slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

cli: docs: update manuals

Browse Source
This commit is contained in:
Simon Michael 2017-09-14 06:23:11 -07:00
parent 076424dedd
commit a218ce12ad
3 changed files with 317 additions and 315 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
hledger/doc/hledger.1
View File

@ -1086,9 +1086,9 @@ will also be listed as subcommands.
.PP
Run a subcommand by writing its name as first argument (eg
\f[C]hledger\ incomestatement\f[]).
You can also write any unambiguous prefix of a command name
(\f[C]hledger\ inc\f[]), or one of the standard short aliases displayed
in the command list (\f[C]hledger\ is\f[]).
You can also write one of the standard short aliases displayed in
parentheses in the command list (\f[C]hledger\ b\f[]), or any any
unambiguous prefix of a command name (\f[C]hledger\ inc\f[]).
.PP
Here are all the builtin commands in alphabetical order.
See also \f[C]hledger\f[] for a more organised command list, and
@ -1096,6 +1096,7 @@ See also \f[C]hledger\f[] for a more organised command list, and
.SS accounts
.PP
Show account names.
Alias: a.
.TP
.B \f[C]\-\-tree\f[]
show short account names, as a tree
@ -1272,7 +1273,7 @@ Date\ [2015/05/22]:\ <CTRL\-D>\ $
.SS balance
.PP
Show accounts and their balances.
Alias: bal.
Aliases: b, bal.
.TP
.B \f[C]\-\-change\f[]
show balance change in each period (default)
@ -1899,6 +1900,15 @@ multicolumn balance reports you can alter the report mode with
.PP
Check that transactions are sorted by increasing date.
With a query, only matched transactions\[aq] dates are checked.
.SS check\-dupes
.PP
Report account names having the same leaf but different prefixes.
An example: http://stefanorodighiero.net/software/hledger\-dupes.html
.SS equity
.PP
Print closing/opening transactions that bring some or all account
balances to zero and back.
Can be useful for bringing account balances across file boundaries.
.SS help
.PP
Show any of the hledger manuals.
@ -2040,9 +2050,13 @@ report period.
Normally incomestatement shows revenues/expenses per period, though as
with multicolumn balance reports you can alter the report mode with
\f[C]\-\-change\f[]/\f[C]\-\-cumulative\f[]/\f[C]\-\-historical\f[].
.SS prices
.PP
Print all market prices from the journal.
.SS print
.PP
Show transactions from the journal.
Aliases: p, txns.
.TP
.B \f[C]\-x\ \ \ \ \ \-\-explicit\f[]
show all amounts explicitly
@ -2149,10 +2163,13 @@ The numeric amount is repeated in either the "credit" or "debit" column,
for convenience.
(Those names are not accurate in the accounting sense; it just puts
negative amounts under credit and zero or greater amounts under debit.)
.SS print\-unique
.PP
Print transactions which do not reuse an already\-seen description.
.SS register
.PP
Show postings and their running total.
Alias: reg.
Aliases: r, reg.
.TP
.B \f[C]\-\-cumulative\f[]
show running total from report start date (default)
@ -2325,6 +2342,14 @@ $\ hledger\ reg\ \-w\ $COLUMNS,40\ \ \ \ \ \ #\ use\ terminal\ width,\ and\ set\
The register command also supports the \f[C]\-o/\-\-output\-file\f[] and
\f[C]\-O/\-\-output\-format\f[] options for controlling output
destination and CSV output.
.SS register\-match
.PP
Print the one posting whose transaction description is closest to DESC,
in the style of the register command.
Helps ledger\-autosync detect already\-seen transactions when importing.
.SS rewrite
.PP
Print all transactions, adding custom postings to the matched ones.
.SS stats
.PP
Show some journal statistics.
@ -2357,6 +2382,9 @@ With a reporting interval, it shows a report for each report period.
.PP
The stats command also supports \f[C]\-o/\-\-output\-file\f[] for
controlling output destination.
.SS tags
.PP
List all the tag names in use.
.SS test
.PP
Run built\-in unit tests.
@ -2460,32 +2488,6 @@ hledger\-chart.hs is an old pie chart generator, in need of some love.
.SS check
.PP
hledger\-check.hs checks more powerful account balance assertions.
.SS check\-dupes
.PP
hledger\-check\-dupes.hs checks for account names sharing the same leaf
name.
.SS equity
.PP
hledger\-equity.hs prints balance\-resetting transactions, useful for
bringing account balances across file boundaries.
.SS prices
.PP
hledger\-prices.hs prints all prices from the journal.
.SS print\-unique
.PP
hledger\-print\-unique.hs prints transactions which do not reuse an
already\-seen description.
.SS register\-match
.PP
hledger\-register\-match.hs helps ledger\-autosync detect already\-seen
transactions when importing.
.SS rewrite
.PP
hledger\-rewrite.hs Adds one or more custom postings to matched
transactions.
.SS tags
.PP
hledger\-tags.hs Lists tag names in use.
.SH ENVIRONMENT
.PP
\f[B]COLUMNS\f[] The screen width used by the register command.

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

