;doc: update manuals

This commit is contained in:
Simon Michael 2022-10-01 16:09:26 -10:00
parent ae8d297396
commit 928cc6d615
13 changed files with 847 additions and 684 deletions

View File

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

View File

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

View File

@ -1,5 +1,5 @@
.TH "HLEDGER-UI" "1" "September 2022" "hledger-ui-1.27 " "hledger User Manuals"
.TH "HLEDGER-UI" "1" "October 2022" "hledger-ui-1.27.99 " "hledger User Manuals"
@ -7,7 +7,7 @@
.PP
hledger-ui is a terminal interface (TUI) for the hledger accounting
tool.
This manual is for hledger-ui 1.27.
This manual is for hledger-ui 1.27.99.
.SH SYNOPSIS
.PP
\f[C]hledger-ui [OPTIONS] [QUERYARGS]\f[R]
@ -335,6 +335,10 @@ reliably reset to normal mode.
.PP
Additional screen-specific keys are described below.
.SH SCREENS
.SS Menu screen
.PP
The top-most screen, currently with just one menu item and not shown by
default.
.SS Accounts screen
.PP
This is normally the first screen displayed.
@ -389,6 +393,7 @@ balances are shown (hledger-ui shows zero items by default, unlike
command-line hledger).
.PP
Press \f[C]RIGHT\f[R] to view an account\[aq]s transactions register.
Or, \f[C]LEFT\f[R] to see the menu screen.
.SS Register screen
.PP
This screen shows the transactions affecting a particular account, like
@ -455,6 +460,25 @@ They will vary depending on which account register you came from
The #N number preceding them is the transaction\[aq]s position within
the complete unfiltered journal, which is a more stable id (at least
until the next reload).
.SS Balance sheet accounts screen
.PP
This is like the accounts screen except:
.IP \[bu] 2
it shows only asset, liability and equity accounts (see account types)
.IP \[bu] 2
it always shows historical end balances on some date (not balance
changes).
.PP
It corresponds to the \f[C]hledger balancesheet\f[R] command.
.SS Income statement accounts screen
.PP
Like the accounts screen except:
.IP \[bu] 2
it shows only revenue and expense accounts
.IP \[bu] 2
it always shows balance changes in some period (not end balances).
.PP
It corresponds to the \f[C]hledger incomestatement\f[R] command.
.SS Error screen
.PP
This screen will appear if there is a problem, such as a parse error,

View File

@ -12,7 +12,7 @@ hledger-ui(1)
*************
hledger-ui is a terminal interface (TUI) for the hledger accounting
tool. This manual is for hledger-ui 1.27.
tool. This manual is for hledger-ui 1.27.99.
'hledger-ui [OPTIONS] [QUERYARGS]'
'hledger ui -- [OPTIONS] [QUERYARGS]'
@ -354,15 +354,27 @@ File: hledger-ui.info, Node: SCREENS, Next: TIPS, Prev: KEYS, Up: Top
* Menu:
* Menu screen::
* Accounts screen::
* Register screen::
* Transaction screen::
* Balance sheet accounts screen::
* Income statement accounts screen::
* Error screen::

File: hledger-ui.info, Node: Accounts screen, Next: Register screen, Up: SCREENS
File: hledger-ui.info, Node: Menu screen, Next: Accounts screen, Up: SCREENS
4.1 Accounts screen
4.1 Menu screen
===============
The top-most screen, currently with just one menu item and not shown by
default.

File: hledger-ui.info, Node: Accounts screen, Next: Register screen, Prev: Menu screen, Up: SCREENS
4.2 Accounts screen
===================
This is normally the first screen displayed. It lists accounts and
@ -408,12 +420,13 @@ is removed.)
balances are shown (hledger-ui shows zero items by default, unlike
command-line hledger).
Press 'RIGHT' to view an account's transactions register.
Press 'RIGHT' to view an account's transactions register. Or, 'LEFT'
to see the menu screen.

File: hledger-ui.info, Node: Register screen, Next: Transaction screen, Prev: Accounts screen, Up: SCREENS
4.2 Register screen
4.3 Register screen
===================
This screen shows the transactions affecting a particular account, like
@ -457,9 +470,9 @@ command-line hledger).
Press 'RIGHT' to view the selected transaction in detail.

