From 6588020e64f93bfa9c85e76e9e044aaadd6d607d Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Fri, 17 Mar 2023 00:53:57 -1000 Subject: [PATCH] ;doc: update CLI help text files --- hledger/Hledger/Cli/Commands/Demo.txt | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/hledger/Hledger/Cli/Commands/Demo.txt b/hledger/Hledger/Cli/Commands/Demo.txt index ebf63f99f..620292557 100644 --- a/hledger/Hledger/Cli/Commands/Demo.txt +++ b/hledger/Hledger/Cli/Commands/Demo.txt @@ -1,22 +1,24 @@ demo -Play small demos of hledger usage in the terminal. +Play demos of hledger usage in the terminal, if asciinema is installed. _FLAGS 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 -be installed. +write its number or a prefix or substring of its title. Tips: -During playback, several keys are available: - SPACE pause/unpause - . -step forward (while paused) - CTRL-c quit early +Make your terminal window large enough to see the demo clearly. -asciinema options can be added following a double dash, such as -s -(adjust speed) and -i (limit idle time). Run asciinema -h to list them. +During playback, several keys are available: SPACE to pause/unpause, . +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: -$ hledger demo # list available demos -$ hledger demo 1 # play the first demo -$ hledger demo install -s5 -i.5 # play the demo named or containing "install", - # at 5x speed, limiting idle time to 0.5s. +$ 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