@ -780,9 +780,9 @@ programs or scripts named 'hledger-NAME' in your PATH, these will also
be listed as subcommands.
Run a subcommand by writing its name as first argument (eg 'hledger
incomestatement'). You can also write any unambiguous prefix of a
command name ('hledger inc'), or one of the standard short aliases
displayed in the command list ('hledger is').
incomestatement'). You can also write one of the standard short aliases
displayed in parentheses in the command list ('hledger b'), or any any
unambiguous prefix of a command name ('hledger inc').
Here are all the builtin commands in alphabetical order. See also
'hledger' for a more organised command list, and 'hledger CMD -h' for
@ -797,11 +797,18 @@ detailed command help.
* balancesheetequity::
* cashflow::
* check-dates::
* check-dupes::
* equity::
* help::
* incomestatement::
* prices::
* print::
* print-unique::
* register::
* register-match::
* rewrite::
* stats::
* tags::
* test::

@ -810,7 +817,7 @@ File: hledger.1.info, Node: accounts, Next: activity, Up: COMMANDS
4.1 accounts
============
Show account names.
Show account names. Alias: a.
'--tree'
@ -963,7 +970,7 @@ File: hledger.1.info, Node: balance, Next: balancesheet, Prev: add, Up: COMM
4.4 balance
===========
Show accounts and their balances. Alias: bal.
Show accounts and their balances. Aliases: b, bal.
'--change'
@ -1485,7 +1492,7 @@ period, though as with multicolumn balance reports you can alter the
report mode with '--change'/'--cumulative'/'--historical'.

File: hledger.1.info, Node: check-dates, Next: help, Prev: cashflow, Up: COMMANDS
File: hledger.1.info, Node: check-dates, Next: check-dupes, Prev: cashflow, Up: COMMANDS
4.8 check-dates
===============
@ -1494,10 +1501,29 @@ Check that transactions are sorted by increasing date. With a query,
only matched transactions' dates are checked.

File: hledger.1.info, Node: help, Next: incomestatement, Prev: check-dates, Up: COMMANDS
File: hledger.1.info, Node: check-dupes, Next: equity, Prev: check-dates, Up: COMMANDS
4.9 help
========
4.9 check-dupes
===============
Report account names having the same leaf but different prefixes. An
example: http://stefanorodighiero.net/software/hledger-dupes.html

File: hledger.1.info, Node: equity, Next: help, Prev: check-dupes, Up: COMMANDS
4.10 equity
===========
Print closing/opening transactions that bring some or all account
balances to zero and back. Can be useful for bringing account balances
across file boundaries.

File: hledger.1.info, Node: help, Next: incomestatement, Prev: equity, Up: COMMANDS
4.11 help
=========
Show any of the hledger manuals.
@ -1531,9 +1557,9 @@ DESCRIPTION
...

File: hledger.1.info, Node: incomestatement, Next: print, Prev: help, Up: COMMANDS
File: hledger.1.info, Node: incomestatement, Next: prices, Prev: help, Up: COMMANDS
4.10 incomestatement
4.12 incomestatement
====================
Show an income statement. Alias: is.
@ -1607,12 +1633,20 @@ per period, though as with multicolumn balance reports you can alter the
report mode with '--change'/'--cumulative'/'--historical'.

File: hledger.1.info, Node: print, Next: register, Prev: incomestatement, Up: COMMANDS
File: hledger.1.info, Node: prices, Next: print, Prev: incomestatement, Up: COMMANDS
4.11 print
4.13 prices
===========
Print all market prices from the journal.

File: hledger.1.info, Node: print, Next: print-unique, Prev: prices, Up: COMMANDS
4.14 print
==========
Show transactions from the journal.
Show transactions from the journal. Aliases: p, txns.
'-x --explicit'
@ -1701,12 +1735,20 @@ $ hledger print -Ocsv
zero or greater amounts under debit.)

