From 20651ec4263f6dabdd4f405571a2f430eada71d6 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Thu, 5 Jan 2017 17:18:13 -0800 Subject: [PATCH] ui, web: update manuals --- hledger-ui/doc/hledger-ui.1 | 2 +- hledger-ui/doc/hledger-ui.1.info | 26 ++++++++-------- hledger-ui/doc/hledger-ui.1.txt | 2 +- hledger-web/doc/hledger-web.1 | 14 +++++---- hledger-web/doc/hledger-web.1.info | 16 +++++----- hledger-web/doc/hledger-web.1.txt | 48 ++++++++++++++++-------------- 6 files changed, 58 insertions(+), 50 deletions(-) diff --git a/hledger-ui/doc/hledger-ui.1 b/hledger-ui/doc/hledger-ui.1 index dae78d375..abc053b61 100644 --- a/hledger-ui/doc/hledger-ui.1 +++ b/hledger-ui/doc/hledger-ui.1 @@ -40,7 +40,7 @@ Any QUERYARGS are interpreted as a hledger search query which filters the data. .TP .B \f[C]\-\-watch\f[] -watch for data (and time) changes and reload automatically +watch for data and date changes and reload automatically .RS .RE .TP diff --git a/hledger-ui/doc/hledger-ui.1.info b/hledger-ui/doc/hledger-ui.1.info index 4ebc107f1..6c2c4d79f 100644 --- a/hledger-ui/doc/hledger-ui.1.info +++ b/hledger-ui/doc/hledger-ui.1.info @@ -38,7 +38,7 @@ options as shown above. the data. `--watch' - watch for data (and time) changes and reload automatically + watch for data and date changes and reload automatically `--theme=default|terminal|greenterm' use this custom display theme @@ -361,17 +361,17 @@ Tag Table: Node: Top88 Node: OPTIONS823 Ref: #options922 -Node: KEYS4003 -Ref: #keys4100 -Node: SCREENS6670 -Ref: #screens6757 -Node: Accounts screen6847 -Ref: #accounts-screen6977 -Node: Register screen9015 -Ref: #register-screen9172 -Node: Transaction screen11060 -Ref: #transaction-screen11220 -Node: Error screen12087 -Ref: #error-screen12211 +Node: KEYS4001 +Ref: #keys4098 +Node: SCREENS6668 +Ref: #screens6755 +Node: Accounts screen6845 +Ref: #accounts-screen6975 +Node: Register screen9013 +Ref: #register-screen9170 +Node: Transaction screen11058 +Ref: #transaction-screen11218 +Node: Error screen12085 +Ref: #error-screen12209  End Tag Table diff --git a/hledger-ui/doc/hledger-ui.1.txt b/hledger-ui/doc/hledger-ui.1.txt index 7745bf0bb..dd580f5c0 100644 --- a/hledger-ui/doc/hledger-ui.1.txt +++ b/hledger-ui/doc/hledger-ui.1.txt @@ -36,7 +36,7 @@ OPTIONS the data. --watch - watch for data (and time) changes and reload automatically + watch for data and date changes and reload automatically --theme=default|terminal|greenterm use this custom display theme diff --git a/hledger-web/doc/hledger-web.1 b/hledger-web/doc/hledger-web.1 index 675e7463b..f68161cc0 100644 --- a/hledger-web/doc/hledger-web.1 +++ b/hledger-web/doc/hledger-web.1 @@ -102,19 +102,23 @@ until the file has been fixed. Note: if invoking hledger\-web as a hledger subcommand, write \f[C]\-\-\f[] before options as shown above. .TP -.B \f[C]\-\-server\f[] -disable browser\-opening and auto\-exit\-on\-idle, and log all requests -to stdout +.B \f[C]\-\-serve\f[] +serve and log requests, don\[aq]t browse or auto\-exit +.RS +.RE +.TP +.B \f[C]\-\-host=IPADDR\f[] +listen on this IP address (default: 127.0.0.1) .RS .RE .TP .B \f[C]\-\-port=PORT\f[] -set the TCP port to listen on (default: 5000) +listen on this TCP port (default: 5000) .RS .RE .TP .B \f[C]\-\-base\-url=URL\f[] -set the base url (default: http://localhost:PORT). +set the base url (default: http://IPADDR:PORT). You would change this when sharing over the network, or integrating within a larger website. .RS diff --git a/hledger-web/doc/hledger-web.1.info b/hledger-web/doc/hledger-web.1.info index 376a01f81..7a5ab460a 100644 --- a/hledger-web/doc/hledger-web.1.info +++ b/hledger-web/doc/hledger-web.1.info @@ -85,17 +85,19 @@ File: hledger-web.1.info, Node: OPTIONS, Prev: Top, Up: Top Note: if invoking hledger-web as a hledger subcommand, write `--' before options as shown above. -`--server' - disable browser-opening and auto-exit-on-idle, and log all - requests to stdout +`--serve' + serve and log requests, don't browse or auto-exit + +`--host=IPADDR' + listen on this IP address (default: 127.0.0.1) `--port=PORT' - set the TCP port to listen on (default: 5000) + listen on this TCP port (default: 5000) `--base-url=URL' - set the base url (default: http://localhost:PORT). You would - change this when sharing over the network, or integrating within a - larger website. + set the base url (default: http://IPADDR:PORT). You would change + this when sharing over the network, or integrating within a larger + website. `--file-url=URL' set the static files url (default: BASEURL/static). hledger-web diff --git a/hledger-web/doc/hledger-web.1.txt b/hledger-web/doc/hledger-web.1.txt index ca6c0b471..385b85f6c 100644 --- a/hledger-web/doc/hledger-web.1.txt +++ b/hledger-web/doc/hledger-web.1.txt @@ -84,29 +84,31 @@ OPTIONS Note: if invoking hledger-web as a hledger subcommand, write -- before options as shown above. - --server - disable browser-opening and auto-exit-on-idle, and log all - requests to stdout + --serve + serve and log requests, don't browse or auto-exit + + --host=IPADDR + listen on this IP address (default: 127.0.0.1) --port=PORT - set the TCP port to listen on (default: 5000) + listen on this TCP port (default: 5000) --base-url=URL - set the base url (default: http://localhost:PORT). You would + set the base url (default: http://IPADDR:PORT). You would change this when sharing over the network, or integrating within a larger website. --file-url=URL set the static files url (default: BASEURL/static). hledger-web - normally serves static files itself, but if you wanted to serve - them from another server for efficiency, you would set the url + normally serves static files itself, but if you wanted to serve + them from another server for efficiency, you would set the url with this. hledger general options: -h show general usage (or after COMMAND, the command's usage) - --help show the current program's manual as plain text (or after an + --help show the current program's manual as plain text (or after an add-on COMMAND, the add-on's manual) --man show the current program's manual with man @@ -123,7 +125,7 @@ OPTIONS use a different input file. For stdin, use - --rules-file=RULESFILE - Conversion rules file to use when reading CSV (default: + Conversion rules file to use when reading CSV (default: FILE.rules) --alias=OLD=NEW @@ -156,7 +158,7 @@ OPTIONS multiperiod/multicolumn report by year -p --period=PERIODEXP - set start date, end date, and/or reporting interval all at once + set start date, end date, and/or reporting interval all at once (overrides the flags above) --date2 @@ -181,15 +183,15 @@ OPTIONS show items with zero amount, normally hidden -B --cost - convert amounts to their cost at transaction time (using the + convert amounts to their cost at transaction time (using the transaction price, if any) --pivot TAG - will transform the journal before any other processing by - replacing the account name of every posting having the tag TAG - with content VALUE by the account name "TAG:VALUE". The TAG - will only match if it is a full-length match. The pivot will - only happen if the TAG is on a posting, not if it is on the + will transform the journal before any other processing by + replacing the account name of every posting having the tag TAG + with content VALUE by the account name "TAG:VALUE". The TAG + will only match if it is a full-length match. The pivot will + only happen if the TAG is on a posting, not if it is on the transaction. If the tag value is a multi:level:account:name the new account name will be "TAG:multi:level:account:name". @@ -197,17 +199,17 @@ OPTIONS ENVIRONMENT LEDGER_FILE The journal file path when not specified with -f. Default: - ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour- + ~/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.jour- nal). FILES - Reads data from one or more files in hledger journal, timeclock, time- - dot, or CSV format specified with -f, or $LEDGER_FILE, or - $HOME/.hledger.journal (on windows, perhaps + Reads data from one or more files in hledger journal, timeclock, time- + dot, or CSV format specified with -f, or $LEDGER_FILE, or + $HOME/.hledger.journal (on windows, perhaps C:/Users/USER/.hledger.journal). BUGS - The need to precede options with -- when invoked from hledger is awk- + The need to precede options with -- when invoked from hledger is awk- ward. -f- doesn't work (hledger-web can't read from stdin). @@ -221,7 +223,7 @@ BUGS REPORTING BUGS - Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel + Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel or hledger mail list) @@ -235,7 +237,7 @@ COPYRIGHT SEE ALSO - hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1), + hledger(1), hledger-ui(1), hledger-web(1), hledger-api(1), hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time- dot(5), ledger(1)