simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-09-16 00:37:33 +03:00
Code Issues Projects Releases Wiki Activity

updated generated manuals

Browse Source
This commit is contained in:
Simon Michael 2018-01-18 11:00:37 -08:00
parent 889ba8caac
commit 46d7893446
7 changed files with 192 additions and 161 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -90,7 +90,7 @@ STACK=stack
#STACK=stack --stack-yaml=stack-ghc7.yaml
# -j16 sometimes gives "commitAndReleaseBuffer: resource vanished (Broken pipe)" but seems harmless
SHELLTESTOPTS=--execdir -- -j16 --hide-successes
SHELLTESTOPTS=--execdir -j16 --hide-successes
# make sure shelltest is a released version of shelltestrunner
# run shell tests using the executable specified in tests

9
hledger-lib/hledger_journal.5
View File

@ -1194,7 +1194,12 @@ files:
.PP
.TS
tab(@);
lw(16.5n) lw(53.5n).
lw(12.2n) lw(57.8n).
T{
Editor
T}@T{
T}
_
T{
Emacs
T}@T{
@ -1208,7 +1213,7 @@ T}
T{
Sublime Text
T}@T{
https://github.com/ledger/ledger/wiki/Using\-Sublime\-Text
https://github.com/ledger/ledger/wiki/Editing\-Ledger\-files\-with\-Sublime\-Text\-or\-RubyMine
T}
T{
Textmate

17
hledger-lib/hledger_journal.info
View File

@ -1136,12 +1136,17 @@ majority), using one of these modes is quite recommended.
These were written with Ledger in mind, but also work with hledger
files:
Emacs http://www.ledger-cli.org/3.0/doc/ledger-mode.html
Vim https://github.com/ledger/ledger/wiki/Getting-started
Sublime Text https://github.com/ledger/ledger/wiki/Using-Sublime-Text
Textmate https://github.com/ledger/ledger/wiki/Using-TextMate-2
Text Wrangler https://github.com/ledger/ledger/wiki/Editing-Ledger-files-with-TextWrangler
Visual Studio https://marketplace.visualstudio.com/items?itemName=mark-hansen.hledger-vscode
Editor
--------------------------------------------------------------------------
Emacs http://www.ledger-cli.org/3.0/doc/ledger-mode.html
Vim https://github.com/ledger/ledger/wiki/Getting-started
Sublime https://github.com/ledger/ledger/wiki/Editing-Ledger-files-with-Sublime-Text-or-RubyMine
Text
Textmate https://github.com/ledger/ledger/wiki/Using-TextMate-2
Text https://github.com/ledger/ledger/wiki/Editing-Ledger-files-with-TextWrangler
Wrangler
Visual https://marketplace.visualstudio.com/items?itemName=mark-hansen.hledger-vscode
Studio
Code


22
hledger-lib/hledger_journal.txt
View File

@ -877,18 +877,18 @@ EDITOR SUPPORT
files:
Emacs http://www.ledger-cli.org/3.0/doc/ledger-mode.html
Vim https://github.com/ledger/ledger/wiki/Getting-started
Editor
--------------------------------------------------------------------------
Emacs http://www.ledger-cli.org/3.0/doc/ledger-mode.html
Sublime Text https://github.com/ledger/ledger/wiki/Using-Sub-
lime-Text
Textmate https://github.com/ledger/ledger/wiki/Using-Text-
Mate-2
Text Wrangler https://github.com/ledger/ledger/wiki/Edit-
ing-Ledger-files-with-TextWrangler
Visual Studio https://marketplace.visualstudio.com/items?item-
Code Name=mark-hansen.hledger-vscode
Vim https://github.com/ledger/ledger/wiki/Getting-started
Sublime Text https://github.com/ledger/ledger/wiki/Edit-
ing-Ledger-files-with-Sublime-Text-or-RubyMine
Textmate https://github.com/ledger/ledger/wiki/Using-TextMate-2
Text Wran- https://github.com/ledger/ledger/wiki/Edit-
gler ing-Ledger-files-with-TextWrangler
Visual Stu- https://marketplace.visualstudio.com/items?item-
dio Code Name=mark-hansen.hledger-vscode

57
hledger/hledger.1
View File

