;doc: regen manuals
[ci skip]
This commit is contained in:
Simon Michael
parent
7500002ee5
commit
9710c86c7f
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -1949,16 +1949,34 @@ 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
|
||||
@ -1989,10 +2007,6 @@ COMMANDS
|
||||
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
|
||||
|
||||
Loading…
Reference in New Issue
Block a user