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

;doc: update embedded manuals

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

4
hledger-ui/hledger-ui.1
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 .PD
\f[CR]hledger ui \-\- [OPTS] [QUERYARGS]\f[R] \f[CR]hledger ui \-\- [OPTS] [QUERYARGS]\f[R]
.SH DESCRIPTION .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. See also the hledger manual for common concepts and file formats.
.PP .PP
hledger is a robust, user\-friendly, cross\-platform set of programs for hledger is a robust, user\-friendly, cross\-platform set of programs for

2
hledger-ui/hledger-ui.info
View File

@ -18,7 +18,7 @@ plain text accounting app.
or or
'hledger ui -- [OPTS] [QUERYARGS]' '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. See also the hledger manual for common concepts and file formats.
hledger is a robust, user-friendly, cross-platform set of programs hledger is a robust, user-friendly, cross-platform set of programs

4
hledger-ui/hledger-ui.txt
View File

@ -11,7 +11,7 @@ SYNOPSIS
hledger ui -- [OPTS] [QUERYARGS] hledger ui -- [OPTS] [QUERYARGS]
DESCRIPTION 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. also the hledger manual for common concepts and file formats.
hledger is a robust, user-friendly, cross-platform set of programs for hledger is a robust, user-friendly, cross-platform set of programs for
@ -450,4 +450,4 @@ LICENSE
SEE ALSO SEE ALSO
hledger(1), hledger-ui(1), hledger-web(1), ledger(1) 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)

4
hledger-web/hledger-web.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 .PD
\f[CR]hledger web \-\- [OPTS] [QUERY]\f[R] \f[CR]hledger web \-\- [OPTS] [QUERY]\f[R]
.SH DESCRIPTION .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. See also the hledger manual for common concepts and file formats.
.PP .PP
hledger is a robust, user\-friendly, cross\-platform set of programs for hledger is a robust, user\-friendly, cross\-platform set of programs for

2
hledger-web/hledger-web.info
View File

@ -18,7 +18,7 @@ plain text accounting app.
or or
'hledger web -- [OPTS] [QUERY]' '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. also the hledger manual for common concepts and file formats.
hledger is a robust, user-friendly, cross-platform set of programs hledger is a robust, user-friendly, cross-platform set of programs

4
hledger-web/hledger-web.txt
View File

@ -11,7 +11,7 @@ SYNOPSIS
hledger web -- [OPTS] [QUERY] hledger web -- [OPTS] [QUERY]
DESCRIPTION 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. the hledger manual for common concepts and file formats.
hledger is a robust, user-friendly, cross-platform set of programs for hledger is a robust, user-friendly, cross-platform set of programs for
@ -480,4 +480,4 @@ LICENSE
SEE ALSO SEE ALSO
hledger(1), hledger-ui(1), hledger-web(1), ledger(1) 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)

58
hledger/hledger.1
View File

@ -1,6 +1,6 @@
.\"t .\"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). largely interconvertible with beancount(1).
.PP .PP
This manual is for hledger\[aq]s command line interface, version 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 It also describes the common options, file formats and concepts used by
all hledger programs. all hledger programs.
It might accidentally teach you some bookkeeping/accounting as well! 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. type \f[CR]exit\f[R] or \f[CR]quit\f[R] or control\-D to exit the REPL.
.PP .PP
While it is running, the REPL remembers your command history, and you While it is running, the REPL remembers your command history, and you
can navigate in the usual ways: \- Keypad or Emacs navigation keys to can navigate in the usual ways:
edit the current command line \- UP/DOWN or control\-P/control\-N to .IP \[bu] 2
step back/forward through history \- control\-R to search for a past Keypad or Emacs navigation keys to edit the current command line
command, etc. .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 .PP
The \f[CR]commands\f[R] and \f[CR]help\f[R]\ commands, and the command 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], 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 .PP
And in most shells you can type control\-Z to exit temporarily to the 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). 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] You may find some differences in behaviour between \f[CR]run\f[R]
command lines and normal hledger command lines. command lines and normal hledger command lines.
For example, in the REPL, For example, in the REPL,
@ -8507,16 +8512,33 @@ options parsing with addon commands might be less flexible than the CLI
.IP \[bu] 2 .IP \[bu] 2
the \f[CR]stats\f[R] command gives false timings, currently the \f[CR]stats\f[R] command gives false timings, currently
.SS Examples .SS Examples
Start the REPL: Start the REPL and enter some commands:
.IP .IP
.EX .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 .EE
.PP .PP
or or:
.IP .IP
.EX .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 .EE
.SS run .SS run
Run a sequence of hledger commands, provided as files or command line 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 .PP
It\[aq]s ok to use the \f[CR]run\f[R] command recursively within a It\[aq]s ok to use the \f[CR]run\f[R] command recursively within a
command script. command script.
.SS Caveats .PP
You may find some differences in behaviour between \f[CR]run\f[R] You may find some differences in behaviour between \f[CR]run\f[R]
command lines and normal hledger command lines. command lines and normal hledger command lines.
For example, with \f[CR]run\f[R], 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) full command names or official abbreviations (as in the command list)
must be used must be used
.SS Examples .SS Examples
Run commands specified on the command line: Run commands from the command line:
.IP .IP
.EX .EX
hledger \-f some.journal run \-\- balance assets \-\-depth 2 \-\- balance liabilities \-f /some/other.journal \-\-depth 3 \-\-transpose \-\- stats 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 (echo \[dq]files\[dq]; echo \[dq]stats\[dq]) | hledger \-f some.journal run
.EE .EE
.PP .PP
Provide commands as a runnable script: Run commands as a script:
.IP .IP
.EX .EX
$ cat report
#!/usr/bin/env \-S hledger run \-f some.journal #!/usr/bin/env \-S hledger run \-f some.journal
echo \[dq]List of accounts in some.journal\[dq] 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] echo \[dq]Commands from another.script, applied to another.journal\[dq]
run \-f another.journal another.script run \-f another.journal another.script
.EE .EE
.IP
.EX
$ chmod +x report
$ ./report
List of accounts in some.journal
\&...
.EE
.SS ui .SS ui
Runs hledger\-ui (if installed). Runs hledger\-ui (if installed).
.SS web .SS web

