From b31091195ba500d4422ef5bc098930050b67ca81 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sat, 8 Mar 2025 12:44:57 -1000 Subject: [PATCH] ;doc: update command docs --- hledger/Hledger/Cli/Commands/Accounts.md | 5 +- hledger/Hledger/Cli/Commands/Accounts.txt | 5 +- hledger/Hledger/Cli/Commands/Aregister.md | 8 ++-- hledger/Hledger/Cli/Commands/Aregister.txt | 8 ++-- hledger/Hledger/Cli/Commands/Balance.md | 47 ++++++++++--------- hledger/Hledger/Cli/Commands/Balance.txt | 47 ++++++++++--------- hledger/Hledger/Cli/Commands/Balancesheet.md | 43 ++++++++--------- hledger/Hledger/Cli/Commands/Balancesheet.txt | 43 ++++++++--------- .../Cli/Commands/Balancesheetequity.md | 43 ++++++++--------- .../Cli/Commands/Balancesheetequity.txt | 43 ++++++++--------- hledger/Hledger/Cli/Commands/Cashflow.md | 45 +++++++++--------- hledger/Hledger/Cli/Commands/Cashflow.txt | 45 +++++++++--------- .../Hledger/Cli/Commands/Incomestatement.md | 45 +++++++++--------- .../Hledger/Cli/Commands/Incomestatement.txt | 45 +++++++++--------- hledger/Hledger/Cli/Commands/Register.md | 9 ++-- hledger/Hledger/Cli/Commands/Register.txt | 9 ++-- 16 files changed, 260 insertions(+), 230 deletions(-) diff --git a/hledger/Hledger/Cli/Commands/Accounts.md b/hledger/Hledger/Cli/Commands/Accounts.md index 8f94dcfea..15346476c 100644 --- a/hledger/Hledger/Cli/Commands/Accounts.md +++ b/hledger/Hledger/Cli/Commands/Accounts.md @@ -14,8 +14,9 @@ Flags: --find find the first account matched by the first argument (a case-insensitive infix regexp or account name) - -l --flat show accounts as a flat list (default) - -t --tree show accounts as a tree + -l --flat list/tree mode: show accounts as a flat list + (default) + -t --tree list/tree mode: show accounts as a tree --drop=N flat mode: omit N leading account name parts ``` diff --git a/hledger/Hledger/Cli/Commands/Accounts.txt b/hledger/Hledger/Cli/Commands/Accounts.txt index 181362eae..3f52d3613 100644 --- a/hledger/Hledger/Cli/Commands/Accounts.txt +++ b/hledger/Hledger/Cli/Commands/Accounts.txt @@ -13,8 +13,9 @@ Flags: --find find the first account matched by the first argument (a case-insensitive infix regexp or account name) - -l --flat show accounts as a flat list (default) - -t --tree show accounts as a tree + -l --flat list/tree mode: show accounts as a flat list + (default) + -t --tree list/tree mode: show accounts as a tree --drop=N flat mode: omit N leading account name parts This command lists account names. By default it shows all known diff --git a/hledger/Hledger/Cli/Commands/Aregister.md b/hledger/Hledger/Cli/Commands/Aregister.md index 5b9ace4e7..70a9730d4 100644 --- a/hledger/Hledger/Cli/Commands/Aregister.md +++ b/hledger/Hledger/Cli/Commands/Aregister.md @@ -11,9 +11,11 @@ Flags: date. Warning: this can show a wrong running balance. --no-elide don't show only 2 commodities per amount - --cumulative show running total from report start date - -H --historical show historical running total/balance (includes - postings before report start date) (default) + --cumulative accumulation mode: show running total from report + start date + -H --historical accumulation mode: show historical running + total/balance (includes postings before report + start date) (default) --invert display all amounts with reversed sign --heading=YN show heading row above table: yes (default) or no -w --width=N set output width (default: terminal width). -wN,M diff --git a/hledger/Hledger/Cli/Commands/Aregister.txt b/hledger/Hledger/Cli/Commands/Aregister.txt index 33f726181..ac0296b4a 100644 --- a/hledger/Hledger/Cli/Commands/Aregister.txt +++ b/hledger/Hledger/Cli/Commands/Aregister.txt @@ -10,9 +10,11 @@ Flags: date. Warning: this can show a wrong running balance. --no-elide don't show only 2 commodities per amount - --cumulative show running total from report start date - -H --historical show historical running total/balance (includes - postings before report start date) (default) + --cumulative accumulation mode: show running total from report + start date + -H --historical accumulation mode: show historical running + total/balance (includes postings before report + start date) (default) --invert display all amounts with reversed sign --heading=YN show heading row above table: yes (default) or no -w --width=N set output width (default: terminal width). -wN,M diff --git a/hledger/Hledger/Cli/Commands/Balance.md b/hledger/Hledger/Cli/Commands/Balance.md index 9f32fe6df..a2f6e5001 100644 --- a/hledger/Hledger/Cli/Commands/Balance.md +++ b/hledger/Hledger/Cli/Commands/Balance.md @@ -7,32 +7,36 @@ This can be balance changes per period, end balances, budget performance, unreal ```flags Flags: - --sum show sum of posting amounts (default) - --valuechange show total change of value of period-end - historical balances (caused by deposits, + --sum calculation mode: show sum of posting amounts + (default) + --valuechange calculation mode: show total change of value of + period-end historical balances (caused by deposits, withdrawals, market price fluctuations) - --gain show unrealised capital gain/loss (historical - balance value minus cost basis) - --budget[=DESCPAT] show sum of posting amounts together with budget - goals defined by periodic + --gain calculation mode: show unrealised capital + gain/loss (historical balance value minus cost + basis) + --budget[=DESCPAT] calculation mode: show sum of posting amounts + together with budget goals defined by periodic transactions. With a DESCPAT argument (must be separated by = not space), use only periodic transactions with matching description (case insensitive substring match). - --count show the count of postings - --change accumulate amounts from column start to column - end (in multicolumn reports, default) - --cumulative accumulate amounts from report start (specified - by e.g. -b/--begin) to column end - -H --historical accumulate amounts from journal start to column - end (includes postings before report start date) - -l --flat show accounts as a flat list (default). Amounts - exclude subaccount amounts, except where the - account is depth-clipped. - -t --tree show accounts as a tree. Amounts include - subaccount amounts. - --drop=N omit N leading account name parts (in flat mode) + --count calculation mode: show the count of postings + --change accumulation mode: accumulate amounts from column + start to column end (in multicolumn reports, + default) + --cumulative accumulation mode: accumulate amounts from report + start (specified by e.g. -b/--begin) to column end + -H --historical accumulation mode: accumulate amounts from + journal start to column end (includes postings + before report start date) + -l --flat list/tree mode: show accounts as a flat list + (default). Amounts exclude subaccount amounts, + except where the account is depth-clipped. + -t --tree list/tree mode: show accounts as a tree. Amounts + include subaccount amounts. + --drop=N in list mode, omit N leading account name parts --declared include non-parent declared accounts (best used with -E) -A --average show a row average column (in multicolumn @@ -41,8 +45,7 @@ Flags: --summary-only display only row summaries (e.g. row total, average) (in multicolumn reports) -N --no-total omit the final total row - --no-elide don't squash boring parent accounts (in tree - mode) + --no-elide in tree mode, don't squash boring parent accounts --format=FORMATSTR use this custom line format (in simple reports) -S --sort-amount sort by amount instead of account code/name (in flat mode). With multiple columns, sorts by the row diff --git a/hledger/Hledger/Cli/Commands/Balance.txt b/hledger/Hledger/Cli/Commands/Balance.txt index e7501ca4a..db679c0a6 100644 --- a/hledger/Hledger/Cli/Commands/Balance.txt +++ b/hledger/Hledger/Cli/Commands/Balance.txt @@ -7,32 +7,36 @@ some kind of numeric data. This can be balance changes per period, end balances, budget performance, unrealised capital gains, etc. Flags: - --sum show sum of posting amounts (default) - --valuechange show total change of value of period-end - historical balances (caused by deposits, + --sum calculation mode: show sum of posting amounts + (default) + --valuechange calculation mode: show total change of value of + period-end historical balances (caused by deposits, withdrawals, market price fluctuations) - --gain show unrealised capital gain/loss (historical - balance value minus cost basis) - --budget[=DESCPAT] show sum of posting amounts together with budget - goals defined by periodic + --gain calculation mode: show unrealised capital + gain/loss (historical balance value minus cost + basis) + --budget[=DESCPAT] calculation mode: show sum of posting amounts + together with budget goals defined by periodic transactions. With a DESCPAT argument (must be separated by = not space), use only periodic transactions with matching description (case insensitive substring match). - --count show the count of postings - --change accumulate amounts from column start to column - end (in multicolumn reports, default) - --cumulative accumulate amounts from report start (specified - by e.g. -b/--begin) to column end - -H --historical accumulate amounts from journal start to column - end (includes postings before report start date) - -l --flat show accounts as a flat list (default). Amounts - exclude subaccount amounts, except where the - account is depth-clipped. - -t --tree show accounts as a tree. Amounts include - subaccount amounts. - --drop=N omit N leading account name parts (in flat mode) + --count calculation mode: show the count of postings + --change accumulation mode: accumulate amounts from column + start to column end (in multicolumn reports, + default) + --cumulative accumulation mode: accumulate amounts from report + start (specified by e.g. -b/--begin) to column end + -H --historical accumulation mode: accumulate amounts from + journal start to column end (includes postings + before report start date) + -l --flat list/tree mode: show accounts as a flat list + (default). Amounts exclude subaccount amounts, + except where the account is depth-clipped. + -t --tree list/tree mode: show accounts as a tree. Amounts + include subaccount amounts. + --drop=N in list mode, omit N leading account name parts --declared include non-parent declared accounts (best used with -E) -A --average show a row average column (in multicolumn @@ -41,8 +45,7 @@ Flags: --summary-only display only row summaries (e.g. row total, average) (in multicolumn reports) -N --no-total omit the final total row - --no-elide don't squash boring parent accounts (in tree - mode) + --no-elide in tree mode, don't squash boring parent accounts --format=FORMATSTR use this custom line format (in simple reports) -S --sort-amount sort by amount instead of account code/name (in flat mode). With multiple columns, sorts by the row diff --git a/hledger/Hledger/Cli/Commands/Balancesheet.md b/hledger/Hledger/Cli/Commands/Balancesheet.md index b39c34364..63f3db592 100644 --- a/hledger/Hledger/Cli/Commands/Balancesheet.md +++ b/hledger/Hledger/Cli/Commands/Balancesheet.md @@ -7,26 +7,28 @@ Amounts are shown with normal positive sign, as in conventional financial statem ```flags Flags: - --sum show sum of posting amounts (default) - --valuechange show total change of period-end historical - balance value (caused by deposits, withdrawals, - market price fluctuations) - --gain show unrealised capital gain/loss (historical - balance value minus cost basis) - --count show the count of postings - --change accumulate amounts from column start to column - end (in multicolumn reports) - --cumulative accumulate amounts from report start (specified - by e.g. -b/--begin) to column end - -H --historical accumulate amounts from journal start to column - end (includes postings before report start date) + --sum calculation mode: show sum of posting amounts (default) - -l --flat show accounts as a flat list (default). Amounts - exclude subaccount amounts, except where the - account is depth-clipped. - -t --tree show accounts as a tree. Amounts include - subaccount amounts. - --drop=N flat mode: omit N leading account name parts + --valuechange calculation mode: show total change of value of + period-end historical balances (caused by deposits, + withdrawals, market price fluctuations) + --gain calculation mode: show unrealised capital + gain/loss (historical balance value minus cost + basis) + --count calculation mode: show the count of postings + --change accumulation mode: accumulate amounts from column + start to column end (in multicolumn reports) + --cumulative accumulation mode: accumulate amounts from report + start (specified by e.g. -b/--begin) to column end + -H --historical accumulation mode: accumulate amounts from + journal start to column end (includes postings + before report start date) (default) + -l --flat list/tree mode: show accounts as a flat list + (default). Amounts exclude subaccount amounts, + except where the account is depth-clipped. + -t --tree list/tree mode: show accounts as a tree. Amounts + include subaccount amounts. + --drop=N in list mode, omit N leading account name parts --declared include non-parent declared accounts (best used with -E) -A --average show a row average column (in multicolumn @@ -35,8 +37,7 @@ Flags: --summary-only display only row summaries (e.g. row total, average) (in multicolumn reports) -N --no-total omit the final total row - --no-elide don't squash boring parent accounts (in tree - mode) + --no-elide in tree mode, don't squash boring parent accounts --format=FORMATSTR use this custom line format (in simple reports) -S --sort-amount sort by amount instead of account code/name -% --percent express values in percentage of each column's diff --git a/hledger/Hledger/Cli/Commands/Balancesheet.txt b/hledger/Hledger/Cli/Commands/Balancesheet.txt index 4eea33198..67f5220f8 100644 --- a/hledger/Hledger/Cli/Commands/Balancesheet.txt +++ b/hledger/Hledger/Cli/Commands/Balancesheet.txt @@ -6,26 +6,28 @@ Show the end balances in asset and liability accounts. Amounts are shown with normal positive sign, as in conventional financial statements. Flags: - --sum show sum of posting amounts (default) - --valuechange show total change of period-end historical - balance value (caused by deposits, withdrawals, - market price fluctuations) - --gain show unrealised capital gain/loss (historical - balance value minus cost basis) - --count show the count of postings - --change accumulate amounts from column start to column - end (in multicolumn reports) - --cumulative accumulate amounts from report start (specified - by e.g. -b/--begin) to column end - -H --historical accumulate amounts from journal start to column - end (includes postings before report start date) + --sum calculation mode: show sum of posting amounts (default) - -l --flat show accounts as a flat list (default). Amounts - exclude subaccount amounts, except where the - account is depth-clipped. - -t --tree show accounts as a tree. Amounts include - subaccount amounts. - --drop=N flat mode: omit N leading account name parts + --valuechange calculation mode: show total change of value of + period-end historical balances (caused by deposits, + withdrawals, market price fluctuations) + --gain calculation mode: show unrealised capital + gain/loss (historical balance value minus cost + basis) + --count calculation mode: show the count of postings + --change accumulation mode: accumulate amounts from column + start to column end (in multicolumn reports) + --cumulative accumulation mode: accumulate amounts from report + start (specified by e.g. -b/--begin) to column end + -H --historical accumulation mode: accumulate amounts from + journal start to column end (includes postings + before report start date) (default) + -l --flat list/tree mode: show accounts as a flat list + (default). Amounts exclude subaccount amounts, + except where the account is depth-clipped. + -t --tree list/tree mode: show accounts as a tree. Amounts + include subaccount amounts. + --drop=N in list mode, omit N leading account name parts --declared include non-parent declared accounts (best used with -E) -A --average show a row average column (in multicolumn @@ -34,8 +36,7 @@ Flags: --summary-only display only row summaries (e.g. row total, average) (in multicolumn reports) -N --no-total omit the final total row - --no-elide don't squash boring parent accounts (in tree - mode) + --no-elide in tree mode, don't squash boring parent accounts --format=FORMATSTR use this custom line format (in simple reports) -S --sort-amount sort by amount instead of account code/name -% --percent express values in percentage of each column's diff --git a/hledger/Hledger/Cli/Commands/Balancesheetequity.md b/hledger/Hledger/Cli/Commands/Balancesheetequity.md index 1ca5fb467..0b9ca8950 100644 --- a/hledger/Hledger/Cli/Commands/Balancesheetequity.md +++ b/hledger/Hledger/Cli/Commands/Balancesheetequity.md @@ -9,26 +9,28 @@ financial statements. ```flags Flags: - --sum show sum of posting amounts (default) - --valuechange show total change of period-end historical - balance value (caused by deposits, withdrawals, - market price fluctuations) - --gain show unrealised capital gain/loss (historical - balance value minus cost basis) - --count show the count of postings - --change accumulate amounts from column start to column - end (in multicolumn reports) - --cumulative accumulate amounts from report start (specified - by e.g. -b/--begin) to column end - -H --historical accumulate amounts from journal start to column - end (includes postings before report start date) + --sum calculation mode: show sum of posting amounts (default) - -l --flat show accounts as a flat list (default). Amounts - exclude subaccount amounts, except where the - account is depth-clipped. - -t --tree show accounts as a tree. Amounts include - subaccount amounts. - --drop=N flat mode: omit N leading account name parts + --valuechange calculation mode: show total change of value of + period-end historical balances (caused by deposits, + withdrawals, market price fluctuations) + --gain calculation mode: show unrealised capital + gain/loss (historical balance value minus cost + basis) + --count calculation mode: show the count of postings + --change accumulation mode: accumulate amounts from column + start to column end (in multicolumn reports) + --cumulative accumulation mode: accumulate amounts from report + start (specified by e.g. -b/--begin) to column end + -H --historical accumulation mode: accumulate amounts from + journal start to column end (includes postings + before report start date) (default) + -l --flat list/tree mode: show accounts as a flat list + (default). Amounts exclude subaccount amounts, + except where the account is depth-clipped. + -t --tree list/tree mode: show accounts as a tree. Amounts + include subaccount amounts. + --drop=N in list mode, omit N leading account name parts --declared include non-parent declared accounts (best used with -E) -A --average show a row average column (in multicolumn @@ -37,8 +39,7 @@ Flags: --summary-only display only row summaries (e.g. row total, average) (in multicolumn reports) -N --no-total omit the final total row - --no-elide don't squash boring parent accounts (in tree - mode) + --no-elide in tree mode, don't squash boring parent accounts --format=FORMATSTR use this custom line format (in simple reports) -S --sort-amount sort by amount instead of account code/name -% --percent express values in percentage of each column's diff --git a/hledger/Hledger/Cli/Commands/Balancesheetequity.txt b/hledger/Hledger/Cli/Commands/Balancesheetequity.txt index 85c697ee2..8fd316a93 100644 --- a/hledger/Hledger/Cli/Commands/Balancesheetequity.txt +++ b/hledger/Hledger/Cli/Commands/Balancesheetequity.txt @@ -7,26 +7,28 @@ balances of asset, liability and equity accounts. Amounts are shown with normal positive sign, as in conventional financial statements. Flags: - --sum show sum of posting amounts (default) - --valuechange show total change of period-end historical - balance value (caused by deposits, withdrawals, - market price fluctuations) - --gain show unrealised capital gain/loss (historical - balance value minus cost basis) - --count show the count of postings - --change accumulate amounts from column start to column - end (in multicolumn reports) - --cumulative accumulate amounts from report start (specified - by e.g. -b/--begin) to column end - -H --historical accumulate amounts from journal start to column - end (includes postings before report start date) + --sum calculation mode: show sum of posting amounts (default) - -l --flat show accounts as a flat list (default). Amounts - exclude subaccount amounts, except where the - account is depth-clipped. - -t --tree show accounts as a tree. Amounts include - subaccount amounts. - --drop=N flat mode: omit N leading account name parts + --valuechange calculation mode: show total change of value of + period-end historical balances (caused by deposits, + withdrawals, market price fluctuations) + --gain calculation mode: show unrealised capital + gain/loss (historical balance value minus cost + basis) + --count calculation mode: show the count of postings + --change accumulation mode: accumulate amounts from column + start to column end (in multicolumn reports) + --cumulative accumulation mode: accumulate amounts from report + start (specified by e.g. -b/--begin) to column end + -H --historical accumulation mode: accumulate amounts from + journal start to column end (includes postings + before report start date) (default) + -l --flat list/tree mode: show accounts as a flat list + (default). Amounts exclude subaccount amounts, + except where the account is depth-clipped. + -t --tree list/tree mode: show accounts as a tree. Amounts + include subaccount amounts. + --drop=N in list mode, omit N leading account name parts --declared include non-parent declared accounts (best used with -E) -A --average show a row average column (in multicolumn @@ -35,8 +37,7 @@ Flags: --summary-only display only row summaries (e.g. row total, average) (in multicolumn reports) -N --no-total omit the final total row - --no-elide don't squash boring parent accounts (in tree - mode) + --no-elide in tree mode, don't squash boring parent accounts --format=FORMATSTR use this custom line format (in simple reports) -S --sort-amount sort by amount instead of account code/name -% --percent express values in percentage of each column's diff --git a/hledger/Hledger/Cli/Commands/Cashflow.md b/hledger/Hledger/Cli/Commands/Cashflow.md index d622cd090..0d8788b2e 100644 --- a/hledger/Hledger/Cli/Commands/Cashflow.md +++ b/hledger/Hledger/Cli/Commands/Cashflow.md @@ -9,25 +9,29 @@ financial statements. ```flags Flags: - --sum show sum of posting amounts (default) - --valuechange show total change of period-end historical - balance value (caused by deposits, withdrawals, - market price fluctuations) - --gain show unrealised capital gain/loss (historical - balance value minus cost basis) - --count show the count of postings - --change accumulate amounts from column start to column - end (in multicolumn reports) (default) - --cumulative accumulate amounts from report start (specified - by e.g. -b/--begin) to column end - -H --historical accumulate amounts from journal start to column - end (includes postings before report start date) - -l --flat show accounts as a flat list (default). Amounts - exclude subaccount amounts, except where the - account is depth-clipped. - -t --tree show accounts as a tree. Amounts include - subaccount amounts. - --drop=N flat mode: omit N leading account name parts + --sum calculation mode: show sum of posting amounts + (default) + --valuechange calculation mode: show total change of value of + period-end historical balances (caused by deposits, + withdrawals, market price fluctuations) + --gain calculation mode: show unrealised capital + gain/loss (historical balance value minus cost + basis) + --count calculation mode: show the count of postings + --change accumulation mode: accumulate amounts from column + start to column end (in multicolumn reports) + (default) + --cumulative accumulation mode: accumulate amounts from report + start (specified by e.g. -b/--begin) to column end + -H --historical accumulation mode: accumulate amounts from + journal start to column end (includes postings + before report start date) + -l --flat list/tree mode: show accounts as a flat list + (default). Amounts exclude subaccount amounts, + except where the account is depth-clipped. + -t --tree list/tree mode: show accounts as a tree. Amounts + include subaccount amounts. + --drop=N in list mode, omit N leading account name parts --declared include non-parent declared accounts (best used with -E) -A --average show a row average column (in multicolumn @@ -36,8 +40,7 @@ Flags: --summary-only display only row summaries (e.g. row total, average) (in multicolumn reports) -N --no-total omit the final total row - --no-elide don't squash boring parent accounts (in tree - mode) + --no-elide in tree mode, don't squash boring parent accounts --format=FORMATSTR use this custom line format (in simple reports) -S --sort-amount sort by amount instead of account code/name -% --percent express values in percentage of each column's diff --git a/hledger/Hledger/Cli/Commands/Cashflow.txt b/hledger/Hledger/Cli/Commands/Cashflow.txt index d6c993935..8a3340db9 100644 --- a/hledger/Hledger/Cli/Commands/Cashflow.txt +++ b/hledger/Hledger/Cli/Commands/Cashflow.txt @@ -8,25 +8,29 @@ Amounts are shown with normal positive sign, as in conventional financial statements. Flags: - --sum show sum of posting amounts (default) - --valuechange show total change of period-end historical - balance value (caused by deposits, withdrawals, - market price fluctuations) - --gain show unrealised capital gain/loss (historical - balance value minus cost basis) - --count show the count of postings - --change accumulate amounts from column start to column - end (in multicolumn reports) (default) - --cumulative accumulate amounts from report start (specified - by e.g. -b/--begin) to column end - -H --historical accumulate amounts from journal start to column - end (includes postings before report start date) - -l --flat show accounts as a flat list (default). Amounts - exclude subaccount amounts, except where the - account is depth-clipped. - -t --tree show accounts as a tree. Amounts include - subaccount amounts. - --drop=N flat mode: omit N leading account name parts + --sum calculation mode: show sum of posting amounts + (default) + --valuechange calculation mode: show total change of value of + period-end historical balances (caused by deposits, + withdrawals, market price fluctuations) + --gain calculation mode: show unrealised capital + gain/loss (historical balance value minus cost + basis) + --count calculation mode: show the count of postings + --change accumulation mode: accumulate amounts from column + start to column end (in multicolumn reports) + (default) + --cumulative accumulation mode: accumulate amounts from report + start (specified by e.g. -b/--begin) to column end + -H --historical accumulation mode: accumulate amounts from + journal start to column end (includes postings + before report start date) + -l --flat list/tree mode: show accounts as a flat list + (default). Amounts exclude subaccount amounts, + except where the account is depth-clipped. + -t --tree list/tree mode: show accounts as a tree. Amounts + include subaccount amounts. + --drop=N in list mode, omit N leading account name parts --declared include non-parent declared accounts (best used with -E) -A --average show a row average column (in multicolumn @@ -35,8 +39,7 @@ Flags: --summary-only display only row summaries (e.g. row total, average) (in multicolumn reports) -N --no-total omit the final total row - --no-elide don't squash boring parent accounts (in tree - mode) + --no-elide in tree mode, don't squash boring parent accounts --format=FORMATSTR use this custom line format (in simple reports) -S --sort-amount sort by amount instead of account code/name -% --percent express values in percentage of each column's diff --git a/hledger/Hledger/Cli/Commands/Incomestatement.md b/hledger/Hledger/Cli/Commands/Incomestatement.md index e572391ff..184cf6cab 100644 --- a/hledger/Hledger/Cli/Commands/Incomestatement.md +++ b/hledger/Hledger/Cli/Commands/Incomestatement.md @@ -7,25 +7,29 @@ Amounts are shown with normal positive sign, as in conventional financial statem ```flags Flags: - --sum show sum of posting amounts (default) - --valuechange show total change of period-end historical - balance value (caused by deposits, withdrawals, - market price fluctuations) - --gain show unrealised capital gain/loss (historical - balance value minus cost basis) - --count show the count of postings - --change accumulate amounts from column start to column - end (in multicolumn reports) (default) - --cumulative accumulate amounts from report start (specified - by e.g. -b/--begin) to column end - -H --historical accumulate amounts from journal start to column - end (includes postings before report start date) - -l --flat show accounts as a flat list (default). Amounts - exclude subaccount amounts, except where the - account is depth-clipped. - -t --tree show accounts as a tree. Amounts include - subaccount amounts. - --drop=N flat mode: omit N leading account name parts + --sum calculation mode: show sum of posting amounts + (default) + --valuechange calculation mode: show total change of value of + period-end historical balances (caused by deposits, + withdrawals, market price fluctuations) + --gain calculation mode: show unrealised capital + gain/loss (historical balance value minus cost + basis) + --count calculation mode: show the count of postings + --change accumulation mode: accumulate amounts from column + start to column end (in multicolumn reports) + (default) + --cumulative accumulation mode: accumulate amounts from report + start (specified by e.g. -b/--begin) to column end + -H --historical accumulation mode: accumulate amounts from + journal start to column end (includes postings + before report start date) + -l --flat list/tree mode: show accounts as a flat list + (default). Amounts exclude subaccount amounts, + except where the account is depth-clipped. + -t --tree list/tree mode: show accounts as a tree. Amounts + include subaccount amounts. + --drop=N in list mode, omit N leading account name parts --declared include non-parent declared accounts (best used with -E) -A --average show a row average column (in multicolumn @@ -34,8 +38,7 @@ Flags: --summary-only display only row summaries (e.g. row total, average) (in multicolumn reports) -N --no-total omit the final total row - --no-elide don't squash boring parent accounts (in tree - mode) + --no-elide in tree mode, don't squash boring parent accounts --format=FORMATSTR use this custom line format (in simple reports) -S --sort-amount sort by amount instead of account code/name -% --percent express values in percentage of each column's diff --git a/hledger/Hledger/Cli/Commands/Incomestatement.txt b/hledger/Hledger/Cli/Commands/Incomestatement.txt index a9e24bc9d..56c706303 100644 --- a/hledger/Hledger/Cli/Commands/Incomestatement.txt +++ b/hledger/Hledger/Cli/Commands/Incomestatement.txt @@ -7,25 +7,29 @@ Amounts are shown with normal positive sign, as in conventional financial statements. Flags: - --sum show sum of posting amounts (default) - --valuechange show total change of period-end historical - balance value (caused by deposits, withdrawals, - market price fluctuations) - --gain show unrealised capital gain/loss (historical - balance value minus cost basis) - --count show the count of postings - --change accumulate amounts from column start to column - end (in multicolumn reports) (default) - --cumulative accumulate amounts from report start (specified - by e.g. -b/--begin) to column end - -H --historical accumulate amounts from journal start to column - end (includes postings before report start date) - -l --flat show accounts as a flat list (default). Amounts - exclude subaccount amounts, except where the - account is depth-clipped. - -t --tree show accounts as a tree. Amounts include - subaccount amounts. - --drop=N flat mode: omit N leading account name parts + --sum calculation mode: show sum of posting amounts + (default) + --valuechange calculation mode: show total change of value of + period-end historical balances (caused by deposits, + withdrawals, market price fluctuations) + --gain calculation mode: show unrealised capital + gain/loss (historical balance value minus cost + basis) + --count calculation mode: show the count of postings + --change accumulation mode: accumulate amounts from column + start to column end (in multicolumn reports) + (default) + --cumulative accumulation mode: accumulate amounts from report + start (specified by e.g. -b/--begin) to column end + -H --historical accumulation mode: accumulate amounts from + journal start to column end (includes postings + before report start date) + -l --flat list/tree mode: show accounts as a flat list + (default). Amounts exclude subaccount amounts, + except where the account is depth-clipped. + -t --tree list/tree mode: show accounts as a tree. Amounts + include subaccount amounts. + --drop=N in list mode, omit N leading account name parts --declared include non-parent declared accounts (best used with -E) -A --average show a row average column (in multicolumn @@ -34,8 +38,7 @@ Flags: --summary-only display only row summaries (e.g. row total, average) (in multicolumn reports) -N --no-total omit the final total row - --no-elide don't squash boring parent accounts (in tree - mode) + --no-elide in tree mode, don't squash boring parent accounts --format=FORMATSTR use this custom line format (in simple reports) -S --sort-amount sort by amount instead of account code/name -% --percent express values in percentage of each column's diff --git a/hledger/Hledger/Cli/Commands/Register.md b/hledger/Hledger/Cli/Commands/Register.md index 87e765091..7c726b490 100644 --- a/hledger/Hledger/Cli/Commands/Register.md +++ b/hledger/Hledger/Cli/Commands/Register.md @@ -6,10 +6,11 @@ Show postings and their running total. ```flags Flags: - --cumulative show running total from report start date - (default) - -H --historical show historical running total/balance (includes - postings before report start date) + --cumulative accumulation mode: show running total from report + start date (default) + -H --historical accumulation mode: show historical running + total/balance (includes postings before report + start date) -A --average show running average of posting amounts instead of total (implies --empty) -m --match=DESC fuzzy search for one recent posting with diff --git a/hledger/Hledger/Cli/Commands/Register.txt b/hledger/Hledger/Cli/Commands/Register.txt index 7bfe615dd..ae9ab1daf 100644 --- a/hledger/Hledger/Cli/Commands/Register.txt +++ b/hledger/Hledger/Cli/Commands/Register.txt @@ -5,10 +5,11 @@ register Show postings and their running total. Flags: - --cumulative show running total from report start date - (default) - -H --historical show historical running total/balance (includes - postings before report start date) + --cumulative accumulation mode: show running total from report + start date (default) + -H --historical accumulation mode: show historical running + total/balance (includes postings before report + start date) -A --average show running average of posting amounts instead of total (implies --empty) -m --match=DESC fuzzy search for one recent posting with