;doc: update manuals

This commit is contained in:
Simon Michael 2024-06-27 00:24:23 +01:00
parent e0cbe65d9b
commit 65c30bceb6
9 changed files with 787 additions and 790 deletions

View File

@ -146,7 +146,7 @@ General help flags:
\-\-info show the manual with info \-\-info show the manual with info
\-\-man show the manual with man \-\-man show the manual with man
\-\-version show version information \-\-version show version information
\-\-debug=[1\-9] show this level of debug output (default: 1) \-\-debug=[1\-9] show this much debug output (default: 1)
.EE .EE
.PP .PP
With hledger\-ui, the \f[CR]\-\-debug\f[R] option sends debug output to With hledger\-ui, the \f[CR]\-\-debug\f[R] option sends debug output to

View File

@ -157,7 +157,7 @@ General help flags:
--info show the manual with info --info show the manual with info
--man show the manual with man --man show the manual with man
--version show version information --version show version information
--debug=[1-9] show this level of debug output (default: 1) --debug=[1-9] show this much debug output (default: 1)
With hledger-ui, the '--debug' option sends debug output to a With hledger-ui, the '--debug' option sends debug output to a
'hledger-ui.log' file in the current directory. 'hledger-ui.log' file in the current directory.
@ -533,34 +533,34 @@ Tag Table:
Node: Top221 Node: Top221
Node: OPTIONS1872 Node: OPTIONS1872
Ref: #options1970 Ref: #options1970
Node: MOUSE8240 Node: MOUSE8236
Ref: #mouse8335 Ref: #mouse8331
Node: KEYS8572 Node: KEYS8568
Ref: #keys8665 Ref: #keys8661
Node: SCREENS13320 Node: SCREENS13316
Ref: #screens13424 Ref: #screens13420
Node: Menu screen14060 Node: Menu screen14056
Ref: #menu-screen14181 Ref: #menu-screen14177
Node: Cash accounts screen14376 Node: Cash accounts screen14372
Ref: #cash-accounts-screen14553 Ref: #cash-accounts-screen14549
Node: Balance sheet accounts screen14737 Node: Balance sheet accounts screen14733
Ref: #balance-sheet-accounts-screen14953 Ref: #balance-sheet-accounts-screen14949
Node: Income statement accounts screen15073 Node: Income statement accounts screen15069
Ref: #income-statement-accounts-screen15294 Ref: #income-statement-accounts-screen15290
Node: All accounts screen15458 Node: All accounts screen15454
Ref: #all-accounts-screen15639 Ref: #all-accounts-screen15635
Node: Register screen15821 Node: Register screen15817
Ref: #register-screen15980 Ref: #register-screen15976
Node: Transaction screen18264 Node: Transaction screen18260
Ref: #transaction-screen18422 Ref: #transaction-screen18418
Node: Error screen19839 Node: Error screen19835
Ref: #error-screen19961 Ref: #error-screen19957
Node: WATCH MODE20205 Node: WATCH MODE20201
Ref: #watch-mode20322 Ref: #watch-mode20318
Node: ENVIRONMENT21781 Node: ENVIRONMENT21777
Ref: #environment21897 Ref: #environment21893
Node: BUGS22088 Node: BUGS22084
Ref: #bugs22171 Ref: #bugs22167
 
End Tag Table End Tag Table

View File

@ -135,7 +135,7 @@ OPTIONS
--info show the manual with info --info show the manual with info
--man show the manual with man --man show the manual with man
--version show version information --version show version information
--debug=[1-9] show this level of debug output (default: 1) --debug=[1-9] show this much debug output (default: 1)
With hledger-ui, the --debug option sends debug output to a With hledger-ui, the --debug option sends debug output to a
hledger-ui.log file in the current directory. hledger-ui.log file in the current directory.

View File

