simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-12-26 03:42:25 +03:00
Code Issues Projects Releases Wiki Activity

;doc: regen manuals

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2020-01-22 12:03:39 -08:00
parent 7500002ee5
commit 9710c86c7f
7 changed files with 435 additions and 356 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
hledger-lib/hledger_journal.5
View File

@ -1275,21 +1275,24 @@ account assets:bank:checking
.fi
.SS Account comments
.PP
Comments, beginning with a semicolon, optionally including tags, can be
written after the account name, and/or on following lines.
Eg:
Comments, beginning with a semicolon, can be added:
.IP \[bu] 2
on the same line, \f[B]after two or more spaces\f[R] (because ; is
allowed in account names)
.IP \[bu] 2
on the next lines, indented
.PP
An example of both:
.IP
.nf
\f[C]
account assets:bank:checking ; a comment
; another comment
; acctno:12345, a tag
account assets:bank:checking ; same-line comment, note 2+ spaces before ;
; next-line comment
; another with tag, acctno:12345 (not used yet)
\f[R]
.fi
.PP
Tip: comments on the same line require hledger 1.12+.
If you need your journal to be compatible with older hledger versions,
write comments on the next line instead.
Same-line comments are not supported by Ledger, or hledger <1.13.
.SS Account subdirectives
.PP
We also allow (and ignore) Ledger-style indented subdirectives, just for

95
hledger-lib/hledger_journal.info
View File

@ -1162,16 +1162,19 @@ File: hledger_journal.info, Node: Account comments, Next: Account subdirective
1.14.7.1 Account comments
.........................
Comments, beginning with a semicolon, optionally including tags, can be
written after the account name, and/or on following lines. Eg:
Comments, beginning with a semicolon, can be added:
account assets:bank:checking ; a comment
; another comment
; acctno:12345, a tag
* on the same line, *after two or more spaces* (because ; is allowed
in account names)
* on the next lines, indented
Tip: comments on the same line require hledger 1.12+. If you need
your journal to be compatible with older hledger versions, write
comments on the next line instead.
An example of both:
account assets:bank:checking ; same-line comment, note 2+ spaces before ;
; next-line comment
; another with tag, acctno:12345 (not used yet)
Same-line comments are not supported by Ledger, or hledger <1.13.

File: hledger_journal.info, Node: Account subdirectives, Next: Account types, Prev: Account comments, Up: Declaring accounts
@ -1825,44 +1828,44 @@ Node: Declaring accounts41126
Ref: #declaring-accounts41302
Node: Account comments42227
Ref: #account-comments42390
Node: Account subdirectives42785
Ref: #account-subdirectives42980
Node: Account types43293
Ref: #account-types43477
Node: Account display order45119
Ref: #account-display-order45289
Node: Rewriting accounts46418
Ref: #rewriting-accounts46603
Node: Basic aliases47329
Ref: #basic-aliases47475
Node: Regex aliases48179
Ref: #regex-aliases48351
Node: Combining aliases49069
Ref: #combining-aliases49247
Node: end aliases50523
Ref: #end-aliases50671
Node: Default parent account50772
Ref: #default-parent-account50938
Node: Periodic transactions51822
Ref: #periodic-transactions52020
Node: Periodic rule syntax53892
Ref: #periodic-rule-syntax54098
Node: Two spaces between period expression and description!54802
Ref: #two-spaces-between-period-expression-and-description55121
Node: Forecasting with periodic transactions55805
Ref: #forecasting-with-periodic-transactions56110
Node: Budgeting with periodic transactions58136
Ref: #budgeting-with-periodic-transactions58375
Node: Auto postings / transaction modifiers58824
Ref: #auto-postings-transaction-modifiers59035
Node: Auto postings and dates61264
Ref: #auto-postings-and-dates61521
Node: Auto postings and transaction balancing / inferred amounts / balance assertions61696
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions62071
Node: Auto posting tags62449
Ref: #auto-posting-tags62688
Node: EDITOR SUPPORT63353
Ref: #editor-support63471
Node: Account subdirectives42814
Ref: #account-subdirectives43009
Node: Account types43322
Ref: #account-types43506
Node: Account display order45148
Ref: #account-display-order45318
Node: Rewriting accounts46447
Ref: #rewriting-accounts46632
Node: Basic aliases47358
Ref: #basic-aliases47504
Node: Regex aliases48208
Ref: #regex-aliases48380
Node: Combining aliases49098
Ref: #combining-aliases49276
Node: end aliases50552
Ref: #end-aliases50700
Node: Default parent account50801
Ref: #default-parent-account50967
Node: Periodic transactions51851
Ref: #periodic-transactions52049
Node: Periodic rule syntax53921
Ref: #periodic-rule-syntax54127
Node: Two spaces between period expression and description!54831
Ref: #two-spaces-between-period-expression-and-description55150
Node: Forecasting with periodic transactions55834
Ref: #forecasting-with-periodic-transactions56139
Node: Budgeting with periodic transactions58165
Ref: #budgeting-with-periodic-transactions58404
Node: Auto postings / transaction modifiers58853
Ref: #auto-postings-transaction-modifiers59064
Node: Auto postings and dates61293
Ref: #auto-postings-and-dates61550
Node: Auto postings and transaction balancing / inferred amounts / balance assertions61725
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions62100
Node: Auto posting tags62478
Ref: #auto-posting-tags62717
Node: EDITOR SUPPORT63382
Ref: #editor-support63500

End Tag Table

20
hledger-lib/hledger_journal.txt
View File

