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

;doc: regen manuals

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2020-01-22 15:22:56 -08:00
parent 5ba3cc6f42
commit b4ced3188e
4 changed files with 289 additions and 293 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -7,22 +7,21 @@ revenues/expenses to retained earnings at the end of a period.
_FLAGS _FLAGS
You can print just one of these transactions by using the --opening or You can print just one of these transactions by using the --close or
--closing flag. --open flag. You can customise their descriptions with the --close-desc
and --open-desc options.
One amountless posting to equity:opening/closing balances is added to One amountless posting to "equity:opening/closing balances" is added to
balance the transactions, by default. You can customise this account balance the transactions, by default. You can customise this account
name with the --close-to and --open-from options. (If you specify only name with --close-acct and --open-acct; if you specify only one of
one, it is used for both.) Similarly, you can customise the transaction these, it will be used for both.
descriptions with --close-desc and --open-desc.
With --x/--explicit, the equity posting's amount will be shown. And if With --x/--explicit, the equity posting's amount will be shown. And if
it involves multiple commodities, a posting for each commodity will be it involves multiple commodities, a posting for each commodity will be
shown (as with the print command). shown, as with the print command.
With --interleaved, the equity postings are shown next to the postings With --interleaved, the equity postings are shown next to the postings
they balance, which makes troubleshooting easier. (It can also generate they balance, which makes troubleshooting easier.
more postings.)
By default, transaction prices in the journal are ignored when By default, transaction prices in the journal are ignored when
generating the closing/opening transactions. With --show-costs, this generating the closing/opening transactions. With --show-costs, this
@ -70,8 +69,8 @@ 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! which would wipe your journal!
$ hledger close -f 2018.journal -e 2019 assets liabilities --opening >>2019.journal $ hledger close -f 2018.journal -e 2019 assets liabilities --open >>2019.journal
$ hledger close -f 2018.journal -e 2019 assets liabilities --closing >>2018.journal $ hledger close -f 2018.journal -e 2019 assets liabilities --close >>2018.journal
Now: Now:

21
hledger/hledger.1
View File

@ -2715,24 +2715,23 @@ balances forward into a new journal file, or to close out
revenues/expenses to retained earnings at the end of a period. revenues/expenses to retained earnings at the end of a period.
.PP .PP
You can print just one of these transactions by using the You can print just one of these transactions by using the
\f[C]--opening\f[R] or \f[C]--closing\f[R] flag. \f[C]--close\f[R] or \f[C]--open\f[R] flag.
You can customise their descriptions with the \f[C]--close-desc\f[R] and
\f[C]--open-desc\f[R] options.
.PP .PP
One amountless posting to \f[C]equity:opening/closing balances\f[R] is One amountless posting to \[dq]equity:opening/closing balances\[dq] is
added to balance the transactions, by default. added to balance the transactions, by default.
You can customise this account name with the \f[C]--close-to\f[R] and You can customise this account name with \f[C]--close-acct\f[R] and
\f[C]--open-from\f[R] options. \f[C]--open-acct\f[R]; if you specify only one of these, it will be used
(If you specify only one, it is used for both.) Similarly, you can for both.
customise the transaction descriptions with \f[C]--close-desc\f[R] and
\f[C]--open-desc\f[R].
.PP .PP
With \f[C]--x/--explicit\f[R], the equity posting\[aq]s amount will be With \f[C]--x/--explicit\f[R], the equity posting\[aq]s amount will be
shown. shown.
And if it involves multiple commodities, a posting for each commodity And if it involves multiple commodities, a posting for each commodity
will be shown (as with the print command). will be shown, as with the print command.
.PP .PP
With \f[C]--interleaved\f[R], the equity postings are shown next to the With \f[C]--interleaved\f[R], the equity postings are shown next to the
postings they balance, which makes troubleshooting easier. postings they balance, which makes troubleshooting easier.
(It can also generate more postings.)
.PP .PP
By default, transaction prices in the journal are ignored when By default, transaction prices in the journal are ignored when
generating the closing/opening transactions. generating the closing/opening transactions.
@ -2789,8 +2788,8 @@ type a single \f[CI]>\f[I] which would wipe your journal!\f[R]
.IP .IP
.nf .nf
\f[C] \f[C]
$ hledger close -f 2018.journal -e 2019 assets liabilities --opening >>2019.journal $ hledger close -f 2018.journal -e 2019 assets liabilities --open >>2019.journal
$ hledger close -f 2018.journal -e 2019 assets liabilities --closing >>2018.journal $ hledger close -f 2018.journal -e 2019 assets liabilities --close >>2018.journal
\f[R] \f[R]
.fi .fi
.PP .PP

