slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages 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, To remove the depth limit, set it higher than the maximum account depth,
or press \f[C]ESCAPE\f[]. or press \f[C]ESCAPE\f[].
.PP .PP
\f[C]F\f[] toggles flat mode on and off. \f[C]F\f[] toggles flat mode, in which accounts are shown as a flat
In flat mode, accounts are listed without indentation, and show their list, with their full names.
subaccount\-excluding balances, except for accounts which have been In this mode, account balances exclude subaccounts, except for accounts
clipped by a depth limit, which show their inclusive balances (as with at the depth limit (as with hledger\[aq]s balance command).
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 .PP
\f[C]C\f[] toggles cleared mode, in which uncleared transactions and \f[C]C\f[] toggles cleared mode, in which uncleared transactions and
postings are not shown. 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 the overall change to the current account\[aq]s balance; positive for an
inflow to this account, negative for an outflow. inflow to this account, negative for an outflow.
.IP \[bu] 2 .IP \[bu] 2
the current account\[aq]s historic balance (if no query other than a the running historical total or period total for the current account,
date limit is in effect) or the running total starting from zero after the transaction.
(otherwise), after the transaction. This can be toggled with \f[C]H\f[].
.PD 0 Similar to the accounts screen, the historical total is affected by
.P transactions (filtered by the filter query) before the report start
.PD date, while the period total is not.
Eg, these will show historic balances: If the historical total is not disturbed by a filter query, it will be
.RS 2 the running historical balance you would see on a bank register for the
.IP current account.
.nf
\f[C]
$\ hledger\-ui
$\ hledger\-ui\ \-\-begin\ \[aq]this\ month\[aq]
$\ hledger\-ui\ \-\-register\ checking\ date:2015/10
\f[]
.fi
.PP .PP
while these will show a running total, since the queries are not just If the accounts screen was in tree mode, the register screen will
date limits: include transactions from both the current account and its subaccounts.
.IP If the accounts screen was in flat mode, and a non\-depth\-clipped
.nf account was selected, the register screen will exclude transactions from
\f[C] subaccounts.
$\ hledger\-ui\ checking In other words, the register always shows the transactions responsible
$\ hledger\-ui\ \-\-begin\ \[aq]this\ month\[aq]\ desc:market for the period balance shown on the accounts screen.
$\ hledger\-ui\ \-\-register\ checking\ \-\-cleared As on the accounts screen, this can be toggled with \f[C]F\f[].
\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.
.PP .PP
\f[C]C\f[] toggles cleared mode, in which uncleared transactions and \f[C]C\f[] toggles cleared mode, in which uncleared transactions and
postings are not shown. 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 limit. To remove the depth limit, set it higher than the maximum
account depth, or press `ESCAPE'. account depth, or press `ESCAPE'.
`F' toggles flat mode on and off. In flat mode, accounts are listed `F' toggles flat mode, in which accounts are shown as a flat list,
without indentation, and show their subaccount-excluding balances, with their full names. In this mode, account balances exclude
except for accounts which have been clipped by a depth limit, which show subaccounts, except for accounts at the depth limit (as with hledger's
their inclusive balances (as with hledger's balance command). 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 `C' toggles cleared mode, in which uncleared transactions and
postings are not shown. `U' toggles uncleared mode, in which only 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 * the overall change to the current account's balance; positive for
an inflow to this account, negative for an outflow. an inflow to this account, negative for an outflow.
* the current account's historic balance (if no query other than a * the running historical total or period total for the current
date limit is in effect) or the running total starting from zero account, after the transaction. This can be toggled with `H'.
(otherwise), after the transaction. Similar to the accounts screen, the historical total is affected
Eg, these will show historic balances: 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 If the accounts screen was in tree mode, the register screen will
$ hledger-ui --begin 'this month' include transactions from both the current account and its subaccounts.
$ hledger-ui --register checking date:2015/10 If the accounts screen was in flat mode, and a non-depth-clipped account
was selected, the register screen will exclude transactions from
while these will show a running total, since the queries are not subaccounts. In other words, the register always shows the transactions
just date limits: responsible for the period balance shown on the accounts screen. As on
the accounts screen, this can be toggled with `F'.
$ 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.
`C' toggles cleared mode, in which uncleared transactions and `C' toggles cleared mode, in which uncleared transactions and
postings are not shown. `U' toggles uncleared mode, in which only postings are not shown. `U' toggles uncleared mode, in which only
@ -353,11 +354,11 @@ Node: SCREENS6241
Ref: #screens6328 Ref: #screens6328
Node: Accounts screen6418 Node: Accounts screen6418
Ref: #accounts-screen6548 Ref: #accounts-screen6548
Node: Register screen8014 Node: Register screen8586
Ref: #register-screen8171 Ref: #register-screen8743
Node: Transaction screen10131 Node: Transaction screen10631
Ref: #transaction-screen10291 Ref: #transaction-screen10791
Node: Error screen11158 Node: Error screen11658
Ref: #error-screen11282 Ref: #error-screen11782
 
End Tag Table 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 depth limit, set it higher than the maximum account depth, or press
ESCAPE. ESCAPE.
F toggles flat mode on and off. In flat mode, accounts are listed F toggles flat mode, in which accounts are shown as a flat list, with
without indentation, and show their subaccount-excluding balances, their full names. In this mode, account balances exclude subaccounts,
except for accounts which have been clipped by a depth limit, which except for accounts at the depth limit (as with hledger's balance com-
show their inclusive balances (as with hledger's balance command). 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 C toggles cleared mode, in which uncleared transactions and postings
are not shown. U toggles uncleared mode, in which only uncleared 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 o the overall change to the current account's balance; positive for an
inflow to this account, negative for an outflow. inflow to this account, negative for an outflow.
o the current account's historic balance (if no query other than a date o the running historical total or period total for the current account,
limit is in effect) or the running total starting from zero (other- after the transaction. This can be toggled with H. Similar to the
wise), after the transaction. accounts screen, the historical total is affected by transactions
Eg, these will show historic balances: (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 If the accounts screen was in tree mode, the register screen will
$ hledger-ui --begin 'this month' include transactions from both the current account and its subaccounts.
$ hledger-ui --register checking date:2015/10 If the accounts screen was in flat mode, and a non-depth-clipped
account was selected, the register screen will exclude transactions
while these will show a running total, since the queries are not just from subaccounts. In other words, the register always shows the trans-
date limits: actions responsible for the period balance shown on the accounts
screen. As on the accounts screen, this can be toggled with F.
$ 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.
C toggles cleared mode, in which uncleared transactions and postings C toggles cleared mode, in which uncleared transactions and postings
are not shown. U toggles uncleared mode, in which only uncleared 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. Show accounts and their balances.
Alias: bal. Alias: bal.
.TP .TP
.B \f[C]\-\-tree\f[] .B \f[C]\-\-change\f[]
show short account names, as a tree show balance change in each period (default)
.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
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-cumulative\f[] .B \f[C]\-\-cumulative\f[]
in multicolumn mode: show ending balances accumulated from 0 at report show balance change accumulated across periods (in multicolumn reports)
start .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 .RS
.RE .RE
.TP .TP
.B \f[C]\-A\ \-\-average\f[] .B \f[C]\-A\ \-\-average\f[]
in multicolumn mode: show a row average column show a row average column (in multicolumn mode)
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-T\ \-\-row\-total\f[] .B \f[C]\-T\ \-\-row\-total\f[]
in multicolumn mode: show a row total column show a row total column (in multicolumn mode)
.RS .RS
.RE .RE
.TP .TP
@ -1054,15 +1052,18 @@ don\[aq]t show the final total row
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-V\ \-\-value\f[] .B \f[C]\-\-drop=N\f[]
show amounts as their current market value in their default valuation omit N leading account name parts (in flat mode)
commodity
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-o\ FILE[.FMT]\ \-\-output\-file=FILE[.FMT]\f[] .B \f[C]\-\-no\-elide\f[]
write output to FILE instead of stdout. don\[aq]t squash boring parent accounts (in tree mode)
A recognised FMT suffix influences the format. .RS
.RE
.TP
.B \f[C]\-\-format=LINEFORMAT\f[]
in single\-column balance reports: use this custom line format
.RS .RS
.RE .RE
.TP .TP
@ -1071,6 +1072,12 @@ select the output format.
Supported formats: txt, csv. Supported formats: txt, csv.
.RS .RS
.RE .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 .PP
The balance command displays accounts and balances. The balance command displays accounts and balances.
It is hledger\[aq]s most featureful and most useful command. It is hledger\[aq]s most featureful and most useful command.
@ -1583,17 +1590,17 @@ most recent
.RS .RS
.RE .RE
.TP .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[] .B \f[C]\-O\ FMT\ \-\-output\-format=FMT\f[]
select the output format. select the output format.
Supported formats: txt, csv. Supported formats: txt, csv.
.RS .RS
.RE .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 .IP
.nf .nf
\f[C] \f[C]
@ -1635,13 +1642,20 @@ The print command also supports output destination and CSV output.
Show postings and their running total. Show postings and their running total.
Alias: reg. Alias: reg.
.TP .TP
.B \f[C]\-\-cumulative\f[]
show running total from report start date (default)
.RS
.RE
.TP
.B \f[C]\-H\ \-\-historical\f[] .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 .RS
.RE .RE
.TP .TP
.B \f[C]\-A\ \-\-average\f[] .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 .RS
.RE .RE
.TP .TP
@ -1656,17 +1670,17 @@ set output width (default: terminal width or COLUMNS.
.RS .RS
.RE .RE
.TP .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[] .B \f[C]\-O\ FMT\ \-\-output\-format=FMT\f[]
select the output format. select the output format.
Supported formats: txt, csv. Supported formats: txt, csv.
.RS .RS
.RE .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 .PP
The register command displays postings, one per line, and their running The register command displays postings, one per line, and their running
total. 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 posting amount instead of the running total (so, the final number
displayed is the average for the whole report period). displayed is the average for the whole report period).
This flag implies \f[C]\-\-empty\f[] (see below). 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. It works best when showing just one account and one commodity.
.PP .PP
The \f[C]\-\-related\f[]/\f[C]\-r\f[] flag shows the \f[I]other\f[] 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 .PP
Show some journal statistics. Show some journal statistics.
.TP .TP
.B \f[C]\-o\ FILE[.FMT]\ \-\-output\-file=FILE[.FMT]\f[] .B \f[C]\-o\ FILE\ \-\-output\-file=FILE\f[]
write output to FILE instead of stdout. write output to FILE.
A recognised FMT suffix influences the format. A file extension matching one of the above formats selects that format.
.RS .RS
.RE .RE
.IP .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. Show accounts and their balances. Alias: bal.
`--tree' `--change'
show short account names, as a tree show balance change in each period (default)
`--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
`--cumulative' `--cumulative'
in multicolumn mode: show ending balances accumulated from 0 at show balance change accumulated across periods (in multicolumn
report start 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' `-A --average'
in multicolumn mode: show a row average column show a row average column (in multicolumn mode)
`-T --row-total' `-T --row-total'
in multicolumn mode: show a row total column show a row total column (in multicolumn mode)
`-N --no-total' `-N --no-total'
don't show the final total row don't show the final total row
`-V --value' `--drop=N'
show amounts as their current market value in their default omit N leading account name parts (in flat mode)
valuation commodity
`-o FILE[.FMT] --output-file=FILE[.FMT]' `--no-elide'
write output to FILE instead of stdout. A recognised FMT suffix don't squash boring parent accounts (in tree mode)
influences the format.
`--format=LINEFORMAT'
in single-column balance reports: use this custom line format
`-O FMT --output-format=FMT' `-O FMT --output-format=FMT'
select the output format. Supported formats: txt, csv. 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 The balance command displays accounts and balances. It is hledger's
most featureful and most useful command. 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 show the transaction whose description is most similar to STR, and
is most recent 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' `-O FMT --output-format=FMT'
select the output format. Supported formats: txt, csv. 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 $ hledger print
2008/01/01 income 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. Show postings and their running total. Alias: reg.
`--cumulative'
show running total from report start date (default)
`-H --historical' `-H --historical'
show historical running balance, reflecting prior postings show historical running total/balance (includes postings before
report start date)
`-A --average' `-A --average'
show a running average instead of the running total (implies show running average of posting amounts instead of total (implies
-empty) -empty)
`-r --related' `-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 set output width (default: terminal width or COLUMNS. -wN,M sets
description width as well) 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' `-O FMT --output-format=FMT'
select the output format. Supported formats: txt, csv. 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 The register command displays postings, one per line, and their
running total. This is typically used with a query selecting a running total. This is typically used with a query selecting a
particular account, to see that account's activity: particular account, to see that account's activity:
@ -1445,7 +1454,8 @@ displayed.
The `--average'/`-A' flag shows the running average posting amount The `--average'/`-A' flag shows the running average posting amount
instead of the running total (so, the final number displayed is the instead of the running total (so, the final number displayed is the
average for the whole report period). This flag implies `--empty' (see 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 The `--related'/`-r' flag shows the _other_ postings in the
transactions of the postings which would normally be shown. 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. Show some journal statistics.
`-o FILE[.FMT] --output-file=FILE[.FMT]' `-o FILE --output-file=FILE'
write output to FILE instead of stdout. A recognised FMT suffix write output to FILE. A file extension matching one of the above
influences the format. formats selects that format.
$ hledger stats $ hledger stats
@ -2127,69 +2137,69 @@ Node: add21806
Ref: #add21907 Ref: #add21907
Node: balance24566 Node: balance24566
Ref: #balance24679 Ref: #balance24679
Node: Flat mode27448 Node: Flat mode27652
Ref: #flat-mode27575 Ref: #flat-mode27779
Node: Depth limited balance reports27994 Node: Depth limited balance reports28198
Ref: #depth-limited-balance-reports28197 Ref: #depth-limited-balance-reports28401
Node: Multicolumn balance reports28618 Node: Multicolumn balance reports28822
Ref: #multicolumn-balance-reports28820 Ref: #multicolumn-balance-reports29024
Node: Market value33469 Node: Market value33673
Ref: #market-value33633 Ref: #market-value33837
Node: Custom balance output34126 Node: Custom balance output34330
Ref: #custom-balance-output34299 Ref: #custom-balance-output34503
Node: Output destination36403 Node: Output destination36607
Ref: #output-destination36568 Ref: #output-destination36772
Node: CSV output36838 Node: CSV output37042
Ref: #csv-output36957 Ref: #csv-output37161
Node: balancesheet37354 Node: balancesheet37558
Ref: #balancesheet37482 Ref: #balancesheet37686
Node: cashflow38134 Node: cashflow38338
Ref: #cashflow38251 Ref: #cashflow38455
Node: help38941 Node: help39145
Ref: #help39053 Ref: #help39257
Node: incomestatement39890 Node: incomestatement40094
Ref: #incomestatement40020 Ref: #incomestatement40224
Node: info40747 Node: info40951
Ref: #info40854 Ref: #info41058
Node: man41216 Node: man41420
Ref: #man41313 Ref: #man41517
Node: print41716 Node: print41920
Ref: #print41821 Ref: #print42025
Node: register43172 Node: register43371
Ref: #register43285 Ref: #register43484
Node: Custom register output47641 Node: Custom register output47976
Ref: #custom-register-output47772 Ref: #custom-register-output48107
Node: stats49069 Node: stats49404
Ref: #stats49175 Ref: #stats49510
Node: test50056 Node: test50386
Ref: #test50143 Ref: #test50473
Node: ADD-ON COMMANDS50510 Node: ADD-ON COMMANDS50840
Ref: #add-on-commands50646 Ref: #add-on-commands50976
Node: api51934 Node: api52264
Ref: #api52026 Ref: #api52356
Node: autosync52060 Node: autosync52390
Ref: #autosync52175 Ref: #autosync52505
Node: diff54490 Node: diff54820
Ref: #diff54600 Ref: #diff54930
Node: equity55264 Node: equity55594
Ref: #equity55378 Ref: #equity55708
Node: interest56706 Node: interest57036
Ref: #interest56823 Ref: #interest57153
Node: irr59907 Node: irr60237
Ref: #irr60020 Ref: #irr60350
Node: print-unique62395 Node: print-unique62725
Ref: #print-unique62525 Ref: #print-unique62855
Node: rewrite62783 Node: rewrite63113
Ref: #rewrite62902 Ref: #rewrite63232
Node: ui63431 Node: ui63761
Ref: #ui63531 Ref: #ui63861
Node: web63572 Node: web63902
Ref: #web63660 Ref: #web63990
Node: TROUBLESHOOTING63693 Node: TROUBLESHOOTING64023
Ref: #troubleshooting63812 Ref: #troubleshooting64142
Node: Run-time problems63866 Node: Run-time problems64196
Ref: #run-time-problems64009 Ref: #run-time-problems64339
Node: Known limitations65953 Node: Known limitations66283
Ref: #known-limitations66096 Ref: #known-limitations66426
 
End Tag Table End Tag Table

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

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