simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-11-08 07:09:28 +03:00
Code Issues Projects Releases Wiki Activity

doc: update generated manuals

Browse Source
This commit is contained in:
Simon Michael 2016-08-12 17:46:12 -07:00
parent 4e3c0cc936
commit eaba311634
6 changed files with 338 additions and 309 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
hledger-ui/doc/hledger-ui.1
View File

@ -292,11 +292,22 @@ depth limit.
To remove the depth limit, set it higher than the maximum account depth,
or press \f[C]ESCAPE\f[].
.PP
\f[C]F\f[] toggles flat mode on and off.
In flat mode, accounts are listed without indentation, and show their
subaccount\-excluding balances, except for accounts which have been
clipped by a depth limit, which show their inclusive balances (as with
hledger\[aq]s balance command).
\f[C]F\f[] toggles flat mode, in which accounts are shown as a flat
list, with their full names.
In this mode, account balances exclude subaccounts, except for accounts
at the depth limit (as with hledger\[aq]s balance command).
.PP
\f[C]H\f[] toggles between showing historical balances or period
balances.
Historical balances (the default) are ending balances at the end of the
report period, taking into account all transactions before that date
(filtered by the filter query if any), including transactions before the
start of the report period.
In other words, historical balances are what you would see on a bank
statement for that account (unless disturbed by a filter query).
Period balances ignore transactions before the report start date, so
they show the change in balance during the report period.
They are more useful eg when viewing a time log.
.PP
\f[C]C\f[] toggles cleared mode, in which uncleared transactions and
postings are not shown.
@ -324,43 +335,24 @@ affected by real postings.)
the overall change to the current account\[aq]s balance; positive for an
inflow to this account, negative for an outflow.
.IP \[bu] 2
the current account\[aq]s historic balance (if no query other than a
date limit is in effect) or the running total starting from zero
(otherwise), after the transaction.
.PD 0
.P
.PD
Eg, these will show historic balances:
.RS 2
.IP
.nf
\f[C]
$\ hledger\-ui
$\ hledger\-ui\ \-\-begin\ \[aq]this\ month\[aq]
$\ hledger\-ui\ \-\-register\ checking\ date:2015/10
\f[]
.fi
the running historical total or period total for the current account,
after the transaction.
This can be toggled with \f[C]H\f[].
Similar to the accounts screen, the historical total is affected by
transactions (filtered by the filter query) before the report start
date, while the period total is not.
If the historical total is not disturbed by a filter query, it will be
the running historical balance you would see on a bank register for the
current account.
.PP
while these will show a running total, since the queries are not just
date limits:
.IP
.nf
\f[C]
$\ hledger\-ui\ checking
$\ hledger\-ui\ \-\-begin\ \[aq]this\ month\[aq]\ desc:market
$\ hledger\-ui\ \-\-register\ checking\ \-\-cleared
\f[]
.fi
.RE
.PP
The register screen normally shows transactions in the current account
and any of its subaccounts (inclusive mode).
If it was entered from the accounts screen in flat mode, where the
selected account was not depth\-clipped and therefore was showing its
subaccount\-excluding balance, the register too will omit the
transactions of subaccounts (exclusive mode).
This means the register always shows the transactions responsible for
the balance being displayed on the accounts screen.
If the accounts screen was in tree mode, the register screen will
include transactions from both the current account and its subaccounts.
If the accounts screen was in flat mode, and a non\-depth\-clipped
account was selected, the register screen will exclude transactions from
subaccounts.
In other words, the register always shows the transactions responsible
for the period balance shown on the accounts screen.
As on the accounts screen, this can be toggled with \f[C]F\f[].
.PP
\f[C]C\f[] toggles cleared mode, in which uncleared transactions and
postings are not shown.

69
hledger-ui/doc/hledger-ui.1.info
View File

