slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc: update manuals

Browse Source
This commit is contained in:
Simon Michael 2023-06-01 16:35:11 -10:00
parent 2a3941682b
commit 21d6b00597
13 changed files with 2119 additions and 2106 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_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{May 2023}})m4_dnl m4_define({{_monthyear_}}, {{June 2023}})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_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{May 2023}})m4_dnl m4_define({{_monthyear_}}, {{June 2023}})m4_dnl

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

@ -1,5 +1,5 @@
.TH "HLEDGER-UI" "1" "May 2023" "hledger-ui-1.29.99 " "hledger User Manuals" .TH "HLEDGER-UI" "1" "June 2023" "hledger-ui-1.30.99 " "hledger User Manuals"
@ -15,7 +15,7 @@ hledger-ui - robust, friendly plain text accounting (TUI version)
\f[V]hledger ui -- [OPTS] [QUERYARGS]\f[R] \f[V]hledger ui -- [OPTS] [QUERYARGS]\f[R]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
This manual is for hledger\[aq]s terminal interface, version 1.29.99. This manual is for hledger\[aq]s terminal interface, version 1.30.99.
See also the hledger manual for common concepts and file formats. See also the hledger manual for common concepts and file formats.
.PP .PP
hledger is a robust, user-friendly, cross-platform set of programs for hledger is a robust, user-friendly, cross-platform set of programs for

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

@ -16,7 +16,7 @@ hledger-ui - robust, friendly plain text accounting (TUI version)
'hledger-ui [OPTS] [QUERYARGS]' 'hledger-ui [OPTS] [QUERYARGS]'
'hledger ui -- [OPTS] [QUERYARGS]' 'hledger ui -- [OPTS] [QUERYARGS]'
This manual is for hledger's terminal interface, version 1.29.99. This manual is for hledger's terminal interface, version 1.30.99.
See also the hledger manual for common concepts and file formats. See also the hledger manual for common concepts and file formats.
hledger is a robust, user-friendly, cross-platform set of programs hledger is a robust, user-friendly, cross-platform set of programs

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

@ -11,7 +11,7 @@ SYNOPSIS
hledger ui -- [OPTS] [QUERYARGS] hledger ui -- [OPTS] [QUERYARGS]
DESCRIPTION DESCRIPTION
This manual is for hledger's terminal interface, version 1.29.99. See This manual is for hledger's terminal interface, version 1.30.99. See
also the hledger manual for common concepts and file formats. also the hledger manual for common concepts and file formats.
hledger is a robust, user-friendly, cross-platform set of programs for hledger is a robust, user-friendly, cross-platform set of programs for
@ -531,4 +531,4 @@ SEE ALSO
hledger-ui-1.29.99 May 2023 HLEDGER-UI(1) hledger-ui-1.30.99 June 2023 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_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{May 2023}})m4_dnl m4_define({{_monthyear_}}, {{June 2023}})m4_dnl

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

@ -1,5 +1,5 @@
.TH "HLEDGER-WEB" "1" "May 2023" "hledger-web-1.29.99 " "hledger User Manuals" .TH "HLEDGER-WEB" "1" "June 2023" "hledger-web-1.30.99 " "hledger User Manuals"
@ -15,7 +15,7 @@ hledger-web - robust, friendly plain text accounting (Web version)
\f[V]hledger web -- [--serve|--serve-api] [OPTS] [ARGS]\f[R] \f[V]hledger web -- [--serve|--serve-api] [OPTS] [ARGS]\f[R]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
This manual is for hledger\[aq]s web interface, version 1.29.99. This manual is for hledger\[aq]s web interface, version 1.30.99.
See also the hledger manual for common concepts and file formats. See also the hledger manual for common concepts and file formats.
.PP .PP
hledger is a robust, user-friendly, cross-platform set of programs for hledger is a robust, user-friendly, cross-platform set of programs for

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

@ -16,7 +16,7 @@ hledger-web - robust, friendly plain text accounting (Web version)
'hledger-web [--serve|--serve-api] [OPTS] [ARGS]' 'hledger-web [--serve|--serve-api] [OPTS] [ARGS]'
'hledger web -- [--serve|--serve-api] [OPTS] [ARGS]' 'hledger web -- [--serve|--serve-api] [OPTS] [ARGS]'
This manual is for hledger's web interface, version 1.29.99. See This manual is for hledger's web interface, version 1.30.99. See
also the hledger manual for common concepts and file formats. also the hledger manual for common concepts and file formats.
hledger is a robust, user-friendly, cross-platform set of programs hledger is a robust, user-friendly, cross-platform set of programs

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

@ -11,7 +11,7 @@ SYNOPSIS
hledger web -- [--serve|--serve-api] [OPTS] [ARGS] hledger web -- [--serve|--serve-api] [OPTS] [ARGS]
DESCRIPTION DESCRIPTION
This manual is for hledger's web interface, version 1.29.99. See also This manual is for hledger's web interface, version 1.30.99. See also
the hledger manual for common concepts and file formats. the hledger manual for common concepts and file formats.
hledger is a robust, user-friendly, cross-platform set of programs for hledger is a robust, user-friendly, cross-platform set of programs for
@ -571,4 +571,4 @@ SEE ALSO
hledger-web-1.29.99 May 2023 HLEDGER-WEB(1) hledger-web-1.30.99 June 2023 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_dnl Date to show in man pages. Updated by "Shake manuals"
m4_define({{_monthyear_}}, {{May 2023}})m4_dnl m4_define({{_monthyear_}}, {{June 2023}})m4_dnl

