;doc: update manuals

This commit is contained in:
Simon Michael 2023-03-16 21:53:37 -10:00
parent 7e422cb12a
commit 12853b1fda
3 changed files with 565 additions and 486 deletions

View File

@ -8062,6 +8062,8 @@ test - run self tests
.SS HELP
.IP \[bu] 2
help - show the hledger manual with info/man/pager
.IP \[bu] 2
demo - show small hledger demos in the terminal
.PP
.SS ADD-ONS
.PP
@ -10201,6 +10203,32 @@ $ hledger codes -E
.SS commodities
.PP
List all commodity/currency symbols used or declared in the journal.
.SS demo
.PP
Play small demos of hledger usage in the terminal.
.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.
.PP
During playback, several keys are available: - SPACE pause/unpause - .
step forward (while paused) - CTRL-c quit early
.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.
.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.
\f[R]
.fi
.SS descriptions
.PP
List the unique descriptions that appear in transactions.

View File

@ -6881,6 +6881,7 @@ File: hledger.info, Node: PART 4 COMMANDS, Next: PART 5 COMMON TASKS, Prev: V
* close::
* codes::
* commodities::
* demo::
* descriptions::
* diff::
* files::
@ -6998,6 +6999,7 @@ File: hledger.info, Node: HELP, Next: ADD-ONS, Prev: REPORTS BASIC, Up: Comm
-----------
• help - show the hledger manual with info/man/pager
• demo - show small hledger demos in the terminal

File: hledger.info, Node: ADD-ONS, Prev: HELP, Up: Commands overview
@ -8894,7 +8896,7 @@ $ hledger codes -E
126

File: hledger.info, Node: commodities, Next: descriptions, Prev: codes, Up: PART 4 COMMANDS
File: hledger.info, Node: commodities, Next: demo, Prev: codes, Up: PART 4 COMMANDS
24.13 commodities
=================
@ -8902,9 +8904,34 @@ File: hledger.info, Node: commodities, Next: descriptions, Prev: codes, Up:
List all commodity/currency symbols used or declared in the journal.

File: hledger.info, Node: descriptions, Next: diff, Prev: commodities, Up: PART 4 COMMANDS
File: hledger.info, Node: demo, Next: descriptions, Prev: commodities, Up: PART 4 COMMANDS
24.14 descriptions
24.14 demo
==========
Play small demos of hledger usage in the terminal.
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.
During playback, several keys are available: - SPACE pause/unpause -
. step forward (while paused) - CTRL-c quit early
asciinema options can be added following a double-dash; list them
with asciinema -h. -s (speed) and -i (max idle time) are
particularly useful.
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.

File: hledger.info, Node: descriptions, Next: diff, Prev: demo, Up: PART 4 COMMANDS
24.15 descriptions
==================
List the unique descriptions that appear in transactions.
@ -8923,7 +8950,7 @@ Person A

File: hledger.info, Node: diff, Next: files, Prev: descriptions, Up: PART 4 COMMANDS
24.15 diff
24.16 diff
==========
Compares a particular accounts transactions in two input files. It
@ -8957,7 +8984,7 @@ These transactions are in the second file only:

File: hledger.info, Node: files, Next: help, Prev: diff, Up: PART 4 COMMANDS
24.16 files
24.17 files
===========
List all files included in the journal. With a REGEX argument, only
@ -8966,7 +8993,7 @@ file names matching the regular expression (case sensitive) are shown.

File: hledger.info, Node: help, Next: import, Prev: files, Up: PART 4 COMMANDS
24.17 help
24.18 help
==========
Show the hledger user manual in the terminal, with info, man, or a
@ -8993,7 +9020,7 @@ $ hledger help journal # show the journal topic in the hledger manual

File: hledger.info, Node: import, Next: incomestatement, Prev: help, Up: PART 4 COMMANDS
24.18 import
24.19 import
============
Read new transactions added to each FILE since last run, and add them to
@ -9025,7 +9052,7 @@ most common import source, and these docs focus on that case.

