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

;doc: update help

Browse Source
This commit is contained in:
Simon Michael 2024-10-19 17:06:06 -10:00
parent 6893f342af
commit d2344c119d
8 changed files with 28 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
hledger/Hledger/Cli/Commands/Demo.md
View File

@ -4,8 +4,8 @@ Play demos of hledger usage in the terminal, if [asciinema](https://asciinema.or
```flags ```flags
Flags: Flags:
-s --speed=SPEED playback speed (1 is original speed, .5 is half, 2 is -s --speed=SPEED playback speed (1 is original speed, .5 is half, 2
double, etc (default: 2)) is double, etc (default: 2))
``` ```
Run this command with no argument to list the demos. Run this command with no argument to list the demos.

4
hledger/Hledger/Cli/Commands/Demo.txt
View File

@ -3,8 +3,8 @@ demo
Play demos of hledger usage in the terminal, if asciinema is installed. Play demos of hledger usage in the terminal, if asciinema is installed.
Flags: Flags:
-s --speed=SPEED playback speed (1 is original speed, .5 is half, 2 is -s --speed=SPEED playback speed (1 is original speed, .5 is half, 2
double, etc (default: 2)) is double, etc (default: 2))
Run this command with no argument to list the demos. To play a demo, Run this command with no argument to list the demos. To play a demo,
write its number or a prefix or substring of its title. Tips: write its number or a prefix or substring of its title. Tips:

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

5
hledger/Hledger/Cli/Commands/Print.md
View File

@ -21,8 +21,11 @@ Flags:
file since last run file since last run
-m --match=DESC fuzzy search for one recent transaction with -m --match=DESC fuzzy search for one recent transaction with
description closest to DESC description closest to DESC
--base-url=URLPREFIX in html output, generate links to hledger-web,
with this prefix. (Usually the base url shown by
hledger-web; can also be relative.)
-O --output-format=FMT select the output format. Supported formats: -O --output-format=FMT select the output format. Supported formats:
txt, beancount, csv, tsv, json, sql. txt, beancount, csv, tsv, html, fods, json, sql.
-o --output-file=FILE write output to FILE. A file extension matching -o --output-file=FILE write output to FILE. A file extension matching
one of the above formats selects that format. one of the above formats selects that format.
``` ```

5
hledger/Hledger/Cli/Commands/Print.txt
View File

@ -20,8 +20,11 @@ Flags:
file since last run file since last run
-m --match=DESC fuzzy search for one recent transaction with -m --match=DESC fuzzy search for one recent transaction with
description closest to DESC description closest to DESC
--base-url=URLPREFIX in html output, generate links to hledger-web,
with this prefix. (Usually the base url shown by
hledger-web; can also be relative.)
-O --output-format=FMT select the output format. Supported formats: -O --output-format=FMT select the output format. Supported formats:
txt, beancount, csv, tsv, json, sql. txt, beancount, csv, tsv, html, fods, json, sql.
-o --output-file=FILE write output to FILE. A file extension matching -o --output-file=FILE write output to FILE. A file extension matching
one of the above formats selects that format. one of the above formats selects that format.

5
hledger/Hledger/Cli/Commands/Register.md
View File

@ -22,8 +22,11 @@ Flags:
-w --width=N set output width (default: terminal width or -w --width=N set output width (default: terminal width or
$COLUMNS). -wN,M sets description width as well. $COLUMNS). -wN,M sets description width as well.
--align-all guarantee alignment across all lines (slower) --align-all guarantee alignment across all lines (slower)
--base-url=URLPREFIX in html output, generate links to hledger-web,
with this prefix. (Usually the base url shown by
hledger-web; can also be relative.)
-O --output-format=FMT select the output format. Supported formats: -O --output-format=FMT select the output format. Supported formats:
txt, csv, tsv, json. txt, csv, tsv, html, fods, json.
-o --output-file=FILE write output to FILE. A file extension matching -o --output-file=FILE write output to FILE. A file extension matching
one of the above formats selects that format. one of the above formats selects that format.
``` ```

5
hledger/Hledger/Cli/Commands/Register.txt
View File

@ -21,8 +21,11 @@ Flags:
-w --width=N set output width (default: terminal width or -w --width=N set output width (default: terminal width or
$COLUMNS). -wN,M sets description width as well. $COLUMNS). -wN,M sets description width as well.
--align-all guarantee alignment across all lines (slower) --align-all guarantee alignment across all lines (slower)
--base-url=URLPREFIX in html output, generate links to hledger-web,
with this prefix. (Usually the base url shown by
hledger-web; can also be relative.)
-O --output-format=FMT select the output format. Supported formats: -O --output-format=FMT select the output format. Supported formats:
txt, csv, tsv, json. txt, csv, tsv, html, fods, json.
-o --output-file=FILE write output to FILE. A file extension matching -o --output-file=FILE write output to FILE. A file extension matching
one of the above formats selects that format. one of the above formats selects that format.