161
hledger/hledger.info
View File

@ -2213,22 +2213,21 @@ These can be added to your journal file(s), eg to bring asset/liability
balances forward into a new journal file, or to close out balances forward into a new journal file, or to close out
revenues/expenses to retained earnings at the end of a period. revenues/expenses to retained earnings at the end of a period.
You can print just one of these transactions by using the '--opening' You can print just one of these transactions by using the '--close'
or '--closing' flag. or '--open' flag. You can customise their descriptions with the
'--close-desc' and '--open-desc' options.
One amountless posting to 'equity:opening/closing balances' is added One amountless posting to "equity:opening/closing balances" is added
to balance the transactions, by default. You can customise this account to balance the transactions, by default. You can customise this account
name with the '--close-to' and '--open-from' options. (If you specify name with '--close-acct' and '--open-acct'; if you specify only one of
only one, it is used for both.) Similarly, you can customise the these, it will be used for both.
transaction descriptions with '--close-desc' and '--open-desc'.
With '--x/--explicit', the equity posting's amount will be shown. With '--x/--explicit', the equity posting's amount will be shown.
And if it involves multiple commodities, a posting for each commodity And if it involves multiple commodities, a posting for each commodity
will be shown (as with the print command). will be shown, as with the print command.
With '--interleaved', the equity postings are shown next to the With '--interleaved', the equity postings are shown next to the
postings they balance, which makes troubleshooting easier. (It can also postings they balance, which makes troubleshooting easier.
generate more postings.)
By default, transaction prices in the journal are ignored when By default, transaction prices in the journal are ignored when
generating the closing/opening transactions. With '--show-costs', this generating the closing/opening transactions. With '--show-costs', this
@ -2286,8 +2285,8 @@ 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!_ '>' which would wipe your journal!_
$ hledger close -f 2018.journal -e 2019 assets liabilities --opening >>2019.journal $ hledger close -f 2018.journal -e 2019 assets liabilities --open >>2019.journal
$ hledger close -f 2018.journal -e 2019 assets liabilities --closing >>2018.journal $ hledger close -f 2018.journal -e 2019 assets liabilities --close >>2018.journal
Now: Now:
@ -3320,76 +3319,76 @@ Node: check-dupes76317
Ref: #check-dupes76441 Ref: #check-dupes76441
Node: close76734 Node: close76734
Ref: #close76848 Ref: #close76848
Node: close usage78430 Node: close usage78377
Ref: #close-usage78523 Ref: #close-usage78470
Node: commodities81368 Node: commodities81310
Ref: #commodities81495 Ref: #commodities81437
Node: descriptions81577 Node: descriptions81519
Ref: #descriptions81705 Ref: #descriptions81647
Node: diff81886 Node: diff81828
Ref: #diff81992 Ref: #diff81934
Node: files83039 Node: files82981
Ref: #files83139 Ref: #files83081
Node: help83286 Node: help83228
Ref: #help83386 Ref: #help83328
Node: import84467 Node: import84409
Ref: #import84581 Ref: #import84523
Node: Importing balance assignments85474 Node: Importing balance assignments85416
Ref: #importing-balance-assignments85622 Ref: #importing-balance-assignments85564
Node: incomestatement86271 Node: incomestatement86213
Ref: #incomestatement86404 Ref: #incomestatement86346
Node: notes87808 Node: notes87750
Ref: #notes87921 Ref: #notes87863
Node: payees88047 Node: payees87989
Ref: #payees88153 Ref: #payees88095
Node: prices88311 Node: prices88253
Ref: #prices88417 Ref: #prices88359
Node: print88758 Node: print88700
Ref: #print88868 Ref: #print88810
Node: print-unique93512 Node: print-unique93454
Ref: #print-unique93638 Ref: #print-unique93580
Node: register93923 Node: register93865
Ref: #register94050 Ref: #register93992
Node: Custom register output98222 Node: Custom register output98164
Ref: #custom-register-output98351 Ref: #custom-register-output98293
Node: register-match99613 Node: register-match99555
Ref: #register-match99747 Ref: #register-match99689
Node: rewrite100098 Node: rewrite100040
Ref: #rewrite100213 Ref: #rewrite100155
Node: Re-write rules in a file102068 Node: Re-write rules in a file102010
Ref: #re-write-rules-in-a-file102202 Ref: #re-write-rules-in-a-file102144
Node: Diff output format103412 Node: Diff output format103354
Ref: #diff-output-format103581 Ref: #diff-output-format103523
Node: rewrite vs print --auto104673 Node: rewrite vs print --auto104615
Ref: #rewrite-vs.-print---auto104852 Ref: #rewrite-vs.-print---auto104794
Node: roi105408 Node: roi105350
Ref: #roi105506 Ref: #roi105448
Node: stats106518 Node: stats106460
Ref: #stats106617 Ref: #stats106559
Node: tags107405 Node: tags107347
Ref: #tags107503 Ref: #tags107445
Node: test107797 Node: test107739
Ref: #test107881 Ref: #test107823
Node: ADD-ON COMMANDS108628 Node: ADD-ON COMMANDS108570
Ref: #add-on-commands108738 Ref: #add-on-commands108680
Node: Official add-ons110026 Node: Official add-ons109968
Ref: #official-add-ons110166 Ref: #official-add-ons110108
Node: ui110246 Node: ui110188
Ref: #ui110333 Ref: #ui110275
Node: web110387 Node: web110329
Ref: #web110476 Ref: #web110418
Node: Third party add-ons110522 Node: Third party add-ons110464
Ref: #third-party-add-ons110697 Ref: #third-party-add-ons110639
Node: iadd110816 Node: iadd110758
Ref: #iadd110917 Ref: #iadd110859
Node: interest110999 Node: interest110941
Ref: #interest111108 Ref: #interest111050
Node: Experimental add-ons111203 Node: Experimental add-ons111145
Ref: #experimental-add-ons111355 Ref: #experimental-add-ons111297
Node: autosync111593 Node: autosync111535
Ref: #autosync111704 Ref: #autosync111646
Node: chart111943 Node: chart111885
Ref: #chart112048 Ref: #chart111990
 
