update embedded manuals

hledger-lib/hledger_journal.5

@@ -1457,7 +1457,7 @@ Goals and actual performance can then be compared in budget reports.
 For more details, see: balance: Budget report and Cookbook: Budgeting
 and Forecasting.
 .PP
- ## Transaction Modifiers
+.SS Transaction Modifiers
 .PP
 Transaction modifier rules describe changes that should be applied
 automatically to certain transactions.

hledger-lib/hledger_journal.info

@@ -82,6 +82,7 @@ File: hledger_journal.info,  Node: FILE FORMAT,  Next: EDITOR SUPPORT,  Prev: To
 * Tags::
 * Directives::
 * Periodic transactions::
+* Transaction Modifiers::
 
 
 File: hledger_journal.info,  Node: Transactions,  Next: Postings,  Up: FILE FORMAT
@@ -1196,7 +1197,7 @@ If account aliases are present, they are applied after the default
 parent account.
 
 
-File: hledger_journal.info,  Node: Periodic transactions,  Prev: Directives,  Up: FILE FORMAT
+File: hledger_journal.info,  Node: Periodic transactions,  Next: Transaction Modifiers,  Prev: Directives,  Up: FILE FORMAT
 
 1.15 Periodic transactions
 ==========================
@@ -1292,9 +1293,13 @@ compared in budget reports.
    For more details, see: balance: Budget report and Cookbook: Budgeting
 and Forecasting.
 
-   ## Transaction Modifiers
+
+File: hledger_journal.info,  Node: Transaction Modifiers,  Prev: Periodic transactions,  Up: FILE FORMAT
 
-   Transaction modifier rules describe changes that should be applied
+1.16 Transaction Modifiers
+==========================
+
+Transaction modifier rules describe changes that should be applied
 automatically to certain transactions.  Currently, this means adding
 extra postings (also known as "automated postings").  Transaction
 modifiers are enabled by the '--auto' flag.
@@ -1364,87 +1369,89 @@ Tag Table:
 Node: Top76
 Node: FILE FORMAT2378
 Ref: #file-format2502
