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

;doc: drop -- argument from more docs [#458]

Browse Source
This commit is contained in:
Simon Michael 2025-06-15 13:24:41 -10:00
parent 3d7a1717e1
commit 3ba3d3d676
5 changed files with 24 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
bin/README.md
View File

@ -243,13 +243,13 @@ $ hledger bar reimbursement
``` ```
```cli ```cli
$ hledger bar # show help $ hledger bar # show help
$ hledger bar food # monthly food expenses $ hledger bar food # monthly food expenses
$ hledger bar -- 1 --count food # monthly food posting counts $ hledger bar 1 --count food # monthly food posting counts
$ hledger bar -- type:c not:tag:clopen cur:\\\\$ -W # weekly cashflow, $ only $ hledger bar type:c not:tag:clopen cur:\\\\$ -W # weekly cashflow, $ only
$ hledger bar -- type:al not:tag:clopen cur:\\\\$ # monthly net worth change ($) $ hledger bar type:al not:tag:clopen cur:\\\\$ # monthly net worth change ($)
$ hledger bar -- type:rx --invert cur:\\\\$ # monthly profit/loss ($) $ hledger bar type:rx --invert cur:\\\\$ # monthly profit/loss ($)
$ hledger bar -- -v 1 -f $TIMELOG -D # daily hours, with numbers $ hledger bar -v 1 -f $TIMELOG -D # daily hours, with numbers
``` ```
### hledger-git ### hledger-git
@ -324,7 +324,7 @@ $ pip install -U hledger-utils # might be slightly different on your system
Examples: Examples:
``` ```
$ hledger-plot -h $ hledger-plot -h
$ hledger plot -- bal -DH ^Assets -2 $ hledger plot bal -DH ^Assets -2
``` ```
### hledger-lots ### hledger-lots
@ -386,7 +386,7 @@ runs a register report and prints the posting with largest historical balance.
```cli ```cli
$ hledger-register-max -f examples/bcexample.hledger checking $ hledger-register-max -f examples/bcexample.hledger checking
2013-01-03 Hoogle | Payroll Assets:US:BofA:Checking 1350.60 USD 8799.22 USD 2013-01-03 Hoogle | Payroll Assets:US:BofA:Checking 1350.60 USD 8799.22 USD
$ hledger register-max -- -f examples/bcexample.hledger checking $ hledger register-max -f examples/bcexample.hledger checking
2013-01-03 Hoogle | Payroll Assets:US:BofA:Checking 1350.60 USD 8799.22 USD 2013-01-03 Hoogle | Payroll Assets:US:BofA:Checking 1350.60 USD 8799.22 USD
``` ```
@ -542,7 +542,7 @@ On unix, the new script should be marked executable. This should do it:
My new cmd command. My new cmd command.
... ...
$ stack ghc hledger-cmd.hs # optionally compile for faster startup/durability $ stack ghc hledger-cmd.hs # optionally compile for faster startup/durability
$ hledger cmd -- --help $ hledger cmd --help
cmd [OPTIONS] cmd [OPTIONS]
My new cmd command. My new cmd command.
... ...

4
hledger-ui/hledger-ui.m4.md
View File

@ -12,9 +12,9 @@ _notinfo_({{
# SYNOPSIS # SYNOPSIS
}}) }})
`hledger-ui [OPTS] [QUERYARGS]`\ `hledger-ui [OPTS] [QUERYARGS]`\
or\ or\
`hledger ui -- [OPTS] [QUERYARGS]` `hledger ui [OPTS] [QUERYARGS]`
_notinfo_({{ _notinfo_({{
# DESCRIPTION # DESCRIPTION

6
hledger-web/hledger-web.m4.md
View File

@ -12,9 +12,9 @@ _notinfo_({{
# SYNOPSIS # SYNOPSIS
}}) }})
`hledger-web [OPTS] [QUERY]`\ `hledger-web [OPTS] [QUERY]`\
or\ or\
`hledger web -- [OPTS] [QUERY]` `hledger web [OPTS] [QUERY]`
_notinfo_({{ _notinfo_({{
# DESCRIPTION # DESCRIPTION
@ -85,7 +85,7 @@ Flags:
--base-url=BASEURL set the base url (default: http://IPADDR:PORT) --base-url=BASEURL set the base url (default: http://IPADDR:PORT)
--test run hledger-web's tests and exit. hspec test --test run hledger-web's tests and exit. hspec test
runner args may follow a --, eg: hledger-web --test runner args may follow a --, eg: hledger-web --test
-- --help --help
``` ```
By default hledger-web listens only on IP address `127.0.0.1`, By default hledger-web listens only on IP address `127.0.0.1`,

16
hledger/Hledger/Cli/Commands/Rewrite.md
View File

@ -39,10 +39,10 @@ and the two spaces between account and amount.
More: More:
```cli ```cli
$ hledger rewrite -- [QUERY] --add-posting "ACCT AMTEXPR" ... $ hledger rewrite [QUERY] --add-posting "ACCT AMTEXPR" ...
$ hledger rewrite -- ^income --add-posting '(liabilities:tax) *.33' $ hledger rewrite ^income --add-posting '(liabilities:tax) *.33'
$ hledger rewrite -- expenses:gifts --add-posting '(budget:gifts) *-1"' $ hledger rewrite expenses:gifts --add-posting '(budget:gifts) *-1"'
$ hledger rewrite -- ^income --add-posting '(budget:foreign currency) *0.25 JPY; diversify' $ hledger rewrite ^income --add-posting '(budget:foreign currency) *0.25 JPY; diversify'
``` ```
Argument for `--add-posting` option is a usual posting of transaction with an Argument for `--add-posting` option is a usual posting of transaction with an
@ -79,14 +79,14 @@ you usually write. It indicates the query by which you want to match the
posting to add new ones. posting to add new ones.
```cli ```cli
$ hledger rewrite -- -f input.journal -f rewrite-rules.journal > rewritten-tidy-output.journal $ hledger rewrite -f input.journal -f rewrite-rules.journal > rewritten-tidy-output.journal
``` ```
This is something similar to the commands pipeline: This is something similar to the commands pipeline:
```cli ```cli
$ hledger rewrite -- -f input.journal '^income' --add-posting '(liabilities:tax) *.33' \ $ hledger rewrite -f input.journal '^income' --add-posting '(liabilities:tax) *.33' \
| hledger rewrite -- -f - expenses:gifts --add-posting 'budget:gifts *-1' \ | hledger rewrite -f - expenses:gifts --add-posting 'budget:gifts *-1' \
--add-posting 'assets:budget *1' \ --add-posting 'assets:budget *1' \
> rewritten-tidy-output.journal > rewritten-tidy-output.journal
``` ```
@ -100,7 +100,7 @@ To use this tool for batch modification of your journal files you may find
useful output in form of unified diff. useful output in form of unified diff.
```cli ```cli
$ hledger rewrite -- --diff -f examples/sample.journal '^income' --add-posting '(liabilities:tax) *.33' $ hledger rewrite --diff -f examples/sample.journal '^income' --add-posting '(liabilities:tax) *.33'
``` ```
Output might look like: Output might look like:

5
hledger/hledger.m4.md
View File

@ -17,8 +17,6 @@ _notinfo_({{
`hledger`\ `hledger`\
or\ or\
`hledger COMMAND [OPTS] [ARGS]`\ `hledger COMMAND [OPTS] [ARGS]`\
or\
`hledger ADDONCMD [OPTS] -- [ADDONOPTS] [ADDONARGS]`
_notinfo_({{ _notinfo_({{
# DESCRIPTION # DESCRIPTION
@ -189,8 +187,7 @@ With the `-s`/`--strict` flag, additional checks are performed:
([Commodity error checking](#commodity-error-checking)) ([Commodity error checking](#commodity-error-checking))
- Are all commodity conversions declared explicitly ? - Are all commodity conversions declared explicitly ?
You can use the [check](#check) command to run individual checks -- the You can use the [check](#check) command to run individual checks - the ones listed above and some more.
ones listed above and some more.
# Commands # Commands