;doc: regen manuals

[ci skip]

hledger-lib/hledger_csv.info

@@ -6,10 +6,12 @@ File: hledger_csv.info,  Node: Top,  Next: EXAMPLES,  Up: (dir)
 hledger_csv(5) hledger 1.16.99
 ******************************
 
-hledger can read CSV (Comma Separated Value/Character Separated Value)
+CSV - how hledger reads CSV data, and the CSV rules file format
-files as if they were journal files, automatically converting each CSV
+
-record into a transaction.  (To learn about _writing_ CSV, see CSV
+   hledger can read CSV (Comma Separated Value/Character Separated
-output.)
+Value) files 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
@@ -966,64 +968,64 @@ command the user specified.
 
 Tag Table:
 Node: Top72
-Node: EXAMPLES2031
+Node: EXAMPLES2099
-Ref: #examples2137
+Ref: #examples2205
-Node: Basic2345
+Node: Basic2413
-Ref: #basic2445
+Ref: #basic2513
-Node: Bank of Ireland2987
+Node: Bank of Ireland3055
-Ref: #bank-of-ireland3122
+Ref: #bank-of-ireland3190
-Node: Amazon4585
+Node: Amazon4653
-Ref: #amazon4703
+Ref: #amazon4771
-Node: Paypal6636
+Node: Paypal6704
-Ref: #paypal6730
+Ref: #paypal6798
-Node: CSV RULES14613
+Node: CSV RULES14681
-Ref: #csv-rules14722
+Ref: #csv-rules14790
-Node: skip14998
+Node: skip15066
-Ref: #skip15091
+Ref: #skip15159
-Node: fields15466
+Node: fields15534
-Ref: #fields15588
+Ref: #fields15656
-Node: Transaction field names16753
+Node: Transaction field names16821
-Ref: #transaction-field-names16913
+Ref: #transaction-field-names16981
-Node: Posting field names17024
+Node: Posting field names17092
-Ref: #posting-field-names17176
+Ref: #posting-field-names17244
-Node: field assignment18467
+Node: field assignment18535
-Ref: #field-assignment18610
+Ref: #field-assignment18678
-Node: separator19428
+Node: separator19496
-Ref: #separator19557
+Ref: #separator19625
-Node: if19968
+Node: if20036
-Ref: #if20070
+Ref: #if20138
-Node: end21786
+Node: end21854
-Ref: #end21892
+Ref: #end21960
-Node: date-format22116
+Node: date-format22184
-Ref: #date-format22248
+Ref: #date-format22316
-Node: newest-first22997
+Node: newest-first23065
-Ref: #newest-first23135
+Ref: #newest-first23203
-Node: include23818
+Node: include23886
-Ref: #include23947
+Ref: #include24015
-Node: balance-type24391
+Node: balance-type24459
-Ref: #balance-type24511
+Ref: #balance-type24579
-Node: TIPS25211
+Node: TIPS25279
-Ref: #tips25293
+Ref: #tips25361
-Node: Rapid feedback25549
+Node: Rapid feedback25617
-Ref: #rapid-feedback25666
+Ref: #rapid-feedback25734
-Node: Valid CSV26126
+Node: Valid CSV26194
-Ref: #valid-csv26256
+Ref: #valid-csv26324
-Node: File Extension26448
+Node: File Extension26516
-Ref: #file-extension26600
+Ref: #file-extension26668
-Node: Reading multiple CSV files27010
+Node: Reading multiple CSV files27078
-Ref: #reading-multiple-csv-files27195
+Ref: #reading-multiple-csv-files27263
-Node: Valid transactions27436
+Node: Valid transactions27504
-Ref: #valid-transactions27614
+Ref: #valid-transactions27682
-Node: Deduplicating importing28242
+Node: Deduplicating importing28310
-Ref: #deduplicating-importing28421
+Ref: #deduplicating-importing28489
-Node: Setting amounts29454
+Node: Setting amounts29522
-Ref: #setting-amounts29623
+Ref: #setting-amounts29691
-Node: Setting currency/commodity30609
+Node: Setting currency/commodity30677
-Ref: #setting-currencycommodity30801
+Ref: #setting-currencycommodity30869
-Node: Referencing other fields31604
+Node: Referencing other fields31672
-Ref: #referencing-other-fields31804
+Ref: #referencing-other-fields31872
-Node: How CSV rules are evaluated32701
+Node: How CSV rules are evaluated32769
-Ref: #how-csv-rules-are-evaluated32874
+Ref: #how-csv-rules-are-evaluated32942
 
 End Tag Table
 

hledger-lib/hledger_journal.info

@@ -7,7 +7,9 @@ File: hledger_journal.info,  Node: Top,  Next: FILE FORMAT,  Up: (dir)
 hledger_journal(5) hledger 1.16.99
 **********************************
 
-hledger's usual data source is a plain text file containing journal
+Journal - 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
 that's not required.  The journal file contains a number of transaction
@@ -1752,120 +1754,120 @@ See the Editor configuration at hledger.org for the latest information.
 
 Tag Table:
 Node: Top76