File: hledger.1.info, Node: register, Next: stats, Prev: print, Up: COMMANDS
File: hledger.1.info, Node: print-unique, Next: register, Prev: print, Up: COMMANDS
4.12 register
4.15 print-unique
=================
Print transactions which do not reuse an already-seen description.

File: hledger.1.info, Node: register, Next: register-match, Prev: print-unique, Up: COMMANDS
4.16 register
=============
Show postings and their running total. Alias: reg.
Show postings and their running total. Aliases: r, reg.
'--cumulative'
@ -1808,7 +1850,7 @@ length and comparable to the others in the report.

File: hledger.1.info, Node: Custom register output, Up: register
4.12.1 Custom register output
4.16.1 Custom register output
-----------------------------
register uses the full terminal width by default, except on windows.
@ -1838,9 +1880,27 @@ $ hledger reg -w $COLUMNS,40 # use terminal width, and set description widt
output.

File: hledger.1.info, Node: stats, Next: test, Prev: register, Up: COMMANDS
File: hledger.1.info, Node: register-match, Next: rewrite, Prev: register, Up: COMMANDS
4.13 stats
4.17 register-match
===================
Print the one posting whose transaction description is closest to DESC,
in the style of the register command. Helps ledger-autosync detect
already-seen transactions when importing.

File: hledger.1.info, Node: rewrite, Next: stats, Prev: register-match, Up: COMMANDS
4.18 rewrite
============
Print all transactions, adding custom postings to the matched ones.

File: hledger.1.info, Node: stats, Next: tags, Prev: rewrite, Up: COMMANDS
4.19 stats
==========
Show some journal statistics.
@ -1870,9 +1930,17 @@ for each report period.
output destination.

File: hledger.1.info, Node: test, Prev: stats, Up: COMMANDS
File: hledger.1.info, Node: tags, Next: test, Prev: stats, Up: COMMANDS
4.14 test
4.20 tags
=========
List all the tag names in use.

File: hledger.1.info, Node: test, Prev: tags, Up: COMMANDS
4.21 test
=========
Run built-in unit tests.
@ -2027,13 +2095,6 @@ start making your own!
* budget::
* chart::
* check::
* check-dupes::
* equity::
* prices::
* print-unique::
* register-match::
* rewrite::
* tags::

File: hledger.1.info, Node: autosync, Next: budget, Up: Experimental add-ons
@ -2063,74 +2124,13 @@ File: hledger.1.info, Node: chart, Next: check, Prev: budget, Up: Experiment
hledger-chart.hs is an old pie chart generator, in need of some love.

File: hledger.1.info, Node: check, Next: check-dupes, Prev: chart, Up: Experimental add-ons
File: hledger.1.info, Node: check, Prev: chart, Up: Experimental add-ons
5.3.4 check
-----------
hledger-check.hs checks more powerful account balance assertions.

File: hledger.1.info, Node: check-dupes, Next: equity, Prev: check, Up: Experimental add-ons
5.3.5 check-dupes
-----------------
hledger-check-dupes.hs checks for account names sharing the same leaf
name.

File: hledger.1.info, Node: equity, Next: prices, Prev: check-dupes, Up: Experimental add-ons
5.3.6 equity
------------
hledger-equity.hs prints balance-resetting transactions, useful for
bringing account balances across file boundaries.

File: hledger.1.info, Node: prices, Next: print-unique, Prev: equity, Up: Experimental add-ons
5.3.7 prices
------------
hledger-prices.hs prints all prices from the journal.

File: hledger.1.info, Node: print-unique, Next: register-match, Prev: prices, Up: Experimental add-ons
5.3.8 print-unique
------------------
hledger-print-unique.hs prints transactions which do not reuse an
already-seen description.

File: hledger.1.info, Node: register-match, Next: rewrite, Prev: print-unique, Up: Experimental add-ons
5.3.9 register-match
--------------------
hledger-register-match.hs helps ledger-autosync detect already-seen
transactions when importing.

