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

ui, web: update manuals

Browse Source
This commit is contained in:
Simon Michael 2017-01-05 17:18:13 -08:00
parent 7f58d186bb
commit 20651ec426
6 changed files with 58 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
hledger-ui/doc/hledger-ui.1
View File

@ -40,7 +40,7 @@ Any QUERYARGS are interpreted as a hledger search query which filters
the data. the data.
.TP .TP
.B \f[C]\-\-watch\f[] .B \f[C]\-\-watch\f[]
watch for data (and time) changes and reload automatically watch for data and date changes and reload automatically
.RS .RS
.RE .RE
.TP .TP

26
hledger-ui/doc/hledger-ui.1.info
View File

@ -38,7 +38,7 @@ options as shown above.
the data. the data.
`--watch' `--watch'
watch for data (and time) changes and reload automatically watch for data and date changes and reload automatically
`--theme=default|terminal|greenterm' `--theme=default|terminal|greenterm'
use this custom display theme use this custom display theme
@ -361,17 +361,17 @@ Tag Table:
Node: Top88 Node: Top88
Node: OPTIONS823 Node: OPTIONS823
Ref: #options922 Ref: #options922
Node: KEYS4003 Node: KEYS4001
Ref: #keys4100 Ref: #keys4098
Node: SCREENS6670 Node: SCREENS6668
Ref: #screens6757 Ref: #screens6755
Node: Accounts screen6847 Node: Accounts screen6845
Ref: #accounts-screen6977 Ref: #accounts-screen6975
Node: Register screen9015 Node: Register screen9013
Ref: #register-screen9172 Ref: #register-screen9170
Node: Transaction screen11060 Node: Transaction screen11058
Ref: #transaction-screen11220 Ref: #transaction-screen11218
Node: Error screen12087 Node: Error screen12085
Ref: #error-screen12211 Ref: #error-screen12209
 
End Tag Table End Tag Table

2
hledger-ui/doc/hledger-ui.1.txt
View File

@ -36,7 +36,7 @@ OPTIONS
the data. the data.
--watch --watch
watch for data (and time) changes and reload automatically watch for data and date changes and reload automatically
--theme=default|terminal|greenterm --theme=default|terminal|greenterm
use this custom display theme use this custom display theme

14
hledger-web/doc/hledger-web.1
View File

@ -102,19 +102,23 @@ until the file has been fixed.
Note: if invoking hledger\-web as a hledger subcommand, write Note: if invoking hledger\-web as a hledger subcommand, write
\f[C]\-\-\f[] before options as shown above. \f[C]\-\-\f[] before options as shown above.
.TP .TP
.B \f[C]\-\-server\f[] .B \f[C]\-\-serve\f[]
disable browser\-opening and auto\-exit\-on\-idle, and log all requests serve and log requests, don\[aq]t browse or auto\-exit
to stdout .RS
.RE
.TP
.B \f[C]\-\-host=IPADDR\f[]
listen on this IP address (default: 127.0.0.1)
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-port=PORT\f[] .B \f[C]\-\-port=PORT\f[]
set the TCP port to listen on (default: 5000) listen on this TCP port (default: 5000)
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-\-base\-url=URL\f[] .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 You would change this when sharing over the network, or integrating
within a larger website. within a larger website.
.RS .RS

16
hledger-web/doc/hledger-web.1.info
View File

@ -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 `--' Note: if invoking hledger-web as a hledger subcommand, write `--'
before options as shown above. before options as shown above.
`--server' `--serve'
disable browser-opening and auto-exit-on-idle, and log all serve and log requests, don't browse or auto-exit
requests to stdout
`--host=IPADDR'
listen on this IP address (default: 127.0.0.1)
`--port=PORT' `--port=PORT'
set the TCP port to listen on (default: 5000) listen on this TCP port (default: 5000)
`--base-url=URL' `--base-url=URL'
set the base url (default: http://localhost:PORT). You would set the base url (default: http://IPADDR:PORT). You would change
change this when sharing over the network, or integrating within a this when sharing over the network, or integrating within a larger
larger website. website.
`--file-url=URL' `--file-url=URL'
set the static files url (default: BASEURL/static). hledger-web set the static files url (default: BASEURL/static). hledger-web

48
hledger-web/doc/hledger-web.1.txt
View File

@ -84,29 +84,31 @@ OPTIONS
Note: if invoking hledger-web as a hledger subcommand, write -- before Note: if invoking hledger-web as a hledger subcommand, write -- before
options as shown above. options as shown above.
--server --serve
disable browser-opening and auto-exit-on-idle, and log all serve and log requests, don't browse or auto-exit
requests to stdout
--host=IPADDR
listen on this IP address (default: 127.0.0.1)
--port=PORT --port=PORT
set the TCP port to listen on (default: 5000) listen on this TCP port (default: 5000)
--base-url=URL --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 change this when sharing over the network, or integrating within
a larger website. a larger website.
--file-url=URL --file-url=URL
set the static files url (default: BASEURL/static). hledger-web set the static files url (default: BASEURL/static). hledger-web
normally serves static files itself, but if you wanted to serve normally serves static files itself, but if you wanted to serve
them from another server for efficiency, you would set the url them from another server for efficiency, you would set the url
with this. with this.
hledger general options: hledger general options:
-h show general usage (or after COMMAND, the command's usage) -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) add-on COMMAND, the add-on's manual)
--man show the current program's manual with man --man show the current program's manual with man
@ -123,7 +125,7 @@ OPTIONS
use a different input file. For stdin, use - use a different input file. For stdin, use -
--rules-file=RULESFILE --rules-file=RULESFILE
Conversion rules file to use when reading CSV (default: Conversion rules file to use when reading CSV (default:
FILE.rules) FILE.rules)
--alias=OLD=NEW --alias=OLD=NEW
@ -156,7 +158,7 @@ OPTIONS
multiperiod/multicolumn report by year multiperiod/multicolumn report by year
-p --period=PERIODEXP -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) (overrides the flags above)
--date2 --date2
@ -181,15 +183,15 @@ OPTIONS
show items with zero amount, normally hidden show items with zero amount, normally hidden
-B --cost -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) transaction price, if any)
--pivot TAG --pivot TAG
will transform the journal before any other processing by will transform the journal before any other processing by
replacing the account name of every posting having the tag TAG replacing the account name of every posting having the tag TAG
with content VALUE by the account name "TAG:VALUE". The 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 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 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 transaction. If the tag value is a multi:level:account:name the
new account name will be "TAG:multi:level:account:name". new account name will be "TAG:multi:level:account:name".
@ -197,17 +199,17 @@ OPTIONS
ENVIRONMENT ENVIRONMENT
LEDGER_FILE The journal file path when not specified with -f. Default: 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). nal).
FILES FILES
Reads data from one or more files in hledger journal, timeclock, time- Reads data from one or more files in hledger journal, timeclock, time-
dot, or CSV format specified with -f, or $LEDGER_FILE, or dot, or CSV format specified with -f, or $LEDGER_FILE, or
$HOME/.hledger.journal (on windows, perhaps $HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal). C:/Users/USER/.hledger.journal).
BUGS 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. ward.
-f- doesn't work (hledger-web can't read from stdin). -f- doesn't work (hledger-web can't read from stdin).
@ -221,7 +223,7 @@ BUGS
REPORTING 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) or hledger mail list)
@ -235,7 +237,7 @@ COPYRIGHT
SEE ALSO 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- hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time-
dot(5), ledger(1) dot(5), ledger(1)