-Node: FILE FORMAT2358
+Node: FILE FORMAT2434
-Ref: #file-format2482
+Ref: #file-format2558
-Node: Transactions2785
+Node: Transactions2861
-Ref: #transactions2906
+Ref: #transactions2982
-Node: Postings3590
+Node: Postings3666
-Ref: #postings3717
+Ref: #postings3793
-Node: Dates4712
+Node: Dates4788
-Ref: #dates4827
+Ref: #dates4903
-Node: Simple dates4892
+Node: Simple dates4968
-Ref: #simple-dates5018
+Ref: #simple-dates5094
-Node: Secondary dates5384
+Node: Secondary dates5460
-Ref: #secondary-dates5538
+Ref: #secondary-dates5614
-Node: Posting dates7101
+Node: Posting dates7177
-Ref: #posting-dates7230
+Ref: #posting-dates7306
-Node: Status8602
+Node: Status8678
-Ref: #status8722
+Ref: #status8798
-Node: Description10430
+Node: Description10506
-Ref: #description10568
+Ref: #description10644
-Node: Payee and note10888
+Node: Payee and note10964
-Ref: #payee-and-note11002
+Ref: #payee-and-note11078
-Node: Account names11337
+Node: Account names11413
-Ref: #account-names11480
+Ref: #account-names11556
-Node: Amounts11967
+Node: Amounts12043
-Ref: #amounts12103
+Ref: #amounts12179
-Node: Digit group marks13036
+Node: Digit group marks13112
-Ref: #digit-group-marks13185
+Ref: #digit-group-marks13261
-Node: Amount display format14123
+Node: Amount display format14199
-Ref: #amount-display-format14280
+Ref: #amount-display-format14356
-Node: Virtual Postings15305
+Node: Virtual Postings15381
-Ref: #virtual-postings15464
+Ref: #virtual-postings15540
-Node: Balance Assertions16684
+Node: Balance Assertions16760
-Ref: #balance-assertions16859
+Ref: #balance-assertions16935
-Node: Assertions and ordering17892
+Node: Assertions and ordering17968
-Ref: #assertions-and-ordering18078
+Ref: #assertions-and-ordering18154
-Node: Assertions and included files18778
+Node: Assertions and included files18854
-Ref: #assertions-and-included-files19019
+Ref: #assertions-and-included-files19095
-Node: Assertions and multiple -f options19352
+Node: Assertions and multiple -f options19428
-Ref: #assertions-and-multiple--f-options19606
+Ref: #assertions-and-multiple--f-options19682
-Node: Assertions and commodities19738
+Node: Assertions and commodities19814
-Ref: #assertions-and-commodities19968
+Ref: #assertions-and-commodities20044
-Node: Assertions and prices21124
+Node: Assertions and prices21200
-Ref: #assertions-and-prices21336
+Ref: #assertions-and-prices21412
-Node: Assertions and subaccounts21776
+Node: Assertions and subaccounts21852
-Ref: #assertions-and-subaccounts22003
+Ref: #assertions-and-subaccounts22079
-Node: Assertions and virtual postings22327
+Node: Assertions and virtual postings22403
-Ref: #assertions-and-virtual-postings22567
+Ref: #assertions-and-virtual-postings22643
-Node: Assertions and precision22709
+Node: Assertions and precision22785
-Ref: #assertions-and-precision22900
+Ref: #assertions-and-precision22976
-Node: Balance Assignments23167
+Node: Balance Assignments23243
-Ref: #balance-assignments23348
+Ref: #balance-assignments23424
-Node: Balance assignments and prices24513
+Node: Balance assignments and prices24589
-Ref: #balance-assignments-and-prices24685
+Ref: #balance-assignments-and-prices24761
-Node: Transaction prices24909
+Node: Transaction prices24985
-Ref: #transaction-prices25078
+Ref: #transaction-prices25154
-Node: Comments27344
+Node: Comments27420
-Ref: #comments27478
+Ref: #comments27554
-Node: Tags28648
+Node: Tags28724
-Ref: #tags28766
+Ref: #tags28842
-Node: Directives30159
+Node: Directives30235
-Ref: #directives30302
+Ref: #directives30378
-Node: Comment blocks35981
+Node: Comment blocks36057
-Ref: #comment-blocks36126
+Ref: #comment-blocks36202
-Node: Including other files36302
+Node: Including other files36378
-Ref: #including-other-files36482
+Ref: #including-other-files36558
-Node: Default year36890
+Node: Default year36966
-Ref: #default-year37059
+Ref: #default-year37135
-Node: Declaring commodities37466
+Node: Declaring commodities37542
-Ref: #declaring-commodities37649
+Ref: #declaring-commodities37725
-Node: Default commodity39310
+Node: Default commodity39386
-Ref: #default-commodity39486
+Ref: #default-commodity39562
-Node: Market prices40120
+Node: Market prices40196
-Ref: #market-prices40285
+Ref: #market-prices40361
-Node: Declaring accounts41126
+Node: Declaring accounts41202
-Ref: #declaring-accounts41302
+Ref: #declaring-accounts41378
-Node: Account comments42227
+Node: Account comments42303
-Ref: #account-comments42390
+Ref: #account-comments42466
-Node: Account subdirectives42814
+Node: Account subdirectives42890
-Ref: #account-subdirectives43009
+Ref: #account-subdirectives43085
-Node: Account types43322
+Node: Account types43398
-Ref: #account-types43506
+Ref: #account-types43582
-Node: Account display order45148
+Node: Account display order45224
-Ref: #account-display-order45318
+Ref: #account-display-order45394
-Node: Rewriting accounts46447
+Node: Rewriting accounts46523
-Ref: #rewriting-accounts46632
+Ref: #rewriting-accounts46708
-Node: Basic aliases47358
+Node: Basic aliases47434
-Ref: #basic-aliases47504
+Ref: #basic-aliases47580
-Node: Regex aliases48208
+Node: Regex aliases48284
-Ref: #regex-aliases48380
+Ref: #regex-aliases48456
-Node: Combining aliases49098
+Node: Combining aliases49174
-Ref: #combining-aliases49276
+Ref: #combining-aliases49352
-Node: end aliases50552
+Node: end aliases50628
-Ref: #end-aliases50700
+Ref: #end-aliases50776
-Node: Default parent account50801
+Node: Default parent account50877
-Ref: #default-parent-account50967
+Ref: #default-parent-account51043
-Node: Periodic transactions51851
+Node: Periodic transactions51927
-Ref: #periodic-transactions52049
+Ref: #periodic-transactions52125
-Node: Periodic rule syntax53921
+Node: Periodic rule syntax53997
-Ref: #periodic-rule-syntax54127
+Ref: #periodic-rule-syntax54203
-Node: Two spaces between period expression and description!54831
+Node: Two spaces between period expression and description!54907
-Ref: #two-spaces-between-period-expression-and-description55150
+Ref: #two-spaces-between-period-expression-and-description55226
-Node: Forecasting with periodic transactions55834
+Node: Forecasting with periodic transactions55910
-Ref: #forecasting-with-periodic-transactions56139
+Ref: #forecasting-with-periodic-transactions56215
-Node: Budgeting with periodic transactions58165
+Node: Budgeting with periodic transactions58241
-Ref: #budgeting-with-periodic-transactions58404
+Ref: #budgeting-with-periodic-transactions58480
-Node: Auto postings / transaction modifiers58853
+Node: Auto postings / transaction modifiers58929
-Ref: #auto-postings-transaction-modifiers59064
+Ref: #auto-postings-transaction-modifiers59140
-Node: Auto postings and dates61293
+Node: Auto postings and dates61369
-Ref: #auto-postings-and-dates61550
+Ref: #auto-postings-and-dates61626
-Node: Auto postings and transaction balancing / inferred amounts / balance assertions61725
+Node: Auto postings and transaction balancing / inferred amounts / balance assertions61801
-Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions62100
+Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions62176
-Node: Auto posting tags62478
+Node: Auto posting tags62554
-Ref: #auto-posting-tags62717
+Ref: #auto-posting-tags62793
-Node: EDITOR SUPPORT63382
+Node: EDITOR SUPPORT63458
-Ref: #editor-support63500
+Ref: #editor-support63576
 
 End Tag Table
 

