;update manuals

This commit is contained in:
Simon Michael 2020-11-09 17:13:57 -08:00
parent 94b01dd19d
commit 86fac4236d
6 changed files with 336 additions and 316 deletions

View File

@ -584,7 +584,8 @@ commodity INR 9,99,99,999.00
commodity 1 000 000.9455
\f[R]
.fi
.SS Amount display style
.PP
.SS Commodity display style
.PP
For each commodity, hledger chooses a consistent format to use when
displaying amounts.
@ -613,11 +614,10 @@ journal, with the max observed number of decimal places.
If you want to see fewer decimal places in reports, use a commodity
directive to override that.
.PP
hledger uses banker\[aq]s rounding: it rounds to the nearest even
Note, hledger uses banker\[aq]s rounding: it rounds to the nearest even
number, eg 0.5 displayed with zero decimal places is \[dq]0\[dq]).
(Note, prior to hledger 1.17.1 this could vary if hledger happened to be
built with an old version of Decimal (<0.5.1); since 1.17.1 it\[aq]s
guaranteed.)
(Guaranteed since hledger 1.17.1; in older versions this could vary if
hledger was built with Decimal < 0.5.1.)
.SS Transaction prices
.PP
Within a transaction, you can note an amount\[aq]s price in another
@ -1198,7 +1198,7 @@ your data.
(Without this, hledger will parse both \f[C]1,000\f[R] and
\f[C]1.000\f[R] as 1).
.IP "3." 3
It declares the amount display style to use in output - decimal and
It declares a commodity\[aq]s display style in output - decimal and
digit group marks, number of decimal places, symbol placement etc.
.PP
You are likely to run into one of the problems solved by commodity
@ -1244,7 +1244,7 @@ followed by 0 or more decimal digits.
.PP
Note hledger normally uses banker\[aq]s rounding, so 0.5 displayed with
zero decimal digits is \[dq]0\[dq].
(More at Amount display style.)
(More at Commodity display style.)
.SS Default commodity
.PP
The \f[C]D\f[R] directive sets a default commodity, to be used for

View File

@ -487,10 +487,10 @@ EUR 1E3
* Menu:
* Digit group marks::
* Amount display style::
* Commodity display style::

File: hledger_journal.info, Node: Digit group marks, Next: Amount display style, Up: Amounts
File: hledger_journal.info, Node: Digit group marks, Next: Commodity display style, Up: Amounts
1.8.1 Digit group marks
-----------------------
@ -523,10 +523,10 @@ commodity INR 9,99,99,999.00
commodity 1 000 000.9455

File: hledger_journal.info, Node: Amount display style, Prev: Digit group marks, Up: Amounts
File: hledger_journal.info, Node: Commodity display style, Prev: Digit group marks, Up: Amounts
1.8.2 Amount display style
--------------------------
1.8.2 Commodity display style
-----------------------------
For each commodity, hledger chooses a consistent format to use when
displaying amounts. (Except price amounts, which are always displayed
@ -553,10 +553,10 @@ journal, with the max observed number of decimal places. If you want to
see fewer decimal places in reports, use a commodity directive to
override that.
hledger uses banker's rounding: it rounds to the nearest even number,
eg 0.5 displayed with zero decimal places is "0"). (Note, prior to
hledger 1.17.1 this could vary if hledger happened to be built with an
old version of Decimal (<0.5.1); since 1.17.1 it's guaranteed.)
Note, hledger uses banker's rounding: it rounds to the nearest even
number, eg 0.5 displayed with zero decimal places is "0"). (Guaranteed
since hledger 1.17.1; in older versions this could vary if hledger was
built with Decimal < 0.5.1.)

File: hledger_journal.info, Node: Transaction prices, Next: Lot prices and lot dates, Prev: Amounts, Up: Transactions
@ -1079,7 +1079,7 @@ The 'commodity' directive has several functions:
formats in your data. (Without this, hledger will parse both
'1,000' and '1.000' as 1).
3. It declares the amount display style to use in output - decimal and
3. It declares a commodity's display style in output - decimal and
digit group marks, number of decimal places, symbol placement etc.
You are likely to run into one of the problems solved by commodity
@ -1114,7 +1114,7 @@ significant. The number must include a decimal mark: either a period or
a comma, followed by 0 or more decimal digits.
Note hledger normally uses banker's rounding, so 0.5 displayed with
zero decimal digits is "0". (More at Amount display style.)
zero decimal digits is "0". (More at Commodity display style.)

