;regen manuals

This commit is contained in:
Simon Michael 2020-06-05 14:44:37 -07:00
parent 88051b93ab
commit e5a0bddbe6
20 changed files with 825 additions and 837 deletions

View File

@ -4,4 +4,4 @@ m4_dnl Program version. Updated by make setversion.
m4_define({{_version_}}, {{1.17.99}})m4_dnl m4_define({{_version_}}, {{1.17.99}})m4_dnl
m4_dnl m4_dnl
m4_dnl Date to show in man pages. Updated by make setdate. m4_dnl Date to show in man pages. Updated by make setdate.
m4_define({{_monthyear_}}, {{May 2020}})m4_dnl m4_define({{_monthyear_}}, {{June 2020}})m4_dnl

View File

@ -1,6 +1,6 @@
.\"t .\"t
.TH "hledger_csv" "5" "May 2020" "hledger 1.17.99" "hledger User Manuals" .TH "hledger_csv" "5" "June 2020" "hledger 1.17.99" "hledger User Manuals"

View File

@ -850,4 +850,4 @@ SEE ALSO
hledger 1.17.99 May 2020 hledger_csv(5) hledger 1.17.99 June 2020 hledger_csv(5)

View File

@ -1,6 +1,6 @@
.\"t .\"t
.TH "hledger_journal" "5" "May 2020" "hledger 1.17.99" "hledger User Manuals" .TH "hledger_journal" "5" "June 2020" "hledger 1.17.99" "hledger User Manuals"
@ -1133,17 +1133,25 @@ directive, like this:
.IP .IP
.nf .nf
\f[C] \f[C]
include path/to/file.journal include FILEPATH
\f[R] \f[R]
.fi .fi
.PP .PP
If the path does not begin with a slash, it is relative to the current Only journal files can include, and only journal, timeclock or timedot
file. files can be included (not CSV files, currently).
The include file path may contain common glob patterns (e.g.
\f[C]*\f[R]).
.PP .PP
The \f[C]include\f[R] directive can only be used in journal files. If the file path does not begin with a slash, it is relative to the
It can include journal, timeclock or timedot files, but not CSV files. current file\[aq]s folder.
.PP
It may contain glob patterns to match multiple files, eg:
\f[C]include *.journal\f[R].
.PP
Or a tilde, meaning home directory:
\f[C]include \[ti]/main.journal\f[R].
.PP
It may also be prefixed to force a specific file format, overriding the
file extension (as described in hledger.1 -> Input files):
\f[C]include timedot:\[ti]/notes/2020*.md\f[R].
.SS Default year .SS Default year
.PP .PP
You can set a default year to be used for subsequent dates which You can set a default year to be used for subsequent dates which
@ -1789,25 +1797,25 @@ Don\[aq]t accidentally write two spaces in the middle of your period
expression. expression.
.SS Forecasting with periodic transactions .SS Forecasting with periodic transactions
.PP .PP
With the \f[C]--forecast\f[R] flag, each periodic transaction rule The \f[C]--forecast\f[R] flag activates any periodic transaction rules
generates future transactions recurring at the specified interval. in the journal.
These are not saved in the journal, but appear in all reports. They will generate temporary recurring transactions, which are not saved
They will look like normal transactions, but with an extra tag: in the journal, but will appear in all reports (eg print).
.IP \[bu] 2 This can be useful for estimating balances into the future, or
\f[C]generated-transaction:\[ti] PERIODICEXPR\f[R] - shows that this was experimenting with different scenarios.
generated by a periodic transaction rule, and the period Or, it can be used as a data entry aid: describe recurring transactions,
and every so often copy the output of \f[C]print --forecast\f[R] into
the journal.
.PP .PP
There is also a hidden tag, with an underscore prefix, which does not These transactions will have an extra tag indicating which periodic rule
appear in hledger\[aq]s output: generated them: \f[C]generated-transaction:\[ti] PERIODICEXPR\f[R].
.IP \[bu] 2 And a similar, hidden tag (beginning with an underscore) which, because
\f[C]_generated-transaction:\[ti] PERIODICEXPR\f[R] it\[aq]s never displayed by print, can be used to match transactions
generated \[dq]just now\[dq]:
\f[C]_generated-transaction:\[ti] PERIODICEXPR\f[R].
.PP .PP
This can be used to match transactions generated \[dq]just now\[dq], Periodic transactions are generated within some forecast period.
rather than generated in the past and saved to the journal. By default, this
.PP
Forecast transactions start on the first occurrence, and end on the last
occurrence, of their interval within the forecast period.
The forecast period:
.IP \[bu] 2 .IP \[bu] 2
begins on the later of begins on the later of
.RS 2 .RS 2
@ -1818,27 +1826,26 @@ the day after the latest normal (non-periodic) transaction in the
journal, or today if there are no normal transactions. journal, or today if there are no normal transactions.
.RE .RE
.IP \[bu] 2 .IP \[bu] 2
ends on the report end date if specified with -e/-p/date:, or 180 days ends on the report end date if specified with -e/-p/date:, or 6 months
from today. (180 days) from today.
.PP .PP
where \[dq]today\[dq] means the current date at report time. This means that periodic transactions will begin only after the latest
The \[dq]later of\[dq] rule ensures that forecast transactions do not recorded transaction.
overlap normal transactions in time; they will begin only after normal And a recorded transaction dated in the future can prevent generation of
transactions end. periodic transactions.
(You can avoid that by writing the future transaction as a one-time
periodic rule instead - put tilde before the date, eg
\f[C]\[ti] YYYY-MM-DD ...\f[R]).
.PP .PP
Forecasting can be useful for estimating balances into the future, and Or, you can set your own arbitrary \[dq]forecast period\[dq], which can
experimenting with different scenarios. overlap recorded transactions, and need not be in the future, by
Note the start date logic means that forecasted transactions are providing an option argument, like \f[C]--forecast=PERIODEXPR\f[R].
automatically replaced by normal transactions as you add those. Note the equals sign is required, a space won\[aq]t work.
.PP PERIODEXPR is a period expression, which can specify the start date, end
Forecasting can also help with data entry: describe most of your date, or both, like in a \f[C]date:\f[R] query.
transactions with periodic rules, and every so often copy the output of (See also hledger.1 -> Report start & end date).
\f[C]print --forecast\f[R] to the journal. Some examples: \f[C]--forecast=202001-202004\f[R],
.PP \f[C]--forecast=jan-\f[R], \f[C]--forecast=2020\f[R].
You can generate one-time transactions too: just write a period
expression specifying a date with no report interval.
(You could also write a normal transaction with a future date, but
remember this disables forecast transactions on previous dates.)
.SS Budgeting with periodic transactions .SS Budgeting with periodic transactions
.PP .PP
With the \f[C]--budget\f[R] flag, currently supported by the balance With the \f[C]--budget\f[R] flag, currently supported by the balance