File: hledger.1.info, Node: rewrite, Next: tags, Prev: register-match, Up: Experimental add-ons
5.3.10 rewrite
--------------
hledger-rewrite.hs Adds one or more custom postings to matched
transactions.

File: hledger.1.info, Node: tags, Prev: rewrite, Up: Experimental add-ons
5.3.11 tags
-----------
hledger-tags.hs Lists tag names in use.

Tag Table:
Node: Top70
@ -2170,93 +2170,93 @@ Node: QUERIES21498
Ref: #queries21602
Node: COMMANDS25569
Ref: #commands25683
Node: accounts26542
Ref: #accounts26642
Node: activity27624
Ref: #activity27736
Node: add28095
Ref: #add28196
Node: balance30854
Ref: #balance30967
Node: Flat mode33982
Ref: #flat-mode34109
Node: Depth limited balance reports34529
Ref: #depth-limited-balance-reports34732
Node: Multicolumn balance reports35152
Ref: #multicolumn-balance-reports35363
Node: Custom balance output40011
Ref: #custom-balance-output40195
Node: Colour support42288
Ref: #colour-support42449
Node: Output destination42622
Ref: #output-destination42780
Node: CSV output43050
Ref: #csv-output43169
Node: balancesheet43566
Ref: #balancesheet43704
Node: balancesheetequity45611
Ref: #balancesheetequity45762
Node: cashflow46551
Ref: #cashflow46681
Node: check-dates48532
Ref: #check-dates48654
Node: help48771
Ref: #help48886
Node: incomestatement49960
Ref: #incomestatement50093
Node: print51985
Ref: #print52102
Node: register55858
Ref: #register55971
Node: Custom register output60467
Ref: #custom-register-output60598
Node: stats61895
Ref: #stats62001
Node: test62882
Ref: #test62969
Node: ADD-ON COMMANDS63337
Ref: #add-on-commands63449
Node: Official add-ons64736
Ref: #official-add-ons64878
Node: api64965
Ref: #api65056
Node: ui65108
Ref: #ui65209
Node: web65267
Ref: #web65358
Node: Third party add-ons65404
Ref: #third-party-add-ons65581
Node: diff65716
Ref: #diff65815
Node: iadd65914
Ref: #iadd66030
Node: interest66113
Ref: #interest66236
Node: irr66331
Ref: #irr66431
Node: Experimental add-ons66509
Ref: #experimental-add-ons66663
Node: autosync67049
Ref: #autosync67163
Node: budget67402
Ref: #budget67526
Node: chart67592
Ref: #chart67711
Node: check67782
Ref: #check67906
Node: check-dupes67973
Ref: #check-dupes68110
Node: equity68187
Ref: #equity68315
Node: prices68434
Ref: #prices68563
Node: print-unique68618
Ref: #print-unique68767
Node: register-match68860
Ref: #register-match69014
Node: rewrite69112
Ref: #rewrite69246
Node: tags69324
Ref: #tags69429
Node: accounts26655
Ref: #accounts26755
Node: activity27748
Ref: #activity27860
Node: add28219
Ref: #add28320
Node: balance30978
Ref: #balance31091
Node: Flat mode34111
Ref: #flat-mode34238
Node: Depth limited balance reports34658
Ref: #depth-limited-balance-reports34861
Node: Multicolumn balance reports35281
Ref: #multicolumn-balance-reports35492
Node: Custom balance output40140
Ref: #custom-balance-output40324
Node: Colour support42417
Ref: #colour-support42578
Node: Output destination42751
Ref: #output-destination42909
Node: CSV output43179
Ref: #csv-output43298
Node: balancesheet43695
Ref: #balancesheet43833
Node: balancesheetequity45740
Ref: #balancesheetequity45891
Node: cashflow46680
Ref: #cashflow46810
Node: check-dates48661
Ref: #check-dates48790
Node: check-dupes48907
Ref: #check-dupes49034
Node: equity49171
Ref: #equity49283
Node: help49446
Ref: #help49558
Node: incomestatement50632
Ref: #incomestatement50766
Node: prices52658
Ref: #prices52775
Node: print52818
Ref: #print52930
Node: print-unique56705
Ref: #print-unique56833
Node: register56901
Ref: #register57030
Node: Custom register output61531
Ref: #custom-register-output61662
Node: register-match62959
Ref: #register-match63095
Node: rewrite63278
Ref: #rewrite63397
Node: stats63466
Ref: #stats63571
Node: tags64452
Ref: #tags64552
Node: test64584
Ref: #test64670
Node: ADD-ON COMMANDS65038
Ref: #add-on-commands65150
Node: Official add-ons66437
Ref: #official-add-ons66579
Node: api66666
Ref: #api66757
Node: ui66809
Ref: #ui66910
Node: web66968
Ref: #web67059
Node: Third party add-ons67105
Ref: #third-party-add-ons67282
Node: diff67417
Ref: #diff67516
Node: iadd67615
Ref: #iadd67731
Node: interest67814
Ref: #interest67937
Node: irr68032
Ref: #irr68132
Node: Experimental add-ons68210
Ref: #experimental-add-ons68364
Node: autosync68655
Ref: #autosync68769
Node: budget69008
Ref: #budget69132
Node: chart69198
Ref: #chart69317
Node: check69388
Ref: #check69492

