;doc: regen manuals

[ci skip]

hledger/Hledger/Cli/Commands/Close.txt

@@ -1,31 +1,31 @@
 close, equity
 Prints a "closing balances" transaction and an "opening balances"
 transaction that bring account balances to and from zero, respectively.
-Useful for bringing asset/liability balances forward into a new journal
+These can be added to your journal file(s), eg to bring asset/liability
-file, or for closing out revenues/expenses to retained earnings at the
+balances forward into a new journal file, or to close out
-end of a period.
+revenues/expenses to retained earnings at the end of a period.
 
 _FLAGS
 
-You can choose to print just one of the transactions by using the
+You can choose to print just one of these transactions by using the
 --opening or --closing flag.
 
-The closing transaction transfers balances to equity:closing balances,
+One posting to equity:opening/closing balances, with an implicit amount,
-and the opening transaction transfers balances from
+is added to balance the transactions, by default.
-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
+You can customise this account name with the --close-to and --open-from
-these journal entries, with the amount left implicit.
+options. (If you specify only one, it is used in both transactions.)
 
-With --x/--explicit, the balancing amount is shown, and if multiple
+Similarly, you can customise the transaction descriptions with
-commodities are involved, multiple single-commodity equity postings are
+--close-desc and --open-desc.
-shown (like the print command).
 
-With --interleaved, the equity postings are shown next to each posting
+With --x/--explicit, the equity posting's amount will be shown. If it
-they balance, which can be better for troubleshooting (and can generate
+involves multiple commodities, a posting for each commodity will be
-more postings).
+shown (as with the print command).
+
+With --interleaved, the equity postings are shown next to the postings
+they balance, which makes troubleshooting easier. (It can also generate
+more postings.)
 
 By default, transaction prices in the journal are ignored when
 generating the closing/opening transactions. With --show-costs, this

hledger/hledger.1

@@ -2710,30 +2710,31 @@ close, equity
 Prints a \[dq]closing balances\[dq] transaction and an \[dq]opening
 balances\[dq] transaction that bring account balances to and from zero,
 respectively.
-Useful for bringing asset/liability balances forward into a new journal
+These can be added to your journal file(s), eg to bring asset/liability
-file, or for closing out revenues/expenses to retained earnings at the
+balances forward into a new journal file, or to close out
-end of a period.
+revenues/expenses to retained earnings at the end of a period.
 .PP
-You can choose to print just one of the transactions by using the
+You can choose to print just one of these transactions by using the
 \f[C]--opening\f[R] or \f[C]--closing\f[R] flag.
 .PP
-The closing transaction transfers balances to
+One posting to \f[C]equity:opening/closing balances\f[R], with an
-\f[C]equity:closing balances\f[R], and the opening transaction transfers
+implicit amount, is added to balance the transactions, by default.
-balances from \f[C]equity:opening balances\f[R], by default.
+.PP
-You can choose different account names 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.
-If you specify only one of these, it is used for both.
+(If you specify only one, it is used in both transactions.)
 .PP
-By default, a single balancing equity posting is added at the end of
+Similarly, you can customise the transaction descriptions with
-these journal entries, with the amount left implicit.
+\f[C]--close-desc\f[R] and \f[C]--open-desc\f[R].
 .PP
-With \f[C]--x/--explicit\f[R], the balancing amount is shown, and if
+With \f[C]--x/--explicit\f[R], the equity posting\[aq]s amount will be
-multiple commodities are involved, multiple single-commodity equity
+shown.
-postings are shown (like the print command).
+If it involves multiple commodities, a posting for each commodity will
+be shown (as with the print command).
 .PP
-With \f[C]--interleaved\f[R], the equity postings are shown next to each
+With \f[C]--interleaved\f[R], the equity postings are shown next to the
-posting they balance, which can be better for troubleshooting (and can
+postings they balance, which makes troubleshooting easier.
-generate more postings).
+(It can also generate more postings.)
 .PP
 By default, transaction prices in the journal are ignored when
 generating the closing/opening transactions.

hledger/hledger.info