@ -233,10 +233,20 @@ single total. `-' and `+' (or `=') decrease and increase the depth
limit. To remove the depth limit, set it higher than the maximum
account depth, or press `ESCAPE'.
`F' toggles flat mode on and off. In flat mode, accounts are listed
without indentation, and show their subaccount-excluding balances,
except for accounts which have been clipped by a depth limit, which show
their inclusive balances (as with hledger's balance command).
`F' toggles flat mode, in which accounts are shown as a flat list,
with their full names. In this mode, account balances exclude
subaccounts, except for accounts at the depth limit (as with hledger's
balance command).
`H' toggles between showing historical balances or period balances.
Historical balances (the default) are ending balances at the end of the
report period, taking into account all transactions before that date
(filtered by the filter query if any), including transactions before the
start of the report period. In other words, historical balances are what
you would see on a bank statement for that account (unless disturbed by
a filter query). Period balances ignore transactions before the report
start date, so they show the change in balance during the report period.
They are more useful eg when viewing a time log.
`C' toggles cleared mode, in which uncleared transactions and
postings are not shown. `U' toggles uncleared mode, in which only
@ -266,32 +276,23 @@ a check register. Each line represents one transaction and shows:
* the overall change to the current account's balance; positive for
an inflow to this account, negative for an outflow.
* the current account's historic balance (if no query other than a
date limit is in effect) or the running total starting from zero
(otherwise), after the transaction.
Eg, these will show historic balances:
* the running historical total or period total for the current
account, after the transaction. This can be toggled with `H'.
Similar to the accounts screen, the historical total is affected
by transactions (filtered by the filter query) before the report
start date, while the period total is not. If the historical total
is not disturbed by a filter query, it will be the running
historical balance you would see on a bank register for the
current account.
$ hledger-ui
$ hledger-ui --begin 'this month'
$ hledger-ui --register checking date:2015/10
while these will show a running total, since the queries are not
just date limits:
$ hledger-ui checking
$ hledger-ui --begin 'this month' desc:market
$ hledger-ui --register checking --cleared
The register screen normally shows transactions in the current
account and any of its subaccounts (inclusive mode). If it was entered
from the accounts screen in flat mode, where the selected account was
not depth-clipped and therefore was showing its subaccount-excluding
balance, the register too will omit the transactions of subaccounts
(exclusive mode). This means the register always shows the transactions
responsible for the balance being displayed on the accounts screen.
If the accounts screen was in tree mode, the register screen will
include transactions from both the current account and its subaccounts.
If the accounts screen was in flat mode, and a non-depth-clipped account
was selected, the register screen will exclude transactions from
subaccounts. In other words, the register always shows the transactions
responsible for the period balance shown on the accounts screen. As on
the accounts screen, this can be toggled with `F'.
`C' toggles cleared mode, in which uncleared transactions and
postings are not shown. `U' toggles uncleared mode, in which only
@ -353,11 +354,11 @@ Node: SCREENS6241
Ref: #screens6328
Node: Accounts screen6418
Ref: #accounts-screen6548
Node: Register screen8014
Ref: #register-screen8171
Node: Transaction screen10131
Ref: #transaction-screen10291
Node: Error screen11158
Ref: #error-screen11282
Node: Register screen8586
Ref: #register-screen8743
Node: Transaction screen10631
Ref: #transaction-screen10791
Node: Error screen11658
Ref: #error-screen11782

End Tag Table

55
hledger-ui/doc/hledger-ui.1.txt
View File

