regen manuals

[ci skip]
2019-02-26 10:13:50 -08:00 · 2019-02-26 10:13:50 -08:00 · a3ae68020f
commit a3ae68020f
parent 1c2bf7e784
4 changed files with 386 additions and 339 deletions
--- a/hledger/Hledger/Cli/Commands/Balance.txt
+++ b/hledger/Hledger/Cli/Commands/Balance.txt
@ -232,7 +232,7 @@ period (without -E, leading and trailing columns with all zeroes are not
 shown). Second, all accounts which existed at the report start date will
 be considered, not just the ones with activity during the report period
 (use -E to include low-activity accounts which would otherwise would be
-omitted). With --budget, --empty also shows unbudgeted accounts.
+omitted).

 The -T/--row-total flag adds an additional column showing the total for
 each row.
@ -320,13 +320,28 @@ Budget performance in 2017/11/01-2017/12/31:
 ----------------------++----------------------------------------------------
                      ||      0 [              0]       0 [              0] 

-By default, only accounts with budget goals during the report period are
-shown. In the example above, transactions in expenses:gifts and
-expenses:supplies are counted towards expenses budget, but accounts
-expenses:gifts and expenses:supplies are not shown, as they don't have
-any budgets.
+Note this is different from a normal balance report in several ways:

-You can use --empty shows unbudgeted accounts as well:
+-   Only accounts with budget goals during the report period are shown,
+    by default.
+
+-   In each column, in square brackets after the actual amount, budgeted
+    amounts are shown, along with the percentage of budget used.
+
+-   All parent accounts are always shown, even in flat mode. Eg assets,
+    assets:bank, and expenses above.
+
+-   Amounts always include all subaccounts, budgeted or unbudgeted, even
+    in flat mode.
+
+This means that the numbers displayed will not always add up! Eg above,
+the expenses actual amount includes the gifts and supplies transactions,
+but the expenses:gifts and expenses:supplies accounts are not shown, as
+they have no budget amounts declared.
+
+This can be confusing. When you need to make things clearer, use the
+-E/--empty flag, which will reveal all accounts including unbudgeted
+ones, giving the full picture. Eg:

 $ hledger balance -M --budget --empty
 Budget performance in 2017/11/01-2017/12/31:
@ -364,9 +379,6 @@ Budget performance in 2017/11/01-2017/12/31:
 ----------------------++----------------------------------------------------
                      ||      0 [              0]       0 [              0] 

-Note, the -S/--sort-amount flag is not yet fully supported with
--budget.
-
 For more examples, see Budgeting and Forecasting.

 Nested budgets
--- a/hledger/hledger.1
+++ b/hledger/hledger.1
@ -1783,8 +1783,6 @@ Second, all accounts which existed at the report start date will be
 considered, not just the ones with activity during the report period
 (use \-E to include low\-activity accounts which would otherwise would
 be omitted).
-With \f[C]\-\-budget\f[], \f[C]\-\-empty\f[] also shows unbudgeted
-accounts.
 .PP
 The \f[C]\-T/\-\-row\-total\f[] flag adds an additional column showing
 the total for each row.
@ -1884,14 +1882,31 @@ Budget\ performance\ in\ 2017/11/01\-2017/12/31:
 \f[]
 .fi
 .PP
-By default, only accounts with budget goals during the report period are
-shown.
-In the example above, transactions in \f[C]expenses:gifts\f[] and
-\f[C]expenses:supplies\f[] are counted towards \f[C]expenses\f[] budget,
-but accounts \f[C]expenses:gifts\f[] and \f[C]expenses:supplies\f[] are
-not shown, as they don\[aq]t have any budgets.
+Note this is different from a normal balance report in several ways:
+.IP \[bu] 2
+Only accounts with budget goals during the report period are shown, by
+default.
+.IP \[bu] 2
+In each column, in square brackets after the actual amount, budgeted
+amounts are shown, along with the percentage of budget used.
+.IP \[bu] 2
+All parent accounts are always shown, even in flat mode.
+Eg assets, assets:bank, and expenses above.
+.IP \[bu] 2
+Amounts always include all subaccounts, budgeted or unbudgeted, even in
+flat mode.
 .PP
-You can use \f[C]\-\-empty\f[] shows unbudgeted accounts as well:
+This means that the numbers displayed will not always add up! Eg above,
+the \f[C]expenses\f[] actual amount includes the gifts and supplies
+transactions, but the \f[C]expenses:gifts\f[] and
+\f[C]expenses:supplies\f[] accounts are not shown, as they have no
+budget amounts declared.
+.PP
+This can be confusing.
+When you need to make things clearer, use the \f[C]\-E/\-\-empty\f[]
+flag, which will reveal all accounts including unbudgeted ones, giving
+the full picture.
+Eg:
 .IP
 .nf
 \f[C]
@ -1938,9 +1953,6 @@ Budget\ performance\ in\ 2017/11/01\-2017/12/31:
 \f[]
 .fi
 .PP
