summaryrefslogtreecommitdiff
path: root/doc/ledger.1
diff options
context:
space:
mode:
authorGwyneth Morgan <gwymor@tilde.club>2022-06-28 04:22:56 +0000
committerMartin Michlmayr <tbm@cyrius.com>2022-06-29 09:47:20 +0800
commit7424c244d69c386187f6df87d309c1d54f8a435b (patch)
tree9febb5e404497418c2d070aae23b6f3e1bcea82e /doc/ledger.1
parent0cf138cbce88ca22c0b802b6db0a7257a517a87d (diff)
downloadfork-ledger-7424c244d69c386187f6df87d309c1d54f8a435b.tar.gz
fork-ledger-7424c244d69c386187f6df87d309c1d54f8a435b.tar.bz2
fork-ledger-7424c244d69c386187f6df87d309c1d54f8a435b.zip
Document --exchange can accept multiple commodities
The --exchange option can accept multiple comma-separated commodities, but this is only mentioned in one place where --exchange is documented, and notably not in the Texinfo manual. Examples made with the following ledger file: ``` P 2022-06-28 USD 54.81 PHP P 2022-06-28 EUR 58.01 PHP 2022-06-28 * Opening Balances Equity:Opening Balances Assets:USD Bank 100 USD Assets:EUR Bank 100 EUR Assets:PHP Bank 100 PHP ``` [ci skip]
Diffstat (limited to 'doc/ledger.1')
-rw-r--r--doc/ledger.115
1 files changed, 10 insertions, 5 deletions
diff --git a/doc/ledger.1 b/doc/ledger.1
index 74a9e84d..cc6df5d6 100644
--- a/doc/ledger.1
+++ b/doc/ledger.1
@@ -172,11 +172,14 @@ with this command are:
Show the running average, rather than a running total.
.It Fl \-current Pq Fl c
Don't show postings beyond the present day.
-.It Fl \-exchange Ar commodity Pq Fl X
+.It Fl \-exchange Qo Ar COMMODITY Oo , Ar COMMODITY, ... Oc Qc Pq Fl X
Render all values in the given
.Ar commodity ,
-if a price conversion rate can be determined. Rates are always displayed
-relative to the date of the posting they are calculated for. This means a
+if a price conversion rate can be determined. If multiple commodities are
+given, values in a listed commodity will remain as-is, and others will be
+displayed in the first listed commodity they can be converted to. Rates are
+always displayed relative to the date of the posting they are calculated for.
+This means a
.Ic register
report is a historical value report. For current values, it may be preferable
to use the
@@ -574,10 +577,12 @@ report.
.It Fl \-exact
Report beginning and ending of periods by the date of the first and last
posting occurring in that period.
-.It Fl \-exchange Ar COMMODITY Oo , Ar COMMODITY, ... Oc Pq Fl X
+.It Fl \-exchange Qo Ar COMMODITY Oo , Ar COMMODITY, ... Oc Qc Pq Fl X
Display values in terms of the given
.Ar COMMODITY .
-The latest available price is used.
+If multiple commodities are given, values in a listed commodity will remain
+as-is, and others will be displayed in the first listed commodity they can be
+converted to.
.It Fl \-file Ar FILE Pq Fl f
Read journal data from
.Ar FILE .