;doc: update embedded manuals

This commit is contained in:
Simon Michael 2025-03-07 18:49:13 -10:00
parent 4e5506da1e
commit b9cd9981f7
9 changed files with 1001 additions and 936 deletions

View File

@ -1,5 +1,5 @@
.TH "HLEDGER\-UI" "1" "March 2025" "hledger-ui-1.41.99 " "hledger User Manuals"
.TH "HLEDGER\-UI" "1" "March 2025" "hledger-ui-1.42.99 " "hledger User Manuals"
@ -17,7 +17,7 @@ or
.PD
\f[CR]hledger ui \-\- [OPTS] [QUERYARGS]\f[R]
.SH DESCRIPTION
This manual is for hledger\[aq]s terminal interface, version 1.41.99.
This manual is for hledger\[aq]s terminal interface, version 1.42.99.
See also the hledger manual for common concepts and file formats.
.PP
hledger is a robust, user\-friendly, cross\-platform set of programs for

View File

@ -18,7 +18,7 @@ plain text accounting app.
or
'hledger ui -- [OPTS] [QUERYARGS]'
This manual is for hledger's terminal interface, version 1.41.99.
This manual is for hledger's terminal interface, version 1.42.99.
See also the hledger manual for common concepts and file formats.
hledger is a robust, user-friendly, cross-platform set of programs

View File

@ -11,7 +11,7 @@ SYNOPSIS
hledger ui -- [OPTS] [QUERYARGS]
DESCRIPTION
This manual is for hledger's terminal interface, version 1.41.99. See
This manual is for hledger's terminal interface, version 1.42.99. See
also the hledger manual for common concepts and file formats.
hledger is a robust, user-friendly, cross-platform set of programs for
@ -450,4 +450,4 @@ LICENSE
SEE ALSO
hledger(1), hledger-ui(1), hledger-web(1), ledger(1)
hledger-ui-1.41.99 March 2025 HLEDGER-UI(1)
hledger-ui-1.42.99 March 2025 HLEDGER-UI(1)

View File

@ -1,5 +1,5 @@
.TH "HLEDGER\-WEB" "1" "March 2025" "hledger-web-1.41.99 " "hledger User Manuals"
.TH "HLEDGER\-WEB" "1" "March 2025" "hledger-web-1.42.99 " "hledger User Manuals"
@ -17,7 +17,7 @@ or
.PD
\f[CR]hledger web \-\- [OPTS] [QUERY]\f[R]
.SH DESCRIPTION
This manual is for hledger\[aq]s web interface, version 1.41.99.
This manual is for hledger\[aq]s web interface, version 1.42.99.
See also the hledger manual for common concepts and file formats.
.PP
hledger is a robust, user\-friendly, cross\-platform set of programs for

View File

@ -18,7 +18,7 @@ plain text accounting app.
or
'hledger web -- [OPTS] [QUERY]'
This manual is for hledger's web interface, version 1.41.99. See
This manual is for hledger's web interface, version 1.42.99. See
also the hledger manual for common concepts and file formats.
hledger is a robust, user-friendly, cross-platform set of programs

View File

@ -11,7 +11,7 @@ SYNOPSIS
hledger web -- [OPTS] [QUERY]
DESCRIPTION
This manual is for hledger's web interface, version 1.41.99. See also
This manual is for hledger's web interface, version 1.42.99. See also
the hledger manual for common concepts and file formats.
hledger is a robust, user-friendly, cross-platform set of programs for
@ -480,4 +480,4 @@ LICENSE
SEE ALSO
hledger(1), hledger-ui(1), hledger-web(1), ledger(1)
hledger-web-1.41.99 March 2025 HLEDGER-WEB(1)
hledger-web-1.42.99 March 2025 HLEDGER-WEB(1)

View File

