api: add options to manual

hledger-api/doc/hledger-api.1

@@ -30,11 +30,47 @@ Data is served from the usual hledger journal file:
 specified with \-f.
 For more about the format, see hledger(1) or hledger_journal(5).
 .PP
-The server listens for requests on port ...
+The server listens on port 8001, or another specified with
+\f[C]\-p\ PORT\f[].
 .PP
 Note there is no built\-in access control, so you will need to hide
 hledger\-api behind an authenticating proxy if you want to restrict
 access.
+.SH OPTIONS
+.PP
+Note: if invoking hledger\-api as a hledger subcommand, write
+\f[C]\-\-\f[] before options as shown above.
+.TP
+.B \f[C]\-f\ \-\-file\ FILE\f[]
+use a different input file (default: \f[C]$LEDGER_FILE\f[] or
+\f[C]~/.hledger.journal\f[])
+.RS
+.RE
+.TP
+.B \f[C]\-d\ \-\-static\-dir=DIR\f[]
+serve files from a different directory (default: \f[C]\&.\f[])
+.RS
+.RE
+.TP
+.B \f[C]\-p\ \-\-port=PORT\f[]
+use a different TCP port (default: 8001)
+.RS
+.RE
+.TP
+.B \f[C]\-h\f[]
+show usage
+.RS
+.RE
+.TP
+.B \f[C]\-\-help\f[]
+show detailed help
+.RS
+.RE
+.TP
+.B \f[C]\-\-version\f[]
+show version information
+.RS
+.RE
 .SH ENVIRONMENT
 .PP
 \f[B]LEDGER_FILE\f[] sets the default journal file path.

hledger-api/doc/hledger-api.1.m4.md

@@ -33,81 +33,33 @@ Data is served from the usual hledger journal file:
 `~/.hledger.journal`, `$LEDGER_FILE`, or another file specified with -f.
 For more about the format, see hledger(1) or hledger_journal(5).
 
-The server listens for requests on port ...
+The server listens on port 8001, or another specified with `-p PORT`.
 
 Note there is no built-in access control, so you will need to hide
 hledger-api behind an authenticating proxy if you want to restrict
 access.
 
-<!-- With journal and timeclock files (but not CSV files, currently) -->
+# OPTIONS
-<!-- the web app detects changes and will show the new data on the next request. -->
-<!-- If a change makes the file unparseable, hledger-api will show an error -->
-<!-- until the file has been fixed. -->
 
-<!-- # OPTIONS -->
+Note: if invoking hledger-api as a hledger subcommand, write `--` before options as shown above.
 
-<!-- Note: if invoking hledger-web as a hledger subcommand, write `--` before options as shown above. -->
+`-f --file FILE`
+: use a different input file (default: `$LEDGER_FILE` or `~/.hledger.journal`)
 
-<!-- `--port=PORT` -->
+`-d --static-dir=DIR`
-<!-- : set the TCP port to listen on (default: 5000) -->
+: serve files from a different directory (default: `.`)
 
-<!-- `-h --help` -->
+`-p --port=PORT`
-<!-- : show help -->
+: use a different TCP port (default: 8001)
 
-<!-- `--version` -->
+`-h`
-<!-- : show version information -->
+: show usage
 
-<!-- ## hledger options: -->
+`--help`
+: show detailed help
 
-<!-- The following common hledger options should also work: -->
+`--version`
-
+: show version information
-<!-- `-f FILE --file=FILE` -->
-<!-- : use a different input file. For stdin, use - -->
-
-<!-- `--rules-file=RULESFILE` -->
-<!-- : Conversion rules file to use when reading CSV (default: FILE.rules) -->
-
-<!-- `--alias=OLD=NEW` -->
-<!-- : display accounts named OLD as NEW -->
-
-<!-- `--ignore-assertions` -->
-<!-- : ignore any failing balance assertions in the journal -->
-
-<!-- `--debug=N` -->
-<!-- : show debug output if N is 1-9 (default: 0) -->
-
-<!-- `-b --begin=DATE` -->
-<!-- : include postings/txns on or after this date -->
-
-<!-- `-e --end=DATE` -->
-<!-- : include postings/txns before this date -->
-
-<!-- `-p --period=PERIODEXP` -->
-<!-- : set start date, end date, and/or reporting interval all at once (overrides the flags above) -->
-
-<!-- `--date2 --aux-date` -->
-<!-- : use postings/txns' secondary dates instead -->
-
-<!-- `-C --cleared` -->
-<!-- : include only cleared postings/txns -->
-
-<!-- `--pending` -->
-<!-- : include only pending postings/txns -->
-
-<!-- `-U --uncleared` -->
-<!-- : include only uncleared (and pending) postings/txns -->
-
-<!-- `-R --real` -->
-<!-- : include only non-virtual postings -->
-
-<!-- `--depth=N` -->
-<!-- : hide accounts/postings deeper than N -->
-
-<!-- `-E --empty` -->
-<!-- : show empty/zero things which are normally omitted -->
-
-<!-- `-B --cost` -->
-<!-- : show amounts in their cost price's commodity -->
 
 _man_({{
 

hledger-api/doc/hledger-api.1.txt

@@ -24,12 +24,33 @@ DDEESSCCRRIIPPTTIIOONN
        $LEDGER_FILE,  or  another  file specified with -f.  For more about the
        format, see hledger(1) or hledger_journal(5).
 
-       The server listens for requests on port ...
+       The server listens on port 8001, or another specified with -p PORT.
 
        Note there is no built-in access control, so  you  will  need  to  hide
        hledger-api  behind  an  authenticating  proxy  if you want to restrict
        access.
 
+OOPPTTIIOONNSS
+       Note: if invoking hledger-api as a hledger subcommand, write --  before
+       options as shown above.
+
+       --ff ----ffiillee FFIILLEE
+              use   a   different   input   file   (default:  $LEDGER_FILE  or
+              ~/.hledger.journal)
+
+       --dd ----ssttaattiicc--ddiirr==DDIIRR
+              serve files from a different directory (default: .)
+
+       --pp ----ppoorrtt==PPOORRTT
+              use a different TCP port (default: 8001)
+
+       --hh     show usage
+
+       ----hheellpp show detailed help
+
+       ----vveerrssiioonn
+              show version information
+
 EENNVVIIRROONNMMEENNTT
        LLEEDDGGEERR__FFIILLEE sets the default journal file path.   If  not  set,  it  is
        ~/.hledger.journal.