diff options
| author | Rahix <rahix@rahix.de> | 2021-08-04 14:42:35 +0200 |
|---|---|---|
| committer | Martin Michlmayr <tbm@cyrius.com> | 2021-08-26 08:20:10 +0800 |
| commit | 1a91c0ff836ef3e438e6c83a40271d4ebcc648f0 (patch) | |
| tree | b500c385d2a94675127ad6137c1fbf00e175543d /doc/ledger.1 | |
| parent | d137192fea7ad5267df16ee0978c352af65a37b9 (diff) | |
| download | fork-ledger-1a91c0ff836ef3e438e6c83a40271d4ebcc648f0.tar.gz fork-ledger-1a91c0ff836ef3e438e6c83a40271d4ebcc648f0.tar.bz2 fork-ledger-1a91c0ff836ef3e438e6c83a40271d4ebcc648f0.zip | |
docs: Improve --depth documentation
Make it clear that --depth behaves the same for balance and register
reports now.
Fixes: #1952
Diffstat (limited to 'doc/ledger.1')
| -rw-r--r-- | doc/ledger.1 | 17 |
1 files changed, 8 insertions, 9 deletions
diff --git a/doc/ledger.1 b/doc/ledger.1 index f1fad3f6..f7f94a35 100644 --- a/doc/ledger.1 +++ b/doc/ledger.1 @@ -506,17 +506,16 @@ Direct to parse journals using the European standard comma as decimal separator, vice a period. .It Fl \-depth Ar INT -Limit the depth of the account tree. In a balance report, for example, +Limit the depth of displayed accounts in balance and register reports. Any +accounts of greater depth are folded into their parent at the specified +level. For example with .Fl \-depth Ar 2 -will print balances only for accounts with two levels, i.e. +the account +.Sy Expenses:Entertainment:Dining +would be folded into .Sy Expenses:Entertainment -but not -.Sy Expenses:Entertainment:Dining . -This is a display predicate, which means it only affects display, -not the total calculations. In register reports, -.Fl \-depth -will collapse postings of child accounts beyond the given level and add -their balances to the parent account. +for display. Importantly, this is a display predicate, which means it only +affects display, not the total calculations. .It Fl \-detail Related to .Ic convert |