;doc: regen manuals

[ci skip]
This commit is contained in:
Simon Michael 2020-01-05 10:54:11 -08:00
parent 2101939345
commit 65d0fda245
3 changed files with 778 additions and 676 deletions

View File

@ -280,12 +280,57 @@ Most hledger commands accept arguments after the command name, which are
often a query, filtering the data in some way. often a query, filtering the data in some way.
.SS Argument files .SS Argument files
.PP .PP
You can save a set of command line options/arguments in a file, one per You can save a set of command line options/arguments in a file, and then
line, and then reuse them by writing \f[C]\[at]FILENAME\f[R] in a reuse them by writing \f[C]\[at]FILENAME\f[R] as a command line
command line. argument.
To prevent this expansion of \f[C]\[at]\f[R]-arguments, precede them Eg: \f[C]hledger bal \[at]foo.args\f[R].
with a \f[C]--\f[R] argument. (To prevent this, eg if you have an argument that begins with a literal
For more, see Save frequently used options. \f[C]\[at]\f[R], precede it with \f[C]--\f[R], eg:
\f[C]hledger bal -- \[at]ARG\f[R]).
.PP
Inside the argument file, each line should contain just one option or
argument.
Avoid the use of spaces, except inside quotes (or you\[aq]ll see a
confusing error).
Between a flag and its argument, use = (or nothing).
Bad:
.IP
.nf
\f[C]
assets depth:2
-X USD
\f[R]
.fi
.PP
Good:
.IP
.nf
\f[C]
assets
depth:2
-X=USD
\f[R]
.fi
.PP
For special characters (see below), use one less level of quoting than
you would at the command prompt.
Bad:
.IP
.nf
\f[C]
-X\[dq]$\[dq]
\f[R]
.fi
.PP
Good:
.IP
.nf
\f[C]
-X$
\f[R]
.fi
.PP
See also: Save frequently used options.
.SS Special characters in arguments and queries .SS Special characters in arguments and queries
.PP .PP
In shell command lines, option and argument values which contain In shell command lines, option and argument values which contain

View File

