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

doc: update manuals

Browse Source
This commit is contained in:
Simon Michael 2022-07-11 13:57:18 +01:00
parent 9a34145569
commit 6fbcbf7c6b
13 changed files with 1670 additions and 1685 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hledger-lib/.date.m4
View File

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

2
hledger-ui/.date.m4
View File

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

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

@ -1,5 +1,5 @@
.TH "HLEDGER-UI" "1" "June 2022" "hledger-ui-1.26 " "hledger User Manuals"
.TH "HLEDGER-UI" "1" "July 2022" "hledger-ui-1.26.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.26.
This manual is for hledger-ui 1.26.99.
.SH SYNOPSIS
.PP
\f[C]hledger-ui [OPTIONS] [QUERYARGS]\f[R]

58
hledger-ui/hledger-ui.info
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.26.
tool. This manual is for hledger-ui 1.26.99.
'hledger-ui [OPTIONS] [QUERYARGS]'
'hledger ui -- [OPTIONS] [QUERYARGS]'
@ -639,34 +639,34 @@ 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: FILES21092
Ref: #files21191
Node: BUGS21404
Ref: #bugs21481
Node: OPTIONS1657
Ref: #options1755
Node: MOUSE6637
Ref: #mouse6732
Node: KEYS7014
Ref: #keys7107
Node: SCREENS11193
Ref: #screens11291
Node: Accounts screen11381
Ref: #accounts-screen11509
Node: Register screen13848
Ref: #register-screen14003
Node: Transaction screen15987
Ref: #transaction-screen16145
Node: Error screen17015
Ref: #error-screen17137
Node: TIPS17381
Ref: #tips17480
Node: Watch mode17532
Ref: #watch-mode17649
Node: Watch mode limitations18399
Ref: #watch-mode-limitations18540
Node: ENVIRONMENT19676
Ref: #environment19787
Node: FILES21095
Ref: #files21194
Node: BUGS21407
Ref: #bugs21484

End Tag Table

4
hledger-ui/hledger-ui.txt
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.26.
tool. This manual is for hledger-ui 1.26.99.
SYNOPSIS
hledger-ui [OPTIONS] [QUERYARGS]
@ -548,4 +548,4 @@ SEE ALSO
hledger-ui-1.26 June 2022 HLEDGER-UI(1)
hledger-ui-1.26.99 July 2022 HLEDGER-UI(1)

2
hledger-web/.date.m4
View File

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

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

@ -1,12 +1,12 @@
.TH "HLEDGER-WEB" "1" "June 2022" "hledger-web-1.26 " "hledger User Manuals"
.TH "HLEDGER-WEB" "1" "July 2022" "hledger-web-1.26.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.26.
This manual is for hledger-web 1.26.99.
.SH SYNOPSIS
.PP
\f[C]hledger-web [OPTIONS]\f[R]

34
hledger-web/hledger-web.info
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.26.
This manual is for hledger-web 1.26.99.
'hledger-web [OPTIONS]'
'hledger web -- [OPTIONS]'
@ -631,22 +631,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: FILES19789
Ref: #files19889
Node: BUGS20102
Ref: #bugs20180
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: FILES19792
Ref: #files19892
Node: BUGS20105
Ref: #bugs20183

End Tag Table

4
hledger-web/hledger-web.txt
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.26.
This manual is for hledger-web 1.26.99.
SYNOPSIS
hledger-web [OPTIONS]
@ -585,4 +585,4 @@ SEE ALSO
hledger-web-1.26 June 2022 HLEDGER-WEB(1)
hledger-web-1.26.99 July 2022 HLEDGER-WEB(1)

2
hledger/.date.m4
View File

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

55
hledger/hledger.1
View File

