;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_dnl
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
.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
.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
.nf
\f[C]
include path/to/file.journal
include FILEPATH
\f[R]
.fi
.PP
If the path does not begin with a slash, it is relative to the current
file.
The include file path may contain common glob patterns (e.g.
\f[C]*\f[R]).
Only journal files can include, and only journal, timeclock or timedot
files can be included (not CSV files, currently).
.PP
The \f[C]include\f[R] directive can only be used in journal files.
It can include journal, timeclock or timedot files, but not CSV files.
If the file path does not begin with a slash, it is relative to the
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
.PP
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.
.SS Forecasting with periodic transactions
.PP
With the \f[C]--forecast\f[R] flag, each periodic transaction rule
generates future transactions recurring at the specified interval.
These are not saved in the journal, but appear in all reports.
They will look like normal transactions, but with an extra tag:
.IP \[bu] 2
\f[C]generated-transaction:\[ti] PERIODICEXPR\f[R] - shows that this was
generated by a periodic transaction rule, and the period
The \f[C]--forecast\f[R] flag activates any periodic transaction rules
in the journal.
They will generate temporary recurring transactions, which are not saved
in the journal, but will appear in all reports (eg 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 \f[C]print --forecast\f[R] into
the journal.
.PP
There is also a hidden tag, with an underscore prefix, which does not
appear in hledger\[aq]s output:
.IP \[bu] 2
\f[C]_generated-transaction:\[ti] PERIODICEXPR\f[R]
These transactions will have an extra tag indicating which periodic rule
generated them: \f[C]generated-transaction:\[ti] PERIODICEXPR\f[R].
And a similar, hidden tag (beginning with an underscore) which, because
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
This can be used to match transactions generated \[dq]just now\[dq],
rather than generated in the past and saved to the journal.
.PP
Forecast transactions start on the first occurrence, and end on the last
occurrence, of their interval within the forecast period.
The forecast period:
Periodic transactions are generated within some forecast period.
By default, this
.IP \[bu] 2
begins on the later of
.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.
.RE
.IP \[bu] 2
ends on the report end date if specified with -e/-p/date:, or 180 days
from today.
ends on the report end date if specified with -e/-p/date:, or 6 months
(180 days) from today.
.PP
where \[dq]today\[dq] means the current date at report time.
The \[dq]later of\[dq] rule ensures that forecast transactions do not
overlap normal transactions in time; they will begin only after normal
transactions end.
This means that periodic transactions will begin only after the latest
recorded transaction.
And a recorded transaction dated in the future 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
\f[C]\[ti] YYYY-MM-DD ...\f[R]).
.PP
Forecasting can be useful for estimating balances into the future, and
experimenting with different scenarios.
Note the start date logic means that forecasted transactions are
automatically replaced by normal transactions as you add those.
.PP
Forecasting can also help with data entry: describe most of your
transactions with periodic rules, and every so often copy the output of
\f[C]print --forecast\f[R] to the journal.
.PP
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.)
Or, you can set your own arbitrary \[dq]forecast period\[dq], which can
overlap recorded transactions, and need not be in the future, by
providing an option argument, like \f[C]--forecast=PERIODEXPR\f[R].
Note the equals sign is required, a space won\[aq]t work.
PERIODEXPR is a period expression, which can specify the start date, end
date, or both, like in a \f[C]date:\f[R] query.
(See also hledger.1 -> Report start & end date).
Some examples: \f[C]--forecast=202001-202004\f[R],
\f[C]--forecast=jan-\f[R], \f[C]--forecast=2020\f[R].
.SS Budgeting with periodic transactions
.PP
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
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 file. The include file path may contain common glob patterns
(e.g. '*').
Only journal files can include, and only journal, timeclock or
timedot files can be included (not CSV files, currently).
The 'include' directive can only be used in journal files. It can
include journal, timeclock or timedot files, but not CSV files.
If the file path does not begin with a slash, it is relative to the
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
@ -1620,52 +1628,45 @@ File: hledger_journal.info, Node: Forecasting with periodic transactions, Next
1.14.3 Forecasting with periodic transactions
---------------------------------------------
With the '--forecast' flag, each periodic transaction rule generates
future transactions recurring at the specified interval. These are not
saved in the journal, but appear in all reports. They will look like
normal transactions, but with an extra tag:
The '--forecast' flag activates any periodic transaction rules in the
journal. They will generate temporary recurring transactions, which are
not saved in the journal, but will appear in all reports (eg 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.
* 'generated-transaction:~ PERIODICEXPR' - shows that this was
generated by a periodic transaction rule, and the period
These transactions will have an extra tag indicating which periodic
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
appear in hledger's output:
* '_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:
Periodic transactions are generated within some forecast period. By
default, this
* begins on the later of
* the report start date if specified with -b/-p/date:
* the day after the latest normal (non-periodic) transaction in
the journal, or today if there are no normal transactions.
* ends on the report end date if specified with -e/-p/date:, or 180
days from today.
* ends on the report end date if specified with -e/-p/date:, or 6
months (180 days) from today.
where "today" means the current date at report time. The "later of"
rule ensures that forecast transactions do not overlap normal
transactions in time; they will begin only after normal transactions
end.
This means that periodic transactions will begin only after the
latest recorded transaction. And a recorded transaction dated in the
future 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 experimenting with different scenarios. Note the start date logic
means that forecasted transactions are automatically replaced by normal
transactions as you add those.
Forecasting can also help with data entry: describe most of your
transactions with periodic rules, and every so often copy the output of
'print --forecast' to the journal.
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.)
Or, you can set your own arbitrary "forecast period", which can
overlap recorded transactions, and need not be in the future, by
providing an option argument, like '--forecast=PERIODEXPR'. Note the
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
a 'date:' query. (See also hledger.1 -> Report start & end date). Some
examples: '--forecast=202001-202004', '--forecast=jan-',
'--forecast=2020'.

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
Node: Including other files38219
Ref: #including-other-files38399
Node: Default year38807
Ref: #default-year38976
Node: Declaring commodities39383
Ref: #declaring-commodities39566
Node: Default commodity41372
Ref: #default-commodity41558
Node: Declaring market prices42447
Ref: #declaring-market-prices42642
Node: Declaring accounts43499
Ref: #declaring-accounts43685
Node: Account comments44610
Ref: #account-comments44773
Node: Account subdirectives45197
Ref: #account-subdirectives45392
Node: Account types45705
Ref: #account-types45889
Node: Account display order47528
Ref: #account-display-order47698
Node: Rewriting accounts48849
Ref: #rewriting-accounts49034
Node: Basic aliases49791
Ref: #basic-aliases49937
Node: Regex aliases50641
Ref: #regex-aliases50813
Node: Combining aliases51531
Ref: #combining-aliases51724
Node: Aliases and multiple files53000
Ref: #aliases-and-multiple-files53209
Node: end aliases53788
Ref: #end-aliases53945
Node: Default parent account54046
Ref: #default-parent-account54214
Node: Periodic transactions55098
Ref: #periodic-transactions55273
Node: Periodic rule syntax57145
Ref: #periodic-rule-syntax57351
Node: Two spaces between period expression and description!58055
Ref: #two-spaces-between-period-expression-and-description58374
Node: Forecasting with periodic transactions59058
Ref: #forecasting-with-periodic-transactions59363
Node: Budgeting with periodic transactions61389
Ref: #budgeting-with-periodic-transactions61628
Node: Auto postings62077
Ref: #auto-postings62217
Node: Auto postings and multiple files64396
Ref: #auto-postings-and-multiple-files64600
Node: Auto postings and dates64809
Ref: #auto-postings-and-dates65083
Node: Auto postings and transaction balancing / inferred amounts / balance assertions65258
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions65609
Node: Auto posting tags65951
Ref: #auto-posting-tags66166
Node: Default year39050
Ref: #default-year39219
Node: Declaring commodities39626
Ref: #declaring-commodities39809
Node: Default commodity41615
Ref: #default-commodity41801
Node: Declaring market prices42690
Ref: #declaring-market-prices42885
Node: Declaring accounts43742
Ref: #declaring-accounts43928
Node: Account comments44853
Ref: #account-comments45016
Node: Account subdirectives45440
Ref: #account-subdirectives45635
Node: Account types45948
Ref: #account-types46132
Node: Account display order47771
Ref: #account-display-order47941
Node: Rewriting accounts49092
Ref: #rewriting-accounts49277
Node: Basic aliases50034
Ref: #basic-aliases50180
Node: Regex aliases50884
Ref: #regex-aliases51056
Node: Combining aliases51774
Ref: #combining-aliases51967
Node: Aliases and multiple files53243
Ref: #aliases-and-multiple-files53452
Node: end aliases54031
Ref: #end-aliases54188
Node: Default parent account54289
Ref: #default-parent-account54457
Node: Periodic transactions55341
Ref: #periodic-transactions55516
Node: Periodic rule syntax57388
Ref: #periodic-rule-syntax57594
Node: Two spaces between period expression and description!58298
Ref: #two-spaces-between-period-expression-and-description58617
Node: Forecasting with periodic transactions59301
Ref: #forecasting-with-periodic-transactions59606
Node: Budgeting with periodic transactions61661
Ref: #budgeting-with-periodic-transactions61900
Node: Auto postings62349
Ref: #auto-postings62489
Node: Auto postings and multiple files64668
Ref: #auto-postings-and-multiple-files64872
Node: Auto postings and dates65081
Ref: #auto-postings-and-dates65355
Node: Auto postings and transaction balancing / inferred amounts / balance assertions65530
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions65881
Node: Auto posting tags66223
Ref: #auto-posting-tags66438