@ -1,6 +1,6 @@
.\"t
.TH "HLEDGER" "1" "March 2025" "hledger-1.41.99 " "hledger User Manuals"
.TH "HLEDGER" "1" "March 2025" "hledger-1.42.99 " "hledger User Manuals"
@ -33,7 +33,7 @@ hledger is inspired by and largely compatible with ledger(1), and
largely interconvertible with beancount(1).
.PP
This manual is for hledger\[aq]s command line interface, version
1.41.99.
1.42.99.
It also describes the common options, file formats and concepts used by
all hledger programs.
It might accidentally teach you some bookkeeping/accounting as well!
@ -8478,10 +8478,15 @@ use single or double quotes to quote arguments when needed
type \f[CR]exit\f[R] or \f[CR]quit\f[R] or control\-D to exit the REPL.
.PP
While it is running, the REPL remembers your command history, and you
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, etc.
can navigate in the usual ways:
.IP \[bu] 2
Keypad or Emacs navigation keys to edit the current command line
.IP \[bu] 2
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.
.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],
@ -8493,7 +8498,7 @@ once; typing it a second time will exit the REPL).
.PP
And in most shells you can type control\-Z to exit temporarily to the
shell (and \f[CR]fg\f[R] to return to the REPL).
.SS Caveats
.PP
You may find some differences in behaviour between \f[CR]run\f[R]
command lines and normal hledger command lines.
For example, in the REPL,
@ -8507,16 +8512,33 @@ 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
.SS Examples
Start the REPL:
Start the REPL and enter some commands:
.IP
.EX
hledger repl
$ hledger repl
Enter hledger commands. To exit, enter \[aq]quit\[aq] or \[aq]exit\[aq], or send EOF.
% stats
Main file : .../2025.journal
\&...
% stats \-f 2024/2024.journal
Main file : .../2024.journal
\&...
% stats
Main file : .../2025.journal
\&...
.EE
.PP
or
or:
.IP
.EX
hledger repl \-f some.journal
$ hledger repl \-f some.journal
Enter hledger commands. To exit, enter \[aq]quit\[aq] or \[aq]exit\[aq], or send EOF.
% bs
\&...
% print \-b \[aq]last week\[aq]
\&...
% bs \-f other.journal
\&...
.EE
.SS run
Run a sequence of hledger commands, provided as files or command line
@ -8578,7 +8600,7 @@ If that gives an error, use \f[CR]#!/usr/bin/env \-S hledger run\f[R].
.PP
It\[aq]s ok to use the \f[CR]run\f[R] command recursively within a
command script.
.SS Caveats
.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],
@ -8588,7 +8610,7 @@ the command name must be written first, options afterward
full command names or official abbreviations (as in the command list)
must be used
.SS Examples
Run commands specified on the command line:
Run commands from the command line:
.IP
.EX
hledger \-f some.journal run \-\- balance assets \-\-depth 2 \-\- balance liabilities \-f /some/other.journal \-\-depth 3 \-\-transpose \-\- stats
@ -8606,9 +8628,10 @@ Run commands from standard input:
(echo \[dq]files\[dq]; echo \[dq]stats\[dq]) | hledger \-f some.journal run
.EE
.PP
Provide commands as a runnable script:
Run commands as a script:
.IP
.EX
$ cat report
#!/usr/bin/env \-S hledger run \-f some.journal
echo \[dq]List of accounts in some.journal\[dq]
@ -8623,6 +8646,13 @@ balance liabilities \-f /some/other.journal \-\-depth 3 \-\-transpose
echo \[dq]Commands from another.script, applied to another.journal\[dq]
run \-f another.journal another.script
.EE
.IP
.EX
$ chmod +x report
$ ./report
List of accounts in some.journal
\&...
.EE
.SS ui
Runs hledger\-ui (if installed).
.SS web

View File

@ -26,7 +26,7 @@ accounting and a simple, editable file format. hledger is inspired by
and largely compatible with ledger(1), and largely interconvertible with
beancount(1).
This manual is for hledger's command line interface, version 1.41.99.
This manual is for hledger's command line interface, version 1.42.99.
It also describes the common options, file formats and concepts used by
all hledger programs. It might accidentally teach you some
bookkeeping/accounting as well! You don't need to know everything in
@ -8204,10 +8204,12 @@ until you exit and restart the REPL.
* type 'exit' or 'quit' or control-D to exit the REPL.
While it is running, the REPL remembers your command history, and you
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,
etc.
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.
The 'commands' and 'help' commands, and the command help flags ('CMD
--tldr', 'CMD -h/--help', 'CMD --info', 'CMD --man'), work in the usual
@ -8219,19 +8221,8 @@ once; typing it a second time will exit the REPL).
And in most shells you can type control-Z to exit temporarily to the
shell (and 'fg' to return to the REPL).
* Menu:
* Caveats::
* Examples::

File: hledger.info, Node: Caveats, Next: Examples, Up: repl
25.1.1 Caveats
--------------
You may find some differences in behaviour between 'run' command lines
and normal hledger command lines. For example, in the REPL,
You may find some differences in behaviour between 'run' 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
@ -8240,19 +8231,40 @@ and normal hledger command lines. For example, in the REPL,
CLI
* the 'stats' command gives false timings, currently

