;doc: update help
This commit is contained in:
parent
52402cd084
commit
d88e30ff43
@ -8,6 +8,11 @@ This can be balance changes per period, end balances, budget performance, unreal
|
|||||||
```flags
|
```flags
|
||||||
Flags:
|
Flags:
|
||||||
--sum show sum of posting amounts (default)
|
--sum show sum of posting amounts (default)
|
||||||
|
--valuechange 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
|
--budget[=DESCPAT] show sum of posting amounts together with budget
|
||||||
goals defined by periodic
|
goals defined by periodic
|
||||||
transactions. With a DESCPAT argument (must be
|
transactions. With a DESCPAT argument (must be
|
||||||
@ -15,11 +20,6 @@ Flags:
|
|||||||
use only periodic transactions with matching
|
use only periodic transactions with matching
|
||||||
description
|
description
|
||||||
(case insensitive substring match).
|
(case insensitive substring match).
|
||||||
--valuechange 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)
|
|
||||||
--count show the count of postings
|
--count show the count of postings
|
||||||
--change accumulate amounts from column start to column
|
--change accumulate amounts from column start to column
|
||||||
end (in multicolumn reports, default)
|
end (in multicolumn reports, default)
|
||||||
@ -37,7 +37,6 @@ Flags:
|
|||||||
with -E)
|
with -E)
|
||||||
-A --average show a row average column (in multicolumn
|
-A --average show a row average column (in multicolumn
|
||||||
reports)
|
reports)
|
||||||
-r --related show postings' siblings instead
|
|
||||||
-T --row-total show a row total column (in multicolumn reports)
|
-T --row-total show a row total column (in multicolumn reports)
|
||||||
--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)
|
||||||
@ -50,14 +49,18 @@ Flags:
|
|||||||
total, or by row average if that is displayed.
|
total, or by row average if that is displayed.
|
||||||
-% --percent express values in percentage of each column's
|
-% --percent express values in percentage of each column's
|
||||||
total
|
total
|
||||||
|
-r --related show the other accounts transacted with, instead
|
||||||
--invert display all amounts with reversed sign
|
--invert display all amounts with reversed sign
|
||||||
--transpose transpose rows and columns
|
--transpose switch rows and columns (use vertical time axis)
|
||||||
--layout=ARG how to lay out multi-commodity amounts and the
|
--layout=ARG how to lay out multi-commodity amounts and the
|
||||||
overall table:
|
overall table:
|
||||||
'wide[,WIDTH]': commodities on one line
|
'wide[,WIDTH]': commodities on one line
|
||||||
'tall' : commodities on separate lines
|
'tall' : commodities on separate lines
|
||||||
'bare' : commodity symbols in one column
|
'bare' : commodity symbols in one column
|
||||||
'tidy' : every attribute in its own column
|
'tidy' : every attribute in its own column
|
||||||
|
--base-url=URLPREFIX in html output, generate links to hledger-web,
|
||||||
|
with this prefix. (Usually the base url shown by
|
||||||
|
hledger-web; can also be relative.)
|
||||||
-O --output-format=FMT select the output format. Supported formats:
|
-O --output-format=FMT select the output format. Supported formats:
|
||||||
txt, html, csv, tsv, json, fods.
|
txt, html, csv, tsv, json, fods.
|
||||||
-o --output-file=FILE write output to FILE. A file extension matching
|
-o --output-file=FILE write output to FILE. A file extension matching
|
||||||
|
|||||||
@ -8,6 +8,11 @@ balances, budget performance, unrealised capital gains, etc.
|
|||||||
|
|
||||||
Flags:
|
Flags:
|
||||||
--sum show sum of posting amounts (default)
|
--sum show sum of posting amounts (default)
|
||||||
|
--valuechange 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
|
--budget[=DESCPAT] show sum of posting amounts together with budget
|
||||||
goals defined by periodic
|
goals defined by periodic
|
||||||
transactions. With a DESCPAT argument (must be
|
transactions. With a DESCPAT argument (must be
|
||||||
@ -15,11 +20,6 @@ Flags:
|
|||||||
use only periodic transactions with matching
|
use only periodic transactions with matching
|
||||||
description
|
description
|
||||||
(case insensitive substring match).
|
(case insensitive substring match).
|
||||||
--valuechange 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)
|
|
||||||
--count show the count of postings
|
--count show the count of postings
|
||||||
--change accumulate amounts from column start to column
|
--change accumulate amounts from column start to column
|
||||||
end (in multicolumn reports, default)
|
end (in multicolumn reports, default)
|
||||||
@ -37,7 +37,6 @@ Flags:
|
|||||||
with -E)
|
with -E)
|
||||||
-A --average show a row average column (in multicolumn
|
-A --average show a row average column (in multicolumn
|
||||||
reports)
|
reports)
|
||||||
-r --related show postings' siblings instead
|
|
||||||
-T --row-total show a row total column (in multicolumn reports)
|
-T --row-total show a row total column (in multicolumn reports)
|
||||||
--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)
|
||||||
@ -50,14 +49,18 @@ Flags:
|
|||||||
total, or by row average if that is displayed.
|
total, or by row average if that is displayed.
|
||||||
-% --percent express values in percentage of each column's
|
-% --percent express values in percentage of each column's
|
||||||
total
|
total
|
||||||
|
-r --related show the other accounts transacted with, instead
|
||||||
--invert display all amounts with reversed sign
|
--invert display all amounts with reversed sign
|
||||||
--transpose transpose rows and columns
|
--transpose switch rows and columns (use vertical time axis)
|
||||||
--layout=ARG how to lay out multi-commodity amounts and the
|
--layout=ARG how to lay out multi-commodity amounts and the
|
||||||
overall table:
|
overall table:
|
||||||
'wide[,WIDTH]': commodities on one line
|
'wide[,WIDTH]': commodities on one line
|
||||||
'tall' : commodities on separate lines
|
'tall' : commodities on separate lines
|
||||||
'bare' : commodity symbols in one column
|
'bare' : commodity symbols in one column
|
||||||
'tidy' : every attribute in its own column
|
'tidy' : every attribute in its own column
|
||||||
|
--base-url=URLPREFIX in html output, generate links to hledger-web,
|
||||||
|
with this prefix. (Usually the base url shown by
|
||||||
|
hledger-web; can also be relative.)
|
||||||
-O --output-format=FMT select the output format. Supported formats:
|
-O --output-format=FMT select the output format. Supported formats:
|
||||||
txt, html, csv, tsv, json, fods.
|
txt, html, csv, tsv, json, fods.
|
||||||
-o --output-file=FILE write output to FILE. A file extension matching
|
-o --output-file=FILE write output to FILE. A file extension matching
|
||||||
@ -358,6 +361,15 @@ report for each commodity:
|
|||||||
$ hledger bal -% cur:\\$
|
$ hledger bal -% cur:\\$
|
||||||
$ hledger bal -% cur:€
|
$ hledger bal -% cur:€
|
||||||
|
|
||||||
|
Hyperlinks
|
||||||
|
|
||||||
|
The HTML and FODS output formats can generate hyperlinks to a
|
||||||
|
hledger-web register view for each account and period. E.g. if your
|
||||||
|
hledger-web server is reachable at http://localhost:5000 then you might
|
||||||
|
run the balance command with the extra option
|
||||||
|
--base-url=http://localhost:5000. You can also produce relative links,
|
||||||
|
like --base-url="some/path" or --base-url="".)
|
||||||
|
|
||||||
Multi-period balance report
|
Multi-period balance report
|
||||||
|
|
||||||
With a report interval (set by the -D/--daily, -W/--weekly,
|
With a report interval (set by the -D/--daily, -W/--weekly,
|
||||||
|
|||||||
@ -15,6 +15,7 @@ Flags:
|
|||||||
balance value minus cost basis)
|
balance value minus cost basis)
|
||||||
--budget show sum of posting amounts compared to budget
|
--budget show sum of posting amounts compared to budget
|
||||||
goals defined by periodic transactions
|
goals defined by periodic transactions
|
||||||
|
--count show the count of postings
|
||||||
--change accumulate amounts from column start to column
|
--change accumulate amounts from column start to column
|
||||||
end (in multicolumn reports)
|
end (in multicolumn reports)
|
||||||
--cumulative accumulate amounts from report start (specified
|
--cumulative accumulate amounts from report start (specified
|
||||||
@ -46,6 +47,9 @@ Flags:
|
|||||||
'wide[,WIDTH]': all commodities on one line
|
'wide[,WIDTH]': all commodities on one line
|
||||||
'tall' : each commodity on a new line
|
'tall' : each commodity on a new line
|
||||||
'bare' : bare numbers, symbols in a column
|
'bare' : bare numbers, symbols in a column
|
||||||
|
--base-url=URLPREFIX in html output, generate hyperlinks to
|
||||||
|
hledger-web, with this prefix. (Usually the base
|
||||||
|
url shown by hledger-web; can also be relative.)
|
||||||
-O --output-format=FMT select the output format. Supported formats:
|
-O --output-format=FMT select the output format. Supported formats:
|
||||||
txt, html, csv, tsv, json.
|
txt, html, csv, tsv, json.
|
||||||
-o --output-file=FILE write output to FILE. A file extension matching
|
-o --output-file=FILE write output to FILE. A file extension matching
|
||||||
|
|||||||
@ -14,6 +14,7 @@ Flags:
|
|||||||
balance value minus cost basis)
|
balance value minus cost basis)
|
||||||
--budget show sum of posting amounts compared to budget
|
--budget show sum of posting amounts compared to budget
|
||||||
goals defined by periodic transactions
|
goals defined by periodic transactions
|
||||||
|
--count show the count of postings
|
||||||
--change accumulate amounts from column start to column
|
--change accumulate amounts from column start to column
|
||||||
end (in multicolumn reports)
|
end (in multicolumn reports)
|
||||||
--cumulative accumulate amounts from report start (specified
|
--cumulative accumulate amounts from report start (specified
|
||||||
@ -45,6 +46,9 @@ Flags:
|
|||||||
'wide[,WIDTH]': all commodities on one line
|
'wide[,WIDTH]': all commodities on one line
|
||||||
'tall' : each commodity on a new line
|
'tall' : each commodity on a new line
|
||||||
'bare' : bare numbers, symbols in a column
|
'bare' : bare numbers, symbols in a column
|
||||||
|
--base-url=URLPREFIX in html output, generate hyperlinks to
|
||||||
|
hledger-web, with this prefix. (Usually the base
|
||||||
|
url shown by hledger-web; can also be relative.)
|
||||||
-O --output-format=FMT select the output format. Supported formats:
|
-O --output-format=FMT select the output format. Supported formats:
|
||||||
txt, html, csv, tsv, json.
|
txt, html, csv, tsv, json.
|
||||||
-o --output-file=FILE write output to FILE. A file extension matching
|
-o --output-file=FILE write output to FILE. A file extension matching
|
||||||
|
|||||||
@ -17,6 +17,7 @@ Flags:
|
|||||||
balance value minus cost basis)
|
balance value minus cost basis)
|
||||||
--budget show sum of posting amounts compared to budget
|
--budget show sum of posting amounts compared to budget
|
||||||
goals defined by periodic transactions
|
goals defined by periodic transactions
|
||||||
|
--count show the count of postings
|
||||||
--change accumulate amounts from column start to column
|
--change accumulate amounts from column start to column
|
||||||
end (in multicolumn reports)
|
end (in multicolumn reports)
|
||||||
--cumulative accumulate amounts from report start (specified
|
--cumulative accumulate amounts from report start (specified
|
||||||
@ -48,6 +49,9 @@ Flags:
|
|||||||
'wide[,WIDTH]': all commodities on one line
|
'wide[,WIDTH]': all commodities on one line
|
||||||
'tall' : each commodity on a new line
|
'tall' : each commodity on a new line
|
||||||
'bare' : bare numbers, symbols in a column
|
'bare' : bare numbers, symbols in a column
|
||||||
|
--base-url=URLPREFIX in html output, generate hyperlinks to
|
||||||
|
hledger-web, with this prefix. (Usually the base
|
||||||
|
url shown by hledger-web; can also be relative.)
|
||||||
-O --output-format=FMT select the output format. Supported formats:
|
-O --output-format=FMT select the output format. Supported formats:
|
||||||
txt, html, csv, tsv, json.
|
txt, html, csv, tsv, json.
|
||||||
-o --output-file=FILE write output to FILE. A file extension matching
|
-o --output-file=FILE write output to FILE. A file extension matching
|
||||||
|
|||||||
@ -15,6 +15,7 @@ Flags:
|
|||||||
balance value minus cost basis)
|
balance value minus cost basis)
|
||||||
--budget show sum of posting amounts compared to budget
|
--budget show sum of posting amounts compared to budget
|
||||||
goals defined by periodic transactions
|
goals defined by periodic transactions
|
||||||
|
--count show the count of postings
|
||||||
--change accumulate amounts from column start to column
|
--change accumulate amounts from column start to column
|
||||||
end (in multicolumn reports)
|
end (in multicolumn reports)
|
||||||
--cumulative accumulate amounts from report start (specified
|
--cumulative accumulate amounts from report start (specified
|
||||||
@ -46,6 +47,9 @@ Flags:
|
|||||||
'wide[,WIDTH]': all commodities on one line
|
'wide[,WIDTH]': all commodities on one line
|
||||||
'tall' : each commodity on a new line
|
'tall' : each commodity on a new line
|
||||||
'bare' : bare numbers, symbols in a column
|
'bare' : bare numbers, symbols in a column
|
||||||
|
--base-url=URLPREFIX in html output, generate hyperlinks to
|
||||||
|
hledger-web, with this prefix. (Usually the base
|
||||||
|
url shown by hledger-web; can also be relative.)
|
||||||
-O --output-format=FMT select the output format. Supported formats:
|
-O --output-format=FMT select the output format. Supported formats:
|
||||||
txt, html, csv, tsv, json.
|
txt, html, csv, tsv, json.
|
||||||
-o --output-file=FILE write output to FILE. A file extension matching
|
-o --output-file=FILE write output to FILE. A file extension matching
|
||||||
|
|||||||
@ -17,6 +17,7 @@ Flags:
|
|||||||
balance value minus cost basis)
|
balance value minus cost basis)
|
||||||
--budget show sum of posting amounts compared to budget
|
--budget show sum of posting amounts compared to budget
|
||||||
goals defined by periodic transactions
|
goals defined by periodic transactions
|
||||||
|
--count show the count of postings
|
||||||
--change accumulate amounts from column start to column
|
--change accumulate amounts from column start to column
|
||||||
end (in multicolumn reports) (default)
|
end (in multicolumn reports) (default)
|
||||||
--cumulative accumulate amounts from report start (specified
|
--cumulative accumulate amounts from report start (specified
|
||||||
@ -47,6 +48,9 @@ Flags:
|
|||||||
'wide[,WIDTH]': all commodities on one line
|
'wide[,WIDTH]': all commodities on one line
|
||||||
'tall' : each commodity on a new line
|
'tall' : each commodity on a new line
|
||||||
'bare' : bare numbers, symbols in a column
|
'bare' : bare numbers, symbols in a column
|
||||||
|
--base-url=URLPREFIX in html output, generate hyperlinks to
|
||||||
|
hledger-web, with this prefix. (Usually the base
|
||||||
|
url shown by hledger-web; can also be relative.)
|
||||||
-O --output-format=FMT select the output format. Supported formats:
|
-O --output-format=FMT select the output format. Supported formats:
|
||||||
txt, html, csv, tsv, json.
|
txt, html, csv, tsv, json.
|
||||||
-o --output-file=FILE write output to FILE. A file extension matching
|
-o --output-file=FILE write output to FILE. A file extension matching
|
||||||
|
|||||||
@ -16,6 +16,7 @@ Flags:
|
|||||||
balance value minus cost basis)
|
balance value minus cost basis)
|
||||||
--budget show sum of posting amounts compared to budget
|
--budget show sum of posting amounts compared to budget
|
||||||
goals defined by periodic transactions
|
goals defined by periodic transactions
|
||||||
|
--count show the count of postings
|
||||||
--change accumulate amounts from column start to column
|
--change accumulate amounts from column start to column
|
||||||
end (in multicolumn reports) (default)
|
end (in multicolumn reports) (default)
|
||||||
--cumulative accumulate amounts from report start (specified
|
--cumulative accumulate amounts from report start (specified
|
||||||
@ -46,6 +47,9 @@ Flags:
|
|||||||
'wide[,WIDTH]': all commodities on one line
|
'wide[,WIDTH]': all commodities on one line
|
||||||
'tall' : each commodity on a new line
|
'tall' : each commodity on a new line
|
||||||
'bare' : bare numbers, symbols in a column
|
'bare' : bare numbers, symbols in a column
|
||||||
|
--base-url=URLPREFIX in html output, generate hyperlinks to
|
||||||
|
hledger-web, with this prefix. (Usually the base
|
||||||
|
url shown by hledger-web; can also be relative.)
|
||||||
-O --output-format=FMT select the output format. Supported formats:
|
-O --output-format=FMT select the output format. Supported formats:
|
||||||
txt, html, csv, tsv, json.
|
txt, html, csv, tsv, json.
|
||||||
-o --output-file=FILE write output to FILE. A file extension matching
|
-o --output-file=FILE write output to FILE. A file extension matching
|
||||||
|
|||||||
@ -15,6 +15,7 @@ Flags:
|
|||||||
balance value minus cost basis)
|
balance value minus cost basis)
|
||||||
--budget show sum of posting amounts compared to budget
|
--budget show sum of posting amounts compared to budget
|
||||||
goals defined by periodic transactions
|
goals defined by periodic transactions
|
||||||
|
--count show the count of postings
|
||||||
--change accumulate amounts from column start to column
|
--change accumulate amounts from column start to column
|
||||||
end (in multicolumn reports) (default)
|
end (in multicolumn reports) (default)
|
||||||
--cumulative accumulate amounts from report start (specified
|
--cumulative accumulate amounts from report start (specified
|
||||||
@ -45,6 +46,9 @@ Flags:
|
|||||||
'wide[,WIDTH]': all commodities on one line
|
'wide[,WIDTH]': all commodities on one line
|
||||||
'tall' : each commodity on a new line
|
'tall' : each commodity on a new line
|
||||||
'bare' : bare numbers, symbols in a column
|
'bare' : bare numbers, symbols in a column
|
||||||
|
--base-url=URLPREFIX in html output, generate hyperlinks to
|
||||||
|
hledger-web, with this prefix. (Usually the base
|
||||||
|
url shown by hledger-web; can also be relative.)
|
||||||
-O --output-format=FMT select the output format. Supported formats:
|
-O --output-format=FMT select the output format. Supported formats:
|
||||||
txt, html, csv, tsv, json.
|
txt, html, csv, tsv, json.
|
||||||
-o --output-file=FILE write output to FILE. A file extension matching
|
-o --output-file=FILE write output to FILE. A file extension matching
|
||||||
|
|||||||
@ -15,6 +15,7 @@ Flags:
|
|||||||
balance value minus cost basis)
|
balance value minus cost basis)
|
||||||
--budget show sum of posting amounts compared to budget
|
--budget show sum of posting amounts compared to budget
|
||||||
goals defined by periodic transactions
|
goals defined by periodic transactions
|
||||||
|
--count show the count of postings
|
||||||
--change accumulate amounts from column start to column
|
--change accumulate amounts from column start to column
|
||||||
end (in multicolumn reports) (default)
|
end (in multicolumn reports) (default)
|
||||||
--cumulative accumulate amounts from report start (specified
|
--cumulative accumulate amounts from report start (specified
|
||||||
@ -45,6 +46,9 @@ Flags:
|
|||||||
'wide[,WIDTH]': all commodities on one line
|
'wide[,WIDTH]': all commodities on one line
|
||||||
'tall' : each commodity on a new line
|
'tall' : each commodity on a new line
|
||||||
'bare' : bare numbers, symbols in a column
|
'bare' : bare numbers, symbols in a column
|
||||||
|
--base-url=URLPREFIX in html output, generate hyperlinks to
|
||||||
|
hledger-web, with this prefix. (Usually the base
|
||||||
|
url shown by hledger-web; can also be relative.)
|
||||||
-O --output-format=FMT select the output format. Supported formats:
|
-O --output-format=FMT select the output format. Supported formats:
|
||||||
txt, html, csv, tsv, json.
|
txt, html, csv, tsv, json.
|
||||||
-o --output-file=FILE write output to FILE. A file extension matching
|
-o --output-file=FILE write output to FILE. A file extension matching
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user