From 83087daa40579cb9ed7a805dc74b1e707cdec76e Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Tue, 29 Sep 2020 17:32:51 -0700 Subject: [PATCH] ;update manuals --- hledger-lib/hledger_journal.5 | 3 +-- hledger-lib/hledger_journal.info | 23 +++++++++--------- hledger-lib/hledger_journal.txt | 41 ++++++++++++++++---------------- hledger-web/hledger-web.1 | 1 + hledger-web/hledger-web.info | 13 +++++----- hledger-web/hledger-web.txt | 1 + 6 files changed, 41 insertions(+), 41 deletions(-) diff --git a/hledger-lib/hledger_journal.5 b/hledger-lib/hledger_journal.5 index 5ed28dd84..5c88cce86 100644 --- a/hledger-lib/hledger_journal.5 +++ b/hledger-lib/hledger_journal.5 @@ -1941,8 +1941,7 @@ Eg the first example above declares a goal of spending $2000 on rent (and also, a goal of depositing $2000 into checking) every month. Goals and actual performance can then be compared in budget reports. .PP -For more details, see: balance: Budget report and Budgeting and -Forecasting. +See also: Budgeting and Forecasting. .PP .SS Auto postings .PP diff --git a/hledger-lib/hledger_journal.info b/hledger-lib/hledger_journal.info index ae2c91bf6..d57eef769 100644 --- a/hledger-lib/hledger_journal.info +++ b/hledger-lib/hledger_journal.info @@ -1723,8 +1723,7 @@ spending $2000 on rent (and also, a goal of depositing $2000 into checking) every month. Goals and actual performance can then be compared in budget reports. - For more details, see: balance: Budget report and Budgeting and -Forecasting. + See also: Budgeting and Forecasting.  File: hledger_journal.info, Node: Auto postings, Prev: Periodic transactions, Up: Transactions @@ -1973,16 +1972,16 @@ Node: Forecasting with periodic transactions61081 Ref: #forecasting-with-periodic-transactions61386 Node: Budgeting with periodic transactions63441 Ref: #budgeting-with-periodic-transactions63680 -Node: Auto postings64129 -Ref: #auto-postings64269 -Node: Auto postings and multiple files66448 -Ref: #auto-postings-and-multiple-files66652 -Node: Auto postings and dates66861 -Ref: #auto-postings-and-dates67135 -Node: Auto postings and transaction balancing / inferred amounts / balance assertions67310 -Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions67661 -Node: Auto posting tags68003 -Ref: #auto-posting-tags68218 +Node: Auto postings64089 +Ref: #auto-postings64229 +Node: Auto postings and multiple files66408 +Ref: #auto-postings-and-multiple-files66612 +Node: Auto postings and dates66821 +Ref: #auto-postings-and-dates67095 +Node: Auto postings and transaction balancing / inferred amounts / balance assertions67270 +Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions67621 +Node: Auto posting tags67963 +Ref: #auto-posting-tags68178  End Tag Table diff --git a/hledger-lib/hledger_journal.txt b/hledger-lib/hledger_journal.txt index d1ea374e2..277de3398 100644 --- a/hledger-lib/hledger_journal.txt +++ b/hledger-lib/hledger_journal.txt @@ -1388,12 +1388,11 @@ FILE FORMAT checking) every month. Goals and actual performance can then be com- pared in budget reports. - For more details, see: balance: Budget report and Budgeting and Fore- - casting. + See also: Budgeting and Forecasting. Auto postings - "Automated postings" or "auto postings" are extra postings which get - added automatically to transactions which match certain queries, de- + "Automated postings" or "auto postings" are extra postings which get + added automatically to transactions which match certain queries, de- fined by "auto posting rules", when you use the --auto flag. An auto posting rule looks a bit like a transaction: @@ -1403,27 +1402,27 @@ FILE FORMAT ... ACCOUNT [AMOUNT] - except the first line is an equals sign (mnemonic: = suggests match- - ing), followed by a query (which matches existing postings), and each - "posting" line describes a posting to be generated, and the posting + except the first line is an equals sign (mnemonic: = suggests match- + ing), followed by a query (which matches existing postings), and each + "posting" line describes a posting to be generated, and the posting amounts can be: - o a normal amount with a commodity symbol, eg $2. This will be used + o a normal amount with a commodity symbol, eg $2. This will be used as-is. o a number, eg 2. The commodity symbol (if any) from the matched post- ing will be added to this. - o a numeric multiplier, eg *2 (a star followed by a number N). The + o a numeric multiplier, eg *2 (a star followed by a number N). The matched posting's amount (and total price, if any) will be multiplied by N. - o a multiplier with a commodity symbol, eg *$2 (a star, number N, and + o a multiplier with a commodity symbol, eg *$2 (a star, number N, and symbol S). The matched posting's amount will be multiplied by N, and its commodity symbol will be replaced with S. - Any query term containing spaces must be enclosed in single or double - quotes, as on the command line. Eg, note the quotes around the second + Any query term containing spaces must be enclosed in single or double + quotes, as on the command line. Eg, note the quotes around the second query term below: = expenses:groceries 'expenses:dining out' @@ -1462,24 +1461,24 @@ FILE FORMAT Auto postings and multiple files An auto posting rule can affect any transaction in the current file, or - in any parent file or child file. Note, currently it will not affect + in any parent file or child file. Note, currently it will not affect sibling files (when multiple -f/--file are used - see #1212). Auto postings and dates - A posting date (or secondary date) in the matched posting, or (taking - precedence) a posting date in the auto posting rule itself, will also + A posting date (or secondary date) in the matched posting, or (taking + precedence) a posting date in the auto posting rule itself, will also be used in the generated posting. Auto postings and transaction balancing / inferred amounts / balance asser- tions Currently, auto postings are added: - o after missing amounts are inferred, and transactions are checked for + o after missing amounts are inferred, and transactions are checked for balancedness, o but before balance assertions are checked. - Note this means that journal entries must be balanced both before and + Note this means that journal entries must be balanced both before and after auto postings are added. This changed in hledger 1.12+; see #893 for background. @@ -1489,11 +1488,11 @@ FILE FORMAT o generated-posting:= QUERY - shows this was generated by an auto post- ing rule, and the query - o _generated-posting:= QUERY - a hidden tag, which does not appear in + o _generated-posting:= QUERY - a hidden tag, which does not appear in hledger's output. This can be used to match postings generated "just now", rather than generated in the past and saved to the journal. - Also, any transaction that has been changed by auto posting rules will + Also, any transaction that has been changed by auto posting rules will have these tags added: o modified: - this transaction was modified @@ -1504,7 +1503,7 @@ FILE FORMAT 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) @@ -1518,7 +1517,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) diff --git a/hledger-web/hledger-web.1 b/hledger-web/hledger-web.1 index 7ea6d63cf..ee84ad40c 100644 --- a/hledger-web/hledger-web.1 +++ b/hledger-web/hledger-web.1 @@ -349,6 +349,7 @@ You can get JSON data from these routes: .IP .nf \f[C] +/version /accountnames /transactions /prices diff --git a/hledger-web/hledger-web.info b/hledger-web/hledger-web.info index 06fe43f70..8ba0e947a 100644 --- a/hledger-web/hledger-web.info +++ b/hledger-web/hledger-web.info @@ -355,6 +355,7 @@ $ hledger-web -f examples/sample.journal --serve-api You can get JSON data from these routes: +/version /accountnames /transactions /prices @@ -590,12 +591,12 @@ Node: RELOADING11103 Ref: #reloading11237 Node: JSON API11670 Ref: #json-api11784 -Node: ENVIRONMENT17265 -Ref: #environment17381 -Node: FILES18114 -Ref: #files18214 -Node: BUGS18427 -Ref: #bugs18505 +Node: ENVIRONMENT17274 +Ref: #environment17390 +Node: FILES18123 +Ref: #files18223 +Node: BUGS18436 +Ref: #bugs18514  End Tag Table diff --git a/hledger-web/hledger-web.txt b/hledger-web/hledger-web.txt index eb14075ee..8c36a1396 100644 --- a/hledger-web/hledger-web.txt +++ b/hledger-web/hledger-web.txt @@ -314,6 +314,7 @@ JSON API You can get JSON data from these routes: + /version /accountnames /transactions /prices