mirror of
https://github.com/simonmichael/hledger.git
synced 2024-11-07 21:15:19 +03:00
;update manuals
This commit is contained in:
parent
0c56d3ffa3
commit
7fad876014
@ -1,2 +1,2 @@
|
||||
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
||||
m4_define({{_monthyear_}}, {{December 2020}})m4_dnl
|
||||
m4_define({{_monthyear_}}, {{March 2021}})m4_dnl
|
||||
|
@ -1,2 +1,2 @@
|
||||
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
||||
m4_define({{_monthyear_}}, {{December 2020}})m4_dnl
|
||||
m4_define({{_monthyear_}}, {{March 2021}})m4_dnl
|
||||
|
@ -1,5 +1,5 @@
|
||||
|
||||
.TH "HLEDGER-UI" "1" "December 2020" "hledger-ui-1.21 " "hledger User Manuals"
|
||||
.TH "HLEDGER-UI" "1" "March 2021" "hledger-ui-1.21.99 " "hledger User Manuals"
|
||||
|
||||
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
.PP
|
||||
hledger-ui is a terminal interface (TUI) for the hledger accounting
|
||||
tool.
|
||||
This manual is for hledger-ui 1.21.
|
||||
This manual is for hledger-ui 1.21.99.
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\f[C]hledger-ui [OPTIONS] [QUERYARGS]\f[R]
|
||||
|
@ -8,7 +8,7 @@ hledger-ui(1)
|
||||
*************
|
||||
|
||||
hledger-ui is a terminal interface (TUI) for the hledger accounting
|
||||
tool. This manual is for hledger-ui 1.21.
|
||||
tool. This manual is for hledger-ui 1.21.99.
|
||||
|
||||
`hledger-ui [OPTIONS] [QUERYARGS]'
|
||||
`hledger ui -- [OPTIONS] [QUERYARGS]'
|
||||
@ -527,25 +527,25 @@ program is restarted.
|
||||
|
||||
Tag Table:
|
||||
Node: Top82
|
||||
Node: OPTIONS1475
|
||||
Ref: #options1572
|
||||
Node: KEYS5805
|
||||
Ref: #keys5900
|
||||
Node: SCREENS10196
|
||||
Ref: #screens10301
|
||||
Node: Accounts screen10391
|
||||
Ref: #accounts-screen10519
|
||||
Node: Register screen12723
|
||||
Ref: #register-screen12878
|
||||
Node: Transaction screen14873
|
||||
Ref: #transaction-screen15031
|
||||
Node: Error screen15898
|
||||
Ref: #error-screen16020
|
||||
Node: ENVIRONMENT16262
|
||||
Ref: #environment16376
|
||||
Node: FILES17181
|
||||
Ref: #files17280
|
||||
Node: BUGS17493
|
||||
Ref: #bugs17570
|
||||
Node: OPTIONS1478
|
||||
Ref: #options1575
|
||||
Node: KEYS5808
|
||||
Ref: #keys5903
|
||||
Node: SCREENS10199
|
||||
Ref: #screens10304
|
||||
Node: Accounts screen10394
|
||||
Ref: #accounts-screen10522
|
||||
Node: Register screen12726
|
||||
Ref: #register-screen12881
|
||||
Node: Transaction screen14876
|
||||
Ref: #transaction-screen15034
|
||||
Node: Error screen15901
|
||||
Ref: #error-screen16023
|
||||
Node: ENVIRONMENT16265
|
||||
Ref: #environment16379
|
||||
Node: FILES17184
|
||||
Ref: #files17283
|
||||
Node: BUGS17496
|
||||
Ref: #bugs17573
|
||||
|
||||
End Tag Table
|
||||
|
@ -5,7 +5,7 @@ HLEDGER-UI(1) hledger User Manuals HLEDGER-UI(1)
|
||||
|
||||
NAME
|
||||
hledger-ui is a terminal interface (TUI) for the hledger accounting
|
||||
tool. This manual is for hledger-ui 1.21.
|
||||
tool. This manual is for hledger-ui 1.21.99.
|
||||
|
||||
SYNOPSIS
|
||||
hledger-ui [OPTIONS] [QUERYARGS]
|
||||
@ -463,4 +463,4 @@ SEE ALSO
|
||||
|
||||
|
||||
|
||||
hledger-ui-1.21 December 2020 HLEDGER-UI(1)
|
||||
hledger-ui-1.21.99 March 2021 HLEDGER-UI(1)
|
||||
|
@ -1,2 +1,2 @@
|
||||
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
||||
m4_define({{_monthyear_}}, {{December 2020}})m4_dnl
|
||||
m4_define({{_monthyear_}}, {{March 2021}})m4_dnl
|
||||
|
@ -1,12 +1,12 @@
|
||||
|
||||
.TH "HLEDGER-WEB" "1" "December 2020" "hledger-web-1.21 " "hledger User Manuals"
|
||||
.TH "HLEDGER-WEB" "1" "March 2021" "hledger-web-1.21.99 " "hledger User Manuals"
|
||||
|
||||
|
||||
|
||||
.SH NAME
|
||||
.PP
|
||||
hledger-web is a web interface (WUI) for the hledger accounting tool.
|
||||
This manual is for hledger-web 1.21.
|
||||
This manual is for hledger-web 1.21.99.
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\f[C]hledger-web [OPTIONS]\f[R]
|
||||
@ -41,7 +41,7 @@ Like hledger, it reads data from one or more files in hledger journal,
|
||||
timeclock, timedot, or CSV format specified with \f[C]-f\f[R], or
|
||||
\f[C]$LEDGER_FILE\f[R], or \f[C]$HOME/.hledger.journal\f[R] (on windows,
|
||||
perhaps \f[C]C:/Users/USER/.hledger.journal\f[R]).
|
||||
For more about this see hledger(1), hledger_journal(5) etc.
|
||||
For more about this see hledger(1).
|
||||
.SH OPTIONS
|
||||
.PP
|
||||
Command-line options and arguments may be used to set an initial filter
|
||||
|
@ -8,7 +8,7 @@ hledger-web(1)
|
||||
**************
|
||||
|
||||
hledger-web is a web interface (WUI) for the hledger accounting tool.
|
||||
This manual is for hledger-web 1.21.
|
||||
This manual is for hledger-web 1.21.99.
|
||||
|
||||
`hledger-web [OPTIONS]'
|
||||
`hledger web -- [OPTIONS]'
|
||||
@ -34,8 +34,7 @@ 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),
|
||||
hledger_journal(5) etc.
|
||||
`C:/Users/USER/.hledger.journal'). For more about this see hledger(1).
|
||||
|
||||
* Menu:
|
||||
|
||||
@ -607,21 +606,21 @@ awkward.
|
||||
|
||||
Tag Table:
|
||||
Node: Top84
|
||||
Node: OPTIONS1748
|
||||
Ref: #options1853
|
||||
Node: PERMISSIONS9104
|
||||
Ref: #permissions9243
|
||||
Node: EDITING UPLOADING DOWNLOADING10455
|
||||
Ref: #editing-uploading-downloading10636
|
||||
Node: RELOADING11467
|
||||
Ref: #reloading11601
|
||||
Node: JSON API12033
|
||||
Ref: #json-api12147
|
||||
Node: ENVIRONMENT17636
|
||||
Ref: #environment17752
|
||||
Node: FILES18484
|
||||
Ref: #files18584
|
||||
Node: BUGS18797
|
||||
Ref: #bugs18875
|
||||
Node: OPTIONS1727
|
||||
Ref: #options1832
|
||||
Node: PERMISSIONS9083
|
||||
Ref: #permissions9222
|
||||
Node: EDITING UPLOADING DOWNLOADING10434
|
||||
Ref: #editing-uploading-downloading10615
|
||||
Node: RELOADING11446
|
||||
Ref: #reloading11580
|
||||
Node: JSON API12012
|
||||
Ref: #json-api12126
|
||||
Node: ENVIRONMENT17615
|
||||
Ref: #environment17731
|
||||
Node: FILES18463
|
||||
Ref: #files18563
|
||||
Node: BUGS18776
|
||||
Ref: #bugs18854
|
||||
|
||||
End Tag Table
|
||||
|
@ -5,7 +5,7 @@ HLEDGER-WEB(1) hledger User Manuals HLEDGER-WEB(1)
|
||||
|
||||
NAME
|
||||
hledger-web is a web interface (WUI) for the hledger accounting tool.
|
||||
This manual is for hledger-web 1.21.
|
||||
This manual is for hledger-web 1.21.99.
|
||||
|
||||
SYNOPSIS
|
||||
hledger-web [OPTIONS]
|
||||
@ -33,22 +33,21 @@ DESCRIPTION
|
||||
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),
|
||||
etc.
|
||||
C:/Users/USER/.hledger.journal). For more about this see hledger(1).
|
||||
|
||||
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
|
||||
@ -58,30 +57,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:
|
||||
@ -91,7 +90,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
|
||||
@ -110,7 +109,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:
|
||||
@ -137,11 +136,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
|
||||
@ -160,39 +159,39 @@ 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-market-prices
|
||||
use transaction prices (recorded with @ or @@) as additional
|
||||
use transaction prices (recorded with @ or @@) as additional
|
||||
market prices, as if they were P directives
|
||||
|
||||
--auto apply automated posting rules to modify transactions.
|
||||
|
||||
--forecast
|
||||
generate future transactions from periodic transaction rules,
|
||||
for the next 6 months or till report end date. In hledger-ui,
|
||||
generate future transactions from periodic transaction rules,
|
||||
for the next 6 months or till report end date. In hledger-ui,
|
||||
also make ordinary future transactions visible.
|
||||
|
||||
--color=WHEN (or --colour=WHEN)
|
||||
Should color-supporting commands use ANSI color codes in text
|
||||
output. 'auto' (default): whenever stdout seems to be a color-
|
||||
supporting terminal. 'always' or 'yes': always, useful eg when
|
||||
piping output into 'less -R'. 'never' or 'no': never. A
|
||||
Should color-supporting commands use ANSI color codes in text
|
||||
output. 'auto' (default): whenever stdout seems to be a color-
|
||||
supporting terminal. 'always' or 'yes': always, useful eg when
|
||||
piping output into 'less -R'. 'never' or 'no': never. A
|
||||
NO_COLOR environment variable overrides this.
|
||||
|
||||
When a reporting option appears more than once in the command line, the
|
||||
@ -216,54 +215,54 @@ OPTIONS
|
||||
show debug output (levels 1-9, default: 1)
|
||||
|
||||
A @FILE argument will be expanded to the contents of FILE, which should
|
||||
contain one command line option/argument per line. (To prevent this,
|
||||
contain one command line option/argument per line. (To prevent this,
|
||||
insert a -- argument before.)
|
||||
|
||||
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 win-
|
||||
dow, and will exit after two minutes of inactivity (no requests and no
|
||||
browser windows viewing it). With --serve, it just runs the web app
|
||||
without exiting, and logs requests to the console. With --serve-api,
|
||||
only the JSON web api (see below) is served, with the usual HTML
|
||||
dow, and will exit after two minutes of inactivity (no requests and no
|
||||
browser windows viewing it). With --serve, it just runs the web app
|
||||
without exiting, and logs requests to the console. With --serve-api,
|
||||
only the JSON web api (see below) is served, with the usual HTML
|
||||
server-side web UI disabled.
|
||||
|
||||
By default the server listens on IP address 127.0.0.1, accessible only
|
||||
to local requests. You can use --host to change this, eg --host
|
||||
By default the server listens on IP address 127.0.0.1, accessible only
|
||||
to local requests. You can use --host to change this, eg --host
|
||||
0.0.0.0 to listen on all configured addresses.
|
||||
|
||||
Similarly, use --port to set a TCP port other than 5000, eg if you are
|
||||
Similarly, use --port to set a TCP port other than 5000, eg if you are
|
||||
running multiple hledger-web instances.
|
||||
|
||||
Both of these options are ignored when --socket is used. In this case,
|
||||
it creates an AF_UNIX socket file at the supplied path and uses that
|
||||
for communication. This is an alternative way of running multiple
|
||||
hledger-web instances behind a reverse proxy that handles authentica-
|
||||
tion for different users. The path can be derived in a predictable
|
||||
it creates an AF_UNIX socket file at the supplied path and uses that
|
||||
for communication. This is an alternative way of running multiple
|
||||
hledger-web instances behind a reverse proxy that handles authentica-
|
||||
tion for different users. The path can be derived in a predictable
|
||||
way, eg by using the username within the path. As an example, nginx as
|
||||
reverse proxy can use the variable $remote_user to derive a path from
|
||||
the username used in a HTTP basic authentication. The following
|
||||
proxy_pass directive allows access to all hledger-web instances that
|
||||
reverse proxy can use the variable $remote_user to derive a path from
|
||||
the username used in a HTTP basic authentication. The following
|
||||
proxy_pass directive allows access to all hledger-web instances that
|
||||
created a socket in /tmp/hledger/:
|
||||
|
||||
proxy_pass http://unix:/tmp/hledger/${remote_user}.socket;
|
||||
|
||||
You can use --base-url to change the protocol, hostname, port and path
|
||||
You can use --base-url to change the protocol, hostname, port and path
|
||||
that appear in hyperlinks, useful eg for integrating hledger-web within
|
||||
a larger website. The default is http://HOST:PORT/ using the server's
|
||||
a larger website. The default is http://HOST:PORT/ using the server's
|
||||
configured host address and TCP port (or http://HOST if PORT is 80).
|
||||
|
||||
With --file-url you can set a different base url for static files, eg
|
||||
With --file-url you can set a different base url for static files, eg
|
||||
for better caching or cookie-less serving on high performance websites.
|
||||
|
||||
PERMISSIONS
|
||||
By default, hledger-web allows anyone who can reach it to view the
|
||||
By default, hledger-web allows anyone who can reach it to view the
|
||||
journal and to add new transactions, but not to change existing data.
|
||||
|
||||
You can restrict who can reach it by
|
||||
|
||||
o setting the IP address it listens on (see --host above). By default
|
||||
it listens on 127.0.0.1, accessible to all users on the local
|
||||
o setting the IP address it listens on (see --host above). By default
|
||||
it listens on 127.0.0.1, accessible to all users on the local
|
||||
machine.
|
||||
|
||||
o putting it behind an authenticating proxy, using eg apache or nginx
|
||||
@ -273,53 +272,53 @@ PERMISSIONS
|
||||
You can restrict what the users who reach it can do, by
|
||||
|
||||
o using the --capabilities=CAP[,CAP..] flag when you start it, enabling
|
||||
one or more of the following capabilities. The default value is
|
||||
one or more of the following capabilities. The default value is
|
||||
view,add:
|
||||
|
||||
o view - allows viewing the journal file and all included files
|
||||
|
||||
o add - allows adding new transactions to the main journal file
|
||||
|
||||
o manage - allows editing, uploading or downloading the main or
|
||||
o manage - allows editing, uploading or downloading the main or
|
||||
included files
|
||||
|
||||
o using the --capabilities-header=HTTPHEADER flag to specify a HTTP
|
||||
header from which it will read capabilities to enable. hledger-web
|
||||
on Sandstorm uses the X-Sandstorm-Permissions header to integrate
|
||||
o using the --capabilities-header=HTTPHEADER flag to specify a HTTP
|
||||
header from which it will read capabilities to enable. hledger-web
|
||||
on Sandstorm uses the X-Sandstorm-Permissions header to integrate
|
||||
with Sandstorm's permissions. This is disabled by default.
|
||||
|
||||
EDITING, UPLOADING, DOWNLOADING
|
||||
If you enable the manage capability mentioned above, you'll see a new
|
||||
"spanner" button to the right of the search form. Clicking this will
|
||||
let you edit, upload, or download the journal file or any files it
|
||||
If you enable the manage capability mentioned above, you'll see a new
|
||||
"spanner" button to the right of the search form. Clicking this will
|
||||
let you edit, upload, or download the journal file or any files it
|
||||
includes.
|
||||
|
||||
Note, unlike any other hledger command, in this mode you (or any visi-
|
||||
Note, unlike any other hledger command, in this mode you (or any visi-
|
||||
tor) can alter or wipe the data files.
|
||||
|
||||
Normally whenever a file is changed in this way, hledger-web saves a
|
||||
numbered backup (assuming file permissions allow it, the disk is not
|
||||
full, etc.) hledger-web is not aware of version control systems, cur-
|
||||
rently; if you use one, you'll have to arrange to commit the changes
|
||||
Normally whenever a file is changed in this way, hledger-web saves a
|
||||
numbered backup (assuming file permissions allow it, the disk is not
|
||||
full, etc.) hledger-web is not aware of version control systems, cur-
|
||||
rently; if you use one, you'll have to arrange to commit the changes
|
||||
yourself (eg with a cron job or a file watcher like entr).
|
||||
|
||||
Changes which would leave the journal file(s) unparseable or non-valid
|
||||
(eg with failing balance assertions) are prevented. (Probably. This
|
||||
Changes which would leave the journal file(s) unparseable or non-valid
|
||||
(eg with failing balance assertions) are prevented. (Probably. This
|
||||
needs re-testing.)
|
||||
|
||||
RELOADING
|
||||
hledger-web detects changes made to the files by other means (eg if you
|
||||
edit it directly, outside of hledger-web), and it will show the new
|
||||
data when you reload the page or navigate to a new page. If a change
|
||||
makes a file unparseable, hledger-web will display an error message
|
||||
edit it directly, outside of hledger-web), and it will show the new
|
||||
data when you reload the page or navigate to a new page. If a change
|
||||
makes a file unparseable, hledger-web will display an error message
|
||||
until the file has been fixed.
|
||||
|
||||
(Note: if you are viewing files mounted from another machine, make sure
|
||||
that both machine clocks are roughly in step.)
|
||||
|
||||
JSON API
|
||||
In addition to the web UI, hledger-web also serves a JSON API that can
|
||||
be used to get data or add new transactions. If you want the JSON API
|
||||
In addition to the web UI, hledger-web also serves a JSON API that can
|
||||
be used to get data or add new transactions. If you want the JSON API
|
||||
only, you can use the --serve-api flag. Eg:
|
||||
|
||||
$ hledger-web -f examples/sample.journal --serve-api
|
||||
@ -336,7 +335,7 @@ JSON API
|
||||
/accounttransactions/ACCOUNTNAME
|
||||
|
||||
Eg, all account names in the journal (similar to the accounts command).
|
||||
(hledger-web's JSON does not include newlines, here we use python to
|
||||
(hledger-web's JSON does not include newlines, here we use python to
|
||||
prettify it):
|
||||
|
||||
$ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool
|
||||
@ -377,25 +376,25 @@ JSON API
|
||||
"aprice": null,
|
||||
...
|
||||
|
||||
Most of the JSON corresponds to hledger's data types; for details of
|
||||
what the fields mean, see the Hledger.Data.Json haddock docs and click
|
||||
on the various data types, eg Transaction. And for a higher level
|
||||
Most of the JSON corresponds to hledger's data types; for details of
|
||||
what the fields mean, see the Hledger.Data.Json haddock docs and click
|
||||
on the various data types, eg Transaction. And for a higher level
|
||||
understanding, see the journal manual.
|
||||
|
||||
In some cases there is outer JSON corresponding to a "Report" type. To
|
||||
understand that, go to the Hledger.Web.Handler.MiscR haddock and look
|
||||
at the source for the appropriate handler to see what it returns. Eg
|
||||
understand that, go to the Hledger.Web.Handler.MiscR haddock and look
|
||||
at the source for the appropriate handler to see what it returns. Eg
|
||||
for /accounttransactions it's getAccounttransactionsR, returning a
|
||||
"accountTransactionsReport ...". Looking up the haddock for that we
|
||||
"accountTransactionsReport ...". Looking up the haddock for that we
|
||||
can see that /accounttransactions returns an AccountTransactionsReport,
|
||||
which consists of a report title and a list of AccountTransactionsRe-
|
||||
which consists of a report title and a list of AccountTransactionsRe-
|
||||
portItem (etc).
|
||||
|
||||
You can add a new transaction to the journal with a PUT request to
|
||||
/add, if hledger-web was started with the add capability (enabled by
|
||||
You can add a new transaction to the journal with a PUT request to
|
||||
/add, if hledger-web was started with the add capability (enabled by
|
||||
default). The payload must be the full, exact JSON representation of a
|
||||
hledger transaction (partial data won't do). You can get sample JSON
|
||||
from hledger-web's /transactions or /accounttransactions, or you can
|
||||
hledger transaction (partial data won't do). You can get sample JSON
|
||||
from hledger-web's /transactions or /accounttransactions, or you can
|
||||
export it with hledger-lib, eg like so:
|
||||
|
||||
.../hledger$ stack ghci hledger-lib
|
||||
@ -491,23 +490,23 @@ JSON API
|
||||
"tstatus": "Unmarked"
|
||||
}
|
||||
|
||||
And here's how to test adding it with curl. This should add a new
|
||||
And here's how to test adding it with curl. This should add a new
|
||||
entry to your journal:
|
||||
|
||||
$ curl http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' --data-binary @txn.json
|
||||
|
||||
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).
|
||||
|
||||
A typical value is ~/DIR/YYYY.journal, where DIR is a version-con-
|
||||
trolled finance directory and YYYY is the current year. Or ~/DIR/cur-
|
||||
A typical value is ~/DIR/YYYY.journal, where DIR is a version-con-
|
||||
trolled finance directory and YYYY is the current year. Or ~/DIR/cur-
|
||||
rent.journal, where current.journal is a symbolic link to YYYY.journal.
|
||||
|
||||
On Mac computers, you can set this and other environment variables in a
|
||||
more thorough way that also affects applications started from the GUI
|
||||
(say, an Emacs dock icon). Eg on MacOS Catalina I have a
|
||||
more thorough way that also affects applications started from the GUI
|
||||
(say, an Emacs dock icon). Eg on MacOS Catalina I have a
|
||||
~/.MacOSX/environment.plist file containing
|
||||
|
||||
{
|
||||
@ -517,13 +516,13 @@ ENVIRONMENT
|
||||
To see the effect you may need to killall Dock, or reboot.
|
||||
|
||||
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).
|
||||
@ -537,7 +536,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)
|
||||
|
||||
|
||||
@ -555,4 +554,4 @@ SEE ALSO
|
||||
|
||||
|
||||
|
||||
hledger-web-1.21 December 2020 HLEDGER-WEB(1)
|
||||
hledger-web-1.21.99 March 2021 HLEDGER-WEB(1)
|
||||
|
@ -1,2 +1,2 @@
|
||||
m4_dnl Date to show in man pages. Updated by "Shake manuals"
|
||||
m4_define({{_monthyear_}}, {{December 2020}})m4_dnl
|
||||
m4_define({{_monthyear_}}, {{March 2021}})m4_dnl
|
||||
|
@ -1,6 +1,6 @@
|
||||
.\"t
|
||||
|
||||
.TH "HLEDGER" "1" "December 2020" "hledger-1.21 " "hledger User Manuals"
|
||||
.TH "HLEDGER" "1" "March 2021" "hledger-1.21.99 " "hledger User Manuals"
|
||||
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
This is the command-line interface (CLI) for the hledger accounting
|
||||
tool.
|
||||
Here we also describe hledger\[aq]s concepts and file formats.
|
||||
This manual is for hledger 1.21.
|
||||
This manual is for hledger 1.21.99.
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\f[C]hledger\f[R]
|
||||
@ -52,8 +52,6 @@ accounts, and are recorded with journal entries like this:
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
For more about this format, see hledger_journal(5).
|
||||
.PP
|
||||
Most users use a text editor to edit the journal, usually with an editor
|
||||
mode such as ledger-mode for added convenience.
|
||||
hledger\[cq]s interactive add command is another way to record new
|
||||
|
@ -9,7 +9,7 @@ hledger(1)
|
||||
|
||||
This is the command-line interface (CLI) for the hledger accounting
|
||||
tool. Here we also describe hledger's concepts and file formats. This
|
||||
manual is for hledger 1.21.
|
||||
manual is for hledger 1.21.99.
|
||||
|
||||
`hledger'
|
||||
|
||||
@ -45,8 +45,6 @@ accounts, and are recorded with journal entries like this:
|
||||
expenses:food $10
|
||||
assets:cash
|
||||
|
||||
For more about this format, see hledger_journal(5).
|
||||
|
||||
Most users use a text editor to edit the journal, usually with an
|
||||
editor mode such as ledger-mode for added convenience. hledger's
|
||||
interactive add command is another way to record new transactions.
|
||||
@ -8612,447 +8610,447 @@ $ LANG=en_US.UTF-8 hledger -f my.journal print
|
||||
|
||||
Tag Table:
|
||||
Node: Top76
|
||||
Node: OPTIONS2502
|
||||
Ref: #options2603
|
||||
Node: General options2745
|
||||
Ref: #general-options2870
|
||||
Node: Command options6439
|
||||
Ref: #command-options6590
|
||||
Node: Command arguments6989
|
||||
Ref: #command-arguments7147
|
||||
Node: Special characters8025
|
||||
Ref: #special-characters8188
|
||||
Node: Single escaping shell metacharacters8351
|
||||
Ref: #single-escaping-shell-metacharacters8592
|
||||
Node: Double escaping regular expression metacharacters8994
|
||||
Ref: #double-escaping-regular-expression-metacharacters9305
|
||||
Node: Triple escaping for add-on commands9831
|
||||
Ref: #triple-escaping-for-add-on-commands10091
|
||||
Node: Less escaping10737
|
||||
Ref: #less-escaping10891
|
||||
Node: Unicode characters11217
|
||||
Ref: #unicode-characters11382
|
||||
Node: Regular expressions12791
|
||||
Ref: #regular-expressions12931
|
||||
Node: ENVIRONMENT14672
|
||||
Ref: #environment14788
|
||||
Node: DATA FILES15770
|
||||
Ref: #data-files15889
|
||||
Node: Data formats16430
|
||||
Ref: #data-formats16548
|
||||
Node: Multiple files18030
|
||||
Ref: #multiple-files18172
|
||||
Node: Strict mode18642
|
||||
Ref: #strict-mode18757
|
||||
Node: TIME PERIODS19407
|
||||
Ref: #time-periods19524
|
||||
Node: Smart dates19622
|
||||
Ref: #smart-dates19748
|
||||
Node: Report start & end date21052
|
||||
Ref: #report-start-end-date21227
|
||||
Node: Report intervals22771
|
||||
Ref: #report-intervals22939
|
||||
Node: Period expressions23327
|
||||
Ref: #period-expressions23467
|
||||
Node: DEPTH27846
|
||||
Ref: #depth27946
|
||||
Node: QUERIES28277
|
||||
Ref: #queries28376
|
||||
Node: COSTING32328
|
||||
Ref: #costing32431
|
||||
Node: VALUATION32704
|
||||
Ref: #valuation32812
|
||||
Node: -V Value33535
|
||||
Ref: #v-value33659
|
||||
Node: -X Value in specified commodity33853
|
||||
Ref: #x-value-in-specified-commodity34046
|
||||
Node: Valuation date34195
|
||||
Ref: #valuation-date34357
|
||||
Node: Market prices34794
|
||||
Ref: #market-prices34975
|
||||
Node: --infer-market-price market prices from transactions36157
|
||||
Ref: #infer-market-price-market-prices-from-transactions36421
|
||||
Node: Valuation commodity37770
|
||||
Ref: #valuation-commodity37980
|
||||
Node: Simple valuation examples39205
|
||||
Ref: #simple-valuation-examples39401
|
||||
Node: --value Flexible valuation40063
|
||||
Ref: #value-flexible-valuation40265
|
||||
Node: More valuation examples41907
|
||||
Ref: #more-valuation-examples42108
|
||||
Node: Effect of valuation on reports44114
|
||||
Ref: #effect-of-valuation-on-reports44296
|
||||
Node: PIVOTING52193
|
||||
Ref: #pivoting52298
|
||||
Node: OUTPUT53977
|
||||
Ref: #output54079
|
||||
Node: Output destination54130
|
||||
Ref: #output-destination54263
|
||||
Node: Output format54688
|
||||
Ref: #output-format54811
|
||||
Node: COMMANDS56974
|
||||
Ref: #commands57086
|
||||
Node: accounts60476
|
||||
Ref: #accounts60576
|
||||
Node: activity61268
|
||||
Ref: #activity61380
|
||||
Node: add61762
|
||||
Ref: #add61865
|
||||
Node: aregister64660
|
||||
Ref: #aregister64774
|
||||
Node: aregister and custom posting dates66969
|
||||
Ref: #aregister-and-custom-posting-dates67135
|
||||
Node: balance67956
|
||||
Ref: #balance68075
|
||||
Node: balance features68988
|
||||
Ref: #balance-features69128
|
||||
Node: Simple balance report70798
|
||||
Ref: #simple-balance-report70980
|
||||
Node: Filtered balance report72428
|
||||
Ref: #filtered-balance-report72615
|
||||
Node: List or tree mode72912
|
||||
Ref: #list-or-tree-mode73080
|
||||
Node: Depth limiting74397
|
||||
Ref: #depth-limiting74563
|
||||
Node: Multi-period balance report75321
|
||||
Ref: #multi-period-balance-report75513
|
||||
Node: Sorting by amount77769
|
||||
Ref: #sorting-by-amount77938
|
||||
Node: Percentages78400
|
||||
Ref: #percentages78556
|
||||
Node: Balance change end balance79488
|
||||
Ref: #balance-change-end-balance79679
|
||||
Node: Balance report types81103
|
||||
Ref: #balance-report-types81293
|
||||
Node: Useful balance reports85457
|
||||
Ref: #useful-balance-reports85638
|
||||
Node: Budget report86722
|
||||
Ref: #budget-report86906
|
||||
Node: Budget report start date92075
|
||||
Ref: #budget-report-start-date92244
|
||||
Node: Nested budgets93571
|
||||
Ref: #nested-budgets93720
|
||||
Node: Customising single-period balance reports97107
|
||||
Ref: #customising-single-period-balance-reports97316
|
||||
Node: balancesheet99473
|
||||
Ref: #balancesheet99611
|
||||
Node: balancesheetequity100909
|
||||
Ref: #balancesheetequity101060
|
||||
Node: cashflow102440
|
||||
Ref: #cashflow102564
|
||||
Node: check103710
|
||||
Ref: #check103815
|
||||
Node: Basic checks104448
|
||||
Ref: #basic-checks104566
|
||||
Node: Strict checks105099
|
||||
Ref: #strict-checks105240
|
||||
Node: Other checks105544
|
||||
Ref: #other-checks105684
|
||||
Node: Custom checks106037
|
||||
Ref: #custom-checks106157
|
||||
Node: close106575
|
||||
Ref: #close106679
|
||||
Node: close usage108196
|
||||
Ref: #close-usage108291
|
||||
Node: codes111099
|
||||
Ref: #codes111209
|
||||
Node: commodities111922
|
||||
Ref: #commodities112051
|
||||
Node: descriptions112133
|
||||
Ref: #descriptions112263
|
||||
Node: diff112567
|
||||
Ref: #diff112675
|
||||
Node: files113720
|
||||
Ref: #files113822
|
||||
Node: help113968
|
||||
Ref: #help114070
|
||||
Node: import114793
|
||||
Ref: #import114909
|
||||
Node: Deduplication115771
|
||||
Ref: #deduplication115896
|
||||
Node: Import testing117784
|
||||
Ref: #import-testing117949
|
||||
Node: Importing balance assignments118439
|
||||
Ref: #importing-balance-assignments118645
|
||||
Node: Commodity display styles119292
|
||||
Ref: #commodity-display-styles119465
|
||||
Node: incomestatement119594
|
||||
Ref: #incomestatement119729
|
||||
Node: notes121030
|
||||
Ref: #notes121145
|
||||
Node: payees121512
|
||||
Ref: #payees121620
|
||||
Node: prices122146
|
||||
Ref: #prices122254
|
||||
Node: print122593
|
||||
Ref: #print122705
|
||||
Node: print-unique128015
|
||||
Ref: #print-unique128143
|
||||
Node: register128429
|
||||
Ref: #register128558
|
||||
Node: Custom register output133002
|
||||
Ref: #custom-register-output133133
|
||||
Node: register-match134470
|
||||
Ref: #register-match134606
|
||||
Node: rewrite134954
|
||||
Ref: #rewrite135071
|
||||
Node: Re-write rules in a file136977
|
||||
Ref: #re-write-rules-in-a-file137140
|
||||
Node: Diff output format138290
|
||||
Ref: #diff-output-format138473
|
||||
Node: rewrite vs print --auto139565
|
||||
Ref: #rewrite-vs.-print---auto139725
|
||||
Node: roi140275
|
||||
Ref: #roi140375
|
||||
Node: Semantics of --inv and --pnl142010
|
||||
Ref: #semantics-of---inv-and---pnl142192
|
||||
Node: IRR and TWR explained144038
|
||||
Ref: #irr-and-twr-explained144198
|
||||
Node: stats147260
|
||||
Ref: #stats147361
|
||||
Node: tags148148
|
||||
Ref: #tags148248
|
||||
Node: test148765
|
||||
Ref: #test148881
|
||||
Node: About add-on commands149626
|
||||
Ref: #about-add-on-commands149763
|
||||
Node: JOURNAL FORMAT150896
|
||||
Ref: #journal-format151024
|
||||
Node: Transactions153204
|
||||
Ref: #transactions153319
|
||||
Node: Dates154336
|
||||
Ref: #dates154452
|
||||
Node: Simple dates154517
|
||||
Ref: #simple-dates154637
|
||||
Node: Secondary dates155144
|
||||
Ref: #secondary-dates155292
|
||||
Node: Posting dates156626
|
||||
Ref: #posting-dates156749
|
||||
Node: Status158118
|
||||
Ref: #status158235
|
||||
Node: Description159940
|
||||
Ref: #description160070
|
||||
Node: Payee and note160388
|
||||
Ref: #payee-and-note160496
|
||||
Node: Comments160830
|
||||
Ref: #comments160952
|
||||
Node: Tags162145
|
||||
Ref: #tags-1162256
|
||||
Node: Postings163654
|
||||
Ref: #postings163778
|
||||
Node: Virtual postings164802
|
||||
Ref: #virtual-postings164913
|
||||
Node: Account names166215
|
||||
Ref: #account-names166352
|
||||
Node: Amounts166838
|
||||
Ref: #amounts166973
|
||||
Node: Decimal marks digit group marks168032
|
||||
Ref: #decimal-marks-digit-group-marks168221
|
||||
Node: Commodity display style169568
|
||||
Ref: #commodity-display-style169756
|
||||
Node: Rounding171782
|
||||
Ref: #rounding171900
|
||||
Node: Transaction prices172310
|
||||
Ref: #transaction-prices172476
|
||||
Node: Lot prices lot dates174906
|
||||
Ref: #lot-prices-lot-dates175089
|
||||
Node: Balance assertions175576
|
||||
Ref: #balance-assertions175754
|
||||
Node: Assertions and ordering176784
|
||||
Ref: #assertions-and-ordering176966
|
||||
Node: Assertions and included files177663
|
||||
Ref: #assertions-and-included-files177900
|
||||
Node: Assertions and multiple -f options178231
|
||||
Ref: #assertions-and-multiple--f-options178481
|
||||
Node: Assertions and commodities178612
|
||||
Ref: #assertions-and-commodities178838
|
||||
Node: Assertions and prices179993
|
||||
Ref: #assertions-and-prices180201
|
||||
Node: Assertions and subaccounts180642
|
||||
Ref: #assertions-and-subaccounts180865
|
||||
Node: Assertions and virtual postings181189
|
||||
Ref: #assertions-and-virtual-postings181425
|
||||
Node: Assertions and precision181566
|
||||
Ref: #assertions-and-precision181753
|
||||
Node: Balance assignments182018
|
||||
Ref: #balance-assignments182188
|
||||
Node: Balance assignments and prices183351
|
||||
Ref: #balance-assignments-and-prices183517
|
||||
Node: Directives183743
|
||||
Ref: #directives183906
|
||||
Node: Directives and multiple files189311
|
||||
Ref: #directives-and-multiple-files189507
|
||||
Node: Comment blocks190169
|
||||
Ref: #comment-blocks190346
|
||||
Node: Including other files190521
|
||||
Ref: #including-other-files190695
|
||||
Node: Default year191619
|
||||
Ref: #default-year191777
|
||||
Node: Declaring payees192184
|
||||
Ref: #declaring-payees192350
|
||||
Node: Declaring commodities192595
|
||||
Ref: #declaring-commodities192776
|
||||
Node: Commodity error checking194617
|
||||
Ref: #commodity-error-checking194767
|
||||
Node: Default commodity195023
|
||||
Ref: #default-commodity195203
|
||||
Node: Declaring market prices196088
|
||||
Ref: #declaring-market-prices196277
|
||||
Node: Declaring accounts197135
|
||||
Ref: #declaring-accounts197315
|
||||
Node: Account error checking198522
|
||||
Ref: #account-error-checking198688
|
||||
Node: Account comments199865
|
||||
Ref: #account-comments200049
|
||||
Node: Account subdirectives200475
|
||||
Ref: #account-subdirectives200660
|
||||
Node: Account types200975
|
||||
Ref: #account-types201149
|
||||
Node: Declaring account types201884
|
||||
Ref: #declaring-account-types202063
|
||||
Node: Auto-detected account types202714
|
||||
Ref: #auto-detected-account-types202955
|
||||
Node: Interference from auto-detected account types203854
|
||||
Ref: #interference-from-auto-detected-account-types204131
|
||||
Node: Old account type syntax204614
|
||||
Ref: #old-account-type-syntax204811
|
||||
Node: Account display order205112
|
||||
Ref: #account-display-order205272
|
||||
Node: Rewriting accounts206423
|
||||
Ref: #rewriting-accounts206602
|
||||
Node: Basic aliases207361
|
||||
Ref: #basic-aliases207497
|
||||
Node: Regex aliases208199
|
||||
Ref: #regex-aliases208361
|
||||
Node: Combining aliases209081
|
||||
Ref: #combining-aliases209264
|
||||
Node: Aliases and multiple files210541
|
||||
Ref: #aliases-and-multiple-files210740
|
||||
Node: end aliases211321
|
||||
Ref: #end-aliases211468
|
||||
Node: Default parent account211570
|
||||
Ref: #default-parent-account211760
|
||||
Node: Periodic transactions212644
|
||||
Ref: #periodic-transactions212827
|
||||
Node: Periodic rule syntax214744
|
||||
Ref: #periodic-rule-syntax214944
|
||||
Node: Two spaces between period expression and description!215647
|
||||
Ref: #two-spaces-between-period-expression-and-description215960
|
||||
Node: Forecasting with periodic transactions216645
|
||||
Ref: #forecasting-with-periodic-transactions216944
|
||||
Node: Budgeting with periodic transactions218990
|
||||
Ref: #budgeting-with-periodic-transactions219223
|
||||
Node: Auto postings219630
|
||||
Ref: #auto-postings219766
|
||||
Node: Auto postings and multiple files221949
|
||||
Ref: #auto-postings-and-multiple-files222147
|
||||
Node: Auto postings and dates222355
|
||||
Ref: #auto-postings-and-dates222623
|
||||
Node: Auto postings and transaction balancing / inferred amounts / balance assertions222798
|
||||
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions223144
|
||||
Node: Auto posting tags223489
|
||||
Ref: #auto-posting-tags223698
|
||||
Node: CSV FORMAT224335
|
||||
Ref: #csv-format224463
|
||||
Node: Examples227044
|
||||
Ref: #examples227147
|
||||
Node: Basic227354
|
||||
Ref: #basic227456
|
||||
Node: Bank of Ireland228000
|
||||
Ref: #bank-of-ireland228137
|
||||
Node: Amazon229602
|
||||
Ref: #amazon229722
|
||||
Node: Paypal231443
|
||||
Ref: #paypal231539
|
||||
Node: CSV rules239187
|
||||
Ref: #csv-rules239305
|
||||
Node: skip239617
|
||||
Ref: #skip239712
|
||||
Node: fields240084
|
||||
Ref: #fields240208
|
||||
Node: Transaction field names241369
|
||||
Ref: #transaction-field-names241531
|
||||
Node: Posting field names241642
|
||||
Ref: #posting-field-names241796
|
||||
Node: field assignment244157
|
||||
Ref: #field-assignment244302
|
||||
Node: separator245116
|
||||
Ref: #separator245253
|
||||
Node: if block245795
|
||||
Ref: #if-block245922
|
||||
Node: Matching the whole record246320
|
||||
Ref: #matching-the-whole-record246497
|
||||
Node: Matching individual fields247301
|
||||
Ref: #matching-individual-fields247507
|
||||
Node: Combining matchers247731
|
||||
Ref: #combining-matchers247929
|
||||
Node: Rules applied on successful match248243
|
||||
Ref: #rules-applied-on-successful-match248436
|
||||
Node: if table249093
|
||||
Ref: #if-table249214
|
||||
Node: end250950
|
||||
Ref: #end251064
|
||||
Node: date-format251288
|
||||
Ref: #date-format251422
|
||||
Node: decimal-mark252172
|
||||
Ref: #decimal-mark252317
|
||||
Node: newest-first252654
|
||||
Ref: #newest-first252797
|
||||
Node: include253480
|
||||
Ref: #include253613
|
||||
Node: balance-type254055
|
||||
Ref: #balance-type254177
|
||||
Node: Tips254877
|
||||
Ref: #tips254968
|
||||
Node: Rapid feedback255267
|
||||
Ref: #rapid-feedback255386
|
||||
Node: Valid CSV255845
|
||||
Ref: #valid-csv255977
|
||||
Node: File Extension256169
|
||||
Ref: #file-extension256323
|
||||
Node: Reading multiple CSV files256752
|
||||
Ref: #reading-multiple-csv-files256939
|
||||
Node: Valid transactions257179
|
||||
Ref: #valid-transactions257359
|
||||
Node: Deduplicating importing257987
|
||||
Ref: #deduplicating-importing258168
|
||||
Node: Setting amounts259200
|
||||
Ref: #setting-amounts259357
|
||||
Node: Amount signs261576
|
||||
Ref: #amount-signs261730
|
||||
Node: Setting currency/commodity262417
|
||||
Ref: #setting-currencycommodity262605
|
||||
Node: Amount decimal places263785
|
||||
Ref: #amount-decimal-places263977
|
||||
Node: Referencing other fields264289
|
||||
Ref: #referencing-other-fields264488
|
||||
Node: How CSV rules are evaluated265386
|
||||
Ref: #how-csv-rules-are-evaluated265561
|
||||
Node: TIMECLOCK FORMAT267010
|
||||
Ref: #timeclock-format267150
|
||||
Node: TIMEDOT FORMAT269218
|
||||
Ref: #timedot-format269356
|
||||
Node: COMMON TASKS273619
|
||||
Ref: #common-tasks273748
|
||||
Node: Getting help274155
|
||||
Ref: #getting-help274289
|
||||
Node: Constructing command lines274840
|
||||
Ref: #constructing-command-lines275034
|
||||
Node: Starting a journal file275733
|
||||
Ref: #starting-a-journal-file275933
|
||||
Node: Setting opening balances277120
|
||||
Ref: #setting-opening-balances277318
|
||||
Node: Recording transactions280451
|
||||
Ref: #recording-transactions280633
|
||||
Node: Reconciling281190
|
||||
Ref: #reconciling281335
|
||||
Node: Reporting283580
|
||||
Ref: #reporting283722
|
||||
Node: Migrating to a new file287642
|
||||
Ref: #migrating-to-a-new-file287792
|
||||
Node: LIMITATIONS288090
|
||||
Ref: #limitations288218
|
||||
Node: TROUBLESHOOTING288959
|
||||
Ref: #troubleshooting289074
|
||||
Node: OPTIONS2449
|
||||
Ref: #options2550
|
||||
Node: General options2692
|
||||
Ref: #general-options2817
|
||||
Node: Command options6386
|
||||
Ref: #command-options6537
|
||||
Node: Command arguments6936
|
||||
Ref: #command-arguments7094
|
||||
Node: Special characters7972
|
||||
Ref: #special-characters8135
|
||||
Node: Single escaping shell metacharacters8298
|
||||
Ref: #single-escaping-shell-metacharacters8539
|
||||
Node: Double escaping regular expression metacharacters8941
|
||||
Ref: #double-escaping-regular-expression-metacharacters9252
|
||||
Node: Triple escaping for add-on commands9778
|
||||
Ref: #triple-escaping-for-add-on-commands10038
|
||||
Node: Less escaping10684
|
||||
Ref: #less-escaping10838
|
||||
Node: Unicode characters11164
|
||||
Ref: #unicode-characters11329
|
||||
Node: Regular expressions12738
|
||||
Ref: #regular-expressions12878
|
||||
Node: ENVIRONMENT14619
|
||||
Ref: #environment14735
|
||||
Node: DATA FILES15717
|
||||
Ref: #data-files15836
|
||||
Node: Data formats16377
|
||||
Ref: #data-formats16495
|
||||
Node: Multiple files17977
|
||||
Ref: #multiple-files18119
|
||||
Node: Strict mode18589
|
||||
Ref: #strict-mode18704
|
||||
Node: TIME PERIODS19354
|
||||
Ref: #time-periods19471
|
||||
Node: Smart dates19569
|
||||
Ref: #smart-dates19695
|
||||
Node: Report start & end date20999
|
||||
Ref: #report-start-end-date21174
|
||||
Node: Report intervals22718
|
||||
Ref: #report-intervals22886
|
||||
Node: Period expressions23274
|
||||
Ref: #period-expressions23414
|
||||
Node: DEPTH27793
|
||||
Ref: #depth27893
|
||||
Node: QUERIES28224
|
||||
Ref: #queries28323
|
||||
Node: COSTING32275
|
||||
Ref: #costing32378
|
||||
Node: VALUATION32651
|
||||
Ref: #valuation32759
|
||||
Node: -V Value33482
|
||||
Ref: #v-value33606
|
||||
Node: -X Value in specified commodity33800
|
||||
Ref: #x-value-in-specified-commodity33993
|
||||
Node: Valuation date34142
|
||||
Ref: #valuation-date34304
|
||||
Node: Market prices34741
|
||||
Ref: #market-prices34922
|
||||
Node: --infer-market-price market prices from transactions36104
|
||||
Ref: #infer-market-price-market-prices-from-transactions36368
|
||||
Node: Valuation commodity37717
|
||||
Ref: #valuation-commodity37927
|
||||
Node: Simple valuation examples39152
|
||||
Ref: #simple-valuation-examples39348
|
||||
Node: --value Flexible valuation40010
|
||||
Ref: #value-flexible-valuation40212
|
||||
Node: More valuation examples41854
|
||||
Ref: #more-valuation-examples42055
|
||||
Node: Effect of valuation on reports44061
|
||||
Ref: #effect-of-valuation-on-reports44243
|
||||
Node: PIVOTING52140
|
||||
Ref: #pivoting52245
|
||||
Node: OUTPUT53924
|
||||
Ref: #output54026
|
||||
Node: Output destination54077
|
||||
Ref: #output-destination54210
|
||||
Node: Output format54635
|
||||
Ref: #output-format54758
|
||||
Node: COMMANDS56921
|
||||
Ref: #commands57033
|
||||
Node: accounts60423
|
||||
Ref: #accounts60523
|
||||
Node: activity61215
|
||||
Ref: #activity61327
|
||||
Node: add61709
|
||||
Ref: #add61812
|
||||
Node: aregister64607
|
||||
Ref: #aregister64721
|
||||
Node: aregister and custom posting dates66916
|
||||
Ref: #aregister-and-custom-posting-dates67082
|
||||
Node: balance67903
|
||||
Ref: #balance68022
|
||||
Node: balance features68935
|
||||
Ref: #balance-features69075
|
||||
Node: Simple balance report70745
|
||||
Ref: #simple-balance-report70927
|
||||
Node: Filtered balance report72375
|
||||
Ref: #filtered-balance-report72562
|
||||
Node: List or tree mode72859
|
||||
Ref: #list-or-tree-mode73027
|
||||
Node: Depth limiting74344
|
||||
Ref: #depth-limiting74510
|
||||
Node: Multi-period balance report75268
|
||||
Ref: #multi-period-balance-report75460
|
||||
Node: Sorting by amount77716
|
||||
Ref: #sorting-by-amount77885
|
||||
Node: Percentages78347
|
||||
Ref: #percentages78503
|
||||
Node: Balance change end balance79435
|
||||
Ref: #balance-change-end-balance79626
|
||||
Node: Balance report types81050
|
||||
Ref: #balance-report-types81240
|
||||
Node: Useful balance reports85404
|
||||
Ref: #useful-balance-reports85585
|
||||
Node: Budget report86669
|
||||
Ref: #budget-report86853
|
||||
Node: Budget report start date92022
|
||||
Ref: #budget-report-start-date92191
|
||||
Node: Nested budgets93518
|
||||
Ref: #nested-budgets93667
|
||||
Node: Customising single-period balance reports97054
|
||||
Ref: #customising-single-period-balance-reports97263
|
||||
Node: balancesheet99420
|
||||
Ref: #balancesheet99558
|
||||
Node: balancesheetequity100856
|
||||
Ref: #balancesheetequity101007
|
||||
Node: cashflow102387
|
||||
Ref: #cashflow102511
|
||||
Node: check103657
|
||||
Ref: #check103762
|
||||
Node: Basic checks104395
|
||||
Ref: #basic-checks104513
|
||||
Node: Strict checks105046
|
||||
Ref: #strict-checks105187
|
||||
Node: Other checks105491
|
||||
Ref: #other-checks105631
|
||||
Node: Custom checks105984
|
||||
Ref: #custom-checks106104
|
||||
Node: close106522
|
||||
Ref: #close106626
|
||||
Node: close usage108143
|
||||
Ref: #close-usage108238
|
||||
Node: codes111046
|
||||
Ref: #codes111156
|
||||
Node: commodities111869
|
||||
Ref: #commodities111998
|
||||
Node: descriptions112080
|
||||
Ref: #descriptions112210
|
||||
Node: diff112514
|
||||
Ref: #diff112622
|
||||
Node: files113667
|
||||
Ref: #files113769
|
||||
Node: help113915
|
||||
Ref: #help114017
|
||||
Node: import114740
|
||||
Ref: #import114856
|
||||
Node: Deduplication115718
|
||||
Ref: #deduplication115843
|
||||
Node: Import testing117731
|
||||
Ref: #import-testing117896
|
||||
Node: Importing balance assignments118386
|
||||
Ref: #importing-balance-assignments118592
|
||||
Node: Commodity display styles119239
|
||||
Ref: #commodity-display-styles119412
|
||||
Node: incomestatement119541
|
||||
Ref: #incomestatement119676
|
||||
Node: notes120977
|
||||
Ref: #notes121092
|
||||
Node: payees121459
|
||||
Ref: #payees121567
|
||||
Node: prices122093
|
||||
Ref: #prices122201
|
||||
Node: print122540
|
||||
Ref: #print122652
|
||||
Node: print-unique127962
|
||||
Ref: #print-unique128090
|
||||
Node: register128376
|
||||
Ref: #register128505
|
||||
Node: Custom register output132949
|
||||
Ref: #custom-register-output133080
|
||||
Node: register-match134417
|
||||
Ref: #register-match134553
|
||||
Node: rewrite134901
|
||||
Ref: #rewrite135018
|
||||
Node: Re-write rules in a file136924
|
||||
Ref: #re-write-rules-in-a-file137087
|
||||
Node: Diff output format138237
|
||||
Ref: #diff-output-format138420
|
||||
Node: rewrite vs print --auto139512
|
||||
Ref: #rewrite-vs.-print---auto139672
|
||||
Node: roi140222
|
||||
Ref: #roi140322
|
||||
Node: Semantics of --inv and --pnl141957
|
||||
Ref: #semantics-of---inv-and---pnl142139
|
||||
Node: IRR and TWR explained143985
|
||||
Ref: #irr-and-twr-explained144145
|
||||
Node: stats147207
|
||||
Ref: #stats147308
|
||||
Node: tags148095
|
||||
Ref: #tags148195
|
||||
Node: test148712
|
||||
Ref: #test148828
|
||||
Node: About add-on commands149573
|
||||
Ref: #about-add-on-commands149710
|
||||
Node: JOURNAL FORMAT150843
|
||||
Ref: #journal-format150971
|
||||
Node: Transactions153151
|
||||
Ref: #transactions153266
|
||||
Node: Dates154283
|
||||
Ref: #dates154399
|
||||
Node: Simple dates154464
|
||||
Ref: #simple-dates154584
|
||||
Node: Secondary dates155091
|
||||
Ref: #secondary-dates155239
|
||||
Node: Posting dates156573
|
||||
Ref: #posting-dates156696
|
||||
Node: Status158065
|
||||
Ref: #status158182
|
||||
Node: Description159887
|
||||
Ref: #description160017
|
||||
Node: Payee and note160335
|
||||
Ref: #payee-and-note160443
|
||||
Node: Comments160777
|
||||
Ref: #comments160899
|
||||
Node: Tags162092
|
||||
Ref: #tags-1162203
|
||||
Node: Postings163601
|
||||
Ref: #postings163725
|
||||
Node: Virtual postings164749
|
||||
Ref: #virtual-postings164860
|
||||
Node: Account names166162
|
||||
Ref: #account-names166299
|
||||
Node: Amounts166785
|
||||
Ref: #amounts166920
|
||||
Node: Decimal marks digit group marks167979
|
||||
Ref: #decimal-marks-digit-group-marks168168
|
||||
Node: Commodity display style169515
|
||||
Ref: #commodity-display-style169703
|
||||
Node: Rounding171729
|
||||
Ref: #rounding171847
|
||||
Node: Transaction prices172257
|
||||
Ref: #transaction-prices172423
|
||||
Node: Lot prices lot dates174853
|
||||
Ref: #lot-prices-lot-dates175036
|
||||
Node: Balance assertions175523
|
||||
Ref: #balance-assertions175701
|
||||
Node: Assertions and ordering176731
|
||||
Ref: #assertions-and-ordering176913
|
||||
Node: Assertions and included files177610
|
||||
Ref: #assertions-and-included-files177847
|
||||
Node: Assertions and multiple -f options178178
|
||||
Ref: #assertions-and-multiple--f-options178428
|
||||
Node: Assertions and commodities178559
|
||||
Ref: #assertions-and-commodities178785
|
||||
Node: Assertions and prices179940
|
||||
Ref: #assertions-and-prices180148
|
||||
Node: Assertions and subaccounts180589
|
||||
Ref: #assertions-and-subaccounts180812
|
||||
Node: Assertions and virtual postings181136
|
||||
Ref: #assertions-and-virtual-postings181372
|
||||
Node: Assertions and precision181513
|
||||
Ref: #assertions-and-precision181700
|
||||
Node: Balance assignments181965
|
||||
Ref: #balance-assignments182135
|
||||
Node: Balance assignments and prices183298
|
||||
Ref: #balance-assignments-and-prices183464
|
||||
Node: Directives183690
|
||||
Ref: #directives183853
|
||||
Node: Directives and multiple files189258
|
||||
Ref: #directives-and-multiple-files189454
|
||||
Node: Comment blocks190116
|
||||
Ref: #comment-blocks190293
|
||||
Node: Including other files190468
|
||||
Ref: #including-other-files190642
|
||||
Node: Default year191566
|
||||
Ref: #default-year191724
|
||||
Node: Declaring payees192131
|
||||
Ref: #declaring-payees192297
|
||||
Node: Declaring commodities192542
|
||||
Ref: #declaring-commodities192723
|
||||
Node: Commodity error checking194564
|
||||
Ref: #commodity-error-checking194714
|
||||
Node: Default commodity194970
|
||||
Ref: #default-commodity195150
|
||||
Node: Declaring market prices196035
|
||||
Ref: #declaring-market-prices196224
|
||||
Node: Declaring accounts197082
|
||||
Ref: #declaring-accounts197262
|
||||
Node: Account error checking198469
|
||||
Ref: #account-error-checking198635
|
||||
Node: Account comments199812
|
||||
Ref: #account-comments199996
|
||||
Node: Account subdirectives200422
|
||||
Ref: #account-subdirectives200607
|
||||
Node: Account types200922
|
||||
Ref: #account-types201096
|
||||
Node: Declaring account types201831
|
||||
Ref: #declaring-account-types202010
|
||||
Node: Auto-detected account types202661
|
||||
Ref: #auto-detected-account-types202902
|
||||
Node: Interference from auto-detected account types203801
|
||||
Ref: #interference-from-auto-detected-account-types204078
|
||||
Node: Old account type syntax204561
|
||||
Ref: #old-account-type-syntax204758
|
||||
Node: Account display order205059
|
||||
Ref: #account-display-order205219
|
||||
Node: Rewriting accounts206370
|
||||
Ref: #rewriting-accounts206549
|
||||
Node: Basic aliases207308
|
||||
Ref: #basic-aliases207444
|
||||
Node: Regex aliases208146
|
||||
Ref: #regex-aliases208308
|
||||
Node: Combining aliases209028
|
||||
Ref: #combining-aliases209211
|
||||
Node: Aliases and multiple files210488
|
||||
Ref: #aliases-and-multiple-files210687
|
||||
Node: end aliases211268
|
||||
Ref: #end-aliases211415
|
||||
Node: Default parent account211517
|
||||
Ref: #default-parent-account211707
|
||||
Node: Periodic transactions212591
|
||||
Ref: #periodic-transactions212774
|
||||
Node: Periodic rule syntax214691
|
||||
Ref: #periodic-rule-syntax214891
|
||||
Node: Two spaces between period expression and description!215594
|
||||
Ref: #two-spaces-between-period-expression-and-description215907
|
||||
Node: Forecasting with periodic transactions216592
|
||||
Ref: #forecasting-with-periodic-transactions216891
|
||||
Node: Budgeting with periodic transactions218937
|
||||
Ref: #budgeting-with-periodic-transactions219170
|
||||
Node: Auto postings219577
|
||||
Ref: #auto-postings219713
|
||||
Node: Auto postings and multiple files221896
|
||||
Ref: #auto-postings-and-multiple-files222094
|
||||
Node: Auto postings and dates222302
|
||||
Ref: #auto-postings-and-dates222570
|
||||
Node: Auto postings and transaction balancing / inferred amounts / balance assertions222745
|
||||
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions223091
|
||||
Node: Auto posting tags223436
|
||||
Ref: #auto-posting-tags223645
|
||||
Node: CSV FORMAT224282
|
||||
Ref: #csv-format224410
|
||||
Node: Examples226991
|
||||
Ref: #examples227094
|
||||
Node: Basic227301
|
||||
Ref: #basic227403
|
||||
Node: Bank of Ireland227947
|
||||
Ref: #bank-of-ireland228084
|
||||
Node: Amazon229549
|
||||
Ref: #amazon229669
|
||||
Node: Paypal231390
|
||||
Ref: #paypal231486
|
||||
Node: CSV rules239134
|
||||
Ref: #csv-rules239252
|
||||
Node: skip239564
|
||||
Ref: #skip239659
|
||||
Node: fields240031
|
||||
Ref: #fields240155
|
||||
Node: Transaction field names241316
|
||||
Ref: #transaction-field-names241478
|
||||
Node: Posting field names241589
|
||||
Ref: #posting-field-names241743
|
||||
Node: field assignment244104
|
||||
Ref: #field-assignment244249
|
||||
Node: separator245063
|
||||
Ref: #separator245200
|
||||
Node: if block245742
|
||||
Ref: #if-block245869
|
||||
Node: Matching the whole record246267
|
||||
Ref: #matching-the-whole-record246444
|
||||
Node: Matching individual fields247248
|
||||
Ref: #matching-individual-fields247454
|
||||
Node: Combining matchers247678
|
||||
Ref: #combining-matchers247876
|
||||
Node: Rules applied on successful match248190
|
||||
Ref: #rules-applied-on-successful-match248383
|
||||
Node: if table249040
|
||||
Ref: #if-table249161
|
||||
Node: end250897
|
||||
Ref: #end251011
|
||||
Node: date-format251235
|
||||
Ref: #date-format251369
|
||||
Node: decimal-mark252119
|
||||
Ref: #decimal-mark252264
|
||||
Node: newest-first252601
|
||||
Ref: #newest-first252744
|
||||
Node: include253427
|
||||
Ref: #include253560
|
||||
Node: balance-type254002
|
||||
Ref: #balance-type254124
|
||||
Node: Tips254824
|
||||
Ref: #tips254915
|
||||
Node: Rapid feedback255214
|
||||
Ref: #rapid-feedback255333
|
||||
Node: Valid CSV255792
|
||||
Ref: #valid-csv255924
|
||||
Node: File Extension256116
|
||||
Ref: #file-extension256270
|
||||
Node: Reading multiple CSV files256699
|
||||
Ref: #reading-multiple-csv-files256886
|
||||
Node: Valid transactions257126
|
||||
Ref: #valid-transactions257306
|
||||
Node: Deduplicating importing257934
|
||||
Ref: #deduplicating-importing258115
|
||||
Node: Setting amounts259147
|
||||
Ref: #setting-amounts259304
|
||||
Node: Amount signs261523
|
||||
Ref: #amount-signs261677
|
||||
Node: Setting currency/commodity262364
|
||||
Ref: #setting-currencycommodity262552
|
||||
Node: Amount decimal places263732
|
||||
Ref: #amount-decimal-places263924
|
||||
Node: Referencing other fields264236
|
||||
Ref: #referencing-other-fields264435
|
||||
Node: How CSV rules are evaluated265333
|
||||
Ref: #how-csv-rules-are-evaluated265508
|
||||
Node: TIMECLOCK FORMAT266957
|
||||
Ref: #timeclock-format267097
|
||||
Node: TIMEDOT FORMAT269165
|
||||
Ref: #timedot-format269303
|
||||
Node: COMMON TASKS273566
|
||||
Ref: #common-tasks273695
|
||||
Node: Getting help274102
|
||||
Ref: #getting-help274236
|
||||
Node: Constructing command lines274787
|
||||
Ref: #constructing-command-lines274981
|
||||
Node: Starting a journal file275680
|
||||
Ref: #starting-a-journal-file275880
|
||||
Node: Setting opening balances277067
|
||||
Ref: #setting-opening-balances277265
|
||||
Node: Recording transactions280398
|
||||
Ref: #recording-transactions280580
|
||||
Node: Reconciling281137
|
||||
Ref: #reconciling281282
|
||||
Node: Reporting283527
|
||||
Ref: #reporting283669
|
||||
Node: Migrating to a new file287589
|
||||
Ref: #migrating-to-a-new-file287739
|
||||
Node: LIMITATIONS288037
|
||||
Ref: #limitations288165
|
||||
Node: TROUBLESHOOTING288906
|
||||
Ref: #troubleshooting289021
|
||||
|
||||
End Tag Table
|
||||
|
@ -6,7 +6,7 @@ HLEDGER(1) hledger User Manuals HLEDGER(1)
|
||||
NAME
|
||||
This is the command-line interface (CLI) for the hledger accounting
|
||||
tool. Here we also describe hledger's concepts and file formats. This
|
||||
manual is for hledger 1.21.
|
||||
manual is for hledger 1.21.99.
|
||||
|
||||
SYNOPSIS
|
||||
hledger
|
||||
@ -606,6 +606,7 @@ TIME PERIODS
|
||||
|
||||
|
||||
-p "1/1 4/1"
|
||||
|
||||
-p "january-apr"
|
||||
-p "this year to 4/1"
|
||||
|
||||
@ -626,9 +627,6 @@ TIME PERIODS
|
||||
|
||||
-p "2009" the year 2009; equivalent
|
||||
to "2009/1/1 to 2010/1/1"
|
||||
|
||||
|
||||
|
||||
-p "2009/1" the month of jan; equiva-
|
||||
lent to "2009/1/1 to
|
||||
2009/2/1"
|
||||
@ -699,7 +697,6 @@ TIME PERIODS
|
||||
Examples:
|
||||
|
||||
|
||||
|
||||
-p "every 2nd day of periods will go from Tue to Tue
|
||||
week"
|
||||
-p "every Tue" same
|
||||
@ -1165,6 +1162,8 @@ VALUATION
|
||||
posting cost value at value at posting value at value at
|
||||
amounts report end date report or DATE/today
|
||||
or today journal end
|
||||
|
||||
|
||||
summary post- summarised value at sum of postings value at value at
|
||||
ing amounts cost period ends in interval, val- period ends DATE/today
|
||||
with report ued at interval
|
||||
@ -1202,13 +1201,6 @@ VALUATION
|
||||
is, bs postings in period at respec- each period, sums of post-
|
||||
--change, cf period tive posting valued at ings
|
||||
--change) dates period ends
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
end balances sums of same as sums of values of period end value at
|
||||
(bal -H, is costs of --value=end postings from balances, DATE/today of
|
||||
--H, bs, cf) postings before period valued at sums of post-
|
||||
@ -4350,6 +4342,9 @@ JOURNAL FORMAT
|
||||
tive directive rec- 2018/06)
|
||||
tives
|
||||
------------------------------------------------------------------------------------
|
||||
|
||||
|
||||
|
||||
account any document account names, all entries in all
|
||||
text declare account types & dis- files, before or
|
||||
play order after
|
||||
@ -4387,7 +4382,6 @@ JOURNAL FORMAT
|
||||
reports
|
||||
include include entries/directives what the included
|
||||
from another file directives affect
|
||||
|
||||
[payee] declare a payee name following entries
|
||||
until end of cur-
|
||||
rent file
|
||||
@ -4738,6 +4732,7 @@ JOURNAL FORMAT
|
||||
If account type is Asset and name does not contain regu- account type
|
||||
lar expression: is:
|
||||
--------------------------------------------------------------------------
|
||||
|
||||
(investment|receivable|:A/R|:fixed) Cash
|
||||
|
||||
Even so, explicit declarations may be a good idea, for clarity and pre-
|
||||
@ -6862,4 +6857,4 @@ SEE ALSO
|
||||
|
||||
|
||||
|
||||
hledger-1.21 December 2020 HLEDGER(1)
|
||||
hledger-1.21.99 March 2021 HLEDGER(1)
|
||||
|
Loading…
Reference in New Issue
Block a user