;doc: regen manuals

[ci skip]
This commit is contained in:
Simon Michael 2020-01-22 14:41:08 -08:00
parent 72d0190d1d
commit f14ae7df3a
4 changed files with 283 additions and 288 deletions

View File

@ -7,20 +7,19 @@ revenues/expenses to retained earnings at the end of a period.
_FLAGS _FLAGS
You can choose to print just one of these transactions by using the You can print just one of these transactions by using the --opening or
--opening or --closing flag. --closing flag.
One posting to equity:opening/closing balances, with an implicit amount, One amountless posting to equity:opening/closing balances is added to
is added to balance the transactions, by default. balance the transactions, by default.
You can customise this account name with the --close-to and --open-from You can customise this account name with the --close-to and --open-from
options. (If you specify only one, it is used in both transactions.) options. If you specify only one, it is used for both. Similarly, you
can customise the transaction descriptions with --close-desc and
--open-desc.
Similarly, you can customise the transaction descriptions with With --x/--explicit, the equity posting's amount will be shown. And if
--close-desc and --open-desc. it involves multiple commodities, a posting for each commodity will be
With --x/--explicit, the equity posting's amount will be shown. If 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

View File

@ -2714,23 +2714,22 @@ 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.
.PP .PP
You can choose to 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]--opening\f[R] or \f[C]--closing\f[R] flag.
.PP .PP
One posting to \f[C]equity:opening/closing balances\f[R], with an One amountless posting to \f[C]equity:opening/closing balances\f[R] is
implicit amount, is added to balance the transactions, by default. added to balance the transactions, by default.
.PP .PP
You can customise this account name with the \f[C]--close-to\f[R] and You can customise this account name with the \f[C]--close-to\f[R] and
\f[C]--open-from\f[R] options. \f[C]--open-from\f[R] options.
(If you specify only one, it is used in both transactions.) If you specify only one, it is used for both.
.PP
Similarly, you can customise the transaction descriptions with Similarly, you can customise the transaction descriptions with
\f[C]--close-desc\f[R] and \f[C]--open-desc\f[R]. \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.
If it involves multiple commodities, a posting for each commodity will And if it involves multiple commodities, a posting for each commodity
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.

View File

