;doc: update manuals

This commit is contained in:
Simon Michael 2023-03-18 20:07:18 -10:00
parent 4d7d982f83
commit 13531b5b86
3 changed files with 113 additions and 108 deletions

View File

@ -10205,28 +10205,29 @@ $ hledger codes -E
List all commodity/currency symbols used or declared in the journal.
.SS demo
.PP
Play small demos of hledger usage in the terminal.
Play demos of hledger usage in the terminal, if asciinema is installed.
.PP
Run this command with no argument to list the demos.
To play a demo, write its number or name or a substring.
asciinema must be installed.
To play a demo, write its number or a prefix or substring of its title.
Tips:
.PP
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.
.PP
asciinema options can be added following a double-dash; list them with
\f[V]asciinema -h\f[R].
\f[V]-s\f[R] (speed) and \f[V]-i\f[R] (max idle time) are particularly
useful.
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 demo named or containing \[dq]install\[dq],
# 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
\f[R]
.fi
.SS descriptions

View File

@ -8909,24 +8909,26 @@ File: hledger.info, Node: demo, Next: descriptions, Prev: commodities, Up: P
24.14 demo
==========
Play small demos of hledger usage in the terminal.
Play demos of hledger usage in the terminal, if asciinema is installed.
Run this command with no argument to list the demos. To play a demo,
write its number or name or a substring. 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; list them
with asciinema -h. -s (speed) and -i (max idle time) are
particularly useful.
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

File: hledger.info, Node: descriptions, Next: diff, Prev: demo, Up: PART 4 COMMANDS
@ -10917,78 +10919,78 @@ Node: commodities325330
Ref: #commodities325458
Node: demo325528
Ref: #demo325649
Node: descriptions326419
Ref: #descriptions326549
Node: diff326840
Ref: #diff326955
Node: files328001
Ref: #files328110
Node: help328251
Ref: #help-1328360
Node: import329350
Ref: #import329473
Node: Deduplication330581
Ref: #deduplication330706
Node: Import testing332628
Ref: #import-testing332793
Node: Importing balance assignments333644
Ref: #importing-balance-assignments333850
Node: Commodity display styles334507
Ref: #commodity-display-styles334680
Node: incomestatement334809
Ref: #incomestatement334951
Node: notes336318
Ref: #notes336440
Node: payees336802
Ref: #payees336917
Node: prices337442
Ref: #prices337557
Node: print337859
Ref: #print337974
Node: register343420
Ref: #register343542
Node: Custom register output348651
Ref: #custom-register-output348782
Node: rewrite350157
Ref: #rewrite350275
Node: Re-write rules in a file352187
Ref: #re-write-rules-in-a-file352350
Node: Diff output format353503
Ref: #diff-output-format353686
Node: rewrite vs print --auto354798
Ref: #rewrite-vs.-print---auto354960
Node: roi355534
Ref: #roi355641
Node: Spaces and special characters in --inv and --pnl357402
Ref: #spaces-and-special-characters-in---inv-and---pnl357650
Node: Semantics of --inv and --pnl358148
Ref: #semantics-of---inv-and---pnl358395
Node: IRR and TWR explained360273
Ref: #irr-and-twr-explained360433
Node: stats363545
Ref: #stats363653
Node: tags365050
Ref: #tags-1365157
Node: test366174
Ref: #test366267
Node: PART 5 COMMON TASKS367017
Ref: #part-5-common-tasks367150
Node: Getting help367424
Ref: #getting-help367565
Node: Constructing command lines368329
Ref: #constructing-command-lines368530
Node: Starting a journal file369211
Ref: #starting-a-journal-file369418
Node: Setting opening balances370616
Ref: #setting-opening-balances370821
Node: Recording transactions373974
Ref: #recording-transactions374163
Node: Reconciling374719
Ref: #reconciling374871
Node: Reporting377184
Ref: #reporting377333
Node: Migrating to a new file381322
Ref: #migrating-to-a-new-file381479
Node: descriptions326505
Ref: #descriptions326635
Node: diff326926
Ref: #diff327041
Node: files328087
Ref: #files328196
Node: help328337
Ref: #help-1328446
Node: import329436
Ref: #import329559
Node: Deduplication330667
Ref: #deduplication330792
Node: Import testing332714
Ref: #import-testing332879
Node: Importing balance assignments333730
Ref: #importing-balance-assignments333936
Node: Commodity display styles334593
Ref: #commodity-display-styles334766
Node: incomestatement334895
Ref: #incomestatement335037
Node: notes336404
Ref: #notes336526
Node: payees336888
Ref: #payees337003
Node: prices337528
Ref: #prices337643
Node: print337945
Ref: #print338060
Node: register343506
Ref: #register343628
Node: Custom register output348737
Ref: #custom-register-output348868
Node: rewrite350243
Ref: #rewrite350361
Node: Re-write rules in a file352273
Ref: #re-write-rules-in-a-file352436
Node: Diff output format353589
Ref: #diff-output-format353772
Node: rewrite vs print --auto354884
Ref: #rewrite-vs.-print---auto355046
Node: roi355620
Ref: #roi355727
Node: Spaces and special characters in --inv and --pnl357488
Ref: #spaces-and-special-characters-in---inv-and---pnl357736
Node: Semantics of --inv and --pnl358234
Ref: #semantics-of---inv-and---pnl358481
Node: IRR and TWR explained360359
Ref: #irr-and-twr-explained360519
Node: stats363631
Ref: #stats363739
Node: tags365136
Ref: #tags-1365243
Node: test366260
Ref: #test366353
Node: PART 5 COMMON TASKS367103
Ref: #part-5-common-tasks367236
Node: Getting help367510
Ref: #getting-help367651
Node: Constructing command lines368415
Ref: #constructing-command-lines368616
Node: Starting a journal file369297
Ref: #starting-a-journal-file369504
Node: Setting opening balances370702
Ref: #setting-opening-balances370907
Node: Recording transactions374060
Ref: #recording-transactions374249
Node: Reconciling374805
Ref: #reconciling374957
Node: Reporting377270
Ref: #reporting377419
Node: Migrating to a new file381408
Ref: #migrating-to-a-new-file381565

End Tag Table

View File

@ -7384,24 +7384,26 @@ PART 4: COMMANDS
List all commodity/currency symbols used or declared in the journal.
demo
Play small demos of hledger usage in the terminal.
Play demos of hledger usage in the terminal, if asciinema is installed.
Run this command with no argument to list the demos. To play a demo,
write its number or name or a substring. asciinema must be installed.
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. 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; list them with
asciinema -h. -s (speed) and -i (max idle time) are particularly use-
ful.
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
descriptions
List the unique descriptions that appear in transactions.