@ -900,16 +900,20 @@ FILE FORMAT
account assets:bank:checking
Account comments
Comments, beginning with a semicolon, optionally including tags, can be
written after the account name, and/or on following lines. Eg:
Comments, beginning with a semicolon, can be added:
account assets:bank:checking ; a comment
; another comment
; acctno:12345, a tag
o on the same line, after two or more spaces (because ; is allowed in
account names)
Tip: comments on the same line require hledger 1.12+. If you need your
journal to be compatible with older hledger versions, write comments on
the next line instead.
o on the next lines, indented
An example of both:
account assets:bank:checking ; same-line comment, note 2+ spaces before ;
; next-line comment
; another with tag, acctno:12345 (not used yet)
Same-line comments are not supported by Ledger, or hledger <1.13.
Account subdirectives
We also allow (and ignore) Ledger-style indented subdirectives, just

39
hledger/Hledger/Cli/Commands/Close.txt
View File

@ -7,15 +7,34 @@ end of a period.
_FLAGS
The closing transaction transfers balances to "equity:closing balances",
and the opening transaction transfers balances from "equity:opening
balances", or you can customise these with the --close-to and
--open-from options. You can choose to print just one of the
transactions by using the --opening or --closing flag.
You can choose to print just one of the transactions by using the
--opening or --closing flag.
The equity postings appear at the end of the transaction by default;
with --interleaved, they appear beside their corresponding closing
postings.
The closing transaction transfers balances to equity:closing balances,
and the opening transaction transfers balances from
equity:opening balances, by default. You can choose different account
names with the --close-to and --open-from options. If you specify only
one of these, it is used for both.
By default, a single balancing equity posting is added at the end of
these journal entries, with the amount left implicit.
With --x/--explicit, the balancing amount is shown, and if multiple
commodities are involved, multiple single-commodity equity postings are
shown (like the print command).
With --interleaved, the equity postings are shown next to each posting
they balance, which can be better for troubleshooting (and can generate
more postings).
By default, transaction prices in the journal are ignored when
generating the closing/opening transactions. With --show-costs, this
cost information is preserved, so that balance -B reports will be
unchanged after the transition. Separate postings are generated for each
cost in each commodity. Note this can generate very large journal
entries, if you have many foreign currency or investment transactions.
close usage
If you split your journal files by time (eg yearly), you will typically
run this command at the end of the year, and save the closing
@ -46,10 +65,6 @@ balance assertions will depend on these flags. Likewise, if you run this
command with --auto, the balance assertions will probably always require
--auto.
When account balances have cost information (transaction prices), the
closing/opening transactions will preserve it, so that eg balance -B
reports will not be affected.
Examples:
Carrying asset/liability balances into a new file for 2019, all from

37
hledger/hledger.1
View File

@ -2714,16 +2714,35 @@ Useful for bringing asset/liability balances forward into a new journal
file, or for closing out revenues/expenses to retained earnings at the
end of a period.
.PP
The closing transaction transfers balances to \[dq]equity:closing
balances\[dq], and the opening transaction transfers balances from
\[dq]equity:opening balances\[dq], or you can customise these with the
\f[C]--close-to\f[R] and \f[C]--open-from\f[R] options.
You can choose to print just one of the transactions by using the
\f[C]--opening\f[R] or \f[C]--closing\f[R] flag.
.PP
The equity postings appear at the end of the transaction by default;
with \f[C]--interleaved\f[R], they appear beside their corresponding
closing postings.
The closing transaction transfers balances to
\f[C]equity:closing balances\f[R], and the opening transaction transfers
balances from \f[C]equity:opening balances\f[R], by default.
You can choose different account names with the \f[C]--close-to\f[R] and
\f[C]--open-from\f[R] options.
If you specify only one of these, it is used for both.
.PP
By default, a single balancing equity posting is added at the end of
these journal entries, with the amount left implicit.
.PP
With \f[C]--x/--explicit\f[R], the balancing amount is shown, and if
multiple commodities are involved, multiple single-commodity equity
postings are shown (like the print command).
.PP
With \f[C]--interleaved\f[R], the equity postings are shown next to each
posting they balance, which can be better for troubleshooting (and can
generate more postings).
.PP
By default, transaction prices in the journal are ignored when
generating the closing/opening transactions.
With \f[C]--show-costs\f[R], this cost information is preserved, so that
\f[C]balance -B\f[R] reports will be unchanged after the transition.
Separate postings are generated for each cost in each commodity.
Note this can generate very large journal entries, if you have many
foreign currency or investment transactions.
.SS close usage
.PP
If you split your journal files by time (eg yearly), you will typically
run this command at the end of the year, and save the closing
@ -2761,10 +2780,6 @@ assertions will depend on these flags.
Likewise, if you run this command with --auto, the balance assertions
will probably always require --auto.
.PP
When account balances have cost information (transaction prices), the
closing/opening transactions will preserve it, so that eg balance -B
reports will not be affected.
.PP
Examples:
.PP
Carrying asset/liability balances into a new file for 2019, all from

189
hledger/hledger.info
View File

@ -2213,18 +2213,45 @@ Useful for bringing asset/liability balances forward into a new journal
file, or for closing out revenues/expenses to retained earnings at the
end of a period.
The closing transaction transfers balances to "equity:closing
balances", and the opening transaction transfers balances from
"equity:opening balances", or you can customise these with the
'--close-to' and '--open-from' options. You can choose to print just
one of the transactions by using the '--opening' or '--closing' flag.
You can choose to print just one of the transactions by using the
'--opening' or '--closing' flag.
The equity postings appear at the end of the transaction by default;
with '--interleaved', they appear beside their corresponding closing
postings.
The closing transaction transfers balances to 'equity:closing
balances', and the opening transaction transfers balances from
'equity:opening balances', by default. You can choose different account
names with the '--close-to' and '--open-from' options. If you specify
only one of these, it is used for both.
If you split your journal files by time (eg yearly), you will
typically run this command at the end of the year, and save the closing
By default, a single balancing equity posting is added at the end of
these journal entries, with the amount left implicit.
With '--x/--explicit', the balancing amount is shown, and if multiple
commodities are involved, multiple single-commodity equity postings are
shown (like the print command).
With '--interleaved', the equity postings are shown next to each
posting they balance, which can be better for troubleshooting (and can
generate more postings).
By default, transaction prices in the journal are ignored when
generating the closing/opening transactions. With '--show-costs', this
cost information is preserved, so that 'balance -B' reports will be
unchanged after the transition. Separate postings are generated for
each cost in each commodity. Note this can generate very large journal
entries, if you have many foreign currency or investment transactions.
* Menu:
* close usage::

