Skip to content

Commit 745e4b9

Browse files
committed
;doc: update embedded manuals
1 parent d6ce811 commit 745e4b9

File tree

3 files changed

+204
-227
lines changed

3 files changed

+204
-227
lines changed

hledger/hledger.1

Lines changed: 36 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -12760,64 +12760,55 @@ Flags:
1276012760
no command\-specific flags
1276112761
.EE
1276212762
.PP
12763-
\f[CR]setup\f[R] tests your hledger installation and prints a list of
12763+
\f[CR]setup\f[R] checks your hledger installation and reports the
1276412764
results, sometimes with helpful hints.
12765-
This is a good first command to run after installing hledger.
12766-
Also after upgrading, or when something\[aq]s not working, or just when
12767-
you want a reminder of where things are.
12768-
.PP
12769-
It makes one network request to detect the latest hledger release
12770-
version.
12771-
It\[aq]s ok if this fails or times out.
12772-
It will use ANSI color by default, unless disabled by NO_COLOR or
12773-
\-\-color=n.
12774-
It does not use a pager or a config file.
1277512765
.PP
12776-
It expects that the hledger version you are running is installed in your
12777-
PATH.
12778-
If not, it will stop until you have done that (to keep things simple).
12766+
This is a great command to run after installing hledger.
12767+
Or after upgrading, or when something\[aq]s not working, or just when
12768+
you want a reminder of where your files are.
1277912769
.PP
12780-
Example:
12770+
\f[CR]setup\f[R] attempts to make one HTTP request, to hledger.org to
12771+
detect the latest hledger release version.
12772+
It will use ANSI color by default, unless that is disabled by
12773+
\f[CR]NO_COLOR\f[R] or \f[CR]\-\-color=no\f[R].
12774+
It does not use a pager or a config file.
12775+
.PP
12776+
Example output:
1278112777
.IP
1278212778
.EX
1278312779
$ hledger setup
1278412780
Checking your hledger setup..
12785-
Legend: good, neutral, unknown, warning
12781+
Legend: good ✅, info ℹ️ , warning 🔸, problem ❗
1278612782

1278712783
hledger
12788-
* is a released version ? no hledger 1.42.99\-gbca4b39c5\-20250425, mac\-aarch64
12789-
* is up to date ? yes 1.42.99 installed, latest is 1.42.1
12790-
* is a native binary for this machine ? yes aarch64
12791-
* is installed in PATH ? yes /Users/simon/.local/bin/hledger
12792-
* has a system text encoding configured ? yes UTF\-8, data files should use this encoding
12793-
* has a user config file ? (optional) no
12794-
* current directory has a local config ? yes /Users/simon/src/hledger/hledger.conf
12795-
* the config file is readable ? yes /Users/simon/src/hledger/hledger.conf
12784+
* is a released version ? no ℹ️ hledger 1.50.99\-gd8996c05c\-20251013, mac\-aarch64
12785+
* is up to date ? checking... yes ✅ 1.50.99 installed, latest is 1.50.2
12786+
* is a native binary for this machine ? yes aarch64
12787+
* is installed in PATH (this version) ? yes /Users/simon/.local/bin/hledger
12788+
* has a system text encoding configured ? yes UTF\-8, data files must use this encoding
12789+
* has a user config file ? yes ℹ️ /Users/simon/.hledger.conf (overridden)
12790+
* has a local config file ? yes ℹ️ /Users/simon/src/hledger/hledger.conf
12791+
* the config file is readable ? yes
1279612792

1279712793
terminal
12798-
* the NO_COLOR variable is defined ? no
12799-
* \-\-color is configured by config file ? no
12800-
* hledger will use color by default ? yes
12801-
* the PAGER variable is defined ? yes less
12802-
* \-\-pager is configured by config file ? no
12803-
* hledger will use a pager when needed ? yes /opt/homebrew/bin/less
12804-
* the LESS variable is defined ? yes
12805-
* the HLEDGER_LESS variable is defined ? no
12806-
* adjusting LESS variable for color etc. ? yes
12807-
* \-\-pretty is enabled by config file ? no tables will use ASCII characters
12808-
* bash shell completions are installed ? ?
12809-
* zsh shell completions are installed ? ?
12794+
* the NO_COLOR variable is defined ? no ℹ️
12795+
* \-\-color is configured by config file ? no ℹ️
12796+
* hledger will use color by default ? yes ✅
12797+
* the PAGER variable is defined ? yes ℹ️ cat
12798+
* \-\-pager is configured by config file ? no ℹ️
12799+
* hledger will use a pager when needed ? yes ✅ /bin/cat
12800+
* tables will use box\-drawing chars ? no ℹ️ you can use \-\-pretty to enable them
1281012801

