From 7a692284a9a46f6731da35cddf5d9715e669ecf3 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 8 Dec 2020 09:27:36 -0800 Subject: [PATCH] ;doc: replace a few addon with add-on --- bin/README.md | 2 +- hledger/Hledger/Cli/Commands/Check.md | 2 +- hledger/hledger.m4.md | 16 +++++++++++----- 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/bin/README.md b/bin/README.md index cc56320a6..c6431bcf2 100644 --- a/bin/README.md +++ b/bin/README.md @@ -30,7 +30,7 @@ Scripts overview, simplest first: How to: -### Install all scripts as addon commands +### Install all scripts as add-on commands $ git clone https://github.com/simonmichael/hledger # add hledger/bin/ to your $PATH diff --git a/hledger/Hledger/Cli/Commands/Check.md b/hledger/Hledger/Cli/Commands/Check.md index c3c7b5f03..96fe71a42 100644 --- a/hledger/Hledger/Cli/Commands/Check.md +++ b/hledger/Hledger/Cli/Commands/Check.md @@ -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) -### Addon checks +### Add-on checks Some checks are not yet integrated with this command, but are available as [add-on commands] in : diff --git a/hledger/hledger.m4.md b/hledger/hledger.m4.md index b372c986c..9028f89e9 100644 --- a/hledger/hledger.m4.md +++ b/hledger/hledger.m4.md @@ -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`. -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`. -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 @@ -636,7 +636,7 @@ or: ### 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. 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.) -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:\\$` @@ -1759,6 +1759,12 @@ generates interest transactions for an account according to various schemes. +### 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/ directory. These are typically prototypes and not guaranteed to work. @@ -1783,7 +1789,7 @@ Reads _files_ # 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). Eg on POSIX, set LANG to something other than C.