View File

@ -1015,14 +1015,22 @@ File: hledger_journal.info, Node: Including other files, Next: Default year,
You can pull in the content of additional files by writing an include You can pull in the content of additional files by writing an include
directive, like this: directive, like this:
include path/to/file.journal include FILEPATH
If the path does not begin with a slash, it is relative to the Only journal files can include, and only journal, timeclock or
current file. The include file path may contain common glob patterns timedot files can be included (not CSV files, currently).
(e.g. '*').
The 'include' directive can only be used in journal files. It can If the file path does not begin with a slash, it is relative to the
include journal, timeclock or timedot files, but not CSV files. current file's folder.
It may contain glob patterns to match multiple files, eg: 'include
*.journal'.
Or a tilde, meaning home directory: 'include ~/main.journal'.
It may also be prefixed to force a specific file format, overriding
the file extension (as described in hledger.1 -> Input files): 'include
timedot:~/notes/2020*.md'.
 
File: hledger_journal.info, Node: Default year, Next: Declaring commodities, Prev: Including other files, Up: Directives File: hledger_journal.info, Node: Default year, Next: Declaring commodities, Prev: Including other files, Up: Directives
@ -1620,52 +1628,45 @@ File: hledger_journal.info, Node: Forecasting with periodic transactions, Next
1.14.3 Forecasting with periodic transactions 1.14.3 Forecasting with periodic transactions
--------------------------------------------- ---------------------------------------------
With the '--forecast' flag, each periodic transaction rule generates The '--forecast' flag activates any periodic transaction rules in the
future transactions recurring at the specified interval. These are not journal. They will generate temporary recurring transactions, which are
saved in the journal, but appear in all reports. They will look like not saved in the journal, but will appear in all reports (eg print).
normal transactions, but with an extra tag: This can be useful for estimating balances into the future, or
experimenting with different scenarios. Or, it can be used as a data
entry aid: describe recurring transactions, and every so often copy the
output of 'print --forecast' into the journal.
* 'generated-transaction:~ PERIODICEXPR' - shows that this was These transactions will have an extra tag indicating which periodic
generated by a periodic transaction rule, and the period rule generated them: 'generated-transaction:~ PERIODICEXPR'. And a
similar, hidden tag (beginning with an underscore) which, because it's
never displayed by print, can be used to match transactions generated
"just now": '_generated-transaction:~ PERIODICEXPR'.
There is also a hidden tag, with an underscore prefix, which does not Periodic transactions are generated within some forecast period. By
appear in hledger's output: default, this
* '_generated-transaction:~ PERIODICEXPR'
This can be used to match transactions generated "just now", rather
than generated in the past and saved to the journal.
Forecast transactions start on the first occurrence, and end on the
last occurrence, of their interval within the forecast period. The
forecast period:
* begins on the later of * begins on the later of
* the report start date if specified with -b/-p/date: * the report start date if specified with -b/-p/date:
* the day after the latest normal (non-periodic) transaction in * the day after the latest normal (non-periodic) transaction in
the journal, or today if there are no normal transactions. the journal, or today if there are no normal transactions.
* ends on the report end date if specified with -e/-p/date:, or 180 * ends on the report end date if specified with -e/-p/date:, or 6
days from today. months (180 days) from today.
where "today" means the current date at report time. The "later of" This means that periodic transactions will begin only after the
rule ensures that forecast transactions do not overlap normal latest recorded transaction. And a recorded transaction dated in the
transactions in time; they will begin only after normal transactions future can prevent generation of periodic transactions. (You can avoid
end. that by writing the future transaction as a one-time periodic rule
instead - put tilde before the date, eg '~ YYYY-MM-DD ...').
Forecasting can be useful for estimating balances into the future, Or, you can set your own arbitrary "forecast period", which can
and experimenting with different scenarios. Note the start date logic overlap recorded transactions, and need not be in the future, by
means that forecasted transactions are automatically replaced by normal providing an option argument, like '--forecast=PERIODEXPR'. Note the
transactions as you add those. equals sign is required, a space won't work. PERIODEXPR is a period
expression, which can specify the start date, end date, or both, like in
Forecasting can also help with data entry: describe most of your a 'date:' query. (See also hledger.1 -> Report start & end date). Some
transactions with periodic rules, and every so often copy the output of examples: '--forecast=202001-202004', '--forecast=jan-',
'print --forecast' to the journal. '--forecast=2020'.
You can generate one-time transactions too: just write a period
expression specifying a date with no report interval. (You could also
write a normal transaction with a future date, but remember this
disables forecast transactions on previous dates.)
 