-Node: Transactions2763
+Node: Transactions2789
-Ref: #transactions2884
+Ref: #transactions2910
-Node: Postings3568
+Node: Postings3594
-Ref: #postings3695
+Ref: #postings3721
-Node: Dates4690
+Node: Dates4716
-Ref: #dates4805
+Ref: #dates4831
-Node: Simple dates4870
+Node: Simple dates4896
-Ref: #simple-dates4996
+Ref: #simple-dates5022
-Node: Secondary dates5362
+Node: Secondary dates5388
-Ref: #secondary-dates5516
+Ref: #secondary-dates5542
-Node: Posting dates7079
+Node: Posting dates7105
-Ref: #posting-dates7208
+Ref: #posting-dates7234
-Node: Status8582
+Node: Status8608
-Ref: #status8702
+Ref: #status8728
-Node: Description10410
+Node: Description10436
-Ref: #description10548
+Ref: #description10574
-Node: Payee and note10867
+Node: Payee and note10893
-Ref: #payee-and-note10981
+Ref: #payee-and-note11007
-Node: Account names11223
+Node: Account names11249
-Ref: #account-names11366
+Ref: #account-names11392
-Node: Amounts11853
+Node: Amounts11879
-Ref: #amounts11989
+Ref: #amounts12015
-Node: Virtual Postings15006
+Node: Virtual Postings15032
-Ref: #virtual-postings15165
+Ref: #virtual-postings15191
-Node: Balance Assertions16385
+Node: Balance Assertions16411
-Ref: #balance-assertions16560
+Ref: #balance-assertions16586
-Node: Assertions and ordering17456
+Node: Assertions and ordering17482
-Ref: #assertions-and-ordering17642
+Ref: #assertions-and-ordering17668
-Node: Assertions and included files18342
+Node: Assertions and included files18368
-Ref: #assertions-and-included-files18583
+Ref: #assertions-and-included-files18609
-Node: Assertions and multiple -f options18916
+Node: Assertions and multiple -f options18942
-Ref: #assertions-and-multiple--f-options19170
+Ref: #assertions-and-multiple--f-options19196
-Node: Assertions and commodities19302
+Node: Assertions and commodities19328
-Ref: #assertions-and-commodities19537
+Ref: #assertions-and-commodities19563
-Node: Assertions and subaccounts20233
+Node: Assertions and subaccounts20259
-Ref: #assertions-and-subaccounts20465
+Ref: #assertions-and-subaccounts20491
-Node: Assertions and virtual postings20986
+Node: Assertions and virtual postings21012
-Ref: #assertions-and-virtual-postings21193
+Ref: #assertions-and-virtual-postings21219
-Node: Balance Assignments21335
+Node: Balance Assignments21361
-Ref: #balance-assignments21516
+Ref: #balance-assignments21542
-Node: Transaction prices22636
+Node: Transaction prices22662
-Ref: #transaction-prices22805
+Ref: #transaction-prices22831
-Node: Comments25073
+Node: Comments25099
-Ref: #comments25207
+Ref: #comments25233
-Node: Tags26377
+Node: Tags26403
-Ref: #tags26495
+Ref: #tags26521
-Node: Directives27897
+Node: Directives27923
-Ref: #directives28040
+Ref: #directives28066
-Node: Comment blocks33896
+Node: Comment blocks33922
-Ref: #comment-blocks34041
+Ref: #comment-blocks34067
-Node: Including other files34217
+Node: Including other files34243
-Ref: #including-other-files34397
+Ref: #including-other-files34423
-Node: Default year34805
+Node: Default year34831
-Ref: #default-year34974
+Ref: #default-year35000
-Node: Declaring commodities35397
+Node: Declaring commodities35423
-Ref: #declaring-commodities35580
+Ref: #declaring-commodities35606
-Node: Default commodity36807
+Node: Default commodity36833
-Ref: #default-commodity36983
+Ref: #default-commodity37009
-Node: Market prices37619
+Node: Market prices37645
-Ref: #market-prices37784
+Ref: #market-prices37810
-Node: Declaring accounts38625
+Node: Declaring accounts38651
-Ref: #declaring-accounts38801
+Ref: #declaring-accounts38827
-Node: Rewriting accounts40472
+Node: Rewriting accounts40498
-Ref: #rewriting-accounts40657
+Ref: #rewriting-accounts40683
-Node: Basic aliases41391
+Node: Basic aliases41417
-Ref: #basic-aliases41537
+Ref: #basic-aliases41563
-Node: Regex aliases42241
+Node: Regex aliases42267
-Ref: #regex-aliases42412
+Ref: #regex-aliases42438
-Node: Multiple aliases43130
+Node: Multiple aliases43156
-Ref: #multiple-aliases43305
+Ref: #multiple-aliases43331
-Node: end aliases43803
+Node: end aliases43829
-Ref: #end-aliases43950
+Ref: #end-aliases43976
-Node: Default parent account44051
+Node: Default parent account44077
-Ref: #default-parent-account44217
+Ref: #default-parent-account44243
-Node: Periodic transactions45101
+Node: Periodic transactions45127
-Ref: #periodic-transactions45253
+Ref: #periodic-transactions45309
-Node: Forecasting with periodic transactions46464
+Node: Forecasting with periodic transactions46520
-Ref: #forecasting-with-periodic-transactions46707
+Ref: #forecasting-with-periodic-transactions46763
-Node: Budgeting with periodic transactions48394
+Node: Budgeting with periodic transactions48450
-Ref: #budgeting-with-periodic-transactions48633
+Ref: #budgeting-with-periodic-transactions48689
-Node: EDITOR SUPPORT50380
+Node: Transaction Modifiers49148
-Ref: #editor-support50498
+Ref: #transaction-modifiers49311
+Node: EDITOR SUPPORT50567
+Ref: #editor-support50685
 
 End Tag Table

hledger-lib/hledger_journal.txt

@@ -1047,8 +1047,8 @@ FILE FORMAT
        For  more  details, see: balance: Budget report and Cookbook: Budgeting
        and Forecasting.
 