File: hledger-ui.info, Node: Transaction screen, Next: Error screen, Prev: Register screen, Up: SCREENS
File: hledger-ui.info, Node: Transaction screen, Next: Balance sheet accounts screen, Prev: Register screen, Up: SCREENS
4.3 Transaction screen
4.4 Transaction screen
======================
This screen shows a single transaction, as a general journal entry,
@ -481,9 +494,37 @@ unfiltered journal, which is a more stable id (at least until the next
reload).

File: hledger-ui.info, Node: Error screen, Prev: Transaction screen, Up: SCREENS
File: hledger-ui.info, Node: Balance sheet accounts screen, Next: Income statement accounts screen, Prev: Transaction screen, Up: SCREENS
4.4 Error screen
4.5 Balance sheet accounts screen
=================================
This is like the accounts screen except:
* it shows only asset, liability and equity accounts (see account
types)
* it always shows historical end balances on some date (not balance
changes).
It corresponds to the 'hledger balancesheet' command.

File: hledger-ui.info, Node: Income statement accounts screen, Next: Error screen, Prev: Balance sheet accounts screen, Up: SCREENS
4.6 Income statement accounts screen
====================================
Like the accounts screen except:
* it shows only revenue and expense accounts
* it always shows balance changes in some period (not end balances).
It corresponds to the 'hledger incomestatement' command.

File: hledger-ui.info, Node: Error screen, Prev: Income statement accounts screen, Up: SCREENS
4.7 Error screen
================
This screen will appear if there is a problem, such as a parse error,
@ -640,34 +681,40 @@ program is restarted.

Tag Table:
Node: Top221
Node: OPTIONS1654
Ref: #options1752
Node: MOUSE6634
Ref: #mouse6729
Node: KEYS7011
Ref: #keys7104
Node: SCREENS11190
Ref: #screens11288
Node: Accounts screen11378
Ref: #accounts-screen11506
Node: Register screen13845
Ref: #register-screen14000
Node: Transaction screen15984
Ref: #transaction-screen16142
Node: Error screen17012
Ref: #error-screen17134
Node: TIPS17378
Ref: #tips17477
Node: Watch mode17529
Ref: #watch-mode17646
Node: Watch mode limitations18396
Ref: #watch-mode-limitations18537
Node: ENVIRONMENT19673
Ref: #environment19784
Node: FILES21169
Ref: #files21268
Node: BUGS21481
Ref: #bugs21558
Node: OPTIONS1657
Ref: #options1755
Node: MOUSE6637
Ref: #mouse6732
Node: KEYS7014
Ref: #keys7107
Node: SCREENS11193
Ref: #screens11291
Node: Menu screen11468
Ref: #menu-screen11584
Node: Accounts screen11666
Ref: #accounts-screen11814
Node: Register screen14189
Ref: #register-screen14344
Node: Transaction screen16328
Ref: #transaction-screen16503
Node: Balance sheet accounts screen17373
Ref: #balance-sheet-accounts-screen17587
Node: Income statement accounts screen17855
Ref: #income-statement-accounts-screen18069
Node: Error screen18285
Ref: #error-screen18421
Node: TIPS18665
Ref: #tips18764
Node: Watch mode18816
Ref: #watch-mode18933
Node: Watch mode limitations19683
Ref: #watch-mode-limitations19824
Node: ENVIRONMENT20960
Ref: #environment21071
Node: FILES22456
Ref: #files22555
Node: BUGS22768
Ref: #bugs22845

End Tag Table

View File

