;doc: regen manuals
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:
parent
6b70eadf30
commit
f91076cc6a
@ -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
|
Currently there must be least two items (there must be at least one
|
||||||
comma).
|
comma).
|
||||||
.PP
|
.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.
|
Here are the standard hledger field/pseudo-field names.
|
||||||
For more about the transaction parts they refer to, see the manual for
|
For more about the transaction parts they refer to, see the manual for
|
||||||
hledger\[aq]s journal format.
|
hledger\[aq]s journal format.
|
||||||
@ -508,6 +511,7 @@ If the CSV has the currency symbol in a separate field, you can use
|
|||||||
.PP
|
.PP
|
||||||
\f[C]balanceN\f[R] sets a balance assertion amount (or if the posting
|
\f[C]balanceN\f[R] sets a balance assertion amount (or if the posting
|
||||||
amount is left empty, a balance assignment).
|
amount is left empty, a balance assignment).
|
||||||
|
You may need to adjust this with the \f[C]balance-type\f[R] rule.
|
||||||
.PP
|
.PP
|
||||||
Finally, \f[C]commentN\f[R] sets a comment on the Nth posting.
|
Finally, \f[C]commentN\f[R] sets a comment on the Nth posting.
|
||||||
Comments can also contain tags, as usual.
|
Comments can also contain tags, as usual.
|
||||||
@ -733,7 +737,52 @@ account2 expenses:misc
|
|||||||
include categorisation.rules
|
include categorisation.rules
|
||||||
\f[R]
|
\f[R]
|
||||||
.fi
|
.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
|
.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
|
.SS Valid CSV
|
||||||
.PP
|
.PP
|
||||||
hledger accepts CSV conforming to RFC 4180.
|
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
|
spaces outside the quotes are not allowed
|
||||||
.SS Other separator characters
|
.SS Other separator characters
|
||||||
.PP
|
.PP
|
||||||
With the \f[C]--separator \[aq]CHAR\[aq]\f[R] option (experimental),
|
You can use the \f[C]--separator \[aq]CHAR\[aq]\f[R] command line option
|
||||||
hledger will expect the separator to be CHAR instead of a comma.
|
(experimental) to read other kinds of character-separated data.
|
||||||
Ie it will read other \[dq]Character Separated Values\[dq] formats, such
|
Eg to read SSV (Semicolon Separated Values), use:
|
||||||
as TSV (Tab Separated Values).
|
.IP
|
||||||
Note: on the command line, use a real tab character in quotes, not Eg:
|
.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
|
.IP
|
||||||
.nf
|
.nf
|
||||||
\f[C]
|
\f[C]
|
||||||
$ hledger -f foo.tsv --separator \[aq] \[aq] print
|
$ hledger -f foo.tsv --separator \[aq] \[aq] print
|
||||||
\f[R]
|
\f[R]
|
||||||
.fi
|
.fi
|
||||||
|
.PP
|
||||||
|
Note, that\[aq]s a real tab character in quotes, not \f[C]\[rs]t\f[R].
|
||||||
.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
|
||||||
|
|||||||
@ -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)
|
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::
|
* date-format::
|
||||||
* newest-first::
|
* newest-first::
|
||||||
* include::
|
* include::
|
||||||
|
* balance-type::
|
||||||
|
|
||||||
|
|
||||||
File: hledger_csv.info, Node: skip, Next: fields, Up: CSV RULES
|
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
|
can be left unnamed. Currently there must be least two items (there
|
||||||
must be at least one comma).
|
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
|
Here are the standard hledger field/pseudo-field names. For more
|
||||||
about the transaction parts they refer to, see the manual for hledger's
|
about the transaction parts they refer to, see the manual for hledger's
|
||||||
journal format.
|
journal format.
|
||||||
@ -466,7 +470,8 @@ indicating an unbalanced posting.)
|
|||||||
affects ALL postings.
|
affects ALL postings.
|
||||||
|
|
||||||
'balanceN' sets a balance assertion amount (or if the posting amount
|
'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
|
Finally, 'commentN' sets a comment on the Nth posting. Comments can
|
||||||
also contain tags, as usual.
|
also contain tags, as usual.
|
||||||
@ -625,7 +630,7 @@ oldest first or newest first. But if all of the following are true:
|
|||||||
newest-first
|
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'
|
2.8 'include'
|
||||||
=============
|
=============
|
||||||
@ -647,6 +652,29 @@ account2 expenses:misc
|
|||||||
## common rules
|
## common rules
|
||||||
include categorisation.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
|
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:
|
* Menu:
|
||||||
|
|
||||||
|
* Rapid feedback::
|
||||||
* Valid CSV::
|
* Valid CSV::
|
||||||
* Other separator characters::
|
* Other separator characters::
|
||||||
* Reading multiple CSV files::
|
* Reading multiple CSV files::
|
||||||
@ -666,9 +695,26 @@ File: hledger_csv.info, Node: TIPS, Prev: CSV RULES, Up: Top
|
|||||||
* How CSV rules are evaluated::
|
* 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
|
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
|
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
|
You can use the '--separator 'CHAR'' command line option (experimental)
|
||||||
the separator to be CHAR instead of a comma. Ie it will read other
|
to read other kinds of character-separated data. Eg to read SSV
|
||||||
"Character Separated Values" formats, such as TSV (Tab Separated
|
(Semicolon Separated Values), use:
|
||||||
Values). Note: on the command line, use a real tab character in quotes,
|
|
||||||
not
|
$ 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
|
$ 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
|
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,
|
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
|
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
|
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
|
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
|
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
|
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:
|
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
|
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
|
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
|
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
|
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
|
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
|
Here's how to think of CSV rules being evaluated (if you really need
|
||||||
to). First,
|
to). First,
|
||||||
@ -900,45 +952,54 @@ Node: Paypal6438
|
|||||||
Ref: #paypal6532
|
Ref: #paypal6532
|
||||||
Node: CSV RULES14415
|
Node: CSV RULES14415
|
||||||
Ref: #csv-rules14524
|
Ref: #csv-rules14524
|
||||||
Node: skip14769
|
Node: skip14786
|
||||||
Ref: #skip14862
|
Ref: #skip14879
|
||||||
Node: fields15237
|
Node: fields15254
|
||||||
Ref: #fields15359
|
Ref: #fields15376
|
||||||
Node: Transaction field names16426
|
Node: Transaction field names16541
|
||||||
Ref: #transaction-field-names16586
|
Ref: #transaction-field-names16701
|
||||||
Node: Posting field names16697
|
Node: Posting field names16812
|
||||||
Ref: #posting-field-names16849
|
Ref: #posting-field-names16964
|
||||||
Node: field assignment18081
|
Node: field assignment18255
|
||||||
Ref: #field-assignment18217
|
Ref: #field-assignment18391
|
||||||
Node: if19035
|
Node: if19209
|
||||||
Ref: #if19144
|
Ref: #if19318
|
||||||
Node: end20860
|
Node: end21034
|
||||||
Ref: #end20966
|
Ref: #end21140
|
||||||
Node: date-format21190
|
Node: date-format21364
|
||||||
Ref: #date-format21322
|
Ref: #date-format21496
|
||||||
Node: newest-first22071
|
Node: newest-first22245
|
||||||
Ref: #newest-first22209
|
Ref: #newest-first22383
|
||||||
Node: include22892
|
Node: include23066
|
||||||
Ref: #include23000
|
Ref: #include23195
|
||||||
Node: TIPS23444
|
Node: balance-type23639
|
||||||
Ref: #tips23526
|
Ref: #balance-type23757
|
||||||
Node: Valid CSV23775
|
Node: TIPS24457
|
||||||
Ref: #valid-csv23894
|
Ref: #tips24539
|
||||||
Node: Other separator characters24086
|
Node: Rapid feedback24807
|
||||||
Ref: #other-separator-characters24274
|
Ref: #rapid-feedback24924
|
||||||
Node: Reading multiple CSV files24603
|
Node: Valid CSV25384
|
||||||
Ref: #reading-multiple-csv-files24800
|
Ref: #valid-csv25526
|
||||||
Node: Valid transactions25041
|
Node: Other separator characters25718
|
||||||
Ref: #valid-transactions25219
|
Ref: #other-separator-characters25906
|
||||||
Node: Deduplicating importing25847
|
Node: Reading multiple CSV files26345
|
||||||
Ref: #deduplicating-importing26026
|
Ref: #reading-multiple-csv-files26542
|
||||||
Node: Setting amounts27059
|
Node: Valid transactions26783
|
||||||
Ref: #setting-amounts27228
|
Ref: #valid-transactions26961
|
||||||
Node: Setting currency/commodity28214
|
Node: Deduplicating importing27589
|
||||||
Ref: #setting-currencycommodity28406
|
Ref: #deduplicating-importing27768
|
||||||
Node: Referencing other fields29209
|
Node: Setting amounts28801
|
||||||
Ref: #referencing-other-fields29409
|
Ref: #setting-amounts28970
|
||||||
Node: How CSV rules are evaluated30306
|
Node: Setting currency/commodity29956
|
||||||
Ref: #how-csv-rules-are-evaluated30477
|
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
|
End Tag Table
|
||||||
|
|
||||||
|
|
||||||
|
Local Variables:
|
||||||
|
coding: utf-8
|
||||||
|
End:
|
||||||
|
|||||||
@ -366,6 +366,9 @@ CSV RULES
|
|||||||
can be left unnamed. Currently there must be least two items (there
|
can be left unnamed. Currently there must be least two items (there
|
||||||
must be at least one comma).
|
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
|
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-
|
the transaction parts they refer to, see the manual for hledger's jour-
|
||||||
nal format.
|
nal format.
|
||||||
@ -396,7 +399,8 @@ CSV RULES
|
|||||||
fects ALL postings.
|
fects ALL postings.
|
||||||
|
|
||||||
balanceN sets a balance assertion amount (or if the posting amount is
|
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
|
Finally, commentN sets a comment on the Nth posting. Comments can also
|
||||||
contain tags, as usual.
|
contain tags, as usual.
|
||||||
@ -551,7 +555,37 @@ CSV RULES
|
|||||||
## common rules
|
## common rules
|
||||||
include categorisation.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
|
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
|
Valid CSV
|
||||||
hledger accepts CSV conforming to RFC 4180. When CSV values are en-
|
hledger accepts CSV conforming to RFC 4180. When CSV values are en-
|
||||||
closed in quotes, note:
|
closed in quotes, note:
|
||||||
@ -561,14 +595,20 @@ TIPS
|
|||||||
o spaces outside the quotes are not allowed
|
o spaces outside the quotes are not allowed
|
||||||
|
|
||||||
Other separator characters
|
Other separator characters
|
||||||
With the --separator 'CHAR' option (experimental), hledger will expect
|
You can use the --separator 'CHAR' command line option (experimental)
|
||||||
the separator to be CHAR instead of a comma. Ie it will read other
|
to read other kinds of character-separated data. Eg to read SSV (Semi-
|
||||||
"Character Separated Values" formats, such as TSV (Tab Separated Val-
|
colon Separated Values), use:
|
||||||
ues). Note: on the command line, use a real tab character in quotes,
|
|
||||||
not Eg:
|
$ 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
|
$ hledger -f foo.tsv --separator ' ' print
|
||||||
|
|
||||||
|
Note, that's a real tab character in quotes, not \t.
|
||||||
|
|
||||||
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,
|
||||||
hledger will look for a correspondingly-named rules file for each CSV
|
hledger will look for a correspondingly-named rules file for each CSV
|
||||||
|
|||||||
@ -533,6 +533,7 @@ reconciled balances while cleaning up old entries.
|
|||||||
You can disable them temporarily with the
|
You can disable them temporarily with the
|
||||||
\f[C]-I/--ignore-assertions\f[R] flag, which can be useful for
|
\f[C]-I/--ignore-assertions\f[R] 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).
|
||||||
.SS Assertions and ordering
|
.SS Assertions and ordering
|
||||||
.PP
|
.PP
|
||||||
hledger sorts an account\[aq]s postings and assertions first by date and
|
hledger sorts an account\[aq]s postings and assertions first by date and
|
||||||
|
|||||||
@ -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.
|
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
|
can protect you from, eg, inadvertently disrupting reconciled balances
|
||||||
while cleaning up old entries. You can disable them temporarily with
|
while cleaning up old entries. You can disable them temporarily with
|
||||||
the '-I/--ignore-assertions' flag, which can be useful for
|
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:
|
* Menu:
|
||||||
|
|
||||||
@ -1779,87 +1780,92 @@ Node: Virtual Postings15303
|
|||||||
Ref: #virtual-postings15462
|
Ref: #virtual-postings15462
|
||||||
Node: Balance Assertions16682
|
Node: Balance Assertions16682
|
||||||
Ref: #balance-assertions16857
|
Ref: #balance-assertions16857
|
||||||
Node: Assertions and ordering17816
|
Node: Assertions and ordering17890
|
||||||
Ref: #assertions-and-ordering18002
|
Ref: #assertions-and-ordering18076
|
||||||
Node: Assertions and included files18702
|
Node: Assertions and included files18776
|
||||||
Ref: #assertions-and-included-files18943
|
Ref: #assertions-and-included-files19017
|
||||||
Node: Assertions and multiple -f options19276
|
Node: Assertions and multiple -f options19350
|
||||||
Ref: #assertions-and-multiple--f-options19530
|
Ref: #assertions-and-multiple--f-options19604
|
||||||
Node: Assertions and commodities19662
|
Node: Assertions and commodities19736
|
||||||
Ref: #assertions-and-commodities19892
|
Ref: #assertions-and-commodities19966
|
||||||
Node: Assertions and prices21048
|
Node: Assertions and prices21122
|
||||||
Ref: #assertions-and-prices21260
|
Ref: #assertions-and-prices21334
|
||||||
Node: Assertions and subaccounts21700
|
Node: Assertions and subaccounts21774
|
||||||
Ref: #assertions-and-subaccounts21927
|
Ref: #assertions-and-subaccounts22001
|
||||||
Node: Assertions and virtual postings22251
|
Node: Assertions and virtual postings22325
|
||||||
Ref: #assertions-and-virtual-postings22491
|
Ref: #assertions-and-virtual-postings22565
|
||||||
Node: Assertions and precision22633
|
Node: Assertions and precision22707
|
||||||
Ref: #assertions-and-precision22824
|
Ref: #assertions-and-precision22898
|
||||||
Node: Balance Assignments23091
|
Node: Balance Assignments23165
|
||||||
Ref: #balance-assignments23272
|
Ref: #balance-assignments23346
|
||||||
Node: Balance assignments and prices24437
|
Node: Balance assignments and prices24511
|
||||||
Ref: #balance-assignments-and-prices24609
|
Ref: #balance-assignments-and-prices24683
|
||||||
Node: Transaction prices24833
|
Node: Transaction prices24907
|
||||||
Ref: #transaction-prices25002
|
Ref: #transaction-prices25076
|
||||||
Node: Comments27268
|
Node: Comments27342
|
||||||
Ref: #comments27402
|
Ref: #comments27476
|
||||||
Node: Tags28572
|
Node: Tags28646
|
||||||
Ref: #tags28690
|
Ref: #tags28764
|
||||||
Node: Directives30083
|
Node: Directives30157
|
||||||
Ref: #directives30226
|
Ref: #directives30300
|
||||||
Node: Comment blocks35834
|
Node: Comment blocks35908
|
||||||
Ref: #comment-blocks35979
|
Ref: #comment-blocks36053
|
||||||
Node: Including other files36155
|
Node: Including other files36229
|
||||||
Ref: #including-other-files36335
|
Ref: #including-other-files36409
|
||||||
Node: Default year36743
|
Node: Default year36817
|
||||||
Ref: #default-year36912
|
Ref: #default-year36986
|
||||||
Node: Declaring commodities37319
|
Node: Declaring commodities37393
|
||||||
Ref: #declaring-commodities37502
|
Ref: #declaring-commodities37576
|
||||||
Node: Default commodity39163
|
Node: Default commodity39237
|
||||||
Ref: #default-commodity39339
|
Ref: #default-commodity39413
|
||||||
Node: Market prices39973
|
Node: Market prices40047
|
||||||
Ref: #market-prices40138
|
Ref: #market-prices40212
|
||||||
Node: Declaring accounts40979
|
Node: Declaring accounts41053
|
||||||
Ref: #declaring-accounts41155
|
Ref: #declaring-accounts41229
|
||||||
Node: Account comments42080
|
Node: Account comments42154
|
||||||
Ref: #account-comments42243
|
Ref: #account-comments42317
|
||||||
Node: Account subdirectives42638
|
Node: Account subdirectives42712
|
||||||
Ref: #account-subdirectives42833
|
Ref: #account-subdirectives42907
|
||||||
Node: Account types43146
|
Node: Account types43220
|
||||||
Ref: #account-types43330
|
Ref: #account-types43404
|
||||||
Node: Account display order44972
|
Node: Account display order45046
|
||||||
Ref: #account-display-order45142
|
Ref: #account-display-order45216
|
||||||
Node: Rewriting accounts46271
|
Node: Rewriting accounts46345
|
||||||
Ref: #rewriting-accounts46456
|
Ref: #rewriting-accounts46530
|
||||||
Node: Basic aliases47182
|
Node: Basic aliases47256
|
||||||
Ref: #basic-aliases47328
|
Ref: #basic-aliases47402
|
||||||
Node: Regex aliases48032
|
Node: Regex aliases48106
|
||||||
Ref: #regex-aliases48204
|
Ref: #regex-aliases48278
|
||||||
Node: Combining aliases48922
|
Node: Combining aliases48996
|
||||||
Ref: #combining-aliases49100
|
Ref: #combining-aliases49174
|
||||||
Node: end aliases50376
|
Node: end aliases50450
|
||||||
Ref: #end-aliases50524
|
Ref: #end-aliases50598
|
||||||
Node: Default parent account50625
|
Node: Default parent account50699
|
||||||
Ref: #default-parent-account50791
|
Ref: #default-parent-account50865
|
||||||
Node: Periodic transactions51675
|
Node: Periodic transactions51749
|
||||||
Ref: #periodic-transactions51873
|
Ref: #periodic-transactions51947
|
||||||
Node: Periodic rule syntax53745
|
Node: Periodic rule syntax53819
|
||||||
Ref: #periodic-rule-syntax53951
|
Ref: #periodic-rule-syntax54025
|
||||||
Node: Two spaces between period expression and description!54655
|
Node: Two spaces between period expression and description!54729
|
||||||
Ref: #two-spaces-between-period-expression-and-description54974
|
Ref: #two-spaces-between-period-expression-and-description55048
|
||||||
Node: Forecasting with periodic transactions55658
|
Node: Forecasting with periodic transactions55732
|
||||||
Ref: #forecasting-with-periodic-transactions55963
|
Ref: #forecasting-with-periodic-transactions56037
|
||||||
Node: Budgeting with periodic transactions57989
|
Node: Budgeting with periodic transactions58063
|
||||||
Ref: #budgeting-with-periodic-transactions58228
|
Ref: #budgeting-with-periodic-transactions58302
|
||||||
Node: Auto postings / transaction modifiers58677
|
Node: Auto postings / transaction modifiers58751
|
||||||
Ref: #auto-postings-transaction-modifiers58888
|
Ref: #auto-postings-transaction-modifiers58962
|
||||||
Node: Auto postings and dates61117
|
Node: Auto postings and dates61191
|
||||||
Ref: #auto-postings-and-dates61374
|
Ref: #auto-postings-and-dates61448
|
||||||
Node: Auto postings and transaction balancing / inferred amounts / balance assertions61549
|
Node: Auto postings and transaction balancing / inferred amounts / balance assertions61623
|
||||||
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions61924
|
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions61998
|
||||||
Node: Auto posting tags62302
|
Node: Auto posting tags62376
|
||||||
Ref: #auto-posting-tags62541
|
Ref: #auto-posting-tags62615
|
||||||
Node: EDITOR SUPPORT63206
|
Node: EDITOR SUPPORT63280
|
||||||
Ref: #editor-support63324
|
Ref: #editor-support63398
|
||||||
|
|
||||||
End Tag Table
|
End Tag Table
|
||||||
|
|
||||||
|
|
||||||
|
Local Variables:
|
||||||
|
coding: utf-8
|
||||||
|
End:
|
||||||
|
|||||||
@ -384,7 +384,8 @@ FILE FORMAT
|
|||||||
tect you from, eg, inadvertently disrupting reconciled balances while
|
tect you from, eg, inadvertently disrupting reconciled balances while
|
||||||
cleaning up old entries. You can disable them temporarily with the
|
cleaning up old entries. You can disable them temporarily with the
|
||||||
-I/--ignore-assertions flag, which can be useful for troubleshooting or
|
-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
|
Assertions and ordering
|
||||||
hledger sorts an account's postings and assertions first by date and
|
hledger sorts an account's postings and assertions first by date and
|
||||||
@ -732,8 +733,6 @@ FILE FORMAT
|
|||||||
file.)
|
file.)
|
||||||
display how to display amounts of a commodity in reports (symbol side
|
display how to display amounts of a commodity in reports (symbol side
|
||||||
style and spacing, digit groups, decimal separator, decimal places)
|
style and spacing, digit groups, decimal separator, decimal places)
|
||||||
|
|
||||||
|
|
||||||
directive which entries and (when there are multiple files) which files
|
directive which entries and (when there are multiple files) which files
|
||||||
scope are affected by a directive
|
scope are affected by a directive
|
||||||
|
|
||||||
|
|||||||
@ -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.
|
stdin.
|
||||||
|
|
||||||
|
|
||||||
@ -59,3 +59,8 @@ Tag Table:
|
|||||||
Node: Top78
|
Node: Top78
|
||||||
|
|
||||||
End Tag Table
|
End Tag Table
|
||||||
|
|
||||||
|
|
||||||
|
Local Variables:
|
||||||
|
coding: utf-8
|
||||||
|
End:
|
||||||
|
|||||||
@ -45,9 +45,9 @@ DESCRIPTION
|
|||||||
o use emacs and the built-in timeclock.el, or the extended timeclock-
|
o use emacs and the built-in timeclock.el, or the extended timeclock-
|
||||||
x.el and perhaps the extras in ledgerutils.el
|
x.el and perhaps the extras in ledgerutils.el
|
||||||
|
|
||||||
o at the command line, use these bash aliases: shell alias ti="echo i
|
o at the command line, use these bash aliases: shell alias ti="echo
|
||||||
`date '+%Y-%m-%d %H:%M:%S'` \$* >>$TIMELOG" alias to="echo o `date
|
i `date '+%Y-%m-%d %H:%M:%S'` \$* >>$TIMELOG" alias to="echo o
|
||||||
'+%Y-%m-%d %H:%M:%S'` >>$TIMELOG"
|
`date '+%Y-%m-%d %H:%M:%S'` >>$TIMELOG"
|
||||||
|
|
||||||
o or use the old ti and to scripts in the ledger 2.x repository. These
|
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
|
rely on a "timeclock" executable which I think is just the ledger 2
|
||||||
|
|||||||
@ -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.
|
stdin.
|
||||||
|
|
||||||
|
|
||||||
@ -115,3 +115,8 @@ Node: FILE FORMAT812
|
|||||||
Ref: #file-format913
|
Ref: #file-format913
|
||||||
|
|
||||||
End Tag Table
|
End Tag Table
|
||||||
|
|
||||||
|
|
||||||
|
Local Variables:
|
||||||
|
coding: utf-8
|
||||||
|
End:
|
||||||
|
|||||||
@ -47,113 +47,114 @@ before options as shown above.
|
|||||||
Any QUERYARGS are interpreted as a hledger search query which filters
|
Any QUERYARGS are interpreted as a hledger search query which filters
|
||||||
the data.
|
the data.
|
||||||
.TP
|
.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
|
watch for data and date changes and reload automatically
|
||||||
.TP
|
.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
|
use this custom display theme
|
||||||
.TP
|
.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
|
start in the (first) matched account\[aq]s register screen
|
||||||
.TP
|
.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
|
show period balances (changes) at startup instead of historical balances
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-F --flat\f[R]
|
\f[B]\f[CB]-F --flat\f[B]\f[R]
|
||||||
show accounts as a list (default)
|
show accounts as a list (default)
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-T --tree\f[R]
|
\f[B]\f[CB]-T --tree\f[B]\f[R]
|
||||||
show accounts as a tree
|
show accounts as a tree
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]--future\f[R]
|
\f[B]\f[CB]--future\f[B]\f[R]
|
||||||
show transactions dated later than today (normally hidden)
|
show transactions dated later than today (normally hidden)
|
||||||
.PP
|
.PP
|
||||||
hledger input options:
|
hledger input options:
|
||||||
.TP
|
.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.
|
use a different input file.
|
||||||
For stdin, use - (default: \f[C]$LEDGER_FILE\f[R] or
|
For stdin, use - (default: \f[C]$LEDGER_FILE\f[R] or
|
||||||
\f[C]$HOME/.hledger.journal\f[R])
|
\f[C]$HOME/.hledger.journal\f[R])
|
||||||
.TP
|
.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)
|
Conversion rules file to use when reading CSV (default: FILE.rules)
|
||||||
.TP
|
.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])
|
Field separator to expect when reading CSV (default: \[aq],\[aq])
|
||||||
.TP
|
.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
|
rename accounts named OLD to NEW
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]--anon\f[R]
|
\f[B]\f[CB]--anon\f[B]\f[R]
|
||||||
anonymize accounts and payees
|
anonymize accounts and payees
|
||||||
.TP
|
.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
|
use some other field or tag for the account name
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-I --ignore-assertions\f[R]
|
\f[B]\f[CB]-I --ignore-assertions\f[B]\f[R]
|
||||||
ignore any failing balance assertions
|
disable balance assertion checks (note: does not disable balance
|
||||||
|
assignments)
|
||||||
.PP
|
.PP
|
||||||
hledger reporting options:
|
hledger reporting options:
|
||||||
.TP
|
.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
|
include postings/txns on or after this date
|
||||||
.TP
|
.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
|
include postings/txns before this date
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-D --daily\f[R]
|
\f[B]\f[CB]-D --daily\f[B]\f[R]
|
||||||
multiperiod/multicolumn report by day
|
multiperiod/multicolumn report by day
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-W --weekly\f[R]
|
\f[B]\f[CB]-W --weekly\f[B]\f[R]
|
||||||
multiperiod/multicolumn report by week
|
multiperiod/multicolumn report by week
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-M --monthly\f[R]
|
\f[B]\f[CB]-M --monthly\f[B]\f[R]
|
||||||
multiperiod/multicolumn report by month
|
multiperiod/multicolumn report by month
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-Q --quarterly\f[R]
|
\f[B]\f[CB]-Q --quarterly\f[B]\f[R]
|
||||||
multiperiod/multicolumn report by quarter
|
multiperiod/multicolumn report by quarter
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-Y --yearly\f[R]
|
\f[B]\f[CB]-Y --yearly\f[B]\f[R]
|
||||||
multiperiod/multicolumn report by year
|
multiperiod/multicolumn report by year
|
||||||
.TP
|
.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
|
set start date, end date, and/or reporting interval all at once using
|
||||||
period expressions syntax
|
period expressions syntax
|
||||||
.TP
|
.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)
|
match the secondary date instead (see command help for other effects)
|
||||||
.TP
|
.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)
|
include only unmarked postings/txns (can combine with -P or -C)
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-P --pending\f[R]
|
\f[B]\f[CB]-P --pending\f[B]\f[R]
|
||||||
include only pending postings/txns
|
include only pending postings/txns
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-C --cleared\f[R]
|
\f[B]\f[CB]-C --cleared\f[B]\f[R]
|
||||||
include only cleared postings/txns
|
include only cleared postings/txns
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-R --real\f[R]
|
\f[B]\f[CB]-R --real\f[B]\f[R]
|
||||||
include only non-virtual postings
|
include only non-virtual postings
|
||||||
.TP
|
.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
|
hide/aggregate accounts or postings more than NUM levels deep
|
||||||
.TP
|
.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
|
show items with zero amount, normally hidden (and vice-versa in
|
||||||
hledger-ui/hledger-web)
|
hledger-ui/hledger-web)
|
||||||
.TP
|
.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
|
convert amounts to their cost at transaction time (using the transaction
|
||||||
price, if any)
|
price, if any)
|
||||||
.TP
|
.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
|
convert amounts to their market value on the report end date (using the
|
||||||
most recent applicable market price, if any)
|
most recent applicable market price, if any)
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]--auto\f[R]
|
\f[B]\f[CB]--auto\f[B]\f[R]
|
||||||
apply automated posting rules to modify transactions.
|
apply automated posting rules to modify transactions.
|
||||||
.TP
|
.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
|
apply periodic transaction rules to generate future transactions, to 6
|
||||||
months from now or report end date.
|
months from now or report end date.
|
||||||
.PP
|
.PP
|
||||||
@ -164,13 +165,13 @@ Some reporting options can also be written as query arguments.
|
|||||||
.PP
|
.PP
|
||||||
hledger help options:
|
hledger help options:
|
||||||
.TP
|
.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)
|
show general usage (or after COMMAND, command usage)
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]--version\f[R]
|
\f[B]\f[CB]--version\f[B]\f[R]
|
||||||
show version
|
show version
|
||||||
.TP
|
.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)
|
show debug output (levels 1-9, default: 1)
|
||||||
.PP
|
.PP
|
||||||
A \[at]FILE argument will be expanded to the contents of FILE, which
|
A \[at]FILE argument will be expanded to the contents of FILE, which
|
||||||
|
|||||||
@ -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)
|
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
|
use some other field or tag for the account name
|
||||||
'-I --ignore-assertions'
|
'-I --ignore-assertions'
|
||||||
|
|
||||||
ignore any failing balance assertions
|
disable balance assertion checks (note: does not disable balance
|
||||||
|
assignments)
|
||||||
|
|
||||||
hledger reporting options:
|
hledger reporting options:
|
||||||
|
|
||||||
@ -425,17 +426,22 @@ Tag Table:
|
|||||||
Node: Top71
|
Node: Top71
|
||||||
Node: OPTIONS1101
|
Node: OPTIONS1101
|
||||||
Ref: #options1198
|
Ref: #options1198
|
||||||
Node: KEYS4589
|
Node: KEYS4634
|
||||||
Ref: #keys4684
|
Ref: #keys4729
|
||||||
Node: SCREENS8991
|
Node: SCREENS9036
|
||||||
Ref: #screens9076
|
Ref: #screens9121
|
||||||
Node: Accounts screen9166
|
Node: Accounts screen9211
|
||||||
Ref: #accounts-screen9294
|
Ref: #accounts-screen9339
|
||||||
Node: Register screen11510
|
Node: Register screen11555
|
||||||
Ref: #register-screen11665
|
Ref: #register-screen11710
|
||||||
Node: Transaction screen13661
|
Node: Transaction screen13706
|
||||||
Ref: #transaction-screen13819
|
Ref: #transaction-screen13864
|
||||||
Node: Error screen14689
|
Node: Error screen14734
|
||||||
Ref: #error-screen14811
|
Ref: #error-screen14856
|
||||||
|
|
||||||
End Tag Table
|
End Tag Table
|
||||||
|
|
||||||
|
|
||||||
|
Local Variables:
|
||||||
|
coding: utf-8
|
||||||
|
End:
|
||||||
|
|||||||
@ -87,7 +87,8 @@ OPTIONS
|
|||||||
use some other field or tag for the account name
|
use some other field or tag for the account name
|
||||||
|
|
||||||
-I --ignore-assertions
|
-I --ignore-assertions
|
||||||
ignore any failing balance assertions
|
disable balance assertion checks (note: does not disable balance
|
||||||
|
assignments)
|
||||||
|
|
||||||
hledger reporting options:
|
hledger reporting options:
|
||||||
|
|
||||||
|
|||||||
@ -51,123 +51,124 @@ in addition to any search query entered there.
|
|||||||
Note: if invoking hledger-web as a hledger subcommand, write
|
Note: if invoking hledger-web as a hledger subcommand, write
|
||||||
\f[C]--\f[R] before options, as shown in the synopsis above.
|
\f[C]--\f[R] before options, as shown in the synopsis above.
|
||||||
.TP
|
.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
|
serve and log requests, don\[aq]t browse or auto-exit
|
||||||
.TP
|
.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
|
like --serve, but serve only the JSON web API, without the server-side
|
||||||
web UI
|
web UI
|
||||||
.TP
|
.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)
|
listen on this IP address (default: 127.0.0.1)
|
||||||
.TP
|
.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)
|
listen on this TCP port (default: 5000)
|
||||||
.TP
|
.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).
|
set the base url (default: http://IPADDR:PORT).
|
||||||
You would change this when sharing over the network, or integrating
|
You would change this when sharing over the network, or integrating
|
||||||
within a larger website.
|
within a larger website.
|
||||||
.TP
|
.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).
|
set the static files url (default: BASEURL/static).
|
||||||
hledger-web normally serves static files itself, but if you wanted to
|
hledger-web normally serves static files itself, but if you wanted to
|
||||||
serve them from another server for efficiency, you would set the url
|
serve them from another server for efficiency, you would set the url
|
||||||
with this.
|
with this.
|
||||||
.TP
|
.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)
|
enable the view, add, and/or manage capabilities (default: view,add)
|
||||||
.TP
|
.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
|
read capabilities to enable from a HTTP header, like
|
||||||
X-Sandstorm-Permissions (default: disabled)
|
X-Sandstorm-Permissions (default: disabled)
|
||||||
.PP
|
.PP
|
||||||
hledger input options:
|
hledger input options:
|
||||||
.TP
|
.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.
|
use a different input file.
|
||||||
For stdin, use - (default: \f[C]$LEDGER_FILE\f[R] or
|
For stdin, use - (default: \f[C]$LEDGER_FILE\f[R] or
|
||||||
\f[C]$HOME/.hledger.journal\f[R])
|
\f[C]$HOME/.hledger.journal\f[R])
|
||||||
.TP
|
.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)
|
Conversion rules file to use when reading CSV (default: FILE.rules)
|
||||||
.TP
|
.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])
|
Field separator to expect when reading CSV (default: \[aq],\[aq])
|
||||||
.TP
|
.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
|
rename accounts named OLD to NEW
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]--anon\f[R]
|
\f[B]\f[CB]--anon\f[B]\f[R]
|
||||||
anonymize accounts and payees
|
anonymize accounts and payees
|
||||||
.TP
|
.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
|
use some other field or tag for the account name
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-I --ignore-assertions\f[R]
|
\f[B]\f[CB]-I --ignore-assertions\f[B]\f[R]
|
||||||
ignore any failing balance assertions
|
disable balance assertion checks (note: does not disable balance
|
||||||
|
assignments)
|
||||||
.PP
|
.PP
|
||||||
hledger reporting options:
|
hledger reporting options:
|
||||||
.TP
|
.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
|
include postings/txns on or after this date
|
||||||
.TP
|
.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
|
include postings/txns before this date
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-D --daily\f[R]
|
\f[B]\f[CB]-D --daily\f[B]\f[R]
|
||||||
multiperiod/multicolumn report by day
|
multiperiod/multicolumn report by day
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-W --weekly\f[R]
|
\f[B]\f[CB]-W --weekly\f[B]\f[R]
|
||||||
multiperiod/multicolumn report by week
|
multiperiod/multicolumn report by week
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-M --monthly\f[R]
|
\f[B]\f[CB]-M --monthly\f[B]\f[R]
|
||||||
multiperiod/multicolumn report by month
|
multiperiod/multicolumn report by month
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-Q --quarterly\f[R]
|
\f[B]\f[CB]-Q --quarterly\f[B]\f[R]
|
||||||
multiperiod/multicolumn report by quarter
|
multiperiod/multicolumn report by quarter
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-Y --yearly\f[R]
|
\f[B]\f[CB]-Y --yearly\f[B]\f[R]
|
||||||
multiperiod/multicolumn report by year
|
multiperiod/multicolumn report by year
|
||||||
.TP
|
.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
|
set start date, end date, and/or reporting interval all at once using
|
||||||
period expressions syntax
|
period expressions syntax
|
||||||
.TP
|
.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)
|
match the secondary date instead (see command help for other effects)
|
||||||
.TP
|
.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)
|
include only unmarked postings/txns (can combine with -P or -C)
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-P --pending\f[R]
|
\f[B]\f[CB]-P --pending\f[B]\f[R]
|
||||||
include only pending postings/txns
|
include only pending postings/txns
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-C --cleared\f[R]
|
\f[B]\f[CB]-C --cleared\f[B]\f[R]
|
||||||
include only cleared postings/txns
|
include only cleared postings/txns
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-R --real\f[R]
|
\f[B]\f[CB]-R --real\f[B]\f[R]
|
||||||
include only non-virtual postings
|
include only non-virtual postings
|
||||||
.TP
|
.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
|
hide/aggregate accounts or postings more than NUM levels deep
|
||||||
.TP
|
.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
|
show items with zero amount, normally hidden (and vice-versa in
|
||||||
hledger-ui/hledger-web)
|
hledger-ui/hledger-web)
|
||||||
.TP
|
.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
|
convert amounts to their cost at transaction time (using the transaction
|
||||||
price, if any)
|
price, if any)
|
||||||
.TP
|
.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
|
convert amounts to their market value on the report end date (using the
|
||||||
most recent applicable market price, if any)
|
most recent applicable market price, if any)
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]--auto\f[R]
|
\f[B]\f[CB]--auto\f[B]\f[R]
|
||||||
apply automated posting rules to modify transactions.
|
apply automated posting rules to modify transactions.
|
||||||
.TP
|
.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
|
apply periodic transaction rules to generate future transactions, to 6
|
||||||
months from now or report end date.
|
months from now or report end date.
|
||||||
.PP
|
.PP
|
||||||
@ -178,13 +179,13 @@ Some reporting options can also be written as query arguments.
|
|||||||
.PP
|
.PP
|
||||||
hledger help options:
|
hledger help options:
|
||||||
.TP
|
.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)
|
show general usage (or after COMMAND, command usage)
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]--version\f[R]
|
\f[B]\f[CB]--version\f[B]\f[R]
|
||||||
show version
|
show version
|
||||||
.TP
|
.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)
|
show debug output (levels 1-9, default: 1)
|
||||||
.PP
|
.PP
|
||||||
A \[at]FILE argument will be expanded to the contents of FILE, which
|
A \[at]FILE argument will be expanded to the contents of FILE, which
|
||||||
|
|||||||
@ -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)
|
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
|
use some other field or tag for the account name
|
||||||
'-I --ignore-assertions'
|
'-I --ignore-assertions'
|
||||||
|
|
||||||
ignore any failing balance assertions
|
disable balance assertion checks (note: does not disable balance
|
||||||
|
assignments)
|
||||||
|
|
||||||
hledger reporting options:
|
hledger reporting options:
|
||||||
|
|
||||||
@ -342,13 +343,18 @@ Tag Table:
|
|||||||
Node: Top72
|
Node: Top72
|
||||||
Node: OPTIONS1359
|
Node: OPTIONS1359
|
||||||
Ref: #options1464
|
Ref: #options1464
|
||||||
Node: PERMISSIONS6743
|
Node: PERMISSIONS6788
|
||||||
Ref: #permissions6882
|
Ref: #permissions6927
|
||||||
Node: EDITING UPLOADING DOWNLOADING8094
|
Node: EDITING UPLOADING DOWNLOADING8139
|
||||||
Ref: #editing-uploading-downloading8275
|
Ref: #editing-uploading-downloading8320
|
||||||
Node: RELOADING9109
|
Node: RELOADING9154
|
||||||
Ref: #reloading9243
|
Ref: #reloading9288
|
||||||
Node: JSON API9676
|
Node: JSON API9721
|
||||||
Ref: #json-api9770
|
Ref: #json-api9815
|
||||||
|
|
||||||
End Tag Table
|
End Tag Table
|
||||||
|
|
||||||
|
|
||||||
|
Local Variables:
|
||||||
|
coding: utf-8
|
||||||
|
End:
|
||||||
|
|||||||
@ -97,7 +97,8 @@ OPTIONS
|
|||||||
use some other field or tag for the account name
|
use some other field or tag for the account name
|
||||||
|
|
||||||
-I --ignore-assertions
|
-I --ignore-assertions
|
||||||
ignore any failing balance assertions
|
disable balance assertion checks (note: does not disable balance
|
||||||
|
assignments)
|
||||||
|
|
||||||
hledger reporting options:
|
hledger reporting options:
|
||||||
|
|
||||||
|
|||||||
@ -159,101 +159,102 @@ by most hledger commands, run \f[C]hledger -h\f[R].
|
|||||||
.PP
|
.PP
|
||||||
General help options:
|
General help options:
|
||||||
.TP
|
.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)
|
show general usage (or after COMMAND, command usage)
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]--version\f[R]
|
\f[B]\f[CB]--version\f[B]\f[R]
|
||||||
show version
|
show version
|
||||||
.TP
|
.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)
|
show debug output (levels 1-9, default: 1)
|
||||||
.PP
|
.PP
|
||||||
General input options:
|
General input options:
|
||||||
.TP
|
.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.
|
use a different input file.
|
||||||
For stdin, use - (default: \f[C]$LEDGER_FILE\f[R] or
|
For stdin, use - (default: \f[C]$LEDGER_FILE\f[R] or
|
||||||
\f[C]$HOME/.hledger.journal\f[R])
|
\f[C]$HOME/.hledger.journal\f[R])
|
||||||
.TP
|
.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)
|
Conversion rules file to use when reading CSV (default: FILE.rules)
|
||||||
.TP
|
.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])
|
Field separator to expect when reading CSV (default: \[aq],\[aq])
|
||||||
.TP
|
.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
|
rename accounts named OLD to NEW
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]--anon\f[R]
|
\f[B]\f[CB]--anon\f[B]\f[R]
|
||||||
anonymize accounts and payees
|
anonymize accounts and payees
|
||||||
.TP
|
.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
|
use some other field or tag for the account name
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-I --ignore-assertions\f[R]
|
\f[B]\f[CB]-I --ignore-assertions\f[B]\f[R]
|
||||||
ignore any failing balance assertions
|
disable balance assertion checks (note: does not disable balance
|
||||||
|
assignments)
|
||||||
.PP
|
.PP
|
||||||
General reporting options:
|
General reporting options:
|
||||||
.TP
|
.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
|
include postings/txns on or after this date
|
||||||
.TP
|
.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
|
include postings/txns before this date
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-D --daily\f[R]
|
\f[B]\f[CB]-D --daily\f[B]\f[R]
|
||||||
multiperiod/multicolumn report by day
|
multiperiod/multicolumn report by day
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-W --weekly\f[R]
|
\f[B]\f[CB]-W --weekly\f[B]\f[R]
|
||||||
multiperiod/multicolumn report by week
|
multiperiod/multicolumn report by week
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-M --monthly\f[R]
|
\f[B]\f[CB]-M --monthly\f[B]\f[R]
|
||||||
multiperiod/multicolumn report by month
|
multiperiod/multicolumn report by month
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-Q --quarterly\f[R]
|
\f[B]\f[CB]-Q --quarterly\f[B]\f[R]
|
||||||
multiperiod/multicolumn report by quarter
|
multiperiod/multicolumn report by quarter
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-Y --yearly\f[R]
|
\f[B]\f[CB]-Y --yearly\f[B]\f[R]
|
||||||
multiperiod/multicolumn report by year
|
multiperiod/multicolumn report by year
|
||||||
.TP
|
.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
|
set start date, end date, and/or reporting interval all at once using
|
||||||
period expressions syntax
|
period expressions syntax
|
||||||
.TP
|
.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)
|
match the secondary date instead (see command help for other effects)
|
||||||
.TP
|
.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)
|
include only unmarked postings/txns (can combine with -P or -C)
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-P --pending\f[R]
|
\f[B]\f[CB]-P --pending\f[B]\f[R]
|
||||||
include only pending postings/txns
|
include only pending postings/txns
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-C --cleared\f[R]
|
\f[B]\f[CB]-C --cleared\f[B]\f[R]
|
||||||
include only cleared postings/txns
|
include only cleared postings/txns
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]-R --real\f[R]
|
\f[B]\f[CB]-R --real\f[B]\f[R]
|
||||||
include only non-virtual postings
|
include only non-virtual postings
|
||||||
.TP
|
.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
|
hide/aggregate accounts or postings more than NUM levels deep
|
||||||
.TP
|
.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
|
show items with zero amount, normally hidden (and vice-versa in
|
||||||
hledger-ui/hledger-web)
|
hledger-ui/hledger-web)
|
||||||
.TP
|
.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
|
convert amounts to their cost at transaction time (using the transaction
|
||||||
price, if any)
|
price, if any)
|
||||||
.TP
|
.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
|
convert amounts to their market value on the report end date (using the
|
||||||
most recent applicable market price, if any)
|
most recent applicable market price, if any)
|
||||||
.TP
|
.TP
|
||||||
.B \f[C]--auto\f[R]
|
\f[B]\f[CB]--auto\f[B]\f[R]
|
||||||
apply automated posting rules to modify transactions.
|
apply automated posting rules to modify transactions.
|
||||||
.TP
|
.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
|
apply periodic transaction rules to generate future transactions, to 6
|
||||||
months from now or report end date.
|
months from now or report end date.
|
||||||
.PP
|
.PP
|
||||||
@ -773,7 +774,7 @@ start and end date like so:
|
|||||||
.PP
|
.PP
|
||||||
.TS
|
.TS
|
||||||
tab(@);
|
tab(@);
|
||||||
l l.
|
l r.
|
||||||
T{
|
T{
|
||||||
\f[C]-p \[dq]2009\[dq]\f[R]
|
\f[C]-p \[dq]2009\[dq]\f[R]
|
||||||
T}@T{
|
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
|
The TYPE part basically selects either \[dq]cost\[dq], or \[dq]market
|
||||||
value\[dq] plus a valuation date:
|
value\[dq] plus a valuation date:
|
||||||
.TP
|
.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.
|
Convert amounts to cost, using the prices recorded in transactions.
|
||||||
.TP
|
.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
|
Convert amounts to their value in a default valuation commodity, using
|
||||||
market prices on the last day of the report period (or if unspecified,
|
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 journal\[aq]s end date); or in multiperiod reports, market prices on
|
||||||
the last day of each subperiod.
|
the last day of each subperiod.
|
||||||
.TP
|
.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
|
Convert amounts to their value in default valuation commodity using
|
||||||
current market prices (as of when report is generated).
|
current market prices (as of when report is generated).
|
||||||
.TP
|
.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
|
Convert amounts to their value in default valuation commodity using
|
||||||
market prices on this date.
|
market prices on this date.
|
||||||
.PP
|
.PP
|
||||||
@ -1509,30 +1510,30 @@ T}
|
|||||||
.PP
|
.PP
|
||||||
\f[B]Additional notes\f[R]
|
\f[B]Additional notes\f[R]
|
||||||
.TP
|
.TP
|
||||||
.B \f[I]cost\f[R]
|
\f[I]cost\f[R]
|
||||||
calculated using price(s) recorded in the transaction(s).
|
calculated using price(s) recorded in the transaction(s).
|
||||||
.TP
|
.TP
|
||||||
.B \f[I]value\f[R]
|
\f[I]value\f[R]
|
||||||
market value using available market price declarations, or the unchanged
|
market value using available market price declarations, or the unchanged
|
||||||
amount if no conversion rate can be found.
|
amount if no conversion rate can be found.
|
||||||
.TP
|
.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:,
|
the first day of the report period specified with -b or -p or date:,
|
||||||
otherwise today.
|
otherwise today.
|
||||||
.TP
|
.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:,
|
the first day of the report period specified with -b or -p or date:,
|
||||||
otherwise the earliest transaction date in the journal, otherwise today.
|
otherwise the earliest transaction date in the journal, otherwise today.
|
||||||
.TP
|
.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:,
|
the last day of the report period specified with -e or -p or date:,
|
||||||
otherwise today.
|
otherwise today.
|
||||||
.TP
|
.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:,
|
the last day of the report period specified with -e or -p or date:,
|
||||||
otherwise the latest transaction date in the journal, otherwise today.
|
otherwise the latest transaction date in the journal, otherwise today.
|
||||||
.TP
|
.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
|
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).
|
report\[aq]s multi-period mode (whether showing one or many subperiods).
|
||||||
.SS Combining -B, -V, -X, --value
|
.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
|
Remember these can also be prefixed with \f[B]\f[CB]not:\f[B]\f[R], eg
|
||||||
to exclude a particular subaccount.
|
to exclude a particular subaccount.
|
||||||
.TP
|
.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.
|
match account names by this regular expression.
|
||||||
(With no prefix, \f[C]acct:\f[R] is assumed.)
|
(With no prefix, \f[C]acct:\f[R] is assumed.)
|
||||||
same as above
|
same as above
|
||||||
.TP
|
.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
|
match postings with a single-commodity amount that is equal to, less
|
||||||
than, or greater than N.
|
than, or greater than N.
|
||||||
(Multi-commodity amounts are not tested, and will always match.) The
|
(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.
|
the two signed numbers are compared.
|
||||||
Otherwise, the absolute magnitudes are compared, ignoring sign.
|
Otherwise, the absolute magnitudes are compared, ignoring sign.
|
||||||
.TP
|
.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)
|
match by transaction code (eg check number)
|
||||||
.TP
|
.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
|
match postings or transactions including any amounts whose
|
||||||
currency/commodity symbol is fully matched by REGEX.
|
currency/commodity symbol is fully matched by REGEX.
|
||||||
(For a partial match, use \f[C].*REGEX.*\f[R]).
|
(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:\[aq]\[rs]$\[aq]\f[R] or
|
||||||
\f[C]hledger print cur:\[rs]\[rs]$\f[R].
|
\f[C]hledger print cur:\[rs]\[rs]$\f[R].
|
||||||
.TP
|
.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.
|
match transaction descriptions.
|
||||||
.TP
|
.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.
|
match dates within the specified period.
|
||||||
PERIODEXPR is a period expression (with no report interval).
|
PERIODEXPR is a period expression (with no report interval).
|
||||||
Examples: \f[C]date:2016\f[R], \f[C]date:thismonth\f[R],
|
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
|
If the \f[C]--date2\f[R] command line flag is present, this matches
|
||||||
secondary dates instead.
|
secondary dates instead.
|
||||||
.TP
|
.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.
|
match secondary dates within the specified period.
|
||||||
.TP
|
.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
|
match (or display, depending on command) accounts at or above this depth
|
||||||
.TP
|
.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
|
match transaction notes (part of description right of \f[C]|\f[R], or
|
||||||
whole description when there\[aq]s no \f[C]|\f[R])
|
whole description when there\[aq]s no \f[C]|\f[R])
|
||||||
.TP
|
.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
|
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])
|
\f[C]|\f[R], or whole description when there\[aq]s no \f[C]|\f[R])
|
||||||
.TP
|
.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
|
match real or virtual postings respectively
|
||||||
.TP
|
.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
|
match unmarked, pending, or cleared transactions respectively
|
||||||
.TP
|
.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.
|
match by tag name, and optionally also by tag value.
|
||||||
Note a tag: query is considered to match a transaction if it matches any
|
Note a tag: query is considered to match a transaction if it matches any
|
||||||
of the postings.
|
of the postings.
|
||||||
@ -1714,7 +1715,7 @@ transaction.
|
|||||||
The following special search term is used automatically in hledger-web,
|
The following special search term is used automatically in hledger-web,
|
||||||
only:
|
only:
|
||||||
.TP
|
.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.
|
tells hledger-web to show the transaction register for this account.
|
||||||
Can be filtered further with \f[C]acct\f[R] etc.
|
Can be filtered further with \f[C]acct\f[R] etc.
|
||||||
.PP
|
.PP
|
||||||
@ -1749,6 +1750,8 @@ accounts, a
|
|||||||
.PD
|
.PD
|
||||||
Show account names.
|
Show account names.
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
This command lists account names, either declared with account
|
This command lists account names, either declared with account
|
||||||
directives (--declared), posted to (--used), or both (the default).
|
directives (--declared), posted to (--used), or both (the default).
|
||||||
With query arguments, only matched account names and account names
|
With query arguments, only matched account names and account names
|
||||||
@ -1784,6 +1787,8 @@ activity
|
|||||||
.PD
|
.PD
|
||||||
Show an ascii barchart of posting counts per interval.
|
Show an ascii barchart of posting counts per interval.
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
The activity command displays an ascii histogram showing transaction
|
The activity command displays an ascii histogram showing transaction
|
||||||
counts by day, week, month or other reporting interval (by day is the
|
counts by day, week, month or other reporting interval (by day is the
|
||||||
default).
|
default).
|
||||||
@ -1808,6 +1813,8 @@ add
|
|||||||
.PD
|
.PD
|
||||||
Prompt for transactions and add them to the journal.
|
Prompt for transactions and add them to the journal.
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
Many hledger users edit their journals directly with a text editor, or
|
Many hledger users edit their journals directly with a text editor, or
|
||||||
generate them from CSV.
|
generate them from CSV.
|
||||||
For more interactive data entry, there is the \f[C]add\f[R] command,
|
For more interactive data entry, there is the \f[C]add\f[R] command,
|
||||||
@ -1891,6 +1898,8 @@ balance, bal, b
|
|||||||
.PD
|
.PD
|
||||||
Show accounts and their balances.
|
Show accounts and their balances.
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
The balance command is hledger\[aq]s most versatile command.
|
The balance command is hledger\[aq]s most versatile command.
|
||||||
Note, despite the name, it is not always used for showing real-world
|
Note, despite the name, it is not always used for showing real-world
|
||||||
account balances; the more accounting-aware balancesheet and
|
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)
|
(like conventional financial statements, unlike balance/print/register)
|
||||||
(experimental).
|
(experimental).
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
Example:
|
Example:
|
||||||
.IP
|
.IP
|
||||||
.nf
|
.nf
|
||||||
@ -2559,6 +2570,8 @@ balancesheetequity, bse
|
|||||||
Just like balancesheet, but also reports Equity (which it assumes is
|
Just like balancesheet, but also reports Equity (which it assumes is
|
||||||
under a top-level \f[C]equity\f[R] account).
|
under a top-level \f[C]equity\f[R] account).
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
Example:
|
Example:
|
||||||
.IP
|
.IP
|
||||||
.nf
|
.nf
|
||||||
@ -2603,6 +2616,8 @@ Note this report shows all account balances with normal positive sign
|
|||||||
(like conventional financial statements, unlike balance/print/register)
|
(like conventional financial statements, unlike balance/print/register)
|
||||||
(experimental).
|
(experimental).
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
Example:
|
Example:
|
||||||
.IP
|
.IP
|
||||||
.nf
|
.nf
|
||||||
@ -2644,6 +2659,8 @@ With --date2, checks secondary dates instead.
|
|||||||
With --strict, dates must also be unique.
|
With --strict, dates must also be unique.
|
||||||
With a query, only matched transactions\[aq] dates are checked.
|
With a query, only matched transactions\[aq] dates are checked.
|
||||||
Reads the default journal file, or another specified with -f.
|
Reads the default journal file, or another specified with -f.
|
||||||
|
.PP
|
||||||
|
$FLAGS$
|
||||||
.SS check-dupes
|
.SS check-dupes
|
||||||
.PP
|
.PP
|
||||||
check-dupes
|
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.
|
In other words, two or more leaves that are categorized differently.
|
||||||
Reads the default journal file, or another specified as an argument.
|
Reads the default journal file, or another specified as an argument.
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
An example: http://stefanorodighiero.net/software/hledger-dupes.html
|
An example: http://stefanorodighiero.net/software/hledger-dupes.html
|
||||||
.SS close
|
.SS close
|
||||||
.PP
|
.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
|
file, or for closing out revenues/expenses to retained earnings at the
|
||||||
end of a period.
|
end of a period.
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
The closing transaction transfers balances to \[dq]equity:closing
|
The closing transaction transfers balances to \[dq]equity:closing
|
||||||
balances\[dq], and the opening transaction transfers balances from
|
balances\[dq], and the opening transaction transfers balances from
|
||||||
\[dq]equity:opening balances\[dq], or you can customise these with the
|
\[dq]equity:opening balances\[dq], or you can customise these with the
|
||||||
@ -2773,10 +2794,14 @@ commodities
|
|||||||
.P
|
.P
|
||||||
.PD
|
.PD
|
||||||
List all commodity/currency symbols used or declared in the journal.
|
List all commodity/currency symbols used or declared in the journal.
|
||||||
|
.PP
|
||||||
|
$FLAGS$
|
||||||
.SS descriptions
|
.SS descriptions
|
||||||
.PP
|
.PP
|
||||||
descriptions Show descriptions.
|
descriptions Show descriptions.
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
This command lists all descriptions that appear in transactions.
|
This command lists all descriptions that appear in transactions.
|
||||||
.PP
|
.PP
|
||||||
Examples:
|
Examples:
|
||||||
@ -2810,6 +2835,8 @@ from your bank (eg as CSV data).
|
|||||||
When hledger and your bank disagree about the account balance, you can
|
When hledger and your bank disagree about the account balance, you can
|
||||||
compare the bank data with your journal to find out the cause.
|
compare the bank data with your journal to find out the cause.
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
Examples:
|
Examples:
|
||||||
.IP
|
.IP
|
||||||
.nf
|
.nf
|
||||||
@ -2834,6 +2861,8 @@ files
|
|||||||
List all files included in the journal.
|
List all files included in the journal.
|
||||||
With a REGEX argument, only file names matching the regular expression
|
With a REGEX argument, only file names matching the regular expression
|
||||||
(case sensitive) are shown.
|
(case sensitive) are shown.
|
||||||
|
.PP
|
||||||
|
$FLAGS$
|
||||||
.SS help
|
.SS help
|
||||||
.PP
|
.PP
|
||||||
help
|
help
|
||||||
@ -2842,6 +2871,8 @@ help
|
|||||||
.PD
|
.PD
|
||||||
Show any of the hledger manuals.
|
Show any of the hledger manuals.
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
The \f[C]help\f[R] command displays any of the main hledger manuals, in
|
The \f[C]help\f[R] command displays any of the main hledger manuals, in
|
||||||
one of several ways.
|
one of several ways.
|
||||||
Run it with no argument to list the manuals, or provide a full or
|
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
|
Or with --catchup, just mark all of the FILEs\[aq] transactions as
|
||||||
imported, without actually importing any.
|
imported, without actually importing any.
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
The input files are specified as arguments - no need to write -f before
|
The input files are specified as arguments - no need to write -f before
|
||||||
each one.
|
each one.
|
||||||
So eg to add new transactions from all CSV files to the main journal,
|
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)
|
(like conventional financial statements, unlike balance/print/register)
|
||||||
(experimental).
|
(experimental).
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
This command displays a simple income statement.
|
This command displays a simple income statement.
|
||||||
It currently assumes that you have top-level accounts named
|
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
|
\f[C]income\f[R] (or \f[C]revenue\f[R]) and \f[C]expense\f[R] (plural
|
||||||
@ -2990,6 +3025,8 @@ selection.
|
|||||||
.PP
|
.PP
|
||||||
notes Show notes.
|
notes Show notes.
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
This command lists all notes that appear in transactions.
|
This command lists all notes that appear in transactions.
|
||||||
.PP
|
.PP
|
||||||
Examples:
|
Examples:
|
||||||
@ -3005,6 +3042,8 @@ Snacks
|
|||||||
.PP
|
.PP
|
||||||
payees Show payee names.
|
payees Show payee names.
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
This command lists all payee names that appear in transactions.
|
This command lists all payee names that appear in transactions.
|
||||||
.PP
|
.PP
|
||||||
Examples:
|
Examples:
|
||||||
@ -3030,6 +3069,8 @@ With --inverted-costs, also print inverse prices based on transaction
|
|||||||
prices.
|
prices.
|
||||||
Prices (and postings providing prices) can be filtered by a query.
|
Prices (and postings providing prices) can be filtered by a query.
|
||||||
Price amounts are always displayed with their full precision.
|
Price amounts are always displayed with their full precision.
|
||||||
|
.PP
|
||||||
|
$FLAGS$
|
||||||
.SS print
|
.SS print
|
||||||
.PP
|
.PP
|
||||||
print, txns, p
|
print, txns, p
|
||||||
@ -3038,6 +3079,8 @@ print, txns, p
|
|||||||
.PD
|
.PD
|
||||||
Show transaction journal entries, sorted by date.
|
Show transaction journal entries, sorted by date.
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
The print command displays full journal entries (transactions) from the
|
The print command displays full journal entries (transactions) from the
|
||||||
journal file in date order, tidily formatted.
|
journal file in date order, tidily formatted.
|
||||||
With --date2, transactions are sorted by secondary date instead.
|
With --date2, transactions are sorted by secondary date instead.
|
||||||
@ -3164,6 +3207,8 @@ print-unique
|
|||||||
.PD
|
.PD
|
||||||
Print transactions which do not reuse an already-seen description.
|
Print transactions which do not reuse an already-seen description.
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
Example:
|
Example:
|
||||||
.IP
|
.IP
|
||||||
.nf
|
.nf
|
||||||
@ -3187,6 +3232,8 @@ register, reg, r
|
|||||||
.PD
|
.PD
|
||||||
Show postings and their running total.
|
Show postings and their running total.
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
The register command displays postings in date order, one per line, and
|
The register command displays postings in date order, one per line, and
|
||||||
their running total.
|
their running total.
|
||||||
This is typically used with a query selecting a particular account, to
|
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
|
Query options (options, not arguments) can be used to restrict the
|
||||||
search space.
|
search space.
|
||||||
Helps ledger-autosync detect already-seen transactions when importing.
|
Helps ledger-autosync detect already-seen transactions when importing.
|
||||||
|
.PP
|
||||||
|
$FLAGS$
|
||||||
.SS rewrite
|
.SS rewrite
|
||||||
.PP
|
.PP
|
||||||
rewrite
|
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
|
For now the only rewrite available is adding new postings, like print
|
||||||
--auto.
|
--auto.
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
This is a start at a generic rewriter of transaction entries.
|
This is a start at a generic rewriter of transaction entries.
|
||||||
It reads the default journal and prints the transactions, like print,
|
It reads the default journal and prints the transactions, like print,
|
||||||
but adds one or more specified postings to any transactions matching
|
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
|
Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on
|
||||||
your investments.
|
your investments.
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
This command assumes that you have account(s) that hold nothing but your
|
This command assumes that you have account(s) that hold nothing but your
|
||||||
investments and whenever you record current appraisal/valuation of these
|
investments and whenever you record current appraisal/valuation of these
|
||||||
investments you offset unrealized profit and loss into account(s) that,
|
investments you offset unrealized profit and loss into account(s) that,
|
||||||
@ -3550,6 +3603,8 @@ stats
|
|||||||
.PD
|
.PD
|
||||||
Show some journal statistics.
|
Show some journal statistics.
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
The stats command displays summary information for the whole journal, or
|
The stats command displays summary information for the whole journal, or
|
||||||
a matched part of it.
|
a matched part of it.
|
||||||
With a reporting interval, it shows a report for each report period.
|
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
|
With QUERY arguments, only transactions matching the query are
|
||||||
considered.
|
considered.
|
||||||
With --values flag, the tags\[aq] unique values are listed instead.
|
With --values flag, the tags\[aq] unique values are listed instead.
|
||||||
|
.PP
|
||||||
|
$FLAGS$
|
||||||
.SS test
|
.SS test
|
||||||
.PP
|
.PP
|
||||||
test
|
test
|
||||||
@ -3595,6 +3652,8 @@ test
|
|||||||
.PD
|
.PD
|
||||||
Run built-in unit tests.
|
Run built-in unit tests.
|
||||||
.PP
|
.PP
|
||||||
|
$FLAGS$
|
||||||
|
.PP
|
||||||
This command runs the unit tests built in to hledger and hledger-lib,
|
This command runs the unit tests built in to hledger and hledger-lib,
|
||||||
printing the results on stdout.
|
printing the results on stdout.
|
||||||
If any test fails, the exit code will be non-zero.
|
If any test fails, the exit code will be non-zero.
|
||||||
@ -3662,10 +3721,6 @@ hledger-web provides a simple web interface.
|
|||||||
.PP
|
.PP
|
||||||
These are maintained separately, and usually updated shortly after a
|
These are maintained separately, and usually updated shortly after a
|
||||||
hledger release.
|
hledger release.
|
||||||
.SS diff
|
|
||||||
.PP
|
|
||||||
hledger-diff shows differences in an account\[aq]s transactions between
|
|
||||||
one journal file and another.
|
|
||||||
.SS iadd
|
.SS iadd
|
||||||
.PP
|
.PP
|
||||||
hledger-iadd is a more interactive, terminal UI replacement for the add
|
hledger-iadd is a more interactive, terminal UI replacement for the add
|
||||||
@ -3674,10 +3729,6 @@ command.
|
|||||||
.PP
|
.PP
|
||||||
hledger-interest generates interest transactions for an account
|
hledger-interest generates interest transactions for an account
|
||||||
according to various schemes.
|
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
|
.SS Experimental add-ons
|
||||||
.PP
|
.PP
|
||||||
These are available in source form in the hledger repo\[aq]s bin/
|
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.
|
Connect.
|
||||||
.SS chart
|
.SS chart
|
||||||
.PP
|
.PP
|
||||||
hledger-chart.hs is an old pie chart generator, in need of some love.
|
hledger-chart.hs is an old very basic pie chart generator.
|
||||||
.SS check
|
|
||||||
.PP
|
|
||||||
hledger-check.hs checks more powerful account balance assertions.
|
|
||||||
.SH ENVIRONMENT
|
.SH ENVIRONMENT
|
||||||
.PP
|
.PP
|
||||||
\f[B]COLUMNS\f[R] The screen width used by the register command.
|
\f[B]COLUMNS\f[R] The screen width used by the register command.
|
||||||
|
|||||||
@ -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)
|
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
|
use some other field or tag for the account name
|
||||||
'-I --ignore-assertions'
|
'-I --ignore-assertions'
|
||||||
|
|
||||||
ignore any failing balance assertions
|
disable balance assertion checks (note: does not disable balance
|
||||||
|
assignments)
|
||||||
|
|
||||||
General reporting options:
|
General reporting options:
|
||||||
|
|
||||||
@ -1347,6 +1348,8 @@ File: hledger.info, Node: accounts, Next: activity, Up: COMMANDS
|
|||||||
accounts, a
|
accounts, a
|
||||||
Show account names.
|
Show account names.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
This command lists account names, either declared with account
|
This command lists account names, either declared with account
|
||||||
directives (-declared), posted to (-used), or both (the default). With
|
directives (-declared), posted to (-used), or both (the default). With
|
||||||
query arguments, only matched account names and account names referenced
|
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
|
activity
|
||||||
Show an ascii barchart of posting counts per interval.
|
Show an ascii barchart of posting counts per interval.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
The activity command displays an ascii histogram showing transaction
|
The activity command displays an ascii histogram showing transaction
|
||||||
counts by day, week, month or other reporting interval (by day is the
|
counts by day, week, month or other reporting interval (by day is the
|
||||||
default). With query arguments, it counts only matched transactions.
|
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
|
add
|
||||||
Prompt for transactions and add them to the journal.
|
Prompt for transactions and add them to the journal.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
Many hledger users edit their journals directly with a text editor,
|
Many hledger users edit their journals directly with a text editor,
|
||||||
or generate them from CSV. For more interactive data entry, there is the
|
or generate them from CSV. For more interactive data entry, there is the
|
||||||
'add' command, which prompts interactively on the console for new
|
'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
|
balance, bal, b
|
||||||
Show accounts and their balances.
|
Show accounts and their balances.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
The balance command is hledger's most versatile command. Note,
|
The balance command is hledger's most versatile command. Note,
|
||||||
despite the name, it is not always used for showing real-world account
|
despite the name, it is not always used for showing real-world account
|
||||||
balances; the more accounting-aware balancesheet and incomestatement may
|
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)
|
(like conventional financial statements, unlike balance/print/register)
|
||||||
(experimental).
|
(experimental).
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
$ hledger balancesheet
|
$ hledger balancesheet
|
||||||
@ -2083,6 +2094,8 @@ balancesheetequity, bse
|
|||||||
Just like balancesheet, but also reports Equity (which it assumes is
|
Just like balancesheet, but also reports Equity (which it assumes is
|
||||||
under a top-level 'equity' account).
|
under a top-level 'equity' account).
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
$ hledger balancesheetequity
|
$ 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
|
account balances with normal positive sign (like conventional financial
|
||||||
statements, unlike balance/print/register) (experimental).
|
statements, unlike balance/print/register) (experimental).
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
$ hledger cashflow
|
$ 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.
|
unique. With a query, only matched transactions' dates are checked.
|
||||||
Reads the default journal file, or another specified with -f.
|
Reads the default journal file, or another specified with -f.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
|
|
||||||
File: hledger.info, Node: check-dupes, Next: close, Prev: check-dates, Up: COMMANDS
|
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
|
other words, two or more leaves that are categorized differently. Reads
|
||||||
the default journal file, or another specified as an argument.
|
the default journal file, or another specified as an argument.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
An example: http://stefanorodighiero.net/software/hledger-dupes.html
|
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
|
file, or for closing out revenues/expenses to retained earnings at the
|
||||||
end of a period.
|
end of a period.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
The closing transaction transfers balances to "equity:closing
|
The closing transaction transfers balances to "equity:closing
|
||||||
balances", and the opening transaction transfers balances from
|
balances", and the opening transaction transfers balances from
|
||||||
"equity:opening balances", or you can customise these with the
|
"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
|
commodities
|
||||||
List all commodity/currency symbols used or declared in the journal.
|
List all commodity/currency symbols used or declared in the journal.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
|
|
||||||
File: hledger.info, Node: descriptions, Next: diff, Prev: commodities, Up: COMMANDS
|
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.
|
descriptions Show descriptions.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
This command lists all descriptions that appear in transactions.
|
This command lists all descriptions that appear in transactions.
|
||||||
|
|
||||||
Examples:
|
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
|
about the account balance, you can compare the bank data with your
|
||||||
journal to find out the cause.
|
journal to find out the cause.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
|
|
||||||
$ hledger diff -f $LEDGER_FILE -f bank.csv assets:bank:giro
|
$ 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
|
List all files included in the journal. With a REGEX argument, only
|
||||||
file names matching the regular expression (case sensitive) are shown.
|
file names matching the regular expression (case sensitive) are shown.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
|
|
||||||
File: hledger.info, Node: help, Next: import, Prev: files, Up: COMMANDS
|
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
|
help
|
||||||
Show any of the hledger manuals.
|
Show any of the hledger manuals.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
The 'help' command displays any of the main hledger manuals, in one
|
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
|
of several ways. Run it with no argument to list the manuals, or
|
||||||
provide a full or partial manual name to select one.
|
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'
|
that would be added. Or with -catchup, just mark all of the FILEs'
|
||||||
transactions as imported, without actually importing any.
|
transactions as imported, without actually importing any.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
The input files are specified as arguments - no need to write -f
|
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
|
before each one. So eg to add new transactions from all CSV files to
|
||||||
the main journal, it's just: 'hledger import *.csv'
|
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,
|
with normal positive sign (like conventional financial statements,
|
||||||
unlike balance/print/register) (experimental).
|
unlike balance/print/register) (experimental).
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
This command displays a simple income statement. It currently
|
This command displays a simple income statement. It currently
|
||||||
assumes that you have top-level accounts named 'income' (or 'revenue')
|
assumes that you have top-level accounts named 'income' (or 'revenue')
|
||||||
and 'expense' (plural forms also allowed.)
|
and 'expense' (plural forms also allowed.)
|
||||||
@ -2478,6 +2513,8 @@ File: hledger.info, Node: notes, Next: payees, Prev: incomestatement, Up: CO
|
|||||||
|
|
||||||
notes Show notes.
|
notes Show notes.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
This command lists all notes that appear in transactions.
|
This command lists all notes that appear in transactions.
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
@ -2494,6 +2531,8 @@ File: hledger.info, Node: payees, Next: prices, Prev: notes, Up: COMMANDS
|
|||||||
|
|
||||||
payees Show payee names.
|
payees Show payee names.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
This command lists all payee names that appear in transactions.
|
This command lists all payee names that appear in transactions.
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
@ -2516,6 +2555,8 @@ synthetic market prices based on transaction prices. With
|
|||||||
Prices (and postings providing prices) can be filtered by a query.
|
Prices (and postings providing prices) can be filtered by a query.
|
||||||
Price amounts are always displayed with their full precision.
|
Price amounts are always displayed with their full precision.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
|
|
||||||
File: hledger.info, Node: print, Next: print-unique, Prev: prices, Up: COMMANDS
|
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
|
print, txns, p
|
||||||
Show transaction journal entries, sorted by date.
|
Show transaction journal entries, sorted by date.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
The print command displays full journal entries (transactions) from
|
The print command displays full journal entries (transactions) from
|
||||||
the journal file in date order, tidily formatted. With -date2,
|
the journal file in date order, tidily formatted. With -date2,
|
||||||
transactions are sorted by secondary date instead.
|
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-unique
|
||||||
Print transactions which do not reuse an already-seen description.
|
Print transactions which do not reuse an already-seen description.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
$ cat unique.journal
|
$ cat unique.journal
|
||||||
@ -2647,6 +2692,8 @@ File: hledger.info, Node: register, Next: register-match, Prev: print-unique,
|
|||||||
register, reg, r
|
register, reg, r
|
||||||
Show postings and their running total.
|
Show postings and their running total.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
The register command displays postings in date order, one per line,
|
The register command displays postings in date order, one per line,
|
||||||
and their running total. This is typically used with a query selecting
|
and their running total. This is typically used with a query selecting
|
||||||
a particular account, to see that account's activity:
|
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
|
arguments) can be used to restrict the search space. Helps
|
||||||
ledger-autosync detect already-seen transactions when importing.
|
ledger-autosync detect already-seen transactions when importing.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
|
|
||||||
File: hledger.info, Node: rewrite, Next: roi, Prev: register-match, Up: COMMANDS
|
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
|
For now the only rewrite available is adding new postings, like print
|
||||||
-auto.
|
-auto.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
This is a start at a generic rewriter of transaction entries. It
|
This is a start at a generic rewriter of transaction entries. It
|
||||||
reads the default journal and prints the transactions, like print, but
|
reads the default journal and prints the transactions, like print, but
|
||||||
adds one or more specified postings to any transactions matching QUERY.
|
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
|
Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on
|
||||||
your investments.
|
your investments.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
This command assumes that you have account(s) that hold nothing but
|
This command assumes that you have account(s) that hold nothing but
|
||||||
your investments and whenever you record current appraisal/valuation of
|
your investments and whenever you record current appraisal/valuation of
|
||||||
these investments you offset unrealized profit and loss into account(s)
|
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
|
stats
|
||||||
Show some journal statistics.
|
Show some journal statistics.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
The stats command displays summary information for the whole journal,
|
The stats command displays summary information for the whole journal,
|
||||||
or a matched part of it. With a reporting interval, it shows a report
|
or a matched part of it. With a reporting interval, it shows a report
|
||||||
for each report period.
|
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
|
considered. With -values flag, the tags' unique values are listed
|
||||||
instead.
|
instead.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
|
|
||||||
File: hledger.info, Node: test, Prev: tags, Up: COMMANDS
|
File: hledger.info, Node: test, Prev: tags, Up: COMMANDS
|
||||||
|
|
||||||
@ -3009,6 +3066,8 @@ File: hledger.info, Node: test, Prev: tags, Up: COMMANDS
|
|||||||
test
|
test
|
||||||
Run built-in unit tests.
|
Run built-in unit tests.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
This command runs the unit tests built in to hledger and hledger-lib,
|
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
|
printing the results on stdout. If any test fails, the exit code will
|
||||||
be non-zero.
|
be non-zero.
|
||||||
@ -3106,44 +3165,27 @@ hledger release.
|
|||||||
|
|
||||||
* Menu:
|
* Menu:
|
||||||
|
|
||||||
* diff::
|
|
||||||
* iadd::
|
* iadd::
|
||||||
* interest::
|
* 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
|
hledger-iadd is a more interactive, terminal UI replacement for the add
|
||||||
command.
|
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
|
hledger-interest generates interest transactions for an account
|
||||||
according to various schemes.
|
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
|
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::
|
* autosync::
|
||||||
* chart::
|
* chart::
|
||||||
* check::
|
|
||||||
|
|
||||||
|
|
||||||
File: hledger.info, Node: autosync, Next: chart, Up: Experimental add-ons
|
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.
|
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
|
5.3.2 chart
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
hledger-chart.hs is an old pie chart generator, in need of some love.
|
hledger-chart.hs is an old very basic pie chart generator.
|
||||||
|
|
||||||
|
|
||||||
File: hledger.info, Node: check, Prev: chart, Up: Experimental add-ons
|
|
||||||
|
|
||||||
5.3.3 check
|
|
||||||
-----------
|
|
||||||
|
|
||||||
hledger-check.hs checks more powerful account balance assertions.
|
|
||||||
|
|
||||||
|
|
||||||
Tag Table:
|
Tag Table:
|
||||||
@ -3196,173 +3229,173 @@ Node: OPTIONS3637
|
|||||||
Ref: #options3739
|
Ref: #options3739
|
||||||
Node: General options4138
|
Node: General options4138
|
||||||
Ref: #general-options4263
|
Ref: #general-options4263
|
||||||
Node: Command options6917
|
Node: Command options6962
|
||||||
Ref: #command-options7068
|
Ref: #command-options7113
|
||||||
Node: Command arguments7466
|
Node: Command arguments7511
|
||||||
Ref: #command-arguments7620
|
Ref: #command-arguments7665
|
||||||
Node: Argument files7741
|
Node: Argument files7786
|
||||||
Ref: #argument-files7917
|
Ref: #argument-files7962
|
||||||
Node: Special characters in arguments and queries8183
|
Node: Special characters in arguments and queries8228
|
||||||
Ref: #special-characters-in-arguments-and-queries8417
|
Ref: #special-characters-in-arguments-and-queries8462
|
||||||
Node: More escaping8868
|
Node: More escaping8913
|
||||||
Ref: #more-escaping9030
|
Ref: #more-escaping9075
|
||||||
Node: Even more escaping9326
|
Node: Even more escaping9371
|
||||||
Ref: #even-more-escaping9520
|
Ref: #even-more-escaping9565
|
||||||
Node: Less escaping10191
|
Node: Less escaping10236
|
||||||
Ref: #less-escaping10353
|
Ref: #less-escaping10398
|
||||||
Node: Command line tips10598
|
Node: Command line tips10643
|
||||||
Ref: #command-line-tips10784
|
Ref: #command-line-tips10829
|
||||||
Node: Unicode characters11161
|
Node: Unicode characters11206
|
||||||
Ref: #unicode-characters11317
|
Ref: #unicode-characters11362
|
||||||
Node: Input files12729
|
Node: Input files12774
|
||||||
Ref: #input-files12865
|
Ref: #input-files12910
|
||||||
Node: Smart dates14794
|
Node: Smart dates14839
|
||||||
Ref: #smart-dates14935
|
Ref: #smart-dates14980
|
||||||
Node: Report start & end date16341
|
Node: Report start & end date16386
|
||||||
Ref: #report-start-end-date16513
|
Ref: #report-start-end-date16558
|
||||||
Node: Report intervals17937
|
Node: Report intervals17982
|
||||||
Ref: #report-intervals18102
|
Ref: #report-intervals18147
|
||||||
Node: Period expressions18492
|
Node: Period expressions18537
|
||||||
Ref: #period-expressions18652
|
Ref: #period-expressions18697
|
||||||
Node: Depth limiting22607
|
Node: Depth limiting22652
|
||||||
Ref: #depth-limiting22751
|
Ref: #depth-limiting22796
|
||||||
Node: Pivoting23093
|
Node: Pivoting23138
|
||||||
Ref: #pivoting23216
|
Ref: #pivoting23261
|
||||||
Node: Valuation24892
|
Node: Valuation24937
|
||||||
Ref: #valuation25021
|
Ref: #valuation25066
|
||||||
Node: -B Cost25201
|
Node: -B Cost25246
|
||||||
Ref: #b-cost25312
|
Ref: #b-cost25357
|
||||||
Node: -V Market value25510
|
Node: -V Market value25555
|
||||||
Ref: #v-market-value25684
|
Ref: #v-market-value25729
|
||||||
Node: -X Market value in specified commodity27116
|
Node: -X Market value in specified commodity27161
|
||||||
Ref: #x-market-value-in-specified-commodity27355
|
Ref: #x-market-value-in-specified-commodity27400
|
||||||
Node: --value Flexible valuation27531
|
Node: --value Flexible valuation27576
|
||||||
Ref: #value-flexible-valuation27757
|
Ref: #value-flexible-valuation27802
|
||||||
Node: Effect of --value on reports31947
|
Node: Effect of --value on reports31992
|
||||||
Ref: #effect-of---value-on-reports32163
|
Ref: #effect-of---value-on-reports32208
|
||||||
Node: Combining -B -V -X --value37094
|
Node: Combining -B -V -X --value37139
|
||||||
Ref: #combining--b--v--x---value37277
|
Ref: #combining--b--v--x---value37322
|
||||||
Node: Output destination37313
|
Node: Output destination37358
|
||||||
Ref: #output-destination37465
|
Ref: #output-destination37510
|
||||||
Node: Output format37748
|
Node: Output format37793
|
||||||
Ref: #output-format37900
|
Ref: #output-format37945
|
||||||
Node: Regular expressions38285
|
Node: Regular expressions38330
|
||||||
Ref: #regular-expressions38422
|
Ref: #regular-expressions38467
|
||||||
Node: QUERIES39783
|
Node: QUERIES39828
|
||||||
Ref: #queries39885
|
Ref: #queries39930
|
||||||
Node: COMMANDS43847
|
Node: COMMANDS43892
|
||||||
Ref: #commands43959
|
Ref: #commands44004
|
||||||
Node: accounts45023
|
Node: accounts45068
|
||||||
Ref: #accounts45121
|
Ref: #accounts45166
|
||||||
Node: activity45820
|
Node: activity45877
|
||||||
Ref: #activity45930
|
Ref: #activity45987
|
||||||
Node: add46313
|
Node: add46382
|
||||||
Ref: #add46412
|
Ref: #add46481
|
||||||
Node: balance49157
|
Node: balance49232
|
||||||
Ref: #balance49268
|
Ref: #balance49343
|
||||||
Node: Classic balance report50726
|
Node: Classic balance report50813
|
||||||
Ref: #classic-balance-report50899
|
Ref: #classic-balance-report50986
|
||||||
Node: Customising the classic balance report52268
|
Node: Customising the classic balance report52355
|
||||||
Ref: #customising-the-classic-balance-report52496
|
Ref: #customising-the-classic-balance-report52583
|
||||||
Node: Colour support54572
|
Node: Colour support54659
|
||||||
Ref: #colour-support54739
|
Ref: #colour-support54826
|
||||||
Node: Flat mode54912
|
Node: Flat mode54999
|
||||||
Ref: #flat-mode55060
|
Ref: #flat-mode55147
|
||||||
Node: Depth limited balance reports55473
|
Node: Depth limited balance reports55560
|
||||||
Ref: #depth-limited-balance-reports55658
|
Ref: #depth-limited-balance-reports55745
|
||||||
Node: Percentages56114
|
Node: Percentages56201
|
||||||
Ref: #percentages56280
|
Ref: #percentages56367
|
||||||
Node: Multicolumn balance report57417
|
Node: Multicolumn balance report57504
|
||||||
Ref: #multicolumn-balance-report57597
|
Ref: #multicolumn-balance-report57684
|
||||||
Node: Budget report62911
|
Node: Budget report62998
|
||||||
Ref: #budget-report63054
|
Ref: #budget-report63141
|
||||||
Node: Nested budgets68256
|
Node: Nested budgets68343
|
||||||
Ref: #nested-budgets68368
|
Ref: #nested-budgets68455
|
||||||
Ref: #output-format-171848
|
Ref: #output-format-171936
|
||||||
Node: balancesheet71926
|
Node: balancesheet72014
|
||||||
Ref: #balancesheet72062
|
Ref: #balancesheet72150
|
||||||
Node: balancesheetequity73445
|
Node: balancesheetequity73545
|
||||||
Ref: #balancesheetequity73594
|
Ref: #balancesheetequity73694
|
||||||
Node: cashflow74155
|
Node: cashflow74267
|
||||||
Ref: #cashflow74283
|
Ref: #cashflow74395
|
||||||
Node: check-dates75379
|
Node: check-dates75503
|
||||||
Ref: #check-dates75506
|
Ref: #check-dates75630
|
||||||
Node: check-dupes75785
|
Node: check-dupes75921
|
||||||
Ref: #check-dupes75909
|
Ref: #check-dupes76045
|
||||||
Node: close76202
|
Node: close76350
|
||||||
Ref: #close76316
|
Ref: #close76464
|
||||||
Node: commodities79982
|
Node: commodities80142
|
||||||
Ref: #commodities80109
|
Ref: #commodities80269
|
||||||
Node: descriptions80191
|
Node: descriptions80363
|
||||||
Ref: #descriptions80319
|
Ref: #descriptions80491
|
||||||
Node: diff80500
|
Node: diff80684
|
||||||
Ref: #diff80606
|
Ref: #diff80790
|
||||||
Node: files81653
|
Node: files81849
|
||||||
Ref: #files81753
|
Ref: #files81949
|
||||||
Node: help81900
|
Node: help82108
|
||||||
Ref: #help82000
|
Ref: #help82208
|
||||||
Node: import83081
|
Node: import83301
|
||||||
Ref: #import83195
|
Ref: #import83415
|
||||||
Node: Importing balance assignments84088
|
Node: Importing balance assignments84320
|
||||||
Ref: #importing-balance-assignments84236
|
Ref: #importing-balance-assignments84468
|
||||||
Node: incomestatement84885
|
Node: incomestatement85117
|
||||||
Ref: #incomestatement85018
|
Ref: #incomestatement85250
|
||||||
Node: notes86422
|
Node: notes86666
|
||||||
Ref: #notes86535
|
Ref: #notes86779
|
||||||
Node: payees86661
|
Node: payees86917
|
||||||
Ref: #payees86767
|
Ref: #payees87023
|
||||||
Node: prices86925
|
Node: prices87193
|
||||||
Ref: #prices87031
|
Ref: #prices87299
|
||||||
Node: print87372
|
Node: print87652
|
||||||
Ref: #print87482
|
Ref: #print87762
|
||||||
Node: print-unique91975
|
Node: print-unique92267
|
||||||
Ref: #print-unique92101
|
Ref: #print-unique92393
|
||||||
Node: register92386
|
Node: register92690
|
||||||
Ref: #register92513
|
Ref: #register92817
|
||||||
Node: Custom register output96685
|
Node: Custom register output97001
|
||||||
Ref: #custom-register-output96814
|
Ref: #custom-register-output97130
|
||||||
Node: register-match98076
|
Node: register-match98392
|
||||||
Ref: #register-match98210
|
Ref: #register-match98526
|
||||||
Node: rewrite98561
|
Node: rewrite98889
|
||||||
Ref: #rewrite98676
|
Ref: #rewrite99004
|
||||||
Node: Re-write rules in a file100531
|
Node: Re-write rules in a file100871
|
||||||
Ref: #re-write-rules-in-a-file100665
|
Ref: #re-write-rules-in-a-file101005
|
||||||
Node: Diff output format101875
|
Node: Diff output format102215
|
||||||
Ref: #diff-output-format102044
|
Ref: #diff-output-format102384
|
||||||
Node: rewrite vs print --auto103136
|
Node: rewrite vs print --auto103476
|
||||||
Ref: #rewrite-vs.-print---auto103315
|
Ref: #rewrite-vs.-print---auto103655
|
||||||
Node: roi103871
|
Node: roi104211
|
||||||
Ref: #roi103969
|
Ref: #roi104309
|
||||||
Node: stats104981
|
Node: stats105333
|
||||||
Ref: #stats105080
|
Ref: #stats105432
|
||||||
Node: tags105868
|
Node: tags106232
|
||||||
Ref: #tags105966
|
Ref: #tags106330
|
||||||
Node: test106260
|
Node: test106636
|
||||||
Ref: #test106344
|
Ref: #test106720
|
||||||
Node: ADD-ON COMMANDS107091
|
Node: ADD-ON COMMANDS107479
|
||||||
Ref: #add-on-commands107201
|
Ref: #add-on-commands107589
|
||||||
Node: Official add-ons108489
|
Node: Official add-ons108877
|
||||||
Ref: #official-add-ons108629
|
Ref: #official-add-ons109017
|
||||||
Node: ui108709
|
Node: ui109097
|
||||||
Ref: #ui108796
|
Ref: #ui109184
|
||||||
Node: web108850
|
Node: web109238
|
||||||
Ref: #web108939
|
Ref: #web109327
|
||||||
Node: Third party add-ons108985
|
Node: Third party add-ons109373
|
||||||
Ref: #third-party-add-ons109160
|
Ref: #third-party-add-ons109548
|
||||||
Ref: #diff-1109319
|
Node: iadd109667
|
||||||
Node: iadd109418
|
Ref: #iadd109768
|
||||||
Ref: #iadd109528
|
Node: interest109850
|
||||||
Node: interest109610
|
Ref: #interest109959
|
||||||
Ref: #interest109731
|
Node: Experimental add-ons110054
|
||||||
Node: irr109826
|
Ref: #experimental-add-ons110206
|
||||||
Ref: #irr109924
|
Node: autosync110444
|
||||||
Node: Experimental add-ons110055
|
Ref: #autosync110555
|
||||||
Ref: #experimental-add-ons110207
|
Node: chart110794
|
||||||
Node: autosync110455
|
Ref: #chart110899
|
||||||
Ref: #autosync110566
|
|
||||||
Node: chart110805
|
|
||||||
Ref: #chart110924
|
|
||||||
Node: check110995
|
|
||||||
Ref: #check111097
|
|
||||||
|
|
||||||
End Tag Table
|
End Tag Table
|
||||||
|
|
||||||
|
|
||||||
|
Local Variables:
|
||||||
|
coding: utf-8
|
||||||
|
End:
|
||||||
|
|||||||
@ -146,7 +146,8 @@ OPTIONS
|
|||||||
use some other field or tag for the account name
|
use some other field or tag for the account name
|
||||||
|
|
||||||
-I --ignore-assertions
|
-I --ignore-assertions
|
||||||
ignore any failing balance assertions
|
disable balance assertion checks (note: does not disable balance
|
||||||
|
assignments)
|
||||||
|
|
||||||
General reporting options:
|
General reporting options:
|
||||||
|
|
||||||
@ -464,14 +465,11 @@ OPTIONS
|
|||||||
|
|
||||||
-b 2016/3/17 begin on St. Patrick's
|
-b 2016/3/17 begin on St. Patrick's
|
||||||
day 2016
|
day 2016
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
-e 12/1 end at the start of decem-
|
-e 12/1 end at the start of decem-
|
||||||
ber 1st of the current
|
ber 1st of the current
|
||||||
year (11/30 will be the
|
year (11/30 will be the
|
||||||
last date included)
|
last date included)
|
||||||
|
|
||||||
-b thismonth all transactions on or af-
|
-b thismonth all transactions on or af-
|
||||||
ter the 1st of the current
|
ter the 1st of the current
|
||||||
month
|
month
|
||||||
@ -534,8 +532,6 @@ OPTIONS
|
|||||||
-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"
|
||||||
|
|
||||||
|
|
||||||
-p "2009/1/1" just that day; equivalent
|
-p "2009/1/1" just that day; equivalent
|
||||||
to "2009/1/1 to 2009/1/2"
|
to "2009/1/1 to 2009/1/2"
|
||||||
|
|
||||||
@ -603,7 +599,6 @@ OPTIONS
|
|||||||
-p "every 2nd Monday" -- period bound-
|
-p "every 2nd Monday" -- period bound-
|
||||||
aries will be on second Monday of each
|
aries will be on second Monday of each
|
||||||
month
|
month
|
||||||
|
|
||||||
-p "every 11/05" -- yearly periods with
|
-p "every 11/05" -- yearly periods with
|
||||||
boundaries on 5th of Nov
|
boundaries on 5th of Nov
|
||||||
-p "every 5th Nov" -- same
|
-p "every 5th Nov" -- same
|
||||||
@ -947,7 +942,6 @@ OPTIONS
|
|||||||
grand total sum of dis- sum of dis- sum of dis- sum of dis-
|
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
|
(no report in- played values played values played values played values
|
||||||
terval)
|
terval)
|
||||||
|
|
||||||
row totals/av- sums/averages sums/averages sums/averages sums/averages
|
row totals/av- sums/averages sums/averages sums/averages sums/averages
|
||||||
erages (with of displayed of displayed of displayed of displayed
|
erages (with of displayed of displayed of displayed of displayed
|
||||||
report inter- values values values values
|
report inter- values values values values
|
||||||
@ -1179,6 +1173,8 @@ COMMANDS
|
|||||||
accounts, a
|
accounts, a
|
||||||
Show account names.
|
Show account names.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
This command lists account names, either declared with account direc-
|
This command lists account names, either declared with account direc-
|
||||||
tives (--declared), posted to (--used), or both (the default). With
|
tives (--declared), posted to (--used), or both (the default). With
|
||||||
query arguments, only matched account names and account names refer-
|
query arguments, only matched account names and account names refer-
|
||||||
@ -1204,6 +1200,8 @@ COMMANDS
|
|||||||
activity
|
activity
|
||||||
Show an ascii barchart of posting counts per interval.
|
Show an ascii barchart of posting counts per interval.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
The activity command displays an ascii histogram showing transaction
|
The activity command displays an ascii histogram showing transaction
|
||||||
counts by day, week, month or other reporting interval (by day is the
|
counts by day, week, month or other reporting interval (by day is the
|
||||||
default). With query arguments, it counts only matched transactions.
|
default). With query arguments, it counts only matched transactions.
|
||||||
@ -1220,6 +1218,8 @@ COMMANDS
|
|||||||
add
|
add
|
||||||
Prompt for transactions and add them to the journal.
|
Prompt for transactions and add them to the journal.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
Many hledger users edit their journals directly with a text editor, or
|
Many hledger users edit their journals directly with a text editor, or
|
||||||
generate them from CSV. For more interactive data entry, there is the
|
generate them from CSV. For more interactive data entry, there is the
|
||||||
add command, which prompts interactively on the console for new trans-
|
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 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
|
o If you make a mistake, enter < at any prompt to go one step backward.
|
||||||
backward.
|
|
||||||
|
|
||||||
o Input prompts are displayed in a different colour when the terminal
|
o Input prompts are displayed in a different colour when the terminal
|
||||||
supports it.
|
supports it.
|
||||||
@ -1294,6 +1293,8 @@ COMMANDS
|
|||||||
balance, bal, b
|
balance, bal, b
|
||||||
Show accounts and their balances.
|
Show accounts and their balances.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
The balance command is hledger's most versatile command. Note, despite
|
The balance command is hledger's most versatile command. Note, despite
|
||||||
the name, it is not always used for showing real-world account bal-
|
the name, it is not always used for showing real-world account bal-
|
||||||
ances; the more accounting-aware balancesheet and incomestatement may
|
ances; the more accounting-aware balancesheet and incomestatement may
|
||||||
@ -1723,7 +1724,7 @@ COMMANDS
|
|||||||
liabilities
|
liabilities
|
||||||
|
|
||||||
With this, monthly budget for electronics is defined to be $100 and
|
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.
|
means that budget for both expenses:personal and expenses is $1100.
|
||||||
|
|
||||||
Transactions in expenses:personal:electronics will be counted both to-
|
Transactions in expenses:personal:electronics will be counted both to-
|
||||||
@ -1804,6 +1805,8 @@ COMMANDS
|
|||||||
(like conventional financial statements, unlike balance/print/register)
|
(like conventional financial statements, unlike balance/print/register)
|
||||||
(experimental).
|
(experimental).
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
$ hledger balancesheet
|
$ hledger balancesheet
|
||||||
@ -1842,6 +1845,8 @@ COMMANDS
|
|||||||
Just like balancesheet, but also reports Equity (which it assumes is
|
Just like balancesheet, but also reports Equity (which it assumes is
|
||||||
under a top-level equity account).
|
under a top-level equity account).
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
$ hledger balancesheetequity
|
$ hledger balancesheetequity
|
||||||
@ -1877,6 +1882,8 @@ COMMANDS
|
|||||||
account balances with normal positive sign (like conventional financial
|
account balances with normal positive sign (like conventional financial
|
||||||
statements, unlike balance/print/register) (experimental).
|
statements, unlike balance/print/register) (experimental).
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
$ hledger cashflow
|
$ hledger cashflow
|
||||||
@ -1909,12 +1916,16 @@ COMMANDS
|
|||||||
unique. With a query, only matched transactions' dates are checked.
|
unique. With a query, only matched transactions' dates are checked.
|
||||||
Reads the default journal file, or another specified with -f.
|
Reads the default journal file, or another specified with -f.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
check-dupes
|
check-dupes
|
||||||
check-dupes
|
check-dupes
|
||||||
Reports account names having the same leaf but different prefixes. In
|
Reports account names having the same leaf but different prefixes. In
|
||||||
other words, two or more leaves that are categorized differently.
|
other words, two or more leaves that are categorized differently.
|
||||||
Reads the default journal file, or another specified as an argument.
|
Reads the default journal file, or another specified as an argument.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
An example: http://stefanorodighiero.net/software/hledger-dupes.html
|
An example: http://stefanorodighiero.net/software/hledger-dupes.html
|
||||||
|
|
||||||
close
|
close
|
||||||
@ -1925,6 +1936,8 @@ COMMANDS
|
|||||||
file, or for closing out revenues/expenses to retained earnings at the
|
file, or for closing out revenues/expenses to retained earnings at the
|
||||||
end of a period.
|
end of a period.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
The closing transaction transfers balances to "equity:closing bal-
|
The closing transaction transfers balances to "equity:closing bal-
|
||||||
ances", and the opening transaction transfers balances from "eq-
|
ances", and the opening transaction transfers balances from "eq-
|
||||||
uity:opening balances", or you can customise these with the --close-to
|
uity:opening balances", or you can customise these with the --close-to
|
||||||
@ -2005,9 +2018,13 @@ COMMANDS
|
|||||||
commodities
|
commodities
|
||||||
List all commodity/currency symbols used or declared in the journal.
|
List all commodity/currency symbols used or declared in the journal.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
descriptions
|
descriptions
|
||||||
descriptions Show descriptions.
|
descriptions Show descriptions.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
This command lists all descriptions that appear in transactions.
|
This command lists all descriptions that appear in transactions.
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
@ -2034,6 +2051,8 @@ COMMANDS
|
|||||||
the account balance, you can compare the bank data with your journal to
|
the account balance, you can compare the bank data with your journal to
|
||||||
find out the cause.
|
find out the cause.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
|
|
||||||
$ hledger diff -f $LEDGER_FILE -f bank.csv assets:bank:giro
|
$ 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
|
List all files included in the journal. With a REGEX argument, only
|
||||||
file names matching the regular expression (case sensitive) are shown.
|
file names matching the regular expression (case sensitive) are shown.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
help
|
help
|
||||||
help
|
help
|
||||||
Show any of the hledger manuals.
|
Show any of the hledger manuals.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
The help command displays any of the main hledger manuals, in one of
|
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
|
several ways. Run it with no argument to list the manuals, or provide
|
||||||
a full or partial manual name to select one.
|
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
|
tions that would be added. Or with --catchup, just mark all of the
|
||||||
FILEs' transactions as imported, without actually importing any.
|
FILEs' transactions as imported, without actually importing any.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
The input files are specified as arguments - no need to write -f before
|
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
|
each one. So eg to add new transactions from all CSV files to the main
|
||||||
journal, it's just: hledger import *.csv
|
journal, it's just: hledger import *.csv
|
||||||
@ -2129,6 +2154,8 @@ COMMANDS
|
|||||||
with normal positive sign (like conventional financial statements, un-
|
with normal positive sign (like conventional financial statements, un-
|
||||||
like balance/print/register) (experimental).
|
like balance/print/register) (experimental).
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
This command displays a simple income statement. It currently assumes
|
This command displays a simple income statement. It currently assumes
|
||||||
that you have top-level accounts named income (or revenue) and expense
|
that you have top-level accounts named income (or revenue) and expense
|
||||||
(plural forms also allowed.)
|
(plural forms also allowed.)
|
||||||
@ -2166,6 +2193,8 @@ COMMANDS
|
|||||||
notes
|
notes
|
||||||
notes Show notes.
|
notes Show notes.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
This command lists all notes that appear in transactions.
|
This command lists all notes that appear in transactions.
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
@ -2177,6 +2206,8 @@ COMMANDS
|
|||||||
payees
|
payees
|
||||||
payees Show payee names.
|
payees Show payee names.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
This command lists all payee names that appear in transactions.
|
This command lists all payee names that appear in transactions.
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
@ -2194,10 +2225,14 @@ COMMANDS
|
|||||||
Prices (and postings providing prices) can be filtered by a query.
|
Prices (and postings providing prices) can be filtered by a query.
|
||||||
Price amounts are always displayed with their full precision.
|
Price amounts are always displayed with their full precision.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
print
|
print
|
||||||
print, txns, p
|
print, txns, p
|
||||||
Show transaction journal entries, sorted by date.
|
Show transaction journal entries, sorted by date.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
The print command displays full journal entries (transactions) from the
|
The print command displays full journal entries (transactions) from the
|
||||||
journal file in date order, tidily formatted. With --date2, transac-
|
journal file in date order, tidily formatted. With --date2, transac-
|
||||||
tions are sorted by secondary date instead.
|
tions are sorted by secondary date instead.
|
||||||
@ -2298,6 +2333,8 @@ COMMANDS
|
|||||||
print-unique
|
print-unique
|
||||||
Print transactions which do not reuse an already-seen description.
|
Print transactions which do not reuse an already-seen description.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
|
||||||
$ cat unique.journal
|
$ cat unique.journal
|
||||||
@ -2314,6 +2351,8 @@ COMMANDS
|
|||||||
register, reg, r
|
register, reg, r
|
||||||
Show postings and their running total.
|
Show postings and their running total.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
The register command displays postings in date order, one per line, and
|
The register command displays postings in date order, one per line, and
|
||||||
their running total. This is typically used with a query selecting a
|
their running total. This is typically used with a query selecting a
|
||||||
particular account, to see that account's activity:
|
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-
|
arguments) can be used to restrict the search space. Helps ledger-au-
|
||||||
tosync detect already-seen transactions when importing.
|
tosync detect already-seen transactions when importing.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
rewrite
|
rewrite
|
||||||
rewrite
|
rewrite
|
||||||
Print all transactions, rewriting the postings of matched transactions.
|
Print all transactions, rewriting the postings of matched transactions.
|
||||||
For now the only rewrite available is adding new postings, like print
|
For now the only rewrite available is adding new postings, like print
|
||||||
--auto.
|
--auto.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
This is a start at a generic rewriter of transaction entries. It reads
|
This is a start at a generic rewriter of transaction entries. It reads
|
||||||
the default journal and prints the transactions, like print, but adds
|
the default journal and prints the transactions, like print, but adds
|
||||||
one or more specified postings to any transactions matching QUERY. The
|
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
|
Shows the time-weighted (TWR) and money-weighted (IRR) rate of return
|
||||||
on your investments.
|
on your investments.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
This command assumes that you have account(s) that hold nothing but
|
This command assumes that you have account(s) that hold nothing but
|
||||||
your investments and whenever you record current appraisal/valuation of
|
your investments and whenever you record current appraisal/valuation of
|
||||||
these investments you offset unrealized profit and loss into account(s)
|
these investments you offset unrealized profit and loss into account(s)
|
||||||
@ -2576,6 +2621,8 @@ COMMANDS
|
|||||||
stats
|
stats
|
||||||
Show some journal statistics.
|
Show some journal statistics.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
The stats command displays summary information for the whole journal,
|
The stats command displays summary information for the whole journal,
|
||||||
or a matched part of it. With a reporting interval, it shows a report
|
or a matched part of it. With a reporting interval, it shows a report
|
||||||
for each report period.
|
for each report period.
|
||||||
@ -2606,10 +2653,14 @@ COMMANDS
|
|||||||
considered. With --values flag, the tags' unique values are listed in-
|
considered. With --values flag, the tags' unique values are listed in-
|
||||||
stead.
|
stead.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
test
|
test
|
||||||
test
|
test
|
||||||
Run built-in unit tests.
|
Run built-in unit tests.
|
||||||
|
|
||||||
|
$FLAGS$
|
||||||
|
|
||||||
This command runs the unit tests built in to hledger and hledger-lib,
|
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
|
printing the results on stdout. If any test fails, the exit code will
|
||||||
be non-zero.
|
be non-zero.
|
||||||
@ -2668,10 +2719,6 @@ ADD-ON COMMANDS
|
|||||||
These are maintained separately, and usually updated shortly after a
|
These are maintained separately, and usually updated shortly after a
|
||||||
hledger release.
|
hledger release.
|
||||||
|
|
||||||
diff
|
|
||||||
hledger-diff shows differences in an account's transactions between one
|
|
||||||
journal file and another.
|
|
||||||
|
|
||||||
iadd
|
iadd
|
||||||
hledger-iadd is a more interactive, terminal UI replacement for the add
|
hledger-iadd is a more interactive, terminal UI replacement for the add
|
||||||
command.
|
command.
|
||||||
@ -2680,10 +2727,6 @@ ADD-ON COMMANDS
|
|||||||
hledger-interest generates interest transactions for an account accord-
|
hledger-interest generates interest transactions for an account accord-
|
||||||
ing to various schemes.
|
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
|
Experimental add-ons
|
||||||
These are available in source form in the hledger repo's bin/ direc-
|
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.
|
tory. They may be less mature and documented than built-in commands.
|
||||||
@ -2696,10 +2739,7 @@ ADD-ON COMMANDS
|
|||||||
offers OFX Direct Connect.
|
offers OFX Direct Connect.
|
||||||
|
|
||||||
chart
|
chart
|
||||||
hledger-chart.hs is an old pie chart generator, in need of some love.
|
hledger-chart.hs is an old very basic pie chart generator.
|
||||||
|
|
||||||
check
|
|
||||||
hledger-check.hs checks more powerful account balance assertions.
|
|
||||||
|
|
||||||
ENVIRONMENT
|
ENVIRONMENT
|
||||||
COLUMNS The screen width used by the register command. Default: the
|
COLUMNS The screen width used by the register command. Default: the
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user