File: hledger_journal.info, Node: Default commodity, Next: Declaring market prices, Prev: Declaring commodities, Up: Directives
@ -1889,96 +1889,96 @@ Node: Account names15177
Ref: #account-names15318
Node: Amounts15805
Ref: #amounts15944
Node: Digit group marks17052
Ref: #digit-group-marks17200
Node: Amount display style18138
Ref: #amount-display-style18292
Node: Transaction prices19729
Ref: #transaction-prices19901
Node: Lot prices and lot dates22332
Ref: #lot-prices-and-lot-dates22529
Node: Balance assertions23017
Ref: #balance-assertions23203
Node: Assertions and ordering24236
Ref: #assertions-and-ordering24424
Node: Assertions and included files25124
Ref: #assertions-and-included-files25367
Node: Assertions and multiple -f options25700
Ref: #assertions-and-multiple--f-options25956
Node: Assertions and commodities26088
Ref: #assertions-and-commodities26320
Node: Assertions and prices27477
Ref: #assertions-and-prices27691
Node: Assertions and subaccounts28131
Ref: #assertions-and-subaccounts28360
Node: Assertions and virtual postings28684
Ref: #assertions-and-virtual-postings28926
Node: Assertions and precision29068
Ref: #assertions-and-precision29261
Node: Balance assignments29528
Ref: #balance-assignments29702
Node: Balance assignments and prices30866
Ref: #balance-assignments-and-prices31038
Node: Directives31262
Ref: #directives31421
Node: Directives and multiple files36919
Ref: #directives-and-multiple-files37102
Node: Comment blocks37766
Ref: #comment-blocks37949
Node: Including other files38125
Ref: #including-other-files38305
Node: Default year39229
Ref: #default-year39398
Node: Declaring commodities39805
Ref: #declaring-commodities39988
Node: Default commodity41794
Ref: #default-commodity41980
Node: Declaring market prices42869
Ref: #declaring-market-prices43064
Node: Declaring accounts43921
Ref: #declaring-accounts44107
Node: Account comments45032
Ref: #account-comments45195
Node: Account subdirectives45619
Ref: #account-subdirectives45814
Node: Account types46127
Ref: #account-types46311
Node: Account display order49357
Ref: #account-display-order49527
Node: Rewriting accounts50678
Ref: #rewriting-accounts50863
Node: Basic aliases51620
Ref: #basic-aliases51766
Node: Regex aliases52470
Ref: #regex-aliases52642
Node: Combining aliases53361
Ref: #combining-aliases53554
Node: Aliases and multiple files54830
Ref: #aliases-and-multiple-files55039
Node: end aliases55618
Ref: #end-aliases55775
Node: Default parent account55876
Ref: #default-parent-account56044
Node: Periodic transactions56928
Ref: #periodic-transactions57103
Node: Periodic rule syntax58975
Ref: #periodic-rule-syntax59181
Node: Two spaces between period expression and description!59885
Ref: #two-spaces-between-period-expression-and-description60204
Node: Forecasting with periodic transactions60888
Ref: #forecasting-with-periodic-transactions61193
Node: Budgeting with periodic transactions63248
Ref: #budgeting-with-periodic-transactions63487
Node: Auto postings63896
Ref: #auto-postings64036
Node: Auto postings and multiple files66215
Ref: #auto-postings-and-multiple-files66419
Node: Auto postings and dates66628
Ref: #auto-postings-and-dates66902
Node: Auto postings and transaction balancing / inferred amounts / balance assertions67077
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions67428
Node: Auto posting tags67770
Ref: #auto-posting-tags67985
Node: Digit group marks17055
Ref: #digit-group-marks17206
Node: Commodity display style18144
Ref: #commodity-display-style18307
Node: Transaction prices19711
Ref: #transaction-prices19883
Node: Lot prices and lot dates22314
Ref: #lot-prices-and-lot-dates22511
Node: Balance assertions22999
Ref: #balance-assertions23185
Node: Assertions and ordering24218
Ref: #assertions-and-ordering24406
Node: Assertions and included files25106
Ref: #assertions-and-included-files25349
Node: Assertions and multiple -f options25682
Ref: #assertions-and-multiple--f-options25938
Node: Assertions and commodities26070
Ref: #assertions-and-commodities26302
Node: Assertions and prices27459
Ref: #assertions-and-prices27673
Node: Assertions and subaccounts28113
Ref: #assertions-and-subaccounts28342
Node: Assertions and virtual postings28666
Ref: #assertions-and-virtual-postings28908
Node: Assertions and precision29050
Ref: #assertions-and-precision29243
Node: Balance assignments29510
Ref: #balance-assignments29684
Node: Balance assignments and prices30848
Ref: #balance-assignments-and-prices31020
Node: Directives31244
Ref: #directives31403
Node: Directives and multiple files36901
Ref: #directives-and-multiple-files37084
Node: Comment blocks37748
Ref: #comment-blocks37931
Node: Including other files38107
Ref: #including-other-files38287
Node: Default year39211
Ref: #default-year39380
Node: Declaring commodities39787
Ref: #declaring-commodities39970
Node: Default commodity41775
Ref: #default-commodity41961
Node: Declaring market prices42850
Ref: #declaring-market-prices43045
Node: Declaring accounts43902
Ref: #declaring-accounts44088
Node: Account comments45013
Ref: #account-comments45176
Node: Account subdirectives45600
Ref: #account-subdirectives45795
Node: Account types46108
Ref: #account-types46292
Node: Account display order49338
Ref: #account-display-order49508
Node: Rewriting accounts50659
Ref: #rewriting-accounts50844
Node: Basic aliases51601
Ref: #basic-aliases51747
Node: Regex aliases52451
Ref: #regex-aliases52623
Node: Combining aliases53342
Ref: #combining-aliases53535
Node: Aliases and multiple files54811
Ref: #aliases-and-multiple-files55020
Node: end aliases55599
Ref: #end-aliases55756
Node: Default parent account55857
Ref: #default-parent-account56025
Node: Periodic transactions56909
Ref: #periodic-transactions57084
Node: Periodic rule syntax58956
Ref: #periodic-rule-syntax59162
Node: Two spaces between period expression and description!59866
Ref: #two-spaces-between-period-expression-and-description60185
Node: Forecasting with periodic transactions60869
Ref: #forecasting-with-periodic-transactions61174
Node: Budgeting with periodic transactions63229
Ref: #budgeting-with-periodic-transactions63468
Node: Auto postings63877
Ref: #auto-postings64017
Node: Auto postings and multiple files66196
Ref: #auto-postings-and-multiple-files66400
Node: Auto postings and dates66609
Ref: #auto-postings-and-dates66883
Node: Auto postings and transaction balancing / inferred amounts / balance assertions67058
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions67409
Node: Auto posting tags67751
Ref: #auto-posting-tags67966