329
hledger/hledger.info
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 and largely compatible with ledger(1), and largely interconvertible with
beancount(1). 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 It also describes the common options, file formats and concepts used by
all hledger programs. It might accidentally teach you some all hledger programs. It might accidentally teach you some
bookkeeping/accounting as well! You don't need to know everything in 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. * type 'exit' or 'quit' or control-D to exit the REPL.
While it is running, the REPL remembers your command history, and you While it is running, the REPL remembers your command history, and you
can navigate in the usual ways: - Keypad or Emacs navigation keys to can navigate in the usual ways:
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, * Keypad or Emacs navigation keys to edit the current command line
etc. * 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 The 'commands' and 'help' commands, and the command help flags ('CMD
--tldr', 'CMD -h/--help', 'CMD --info', 'CMD --man'), work in the usual --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 And in most shells you can type control-Z to exit temporarily to the
shell (and 'fg' to return to the REPL). shell (and 'fg' to return to the REPL).
* Menu: You may find some differences in behaviour between 'run' command
lines and normal hledger command lines. For example, in the REPL,
* 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,
* the command name must be written first, options afterward * the command name must be written first, options afterward
* full command names or official abbreviations (as in the command * 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 CLI
* the 'stats' command gives false timings, currently * the 'stats' command gives false timings, currently
 * Menu:
File: hledger.info, Node: Examples, Prev: Caveats, Up: repl
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 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. It's ok to use the 'run' command recursively within a command script.
* Menu: You may find some differences in behaviour between 'run' command
lines and normal hledger command lines. For example, with 'run',
* 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',
* the command name must be written first, options afterward * the command name must be written first, options afterward
* full command names or official abbreviations (as in the command * full command names or official abbreviations (as in the command
list) must be used list) must be used
 * Menu:
File: hledger.info, Node: Examples 2, Prev: Caveats 2, Up: run
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 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 (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 #!/usr/bin/env -S hledger run -f some.journal
echo "List of accounts in 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" echo "Commands from another.script, applied to another.journal"
run -f another.journal another.script 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 File: hledger.info, Node: ui, Next: web, Prev: run, Up: User interface commands
@ -12852,123 +12863,121 @@ Node: demo295039
Node: help296273 Node: help296273
Node: User interface commands297978 Node: User interface commands297978
Node: repl298189 Node: repl298189
Node: Caveats300205 Node: Examples300659
Node: Examples300730 Node: run301217
Node: run300897 Node: Examples 2303634
Node: Caveats 2303044 Node: ui304658
Node: Examples 2303433 Node: web304795
Node: ui304416 Node: Data entry commands304923
Node: web304553 Node: add305121
Node: Data entry commands304681 Node: import307576
Node: add304879 Node: Import preview308610
Node: import307334 Node: Overlap detection309558
Node: Import preview308368 Node: First import312444
Node: Overlap detection309316 Node: Importing balance assignments313639
Node: First import312202 Node: Import and commodity styles314694
Node: Importing balance assignments313397 Node: Import special cases315132
Node: Import and commodity styles314452 Node: Basic report commands316467
Node: Import special cases314890 Node: accounts316768
Node: Basic report commands316225 Node: codes319641
Node: accounts316526 Node: commodities320663
Node: codes319399 Node: descriptions320907
Node: commodities320421 Node: files321374
Node: descriptions320665 Node: notes321671
Node: files321132 Node: payees322183
Node: notes321429 Node: prices322967
Node: payees321941 Node: stats323859
Node: prices322725 Node: tags325600
Node: stats323617 Node: Standard report commands326907
Node: tags325358 Node: print327212
Node: Standard report commands326665 Node: print explicitness329953
Node: print326970 Node: print amount style330873
Node: print explicitness329711 Node: print parseability332111
Node: print amount style330631 Node: print other features333030
Node: print parseability331869 Node: print output format333893
Node: print other features332788 Node: aregister337178
Node: print output format333651 Node: aregister and posting dates341637
Node: aregister336936 Node: register342538
Node: aregister and posting dates341395 Node: Custom register output349713
Node: register342296 Node: balancesheet350898
Node: Custom register output349471 Node: balancesheetequity355668
Node: balancesheet350656 Node: cashflow360808
Node: balancesheetequity355426 Node: incomestatement365370
Node: cashflow360566 Node: Advanced report commands369968
Node: incomestatement365128 Node: balance370176
Node: Advanced report commands369726 Node: balance features375352
Node: balance369934 Node: Simple balance report377428
Node: balance features375110 Node: Balance report line format379238
Node: Simple balance report377186 Node: Filtered balance report381598
Node: Balance report line format378996 Node: List or tree mode382117
Node: Filtered balance report381356 Node: Depth limiting383630
Node: List or tree mode381875 Node: Dropping top-level accounts384397
Node: Depth limiting383388 Node: Showing declared accounts384907
Node: Dropping top-level accounts384155 Node: Sorting by amount385637
Node: Showing declared accounts384665 Node: Percentages386474
Node: Sorting by amount385395 Node: Multi-period balance report387181
Node: Percentages386232 Node: Balance change end balance389933
Node: Multi-period balance report386939 Node: Balance report types391570
Node: Balance change end balance389691 Node: Calculation type392249
Node: Balance report types391328 Node: Accumulation type392953
Node: Calculation type392007 Node: Valuation type394054
Node: Accumulation type392711 Node: Combining balance report types395243
Node: Valuation type393812 Node: Budget report397275
Node: Combining balance report types395001 Node: Using the budget report399580
Node: Budget report397033 Node: Budget date surprises401856
Node: Using the budget report399338 Node: Selecting budget goals403220
Node: Budget date surprises401614 Node: Budgeting vs forecasting404168
Node: Selecting budget goals402978 Node: Balance report layout405845
Node: Budgeting vs forecasting403926 Node: Wide layout407050
Node: Balance report layout405603 Node: Tall layout409455
Node: Wide layout406808 Node: Bare layout410761
Node: Tall layout409213 Node: Tidy layout412825
Node: Bare layout410519 Node: Balance report output414369
Node: Tidy layout412583 Node: Some useful balance reports415184
Node: Balance report output414127 Node: roi416444
Node: Some useful balance reports414942 Node: Spaces and special characters in --inv and --pnl418691
Node: roi416202 Node: Semantics of --inv and --pnl419417
Node: Spaces and special characters in --inv and --pnl418449 Node: IRR and TWR explained421504
Node: Semantics of --inv and --pnl419175 Node: Chart commands424915
Node: IRR and TWR explained421262 Node: activity425096
Node: Chart commands424673 Node: Data generation commands425593
Node: activity424854 Node: close425799
Node: Data generation commands425351 Node: close --clopen428362
Node: close425557 Node: close --close430536
Node: close --clopen428120 Node: close --open431060
Node: close --close430294 Node: close --assert431310
Node: close --open430818 Node: close --assign431637
Node: close --assert431068 Node: close --retain432316
Node: close --assign431395 Node: close customisation433173
Node: close --retain432074 Node: close and balance assertions434817
Node: close customisation432931 Node: close examples436339
Node: close and balance assertions434575 Node: Retain earnings436576
Node: close examples436097 Node: Migrate balances to a new file437079
Node: Retain earnings436334 Node: More detailed close examples438441
Node: Migrate balances to a new file436837 Node: rewrite438663
Node: More detailed close examples438199 Node: Re-write rules in a file441235
Node: rewrite438421 Node: Diff output format442545
Node: Re-write rules in a file440993 Node: rewrite vs print --auto443818
Node: Diff output format442303 Node: Maintenance commands444532
Node: rewrite vs print --auto443576 Node: check444741
Node: Maintenance commands444290 Node: Basic checks445823
Node: check444499 Node: Strict checks446776
Node: Basic checks445581 Node: Other checks447651
Node: Strict checks446534 Node: Custom checks449506
Node: Other checks447409 Node: diff449961
Node: Custom checks449264 Node: test451168
Node: diff449719 Node: PART 5 COMMON TASKS452040
Node: test450926 Node: Getting help452273
Node: PART 5 COMMON TASKS451798 Node: Constructing command lines453182
Node: Getting help452031 Node: Starting a journal file454020
Node: Constructing command lines452940 Node: Setting LEDGER_FILE455404
Node: Starting a journal file453778 Node: Setting opening balances456662
Node: Setting LEDGER_FILE455162 Node: Recording transactions459984
Node: Setting opening balances456420 Node: Reconciling460709
Node: Recording transactions459742 Node: Reporting463098
Node: Reconciling460467 Node: Migrating to a new file467212
Node: Reporting462856 Node: BUGS467661
Node: Migrating to a new file466970 Node: Troubleshooting468626
Node: BUGS467419
Node: Troubleshooting468384
 
End Tag Table End Tag Table

1530
hledger/hledger.txt
View File

File diff suppressed because it is too large Load Diff