hledger-lib/hledger_timeclock.info

@@ -7,12 +7,14 @@ File: hledger_timeclock.info,  Node: Top,  Up: (dir)
 hledger_timeclock(5) hledger 1.16.99
 ************************************
 
-hledger can read timeclock files.  As with Ledger, these are (a subset
+Timeclock - the time logging format of timeclock.el, as read by hledger
-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
+   hledger can read timeclock files.  As with Ledger, these are (a
-HH:MM[:SS][+-ZZZZ]. Seconds and timezone are optional.  The timezone, if
+subset of) timeclock.el's format, containing clock-in and clock-out
-present, must be four digits and is ignored (currently the time is
+entries as in the example below.  The date is a simple date.  The time
-always interpreted as a local 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).
 
 i 2015/03/30 09:00:00 some:account name  optional description after two spaces
 o 2015/03/30 09:20:00

hledger-lib/hledger_timedot.5

@@ -20,7 +20,6 @@ Though called \[dq]timedot\[dq], this format is read by hledger as
 commodityless quantities, so it could be used to represent dated
 quantities other than time.
 In the docs below we\[aq]ll assume it\[aq]s time.
-.SH FILE FORMAT
 .PP
 A timedot file contains a series of day entries.
 A day entry begins with a date, and is followed by category/quantity

hledger-lib/hledger_timedot.info

@@ -2,14 +2,16 @@ This is hledger_timedot.info, produced by makeinfo version 6.7 from
 stdin.
 
 
-File: hledger_timedot.info,  Node: Top,  Next: FILE FORMAT,  Up: (dir)
+File: hledger_timedot.info,  Node: Top,  Up: (dir)
 
 hledger_timedot(5) hledger 1.16.99
 **********************************
 
-Timedot is a plain text format for logging dated, categorised quantities
+Timedot - hledger's human-friendly time logging format
-(of time, usually), supported by hledger.  It is convenient for
+
-approximate and retroactive time logging, eg when the real-time
+   Timedot is a plain text format for logging dated, categorised
+quantities (of time, usually), supported by hledger.  It is convenient
+for approximate and retroactive time logging, eg when the real-time
 clock-in/out required with a timeclock file is too precise or too
 interruptive.  It can be formatted like a bar chart, making clear at a
 glance where time was spent.
@@ -18,17 +20,7 @@ glance where time was spent.
 commodityless quantities, so it could be used to represent dated
 quantities other than time.  In the docs below we'll assume it's time.
 
-* Menu:
+   A timedot file contains a series of day entries.  A day entry begins
-
-* FILE FORMAT::
-
-
-File: hledger_timedot.info,  Node: FILE FORMAT,  Prev: Top,  Up: Top
-
-1 FILE FORMAT
-*************
-
-A timedot file contains a series of day entries.  A day entry begins
 with a date, and is followed by category/quantity pairs, one per line.
 Dates are hledger-style simple dates (see hledger_journal(5)).
 Categories are hledger-style account names, optionally indented.  As in
@@ -111,8 +103,6 @@ $ hledger -f t.timedot --alias /\\./=: bal date:2016/2/4
 
 Tag Table:
 Node: Top76
-Node: FILE FORMAT814
-Ref: #file-format915
 
 End Tag Table
 

hledger-lib/hledger_timedot.txt

@@ -18,7 +18,6 @@ DESCRIPTION
        less  quantities,  so  it  could  be used to represent dated quantities
        other than time.  In the docs below we'll assume it's time.
 
-FILE FORMAT
        A timedot file contains a series of day entries.  A  day  entry  begins
        with  a date, and is followed by category/quantity pairs, one per line.
        Dates are hledger-style simple dates (see  hledger_journal(5)).   Cate-

hledger-ui/hledger-ui.1

@@ -15,9 +15,9 @@ hledger-ui - terminal interface for the hledger accounting tool
 \f[C]hledger ui -- [OPTIONS] [QUERYARGS]\f[R]
 .SH DESCRIPTION
 .PP
-hledger is a cross-platform program for tracking money, time, or any
+hledger is a reliable, cross-platform set of programs for tracking
-other commodity, using double-entry accounting and a simple, editable
+money, time, or any other commodity, using double-entry accounting and a
-file format.
+simple, editable file format.
 hledger is inspired by and largely compatible with ledger(1).
 .PP
 hledger-ui is hledger\[aq]s terminal interface, providing an efficient

hledger-ui/hledger-ui.info

@@ -6,7 +6,17 @@ File: hledger-ui.info,  Node: Top,  Next: OPTIONS,  Up: (dir)
 hledger-ui(1) hledger-ui 1.16.99
 ********************************
 
-hledger-ui is hledger's terminal interface, providing an efficient
+hledger-ui - terminal interface for the hledger accounting tool
+
+   'hledger-ui [OPTIONS] [QUERYARGS]'
+'hledger ui -- [OPTIONS] [QUERYARGS]'
+
+   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-ui is hledger's terminal interface, providing an efficient
 full-window text UI for viewing accounts and transactions, and some
 limited data entry capability.  It is easier than hledger's command-line
 interface, and sometimes quicker and more convenient than the web
@@ -30,6 +40,9 @@ hledger_journal(5) etc.
 * OPTIONS::
 * KEYS::
 * SCREENS::
+* ENVIRONMENT::
+* FILES::
+* BUGS::
 
 
 File: hledger-ui.info,  Node: OPTIONS,  Next: KEYS,  Prev: Top,  Up: Top
@@ -278,7 +291,7 @@ exit the transaction screen.
    Additional screen-specific keys are described below.
 
 
-File: hledger-ui.info,  Node: SCREENS,  Prev: KEYS,  Up: Top
+File: hledger-ui.info,  Node: SCREENS,  Next: ENVIRONMENT,  Prev: KEYS,  Up: Top
 
 3 SCREENS
 *********
@@ -421,23 +434,80 @@ when you press g to reload.  Once you have fixed the problem, press g
 again to reload and resume normal operation.  (Or, you can press escape
 to cancel the reload attempt.)
 
+
+File: hledger-ui.info,  Node: ENVIRONMENT,  Next: FILES,  Prev: SCREENS,  Up: Top
+
+4 ENVIRONMENT
+*************
+
+*COLUMNS* The screen width to use.  Default: the full terminal width.
+
+   *LEDGER_FILE* The journal file path when not specified with '-f'.
+Default: '~/.hledger.journal' (on windows, perhaps
+'C:/Users/USER/.hledger.journal').
+
+
+File: hledger-ui.info,  Node: FILES,  Next: BUGS,  Prev: ENVIRONMENT,  Up: Top
+
+5 FILES
+*******
+
+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').
+
+
+File: hledger-ui.info,  Node: BUGS,  Prev: FILES,  Up: Top
+
+6 BUGS
+******
+
+The need to precede options with '--' when invoked from hledger is
+awkward.
+
+   '-f-' doesn't work (hledger-ui can't read from stdin).
+
+   '-V' affects only the accounts screen.
+
+   When you press 'g', the current and all previous screens are
+regenerated, which may cause a noticeable pause with large files.  Also
+there is no visual indication that this is in progress.
+
+   '--watch' is not yet fully robust.  It works well for normal usage,
+but many file changes in a short time (eg saving the file thousands of
+times with an editor macro) can cause problems at least on OSX. Symptoms
+include: unresponsive UI, periodic resetting of the cursor position,
+momentary display of parse errors, high CPU usage eventually subsiding,
+and possibly a small but persistent build-up of CPU usage until the
+program is restarted.
+
+   Also, if you are viewing files mounted from another machine,
+'--watch' requires that both machine clocks are roughly in step.
+
 
 Tag Table:
 Node: Top71