End Tag Table

View File

@ -784,14 +784,22 @@ FILE FORMAT
You can pull in the content of additional files by writing an include
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
file. The include file path may contain common glob patterns (e.g.
*).
Only journal files can include, and only journal, timeclock or timedot
files can be included (not CSV files, currently).
The include directive can only be used in journal files. It can in-
clude journal, timeclock or timedot files, but not CSV files.
If the file path does not begin with a slash, it is relative to the
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
You can set a default year to be used for subsequent dates which don't
@ -1285,25 +1293,22 @@ FILE FORMAT
pression.
Forecasting with periodic transactions
With the --forecast flag, each periodic transaction rule generates fu-
ture transactions recurring at the specified interval. These are not
saved in the journal, but appear in all reports. They will look like
normal transactions, but with an extra tag:
The --forecast flag activates any periodic transaction rules in the
journal. They will generate temporary recurring transactions, which
are not saved in the journal, but will appear in all reports (eg
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
by a periodic transaction rule, and the period
These transactions will have an extra tag indicating which periodic
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
appear in hledger's output:
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:
Periodic transactions are generated within some forecast period. By
default, this
o begins on the later of
@ -1312,26 +1317,22 @@ FILE FORMAT
o the day after the latest normal (non-periodic) transaction in the
journal, or today if there are no normal transactions.
o ends on the report end date if specified with -e/-p/date:, or 180
days from today.
o ends on the report end date if specified with -e/-p/date:, or 6
months (180 days) from today.
where "today" means the current date at report time. The "later of"
rule ensures that forecast transactions do not overlap normal transac-
tions in time; they will begin only after normal transactions end.
This means that periodic transactions will begin only after the latest
recorded transaction. And a recorded transaction dated in the future
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
experimenting with different scenarios. Note the start date logic
means that forecasted transactions are automatically replaced by normal
transactions as you add those.
Forecasting can also help with data entry: describe most of your trans-
actions with periodic rules, and every so often copy the output of
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.)
Or, you can set your own arbitrary "forecast period", which can overlap
recorded transactions, and need not be in the future, by providing an
option argument, like --forecast=PERIODEXPR. Note the 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 a date: query.
(See also hledger.1 -> Report start & end date). Some examples:
--forecast=202001-202004, --forecast=jan-, --forecast=2020.
Budgeting with periodic transactions
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_dnl
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_dnl
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_dnl
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
.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
https://github.com/simonmichael/hledger/blob/master/hledger-lib/Hledger/Data/Types.hs.
.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
significant digits, eg for repeating decimals.
Such numbers can arise in practice (from automatically-calculated
@ -1298,7 +1289,7 @@ Examples:
.PP
.TS
tab(@);
lw(11.9n) lw(58.1n).
lw(12.4n) lw(57.6n).
T{
\f[C]-b 2016/3/17\f[R]
T}@T{
@ -1321,16 +1312,17 @@ T}@T{
all transactions in the current month
T}
T{
\f[C]date:2016/3/17-\f[R]
\f[C]date:2016/3/17..\f[R]
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{
\f[C]date:-12/1\f[R]
\f[C]date:..12/1\f[R]
T}@T{
T}
T{
\f[C]date:thismonth-\f[R]
\f[C]date:thismonth..\f[R]
T}@T{
T}
T{
@ -1362,7 +1354,7 @@ exclusive:
.PP
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.
\[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:
.PP
.TS
@ -1375,7 +1367,7 @@ T{
\f[C]-p2009/1/1to2009/4/1\f[R]
T}
T{
\f[C]-p2009/1/1-2009/4/1\f[R]
\f[C]-p2009/1/1..2009/4/1\f[R]
T}
.TE
.PP
@ -1602,8 +1594,7 @@ like account, 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 less detail.
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
equivalent).
\f[C]-2\f[R], \f[C]--depth=2\f[R] or \f[C]depth:2\f[R] are equivalent).
.SS Pivoting
.PP
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
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
significant digits, eg for repeating decimals. Such numbers can
arise in practice (from automatically-calculated transaction
@ -1159,9 +1151,10 @@ these accept the smart date syntax.
thismonth'
'-p all transactions in the current month
thismonth'
'date:2016/3/17-'the above written as queries instead
'date:-12/1'
'date:thismonth-'
'date:2016/3/17..'the above written as queries instead ('..' can also be
replaced with '-')
'date:..12/1'
'date:thismonth..'
'date:thismonth'

@ -1194,11 +1187,11 @@ dates as exclusive:
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
"-". These are equivalent to the above:
".." or "-". These are equivalent to the above:
'-p "2009/1/1 2009/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
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
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
(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
@ -3827,143 +3820,143 @@ Node: Output destination31999
Ref: #output-destination32151
Node: Output format32576
Ref: #output-format32726
Node: Regular expressions34774
Ref: #regular-expressions34931
Node: Smart dates36667
Ref: #smart-dates36818
Node: Report start & end date38179
Ref: #report-start-end-date38351
Node: Report intervals39789
Ref: #report-intervals39954
Node: Period expressions40344
Ref: #period-expressions40504
Node: Depth limiting44630
Ref: #depth-limiting44774
Node: Pivoting45116
Ref: #pivoting45239
Node: Valuation46915
Ref: #valuation47017
Node: -B Cost47937
Ref: #b-cost48041
Node: -V Value48213
Ref: #v-value48366
Node: -X Market value in specified commodity49639
Ref: #x-market-value-in-specified-commodity49858
Node: Market prices50036
Ref: #market-prices50221
Node: --value Flexible valuation51146
Ref: #value-flexible-valuation51347
Node: Effect of --value on reports55852
Ref: #effect-of---value-on-reports56033
Node: COMMANDS61579
Ref: #commands61687
Node: accounts62771
Ref: #accounts62869
Node: activity63568
Ref: #activity63678
Node: add64061
Ref: #add64160
Node: balance66899
Ref: #balance67010
Node: Classic balance report68468
Ref: #classic-balance-report68641
Node: Customising the classic balance report70010
Ref: #customising-the-classic-balance-report70238
Node: Colour support72314
Ref: #colour-support72481
Node: Flat mode72654
Ref: #flat-mode72802
Node: Depth limited balance reports73215
Ref: #depth-limited-balance-reports73400
Node: Percentages73856
Ref: #percentages74022
Node: Multicolumn balance report75159
Ref: #multicolumn-balance-report75339
Node: Budget report80601
Ref: #budget-report80744
Node: Nested budgets86010
Ref: #nested-budgets86122
Ref: #output-format-189603
Node: balancesheet89800
Ref: #balancesheet89936
Node: balancesheetequity91402
Ref: #balancesheetequity91551
Node: cashflow92274
Ref: #cashflow92402
Node: check-dates93581
Ref: #check-dates93708
Node: check-dupes93987
Ref: #check-dupes94111
Node: close94404
Ref: #close94518
Node: close usage96040
Ref: #close-usage96133
Node: commodities98946
Ref: #commodities99073
Node: descriptions99155
Ref: #descriptions99283
Node: diff99464
Ref: #diff99570
Node: files100617
Ref: #files100717
Node: help100864
Ref: #help100964
Node: import102045
Ref: #import102159
Node: Importing balance assignments103052
Ref: #importing-balance-assignments103200
Node: incomestatement103849
Ref: #incomestatement103982
Node: notes105469
Ref: #notes105582
Node: payees105708
Ref: #payees105814
Node: prices105972
Ref: #prices106078
Node: print106419
Ref: #print106529
Node: print-unique111315
Ref: #print-unique111441
Node: register111726
Ref: #register111853
Node: Custom register output116025
Ref: #custom-register-output116154
Node: register-match117491
Ref: #register-match117625
Node: rewrite117976
Ref: #rewrite118091
Node: Re-write rules in a file119946
Ref: #re-write-rules-in-a-file120080
Node: Diff output format121290
Ref: #diff-output-format121459
Node: rewrite vs print --auto122551
Ref: #rewrite-vs.-print---auto122730
Node: roi123286
Ref: #roi123384
Node: stats124396
Ref: #stats124495
Node: tags125283
Ref: #tags125381
Node: test125675
Ref: #test125783
Node: Add-on commands126530
Ref: #add-on-commands126647
Node: ui127990
Ref: #ui128078
Node: web128132
Ref: #web128235
Node: iadd128351
Ref: #iadd128462
Node: interest128544
Ref: #interest128651
Node: ENVIRONMENT128891
Ref: #environment129003
Node: FILES129832
Ref: #files-1129935
Node: LIMITATIONS130148
Ref: #limitations130267
Node: TROUBLESHOOTING131009
Ref: #troubleshooting131122
Node: Regular expressions34308
Ref: #regular-expressions34465
Node: Smart dates36201
Ref: #smart-dates36352
Node: Report start & end date37713
Ref: #report-start-end-date37885
Node: Report intervals39382
Ref: #report-intervals39547
Node: Period expressions39937
Ref: #period-expressions40097
Node: Depth limiting44233
Ref: #depth-limiting44377
Node: Pivoting44709
Ref: #pivoting44832
Node: Valuation46508
Ref: #valuation46610
Node: -B Cost47530
Ref: #b-cost47634
Node: -V Value47806
Ref: #v-value47959
Node: -X Market value in specified commodity49232
Ref: #x-market-value-in-specified-commodity49451
Node: Market prices49629
Ref: #market-prices49814
Node: --value Flexible valuation50739
Ref: #value-flexible-valuation50940
Node: Effect of --value on reports55445
Ref: #effect-of---value-on-reports55626
Node: COMMANDS61172
Ref: #commands61280
Node: accounts62364
Ref: #accounts62462
Node: activity63161
Ref: #activity63271
Node: add63654
Ref: #add63753
Node: balance66492
Ref: #balance66603
Node: Classic balance report68061
Ref: #classic-balance-report68234
Node: Customising the classic balance report69603
Ref: #customising-the-classic-balance-report69831
Node: Colour support71907
Ref: #colour-support72074
Node: Flat mode72247
Ref: #flat-mode72395
Node: Depth limited balance reports72808
Ref: #depth-limited-balance-reports72993
Node: Percentages73449
Ref: #percentages73615
Node: Multicolumn balance report74752
Ref: #multicolumn-balance-report74932
Node: Budget report80194
Ref: #budget-report80337
Node: Nested budgets85603
Ref: #nested-budgets85715
Ref: #output-format-189196
Node: balancesheet89393
Ref: #balancesheet89529
Node: balancesheetequity90995
Ref: #balancesheetequity91144
Node: cashflow91867
Ref: #cashflow91995
Node: check-dates93174
Ref: #check-dates93301
Node: check-dupes93580
Ref: #check-dupes93704
Node: close93997
Ref: #close94111
Node: close usage95633
Ref: #close-usage95726
Node: commodities98539
Ref: #commodities98666
Node: descriptions98748
Ref: #descriptions98876
Node: diff99057
Ref: #diff99163
Node: files100210
Ref: #files100310
Node: help100457
Ref: #help100557
Node: import101638
Ref: #import101752
Node: Importing balance assignments102645
Ref: #importing-balance-assignments102793
Node: incomestatement103442
Ref: #incomestatement103575
Node: notes105062
Ref: #notes105175
Node: payees105301
Ref: #payees105407
Node: prices105565
Ref: #prices105671
Node: print106012
Ref: #print106122
Node: print-unique110908
Ref: #print-unique111034
Node: register111319
Ref: #register111446
Node: Custom register output115618
Ref: #custom-register-output115747
Node: register-match117084
Ref: #register-match117218
Node: rewrite117569
Ref: #rewrite117684
Node: Re-write rules in a file119539
Ref: #re-write-rules-in-a-file119673
Node: Diff output format120883
Ref: #diff-output-format121052
Node: rewrite vs print --auto122144
Ref: #rewrite-vs.-print---auto122323
Node: roi122879
Ref: #roi122977
Node: stats123989
Ref: #stats124088
Node: tags124876
Ref: #tags124974
Node: test125268
Ref: #test125376
Node: Add-on commands126123
Ref: #add-on-commands126240
Node: ui127583
Ref: #ui127671
Node: web127725
Ref: #web127828
Node: iadd127944
Ref: #iadd128055
Node: interest128137
Ref: #interest128244
Node: ENVIRONMENT128484
Ref: #environment128596
Node: FILES129425
Ref: #files-1129528
Node: LIMITATIONS129741
Ref: #limitations129860
Node: TROUBLESHOOTING130602
Ref: #troubleshooting130715

End Tag Table

View File

@ -868,14 +868,6 @@ OPTIONS
https://github.com/simonmichael/hledger/blob/master/hledger-
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
significant digits, eg for repeating decimals. Such numbers can
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.9.1 is 4+ digits, month is 1-12, day is 1-31
2004 start of year
2004/10 start of month
10/1 month and day in current year
21 day in current month
@ -995,9 +988,10 @@ OPTIONS
(11/30 will be the last date included)
-b thismonth all transactions on or after the 1st of the current month
-p thismonth all transactions in the current month
date:2016/3/17- the above written as queries instead
date:-12/1
date:thismonth-
date:2016/3/17.. the above written as queries instead (.. can also be re-
placed with -)
date:..12/1
date:thismonth..
date:thismonth
Report intervals
@ -1020,11 +1014,11 @@ OPTIONS
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
"-". These are equivalent to the above:
".." or "-". These are equivalent to the above:
-p "2009/1/1 2009/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
also be written as:
@ -1130,7 +1124,7 @@ OPTIONS
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-
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
Normally hledger sums amounts, and organizes them in a hierarchy, based
@ -1477,8 +1471,6 @@ OPTIONS
amounts terval, val-
(with report ued at inter-
interval) val start
running to- sum/average sum/average sum/average sum/average sum/average
tal/average of displayed of displayed of displayed of displayed of displayed
values values values values values
@ -1500,6 +1492,9 @@ OPTIONS
(with report postings be- fore report fore report report start
interval and fore report start start
-H) start
budget like bal- like bal- not supported like bal- like balances
amounts with ances ances ances
--budget
@ -3236,4 +3231,4 @@ SEE ALSO
hledger 1.17.99 May 2020 hledger(1)
hledger 1.17.99 June 2020 hledger(1)