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

doc: update builtin manuals

Browse Source
This commit is contained in:
Simon Michael 2017-07-07 15:40:50 +01:00
parent 9eb1520b6f
commit 9195989979
6 changed files with 240 additions and 275 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
hledger-api/doc/hledger-api.1
View File

@ -79,25 +79,10 @@ show version
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-h\f[] .B \f[C]\-h\ \-\-help\f[]
show usage show usage
.RS .RS
.RE .RE
.TP
.B \f[C]\-\-help\f[]
show manual as plain text
.RS
.RE
.TP
.B \f[C]\-\-man\f[]
show manual with man
.RS
.RE
.TP
.B \f[C]\-\-info\f[]
show manual with info
.RS
.RE
.SH ENVIRONMENT .SH ENVIRONMENT
.PP .PP
\f[B]LEDGER_FILE\f[] The journal file path when not specified with \f[B]LEDGER_FILE\f[] The journal file path when not specified with

11
hledger-api/doc/hledger-api.1.info
View File

@ -57,18 +57,9 @@ options as shown above.
'--version' '--version'
show version show version
'-h' '-h --help'
show usage show usage
'--help'
show manual as plain text
'--man'
show manual with man
'--info'
show manual with info
 
Tag Table: Tag Table:

9
hledger-api/doc/hledger-api.1.txt
View File

@ -59,13 +59,8 @@ OPTIONS
--version --version
show version show version
-h show usage -h --help
show usage
--help show manual as plain text
--man show manual with man
--info show manual with info
ENVIRONMENT ENVIRONMENT
LEDGER_FILE The journal file path when not specified with -f. Default: LEDGER_FILE The journal file path when not specified with -f. Default:

32
hledger/doc/hledger.1
View File

