doc: update manuals

This commit is contained in:
Simon Michael 2021-09-21 15:46:55 -10:00
parent 1126b4b0dd
commit 416555b65a
9 changed files with 1157 additions and 1049 deletions

View File

@ -1,5 +1,5 @@
.TH "HLEDGER-UI" "1" "September 2021" "hledger-ui-1.22.99 " "hledger User Manuals" .TH "HLEDGER-UI" "1" "September 2021" "hledger-ui-1.23 " "hledger User Manuals"
@ -7,7 +7,7 @@
.PP .PP
hledger-ui is a terminal interface (TUI) for the hledger accounting hledger-ui is a terminal interface (TUI) for the hledger accounting
tool. tool.
This manual is for hledger-ui 1.22.99. This manual is for hledger-ui 1.23.
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\f[C]hledger-ui [OPTIONS] [QUERYARGS]\f[R] \f[C]hledger-ui [OPTIONS] [QUERYARGS]\f[R]
@ -185,6 +185,14 @@ terminal.
into \[aq]less -R\[aq]. into \[aq]less -R\[aq].
\[aq]never\[aq] or \[aq]no\[aq]: never. \[aq]never\[aq] or \[aq]no\[aq]: never.
A NO_COLOR environment variable overrides this. A NO_COLOR environment variable overrides this.
.TP
\f[B]\f[CB]--pretty[=WHEN]\f[B]\f[R]
Show prettier output, e.g.
using unicode box-drawing characters.
Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq],
\[aq]n\[aq], \[aq]always\[aq], \[aq]never\[aq] also work).
If you provide an argument you must use \[aq]=\[aq], e.g.
\[aq]--pretty=yes\[aq].
.PP .PP
When a reporting option appears more than once in the command line, the When a reporting option appears more than once in the command line, the
last one takes precedence. last one takes precedence.

View File

@ -12,7 +12,7 @@ hledger-ui(1)
************* *************
hledger-ui is a terminal interface (TUI) for the hledger accounting hledger-ui is a terminal interface (TUI) for the hledger accounting
tool. This manual is for hledger-ui 1.22.99. tool. This manual is for hledger-ui 1.23.
'hledger-ui [OPTIONS] [QUERYARGS]' 'hledger-ui [OPTIONS] [QUERYARGS]'
'hledger ui -- [OPTIONS] [QUERYARGS]' 'hledger ui -- [OPTIONS] [QUERYARGS]'
@ -204,6 +204,12 @@ the data.
color-supporting terminal. 'always' or 'yes': always, useful eg color-supporting terminal. 'always' or 'yes': always, useful eg
when piping output into 'less -R'. 'never' or 'no': never. A when piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this. NO_COLOR environment variable overrides this.
'--pretty[=WHEN]'
Show prettier output, e.g. using unicode box-drawing characters.
Accepts 'yes' (the default) or 'no' ('y', 'n', 'always', 'never'
also work). If you provide an argument you must use '=', e.g.
'-pretty=yes'.
When a reporting option appears more than once in the command line, When a reporting option appears more than once in the command line,
the last one takes precedence. the last one takes precedence.
@ -602,32 +608,32 @@ program is restarted.
 
Tag Table: Tag Table:
Node: Top221 Node: Top221
Node: OPTIONS1647 Node: OPTIONS1644
Ref: #options1744 Ref: #options1741
Node: KEYS6375 Node: KEYS6620
Ref: #keys6470 Ref: #keys6715
Node: SCREENS10541 Node: SCREENS10786
Ref: #screens10639 Ref: #screens10884
Node: Accounts screen10729 Node: Accounts screen10974
Ref: #accounts-screen10857 Ref: #accounts-screen11102
Node: Register screen13072 Node: Register screen13317
Ref: #register-screen13227 Ref: #register-screen13472
Node: Transaction screen15224 Node: Transaction screen15469
Ref: #transaction-screen15382 Ref: #transaction-screen15627
Node: Error screen16252 Node: Error screen16497
Ref: #error-screen16374 Ref: #error-screen16619
Node: TIPS16618 Node: TIPS16863
Ref: #tips16717 Ref: #tips16962
Node: Watch mode16769 Node: Watch mode17014
Ref: #watch-mode16886 Ref: #watch-mode17131
Node: Watch mode limitations17632 Node: Watch mode limitations17877
Ref: #watch-mode-limitations17773 Ref: #watch-mode-limitations18018
Node: ENVIRONMENT18909 Node: ENVIRONMENT19154
Ref: #environment19020 Ref: #environment19265
Node: FILES19827 Node: FILES20072
Ref: #files19926 Ref: #files20171
Node: BUGS20139 Node: BUGS20384
Ref: #bugs20216 Ref: #bugs20461
 
