simonmichael/hledger
1
1
Fork 0
mirror of https://github.com/simonmichael/hledger.git synced 2024-07-08 19:36:27 +03:00
Code Issues Projects Releases Wiki Activity

;doc: update manuals

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hledger-ui/hledger-ui.1
View File

@ -146,7 +146,7 @@ General help flags:
\-\-info show the manual with info
\-\-man show the manual with man
\-\-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
.PP
With hledger\-ui, the \f[CR]\-\-debug\f[R] option sends debug output to

58
hledger-ui/hledger-ui.info
View File

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

End Tag Table

2
hledger-ui/hledger-ui.txt
View File

@ -135,7 +135,7 @@ OPTIONS
--info show the manual with info
--man show the manual with man
--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
hledger-ui.log file in the current directory.

2
hledger-web/hledger-web.1
View File

@ -197,7 +197,7 @@ General help flags:
\-\-info show the manual with info
\-\-man show the manual with man
\-\-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
.PP
hledger\-web shows accounts with zero balances by default (like

34
hledger-web/hledger-web.info
View File

@ -202,7 +202,7 @@ General help flags:
--info show the manual with info
--man show the manual with man
--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-ui', and unlike 'hledger'). Using the '-E/--empty' flag will
@ -525,22 +525,22 @@ Tag Table:
Node: Top223
Node: OPTIONS2569
Ref: #options2674
Node: PERMISSIONS10952
Ref: #permissions11091
Node: EDITING UPLOADING DOWNLOADING12303
Ref: #editing-uploading-downloading12484
Node: RELOADING13318
Ref: #reloading13452
Node: JSON API13885
Ref: #json-api14000
Node: DEBUG OUTPUT19534
Ref: #debug-output19659
Node: Debug output19686
Ref: #debug-output-119787
Node: ENVIRONMENT20204
Ref: #environment20323
Node: BUGS20440
Ref: #bugs20524
Node: PERMISSIONS10948
Ref: #permissions11087
Node: EDITING UPLOADING DOWNLOADING12299
Ref: #editing-uploading-downloading12480
Node: RELOADING13314
Ref: #reloading13448
Node: JSON API13881
Ref: #json-api13996
Node: DEBUG OUTPUT19530
Ref: #debug-output19655
Node: Debug output19682
Ref: #debug-output-119783
Node: ENVIRONMENT20200
Ref: #environment20319
Node: BUGS20436
Ref: #bugs20520

End Tag Table

2
hledger-web/hledger-web.txt
View File

@ -179,7 +179,7 @@ OPTIONS
--info show the manual with info
--man show the manual with man
--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-ui, and unlike hledger). Using the -E/--empty flag will re-

45
hledger/hledger.1
View File

@ -431,7 +431,7 @@ General help flags:
\-\-info show the manual with info
\-\-man show the manual with man
\-\-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
.PP
Usually hledger accepts any unambiguous flag prefix, eg you can write
@ -731,29 +731,30 @@ quoting than you would at the command prompt.)
.PP
Argument files are now superseded by..
.SS Config files
hledger looks for a \f[CR]hledger.conf\f[R] file (or
\f[CR].hledger.conf\f[R] in your home directory) in the current
directory, then parent directories, then your XDG config directory
(\f[CR]\[ti]/.config/hledger/\f[R]).
Any command line options (or arguments) in this file will be added to
your \f[CR]hledger\f[R] commands, near the start of the command line (so
you can override them when needed).
hledger will read extra command line options from a
\f[CR]hledger.conf\f[R] config file.
These will be inserted early in the command line, so your later options
can override them if needed.
The config file can contain general options (which will be used with all
commands that support them), and command\-specific options (or
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
Or you can specify a config file with the \f[CR]\-\-conf\f[R] option.
Or you can add a \f[CR]hledger \-\-conf\f[R] shebang line to a config
file and make it executable.
To be precise, hledger looks for \f[CR]hledger.conf\f[R] in the current
directory or above, or in your home directory (with a dotted name,
\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
A hledger config file contains command line options, to be used with all
commands that support them, and optionally command\-specific options in
named sections.
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.
If you want to run hledger without a config file, to ensure standard
defaults and behaviour, use the \f[CR]\-n/\-\-no\-conf\f[R] flag.
This is useful when troubleshooting problems or sharing examples.
.PP
\f[I](Added in 1.40; experimental)\f[R]
.SH Output

1394
hledger/hledger.info
View File

File diff suppressed because it is too large Load Diff

38
hledger/hledger.txt
View File

@ -332,7 +332,7 @@ Options
--info show the manual with info
--man show the manual with man
--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
--tl instead of --tldr or --dry instead of --dry-run.
@ -568,26 +568,26 @@ Options
Argument files are now superseded by..
Config files
hledger looks for a hledger.conf file (or .hledger.conf in your home
directory) in the current directory, then parent directories, then your
XDG config directory (~/.config/hledger/). Any command line options
(or arguments) in this file will be added to your hledger commands,
near the start of the command line (so you can override them when
needed).
hledger will read extra command line options from a hledger.conf config
file. These will be inserted early in the command line, so your later
options can override them if needed. The config file can contain gen-
eral options (which will be used with all commands that support them),
and command-specific options (or arguments). hledger.conf.sample is an
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
add a hledger --conf shebang line to a config file and make it exe-
cutable.
To be precise, hledger looks for hledger.conf in the current directory
or above, or in your home directory (with a dotted name,
~/.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
all commands that support them, and optionally command-specific options
in named sections. hledger.conf.sample is a sample demonstrating the
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.
If you want to run hledger without a config file, to ensure standard
defaults and behaviour, use the -n/--no-conf flag. This is useful when
troubleshooting problems or sharing examples.
(Added in 1.40; experimental)