@ -202,10 +202,20 @@ SCREENS
depth limit, set it higher than the maximum account depth, or press
ESCAPE.
F toggles flat mode on and off. In flat mode, accounts are listed
without indentation, and show their subaccount-excluding balances,
except for accounts which have been clipped by a depth limit, which
show their inclusive balances (as with hledger's balance command).
F toggles flat mode, in which accounts are shown as a flat list, with
their full names. In this mode, account balances exclude subaccounts,
except for accounts at the depth limit (as with hledger's balance com-
mand).
H toggles between showing historical balances or period balances. His-
torical balances (the default) are ending balances at the end of the
report period, taking into account all transactions before that date
(filtered by the filter query if any), including transactions before
the start of the report period. In other words, historical balances
are what you would see on a bank statement for that account (unless
disturbed by a filter query). Period balances ignore transactions
before the report start date, so they show the change in balance during
the report period. They are more useful eg when viewing a time log.
C toggles cleared mode, in which uncleared transactions and postings
are not shown. U toggles uncleared mode, in which only uncleared
@ -230,30 +240,21 @@ SCREENS
o the overall change to the current account's balance; positive for an
inflow to this account, negative for an outflow.
o the current account's historic balance (if no query other than a date
limit is in effect) or the running total starting from zero (other-
wise), after the transaction.
Eg, these will show historic balances:
o the running historical total or period total for the current account,
after the transaction. This can be toggled with H. Similar to the
accounts screen, the historical total is affected by transactions
(filtered by the filter query) before the report start date, while
the period total is not. If the historical total is not disturbed by
a filter query, it will be the running historical balance you would
see on a bank register for the current account.
$ hledger-ui
$ hledger-ui --begin 'this month'
$ hledger-ui --register checking date:2015/10
while these will show a running total, since the queries are not just
date limits:
$ hledger-ui checking
$ hledger-ui --begin 'this month' desc:market
$ hledger-ui --register checking --cleared
The register screen normally shows transactions in the current account
and any of its subaccounts (inclusive mode). If it was entered from
the accounts screen in flat mode, where the selected account was not
depth-clipped and therefore was showing its subaccount-excluding bal-
ance, the register too will omit the transactions of subaccounts
(exclusive mode). This means the register always shows the transac-
tions responsible for the balance being displayed on the accounts
screen.
If the accounts screen was in tree mode, the register screen will
include transactions from both the current account and its subaccounts.
If the accounts screen was in flat mode, and a non-depth-clipped
account was selected, the register screen will exclude transactions
from subaccounts. In other words, the register always shows the trans-
actions responsible for the period balance shown on the accounts
screen. As on the accounts screen, this can be toggled with F.
C toggles cleared mode, in which uncleared transactions and postings
are not shown. U toggles uncleared mode, in which only uncleared

123
hledger/doc/hledger.1
View File

