slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc: regen manuals

Browse Source 
I think all the non-content changes are due to newer
doc tools and harmless, including this one hopefully:

    -.B \f[C]--watch\f[R]
    +\f[B]\f[CB]--watch\f[B]\f[R]

[ci skip]
This commit is contained in:
Simon Michael 2020-01-05 07:04:00 -08:00
parent 6b70eadf30
commit f91076cc6a
19 changed files with 1486 additions and 1173 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
hledger-lib/hledger_csv.5
View File

@ -472,6 +472,9 @@ Fields you don\[aq]t care about can be left unnamed.
Currently there must be least two items (there must be at least one
comma).
.PP
Note, always use comma in the fields list, even if your CSV uses another
separator character.
.PP
Here are the standard hledger field/pseudo-field names.
For more about the transaction parts they refer to, see the manual for
hledger\[aq]s journal format.
@ -508,6 +511,7 @@ If the CSV has the currency symbol in a separate field, you can use
.PP
\f[C]balanceN\f[R] sets a balance assertion amount (or if the posting
amount is left empty, a balance assignment).
You may need to adjust this with the \f[C]balance-type\f[R] rule.
.PP
Finally, \f[C]commentN\f[R] sets a comment on the Nth posting.
Comments can also contain tags, as usual.
@ -733,7 +737,52 @@ account2 expenses:misc
include categorisation.rules
\f[R]
.fi
.SS \f[C]balance-type\f[R]
.PP
Balance assertions generated by assigning to balanceN are of the simple
\f[C]=\f[R] type by default, which is a single-commodity,
subaccount-excluding assertion.
You may find the subaccount-including variants more useful, eg if you
have created some virtual subaccounts of checking to help with
budgeting.
You can select a different type of assertion with the
\f[C]balance-type\f[R] rule:
.IP
.nf
\f[C]
# balance assertions will consider all commodities and all subaccounts
balance-type ==*
\f[R]
.fi
.PP
Here are the balance assertion types for quick reference:
.IP
.nf
\f[C]
= single commodity, exclude subaccounts
=* single commodity, include subaccounts
== multi commodity, exclude subaccounts
==* multi commodity, include subaccounts
\f[R]
.fi
.SH TIPS
.SS Rapid feedback
.PP
It\[aq]s a good idea to get rapid feedback while
creating/troubleshooting CSV rules.
Here\[aq]s a good way, using entr from http://eradman.com/entrproject :
.IP
.nf
\f[C]
$ ls foo.csv* | entr bash -c \[aq]echo ----; hledger -f foo.csv print desc:SOMEDESC\[aq]
\f[R]
.fi
.PP
A desc: query (eg) is used to select just one, or a few, transactions of
interest.
\[dq]bash -c\[dq] is used to run multiple commands, so we can echo a
separator each time the command re-runs, making it easier to read the
output.
.SS Valid CSV
.PP
hledger accepts CSV conforming to RFC 4180.
@ -744,17 +793,27 @@ they must be double quotes (not single quotes)
spaces outside the quotes are not allowed
.SS Other separator characters
.PP
With the \f[C]--separator \[aq]CHAR\[aq]\f[R] option (experimental),
hledger will expect the separator to be CHAR instead of a comma.
Ie it will read other \[dq]Character Separated Values\[dq] formats, such
as TSV (Tab Separated Values).
Note: on the command line, use a real tab character in quotes, not Eg:
You can use the \f[C]--separator \[aq]CHAR\[aq]\f[R] command line option
(experimental) to read other kinds of character-separated data.
Eg to read SSV (Semicolon Separated Values), use:
.IP
.nf
\f[C]
$ hledger -f foo.tsv --separator \[aq];\[aq] print
\f[R]
.fi
.PP
Note the semicolon is quoted because it\[aq]s a special shell character.
.PP
To read TSV (Tab Separated Values), use:
.IP
.nf
\f[C]
$ hledger -f foo.tsv --separator \[aq] \[aq] print
\f[R]
.fi
.PP
Note, that\[aq]s a real tab character in quotes, not \f[C]\[rs]t\f[R].
.SS Reading multiple CSV files
.PP
If you use multiple \f[C]-f\f[R] options to read multiple CSV files at

179
hledger-lib/hledger_csv.info
View File

@ -1,4 +1,4 @@
This is hledger_csv.info, produced by makeinfo version 6.5 from stdin.
This is hledger_csv.info, produced by makeinfo version 6.7 from stdin.

File: hledger_csv.info, Node: Top, Next: EXAMPLES, Up: (dir)
@ -376,6 +376,7 @@ Blank lines and lines beginning with '#' or ';' are ignored.
* date-format::
* newest-first::
* include::
* balance-type::

File: hledger_csv.info, Node: skip, Next: fields, Up: CSV RULES
@ -421,6 +422,9 @@ fields date, description, , amount, , , somefield, anotherfield
can be left unnamed. Currently there must be least two items (there
must be at least one comma).
Note, always use comma in the fields list, even if your CSV uses
another separator character.
Here are the standard hledger field/pseudo-field names. For more
about the transaction parts they refer to, see the manual for hledger's
journal format.
@ -466,7 +470,8 @@ indicating an unbalanced posting.)
affects ALL postings.
'balanceN' sets a balance assertion amount (or if the posting amount
is left empty, a balance assignment).
is left empty, a balance assignment). You may need to adjust this with
the 'balance-type' rule.
Finally, 'commentN' sets a comment on the Nth posting. Comments can
also contain tags, as usual.
@ -625,7 +630,7 @@ oldest first or newest first. But if all of the following are true:
newest-first

File: hledger_csv.info, Node: include, Prev: newest-first, Up: CSV RULES
File: hledger_csv.info, Node: include, Next: balance-type, Prev: newest-first, Up: CSV RULES
2.8 'include'
=============
@ -647,6 +652,29 @@ account2 expenses:misc
## common rules
include categorisation.rules

File: hledger_csv.info, Node: balance-type, Prev: include, Up: CSV RULES
2.9 'balance-type'
==================
Balance assertions generated by assigning to balanceN are of the simple
'=' type by default, which is a single-commodity, subaccount-excluding
assertion. You may find the subaccount-including variants more useful,
eg if you have created some virtual subaccounts of checking to help with
budgeting. You can select a different type of assertion with the
'balance-type' rule:
# balance assertions will consider all commodities and all subaccounts
balance-type ==*
Here are the balance assertion types for quick reference:
= single commodity, exclude subaccounts
=* single commodity, include subaccounts
== multi commodity, exclude subaccounts
==* multi commodity, include subaccounts

File: hledger_csv.info, Node: TIPS, Prev: CSV RULES, Up: Top
@ -655,6 +683,7 @@ File: hledger_csv.info, Node: TIPS, Prev: CSV RULES, Up: Top
* Menu:
* Rapid feedback::
* Valid CSV::
* Other separator characters::
* Reading multiple CSV files::
@ -666,9 +695,26 @@ File: hledger_csv.info, Node: TIPS, Prev: CSV RULES, Up: Top
* How CSV rules are evaluated::

File: hledger_csv.info, Node: Valid CSV, Next: Other separator characters, Up: TIPS
File: hledger_csv.info, Node: Rapid feedback, Next: Valid CSV, Up: TIPS
3.1 Valid CSV
3.1 Rapid feedback
==================
It's a good idea to get rapid feedback while creating/troubleshooting
CSV rules. Here's a good way, using entr from
http://eradman.com/entrproject :
$ ls foo.csv* | entr bash -c 'echo ----; hledger -f foo.csv print desc:SOMEDESC'
A desc: query (eg) is used to select just one, or a few, transactions
of interest. "bash -c" is used to run multiple commands, so we can echo
a separator each time the command re-runs, making it easier to read the
output.

File: hledger_csv.info, Node: Valid CSV, Next: Other separator characters, Prev: Rapid feedback, Up: TIPS
3.2 Valid CSV
=============
hledger accepts CSV conforming to RFC 4180. When CSV values are
@ -680,21 +726,27 @@ enclosed in quotes, note:

File: hledger_csv.info, Node: Other separator characters, Next: Reading multiple CSV files, Prev: Valid CSV, Up: TIPS
3.2 Other separator characters
3.3 Other separator characters
==============================
With the '--separator 'CHAR'' option (experimental), hledger will expect
the separator to be CHAR instead of a comma. Ie it will read other
"Character Separated Values" formats, such as TSV (Tab Separated
Values). Note: on the command line, use a real tab character in quotes,
not
You can use the '--separator 'CHAR'' command line option (experimental)
to read other kinds of character-separated data. Eg to read SSV
(Semicolon Separated Values), use:
$ hledger -f foo.tsv --separator ';' print
Note the semicolon is quoted because it's a special shell character.
To read TSV (Tab Separated Values), use:
$ hledger -f foo.tsv --separator ' ' print
Note, that's a real tab character in quotes, not '\t'.

File: hledger_csv.info, Node: Reading multiple CSV files, Next: Valid transactions, Prev: Other separator characters, Up: TIPS
3.3 Reading multiple CSV files
3.4 Reading multiple CSV files
==============================
If you use multiple '-f' options to read multiple CSV files at once,
@ -705,7 +757,7 @@ used for all the CSV files.

File: hledger_csv.info, Node: Valid transactions, Next: Deduplicating importing, Prev: Reading multiple CSV files, Up: TIPS
3.4 Valid transactions
3.5 Valid transactions
======================
After reading a CSV file, hledger post-processes and validates the
@ -724,7 +776,7 @@ $ hledger -f file.csv print | hledger -f- print

File: hledger_csv.info, Node: Deduplicating importing, Next: Setting amounts, Prev: Valid transactions, Up: TIPS
3.5 Deduplicating, importing
3.6 Deduplicating, importing
============================
When you download a CSV file periodically, eg to get your latest bank
@ -754,7 +806,7 @@ CSV data. See:

File: hledger_csv.info, Node: Setting amounts, Next: Setting currency/commodity, Prev: Deduplicating importing, Up: TIPS
3.6 Setting amounts
3.7 Setting amounts
===================
A posting amount can be set in one of these ways:
@ -783,7 +835,7 @@ A posting amount can be set in one of these ways:

File: hledger_csv.info, Node: Setting currency/commodity, Next: Referencing other fields, Prev: Setting amounts, Up: TIPS
3.7 Setting currency/commodity
3.8 Setting currency/commodity
==============================
If the currency/commodity symbol is included in the CSV's amount
@ -810,7 +862,7 @@ field(s), you don't have to do anything special.

File: hledger_csv.info, Node: Referencing other fields, Next: How CSV rules are evaluated, Prev: Setting currency/commodity, Up: TIPS
3.8 Referencing other fields
3.9 Referencing other fields
============================
In field assignments, you can interpolate only CSV fields, not hledger
@ -847,8 +899,8 @@ if something

