;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_define({{_version_}}, {{1.18.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_}}, {{August 2020}})m4_dnl m4_define({{_monthyear_}}, {{September 2020}})m4_dnl

View File

@ -1,6 +1,6 @@
.\"t .\"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 CSV - how hledger reads CSV data, and the CSV rules file format
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
hledger can read CSV (Comma Separated Value/Character Separated Value) hledger can read CSV files (Character Separated Value - usually comma,
files as if they were journal files, automatically converting each CSV semicolon, or tab) containing dated records as if they were journal
record into a transaction. files, automatically converting each CSV record into a transaction.
.PP
(To learn about \f[I]writing\f[R] CSV, see CSV output.) (To learn about \f[I]writing\f[R] CSV, see CSV output.)
.PP .PP
We describe each CSV file\[aq]s format with a corresponding \f[I]rules 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. See TIPS below for more about referencing other fields.
.SS \f[C]separator\f[R] .SS \f[C]separator\f[R]
.PP .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. 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 .IP
.nf .nf
\f[C] \f[C]
@ -602,11 +613,7 @@ separator ;
\f[R] \f[R]
.fi .fi
.PP .PP
The separator directive accepts exactly one single byte character as a or for tab-separated values (TSV):
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:
.IP .IP
.nf .nf
\f[C] \f[C]
@ -614,7 +621,10 @@ separator TAB
\f[R] \f[R]
.fi .fi
.PP .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 .SS \f[C]if\f[R] block
.IP .IP
.nf .nf
@ -964,14 +974,12 @@ they must be double quotes (not single quotes)
spaces outside the quotes are not allowed spaces outside the quotes are not allowed
.SS File Extension .SS File Extension
.PP .PP
CSV (\[dq]Character Separated Values\[dq]) files should be named with To help hledger identify the format and show the right error messages,
one of these filename extensions: \f[C].csv\f[R], \f[C].ssv\f[R], CSV/SSV/TSV files should normally be named with a \f[C].csv\f[R],
\f[C].tsv\f[R]. \f[C].ssv\f[R] or \f[C].tsv\f[R] filename extension.
Or, the file path should be prefixed with one of \f[C]csv:\f[R], Or, the file path should be prefixed with \f[C]csv:\f[R], \f[C]ssv:\f[R]
\f[C]ssv:\f[R], \f[C]tsv:\f[R]. or \f[C]tsv:\f[R].
This helps hledger identify the format and show the right error Eg:
messages.
For example:
.IP .IP
.nf .nf
\f[C] \f[C]
@ -987,7 +995,8 @@ $ cat foo | hledger -f ssv:- foo
\f[R] \f[R]
.fi .fi
.PP .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 .SS Reading multiple CSV files
.PP .PP
If you use multiple \f[C]-f\f[R] options to read multiple CSV files at 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 CSV - how hledger reads CSV data, and the CSV rules file format
hledger can read CSV (Comma Separated Value/Character Separated hledger can read CSV files (Character Separated Value - usually
Value) files as if they were journal files, automatically converting comma, semicolon, or tab) containing dated records as if they were
each CSV record into a transaction. (To learn about _writing_ CSV, see journal files, automatically converting each CSV record into a
CSV output.) transaction.
(To learn about _writing_ CSV, see CSV output.)
We describe each CSV file's format with a corresponding _rules file_. 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 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' 2.4 'separator'
=============== ===============
You can use the 'separator' directive to read other kinds of You can use the 'separator' rule to read other kinds of
character-separated data. Eg to read SSV (Semicolon Separated Values), character-separated data. The argument is any single separator
use: character, or the words 'tab' or 'space' (case insensitive). Eg, for
comma-separated values (CSV):
separator ,
or for semicolon-separated values (SSV):
separator ; separator ;
The separator directive accepts exactly one single byte character as or for tab-separated values (TSV):
a separator. To specify whitespace characters, you may use the special
words 'TAB' or 'SPACE'. Eg to read TSV (Tab Separated Values), use:
separator TAB 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 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 3.3 File Extension
================== ==================
CSV ("Character Separated Values") files should be named with one of To help hledger identify the format and show the right error messages,
these filename extensions: '.csv', '.ssv', '.tsv'. Or, the file path CSV/SSV/TSV files should normally be named with a '.csv', '.ssv' or
should be prefixed with one of 'csv:', 'ssv:', 'tsv:'. This helps '.tsv' filename extension. Or, the file path should be prefixed with
hledger identify the format and show the right error messages. For 'csv:', 'ssv:' or 'tsv:'. Eg:
example:
$ hledger -f foo.ssv print $ hledger -f foo.ssv print
@ -944,7 +950,8 @@ $ hledger -f foo.ssv print
$ cat foo | hledger -f ssv:- foo $ 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 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: Tag Table:
Node: Top72 Node: Top72
Node: EXAMPLES2636 Node: EXAMPLES2677
Ref: #examples2742 Ref: #examples2783
Node: Basic2950 Node: Basic2991
Ref: #basic3050 Ref: #basic3091
Node: Bank of Ireland3592 Node: Bank of Ireland3633
Ref: #bank-of-ireland3727 Ref: #bank-of-ireland3768
Node: Amazon5189 Node: Amazon5230
Ref: #amazon5307 Ref: #amazon5348
Node: Paypal7026 Node: Paypal7067
Ref: #paypal7120 Ref: #paypal7161
Node: CSV RULES14764 Node: CSV RULES14805
Ref: #csv-rules14873 Ref: #csv-rules14914
Node: skip15168 Node: skip15209
Ref: #skip15261 Ref: #skip15302
Node: fields15636 Node: fields15677
Ref: #fields15758 Ref: #fields15799
Node: Transaction field names16923 Node: Transaction field names16964
Ref: #transaction-field-names17083 Ref: #transaction-field-names17124
Node: Posting field names17194 Node: Posting field names17235
Ref: #posting-field-names17346 Ref: #posting-field-names17387
Node: account17416 Node: account17457
Ref: #account17532 Ref: #account17573
Node: amount18069 Node: amount18110
Ref: #amount18200 Ref: #amount18241
Node: currency19307 Node: currency19348
Ref: #currency19442 Ref: #currency19483
Node: balance19648 Node: balance19689
Ref: #balance19782 Ref: #balance19823
Node: comment20099 Node: comment20140
Ref: #comment20216 Ref: #comment20257
Node: field assignment20379 Node: field assignment20420
Ref: #field-assignment20522 Ref: #field-assignment20563
Node: separator21340 Node: separator21381
Ref: #separator21475 Ref: #separator21516
Node: if block21886 Node: if block22056
Ref: #if-block22011 Ref: #if-block22181
Node: Matching the whole record22412 Node: Matching the whole record22582
Ref: #matching-the-whole-record22587 Ref: #matching-the-whole-record22757
Node: Matching individual fields23391 Node: Matching individual fields23561
Ref: #matching-individual-fields23595 Ref: #matching-individual-fields23765
Node: Combining matchers23819 Node: Combining matchers23989
Ref: #combining-matchers24015 Ref: #combining-matchers24185
Node: Rules applied on successful match24328 Node: Rules applied on successful match24498
Ref: #rules-applied-on-successful-match24519 Ref: #rules-applied-on-successful-match24689
Node: if table25173 Node: if table25343
Ref: #if-table25292 Ref: #if-table25462
Node: end27030 Node: end27200
Ref: #end27142 Ref: #end27312
Node: date-format27366 Node: date-format27536
Ref: #date-format27498 Ref: #date-format27668
Node: newest-first28247 Node: newest-first28417
Ref: #newest-first28385 Ref: #newest-first28555
Node: include29068 Node: include29238
Ref: #include29199 Ref: #include29369
Node: balance-type29643 Node: balance-type29813
Ref: #balance-type29763 Ref: #balance-type29933
Node: TIPS30463 Node: TIPS30633
Ref: #tips30545 Ref: #tips30715
Node: Rapid feedback30801 Node: Rapid feedback30971
Ref: #rapid-feedback30918 Ref: #rapid-feedback31088
Node: Valid CSV31378 Node: Valid CSV31548
Ref: #valid-csv31508 Ref: #valid-csv31678
Node: File Extension31700 Node: File Extension31870
Ref: #file-extension31852 Ref: #file-extension32022
Node: Reading multiple CSV files32262 Node: Reading multiple CSV files32451
Ref: #reading-multiple-csv-files32447 Ref: #reading-multiple-csv-files32636
Node: Valid transactions32688 Node: Valid transactions32877
Ref: #valid-transactions32866 Ref: #valid-transactions33055
Node: Deduplicating importing33494 Node: Deduplicating importing33683
Ref: #deduplicating-importing33673 Ref: #deduplicating-importing33862
Node: Setting amounts34706 Node: Setting amounts34895
Ref: #setting-amounts34875 Ref: #setting-amounts35064
Node: Setting currency/commodity35862 Node: Setting currency/commodity36051
Ref: #setting-currencycommodity36054 Ref: #setting-currencycommodity36243
Node: Referencing other fields36857 Node: Referencing other fields37046
Ref: #referencing-other-fields37057 Ref: #referencing-other-fields37246
Node: How CSV rules are evaluated37954 Node: How CSV rules are evaluated38143
Ref: #how-csv-rules-are-evaluated38127 Ref: #how-csv-rules-are-evaluated38316
 
