Skip to content

Commit

Permalink
;doc: update manuals
Browse files Browse the repository at this point in the history
  • Loading branch information
simonmichael committed Jun 2, 2023
1 parent cffd056 commit 94fe8b2
Show file tree
Hide file tree
Showing 11 changed files with 981 additions and 1,003 deletions.
2 changes: 1 addition & 1 deletion hledger-lib/.date.m4
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
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 changes: 1 addition & 1 deletion hledger-ui/.date.m4
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
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 changes: 1 addition & 1 deletion hledger-ui/hledger-ui.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

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



Expand Down
2 changes: 1 addition & 1 deletion hledger-ui/hledger-ui.txt
Original file line number Diff line number Diff line change
Expand Up @@ -531,4 +531,4 @@ SEE ALSO



hledger-ui-1.30 May 2023 HLEDGER-UI(1)
hledger-ui-1.30 June 2023 HLEDGER-UI(1)
2 changes: 1 addition & 1 deletion hledger-web/.date.m4
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
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 changes: 1 addition & 1 deletion hledger-web/hledger-web.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

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



Expand Down
2 changes: 1 addition & 1 deletion hledger-web/hledger-web.txt
Original file line number Diff line number Diff line change
Expand Up @@ -571,4 +571,4 @@ SEE ALSO



hledger-web-1.30 May 2023 HLEDGER-WEB(1)
hledger-web-1.30 June 2023 HLEDGER-WEB(1)
2 changes: 1 addition & 1 deletion hledger/.date.m4
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
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
41 changes: 19 additions & 22 deletions hledger/hledger.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\"t

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



Expand Down Expand Up @@ -494,15 +494,6 @@ Some reporting options can also be written as query arguments.
Here are some details useful to know about for hledger command lines
(and elsewhere).
Feel free to skip this section until you need it.
.SS Option repetition
.PP
If options are repeated in a command line, hledger will generally use
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 Single escaping (shell metacharacters)
.PP
Expand Down Expand Up @@ -10056,6 +10047,9 @@ the account to transfer to/from can be changed with
.IP \[bu] 2
the accounts to be closed/opened can be changed with \f[V]ACCTQUERY\f[R]
(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
By default just one destination/source posting will be used, with its
amount left implicit.
Expand All @@ -10075,10 +10069,9 @@ This could be useful for troubleshooting.
.PP
The default closing date is yesterday, or the journal\[aq]s end date,
whichever is later.
You can change this by specifying a report end date; (The report start
date does not matter.)
The last day of the report period will be the closing date; eg
\f[V]-e 2022\f[R] means \[dq]close on 2022-12-31\[dq].
You can change this by specifying a report end date with \f[V]-e\f[R].
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].
The opening date is always the day after the closing date.
.SS close and balance assertions
.PP
Expand Down Expand Up @@ -10308,21 +10301,25 @@ Tips:
.PP
Make your terminal window large enough to see the demo clearly.
.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, .
to step forward (while paused), CTRL-c quit.
.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:
.IP
.nf
\f[C]
$ hledger demo # list available demos
$ hledger demo 1 # play the first demo
$ hledger demo install -- -s5 -i.5 # play the install demo at 5x speed,
# with pauses limited to half a second
$ hledger demo # list available demos
$ hledger demo 1 # play the first demo at default speed (2x)
$ hledger demo install -s4 # play the \[dq]install\[dq] demo at 4x speed
\f[R]
.fi
.SS descriptions
Expand Down

0 comments on commit 94fe8b2

Please sign in to comment.