File: hledger_journal.info, Node: Budgeting with periodic transactions, Prev: Forecasting with periodic transactions, Up: Periodic transactions File: hledger_journal.info, Node: Budgeting with periodic transactions, Prev: Forecasting with periodic transactions, Up: Periodic transactions
@ -1888,58 +1889,58 @@ Node: Comment blocks37860
Ref: #comment-blocks38043 Ref: #comment-blocks38043
Node: Including other files38219 Node: Including other files38219
Ref: #including-other-files38399 Ref: #including-other-files38399
Node: Default year38807 Node: Default year39050
Ref: #default-year38976 Ref: #default-year39219
Node: Declaring commodities39383 Node: Declaring commodities39626
Ref: #declaring-commodities39566 Ref: #declaring-commodities39809
Node: Default commodity41372 Node: Default commodity41615
Ref: #default-commodity41558 Ref: #default-commodity41801
Node: Declaring market prices42447 Node: Declaring market prices42690
Ref: #declaring-market-prices42642 Ref: #declaring-market-prices42885
Node: Declaring accounts43499 Node: Declaring accounts43742
Ref: #declaring-accounts43685 Ref: #declaring-accounts43928
Node: Account comments44610 Node: Account comments44853
Ref: #account-comments44773 Ref: #account-comments45016
Node: Account subdirectives45197 Node: Account subdirectives45440
Ref: #account-subdirectives45392 Ref: #account-subdirectives45635
Node: Account types45705 Node: Account types45948
Ref: #account-types45889 Ref: #account-types46132
Node: Account display order47528 Node: Account display order47771
Ref: #account-display-order47698 Ref: #account-display-order47941
Node: Rewriting accounts48849 Node: Rewriting accounts49092
Ref: #rewriting-accounts49034 Ref: #rewriting-accounts49277
Node: Basic aliases49791 Node: Basic aliases50034
Ref: #basic-aliases49937 Ref: #basic-aliases50180
Node: Regex aliases50641 Node: Regex aliases50884
Ref: #regex-aliases50813 Ref: #regex-aliases51056
Node: Combining aliases51531 Node: Combining aliases51774
Ref: #combining-aliases51724 Ref: #combining-aliases51967
Node: Aliases and multiple files53000 Node: Aliases and multiple files53243
Ref: #aliases-and-multiple-files53209 Ref: #aliases-and-multiple-files53452
Node: end aliases53788 Node: end aliases54031
Ref: #end-aliases53945 Ref: #end-aliases54188
Node: Default parent account54046 Node: Default parent account54289
Ref: #default-parent-account54214 Ref: #default-parent-account54457
Node: Periodic transactions55098 Node: Periodic transactions55341
Ref: #periodic-transactions55273 Ref: #periodic-transactions55516
Node: Periodic rule syntax57145 Node: Periodic rule syntax57388
Ref: #periodic-rule-syntax57351 Ref: #periodic-rule-syntax57594
Node: Two spaces between period expression and description!58055 Node: Two spaces between period expression and description!58298
Ref: #two-spaces-between-period-expression-and-description58374 Ref: #two-spaces-between-period-expression-and-description58617
Node: Forecasting with periodic transactions59058 Node: Forecasting with periodic transactions59301
Ref: #forecasting-with-periodic-transactions59363 Ref: #forecasting-with-periodic-transactions59606
Node: Budgeting with periodic transactions61389 Node: Budgeting with periodic transactions61661
Ref: #budgeting-with-periodic-transactions61628 Ref: #budgeting-with-periodic-transactions61900
Node: Auto postings62077 Node: Auto postings62349
Ref: #auto-postings62217 Ref: #auto-postings62489
Node: Auto postings and multiple files64396 Node: Auto postings and multiple files64668
Ref: #auto-postings-and-multiple-files64600 Ref: #auto-postings-and-multiple-files64872
Node: Auto postings and dates64809 Node: Auto postings and dates65081
Ref: #auto-postings-and-dates65083 Ref: #auto-postings-and-dates65355
Node: Auto postings and transaction balancing / inferred amounts / balance assertions65258 Node: Auto postings and transaction balancing / inferred amounts / balance assertions65530
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions65609 Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions65881
Node: Auto posting tags65951 Node: Auto posting tags66223
Ref: #auto-posting-tags66166 Ref: #auto-posting-tags66438
 
End Tag Table End Tag Table

View File