File: hledger_csv.info, Node: How CSV rules are evaluated, Prev: Referencing other fields, Up: TIPS
3.9 How CSV rules are evaluated
===============================
3.10 How CSV rules are evaluated
================================
Here's how to think of CSV rules being evaluated (if you really need
to). First,
@ -900,45 +952,54 @@ Node: Paypal6438
Ref: #paypal6532
Node: CSV RULES14415
Ref: #csv-rules14524
Node: skip14769
Ref: #skip14862
Node: fields15237
Ref: #fields15359
Node: Transaction field names16426
Ref: #transaction-field-names16586
Node: Posting field names16697
Ref: #posting-field-names16849
Node: field assignment18081
Ref: #field-assignment18217
Node: if19035
Ref: #if19144
Node: end20860
Ref: #end20966
Node: date-format21190
Ref: #date-format21322
Node: newest-first22071
Ref: #newest-first22209
Node: include22892
Ref: #include23000
Node: TIPS23444
Ref: #tips23526
Node: Valid CSV23775
Ref: #valid-csv23894
Node: Other separator characters24086
Ref: #other-separator-characters24274
Node: Reading multiple CSV files24603
Ref: #reading-multiple-csv-files24800
Node: Valid transactions25041
Ref: #valid-transactions25219
Node: Deduplicating importing25847
Ref: #deduplicating-importing26026
Node: Setting amounts27059
Ref: #setting-amounts27228
Node: Setting currency/commodity28214
Ref: #setting-currencycommodity28406
Node: Referencing other fields29209
Ref: #referencing-other-fields29409
Node: How CSV rules are evaluated30306
Ref: #how-csv-rules-are-evaluated30477
Node: skip14786
Ref: #skip14879
Node: fields15254
Ref: #fields15376
Node: Transaction field names16541
Ref: #transaction-field-names16701
Node: Posting field names16812
Ref: #posting-field-names16964
Node: field assignment18255
Ref: #field-assignment18391
Node: if19209
Ref: #if19318
Node: end21034
Ref: #end21140
Node: date-format21364
Ref: #date-format21496
Node: newest-first22245
Ref: #newest-first22383
Node: include23066
Ref: #include23195
Node: balance-type23639
Ref: #balance-type23757
Node: TIPS24457
Ref: #tips24539
Node: Rapid feedback24807
Ref: #rapid-feedback24924
Node: Valid CSV25384
Ref: #valid-csv25526
Node: Other separator characters25718
Ref: #other-separator-characters25906
Node: Reading multiple CSV files26345
Ref: #reading-multiple-csv-files26542
Node: Valid transactions26783
Ref: #valid-transactions26961
Node: Deduplicating importing27589
Ref: #deduplicating-importing27768
Node: Setting amounts28801
Ref: #setting-amounts28970
Node: Setting currency/commodity29956
Ref: #setting-currencycommodity30148
Node: Referencing other fields30951
Ref: #referencing-other-fields31151
Node: How CSV rules are evaluated32048
Ref: #how-csv-rules-are-evaluated32221

End Tag Table

Local Variables:
coding: utf-8
End:

52
hledger-lib/hledger_csv.txt
View File

@ -366,6 +366,9 @@ CSV RULES
can be left unnamed. Currently there must be least two items (there
must be at least one comma).
Note, always use comma in the fields list, even if your CSV uses an-
other separator character.
Here are the standard hledger field/pseudo-field names. For more about
the transaction parts they refer to, see the manual for hledger's jour-
nal format.
@ -396,7 +399,8 @@ CSV RULES
fects ALL postings.
balanceN sets a balance assertion amount (or if the posting amount is
left empty, a balance assignment).
left empty, a balance assignment). You may need to adjust this with
the balance-type rule.
Finally, commentN sets a comment on the Nth posting. Comments can also
contain tags, as usual.
@ -551,7 +555,37 @@ CSV RULES
## common rules
include categorisation.rules
balance-type
Balance assertions generated by assigning to balanceN are of the simple
= type by default, which is a single-commodity, subaccount-excluding
assertion. You may find the subaccount-including variants more useful,
eg if you have created some virtual subaccounts of checking to help
with budgeting. You can select a different type of assertion with the
balance-type rule:
# balance assertions will consider all commodities and all subaccounts
balance-type ==*
Here are the balance assertion types for quick reference:
= single commodity, exclude subaccounts
=* single commodity, include subaccounts
== multi commodity, exclude subaccounts
==* multi commodity, include subaccounts
TIPS
Rapid feedback
It's a good idea to get rapid feedback while creating/troubleshooting
CSV rules. Here's a good way, using entr from http://eradman.com/entr-
project :
$ ls foo.csv* | entr bash -c 'echo ----; hledger -f foo.csv print desc:SOMEDESC'
A desc: query (eg) is used to select just one, or a few, transactions
of interest. "bash -c" is used to run multiple commands, so we can
echo a separator each time the command re-runs, making it easier to
read the output.
Valid CSV
hledger accepts CSV conforming to RFC 4180. When CSV values are en-
closed in quotes, note:
@ -561,14 +595,20 @@ TIPS
o spaces outside the quotes are not allowed
Other separator characters
With the --separator 'CHAR' option (experimental), hledger will expect
the separator to be CHAR instead of a comma. Ie it will read other
"Character Separated Values" formats, such as TSV (Tab Separated Val-
ues). Note: on the command line, use a real tab character in quotes,
not Eg:
You can use the --separator 'CHAR' command line option (experimental)
to read other kinds of character-separated data. Eg to read SSV (Semi-
colon Separated Values), use:
$ hledger -f foo.tsv --separator ';' print
Note the semicolon is quoted because it's a special shell character.
To read TSV (Tab Separated Values), use:
$ hledger -f foo.tsv --separator ' ' print
Note, that's a real tab character in quotes, not \t.
Reading multiple CSV files
If you use multiple -f options to read multiple CSV files at once,
hledger will look for a correspondingly-named rules file for each CSV

1
hledger-lib/hledger_journal.5
View File

@ -533,6 +533,7 @@ reconciled balances while cleaning up old entries.
You can disable them temporarily with the
\f[C]-I/--ignore-assertions\f[R] flag, which can be useful for
troubleshooting or for reading Ledger files.
(Note: this flag currently does not disable balance assignments, below).
.SS Assertions and ordering
.PP
hledger sorts an account\[aq]s postings and assertions first by date and

174
hledger-lib/hledger_journal.info
View File

@ -1,4 +1,4 @@
This is hledger_journal.info, produced by makeinfo version 6.5 from
This is hledger_journal.info, produced by makeinfo version 6.7 from
stdin.

@ -500,7 +500,8 @@ assertions and report an error if any of them fail. Balance assertions
can protect you from, eg, inadvertently disrupting reconciled balances
while cleaning up old entries. You can disable them temporarily with
the '-I/--ignore-assertions' flag, which can be useful for
troubleshooting or for reading Ledger files.
troubleshooting or for reading Ledger files. (Note: this flag currently
does not disable balance assignments, below).
* Menu:
@ -1779,87 +1780,92 @@ Node: Virtual Postings15303
Ref: #virtual-postings15462
Node: Balance Assertions16682
Ref: #balance-assertions16857
Node: Assertions and ordering17816
Ref: #assertions-and-ordering18002
Node: Assertions and included files18702
Ref: #assertions-and-included-files18943
Node: Assertions and multiple -f options19276
Ref: #assertions-and-multiple--f-options19530
Node: Assertions and commodities19662
Ref: #assertions-and-commodities19892
Node: Assertions and prices21048
Ref: #assertions-and-prices21260
Node: Assertions and subaccounts21700
Ref: #assertions-and-subaccounts21927
Node: Assertions and virtual postings22251
Ref: #assertions-and-virtual-postings22491
Node: Assertions and precision22633
Ref: #assertions-and-precision22824
Node: Balance Assignments23091
Ref: #balance-assignments23272
Node: Balance assignments and prices24437
Ref: #balance-assignments-and-prices24609
Node: Transaction prices24833
Ref: #transaction-prices25002
Node: Comments27268
Ref: #comments27402
Node: Tags28572
Ref: #tags28690
Node: Directives30083
Ref: #directives30226
Node: Comment blocks35834
Ref: #comment-blocks35979
Node: Including other files36155
Ref: #including-other-files36335
Node: Default year36743
Ref: #default-year36912
Node: Declaring commodities37319
Ref: #declaring-commodities37502
Node: Default commodity39163
Ref: #default-commodity39339
Node: Market prices39973
Ref: #market-prices40138
Node: Declaring accounts40979
Ref: #declaring-accounts41155
Node: Account comments42080
Ref: #account-comments42243
Node: Account subdirectives42638
Ref: #account-subdirectives42833
Node: Account types43146
Ref: #account-types43330
Node: Account display order44972
Ref: #account-display-order45142
Node: Rewriting accounts46271
Ref: #rewriting-accounts46456
Node: Basic aliases47182
Ref: #basic-aliases47328
Node: Regex aliases48032
Ref: #regex-aliases48204
Node: Combining aliases48922
Ref: #combining-aliases49100
Node: end aliases50376
Ref: #end-aliases50524
Node: Default parent account50625
Ref: #default-parent-account50791
Node: Periodic transactions51675
Ref: #periodic-transactions51873
Node: Periodic rule syntax53745
Ref: #periodic-rule-syntax53951
Node: Two spaces between period expression and description!54655
Ref: #two-spaces-between-period-expression-and-description54974
Node: Forecasting with periodic transactions55658
Ref: #forecasting-with-periodic-transactions55963
Node: Budgeting with periodic transactions57989
Ref: #budgeting-with-periodic-transactions58228
Node: Auto postings / transaction modifiers58677
Ref: #auto-postings-transaction-modifiers58888
Node: Auto postings and dates61117
Ref: #auto-postings-and-dates61374
Node: Auto postings and transaction balancing / inferred amounts / balance assertions61549
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions61924
Node: Auto posting tags62302
Ref: #auto-posting-tags62541
Node: EDITOR SUPPORT63206
Ref: #editor-support63324
Node: Assertions and ordering17890
Ref: #assertions-and-ordering18076
Node: Assertions and included files18776
Ref: #assertions-and-included-files19017
Node: Assertions and multiple -f options19350
Ref: #assertions-and-multiple--f-options19604
Node: Assertions and commodities19736
Ref: #assertions-and-commodities19966
Node: Assertions and prices21122
Ref: #assertions-and-prices21334
Node: Assertions and subaccounts21774
Ref: #assertions-and-subaccounts22001
Node: Assertions and virtual postings22325
Ref: #assertions-and-virtual-postings22565
Node: Assertions and precision22707
Ref: #assertions-and-precision22898
Node: Balance Assignments23165
Ref: #balance-assignments23346
Node: Balance assignments and prices24511
Ref: #balance-assignments-and-prices24683
Node: Transaction prices24907
Ref: #transaction-prices25076
Node: Comments27342
Ref: #comments27476
Node: Tags28646
Ref: #tags28764
Node: Directives30157
Ref: #directives30300
Node: Comment blocks35908
Ref: #comment-blocks36053
Node: Including other files36229
Ref: #including-other-files36409
Node: Default year36817
Ref: #default-year36986
Node: Declaring commodities37393
Ref: #declaring-commodities37576
Node: Default commodity39237
Ref: #default-commodity39413
Node: Market prices40047
Ref: #market-prices40212
Node: Declaring accounts41053
Ref: #declaring-accounts41229
Node: Account comments42154
Ref: #account-comments42317
Node: Account subdirectives42712
Ref: #account-subdirectives42907
Node: Account types43220
Ref: #account-types43404
Node: Account display order45046
Ref: #account-display-order45216
Node: Rewriting accounts46345
Ref: #rewriting-accounts46530
Node: Basic aliases47256
Ref: #basic-aliases47402
Node: Regex aliases48106
Ref: #regex-aliases48278
Node: Combining aliases48996
Ref: #combining-aliases49174
Node: end aliases50450
Ref: #end-aliases50598
Node: Default parent account50699
Ref: #default-parent-account50865
Node: Periodic transactions51749
Ref: #periodic-transactions51947
Node: Periodic rule syntax53819
Ref: #periodic-rule-syntax54025
Node: Two spaces between period expression and description!54729
Ref: #two-spaces-between-period-expression-and-description55048
Node: Forecasting with periodic transactions55732
Ref: #forecasting-with-periodic-transactions56037
Node: Budgeting with periodic transactions58063
Ref: #budgeting-with-periodic-transactions58302
Node: Auto postings / transaction modifiers58751
Ref: #auto-postings-transaction-modifiers58962
Node: Auto postings and dates61191
Ref: #auto-postings-and-dates61448
Node: Auto postings and transaction balancing / inferred amounts / balance assertions61623
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions61998
Node: Auto posting tags62376
Ref: #auto-posting-tags62615
Node: EDITOR SUPPORT63280
Ref: #editor-support63398

End Tag Table

Local Variables:
coding: utf-8
End:

5
hledger-lib/hledger_journal.txt
View File

