;doc: update manuals

Author: simonmichael

hledger-lib/.date.m4

@@ -1,2 +1,2 @@
 m4_dnl Date to show in man pages. Updated by "Shake manuals"
-m4_define({{_monthyear_}}, {{May 2024}})m4_dnl
+m4_define({{_monthyear_}}, {{June 2024}})m4_dnl

hledger-ui/.date.m4

@@ -1,2 +1,2 @@
 m4_dnl Date to show in man pages. Updated by "Shake manuals"
-m4_define({{_monthyear_}}, {{May 2024}})m4_dnl
+m4_define({{_monthyear_}}, {{June 2024}})m4_dnl

hledger-ui/hledger-ui.1

@@ -1,5 +1,5 @@
 
-.TH "HLEDGER\-UI" "1" "May 2024" "hledger-ui-1.34 " "hledger User Manuals"
+.TH "HLEDGER\-UI" "1" "June 2024" "hledger-ui-1.34 " "hledger User Manuals"
 
 
 
@@ -11,6 +11,10 @@ robust, friendly plain text accounting app.
 .PD 0
 .P
 .PD
+or
+.PD 0
+.P
+.PD
 \f[CR]hledger ui \-\- [OPTS] [QUERYARGS]\f[R]
 .SH DESCRIPTION
 This manual is for hledger\[aq]s terminal interface, version 1.34.
@@ -42,47 +46,27 @@ They can be revealed, along with any rule\-generated periodic
 transactions, by pressing the F key (or starting with \-\-forecast) to
 enable \[dq]forecast mode\[dq].
 .SH OPTIONS
-Any QUERYARGS are interpreted as a hledger search query which filters
-the data.
-.PP
+Any arguments are interpreted as a hledger query which filters the data.
 hledger\-ui provides the following options:
-.TP
-\f[CR]\-w \-\-watch\f[R]
-watch for data and date changes and reload automatically
-.TP
-\f[CR]\-\-theme=default|terminal|greenterm|dark\f[R]
-use this custom display theme
-.TP
-\f[CR]\-\-menu\f[R]
-start in the menu screen
-.TP
-\f[CR]\-\-cash\f[R]
-start in the cash accounts screen
-.TP
-\f[CR]\-\-bs\f[R]
-start in the balance sheet accounts screen
-.TP
-\f[CR]\-\-is\f[R]
-start in the income statement accounts screen
-.TP
-\f[CR]\-\-all\f[R]
-start in the all accounts screen
-.TP
-\f[CR]\-\-register=ACCTREGEX\f[R]
-start in the (first) matched account\[aq]s register screen
-.TP
-\f[CR]\-\-change\f[R]
-show period balances (changes) at startup instead of historical balances
-.TP
-\f[CR]\-l \-\-flat\f[R]
-show accounts as a flat list (default)
-.TP
-\f[CR]\-t \-\-tree\f[R]
-show accounts as a tree
-.PP
-hledger\-ui also supports many of hledger\[aq]s general options (and the
-hledger manual\[aq]s command line tips also apply here):
-.SS General options
+.IP
+.EX
+Flags:
+  \-w \-\-watch                watch for data and date changes and reload
+                            automatically
+     \-\-theme=THEME          use this custom display theme (default,
+                            greenterm, terminal, dark)
+     \-\-cash                 start in the cash accounts screen
+     \-\-bs                   start in the balance sheet accounts screen
+     \-\-is                   start in the income statement accounts screen
+     \-\-all                  start in the all accounts screen
+     \-\-register=ACCTREGEX   start in the (first matched) account\[aq]s register
+     \-\-change               show period balances (changes) at startup instead
+                            of historical balances
+  \-l \-\-flat                 show accounts as a flat list (default)
+  \-t \-\-tree                 show accounts as a tree
+.EE
+.PP
+and also supports many of hledger\[aq]s general options:
 .IP
 .EX
 General input/data transformation flags:
@@ -151,7 +135,6 @@ General output/reporting flags (supported by some commands):
                             Eg: \-c \[aq].\[aq] or \-c \[aq]1.000,00 EUR\[aq]
      \-\-color=YN \-\-colour    Use ANSI color codes in text output? Can be
                             \[aq]y\[aq]/\[aq]yes\[aq]/\[aq]always\[aq], \[aq]n\[aq]/\[aq]no\[aq]/\[aq]never\[aq] or \[aq]auto\[aq].
-                            (A NO_COLOR environment variable overrides this.)
      \-\-pretty[=YN]          Use box\-drawing characters in text output? Can be
                             \[aq]y\[aq]/\[aq]yes\[aq] or \[aq]n\[aq]/\[aq]no\[aq].
                             If YN is specified, the equals is required.
@@ -160,10 +143,13 @@ General output/reporting flags (supported by some commands):
 General help flags:
   \-h \-\-help                 show command line help
      \-\-tldr                 show command examples with tldr