End Tag Table End Tag Table

View File

@ -5,7 +5,7 @@ HLEDGER-UI(1) hledger User Manuals HLEDGER-UI(1)
NAME NAME
hledger-ui is a terminal interface (TUI) for the hledger accounting hledger-ui is a terminal interface (TUI) for the hledger accounting
tool. This manual is for hledger-ui 1.22.99. tool. This manual is for hledger-ui 1.23.
SYNOPSIS SYNOPSIS
hledger-ui [OPTIONS] [QUERYARGS] hledger-ui [OPTIONS] [QUERYARGS]
@ -181,6 +181,12 @@ OPTIONS
piping output into 'less -R'. 'never' or 'no': never. A piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this. NO_COLOR environment variable overrides this.
--pretty[=WHEN]
Show prettier output, e.g. using unicode box-drawing charac-
ters. Accepts 'yes' (the default) or 'no' ('y', 'n', 'always',
'never' also work). If you provide an argument you must use
'=', e.g. '--pretty=yes'.
When a reporting option appears more than once in the command line, the When a reporting option appears more than once in the command line, the
last one takes precedence. last one takes precedence.
@ -512,4 +518,4 @@ SEE ALSO
hledger-ui-1.22.99 September 2021 HLEDGER-UI(1) hledger-ui-1.23 September 2021 HLEDGER-UI(1)

View File

@ -1,12 +1,12 @@
.TH "HLEDGER-WEB" "1" "September 2021" "hledger-web-1.22.99 " "hledger User Manuals" .TH "HLEDGER-WEB" "1" "September 2021" "hledger-web-1.23 " "hledger User Manuals"
.SH NAME .SH NAME
.PP .PP
hledger-web is a web interface (WUI) for the hledger accounting tool. hledger-web is a web interface (WUI) for the hledger accounting tool.
This manual is for hledger-web 1.22.99. This manual is for hledger-web 1.23.
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\f[C]hledger-web [OPTIONS]\f[R] \f[C]hledger-web [OPTIONS]\f[R]
@ -214,6 +214,14 @@ terminal.
into \[aq]less -R\[aq]. into \[aq]less -R\[aq].
\[aq]never\[aq] or \[aq]no\[aq]: never. \[aq]never\[aq] or \[aq]no\[aq]: never.
A NO_COLOR environment variable overrides this. A NO_COLOR environment variable overrides this.
.TP
\f[B]\f[CB]--pretty[=WHEN]\f[B]\f[R]
Show prettier output, e.g.
using unicode box-drawing characters.
Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq],
\[aq]n\[aq], \[aq]always\[aq], \[aq]never\[aq] also work).
If you provide an argument you must use \[aq]=\[aq], e.g.
\[aq]--pretty=yes\[aq].
.PP .PP
When a reporting option appears more than once in the command line, the When a reporting option appears more than once in the command line, the
last one takes precedence. last one takes precedence.

View File

@ -12,7 +12,7 @@ hledger-web(1)
************** **************
hledger-web is a web interface (WUI) for the hledger accounting tool. hledger-web is a web interface (WUI) for the hledger accounting tool.
This manual is for hledger-web 1.22.99. This manual is for hledger-web 1.23.
'hledger-web [OPTIONS]' 'hledger-web [OPTIONS]'
'hledger web -- [OPTIONS]' 'hledger web -- [OPTIONS]'
@ -230,6 +230,12 @@ before options, as shown in the synopsis above.
color-supporting terminal. 'always' or 'yes': always, useful eg color-supporting terminal. 'always' or 'yes': always, useful eg
when piping output into 'less -R'. 'never' or 'no': never. A when piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this. NO_COLOR environment variable overrides this.
'--pretty[=WHEN]'
Show prettier output, e.g. using unicode box-drawing characters.
Accepts 'yes' (the default) or 'no' ('y', 'n', 'always', 'never'
also work). If you provide an argument you must use '=', e.g.
'-pretty=yes'.
When a reporting option appears more than once in the command line, When a reporting option appears more than once in the command line,
the last one takes precedence. the last one takes precedence.
@ -611,22 +617,22 @@ awkward.
 
