;doc: update embedded manuals

simonmichael · Dec 10, 2024 · ffc3440 · ffc3440
1 parent f2cb3cd
commit ffc3440
Show file tree

Hide file tree

Showing 13 changed files with 3,508 additions and 2,844 deletions.
diff --git a/hledger-lib/.date.m4 b/hledger-lib/.date.m4
@@ -1,2 +1,2 @@
 m4_dnl Date to show in man pages. Updated by "Shake manuals"
-m4_define({{_monthyear_}}, {{October 2024}})m4_dnl
+m4_define({{_monthyear_}}, {{December 2024}})m4_dnl
diff --git a/hledger-ui/.date.m4 b/hledger-ui/.date.m4
@@ -1,2 +1,2 @@
 m4_dnl Date to show in man pages. Updated by "Shake manuals"
-m4_define({{_monthyear_}}, {{October 2024}})m4_dnl
+m4_define({{_monthyear_}}, {{December 2024}})m4_dnl
diff --git a/hledger-ui/hledger-ui.1 b/hledger-ui/hledger-ui.1
@@ -1,5 +1,5 @@
 
-.TH "HLEDGER\-UI" "1" "October 2024" "hledger-ui-1.40.99 " "hledger User Manuals"
+.TH "HLEDGER\-UI" "1" "December 2024" "hledger-ui-1.41.99 " "hledger User Manuals"
 
 
 
@@ -17,7 +17,7 @@ or
 .PD
 \f[CR]hledger ui \-\- [OPTS] [QUERYARGS]\f[R]
 .SH DESCRIPTION
-This manual is for hledger\[aq]s terminal interface, version 1.40.99.
+This manual is for hledger\[aq]s terminal interface, version 1.41.99.
 See also the hledger manual for common concepts and file formats.
 .PP
 hledger is a robust, user\-friendly, cross\-platform set of programs for
@@ -115,9 +115,11 @@ General output/reporting flags (supported by some commands):
   \-C \-\-cleared              include only cleared postings/transactions
                             (\-U/\-P/\-C can be combined)
   \-R \-\-real                 include only non\-virtual postings
-     \-\-depth=NUM            or \-NUM: show only top NUM levels of accounts
   \-E \-\-empty                Show zero items, which are normally hidden.
                             In hledger\-ui & hledger\-web, do the opposite.
+     \-\-depth=DEPTHEXP       if a number (or \-NUM): show only top NUM levels
+                            of accounts. If REGEXP=NUM, only apply limiting to
+                            accounts matching the regular expression.
   \-B \-\-cost                 show amounts converted to their cost/sale amount
   \-V \-\-market               Show amounts converted to their value at period
                             end(s) in their default valuation commodity.
@@ -211,6 +213,9 @@ period to \[dq]today\[dq].
 If you are using \f[CR]\-w/\-\-watch\f[R] and viewing a narrowed period
 containing today, the view will follow any changes in system date
 (moving to the period containing the new date).
+(These keys work only with the standard Julian calendar
+year/quarter/month/week/day periods; they are not affected by a custom
+report interval specified at the command line.)
 .PP
 You can also specify a non\-standard period with \f[CR]/\f[R] and a
 \f[CR]date:\f[R] query; in this case, the period is not movable with the
