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 2017-03-28 04:09:29 -07:00
parent abfd6394ee
commit 64a97774c4
3 changed files with 485 additions and 179 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

147
hledger/doc/hledger.1
View File

@ -1662,8 +1662,43 @@ $\ hledger\ balance\ \-o\ FILE.csv\ \ #\ write\ CSV\ to\ FILE.csv
Show a balance sheet. Show a balance sheet.
Alias: bs. Alias: bs.
.TP .TP
.B \f[C]\-\-change\f[]
show balance change in each period, instead of historical ending
balances
.RS
.RE
.TP
.B \f[C]\-\-cumulative\f[]
show balance change accumulated across periods (in multicolumn reports),
instead of historical ending balances
.RS
.RE
.TP
.B \f[C]\-H\ \-\-historical\f[]
show historical ending balance in each period (includes postings before
report start date) (default)
.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[] .B \f[C]\-\-flat\f[]
show full account names, as a list (default) show accounts as a list; amounts exclude subaccounts except when account
is depth\-clipped (default in multicolumn reports)
.RS
.RE
.TP
.B \f[C]\-A\ \-\-average\f[]
show a row average column (in multicolumn mode)
.RS
.RE
.TP
.B \f[C]\-T\ \-\-row\-total\f[]
show a row total column (in multicolumn mode)
.RS .RS
.RE .RE
.TP .TP
@ -1673,7 +1708,7 @@ don\[aq]t show the final total row
.RE .RE
.TP .TP
.B \f[C]\-\-drop=N\f[] .B \f[C]\-\-drop=N\f[]
in flat mode: omit N leading account name parts omit N leading account name parts (in flat mode)
.RS .RS
.RE .RE
.TP .TP
@ -1713,23 +1748,66 @@ Total:
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ 0 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ 0
\f[] \f[]
.fi .fi
.PP
If given a period flag, renders a multi\-column balance with the same
format as \f[C]balance\f[], with asset and liability totals as well as
an overall total if desired.
.PP
This command shows normally historical end\-balance reports, but for
flexibility, also accepts \f[C]\-\-cumulative\f[] and
\f[C]\-\-change\f[] to display cumulative ending balances and changes in
reporting periods.
.SS cashflow .SS cashflow
.PP .PP
Show a cashflow statement. Show a cashflow statement.
Alias: cf. Alias: cf.
.TP .TP
.B \f[C]\-\-change\f[]
show balance change in each period (default)
.RS
.RE
.TP
.B \f[C]\-\-cumulative\f[]
show balance change accumulated across periods (in multicolumn reports),
instead of changes during periods
.RS
.RE
.TP
.B \f[C]\-H\ \-\-historical\f[]
show historical ending balance in each period (includes postings before
report start date), instead of changes during each period
.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[] .B \f[C]\-\-flat\f[]
show full account names, as a list (default) show accounts as a list; amounts exclude subaccounts except when account
is depth\-clipped (default in multicolumn reports)
.RS
.RE
.TP
.B \f[C]\-A\ \-\-average\f[]
show a row average column (in multicolumn mode)
.RS
.RE
.TP
.B \f[C]\-T\ \-\-row\-total\f[]
show a row total column (in multicolumn mode)
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-N\ \-\-no\-total\f[] .B \f[C]\-N\ \-\-no\-total\f[]
don\[aq]t show the final total row don\[aq]t show the final total row (in simple reports)
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-drop=N\f[] .B \f[C]\-\-drop=N\f[]
in flat mode: omit N leading account name parts omit N leading account name parts (in flat mode)
.RS .RS
.RE .RE
.TP .TP
@ -1766,6 +1844,14 @@ Total:
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ $\-1 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ $\-1
\f[] \f[]
.fi .fi
.PP
If given a period flag, renders a multi\-column balance with the same
format as \f[C]balance\f[].
.PP
This command normally shows period change reports, but for flexibility,
also accepts \f[C]\-\-cumulative\f[] and \f[C]\-\-historical\f[] to
display cumulative ending balances and historical ending balances, as
well.
.SS help .SS help
.PP .PP
Show any of the hledger manuals. Show any of the hledger manuals.
@ -1809,8 +1895,42 @@ SYNOPSIS
Show an income statement. Show an income statement.
Alias: is. Alias: is.
.TP .TP
.B \f[C]\-\-change\f[]
show balance change in each period (default)
.RS
.RE
.TP
.B \f[C]\-\-cumulative\f[]
show balance change accumulated across periods (in multicolumn reports),
instead of changes during periods
.RS
.RE
.TP
.B \f[C]\-H\ \-\-historical\f[]
show historical ending balance in each period (includes postings before
report start date), instead of changes during each period
.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[] .B \f[C]\-\-flat\f[]
show full account names, as a list (default) show accounts as a list; amounts exclude subaccounts except when account
is depth\-clipped (default in multicolumn reports)
.RS
.RE
.TP
.B \f[C]\-A\ \-\-average\f[]
show a row average column (in multicolumn mode)
.RS
.RE
.TP
.B \f[C]\-T\ \-\-row\-total\f[]
show a row total column (in multicolumn mode)
.RS .RS
.RE .RE
.TP .TP
@ -1820,7 +1940,7 @@ don\[aq]t show the final total row
.RE .RE
.TP .TP
.B \f[C]\-\-drop=N\f[] .B \f[C]\-\-drop=N\f[]
in flat mode: omit N leading account name parts omit N leading account name parts (in flat mode)
.RS .RS
.RE .RE
.TP .TP
@ -1863,6 +1983,14 @@ Total:
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ 0 \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ 0
\f[] \f[]
.fi .fi
.PP
If given a period flag, renders a multi\-column balance with the same
format as \f[C]balance\f[].
.PP
This command normally shows period change reports, but for flexibility,
also accepts \f[C]\-\-cumulative\f[] and \f[C]\-\-historical\f[] to
display cumulative ending balances and historical ending balances, as
well.
.SS info .SS info
.PP .PP
Show any of the hledger manuals using info. Show any of the hledger manuals using info.
@ -2310,9 +2438,10 @@ hledger\-check.hs checks more powerful account balance assertions.
.PP .PP
hledger\-check\-dates.hs checks that journal entries are ordered by hledger\-check\-dates.hs checks that journal entries are ordered by
date. date.
.SS dupes .SS check\-dupes
.PP .PP
hledger\-dupes.hs checks for account names sharing the same leaf name. hledger\-check\-dupes.hs checks for account names sharing the same leaf
name.
.SS equity .SS equity
.PP .PP
hledger\-equity.hs prints balance\-resetting transactions, useful for hledger\-equity.hs prints balance\-resetting transactions, useful for

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