-Node: OPTIONS1103
+Node: OPTIONS1520
-Ref: #options1200
+Ref: #options1617
-Node: KEYS4636
+Node: KEYS5053
-Ref: #keys4731
+Ref: #keys5148
-Node: SCREENS9038
+Node: SCREENS9455
-Ref: #screens9123
+Ref: #screens9560
-Node: Accounts screen9213
+Node: Accounts screen9650
-Ref: #accounts-screen9341
+Ref: #accounts-screen9778
-Node: Register screen11557
+Node: Register screen11994
-Ref: #register-screen11712
+Ref: #register-screen12149
-Node: Transaction screen13708
+Node: Transaction screen14145
-Ref: #transaction-screen13866
+Ref: #transaction-screen14303
-Node: Error screen14736
+Node: Error screen15173
-Ref: #error-screen14858
+Ref: #error-screen15295
+Node: ENVIRONMENT15539
+Ref: #environment15653
+Node: FILES15880
+Ref: #files15979
+Node: BUGS16192
+Ref: #bugs16269
 
 End Tag Table
 

hledger-ui/hledger-ui.txt

@@ -11,10 +11,10 @@ SYNOPSIS
        hledger ui -- [OPTIONS] [QUERYARGS]
 
 DESCRIPTION
-       hledger  is  a  cross-platform program for tracking money, time, or any
+       hledger  is  a  reliable,  cross-platform  set of programs for tracking
-       other commodity, using double-entry accounting and a  simple,  editable
+       money, time, or any other commodity, using double-entry accounting  and
-       file  format.   hledger  is  inspired  by  and  largely compatible with
+       a  simple,  editable  file  format.  hledger is inspired by and largely
-       ledger(1).
+       compatible with ledger(1).
 
        hledger-ui is hledger's  terminal  interface,  providing  an  efficient
        full-window  text  UI  for  viewing accounts and transactions, and some