@ -5,7 +5,7 @@ HLEDGER-UI(1) hledger User Manuals HLEDGER-UI(1)
NAME
hledger-ui is a terminal interface (TUI) for the hledger accounting
tool. This manual is for hledger-ui 1.27.
tool. This manual is for hledger-ui 1.27.99.
SYNOPSIS
hledger-ui [OPTIONS] [QUERYARGS]
@ -308,50 +308,55 @@ KEYS
Additional screen-specific keys are described below.
SCREENS
Menu screen
The top-most screen, currently with just one menu item and not shown by
default.
Accounts screen
This is normally the first screen displayed. It lists accounts and
their balances, like hledger's balance command. By default, it shows
all accounts and their latest ending balances (including the balances
of subaccounts). Accounts which have been declared with an account
directive are also listed, even if not yet used (except for empty par-
ent accounts). If you specify a query on the command line, it shows
This is normally the first screen displayed. It lists accounts and
their balances, like hledger's balance command. By default, it shows
all accounts and their latest ending balances (including the balances
of subaccounts). Accounts which have been declared with an account
directive are also listed, even if not yet used (except for empty par-
ent accounts). If you specify a query on the command line, it shows
just the matched accounts and the balances from matched transactions.
Account names are shown as a flat list by default; press t to toggle
tree mode. In list mode, account balances are exclusive of subac-
counts, except where subaccounts are hidden by a depth limit (see
below). In tree mode, all account balances are inclusive of subac-
Account names are shown as a flat list by default; press t to toggle
tree mode. In list mode, account balances are exclusive of subac-
counts, except where subaccounts are hidden by a depth limit (see
below). In tree mode, all account balances are inclusive of subac-
counts.
To see less detail, press a number key, 1 to 9, to set a depth limit.
To see less detail, press a number key, 1 to 9, to set a depth limit.
Or use - to decrease and +/= to increase the depth limit. 0 shows even
less detail, collapsing all accounts to a single total. To remove the
depth limit, set it higher than the maximum account depth, or press
less detail, collapsing all accounts to a single total. To remove the
depth limit, set it higher than the maximum account depth, or press
ESCAPE.
H toggles between showing historical balances or period balances. His-
torical balances (the default) are ending balances at the end of the
report period, taking into account all transactions before that date
(filtered by the filter query if any), including transactions before
the start of the report period. In other words, historical balances
are what you would see on a bank statement for that account (unless
disturbed by a filter query). Period balances ignore transactions
torical balances (the default) are ending balances at the end of the
report period, taking into account all transactions before that date
(filtered by the filter query if any), including transactions before
the start of the report period. In other words, historical balances
are what you would see on a bank statement for that account (unless
disturbed by a filter query). Period balances ignore transactions
before the report start date, so they show the change in balance during
the report period. They are more useful eg when viewing a time log.
U toggles filtering by unmarked status, including or excluding unmarked
postings in the balances. Similarly, P toggles pending postings, and C
toggles cleared postings. (By default, balances include all postings;
if you activate one or two status filters, only those postings are
toggles cleared postings. (By default, balances include all postings;
if you activate one or two status filters, only those postings are
included; and if you activate all three, the filter is removed.)
R toggles real mode, in which virtual postings are ignored.
z toggles nonzero mode, in which only accounts with nonzero balances
are shown (hledger-ui shows zero items by default, unlike command-line
z toggles nonzero mode, in which only accounts with nonzero balances
are shown (hledger-ui shows zero items by default, unlike command-line
hledger).
Press RIGHT to view an account's transactions register.
Press RIGHT to view an account's transactions register. Or, LEFT to
see the menu screen.
Register screen
This screen shows the transactions affecting a particular account, like
@ -411,6 +416,26 @@ SCREENS
them is the transaction's position within the complete unfiltered jour-
nal, which is a more stable id (at least until the next reload).
Balance sheet accounts screen
This is like the accounts screen except:
o it shows only asset, liability and equity accounts (see account
types)
o it always shows historical end balances on some date (not balance
changes).
It corresponds to the hledger balancesheet command.
Income statement accounts screen
Like the accounts screen except:
o it shows only revenue and expense accounts
o it always shows balance changes in some period (not end balances).
It corresponds to the hledger incomestatement command.
Error screen
This screen will appear if there is a problem, such as a parse error,
when you press g to reload. Once you have fixed the problem, press g
@ -549,4 +574,4 @@ SEE ALSO
hledger-ui-1.27 September 2022 HLEDGER-UI(1)
hledger-ui-1.27.99 October 2022 HLEDGER-UI(1)

View File

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

View File

@ -1,12 +1,12 @@
.TH "HLEDGER-WEB" "1" "September 2022" "hledger-web-1.27 " "hledger User Manuals"
.TH "HLEDGER-WEB" "1" "October 2022" "hledger-web-1.27.99 " "hledger User Manuals"
.SH NAME
.PP
hledger-web is a web interface (WUI) for the hledger accounting tool.
This manual is for hledger-web 1.27.
This manual is for hledger-web 1.27.99.
.SH SYNOPSIS
.PP
\f[C]hledger-web [OPTIONS]\f[R]

View File

@ -12,7 +12,7 @@ hledger-web(1)
**************
hledger-web is a web interface (WUI) for the hledger accounting tool.
This manual is for hledger-web 1.27.
This manual is for hledger-web 1.27.99.
'hledger-web [OPTIONS]'
'hledger web -- [OPTIONS]'
@ -632,22 +632,22 @@ awkward.

Tag Table:
Node: Top223
Node: OPTIONS1886
Ref: #options1991
Node: PERMISSIONS9902
Ref: #permissions10041
Node: EDITING UPLOADING DOWNLOADING11253
Ref: #editing-uploading-downloading11434
Node: RELOADING12268
Ref: #reloading12402
Node: JSON API12835
Ref: #json-api12949
Node: ENVIRONMENT18439
Ref: #environment18555
Node: FILES19866
Ref: #files19966
Node: BUGS20179
Ref: #bugs20257
Node: OPTIONS1889
Ref: #options1994
Node: PERMISSIONS9905
Ref: #permissions10044
Node: EDITING UPLOADING DOWNLOADING11256
Ref: #editing-uploading-downloading11437
Node: RELOADING12271
Ref: #reloading12405
Node: JSON API12838
Ref: #json-api12952
Node: ENVIRONMENT18442
Ref: #environment18558
Node: FILES19869
Ref: #files19969
Node: BUGS20182
Ref: #bugs20260

End Tag Table

View File

@ -5,7 +5,7 @@ HLEDGER-WEB(1) hledger User Manuals HLEDGER-WEB(1)
NAME
hledger-web is a web interface (WUI) for the hledger accounting tool.
This manual is for hledger-web 1.27.
This manual is for hledger-web 1.27.99.
SYNOPSIS
hledger-web [OPTIONS]
@ -586,4 +586,4 @@ SEE ALSO
hledger-web-1.27 September 2022 HLEDGER-WEB(1)
hledger-web-1.27.99 October 2022 HLEDGER-WEB(1)

View File

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

View File

@ -1,6 +1,6 @@
.\"t
.TH "HLEDGER" "1" "September 2022" "hledger-1.27 " "hledger User Manuals"
.TH "HLEDGER" "1" "October 2022" "hledger-1.27.99 " "hledger User Manuals"
@ -9,7 +9,7 @@
This is the command-line interface (CLI) for the hledger accounting
tool.
Here we also describe hledger\[aq]s concepts and file formats.
This manual is for hledger 1.27.
This manual is for hledger 1.27.99.
.SH SYNOPSIS
.PP
\f[C]hledger\f[R]
@ -3281,7 +3281,7 @@ backward.
Input prompts are displayed in a different colour when the terminal
supports it.
.PP
Example (see the tutorial for a detailed explanation):
Example (see https://hledger.org/add.html for a detailed tutorial):
.IP
.nf
\f[C]
@ -9781,8 +9781,10 @@ date-format DATEFMT
This is a helper for the \f[C]date\f[R] (and \f[C]date2\f[R]) fields.
If your CSV dates are not formatted like \f[C]YYYY-MM-DD\f[R],
\f[C]YYYY/MM/DD\f[R] or \f[C]YYYY.MM.DD\f[R], you\[aq]ll need to add a
date-format rule describing them with a strptime date parsing pattern,
which must parse the CSV date value completely.
date-format rule describing them with a strptime-style date parsing
pattern - see
https://hackage.haskell.org/package/time/docs/Data-Time-Format.html#v:formatTime.
The pattern must parse the CSV date value completely.
Some examples:
.IP
.nf
@ -9814,17 +9816,41 @@ date-format %Y-%h-%d
date-format %-m/%-d/%Y %l:%M %p some other junk
\f[R]
.fi
.SS \f[C]timezone\f[R]
.IP
.nf
\f[C]
timezone TIMEZONE
\f[R]
.fi
.PP
For the supported strptime syntax, see:
.PD 0
.P
.PD
https://hackage.haskell.org/package/time/docs/Data-Time-Format.html#v:formatTime
When CSV contains date-times that are implicitly in some time zone other
than yours, but containing no explicit time zone information, you can
use this rule to declare the CSV\[aq]s native time zone, which helps
prevent off-by-one dates.
.PP
Note that although you can parse date-times which include a time zone,
that time zone is ignored; it will not change the date that is parsed.
This means when reading CSV data with times not in your local time zone,
dates can be \[dq]off by one\[dq].
When the CSV date-times do contain time zone information, you don\[aq]t
need this rule; instead, use \f[C]%Z\f[R] in \f[C]date-format\f[R] (or
\f[C]%z\f[R], \f[C]%EZ\f[R], \f[C]%Ez\f[R]; see the formatTime link
above).
.PP
In either of these cases, hledger will do a time-zone-aware conversion,
localising the CSV date-times to your current system time zone.
If you prefer to localise to some other time zone, eg for
reproducibility, you can (on unix at least) set the output timezone with
the TZ environment variable, eg:
.IP
.nf
\f[C]
$ TZ=HST hledger print -f foo.csv # or TZ=HST hledger import foo.csv
\f[R]
.fi
.PP
\f[C]timezone\f[R] currently does not understand timezone names, except
\[dq]UTC\[dq], \[dq]GMT\[dq], \[dq]EST\[dq], \[dq]EDT\[dq],
\[dq]CST\[dq], \[dq]CDT\[dq], \[dq]MST\[dq], \[dq]MDT\[dq],
\[dq]PST\[dq], or \[dq]PDT\[dq].
For others, use numeric format: +HHMM or -HHMM.
.SS \f[C]decimal-mark\f[R]
.IP
.nf

File diff suppressed because it is too large Load Diff

View File

@ -6,7 +6,7 @@ HLEDGER(1) hledger User Manuals HLEDGER(1)
NAME
This is the command-line interface (CLI) for the hledger accounting
tool. Here we also describe hledger's concepts and file formats. This
manual is for hledger 1.27.
manual is for hledger 1.27.99.
SYNOPSIS
hledger
@ -2202,7 +2202,7 @@ COMMANDS
o Input prompts are displayed in a different colour when the terminal
supports it.
Example (see the tutorial for a detailed explanation):
Example (see https://hledger.org/add.html for a detailed tutorial):
$ hledger add
Adding transactions to journal file /src/hledger/examples/sample.journal
@ -7079,9 +7079,10 @@ CSV FORMAT
This is a helper for the date (and date2) fields. If your CSV dates
are not formatted like YYYY-MM-DD, YYYY/MM/DD or YYYY.MM.DD, you'll
need to add a date-format rule describing them with a strptime date
parsing pattern, which must parse the CSV date value completely. Some
examples:
need to add a date-format rule describing them with a strptime-style
date parsing pattern - see https://hackage.haskell.org/pack-
age/time/docs/Data-Time-Format.html#v:formatTime. The pattern must
parse the CSV date value completely. Some examples:
# MM/DD/YY
date-format %m/%d/%y
@ -7097,14 +7098,29 @@ CSV FORMAT
# Note the time and junk must be fully parsed, though only the date is used.
date-format %-m/%-d/%Y %l:%M %p some other junk
For the supported strptime syntax, see:
https://hackage.haskell.org/package/time/docs/Data-Time-For-
mat.html#v:formatTime
timezone
timezone TIMEZONE
Note that although you can parse date-times which include a time zone,
that time zone is ignored; it will not change the date that is parsed.
This means when reading CSV data with times not in your local time
zone, dates can be "off by one".
When CSV contains date-times that are implicitly in some time zone
other than yours, but containing no explicit time zone information, you
can use this rule to declare the CSV's native time zone, which helps
prevent off-by-one dates.
When the CSV date-times do contain time zone information, you don't
need this rule; instead, use %Z in date-format (or %z, %EZ, %Ez; see
the formatTime link above).
In either of these cases, hledger will do a time-zone-aware conversion,
localising the CSV date-times to your current system time zone. If you
prefer to localise to some other time zone, eg for reproducibility, you
can (on unix at least) set the output timezone with the TZ environment
variable, eg:
$ TZ=HST hledger print -f foo.csv # or TZ=HST hledger import foo.csv
timezone currently does not understand timezone names, except "UTC",
"GMT", "EST", "EDT", "CST", "CDT", "MST", "MDT", "PST", or "PDT". For
others, use numeric format: +HHMM or -HHMM.
decimal-mark
decimal-mark .
@ -8155,4 +8171,4 @@ SEE ALSO
hledger-1.27 September 2022 HLEDGER(1)
hledger-1.27.99 October 2022 HLEDGER(1)