End Tag Table

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

@ -717,16 +717,16 @@ COMMANDS
subcommands.
Run a subcommand by writing its name as first argument (eg
hledger incomestatement). You can also write any unambiguous prefix of
a command name (hledger inc), or one of the standard short aliases dis-
played in the command list (hledger is).
hledger incomestatement). You can also write one of the standard short
aliases displayed in parentheses in the command list (hledger b), or
any any unambiguous prefix of a command name (hledger inc).
Here are all the builtin commands in alphabetical order. See also
hledger for a more organised command list, and hledger CMD -h for
detailed command help.
accounts
Show account names.
Show account names. Alias: a.
--tree show short account names, as a tree
@ -868,7 +868,7 @@ COMMANDS
Date [2015/05/22]: <CTRL-D> $
balance
Show accounts and their balances. Alias: bal.
Show accounts and their balances. Aliases: b, bal.
--change
show balance change in each period (default)
@ -1333,6 +1333,15 @@ COMMANDS
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
example: http://stefanorodighiero.net/software/hledger-dupes.html
equity
Print closing/opening transactions that bring some or all account bal-
ances to zero and back. Can be useful for bringing account balances
across file boundaries.
help
Show any of the hledger manuals.
@ -1433,8 +1442,11 @@ COMMANDS
period, though as with multicolumn balance reports you can alter the
report mode with --change/--cumulative/--historical.
prices
Print all market prices from the journal.
print
Show transactions from the journal.
Show transactions from the journal. Aliases: p, txns.
-x --explicit
show all amounts explicitly
@ -1524,8 +1536,11 @@ COMMANDS
ing sense; it just puts negative amounts under credit and zero or
greater amounts under debit.)
print-unique
Print transactions which do not reuse an already-seen description.
register
Show postings and their running total. Alias: reg.
Show postings and their running total. Aliases: r, reg.
--cumulative
show running total from report start date (default)
@ -1645,6 +1660,14 @@ COMMANDS
The register command also supports the -o/--output-file and -O/--out-
put-format options for controlling output destination and CSV output.
register-match
Print the one posting whose transaction description is closest to DESC,
in the style of the register command. Helps ledger-autosync detect
already-seen transactions when importing.
rewrite
Print all transactions, adding custom postings to the matched ones.
stats
Show some journal statistics.
@ -1671,6 +1694,9 @@ COMMANDS
The stats command also supports -o/--output-file for controlling output
destination.
tags
List all the tag names in use.
test
Run built-in unit tests.
@ -1762,32 +1788,6 @@ ADD-ON COMMANDS
check
hledger-check.hs checks more powerful account balance assertions.
check-dupes
hledger-check-dupes.hs checks for account names sharing the same leaf
name.
equity
hledger-equity.hs prints balance-resetting transactions, useful for
bringing account balances across file boundaries.
prices
hledger-prices.hs prints all prices from the journal.
print-unique
hledger-print-unique.hs prints transactions which do not reuse an
already-seen description.
register-match
hledger-register-match.hs helps ledger-autosync detect already-seen
transactions when importing.
rewrite
hledger-rewrite.hs Adds one or more custom postings to matched transac-
tions.
tags
hledger-tags.hs Lists tag names in use.
ENVIRONMENT
COLUMNS The screen width used by the register command. Default: the
full terminal width.