-        ## Transaction Modifiers
 
+   Transaction Modifiers
        Transaction modifier rules describe  changes  that  should  be  applied
        automatically  to  certain  transactions.  Currently, this means adding
        extra postings (also known as "automated postings").  Transaction modi-

hledger/hledger.1

@@ -2806,20 +2806,22 @@ are considered.
 .SS test
 .PP
 Run built\-in unit tests.
-.IP
-.nf
-\f[C]
-$\ hledger\ test
-Cases:\ 74\ \ Tried:\ 74\ \ Errors:\ 0\ \ Failures:\ 0
-\f[]
-.fi
 .PP
-This command runs hledger's built\-in unit tests and displays a quick
+Prints test names and their results on stdout.
-report.
+If any test fails or gives an error, the exit code will be non\-zero.
-With a regular expression argument, it selects only tests with matching
+.PP
-names.
+Test names include a group prefix.
-It's mainly used in development, but it's also nice to be able to check
+If a (exact, case sensitive) group prefix, or a full test name is
-your hledger executable for smoke at any time.
+provided as the first argument, only that group or test is run.
+.PP
+If a numeric second argument is provided, it will set the randomness
+seed, for repeatable results from tests using randomness (currently none
+of them).
+.PP
+This is mainly used by developers, but it's nice to be able to
+sanity\-check your installed hledger executable at any time.
+All tests are expected to pass \- if you ever see otherwise, something
+has gone wrong, please report a bug!
 .SH ADD\-ON COMMANDS
 .PP
 hledger also searches for external add\-on commands, and will include

hledger/hledger.info

@@ -2256,13 +2256,21 @@ File: hledger.info,  Node: test,  Prev: tags,  Up: COMMANDS
 
 Run built-in unit tests.
 
-$ hledger test
+   Prints test names and their results on stdout.  If any test fails or
-Cases: 74  Tried: 74  Errors: 0  Failures: 0
+gives an error, the exit code will be non-zero.
 
-   This command runs hledger's built-in unit tests and displays a quick
+   Test names include a group prefix.  If a (exact, case sensitive)
-report.  With a regular expression argument, it selects only tests with
+group prefix, or a full test name is provided as the first argument,
-matching names.  It's mainly used in development, but it's also nice to
+only that group or test is run.
-be able to check your hledger executable for smoke at any time.
+
+   If a numeric second argument is provided, it will set the randomness
+seed, for repeatable results from tests using randomness (currently none
+of them).
+
+   This is mainly used by developers, but it's nice to be able to
+sanity-check your installed hledger executable at any time.  All tests
+are expected to pass - if you ever see otherwise, something has gone
+wrong, please report a bug!
 
 
 File: hledger.info,  Node: ADD-ON COMMANDS,  Prev: COMMANDS,  Up: Top
@@ -2541,33 +2549,33 @@ Node: tags76896
 Ref: #tags76994
 Node: test77230
 Ref: #test77314
-Node: ADD-ON COMMANDS77682
+Node: ADD-ON COMMANDS78022
-Ref: #add-on-commands77792
+Ref: #add-on-commands78132
-Node: Official add-ons79079
+Node: Official add-ons79419
-Ref: #official-add-ons79219
+Ref: #official-add-ons79559
-Node: api79306
+Node: api79646
-Ref: #api79395
+Ref: #api79735
-Node: ui79447
+Node: ui79787
-Ref: #ui79546
+Ref: #ui79886
-Node: web79604
+Node: web79944
-Ref: #web79693
+Ref: #web80033
-Node: Third party add-ons79739
+Node: Third party add-ons80079
-Ref: #third-party-add-ons79914
+Ref: #third-party-add-ons80254
-Node: diff80049
+Node: diff80389
-Ref: #diff80146
+Ref: #diff80486
-Node: iadd80245
+Node: iadd80585
-Ref: #iadd80359
+Ref: #iadd80699
-Node: interest80442
+Node: interest80782
-Ref: #interest80563
+Ref: #interest80903
-Node: irr80658
+Node: irr80998
-Ref: #irr80756
+Ref: #irr81096
-Node: Experimental add-ons80834
+Node: Experimental add-ons81174
-Ref: #experimental-add-ons80986
+Ref: #experimental-add-ons81326
-Node: autosync81266
+Node: autosync81606
-Ref: #autosync81377
+Ref: #autosync81717
-Node: chart81616
+Node: chart81956
-Ref: #chart81735
+Ref: #chart82075
-Node: check81806
+Node: check82146
-Ref: #check81908
+Ref: #check82248
 
 End Tag Table