File: hledger.info, Node: Deduplication, Next: Import testing, Up: import
24.18.1 Deduplication
24.19.1 Deduplication
---------------------
As a convenience import does _deduplication_ while reading
@ -9069,7 +9096,7 @@ certain date.

File: hledger.info, Node: Import testing, Next: Importing balance assignments, Prev: Deduplication, Up: import
24.18.2 Import testing
24.19.2 Import testing
----------------------
With --dry-run, the transactions that will be imported are printed to
@ -9094,7 +9121,7 @@ import.

File: hledger.info, Node: Importing balance assignments, Next: Commodity display styles, Prev: Import testing, Up: import
24.18.3 Importing balance assignments
24.19.3 Importing balance assignments
-------------------------------------
Entries added by import will have their posting amounts made explicit
@ -9113,7 +9140,7 @@ please test it and send a pull request.)

File: hledger.info, Node: Commodity display styles, Prev: Importing balance assignments, Up: import
24.18.4 Commodity display styles
24.19.4 Commodity display styles
--------------------------------
Imported amounts will be formatted according to the canonical commodity
@ -9122,7 +9149,7 @@ styles (declared or inferred) in the main journal file.

File: hledger.info, Node: incomestatement, Next: notes, Prev: import, Up: PART 4 COMMANDS
24.19 incomestatement
24.20 incomestatement
=====================
(is)
@ -9172,7 +9199,7 @@ options The output formats supported are txt, csv, html, and

File: hledger.info, Node: notes, Next: payees, Prev: incomestatement, Up: PART 4 COMMANDS
24.20 notes
24.21 notes
===========
List the unique notes that appear in transactions.
@ -9191,7 +9218,7 @@ Snacks

File: hledger.info, Node: payees, Next: prices, Prev: notes, Up: PART 4 COMMANDS
24.21 payees
24.22 payees
============
List the unique payee/payer names that appear in transactions.
@ -9216,7 +9243,7 @@ Person A

File: hledger.info, Node: prices, Next: print, Prev: payees, Up: PART 4 COMMANDS
24.22 prices
24.23 prices
============
Print market price directives from the journal. With
@ -9228,7 +9255,7 @@ displayed with their full precision.

File: hledger.info, Node: print, Next: register, Prev: prices, Up: PART 4 COMMANDS
24.23 print
24.24 print
===========
Show transaction journal entries, sorted by date.
@ -9352,7 +9379,7 @@ $ hledger print -Ocsv

File: hledger.info, Node: register, Next: rewrite, Prev: print, Up: PART 4 COMMANDS
24.24 register
24.25 register
==============
(reg)
@ -9462,7 +9489,7 @@ no posting will be shown and the program exit code will be non-zero.

File: hledger.info, Node: Custom register output, Up: register
24.24.1 Custom register output
24.25.1 Custom register output
------------------------------
register uses the full terminal width by default, except on windows.
@ -9494,7 +9521,7 @@ options The output formats supported are txt, csv, and

File: hledger.info, Node: rewrite, Next: roi, Prev: register, Up: PART 4 COMMANDS
24.25 rewrite
24.26 rewrite
=============
Print all transactions, rewriting the postings of matched transactions.
@ -9547,7 +9574,7 @@ commodity.

File: hledger.info, Node: Re-write rules in a file, Next: Diff output format, Up: rewrite
24.25.1 Re-write rules in a file
24.26.1 Re-write rules in a file
--------------------------------
During the run this tool will execute so called "Automated Transactions"
@ -9585,7 +9612,7 @@ postings.

File: hledger.info, Node: Diff output format, Next: rewrite vs print --auto, Prev: Re-write rules in a file, Up: rewrite
24.25.2 Diff output format
24.26.2 Diff output format
--------------------------
To use this tool for batch modification of your journal files you may
@ -9626,7 +9653,7 @@ output from hledger print.

File: hledger.info, Node: rewrite vs print --auto, Prev: Diff output format, Up: rewrite
24.25.3 rewrite vs. print auto
24.26.3 rewrite vs. print auto
-------------------------------
This command predates print auto, and currently does much the same
@ -9646,7 +9673,7 @@ thing, but with these differences:

File: hledger.info, Node: roi, Next: stats, Prev: rewrite, Up: PART 4 COMMANDS
24.26 roi
24.27 roi
=========
Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on
@ -9694,7 +9721,7 @@ display, regardless of the length of reporting interval.

File: hledger.info, Node: Spaces and special characters in --inv and --pnl, Next: Semantics of --inv and --pnl, Up: roi
24.26.1 Spaces and special characters in --inv and
24.27.1 Spaces and special characters in --inv and
----------------------------------------------------
--pnl Note that --inv and --pnls argument is a query, and queries
@ -9713,7 +9740,7 @@ $ hledger roi --inv="'Assets:Test 1'" --pnl="'Equity:Unrealized Profit and Loss'

File: hledger.info, Node: Semantics of --inv and --pnl, Next: IRR and TWR explained, Prev: Spaces and special characters in --inv and --pnl, Up: roi
24.26.2 Semantics of --inv and --pnl
24.27.2 Semantics of --inv and --pnl
----------------------------------------
Query supplied to --inv has to match all transactions that are related
@ -9767,7 +9794,7 @@ postings in the example below would be classifed as:

File: hledger.info, Node: IRR and TWR explained, Prev: Semantics of --inv and --pnl, Up: roi
24.26.3 IRR and TWR explained
24.27.3 IRR and TWR explained
-----------------------------
"ROI" stands for "return on investment". Traditionally this was
@ -9834,7 +9861,7 @@ your investment.

File: hledger.info, Node: stats, Next: tags, Prev: roi, Up: PART 4 COMMANDS
24.27 stats
24.28 stats
===========
Show journal and performance statistics.
@ -9874,7 +9901,7 @@ Throughput : 8342 txns/s

File: hledger.info, Node: tags, Next: test, Prev: stats, Up: PART 4 COMMANDS
24.28 tags
24.29 tags
==========
List the tags used in the journal, or their values.
@ -9904,7 +9931,7 @@ transactions also acquire tags from their postings.

