summaryrefslogtreecommitdiff
path: root/doc/ledger3.texi
diff options
context:
space:
mode:
authorAlexis Hildebrandt <afh@surryhill.net>2023-02-08 16:13:09 +0100
committerMartin Michlmayr <tbm@cyrius.com>2023-02-09 09:21:52 +0800
commit3b2c681f79b4094184c60134aa42342f9f57f89e (patch)
treee5261da902baa58c551541167276d65b8569f456 /doc/ledger3.texi
parent86aaf75cb95279d88144a4607d3e10a7781865a4 (diff)
downloadfork-ledger-3b2c681f79b4094184c60134aa42342f9f57f89e.tar.gz
fork-ledger-3b2c681f79b4094184c60134aa42342f9f57f89e.tar.bz2
fork-ledger-3b2c681f79b4094184c60134aa42342f9f57f89e.zip
Cross reference Auxiliary and Effective dates sections
Closes #2150
Diffstat (limited to 'doc/ledger3.texi')
-rw-r--r--doc/ledger3.texi18
1 files changed, 13 insertions, 5 deletions
diff --git a/doc/ledger3.texi b/doc/ledger3.texi
index f272c992..8799afe3 100644
--- a/doc/ledger3.texi
+++ b/doc/ledger3.texi
@@ -2890,9 +2890,13 @@ primary date with an equals sign:
@end smallexample
What this auxiliary date means is entirely up to you. The only use
-Ledger has for it is that if you specify @option{--aux-date}, then all
-reports and calculations (including pricing) will use the auxiliary
-date as if it were the primary date.
+Ledger has for it is that if you specify @option{--aux-date} (or
+@option{--effective}), then all reports and calculations (including
+pricing) will use the auxiliary date as if it were the primary date.
+
+Note that the @option{--aux-date} option is an alias for
+@option{--effective}; for more details on effective dates
+@pxref{Effective Dates}.
@node Codes, Transaction state, Auxiliary dates, Transactions
@section Codes
@@ -4045,8 +4049,8 @@ This entry accomplishes this. Every month you'll see an
automatic $37.50 deficit like you should, while your checking account
really knows that it debited $225 this month.
-And using the @option{--effective} option, the initial date will be
-overridden by the effective dates.
+And using the @option{--effective} (or @option{--aux-date}) option,
+the initial date will be overridden by the effective dates.
@smallexample @c command:6453542
$ ledger --effective register Groceries
@@ -4061,6 +4065,10 @@ $ ledger --effective register Groceries
09-Mar-01 Bountiful Blessings.. Expense:Food:Groceries $ 37.50 $ 225.00
@end smallexample
+Note that the @option{--aux-date} option is an alias for
+@option{--effective}; for a brief explanation of auxiliary date
+@pxref{Auxiliary dates}.
+
@node Periodic Transactions, Concrete Example of Automated Transactions, Effective Dates, Automated Transactions
@subsection Periodic Transactions
@findex --budget