;doc: update CLI help text files

This commit is contained in:
Simon Michael 2023-03-17 00:53:57 -10:00
parent 8b2efe3c33
commit 6588020e64

View File

@ -1,22 +1,24 @@
demo demo
Play small demos of hledger usage in the terminal. Play demos of hledger usage in the terminal, if asciinema is installed.
_FLAGS _FLAGS
Run this command with no argument to list the demos. To play a demo, Run this command with no argument to list the demos. To play a demo,
write its number or a prefix or substring of its title. asciinema must write its number or a prefix or substring of its title. Tips:
be installed.
During playback, several keys are available: - SPACE pause/unpause - . Make your terminal window large enough to see the demo clearly.
step forward (while paused) - CTRL-c quit early
asciinema options can be added following a double dash, such as -s During playback, several keys are available: SPACE to pause/unpause, .
(adjust speed) and -i (limit idle time). Run asciinema -h to list them. to step forward (while paused), CTRL-c quit.
asciinema options can be added following a double dash, such as -s N to
adjust speed and -i SECS to limit pauses. Run asciinema -h to list these
options.
Examples: Examples:
$ hledger demo # list available demos $ hledger demo # list available demos
$ hledger demo 1 # play the first demo $ hledger demo 1 # play the first demo
$ hledger demo install -s5 -i.5 # play the demo named or containing "install", $ hledger demo install -- -s5 -i.5 # play the install demo at 5x speed,
# at 5x speed, limiting idle time to 0.5s. # with pauses limited to half a second