@ -384,7 +384,8 @@ FILE FORMAT
tect you from, eg, inadvertently disrupting reconciled balances while
cleaning up old entries. You can disable them temporarily with the
-I/--ignore-assertions flag, which can be useful for troubleshooting or
for reading Ledger files.
for reading Ledger files. (Note: this flag currently does not disable
balance assignments, below).
Assertions and ordering
hledger sorts an account's postings and assertions first by date and
@ -732,8 +733,6 @@ FILE FORMAT
file.)
display how to display amounts of a commodity in reports (symbol side
style and spacing, digit groups, decimal separator, decimal places)
directive which entries and (when there are multiple files) which files
scope are affected by a directive

7
hledger-lib/hledger_timeclock.info
View File

@ -1,4 +1,4 @@
This is hledger_timeclock.info, produced by makeinfo version 6.5 from
This is hledger_timeclock.info, produced by makeinfo version 6.7 from
stdin.

@ -59,3 +59,8 @@ Tag Table:
Node: Top78

End Tag Table

Local Variables:
coding: utf-8
End:

6
hledger-lib/hledger_timeclock.txt
View File

@ -45,9 +45,9 @@ DESCRIPTION
o use emacs and the built-in timeclock.el, or the extended timeclock-
x.el and perhaps the extras in ledgerutils.el
o at the command line, use these bash aliases: shell alias ti="echo i
`date '+%Y-%m-%d %H:%M:%S'` \$* >>$TIMELOG" alias to="echo o `date
'+%Y-%m-%d %H:%M:%S'` >>$TIMELOG"
o at the command line, use these bash aliases: shell alias ti="echo
i `date '+%Y-%m-%d %H:%M:%S'` \$* >>$TIMELOG" alias to="echo o
`date '+%Y-%m-%d %H:%M:%S'` >>$TIMELOG"
o or use the old ti and to scripts in the ledger 2.x repository. These
rely on a "timeclock" executable which I think is just the ledger 2

7
hledger-lib/hledger_timedot.info
View File

@ -1,4 +1,4 @@
This is hledger_timedot.info, produced by makeinfo version 6.5 from
This is hledger_timedot.info, produced by makeinfo version 6.7 from
stdin.

@ -115,3 +115,8 @@ Node: FILE FORMAT812
Ref: #file-format913

End Tag Table

Local Variables:
coding: utf-8
End:

75
hledger-ui/hledger-ui.1
View File

@ -47,113 +47,114 @@ before options as shown above.
Any QUERYARGS are interpreted as a hledger search query which filters
the data.
.TP
.B \f[C]--watch\f[R]
\f[B]\f[CB]--watch\f[B]\f[R]
watch for data and date changes and reload automatically
.TP
.B \f[C]--theme=default|terminal|greenterm\f[R]
\f[B]\f[CB]--theme=default|terminal|greenterm\f[B]\f[R]
use this custom display theme
.TP
.B \f[C]--register=ACCTREGEX\f[R]
\f[B]\f[CB]--register=ACCTREGEX\f[B]\f[R]
start in the (first) matched account\[aq]s register screen
.TP
.B \f[C]--change\f[R]
\f[B]\f[CB]--change\f[B]\f[R]
show period balances (changes) at startup instead of historical balances
.TP
.B \f[C]-F --flat\f[R]
\f[B]\f[CB]-F --flat\f[B]\f[R]
show accounts as a list (default)
.TP
.B \f[C]-T --tree\f[R]
\f[B]\f[CB]-T --tree\f[B]\f[R]
show accounts as a tree
.TP
.B \f[C]--future\f[R]
\f[B]\f[CB]--future\f[B]\f[R]
show transactions dated later than today (normally hidden)
.PP
hledger input options:
.TP
.B \f[C]-f FILE --file=FILE\f[R]
\f[B]\f[CB]-f FILE --file=FILE\f[B]\f[R]
use a different input file.
For stdin, use - (default: \f[C]$LEDGER_FILE\f[R] or
\f[C]$HOME/.hledger.journal\f[R])
.TP
.B \f[C]--rules-file=RULESFILE\f[R]
\f[B]\f[CB]--rules-file=RULESFILE\f[B]\f[R]
Conversion rules file to use when reading CSV (default: FILE.rules)
.TP
.B \f[C]--separator=CHAR\f[R]
\f[B]\f[CB]--separator=CHAR\f[B]\f[R]
Field separator to expect when reading CSV (default: \[aq],\[aq])
.TP
.B \f[C]--alias=OLD=NEW\f[R]
\f[B]\f[CB]--alias=OLD=NEW\f[B]\f[R]
rename accounts named OLD to NEW
.TP
.B \f[C]--anon\f[R]
\f[B]\f[CB]--anon\f[B]\f[R]
anonymize accounts and payees
.TP
.B \f[C]--pivot FIELDNAME\f[R]
\f[B]\f[CB]--pivot FIELDNAME\f[B]\f[R]
use some other field or tag for the account name
.TP
.B \f[C]-I --ignore-assertions\f[R]
ignore any failing balance assertions
\f[B]\f[CB]-I --ignore-assertions\f[B]\f[R]
disable balance assertion checks (note: does not disable balance
assignments)
.PP
hledger reporting options:
.TP
.B \f[C]-b --begin=DATE\f[R]
\f[B]\f[CB]-b --begin=DATE\f[B]\f[R]
include postings/txns on or after this date
.TP
.B \f[C]-e --end=DATE\f[R]
\f[B]\f[CB]-e --end=DATE\f[B]\f[R]
include postings/txns before this date
.TP
.B \f[C]-D --daily\f[R]
\f[B]\f[CB]-D --daily\f[B]\f[R]
multiperiod/multicolumn report by day
.TP
.B \f[C]-W --weekly\f[R]
\f[B]\f[CB]-W --weekly\f[B]\f[R]
multiperiod/multicolumn report by week
.TP
.B \f[C]-M --monthly\f[R]
\f[B]\f[CB]-M --monthly\f[B]\f[R]
multiperiod/multicolumn report by month
.TP
.B \f[C]-Q --quarterly\f[R]
\f[B]\f[CB]-Q --quarterly\f[B]\f[R]
multiperiod/multicolumn report by quarter
.TP
.B \f[C]-Y --yearly\f[R]
\f[B]\f[CB]-Y --yearly\f[B]\f[R]
multiperiod/multicolumn report by year
.TP
.B \f[C]-p --period=PERIODEXP\f[R]
\f[B]\f[CB]-p --period=PERIODEXP\f[B]\f[R]
set start date, end date, and/or reporting interval all at once using
period expressions syntax
.TP
.B \f[C]--date2\f[R]
\f[B]\f[CB]--date2\f[B]\f[R]
match the secondary date instead (see command help for other effects)
.TP
.B \f[C]-U --unmarked\f[R]
\f[B]\f[CB]-U --unmarked\f[B]\f[R]
include only unmarked postings/txns (can combine with -P or -C)
.TP
.B \f[C]-P --pending\f[R]
\f[B]\f[CB]-P --pending\f[B]\f[R]
include only pending postings/txns
.TP
.B \f[C]-C --cleared\f[R]
\f[B]\f[CB]-C --cleared\f[B]\f[R]
include only cleared postings/txns
.TP
.B \f[C]-R --real\f[R]
\f[B]\f[CB]-R --real\f[B]\f[R]
include only non-virtual postings
.TP
.B \f[C]-NUM --depth=NUM\f[R]
\f[B]\f[CB]-NUM --depth=NUM\f[B]\f[R]
hide/aggregate accounts or postings more than NUM levels deep
.TP
.B \f[C]-E --empty\f[R]
\f[B]\f[CB]-E --empty\f[B]\f[R]
show items with zero amount, normally hidden (and vice-versa in
hledger-ui/hledger-web)
.TP
.B \f[C]-B --cost\f[R]
\f[B]\f[CB]-B --cost\f[B]\f[R]
convert amounts to their cost at transaction time (using the transaction
price, if any)
.TP
.B \f[C]-V --value\f[R]
\f[B]\f[CB]-V --value\f[B]\f[R]
convert amounts to their market value on the report end date (using the
most recent applicable market price, if any)
.TP
.B \f[C]--auto\f[R]
\f[B]\f[CB]--auto\f[B]\f[R]
apply automated posting rules to modify transactions.
.TP
.B \f[C]--forecast\f[R]
\f[B]\f[CB]--forecast\f[B]\f[R]
apply periodic transaction rules to generate future transactions, to 6
months from now or report end date.
.PP
@ -164,13 +165,13 @@ Some reporting options can also be written as query arguments.
.PP
hledger help options:
.TP
.B \f[C]-h --help\f[R]
\f[B]\f[CB]-h --help\f[B]\f[R]
show general usage (or after COMMAND, command usage)
.TP
.B \f[C]--version\f[R]
\f[B]\f[CB]--version\f[B]\f[R]
show version
.TP
.B \f[C]--debug[=N]\f[R]
\f[B]\f[CB]--debug[=N]\f[B]\f[R]
show debug output (levels 1-9, default: 1)
.PP
A \[at]FILE argument will be expanded to the contents of FILE, which

34
hledger-ui/hledger-ui.info
View File

@ -1,4 +1,4 @@
This is hledger-ui.info, produced by makeinfo version 6.5 from stdin.
This is hledger-ui.info, produced by makeinfo version 6.7 from stdin.

File: hledger-ui.info, Node: Top, Next: OPTIONS, Up: (dir)
@ -89,7 +89,8 @@ the data.
use some other field or tag for the account name
'-I --ignore-assertions'
ignore any failing balance assertions
disable balance assertion checks (note: does not disable balance
assignments)
hledger reporting options:
@ -425,17 +426,22 @@ Tag Table:
Node: Top71
Node: OPTIONS1101
Ref: #options1198
Node: KEYS4589
Ref: #keys4684
Node: SCREENS8991
Ref: #screens9076
Node: Accounts screen9166
Ref: #accounts-screen9294
Node: Register screen11510
Ref: #register-screen11665
Node: Transaction screen13661
Ref: #transaction-screen13819
Node: Error screen14689
Ref: #error-screen14811
Node: KEYS4634
Ref: #keys4729
Node: SCREENS9036
Ref: #screens9121
Node: Accounts screen9211
Ref: #accounts-screen9339
Node: Register screen11555
Ref: #register-screen11710
Node: Transaction screen13706
Ref: #transaction-screen13864
Node: Error screen14734
Ref: #error-screen14856

End Tag Table

Local Variables:
coding: utf-8
End:

3
hledger-ui/hledger-ui.txt
View File

@ -87,7 +87,8 @@ OPTIONS
use some other field or tag for the account name
-I --ignore-assertions
ignore any failing balance assertions
disable balance assertion checks (note: does not disable balance
assignments)
hledger reporting options:

77
hledger-web/hledger-web.1
View File

