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

;doc: update command docs

Browse Source
This commit is contained in:
Simon Michael 2025-03-08 12:44:57 -10:00
parent 02ef6e45e7
commit b31091195b
16 changed files with 260 additions and 230 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
hledger/Hledger/Cli/Commands/Accounts.md
View File

@ -14,8 +14,9 @@ Flags:
--find find the first account matched by the first --find find the first account matched by the first
argument (a case-insensitive infix regexp or argument (a case-insensitive infix regexp or
account name) account name)
-l --flat show accounts as a flat list (default) -l --flat list/tree mode: show accounts as a flat list
-t --tree show accounts as a tree (default)
-t --tree list/tree mode: show accounts as a tree
--drop=N flat mode: omit N leading account name parts --drop=N flat mode: omit N leading account name parts
``` ```

5
hledger/Hledger/Cli/Commands/Accounts.txt
View File

@ -13,8 +13,9 @@ Flags:
--find find the first account matched by the first --find find the first account matched by the first
argument (a case-insensitive infix regexp or argument (a case-insensitive infix regexp or
account name) account name)
-l --flat show accounts as a flat list (default) -l --flat list/tree mode: show accounts as a flat list
-t --tree show accounts as a tree (default)
-t --tree list/tree mode: show accounts as a tree
--drop=N flat mode: omit N leading account name parts --drop=N flat mode: omit N leading account name parts
This command lists account names. By default it shows all known This command lists account names. By default it shows all known

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

@ -11,9 +11,11 @@ Flags:
date. Warning: this can show a wrong running date. Warning: this can show a wrong running
balance. balance.
--no-elide don't show only 2 commodities per amount --no-elide don't show only 2 commodities per amount
--cumulative show running total from report start date --cumulative accumulation mode: show running total from report
-H --historical show historical running total/balance (includes start date
postings before report start date) (default) -H --historical accumulation mode: show historical running
total/balance (includes postings before report
start date) (default)
--invert display all amounts with reversed sign --invert display all amounts with reversed sign
--heading=YN show heading row above table: yes (default) or no --heading=YN show heading row above table: yes (default) or no
-w --width=N set output width (default: terminal width). -wN,M -w --width=N set output width (default: terminal width). -wN,M

8
hledger/Hledger/Cli/Commands/Aregister.txt
View File

@ -10,9 +10,11 @@ Flags:
date. Warning: this can show a wrong running date. Warning: this can show a wrong running
balance. balance.
--no-elide don't show only 2 commodities per amount --no-elide don't show only 2 commodities per amount
--cumulative show running total from report start date --cumulative accumulation mode: show running total from report
-H --historical show historical running total/balance (includes start date
postings before report start date) (default) -H --historical accumulation mode: show historical running
total/balance (includes postings before report
start date) (default)
--invert display all amounts with reversed sign --invert display all amounts with reversed sign
--heading=YN show heading row above table: yes (default) or no --heading=YN show heading row above table: yes (default) or no
-w --width=N set output width (default: terminal width). -wN,M -w --width=N set output width (default: terminal width). -wN,M

47
hledger/Hledger/Cli/Commands/Balance.md
View File