File: hledger.info, Node: test, Prev: tags, Up: PART 4 COMMANDS
24.29 test
24.30 test
==========
Run built-in unit tests.
@ -10776,190 +10803,192 @@ Node: Effect of valuation on reports239415
Ref: #effect-of-valuation-on-reports239612
Node: PART 4 COMMANDS247371
Ref: #part-4-commands247514
Node: Commands overview247884
Ref: #commands-overview248018
Node: DATA ENTRY248197
Ref: #data-entry248321
Node: DATA CREATION248524
Ref: #data-creation248678
Node: DATA MANAGEMENT248802
Ref: #data-management248967
Node: REPORTS FINANCIAL249092
Ref: #reports-financial249267
Node: REPORTS VERSATILE249582
Ref: #reports-versatile249755
Node: REPORTS BASIC250016
Ref: #reports-basic250168
Node: HELP250701
Ref: #help250823
Node: ADD-ONS250882
Ref: #add-ons250988
Node: accounts251585
Ref: #accounts251718
Node: activity253693
Ref: #activity253812
Node: add254186
Ref: #add254296
Node: aregister257157
Ref: #aregister257278
Node: aregister and custom posting dates260254
Ref: #aregister-and-custom-posting-dates260420
Node: balance260988
Ref: #balance261114
Node: balance features262119
Ref: #balance-features262259
Node: Simple balance report264389
Ref: #simple-balance-report264574
Node: Balance report line format266219
Ref: #balance-report-line-format266421
Node: Filtered balance report268671
Ref: #filtered-balance-report268863
Node: List or tree mode269190
Ref: #list-or-tree-mode269358
Node: Depth limiting270733
Ref: #depth-limiting270899
Node: Dropping top-level accounts271516
Ref: #dropping-top-level-accounts271716
Node: Showing declared accounts272030
Ref: #showing-declared-accounts272229
Node: Sorting by amount272770
Ref: #sorting-by-amount272937
Node: Percentages273627
Ref: #percentages273786
Node: Multi-period balance report274356
Ref: #multi-period-balance-report274556
Node: Balance change end balance276949
Ref: #balance-change-end-balance277158
Node: Balance report types278606
Ref: #balance-report-types278787
Node: Calculation type279303
Ref: #calculation-type279458
Node: Accumulation type279989
Ref: #accumulation-type280169
Node: Valuation type281097
Ref: #valuation-type281285
Node: Combining balance report types282352
Ref: #combining-balance-report-types282546
Node: Budget report284450
Ref: #budget-report284602
Node: Budget report start date290336
Ref: #budget-report-start-date290514
Node: Budgets and subaccounts291876
Ref: #budgets-and-subaccounts292083
Node: Selecting budget goals295569
Ref: #selecting-budget-goals295768
Node: Budget vs forecast296815
Ref: #budget-vs-forecast296974
Node: Data layout298674
Ref: #data-layout298824
Node: Useful balance reports306765
Ref: #useful-balance-reports306915
Node: balancesheet308068
Ref: #balancesheet308213
Node: balancesheetequity309579
Ref: #balancesheetequity309737
Node: cashflow311180
Ref: #cashflow311311
Node: check312797
Ref: #check312911
Node: Basic checks313717
Ref: #basic-checks313837
Node: Strict checks314375
Ref: #strict-checks314518
Node: Other checks314959
Ref: #other-checks315101
Node: Custom checks315678
Ref: #custom-checks315835
Node: More about specific checks316256
Ref: #more-about-specific-checks316418
Node: close317150
Ref: #close317261
Node: close and costs319647
Ref: #close-and-costs319791
Node: close and balance assertions320080
Ref: #close-and-balance-assertions320282
Node: Example retain earnings321453
Ref: #example-retain-earnings321670
Node: Example migrate balances to a new file322028
Ref: #example-migrate-balances-to-a-new-file322293
Node: Example excluding closing/opening transactions322846
Ref: #example-excluding-closingopening-transactions323095
Node: codes324273
Ref: #codes324390
Node: commodities325266
Ref: #commodities325402
Node: descriptions325472
Ref: #descriptions325609
Node: diff325900
Ref: #diff326015
Node: files327061
Ref: #files327170
Node: help327311
Ref: #help-1327420
Node: import328410
Ref: #import328533
Node: Deduplication329641
Ref: #deduplication329766
Node: Import testing331688
Ref: #import-testing331853
Node: Importing balance assignments332704
Ref: #importing-balance-assignments332910
Node: Commodity display styles333567
Ref: #commodity-display-styles333740
Node: incomestatement333869
Ref: #incomestatement334011
Node: notes335378
Ref: #notes335500
Node: payees335862
Ref: #payees335977
Node: prices336502
Ref: #prices336617
Node: print336919
Ref: #print337034
Node: register342480
Ref: #register342602
Node: Custom register output347711
Ref: #custom-register-output347842
Node: rewrite349217
Ref: #rewrite349335
Node: Re-write rules in a file351247
Ref: #re-write-rules-in-a-file351410
Node: Diff output format352563
Ref: #diff-output-format352746
Node: rewrite vs print --auto353858
Ref: #rewrite-vs.-print---auto354020
Node: roi354594
Ref: #roi354701
Node: Spaces and special characters in --inv and --pnl356462
Ref: #spaces-and-special-characters-in---inv-and---pnl356710
Node: Semantics of --inv and --pnl357208
Ref: #semantics-of---inv-and---pnl357455
Node: IRR and TWR explained359333
Ref: #irr-and-twr-explained359493
Node: stats362605
Ref: #stats362713
Node: tags364110
Ref: #tags-1364217
Node: test365234
Ref: #test365327
Node: PART 5 COMMON TASKS366077
Ref: #part-5-common-tasks366210
Node: Getting help366484
Ref: #getting-help366625
Node: Constructing command lines367389
Ref: #constructing-command-lines367590
Node: Starting a journal file368271
Ref: #starting-a-journal-file368478
Node: Setting opening balances369676
Ref: #setting-opening-balances369881
Node: Recording transactions373034
Ref: #recording-transactions373223
Node: Reconciling373779
Ref: #reconciling373931
Node: Reporting376244
Ref: #reporting376393
Node: Migrating to a new file380382
Ref: #migrating-to-a-new-file380539
Node: Commands overview247893
Ref: #commands-overview248027
Node: DATA ENTRY248206
Ref: #data-entry248330
Node: DATA CREATION248533
Ref: #data-creation248687
Node: DATA MANAGEMENT248811
Ref: #data-management248976
Node: REPORTS FINANCIAL249101
Ref: #reports-financial249276
Node: REPORTS VERSATILE249591
Ref: #reports-versatile249764
Node: REPORTS BASIC250025
Ref: #reports-basic250177
Node: HELP250710
Ref: #help250832
Node: ADD-ONS250946
Ref: #add-ons251052
Node: accounts251649
Ref: #accounts251782
Node: activity253757
Ref: #activity253876
Node: add254250
Ref: #add254360
Node: aregister257221
Ref: #aregister257342
Node: aregister and custom posting dates260318
Ref: #aregister-and-custom-posting-dates260484
Node: balance261052
Ref: #balance261178
Node: balance features262183
Ref: #balance-features262323
Node: Simple balance report264453
Ref: #simple-balance-report264638
Node: Balance report line format266283
Ref: #balance-report-line-format266485
Node: Filtered balance report268735
Ref: #filtered-balance-report268927
Node: List or tree mode269254
Ref: #list-or-tree-mode269422
Node: Depth limiting270797
Ref: #depth-limiting270963
Node: Dropping top-level accounts271580
Ref: #dropping-top-level-accounts271780
Node: Showing declared accounts272094
Ref: #showing-declared-accounts272293
Node: Sorting by amount272834
Ref: #sorting-by-amount273001
Node: Percentages273691
Ref: #percentages273850
Node: Multi-period balance report274420
Ref: #multi-period-balance-report274620
Node: Balance change end balance277013
Ref: #balance-change-end-balance277222
Node: Balance report types278670
Ref: #balance-report-types278851
Node: Calculation type279367
Ref: #calculation-type279522
Node: Accumulation type280053
Ref: #accumulation-type280233
Node: Valuation type281161
Ref: #valuation-type281349
Node: Combining balance report types282416
Ref: #combining-balance-report-types282610
Node: Budget report284514
Ref: #budget-report284666
Node: Budget report start date290400
Ref: #budget-report-start-date290578
Node: Budgets and subaccounts291940
Ref: #budgets-and-subaccounts292147
Node: Selecting budget goals295633
Ref: #selecting-budget-goals295832
Node: Budget vs forecast296879
Ref: #budget-vs-forecast297038
Node: Data layout298738
Ref: #data-layout298888
Node: Useful balance reports306829
Ref: #useful-balance-reports306979
Node: balancesheet308132
Ref: #balancesheet308277
Node: balancesheetequity309643
Ref: #balancesheetequity309801
Node: cashflow311244
Ref: #cashflow311375
Node: check312861
Ref: #check312975
Node: Basic checks313781
Ref: #basic-checks313901
Node: Strict checks314439
Ref: #strict-checks314582
Node: Other checks315023
Ref: #other-checks315165
Node: Custom checks315742
Ref: #custom-checks315899
Node: More about specific checks316320
Ref: #more-about-specific-checks316482
Node: close317214
Ref: #close317325
Node: close and costs319711
Ref: #close-and-costs319855
Node: close and balance assertions320144
Ref: #close-and-balance-assertions320346
Node: Example retain earnings321517
Ref: #example-retain-earnings321734
Node: Example migrate balances to a new file322092
Ref: #example-migrate-balances-to-a-new-file322357
Node: Example excluding closing/opening transactions322910
Ref: #example-excluding-closingopening-transactions323159
Node: codes324337
Ref: #codes324454
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

End Tag Table

File diff suppressed because it is too large Load Diff