@ -1272,15 +1272,38 @@ File: hledger.1.info, Node: balancesheet, Next: cashflow, Prev: balance, Up:
Show a balance sheet. Alias: bs. Show a balance sheet. Alias: bs.
'--change'
show balance change in each period, instead of historical ending
balances
'--cumulative'
show balance change accumulated across periods (in multicolumn
reports), instead of historical ending balances
'-H --historical'
show historical ending balance in each period (includes postings
before report start date) (default)
'--tree'
show accounts as a tree; amounts include subaccounts (default in
simple reports)
'--flat' '--flat'
show full account names, as a list (default) show accounts as a list; amounts exclude subaccounts except when
account is depth-clipped (default in multicolumn reports)
'-A --average'
show a row average column (in multicolumn mode)
'-T --row-total'
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
'--drop=N' '--drop=N'
in flat mode: omit N leading account name parts omit N leading account name parts (in flat mode)
'--no-elide' '--no-elide'
don't squash boring parent accounts (in tree mode) don't squash boring parent accounts (in tree mode)
@ -1311,6 +1334,14 @@ Total:
-------------------- --------------------
0 0
If given a period flag, renders a multi-column balance with the same
format as 'balance', with asset and liability totals as well as an
overall total if desired.
This command shows normally historical end-balance reports, but for
flexibility, also accepts '--cumulative' and '--change' to display
cumulative ending balances and changes in reporting periods.
 
