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

doc: options cleanups

Browse Source
This commit is contained in:
Simon Michael 2017-03-29 16:24:28 -07:00
parent a3c3d58f75
commit 1f36c1cb8c
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
hledger/doc/options.m4.md
View File

@ -272,10 +272,10 @@ or one of the built-in implicit tags (like `code` or `payee`).
As with account names, when tag values have `multiple:colon-separated:parts` hledger will build hierarchy, As with account names, when tag values have `multiple:colon-separated:parts` hledger will build hierarchy,
displayed in tree-mode reports, summarisable with a depth limit, and so on. displayed in tree-mode reports, summarisable with a depth limit, and so on.
`--pivot` affects all reports, and is one of those options you can write before the command name if you wish. `--pivot` is a general option affecting all reports; you can think of hledger transforming
You can think of hledger transforming the journal before any other processing, the journal before any other processing, replacing every posting's account name with
replacing every posting's account name with the value of the specified tag on that posting, the value of the specified tag on that posting, inheriting it from the transaction
inheriting it from the transaction or using a blank value if it's not present. or using a blank value if it's not present.
An example: An example:
@ -340,13 +340,12 @@ Some things to note:
must be enclosed in forward slashes (`/REGEX/`). Elsewhere in hledger, must be enclosed in forward slashes (`/REGEX/`). Elsewhere in hledger,
these are not required. these are not required.
- To match a regular expression metacharacter like `$` as a literal - In queries, to match a regular expression metacharacter like `$`
character, prepend a backslash. Eg to search for amounts with the as a literal character, prepend a backslash. Eg to search for amounts with the
dollar sign in hledger-web, write `cur:\$`. dollar sign in hledger-web, write `cur:\$`.
- On the command line, some metacharacters like `$` have a special - On the command line, some metacharacters like `$` have a special
meaning to the shell and so must be escaped a second time, with single meaning to the shell and so must be escaped at least once more.
or double quotes or another backslash. Eg, to match amounts with the See [Special characters](#special-characters).
dollar sign from the command line, write `cur:'\$'` or `cur:\\$`.