hledger/hledger.txt

@@ -2012,37 +2012,45 @@ COMMANDS
    test
        Run built-in unit tests.
 
-              $ hledger test
+       Prints test names and their results on stdout.  If any  test  fails  or
-              Cases: 74  Tried: 74  Errors: 0  Failures: 0
+       gives an error, the exit code will be non-zero.
 
-       This command runs hledger's built-in unit tests and  displays  a  quick
+       Test  names include a group prefix.  If a (exact, case sensitive) group
-       report.  With a regular expression argument, it selects only tests with
+       prefix, or a full test name is provided as  the  first  argument,  only
-       matching names.  It's mainly used in development, but it's also nice to
+       that group or test is run.
-       be able to check your hledger executable for smoke at any time.
+
+       If  a  numeric  second argument is provided, it will set the randomness
+       seed, for repeatable results from  tests  using  randomness  (currently
+       none of them).
+
+       This  is  mainly  used  by developers, but it's nice to be able to san-
+       ity-check your installed hledger executable at any time.  All tests are
+       expected to pass - if you ever see otherwise, something has gone wrong,
+       please report a bug!
 
 ADD-ON COMMANDS
-       hledger  also  searches  for external add-on commands, and will include
+       hledger also searches for external add-on commands,  and  will  include
        these in the commands list.  These are programs or scripts in your PATH
-       whose  name starts with hledger- and ends with a recognised file exten-
+       whose name starts with hledger- and ends with a recognised file  exten-
        sion (currently: no extension, bat,com,exe, hs,lhs,pl,py,rb,rkt,sh).
 
-       Add-ons can be invoked like any hledger command, but there  are  a  few
+       Add-ons  can  be  invoked like any hledger command, but there are a few
        things to be aware of.  Eg if the hledger-web add-on is installed,
 
        o hledger -h web  shows  hledger's  help,  while  hledger web -h  shows
          hledger-web's help.
 
-       o Flags specific to the add-on must have a preceding --  to  hide  them
+       o Flags  specific  to  the add-on must have a preceding -- to hide them
-         from  hledger.   So hledger web --serve --port 9000 will be rejected;
+         from hledger.  So hledger web --serve --port 9000 will  be  rejected;
          you must use hledger web -- --serve --port 9000.
 
-       o You   can    always    run    add-ons    directly    if    preferred:
+       o You    can    always    run    add-ons    directly    if   preferred:
          hledger-web --serve --port 9000.
 
-       Add-ons  are  a relatively easy way to add local features or experiment
+       Add-ons are a relatively easy way to add local features  or  experiment
-       with new ideas.  They can be  written  in  any  language,  but  haskell
+       with  new  ideas.   They  can  be  written in any language, but haskell
-       scripts  have  a  big  advantage:  they  can  use the same hledger (and
+       scripts have a big advantage:  they  can  use  the  same  hledger  (and
-       haskell) library functions that built-in commands do, for  command-line
+       haskell)  library functions that built-in commands do, for command-line
        options, journal parsing, reporting, etc.
 
        Here are some hledger add-ons available:
@@ -2060,7 +2068,7 @@ ADD-ON COMMANDS
        hledger-web provides a simple web interface.
 
    Third party add-ons
-       These  are  maintained  separately, and usually updated shortly after a
+       These are maintained separately, and usually updated  shortly  after  a
        hledger release.
 
    diff
@@ -2068,7 +2076,7 @@ ADD-ON COMMANDS
        journal file and another.
 
    iadd
-       hledger-iadd  is  a  curses-style, more interactive replacement for the
+       hledger-iadd is a curses-style, more interactive  replacement  for  the
        add command.
 
    interest