End Tag Table End Tag Table

View File

@ -7,10 +7,11 @@ NAME
CSV - how hledger reads CSV data, and the CSV rules file format CSV - how hledger reads CSV data, and the CSV rules file format
DESCRIPTION DESCRIPTION
hledger can read CSV (Comma Separated Value/Character Separated Value) hledger can read CSV files (Character Separated Value - usually comma,
files as if they were journal files, automatically converting each CSV semicolon, or tab) containing dated records as if they were journal
record into a transaction. (To learn about writing CSV, see CSV out- files, automatically converting each CSV record into a transaction.
put.)
(To learn about writing CSV, see CSV output.)
We describe each CSV file's format with a corresponding rules file. By 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. default this is named like the CSV file with a .rules extension added.
@ -451,18 +452,24 @@ CSV RULES
erencing other fields. erencing other fields.
separator separator
You can use the separator directive to read other kinds of character- You can use the separator rule to read other kinds of character-sepa-
separated data. Eg to read SSV (Semicolon Separated Values), use: 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 ; separator ;
The separator directive accepts exactly one single byte character as a or for tab-separated values (TSV):
separator. To specify whitespace characters, you may use the special
words TAB or SPACE. Eg to read TSV (Tab Separated Values), use:
separator TAB 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 block
if MATCHER if MATCHER
@ -710,10 +717,10 @@ TIPS
o spaces outside the quotes are not allowed o spaces outside the quotes are not allowed
File Extension File Extension
CSV ("Character Separated Values") files should be named with one of To help hledger identify the format and show the right error messages,
these filename extensions: .csv, .ssv, .tsv. Or, the file path should CSV/SSV/TSV files should normally be named with a .csv, .ssv or .tsv
be prefixed with one of csv:, ssv:, tsv:. This helps hledger identify filename extension. Or, the file path should be prefixed with csv:,
the format and show the right error messages. For example: ssv: or tsv:. Eg:
$ hledger -f foo.ssv print $ hledger -f foo.ssv print
@ -721,7 +728,8 @@ TIPS
$ cat foo | hledger -f ssv:- foo $ 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 Reading multiple CSV files
If you use multiple -f options to read multiple CSV files at once, 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 .\"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_define({{_version_}}, {{1.18.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_}}, {{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_define({{_version_}}, {{1.18.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_}}, {{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 By default, accounts are displayed hierarchically, with subaccounts
indented below their parent. At each level of the tree, accounts are indented below their parent. At each level of the tree, accounts are
sorted by account code if any, then by account name. Or with sorted by account code if any, then by account name. Or with
-S/--sort-amount, by their balance amount, largest first. (Note: -S has -S/--sort-amount, by their balance amount, largest first.
a problem in hledger 1.11-1.18).
"Boring" accounts, which contain a single interesting subaccount and no "Boring" accounts, which contain a single interesting subaccount and no
balance of their own, are elided into the following line for more 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_define({{_version_}}, {{1.18.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_}}, {{August 2020}})m4_dnl m4_define({{_monthyear_}}, {{September 2020}})m4_dnl