@ -1888,8 +1888,16 @@ $\ hledger\ balance\ \-o\ FILE.csv\ \ #\ write\ CSV\ to\ FILE.csv
.fi
.SS balancesheet
.PP
Show a balance sheet.
Alias: bs.
This command displays a simple balance sheet, showing historical ending
balances of asset and liability accounts (ignoring any report begin
date).
It assumes that these accounts are under a top\-level \f[C]asset\f[] or
\f[C]liability\f[] account (case insensitive, plural forms also
allowed).
Note this report shows all account balances with normal positive sign
(like conventional financial statements, unlike balance/print/register)
(experimental).
(bs)
.TP
.B \f[C]\-\-change\f[]
show balance change in each period, instead of historical ending
@ -1956,9 +1964,7 @@ sort by amount instead of account name
.RS
.RE
.PP
This command displays a simple balance sheet.
It currently assumes that you have top\-level accounts named
\f[C]asset\f[] and \f[C]liability\f[] (plural forms also allowed.)
Example:
.IP
.nf
\f[C]
@ -1992,17 +1998,10 @@ 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.
Just like balancesheet, but also reports Equity (which it assumes is
under a top\-level \f[C]equity\f[] account).
.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.)
Example:
.IP
.nf
\f[C]
@ -2033,8 +2032,15 @@ Total:
.fi
.SS cashflow
.PP
Show a cashflow statement.
Alias: cf.
This command displays a simple cashflow statement, showing changes in
\[lq]cash\[rq] accounts.
It assumes that these accounts are under a top\-level \f[C]asset\f[]
account (case insensitive, plural forms also allowed) and do not contain
\f[C]receivable\f[] or \f[C]A/R\f[] in their name.
Note this report shows all account balances with normal positive sign
(like conventional financial statements, unlike balance/print/register)
(experimental).
(cf)
.TP
.B \f[C]\-\-change\f[]
show balance change in each period (default)
@ -2100,11 +2106,7 @@ sort by amount instead of account name
.RS
.RE
.PP
This command displays a simple cashflow statement It shows the change in
all \[lq]cash\[rq] (ie, liquid assets) accounts for the period.
It currently assumes that cash accounts are under a top\-level account
named \f[C]asset\f[] and do not contain \f[C]receivable\f[],
\f[C]:A/R\f[] or \f[C]:fixed\f[].
Example:
.IP
.nf
\f[C]
@ -2217,8 +2219,15 @@ $\ hledger\ import\ \-\-dry\ ...\ |\ hledger\ \-f\-\ print\ unknown\ \-\-ignore\
.fi
.SS incomestatement
.PP
Show an income statement.
Alias: is.
This command displays a simple income statement, showing revenues and
expenses during a period.
It assumes that these accounts are under a top\-level \f[C]revenue\f[]
or \f[C]income\f[] or \f[C]expense\f[] account (case insensitive, plural
forms also allowed).
Note this report shows all account balances with normal positive sign
(like conventional financial statements, unlike balance/print/register)
(experimental).
(is)
.TP
.B \f[C]\-\-change\f[]
show balance change in each period (default)

174
hledger/hledger.info
View File

