bse: update embedded manuals

This commit is contained in:
Simon Michael 2017-08-28 17:29:24 -07:00
parent d7f2d5eac3
commit ddb67c0c0b
3 changed files with 216 additions and 97 deletions

View File

@ -1751,6 +1751,47 @@ As with multicolumn balance reports, you can alter the report mode with
Normally balancesheet shows historical ending balances, which is what
you need for a balance sheet; note this means it ignores report begin
dates.
.SS balancesheetequity
.PP
Show a balance sheet including equity.
Alias: bse.
.PP
Other than showing the equity accounts, this command is exactly the same
as the command balancesheet.
Please refer to it for the available options.
.PP
This command displays a balancesheet.
It currently assumes that you have top\-level accounts named
\f[C]asset\f[], \f[C]liability\f[] and \f[C]equity\f[] (plural forms
also allowed.)
.IP
.nf
\f[C]
$\ hledger\ balancesheetequity
Balance\ Sheet\ With\ Equity
Assets:
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ $\-2\ \ assets
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ $1\ \ \ \ bank:saving
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ $\-3\ \ \ \ cash
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ $\-2
Liabilities:
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ $1\ \ liabilities:debts
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ $1
Equity:
\ \ \ \ \ \ \ \ \ \ $1\ \ equity:owner
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\ \ \ \ \ \ \ \ \ \ $1
Total:
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ 0
\f[]
.fi
.SS cashflow
.PP
Show a cashflow statement.

View File

@ -784,6 +784,7 @@ displayed in the command list ('hledger is').
* add::
* balance::
* balancesheet::
* balancesheetequity::
* cashflow::
* help::
* incomestatement::
@ -1287,7 +1288,7 @@ $ hledger balance -O csv # write CSV to stdout
$ hledger balance -o FILE.csv # write CSV to FILE.csv

File: hledger.1.info, Node: balancesheet, Next: cashflow, Prev: balance, Up: COMMANDS
File: hledger.1.info, Node: balancesheet, Next: balancesheetequity, Prev: balance, Up: COMMANDS
4.5 balancesheet
================
@ -1363,9 +1364,49 @@ balancesheet shows historical ending balances, which is what you need
for a balance sheet; note this means it ignores report begin dates.

File: hledger.1.info, Node: cashflow, Next: help, Prev: balancesheet, Up: COMMANDS
File: hledger.1.info, Node: balancesheetequity, Next: cashflow, Prev: balancesheet, Up: COMMANDS
4.6 cashflow
4.6 balancesheetequity
======================
Show a balance sheet including equity. Alias: bse.
Other than showing the equity accounts, this command is exactly the
same as the command balancesheet. Please refer to it for the available
options.
This command displays a balancesheet. It currently assumes that you
have top-level accounts named 'asset', 'liability' and 'equity' (plural
forms also allowed.)
$ hledger balancesheetequity
Balance Sheet With Equity
Assets:
$-2 assets
$1 bank:saving
$-3 cash
--------------------
$-2
Liabilities:
$1 liabilities:debts
--------------------
$1
Equity:
$1 equity:owner
--------------------
$1
Total:
--------------------
0

File: hledger.1.info, Node: cashflow, Next: help, Prev: balancesheetequity, Up: COMMANDS
4.7 cashflow
============
Show a cashflow statement. Alias: cf.
@ -1435,7 +1476,7 @@ report mode with '--change'/'--cumulative'/'--historical'.

File: hledger.1.info, Node: help, Next: incomestatement, Prev: cashflow, Up: COMMANDS
4.7 help
4.8 help
========
Show any of the hledger manuals.
@ -1472,7 +1513,7 @@ DESCRIPTION

File: hledger.1.info, Node: incomestatement, Next: print, Prev: help, Up: COMMANDS
4.8 incomestatement
4.9 incomestatement
===================
Show an income statement. Alias: is.
@ -1548,8 +1589,8 @@ report mode with '--change'/'--cumulative'/'--historical'.

File: hledger.1.info, Node: print, Next: register, Prev: incomestatement, Up: COMMANDS
4.9 print
=========
4.10 print
==========
Show transactions from the journal.
@ -1642,7 +1683,7 @@ $ hledger print -Ocsv

File: hledger.1.info, Node: register, Next: stats, Prev: print, Up: COMMANDS
4.10 register
4.11 register
=============
Show postings and their running total. Alias: reg.
@ -1747,7 +1788,7 @@ length and comparable to the others in the report.

File: hledger.1.info, Node: Custom register output, Up: register
4.10.1 Custom register output
4.11.1 Custom register output
-----------------------------
register uses the full terminal width by default, except on windows.
@ -1779,7 +1820,7 @@ output.

File: hledger.1.info, Node: stats, Next: test, Prev: register, Up: COMMANDS
4.11 stats
4.12 stats
==========
Show some journal statistics.
@ -1811,7 +1852,7 @@ output destination.