@@ -461,7 +466,7 @@ with \f[CR]\-f/\-\-file\f[R].
 Default: \f[CR]$HOME/.hledger.journal\f[R].
 .SH BUGS
 We welcome bug reports in the hledger issue tracker (shortcut:
-http://bugs.hledger.org), or on the #hledger chat or hledger mail list
+https://bugs.hledger.org), or on the hledger chat or mail list
 (https://hledger.org/support).
 .PP
 Some known issues:

diff --git a/hledger-ui/hledger-ui.info b/hledger-ui/hledger-ui.info
@@ -18,7 +18,7 @@ plain text accounting app.
 or
 'hledger ui -- [OPTS] [QUERYARGS]'
 
-   This manual is for hledger's terminal interface, version 1.40.99.
+   This manual is for hledger's terminal interface, version 1.41.99.
 See also the hledger manual for common concepts and file formats.
 
    hledger is a robust, user-friendly, cross-platform set of programs
@@ -126,9 +126,11 @@ General output/reporting flags (supported by some commands):
   -C --cleared              include only cleared postings/transactions
                             (-U/-P/-C can be combined)
   -R --real                 include only non-virtual postings
-     --depth=NUM            or -NUM: show only top NUM levels of accounts
   -E --empty                Show zero items, which are normally hidden.
                             In hledger-ui & hledger-web, do the opposite.
+     --depth=DEPTHEXP       if a number (or -NUM): show only top NUM levels
+                            of accounts. If REGEXP=NUM, only apply limiting to
+                            accounts matching the regular expression.
   -B --cost                 show amounts converted to their cost/sale amount
   -V --market               Show amounts converted to their value at period
                             end(s) in their default valuation commodity.
@@ -221,7 +223,10 @@ is displayed in the header line, pressing 'SHIFT-LEFT' or 'SHIFT-RIGHT'
 moves to the previous or next period, and pressing 'T' sets the period
 to "today".  If you are using '-w/--watch' and viewing a narrowed period
 containing today, the view will follow any changes in system date
-(moving to the period containing the new date).
+(moving to the period containing the new date).  (These keys work only
+with the standard Julian calendar year/quarter/month/week/day periods;
+they are not affected by a custom report interval specified at the
+command line.)
 
    You can also specify a non-standard period with '/' and a 'date:'
 query; in this case, the period is not movable with the arrow keys.
@@ -521,7 +526,7 @@ File: hledger-ui.info,  Node: BUGS,  Prev: ENVIRONMENT,  Up: Top
 ******
 
 We welcome bug reports in the hledger issue tracker (shortcut:
-http://bugs.hledger.org), or on the #hledger chat or hledger mail list
+https://bugs.hledger.org), or on the hledger chat or mail list
 (https://hledger.org/support).
 
    Some known issues:
@@ -540,20 +545,20 @@ above).
 Tag Table:
 Node: Top223
 Node: OPTIONS1874
-Node: MOUSE8397
-Node: KEYS8729
-Node: SCREENS13557
-Node: Menu screen14297
-Node: Cash accounts screen14613
-Node: Balance sheet accounts screen14974
-Node: Income statement accounts screen15310
-Node: All accounts screen15695
-Node: Register screen16058
-Node: Transaction screen18501
-Node: Error screen20076
-Node: WATCH MODE20442
-Node: ENVIRONMENT22018
-Node: BUGS22325
+Node: MOUSE8548
+Node: KEYS8880
+Node: SCREENS13884
+Node: Menu screen14624
+Node: Cash accounts screen14940
+Node: Balance sheet accounts screen15301
+Node: Income statement accounts screen15637
+Node: All accounts screen16022
+Node: Register screen16385
+Node: Transaction screen18828
+Node: Error screen20403
+Node: WATCH MODE20769
+Node: ENVIRONMENT22345
+Node: BUGS22652
 
 End Tag Table
 

diff --git a/hledger-ui/hledger-ui.txt b/hledger-ui/hledger-ui.txt
@@ -11,7 +11,7 @@ SYNOPSIS
        hledger ui -- [OPTS] [QUERYARGS]
 
 DESCRIPTION
-       This manual is for hledger's terminal interface, version 1.40.99.   See
+       This manual is for hledger's terminal interface, version 1.41.99.   See
        also the hledger manual for common concepts and file formats.
 
        hledger  is a robust, user-friendly, cross-platform set of programs for
@@ -104,9 +104,11 @@ OPTIONS
                 -C --cleared              include only cleared postings/transactions
                                           (-U/-P/-C can be combined)
                 -R --real                 include only non-virtual postings
-                   --depth=NUM            or -NUM: show only top NUM levels of accounts
                 -E --empty                Show zero items, which are normally hidden.
                                           In hledger-ui & hledger-web, do the opposite.
+                   --depth=DEPTHEXP       if a number (or -NUM): show only top NUM levels
+                                          of accounts. If REGEXP=NUM, only apply limiting to
+                                          accounts matching the regular expression.
                 -B --cost                 show amounts converted to their cost/sale amount
                 -V --market               Show amounts converted to their value at period
                                           end(s) in their default valuation commodity.
@@ -189,7 +191,9 @@ KEYS
        the previous or next period, and pressing T sets the period to "today".
        If  you  are  using -w/--watch and viewing a narrowed period containing
        today, the view will follow any changes in system date (moving  to  the
-       period containing the new date).
+       period  containing the new date).  (These keys work only with the stan-
+       dard Julian calendar year/quarter/month/week/day periods; they are  not
+       affected by a custom report interval specified at the command line.)
 
        You can also specify a non-standard period with / and a date: query; in
        this case, the period is not movable with the arrow keys.
@@ -415,7 +419,7 @@ ENVIRONMENT
 
 BUGS
        We  welcome  bug  reports  in  the  hledger  issue  tracker  (shortcut:
-       http://bugs.hledger.org), or on the #hledger chat or hledger mail  list
+       https://bugs.hledger.org),  or  on  the  hledger  chat  or  mail   list
        (https://hledger.org/support).
 
        Some known issues:
@@ -448,4 +452,4 @@ LICENSE
 SEE ALSO
        hledger(1), hledger-ui(1), hledger-web(1), ledger(1)
 
-hledger-ui-1.40.99               October 2024                    HLEDGER-UI(1)
+hledger-ui-1.41.99               December 2024                   HLEDGER-UI(1)
diff --git a/hledger-web/.date.m4 b/hledger-web/.date.m4
@@ -1,2 +1,2 @@
 m4_dnl Date to show in man pages. Updated by "Shake manuals"
-m4_define({{_monthyear_}}, {{October 2024}})m4_dnl
+m4_define({{_monthyear_}}, {{December 2024}})m4_dnl
diff --git a/hledger-web/hledger-web.1 b/hledger-web/hledger-web.1
@@ -1,5 +1,5 @@
 
-.TH "HLEDGER\-WEB" "1" "October 2024" "hledger-web-1.40.99 " "hledger User Manuals"
+.TH "HLEDGER\-WEB" "1" "December 2024" "hledger-web-1.41.99 " "hledger User Manuals"
 
 
 
@@ -17,7 +17,7 @@ or
 .PD
 \f[CR]hledger web \-\- [OPTS] [QUERY]\f[R]
 .SH DESCRIPTION
-This manual is for hledger\[aq]s web interface, version 1.40.99.
+This manual is for hledger\[aq]s web interface, version 1.41.99.
 See also the hledger manual for common concepts and file formats.
 .PP
 hledger is a robust, user\-friendly, cross\-platform set of programs for
@@ -166,9 +166,11 @@ General output/reporting flags (supported by some commands):
   \-C \-\-cleared              include only cleared postings/transactions
                             (\-U/\-P/\-C can be combined)
   \-R \-\-real                 include only non\-virtual postings
-     \-\-depth=NUM            or \-NUM: show only top NUM levels of accounts
   \-E \-\-empty                Show zero items, which are normally hidden.
                             In hledger\-ui & hledger\-web, do the opposite.
+     \-\-depth=DEPTHEXP       if a number (or \-NUM): show only top NUM levels
+                            of accounts. If REGEXP=NUM, only apply limiting to
+                            accounts matching the regular expression.
   \-B \-\-cost                 show amounts converted to their cost/sale amount
   \-V \-\-market               Show amounts converted to their value at period
                             end(s) in their default valuation commodity.
@@ -500,7 +502,7 @@ with \f[CR]\-f/\-\-file\f[R].
 Default: \f[CR]$HOME/.hledger.journal\f[R].
 .SH BUGS
 We welcome bug reports in the hledger issue tracker (shortcut:
-http://bugs.hledger.org), or on the #hledger chat or hledger mail list
+https://bugs.hledger.org), or on the hledger chat or mail list
 (https://hledger.org/support).
 .PP
 Some known issues:

diff --git a/hledger-web/hledger-web.info b/hledger-web/hledger-web.info
@@ -18,7 +18,7 @@ plain text accounting app.
 or
 'hledger web -- [OPTS] [QUERY]'
 
-   This manual is for hledger's web interface, version 1.40.99.  See
+   This manual is for hledger's web interface, version 1.41.99.  See
 also the hledger manual for common concepts and file formats.
 
    hledger is a robust, user-friendly, cross-platform set of programs
@@ -171,9 +171,11 @@ General output/reporting flags (supported by some commands):
   -C --cleared              include only cleared postings/transactions
                             (-U/-P/-C can be combined)
   -R --real                 include only non-virtual postings
-     --depth=NUM            or -NUM: show only top NUM levels of accounts
   -E --empty                Show zero items, which are normally hidden.
                             In hledger-ui & hledger-web, do the opposite.
+     --depth=DEPTHEXP       if a number (or -NUM): show only top NUM levels
+                            of accounts. If REGEXP=NUM, only apply limiting to
+                            accounts matching the regular expression.
   -B --cost                 show amounts converted to their cost/sale amount
   -V --market               Show amounts converted to their value at period
                             end(s) in their default valuation commodity.
@@ -517,7 +519,7 @@ File: hledger-web.info,  Node: BUGS,  Prev: ENVIRONMENT,  Up: Top
 ******
 
 We welcome bug reports in the hledger issue tracker (shortcut:
-http://bugs.hledger.org), or on the #hledger chat or hledger mail list
+https://bugs.hledger.org), or on the hledger chat or mail list
 (https://hledger.org/support).
 
    Some known issues:
@@ -528,14 +530,14 @@ http://bugs.hledger.org), or on the #hledger chat or hledger mail list
 Tag Table:
 Node: Top225
 Node: OPTIONS2571
-Node: PERMISSIONS11109
-Node: EDITING UPLOADING DOWNLOADING12460
-Node: RELOADING13475
-Node: JSON API14042
-Node: DEBUG OUTPUT19691
-Node: Debug output19843
-Node: ENVIRONMENT20361
-Node: BUGS20597
+Node: PERMISSIONS11260
+Node: EDITING UPLOADING DOWNLOADING12611
+Node: RELOADING13626
+Node: JSON API14193
+Node: DEBUG OUTPUT19842
+Node: Debug output19994
+Node: ENVIRONMENT20512
+Node: BUGS20748
 
 End Tag Table
 

diff --git a/hledger-web/hledger-web.txt b/hledger-web/hledger-web.txt
@@ -11,7 +11,7 @@ SYNOPSIS
        hledger web -- [OPTS] [QUERY]
 
 DESCRIPTION
-       This manual is for hledger's web interface, version 1.40.99.  See  also
+       This manual is for hledger's web interface, version 1.41.99.  See  also
        the hledger manual for common concepts and file formats.
 
        hledger  is a robust, user-friendly, cross-platform set of programs for
@@ -148,9 +148,11 @@ OPTIONS
                 -C --cleared              include only cleared postings/transactions
                                           (-U/-P/-C can be combined)
                 -R --real                 include only non-virtual postings
-                   --depth=NUM            or -NUM: show only top NUM levels of accounts
                 -E --empty                Show zero items, which are normally hidden.
                                           In hledger-ui & hledger-web, do the opposite.
+                   --depth=DEPTHEXP       if a number (or -NUM): show only top NUM levels
+                                          of accounts. If REGEXP=NUM, only apply limiting to
+                                          accounts matching the regular expression.
                 -B --cost                 show amounts converted to their cost/sale amount
                 -V --market               Show amounts converted to their value at period
                                           end(s) in their default valuation commodity.
@@ -453,7 +455,7 @@ ENVIRONMENT
 
 BUGS
        We  welcome  bug  reports  in  the  hledger  issue  tracker  (shortcut:
-       http://bugs.hledger.org),  or on the #hledger chat or hledger mail list
+       https://bugs.hledger.org),   or  on  the  hledger  chat  or  mail  list
        (https://hledger.org/support).
 
        Some known issues:
@@ -478,4 +480,4 @@ LICENSE
 SEE ALSO
        hledger(1), hledger-ui(1), hledger-web(1), ledger(1)
 
-hledger-web-1.40.99              October 2024                   HLEDGER-WEB(1)
+hledger-web-1.41.99              December 2024                  HLEDGER-WEB(1)
diff --git a/hledger/.date.m4 b/hledger/.date.m4
@@ -1,2 +1,2 @@
 m4_dnl Date to show in man pages. Updated by "Shake manuals"
-m4_define({{_monthyear_}}, {{October 2024}})m4_dnl
+m4_define({{_monthyear_}}, {{December 2024}})m4_dnl