Skip to content

Commit 94fe8b2

Browse files
committed
;doc: update manuals
1 parent cffd056 commit 94fe8b2

File tree

11 files changed

+981
-1003
lines changed

11 files changed

+981
-1003
lines changed

hledger-lib/.date.m4

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
m4_dnl Date to show in man pages. Updated by "Shake manuals"
2-
m4_define({{_monthyear_}}, {{May 2023}})m4_dnl
2+
m4_define({{_monthyear_}}, {{June 2023}})m4_dnl

hledger-ui/.date.m4

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
m4_dnl Date to show in man pages. Updated by "Shake manuals"
2-
m4_define({{_monthyear_}}, {{May 2023}})m4_dnl
2+
m4_define({{_monthyear_}}, {{June 2023}})m4_dnl

hledger-ui/hledger-ui.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
.TH "HLEDGER-UI" "1" "May 2023" "hledger-ui-1.30 " "hledger User Manuals"
2+
.TH "HLEDGER-UI" "1" "June 2023" "hledger-ui-1.30 " "hledger User Manuals"
33

44

55

hledger-ui/hledger-ui.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -531,4 +531,4 @@ SEE ALSO
531531

532532

533533

534-
hledger-ui-1.30 May 2023 HLEDGER-UI(1)
534+
hledger-ui-1.30 June 2023 HLEDGER-UI(1)

hledger-web/.date.m4

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
m4_dnl Date to show in man pages. Updated by "Shake manuals"
2-
m4_define({{_monthyear_}}, {{May 2023}})m4_dnl
2+
m4_define({{_monthyear_}}, {{June 2023}})m4_dnl

hledger-web/hledger-web.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
.TH "HLEDGER-WEB" "1" "May 2023" "hledger-web-1.30 " "hledger User Manuals"
2+
.TH "HLEDGER-WEB" "1" "June 2023" "hledger-web-1.30 " "hledger User Manuals"
33

44

55

hledger-web/hledger-web.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -571,4 +571,4 @@ SEE ALSO
571571

572572

573573

574-
hledger-web-1.30 May 2023 HLEDGER-WEB(1)
574+
hledger-web-1.30 June 2023 HLEDGER-WEB(1)

hledger/.date.m4

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
m4_dnl Date to show in man pages. Updated by "Shake manuals"
2-
m4_define({{_monthyear_}}, {{May 2023}})m4_dnl
2+
m4_define({{_monthyear_}}, {{June 2023}})m4_dnl

hledger/hledger.1

+19-22
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.\"t
22

3-
.TH "HLEDGER" "1" "May 2023" "hledger-1.30 " "hledger User Manuals"
3+
.TH "HLEDGER" "1" "June 2023" "hledger-1.30 " "hledger User Manuals"
44

55

66

@@ -494,15 +494,6 @@ Some reporting options can also be written as query arguments.
494494
Here are some details useful to know about for hledger command lines
495495
(and elsewhere).
496496
Feel free to skip this section until you need it.
497-
.SS Option repetition
498-
.PP
499-
If options are repeated in a command line, hledger will generally use
500-
the last (right-most) occurence.
501-
Some of the boolean flags will toggle if repeated; these include:
502-
\f[V]--invert\f[R], \f[V]--transpose\f[R], \f[V]-r/--related\f[R],
503-
\f[V]-%/--percent\f[R], \f[V]-E/--empty\f[R], \f[V]-N/--no-total\f[R],
504-
\f[V]-T/--row-total\f[R], \f[V]-A/--average\f[R], and
505-
\f[V]-S/--sort-amount\f[R].
506497
.SS Special characters
507498
.SS Single escaping (shell metacharacters)
508499
.PP
@@ -10056,6 +10047,9 @@ the account to transfer to/from can be changed with
1005610047
.IP \[bu] 2
1005710048
the accounts to be closed/opened can be changed with \f[V]ACCTQUERY\f[R]
1005810049
(account query arguments).
10050+
.IP \[bu] 2
10051+
the closing/opening dates can be changed with \f[V]-e DATE\f[R] (a
10052+
report end date)
1005910053
.PP
1006010054
By default just one destination/source posting will be used, with its
1006110055
amount left implicit.
@@ -10075,10 +10069,9 @@ This could be useful for troubleshooting.
1007510069
.PP
1007610070
The default closing date is yesterday, or the journal\[aq]s end date,
1007710071
whichever is later.
10078-
You can change this by specifying a report end date; (The report start
10079-
date does not matter.)
10080-
The last day of the report period will be the closing date; eg
10081-
\f[V]-e 2022\f[R] means \[dq]close on 2022-12-31\[dq].
10072+
You can change this by specifying a report end date with \f[V]-e\f[R].
10073+
The last day of the report period will be the closing date, eg
10074+
\f[V]-e 2024\f[R] means \[dq]close on 2023-12-31\[dq].
1008210075
The opening date is always the day after the closing date.
1008310076
.SS close and balance assertions
1008410077
.PP
@@ -10308,21 +10301,25 @@ Tips:
1030810301
.PP
1030910302
Make your terminal window large enough to see the demo clearly.
1031010303
.PP
10304+
Use the -s/--speed SPEED option to set your preferred playback speed, eg
10305+
\f[V]-s4\f[R] to play at 4x original speed or \f[V]-s.5\f[R] to play at
10306+
half speed.
10307+
The default speed is 2x.
10308+
.PP
10309+
Other asciinema options can be added following a double dash, eg
10310+
\f[V]-- -i.1\f[R] to limit pauses or \f[V]-- -h\f[R] to list
10311+
asciinema\[aq]s other options.
10312+
.PP
1031110313
During playback, several keys are available: SPACE to pause/unpause, .
1031210314
to step forward (while paused), CTRL-c quit.
1031310315
.PP
10314-
asciinema options can be added following a double dash, such as
10315-
\f[V]-s N\f[R] to adjust speed and \f[V]-i SECS\f[R] to limit pauses.
10316-
Run \f[V]asciinema -h\f[R] to list these options.
10317-
.PP
1031810316
Examples:
1031910317
.IP
1032010318
.nf
1032110319
\f[C]
10322-
$ hledger demo # list available demos
10323-
$ hledger demo 1 # play the first demo
10324-
$ hledger demo install -- -s5 -i.5 # play the install demo at 5x speed,
10325-
# with pauses limited to half a second
10320+
$ hledger demo # list available demos
10321+
$ hledger demo 1 # play the first demo at default speed (2x)
10322+
$ hledger demo install -s4 # play the \[dq]install\[dq] demo at 4x speed
1032610323
\f[R]
1032710324
.fi
1032810325
.SS descriptions

0 commit comments

Comments
 (0)