@ -784,14 +784,22 @@ FILE FORMAT
You can pull in the content of additional files by writing an include You can pull in the content of additional files by writing an include
directive, like this: directive, like this:
include path/to/file.journal include FILEPATH
If the path does not begin with a slash, it is relative to the current Only journal files can include, and only journal, timeclock or timedot
file. The include file path may contain common glob patterns (e.g. files can be included (not CSV files, currently).
*).
The include directive can only be used in journal files. It can in- If the file path does not begin with a slash, it is relative to the
clude journal, timeclock or timedot files, but not CSV files. current file's folder.
It may contain glob patterns to match multiple files, eg: include
*.journal.
Or a tilde, meaning home directory: include ~/main.journal.
It may also be prefixed to force a specific file format, overriding the
file extension (as described in hledger.1 -> Input files): include
timedot:~/notes/2020*.md.
Default year Default year
You can set a default year to be used for subsequent dates which don't You can set a default year to be used for subsequent dates which don't
@ -1285,25 +1293,22 @@ FILE FORMAT
pression. pression.
Forecasting with periodic transactions Forecasting with periodic transactions
With the --forecast flag, each periodic transaction rule generates fu- The --forecast flag activates any periodic transaction rules in the
ture transactions recurring at the specified interval. These are not journal. They will generate temporary recurring transactions, which
saved in the journal, but appear in all reports. They will look like are not saved in the journal, but will appear in all reports (eg
normal transactions, but with an extra tag: print). This can be useful for estimating balances into the future, or
experimenting with different scenarios. Or, it can be used as a data
entry aid: describe recurring transactions, and every so often copy the
output of print --forecast into the journal.
o generated-transaction:~ PERIODICEXPR - shows that this was generated These transactions will have an extra tag indicating which periodic
by a periodic transaction rule, and the period rule generated them: generated-transaction:~ PERIODICEXPR. And a simi-
lar, hidden tag (beginning with an underscore) which, because it's
never displayed by print, can be used to match transactions generated
"just now": _generated-transaction:~ PERIODICEXPR.
There is also a hidden tag, with an underscore prefix, which does not Periodic transactions are generated within some forecast period. By
appear in hledger's output: default, this
o _generated-transaction:~ PERIODICEXPR
This can be used to match transactions generated "just now", rather
than generated in the past and saved to the journal.
Forecast transactions start on the first occurrence, and end on the
last occurrence, of their interval within the forecast period. The
forecast period:
o begins on the later of o begins on the later of
@ -1312,26 +1317,22 @@ FILE FORMAT
o the day after the latest normal (non-periodic) transaction in the o the day after the latest normal (non-periodic) transaction in the
journal, or today if there are no normal transactions. journal, or today if there are no normal transactions.
o ends on the report end date if specified with -e/-p/date:, or 180 o ends on the report end date if specified with -e/-p/date:, or 6
days from today. months (180 days) from today.
where "today" means the current date at report time. The "later of" This means that periodic transactions will begin only after the latest
rule ensures that forecast transactions do not overlap normal transac- recorded transaction. And a recorded transaction dated in the future
tions in time; they will begin only after normal transactions end. can prevent generation of periodic transactions. (You can avoid that
by writing the future transaction as a one-time periodic rule instead -
put tilde before the date, eg ~ YYYY-MM-DD ...).
Forecasting can be useful for estimating balances into the future, and Or, you can set your own arbitrary "forecast period", which can overlap
experimenting with different scenarios. Note the start date logic recorded transactions, and need not be in the future, by providing an
means that forecasted transactions are automatically replaced by normal option argument, like --forecast=PERIODEXPR. Note the equals sign is
transactions as you add those. required, a space won't work. PERIODEXPR is a period expression, which
can specify the start date, end date, or both, like in a date: query.
Forecasting can also help with data entry: describe most of your trans- (See also hledger.1 -> Report start & end date). Some examples:
actions with periodic rules, and every so often copy the output of --forecast=202001-202004, --forecast=jan-, --forecast=2020.
print --forecast to the journal.
You can generate one-time transactions too: just write a period expres-
sion specifying a date with no report interval. (You could also write
a normal transaction with a future date, but remember this disables
forecast transactions on previous dates.)
Budgeting with periodic transactions Budgeting with periodic transactions
With the --budget flag, currently supported by the balance command, With the --budget flag, currently supported by the balance command,
@ -1479,4 +1480,4 @@ SEE ALSO
hledger 1.17.99 May 2020 hledger_journal(5) hledger 1.17.99 June 2020 hledger_journal(5)

View File

@ -1,5 +1,5 @@
.TH "hledger_timeclock" "5" "May 2020" "hledger 1.17.99" "hledger User Manuals" .TH "hledger_timeclock" "5" "June 2020" "hledger 1.17.99" "hledger User Manuals"

View File

@ -78,4 +78,4 @@ SEE ALSO
hledger 1.17.99 May 2020 hledger_timeclock(5) hledger 1.17.99 June 2020 hledger_timeclock(5)

View File

@ -1,5 +1,5 @@
.TH "hledger_timedot" "5" "May 2020" "hledger 1.17.99" "hledger User Manuals" .TH "hledger_timedot" "5" "June 2020" "hledger 1.17.99" "hledger User Manuals"

View File

@ -161,4 +161,4 @@ SEE ALSO
hledger 1.17.99 May 2020 hledger_timedot(5) hledger 1.17.99 June 2020 hledger_timedot(5)

View File

@ -4,4 +4,4 @@ m4_dnl Program version. Updated by make setversion.
m4_define({{_version_}}, {{1.17.99}})m4_dnl m4_define({{_version_}}, {{1.17.99}})m4_dnl
m4_dnl m4_dnl
m4_dnl Date to show in man pages. Updated by make setdate. m4_dnl Date to show in man pages. Updated by make setdate.
m4_define({{_monthyear_}}, {{May 2020}})m4_dnl m4_define({{_monthyear_}}, {{June 2020}})m4_dnl

View File

