;doc: update embedded manuals

This commit is contained in:
Simon Michael 2025-03-08 12:46:13 -10:00
parent b31091195b
commit dcd5221489
6 changed files with 2933 additions and 2883 deletions

View File

@ -51,15 +51,14 @@ with a date field.
.PP
hledger\-web can be run in three modes:
.IP \[bu] 2
Transient mode (the default): your default web browser will be opened to
show the app if possible, and the app exits automatically after two
minutes of inactivity (no requests received and no open browser windows
viewing it).
\f[CR]\-\-serve\-browse\f[R] mode (the default): the app serves the web
UI and JSON API, and opens your default web browser to show the app if
possible, and exits automatically after two minutes of inactivity (with
no requests received and no open browser windows viewing it).
.IP \[bu] 2
With \f[CR]\-\-serve\f[R]: the app runs without stopping, and without
opening a browser.
\f[CR]\-\-serve\f[R]: the app just serves the web UI and JSON API.
.IP \[bu] 2
With \f[CR]\-\-serve\-api\f[R]: only the JSON API is served.
\f[CR]\-\-serve\-api\f[R]: the app just serves the JSON API.
.PP
In all cases hledger\-web runs as a foreground process, logging requests
to stdout.

View File

@ -47,15 +47,14 @@ with a date field. (See hledger(1) -> Input for details.)
hledger-web can be run in three modes:
* Transient mode (the default): your default web browser will be
opened to show the app if possible, and the app exits automatically
after two minutes of inactivity (no requests received and no open
browser windows viewing it).
* '--serve-browse' mode (the default): the app serves the web UI and
JSON API, and opens your default web browser to show the app if
possible, and exits automatically after two minutes of inactivity
(with no requests received and no open browser windows viewing it).
* With '--serve': the app runs without stopping, and without opening
a browser.
* '--serve': the app just serves the web UI and JSON API.
* With '--serve-api': only the JSON API is served.
* '--serve-api': the app just serves the JSON API.
In all cases hledger-web runs as a foreground process, logging
requests to stdout.
@ -529,15 +528,15 @@ https://bugs.hledger.org), or on the hledger chat or mail list

Tag Table:
Node: Top223
Node: OPTIONS2569
Node: PERMISSIONS11258
Node: EDITING UPLOADING DOWNLOADING12609
Node: RELOADING13624
Node: JSON API14191
Node: DEBUG OUTPUT19840
Node: Debug output19992
Node: ENVIRONMENT20510
Node: BUGS20746
Node: OPTIONS2581
Node: PERMISSIONS11270
Node: EDITING UPLOADING DOWNLOADING12621
Node: RELOADING13636
Node: JSON API14203
Node: DEBUG OUTPUT19852
Node: Debug output20004
Node: ENVIRONMENT20522
Node: BUGS20758

End Tag Table

View File

@ -40,15 +40,14 @@ DESCRIPTION
hledger-web can be run in three modes:
o Transient mode (the default): your default web browser will be opened
to show the app if possible, and the app exits automatically after
two minutes of inactivity (no requests received and no open browser
windows viewing it).
o --serve-browse mode (the default): the app serves the web UI and JSON
API, and opens your default web browser to show the app if possible,
and exits automatically after two minutes of inactivity (with no re-
quests received and no open browser windows viewing it).
o With --serve: the app runs without stopping, and without opening a
browser.
o --serve: the app just serves the web UI and JSON API.
o With --serve-api: only the JSON API is served.
o --serve-api: the app just serves the JSON API.
In all cases hledger-web runs as a foreground process, logging requests
to stdout.

View File

@ -447,8 +447,12 @@ Usually hledger accepts any unambiguous flag prefix, eg you can write
\f[CR]\-\-tl\f[R] instead of \f[CR]\-\-tldr\f[R] or \f[CR]\-\-dry\f[R]
instead of \f[CR]\-\-dry\-run\f[R].
.PP
If the same option appears more than once in a command, usually the last
(right\-most) wins.
If the same option appears more than once in a command line, usually the
last (right\-most) wins.
Similarly, if mutually exclusive flags are used together, the
right\-most wins.
(When flags are mutually exclusive, they\[aq]ll usually have a group
prefix in \-\-help.)
.PP
With most commands, arguments are interpreted as a hledger query which
filter the data.
@ -8975,8 +8979,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
.EE
.PP
@ -9525,9 +9530,11 @@ Flags:
date. Warning: this can show a wrong running
balance.
\-\-no\-elide don\[aq]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
@ -9638,10 +9645,11 @@ Show postings and their running total.
.IP
.EX
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
@ -9826,26 +9834,28 @@ financial statements.
.IP
.EX
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
@ -9854,8 +9864,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\[aq]t squash boring parent accounts (in tree
mode)
\-\-no\-elide in tree mode, don\[aq]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\[aq]s
@ -9928,26 +9937,28 @@ financial statements.
.IP
.EX
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
@ -9956,8 +9967,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\[aq]t squash boring parent accounts (in tree
mode)
\-\-no\-elide in tree mode, don\[aq]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\[aq]s
@ -10038,25 +10048,29 @@ financial statements.
.IP
.EX
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
@ -10065,8 +10079,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\[aq]t squash boring parent accounts (in tree
mode)
\-\-no\-elide in tree mode, don\[aq]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\[aq]s
@ -10137,25 +10150,29 @@ financial statements.
.IP
.EX
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
@ -10164,8 +10181,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\[aq]t squash boring parent accounts (in tree
mode)
\-\-no\-elide in tree mode, don\[aq]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\[aq]s
@ -10240,32 +10256,36 @@ performance, unrealised capital gains, etc.
.IP
.EX
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
@ -10274,8 +10294,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\[aq]t squash boring parent accounts (in tree
mode)
\-\-no\-elide in tree mode, don\[aq]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

File diff suppressed because it is too large Load Diff

View File

@ -344,8 +344,10 @@ Options
Usually hledger accepts any unambiguous flag prefix, eg you can write
--tl instead of --tldr or --dry instead of --dry-run.
If the same option appears more than once in a command, usually the
last (right-most) wins.
If the same option appears more than once in a command line, usually
the last (right-most) wins. Similarly, if mutually exclusive flags are
used together, the right-most wins. (When flags are mutually exclu-
sive, they'll usually have a group prefix in --help.)
With most commands, arguments are interpreted as a hledger query which
filter the data. Some queries can be expressed either with options or
@ -7025,8 +7027,9 @@ Basic report commands
--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 ac-
@ -7511,9 +7514,11 @@ Standard report commands
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
@ -7610,10 +7615,11 @@ Standard report commands
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
@ -7766,26 +7772,28 @@ Standard report commands
ments.
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
@ -7794,8 +7802,7 @@ Standard report commands
--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
@ -7861,26 +7868,28 @@ Standard report commands
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
@ -7889,8 +7898,7 @@ Standard report commands
--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
@ -7962,25 +7970,29 @@ Standard report commands
tional 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
@ -7989,8 +8001,7 @@ Standard report commands
--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
@ -8053,25 +8064,29 @@ Standard report commands
cial 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
@ -8080,8 +8095,7 @@ Standard report commands
--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
@ -8148,32 +8162,36 @@ Advanced report commands
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
@ -8182,8 +8200,7 @@ Advanced report commands
--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