@ -51,123 +51,124 @@ in addition to any search query entered there.
Note: if invoking hledger-web as a hledger subcommand, write
\f[C]--\f[R] before options, as shown in the synopsis above.
.TP
.B \f[C]--serve\f[R]
\f[B]\f[CB]--serve\f[B]\f[R]
serve and log requests, don\[aq]t browse or auto-exit
.TP
.B \f[C]--serve-api\f[R]
\f[B]\f[CB]--serve-api\f[B]\f[R]
like --serve, but serve only the JSON web API, without the server-side
web UI
.TP
.B \f[C]--host=IPADDR\f[R]
\f[B]\f[CB]--host=IPADDR\f[B]\f[R]
listen on this IP address (default: 127.0.0.1)
.TP
.B \f[C]--port=PORT\f[R]
\f[B]\f[CB]--port=PORT\f[B]\f[R]
listen on this TCP port (default: 5000)
.TP
.B \f[C]--base-url=URL\f[R]
\f[B]\f[CB]--base-url=URL\f[B]\f[R]
set the base url (default: http://IPADDR:PORT).
You would change this when sharing over the network, or integrating
within a larger website.
.TP
.B \f[C]--file-url=URL\f[R]
\f[B]\f[CB]--file-url=URL\f[B]\f[R]
set the static files url (default: BASEURL/static).
hledger-web normally serves static files itself, but if you wanted to
serve them from another server for efficiency, you would set the url
with this.
.TP
.B \f[C]--capabilities=CAP[,CAP..]\f[R]
\f[B]\f[CB]--capabilities=CAP[,CAP..]\f[B]\f[R]
enable the view, add, and/or manage capabilities (default: view,add)
.TP
.B \f[C]--capabilities-header=HTTPHEADER\f[R]
\f[B]\f[CB]--capabilities-header=HTTPHEADER\f[B]\f[R]
read capabilities to enable from a HTTP header, like
X-Sandstorm-Permissions (default: disabled)
.PP
hledger input options:
.TP
.B \f[C]-f FILE --file=FILE\f[R]
\f[B]\f[CB]-f FILE --file=FILE\f[B]\f[R]
use a different input file.
For stdin, use - (default: \f[C]$LEDGER_FILE\f[R] or
\f[C]$HOME/.hledger.journal\f[R])
.TP
.B \f[C]--rules-file=RULESFILE\f[R]
\f[B]\f[CB]--rules-file=RULESFILE\f[B]\f[R]
Conversion rules file to use when reading CSV (default: FILE.rules)
.TP
.B \f[C]--separator=CHAR\f[R]
\f[B]\f[CB]--separator=CHAR\f[B]\f[R]
Field separator to expect when reading CSV (default: \[aq],\[aq])
.TP
.B \f[C]--alias=OLD=NEW\f[R]
\f[B]\f[CB]--alias=OLD=NEW\f[B]\f[R]
rename accounts named OLD to NEW
.TP
.B \f[C]--anon\f[R]
\f[B]\f[CB]--anon\f[B]\f[R]
anonymize accounts and payees
.TP
.B \f[C]--pivot FIELDNAME\f[R]
\f[B]\f[CB]--pivot FIELDNAME\f[B]\f[R]
use some other field or tag for the account name
.TP
.B \f[C]-I --ignore-assertions\f[R]
ignore any failing balance assertions
\f[B]\f[CB]-I --ignore-assertions\f[B]\f[R]
disable balance assertion checks (note: does not disable balance
assignments)
.PP
hledger reporting options:
.TP
.B \f[C]-b --begin=DATE\f[R]
\f[B]\f[CB]-b --begin=DATE\f[B]\f[R]
include postings/txns on or after this date
.TP
.B \f[C]-e --end=DATE\f[R]
\f[B]\f[CB]-e --end=DATE\f[B]\f[R]
include postings/txns before this date
.TP
.B \f[C]-D --daily\f[R]
\f[B]\f[CB]-D --daily\f[B]\f[R]
multiperiod/multicolumn report by day
.TP
.B \f[C]-W --weekly\f[R]
\f[B]\f[CB]-W --weekly\f[B]\f[R]
multiperiod/multicolumn report by week
.TP
.B \f[C]-M --monthly\f[R]
\f[B]\f[CB]-M --monthly\f[B]\f[R]
multiperiod/multicolumn report by month
.TP
.B \f[C]-Q --quarterly\f[R]
\f[B]\f[CB]-Q --quarterly\f[B]\f[R]
multiperiod/multicolumn report by quarter
.TP
.B \f[C]-Y --yearly\f[R]
\f[B]\f[CB]-Y --yearly\f[B]\f[R]
multiperiod/multicolumn report by year
.TP
.B \f[C]-p --period=PERIODEXP\f[R]
\f[B]\f[CB]-p --period=PERIODEXP\f[B]\f[R]
set start date, end date, and/or reporting interval all at once using
period expressions syntax
.TP
.B \f[C]--date2\f[R]
\f[B]\f[CB]--date2\f[B]\f[R]
match the secondary date instead (see command help for other effects)
.TP
.B \f[C]-U --unmarked\f[R]
\f[B]\f[CB]-U --unmarked\f[B]\f[R]
include only unmarked postings/txns (can combine with -P or -C)
.TP
.B \f[C]-P --pending\f[R]
\f[B]\f[CB]-P --pending\f[B]\f[R]
include only pending postings/txns
.TP
.B \f[C]-C --cleared\f[R]
\f[B]\f[CB]-C --cleared\f[B]\f[R]
include only cleared postings/txns
.TP
.B \f[C]-R --real\f[R]
\f[B]\f[CB]-R --real\f[B]\f[R]
include only non-virtual postings
.TP
.B \f[C]-NUM --depth=NUM\f[R]
\f[B]\f[CB]-NUM --depth=NUM\f[B]\f[R]
hide/aggregate accounts or postings more than NUM levels deep
.TP
.B \f[C]-E --empty\f[R]
\f[B]\f[CB]-E --empty\f[B]\f[R]
show items with zero amount, normally hidden (and vice-versa in
hledger-ui/hledger-web)
.TP
.B \f[C]-B --cost\f[R]
\f[B]\f[CB]-B --cost\f[B]\f[R]
convert amounts to their cost at transaction time (using the transaction
price, if any)
.TP
.B \f[C]-V --value\f[R]
\f[B]\f[CB]-V --value\f[B]\f[R]
convert amounts to their market value on the report end date (using the
most recent applicable market price, if any)
.TP
.B \f[C]--auto\f[R]
\f[B]\f[CB]--auto\f[B]\f[R]
apply automated posting rules to modify transactions.
.TP
.B \f[C]--forecast\f[R]
\f[B]\f[CB]--forecast\f[B]\f[R]
apply periodic transaction rules to generate future transactions, to 6
months from now or report end date.
.PP
@ -178,13 +179,13 @@ Some reporting options can also be written as query arguments.
.PP
hledger help options:
.TP
.B \f[C]-h --help\f[R]
\f[B]\f[CB]-h --help\f[B]\f[R]
show general usage (or after COMMAND, command usage)
.TP
.B \f[C]--version\f[R]
\f[B]\f[CB]--version\f[B]\f[R]
show version
.TP
.B \f[C]--debug[=N]\f[R]
\f[B]\f[CB]--debug[=N]\f[B]\f[R]
show debug output (levels 1-9, default: 1)
.PP
A \[at]FILE argument will be expanded to the contents of FILE, which

26
hledger-web/hledger-web.info
View File

@ -1,4 +1,4 @@
This is hledger-web.info, produced by makeinfo version 6.5 from stdin.
This is hledger-web.info, produced by makeinfo version 6.7 from stdin.

File: hledger-web.info, Node: Top, Next: OPTIONS, Up: (dir)
@ -103,7 +103,8 @@ before options, as shown in the synopsis above.
use some other field or tag for the account name
'-I --ignore-assertions'
ignore any failing balance assertions
disable balance assertion checks (note: does not disable balance
assignments)
hledger reporting options:
@ -342,13 +343,18 @@ Tag Table:
Node: Top72
Node: OPTIONS1359
Ref: #options1464
Node: PERMISSIONS6743
Ref: #permissions6882
Node: EDITING UPLOADING DOWNLOADING8094
Ref: #editing-uploading-downloading8275
Node: RELOADING9109
Ref: #reloading9243
Node: JSON API9676
Ref: #json-api9770
Node: PERMISSIONS6788
Ref: #permissions6927
Node: EDITING UPLOADING DOWNLOADING8139
Ref: #editing-uploading-downloading8320
Node: RELOADING9154
Ref: #reloading9288
Node: JSON API9721
Ref: #json-api9815

End Tag Table

Local Variables:
coding: utf-8
End:

3
hledger-web/hledger-web.txt
View File

@ -97,7 +97,8 @@ OPTIONS
use some other field or tag for the account name
-I --ignore-assertions
ignore any failing balance assertions
disable balance assertion checks (note: does not disable balance
assignments)
hledger reporting options:

184
hledger/hledger.1
View File

@ -159,101 +159,102 @@ by most hledger commands, run \f[C]hledger -h\f[R].
.PP
General help options:
.TP
.B \f[C]-h --help\f[R]
\f[B]\f[CB]-h --help\f[B]\f[R]
show general usage (or after COMMAND, command usage)
.TP
.B \f[C]--version\f[R]
\f[B]\f[CB]--version\f[B]\f[R]
show version
.TP
.B \f[C]--debug[=N]\f[R]
\f[B]\f[CB]--debug[=N]\f[B]\f[R]
show debug output (levels 1-9, default: 1)
.PP
General input options:
.TP
.B \f[C]-f FILE --file=FILE\f[R]
\f[B]\f[CB]-f FILE --file=FILE\f[B]\f[R]
use a different input file.
For stdin, use - (default: \f[C]$LEDGER_FILE\f[R] or
\f[C]$HOME/.hledger.journal\f[R])
.TP
.B \f[C]--rules-file=RULESFILE\f[R]
\f[B]\f[CB]--rules-file=RULESFILE\f[B]\f[R]
Conversion rules file to use when reading CSV (default: FILE.rules)
.TP
.B \f[C]--separator=CHAR\f[R]
\f[B]\f[CB]--separator=CHAR\f[B]\f[R]
Field separator to expect when reading CSV (default: \[aq],\[aq])
.TP
.B \f[C]--alias=OLD=NEW\f[R]
\f[B]\f[CB]--alias=OLD=NEW\f[B]\f[R]
rename accounts named OLD to NEW
.TP
.B \f[C]--anon\f[R]
\f[B]\f[CB]--anon\f[B]\f[R]
anonymize accounts and payees
.TP
.B \f[C]--pivot FIELDNAME\f[R]
\f[B]\f[CB]--pivot FIELDNAME\f[B]\f[R]
use some other field or tag for the account name
.TP
.B \f[C]-I --ignore-assertions\f[R]
ignore any failing balance assertions
\f[B]\f[CB]-I --ignore-assertions\f[B]\f[R]
disable balance assertion checks (note: does not disable balance
assignments)
.PP
General reporting options:
.TP
.B \f[C]-b --begin=DATE\f[R]
\f[B]\f[CB]-b --begin=DATE\f[B]\f[R]
include postings/txns on or after this date
.TP
.B \f[C]-e --end=DATE\f[R]
\f[B]\f[CB]-e --end=DATE\f[B]\f[R]
include postings/txns before this date
.TP
.B \f[C]-D --daily\f[R]
\f[B]\f[CB]-D --daily\f[B]\f[R]
multiperiod/multicolumn report by day
.TP
.B \f[C]-W --weekly\f[R]
\f[B]\f[CB]-W --weekly\f[B]\f[R]
multiperiod/multicolumn report by week
.TP
.B \f[C]-M --monthly\f[R]
\f[B]\f[CB]-M --monthly\f[B]\f[R]
multiperiod/multicolumn report by month
.TP
.B \f[C]-Q --quarterly\f[R]
\f[B]\f[CB]-Q --quarterly\f[B]\f[R]
multiperiod/multicolumn report by quarter
.TP
.B \f[C]-Y --yearly\f[R]
\f[B]\f[CB]-Y --yearly\f[B]\f[R]
multiperiod/multicolumn report by year
.TP
.B \f[C]-p --period=PERIODEXP\f[R]
\f[B]\f[CB]-p --period=PERIODEXP\f[B]\f[R]
set start date, end date, and/or reporting interval all at once using
period expressions syntax
.TP
.B \f[C]--date2\f[R]
\f[B]\f[CB]--date2\f[B]\f[R]
match the secondary date instead (see command help for other effects)
.TP
.B \f[C]-U --unmarked\f[R]
\f[B]\f[CB]-U --unmarked\f[B]\f[R]
include only unmarked postings/txns (can combine with -P or -C)
.TP
.B \f[C]-P --pending\f[R]
\f[B]\f[CB]-P --pending\f[B]\f[R]
include only pending postings/txns
.TP
.B \f[C]-C --cleared\f[R]
\f[B]\f[CB]-C --cleared\f[B]\f[R]
include only cleared postings/txns
.TP
.B \f[C]-R --real\f[R]
\f[B]\f[CB]-R --real\f[B]\f[R]
include only non-virtual postings
.TP
.B \f[C]-NUM --depth=NUM\f[R]
\f[B]\f[CB]-NUM --depth=NUM\f[B]\f[R]
hide/aggregate accounts or postings more than NUM levels deep
.TP
.B \f[C]-E --empty\f[R]
\f[B]\f[CB]-E --empty\f[B]\f[R]
show items with zero amount, normally hidden (and vice-versa in
hledger-ui/hledger-web)
.TP
.B \f[C]-B --cost\f[R]
\f[B]\f[CB]-B --cost\f[B]\f[R]
convert amounts to their cost at transaction time (using the transaction
price, if any)
.TP
.B \f[C]-V --value\f[R]
\f[B]\f[CB]-V --value\f[B]\f[R]
convert amounts to their market value on the report end date (using the
most recent applicable market price, if any)
.TP
.B \f[C]--auto\f[R]
\f[B]\f[CB]--auto\f[B]\f[R]
apply automated posting rules to modify transactions.
.TP
.B \f[C]--forecast\f[R]
\f[B]\f[CB]--forecast\f[B]\f[R]
apply periodic transaction rules to generate future transactions, to 6
months from now or report end date.
.PP
@ -773,7 +774,7 @@ start and end date like so:
.PP
.TS
tab(@);
l l.
l r.
T{
\f[C]-p \[dq]2009\[dq]\f[R]
T}@T{
@ -1101,20 +1102,20 @@ more general \f[C]--value\f[R] option:
The TYPE part basically selects either \[dq]cost\[dq], or \[dq]market
value\[dq] plus a valuation date:
.TP
.B \f[C]--value=cost\f[R]
\f[B]\f[CB]--value=cost\f[B]\f[R]
Convert amounts to cost, using the prices recorded in transactions.
.TP
.B \f[C]--value=end\f[R]
\f[B]\f[CB]--value=end\f[B]\f[R]
Convert amounts to their value in a default valuation commodity, using
market prices on the last day of the report period (or if unspecified,
the journal\[aq]s end date); or in multiperiod reports, market prices on
the last day of each subperiod.
.TP
.B \f[C]--value=now\f[R]
\f[B]\f[CB]--value=now\f[B]\f[R]
Convert amounts to their value in default valuation commodity using
current market prices (as of when report is generated).
.TP
.B \f[C]--value=YYYY-MM-DD\f[R]
\f[B]\f[CB]--value=YYYY-MM-DD\f[B]\f[R]
Convert amounts to their value in default valuation commodity using
market prices on this date.
.PP
@ -1509,30 +1510,30 @@ T}
.PP
\f[B]Additional notes\f[R]
.TP
.B \f[I]cost\f[R]
\f[I]cost\f[R]
calculated using price(s) recorded in the transaction(s).
.TP
.B \f[I]value\f[R]
\f[I]value\f[R]
market value using available market price declarations, or the unchanged
amount if no conversion rate can be found.
.TP
.B \f[I]report start\f[R]
\f[I]report start\f[R]
the first day of the report period specified with -b or -p or date:,
otherwise today.
.TP
.B \f[I]report or journal start\f[R]
\f[I]report or journal start\f[R]
the first day of the report period specified with -b or -p or date:,
otherwise the earliest transaction date in the journal, otherwise today.
.TP
.B \f[I]report end\f[R]
\f[I]report end\f[R]
the last day of the report period specified with -e or -p or date:,
otherwise today.
.TP
.B \f[I]report or journal end\f[R]
\f[I]report or journal end\f[R]
the last day of the report period specified with -e or -p or date:,
otherwise the latest transaction date in the journal, otherwise today.
.TP
.B \f[I]report interval\f[R]
\f[I]report interval\f[R]
a flag (-D/-W/-M/-Q/-Y) or period expression that activates the
report\[aq]s multi-period mode (whether showing one or many subperiods).
.SS Combining -B, -V, -X, --value
@ -1646,12 +1647,12 @@ The following kinds of search terms can be used.
Remember these can also be prefixed with \f[B]\f[CB]not:\f[B]\f[R], eg
to exclude a particular subaccount.
.TP
.B \f[B]\f[CB]REGEX\f[B], \f[CB]acct:REGEX\f[B]\f[R]
\f[B]\f[R]\f[C]REGEX\f[R]\f[B], \f[R]\f[C]acct:REGEX\f[R]\f[B]\f[R]
match account names by this regular expression.
(With no prefix, \f[C]acct:\f[R] is assumed.)
same as above
.TP
.B \f[B]\f[CB]amt:N, amt:<N, amt:<=N, amt:>N, amt:>=N\f[B]\f[R]
\f[B]\f[R]\f[C]amt:N, amt:<N, amt:<=N, amt:>N, amt:>=N\f[R]\f[B]\f[R]
match postings with a single-commodity amount that is equal to, less
than, or greater than N.
(Multi-commodity amounts are not tested, and will always match.) The
@ -1659,10 +1660,10 @@ comparison has two modes: if N is preceded by a + or - sign (or is 0),
the two signed numbers are compared.
Otherwise, the absolute magnitudes are compared, ignoring sign.
.TP
.B \f[B]\f[CB]code:REGEX\f[B]\f[R]
\f[B]\f[R]\f[C]code:REGEX\f[R]\f[B]\f[R]
match by transaction code (eg check number)
.TP
.B \f[B]\f[CB]cur:REGEX\f[B]\f[R]
\f[B]\f[R]\f[C]cur:REGEX\f[R]\f[B]\f[R]
match postings or transactions including any amounts whose
currency/commodity symbol is fully matched by REGEX.
(For a partial match, use \f[C].*REGEX.*\f[R]).
@ -1673,10 +1674,10 @@ quoting to hide it from the shell, so eg do:
\f[C]hledger print cur:\[aq]\[rs]$\[aq]\f[R] or
\f[C]hledger print cur:\[rs]\[rs]$\f[R].
.TP
.B \f[B]\f[CB]desc:REGEX\f[B]\f[R]
\f[B]\f[R]\f[C]desc:REGEX\f[R]\f[B]\f[R]
match transaction descriptions.
.TP
.B \f[B]\f[CB]date:PERIODEXPR\f[B]\f[R]
\f[B]\f[R]\f[C]date:PERIODEXPR\f[R]\f[B]\f[R]
match dates within the specified period.
PERIODEXPR is a period expression (with no report interval).
Examples: \f[C]date:2016\f[R], \f[C]date:thismonth\f[R],
@ -1684,27 +1685,27 @@ Examples: \f[C]date:2016\f[R], \f[C]date:thismonth\f[R],
If the \f[C]--date2\f[R] command line flag is present, this matches
secondary dates instead.
.TP
.B \f[B]\f[CB]date2:PERIODEXPR\f[B]\f[R]
\f[B]\f[R]\f[C]date2:PERIODEXPR\f[R]\f[B]\f[R]
match secondary dates within the specified period.
.TP
.B \f[B]\f[CB]depth:N\f[B]\f[R]
\f[B]\f[R]\f[C]depth:N\f[R]\f[B]\f[R]
match (or display, depending on command) accounts at or above this depth
.TP
.B \f[B]\f[CB]note:REGEX\f[B]\f[R]
\f[B]\f[R]\f[C]note:REGEX\f[R]\f[B]\f[R]
match transaction notes (part of description right of \f[C]|\f[R], or
whole description when there\[aq]s no \f[C]|\f[R])
.TP
.B \f[B]\f[CB]payee:REGEX\f[B]\f[R]
\f[B]\f[R]\f[C]payee:REGEX\f[R]\f[B]\f[R]
match transaction payee/payer names (part of description left of
\f[C]|\f[R], or whole description when there\[aq]s no \f[C]|\f[R])
.TP
.B \f[B]\f[CB]real:, real:0\f[B]\f[R]
\f[B]\f[R]\f[C]real:, real:0\f[R]\f[B]\f[R]
match real or virtual postings respectively
.TP
.B \f[B]\f[CB]status:, status:!, status:*\f[B]\f[R]
\f[B]\f[R]\f[C]status:, status:!, status:*\f[R]\f[B]\f[R]
match unmarked, pending, or cleared transactions respectively
.TP
.B \f[B]\f[CB]tag:REGEX[=REGEX]\f[B]\f[R]
\f[B]\f[R]\f[C]tag:REGEX[=REGEX]\f[R]\f[B]\f[R]
match by tag name, and optionally also by tag value.
Note a tag: query is considered to match a transaction if it matches any
of the postings.
@ -1714,7 +1715,7 @@ transaction.
The following special search term is used automatically in hledger-web,
only:
.TP
.B \f[B]\f[CB]inacct:ACCTNAME\f[B]\f[R]
\f[B]\f[R]\f[C]inacct:ACCTNAME\f[R]\f[B]\f[R]
tells hledger-web to show the transaction register for this account.
Can be filtered further with \f[C]acct\f[R] etc.
.PP
@ -1749,6 +1750,8 @@ accounts, a
.PD
Show account names.
.PP
$FLAGS$
.PP
This command lists account names, either declared with account
directives (--declared), posted to (--used), or both (the default).
With query arguments, only matched account names and account names
@ -1784,6 +1787,8 @@ activity
.PD
Show an ascii barchart of posting counts per interval.
.PP
$FLAGS$
.PP
The activity command displays an ascii histogram showing transaction
counts by day, week, month or other reporting interval (by day is the
default).
@ -1808,6 +1813,8 @@ add
.PD
Prompt for transactions and add them to the journal.
.PP
$FLAGS$
.PP
Many hledger users edit their journals directly with a text editor, or
generate them from CSV.
For more interactive data entry, there is the \f[C]add\f[R] command,
@ -1891,6 +1898,8 @@ balance, bal, b
.PD
Show accounts and their balances.
.PP
$FLAGS$
.PP
The balance command is hledger\[aq]s most versatile command.
Note, despite the name, it is not always used for showing real-world
account balances; the more accounting-aware balancesheet and
@ -2512,6 +2521,8 @@ Note this report shows all account balances with normal positive sign
(like conventional financial statements, unlike balance/print/register)
(experimental).
.PP
$FLAGS$
.PP
Example:
.IP
.nf
@ -2559,6 +2570,8 @@ balancesheetequity, bse
Just like balancesheet, but also reports Equity (which it assumes is
under a top-level \f[C]equity\f[R] account).
.PP
$FLAGS$
.PP
Example:
.IP
.nf
@ -2603,6 +2616,8 @@ Note this report shows all account balances with normal positive sign
(like conventional financial statements, unlike balance/print/register)
(experimental).
.PP
$FLAGS$
.PP
Example:
.IP
.nf
@ -2644,6 +2659,8 @@ With --date2, checks secondary dates instead.
With --strict, dates must also be unique.
With a query, only matched transactions\[aq] dates are checked.
Reads the default journal file, or another specified with -f.
.PP
$FLAGS$
.SS check-dupes
.PP
check-dupes
@ -2654,6 +2671,8 @@ Reports account names having the same leaf but different prefixes.
In other words, two or more leaves that are categorized differently.
Reads the default journal file, or another specified as an argument.
.PP
$FLAGS$
.PP
An example: http://stefanorodighiero.net/software/hledger-dupes.html
.SS close
.PP
@ -2668,6 +2687,8 @@ Useful for bringing asset/liability balances forward into a new journal
file, or for closing out revenues/expenses to retained earnings at the
end of a period.
.PP
$FLAGS$
.PP
The closing transaction transfers balances to \[dq]equity:closing
balances\[dq], and the opening transaction transfers balances from
\[dq]equity:opening balances\[dq], or you can customise these with the
@ -2773,10 +2794,14 @@ commodities
.P
.PD
List all commodity/currency symbols used or declared in the journal.
.PP
$FLAGS$
.SS descriptions
.PP
descriptions Show descriptions.
.PP
$FLAGS$
.PP
This command lists all descriptions that appear in transactions.
.PP
Examples:
@ -2810,6 +2835,8 @@ from your bank (eg as CSV data).
When hledger and your bank disagree about the account balance, you can
compare the bank data with your journal to find out the cause.
.PP
$FLAGS$
.PP
Examples:
.IP
.nf
@ -2834,6 +2861,8 @@ files
List all files included in the journal.
With a REGEX argument, only file names matching the regular expression
(case sensitive) are shown.
.PP
$FLAGS$
.SS help
.PP
help
@ -2842,6 +2871,8 @@ help
.PD
Show any of the hledger manuals.
.PP
$FLAGS$
.PP
The \f[C]help\f[R] command displays any of the main hledger manuals, in
one of several ways.
Run it with no argument to list the manuals, or provide a full or
@ -2894,6 +2925,8 @@ Or with --dry-run, just print the transactions that would be added.
Or with --catchup, just mark all of the FILEs\[aq] transactions as
imported, without actually importing any.
.PP
$FLAGS$
.PP
The input files are specified as arguments - no need to write -f before
each one.
So eg to add new transactions from all CSV files to the main journal,
@ -2946,6 +2979,8 @@ Note this report shows all account balances with normal positive sign
(like conventional financial statements, unlike balance/print/register)
(experimental).
.PP
$FLAGS$
.PP
This command displays a simple income statement.
It currently assumes that you have top-level accounts named
\f[C]income\f[R] (or \f[C]revenue\f[R]) and \f[C]expense\f[R] (plural
@ -2990,6 +3025,8 @@ selection.
.PP
notes Show notes.
.PP
$FLAGS$
.PP
This command lists all notes that appear in transactions.
.PP
Examples:
@ -3005,6 +3042,8 @@ Snacks
.PP
payees Show payee names.
.PP
$FLAGS$
.PP
This command lists all payee names that appear in transactions.
.PP
Examples:
@ -3030,6 +3069,8 @@ With --inverted-costs, also print inverse prices based on transaction
prices.
Prices (and postings providing prices) can be filtered by a query.
Price amounts are always displayed with their full precision.
.PP
$FLAGS$
.SS print
.PP
print, txns, p
@ -3038,6 +3079,8 @@ print, txns, p
.PD
Show transaction journal entries, sorted by date.
.PP
$FLAGS$
.PP
The print command displays full journal entries (transactions) from the
journal file in date order, tidily formatted.
With --date2, transactions are sorted by secondary date instead.
@ -3164,6 +3207,8 @@ print-unique
.PD
Print transactions which do not reuse an already-seen description.
.PP
$FLAGS$
.PP
Example:
.IP
.nf
@ -3187,6 +3232,8 @@ register, reg, r
.PD
Show postings and their running total.
.PP
$FLAGS$
.PP
The register command displays postings in date order, one per line, and
their running total.
This is typically used with a query selecting a particular account, to
@ -3343,6 +3390,8 @@ If there are multiple equally good matches, it shows the most recent.
Query options (options, not arguments) can be used to restrict the
search space.
Helps ledger-autosync detect already-seen transactions when importing.
.PP
$FLAGS$
.SS rewrite
.PP
rewrite
@ -3353,6 +3402,8 @@ Print all transactions, rewriting the postings of matched transactions.
For now the only rewrite available is adding new postings, like print
--auto.
.PP
$FLAGS$
.PP
This is a start at a generic rewriter of transaction entries.
It reads the default journal and prints the transactions, like print,
but adds one or more specified postings to any transactions matching
@ -3524,6 +3575,8 @@ roi
Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on
your investments.
.PP
$FLAGS$
.PP
This command assumes that you have account(s) that hold nothing but your
investments and whenever you record current appraisal/valuation of these
investments you offset unrealized profit and loss into account(s) that,
@ -3550,6 +3603,8 @@ stats
.PD
Show some journal statistics.
.PP
$FLAGS$
.PP
The stats command displays summary information for the whole journal, or
a matched part of it.
With a reporting interval, it shows a report for each report period.
@ -3587,6 +3642,8 @@ With a TAGREGEX argument, only tag names matching the regular expression
With QUERY arguments, only transactions matching the query are
considered.
With --values flag, the tags\[aq] unique values are listed instead.
.PP
$FLAGS$
.SS test
.PP
test
@ -3595,6 +3652,8 @@ test
.PD
Run built-in unit tests.
.PP
$FLAGS$
.PP
This command runs the unit tests built in to hledger and hledger-lib,
printing the results on stdout.
If any test fails, the exit code will be non-zero.
@ -3662,10 +3721,6 @@ hledger-web provides a simple web interface.
.PP
These are maintained separately, and usually updated shortly after a
hledger release.
.SS diff
.PP
hledger-diff shows differences in an account\[aq]s transactions between
one journal file and another.
.SS iadd
.PP
hledger-iadd is a more interactive, terminal UI replacement for the add
@ -3674,10 +3729,6 @@ command.
.PP
hledger-interest generates interest transactions for an account
according to various schemes.
.SS irr
.PP
hledger-irr calculates the internal rate of return of an investment
account, but it\[aq]s superseded now by the built-in roi command.
.SS Experimental add-ons
.PP
These are available in source form in the hledger repo\[aq]s bin/
@ -3693,10 +3744,7 @@ formats, and can also download the data if your bank offers OFX Direct
Connect.
.SS chart
.PP
hledger-chart.hs is an old pie chart generator, in need of some love.
.SS check
.PP
hledger-check.hs checks more powerful account balance assertions.
hledger-chart.hs is an old very basic pie chart generator.
.SH ENVIRONMENT
.PP
\f[B]COLUMNS\f[R] The screen width used by the register command.

437
hledger/hledger.info
View File

@ -1,4 +1,4 @@
This is hledger.info, produced by makeinfo version 6.5 from stdin.
This is hledger.info, produced by makeinfo version 6.7 from stdin.

File: hledger.info, Node: Top, Next: EXAMPLES, Up: (dir)
@ -179,7 +179,8 @@ by most hledger commands, run 'hledger -h'.
use some other field or tag for the account name
'-I --ignore-assertions'
ignore any failing balance assertions
disable balance assertion checks (note: does not disable balance
assignments)
General reporting options:
@ -1347,6 +1348,8 @@ File: hledger.info, Node: accounts, Next: activity, Up: COMMANDS
accounts, a
Show account names.
$FLAGS$
This command lists account names, either declared with account
directives (-declared), posted to (-used), or both (the default). With
query arguments, only matched account names and account names referenced
@ -1377,6 +1380,8 @@ File: hledger.info, Node: activity, Next: add, Prev: accounts, Up: COMMANDS
activity
Show an ascii barchart of posting counts per interval.
$FLAGS$
The activity command displays an ascii histogram showing transaction
counts by day, week, month or other reporting interval (by day is the
default). With query arguments, it counts only matched transactions.
@ -1398,6 +1403,8 @@ File: hledger.info, Node: add, Next: balance, Prev: activity, Up: COMMANDS
add
Prompt for transactions and add them to the journal.
$FLAGS$
Many hledger users edit their journals directly with a text editor,
or generate them from CSV. For more interactive data entry, there is the
'add' command, which prompts interactively on the console for new
@ -1469,6 +1476,8 @@ File: hledger.info, Node: balance, Next: balancesheet, Prev: add, Up: COMMAN
balance, bal, b
Show accounts and their balances.
$FLAGS$
The balance command is hledger's most versatile command. Note,
despite the name, it is not always used for showing real-world account
balances; the more accounting-aware balancesheet and incomestatement may
@ -2040,6 +2049,8 @@ date). It assumes that these accounts are under a top-level 'asset' or
(like conventional financial statements, unlike balance/print/register)
(experimental).
$FLAGS$
Example:
$ hledger balancesheet
@ -2083,6 +2094,8 @@ balancesheetequity, bse
Just like balancesheet, but also reports Equity (which it assumes is
under a top-level 'equity' account).
$FLAGS$
Example:
$ hledger balancesheetequity
@ -2123,6 +2136,8 @@ contain 'receivable' or 'A/R' in their name. Note this report shows all
account balances with normal positive sign (like conventional financial
statements, unlike balance/print/register) (experimental).
$FLAGS$
Example:
$ hledger cashflow
@ -2160,6 +2175,8 @@ checks secondary dates instead. With -strict, dates must also be
unique. With a query, only matched transactions' dates are checked.
Reads the default journal file, or another specified with -f.
$FLAGS$

File: hledger.info, Node: check-dupes, Next: close, Prev: check-dates, Up: COMMANDS
@ -2171,6 +2188,8 @@ Reports account names having the same leaf but different prefixes. In
other words, two or more leaves that are categorized differently. Reads
the default journal file, or another specified as an argument.
$FLAGS$
An example: http://stefanorodighiero.net/software/hledger-dupes.html

@ -2186,6 +2205,8 @@ Useful for bringing asset/liability balances forward into a new journal
file, or for closing out revenues/expenses to retained earnings at the
end of a period.
$FLAGS$
The closing transaction transfers balances to "equity:closing
balances", and the opening transaction transfers balances from
"equity:opening balances", or you can customise these with the
@ -2272,6 +2293,8 @@ File: hledger.info, Node: commodities, Next: descriptions, Prev: close, Up:
commodities
List all commodity/currency symbols used or declared in the journal.
$FLAGS$

File: hledger.info, Node: descriptions, Next: diff, Prev: commodities, Up: COMMANDS
@ -2280,6 +2303,8 @@ File: hledger.info, Node: descriptions, Next: diff, Prev: commodities, Up: C
descriptions Show descriptions.
$FLAGS$
This command lists all descriptions that appear in transactions.
Examples:
@ -2312,6 +2337,8 @@ from your bank (eg as CSV data). When hledger and your bank disagree
about the account balance, you can compare the bank data with your
journal to find out the cause.
$FLAGS$
Examples:
$ hledger diff -f $LEDGER_FILE -f bank.csv assets:bank:giro
@ -2334,6 +2361,8 @@ files
List all files included in the journal. With a REGEX argument, only
file names matching the regular expression (case sensitive) are shown.
$FLAGS$

File: hledger.info, Node: help, Next: import, Prev: files, Up: COMMANDS
@ -2343,6 +2372,8 @@ File: hledger.info, Node: help, Next: import, Prev: files, Up: COMMANDS
help
Show any of the hledger manuals.
$FLAGS$
The 'help' command displays any of the main hledger manuals, in one
of several ways. Run it with no argument to list the manuals, or
provide a full or partial manual name to select one.
@ -2386,6 +2417,8 @@ the main journal file. Or with -dry-run, just print the transactions
that would be added. Or with -catchup, just mark all of the FILEs'
transactions as imported, without actually importing any.
$FLAGS$
The input files are specified as arguments - no need to write -f
before each one. So eg to add new transactions from all CSV files to
the main journal, it's just: 'hledger import *.csv'
@ -2436,6 +2469,8 @@ plural forms also allowed). Note this report shows all account balances
with normal positive sign (like conventional financial statements,
unlike balance/print/register) (experimental).
$FLAGS$
This command displays a simple income statement. It currently
assumes that you have top-level accounts named 'income' (or 'revenue')
and 'expense' (plural forms also allowed.)
@ -2478,6 +2513,8 @@ File: hledger.info, Node: notes, Next: payees, Prev: incomestatement, Up: CO
notes Show notes.
$FLAGS$
This command lists all notes that appear in transactions.
Examples:
@ -2494,6 +2531,8 @@ File: hledger.info, Node: payees, Next: prices, Prev: notes, Up: COMMANDS
payees Show payee names.
$FLAGS$
This command lists all payee names that appear in transactions.
Examples:
@ -2516,6 +2555,8 @@ synthetic market prices based on transaction prices. With
Prices (and postings providing prices) can be filtered by a query.
Price amounts are always displayed with their full precision.
$FLAGS$