39
hledger/hledger.1
View File

@ -1,6 +1,6 @@
.\"t .\"t
.TH "HLEDGER" "1" "May 2023" "hledger-1.29.99 " "hledger User Manuals" .TH "HLEDGER" "1" "June 2023" "hledger-1.30.99 " "hledger User Manuals"
@ -27,7 +27,7 @@ hledger is inspired by and largely compatible with ledger(1), and
largely interconvertible with beancount(1). largely interconvertible with beancount(1).
.PP .PP
This manual is for hledger\[aq]s command line interface, version This manual is for hledger\[aq]s command line interface, version
1.29.99. 1.30.99.
It also describes the common options, file formats and concepts used by It also describes the common options, file formats and concepts used by
all hledger programs. all hledger programs.
It might accidentally teach you some bookkeeping/accounting as well! It might accidentally teach you some bookkeeping/accounting as well!
@ -499,11 +499,6 @@ Feel free to skip this section until you need it.
.PP .PP
If options are repeated in a command line, hledger will generally use If options are repeated in a command line, hledger will generally use
the last (right-most) occurence. the last (right-most) occurence.
Some of the boolean flags will toggle if repeated; these include:
\f[V]--invert\f[R], \f[V]--transpose\f[R], \f[V]-r/--related\f[R],
\f[V]-%/--percent\f[R], \f[V]-E/--empty\f[R], \f[V]-N/--no-total\f[R],
\f[V]-T/--row-total\f[R], \f[V]-A/--average\f[R], and
\f[V]-S/--sort-amount\f[R].
.SS Special characters .SS Special characters
.SS Single escaping (shell metacharacters) .SS Single escaping (shell metacharacters)
.PP .PP
@ -10057,6 +10052,9 @@ the account to transfer to/from can be changed with
.IP \[bu] 2 .IP \[bu] 2
the accounts to be closed/opened can be changed with \f[V]ACCTQUERY\f[R] the accounts to be closed/opened can be changed with \f[V]ACCTQUERY\f[R]
(account query arguments). (account query arguments).
.IP \[bu] 2
the closing/opening dates can be changed with \f[V]-e DATE\f[R] (a
report end date)
.PP .PP
By default just one destination/source posting will be used, with its By default just one destination/source posting will be used, with its
amount left implicit. amount left implicit.
@ -10076,10 +10074,9 @@ This could be useful for troubleshooting.
.PP .PP
The default closing date is yesterday, or the journal\[aq]s end date, The default closing date is yesterday, or the journal\[aq]s end date,
whichever is later. whichever is later.
You can change this by specifying a report end date; (The report start You can change this by specifying a report end date with \f[V]-e\f[R].
date does not matter.) The last day of the report period will be the closing date, eg
The last day of the report period will be the closing date; eg \f[V]-e 2024\f[R] means \[dq]close on 2023-12-31\[dq].
\f[V]-e 2022\f[R] means \[dq]close on 2022-12-31\[dq].
The opening date is always the day after the closing date. The opening date is always the day after the closing date.
.SS close and balance assertions .SS close and balance assertions
.PP .PP
@ -10309,21 +10306,25 @@ Tips:
.PP .PP
Make your terminal window large enough to see the demo clearly. Make your terminal window large enough to see the demo clearly.
.PP .PP
Use the -s/--speed SPEED option to set your preferred playback speed, eg
\f[V]-s4\f[R] to play at 4x original speed or \f[V]-s.5\f[R] to play at
half speed.
The default speed is 2x.
.PP
Other asciinema options can be added following a double dash, eg
\f[V]-- -i.1\f[R] to limit pauses or \f[V]-- -h\f[R] to list
asciinema\[aq]s other options.
.PP
During playback, several keys are available: SPACE to pause/unpause, . During playback, several keys are available: SPACE to pause/unpause, .
to step forward (while paused), CTRL-c quit. to step forward (while paused), CTRL-c quit.
.PP .PP
asciinema options can be added following a double dash, such as
\f[V]-s N\f[R] to adjust speed and \f[V]-i SECS\f[R] to limit pauses.
Run \f[V]asciinema -h\f[R] to list these options.
.PP
Examples: Examples:
.IP .IP
.nf .nf
\f[C] \f[C]
$ hledger demo # list available demos $ hledger demo # list available demos
$ hledger demo 1 # play the first demo $ hledger demo 1 # play the first demo at default speed (2x)
$ hledger demo install -- -s5 -i.5 # play the install demo at 5x speed, $ hledger demo install -s4 # play the \[dq]install\[dq] demo at 4x speed
# with pauses limited to half a second
\f[R] \f[R]
.fi .fi
.SS descriptions .SS descriptions

1247
hledger/hledger.info
View File

File diff suppressed because it is too large Load Diff

2911
hledger/hledger.txt
View File

File diff suppressed because it is too large Load Diff