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

;doc: regen help/manuals

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2020-02-22 11:33:50 -08:00
parent b9b5702946
commit 696ec4998b
18 changed files with 1246 additions and 1168 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

104
hledger-lib/hledger_csv.info
View File

@ -974,58 +974,58 @@ Node: Basic2413
Ref: #basic2513 Ref: #basic2513
Node: Bank of Ireland3055 Node: Bank of Ireland3055
Ref: #bank-of-ireland3190 Ref: #bank-of-ireland3190
Node: Amazon4653 Node: Amazon4652
Ref: #amazon4771 Ref: #amazon4770
Node: Paypal6704 Node: Paypal6702
Ref: #paypal6798 Ref: #paypal6796
Node: CSV RULES14681 Node: CSV RULES14675
Ref: #csv-rules14790 Ref: #csv-rules14784
Node: skip15066 Node: skip15060
Ref: #skip15159 Ref: #skip15153
Node: fields15534 Node: fields15528
Ref: #fields15656 Ref: #fields15650
Node: Transaction field names16821 Node: Transaction field names16815
Ref: #transaction-field-names16981 Ref: #transaction-field-names16975
Node: Posting field names17092 Node: Posting field names17086
Ref: #posting-field-names17244 Ref: #posting-field-names17238
Node: field assignment18535 Node: field assignment18529
Ref: #field-assignment18678 Ref: #field-assignment18672
Node: separator19496 Node: separator19490
Ref: #separator19625 Ref: #separator19619
Node: if20036 Node: if20030
Ref: #if20138 Ref: #if20132
Node: end21854 Node: end21848
Ref: #end21960 Ref: #end21954
Node: date-format22184 Node: date-format22178
Ref: #date-format22316 Ref: #date-format22310
Node: newest-first23065 Node: newest-first23059
Ref: #newest-first23203 Ref: #newest-first23197
Node: include23886 Node: include23880
Ref: #include24015 Ref: #include24009
Node: balance-type24459 Node: balance-type24453
Ref: #balance-type24579 Ref: #balance-type24573
Node: TIPS25279 Node: TIPS25273
Ref: #tips25361 Ref: #tips25355
Node: Rapid feedback25617 Node: Rapid feedback25611
Ref: #rapid-feedback25734 Ref: #rapid-feedback25728
Node: Valid CSV26194 Node: Valid CSV26188
Ref: #valid-csv26324 Ref: #valid-csv26318
Node: File Extension26516 Node: File Extension26510
Ref: #file-extension26668 Ref: #file-extension26662
Node: Reading multiple CSV files27078 Node: Reading multiple CSV files27072
Ref: #reading-multiple-csv-files27263 Ref: #reading-multiple-csv-files27257
Node: Valid transactions27504 Node: Valid transactions27498
Ref: #valid-transactions27682 Ref: #valid-transactions27676
Node: Deduplicating importing28310 Node: Deduplicating importing28304
Ref: #deduplicating-importing28489 Ref: #deduplicating-importing28483
Node: Setting amounts29522 Node: Setting amounts29516
Ref: #setting-amounts29691 Ref: #setting-amounts29685
Node: Setting currency/commodity30677 Node: Setting currency/commodity30671
Ref: #setting-currencycommodity30869 Ref: #setting-currencycommodity30863
Node: Referencing other fields31672 Node: Referencing other fields31666
Ref: #referencing-other-fields31872 Ref: #referencing-other-fields31866
Node: How CSV rules are evaluated32769 Node: How CSV rules are evaluated32763
Ref: #how-csv-rules-are-evaluated32942 Ref: #how-csv-rules-are-evaluated32936
 
End Tag Table End Tag Table

69
hledger-lib/hledger_journal.5
View File

@ -573,15 +573,15 @@ commodity INR 9,99,99,999.00
commodity 1 000 000.9455 commodity 1 000 000.9455
\f[R] \f[R]
.fi .fi
.SS Amount display format .SS Amount display style
.PP .PP
For each commodity, hledger chooses a consistent format to use when For each commodity, hledger chooses a consistent format to use when
displaying amounts. displaying amounts.
(Except price amounts, which are always displayed as written). (Except price amounts, which are always displayed as written).
The display format is chosen as follows: The display style is chosen as follows:
.IP \[bu] 2 .IP \[bu] 2
If there is a commodity directive for the commodity, that format is used If there is a commodity directive (or default commodity directive) for
(see examples above). the commodity, that format is used (see examples above).
.IP \[bu] 2 .IP \[bu] 2
Otherwise the format of the first posting amount in that commodity seen Otherwise the format of the first posting amount in that commodity seen
in the journal is used. in the journal is used.
@ -591,13 +591,16 @@ maximum from all posting amounts in that commmodity.
Or if there are no such amounts in the journal, a default format is used Or if there are no such amounts in the journal, a default format is used
(like \f[C]$1000.00\f[R]). (like \f[C]$1000.00\f[R]).
.PP .PP
Price amounts, and amounts in \f[C]D\f[R] directives don\[aq]t affect Transaction prices don\[aq]t affect the amount display style directly,
the amount display format directly, but occasionally they can do so but occasionally they can do so indirectly (eg when an posting\[aq]s
indirectly. amount is inferred using a transaction price).
(Eg when D\[aq]s default commodity is applied to a commodity-less If you find this causing problems, use a commodity directive to fix the
amount, or when an amountless posting is balanced using a price\[aq]s display style.
commodity, or when -V is used.) If you find this causing problems, use a .PP
commodity directive to set the display format. In summary: amounts will be displayed much as they appear in your
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.
.SS Transaction prices .SS Transaction prices
.PP .PP
Within a transaction, you can note an amount\[aq]s price in another Within a transaction, you can note an amount\[aq]s price in another
@ -753,9 +756,6 @@ Use include or concatenate the files instead.
The asserted balance must be a simple single-commodity amount, and in The asserted balance must be a simple single-commodity amount, and in
fact the assertion checks only this commodity\[aq]s balance within the fact the assertion checks only this commodity\[aq]s balance within the
(possibly multi-commodity) account balance. (possibly multi-commodity) account balance.
.PD 0
.P
.PD
This is how assertions work in Ledger also. This is how assertions work in Ledger also.
We could call this a \[dq]partial\[dq] balance assertion. We could call this a \[dq]partial\[dq] balance assertion.
.PP .PP
@ -1130,12 +1130,13 @@ The \f[C]commodity\f[R] directive has several functions:
It declares commodities which may be used in the journal. It declares commodities which may be used in the journal.
This is currently not enforced, but can serve as documentation. This is currently not enforced, but can serve as documentation.
.IP "2." 3 .IP "2." 3
It declares what decimal mark character to expect when parsing input - It declares what decimal mark character (period or comma) to expect when
useful to disambiguate international number formats in your data. parsing input - useful to disambiguate international number formats in
your data.
(Without this, hledger will parse both \f[C]1,000\f[R] and (Without this, hledger will parse both \f[C]1,000\f[R] and
\f[C]1.000\f[R] as 1). \f[C]1.000\f[R] as 1).
.IP "3." 3 .IP "3." 3
It declares the amount display format to use in output - decimal and It declares the amount display style to use in output - decimal and
digit group marks, number of decimal places, symbol placement etc. digit group marks, number of decimal places, symbol placement etc.
.PP .PP
You are likely to run into one of the problems solved by commodity You are likely to run into one of the problems solved by commodity
@ -1180,26 +1181,34 @@ The number must include a decimal mark: either a period or a comma,
followed by 0 or more decimal digits. followed by 0 or more decimal digits.
.SS Default commodity .SS Default commodity
.PP .PP
The \f[C]D\f[R] directive sets a default commodity (and display format), The \f[C]D\f[R] directive sets a default commodity, to be used for
to be used for amounts without a commodity symbol (ie, plain numbers). amounts without a commodity symbol (ie, plain numbers).
(Note this differs from Ledger\[aq]s default commodity directive.) The This commodity will be applied to all subsequent commodity-less amounts,
commodity and display format will be applied to all subsequent or until the next \f[C]D\f[R] directive.
commodity-less amounts, or until the next \f[C]D\f[R] directive. (Note, this is different from Ledger\[aq]s \f[C]D\f[R].)
.PP
For compatibility/historical reasons, \f[C]D\f[R] also acts like a
\f[C]commodity\f[R] directive, setting the commodity\[aq]s display style
(for output) and decimal mark (for parsing input).
As with \f[C]commodity\f[R], the amount must always be written with a
decimal mark (period or comma).
If both directives are used, \f[C]commodity\f[R]\[aq]s style takes
precedence.
.PP
The syntax is \f[C]D AMOUNT\f[R].
Eg:
.IP .IP
.nf .nf
\f[C] \f[C]
; commodity-less amounts should be treated as dollars ; commodity-less amounts should be treated as dollars
; (and displayed with symbol on the left, thousands separators and two decimal places) ; (and displayed with the dollar sign on the left, thousands separators and two decimal places)
D $1,000.00 D $1,000.00
1/1 1/1
a 5 ; <- commodity-less amount, becomes $1 a 5 ; <- commodity-less amount, parsed as $5 and displayed as $5.00
b b
\f[R] \f[R]
.fi .fi
.PP
As with the \f[C]commodity\f[R] directive, the amount must always be
written with a decimal point.
.SS Market prices .SS Market prices
.PP .PP
The \f[C]P\f[R] directive declares a market price, which is an exchange The \f[C]P\f[R] directive declares a market price, which is an exchange
@ -1331,7 +1340,7 @@ account assets ; type:Asset
account liabilities ; type:Liability account liabilities ; type:Liability
account equity ; type:Equity account equity ; type:Equity
account revenues ; type:Revenue account revenues ; type:Revenue
account expenses ; type:Expenses account expenses ; type:Expense
\f[R] \f[R]
.fi .fi
.SS Account types declared with account type codes .SS Account types declared with account type codes
@ -1767,8 +1776,8 @@ And each \[dq]posting\[dq] is actually a posting-generating rule:
.nf .nf
\f[C] \f[C]
= QUERY = QUERY
ACCT AMT ACCOUNT AMOUNT
ACCT [AMT] ACCOUNT [AMOUNT]
... ...
\f[R] \f[R]
.fi .fi

251
hledger-lib/hledger_journal.info
View File

@ -479,10 +479,10 @@ comma:
* Menu: * Menu:
* Digit group marks:: * Digit group marks::
* Amount display format:: * Amount display style::
 
File: hledger_journal.info, Node: Digit group marks, Next: Amount display format, Up: Amounts File: hledger_journal.info, Node: Digit group marks, Next: Amount display style, Up: Amounts
1.8.1 Digit group marks 1.8.1 Digit group marks
----------------------- -----------------------
@ -515,17 +515,17 @@ commodity INR 9,99,99,999.00
commodity 1 000 000.9455 commodity 1 000 000.9455
 