End Tag Table

View File

@ -411,7 +411,7 @@ FILE FORMAT
commodity INR 9,99,99,999.00
commodity 1 000 000.9455
Amount display style
Commodity display style
For each commodity, hledger chooses a consistent format to use when
displaying amounts. (Except price amounts, which are always displayed
as written). The display style is chosen as follows:
@ -437,10 +437,10 @@ FILE FORMAT
see fewer decimal places in reports, use a commodity directive to over-
ride that.
hledger uses banker's rounding: it rounds to the nearest even number,
eg 0.5 displayed with zero decimal places is "0"). (Note, prior to
hledger 1.17.1 this could vary if hledger happened to be built with an
old version of Decimal (<0.5.1); since 1.17.1 it's guaranteed.)
Note, hledger uses banker's rounding: it rounds to the nearest even
number, eg 0.5 displayed with zero decimal places is "0"). (Guaranteed
since hledger 1.17.1; in older versions this could vary if hledger was
built with Decimal < 0.5.1.)
Transaction prices
Within a transaction, you can note an amount's price in another commod-
@ -838,7 +838,7 @@ FILE FORMAT
formats in your data. (Without this, hledger will parse both 1,000
and 1.000 as 1).
3. It declares the amount display style to use in output - decimal and
3. It declares a commodity's display style in output - decimal and
digit group marks, number of decimal places, symbol placement etc.
You are likely to run into one of the problems solved by commodity di-
@ -873,7 +873,7 @@ FILE FORMAT
comma, followed by 0 or more decimal digits.
Note hledger normally uses banker's rounding, so 0.5 displayed with
zero decimal digits is "0". (More at Amount display style.)
zero decimal digits is "0". (More at Commodity display style.)
Default commodity
The D directive sets a default commodity, to be used for amounts with-

View File

@ -3805,6 +3805,10 @@ $ hledger print IMPORTFILE [--new] >> $LEDGER_FILE
.PP
(If you think import should leave amounts implicit like print does,
please test it and send a pull request.)
.SS Commodity display styles
.PP
Imported amounts will be formatted according to the canonical commodity
styles (declared or inferred) in the main journal file.
.SS incomestatement
.PP
incomestatement, is