@ -1003,49 +1003,47 @@ Date\ [2015/05/22]:\ <CTRL\-D>\ $
Show accounts and their balances.
Alias: bal.
.TP
.B \f[C]\-\-tree\f[]
show short account names, as a tree
.RS
.RE
.TP
.B \f[C]\-\-flat\f[]
show full account names, as a list (default)
.RS
.RE
.TP
.B \f[C]\-\-drop=N\f[]
in flat mode: omit N leading account name parts
.RS
.RE
.TP
.B \f[C]\-\-format=LINEFORMAT\f[]
in single\-column balance reports: use this custom line format
.RS
.RE
.TP
.B \f[C]\-\-no\-elide\f[]
in tree mode: don\[aq]t squash boring parent accounts
.RS
.RE
.TP
.B \f[C]\-H\ \-\-historical\f[]
show historical ending balances, reflecting postings before report start
.B \f[C]\-\-change\f[]
show balance change in each period (default)
.RS
.RE
.TP
.B \f[C]\-\-cumulative\f[]
in multicolumn mode: show ending balances accumulated from 0 at report
start
show balance change accumulated across periods (in multicolumn reports)
.RS
.RE
.TP
.B \f[C]\-H\ \-\-historical\f[]
show historical ending balance in each period (includes postings before
report start date)
.RS
.RE
.TP
.B \f[C]\-\-tree\f[]
show accounts as a tree; amounts include subaccounts (default in simple
reports)
.RS
.RE
.TP
.B \f[C]\-\-flat\f[]
show accounts as a list; amounts exclude subaccounts except when account
is depth\-clipped (default in multicolumn reports)
.RS
.RE
.TP
.B \f[C]\-V\ \-\-value\f[]
convert amounts to current market value in their default valuation
commodity
.RS
.RE
.TP
.B \f[C]\-A\ \-\-average\f[]
in multicolumn mode: show a row average column
show a row average column (in multicolumn mode)
.RS
.RE
.TP
.B \f[C]\-T\ \-\-row\-total\f[]
in multicolumn mode: show a row total column
show a row total column (in multicolumn mode)
.RS
.RE
.TP
@ -1054,15 +1052,18 @@ don\[aq]t show the final total row
.RS
.RE
.TP
.B \f[C]\-V\ \-\-value\f[]
show amounts as their current market value in their default valuation
commodity
.B \f[C]\-\-drop=N\f[]
omit N leading account name parts (in flat mode)
.RS
.RE
.TP
.B \f[C]\-o\ FILE[.FMT]\ \-\-output\-file=FILE[.FMT]\f[]
write output to FILE instead of stdout.
A recognised FMT suffix influences the format.
.B \f[C]\-\-no\-elide\f[]
don\[aq]t squash boring parent accounts (in tree mode)
.RS
.RE
.TP
.B \f[C]\-\-format=LINEFORMAT\f[]
in single\-column balance reports: use this custom line format
.RS
.RE
.TP
@ -1071,6 +1072,12 @@ select the output format.
Supported formats: txt, csv.
.RS
.RE
.TP
.B \f[C]\-o\ FILE\ \-\-output\-file=FILE\f[]
write output to FILE.
A file extension matching one of the above formats selects that format.
.RS
.RE
.PP
The balance command displays accounts and balances.
It is hledger\[aq]s most featureful and most useful command.
@ -1583,17 +1590,17 @@ most recent
.RS
.RE
.TP
.B \f[C]\-o\ FILE[.FMT]\ \-\-output\-file=FILE[.FMT]\f[]
write output to FILE instead of stdout.
A recognised FMT suffix influences the format.
.RS
.RE
.TP
.B \f[C]\-O\ FMT\ \-\-output\-format=FMT\f[]
select the output format.
Supported formats: txt, csv.
.RS
.RE
.TP
.B \f[C]\-o\ FILE\ \-\-output\-file=FILE\f[]
write output to FILE.
A file extension matching one of the above formats selects that format.
.RS
.RE
.IP
.nf
\f[C]
@ -1635,13 +1642,20 @@ The print command also supports output destination and CSV output.
Show postings and their running total.
Alias: reg.
.TP
.B \f[C]\-\-cumulative\f[]
show running total from report start date (default)
.RS
.RE
.TP
.B \f[C]\-H\ \-\-historical\f[]
show historical running balance, reflecting prior postings
show historical running total/balance (includes postings before report
start date)
.RS
.RE
.TP
.B \f[C]\-A\ \-\-average\f[]
show a running average instead of the running total (implies \-\-empty)
show running average of posting amounts instead of total (implies
\-\-empty)
.RS
.RE
.TP
@ -1656,17 +1670,17 @@ set output width (default: terminal width or COLUMNS.
.RS
.RE
.TP
.B \f[C]\-o\ FILE[.FMT]\ \-\-output\-file=FILE[.FMT]\f[]
write output to FILE instead of stdout.
A recognised FMT suffix influences the format.
.RS
.RE
.TP
.B \f[C]\-O\ FMT\ \-\-output\-format=FMT\f[]
select the output format.
Supported formats: txt, csv.
.RS
.RE
.TP
.B \f[C]\-o\ FILE\ \-\-output\-file=FILE\f[]
write output to FILE.
A file extension matching one of the above formats selects that format.
.RS
.RE
.PP
The register command displays postings, one per line, and their running
total.
@ -1704,6 +1718,7 @@ The \f[C]\-\-average\f[]/\f[C]\-A\f[] flag shows the running average
posting amount instead of the running total (so, the final number
displayed is the average for the whole report period).
This flag implies \f[C]\-\-empty\f[] (see below).
It is affected by \f[C]\-\-historical\f[].
It works best when showing just one account and one commodity.
.PP
The \f[C]\-\-related\f[]/\f[C]\-r\f[] flag shows the \f[I]other\f[]
@ -1802,9 +1817,9 @@ destination and CSV output.
.PP
Show some journal statistics.
.TP
.B \f[C]\-o\ FILE[.FMT]\ \-\-output\-file=FILE[.FMT]\f[]
write output to FILE instead of stdout.
A recognised FMT suffix influences the format.
.B \f[C]\-o\ FILE\ \-\-output\-file=FILE\f[]
write output to FILE.
A file extension matching one of the above formats selects that format.
.RS
.RE
.IP

222
hledger/doc/hledger.1.info
View File

@ -801,49 +801,54 @@ File: hledger.1.info, Node: balance, Next: balancesheet, Prev: add, Up: COMM
Show accounts and their balances. Alias: bal.
`--tree'
show short account names, as a tree
`--flat'
show full account names, as a list (default)
`--drop=N'
in flat mode: omit N leading account name parts
`--format=LINEFORMAT'
in single-column balance reports: use this custom line format
`--no-elide'
in tree mode: don't squash boring parent accounts
`-H --historical'
show historical ending balances, reflecting postings before report
start
`--change'
show balance change in each period (default)
`--cumulative'
in multicolumn mode: show ending balances accumulated from 0 at
report start
show balance change accumulated across periods (in multicolumn
reports)
`-H --historical'
show historical ending balance in each period (includes postings
before report start date)
`--tree'
show accounts as a tree; amounts include subaccounts (default in
simple reports)
`--flat'
show accounts as a list; amounts exclude subaccounts except when
account is depth-clipped (default in multicolumn reports)
`-V --value'
convert amounts to current market value in their default valuation
commodity
`-A --average'
in multicolumn mode: show a row average column
show a row average column (in multicolumn mode)
`-T --row-total'
in multicolumn mode: show a row total column
show a row total column (in multicolumn mode)
`-N --no-total'
don't show the final total row
`-V --value'
show amounts as their current market value in their default
valuation commodity
`--drop=N'
omit N leading account name parts (in flat mode)
`-o FILE[.FMT] --output-file=FILE[.FMT]'
write output to FILE instead of stdout. A recognised FMT suffix
influences the format.
`--no-elide'
don't squash boring parent accounts (in tree mode)
`--format=LINEFORMAT'
in single-column balance reports: use this custom line format
`-O FMT --output-format=FMT'
select the output format. Supported formats: txt, csv.
`-o FILE --output-file=FILE'
write output to FILE. A file extension matching one of the above
formats selects that format.
The balance command displays accounts and balances. It is hledger's
most featureful and most useful command.
@ -1349,13 +1354,13 @@ Show transactions from the journal.
show the transaction whose description is most similar to STR, and
is most recent
`-o FILE[.FMT] --output-file=FILE[.FMT]'
write output to FILE instead of stdout. A recognised FMT suffix
influences the format.
`-O FMT --output-format=FMT'
select the output format. Supported formats: txt, csv.
`-o FILE --output-file=FILE'
write output to FILE. A file extension matching one of the above
formats selects that format.
$ hledger print
2008/01/01 income
@ -1397,11 +1402,15 @@ File: hledger.1.info, Node: register, Next: stats, Prev: print, Up: COMMANDS
Show postings and their running total. Alias: reg.
`--cumulative'
show running total from report start date (default)
`-H --historical'
show historical running balance, reflecting prior postings
show historical running total/balance (includes postings before
report start date)
`-A --average'
show a running average instead of the running total (implies
show running average of posting amounts instead of total (implies
-empty)
`-r --related'
@ -1411,13 +1420,13 @@ Show postings and their running total. Alias: reg.
set output width (default: terminal width or COLUMNS. -wN,M sets
description width as well)
`-o FILE[.FMT] --output-file=FILE[.FMT]'
write output to FILE instead of stdout. A recognised FMT suffix
influences the format.
`-O FMT --output-format=FMT'
select the output format. Supported formats: txt, csv.
`-o FILE --output-file=FILE'
write output to FILE. A file extension matching one of the above
formats selects that format.
The register command displays postings, one per line, and their
running total. This is typically used with a query selecting a
particular account, to see that account's activity:
@ -1445,7 +1454,8 @@ displayed.
The `--average'/`-A' flag shows the running average posting amount
instead of the running total (so, the final number displayed is the
average for the whole report period). This flag implies `--empty' (see
below). It works best when showing just one account and one commodity.
below). It is affected by `--historical'. It works best when showing
just one account and one commodity.
The `--related'/`-r' flag shows the _other_ postings in the
transactions of the postings which would normally be shown.
@ -1536,9 +1546,9 @@ File: hledger.1.info, Node: stats, Next: test, Prev: register, Up: COMMANDS
Show some journal statistics.
`-o FILE[.FMT] --output-file=FILE[.FMT]'
write output to FILE instead of stdout. A recognised FMT suffix
influences the format.
`-o FILE --output-file=FILE'
write output to FILE. A file extension matching one of the above
formats selects that format.
$ hledger stats
@ -2127,69 +2137,69 @@ Node: add21806
Ref: #add21907
Node: balance24566
Ref: #balance24679
Node: Flat mode27448
Ref: #flat-mode27575
Node: Depth limited balance reports27994
Ref: #depth-limited-balance-reports28197
Node: Multicolumn balance reports28618
Ref: #multicolumn-balance-reports28820
Node: Market value33469
Ref: #market-value33633
Node: Custom balance output34126
Ref: #custom-balance-output34299
Node: Output destination36403
Ref: #output-destination36568
Node: CSV output36838
Ref: #csv-output36957
Node: balancesheet37354
Ref: #balancesheet37482
Node: cashflow38134
Ref: #cashflow38251
Node: help38941
Ref: #help39053
Node: incomestatement39890
Ref: #incomestatement40020
Node: info40747
Ref: #info40854
Node: man41216
Ref: #man41313
Node: print41716
Ref: #print41821
Node: register43172
Ref: #register43285
Node: Custom register output47641
Ref: #custom-register-output47772
Node: stats49069
Ref: #stats49175
Node: test50056
Ref: #test50143
Node: ADD-ON COMMANDS50510
Ref: #add-on-commands50646
Node: api51934
Ref: #api52026
Node: autosync52060
Ref: #autosync52175
Node: diff54490
Ref: #diff54600
Node: equity55264
Ref: #equity55378
Node: interest56706
Ref: #interest56823
Node: irr59907
Ref: #irr60020
Node: print-unique62395
Ref: #print-unique62525
Node: rewrite62783
Ref: #rewrite62902
Node: ui63431
Ref: #ui63531
Node: web63572
Ref: #web63660
Node: TROUBLESHOOTING63693
Ref: #troubleshooting63812
Node: Run-time problems63866
Ref: #run-time-problems64009
Node: Known limitations65953
Ref: #known-limitations66096
Node: Flat mode27652
Ref: #flat-mode27779
Node: Depth limited balance reports28198
Ref: #depth-limited-balance-reports28401
Node: Multicolumn balance reports28822
Ref: #multicolumn-balance-reports29024
Node: Market value33673
Ref: #market-value33837
Node: Custom balance output34330
Ref: #custom-balance-output34503
Node: Output destination36607
Ref: #output-destination36772
Node: CSV output37042
Ref: #csv-output37161
Node: balancesheet37558
Ref: #balancesheet37686
Node: cashflow38338
Ref: #cashflow38455
Node: help39145
Ref: #help39257
Node: incomestatement40094
Ref: #incomestatement40224
Node: info40951
Ref: #info41058
Node: man41420
Ref: #man41517
Node: print41920
Ref: #print42025
Node: register43371
Ref: #register43484
Node: Custom register output47976
Ref: #custom-register-output48107
Node: stats49404
Ref: #stats49510
Node: test50386
Ref: #test50473
Node: ADD-ON COMMANDS50840
Ref: #add-on-commands50976
Node: api52264
Ref: #api52356
Node: autosync52390
Ref: #autosync52505
Node: diff54820
Ref: #diff54930
Node: equity55594
Ref: #equity55708
Node: interest57036
Ref: #interest57153
Node: irr60237
Ref: #irr60350
Node: print-unique62725
Ref: #print-unique62855
Node: rewrite63113
Ref: #rewrite63232
Node: ui63761
Ref: #ui63861
Node: web63902
Ref: #web63990
Node: TROUBLESHOOTING64023
Ref: #troubleshooting64142
Node: Run-time problems64196
Ref: #run-time-problems64339
Node: Known limitations66283
Ref: #known-limitations66426

End Tag Table

104
hledger/doc/hledger.1.txt
View File

@ -697,47 +697,52 @@ COMMANDS
balance
Show accounts and their balances. Alias: bal.
--tree show short account names, as a tree
--flat show full account names, as a list (default)
--drop=N
in flat mode: omit N leading account name parts
--format=LINEFORMAT
in single-column balance reports: use this custom line format
--no-elide
in tree mode: don't squash boring parent accounts
-H --historical
show historical ending balances, reflecting postings before
report start
--change
show balance change in each period (default)
--cumulative
in multicolumn mode: show ending balances accumulated from 0 at
report start
show balance change accumulated across periods (in multicolumn
reports)
-H --historical
show historical ending balance in each period (includes postings
before report start date)
--tree show accounts as a tree; amounts include subaccounts (default in
simple reports)
--flat show accounts as a list; amounts exclude subaccounts except when
account is depth-clipped (default in multicolumn reports)
-V --value
convert amounts to current market value in their default valua-
tion commodity
-A --average
in multicolumn mode: show a row average column
show a row average column (in multicolumn mode)
-T --row-total
in multicolumn mode: show a row total column
show a row total column (in multicolumn mode)
-N --no-total
don't show the final total row
-V --value
show amounts as their current market value in their default val-
uation commodity
--drop=N
omit N leading account name parts (in flat mode)
-o FILE[.FMT] --output-file=FILE[.FMT]
write output to FILE instead of stdout. A recognised FMT suffix
influences the format.
--no-elide
don't squash boring parent accounts (in tree mode)
--format=LINEFORMAT
in single-column balance reports: use this custom line format
-O FMT --output-format=FMT
select the output format. Supported formats: txt, csv.
-o FILE --output-file=FILE
write output to FILE. A file extension matching one of the
above formats selects that format.
The balance command displays accounts and balances. It is hledger's
most featureful and most useful command.
@ -1137,13 +1142,13 @@ COMMANDS
show the transaction whose description is most similar to STR,
and is most recent
-o FILE[.FMT] --output-file=FILE[.FMT]
write output to FILE instead of stdout. A recognised FMT suffix
influences the format.
-O FMT --output-format=FMT
select the output format. Supported formats: txt, csv.
-o FILE --output-file=FILE
write output to FILE. A file extension matching one of the
above formats selects that format.
$ hledger print
2008/01/01 income
assets:bank:checking $1
@ -1179,29 +1184,33 @@ COMMANDS
register
Show postings and their running total. Alias: reg.
--cumulative
show running total from report start date (default)
-H --historical
show historical running balance, reflecting prior postings
show historical running total/balance (includes postings before
report start date)
-A --average
show a running average instead of the running total (implies
--empty)
show running average of posting amounts instead of total
(implies --empty)
-r --related
show postings' siblings instead
-w N --width=N
set output width (default: terminal width or COLUMNS. -wN,M
set output width (default: terminal width or COLUMNS. -wN,M
sets description width as well)
-o FILE[.FMT] --output-file=FILE[.FMT]
write output to FILE instead of stdout. A recognised FMT suffix
influences the format.
-O FMT --output-format=FMT
select the output format. Supported formats: txt, csv.
-o FILE --output-file=FILE
write output to FILE. A file extension matching one of the
above formats selects that format.
The register command displays postings, one per line, and their running
total. This is typically used with a query selecting a particular
total. This is typically used with a query selecting a particular
account, to see that account's activity:
$ hledger register checking
@ -1210,8 +1219,8 @@ COMMANDS
2008/06/02 save assets:bank:checking $-1 $1
2008/12/31 pay off assets:bank:checking $-1 0
The --historical/-H flag adds the balance from any undisplayed prior
postings to the running total. This is useful when you want to see
The --historical/-H flag adds the balance from any undisplayed prior
postings to the running total. This is useful when you want to see
only recent activity, with a historically accurate running balance:
$ hledger register checking -b 2008/6 --historical
@ -1221,10 +1230,11 @@ COMMANDS
The --depth option limits the amount of sub-account detail displayed.
The --average/-A flag shows the running average posting amount instead
The --average/-A flag shows the running average posting amount instead
of the running total (so, the final number displayed is the average for
the whole report period). This flag implies --empty (see below). It
works best when showing just one account and one commodity.
the whole report period). This flag implies --empty (see below). It
is affected by --historical. It works best when showing just one
account and one commodity.
The --related/-r flag shows the other postings in the transactions of
the postings which would normally be shown.
@ -1295,9 +1305,9 @@ COMMANDS
stats
Show some journal statistics.
-o FILE[.FMT] --output-file=FILE[.FMT]
write output to FILE instead of stdout. A recognised FMT suffix
influences the format.
-o FILE --output-file=FILE
write output to FILE. A file extension matching one of the
above formats selects that format.
$ hledger stats
Main journal file : /src/hledger/data/sample.journal