hledger-web/hledger-web.1

@@ -15,9 +15,9 @@ hledger-web - web interface for the hledger accounting tool
 \f[C]hledger web -- [OPTIONS]\f[R]
 .SH DESCRIPTION
 .PP
-hledger is a cross-platform program for tracking money, time, or any
+hledger is a reliable, cross-platform set of programs for tracking
-other commodity, using double-entry accounting and a simple, editable
+money, time, or any other commodity, using double-entry accounting and a
-file format.
+simple, editable file format.
 hledger is inspired by and largely compatible with ledger(1).
 .PP
 hledger-web is hledger\[aq]s web interface.

hledger-web/hledger-web.info

@@ -6,7 +6,17 @@ File: hledger-web.info,  Node: Top,  Next: OPTIONS,  Up: (dir)
 hledger-web(1) hledger-web 1.16.99
 **********************************
 
-hledger-web is hledger's web interface.  It starts a simple web
+hledger-web - web interface for the hledger accounting tool
+
+   '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
+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
@@ -33,6 +43,9 @@ hledger_journal(5) etc.
 * EDITING UPLOADING DOWNLOADING::
 * RELOADING::
 * JSON API::
+* ENVIRONMENT::
+* FILES::
+* BUGS::
 
 
 File: hledger-web.info,  Node: OPTIONS,  Next: PERMISSIONS,  Prev: Top,  Up: Top
@@ -311,7 +324,7 @@ file has been fixed.
 sure that both machine clocks are roughly in step.)
 
 
-File: hledger-web.info,  Node: JSON API,  Prev: RELOADING,  Up: Top
+File: hledger-web.info,  Node: JSON API,  Next: ENVIRONMENT,  Prev: RELOADING,  Up: Top
 
 5 JSON API
 **********
@@ -356,19 +369,63 @@ $ curl -s http://127.0.0.1:5000/add -X PUT -H 'Content-Type: application/json' -
 Running with '--serve-api' disables the former, useful if you only want
 to serve the API.
 
+
+File: hledger-web.info,  Node: ENVIRONMENT,  Next: FILES,  Prev: JSON API,  Up: Top
+
+6 ENVIRONMENT
+*************
+
+*LEDGER_FILE* The journal file path when not specified with '-f'.
+Default: '~/.hledger.journal' (on windows, perhaps
+'C:/Users/USER/.hledger.journal').
+
+
+File: hledger-web.info,  Node: FILES,  Next: BUGS,  Prev: ENVIRONMENT,  Up: Top
+
+7 FILES
+*******
+
+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').
+
+
+File: hledger-web.info,  Node: BUGS,  Prev: FILES,  Up: Top
+
+8 BUGS
+******
+
+The need to precede options with '--' when invoked from hledger is
+awkward.
+
+   '-f-' doesn't work (hledger-web can't read from stdin).
+
+   Query arguments and some hledger options are ignored.
+
+   Does not work in text-mode browsers.
+
+   Does not work well on small screens.
+
 
 Tag Table:
 Node: Top72
-Node: OPTIONS1361
+Node: OPTIONS1752
-Ref: #options1466
+Ref: #options1857
-Node: PERMISSIONS7739
+Node: PERMISSIONS8130
-Ref: #permissions7878
+Ref: #permissions8269
-Node: EDITING UPLOADING DOWNLOADING9090
+Node: EDITING UPLOADING DOWNLOADING9481
-Ref: #editing-uploading-downloading9271
+Ref: #editing-uploading-downloading9662
-Node: RELOADING10105
+Node: RELOADING10496
-Ref: #reloading10239
+Ref: #reloading10630
-Node: JSON API10672
+Node: JSON API11063
-Ref: #json-api10766
+Ref: #json-api11177
+Node: ENVIRONMENT12618
+Ref: #environment12734
+Node: FILES12887
+Ref: #files12987
+Node: BUGS13200
+Ref: #bugs13278
 
 End Tag Table
 

hledger-web/hledger-web.txt

@@ -11,10 +11,10 @@ SYNOPSIS
        hledger web -- [OPTIONS]
 
 DESCRIPTION
-       hledger  is  a  cross-platform program for tracking money, time, or any
+       hledger  is  a  reliable,  cross-platform  set of programs for tracking
-       other commodity, using double-entry accounting and a  simple,  editable
+       money, time, or any other commodity, using double-entry accounting  and
-       file  format.   hledger  is  inspired  by  and  largely compatible with
+       a  simple,  editable  file  format.  hledger is inspired by and largely
-       ledger(1).
+       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

hledger/hledger.1

@@ -20,15 +20,10 @@ hledger - a command-line accounting tool
 \f[C]hledger\f[R]
 .SH DESCRIPTION
 .PP