1281112802
journal
12812-
* the LEDGER_FILE variable is defined ? yes /Users/simon/finance/2025/2025.journal
12813-
* a default journal file is readable ? yes /Users/simon/finance/2025/2025.journal
12814-
* it includes additional files ? yes 15
12815-
* all commodities are declared ? yes 10
12816-
* all accounts are declared ? yes 160
12817-
* all accounts have types ? no 14 untyped
12818-
* accounts of each type were detected ? yes ALERXCV
12819-
* commodities/accounts are checked ? no use \-s to check commodities/accounts
12820-
* balance assertions are checked ? yes use \-I to ignore assertions
12803+
* the LEDGER_FILE variable is defined ? yes ℹ️ examples/sample.journal
12804+
* a default journal file is readable ? yes ✅ ./examples/sample.journal
12805+
* it includes additional files ? no ℹ️
12806+
* all commodities are declared ? no 🔸 1 undeclared commodities
12807+
* all accounts are declared ? no 🔸 8 undeclared accounts
12808+
* all accounts have types ? yes ✅
12809+
* accounts of all types exist ? no 🔸 no EV accounts found, some features may not work
12810+
* commodities/accounts are being checked ? no ℹ️ you can use \-s to check them
12811+
* balance assertions are being checked ? yes ✅ you can use \-I to ignore them
1282112812
.EE
1282212813
.SS test
1282312814
Run built\-in unit tests.

hledger/hledger.info

Lines changed: 48 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -12483,60 +12483,53 @@ Check the status of the hledger installation.
1248312483
Flags:
1248412484
no command-specific flags
1248512485

12486-
'setup' tests your hledger installation and prints a list of results,
12487-
sometimes with helpful hints. This is a good first command to run after
12488-
installing hledger. Also after upgrading, or when something's not
12489-
working, or just when you want a reminder of where things are.
12486+
'setup' checks your hledger installation and reports the results,
12487+
sometimes with helpful hints.
1249012488

12491-
It makes one network request to detect the latest hledger release
12492-
version. It's ok if this fails or times out. It will use ANSI color by
12493-
default, unless disabled by NO_COLOR or -color=n. It does not use a
12494-
pager or a config file.
12489+
This is a great command to run after installing hledger. Or after
12490+
upgrading, or when something's not working, or just when you want a
12491+
reminder of where your files are.
1249512492

12496-
It expects that the hledger version you are running is installed in
12497-
your PATH. If not, it will stop until you have done that (to keep things
12498-
simple).
12493+
'setup' attempts to make one HTTP request, to hledger.org to detect
12494+
the latest hledger release version. It will use ANSI color by default,
12495+
unless that is disabled by 'NO_COLOR' or '--color=no'. It does not use
12496+
a pager or a config file.
1249912497

12500-
Example:
12498+
Example output:
1250112499

1250212500
$ hledger setup
1250312501
Checking your hledger setup..
12504-
Legend: good, neutral, unknown, warning
12502+
Legend: good ✅, info ℹ️ , warning 🔸, problem ❗
1250512503

1250612504
hledger
12507-
* is a released version ? no hledger 1.42.99-gbca4b39c5-20250425, mac-aarch64
12508-
* is up to date ? yes 1.42.99 installed, latest is 1.42.1
12509-
* is a native binary for this machine ? yes aarch64
12510-
* is installed in PATH ? yes /Users/simon/.local/bin/hledger
12511-
* has a system text encoding configured ? yes UTF-8, data files should use this encoding
12512-
* has a user config file ? (optional) no
12513-
* current directory has a local config ? yes /Users/simon/src/hledger/hledger.conf
12514-
* the config file is readable ? yes /Users/simon/src/hledger/hledger.conf
12505+
* is a released version ? no ℹ️ hledger 1.50.99-gd8996c05c-20251013, mac-aarch64
12506+
* is up to date ? checking... yes ✅ 1.50.99 installed, latest is 1.50.2
12507+
* is a native binary for this machine ? yes aarch64
12508+
* is installed in PATH (this version) ? yes /Users/simon/.local/bin/hledger
12509+
* has a system text encoding configured ? yes UTF-8, data files must use this encoding
12510+
* has a user config file ? yes ℹ️ /Users/simon/.hledger.conf (overridden)
12511+
* has a local config file ? yes ℹ️ /Users/simon/src/hledger/hledger.conf
12512+
* the config file is readable ? yes
1251512513