@ -1848,20 +1848,23 @@ multicolumn balance reports you can alter the report mode with
.PP .PP
Show any of the hledger manuals. Show any of the hledger manuals.
.PP .PP
The \f[C]help\f[] command displays any of the main hledger man pages. The \f[C]help\f[] command displays any of the main hledger manuals, in
(Unlike \f[C]hledger\ \-\-help\f[], which displays only the hledger man one of several ways.
page.) Run it with no arguments to list available topics (their names Run it with no argument to list the manuals (their names are shortened
are shortened for easier typing), and run \f[C]hledger\ help\ TOPIC\f[] for easier typing), and run \f[C]hledger\ help\ MANUAL\f[] to select
to select one. one.
The output is similar to a man page, but fixed width. .PP
It may be long, so you may wish to pipe it into a pager. hledger help will choose one of these docs viewers, in order of
See also info and man. preference: info, man, $PAGER, less, stdout (and it always prints on
stdout when piped).
Or you can force a particular viewer with the \f[C]\-\-info\f[],
\f[C]\-\-man\f[], \f[C]\-\-pager\f[], \f[C]\-\-cat\f[] flags.
.IP .IP
.nf .nf
\f[C] \f[C]
$\ hledger\ help $\ hledger\ help
Choose\ a\ topic,\ eg:\ hledger\ help\ cli Please\ choose\ a\ manual:
cli,\ ui,\ web,\ api,\ journal,\ csv,\ timeclock,\ timedot hledger\ help\ cli|ui|web|api|journal|csv|timeclock|timedot
\f[] \f[]
.fi .fi
.IP .IP
@ -1877,9 +1880,7 @@ NAME
\ \ \ \ \ \ \ hledger\ \-\ a\ command\-line\ accounting\ tool \ \ \ \ \ \ \ hledger\ \-\ a\ command\-line\ accounting\ tool
SYNOPSIS SYNOPSIS
\ \ \ \ \ \ \ hledger\ [\-f\ FILE]\ COMMAND\ [OPTIONS]\ [CMDARGS] \ \ \ \ \ \ \ hledger\ [\-f\ FILE]\ COMMAND\ [OPTIONS]\ [ARGS]
\ \ \ \ \ \ \ hledger\ [\-f\ FILE]\ ADDONCMD\ \-\-\ [OPTIONS]\ [CMDARGS]
:
\f[] \f[]
.fi .fi
.SS incomestatement .SS incomestatement
@ -1981,9 +1982,9 @@ report period.
Normally incomestatement shows revenues/expenses per period, though as Normally incomestatement shows revenues/expenses per period, though as
with multicolumn balance reports you can alter the report mode with with multicolumn balance reports you can alter the report mode with
\f[C]\-\-change\f[]/\f[C]\-\-cumulative\f[]/\f[C]\-\-historical\f[]. \f[C]\-\-change\f[]/\f[C]\-\-cumulative\f[]/\f[C]\-\-historical\f[].
.SS info
.PP .PP
Show any of the hledger manuals using info. \&...
## info Show any of the hledger manuals using info.
.PP .PP
The \f[C]info\f[] command displays any of the hledger reference manuals The \f[C]info\f[] command displays any of the hledger reference manuals
using the info hypertextual documentation viewer. using the info hypertextual documentation viewer.
@ -2004,6 +2005,7 @@ It requires the "man" program to be available in your PATH.
.PP .PP
As with help, run it with no arguments to list available topics As with help, run it with no arguments to list available topics
(manuals). (manuals).
```
.SS print .SS print
.PP .PP
Show transactions from the journal. Show transactions from the journal.

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

@ -786,7 +786,6 @@ displayed in the command list ('hledger is').
* cashflow:: * cashflow::
* help:: * help::
* incomestatement:: * incomestatement::
* info::
* man:: * man::
* print:: * print::
* register:: * register::
@ -1441,16 +1440,19 @@ File: hledger.1.info, Node: help, Next: incomestatement, Prev: cashflow, Up:
Show any of the hledger manuals. Show any of the hledger manuals.
The 'help' command displays any of the main hledger man pages. The 'help' command displays any of the main hledger manuals, in one
(Unlike 'hledger --help', which displays only the hledger man page.) of several ways. Run it with no argument to list the manuals (their
Run it with no arguments to list available topics (their names are names are shortened for easier typing), and run 'hledger help MANUAL' to
shortened for easier typing), and run 'hledger help TOPIC' to select select one.
one. The output is similar to a man page, but fixed width. It may be
long, so you may wish to pipe it into a pager. See also info and man. hledger help will choose one of these docs viewers, in order of
preference: info, man, $PAGER, less, stdout (and it always prints on
stdout when piped). Or you can force a particular viewer with the
'--info', '--man', '--pager', '--cat' flags.
$ hledger help $ hledger help
Choose a topic, eg: hledger help cli Please choose a manual:
cli, ui, web, api, journal, csv, timeclock, timedot hledger help cli|ui|web|api|journal|csv|timeclock|timedot
$ hledger help cli | less $ hledger help cli | less
@ -1462,12 +1464,10 @@ NAME
hledger - a command-line accounting tool hledger - a command-line accounting tool
SYNOPSIS SYNOPSIS
hledger [-f FILE] COMMAND [OPTIONS] [CMDARGS] hledger [-f FILE] COMMAND [OPTIONS] [ARGS]
hledger [-f FILE] ADDONCMD -- [OPTIONS] [CMDARGS]
:
 
File: hledger.1.info, Node: incomestatement, Next: info, Prev: help, Up: COMMANDS File: hledger.1.info, Node: incomestatement, Next: man, Prev: help, Up: COMMANDS
4.8 incomestatement 4.8 incomestatement
=================== ===================
@ -1542,13 +1542,7 @@ each report period. Normally incomestatement shows revenues/expenses
per period, though as with multicolumn balance reports you can alter the per period, though as with multicolumn balance reports you can alter the
report mode with '--change'/'--cumulative'/'--historical'. report mode with '--change'/'--cumulative'/'--historical'.
 ... ## info Show any of the hledger manuals using info.
File: hledger.1.info, Node: info, Next: man, Prev: incomestatement, Up: COMMANDS
4.9 info
========
Show any of the hledger manuals using info.
The 'info' command displays any of the hledger reference manuals The 'info' command displays any of the hledger reference manuals
using the info hypertextual documentation viewer. This can be a very using the info hypertextual documentation viewer. This can be a very
@ -1559,10 +1553,10 @@ to be available in your PATH.
(manuals). (manuals).
 
File: hledger.1.info, Node: man, Next: print, Prev: info, Up: COMMANDS File: hledger.1.info, Node: man, Next: print, Prev: incomestatement, Up: COMMANDS
4.10 man 4.9 man
======== =======
Show any of the hledger manuals using man. Show any of the hledger manuals using man.
@ -1573,12 +1567,12 @@ automatically. It requires the "man" program to be available in your
PATH. PATH.
As with help, run it with no arguments to list available topics As with help, run it with no arguments to list available topics
(manuals). (manuals). "'
 
File: hledger.1.info, Node: print, Next: register, Prev: man, Up: COMMANDS File: hledger.1.info, Node: print, Next: register, Prev: man, Up: COMMANDS
4.11 print 4.10 print
========== ==========
Show transactions from the journal. Show transactions from the journal.
@ -1672,7 +1666,7 @@ $ hledger print -Ocsv
 
File: hledger.1.info, Node: register, Next: stats, Prev: print, Up: COMMANDS File: hledger.1.info, Node: register, Next: stats, Prev: print, Up: COMMANDS
4.12 register 4.11 register
============= =============
Show postings and their running total. Alias: reg. Show postings and their running total. Alias: reg.
@ -1777,7 +1771,7 @@ length and comparable to the others in the report.
 
File: hledger.1.info, Node: Custom register output, Up: register File: hledger.1.info, Node: Custom register output, Up: register
4.12.1 Custom register output 4.11.1 Custom register output
----------------------------- -----------------------------
register uses the full terminal width by default, except on windows. register uses the full terminal width by default, except on windows.
@ -1809,7 +1803,7 @@ output.
 
File: hledger.1.info, Node: stats, Next: test, Prev: register, Up: COMMANDS File: hledger.1.info, Node: stats, Next: test, Prev: register, Up: COMMANDS
4.13 stats 4.12 stats
========== ==========
Show some journal statistics. Show some journal statistics.
@ -1841,7 +1835,7 @@ output destination.
 
File: hledger.1.info, Node: test, Prev: stats, Up: COMMANDS File: hledger.1.info, Node: test, Prev: stats, Up: COMMANDS
4.14 test 4.13 test
========= =========
Run built-in unit tests. Run built-in unit tests.
@ -2139,93 +2133,91 @@ Node: QUERIES21565
Ref: #queries21669 Ref: #queries21669
Node: COMMANDS25334 Node: COMMANDS25334
Ref: #commands25448 Ref: #commands25448
Node: accounts26121 Node: accounts26112
Ref: #accounts26221 Ref: #accounts26212
Node: activity27203 Node: activity27194
Ref: #activity27315 Ref: #activity27306
Node: add27674 Node: add27665
Ref: #add27775 Ref: #add27766
Node: balance30433 Node: balance30424
Ref: #balance30546 Ref: #balance30537
Node: Flat mode33561 Node: Flat mode33552
Ref: #flat-mode33688 Ref: #flat-mode33679
Node: Depth limited balance reports34108 Node: Depth limited balance reports34099
Ref: #depth-limited-balance-reports34311 Ref: #depth-limited-balance-reports34302
Node: Multicolumn balance reports34731 Node: Multicolumn balance reports34722
Ref: #multicolumn-balance-reports34942 Ref: #multicolumn-balance-reports34933
Node: Custom balance output39590 Node: Custom balance output39581
Ref: #custom-balance-output39774 Ref: #custom-balance-output39765
Node: Colour support41867 Node: Colour support41858
Ref: #colour-support42028 Ref: #colour-support42019
Node: Output destination42201 Node: Output destination42192
Ref: #output-destination42359 Ref: #output-destination42350
Node: CSV output42629 Node: CSV output42620
Ref: #csv-output42748 Ref: #csv-output42739
Node: balancesheet43145 Node: balancesheet43136
Ref: #balancesheet43273 Ref: #balancesheet43264
Node: cashflow45180 Node: cashflow45171
Ref: #cashflow45297 Ref: #cashflow45288
Node: help47165 Node: help47156
Ref: #help47277 Ref: #help47268
Node: incomestatement48115 Node: incomestatement48098
Ref: #incomestatement48245 Ref: #incomestatement48227
Node: info50137 Node: man50499
Ref: #info50244 Ref: #man50605
Node: man50608 Node: print51014
Ref: #man50705 Ref: #print51119
Node: print51110 Node: register54875
Ref: #print51215 Ref: #register54988
Node: register54971 Node: Custom register output59484
Ref: #register55084 Ref: #custom-register-output59615
Node: Custom register output59580 Node: stats60912
Ref: #custom-register-output59711 Ref: #stats61018
Node: stats61008 Node: test61899
Ref: #stats61114 Ref: #test61986
Node: test61995 Node: ADD-ON COMMANDS62354
Ref: #test62082 Ref: #add-on-commands62466
Node: ADD-ON COMMANDS62450 Node: Official add-ons63753
Ref: #add-on-commands62562 Ref: #official-add-ons63895
Node: Official add-ons63849 Node: api63982
Ref: #official-add-ons63991 Ref: #api64073
Node: api64078 Node: ui64125
Ref: #api64169 Ref: #ui64226
Node: ui64221 Node: web64284
Ref: #ui64322 Ref: #web64375
Node: web64380 Node: Third party add-ons64421
Ref: #web64471 Ref: #third-party-add-ons64598
Node: Third party add-ons64517 Node: diff64733
Ref: #third-party-add-ons64694 Ref: #diff64832
Node: diff64829 Node: iadd64931
Ref: #diff64928 Ref: #iadd65047
Node: iadd65027 Node: interest65130
Ref: #iadd65143 Ref: #interest65253
Node: interest65226 Node: irr65348
Ref: #interest65349 Ref: #irr65448
Node: irr65444 Node: Experimental add-ons65526
Ref: #irr65544 Ref: #experimental-add-ons65680
Node: Experimental add-ons65622 Node: autosync66073
Ref: #experimental-add-ons65776 Ref: #autosync66187
Node: autosync66169 Node: budget66426
Ref: #autosync66283 Ref: #budget66550
Node: budget66522 Node: chart66616
Ref: #budget66646 Ref: #chart66735
Node: chart66712 Node: check66806
Ref: #chart66831 Ref: #check66930
Node: check66902 Node: check-dates66997
Ref: #check67026 Ref: #check-dates67139
Node: check-dates67093 Node: check-dupes67212
Ref: #check-dates67235 Ref: #check-dupes67355
Node: check-dupes67308 Node: equity67432
Ref: #check-dupes67451 Ref: #equity67560
Node: equity67528 Node: prices67679
Ref: #equity67656 Ref: #prices67808
Node: prices67775 Node: print-unique67863
Ref: #prices67904 Ref: #print-unique68012
Node: print-unique67959 Node: register-match68105
Ref: #print-unique68108 Ref: #register-match68261
Node: register-match68201 Node: rewrite68359
Ref: #register-match68357 Ref: #rewrite68480
Node: rewrite68455
Ref: #rewrite68576
 
End Tag Table End Tag Table

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

@ -1286,16 +1286,19 @@ COMMANDS
help help
Show any of the hledger manuals. Show any of the hledger manuals.
The help command displays any of the main hledger man pages. (Unlike The help command displays any of the main hledger manuals, in one of
hledger --help, which displays only the hledger man page.) Run it with several ways. Run it with no argument to list the manuals (their names
no arguments to list available topics (their names are shortened for are shortened for easier typing), and run hledger help MANUAL to select
easier typing), and run hledger help TOPIC to select one. The output one.
is similar to a man page, but fixed width. It may be long, so you may
wish to pipe it into a pager. See also info and man. hledger help will choose one of these docs viewers, in order of prefer-
ence: info, man, $PAGER, less, stdout (and it always prints on stdout
when piped). Or you can force a particular viewer with the --info,
--man, --pager, --cat flags.
$ hledger help $ hledger help
Choose a topic, eg: hledger help cli Please choose a manual:
cli, ui, web, api, journal, csv, timeclock, timedot hledger help cli|ui|web|api|journal|csv|timeclock|timedot
$ hledger help cli | less $ hledger help cli | less
@ -1307,9 +1310,7 @@ COMMANDS
hledger - a command-line accounting tool hledger - a command-line accounting tool
SYNOPSIS SYNOPSIS
hledger [-f FILE] COMMAND [OPTIONS] [CMDARGS] hledger [-f FILE] COMMAND [OPTIONS] [ARGS]
hledger [-f FILE] ADDONCMD -- [OPTIONS] [CMDARGS]
:
incomestatement incomestatement
Show an income statement. Alias: is. Show an income statement. Alias: is.
@ -1379,8 +1380,7 @@ COMMANDS
period, though as with multicolumn balance reports you can alter the period, though as with multicolumn balance reports you can alter the
report mode with --change/--cumulative/--historical. report mode with --change/--cumulative/--historical.
info ... ## info Show any of the hledger manuals using info.
Show any of the hledger manuals using info.
The info command displays any of the hledger reference manuals using The info command displays any of the hledger reference manuals using
the info hypertextual documentation viewer. This can be a very effi- the info hypertextual documentation viewer. This can be a very effi-
@ -1399,7 +1399,7 @@ COMMANDS
cally. It requires the "man" program to be available in your PATH. cally. It requires the "man" program to be available in your PATH.
As with help, run it with no arguments to list available topics (manu- As with help, run it with no arguments to list available topics (manu-
als). als). ```
print print
Show transactions from the journal. Show transactions from the journal.