From e3fc891ea6258f256e804c6b7168f74079b3b7b2 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 31 Oct 2017 12:52:23 -0700 Subject: [PATCH] doc: argument files: fix typos, add links [ci skip] --- site/argfiles.md | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/site/argfiles.md b/site/argfiles.md index b62024a35..c6e77c5e4 100644 --- a/site/argfiles.md +++ b/site/argfiles.md @@ -21,14 +21,15 @@ cur:. The format is one command-line flag or command-line argument per line. Now if I write `@simple.args` in a hledger command line, it will be replaced -by all of the above options/flags: +by all of the above options/flags. -These options are just an example, but in case you're wondering: -they remove some detail, giving simplified reports which are easier for me to read at a glance. +The options above are just an example, but in case you're wondering: -- the aliases simplify the chart of accounts, hiding some distinctions (eg business vs. personal) and flattening some bank account names -- the `-2` depth flag limits account depth to 2, hiding deeper subaccounts -- the `cur:.` argument shows only single-character currencies, hiding a bunch of cluttersome commodities I don't want to see +- the [aliases](manual.html#account-aliases) simplify the chart of accounts, hiding some distinctions (eg business vs. personal) and flattening some bank account names +- the `-2` [depth flag](manual.html#depth-limiting) limits account depth to 2, hiding deeper subaccounts +- the `cur:.` [query argument](manual.html#queries) shows only single-character currencies, hiding a bunch of cluttersome commodities I don't want to see + +Ie they remove some detail, giving simplified reports which are easier for me to read at a glance. ## Usage @@ -42,17 +43,18 @@ $ hledger-ui --watch @simple.args assets ``` Options in the arguments file can be overridden by similar options later on -the command line, in the usual way. Eg, to show just a little more account detail: +the command line, in the [usual way](manual.html#options). +Eg, to show just a little more account detail: ```shell $ hledger bal @simple.args -3 ``` ## Quoting -Special characters in the arguments file may need quoted, -following the usual rules of your shell (bash, fish etc.), -but they'll need one less level of quoting than on the -command line. I think: +[Special characters](manual.html#special-characters) in the arguments file +may need to be quoted, depending on your shell (bash, fish etc.) +They'll need one less level of quoting than on the command line. +I think ```shell $ hledger bal @simple.args ``` @@ -60,7 +62,7 @@ is equivalent to writing: ```shell $ hledger bal "--alias=/:(business|personal):/=:" "--alias=/:(bank|cash|online):/=:" "--alias=/:bofi:/=:b" "--alias=/:unify:/=:u" "--alias=/:wf:/=:w" "-2" "cur:." ``` -So in this example, using the bash shell, the `|` pipe character does +So in this example, using the bash shell, the `|` pipe character did not need to be quoted in the arguments file (and should not be). ## Suppressing this feature @@ -68,11 +70,11 @@ not need to be quoted in the arguments file (and should not be). If you actually need to write an argument beginning with @, eg let's say you have an account pattern beginning with that character, you'll want a way to disable this feature. On unix systems at least, -you can do that by inserting a `--` argument first. Eg: +you can do that by inserting a `--` (double hyphen) argument first. Eg: ``` $ hledger bal @somewhere.com # looks for additional arguments in the ./somewhere.com file $ hledger bal -- @somewhere.com # matches account names containing "@somewhere.com" ``` -On windows, this might or might not require a hledger built with GHC 8.2+. +On windows, this double hyphen trick [might](https://ghc.haskell.org/trac/ghc/ticket/13287) require a hledger built with GHC 8.2+. (Let us know.)