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

;areg: doc: try to clarify aregister's purpose

Browse Source
This commit is contained in:
Simon Michael 2021-01-27 12:53:49 -08:00
parent a91ca6892b
commit 6650a563fb
1 changed files with 28 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,39 +1,45 @@
aregister, areg\ aregister, areg\
Show transactions affecting a particular account, and the account's
running balance. Show the transactions and running historical balance in an account,
with each line item representing one transaction.
_FLAGS _FLAGS
`aregister` shows the transactions affecting a particular account `aregister` shows the transactions affecting a particular account and
(and its subaccounts), from the point of view of that account. its subaccounts, with each line item representing a whole transaction -
Each line shows: as in bank statements, hledger-ui, hledger-web and other accounting apps.
- the transaction's (or posting's, see below) date Note this is unlike the [`register`](#register) command,
- the names of the other account(s) involved which shows individual postings
- the net change to this account's balance and does not always show a single account or a historical balance.
- the account's historical running balance (including balance from
transactions before the report start date).
With `aregister`, each line represents a whole transaction - as in A reminder, "historical" balances include any balance from transactions
hledger-ui, hledger-web, and your bank statement. By contrast, the before the report start date, so (if opening balances are recorded correctly)
[`register`](#register) command shows individual postings, across all `aregister` will show the real-world balances of an account, as you would see
accounts. You might prefer `aregister` for reconciling with real-world in a bank statement.
asset/liability accounts, and `register` for reviewing detailed
revenues/expenses.
An account must be specified as the first argument, which should be As a quick rule of thumb,
the full account name or an account pattern (regular expression). use `aregister` for reconciling real-world asset/liability accounts
aregister will show transactions in this account (the first one and `register` for reviewing detailed revenues/expenses.
matched) and any of its subaccounts. (`aregister` ignores any
depth limit, so its final total will always match a balance report An account must be specified as the first argument. This can be
with similar arguments.) a full account name or an account pattern (regular expression).
Any additional arguments form a query which will filter the Any additional arguments form a query which will filter the
transactions shown. transactions shown.
Each `aregister` line item shows:
- the transaction's date (or the relevant posting's date if different, see below)
- the names of all the other account(s) involved in this transaction (probably abbreviated)
- the total change to this account's balance from this transaction
- the account's historical running balance after this transaction.
Transactions making a net change of zero are not shown by default; Transactions making a net change of zero are not shown by default;
add the `-E/--empty` flag to show them. add the `-E/--empty` flag to show them.
`aregister` ignores a depth limit, so its final total will always match a balance report with similar arguments.
This command also supports the This command also supports the
[output destination](hledger.html#output-destination) and [output destination](hledger.html#output-destination) and
[output format](hledger.html#output-format) options [output format](hledger.html#output-format) options