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

;imp:doc: ui, web: options cleanup

Browse Source
This commit is contained in:
Simon Michael 2023-05-30 22:35:01 -10:00
parent 5c1721da22
commit b0e5bb4bc7
2 changed files with 28 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -50,10 +50,10 @@ by pressing the F key (or starting with --forecast) to enable "forecast mode".
# OPTIONS
Note: if invoking hledger-ui as a hledger subcommand, write `--` before options as shown above.
Any QUERYARGS are interpreted as a hledger search query which filters the data.
hledger-ui provides the following options:
`-w --watch`
: watch for data and date changes and reload automatically
@ -87,21 +87,20 @@ Any QUERYARGS are interpreted as a hledger search query which filters the data.
`-t --tree`
: show accounts as a tree
hledger input options:
hledger-ui also supports many of hledger's general options
(and the hledger manual's command line tips also apply here):
_inputoptions_
hledger reporting options:
_reportingoptions_
hledger help options:
## General help options
_helpoptions_
A @FILE argument will be expanded to the contents of FILE,
which should contain one command line option/argument per line.
(To prevent this, insert a `--` argument before.)
## General input options
_inputoptions_
## General reporting options
_reportingoptions_
# MOUSE

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

@ -68,8 +68,7 @@ Command-line options and arguments may be used to set an initial
filter on the data. These filter options are not shown in the web UI,
but it will be applied in addition to any search query entered there.
Note: if invoking hledger-web as a hledger subcommand, write `--` before options,
as shown in the synopsis above.
hledger-web provides the following options:
`--serve`
: serve and log requests, don't browse or auto-exit after timeout
@ -106,22 +105,6 @@ serve them from another server for efficiency, you would set the url with this.
`--test`
: run hledger-web's tests and exit. hspec test runner args may follow a --, eg: hledger-web --test -- --help
hledger input options:
_inputoptions_
hledger reporting options:
_reportingoptions_
hledger help options:
_helpoptions_
A @FILE argument will be expanded to the contents of FILE,
which should contain one command line option/argument per line.
(To prevent this, insert a `--` argument before.)
By default the server listens on IP address 127.0.0.1, accessible only to local requests.
You can use `--host` to change this, eg `--host 0.0.0.0` to listen on all configured addresses.
@ -150,6 +133,21 @@ The default is `http://HOST:PORT/` using the server's configured host address an
With `--file-url` you can set a different base url for static files,
eg for better caching or cookie-less serving on high performance websites.
hledger-web also supports many of hledger's general options
(and the hledger manual's command line tips also apply here):
## General help options
_helpoptions_
## General input options
_inputoptions_
## General reporting options
_reportingoptions_
# PERMISSIONS
By default, hledger-web allows anyone who can reach it to view the journal