;doc: update manuals

This commit is contained in:
Simon Michael 2021-09-17 17:58:10 -10:00
parent 62351dd329
commit 8a4cea2a69
9 changed files with 2261 additions and 2234 deletions

View File

@ -199,6 +199,9 @@ show general or ADDONCMD version
.TP .TP
\f[B]\f[CB]--debug[=N]\f[B]\f[R] \f[B]\f[CB]--debug[=N]\f[B]\f[R]
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
.TP
\f[B]\f[CB]--today=DATE\f[B]\f[R]
generate reports treating DATE as the current day (for testing purposes)
.PP .PP
A \[at]FILE argument will be expanded to the contents of FILE, which A \[at]FILE argument will be expanded to the contents of FILE, which
should contain one command line option/argument per line. should contain one command line option/argument per line.

View File

@ -217,6 +217,10 @@ the last one takes precedence.
`--debug[=N]' `--debug[=N]'
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
`--today=DATE'
generate reports treating DATE as the current day (for testing
purposes)
A @FILE argument will be expanded to the contents of FILE, which A @FILE argument will be expanded to the contents of FILE, which
should contain one command line option/argument per line. (To prevent should contain one command line option/argument per line. (To prevent
this, insert a `--' argument before.) this, insert a `--' argument before.)
@ -598,29 +602,29 @@ Tag Table:
Node: Top232 Node: Top232
Node: OPTIONS1637 Node: OPTIONS1637
Ref: #options1734 Ref: #options1734
Node: KEYS6129 Node: KEYS6228
Ref: #keys6224 Ref: #keys6323
Node: SCREENS10273 Node: SCREENS10372
Ref: #screens10371 Ref: #screens10470
Node: Accounts screen10461 Node: Accounts screen10560
Ref: #accounts-screen10589 Ref: #accounts-screen10688
Node: Register screen12793 Node: Register screen12892
Ref: #register-screen12948 Ref: #register-screen13047
Node: Transaction screen14943 Node: Transaction screen15042
Ref: #transaction-screen15101 Ref: #transaction-screen15200
Node: Error screen15968 Node: Error screen16067
Ref: #error-screen16090 Ref: #error-screen16189
Node: TIPS16332 Node: TIPS16431
Ref: #tips16431 Ref: #tips16530
Node: Watch mode16483 Node: Watch mode16582
Ref: #watch-mode16600 Ref: #watch-mode16699
Node: Watch mode limitations17344 Node: Watch mode limitations17443
Ref: #watch-mode-limitations17485 Ref: #watch-mode-limitations17584
Node: ENVIRONMENT18618 Node: ENVIRONMENT18717
Ref: #environment18729 Ref: #environment18828
Node: FILES19534 Node: FILES19633
Ref: #files19633 Ref: #files19732
Node: BUGS19846 Node: BUGS19945
Ref: #bugs19923 Ref: #bugs20022
 
End Tag Table End Tag Table

View File

@ -193,6 +193,10 @@ OPTIONS
--debug[=N] --debug[=N]
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
--today=DATE
generate reports treating DATE as the current day (for testing
purposes)
A @FILE argument will be expanded to the contents of FILE, which should A @FILE argument will be expanded to the contents of FILE, which should
contain one command line option/argument per line. (To prevent this, contain one command line option/argument per line. (To prevent this,
insert a -- argument before.) insert a -- argument before.)

View File

@ -228,6 +228,9 @@ show general or ADDONCMD version
.TP .TP
\f[B]\f[CB]--debug[=N]\f[B]\f[R] \f[B]\f[CB]--debug[=N]\f[B]\f[R]
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
.TP
\f[B]\f[CB]--today=DATE\f[B]\f[R]
generate reports treating DATE as the current day (for testing purposes)
.PP .PP
A \[at]FILE argument will be expanded to the contents of FILE, which A \[at]FILE argument will be expanded to the contents of FILE, which
should contain one command line option/argument per line. should contain one command line option/argument per line.

View File

@ -242,6 +242,10 @@ the last one takes precedence.
`--debug[=N]' `--debug[=N]'
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
`--today=DATE'
generate reports treating DATE as the current day (for testing
purposes)
A @FILE argument will be expanded to the contents of FILE, which A @FILE argument will be expanded to the contents of FILE, which
should contain one command line option/argument per line. (To prevent should contain one command line option/argument per line. (To prevent
this, insert a `--' argument before.) this, insert a `--' argument before.)
@ -615,19 +619,19 @@ Tag Table:
Node: Top235 Node: Top235
Node: OPTIONS1878 Node: OPTIONS1878
Ref: #options1983 Ref: #options1983
Node: PERMISSIONS9396 Node: PERMISSIONS9495
Ref: #permissions9535 Ref: #permissions9634
Node: EDITING UPLOADING DOWNLOADING10747 Node: EDITING UPLOADING DOWNLOADING10846
Ref: #editing-uploading-downloading10928 Ref: #editing-uploading-downloading11027
Node: RELOADING11759 Node: RELOADING11858
Ref: #reloading11893 Ref: #reloading11992
Node: JSON API12325 Node: JSON API12424
Ref: #json-api12439 Ref: #json-api12538
Node: ENVIRONMENT17928 Node: ENVIRONMENT18027
Ref: #environment18044 Ref: #environment18143
Node: FILES18776 Node: FILES18875
Ref: #files18876 Ref: #files18975
Node: BUGS19089 Node: BUGS19188
Ref: #bugs19167 Ref: #bugs19266
 
End Tag Table End Tag Table

View File

