f21e9d1c25
Help for reporting options is now also defined once in lib.m4 (in addition to CliOptions.hs). Also fixed some duplication of general options in docs. hledger-* manuals now include the full list of general and reporting options; we assume that any inapplicable options get harmlessly ignored and that this will not surprise users.
318 lines
8.0 KiB
Groff
318 lines
8.0 KiB
Groff
|
|
.TH "hledger\-web" "1" "May 2016" "hledger\-web 0.28" "hledger User Manuals"
|
|
|
|
|
|
|
|
.SH NAME
|
|
.PP
|
|
hledger\-web \- web interface for the hledger accounting tool
|
|
.SH SYNOPSIS
|
|
.PP
|
|
\f[C]hledger\-web\ [OPTIONS]\f[]
|
|
.PD 0
|
|
.P
|
|
.PD
|
|
\f[C]hledger\ web\ \-\-\ [OPTIONS]\f[]
|
|
.PP
|
|
.PP
|
|
.SH DESCRIPTION
|
|
.PP
|
|
hledger is a cross\-platform program for tracking money, time, or any
|
|
other commodity, using double\-entry accounting and a simple, editable
|
|
file format.
|
|
hledger is inspired by and largely compatible with ledger(1).
|
|
.PP
|
|
hledger\-web is hledger\[aq]s web interface.
|
|
It starts a simple web application for browsing and adding transactions,
|
|
and optionally opens it in a web browser window if possible.
|
|
It provides a more user\-friendly UI than the hledger CLI or hledger\-ui
|
|
interface, showing more at once (accounts, the current account register,
|
|
balance charts) and allowing history\-aware data entry, interactive
|
|
searching, and bookmarking.
|
|
.PP
|
|
hledger\-web also lets you share a ledger with multiple users, or even
|
|
the public web.
|
|
There is no access control, so if you need that you should put it behind
|
|
a suitable web proxy.
|
|
As a small protection against data loss when running an unprotected
|
|
instance, it writes a numbered backup of the main journal file (only ?)
|
|
on every edit.
|
|
.PP
|
|
The journal file is \f[C]~/.hledger.journal\f[], \f[C]$LEDGER_FILE\f[],
|
|
or another file specified with \-f.
|
|
For more about the format, see hledger(1) or hledger_journal(5).
|
|
.PP
|
|
By default, hledger\-web starts the web app in "transient mode" and also
|
|
opens it in your default web browser if possible.
|
|
In this mode the web app will keep running for as long as you have it
|
|
open in a browser window, and will exit after two minutes of inactivity
|
|
(no requests and no browser windows viewing it).
|
|
.IP
|
|
.nf
|
|
\f[C]
|
|
$\ hledger\ web
|
|
Starting\ web\ app\ on\ port\ 5000\ with\ base\ url\ http://localhost:5000
|
|
Starting\ web\ browser\ if\ possible
|
|
Web\ app\ will\ auto\-exit\ after\ a\ few\ minutes\ with\ no\ browsers\ (or\ press\ ctrl\-c)
|
|
\f[]
|
|
.fi
|
|
.PP
|
|
With \f[C]\-\-server\f[], it starts the web app in non\-transient mode
|
|
and logs requests to the console.
|
|
Typically when running hledger web as part of a website you\[aq]ll want
|
|
to use \f[C]\-\-base\-url\f[] to set the protocol/hostname/port/path to
|
|
be used in hyperlinks.
|
|
The \f[C]\-\-file\-url\f[] option allows static files to be served from
|
|
a different url, eg for better caching or cookie\-less serving.
|
|
.PP
|
|
You can use \f[C]\-\-port\f[] to listen on a different TCP port, eg if
|
|
you are running multiple hledger\-web instances.
|
|
This need not be the same as the PORT in the base url.
|
|
.PP
|
|
Note there is no built\-in access control, so you will need to hide
|
|
hledger\-web behind an authenticating proxy (such as apache or nginx) if
|
|
you want to restrict who can see and add entries to your journal.
|
|
.PP
|
|
Command\-line options and arguments may be used to set an initial filter
|
|
on the data.
|
|
This is not shown in the web UI, but it will be applied in addition to
|
|
any search query entered there.
|
|
.PP
|
|
With journal and timeclock files (but not CSV files, currently) the web
|
|
app detects changes made by other means and will show the new data on
|
|
the next request.
|
|
If a change makes the file unparseable, hledger\-web will show an error
|
|
until the file has been fixed.
|
|
.SH OPTIONS
|
|
.PP
|
|
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
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-\-port=PORT\f[]
|
|
set the TCP port to listen on (default: 5000)
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-\-base\-url=URL\f[]
|
|
set the base url (default: http://localhost:PORT).
|
|
You would change this when sharing over the network, or integrating
|
|
within a larger website.
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-\-file\-url=URL\f[]
|
|
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
|
|
with this.
|
|
.RS
|
|
.RE
|
|
.PP
|
|
hledger general options:
|
|
.TP
|
|
.B \f[C]\-h\f[]
|
|
show general usage (or after COMMAND, the command\[aq]s usage)
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-\-help\f[]
|
|
show the current program\[aq]s manual as plain text (or after an add\-on
|
|
COMMAND, the add\-on\[aq]s manual)
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-\-man\f[]
|
|
show the current program\[aq]s manual with man
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-\-info\f[]
|
|
show the current program\[aq]s manual with info
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-\-version\f[]
|
|
show version
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-\-debug=N\f[]
|
|
show debug output if N is 1\-9 (default: 0)
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-f\ FILE\ \-\-file=FILE\f[]
|
|
use a different input file.
|
|
For stdin, use \-
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-\-rules\-file=RULESFILE\f[]
|
|
Conversion rules file to use when reading CSV (default: FILE.rules)
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-\-alias=OLD=NEW\f[]
|
|
display accounts named OLD as NEW
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-\-ignore\-assertions\f[]
|
|
ignore any failing balance assertions in the journal
|
|
.RS
|
|
.RE
|
|
.PP
|
|
hledger reporting options:
|
|
.TP
|
|
.B \f[C]\-b\ \-\-begin=DATE\f[]
|
|
include postings/txns on or after this date
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-e\ \-\-end=DATE\f[]
|
|
include postings/txns before this date
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-D\ \-\-daily\f[]
|
|
multiperiod/multicolumn report by day
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-W\ \-\-weekly\f[]
|
|
multiperiod/multicolumn report by week
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-M\ \-\-monthly\f[]
|
|
multiperiod/multicolumn report by month
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-Q\ \-\-quarterly\f[]
|
|
multiperiod/multicolumn report by quarter
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-Y\ \-\-yearly\f[]
|
|
multiperiod/multicolumn report by year
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-p\ \-\-period=PERIODEXP\f[]
|
|
set start date, end date, and/or reporting interval all at once
|
|
(overrides the flags above)
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-\-date2\f[]
|
|
show, and match with \-b/\-e/\-p/date:, secondary dates instead
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-C\ \-\-cleared\f[]
|
|
include only cleared postings/txns
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-\-pending\f[]
|
|
include only pending postings/txns
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-U\ \-\-uncleared\f[]
|
|
include only uncleared (and pending) postings/txns
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-R\ \-\-real\f[]
|
|
include only non\-virtual postings
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-\-depth=N\f[]
|
|
hide accounts/postings deeper than N
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-E\ \-\-empty\f[]
|
|
show items with zero amount, normally hidden
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B \f[C]\-B\ \-\-cost\f[]
|
|
show amounts in their cost price\[aq]s commodity
|
|
.RS
|
|
.RE
|
|
.TP
|
|
.B `\-\-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".
|
|
.RS
|
|
.RE
|
|
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".
|
|
.RS
|
|
.RE
|
|
.SH ENVIRONMENT
|
|
.PP
|
|
\f[B]LEDGER_FILE\f[] sets the default journal file path.
|
|
If not set, it is \f[C]~/.hledger.journal\f[].
|
|
.SH FILES
|
|
.PP
|
|
Reads data from a hledger journal file (\f[C]$LEDGER_FILE\f[] or
|
|
\f[C]~/.hledger.journal\f[] by default), or a CSV file plus associated
|
|
CSV rules file.
|
|
.SH BUGS
|
|
.PP
|
|
The need to precede options with \f[C]\-\-\f[] when invoked from hledger
|
|
is awkward.
|
|
.PP
|
|
\f[C]\-f\-\f[] doesn\[aq]t work (hledger\-web can\[aq]t read from
|
|
stdin).
|
|
.PP
|
|
Query arguments and some applicable hledger options probably aren\[aq]t
|
|
supported.
|
|
.PP
|
|
Does not work in text\-mode browsers.
|
|
.PP
|
|
Does not work well on small screens.
|
|
.PP
|
|
The auto\-exit feature was added to avoid leaving stray processes, eg on
|
|
Windows.
|
|
It is not well tested.
|
|
.PP
|
|
If you start two instances on the same port, the second one will appear
|
|
to run normally, but you will be seeing pages served from the first one.
|
|
|
|
|
|
.SH "REPORTING BUGS"
|
|
Report bugs at http://bugs.hledger.org
|
|
(or on the #hledger IRC channel or hledger mail list)
|
|
|
|
.SH AUTHORS
|
|
Simon Michael <simon@joyful.com> and contributors
|
|
|
|
.SH COPYRIGHT
|
|
|
|
Copyright (C) 2007-2016 Simon Michael.
|
|
.br
|
|
Released under GNU GPL v3 or later.
|
|
|
|
.SH SEE ALSO
|
|
hledger(1), hledger\-ui(1), hledger\-web(1), hledger\-api(1),
|
|
hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_timedot(5),
|
|
ledger(1)
|
|
|
|
http://hledger.org
|