-Note, the \f[C]\-S/\-\-sort\-amount\f[] flag is not yet fully supported
-with \f[C]\-\-budget\f[].
-.PP
 For more examples, see Budgeting and Forecasting.
 .SS Nested budgets
 .PP
--- a/hledger/hledger.info
+++ b/hledger/hledger.info
@ -1404,8 +1404,7 @@ period (without -E, leading and trailing columns with all zeroes are not
 shown).  Second, all accounts which existed at the report start date
 will be considered, not just the ones with activity during the report
 period (use -E to include low-activity accounts which would otherwise
-would be omitted).  With '--budget', '--empty' also shows unbudgeted
-accounts.
+would be omitted).

   The '-T/--row-total' flag adds an additional column showing the total
 for each row.
@ -1497,13 +1496,29 @@ Budget performance in 2017/11/01-2017/12/31:
 ----------------------++----------------------------------------------------
                      ||      0 [              0]       0 [              0] 

-   By default, only accounts with budget goals during the report period
-are shown.  In the example above, transactions in 'expenses:gifts' and
-'expenses:supplies' are counted towards 'expenses' budget, but accounts
-'expenses:gifts' and 'expenses:supplies' are not shown, as they don't
-have any budgets.
+   Note this is different from a normal balance report in several ways:

-   You can use '--empty' shows unbudgeted accounts as well:
+   * Only accounts with budget goals during the report period are shown,
+     by default.
+
+   * In each column, in square brackets after the actual amount,
+     budgeted amounts are shown, along with the percentage of budget
+     used.
+
+   * All parent accounts are always shown, even in flat mode.  Eg
+     assets, assets:bank, and expenses above.
+
+   * Amounts always include all subaccounts, budgeted or unbudgeted,
+     even in flat mode.
+
+   This means that the numbers displayed will not always add up!  Eg
+above, the 'expenses' actual amount includes the gifts and supplies
+transactions, but the 'expenses:gifts' and 'expenses:supplies' accounts
+are not shown, as they have no budget amounts declared.
+
+   This can be confusing.  When you need to make things clearer, use the
+'-E/--empty' flag, which will reveal all accounts including unbudgeted
+ones, giving the full picture.  Eg:

 $ hledger balance -M --budget --empty
 Budget performance in 2017/11/01-2017/12/31:
@ -1541,9 +1556,6 @@ Budget performance in 2017/11/01-2017/12/31:
 ----------------------++----------------------------------------------------
                      ||      0 [              0]       0 [              0] 

-   Note, the '-S/--sort-amount' flag is not yet fully supported with
-'--budget'.
-
   For more examples, see Budgeting and Forecasting.
 * Menu:

@ -2759,86 +2771,86 @@ Node: Depth limited balance reports43924
 Ref: #depth-limited-balance-reports44124
 Node: Multicolumn balance report44580
 Ref: #multicolumn-balance-report44778