@@ -2209,29 +2209,30 @@ File: hledger.info,  Node: close,  Next: commodities,  Prev: check-dupes,  Up: C
 close, equity
 Prints a "closing balances" transaction and an "opening balances"
 transaction that bring account balances to and from zero, respectively.
-Useful for bringing asset/liability balances forward into a new journal
+These can be added to your journal file(s), eg to bring asset/liability
-file, or for closing out revenues/expenses to retained earnings at the
+balances forward into a new journal file, or to close out
-end of a period.
+revenues/expenses to retained earnings at the end of a period.
 
-   You can choose to print just one of the transactions by using the
+   You can choose to print just one of these transactions by using the
 '--opening' or '--closing' flag.
 
-   The closing transaction transfers balances to 'equity:closing
+   One posting to 'equity:opening/closing balances', with an implicit
-balances', and the opening transaction transfers balances from
+amount, is added to balance the transactions, by default.
-'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
+   You can customise this account name with the '--close-to' and
-these journal entries, with the amount left implicit.
+'--open-from' options.  (If you specify only one, it is used in both
+transactions.)
 
-   With '--x/--explicit', the balancing amount is shown, and if multiple
+   Similarly, you can customise the transaction descriptions with
-commodities are involved, multiple single-commodity equity postings are
+'--close-desc' and '--open-desc'.
-shown (like the print command).
 
-   With '--interleaved', the equity postings are shown next to each
+   With '--x/--explicit', the equity posting's amount will be shown.  If
-posting they balance, which can be better for troubleshooting (and can
+it involves multiple commodities, a posting for each commodity will be
-generate more postings).
+shown (as with the print command).
+
+   With '--interleaved', the equity postings are shown next to the
+postings they balance, which makes troubleshooting easier.  (It can also
+generate more postings.)
 
    By default, transaction prices in the journal are ignored when
 generating the closing/opening transactions.  With '--show-costs', this
@@ -3323,76 +3324,76 @@ Node: check-dupes76317
 Ref: #check-dupes76441
 Node: close76734
 Ref: #close76848
