From c0053cb9ba7879c563bbe4073c5d826fb79e6329 Mon Sep 17 00:00:00 2001
From: Stephen Morgan <morgan.stephen99@gmail.com>
Date: Fri, 10 Sep 2021 10:30:10 +1000
Subject: [PATCH] doc: Document --today in the manual.

---
 hledger/hledger.m4.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/hledger/hledger.m4.md b/hledger/hledger.m4.md
index 49dad9af1..02b7350f6 100644
--- a/hledger/hledger.m4.md
+++ b/hledger/hledger.m4.md
@@ -473,6 +473,10 @@ Counterexamples - malformed digit sequences might give surprising results:
 | `20181232`  | 8 digits with an invalid day gives an error                       |
 | `201801012` | 9+ digits beginning with a valid YYYYMMDD gives an error          |
 
+Note "today's date" can be overridden with the `--today` option, in case it's
+needed for testing or for recreating old reports. (Except for periodic
+transaction rules; those are not affected by `--today`.)
+
 <a name="report-period"></a>
 
 ## Report start & end date