@ -1,5 +1,5 @@
.TH "hledger-ui" "1" "May 2020" "hledger-ui 1.17.99" "hledger User Manuals" .TH "hledger-ui" "1" "June 2020" "hledger-ui 1.17.99" "hledger User Manuals"

View File

@ -441,4 +441,4 @@ SEE ALSO
hledger-ui 1.17.99 May 2020 hledger-ui(1) hledger-ui 1.17.99 June 2020 hledger-ui(1)

View File

@ -4,4 +4,4 @@ m4_dnl Program version. Updated by make setversion.
m4_define({{_version_}}, {{1.17.99}})m4_dnl m4_define({{_version_}}, {{1.17.99}})m4_dnl
m4_dnl m4_dnl
m4_dnl Date to show in man pages. Updated by make setdate. m4_dnl Date to show in man pages. Updated by make setdate.
m4_define({{_monthyear_}}, {{May 2020}})m4_dnl m4_define({{_monthyear_}}, {{June 2020}})m4_dnl

View File

@ -1,5 +1,5 @@
.TH "hledger-web" "1" "May 2020" "hledger-web 1.17.99" "hledger User Manuals" .TH "hledger-web" "1" "June 2020" "hledger-web 1.17.99" "hledger User Manuals"

View File

@ -533,4 +533,4 @@ SEE ALSO
hledger-web 1.17.99 May 2020 hledger-web(1) hledger-web 1.17.99 June 2020 hledger-web(1)

View File

@ -4,4 +4,4 @@ m4_dnl Program version. Updated by make setversion.
m4_define({{_version_}}, {{1.17.99}})m4_dnl m4_define({{_version_}}, {{1.17.99}})m4_dnl
m4_dnl m4_dnl
m4_dnl Date to show in man pages. Updated by make setdate. m4_dnl Date to show in man pages. Updated by make setdate.
m4_define({{_monthyear_}}, {{May 2020}})m4_dnl m4_define({{_monthyear_}}, {{June 2020}})m4_dnl

View File