1251612514
terminal
12517-
* the NO_COLOR variable is defined ? no
12518-
* --color is configured by config file ? no
12519-
* hledger will use color by default ? yes
12520-
* the PAGER variable is defined ? yes less
12521-
* --pager is configured by config file ? no
12522-
* hledger will use a pager when needed ? yes /opt/homebrew/bin/less
12523-
* the LESS variable is defined ? yes
12524-
* the HLEDGER_LESS variable is defined ? no
12525-
* adjusting LESS variable for color etc. ? yes
12526-
* --pretty is enabled by config file ? no tables will use ASCII characters
12527-
* bash shell completions are installed ? ?
12528-
* zsh shell completions are installed ? ?
12515+
* the NO_COLOR variable is defined ? no ℹ️
12516+
* --color is configured by config file ? no ℹ️
12517+
* hledger will use color by default ? yes ✅
12518+
* the PAGER variable is defined ? yes ℹ️ cat
12519+
* --pager is configured by config file ? no ℹ️
12520+
* hledger will use a pager when needed ? yes ✅ /bin/cat
12521+
* tables will use box-drawing chars ? no ℹ️ you can use --pretty to enable them
1252912522

1253012523
journal
12531-
* the LEDGER_FILE variable is defined ? yes /Users/simon/finance/2025/2025.journal
12532-
* a default journal file is readable ? yes /Users/simon/finance/2025/2025.journal
12533-
* it includes additional files ? yes 15
12534-
* all commodities are declared ? yes 10
12535-
* all accounts are declared ? yes 160
12536-
* all accounts have types ? no 14 untyped
12537-
* accounts of each type were detected ? yes ALERXCV
12538-
* commodities/accounts are checked ? no use -s to check commodities/accounts
12539-
* balance assertions are checked ? yes use -I to ignore assertions
12524+
* the LEDGER_FILE variable is defined ? yes ℹ️ examples/sample.journal
12525+
* a default journal file is readable ? yes ✅ ./examples/sample.journal
12526+
* it includes additional files ? no ℹ️
12527+
* all commodities are declared ? no 🔸 1 undeclared commodities
12528+
* all accounts are declared ? no 🔸 8 undeclared accounts
12529+
* all accounts have types ? yes ✅
12530+
* accounts of all types exist ? no 🔸 no EV accounts found, some features may not work
12531+
* commodities/accounts are being checked ? no ℹ️ you can use -s to check them
12532+
* balance assertions are being checked ? yes ✅ you can use -I to ignore them
1254012533

1254112534

1254212535
File: hledger.info, Node: test, Prev: setup, Up: Maintenance commands
@@ -13472,19 +13465,19 @@ Node: Other checks466092
1347213465
Node: Custom checks467844
1347313466
Node: diff468299
1347413467
Node: setup469507
13475-
Node: test472374
13476-
Node: PART 5 COMMON TASKS473277
13477-
Node: Getting help473510
13478-
Node: Constructing command lines474419
13479-
Node: Starting a journal file475264
13480-
Node: Setting LEDGER_FILE476648
13481-
Node: Setting opening balances477906
13482-
Node: Recording transactions481228
13483-
Node: Reconciling481953
13484-
Node: Reporting484342
13485-
Node: Migrating to a new file488456
13486-
Node: BUGS488905
13487-
Node: Troubleshooting489735
13468+
Node: test472168
13469+
Node: PART 5 COMMON TASKS473071
13470+
Node: Getting help473304
13471+
Node: Constructing command lines474213
13472+
Node: Starting a journal file475058
13473+
Node: Setting LEDGER_FILE476442
13474+
Node: Setting opening balances477700
13475+
Node: Recording transactions481022
13476+
Node: Reconciling481747
13477+
Node: Reporting484136
13478+
Node: Migrating to a new file488250
13479+
Node: BUGS488699
13480+
Node: Troubleshooting489529
1348813481

1348913482
End Tag Table
1349013483

0 commit comments

Comments
 (0)