-hledger is a cross-platform program for tracking money, time, or any
+hledger is a reliable, cross-platform set of programs for tracking
-other commodity, using double-entry accounting and a simple, editable
+money, time, or any other commodity, using double-entry accounting and a
-file format.
+simple, editable file format.
 hledger is inspired by and largely compatible with ledger(1).
-.PD 0
-.P
-.PD
-Tested on unix, mac, windows, hledger aims to be a reliable, practical
-tool for daily use.
 .PP
 This is hledger\[cq]s command-line interface (there are also terminal
 and web interfaces).

hledger/hledger.info

@@ -6,7 +6,18 @@ File: hledger.info,  Node: Top,  Next: EXAMPLES,  Up: (dir)
 hledger(1) hledger 1.16.99
 **************************
 
-This is hledger's command-line interface (there are also terminal and
+hledger - a command-line accounting tool
+
+   'hledger [-f FILE] COMMAND [OPTIONS] [ARGS]'
+'hledger [-f FILE] ADDONCMD -- [OPTIONS] [ARGS]'
+'hledger'
+
+   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).
+
+   This is hledger's command-line interface (there are also terminal and
 web interfaces).  Its basic function is to read a plain text file
 describing financial transactions (in accounting terms, a general
 journal) and print useful reports on standard output, or export them as
@@ -48,6 +59,10 @@ try some commands like 'hledger print' or 'hledger balance'.  Run
 * QUERIES::
 * COMMANDS::
 * ADD-ON COMMANDS::
+* ENVIRONMENT::
+* FILES::
+* LIMITATIONS::
+* TROUBLESHOOTING::
 
 
 File: hledger.info,  Node: EXAMPLES,  Next: OPTIONS,  Prev: Top,  Up: Top