File: hledger.info, Node: print, Next: print-unique, Prev: prices, Up: COMMANDS
@ -2525,6 +2566,8 @@ File: hledger.info, Node: print, Next: print-unique, Prev: prices, Up: COMMA
print, txns, p
Show transaction journal entries, sorted by date.
$FLAGS$
The print command displays full journal entries (transactions) from
the journal file in date order, tidily formatted. With -date2,
transactions are sorted by secondary date instead.
@ -2626,6 +2669,8 @@ File: hledger.info, Node: print-unique, Next: register, Prev: print, Up: COM
print-unique
Print transactions which do not reuse an already-seen description.
$FLAGS$
Example:
$ cat unique.journal
@ -2647,6 +2692,8 @@ File: hledger.info, Node: register, Next: register-match, Prev: print-unique,
register, reg, r
Show postings and their running total.
$FLAGS$
The register command displays postings in date order, one per line,
and their running total. This is typically used with a query selecting
a particular account, to see that account's activity:
@ -2772,6 +2819,8 @@ good matches, it shows the most recent. Query options (options, not
arguments) can be used to restrict the search space. Helps
ledger-autosync detect already-seen transactions when importing.
$FLAGS$

File: hledger.info, Node: rewrite, Next: roi, Prev: register-match, Up: COMMANDS
@ -2783,6 +2832,8 @@ Print all transactions, rewriting the postings of matched transactions.
For now the only rewrite available is adding new postings, like print
-auto.
$FLAGS$
This is a start at a generic rewriter of transaction entries. It
reads the default journal and prints the transactions, like print, but
adds one or more specified postings to any transactions matching QUERY.
@ -2938,6 +2989,8 @@ roi
Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on
your investments.
$FLAGS$
This command assumes that you have account(s) that hold nothing but
your investments and whenever you record current appraisal/valuation of
these investments you offset unrealized profit and loss into account(s)
@ -2965,6 +3018,8 @@ File: hledger.info, Node: stats, Next: tags, Prev: roi, Up: COMMANDS
stats
Show some journal statistics.
$FLAGS$
The stats command displays summary information for the whole journal,
or a matched part of it. With a reporting interval, it shows a report
for each report period.
@ -3000,6 +3055,8 @@ shown. With QUERY arguments, only transactions matching the query are
considered. With -values flag, the tags' unique values are listed
instead.
$FLAGS$