View File

@ -3218,9 +3218,10 @@ $ hledger import --dry ... | hledger -f- print unknown --ignore-assertions
* Menu:
* Importing balance assignments::
* Commodity display styles::

File: hledger.info, Node: Importing balance assignments, Up: import
File: hledger.info, Node: Importing balance assignments, Next: Commodity display styles, Up: import
3.18.1 Importing balance assignments
------------------------------------
@ -3238,6 +3239,15 @@ $ hledger print IMPORTFILE [--new] >> $LEDGER_FILE
(If you think import should leave amounts implicit like print does,
please test it and send a pull request.)

File: hledger.info, Node: Commodity display styles, Prev: Importing balance assignments, Up: import
3.18.2 Commodity display styles
-------------------------------
Imported amounts will be formatted according to the canonical commodity
styles (declared or inferred) in the main journal file.

File: hledger.info, Node: incomestatement, Next: notes, Prev: import, Up: COMMANDS
@ -4252,60 +4262,62 @@ Node: help111433
Ref: #help111533
Node: import112614
Ref: #import112728
Node: Importing balance assignments113621
Ref: #importing-balance-assignments113769
Node: incomestatement114418
Ref: #incomestatement114551
Node: notes115896
Ref: #notes116009
Node: payees116377
Ref: #payees116483
Node: prices116903
Ref: #prices117009
Node: print117350
Ref: #print117460
Node: print-unique122256
Ref: #print-unique122382
Node: register122667
Ref: #register122794
Node: Custom register output127243
Ref: #custom-register-output127372
Node: register-match128709
Ref: #register-match128843
Node: rewrite129194
Ref: #rewrite129309
Node: Re-write rules in a file131164
Ref: #re-write-rules-in-a-file131298
Node: Diff output format132508
Ref: #diff-output-format132677
Node: rewrite vs print --auto133769
Ref: #rewrite-vs.-print---auto133948
Node: roi134504
Ref: #roi134602
Node: stats135614
Ref: #stats135713
Node: tags136501
Ref: #tags136599
Node: test137118
Ref: #test137226
Node: Add-on commands137973
Ref: #add-on-commands138090
Node: ui139433
Ref: #ui139521
Node: web139575
Ref: #web139678
Node: iadd139794
Ref: #iadd139905
Node: interest139987
Ref: #interest140094
Node: ENVIRONMENT140334
Ref: #environment140446
Node: FILES141431
Ref: #files-1141534
Node: LIMITATIONS141747
Ref: #limitations141866
Node: TROUBLESHOOTING142608
Ref: #troubleshooting142721
Node: Importing balance assignments113650
Ref: #importing-balance-assignments113831
Node: Commodity display styles114480
Ref: #commodity-display-styles114651
Node: incomestatement114780
Ref: #incomestatement114913
Node: notes116258
Ref: #notes116371
Node: payees116739
Ref: #payees116845
Node: prices117265
Ref: #prices117371
Node: print117712
Ref: #print117822
Node: print-unique122618
Ref: #print-unique122744
Node: register123029
Ref: #register123156
Node: Custom register output127605
Ref: #custom-register-output127734
Node: register-match129071
Ref: #register-match129205
Node: rewrite129556
Ref: #rewrite129671
Node: Re-write rules in a file131526
Ref: #re-write-rules-in-a-file131660
Node: Diff output format132870
Ref: #diff-output-format133039
Node: rewrite vs print --auto134131
Ref: #rewrite-vs.-print---auto134310
Node: roi134866
Ref: #roi134964
Node: stats135976
Ref: #stats136075
Node: tags136863
Ref: #tags136961
Node: test137480
Ref: #test137588
Node: Add-on commands138335
Ref: #add-on-commands138452
Node: ui139795
Ref: #ui139883
Node: web139937
Ref: #web140040
Node: iadd140156
Ref: #iadd140267
Node: interest140349
Ref: #interest140456
Node: ENVIRONMENT140696
Ref: #environment140808
Node: FILES141793
Ref: #files-1141896
Node: LIMITATIONS142109
Ref: #limitations142228
Node: TROUBLESHOOTING142970
Ref: #troubleshooting143083

End Tag Table

View File

@ -2777,6 +2777,10 @@ COMMANDS
(If you think import should leave amounts implicit like print does,
please test it and send a pull request.)
Commodity display styles
Imported amounts will be formatted according to the canonical commodity
styles (declared or inferred) in the main journal file.
incomestatement
incomestatement, is
This command displays an income statement, showing revenues and ex-