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

;doc: update help

Browse Source
This commit is contained in:
Simon Michael 2024-06-25 08:33:40 +01:00
parent 9a89adf737
commit d9f314dfa3
5 changed files with 31 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/common.m4
View File

@ -58,12 +58,13 @@ m4_dnl
m4_define({{_generaloptions_}}, {{ m4_define({{_generaloptions_}}, {{
``` ```
General input/data transformation flags: General input/data transformation flags:
-f --file=FILE Read data from FILE, or from stdin if -. Can be -f --file=[FMT:]FILE Read data from FILE, or from stdin if FILE is -,
specified more than once. If not specified, reads inferring format from extension or a FMT: prefix.
from $LEDGER_FILE or $HOME/.hledger.journal. Can be specified more than once. If not specified,
--rules-file=RULEFILE Use conversion rules from this file for reads from $LEDGER_FILE or $HOME/.hledger.journal.
--rules=RULESFILE Use rules defined in this rules file for
converting subsequent CSV/SSV/TSV files. If not converting subsequent CSV/SSV/TSV files. If not
specified, uses FILE.rules for each such FILE. specified, uses FILE.csv.rules for each FILE.csv.
--alias=A=B|/RGX/=RPL transform account names from A to B, or by --alias=A=B|/RGX/=RPL transform account names from A to B, or by
replacing regular expression matches replacing regular expression matches
--auto generate extra postings by applying auto posting --auto generate extra postings by applying auto posting
@ -126,7 +127,6 @@ General output/reporting flags (supported by some commands):
--pretty[=YN] Use box-drawing characters in text output? Can be --pretty[=YN] Use box-drawing characters in text output? Can be
'y'/'yes' or 'n'/'no'. 'y'/'yes' or 'n'/'no'.
If YN is specified, the equals is required. If YN is specified, the equals is required.
--debug=[1-9] show this level of debug output (default: 1)
General help flags: General help flags:
-h --help show command line help -h --help show command line help
@ -134,6 +134,7 @@ General help flags:
--info show the manual with info --info show the manual with info
--man show the manual with man --man show the manual with man
--version show version information --version show version information
--debug=[1-9] show this level of debug output (default: 1)
``` ```
}} )m4_dnl }} )m4_dnl
m4_dnl m4_dnl

10
hledger/Hledger/Cli/Commands/Balance.txt
View File

@ -854,11 +854,11 @@ $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout=
"Assets:US:ETrade","USD","5120.50" "Assets:US:ETrade","USD","5120.50"
"Assets:US:ETrade","VEA","36.00" "Assets:US:ETrade","VEA","36.00"
"Assets:US:ETrade","VHT","294.00" "Assets:US:ETrade","VHT","294.00"
"total","GLD","70.00" "Total:","GLD","70.00"
"total","ITOT","17.00" "Total:","ITOT","17.00"
"total","USD","5120.50" "Total:","USD","5120.50"
"total","VEA","36.00" "Total:","VEA","36.00"
"total","VHT","294.00" "Total:","VHT","294.00"
Bare layout will sometimes display an extra row for the no-symbol Bare layout will sometimes display an extra row for the no-symbol
commodity, because of zero amounts (hledger treats zeroes as commodity, because of zero amounts (hledger treats zeroes as

8
hledger/Hledger/Cli/Commands/Help.md
View File

@ -5,10 +5,10 @@ With a (case insensitive) TOPIC argument, try to open it at that section heading
```flags ```flags
Flags: Flags:
-i show the manual with info -i show the manual with info
-m show the manual with man -m show the manual with man
-p show the manual with $PAGER or less -p show the manual with $PAGER or less
(less is always used if TOPIC is specified) (less is always used if TOPIC is specified)
``` ```
This command shows the hledger manual built in to your hledger executable. This command shows the hledger manual built in to your hledger executable.

8
hledger/Hledger/Cli/Commands/Help.txt
View File

@ -4,10 +4,10 @@ Show the hledger user manual with info, man, or a pager. With a (case
insensitive) TOPIC argument, try to open it at that section heading. insensitive) TOPIC argument, try to open it at that section heading.
Flags: Flags:
-i show the manual with info -i show the manual with info
-m show the manual with man -m show the manual with man
-p show the manual with $PAGER or less -p show the manual with $PAGER or less
(less is always used if TOPIC is specified) (less is always used if TOPIC is specified)
This command shows the hledger manual built in to your hledger This command shows the hledger manual built in to your hledger
executable. It can be useful when offline, or when you prefer the executable. It can be useful when offline, or when you prefer the

12
hledger/hledger.m4.md
View File

@ -246,7 +246,17 @@ If this causes difficulty, you can always run the add-on directly, without using
Run `hledger -h` to see general command line help. Run `hledger -h` to see general command line help.
Options can be written either before or after the command name. Options can be written either before or after the command name.
The following general options are common to most hledger commands. These options are specific to the `hledger` CLI:
```
Flags:
--conf=CONFFILE Use extra options defined in this config file. If
not specified, searches upward and in XDG config
dir for hledger.conf (or .hledger.conf in $HOME).
-n --no-conf ignore any config file
```
And the following general options are common to most hledger commands:
_generaloptions_ _generaloptions_