File: hledger.1.info, Node: cashflow, Next: help, Prev: balancesheet, Up: COMMANDS File: hledger.1.info, Node: cashflow, Next: help, Prev: balancesheet, Up: COMMANDS
@ -1319,15 +1350,37 @@ File: hledger.1.info, Node: cashflow, Next: help, Prev: balancesheet, Up: CO
Show a cashflow statement. Alias: cf. Show a cashflow statement. Alias: cf.
'--change'
show balance change in each period (default)
'--cumulative'
show balance change accumulated across periods (in multicolumn
reports), instead of changes during periods
'-H --historical'
show historical ending balance in each period (includes postings
before report start date), instead of changes during each period
'--tree'
show accounts as a tree; amounts include subaccounts (default in
simple reports)
'--flat' '--flat'
show full account names, as a list (default) show accounts as a list; amounts exclude subaccounts except when
account is depth-clipped (default in multicolumn reports)
'-A --average'
show a row average column (in multicolumn mode)
'-T --row-total'
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 (in simple reports)
'--drop=N' '--drop=N'
in flat mode: omit N leading account name parts omit N leading account name parts (in flat mode)
'--no-elide' '--no-elide'
don't squash boring parent accounts (in tree mode) don't squash boring parent accounts (in tree mode)
@ -1354,6 +1407,13 @@ Total:
-------------------- --------------------
$-1 $-1
If given a period flag, renders a multi-column balance with the same
format as 'balance'.
This command normally shows period change reports, but for
flexibility, also accepts '--cumulative' and '--historical' to display
cumulative ending balances and historical ending balances, as well.
 
File: hledger.1.info, Node: help, Next: incomestatement, Prev: cashflow, Up: COMMANDS File: hledger.1.info, Node: help, Next: incomestatement, Prev: cashflow, Up: COMMANDS
@ -1395,15 +1455,37 @@ File: hledger.1.info, Node: incomestatement, Next: info, Prev: help, Up: COM
Show an income statement. Alias: is. Show an income statement. Alias: is.
'--change'
show balance change in each period (default)
'--cumulative'
show balance change accumulated across periods (in multicolumn
reports), instead of changes during periods
'-H --historical'
show historical ending balance in each period (includes postings
before report start date), instead of changes during each period
'--tree'
show accounts as a tree; amounts include subaccounts (default in
simple reports)
'--flat' '--flat'
show full account names, as a list (default) show accounts as a list; amounts exclude subaccounts except when
account is depth-clipped (default in multicolumn reports)
'-A --average'
show a row average column (in multicolumn mode)
'-T --row-total'
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
'--drop=N' '--drop=N'
in flat mode: omit N leading account name parts omit N leading account name parts (in flat mode)
'--no-elide' '--no-elide'
don't squash boring parent accounts (in tree mode) don't squash boring parent accounts (in tree mode)
@ -1436,6 +1518,13 @@ Total:
-------------------- --------------------
0 0
If given a period flag, renders a multi-column balance with the same
format as 'balance'.
This command normally shows period change reports, but for
flexibility, also accepts '--cumulative' and '--historical' to display
cumulative ending balances and historical ending balances, as well.
 
File: hledger.1.info, Node: info, Next: man, Prev: incomestatement, Up: COMMANDS File: hledger.1.info, Node: info, Next: man, Prev: incomestatement, Up: COMMANDS
@ -1891,7 +1980,7 @@ start making your own!
* chart:: * chart::
* check:: * check::
* check-dates:: * check-dates::
* dupes:: * check-dupes::
* equity:: * equity::
* prices:: * prices::
* print-unique:: * print-unique::
@ -1934,7 +2023,7 @@ File: hledger.1.info, Node: check, Next: check-dates, Prev: chart, Up: Exper
hledger-check.hs checks more powerful account balance assertions. hledger-check.hs checks more powerful account balance assertions.
 
File: hledger.1.info, Node: check-dates, Next: dupes, Prev: check, Up: Experimental add-ons File: hledger.1.info, Node: check-dates, Next: check-dupes, Prev: check, Up: Experimental add-ons
5.3.5 check-dates 5.3.5 check-dates
----------------- -----------------
@ -1942,15 +2031,16 @@ File: hledger.1.info, Node: check-dates, Next: dupes, Prev: check, Up: Exper
hledger-check-dates.hs checks that journal entries are ordered by date. hledger-check-dates.hs checks that journal entries are ordered by date.
 
