slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

;update manuals

Browse Source
This commit is contained in:
Simon Michael 2020-09-29 17:32:51 -07:00
parent fd200a85af
commit 83087daa40
6 changed files with 41 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
hledger-lib/hledger_journal.5
View File

@ -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. (and also, a goal of depositing $2000 into checking) every month.
Goals and actual performance can then be compared in budget reports. Goals and actual performance can then be compared in budget reports.
.PP .PP
For more details, see: balance: Budget report and Budgeting and See also: Budgeting and Forecasting.
Forecasting.
.PP .PP
.SS Auto postings .SS Auto postings
.PP .PP

23
hledger-lib/hledger_journal.info
View File

@ -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 checking) every month. Goals and actual performance can then be
compared in budget reports. compared in budget reports.
For more details, see: balance: Budget report and Budgeting and See also: Budgeting and Forecasting.
Forecasting.
 
File: hledger_journal.info, Node: Auto postings, Prev: Periodic transactions, Up: Transactions 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 Ref: #forecasting-with-periodic-transactions61386
Node: Budgeting with periodic transactions63441 Node: Budgeting with periodic transactions63441
Ref: #budgeting-with-periodic-transactions63680 Ref: #budgeting-with-periodic-transactions63680
Node: Auto postings64129 Node: Auto postings64089
Ref: #auto-postings64269 Ref: #auto-postings64229
Node: Auto postings and multiple files66448 Node: Auto postings and multiple files66408
Ref: #auto-postings-and-multiple-files66652 Ref: #auto-postings-and-multiple-files66612
Node: Auto postings and dates66861 Node: Auto postings and dates66821
Ref: #auto-postings-and-dates67135 Ref: #auto-postings-and-dates67095
Node: Auto postings and transaction balancing / inferred amounts / balance assertions67310 Node: Auto postings and transaction balancing / inferred amounts / balance assertions67270
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions67661 Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions67621
Node: Auto posting tags68003 Node: Auto posting tags67963
Ref: #auto-posting-tags68218 Ref: #auto-posting-tags68178
 
End Tag Table End Tag Table

41
hledger-lib/hledger_journal.txt
View File

@ -1388,12 +1388,11 @@ FILE FORMAT
checking) every month. Goals and actual performance can then be com- checking) every month. Goals and actual performance can then be com-
pared in budget reports. pared in budget reports.
For more details, see: balance: Budget report and Budgeting and Fore- See also: Budgeting and Forecasting.
casting.
Auto postings Auto postings
"Automated postings" or "auto postings" are extra postings which get "Automated postings" or "auto postings" are extra postings which get
added automatically to transactions which match certain queries, de- added automatically to transactions which match certain queries, de-
fined by "auto posting rules", when you use the --auto flag. fined by "auto posting rules", when you use the --auto flag.
An auto posting rule looks a bit like a transaction: An auto posting rule looks a bit like a transaction:
@ -1403,27 +1402,27 @@ FILE FORMAT
... ...
ACCOUNT [AMOUNT] ACCOUNT [AMOUNT]
except the first line is an equals sign (mnemonic: = suggests match- except the first line is an equals sign (mnemonic: = suggests match-
ing), followed by a query (which matches existing postings), and each ing), followed by a query (which matches existing postings), and each
"posting" line describes a posting to be generated, and the posting "posting" line describes a posting to be generated, and the posting
amounts can be: 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. as-is.
o a number, eg 2. The commodity symbol (if any) from the matched post- o a number, eg 2. The commodity symbol (if any) from the matched post-
ing will be added to this. 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 matched posting's amount (and total price, if any) will be multiplied
by N. 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 symbol S). The matched posting's amount will be multiplied by N, and
its commodity symbol will be replaced with S. its commodity symbol will be replaced with S.
Any query term containing spaces must be enclosed in single or double 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 quotes, as on the command line. Eg, note the quotes around the second
query term below: query term below:
= expenses:groceries 'expenses:dining out' = expenses:groceries 'expenses:dining out'
@ -1462,24 +1461,24 @@ FILE FORMAT
Auto postings and multiple files Auto postings and multiple files
An auto posting rule can affect any transaction in the current file, or 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). sibling files (when multiple -f/--file are used - see #1212).
Auto postings and dates Auto postings and dates
A posting date (or secondary date) in the matched posting, or (taking A posting date (or secondary date) in the matched posting, or (taking
precedence) a posting date in the auto posting rule itself, will also precedence) a posting date in the auto posting rule itself, will also
be used in the generated posting. be used in the generated posting.
Auto postings and transaction balancing / inferred amounts / balance asser- Auto postings and transaction balancing / inferred amounts / balance asser-
tions tions
Currently, auto postings are added: 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, balancedness,
o but before balance assertions are checked. 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 after auto postings are added. This changed in hledger 1.12+; see #893
for background. for background.
@ -1489,11 +1488,11 @@ FILE FORMAT
o generated-posting:= QUERY - shows this was generated by an auto post- o generated-posting:= QUERY - shows this was generated by an auto post-
ing rule, and the query 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 hledger's output. This can be used to match postings generated "just
now", rather than generated in the past and saved to the journal. 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: have these tags added:
o modified: - this transaction was modified o modified: - this transaction was modified
@ -1504,7 +1503,7 @@ FILE FORMAT
REPORTING BUGS REPORTING BUGS
Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel Report bugs at http://bugs.hledger.org (or on the #hledger IRC channel
or hledger mail list) or hledger mail list)
@ -1518,7 +1517,7 @@ COPYRIGHT
SEE ALSO 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- hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_time-
dot(5), ledger(1) dot(5), ledger(1)

1
hledger-web/hledger-web.1
View File

@ -349,6 +349,7 @@ You can get JSON data from these routes:
.IP .IP
.nf .nf
\f[C] \f[C]
/version
/accountnames /accountnames
/transactions /transactions
/prices /prices

13
hledger-web/hledger-web.info
View File

@ -355,6 +355,7 @@ $ hledger-web -f examples/sample.journal --serve-api
You can get JSON data from these routes: You can get JSON data from these routes:
/version
/accountnames /accountnames
/transactions /transactions
/prices /prices
@ -590,12 +591,12 @@ Node: RELOADING11103
Ref: #reloading11237 Ref: #reloading11237
Node: JSON API11670 Node: JSON API11670
Ref: #json-api11784 Ref: #json-api11784
Node: ENVIRONMENT17265 Node: ENVIRONMENT17274
Ref: #environment17381 Ref: #environment17390
Node: FILES18114 Node: FILES18123
Ref: #files18214 Ref: #files18223
Node: BUGS18427 Node: BUGS18436
Ref: #bugs18505 Ref: #bugs18514
 
End Tag Table End Tag Table

1
hledger-web/hledger-web.txt
View File

@ -314,6 +314,7 @@ JSON API
You can get JSON data from these routes: You can get JSON data from these routes:
/version
/accountnames /accountnames
/transactions /transactions
/prices /prices