@ -1484,7 +1484,13 @@ File: hledger.info, Node: balancesheet, Next: balancesheetequity, Prev: balan
4.5 balancesheet
================
Show a balance sheet. Alias: bs.
This command displays a simple balance sheet, showing historical ending
balances of asset and liability accounts (ignoring any report begin
date). It assumes that these accounts are under a top-level 'asset' or
'liability' account (case insensitive, plural forms also allowed). Note
this report shows all account balances with normal positive sign (like
conventional financial statements, unlike balance/print/register)
(experimental). (bs)
'--change'
@ -1528,9 +1534,7 @@ Show a balance sheet. Alias: bs.
sort by amount instead of account name
This command displays a simple balance sheet. It currently assumes
that you have top-level accounts named 'asset' and 'liability' (plural
forms also allowed.)
Example:
$ hledger balancesheet
Balance Sheet
@ -1563,15 +1567,10 @@ File: hledger.info, Node: balancesheetequity, Next: cashflow, Prev: balancesh
4.6 balancesheetequity
======================
Show a balance sheet including equity. Alias: bse.
Just like balancesheet, but also reports Equity (which it assumes is
under a top-level 'equity' account).
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.)
Example:
$ hledger balancesheetequity
Balance Sheet With Equity
@ -1603,7 +1602,12 @@ File: hledger.info, Node: cashflow, Next: check-dates, Prev: balancesheetequi
4.7 cashflow
============
Show a cashflow statement. Alias: cf.
This command displays a simple cashflow statement, showing changes in
"cash" accounts. It assumes that these accounts are under a top-level
'asset' account (case insensitive, plural forms also allowed) and do not
contain 'receivable' or 'A/R' in their name. Note this report shows all
account balances with normal positive sign (like conventional financial
statements, unlike balance/print/register) (experimental). (cf)
'--change'
@ -1646,10 +1650,7 @@ Show a cashflow statement. Alias: cf.
sort by amount instead of account name
This command displays a simple cashflow statement It shows the change
in all "cash" (ie, liquid assets) accounts for the period. It currently
assumes that cash accounts are under a top-level account named 'asset'
and do not contain 'receivable', ':A/R' or ':fixed'.
Example:
$ hledger cashflow
Cashflow Statement
@ -1769,7 +1770,12 @@ File: hledger.info, Node: incomestatement, Next: prices, Prev: import, Up: C
4.13 incomestatement
====================
Show an income statement. Alias: is.
This command displays a simple income statement, showing revenues and
expenses during a period. It assumes that these accounts are under a
top-level 'revenue' or 'income' or 'expense' account (case insensitive,
plural forms also allowed). Note this report shows all account balances
with normal positive sign (like conventional financial statements,
unlike balance/print/register) (experimental). (is)
'--change'
@ -2436,71 +2442,71 @@ Node: CSV output50340
Ref: #csv-output50457
Node: balancesheet50854
Ref: #balancesheet50990
Node: balancesheetequity52958
Ref: #balancesheetequity53107
Node: cashflow53896
Ref: #cashflow54024
Node: check-dates55936
Ref: #check-dates56063
Node: check-dupes56180
Ref: #check-dupes56304
Node: close56441
Ref: #close56548
Node: help56878
Ref: #help56978
Node: import58052
Ref: #import58166
Node: incomestatement58896
Ref: #incomestatement59030
Node: prices60983
Ref: #prices61098
Node: print61141
Ref: #print61251
Node: print-unique66136
Ref: #print-unique66262
Node: register66330
Ref: #register66457
Node: Custom register output70958
Ref: #custom-register-output71087
Node: register-match72384
Ref: #register-match72518
Node: rewrite72701
Ref: #rewrite72818
Node: stats72887
Ref: #stats72990
Node: tags73872
Ref: #tags73970
Node: test74206
Ref: #test74290
Node: ADD-ON COMMANDS74658
Ref: #add-on-commands74768
Node: Official add-ons76055
Ref: #official-add-ons76195
Node: api76282
Ref: #api76371
Node: ui76423
Ref: #ui76522
Node: web76580
Ref: #web76669
Node: Third party add-ons76715
Ref: #third-party-add-ons76890
Node: diff77025
Ref: #diff77122
Node: iadd77221
Ref: #iadd77335
Node: interest77418
Ref: #interest77539
Node: irr77634
Ref: #irr77732
Node: Experimental add-ons77810
Ref: #experimental-add-ons77962
Node: autosync78253
Ref: #autosync78365
Node: budget78604
Ref: #budget78726
Node: chart78792
Ref: #chart78909
Node: check78980
Ref: #check79082
Node: balancesheetequity53217
Ref: #balancesheetequity53366
Node: cashflow53903
Ref: #cashflow54031
Node: check-dates56070
Ref: #check-dates56197
Node: check-dupes56314
Ref: #check-dupes56438
Node: close56575
Ref: #close56682
Node: help57012
Ref: #help57112
Node: import58186
Ref: #import58300
Node: incomestatement59030
Ref: #incomestatement59164
Node: prices61484
Ref: #prices61599
Node: print61642
Ref: #print61752
Node: print-unique66637
Ref: #print-unique66763
Node: register66831
Ref: #register66958
Node: Custom register output71459
Ref: #custom-register-output71588
Node: register-match72885
Ref: #register-match73019
Node: rewrite73202
Ref: #rewrite73319
Node: stats73388
Ref: #stats73491
Node: tags74373
Ref: #tags74471
Node: test74707
Ref: #test74791
Node: ADD-ON COMMANDS75159
Ref: #add-on-commands75269
Node: Official add-ons76556
Ref: #official-add-ons76696
Node: api76783
Ref: #api76872
Node: ui76924
Ref: #ui77023
Node: web77081
Ref: #web77170
Node: Third party add-ons77216
Ref: #third-party-add-ons77391
Node: diff77526
Ref: #diff77623
Node: iadd77722
Ref: #iadd77836
Node: interest77919
Ref: #interest78040
Node: irr78135
Ref: #irr78233
Node: Experimental add-ons78311
Ref: #experimental-add-ons78463
Node: autosync78754
Ref: #autosync78866
Node: budget79105
Ref: #budget79227
Node: chart79293
Ref: #chart79410
Node: check79481
Ref: #check79583

End Tag Table

72
hledger/hledger.txt
View File

