slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc:aregister: clarify

Browse Source
This commit is contained in:
Simon Michael 2025-10-13 09:53:49 -10:00
parent 25f04dd367
commit 8b125a2ee6
1 changed files with 7 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
hledger/Hledger/Cli/Commands/Aregister.md
View File

@ -40,23 +40,18 @@ As a quick rule of thumb:
- use `aregister` for reviewing and reconciling real-world asset/liability accounts - use `aregister` for reviewing and reconciling real-world asset/liability accounts
- use `register` for reviewing detailed revenues/expenses. - use `register` for reviewing detailed revenues/expenses.
`aregister` requires one argument: the account to report on. Note this command's non-standard, and required, first argument; it specifies the account whose register will be shown.
You can write either the full account name, or a case-insensitive regular expression You can write the account's name, or (to save typing) a case-insensitive infix regular expression matching the name,
which will select the alphabetically first matched account. which selects the alphabetically first matched account.
(For example, if you have `assets:personal checking` and `assets:business checking`,
When there are multiple matches, the alphabetically-first choice can be surprising; `hledger areg checking` would select `assets:business checking`.)
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 `aregister` ignores depth limits, so its final total will always match
a historical balance report with similar arguments. a historical balance report with similar arguments.
Any additional arguments form a [query](#queries) which will filter the Any additional arguments are standard [query arguments](#queries), which will limit the transactions shown.
transactions shown. Note some queries will disturb the running balance, Note some queries will disturb the running balance, causing it to be different from the account's real-world running balance.
causing it to be different from the account's real-world running balance.
An example: this shows the transactions and historical running balance An example: this shows the transactions and historical running balance
during july, in the first account whose name contains "checking": during july, in the first account whose name contains "checking":