File: hledger.info, Node: close usage, Up: close
4.10.1 close usage
------------------
If you split your journal files by time (eg yearly), you will typically
run this command at the end of the year, and save the closing
transaction as last entry of the old file, and the opening transaction
as the first entry of the new file. This makes the files self
contained, so that correct balances are reported no matter which of them
@ -2254,10 +2281,6 @@ balance assertions will depend on these flags. Likewise, if you run
this command with -auto, the balance assertions will probably always
require -auto.
When account balances have cost information (transaction prices), the
closing/opening transactions will preserve it, so that eg balance -B
reports will not be affected.
Examples:
Carrying asset/liability balances into a new file for 2019, all from
@ -3300,74 +3323,76 @@ Node: check-dupes76317
Ref: #check-dupes76441
Node: close76734
Ref: #close76848
Node: commodities80666
Ref: #commodities80793
Node: descriptions80875
Ref: #descriptions81003
Node: diff81184
Ref: #diff81290
Node: files82337
Ref: #files82437
Node: help82584
Ref: #help82684
Node: import83765
Ref: #import83879
Node: Importing balance assignments84772
Ref: #importing-balance-assignments84920
Node: incomestatement85569
Ref: #incomestatement85702
Node: notes87106
Ref: #notes87219
Node: payees87345
Ref: #payees87451
Node: prices87609
Ref: #prices87715
Node: print88056
Ref: #print88166
Node: print-unique92810
Ref: #print-unique92936
Node: register93221
Ref: #register93348
Node: Custom register output97520
Ref: #custom-register-output97649
Node: register-match98911
Ref: #register-match99045
Node: rewrite99396
Ref: #rewrite99511
Node: Re-write rules in a file101366
Ref: #re-write-rules-in-a-file101500
Node: Diff output format102710
Ref: #diff-output-format102879
Node: rewrite vs print --auto103971
Ref: #rewrite-vs.-print---auto104150
Node: roi104706
Ref: #roi104804
Node: stats105816
Ref: #stats105915
Node: tags106703
Ref: #tags106801
Node: test107095
Ref: #test107179
Node: ADD-ON COMMANDS107926
Ref: #add-on-commands108036
Node: Official add-ons109324
Ref: #official-add-ons109464
Node: ui109544
Ref: #ui109631
Node: web109685
Ref: #web109774
Node: Third party add-ons109820
Ref: #third-party-add-ons109995
Node: iadd110114
Ref: #iadd110215
Node: interest110297
Ref: #interest110406
Node: Experimental add-ons110501
Ref: #experimental-add-ons110653
Node: autosync110891
Ref: #autosync111002
Node: chart111241
Ref: #chart111346
Node: close usage78492
Ref: #close-usage78585
Node: commodities81430
Ref: #commodities81557
Node: descriptions81639
Ref: #descriptions81767
Node: diff81948
Ref: #diff82054
Node: files83101
Ref: #files83201
Node: help83348
Ref: #help83448
Node: import84529
Ref: #import84643
Node: Importing balance assignments85536
Ref: #importing-balance-assignments85684
Node: incomestatement86333
Ref: #incomestatement86466
Node: notes87870
Ref: #notes87983
Node: payees88109
Ref: #payees88215
Node: prices88373
Ref: #prices88479
Node: print88820
Ref: #print88930
Node: print-unique93574
Ref: #print-unique93700
Node: register93985
Ref: #register94112
Node: Custom register output98284
Ref: #custom-register-output98413
Node: register-match99675
Ref: #register-match99809
Node: rewrite100160
Ref: #rewrite100275
Node: Re-write rules in a file102130
Ref: #re-write-rules-in-a-file102264
Node: Diff output format103474
Ref: #diff-output-format103643
Node: rewrite vs print --auto104735
Ref: #rewrite-vs.-print---auto104914
Node: roi105470
Ref: #roi105568
Node: stats106580
Ref: #stats106679
Node: tags107467
Ref: #tags107565
Node: test107859
Ref: #test107943
Node: ADD-ON COMMANDS108690
Ref: #add-on-commands108800
Node: Official add-ons110088
Ref: #official-add-ons110228
Node: ui110308
Ref: #ui110395
Node: web110449
Ref: #web110538
Node: Third party add-ons110584
Ref: #third-party-add-ons110759
Node: iadd110878
Ref: #iadd110979
Node: interest111061
Ref: #interest111170
Node: Experimental add-ons111265
Ref: #experimental-add-ons111417
Node: autosync111655
Ref: #autosync111766
Node: chart112005
Ref: #chart112110

End Tag Table

390
hledger/hledger.txt
View File

