;doc: update CLI usage texts

This commit is contained in:
Simon Michael 2023-01-25 11:59:05 -10:00
parent 811ff64e30
commit 1b3b26895e
3 changed files with 17 additions and 8 deletions

View File

@ -18,9 +18,14 @@ accounts - use register for reviewing detailed revenues/expenses.
aregister requires one argument: the account to report on. You can write aregister requires one argument: the account to report on. You can write
either the full account name, or a case-insensitive regular expression either the full account name, or a case-insensitive regular expression
which will select the alphabetically first matched account. (Eg if you which will select the alphabetically first matched account.
have assets:aaa:checking and assets:bbb:checking accounts,
hledger areg checking would select assets:aaa:checking.) When there are multiple matches, the alphabetically-first choice can be
surprising; eg if you have assets:per:checking 1 and
assets:biz:checking 2 accounts, hledger areg checking would select
assets:biz:checking 2. It's just a convenience to save typing, so if in
doubt, write the full account name, or a distinctive substring that
matches uniquely.
Transactions involving subaccounts of this account will also be shown. Transactions involving subaccounts of this account will also be shown.
aregister ignores depth limits, so its final total will always match a aregister ignores depth limits, so its final total will always match a

View File

@ -75,11 +75,10 @@ output parseable.
With -B/--cost, amounts with costs are converted to cost using that With -B/--cost, amounts with costs are converted to cost using that
price. This can be used for troubleshooting. price. This can be used for troubleshooting.
With -m DESC/--match=DESC, print does a fuzzy search for the one With -m DESC/--match=DESC, print does a fuzzy search for one recent
transaction whose description is most similar to DESC, also preferring transaction whose description is most similar to DESC. DESC should
recent tranactions. DESC should contain at least two characters. If contain at least two characters. If there is no similar-enough match, no
there is no similar-enough match, no transaction will be shown and the transaction will be shown and the program exit code will be non-zero.
program exit code will be non-zero.
With --new, hledger prints only transactions it has not seen on a With --new, hledger prints only transactions it has not seen on a
previous run. This uses the same deduplication system as the import previous run. This uses the same deduplication system as the import

View File

@ -92,6 +92,11 @@ will be adjusted outward if necessary to contain a whole number of
intervals. This ensures that the first and last intervals are full intervals. This ensures that the first and last intervals are full
length and comparable to the others in the report. length and comparable to the others in the report.
With -m DESC/--match=DESC, register does a fuzzy search for one recent
posting whose description is most similar to DESC. DESC should contain
at least two characters. If there is no similar-enough match, no posting
will be shown and the program exit code will be non-zero.
Custom register output Custom register output
register uses the full terminal width by default, except on windows. You register uses the full terminal width by default, except on windows. You