-Node: close usage78492
+Node: close usage78470
-Ref: #close-usage78585
+Ref: #close-usage78563
-Node: commodities81430
+Node: commodities81408
-Ref: #commodities81557
+Ref: #commodities81535
-Node: descriptions81639
+Node: descriptions81617
-Ref: #descriptions81767
+Ref: #descriptions81745
-Node: diff81948
+Node: diff81926
-Ref: #diff82054
+Ref: #diff82032
-Node: files83101
+Node: files83079
-Ref: #files83201
+Ref: #files83179
-Node: help83348
+Node: help83326
-Ref: #help83448
+Ref: #help83426
-Node: import84529
+Node: import84507
-Ref: #import84643
+Ref: #import84621
-Node: Importing balance assignments85536
+Node: Importing balance assignments85514
-Ref: #importing-balance-assignments85684
+Ref: #importing-balance-assignments85662
-Node: incomestatement86333
+Node: incomestatement86311
-Ref: #incomestatement86466
+Ref: #incomestatement86444
-Node: notes87870
+Node: notes87848
-Ref: #notes87983
+Ref: #notes87961
-Node: payees88109
+Node: payees88087
-Ref: #payees88215
+Ref: #payees88193
-Node: prices88373
+Node: prices88351
-Ref: #prices88479
+Ref: #prices88457
-Node: print88820
+Node: print88798
-Ref: #print88930
+Ref: #print88908
-Node: print-unique93574
+Node: print-unique93552
-Ref: #print-unique93700
+Ref: #print-unique93678
-Node: register93985
+Node: register93963
-Ref: #register94112
+Ref: #register94090
-Node: Custom register output98284
+Node: Custom register output98262
-Ref: #custom-register-output98413
+Ref: #custom-register-output98391
-Node: register-match99675
+Node: register-match99653
-Ref: #register-match99809
+Ref: #register-match99787
-Node: rewrite100160
+Node: rewrite100138
-Ref: #rewrite100275
+Ref: #rewrite100253
-Node: Re-write rules in a file102130
+Node: Re-write rules in a file102108
-Ref: #re-write-rules-in-a-file102264
+Ref: #re-write-rules-in-a-file102242
-Node: Diff output format103474
+Node: Diff output format103452
-Ref: #diff-output-format103643
+Ref: #diff-output-format103621
-Node: rewrite vs print --auto104735
+Node: rewrite vs print --auto104713
-Ref: #rewrite-vs.-print---auto104914
+Ref: #rewrite-vs.-print---auto104892
-Node: roi105470
+Node: roi105448
-Ref: #roi105568
+Ref: #roi105546
-Node: stats106580
+Node: stats106558
-Ref: #stats106679
+Ref: #stats106657
-Node: tags107467
+Node: tags107445
-Ref: #tags107565
+Ref: #tags107543
-Node: test107859
+Node: test107837
-Ref: #test107943
+Ref: #test107921
-Node: ADD-ON COMMANDS108690
+Node: ADD-ON COMMANDS108668
-Ref: #add-on-commands108800
+Ref: #add-on-commands108778
-Node: Official add-ons110088
+Node: Official add-ons110066
-Ref: #official-add-ons110228
+Ref: #official-add-ons110206
-Node: ui110308
+Node: ui110286
-Ref: #ui110395
+Ref: #ui110373
-Node: web110449
+Node: web110427
-Ref: #web110538
+Ref: #web110516
-Node: Third party add-ons110584
+Node: Third party add-ons110562
-Ref: #third-party-add-ons110759
+Ref: #third-party-add-ons110737
-Node: iadd110878
+Node: iadd110856
-Ref: #iadd110979
+Ref: #iadd110957
-Node: interest111061
+Node: interest111039
-Ref: #interest111170
+Ref: #interest111148
-Node: Experimental add-ons111265
+Node: Experimental add-ons111243
-Ref: #experimental-add-ons111417
+Ref: #experimental-add-ons111395
-Node: autosync111655
+Node: autosync111633
-Ref: #autosync111766
+Ref: #autosync111744
-Node: chart112005
+Node: chart111983
-Ref: #chart112110
+Ref: #chart112088
 
 End Tag Table
 

hledger/hledger.txt

@@ -1945,29 +1945,29 @@ COMMANDS
        close, equity
        Prints a "closing  balances"  transaction  and  an  "opening  balances"
        transaction that bring account balances to and from zero, respectively.
-       Useful for bringing asset/liability balances forward into a new journal
+       These can be added to your journal file(s), eg to bring asset/liability
-       file,  or for closing out revenues/expenses to retained earnings at the
+       balances  forward into a new journal file, or to close out revenues/ex-
-       end of a period.
+       penses to retained earnings at the end of a period.
 
-       You can choose to print just one  of  the  transactions  by  using  the
+       You can choose to print just one of these  transactions  by  using  the
        --opening or --closing flag.
 
-       The  closing transaction transfers balances to equity:closing balances,
+       One  posting  to  equity:opening/closing  balances,  with  an  implicit
-       and the opening transaction transfers balances from equity:opening bal-
+       amount, is added to balance the transactions, by default.
-       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
+       You can customise this account name with the --close-to and --open-from
-       these journal entries, with the amount left implicit.
+       options.  (If you specify only one, it is used in both transactions.)
 
-       With --x/--explicit, the balancing amount is  shown,  and  if  multiple
+       Similarly, you can customise the transaction descriptions with --close-
-       commodities are involved, multiple single-commodity equity postings are
+       desc and --open-desc.
-       shown (like the print command).
 
-       With --interleaved, the equity postings are shown next to each  posting
+       With --x/--explicit, the equity posting's amount will be shown.  If  it
-       they balance, which can be better for troubleshooting (and can generate
+       involves  multiple  commodities,  a  posting for each commodity will be
-       more postings).
+       shown (as with the print command).
+
+       With --interleaved, the equity postings are shown next to the  postings
+       they  balance, which makes troubleshooting easier.  (It can also gener-
+       ate more postings.)
 
        By default, transaction prices in the journal are ignored when generat-
        ing the closing/opening transactions.  With --show-costs, this cost in-