;regen manuals

This commit is contained in:
Simon Michael 2020-09-01 10:46:14 -07:00
parent c1a985f1c8
commit e44c1cfae8
21 changed files with 826 additions and 785 deletions

View File

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

View File

@ -1,6 +1,6 @@
.\"t
.TH "hledger_csv" "5" "August 2020" "hledger 1.18.99" "hledger User Manuals"
.TH "hledger_csv" "5" "September 2020" "hledger 1.18.99" "hledger User Manuals"
@ -9,9 +9,10 @@
CSV - how hledger reads CSV data, and the CSV rules file format
.SH DESCRIPTION
.PP
hledger can read CSV (Comma Separated Value/Character Separated Value)
files as if they were journal files, automatically converting each CSV
record into a transaction.
hledger can read CSV files (Character Separated Value - usually comma,
semicolon, or tab) containing dated records as if they were journal
files, automatically converting each CSV record into a transaction.
.PP
(To learn about \f[I]writing\f[R] CSV, see CSV output.)
.PP
We describe each CSV file\[aq]s format with a corresponding \f[I]rules
@ -592,9 +593,19 @@ Interpolation strips outer whitespace (so a CSV value like
See TIPS below for more about referencing other fields.
.SS \f[C]separator\f[R]
.PP
You can use the \f[C]separator\f[R] directive to read other kinds of
You can use the \f[C]separator\f[R] rule to read other kinds of
character-separated data.
Eg to read SSV (Semicolon Separated Values), use:
The argument is any single separator character, or the words
\f[C]tab\f[R] or \f[C]space\f[R] (case insensitive).
Eg, for comma-separated values (CSV):
.IP
.nf
\f[C]
separator ,
\f[R]
.fi
.PP
or for semicolon-separated values (SSV):
.IP
.nf
\f[C]
@ -602,11 +613,7 @@ separator ;
\f[R]
.fi
.PP
The separator directive accepts exactly one single byte character as a
separator.
To specify whitespace characters, you may use the special words
\f[C]TAB\f[R] or \f[C]SPACE\f[R].
Eg to read TSV (Tab Separated Values), use:
or for tab-separated values (TSV):
.IP
.nf
\f[C]
@ -614,7 +621,10 @@ separator TAB
\f[R]
.fi
.PP
See also: File Extension.
If the input file has a \f[C].csv\f[R], \f[C].ssv\f[R] or \f[C].tsv\f[R]
file extension (or a \f[C]csv:\f[R], \f[C]ssv:\f[R], \f[C]tsv:\f[R]
prefix), the appropriate separator will be inferred automatically, and
you won\[aq]t need this rule.
.SS \f[C]if\f[R] block
.IP
.nf
@ -964,14 +974,12 @@ they must be double quotes (not single quotes)
spaces outside the quotes are not allowed
.SS File Extension
.PP
CSV (\[dq]Character Separated Values\[dq]) files should be named with
one of these filename extensions: \f[C].csv\f[R], \f[C].ssv\f[R],
\f[C].tsv\f[R].
Or, the file path should be prefixed with one of \f[C]csv:\f[R],
\f[C]ssv:\f[R], \f[C]tsv:\f[R].
This helps hledger identify the format and show the right error
messages.
For example:
To help hledger identify the format and show the right error messages,
CSV/SSV/TSV files should normally be named with a \f[C].csv\f[R],
\f[C].ssv\f[R] or \f[C].tsv\f[R] filename extension.
Or, the file path should be prefixed with \f[C]csv:\f[R], \f[C]ssv:\f[R]
or \f[C]tsv:\f[R].
Eg:
.IP
.nf
\f[C]
@ -987,7 +995,8 @@ $ cat foo | hledger -f ssv:- foo
\f[R]
.fi
.PP
More about this: Input files in the hledger manual.
You can override the file extension with a separator rule if needed.
See also: Input files in the hledger manual.
.SS Reading multiple CSV files
.PP
If you use multiple \f[C]-f\f[R] options to read multiple CSV files at

View File

@ -8,10 +8,12 @@ hledger_csv(5) hledger 1.18.99
CSV - how hledger reads CSV data, and the CSV rules file format
hledger can read CSV (Comma Separated Value/Character Separated
Value) files as if they were journal files, automatically converting
each CSV record into a transaction. (To learn about _writing_ CSV, see
CSV output.)
hledger can read CSV files (Character Separated Value - usually
comma, semicolon, or tab) containing dated records as if they were
journal files, automatically converting each CSV record into a
transaction.
(To learn about _writing_ CSV, see CSV output.)
We describe each CSV file's format with a corresponding _rules file_.
By default this is named like the CSV file with a '.rules' extension
@ -580,19 +582,24 @@ File: hledger_csv.info, Node: separator, Next: if block, Prev: field assignme
2.4 'separator'
===============
You can use the 'separator' directive to read other kinds of
character-separated data. Eg to read SSV (Semicolon Separated Values),
use:
You can use the 'separator' rule to read other kinds of
character-separated data. The argument is any single separator
character, or the words 'tab' or 'space' (case insensitive). Eg, for
comma-separated values (CSV):
separator ,
or for semicolon-separated values (SSV):
separator ;
The separator directive accepts exactly one single byte character as
a separator. To specify whitespace characters, you may use the special
words 'TAB' or 'SPACE'. Eg to read TSV (Tab Separated Values), use:
or for tab-separated values (TSV):
separator TAB
See also: File Extension.
If the input file has a '.csv', '.ssv' or '.tsv' file extension (or a
'csv:', 'ssv:', 'tsv:' prefix), the appropriate separator will be
inferred automatically, and you won't need this rule.

File: hledger_csv.info, Node: if block, Next: if table, Prev: separator, Up: CSV RULES
@ -932,11 +939,10 @@ File: hledger_csv.info, Node: File Extension, Next: Reading multiple CSV files
3.3 File Extension
==================
CSV ("Character Separated Values") files should be named with one of
these filename extensions: '.csv', '.ssv', '.tsv'. Or, the file path
should be prefixed with one of 'csv:', 'ssv:', 'tsv:'. This helps
hledger identify the format and show the right error messages. For
example:
To help hledger identify the format and show the right error messages,
CSV/SSV/TSV files should normally be named with a '.csv', '.ssv' or
'.tsv' filename extension. Or, the file path should be prefixed with
'csv:', 'ssv:' or 'tsv:'. Eg:
$ hledger -f foo.ssv print
@ -944,7 +950,8 @@ $ hledger -f foo.ssv print
$ cat foo | hledger -f ssv:- foo
More about this: Input files in the hledger manual.
You can override the file extension with a separator rule if needed.
See also: Input files in the hledger manual.

File: hledger_csv.info, Node: Reading multiple CSV files, Next: Valid transactions, Prev: File Extension, Up: TIPS
@ -1143,84 +1150,84 @@ command the user specified.

Tag Table:
Node: Top72
Node: EXAMPLES2636
Ref: #examples2742
Node: Basic2950
Ref: #basic3050
Node: Bank of Ireland3592
Ref: #bank-of-ireland3727
Node: Amazon5189
Ref: #amazon5307
Node: Paypal7026
Ref: #paypal7120
Node: CSV RULES14764
Ref: #csv-rules14873
Node: skip15168
Ref: #skip15261
Node: fields15636
Ref: #fields15758
Node: Transaction field names16923
Ref: #transaction-field-names17083
Node: Posting field names17194
Ref: #posting-field-names17346
Node: account17416
Ref: #account17532
Node: amount18069
Ref: #amount18200
Node: currency19307
Ref: #currency19442
Node: balance19648
Ref: #balance19782
Node: comment20099
Ref: #comment20216
Node: field assignment20379
Ref: #field-assignment20522
Node: separator21340
Ref: #separator21475
Node: if block21886
Ref: #if-block22011
Node: Matching the whole record22412
Ref: #matching-the-whole-record22587
Node: Matching individual fields23391
Ref: #matching-individual-fields23595
Node: Combining matchers23819
Ref: #combining-matchers24015
Node: Rules applied on successful match24328
Ref: #rules-applied-on-successful-match24519
Node: if table25173
Ref: #if-table25292
Node: end27030
Ref: #end27142
Node: date-format27366
Ref: #date-format27498
Node: newest-first28247
Ref: #newest-first28385
Node: include29068
Ref: #include29199
Node: balance-type29643
Ref: #balance-type29763
Node: TIPS30463
Ref: #tips30545
Node: Rapid feedback30801
Ref: #rapid-feedback30918
Node: Valid CSV31378
Ref: #valid-csv31508
Node: File Extension31700
Ref: #file-extension31852
Node: Reading multiple CSV files32262
Ref: #reading-multiple-csv-files32447
Node: Valid transactions32688
Ref: #valid-transactions32866
Node: Deduplicating importing33494
Ref: #deduplicating-importing33673
Node: Setting amounts34706
Ref: #setting-amounts34875
Node: Setting currency/commodity35862
Ref: #setting-currencycommodity36054
Node: Referencing other fields36857
Ref: #referencing-other-fields37057
Node: How CSV rules are evaluated37954
Ref: #how-csv-rules-are-evaluated38127
Node: EXAMPLES2677
Ref: #examples2783
Node: Basic2991
Ref: #basic3091
Node: Bank of Ireland3633
Ref: #bank-of-ireland3768
Node: Amazon5230
Ref: #amazon5348
Node: Paypal7067
Ref: #paypal7161
Node: CSV RULES14805
Ref: #csv-rules14914
Node: skip15209
Ref: #skip15302
Node: fields15677
Ref: #fields15799
Node: Transaction field names16964
Ref: #transaction-field-names17124
Node: Posting field names17235
Ref: #posting-field-names17387
Node: account17457
Ref: #account17573
Node: amount18110
Ref: #amount18241
Node: currency19348
Ref: #currency19483
Node: balance19689
Ref: #balance19823
Node: comment20140
Ref: #comment20257
Node: field assignment20420
Ref: #field-assignment20563
Node: separator21381
Ref: #separator21516
Node: if block22056
Ref: #if-block22181
Node: Matching the whole record22582
Ref: #matching-the-whole-record22757
Node: Matching individual fields23561
Ref: #matching-individual-fields23765
Node: Combining matchers23989
Ref: #combining-matchers24185
Node: Rules applied on successful match24498
Ref: #rules-applied-on-successful-match24689
Node: if table25343
Ref: #if-table25462
Node: end27200
Ref: #end27312
Node: date-format27536
Ref: #date-format27668
Node: newest-first28417
Ref: #newest-first28555
Node: include29238
Ref: #include29369
Node: balance-type29813
Ref: #balance-type29933
Node: TIPS30633
Ref: #tips30715
Node: Rapid feedback30971
Ref: #rapid-feedback31088
Node: Valid CSV31548
Ref: #valid-csv31678
Node: File Extension31870
Ref: #file-extension32022
Node: Reading multiple CSV files32451
Ref: #reading-multiple-csv-files32636
Node: Valid transactions32877
Ref: #valid-transactions33055
Node: Deduplicating importing33683
Ref: #deduplicating-importing33862
Node: Setting amounts34895
Ref: #setting-amounts35064
Node: Setting currency/commodity36051
Ref: #setting-currencycommodity36243
Node: Referencing other fields37046
Ref: #referencing-other-fields37246
Node: How CSV rules are evaluated38143
Ref: #how-csv-rules-are-evaluated38316

End Tag Table

View File

@ -7,10 +7,11 @@ NAME
CSV - how hledger reads CSV data, and the CSV rules file format
DESCRIPTION
hledger can read CSV (Comma Separated Value/Character Separated Value)
files as if they were journal files, automatically converting each CSV
record into a transaction. (To learn about writing CSV, see CSV out-
put.)
hledger can read CSV files (Character Separated Value - usually comma,
semicolon, or tab) containing dated records as if they were journal
files, automatically converting each CSV record into a transaction.
(To learn about writing CSV, see CSV output.)
We describe each CSV file's format with a corresponding rules file. By
default this is named like the CSV file with a .rules extension added.
@ -451,18 +452,24 @@ CSV RULES
erencing other fields.
separator
You can use the separator directive to read other kinds of character-
separated data. Eg to read SSV (Semicolon Separated Values), use:
You can use the separator rule to read other kinds of character-sepa-
rated data. The argument is any single separator character, or the
words tab or space (case insensitive). Eg, for comma-separated values
(CSV):
separator ,
or for semicolon-separated values (SSV):
separator ;
The separator directive accepts exactly one single byte character as a
separator. To specify whitespace characters, you may use the special
words TAB or SPACE. Eg to read TSV (Tab Separated Values), use:
or for tab-separated values (TSV):
separator TAB
See also: File Extension.
If the input file has a .csv, .ssv or .tsv file extension (or a csv:,
ssv:, tsv: prefix), the appropriate separator will be inferred automat-
ically, and you won't need this rule.
if block
if MATCHER
@ -710,10 +717,10 @@ TIPS
o spaces outside the quotes are not allowed
File Extension
CSV ("Character Separated Values") files should be named with one of
these filename extensions: .csv, .ssv, .tsv. Or, the file path should
be prefixed with one of csv:, ssv:, tsv:. This helps hledger identify
the format and show the right error messages. For example:
To help hledger identify the format and show the right error messages,
CSV/SSV/TSV files should normally be named with a .csv, .ssv or .tsv
filename extension. Or, the file path should be prefixed with csv:,
ssv: or tsv:. Eg:
$ hledger -f foo.ssv print
@ -721,7 +728,8 @@ TIPS
$ cat foo | hledger -f ssv:- foo
More about this: Input files in the hledger manual.
You can override the file extension with a separator rule if needed.
See also: Input files in the hledger manual.
Reading multiple CSV files
If you use multiple -f options to read multiple CSV files at once,
@ -914,4 +922,4 @@ SEE ALSO
hledger 1.18.99 August 2020 hledger_csv(5)
hledger 1.18.99 September 2020 hledger_csv(5)

View File

@ -1,6 +1,6 @@
.\"t
.TH "hledger_journal" "5" "August 2020" "hledger 1.18.99" "hledger User Manuals"
.TH "hledger_journal" "5" "September 2020" "hledger 1.18.99" "hledger User Manuals"

View File

@ -1526,4 +1526,4 @@ SEE ALSO
hledger 1.18.99 August 2020 hledger_journal(5)
hledger 1.18.99 September 2020 hledger_journal(5)

View File

@ -1,5 +1,5 @@
.TH "hledger_timeclock" "5" "August 2020" "hledger 1.18.99" "hledger User Manuals"
.TH "hledger_timeclock" "5" "September 2020" "hledger 1.18.99" "hledger User Manuals"

View File

@ -78,4 +78,4 @@ SEE ALSO
hledger 1.18.99 August 2020 hledger_timeclock(5)
hledger 1.18.99 September 2020 hledger_timeclock(5)

View File

@ -1,5 +1,5 @@
.TH "hledger_timedot" "5" "August 2020" "hledger 1.18.99" "hledger User Manuals"
.TH "hledger_timedot" "5" "September 2020" "hledger 1.18.99" "hledger User Manuals"

View File

@ -161,4 +161,4 @@ SEE ALSO
hledger 1.18.99 August 2020 hledger_timedot(5)
hledger 1.18.99 September 2020 hledger_timedot(5)

View File

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

View File

@ -1,5 +1,5 @@
.TH "hledger-ui" "1" "August 2020" "hledger-ui 1.18.99" "hledger User Manuals"
.TH "hledger-ui" "1" "September 2020" "hledger-ui 1.18.99" "hledger User Manuals"

View File

@ -456,4 +456,4 @@ SEE ALSO
hledger-ui 1.18.99 August 2020 hledger-ui(1)
hledger-ui 1.18.99 September 2020 hledger-ui(1)

View File

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

View File

@ -1,5 +1,5 @@
.TH "hledger-web" "1" "August 2020" "hledger-web 1.18.99" "hledger User Manuals"
.TH "hledger-web" "1" "September 2020" "hledger-web 1.18.99" "hledger User Manuals"

View File

@ -545,4 +545,4 @@ SEE ALSO
hledger-web 1.18.99 August 2020 hledger-web(1)
hledger-web 1.18.99 September 2020 hledger-web(1)

View File

@ -47,8 +47,7 @@ $ hledger balance
By default, accounts are displayed hierarchically, with subaccounts
indented below their parent. At each level of the tree, accounts are
sorted by account code if any, then by account name. Or with
-S/--sort-amount, by their balance amount, largest first. (Note: -S has
a problem in hledger 1.11-1.18).
-S/--sort-amount, by their balance amount, largest first.
"Boring" accounts, which contain a single interesting subaccount and no
balance of their own, are elided into the following line for more

View File

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

View File

@ -1,6 +1,6 @@
.\"t
.TH "hledger" "1" "August 2020" "hledger 1.18.99" "hledger User Manuals"
.TH "hledger" "1" "September 2020" "hledger 1.18.99" "hledger User Manuals"
@ -982,15 +982,12 @@ $ cat some.journal | hledger -f-
\f[R]
.fi
.PP
Usually the data file is in hledger\[aq]s journal format, but it can
also be one of several other formats, listed below.
hledger detects the format automatically based on the file extension, or
if that is not recognised, by trying each built-in \[dq]reader\[dq] in
turn:
Usually the data file is in hledger\[aq]s journal format, but it can be
in any of the supported file formats, which currently are:
.PP
.TS
tab(@);
lw(7.6n) lw(31.2n) lw(31.2n).
lw(7.8n) lw(39.5n) lw(22.7n).
T{
Reader:
T}@T{
@ -1002,37 +999,45 @@ _
T{
\f[C]journal\f[R]
T}@T{
hledger\[aq]s journal format, also some Ledger journals
hledger journal files and some Ledger journals, for transactions
T}@T{
\f[C].journal\f[R] \f[C].j\f[R] \f[C].hledger\f[R] \f[C].ledger\f[R]
T}
T{
\f[C]timeclock\f[R]
T}@T{
timeclock files (precise time logging)
timeclock files, for precise time logging
T}@T{
\f[C].timeclock\f[R]
T}
T{
\f[C]timedot\f[R]
T}@T{
timedot files (approximate time logging)
timedot files, for approximate time logging
T}@T{
\f[C].timedot\f[R]
T}
T{
\f[C]csv\f[R]
T}@T{
comma-separated values (data interchange)
comma/semicolon/tab/other-separated values, for data import
T}@T{
\f[C].csv\f[R]
\f[C].csv\f[R] \f[C].ssv\f[R] \f[C].tsv\f[R]
T}
.TE
.PP
If needed (eg to ensure correct error messages when a file has the
\[dq]wrong\[dq] extension), you can force a specific reader/format by
prepending it to the file path with a colon.
Examples:
hledger detects the format automatically based on the file extensions
shown above.
If it can\[aq]t recognise the file extension, it assumes
\f[C]journal\f[R] format.
So for non-journal files, it\[aq]s important to use a recognised file
extension, so as to either read successfully or to show relevant error
messages.
.PP
When you can\[aq]t ensure the right file extension, not to worry: you
can force a specific reader/format by prefixing the file path with the
format and a colon.
Eg to read a .dat file as csv:
.IP
.nf
\f[C]
@ -1041,16 +1046,20 @@ $ echo \[aq]i 2009/13/1 08:00:00\[aq] | hledger print -ftimeclock:-
\f[R]
.fi
.PP
You can also specify multiple \f[C]-f\f[R] options, to read multiple
files as one big journal.
You can specify multiple \f[C]-f\f[R] options, to read multiple files as
one big journal.
There are some limitations with this:
.IP \[bu] 2
directives in one file will not affect the other files
.IP \[bu] 2
balance assertions will not see any account balances from previous files
.PP
If you need those, either use the include directive, or concatenate the
files, eg: \f[C]cat a.journal b.journal | hledger -f- CMD\f[R].
If you need either of those things, you can
.IP \[bu] 2
use a single parent file which includes the others
.IP \[bu] 2
or concatenate the files into one before reading, eg:
\f[C]cat a.journal b.journal | hledger -f- CMD\f[R].
.SS Output destination
.PP
hledger commands send their output to the terminal by default.
@ -2676,7 +2685,6 @@ At each level of the tree, accounts are sorted by account code if any,
then by account name.
Or with \f[C]-S/--sort-amount\f[R], by their balance amount, largest
first.
(Note: \f[C]-S\f[R] has a problem in hledger 1.11-1.18).
.PP
\[dq]Boring\[dq] accounts, which contain a single interesting subaccount
and no balance of their own, are elided into the following line for more

View File

@ -955,38 +955,46 @@ $ hledger -f /some/file stats
$ cat some.journal | hledger -f-
Usually the data file is in hledger's journal format, but it can also
be one of several other formats, listed below. hledger detects the
format automatically based on the file extension, or if that is not
recognised, by trying each built-in "reader" in turn:
Usually the data file is in hledger's journal format, but it can be
in any of the supported file formats, which currently are:
Reader: Reads: Used for file extensions:
---------------------------------------------------------------------------
'journal'hledger's journal format, also '.journal' '.j' '.hledger'
some Ledger journals '.ledger'
'timeclock'timeclock files (precise time '.timeclock'
logging)
'timedot'timedot files (approximate '.timedot'
time logging)
'csv' comma-separated values (data '.csv'
interchange)
Reader: Reads: Used for file
extensions:
--------------------------------------------------------------------------
'journal'hledger journal files and some Ledger '.journal' '.j'
journals, for transactions '.hledger' '.ledger'
'timeclock'timeclock files, for precise time '.timeclock'
logging
'timedot'timedot files, for approximate time '.timedot'
logging
'csv' comma/semicolon/tab/other-separated '.csv' '.ssv' '.tsv'
values, for data import
If needed (eg to ensure correct error messages when a file has the
"wrong" extension), you can force a specific reader/format by prepending
it to the file path with a colon. Examples:
hledger detects the format automatically based on the file extensions
shown above. If it can't recognise the file extension, it assumes
'journal' format. So for non-journal files, it's important to use a
recognised file extension, so as to either read successfully or to show
relevant error messages.
When you can't ensure the right file extension, not to worry: you can
force a specific reader/format by prefixing the file path with the
format and a colon. Eg to read a .dat file as csv:
$ hledger -f csv:/some/csv-file.dat stats
$ echo 'i 2009/13/1 08:00:00' | hledger print -ftimeclock:-
You can also specify multiple '-f' options, to read multiple files as
one big journal. There are some limitations with this:
You can specify multiple '-f' options, to read multiple files as one
big journal. There are some limitations with this:
* directives in one file will not affect the other files
* balance assertions will not see any account balances from previous
files
If you need those, either use the include directive, or concatenate
the files, eg: 'cat a.journal b.journal | hledger -f- CMD'.
If you need either of those things, you can
* use a single parent file which includes the others
* or concatenate the files into one before reading, eg: 'cat
a.journal b.journal | hledger -f- CMD'.

File: hledger.info, Node: Output destination, Next: Output format, Prev: Input files, Up: OPTIONS
@ -2205,8 +2213,7 @@ $ hledger balance
By default, accounts are displayed hierarchically, with subaccounts
indented below their parent. At each level of the tree, accounts are
sorted by account code if any, then by account name. Or with
'-S/--sort-amount', by their balance amount, largest first. (Note: '-S'
has a problem in hledger 1.11-1.18).
'-S/--sort-amount', by their balance amount, largest first.
"Boring" accounts, which contain a single interesting subaccount and
no balance of their own, are elided into the following line for more
@ -4095,164 +4102,164 @@ Node: Unicode characters28869
Ref: #unicode-characters29051
Node: Input files30463
Ref: #input-files30606
Node: Output destination32535
Ref: #output-destination32687
Node: Output format33112
Ref: #output-format33262
Node: Regular expressions35429
Ref: #regular-expressions35586
Node: Smart dates37322
Ref: #smart-dates37473
Node: Report start & end date38834
Ref: #report-start-end-date39006
Node: Report intervals40503
Ref: #report-intervals40668
Node: Period expressions41058
Ref: #period-expressions41218
Node: Depth limiting45550
Ref: #depth-limiting45694
Node: Pivoting46026
Ref: #pivoting46149
Node: Valuation47825
Ref: #valuation47927
Node: -B Cost48616
Ref: #b-cost48720
Node: -V Value48853
Ref: #v-value48999
Node: -X Value in specified commodity49194
Ref: #x-value-in-specified-commodity49393
Node: Valuation date49542
Ref: #valuation-date49710
Node: Market prices50120
Ref: #market-prices50300
Node: --infer-value market prices from transactions51077
Ref: #infer-value-market-prices-from-transactions51326
Node: Valuation commodity52608
Ref: #valuation-commodity52817
Node: Simple valuation examples54043
Ref: #simple-valuation-examples54245
Node: --value Flexible valuation54904
Ref: #value-flexible-valuation55112
Node: More valuation examples57059
Ref: #more-valuation-examples57268
Node: Effect of valuation on reports59273
Ref: #effect-of-valuation-on-reports59461
Node: COMMANDS64982
Ref: #commands65090
Node: accounts66198
Ref: #accounts66296
Node: activity66995
Ref: #activity67105
Node: add67488
Ref: #add67589
Node: aregister70382
Ref: #aregister70494
Node: aregister and custom posting dates71867
Ref: #aregister-and-custom-posting-dates72040
Ref: #output-format-172633
Node: balance73038
Ref: #balance73155
Node: Classic balance report74613
Ref: #classic-balance-report74786
Node: Customising the classic balance report76220
Ref: #customising-the-classic-balance-report76448
Node: Colour support78524
Ref: #colour-support78691
Node: Flat mode78787
Ref: #flat-mode78935
Node: Depth limited balance reports79348
Ref: #depth-limited-balance-reports79533
Node: Percentages79989
Ref: #percentages80155
Node: Multicolumn balance report81292
Ref: #multicolumn-balance-report81472
Node: Budget report87069
Ref: #budget-report87212
Node: Nested budgets92478
Ref: #nested-budgets92590
Ref: #output-format-296071
Node: balancesheet96268
Ref: #balancesheet96404
Node: balancesheetequity97916
Ref: #balancesheetequity98065
Node: cashflow99141
Ref: #cashflow99269
Node: check-dates100485
Ref: #check-dates100612
Node: check-dupes100891
Ref: #check-dupes101017
Node: close101310
Ref: #close101418
Node: close usage102940
Ref: #close-usage103033
Node: codes105846
Ref: #codes105954
Node: commodities106666
Ref: #commodities106793
Node: descriptions106875
Ref: #descriptions107003
Node: diff107307
Ref: #diff107413
Node: files108460
Ref: #files108560
Node: help108707
Ref: #help108807
Node: import109888
Ref: #import110002
Node: Importing balance assignments110895
Ref: #importing-balance-assignments111043
Node: incomestatement111692
Ref: #incomestatement111825
Node: notes113170
Ref: #notes113283
Node: payees113651
Ref: #payees113757
Node: prices114177
Ref: #prices114283
Node: print114624
Ref: #print114734
Node: print-unique119530
Ref: #print-unique119656
Node: register119941
Ref: #register120068
Node: Custom register output124517
Ref: #custom-register-output124646
Node: register-match125983
Ref: #register-match126117
Node: rewrite126468
Ref: #rewrite126583
Node: Re-write rules in a file128438
Ref: #re-write-rules-in-a-file128572
Node: Diff output format129782
Ref: #diff-output-format129951
Node: rewrite vs print --auto131043
Ref: #rewrite-vs.-print---auto131222
Node: roi131778
Ref: #roi131876
Node: stats132888
Ref: #stats132987
Node: tags133775
Ref: #tags133873
Node: test134392
Ref: #test134500
Node: Add-on commands135247
Ref: #add-on-commands135364
Node: ui136707
Ref: #ui136795
Node: web136849
Ref: #web136952
Node: iadd137068
Ref: #iadd137179
Node: interest137261
Ref: #interest137368
Node: ENVIRONMENT137608
Ref: #environment137720
Node: FILES138705
Ref: #files-1138808
Node: LIMITATIONS139021
Ref: #limitations139140
Node: TROUBLESHOOTING139882
Ref: #troubleshooting139995
Node: Output destination32905
Ref: #output-destination33057
Node: Output format33482
Ref: #output-format33632
Node: Regular expressions35799
Ref: #regular-expressions35956
Node: Smart dates37692
Ref: #smart-dates37843
Node: Report start & end date39204
Ref: #report-start-end-date39376
Node: Report intervals40873
Ref: #report-intervals41038
Node: Period expressions41428
Ref: #period-expressions41588
Node: Depth limiting45920
Ref: #depth-limiting46064
Node: Pivoting46396
Ref: #pivoting46519
Node: Valuation48195
Ref: #valuation48297
Node: -B Cost48986
Ref: #b-cost49090
Node: -V Value49223
Ref: #v-value49369
Node: -X Value in specified commodity49564
Ref: #x-value-in-specified-commodity49763
Node: Valuation date49912
Ref: #valuation-date50080
Node: Market prices50490
Ref: #market-prices50670
Node: --infer-value market prices from transactions51447
Ref: #infer-value-market-prices-from-transactions51696
Node: Valuation commodity52978
Ref: #valuation-commodity53187
Node: Simple valuation examples54413
Ref: #simple-valuation-examples54615
Node: --value Flexible valuation55274
Ref: #value-flexible-valuation55482
Node: More valuation examples57429
Ref: #more-valuation-examples57638
Node: Effect of valuation on reports59643
Ref: #effect-of-valuation-on-reports59831
Node: COMMANDS65352
Ref: #commands65460
Node: accounts66568
Ref: #accounts66666
Node: activity67365
Ref: #activity67475
Node: add67858
Ref: #add67959
Node: aregister70752
Ref: #aregister70864
Node: aregister and custom posting dates72237
Ref: #aregister-and-custom-posting-dates72410
Ref: #output-format-173003
Node: balance73408
Ref: #balance73525
Node: Classic balance report74983
Ref: #classic-balance-report75156
Node: Customising the classic balance report76540
Ref: #customising-the-classic-balance-report76768
Node: Colour support78844
Ref: #colour-support79011
Node: Flat mode79107
Ref: #flat-mode79255
Node: Depth limited balance reports79668
Ref: #depth-limited-balance-reports79853
Node: Percentages80309
Ref: #percentages80475
Node: Multicolumn balance report81612
Ref: #multicolumn-balance-report81792
Node: Budget report87389
Ref: #budget-report87532
Node: Nested budgets92798
Ref: #nested-budgets92910
Ref: #output-format-296391
Node: balancesheet96588
Ref: #balancesheet96724
Node: balancesheetequity98236
Ref: #balancesheetequity98385
Node: cashflow99461
Ref: #cashflow99589
Node: check-dates100805
Ref: #check-dates100932
Node: check-dupes101211
Ref: #check-dupes101337
Node: close101630
Ref: #close101738
Node: close usage103260
Ref: #close-usage103353
Node: codes106166
Ref: #codes106274
Node: commodities106986
Ref: #commodities107113
Node: descriptions107195
Ref: #descriptions107323
Node: diff107627
Ref: #diff107733
Node: files108780
Ref: #files108880
Node: help109027
Ref: #help109127
Node: import110208
Ref: #import110322
Node: Importing balance assignments111215
Ref: #importing-balance-assignments111363
Node: incomestatement112012
Ref: #incomestatement112145
Node: notes113490
Ref: #notes113603
Node: payees113971
Ref: #payees114077
Node: prices114497
Ref: #prices114603
Node: print114944
Ref: #print115054
Node: print-unique119850
Ref: #print-unique119976
Node: register120261
Ref: #register120388
Node: Custom register output124837
Ref: #custom-register-output124966
Node: register-match126303
Ref: #register-match126437
Node: rewrite126788
Ref: #rewrite126903
Node: Re-write rules in a file128758
Ref: #re-write-rules-in-a-file128892
Node: Diff output format130102
Ref: #diff-output-format130271
Node: rewrite vs print --auto131363
Ref: #rewrite-vs.-print---auto131542
Node: roi132098
Ref: #roi132196
Node: stats133208
Ref: #stats133307
Node: tags134095
Ref: #tags134193
Node: test134712
Ref: #test134820
Node: Add-on commands135567
Ref: #add-on-commands135684
Node: ui137027
Ref: #ui137115
Node: web137169
Ref: #web137272
Node: iadd137388
Ref: #iadd137499
Node: interest137581
Ref: #interest137688
Node: ENVIRONMENT137928
Ref: #environment138040
Node: FILES139025
Ref: #files-1139128
Node: LIMITATIONS139341
Ref: #limitations139460
Node: TROUBLESHOOTING140202
Ref: #troubleshooting140315

End Tag Table

View File

@ -810,39 +810,48 @@ OPTIONS
$ cat some.journal | hledger -f-
Usually the data file is in hledger's journal format, but it can also
be one of several other formats, listed below. hledger detects the
format automatically based on the file extension, or if that is not
recognised, by trying each built-in "reader" in turn:
Usually the data file is in hledger's journal format, but it can be in
any of the supported file formats, which currently are:
Reader: Reads: Used for file extensions:
Reader: Reads: Used for file exten-
sions:
-----------------------------------------------------------------------------
journal hledger's journal format, also .journal .j .hledger .ledger
some Ledger journals
time- timeclock files (precise time .timeclock
clock logging)
timedot timedot files (approximate time .timedot
logging)
csv comma-separated values (data .csv
interchange)
journal hledger journal files and some Ledger .journal .j .hledger
journals, for transactions .ledger
time- timeclock files, for precise time log- .timeclock
clock ging
timedot timedot files, for approximate time .timedot
logging
csv comma/semicolon/tab/other-separated .csv .ssv .tsv
values, for data import
If needed (eg to ensure correct error messages when a file has the
"wrong" extension), you can force a specific reader/format by prepend-
ing it to the file path with a colon. Examples:
hledger detects the format automatically based on the file extensions
shown above. If it can't recognise the file extension, it assumes
journal format. So for non-journal files, it's important to use a
recognised file extension, so as to either read successfully or to show
relevant error messages.
When you can't ensure the right file extension, not to worry: you can
force a specific reader/format by prefixing the file path with the for-
mat and a colon. Eg to read a .dat file as csv:
$ hledger -f csv:/some/csv-file.dat stats
$ echo 'i 2009/13/1 08:00:00' | hledger print -ftimeclock:-
You can also specify multiple -f options, to read multiple files as one
big journal. There are some limitations with this:
You can specify multiple -f options, to read multiple files as one big
journal. There are some limitations with this:
o directives in one file will not affect the other files
o balance assertions will not see any account balances from previous
files
If you need those, either use the include directive, or concatenate the
files, eg: cat a.journal b.journal | hledger -f- CMD.
If you need either of those things, you can
o use a single parent file which includes the others
o or concatenate the files into one before reading, eg: cat a.journal
b.journal | hledger -f- CMD.
Output destination
hledger commands send their output to the terminal by default. You can
@ -1062,6 +1071,7 @@ OPTIONS
1, 2009
-p "from 2009/1" the same
-p "from 2009" the same
-p "to 2009" everything before january
1, 2009
@ -1070,8 +1080,6 @@ OPTIONS
-p "2009" the year 2009; equivalent
to "2009/1/1 to 2010/1/1"
-p "2009/1" the month of jan; equiva-
lent to "2009/1/1 to
2009/2/1"
@ -1139,8 +1147,6 @@ OPTIONS
-p "every 2nd day of periods will go from Tue to Tue
week"
-p "every Tue" same
-p "every 15th day" period boundaries will be on 15th of each
month
-p "every 2nd Monday" period boundaries will be on second Monday of
@ -1552,13 +1558,11 @@ 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
balance (bs,
bse, cf,
is..)
@ -1865,8 +1869,7 @@ COMMANDS
By default, accounts are displayed hierarchically, with subaccounts in-
dented below their parent. At each level of the tree, accounts are
sorted by account code if any, then by account name. Or with
-S/--sort-amount, by their balance amount, largest first. (Note: -S
has a problem in hledger 1.11-1.18).
-S/--sort-amount, by their balance amount, largest first.
"Boring" accounts, which contain a single interesting subaccount and no
balance of their own, are elided into the following line for more com-
@ -3457,4 +3460,4 @@ SEE ALSO
hledger 1.18.99 August 2020 hledger(1)
hledger 1.18.99 September 2020 hledger(1)