From 80eb46106373d77832c76413e8c165c3f6c9eac3 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Thu, 3 Nov 2022 08:31:47 -1000 Subject: [PATCH] ;doc: update manuals --- hledger-lib/.date.m4 | 2 +- hledger-ui/.date.m4 | 2 +- hledger-ui/hledger-ui.1 | 2 +- hledger-ui/hledger-ui.txt | 2 +- hledger-web/.date.m4 | 2 +- hledger-web/hledger-web.1 | 53 +- hledger-web/hledger-web.info | 83 +- hledger-web/hledger-web.txt | 186 +-- hledger/.date.m4 | 2 +- hledger/hledger.1 | 639 ++++---- hledger/hledger.info | 1686 ++++++++++---------- hledger/hledger.txt | 2859 +++++++++++++++++----------------- 12 files changed, 2862 insertions(+), 2656 deletions(-) diff --git a/hledger-lib/.date.m4 b/hledger-lib/.date.m4 index b7f3131e4..f4bc2db3f 100644 --- a/hledger-lib/.date.m4 +++ b/hledger-lib/.date.m4 @@ -1,2 +1,2 @@ m4_dnl Date to show in man pages. Updated by "Shake manuals" -m4_define({{_monthyear_}}, {{October 2022}})m4_dnl +m4_define({{_monthyear_}}, {{November 2022}})m4_dnl diff --git a/hledger-ui/.date.m4 b/hledger-ui/.date.m4 index b7f3131e4..f4bc2db3f 100644 --- a/hledger-ui/.date.m4 +++ b/hledger-ui/.date.m4 @@ -1,2 +1,2 @@ m4_dnl Date to show in man pages. Updated by "Shake manuals" -m4_define({{_monthyear_}}, {{October 2022}})m4_dnl +m4_define({{_monthyear_}}, {{November 2022}})m4_dnl diff --git a/hledger-ui/hledger-ui.1 b/hledger-ui/hledger-ui.1 index 8c84c1308..10bfd09e1 100644 --- a/hledger-ui/hledger-ui.1 +++ b/hledger-ui/hledger-ui.1 @@ -1,5 +1,5 @@ -.TH "HLEDGER-UI" "1" "October 2022" "hledger-ui-1.27.99 " "hledger User Manuals" +.TH "HLEDGER-UI" "1" "November 2022" "hledger-ui-1.27.99 " "hledger User Manuals" diff --git a/hledger-ui/hledger-ui.txt b/hledger-ui/hledger-ui.txt index 38bf4249a..527f55c23 100644 --- a/hledger-ui/hledger-ui.txt +++ b/hledger-ui/hledger-ui.txt @@ -574,4 +574,4 @@ SEE ALSO -hledger-ui-1.27.99 October 2022 HLEDGER-UI(1) +hledger-ui-1.27.99 November 2022 HLEDGER-UI(1) diff --git a/hledger-web/.date.m4 b/hledger-web/.date.m4 index b7f3131e4..f4bc2db3f 100644 --- a/hledger-web/.date.m4 +++ b/hledger-web/.date.m4 @@ -1,2 +1,2 @@ m4_dnl Date to show in man pages. Updated by "Shake manuals" -m4_define({{_monthyear_}}, {{October 2022}})m4_dnl +m4_define({{_monthyear_}}, {{November 2022}})m4_dnl diff --git a/hledger-web/hledger-web.1 b/hledger-web/hledger-web.1 index 983d78932..6640c373c 100644 --- a/hledger-web/hledger-web.1 +++ b/hledger-web/hledger-web.1 @@ -1,5 +1,5 @@ -.TH "HLEDGER-WEB" "1" "October 2022" "hledger-web-1.27.99 " "hledger User Manuals" +.TH "HLEDGER-WEB" "1" "November 2022" "hledger-web-1.27.99 " "hledger User Manuals" @@ -9,11 +9,18 @@ hledger-web is a web interface (WUI) for the hledger accounting tool. This manual is for hledger-web 1.27.99. .SH SYNOPSIS .PP -\f[C]hledger-web [OPTIONS]\f[R] +\f[C]hledger-web [OPTIONS] # run temporarily & browse\f[R] +.PD 0 +.P +.PD +\f[C]hledger-web --serve [OPTIONS] # run without stopping\f[R] +.PD 0 +.P +.PD +\f[C]hledger-web --serve-api [OPTIONS] # run JSON server only\f[R] .PD 0 .P .PD -\f[C]hledger web -- [OPTIONS]\f[R] .SH DESCRIPTION .PP hledger is a reliable, cross-platform set of programs for tracking @@ -21,27 +28,41 @@ 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. +hledger-web is a simple web application for browsing and adding +transactions. It provides a more user-friendly UI than the hledger CLI or hledger-ui -interface, showing more at once (accounts, the current account register, +TUI, 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 +hledger-web also lets you share a journal 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. +instance, it writes a numbered backup of the main journal file (only) on +every edit. .PP 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). +.PP +hledger-web can be run in three modes: +.IP \[bu] 2 +Transient mode (the default): your default web browser will be opened to +show the app if possible, and the app exits automatically after two +minutes of inactivity (no requests received and no open browser windows +viewing it). +.IP \[bu] 2 +With \f[C]--serve\f[R]: the app runs without stopping, and without +opening a browser. +.IP \[bu] 2 +With \f[C]--serve-api\f[R]: only the JSON API is served. +.PP +In all cases hledger-web runs as a foreground process, logging requests +to stdout. .SH OPTIONS .PP Command-line options and arguments may be used to set an initial filter @@ -53,7 +74,7 @@ Note: if invoking hledger-web as a hledger subcommand, write \f[C]--\f[R] before options, as shown in the synopsis above. .TP \f[B]\f[CB]--serve\f[B]\f[R] -serve and log requests, don\[aq]t browse or auto-exit +serve and log requests, don\[aq]t browse or auto-exit after timeout .TP \f[B]\f[CB]--serve-api\f[B]\f[R] like --serve, but serve only the JSON web API, without the server-side @@ -249,16 +270,6 @@ A \[at]FILE argument will be expanded to the contents of FILE, which should contain one command line option/argument per line. (To prevent this, insert a \f[C]--\f[R] argument before.) .PP -By default, hledger-web starts the web app in \[dq]transient mode\[dq] -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). -With \f[C]--serve\f[R], it just runs the web app without exiting, and -logs requests to the console. -With \f[C]--serve-api\f[R], only the JSON web api (see below) is served, -with the usual HTML server-side web UI disabled. -.PP By default the server listens on IP address 127.0.0.1, accessible only to local requests. You can use \f[C]--host\f[R] to change this, eg \f[C]--host 0.0.0.0\f[R] diff --git a/hledger-web/hledger-web.info b/hledger-web/hledger-web.info index 2562281aa..50e785174 100644 --- a/hledger-web/hledger-web.info +++ b/hledger-web/hledger-web.info @@ -14,33 +14,47 @@ hledger-web(1) hledger-web is a web interface (WUI) for the hledger accounting tool. This manual is for hledger-web 1.27.99. - 'hledger-web [OPTIONS]' -'hledger web -- [OPTIONS]' + 'hledger-web [OPTIONS] # run temporarily & browse' +'hledger-web --serve [OPTIONS] # run without stopping' +'hledger-web --serve-api [OPTIONS] # run JSON server only' 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 -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. + hledger-web is a simple web application for browsing and adding +transactions. It provides a more user-friendly UI than the hledger CLI +or hledger-ui TUI, 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 + hledger-web also lets you share a journal 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. +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). + hledger-web can be run in three modes: + + * Transient mode (the default): your default web browser will be + opened to show the app if possible, and the app exits automatically + after two minutes of inactivity (no requests received and no open + browser windows viewing it). + + * With '--serve': the app runs without stopping, and without opening + a browser. + + * With '--serve-api': only the JSON API is served. + + In all cases hledger-web runs as a foreground process, logging +requests to stdout. + * Menu: * OPTIONS:: @@ -67,7 +81,7 @@ before options, as shown in the synopsis above. '--serve' - serve and log requests, don't browse or auto-exit + serve and log requests, don't browse or auto-exit after timeout '--serve-api' like -serve, but serve only the JSON web API, without the @@ -264,15 +278,6 @@ the last one takes precedence. should 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 -window, 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 0.0.0.0' to listen on all configured addresses. @@ -632,22 +637,22 @@ awkward.  Tag Table: Node: Top223 -Node: OPTIONS1889 -Ref: #options1994 -Node: PERMISSIONS9905 -Ref: #permissions10044 -Node: EDITING UPLOADING DOWNLOADING11256 -Ref: #editing-uploading-downloading11437 -Node: RELOADING12271 -Ref: #reloading12405 -Node: JSON API12838 -Ref: #json-api12952 -Node: ENVIRONMENT18442 -Ref: #environment18558 -Node: FILES19869 -Ref: #files19969 -Node: BUGS20182 -Ref: #bugs20260 +Node: OPTIONS2419 +Ref: #options2524 +Node: PERMISSIONS9923 +Ref: #permissions10062 +Node: EDITING UPLOADING DOWNLOADING11274 +Ref: #editing-uploading-downloading11455 +Node: RELOADING12289 +Ref: #reloading12423 +Node: JSON API12856 +Ref: #json-api12970 +Node: ENVIRONMENT18460 +Ref: #environment18576 +Node: FILES19887 +Ref: #files19987 +Node: BUGS20200 +Ref: #bugs20278  End Tag Table diff --git a/hledger-web/hledger-web.txt b/hledger-web/hledger-web.txt index de059699b..ce73b477d 100644 --- a/hledger-web/hledger-web.txt +++ b/hledger-web/hledger-web.txt @@ -8,8 +8,9 @@ NAME This manual is for hledger-web 1.27.99. SYNOPSIS - hledger-web [OPTIONS] - hledger web -- [OPTIONS] + hledger-web [OPTIONS] # run temporarily & browse + hledger-web --serve [OPTIONS] # run without stopping + hledger-web --serve-api [OPTIONS] # run JSON server only DESCRIPTION hledger is a reliable, cross-platform set of programs for tracking @@ -17,24 +18,38 @@ DESCRIPTION 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- - 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 - history-aware data entry, interactive searching, and bookmarking. + hledger-web is a simple web application for browsing and adding trans- + actions. It provides a more user-friendly UI than the hledger CLI or + hledger-ui TUI, showing more at once (accounts, the current account + register, balance charts) and allowing history-aware data entry, inter- + active 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 - numbered backup of the main journal file (only ?) on every edit. + hledger-web also lets you share a journal 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 + 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-web can be run in three modes: + + o Transient mode (the default): your default web browser will be opened + to show the app if possible, and the app exits automatically after + two minutes of inactivity (no requests received and no open browser + windows viewing it). + + o With --serve: the app runs without stopping, and without opening a + browser. + + o With --serve-api: only the JSON API is served. + + In all cases hledger-web runs as a foreground process, logging requests + to stdout. + 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 @@ -44,7 +59,7 @@ OPTIONS options, as shown in the synopsis above. --serve - serve and log requests, don't browse or auto-exit + serve and log requests, don't browse or auto-exit after timeout --serve-api like --serve, but serve only the JSON web API, without the @@ -234,51 +249,42 @@ OPTIONS 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 - 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 @@ -288,53 +294,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 @@ -351,7 +357,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 @@ -392,25 +398,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 @@ -506,7 +512,7 @@ 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 @@ -516,17 +522,17 @@ ENVIRONMENT On unix computers, the default value is: ~/.hledger.journal. - A more typical value is something like ~/finance/YYYY.journal, where - ~/finance is a version-controlled finance directory and YYYY is the - current year. Or, ~/finance/current.journal, where current.journal is + A more typical value is something like ~/finance/YYYY.journal, where + ~/finance is a version-controlled finance directory and YYYY is the + current year. Or, ~/finance/current.journal, where current.journal is a symbolic link to YYYY.journal. - The usual way to set this permanently is to add a command to one of + The usual way to set this permanently is to add a command to one of your shell's startup files (eg ~/.profile): export LEDGER_FILE=~/finance/current.journal` - On some Mac computers, there is a more thorough way to set environment + On some Mac computers, there is a more thorough way to set environment variables, that will also affect applications started from the GUI (eg, Emacs started from a dock icon): In ~/.MacOSX/environment.plist, add an entry like: @@ -537,24 +543,24 @@ ENVIRONMENT For this to take effect you might need to killall Dock, or reboot. - On Windows computers, the default value is probably C:\Users\YOUR- - NAME\.hledger.journal. You can change this by running a command like - this in a powershell window (let us know if you need to be an Adminis- + On Windows computers, the default value is probably C:\Users\YOUR- + NAME\.hledger.journal. You can change this by running a command like + this in a powershell window (let us know if you need to be an Adminis- trator, and if this persists across a reboot): > setx LEDGER_FILE "C:\Users\MyUserName\finance\2021.journal" - Or, change it in settings: see https://www.java.com/en/down- + Or, change it in settings: see https://www.java.com/en/down- load/help/path.html. 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). @@ -568,7 +574,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) @@ -586,4 +592,4 @@ SEE ALSO -hledger-web-1.27.99 October 2022 HLEDGER-WEB(1) +hledger-web-1.27.99 November 2022 HLEDGER-WEB(1) diff --git a/hledger/.date.m4 b/hledger/.date.m4 index b7f3131e4..f4bc2db3f 100644 --- a/hledger/.date.m4 +++ b/hledger/.date.m4 @@ -1,2 +1,2 @@ m4_dnl Date to show in man pages. Updated by "Shake manuals" -m4_define({{_monthyear_}}, {{October 2022}})m4_dnl +m4_define({{_monthyear_}}, {{November 2022}})m4_dnl diff --git a/hledger/hledger.1 b/hledger/hledger.1 index 70173610f..5001a2ab0 100644 --- a/hledger/hledger.1 +++ b/hledger/hledger.1 @@ -1,6 +1,6 @@ .\"t -.TH "HLEDGER" "1" "October 2022" "hledger-1.27.99 " "hledger User Manuals" +.TH "HLEDGER" "1" "November 2022" "hledger-1.27.99 " "hledger User Manuals" @@ -563,7 +563,7 @@ Default: the full terminal width. \f[B]NO_COLOR\f[R] If this variable exists with any value, hledger will not use ANSI color codes in terminal output. This is overriden by the --color/--colour option. -.SH DATA FILES +.SH INPUT .PP hledger reads transactions from one or more data files. The default data file is \f[C]$HOME/.hledger.journal\f[R] (or on @@ -710,6 +710,283 @@ Are all commodity conversions declared explicitly ? .PP You can use the check command to run individual checks -- the ones listed above and some more. +.SH OUTPUT +.PP +Some of this section may refer to things explained further below. +.SS Output destination +.PP +hledger commands send their output to the terminal by default. +You can of course redirect this, eg into a file, using standard shell +syntax: +.IP +.nf +\f[C] +$ hledger print > foo.txt +\f[R] +.fi +.PP +Some commands (print, register, stats, the balance commands) also +provide the \f[C]-o/--output-file\f[R] option, which does the same thing +without needing the shell. +Eg: +.IP +.nf +\f[C] +$ hledger print -o foo.txt +$ hledger print -o - # write to stdout (the default) +\f[R] +.fi +.SS Output styling +.PP +hledger commands can produce colour output when the terminal supports +it. +This is controlled by the \f[C]--color/--colour\f[R] option: - if the +\f[C]--color/--colour\f[R] option is given a value of \f[C]yes\f[R] or +\f[C]always\f[R] (or \f[C]no\f[R] or \f[C]never\f[R]), colour will (or +will not) be used; - otherwise, if the \f[C]NO_COLOR\f[R] environment +variable is set, colour will not be used; - otherwise, colour will be +used if the output (terminal or file) supports it. +.PP +hledger commands can also use unicode box-drawing characters to produce +prettier tables and output. +This is controlled by the \f[C]--pretty\f[R] option: - if the +\f[C]--pretty\f[R] option is given a value of \f[C]yes\f[R] or +\f[C]always\f[R] (or \f[C]no\f[R] or \f[C]never\f[R]), unicode +characters will (or will not) be used; - otherwise, unicode characters +will not be used. +.SS Output format +.PP +Some commands offer additional output formats, other than the usual +plain text terminal output. +Here are those commands and the formats currently supported: +.PP +.TS +tab(@); +l l l l l l. +T{ +- +T}@T{ +txt +T}@T{ +csv +T}@T{ +html +T}@T{ +json +T}@T{ +sql +T} +_ +T{ +aregister +T}@T{ +Y +T}@T{ +Y +T}@T{ +T}@T{ +Y +T}@T{ +T} +T{ +balance +T}@T{ +Y \f[I]1\f[R] +T}@T{ +Y \f[I]1\f[R] +T}@T{ +Y \f[I]1,2\f[R] +T}@T{ +Y +T}@T{ +T} +T{ +balancesheet +T}@T{ +Y \f[I]1\f[R] +T}@T{ +Y \f[I]1\f[R] +T}@T{ +Y \f[I]1\f[R] +T}@T{ +Y +T}@T{ +T} +T{ +balancesheetequity +T}@T{ +Y \f[I]1\f[R] +T}@T{ +Y \f[I]1\f[R] +T}@T{ +Y \f[I]1\f[R] +T}@T{ +Y +T}@T{ +T} +T{ +cashflow +T}@T{ +Y \f[I]1\f[R] +T}@T{ +Y \f[I]1\f[R] +T}@T{ +Y \f[I]1\f[R] +T}@T{ +Y +T}@T{ +T} +T{ +incomestatement +T}@T{ +Y \f[I]1\f[R] +T}@T{ +Y \f[I]1\f[R] +T}@T{ +Y \f[I]1\f[R] +T}@T{ +Y +T}@T{ +T} +T{ +print +T}@T{ +Y +T}@T{ +Y +T}@T{ +T}@T{ +Y +T}@T{ +Y +T} +T{ +register +T}@T{ +Y +T}@T{ +Y +T}@T{ +T}@T{ +Y +T}@T{ +T} +.TE +.IP \[bu] 2 +\f[I]1 Also affected by the balance commands\[aq] \f[CI]--layout\f[I] +option.\f[R] +.IP \[bu] 2 +\f[I]2 \f[CI]balance\f[I] does not support html output without a report +interval or with \f[CI]--budget\f[I].\f[R] +.PP +The output format is selected by the \f[C]-O/--output-format=FMT\f[R] +option: +.IP +.nf +\f[C] +$ hledger print -O csv # print CSV on stdout +\f[R] +.fi +.PP +or by the filename extension of an output file specified with the +\f[C]-o/--output-file=FILE.FMT\f[R] option: +.IP +.nf +\f[C] +$ hledger balancesheet -o foo.csv # write CSV to foo.csv +\f[R] +.fi +.PP +The \f[C]-O\f[R] option can be combined with \f[C]-o\f[R] to override +the file extension, if needed: +.IP +.nf +\f[C] +$ hledger balancesheet -o foo.txt -O csv # write CSV to foo.txt +\f[R] +.fi +.SS CSV output +.IP \[bu] 2 +In CSV output, digit group marks (such as thousands separators) are +disabled automatically. +.SS HTML output +.IP \[bu] 2 +HTML output can be styled by an optional \f[C]hledger.css\f[R] file in +the same directory. +.SS JSON output +.IP \[bu] 2 +Not yet much used; real-world feedback is welcome. +.IP \[bu] 2 +Our JSON is rather large and verbose, as it is quite a faithful +representation of hledger\[aq]s internal data types. +To understand the JSON, read the Haskell type definitions, which are +mostly in +https://github.com/simonmichael/hledger/blob/master/hledger-lib/Hledger/Data/Types.hs. +.IP \[bu] 2 +hledger represents quantities as Decimal values storing up to 255 +significant digits, eg for repeating decimals. +Such numbers can arise in practice (from automatically-calculated +transaction prices), and would break most JSON consumers. +So in JSON, we show quantities as simple Numbers with at most 10 decimal +places. +We don\[aq]t limit the number of integer digits, but that part is under +your control. +We hope this approach will not cause problems in practice; if you find +otherwise, please let us know. +(Cf #1195) +.SS SQL output +.IP \[bu] 2 +Not yet much used; real-world feedback is welcome. +.IP \[bu] 2 +SQL output is expected to work with sqlite, MySQL and PostgreSQL +.IP \[bu] 2 +SQL output is structured with the expectations that statements will be +executed in the empty database. +If you already have tables created via SQL output of hledger, you would +probably want to either clear tables of existing data (via +\f[C]delete\f[R] or \f[C]truncate\f[R] SQL statements) or drop tables +completely as otherwise your postings will be duped. +.SS Commodity styles +.PP +The display style of a commodity/currency is inferred according to the +rules described in Commodity display style. +The inferred display style can be overridden by an optional +\f[C]-c/--commodity-style\f[R] option (Exceptions: as is the case for +inferred styles, price amounts, and all amounts displayed by the +\f[C]print\f[R] command, will be displayed with all of their decimal +digits visible, regardless of the specified precision). +For example, the following will override the display style for dollars. +.IP +.nf +\f[C] +$ hledger print -c \[aq]$1.000,0\[aq] +\f[R] +.fi +.PP +The format specification of the style is identical to the commodity +display style specification for the commodity directive. +The command line option can be supplied repeatedly to override the +display style for multiple commodity/currency symbols. +.SS Debug output +.PP +We aim for hledger to be relatively easy to troubleshoot, introspect and +develop. +You can add \f[C]--debug[=N]\f[R] to any hledger command line to see +additional debug output. +N ranges from 1 (least output, the default) to 9 (maximum output). +Typically you would start with 1 and increase until you are seeing +enough. +Debug output goes to stderr, and is not affected by +\f[C]-o/--output-file\f[R] (unless you redirect stderr to stdout, eg: +\f[C]2>&1\f[R]). +It will be interleaved with normal output, which can help reveal when +parts of the code are evaluated. +To capture debug output in a log file instead, you can usually redirect +stderr, eg: +.PD 0 +.P +.PD +\f[C]hledger bal --debug=3 2>hledger.log\f[R]. .SH TIME PERIODS .SS Smart dates .PP @@ -2790,267 +3067,6 @@ $ hledger balance --pivot member acct:. -2 EUR \f[R] .fi -.SH OUTPUT -.SS Output destination -.PP -hledger commands send their output to the terminal by default. -You can of course redirect this, eg into a file, using standard shell -syntax: -.IP -.nf -\f[C] -$ hledger print > foo.txt -\f[R] -.fi -.PP -Some commands (print, register, stats, the balance commands) also -provide the \f[C]-o/--output-file\f[R] option, which does the same thing -without needing the shell. -Eg: -.IP -.nf -\f[C] -$ hledger print -o foo.txt -$ hledger print -o - # write to stdout (the default) -\f[R] -.fi -.PP -hledger can optionally produce debug output (if enabled with -\f[C]--debug=N\f[R]); this goes to stderr, and is not affected by -\f[C]-o/--output-file\f[R]. -If you need to capture it, use shell redirects, eg: -\f[C]hledger bal --debug=3 >file 2>&1\f[R]. -.SS Output styling -.PP -hledger commands can produce colour output when the terminal supports -it. -This is controlled by the \f[C]--color/--colour\f[R] option: - if the -\f[C]--color/--colour\f[R] option is given a value of \f[C]yes\f[R] or -\f[C]always\f[R] (or \f[C]no\f[R] or \f[C]never\f[R]), colour will (or -will not) be used; - otherwise, if the \f[C]NO_COLOR\f[R] environment -variable is set, colour will not be used; - otherwise, colour will be -used if the output (terminal or file) supports it. -.PP -hledger commands can also use unicode box-drawing characters to produce -prettier tables and output. -This is controlled by the \f[C]--pretty\f[R] option: - if the -\f[C]--pretty\f[R] option is given a value of \f[C]yes\f[R] or -\f[C]always\f[R] (or \f[C]no\f[R] or \f[C]never\f[R]), unicode -characters will (or will not) be used; - otherwise, unicode characters -will not be used. -.SS Output format -.PP -Some commands offer additional output formats, other than the usual -plain text terminal output. -Here are those commands and the formats currently supported: -.PP -.TS -tab(@); -l l l l l l. -T{ -- -T}@T{ -txt -T}@T{ -csv -T}@T{ -html -T}@T{ -json -T}@T{ -sql -T} -_ -T{ -aregister -T}@T{ -Y -T}@T{ -Y -T}@T{ -T}@T{ -Y -T}@T{ -T} -T{ -balance -T}@T{ -Y \f[I]1\f[R] -T}@T{ -Y \f[I]1\f[R] -T}@T{ -Y \f[I]1,2\f[R] -T}@T{ -Y -T}@T{ -T} -T{ -balancesheet -T}@T{ -Y \f[I]1\f[R] -T}@T{ -Y \f[I]1\f[R] -T}@T{ -Y \f[I]1\f[R] -T}@T{ -Y -T}@T{ -T} -T{ -balancesheetequity -T}@T{ -Y \f[I]1\f[R] -T}@T{ -Y \f[I]1\f[R] -T}@T{ -Y \f[I]1\f[R] -T}@T{ -Y -T}@T{ -T} -T{ -cashflow -T}@T{ -Y \f[I]1\f[R] -T}@T{ -Y \f[I]1\f[R] -T}@T{ -Y \f[I]1\f[R] -T}@T{ -Y -T}@T{ -T} -T{ -incomestatement -T}@T{ -Y \f[I]1\f[R] -T}@T{ -Y \f[I]1\f[R] -T}@T{ -Y \f[I]1\f[R] -T}@T{ -Y -T}@T{ -T} -T{ -print -T}@T{ -Y -T}@T{ -Y -T}@T{ -T}@T{ -Y -T}@T{ -Y -T} -T{ -register -T}@T{ -Y -T}@T{ -Y -T}@T{ -T}@T{ -Y -T}@T{ -T} -.TE -.IP \[bu] 2 -\f[I]1 Also affected by the balance commands\[aq] \f[CI]--layout\f[I] -option.\f[R] -.IP \[bu] 2 -\f[I]2 \f[CI]balance\f[I] does not support html output without a report -interval or with \f[CI]--budget\f[I].\f[R] -.PP -The output format is selected by the \f[C]-O/--output-format=FMT\f[R] -option: -.IP -.nf -\f[C] -$ hledger print -O csv # print CSV on stdout -\f[R] -.fi -.PP -or by the filename extension of an output file specified with the -\f[C]-o/--output-file=FILE.FMT\f[R] option: -.IP -.nf -\f[C] -$ hledger balancesheet -o foo.csv # write CSV to foo.csv -\f[R] -.fi -.PP -The \f[C]-O\f[R] option can be combined with \f[C]-o\f[R] to override -the file extension, if needed: -.IP -.nf -\f[C] -$ hledger balancesheet -o foo.txt -O csv # write CSV to foo.txt -\f[R] -.fi -.SS CSV output -.IP \[bu] 2 -In CSV output, digit group marks (such as thousands separators) are -disabled automatically. -.SS HTML output -.IP \[bu] 2 -HTML output can be styled by an optional \f[C]hledger.css\f[R] file in -the same directory. -.SS JSON output -.IP \[bu] 2 -Not yet much used; real-world feedback is welcome. -.IP \[bu] 2 -Our JSON is rather large and verbose, as it is quite a faithful -representation of hledger\[aq]s internal data types. -To understand the JSON, read the Haskell type definitions, which are -mostly in -https://github.com/simonmichael/hledger/blob/master/hledger-lib/Hledger/Data/Types.hs. -.IP \[bu] 2 -hledger represents quantities as Decimal values storing up to 255 -significant digits, eg for repeating decimals. -Such numbers can arise in practice (from automatically-calculated -transaction prices), and would break most JSON consumers. -So in JSON, we show quantities as simple Numbers with at most 10 decimal -places. -We don\[aq]t limit the number of integer digits, but that part is under -your control. -We hope this approach will not cause problems in practice; if you find -otherwise, please let us know. -(Cf #1195) -.SS SQL output -.IP \[bu] 2 -Not yet much used; real-world feedback is welcome. -.IP \[bu] 2 -SQL output is expected to work with sqlite, MySQL and PostgreSQL -.IP \[bu] 2 -SQL output is structured with the expectations that statements will be -executed in the empty database. -If you already have tables created via SQL output of hledger, you would -probably want to either clear tables of existing data (via -\f[C]delete\f[R] or \f[C]truncate\f[R] SQL statements) or drop tables -completely as otherwise your postings will be duped. -.SS Commodity styles -.PP -The display style of a commodity/currency is inferred according to the -rules described in Commodity display style. -The inferred display style can be overridden by an optional -\f[C]-c/--commodity-style\f[R] option (Exceptions: as is the case for -inferred styles, price amounts, and all amounts displayed by the -\f[C]print\f[R] command, will be displayed with all of their decimal -digits visible, regardless of the specified precision). -For example, the following will override the display style for dollars. -.IP -.nf -\f[C] -$ hledger print -c \[aq]$1.000,0\[aq] -\f[R] -.fi -.PP -The format specification of the style is identical to the commodity -display style specification for the commodity directive. -The command line option can be supplied repeatedly to override the -display style for multiple commodity/currency symbols. .SH COMMANDS .PP hledger provides a number of commands for producing reports and managing @@ -3165,11 +3181,19 @@ accounts .PD Show account names. .PP -This command lists account names, either declared with account -directives (--declared), posted to (--used), or both (the default). +This command lists account names. +By default it shows all known accounts, either used in transactions or +declared with account directives. +.PP With query arguments, only matched account names and account names referenced by matched postings are shown. .PP +Or it can show just the used accounts (\f[C]--used\f[R]/\f[C]-u\f[R]), +the declared accounts (\f[C]--declared\f[R]/\f[C]-d\f[R]), the accounts +declared but not used (\f[C]--unused\f[R]), the accounts used but not +declared (\f[C]--undeclared\f[R]), or the first account matched by an +account name pattern, if any (\f[C]--find\f[R]). +.PP It shows a flat list by default. With \f[C]--tree\f[R], it uses indentation to show the account hierarchy. @@ -3190,6 +3214,13 @@ display order. With \f[C]--directives\f[R], it adds the \f[C]account\f[R] keyword, showing valid account directives which can be pasted into a journal file. +This is useful together with \f[C]--undeclared\f[R] when updating your +account declarations to satisfy \f[C]hledger check accounts\f[R]. +.PP +The \f[C]--find\f[R] flag can be used to look up a single account name, +in the same way that the \f[C]aregister\f[R] command does. +It returns the alphanumerically-first matched account name, or if none +can be found, it fails with a non-zero exit code. .PP Examples: .IP @@ -3206,6 +3237,13 @@ income:salary liabilities:debts \f[R] .fi +.IP +.nf +\f[C] +$ hledger accounts --undeclared --directives >> $LEDGER_FILE +$ hledger check accounts +\f[R] +.fi .SS activity .PP activity @@ -8979,7 +9017,14 @@ T} T{ \f[B]\f[CB]newest-first\f[B]\f[R] T}@T{ -disambiguate record order when there\[aq]s only one date +improve txn order when there are multiple records, newest first, all +with the same date +T} +T{ +\f[B]\f[CB]intra-day-reversed\f[B]\f[R] +T}@T{ +improve txn order when each day\[aq]s txns are reverse of the overall +date order T} T{ \f[B]\f[CB]include\f[B]\f[R] @@ -9842,7 +9887,7 @@ the TZ environment variable, eg: .IP .nf \f[C] -$ TZ=HST hledger print -f foo.csv # or TZ=HST hledger import foo.csv +$ TZ=-1000 hledger print -f foo.csv # or TZ=-1000 hledger import foo.csv \f[R] .fi .PP @@ -9874,29 +9919,55 @@ thousand-separating commas, you should declare the decimal mark explicitly with this rule, to avoid misparsed numbers. .SS \f[C]newest-first\f[R] .PP -hledger always sorts the generated transactions by date. -Transactions on the same date should appear in the same order as their -CSV records, as hledger can usually auto-detect whether the CSV\[aq]s -normal order is oldest first or newest first. -But if all of the following are true: -.IP \[bu] 2 -the CSV might sometimes contain just one day of data (all records having -the same date) -.IP \[bu] 2 -the CSV records are normally in reverse chronological order (newest at -the top) -.IP \[bu] 2 -and you care about preserving the order of same-day transactions -.PP -then, you should add the \f[C]newest-first\f[R] rule as a hint. -Eg: +hledger tries to ensure that the generated transactions will be ordered +chronologically, including intra-day transactions. +Usually it can auto-detect how the CSV records are ordered. +But if it encounters CSV where all records are on the same date, it +assumes that the records are oldest first. +If in fact the CSV\[aq]s records are normally newest first, like: .IP .nf \f[C] -# tell hledger explicitly that the CSV is normally newest first +2022-10-01, txn 3... +2022-10-01, txn 2... +2022-10-01, txn 1... +\f[R] +.fi +.PP +you can add the \f[C]newest-first\f[R] rule to help hledger generate the +transactions in correct order. +.IP +.nf +\f[C] +# same-day CSV records are newest first newest-first \f[R] .fi +.SS \f[C]intra-day-reversed\f[R] +.PP +CSV records for each day are sometimes ordered in reverse compared to +the overall date order. +Eg, here dates are newest first, but the transactions on each date are +oldest first: +.IP +.nf +\f[C] +2022-10-02, txn 3... +2022-10-02, txn 4... +2022-10-01, txn 1... +2022-10-01, txn 2... +\f[R] +.fi +.PP +In this situation, add the \f[C]intra-day-reversed\f[R] rule, and +hledger will compensate, improving the order of transactions. +.IP +.nf +\f[C] +# transactions within each day are reversed with respect to the overall date order +intra-day-reversed +\f[R] +.fi .SS \f[C]include\f[R] .IP .nf diff --git a/hledger/hledger.info b/hledger/hledger.info index ab2401be0..8781a6094 100644 --- a/hledger/hledger.info +++ b/hledger/hledger.info @@ -62,14 +62,14 @@ try some commands like 'hledger print' or 'hledger balance'. Run * OPTIONS:: * ENVIRONMENT:: -* DATA FILES:: +* INPUT:: +* OUTPUT:: * TIME PERIODS:: * DEPTH:: * QUERIES:: * COST:: * VALUATION:: * PIVOTING:: -* OUTPUT:: * COMMANDS:: * JOURNAL FORMAT:: * CSV FORMAT:: @@ -497,7 +497,7 @@ they support: See Special characters.  -File: hledger.info, Node: ENVIRONMENT, Next: DATA FILES, Prev: OPTIONS, Up: Top +File: hledger.info, Node: ENVIRONMENT, Next: INPUT, Prev: OPTIONS, Up: Top 2 ENVIRONMENT ************* @@ -545,10 +545,10 @@ use ANSI color codes in terminal output. This is overriden by the -color/-colour option.  -File: hledger.info, Node: DATA FILES, Next: TIME PERIODS, Prev: ENVIRONMENT, Up: Top +File: hledger.info, Node: INPUT, Next: OUTPUT, Prev: ENVIRONMENT, Up: Top -3 DATA FILES -************ +3 INPUT +******* hledger reads transactions from one or more data files. The default data file is '$HOME/.hledger.journal' (or on Windows, something like @@ -574,7 +574,7 @@ $ cat some.journal | hledger -f- * Strict mode::  -File: hledger.info, Node: Data formats, Next: Multiple files, Up: DATA FILES +File: hledger.info, Node: Data formats, Next: Multiple files, Up: INPUT 3.1 Data formats ================ @@ -613,7 +613,7 @@ $ hledger -f csv:/some/csv-file.dat stats $ echo 'i 2009/13/1 08:00:00' | hledger print -ftimeclock:-  -File: hledger.info, Node: Multiple files, Next: Strict mode, Prev: Data formats, Up: DATA FILES +File: hledger.info, Node: Multiple files, Next: Strict mode, Prev: Data formats, Up: INPUT 3.2 Multiple files ================== @@ -632,7 +632,7 @@ journal. There are some limitations with this: a.journal b.journal | hledger -f- CMD'.  -File: hledger.info, Node: Strict mode, Prev: Multiple files, Up: DATA FILES +File: hledger.info, Node: Strict mode, Prev: Multiple files, Up: INPUT 3.3 Strict mode =============== @@ -657,9 +657,204 @@ without a lot of declarations: listed above and some more.  -File: hledger.info, Node: TIME PERIODS, Next: DEPTH, Prev: DATA FILES, Up: Top +File: hledger.info, Node: OUTPUT, Next: TIME PERIODS, Prev: INPUT, Up: Top -4 TIME PERIODS +4 OUTPUT +******** + +Some of this section may refer to things explained further below. + +* Menu: + +* Output destination:: +* Output styling:: +* Output format:: +* Commodity styles:: +* Debug output:: + + +File: hledger.info, Node: Output destination, Next: Output styling, Up: OUTPUT + +4.1 Output destination +====================== + +hledger commands send their output to the terminal by default. You can +of course redirect this, eg into a file, using standard shell syntax: + +$ hledger print > foo.txt + + Some commands (print, register, stats, the balance commands) also +provide the '-o/--output-file' option, which does the same thing without +needing the shell. Eg: + +$ hledger print -o foo.txt +$ hledger print -o - # write to stdout (the default) + + +File: hledger.info, Node: Output styling, Next: Output format, Prev: Output destination, Up: OUTPUT + +4.2 Output styling +================== + +hledger commands can produce colour output when the terminal supports +it. This is controlled by the '--color/--colour' option: - if the +'--color/--colour' option is given a value of 'yes' or 'always' (or 'no' +or 'never'), colour will (or will not) be used; - otherwise, if the +'NO_COLOR' environment variable is set, colour will not be used; - +otherwise, colour will be used if the output (terminal or file) supports +it. + + hledger commands can also use unicode box-drawing characters to +produce prettier tables and output. This is controlled by the +'--pretty' option: - if the '--pretty' option is given a value of 'yes' +or 'always' (or 'no' or 'never'), unicode characters will (or will not) +be used; - otherwise, unicode characters will not be used. + + +File: hledger.info, Node: Output format, Next: Commodity styles, Prev: Output styling, Up: OUTPUT + +4.3 Output format +================= + +Some commands offer additional output formats, other than the usual +plain text terminal output. Here are those commands and the formats +currently supported: + +- txt csv html json sql +------------------------------------------------------------ +aregister Y Y Y +balance Y _1_ Y _1_ Y _1,2_ Y +balancesheet Y _1_ Y _1_ Y _1_ Y +balancesheetequity Y _1_ Y _1_ Y _1_ Y +cashflow Y _1_ Y _1_ Y _1_ Y +incomestatement Y _1_ Y _1_ Y _1_ Y +print Y Y Y Y +register Y Y Y + + * _1 Also affected by the balance commands' '--layout' option._ + * _2 'balance' does not support html output without a report interval + or with '--budget'._ + + The output format is selected by the '-O/--output-format=FMT' option: + +$ hledger print -O csv # print CSV on stdout + + or by the filename extension of an output file specified with the +'-o/--output-file=FILE.FMT' option: + +$ hledger balancesheet -o foo.csv # write CSV to foo.csv + + The '-O' option can be combined with '-o' to override the file +extension, if needed: + +$ hledger balancesheet -o foo.txt -O csv # write CSV to foo.txt + +* Menu: + +* CSV output:: +* HTML output:: +* JSON output:: +* SQL output:: + + +File: hledger.info, Node: CSV output, Next: HTML output, Up: Output format + +4.3.1 CSV output +---------------- + + * In CSV output, digit group marks (such as thousands separators) are + disabled automatically. + + +File: hledger.info, Node: HTML output, Next: JSON output, Prev: CSV output, Up: Output format + +4.3.2 HTML output +----------------- + + * HTML output can be styled by an optional 'hledger.css' file in the + same directory. + + +File: hledger.info, Node: JSON output, Next: SQL output, Prev: HTML output, Up: Output format + +4.3.3 JSON output +----------------- + + * Not yet much used; real-world feedback is welcome. + + * Our JSON is rather large and verbose, as it is quite a faithful + representation of hledger's internal data types. To understand the + JSON, read the Haskell type definitions, which are mostly in + https://github.com/simonmichael/hledger/blob/master/hledger-lib/Hledger/Data/Types.hs. + + * hledger represents quantities as Decimal values storing up to 255 + significant digits, eg for repeating decimals. Such numbers can + arise in practice (from automatically-calculated transaction + prices), and would break most JSON consumers. So in JSON, we show + quantities as simple Numbers with at most 10 decimal places. We + don't limit the number of integer digits, but that part is under + your control. We hope this approach will not cause problems in + practice; if you find otherwise, please let us know. (Cf #1195) + + +File: hledger.info, Node: SQL output, Prev: JSON output, Up: Output format + +4.3.4 SQL output +---------------- + + * Not yet much used; real-world feedback is welcome. + + * SQL output is expected to work with sqlite, MySQL and PostgreSQL + + * SQL output is structured with the expectations that statements will + be executed in the empty database. If you already have tables + created via SQL output of hledger, you would probably want to + either clear tables of existing data (via 'delete' or 'truncate' + SQL statements) or drop tables completely as otherwise your + postings will be duped. + + +File: hledger.info, Node: Commodity styles, Next: Debug output, Prev: Output format, Up: OUTPUT + +4.4 Commodity styles +==================== + +The display style of a commodity/currency is inferred according to the +rules described in Commodity display style. The inferred display style +can be overridden by an optional '-c/--commodity-style' option +(Exceptions: as is the case for inferred styles, price amounts, and all +amounts displayed by the 'print' command, will be displayed with all of +their decimal digits visible, regardless of the specified precision). +For example, the following will override the display style for dollars. + +$ hledger print -c '$1.000,0' + + The format specification of the style is identical to the commodity +display style specification for the commodity directive. The command +line option can be supplied repeatedly to override the display style for +multiple commodity/currency symbols. + + +File: hledger.info, Node: Debug output, Prev: Commodity styles, Up: OUTPUT + +4.5 Debug output +================ + +We aim for hledger to be relatively easy to troubleshoot, introspect and +develop. You can add '--debug[=N]' to any hledger command line to see +additional debug output. N ranges from 1 (least output, the default) to +9 (maximum output). Typically you would start with 1 and increase until +you are seeing enough. Debug output goes to stderr, and is not affected +by '-o/--output-file' (unless you redirect stderr to stdout, eg: +'2>&1'). It will be interleaved with normal output, which can help +reveal when parts of the code are evaluated. To capture debug output in +a log file instead, you can usually redirect stderr, eg: +'hledger bal --debug=3 2>hledger.log'. + + +File: hledger.info, Node: TIME PERIODS, Next: DEPTH, Prev: OUTPUT, Up: Top + +5 TIME PERIODS ************** * Menu: @@ -672,7 +867,7 @@ File: hledger.info, Node: TIME PERIODS, Next: DEPTH, Prev: DATA FILES, Up: T  File: hledger.info, Node: Smart dates, Next: Report start & end date, Up: TIME PERIODS -4.1 Smart dates +5.1 Smart dates =============== hledger's user interfaces accept a flexible "smart date" syntax. Smart @@ -722,7 +917,7 @@ periodic transaction rules; those are not affected by '--today'.)  File: hledger.info, Node: Report start & end date, Next: Report intervals, Prev: Smart dates, Up: TIME PERIODS -4.2 Report start & end date +5.2 Report start & end date =========================== By default, most hledger reports will show the full span of time @@ -767,7 +962,7 @@ thismonth'  File: hledger.info, Node: Report intervals, Next: Period expressions, Prev: Report start & end date, Up: TIME PERIODS -4.3 Report intervals +5.3 Report intervals ==================== A report interval can be specified so that commands like register, @@ -816,7 +1011,7 @@ subperiods, so that all subperiods' numbers are comparable.  File: hledger.info, Node: Period expressions, Prev: Report intervals, Up: TIME PERIODS -4.4 Period expressions +5.4 Period expressions ====================== The '-p/--period' option accepts period expressions, a shorthand way of @@ -874,7 +1069,7 @@ date like so:  File: hledger.info, Node: Period expressions with a report interval, Next: More complex report intervals, Up: Period expressions -4.4.1 Period expressions with a report interval +5.4.1 Period expressions with a report interval ----------------------------------------------- '-p/--period''s argument can also begin with, or entirely consist of, a @@ -907,7 +1102,7 @@ needed to span a whole number of intervals.  File: hledger.info, Node: More complex report intervals, Next: Intervals with custom start date, Prev: Period expressions with a report interval, Up: Period expressions -4.4.2 More complex report intervals +5.4.2 More complex report intervals ----------------------------------- Some more complex kinds of interval are also supported in period @@ -931,7 +1126,7 @@ needed, to span a whole number of intervals. Examples:  File: hledger.info, Node: Intervals with custom start date, Next: Periods or dates ?, Prev: More complex report intervals, Up: Period expressions -4.4.3 Intervals with custom start date +5.4.3 Intervals with custom start date -------------------------------------- All intervals mentioned above are required to start on their natural @@ -984,7 +1179,7 @@ $ hledger register checking -p "every 3rd day of week"  File: hledger.info, Node: Periods or dates ?, Next: Events on multiple weekdays, Prev: Intervals with custom start date, Up: Period expressions -4.4.4 Periods or dates ? +5.4.4 Periods or dates ? ------------------------ Report intervals like the above are most often used with '-p|--period', @@ -1000,7 +1195,7 @@ matters.  File: hledger.info, Node: Events on multiple weekdays, Prev: Periods or dates ?, Up: Period expressions -4.4.5 Events on multiple weekdays +5.4.5 Events on multiple weekdays --------------------------------- The 'every WEEKDAYNAME' form has a special variant with multiple day @@ -1026,7 +1221,7 @@ weekendday"'  File: hledger.info, Node: DEPTH, Next: QUERIES, Prev: TIME PERIODS, Up: Top -5 DEPTH +6 DEPTH ******* With the '--depth NUM' option (short form: '-NUM'), commands like @@ -1038,7 +1233,7 @@ argument: 'depth:2', '--depth=2' or '-2' are equivalent.  File: hledger.info, Node: QUERIES, Next: COST, Prev: DEPTH, Up: Top -6 QUERIES +7 QUERIES ********* One of hledger's strengths is being able to quickly report on a precise @@ -1080,7 +1275,7 @@ arguments to restrict their scope. The syntax is as follows:  File: hledger.info, Node: Query types, Next: Combining query terms, Up: QUERIES -6.1 Query types +7.1 Query types =============== Here are the types of query term available. Remember these can also be @@ -1169,7 +1364,7 @@ hledger-web to show the transaction register for an account.)  File: hledger.info, Node: Combining query terms, Next: Queries and command options, Prev: Query types, Up: QUERIES -6.2 Combining query terms +7.2 Combining query terms ========================= Most commands select things which match: @@ -1198,7 +1393,7 @@ $ hledger print assets:cash | hledger -f- -I balance expenses:food  File: hledger.info, Node: Queries and command options, Next: Queries and account aliases, Prev: Combining query terms, Up: QUERIES -6.3 Queries and command options +7.3 Queries and command options =============================== Some queries can also be expressed as command-line options: 'depth:2' is @@ -1209,7 +1404,7 @@ resulting query is their intersection.  File: hledger.info, Node: Queries and account aliases, Next: Queries and valuation, Prev: Queries and command options, Up: QUERIES -6.4 Queries and account aliases +7.4 Queries and account aliases =============================== When account names are rewritten with '--alias' or 'alias', 'acct:' will @@ -1218,7 +1413,7 @@ match either the old or the new account name.  File: hledger.info, Node: Queries and valuation, Next: Querying with account aliases, Prev: Queries and account aliases, Up: QUERIES -6.5 Queries and valuation +7.5 Queries and valuation ========================= When amounts are converted to other commodities in cost or value @@ -1229,7 +1424,7 @@ reversed, see #1625).  File: hledger.info, Node: Querying with account aliases, Next: Querying with cost or value, Prev: Queries and valuation, Up: QUERIES -6.6 Querying with account aliases +7.6 Querying with account aliases ================================= When account names are rewritten with '--alias' or 'alias', note that @@ -1238,7 +1433,7 @@ When account names are rewritten with '--alias' or 'alias', note that  File: hledger.info, Node: Querying with cost or value, Prev: Querying with account aliases, Up: QUERIES -6.7 Querying with cost or value +7.7 Querying with cost or value =============================== When amounts are converted to other commodities in cost or value @@ -1250,7 +1445,7 @@ the discussion at #1625.  File: hledger.info, Node: COST, Next: VALUATION, Prev: QUERIES, Up: Top -7 COST +8 COST ****** This section is about recording the cost of things, in transactions @@ -1289,7 +1484,7 @@ currency, or a stock purchase or sale. First, a quick glossary:  File: hledger.info, Node: -B Convert to cost, Next: Equity conversion postings, Up: COST -7.1 -B: Convert to cost +8.1 -B: Convert to cost ======================= As discussed a little further on in Transaction prices, when recording a @@ -1333,7 +1528,7 @@ equation and tends to causes a non-zero total in balance reports.  File: hledger.info, Node: Equity conversion postings, Next: Inferring equity postings from cost, Prev: -B Convert to cost, Up: COST -7.2 Equity conversion postings +8.2 Equity conversion postings ============================== By contrast, conventional double entry bookkeeping (DEB) uses a @@ -1356,7 +1551,7 @@ the other when needed, so you can use the one you prefer.  File: hledger.info, Node: Inferring equity postings from cost, Next: Inferring cost from equity postings, Prev: Equity conversion postings, Up: COST -7.3 Inferring equity postings from cost +8.3 Inferring equity postings from cost ======================================= With '--infer-equity', hledger detects transactions written with PTA @@ -1389,7 +1584,7 @@ entries for sharing with non-PTA-users.  File: hledger.info, Node: Inferring cost from equity postings, Next: When to infer cost/equity, Prev: Inferring equity postings from cost, Up: COST -7.4 Inferring cost from equity postings +8.4 Inferring cost from equity postings ======================================= The reverse operation is possible using '--infer-costs', which detects @@ -1457,7 +1652,7 @@ mixture of both notations.  File: hledger.info, Node: When to infer cost/equity, Next: How to record conversions, Prev: Inferring cost from equity postings, Up: COST -7.5 When to infer cost/equity +8.5 When to infer cost/equity ============================= Inferring equity postings or costs is still fairly new, so not enabled @@ -1473,7 +1668,7 @@ suggestions to try, experience reports welcome:  File: hledger.info, Node: How to record conversions, Next: Cost tips, Prev: When to infer cost/equity, Up: COST -7.6 How to record conversions +8.6 How to record conversions ============================= Essentially there are four ways to record a conversion transaction in @@ -1489,7 +1684,7 @@ hledger. Here are all of them, with pros and cons.  File: hledger.info, Node: Conversion with implicit cost, Next: Conversion with explicit cost, Up: How to record conversions -7.6.1 Conversion with implicit cost +8.6.1 Conversion with implicit cost ----------------------------------- Let's assume 100 EUR is converted to 120 USD. You can just record the @@ -1524,7 +1719,7 @@ check balancednoautoconversion', or '-s/--strict'.  File: hledger.info, Node: Conversion with explicit cost, Next: Conversion with equity postings, Prev: Conversion with implicit cost, Up: How to record conversions -7.6.2 Conversion with explicit cost +8.6.2 Conversion with explicit cost ----------------------------------- You can add the conversion rate using @ notation: @@ -1550,7 +1745,7 @@ error otherwise.  File: hledger.info, Node: Conversion with equity postings, Next: Conversion with equity postings and explicit cost, Prev: Conversion with explicit cost, Up: How to record conversions -7.6.3 Conversion with equity postings +8.6.3 Conversion with equity postings ------------------------------------- In strict double entry bookkeeping, the above transaction is not @@ -1582,7 +1777,7 @@ each commodity, using an equity account:  File: hledger.info, Node: Conversion with equity postings and explicit cost, Prev: Conversion with equity postings, Up: How to record conversions -7.6.4 Conversion with equity postings and explicit cost +8.6.4 Conversion with equity postings and explicit cost ------------------------------------------------------- Here both equity postings and @ notation are used together. hledger @@ -1611,7 +1806,7 @@ will usually complain about this redundancy, but when using the  File: hledger.info, Node: Cost tips, Prev: How to record conversions, Up: COST -7.7 Cost tips +8.7 Cost tips ============= * Recording the conversion rate explicitly is good because it makes @@ -1631,7 +1826,7 @@ File: hledger.info, Node: Cost tips, Prev: How to record conversions, Up: COS  File: hledger.info, Node: VALUATION, Next: PIVOTING, Prev: COST, Up: Top -8 VALUATION +9 VALUATION *********** Instead of reporting amounts in their original commodity, hledger can @@ -1658,7 +1853,7 @@ and '-X COMMODITY' options, and often one of these is all you need:  File: hledger.info, Node: -V Value, Next: -X Value in specified commodity, Up: VALUATION -8.1 -V: Value +9.1 -V: Value ============= The '-V/--market' flag converts amounts to market value in their default @@ -1668,7 +1863,7 @@ _valuation date(s)_, if any. More on these in a minute.  File: hledger.info, Node: -X Value in specified commodity, Next: Valuation date, Prev: -V Value, Up: VALUATION -8.2 -X: Value in specified commodity +9.2 -X: Value in specified commodity ==================================== The '-X/--exchange=COMM' option is like '-V', except you tell it which @@ -1678,7 +1873,7 @@ that.  File: hledger.info, Node: Valuation date, Next: Market prices, Prev: -X Value in specified commodity, Up: VALUATION -8.3 Valuation date +9.3 Valuation date ================== Since market prices can change from day to day, market value reports @@ -1695,7 +1890,7 @@ of the period, by default.  File: hledger.info, Node: Market prices, Next: --infer-market-prices market prices from transactions, Prev: Valuation date, Up: VALUATION -8.4 Market prices +9.4 Market prices ================= To convert a commodity A to its market value in another commodity B, @@ -1729,7 +1924,7 @@ converted.  File: hledger.info, Node: --infer-market-prices market prices from transactions, Next: Valuation commodity, Prev: Market prices, Up: VALUATION -8.5 -infer-market-prices: market prices from transactions +9.5 -infer-market-prices: market prices from transactions ========================================================= Normally, market value in hledger is fully controlled by, and requires, @@ -1774,7 +1969,7 @@ valuation commmodity, eg:  File: hledger.info, Node: Valuation commodity, Next: Simple valuation examples, Prev: --infer-market-prices market prices from transactions, Up: VALUATION -8.6 Valuation commodity +9.6 Valuation commodity ======================= *When you specify a valuation commodity ('-X COMM' or '--value @@ -1813,7 +2008,7 @@ converted.  File: hledger.info, Node: Simple valuation examples, Next: --value Flexible valuation, Prev: Valuation commodity, Up: VALUATION -8.7 Simple valuation examples +9.7 Simple valuation examples ============================= Here are some quick examples of '-V': @@ -1848,7 +2043,7 @@ $ hledger -f t.j bal -N euros -V  File: hledger.info, Node: --value Flexible valuation, Next: More valuation examples, Prev: Simple valuation examples, Up: VALUATION -8.8 -value: Flexible valuation +9.8 -value: Flexible valuation ============================== '-V' and '-X' are special cases of the more general '--value' option: @@ -1890,7 +2085,7 @@ this commodity, deducing market prices as described above.  File: hledger.info, Node: More valuation examples, Next: Interaction of valuation and queries, Prev: --value Flexible valuation, Up: VALUATION -8.9 More valuation examples +9.9 More valuation examples =========================== Here are some examples showing the effect of '--value', as seen with @@ -2004,7 +2199,7 @@ $ hledger print -X A  File: hledger.info, Node: Interaction of valuation and queries, Next: Effect of valuation on reports, Prev: More valuation examples, Up: VALUATION -8.10 Interaction of valuation and queries +9.10 Interaction of valuation and queries ========================================= When matching postings based on queries in the presence of valuation, @@ -2025,7 +2220,7 @@ the following happens.  File: hledger.info, Node: Effect of valuation on reports, Prev: Interaction of valuation and queries, Up: VALUATION -8.11 Effect of valuation on reports +9.11 Effect of valuation on reports =================================== Here is a reference for how valuation is supposed to affect each part of @@ -2172,10 +2367,10 @@ _report interval_ subperiods).  -File: hledger.info, Node: PIVOTING, Next: OUTPUT, Prev: VALUATION, Up: Top +File: hledger.info, Node: PIVOTING, Next: COMMANDS, Prev: VALUATION, Up: Top -9 PIVOTING -********** +10 PIVOTING +*********** Normally hledger sums amounts, and organizes them in a hierarchy, based on account name. The '--pivot FIELD' option causes it to sum and @@ -2230,187 +2425,7 @@ $ hledger balance --pivot member acct:. -2 EUR  -File: hledger.info, Node: OUTPUT, Next: COMMANDS, Prev: PIVOTING, Up: Top - -10 OUTPUT -********* - -* Menu: - -* Output destination:: -* Output styling:: -* Output format:: -* Commodity styles:: - - -File: hledger.info, Node: Output destination, Next: Output styling, Up: OUTPUT - -10.1 Output destination -======================= - -hledger commands send their output to the terminal by default. You can -of course redirect this, eg into a file, using standard shell syntax: - -$ hledger print > foo.txt - - Some commands (print, register, stats, the balance commands) also -provide the '-o/--output-file' option, which does the same thing without -needing the shell. Eg: - -$ hledger print -o foo.txt -$ hledger print -o - # write to stdout (the default) - - hledger can optionally produce debug output (if enabled with -'--debug=N'); this goes to stderr, and is not affected by -'-o/--output-file'. If you need to capture it, use shell redirects, eg: -'hledger bal --debug=3 >file 2>&1'. - - -File: hledger.info, Node: Output styling, Next: Output format, Prev: Output destination, Up: OUTPUT - -10.2 Output styling -=================== - -hledger commands can produce colour output when the terminal supports -it. This is controlled by the '--color/--colour' option: - if the -'--color/--colour' option is given a value of 'yes' or 'always' (or 'no' -or 'never'), colour will (or will not) be used; - otherwise, if the -'NO_COLOR' environment variable is set, colour will not be used; - -otherwise, colour will be used if the output (terminal or file) supports -it. - - hledger commands can also use unicode box-drawing characters to -produce prettier tables and output. This is controlled by the -'--pretty' option: - if the '--pretty' option is given a value of 'yes' -or 'always' (or 'no' or 'never'), unicode characters will (or will not) -be used; - otherwise, unicode characters will not be used. - - -File: hledger.info, Node: Output format, Next: Commodity styles, Prev: Output styling, Up: OUTPUT - -10.3 Output format -================== - -Some commands offer additional output formats, other than the usual -plain text terminal output. Here are those commands and the formats -currently supported: - -- txt csv html json sql ------------------------------------------------------------- -aregister Y Y Y -balance Y _1_ Y _1_ Y _1,2_ Y -balancesheet Y _1_ Y _1_ Y _1_ Y -balancesheetequity Y _1_ Y _1_ Y _1_ Y -cashflow Y _1_ Y _1_ Y _1_ Y -incomestatement Y _1_ Y _1_ Y _1_ Y -print Y Y Y Y -register Y Y Y - - * _1 Also affected by the balance commands' '--layout' option._ - * _2 'balance' does not support html output without a report interval - or with '--budget'._ - - The output format is selected by the '-O/--output-format=FMT' option: - -$ hledger print -O csv # print CSV on stdout - - or by the filename extension of an output file specified with the -'-o/--output-file=FILE.FMT' option: - -$ hledger balancesheet -o foo.csv # write CSV to foo.csv - - The '-O' option can be combined with '-o' to override the file -extension, if needed: - -$ hledger balancesheet -o foo.txt -O csv # write CSV to foo.txt - -* Menu: - -* CSV output:: -* HTML output:: -* JSON output:: -* SQL output:: - - -File: hledger.info, Node: CSV output, Next: HTML output, Up: Output format - -10.3.1 CSV output ------------------ - - * In CSV output, digit group marks (such as thousands separators) are - disabled automatically. - - -File: hledger.info, Node: HTML output, Next: JSON output, Prev: CSV output, Up: Output format - -10.3.2 HTML output ------------------- - - * HTML output can be styled by an optional 'hledger.css' file in the - same directory. - - -File: hledger.info, Node: JSON output, Next: SQL output, Prev: HTML output, Up: Output format - -10.3.3 JSON output ------------------- - - * Not yet much used; real-world feedback is welcome. - - * Our JSON is rather large and verbose, as it is quite a faithful - representation of hledger's internal data types. To understand the - JSON, read the Haskell type definitions, which are mostly in - https://github.com/simonmichael/hledger/blob/master/hledger-lib/Hledger/Data/Types.hs. - - * hledger represents quantities as Decimal values storing up to 255 - significant digits, eg for repeating decimals. Such numbers can - arise in practice (from automatically-calculated transaction - prices), and would break most JSON consumers. So in JSON, we show - quantities as simple Numbers with at most 10 decimal places. We - don't limit the number of integer digits, but that part is under - your control. We hope this approach will not cause problems in - practice; if you find otherwise, please let us know. (Cf #1195) - - -File: hledger.info, Node: SQL output, Prev: JSON output, Up: Output format - -10.3.4 SQL output ------------------ - - * Not yet much used; real-world feedback is welcome. - - * SQL output is expected to work with sqlite, MySQL and PostgreSQL - - * SQL output is structured with the expectations that statements will - be executed in the empty database. If you already have tables - created via SQL output of hledger, you would probably want to - either clear tables of existing data (via 'delete' or 'truncate' - SQL statements) or drop tables completely as otherwise your - postings will be duped. - - -File: hledger.info, Node: Commodity styles, Prev: Output format, Up: OUTPUT - -10.4 Commodity styles -===================== - -The display style of a commodity/currency is inferred according to the -rules described in Commodity display style. The inferred display style -can be overridden by an optional '-c/--commodity-style' option -(Exceptions: as is the case for inferred styles, price amounts, and all -amounts displayed by the 'print' command, will be displayed with all of -their decimal digits visible, regardless of the specified precision). -For example, the following will override the display style for dollars. - -$ hledger print -c '$1.000,0' - - The format specification of the style is identical to the commodity -display style specification for the commodity directive. The command -line option can be supplied repeatedly to override the display style for -multiple commodity/currency symbols. - - -File: hledger.info, Node: COMMANDS, Next: JOURNAL FORMAT, Prev: OUTPUT, Up: Top +File: hledger.info, Node: COMMANDS, Next: JOURNAL FORMAT, Prev: PIVOTING, Up: Top 11 COMMANDS *********** @@ -2530,10 +2545,17 @@ File: hledger.info, Node: accounts, Next: activity, Up: COMMANDS accounts Show account names. - This command lists account names, either declared with account -directives (-declared), posted to (-used), or both (the default). With -query arguments, only matched account names and account names referenced -by matched postings are shown. + This command lists account names. By default it shows all known +accounts, either used in transactions or declared with account +directives. + + With query arguments, only matched account names and account names +referenced by matched postings are shown. + + Or it can show just the used accounts ('--used'/'-u'), the declared +accounts ('--declared'/'-d'), the accounts declared but not used +('--unused'), the accounts used but not declared ('--undeclared'), or +the first account matched by an account name pattern, if any ('--find'). It shows a flat list by default. With '--tree', it uses indentation to show the account hierarchy. In flat mode you can add '--drop N' to @@ -2548,7 +2570,14 @@ account's declaration, if any, and the account's overall declaration order; these may be useful when troubleshooting account display order. With '--directives', it adds the 'account' keyword, showing valid -account directives which can be pasted into a journal file. +account directives which can be pasted into a journal file. This is +useful together with '--undeclared' when updating your account +declarations to satisfy 'hledger check accounts'. + + The '--find' flag can be used to look up a single account name, in +the same way that the 'aregister' command does. It returns the +alphanumerically-first matched account name, or if none can be found, it +fails with a non-zero exit code. Examples: @@ -2562,6 +2591,9 @@ income:gifts income:salary liabilities:debts +$ hledger accounts --undeclared --directives >> $LEDGER_FILE +$ hledger check accounts +  File: hledger.info, Node: activity, Next: add, Prev: accounts, Up: COMMANDS @@ -7664,8 +7696,11 @@ after the examples: *'date-format'* how to parse dates in CSV records *'decimal-mark'* the decimal mark used in CSV amounts, if ambiguous -*'newest-first'* disambiguate record order when there's only - one date +*'newest-first'* improve txn order when there are multiple + records, newest first, all with the same + date +*'intra-day-reversed'* improve txn order when each day's txns are + reverse of the overall date order *'include'* inline another CSV rules file *'balance-type'* choose which type of balance assignments to use @@ -8012,6 +8047,7 @@ Blank lines and lines beginning with '#' or ';' are ignored. * timezone:: * decimal-mark:: * newest-first:: +* intra-day-reversed:: * include:: * balance-type:: @@ -8527,7 +8563,7 @@ zone. If you prefer to localise to some other time zone, eg for reproducibility, you can (on unix at least) set the output timezone with the TZ environment variable, eg: -$ TZ=HST hledger print -f foo.csv # or TZ=HST hledger import foo.csv +$ TZ=-1000 hledger print -f foo.csv # or TZ=-1000 hledger import foo.csv 'timezone' currently does not understand timezone names, except "UTC", "GMT", "EST", "EDT", "CST", "CDT", "MST", "MDT", "PST", or "PDT". @@ -8552,31 +8588,53 @@ should declare the decimal mark explicitly with this rule, to avoid misparsed numbers.  -File: hledger.info, Node: newest-first, Next: include, Prev: decimal-mark, Up: CSV rules +File: hledger.info, Node: newest-first, Next: intra-day-reversed, Prev: decimal-mark, Up: CSV rules 13.2.12 'newest-first' ---------------------- -hledger always sorts the generated transactions by date. Transactions -on the same date should appear in the same order as their CSV records, -as hledger can usually auto-detect whether the CSV's normal order is -oldest first or newest first. But if all of the following are true: +hledger tries to ensure that the generated transactions will be ordered +chronologically, including intra-day transactions. Usually it can +auto-detect how the CSV records are ordered. But if it encounters CSV +where all records are on the same date, it assumes that the records are +oldest first. If in fact the CSV's records are normally newest first, +like: - * the CSV might sometimes contain just one day of data (all records - having the same date) - * the CSV records are normally in reverse chronological order (newest - at the top) - * and you care about preserving the order of same-day transactions +2022-10-01, txn 3... +2022-10-01, txn 2... +2022-10-01, txn 1... - then, you should add the 'newest-first' rule as a hint. Eg: + you can add the 'newest-first' rule to help hledger generate the +transactions in correct order. -# tell hledger explicitly that the CSV is normally newest first +# same-day CSV records are newest first newest-first  -File: hledger.info, Node: include, Next: balance-type, Prev: newest-first, Up: CSV rules +File: hledger.info, Node: intra-day-reversed, Next: include, Prev: newest-first, Up: CSV rules -13.2.13 'include' +13.2.13 'intra-day-reversed' +---------------------------- + +CSV records for each day are sometimes ordered in reverse compared to +the overall date order. Eg, here dates are newest first, but the +transactions on each date are oldest first: + +2022-10-02, txn 3... +2022-10-02, txn 4... +2022-10-01, txn 1... +2022-10-01, txn 2... + + In this situation, add the 'intra-day-reversed' rule, and hledger +will compensate, improving the order of transactions. + +# transactions within each day are reversed with respect to the overall date order +intra-day-reversed + + +File: hledger.info, Node: include, Next: balance-type, Prev: intra-day-reversed, Up: CSV rules + +13.2.14 'include' ----------------- include RULESFILE @@ -8599,7 +8657,7 @@ include categorisation.rules  File: hledger.info, Node: balance-type, Prev: include, Up: CSV rules -13.2.14 'balance-type' +13.2.15 'balance-type' ---------------------- Balance assertions generated by assigning to balanceN are of the simple @@ -9730,558 +9788,562 @@ $ LANG=en_US.UTF-8 hledger -f my.journal print  Tag Table: Node: Top208 -Node: OPTIONS2602 -Ref: #options2703 -Node: General options2845 -Ref: #general-options2970 -Node: Command options7183 -Ref: #command-options7334 -Node: Command arguments7734 -Ref: #command-arguments7892 -Node: Special characters8772 -Ref: #special-characters8935 -Node: Single escaping shell metacharacters9098 -Ref: #single-escaping-shell-metacharacters9339 -Node: Double escaping regular expression metacharacters9942 -Ref: #double-escaping-regular-expression-metacharacters10253 -Node: Triple escaping for add-on commands10779 -Ref: #triple-escaping-for-add-on-commands11039 -Node: Less escaping11683 -Ref: #less-escaping11837 -Node: Unicode characters12161 -Ref: #unicode-characters12326 -Node: Regular expressions13738 -Ref: #regular-expressions13878 -Node: ENVIRONMENT15614 -Ref: #environment15730 -Node: DATA FILES17299 -Ref: #data-files17418 -Node: Data formats17961 -Ref: #data-formats18079 -Node: Multiple files19473 -Ref: #multiple-files19615 -Node: Strict mode20084 -Ref: #strict-mode20199 -Node: TIME PERIODS20923 -Ref: #time-periods21040 -Node: Smart dates21138 -Ref: #smart-dates21264 -Node: Report start & end date23094 -Ref: #report-start-end-date23269 -Node: Report intervals24936 -Ref: #report-intervals25104 -Node: Period expressions26843 -Ref: #period-expressions26983 -Node: Period expressions with a report interval28714 -Ref: #period-expressions-with-a-report-interval28946 -Node: More complex report intervals30027 -Ref: #more-complex-report-intervals30276 -Node: Intervals with custom start date30916 -Ref: #intervals-with-custom-start-date31148 -Node: Periods or dates ?32722 -Ref: #periods-or-dates32924 -Node: Events on multiple weekdays33366 -Ref: #events-on-multiple-weekdays33545 -Node: DEPTH34408 -Ref: #depth34508 -Node: QUERIES34842 -Ref: #queries34938 -Node: Query types35879 -Ref: #query-types35998 -Node: Combining query terms39172 -Ref: #combining-query-terms39347 -Node: Queries and command options40150 -Ref: #queries-and-command-options40353 -Node: Queries and account aliases40602 -Ref: #queries-and-account-aliases40805 -Node: Queries and valuation40925 -Ref: #queries-and-valuation41118 -Node: Querying with account aliases41347 -Ref: #querying-with-account-aliases41556 -Node: Querying with cost or value41686 -Ref: #querying-with-cost-or-value41861 -Node: COST42162 -Ref: #cost42256 -Node: -B Convert to cost43450 -Ref: #b-convert-to-cost43594 -Node: Equity conversion postings45022 -Ref: #equity-conversion-postings45224 -Node: Inferring equity postings from cost45851 -Ref: #inferring-equity-postings-from-cost46088 -Node: Inferring cost from equity postings47077 -Ref: #inferring-cost-from-equity-postings47313 -Node: When to infer cost/equity49538 -Ref: #when-to-infer-costequity49744 -Node: How to record conversions50140 -Ref: #how-to-record-conversions50320 -Node: Conversion with implicit cost50611 -Ref: #conversion-with-implicit-cost50814 -Node: Conversion with explicit cost51691 -Ref: #conversion-with-explicit-cost51934 -Node: Conversion with equity postings52351 -Ref: #conversion-with-equity-postings52618 -Node: Conversion with equity postings and explicit cost53437 -Ref: #conversion-with-equity-postings-and-explicit-cost53702 -Node: Cost tips54307 -Ref: #cost-tips54421 -Node: VALUATION55150 -Ref: #valuation55255 -Node: -V Value56022 -Ref: #v-value56146 -Node: -X Value in specified commodity56341 -Ref: #x-value-in-specified-commodity56534 -Node: Valuation date56683 -Ref: #valuation-date56845 -Node: Market prices57282 -Ref: #market-prices57464 -Node: --infer-market-prices market prices from transactions58647 -Ref: #infer-market-prices-market-prices-from-transactions58914 -Node: Valuation commodity60798 -Ref: #valuation-commodity61009 -Node: Simple valuation examples62235 -Ref: #simple-valuation-examples62431 -Node: --value Flexible valuation63090 -Ref: #value-flexible-valuation63292 -Node: More valuation examples64936 -Ref: #more-valuation-examples65143 -Node: Interaction of valuation and queries67142 -Ref: #interaction-of-valuation-and-queries67381 -Node: Effect of valuation on reports67853 -Ref: #effect-of-valuation-on-reports68048 -Node: PIVOTING75745 -Ref: #pivoting75850 -Node: OUTPUT77536 -Ref: #output77638 -Node: Output destination77729 -Ref: #output-destination77863 -Node: Output styling78520 -Ref: #output-styling78668 -Node: Output format79425 -Ref: #output-format79569 -Node: CSV output80933 -Ref: #csv-output81051 -Node: HTML output81154 -Ref: #html-output81294 -Node: JSON output81388 -Ref: #json-output81528 -Node: SQL output82445 -Ref: #sql-output82563 -Node: Commodity styles83064 -Ref: #commodity-styles83191 -Node: COMMANDS83967 -Ref: #commands84079 -Node: accounts87333 -Ref: #accounts87433 -Node: activity88585 -Ref: #activity88697 -Node: add89080 -Ref: #add89183 -Node: aregister91991 -Ref: #aregister92105 -Node: aregister and custom posting dates94774 -Ref: #aregister-and-custom-posting-dates94940 -Node: balance95492 -Ref: #balance95611 -Node: balance features96604 -Ref: #balance-features96744 -Node: Simple balance report98668 -Ref: #simple-balance-report98850 -Node: Filtered balance report100330 -Ref: #filtered-balance-report100517 -Node: List or tree mode100844 -Ref: #list-or-tree-mode101012 -Node: Depth limiting102357 -Ref: #depth-limiting102523 -Node: Dropping top-level accounts103124 -Ref: #dropping-top-level-accounts103326 -Node: Multi-period balance report103636 -Ref: #multi-period-balance-report103849 -Node: Showing declared accounts106124 -Ref: #showing-declared-accounts106317 -Node: Data layout106848 -Ref: #data-layout107003 -Node: Sorting by amount114943 -Ref: #sorting-by-amount115098 -Node: Percentages115768 -Ref: #percentages115926 -Node: Balance change end balance116887 -Ref: #balance-change-end-balance117080 -Node: Balance report types118508 -Ref: #balance-report-types118698 -Node: Useful balance reports122977 -Ref: #useful-balance-reports123158 -Node: Budget report124243 -Ref: #budget-report124427 -Node: Budget report start date129702 -Ref: #budget-report-start-date129880 -Node: Budgets and subaccounts131212 -Ref: #budgets-and-subaccounts131419 -Node: Selecting budget goals134859 -Ref: #selecting-budget-goals135031 -Node: Customising single-period balance reports136065 -Ref: #customising-single-period-balance-reports136274 -Node: balancesheet138449 -Ref: #balancesheet138587 -Node: balancesheetequity139915 -Ref: #balancesheetequity140066 -Node: cashflow141469 -Ref: #cashflow141593 -Node: check143025 -Ref: #check143130 -Node: Basic checks143938 -Ref: #basic-checks144056 -Node: Strict checks144607 -Ref: #strict-checks144748 -Node: Other checks145184 -Ref: #other-checks145324 -Node: Custom checks145823 -Ref: #custom-checks145978 -Node: More about specific checks146395 -Ref: #more-about-specific-checks146555 -Node: close147283 -Ref: #close147387 -Node: close and prices149478 -Ref: #close-and-prices149607 -Node: close date150002 -Ref: #close-date150186 -Node: Example close asset/liability accounts for file transition150943 -Ref: #example-close-assetliability-accounts-for-file-transition151244 -Node: Hiding opening/closing transactions152103 -Ref: #hiding-openingclosing-transactions152374 -Node: close and balance assertions153751 -Ref: #close-and-balance-assertions154009 -Node: Example close revenue/expense accounts to retained earnings155363 -Ref: #example-close-revenueexpense-accounts-to-retained-earnings155641 -Node: codes156531 -Ref: #codes156641 -Node: commodities157353 -Ref: #commodities157482 -Node: descriptions157564 -Ref: #descriptions157694 -Node: diff157998 -Ref: #diff158106 -Node: files159153 -Ref: #files159255 -Node: help159402 -Ref: #help159504 -Node: import160455 -Ref: #import160571 -Node: Deduplication161664 -Ref: #deduplication161789 -Node: Import testing163683 -Ref: #import-testing163848 -Node: Importing balance assignments164336 -Ref: #importing-balance-assignments164542 -Node: Commodity display styles165191 -Ref: #commodity-display-styles165364 -Node: incomestatement165493 -Ref: #incomestatement165628 -Node: notes166960 -Ref: #notes167075 -Node: payees167443 -Ref: #payees167551 -Node: prices168077 -Ref: #prices168185 -Node: print168554 -Ref: #print168666 -Node: print-unique174034 -Ref: #print-unique174162 -Node: register174447 -Ref: #register174576 -Node: Custom register output179326 -Ref: #custom-register-output179457 -Node: register-match180794 -Ref: #register-match180930 -Node: rewrite181281 -Ref: #rewrite181398 -Node: Re-write rules in a file183304 -Ref: #re-write-rules-in-a-file183467 -Node: Diff output format184616 -Ref: #diff-output-format184799 -Node: rewrite vs print --auto185891 -Ref: #rewrite-vs.-print---auto186051 -Node: roi186607 -Ref: #roi186707 -Node: Spaces and special characters in --inv and --pnl188432 -Ref: #spaces-and-special-characters-in---inv-and---pnl188672 -Node: Semantics of --inv and --pnl189160 -Ref: #semantics-of---inv-and---pnl189399 -Node: IRR and TWR explained191249 -Ref: #irr-and-twr-explained191409 -Node: stats194495 -Ref: #stats194596 -Node: tags195976 -Ref: #tags196076 -Node: test197090 -Ref: #test197200 -Node: Add-on commands197947 -Ref: #add-on-commands198066 -Node: JOURNAL FORMAT199197 -Ref: #journal-format199325 -Node: Transactions201552 -Ref: #transactions201667 -Node: Dates202681 -Ref: #dates202797 -Node: Simple dates202862 -Ref: #simple-dates202982 -Node: Secondary dates203491 -Ref: #secondary-dates203639 -Node: Posting dates204975 -Ref: #posting-dates205098 -Node: Status206470 -Ref: #status206580 -Node: Code208288 -Ref: #code208400 -Node: Description208632 -Ref: #description208760 -Node: Payee and note209080 -Ref: #payee-and-note209188 -Node: Comments209523 -Ref: #comments209645 -Node: Tags210839 -Ref: #tags-1210950 -Node: Postings212405 -Ref: #postings212529 -Node: Virtual postings213555 -Ref: #virtual-postings213666 -Node: Account names214971 -Ref: #account-names215108 -Node: Amounts215596 -Ref: #amounts215733 -Node: Decimal marks digit group marks216718 -Ref: #decimal-marks-digit-group-marks216895 -Node: Commodity217916 -Ref: #commodity218105 -Node: Directives influencing number parsing and display219057 -Ref: #directives-influencing-number-parsing-and-display219318 -Node: Commodity display style219811 -Ref: #commodity-display-style220019 -Node: Rounding222214 -Ref: #rounding222334 -Node: Transaction prices222746 -Ref: #transaction-prices222912 -Node: Lot prices lot dates224835 -Ref: #lot-prices-lot-dates225018 -Node: Balance assertions225506 -Ref: #balance-assertions225684 -Node: Assertions and ordering226757 -Ref: #assertions-and-ordering226948 -Node: Assertions and multiple included files227648 -Ref: #assertions-and-multiple-included-files227910 -Node: Assertions and multiple -f files228410 -Ref: #assertions-and-multiple--f-files228663 -Node: Assertions and commodities229060 -Ref: #assertions-and-commodities229284 -Node: Assertions and prices230464 -Ref: #assertions-and-prices230672 -Node: Assertions and subaccounts231112 -Ref: #assertions-and-subaccounts231335 -Node: Assertions and virtual postings231659 -Ref: #assertions-and-virtual-postings231899 -Node: Assertions and auto postings232031 -Ref: #assertions-and-auto-postings232263 -Node: Assertions and precision232908 -Ref: #assertions-and-precision233092 -Node: Balance assignments233359 -Ref: #balance-assignments233529 -Node: Balance assignments and prices234693 -Ref: #balance-assignments-and-prices234859 -Node: Directives235083 -Ref: #directives235246 -Node: Directives and multiple files239738 -Ref: #directives-and-multiple-files239934 -Node: Comment blocks240626 -Ref: #comment-blocks240803 -Node: Including other files240979 -Ref: #including-other-files241153 -Node: Default year242077 -Ref: #default-year242235 -Node: Declaring payees242642 -Ref: #declaring-payees242813 -Node: Declaring the decimal mark243059 -Ref: #declaring-the-decimal-mark243259 -Node: Declaring commodities243656 -Ref: #declaring-commodities243847 -Node: Commodity error checking246365 -Ref: #commodity-error-checking246515 -Node: Default commodity247030 -Ref: #default-commodity247210 -Node: Declaring market prices248326 -Ref: #declaring-market-prices248515 -Node: Declaring accounts249328 -Ref: #declaring-accounts249508 -Node: Account comments250672 -Ref: #account-comments250825 -Node: Account subdirectives251248 -Ref: #account-subdirectives251442 -Node: Account error checking251584 -Ref: #account-error-checking251785 -Node: Account display order252974 -Ref: #account-display-order253165 -Node: Account types254266 -Ref: #account-types254410 -Node: Rewriting accounts258084 -Ref: #rewriting-accounts258263 -Node: Basic aliases259303 -Ref: #basic-aliases259439 -Node: Regex aliases260183 -Ref: #regex-aliases260345 -Node: Combining aliases261235 -Ref: #combining-aliases261418 -Node: Aliases and multiple files262694 -Ref: #aliases-and-multiple-files262893 -Node: end aliases263472 -Ref: #end-aliases263666 -Node: Aliases can generate bad account names263815 -Ref: #aliases-can-generate-bad-account-names264058 -Node: Aliases and account types264643 -Ref: #aliases-and-account-types264840 -Node: Default parent account265536 -Ref: #default-parent-account265726 -Node: Periodic transactions266610 -Ref: #periodic-transactions266793 -Node: Periodic rule syntax268748 -Ref: #periodic-rule-syntax268928 -Node: Periodic rules and relative dates269387 -Ref: #periodic-rules-and-relative-dates269655 -Node: Two spaces between period expression and description!270166 -Ref: #two-spaces-between-period-expression-and-description270492 -Node: Forecasting with periodic transactions271176 -Ref: #forecasting-with-periodic-transactions271475 -Node: Budgeting with periodic transactions274246 -Ref: #budgeting-with-periodic-transactions274479 -Node: Auto postings274888 -Ref: #auto-postings275024 -Node: Auto postings and multiple files277203 -Ref: #auto-postings-and-multiple-files277401 -Node: Auto postings and dates277610 -Ref: #auto-postings-and-dates277878 -Node: Auto postings and transaction balancing / inferred amounts / balance assertions278053 -Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions278398 -Node: Auto posting tags278901 -Ref: #auto-posting-tags279110 -Node: CSV FORMAT279746 -Ref: #csv-format279874 -Node: Examples282504 -Ref: #examples282607 -Node: Basic282815 -Ref: #basic282917 -Node: Bank of Ireland283459 -Ref: #bank-of-ireland283596 -Node: Amazon285058 -Ref: #amazon285178 -Node: Paypal286897 -Ref: #paypal286993 -Node: CSV rules294637 -Ref: #csv-rules294755 -Node: skip295101 -Ref: #skip295201 -Node: fields list295576 -Ref: #fields-list295715 -Node: field assignment297281 -Ref: #field-assignment297433 -Node: Field names298468 -Ref: #field-names298608 -Node: date field298988 -Ref: #date-field299108 -Node: date2 field299156 -Ref: #date2-field299299 -Node: status field299355 -Ref: #status-field299500 -Node: code field299549 -Ref: #code-field299696 -Node: description field299741 -Ref: #description-field299903 -Node: comment field299962 -Ref: #comment-field300119 -Node: account field300430 -Ref: #account-field300582 -Node: amount field301157 -Ref: #amount-field301308 -Node: currency field302553 -Ref: #currency-field302708 -Node: balance field302965 -Ref: #balance-field303099 -Node: separator303471 -Ref: #separator303603 -Node: if block304143 -Ref: #if-block304270 -Node: Matching the whole record304671 -Ref: #matching-the-whole-record304848 -Node: Matching individual fields305651 -Ref: #matching-individual-fields305857 -Node: Combining matchers306081 -Ref: #combining-matchers306279 -Node: Rules applied on successful match306592 -Ref: #rules-applied-on-successful-match306785 -Node: if table307439 -Ref: #if-table307560 -Node: end309298 -Ref: #end309412 -Node: date-format309636 -Ref: #date-format309766 -Node: timezone310490 -Ref: #timezone310625 -Node: decimal-mark311626 -Ref: #decimal-mark311770 -Node: newest-first312109 -Ref: #newest-first312252 -Node: include312935 -Ref: #include313068 -Node: balance-type313512 -Ref: #balance-type313634 -Node: Tips314334 -Ref: #tips314425 -Node: Rapid feedback314724 -Ref: #rapid-feedback314843 -Node: Valid CSV315295 -Ref: #valid-csv315427 -Node: File Extension315619 -Ref: #file-extension315773 -Node: Reading multiple CSV files316202 -Ref: #reading-multiple-csv-files316389 -Node: Valid transactions316630 -Ref: #valid-transactions316810 -Node: Deduplicating importing317438 -Ref: #deduplicating-importing317619 -Node: Setting amounts318655 -Ref: #setting-amounts318812 -Node: Amount signs321256 -Ref: #amount-signs321410 -Node: Setting currency/commodity322097 -Ref: #setting-currencycommodity322285 -Node: Amount decimal places323459 -Ref: #amount-decimal-places323651 -Node: Referencing other fields323963 -Ref: #referencing-other-fields324162 -Node: How CSV rules are evaluated325059 -Ref: #how-csv-rules-are-evaluated325234 -Node: TIMECLOCK FORMAT326685 -Ref: #timeclock-format326825 -Node: TIMEDOT FORMAT328886 -Ref: #timedot-format329024 -Node: COMMON TASKS333586 -Ref: #common-tasks333715 -Node: Getting help333989 -Ref: #getting-help334123 -Node: Constructing command lines334875 -Ref: #constructing-command-lines335069 -Node: Starting a journal file335766 -Ref: #starting-a-journal-file335966 -Node: Setting opening balances337154 -Ref: #setting-opening-balances337352 -Node: Recording transactions340493 -Ref: #recording-transactions340675 -Node: Reconciling341231 -Ref: #reconciling341376 -Node: Reporting343633 -Ref: #reporting343775 -Node: Migrating to a new file347760 -Ref: #migrating-to-a-new-file347910 -Node: LIMITATIONS348209 -Ref: #limitations348337 -Node: TROUBLESHOOTING349106 -Ref: #troubleshooting349221 +Node: OPTIONS2597 +Ref: #options2698 +Node: General options2840 +Ref: #general-options2965 +Node: Command options7178 +Ref: #command-options7329 +Node: Command arguments7729 +Ref: #command-arguments7887 +Node: Special characters8767 +Ref: #special-characters8930 +Node: Single escaping shell metacharacters9093 +Ref: #single-escaping-shell-metacharacters9334 +Node: Double escaping regular expression metacharacters9937 +Ref: #double-escaping-regular-expression-metacharacters10248 +Node: Triple escaping for add-on commands10774 +Ref: #triple-escaping-for-add-on-commands11034 +Node: Less escaping11678 +Ref: #less-escaping11832 +Node: Unicode characters12156 +Ref: #unicode-characters12321 +Node: Regular expressions13733 +Ref: #regular-expressions13873 +Node: ENVIRONMENT15609 +Ref: #environment15720 +Node: INPUT17289 +Ref: #input17387 +Node: Data formats17930 +Ref: #data-formats18043 +Node: Multiple files19437 +Ref: #multiple-files19574 +Node: Strict mode20043 +Ref: #strict-mode20153 +Node: OUTPUT20877 +Ref: #output20978 +Node: Output destination21153 +Ref: #output-destination21285 +Node: Output styling21710 +Ref: #output-styling21856 +Node: Output format22613 +Ref: #output-format22755 +Node: CSV output24119 +Ref: #csv-output24235 +Node: HTML output24338 +Ref: #html-output24476 +Node: JSON output24570 +Ref: #json-output24708 +Node: SQL output25625 +Ref: #sql-output25741 +Node: Commodity styles26242 +Ref: #commodity-styles26388 +Node: Debug output27164 +Ref: #debug-output27280 +Node: TIME PERIODS27946 +Ref: #time-periods28059 +Node: Smart dates28157 +Ref: #smart-dates28283 +Node: Report start & end date30113 +Ref: #report-start-end-date30288 +Node: Report intervals31955 +Ref: #report-intervals32123 +Node: Period expressions33862 +Ref: #period-expressions34002 +Node: Period expressions with a report interval35733 +Ref: #period-expressions-with-a-report-interval35965 +Node: More complex report intervals37046 +Ref: #more-complex-report-intervals37295 +Node: Intervals with custom start date37935 +Ref: #intervals-with-custom-start-date38167 +Node: Periods or dates ?39741 +Ref: #periods-or-dates39943 +Node: Events on multiple weekdays40385 +Ref: #events-on-multiple-weekdays40564 +Node: DEPTH41427 +Ref: #depth41527 +Node: QUERIES41861 +Ref: #queries41957 +Node: Query types42898 +Ref: #query-types43017 +Node: Combining query terms46191 +Ref: #combining-query-terms46366 +Node: Queries and command options47169 +Ref: #queries-and-command-options47372 +Node: Queries and account aliases47621 +Ref: #queries-and-account-aliases47824 +Node: Queries and valuation47944 +Ref: #queries-and-valuation48137 +Node: Querying with account aliases48366 +Ref: #querying-with-account-aliases48575 +Node: Querying with cost or value48705 +Ref: #querying-with-cost-or-value48880 +Node: COST49181 +Ref: #cost49275 +Node: -B Convert to cost50469 +Ref: #b-convert-to-cost50613 +Node: Equity conversion postings52041 +Ref: #equity-conversion-postings52243 +Node: Inferring equity postings from cost52870 +Ref: #inferring-equity-postings-from-cost53107 +Node: Inferring cost from equity postings54096 +Ref: #inferring-cost-from-equity-postings54332 +Node: When to infer cost/equity56557 +Ref: #when-to-infer-costequity56763 +Node: How to record conversions57159 +Ref: #how-to-record-conversions57339 +Node: Conversion with implicit cost57630 +Ref: #conversion-with-implicit-cost57833 +Node: Conversion with explicit cost58710 +Ref: #conversion-with-explicit-cost58953 +Node: Conversion with equity postings59370 +Ref: #conversion-with-equity-postings59637 +Node: Conversion with equity postings and explicit cost60456 +Ref: #conversion-with-equity-postings-and-explicit-cost60721 +Node: Cost tips61326 +Ref: #cost-tips61440 +Node: VALUATION62169 +Ref: #valuation62274 +Node: -V Value63041 +Ref: #v-value63165 +Node: -X Value in specified commodity63360 +Ref: #x-value-in-specified-commodity63553 +Node: Valuation date63702 +Ref: #valuation-date63864 +Node: Market prices64301 +Ref: #market-prices64483 +Node: --infer-market-prices market prices from transactions65666 +Ref: #infer-market-prices-market-prices-from-transactions65933 +Node: Valuation commodity67817 +Ref: #valuation-commodity68028 +Node: Simple valuation examples69254 +Ref: #simple-valuation-examples69450 +Node: --value Flexible valuation70109 +Ref: #value-flexible-valuation70311 +Node: More valuation examples71955 +Ref: #more-valuation-examples72162 +Node: Interaction of valuation and queries74161 +Ref: #interaction-of-valuation-and-queries74400 +Node: Effect of valuation on reports74872 +Ref: #effect-of-valuation-on-reports75067 +Node: PIVOTING82764 +Ref: #pivoting82873 +Node: COMMANDS84559 +Ref: #commands84673 +Node: accounts87927 +Ref: #accounts88027 +Node: activity89923 +Ref: #activity90035 +Node: add90418 +Ref: #add90521 +Node: aregister93329 +Ref: #aregister93443 +Node: aregister and custom posting dates96112 +Ref: #aregister-and-custom-posting-dates96278 +Node: balance96830 +Ref: #balance96949 +Node: balance features97942 +Ref: #balance-features98082 +Node: Simple balance report100006 +Ref: #simple-balance-report100188 +Node: Filtered balance report101668 +Ref: #filtered-balance-report101855 +Node: List or tree mode102182 +Ref: #list-or-tree-mode102350 +Node: Depth limiting103695 +Ref: #depth-limiting103861 +Node: Dropping top-level accounts104462 +Ref: #dropping-top-level-accounts104664 +Node: Multi-period balance report104974 +Ref: #multi-period-balance-report105187 +Node: Showing declared accounts107462 +Ref: #showing-declared-accounts107655 +Node: Data layout108186 +Ref: #data-layout108341 +Node: Sorting by amount116281 +Ref: #sorting-by-amount116436 +Node: Percentages117106 +Ref: #percentages117264 +Node: Balance change end balance118225 +Ref: #balance-change-end-balance118418 +Node: Balance report types119846 +Ref: #balance-report-types120036 +Node: Useful balance reports124315 +Ref: #useful-balance-reports124496 +Node: Budget report125581 +Ref: #budget-report125765 +Node: Budget report start date131040 +Ref: #budget-report-start-date131218 +Node: Budgets and subaccounts132550 +Ref: #budgets-and-subaccounts132757 +Node: Selecting budget goals136197 +Ref: #selecting-budget-goals136369 +Node: Customising single-period balance reports137403 +Ref: #customising-single-period-balance-reports137612 +Node: balancesheet139787 +Ref: #balancesheet139925 +Node: balancesheetequity141253 +Ref: #balancesheetequity141404 +Node: cashflow142807 +Ref: #cashflow142931 +Node: check144363 +Ref: #check144468 +Node: Basic checks145276 +Ref: #basic-checks145394 +Node: Strict checks145945 +Ref: #strict-checks146086 +Node: Other checks146522 +Ref: #other-checks146662 +Node: Custom checks147161 +Ref: #custom-checks147316 +Node: More about specific checks147733 +Ref: #more-about-specific-checks147893 +Node: close148621 +Ref: #close148725 +Node: close and prices150816 +Ref: #close-and-prices150945 +Node: close date151340 +Ref: #close-date151524 +Node: Example close asset/liability accounts for file transition152281 +Ref: #example-close-assetliability-accounts-for-file-transition152582 +Node: Hiding opening/closing transactions153441 +Ref: #hiding-openingclosing-transactions153712 +Node: close and balance assertions155089 +Ref: #close-and-balance-assertions155347 +Node: Example close revenue/expense accounts to retained earnings156701 +Ref: #example-close-revenueexpense-accounts-to-retained-earnings156979 +Node: codes157869 +Ref: #codes157979 +Node: commodities158691 +Ref: #commodities158820 +Node: descriptions158902 +Ref: #descriptions159032 +Node: diff159336 +Ref: #diff159444 +Node: files160491 +Ref: #files160593 +Node: help160740 +Ref: #help160842 +Node: import161793 +Ref: #import161909 +Node: Deduplication163002 +Ref: #deduplication163127 +Node: Import testing165021 +Ref: #import-testing165186 +Node: Importing balance assignments165674 +Ref: #importing-balance-assignments165880 +Node: Commodity display styles166529 +Ref: #commodity-display-styles166702 +Node: incomestatement166831 +Ref: #incomestatement166966 +Node: notes168298 +Ref: #notes168413 +Node: payees168781 +Ref: #payees168889 +Node: prices169415 +Ref: #prices169523 +Node: print169892 +Ref: #print170004 +Node: print-unique175372 +Ref: #print-unique175500 +Node: register175785 +Ref: #register175914 +Node: Custom register output180664 +Ref: #custom-register-output180795 +Node: register-match182132 +Ref: #register-match182268 +Node: rewrite182619 +Ref: #rewrite182736 +Node: Re-write rules in a file184642 +Ref: #re-write-rules-in-a-file184805 +Node: Diff output format185954 +Ref: #diff-output-format186137 +Node: rewrite vs print --auto187229 +Ref: #rewrite-vs.-print---auto187389 +Node: roi187945 +Ref: #roi188045 +Node: Spaces and special characters in --inv and --pnl189770 +Ref: #spaces-and-special-characters-in---inv-and---pnl190010 +Node: Semantics of --inv and --pnl190498 +Ref: #semantics-of---inv-and---pnl190737 +Node: IRR and TWR explained192587 +Ref: #irr-and-twr-explained192747 +Node: stats195833 +Ref: #stats195934 +Node: tags197314 +Ref: #tags197414 +Node: test198428 +Ref: #test198538 +Node: Add-on commands199285 +Ref: #add-on-commands199404 +Node: JOURNAL FORMAT200535 +Ref: #journal-format200663 +Node: Transactions202890 +Ref: #transactions203005 +Node: Dates204019 +Ref: #dates204135 +Node: Simple dates204200 +Ref: #simple-dates204320 +Node: Secondary dates204829 +Ref: #secondary-dates204977 +Node: Posting dates206313 +Ref: #posting-dates206436 +Node: Status207808 +Ref: #status207918 +Node: Code209626 +Ref: #code209738 +Node: Description209970 +Ref: #description210098 +Node: Payee and note210418 +Ref: #payee-and-note210526 +Node: Comments210861 +Ref: #comments210983 +Node: Tags212177 +Ref: #tags-1212288 +Node: Postings213743 +Ref: #postings213867 +Node: Virtual postings214893 +Ref: #virtual-postings215004 +Node: Account names216309 +Ref: #account-names216446 +Node: Amounts216934 +Ref: #amounts217071 +Node: Decimal marks digit group marks218056 +Ref: #decimal-marks-digit-group-marks218233 +Node: Commodity219254 +Ref: #commodity219443 +Node: Directives influencing number parsing and display220395 +Ref: #directives-influencing-number-parsing-and-display220656 +Node: Commodity display style221149 +Ref: #commodity-display-style221357 +Node: Rounding223552 +Ref: #rounding223672 +Node: Transaction prices224084 +Ref: #transaction-prices224250 +Node: Lot prices lot dates226173 +Ref: #lot-prices-lot-dates226356 +Node: Balance assertions226844 +Ref: #balance-assertions227022 +Node: Assertions and ordering228095 +Ref: #assertions-and-ordering228286 +Node: Assertions and multiple included files228986 +Ref: #assertions-and-multiple-included-files229248 +Node: Assertions and multiple -f files229748 +Ref: #assertions-and-multiple--f-files230001 +Node: Assertions and commodities230398 +Ref: #assertions-and-commodities230622 +Node: Assertions and prices231802 +Ref: #assertions-and-prices232010 +Node: Assertions and subaccounts232450 +Ref: #assertions-and-subaccounts232673 +Node: Assertions and virtual postings232997 +Ref: #assertions-and-virtual-postings233237 +Node: Assertions and auto postings233369 +Ref: #assertions-and-auto-postings233601 +Node: Assertions and precision234246 +Ref: #assertions-and-precision234430 +Node: Balance assignments234697 +Ref: #balance-assignments234867 +Node: Balance assignments and prices236031 +Ref: #balance-assignments-and-prices236197 +Node: Directives236421 +Ref: #directives236584 +Node: Directives and multiple files241076 +Ref: #directives-and-multiple-files241272 +Node: Comment blocks241964 +Ref: #comment-blocks242141 +Node: Including other files242317 +Ref: #including-other-files242491 +Node: Default year243415 +Ref: #default-year243573 +Node: Declaring payees243980 +Ref: #declaring-payees244151 +Node: Declaring the decimal mark244397 +Ref: #declaring-the-decimal-mark244597 +Node: Declaring commodities244994 +Ref: #declaring-commodities245185 +Node: Commodity error checking247703 +Ref: #commodity-error-checking247853 +Node: Default commodity248368 +Ref: #default-commodity248548 +Node: Declaring market prices249664 +Ref: #declaring-market-prices249853 +Node: Declaring accounts250666 +Ref: #declaring-accounts250846 +Node: Account comments252010 +Ref: #account-comments252163 +Node: Account subdirectives252586 +Ref: #account-subdirectives252780 +Node: Account error checking252922 +Ref: #account-error-checking253123 +Node: Account display order254312 +Ref: #account-display-order254503 +Node: Account types255604 +Ref: #account-types255748 +Node: Rewriting accounts259422 +Ref: #rewriting-accounts259601 +Node: Basic aliases260641 +Ref: #basic-aliases260777 +Node: Regex aliases261521 +Ref: #regex-aliases261683 +Node: Combining aliases262573 +Ref: #combining-aliases262756 +Node: Aliases and multiple files264032 +Ref: #aliases-and-multiple-files264231 +Node: end aliases264810 +Ref: #end-aliases265004 +Node: Aliases can generate bad account names265153 +Ref: #aliases-can-generate-bad-account-names265396 +Node: Aliases and account types265981 +Ref: #aliases-and-account-types266178 +Node: Default parent account266874 +Ref: #default-parent-account267064 +Node: Periodic transactions267948 +Ref: #periodic-transactions268131 +Node: Periodic rule syntax270086 +Ref: #periodic-rule-syntax270266 +Node: Periodic rules and relative dates270725 +Ref: #periodic-rules-and-relative-dates270993 +Node: Two spaces between period expression and description!271504 +Ref: #two-spaces-between-period-expression-and-description271830 +Node: Forecasting with periodic transactions272514 +Ref: #forecasting-with-periodic-transactions272813 +Node: Budgeting with periodic transactions275584 +Ref: #budgeting-with-periodic-transactions275817 +Node: Auto postings276226 +Ref: #auto-postings276362 +Node: Auto postings and multiple files278541 +Ref: #auto-postings-and-multiple-files278739 +Node: Auto postings and dates278948 +Ref: #auto-postings-and-dates279216 +Node: Auto postings and transaction balancing / inferred amounts / balance assertions279391 +Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions279736 +Node: Auto posting tags280239 +Ref: #auto-posting-tags280448 +Node: CSV FORMAT281084 +Ref: #csv-format281212 +Node: Examples284038 +Ref: #examples284141 +Node: Basic284349 +Ref: #basic284451 +Node: Bank of Ireland284993 +Ref: #bank-of-ireland285130 +Node: Amazon286592 +Ref: #amazon286712 +Node: Paypal288431 +Ref: #paypal288527 +Node: CSV rules296171 +Ref: #csv-rules296289 +Node: skip296658 +Ref: #skip296758 +Node: fields list297133 +Ref: #fields-list297272 +Node: field assignment298838 +Ref: #field-assignment298990 +Node: Field names300025 +Ref: #field-names300165 +Node: date field300545 +Ref: #date-field300665 +Node: date2 field300713 +Ref: #date2-field300856 +Node: status field300912 +Ref: #status-field301057 +Node: code field301106 +Ref: #code-field301253 +Node: description field301298 +Ref: #description-field301460 +Node: comment field301519 +Ref: #comment-field301676 +Node: account field301987 +Ref: #account-field302139 +Node: amount field302714 +Ref: #amount-field302865 +Node: currency field304110 +Ref: #currency-field304265 +Node: balance field304522 +Ref: #balance-field304656 +Node: separator305028 +Ref: #separator305160 +Node: if block305700 +Ref: #if-block305827 +Node: Matching the whole record306228 +Ref: #matching-the-whole-record306405 +Node: Matching individual fields307208 +Ref: #matching-individual-fields307414 +Node: Combining matchers307638 +Ref: #combining-matchers307836 +Node: Rules applied on successful match308149 +Ref: #rules-applied-on-successful-match308342 +Node: if table308996 +Ref: #if-table309117 +Node: end310855 +Ref: #end310969 +Node: date-format311193 +Ref: #date-format311323 +Node: timezone312047 +Ref: #timezone312182 +Node: decimal-mark313187 +Ref: #decimal-mark313331 +Node: newest-first313670 +Ref: #newest-first313824 +Node: intra-day-reversed314402 +Ref: #intra-day-reversed314563 +Node: include315056 +Ref: #include315195 +Node: balance-type315639 +Ref: #balance-type315761 +Node: Tips316461 +Ref: #tips316552 +Node: Rapid feedback316851 +Ref: #rapid-feedback316970 +Node: Valid CSV317422 +Ref: #valid-csv317554 +Node: File Extension317746 +Ref: #file-extension317900 +Node: Reading multiple CSV files318329 +Ref: #reading-multiple-csv-files318516 +Node: Valid transactions318757 +Ref: #valid-transactions318937 +Node: Deduplicating importing319565 +Ref: #deduplicating-importing319746 +Node: Setting amounts320782 +Ref: #setting-amounts320939 +Node: Amount signs323383 +Ref: #amount-signs323537 +Node: Setting currency/commodity324224 +Ref: #setting-currencycommodity324412 +Node: Amount decimal places325586 +Ref: #amount-decimal-places325778 +Node: Referencing other fields326090 +Ref: #referencing-other-fields326289 +Node: How CSV rules are evaluated327186 +Ref: #how-csv-rules-are-evaluated327361 +Node: TIMECLOCK FORMAT328812 +Ref: #timeclock-format328952 +Node: TIMEDOT FORMAT331013 +Ref: #timedot-format331151 +Node: COMMON TASKS335713 +Ref: #common-tasks335842 +Node: Getting help336116 +Ref: #getting-help336250 +Node: Constructing command lines337002 +Ref: #constructing-command-lines337196 +Node: Starting a journal file337893 +Ref: #starting-a-journal-file338093 +Node: Setting opening balances339281 +Ref: #setting-opening-balances339479 +Node: Recording transactions342620 +Ref: #recording-transactions342802 +Node: Reconciling343358 +Ref: #reconciling343503 +Node: Reporting345760 +Ref: #reporting345902 +Node: Migrating to a new file349887 +Ref: #migrating-to-a-new-file350037 +Node: LIMITATIONS350336 +Ref: #limitations350464 +Node: TROUBLESHOOTING351233 +Ref: #troubleshooting351348  End Tag Table diff --git a/hledger/hledger.txt b/hledger/hledger.txt index fb7d062ac..d67dd4fda 100644 --- a/hledger/hledger.txt +++ b/hledger/hledger.txt @@ -446,7 +446,7 @@ ENVIRONMENT ANSI color codes in terminal output. This is overriden by the --color/--colour option. -DATA FILES +INPUT hledger reads transactions from one or more data files. The default data file is $HOME/.hledger.journal (or on Windows, something like C:\Users\YOURNAME\.hledger.journal). @@ -539,6 +539,141 @@ DATA FILES You can use the check command to run individual checks -- the ones listed above and some more. +OUTPUT + Some of this section may refer to things explained further below. + + Output destination + hledger commands send their output to the terminal by default. You can + of course redirect this, eg into a file, using standard shell syntax: + + $ hledger print > foo.txt + + Some commands (print, register, stats, the balance commands) also pro- + vide the -o/--output-file option, which does the same thing without + needing the shell. Eg: + + $ hledger print -o foo.txt + $ hledger print -o - # write to stdout (the default) + + Output styling + hledger commands can produce colour output when the terminal supports + it. This is controlled by the --color/--colour option: - if the + --color/--colour option is given a value of yes or always (or no or + never), colour will (or will not) be used; - otherwise, if the NO_COLOR + environment variable is set, colour will not be used; - otherwise, + colour will be used if the output (terminal or file) supports it. + + hledger commands can also use unicode box-drawing characters to produce + prettier tables and output. This is controlled by the --pretty option: + - if the --pretty option is given a value of yes or always (or no or + never), unicode characters will (or will not) be used; - otherwise, + unicode characters will not be used. + + Output format + Some commands offer additional output formats, other than the usual + plain text terminal output. Here are those commands and the formats + currently supported: + + + - txt csv html json sql + --------------------------------------------- + aregister Y Y Y + balance Y 1 Y 1 Y 1,2 Y + bal- Y 1 Y 1 Y 1 Y + ancesheet + bal- Y 1 Y 1 Y 1 Y + ancesheete- + quity + cashflow Y 1 Y 1 Y 1 Y + incomes- Y 1 Y 1 Y 1 Y + tatement + print Y Y Y Y + register Y Y Y + + o 1 Also affected by the balance commands' --layout option. + + o 2 balance does not support html output without a report interval or + with --budget. + + The output format is selected by the -O/--output-format=FMT option: + + $ hledger print -O csv # print CSV on stdout + + or by the filename extension of an output file specified with the + -o/--output-file=FILE.FMT option: + + $ hledger balancesheet -o foo.csv # write CSV to foo.csv + + The -O option can be combined with -o to override the file extension, + if needed: + + $ hledger balancesheet -o foo.txt -O csv # write CSV to foo.txt + + CSV output + o In CSV output, digit group marks (such as thousands separators) are + disabled automatically. + + HTML output + o HTML output can be styled by an optional hledger.css file in the same + directory. + + JSON output + o Not yet much used; real-world feedback is welcome. + + o Our JSON is rather large and verbose, as it is quite a faithful rep- + resentation of hledger's internal data types. To understand the + JSON, read the Haskell type definitions, which are mostly in + https://github.com/simonmichael/hledger/blob/master/hledger- + lib/Hledger/Data/Types.hs. + + o hledger represents quantities as Decimal values storing up to 255 + significant digits, eg for repeating decimals. Such numbers can + arise in practice (from automatically-calculated transaction prices), + and would break most JSON consumers. So in JSON, we show quantities + as simple Numbers with at most 10 decimal places. We don't limit the + number of integer digits, but that part is under your control. We + hope this approach will not cause problems in practice; if you find + otherwise, please let us know. (Cf #1195) + + SQL output + o Not yet much used; real-world feedback is welcome. + + o SQL output is expected to work with sqlite, MySQL and PostgreSQL + + o SQL output is structured with the expectations that statements will + be executed in the empty database. If you already have tables cre- + ated via SQL output of hledger, you would probably want to either + clear tables of existing data (via delete or truncate SQL statements) + or drop tables completely as otherwise your postings will be duped. + + Commodity styles + The display style of a commodity/currency is inferred according to the + rules described in Commodity display style. The inferred display style + can be overridden by an optional -c/--commodity-style option (Excep- + tions: as is the case for inferred styles, price amounts, and all + amounts displayed by the print command, will be displayed with all of + their decimal digits visible, regardless of the specified precision). + For example, the following will override the display style for dollars. + + $ hledger print -c '$1.000,0' + + The format specification of the style is identical to the commodity + display style specification for the commodity directive. The command + line option can be supplied repeatedly to override the display style + for multiple commodity/currency symbols. + + Debug output + We aim for hledger to be relatively easy to troubleshoot, introspect + and develop. You can add --debug[=N] to any hledger command line to + see additional debug output. N ranges from 1 (least output, the + default) to 9 (maximum output). Typically you would start with 1 and + increase until you are seeing enough. Debug output goes to stderr, and + is not affected by -o/--output-file (unless you redirect stderr to std- + out, eg: 2>&1). It will be interleaved with normal output, which can + help reveal when parts of the code are evaluated. To capture debug + output in a log file instead, you can usually redirect stderr, eg: + hledger bal --debug=3 2>hledger.log. + TIME PERIODS Smart dates hledger's user interfaces accept a flexible "smart date" syntax. Smart @@ -550,6 +685,7 @@ TIME PERIODS 2004/10/1, 2004-01-01, exact date, several separators allowed. Year 2004.9.1 is 4+ digits, month is 1-12, day is 1-31 + 2004 start of year 2004/10 start of month 10/1 month and day in current year @@ -618,6 +754,7 @@ TIME PERIODS Examples: + -b 2016/3/17 begin on St. Patrick's day 2016 -e 12/1 end at the start of december 1st of the current year (11/30 will be the last date included) @@ -822,10 +959,9 @@ TIME PERIODS Examples: - - -p "every 2nd day of periods will go from Tue to Tue week" + -p "every Tue" same -p "every 15th day" period boundaries will be on 15th of each month @@ -1721,8 +1857,6 @@ VALUATION ments register - - starting bal- cost value at valued at day value at value at ance (-H) report or each historical report or DATE/today journal end posting was made journal end @@ -1731,6 +1865,8 @@ VALUATION with report report or posting was made report or interval journal journal start start + + posting cost value at value at posting value at value at amounts report or date report or DATE/today journal end journal end @@ -1878,137 +2014,11 @@ PIVOTING -------------------- -2 EUR -OUTPUT - Output destination - hledger commands send their output to the terminal by default. You can - of course redirect this, eg into a file, using standard shell syntax: - - $ hledger print > foo.txt - - Some commands (print, register, stats, the balance commands) also pro- - vide the -o/--output-file option, which does the same thing without - needing the shell. Eg: - - $ hledger print -o foo.txt - $ hledger print -o - # write to stdout (the default) - - hledger can optionally produce debug output (if enabled with - --debug=N); this goes to stderr, and is not affected by -o/--output- - file. If you need to capture it, use shell redirects, eg: hledger bal - --debug=3 >file 2>&1. - - Output styling - hledger commands can produce colour output when the terminal supports - it. This is controlled by the --color/--colour option: - if the - --color/--colour option is given a value of yes or always (or no or - never), colour will (or will not) be used; - otherwise, if the NO_COLOR - environment variable is set, colour will not be used; - otherwise, - colour will be used if the output (terminal or file) supports it. - - hledger commands can also use unicode box-drawing characters to produce - prettier tables and output. This is controlled by the --pretty option: - - if the --pretty option is given a value of yes or always (or no or - never), unicode characters will (or will not) be used; - otherwise, - unicode characters will not be used. - - Output format - Some commands offer additional output formats, other than the usual - plain text terminal output. Here are those commands and the formats - currently supported: - - - - txt csv html json sql - --------------------------------------------- - aregister Y Y Y - balance Y 1 Y 1 Y 1,2 Y - bal- Y 1 Y 1 Y 1 Y - ancesheet - bal- Y 1 Y 1 Y 1 Y - ancesheete- - quity - cashflow Y 1 Y 1 Y 1 Y - incomes- Y 1 Y 1 Y 1 Y - tatement - print Y Y Y Y - register Y Y Y - - o 1 Also affected by the balance commands' --layout option. - - o 2 balance does not support html output without a report interval or - with --budget. - - The output format is selected by the -O/--output-format=FMT option: - - $ hledger print -O csv # print CSV on stdout - - or by the filename extension of an output file specified with the - -o/--output-file=FILE.FMT option: - - $ hledger balancesheet -o foo.csv # write CSV to foo.csv - - The -O option can be combined with -o to override the file extension, - if needed: - - $ hledger balancesheet -o foo.txt -O csv # write CSV to foo.txt - - CSV output - o In CSV output, digit group marks (such as thousands separators) are - disabled automatically. - - HTML output - o HTML output can be styled by an optional hledger.css file in the same - directory. - - JSON output - o Not yet much used; real-world feedback is welcome. - - o Our JSON is rather large and verbose, as it is quite a faithful rep- - resentation of hledger's internal data types. To understand the - JSON, read the Haskell type definitions, which are mostly in - https://github.com/simonmichael/hledger/blob/master/hledger- - lib/Hledger/Data/Types.hs. - - o hledger represents quantities as Decimal values storing up to 255 - significant digits, eg for repeating decimals. Such numbers can - arise in practice (from automatically-calculated transaction prices), - and would break most JSON consumers. So in JSON, we show quantities - as simple Numbers with at most 10 decimal places. We don't limit the - number of integer digits, but that part is under your control. We - hope this approach will not cause problems in practice; if you find - otherwise, please let us know. (Cf #1195) - - SQL output - o Not yet much used; real-world feedback is welcome. - - o SQL output is expected to work with sqlite, MySQL and PostgreSQL - - o SQL output is structured with the expectations that statements will - be executed in the empty database. If you already have tables cre- - ated via SQL output of hledger, you would probably want to either - clear tables of existing data (via delete or truncate SQL statements) - or drop tables completely as otherwise your postings will be duped. - - Commodity styles - The display style of a commodity/currency is inferred according to the - rules described in Commodity display style. The inferred display style - can be overridden by an optional -c/--commodity-style option (Excep- - tions: as is the case for inferred styles, price amounts, and all - amounts displayed by the print command, will be displayed with all of - their decimal digits visible, regardless of the specified precision). - For example, the following will override the display style for dollars. - - $ hledger print -c '$1.000,0' - - The format specification of the style is identical to the commodity - display style specification for the commodity directive. The command - line option can be supplied repeatedly to override the display style - for multiple commodity/currency symbols. - COMMANDS - hledger provides a number of commands for producing reports and manag- - ing your data. Run hledger with no arguments to list the commands - available, and hledger CMD to run a command. CMD can be the full com- - mand name, or its standard abbreviation shown in the commands list, or + hledger provides a number of commands for producing reports and manag- + ing your data. Run hledger with no arguments to list the commands + available, and hledger CMD to run a command. CMD can be the full com- + mand name, or its standard abbreviation shown in the commands list, or any unambiguous prefix of the name. Eg: hledger bal. Here are the built-in commands, with the most often-used in bold: @@ -2052,7 +2062,7 @@ COMMANDS o activity - show postings-per-interval bar charts - o balance (bal) - show balance changes/end balances/budgets in any + o balance (bal) - show balance changes/end balances/budgets in any accounts o codes - show transaction codes @@ -2075,10 +2085,10 @@ COMMANDS o print-unique - show only transactions with unique descriptions - o register (reg) - show postings in one or more accounts & running + o register (reg) - show postings in one or more accounts & running total - o register-match - show a recent posting that best matches a descrip- + o register-match - show a recent posting that best matches a descrip- tion o stats - show journal statistics @@ -2090,7 +2100,7 @@ COMMANDS Add-on commands: - Programs or scripts named hledger-SOMETHING in your PATH are add-on + Programs or scripts named hledger-SOMETHING in your PATH are add-on commands; these appear in the commands list with a + mark. The follow- ing add-on commands can be installed, eg by the hledger-install script: @@ -2102,7 +2112,7 @@ COMMANDS o interest - generates interest transactions - o stockquotes - downloads market prices. (Alpha quality, needs your + o stockquotes - downloads market prices. (Alpha quality, needs your help.) Next, the detailed command docs, in alphabetical order. @@ -2111,10 +2121,17 @@ COMMANDS accounts Show account names. - This command lists account names, either declared with account direc- - tives (--declared), posted to (--used), or both (the default). With - query arguments, only matched account names and account names refer- - enced by matched postings are shown. + This command lists account names. By default it shows all known + accounts, either used in transactions or declared with account direc- + tives. + + With query arguments, only matched account names and account names ref- + erenced by matched postings are shown. + + Or it can show just the used accounts (--used/-u), the declared + accounts (--declared/-d), the accounts declared but not used + (--unused), the accounts used but not declared (--undeclared), or the + first account matched by an account name pattern, if any (--find). It shows a flat list by default. With --tree, it uses indentation to show the account hierarchy. In flat mode you can add --drop N to omit @@ -2129,7 +2146,14 @@ COMMANDS order; these may be useful when troubleshooting account display order. With --directives, it adds the account keyword, showing valid account - directives which can be pasted into a journal file. + directives which can be pasted into a journal file. This is useful + together with --undeclared when updating your account declarations to + satisfy hledger check accounts. + + The --find flag can be used to look up a single account name, in the + same way that the aregister command does. It returns the alphanumeri- + cally-first matched account name, or if none can be found, it fails + with a non-zero exit code. Examples: @@ -2143,12 +2167,15 @@ COMMANDS income:salary liabilities:debts + $ hledger accounts --undeclared --directives >> $LEDGER_FILE + $ hledger check accounts + activity activity Show an ascii barchart of posting counts per interval. - The activity command displays an ascii histogram showing transaction - counts by day, week, month or other reporting interval (by day is the + The activity command displays an ascii histogram showing transaction + counts by day, week, month or other reporting interval (by day is the default). With query arguments, it counts only matched transactions. Examples: @@ -2161,25 +2188,25 @@ COMMANDS add add - Prompt for transactions and add them to the journal. Any arguments + Prompt for transactions and add them to the journal. Any arguments will be used as default inputs for the first N prompts. - Many hledger users edit their journals directly with a text editor, or - generate them from CSV. For more interactive data entry, there is the - add command, which prompts interactively on the console for new trans- - actions, and appends them to the main journal file (which should be in - journal format). Existing transactions are not changed. This is one - of the few hledger commands that writes to the journal file (see also + Many hledger users edit their journals directly with a text editor, or + generate them from CSV. For more interactive data entry, there is the + add command, which prompts interactively on the console for new trans- + actions, and appends them to the main journal file (which should be in + journal format). Existing transactions are not changed. This is one + of the few hledger commands that writes to the journal file (see also import). To use it, just run hledger add and follow the prompts. You can add as - many transactions as you like; when you are finished, enter . or press + many transactions as you like; when you are finished, enter . or press control-d or control-c to exit. Features: - o add tries to provide useful defaults, using the most similar (by - description) recent transaction (filtered by the query, if any) as a + o add tries to provide useful defaults, using the most similar (by + description) recent transaction (filtered by the query, if any) as a template. o You can also set the initial defaults with command line arguments. @@ -2187,10 +2214,10 @@ COMMANDS o Readline-style edit keys can be used during data entry. o The tab key will auto-complete whenever possible - accounts, descrip- - tions, dates (yesterday, today, tomorrow). If the input area is + tions, dates (yesterday, today, tomorrow). If the input area is empty, it will insert the default value. - o If the journal defines a default commodity, it will be added to any + o If the journal defines a default commodity, it will be added to any bare numbers entered. o A parenthesised transaction code may be entered following a date. @@ -2199,7 +2226,7 @@ COMMANDS o If you make a mistake, enter < at any prompt to go one step backward. - o Input prompts are displayed in a different colour when the terminal + o Input prompts are displayed in a different colour when the terminal supports it. Example (see https://hledger.org/add.html for a detailed tutorial): @@ -2229,97 +2256,97 @@ COMMANDS Starting the next transaction (. or ctrl-D/ctrl-C to quit) Date [2015/05/22]: $ - On Microsoft Windows, the add command makes sure that no part of the + On Microsoft Windows, the add command makes sure that no part of the file path ends with a period, as that would cause problems (#1056). aregister aregister, areg - Show the transactions and running historical balance of a single + Show the transactions and running historical balance of a single account, with each transaction displayed as one line. aregister shows the overall transactions affecting a particular account - (and any subaccounts). Each report line represents one transaction in - this account. Transactions before the report start date are always + (and any subaccounts). Each report line represents one transaction in + this account. Transactions before the report start date are always included in the running balance (--historical mode is always on). - This is a more "real world", bank-like view than the register command - (which shows individual postings, possibly from multiple accounts, not + This is a more "real world", bank-like view than the register command + (which shows individual postings, possibly from multiple accounts, not necessarily in historical mode). As a quick rule of thumb: - use areg- ister for reviewing and reconciling real-world asset/liability accounts - use register for reviewing detailed revenues/expenses. - aregister requires one argument: the account to report on. You can - write either the full account name, or a case-insensitive regular - expression which will select the alphabetically first matched account. - (Eg if you have assets:aaa:checking and assets:bbb:checking accounts, + aregister requires one argument: the account to report on. You can + write either the full account name, or a case-insensitive regular + expression which will select the alphabetically first matched account. + (Eg if you have assets:aaa:checking and assets:bbb:checking accounts, hledger areg checking would select assets:aaa:checking.) - Transactions involving subaccounts of this account will also be shown. - aregister ignores depth limits, so its final total will always match a + Transactions involving subaccounts of this account will also be shown. + aregister ignores depth limits, so its final total will always match a balance report with similar arguments. - Any additional arguments form a query which will filter the transac- + Any additional arguments form a query which will filter the transac- tions shown. Note some queries will disturb the running balance, caus- ing it to be different from the account's real-world running balance. - An example: this shows the transactions and historical running balance + An example: this shows the transactions and historical running balance during july, in the first account whose name contains "checking": $ hledger areg checking date:jul Each aregister line item shows: - o the transaction's date (or the relevant posting's date if different, + o the transaction's date (or the relevant posting's date if different, see below) - o the names of all the other account(s) involved in this transaction + o the names of all the other account(s) involved in this transaction (probably abbreviated) o the total change to this account's balance from this transaction o the account's historical running balance after this transaction. - Transactions making a net change of zero are not shown by default; add + Transactions making a net change of zero are not shown by default; add the -E/--empty flag to show them. - For performance reasons, column widths are chosen based on the first - 1000 lines; this means unusually wide values in later lines can cause - visual discontinuities as column widths are adjusted. If you want to - ensure perfect alignment, at the cost of more time and memory, use the + For performance reasons, column widths are chosen based on the first + 1000 lines; this means unusually wide values in later lines can cause + visual discontinuities as column widths are adjusted. If you want to + ensure perfect alignment, at the cost of more time and memory, use the --align-all flag. - This command also supports the output destination and output format + This command also supports the output destination and output format options. The output formats supported are txt, csv, and json. aregister and custom posting dates - Transactions whose date is outside the report period can still be - shown, if they have a posting to this account dated inside the report - period. (And in this case it's the posting date that is shown.) This + Transactions whose date is outside the report period can still be + shown, if they have a posting to this account dated inside the report + period. (And in this case it's the posting date that is shown.) This ensures that aregister can show an accurate historical running balance, matching the one shown by register -H with the same arguments. - To filter strictly by transaction date instead, add the --txn-dates - flag. If you use this flag and some of your postings have custom + To filter strictly by transaction date instead, add the --txn-dates + flag. If you use this flag and some of your postings have custom dates, it's probably best to assume the running balance is wrong. balance balance, bal Show accounts and their balances. - balance is one of hledger's oldest and most versatile commands, for - listing account balances, balance changes, values, value changes and + balance is one of hledger's oldest and most versatile commands, for + listing account balances, balance changes, values, value changes and more, during one time period or many. Generally it shows a table, with rows representing accounts, and columns representing periods. - Note there are some higher-level variants of the balance command with - convenient defaults, which can be simpler to use: balancesheet, bal- + Note there are some higher-level variants of the balance command with + convenient defaults, which can be simpler to use: balancesheet, bal- ancesheetequity, cashflow and incomestatement. When you need more con- trol, then use balance. balance features - Here's a quick overview of the balance command's features, followed by - more detailed descriptions and examples. Many of these work with the + Here's a quick overview of the balance command's features, followed by + more detailed descriptions and examples. Many of these work with the higher-level commands as well. balance can show.. @@ -2370,7 +2397,7 @@ COMMANDS ..with.. - o totals (-T), averages (-A), percentages (-%), inverted sign + o totals (-T), averages (-A), percentages (-%), inverted sign (--invert) o rows and columns swapped (--transpose) @@ -2382,21 +2409,21 @@ COMMANDS o commodities displayed on the same line or multiple lines (--layout) This command supports the output destination and output format options, - with output formats txt, csv, json, and (multi-period reports only:) - html. In txt output in a colour-supporting terminal, negative amounts + with output formats txt, csv, json, and (multi-period reports only:) + html. In txt output in a colour-supporting terminal, negative amounts are shown in red. - The --related/-r flag shows the balance of the other postings in the + The --related/-r flag shows the balance of the other postings in the transactions of the postings which would normally be shown. Simple balance report - With no arguments, balance shows a list of all accounts and their - change of balance - ie, the sum of posting amounts, both inflows and - outflows - during the entire period of the journal. For real-world - accounts, this should also match their end balance at the end of the + With no arguments, balance shows a list of all accounts and their + change of balance - ie, the sum of posting amounts, both inflows and + outflows - during the entire period of the journal. For real-world + accounts, this should also match their end balance at the end of the journal period (more on this below). - Accounts are sorted by declaration order if any, and then alphabeti- + Accounts are sorted by declaration order if any, and then alphabeti- cally by account name. For instance (using examples/sample.journal): $ hledger -f examples/sample.journal bal @@ -2411,7 +2438,7 @@ COMMANDS 0 Accounts with a zero balance (and no non-zero subaccounts, in tree mode - - see below) are hidden by default. Use -E/--empty to show them + - see below) are hidden by default. Use -E/--empty to show them (revealing assets:bank:checking here): $ hledger -f examples/sample.journal bal -E @@ -2426,11 +2453,11 @@ COMMANDS -------------------- 0 - The total of the amounts displayed is shown as the last line, unless + The total of the amounts displayed is shown as the last line, unless -N/--no-total is used. Filtered balance report - You can show fewer accounts, a different time period, totals from + You can show fewer accounts, a different time period, totals from cleared transactions only, etc. by using query arguments or options to limit the postings being matched. Eg: @@ -2440,10 +2467,10 @@ COMMANDS $-2 List or tree mode - By default, or with -l/--flat, accounts are shown as a flat list with + By default, or with -l/--flat, accounts are shown as a flat list with their full names visible, as in the examples above. - With -t/--tree, the account hierarchy is shown, with subaccounts' + With -t/--tree, the account hierarchy is shown, with subaccounts' "leaf" names indented below their parent: $ hledger -f examples/sample.journal balance @@ -2463,26 +2490,26 @@ COMMANDS Notes: o "Boring" accounts are combined with their subaccount for more compact - output, unless --no-elide is used. Boring accounts have no balance - of their own and just one subaccount (eg assets:bank and liabilities + output, unless --no-elide is used. Boring accounts have no balance + of their own and just one subaccount (eg assets:bank and liabilities above). - o All balances shown are "inclusive", ie including the balances from - all subaccounts. Note this means some repetition in the output, + o All balances shown are "inclusive", ie including the balances from + all subaccounts. Note this means some repetition in the output, which requires explanation when sharing reports with non-plaintextac- - counting-users. A tree mode report's final total is the sum of the + counting-users. A tree mode report's final total is the sum of the top-level balances shown, not of all the balances shown. - o Each group of sibling accounts (ie, under a common parent) is sorted + o Each group of sibling accounts (ie, under a common parent) is sorted separately. Depth limiting - With a depth:NUM query, or --depth NUM option, or just -NUM (eg: -3) - balance reports will show accounts only to the specified depth, hiding - the deeper subaccounts. This can be useful for getting an overview + With a depth:NUM query, or --depth NUM option, or just -NUM (eg: -3) + balance reports will show accounts only to the specified depth, hiding + the deeper subaccounts. This can be useful for getting an overview without too much detail. - Account balances at the depth limit always include the balances from + Account balances at the depth limit always include the balances from any deeper subaccounts (even in list mode). Eg, limiting to depth 1: $ hledger -f examples/sample.journal balance -1 @@ -2494,7 +2521,7 @@ COMMANDS 0 Dropping top-level accounts - You can also hide one or more top-level account name parts, using + You can also hide one or more top-level account name parts, using --drop NUM. This can be useful for hiding repetitive top-level account names: @@ -2506,9 +2533,9 @@ COMMANDS Multi-period balance report - With a report interval (set by the -D/--daily, -W/--weekly, - -M/--monthly, -Q/--quarterly, -Y/--yearly, or -p/--period flag), bal- - ance shows a tabular report, with columns representing successive time + With a report interval (set by the -D/--daily, -W/--weekly, + -M/--monthly, -Q/--quarterly, -Y/--yearly, or -p/--period flag), bal- + ance shows a tabular report, with columns representing successive time periods (and a title): $ hledger -f examples/sample.journal bal --quarterly income expenses -E @@ -2529,21 +2556,21 @@ COMMANDS encompass the displayed subperiods (so that the first and last subpe- riods have the same duration as the others). - o Leading and trailing periods (columns) containing all zeroes are not + o Leading and trailing periods (columns) containing all zeroes are not shown, unless -E/--empty is used. - o Accounts (rows) containing all zeroes are not shown, unless + o Accounts (rows) containing all zeroes are not shown, unless -E/--empty is used. - o Amounts with many commodities are shown in abbreviated form, unless + o Amounts with many commodities are shown in abbreviated form, unless --no-elide is used. (experimental) - o Average and/or total columns can be added with the -A/--average and + o Average and/or total columns can be added with the -A/--average and -T/--row-total flags. o The --transpose flag can be used to exchange rows and columns. - o The --pivot FIELD option causes a different transaction field to be + o The --pivot FIELD option causes a different transaction field to be used as "account name". See PIVOTING. Multi-period reports with many periods can be too wide for easy viewing @@ -2557,32 +2584,32 @@ COMMANDS o Reduce the terminal's font size - o View with a pager like less, eg: hledger bal -D --color=yes | less + o View with a pager like less, eg: hledger bal -D --color=yes | less -RS - o Output as CSV and use a CSV viewer like visidata (hledger bal -D -O - csv | vd -f csv), Emacs' csv-mode (M-x csv-mode, C-c C-a), or a + o Output as CSV and use a CSV viewer like visidata (hledger bal -D -O + csv | vd -f csv), Emacs' csv-mode (M-x csv-mode, C-c C-a), or a spreadsheet (hledger bal -D -o a.csv && open a.csv) - o Output as HTML and view with a browser: hledger bal -D -o a.html && + o Output as HTML and view with a browser: hledger bal -D -o a.html && open a.html Showing declared accounts - With --declared, accounts which have been declared with an account - directive will be included in the balance report, even if they have no + With --declared, accounts which have been declared with an account + directive will be included in the balance report, even if they have no transactions. (Since they will have a zero balance, you will also need -E/--empty to see them.) - More precisely, leaf declared accounts (with no subaccounts) will be + More precisely, leaf declared accounts (with no subaccounts) will be included, since those are usually the more useful in reports. - The idea of this is to be able to see a useful "complete" balance - report, even when you don't have transactions in all of your declared + The idea of this is to be able to see a useful "complete" balance + report, even when you don't have transactions in all of your declared accounts yet. Data layout - The --layout option affects how multi-commodity amounts are displayed, - and some other things, influencing the overall layout of the report + The --layout option affects how multi-commodity amounts are displayed, + and some other things, influencing the overall layout of the report data: o --layout=wide[,WIDTH]: commodities are shown on a single line, possi- @@ -2594,11 +2621,11 @@ COMMANDS bols in a separate column o --layout=tidy: data is normalised to tidy form, with one row per data - value. We currently support this with CSV output only. In tidy - mode, totals and row averages are disabled (-N/--no-total is implied + value. We currently support this with CSV output only. In tidy + mode, totals and row averages are disabled (-N/--no-total is implied and -T/--row-total and -A/--average will be ignored). - These --layout modes are supported with some but not all of the output + These --layout modes are supported with some but not all of the output formats: @@ -2622,7 +2649,7 @@ COMMANDS ------------------++-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- || 10.00 ITOT, 337.18 USD, 12.00 VEA, 106.00 VHT 70.00 GLD, 18.00 ITOT, -98.12 USD, 10.00 VEA, 18.00 VHT -11.00 ITOT, 4881.44 USD, 14.00 VEA, 170.00 VHT 70.00 GLD, 17.00 ITOT, 5120.50 USD, 36.00 VEA, 294.00 VHT - o Limited wide layout. A width limit reduces the width, but some com- + o Limited wide layout. A width limit reduces the width, but some com- modities will be hidden: $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=wide,32 @@ -2634,7 +2661,7 @@ COMMANDS ------------------++--------------------------------------------------------------------------------------------------------------------------- || 10.00 ITOT, 337.18 USD, 2 more.. 70.00 GLD, 18.00 ITOT, 3 more.. -11.00 ITOT, 3 more.. 70.00 GLD, 17.00 ITOT, 3 more.. - o Tall layout. Each commodity gets a new line (may be different in + o Tall layout. Each commodity gets a new line (may be different in each column), and account names are repeated: $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=tall @@ -2654,7 +2681,7 @@ COMMANDS || 106.00 VHT 10.00 VEA 170.00 VHT 36.00 VEA || 18.00 VHT 294.00 VHT - o Bare layout. Commodity symbols are kept in one column, each commod- + o Bare layout. Commodity symbols are kept in one column, each commod- ity gets its own report row, account names are repeated: $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -T -Y --layout=bare @@ -2674,7 +2701,7 @@ COMMANDS || VEA 12.00 10.00 14.00 36.00 || VHT 106.00 18.00 170.00 294.00 - o Bare layout also affects CSV output, which is useful for producing + o Bare layout also affects CSV output, which is useful for producing data that is easier to consume, eg when making charts: $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout=bare @@ -2690,10 +2717,10 @@ COMMANDS "total","VEA","36.00" "total","VHT","294.00" - o Tidy layout produces normalised "tidy data", where every variable is - a column and each row represents a single data point (see + o Tidy layout produces normalised "tidy data", where every variable is + a column and each row represents a single data point (see https://cran.r-project.org/web/packages/tidyr/vignettes/tidy- - data.html). This kind of data is the easiest to process with other + data.html). This kind of data is the easiest to process with other software: $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -Y -O csv --layout=tidy @@ -2715,21 +2742,21 @@ COMMANDS "Assets:US:ETrade","2014","2014-01-01","2014-12-31","VHT","170.00" Sorting by amount - With -S/--sort-amount, accounts with the largest (most positive) bal- - ances are shown first. Eg: hledger bal expenses -MAS shows your big- - gest averaged monthly expenses first. When more than one commodity is - present, they will be sorted by the alphabetically earliest commodity - first, and then by subsequent commodities (if an amount is missing a + With -S/--sort-amount, accounts with the largest (most positive) bal- + ances are shown first. Eg: hledger bal expenses -MAS shows your big- + gest averaged monthly expenses first. When more than one commodity is + present, they will be sorted by the alphabetically earliest commodity + first, and then by subsequent commodities (if an amount is missing a commodity, it is treated as 0). - Revenues and liability balances are typically negative, however, so -S - shows these in reverse order. To work around this, you can add - --invert to flip the signs. (Or, use one of the higher-level reports, - which flip the sign automatically. Eg: hledger incomestatement -MAS). + Revenues and liability balances are typically negative, however, so -S + shows these in reverse order. To work around this, you can add + --invert to flip the signs. (Or, use one of the higher-level reports, + which flip the sign automatically. Eg: hledger incomestatement -MAS). Percentages - With -%/--percent, balance reports show each account's value expressed + With -%/--percent, balance reports show each account's value expressed as a percentage of the (column) total: $ hledger -f examples/sample.journal bal expenses -Q -% @@ -2743,62 +2770,62 @@ COMMANDS || 0 100.0 % 0 0 Note it is not useful to calculate percentages if the amounts in a col- - umn have mixed signs. In this case, make a separate report for each + umn have mixed signs. In this case, make a separate report for each sign, eg: $ hledger bal -% amt:`>0` $ hledger bal -% amt:`<0` - Similarly, if the amounts in a column have mixed commodities, convert - them to one commodity with -B, -V, -X or --value, or make a separate + Similarly, if the amounts in a column have mixed commodities, convert + them to one commodity with -B, -V, -X or --value, or make a separate report for each commodity: $ hledger bal -% cur:\\$ $ hledger bal -% cur:EUR Balance change, end balance - It's important to be clear on the meaning of the numbers shown in bal- + It's important to be clear on the meaning of the numbers shown in bal- ance reports. Here is some terminology we use: - A balance change is the net amount added to, or removed from, an + A balance change is the net amount added to, or removed from, an account during some period. - An end balance is the amount accumulated in an account as of some date - (and some time, but hledger doesn't store that; assume end of day in + An end balance is the amount accumulated in an account as of some date + (and some time, but hledger doesn't store that; assume end of day in your timezone). It is the sum of previous balance changes. - We call it a historical end balance if it includes all balance changes + We call it a historical end balance if it includes all balance changes since the account was created. For a real world account, this means it - will match the "historical record", eg the balances reported in your + will match the "historical record", eg the balances reported in your bank statements or bank web UI. (If they are correct!) - In general, balance changes are what you want to see when reviewing + In general, balance changes are what you want to see when reviewing revenues and expenses, and historical end balances are what you want to see when reviewing or reconciling asset, liability and equity accounts. - balance shows balance changes by default. To see accurate historical + balance shows balance changes by default. To see accurate historical end balances: - 1. Initialise account starting balances with an "opening balances" - transaction (a transfer from equity to the account), unless the + 1. Initialise account starting balances with an "opening balances" + transaction (a transfer from equity to the account), unless the journal covers the account's full lifetime. 2. Include all of of the account's prior postings in the report, by not - specifying a report start date, or by using the -H/--historical + specifying a report start date, or by using the -H/--historical flag. (-H causes report start date to be ignored when summing post- ings.) Balance report types For more flexible reporting, there are three important option groups: - hledger balance [CALCULATIONTYPE] [ACCUMULATIONTYPE] [VALUATIONTYPE] + hledger balance [CALCULATIONTYPE] [ACCUMULATIONTYPE] [VALUATIONTYPE] ... - The first two are the most important: calculation type selects the - basic calculation to perform for each table cell, while accumulation + The first two are the most important: calculation type selects the + basic calculation to perform for each table cell, while accumulation type says which postings should be included in each cell's calculation. - Typically one or both of these are selected by default, so you don't - need to write them explicitly. A valuation type can be added if you + Typically one or both of these are selected by default, so you don't + need to write them explicitly. A valuation type can be added if you want to convert the basic report to value or cost. Calculation type: @@ -2809,27 +2836,27 @@ COMMANDS o --budget : like --sum but also show a goal amount o --valuechange : show the change in period-end historical balance val- - ues (caused by deposits, withdrawals, and/or market price fluctua- + ues (caused by deposits, withdrawals, and/or market price fluctua- tions) - o --gain : show the unrealised capital gain/loss, (the current valued + o --gain : show the unrealised capital gain/loss, (the current valued balance minus each amount's original cost) Accumulation type: - Which postings should be included in each cell's calculation. It is + Which postings should be included in each cell's calculation. It is one of: - o --change : postings from column start to column end, ie within the - cell's period. Typically used to see revenues/expenses. (default + o --change : postings from column start to column end, ie within the + cell's period. Typically used to see revenues/expenses. (default for balance, incomestatement) - o --cumulative : postings from report start to column end, eg to show + o --cumulative : postings from report start to column end, eg to show changes accumulated since the report's start date. Rarely used. - o --historical/-H : postings from journal start to column end, ie all + o --historical/-H : postings from journal start to column end, ie all postings from account creation to the end of the cell's period. Typ- ically used to see historical end balances of assets/liabili- - ties/equity. (default for balancesheet, balancesheetequity, cash- + ties/equity. (default for balancesheet, balancesheetequity, cash- flow) Valuation type: @@ -2842,7 +2869,7 @@ COMMANDS o --value=then[,COMM] : show value at transaction dates - o --value=end[,COMM] : show value at period end date(s) (default with + o --value=end[,COMM] : show value at period end date(s) (default with --valuechange, --gain) o --value=now[,COMM] : show value at today's date @@ -2851,13 +2878,13 @@ COMMANDS or one of their aliases: --cost/-B, --market/-V or --exchange/-X. - Most combinations of these options should produce reasonable reports, - but if you find any that seem wrong or misleading, let us know. The + Most combinations of these options should produce reasonable reports, + but if you find any that seem wrong or misleading, let us know. The following restrictions are applied: o --valuechange implies --value=end - o --valuechange makes --change the default when used with the bal- + o --valuechange makes --change the default when used with the bal- ancesheet/balancesheetequity commands o --cumulative or --historical disables --row-total/-T @@ -2873,16 +2900,17 @@ COMMANDS v ------------------------------------------------------------------------------------ --change change in period sum of posting- period-end DATE-value of - date market val- value of change change in + date market val- value of change change in ues in period in period period + --cumu- change from sum of posting- period-end DATE-value of - lative report start to date market val- value of change change from + lative report start to date market val- value of change change from period end ues from report from report report start start to period start to period to period end end end --his- change from sum of posting- period-end DATE-value of - torical journal start to date market val- value of change change from - /-H period end (his- ues from journal from journal journal start + torical journal start to date market val- value of change change from + /-H period end (his- ues from journal from journal journal start torical end bal- start to period start to period to period end ance) end end @@ -2890,25 +2918,25 @@ COMMANDS Some frequently used balance options/reports are: o bal -M revenues expenses - Show revenues/expenses in each month. Also available as the incomes- + Show revenues/expenses in each month. Also available as the incomes- tatement command. o bal -M -H assets liabilities - Show historical asset/liability balances at each month end. Also + Show historical asset/liability balances at each month end. Also available as the balancesheet command. o bal -M -H assets liabilities equity - Show historical asset/liability/equity balances at each month end. + Show historical asset/liability/equity balances at each month end. Also available as the balancesheetequity command. o bal -M assets not:receivable - Show changes to liquid assets in each month. Also available as the + Show changes to liquid assets in each month. Also available as the cashflow command. Also: o bal -M expenses -2 -SA - Show monthly expenses summarised to depth 2 and sorted by average + Show monthly expenses summarised to depth 2 and sorted by average amount. o bal -M --budget expenses @@ -2922,12 +2950,12 @@ COMMANDS Show top gainers [or losers] last week Budget report - The --budget report type activates extra columns showing any budget - goals for each account and period. The budget goals are defined by - periodic transactions. This is very useful for comparing planned and + The --budget report type activates extra columns showing any budget + goals for each account and period. The budget goals are defined by + periodic transactions. This is very useful for comparing planned and actual income, expenses, time usage, etc. - For example, you can take average monthly expenses in the common + For example, you can take average monthly expenses in the common expense categories to construct a minimal monthly budget: ;; Budget @@ -2974,26 +3002,26 @@ COMMANDS This is different from a normal balance report in several ways: - o Only accounts with budget goals during the report period are shown, + o Only accounts with budget goals during the report period are shown, by default. - o In each column, in square brackets after the actual amount, budget - goal amounts are shown, and the actual/goal percentage. (Note: bud- + o In each column, in square brackets after the actual amount, budget + goal amounts are shown, and the actual/goal percentage. (Note: bud- get goals should be in the same commodity as the actual amount.) - o All parent accounts are always shown, even in list mode. Eg assets, + o All parent accounts are always shown, even in list mode. Eg assets, assets:bank, and expenses above. - o Amounts always include all subaccounts, budgeted or unbudgeted, even + o Amounts always include all subaccounts, budgeted or unbudgeted, even in list mode. This means that the numbers displayed will not always add up! Eg above, - the expenses actual amount includes the gifts and supplies transac- - tions, but the expenses:gifts and expenses:supplies accounts are not + the expenses actual amount includes the gifts and supplies transac- + tions, but the expenses:gifts and expenses:supplies accounts are not shown, as they have no budget amounts declared. - This can be confusing. When you need to make things clearer, use the - -E/--empty flag, which will reveal all accounts including unbudgeted + This can be confusing. When you need to make things clearer, use the + -E/--empty flag, which will reveal all accounts including unbudgeted ones, giving the full picture. Eg: $ hledger balance -M --budget --empty @@ -3035,12 +3063,12 @@ COMMANDS For more examples and notes, see Budgeting. Budget report start date - This might be a bug, but for now: when making budget reports, it's a + This might be a bug, but for now: when making budget reports, it's a good idea to explicitly set the report's start date to the first day of - a reporting period, because a periodic rule like ~ monthly generates - its transactions on the 1st of each month, and if your journal has no - regular transactions on the 1st, the default report start date could - exclude that budget goal, which can be a little surprising. Eg here + a reporting period, because a periodic rule like ~ monthly generates + its transactions on the 1st of each month, and if your journal has no + regular transactions on the 1st, the default report start date could + exclude that budget goal, which can be a little surprising. Eg here the default report period is just the day of 2020-01-15: ~ monthly in 2020 @@ -3059,9 +3087,9 @@ COMMANDS --------------++------------ || $400 - To avoid this, specify the budget report's period, or at least the - start date, with -b/-e/-p/date:, to ensure it includes the budget goal - transactions (periodic transactions) that you want. Eg, adding -b + To avoid this, specify the budget report's period, or at least the + start date, with -b/-e/-p/date:, to ensure it includes the budget goal + transactions (periodic transactions) that you want. Eg, adding -b 2020/1/1 to the above: $ hledger bal expenses --budget -b 2020/1/1 @@ -3074,12 +3102,12 @@ COMMANDS || $400 [80% of $500] Budgets and subaccounts - You can add budgets to any account in your account hierarchy. If you + You can add budgets to any account in your account hierarchy. If you have budgets on both parent account and some of its children, then bud- - get(s) of the child account(s) would be added to the budget of their + get(s) of the child account(s) would be added to the budget of their parent, much like account balances behave. - In the most simple case this means that once you add a budget to any + In the most simple case this means that once you add a budget to any account, all its parents would have budget as well. To illustrate this, consider the following budget: @@ -3089,13 +3117,13 @@ COMMANDS expenses:personal:electronics $100.00 liabilities - With this, monthly budget for electronics is defined to be $100 and - budget for personal expenses is an additional $1000, which implicitly + With this, monthly budget for electronics is defined to be $100 and + budget for personal expenses is an additional $1000, which implicitly means that budget for both expenses:personal and expenses is $1100. - Transactions in expenses:personal:electronics will be counted both - towards its $100 budget and $1100 of expenses:personal , and transac- - tions in any other subaccount of expenses:personal would be counted + Transactions in expenses:personal:electronics will be counted both + towards its $100 budget and $1100 of expenses:personal , and transac- + tions in any other subaccount of expenses:personal would be counted towards only towards the budget of expenses:personal. For example, let's consider these transactions: @@ -3121,9 +3149,9 @@ COMMANDS expenses:personal $30.00 liabilities - As you can see, we have transactions in expenses:personal:electron- - ics:upgrades and expenses:personal:train tickets, and since both of - these accounts are without explicitly defined budget, these transac- + As you can see, we have transactions in expenses:personal:electron- + ics:upgrades and expenses:personal:train tickets, and since both of + these accounts are without explicitly defined budget, these transac- tions would be counted towards budgets of expenses:personal:electronics and expenses:personal accordingly: @@ -3139,7 +3167,7 @@ COMMANDS -------------------------------++------------------------------- || 0 [ 0] - And with --empty, we can get a better picture of budget allocation and + And with --empty, we can get a better picture of budget allocation and consumption: $ hledger balance --budget -M --empty @@ -3158,28 +3186,28 @@ COMMANDS Selecting budget goals The budget report evaluates periodic transaction rules to generate spe- - cial "goal transactions", which generate the goal amounts for each - account in each report subperiod. When troubleshooting, you can use + cial "goal transactions", which generate the goal amounts for each + account in each report subperiod. When troubleshooting, you can use the print command to show these as forecasted transactions: $ hledger print --forecast=BUDGETREPORTPERIOD tag:generated - By default, the budget report uses all available periodic transaction - rules to generate goals. This includes rules with a different report - interval from your report. Eg if you have daily, weekly and monthly - periodic rules, all of these will contribute to the goals in a monthly + By default, the budget report uses all available periodic transaction + rules to generate goals. This includes rules with a different report + interval from your report. Eg if you have daily, weekly and monthly + periodic rules, all of these will contribute to the goals in a monthly budget report. - You can select a subset of periodic rules by providing an argument to - the --budget flag. --budget=DESCPAT will match all periodic rules + You can select a subset of periodic rules by providing an argument to + the --budget flag. --budget=DESCPAT will match all periodic rules whose description contains DESCPAT, a case-insensitive substring (not a - regular expression or query). This means you can give your periodic - rules descriptions (remember that two spaces are needed), and then + regular expression or query). This means you can give your periodic + rules descriptions (remember that two spaces are needed), and then select from multiple budgets defined in your journal. Customising single-period balance reports For single-period balance reports displayed in the terminal (only), you - can use --format FMT to customise the format and content of each line. + can use --format FMT to customise the format and content of each line. Eg: $ hledger -f examples/sample.journal balance --format "%20(account) %12(total)" @@ -3197,7 +3225,7 @@ COMMANDS 0 The FMT format string (plus a newline) specifies the formatting applied - to each account/balance pair. It may contain any suitable text, with + to each account/balance pair. It may contain any suitable text, with data fields interpolated like so: %[MIN][.MAX](FIELDNAME) @@ -3208,14 +3236,14 @@ COMMANDS o FIELDNAME must be enclosed in parentheses, and can be one of: - o depth_spacer - a number of spaces equal to the account's depth, or + o depth_spacer - a number of spaces equal to the account's depth, or if MIN is specified, MIN * depth spaces. o account - the account's name o total - the account's balance/posted total, right justified - Also, FMT can begin with an optional prefix to control how multi-com- + Also, FMT can begin with an optional prefix to control how multi-com- modity amounts are rendered: o %_ - render on multiple lines, bottom-aligned (the default) @@ -3224,34 +3252,34 @@ COMMANDS o %, - render on one line, comma-separated - There are some quirks. Eg in one-line mode, %(depth_spacer) has no - effect, instead %(account) has indentation built in. Experimentation + There are some quirks. Eg in one-line mode, %(depth_spacer) has no + effect, instead %(account) has indentation built in. Experimentation may be needed to get pleasing results. Some example formats: o %(total) - the account's total - o %-20.20(account) - the account's name, left justified, padded to 20 + o %-20.20(account) - the account's name, left justified, padded to 20 characters and clipped at 20 characters - o %,%-50(account) %25(total) - account name padded to 50 characters, - total padded to 20 characters, with multiple commodities rendered on + o %,%-50(account) %25(total) - account name padded to 50 characters, + total padded to 20 characters, with multiple commodities rendered on one line - o %20(total) %2(depth_spacer)%-(account) - the default format for the + o %20(total) %2(depth_spacer)%-(account) - the default format for the single-column balance report balancesheet balancesheet, bs - This command displays a balance sheet, showing historical ending bal- + This command displays a balance sheet, showing historical ending bal- ances of asset and liability accounts. (To see equity as well, use the - balancesheetequity command.) Amounts are shown with normal positive + balancesheetequity command.) Amounts are shown with normal positive sign, as in conventional financial statements. - This report shows accounts declared with the Asset, Cash or Liability - type (see account types). Or if no such accounts are declared, it - shows top-level accounts named asset or liability (case insensitive, + This report shows accounts declared with the Asset, Cash or Liability + type (see account types). Or if no such accounts are declared, it + shows top-level accounts named asset or liability (case insensitive, plurals allowed) and their subaccounts. Example: @@ -3276,24 +3304,24 @@ COMMANDS 0 This command is a higher-level variant of the balance command, and sup- - ports many of that command's features, such as multi-period reports. - It is similar to hledger balance -H assets liabilities, but with - smarter account detection, and liabilities displayed with their sign + ports many of that command's features, such as multi-period reports. + It is similar to hledger balance -H assets liabilities, but with + smarter account detection, and liabilities displayed with their sign flipped. - This command also supports the output destination and output format - options The output formats supported are txt, csv, html, and (experi- + This command also supports the output destination and output format + options The output formats supported are txt, csv, html, and (experi- mental) json. balancesheetequity balancesheetequity, bse - This command displays a balance sheet, showing historical ending bal- - ances of asset, liability and equity accounts. Amounts are shown with + This command displays a balance sheet, showing historical ending bal- + ances of asset, liability and equity accounts. Amounts are shown with normal positive sign, as in conventional financial statements. - This report shows accounts declared with the Asset, Cash, Liability or - Equity type (see account types). Or if no such accounts are declared, - it shows top-level accounts named asset, liability or equity (case + This report shows accounts declared with the Asset, Cash, Liability or + Equity type (see account types). Or if no such accounts are declared, + it shows top-level accounts named asset, liability or equity (case insensitive, plurals allowed) and their subaccounts. Example: @@ -3323,31 +3351,31 @@ COMMANDS 0 This command is a higher-level variant of the balance command, and sup- - ports many of that command's features, such as multi-period reports. + ports many of that command's features, such as multi-period reports. It is similar to hledger balance -H assets liabilities equity, but with - smarter account detection, and liabilities/equity displayed with their + smarter account detection, and liabilities/equity displayed with their sign flipped. - This command also supports the output destination and output format - options The output formats supported are txt, csv, html, and (experi- + This command also supports the output destination and output format + options The output formats supported are txt, csv, html, and (experi- mental) json. cashflow cashflow, cf - This command displays a cashflow statement, showing the inflows and - outflows affecting "cash" (ie, liquid, easily convertible) assets. - Amounts are shown with normal positive sign, as in conventional finan- + This command displays a cashflow statement, showing the inflows and + outflows affecting "cash" (ie, liquid, easily convertible) assets. + Amounts are shown with normal positive sign, as in conventional finan- cial statements. - This report shows accounts declared with the Cash type (see account + This report shows accounts declared with the Cash type (see account types). Or if no such accounts are declared, it shows accounts - o under a top-level account named asset (case insensitive, plural + o under a top-level account named asset (case insensitive, plural allowed) o whose name contains some variation of cash, bank, checking or saving. - More precisely: all accounts matching this case insensitive regular + More precisely: all accounts matching this case insensitive regular expression: ^assets?(:.+)?:(cash|bank|che(ck|que?)(ing)?|savings?|currentcash)(:|$) @@ -3371,22 +3399,22 @@ COMMANDS $-1 This command is a higher-level variant of the balance command, and sup- - ports many of that command's features, such as multi-period reports. - It is similar to hledger balance assets not:fixed not:investment + ports many of that command's features, such as multi-period reports. + It is similar to hledger balance assets not:fixed not:investment not:receivable, but with smarter account detection. - This command also supports the output destination and output format - options The output formats supported are txt, csv, html, and (experi- + This command also supports the output destination and output format + options The output formats supported are txt, csv, html, and (experi- mental) json. check check Check for various kinds of errors in your data. - hledger provides a number of built-in error checks to help prevent - problems in your data. Some of these are run automatically; or, you - can use this check command to run them on demand, with no output and a - zero exit code if all is well. Specify their names (or a prefix) as + hledger provides a number of built-in error checks to help prevent + problems in your data. Some of these are run automatically; or, you + can use this check command to run them on demand, with no output and a + zero exit code if all is well. Specify their names (or a prefix) as argument(s). Some examples: @@ -3395,7 +3423,7 @@ COMMANDS hledger check -s # basic + strict checks hledger check ordereddates payees # basic + two other checks - If you are an Emacs user, you can also configure flycheck-hledger to + If you are an Emacs user, you can also configure flycheck-hledger to run these checks, providing instant feedback as you edit the journal. Here are the checks currently available: @@ -3407,98 +3435,98 @@ COMMANDS o parseable - data files are well-formed and can be successfully parsed o balancedwithautoconversion - all transactions are balanced, inferring - missing amounts where necessary, and possibly converting commodities + missing amounts where necessary, and possibly converting commodities using transaction prices or automatically-inferred transaction prices - o assertions - all balance assertions in the journal are passing. + o assertions - all balance assertions in the journal are passing. (This check can be disabled with -I/--ignore-assertions.) Strict checks These additional checks are run when the -s/--strict (strict mode) flag - is used. Or, they can be run by giving their names as arguments to + is used. Or, they can be run by giving their names as arguments to check: o accounts - all account names used by transactions have been declared o commodities - all commodity symbols used have been declared - o balancednoautoconversion - transactions are balanced, possibly using + o balancednoautoconversion - transactions are balanced, possibly using explicit transaction prices but not inferred ones Other checks - These checks can be run only by giving their names as arguments to - check. They are more specialised and not desirable for everyone, + These checks can be run only by giving their names as arguments to + check. They are more specialised and not desirable for everyone, therefore optional: o ordereddates - transactions are ordered by date within each file o payees - all payees used by transactions have been declared - o recentassertions - all accounts with balance assertions have a bal- + o recentassertions - all accounts with balance assertions have a bal- ance assertion no more than 7 days before their latest posting o uniqueleafnames - all account leaf names are unique Custom checks - A few more checks are are available as separate add-on commands, in + A few more checks are are available as separate add-on commands, in https://github.com/simonmichael/hledger/tree/master/bin: - o hledger-check-tagfiles - all tag values containing / (a forward + o hledger-check-tagfiles - all tag values containing / (a forward slash) exist as file paths - o hledger-check-fancyassertions - more complex balance assertions are + o hledger-check-fancyassertions - more complex balance assertions are passing You could make similar scripts to perform your own custom checks. See: Cookbook -> Scripting. More about specific checks - hledger check recentassertions will complain if any balance-asserted + hledger check recentassertions will complain if any balance-asserted account does not have a balance assertion within 7 days before its lat- - est posting. This aims to prevent the situation where you are regu- - larly updating your journal, but forgetting to check your balances - against the real world, then one day must dig back through months of - data to find an error. It assumes that adding a balance assertion - requires/reminds you to check the real-world balance. That may not be - true if you auto-generate balance assertions from bank data; in that - case, I recommend to import transactions uncleared, then use the man- - ual-review-and-mark-cleared phase as a reminder to check the latest + est posting. This aims to prevent the situation where you are regu- + larly updating your journal, but forgetting to check your balances + against the real world, then one day must dig back through months of + data to find an error. It assumes that adding a balance assertion + requires/reminds you to check the real-world balance. That may not be + true if you auto-generate balance assertions from bank data; in that + case, I recommend to import transactions uncleared, then use the man- + ual-review-and-mark-cleared phase as a reminder to check the latest assertions against real-world balances. close close, equity - Prints a sample "closing" transaction bringing specified account bal- - ances to zero, and an inverse "opening" transaction restoring the same + Prints a sample "closing" transaction bringing specified account bal- + ances to zero, and an inverse "opening" transaction restoring the same account balances. - If like most people you split your journal files by time, eg by year: - at the end of the year you can use this command to "close out" your - asset and liability (and perhaps equity) balances in the old file, and - reinitialise them in the new file. This helps ensure that report bal- - ances remain correct whether you are including old files or not. - (Because all closing/opening transactions except the very first will + If like most people you split your journal files by time, eg by year: + at the end of the year you can use this command to "close out" your + asset and liability (and perhaps equity) balances in the old file, and + reinitialise them in the new file. This helps ensure that report bal- + ances remain correct whether you are including old files or not. + (Because all closing/opening transactions except the very first will cancel out - see example below.) Some people also use this command to close out revenue and expense bal- - ances at the end of an accounting period. This properly records the - period's profit/loss as "retained earnings" (part of equity), and + ances at the end of an accounting period. This properly records the + period's profit/loss as "retained earnings" (part of equity), and allows the accounting equation (A-L=E) to balance, which you could then check by the bse report's zero total. - You can print just the closing transaction by using the --close flag, + You can print just the closing transaction by using the --close flag, or just the opening transaction with the --open flag. Their descriptions are closing balances and opening balances by - default; you can customise these with the --close-desc and --open-desc + default; you can customise these with the --close-desc and --open-desc options. - Just one balancing equity posting is used by default, with the amount + Just one balancing equity posting is used by default, with the amount left implicit. The default account name is equity:opening/closing bal- - ances. You can customise the account name(s) with --close-acct and - --open-acct. (If you specify only one of these, it will be used for + ances. You can customise the account name(s) with --close-acct and + --open-acct. (If you specify only one of these, it will be used for both.) - With --x/--explicit, the equity posting's amount will be shown explic- + With --x/--explicit, the equity posting's amount will be shown explic- itly, and if it involves multiple commodities, there will be a separate equity posting for each commodity (as in the print command). @@ -3506,29 +3534,29 @@ COMMANDS balances (good for troubleshooting). close and prices - Transaction prices are ignored (and discarded) by closing/opening + Transaction prices are ignored (and discarded) by closing/opening transactions, by default. With --show-costs, they are preserved; there - will be a separate equity posting for each cost in each commodity. - This means balance -B reports will look the same after the transition. + will be a separate equity posting for each cost in each commodity. + This means balance -B reports will look the same after the transition. Note if you have many foreign currency or investment transactions, this will generate very large journal entries. close date - The default closing date is yesterday, or the journal's end date, + The default closing date is yesterday, or the journal's end date, whichever is later. - Unless you are running close on exactly the first day of the new - period, you'll want to override the closing date. This is done by - specifying a report end date, where "last day of the report period" - will be the closing date. The opening date is always the following - day. So to close on (end of) 2020-12-31 and open on (start of) + Unless you are running close on exactly the first day of the new + period, you'll want to override the closing date. This is done by + specifying a report end date, where "last day of the report period" + will be the closing date. The opening date is always the following + day. So to close on (end of) 2020-12-31 and open on (start of) 2021-01-01, any of these will work: end date argument explanation ----------------------------------------------- -e 2021-01-01 end dates are exclusive - -e 2021 equivalent, per smart + -e 2021 equivalent, per smart dates -p 2020 equivalent, the period's begin date is ignored @@ -3556,17 +3584,17 @@ COMMANDS Hiding opening/closing transactions Although the closing/opening transactions cancel out, they will be vis- - ible in reports like print and register, creating some visual clutter. + ible in reports like print and register, creating some visual clutter. You can exclude them all with a query, like: $ hledger print not:desc:'opening|closing' # less typing $ hledger print not:'equity:opening/closing balances' # more precise - But when reporting on multiple files, this can get a bit tricky; you + But when reporting on multiple files, this can get a bit tricky; you may need to keep the earliest opening balances, for a historical regis- - ter report; or you may need to suppress a closing transaction, to see - year-end balances. If you find yourself needing more precise queries, - here's one solution: add more easily-matched tags to opening/closing + ter report; or you may need to suppress a closing transaction, to see + year-end balances. If you find yourself needing more precise queries, + here's one solution: add more easily-matched tags to opening/closing transactions, like this: ; 2019.journal @@ -3601,18 +3629,18 @@ COMMANDS # 2020 year end balances, suppressing 2020 closing txn close and balance assertions - The closing and opening transactions will include balance assertions, - verifying that the accounts have first been reset to zero and then - restored to their previous balance. These provide valuable error - checking, alerting you when things get out of line, but you can ignore + The closing and opening transactions will include balance assertions, + verifying that the accounts have first been reset to zero and then + restored to their previous balance. These provide valuable error + checking, alerting you when things get out of line, but you can ignore them temporarily with -I or just remove them if you prefer. You probably shouldn't use status or realness filters (like -C or -R or status:) with close, or the generated balance assertions will depend on - these flags. Likewise, if you run this command with --auto, the bal- + these flags. Likewise, if you run this command with --auto, the bal- ance assertions would probably always require --auto. - Multi-day transactions (where some postings have a different date) + Multi-day transactions (where some postings have a different date) break the balance assertions, because the money is temporarily "invisi- ble" while in transit: @@ -3620,8 +3648,8 @@ COMMANDS expenses:food 5 assets:bank:checking -5 ; date: 2021/1/2 - To fix the assertions, you can add a temporary account to track such - in-transit money (splitting the multi-day transaction into two single- + To fix the assertions, you can add a temporary account to track such + in-transit money (splitting the multi-day transaction into two single- day transactions): ; in 2020.journal: @@ -3635,8 +3663,8 @@ COMMANDS assets:bank:checking Example: close revenue/expense accounts to retained earnings - For this, use --close to suppress the opening transaction, as it's not - needed. Also you'll want to change the equity account name to your + For this, use --close to suppress the opening transaction, as it's not + needed. Also you'll want to change the equity account name to your equivalent of "equity:retained earnings". Closing 2021's first quarter revenues/expenses: @@ -3649,13 +3677,13 @@ COMMANDS $ hledger close --close revenues expenses -p Q1 \ --close-acct='equity:retained earnings' >> $LEDGER_FILE - Now, the first quarter's balance sheet should show a zero (unless you + Now, the first quarter's balance sheet should show a zero (unless you are using @/@@ notation without equity postings): $ hledger bse -p Q1 And we must suppress the closing transaction to see the first quarter's - income statement (using the description; not:'retained earnings' won't + income statement (using the description; not:'retained earnings' won't work here): $ hledger is -p Q1 not:desc:'closing balances' @@ -3664,13 +3692,13 @@ COMMANDS codes List the codes seen in transactions, in the order parsed. - This command prints the value of each transaction's code field, in the - order transactions were parsed. The transaction code is an optional - value written in parentheses between the date and description, often + This command prints the value of each transaction's code field, in the + order transactions were parsed. The transaction code is an optional + value written in parentheses between the date and description, often used to store a cheque number, order number or similar. Transactions aren't required to have a code, and missing or empty codes - will not be shown by default. With the -E/--empty flag, they will be + will not be shown by default. With the -E/--empty flag, they will be printed as blank lines. You can add a query to select a subset of transactions. @@ -3710,7 +3738,7 @@ COMMANDS List the unique descriptions that appear in transactions. This command lists the unique descriptions that appear in transactions, - in alphabetic order. You can add a query to select a subset of trans- + in alphabetic order. You can add a query to select a subset of trans- actions. Example: @@ -3722,18 +3750,18 @@ COMMANDS diff diff - Compares a particular account's transactions in two input files. It + Compares a particular account's transactions in two input files. It shows any transactions to this account which are in one file but not in the other. More precisely, for each posting affecting this account in either file, - it looks for a corresponding posting in the other file which posts the - same amount to the same account (ignoring date, description, etc.) + it looks for a corresponding posting in the other file which posts the + same amount to the same account (ignoring date, description, etc.) Since postings not transactions are compared, this also works when mul- tiple bank transactions have been combined into a single journal entry. This is useful eg if you have downloaded an account's transactions from - your bank (eg as CSV data). When hledger and your bank disagree about + your bank (eg as CSV data). When hledger and your bank disagree about the account balance, you can compare the bank data with your journal to find out the cause. @@ -3751,23 +3779,23 @@ COMMANDS files files - List all files included in the journal. With a REGEX argument, only - file names matching the regular expression (case sensitive) are shown. + List all files included in the journal. With a REGEX argument, only + file names matching the regular expression (case sensitive) are shown. help help - Show the hledger user manual in the terminal, with info, man, or a - pager. With a TOPIC argument, open it at that topic if possible. - TOPIC can be any heading in the manual, or a heading prefix, case - insensitive. Eg: commands, print, forecast, journal, amount, "auto + Show the hledger user manual in the terminal, with info, man, or a + pager. With a TOPIC argument, open it at that topic if possible. + TOPIC can be any heading in the manual, or a heading prefix, case + insensitive. Eg: commands, print, forecast, journal, amount, "auto postings". This command shows the hledger manual built in to your hledger version. It can be useful when offline, or when you prefer the terminal to a web - browser, or when the appropriate hledger manual or viewing tools are + browser, or when the appropriate hledger manual or viewing tools are not installed on your system. - By default it chooses the best viewer found in $PATH (preferring info + By default it chooses the best viewer found in $PATH (preferring info since the hledger manual is large). You can select a particular viewer with the -i, -m, or -p flags. @@ -3779,71 +3807,71 @@ COMMANDS import import - Read new transactions added to each FILE since last run, and add them - to the journal. Or with --dry-run, just print the transactions that - would be added. Or with --catchup, just mark all of the FILEs' trans- + Read new transactions added to each FILE since last run, and add them + to the journal. Or with --dry-run, just print the transactions that + would be added. Or with --catchup, just mark all of the FILEs' trans- actions as imported, without actually importing any. - This command may append new transactions to the main journal file - (which should be in journal format). Existing transactions are not - changed. This is one of the few hledger commands that writes to the + This command may append new transactions to the main journal file + (which should be in journal format). Existing transactions are not + changed. This is one of the few hledger commands that writes to the journal file (see also add). - Unlike other hledger commands, with import the journal file is an out- + Unlike other hledger commands, with import the journal file is an out- put file, and will be modified, though only by appending (existing data - will not be changed). The input files are specified as arguments, so - to import one or more CSV files to your main journal, you will run + will not be changed). The input files are specified as arguments, so + to import one or more CSV files to your main journal, you will run hledger import bank.csv or perhaps hledger import *.csv. Note you can import from any file format, though CSV files are the most common import source, and these docs focus on that case. Deduplication - As a convenience import does deduplication while reading transactions. + As a convenience import does deduplication while reading transactions. This does not mean "ignore transactions that look the same", but rather "ignore transactions that have been seen before". This is intended for - when you are periodically importing foreign data which may contain - already-imported transactions. So eg, if every day you download bank - CSV files containing redundant data, you can safely run hledger import - bank.csv and only new transactions will be imported. (import is idem- + when you are periodically importing foreign data which may contain + already-imported transactions. So eg, if every day you download bank + CSV files containing redundant data, you can safely run hledger import + bank.csv and only new transactions will be imported. (import is idem- potent.) - Since the items being read (CSV records, eg) often do not come with - unique identifiers, hledger detects new transactions by date, assuming + Since the items being read (CSV records, eg) often do not come with + unique identifiers, hledger detects new transactions by date, assuming that: 1. new items always have the newest dates 2. item dates do not change across reads - 3. and items with the same date remain in the same relative order + 3. and items with the same date remain in the same relative order across reads. - These are often true of CSV files representing transactions, or true - enough so that it works pretty well in practice. 1 is important, but + These are often true of CSV files representing transactions, or true + enough so that it works pretty well in practice. 1 is important, but violations of 2 and 3 amongst the old transactions won't matter (and if - you import often, the new transactions will be few, so less likely to + you import often, the new transactions will be few, so less likely to be the ones affected). - hledger remembers the latest date processed in each input file by sav- + hledger remembers the latest date processed in each input file by sav- ing a hidden ".latest" state file in the same directory. Eg when read- - ing finance/bank.csv, it will look for and update the finance/.lat- - est.bank.csv state file. The format is simple: one or more lines con- - taining the same ISO-format date (YYYY-MM-DD), meaning "I have pro- - cessed transactions up to this date, and this many of them on that + ing finance/bank.csv, it will look for and update the finance/.lat- + est.bank.csv state file. The format is simple: one or more lines con- + taining the same ISO-format date (YYYY-MM-DD), meaning "I have pro- + cessed transactions up to this date, and this many of them on that date." Normally you won't see or manipulate these state files yourself. - But if needed, you can delete them to reset the state (making all - transactions "new"), or you can construct them to "catch up" to a cer- + But if needed, you can delete them to reset the state (making all + transactions "new"), or you can construct them to "catch up" to a cer- tain date. - Note deduplication (and updating of state files) can also be done by + Note deduplication (and updating of state files) can also be done by print --new, but this is less often used. Import testing - With --dry-run, the transactions that will be imported are printed to + With --dry-run, the transactions that will be imported are printed to the terminal, without updating your journal or state files. The output - is valid journal format, like the print command, so you can re-parse - it. Eg, to see any importable transactions which CSV rules have not + is valid journal format, like the print command, so you can re-parse + it. Eg, to see any importable transactions which CSV rules have not categorised: $ hledger import --dry bank.csv | hledger -f- -I print unknown @@ -3853,17 +3881,17 @@ COMMANDS $ ls bank.csv* | entr bash -c 'echo ====; hledger import --dry bank.csv | hledger -f- -I print unknown' Importing balance assignments - Entries added by import will have their posting amounts made explicit - (like hledger print -x). This means that any balance assignments in - imported files must be evaluated; but, imported files don't get to see - the main file's account balances. As a result, importing entries with + Entries added by import will have their posting amounts made explicit + (like hledger print -x). This means that any balance assignments in + imported files must be evaluated; but, imported files don't get to see + the main file's account balances. As a result, importing entries with balance assignments (eg from an institution that provides only balances - and not posting amounts) will probably generate incorrect posting + and not posting amounts) will probably generate incorrect posting amounts. To avoid this problem, use print instead of import: $ hledger print IMPORTFILE [--new] >> $LEDGER_FILE - (If you think import should leave amounts implicit like print does, + (If you think import should leave amounts implicit like print does, please test it and send a pull request.) Commodity display styles @@ -3873,12 +3901,12 @@ COMMANDS incomestatement incomestatement, is This command displays an income statement, showing revenues and - expenses during one or more periods. Amounts are shown with normal + expenses during one or more periods. Amounts are shown with normal positive sign, as in conventional financial statements. - This report shows accounts declared with the Revenue or Expense type - (see account types). Or if no such accounts are declared, it shows - top-level accounts named revenue or income or expense (case insensi- + This report shows accounts declared with the Revenue or Expense type + (see account types). Or if no such accounts are declared, it shows + top-level accounts named revenue or income or expense (case insensi- tive, plurals allowed) and their subaccounts. Example: @@ -3905,22 +3933,22 @@ COMMANDS 0 This command is a higher-level variant of the balance command, and sup- - ports many of that command's features, such as multi-period reports. + ports many of that command's features, such as multi-period reports. It is similar to hledger balance '(revenues|income)' expenses, but with - smarter account detection, and revenues/income displayed with their + smarter account detection, and revenues/income displayed with their sign flipped. - This command also supports the output destination and output format - options The output formats supported are txt, csv, html, and (experi- + This command also supports the output destination and output format + options The output formats supported are txt, csv, html, and (experi- mental) json. notes notes List the unique notes that appear in transactions. - This command lists the unique notes that appear in transactions, in - alphabetic order. You can add a query to select a subset of transac- - tions. The note is the part of the transaction description after a | + This command lists the unique notes that appear in transactions, in + alphabetic order. You can add a query to select a subset of transac- + tions. The note is the part of the transaction description after a | character (or if there is no |, the whole description). Example: @@ -3933,14 +3961,14 @@ COMMANDS payees List the unique payee/payer names that appear in transactions. - This command lists unique payee/payer names which have been declared - with payee directives (--declared), used in transaction descriptions + This command lists unique payee/payer names which have been declared + with payee directives (--declared), used in transaction descriptions (--used), or both (the default). - The payee/payer is the part of the transaction description before a | + The payee/payer is the part of the transaction description before a | character (or if there is no |, the whole description). - You can add query arguments to select a subset of transactions. This + You can add query arguments to select a subset of transactions. This implies --used. Example: @@ -3952,11 +3980,11 @@ COMMANDS prices prices - Print market price directives from the journal. With --infer-market- - prices, generate additional market prices from transaction prices. - With --infer-reverse-prices, also generate market prices by inverting + Print market price directives from the journal. With --infer-market- + prices, generate additional market prices from transaction prices. + With --infer-reverse-prices, also generate market prices by inverting transaction prices. Prices (and postings providing transaction prices) - can be filtered by a query. Price amounts are displayed with their + can be filtered by a query. Price amounts are displayed with their full precision. print @@ -3966,17 +3994,17 @@ COMMANDS The print command displays full journal entries (transactions) from the journal file, sorted by date (or with --date2, by secondary date). - Amounts are shown mostly normalised to commodity display style, eg the - placement of commodity symbols will be consistent. All of their deci- + Amounts are shown mostly normalised to commodity display style, eg the + placement of commodity symbols will be consistent. All of their deci- mal places are shown, as in the original journal entry (with one alter- ation: in some cases trailing zeroes are added.) Amounts are shown right-aligned within each transaction (but not across all transactions). - Directives and inter-transaction comments are not shown, currently. + Directives and inter-transaction comments are not shown, currently. This means the print command is somewhat lossy, and if you are using it - to reformat your journal you should take care to also copy over the + to reformat your journal you should take care to also copy over the directives and file-level comments. Eg: @@ -4003,7 +4031,7 @@ COMMANDS liabilities:debts $1 assets:bank:checking $-1 - print's output is usually a valid hledger journal, and you can process + print's output is usually a valid hledger journal, and you can process it again with a second hledger command. This can be useful for certain kinds of search, eg: @@ -4013,7 +4041,7 @@ COMMANDS There are some situations where print's output can become unparseable: - o Valuation affects posting amounts but not balance assertion or bal- + o Valuation affects posting amounts but not balance assertion or bal- ance assignment amounts, potentially causing those to fail. o Auto postings can generate postings with too many missing amounts. @@ -4022,32 +4050,32 @@ COMMANDS Normally, the journal entry's explicit or implicit amount style is pre- served. For example, when an amount is omitted in the journal, it will - not appear in the output. Similarly, when a transaction price is + not appear in the output. Similarly, when a transaction price is implied but not written, it will not appear in the output. You can use - the -x/--explicit flag to make all amounts and transaction prices - explicit, which can be useful for troubleshooting or for making your + the -x/--explicit flag to make all amounts and transaction prices + explicit, which can be useful for troubleshooting or for making your journal more readable and robust against data entry errors. -x is also implied by using any of -B,-V,-X,--value. - Note, -x/--explicit will cause postings with a multi-commodity amount - (these can arise when a multi-commodity transaction has an implicit - amount) to be split into multiple single-commodity postings, keeping + Note, -x/--explicit will cause postings with a multi-commodity amount + (these can arise when a multi-commodity transaction has an implicit + amount) to be split into multiple single-commodity postings, keeping the output parseable. - With -B/--cost, amounts with transaction prices are converted to cost + With -B/--cost, amounts with transaction prices are converted to cost using that price. This can be used for troubleshooting. - With -m/--match and a STR argument, print will show at most one trans- - action: the one one whose description is most similar to STR, and is - most recent. STR should contain at least two characters. If there is + With -m/--match and a STR argument, print will show at most one trans- + action: the one one whose description is most similar to STR, and is + most recent. STR should contain at least two characters. If there is no similar-enough match, no transaction will be shown. - With --new, hledger prints only transactions it has not seen on a pre- - vious run. This uses the same deduplication system as the import com- + With --new, hledger prints only transactions it has not seen on a pre- + vious run. This uses the same deduplication system as the import com- mand. (See import's docs for details.) - This command also supports the output destination and output format - options The output formats supported are txt, csv, and (experimental) + This command also supports the output destination and output format + options The output formats supported are txt, csv, and (experimental) json and sql. Here's an example of print's CSV output: @@ -4066,20 +4094,20 @@ COMMANDS "5","2008/12/31","","*","","pay off","","liabilities:debts","1","$","","1","","" "5","2008/12/31","","*","","pay off","","assets:bank:checking","-1","$","1","","","" - o There is one CSV record per posting, with the parent transaction's + o There is one CSV record per posting, with the parent transaction's fields repeated. o The "txnidx" (transaction index) field shows which postings belong to - the same transaction. (This number might change if transactions are - reordered within the file, files are parsed/included in a different + the same transaction. (This number might change if transactions are + reordered within the file, files are parsed/included in a different order, etc.) - o The amount is separated into "commodity" (the symbol) and "amount" + o The amount is separated into "commodity" (the symbol) and "amount" (numeric quantity) fields. o The numeric amount is repeated in either the "credit" or "debit" col- - umn, for convenience. (Those names are not accurate in the account- - ing sense; it just puts negative amounts under credit and zero or + umn, for convenience. (Those names are not accurate in the account- + ing sense; it just puts negative amounts under credit and zero or greater amounts under debit.) print-unique @@ -4103,14 +4131,14 @@ COMMANDS Show postings and their running total. The register command displays matched postings, across all accounts, in - date order, with their running total or running historical balance. - (See also the aregister command, which shows matched transactions in a + date order, with their running total or running historical balance. + (See also the aregister command, which shows matched transactions in a specific account.) register normally shows line per posting, but note that multi-commodity amounts will occupy multiple lines (one line per commodity). - It is typically used with a query selecting a particular account, to + It is typically used with a query selecting a particular account, to see that account's activity: $ hledger register checking @@ -4121,14 +4149,14 @@ COMMANDS With --date2, it shows and sorts by secondary date instead. - For performance reasons, column widths are chosen based on the first - 1000 lines; this means unusually wide values in later lines can cause - visual discontinuities as column widths are adjusted. If you want to - ensure perfect alignment, at the cost of more time and memory, use the + For performance reasons, column widths are chosen based on the first + 1000 lines; this means unusually wide values in later lines can cause + visual discontinuities as column widths are adjusted. If you want to + ensure perfect alignment, at the cost of more time and memory, use the --align-all flag. - The --historical/-H flag adds the balance from any undisplayed prior - postings to the running total. This is useful when you want to see + The --historical/-H flag adds the balance from any undisplayed prior + postings to the running total. This is useful when you want to see only recent activity, with a historically accurate running balance: $ hledger register checking -b 2008/6 --historical @@ -4138,30 +4166,30 @@ COMMANDS The --depth option limits the amount of sub-account detail displayed. - The --average/-A flag shows the running average posting amount instead + The --average/-A flag shows the running average posting amount instead of the running total (so, the final number displayed is the average for - the whole report period). This flag implies --empty (see below). It - is affected by --historical. It works best when showing just one + the whole report period). This flag implies --empty (see below). It + is affected by --historical. It works best when showing just one account and one commodity. - The --related/-r flag shows the other postings in the transactions of + The --related/-r flag shows the other postings in the transactions of the postings which would normally be shown. - The --invert flag negates all amounts. For example, it can be used on + The --invert flag negates all amounts. For example, it can be used on an income account where amounts are normally displayed as negative num- - bers. It's also useful to show postings on the checking account + bers. It's also useful to show postings on the checking account together with the related account: $ hledger register --related --invert assets:checking - With a reporting interval, register shows summary postings, one per + With a reporting interval, register shows summary postings, one per interval, aggregating the postings to each account: $ hledger register --monthly income 2008/01 income:salary $-1 $-1 2008/06 income:gifts $-1 $-2 - Periods with no activity, and summary postings with a zero amount, are + Periods with no activity, and summary postings with a zero amount, are not shown by default; use the --empty/-E flag to see them: $ hledger register --monthly income -E @@ -4178,7 +4206,7 @@ COMMANDS 2008/11 0 $-2 2008/12 0 $-2 - Often, you'll want to see just one line per interval. The --depth + Often, you'll want to see just one line per interval. The --depth option helps with this, causing subaccounts to be aggregated: $ hledger register --monthly assets --depth 1h @@ -4186,19 +4214,19 @@ COMMANDS 2008/06 assets $-1 0 2008/12 assets $-1 $-1 - Note when using report intervals, if you specify start/end dates these - will be adjusted outward if necessary to contain a whole number of - intervals. This ensures that the first and last intervals are full + Note when using report intervals, if you specify start/end dates these + will be adjusted outward if necessary to contain a whole number of + intervals. This ensures that the first and last intervals are full length and comparable to the others in the report. Custom register output - register uses the full terminal width by default, except on windows. - You can override this by setting the COLUMNS environment variable (not + register uses the full terminal width by default, except on windows. + You can override this by setting the COLUMNS environment variable (not a bash shell variable) or by using the --width/-w option. - The description and account columns normally share the space equally - (about half of (width - 40) each). You can adjust this by adding a - description width as part of --width's argument, comma-separated: + The description and account columns normally share the space equally + (about half of (width - 40) each). You can adjust this by adding a + description width as part of --width's argument, comma-separated: --width W,D . Here's a diagram (won't display correctly in --help): <--------------------------------- width (W) ----------------------------------> @@ -4214,28 +4242,28 @@ COMMANDS $ hledger reg -w 100,40 # set overall width 100, description width 40 $ hledger reg -w $COLUMNS,40 # use terminal width, & description width 40 - This command also supports the output destination and output format - options The output formats supported are txt, csv, and (experimental) + This command also supports the output destination and output format + options The output formats supported are txt, csv, and (experimental) json. register-match register-match Print the one posting whose transaction description is closest to DESC, - in the style of the register command. If there are multiple equally - good matches, it shows the most recent. Query options (options, not - arguments) can be used to restrict the search space. Helps ledger- + in the style of the register command. If there are multiple equally + good matches, it shows the most recent. Query options (options, not + arguments) can be used to restrict the search space. Helps ledger- autosync detect already-seen transactions when importing. rewrite rewrite Print all transactions, rewriting the postings of matched transactions. - For now the only rewrite available is adding new postings, like print + For now the only rewrite available is adding new postings, like print --auto. This is a start at a generic rewriter of transaction entries. It reads - the default journal and prints the transactions, like print, but adds + the default journal and prints the transactions, like print, but adds one or more specified postings to any transactions matching QUERY. The - posting amounts can be fixed, or a multiplier of the existing transac- + posting amounts can be fixed, or a multiplier of the existing transac- tion's first posting amount. Examples: @@ -4251,7 +4279,7 @@ COMMANDS (reserve:grocery) *0.25 ; reserve 25% for grocery (reserve:) *0.25 ; reserve 25% for grocery - Note the single quotes to protect the dollar sign from bash, and the + Note the single quotes to protect the dollar sign from bash, and the two spaces between account and amount. More: @@ -4261,16 +4289,16 @@ COMMANDS $ hledger rewrite -- expenses:gifts --add-posting '(budget:gifts) *-1"' $ hledger rewrite -- ^income --add-posting '(budget:foreign currency) *0.25 JPY; diversify' - Argument for --add-posting option is a usual posting of transaction - with an exception for amount specification. More precisely, you can + Argument for --add-posting option is a usual posting of transaction + with an exception for amount specification. More precisely, you can use '*' (star symbol) before the amount to indicate that that this is a - factor for an amount of original matched posting. If the amount - includes a commodity name, the new posting amount will be in the new - commodity; otherwise, it will be in the matched posting amount's com- + factor for an amount of original matched posting. If the amount + includes a commodity name, the new posting amount will be in the new + commodity; otherwise, it will be in the matched posting amount's com- modity. Re-write rules in a file - During the run this tool will execute so called "Automated Transac- + During the run this tool will execute so called "Automated Transac- tions" found in any journal it process. I.e instead of specifying this operations in command line you can put them in a journal file. @@ -4285,7 +4313,7 @@ COMMANDS budget:gifts *-1 assets:budget *1 - Note that '=' (equality symbol) that is used instead of date in trans- + Note that '=' (equality symbol) that is used instead of date in trans- actions you usually write. It indicates the query by which you want to match the posting to add new ones. @@ -4298,12 +4326,12 @@ COMMANDS --add-posting 'assets:budget *1' \ > rewritten-tidy-output.journal - It is important to understand that relative order of such entries in - journal is important. You can re-use result of previously added post- + It is important to understand that relative order of such entries in + journal is important. You can re-use result of previously added post- ings. Diff output format - To use this tool for batch modification of your journal files you may + To use this tool for batch modification of your journal files you may find useful output in form of unified diff. $ hledger rewrite -- --diff -f examples/sample.journal '^income' --add-posting '(liabilities:tax) *.33' @@ -4327,10 +4355,10 @@ COMMANDS If you'll pass this through patch tool you'll get transactions contain- ing the posting that matches your query be updated. Note that multiple - files might be update according to list of input files specified via + files might be update according to list of input files specified via --file options and include directives inside of these files. - Be careful. Whole transaction being re-formatted in a style of output + Be careful. Whole transaction being re-formatted in a style of output from hledger print. See also: @@ -4338,54 +4366,54 @@ COMMANDS https://github.com/simonmichael/hledger/issues/99 rewrite vs. print --auto - This command predates print --auto, and currently does much the same + This command predates print --auto, and currently does much the same thing, but with these differences: - o with multiple files, rewrite lets rules in any file affect all other - files. print --auto uses standard directive scoping; rules affect + o with multiple files, rewrite lets rules in any file affect all other + files. print --auto uses standard directive scoping; rules affect only child files. - o rewrite's query limits which transactions can be rewritten; all are + o rewrite's query limits which transactions can be rewritten; all are printed. print --auto's query limits which transactions are printed. - o rewrite applies rules specified on command line or in the journal. + o rewrite applies rules specified on command line or in the journal. print --auto applies rules specified in the journal. roi roi - Shows the time-weighted (TWR) and money-weighted (IRR) rate of return + Shows the time-weighted (TWR) and money-weighted (IRR) rate of return on your investments. - At a minimum, you need to supply a query (which could be just an - account name) to select your investment(s) with --inv, and another + At a minimum, you need to supply a query (which could be just an + account name) to select your investment(s) with --inv, and another query to identify your profit and loss transactions with --pnl. - If you do not record changes in the value of your investment manually, - or do not require computation of time-weighted return (TWR), --pnl + If you do not record changes in the value of your investment manually, + or do not require computation of time-weighted return (TWR), --pnl could be an empty query (--pnl "" or --pnl STR where STR does not match any of your accounts). - This command will compute and display the internalized rate of return - (IRR) and time-weighted rate of return (TWR) for your investments for - the time period requested. Both rates of return are annualized before + This command will compute and display the internalized rate of return + (IRR) and time-weighted rate of return (TWR) for your investments for + the time period requested. Both rates of return are annualized before display, regardless of the length of reporting interval. - Price directives will be taken into account if you supply appropriate + Price directives will be taken into account if you supply appropriate --cost or --value flags (see VALUATION). Note, in some cases this report can fail, for these reasons: - o Error (NotBracketed): No solution for Internal Rate of Return (IRR). - Possible causes: IRR is huge (>1000000%), balance of investment + o Error (NotBracketed): No solution for Internal Rate of Return (IRR). + Possible causes: IRR is huge (>1000000%), balance of investment becomes negative at some point in time. - o Error (SearchFailed): Failed to find solution for Internal Rate of + o Error (SearchFailed): Failed to find solution for Internal Rate of Return (IRR). Either search does not converge to a solution, or con- verges too slowly. Examples: - o Using roi to compute total return of investment in stocks: + o Using roi to compute total return of investment in stocks: https://github.com/simonmichael/hledger/blob/master/examples/invest- ing/roi-unrealised.ledger @@ -4395,27 +4423,27 @@ COMMANDS Note that --inv and --pnl's argument is a query, and queries could have several space-separated terms (see QUERIES). - To indicate that all search terms form single command-line argument, + To indicate that all search terms form single command-line argument, you will need to put them in quotes (see Special characters): $ hledger roi --inv 'term1 term2 term3 ...' - If any query terms contain spaces themselves, you will need an extra + If any query terms contain spaces themselves, you will need an extra level of nested quoting, eg: $ hledger roi --inv="'Assets:Test 1'" --pnl="'Equity:Unrealized Profit and Loss'" Semantics of --inv and --pnl - Query supplied to --inv has to match all transactions that are related + Query supplied to --inv has to match all transactions that are related to your investment. Transactions not matching --inv will be ignored. In these transactions, ROI will conside postings that match --inv to be - "investment postings" and other postings (not matching --inv) will be - sorted into two categories: "cash flow" and "profit and loss", as ROI - needs to know which part of the investment value is your contributions + "investment postings" and other postings (not matching --inv) will be + sorted into two categories: "cash flow" and "profit and loss", as ROI + needs to know which part of the investment value is your contributions and which is due to the return on investment. - o "Cash flow" is depositing or withdrawing money, buying or selling + o "Cash flow" is depositing or withdrawing money, buying or selling assets, or otherwise converting between your investment commodity and any other commodity. Example: @@ -4433,12 +4461,12 @@ COMMANDS investment:snake oil = $57 equity:unrealized profit or loss - All non-investment postings are assumed to be "cash flow", unless they - match --pnl query. Changes in value of your investment due to "profit - and loss" postings will be considered as part of your investment + All non-investment postings are assumed to be "cash flow", unless they + match --pnl query. Changes in value of your investment due to "profit + and loss" postings will be considered as part of your investment return. - Example: if you use --inv snake --pnl equity:unrealized, then postings + Example: if you use --inv snake --pnl equity:unrealized, then postings in the example below would be classifed as: 2019-01-01 Snake Oil #1 @@ -4455,57 +4483,57 @@ COMMANDS snake oil $50 ; investment posting IRR and TWR explained - "ROI" stands for "return on investment". Traditionally this was com- - puted as a difference between current value of investment and its ini- + "ROI" stands for "return on investment". Traditionally this was com- + puted as a difference between current value of investment and its ini- tial value, expressed in percentage of the initial value. However, this approach is only practical in simple cases, where invest- - ments receives no in-flows or out-flows of money, and where rate of + ments receives no in-flows or out-flows of money, and where rate of growth is fixed over time. For more complex scenarios you need differ- - ent ways to compute rate of return, and this command implements two of + ent ways to compute rate of return, and this command implements two of them: IRR and TWR. - Internal rate of return, or "IRR" (also called "money-weighted rate of - return") takes into account effects of in-flows and out-flows. + Internal rate of return, or "IRR" (also called "money-weighted rate of + return") takes into account effects of in-flows and out-flows. Naively, if you are withdrawing from your investment, your future gains - would be smaller (in absolute numbers), and will be a smaller percent- - age of your initial investment, and if you are adding to your invest- - ment, you will receive bigger absolute gains (but probably at the same - rate of return). IRR is a way to compute rate of return for each + would be smaller (in absolute numbers), and will be a smaller percent- + age of your initial investment, and if you are adding to your invest- + ment, you will receive bigger absolute gains (but probably at the same + rate of return). IRR is a way to compute rate of return for each period between in-flow or out-flow of money, and then combine them in a - way that gives you a compound annual rate of return that investment is + way that gives you a compound annual rate of return that investment is expected to generate. - As mentioned before, in-flows and out-flows would be any cash that you + As mentioned before, in-flows and out-flows would be any cash that you personally put in or withdraw, and for the "roi" command, these are the - postings that match the query in the--inv argument and NOT match the + postings that match the query in the--inv argument and NOT match the query in the--pnl argument. - If you manually record changes in the value of your investment as - transactions that balance them against "profit and loss" (or "unreal- - ized gains") account or use price directives, then in order for IRR to - compute the precise effect of your in-flows and out-flows on the rate - of return, you will need to record the value of your investement on or + If you manually record changes in the value of your investment as + transactions that balance them against "profit and loss" (or "unreal- + ized gains") account or use price directives, then in order for IRR to + compute the precise effect of your in-flows and out-flows on the rate + of return, you will need to record the value of your investement on or close to the days when in- or out-flows occur. - In technical terms, IRR uses the same approach as computation of net + In technical terms, IRR uses the same approach as computation of net present value, and tries to find a discount rate that makes net present value of all the cash flows of your investment to add up to zero. This - could be hard to wrap your head around, especially if you haven't done + could be hard to wrap your head around, especially if you haven't done discounted cash flow analysis before. Implementation of IRR in hledger should produce results that match the XIRR formula in Excel. - Second way to compute rate of return that roi command implements is + Second way to compute rate of return that roi command implements is called "time-weighted rate of return" or "TWR". Like IRR, it will also - break the history of your investment into periods between in-flows, - out-flows and value changes, to compute rate of return per each period - and then a compound rate of return. However, internal workings of TWR + break the history of your investment into periods between in-flows, + out-flows and value changes, to compute rate of return per each period + and then a compound rate of return. However, internal workings of TWR are quite different. - TWR represents your investment as an imaginary "unit fund" where in- - flows/ out-flows lead to buying or selling "units" of your investment + TWR represents your investment as an imaginary "unit fund" where in- + flows/ out-flows lead to buying or selling "units" of your investment and changes in its value change the value of "investment unit". Change - in "unit price" over the reporting period gives you rate of return of + in "unit price" over the reporting period gives you rate of return of your investment. References: @@ -4516,22 +4544,22 @@ COMMANDS o Explanation of TWR - o Examples of computing IRR and TWR and discussion of the limitations + o Examples of computing IRR and TWR and discussion of the limitations of both metrics stats stats Show journal and performance statistics. - The stats command displays summary information for the whole journal, - or a matched part of it. With a reporting interval, it shows a report + The stats command displays summary information for the whole journal, + or a matched part of it. With a reporting interval, it shows a report for each report period. - At the end, it shows (in the terminal) the overall run time and number - of transactions processed per second. Note these are approximate and - will vary based on machine, current load, data size, hledger version, - haskell lib versions, GHC version.. but they may be of interest. The - stats command's run time is similar to that of a single-column balance + At the end, it shows (in the terminal) the overall run time and number + of transactions processed per second. Note these are approximate and + will vary based on machine, current load, data size, hledger version, + haskell lib versions, GHC version.. but they may be of interest. The + stats command's run time is similar to that of a single-column balance report. Example: @@ -4552,7 +4580,7 @@ COMMANDS Run time : 0.12 s Throughput : 8342 txns/s - This command also supports output destination and output format selec- + This command also supports output destination and output format selec- tion. tags @@ -4562,22 +4590,22 @@ COMMANDS This command lists the tag names used in the journal, whether on trans- actions, postings, or account declarations. - With a TAGREGEX argument, only tag names matching this regular expres- + With a TAGREGEX argument, only tag names matching this regular expres- sion (case insensitive, infix matched) are shown. - With QUERY arguments, only transactions and accounts matching this + With QUERY arguments, only transactions and accounts matching this query are considered. If the query involves transaction fields (date:, desc:, amt:, ...), the search is restricted to the matched transactions and their accounts. - With the --values flag, the tags' unique non-empty values are listed + With the --values flag, the tags' unique non-empty values are listed instead. With -E/--empty, blank/empty values are also shown. - With --parsed, tags or values are shown in the order they were parsed, - with duplicates included. (Except, tags from account declarations are + With --parsed, tags or values are shown in the order they were parsed, + with duplicates included. (Except, tags from account declarations are always shown first.) - Tip: remember, accounts also acquire tags from their parents, postings + Tip: remember, accounts also acquire tags from their parents, postings also acquire tags from their account and transaction, transactions also acquire tags from their postings. @@ -4585,13 +4613,13 @@ COMMANDS test Run built-in unit tests. - This command runs the unit tests built in to hledger and hledger-lib, - printing the results on stdout. If any test fails, the exit code will + This command runs the unit tests built in to hledger and hledger-lib, + printing the results on stdout. If any test fails, the exit code will be non-zero. - This is mainly used by hledger developers, but you can also use it to - sanity-check the installed hledger executable on your platform. All - tests are expected to pass - if you ever see a failure, please report + This is mainly used by hledger developers, but you can also use it to + sanity-check the installed hledger executable on your platform. All + tests are expected to pass - if you ever see a failure, please report as a bug! This command also accepts tasty test runner options, written after a -- @@ -4600,7 +4628,7 @@ COMMANDS $ hledger test -- -pData.Amount --color=never - For help on these, see https://github.com/feuerbach/tasty#options (-- + For help on these, see https://github.com/feuerbach/tasty#options (-- --help currently doesn't show them). Add-on commands @@ -4608,16 +4636,16 @@ COMMANDS o whose name starts with hledger- - o whose name ends with a recognised file extension: .bat,.com,.exe, + o whose name ends with a recognised file extension: .bat,.com,.exe, .hs,.lhs,.pl,.py,.rb,.rkt,.sh or none o and (on unix, mac) which are executable by the current user. - Add-ons are a relatively easy way to add local features or experiment - with new ideas. They can be written in any language, but haskell - scripts have a big advantage: they can use the same hledger library - functions that built-in commands use for command-line options, parsing - and reporting. Some experimental/example add-on scripts can be found + Add-ons are a relatively easy way to add local features or experiment + with new ideas. They can be written in any language, but haskell + scripts have a big advantage: they can use the same hledger library + functions that built-in commands use for command-line options, parsing + and reporting. Some experimental/example add-on scripts can be found in the hledger repo's bin/ directory. Note in a hledger command line, add-on command flags must have a double @@ -4641,17 +4669,17 @@ COMMANDS JOURNAL FORMAT hledger's default file format, representing a General Journal. - hledger's usual data source is a plain text file containing journal - entries in hledger journal format. This file represents a standard - accounting general journal. I use file names ending in .journal, but + hledger's usual data source is a plain text file containing journal + entries in hledger journal format. This file represents a standard + accounting general journal. I use file names ending in .journal, but that's not required. The journal file contains a number of transaction entries, each describing a transfer of money (or any commodity) between two or more named accounts, in a simple format readable by both hledger and humans. - hledger's journal format is a compatible subset, mostly, of ledger's - journal format, so hledger can work with compatible ledger journal - files as well. It's safe, and encouraged, to run both hledger and + hledger's journal format is a compatible subset, mostly, of ledger's + journal format, so hledger can work with compatible ledger journal + files as well. It's safe, and encouraged, to run both hledger and ledger on the same journal file, eg to validate the results you're get- ting. @@ -4659,25 +4687,25 @@ JOURNAL FORMAT the add or web or import commands to create and update it. Many users, though, edit the journal file with a text editor, and track - changes with a version control system such as git. Editor addons such - as ledger-mode or hledger-mode for Emacs, vim-ledger for Vim, and + changes with a version control system such as git. Editor addons such + as ledger-mode or hledger-mode for Emacs, vim-ledger for Vim, and hledger-vscode for Visual Studio Code, make this easier, adding colour, formatting, tab completion, and useful commands. See Editor configura- tion at hledger.org for the full list. - Here's a description of each part of the file format (and hledger's - data model). These are mostly in the order you'll use them, but in - some cases related concepts have been grouped together for easy refer- - ence, or linked before they are introduced, so feel free to skip over + Here's a description of each part of the file format (and hledger's + data model). These are mostly in the order you'll use them, but in + some cases related concepts have been grouped together for easy refer- + ence, or linked before they are introduced, so feel free to skip over anything that looks unnecessary right now. Transactions - Transactions are the main unit of information in a journal file. They - represent events, typically a movement of some quantity of commodities + Transactions are the main unit of information in a journal file. They + represent events, typically a movement of some quantity of commodities between two or more named accounts. - Each transaction is recorded as a journal entry, beginning with a sim- - ple date in column 0. This can be followed by any of the following + Each transaction is recorded as a journal entry, beginning with a sim- + ple date in column 0. This can be followed by any of the following optional fields, separated by spaces: o a status character (empty, !, or *) @@ -4686,11 +4714,11 @@ JOURNAL FORMAT o a description (any remaining text until end of line or a semicolon) - o a comment (any remaining text following a semicolon until end of + o a comment (any remaining text following a semicolon until end of line, and any following indented lines beginning with a semicolon) o 0 or more indented posting lines, describing what was transferred and - the accounts involved (indented comment lines are also allowed, but + the accounts involved (indented comment lines are also allowed, but not blank lines or non-indented lines). Here's a simple journal file containing one transaction: @@ -4701,35 +4729,35 @@ JOURNAL FORMAT Dates Simple dates - Dates in the journal file use simple dates format: YYYY-MM-DD or + Dates in the journal file use simple dates format: YYYY-MM-DD or YYYY/MM/DD or YYYY.MM.DD, with leading zeros optional. The year may be - omitted, in which case it will be inferred from the context: the cur- - rent transaction, the default year set with a default year directive, - or the current date when the command is run. Some examples: + omitted, in which case it will be inferred from the context: the cur- + rent transaction, the default year set with a default year directive, + or the current date when the command is run. Some examples: 2010-01-31, 2010/01/31, 2010.1.31, 1/31. - (The UI also accepts simple dates, as well as the more flexible smart + (The UI also accepts simple dates, as well as the more flexible smart dates documented in the hledger manual.) Secondary dates - Real-life transactions sometimes involve more than one date - eg the + Real-life transactions sometimes involve more than one date - eg the date you write a cheque, and the date it clears in your bank. When you - want to model this, for more accurate daily balances, you can specify + want to model this, for more accurate daily balances, you can specify individual posting dates. - Or, you can use the older secondary date feature (Ledger calls it aux- - iliary date or effective date). Note: we support this for compatibil- - ity, but I usually recommend avoiding this feature; posting dates are + Or, you can use the older secondary date feature (Ledger calls it aux- + iliary date or effective date). Note: we support this for compatibil- + ity, but I usually recommend avoiding this feature; posting dates are almost always clearer and simpler. A secondary date is written after the primary date, following an equals - sign. If the year is omitted, the primary date's year is assumed. - When running reports, the primary (left) date is used by default, but - with the --date2 flag (or --aux-date or --effective), the secondary + sign. If the year is omitted, the primary date's year is assumed. + When running reports, the primary (left) date is used by default, but + with the --date2 flag (or --aux-date or --effective), the secondary (right) date will be used instead. - The meaning of secondary dates is up to you, but it's best to follow a - consistent rule. Eg "primary = the bank's clearing date, secondary = + The meaning of secondary dates is up to you, but it's best to follow a + consistent rule. Eg "primary = the bank's clearing date, secondary = date the transaction was initiated, if different", as shown here: 2010/2/23=2/19 movie ticket @@ -4743,11 +4771,11 @@ JOURNAL FORMAT 2010-02-19 movie ticket assets:checking $-10 $-10 Posting dates - You can give individual postings a different date from their parent - transaction, by adding a posting comment containing a tag (see below) + You can give individual postings a different date from their parent + transaction, by adding a posting comment containing a tag (see below) like date:DATE. This is probably the best way to control posting dates - precisely. Eg in this example the expense should appear in May - reports, and the deduction from checking should be reported on 6/1 for + precisely. Eg in this example the expense should appear in May + reports, and the deduction from checking should be reported on 6/1 for easy bank reconciliation: 2015/5/30 @@ -4760,22 +4788,22 @@ JOURNAL FORMAT $ hledger -f t.j register checking 2015-06-01 assets:checking $-10 $-10 - DATE should be a simple date; if the year is not specified it will use - the year of the transaction's date. You can set the secondary date - similarly, with date2:DATE2. The date: or date2: tags must have a - valid simple date value if they are present, eg a date: tag with no + DATE should be a simple date; if the year is not specified it will use + the year of the transaction's date. You can set the secondary date + similarly, with date2:DATE2. The date: or date2: tags must have a + valid simple date value if they are present, eg a date: tag with no value is not allowed. Ledger's earlier, more compact bracketed date syntax is also supported: - [DATE], [DATE=DATE2] or [=DATE2]. hledger will attempt to parse any + [DATE], [DATE=DATE2] or [=DATE2]. hledger will attempt to parse any square-bracketed sequence of the 0123456789/-.= characters in this way. - With this syntax, DATE infers its year from the transaction and DATE2 + With this syntax, DATE infers its year from the transaction and DATE2 infers its year from DATE. Status - Transactions, or individual postings within a transaction, can have a - status mark, which is a single character before the transaction - description or posting account name, separated from it by a space, + Transactions, or individual postings within a transaction, can have a + status mark, which is a single character before the transaction + description or posting account name, separated from it by a space, indicating one of three statuses: @@ -4785,69 +4813,71 @@ JOURNAL FORMAT ! pending * cleared - When reporting, you can filter by status with the -U/--unmarked, - -P/--pending, and -C/--cleared flags; or the status:, status:!, and + When reporting, you can filter by status with the -U/--unmarked, + -P/--pending, and -C/--cleared flags; or the status:, status:!, and status:* queries; or the U, P, C keys in hledger-ui. - Note, in Ledger and in older versions of hledger, the "unmarked" state - is called "uncleared". As of hledger 1.3 we have renamed it to + Note, in Ledger and in older versions of hledger, the "unmarked" state + is called "uncleared". As of hledger 1.3 we have renamed it to unmarked for clarity. - To replicate Ledger and old hledger's behaviour of also matching pend- + To replicate Ledger and old hledger's behaviour of also matching pend- ing, combine -U and -P. - Status marks are optional, but can be helpful eg for reconciling with + Status marks are optional, but can be helpful eg for reconciling with real-world accounts. Some editor modes provide highlighting and short- - cuts for working with status. Eg in Emacs ledger-mode, you can toggle + cuts for working with status. Eg in Emacs ledger-mode, you can toggle transaction status with C-c C-e, or posting status with C-c C-c. - What "uncleared", "pending", and "cleared" actually mean is up to you. + What "uncleared", "pending", and "cleared" actually mean is up to you. Here's one suggestion: status meaning -------------------------------------------------------------------------- uncleared recorded but not yet reconciled; needs review + + pending tentatively reconciled (if needed, eg during a big reconcil- iation) cleared complete, reconciled as far as possible, and considered cor- rect - With this scheme, you would use -PC to see the current balance at your - bank, -U to see things which will probably hit your bank soon (like + With this scheme, you would use -PC to see the current balance at your + bank, -U to see things which will probably hit your bank soon (like uncashed checks), and no flags to see the most up-to-date state of your finances. Code - After the status mark, but before the description, you can optionally - write a transaction "code", enclosed in parentheses. This is a good - place to record a check number, or some other important transaction id + After the status mark, but before the description, you can optionally + write a transaction "code", enclosed in parentheses. This is a good + place to record a check number, or some other important transaction id or reference number. Description - A transaction's description is the rest of the line following the date - and status mark (or until a comment begins). Sometimes called the + A transaction's description is the rest of the line following the date + and status mark (or until a comment begins). Sometimes called the "narration" in traditional bookkeeping, it can be used for whatever you - wish, or left blank. Transaction descriptions can be queried, unlike + wish, or left blank. Transaction descriptions can be queried, unlike comments. Payee and note You can optionally include a | (pipe) character in descriptions to sub- divide the description into separate fields for payee/payer name on the - left (up to the first |) and an additional note field on the right - (after the first |). This may be worthwhile if you need to do more + left (up to the first |) and an additional note field on the right + (after the first |). This may be worthwhile if you need to do more precise querying and pivoting by payee or by note. Comments Lines in the journal beginning with a semicolon (;) or hash (#) or star - (*) are comments, and will be ignored. (Star comments cause org-mode - nodes to be ignored, allowing emacs users to fold and navigate their + (*) are comments, and will be ignored. (Star comments cause org-mode + nodes to be ignored, allowing emacs users to fold and navigate their journals with org-mode or orgstruct-mode.) - You can attach comments to a transaction by writing them after the - description and/or indented on the following lines (before the post- - ings). Similarly, you can attach comments to an individual posting by - writing them after the amount and/or indented on the following lines. + You can attach comments to a transaction by writing them after the + description and/or indented on the following lines (before the post- + ings). Similarly, you can attach comments to an individual posting by + writing them after the amount and/or indented on the following lines. Transaction and posting comments must begin with a semicolon (;). Some examples: @@ -4870,15 +4900,15 @@ JOURNAL FORMAT ; another comment line for posting 2 ; a file comment (because not indented) - You can also comment larger regions of a file using comment and end + You can also comment larger regions of a file using comment and end comment directives. Tags - Tags are a way to add extra labels or labelled data to transactions, + Tags are a way to add extra labels or labelled data to transactions, postings, or accounts, which you can then search or pivot on. They are written as a (optionally hyphenated) word immediately followed - by a full colon within a transaction or posting or account directive's + by a full colon within a transaction or posting or account directive's comment: account assets:checking ; accounttag: @@ -4894,16 +4924,16 @@ JOURNAL FORMAT o Tags on an account affect all postings to that account. - So in the example above, - the assets:checking account has one tag - (accounttag) - the transaction has two tags (transaction-tag, another- + So in the example above, - the assets:checking account has one tag + (accounttag) - the transaction has two tags (transaction-tag, another- transaction-tag) - the assets:checking posting has three tags (transac- tion-tag, another-transaction-tag, accounttag) - the expenses:food posting has three tags (transaction-tag, another-transaction-tag, post- ing-tag). - Tags can have a value, which is the text after the colon, until the - next comma or end of line, with surrounding whitespace stripped. So - here a-posting-tag's value is "the tag value", tag2's value is "foo", + Tags can have a value, which is the text after the colon, until the + next comma or end of line, with surrounding whitespace stripped. So + here a-posting-tag's value is "the tag value", tag2's value is "foo", and tag3's value is "" (the empty string): expenses:food $10 @@ -4912,44 +4942,44 @@ JOURNAL FORMAT A hledger tag value may not contain a comma. Postings - A posting is an addition of some amount to, or removal of some amount - from, an account. Each posting line begins with at least one space or + A posting is an addition of some amount to, or removal of some amount + from, an account. Each posting line begins with at least one space or tab (2 or 4 spaces is common), followed by: o (optional) a status character (empty, !, or *), followed by a space - o (required) an account name (any text, optionally containing single + o (required) an account name (any text, optionally containing single spaces, until end of line or a double space) o (optional) two or more spaces or tabs followed by an amount. - Positive amounts are being added to the account, negative amounts are + Positive amounts are being added to the account, negative amounts are being removed. The amounts within a transaction must always sum up to zero. As a con- - venience, one amount may be left blank; it will be inferred so as to + venience, one amount may be left blank; it will be inferred so as to balance the transaction. - Be sure to note the unusual two-space delimiter between account name - and amount. This makes it easy to write account names containing spa- - ces. But if you accidentally leave only one space (or tab) before the + Be sure to note the unusual two-space delimiter between account name + and amount. This makes it easy to write account names containing spa- + ces. But if you accidentally leave only one space (or tab) before the amount, the amount will be considered part of the account name. Virtual postings A posting with a parenthesised account name is called a virtual posting - or unbalanced posting, which means it is exempt from the usual rule + or unbalanced posting, which means it is exempt from the usual rule that a transaction's postings must balance add up to zero. - This is not part of double entry accounting, so you might choose to - avoid this feature. Or you can use it sparingly for certain special - cases where it can be convenient. Eg, you could set opening balances + This is not part of double entry accounting, so you might choose to + avoid this feature. Or you can use it sparingly for certain special + cases where it can be convenient. Eg, you could set opening balances without using a balancing equity account: 1/1 opening balances (assets:checking) $1000 (assets:savings) $2000 - A posting with a bracketed account name is called a balanced virtual + A posting with a bracketed account name is called a balanced virtual posting. The balanced virtual postings in a transaction must add up to zero (separately from other postings). Eg: @@ -4961,34 +4991,34 @@ JOURNAL FORMAT [assets:checking:available] $10 ; <- (something:else) $5 ; <- not required to balance - Ordinary non-parenthesised, non-bracketed postings are called real - postings. You can exclude virtual postings from reports with the + Ordinary non-parenthesised, non-bracketed postings are called real + postings. You can exclude virtual postings from reports with the -R/--real flag or real:1 query. Account names - Account names typically have several parts separated by a full colon, - from which hledger derives a hierarchical chart of accounts. They can - be anything you like, but in finance there are traditionally five top- + Account names typically have several parts separated by a full colon, + from which hledger derives a hierarchical chart of accounts. They can + be anything you like, but in finance there are traditionally five top- level accounts: assets, liabilities, revenue, expenses, and equity. - Account names may contain single spaces, eg: assets:accounts receiv- - able. Because of this, they must always be followed by two or more + Account names may contain single spaces, eg: assets:accounts receiv- + able. Because of this, they must always be followed by two or more spaces (or newline). Account names can be aliased. Amounts - After the account name, there is usually an amount. (Important: + After the account name, there is usually an amount. (Important: between account name and amount, there must be two or more spaces.) - hledger's amount format is flexible, supporting several international - formats. Here are some examples. Amounts have a number (the "quan- + hledger's amount format is flexible, supporting several international + formats. Here are some examples. Amounts have a number (the "quan- tity"): 1 ..and usually a currency symbol or commodity name (more on this below), - to the left or right of the quantity, with or without a separating + to the left or right of the quantity, with or without a separating space: $1 @@ -4996,13 +5026,13 @@ JOURNAL FORMAT 3 "green apples" Amounts can be preceded by a minus sign (or a plus sign, though plus is - the default), The sign can be written before or after a left-side com- + the default), The sign can be written before or after a left-side com- modity symbol: -$1 $-1 - One or more spaces between the sign and the number are acceptable when + One or more spaces between the sign and the number are acceptable when parsing (but they won't be displayed in output): + $1 @@ -5019,8 +5049,8 @@ JOURNAL FORMAT 1.23 1,23456780000009 - In the integer part of the quantity (left of the decimal mark), groups - of digits can optionally be separated by a digit group mark - a space, + In the integer part of the quantity (left of the decimal mark), groups + of digits can optionally be separated by a digit group mark - a space, comma, or period (different from the decimal mark): $1,000,000.00 @@ -5034,41 +5064,41 @@ JOURNAL FORMAT 1,000 1.000 - If you don't tell it otherwise, hledger will assume both of the above + If you don't tell it otherwise, hledger will assume both of the above are decimal marks, parsing both numbers as 1. - To prevent confusing parsing mistakes and undetected typos, especially - if your data contains digit group marks (eg, thousands separators), we + To prevent confusing parsing mistakes and undetected typos, especially + if your data contains digit group marks (eg, thousands separators), we recommend explicitly declaring the decimal mark character in each jour- - nal file, using a directive at the top of the file. The decimal-mark - directive is best, otherwise commodity directives will also work. + nal file, using a directive at the top of the file. The decimal-mark + directive is best, otherwise commodity directives will also work. These are described detail below. Commodity - Amounts in hledger have both a "quantity", which is a signed decimal + Amounts in hledger have both a "quantity", which is a signed decimal number, and a "commodity", which is a currency symbol, stock ticker, or any word or phrase describing something you are tracking. If the commodity name contains non-letters (spaces, numbers, or punctu- - ation), you must always write it inside double quotes ("green apples", + ation), you must always write it inside double quotes ("green apples", "ABC123"). - If you write just a bare number, that too will have a commodity, with + If you write just a bare number, that too will have a commodity, with name ""; we call that the "no-symbol commodity". - Actually, hledger combines these single-commodity amounts into more - powerful multi-commodity amounts, which are what it works with most of - the time. A multi-commodity amount could be, eg: 1 USD, 2 EUR, 3.456 - TSLA. In practice, you will only see multi-commodity amounts in + Actually, hledger combines these single-commodity amounts into more + powerful multi-commodity amounts, which are what it works with most of + the time. A multi-commodity amount could be, eg: 1 USD, 2 EUR, 3.456 + TSLA. In practice, you will only see multi-commodity amounts in hledger's output; you can't write them directly in the journal file. - (If you are writing scripts or working with hledger's internals, these + (If you are writing scripts or working with hledger's internals, these are the Amount and MixedAmount types.) Directives influencing number parsing and display - You can add decimal-mark and commodity directives to the journal, to - declare and control these things more explicitly and precisely. These - are described below, in JOURNAL FORMAT -> Declaring commodities. + You can add decimal-mark and commodity directives to the journal, to + declare and control these things more explicitly and precisely. These + are described below, in JOURNAL FORMAT -> Declaring commodities. Here's a quick example: # the decimal mark character used by all amounts in this file (all commodities) @@ -5083,48 +5113,48 @@ JOURNAL FORMAT Commodity display style For the amounts in each commodity, hledger chooses a consistent display - style to use in most reports. (Exceptions: price amounts, and all + style to use in most reports. (Exceptions: price amounts, and all amounts displayed by the print command, are displayed with all of their decimal digits visible.) A commodity's display style is inferred as follows. - First, if a default commodity is declared with D, this commodity and + First, if a default commodity is declared with D, this commodity and its style is applied to any no-symbol amounts in the journal. - Then each commodity's style is inferred from one of the following, in + Then each commodity's style is inferred from one of the following, in order of preference: - o The commodity directive for that commodity (including the no-symbol + o The commodity directive for that commodity (including the no-symbol commodity), if any. - o The amounts in that commodity seen in the journal's transactions. + o The amounts in that commodity seen in the journal's transactions. (Posting amounts only; prices and periodic or auto rules are ignored, currently.) - o The built-in fallback style, which looks like this: $1000.00. (Sym- + o The built-in fallback style, which looks like this: $1000.00. (Sym- bol on the left, period decimal mark, two decimal places.) A style is inferred from journal amounts as follows: - o Use the general style (decimal mark, symbol placement) of the first + o Use the general style (decimal mark, symbol placement) of the first amount - o Use the first-seen digit group style (digit group mark, digit group + o Use the first-seen digit group style (digit group mark, digit group sizes), if any o Use the maximum number of decimal places of all. - Transaction price amounts don't affect the commodity display style - directly, but occasionally they can do so indirectly (eg when a post- - ing's amount is inferred using a transaction price). If you find this + Transaction price amounts don't affect the commodity display style + directly, but occasionally they can do so indirectly (eg when a post- + ing's amount is inferred using a transaction price). If you find this causing problems, use a commodity directive to fix the display style. - To summarise: each commodity's amounts will be normalised to (a) the - style declared by a commodity directive, or (b) the style of the first - posting amount in the journal, with the first-seen digit group style - and the maximum-seen number of decimal places. So if your reports are - showing amounts in a way you don't like, eg with too many decimal + To summarise: each commodity's amounts will be normalised to (a) the + style declared by a commodity directive, or (b) the style of the first + posting amount in the journal, with the first-seen digit group style + and the maximum-seen number of decimal places. So if your reports are + showing amounts in a way you don't like, eg with too many decimal places, use a commodity directive. Some examples: # declare euro, dollar, bitcoin and no-symbol commodities and set their @@ -5134,34 +5164,34 @@ JOURNAL FORMAT commodity 1000.00000000 BTC commodity 1 000. - The inferred commodity style can be overridden by supplying a command + The inferred commodity style can be overridden by supplying a command line option. Rounding Amounts are stored internally as decimal numbers with up to 255 decimal - places, and displayed with the number of decimal places specified by - the commodity display style. Note, hledger uses banker's rounding: it - rounds to the nearest even number, eg 0.5 displayed with zero decimal - places is "0"). (Guaranteed since hledger 1.17.1; in older versions + places, and displayed with the number of decimal places specified by + the commodity display style. Note, hledger uses banker's rounding: it + rounds to the nearest even number, eg 0.5 displayed with zero decimal + places is "0"). (Guaranteed since hledger 1.17.1; in older versions this could vary if hledger was built with Decimal < 0.5.1.) Transaction prices (AKA Costs) - After a posting amount, you can note its cost or selling price in + After a posting amount, you can note its cost or selling price in another commodity, by writing either @ UNITPRICE or @@ TOTALPRICE after - it. This indicates a conversion transaction, where one commodity is + it. This indicates a conversion transaction, where one commodity is exchanged for another. - hledger docs have historically called this a "transaction price" - because it is specific to one transaction, unlike market prices which + hledger docs have historically called this a "transaction price" + because it is specific to one transaction, unlike market prices which are not. "Cost" is shorter and might be preferable; just remember this feature can represent either a buyer's cost, or a seller's price. - Costs are usually written explicitly with @ or @@, but can also be + Costs are usually written explicitly with @ or @@, but can also be inferred automatically for simple multi-commodity transactions. - As an example, here are several ways to record purchases of a foreign - currency in hledger, using the cost notation either explicitly or + As an example, here are several ways to record purchases of a foreign + currency in hledger, using the cost notation either explicitly or implicitly: 1. Write the price per unit, as @ UNITPRICE after the amount: @@ -5183,29 +5213,29 @@ JOURNAL FORMAT assets:euros EUR100 ; one hundred euros purchased assets:dollars $-135 ; for $135 - 4. Like 1, but the @ is parenthesised, i.e. (@); this is for compati- - bility with Ledger journals (Virtual posting costs), and is equiva- + 4. Like 1, but the @ is parenthesised, i.e. (@); this is for compati- + bility with Ledger journals (Virtual posting costs), and is equiva- lent to 1 in hledger. 5. Like 2, but as in 4 the @@ is parenthesised, i.e. (@@); in hledger, this is equivalent to 2. - Amounts can be converted to cost at report time using the -B/--cost + Amounts can be converted to cost at report time using the -B/--cost flag; this is discussed more in the COST section. Lot prices, lot dates - Ledger allows another kind of price, lot price (four variants: {UNIT- + Ledger allows another kind of price, lot price (four variants: {UNIT- PRICE}, {{TOTALPRICE}}, {=FIXEDUNITPRICE}, {{=FIXEDTOTALPRICE}}), and/or a lot date ([DATE]) to be specified. These are normally used to - select a lot when selling investments. hledger will parse these, for - compatibility with Ledger journals, but currently ignores them. A - transaction price, lot price and/or lot date may appear in any order, + select a lot when selling investments. hledger will parse these, for + compatibility with Ledger journals, but currently ignores them. A + transaction price, lot price and/or lot date may appear in any order, after the posting amount and before the balance assertion if any. Balance assertions - hledger supports Ledger-style balance assertions in journal files. - These look like, for example, = EXPECTEDBALANCE following a posting's - amount. Eg here we assert the expected dollar balance in accounts a + hledger supports Ledger-style balance assertions in journal files. + These look like, for example, = EXPECTEDBALANCE following a posting's + amount. Eg here we assert the expected dollar balance in accounts a and b after each posting: 2013/1/1 @@ -5217,59 +5247,59 @@ JOURNAL FORMAT b $-1 =$-2 After reading a journal file, hledger will check all balance assertions - and report an error if any of them fail. Balance assertions can pro- - tect you from, eg, inadvertently disrupting reconciled balances while - cleaning up old entries. You can disable them temporarily with the + and report an error if any of them fail. Balance assertions can pro- + tect you from, eg, inadvertently disrupting reconciled balances while + cleaning up old entries. You can disable them temporarily with the -I/--ignore-assertions flag, which can be useful for troubleshooting or - for reading Ledger files. (Note: this flag currently does not disable + for reading Ledger files. (Note: this flag currently does not disable balance assignments, below). Assertions and ordering - hledger sorts an account's postings and assertions first by date and - then (for postings on the same day) by parse order. Note this is dif- + hledger sorts an account's postings and assertions first by date and + then (for postings on the same day) by parse order. Note this is dif- ferent from Ledger, which sorts assertions only by parse order. (Also, - Ledger assertions do not see the accumulated effect of repeated post- + Ledger assertions do not see the accumulated effect of repeated post- ings to the same account within a transaction.) So, hledger balance assertions keep working if you reorder differently- - dated transactions within the journal. But if you reorder same-dated - transactions or postings, assertions might break and require updating. + dated transactions within the journal. But if you reorder same-dated + transactions or postings, assertions might break and require updating. This order dependence does bring an advantage: precise control over the order of postings and assertions within a day, so you can assert intra- day balances. Assertions and multiple included files - Multiple files included with the include directive are processed as if - concatenated into one file, preserving their order and the posting - order within each file. It means that balance assertions in later + Multiple files included with the include directive are processed as if + concatenated into one file, preserving their order and the posting + order within each file. It means that balance assertions in later files will see balance from earlier files. - And if you have multiple postings to an account on the same day, split - across multiple files, and you want to assert the account's balance on + And if you have multiple postings to an account on the same day, split + across multiple files, and you want to assert the account's balance on that day, you'll need to put the assertion in the right file - the last one in the sequence, probably. Assertions and multiple -f files - Unlike include, when multiple files are specified on the command line - with multiple -f/--file options, balance assertions will not see bal- + Unlike include, when multiple files are specified on the command line + with multiple -f/--file options, balance assertions will not see bal- ance from earlier files. This can be useful when you do not want prob- lems in earlier files to disrupt valid assertions in later files. - If you do want assertions to see balance from earlier files, use + If you do want assertions to see balance from earlier files, use include, or concatenate the files temporarily. Assertions and commodities - The asserted balance must be a simple single-commodity amount, and in - fact the assertion checks only this commodity's balance within the - (possibly multi-commodity) account balance. This is how assertions + The asserted balance must be a simple single-commodity amount, and in + fact the assertion checks only this commodity's balance within the + (possibly multi-commodity) account balance. This is how assertions work in Ledger also. We could call this a "partial" balance assertion. To assert the balance of more than one commodity in an account, you can write multiple postings, each asserting one commodity's balance. - You can make a stronger "total" balance assertion by writing a double + You can make a stronger "total" balance assertion by writing a double equals sign (== EXPECTEDBALANCE). This asserts that there are no other - commodities in the account besides the asserted one (or at least, that + commodities in the account besides the asserted one (or at least, that their balance is 0). 2013/1/1 @@ -5288,7 +5318,7 @@ JOURNAL FORMAT a 0 == $1 It's not yet possible to make a complete assertion about a balance that - has multiple commodities. One workaround is to isolate each commodity + has multiple commodities. One workaround is to isolate each commodity into its own subaccount: 2013/1/1 @@ -5302,21 +5332,21 @@ JOURNAL FORMAT a:euro 0 == 1EUR Assertions and prices - Balance assertions ignore transaction prices, and should normally be + Balance assertions ignore transaction prices, and should normally be written without one: 2019/1/1 (a) $1 @ EUR1 = $1 - We do allow prices to be written there, however, and print shows them, - even though they don't affect whether the assertion passes or fails. - This is for backward compatibility (hledger's close command used to - generate balance assertions with prices), and because balance assign- + We do allow prices to be written there, however, and print shows them, + even though they don't affect whether the assertion passes or fails. + This is for backward compatibility (hledger's close command used to + generate balance assertions with prices), and because balance assign- ments do use them (see below). Assertions and subaccounts - The balance assertions above (= and ==) do not count the balance from - subaccounts; they check the account's exclusive balance only. You can + The balance assertions above (= and ==) do not count the balance from + subaccounts; they check the account's exclusive balance only. You can assert the balance including subaccounts by writing =* or ==*, eg: 2019/1/1 @@ -5330,10 +5360,10 @@ JOURNAL FORMAT are not affected by the --real/-R flag or real: query. Assertions and auto postings - Balance assertions are affected by the --auto flag, which generates + Balance assertions are affected by the --auto flag, which generates auto postings, which can alter account balances. Because auto postings are optional in hledger, accounts affected by them effectively have two - balances. But balance assertions can only test one or the other of + balances. But balance assertions can only test one or the other of these. So to avoid making fragile assertions, either: o assert the balance calculated with --auto, and always use --auto with @@ -5346,16 +5376,16 @@ JOURNAL FORMAT avoid auto postings entirely). Assertions and precision - Balance assertions compare the exactly calculated amounts, which are - not always what is shown by reports. Eg a commodity directive may - limit the display precision, but this will not affect balance asser- + Balance assertions compare the exactly calculated amounts, which are + not always what is shown by reports. Eg a commodity directive may + limit the display precision, but this will not affect balance asser- tions. Balance assertion failure messages show exact amounts. Balance assignments - Ledger-style balance assignments are also supported. These are like - balance assertions, but with no posting amount on the left side of the - equals sign; instead it is calculated automatically so as to satisfy - the assertion. This can be a convenience during data entry, eg when + Ledger-style balance assignments are also supported. These are like + balance assertions, but with no posting amount on the left side of the + equals sign; instead it is calculated automatically so as to satisfy + the assertion. This can be a convenience during data entry, eg when setting opening balances: ; starting a new journal, set asset account balances @@ -5373,14 +5403,14 @@ JOURNAL FORMAT expenses:misc The calculated amount depends on the account's balance in the commodity - at that point (which depends on the previously-dated postings of the - commodity to that account since the last balance assertion or assign- + at that point (which depends on the previously-dated postings of the + commodity to that account since the last balance assertion or assign- ment). Note that using balance assignments makes your journal a little less explicit; to know the exact amount posted, you have to run hledger or do the calculations yourself, instead of just reading it. Balance assignments and prices - A transaction price in a balance assignment will cause the calculated + A transaction price in a balance assignment will cause the calculated amount to have that price attached: 2019/1/1 @@ -5391,24 +5421,24 @@ JOURNAL FORMAT (a) $1 @ EUR2 = $1 @ EUR2 Directives - A directive is a line in the journal beginning with a special keyword, + A directive is a line in the journal beginning with a special keyword, that influences how the journal is processed, how things are displayed, - and so on. hledger's directives are based on (a subset of) Ledger's, - but there are many differences, and also some differences between + and so on. hledger's directives are based on (a subset of) Ledger's, + but there are many differences, and also some differences between hledger versions. Here are some more definitions: - o subdirective - Some directives support subdirectives, written + o subdirective - Some directives support subdirectives, written indented below the parent directive. - o decimal mark - The character to interpret as a decimal mark (period + o decimal mark - The character to interpret as a decimal mark (period or comma) when parsing amounts of a commodity. o display style - How to display amounts of a commodity in output: sym- bol side and spacing, digit groups, decimal mark, and number of deci- mal places. - Directives are not required when starting out with hledger, but you - will probably add some as your needs grow. Here is an overview of + Directives are not required when starting out with hledger, but you + will probably add some as your needs grow. Here is an overview of directives by purpose: @@ -5418,17 +5448,17 @@ JOURNAL FORMAT ----------------------------------------------------------------------------- READING/GENERATING DATA: Declare a commodity's or file's commodity, D, decimal- - decimal mark to help parse mark + decimal mark to help parse mark amounts accurately - Apply changes to the data while alias, apply account, --alias + Apply changes to the data while alias, apply account, --alias parsing comment, D, Y Inline extra data files include multiple -f/--file's - Generate extra transactions or ~ + Generate extra transactions or ~ budget goals Generate extra postings = CHECKING FOR ERRORS: - Define valid entities to allow account, commodity, + Define valid entities to allow account, commodity, stricter error checking payee DISPLAYING REPORTS: Declare accounts' display order account @@ -5444,73 +5474,76 @@ JOURNAL FORMAT file end? ---------------------------------------------------------------------------------- - account Declares an account, for checking all entries in all files; - and its display order and type, for reports. Subdirectives: + account Declares an account, for checking all entries in all files; + and its display order and type, for reports. Subdirectives: any text, ignored. - alias Rewrites account names, in following entries until end of Y + alias Rewrites account names, in following entries until end of Y current file or end aliases. - apply Prepends a common parent account to all account names, in Y - account following entries until end of current file or end apply + apply Prepends a common parent account to all account names, in Y + account following entries until end of current file or end apply account. - comment Ignores part of the journal file, until end of current file Y + comment Ignores part of the journal file, until end of current file Y or end comment. - commod- Declares a commodity, for checking all entries in all files; N, Y - ity the decimal mark for parsing amounts of this commodity, for - following entries until end of current file; and its display + commod- Declares a commodity, for checking all entries in all files; N, Y + ity the decimal mark for parsing amounts of this commodity, for + following entries until end of current file; and its display style, for reports. Takes precedence over D. Subdirectives: format (alternate syntax). - D Sets a default commodity to use for no-symbol amounts, and Y - its decimal mark for parsing amounts of this commodity in - following entries until end of current file; and its display + D Sets a default commodity to use for no-symbol amounts, and Y + its decimal mark for parsing amounts of this commodity in + following entries until end of current file; and its display style, for reports. - deci- Declares the decimal mark, for parsing amounts of all com- Y - mal- modities in following entries until next decimal-mark or end - mark of current file. Included files can override. Takes prece- + deci- Declares the decimal mark, for parsing amounts of all com- Y + mal- modities in following entries until next decimal-mark or end + mark of current file. Included files can override. Takes prece- dence over commodity and D. include Includes entries and directives from another file, as if they were written inline. payee Declares a payee name, for checking all entries in all files. - P Declares a market price for a commodity on some date, for + P Declares a market price for a commodity on some date, for valuation reports. - Y Declares a year for yearless dates, for following entries Y + Y Declares a year for yearless dates, for following entries Y until end of current file. - ~ Declares a periodic transaction rule that generates future - (tilde) transactions with --forecast and budget goals with balance + ~ Declares a periodic transaction rule that generates future + (tilde) transactions with --forecast and budget goals with balance --budget. - = Declares an auto posting rule that generates extra postings partly - (equals) on matched transactions with --auto, in current, parent, and + + + + = Declares an auto posting rule that generates extra postings partly + (equals) on matched transactions with --auto, in current, parent, and child files (but not sibling files, see #1212). Directives and multiple files - If you use multiple -f/--file options, or the include directive, + If you use multiple -f/--file options, or the include directive, hledger will process multiple input files. But directives which affect - input typically have effect only until the end of the file in which + input typically have effect only until the end of the file in which they occur (and on any included files in that region). This may seem inconvenient, but it's intentional; it makes reports sta- - ble and deterministic, independent of the order of input. Otherwise - you could see different numbers if you happened to write -f options in - a different order, or if you moved includes around while cleaning up + ble and deterministic, independent of the order of input. Otherwise + you could see different numbers if you happened to write -f options in + a different order, or if you moved includes around while cleaning up your files. - It can be surprising though; for example, it means that alias direc- + It can be surprising though; for example, it means that alias direc- tives do not affect parent or sibling files (see below). Comment blocks - A line containing just comment starts a commented region of the file, + A line containing just comment starts a commented region of the file, and a line containing just end comment (or the end of the current file) ends it. See also comments. Including other files - You can pull in the content of additional files by writing an include + You can pull in the content of additional files by writing an include directive, like this: include FILEPATH - Only journal files can include, and only journal, timeclock or timedot + Only journal files can include, and only journal, timeclock or timedot files can be included (not CSV files, currently). - If the file path does not begin with a slash, it is relative to the + If the file path does not begin with a slash, it is relative to the current file's folder. A tilde means home directory, eg: include ~/main.journal. @@ -5518,18 +5551,18 @@ JOURNAL FORMAT The path may contain glob patterns to match multiple files, eg: include *.journal. - There is limited support for recursive wildcards: **/ (the slash is - required) matches 0 or more subdirectories. It's not super convenient - since you have to avoid include cycles and including directories, but + There is limited support for recursive wildcards: **/ (the slash is + required) matches 0 or more subdirectories. It's not super convenient + since you have to avoid include cycles and including directories, but this can be done, eg: include */**/*.journal. The path may also be prefixed to force a specific file format, overrid- - ing the file extension (as described in hledger.1 -> Input files): + ing the file extension (as described in hledger.1 -> Input files): include timedot:~/notes/2020*.md. Default year - You can set a default year to be used for subsequent dates which don't - specify a year. This is a line beginning with Y followed by the year. + You can set a default year to be used for subsequent dates which don't + specify a year. This is a line beginning with Y followed by the year. Eg: Y2009 ; set default year to 2009 @@ -5549,9 +5582,9 @@ JOURNAL FORMAT assets Declaring payees - The payee directive can be used to declare a limited set of payees - which may appear in transaction descriptions. The "payees" check will - report an error if any transaction refers to a payee that has not been + The payee directive can be used to declare a limited set of payees + which may appear in transaction descriptions. The "payees" check will + report an error if any transaction refers to a payee that has not been declared. Eg: payee Whole Foods @@ -5567,36 +5600,36 @@ JOURNAL FORMAT decimal-mark , - This prevents any ambiguity when parsing numbers in the file, so we - recommend it, especially if the file contains digit group marks (eg + This prevents any ambiguity when parsing numbers in the file, so we + recommend it, especially if the file contains digit group marks (eg thousands separators). Declaring commodities - You can use commodity directives to declare your commodities. In fact + You can use commodity directives to declare your commodities. In fact the commodity directive performs several functions at once: - 1. It declares commodities which may be used in the journal. This can - optionally be enforced, providing useful error checking. (Cf Com- + 1. It declares commodities which may be used in the journal. This can + optionally be enforced, providing useful error checking. (Cf Com- modity error checking) - 2. It declares which decimal mark character (period or comma), to - expect when parsing input - useful to disambiguate international - number formats in your data. Without this, hledger will parse both + 2. It declares which decimal mark character (period or comma), to + expect when parsing input - useful to disambiguate international + number formats in your data. Without this, hledger will parse both 1,000 and 1.000 as 1. (Cf Amounts) - 3. It declares how to render the commodity's amounts when displaying + 3. It declares how to render the commodity's amounts when displaying output - the decimal mark, any digit group marks, the number of dec- - imal places, symbol placement and so on. (Cf Commodity display + imal places, symbol placement and so on. (Cf Commodity display style) - You will run into one of the problems solved by commodity directives + You will run into one of the problems solved by commodity directives sooner or later, so we recommend using them, for robust and predictable parsing and display. - Generally you should put them at the top of your journal file (since + Generally you should put them at the top of your journal file (since for function 2, they affect only following amounts, cf #793). - A commodity directive is just the word commodity followed by a sample + A commodity directive is just the word commodity followed by a sample amount, like this: ;commodity SAMPLEAMOUNT @@ -5604,8 +5637,8 @@ JOURNAL FORMAT commodity $1000.00 commodity 1,000.0000 AAAA ; optional same-line comment - It may also be written on multiple lines, and use the format subdirec- - tive, as in Ledger. Note in this case the commodity symbol appears + It may also be written on multiple lines, and use the format subdirec- + tive, as in Ledger. Note in this case the commodity symbol appears twice; it must be the same in both places: ;commodity SYMBOL @@ -5617,11 +5650,11 @@ JOURNAL FORMAT commodity INR format INR 1,00,00,000.00 - Remember that if the commodity symbol contains spaces, numbers, or + Remember that if the commodity symbol contains spaces, numbers, or punctuation, it must be enclosed in double quotes (cf Commodity). - The amount's quantity does not matter; only the format is significant. - It must include a decimal mark - either a period or a comma - followed + The amount's quantity does not matter; only the format is significant. + It must include a decimal mark - either a period or a comma - followed by 0 or more decimal digits. A few more examples: @@ -5632,34 +5665,34 @@ JOURNAL FORMAT commodity INR 9,99,99,999.0 commodity 1 000 000. - Note hledger normally uses banker's rounding, so 0.5 displayed with + Note hledger normally uses banker's rounding, so 0.5 displayed with zero decimal digits is "0". (More at Commodity display style.) - Even in the presence of commodity directives, the commodity display + Even in the presence of commodity directives, the commodity display style can still be overridden by supplying a command line option. Commodity error checking - In strict mode, enabled with the -s/--strict flag, hledger will report - an error if a commodity symbol is used that has not been declared by a - commodity directive. This works similarly to account error checking, + In strict mode, enabled with the -s/--strict flag, hledger will report + an error if a commodity symbol is used that has not been declared by a + commodity directive. This works similarly to account error checking, see the notes there for more details. - Note, this disallows amounts without a commodity symbol, because cur- - rently it's not possible (?) to declare the "no-symbol" commodity with - a directive. This is one exception for convenience: zero amounts are + Note, this disallows amounts without a commodity symbol, because cur- + rently it's not possible (?) to declare the "no-symbol" commodity with + a directive. This is one exception for convenience: zero amounts are always allowed to have no commodity symbol. Default commodity The D directive sets a default commodity, to be used for any subsequent - commodityless amounts (ie, plain numbers) seen while parsing the jour- - nal. This effect lasts until the next D directive, or the end of the + commodityless amounts (ie, plain numbers) seen while parsing the jour- + nal. This effect lasts until the next D directive, or the end of the journal. - For compatibility/historical reasons, D also acts like a commodity + For compatibility/historical reasons, D also acts like a commodity directive (setting the commodity's decimal mark for parsing and display style for output). - The syntax is D AMOUNT. As with commodity, the amount must include a + The syntax is D AMOUNT. As with commodity, the amount must include a decimal mark (either period or comma). Eg: ; commodity-less amounts should be treated as dollars @@ -5673,23 +5706,23 @@ JOURNAL FORMAT If both commodity and D directives are found for a commodity, commodity takes precedence for setting decimal mark and display style. - If you are using D and also checking commodities, you will need to add + If you are using D and also checking commodities, you will need to add a commodity directive similar to the D. (The hledger check commodities command expects commodity directives, and ignores D). Declaring market prices - The P directive declares a market price, which is an exchange rate + The P directive declares a market price, which is an exchange rate between two commodities on a certain date. (In Ledger, they are called - "historical prices".) These are often obtained from a stock exchange, + "historical prices".) These are often obtained from a stock exchange, cryptocurrency exchange, or the foreign exchange market. The format is: P DATE COMMODITY1SYMBOL COMMODITY2AMOUNT - DATE is a simple date, COMMODITY1SYMBOL is the symbol of the commodity - being priced, and COMMODITY2AMOUNT is the amount (symbol and quantity) - of commodity 2 that one unit of commodity 1 is worth on this date. + DATE is a simple date, COMMODITY1SYMBOL is the symbol of the commodity + being priced, and COMMODITY2AMOUNT is the amount (symbol and quantity) + of commodity 2 that one unit of commodity 1 is worth on this date. Examples: # one euro was worth $1.35 from 2009-01-01 onward: @@ -5698,34 +5731,34 @@ JOURNAL FORMAT # and $1.40 from 2010-01-01 onward: P 2010-01-01 EUR $1.40 - The -V, -X and --value flags use these market prices to show amount + The -V, -X and --value flags use these market prices to show amount values in another commodity. See Valuation. Declaring accounts account directives can be used to declare accounts (ie, the places that - amounts are transferred from and to). Though not required, these dec- + amounts are transferred from and to). Though not required, these dec- larations can provide several benefits: o They can document your intended chart of accounts, providing a refer- ence. - o In strict mode, they restrict which accounts may be posted to by + o In strict mode, they restrict which accounts may be posted to by transactions, which helps detect typos. - o They control account display order in reports, allowing non-alpha- + o They control account display order in reports, allowing non-alpha- betic sorting (eg Revenues to appear above Expenses). - o They help with account name completion (in hledger add, hledger-web, + o They help with account name completion (in hledger add, hledger-web, hledger-iadd, ledger-mode, etc.) o They can store additional account information as comments, or as tags which can be used to filter or pivot reports. - o They can help hledger know your accounts' types (asset, liability, - equity, revenue, expense), affecting reports like balancesheet and + o They can help hledger know your accounts' types (asset, liability, + equity, revenue, expense), affecting reports like balancesheet and incomestatement. - They are written as the word account followed by a hledger-style + They are written as the word account followed by a hledger-style account name, eg: account assets:bank:checking @@ -5733,7 +5766,7 @@ JOURNAL FORMAT Account comments Comments, beginning with a semicolon: - o can be written on the same line, but only after two or more spaces + o can be written on the same line, but only after two or more spaces (because ; is allowed in account names) o and/or on the next lines, indented @@ -5747,42 +5780,42 @@ JOURNAL FORMAT ; some tags - type:A, acctnum:12345 Account subdirectives - Ledger-style indented subdirectives are also accepted, but currently + Ledger-style indented subdirectives are also accepted, but currently ignored: account assets:bank:checking format subdirective is ignored Account error checking - By default, accounts need not be declared; they come into existence - when a posting references them. This is convenient, but it means - hledger can't warn you when you mis-spell an account name in the jour- + By default, accounts need not be declared; they come into existence + when a posting references them. This is convenient, but it means + hledger can't warn you when you mis-spell an account name in the jour- nal. Usually you'll find that error later, as an extra account in bal- ance reports, or an incorrect balance when reconciling. - In strict mode, enabled with the -s/--strict flag, hledger will report - an error if any transaction uses an account name that has not been + In strict mode, enabled with the -s/--strict flag, hledger will report + an error if any transaction uses an account name that has not been declared by an account directive. Some notes: - o The declaration is case-sensitive; transactions must use the correct + o The declaration is case-sensitive; transactions must use the correct account name capitalisation. - o The account directive's scope is "whole file and below" (see direc- + o The account directive's scope is "whole file and below" (see direc- tives). This means it affects all of the current file, and any files - it includes, but not parent or sibling files. The position of + it includes, but not parent or sibling files. The position of account directives within the file does not matter, though it's usual to put them at the top. - o Accounts can only be declared in journal files, but will affect + o Accounts can only be declared in journal files, but will affect included files of all types. - o It's currently not possible to declare "all possible subaccounts" + o It's currently not possible to declare "all possible subaccounts" with a wildcard; every account posted to must be declared. Account display order - The order in which account directives are written influences the order - in which accounts appear in reports, hledger-ui, hledger-web etc. By - default accounts appear in alphabetical order, but if you add these + The order in which account directives are written influences the order + in which accounts appear in reports, hledger-ui, hledger-web etc. By + default accounts appear in alphabetical order, but if you add these account directives to the journal file: account assets @@ -5807,36 +5840,36 @@ JOURNAL FORMAT account other:zoo - would influence the position of zoo among other's subaccounts, but not + would influence the position of zoo among other's subaccounts, but not the position of other among the top-level accounts. This means: - o you will sometimes declare parent accounts (eg account other above) - that you don't intend to post to, just to customize their display + o you will sometimes declare parent accounts (eg account other above) + that you don't intend to post to, just to customize their display order - o sibling accounts stay together (you couldn't display x:y in between + o sibling accounts stay together (you couldn't display x:y in between a:b and a:c). Account types hledger knows that accounts come in several types: assets, liabilities, - expenses and so on. This enables easy reports like balancesheet and + expenses and so on. This enables easy reports like balancesheet and incomestatement, and filtering by account type with the type: query. As a convenience, hledger will detect these account types automatically - if you are using common english-language top-level account names - (described below). But generally we recommend you declare types + if you are using common english-language top-level account names + (described below). But generally we recommend you declare types explicitly, by adding a type: tag to your top-level account directives. - Subaccounts will inherit the type of their parent. The tag's value + Subaccounts will inherit the type of their parent. The tag's value should be one of the five main account types: o A or Asset (things you own) o L or Liability (things you owe) - o E or Equity (investment/ownership; balanced counterpart of assets & + o E or Equity (investment/ownership; balanced counterpart of assets & liabilities) - o R or Revenue (what you received money from, AKA income; technically + o R or Revenue (what you received money from, AKA income; technically part of Equity) o X or Expense (what you spend money on; technically part of Equity) @@ -5863,10 +5896,10 @@ JOURNAL FORMAT Here are some tips for working with account types. - o The rules for inferring types from account names are as follows. + o The rules for inferring types from account names are as follows. These are just a convenience that sometimes help new users get going; if they don't work for you, just ignore them and declare your account - types. See also Regular expressions. Note the Cash regexp changed + types. See also Regular expressions. Note the Cash regexp changed in hledger 1.24.99.2. If account's name contains this (CI) regular expression: | its type is: @@ -5879,25 +5912,25 @@ JOURNAL FORMAT ^(income|revenue)s?(:|$) | Revenue ^expenses?(:|$) | Expense - o If you declare any account types, it's a good idea to declare an - account for all of the account types, because a mixture of declared + o If you declare any account types, it's a good idea to declare an + account for all of the account types, because a mixture of declared and name-inferred types can disrupt certain reports. - o Certain uses of account aliases can disrupt account types. See + o Certain uses of account aliases can disrupt account types. See Rewriting accounts > Aliases and account types. o As mentioned above, subaccounts will inherit a type from their parent - account. More precisely, an account's type is decided by the first + account. More precisely, an account's type is decided by the first of these that exists: 1. A type: declaration for this account. - 2. A type: declaration in the parent accounts above it, preferring + 2. A type: declaration in the parent accounts above it, preferring the nearest. 3. An account type inferred from this account's name. - 4. An account type inferred from a parent account's name, preferring + 4. An account type inferred from a parent account's name, preferring the nearest parent. 5. Otherwise, it will have no type. @@ -5923,7 +5956,7 @@ JOURNAL FORMAT o customising reports Account aliases also rewrite account names in account directives. They - do not affect account names being entered via hledger add or hledger- + do not affect account names being entered via hledger add or hledger- web. Account aliases are very powerful. They are generally easy to use cor- @@ -5933,9 +5966,9 @@ JOURNAL FORMAT See also Rewrite account names. Basic aliases - To set an account alias, use the alias directive in your journal file. - This affects all subsequent journal entries in the current file or its - included files (but note: not sibling or parent files). The spaces + To set an account alias, use the alias directive in your journal file. + This affects all subsequent journal entries in the current file or its + included files (but note: not sibling or parent files). The spaces around the = are optional: alias OLD = NEW @@ -5943,17 +5976,17 @@ JOURNAL FORMAT Or, you can use the --alias 'OLD=NEW' option on the command line. This affects all entries. It's useful for trying out aliases interactively. - OLD and NEW are case sensitive full account names. hledger will - replace any occurrence of the old account name with the new one. Sub- + OLD and NEW are case sensitive full account names. hledger will + replace any occurrence of the old account name with the new one. Sub- accounts are also affected. Eg: alias checking = assets:bank:wells fargo:checking ; rewrites "checking" to "assets:bank:wells fargo:checking", or "checking:a" to "assets:bank:wells fargo:checking:a" Regex aliases - There is also a more powerful variant that uses a regular expression, - indicated by wrapping the pattern in forward slashes. (This is the - only place where hledger requires forward slashes around a regular + There is also a more powerful variant that uses a regular expression, + indicated by wrapping the pattern in forward slashes. (This is the + only place where hledger requires forward slashes around a regular expression.) Eg: @@ -5964,13 +5997,13 @@ JOURNAL FORMAT $ hledger --alias '/REGEX/=REPLACEMENT' ... - Any part of an account name matched by REGEX will be replaced by + Any part of an account name matched by REGEX will be replaced by REPLACEMENT. REGEX is case-insensitive as usual. - If you need to match a forward slash, escape it with a backslash, eg + If you need to match a forward slash, escape it with a backslash, eg /\/=:. - If REGEX contains parenthesised match groups, these can be referenced + If REGEX contains parenthesised match groups, these can be referenced by the usual backslash and number in REPLACEMENT: alias /^(.+):bank:([^:]+):(.*)/ = \1:\2 \3 @@ -5980,21 +6013,21 @@ JOURNAL FORMAT option argument), so it can contain trailing whitespace. Combining aliases - You can define as many aliases as you like, using journal directives + You can define as many aliases as you like, using journal directives and/or command line options. - Recursive aliases - where an account name is rewritten by one alias, - then by another alias, and so on - are allowed. Each alias sees the + Recursive aliases - where an account name is rewritten by one alias, + then by another alias, and so on - are allowed. Each alias sees the effect of previously applied aliases. - In such cases it can be important to understand which aliases will be - applied and in which order. For (each account name in) each journal + In such cases it can be important to understand which aliases will be + applied and in which order. For (each account name in) each journal entry, we apply: - 1. alias directives preceding the journal entry, most recently parsed + 1. alias directives preceding the journal entry, most recently parsed first (ie, reading upward from the journal entry, bottom to top) - 2. --alias options, in the order they appeared on the command line + 2. --alias options, in the order they appeared on the command line (left to right). In other words, for (an account name in) a given journal entry: @@ -6005,15 +6038,15 @@ JOURNAL FORMAT o aliases defined after/below the entry do not affect it. - This gives nearby aliases precedence over distant ones, and helps pro- - vide semantic stability - aliases will keep working the same way inde- + This gives nearby aliases precedence over distant ones, and helps pro- + vide semantic stability - aliases will keep working the same way inde- pendent of which files are being read and in which order. - In case of trouble, adding --debug=6 to the command line will show + In case of trouble, adding --debug=6 to the command line will show which aliases are being applied when. Aliases and multiple files - As explained at Directives and multiple files, alias directives do not + As explained at Directives and multiple files, alias directives do not affect parent or sibling files. Eg in this command, hledger -f a.aliases -f b.journal @@ -6046,7 +6079,7 @@ JOURNAL FORMAT end aliases Aliases can generate bad account names - Be aware that account aliases can produce malformed account names, + Be aware that account aliases can produce malformed account names, which could cause confusing reports or invalid print output. For exam- ple, you could erase all account names: @@ -6058,8 +6091,8 @@ JOURNAL FORMAT 2021-01-01 1 - The above print output is not a valid journal. Or you could insert an - illegal double space, causing print output that would give a different + The above print output is not a valid journal. Or you could insert an + illegal double space, causing print output that would give a different journal when reparsed: 2021-01-01 @@ -6073,25 +6106,25 @@ JOURNAL FORMAT Aliases and account types If an account with a type declaration (see Declaring accounts > Account - types) is renamed by an alias, normally the account type remains in + types) is renamed by an alias, normally the account type remains in effect. - However, renaming in a way that reshapes the account tree (eg renaming - parent accounts but not their children, or vice versa) could prevent + However, renaming in a way that reshapes the account tree (eg renaming + parent accounts but not their children, or vice versa) could prevent child accounts from inheriting the account type of their parents. - Secondly, if an account's type is being inferred from its name, renam- + Secondly, if an account's type is being inferred from its name, renam- ing it by an alias could prevent or alter that. - If you are using account aliases and the type: query is not matching - accounts as you expect, try troubleshooting with the accounts command, + If you are using account aliases and the type: query is not matching + accounts as you expect, try troubleshooting with the accounts command, eg something like: $ hledger accounts --alias assets=bassetts type:a Default parent account - You can specify a parent account which will be prepended to all - accounts within a section of the journal. Use the apply account and + You can specify a parent account which will be prepended to all + accounts within a section of the journal. Use the apply account and end apply account directives like so: apply account home @@ -6108,7 +6141,7 @@ JOURNAL FORMAT home:food $10 home:cash $-10 - If end apply account is omitted, the effect lasts to the end of the + If end apply account is omitted, the effect lasts to the end of the file. Included files are also affected, eg: apply account business @@ -6117,49 +6150,49 @@ JOURNAL FORMAT apply account personal include personal.journal - Prior to hledger 1.0, legacy account and end spellings were also sup- + Prior to hledger 1.0, legacy account and end spellings were also sup- ported. - A default parent account also affects account directives. It does not - affect account names being entered via hledger add or hledger-web. If - account aliases are present, they are applied after the default parent + A default parent account also affects account directives. It does not + affect account names being entered via hledger add or hledger-web. If + account aliases are present, they are applied after the default parent account. Periodic transactions - Periodic transaction rules describe transactions that recur. They - allow hledger to generate temporary future transactions to help with - forecasting, so you don't have to write out each one in the journal, + Periodic transaction rules describe transactions that recur. They + allow hledger to generate temporary future transactions to help with + forecasting, so you don't have to write out each one in the journal, and it's easy to try out different forecasts. - Periodic transactions can be a little tricky, so before you use them, + Periodic transactions can be a little tricky, so before you use them, read this whole section - or at least these tips: - 1. Two spaces accidentally added or omitted will cause you trouble - + 1. Two spaces accidentally added or omitted will cause you trouble - read about this below. - 2. For troubleshooting, show the generated transactions with hledger - print --forecast tag:generated or hledger register --forecast + 2. For troubleshooting, show the generated transactions with hledger + print --forecast tag:generated or hledger register --forecast tag:generated. - 3. Forecasted transactions will begin only after the last non-fore- + 3. Forecasted transactions will begin only after the last non-fore- casted transaction's date. - 4. Forecasted transactions will end 6 months from today, by default. + 4. Forecasted transactions will end 6 months from today, by default. See below for the exact start/end rules. - 5. period expressions can be tricky. Their documentation needs + 5. period expressions can be tricky. Their documentation needs improvement, but is worth studying. - 6. Some period expressions with a repeating interval must begin on a - natural boundary of that interval. Eg in weekly from DATE, DATE - must be a monday. ~ weekly from 2019/10/1 (a tuesday) will give an + 6. Some period expressions with a repeating interval must begin on a + natural boundary of that interval. Eg in weekly from DATE, DATE + must be a monday. ~ weekly from 2019/10/1 (a tuesday) will give an error. 7. Other period expressions with an interval are automatically expanded - to cover a whole number of that interval. (This is done to improve + to cover a whole number of that interval. (This is done to improve reports, but it also affects periodic transactions. Yes, it's a bit - inconsistent with the above.) Eg: ~ every 10th day of month from - 2020/01, which is equivalent to ~ every 10th day of month from + inconsistent with the above.) Eg: ~ every 10th day of month from + 2020/01, which is equivalent to ~ every 10th day of month from 2020/01/01, will be adjusted to start on 2019/12/10. Periodic transaction rules also have a second meaning: they are used to @@ -6174,14 +6207,14 @@ JOURNAL FORMAT expenses:rent $2000 assets:bank:checking - There is an additional constraint on the period expression: the start - date must fall on a natural boundary of the interval. Eg monthly from + There is an additional constraint on the period expression: the start + date must fall on a natural boundary of the interval. Eg monthly from 2018/1/1 is valid, but monthly from 2018/1/15 is not. Periodic rules and relative dates - Partial or relative dates (like 12/31, 25, tomorrow, last week, next - quarter) are usually not recommended in periodic rules, since the - results will change as time passes. If used, they will be interpreted + Partial or relative dates (like 12/31, 25, tomorrow, last week, next + quarter) are usually not recommended in periodic rules, since the + results will change as time passes. If used, they will be interpreted relative to, in order of preference: 1. the first day of the default year specified by a recent Y directive @@ -6190,11 +6223,11 @@ JOURNAL FORMAT 3. or the date on which you are running the report. - They will not be affected at all by report period or forecast period + They will not be affected at all by report period or forecast period dates. Two spaces between period expression and description! - If the period expression is followed by a transaction description, + If the period expression is followed by a transaction description, these must be separated by two or more spaces. This helps hledger know where the period expression ends, so that descriptions can not acciden- tally alter their meaning, as in this example: @@ -6208,34 +6241,34 @@ JOURNAL FORMAT So, - o Do write two spaces between your period expression and your transac- + o Do write two spaces between your period expression and your transac- tion description, if any. - o Don't accidentally write two spaces in the middle of your period + o Don't accidentally write two spaces in the middle of your period expression. Forecasting with periodic transactions - The --forecast flag activates any periodic transaction rules in the - journal. These will generate temporary additional transactions, usu- - ally recurring and in the future, which will appear in all reports. + The --forecast flag activates any periodic transaction rules in the + journal. These will generate temporary additional transactions, usu- + ally recurring and in the future, which will appear in all reports. hledger print --forecast is a good way to see them. - This can be useful for estimating balances into the future, perhaps + This can be useful for estimating balances into the future, perhaps experimenting with different scenarios. - It could also be useful for scripted data entry: you could describe - recurring transactions, and every so often copy the output of print + It could also be useful for scripted data entry: you could describe + recurring transactions, and every so often copy the output of print --forecast into the journal. - The generated transactions will have an extra tag, like generated- - transaction:~ PERIODICEXPR, indicating which periodic rule generated - them. There is also a similar, hidden tag, named _generated-transac- + The generated transactions will have an extra tag, like generated- + transaction:~ PERIODICEXPR, indicating which periodic rule generated + them. There is also a similar, hidden tag, named _generated-transac- tion:, which you can use to reliably match transactions generated "just now" (rather than printed in the past). The forecast transactions are generated within a forecast period, which - is independent of the report period. (Forecast period sets the bounds - for generated transactions, report period controls which transactions + is independent of the report period. (Forecast period sets the bounds + for generated transactions, report period controls which transactions are reported.) The forecast period begins on: o the start date provided within --forecast's argument, if any @@ -6244,7 +6277,7 @@ JOURNAL FORMAT o the report start date, if specified (with -b/-p/date:) - o the day after the latest ordinary transaction in the journal, if + o the day after the latest ordinary transaction in the journal, if any o otherwise today. @@ -6257,17 +6290,17 @@ JOURNAL FORMAT o otherwise 180 days (6 months) from today. - Note, this means that ordinary transactions will suppress periodic - transactions, by default; the periodic transactions will not start + Note, this means that ordinary transactions will suppress periodic + transactions, by default; the periodic transactions will not start until after the last ordinary transaction. This is usually convenient, but you can get around it in two ways: - o If you need to record some transactions in the future, make them - periodic transactions (with a single occurrence, eg: ~ YYYY-MM-DD) - rather than ordinary transactions. That way they won't suppress + o If you need to record some transactions in the future, make them + periodic transactions (with a single occurrence, eg: ~ YYYY-MM-DD) + rather than ordinary transactions. That way they won't suppress other periodic transactions. - o Or give --forecast a period expression argument. A forecast period + o Or give --forecast a period expression argument. A forecast period specified this way can overlap ordinary transactions, and need not be in the future. Some things to note: @@ -6276,25 +6309,25 @@ JOURNAL FORMAT o The period expression can specify the forecast period's start date, end date, or both. See also Report start & end date. - o The period expression should not specify a report interval. (Each + o The period expression should not specify a report interval. (Each periodic transaction rule specifies its own interval.) - Some examples: --forecast=202001-202004, --forecast=jan-, --fore- + Some examples: --forecast=202001-202004, --forecast=jan-, --fore- cast=2021. Budgeting with periodic transactions - With the --budget flag, currently supported by the balance command, - each periodic transaction rule declares recurring budget goals for the - specified accounts. Eg the first example above declares a goal of - spending $2000 on rent (and also, a goal of depositing $2000 into - checking) every month. Goals and actual performance can then be com- + With the --budget flag, currently supported by the balance command, + each periodic transaction rule declares recurring budget goals for the + specified accounts. Eg the first example above declares a goal of + spending $2000 on rent (and also, a goal of depositing $2000 into + checking) every month. Goals and actual performance can then be com- pared in budget reports. See also: Budgeting and Forecasting. Auto postings - "Automated postings" or "auto postings" are extra postings which get + "Automated postings" or "auto postings" are extra postings which get added automatically to transactions which match certain queries, defined by "auto posting rules", when you use the --auto flag. @@ -6305,27 +6338,27 @@ JOURNAL FORMAT ... ACCOUNT [AMOUNT] - except the first line is an equals sign (mnemonic: = suggests match- - ing), followed by a query (which matches existing postings), and each - "posting" line describes a posting to be generated, and the posting + except the first line is an equals sign (mnemonic: = suggests match- + ing), followed by a query (which matches existing postings), and each + "posting" line describes a posting to be generated, and the posting amounts can be: - o a normal amount with a commodity symbol, eg $2. This will be used + o a normal amount with a commodity symbol, eg $2. This will be used as-is. o a number, eg 2. The commodity symbol (if any) from the matched post- ing will be added to this. - o a numeric multiplier, eg *2 (a star followed by a number N). The + o a numeric multiplier, eg *2 (a star followed by a number N). The matched posting's amount (and total price, if any) will be multiplied by N. - o a multiplier with a commodity symbol, eg *$2 (a star, number N, and + o a multiplier with a commodity symbol, eg *$2 (a star, number N, and symbol S). The matched posting's amount will be multiplied by N, and its commodity symbol will be replaced with S. - Any query term containing spaces must be enclosed in single or double - quotes, as on the command line. Eg, note the quotes around the second + Any query term containing spaces must be enclosed in single or double + quotes, as on the command line. Eg, note the quotes around the second query term below: = expenses:groceries 'expenses:dining out' @@ -6364,29 +6397,29 @@ JOURNAL FORMAT Auto postings and multiple files An auto posting rule can affect any transaction in the current file, or - in any parent file or child file. Note, currently it will not affect + in any parent file or child file. Note, currently it will not affect sibling files (when multiple -f/--file are used - see #1212). Auto postings and dates - A posting date (or secondary date) in the matched posting, or (taking - precedence) a posting date in the auto posting rule itself, will also + A posting date (or secondary date) in the matched posting, or (taking + precedence) a posting date in the auto posting rule itself, will also be used in the generated posting. Auto postings and transaction balancing / inferred amounts / balance asser- tions Currently, auto postings are added: - o after missing amounts are inferred, and transactions are checked for + o after missing amounts are inferred, and transactions are checked for balancedness, o but before balance assertions are checked. - Note this means that journal entries must be balanced both before and + Note this means that journal entries must be balanced both before and after auto postings are added. This changed in hledger 1.12+; see #893 for background. - This also means that you cannot have more than one auto-posting with a - missing amount applied to a given transaction, as it will be unable to + This also means that you cannot have more than one auto-posting with a + missing amount applied to a given transaction, as it will be unable to infer amounts. Auto posting tags @@ -6395,11 +6428,11 @@ JOURNAL FORMAT o generated-posting:= QUERY - shows this was generated by an auto post- ing rule, and the query - o _generated-posting:= QUERY - a hidden tag, which does not appear in + o _generated-posting:= QUERY - a hidden tag, which does not appear in hledger's output. This can be used to match postings generated "just now", rather than generated in the past and saved to the journal. - Also, any transaction that has been changed by auto posting rules will + Also, any transaction that has been changed by auto posting rules will have these tags added: o modified: - this transaction was modified @@ -6410,63 +6443,66 @@ JOURNAL FORMAT CSV FORMAT How hledger reads CSV data, and the CSV rules file format. - hledger can read CSV files (Character Separated Value - usually comma, - semicolon, or tab) containing dated records as if they were journal + hledger can read CSV files (Character Separated Value - usually comma, + semicolon, or tab) containing dated records as if they were journal files, automatically converting each CSV record into a transaction. (To learn about writing CSV, see CSV output.) We describe each CSV file's format with a corresponding rules file. By - default this is named like the CSV file with a .rules extension added. - Eg when reading FILE.csv, hledger also looks for FILE.csv.rules in the - same directory as FILE.csv. You can specify a different rules file - with the --rules-file option. If a rules file is not found, hledger + default this is named like the CSV file with a .rules extension added. + Eg when reading FILE.csv, hledger also looks for FILE.csv.rules in the + same directory as FILE.csv. You can specify a different rules file + with the --rules-file option. If a rules file is not found, hledger will create a sample rules file, which you'll need to adjust. - This file contains rules describing the CSV data (header line, fields + This file contains rules describing the CSV data (header line, fields layout, date format etc.), and how to construct hledger journal entries (transactions) from it. Often there will also be a list of conditional rules for categorising transactions based on their descriptions. - Here's an overview of the CSV rules; these are described more fully + Here's an overview of the CSV rules; these are described more fully below, after the examples: skip skip one or more header lines or matched CSV records - fields list name CSV fields, assign them to hledger + fields list name CSV fields, assign them to hledger fields - field assignment assign a value to one hledger field, with + field assignment assign a value to one hledger field, with interpolation Field names hledger field names, used in the fields list and field assignments separator a custom field separator - if block apply some rules to CSV records matched by + if block apply some rules to CSV records matched by patterns - if table apply some rules to CSV records matched by + if table apply some rules to CSV records matched by patterns, alternate syntax end skip the remaining CSV records date-format how to parse dates in CSV records - decimal-mark the decimal mark used in CSV amounts, if + decimal-mark the decimal mark used in CSV amounts, if ambiguous - newest-first disambiguate record order when there's only - one date + newest-first improve txn order when there are multiple + records, newest first, all with the same + date + intra-day-reversed improve txn order when each day's txns are + reverse of the overall date order include inline another CSV rules file - balance-type choose which type of balance assignments to + balance-type choose which type of balance assignments to use - Note, for best error messages when reading CSV files, use a .csv, .tsv + Note, for best error messages when reading CSV files, use a .csv, .tsv or .ssv file extension or file prefix - see File Extension below. There's an introductory Importing CSV data tutorial on hledger.org. Examples - Here are some sample hledger CSV rules files. See also the full col- + Here are some sample hledger CSV rules files. See also the full col- lection at: https://github.com/simonmichael/hledger/tree/master/examples/csv Basic - At minimum, the rules file must identify the date and amount fields, - and often it also specifies the date format and how many header lines + At minimum, the rules file must identify the date and amount fields, + and often it also specifies the date format and how many header lines there are. Here's a simple CSV file and a rules file for it: Date, Description, Id, Amount @@ -6485,8 +6521,8 @@ CSV FORMAT Default account names are chosen, since we didn't set them. Bank of Ireland - Here's a CSV with two amount fields (Debit and Credit), and a balance - field, which we can use to add balance assertions, which is not neces- + Here's a CSV with two amount fields (Debit and Credit), and a balance + field, which we can use to add balance assertions, which is not neces- sary but provides extra error checking: Date,Details,Debit,Credit,Balance @@ -6528,13 +6564,13 @@ CSV FORMAT assets:bank:boi:checking EUR-5.0 = EUR126.0 expenses:unknown EUR5.0 - The balance assertions don't raise an error above, because we're read- - ing directly from CSV, but they will be checked if these entries are + The balance assertions don't raise an error above, because we're read- + ing directly from CSV, but they will be checked if these entries are imported into a journal file. Amazon Here we convert amazon.com order history, and use an if block to gener- - ate a third posting if there's a fee. (In practice you'd probably get + ate a third posting if there's a fee. (In practice you'd probably get this data from your bank instead, but it's an example.) "Date","Type","To/From","Name","Status","Amount","Fees","Transaction ID" @@ -6586,7 +6622,7 @@ CSV FORMAT expenses:fees $1.00 Paypal - Here's a real-world rules file for (customised) Paypal CSV, with some + Here's a real-world rules file for (customised) Paypal CSV, with some Paypal-specific rules, and a second rules file included: "Date","Time","TimeZone","Name","Type","Status","Currency","Gross","Fee","Net","From Email Address","To Email Address","Transaction ID","Item Title","Item ID","Reference Txn ID","Receipt ID","Balance","Note" @@ -6741,9 +6777,9 @@ CSV FORMAT skip skip N - The word "skip" followed by a number (or no number, meaning 1) tells - hledger to ignore this many non-empty lines preceding the CSV data. - (Empty/blank lines are skipped automatically.) You'll need this when- + The word "skip" followed by a number (or no number, meaning 1) tells + hledger to ignore this many non-empty lines preceding the CSV data. + (Empty/blank lines are skipped automatically.) You'll need this when- ever your CSV data contains header lines. It also has a second purpose: it can be used inside if blocks to ignore @@ -6752,19 +6788,19 @@ CSV FORMAT fields list fields FIELDNAME1, FIELDNAME2, ... - A fields list (the word "fields" followed by comma-separated field - names) is the quick way to assign CSV field values to hledger fields. - (The other way is field assignments, see below.) A fields list does + A fields list (the word "fields" followed by comma-separated field + names) is the quick way to assign CSV field values to hledger fields. + (The other way is field assignments, see below.) A fields list does does two things: - 1. It names the CSV fields. This is optional, but can be convenient + 1. It names the CSV fields. This is optional, but can be convenient later for interpolating them. - 2. Whenever you use a standard hledger field name (defined below), the + 2. Whenever you use a standard hledger field name (defined below), the CSV value is assigned to that part of the hledger transaction. - Here's an example that says "use the 1st, 2nd and 4th fields as the - transaction's date, description and amount; name the last two fields + Here's an example that says "use the 1st, 2nd and 4th fields as the + transaction's date, description and amount; name the last two fields for later reference; and ignore the others": fields date, description, , amount, , , somefield, anotherfield @@ -6774,20 +6810,20 @@ CSV FORMAT o The fields list always use commas, even if your CSV data uses another separator character. - o Currently there must be least two items in the list (at least one + o Currently there must be least two items in the list (at least one comma). - o Field names may not contain spaces. Spaces before/after field names + o Field names may not contain spaces. Spaces before/after field names are optional. o Field names may contain _ (underscore) or - (hyphen). - o If the CSV contains column headings, it's a good idea to use these, + o If the CSV contains column headings, it's a good idea to use these, suitably modified, as the basis for your field names (eg lower-cased, with underscores instead of spaces). - o If some heading names match standard hledger fields, but you don't - want to set the hledger fields directly, alter those names, eg by + o If some heading names match standard hledger fields, but you don't + want to set the hledger fields directly, alter those names, eg by appending an underscore. o Fields you don't care about can be given a dummy name (eg: _ ), or no @@ -6796,15 +6832,15 @@ CSV FORMAT field assignment HLEDGERFIELDNAME FIELDVALUE - Field assignments are the more flexible way to assign CSV values to + Field assignments are the more flexible way to assign CSV values to hledger fields. They can be used instead of or in addition to a fields list (see above). - To assign a value to a hledger field, write the field name (any of the - standard hledger field/pseudo-field names, defined below), a space, - followed by a text value on the same line. This text value may inter- - polate CSV fields, referenced by their 1-based position in the CSV - record (%N), or by the name they were given in the fields list (%CSV- + To assign a value to a hledger field, write the field name (any of the + standard hledger field/pseudo-field names, defined below), a space, + followed by a text value on the same line. This text value may inter- + polate CSV fields, referenced by their 1-based position in the CSV + record (%N), or by the name they were given in the fields list (%CSV- FIELDNAME). Some examples: @@ -6817,15 +6853,15 @@ CSV FORMAT Tips: - o Interpolation strips outer whitespace (so a CSV value like " 1 " + o Interpolation strips outer whitespace (so a CSV value like " 1 " becomes 1 when interpolated) (#1051). - o Interpolations always refer to a CSV field - you can't interpolate a + o Interpolations always refer to a CSV field - you can't interpolate a hledger field. (See Referencing other fields below). Field names Here are the standard hledger field (and pseudo-field) names, which you - can use in a fields list and in field assignments. For more about the + can use in a fields list and in field assignments. For more about the transaction parts they refer to, see Transactions. date field @@ -6859,63 +6895,63 @@ CSV FORMAT Assigning to accountN, where N is 1 to 99, sets the account name of the Nth posting, and causes that posting to be generated. - Most often there are two postings, so you'll want to set account1 and - account2. Typically account1 is associated with the CSV file, and is - set once with a top-level assignment, while account2 is set based on + Most often there are two postings, so you'll want to set account1 and + account2. Typically account1 is associated with the CSV file, and is + set once with a top-level assignment, while account2 is set based on each transaction's description, and in conditional blocks. - If a posting's account name is left unset but its amount is set (see - below), a default account name will be chosen (like "expenses:unknown" + If a posting's account name is left unset but its amount is set (see + below), a default account name will be chosen (like "expenses:unknown" or "income:unknown"). amount field - amountN sets the amount of the Nth posting, and causes that posting to - be generated. By assigning to amount1, amount2, ... etc. you can + amountN sets the amount of the Nth posting, and causes that posting to + be generated. By assigning to amount1, amount2, ... etc. you can generate up to 99 postings. - amountN-in and amountN-out can be used instead, if the CSV uses sepa- - rate fields for debits and credits (inflows and outflows). hledger - assumes both of these CSV fields are unsigned, and will automatically - negate the "-out" value. If they are signed, see "Setting amounts" + amountN-in and amountN-out can be used instead, if the CSV uses sepa- + rate fields for debits and credits (inflows and outflows). hledger + assumes both of these CSV fields are unsigned, and will automatically + negate the "-out" value. If they are signed, see "Setting amounts" below. - amount, or amount-in and amount-out are a legacy mode, to keep pre- - hledger-1.17 CSV rules files working (and for occasional convenience). - They are suitable only for two-posting transactions; they set both - posting 1's and posting 2's amount. Posting 2's amount will be + amount, or amount-in and amount-out are a legacy mode, to keep pre- + hledger-1.17 CSV rules files working (and for occasional convenience). + They are suitable only for two-posting transactions; they set both + posting 1's and posting 2's amount. Posting 2's amount will be negated, and also converted to cost if there's a transaction price. If you have an existing rules file using the unnumbered form, you might - want to use the numbered form in certain conditional blocks, without - having to update and retest all the old rules. To facilitate this, - posting 1 ignores amount/amount-in/amount-out if any of + want to use the numbered form in certain conditional blocks, without + having to update and retest all the old rules. To facilitate this, + posting 1 ignores amount/amount-in/amount-out if any of amount1/amount1-in/amount1-out are assigned, and posting 2 ignores them - if any of amount2/amount2-in/amount2-out are assigned, avoiding con- + if any of amount2/amount2-in/amount2-out are assigned, avoiding con- flicts. currency field - currency sets a currency symbol, to be prepended to all postings' - amounts. You can use this if the CSV amounts do not have a currency + currency sets a currency symbol, to be prepended to all postings' + amounts. You can use this if the CSV amounts do not have a currency symbol, eg if it is in a separate column. - currencyN prepends a currency symbol to just the Nth posting's amount. + currencyN prepends a currency symbol to just the Nth posting's amount. balance field - balanceN sets a balance assertion amount (or if the posting amount is + balanceN sets a balance assertion amount (or if the posting amount is left empty, a balance assignment) on posting N. balance is a compatibility spelling for hledger <1.17; it is equivalent to balance1. - You can adjust the type of assertion/assignment with the balance-type + You can adjust the type of assertion/assignment with the balance-type rule (see below). See Tips below for more about setting amounts and currency. separator - You can use the separator rule to read other kinds of character-sepa- - rated data. The argument is any single separator character, or the - words tab or space (case insensitive). Eg, for comma-separated values + You can use the separator rule to read other kinds of character-sepa- + rated data. The argument is any single separator character, or the + words tab or space (case insensitive). Eg, for comma-separated values (CSV): separator , @@ -6928,7 +6964,7 @@ CSV FORMAT separator TAB - If the input file has a .csv, .ssv or .tsv file extension (or a csv:, + If the input file has a .csv, .ssv or .tsv file extension (or a csv:, ssv:, tsv: prefix), the appropriate separator will be inferred automat- ically, and you won't need this rule. @@ -6943,8 +6979,8 @@ CSV FORMAT RULE RULE - Conditional blocks ("if blocks") are a block of rules that are applied - only to CSV records which match certain patterns. They are often used + Conditional blocks ("if blocks") are a block of rules that are applied + only to CSV records which match certain patterns. They are often used for customising account names based on transaction descriptions. Matching the whole record @@ -6953,16 +6989,16 @@ CSV FORMAT REGEX REGEX is a case-insensitive regular expression that tries to match any- - where within the CSV record. It is a POSIX ERE (extended regular - expression) that also supports GNU word boundaries (\b, \B, \<, \>), - and nothing else. If you have trouble, be sure to check our doc: + where within the CSV record. It is a POSIX ERE (extended regular + expression) that also supports GNU word boundaries (\b, \B, \<, \>), + and nothing else. If you have trouble, be sure to check our doc: https://hledger.org/hledger.html#regular-expressions - Important note: the record that is matched is not the original record, - but a synthetic one, with any enclosing double quotes (but not enclos- + Important note: the record that is matched is not the original record, + but a synthetic one, with any enclosing double quotes (but not enclos- ing whitespace) removed, and always comma-separated (which means that a - field containing a comma will appear like two fields). Eg, if the - original record is 2020-01-01; "Acme, Inc."; 1,000, the REGEX will + field containing a comma will appear like two fields). Eg, if the + original record is 2020-01-01; "Acme, Inc."; 1,000, the REGEX will actually see 2020-01-01,Acme, Inc., 1,000). Matching individual fields @@ -6970,14 +7006,14 @@ CSV FORMAT %CSVFIELD REGEX - which matches just the content of a particular CSV field. CSVFIELD is - a percent sign followed by the field's name or column number, like + which matches just the content of a particular CSV field. CSVFIELD is + a percent sign followed by the field's name or column number, like %date or %1. Combining matchers A single matcher can be written on the same line as the "if"; or multi- ple matchers can be written on the following lines, non-indented. Mul- - tiple matchers are OR'd (any one of them can match), unless one begins + tiple matchers are OR'd (any one of them can match), unless one begins with an & symbol, in which case it is AND'ed with the previous matcher. if @@ -6986,8 +7022,8 @@ CSV FORMAT RULE Rules applied on successful match - After the patterns there should be one or more rules to apply, all - indented by at least one space. Three kinds of rule are allowed in + After the patterns there should be one or more rules to apply, all + indented by at least one space. Three kinds of rule are allowed in conditional blocks: o field assignments (to set a hledger field) @@ -7017,11 +7053,11 @@ CSV FORMAT MATCHER3,VALUE31,VALUE32,...,VALUE3n - Conditional tables ("if tables") are a different syntax to specify - field assignments that will be applied only to CSV records which match + Conditional tables ("if tables") are a different syntax to specify + field assignments that will be applied only to CSV records which match certain patterns. - MATCHER could be either field or record matcher, as described above. + MATCHER could be either field or record matcher, as described above. When MATCHER matches, values from that row would be assigned to the CSV fields named on the if line, in the same order. @@ -7045,17 +7081,17 @@ CSV FORMAT ... CSVFIELDNAMEn VALUE3n - Each line starting with MATCHER should contain enough (possibly empty) + Each line starting with MATCHER should contain enough (possibly empty) values for all the listed fields. - Rules would be checked and applied in the order they are listed in the + Rules would be checked and applied in the order they are listed in the table and, like with if blocks, later rules (in the same or another ta- ble) or if blocks could override the effect of any rule. - Instead of ',' you can use a variety of other non-alphanumeric charac- + Instead of ',' you can use a variety of other non-alphanumeric charac- ters as a separator. First character after if is taken to be the sepa- - rator for the rest of the table. It is the responsibility of the user - to ensure that separator does not occur inside MATCHERs and values - + rator for the rest of the table. It is the responsibility of the user + to ensure that separator does not occur inside MATCHERs and values - there is no way to escape separator. Example: @@ -7066,7 +7102,7 @@ CSV FORMAT 2020/01/12.*Plumbing LLC,expenses:house:upkeep,emergency plumbing call-out end - This rule can be used inside if blocks (only), to make hledger stop + This rule can be used inside if blocks (only), to make hledger stop reading this CSV file and move on to the next input file, or to command execution. Eg: @@ -7077,11 +7113,11 @@ CSV FORMAT date-format date-format DATEFMT - This is a helper for the date (and date2) fields. If your CSV dates - are not formatted like YYYY-MM-DD, YYYY/MM/DD or YYYY.MM.DD, you'll - need to add a date-format rule describing them with a strptime-style - date parsing pattern - see https://hackage.haskell.org/pack- - age/time/docs/Data-Time-Format.html#v:formatTime. The pattern must + This is a helper for the date (and date2) fields. If your CSV dates + are not formatted like YYYY-MM-DD, YYYY/MM/DD or YYYY.MM.DD, you'll + need to add a date-format rule describing them with a strptime-style + date parsing pattern - see https://hackage.haskell.org/pack- + age/time/docs/Data-Time-Format.html#v:formatTime. The pattern must parse the CSV date value completely. Some examples: # MM/DD/YY @@ -7101,25 +7137,25 @@ CSV FORMAT timezone timezone TIMEZONE - When CSV contains date-times that are implicitly in some time zone + When CSV contains date-times that are implicitly in some time zone other than yours, but containing no explicit time zone information, you - can use this rule to declare the CSV's native time zone, which helps + can use this rule to declare the CSV's native time zone, which helps prevent off-by-one dates. - When the CSV date-times do contain time zone information, you don't - need this rule; instead, use %Z in date-format (or %z, %EZ, %Ez; see + When the CSV date-times do contain time zone information, you don't + need this rule; instead, use %Z in date-format (or %z, %EZ, %Ez; see the formatTime link above). In either of these cases, hledger will do a time-zone-aware conversion, localising the CSV date-times to your current system time zone. If you prefer to localise to some other time zone, eg for reproducibility, you - can (on unix at least) set the output timezone with the TZ environment + can (on unix at least) set the output timezone with the TZ environment variable, eg: - $ TZ=HST hledger print -f foo.csv # or TZ=HST hledger import foo.csv + $ TZ=-1000 hledger print -f foo.csv # or TZ=-1000 hledger import foo.csv - timezone currently does not understand timezone names, except "UTC", - "GMT", "EST", "EDT", "CST", "CDT", "MST", "MDT", "PST", or "PDT". For + timezone currently does not understand timezone names, except "UTC", + "GMT", "EST", "EDT", "CST", "CDT", "MST", "MDT", "PST", or "PDT". For others, use numeric format: +HHMM or -HHMM. decimal-mark @@ -7129,37 +7165,52 @@ CSV FORMAT decimal-mark , - hledger automatically accepts either period or comma as a decimal mark - when parsing numbers (cf Amounts). However if any numbers in the CSV - contain digit group marks, such as thousand-separating commas, you - should declare the decimal mark explicitly with this rule, to avoid + hledger automatically accepts either period or comma as a decimal mark + when parsing numbers (cf Amounts). However if any numbers in the CSV + contain digit group marks, such as thousand-separating commas, you + should declare the decimal mark explicitly with this rule, to avoid misparsed numbers. newest-first - hledger always sorts the generated transactions by date. Transactions - on the same date should appear in the same order as their CSV records, - as hledger can usually auto-detect whether the CSV's normal order is - oldest first or newest first. But if all of the following are true: + hledger tries to ensure that the generated transactions will be ordered + chronologically, including intra-day transactions. Usually it can + auto-detect how the CSV records are ordered. But if it encounters CSV + where all records are on the same date, it assumes that the records are + oldest first. If in fact the CSV's records are normally newest first, + like: - o the CSV might sometimes contain just one day of data (all records - having the same date) + 2022-10-01, txn 3... + 2022-10-01, txn 2... + 2022-10-01, txn 1... - o the CSV records are normally in reverse chronological order (newest - at the top) + you can add the newest-first rule to help hledger generate the transac- + tions in correct order. - o and you care about preserving the order of same-day transactions - - then, you should add the newest-first rule as a hint. Eg: - - # tell hledger explicitly that the CSV is normally newest first + # same-day CSV records are newest first newest-first + intra-day-reversed + CSV records for each day are sometimes ordered in reverse compared to + the overall date order. Eg, here dates are newest first, but the + transactions on each date are oldest first: + + 2022-10-02, txn 3... + 2022-10-02, txn 4... + 2022-10-01, txn 1... + 2022-10-01, txn 2... + + In this situation, add the intra-day-reversed rule, and hledger will + compensate, improving the order of transactions. + + # transactions within each day are reversed with respect to the overall date order + intra-day-reversed + include include RULESFILE - This includes the contents of another CSV rules file at this point. - RULESFILE is an absolute file path or a path relative to the current - file's directory. This can be useful for sharing common rules between + This includes the contents of another CSV rules file at this point. + RULESFILE is an absolute file path or a path relative to the current + file's directory. This can be useful for sharing common rules between several rules files, eg: # someaccount.csv.rules @@ -7174,10 +7225,10 @@ CSV FORMAT balance-type Balance assertions generated by assigning to balanceN are of the simple - = type by default, which is a single-commodity, subaccount-excluding + = type by default, which is a single-commodity, subaccount-excluding assertion. You may find the subaccount-including variants more useful, - eg if you have created some virtual subaccounts of checking to help - with budgeting. You can select a different type of assertion with the + eg if you have created some virtual subaccounts of checking to help + with budgeting. You can select a different type of assertion with the balance-type rule: # balance assertions will consider all commodities and all subaccounts @@ -7192,18 +7243,18 @@ CSV FORMAT Tips Rapid feedback - It's a good idea to get rapid feedback while creating/troubleshooting + It's a good idea to get rapid feedback while creating/troubleshooting CSV rules. Here's a good way, using entr from eradman.com/entrproject: $ ls foo.csv* | entr bash -c 'echo ----; hledger -f foo.csv print desc:SOMEDESC' - A desc: query (eg) is used to select just one, or a few, transactions - of interest. "bash -c" is used to run multiple commands, so we can - echo a separator each time the command re-runs, making it easier to + A desc: query (eg) is used to select just one, or a few, transactions + of interest. "bash -c" is used to run multiple commands, so we can + echo a separator each time the command re-runs, making it easier to read the output. Valid CSV - hledger accepts CSV conforming to RFC 4180. When CSV values are + hledger accepts CSV conforming to RFC 4180. When CSV values are enclosed in quotes, note: o they must be double quotes (not single quotes) @@ -7211,9 +7262,9 @@ CSV FORMAT o spaces outside the quotes are not allowed File Extension - To help hledger identify the format and show the right error messages, - CSV/SSV/TSV files should normally be named with a .csv, .ssv or .tsv - filename extension. Or, the file path should be prefixed with csv:, + To help hledger identify the format and show the right error messages, + CSV/SSV/TSV files should normally be named with a .csv, .ssv or .tsv + filename extension. Or, the file path should be prefixed with csv:, ssv: or tsv:. Eg: $ hledger -f foo.ssv print @@ -7222,48 +7273,48 @@ CSV FORMAT $ cat foo | hledger -f ssv:- foo - You can override the file extension with a separator rule if needed. + You can override the file extension with a separator rule if needed. See also: Input files in the hledger manual. Reading multiple CSV files - If you use multiple -f options to read multiple CSV files at once, - hledger will look for a correspondingly-named rules file for each CSV - file. But if you use the --rules-file option, that rules file will be + If you use multiple -f options to read multiple CSV files at once, + hledger will look for a correspondingly-named rules file for each CSV + file. But if you use the --rules-file option, that rules file will be used for all the CSV files. Valid transactions After reading a CSV file, hledger post-processes and validates the gen- erated journal entries as it would for a journal file - balancing them, - applying balance assignments, and canonicalising amount styles. Any - errors at this stage will be reported in the usual way, displaying the + applying balance assignments, and canonicalising amount styles. Any + errors at this stage will be reported in the usual way, displaying the problem entry. There is one exception: balance assertions, if you have generated them, - will not be checked, since normally these will work only when the CSV - data is part of the main journal. If you do need to check balance + will not be checked, since normally these will work only when the CSV + data is part of the main journal. If you do need to check balance assertions generated from CSV right away, pipe into another hledger: $ hledger -f file.csv print | hledger -f- print Deduplicating, importing - When you download a CSV file periodically, eg to get your latest bank - transactions, the new file may overlap with the old one, containing + When you download a CSV file periodically, eg to get your latest bank + transactions, the new file may overlap with the old one, containing some of the same records. The import command will (a) detect the new transactions, and (b) append just those transactions to your main journal. It is idempotent, so you - don't have to remember how many times you ran it or with which version - of the CSV. (It keeps state in a hidden .latest.FILE.csv file.) This + don't have to remember how many times you ran it or with which version + of the CSV. (It keeps state in a hidden .latest.FILE.csv file.) This is the easiest way to import CSV data. Eg: # download the latest CSV files, then run this command. # Note, no -f flags needed here. $ hledger import *.csv [--dry] - This method works for most CSV files. (Where records have a stable + This method works for most CSV files. (Where records have a stable chronological order, and new records appear only at the new end.) - A number of other tools and workflows, hledger-specific and otherwise, + A number of other tools and workflows, hledger-specific and otherwise, exist for converting, deduplicating, classifying and managing CSV data. See: @@ -7284,13 +7335,13 @@ CSV FORMAT a. If both fields are unsigned: Assign to amountN-in and amountN-out. This sets posting N's amount - to whichever of these has a non-zero value, and negates the "-out" + to whichever of these has a non-zero value, and negates the "-out" value. b. If either field is signed (can contain a minus sign): - Use a conditional rule to flip the sign (of non-empty values). - Since hledger always negates amountN-out, if it was already nega- - tive, we must undo that by negating once more (but only if the + Use a conditional rule to flip the sign (of non-empty values). + Since hledger always negates amountN-out, if it was already nega- + tive, we must undo that by negating once more (but only if the field is non-empty): fields date, description, amount1-in, amount1-out @@ -7298,8 +7349,8 @@ CSV FORMAT amount1-out -%amount1-out c. If both fields, or neither field, can contain a non-zero value: - hledger normally expects exactly one of the fields to have a non- - zero value. Eg, the amountN-in/amountN-out rules would reject + hledger normally expects exactly one of the fields to have a non- + zero value. Eg, the amountN-in/amountN-out rules would reject value pairs like these: "", "" @@ -7307,7 +7358,7 @@ CSV FORMAT "1", "none" So, use smarter conditional rules to set the amount from the appro- - priate field. Eg, these rules would make it use only the value + priate field. Eg, these rules would make it use only the value containing non-zero digits, handling the above: fields date, description, in, out @@ -7318,7 +7369,7 @@ CSV FORMAT 3. If you want posting 2's amount converted to cost: Assign to amount (or to amount-in and amount-out). (This is the legacy - numberless syntax, which sets amount1 and amount2 and converts amount2 + numberless syntax, which sets amount1 and amount2 and converts amount2 to cost.) 4. If the CSV has the balance instead of the transaction amount: @@ -7326,15 +7377,15 @@ CSV FORMAT ance assignment. (Old syntax: balance, equivalent to balance1.) o If hledger guesses the wrong default account name: - When setting the amount via balance assertion, hledger may guess - the wrong default account name. So, set the account name explic- + When setting the amount via balance assertion, hledger may guess + the wrong default account name. So, set the account name explic- itly, eg: fields date, description, balance1 account1 assets:checking Amount signs - There is some special handling for amount signs, to simplify parsing + There is some special handling for amount signs, to simplify parsing and sign-flipping: o If an amount value begins with a plus sign: @@ -7343,17 +7394,17 @@ CSV FORMAT o If an amount value is parenthesised: it will be de-parenthesised and sign-flipped: (AMT) becomes -AMT - o If an amount value has two minus signs (or two sets of parentheses, + o If an amount value has two minus signs (or two sets of parentheses, or a minus sign and parentheses): they cancel out and will be removed: --AMT or -(AMT) becomes AMT - o If an amount value contains just a sign (or just a set of parenthe- + o If an amount value contains just a sign (or just a set of parenthe- ses): - that is removed, making it an empty value. "+" or "-" or "()" becomes + that is removed, making it an empty value. "+" or "-" or "()" becomes "". Setting currency/commodity - If the currency/commodity symbol is included in the CSV's amount + If the currency/commodity symbol is included in the CSV's amount field(s): 2020-01-01,foo,$123.00 @@ -7372,7 +7423,7 @@ CSV FORMAT 2020-01-01,foo,USD,123.00 You can assign that to the currency pseudo-field, which has the special - effect of prepending itself to every amount in the transaction (on the + effect of prepending itself to every amount in the transaction (on the left, with no separating space): fields date,description,currency,amount @@ -7381,7 +7432,7 @@ CSV FORMAT expenses:unknown USD123.00 income:unknown USD-123.00 - Or, you can use a field assignment to construct the amount yourself, + Or, you can use a field assignment to construct the amount yourself, with more control. Eg to put the symbol on the right, and separated by a space: @@ -7392,7 +7443,7 @@ CSV FORMAT expenses:unknown 123.00 USD income:unknown -123.00 USD - Note we used a temporary field name (cur) that is not currency - that + Note we used a temporary field name (cur) that is not currency - that would trigger the prepending effect, which we don't want here. Amount decimal places @@ -7400,13 +7451,13 @@ CSV FORMAT amount1 influence commodity display styles, such as the number of deci- mal places displayed in reports. - The original amounts as written in the CSV file do not affect display + The original amounts as written in the CSV file do not affect display style (because we don't yet reliably know their commodity). Referencing other fields - In field assignments, you can interpolate only CSV fields, not hledger - fields. In the example below, there's both a CSV field and a hledger - field named amount1, but %amount1 always means the CSV field, not the + In field assignments, you can interpolate only CSV fields, not hledger + fields. In the example below, there's both a CSV field and a hledger + field named amount1, but %amount1 always means the CSV field, not the hledger field: # Name the third CSV field "amount1" @@ -7418,7 +7469,7 @@ CSV FORMAT # Set comment to the CSV amount1 (not the amount1 assigned above) comment %amount1 - Here, since there's no CSV amount1 field, %amount1 will produce a lit- + Here, since there's no CSV amount1 field, %amount1 will produce a lit- eral "amount1": fields date,description,csvamount @@ -7426,7 +7477,7 @@ CSV FORMAT # Can't interpolate amount1 here comment %amount1 - When there are multiple field assignments to the same hledger field, + When there are multiple field assignments to the same hledger field, only the last one takes effect. Here, comment's value will be be B, or C if "something" is matched, but never A: @@ -7436,14 +7487,14 @@ CSV FORMAT comment C How CSV rules are evaluated - Here's how to think of CSV rules being evaluated (if you really need + Here's how to think of CSV rules being evaluated (if you really need to). First, - o include - all includes are inlined, from top to bottom, depth first. - (At each include point the file is inlined and scanned for further + o include - all includes are inlined, from top to bottom, depth first. + (At each include point the file is inlined and scanned for further includes, recursively, before proceeding.) - Then "global" rules are evaluated, top to bottom. If a rule is + Then "global" rules are evaluated, top to bottom. If a rule is repeated, the last one wins: o skip (at top level) @@ -7457,33 +7508,33 @@ CSV FORMAT Then for each CSV record in turn: - o test all if blocks. If any of them contain a end rule, skip all + o test all if blocks. If any of them contain a end rule, skip all remaining CSV records. Otherwise if any of them contain a skip rule, - skip that many CSV records. If there are multiple matched skip + skip that many CSV records. If there are multiple matched skip rules, the first one wins. - o collect all field assignments at top level and in matched if blocks. - When there are multiple assignments for a field, keep only the last + o collect all field assignments at top level and in matched if blocks. + When there are multiple assignments for a field, keep only the last one. - o compute a value for each hledger field - either the one that was - assigned to it (and interpolate the %CSVFIELDNAME references), or a + o compute a value for each hledger field - either the one that was + assigned to it (and interpolate the %CSVFIELDNAME references), or a default o generate a synthetic hledger transaction from these values. - This is all part of the CSV reader, one of several readers hledger can - use to parse input files. When all files have been read successfully, - the transactions are passed as input to whichever hledger command the + This is all part of the CSV reader, one of several readers hledger can + use to parse input files. When all files have been read successfully, + the transactions are passed as input to whichever hledger command the user specified. TIMECLOCK FORMAT The time logging format of timeclock.el, as read by hledger. - hledger can read time logs in timeclock format. As with Ledger, these + hledger can read time logs in timeclock format. As with Ledger, these are (a subset of) timeclock.el's format, containing clock-in and clock- - out entries as in the example below. The date is a simple date. The - time format is HH:MM[:SS][+-ZZZZ]. Seconds and timezone are optional. + out entries as in the example below. The date is a simple date. The + time format is HH:MM[:SS][+-ZZZZ]. Seconds and timezone are optional. The timezone, if present, must be four digits and is ignored (currently the time is always interpreted as a local time). @@ -7492,9 +7543,9 @@ TIMECLOCK FORMAT i 2015/03/31 22:21:45 another account o 2015/04/01 02:00:34 - hledger treats each clock-in/clock-out pair as a transaction posting - some number of hours to an account. Or if the session spans more than - one day, it is split into several transactions, one for each day. For + hledger treats each clock-in/clock-out pair as a transaction posting + some number of hours to an account. Or if the session spans more than + one day, it is split into several transactions, one for each day. For the above time log, hledger print generates these journal entries: $ hledger -f t.timeclock print @@ -7515,26 +7566,26 @@ TIMECLOCK FORMAT To generate time logs, ie to clock in and clock out, you could: - o use emacs and the built-in timeclock.el, or the extended timeclock- + o use emacs and the built-in timeclock.el, or the extended timeclock- x.el and perhaps the extras in ledgerutils.el o at the command line, use these bash aliases: shell alias ti="echo - i `date '+%Y-%m-%d %H:%M:%S'` \$* >>$TIMELOG" alias to="echo o + i `date '+%Y-%m-%d %H:%M:%S'` \$* >>$TIMELOG" alias to="echo o `date '+%Y-%m-%d %H:%M:%S'` >>$TIMELOG" o or use the old ti and to scripts in the ledger 2.x repository. These - rely on a "timeclock" executable which I think is just the ledger 2 + rely on a "timeclock" executable which I think is just the ledger 2 executable renamed. TIMEDOT FORMAT - timedot format is hledger's human-friendly time logging format. Com- + timedot format is hledger's human-friendly time logging format. Com- pared to timeclock format, it is o convenient for quick, approximate, and retroactive time logging o readable: you can see at a glance where time was spent. - A timedot file contains a series of day entries, which might look like + A timedot file contains a series of day entries, which might look like this: 2021-08-04 @@ -7542,7 +7593,7 @@ TIMEDOT FORMAT fos:hledger:timedot .. ; docs per:admin:finance - hledger reads this as three time transactions on this day, with each + hledger reads this as three time transactions on this day, with each dot representing a quarter-hour spent: $ hledger -f a.timedot print # .timedot file extension activates the timedot reader @@ -7565,45 +7616,45 @@ TIMEDOT FORMAT o a common transaction comment for this day, after a semicolon (;). - After the date line are zero or more optionally-indented time transac- + After the date line are zero or more optionally-indented time transac- tion lines, consisting of: o an account name - any word or phrase, usually a hledger-style account name. - o two or more spaces - a field separator, required if there is an + o two or more spaces - a field separator, required if there is an amount (as in journal format). - o a timedot amount - dots representing quarter hours, or a number rep- + o a timedot amount - dots representing quarter hours, or a number rep- resenting hours. o an optional comment beginning with semicolon. This is ignored. In more detail, timedot amounts can be: - o dots: zero or more period characters, each representing one quarter- - hour. Spaces are ignored and can be used for grouping. Eg: .... .. + o dots: zero or more period characters, each representing one quarter- + hour. Spaces are ignored and can be used for grouping. Eg: .... .. o a number, representing hours. Eg: 1.5 - o a number immediately followed by a unit symbol s, m, h, d, w, mo, or + o a number immediately followed by a unit symbol s, m, h, d, w, mo, or y, representing seconds, minutes, hours, days weeks, months or years. Eg 1.5h or 90m. The following equivalencies are assumed: - 60s = 1m, 60m = 1h, 24h = 1d, 7d = 1w, 30d = 1mo, 365d = 1y. (This - unit will not be visible in the generated transaction amount, which is + 60s = 1m, 60m = 1h, 24h = 1d, 7d = 1w, 30d = 1mo, 365d = 1y. (This + unit will not be visible in the generated transaction amount, which is always in hours.) - There is some added flexibility to help with keeping time log data in + There is some added flexibility to help with keeping time log data in the same file as your notes, todo lists, etc.: o Lines beginning with # or ;, and blank lines, are ignored. - o Lines not ending with a double-space and amount are parsed as trans- - actions with zero amount. (Most hledger reports hide these by + o Lines not ending with a double-space and amount are parsed as trans- + actions with zero amount. (Most hledger reports hide these by default; add -E to see them.) o One or more stars (*) followed by a space, at the start of a line, is - ignored. So date lines or time transaction lines can also be Org- + ignored. So date lines or time transaction lines can also be Org- mode headlines. o All Org-mode headlines before the first date line are ignored. @@ -7686,7 +7737,7 @@ TIMEDOT FORMAT A sample.timedot file. COMMON TASKS - Here are some quick examples of how to do some basic tasks with + Here are some quick examples of how to do some basic tasks with hledger. Getting help @@ -7696,38 +7747,38 @@ COMMON TASKS $ hledger --help # show common options $ hledger CMD --help # show common options and CMD's options and documentation - You can also view your hledger version's manual in several formats by + You can also view your hledger version's manual in several formats by using the help command. Eg: $ hledger help # show the hledger manual with info, man or $PAGER (best available) $ hledger help journal # show the journal topic in the hledger manual $ hledger help --help # show how the help command works - To view manuals and introductory docs on the web, visit - https://hledger.org. Chat and mail list support and discussion ar- + To view manuals and introductory docs on the web, visit + https://hledger.org. Chat and mail list support and discussion ar- chives can be found at https://hledger.org/support. Constructing command lines - hledger has an extensive and powerful command line interface. We + hledger has an extensive and powerful command line interface. We strive to keep it simple and ergonomic, but you may run into one of the confusing real world details described in OPTIONS, below. If that hap- pens, here are some tips that may help: - o command-specific options must go after the command (it's fine to put + o command-specific options must go after the command (it's fine to put all options there) (hledger CMD OPTS ARGS) - o running add-on executables directly simplifies command line parsing + o running add-on executables directly simplifies command line parsing (hledger-ui OPTS ARGS) o enclose "problematic" args in single quotes - o if needed, also add a backslash to hide regular expression metachar- + o if needed, also add a backslash to hide regular expression metachar- acters from the shell o to see how a misbehaving command is being parsed, add --debug=2. Starting a journal file - hledger looks for your accounting data in a journal file, + hledger looks for your accounting data in a journal file, $HOME/.hledger.journal by default: $ hledger stats @@ -7735,9 +7786,9 @@ COMMON TASKS Please create it first, eg with "hledger add" or a text editor. Or, specify an existing journal file with -f or LEDGER_FILE. - You can override this by setting the LEDGER_FILE environment variable. + You can override this by setting the LEDGER_FILE environment variable. It's a good practice to keep this important file under version control, - and to start a new file each year. So you could do something like + and to start a new file each year. So you could do something like this: $ mkdir ~/finance @@ -7761,20 +7812,20 @@ COMMON TASKS Market prices : 0 () Setting opening balances - Pick a starting date for which you can look up the balances of some - real-world assets (bank accounts, wallet..) and liabilities (credit + Pick a starting date for which you can look up the balances of some + real-world assets (bank accounts, wallet..) and liabilities (credit cards..). - To avoid a lot of data entry, you may want to start with just one or - two accounts, like your checking account or cash wallet; and pick a - recent starting date, like today or the start of the week. You can + To avoid a lot of data entry, you may want to start with just one or + two accounts, like your checking account or cash wallet; and pick a + recent starting date, like today or the start of the week. You can always come back later and add more accounts and older transactions, eg going back to january 1st. - Add an opening balances transaction to the journal, declaring the bal- + Add an opening balances transaction to the journal, declaring the bal- ances on this date. Here are two ways to do it: - o The first way: open the journal in any text editor and save an entry + o The first way: open the journal in any text editor and save an entry like this: 2020-01-01 * opening balances @@ -7784,19 +7835,19 @@ COMMON TASKS liabilities:creditcard $-50 = $-50 equity:opening/closing balances - These are start-of-day balances, ie whatever was in the account at + These are start-of-day balances, ie whatever was in the account at the end of the previous day. - The * after the date is an optional status flag. Here it means + The * after the date is an optional status flag. Here it means "cleared & confirmed". - The currency symbols are optional, but usually a good idea as you'll + The currency symbols are optional, but usually a good idea as you'll be dealing with multiple currencies sooner or later. - The = amounts are optional balance assertions, providing extra error + The = amounts are optional balance assertions, providing extra error checking. - o The second way: run hledger add and follow the prompts to record a + o The second way: run hledger add and follow the prompts to record a similar transaction: $ hledger add @@ -7833,18 +7884,18 @@ COMMON TASKS Starting the next transaction (. or ctrl-D/ctrl-C to quit) Date [2020-01-01]: . - If you're using version control, this could be a good time to commit + If you're using version control, this could be a good time to commit the journal. Eg: $ git commit -m 'initial balances' 2020.journal Recording transactions - As you spend or receive money, you can record these transactions using - one of the methods above (text editor, hledger add) or by using the - hledger-iadd or hledger-web add-ons, or by using the import command to + As you spend or receive money, you can record these transactions using + one of the methods above (text editor, hledger add) or by using the + hledger-iadd or hledger-web add-ons, or by using the import command to convert CSV data downloaded from your bank. - Here are some simple transactions, see the hledger_journal(5) manual + Here are some simple transactions, see the hledger_journal(5) manual and hledger.org for more ideas: 2020/1/10 * gift received @@ -7860,22 +7911,22 @@ COMMON TASKS assets:bank:checking $1000 Reconciling - Periodically you should reconcile - compare your hledger-reported bal- - ances against external sources of truth, like bank statements or your - bank's website - to be sure that your ledger accurately represents the - real-world balances (and, that the real-world institutions have not - made a mistake!). This gets easy and fast with (1) practice and (2) - frequency. If you do it daily, it can take 2-10 minutes. If you let - it pile up, expect it to take longer as you hunt down errors and dis- + Periodically you should reconcile - compare your hledger-reported bal- + ances against external sources of truth, like bank statements or your + bank's website - to be sure that your ledger accurately represents the + real-world balances (and, that the real-world institutions have not + made a mistake!). This gets easy and fast with (1) practice and (2) + frequency. If you do it daily, it can take 2-10 minutes. If you let + it pile up, expect it to take longer as you hunt down errors and dis- crepancies. A typical workflow: - 1. Reconcile cash. Count what's in your wallet. Compare with what - hledger reports (hledger bal cash). If they are different, try to - remember the missing transaction, or look for the error in the - already-recorded transactions. A register report can be helpful - (hledger reg cash). If you can't find the error, add an adjustment + 1. Reconcile cash. Count what's in your wallet. Compare with what + hledger reports (hledger bal cash). If they are different, try to + remember the missing transaction, or look for the error in the + already-recorded transactions. A register report can be helpful + (hledger reg cash). If you can't find the error, add an adjustment transaction. Eg if you have $105 after the above, and can't explain the missing $2, it could be: @@ -7885,26 +7936,26 @@ COMMON TASKS 2. Reconcile checking. Log in to your bank's website. Compare today's (cleared) balance with hledger's cleared balance (hledger bal check- - ing -C). If they are different, track down the error or record the - missing transaction(s) or add an adjustment transaction, similar to + ing -C). If they are different, track down the error or record the + missing transaction(s) or add an adjustment transaction, similar to the above. Unlike the cash case, you can usually compare the trans- - action history and running balance from your bank with the one - reported by hledger reg checking -C. This will be easier if you - generally record transaction dates quite similar to your bank's + action history and running balance from your bank with the one + reported by hledger reg checking -C. This will be easier if you + generally record transaction dates quite similar to your bank's clearing dates. 3. Repeat for other asset/liability accounts. - Tip: instead of the register command, use hledger-ui to see a live- + Tip: instead of the register command, use hledger-ui to see a live- updating register while you edit the journal: hledger-ui --watch --reg- ister checking -C - After reconciling, it could be a good time to mark the reconciled - transactions' status as "cleared and confirmed", if you want to track - that, by adding the * marker. Eg in the paycheck transaction above, + After reconciling, it could be a good time to mark the reconciled + transactions' status as "cleared and confirmed", if you want to track + that, by adding the * marker. Eg in the paycheck transaction above, insert * between 2020-01-15 and paycheck - If you're using version control, this can be another good time to com- + If you're using version control, this can be another good time to com- mit: $ git commit -m 'txns' 2020.journal @@ -7976,7 +8027,7 @@ COMMON TASKS -------------------- 0 - Show only asset and liability balances, as a flat list, limited to + Show only asset and liability balances, as a flat list, limited to depth 2: $ hledger bal assets liabilities -2 @@ -7986,7 +8037,7 @@ COMMON TASKS -------------------- $4055 - Show the same thing without negative numbers, formatted as a simple + Show the same thing without negative numbers, formatted as a simple balance sheet: $ hledger bs -2 @@ -8053,15 +8104,15 @@ COMMON TASKS 2020-01-13 **** Migrating to a new file - At the end of the year, you may want to continue your journal in a new + At the end of the year, you may want to continue your journal in a new file, so that old transactions don't slow down or clutter your reports, - and to help ensure the integrity of your accounting history. See the + and to help ensure the integrity of your accounting history. See the close command. If using version control, don't forget to git add the new file. LIMITATIONS - The need to precede add-on command options with -- when invoked from + The need to precede add-on command options with -- when invoked from hledger is awkward. When input data contains non-ascii characters, a suitable system locale @@ -8077,36 +8128,36 @@ LIMITATIONS In a Cygwin/MSYS/Mintty window, the tab key is not supported in hledger add. - Not all of Ledger's journal file syntax is supported. See hledger and + Not all of Ledger's journal file syntax is supported. See hledger and Ledger > Differences > journal format. - On large data files, hledger is slower and uses more memory than + On large data files, hledger is slower and uses more memory than Ledger. TROUBLESHOOTING - Here are some issues you might encounter when you run hledger (and - remember you can also seek help from the IRC channel, mail list or bug + Here are some issues you might encounter when you run hledger (and + remember you can also seek help from the IRC channel, mail list or bug tracker): Successfully installed, but "No command 'hledger' found" stack and cabal install binaries into a special directory, which should - be added to your PATH environment variable. Eg on unix-like systems, + be added to your PATH environment variable. Eg on unix-like systems, that is ~/.local/bin and ~/.cabal/bin respectively. I set a custom LEDGER_FILE, but hledger is still using the default file - LEDGER_FILE should be a real environment variable, not just a shell - variable. The command env | grep LEDGER_FILE should show it. You may + LEDGER_FILE should be a real environment variable, not just a shell + variable. The command env | grep LEDGER_FILE should show it. You may need to use export. Here's an explanation. - Getting errors like "Illegal byte sequence" or "Invalid or incomplete - multibyte or wide character" or "commitAndReleaseBuffer: invalid argu- + Getting errors like "Illegal byte sequence" or "Invalid or incomplete + multibyte or wide character" or "commitAndReleaseBuffer: invalid argu- ment (invalid character)" Programs compiled with GHC (hledger, haskell build tools, etc.) need to have a UTF-8-aware locale configured in the environment, otherwise they - will fail with these kinds of errors when they encounter non-ascii + will fail with these kinds of errors when they encounter non-ascii characters. - To fix it, set the LANG environment variable to some locale which sup- + To fix it, set the LANG environment variable to some locale which sup- ports UTF-8. The locale you choose must be installed on your system. Here's an example of setting LANG temporarily, on Ubuntu GNU/Linux: @@ -8121,8 +8172,8 @@ TROUBLESHOOTING POSIX $ LANG=en_US.utf8 hledger -f my.journal print # ensure it is used for this command - If available, C.UTF-8 will also work. If your preferred locale isn't - listed by locale -a, you might need to install it. Eg on + If available, C.UTF-8 will also work. If your preferred locale isn't + listed by locale -a, you might need to install it. Eg on Ubuntu/Debian: $ apt-get install language-pack-fr @@ -8142,8 +8193,8 @@ TROUBLESHOOTING $ echo "export LANG=en_US.utf8" >>~/.bash_profile $ bash --login - Exact spelling and capitalisation may be important. Note the differ- - ence on MacOS (UTF-8, not utf8). Some platforms (eg ubuntu) allow + Exact spelling and capitalisation may be important. Note the differ- + ence on MacOS (UTF-8, not utf8). Some platforms (eg ubuntu) allow variant spellings, but others (eg macos) require it to be exact: $ locale -a | grep -iE en_us.*utf @@ -8153,7 +8204,7 @@ TROUBLESHOOTING 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) @@ -8171,4 +8222,4 @@ SEE ALSO -hledger-1.27.99 October 2022 HLEDGER(1) +hledger-1.27.99 November 2022 HLEDGER(1)