@@ -2076,19 +2084,19 @@ ADD-ON COMMANDS
        ing to various schemes.
 
    irr
-       hledger-irr  calculates  the  internal  rate of return of an investment
+       hledger-irr calculates the internal rate of  return  of  an  investment
        account.
 
    Experimental add-ons
-       These are available in source form in the hledger  repo's  bin/  direc-
+       These  are  available  in source form in the hledger repo's bin/ direc-
        tory; installing them is pretty easy.  They may be less mature and doc-
-       umented than built-in commands.  Reading and tweaking these is  a  good
+       umented  than  built-in commands.  Reading and tweaking these is a good
        way to start making your own!
 
    autosync
        hledger-autosync is a symbolic link for easily running ledger-autosync,
-       if installed.  ledger-autosync does  deduplicating  conversion  of  OFX
+       if  installed.   ledger-autosync  does  deduplicating conversion of OFX
-       data  and some CSV formats, and can also download the data if your bank
+       data and some CSV formats, and can also download the data if your  bank
        offers OFX Direct Connect.
 
    chart
@@ -2098,21 +2106,21 @@ ADD-ON COMMANDS
        hledger-check.hs checks more powerful account balance assertions.
 
 ENVIRONMENT
-       COLUMNS The screen width used by the register  command.   Default:  the
+       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.jour-
+       ~/.hledger.journal  (on  windows,  perhaps C:/Users/USER/.hledger.jour-
        nal).
 
 FILES
-       Reads  data from one or more files in hledger journal, timeclock, time-
+       Reads data from one or more files in hledger journal, timeclock,  time-
-       dot,  or  CSV  format  specified   with   -f,   or   $LEDGER_FILE,   or
+       dot,   or   CSV   format   specified   with  -f,  or  $LEDGER_FILE,  or
-       $HOME/.hledger.journal           (on          windows,          perhaps
+       $HOME/.hledger.journal          (on          windows,           perhaps
        C:/Users/USER/.hledger.journal).
 
 BUGS
-       The need to precede addon command options with  --  when  invoked  from
+       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
@@ -2125,33 +2133,33 @@ BUGS
        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
+       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
+       On  large  data  files,  hledger  is  slower  and uses more memory than
        Ledger.
 
 TROUBLESHOOTING
-       Here  are  some  issues  you  might encounter when you run hledger (and
+       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
+       remember  you can also seek help from the IRC channel, mail list or bug
        tracker):
 
        Successfully installed, but "No command `hledger' found"
        stack and cabal install binaries into a special directory, which should
-       be added to your PATH environment variable.  Eg on  unix-like  systems,
+       be  added  to your PATH environment variable.  Eg on unix-like systems,
        that is ~/.local/bin and ~/.cabal/bin respectively.
 
        I set a custom LEDGER_FILE, but hledger is still using the default file
-       LEDGER_FILE should be a real environment variable,  not  just  a  shell
+       LEDGER_FILE  should  be  a  real environment variable, not just a shell
-       variable.   The command env | grep LEDGER_FILE should show it.  You may
+       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
+       "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 sup-
-       ports UTF-8, if you built hledger with GHC < 7.2 (or  possibly  always,
+       ports  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
@@ -2170,7 +2178,7 @@ TROUBLESHOOTING
               $ 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
+       If  we  preferred  to  use eg fr_FR.utf8, we might have to install that
        first:
 
               $ apt-get install language-pack-fr
@@ -2191,7 +2199,7 @@ TROUBLESHOOTING
 
 
 REPORTING BUGS
-       Report bugs at http://bugs.hledger.org (or on the #hledger IRC  channel
+       Report  bugs at http://bugs.hledger.org (or on the #hledger IRC channel
        or hledger mail list)
 
 
@@ -2205,7 +2213,7 @@ COPYRIGHT
 
 
 SEE ALSO
-       hledger(1),      hledger-ui(1),     hledger-web(1),     hledger-api(1),
+       hledger(1),     hledger-ui(1),     hledger-web(1),      hledger-api(1),
        hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time-
        dot(5), ledger(1)