File: hledger.info, Node: test, Prev: tags, Up: COMMANDS
@ -3009,6 +3066,8 @@ File: hledger.info, Node: test, Prev: tags, Up: COMMANDS
test
Run built-in unit tests.
$FLAGS$
This command runs the unit tests built in to hledger and hledger-lib,
printing the results on stdout. If any test fails, the exit code will
be non-zero.
@ -3106,44 +3165,27 @@ hledger release.
* Menu:
* diff::
* iadd::
* interest::
* irr::
5.2.1 diff
----------
hledger-diff shows differences in an account's transactions between one
journal file and another.

File: hledger.info, Node: iadd, Next: interest, Prev: , Up: Third party add-ons
File: hledger.info, Node: iadd, Next: interest, Up: Third party add-ons
5.2.2 iadd
5.2.1 iadd
----------
hledger-iadd is a more interactive, terminal UI replacement for the add
command.

File: hledger.info, Node: interest, Next: irr, Prev: iadd, Up: Third party add-ons
File: hledger.info, Node: interest, Prev: iadd, Up: Third party add-ons
5.2.3 interest
5.2.2 interest
--------------
hledger-interest generates interest transactions for an account
according to various schemes.

File: hledger.info, Node: irr, Prev: interest, Up: Third party add-ons
5.2.4 irr
---------
hledger-irr calculates the internal rate of return of an investment
account, but it's superseded now by the built-in roi command.