@@ -3080,7 +3095,7 @@ $ hledger test -- -pData.Amount --color=never
 ('-- --help' currently doesn't show them).
 
 
-File: hledger.info,  Node: ADD-ON COMMANDS,  Prev: COMMANDS,  Up: Top
+File: hledger.info,  Node: ADD-ON COMMANDS,  Next: ENVIRONMENT,  Prev: COMMANDS,  Up: Top
 
 5 ADD-ON COMMANDS
 *****************
@@ -3213,180 +3228,303 @@ File: hledger.info,  Node: chart,  Prev: autosync,  Up: Experimental add-ons
 
 hledger-chart.hs is an old very basic pie chart generator.
 
+
+File: hledger.info,  Node: ENVIRONMENT,  Next: FILES,  Prev: ADD-ON COMMANDS,  Up: Top
+
+6 ENVIRONMENT
+*************
+
+*COLUMNS* The screen width used by the register command.  Default: the
+full terminal width.
+
+   *LEDGER_FILE* The journal file path when not specified with '-f'.
+Default: '~/.hledger.journal' (on windows, perhaps
+'C:/Users/USER/.hledger.journal').
+
+
+File: hledger.info,  Node: FILES,  Next: LIMITATIONS,  Prev: ENVIRONMENT,  Up: Top
+
+7 FILES
+*******
+
+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').
+
+
+File: hledger.info,  Node: LIMITATIONS,  Next: TROUBLESHOOTING,  Prev: FILES,  Up: Top
+
+8 LIMITATIONS
+*************
+
+The need to precede addon command options with '--' when invoked from
+hledger is awkward.
+
+   When input data contains non-ascii characters, a suitable system
+locale must be configured (or there will be an unhelpful error).  Eg on
+POSIX, set LANG to something other than C.
+
+   In a Microsoft Windows CMD window, non-ascii characters and colours
+are not supported.
+
+   On Windows, non-ascii characters may not display correctly when
+running a hledger built in CMD in MSYS/CYGWIN, or vice-versa.
+
+   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 file
+format differences.
+
+   On large data files, hledger is slower and uses more memory than
+Ledger.
+
+
+File: hledger.info,  Node: TROUBLESHOOTING,  Prev: LIMITATIONS,  Up: Top
+
+9 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
+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,
+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
+need to use 'export'.  Here's an explanation.
+
+   *"Illegal byte sequence" or "Invalid or incomplete multibyte or wide
+character" errors*
+In order to handle non-ascii letters and symbols (like £), hledger needs
+an appropriate locale.  This is usually configured system-wide; you can
+also configure it temporarily.  The locale may need to be one that
+supports UTF-8, if you built hledger with GHC < 7.2 (or possibly always,
+I'm not sure yet).
+
+   Here's an example of setting the locale temporarily, on ubuntu
+gnu/linux:
+
+$ file my.journal
+my.journal: UTF-8 Unicode text                 # <- the file is UTF8-encoded
+$ locale -a
+C
+en_US.utf8                             # <- a UTF8-aware locale is available
+POSIX
+$ LANG=en_US.utf8 hledger -f my.journal print   # <- use it for this command
+
+   Here's one way to set it permanently, there are probably better ways:
+
+$ echo "export LANG=en_US.UTF-8" >>~/.bash_profile
+$ bash --login
+
+   If we preferred to use eg 'fr_FR.utf8', we might have to install that
+first:
+
+$ apt-get install language-pack-fr
+$ locale -a
+C
+en_US.utf8
+fr_BE.utf8
+fr_CA.utf8
+fr_CH.utf8
+fr_FR.utf8
+fr_LU.utf8
+POSIX
+$ LANG=fr_FR.utf8 hledger -f my.journal print
+
+   Note some platforms allow variant locale spellings, but not all
+(ubuntu accepts 'fr_FR.UTF8', mac osx requires exactly 'fr_FR.UTF-8').
+
 
 Tag Table:
 Node: Top68
-Node: EXAMPLES1893
+Node: EXAMPLES2345
-Ref: #examples1993
+Ref: #examples2445
-Node: OPTIONS3639
+Node: OPTIONS4091
-Ref: #options3741
+Ref: #options4193
-Node: General options4140
+Node: General options4592
-Ref: #general-options4265
+Ref: #general-options4717
-Node: Command options6964
+Node: Command options7416
-Ref: #command-options7115
+Ref: #command-options7567
-Node: Command arguments7513
+Node: Command arguments7965
-Ref: #command-arguments7667
+Ref: #command-arguments8119
-Node: Argument files7788
+Node: Argument files8240
-Ref: #argument-files7964
+Ref: #argument-files8416
-Node: Special characters in arguments and queries8720
+Node: Special characters in arguments and queries9172
-Ref: #special-characters-in-arguments-and-queries8954
+Ref: #special-characters-in-arguments-and-queries9406
-Node: More escaping9405
+Node: More escaping9857
-Ref: #more-escaping9567
+Ref: #more-escaping10019
-Node: Even more escaping9863
+Node: Even more escaping10315
-Ref: #even-more-escaping10057
+Ref: #even-more-escaping10509
-Node: Less escaping10728
+Node: Less escaping11180
-Ref: #less-escaping10890
+Ref: #less-escaping11342
-Node: Command line tips11135
+Node: Command line tips11587
-Ref: #command-line-tips11321
+Ref: #command-line-tips11773
-Node: Unicode characters11698
+Node: Unicode characters12150
-Ref: #unicode-characters11854
+Ref: #unicode-characters12306
-Node: Input files13266
+Node: Input files13718
-Ref: #input-files13402
+Ref: #input-files13854
-Node: Smart dates15331
+Node: Smart dates15783
-Ref: #smart-dates15472
+Ref: #smart-dates15924
-Node: Report start & end date16878
+Node: Report start & end date17330
-Ref: #report-start-end-date17050
+Ref: #report-start-end-date17502
-Node: Report intervals18474
+Node: Report intervals18926
-Ref: #report-intervals18639
+Ref: #report-intervals19091
-Node: Period expressions19029
+Node: Period expressions19481
-Ref: #period-expressions19189
+Ref: #period-expressions19641
-Node: Depth limiting23144
+Node: Depth limiting23596
-Ref: #depth-limiting23288
+Ref: #depth-limiting23740
-Node: Pivoting23630
+Node: Pivoting24082
-Ref: #pivoting23753
+Ref: #pivoting24205
-Node: Valuation25429
+Node: Valuation25881
-Ref: #valuation25558
+Ref: #valuation26010
-Node: -B Cost25738
+Node: -B Cost26190
-Ref: #b-cost25849
+Ref: #b-cost26301
-Node: -V Market value26047
+Node: -V Market value26499
-Ref: #v-market-value26221
+Ref: #v-market-value26673
-Node: -X Market value in specified commodity27653
+Node: -X Market value in specified commodity28105
-Ref: #x-market-value-in-specified-commodity27892
+Ref: #x-market-value-in-specified-commodity28344
-Node: --value Flexible valuation28068
+Node: --value Flexible valuation28520
-Ref: #value-flexible-valuation28294
+Ref: #value-flexible-valuation28746
-Node: Effect of --value on reports32484
+Node: Effect of --value on reports32936
-Ref: #effect-of---value-on-reports32700
+Ref: #effect-of---value-on-reports33152
-Node: Combining -B -V -X --value37631
+Node: Combining -B -V -X --value38083
-Ref: #combining--b--v--x---value37814
+Ref: #combining--b--v--x---value38266
-Node: Output destination37850
+Node: Output destination38302
-Ref: #output-destination38002
+Ref: #output-destination38454
-Node: Output format38285
+Node: Output format38737
-Ref: #output-format38437
+Ref: #output-format38889
-Node: Regular expressions38822
+Node: Regular expressions39274
-Ref: #regular-expressions38959
+Ref: #regular-expressions39411
-Node: QUERIES40320
+Node: QUERIES40772
-Ref: #queries40422
+Ref: #queries40874
-Node: COMMANDS44384
+Node: COMMANDS44836
-Ref: #commands44496
+Ref: #commands44948
-Node: accounts45560
+Node: accounts46012
-Ref: #accounts45658
+Ref: #accounts46110
-Node: activity46357
+Node: activity46809
-Ref: #activity46467
+Ref: #activity46919
-Node: add46850
+Node: add47302
-Ref: #add46949
+Ref: #add47401
-Node: balance49688
+Node: balance50140
-Ref: #balance49799
+Ref: #balance50251
-Node: Classic balance report51257
+Node: Classic balance report51709
-Ref: #classic-balance-report51430
+Ref: #classic-balance-report51882
-Node: Customising the classic balance report52799
+Node: Customising the classic balance report53251
-Ref: #customising-the-classic-balance-report53027
+Ref: #customising-the-classic-balance-report53479
-Node: Colour support55103
+Node: Colour support55555
-Ref: #colour-support55270
+Ref: #colour-support55722
-Node: Flat mode55443
+Node: Flat mode55895
-Ref: #flat-mode55591
+Ref: #flat-mode56043
-Node: Depth limited balance reports56004
+Node: Depth limited balance reports56456
-Ref: #depth-limited-balance-reports56189
+Ref: #depth-limited-balance-reports56641
-Node: Percentages56645
+Node: Percentages57097
-Ref: #percentages56811
+Ref: #percentages57263
-Node: Multicolumn balance report57948
+Node: Multicolumn balance report58400
-Ref: #multicolumn-balance-report58128
+Ref: #multicolumn-balance-report58580
-Node: Budget report63442
+Node: Budget report63894
-Ref: #budget-report63585
+Ref: #budget-report64037
-Node: Nested budgets68787
+Node: Nested budgets69239
-Ref: #nested-budgets68899
+Ref: #nested-budgets69351
-Ref: #output-format-172380
+Ref: #output-format-172832
-Node: balancesheet72458
+Node: balancesheet72910
-Ref: #balancesheet72594
+Ref: #balancesheet73046
-Node: balancesheetequity73977
+Node: balancesheetequity74429
-Ref: #balancesheetequity74126
+Ref: #balancesheetequity74578
-Node: cashflow74687
+Node: cashflow75139
-Ref: #cashflow74815
+Ref: #cashflow75267
-Node: check-dates75911
+Node: check-dates76363
-Ref: #check-dates76038
+Ref: #check-dates76490
-Node: check-dupes76317
+Node: check-dupes76769
-Ref: #check-dupes76441
+Ref: #check-dupes76893
-Node: close76734
+Node: close77186
-Ref: #close76848
+Ref: #close77300
-Node: close usage78370
+Node: close usage78822
-Ref: #close-usage78463
+Ref: #close-usage78915
-Node: commodities81276
+Node: commodities81728
-Ref: #commodities81403
+Ref: #commodities81855
-Node: descriptions81485
+Node: descriptions81937
-Ref: #descriptions81613
+Ref: #descriptions82065
-Node: diff81794
+Node: diff82246
-Ref: #diff81900
+Ref: #diff82352
-Node: files82947
+Node: files83399
-Ref: #files83047
+Ref: #files83499
-Node: help83194
+Node: help83646
-Ref: #help83294
+Ref: #help83746
-Node: import84375
+Node: import84827
-Ref: #import84489
+Ref: #import84941
-Node: Importing balance assignments85382
+Node: Importing balance assignments85834
-Ref: #importing-balance-assignments85530
+Ref: #importing-balance-assignments85982
-Node: incomestatement86179
+Node: incomestatement86631
-Ref: #incomestatement86312
+Ref: #incomestatement86764
-Node: notes87716
+Node: notes88168
-Ref: #notes87829
+Ref: #notes88281
-Node: payees87955
+Node: payees88407
-Ref: #payees88061
+Ref: #payees88513
-Node: prices88219
+Node: prices88671
-Ref: #prices88325
+Ref: #prices88777
-Node: print88666
+Node: print89118
-Ref: #print88776
+Ref: #print89228
-Node: print-unique93420
+Node: print-unique93872
-Ref: #print-unique93546
+Ref: #print-unique93998
-Node: register93831
+Node: register94283
-Ref: #register93958
+Ref: #register94410
-Node: Custom register output98130
+Node: Custom register output98582
-Ref: #custom-register-output98259
+Ref: #custom-register-output98711
-Node: register-match99521
+Node: register-match99973
-Ref: #register-match99655
+Ref: #register-match100107
-Node: rewrite100006
+Node: rewrite100458
-Ref: #rewrite100121
+Ref: #rewrite100573
-Node: Re-write rules in a file101976
+Node: Re-write rules in a file102428
-Ref: #re-write-rules-in-a-file102110
+Ref: #re-write-rules-in-a-file102562
-Node: Diff output format103320
+Node: Diff output format103772
-Ref: #diff-output-format103489
+Ref: #diff-output-format103941
-Node: rewrite vs print --auto104581
+Node: rewrite vs print --auto105033
-Ref: #rewrite-vs.-print---auto104760
+Ref: #rewrite-vs.-print---auto105212
-Node: roi105316
+Node: roi105768
-Ref: #roi105414
+Ref: #roi105866
-Node: stats106426
+Node: stats106878
-Ref: #stats106525
+Ref: #stats106977
-Node: tags107313
+Node: tags107765
-Ref: #tags107411
+Ref: #tags107863
-Node: test107705
+Node: test108157
-Ref: #test107789
+Ref: #test108241
-Node: ADD-ON COMMANDS108536
+Node: ADD-ON COMMANDS108988
-Ref: #add-on-commands108646
+Ref: #add-on-commands109118
-Node: Official add-ons109934
+Node: Official add-ons110406
-Ref: #official-add-ons110074
+Ref: #official-add-ons110546
-Node: ui110154
+Node: ui110626
-Ref: #ui110241
+Ref: #ui110713
-Node: web110295
+Node: web110767
-Ref: #web110384
+Ref: #web110856
-Node: Third party add-ons110430
+Node: Third party add-ons110902
-Ref: #third-party-add-ons110605
+Ref: #third-party-add-ons111077
-Node: iadd110724
+Node: iadd111196
-Ref: #iadd110825
+Ref: #iadd111297
-Node: interest110907
+Node: interest111379
-Ref: #interest111016
+Ref: #interest111488
-Node: Experimental add-ons111111
+Node: Experimental add-ons111583
-Ref: #experimental-add-ons111263
+Ref: #experimental-add-ons111735
-Node: autosync111501
+Node: autosync111973
-Ref: #autosync111612
+Ref: #autosync112084
-Node: chart111851
+Node: chart112323
-Ref: #chart111956
+Ref: #chart112428
+Node: ENVIRONMENT112488
+Ref: #environment112607
+Node: FILES112856
+Ref: #files-1112959
+Node: LIMITATIONS113172
+Ref: #limitations113291
+Node: TROUBLESHOOTING114033
+Ref: #troubleshooting114146
 
 End Tag Table