File: hledger.1.info, Node: test, Prev: stats, Up: COMMANDS
4.12 test
4.13 test
=========
Run built-in unit tests.
@ -2118,91 +2159,93 @@ Node: QUERIES21585
Ref: #queries21689
Node: COMMANDS25354
Ref: #commands25468
Node: accounts26124
Ref: #accounts26224
Node: activity27206
Ref: #activity27318
Node: add27677
Ref: #add27778
Node: balance30436
Ref: #balance30549
Node: Flat mode33564
Ref: #flat-mode33691
Node: Depth limited balance reports34111
Ref: #depth-limited-balance-reports34314
Node: Multicolumn balance reports34734
Ref: #multicolumn-balance-reports34945
Node: Custom balance output39593
Ref: #custom-balance-output39777
Node: Colour support41870
Ref: #colour-support42031
Node: Output destination42204
Ref: #output-destination42362
Node: CSV output42632
Ref: #csv-output42751
Node: balancesheet43148
Ref: #balancesheet43276
Node: cashflow45183
Ref: #cashflow45300
Node: help47151
Ref: #help47263
Node: incomestatement48337
Ref: #incomestatement48468
Node: print50360
Ref: #print50475
Node: register54231
Ref: #register54344
Node: Custom register output58840
Ref: #custom-register-output58971
Node: stats60268
Ref: #stats60374
Node: test61255
Ref: #test61342
Node: ADD-ON COMMANDS61710
Ref: #add-on-commands61822
Node: Official add-ons63109
Ref: #official-add-ons63251
Node: api63338
Ref: #api63429
Node: ui63481
Ref: #ui63582
Node: web63640
Ref: #web63731
Node: Third party add-ons63777
Ref: #third-party-add-ons63954
Node: diff64089
Ref: #diff64188
Node: iadd64287
Ref: #iadd64403
Node: interest64486
Ref: #interest64609
Node: irr64704
Ref: #irr64804
Node: Experimental add-ons64882
Ref: #experimental-add-ons65036
Node: autosync65438
Ref: #autosync65552
Node: budget65791
Ref: #budget65915
Node: chart65981
Ref: #chart66100
Node: check66171
Ref: #check66295
Node: check-dates66362
Ref: #check-dates66504
Node: check-dupes66577
Ref: #check-dupes66720
Node: equity66797
Ref: #equity66925
Node: prices67044
Ref: #prices67173
Node: print-unique67228
Ref: #print-unique67377
Node: register-match67470
Ref: #register-match67626
Node: rewrite67724
Ref: #rewrite67858
Node: tags67936
Ref: #tags68041
Node: accounts26147
Ref: #accounts26247
Node: activity27229
Ref: #activity27341
Node: add27700
Ref: #add27801
Node: balance30459
Ref: #balance30572
Node: Flat mode33587
Ref: #flat-mode33714
Node: Depth limited balance reports34134
Ref: #depth-limited-balance-reports34337
Node: Multicolumn balance reports34757
Ref: #multicolumn-balance-reports34968
Node: Custom balance output39616
Ref: #custom-balance-output39800
Node: Colour support41893
Ref: #colour-support42054
Node: Output destination42227
Ref: #output-destination42385
Node: CSV output42655
Ref: #csv-output42774
Node: balancesheet43171
Ref: #balancesheet43309
Node: balancesheetequity45216
Ref: #balancesheetequity45367
Node: cashflow46156
Ref: #cashflow46279
Node: help48130
Ref: #help48242
Node: incomestatement49316
Ref: #incomestatement49447
Node: print51339
Ref: #print51456
Node: register55212
Ref: #register55325
Node: Custom register output59821
Ref: #custom-register-output59952
Node: stats61249
Ref: #stats61355
Node: test62236
Ref: #test62323
Node: ADD-ON COMMANDS62691
Ref: #add-on-commands62803
Node: Official add-ons64090
Ref: #official-add-ons64232
Node: api64319
Ref: #api64410
Node: ui64462
Ref: #ui64563
Node: web64621
Ref: #web64712
Node: Third party add-ons64758
Ref: #third-party-add-ons64935
Node: diff65070
Ref: #diff65169
Node: iadd65268
Ref: #iadd65384
Node: interest65467
Ref: #interest65590
Node: irr65685
Ref: #irr65785
Node: Experimental add-ons65863
Ref: #experimental-add-ons66017
Node: autosync66419
Ref: #autosync66533
Node: budget66772
Ref: #budget66896
Node: chart66962
Ref: #chart67081
Node: check67152
Ref: #check67276
Node: check-dates67343
Ref: #check-dates67485
Node: check-dupes67558
Ref: #check-dupes67701
Node: equity67778
Ref: #equity67906
Node: prices68025
Ref: #prices68154
Node: print-unique68209
Ref: #print-unique68358
Node: register-match68451
Ref: #register-match68607
Node: rewrite68705
Ref: #rewrite68839
Node: tags68917
Ref: #tags69022

End Tag Table

View File

@ -1222,6 +1222,41 @@ COMMANDS
ancesheet shows historical ending balances, which is what you need for
a balance sheet; note this means it ignores report begin dates.
balancesheetequity
Show a balance sheet including equity. Alias: bse.
Other than showing the equity accounts, this command is exactly the
same as the command balancesheet. Please refer to it for the available
options.
This command displays a balancesheet. It currently assumes that you
have top-level accounts named asset, liability and equity (plural forms
also allowed.)
$ hledger balancesheetequity
Balance Sheet With Equity
Assets:
$-2 assets
$1 bank:saving
$-3 cash
--------------------
$-2
Liabilities:
$1 liabilities:debts
--------------------
$1
Equity:
$1 equity:owner
--------------------
$1
Total:
--------------------
0
cashflow
Show a cashflow statement. Alias: cf.