@ -2213,22 +2213,20 @@ 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 choose to print just one of these transactions by using the You can print just one of these transactions by using the '--opening'
'--opening' or '--closing' flag. or '--closing' flag.
One posting to 'equity:opening/closing balances', with an implicit One amountless posting to 'equity:opening/closing balances' is added
amount, is added to balance the transactions, by default. to balance the transactions, by default.
You can customise this account name with the '--close-to' and You can customise this account name with the '--close-to' and
'--open-from' options. (If you specify only one, it is used in both '--open-from' options. If you specify only one, it is used for both.
transactions.)
Similarly, you can customise the transaction descriptions with Similarly, you can customise the transaction descriptions with
'--close-desc' and '--open-desc'. '--close-desc' and '--open-desc'.
With '--x/--explicit', the equity posting's amount will be shown. If With '--x/--explicit', the equity posting's amount will be shown.
it involves multiple commodities, a posting for each commodity will be And if it involves multiple commodities, a posting for each commodity
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. (It can also
@ -3324,76 +3322,76 @@ Node: check-dupes76317
Ref: #check-dupes76441 Ref: #check-dupes76441
Node: close76734 Node: close76734
Ref: #close76848 Ref: #close76848
Node: close usage78470 Node: close usage78430
Ref: #close-usage78563 Ref: #close-usage78523
Node: commodities81408 Node: commodities81368
Ref: #commodities81535 Ref: #commodities81495
Node: descriptions81617 Node: descriptions81577
Ref: #descriptions81745 Ref: #descriptions81705
Node: diff81926 Node: diff81886
Ref: #diff82032 Ref: #diff81992
Node: files83079 Node: files83039
Ref: #files83179 Ref: #files83139
Node: help83326 Node: help83286
Ref: #help83426 Ref: #help83386
Node: import84507 Node: import84467
Ref: #import84621 Ref: #import84581
Node: Importing balance assignments85514 Node: Importing balance assignments85474
Ref: #importing-balance-assignments85662 Ref: #importing-balance-assignments85622
Node: incomestatement86311 Node: incomestatement86271
Ref: #incomestatement86444 Ref: #incomestatement86404
Node: notes87848 Node: notes87808
Ref: #notes87961 Ref: #notes87921
Node: payees88087 Node: payees88047
Ref: #payees88193 Ref: #payees88153
Node: prices88351 Node: prices88311
Ref: #prices88457 Ref: #prices88417
Node: print88798 Node: print88758
Ref: #print88908 Ref: #print88868
Node: print-unique93552 Node: print-unique93512
Ref: #print-unique93678 Ref: #print-unique93638
Node: register93963 Node: register93923
Ref: #register94090 Ref: #register94050
Node: Custom register output98262 Node: Custom register output98222
Ref: #custom-register-output98391 Ref: #custom-register-output98351
Node: register-match99653 Node: register-match99613
Ref: #register-match99787 Ref: #register-match99747
Node: rewrite100138 Node: rewrite100098
Ref: #rewrite100253 Ref: #rewrite100213
Node: Re-write rules in a file102108 Node: Re-write rules in a file102068
Ref: #re-write-rules-in-a-file102242 Ref: #re-write-rules-in-a-file102202
Node: Diff output format103452 Node: Diff output format103412
Ref: #diff-output-format103621 Ref: #diff-output-format103581
Node: rewrite vs print --auto104713 Node: rewrite vs print --auto104673
Ref: #rewrite-vs.-print---auto104892 Ref: #rewrite-vs.-print---auto104852
Node: roi105448 Node: roi105408
Ref: #roi105546 Ref: #roi105506
Node: stats106558 Node: stats106518
Ref: #stats106657 Ref: #stats106617
Node: tags107445 Node: tags107405
Ref: #tags107543 Ref: #tags107503
Node: test107837 Node: test107797
Ref: #test107921 Ref: #test107881
Node: ADD-ON COMMANDS108668 Node: ADD-ON COMMANDS108628
Ref: #add-on-commands108778 Ref: #add-on-commands108738
Node: Official add-ons110066 Node: Official add-ons110026
Ref: #official-add-ons110206 Ref: #official-add-ons110166
Node: ui110286 Node: ui110246
Ref: #ui110373 Ref: #ui110333
Node: web110427 Node: web110387
Ref: #web110516 Ref: #web110476
Node: Third party add-ons110562 Node: Third party add-ons110522
Ref: #third-party-add-ons110737 Ref: #third-party-add-ons110697
Node: iadd110856 Node: iadd110816
Ref: #iadd110957 Ref: #iadd110917
Node: interest111039 Node: interest110999
Ref: #interest111148 Ref: #interest111108
Node: Experimental add-ons111243 Node: Experimental add-ons111203
Ref: #experimental-add-ons111395 Ref: #experimental-add-ons111355
Node: autosync111633 Node: autosync111593
Ref: #autosync111744 Ref: #autosync111704
Node: chart111983 Node: chart111943
Ref: #chart112088 Ref: #chart112048
 
End Tag Table End Tag Table

View File

@ -1949,20 +1949,19 @@ 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 choose to print just one of these transactions by using the You can print just one of these transactions by using the --opening or
--opening or --closing flag. --closing flag.
One posting to equity:opening/closing balances, with an implicit One amountless posting to equity:opening/closing balances is added to
amount, is added to balance the transactions, by default. balance the transactions, by default.
You can customise this account name with the --close-to and --open-from You can customise this account name with the --close-to and --open-from
options. (If you specify only one, it is used in both transactions.) options. If you specify only one, it is used for both. Similarly, you
can customise the transaction descriptions with --close-desc and
--open-desc.
Similarly, you can customise the transaction descriptions with --close- With --x/--explicit, the equity posting's amount will be shown. And if
desc and --open-desc. it involves multiple commodities, a posting for each commodity will be
With --x/--explicit, the equity posting's amount will be shown. If 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