File: hledger.1.info, Node: dupes, Next: equity, Prev: check-dates, Up: Experimental add-ons File: hledger.1.info, Node: check-dupes, Next: equity, Prev: check-dates, Up: Experimental add-ons
5.3.6 dupes 5.3.6 check-dupes
----------- -----------------
hledger-dupes.hs checks for account names sharing the same leaf name. hledger-check-dupes.hs checks for account names sharing the same leaf
name.
 
File: hledger.1.info, Node: equity, Next: prices, Prev: dupes, Up: Experimental add-ons File: hledger.1.info, Node: equity, Next: prices, Prev: check-dupes, Up: Experimental add-ons
5.3.7 equity 5.3.7 equity
------------ ------------
@ -2150,75 +2240,75 @@ Node: CSV output42494
Ref: #csv-output42613 Ref: #csv-output42613
Node: balancesheet43010 Node: balancesheet43010
Ref: #balancesheet43138 Ref: #balancesheet43138
Node: cashflow44005 Node: cashflow45057
Ref: #cashflow44122 Ref: #cashflow45174
Node: help45027 Node: help47072
Ref: #help45139 Ref: #help47184
Node: incomestatement45977 Node: incomestatement48022
Ref: #incomestatement46107 Ref: #incomestatement48152
Node: info47049 Node: info50067
Ref: #info47156 Ref: #info50174
Node: man47520 Node: man50538
Ref: #man47617 Ref: #man50635
Node: print48022 Node: print51040
Ref: #print48127 Ref: #print51145
Node: register51883 Node: register54901
Ref: #register51996 Ref: #register55014
Node: Custom register output56492 Node: Custom register output59510
Ref: #custom-register-output56623 Ref: #custom-register-output59641
Node: stats57920 Node: stats60938
Ref: #stats58026 Ref: #stats61044
Node: test58907 Node: test61925
Ref: #test58994 Ref: #test62012
Node: ADD-ON COMMANDS59362 Node: ADD-ON COMMANDS62380
Ref: #add-on-commands59498 Ref: #add-on-commands62516
Node: Official add-ons60785 Node: Official add-ons63803
Ref: #official-add-ons60927 Ref: #official-add-ons63945
Node: api61014 Node: api64032
Ref: #api61105 Ref: #api64123
Node: ui61157 Node: ui64175
Ref: #ui61258 Ref: #ui64276
Node: web61316 Node: web64334
Ref: #web61407 Ref: #web64425
Node: Third party add-ons61453 Node: Third party add-ons64471
Ref: #third-party-add-ons61630 Ref: #third-party-add-ons64648
Node: diff61765 Node: diff64783
Ref: #diff61864 Ref: #diff64882
Node: iadd61963 Node: iadd64981
Ref: #iadd62079 Ref: #iadd65097
Node: interest62162 Node: interest65180
Ref: #interest62285 Ref: #interest65303
Node: irr62380 Node: irr65398
Ref: #irr62480 Ref: #irr65498
Node: Experimental add-ons62558 Node: Experimental add-ons65576
Ref: #experimental-add-ons62712 Ref: #experimental-add-ons65730
Node: autosync63099 Node: autosync66123
Ref: #autosync63213 Ref: #autosync66237
Node: budget63452 Node: budget66476
Ref: #budget63576 Ref: #budget66600
Node: chart63642 Node: chart66666
Ref: #chart63761 Ref: #chart66785
Node: check63832 Node: check66856
Ref: #check63956 Ref: #check66980
Node: check-dates64023 Node: check-dates67047
Ref: #check-dates64159 Ref: #check-dates67189
Node: dupes64232 Node: check-dupes67262
Ref: #dupes64357 Ref: #check-dupes67405
Node: equity64428 Node: equity67482
Ref: #equity64550 Ref: #equity67610
Node: prices64669 Node: prices67729
Ref: #prices64798 Ref: #prices67858
Node: print-unique64853 Node: print-unique67913
Ref: #print-unique65002 Ref: #print-unique68062
Node: register-match65095 Node: register-match68155
Ref: #register-match65251 Ref: #register-match68311
Node: rewrite65349 Node: rewrite68409
Ref: #rewrite65470 Ref: #rewrite68530
Node: TROUBLESHOOTING65548 Node: TROUBLESHOOTING68608
Ref: #troubleshooting65667 Ref: #troubleshooting68727
Node: Run-time problems65721 Node: Run-time problems68781
Ref: #run-time-problems65864 Ref: #run-time-problems68924
Node: Known limitations67811 Node: Known limitations70871
Ref: #known-limitations67954 Ref: #known-limitations71014
 