@ -284,10 +284,36 @@ File: hledger.info, Node: Argument files, Next: Special characters in argument
2.4 Argument files 2.4 Argument files
================== ==================
You can save a set of command line options/arguments in a file, one per You can save a set of command line options/arguments in a file, and then
line, and then reuse them by writing '@FILENAME' in a command line. To reuse them by writing '@FILENAME' as a command line argument. Eg:
prevent this expansion of '@'-arguments, precede them with a '--' 'hledger bal @foo.args'. (To prevent this, eg if you have an argument
argument. For more, see Save frequently used options. that begins with a literal '@', precede it with '--', eg: 'hledger bal
-- @ARG').
Inside the argument file, each line should contain just one option or
argument. Avoid the use of spaces, except inside quotes (or you'll see
a confusing error). Between a flag and its argument, use = (or
nothing). Bad:
assets depth:2
-X USD
Good:
assets
depth:2
-X=USD
For special characters (see below), use one less level of quoting
than you would at the command prompt. Bad:
-X"$"
Good:
-X$
See also: Save frequently used options.
 
File: hledger.info, Node: Special characters in arguments and queries, Next: Command line tips, Prev: Argument files, Up: OPTIONS File: hledger.info, Node: Special characters in arguments and queries, Next: Command line tips, Prev: Argument files, Up: OPTIONS
@ -3177,163 +3203,163 @@ Node: Command arguments7513
Ref: #command-arguments7667 Ref: #command-arguments7667
Node: Argument files7788 Node: Argument files7788
Ref: #argument-files7964 Ref: #argument-files7964
Node: Special characters in arguments and queries8230 Node: Special characters in arguments and queries8720
Ref: #special-characters-in-arguments-and-queries8464 Ref: #special-characters-in-arguments-and-queries8954
Node: More escaping8915 Node: More escaping9405
Ref: #more-escaping9077 Ref: #more-escaping9567
Node: Even more escaping9373 Node: Even more escaping9863
Ref: #even-more-escaping9567 Ref: #even-more-escaping10057
Node: Less escaping10238 Node: Less escaping10728
Ref: #less-escaping10400 Ref: #less-escaping10890
Node: Command line tips10645 Node: Command line tips11135
Ref: #command-line-tips10831 Ref: #command-line-tips11321
Node: Unicode characters11208 Node: Unicode characters11698
Ref: #unicode-characters11364 Ref: #unicode-characters11854
Node: Input files12776 Node: Input files13266
Ref: #input-files12912 Ref: #input-files13402
Node: Smart dates14841 Node: Smart dates15331
Ref: #smart-dates14982 Ref: #smart-dates15472
Node: Report start & end date16388 Node: Report start & end date16878
Ref: #report-start-end-date16560 Ref: #report-start-end-date17050
Node: Report intervals17984 Node: Report intervals18474
Ref: #report-intervals18149 Ref: #report-intervals18639
Node: Period expressions18539 Node: Period expressions19029
Ref: #period-expressions18699 Ref: #period-expressions19189
Node: Depth limiting22654 Node: Depth limiting23144
Ref: #depth-limiting22798 Ref: #depth-limiting23288
Node: Pivoting23140 Node: Pivoting23630
Ref: #pivoting23263 Ref: #pivoting23753
Node: Valuation24939 Node: Valuation25429
Ref: #valuation25068 Ref: #valuation25558
Node: -B Cost25248 Node: -B Cost25738
Ref: #b-cost25359 Ref: #b-cost25849
Node: -V Market value25557 Node: -V Market value26047
Ref: #v-market-value25731 Ref: #v-market-value26221
Node: -X Market value in specified commodity27163 Node: -X Market value in specified commodity27653
Ref: #x-market-value-in-specified-commodity27402 Ref: #x-market-value-in-specified-commodity27892
Node: --value Flexible valuation27578 Node: --value Flexible valuation28068
Ref: #value-flexible-valuation27804 Ref: #value-flexible-valuation28294
Node: Effect of --value on reports31994 Node: Effect of --value on reports32484
Ref: #effect-of---value-on-reports32210 Ref: #effect-of---value-on-reports32700
Node: Combining -B -V -X --value37141 Node: Combining -B -V -X --value37631
Ref: #combining--b--v--x---value37324 Ref: #combining--b--v--x---value37814
Node: Output destination37360 Node: Output destination37850
Ref: #output-destination37512 Ref: #output-destination38002
Node: Output format37795 Node: Output format38285
Ref: #output-format37947 Ref: #output-format38437
Node: Regular expressions38332 Node: Regular expressions38822
Ref: #regular-expressions38469 Ref: #regular-expressions38959
Node: QUERIES39830 Node: QUERIES40320
Ref: #queries39932 Ref: #queries40422
Node: COMMANDS43894 Node: COMMANDS44384
Ref: #commands44006 Ref: #commands44496
Node: accounts45070 Node: accounts45560
Ref: #accounts45168 Ref: #accounts45658
Node: activity45867 Node: activity46357
Ref: #activity45977 Ref: #activity46467
Node: add46360 Node: add46850
Ref: #add46459 Ref: #add46949
Node: balance49198 Node: balance49688
Ref: #balance49309 Ref: #balance49799
Node: Classic balance report50767 Node: Classic balance report51257
Ref: #classic-balance-report50940 Ref: #classic-balance-report51430
Node: Customising the classic balance report52309 Node: Customising the classic balance report52799
Ref: #customising-the-classic-balance-report52537 Ref: #customising-the-classic-balance-report53027
Node: Colour support54613 Node: Colour support55103
Ref: #colour-support54780 Ref: #colour-support55270
Node: Flat mode54953 Node: Flat mode55443
Ref: #flat-mode55101 Ref: #flat-mode55591
Node: Depth limited balance reports55514 Node: Depth limited balance reports56004
Ref: #depth-limited-balance-reports55699 Ref: #depth-limited-balance-reports56189
Node: Percentages56155 Node: Percentages56645
Ref: #percentages56321 Ref: #percentages56811
Node: Multicolumn balance report57458 Node: Multicolumn balance report57948
Ref: #multicolumn-balance-report57638 Ref: #multicolumn-balance-report58128
Node: Budget report62952 Node: Budget report63442
Ref: #budget-report63095 Ref: #budget-report63585
Node: Nested budgets68297 Node: Nested budgets68787
Ref: #nested-budgets68409 Ref: #nested-budgets68899
Ref: #output-format-171890 Ref: #output-format-172380
Node: balancesheet71968 Node: balancesheet72458
Ref: #balancesheet72104 Ref: #balancesheet72594
Node: balancesheetequity73487 Node: balancesheetequity73977
Ref: #balancesheetequity73636 Ref: #balancesheetequity74126
Node: cashflow74197 Node: cashflow74687
Ref: #cashflow74325 Ref: #cashflow74815
Node: check-dates75421 Node: check-dates75911
Ref: #check-dates75548 Ref: #check-dates76038
Node: check-dupes75827 Node: check-dupes76317
Ref: #check-dupes75951 Ref: #check-dupes76441
Node: close76244 Node: close76734
Ref: #close76358 Ref: #close76848
Node: commodities80024 Node: commodities80514
Ref: #commodities80151 Ref: #commodities80641
Node: descriptions80233 Node: descriptions80723
Ref: #descriptions80361 Ref: #descriptions80851
Node: diff80542 Node: diff81032
Ref: #diff80648 Ref: #diff81138
Node: files81695 Node: files82185
Ref: #files81795 Ref: #files82285
Node: help81942 Node: help82432
Ref: #help82042 Ref: #help82532
Node: import83123 Node: import83613
Ref: #import83237 Ref: #import83727
Node: Importing balance assignments84130 Node: Importing balance assignments84620
Ref: #importing-balance-assignments84278 Ref: #importing-balance-assignments84768
Node: incomestatement84927 Node: incomestatement85417
Ref: #incomestatement85060 Ref: #incomestatement85550
Node: notes86464 Node: notes86954
Ref: #notes86577 Ref: #notes87067
Node: payees86703 Node: payees87193
Ref: #payees86809 Ref: #payees87299
Node: prices86967 Node: prices87457
Ref: #prices87073 Ref: #prices87563
Node: print87414 Node: print87904
Ref: #print87524 Ref: #print88014
Node: print-unique92017 Node: print-unique92507
Ref: #print-unique92143 Ref: #print-unique92633
Node: register92428 Node: register92918
Ref: #register92555 Ref: #register93045
Node: Custom register output96727 Node: Custom register output97217
Ref: #custom-register-output96856 Ref: #custom-register-output97346
Node: register-match98118 Node: register-match98608
Ref: #register-match98252 Ref: #register-match98742
Node: rewrite98603 Node: rewrite99093
Ref: #rewrite98718 Ref: #rewrite99208
Node: Re-write rules in a file100573 Node: Re-write rules in a file101063
Ref: #re-write-rules-in-a-file100707 Ref: #re-write-rules-in-a-file101197
Node: Diff output format101917 Node: Diff output format102407
Ref: #diff-output-format102086 Ref: #diff-output-format102576
Node: rewrite vs print --auto103178 Node: rewrite vs print --auto103668
Ref: #rewrite-vs.-print---auto103357 Ref: #rewrite-vs.-print---auto103847
Node: roi103913 Node: roi104403
Ref: #roi104011 Ref: #roi104501
Node: stats105023 Node: stats105513
Ref: #stats105122 Ref: #stats105612
Node: tags105910 Node: tags106400
Ref: #tags106008 Ref: #tags106498
Node: test106302 Node: test106792
Ref: #test106386 Ref: #test106876
Node: ADD-ON COMMANDS107133 Node: ADD-ON COMMANDS107623
Ref: #add-on-commands107243 Ref: #add-on-commands107733
Node: Official add-ons108531 Node: Official add-ons109021
Ref: #official-add-ons108671 Ref: #official-add-ons109161
Node: ui108751 Node: ui109241
Ref: #ui108838 Ref: #ui109328
Node: web108892 Node: web109382
Ref: #web108981 Ref: #web109471
Node: Third party add-ons109027 Node: Third party add-ons109517
Ref: #third-party-add-ons109202 Ref: #third-party-add-ons109692
Node: iadd109321 Node: iadd109811
Ref: #iadd109422 Ref: #iadd109912
Node: interest109504 Node: interest109994
Ref: #interest109613 Ref: #interest110103
Node: Experimental add-ons109708 Node: Experimental add-ons110198
Ref: #experimental-add-ons109860 Ref: #experimental-add-ons110350
Node: autosync110098 Node: autosync110588
Ref: #autosync110209 Ref: #autosync110699
Node: chart110448 Node: chart110938
Ref: #chart110553 Ref: #chart111043
 
End Tag Table End Tag Table

View File

@ -234,10 +234,36 @@ OPTIONS
are often a query, filtering the data in some way. are often a query, filtering the data in some way.
Argument files Argument files
You can save a set of command line options/arguments in a file, one per You can save a set of command line options/arguments in a file, and
line, and then reuse them by writing @FILENAME in a command line. To then reuse them by writing @FILENAME as a command line argument. Eg:
prevent this expansion of @-arguments, precede them with a -- argument. hledger bal @foo.args. (To prevent this, eg if you have an argument
For more, see Save frequently used options. that begins with a literal @, precede it with --, eg: hledger bal --
@ARG).
Inside the argument file, each line should contain just one option or
argument. Avoid the use of spaces, except inside quotes (or you'll see
a confusing error). Between a flag and its argument, use = (or noth-
ing). Bad:
assets depth:2
-X USD
Good:
assets
depth:2
-X=USD
For special characters (see below), use one less level of quoting than
you would at the command prompt. Bad:
-X"$"
Good:
-X$
See also: Save frequently used options.
Special characters in arguments and queries Special characters in arguments and queries
In shell command lines, option and argument values which contain "prob- In shell command lines, option and argument values which contain "prob-
@ -469,7 +495,6 @@ OPTIONS
ber 1st of the current ber 1st of the current
year (11/30 will be the year (11/30 will be the
last date included) last date included)
-b thismonth all transactions on or af- -b thismonth all transactions on or af-
ter the 1st of the current ter the 1st of the current
month month
@ -521,6 +546,8 @@ OPTIONS
1, 2009 1, 2009
-p "from 2009/1" the same -p "from 2009/1" the same
-p "from 2009" the same -p "from 2009" the same
-p "to 2009" everything before january -p "to 2009" everything before january
1, 2009 1, 2009
@ -942,6 +969,10 @@ OPTIONS
grand total sum of dis- sum of dis- sum of dis- sum of dis- grand total sum of dis- sum of dis- sum of dis- sum of dis-
(no report in- played values played values played values played values (no report in- played values played values played values played values
terval) terval)
row totals/av- sums/averages sums/averages sums/averages sums/averages row totals/av- sums/averages sums/averages sums/averages sums/averages
erages (with of displayed of displayed of displayed of displayed erages (with of displayed of displayed of displayed of displayed
report inter- values values values values report inter- values values values values