File: hledger.info, Node: Experimental add-ons, Prev: Third party add-ons, Up: ADD-ON COMMANDS
@ -3158,7 +3200,6 @@ and tweaking these is a good way to start making your own!
* autosync::
* chart::
* check::

File: hledger.info, Node: autosync, Next: chart, Up: Experimental add-ons
@ -3172,20 +3213,12 @@ and some CSV formats, and can also download the data if your bank offers
OFX Direct Connect.

File: hledger.info, Node: chart, Next: check, Prev: autosync, Up: Experimental add-ons
File: hledger.info, Node: chart, Prev: autosync, Up: Experimental add-ons
5.3.2 chart
-----------
hledger-chart.hs is an old pie chart generator, in need of some love.

File: hledger.info, Node: check, Prev: chart, Up: Experimental add-ons
5.3.3 check
-----------
hledger-check.hs checks more powerful account balance assertions.
hledger-chart.hs is an old very basic pie chart generator.

Tag Table:
@ -3196,173 +3229,173 @@ Node: OPTIONS3637
Ref: #options3739
Node: General options4138
Ref: #general-options4263
Node: Command options6917
Ref: #command-options7068
Node: Command arguments7466
Ref: #command-arguments7620
Node: Argument files7741
Ref: #argument-files7917
Node: Special characters in arguments and queries8183
Ref: #special-characters-in-arguments-and-queries8417
Node: More escaping8868
Ref: #more-escaping9030
Node: Even more escaping9326
Ref: #even-more-escaping9520
Node: Less escaping10191
Ref: #less-escaping10353
Node: Command line tips10598
Ref: #command-line-tips10784
Node: Unicode characters11161
Ref: #unicode-characters11317
Node: Input files12729
Ref: #input-files12865
Node: Smart dates14794
Ref: #smart-dates14935
Node: Report start & end date16341
Ref: #report-start-end-date16513
Node: Report intervals17937
Ref: #report-intervals18102
Node: Period expressions18492
Ref: #period-expressions18652
Node: Depth limiting22607
Ref: #depth-limiting22751
Node: Pivoting23093
Ref: #pivoting23216
Node: Valuation24892
Ref: #valuation25021
Node: -B Cost25201
Ref: #b-cost25312
Node: -V Market value25510
Ref: #v-market-value25684
Node: -X Market value in specified commodity27116
Ref: #x-market-value-in-specified-commodity27355
Node: --value Flexible valuation27531
Ref: #value-flexible-valuation27757
Node: Effect of --value on reports31947
Ref: #effect-of---value-on-reports32163
Node: Combining -B -V -X --value37094
Ref: #combining--b--v--x---value37277
Node: Output destination37313
Ref: #output-destination37465
Node: Output format37748
Ref: #output-format37900
Node: Regular expressions38285
Ref: #regular-expressions38422
Node: QUERIES39783
Ref: #queries39885
Node: COMMANDS43847
Ref: #commands43959
Node: accounts45023
Ref: #accounts45121
Node: activity45820
Ref: #activity45930
Node: add46313
Ref: #add46412
Node: balance49157
Ref: #balance49268
Node: Classic balance report50726
Ref: #classic-balance-report50899
Node: Customising the classic balance report52268
Ref: #customising-the-classic-balance-report52496
Node: Colour support54572
Ref: #colour-support54739
Node: Flat mode54912
Ref: #flat-mode55060
Node: Depth limited balance reports55473
Ref: #depth-limited-balance-reports55658
Node: Percentages56114
Ref: #percentages56280
Node: Multicolumn balance report57417
Ref: #multicolumn-balance-report57597
Node: Budget report62911
Ref: #budget-report63054
Node: Nested budgets68256
Ref: #nested-budgets68368
Ref: #output-format-171848
Node: balancesheet71926
Ref: #balancesheet72062
Node: balancesheetequity73445
Ref: #balancesheetequity73594
Node: cashflow74155
Ref: #cashflow74283
Node: check-dates75379
Ref: #check-dates75506
Node: check-dupes75785
Ref: #check-dupes75909
Node: close76202
Ref: #close76316
Node: commodities79982
Ref: #commodities80109
Node: descriptions80191
Ref: #descriptions80319
Node: diff80500
Ref: #diff80606
Node: files81653
Ref: #files81753
Node: help81900
Ref: #help82000
Node: import83081
Ref: #import83195
Node: Importing balance assignments84088
Ref: #importing-balance-assignments84236
Node: incomestatement84885
Ref: #incomestatement85018
Node: notes86422
Ref: #notes86535
Node: payees86661
Ref: #payees86767
Node: prices86925
Ref: #prices87031
Node: print87372
Ref: #print87482
Node: print-unique91975
Ref: #print-unique92101
Node: register92386
Ref: #register92513
Node: Custom register output96685
Ref: #custom-register-output96814
Node: register-match98076
Ref: #register-match98210
Node: rewrite98561
Ref: #rewrite98676
Node: Re-write rules in a file100531
Ref: #re-write-rules-in-a-file100665
Node: Diff output format101875
Ref: #diff-output-format102044
Node: rewrite vs print --auto103136
Ref: #rewrite-vs.-print---auto103315
Node: roi103871
Ref: #roi103969
Node: stats104981
Ref: #stats105080
Node: tags105868
Ref: #tags105966
Node: test106260
Ref: #test106344
Node: ADD-ON COMMANDS107091
Ref: #add-on-commands107201
Node: Official add-ons108489
Ref: #official-add-ons108629
Node: ui108709
Ref: #ui108796
Node: web108850
Ref: #web108939
Node: Third party add-ons108985
Ref: #third-party-add-ons109160
Ref: #diff-1109319
Node: iadd109418
Ref: #iadd109528
Node: interest109610
Ref: #interest109731
Node: irr109826
Ref: #irr109924
Node: Experimental add-ons110055
Ref: #experimental-add-ons110207
Node: autosync110455
Ref: #autosync110566
Node: chart110805
Ref: #chart110924
Node: check110995
Ref: #check111097
Node: Command options6962
Ref: #command-options7113
Node: Command arguments7511
Ref: #command-arguments7665
Node: Argument files7786
Ref: #argument-files7962
Node: Special characters in arguments and queries8228
Ref: #special-characters-in-arguments-and-queries8462
Node: More escaping8913
Ref: #more-escaping9075
Node: Even more escaping9371
Ref: #even-more-escaping9565
Node: Less escaping10236
Ref: #less-escaping10398
Node: Command line tips10643
Ref: #command-line-tips10829
Node: Unicode characters11206
Ref: #unicode-characters11362
Node: Input files12774
Ref: #input-files12910
Node: Smart dates14839
Ref: #smart-dates14980
Node: Report start & end date16386
Ref: #report-start-end-date16558
Node: Report intervals17982
Ref: #report-intervals18147
Node: Period expressions18537
Ref: #period-expressions18697
Node: Depth limiting22652
Ref: #depth-limiting22796
Node: Pivoting23138
Ref: #pivoting23261
Node: Valuation24937
Ref: #valuation25066
Node: -B Cost25246
Ref: #b-cost25357
Node: -V Market value25555
Ref: #v-market-value25729
Node: -X Market value in specified commodity27161
Ref: #x-market-value-in-specified-commodity27400
Node: --value Flexible valuation27576
Ref: #value-flexible-valuation27802
Node: Effect of --value on reports31992
Ref: #effect-of---value-on-reports32208
Node: Combining -B -V -X --value37139
Ref: #combining--b--v--x---value37322
Node: Output destination37358
Ref: #output-destination37510
Node: Output format37793
Ref: #output-format37945
Node: Regular expressions38330
Ref: #regular-expressions38467
Node: QUERIES39828
Ref: #queries39930
Node: COMMANDS43892
Ref: #commands44004
Node: accounts45068
Ref: #accounts45166
Node: activity45877
Ref: #activity45987
Node: add46382
Ref: #add46481
Node: balance49232
Ref: #balance49343
Node: Classic balance report50813
Ref: #classic-balance-report50986
Node: Customising the classic balance report52355
Ref: #customising-the-classic-balance-report52583
Node: Colour support54659
Ref: #colour-support54826
Node: Flat mode54999
Ref: #flat-mode55147
Node: Depth limited balance reports55560
Ref: #depth-limited-balance-reports55745
Node: Percentages56201
Ref: #percentages56367
Node: Multicolumn balance report57504
Ref: #multicolumn-balance-report57684
Node: Budget report62998
Ref: #budget-report63141
Node: Nested budgets68343
Ref: #nested-budgets68455
Ref: #output-format-171936
Node: balancesheet72014
Ref: #balancesheet72150
Node: balancesheetequity73545
Ref: #balancesheetequity73694
Node: cashflow74267
Ref: #cashflow74395
Node: check-dates75503
Ref: #check-dates75630
Node: check-dupes75921
Ref: #check-dupes76045
Node: close76350
Ref: #close76464
Node: commodities80142
Ref: #commodities80269
Node: descriptions80363
Ref: #descriptions80491
Node: diff80684
Ref: #diff80790
Node: files81849
Ref: #files81949
Node: help82108
Ref: #help82208
Node: import83301
Ref: #import83415
Node: Importing balance assignments84320
Ref: #importing-balance-assignments84468
Node: incomestatement85117
Ref: #incomestatement85250
Node: notes86666
Ref: #notes86779
Node: payees86917
Ref: #payees87023
Node: prices87193
Ref: #prices87299
Node: print87652
Ref: #print87762
Node: print-unique92267
Ref: #print-unique92393
Node: register92690
Ref: #register92817
Node: Custom register output97001
Ref: #custom-register-output97130
Node: register-match98392
Ref: #register-match98526
Node: rewrite98889
Ref: #rewrite99004
Node: Re-write rules in a file100871
Ref: #re-write-rules-in-a-file101005
Node: Diff output format102215
Ref: #diff-output-format102384
Node: rewrite vs print --auto103476
Ref: #rewrite-vs.-print---auto103655
Node: roi104211
Ref: #roi104309
Node: stats105333
Ref: #stats105432
Node: tags106232
Ref: #tags106330
Node: test106636
Ref: #test106720
Node: ADD-ON COMMANDS107479
Ref: #add-on-commands107589
Node: Official add-ons108877
Ref: #official-add-ons109017
Node: ui109097
Ref: #ui109184
Node: web109238
Ref: #web109327
Node: Third party add-ons109373
Ref: #third-party-add-ons109548
Node: iadd109667
Ref: #iadd109768
Node: interest109850
Ref: #interest109959
Node: Experimental add-ons110054
Ref: #experimental-add-ons110206
Node: autosync110444
Ref: #autosync110555
Node: chart110794
Ref: #chart110899