End Tag Table End Tag Table

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

@ -1152,13 +1152,35 @@ COMMANDS
balancesheet balancesheet
Show a balance sheet. Alias: bs. Show a balance sheet. Alias: bs.
--flat show full account names, as a list (default) --change
show balance change in each period, instead of historical ending
balances
--cumulative
show balance change accumulated across periods (in multicolumn
reports), instead of historical ending balances
-H --historical
show historical ending balance in each period (includes postings
before report start date) (default)
--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)
-A --average
show a row average column (in multicolumn mode)
-T --row-total
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
--drop=N --drop=N
in flat mode: omit N leading account name parts omit N leading account name parts (in flat mode)
--no-elide --no-elide
don't squash boring parent accounts (in tree mode) don't squash boring parent accounts (in tree mode)
@ -1189,16 +1211,45 @@ COMMANDS
-------------------- --------------------
0 0
If given a period flag, renders a multi-column balance with the same
format as balance, with asset and liability totals as well as an over-
all total if desired.
This command shows normally historical end-balance reports, but for
flexibility, also accepts --cumulative and --change to display cumula-
tive ending balances and changes in reporting periods.
cashflow cashflow
Show a cashflow statement. Alias: cf. Show a cashflow statement. Alias: cf.
--flat show full account names, as a list (default) --change
show balance change in each period (default)
--cumulative
show balance change accumulated across periods (in multicolumn
reports), instead of changes during periods
-H --historical
show historical ending balance in each period (includes postings
before report start date), instead of changes during each period
--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)
-A --average
show a row average column (in multicolumn mode)
-T --row-total
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 (in simple reports)
--drop=N --drop=N
in flat mode: omit N leading account name parts omit N leading account name parts (in flat mode)
--no-elide --no-elide
don't squash boring parent accounts (in tree mode) don't squash boring parent accounts (in tree mode)
@ -1225,6 +1276,13 @@ COMMANDS
-------------------- --------------------
$-1 $-1
If given a period flag, renders a multi-column balance with the same
format as balance.
This command normally shows period change reports, but for flexibility,
also accepts --cumulative and --historical to display cumulative ending
balances and historical ending balances, as well.
help help
Show any of the hledger manuals. Show any of the hledger manuals.
@ -1256,13 +1314,34 @@ COMMANDS
incomestatement incomestatement
Show an income statement. Alias: is. Show an income statement. Alias: is.
--flat show full account names, as a list (default) --change
show balance change in each period (default)
--cumulative
show balance change accumulated across periods (in multicolumn
reports), instead of changes during periods
-H --historical
show historical ending balance in each period (includes postings
before report start date), instead of changes during each period
--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)
-A --average
show a row average column (in multicolumn mode)
-T --row-total
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
--drop=N --drop=N
in flat mode: omit N leading account name parts omit N leading account name parts (in flat mode)
--no-elide --no-elide
don't squash boring parent accounts (in tree mode) don't squash boring parent accounts (in tree mode)
@ -1295,6 +1374,13 @@ COMMANDS
-------------------- --------------------
0 0
If given a period flag, renders a multi-column balance with the same
format as balance.
This command normally shows period change reports, but for flexibility,
also accepts --cumulative and --historical to display cumulative ending
balances and historical ending balances, as well.
info info
Show any of the hledger manuals using info. Show any of the hledger manuals using info.
@ -1649,8 +1735,9 @@ ADD-ON COMMANDS
check-dates check-dates
hledger-check-dates.hs checks that journal entries are ordered by date. hledger-check-dates.hs checks that journal entries are ordered by date.
dupes check-dupes
hledger-dupes.hs checks for account names sharing the same leaf name. hledger-check-dupes.hs checks for account names sharing the same leaf
name.
equity equity
hledger-equity.hs prints balance-resetting transactions, useful for hledger-equity.hs prints balance-resetting transactions, useful for