@ -1,6 +1,6 @@
.\"t .\"t
.TH "hledger" "1" "May 2020" "hledger 1.17.99" "hledger User Manuals" .TH "hledger" "1" "June 2020" "hledger 1.17.99" "hledger User Manuals"
@ -1101,15 +1101,6 @@ To understand the JSON, read the Haskell type definitions, which are
mostly in mostly in
https://github.com/simonmichael/hledger/blob/master/hledger-lib/Hledger/Data/Types.hs. https://github.com/simonmichael/hledger/blob/master/hledger-lib/Hledger/Data/Types.hs.
.IP \[bu] 2 .IP \[bu] 2
The JSON output from hledger commands is essentially the same as the
JSON served by hledger-web\[aq]s JSON API, but pretty printed, using
line breaks and indentation.
Our pretty printer has the ability to elide data in certain cases -
rendering non-strings as if they were strings, or displaying
\[dq]FOO..\[dq] instead of FOO\[aq]s full details.
This should never happen in hledger\[aq]s JSON output; if you see
otherwise, please report as a bug.
.IP \[bu] 2
hledger represents quantities as Decimal values storing up to 255 hledger represents quantities as Decimal values storing up to 255
significant digits, eg for repeating decimals. significant digits, eg for repeating decimals.
Such numbers can arise in practice (from automatically-calculated Such numbers can arise in practice (from automatically-calculated
@ -1298,7 +1289,7 @@ Examples:
.PP .PP
.TS .TS
tab(@); tab(@);
lw(11.9n) lw(58.1n). lw(12.4n) lw(57.6n).
T{ T{
\f[C]-b 2016/3/17\f[R] \f[C]-b 2016/3/17\f[R]
T}@T{ T}@T{
@ -1321,16 +1312,17 @@ T}@T{
all transactions in the current month all transactions in the current month
T} T}
T{ T{
\f[C]date:2016/3/17-\f[R] \f[C]date:2016/3/17..\f[R]
T}@T{ T}@T{
the above written as queries instead the above written as queries instead (\f[C]..\f[R] can also be replaced
with \f[C]-\f[R])
T} T}
T{ T{
\f[C]date:-12/1\f[R] \f[C]date:..12/1\f[R]
T}@T{ T}@T{
T} T}
T{ T{
\f[C]date:thismonth-\f[R] \f[C]date:thismonth..\f[R]
T}@T{ T}@T{
T} T}
T{ T{
@ -1362,7 +1354,7 @@ exclusive:
.PP .PP
Keywords like \[dq]from\[dq] and \[dq]to\[dq] are optional, and so are Keywords like \[dq]from\[dq] and \[dq]to\[dq] are optional, and so are
the spaces, as long as you don\[aq]t run two dates together. the spaces, as long as you don\[aq]t run two dates together.
\[dq]to\[dq] can also be written as \[dq]-\[dq]. \[dq]to\[dq] can also be written as \[dq]..\[dq] or \[dq]-\[dq].
These are equivalent to the above: These are equivalent to the above:
.PP .PP
.TS .TS
@ -1375,7 +1367,7 @@ T{
\f[C]-p2009/1/1to2009/4/1\f[R] \f[C]-p2009/1/1to2009/4/1\f[R]
T} T}
T{ T{
\f[C]-p2009/1/1-2009/4/1\f[R] \f[C]-p2009/1/1..2009/4/1\f[R]
T} T}
.TE .TE
.PP .PP
@ -1602,8 +1594,7 @@ like account, balance and register will show only the uppermost accounts
in the account tree, down to level N. in the account tree, down to level N.
Use this when you want a summary with less detail. Use this when you want a summary with less detail.
This flag has the same effect as a \f[C]depth:\f[R] query argument (so This flag has the same effect as a \f[C]depth:\f[R] query argument (so
\f[C]-2\f[R], \f[C]--depth=2\f[R] or \f[C]depth:2\f[R] are basically \f[C]-2\f[R], \f[C]--depth=2\f[R] or \f[C]depth:2\f[R] are equivalent).
equivalent).
.SS Pivoting .SS Pivoting
.PP .PP
Normally hledger sums amounts, and organizes them in a hierarchy, based Normally hledger sums amounts, and organizes them in a hierarchy, based

View File

@ -1021,14 +1021,6 @@ $ hledger balancesheet -o foo.txt -O html # write HTML to foo.txt
JSON, read the Haskell type definitions, which are mostly in JSON, read the Haskell type definitions, which are mostly in
https://github.com/simonmichael/hledger/blob/master/hledger-lib/Hledger/Data/Types.hs. https://github.com/simonmichael/hledger/blob/master/hledger-lib/Hledger/Data/Types.hs.
* The JSON output from hledger commands is essentially the same as
the JSON served by hledger-web's JSON API, but pretty printed,
using line breaks and indentation. Our pretty printer has the
ability to elide data in certain cases - rendering non-strings as
if they were strings, or displaying "FOO.." instead of FOO's full
details. This should never happen in hledger's JSON output; if you
see otherwise, please report as a bug.
* hledger represents quantities as Decimal values storing up to 255 * hledger represents quantities as Decimal values storing up to 255
significant digits, eg for repeating decimals. Such numbers can significant digits, eg for repeating decimals. Such numbers can
arise in practice (from automatically-calculated transaction arise in practice (from automatically-calculated transaction
@ -1159,9 +1151,10 @@ these accept the smart date syntax.
thismonth' thismonth'
'-p all transactions in the current month '-p all transactions in the current month
thismonth' thismonth'
'date:2016/3/17-'the above written as queries instead 'date:2016/3/17..'the above written as queries instead ('..' can also be
'date:-12/1' replaced with '-')
'date:thismonth-' 'date:..12/1'
'date:thismonth..'
'date:thismonth' 'date:thismonth'
 
@ -1194,11 +1187,11 @@ dates as exclusive:
Keywords like "from" and "to" are optional, and so are the spaces, as Keywords like "from" and "to" are optional, and so are the spaces, as
long as you don't run two dates together. "to" can also be written as long as you don't run two dates together. "to" can also be written as
"-". These are equivalent to the above: ".." or "-". These are equivalent to the above:
'-p "2009/1/1 2009/4/1"' '-p "2009/1/1 2009/4/1"'
'-p2009/1/1to2009/4/1' '-p2009/1/1to2009/4/1'
'-p2009/1/1-2009/4/1' '-p2009/1/1..2009/4/1'
Dates are smart dates, so if the current year is 2009, the above can Dates are smart dates, so if the current year is 2009, the above can
also be written as: also be written as:
@ -1305,7 +1298,7 @@ With the '--depth N' option (short form: '-N'), commands like account,
balance and register will show only the uppermost accounts in the balance and register will show only the uppermost accounts in the
account tree, down to level N. Use this when you want a summary with account tree, down to level N. Use this when you want a summary with
less detail. This flag has the same effect as a 'depth:' query argument less detail. This flag has the same effect as a 'depth:' query argument
(so '-2', '--depth=2' or 'depth:2' are basically equivalent). (so '-2', '--depth=2' or 'depth:2' are equivalent).
 
File: hledger.info, Node: Pivoting, Next: Valuation, Prev: Depth limiting, Up: OPTIONS File: hledger.info, Node: Pivoting, Next: Valuation, Prev: Depth limiting, Up: OPTIONS
@ -3827,143 +3820,143 @@ Node: Output destination31999
Ref: #output-destination32151 Ref: #output-destination32151
Node: Output format32576 Node: Output format32576
Ref: #output-format32726 Ref: #output-format32726
Node: Regular expressions34774 Node: Regular expressions34308
Ref: #regular-expressions34931 Ref: #regular-expressions34465
Node: Smart dates36667 Node: Smart dates36201
Ref: #smart-dates36818 Ref: #smart-dates36352
Node: Report start & end date38179 Node: Report start & end date37713
Ref: #report-start-end-date38351 Ref: #report-start-end-date37885
Node: Report intervals39789 Node: Report intervals39382
Ref: #report-intervals39954 Ref: #report-intervals39547
Node: Period expressions40344 Node: Period expressions39937
Ref: #period-expressions40504 Ref: #period-expressions40097
Node: Depth limiting44630 Node: Depth limiting44233
Ref: #depth-limiting44774 Ref: #depth-limiting44377
Node: Pivoting45116 Node: Pivoting44709
Ref: #pivoting45239 Ref: #pivoting44832
Node: Valuation46915 Node: Valuation46508
Ref: #valuation47017 Ref: #valuation46610
Node: -B Cost47937 Node: -B Cost47530
Ref: #b-cost48041 Ref: #b-cost47634
Node: -V Value48213 Node: -V Value47806
Ref: #v-value48366 Ref: #v-value47959
Node: -X Market value in specified commodity49639 Node: -X Market value in specified commodity49232
Ref: #x-market-value-in-specified-commodity49858 Ref: #x-market-value-in-specified-commodity49451
Node: Market prices50036 Node: Market prices49629
Ref: #market-prices50221 Ref: #market-prices49814
Node: --value Flexible valuation51146 Node: --value Flexible valuation50739
Ref: #value-flexible-valuation51347 Ref: #value-flexible-valuation50940
Node: Effect of --value on reports55852 Node: Effect of --value on reports55445
Ref: #effect-of---value-on-reports56033 Ref: #effect-of---value-on-reports55626
Node: COMMANDS61579 Node: COMMANDS61172
Ref: #commands61687 Ref: #commands61280
Node: accounts62771 Node: accounts62364
Ref: #accounts62869 Ref: #accounts62462
Node: activity63568 Node: activity63161
Ref: #activity63678 Ref: #activity63271
Node: add64061 Node: add63654
Ref: #add64160 Ref: #add63753
Node: balance66899 Node: balance66492
Ref: #balance67010 Ref: #balance66603
Node: Classic balance report68468 Node: Classic balance report68061
Ref: #classic-balance-report68641 Ref: #classic-balance-report68234
Node: Customising the classic balance report70010 Node: Customising the classic balance report69603
Ref: #customising-the-classic-balance-report70238 Ref: #customising-the-classic-balance-report69831
Node: Colour support72314 Node: Colour support71907
Ref: #colour-support72481 Ref: #colour-support72074
Node: Flat mode72654 Node: Flat mode72247
Ref: #flat-mode72802 Ref: #flat-mode72395
Node: Depth limited balance reports73215 Node: Depth limited balance reports72808
Ref: #depth-limited-balance-reports73400 Ref: #depth-limited-balance-reports72993
Node: Percentages73856 Node: Percentages73449
Ref: #percentages74022 Ref: #percentages73615
Node: Multicolumn balance report75159 Node: Multicolumn balance report74752
Ref: #multicolumn-balance-report75339 Ref: #multicolumn-balance-report74932
Node: Budget report80601 Node: Budget report80194
Ref: #budget-report80744 Ref: #budget-report80337
Node: Nested budgets86010 Node: Nested budgets85603
Ref: #nested-budgets86122 Ref: #nested-budgets85715
Ref: #output-format-189603 Ref: #output-format-189196
Node: balancesheet89800 Node: balancesheet89393
Ref: #balancesheet89936 Ref: #balancesheet89529
Node: balancesheetequity91402 Node: balancesheetequity90995
Ref: #balancesheetequity91551 Ref: #balancesheetequity91144
Node: cashflow92274 Node: cashflow91867
Ref: #cashflow92402 Ref: #cashflow91995
Node: check-dates93581 Node: check-dates93174
Ref: #check-dates93708 Ref: #check-dates93301
Node: check-dupes93987 Node: check-dupes93580
Ref: #check-dupes94111 Ref: #check-dupes93704
Node: close94404 Node: close93997
Ref: #close94518 Ref: #close94111
Node: close usage96040 Node: close usage95633
Ref: #close-usage96133 Ref: #close-usage95726
Node: commodities98946 Node: commodities98539
Ref: #commodities99073 Ref: #commodities98666
Node: descriptions99155 Node: descriptions98748
Ref: #descriptions99283 Ref: #descriptions98876
Node: diff99464 Node: diff99057
Ref: #diff99570 Ref: #diff99163
Node: files100617 Node: files100210
Ref: #files100717 Ref: #files100310
Node: help100864 Node: help100457
Ref: #help100964 Ref: #help100557
Node: import102045 Node: import101638
Ref: #import102159 Ref: #import101752
Node: Importing balance assignments103052 Node: Importing balance assignments102645
Ref: #importing-balance-assignments103200 Ref: #importing-balance-assignments102793
Node: incomestatement103849 Node: incomestatement103442
Ref: #incomestatement103982 Ref: #incomestatement103575
Node: notes105469 Node: notes105062
Ref: #notes105582 Ref: #notes105175
Node: payees105708 Node: payees105301
Ref: #payees105814 Ref: #payees105407
Node: prices105972 Node: prices105565
Ref: #prices106078 Ref: #prices105671
Node: print106419 Node: print106012
Ref: #print106529 Ref: #print106122
Node: print-unique111315 Node: print-unique110908
Ref: #print-unique111441 Ref: #print-unique111034
Node: register111726 Node: register111319
Ref: #register111853 Ref: #register111446
Node: Custom register output116025 Node: Custom register output115618
Ref: #custom-register-output116154 Ref: #custom-register-output115747
Node: register-match117491 Node: register-match117084
Ref: #register-match117625 Ref: #register-match117218
Node: rewrite117976 Node: rewrite117569
Ref: #rewrite118091 Ref: #rewrite117684
Node: Re-write rules in a file119946 Node: Re-write rules in a file119539
Ref: #re-write-rules-in-a-file120080 Ref: #re-write-rules-in-a-file119673
Node: Diff output format121290 Node: Diff output format120883
Ref: #diff-output-format121459 Ref: #diff-output-format121052
Node: rewrite vs print --auto122551 Node: rewrite vs print --auto122144
Ref: #rewrite-vs.-print---auto122730 Ref: #rewrite-vs.-print---auto122323
Node: roi123286 Node: roi122879
Ref: #roi123384 Ref: #roi122977
Node: stats124396 Node: stats123989
Ref: #stats124495 Ref: #stats124088
Node: tags125283 Node: tags124876
Ref: #tags125381 Ref: #tags124974
Node: test125675 Node: test125268
Ref: #test125783 Ref: #test125376
Node: Add-on commands126530 Node: Add-on commands126123
Ref: #add-on-commands126647 Ref: #add-on-commands126240
Node: ui127990 Node: ui127583
Ref: #ui128078 Ref: #ui127671
Node: web128132 Node: web127725
Ref: #web128235 Ref: #web127828
Node: iadd128351 Node: iadd127944
Ref: #iadd128462 Ref: #iadd128055
Node: interest128544 Node: interest128137
Ref: #interest128651 Ref: #interest128244
Node: ENVIRONMENT128891 Node: ENVIRONMENT128484
Ref: #environment129003 Ref: #environment128596
Node: FILES129832 Node: FILES129425
Ref: #files-1129935 Ref: #files-1129528
Node: LIMITATIONS130148 Node: LIMITATIONS129741
Ref: #limitations130267 Ref: #limitations129860
Node: TROUBLESHOOTING131009 Node: TROUBLESHOOTING130602
Ref: #troubleshooting131122 Ref: #troubleshooting130715
 
End Tag Table End Tag Table

View File

@ -868,14 +868,6 @@ OPTIONS
https://github.com/simonmichael/hledger/blob/master/hledger- https://github.com/simonmichael/hledger/blob/master/hledger-
lib/Hledger/Data/Types.hs. lib/Hledger/Data/Types.hs.
o The JSON output from hledger commands is essentially the same as the
JSON served by hledger-web's JSON API, but pretty printed, using line
breaks and indentation. Our pretty printer has the ability to elide
data in certain cases - rendering non-strings as if they were
strings, or displaying "FOO.." instead of FOO's full details. This
should never happen in hledger's JSON output; if you see otherwise,
please report as a bug.
o hledger represents quantities as Decimal values storing up to 255 o hledger represents quantities as Decimal values storing up to 255
significant digits, eg for repeating decimals. Such numbers can significant digits, eg for repeating decimals. Such numbers can
arise in practice (from automatically-calculated transaction prices), arise in practice (from automatically-calculated transaction prices),
@ -942,6 +934,7 @@ OPTIONS
2004/10/1, 2004-01-01, exact date, several separators allowed. Year 2004/10/1, 2004-01-01, exact date, several separators allowed. Year
2004.9.1 is 4+ digits, month is 1-12, day is 1-31 2004.9.1 is 4+ digits, month is 1-12, day is 1-31
2004 start of year 2004 start of year
2004/10 start of month 2004/10 start of month
10/1 month and day in current year 10/1 month and day in current year
21 day in current month 21 day in current month
@ -995,9 +988,10 @@ OPTIONS
(11/30 will be the last date included) (11/30 will be the last date included)
-b thismonth all transactions on or after the 1st of the current month -b thismonth all transactions on or after the 1st of the current month
-p thismonth all transactions in the current month -p thismonth all transactions in the current month
date:2016/3/17- the above written as queries instead date:2016/3/17.. the above written as queries instead (.. can also be re-
date:-12/1 placed with -)
date:thismonth- date:..12/1
date:thismonth..
date:thismonth date:thismonth
Report intervals Report intervals
@ -1020,11 +1014,11 @@ OPTIONS
Keywords like "from" and "to" are optional, and so are the spaces, as Keywords like "from" and "to" are optional, and so are the spaces, as
long as you don't run two dates together. "to" can also be written as long as you don't run two dates together. "to" can also be written as
"-". These are equivalent to the above: ".." or "-". These are equivalent to the above:
-p "2009/1/1 2009/4/1" -p "2009/1/1 2009/4/1"
-p2009/1/1to2009/4/1 -p2009/1/1to2009/4/1
-p2009/1/1-2009/4/1 -p2009/1/1..2009/4/1
Dates are smart dates, so if the current year is 2009, the above can Dates are smart dates, so if the current year is 2009, the above can
also be written as: also be written as:
@ -1130,7 +1124,7 @@ OPTIONS
ance and register will show only the uppermost accounts in the account ance and register will show only the uppermost accounts in the account
tree, down to level N. Use this when you want a summary with less de- tree, down to level N. Use this when you want a summary with less de-
tail. This flag has the same effect as a depth: query argument (so -2, tail. This flag has the same effect as a depth: query argument (so -2,
--depth=2 or depth:2 are basically equivalent). --depth=2 or depth:2 are equivalent).
Pivoting Pivoting
Normally hledger sums amounts, and organizes them in a hierarchy, based Normally hledger sums amounts, and organizes them in a hierarchy, based
@ -1477,8 +1471,6 @@ OPTIONS
amounts terval, val- amounts terval, val-
(with report ued at inter- (with report ued at inter-
interval) val start interval) val start
running to- sum/average sum/average sum/average sum/average sum/average running to- sum/average sum/average sum/average sum/average sum/average
tal/average of displayed of displayed of displayed of displayed of displayed tal/average of displayed of displayed of displayed of displayed of displayed
values values values values values values values values values values
@ -1500,6 +1492,9 @@ OPTIONS
(with report postings be- fore report fore report report start (with report postings be- fore report fore report report start
interval and fore report start start interval and fore report start start
-H) start -H) start
budget like bal- like bal- not supported like bal- like balances budget like bal- like bal- not supported like bal- like balances
amounts with ances ances ances amounts with ances ances ances
--budget --budget
@ -3236,4 +3231,4 @@ SEE ALSO
hledger 1.17.99 May 2020 hledger(1) hledger 1.17.99 June 2020 hledger(1)