slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;doc: update manuals

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
hledger/hledger.1
View File

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

168
hledger/hledger.info
View File

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

26
hledger/hledger.txt
View File

@ -7384,24 +7384,26 @@ PART 4: COMMANDS
List all commodity/currency symbols used or declared in the journal. List all commodity/currency symbols used or declared in the journal.
demo 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, 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 - . 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; list them with During playback, several keys are available: SPACE to pause/unpause, .
asciinema -h. -s (speed) and -i (max idle time) are particularly use- to step forward (while paused), CTRL-c quit.
ful.
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
descriptions descriptions
List the unique descriptions that appear in transactions. List the unique descriptions that appear in transactions.