Tag Table: Tag Table:
Node: Top223 Node: Top223
Node: OPTIONS1889 Node: OPTIONS1886
Ref: #options1994 Ref: #options1991
Node: PERMISSIONS9657 Node: PERMISSIONS9902
Ref: #permissions9796 Ref: #permissions10041
Node: EDITING UPLOADING DOWNLOADING11008 Node: EDITING UPLOADING DOWNLOADING11253
Ref: #editing-uploading-downloading11189 Ref: #editing-uploading-downloading11434
Node: RELOADING12023 Node: RELOADING12268
Ref: #reloading12157 Ref: #reloading12402
Node: JSON API12590 Node: JSON API12835
Ref: #json-api12704 Ref: #json-api12949
Node: ENVIRONMENT18194 Node: ENVIRONMENT18439
Ref: #environment18310 Ref: #environment18555
Node: FILES19043 Node: FILES19288
Ref: #files19143 Ref: #files19388
Node: BUGS19356 Node: BUGS19601
Ref: #bugs19434 Ref: #bugs19679
 
End Tag Table End Tag Table

View File

@ -5,7 +5,7 @@ HLEDGER-WEB(1) hledger User Manuals HLEDGER-WEB(1)
NAME NAME
hledger-web is a web interface (WUI) for the hledger accounting tool. hledger-web is a web interface (WUI) for the hledger accounting tool.
This manual is for hledger-web 1.22.99. This manual is for hledger-web 1.23.
SYNOPSIS SYNOPSIS
hledger-web [OPTIONS] hledger-web [OPTIONS]
@ -204,6 +204,12 @@ OPTIONS
piping output into 'less -R'. 'never' or 'no': never. A piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this. NO_COLOR environment variable overrides this.
--pretty[=WHEN]
Show prettier output, e.g. using unicode box-drawing charac-
ters. Accepts 'yes' (the default) or 'no' ('y', 'n', 'always',
'never' also work). If you provide an argument you must use
'=', e.g. '--pretty=yes'.
When a reporting option appears more than once in the command line, the When a reporting option appears more than once in the command line, the
last one takes precedence. last one takes precedence.
@ -564,4 +570,4 @@ SEE ALSO
hledger-web-1.22.99 September 2021 HLEDGER-WEB(1) hledger-web-1.23 September 2021 HLEDGER-WEB(1)

View File

