From 1c4e0c3cffe931c04c1102dbf471610f17bbff63 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Wed, 22 Jul 2020 07:57:53 -0700 Subject: [PATCH] ;reg,areg: interlink their docs --- hledger/Hledger/Cli/Commands/Aregister.md | 4 ++-- hledger/Hledger/Cli/Commands/Register.md | 15 +++++++++++---- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/hledger/Hledger/Cli/Commands/Aregister.md b/hledger/Hledger/Cli/Commands/Aregister.md index 66b6617ce..35466bc66 100644 --- a/hledger/Hledger/Cli/Commands/Aregister.md +++ b/hledger/Hledger/Cli/Commands/Aregister.md @@ -16,8 +16,8 @@ Each line shows: With `aregister`, each line represents a whole transaction - as in hledger-ui, hledger-web, and your bank statement. By contrast, the -`register` command shows individual postings, across all accounts. -You might prefer `aregister` for reconciling with real-world +[`register`](#register) command shows individual postings, across all +accounts. You might prefer `aregister` for reconciling with real-world asset/liability accounts, and `register` for reviewing detailed revenues/expenses. diff --git a/hledger/Hledger/Cli/Commands/Register.md b/hledger/Hledger/Cli/Commands/Register.md index dd8383e18..7215b20f7 100644 --- a/hledger/Hledger/Cli/Commands/Register.md +++ b/hledger/Hledger/Cli/Commands/Register.md @@ -3,10 +3,17 @@ Show postings and their running total. _FLAGS -The register command displays postings in date order, one per line, -and their running total. This is typically used with a -[query](#queries) selecting a particular account, to see that -account's activity: +The register command displays matched postings, across all accounts, +in date order, with their running total or running historical balance. +(See also the [`aregister`](#aregister) command, which shows matched +transactions in a specific account.) + +register normally shows line per posting, but note that +multi-commodity amounts will occupy multiple lines (one line per +commodity). + +It is typically used with a [query](#queries) selecting a +particular account, to see that account's activity: ```shell $ hledger register checking