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

;doc: replace a few addon with add-on

Browse Source
This commit is contained in:
Simon Michael 2020-12-08 09:27:36 -08:00
parent c34c4fddc7
commit 7a692284a9
3 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
bin/README.md
View File

@ -30,7 +30,7 @@ Scripts overview, simplest first:
How to: How to:
### Install all scripts as addon commands ### Install all scripts as add-on commands
$ git clone https://github.com/simonmichael/hledger $ git clone https://github.com/simonmichael/hledger
# add hledger/bin/ to your $PATH # add hledger/bin/ to your $PATH

2
hledger/Hledger/Cli/Commands/Check.md
View File

@ -52,7 +52,7 @@ These checks can be run by specifying their names as arguments to the check comm
- **uniqueleafnames** - all account leaf names are unique (similar to the old `check-dupes` command) - **uniqueleafnames** - all account leaf names are unique (similar to the old `check-dupes` command)
### Addon checks ### Add-on checks
Some checks are not yet integrated with this command, but are available as Some checks are not yet integrated with this command, but are available as
[add-on commands] in <https://github.com/simonmichael/hledger/tree/master/bin>: [add-on commands] in <https://github.com/simonmichael/hledger/tree/master/bin>:

16
hledger/hledger.m4.md
View File

@ -472,9 +472,9 @@ To see options for a particular command, including command-specific options, run
Command-specific options must be written after the command name, eg: `hledger print -x`. Command-specific options must be written after the command name, eg: `hledger print -x`.
Additionally, if the command is an [addon](#commands), Additionally, if the command is an [add-on](#commands),
you may need to put its options after a double-hyphen, eg: `hledger ui -- --watch`. you may need to put its options after a double-hyphen, eg: `hledger ui -- --watch`.
Or, you can run the addon executable directly: `hledger-ui --watch`. Or, you can run the add-on executable directly: `hledger-ui --watch`.
## Command arguments ## Command arguments
@ -636,7 +636,7 @@ or:
### Even more escaping ### Even more escaping
When hledger runs an addon executable (eg you type `hledger ui`, hledger runs `hledger-ui`), When hledger runs an add-on executable (eg you type `hledger ui`, hledger runs `hledger-ui`),
it de-escapes command-line options and arguments once, so you might need to *triple*-escape. it de-escapes command-line options and arguments once, so you might need to *triple*-escape.
Eg in bash, running the ui command and matching the dollar sign, it's: Eg in bash, running the ui command and matching the dollar sign, it's:
@ -657,7 +657,7 @@ If you asked why *four* slashes above, this may help:
(The number of backslashes in fish shell is left as an exercise for the reader.) (The number of backslashes in fish shell is left as an exercise for the reader.)
You can always avoid the extra escaping for addons by running the addon directly: You can always avoid the extra escaping for add-ons by running the add-on directly:
`hledger-ui cur:\\$` `hledger-ui cur:\\$`
@ -1759,6 +1759,12 @@ generates interest transactions for an account according to various schemes.
<!-- and can also download the data --> <!-- and can also download the data -->
<!-- [if your bank offers OFX Direct Connect](http://wiki.gnucash.org/wiki/OFX_Direct_Connect_Bank_Settings). --> <!-- [if your bank offers OFX Direct Connect](http://wiki.gnucash.org/wiki/OFX_Direct_Connect_Bank_Settings). -->
### stockquotes
[hledger-stockquotes](http://hackage.haskell.org/package/hledger-stockquotes)
downloads market prices for the commodities in your journal from AlphaVantage.
A few more experimental or old add-ons can be found in hledger's bin/ A few more experimental or old add-ons can be found in hledger's bin/
directory. These are typically prototypes and not guaranteed to work. directory. These are typically prototypes and not guaranteed to work.
@ -1783,7 +1789,7 @@ Reads _files_
# LIMITATIONS # LIMITATIONS
The need to precede addon command options with `--` when invoked from hledger is awkward. The need to precede add-on command options with `--` when invoked from hledger is awkward.
When input data contains non-ascii characters, a suitable system locale must be configured (or there will be an unhelpful error). When input data contains non-ascii characters, a suitable system locale must be configured (or there will be an unhelpful error).
Eg on POSIX, set LANG to something other than C. Eg on POSIX, set LANG to something other than C.