-     \-\-info                 show the hledger manual with info
-     \-\-man                  show the hledger manual with man
+     \-\-info                 show the manual with info
+     \-\-man                  show the manual with man
      \-\-version              show version information
 .EE
+.PP
+With hledger\-ui, the \f[CR]\-\-debug\f[R] option sends debug output to
+a \f[CR]hledger\-ui.log\f[R] file in the current directory.
 .SH MOUSE
 In most modern terminals, you can navigate through the screens with a
 mouse or touchpad:
@@ -417,8 +403,7 @@ when you press g to reload.
 Once you have fixed the problem, press g again to reload and resume
 normal operation.
 (Or, you can press escape to cancel the reload attempt.)
-.SH TIPS
-.SS Watch mode
+.SH WATCH MODE
 One of hledger\-ui\[aq]s best features is the auto\-reloading
 \f[CR]\-w/\-\-watch\f[R] mode.
 With this flag, it will update the display automatically whenever
@@ -458,12 +443,6 @@ know.)
 .PP
 If you are viewing files mounted from another machine, the system clocks
 on both machines should be roughly in agreement.
-.SS Debug output
-You can add \f[CR]\-\-debug[=N]\f[R] to the command line to log debug
-output.
-This will be logged to the file \f[CR]hledger\-ui.log\f[R] in the
-current directory.
-N ranges from 1 (least output, the default) to 9 (maximum output).
 .SH ENVIRONMENT
 \f[B]COLUMNS\f[R] The screen width to use.
 Default: the full terminal width.

hledger-ui/hledger-ui.info

@@ -15,6 +15,7 @@ hledger-ui - terminal interface (TUI) for 'hledger', a robust, friendly
 plain text accounting app.
 
    'hledger-ui [OPTS] [QUERYARGS]'
+or
 'hledger ui -- [OPTS] [QUERYARGS]'
 
    This manual is for hledger's terminal interface, version 1.34.  See
@@ -49,7 +50,7 @@ enable "forecast mode".
 * MOUSE::
 * KEYS::
 * SCREENS::
-* TIPS::
+* WATCH MODE::
 * ENVIRONMENT::
 * BUGS::
 
@@ -59,58 +60,25 @@ File: hledger-ui.info,  Node: OPTIONS,  Next: MOUSE,  Prev: Top,  Up: Top
 1 OPTIONS
 *********
 
-Any QUERYARGS are interpreted as a hledger search query which filters
-the data.
-
-   hledger-ui provides the following options:
-
-'-w --watch'
-
-     watch for data and date changes and reload automatically
-'--theme=default|terminal|greenterm|dark'
-
-     use this custom display theme
-'--menu'
-
-     start in the menu screen
-'--cash'
-
-     start in the cash accounts screen
-'--bs'
-
-     start in the balance sheet accounts screen
-'--is'
-
-     start in the income statement accounts screen
-'--all'
-
-     start in the all accounts screen
-'--register=ACCTREGEX'
-
-     start in the (first) matched account's register screen
-'--change'
-
-     show period balances (changes) at startup instead of historical
-     balances
-'-l --flat'
-
-     show accounts as a flat list (default)
-'-t --tree'
-
-     show accounts as a tree
-
-   hledger-ui also supports many of hledger's general options (and the
-hledger manual's command line tips also apply here):
-
-* Menu:
-
-* General options::
-
-
-File: hledger-ui.info,  Node: General options,  Up: OPTIONS
-
-1.1 General options
-===================
+Any arguments are interpreted as a hledger query which filters the data.
+hledger-ui provides the following options:
+
+Flags:
+  -w --watch                watch for data and date changes and reload
+                            automatically
+     --theme=THEME          use this custom display theme (default,
+                            greenterm, terminal, dark)
+     --cash                 start in the cash accounts screen
+     --bs                   start in the balance sheet accounts screen
+     --is                   start in the income statement accounts screen
+     --all                  start in the all accounts screen
+     --register=ACCTREGEX   start in the (first matched) account's register
+     --change               show period balances (changes) at startup instead
+                            of historical balances
+  -l --flat                 show accounts as a flat list (default)
+  -t --tree                 show accounts as a tree
+
+   and also supports many of hledger's general options:
 
 General input/data transformation flags:
   -f --file=FILE            Read data from FILE, or from stdin if -. Can be
@@ -178,7 +146,6 @@ General output/reporting flags (supported by some commands):
                             Eg: -c '.' or -c '1.000,00 EUR'
      --color=YN --colour    Use ANSI color codes in text output? Can be
                             'y'/'yes'/'always', 'n'/'no'/'never' or 'auto'.
-                            (A NO_COLOR environment variable overrides this.)
      --pretty[=YN]          Use box-drawing characters in text output? Can be
                             'y'/'yes' or 'n'/'no'.
                             If YN is specified, the equals is required.
@@ -187,10 +154,13 @@ General output/reporting flags (supported by some commands):
 General help flags:
   -h --help                 show command line help
      --tldr                 show command examples with tldr
