From 1b3b26895eac89aaa64083373d51e4a22ab6dc61 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Wed, 25 Jan 2023 11:59:05 -1000 Subject: [PATCH] ;doc: update CLI usage texts --- hledger/Hledger/Cli/Commands/Aregister.txt | 11 ++++++++--- hledger/Hledger/Cli/Commands/Print.txt | 9 ++++----- hledger/Hledger/Cli/Commands/Register.txt | 5 +++++ 3 files changed, 17 insertions(+), 8 deletions(-) diff --git a/hledger/Hledger/Cli/Commands/Aregister.txt b/hledger/Hledger/Cli/Commands/Aregister.txt index bbe76f13f..63a704589 100644 --- a/hledger/Hledger/Cli/Commands/Aregister.txt +++ b/hledger/Hledger/Cli/Commands/Aregister.txt @@ -18,9 +18,14 @@ accounts - use register for reviewing detailed revenues/expenses. aregister requires one argument: the account to report on. You can write either the full account name, or a case-insensitive regular expression -which will select the alphabetically first matched account. (Eg if you -have assets:aaa:checking and assets:bbb:checking accounts, -hledger areg checking would select assets:aaa:checking.) +which will select the alphabetically first matched account. + +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. aregister ignores depth limits, so its final total will always match a diff --git a/hledger/Hledger/Cli/Commands/Print.txt b/hledger/Hledger/Cli/Commands/Print.txt index 1202af9d7..b8cb11477 100644 --- a/hledger/Hledger/Cli/Commands/Print.txt +++ b/hledger/Hledger/Cli/Commands/Print.txt @@ -75,11 +75,10 @@ output parseable. With -B/--cost, amounts with costs are converted to cost using that price. This can be used for troubleshooting. -With -m DESC/--match=DESC, print does a fuzzy search for the one -transaction whose description is most similar to DESC, also preferring -recent tranactions. DESC should contain at least two characters. If -there is no similar-enough match, no transaction will be shown and the -program exit code will be non-zero. +With -m DESC/--match=DESC, print does a fuzzy search for one recent +transaction whose description is most similar to DESC. DESC should +contain at least two characters. If there is no similar-enough match, no +transaction will be shown and the program exit code will be non-zero. With --new, hledger prints only transactions it has not seen on a previous run. This uses the same deduplication system as the import diff --git a/hledger/Hledger/Cli/Commands/Register.txt b/hledger/Hledger/Cli/Commands/Register.txt index ccb03b4ca..8c33ef2f9 100644 --- a/hledger/Hledger/Cli/Commands/Register.txt +++ b/hledger/Hledger/Cli/Commands/Register.txt @@ -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 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 register uses the full terminal width by default, except on windows. You