;doc: update CLI usage texts

This commit is contained in:
Simon Michael 2022-04-14 12:39:09 -10:00
parent 318ec0a701
commit 9f8381426c
4 changed files with 38 additions and 12 deletions

View File

@ -11,6 +11,9 @@ by matched postings are shown. It shows a flat list by default. With
you can add --drop N to omit the first few account name components. you can add --drop N to omit the first few account name components.
Account names can be depth-clipped with depth:N or --depth N or -N. Account names can be depth-clipped with depth:N or --depth N or -N.
With --types, it also shows each account's type, if it's known. (See
Declaring accounts > Account types.)
Examples: Examples:
$ hledger accounts $ hledger accounts

View File

@ -47,6 +47,12 @@ Each aregister line item shows:
Transactions making a net change of zero are not shown by default; add Transactions making a net change of zero are not shown by default; add
the -E/--empty flag to show them. the -E/--empty flag to show them.
For performance reasons, column widths are chosen based on the first
1000 lines; this means unusually wide values in later lines can cause
visual discontinuities as column widths are adjusted. If you want to
ensure perfect alignment, at the cost of more time and memory, use the
--align-all flag.
This command also supports the output destination and output format This command also supports the output destination and output format
options. The output formats supported are txt, csv, and json. options. The output formats supported are txt, csv, and json.

View File

@ -22,6 +22,12 @@ $ hledger register checking
With --date2, it shows and sorts by secondary date instead. With --date2, it shows and sorts by secondary date instead.
For performance reasons, column widths are chosen based on the first
1000 lines; this means unusually wide values in later lines can cause
visual discontinuities as column widths are adjusted. If you want to
ensure perfect alignment, at the cost of more time and memory, use the
--align-all flag.
The --historical/-H flag adds the balance from any undisplayed prior The --historical/-H flag adds the balance from any undisplayed prior
postings to the running total. This is useful when you want to see only postings to the running total. This is useful when you want to see only
recent activity, with a historically accurate running balance: recent activity, with a historically accurate running balance:

View File

@ -1,15 +1,26 @@
tags tags
List the unique tag names used in the journal. With a TAGREGEX argument, List the tags used in the journal, or their values.
only tag names matching the regular expression (case insensitive) are
shown. With QUERY arguments, only transactions matching the query are
considered.
With the --values flag, the tags' unique values are listed instead.
With --parsed flag, all tags or values are shown in the order they are
parsed from the input data, including duplicates.
With -E/--empty, any blank/empty values will also be shown, otherwise
they are omitted.
_FLAGS _FLAGS
This command lists the tag names used in the journal, whether on
transactions, postings, or account declarations.
With a TAGREGEX argument, only tag names matching this regular
expression (case insensitive, infix matched) are shown.
With QUERY arguments, only transactions and accounts matching this query
are considered. If the query involves transaction fields (date:, desc:,
amt:, ...), the search is restricted to the matched transactions and
their accounts.
With the --values flag, the tags' unique non-empty values are listed
instead. With -E/--empty, blank/empty values are also shown.
With --parsed, tags or values are shown in the order they were parsed,
with duplicates included. (Except, tags from account declarations are
always shown first.)
Tip: remember, accounts also acquire tags from their parents, postings
also acquire tags from their account and transaction, transactions also
acquire tags from their postings.