@ -197,7 +197,7 @@ General help flags:
\-\-info show the manual with info \-\-info show the manual with info
\-\-man show the manual with man \-\-man show the manual with man
\-\-version show version information \-\-version show version information
\-\-debug=[1\-9] show this level of debug output (default: 1) \-\-debug=[1\-9] show this much debug output (default: 1)
.EE .EE
.PP .PP
hledger\-web shows accounts with zero balances by default (like hledger\-web shows accounts with zero balances by default (like

View File

@ -202,7 +202,7 @@ General help flags:
--info show the manual with info --info show the manual with info
--man show the manual with man --man show the manual with man
--version show version information --version show version information
--debug=[1-9] show this level of debug output (default: 1) --debug=[1-9] show this much debug output (default: 1)
hledger-web shows accounts with zero balances by default (like hledger-web shows accounts with zero balances by default (like
'hledger-ui', and unlike 'hledger'). Using the '-E/--empty' flag will 'hledger-ui', and unlike 'hledger'). Using the '-E/--empty' flag will
@ -525,22 +525,22 @@ Tag Table:
Node: Top223 Node: Top223
Node: OPTIONS2569 Node: OPTIONS2569
Ref: #options2674 Ref: #options2674
Node: PERMISSIONS10952 Node: PERMISSIONS10948
Ref: #permissions11091 Ref: #permissions11087
Node: EDITING UPLOADING DOWNLOADING12303 Node: EDITING UPLOADING DOWNLOADING12299
Ref: #editing-uploading-downloading12484 Ref: #editing-uploading-downloading12480
Node: RELOADING13318 Node: RELOADING13314
Ref: #reloading13452 Ref: #reloading13448
Node: JSON API13885 Node: JSON API13881
Ref: #json-api14000 Ref: #json-api13996
Node: DEBUG OUTPUT19534 Node: DEBUG OUTPUT19530
Ref: #debug-output19659 Ref: #debug-output19655
Node: Debug output19686 Node: Debug output19682
Ref: #debug-output-119787 Ref: #debug-output-119783
Node: ENVIRONMENT20204 Node: ENVIRONMENT20200
Ref: #environment20323 Ref: #environment20319
Node: BUGS20440 Node: BUGS20436
Ref: #bugs20524 Ref: #bugs20520
 
End Tag Table End Tag Table

View File

@ -179,7 +179,7 @@ OPTIONS
--info show the manual with info --info show the manual with info
--man show the manual with man --man show the manual with man
--version show version information --version show version information
--debug=[1-9] show this level of debug output (default: 1) --debug=[1-9] show this much debug output (default: 1)
hledger-web shows accounts with zero balances by default (like hledger-web shows accounts with zero balances by default (like
hledger-ui, and unlike hledger). Using the -E/--empty flag will re- hledger-ui, and unlike hledger). Using the -E/--empty flag will re-

View File

@ -431,7 +431,7 @@ General help flags:
\-\-info show the manual with info \-\-info show the manual with info
\-\-man show the manual with man \-\-man show the manual with man
\-\-version show version information \-\-version show version information
\-\-debug=[1\-9] show this level of debug output (default: 1) \-\-debug=[1\-9] show this much debug output (default: 1)
.EE .EE
.PP .PP
Usually hledger accepts any unambiguous flag prefix, eg you can write Usually hledger accepts any unambiguous flag prefix, eg you can write
@ -731,29 +731,30 @@ quoting than you would at the command prompt.)
.PP .PP
Argument files are now superseded by.. Argument files are now superseded by..
.SS Config files .SS Config files
hledger looks for a \f[CR]hledger.conf\f[R] file (or hledger will read extra command line options from a
\f[CR].hledger.conf\f[R] in your home directory) in the current \f[CR]hledger.conf\f[R] config file.
directory, then parent directories, then your XDG config directory These will be inserted early in the command line, so your later options
(\f[CR]\[ti]/.config/hledger/\f[R]). can override them if needed.
Any command line options (or arguments) in this file will be added to The config file can contain general options (which will be used with all
your \f[CR]hledger\f[R] commands, near the start of the command line (so commands that support them), and command\-specific options (or
you can override them when needed). arguments).
hledger.conf.sample is an example, which you can install as
\f[CR]./hledger.conf\f[R] or \f[CR]$HOME/.hledger.conf\f[R].
.PP .PP
Or you can specify a config file with the \f[CR]\-\-conf\f[R] option. To be precise, hledger looks for \f[CR]hledger.conf\f[R] in the current
Or you can add a \f[CR]hledger \-\-conf\f[R] shebang line to a config directory or above, or in your home directory (with a dotted name,
file and make it executable. \f[CR]\[ti]/.hledger.conf\f[R]), or finally in your XDG config directory
(\f[CR]\[ti]/.config/hledger/hledger.conf\f[R]).
Or you can select a particular config file by using the
\f[CR]\-\-conf\f[R] option, or by adding a \f[CR]hledger \-\-conf\f[R]
shebang line to a config file and executing it like a script (see the
example file).
You can inspect the finding and processing of config files with
\f[CR]\-\-debug\f[R] or \f[CR]\-\-debug=8\f[R].
.PP .PP
A hledger config file contains command line options, to be used with all If you want to run hledger without a config file, to ensure standard
commands that support them, and optionally command\-specific options in defaults and behaviour, use the \f[CR]\-n/\-\-no\-conf\f[R] flag.
named sections. This is useful when troubleshooting problems or sharing examples.
hledger.conf.sample is a sample demonstrating the syntax; you can
install it as \f[CR]./hledger.conf\f[R] or
\f[CR]$HOME/.hledger.conf\f[R] and customise it.
.PP
You can disable config files entirely by running with the
\f[CR]\-n/\-\-no\-conf\f[R] flag.
This will ensure hledger runs with standard defaults, useful when
troubleshooting or when sharing examples with others.
.PP .PP
\f[I](Added in 1.40; experimental)\f[R] \f[I](Added in 1.40; experimental)\f[R]
.SH Output .SH Output

File diff suppressed because it is too large Load Diff

View File

@ -332,7 +332,7 @@ Options
--info show the manual with info --info show the manual with info
--man show the manual with man --man show the manual with man
--version show version information --version show version information
--debug=[1-9] show this level of debug output (default: 1) --debug=[1-9] show this much debug output (default: 1)
Usually hledger accepts any unambiguous flag prefix, eg you can write Usually hledger accepts any unambiguous flag prefix, eg you can write
--tl instead of --tldr or --dry instead of --dry-run. --tl instead of --tldr or --dry instead of --dry-run.
@ -568,26 +568,26 @@ Options
Argument files are now superseded by.. Argument files are now superseded by..
Config files Config files
hledger looks for a hledger.conf file (or .hledger.conf in your home hledger will read extra command line options from a hledger.conf config
directory) in the current directory, then parent directories, then your file. These will be inserted early in the command line, so your later
XDG config directory (~/.config/hledger/). Any command line options options can override them if needed. The config file can contain gen-
(or arguments) in this file will be added to your hledger commands, eral options (which will be used with all commands that support them),
near the start of the command line (so you can override them when and command-specific options (or arguments). hledger.conf.sample is an
needed). example, which you can install as ./hledger.conf or
$HOME/.hledger.conf.
Or you can specify a config file with the --conf option. Or you can To be precise, hledger looks for hledger.conf in the current directory
add a hledger --conf shebang line to a config file and make it exe- or above, or in your home directory (with a dotted name,
cutable. ~/.hledger.conf), or finally in your XDG config directory (~/.con-
fig/hledger/hledger.conf). Or you can select a particular config file
by using the --conf option, or by adding a hledger --conf shebang line
to a config file and executing it like a script (see the example file).
You can inspect the finding and processing of config files with --debug
or --debug=8.
A hledger config file contains command line options, to be used with If you want to run hledger without a config file, to ensure standard
all commands that support them, and optionally command-specific options defaults and behaviour, use the -n/--no-conf flag. This is useful when
in named sections. hledger.conf.sample is a sample demonstrating the troubleshooting problems or sharing examples.
syntax; you can install it as ./hledger.conf or $HOME/.hledger.conf and
customise it.
You can disable config files entirely by running with the -n/--no-conf
flag. This will ensure hledger runs with standard defaults, useful
when troubleshooting or when sharing examples with others.
(Added in 1.40; experimental) (Added in 1.40; experimental)