summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Wiegley <johnw@newartisans.com>2023-11-23 15:59:02 -0800
committerJohn Wiegley <johnw@newartisans.com>2024-08-05 08:35:56 -0700
commit6e9fda06df1754f58c347e44a4579d059dfd36f0 (patch)
treedf762273aa9f25246e06e229d7645c0aacf88718
parentb8d71b69e05aea46504f5c1a89fe0e16138f1057 (diff)
downloadfork-ledger-6e9fda06df1754f58c347e44a4579d059dfd36f0.tar.gz
fork-ledger-6e9fda06df1754f58c347e44a4579d059dfd36f0.tar.bz2
fork-ledger-6e9fda06df1754f58c347e44a4579d059dfd36f0.zip
Add documentation for the --hashes option
-rw-r--r--doc/ledger.113
-rw-r--r--doc/ledger3.texi9
2 files changed, 21 insertions, 1 deletions
diff --git a/doc/ledger.1 b/doc/ledger.1
index f64be720..febfaf1e 100644
--- a/doc/ledger.1
+++ b/doc/ledger.1
@@ -1,4 +1,4 @@
-.Dd March 15, 2019
+.Dd November 23, 2023
.Dt LEDGER 1
.Os
.Sh NAME
@@ -634,6 +634,17 @@ Set the format for the headers that separate reports section of
a grouped report. Only has effect with a
.Fl \-group-by Ar EXPR
register report.
+.It Fl \-hashes Ar ALGO
+Record the hash of each transaction in a
+.Ar Hash
+metadata value, according to the hashing algorithm given by the
+.Ar ALGO
+argument. Note that if a
+.Ar Hash
+metadata value is explicitly provided and does not match what would
+have been generated, an error is reported. Hashes depend on previous
+entries, such that setting a single hash value is sufficient to
+guarantee the shape of the entire history leading up to that entry.
.It Fl \-head Ar INT
Print the first
.Ar INT
diff --git a/doc/ledger3.texi b/doc/ledger3.texi
index 02680caa..b4f3baab 100644
--- a/doc/ledger3.texi
+++ b/doc/ledger3.texi
@@ -6755,6 +6755,15 @@ $ ledger reg Expenses --group-by "payee" --group-title-format "-----------------
...
@end smallexample
+@item --hashes @var{ALGO}
+Record the hash of each transaction in a @var{Hash} metadata value,
+according to the hashing algorithm given by the @var{ALGO}
+argument. Note that if a @var{Hash} metadata value is explicitly
+provided and does not match what would have been generated, an error is
+reported. Hashes depend on previous entries, such that setting a single
+hash value is sufficient to guarantee the shape of the entire history
+leading up to that entry.
+
@item --head @var{INT}
@itemx --first @var{INT}
Print the first @var{INT} entries. Opposite of @option{--tail