View File

@ -1,6 +1,6 @@
.\"t .\"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] \f[R]
.fi .fi
.PP .PP
Usually the data file is in hledger\[aq]s journal format, but it can Usually the data file is in hledger\[aq]s journal format, but it can be
also be one of several other formats, listed below. in any of the supported file formats, which currently are:
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:
.PP .PP
.TS .TS
tab(@); tab(@);
lw(7.6n) lw(31.2n) lw(31.2n). lw(7.8n) lw(39.5n) lw(22.7n).
T{ T{
Reader: Reader:
T}@T{ T}@T{
@ -1002,37 +999,45 @@ _
T{ T{
\f[C]journal\f[R] \f[C]journal\f[R]
T}@T{ T}@T{
hledger\[aq]s journal format, also some Ledger journals hledger journal files and some Ledger journals, for transactions
T}@T{ T}@T{
\f[C].journal\f[R] \f[C].j\f[R] \f[C].hledger\f[R] \f[C].ledger\f[R] \f[C].journal\f[R] \f[C].j\f[R] \f[C].hledger\f[R] \f[C].ledger\f[R]
T} T}
T{ T{
\f[C]timeclock\f[R] \f[C]timeclock\f[R]
T}@T{ T}@T{
timeclock files (precise time logging) timeclock files, for precise time logging
T}@T{ T}@T{
\f[C].timeclock\f[R] \f[C].timeclock\f[R]
T} T}
T{ T{
\f[C]timedot\f[R] \f[C]timedot\f[R]
T}@T{ T}@T{
timedot files (approximate time logging) timedot files, for approximate time logging
T}@T{ T}@T{
\f[C].timedot\f[R] \f[C].timedot\f[R]
T} T}
T{ T{
\f[C]csv\f[R] \f[C]csv\f[R]
T}@T{ T}@T{
comma-separated values (data interchange) comma/semicolon/tab/other-separated values, for data import
T}@T{ T}@T{
\f[C].csv\f[R] \f[C].csv\f[R] \f[C].ssv\f[R] \f[C].tsv\f[R]
T} T}
.TE .TE
.PP .PP
If needed (eg to ensure correct error messages when a file has the hledger detects the format automatically based on the file extensions
\[dq]wrong\[dq] extension), you can force a specific reader/format by shown above.
prepending it to the file path with a colon. If it can\[aq]t recognise the file extension, it assumes
Examples: \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 .IP
.nf .nf
\f[C] \f[C]
@ -1041,16 +1046,20 @@ $ echo \[aq]i 2009/13/1 08:00:00\[aq] | hledger print -ftimeclock:-
\f[R] \f[R]
.fi .fi
.PP .PP
You can also specify multiple \f[C]-f\f[R] options, to read multiple You can specify multiple \f[C]-f\f[R] options, to read multiple files as
files as one big journal. one big journal.
There are some limitations with this: There are some limitations with this:
.IP \[bu] 2 .IP \[bu] 2
directives in one file will not affect the other files directives in one file will not affect the other files
.IP \[bu] 2 .IP \[bu] 2
balance assertions will not see any account balances from previous files balance assertions will not see any account balances from previous files
.PP .PP
If you need those, either use the include directive, or concatenate the If you need either of those things, you can
files, eg: \f[C]cat a.journal b.journal | hledger -f- CMD\f[R]. .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 .SS Output destination
.PP .PP
hledger commands send their output to the terminal by default. 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. then by account name.
Or with \f[C]-S/--sort-amount\f[R], by their balance amount, largest Or with \f[C]-S/--sort-amount\f[R], by their balance amount, largest
first. first.
(Note: \f[C]-S\f[R] has a problem in hledger 1.11-1.18).
.PP .PP
\[dq]Boring\[dq] accounts, which contain a single interesting subaccount \[dq]Boring\[dq] accounts, which contain a single interesting subaccount
and no balance of their own, are elided into the following line for more 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- $ cat some.journal | hledger -f-
Usually the data file is in hledger's journal format, but it can also Usually the data file is in hledger's journal format, but it can be
be one of several other formats, listed below. hledger detects the in any of the supported file formats, which currently are:
format automatically based on the file extension, or if that is not
recognised, by trying each built-in "reader" in turn:
Reader: Reads: Used for file extensions: Reader: Reads: Used for file
--------------------------------------------------------------------------- extensions:
'journal'hledger's journal format, also '.journal' '.j' '.hledger' --------------------------------------------------------------------------
some Ledger journals '.ledger' 'journal'hledger journal files and some Ledger '.journal' '.j'
'timeclock'timeclock files (precise time '.timeclock' journals, for transactions '.hledger' '.ledger'
logging) 'timeclock'timeclock files, for precise time '.timeclock'
'timedot'timedot files (approximate '.timedot' logging
time logging) 'timedot'timedot files, for approximate time '.timedot'
'csv' comma-separated values (data '.csv' logging
interchange) '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 hledger detects the format automatically based on the file extensions
"wrong" extension), you can force a specific reader/format by prepending shown above. If it can't recognise the file extension, it assumes
it to the file path with a colon. Examples: '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 $ hledger -f csv:/some/csv-file.dat stats
$ echo 'i 2009/13/1 08:00:00' | hledger print -ftimeclock:- $ echo 'i 2009/13/1 08:00:00' | hledger print -ftimeclock:-
You can also specify multiple '-f' options, to read multiple files as You can specify multiple '-f' options, to read multiple files as one
one big journal. There are some limitations with this: big journal. There are some limitations with this:
* directives in one file will not affect the other files * directives in one file will not affect the other files
* balance assertions will not see any account balances from previous * balance assertions will not see any account balances from previous
files files
If you need those, either use the include directive, or concatenate If you need either of those things, you can
the files, eg: 'cat a.journal b.journal | hledger -f- CMD'.
* 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 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 By default, accounts are displayed hierarchically, with subaccounts
indented below their parent. At each level of the tree, accounts are indented below their parent. At each level of the tree, accounts are
sorted by account code if any, then by account name. Or with sorted by account code if any, then by account name. Or with
'-S/--sort-amount', by their balance amount, largest first. (Note: '-S' '-S/--sort-amount', by their balance amount, largest first.
has a problem in hledger 1.11-1.18).
"Boring" accounts, which contain a single interesting subaccount and "Boring" accounts, which contain a single interesting subaccount and
no balance of their own, are elided into the following line for more no balance of their own, are elided into the following line for more
@ -4095,164 +4102,164 @@ Node: Unicode characters28869
Ref: #unicode-characters29051 Ref: #unicode-characters29051
Node: Input files30463 Node: Input files30463
Ref: #input-files30606 Ref: #input-files30606
Node: Output destination32535 Node: Output destination32905
Ref: #output-destination32687 Ref: #output-destination33057
Node: Output format33112 Node: Output format33482
Ref: #output-format33262 Ref: #output-format33632
Node: Regular expressions35429 Node: Regular expressions35799
Ref: #regular-expressions35586 Ref: #regular-expressions35956
Node: Smart dates37322 Node: Smart dates37692
Ref: #smart-dates37473 Ref: #smart-dates37843
Node: Report start & end date38834 Node: Report start & end date39204
Ref: #report-start-end-date39006 Ref: #report-start-end-date39376
Node: Report intervals40503 Node: Report intervals40873
Ref: #report-intervals40668 Ref: #report-intervals41038
Node: Period expressions41058 Node: Period expressions41428
Ref: #period-expressions41218 Ref: #period-expressions41588
Node: Depth limiting45550 Node: Depth limiting45920
Ref: #depth-limiting45694 Ref: #depth-limiting46064
Node: Pivoting46026 Node: Pivoting46396
Ref: #pivoting46149 Ref: #pivoting46519
Node: Valuation47825 Node: Valuation48195
Ref: #valuation47927 Ref: #valuation48297
Node: -B Cost48616 Node: -B Cost48986
Ref: #b-cost48720 Ref: #b-cost49090
Node: -V Value48853 Node: -V Value49223
Ref: #v-value48999 Ref: #v-value49369
Node: -X Value in specified commodity49194 Node: -X Value in specified commodity49564
Ref: #x-value-in-specified-commodity49393 Ref: #x-value-in-specified-commodity49763
Node: Valuation date49542 Node: Valuation date49912
Ref: #valuation-date49710 Ref: #valuation-date50080
Node: Market prices50120 Node: Market prices50490
Ref: #market-prices50300 Ref: #market-prices50670
Node: --infer-value market prices from transactions51077 Node: --infer-value market prices from transactions51447
Ref: #infer-value-market-prices-from-transactions51326 Ref: #infer-value-market-prices-from-transactions51696
Node: Valuation commodity52608 Node: Valuation commodity52978
Ref: #valuation-commodity52817 Ref: #valuation-commodity53187
Node: Simple valuation examples54043 Node: Simple valuation examples54413
Ref: #simple-valuation-examples54245 Ref: #simple-valuation-examples54615
Node: --value Flexible valuation54904 Node: --value Flexible valuation55274
Ref: #value-flexible-valuation55112 Ref: #value-flexible-valuation55482
Node: More valuation examples57059 Node: More valuation examples57429
Ref: #more-valuation-examples57268 Ref: #more-valuation-examples57638
Node: Effect of valuation on reports59273 Node: Effect of valuation on reports59643
Ref: #effect-of-valuation-on-reports59461 Ref: #effect-of-valuation-on-reports59831
Node: COMMANDS64982 Node: COMMANDS65352
Ref: #commands65090 Ref: #commands65460
Node: accounts66198 Node: accounts66568
Ref: #accounts66296 Ref: #accounts66666
Node: activity66995 Node: activity67365
Ref: #activity67105 Ref: #activity67475
Node: add67488 Node: add67858
Ref: #add67589 Ref: #add67959
Node: aregister70382 Node: aregister70752
Ref: #aregister70494 Ref: #aregister70864
Node: aregister and custom posting dates71867 Node: aregister and custom posting dates72237
Ref: #aregister-and-custom-posting-dates72040 Ref: #aregister-and-custom-posting-dates72410
Ref: #output-format-172633 Ref: #output-format-173003
Node: balance73038 Node: balance73408
Ref: #balance73155 Ref: #balance73525
Node: Classic balance report74613 Node: Classic balance report74983
Ref: #classic-balance-report74786 Ref: #classic-balance-report75156
Node: Customising the classic balance report76220 Node: Customising the classic balance report76540
Ref: #customising-the-classic-balance-report76448 Ref: #customising-the-classic-balance-report76768
Node: Colour support78524 Node: Colour support78844
Ref: #colour-support78691 Ref: #colour-support79011
Node: Flat mode78787 Node: Flat mode79107
Ref: #flat-mode78935 Ref: #flat-mode79255
Node: Depth limited balance reports79348 Node: Depth limited balance reports79668
Ref: #depth-limited-balance-reports79533 Ref: #depth-limited-balance-reports79853
Node: Percentages79989 Node: Percentages80309
Ref: #percentages80155 Ref: #percentages80475
Node: Multicolumn balance report81292 Node: Multicolumn balance report81612
Ref: #multicolumn-balance-report81472 Ref: #multicolumn-balance-report81792
Node: Budget report87069 Node: Budget report87389
Ref: #budget-report87212 Ref: #budget-report87532
Node: Nested budgets92478 Node: Nested budgets92798
Ref: #nested-budgets92590 Ref: #nested-budgets92910
Ref: #output-format-296071 Ref: #output-format-296391
Node: balancesheet96268 Node: balancesheet96588
Ref: #balancesheet96404 Ref: #balancesheet96724
Node: balancesheetequity97916 Node: balancesheetequity98236
Ref: #balancesheetequity98065 Ref: #balancesheetequity98385
Node: cashflow99141 Node: cashflow99461
Ref: #cashflow99269 Ref: #cashflow99589
Node: check-dates100485 Node: check-dates100805
Ref: #check-dates100612 Ref: #check-dates100932
Node: check-dupes100891 Node: check-dupes101211
Ref: #check-dupes101017 Ref: #check-dupes101337
Node: close101310 Node: close101630
Ref: #close101418 Ref: #close101738
Node: close usage102940 Node: close usage103260
Ref: #close-usage103033 Ref: #close-usage103353
Node: codes105846 Node: codes106166
Ref: #codes105954 Ref: #codes106274
Node: commodities106666 Node: commodities106986
Ref: #commodities106793 Ref: #commodities107113
Node: descriptions106875 Node: descriptions107195
Ref: #descriptions107003 Ref: #descriptions107323
Node: diff107307 Node: diff107627
Ref: #diff107413 Ref: #diff107733
Node: files108460 Node: files108780
Ref: #files108560 Ref: #files108880
Node: help108707 Node: help109027
Ref: #help108807 Ref: #help109127
Node: import109888 Node: import110208
Ref: #import110002 Ref: #import110322
Node: Importing balance assignments110895 Node: Importing balance assignments111215
Ref: #importing-balance-assignments111043 Ref: #importing-balance-assignments111363
Node: incomestatement111692 Node: incomestatement112012
Ref: #incomestatement111825 Ref: #incomestatement112145
Node: notes113170 Node: notes113490
Ref: #notes113283 Ref: #notes113603
Node: payees113651 Node: payees113971
Ref: #payees113757 Ref: #payees114077
Node: prices114177 Node: prices114497
Ref: #prices114283 Ref: #prices114603
Node: print114624 Node: print114944
Ref: #print114734 Ref: #print115054
Node: print-unique119530 Node: print-unique119850
Ref: #print-unique119656 Ref: #print-unique119976
Node: register119941 Node: register120261
Ref: #register120068 Ref: #register120388
Node: Custom register output124517 Node: Custom register output124837
Ref: #custom-register-output124646 Ref: #custom-register-output124966
Node: register-match125983 Node: register-match126303
Ref: #register-match126117 Ref: #register-match126437
Node: rewrite126468 Node: rewrite126788
Ref: #rewrite126583 Ref: #rewrite126903
Node: Re-write rules in a file128438 Node: Re-write rules in a file128758
Ref: #re-write-rules-in-a-file128572 Ref: #re-write-rules-in-a-file128892
Node: Diff output format129782 Node: Diff output format130102
Ref: #diff-output-format129951 Ref: #diff-output-format130271
Node: rewrite vs print --auto131043 Node: rewrite vs print --auto131363
Ref: #rewrite-vs.-print---auto131222 Ref: #rewrite-vs.-print---auto131542
Node: roi131778 Node: roi132098
Ref: #roi131876 Ref: #roi132196
Node: stats132888 Node: stats133208
Ref: #stats132987 Ref: #stats133307
Node: tags133775 Node: tags134095
Ref: #tags133873 Ref: #tags134193
Node: test134392 Node: test134712
Ref: #test134500 Ref: #test134820
Node: Add-on commands135247 Node: Add-on commands135567
Ref: #add-on-commands135364 Ref: #add-on-commands135684
Node: ui136707 Node: ui137027
Ref: #ui136795 Ref: #ui137115
Node: web136849 Node: web137169
Ref: #web136952 Ref: #web137272
Node: iadd137068 Node: iadd137388
Ref: #iadd137179 Ref: #iadd137499
Node: interest137261 Node: interest137581
Ref: #interest137368 Ref: #interest137688
Node: ENVIRONMENT137608 Node: ENVIRONMENT137928
Ref: #environment137720 Ref: #environment138040
Node: FILES138705 Node: FILES139025
Ref: #files-1138808 Ref: #files-1139128
Node: LIMITATIONS139021 Node: LIMITATIONS139341
Ref: #limitations139140 Ref: #limitations139460
Node: TROUBLESHOOTING139882 Node: TROUBLESHOOTING140202
Ref: #troubleshooting139995 Ref: #troubleshooting140315
 
End Tag Table End Tag Table

View File

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