full documentation of new command structure

This commit is contained in:
Justin Le 2017-02-04 00:58:21 -08:00 committed by Simon Michael
parent bc67c2a769
commit 5ef30d1d4d
3 changed files with 31 additions and 4 deletions

View File

@ -148,6 +148,10 @@ m4_define({{_reportingoptions_}}, {{
: convert amounts to their cost at transaction time : convert amounts to their cost at transaction time
(using the [transaction price](journal.html#transaction-prices), if any) (using the [transaction price](journal.html#transaction-prices), if any)
`-V --value`
: convert amounts to their market value on the report end date
(using the most recent applicable [market price](journal.html#market-prices), if any)
`--pivot TAGNAME` `--pivot TAGNAME`
: organize reports by some tag's value instead of by account : organize reports by some tag's value instead of by account

View File

@ -16,10 +16,6 @@ Show accounts and their balances. Alias: bal.
`--flat` `--flat`
: show accounts as a list; amounts exclude subaccounts except when account is depth-clipped (default in multicolumn reports) : show accounts as a list; amounts exclude subaccounts except when account is depth-clipped (default in multicolumn reports)
`-V --value`
: convert amounts to their market value on the report end date
(using the most recent applicable [market price](journal.html#market-prices), if any)
`-A --average` `-A --average`
: show a row average column (in multicolumn mode) : show a row average column (in multicolumn mode)

View File

@ -172,9 +172,18 @@ Show a balance sheet. Alias: bs.
`--flat` `--flat`
: show full account names, as a list (default) : show full account names, as a list (default)
`-N --no-total`
: don't show the final total row
`--drop=N` `--drop=N`
: in flat mode: omit N leading account name parts : in flat mode: omit N leading account name parts
`--no-elide`
: don't squash boring parent accounts (in tree mode)
`--format=LINEFORMAT`
: in single-column balance reports: use this custom line format
This command displays a simple This command displays a simple
[balance sheet](http://en.wikipedia.org/wiki/Balance_sheet). It currently [balance sheet](http://en.wikipedia.org/wiki/Balance_sheet). It currently
assumes that you have top-level accounts named `asset` and `liability` assumes that you have top-level accounts named `asset` and `liability`
@ -207,9 +216,18 @@ Show a cashflow statement. Alias: cf.
`--flat` `--flat`
: show full account names, as a list (default) : show full account names, as a list (default)
`-N --no-total`
: don't show the final total row
`--drop=N` `--drop=N`
: in flat mode: omit N leading account name parts : in flat mode: omit N leading account name parts
`--no-elide`
: don't squash boring parent accounts (in tree mode)
`--format=LINEFORMAT`
: in single-column balance reports: use this custom line format
This command displays a simple This command displays a simple
[cashflow statement](http://en.wikipedia.org/wiki/Cash_flow_statement) [cashflow statement](http://en.wikipedia.org/wiki/Cash_flow_statement)
It shows the change in all "cash" (ie, liquid assets) accounts for the It shows the change in all "cash" (ie, liquid assets) accounts for the
@ -272,9 +290,18 @@ Show an income statement. Alias: is.
`--flat` `--flat`
: show full account names, as a list (default) : show full account names, as a list (default)
`-N --no-total`
: don't show the final total row
`--drop=N` `--drop=N`
: in flat mode: omit N leading account name parts : in flat mode: omit N leading account name parts
`--no-elide`
: don't squash boring parent accounts (in tree mode)
`--format=LINEFORMAT`
: in single-column balance reports: use this custom line format
This command displays a simple This command displays a simple
[income statement](http://en.wikipedia.org/wiki/Income_statement). It [income statement](http://en.wikipedia.org/wiki/Income_statement). It
currently assumes that you have top-level accounts named `income` (or currently assumes that you have top-level accounts named `income` (or