End Tag Table

Local Variables:
coding: utf-8
End:

88
hledger/hledger.txt
View File

@ -146,7 +146,8 @@ OPTIONS
use some other field or tag for the account name
-I --ignore-assertions
ignore any failing balance assertions
disable balance assertion checks (note: does not disable balance
assignments)
General reporting options:
@ -464,14 +465,11 @@ OPTIONS
-b 2016/3/17 begin on St. Patrick's
day 2016
-e 12/1 end at the start of decem-
ber 1st of the current
year (11/30 will be the
last date included)
-b thismonth all transactions on or af-
ter the 1st of the current
month
@ -534,8 +532,6 @@ OPTIONS
-p "2009/1" the month of jan; equiva-
lent to "2009/1/1 to
2009/2/1"
-p "2009/1/1" just that day; equivalent
to "2009/1/1 to 2009/1/2"
@ -603,7 +599,6 @@ OPTIONS
-p "every 2nd Monday" -- period bound-
aries will be on second Monday of each
month
-p "every 11/05" -- yearly periods with
boundaries on 5th of Nov
-p "every 5th Nov" -- same
@ -947,7 +942,6 @@ OPTIONS
grand total sum of dis- sum of dis- sum of dis- sum of dis-
(no report in- played values played values played values played values
terval)
row totals/av- sums/averages sums/averages sums/averages sums/averages
erages (with of displayed of displayed of displayed of displayed
report inter- values values values values
@ -1179,6 +1173,8 @@ COMMANDS
accounts, a
Show account names.
$FLAGS$
This command lists account names, either declared with account direc-
tives (--declared), posted to (--used), or both (the default). With
query arguments, only matched account names and account names refer-
@ -1204,6 +1200,8 @@ COMMANDS
activity
Show an ascii barchart of posting counts per interval.
$FLAGS$
The activity command displays an ascii histogram showing transaction
counts by day, week, month or other reporting interval (by day is the
default). With query arguments, it counts only matched transactions.
@ -1220,6 +1218,8 @@ COMMANDS
add
Prompt for transactions and add them to the journal.
$FLAGS$
Many hledger users edit their journals directly with a text editor, or
generate them from CSV. For more interactive data entry, there is the
add command, which prompts interactively on the console for new trans-
@ -1253,8 +1253,7 @@ COMMANDS
o Comments and tags may be entered following a description or amount.
o If you make a mistake, enter < at any prompt to go one step
backward.
o If you make a mistake, enter < at any prompt to go one step backward.
o Input prompts are displayed in a different colour when the terminal
supports it.
@ -1294,6 +1293,8 @@ COMMANDS
balance, bal, b
Show accounts and their balances.
$FLAGS$
The balance command is hledger's most versatile command. Note, despite
the name, it is not always used for showing real-world account bal-
ances; the more accounting-aware balancesheet and incomestatement may
@ -1723,7 +1724,7 @@ COMMANDS
liabilities
With this, monthly budget for electronics is defined to be $100 and
budget for personal expenses is an additional $1000, which implicity
budget for personal expenses is an additional $1000, which implicitly
means that budget for both expenses:personal and expenses is $1100.
Transactions in expenses:personal:electronics will be counted both to-
@ -1804,6 +1805,8 @@ COMMANDS
(like conventional financial statements, unlike balance/print/register)
(experimental).
$FLAGS$
Example:
$ hledger balancesheet
@ -1842,6 +1845,8 @@ COMMANDS
Just like balancesheet, but also reports Equity (which it assumes is
under a top-level equity account).
$FLAGS$
Example:
$ hledger balancesheetequity
@ -1877,6 +1882,8 @@ COMMANDS
account balances with normal positive sign (like conventional financial
statements, unlike balance/print/register) (experimental).
$FLAGS$
Example:
$ hledger cashflow
@ -1909,12 +1916,16 @@ COMMANDS
unique. With a query, only matched transactions' dates are checked.
Reads the default journal file, or another specified with -f.
$FLAGS$
check-dupes
check-dupes
Reports account names having the same leaf but different prefixes. In
other words, two or more leaves that are categorized differently.
Reads the default journal file, or another specified as an argument.
$FLAGS$
An example: http://stefanorodighiero.net/software/hledger-dupes.html
close
@ -1925,6 +1936,8 @@ COMMANDS
file, or for closing out revenues/expenses to retained earnings at the
end of a period.
$FLAGS$
The closing transaction transfers balances to "equity:closing bal-
ances", and the opening transaction transfers balances from "eq-
uity:opening balances", or you can customise these with the --close-to
@ -2005,9 +2018,13 @@ COMMANDS
commodities
List all commodity/currency symbols used or declared in the journal.
$FLAGS$
descriptions
descriptions Show descriptions.
$FLAGS$
This command lists all descriptions that appear in transactions.
Examples:
@ -2034,6 +2051,8 @@ COMMANDS
the account balance, you can compare the bank data with your journal to
find out the cause.
$FLAGS$
Examples:
$ hledger diff -f $LEDGER_FILE -f bank.csv assets:bank:giro
@ -2051,10 +2070,14 @@ COMMANDS
List all files included in the journal. With a REGEX argument, only
file names matching the regular expression (case sensitive) are shown.
$FLAGS$
help
help
Show any of the hledger manuals.
$FLAGS$
The help command displays any of the main hledger manuals, in one of
several ways. Run it with no argument to list the manuals, or provide
a full or partial manual name to select one.
@ -2093,6 +2116,8 @@ COMMANDS
tions that would be added. Or with --catchup, just mark all of the
FILEs' transactions as imported, without actually importing any.
$FLAGS$
The input files are specified as arguments - no need to write -f before
each one. So eg to add new transactions from all CSV files to the main
journal, it's just: hledger import *.csv
@ -2129,6 +2154,8 @@ COMMANDS
with normal positive sign (like conventional financial statements, un-
like balance/print/register) (experimental).
$FLAGS$
This command displays a simple income statement. It currently assumes
that you have top-level accounts named income (or revenue) and expense
(plural forms also allowed.)
@ -2166,6 +2193,8 @@ COMMANDS
notes
notes Show notes.
$FLAGS$
This command lists all notes that appear in transactions.
Examples:
@ -2177,6 +2206,8 @@ COMMANDS
payees
payees Show payee names.
$FLAGS$
This command lists all payee names that appear in transactions.
Examples:
@ -2194,10 +2225,14 @@ COMMANDS
Prices (and postings providing prices) can be filtered by a query.
Price amounts are always displayed with their full precision.
$FLAGS$
print
print, txns, p
Show transaction journal entries, sorted by date.
$FLAGS$
The print command displays full journal entries (transactions) from the
journal file in date order, tidily formatted. With --date2, transac-
tions are sorted by secondary date instead.
@ -2298,6 +2333,8 @@ COMMANDS
print-unique
Print transactions which do not reuse an already-seen description.
$FLAGS$
Example:
$ cat unique.journal
@ -2314,6 +2351,8 @@ COMMANDS
register, reg, r
Show postings and their running total.
$FLAGS$
The register command displays postings in date order, one per line, and
their running total. This is typically used with a query selecting a
particular account, to see that account's activity:
@ -2424,12 +2463,16 @@ COMMANDS
arguments) can be used to restrict the search space. Helps ledger-au-
tosync detect already-seen transactions when importing.
$FLAGS$
rewrite
rewrite
Print all transactions, rewriting the postings of matched transactions.
For now the only rewrite available is adding new postings, like print
--auto.
$FLAGS$
This is a start at a generic rewriter of transaction entries. It reads
the default journal and prints the transactions, like print, but adds
one or more specified postings to any transactions matching QUERY. The
@ -2554,6 +2597,8 @@ COMMANDS
Shows the time-weighted (TWR) and money-weighted (IRR) rate of return
on your investments.
$FLAGS$
This command assumes that you have account(s) that hold nothing but
your investments and whenever you record current appraisal/valuation of
these investments you offset unrealized profit and loss into account(s)
@ -2576,6 +2621,8 @@ COMMANDS
stats
Show some journal statistics.
$FLAGS$
The stats command displays summary information for the whole journal,
or a matched part of it. With a reporting interval, it shows a report
for each report period.
@ -2606,10 +2653,14 @@ COMMANDS
considered. With --values flag, the tags' unique values are listed in-
stead.
$FLAGS$
test
test
Run built-in unit tests.
$FLAGS$
This command runs the unit tests built in to hledger and hledger-lib,
printing the results on stdout. If any test fails, the exit code will
be non-zero.
@ -2668,10 +2719,6 @@ ADD-ON COMMANDS
These are maintained separately, and usually updated shortly after a
hledger release.
diff
hledger-diff shows differences in an account's transactions between one
journal file and another.
iadd
hledger-iadd is a more interactive, terminal UI replacement for the add
command.
@ -2680,10 +2727,6 @@ ADD-ON COMMANDS
hledger-interest generates interest transactions for an account accord-
ing to various schemes.
irr
hledger-irr calculates the internal rate of return of an investment ac-
count, but it's superseded now by the built-in roi command.
Experimental add-ons
These are available in source form in the hledger repo's bin/ direc-
tory. They may be less mature and documented than built-in commands.
@ -2696,10 +2739,7 @@ ADD-ON COMMANDS
offers OFX Direct Connect.
chart
hledger-chart.hs is an old pie chart generator, in need of some love.
check
hledger-check.hs checks more powerful account balance assertions.
hledger-chart.hs is an old very basic pie chart generator.
ENVIRONMENT
COLUMNS The screen width used by the register command. Default: the