;doc: regen manuals

This commit is contained in:
Simon Michael 2020-08-01 12:41:54 -07:00
parent 1eca6b8b5c
commit 5d40b54043
21 changed files with 1013 additions and 915 deletions

View File

@ -4,4 +4,4 @@ m4_dnl Program version. Updated by make setversion.
m4_define({{_version_}}, {{1.18.99}})m4_dnl
m4_dnl
m4_dnl Date to show in man pages. Updated by make setdate.
m4_define({{_monthyear_}}, {{July 2020}})m4_dnl
m4_define({{_monthyear_}}, {{August 2020}})m4_dnl

View File

@ -1,6 +1,6 @@
.\"t
.TH "hledger_csv" "5" "July 2020" "hledger 1.18.99" "hledger User Manuals"
.TH "hledger_csv" "5" "August 2020" "hledger 1.18.99" "hledger User Manuals"

View File

@ -914,4 +914,4 @@ SEE ALSO
hledger 1.18.99 July 2020 hledger_csv(5)
hledger 1.18.99 August 2020 hledger_csv(5)

View File

@ -1,6 +1,6 @@
.\"t
.TH "hledger_journal" "5" "July 2020" "hledger 1.18.99" "hledger User Manuals"
.TH "hledger_journal" "5" "August 2020" "hledger 1.18.99" "hledger User Manuals"
@ -670,10 +670,13 @@ hledger infer the price that balances the transaction:
\f[R]
.fi
.RE
.IP "4." 3
Like 1, but the \f[C]\[at]\f[R] is parenthesised, i.e.
\f[C](\[at])\f[R]; this is for compatibility with Ledger journals
(Virtual posting costs), and is equivalent to 1 in hledger.
.IP "5." 3
Like 1 and 2, but the \f[C]\[at]\f[R] or \f[C]\[at]\[at]\f[R] is
parenthesised; this is for compatibility with Ledger journals (Virtual
posting costs), and in hledger is equivalent to 1 and 2.
Like 2, but as in 4 the \f[C]\[at]\[at]\f[R] is parenthesised, i.e.
\f[C](\[at]\[at])\f[R]; in hledger, this is equivalent to 2.
.PP
Use the \f[C]-B/--cost\f[R] flag to convert amounts to their transaction
price\[aq]s commodity, if any.
@ -1646,7 +1649,7 @@ Eg:
.IP
.nf
\f[C]
alias /\[ha](.+):bank:([\[ha]:]+)(.*)/ = \[rs]1:\[rs]2 \[rs]3
alias /\[ha](.+):bank:([\[ha]:]+):(.*)/ = \[rs]1:\[rs]2 \[rs]3
; rewrites \[dq]assets:bank:wells fargo:checking\[dq] to \[dq]assets:wells fargo checking\[dq]
\f[R]
.fi

View File

