;doc: update help

This commit is contained in:
Simon Michael 2024-09-09 13:23:13 -07:00
parent a5fb7d639e
commit a505ffd3bf
2 changed files with 13 additions and 2 deletions

View File

@ -16,8 +16,9 @@ Flags:
description closest to DESC description closest to DESC
-r --related show postings' siblings instead -r --related show postings' siblings instead
--invert display all amounts with reversed sign --invert display all amounts with reversed sign
--sort=FIELDS comma-separated list of fields used to sort --sort=FIELDS sort by: date, desc, account, amount, absamount,
transactions or a comma-separated combination of these. For a
descending sort, prefix with -. (Default: date)
-w --width=N set output width (default: terminal width or -w --width=N set output width (default: terminal width or
$COLUMNS). -wN,M sets description width as well. $COLUMNS). -wN,M sets description width as well.
--align-all guarantee alignment across all lines (slower) --align-all guarantee alignment across all lines (slower)

View File

@ -15,6 +15,9 @@ Flags:
description closest to DESC description closest to DESC
-r --related show postings' siblings instead -r --related show postings' siblings instead
--invert display all amounts with reversed sign --invert display all amounts with reversed sign
--sort=FIELDS sort by: date, desc, account, amount, absamount,
or a comma-separated combination of these. For a
descending sort, prefix with -. (Default: date)
-w --width=N set output width (default: terminal width or -w --width=N set output width (default: terminal width or
$COLUMNS). -wN,M sets description width as well. $COLUMNS). -wN,M sets description width as well.
--align-all guarantee alignment across all lines (slower) --align-all guarantee alignment across all lines (slower)
@ -73,6 +76,13 @@ income account where amounts are normally displayed as negative numbers.
It's also useful to show postings on the checking account together with It's also useful to show postings on the checking account together with
the related account: the related account:
The --sort=FIELDS flag sorts by the fields given, which can be any of
account, amount, absamount, date, or desc/description, optionally
separated by commas. For example, --sort account,amount will group all
transactions in each account, sorted by transaction amount. Each field
can be negated by a preceding -, so --sort -amount will show
transactions ordered from smallest amount to largest amount.
$ hledger register --related --invert assets:checking $ hledger register --related --invert assets:checking
With a reporting interval, register shows summary postings, one per With a reporting interval, register shows summary postings, one per