@ -216,6 +216,10 @@ OPTIONS
--debug[=N] --debug[=N]
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
--today=DATE
generate reports treating DATE as the current day (for testing
purposes)
A @FILE argument will be expanded to the contents of FILE, which should A @FILE argument will be expanded to the contents of FILE, which should
contain one command line option/argument per line. (To prevent this, contain one command line option/argument per line. (To prevent this,
insert a -- argument before.) insert a -- argument before.)

View File

@ -86,6 +86,9 @@ show general or ADDONCMD version
.TP .TP
\f[B]\f[CB]--debug[=N]\f[B]\f[R] \f[B]\f[CB]--debug[=N]\f[B]\f[R]
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
.TP
\f[B]\f[CB]--today=DATE\f[B]\f[R]
generate reports treating DATE as the current day (for testing purposes)
.PP .PP
General input options: General input options:
.TP .TP
@ -8797,7 +8800,7 @@ Here are the balance assertion types for quick reference:
.PP .PP
It\[aq]s a good idea to get rapid feedback while It\[aq]s a good idea to get rapid feedback while
creating/troubleshooting CSV rules. creating/troubleshooting CSV rules.
Here\[aq]s a good way, using entr from http://eradman.com/entrproject : Here\[aq]s a good way, using entr from eradman.com/entrproject:
.IP .IP
.nf .nf
\f[C] \f[C]

File diff suppressed because it is too large Load Diff

View File

@ -73,6 +73,10 @@ OPTIONS
--debug[=N] --debug[=N]
show debug output (levels 1-9, default: 1) show debug output (levels 1-9, default: 1)
--today=DATE
generate reports treating DATE as the current day (for testing
purposes)
General input options: General input options:
-f FILE --file=FILE -f FILE --file=FILE
@ -684,6 +688,8 @@ TIME PERIODS
-p "2009" the year 2009; equivalent -p "2009" the year 2009; equivalent
to "2009/1/1 to 2010/1/1" to "2009/1/1 to 2010/1/1"
-p "2009/1" the month of jan; equiva- -p "2009/1" the month of jan; equiva-
lent to "2009/1/1 to lent to "2009/1/1 to
2009/2/1" 2009/2/1"
@ -784,7 +790,6 @@ TIME PERIODS
-p "every 2nd day of periods will go from Tue to Tue -p "every 2nd day of periods will go from Tue to Tue
week" week"
-p "every Tue" same -p "every Tue" same
-p "every 15th day" period boundaries will be on 15th of each -p "every 15th day" period boundaries will be on 15th of each
month month
@ -1333,6 +1338,7 @@ VALUATION
ing amounts cost period ends in interval, val- period ends DATE/today ing amounts cost period ends in interval, val- period ends DATE/today
with report ued at interval with report ued at interval
interval start interval start
running sum/average sum/average sum/average of sum/average sum/average running sum/average sum/average sum/average of sum/average sum/average
total/average of displayed of displayed displayed values of displayed of displayed total/average of displayed of displayed displayed values of displayed of displayed
values values values values values values values values
@ -1366,11 +1372,6 @@ VALUATION
is, bs postings in period at respec- each period, sums of post- is, bs postings in period at respec- each period, sums of post-
--change, cf period tive posting valued at ings --change, cf period tive posting valued at ings
--change) dates period ends --change) dates period ends
end balances sums of same as sums of values of period end value at end balances sums of same as sums of values of period end value at
(bal -H, is costs of --value=end postings from balances, DATE/today of (bal -H, is costs of --value=end postings from balances, DATE/today of
--H, bs, cf) postings before period valued at sums of post- --H, bs, cf) postings before period valued at sums of post-
@ -2325,6 +2326,7 @@ COMMANDS
period end ues from report from report report start period end ues from report from report report start
start to period start to period to period end start to period start to period to period end
end end end end
--his- change from sum of posting- period-end DATE-value of --his- change from sum of posting- period-end DATE-value of
torical journal start to date market val- value of change change from torical journal start to date market val- value of change change from
/-H period end (his- ues from journal from journal journal start /-H period end (his- ues from journal from journal journal start
@ -4756,8 +4758,6 @@ JOURNAL FORMAT
links to more detailed docs. links to more detailed docs.
direc- end subdi- purpose can affect (as of direc- end subdi- purpose can affect (as of
tive directive rec- 2018/06) tive directive rec- 2018/06)
tives tives
@ -4809,6 +4809,8 @@ JOURNAL FORMAT
Y declare a year for yearless following entries Y declare a year for yearless following entries
dates until end of cur- dates until end of cur-
rent file rent file
= declare an auto posting all entries in par- = declare an auto posting all entries in par-
rule, adding postings to ent/current/child rule, adding postings to ent/current/child
other transactions files (but not sib- other transactions files (but not sib-
@ -5697,8 +5699,6 @@ CSV FORMAT
skip skip one or more header lines or matched CSV skip skip one or more header lines or matched CSV
records records
fields list name CSV fields, assign them to hledger fields list name CSV fields, assign them to hledger
fields fields
field assignment assign a value to one hledger field, with field assignment assign a value to one hledger field, with
@ -6437,8 +6437,7 @@ CSV FORMAT
Tips Tips
Rapid feedback Rapid feedback
It's a good idea to get rapid feedback while creating/troubleshooting It's a good idea to get rapid feedback while creating/troubleshooting
CSV rules. Here's a good way, using entr from http://eradman.com/entr- CSV rules. Here's a good way, using entr from eradman.com/entrproject:
project :
$ ls foo.csv* | entr bash -c 'echo ----; hledger -f foo.csv print desc:SOMEDESC' $ ls foo.csv* | entr bash -c 'echo ----; hledger -f foo.csv print desc:SOMEDESC'