-     --info                 show the hledger manual with info
-     --man                  show the hledger manual with man
+     --info                 show the manual with info
+     --man                  show the manual with man
      --version              show version information
 
+   With hledger-ui, the '--debug' option sends debug output to a
+'hledger-ui.log' file in the current directory.
+
 
 File: hledger-ui.info,  Node: MOUSE,  Next: KEYS,  Prev: OPTIONS,  Up: Top
 
@@ -309,7 +279,7 @@ amount values.
    Additional screen-specific keys are described below.
 
 
-File: hledger-ui.info,  Node: SCREENS,  Next: TIPS,  Prev: KEYS,  Up: Top
+File: hledger-ui.info,  Node: SCREENS,  Next: WATCH MODE,  Prev: KEYS,  Up: Top
 
 4 SCREENS
 *********
@@ -485,21 +455,10 @@ again to reload and resume normal operation.  (Or, you can press escape
 to cancel the reload attempt.)
 
 
-File: hledger-ui.info,  Node: TIPS,  Next: ENVIRONMENT,  Prev: SCREENS,  Up: Top
-
-5 TIPS
-******
-
-* Menu:
+File: hledger-ui.info,  Node: WATCH MODE,  Next: ENVIRONMENT,  Prev: SCREENS,  Up: Top
 
-* Watch mode::
-* Debug output::
-
-
-File: hledger-ui.info,  Node: Watch mode,  Next: Debug output,  Up: TIPS
-
-5.1 Watch mode
-==============
+5 WATCH MODE
+************
 
 One of hledger-ui's best features is the auto-reloading '-w/--watch'
 mode.  With this flag, it will update the display automatically whenever
@@ -536,17 +495,7 @@ work around, press 'g' to reload manually, or try #1617's
 clocks on both machines should be roughly in agreement.
 
 
-File: hledger-ui.info,  Node: Debug output,  Prev: Watch mode,  Up: TIPS
-
-5.2 Debug output
-================
-
-You can add '--debug[=N]' to the command line to log debug output.  This
-will be logged to the file 'hledger-ui.log' in the current directory.  N
-ranges from 1 (least output, the default) to 9 (maximum output).
-
-
-File: hledger-ui.info,  Node: ENVIRONMENT,  Next: BUGS,  Prev: TIPS,  Up: Top
+File: hledger-ui.info,  Node: ENVIRONMENT,  Next: BUGS,  Prev: WATCH MODE,  Up: Top
 
 6 ENVIRONMENT
 *************
@@ -581,42 +530,36 @@ above).
 
 Tag Table:
 Node: Top221
-Node: OPTIONS1861
-Ref: #options1959
-Node: General options2926
-Ref: #general-options3030
-Node: MOUSE8180
-Ref: #mouse8275
-Node: KEYS8512
-Ref: #keys8605
-Node: SCREENS13260
-Ref: #screens13358
-Node: Menu screen13994
-Ref: #menu-screen14115
-Node: Cash accounts screen14310
-Ref: #cash-accounts-screen14487
-Node: Balance sheet accounts screen14671
-Ref: #balance-sheet-accounts-screen14887
-Node: Income statement accounts screen15007
-Ref: #income-statement-accounts-screen15228
-Node: All accounts screen15392
-Ref: #all-accounts-screen15573
-Node: Register screen15755
-Ref: #register-screen15914
-Node: Transaction screen18198
-Ref: #transaction-screen18356
-Node: Error screen19773
-Ref: #error-screen19895
-Node: TIPS20139
-Ref: #tips20238
-Node: Watch mode20280
-Ref: #watch-mode20387
-Node: Debug output21846
-Ref: #debug-output21957
-Node: ENVIRONMENT22169
-Ref: #environment22279
-Node: BUGS22470
-Ref: #bugs22553
+Node: OPTIONS1870
+Ref: #options1968
+Node: MOUSE8148
+Ref: #mouse8243
+Node: KEYS8480
+Ref: #keys8573
+Node: SCREENS13228
+Ref: #screens13332
+Node: Menu screen13968
+Ref: #menu-screen14089
+Node: Cash accounts screen14284
+Ref: #cash-accounts-screen14461
+Node: Balance sheet accounts screen14645
+Ref: #balance-sheet-accounts-screen14861
+Node: Income statement accounts screen14981
+Ref: #income-statement-accounts-screen15202
+Node: All accounts screen15366
+Ref: #all-accounts-screen15547
+Node: Register screen15729
+Ref: #register-screen15888
+Node: Transaction screen18172
+Ref: #transaction-screen18330
+Node: Error screen19747
+Ref: #error-screen19869
+Node: WATCH MODE20113
+Ref: #watch-mode20230
+Node: ENVIRONMENT21689
+Ref: #environment21805
+Node: BUGS21996
+Ref: #bugs22079
 
 End Tag Table