@ -1,6 +1,6 @@
.\"t .\"t
.TH "HLEDGER" "1" "September 2021" "hledger-1.22.99 " "hledger User Manuals" .TH "HLEDGER" "1" "September 2021" "hledger-1.23 " "hledger User Manuals"
@ -9,7 +9,7 @@
This is the command-line interface (CLI) for the hledger accounting This is the command-line interface (CLI) for the hledger accounting
tool. tool.
Here we also describe hledger\[aq]s concepts and file formats. Here we also describe hledger\[aq]s concepts and file formats.
This manual is for hledger 1.22.99. This manual is for hledger 1.23.
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\f[C]hledger\f[R] \f[C]hledger\f[R]
@ -207,6 +207,14 @@ terminal.
into \[aq]less -R\[aq]. into \[aq]less -R\[aq].
\[aq]never\[aq] or \[aq]no\[aq]: never. \[aq]never\[aq] or \[aq]no\[aq]: never.
A NO_COLOR environment variable overrides this. A NO_COLOR environment variable overrides this.
.TP
\f[B]\f[CB]--pretty[=WHEN]\f[B]\f[R]
Show prettier output, e.g.
using unicode box-drawing characters.
Accepts \[aq]yes\[aq] (the default) or \[aq]no\[aq] (\[aq]y\[aq],
\[aq]n\[aq], \[aq]always\[aq], \[aq]never\[aq] also work).
If you provide an argument you must use \[aq]=\[aq], e.g.
\[aq]--pretty=yes\[aq].
.PP .PP
When a reporting option appears more than once in the command line, the When a reporting option appears more than once in the command line, the
last one takes precedence. last one takes precedence.
@ -528,7 +536,7 @@ Default: the full terminal width.
.PP .PP
\f[B]NO_COLOR\f[R] If this variable exists with any value, hledger will \f[B]NO_COLOR\f[R] If this variable exists with any value, hledger will
not use ANSI color codes in terminal output. not use ANSI color codes in terminal output.
This overrides the --color/--colour option. This is overriden by the --color/--colour option.
.SH DATA FILES .SH DATA FILES
.PP .PP
hledger reads transactions from one or more data files. hledger reads transactions from one or more data files.
@ -2308,6 +2316,24 @@ hledger can optionally produce debug output (if enabled with
\f[C]-o/--output-file\f[R]. \f[C]-o/--output-file\f[R].
If you need to capture it, use shell redirects, eg: If you need to capture it, use shell redirects, eg:
\f[C]hledger bal --debug=3 >file 2>&1\f[R]. \f[C]hledger bal --debug=3 >file 2>&1\f[R].
.SS Output styling
.PP
hledger commands can produce colour output when the terminal supports
it.
This is controlled by the \f[C]--color/--colour\f[R] option: - if the
\f[C]--color/--colour\f[R] option is given a value of \f[C]yes\f[R] or
\f[C]always\f[R] (or \f[C]no\f[R] or \f[C]never\f[R]), colour will (or
will not) be used; - otherwise, if the \f[C]NO_COLOR\f[R] environment
variable is set, colour will not be used; - otherwise, colour will be
used if the output (terminal or file) supports it.
.PP
hledger commands can also use unicode box-drawing characters to produce
prettier tables and output.
This is controlled by the \f[C]--pretty\f[R] option: - if the
\f[C]--pretty\f[R] option is given a value of \f[C]yes\f[R] or
\f[C]always\f[R] (or \f[C]no\f[R] or \f[C]never\f[R]), unicode
characters will (or will not) be used; - otherwise, unicode characters
will not be used.
.SS Output format .SS Output format
.PP .PP
Some commands (print, register, the balance commands) offer a choice of Some commands (print, register, the balance commands) offer a choice of

File diff suppressed because it is too large Load Diff

View File

@ -6,7 +6,7 @@ HLEDGER(1) hledger User Manuals HLEDGER(1)
NAME NAME
This is the command-line interface (CLI) for the hledger accounting This is the command-line interface (CLI) for the hledger accounting
tool. Here we also describe hledger's concepts and file formats. This tool. Here we also describe hledger's concepts and file formats. This
manual is for hledger 1.22.99. manual is for hledger 1.23.
SYNOPSIS SYNOPSIS
hledger hledger
@ -194,6 +194,12 @@ OPTIONS
piping output into 'less -R'. 'never' or 'no': never. A piping output into 'less -R'. 'never' or 'no': never. A
NO_COLOR environment variable overrides this. NO_COLOR environment variable overrides this.
--pretty[=WHEN]
Show prettier output, e.g. using unicode box-drawing charac-
ters. Accepts 'yes' (the default) or 'no' ('y', 'n', 'always',
'never' also work). If you provide an argument you must use
'=', e.g. '--pretty=yes'.
When a reporting option appears more than once in the command line, the When a reporting option appears more than once in the command line, the
last one takes precedence. last one takes precedence.
@ -421,7 +427,7 @@ ENVIRONMENT
full terminal width. full terminal width.
NO_COLOR If this variable exists with any value, hledger will not use NO_COLOR If this variable exists with any value, hledger will not use
ANSI color codes in terminal output. This overrides the ANSI color codes in terminal output. This is overriden by the
--color/--colour option. --color/--colour option.
DATA FILES DATA FILES
@ -546,8 +552,6 @@ TIME PERIODS
201813 6 digits with an invalid month is parsed as start of 201813 6 digits with an invalid month is parsed as start of
6-digit year 6-digit year
20181301 8 digits with an invalid month is parsed as start of 20181301 8 digits with an invalid month is parsed as start of
8-digit year 8-digit year
20181232 8 digits with an invalid day gives an error 20181232 8 digits with an invalid day gives an error
@ -681,11 +685,11 @@ TIME PERIODS
earliest or latest transaction in your journal: earliest or latest transaction in your journal:
-p "from 2009/1/1" everything after january -p "from 2009/1/1" everything after january
1, 2009 1, 2009
-p "from 2009/1" the same -p "from 2009/1" the same
-p "from 2009" the same -p "from 2009" the same
-p "to 2009" everything before january -p "to 2009" everything before january
1, 2009 1, 2009
@ -1318,6 +1322,7 @@ VALUATION
Related: #329, #1083. Related: #329, #1083.
Report -B, --cost -V, -X --value=then --value=end --value=DATE, Report -B, --cost -V, -X --value=then --value=end --value=DATE,
type --value=now type --value=now
----------------------------------------------------------------------------------------------- -----------------------------------------------------------------------------------------------
@ -1376,13 +1381,6 @@ VALUATION
is, bs postings in period at respec- each period, sums of post- is, bs postings in period at respec- each period, sums of post-
--change, cf period tive posting valued at ings --change, cf period tive posting valued at ings
--change) dates period ends --change) dates period ends
end balances sums of same as sums of values of period end value at end balances sums of same as sums of values of period end value at
(bal -H, is costs of --value=end postings from balances, DATE/today of (bal -H, is costs of --value=end postings from balances, DATE/today of
--H, bs, cf) postings before period valued at sums of post- --H, bs, cf) postings before period valued at sums of post-
@ -1393,6 +1391,10 @@ VALUATION
budget like balance like balance like balance like bal- like balance budget like balance like balance like balance like bal- like balance
amounts changes/end changes/end changes/end bal- ances changes/end amounts changes/end changes/end changes/end bal- ances changes/end
(--budget) balances balances ances balances (--budget) balances balances ances balances
row totals, sums, aver- sums, aver- sums, averages of sums, aver- sums, aver- row totals, sums, aver- sums, aver- sums, averages of sums, aver- sums, aver-
row averages ages of dis- ages of dis- displayed values ages of dis- ages of dis- row averages ages of dis- ages of dis- displayed values ages of dis- ages of dis-
(-T, -A) played val- played val- played val- played values (-T, -A) played val- played val- played val- played values
@ -1509,6 +1511,20 @@ OUTPUT
file. If you need to capture it, use shell redirects, eg: hledger bal file. If you need to capture it, use shell redirects, eg: hledger bal
--debug=3 >file 2>&1. --debug=3 >file 2>&1.
Output styling
hledger commands can produce colour output when the terminal supports
it. This is controlled by the --color/--colour option: - if the
--color/--colour option is given a value of yes or always (or no or
never), colour will (or will not) be used; - otherwise, if the NO_COLOR
environment variable is set, colour will not be used; - otherwise,
colour will be used if the output (terminal or file) supports it.
hledger commands can also use unicode box-drawing characters to produce
prettier tables and output. This is controlled by the --pretty option:
- if the --pretty option is given a value of yes or always (or no or
never), unicode characters will (or will not) be used; - otherwise,
unicode characters will not be used.
Output format Output format
Some commands (print, register, the balance commands) offer a choice of Some commands (print, register, the balance commands) offer a choice of
output format. In addition to the usual plain text format (txt), there output format. In addition to the usual plain text format (txt), there
@ -2335,6 +2351,8 @@ COMMANDS
--change change in period sum of posting- period-end DATE-value of --change change in period sum of posting- period-end DATE-value of
date market val- value of change change in date market val- value of change change in
ues in period in period period ues in period in period period
--cumu- change from sum of posting- period-end DATE-value of --cumu- change from sum of posting- period-end DATE-value of
lative report start to date market val- value of change change from lative report start to date market val- value of change change from
period end ues from report from report report start period end ues from report from report report start
@ -2960,8 +2978,6 @@ COMMANDS
-e 2021-01-01 end dates are exclusive -e 2021-01-01 end dates are exclusive
-e 2021 equivalent, per smart -e 2021 equivalent, per smart
dates dates
-p 2020 equivalent, the period's -p 2020 equivalent, the period's
begin date is ignored begin date is ignored
date:2020 equivalent query date:2020 equivalent query
@ -4794,11 +4810,6 @@ JOURNAL FORMAT
rent file or end rent file or end
directive directive
commod- format declare a commodity and its number notation: commod- format declare a commodity and its number notation:
ity number notation & display following entries ity number notation & display following entries
style until end of cur- style until end of cur-
@ -5737,6 +5748,8 @@ CSV FORMAT
newest-first disambiguate record order when there's only newest-first disambiguate record order when there's only
one date one date
include inline another CSV rules file include inline another CSV rules file
balance-type choose which type of balance assignments to balance-type choose which type of balance assignments to
use use
@ -7432,4 +7445,4 @@ SEE ALSO
hledger-1.22.99 September 2021 HLEDGER(1) hledger-1.23 September 2021 HLEDGER(1)