;doc: update embedded manuals
This commit is contained in:
parent
054e9561e4
commit
52d99ee1eb
@ -8487,32 +8487,22 @@ UP/DOWN or control\-P/control\-N to step back/forward through history
|
||||
.IP \[bu] 2
|
||||
control\-R to search for a past command
|
||||
.IP \[bu] 2
|
||||
TAB completes file paths.
|
||||
TAB to complete file paths.
|
||||
.PP
|
||||
The \f[CR]commands\f[R] and \f[CR]help\f[R]\ commands, and the command
|
||||
Generally \f[CR]repl\f[R] command lines should feel much like the normal
|
||||
hledger CLI, but you may find differences.
|
||||
\f[CR]repl\f[R] is a little stricter; eg it requires full command names
|
||||
or official abbreviations (as seen in the commands list).
|
||||
.PP
|
||||
The \f[CR]commands\f[R] and \f[CR]help\f[R] commands, and the command
|
||||
help flags (\f[CR]CMD \-\-tldr\f[R], \f[CR]CMD \-h/\-\-help\f[R],
|
||||
\f[CR]CMD \-\-info\f[R], \f[CR]CMD \-\-man\f[R]), work in the usual way,
|
||||
and can be useful.
|
||||
\f[CR]CMD \-\-info\f[R], \f[CR]CMD \-\-man\f[R]), can be useful.
|
||||
.PP
|
||||
You can type control\-C to cancel a long\-running command (but only
|
||||
once; typing it a second time will exit the REPL).
|
||||
.PP
|
||||
And in most shells you can type control\-Z to temporarily exit to the
|
||||
shell (and \f[CR]fg\f[R] to bring it back to foreground and return to
|
||||
the REPL).
|
||||
.PP
|
||||
You may find some differences in behaviour between \f[CR]repl\f[R]
|
||||
command lines and normal hledger command lines.
|
||||
For example, in the REPL,
|
||||
.IP \[bu] 2
|
||||
the command name must be written first, options afterward
|
||||
.IP \[bu] 2
|
||||
full command names or official abbreviations (as in the command list)
|
||||
must be used
|
||||
.IP \[bu] 2
|
||||
options parsing with addon commands might be less flexible than the CLI
|
||||
.IP \[bu] 2
|
||||
the \f[CR]stats\f[R] command gives false timings, currently
|
||||
shell (and then \f[CR]fg\f[R] to return to the REPL).
|
||||
.SS Examples
|
||||
Start the REPL and enter some commands:
|
||||
.IP
|
||||
@ -8605,12 +8595,9 @@ command script.
|
||||
.PP
|
||||
You may find some differences in behaviour between \f[CR]run\f[R]
|
||||
command lines and normal hledger command lines.
|
||||
For example, with \f[CR]run\f[R],
|
||||
.IP \[bu] 2
|
||||
the command name must be written first, options afterward
|
||||
.IP \[bu] 2
|
||||
full command names or official abbreviations (as in the command list)
|
||||
must be used
|
||||
\f[CR]run\f[R] is a little stricter; eg it requires full command names
|
||||
or official abbreviations (as seen in the commands list), and command
|
||||
options must be written after the command name.
|
||||
.SS Examples
|
||||
Run commands from the command line:
|
||||
.IP
|
||||
|
||||
@ -8209,27 +8209,21 @@ can navigate in the usual ways:
|
||||
* Keypad or Emacs navigation keys to edit the current command line
|
||||
* UP/DOWN or control-P/control-N to step back/forward through history
|
||||
* control-R to search for a past command
|
||||
* TAB completes file paths.
|
||||
* TAB to complete file paths.
|
||||
|
||||
Generally 'repl' command lines should feel much like the normal
|
||||
hledger CLI, but you may find differences. 'repl' is a little stricter;
|
||||
eg it requires full command names or official abbreviations (as seen in
|
||||
the commands list).
|
||||
|
||||
The 'commands' and 'help' commands, and the command help flags ('CMD
|
||||
--tldr', 'CMD -h/--help', 'CMD --info', 'CMD --man'), work in the usual
|
||||
way, and can be useful.
|
||||
--tldr', 'CMD -h/--help', 'CMD --info', 'CMD --man'), can be useful.
|
||||
|
||||
You can type control-C to cancel a long-running command (but only
|
||||
once; typing it a second time will exit the REPL).
|
||||
|
||||
And in most shells you can type control-Z to temporarily exit to the
|
||||
shell (and 'fg' to bring it back to foreground and return to the REPL).
|
||||
|
||||
You may find some differences in behaviour between 'repl' command
|
||||
lines and normal hledger command lines. For example, in the REPL,
|
||||
|
||||
* the command name must be written first, options afterward
|
||||
* full command names or official abbreviations (as in the command
|
||||
list) must be used
|
||||
* options parsing with addon commands might be less flexible than the
|
||||
CLI
|
||||
* the 'stats' command gives false timings, currently
|
||||
shell (and then 'fg' to return to the REPL).
|
||||
|
||||
* Menu:
|
||||
|
||||
@ -8321,11 +8315,10 @@ error, use '#!/usr/bin/env -S hledger run'.
|
||||
It's ok to use the 'run' command recursively within a command script.
|
||||
|
||||
You may find some differences in behaviour between 'run' command
|
||||
lines and normal hledger command lines. For example, with 'run',
|
||||
|
||||
* the command name must be written first, options afterward
|
||||
* full command names or official abbreviations (as in the command
|
||||
list) must be used
|
||||
lines and normal hledger command lines. 'run' is a little stricter; eg
|
||||
it requires full command names or official abbreviations (as seen in the
|
||||
commands list), and command options must be written after the command
|
||||
name.
|
||||
|
||||
* Menu:
|
||||
|
||||
@ -12863,121 +12856,121 @@ Node: demo295039
|
||||
Node: help296273
|
||||
Node: User interface commands297978
|
||||
Node: repl298189
|
||||
Node: Examples300704
|
||||
Node: run301262
|
||||
Node: Examples 2303679
|
||||
Node: ui304703
|
||||
Node: web304840
|
||||
Node: Data entry commands304968
|
||||
Node: add305166
|
||||
Node: import307621
|
||||
Node: Import preview308655
|
||||
Node: Overlap detection309603
|
||||
Node: First import312489
|
||||
Node: Importing balance assignments313684
|
||||
Node: Import and commodity styles314739
|
||||
Node: Import special cases315177
|
||||
Node: Basic report commands316512
|
||||
Node: accounts316813
|
||||
Node: codes319686
|
||||
Node: commodities320708
|
||||
Node: descriptions320952
|
||||
Node: files321419
|
||||
Node: notes321716
|
||||
Node: payees322228
|
||||
Node: prices323012
|
||||
Node: stats323904
|
||||
Node: tags325645
|
||||
Node: Standard report commands326952
|
||||
Node: print327257
|
||||
Node: print explicitness329998
|
||||
Node: print amount style330918
|
||||
Node: print parseability332156
|
||||
Node: print other features333075
|
||||
Node: print output format333938
|
||||
Node: aregister337223
|
||||
Node: aregister and posting dates341682
|
||||
Node: register342583
|
||||
Node: Custom register output349758
|
||||
Node: balancesheet350943
|
||||
Node: balancesheetequity355713
|
||||
Node: cashflow360853
|
||||
Node: incomestatement365415
|
||||
Node: Advanced report commands370013
|
||||
Node: balance370221
|
||||
Node: balance features375397
|
||||
Node: Simple balance report377473
|
||||
Node: Balance report line format379283
|
||||
Node: Filtered balance report381643
|
||||
Node: List or tree mode382162
|
||||
Node: Depth limiting383675
|
||||
Node: Dropping top-level accounts384442
|
||||
Node: Showing declared accounts384952
|
||||
Node: Sorting by amount385682
|
||||
Node: Percentages386519
|
||||
Node: Multi-period balance report387226
|
||||
Node: Balance change end balance389978
|
||||
Node: Balance report types391615
|
||||
Node: Calculation type392294
|
||||
Node: Accumulation type392998
|
||||
Node: Valuation type394099
|
||||
Node: Combining balance report types395288
|
||||
Node: Budget report397320
|
||||
Node: Using the budget report399625
|
||||
Node: Budget date surprises401901
|
||||
Node: Selecting budget goals403265
|
||||
Node: Budgeting vs forecasting404213
|
||||
Node: Balance report layout405890
|
||||
Node: Wide layout407095
|
||||
Node: Tall layout409500
|
||||
Node: Bare layout410806
|
||||
Node: Tidy layout412870
|
||||
Node: Balance report output414414
|
||||
Node: Some useful balance reports415229
|
||||
Node: roi416489
|
||||
Node: Spaces and special characters in --inv and --pnl418736
|
||||
Node: Semantics of --inv and --pnl419462
|
||||
Node: IRR and TWR explained421549
|
||||
Node: Chart commands424960
|
||||
Node: activity425141
|
||||
Node: Data generation commands425638
|
||||
Node: close425844
|
||||
Node: close --clopen428407
|
||||
Node: close --close430581
|
||||
Node: close --open431105
|
||||
Node: close --assert431355
|
||||
Node: close --assign431682
|
||||
Node: close --retain432361
|
||||
Node: close customisation433218
|
||||
Node: close and balance assertions434862
|
||||
Node: close examples436384
|
||||
Node: Retain earnings436621
|
||||
Node: Migrate balances to a new file437124
|
||||
Node: More detailed close examples438486
|
||||
Node: rewrite438708
|
||||
Node: Re-write rules in a file441280
|
||||
Node: Diff output format442590
|
||||
Node: rewrite vs print --auto443863
|
||||
Node: Maintenance commands444577
|
||||
Node: check444786
|
||||
Node: Basic checks445868
|
||||
Node: Strict checks446821
|
||||
Node: Other checks447696
|
||||
Node: Custom checks449551
|
||||
Node: diff450006
|
||||
Node: test451213
|
||||
Node: PART 5 COMMON TASKS452085
|
||||
Node: Getting help452318
|
||||
Node: Constructing command lines453227
|
||||
Node: Starting a journal file454065
|
||||
Node: Setting LEDGER_FILE455449
|
||||
Node: Setting opening balances456707
|
||||
Node: Recording transactions460029
|
||||
Node: Reconciling460754
|
||||
Node: Reporting463143
|
||||
Node: Migrating to a new file467257
|
||||
Node: BUGS467706
|
||||
Node: Troubleshooting468671
|
||||
Node: Examples300453
|
||||
Node: run301011
|
||||
Node: Examples 2303426
|
||||
Node: ui304450
|
||||
Node: web304587
|
||||
Node: Data entry commands304715
|
||||
Node: add304913
|
||||
Node: import307368
|
||||
Node: Import preview308402
|
||||
Node: Overlap detection309350
|
||||
Node: First import312236
|
||||
Node: Importing balance assignments313431
|
||||
Node: Import and commodity styles314486
|
||||
Node: Import special cases314924
|
||||
Node: Basic report commands316259
|
||||
Node: accounts316560
|
||||
Node: codes319433
|
||||
Node: commodities320455
|
||||
Node: descriptions320699
|
||||
Node: files321166
|
||||
Node: notes321463
|
||||
Node: payees321975
|
||||
Node: prices322759
|
||||
Node: stats323651
|
||||
Node: tags325392
|
||||
Node: Standard report commands326699
|
||||
Node: print327004
|
||||
Node: print explicitness329745
|
||||
Node: print amount style330665
|
||||
Node: print parseability331903
|
||||
Node: print other features332822
|
||||
Node: print output format333685
|
||||
Node: aregister336970
|
||||
Node: aregister and posting dates341429
|
||||
Node: register342330
|
||||
Node: Custom register output349505
|
||||
Node: balancesheet350690
|
||||
Node: balancesheetequity355460
|
||||
Node: cashflow360600
|
||||
Node: incomestatement365162
|
||||
Node: Advanced report commands369760
|
||||
Node: balance369968
|
||||
Node: balance features375144
|
||||
Node: Simple balance report377220
|
||||
Node: Balance report line format379030
|
||||
Node: Filtered balance report381390
|
||||
Node: List or tree mode381909
|
||||
Node: Depth limiting383422
|
||||
Node: Dropping top-level accounts384189
|
||||
Node: Showing declared accounts384699
|
||||
Node: Sorting by amount385429
|
||||
Node: Percentages386266
|
||||
Node: Multi-period balance report386973
|
||||
Node: Balance change end balance389725
|
||||
Node: Balance report types391362
|
||||
Node: Calculation type392041
|
||||
Node: Accumulation type392745
|
||||
Node: Valuation type393846
|
||||
Node: Combining balance report types395035
|
||||
Node: Budget report397067
|
||||
Node: Using the budget report399372
|
||||
Node: Budget date surprises401648
|
||||
Node: Selecting budget goals403012
|
||||
Node: Budgeting vs forecasting403960
|
||||
Node: Balance report layout405637
|
||||
Node: Wide layout406842
|
||||
Node: Tall layout409247
|
||||
Node: Bare layout410553
|
||||
Node: Tidy layout412617
|
||||
Node: Balance report output414161
|
||||
Node: Some useful balance reports414976
|
||||
Node: roi416236
|
||||
Node: Spaces and special characters in --inv and --pnl418483
|
||||
Node: Semantics of --inv and --pnl419209
|
||||
Node: IRR and TWR explained421296
|
||||
Node: Chart commands424707
|
||||
Node: activity424888
|
||||
Node: Data generation commands425385
|
||||
Node: close425591
|
||||
Node: close --clopen428154
|
||||
Node: close --close430328
|
||||
Node: close --open430852
|
||||
Node: close --assert431102
|
||||
Node: close --assign431429
|
||||
Node: close --retain432108
|
||||
Node: close customisation432965
|
||||
Node: close and balance assertions434609
|
||||
Node: close examples436131
|
||||
Node: Retain earnings436368
|
||||
Node: Migrate balances to a new file436871
|
||||
Node: More detailed close examples438233
|
||||
Node: rewrite438455
|
||||
Node: Re-write rules in a file441027
|
||||
Node: Diff output format442337
|
||||
Node: rewrite vs print --auto443610
|
||||
Node: Maintenance commands444324
|
||||
Node: check444533
|
||||
Node: Basic checks445615
|
||||
Node: Strict checks446568
|
||||
Node: Other checks447443
|
||||
Node: Custom checks449298
|
||||
Node: diff449753
|
||||
Node: test450960
|
||||
Node: PART 5 COMMON TASKS451832
|
||||
Node: Getting help452065
|
||||
Node: Constructing command lines452974
|
||||
Node: Starting a journal file453812
|
||||
Node: Setting LEDGER_FILE455196
|
||||
Node: Setting opening balances456454
|
||||
Node: Recording transactions459776
|
||||
Node: Reconciling460501
|
||||
Node: Reporting462890
|
||||
Node: Migrating to a new file467004
|
||||
Node: BUGS467453
|
||||
Node: Troubleshooting468418
|
||||
|
||||
End Tag Table
|
||||
|
||||
|
||||
1473
hledger/hledger.txt
1473
hledger/hledger.txt
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user