@ -1,6 +1,6 @@
.\"t
.TH "HLEDGER" "1" "June 2022" "hledger-1.26 " "hledger User Manuals"
.TH "HLEDGER" "1" "July 2022" "hledger-1.26.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.26.
This manual is for hledger 1.26.99.
.SH SYNOPSIS
.PP
\f[C]hledger\f[R]
@ -4436,10 +4436,11 @@ balances of asset and liability accounts.
shown with normal positive sign, as in conventional financial
statements.
.PP
The asset and liability accounts shown are those accounts declared with
the \f[C]Asset\f[R] or \f[C]Cash\f[R] or \f[C]Liability\f[R] type, or
otherwise all accounts under a top-level \f[C]asset\f[R] or
\f[C]liability\f[R] account (case insensitive, plurals allowed).
This report shows accounts declared with the \f[C]Asset\f[R],
\f[C]Cash\f[R] or \f[C]Liability\f[R] type (see account types).
Or if no such accounts are declared, it shows top-level accounts named
\f[C]asset\f[R] or \f[C]liability\f[R] (case insensitive, plurals
allowed) and their subaccounts.
.PP
Example:
.IP
@ -4487,11 +4488,12 @@ balances of asset, liability and equity accounts.
Amounts are shown with normal positive sign, as in conventional
financial statements.
.PP
The asset, liability and equity accounts shown are those accounts
declared with the \f[C]Asset\f[R], \f[C]Cash\f[R], \f[C]Liability\f[R]
or \f[C]Equity\f[R] type, or otherwise all accounts under a top-level
\f[C]asset\f[R], \f[C]liability\f[R] or \f[C]equity\f[R] account (case
insensitive, plurals allowed).
This report shows accounts declared with the \f[C]Asset\f[R],
\f[C]Cash\f[R], \f[C]Liability\f[R] or \f[C]Equity\f[R] type (see
account types).
Or if no such accounts are declared, it shows top-level accounts named
\f[C]asset\f[R], \f[C]liability\f[R] or \f[C]equity\f[R] (case
insensitive, plurals allowed) and their subaccounts.
.PP
Example:
.IP
@ -4545,22 +4547,15 @@ assets.
Amounts are shown with normal positive sign, as in conventional
financial statements.
.PP
\[dq]Cash\[dq] assets are those accounts which are (or whose parents
are) declared as \f[C]Cash\f[R] by an account directive, like this:
.IP
.nf
\f[C]
account some:liquid:asset ; type:C
\f[R]
.fi
.PP
Or if there are no such declarations, all accounts
This report shows accounts declared with the \f[C]Cash\f[R] type (see
account types).
Or if no such accounts are declared, it shows accounts
.IP \[bu] 2
under a top-level \f[C]asset\f[R] account (case insensitive, plural
allowed)
under a top-level account named \f[C]asset\f[R] (case insensitive,
plural allowed)
.IP \[bu] 2
with some variation of \f[C]cash\f[R], \f[C]bank\f[R],
\f[C]checking\f[R] or \f[C]saving\f[R] in their name.
whose name contains some variation of \f[C]cash\f[R], \f[C]bank\f[R],
\f[C]checking\f[R] or \f[C]saving\f[R].
.PP
More precisely: all accounts matching this case insensitive regular
expression:
@ -5255,16 +5250,16 @@ incomestatement, is
.PD 0
.P
.PD
.PP
This command displays an income statement, showing revenues and expenses
during one or more periods.
Amounts are shown with normal positive sign, as in conventional
financial statements.
.PP
The revenue and expense accounts shown are those accounts declared with
the \f[C]Revenue\f[R] or \f[C]Expense\f[R] type, or otherwise all
accounts under a top-level \f[C]revenue\f[R] or \f[C]income\f[R] or
\f[C]expense\f[R] account (case insensitive, plurals allowed).
This report shows accounts declared with the \f[C]Revenue\f[R] or
\f[C]Expense\f[R] type (see account types).
Or if no such accounts are declared, it shows top-level accounts named
\f[C]revenue\f[R] or \f[C]income\f[R] or \f[C]expense\f[R] (case
insensitive, plurals allowed) and their subaccounts.
.PP
Example:
.IP

1136
hledger/hledger.info
View File

File diff suppressed because it is too large Load Diff

48
hledger/hledger.txt
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.26.
manual is for hledger 1.26.99.
SYNOPSIS
hledger
@ -3092,10 +3092,10 @@ COMMANDS
balancesheetequity command.) Amounts are shown with normal positive
sign, as in conventional financial statements.
The asset and liability accounts shown are those accounts declared with
the Asset or Cash or Liability type, or otherwise all accounts under a
top-level asset or liability account (case insensitive, plurals
allowed).
This report shows accounts declared with the Asset, Cash or Liability
type (see account types). Or if no such accounts are declared, it
shows top-level accounts named asset or liability (case insensitive,
plurals allowed) and their subaccounts.
Example:
@ -3134,10 +3134,10 @@ COMMANDS
ances of asset, liability and equity accounts. Amounts are shown with
normal positive sign, as in conventional financial statements.
The asset, liability and equity accounts shown are those accounts
declared with the Asset, Cash, Liability or Equity type, or otherwise
all accounts under a top-level asset, liability or equity account (case
insensitive, plurals allowed).
This report shows accounts declared with the Asset, Cash, Liability or
Equity type (see account types). Or if no such accounts are declared,
it shows top-level accounts named asset, liability or equity (case
insensitive, plurals allowed) and their subaccounts.
Example:
@ -3182,16 +3182,13 @@ COMMANDS
Amounts are shown with normal positive sign, as in conventional finan-
cial statements.
"Cash" assets are those accounts which are (or whose parents are)
declared as Cash by an account directive, like this:
This report shows accounts declared with the Cash type (see account
types). Or if no such accounts are declared, it shows accounts
account some:liquid:asset ; type:C
o under a top-level account named asset (case insensitive, plural
allowed)
Or if there are no such declarations, all accounts
o under a top-level asset account (case insensitive, plural allowed)
o with some variation of cash, bank, checking or saving in their name.
o whose name contains some variation of cash, bank, checking or saving.
More precisely: all accounts matching this case insensitive regular
expression:
@ -3696,15 +3693,14 @@ COMMANDS
incomestatement
incomestatement, is
This command displays an income statement, showing revenues and
expenses during one or more periods. Amounts are shown with normal
positive sign, as in conventional financial statements.
The revenue and expense accounts shown are those accounts declared with
the Revenue or Expense type, or otherwise all accounts under a top-
level revenue or income or expense account (case insensitive, plurals
allowed).
This report shows accounts declared with the Revenue or Expense type
(see account types). Or if no such accounts are declared, it shows
top-level accounts named revenue or income or expense (case insensi-
tive, plurals allowed) and their subaccounts.
Example:
@ -4604,6 +4600,8 @@ JOURNAL FORMAT
indicating one of three statuses:
mark status
------------------
unmarked
@ -5299,10 +5297,6 @@ JOURNAL FORMAT
following entries until end of current file; and its display
style, for reports. Takes precedence over D. Subdirectives:
format (alternate syntax).
D Sets a default commodity to use for no-symbol amounts, and Y
its decimal mark for parsing amounts of this commodity in
following entries until end of current file; and its display
@ -8006,4 +8000,4 @@ SEE ALSO
hledger-1.26 June 2022 HLEDGER(1)
hledger-1.26.99 July 2022 HLEDGER(1)