@ -1949,56 +1949,70 @@ COMMANDS
file, or for closing out revenues/expenses to retained earnings at the
end of a period.
The closing transaction transfers balances to "equity:closing bal-
ances", and the opening transaction transfers balances from "eq-
uity:opening balances", or you can customise these with the --close-to
and --open-from options. You can choose to print just one of the
transactions by using the --opening or --closing flag.
You can choose to print just one of the transactions by using the
--opening or --closing flag.
The equity postings appear at the end of the transaction by default;
with --interleaved, they appear beside their corresponding closing
postings.
The closing transaction transfers balances to equity:closing balances,
and the opening transaction transfers balances from equity:opening bal-
ances, by default. You can choose different account names with the
--close-to and --open-from options. If you specify only one of these,
it is used for both.
By default, a single balancing equity posting is added at the end of
these journal entries, with the amount left implicit.
With --x/--explicit, the balancing amount is shown, and if multiple
commodities are involved, multiple single-commodity equity postings are
shown (like the print command).
With --interleaved, the equity postings are shown next to each posting
they balance, which can be better for troubleshooting (and can generate
more postings).
By default, transaction prices in the journal are ignored when generat-
ing the closing/opening transactions. With --show-costs, this cost in-
formation is preserved, so that balance -B reports will be unchanged
after the transition. Separate postings are generated for each cost in
each commodity. Note this can generate very large journal entries, if
you have many foreign currency or investment transactions.
close usage
If you split your journal files by time (eg yearly), you will typically
run this command at the end of the year, and save the closing transac-
tion as last entry of the old file, and the opening transaction as the
first entry of the new file. This makes the files self contained, so
that correct balances are reported no matter which of them are loaded.
Ie, if you load just one file, the balances are initialised correctly;
or if you load several files, the redundant closing/opening transac-
tions cancel each other out. (They will show up in print or register
reports; you can exclude them with a query like not:desc:'(open-
run this command at the end of the year, and save the closing transac-
tion as last entry of the old file, and the opening transaction as the
first entry of the new file. This makes the files self contained, so
that correct balances are reported no matter which of them are loaded.
Ie, if you load just one file, the balances are initialised correctly;
or if you load several files, the redundant closing/opening transac-
tions cancel each other out. (They will show up in print or register
reports; you can exclude them with a query like not:desc:'(open-
ing|closing) balances'.)
If you're running a business, you might also use this command to "close
the books" at the end of an accounting period, transferring income
statement account balances to retained earnings. (You may want to
the books" at the end of an accounting period, transferring income
statement account balances to retained earnings. (You may want to
change the equity account name to something like "equity:retained earn-
ings".)
By default, the closing transaction is dated yesterday, the balances
are calculated as of end of yesterday, and the opening transaction is
dated today. To close on some other date, use: hledger close -e OPEN-
INGDATE. Eg, to close/open on the 2018/2019 boundary, use -e 2019.
By default, the closing transaction is dated yesterday, the balances
are calculated as of end of yesterday, and the opening transaction is
dated today. To close on some other date, use: hledger close -e OPEN-
INGDATE. Eg, to close/open on the 2018/2019 boundary, use -e 2019.
You can also use -p or date:PERIOD (any starting date is ignored).
Both transactions will include balance assertions for the closed/re-
Both transactions will include balance assertions for the closed/re-
opened accounts. You probably shouldn't use status or realness filters
(like -C or -R or status:) with this command, or the generated balance
assertions will depend on these flags. Likewise, if you run this com-
mand with --auto, the balance assertions will probably always require
(like -C or -R or status:) with this command, or the generated balance
assertions will depend on these flags. Likewise, if you run this com-
mand with --auto, the balance assertions will probably always require
--auto.
When account balances have cost information (transaction prices), the
closing/opening transactions will preserve it, so that eg balance -B
reports will not be affected.
Examples:
Carrying asset/liability balances into a new file for 2019, all from
Carrying asset/liability balances into a new file for 2019, all from
command line:
Warning: we use >> here to append; be careful not to type a single >
Warning: we use >> here to append; be careful not to type a single >
which would wipe your journal!
$ hledger close -f 2018.journal -e 2019 assets liabilities --opening >>2019.journal
@ -2047,18 +2061,18 @@ COMMANDS
diff
diff
Compares a particular account's transactions in two input files. It
Compares a particular account's transactions in two input files. It
shows any transactions to this account which are in one file but not in
the other.
More precisely, for each posting affecting this account in either file,
it looks for a corresponding posting in the other file which posts the
same amount to the same account (ignoring date, description, etc.)
it looks for a corresponding posting in the other file which posts the
same amount to the same account (ignoring date, description, etc.)
Since postings not transactions are compared, this also works when mul-
tiple bank transactions have been combined into a single journal entry.
This is useful eg if you have downloaded an account's transactions from
your bank (eg as CSV data). When hledger and your bank disagree about
your bank (eg as CSV data). When hledger and your bank disagree about
the account balance, you can compare the bank data with your journal to
find out the cause.
@ -2076,20 +2090,20 @@ COMMANDS
files
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.
help
help
Show any of the hledger manuals.
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
The help command displays any of the main hledger manuals, in one of
several ways. Run it with no argument to list the manuals, or provide
a full or partial manual name to select one.
hledger manuals are available in several formats. hledger help will
use the first of these display methods that it finds: info, man,
$PAGER, less, stdout (or when non-interactive, just stdout). You can
hledger manuals are available in several formats. hledger help will
use the first of these display methods that it finds: info, man,
$PAGER, less, stdout (or when non-interactive, just stdout). You can
force a particular viewer with the --info, --man, --pager, --cat flags.
Examples:
@ -2116,9 +2130,9 @@ COMMANDS
import
import
Read new transactions added to each FILE since last run, and add them
to the main journal file. Or with --dry-run, just print the transac-
tions that would be added. Or with --catchup, just mark all of the
Read new transactions added to each FILE since last run, and add them
to the main journal file. Or with --dry-run, just print the transac-
tions that would be added. Or with --catchup, just mark all of the
FILEs' transactions as imported, without actually importing any.
The input files are specified as arguments - no need to write -f before
@ -2129,36 +2143,36 @@ COMMANDS
ing transactions are always added to the input files in increasing date
order, and by saving .latest.FILE state files.
The --dry-run output is in journal format, so you can filter it, eg to
The --dry-run output is in journal format, so you can filter it, eg to
see only uncategorised transactions:
$ hledger import --dry ... | hledger -f- print unknown --ignore-assertions
Importing balance assignments
Entries added by import will have their posting amounts made explicit
(like hledger print -x). This means that any balance assignments in
imported files must be evaluated; but, imported files don't get to see
the main file's account balances. As a result, importing entries with
Entries added by import will have their posting amounts made explicit
(like hledger print -x). This means that any balance assignments in
imported files must be evaluated; but, imported files don't get to see
the main file's account balances. As a result, importing entries with
balance assignments (eg from an institution that provides only balances
and not posting amounts) will probably generate incorrect posting
and not posting amounts) will probably generate incorrect posting
amounts. To avoid this problem, use print instead of import:
$ hledger print IMPORTFILE [--new] >> $LEDGER_FILE
(If you think import should leave amounts implicit like print does,
(If you think import should leave amounts implicit like print does,
please test it and send a pull request.)
incomestatement
incomestatement, is
This command displays a simple income statement, showing revenues and
expenses during a period. It assumes that these accounts are under a
top-level revenue or income or expense account (case insensitive, plu-
ral forms also allowed). Note this report shows all account balances
with normal positive sign (like conventional financial statements, un-
This command displays a simple income statement, showing revenues and
expenses during a period. It assumes that these accounts are under a
top-level revenue or income or expense account (case insensitive, plu-
ral forms also allowed). Note this report shows all account balances
with normal positive sign (like conventional financial statements, un-
like balance/print/register) (experimental).
This command displays a simple income statement. It currently assumes
that you have top-level accounts named income (or revenue) and expense
This command displays a simple income statement. It currently assumes
that you have top-level accounts named income (or revenue) and expense
(plural forms also allowed.)
$ hledger incomestatement
@ -2183,12 +2197,12 @@ COMMANDS
0
With a reporting interval, multiple columns will be shown, one for each
report period. Normally incomestatement shows revenues/expenses per
period, though as with multicolumn balance reports you can alter the
report mode with --change/--cumulative/--historical. Instead of abso-
report period. Normally incomestatement shows revenues/expenses per
period, though as with multicolumn balance reports you can alter the
report mode with --change/--cumulative/--historical. Instead of abso-
lute values percentages can be displayed with -%.
This command also supports output destination and output format selec-
This command also supports output destination and output format selec-
tion.
notes
@ -2216,10 +2230,10 @@ COMMANDS
prices
prices
Print market price directives from the journal. With --costs, also
print synthetic market prices based on transaction prices. With --in-
verted-costs, also print inverse prices based on transaction prices.
Prices (and postings providing prices) can be filtered by a query.
Print market price directives from the journal. With --costs, also
print synthetic market prices based on transaction prices. With --in-
verted-costs, also print inverse prices based on transaction prices.
Prices (and postings providing prices) can be filtered by a query.
Price amounts are always displayed with their full precision.
print
@ -2227,11 +2241,11 @@ COMMANDS
Show transaction journal entries, sorted by date.
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.
print's output is always a valid hledger journal.
It preserves all transaction information, but it does not preserve di-
It preserves all transaction information, but it does not preserve di-
rectives or inter-transaction comments
$ hledger print
@ -2258,41 +2272,41 @@ COMMANDS
Normally, the journal entry's explicit or implicit amount style is pre-
served. For example, when an amount is omitted in the journal, it will
not appear in the output. Similarly, when a transaction price is im-
plied but not written, it will not appear in the output. You can use
the -x/--explicit flag to make all amounts and transaction prices ex-
plicit, which can be useful for troubleshooting or for making your
not appear in the output. Similarly, when a transaction price is im-
plied but not written, it will not appear in the output. You can use
the -x/--explicit flag to make all amounts and transaction prices ex-
plicit, which can be useful for troubleshooting or for making your
journal more readable and robust against data entry errors.
Note, -x/--explicit will cause postings with a multi-commodity amount
(these can arise when a multi-commodity transaction has an implicit
amount) to be split into multiple single-commodity postings, keeping
Note, -x/--explicit will cause postings with a multi-commodity amount
(these can arise when a multi-commodity transaction has an implicit
amount) to be split into multiple single-commodity postings, keeping
the output parseable.
With -B/--cost, amounts with transaction prices are converted to cost
With -B/--cost, amounts with transaction prices are converted to cost
using that price. This can be used for troubleshooting.
With -m/--match and a STR argument, print will show at most one trans-
action: the one one whose description is most similar to STR, and is
most recent. STR should contain at least two characters. If there is
With -m/--match and a STR argument, print will show at most one trans-
action: the one one whose description is most similar to STR, and is
most recent. STR should contain at least two characters. If there is
no similar-enough match, no transaction will be shown.
With --new, for each FILE being read, hledger reads (and writes) a spe-
cial state file (.latest.FILE in the same directory), containing the
latest transaction date(s) that were seen last time FILE was read.
When this file is found, only transactions with newer dates (and new
transactions on the latest date) are printed. This is useful for ig-
noring already-seen entries in import data, such as downloaded CSV
cial state file (.latest.FILE in the same directory), containing the
latest transaction date(s) that were seen last time FILE was read.
When this file is found, only transactions with newer dates (and new
transactions on the latest date) are printed. This is useful for ig-
noring already-seen entries in import data, such as downloaded CSV
files. Eg:
$ hledger -f bank1.csv print --new
# shows transactions added since last print --new on this file
This assumes that transactions added to FILE always have same or in-
creasing dates, and that transactions on the same day do not get re-
This assumes that transactions added to FILE always have same or in-
creasing dates, and that transactions on the same day do not get re-
ordered. See also the import command.
This command also supports output destination and output format selec-
This command also supports output destination and output format selec-
tion. Here's an example of print's CSV output:
$ hledger print -Ocsv
@ -2309,20 +2323,20 @@ COMMANDS
"5","2008/12/31","","*","","pay off","","liabilities:debts","1","$","","1","",""
"5","2008/12/31","","*","","pay off","","assets:bank:checking","-1","$","1","","",""
o There is one CSV record per posting, with the parent transaction's
o There is one CSV record per posting, with the parent transaction's
fields repeated.
o The "txnidx" (transaction index) field shows which postings belong to
the same transaction. (This number might change if transactions are
reordered within the file, files are parsed/included in a different
the same transaction. (This number might change if transactions are
reordered within the file, files are parsed/included in a different
order, etc.)
o The amount is separated into "commodity" (the symbol) and "amount"
o The amount is separated into "commodity" (the symbol) and "amount"
(numeric quantity) fields.
o The numeric amount is repeated in either the "credit" or "debit" col-
umn, for convenience. (Those names are not accurate in the account-
ing sense; it just puts negative amounts under credit and zero or
umn, for convenience. (Those names are not accurate in the account-
ing sense; it just puts negative amounts under credit and zero or
greater amounts under debit.)
print-unique
@ -2346,7 +2360,7 @@ COMMANDS
Show postings and their running total.
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:
$ hledger register checking
@ -2357,8 +2371,8 @@ COMMANDS
With --date2, it shows and sorts by secondary date instead.
The --historical/-H flag adds the balance from any undisplayed prior
postings to the running total. This is useful when you want to see
The --historical/-H flag adds the balance from any undisplayed prior
postings to the running total. This is useful when you want to see
only recent activity, with a historically accurate running balance:
$ hledger register checking -b 2008/6 --historical
@ -2368,18 +2382,18 @@ COMMANDS
The --depth option limits the amount of sub-account detail displayed.
The --average/-A flag shows the running average posting amount instead
The --average/-A flag shows the running average posting amount instead
of the running total (so, the final number displayed is the average for
the whole report period). This flag implies --empty (see below). It
is affected by --historical. It works best when showing just one ac-
the whole report period). This flag implies --empty (see below). It
is affected by --historical. It works best when showing just one ac-
count and one commodity.
The --related/-r flag shows the other postings in the transactions of
The --related/-r flag shows the other postings in the transactions of
the postings which would normally be shown.
The --invert flag negates all amounts. For example, it can be used on
The --invert flag negates all amounts. For example, it can be used on
an income account where amounts are normally displayed as negative num-
bers. It's also useful to show postings on the checking account to-
bers. It's also useful to show postings on the checking account to-
gether with the related account:
$ hledger register --related --invert assets:checking
@ -2391,7 +2405,7 @@ COMMANDS
2008/01 income:salary $-1 $-1
2008/06 income:gifts $-1 $-2
Periods with no activity, and summary postings with a zero amount, are
Periods with no activity, and summary postings with a zero amount, are
not shown by default; use the --empty/-E flag to see them:
$ hledger register --monthly income -E
@ -2408,7 +2422,7 @@ COMMANDS
2008/11 0 $-2
2008/12 0 $-2
Often, you'll want to see just one line per interval. The --depth op-
Often, you'll want to see just one line per interval. The --depth op-
tion helps with this, causing subaccounts to be aggregated:
$ hledger register --monthly assets --depth 1h
@ -2416,17 +2430,17 @@ COMMANDS
2008/06 assets $-1 0
2008/12 assets $-1 $-1
Note when using report intervals, if you specify start/end dates these
will be adjusted outward if necessary to contain a whole number of in-
tervals. This ensures that the first and last intervals are full
Note when using report intervals, if you specify start/end dates these
will be adjusted outward if necessary to contain a whole number of in-
tervals. This ensures that the first and last intervals are full
length and comparable to the others in the report.
Custom register output
register uses the full terminal width by default, except on windows.
You can override this by setting the COLUMNS environment variable (not
register uses the full terminal width by default, except on windows.
You can override this by setting the COLUMNS environment variable (not
a bash shell variable) or by using the --width/-w option.
The description and account columns normally share the space equally
The description and account columns normally share the space equally
(about half of (width - 40) each). You can adjust this by adding a de-
scription width as part of --width's argument, comma-separated: --width
W,D . Here's a diagram (won't display correctly in --help):
@ -2444,27 +2458,27 @@ COMMANDS
$ hledger reg -w 100,40 # set overall width 100, description width 40
$ hledger reg -w $COLUMNS,40 # use terminal width, & description width 40
This command also supports output destination and output format selec-
This command also supports output destination and output format selec-
tion.
register-match
register-match
Print the one posting whose transaction description is closest to DESC,
in the style of the register command. If there are multiple equally
good matches, it shows the most recent. Query options (options, not
arguments) can be used to restrict the search space. Helps ledger-au-
in the style of the register command. If there are multiple equally
good matches, it shows the most recent. Query options (options, not
arguments) can be used to restrict the search space. Helps ledger-au-
tosync detect already-seen transactions when importing.
rewrite
rewrite
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.
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
posting amounts can be fixed, or a multiplier of the existing transac-
posting amounts can be fixed, or a multiplier of the existing transac-
tion's first posting amount.
Examples:
@ -2480,7 +2494,7 @@ COMMANDS
(reserve:grocery) *0.25 ; reserve 25% for grocery
(reserve:) *0.25 ; reserve 25% for grocery
Note the single quotes to protect the dollar sign from bash, and the
Note the single quotes to protect the dollar sign from bash, and the
two spaces between account and amount.
More:
@ -2490,16 +2504,16 @@ COMMANDS
$ hledger rewrite -- expenses:gifts --add-posting '(budget:gifts) *-1"'
$ hledger rewrite -- ^income --add-posting '(budget:foreign currency) *0.25 JPY; diversify'
Argument for --add-posting option is a usual posting of transaction
with an exception for amount specification. More precisely, you can
Argument for --add-posting option is a usual posting of transaction
with an exception for amount specification. More precisely, you can
use '*' (star symbol) before the amount to indicate that that this is a
factor for an amount of original matched posting. If the amount in-
factor for an amount of original matched posting. If the amount in-
cludes a commodity name, the new posting amount will be in the new com-
modity; otherwise, it will be in the matched posting amount's commod-
modity; otherwise, it will be in the matched posting amount's commod-
ity.
Re-write rules in a file
During the run this tool will execute so called "Automated Transac-
During the run this tool will execute so called "Automated Transac-
tions" found in any journal it process. I.e instead of specifying this
operations in command line you can put them in a journal file.
@ -2514,7 +2528,7 @@ COMMANDS
budget:gifts *-1
assets:budget *1
Note that '=' (equality symbol) that is used instead of date in trans-
Note that '=' (equality symbol) that is used instead of date in trans-
actions you usually write. It indicates the query by which you want to
match the posting to add new ones.
@ -2527,12 +2541,12 @@ COMMANDS
--add-posting 'assets:budget *1' \
> rewritten-tidy-output.journal
It is important to understand that relative order of such entries in
journal is important. You can re-use result of previously added post-
It is important to understand that relative order of such entries in
journal is important. You can re-use result of previously added post-
ings.
Diff output format
To use this tool for batch modification of your journal files you may
To use this tool for batch modification of your journal files you may
find useful output in form of unified diff.
$ hledger rewrite -- --diff -f examples/sample.journal '^income' --add-posting '(liabilities:tax) *.33'
@ -2556,10 +2570,10 @@ COMMANDS
If you'll pass this through patch tool you'll get transactions contain-
ing the posting that matches your query be updated. Note that multiple
files might be update according to list of input files specified via
files might be update according to list of input files specified via
--file options and include directives inside of these files.
Be careful. Whole transaction being re-formatted in a style of output
Be careful. Whole transaction being re-formatted in a style of output
from hledger print.
See also:
@ -2567,48 +2581,48 @@ COMMANDS
https://github.com/simonmichael/hledger/issues/99
rewrite vs. print --auto
This command predates print --auto, and currently does much the same
This command predates print --auto, and currently does much the same
thing, but with these differences:
o with multiple files, rewrite lets rules in any file affect all other
files. print --auto uses standard directive scoping; rules affect
o with multiple files, rewrite lets rules in any file affect all other
files. print --auto uses standard directive scoping; rules affect
only child files.
o rewrite's query limits which transactions can be rewritten; all are
o rewrite's query limits which transactions can be rewritten; all are
printed. print --auto's query limits which transactions are printed.
o rewrite applies rules specified on command line or in the journal.
o rewrite applies rules specified on command line or in the journal.
print --auto applies rules specified in the journal.
roi
roi
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.
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
these investments you offset unrealized profit and loss into account(s)
that, again, hold nothing but unrealized profit and loss.
Any transactions affecting balance of investment account(s) and not
originating from unrealized profit and loss account(s) are assumed to
Any transactions affecting balance of investment account(s) and not
originating from unrealized profit and loss account(s) are assumed to
be your investments or withdrawals.
At a minimum, you need to supply a query (which could be just an ac-
At a minimum, you need to supply a query (which could be just an ac-
count name) to select your investments with --inv, and another query to
identify your profit and loss transactions with --pnl.
It will compute and display the internalized rate of return (IRR) and
time-weighted rate of return (TWR) for your investments for the time
period requested. Both rates of return are annualized before display,
It will compute and display the internalized rate of return (IRR) and
time-weighted rate of return (TWR) for your investments for the time
period requested. Both rates of return are annualized before display,
regardless of the length of reporting interval.
stats
stats
Show some journal statistics.
The stats command displays summary information for the whole journal,
or a matched part of it. With a reporting interval, it shows a report
The stats command displays summary information for the whole journal,
or a matched part of it. With a reporting interval, it shows a report
for each report period.
Example:
@ -2626,14 +2640,14 @@ COMMANDS
Commodities : 1 ($)
Market prices : 12 ($)
This command also supports output destination and output format selec-
This command also supports output destination and output format selec-
tion.
tags
tags
List all the tag names used in the journal. With a TAGREGEX argument,
only tag names matching the regular expression (case insensitive) are
shown. With QUERY arguments, only transactions matching the query are
List all the tag names used in the journal. With a TAGREGEX argument,
only tag names matching the regular expression (case insensitive) are
shown. With QUERY arguments, only transactions matching the query are
considered. With --values flag, the tags' unique values are listed in-
stead.
@ -2641,13 +2655,13 @@ COMMANDS
test
Run built-in unit tests.
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
This command runs the unit tests built in to hledger and hledger-lib,
printing the results on stdout. If any test fails, the exit code will
be non-zero.
This is mainly used by hledger developers, but you can also use it to
sanity-check the installed hledger executable on your platform. All
tests are expected to pass - if you ever see a failure, please report
This is mainly used by hledger developers, but you can also use it to
sanity-check the installed hledger executable on your platform. All
tests are expected to pass - if you ever see a failure, please report
as a bug!
This command also accepts tasty test runner options, written after a --
@ -2656,32 +2670,32 @@ COMMANDS
$ hledger test -- -pData.Amount --color=never
For help on these, see https://github.com/feuerbach/tasty#options (--
For help on these, see https://github.com/feuerbach/tasty#options (--
--help currently doesn't show them).
ADD-ON COMMANDS
hledger also searches for external add-on commands, and will include
hledger also searches for external add-on commands, and will include
these in the commands list. These are programs or scripts in your PATH
whose name starts with hledger- and ends with a recognised file exten-
whose name starts with hledger- and ends with a recognised file exten-
sion (currently: no extension, bat,com,exe, hs,lhs,pl,py,rb,rkt,sh).
Add-ons can be invoked like any hledger command, but there are a few
Add-ons can be invoked like any hledger command, but there are a few
things to be aware of. Eg if the hledger-web add-on is installed,
o hledger -h web shows hledger's help, while hledger web -h shows
o hledger -h web shows hledger's help, while hledger web -h shows
hledger-web's help.
o Flags specific to the add-on must have a preceding -- to hide them
from hledger. So hledger web --serve --port 9000 will be rejected;
o Flags specific to the add-on must have a preceding -- to hide them
from hledger. So hledger web --serve --port 9000 will be rejected;
you must use hledger web -- --serve --port 9000.
o You can always run add-ons directly if preferred: hledger-web --serve
--port 9000.
Add-ons are a relatively easy way to add local features or experiment
with new ideas. They can be written in any language, but haskell
scripts have a big advantage: they can use the same hledger (and
haskell) library functions that built-in commands do, for command-line
Add-ons are a relatively easy way to add local features or experiment
with new ideas. They can be written in any language, but haskell
scripts have a big advantage: they can use the same hledger (and
haskell) library functions that built-in commands do, for command-line
options, journal parsing, reporting, etc.
Here are some hledger add-ons available:
@ -2696,7 +2710,7 @@ ADD-ON COMMANDS
hledger-web provides a simple web interface.
Third party add-ons
These are maintained separately, and usually updated shortly after a
These are maintained separately, and usually updated shortly after a
hledger release.
iadd
@ -2708,35 +2722,35 @@ ADD-ON COMMANDS
ing to various schemes.
Experimental add-ons
These are available in source form in the hledger repo's bin/ direc-
tory. They may be less mature and documented than built-in commands.
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.
Reading and tweaking these is a good way to start making your own!
autosync
hledger-autosync is a symbolic link for easily running ledger-autosync,
if installed. ledger-autosync does deduplicating conversion of OFX
data and some CSV formats, and can also download the data if your bank
if installed. ledger-autosync does deduplicating conversion of OFX
data and some CSV formats, and can also download the data if your bank
offers OFX Direct Connect.
chart
hledger-chart.hs is an old very basic pie chart generator.
ENVIRONMENT
COLUMNS The screen width used by the register command. Default: the
COLUMNS The screen width used by the register command. Default: the
full terminal width.
LEDGER_FILE The journal file path when not specified with -f. Default:
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour-
nal).
FILES
Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps
Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal).
LIMITATIONS
The need to precede addon command options with -- when invoked from
The need to precede addon command options with -- when invoked from
hledger is awkward.
When input data contains non-ascii characters, a suitable system locale
@ -2752,33 +2766,33 @@ LIMITATIONS
In a Cygwin/MSYS/Mintty window, the tab key is not supported in hledger
add.
Not all of Ledger's journal file syntax is supported. See file format
Not all of Ledger's journal file syntax is supported. See file format
differences.
On large data files, hledger is slower and uses more memory than
On large data files, hledger is slower and uses more memory than
Ledger.
TROUBLESHOOTING
Here are some issues you might encounter when you run hledger (and re-
member you can also seek help from the IRC channel, mail list or bug
Here are some issues you might encounter when you run hledger (and re-
member you can also seek help from the IRC channel, mail list or bug
tracker):
Successfully installed, but "No command 'hledger' found"
stack and cabal install binaries into a special directory, which should
be added to your PATH environment variable. Eg on unix-like systems,
be added to your PATH environment variable. Eg on unix-like systems,
that is ~/.local/bin and ~/.cabal/bin respectively.
I set a custom LEDGER_FILE, but hledger is still using the default file
LEDGER_FILE should be a real environment variable, not just a shell
variable. The command env | grep LEDGER_FILE should show it. You may
LEDGER_FILE should be a real environment variable, not just a shell
variable. The command env | grep LEDGER_FILE should show it. You may
need to use export. Here's an explanation.
"Illegal byte sequence" or "Invalid or incomplete multibyte or wide
"Illegal byte sequence" or "Invalid or incomplete multibyte or wide
character" errors
In order to handle non-ascii letters and symbols (like ), hledger needs
an appropriate locale. This is usually configured system-wide; you can
also configure it temporarily. The locale may need to be one that sup-
ports UTF-8, if you built hledger with GHC < 7.2 (or possibly always,
ports UTF-8, if you built hledger with GHC < 7.2 (or possibly always,
I'm not sure yet).
Here's an example of setting the locale temporarily, on ubuntu
@ -2797,7 +2811,7 @@ TROUBLESHOOTING
$ echo "export LANG=en_US.UTF-8" >>~/.bash_profile
$ bash --login
If we preferred to use eg fr_FR.utf8, we might have to install that
If we preferred to use eg fr_FR.utf8, we might have to install that
first:
$ apt-get install language-pack-fr
@ -2818,7 +2832,7 @@ TROUBLESHOOTING
REPORTING BUGS
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
or hledger mail list)
@ -2832,7 +2846,7 @@ COPYRIGHT
SEE ALSO
hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1),
hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1),
hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time-
dot(5), ledger(1)