-Node: Budget report50018
-Ref: #budget-report50161
-Node: Nested budgets54845
-Ref: #nested-budgets54957
-Ref: #output-format-158437
-Node: balancesheet58515
-Ref: #balancesheet58651
-Node: balancesheetequity59885
-Ref: #balancesheetequity60034
-Node: cashflow60595
-Ref: #cashflow60723
-Node: check-dates61751
-Ref: #check-dates61878
-Node: check-dupes62157
-Ref: #check-dupes62281
-Node: close62574
-Ref: #close62682
-Node: files66095
-Ref: #files66196
-Node: help66343
-Ref: #help66443
-Node: import67536
-Ref: #import67650
-Node: incomestatement68394
-Ref: #incomestatement68528
-Node: prices69864
-Ref: #prices69979
-Node: print70258
-Ref: #print70368
-Node: print-unique74861
-Ref: #print-unique74987
-Node: register75272
-Ref: #register75399
-Node: Custom register output79570
-Ref: #custom-register-output79699
-Node: register-match80961
-Ref: #register-match81095
-Node: rewrite81446
-Ref: #rewrite81561
-Node: Re-write rules in a file83410
-Ref: #re-write-rules-in-a-file83544
-Node: Diff output format84754
-Ref: #diff-output-format84923
-Node: rewrite vs print --auto86015
-Ref: #rewrite-vs.-print---auto86194
-Node: roi86750
-Ref: #roi86848
-Node: stats87860
-Ref: #stats87959
-Node: tags88713
-Ref: #tags88811
-Node: test89041
-Ref: #test89125
-Node: ADD-ON COMMANDS89886
-Ref: #add-on-commands89996
-Node: Official add-ons91283
-Ref: #official-add-ons91423
-Node: api91510
-Ref: #api91599
-Node: ui91651
-Ref: #ui91750
-Node: web91808
-Ref: #web91897
-Node: Third party add-ons91943
-Ref: #third-party-add-ons92118
-Node: diff92253
-Ref: #diff92350
-Node: iadd92449
-Ref: #iadd92563
-Node: interest92646
-Ref: #interest92767
-Node: irr92862
-Ref: #irr92960
-Node: Experimental add-ons93091
-Ref: #experimental-add-ons93243
-Node: autosync93523
-Ref: #autosync93634
-Node: chart93873
-Ref: #chart93992
-Node: check94063
-Ref: #check94165
+Node: Budget report49958
+Ref: #budget-report50101
+Node: Nested budgets55302
+Ref: #nested-budgets55414
+Ref: #output-format-158894
+Node: balancesheet58972
+Ref: #balancesheet59108
+Node: balancesheetequity60342
+Ref: #balancesheetequity60491
+Node: cashflow61052
+Ref: #cashflow61180
+Node: check-dates62208
+Ref: #check-dates62335
+Node: check-dupes62614
+Ref: #check-dupes62738
+Node: close63031
+Ref: #close63139
+Node: files66552
+Ref: #files66653
+Node: help66800
+Ref: #help66900
+Node: import67993
+Ref: #import68107
+Node: incomestatement68851
+Ref: #incomestatement68985
+Node: prices70321
+Ref: #prices70436
+Node: print70715
+Ref: #print70825
+Node: print-unique75318
+Ref: #print-unique75444
+Node: register75729
+Ref: #register75856
+Node: Custom register output80027
+Ref: #custom-register-output80156
+Node: register-match81418
+Ref: #register-match81552
+Node: rewrite81903
+Ref: #rewrite82018
+Node: Re-write rules in a file83867
+Ref: #re-write-rules-in-a-file84001
+Node: Diff output format85211
+Ref: #diff-output-format85380
+Node: rewrite vs print --auto86472
+Ref: #rewrite-vs.-print---auto86651
+Node: roi87207
+Ref: #roi87305
+Node: stats88317
+Ref: #stats88416
+Node: tags89170
+Ref: #tags89268
+Node: test89498
+Ref: #test89582
+Node: ADD-ON COMMANDS90343
+Ref: #add-on-commands90453
+Node: Official add-ons91740
+Ref: #official-add-ons91880
+Node: api91967
+Ref: #api92056
+Node: ui92108
+Ref: #ui92207
+Node: web92265
+Ref: #web92354
+Node: Third party add-ons92400
+Ref: #third-party-add-ons92575
+Node: diff92710
+Ref: #diff92807
+Node: iadd92906
+Ref: #iadd93020
+Node: interest93103
+Ref: #interest93224
+Node: irr93319
+Ref: #irr93417
+Node: Experimental add-ons93548
+Ref: #experimental-add-ons93700
+Node: autosync93980
+Ref: #autosync94091
+Node: chart94330
+Ref: #chart94449
+Node: check94520
+Ref: #check94622

 End Tag Table
--- a/hledger/hledger.txt
+++ b/hledger/hledger.txt
@ -1251,8 +1251,7 @@ COMMANDS
       not shown).  Second, all accounts which existed  at  the  report  start
       date  will  be  considered,  not just the ones with activity during the
       report period (use -E to include low-activity accounts which would oth-
-       erwise would be omitted).  With --budget, --empty also shows unbudgeted
-       accounts.
+       erwise would be omitted).

       The -T/--row-total flag adds an additional column showing the total for
       each row.
@ -1339,13 +1338,28 @@ COMMANDS
              ----------------------++----------------------------------------------------
                                    ||      0 [              0]       0 [              0]

-       By default, only accounts with budget goals during  the  report  period
-       are  shown.   In  the example above, transactions in expenses:gifts and
-       expenses:supplies are counted towards  expenses  budget,  but  accounts
-       expenses:gifts  and expenses:supplies are not shown, as they don't have
-       any budgets.
+       Note this is different from a normal balance report in several ways:

-       You can use --empty shows unbudgeted accounts as well:
+       o Only  accounts  with budget goals during the report period are shown,
+         by default.
+
+       o In each column, in square brackets after the actual amount,  budgeted
+         amounts are shown, along with the percentage of budget used.
+
+       o All  parent accounts are always shown, even in flat mode.  Eg assets,
+         assets:bank, and expenses above.
+
+       o Amounts always include all subaccounts, budgeted or unbudgeted,  even
+         in flat mode.
+
+       This means that the numbers displayed will not always add up! Eg above,
+       the expenses actual amount includes the  gifts  and  supplies  transac-
+       tions,  but  the  expenses:gifts and expenses:supplies accounts are not
+       shown, as they have no budget amounts declared.
+
+       This can be confusing.  When you need to make things clearer,  use  the
+       -E/--empty  flag,  which  will reveal all accounts including unbudgeted
+       ones, giving the full picture.  Eg:

              $ hledger balance -M --budget --empty
              Budget performance in 2017/11/01-2017/12/31:
@ -1383,9 +1397,6 @@ COMMANDS
              ----------------------++----------------------------------------------------
                                    ||      0 [              0]       0 [              0]

-       Note, the -S/--sort-amount flag is not yet fully supported with  --bud-
-       get.
-
       For more examples, see Budgeting and Forecasting.

   Nested budgets