File: hledger_journal.info, Node: Amount display format, Prev: Digit group marks, Up: Amounts File: hledger_journal.info, Node: Amount display style, Prev: Digit group marks, Up: Amounts
1.8.2 Amount display format 1.8.2 Amount display style
--------------------------- --------------------------
For each commodity, hledger chooses a consistent format to use when For each commodity, hledger chooses a consistent format to use when
displaying amounts. (Except price amounts, which are always displayed displaying amounts. (Except price amounts, which are always displayed
as written). The display format is chosen as follows: as written). The display style is chosen as follows:
* If there is a commodity directive for the commodity, that format is * If there is a commodity directive (or default commodity directive)
used (see examples above). for the commodity, that format is used (see examples above).
* Otherwise the format of the first posting amount in that commodity * Otherwise the format of the first posting amount in that commodity
seen in the journal is used. But the number of decimal places seen in the journal is used. But the number of decimal places
@ -535,12 +535,15 @@ as written). The display format is chosen as follows:
* Or if there are no such amounts in the journal, a default format is * Or if there are no such amounts in the journal, a default format is
used (like '$1000.00'). used (like '$1000.00').
Price amounts, and amounts in 'D' directives don't affect the amount Transaction prices don't affect the amount display style directly,
display format directly, but occasionally they can do so indirectly. but occasionally they can do so indirectly (eg when an posting's amount
(Eg when D's default commodity is applied to a commodity-less amount, or is inferred using a transaction price). If you find this causing
when an amountless posting is balanced using a price's commodity, or problems, use a commodity directive to fix the display style.
when -V is used.) If you find this causing problems, use a commodity
directive to set the display format. In summary: amounts will be displayed much as they appear in your
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.
 
File: hledger_journal.info, Node: Transaction prices, Next: Balance Assertions, Prev: Amounts, Up: Transactions File: hledger_journal.info, Node: Transaction prices, Next: Balance Assertions, Prev: Amounts, Up: Transactions
@ -691,9 +694,8 @@ File: hledger_journal.info, Node: Assertions and commodities, Next: Assertions
The asserted balance must be a simple single-commodity amount, and in The asserted balance must be a simple single-commodity amount, and in
fact the assertion checks only this commodity's balance within the fact the assertion checks only this commodity's balance within the
(possibly multi-commodity) account balance. (possibly multi-commodity) account balance. This is how assertions work
This is how assertions work in Ledger also. We could call this a in Ledger also. We could call this a "partial" balance assertion.
"partial" balance assertion.
To assert the balance of more than one commodity in an account, you To assert the balance of more than one commodity in an account, you
can write multiple postings, each asserting one commodity's balance. can write multiple postings, each asserting one commodity's balance.
@ -1011,14 +1013,13 @@ The 'commodity' directive has several functions:
1. It declares commodities which may be used in the journal. This is 1. It declares commodities which may be used in the journal. This is
currently not enforced, but can serve as documentation. currently not enforced, but can serve as documentation.
2. It declares what decimal mark character to expect when parsing 2. It declares what decimal mark character (period or comma) to expect
input - useful to disambiguate international number formats in your when parsing input - useful to disambiguate international number
data. (Without this, hledger will parse both '1,000' and '1.000' formats in your data. (Without this, hledger will parse both
as 1). '1,000' and '1.000' as 1).
3. It declares the amount display format to use in output - decimal 3. It declares the amount display style to use in output - decimal and
and digit group marks, number of decimal places, symbol placement digit group marks, number of decimal places, symbol placement etc.
etc.
You are likely to run into one of the problems solved by commodity You are likely to run into one of the problems solved by commodity
directives, sooner or later, so it's a good idea to just always use them directives, sooner or later, so it's a good idea to just always use them
@ -1057,23 +1058,27 @@ File: hledger_journal.info, Node: Default commodity, Next: Market prices, Pre
1.12.5 Default commodity 1.12.5 Default commodity
------------------------ ------------------------
The 'D' directive sets a default commodity (and display format), to be The 'D' directive sets a default commodity, to be used for amounts
used for amounts without a commodity symbol (ie, plain numbers). (Note without a commodity symbol (ie, plain numbers). This commodity will be
this differs from Ledger's default commodity directive.) The commodity applied to all subsequent commodity-less amounts, or until the next 'D'
and display format will be applied to all subsequent commodity-less directive. (Note, this is different from Ledger's 'D'.)
amounts, or until the next 'D' directive.
For compatibility/historical reasons, 'D' also acts like a
'commodity' directive, setting the commodity's display style (for
output) and decimal mark (for parsing input). As with 'commodity', the
amount must always be written with a decimal mark (period or comma). If
both directives are used, 'commodity''s style takes precedence.
The syntax is 'D AMOUNT'. Eg:
; commodity-less amounts should be treated as dollars ; commodity-less amounts should be treated as dollars
; (and displayed with symbol on the left, thousands separators and two decimal places) ; (and displayed with the dollar sign on the left, thousands separators and two decimal places)
D $1,000.00 D $1,000.00
1/1 1/1
a 5 ; <- commodity-less amount, becomes $1 a 5 ; <- commodity-less amount, parsed as $5 and displayed as $5.00
b b
As with the 'commodity' directive, the amount must always be written
with a decimal point.
 
File: hledger_journal.info, Node: Market prices, Next: Declaring accounts, Prev: Default commodity, Up: Directives File: hledger_journal.info, Node: Market prices, Next: Declaring accounts, Prev: Default commodity, Up: Directives
@ -1197,7 +1202,7 @@ account assets ; type:Asset
account liabilities ; type:Liability account liabilities ; type:Liability
account equity ; type:Equity account equity ; type:Equity
account revenues ; type:Revenue account revenues ; type:Revenue
account expenses ; type:Expenses account expenses ; type:Expense
Account types declared with account type codes Or, you can write one Account types declared with account type codes Or, you can write one
of those letters separated from the account name by two or more spaces, of those letters separated from the account name by two or more spaces,
@ -1612,8 +1617,8 @@ certain postings (mnemonic: '=' suggests matching). And each "posting"
is actually a posting-generating rule: is actually a posting-generating rule:
= QUERY = QUERY
ACCT AMT ACCOUNT AMOUNT
ACCT [AMT] ACCOUNT [AMOUNT]
... ...
These posting-generating rules look like normal postings, except the These posting-generating rules look like normal postings, except the
@ -1754,92 +1759,92 @@ Node: Postings12506
Ref: #postings12634 Ref: #postings12634
Node: Virtual Postings13660 Node: Virtual Postings13660
Ref: #virtual-postings13777 Ref: #virtual-postings13777
Node: Account names15083 Node: Account names15082
Ref: #account-names15224 Ref: #account-names15223
Node: Amounts15711 Node: Amounts15710
Ref: #amounts15850 Ref: #amounts15849
Node: Digit group marks16783 Node: Digit group marks16781
Ref: #digit-group-marks16932 Ref: #digit-group-marks16929
Node: Amount display format17870 Node: Amount display style17867
Ref: #amount-display-format18027 Ref: #amount-display-style18021
Node: Transaction prices19052 Node: Transaction prices19182
Ref: #transaction-prices19218 Ref: #transaction-prices19348
Node: Balance Assertions21484 Node: Balance Assertions21614
Ref: #balance-assertions21664 Ref: #balance-assertions21794
Node: Assertions and ordering22697 Node: Assertions and ordering22827
Ref: #assertions-and-ordering22885 Ref: #assertions-and-ordering23015
Node: Assertions and included files23585 Node: Assertions and included files23715
Ref: #assertions-and-included-files23828 Ref: #assertions-and-included-files23958
Node: Assertions and multiple -f options24161 Node: Assertions and multiple -f options24291
Ref: #assertions-and-multiple--f-options24417 Ref: #assertions-and-multiple--f-options24547
Node: Assertions and commodities24549 Node: Assertions and commodities24679
Ref: #assertions-and-commodities24781 Ref: #assertions-and-commodities24911
Node: Assertions and prices25937 Node: Assertions and prices26068
Ref: #assertions-and-prices26151 Ref: #assertions-and-prices26282
Node: Assertions and subaccounts26591 Node: Assertions and subaccounts26722
Ref: #assertions-and-subaccounts26820 Ref: #assertions-and-subaccounts26951
Node: Assertions and virtual postings27144 Node: Assertions and virtual postings27275
Ref: #assertions-and-virtual-postings27386 Ref: #assertions-and-virtual-postings27517
Node: Assertions and precision27528 Node: Assertions and precision27659
Ref: #assertions-and-precision27721 Ref: #assertions-and-precision27852
Node: Balance Assignments27988 Node: Balance Assignments28119
Ref: #balance-assignments28162 Ref: #balance-assignments28293
Node: Balance assignments and prices29327 Node: Balance assignments and prices29457
Ref: #balance-assignments-and-prices29499 Ref: #balance-assignments-and-prices29629
Node: Directives29723 Node: Directives29853
Ref: #directives29882 Ref: #directives30012
Node: Comment blocks35530 Node: Comment blocks35660
Ref: #comment-blocks35675 Ref: #comment-blocks35805
Node: Including other files35851 Node: Including other files35981
Ref: #including-other-files36031 Ref: #including-other-files36161
Node: Default year36439 Node: Default year36569
Ref: #default-year36608 Ref: #default-year36738
Node: Declaring commodities37015 Node: Declaring commodities37145
Ref: #declaring-commodities37198 Ref: #declaring-commodities37328
Node: Default commodity38859 Node: Default commodity39001
Ref: #default-commodity39035 Ref: #default-commodity39177
Node: Market prices39669 Node: Market prices40066
Ref: #market-prices39834 Ref: #market-prices40231
Node: Declaring accounts40675 Node: Declaring accounts41072
Ref: #declaring-accounts40851 Ref: #declaring-accounts41248
Node: Account comments41776 Node: Account comments42173
Ref: #account-comments41939 Ref: #account-comments42336
Node: Account subdirectives42363 Node: Account subdirectives42760
Ref: #account-subdirectives42558 Ref: #account-subdirectives42955
Node: Account types42871 Node: Account types43268
Ref: #account-types43055 Ref: #account-types43452
Node: Account display order44697 Node: Account display order45091
Ref: #account-display-order44867 Ref: #account-display-order45261
Node: Rewriting accounts46018 Node: Rewriting accounts46412
Ref: #rewriting-accounts46203 Ref: #rewriting-accounts46597
Node: Basic aliases46929 Node: Basic aliases47323
Ref: #basic-aliases47075 Ref: #basic-aliases47469
Node: Regex aliases47779 Node: Regex aliases48173
Ref: #regex-aliases47951 Ref: #regex-aliases48345
Node: Combining aliases48669 Node: Combining aliases49063
Ref: #combining-aliases48847 Ref: #combining-aliases49241
Node: end aliases50123 Node: end aliases50517
Ref: #end-aliases50271 Ref: #end-aliases50665
Node: Default parent account50372 Node: Default parent account50766
Ref: #default-parent-account50538 Ref: #default-parent-account50932
Node: Periodic transactions51422 Node: Periodic transactions51816
Ref: #periodic-transactions51621 Ref: #periodic-transactions52015
Node: Periodic rule syntax53493 Node: Periodic rule syntax53887
Ref: #periodic-rule-syntax53699 Ref: #periodic-rule-syntax54093
Node: Two spaces between period expression and description!54403 Node: Two spaces between period expression and description!54797
Ref: #two-spaces-between-period-expression-and-description54722 Ref: #two-spaces-between-period-expression-and-description55116
Node: Forecasting with periodic transactions55406 Node: Forecasting with periodic transactions55800
Ref: #forecasting-with-periodic-transactions55711 Ref: #forecasting-with-periodic-transactions56105
Node: Budgeting with periodic transactions57737 Node: Budgeting with periodic transactions58131
Ref: #budgeting-with-periodic-transactions57976 Ref: #budgeting-with-periodic-transactions58370
Node: Auto postings / transaction modifiers58425 Node: Auto postings / transaction modifiers58819
Ref: #auto-postings-transaction-modifiers58637 Ref: #auto-postings-transaction-modifiers59031
Node: Auto postings and dates61122 Node: Auto postings and dates61527
Ref: #auto-postings-and-dates61379 Ref: #auto-postings-and-dates61784
Node: Auto postings and transaction balancing / inferred amounts / balance assertions61554 Node: Auto postings and transaction balancing / inferred amounts / balance assertions61959
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions61929 Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions62334
Node: Auto posting tags62307 Node: Auto posting tags62712
Ref: #auto-posting-tags62546 Ref: #auto-posting-tags62951
 
End Tag Table End Tag Table

70
hledger-lib/hledger_journal.txt
View File

@ -403,13 +403,13 @@ FILE FORMAT
commodity INR 9,99,99,999.00 commodity INR 9,99,99,999.00
commodity 1 000 000.9455 commodity 1 000 000.9455
Amount display format Amount display style
For each commodity, hledger chooses a consistent format to use when For each commodity, hledger chooses a consistent format to use when
displaying amounts. (Except price amounts, which are always displayed displaying amounts. (Except price amounts, which are always displayed
as written). The display format is chosen as follows: as written). The display style is chosen as follows:
o If there is a commodity directive for the commodity, that format is o If there is a commodity directive (or default commodity directive)
used (see examples above). for the commodity, that format is used (see examples above).
o Otherwise the format of the first posting amount in that commodity o Otherwise the format of the first posting amount in that commodity
seen in the journal is used. But the number of decimal places ("pre- seen in the journal is used. But the number of decimal places ("pre-
@ -419,12 +419,15 @@ FILE FORMAT
o Or if there are no such amounts in the journal, a default format is o Or if there are no such amounts in the journal, a default format is
used (like $1000.00). used (like $1000.00).
Price amounts, and amounts in D directives don't affect the amount dis- Transaction prices don't affect the amount display style directly, but
play format directly, but occasionally they can do so indirectly. (Eg occasionally they can do so indirectly (eg when an posting's amount is
when D's default commodity is applied to a commodity-less amount, or inferred using a transaction price). If you find this causing prob-
when an amountless posting is balanced using a price's commodity, or lems, use a commodity directive to fix the display style.
when -V is used.) If you find this causing problems, use a commodity
directive to set the display format. In summary: amounts will be displayed much as they appear in your jour-
nal, with the max observed number of decimal places. If you want to
see fewer decimal places in reports, use a commodity directive to over-
ride that.
Transaction prices Transaction prices
Within a transaction, you can note an amount's price in another commod- Within a transaction, you can note an amount's price in another commod-
@ -533,9 +536,8 @@ FILE FORMAT
Assertions and commodities Assertions and commodities
The asserted balance must be a simple single-commodity amount, and in The asserted balance must be a simple single-commodity amount, and in
fact the assertion checks only this commodity's balance within the fact the assertion checks only this commodity's balance within the
(possibly multi-commodity) account balance. (possibly multi-commodity) account balance. This is how assertions
This is how assertions work in Ledger also. We could call this a "par- work in Ledger also. We could call this a "partial" balance assertion.
tial" balance assertion.
To assert the balance of more than one commodity in an account, you can To assert the balance of more than one commodity in an account, you can
write multiple postings, each asserting one commodity's balance. write multiple postings, each asserting one commodity's balance.
@ -719,6 +721,9 @@ FILE FORMAT
dis- how to display amounts of a commodity in reports (symbol side dis- how to display amounts of a commodity in reports (symbol side
play and spacing, digit groups, decimal separator, decimal places) play and spacing, digit groups, decimal separator, decimal places)
style style
direc- which entries and (when there are multiple files) which files direc- which entries and (when there are multiple files) which files
tive are affected by a directive tive are affected by a directive
scope scope
@ -779,11 +784,12 @@ FILE FORMAT
1. It declares commodities which may be used in the journal. This is 1. It declares commodities which may be used in the journal. This is
currently not enforced, but can serve as documentation. currently not enforced, but can serve as documentation.
2. It declares what decimal mark character to expect when parsing input 2. It declares what decimal mark character (period or comma) to expect
- useful to disambiguate international number formats in your data. when parsing input - useful to disambiguate international number
(Without this, hledger will parse both 1,000 and 1.000 as 1). formats in your data. (Without this, hledger will parse both 1,000
and 1.000 as 1).
3. It declares the amount display format to use in output - decimal and 3. It declares the amount display style to use in output - decimal and
digit group marks, number of decimal places, symbol placement etc. digit group marks, number of decimal places, symbol placement etc.
You are likely to run into one of the problems solved by commodity di- You are likely to run into one of the problems solved by commodity di-
@ -818,23 +824,27 @@ FILE FORMAT
comma, followed by 0 or more decimal digits. comma, followed by 0 or more decimal digits.
Default commodity Default commodity
The D directive sets a default commodity (and display format), to be The D directive sets a default commodity, to be used for amounts with-
used for amounts without a commodity symbol (ie, plain numbers). (Note out a commodity symbol (ie, plain numbers). This commodity will be ap-
this differs from Ledger's default commodity directive.) The commodity plied to all subsequent commodity-less amounts, or until the next D di-
and display format will be applied to all subsequent commodity-less rective. (Note, this is different from Ledger's D.)
amounts, or until the next D directive.
For compatibility/historical reasons, D also acts like a commodity di-
rective, setting the commodity's display style (for output) and decimal
mark (for parsing input). As with commodity, the amount must always be
written with a decimal mark (period or comma). If both directives are
used, commodity's style takes precedence.
The syntax is D AMOUNT. Eg:
; commodity-less amounts should be treated as dollars ; commodity-less amounts should be treated as dollars
; (and displayed with symbol on the left, thousands separators and two decimal places) ; (and displayed with the dollar sign on the left, thousands separators and two decimal places)
D $1,000.00 D $1,000.00
1/1 1/1
a 5 ; <- commodity-less amount, becomes $1 a 5 ; <- commodity-less amount, parsed as $5 and displayed as $5.00
b b
As with the commodity directive, the amount must always be written with
a decimal point.
Market prices Market prices
The P directive declares a market price, which is an exchange rate be- The P directive declares a market price, which is an exchange rate be-
tween two commodities on a certain date. (In Ledger, they are called tween two commodities on a certain date. (In Ledger, they are called
@ -935,7 +945,7 @@ FILE FORMAT
account liabilities ; type:Liability account liabilities ; type:Liability
account equity ; type:Equity account equity ; type:Equity
account revenues ; type:Revenue account revenues ; type:Revenue
account expenses ; type:Expenses account expenses ; type:Expense
Account types declared with account type codes Account types declared with account type codes
Or, you can write one of those letters separated from the account name Or, you can write one of those letters separated from the account name
@ -1281,8 +1291,8 @@ FILE FORMAT
actually a posting-generating rule: actually a posting-generating rule:
= QUERY = QUERY
ACCT AMT ACCOUNT AMOUNT
ACCT [AMT] ACCOUNT [AMOUNT]
... ...
These posting-generating rules look like normal postings, except the These posting-generating rules look like normal postings, except the

36
hledger-ui/hledger-ui.1
View File

@ -26,19 +26,17 @@ limited data entry capability.
It is easier than hledger\[aq]s command-line interface, and sometimes It is easier than hledger\[aq]s command-line interface, and sometimes
quicker and more convenient than the web interface. quicker and more convenient than the web interface.
.PP .PP
Note hledger-ui has some different defaults (experimental):
.IP \[bu] 2
it generates rule-based transactions and postings by default (--forecast
and --auto are always on).
.IP \[bu] 2
it hides transactions dated in the future by default (change this with
--future or the F key).
.PP
Like hledger, it reads data from one or more files in hledger journal, Like hledger, it reads data from one or more files in hledger journal,
timeclock, timedot, or CSV format specified with \f[C]-f\f[R], or timeclock, timedot, or CSV format specified with \f[C]-f\f[R], or
\f[C]$LEDGER_FILE\f[R], or \f[C]$HOME/.hledger.journal\f[R] (on windows, \f[C]$LEDGER_FILE\f[R], or \f[C]$HOME/.hledger.journal\f[R] (on windows,
perhaps \f[C]C:/Users/USER/.hledger.journal\f[R]). perhaps \f[C]C:/Users/USER/.hledger.journal\f[R]).
For more about this see hledger(1), hledger_journal(5) etc. For more about this see hledger(1), hledger_journal(5) etc.
.PP
Unlike hledger, hledger-ui hides all future-dated transactions by
default.
They can be revealed, along with any rule-generated periodic
transactions, by pressing the F key (or starting with --forecast) to
enable \[dq]forecast mode\[dq].
.SH OPTIONS .SH OPTIONS
.PP .PP
Note: if invoking hledger-ui as a hledger subcommand, write \f[C]--\f[R] Note: if invoking hledger-ui as a hledger subcommand, write \f[C]--\f[R]
@ -64,9 +62,6 @@ show accounts as a list (default)
.TP .TP
\f[B]\f[CB]-T --tree\f[B]\f[R] \f[B]\f[CB]-T --tree\f[B]\f[R]
show accounts as a tree show accounts as a tree
.TP
\f[B]\f[CB]--future\f[B]\f[R]
show transactions dated later than today (normally hidden)
.PP .PP
hledger input options: hledger input options:
.TP .TP
@ -155,8 +150,9 @@ most recent applicable market price, if any)
apply automated posting rules to modify transactions. apply automated posting rules to modify transactions.
.TP .TP
\f[B]\f[CB]--forecast\f[B]\f[R] \f[B]\f[CB]--forecast\f[B]\f[R]
apply periodic transaction rules to generate future transactions, to 6 generate future transactions from periodic transaction rules, for the
months from now or report end date. next 6 months or till report end date.
In hledger-ui, also make ordinary future transactions visible.
.PP .PP
When a reporting option appears more than once in the command line, the When a reporting option appears more than once in the command line, the
last one takes precedence. last one takes precedence.
@ -218,12 +214,11 @@ account depth and transaction status (see below).
\f[C]BACKSPACE\f[R] or \f[C]DELETE\f[R] removes all filters, showing all \f[C]BACKSPACE\f[R] or \f[C]DELETE\f[R] removes all filters, showing all
transactions. transactions.
.PP .PP
As mentioned above, hledger-ui shows auto-generated periodic As mentioned above, by default hledger-ui hides future transactions -
transactions, and hides future transactions (auto-generated or not) by both ordinary transactions recorded in the journal, and periodic
default. transactions generated by rule.
\f[C]F\f[R] toggles showing and hiding these future transactions. \f[C]F\f[R] toggles forecast mode, in which future/forecasted
This is similar to using a query like \f[C]date:-tomorrow\f[R], but more transactions are shown.
convenient.
(experimental) (experimental)
.PP .PP
\f[C]ESCAPE\f[R] removes all filters and jumps back to the top screen. \f[C]ESCAPE\f[R] removes all filters and jumps back to the top screen.
@ -371,9 +366,6 @@ in flat mode but this account has subaccounts which are not shown due to
a depth limit. a depth limit.
In other words, the register always shows the transactions contributing In other words, the register always shows the transactions contributing
to the balance shown on the accounts screen. to the balance shown on the accounts screen.
.PD 0
.P
.PD
Tree mode/flat mode can be toggled with \f[C]T\f[R] here also. Tree mode/flat mode can be toggled with \f[C]T\f[R] here also.
.PP .PP
\f[C]U\f[R] toggles filtering by unmarked status, showing or hiding \f[C]U\f[R] toggles filtering by unmarked status, showing or hiding

73
hledger-ui/hledger-ui.info
View File

@ -22,19 +22,17 @@ limited data entry capability. It is easier than hledger's command-line
interface, and sometimes quicker and more convenient than the web interface, and sometimes quicker and more convenient than the web
interface. interface.
Note hledger-ui has some different defaults (experimental):
* it generates rule-based transactions and postings by default
(-forecast and -auto are always on).
* it hides transactions dated in the future by default (change this
with -future or the F key).
Like hledger, it reads data from one or more files in hledger Like hledger, it reads data from one or more files in hledger
journal, timeclock, timedot, or CSV format specified with '-f', or journal, timeclock, timedot, or CSV format specified with '-f', or
'$LEDGER_FILE', or '$HOME/.hledger.journal' (on windows, perhaps '$LEDGER_FILE', or '$HOME/.hledger.journal' (on windows, perhaps
'C:/Users/USER/.hledger.journal'). For more about this see hledger(1), 'C:/Users/USER/.hledger.journal'). For more about this see hledger(1),
hledger_journal(5) etc. hledger_journal(5) etc.
Unlike hledger, hledger-ui hides all future-dated transactions by
default. They can be revealed, along with any rule-generated periodic
transactions, by pressing the F key (or starting with -forecast) to
enable "forecast mode".
* Menu: * Menu:
* OPTIONS:: * OPTIONS::
@ -75,9 +73,6 @@ the data.
'-T --tree' '-T --tree'
show accounts as a tree show accounts as a tree
'--future'
show transactions dated later than today (normally hidden)
hledger input options: hledger input options:
@ -168,8 +163,9 @@ the data.
apply automated posting rules to modify transactions. apply automated posting rules to modify transactions.
'--forecast' '--forecast'
apply periodic transaction rules to generate future transactions, generate future transactions from periodic transaction rules, for
to 6 months from now or report end date. the next 6 months or till report end date. In hledger-ui, also
make ordinary future transactions visible.
When a reporting option appears more than once in the command line, When a reporting option appears more than once in the command line,
the last one takes precedence. the last one takes precedence.
@ -229,11 +225,10 @@ some common filters like account depth and transaction status (see
below). 'BACKSPACE' or 'DELETE' removes all filters, showing all below). 'BACKSPACE' or 'DELETE' removes all filters, showing all
transactions. transactions.
As mentioned above, hledger-ui shows auto-generated periodic As mentioned above, by default hledger-ui hides future transactions -
transactions, and hides future transactions (auto-generated or not) by both ordinary transactions recorded in the journal, and periodic
default. 'F' toggles showing and hiding these future transactions. transactions generated by rule. 'F' toggles forecast mode, in which
This is similar to using a query like 'date:-tomorrow', but more future/forecasted transactions are shown. (experimental)
convenient. (experimental)
'ESCAPE' removes all filters and jumps back to the top screen. Or, 'ESCAPE' removes all filters and jumps back to the top screen. Or,
it cancels a minibuffer edit or help dialog in progress. it cancels a minibuffer edit or help dialog in progress.
@ -380,8 +375,8 @@ a check register. Each line represents one transaction and shows:
the register if the accounts screen is in tree mode, or if it's in flat the register if the accounts screen is in tree mode, or if it's in flat
mode but this account has subaccounts which are not shown due to a depth mode but this account has subaccounts which are not shown due to a depth
limit. In other words, the register always shows the transactions limit. In other words, the register always shows the transactions
contributing to the balance shown on the accounts screen. contributing to the balance shown on the accounts screen. Tree
Tree mode/flat mode can be toggled with 'T' here also. mode/flat mode can be toggled with 'T' here also.
'U' toggles filtering by unmarked status, showing or hiding unmarked 'U' toggles filtering by unmarked status, showing or hiding unmarked
transactions. Similarly, 'P' toggles pending transactions, and 'C' transactions. Similarly, 'P' toggles pending transactions, and 'C'
@ -504,26 +499,26 @@ program is restarted.
 
Tag Table: Tag Table:
Node: Top71 Node: Top71
Node: OPTIONS1520 Node: OPTIONS1476
Ref: #options1617 Ref: #options1573
Node: KEYS5053 Node: KEYS5004
Ref: #keys5148 Ref: #keys5099
Node: SCREENS9455 Node: SCREENS9375
Ref: #screens9560 Ref: #screens9480
Node: Accounts screen9650 Node: Accounts screen9570
Ref: #accounts-screen9778 Ref: #accounts-screen9698
Node: Register screen11994 Node: Register screen11914
Ref: #register-screen12149 Ref: #register-screen12069
Node: Transaction screen14145 Node: Transaction screen14066
Ref: #transaction-screen14303 Ref: #transaction-screen14224
Node: Error screen15173 Node: Error screen15094
Ref: #error-screen15295 Ref: #error-screen15216
Node: ENVIRONMENT15539 Node: ENVIRONMENT15460
Ref: #environment15653 Ref: #environment15574
Node: FILES16460 Node: FILES16381
Ref: #files16559 Ref: #files16480
Node: BUGS16772 Node: BUGS16693
Ref: #bugs16849 Ref: #bugs16770
 
End Tag Table End Tag Table

34
hledger-ui/hledger-ui.txt
View File

@ -22,20 +22,17 @@ DESCRIPTION
line interface, and sometimes quicker and more convenient than the web line interface, and sometimes quicker and more convenient than the web
interface. interface.
Note hledger-ui has some different defaults (experimental):
o it generates rule-based transactions and postings by default (--fore-
cast and --auto are always on).
o it hides transactions dated in the future by default (change this
with --future or the F key).
Like hledger, it reads data from one or more files in hledger journal, Like hledger, it reads data from one or more files in hledger journal,
timeclock, timedot, or CSV format specified with -f, or $LEDGER_FILE, timeclock, timedot, or CSV format specified with -f, or $LEDGER_FILE,
or $HOME/.hledger.journal (on windows, perhaps or $HOME/.hledger.journal (on windows, perhaps
C:/Users/USER/.hledger.journal). For more about this see hledger(1), C:/Users/USER/.hledger.journal). For more about this see hledger(1),
hledger_journal(5) etc. hledger_journal(5) etc.
Unlike hledger, hledger-ui hides all future-dated transactions by de-
fault. They can be revealed, along with any rule-generated periodic
transactions, by pressing the F key (or starting with --forecast) to
enable "forecast mode".
OPTIONS OPTIONS
Note: if invoking hledger-ui as a hledger subcommand, write -- before Note: if invoking hledger-ui as a hledger subcommand, write -- before
options as shown above. options as shown above.
@ -62,9 +59,6 @@ OPTIONS
-T --tree -T --tree
show accounts as a tree show accounts as a tree
--future
show transactions dated later than today (normally hidden)
hledger input options: hledger input options:
-f FILE --file=FILE -f FILE --file=FILE
@ -151,8 +145,9 @@ OPTIONS
--auto apply automated posting rules to modify transactions. --auto apply automated posting rules to modify transactions.
--forecast --forecast
apply periodic transaction rules to generate future transac- generate future transactions from periodic transaction rules,
tions, to 6 months from now or report end date. for the next 6 months or till report end date. In hledger-ui,
also make ordinary future transactions visible.
When a reporting option appears more than once in the command line, the When a reporting option appears more than once in the command line, the
last one takes precedence. last one takes precedence.
@ -204,11 +199,10 @@ KEYS
common filters like account depth and transaction status (see below). common filters like account depth and transaction status (see below).
BACKSPACE or DELETE removes all filters, showing all transactions. BACKSPACE or DELETE removes all filters, showing all transactions.
As mentioned above, hledger-ui shows auto-generated periodic transac- As mentioned above, by default hledger-ui hides future transactions -
tions, and hides future transactions (auto-generated or not) by de- both ordinary transactions recorded in the journal, and periodic trans-
fault. F toggles showing and hiding these future transactions. This actions generated by rule. F toggles forecast mode, in which fu-
is similar to using a query like date:-tomorrow, but more convenient. ture/forecasted transactions are shown. (experimental)
(experimental)
ESCAPE removes all filters and jumps back to the top screen. Or, it ESCAPE removes all filters and jumps back to the top screen. Or, it
cancels a minibuffer edit or help dialog in progress. cancels a minibuffer edit or help dialog in progress.
@ -330,8 +324,8 @@ SCREENS
the register if the accounts screen is in tree mode, or if it's in flat the register if the accounts screen is in tree mode, or if it's in flat
mode but this account has subaccounts which are not shown due to a mode but this account has subaccounts which are not shown due to a
depth limit. In other words, the register always shows the transac- depth limit. In other words, the register always shows the transac-
tions contributing to the balance shown on the accounts screen. tions contributing to the balance shown on the accounts screen. Tree
Tree mode/flat mode can be toggled with T here also. mode/flat mode can be toggled with T here also.
U toggles filtering by unmarked status, showing or hiding unmarked U toggles filtering by unmarked status, showing or hiding unmarked
transactions. Similarly, P toggles pending transactions, and C toggles transactions. Similarly, P toggles pending transactions, and C toggles

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

@ -176,8 +176,9 @@ most recent applicable market price, if any)
apply automated posting rules to modify transactions. apply automated posting rules to modify transactions.
.TP .TP
\f[B]\f[CB]--forecast\f[B]\f[R] \f[B]\f[CB]--forecast\f[B]\f[R]
apply periodic transaction rules to generate future transactions, to 6 generate future transactions from periodic transaction rules, for the
months from now or report end date. next 6 months or till report end date.
In hledger-ui, also make ordinary future transactions visible.
.PP .PP
When a reporting option appears more than once in the command line, the When a reporting option appears more than once in the command line, the
last one takes precedence. last one takes precedence.

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

@ -187,8 +187,9 @@ before options, as shown in the synopsis above.
apply automated posting rules to modify transactions. apply automated posting rules to modify transactions.
'--forecast' '--forecast'
apply periodic transaction rules to generate future transactions, generate future transactions from periodic transaction rules, for
to 6 months from now or report end date. the next 6 months or till report end date. In hledger-ui, also
make ordinary future transactions visible.
When a reporting option appears more than once in the command line, When a reporting option appears more than once in the command line,
the last one takes precedence. the last one takes precedence.
@ -428,20 +429,20 @@ Tag Table:
Node: Top72 Node: Top72
Node: OPTIONS1752 Node: OPTIONS1752
Ref: #options1857 Ref: #options1857
Node: PERMISSIONS8130 Node: PERMISSIONS8201
Ref: #permissions8269 Ref: #permissions8340
Node: EDITING UPLOADING DOWNLOADING9481 Node: EDITING UPLOADING DOWNLOADING9552
Ref: #editing-uploading-downloading9662 Ref: #editing-uploading-downloading9733
Node: RELOADING10496 Node: RELOADING10567
Ref: #reloading10630 Ref: #reloading10701
Node: JSON API11063 Node: JSON API11134
Ref: #json-api11177 Ref: #json-api11248
Node: ENVIRONMENT12618 Node: ENVIRONMENT12689
Ref: #environment12734 Ref: #environment12805
Node: FILES13467 Node: FILES13538
Ref: #files13567 Ref: #files13638
Node: BUGS13780 Node: BUGS13851
Ref: #bugs13858 Ref: #bugs13929
 
End Tag Table End Tag Table

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

@ -166,8 +166,9 @@ OPTIONS
--auto apply automated posting rules to modify transactions. --auto apply automated posting rules to modify transactions.
--forecast --forecast
apply periodic transaction rules to generate future transac- generate future transactions from periodic transaction rules,
tions, to 6 months from now or report end date. for the next 6 months or till report end date. In hledger-ui,
also make ordinary future transactions visible.
When a reporting option appears more than once in the command line, the When a reporting option appears more than once in the command line, the
last one takes precedence. last one takes precedence.

12
hledger/Hledger/Cli/Commands/Balance.txt
View File

@ -291,14 +291,12 @@ Balance changes in 2008:
(Average is rounded to the dollar here since all journal amounts are) (Average is rounded to the dollar here since all journal amounts are)
Limitations: A limitation of multicolumn balance reports: eliding of boring parent
accounts in tree mode, as in the classic balance report, is not yet
supported.
In multicolumn reports the -V/--value flag uses the market price on the The --transpose flag can be used to exchange the rows and columns of a
report end date, for all columns (not the price on each column's end multicolumn report.
date).
Eliding of boring parent accounts in tree mode, as in the classic
balance report, is not yet supported in multicolumn reports.
Budget report Budget report

3
hledger/Hledger/Cli/Commands/Print.txt
View File

@ -39,7 +39,8 @@ will not appear in the output. Similarly, when a transaction price is
implied but not written, it will not appear in the output. You can use implied but not written, it will not appear in the output. You can use
the -x/--explicit flag to make all amounts and transaction prices the -x/--explicit flag to make all amounts and transaction prices
explicit, which can be useful for troubleshooting or for making your explicit, which can be useful for troubleshooting or for making your
journal more readable and robust against data entry errors. journal more readable and robust against data entry errors. -x is also
implied by using any of -B,-V,-X,--value.
Note, -x/--explicit will cause postings with a multi-commodity amount Note, -x/--explicit will cause postings with a multi-commodity amount
(these can arise when a multi-commodity transaction has an implicit (these can arise when a multi-commodity transaction has an implicit

67
hledger/hledger.1
View File

@ -179,7 +179,7 @@ like this:
assets:bank:checking $1000 = $1000 assets:bank:checking $1000 = $1000
assets:bank:savings $2000 = $2000 assets:bank:savings $2000 = $2000
assets:cash $100 = $100 assets:cash $100 = $100
liabilities:creditcard $-50 = $-$50 liabilities:creditcard $-50 = $-50
equity:opening/closing balances equity:opening/closing balances
\f[R] \f[R]
.fi .fi
@ -628,8 +628,9 @@ most recent applicable market price, if any)
apply automated posting rules to modify transactions. apply automated posting rules to modify transactions.
.TP .TP
\f[B]\f[CB]--forecast\f[B]\f[R] \f[B]\f[CB]--forecast\f[B]\f[R]
apply periodic transaction rules to generate future transactions, to 6 generate future transactions from periodic transaction rules, for the
months from now or report end date. next 6 months or till report end date.
In hledger-ui, also make ordinary future transactions visible.
.PP .PP
When a reporting option appears more than once in the command line, the When a reporting option appears more than once in the command line, the
last one takes precedence. last one takes precedence.
@ -1694,10 +1695,11 @@ more general \f[C]--value\f[R] option:
.IP .IP
.nf .nf
\f[C] \f[C]
--value=TYPE[,COMM] TYPE is cost, end, now or YYYY-MM-DD. --value=TYPE[,COMM] TYPE is cost, then, end, now or YYYY-MM-DD.
COMM is an optional commodity symbol. COMM is an optional commodity symbol.
Shows amounts converted to: Shows amounts converted to:
- cost commodity using transaction prices (then optionally to COMM using market prices at period end(s)) - cost commodity using transaction prices (then optionally to COMM using market prices at period end(s))
- default valuation commodity (or COMM) using market prices at posting dates
- default valuation commodity (or COMM) using market prices at period end(s) - default valuation commodity (or COMM) using market prices at period end(s)
- default valuation commodity (or COMM) using current market prices - default valuation commodity (or COMM) using current market prices
- default valuation commodity (or COMM) using market prices at some date - default valuation commodity (or COMM) using market prices at some date
@ -1710,6 +1712,11 @@ value\[dq] plus a valuation date:
\f[B]\f[CB]--value=cost\f[B]\f[R] \f[B]\f[CB]--value=cost\f[B]\f[R]
Convert amounts to cost, using the prices recorded in transactions. Convert amounts to cost, using the prices recorded in transactions.
.TP .TP
\f[B]\f[CB]--value=then\f[B]\f[R]
Convert amounts to their value in a default valuation commodity, using
market prices on each posting\[aq]s date.
This is currently supported only by the print and register commands.
.TP
\f[B]\f[CB]--value=end\f[B]\f[R] \f[B]\f[CB]--value=end\f[B]\f[R]
Convert amounts to their value in a default valuation commodity, using Convert amounts to their value in a default valuation commodity, using
market prices on the last day of the report period (or if unspecified, market prices on the last day of the report period (or if unspecified,
@ -1905,7 +1912,7 @@ Related: #329, #1083.
.PP .PP
.TS .TS
tab(@); tab(@);
lw(14.4n) lw(13.8n) lw(14.6n) lw(15.2n) lw(12.0n). lw(11.7n) lw(11.2n) lw(11.9n) lw(13.1n) lw(12.4n) lw(9.8n).
T{ T{
Report type Report type
T}@T{ T}@T{
@ -1913,6 +1920,8 @@ T}@T{
T}@T{ T}@T{
\f[C]-V\f[R], \f[C]-X\f[R] \f[C]-V\f[R], \f[C]-X\f[R]
T}@T{ T}@T{
\f[C]--value=then\f[R]
T}@T{
\f[C]--value=end\f[R] \f[C]--value=end\f[R]
T}@T{ T}@T{
\f[C]--value=DATE\f[R], \f[C]--value=now\f[R] \f[C]--value=DATE\f[R], \f[C]--value=now\f[R]
@ -1924,6 +1933,7 @@ T}@T{
T}@T{ T}@T{
T}@T{ T}@T{
T}@T{ T}@T{
T}@T{
T} T}
T{ T{
posting amounts posting amounts
@ -1932,6 +1942,8 @@ cost
T}@T{ T}@T{
value at report end or today value at report end or today
T}@T{ T}@T{
value at posting date
T}@T{
value at report or journal end value at report or journal end
T}@T{ T}@T{
value at DATE/today value at DATE/today
@ -1946,12 +1958,15 @@ T}@T{
unchanged unchanged
T}@T{ T}@T{
unchanged unchanged
T}@T{
unchanged
T} T}
T{ T{
T}@T{ T}@T{
T}@T{ T}@T{
T}@T{ T}@T{
T}@T{ T}@T{
T}@T{
T} T}
T{ T{
\f[B]register\f[R] \f[B]register\f[R]
@ -1959,6 +1974,7 @@ T}@T{
T}@T{ T}@T{
T}@T{ T}@T{
T}@T{ T}@T{
T}@T{
T} T}
T{ T{
starting balance (with -H) starting balance (with -H)
@ -1967,6 +1983,8 @@ cost
T}@T{ T}@T{
value at day before report or journal start value at day before report or journal start
T}@T{ T}@T{
not supported
T}@T{
value at day before report or journal start value at day before report or journal start
T}@T{ T}@T{
value at DATE/today value at DATE/today
@ -1978,6 +1996,8 @@ cost
T}@T{ T}@T{
value at report end or today value at report end or today
T}@T{ T}@T{
value at posting date
T}@T{
value at report or journal end value at report or journal end
T}@T{ T}@T{
value at DATE/today value at DATE/today
@ -1989,6 +2009,8 @@ summarised cost
T}@T{ T}@T{
value at period ends value at period ends
T}@T{ T}@T{
sum of postings in interval, valued at interval start
T}@T{
value at period ends value at period ends
T}@T{ T}@T{
value at DATE/today value at DATE/today
@ -2003,12 +2025,15 @@ T}@T{
sum/average of displayed values sum/average of displayed values
T}@T{ T}@T{
sum/average of displayed values sum/average of displayed values
T}@T{
sum/average of displayed values
T} T}
T{ T{
T}@T{ T}@T{
T}@T{ T}@T{
T}@T{ T}@T{
T}@T{ T}@T{
T}@T{
T} T}
T{ T{
\f[B]balance (bs, bse, cf, is..)\f[R] \f[B]balance (bs, bse, cf, is..)\f[R]
@ -2016,6 +2041,7 @@ T}@T{
T}@T{ T}@T{
T}@T{ T}@T{
T}@T{ T}@T{
T}@T{
T} T}
T{ T{
balances (no report interval) balances (no report interval)
@ -2024,6 +2050,8 @@ sums of costs
T}@T{ T}@T{
value at report end or today of sums of postings value at report end or today of sums of postings
T}@T{ T}@T{
not supported
T}@T{
value at report or journal end of sums of postings value at report or journal end of sums of postings
T}@T{ T}@T{
value at DATE/today of sums of postings value at DATE/today of sums of postings
@ -2035,6 +2063,8 @@ sums of costs
T}@T{ T}@T{
value at period ends of sums of postings value at period ends of sums of postings
T}@T{ T}@T{
not supported
T}@T{
value at period ends of sums of postings value at period ends of sums of postings
T}@T{ T}@T{
value at DATE/today of sums of postings value at DATE/today of sums of postings
@ -2046,6 +2076,8 @@ sums of costs of postings before report start
T}@T{ T}@T{
sums of postings before report start sums of postings before report start
T}@T{ T}@T{
not supported
T}@T{
sums of postings before report start sums of postings before report start
T}@T{ T}@T{
sums of postings before report start sums of postings before report start
@ -2057,6 +2089,8 @@ like balances
T}@T{ T}@T{
like balances like balances
T}@T{ T}@T{
not supported
T}@T{
like balances like balances
T}@T{ T}@T{
like balances like balances
@ -2068,6 +2102,8 @@ sum of displayed values
T}@T{ T}@T{
sum of displayed values sum of displayed values
T}@T{ T}@T{
not supported
T}@T{
sum of displayed values sum of displayed values
T}@T{ T}@T{
sum of displayed values sum of displayed values
@ -2079,6 +2115,8 @@ sums/averages of displayed values
T}@T{ T}@T{
sums/averages of displayed values sums/averages of displayed values
T}@T{ T}@T{
not supported
T}@T{
sums/averages of displayed values sums/averages of displayed values
T}@T{ T}@T{
sums/averages of displayed values sums/averages of displayed values
@ -2090,6 +2128,8 @@ sums of displayed values
T}@T{ T}@T{
sums of displayed values sums of displayed values
T}@T{ T}@T{
not supported
T}@T{
sums of displayed values sums of displayed values
T}@T{ T}@T{
sums of displayed values sums of displayed values
@ -2101,6 +2141,8 @@ sum/average of column totals
T}@T{ T}@T{
sum/average of column totals sum/average of column totals
T}@T{ T}@T{
not supported
T}@T{
sum/average of column totals sum/average of column totals
T}@T{ T}@T{
sum/average of column totals sum/average of column totals
@ -2110,6 +2152,7 @@ T}@T{
T}@T{ T}@T{
T}@T{ T}@T{
T}@T{ T}@T{
T}@T{
T} T}
.TE .TE
.PP .PP
@ -2668,14 +2711,12 @@ Balance changes in 2008:
\f[R] \f[R]
.fi .fi
.PP .PP
Limitations: A limitation of multicolumn balance reports: eliding of boring parent
accounts in tree mode, as in the classic balance report, is not yet
supported.
.PP .PP
In multicolumn reports the \f[C]-V/--value\f[R] flag uses the market The \f[C]--transpose\f[R] flag can be used to exchange the rows and
price on the report end date, for all columns (not the price on each columns of a multicolumn report.
column\[aq]s end date).
.PP
Eliding of boring parent accounts in tree mode, as in the classic
balance report, is not yet supported in multicolumn reports.
.SS Budget report .SS Budget report
.PP .PP
With \f[C]--budget\f[R], extra columns are displayed showing budget With \f[C]--budget\f[R], extra columns are displayed showing budget
@ -3521,6 +3562,8 @@ You can use the \f[C]-x\f[R]/\f[C]--explicit\f[R] flag to make all
amounts and transaction prices explicit, which can be useful for amounts and transaction prices explicit, which can be useful for
troubleshooting or for making your journal more readable and robust troubleshooting or for making your journal more readable and robust
against data entry errors. against data entry errors.
\f[C]-x\f[R] is also implied by using any of
\f[C]-B\f[R],\f[C]-V\f[R],\f[C]-X\f[R],\f[C]--value\f[R].
.PP .PP
Note, \f[C]-x\f[R]/\f[C]--explicit\f[R] will cause postings with a Note, \f[C]-x\f[R]/\f[C]--explicit\f[R] will cause postings with a
multi-commodity amount (these can arise when a multi-commodity multi-commodity amount (these can arise when a multi-commodity

491
hledger/hledger.info
View File

@ -186,7 +186,7 @@ balances on this date. Here are two ways to do it:
assets:bank:checking $1000 = $1000 assets:bank:checking $1000 = $1000
assets:bank:savings $2000 = $2000 assets:bank:savings $2000 = $2000
assets:cash $100 = $100 assets:cash $100 = $100
liabilities:creditcard $-50 = $-$50 liabilities:creditcard $-50 = $-50
equity:opening/closing balances equity:opening/closing balances
These are start-of-day balances, ie whatever was in the account at These are start-of-day balances, ie whatever was in the account at
@ -621,8 +621,9 @@ by most hledger commands, run 'hledger -h'.
apply automated posting rules to modify transactions. apply automated posting rules to modify transactions.
'--forecast' '--forecast'
apply periodic transaction rules to generate future transactions, generate future transactions from periodic transaction rules, for
to 6 months from now or report end date. the next 6 months or till report end date. In hledger-ui, also
make ordinary future transactions visible.
When a reporting option appears more than once in the command line, When a reporting option appears more than once in the command line,
the last one takes precedence. the last one takes precedence.
@ -1415,10 +1416,11 @@ _(experimental, added 201905)_
'-B', '-V' and '-X' are special cases of the more general '--value' '-B', '-V' and '-X' are special cases of the more general '--value'
option: option:
--value=TYPE[,COMM] TYPE is cost, end, now or YYYY-MM-DD. --value=TYPE[,COMM] TYPE is cost, then, end, now or YYYY-MM-DD.
COMM is an optional commodity symbol. COMM is an optional commodity symbol.
Shows amounts converted to: Shows amounts converted to:
- cost commodity using transaction prices (then optionally to COMM using market prices at period end(s)) - cost commodity using transaction prices (then optionally to COMM using market prices at period end(s))
- default valuation commodity (or COMM) using market prices at posting dates
- default valuation commodity (or COMM) using market prices at period end(s) - default valuation commodity (or COMM) using market prices at period end(s)
- default valuation commodity (or COMM) using current market prices - default valuation commodity (or COMM) using current market prices
- default valuation commodity (or COMM) using market prices at some date - default valuation commodity (or COMM) using market prices at some date
@ -1429,6 +1431,11 @@ a valuation date:
'--value=cost' '--value=cost'
Convert amounts to cost, using the prices recorded in transactions. Convert amounts to cost, using the prices recorded in transactions.
'--value=then'
Convert amounts to their value in a default valuation commodity,
using market prices on each posting's date. This is currently
supported only by the print and register commands.
'--value=end' '--value=end'
Convert amounts to their value in a default valuation commodity, Convert amounts to their value in a default valuation commodity,
@ -1582,67 +1589,76 @@ troubleshooting or reporting bugs. See also the definitions and notes
below. If you find problems, please report them, ideally with a below. If you find problems, please report them, ideally with a
reproducible example. Related: #329, #1083. reproducible example. Related: #329, #1083.
Report type '-B', '-V', '-X' '--value=end' '--value=DATE', Report '-B', '-V', '-X' '--value=then' '--value=end' '--value=DATE',
'--value=cost' '--value=now' type '--value=cost' '--value=now'
----------------------------------------------------------------------------- -------------------------------------------------------------------------------
*print* *print*
posting cost value at value at value at posting cost value at value at value at value at
amounts report end or report or DATE/today amounts report end posting date report or DATE/today
today journal end or today journal end
balance unchanged unchanged unchanged unchanged balance unchanged unchanged unchanged unchanged unchanged
assertions / assertions
/
assignments assignments
*register* *register*
starting cost value at day value at day value at starting cost value at not value at value at
balance (with before report before report DATE/today balance day before supported day before DATE/today
-H) or journal or journal (with -H) report or report or
journal journal
start start start start
posting cost value at value at value at posting cost value at value at value at value at
amounts (no report end or report or DATE/today amounts report end posting date report or DATE/today
report today journal end (no report or today journal end
interval) interval)
summary summarised value at value at value at summary summarised value at sum of value at value at
posting cost period ends period ends DATE/today posting cost period postings in period ends DATE/today
amounts (with amounts ends interval,
report (with valued at
interval) report interval
running sum/average sum/average sum/average of sum/average interval) start
total/average of displayed of displayed displayed of running sum/average sum/average sum/average sum/average sum/average
values values values displayed total/averageof of of displayed of of
values displayed displayed values displayed displayed
*balance (bs,
bse, cf,
is..)*
balances (no sums of value at value at value at
report costs report end or report or DATE/today
interval) today of sums journal end of of sums of
of postings sums of postings
postings
balances sums of value at value at value at
(with report costs period ends period ends of DATE/today
interval) of sums of sums of of sums of
postings postings postings
starting sums of sums of sums of sums of
balances costs of postings postings postings
(with report postings before report before report before
interval and before start start report
-H) report start start
budget like like balances like balances like
amounts with balances balances
-budget
grand total sum of sum of sum of sum of
(no report displayed displayed displayed displayed
interval) values values values values
row sums/averages sums/averages sums/averages sums/averages
totals/averages of displayed of displayed of displayed of
(with report values values values displayed
interval) values
column totals sums of sums of sums of sums of
displayed displayed displayed displayed
values values values values values values values values
grand sum/average sum/average sum/average of sum/average *balance
total/average of column of column column totals of column (bs, bse,
totals totals totals cf, is..)*
balances sums of value at not value at value at
(no report costs report end supported report or DATE/today
interval) or today journal end of sums
of sums of of sums of of
postings postings postings
balances sums of value at not value at value at
(with costs period supported period ends DATE/today
report ends of of sums of of sums
interval) sums of postings of
postings postings
starting sums of sums of not sums of sums of
balances costs of postings supported postings postings
(with postings before before before
report before report report report
interval report start start start
and -H) start
budget like like not like like
amounts balances balances supported balances balances
with
-budget
grand sum of sum of not sum of sum of
total (no displayed displayed supported displayed displayed
report values values values values
interval)
row sums/averagessums/averagesnot sums/averages sums/averages
totals/averagesof of supported of of
(with displayed displayed displayed displayed
report values values values values
interval)
column sums of sums of not sums of sums of
totals displayed displayed supported displayed displayed
values values values values
grand sum/average sum/average not sum/average sum/average
total/averageof column of column supported of column of
totals totals totals column
totals
*Additional notes* *Additional notes*
@ -2200,14 +2216,12 @@ Balance changes in 2008:
(Average is rounded to the dollar here since all journal amounts are) (Average is rounded to the dollar here since all journal amounts are)
Limitations: A limitation of multicolumn balance reports: eliding of boring parent
accounts in tree mode, as in the classic balance report, is not yet
supported.
In multicolumn reports the '-V/--value' flag uses the market price on The '--transpose' flag can be used to exchange the rows and columns
the report end date, for all columns (not the price on each column's end of a multicolumn report.
date).
Eliding of boring parent accounts in tree mode, as in the classic
balance report, is not yet supported in multicolumn reports.
 
File: hledger.info, Node: Budget report, Next: , Prev: Multicolumn balance report, Up: balance File: hledger.info, Node: Budget report, Next: , Prev: Multicolumn balance report, Up: balance
@ -2984,7 +2998,8 @@ will not appear in the output. Similarly, when a transaction price is
implied but not written, it will not appear in the output. You can use implied but not written, it will not appear in the output. You can use
the '-x'/'--explicit' flag to make all amounts and transaction prices the '-x'/'--explicit' flag to make all amounts and transaction prices
explicit, which can be useful for troubleshooting or for making your explicit, which can be useful for troubleshooting or for making your
journal more readable and robust against data entry errors. journal more readable and robust against data entry errors. '-x' is
also implied by using any of '-B','-V','-X','--value'.
Note, '-x'/'--explicit' will cause postings with a multi-commodity Note, '-x'/'--explicit' will cause postings with a multi-commodity
amount (these can arise when a multi-commodity transaction has an amount (these can arise when a multi-commodity transaction has an
@ -3678,177 +3693,177 @@ Node: Starting a journal file4414
Ref: #starting-a-journal-file4612 Ref: #starting-a-journal-file4612
Node: Setting opening balances5800 Node: Setting opening balances5800
Ref: #setting-opening-balances5996 Ref: #setting-opening-balances5996
Node: Recording transactions9138 Node: Recording transactions9137
Ref: #recording-transactions9318 Ref: #recording-transactions9317
Node: Reconciling9874 Node: Reconciling9873
Ref: #reconciling10017 Ref: #reconciling10016
Node: Reporting12274 Node: Reporting12273
Ref: #reporting12414 Ref: #reporting12413
Node: Migrating to a new file16413 Node: Migrating to a new file16412
Ref: #migrating-to-a-new-file16561 Ref: #migrating-to-a-new-file16560
Node: OPTIONS16860 Node: OPTIONS16859
Ref: #options16967 Ref: #options16966
Node: General options17337 Node: General options17336
Ref: #general-options17462 Ref: #general-options17461
Node: Command options20161 Node: Command options20231
Ref: #command-options20312 Ref: #command-options20382
Node: Command arguments20710 Node: Command arguments20780
Ref: #command-arguments20857 Ref: #command-arguments20927
Node: Queries21737 Node: Queries21807
Ref: #queries21892 Ref: #queries21962
Node: Special characters in arguments and queries25854 Node: Special characters in arguments and queries25924
Ref: #special-characters-in-arguments-and-queries26082 Ref: #special-characters-in-arguments-and-queries26152
Node: More escaping26533 Node: More escaping26603
Ref: #more-escaping26695 Ref: #more-escaping26765
Node: Even more escaping26991 Node: Even more escaping27061
Ref: #even-more-escaping27185 Ref: #even-more-escaping27255
Node: Less escaping27856 Node: Less escaping27926
Ref: #less-escaping28018 Ref: #less-escaping28088
Node: Unicode characters28263 Node: Unicode characters28333
Ref: #unicode-characters28445 Ref: #unicode-characters28515
Node: Input files29857 Node: Input files29927
Ref: #input-files30000 Ref: #input-files30070
Node: Output destination31929 Node: Output destination31999
Ref: #output-destination32081 Ref: #output-destination32151
Node: Output format32364 Node: Output format32434
Ref: #output-format32514 Ref: #output-format32584
Node: Regular expressions32899 Node: Regular expressions32969
Ref: #regular-expressions33056 Ref: #regular-expressions33126
Node: Smart dates34417 Node: Smart dates34487
Ref: #smart-dates34568 Ref: #smart-dates34638
Node: Report start & end date35929 Node: Report start & end date35999
Ref: #report-start-end-date36101 Ref: #report-start-end-date36171
Node: Report intervals37539 Node: Report intervals37609
Ref: #report-intervals37704 Ref: #report-intervals37774
Node: Period expressions38094 Node: Period expressions38164
Ref: #period-expressions38254 Ref: #period-expressions38324
Node: Depth limiting42380 Node: Depth limiting42450
Ref: #depth-limiting42524 Ref: #depth-limiting42594
Node: Pivoting42866 Node: Pivoting42936
Ref: #pivoting42989 Ref: #pivoting43059
Node: Valuation44665 Node: Valuation44735
Ref: #valuation44767 Ref: #valuation44837
Node: -B Cost44947 Node: -B Cost45017
Ref: #b-cost45058 Ref: #b-cost45128
Node: -V Market value45256 Node: -V Market value45326
Ref: #v-market-value45430 Ref: #v-market-value45500
Node: -X Market value in specified commodity46862 Node: -X Market value in specified commodity46932
Ref: #x-market-value-in-specified-commodity47101 Ref: #x-market-value-in-specified-commodity47171
Node: --value Flexible valuation47277 Node: --value Flexible valuation47347
Ref: #value-flexible-valuation47503 Ref: #value-flexible-valuation47573
Node: Effect of --value on reports51693 Node: Effect of --value on reports52078
Ref: #effect-of---value-on-reports51909 Ref: #effect-of---value-on-reports52294
Node: Combining -B -V -X --value56840 Node: Combining -B -V -X --value57840
Ref: #combining--b--v--x---value57023 Ref: #combining--b--v--x---value58023
Node: COMMANDS57059 Node: COMMANDS58059
Ref: #commands57167 Ref: #commands58167
Node: accounts58251 Node: accounts59251
Ref: #accounts58349 Ref: #accounts59349
Node: activity59048 Node: activity60048
Ref: #activity59158 Ref: #activity60158
Node: add59541 Node: add60541
Ref: #add59640 Ref: #add60640
Node: balance62379 Node: balance63379
Ref: #balance62490 Ref: #balance63490
Node: Classic balance report63948 Node: Classic balance report64948
Ref: #classic-balance-report64121 Ref: #classic-balance-report65121
Node: Customising the classic balance report65490 Node: Customising the classic balance report66490
Ref: #customising-the-classic-balance-report65718 Ref: #customising-the-classic-balance-report66718
Node: Colour support67794 Node: Colour support68794
Ref: #colour-support67961 Ref: #colour-support68961
Node: Flat mode68134 Node: Flat mode69134
Ref: #flat-mode68282 Ref: #flat-mode69282
Node: Depth limited balance reports68695 Node: Depth limited balance reports69695
Ref: #depth-limited-balance-reports68880 Ref: #depth-limited-balance-reports69880
Node: Percentages69336 Node: Percentages70336
Ref: #percentages69502 Ref: #percentages70502
Node: Multicolumn balance report70639 Node: Multicolumn balance report71639
Ref: #multicolumn-balance-report70819 Ref: #multicolumn-balance-report71819
Node: Budget report76133 Node: Budget report77081
Ref: #budget-report76276 Ref: #budget-report77224
Node: Nested budgets81478 Node: Nested budgets82426
Ref: #nested-budgets81590 Ref: #nested-budgets82538
Ref: #output-format-185071 Ref: #output-format-186019
Node: balancesheet85149 Node: balancesheet86097
Ref: #balancesheet85285 Ref: #balancesheet86233
Node: balancesheetequity86668 Node: balancesheetequity87616
Ref: #balancesheetequity86817 Ref: #balancesheetequity87765
Node: cashflow87378 Node: cashflow88326
Ref: #cashflow87506 Ref: #cashflow88454
Node: check-dates88602 Node: check-dates89550
Ref: #check-dates88729 Ref: #check-dates89677
Node: check-dupes89008 Node: check-dupes89956
Ref: #check-dupes89132 Ref: #check-dupes90080
Node: close89425 Node: close90373
Ref: #close89539 Ref: #close90487
Node: close usage91061 Node: close usage92009
Ref: #close-usage91154 Ref: #close-usage92102
Node: commodities93967 Node: commodities94915
Ref: #commodities94094 Ref: #commodities95042
Node: descriptions94176 Node: descriptions95124
Ref: #descriptions94304 Ref: #descriptions95252
Node: diff94485 Node: diff95433
Ref: #diff94591 Ref: #diff95539
Node: files95638 Node: files96586
Ref: #files95738 Ref: #files96686
Node: help95885 Node: help96833
Ref: #help95985 Ref: #help96933
Node: import97066 Node: import98014
Ref: #import97180 Ref: #import98128
Node: Importing balance assignments98073 Node: Importing balance assignments99021
Ref: #importing-balance-assignments98221 Ref: #importing-balance-assignments99169
Node: incomestatement98870 Node: incomestatement99818
Ref: #incomestatement99003 Ref: #incomestatement99951
Node: notes100407 Node: notes101355
Ref: #notes100520 Ref: #notes101468
Node: payees100646 Node: payees101594
Ref: #payees100752 Ref: #payees101700
Node: prices100910 Node: prices101858
Ref: #prices101016 Ref: #prices101964
Node: print101357 Node: print102305
Ref: #print101467 Ref: #print102415
Node: print-unique106111 Node: print-unique107123
Ref: #print-unique106237 Ref: #print-unique107249
Node: register106522 Node: register107534
Ref: #register106649 Ref: #register107661
Node: Custom register output110821 Node: Custom register output111833
Ref: #custom-register-output110950 Ref: #custom-register-output111962
Node: register-match112212 Node: register-match113224
Ref: #register-match112346 Ref: #register-match113358
Node: rewrite112697 Node: rewrite113709
Ref: #rewrite112812 Ref: #rewrite113824
Node: Re-write rules in a file114667 Node: Re-write rules in a file115679
Ref: #re-write-rules-in-a-file114801 Ref: #re-write-rules-in-a-file115813
Node: Diff output format116011 Node: Diff output format117023
Ref: #diff-output-format116180 Ref: #diff-output-format117192
Node: rewrite vs print --auto117272 Node: rewrite vs print --auto118284
Ref: #rewrite-vs.-print---auto117451 Ref: #rewrite-vs.-print---auto118463
Node: roi118007 Node: roi119019
Ref: #roi118105 Ref: #roi119117
Node: stats119117 Node: stats120129
Ref: #stats119216 Ref: #stats120228
Node: tags120004 Node: tags121016
Ref: #tags120102 Ref: #tags121114
Node: test120396 Node: test121408
Ref: #test120504 Ref: #test121516
Node: Add-on Commands121251 Node: Add-on Commands122263
Ref: #add-on-commands121368 Ref: #add-on-commands122380
Node: ui122711 Node: ui123723
Ref: #ui122799 Ref: #ui123811
Node: web122853 Node: web123865
Ref: #web122956 Ref: #web123968
Node: iadd123072 Node: iadd124084
Ref: #iadd123183 Ref: #iadd124195
Node: interest123265 Node: interest124277
Ref: #interest123372 Ref: #interest124384
Node: ENVIRONMENT123612 Node: ENVIRONMENT124624
Ref: #environment123724 Ref: #environment124736
Node: FILES124553 Node: FILES125565
Ref: #files-1124656 Ref: #files-1125668
Node: LIMITATIONS124869 Node: LIMITATIONS125881
Ref: #limitations124988 Ref: #limitations126000
Node: TROUBLESHOOTING125730 Node: TROUBLESHOOTING126742
Ref: #troubleshooting125843 Ref: #troubleshooting126855
 
End Tag Table End Tag Table

137
hledger/hledger.txt
View File

@ -144,7 +144,7 @@ COMMON TASKS
assets:bank:checking $1000 = $1000 assets:bank:checking $1000 = $1000
assets:bank:savings $2000 = $2000 assets:bank:savings $2000 = $2000
assets:cash $100 = $100 assets:cash $100 = $100
liabilities:creditcard $-50 = $-$50 liabilities:creditcard $-50 = $-50
equity:opening/closing balances equity:opening/closing balances
These are start-of-day balances, ie whatever was in the account at These are start-of-day balances, ie whatever was in the account at
@ -525,8 +525,9 @@ OPTIONS
--auto apply automated posting rules to modify transactions. --auto apply automated posting rules to modify transactions.
--forecast --forecast
apply periodic transaction rules to generate future transac- generate future transactions from periodic transaction rules,
tions, to 6 months from now or report end date. for the next 6 months or till report end date. In hledger-ui,
also make ordinary future transactions visible.
When a reporting option appears more than once in the command line, the When a reporting option appears more than once in the command line, the
last one takes precedence. last one takes precedence.
@ -995,7 +996,6 @@ OPTIONS
1, 2009 1, 2009
-p "from 2009/1" the same -p "from 2009/1" the same
-p "from 2009" the same -p "from 2009" the same
-p "to 2009" everything before january -p "to 2009" everything before january
1, 2009 1, 2009
@ -1007,6 +1007,7 @@ OPTIONS
-p "2009/1" the month of jan; equiva- -p "2009/1" the month of jan; equiva-
lent to "2009/1/1 to lent to "2009/1/1 to
2009/2/1" 2009/2/1"
-p "2009/1/1" just that day; equivalent -p "2009/1/1" just that day; equivalent
to "2009/1/1 to 2009/1/2" to "2009/1/1 to 2009/1/2"
@ -1062,7 +1063,6 @@ OPTIONS
-p "every 2nd day of periods will go from Tue to Tue -p "every 2nd day of periods will go from Tue to Tue
week" week"
-p "every Tue" same -p "every Tue" same
-p "every 15th day" period boundaries will be on 15th of each -p "every 15th day" period boundaries will be on 15th of each
month month
@ -1202,10 +1202,11 @@ OPTIONS
-B, -V and -X are special cases of the more general --value option: -B, -V and -X are special cases of the more general --value option:
--value=TYPE[,COMM] TYPE is cost, end, now or YYYY-MM-DD. --value=TYPE[,COMM] TYPE is cost, then, end, now or YYYY-MM-DD.
COMM is an optional commodity symbol. COMM is an optional commodity symbol.
Shows amounts converted to: Shows amounts converted to:
- cost commodity using transaction prices (then optionally to COMM using market prices at period end(s)) - cost commodity using transaction prices (then optionally to COMM using market prices at period end(s))
- default valuation commodity (or COMM) using market prices at posting dates
- default valuation commodity (or COMM) using market prices at period end(s) - default valuation commodity (or COMM) using market prices at period end(s)
- default valuation commodity (or COMM) using current market prices - default valuation commodity (or COMM) using current market prices
- default valuation commodity (or COMM) using market prices at some date - default valuation commodity (or COMM) using market prices at some date
@ -1217,6 +1218,11 @@ OPTIONS
Convert amounts to cost, using the prices recorded in transac- Convert amounts to cost, using the prices recorded in transac-
tions. tions.
--value=then
Convert amounts to their value in a default valuation commodity,
using market prices on each posting's date. This is currently
supported only by the print and register commands.
--value=end --value=end
Convert amounts to their value in a default valuation commodity, Convert amounts to their value in a default valuation commodity,
using market prices on the last day of the report period (or if using market prices on the last day of the report period (or if
@ -1364,62 +1370,70 @@ OPTIONS
low. If you find problems, please report them, ideally with a repro- low. If you find problems, please report them, ideally with a repro-
ducible example. Related: #329, #1083. ducible example. Related: #329, #1083.
Report type -B, -V, -X --value=end --value=DATE, Report type -B, -V, -X --value=then --value=end --value=DATE,
--value=cost --value=now --value=cost --value=now
------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------
print print
posting cost value at report value at report value at posting cost value at re- value at value at re- value at
amounts end or today or journal end DATE/today amounts port end or posting date port or DATE/today
balance asser- unchanged unchanged unchanged unchanged today journal end
tions / as- balance as- unchanged unchanged unchanged unchanged unchanged
signments sertions /
assignments
register register
starting bal- cost value at day value at day value at starting cost value at day not supported value at day value at
ance (with -H) before report before report DATE/today balance before re- before re- DATE/today
or journal or journal (with -H) port or port or
journal journal
start start start start
posting cost value at report value at report value at posting cost value at re- value at value at re- value at
amounts (no end or today or journal end DATE/today amounts (no port end or posting date port or DATE/today
report inter- report in- today journal end
val) terval)
summary post- summarised value at period value at period value at summary summarised value at pe- sum of post- value at pe- value at
ing amounts cost ends ends DATE/today posting cost riod ends ings in in- riod ends DATE/today
(with report amounts terval, val-
interval) (with report ued at inter-
running to- sum/average of sum/average of sum/average of sum/average interval) val start
tal/average displayed val- displayed val- displayed val- of displayed running to- sum/average sum/average sum/average sum/average sum/average
ues ues ues values tal/average of displayed of displayed of displayed of displayed of displayed
values values values values values
balance (bs, balance (bs,
bse, cf, is..) bse, cf,
balances (no sums of costs value at report value at report value at is..)
report inter- end or today of or journal end DATE/today of balances (no sums of value at re- not supported value at re- value at
val) sums of post- of sums of sums of post- report in- costs port end or port or DATE/today of
ings postings ings terval) today of journal end sums of post-
sums of of sums of ings
balances (with sums of costs value at period value at period value at postings postings
report inter- ends of sums of ends of sums of DATE/today of balances sums of value at pe- not supported value at pe- value at
val) postings postings sums of post- (with report costs riod ends of riod ends of DATE/today of
ings interval) sums of sums of sums of post-
starting bal- sums of costs sums of post- sums of post- sums of post- postings postings ings
ances (with of postings ings before re- ings before re- ings before starting sums of sums of not supported sums of sums of post-
report inter- before report port start port start report start balances costs of postings be- postings be- ings before
val and -H) start (with report postings be- fore report fore report report start
budget amounts like balances like balances like balances like balances interval and fore report start start
with --budget -H) start
grand total sum of dis- sum of dis- sum of dis- sum of dis- budget like bal- like bal- not supported like bal- like balances
(no report in- played values played values played values played values amounts with ances ances ances
--budget
grand total sum of dis- sum of dis- not supported sum of dis- sum of dis-
(no report played val- played val- played val- played values
interval) ues ues ues
row to- sums/aver- sums/aver- not supported sums/aver- sums/averages
tals/aver- ages of dis- ages of dis- ages of dis- of displayed
ages (with played val- played val- played val- values
report in- ues ues ues
terval) terval)
row totals/av- sums/averages sums/averages sums/averages sums/averages column to- sums of dis- sums of dis- not supported sums of dis- sums of dis-
erages (with of displayed of displayed of displayed of displayed tals played val- played val- played val- played values
report inter- values values values values ues ues ues
val) grand to- sum/average sum/average not supported sum/average sum/average
column totals sums of dis- sums of dis- sums of dis- sums of dis- tal/average of column of column of column of column to-
played values played values played values played values totals totals totals tals
grand to- sum/average of sum/average of sum/average of sum/average
tal/average column totals column totals column totals of column to-
tals
Additional notes Additional notes
@ -1880,14 +1894,12 @@ COMMANDS
(Average is rounded to the dollar here since all journal amounts are) (Average is rounded to the dollar here since all journal amounts are)
Limitations: A limitation of multicolumn balance reports: eliding of boring parent
accounts in tree mode, as in the classic balance report, is not yet
supported.
In multicolumn reports the -V/--value flag uses the market price on the The --transpose flag can be used to exchange the rows and columns of a
report end date, for all columns (not the price on each column's end multicolumn report.
date).
Eliding of boring parent accounts in tree mode, as in the classic bal-
ance report, is not yet supported in multicolumn reports.
Budget report Budget report
With --budget, extra columns are displayed showing budget goals for With --budget, extra columns are displayed showing budget goals for
@ -2542,7 +2554,8 @@ COMMANDS
plied but not written, it will not appear in the output. You can use plied but not written, it will not appear in the output. You can use
the -x/--explicit flag to make all amounts and transaction prices ex- the -x/--explicit flag to make all amounts and transaction prices ex-
plicit, which can be useful for troubleshooting or for making your plicit, which can be useful for troubleshooting or for making your
journal more readable and robust against data entry errors. journal more readable and robust against data entry errors. -x is also
implied by using any of -B,-V,-X,--value.
Note, -x/--explicit will cause postings with a multi-commodity amount Note, -x/--explicit will cause postings with a multi-commodity amount
(these can arise when a multi-commodity transaction has an implicit (these can arise when a multi-commodity transaction has an implicit