@ -1342,7 +1342,13 @@ COMMANDS
$ hledger balance -o FILE.csv # write CSV to FILE.csv
balancesheet
Show a balance sheet. Alias: bs.
This command displays a simple balance sheet, showing historical ending
balances of asset and liability accounts (ignoring any report begin
date). It assumes that these accounts are under a top-level asset or
liability account (case insensitive, plural forms also allowed). Note
this report shows all account balances with normal positive sign (like
conventional financial statements, unlike balance/print/register)
(experimental). (bs)
--change
show balance change in each period, instead of historical ending
@ -1383,9 +1389,7 @@ COMMANDS
--sort-amount
sort by amount instead of account name
This command displays a simple balance sheet. It currently assumes
that you have top-level accounts named asset and liability (plural
forms also allowed.)
Example:
$ hledger balancesheet
Balance Sheet
@ -1413,15 +1417,10 @@ COMMANDS
a balance sheet; note this means it ignores report begin dates.
balancesheetequity
Show a balance sheet including equity. Alias: bse.
Just like balancesheet, but also reports Equity (which it assumes is
under a top-level equity account).
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.)
Example:
$ hledger balancesheetequity
Balance Sheet With Equity
@ -1448,7 +1447,12 @@ COMMANDS
0
cashflow
Show a cashflow statement. Alias: cf.
This command displays a simple cashflow statement, showing changes in
"cash" accounts. It assumes that these accounts are under a top-level
asset account (case insensitive, plural forms also allowed) and do not
contain receivable or A/R in their name. Note this report shows all
account balances with normal positive sign (like conventional financial
statements, unlike balance/print/register) (experimental). (cf)
--change
show balance change in each period (default)
@ -1488,10 +1492,7 @@ COMMANDS
--sort-amount
sort by amount instead of account name
This command displays a simple cashflow statement It shows the change
in all "cash" (ie, liquid assets) accounts for the period. It cur-
rently assumes that cash accounts are under a top-level account named
asset and do not contain receivable, :A/R or :fixed.
Example:
$ hledger cashflow
Cashflow Statement
@ -1508,35 +1509,35 @@ COMMANDS
$-1
With a reporting interval, multiple columns will be shown, one for each
report period. Normally cashflow shows changes in assets per period,
though as with multicolumn balance reports you can alter the report
report period. Normally cashflow shows changes in assets per period,
though as with multicolumn balance reports you can alter the report
mode with --change/--cumulative/--historical.
check-dates
Check that transactions are sorted by increasing date. With a query,
Check that transactions are sorted by increasing date. With a query,
only matched transactions' dates are checked.
check-dupes
Report account names having the same leaf but different prefixes. An
Report account names having the same leaf but different prefixes. An
example: http://stefanorodighiero.net/software/hledger-dupes.html
close
Print closing/opening transactions that bring some or all account bal-
ances to zero and back. Can be useful for bringing asset/liability
Print closing/opening transactions that bring some or all account bal-
ances to zero and back. Can be useful for bringing asset/liability
balances across file boundaries, or for closing out income/expenses for
a period. This was formerly called "equity", as in Ledger, and that
a period. This was formerly called "equity", as in Ledger, and that
alias is also accepted. See close -help for more.
help
Show any of the hledger manuals.
The help command displays any of the main hledger manuals, in one of
several ways. Run it with no argument to list the manuals, or provide
The help command displays any of the main hledger manuals, in one of
several ways. Run it with no argument to list the manuals, or provide
a full or partial manual name to select one.
hledger manuals are available in several formats. hledger help will
use the first of these display methods that it finds: info, man,
$PAGER, less, stdout (or when non-interactive, just stdout). You can
hledger manuals are available in several formats. hledger help will
use the first of these display methods that it finds: info, man,
$PAGER, less, stdout (or when non-interactive, just stdout). You can
force a particular viewer with the --info, --man, --pager, --cat flags.
$ hledger help
@ -1560,7 +1561,7 @@ COMMANDS
...
import
Read new transactions added to each FILE since last run, and add them
Read new transactions added to each FILE since last run, and add them
to the main journal file.
--dry-run
@ -1570,17 +1571,22 @@ COMMANDS
each one. So eg to add new transactions from all CSV files to the main
journal, it's just: hledger import *.csv
New transactions are detected in the same way as print -new: by assum-
New transactions are detected in the same way as print -new: by assum-
ing transactions are always added to the input files in increasing date
order, and by saving .latest.FILE state files.
The -dry-run output is in journal format, so you can filter it, eg to
The -dry-run output is in journal format, so you can filter it, eg to
see only uncategorised transactions:
$ hledger import --dry ... | hledger -f- print unknown --ignore-assertions
incomestatement
Show an income statement. Alias: is.
This command displays a simple income statement, showing revenues and
expenses during a period. It assumes that these accounts are under a
top-level revenue or income or expense account (case insensitive, plu-
ral forms also allowed). Note this report shows all account balances
with normal positive sign (like conventional financial statements,
unlike balance/print/register) (experimental). (is)
--change
show balance change in each period (default)