From d2344c119d76410b6c53a742307da1b4925db09e Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Sat, 19 Oct 2024 17:06:06 -1000 Subject: [PATCH] ;doc: update help --- hledger/Hledger/Cli/Commands/Demo.md | 4 ++-- hledger/Hledger/Cli/Commands/Demo.txt | 4 ++-- hledger/Hledger/Cli/Commands/Help.md | 8 ++++---- hledger/Hledger/Cli/Commands/Help.txt | 8 ++++---- hledger/Hledger/Cli/Commands/Print.md | 5 ++++- hledger/Hledger/Cli/Commands/Print.txt | 5 ++++- hledger/Hledger/Cli/Commands/Register.md | 5 ++++- hledger/Hledger/Cli/Commands/Register.txt | 5 ++++- 8 files changed, 28 insertions(+), 16 deletions(-) diff --git a/hledger/Hledger/Cli/Commands/Demo.md b/hledger/Hledger/Cli/Commands/Demo.md index 486273ee7..49de0a209 100644 --- a/hledger/Hledger/Cli/Commands/Demo.md +++ b/hledger/Hledger/Cli/Commands/Demo.md @@ -4,8 +4,8 @@ Play demos of hledger usage in the terminal, if [asciinema](https://asciinema.or ```flags Flags: - -s --speed=SPEED playback speed (1 is original speed, .5 is half, 2 is - double, etc (default: 2)) + -s --speed=SPEED playback speed (1 is original speed, .5 is half, 2 + is double, etc (default: 2)) ``` Run this command with no argument to list the demos. diff --git a/hledger/Hledger/Cli/Commands/Demo.txt b/hledger/Hledger/Cli/Commands/Demo.txt index 5692f95d3..d102204c5 100644 --- a/hledger/Hledger/Cli/Commands/Demo.txt +++ b/hledger/Hledger/Cli/Commands/Demo.txt @@ -3,8 +3,8 @@ demo Play demos of hledger usage in the terminal, if asciinema is installed. Flags: - -s --speed=SPEED playback speed (1 is original speed, .5 is half, 2 is - double, etc (default: 2)) + -s --speed=SPEED playback speed (1 is original speed, .5 is half, 2 + is double, etc (default: 2)) 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: diff --git a/hledger/Hledger/Cli/Commands/Help.md b/hledger/Hledger/Cli/Commands/Help.md index 42030f393..5182cf5ed 100644 --- a/hledger/Hledger/Cli/Commands/Help.md +++ b/hledger/Hledger/Cli/Commands/Help.md @@ -5,10 +5,10 @@ With a (case insensitive) TOPIC argument, try to open it at that section heading ```flags Flags: - -i show the manual with info - -m show the manual with man - -p show the manual with $PAGER or less - (less is always used if TOPIC is specified) + -i show the manual with info + -m show the manual with man + -p show the manual with $PAGER or less + (less is always used if TOPIC is specified) ``` This command shows the hledger manual built in to your hledger executable. diff --git a/hledger/Hledger/Cli/Commands/Help.txt b/hledger/Hledger/Cli/Commands/Help.txt index 842829738..ae3568cb2 100644 --- a/hledger/Hledger/Cli/Commands/Help.txt +++ b/hledger/Hledger/Cli/Commands/Help.txt @@ -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. Flags: - -i show the manual with info - -m show the manual with man - -p show the manual with $PAGER or less - (less is always used if TOPIC is specified) + -i show the manual with info + -m show the manual with man + -p show the manual with $PAGER or less + (less is always used if TOPIC is specified) This command shows the hledger manual built in to your hledger executable. It can be useful when offline, or when you prefer the diff --git a/hledger/Hledger/Cli/Commands/Print.md b/hledger/Hledger/Cli/Commands/Print.md index 22ecd5c34..047e48321 100644 --- a/hledger/Hledger/Cli/Commands/Print.md +++ b/hledger/Hledger/Cli/Commands/Print.md @@ -21,8 +21,11 @@ Flags: file since last run -m --match=DESC fuzzy search for one recent transaction with 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: - 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 one of the above formats selects that format. ``` diff --git a/hledger/Hledger/Cli/Commands/Print.txt b/hledger/Hledger/Cli/Commands/Print.txt index 9da78524c..c8db7d468 100644 --- a/hledger/Hledger/Cli/Commands/Print.txt +++ b/hledger/Hledger/Cli/Commands/Print.txt @@ -20,8 +20,11 @@ Flags: file since last run -m --match=DESC fuzzy search for one recent transaction with 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: - 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 one of the above formats selects that format. diff --git a/hledger/Hledger/Cli/Commands/Register.md b/hledger/Hledger/Cli/Commands/Register.md index 170ab7a0f..0d6b6aa52 100644 --- a/hledger/Hledger/Cli/Commands/Register.md +++ b/hledger/Hledger/Cli/Commands/Register.md @@ -22,8 +22,11 @@ Flags: -w --width=N set output width (default: terminal width or $COLUMNS). -wN,M sets description width as well. --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: - txt, csv, tsv, json. + txt, csv, tsv, html, fods, json. -o --output-file=FILE write output to FILE. A file extension matching one of the above formats selects that format. ``` diff --git a/hledger/Hledger/Cli/Commands/Register.txt b/hledger/Hledger/Cli/Commands/Register.txt index dacab899e..810005fbe 100644 --- a/hledger/Hledger/Cli/Commands/Register.txt +++ b/hledger/Hledger/Cli/Commands/Register.txt @@ -21,8 +21,11 @@ Flags: -w --width=N set output width (default: terminal width or $COLUMNS). -wN,M sets description width as well. --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: - txt, csv, tsv, json. + txt, csv, tsv, html, fods, json. -o --output-file=FILE write output to FILE. A file extension matching one of the above formats selects that format.