@ -593,9 +593,12 @@ certain date.
assets:euros €100 ; one hundred euros purchased
assets:dollars $-135 ; for $135
4. 5. Like 1 and 2, but the '@' or '@@' is parenthesised; this is for
compatibility with Ledger journals (Virtual posting costs), and in
hledger is equivalent to 1 and 2.
4. Like 1, but the '@' is parenthesised, i.e. '(@)'; this is for
compatibility with Ledger journals (Virtual posting costs), and is
equivalent to 1 in hledger.
5. Like 2, but as in 4 the '@@' is parenthesised, i.e. '(@@)'; in
hledger, this is equivalent to 2.
Use the '-B/--cost' flag to convert amounts to their transaction
price's commodity, if any. (mnemonic: "B" is from "cost Basis", as in
@ -1440,7 +1443,7 @@ inside an account name, the matched part will be replaced by
REPLACEMENT. If REGEX contains parenthesised match groups, these can be
referenced by the usual numeric backreferences in REPLACEMENT. Eg:
alias /^(.+):bank:([^:]+)(.*)/ = \1:\2 \3
alias /^(.+):bank:([^:]+):(.*)/ = \1:\2 \3
; rewrites "assets:bank:wells fargo:checking" to "assets:wells fargo checking"
Also note that REPLACEMENT continues to the end of line (or on
@ -1896,90 +1899,90 @@ Node: Amount display style18138
Ref: #amount-display-style18292
Node: Transaction prices19729
Ref: #transaction-prices19901
Node: Lot prices and lot dates22233
Ref: #lot-prices-and-lot-dates22430
Node: Balance assertions22918
Ref: #balance-assertions23104
Node: Assertions and ordering24137
Ref: #assertions-and-ordering24325
Node: Assertions and included files25025
Ref: #assertions-and-included-files25268
Node: Assertions and multiple -f options25601
Ref: #assertions-and-multiple--f-options25857
Node: Assertions and commodities25989
Ref: #assertions-and-commodities26221
Node: Assertions and prices27378
Ref: #assertions-and-prices27592
Node: Assertions and subaccounts28032
Ref: #assertions-and-subaccounts28261
Node: Assertions and virtual postings28585
Ref: #assertions-and-virtual-postings28827
Node: Assertions and precision28969
Ref: #assertions-and-precision29162
Node: Balance assignments29429
Ref: #balance-assignments29603
Node: Balance assignments and prices30767
Ref: #balance-assignments-and-prices30939
Node: Directives31163
Ref: #directives31322
Node: Directives and multiple files37013
Ref: #directives-and-multiple-files37196
Node: Comment blocks37860
Ref: #comment-blocks38043
Node: Including other files38219
Ref: #including-other-files38399
Node: Default year39323
Ref: #default-year39492
Node: Declaring commodities39899
Ref: #declaring-commodities40082
Node: Default commodity41888
Ref: #default-commodity42074
Node: Declaring market prices42963
Ref: #declaring-market-prices43158
Node: Declaring accounts44015
Ref: #declaring-accounts44201
Node: Account comments45126
Ref: #account-comments45289
Node: Account subdirectives45713
Ref: #account-subdirectives45908
Node: Account types46221
Ref: #account-types46405
Node: Account display order49451
Ref: #account-display-order49621
Node: Rewriting accounts50772
Ref: #rewriting-accounts50957
Node: Basic aliases51714
Ref: #basic-aliases51860
Node: Regex aliases52564
Ref: #regex-aliases52736
Node: Combining aliases53454
Ref: #combining-aliases53647
Node: Aliases and multiple files54923
Ref: #aliases-and-multiple-files55132
Node: end aliases55711
Ref: #end-aliases55868
Node: Default parent account55969
Ref: #default-parent-account56137
Node: Periodic transactions57021
Ref: #periodic-transactions57196
Node: Periodic rule syntax59068
Ref: #periodic-rule-syntax59274
Node: Two spaces between period expression and description!59978
Ref: #two-spaces-between-period-expression-and-description60297
Node: Forecasting with periodic transactions60981
Ref: #forecasting-with-periodic-transactions61286
Node: Budgeting with periodic transactions63341
Ref: #budgeting-with-periodic-transactions63580
Node: Auto postings64029
Ref: #auto-postings64169
Node: Auto postings and multiple files66348
Ref: #auto-postings-and-multiple-files66552
Node: Auto postings and dates66761
Ref: #auto-postings-and-dates67035
Node: Auto postings and transaction balancing / inferred amounts / balance assertions67210
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions67561
Node: Auto posting tags67903
Ref: #auto-posting-tags68118
Node: Lot prices and lot dates22332
Ref: #lot-prices-and-lot-dates22529
Node: Balance assertions23017
Ref: #balance-assertions23203
Node: Assertions and ordering24236
Ref: #assertions-and-ordering24424
Node: Assertions and included files25124
Ref: #assertions-and-included-files25367
Node: Assertions and multiple -f options25700
Ref: #assertions-and-multiple--f-options25956
Node: Assertions and commodities26088
Ref: #assertions-and-commodities26320
Node: Assertions and prices27477
Ref: #assertions-and-prices27691
Node: Assertions and subaccounts28131
Ref: #assertions-and-subaccounts28360
Node: Assertions and virtual postings28684
Ref: #assertions-and-virtual-postings28926
Node: Assertions and precision29068
Ref: #assertions-and-precision29261
Node: Balance assignments29528
Ref: #balance-assignments29702
Node: Balance assignments and prices30866
Ref: #balance-assignments-and-prices31038
Node: Directives31262
Ref: #directives31421
Node: Directives and multiple files37112
Ref: #directives-and-multiple-files37295
Node: Comment blocks37959
Ref: #comment-blocks38142
Node: Including other files38318
Ref: #including-other-files38498
Node: Default year39422
Ref: #default-year39591
Node: Declaring commodities39998
Ref: #declaring-commodities40181
Node: Default commodity41987
Ref: #default-commodity42173
Node: Declaring market prices43062
Ref: #declaring-market-prices43257
Node: Declaring accounts44114
Ref: #declaring-accounts44300
Node: Account comments45225
Ref: #account-comments45388
Node: Account subdirectives45812
Ref: #account-subdirectives46007
Node: Account types46320
Ref: #account-types46504
Node: Account display order49550
Ref: #account-display-order49720
Node: Rewriting accounts50871
Ref: #rewriting-accounts51056
Node: Basic aliases51813
Ref: #basic-aliases51959
Node: Regex aliases52663
Ref: #regex-aliases52835
Node: Combining aliases53554
Ref: #combining-aliases53747
Node: Aliases and multiple files55023
Ref: #aliases-and-multiple-files55232
Node: end aliases55811
Ref: #end-aliases55968
Node: Default parent account56069
Ref: #default-parent-account56237
Node: Periodic transactions57121
Ref: #periodic-transactions57296
Node: Periodic rule syntax59168
Ref: #periodic-rule-syntax59374
Node: Two spaces between period expression and description!60078
Ref: #two-spaces-between-period-expression-and-description60397
Node: Forecasting with periodic transactions61081
Ref: #forecasting-with-periodic-transactions61386
Node: Budgeting with periodic transactions63441
Ref: #budgeting-with-periodic-transactions63680
Node: Auto postings64129
Ref: #auto-postings64269
Node: Auto postings and multiple files66448
Ref: #auto-postings-and-multiple-files66652
Node: Auto postings and dates66861
Ref: #auto-postings-and-dates67135
Node: Auto postings and transaction balancing / inferred amounts / balance assertions67310
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions67661
Node: Auto posting tags68003
Ref: #auto-posting-tags68218

End Tag Table

View File

@ -472,9 +472,12 @@ FILE FORMAT
assets:euros EUR100 ; one hundred euros purchased
assets:dollars $-135 ; for $135
5. Like 1 and 2, but the @ or @@ is parenthesised; this is for compati-
bility with Ledger journals (Virtual posting costs), and in hledger
is equivalent to 1 and 2.
4. Like 1, but the @ is parenthesised, i.e. (@); this is for compati-
bility with Ledger journals (Virtual posting costs), and is equiva-
lent to 1 in hledger.
5. Like 2, but as in 4 the @@ is parenthesised, i.e. (@@); in hledger,
this is equivalent to 2.
Use the -B/--cost flag to convert amounts to their transaction price's
commodity, if any. (mnemonic: "B" is from "cost Basis", as in Ledger).
@ -731,6 +734,7 @@ FILE FORMAT
Y declare a year for yearless following in-
dates line/included en-
tries until end of
@ -1148,7 +1152,7 @@ FILE FORMAT
MENT. If REGEX contains parenthesised match groups, these can be ref-
erenced by the usual numeric backreferences in REPLACEMENT. Eg:
alias /^(.+):bank:([^:]+)(.*)/ = \1:\2 \3
alias /^(.+):bank:([^:]+):(.*)/ = \1:\2 \3
; rewrites "assets:bank:wells fargo:checking" to "assets:wells fargo checking"
Also note that REPLACEMENT continues to the end of line (or on command
@ -1522,4 +1526,4 @@ SEE ALSO
hledger 1.18.99 July 2020 hledger_journal(5)
hledger 1.18.99 August 2020 hledger_journal(5)

View File

@ -1,5 +1,5 @@
.TH "hledger_timeclock" "5" "July 2020" "hledger 1.18.99" "hledger User Manuals"
.TH "hledger_timeclock" "5" "August 2020" "hledger 1.18.99" "hledger User Manuals"

View File

@ -78,4 +78,4 @@ SEE ALSO
hledger 1.18.99 July 2020 hledger_timeclock(5)
hledger 1.18.99 August 2020 hledger_timeclock(5)

View File

@ -1,5 +1,5 @@
.TH "hledger_timedot" "5" "July 2020" "hledger 1.18.99" "hledger User Manuals"
.TH "hledger_timedot" "5" "August 2020" "hledger 1.18.99" "hledger User Manuals"

View File

@ -161,4 +161,4 @@ SEE ALSO
hledger 1.18.99 July 2020 hledger_timedot(5)
hledger 1.18.99 August 2020 hledger_timedot(5)

View File

@ -4,4 +4,4 @@ m4_dnl Program version. Updated by make setversion.
m4_define({{_version_}}, {{1.18.99}})m4_dnl
m4_dnl
m4_dnl Date to show in man pages. Updated by make setdate.
m4_define({{_monthyear_}}, {{July 2020}})m4_dnl
m4_define({{_monthyear_}}, {{August 2020}})m4_dnl

View File

@ -1,5 +1,5 @@
.TH "hledger-ui" "1" "July 2020" "hledger-ui 1.18.99" "hledger User Manuals"
.TH "hledger-ui" "1" "August 2020" "hledger-ui 1.18.99" "hledger User Manuals"

View File

@ -456,4 +456,4 @@ SEE ALSO
hledger-ui 1.18.99 July 2020 hledger-ui(1)
hledger-ui 1.18.99 August 2020 hledger-ui(1)

View File

@ -4,4 +4,4 @@ m4_dnl Program version. Updated by make setversion.
m4_define({{_version_}}, {{1.18.99}})m4_dnl
m4_dnl
m4_dnl Date to show in man pages. Updated by make setdate.
m4_define({{_monthyear_}}, {{July 2020}})m4_dnl
m4_define({{_monthyear_}}, {{August 2020}})m4_dnl

View File

@ -1,5 +1,5 @@
.TH "hledger-web" "1" "July 2020" "hledger-web 1.18.99" "hledger User Manuals"
.TH "hledger-web" "1" "August 2020" "hledger-web 1.18.99" "hledger User Manuals"

View File

@ -545,4 +545,4 @@ SEE ALSO
hledger-web 1.18.99 July 2020 hledger-web(1)
hledger-web 1.18.99 August 2020 hledger-web(1)

View File

@ -3,9 +3,16 @@ Show postings and their running total.
_FLAGS
The register command displays postings in date order, one per line, and
their running total. This is typically used with a query selecting a
particular account, to see that account's activity:
The register command displays matched postings, across all accounts, in
date order, with their running total or running historical balance. (See
also the aregister command, which shows matched transactions in a
specific account.)
register normally shows line per posting, but note that multi-commodity
amounts will occupy multiple lines (one line per commodity).
It is typically used with a query selecting a particular account, to see
that account's activity:
$ hledger register checking
2008/01/01 income assets:bank:checking $1 $1

View File

@ -4,4 +4,4 @@ m4_dnl Program version. Updated by make setversion.
m4_define({{_version_}}, {{1.18.99}})m4_dnl
m4_dnl
m4_dnl Date to show in man pages. Updated by make setdate.
m4_define({{_monthyear_}}, {{July 2020}})m4_dnl
m4_define({{_monthyear_}}, {{August 2020}})m4_dnl

View File

@ -1,6 +1,6 @@
.\"t
.TH "hledger" "1" "July 2020" "hledger 1.18.99" "hledger User Manuals"
.TH "hledger" "1" "August 2020" "hledger 1.18.99" "hledger User Manuals"
@ -1470,6 +1470,23 @@ just that day; equivalent to \[lq]2009/1/1 to 2009/1/2\[rq]
T}
.TE
.PP
Or you can specify a single quarter like so:
.PP
.TS
tab(@);
l l.
T{
\f[C]-p \[dq]2009Q1\[dq]\f[R]
T}@T{
first quarter of 2009, equivalent to \[lq]2009/1/1 to 2009/4/1\[rq]
T}
T{
\f[C]-p \[dq]q4\[dq]\f[R]
T}@T{
fourth quarter of the current year
T}
.TE
.PP
The argument of \f[C]-p\f[R] can also begin with, or be, a report
interval expression.
The basic report intervals are \f[C]daily\f[R], \f[C]weekly\f[R],
@ -3223,16 +3240,16 @@ balancesheet, bs
.PD 0
.P
.PD
This command displays a simple balance sheet, showing historical ending
balances of asset and liability accounts (ignoring any report begin
date).
It assumes that these accounts are under a top-level \f[C]asset\f[R] or
\f[C]liability\f[R] account (case insensitive, plural forms also
allowed).
This command displays a balance sheet, showing historical ending
balances of asset and liability accounts.
(To see equity as well, use the balancesheetequity command.) Amounts are
shown with normal positive sign, as in conventional financial
statements.
.PP
Note this report shows all account balances with normal positive sign
(like conventional financial statements, unlike balance/print/register)
(experimental).
The asset and liability accounts shown are those accounts declared with
the \f[C]Asset\f[R] or \f[C]Cash\f[R] or \f[C]Liability\f[R] type, or
otherwise all accounts under a top-level \f[C]asset\f[R] or
\f[C]liability\f[R] account (case insensitive, plurals allowed).
.PP
Example:
.IP
@ -3279,8 +3296,16 @@ balancesheetequity, bse
.PD 0
.P
.PD
Just like balancesheet, but also reports Equity (which it assumes is
under a top-level \f[C]equity\f[R] account).
This command displays a balance sheet, showing historical ending
balances of asset, liability and equity accounts.
Amounts are shown with normal positive sign, as in conventional
financial statements.
.PP
The asset, liability and equity accounts shown are those accounts
declared with the \f[C]Asset\f[R], \f[C]Cash\f[R], \f[C]Liability\f[R]
or \f[C]Equity\f[R] type, or otherwise all accounts under a top-level
\f[C]asset\f[R], \f[C]liability\f[R] or \f[C]equity\f[R] account (case
insensitive, plurals allowed).
.PP
Example:
.IP
@ -3321,14 +3346,16 @@ cashflow, cf
.PD 0
.P
.PD
This command displays a simple cashflow statement, showing changes in
\[dq]cash\[dq] accounts.
It assumes that these accounts are under a top-level \f[C]asset\f[R]
account (case insensitive, plural forms also allowed) and do not contain
\f[C]receivable\f[R] or \f[C]A/R\f[R] in their name.
Note this report shows all account balances with normal positive sign
(like conventional financial statements, unlike balance/print/register)
(experimental).
This command displays a cashflow statement, showing the inflows and
outflows affecting \[dq]cash\[dq] (ie, liquid) assets.
Amounts are shown with normal positive sign, as in conventional
financial statements.
.PP
The \[dq]cash\[dq] accounts shown are those accounts declared with the
\f[C]Cash\f[R] type, or otherwise all accounts under a top-level
\f[C]asset\f[R] account (case insensitive, plural allowed) which do not
have \f[C]fixed\f[R], \f[C]investment\f[R], \f[C]receivable\f[R] or
\f[C]A/R\f[R] in their name.
.PP
Example:
.IP
@ -3744,19 +3771,18 @@ incomestatement, is
.PD 0
.P
.PD
This command displays a simple income statement, showing revenues and
expenses during a period.
It assumes that these accounts are under a top-level \f[C]revenue\f[R]
or \f[C]income\f[R] or \f[C]expense\f[R] account (case insensitive,
plural forms also allowed).
Note this report shows all account balances with normal positive sign
(like conventional financial statements, unlike balance/print/register)
(experimental).
.PP
This command displays a simple income statement.
It currently assumes that you have top-level accounts named
\f[C]income\f[R] (or \f[C]revenue\f[R]) and \f[C]expense\f[R] (plural
forms also allowed.)
This command displays an income statement, showing revenues and expenses
during one or more periods.
Amounts are shown with normal positive sign, as in conventional
financial statements.
.PP
The revenue and expense accounts shown are those accounts declared with
the \f[C]Revenue\f[R] or \f[C]Expense\f[R] type, or otherwise all
accounts under a top-level \f[C]revenue\f[R] or \f[C]income\f[R] or
\f[C]expense\f[R] account (case insensitive, plurals allowed).
.PP
Example:
.IP
.nf
\f[C]
@ -4019,10 +4045,16 @@ register, reg, r
.PD
Show postings and their running total.
.PP
The register command displays postings in date order, one per line, and
their running total.
This is typically used with a query selecting a particular account, to
see that account\[aq]s activity:
The register command displays matched postings, across all accounts, in
date order, with their running total or running historical balance.
(See also the \f[C]aregister\f[R] command, which shows matched
transactions in a specific account.)
.PP
register normally shows line per posting, but note that multi-commodity
amounts will occupy multiple lines (one line per commodity).
.PP
It is typically used with a query selecting a particular account, to see
that account\[aq]s activity:
.IP
.nf
\f[C]

View File

@ -1245,6 +1245,11 @@ date like so:
'-p "2009/1"' the month of jan; equivalent to “2009/1/1 to 2009/2/1”
'-p "2009/1/1"' just that day; equivalent to “2009/1/1 to 2009/1/2”
Or you can specify a single quarter like so:
'-p "2009Q1"' first quarter of 2009, equivalent to “2009/1/1 to 2009/4/1”
'-p "q4"' fourth quarter of the current year
The argument of '-p' can also begin with, or be, a report interval
expression. The basic report intervals are 'daily', 'weekly',
'monthly', 'quarterly', or 'yearly', which have the same effect as the
@ -2706,14 +2711,15 @@ File: hledger.info, Node: balancesheet, Next: balancesheetequity, Prev: balan
================
balancesheet, bs
This command displays a simple balance sheet, showing historical ending
balances of asset and liability accounts (ignoring any report begin
date). It assumes that these accounts are under a top-level 'asset' or
'liability' account (case insensitive, plural forms also allowed).
This command displays a balance sheet, showing historical ending
balances of asset and liability accounts. (To see equity as well, use
the balancesheetequity command.) Amounts are shown with normal positive
sign, as in conventional financial statements.
Note this report shows all account balances with normal positive sign
(like conventional financial statements, unlike balance/print/register)
(experimental).
The asset and liability accounts shown are those accounts declared
with the 'Asset' or 'Cash' or 'Liability' type, or otherwise all
accounts under a top-level 'asset' or 'liability' account (case
insensitive, plurals allowed).
Example:
@ -2756,8 +2762,14 @@ File: hledger.info, Node: balancesheetequity, Next: cashflow, Prev: balancesh
======================
balancesheetequity, bse
Just like balancesheet, but also reports Equity (which it assumes is
under a top-level 'equity' account).
This command displays a balance sheet, showing historical ending
balances of asset, liability and equity accounts. Amounts are shown
with normal positive sign, as in conventional financial statements.
The asset, liability and equity accounts shown are those accounts
declared with the 'Asset', 'Cash', 'Liability' or 'Equity' type, or
otherwise all accounts under a top-level 'asset', 'liability' or
'equity' account (case insensitive, plurals allowed).
Example:
@ -2796,12 +2808,14 @@ File: hledger.info, Node: cashflow, Next: check-dates, Prev: balancesheetequi
============
cashflow, cf
This command displays a simple cashflow statement, showing changes in
"cash" accounts. It assumes that these accounts are under a top-level
'asset' account (case insensitive, plural forms also allowed) and do not
contain 'receivable' or 'A/R' in their name. Note this report shows all
account balances with normal positive sign (like conventional financial
statements, unlike balance/print/register) (experimental).
This command displays a cashflow statement, showing the inflows and
outflows affecting "cash" (ie, liquid) assets. Amounts are shown with
normal positive sign, as in conventional financial statements.
The "cash" accounts shown are those accounts declared with the 'Cash'
type, or otherwise all accounts under a top-level 'asset' account (case
insensitive, plural allowed) which do not have 'fixed', 'investment',
'receivable' or 'A/R' in their name.
Example:
@ -3180,16 +3194,17 @@ File: hledger.info, Node: incomestatement, Next: notes, Prev: import, Up: CO
====================
incomestatement, is
This command displays a simple income statement, showing revenues and
expenses during a period. It assumes that these accounts are under a
top-level 'revenue' or 'income' or 'expense' account (case insensitive,
plural forms also allowed). Note this report shows all account balances
with normal positive sign (like conventional financial statements,
unlike balance/print/register) (experimental).
This command displays a simple income statement. It currently
assumes that you have top-level accounts named 'income' (or 'revenue')
and 'expense' (plural forms also allowed.)
This command displays an income statement, showing revenues and
expenses during one or more periods. Amounts are shown with normal
positive sign, as in conventional financial statements.
The revenue and expense accounts shown are those accounts declared
with the 'Revenue' or 'Expense' type, or otherwise all accounts under a
top-level 'revenue' or 'income' or 'expense' account (case insensitive,
plurals allowed).
Example:
$ hledger incomestatement
Income Statement
@ -3416,9 +3431,17 @@ File: hledger.info, Node: register, Next: register-match, Prev: print-unique,
register, reg, r
Show postings and their running total.
The register command displays postings in date order, one per line,
and their running total. This is typically used with a query selecting
a particular account, to see that account's activity:
The register command displays matched postings, across all accounts,
in date order, with their running total or running historical balance.
(See also the 'aregister' command, which shows matched transactions in a
specific account.)
register normally shows line per posting, but note that
multi-commodity amounts will occupy multiple lines (one line per
commodity).
It is typically used with a query selecting a particular account, to
see that account's activity:
$ hledger register checking
2008/01/01 income assets:bank:checking $1 $1
@ -4086,150 +4109,150 @@ Node: Report intervals40503
Ref: #report-intervals40668
Node: Period expressions41058
Ref: #period-expressions41218
Node: Depth limiting45369
Ref: #depth-limiting45513
Node: Pivoting45845
Ref: #pivoting45968
Node: Valuation47644
Ref: #valuation47746
Node: -B Cost48435
Ref: #b-cost48539
Node: -V Value48672
Ref: #v-value48818
Node: -X Value in specified commodity49013
Ref: #x-value-in-specified-commodity49212
Node: Valuation date49361
Ref: #valuation-date49529
Node: Market prices49939
Ref: #market-prices50119
Node: --infer-value market prices from transactions50896
Ref: #infer-value-market-prices-from-transactions51145
Node: Valuation commodity52427
Ref: #valuation-commodity52636
Node: Simple valuation examples53862
Ref: #simple-valuation-examples54064
Node: --value Flexible valuation54723
Ref: #value-flexible-valuation54931
Node: More valuation examples56878
Ref: #more-valuation-examples57087
Node: Effect of valuation on reports59092
Ref: #effect-of-valuation-on-reports59280
Node: COMMANDS64801
Ref: #commands64909
Node: accounts66017
Ref: #accounts66115
Node: activity66814
Ref: #activity66924
Node: add67307
Ref: #add67408
Node: aregister70201
Ref: #aregister70313
Node: aregister and custom posting dates71686
Ref: #aregister-and-custom-posting-dates71859
Ref: #output-format-172452
Node: balance72857
Ref: #balance72974
Node: Classic balance report74432
Ref: #classic-balance-report74605
Node: Customising the classic balance report76039
Ref: #customising-the-classic-balance-report76267
Node: Colour support78343
Ref: #colour-support78510
Node: Flat mode78606
Ref: #flat-mode78754
Node: Depth limited balance reports79167
Ref: #depth-limited-balance-reports79352
Node: Percentages79808
Ref: #percentages79974
Node: Multicolumn balance report81111
Ref: #multicolumn-balance-report81291
Node: Budget report86888
Ref: #budget-report87031
Node: Nested budgets92297
Ref: #nested-budgets92409
Ref: #output-format-295890
Node: balancesheet96087
Ref: #balancesheet96223
Node: balancesheetequity97689
Ref: #balancesheetequity97838
Node: cashflow98561
Ref: #cashflow98689
Node: check-dates99868
Ref: #check-dates99995
Node: check-dupes100274
Ref: #check-dupes100400
Node: close100693
Ref: #close100801
Node: close usage102323
Ref: #close-usage102416
Node: codes105229
Ref: #codes105337
Node: commodities106049
Ref: #commodities106176
Node: descriptions106258
Ref: #descriptions106386
Node: diff106690
Ref: #diff106796
Node: files107843
Ref: #files107943
Node: help108090
Ref: #help108190
Node: import109271
Ref: #import109385
Node: Importing balance assignments110278
Ref: #importing-balance-assignments110426
Node: incomestatement111075
Ref: #incomestatement111208
Node: notes112695
Ref: #notes112808
Node: payees113176
Ref: #payees113282
Node: prices113702
Ref: #prices113808
Node: print114149
Ref: #print114259
Node: print-unique119055
Ref: #print-unique119181
Node: register119466
Ref: #register119593
Node: Custom register output123765
Ref: #custom-register-output123894
Node: register-match125231
Ref: #register-match125365
Node: rewrite125716
Ref: #rewrite125831
Node: Re-write rules in a file127686
Ref: #re-write-rules-in-a-file127820
Node: Diff output format129030
Ref: #diff-output-format129199
Node: rewrite vs print --auto130291
Ref: #rewrite-vs.-print---auto130470
Node: roi131026
Ref: #roi131124
Node: stats132136
Ref: #stats132235
Node: tags133023
Ref: #tags133121
Node: test133640
Ref: #test133748
Node: Add-on commands134495
Ref: #add-on-commands134612
Node: ui135955
Ref: #ui136043
Node: web136097
Ref: #web136200
Node: iadd136316
Ref: #iadd136427
Node: interest136509
Ref: #interest136616
Node: ENVIRONMENT136856
Ref: #environment136968
Node: FILES137953
Ref: #files-1138056
Node: LIMITATIONS138269
Ref: #limitations138388
Node: TROUBLESHOOTING139130
Ref: #troubleshooting139243
Node: Depth limiting45550
Ref: #depth-limiting45694
Node: Pivoting46026
Ref: #pivoting46149
Node: Valuation47825
Ref: #valuation47927
Node: -B Cost48616
Ref: #b-cost48720
Node: -V Value48853
Ref: #v-value48999
Node: -X Value in specified commodity49194
Ref: #x-value-in-specified-commodity49393
Node: Valuation date49542
Ref: #valuation-date49710
Node: Market prices50120
Ref: #market-prices50300
Node: --infer-value market prices from transactions51077
Ref: #infer-value-market-prices-from-transactions51326
Node: Valuation commodity52608
Ref: #valuation-commodity52817
Node: Simple valuation examples54043
Ref: #simple-valuation-examples54245
Node: --value Flexible valuation54904
Ref: #value-flexible-valuation55112
Node: More valuation examples57059
Ref: #more-valuation-examples57268
Node: Effect of valuation on reports59273
Ref: #effect-of-valuation-on-reports59461
Node: COMMANDS64982
Ref: #commands65090
Node: accounts66198
Ref: #accounts66296
Node: activity66995
Ref: #activity67105
Node: add67488
Ref: #add67589
Node: aregister70382
Ref: #aregister70494
Node: aregister and custom posting dates71867
Ref: #aregister-and-custom-posting-dates72040
Ref: #output-format-172633
Node: balance73038
Ref: #balance73155
Node: Classic balance report74613
Ref: #classic-balance-report74786
Node: Customising the classic balance report76220
Ref: #customising-the-classic-balance-report76448
Node: Colour support78524
Ref: #colour-support78691
Node: Flat mode78787
Ref: #flat-mode78935
Node: Depth limited balance reports79348
Ref: #depth-limited-balance-reports79533
Node: Percentages79989
Ref: #percentages80155
Node: Multicolumn balance report81292
Ref: #multicolumn-balance-report81472
Node: Budget report87069
Ref: #budget-report87212
Node: Nested budgets92478
Ref: #nested-budgets92590
Ref: #output-format-296071
Node: balancesheet96268
Ref: #balancesheet96404
Node: balancesheetequity97916
Ref: #balancesheetequity98065
Node: cashflow99141
Ref: #cashflow99269
Node: check-dates100485
Ref: #check-dates100612
Node: check-dupes100891
Ref: #check-dupes101017
Node: close101310
Ref: #close101418
Node: close usage102940
Ref: #close-usage103033
Node: codes105846
Ref: #codes105954
Node: commodities106666
Ref: #commodities106793
Node: descriptions106875
Ref: #descriptions107003
Node: diff107307
Ref: #diff107413
Node: files108460
Ref: #files108560
Node: help108707
Ref: #help108807
Node: import109888
Ref: #import110002
Node: Importing balance assignments110895
Ref: #importing-balance-assignments111043
Node: incomestatement111692
Ref: #incomestatement111825
Node: notes113170
Ref: #notes113283
Node: payees113651
Ref: #payees113757
Node: prices114177
Ref: #prices114283
Node: print114624
Ref: #print114734
Node: print-unique119530
Ref: #print-unique119656
Node: register119941
Ref: #register120068
Node: Custom register output124517
Ref: #custom-register-output124646
Node: register-match125983
Ref: #register-match126117
Node: rewrite126468
Ref: #rewrite126583
Node: Re-write rules in a file128438
Ref: #re-write-rules-in-a-file128572
Node: Diff output format129782
Ref: #diff-output-format129951
Node: rewrite vs print --auto131043
Ref: #rewrite-vs.-print---auto131222
Node: roi131778
Ref: #roi131876
Node: stats132888
Ref: #stats132987
Node: tags133775
Ref: #tags133873
Node: test134392
Ref: #test134500
Node: Add-on commands135247
Ref: #add-on-commands135364
Node: ui136707
Ref: #ui136795
Node: web136849
Ref: #web136952
Node: iadd137068
Ref: #iadd137179
Node: interest137261
Ref: #interest137368
Node: ENVIRONMENT137608
Ref: #environment137720
Node: FILES138705
Ref: #files-1138808
Node: LIMITATIONS139021
Ref: #limitations139140
Node: TROUBLESHOOTING139882
Ref: #troubleshooting139995

End Tag Table

View File

@ -1078,6 +1078,14 @@ OPTIONS
-p "2009/1/1" just that day; equivalent
to "2009/1/1 to 2009/1/2"
Or you can specify a single quarter like so:
-p "2009Q1" first quarter of 2009,
equivalent to "2009/1/1 to
2009/4/1"
-p "q4" fourth quarter of the cur-
rent year
The argument of -p can also begin with, or be, a report interval ex-
pression. The basic report intervals are daily, weekly, monthly, quar-
terly, or yearly, which have the same effect as the -D,-W,-M,-Q, or -Y
@ -1131,6 +1139,8 @@ OPTIONS
-p "every 2nd day of periods will go from Tue to Tue
week"
-p "every Tue" same
-p "every 15th day" period boundaries will be on 15th of each
month
-p "every 2nd Monday" period boundaries will be on second Monday of
@ -1542,6 +1552,9 @@ OPTIONS
amounts terval, val-
(with report ued at inter-
interval) val start
running to- sum/average sum/average sum/average sum/average sum/average
tal/average of displayed of displayed of displayed of displayed of displayed
values values values values values
@ -1558,9 +1571,6 @@ OPTIONS
(with report costs riod ends of riod ends of DATE/today of
interval) sums of sums of sums of post-
postings postings ings
starting sums of sums of not supported sums of sums of post-
balances costs of postings be- postings be- ings before
(with report postings be- fore report fore report report start
@ -2317,14 +2327,15 @@ COMMANDS
balancesheet
balancesheet, bs
This command displays a simple balance sheet, showing historical ending
balances of asset and liability accounts (ignoring any report begin
date). It assumes that these accounts are under a top-level asset or
liability account (case insensitive, plural forms also allowed).
This command displays a balance sheet, showing historical ending bal-
ances of asset and liability accounts. (To see equity as well, use the
balancesheetequity command.) Amounts are shown with normal positive
sign, as in conventional financial statements.
Note this report shows all account balances with normal positive sign
(like conventional financial statements, unlike balance/print/register)
(experimental).
The asset and liability accounts shown are those accounts declared with
the Asset or Cash or Liability type, or otherwise all accounts under a
top-level asset or liability account (case insensitive, plurals al-
lowed).
Example:
@ -2362,8 +2373,14 @@ COMMANDS
balancesheetequity
balancesheetequity, bse
Just like balancesheet, but also reports Equity (which it assumes is
under a top-level equity account).
This command displays a balance sheet, showing historical ending bal-
ances of asset, liability and equity accounts. Amounts are shown with
normal positive sign, as in conventional financial statements.
The asset, liability and equity accounts shown are those accounts de-
clared with the Asset, Cash, Liability or Equity type, or otherwise all
accounts under a top-level asset, liability or equity account (case in-
sensitive, plurals allowed).
Example:
@ -2397,12 +2414,14 @@ COMMANDS
cashflow
cashflow, cf
This command displays a simple cashflow statement, showing changes in
"cash" accounts. It assumes that these accounts are under a top-level
asset account (case insensitive, plural forms also allowed) and do not
contain receivable or A/R in their name. Note this report shows all
account balances with normal positive sign (like conventional financial
statements, unlike balance/print/register) (experimental).
This command displays a cashflow statement, showing the inflows and
outflows affecting "cash" (ie, liquid) assets. Amounts are shown with
normal positive sign, as in conventional financial statements.
The "cash" accounts shown are those accounts declared with the Cash
type, or otherwise all accounts under a top-level asset account (case
insensitive, plural allowed) which do not have fixed, investment, re-
ceivable or A/R in their name.
Example:
@ -2706,16 +2725,16 @@ COMMANDS
incomestatement
incomestatement, is
This command displays a simple income statement, showing revenues and
expenses during a period. It assumes that these accounts are under a
top-level revenue or income or expense account (case insensitive, plu-
ral forms also allowed). Note this report shows all account balances
with normal positive sign (like conventional financial statements, un-
like balance/print/register) (experimental).
This command displays an income statement, showing revenues and ex-
penses during one or more periods. Amounts are shown with normal posi-
tive sign, as in conventional financial statements.
This command displays a simple income statement. It currently assumes
that you have top-level accounts named income (or revenue) and expense
(plural forms also allowed.)
The revenue and expense accounts shown are those accounts declared with
the Revenue or Expense type, or otherwise all accounts under a top-
level revenue or income or expense account (case insensitive, plurals
allowed).
Example:
$ hledger incomestatement
Income Statement
@ -2914,9 +2933,16 @@ COMMANDS
register, reg, r
Show postings and their running total.
The register command displays postings in date order, one per line, and
their running total. This is typically used with a query selecting a
particular account, to see that account's activity:
The register command displays matched postings, across all accounts, in
date order, with their running total or running historical balance.
(See also the aregister command, which shows matched transactions in a
specific account.)
register normally shows line per posting, but note that multi-commodity
amounts will occupy multiple lines (one line per commodity).
It is typically used with a query selecting a particular account, to
see that account's activity:
$ hledger register checking
2008/01/01 income assets:bank:checking $1 $1
@ -3431,4 +3457,4 @@ SEE ALSO
hledger 1.18.99 July 2020 hledger(1)
hledger 1.18.99 August 2020 hledger(1)