@ -7,32 +7,36 @@ This can be balance changes per period, end balances, budget performance, unreal
```flags ```flags
Flags: Flags:
--sum show sum of posting amounts (default) --sum calculation mode: show sum of posting amounts
--valuechange show total change of value of period-end (default)
historical balances (caused by deposits, --valuechange calculation mode: show total change of value of
period-end historical balances (caused by deposits,
withdrawals, market price fluctuations) withdrawals, market price fluctuations)
--gain show unrealised capital gain/loss (historical --gain calculation mode: show unrealised capital
balance value minus cost basis) gain/loss (historical balance value minus cost
--budget[=DESCPAT] show sum of posting amounts together with budget basis)
goals defined by periodic --budget[=DESCPAT] calculation mode: show sum of posting amounts
together with budget goals defined by periodic
transactions. With a DESCPAT argument (must be transactions. With a DESCPAT argument (must be
separated by = not space), separated by = not space),
use only periodic transactions with matching use only periodic transactions with matching
description description
(case insensitive substring match). (case insensitive substring match).
--count show the count of postings --count calculation mode: show the count of postings
--change accumulate amounts from column start to column --change accumulation mode: accumulate amounts from column
end (in multicolumn reports, default) start to column end (in multicolumn reports,
--cumulative accumulate amounts from report start (specified default)
by e.g. -b/--begin) to column end --cumulative accumulation mode: accumulate amounts from report
-H --historical accumulate amounts from journal start to column start (specified by e.g. -b/--begin) to column end
end (includes postings before report start date) -H --historical accumulation mode: accumulate amounts from
-l --flat show accounts as a flat list (default). Amounts journal start to column end (includes postings
exclude subaccount amounts, except where the before report start date)
account is depth-clipped. -l --flat list/tree mode: show accounts as a flat list
-t --tree show accounts as a tree. Amounts include (default). Amounts exclude subaccount amounts,
subaccount amounts. except where the account is depth-clipped.
--drop=N omit N leading account name parts (in flat mode) -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 --declared include non-parent declared accounts (best used
with -E) with -E)
-A --average show a row average column (in multicolumn -A --average show a row average column (in multicolumn
@ -41,8 +45,7 @@ Flags:
--summary-only display only row summaries (e.g. row total, --summary-only display only row summaries (e.g. row total,
average) (in multicolumn reports) average) (in multicolumn reports)
-N --no-total omit the final total row -N --no-total omit the final total row
--no-elide don't squash boring parent accounts (in tree --no-elide in tree mode, don't squash boring parent accounts
mode)
--format=FORMATSTR use this custom line format (in simple reports) --format=FORMATSTR use this custom line format (in simple reports)
-S --sort-amount sort by amount instead of account code/name (in -S --sort-amount sort by amount instead of account code/name (in
flat mode). With multiple columns, sorts by the row flat mode). With multiple columns, sorts by the row

47
hledger/Hledger/Cli/Commands/Balance.txt
View File

@ -7,32 +7,36 @@ some kind of numeric data. This can be balance changes per period, end
balances, budget performance, unrealised capital gains, etc. balances, budget performance, unrealised capital gains, etc.
Flags: Flags:
--sum show sum of posting amounts (default) --sum calculation mode: show sum of posting amounts
--valuechange show total change of value of period-end (default)
historical balances (caused by deposits, --valuechange calculation mode: show total change of value of
period-end historical balances (caused by deposits,
withdrawals, market price fluctuations) withdrawals, market price fluctuations)
--gain show unrealised capital gain/loss (historical --gain calculation mode: show unrealised capital
balance value minus cost basis) gain/loss (historical balance value minus cost
--budget[=DESCPAT] show sum of posting amounts together with budget basis)
goals defined by periodic --budget[=DESCPAT] calculation mode: show sum of posting amounts
together with budget goals defined by periodic
transactions. With a DESCPAT argument (must be transactions. With a DESCPAT argument (must be
separated by = not space), separated by = not space),
use only periodic transactions with matching use only periodic transactions with matching
description description
(case insensitive substring match). (case insensitive substring match).
--count show the count of postings --count calculation mode: show the count of postings
--change accumulate amounts from column start to column --change accumulation mode: accumulate amounts from column
end (in multicolumn reports, default) start to column end (in multicolumn reports,
--cumulative accumulate amounts from report start (specified default)
by e.g. -b/--begin) to column end --cumulative accumulation mode: accumulate amounts from report
-H --historical accumulate amounts from journal start to column start (specified by e.g. -b/--begin) to column end
end (includes postings before report start date) -H --historical accumulation mode: accumulate amounts from
-l --flat show accounts as a flat list (default). Amounts journal start to column end (includes postings
exclude subaccount amounts, except where the before report start date)
account is depth-clipped. -l --flat list/tree mode: show accounts as a flat list
-t --tree show accounts as a tree. Amounts include (default). Amounts exclude subaccount amounts,
subaccount amounts. except where the account is depth-clipped.
--drop=N omit N leading account name parts (in flat mode) -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 --declared include non-parent declared accounts (best used
with -E) with -E)
-A --average show a row average column (in multicolumn -A --average show a row average column (in multicolumn
@ -41,8 +45,7 @@ Flags:
--summary-only display only row summaries (e.g. row total, --summary-only display only row summaries (e.g. row total,
average) (in multicolumn reports) average) (in multicolumn reports)
-N --no-total omit the final total row -N --no-total omit the final total row
--no-elide don't squash boring parent accounts (in tree --no-elide in tree mode, don't squash boring parent accounts
mode)
--format=FORMATSTR use this custom line format (in simple reports) --format=FORMATSTR use this custom line format (in simple reports)
-S --sort-amount sort by amount instead of account code/name (in -S --sort-amount sort by amount instead of account code/name (in
flat mode). With multiple columns, sorts by the row flat mode). With multiple columns, sorts by the row

43
hledger/Hledger/Cli/Commands/Balancesheet.md
View File

@ -7,26 +7,28 @@ Amounts are shown with normal positive sign, as in conventional financial statem
```flags ```flags
Flags: Flags:
--sum show sum of posting amounts (default) --sum calculation mode: show sum of posting amounts
--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)
(default) (default)
-l --flat show accounts as a flat list (default). Amounts --valuechange calculation mode: show total change of value of
exclude subaccount amounts, except where the period-end historical balances (caused by deposits,
account is depth-clipped. withdrawals, market price fluctuations)
-t --tree show accounts as a tree. Amounts include --gain calculation mode: show unrealised capital
subaccount amounts. gain/loss (historical balance value minus cost
--drop=N flat mode: omit N leading account name parts 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 --declared include non-parent declared accounts (best used
with -E) with -E)
-A --average show a row average column (in multicolumn -A --average show a row average column (in multicolumn
@ -35,8 +37,7 @@ Flags:
--summary-only display only row summaries (e.g. row total, --summary-only display only row summaries (e.g. row total,
average) (in multicolumn reports) average) (in multicolumn reports)
-N --no-total omit the final total row -N --no-total omit the final total row
--no-elide don't squash boring parent accounts (in tree --no-elide in tree mode, don't squash boring parent accounts
mode)
--format=FORMATSTR use this custom line format (in simple reports) --format=FORMATSTR use this custom line format (in simple reports)
-S --sort-amount sort by amount instead of account code/name -S --sort-amount sort by amount instead of account code/name
-% --percent express values in percentage of each column's -% --percent express values in percentage of each column's

43
hledger/Hledger/Cli/Commands/Balancesheet.txt
View File

@ -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. with normal positive sign, as in conventional financial statements.
Flags: Flags:
--sum show sum of posting amounts (default) --sum calculation mode: show sum of posting amounts
--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)
(default) (default)
-l --flat show accounts as a flat list (default). Amounts --valuechange calculation mode: show total change of value of
exclude subaccount amounts, except where the period-end historical balances (caused by deposits,
account is depth-clipped. withdrawals, market price fluctuations)
-t --tree show accounts as a tree. Amounts include --gain calculation mode: show unrealised capital
subaccount amounts. gain/loss (historical balance value minus cost
--drop=N flat mode: omit N leading account name parts 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 --declared include non-parent declared accounts (best used
with -E) with -E)
-A --average show a row average column (in multicolumn -A --average show a row average column (in multicolumn
@ -34,8 +36,7 @@ Flags:
--summary-only display only row summaries (e.g. row total, --summary-only display only row summaries (e.g. row total,
average) (in multicolumn reports) average) (in multicolumn reports)
-N --no-total omit the final total row -N --no-total omit the final total row
--no-elide don't squash boring parent accounts (in tree --no-elide in tree mode, don't squash boring parent accounts
mode)
--format=FORMATSTR use this custom line format (in simple reports) --format=FORMATSTR use this custom line format (in simple reports)
-S --sort-amount sort by amount instead of account code/name -S --sort-amount sort by amount instead of account code/name
-% --percent express values in percentage of each column's -% --percent express values in percentage of each column's

43
hledger/Hledger/Cli/Commands/Balancesheetequity.md
View File

@ -9,26 +9,28 @@ financial statements.
```flags ```flags
Flags: Flags:
--sum show sum of posting amounts (default) --sum calculation mode: show sum of posting amounts
--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)
(default) (default)
-l --flat show accounts as a flat list (default). Amounts --valuechange calculation mode: show total change of value of
exclude subaccount amounts, except where the period-end historical balances (caused by deposits,
account is depth-clipped. withdrawals, market price fluctuations)
-t --tree show accounts as a tree. Amounts include --gain calculation mode: show unrealised capital
subaccount amounts. gain/loss (historical balance value minus cost
--drop=N flat mode: omit N leading account name parts 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 --declared include non-parent declared accounts (best used
with -E) with -E)
-A --average show a row average column (in multicolumn -A --average show a row average column (in multicolumn
@ -37,8 +39,7 @@ Flags:
--summary-only display only row summaries (e.g. row total, --summary-only display only row summaries (e.g. row total,
average) (in multicolumn reports) average) (in multicolumn reports)
-N --no-total omit the final total row -N --no-total omit the final total row
--no-elide don't squash boring parent accounts (in tree --no-elide in tree mode, don't squash boring parent accounts
mode)
--format=FORMATSTR use this custom line format (in simple reports) --format=FORMATSTR use this custom line format (in simple reports)
-S --sort-amount sort by amount instead of account code/name -S --sort-amount sort by amount instead of account code/name
-% --percent express values in percentage of each column's -% --percent express values in percentage of each column's

43
hledger/Hledger/Cli/Commands/Balancesheetequity.txt
View File

@ -7,26 +7,28 @@ balances of asset, liability and equity accounts. Amounts are shown with
normal positive sign, as in conventional financial statements. normal positive sign, as in conventional financial statements.
Flags: Flags:
--sum show sum of posting amounts (default) --sum calculation mode: show sum of posting amounts
--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)
(default) (default)
-l --flat show accounts as a flat list (default). Amounts --valuechange calculation mode: show total change of value of
exclude subaccount amounts, except where the period-end historical balances (caused by deposits,
account is depth-clipped. withdrawals, market price fluctuations)
-t --tree show accounts as a tree. Amounts include --gain calculation mode: show unrealised capital
subaccount amounts. gain/loss (historical balance value minus cost
--drop=N flat mode: omit N leading account name parts 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 --declared include non-parent declared accounts (best used
with -E) with -E)
-A --average show a row average column (in multicolumn -A --average show a row average column (in multicolumn
@ -35,8 +37,7 @@ Flags:
--summary-only display only row summaries (e.g. row total, --summary-only display only row summaries (e.g. row total,
average) (in multicolumn reports) average) (in multicolumn reports)
-N --no-total omit the final total row -N --no-total omit the final total row
--no-elide don't squash boring parent accounts (in tree --no-elide in tree mode, don't squash boring parent accounts
mode)
--format=FORMATSTR use this custom line format (in simple reports) --format=FORMATSTR use this custom line format (in simple reports)
-S --sort-amount sort by amount instead of account code/name -S --sort-amount sort by amount instead of account code/name
-% --percent express values in percentage of each column's -% --percent express values in percentage of each column's

45
hledger/Hledger/Cli/Commands/Cashflow.md
View File

@ -9,25 +9,29 @@ financial statements.
```flags ```flags
Flags: Flags:
--sum show sum of posting amounts (default) --sum calculation mode: show sum of posting amounts
--valuechange show total change of period-end historical (default)
balance value (caused by deposits, withdrawals, --valuechange calculation mode: show total change of value of
market price fluctuations) period-end historical balances (caused by deposits,
--gain show unrealised capital gain/loss (historical withdrawals, market price fluctuations)
balance value minus cost basis) --gain calculation mode: show unrealised capital
--count show the count of postings gain/loss (historical balance value minus cost
--change accumulate amounts from column start to column basis)
end (in multicolumn reports) (default) --count calculation mode: show the count of postings
--cumulative accumulate amounts from report start (specified --change accumulation mode: accumulate amounts from column
by e.g. -b/--begin) to column end start to column end (in multicolumn reports)
-H --historical accumulate amounts from journal start to column (default)
end (includes postings before report start date) --cumulative accumulation mode: accumulate amounts from report
-l --flat show accounts as a flat list (default). Amounts start (specified by e.g. -b/--begin) to column end
exclude subaccount amounts, except where the -H --historical accumulation mode: accumulate amounts from
account is depth-clipped. journal start to column end (includes postings
-t --tree show accounts as a tree. Amounts include before report start date)
subaccount amounts. -l --flat list/tree mode: show accounts as a flat list
--drop=N flat mode: omit N leading account name parts (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 --declared include non-parent declared accounts (best used
with -E) with -E)
-A --average show a row average column (in multicolumn -A --average show a row average column (in multicolumn
@ -36,8 +40,7 @@ Flags:
--summary-only display only row summaries (e.g. row total, --summary-only display only row summaries (e.g. row total,
average) (in multicolumn reports) average) (in multicolumn reports)
-N --no-total omit the final total row -N --no-total omit the final total row
--no-elide don't squash boring parent accounts (in tree --no-elide in tree mode, don't squash boring parent accounts
mode)
--format=FORMATSTR use this custom line format (in simple reports) --format=FORMATSTR use this custom line format (in simple reports)
-S --sort-amount sort by amount instead of account code/name -S --sort-amount sort by amount instead of account code/name
-% --percent express values in percentage of each column's -% --percent express values in percentage of each column's

45
hledger/Hledger/Cli/Commands/Cashflow.txt
View File

@ -8,25 +8,29 @@ Amounts are shown with normal positive sign, as in conventional
financial statements. financial statements.
Flags: Flags:
--sum show sum of posting amounts (default) --sum calculation mode: show sum of posting amounts
--valuechange show total change of period-end historical (default)
balance value (caused by deposits, withdrawals, --valuechange calculation mode: show total change of value of
market price fluctuations) period-end historical balances (caused by deposits,
--gain show unrealised capital gain/loss (historical withdrawals, market price fluctuations)
balance value minus cost basis) --gain calculation mode: show unrealised capital
--count show the count of postings gain/loss (historical balance value minus cost
--change accumulate amounts from column start to column basis)
end (in multicolumn reports) (default) --count calculation mode: show the count of postings
--cumulative accumulate amounts from report start (specified --change accumulation mode: accumulate amounts from column
by e.g. -b/--begin) to column end start to column end (in multicolumn reports)
-H --historical accumulate amounts from journal start to column (default)
end (includes postings before report start date) --cumulative accumulation mode: accumulate amounts from report
-l --flat show accounts as a flat list (default). Amounts start (specified by e.g. -b/--begin) to column end
exclude subaccount amounts, except where the -H --historical accumulation mode: accumulate amounts from
account is depth-clipped. journal start to column end (includes postings
-t --tree show accounts as a tree. Amounts include before report start date)
subaccount amounts. -l --flat list/tree mode: show accounts as a flat list
--drop=N flat mode: omit N leading account name parts (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 --declared include non-parent declared accounts (best used
with -E) with -E)
-A --average show a row average column (in multicolumn -A --average show a row average column (in multicolumn
@ -35,8 +39,7 @@ Flags:
--summary-only display only row summaries (e.g. row total, --summary-only display only row summaries (e.g. row total,
average) (in multicolumn reports) average) (in multicolumn reports)
-N --no-total omit the final total row -N --no-total omit the final total row
--no-elide don't squash boring parent accounts (in tree --no-elide in tree mode, don't squash boring parent accounts
mode)
--format=FORMATSTR use this custom line format (in simple reports) --format=FORMATSTR use this custom line format (in simple reports)
-S --sort-amount sort by amount instead of account code/name -S --sort-amount sort by amount instead of account code/name
-% --percent express values in percentage of each column's -% --percent express values in percentage of each column's

45
hledger/Hledger/Cli/Commands/Incomestatement.md
View File

@ -7,25 +7,29 @@ Amounts are shown with normal positive sign, as in conventional financial statem
```flags ```flags
Flags: Flags:
--sum show sum of posting amounts (default) --sum calculation mode: show sum of posting amounts
--valuechange show total change of period-end historical (default)
balance value (caused by deposits, withdrawals, --valuechange calculation mode: show total change of value of
market price fluctuations) period-end historical balances (caused by deposits,
--gain show unrealised capital gain/loss (historical withdrawals, market price fluctuations)
balance value minus cost basis) --gain calculation mode: show unrealised capital
--count show the count of postings gain/loss (historical balance value minus cost
--change accumulate amounts from column start to column basis)
end (in multicolumn reports) (default) --count calculation mode: show the count of postings
--cumulative accumulate amounts from report start (specified --change accumulation mode: accumulate amounts from column
by e.g. -b/--begin) to column end start to column end (in multicolumn reports)
-H --historical accumulate amounts from journal start to column (default)
end (includes postings before report start date) --cumulative accumulation mode: accumulate amounts from report
-l --flat show accounts as a flat list (default). Amounts start (specified by e.g. -b/--begin) to column end
exclude subaccount amounts, except where the -H --historical accumulation mode: accumulate amounts from
account is depth-clipped. journal start to column end (includes postings
-t --tree show accounts as a tree. Amounts include before report start date)
subaccount amounts. -l --flat list/tree mode: show accounts as a flat list
--drop=N flat mode: omit N leading account name parts (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 --declared include non-parent declared accounts (best used
with -E) with -E)
-A --average show a row average column (in multicolumn -A --average show a row average column (in multicolumn
@ -34,8 +38,7 @@ Flags:
--summary-only display only row summaries (e.g. row total, --summary-only display only row summaries (e.g. row total,
average) (in multicolumn reports) average) (in multicolumn reports)
-N --no-total omit the final total row -N --no-total omit the final total row
--no-elide don't squash boring parent accounts (in tree --no-elide in tree mode, don't squash boring parent accounts
mode)
--format=FORMATSTR use this custom line format (in simple reports) --format=FORMATSTR use this custom line format (in simple reports)
-S --sort-amount sort by amount instead of account code/name -S --sort-amount sort by amount instead of account code/name
-% --percent express values in percentage of each column's -% --percent express values in percentage of each column's

45
hledger/Hledger/Cli/Commands/Incomestatement.txt
View File

@ -7,25 +7,29 @@ Amounts are shown with normal positive sign, as in conventional
financial statements. financial statements.
Flags: Flags:
--sum show sum of posting amounts (default) --sum calculation mode: show sum of posting amounts
--valuechange show total change of period-end historical (default)
balance value (caused by deposits, withdrawals, --valuechange calculation mode: show total change of value of
market price fluctuations) period-end historical balances (caused by deposits,
--gain show unrealised capital gain/loss (historical withdrawals, market price fluctuations)
balance value minus cost basis) --gain calculation mode: show unrealised capital
--count show the count of postings gain/loss (historical balance value minus cost
--change accumulate amounts from column start to column basis)
end (in multicolumn reports) (default) --count calculation mode: show the count of postings
--cumulative accumulate amounts from report start (specified --change accumulation mode: accumulate amounts from column
by e.g. -b/--begin) to column end start to column end (in multicolumn reports)
-H --historical accumulate amounts from journal start to column (default)
end (includes postings before report start date) --cumulative accumulation mode: accumulate amounts from report
-l --flat show accounts as a flat list (default). Amounts start (specified by e.g. -b/--begin) to column end
exclude subaccount amounts, except where the -H --historical accumulation mode: accumulate amounts from
account is depth-clipped. journal start to column end (includes postings
-t --tree show accounts as a tree. Amounts include before report start date)
subaccount amounts. -l --flat list/tree mode: show accounts as a flat list
--drop=N flat mode: omit N leading account name parts (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 --declared include non-parent declared accounts (best used
with -E) with -E)
-A --average show a row average column (in multicolumn -A --average show a row average column (in multicolumn
@ -34,8 +38,7 @@ Flags:
--summary-only display only row summaries (e.g. row total, --summary-only display only row summaries (e.g. row total,
average) (in multicolumn reports) average) (in multicolumn reports)
-N --no-total omit the final total row -N --no-total omit the final total row
--no-elide don't squash boring parent accounts (in tree --no-elide in tree mode, don't squash boring parent accounts
mode)
--format=FORMATSTR use this custom line format (in simple reports) --format=FORMATSTR use this custom line format (in simple reports)
-S --sort-amount sort by amount instead of account code/name -S --sort-amount sort by amount instead of account code/name
-% --percent express values in percentage of each column's -% --percent express values in percentage of each column's

9
hledger/Hledger/Cli/Commands/Register.md
View File

@ -6,10 +6,11 @@ Show postings and their running total.
```flags ```flags
Flags: Flags:
--cumulative show running total from report start date --cumulative accumulation mode: show running total from report
(default) start date (default)
-H --historical show historical running total/balance (includes -H --historical accumulation mode: show historical running
postings before report start date) total/balance (includes postings before report
start date)
-A --average show running average of posting amounts instead -A --average show running average of posting amounts instead
of total (implies --empty) of total (implies --empty)
-m --match=DESC fuzzy search for one recent posting with -m --match=DESC fuzzy search for one recent posting with

9
hledger/Hledger/Cli/Commands/Register.txt
View File

@ -5,10 +5,11 @@ register
Show postings and their running total. Show postings and their running total.
Flags: Flags:
--cumulative show running total from report start date --cumulative accumulation mode: show running total from report
(default) start date (default)
-H --historical show historical running total/balance (includes -H --historical accumulation mode: show historical running
postings before report start date) total/balance (includes postings before report
start date)
-A --average show running average of posting amounts instead -A --average show running average of posting amounts instead
of total (implies --empty) of total (implies --empty)
-m --match=DESC fuzzy search for one recent posting with -m --match=DESC fuzzy search for one recent posting with