File: hledger.info, Node: Examples, Prev: Caveats, Up: repl
* Menu:
25.1.2 Examples
* Examples::

File: hledger.info, Node: Examples, Up: repl
25.1.1 Examples
---------------
Start the REPL:
Start the REPL and enter some commands:
hledger repl
$ hledger repl
Enter hledger commands. To exit, enter 'quit' or 'exit', or send EOF.
% stats
Main file : .../2025.journal
...
% stats -f 2024/2024.journal
Main file : .../2024.journal
...
% stats
Main file : .../2025.journal
...
or
or:
hledger repl -f some.journal
$ hledger repl -f some.journal
Enter hledger commands. To exit, enter 'quit' or 'exit', or send EOF.
% bs
...
% print -b 'last week'
...
% bs -f other.journal
...

File: hledger.info, Node: run, Next: ui, Prev: repl, Up: User interface commands
@ -8308,31 +8320,24 @@ error, use '#!/usr/bin/env -S hledger run'.
It's ok to use the 'run' command recursively within a command script.
* Menu:
* Caveats: Caveats 2.
* Examples: Examples 2.

File: hledger.info, Node: Caveats 2, Next: Examples 2, Up: run
25.2.1 Caveats
--------------
You may find some differences in behaviour between 'run' command lines
and normal hledger command lines. For example, with 'run',
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

File: hledger.info, Node: Examples 2, Prev: Caveats 2, Up: run
* Menu:
25.2.2 Examples
* Examples: Examples 2.

File: hledger.info, Node: Examples 2, Up: run
25.2.1 Examples
---------------
Run commands specified on the command line:
Run commands from the command line:
hledger -f some.journal run -- balance assets --depth 2 -- balance liabilities -f /some/other.journal --depth 3 --transpose -- stats
@ -8344,8 +8349,9 @@ then run 'balance liabilities --depth 3 --transpose' on
(echo "files"; echo "stats") | hledger -f some.journal run
Provide commands as a runnable script:
Run commands as a script:
$ cat report
#!/usr/bin/env -S hledger run -f some.journal
echo "List of accounts in some.journal"
@ -8360,6 +8366,11 @@ balance liabilities -f /some/other.journal --depth 3 --transpose
echo "Commands from another.script, applied to another.journal"
run -f another.journal another.script
$ chmod +x report
$ ./report
List of accounts in some.journal
...

