From 791f4655df55edf474c1a584e109285df0a40530 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Fri, 26 Nov 2021 05:58:55 -1000 Subject: [PATCH] ;doc: update manuals --- hledger-ui/hledger-ui.1 | 6 +- hledger-ui/hledger-ui.info | 44 +- hledger-ui/hledger-ui.txt | 8 +- hledger-web/hledger-web.info | 351 +++++++------ hledger/hledger.1 | 149 +++--- hledger/hledger.info | 948 +++++++++++++++++------------------ hledger/hledger.txt | 123 ++--- 7 files changed, 785 insertions(+), 844 deletions(-) diff --git a/hledger-ui/hledger-ui.1 b/hledger-ui/hledger-ui.1 index 97f749d4c..758d8a94b 100644 --- a/hledger-ui/hledger-ui.1 +++ b/hledger-ui/hledger-ui.1 @@ -342,6 +342,8 @@ It lists accounts and their balances, like hledger\[aq]s balance command. By default, it shows all accounts and their latest ending balances (including the balances of subaccounts). +Accounts which have been declared with an account directive are also +listed, even if not yet used (except for empty parent accounts). If you specify a query on the command line, it shows just the matched accounts and the balances from matched transactions. .PP @@ -382,7 +384,7 @@ all three, the filter is removed.) .PP \f[C]R\f[R] toggles real mode, in which virtual postings are ignored. .PP -\f[C]Z\f[R] toggles nonzero mode, in which only accounts with nonzero +\f[C]z\f[R] toggles nonzero mode, in which only accounts with nonzero balances are shown (hledger-ui shows zero items by default, unlike command-line hledger). .PP @@ -428,7 +430,7 @@ activate all three, the filter is removed.) .PP \f[C]R\f[R] toggles real mode, in which virtual postings are ignored. .PP -\f[C]Z\f[R] toggles nonzero mode, in which only transactions posting a +\f[C]z\f[R] toggles nonzero mode, in which only transactions posting a nonzero change are shown (hledger-ui shows zero items by default, unlike command-line hledger). .PP diff --git a/hledger-ui/hledger-ui.info b/hledger-ui/hledger-ui.info index e13612def..7a2421b0d 100644 --- a/hledger-ui/hledger-ui.info +++ b/hledger-ui/hledger-ui.info @@ -368,7 +368,9 @@ File: hledger-ui.info, Node: Accounts screen, Next: Register screen, Up: SCRE This is normally the first screen displayed. It lists accounts and their balances, like hledger's balance command. By default, it shows all accounts and their latest ending balances (including the balances of -subaccounts). If you specify a query on the command line, it shows just +subaccounts). Accounts which have been declared with an account +directive are also listed, even if not yet used (except for empty parent +accounts). If you specify a query on the command line, it shows just the matched accounts and the balances from matched transactions. Account names are shown as a flat list by default; press 't' to @@ -402,7 +404,7 @@ is removed.) 'R' toggles real mode, in which virtual postings are ignored. - 'Z' toggles nonzero mode, in which only accounts with nonzero + 'z' toggles nonzero mode, in which only accounts with nonzero balances are shown (hledger-ui shows zero items by default, unlike command-line hledger). @@ -448,7 +450,7 @@ is removed.) 'R' toggles real mode, in which virtual postings are ignored. - 'Z' toggles nonzero mode, in which only transactions posting a + 'z' toggles nonzero mode, in which only transactions posting a nonzero change are shown (hledger-ui shows zero items by default, unlike command-line hledger). @@ -633,24 +635,24 @@ Node: SCREENS11193 Ref: #screens11291 Node: Accounts screen11381 Ref: #accounts-screen11509 -Node: Register screen13713 -Ref: #register-screen13868 -Node: Transaction screen15852 -Ref: #transaction-screen16010 -Node: Error screen16880 -Ref: #error-screen17002 -Node: TIPS17246 -Ref: #tips17345 -Node: Watch mode17397 -Ref: #watch-mode17514 -Node: Watch mode limitations18264 -Ref: #watch-mode-limitations18405 -Node: ENVIRONMENT19541 -Ref: #environment19652 -Node: FILES20459 -Ref: #files20558 -Node: BUGS20771 -Ref: #bugs20848 +Node: Register screen13848 +Ref: #register-screen14003 +Node: Transaction screen15987 +Ref: #transaction-screen16145 +Node: Error screen17015 +Ref: #error-screen17137 +Node: TIPS17381 +Ref: #tips17480 +Node: Watch mode17532 +Ref: #watch-mode17649 +Node: Watch mode limitations18399 +Ref: #watch-mode-limitations18540 +Node: ENVIRONMENT19676 +Ref: #environment19787 +Node: FILES20594 +Ref: #files20693 +Node: BUGS20906 +Ref: #bugs20983  End Tag Table diff --git a/hledger-ui/hledger-ui.txt b/hledger-ui/hledger-ui.txt index d1d16b007..4d4b96715 100644 --- a/hledger-ui/hledger-ui.txt +++ b/hledger-ui/hledger-ui.txt @@ -312,7 +312,9 @@ SCREENS This is normally the first screen displayed. It lists accounts and their balances, like hledger's balance command. By default, it shows all accounts and their latest ending balances (including the balances - of subaccounts). If you specify a query on the command line, it shows + of subaccounts). Accounts which have been declared with an account + directive are also listed, even if not yet used (except for empty par- + ent accounts). If you specify a query on the command line, it shows just the matched accounts and the balances from matched transactions. Account names are shown as a flat list by default; press t to toggle @@ -345,7 +347,7 @@ SCREENS R toggles real mode, in which virtual postings are ignored. - Z toggles nonzero mode, in which only accounts with nonzero balances + z toggles nonzero mode, in which only accounts with nonzero balances are shown (hledger-ui shows zero items by default, unlike command-line hledger). @@ -385,7 +387,7 @@ SCREENS R toggles real mode, in which virtual postings are ignored. - Z toggles nonzero mode, in which only transactions posting a nonzero + z toggles nonzero mode, in which only transactions posting a nonzero change are shown (hledger-ui shows zero items by default, unlike com- mand-line hledger). diff --git a/hledger-web/hledger-web.info b/hledger-web/hledger-web.info index 4bbc25e66..f04984697 100644 --- a/hledger-web/hledger-web.info +++ b/hledger-web/hledger-web.info @@ -1,5 +1,4 @@ -This is hledger-web/hledger-web.info, produced by makeinfo version 4.8 -from stdin. +This is hledger-web.info, produced by makeinfo version 6.8 from stdin. INFO-DIR-SECTION User Applications START-INFO-DIR-ENTRY @@ -7,7 +6,7 @@ START-INFO-DIR-ENTRY END-INFO-DIR-ENTRY  -File: hledger-web.info, Node: Top, Up: (dir) +File: hledger-web.info, Node: Top, Next: OPTIONS, Up: (dir) hledger-web(1) ************** @@ -15,31 +14,32 @@ hledger-web(1) hledger-web is a web interface (WUI) for the hledger accounting tool. This manual is for hledger-web 1.23.99. - `hledger-web [OPTIONS]' -`hledger web -- [OPTIONS]' + 'hledger-web [OPTIONS]' +'hledger web -- [OPTIONS]' 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 +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 + 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. +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 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. +the public web. There is no access control, so if you need that you +should put it behind a suitable web proxy. As a small protection +against data loss when running an unprotected instance, it writes a +numbered backup of the main journal file (only ?) on every edit. Like hledger, it reads data from one or more files in hledger -journal, timeclock, timedot, or CSV format specified with `-f', or -`$LEDGER_FILE', or `$HOME/.hledger.journal' (on windows, perhaps -`C:/Users/USER/.hledger.journal'). For more about this see hledger(1). +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). * Menu: @@ -59,177 +59,180 @@ File: hledger-web.info, Node: OPTIONS, Next: PERMISSIONS, Prev: Top, Up: Top ********* Command-line options and arguments may be used to set an initial filter -on the data. These filter options are not shown in the web UI, but it +on the data. These filter options are not shown in the web UI, but it will be applied in addition to any search query entered there. - Note: if invoking hledger-web as a hledger subcommand, write `--' + Note: if invoking hledger-web as a hledger subcommand, write '--' before options, as shown in the synopsis above. -`--serve' - serve and log requests, don't browse or auto-exit +'--serve' + + serve and log requests, don't browse or auto-exit +'--serve-api' -`--serve-api' like -serve, but serve only the JSON web API, without the server-side web UI +'--host=IPADDR' -`--host=IPADDR' listen on this IP address (default: 127.0.0.1) +'--port=PORT' -`--port=PORT' listen on this TCP port (default: 5000) +'--socket=SOCKETFILE' -`--socket=SOCKETFILE' use a unix domain socket file to listen for requests instead of a - TCP socket. Implies `--serve'. It can only be used if the operating - system can provide this type of socket. + TCP socket. Implies '--serve'. It can only be used if the + operating system can provide this type of socket. +'--base-url=URL' -`--base-url=URL' set the base url (default: http://IPADDR:PORT). You would change this when sharing over the network, or integrating within a larger website. +'--file-url=URL' -`--file-url=URL' - set the static files url (default: BASEURL/static). hledger-web + set the static files url (default: BASEURL/static). hledger-web normally serves static files itself, but if you wanted to serve - them from another server for efficiency, you would set the url - with this. + them from another server for efficiency, you would set the url with + this. +'--capabilities=CAP[,CAP..]' -`--capabilities=CAP[,CAP..]' enable the view, add, and/or manage capabilities (default: view,add) +'--capabilities-header=HTTPHEADER' -`--capabilities-header=HTTPHEADER' read capabilities to enable from a HTTP header, like X-Sandstorm-Permissions (default: disabled) +'--test' -`--test' - run hledger-web's tests and exit. hspec test runner args may + run hledger-web's tests and exit. hspec test runner args may follow a -, eg: hledger-web -test - -help hledger input options: -`-f FILE --file=FILE' - use a different input file. For stdin, use - (default: - `$LEDGER_FILE' or `$HOME/.hledger.journal') +'-f FILE --file=FILE' + + use a different input file. For stdin, use - (default: + '$LEDGER_FILE' or '$HOME/.hledger.journal') +'--rules-file=RULESFILE' -`--rules-file=RULESFILE' Conversion rules file to use when reading CSV (default: FILE.rules) +'--separator=CHAR' -`--separator=CHAR' Field separator to expect when reading CSV (default: ',') +'--alias=OLD=NEW' -`--alias=OLD=NEW' rename accounts named OLD to NEW +'--anon' -`--anon' anonymize accounts and payees +'--pivot FIELDNAME' -`--pivot FIELDNAME' use some other field or tag for the account name +'-I --ignore-assertions' -`-I --ignore-assertions' disable balance assertion checks (note: does not disable balance assignments) +'-s --strict' -`-s --strict' do extra error checking (check that all posted accounts are declared) hledger reporting options: -`-b --begin=DATE' +'-b --begin=DATE' + include postings/txns on or after this date (will be adjusted to preceding subperiod start when using a report interval) +'-e --end=DATE' -`-e --end=DATE' include postings/txns before this date (will be adjusted to following subperiod end when using a report interval) +'-D --daily' -`-D --daily' multiperiod/multicolumn report by day +'-W --weekly' -`-W --weekly' multiperiod/multicolumn report by week +'-M --monthly' -`-M --monthly' multiperiod/multicolumn report by month +'-Q --quarterly' -`-Q --quarterly' multiperiod/multicolumn report by quarter +'-Y --yearly' -`-Y --yearly' multiperiod/multicolumn report by year +'-p --period=PERIODEXP' -`-p --period=PERIODEXP' set start date, end date, and/or reporting interval all at once using period expressions syntax +'--date2' -`--date2' match the secondary date instead (see command help for other effects) +'--today=DATE' -`--today=DATE' override today's date (affects relative smart dates, for tests/examples) +'-U --unmarked' -`-U --unmarked' include only unmarked postings/txns (can combine with -P or -C) +'-P --pending' -`-P --pending' include only pending postings/txns +'-C --cleared' -`-C --cleared' include only cleared postings/txns +'-R --real' -`-R --real' include only non-virtual postings +'-NUM --depth=NUM' -`-NUM --depth=NUM' hide/aggregate accounts or postings more than NUM levels deep +'-E --empty' -`-E --empty' show items with zero amount, normally hidden (and vice-versa in hledger-ui/hledger-web) +'-B --cost' -`-B --cost' convert amounts to their cost/selling amount at transaction time +'-V --market' -`-V --market' convert amounts to their market value in default valuation commodities +'-X --exchange=COMM' -`-X --exchange=COMM' convert amounts to their market value in commodity COMM +'--value' -`--value' convert amounts to cost or market value, more flexibly than -B/-V/-X +'--infer-market-prices' -`--infer-market-prices' use transaction prices (recorded with @ or @@) as additional market prices, as if they were P directives +'--auto' -`--auto' apply automated posting rules to modify transactions. +'--forecast' -`--forecast' generate future transactions from periodic transaction rules, for - the next 6 months or till report end date. In hledger-ui, also + the next 6 months or till report end date. In hledger-ui, also make ordinary future transactions visible. +'--commodity-style' -`--commodity-style' Override the commodity style in the output for the specified commodity. For example 'EUR1.000,00'. +'--color=WHEN (or --colour=WHEN)' -`--color=WHEN (or --colour=WHEN)' Should color-supporting commands use ANSI color codes in text output. 'auto' (default): whenever stdout seems to be a color-supporting terminal. 'always' or 'yes': always, useful eg - when piping output into 'less -R'. 'never' or 'no': never. A + when piping output into 'less -R'. 'never' or 'no': never. A NO_COLOR environment variable overrides this. +'--pretty[=WHEN]' -`--pretty[=WHEN]' - Show prettier output, e.g. using unicode box-drawing characters. + Show prettier output, e.g. using unicode box-drawing characters. Accepts 'yes' (the default) or 'no' ('y', 'n', 'always', 'never' also work). If you provide an argument you must use '=', e.g. '-pretty=yes'. @@ -241,62 +244,62 @@ the last one takes precedence. hledger help options: -`-h --help' +'-h --help' + show general or COMMAND help +'--man' -`--man' show general or COMMAND user manual with man +'--info' -`--info' show general or COMMAND user manual with info +'--version' -`--version' show general or ADDONCMD version +'--debug[=N]' -`--debug[=N]' show debug output (levels 1-9, default: 1) A @FILE argument will be expanded to the contents of FILE, which -should contain one command line option/argument per line. (To prevent -this, insert a `--' argument before.) +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 +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 +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 +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 + 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 -authentication 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 created a socket in `/tmp/hledger/': - + 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 authentication +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 +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 + 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 configured host address and TCP port (or `http://HOST' if PORT +within 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, + 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. @@ -311,32 +314,28 @@ journal and to add new transactions, but not to change existing data. You can restrict who can reach it by - * setting the IP address it listens on (see `--host' above). By + * 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. - * putting it behind an authenticating proxy, using eg apache or nginx - * custom firewall rules You can restrict what the users who reach it can do, by - * using the `--capabilities=CAP[,CAP..]' flag when you start it, - enabling one or more of the following capabilities. The default - value is `view,add': - * `view' - allows viewing the journal file and all included + * using the '--capabilities=CAP[,CAP..]' flag when you start it, + enabling one or more of the following capabilities. The default + value is 'view,add': + * 'view' - allows viewing the journal file and all included files - - * `add' - allows adding new transactions to the main journal + * 'add' - allows adding new transactions to the main journal file - - * `manage' - allows editing, uploading or downloading the main + * 'manage' - allows editing, uploading or downloading the main or included files - * using the `--capabilities-header=HTTPHEADER' flag to specify a HTTP - header from which it will read capabilities to enable. hledger-web + * 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. + with Sandstorm's permissions. This is disabled by default.  File: hledger-web.info, Node: EDITING UPLOADING DOWNLOADING, Next: RELOADING, Prev: PERMISSIONS, Up: Top @@ -344,8 +343,8 @@ File: hledger-web.info, Node: EDITING UPLOADING DOWNLOADING, Next: RELOADING, 3 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 +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. @@ -354,13 +353,13 @@ visitor) 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, +full, etc.) hledger-web is not aware of version control systems, currently; 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 needs re-testing.) +(Probably. This needs re-testing.)  File: hledger-web.info, Node: RELOADING, Next: JSON API, Prev: EDITING UPLOADING DOWNLOADING, Up: Top @@ -370,7 +369,7 @@ File: hledger-web.info, Node: RELOADING, Next: JSON API, Prev: EDITING UPLOAD 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 +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. @@ -384,16 +383,14 @@ File: hledger-web.info, Node: JSON API, Next: ENVIRONMENT, Prev: RELOADING, ********** 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: - +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 ... You can get JSON data from these routes: - /version /accountnames /transactions @@ -406,7 +403,6 @@ $ hledger-web -f examples/sample.journal --serve-api command). (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 [ "assets", @@ -426,7 +422,6 @@ $ curl -s http://127.0.0.1:5000/accountnames | python -m json.tool Or all transactions: - $ curl -s http://127.0.0.1:5000/transactions | python -m json.tool [ { @@ -448,25 +443,24 @@ $ curl -s http://127.0.0.1:5000/transactions | python -m json.tool 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 +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 for `/accounttransactions' it's getAccounttransactionsR, returning a -"`accountTransactionsReport ...'". Looking up the haddock for that we +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 +for '/accounttransactions' it's getAccounttransactionsR, returning a +"'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 AccountTransactionsReportItem (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 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 export it with hledger-lib, eg like so: - +'/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 +export it with hledger-lib, eg like so: .../hledger$ stack ghci hledger-lib >>> writeJsonFile "txn.json" (head $ jtxns samplejournal) @@ -475,7 +469,6 @@ can export it with hledger-lib, eg like so: Here's how it looks as of hledger-1.17 (remember, this JSON corresponds to hledger's Transaction and related data types): - { "tcomment": "", "tpostings": [ @@ -562,10 +555,9 @@ corresponds to hledger's Transaction and related data types): "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  @@ -574,26 +566,25 @@ File: hledger-web.info, Node: ENVIRONMENT, Next: FILES, Prev: JSON API, Up: 6 ENVIRONMENT ************* -*LEDGER_FILE* The journal file path when not specified with `-f'. -Default: `~/.hledger.journal' (on windows, perhaps -`C:/Users/USER/.hledger.journal'). +*LEDGER_FILE* The journal file path when not specified with '-f'. +Default: '~/.hledger.journal' (on windows, perhaps +'C:/Users/USER/.hledger.journal'). - A typical value is `~/DIR/YYYY.journal', where DIR is a -version-controlled finance directory and YYYY is the current year. Or -`~/DIR/current.journal', where current.journal is a symbolic link to + A typical value is '~/DIR/YYYY.journal', where DIR is a +version-controlled finance directory and YYYY is the current year. Or +'~/DIR/current.journal', where current.journal is a symbolic link to YYYY.journal. - On Mac computers, you can set this and other environment variables -in a more thorough way that also affects applications started from the -GUI (say, an Emacs dock icon). Eg on MacOS Catalina I have a -`~/.MacOSX/environment.plist' file containing - + On Mac computers, you can set this and other environment variables in +a more thorough way that also affects applications started from the GUI +(say, an Emacs dock icon). Eg on MacOS Catalina I have a +'~/.MacOSX/environment.plist' file containing { "LEDGER_FILE" : "~/finance/current.journal" } - To see the effect you may need to `killall Dock', or reboot. + To see the effect you may need to 'killall Dock', or reboot.  File: hledger-web.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top @@ -602,9 +593,9 @@ File: hledger-web.info, Node: FILES, Next: BUGS, Prev: ENVIRONMENT, Up: Top ******* 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'). +timedot, or CSV format specified with '-f', or '$LEDGER_FILE', or +'$HOME/.hledger.journal' (on windows, perhaps +'C:/Users/USER/.hledger.journal').  File: hledger-web.info, Node: BUGS, Prev: FILES, Up: Top @@ -612,10 +603,10 @@ File: hledger-web.info, Node: BUGS, Prev: FILES, Up: Top 8 BUGS ****** -The need to precede options with `--' when invoked from hledger is +The need to precede options with '--' when invoked from hledger is awkward. - `-f-' doesn't work (hledger-web can't read from stdin). + '-f-' doesn't work (hledger-web can't read from stdin). Query arguments and some hledger options are ignored. @@ -623,25 +614,29 @@ awkward. Does not work well on small screens. -  Tag Table: -Node: Top235 -Node: OPTIONS1878 -Ref: #options1983 -Node: PERMISSIONS9873 -Ref: #permissions10012 -Node: EDITING UPLOADING DOWNLOADING11224 -Ref: #editing-uploading-downloading11405 -Node: RELOADING12236 -Ref: #reloading12370 -Node: JSON API12802 -Ref: #json-api12916 -Node: ENVIRONMENT18405 -Ref: #environment18521 -Node: FILES19253 -Ref: #files19353 -Node: BUGS19566 -Ref: #bugs19644 +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: FILES19291 +Ref: #files19391 +Node: BUGS19604 +Ref: #bugs19682  End Tag Table + + +Local Variables: +coding: utf-8 +End: diff --git a/hledger/hledger.1 b/hledger/hledger.1 index 1881d4bd4..6c5fcc1f9 100644 --- a/hledger/hledger.1 +++ b/hledger/hledger.1 @@ -3101,6 +3101,20 @@ Output as CSV and use a CSV viewer like visidata .IP \[bu] 2 Output as HTML and view with a browser: \f[C]hledger bal -D -o a.html && open a.html\f[R] +.SS Showing declared accounts +.PP +With \f[C]--declared\f[R], 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 +\f[C]-E/--empty\f[R] to see them.) +.PP +More precisely, \f[I]leaf\f[R] declared accounts (with no subaccounts) +will be included, since those are usually the more useful in reports. +.PP +The idea of this is to be able to see a useful \[dq]complete\[dq] +balance report, even when you don\[aq]t have transactions in all of your +declared accounts yet. .SS Commodity layout .PP With \f[C]--layout\f[R], you can control how amounts with more than one @@ -6790,7 +6804,7 @@ _ T{ \f[B]\f[CB]account\f[B]\f[R] T}@T{ -Declare an account, for checking all entries in all files; and its +Declares an account, for checking all entries in all files; and its display order and type, for reports. Subdirectives: any text, ignored. T}@T{ @@ -7282,67 +7296,64 @@ account ACCTNAME [ACCTTYPE] [;COMMENT] .fi .SS Account types .PP -hledger recognises five main types of account, corresponding to the -account classes in the accounting equation: +By adding a \f[C]type\f[R] tag to the account directive, with value +\f[C]A\f[R], \f[C]L\f[R], \f[C]E\f[R], \f[C]R\f[R], \f[C]X\f[R], +\f[C]C\f[R] (or if you prefer: \f[C]Asset\f[R], \f[C]Liability\f[R], +\f[C]Equity\f[R], \f[C]Revenue\f[R], \f[C]Expense\f[R], \f[C]Cash\f[R]), +you can declare hledger accounts to be of a certain type: +.IP \[bu] 2 +\f[B]asset\f[R], \f[B]liability\f[R], \f[B]equity\f[R], +\f[B]revenue\f[R], \f[B]expense\f[R] +.PD 0 +.P +.PD +the standard types in accounting, or +.IP \[bu] 2 +\f[B]cash\f[R] +.PD 0 +.P +.PD +a subtype of asset, used for liquid assets. .PP -\f[C]Asset\f[R], \f[C]Liability\f[R], \f[C]Equity\f[R], -\f[C]Revenue\f[R], \f[C]Expense\f[R]. +Declaring account types is a good idea, since it helps enable the easy +balancesheet, balancesheetequity, incomestatement and cashflow reports, +and probably other things in future. +As a convenience, when account types are not declared, hledger will try +to guess them based on english-language account names. .PP -These account types are important for controlling which accounts appear -in the balancesheet, balancesheetequity, incomestatement reports (and -probably for other things in future). -.PP -Additionally, we recognise the \f[C]Cash\f[R] type, which is also an -\f[C]Asset\f[R], and which causes accounts to appear in the cashflow -report. -(\[dq]Cash\[dq] here means liquid assets, eg bank balances but typically -not investments or receivables.) -.SS Declaring account types -.PP -To make the balancesheet/balancesheetequity/cashflow/incomestatement -reports work, generally you should declare your top-level accounts, and -their types. -For each top-level account, write an account directive, with a -\f[C]type:\f[R] tag. -The tag\[aq]s value can be any of \f[C]Asset\f[R], \f[C]Liability\f[R], -\f[C]Equity\f[R], \f[C]Revenue\f[R], \f[C]Expense\f[R], \f[C]Cash\f[R], -or (for short) \f[C]A\f[R], \f[C]L\f[R], \f[C]E\f[R], \f[C]R\f[R], -\f[C]X\f[R], \f[C]C\f[R] (case insensitive). -An account\[aq]s type is inherited by its subaccounts, unless they -declare a different type. -Here\[aq]s an example, declaring all six account types: +Here is a typical set of top-level account declarations (because of the +aforementioned, with these account names the type tags are not strictly +needed, but with non-english or non-standard account names, they will +be): .IP .nf \f[C] -account assets ; type: Asset -account assets:bank ; type: Cash -account assets:cash ; type: Cash -account liabilities ; type: Liability -account equity ; type: Equity -account revenues ; type: Revenue -account expenses ; type: Expense +account assets ; type: A +account liabilities ; type: L +account equity ; type: E +account revenues ; type: R +account expenses ; type: X + +account assets:bank ; type: C +account assets:cash ; type: C \f[R] .fi .PP -There is also an older syntax, which is deprecated and will be dropped -soon (A, L, E, R or X separated from the account name by two or more -spaces): -.IP -.nf -\f[C] -account assets A -account liabilities L -account equity E -account revenues R -account expenses X -\f[R] -.fi +It\[aq]s not necessary to declare the type of subaccounts. +(You can, if they are different from the parent, but this is not +common.) .SS Auto-detected account types .PP -hledger tries to find at least one top level account in each of the six -account types (Asset, Liability, Equity, Revenue, Expense, Cash). -When no accounts have been declared for a particular type, hledger tries -to auto-detect some accounts by name, using regular expressions: +More about \[dq]guessing\[dq] account types: hledger tries to find at +least one top level account in each of the six account types (Asset, +Liability, Equity, Revenue, Expense, Cash). +When no accounts have been declared for a particular type, it tries to +auto-detect some accounts by name, using the regular expressions below. +Note: if you declare any account\[aq]s type, it\[aq]s a good idea to +declare an account for all six types, because a mix of declared and +auto-detected types can cause confusing results. +.PP +The auto-detection rules are: .IP .nf \f[C] @@ -7357,40 +7368,6 @@ to auto-detect some accounts by name, using regular expressions: \[ha]expenses?(:|$) | Expense \f[R] .fi -.PP -For people using standard english account names, this feature helps -hledger\[aq]s high-level reports work out of the box with minimal -configuration. -.PP -If you use non-english account names, you should declare account types -to make these reports work. -And more generally, declaring accounts and types is usually a good idea, -for increased clarity and predictability (and for the other benefits of -account directives: error checking, display order, etc). -.PP -Notes: -.IP \[bu] 2 -When any account is declared as some type, this disables auto-detection -for that particular type. -.IP \[bu] 2 -If you declare any account\[aq]s type, it\[aq]s a good idea to declare -an account for all six types, since a mix of declared and auto-detected -types can cause confusion. -For example, here liabilities is declared to be Equity, but would also -be auto-detected as Liability, since no Liability account is declared: -.RS 2 -.IP -.nf -\f[C] -account liabilities ; type:Equity - -2020-01-01 - assets 1 - liabilities 1 - equity -2 -\f[R] -.fi -.RE .SS Account display order .PP Account directives also set the order in which accounts are displayed, diff --git a/hledger/hledger.info b/hledger/hledger.info index c356262d7..6f8fe69e4 100644 --- a/hledger/hledger.info +++ b/hledger/hledger.info @@ -2287,6 +2287,7 @@ more control, then use 'balance'. * Depth limiting:: * Dropping top-level accounts:: * Multi-period balance report:: +* Showing declared accounts:: * Commodity layout:: * Sorting by amount:: * Percentages:: @@ -2501,7 +2502,7 @@ $ hledger -f examples/sample.journal bal expenses --drop 1 $2  -File: hledger.info, Node: Multi-period balance report, Next: Commodity layout, Prev: Dropping top-level accounts, Up: balance +File: hledger.info, Node: Multi-period balance report, Next: Showing declared accounts, Prev: Dropping top-level accounts, Up: balance 11.5.7 Multi-period balance report ---------------------------------- @@ -2556,9 +2557,27 @@ viewing in the terminal. Here are some ways to handle that: && open a.html'  -File: hledger.info, Node: Commodity layout, Next: Sorting by amount, Prev: Multi-period balance report, Up: balance +File: hledger.info, Node: Showing declared accounts, Next: Commodity layout, Prev: Multi-period balance report, Up: balance -11.5.8 Commodity layout +11.5.8 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 +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 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 +accounts yet. + + +File: hledger.info, Node: Commodity layout, Next: Sorting by amount, Prev: Showing declared accounts, Up: balance + +11.5.9 Commodity layout ----------------------- With '--layout', you can control how amounts with more than one @@ -2646,8 +2665,8 @@ $ hledger -f examples/bcexample.hledger bal assets:us:etrade -3 -O csv --layout=  File: hledger.info, Node: Sorting by amount, Next: Percentages, Prev: Commodity layout, Up: balance -11.5.9 Sorting by amount ------------------------- +11.5.10 Sorting by amount +------------------------- With '-S/--sort-amount', accounts with the largest (most positive) balances are shown first. Eg: 'hledger bal expenses -MAS' shows your @@ -2664,7 +2683,7 @@ which flip the sign automatically. Eg: 'hledger incomestatement -MAS').  File: hledger.info, Node: Percentages, Next: Balance change end balance, Prev: Sorting by amount, Up: balance -11.5.10 Percentages +11.5.11 Percentages ------------------- With '-%/--percent', balance reports show each account's value expressed @@ -2697,7 +2716,7 @@ $ hledger bal -% cur:€  File: hledger.info, Node: Balance change end balance, Next: Balance report types, Prev: Percentages, Up: balance -11.5.11 Balance change, end balance +11.5.12 Balance change, end balance ----------------------------------- It's important to be clear on the meaning of the numbers shown in @@ -2734,7 +2753,7 @@ historical end balances:  File: hledger.info, Node: Balance report types, Next: Useful balance reports, Prev: Balance change end balance, Up: balance -11.5.12 Balance report types +11.5.13 Balance report types ---------------------------- For more flexible reporting, there are three important option groups: @@ -2831,7 +2850,7 @@ v /now'  File: hledger.info, Node: Useful balance reports, Next: Budget report, Prev: Balance report types, Up: balance -11.5.13 Useful balance reports +11.5.14 Useful balance reports ------------------------------ Some frequently used 'balance' options/reports are: @@ -2871,7 +2890,7 @@ Some frequently used 'balance' options/reports are:  File: hledger.info, Node: Budget report, Next: Customising single-period balance reports, Prev: Useful balance reports, Up: balance -11.5.14 Budget report +11.5.15 Budget report --------------------- The '--budget' report type activates extra columns showing any budget @@ -2995,7 +3014,7 @@ Budget performance in 2017/11/01-2017/12/31:  File: hledger.info, Node: Budget report start date, Next: Budgets and subaccounts, Up: Budget report -11.5.14.1 Budget report start date +11.5.15.1 Budget report start date .................................. This might be a bug, but for now: when making budget reports, it's a @@ -3039,7 +3058,7 @@ Budget performance in 2020-01-01..2020-01-15:  File: hledger.info, Node: Budgets and subaccounts, Next: Selecting budget goals, Prev: Budget report start date, Up: Budget report -11.5.14.2 Budgets and subaccounts +11.5.15.2 Budgets and subaccounts ................................. You can add budgets to any account in your account hierarchy. If you @@ -3127,7 +3146,7 @@ Budget performance in 2019/01:  File: hledger.info, Node: Selecting budget goals, Prev: Budgets and subaccounts, Up: Budget report -11.5.14.3 Selecting budget goals +11.5.15.3 Selecting budget goals ................................ The budget report evaluates periodic transaction rules to generate @@ -3153,7 +3172,7 @@ select from multiple budgets defined in your journal.  File: hledger.info, Node: Customising single-period balance reports, Prev: Budget report, Up: balance -11.5.15 Customising single-period balance reports +11.5.16 Customising single-period balance reports ------------------------------------------------- For single-period balance reports displayed in the terminal (only), you @@ -5850,7 +5869,7 @@ directiveeffects ends file end? --------------------------------------------------------------------------- -*'account'*Declare an account, for checking all entries in all files; +*'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 @@ -6266,68 +6285,59 @@ File: hledger.info, Node: Account types, Next: Account display order, Prev: A 12.25.4 Account types --------------------- -hledger recognises five main types of account, corresponding to the -account classes in the accounting equation: +By adding a 'type' tag to the account directive, with value 'A', 'L', +'E', 'R', 'X', 'C' (or if you prefer: 'Asset', 'Liability', 'Equity', +'Revenue', 'Expense', 'Cash'), you can declare hledger accounts to be of +a certain type: - 'Asset', 'Liability', 'Equity', 'Revenue', 'Expense'. + * *asset*, *liability*, *equity*, *revenue*, *expense* + the standard types in accounting, or - These account types are important for controlling which accounts -appear in the balancesheet, balancesheetequity, incomestatement reports -(and probably for other things in future). + * *cash* + a subtype of asset, used for liquid assets. - Additionally, we recognise the 'Cash' type, which is also an 'Asset', -and which causes accounts to appear in the cashflow report. ("Cash" -here means liquid assets, eg bank balances but typically not investments -or receivables.) + Declaring account types is a good idea, since it helps enable the +easy balancesheet, balancesheetequity, incomestatement and cashflow +reports, and probably other things in future. As a convenience, when +account types are not declared, hledger will try to guess them based on +english-language account names. + + Here is a typical set of top-level account declarations (because of +the aforementioned, with these account names the type tags are not +strictly needed, but with non-english or non-standard account names, +they will be): + +account assets ; type: A +account liabilities ; type: L +account equity ; type: E +account revenues ; type: R +account expenses ; type: X + +account assets:bank ; type: C +account assets:cash ; type: C + + It's not necessary to declare the type of subaccounts. (You can, if +they are different from the parent, but this is not common.) * Menu: -* Declaring account types:: * Auto-detected account types::  -File: hledger.info, Node: Declaring account types, Next: Auto-detected account types, Up: Account types +File: hledger.info, Node: Auto-detected account types, Up: Account types -12.25.4.1 Declaring account types -................................. - -To make the balancesheet/balancesheetequity/cashflow/incomestatement -reports work, generally you should declare your top-level accounts, and -their types. For each top-level account, write an account directive, -with a 'type:' tag. The tag's value can be any of 'Asset', 'Liability', -'Equity', 'Revenue', 'Expense', 'Cash', or (for short) 'A', 'L', 'E', -'R', 'X', 'C' (case insensitive). An account's type is inherited by its -subaccounts, unless they declare a different type. Here's an example, -declaring all six account types: - -account assets ; type: Asset -account assets:bank ; type: Cash -account assets:cash ; type: Cash -account liabilities ; type: Liability -account equity ; type: Equity -account revenues ; type: Revenue -account expenses ; type: Expense - - There is also an older syntax, which is deprecated and will be -dropped soon (A, L, E, R or X separated from the account name by two or -more spaces): - -account assets A -account liabilities L -account equity E -account revenues R -account expenses X - - -File: hledger.info, Node: Auto-detected account types, Prev: Declaring account types, Up: Account types - -12.25.4.2 Auto-detected account types +12.25.4.1 Auto-detected account types ..................................... -hledger tries to find at least one top level account in each of the six -account types (Asset, Liability, Equity, Revenue, Expense, Cash). When -no accounts have been declared for a particular type, hledger tries to -auto-detect some accounts by name, using regular expressions: +More about "guessing" account types: hledger tries to find at least one +top level account in each of the six account types (Asset, Liability, +Equity, Revenue, Expense, Cash). When no accounts have been declared +for a particular type, it tries to auto-detect some accounts by name, +using the regular expressions below. Note: if you declare any account's +type, it's a good idea to declare an account for all six types, because +a mix of declared and auto-detected types can cause confusing results. + + The auto-detection rules are: If account's name matches this case insensitive regular expression:| its type is: ------------------------------------------------------------------- | ------------ @@ -6339,34 +6349,6 @@ auto-detect some accounts by name, using regular expressions: ^(income|revenue)s?(:|$) | Revenue ^expenses?(:|$) | Expense - For people using standard english account names, this feature helps -hledger's high-level reports work out of the box with minimal -configuration. - - If you use non-english account names, you should declare account -types to make these reports work. And more generally, declaring -accounts and types is usually a good idea, for increased clarity and -predictability (and for the other benefits of account directives: error -checking, display order, etc). - - Notes: - - * When any account is declared as some type, this disables - auto-detection for that particular type. - - * If you declare any account's type, it's a good idea to declare an - account for all six types, since a mix of declared and - auto-detected types can cause confusion. For example, here - liabilities is declared to be Equity, but would also be - auto-detected as Liability, since no Liability account is declared: - - account liabilities ; type:Equity - - 2020-01-01 - assets 1 - liabilities 1 - equity -2 -  File: hledger.info, Node: Account display order, Prev: Account types, Up: Declaring accounts @@ -9137,396 +9119,396 @@ Node: aregister and custom posting dates78242 Ref: #aregister-and-custom-posting-dates78408 Node: balance78960 Ref: #balance79079 -Node: balance features80047 -Ref: #balance-features80187 -Node: Simple balance report82111 -Ref: #simple-balance-report82293 -Node: Filtered balance report83773 -Ref: #filtered-balance-report83960 -Node: List or tree mode84287 -Ref: #list-or-tree-mode84455 -Node: Depth limiting85800 -Ref: #depth-limiting85966 -Node: Dropping top-level accounts86567 -Ref: #dropping-top-level-accounts86769 -Node: Multi-period balance report87079 -Ref: #multi-period-balance-report87283 -Node: Commodity layout89558 -Ref: #commodity-layout89730 -Node: Sorting by amount95071 -Ref: #sorting-by-amount95229 -Node: Percentages95899 -Ref: #percentages96057 -Node: Balance change end balance97018 -Ref: #balance-change-end-balance97211 -Node: Balance report types98639 -Ref: #balance-report-types98829 -Node: Useful balance reports103108 -Ref: #useful-balance-reports103289 -Node: Budget report104374 -Ref: #budget-report104558 -Node: Budget report start date109833 -Ref: #budget-report-start-date110011 -Node: Budgets and subaccounts111343 -Ref: #budgets-and-subaccounts111550 -Node: Selecting budget goals114990 -Ref: #selecting-budget-goals115162 -Node: Customising single-period balance reports116196 -Ref: #customising-single-period-balance-reports116405 -Node: balancesheet118580 -Ref: #balancesheet118718 -Node: balancesheetequity120017 -Ref: #balancesheetequity120168 -Node: cashflow121548 -Ref: #cashflow121672 -Node: check122818 -Ref: #check122923 -Node: Basic checks123557 -Ref: #basic-checks123675 -Node: Strict checks124226 -Ref: #strict-checks124367 -Node: Other checks124803 -Ref: #other-checks124943 -Node: Custom checks125300 -Ref: #custom-checks125420 -Node: close125837 -Ref: #close125941 -Node: close and prices128032 -Ref: #close-and-prices128161 -Node: close date128556 -Ref: #close-date128740 -Node: Example close asset/liability accounts for file transition129497 -Ref: #example-close-assetliability-accounts-for-file-transition129798 -Node: Hiding opening/closing transactions130657 -Ref: #hiding-openingclosing-transactions130928 -Node: close and balance assertions132305 -Ref: #close-and-balance-assertions132563 -Node: Example close revenue/expense accounts to retained earnings133917 -Ref: #example-close-revenueexpense-accounts-to-retained-earnings134195 -Node: codes135085 -Ref: #codes135195 -Node: commodities135907 -Ref: #commodities136036 -Node: descriptions136118 -Ref: #descriptions136248 -Node: diff136552 -Ref: #diff136660 -Node: files137707 -Ref: #files137809 -Node: help137956 -Ref: #help138058 -Node: import138876 -Ref: #import138992 -Node: Deduplication139857 -Ref: #deduplication139982 -Node: Import testing141876 -Ref: #import-testing142041 -Node: Importing balance assignments142529 -Ref: #importing-balance-assignments142735 -Node: Commodity display styles143384 -Ref: #commodity-display-styles143557 -Node: incomestatement143686 -Ref: #incomestatement143821 -Node: notes145126 -Ref: #notes145241 -Node: payees145609 -Ref: #payees145717 -Node: prices146243 -Ref: #prices146351 -Node: print146720 -Ref: #print146832 -Node: print-unique152147 -Ref: #print-unique152275 -Node: register152560 -Ref: #register152689 -Node: Custom register output157135 -Ref: #custom-register-output157266 -Node: register-match158603 -Ref: #register-match158739 -Node: rewrite159090 -Ref: #rewrite159207 -Node: Re-write rules in a file161113 -Ref: #re-write-rules-in-a-file161276 -Node: Diff output format162425 -Ref: #diff-output-format162608 -Node: rewrite vs print --auto163700 -Ref: #rewrite-vs.-print---auto163860 -Node: roi164416 -Ref: #roi164516 -Node: Spaces and special characters in --inv and --pnl166202 -Ref: #spaces-and-special-characters-in---inv-and---pnl166442 -Node: Semantics of --inv and --pnl166930 -Ref: #semantics-of---inv-and---pnl167169 -Node: IRR and TWR explained169019 -Ref: #irr-and-twr-explained169179 -Node: stats172247 -Ref: #stats172348 -Node: tags173728 -Ref: #tags173828 -Node: test174347 -Ref: #test174463 -Node: About add-on commands175210 -Ref: #about-add-on-commands175347 -Node: JOURNAL FORMAT176478 -Ref: #journal-format176606 -Node: Transactions178833 -Ref: #transactions178948 -Node: Dates179962 -Ref: #dates180078 -Node: Simple dates180143 -Ref: #simple-dates180263 -Node: Secondary dates180772 -Ref: #secondary-dates180920 -Node: Posting dates182256 -Ref: #posting-dates182379 -Node: Status183751 -Ref: #status183861 -Node: Code185569 -Ref: #code185681 -Node: Description185913 -Ref: #description186041 -Node: Payee and note186361 -Ref: #payee-and-note186469 -Node: Comments186804 -Ref: #comments186926 -Node: Tags188120 -Ref: #tags-1188231 -Node: Postings189624 -Ref: #postings189748 -Node: Virtual postings190774 -Ref: #virtual-postings190885 -Node: Account names192190 -Ref: #account-names192327 -Node: Amounts192815 -Ref: #amounts192952 -Node: Decimal marks digit group marks193937 -Ref: #decimal-marks-digit-group-marks194114 -Node: Commodity195135 -Ref: #commodity195324 -Node: Directives influencing number parsing and display196276 -Ref: #directives-influencing-number-parsing-and-display196537 -Node: Commodity display style197030 -Ref: #commodity-display-style197238 -Node: Rounding199433 -Ref: #rounding199553 -Node: Transaction prices199965 -Ref: #transaction-prices200131 -Node: Lot prices lot dates202562 -Ref: #lot-prices-lot-dates202745 -Node: Balance assertions203233 -Ref: #balance-assertions203411 -Node: Assertions and ordering204444 -Ref: #assertions-and-ordering204626 -Node: Assertions and included files205326 -Ref: #assertions-and-included-files205563 -Node: Assertions and multiple -f options205896 -Ref: #assertions-and-multiple--f-options206146 -Node: Assertions and commodities206278 -Ref: #assertions-and-commodities206504 -Node: Assertions and prices207661 -Ref: #assertions-and-prices207869 -Node: Assertions and subaccounts208309 -Ref: #assertions-and-subaccounts208532 -Node: Assertions and virtual postings208856 -Ref: #assertions-and-virtual-postings209092 -Node: Assertions and precision209234 -Ref: #assertions-and-precision209421 -Node: Balance assignments209688 -Ref: #balance-assignments209858 -Node: Balance assignments and prices211022 -Ref: #balance-assignments-and-prices211188 -Node: Directives211412 -Ref: #directives211575 -Node: Directives and multiple files216066 -Ref: #directives-and-multiple-files216262 -Node: Comment blocks216954 -Ref: #comment-blocks217131 -Node: Including other files217307 -Ref: #including-other-files217481 -Node: Default year218405 -Ref: #default-year218563 -Node: Declaring payees218970 -Ref: #declaring-payees219141 -Node: Declaring the decimal mark219387 -Ref: #declaring-the-decimal-mark219587 -Node: Declaring commodities219984 -Ref: #declaring-commodities220175 -Node: Commodity error checking222693 -Ref: #commodity-error-checking222843 -Node: Default commodity223100 -Ref: #default-commodity223280 -Node: Declaring market prices224396 -Ref: #declaring-market-prices224585 -Node: Declaring accounts225398 -Ref: #declaring-accounts225578 -Node: Account error checking226780 -Ref: #account-error-checking226946 -Node: Account comments228125 -Ref: #account-comments228309 -Node: Account subdirectives228733 -Ref: #account-subdirectives228918 -Node: Account types229231 -Ref: #account-types229405 -Node: Declaring account types230063 -Ref: #declaring-account-types230242 -Node: Auto-detected account types231296 -Ref: #auto-detected-account-types231483 -Node: Account display order233501 -Ref: #account-display-order233661 -Node: Rewriting accounts234812 -Ref: #rewriting-accounts234991 -Node: Basic aliases235748 -Ref: #basic-aliases235884 -Node: Regex aliases236628 -Ref: #regex-aliases236790 -Node: Combining aliases237509 -Ref: #combining-aliases237692 -Node: Aliases and multiple files238968 -Ref: #aliases-and-multiple-files239167 -Node: end aliases239746 -Ref: #end-aliases239893 -Node: Default parent account240042 -Ref: #default-parent-account240232 -Node: Periodic transactions241116 -Ref: #periodic-transactions241299 -Node: Periodic rule syntax243216 -Ref: #periodic-rule-syntax243416 -Node: Two spaces between period expression and description!244120 -Ref: #two-spaces-between-period-expression-and-description244433 -Node: Forecasting with periodic transactions245117 -Ref: #forecasting-with-periodic-transactions245416 -Node: Budgeting with periodic transactions248187 -Ref: #budgeting-with-periodic-transactions248420 -Node: Auto postings248829 -Ref: #auto-postings248965 -Node: Auto postings and multiple files251144 -Ref: #auto-postings-and-multiple-files251342 -Node: Auto postings and dates251551 -Ref: #auto-postings-and-dates251819 -Node: Auto postings and transaction balancing / inferred amounts / balance assertions251994 -Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions252339 -Node: Auto posting tags252842 -Ref: #auto-posting-tags253051 -Node: CSV FORMAT253687 -Ref: #csv-format253815 -Node: Examples256444 -Ref: #examples256547 -Node: Basic256755 -Ref: #basic256857 -Node: Bank of Ireland257399 -Ref: #bank-of-ireland257536 -Node: Amazon258998 -Ref: #amazon259118 -Node: Paypal260837 -Ref: #paypal260933 -Node: CSV rules268577 -Ref: #csv-rules268695 -Node: skip269028 -Ref: #skip269128 -Node: fields list269503 -Ref: #fields-list269642 -Node: field assignment271145 -Ref: #field-assignment271297 -Node: Field names272332 -Ref: #field-names272472 -Node: date field272852 -Ref: #date-field272972 -Node: date2 field273020 -Ref: #date2-field273163 -Node: status field273219 -Ref: #status-field273364 -Node: code field273413 -Ref: #code-field273560 -Node: description field273605 -Ref: #description-field273767 -Node: comment field273826 -Ref: #comment-field273983 -Node: account field274283 -Ref: #account-field274435 -Node: amount field275010 -Ref: #amount-field275161 -Node: currency field276406 -Ref: #currency-field276561 -Node: balance field276818 -Ref: #balance-field276952 -Node: separator277324 -Ref: #separator277456 -Node: if block277996 -Ref: #if-block278123 -Node: Matching the whole record278524 -Ref: #matching-the-whole-record278701 -Node: Matching individual fields279504 -Ref: #matching-individual-fields279710 -Node: Combining matchers279934 -Ref: #combining-matchers280132 -Node: Rules applied on successful match280445 -Ref: #rules-applied-on-successful-match280638 -Node: if table281292 -Ref: #if-table281413 -Node: end283151 -Ref: #end283265 -Node: date-format283489 -Ref: #date-format283623 -Node: decimal-mark284619 -Ref: #decimal-mark284766 -Node: newest-first285105 -Ref: #newest-first285248 -Node: include285931 -Ref: #include286064 -Node: balance-type286508 -Ref: #balance-type286630 -Node: Tips287330 -Ref: #tips287421 -Node: Rapid feedback287720 -Ref: #rapid-feedback287839 -Node: Valid CSV288291 -Ref: #valid-csv288423 -Node: File Extension288615 -Ref: #file-extension288769 -Node: Reading multiple CSV files289198 -Ref: #reading-multiple-csv-files289385 -Node: Valid transactions289626 -Ref: #valid-transactions289806 -Node: Deduplicating importing290434 -Ref: #deduplicating-importing290615 -Node: Setting amounts291648 -Ref: #setting-amounts291805 -Node: Amount signs294246 -Ref: #amount-signs294400 -Node: Setting currency/commodity295087 -Ref: #setting-currencycommodity295275 -Node: Amount decimal places296449 -Ref: #amount-decimal-places296641 -Node: Referencing other fields296953 -Ref: #referencing-other-fields297152 -Node: How CSV rules are evaluated298049 -Ref: #how-csv-rules-are-evaluated298224 -Node: TIMECLOCK FORMAT299675 -Ref: #timeclock-format299815 -Node: TIMEDOT FORMAT301876 -Ref: #timedot-format302014 -Node: COMMON TASKS306576 -Ref: #common-tasks306705 -Node: Getting help307112 -Ref: #getting-help307246 -Node: Constructing command lines307799 -Ref: #constructing-command-lines307993 -Node: Starting a journal file308690 -Ref: #starting-a-journal-file308890 -Node: Setting opening balances310078 -Ref: #setting-opening-balances310276 -Node: Recording transactions313417 -Ref: #recording-transactions313599 -Node: Reconciling314155 -Ref: #reconciling314300 -Node: Reporting316557 -Ref: #reporting316699 -Node: Migrating to a new file320698 -Ref: #migrating-to-a-new-file320848 -Node: LIMITATIONS321147 -Ref: #limitations321275 -Node: TROUBLESHOOTING322018 -Ref: #troubleshooting322133 +Node: balance features80077 +Ref: #balance-features80217 +Node: Simple balance report82141 +Ref: #simple-balance-report82323 +Node: Filtered balance report83803 +Ref: #filtered-balance-report83990 +Node: List or tree mode84317 +Ref: #list-or-tree-mode84485 +Node: Depth limiting85830 +Ref: #depth-limiting85996 +Node: Dropping top-level accounts86597 +Ref: #dropping-top-level-accounts86799 +Node: Multi-period balance report87109 +Ref: #multi-period-balance-report87322 +Node: Showing declared accounts89597 +Ref: #showing-declared-accounts89795 +Node: Commodity layout90326 +Ref: #commodity-layout90496 +Node: Sorting by amount95837 +Ref: #sorting-by-amount95997 +Node: Percentages96667 +Ref: #percentages96825 +Node: Balance change end balance97786 +Ref: #balance-change-end-balance97979 +Node: Balance report types99407 +Ref: #balance-report-types99597 +Node: Useful balance reports103876 +Ref: #useful-balance-reports104057 +Node: Budget report105142 +Ref: #budget-report105326 +Node: Budget report start date110601 +Ref: #budget-report-start-date110779 +Node: Budgets and subaccounts112111 +Ref: #budgets-and-subaccounts112318 +Node: Selecting budget goals115758 +Ref: #selecting-budget-goals115930 +Node: Customising single-period balance reports116964 +Ref: #customising-single-period-balance-reports117173 +Node: balancesheet119348 +Ref: #balancesheet119486 +Node: balancesheetequity120785 +Ref: #balancesheetequity120936 +Node: cashflow122316 +Ref: #cashflow122440 +Node: check123586 +Ref: #check123691 +Node: Basic checks124325 +Ref: #basic-checks124443 +Node: Strict checks124994 +Ref: #strict-checks125135 +Node: Other checks125571 +Ref: #other-checks125711 +Node: Custom checks126068 +Ref: #custom-checks126188 +Node: close126605 +Ref: #close126709 +Node: close and prices128800 +Ref: #close-and-prices128929 +Node: close date129324 +Ref: #close-date129508 +Node: Example close asset/liability accounts for file transition130265 +Ref: #example-close-assetliability-accounts-for-file-transition130566 +Node: Hiding opening/closing transactions131425 +Ref: #hiding-openingclosing-transactions131696 +Node: close and balance assertions133073 +Ref: #close-and-balance-assertions133331 +Node: Example close revenue/expense accounts to retained earnings134685 +Ref: #example-close-revenueexpense-accounts-to-retained-earnings134963 +Node: codes135853 +Ref: #codes135963 +Node: commodities136675 +Ref: #commodities136804 +Node: descriptions136886 +Ref: #descriptions137016 +Node: diff137320 +Ref: #diff137428 +Node: files138475 +Ref: #files138577 +Node: help138724 +Ref: #help138826 +Node: import139644 +Ref: #import139760 +Node: Deduplication140625 +Ref: #deduplication140750 +Node: Import testing142644 +Ref: #import-testing142809 +Node: Importing balance assignments143297 +Ref: #importing-balance-assignments143503 +Node: Commodity display styles144152 +Ref: #commodity-display-styles144325 +Node: incomestatement144454 +Ref: #incomestatement144589 +Node: notes145894 +Ref: #notes146009 +Node: payees146377 +Ref: #payees146485 +Node: prices147011 +Ref: #prices147119 +Node: print147488 +Ref: #print147600 +Node: print-unique152915 +Ref: #print-unique153043 +Node: register153328 +Ref: #register153457 +Node: Custom register output157903 +Ref: #custom-register-output158034 +Node: register-match159371 +Ref: #register-match159507 +Node: rewrite159858 +Ref: #rewrite159975 +Node: Re-write rules in a file161881 +Ref: #re-write-rules-in-a-file162044 +Node: Diff output format163193 +Ref: #diff-output-format163376 +Node: rewrite vs print --auto164468 +Ref: #rewrite-vs.-print---auto164628 +Node: roi165184 +Ref: #roi165284 +Node: Spaces and special characters in --inv and --pnl166970 +Ref: #spaces-and-special-characters-in---inv-and---pnl167210 +Node: Semantics of --inv and --pnl167698 +Ref: #semantics-of---inv-and---pnl167937 +Node: IRR and TWR explained169787 +Ref: #irr-and-twr-explained169947 +Node: stats173015 +Ref: #stats173116 +Node: tags174496 +Ref: #tags174596 +Node: test175115 +Ref: #test175231 +Node: About add-on commands175978 +Ref: #about-add-on-commands176115 +Node: JOURNAL FORMAT177246 +Ref: #journal-format177374 +Node: Transactions179601 +Ref: #transactions179716 +Node: Dates180730 +Ref: #dates180846 +Node: Simple dates180911 +Ref: #simple-dates181031 +Node: Secondary dates181540 +Ref: #secondary-dates181688 +Node: Posting dates183024 +Ref: #posting-dates183147 +Node: Status184519 +Ref: #status184629 +Node: Code186337 +Ref: #code186449 +Node: Description186681 +Ref: #description186809 +Node: Payee and note187129 +Ref: #payee-and-note187237 +Node: Comments187572 +Ref: #comments187694 +Node: Tags188888 +Ref: #tags-1188999 +Node: Postings190392 +Ref: #postings190516 +Node: Virtual postings191542 +Ref: #virtual-postings191653 +Node: Account names192958 +Ref: #account-names193095 +Node: Amounts193583 +Ref: #amounts193720 +Node: Decimal marks digit group marks194705 +Ref: #decimal-marks-digit-group-marks194882 +Node: Commodity195903 +Ref: #commodity196092 +Node: Directives influencing number parsing and display197044 +Ref: #directives-influencing-number-parsing-and-display197305 +Node: Commodity display style197798 +Ref: #commodity-display-style198006 +Node: Rounding200201 +Ref: #rounding200321 +Node: Transaction prices200733 +Ref: #transaction-prices200899 +Node: Lot prices lot dates203330 +Ref: #lot-prices-lot-dates203513 +Node: Balance assertions204001 +Ref: #balance-assertions204179 +Node: Assertions and ordering205212 +Ref: #assertions-and-ordering205394 +Node: Assertions and included files206094 +Ref: #assertions-and-included-files206331 +Node: Assertions and multiple -f options206664 +Ref: #assertions-and-multiple--f-options206914 +Node: Assertions and commodities207046 +Ref: #assertions-and-commodities207272 +Node: Assertions and prices208429 +Ref: #assertions-and-prices208637 +Node: Assertions and subaccounts209077 +Ref: #assertions-and-subaccounts209300 +Node: Assertions and virtual postings209624 +Ref: #assertions-and-virtual-postings209860 +Node: Assertions and precision210002 +Ref: #assertions-and-precision210189 +Node: Balance assignments210456 +Ref: #balance-assignments210626 +Node: Balance assignments and prices211790 +Ref: #balance-assignments-and-prices211956 +Node: Directives212180 +Ref: #directives212343 +Node: Directives and multiple files216835 +Ref: #directives-and-multiple-files217031 +Node: Comment blocks217723 +Ref: #comment-blocks217900 +Node: Including other files218076 +Ref: #including-other-files218250 +Node: Default year219174 +Ref: #default-year219332 +Node: Declaring payees219739 +Ref: #declaring-payees219910 +Node: Declaring the decimal mark220156 +Ref: #declaring-the-decimal-mark220356 +Node: Declaring commodities220753 +Ref: #declaring-commodities220944 +Node: Commodity error checking223462 +Ref: #commodity-error-checking223612 +Node: Default commodity223869 +Ref: #default-commodity224049 +Node: Declaring market prices225165 +Ref: #declaring-market-prices225354 +Node: Declaring accounts226167 +Ref: #declaring-accounts226347 +Node: Account error checking227549 +Ref: #account-error-checking227715 +Node: Account comments228894 +Ref: #account-comments229078 +Node: Account subdirectives229502 +Ref: #account-subdirectives229687 +Node: Account types230000 +Ref: #account-types230174 +Node: Auto-detected account types231497 +Ref: #auto-detected-account-types231652 +Node: Account display order232887 +Ref: #account-display-order233047 +Node: Rewriting accounts234198 +Ref: #rewriting-accounts234377 +Node: Basic aliases235134 +Ref: #basic-aliases235270 +Node: Regex aliases236014 +Ref: #regex-aliases236176 +Node: Combining aliases236895 +Ref: #combining-aliases237078 +Node: Aliases and multiple files238354 +Ref: #aliases-and-multiple-files238553 +Node: end aliases239132 +Ref: #end-aliases239279 +Node: Default parent account239428 +Ref: #default-parent-account239618 +Node: Periodic transactions240502 +Ref: #periodic-transactions240685 +Node: Periodic rule syntax242602 +Ref: #periodic-rule-syntax242802 +Node: Two spaces between period expression and description!243506 +Ref: #two-spaces-between-period-expression-and-description243819 +Node: Forecasting with periodic transactions244503 +Ref: #forecasting-with-periodic-transactions244802 +Node: Budgeting with periodic transactions247573 +Ref: #budgeting-with-periodic-transactions247806 +Node: Auto postings248215 +Ref: #auto-postings248351 +Node: Auto postings and multiple files250530 +Ref: #auto-postings-and-multiple-files250728 +Node: Auto postings and dates250937 +Ref: #auto-postings-and-dates251205 +Node: Auto postings and transaction balancing / inferred amounts / balance assertions251380 +Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions251725 +Node: Auto posting tags252228 +Ref: #auto-posting-tags252437 +Node: CSV FORMAT253073 +Ref: #csv-format253201 +Node: Examples255830 +Ref: #examples255933 +Node: Basic256141 +Ref: #basic256243 +Node: Bank of Ireland256785 +Ref: #bank-of-ireland256922 +Node: Amazon258384 +Ref: #amazon258504 +Node: Paypal260223 +Ref: #paypal260319 +Node: CSV rules267963 +Ref: #csv-rules268081 +Node: skip268414 +Ref: #skip268514 +Node: fields list268889 +Ref: #fields-list269028 +Node: field assignment270531 +Ref: #field-assignment270683 +Node: Field names271718 +Ref: #field-names271858 +Node: date field272238 +Ref: #date-field272358 +Node: date2 field272406 +Ref: #date2-field272549 +Node: status field272605 +Ref: #status-field272750 +Node: code field272799 +Ref: #code-field272946 +Node: description field272991 +Ref: #description-field273153 +Node: comment field273212 +Ref: #comment-field273369 +Node: account field273669 +Ref: #account-field273821 +Node: amount field274396 +Ref: #amount-field274547 +Node: currency field275792 +Ref: #currency-field275947 +Node: balance field276204 +Ref: #balance-field276338 +Node: separator276710 +Ref: #separator276842 +Node: if block277382 +Ref: #if-block277509 +Node: Matching the whole record277910 +Ref: #matching-the-whole-record278087 +Node: Matching individual fields278890 +Ref: #matching-individual-fields279096 +Node: Combining matchers279320 +Ref: #combining-matchers279518 +Node: Rules applied on successful match279831 +Ref: #rules-applied-on-successful-match280024 +Node: if table280678 +Ref: #if-table280799 +Node: end282537 +Ref: #end282651 +Node: date-format282875 +Ref: #date-format283009 +Node: decimal-mark284005 +Ref: #decimal-mark284152 +Node: newest-first284491 +Ref: #newest-first284634 +Node: include285317 +Ref: #include285450 +Node: balance-type285894 +Ref: #balance-type286016 +Node: Tips286716 +Ref: #tips286807 +Node: Rapid feedback287106 +Ref: #rapid-feedback287225 +Node: Valid CSV287677 +Ref: #valid-csv287809 +Node: File Extension288001 +Ref: #file-extension288155 +Node: Reading multiple CSV files288584 +Ref: #reading-multiple-csv-files288771 +Node: Valid transactions289012 +Ref: #valid-transactions289192 +Node: Deduplicating importing289820 +Ref: #deduplicating-importing290001 +Node: Setting amounts291034 +Ref: #setting-amounts291191 +Node: Amount signs293632 +Ref: #amount-signs293786 +Node: Setting currency/commodity294473 +Ref: #setting-currencycommodity294661 +Node: Amount decimal places295835 +Ref: #amount-decimal-places296027 +Node: Referencing other fields296339 +Ref: #referencing-other-fields296538 +Node: How CSV rules are evaluated297435 +Ref: #how-csv-rules-are-evaluated297610 +Node: TIMECLOCK FORMAT299061 +Ref: #timeclock-format299201 +Node: TIMEDOT FORMAT301262 +Ref: #timedot-format301400 +Node: COMMON TASKS305962 +Ref: #common-tasks306091 +Node: Getting help306498 +Ref: #getting-help306632 +Node: Constructing command lines307185 +Ref: #constructing-command-lines307379 +Node: Starting a journal file308076 +Ref: #starting-a-journal-file308276 +Node: Setting opening balances309464 +Ref: #setting-opening-balances309662 +Node: Recording transactions312803 +Ref: #recording-transactions312985 +Node: Reconciling313541 +Ref: #reconciling313686 +Node: Reporting315943 +Ref: #reporting316085 +Node: Migrating to a new file320084 +Ref: #migrating-to-a-new-file320234 +Node: LIMITATIONS320533 +Ref: #limitations320661 +Node: TROUBLESHOOTING321404 +Ref: #troubleshooting321519  End Tag Table diff --git a/hledger/hledger.txt b/hledger/hledger.txt index 8c36cad1b..fb45b1ac4 100644 --- a/hledger/hledger.txt +++ b/hledger/hledger.txt @@ -2161,6 +2161,19 @@ COMMANDS 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 + 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 + 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 + accounts yet. + Commodity layout With --layout, you can control how amounts with more than one commodity are displayed: @@ -2412,6 +2425,7 @@ COMMANDS 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 @@ -4902,7 +4916,7 @@ JOURNAL FORMAT file end? ---------------------------------------------------------------------------------- - account Declare an account, for checking all entries in all files; + 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 @@ -4910,6 +4924,8 @@ JOURNAL FORMAT 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 or end comment. commod- Declares a commodity, for checking all entries in all files; N, Y @@ -4928,8 +4944,6 @@ JOURNAL FORMAT 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 valuation reports. Y Declares a year for yearless dates, for following entries Y @@ -5242,53 +5256,50 @@ JOURNAL FORMAT [LEDGER-STYLE SUBDIRECTIVES, IGNORED] Account types - hledger recognises five main types of account, corresponding to the - account classes in the accounting equation: + By adding a type tag to the account directive, with value A, L, E, R, + X, C (or if you prefer: Asset, Liability, Equity, Revenue, Expense, + Cash), you can declare hledger accounts to be of a certain type: - Asset, Liability, Equity, Revenue, Expense. + o asset, liability, equity, revenue, expense + the standard types in accounting, or - These account types are important for controlling which accounts appear - in the balancesheet, balancesheetequity, incomestatement reports (and - probably for other things in future). + o cash + a subtype of asset, used for liquid assets. - Additionally, we recognise the Cash type, which is also an Asset, and - which causes accounts to appear in the cashflow report. ("Cash" here - means liquid assets, eg bank balances but typically not investments or - receivables.) + Declaring account types is a good idea, since it helps enable the easy + balancesheet, balancesheetequity, incomestatement and cashflow reports, + and probably other things in future. As a convenience, when account + types are not declared, hledger will try to guess them based on + english-language account names. - Declaring account types - To make the balancesheet/balancesheetequity/cashflow/incomestatement - reports work, generally you should declare your top-level accounts, and - their types. For each top-level account, write an account directive, - with a type: tag. The tag's value can be any of Asset, Liability, - Equity, Revenue, Expense, Cash, or (for short) A, L, E, R, X, C (case - insensitive). An account's type is inherited by its subaccounts, - unless they declare a different type. Here's an example, declaring all - six account types: + Here is a typical set of top-level account declarations (because of the + aforementioned, with these account names the type tags are not strictly + needed, but with non-english or non-standard account names, they will + be): - account assets ; type: Asset - account assets:bank ; type: Cash - account assets:cash ; type: Cash - account liabilities ; type: Liability - account equity ; type: Equity - account revenues ; type: Revenue - account expenses ; type: Expense + account assets ; type: A + account liabilities ; type: L + account equity ; type: E + account revenues ; type: R + account expenses ; type: X - There is also an older syntax, which is deprecated and will be dropped - soon (A, L, E, R or X separated from the account name by two or more - spaces): + account assets:bank ; type: C + account assets:cash ; type: C - account assets A - account liabilities L - account equity E - account revenues R - account expenses X + It's not necessary to declare the type of subaccounts. (You can, if + they are different from the parent, but this is not common.) Auto-detected account types - hledger tries to find at least one top level account in each of the six - account types (Asset, Liability, Equity, Revenue, Expense, Cash). When - no accounts have been declared for a particular type, hledger tries to - auto-detect some accounts by name, using regular expressions: + More about "guessing" account types: hledger tries to find at least one + top level account in each of the six account types (Asset, Liability, + Equity, Revenue, Expense, Cash). When no accounts have been declared + for a particular type, it tries to auto-detect some accounts by name, + using the regular expressions below. Note: if you declare any + account's type, it's a good idea to declare an account for all six + types, because a mix of declared and auto-detected types can cause con- + fusing results. + + The auto-detection rules are: If account's name matches this case insensitive regular expression:| its type is: ------------------------------------------------------------------- | ------------ @@ -5300,34 +5311,6 @@ JOURNAL FORMAT ^(income|revenue)s?(:|$) | Revenue ^expenses?(:|$) | Expense - For people using standard english account names, this feature helps - hledger's high-level reports work out of the box with minimal configu- - ration. - - If you use non-english account names, you should declare account types - to make these reports work. And more generally, declaring accounts and - types is usually a good idea, for increased clarity and predictability - (and for the other benefits of account directives: error checking, dis- - play order, etc). - - Notes: - - o When any account is declared as some type, this disables auto-detec- - tion for that particular type. - - o If you declare any account's type, it's a good idea to declare an - account for all six types, since a mix of declared and auto-detected - types can cause confusion. For example, here liabilities is declared - to be Equity, but would also be auto-detected as Liability, since no - Liability account is declared: - - account liabilities ; type:Equity - - 2020-01-01 - assets 1 - liabilities 1 - equity -2 - Account display order Account directives also set the order in which accounts are displayed, eg in reports, the hledger-ui accounts screen, and the hledger-web @@ -5826,8 +5809,6 @@ CSV FORMAT skip skip one or more header lines or matched CSV records - - fields list name CSV fields, assign them to hledger fields field assignment assign a value to one hledger field, with