summaryrefslogtreecommitdiff
path: root/hledger-web.txt
diff options
context:
space:
mode:
Diffstat (limited to 'hledger-web.txt')
-rw-r--r--hledger-web.txt87
1 files changed, 45 insertions, 42 deletions
diff --git a/hledger-web.txt b/hledger-web.txt
index ea808a4..09881dc 100644
--- a/hledger-web.txt
+++ b/hledger-web.txt
@@ -4,50 +4,51 @@ HLEDGER-WEB(1) hledger User Manuals HLEDGER-WEB(1)
NAME
- A web interface (WUI) for the hledger accounting tool.
+ hledger-web is a web interface (WUI) for the hledger accounting tool.
+ This manual is for hledger-web 1.21.
SYNOPSIS
hledger-web [OPTIONS]
hledger web -- [OPTIONS]
DESCRIPTION
- hledger is a reliable, cross-platform set of programs for tracking
- money, time, or any other commodity, using double-entry accounting and
- a simple, editable file format. hledger is inspired by and largely
+ hledger is a reliable, cross-platform set of programs 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).
- hledger-web is hledger's web interface. It starts a simple web appli-
+ hledger-web is hledger's web interface. It starts a simple web appli-
cation 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
+ 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.
- 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
+ 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.
- Like hledger, it reads data from one or more files in hledger journal,
- timeclock, timedot, or CSV format specified with -f, or $LEDGER_FILE,
- or $HOME/.hledger.journal (on windows, perhaps
- C:/Users/USER/.hledger.journal). For more about this see hledger(1),
+ Like hledger, it reads data from one or more files in hledger journal,
+ timeclock, timedot, or CSV format specified with -f, or $LEDGER_FILE,
+ or $HOME/.hledger.journal (on windows, perhaps
+ C:/Users/USER/.hledger.journal). For more about this see hledger(1),
hledger_journal(5) etc.
OPTIONS
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
+ 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
+ Note: if invoking hledger-web as a hledger subcommand, write -- before
options, as shown in the synopsis above.
--serve
serve and log requests, don't browse or auto-exit
--serve-api
- like --serve, but serve only the JSON web API, without the
+ like --serve, but serve only the JSON web API, without the
server-side web UI
--host=IPADDR
@@ -57,30 +58,30 @@ OPTIONS
listen on this TCP port (default: 5000)
--socket=SOCKETFILE
- use a unix domain socket file to listen for requests instead of
- a TCP socket. Implies --serve. It can only be used if the
+ use a unix domain socket file to listen for requests instead of
+ a TCP socket. Implies --serve. It can only be used if the
operating system can provide this type of socket.
--base-url=URL
- set the base url (default: http://IPADDR: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.
--capabilities=CAP[,CAP..]
- enable the view, add, and/or manage capabilities (default:
+ enable the view, add, and/or manage capabilities (default:
view,add)
--capabilities-header=HTTPHEADER
- read capabilities to enable from a HTTP header, like X-Sand-
+ read capabilities to enable from a HTTP header, like X-Sand-
storm-Permissions (default: disabled)
- --test run hledger-web's tests and exit. hspec test runner args may
+ --test run hledger-web's tests and exit. hspec test runner args may
follow a --, eg: hledger-web --test -- --help
hledger input options:
@@ -90,7 +91,7 @@ OPTIONS
$LEDGER_FILE or $HOME/.hledger.journal)
--rules-file=RULESFILE
- Conversion rules file to use when reading CSV (default:
+ Conversion rules file to use when reading CSV (default:
FILE.rules)
--separator=CHAR
@@ -109,7 +110,7 @@ OPTIONS
assignments)
-s --strict
- do extra error checking (check that all posted accounts are
+ do extra error checking (check that all posted accounts are
declared)
hledger reporting options:
@@ -136,11 +137,11 @@ 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
using period expressions syntax
--date2
- match the secondary date instead (see command help for other
+ match the secondary date instead (see command help for other
effects)
-U --unmarked
@@ -159,25 +160,26 @@ OPTIONS
hide/aggregate accounts or postings more than NUM levels deep
-E --empty
- show items with zero amount, normally hidden (and vice-versa in
+ show items with zero amount, normally hidden (and vice-versa in
hledger-ui/hledger-web)
-B --cost
convert amounts to their cost/selling amount at transaction time
-V --market
- convert amounts to their market value in default valuation com-
+ convert amounts to their market value in default valuation com-
modities
-X --exchange=COMM
convert amounts to their market value in commodity COMM
--value
- convert amounts to cost or market value, more flexibly than
+ convert amounts to cost or market value, more flexibly than
-B/-V/-X
- --infer-value
- with -V/-X/--value, also infer market prices from transactions
+ --infer-market-prices
+ use transaction prices (recorded with @ or @@) as additional
+ market prices, as if they were P directives
--auto apply automated posting rules to modify transactions.
@@ -201,10 +203,14 @@ OPTIONS
hledger help options:
-h --help
- show general usage (or after COMMAND, command usage)
+ show general or COMMAND help
+
+ --man show general or COMMAND user manual with man
+
+ --info show general or COMMAND user manual with info
--version
- show version
+ show general or ADDONCMD version
--debug[=N]
show debug output (levels 1-9, default: 1)
@@ -547,9 +553,6 @@ COPYRIGHT
SEE ALSO
hledger(1), hledger-ui(1), hledger-web(1), ledger(1)
- hledger_journal(5), hledger_csv(5), hledger_timeclock(5), hledger_time-
- dot(5)
-
-hledger-web-1.20.4 December 2020 HLEDGER-WEB(1)
+hledger-web-1.21 December 2020 HLEDGER-WEB(1)