File: hledger.info, Node: ui, Next: web, Prev: run, Up: User interface commands
@ -12852,123 +12863,121 @@ Node: demo295039
Node: help296273
Node: User interface commands297978
Node: repl298189
Node: Caveats300205
Node: Examples300730
Node: run300897
Node: Caveats 2303044
Node: Examples 2303433
Node: ui304416
Node: web304553
Node: Data entry commands304681
Node: add304879
Node: import307334
Node: Import preview308368
Node: Overlap detection309316
Node: First import312202
Node: Importing balance assignments313397
Node: Import and commodity styles314452
Node: Import special cases314890
Node: Basic report commands316225
Node: accounts316526
Node: codes319399
Node: commodities320421
Node: descriptions320665
Node: files321132
Node: notes321429
Node: payees321941
Node: prices322725
Node: stats323617
Node: tags325358
Node: Standard report commands326665
Node: print326970
Node: print explicitness329711
Node: print amount style330631
Node: print parseability331869
Node: print other features332788
Node: print output format333651
Node: aregister336936
Node: aregister and posting dates341395
Node: register342296
Node: Custom register output349471
Node: balancesheet350656
Node: balancesheetequity355426
Node: cashflow360566
Node: incomestatement365128
Node: Advanced report commands369726
Node: balance369934
Node: balance features375110
Node: Simple balance report377186
Node: Balance report line format378996
Node: Filtered balance report381356
Node: List or tree mode381875
Node: Depth limiting383388
Node: Dropping top-level accounts384155
Node: Showing declared accounts384665
Node: Sorting by amount385395
Node: Percentages386232
Node: Multi-period balance report386939
Node: Balance change end balance389691
Node: Balance report types391328
Node: Calculation type392007
Node: Accumulation type392711
Node: Valuation type393812
Node: Combining balance report types395001
Node: Budget report397033
Node: Using the budget report399338
Node: Budget date surprises401614
Node: Selecting budget goals402978
Node: Budgeting vs forecasting403926
Node: Balance report layout405603
Node: Wide layout406808
Node: Tall layout409213
Node: Bare layout410519
Node: Tidy layout412583
Node: Balance report output414127
Node: Some useful balance reports414942
Node: roi416202
Node: Spaces and special characters in --inv and --pnl418449
Node: Semantics of --inv and --pnl419175
Node: IRR and TWR explained421262
Node: Chart commands424673
Node: activity424854
Node: Data generation commands425351
Node: close425557
Node: close --clopen428120
Node: close --close430294
Node: close --open430818
Node: close --assert431068
Node: close --assign431395
Node: close --retain432074
Node: close customisation432931
Node: close and balance assertions434575
Node: close examples436097
Node: Retain earnings436334
Node: Migrate balances to a new file436837
Node: More detailed close examples438199
Node: rewrite438421
Node: Re-write rules in a file440993
Node: Diff output format442303
Node: rewrite vs print --auto443576
Node: Maintenance commands444290
Node: check444499
Node: Basic checks445581
Node: Strict checks446534
Node: Other checks447409
Node: Custom checks449264
Node: diff449719
Node: test450926
Node: PART 5 COMMON TASKS451798
Node: Getting help452031
Node: Constructing command lines452940
Node: Starting a journal file453778
Node: Setting LEDGER_FILE455162
Node: Setting opening balances456420
Node: Recording transactions459742
Node: Reconciling460467
Node: Reporting462856
Node: Migrating to a new file466970
Node: BUGS467419
Node: Troubleshooting468384
Node: Examples300659
Node: run301217
Node: Examples 2303634
Node: ui304658
Node: web304795
Node: Data entry commands304923
Node: add305121
Node: import307576
Node: Import preview308610
Node: Overlap detection309558
Node: First import312444
Node: Importing balance assignments313639
Node: Import and commodity styles314694
Node: Import special cases315132
Node: Basic report commands316467
Node: accounts316768
Node: codes319641
Node: commodities320663
Node: descriptions320907
Node: files321374
Node: notes321671
Node: payees322183
Node: prices322967
Node: stats323859
Node: tags325600
Node: Standard report commands326907
Node: print327212
Node: print explicitness329953
Node: print amount style330873
Node: print parseability332111
Node: print other features333030
Node: print output format333893
Node: aregister337178
Node: aregister and posting dates341637
Node: register342538
Node: Custom register output349713
Node: balancesheet350898
Node: balancesheetequity355668
Node: cashflow360808
Node: incomestatement365370
Node: Advanced report commands369968
Node: balance370176
Node: balance features375352
Node: Simple balance report377428
Node: Balance report line format379238
Node: Filtered balance report381598
Node: List or tree mode382117
Node: Depth limiting383630
Node: Dropping top-level accounts384397
Node: Showing declared accounts384907
Node: Sorting by amount385637
Node: Percentages386474
Node: Multi-period balance report387181
Node: Balance change end balance389933
Node: Balance report types391570
Node: Calculation type392249
Node: Accumulation type392953
Node: Valuation type394054
Node: Combining balance report types395243
Node: Budget report397275
Node: Using the budget report399580
Node: Budget date surprises401856
Node: Selecting budget goals403220
Node: Budgeting vs forecasting404168
Node: Balance report layout405845
Node: Wide layout407050
Node: Tall layout409455
Node: Bare layout410761
Node: Tidy layout412825
Node: Balance report output414369
Node: Some useful balance reports415184
Node: roi416444
Node: Spaces and special characters in --inv and --pnl418691
Node: Semantics of --inv and --pnl419417
Node: IRR and TWR explained421504
Node: Chart commands424915
Node: activity425096
Node: Data generation commands425593
Node: close425799
Node: close --clopen428362
Node: close --close430536
Node: close --open431060
Node: close --assert431310
Node: close --assign431637
Node: close --retain432316
Node: close customisation433173
Node: close and balance assertions434817
Node: close examples436339
Node: Retain earnings436576
Node: Migrate balances to a new file437079
Node: More detailed close examples438441
Node: rewrite438663
Node: Re-write rules in a file441235
Node: Diff output format442545
Node: rewrite vs print --auto443818
Node: Maintenance commands444532
Node: check444741
Node: Basic checks445823
Node: Strict checks446776
Node: Other checks447651
Node: Custom checks449506
Node: diff449961
Node: test451168
Node: PART 5 COMMON TASKS452040
Node: Getting help452273
Node: Constructing command lines453182
Node: Starting a journal file454020
Node: Setting LEDGER_FILE455404
Node: Setting opening balances456662
Node: Recording transactions459984
Node: Reconciling460709
Node: Reporting463098
Node: Migrating to a new file467212
Node: BUGS467661
Node: Troubleshooting468626

End Tag Table

File diff suppressed because it is too large Load Diff