End Tag Table End Tag Table

21
hledger/hledger.txt
View File

@ -1949,22 +1949,21 @@ COMMANDS
balances forward into a new journal file, or to close out revenues/ex- balances forward into a new journal file, or to close out revenues/ex-
penses to retained earnings at the end of a period. penses to retained earnings at the end of a period.
You can print just one of these transactions by using the --opening or You can print just one of these transactions by using the --close or
--closing flag. --open flag. You can customise their descriptions with the --close-
desc and --open-desc options.
One amountless posting to equity:opening/closing balances is added to One amountless posting to "equity:opening/closing balances" is added to
balance the transactions, by default. You can customise this account balance the transactions, by default. You can customise this account
name with the --close-to and --open-from options. (If you specify only name with --close-acct and --open-acct; if you specify only one of
one, it is used for both.) Similarly, you can customise the transaction these, it will be used for both.
descriptions with --close-desc and --open-desc.
With --x/--explicit, the equity posting's amount will be shown. And if With --x/--explicit, the equity posting's amount will be shown. And if
it involves multiple commodities, a posting for each commodity will be it involves multiple commodities, a posting for each commodity will be
shown (as with the print command). shown, as with the print command.
With --interleaved, the equity postings are shown next to the postings With --interleaved, the equity postings are shown next to the postings
they balance, which makes troubleshooting easier. (It can also gener- they balance, which makes troubleshooting easier.
ate more postings.)
By default, transaction prices in the journal are ignored when generat- By default, transaction prices in the journal are ignored when generat-
ing the closing/opening transactions. With --show-costs, this cost in- ing the closing/opening transactions. With --show-costs, this cost in-
@ -2012,8 +2011,8 @@ COMMANDS
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! which would wipe your journal!
$ hledger close -f 2018.journal -e 2019 assets liabilities --opening >>2019.journal $ hledger close -f 2018.journal -e 2019 assets liabilities --open >>2019.journal
$ hledger close -f 2018.journal -e 2019 assets liabilities --closing >>2018.journal $ hledger close -f 2018.journal -e 2019 assets liabilities --close >>2018.journal
Now: Now: