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

doc: regen manuals

Browse Source
This commit is contained in:
Simon Michael 2019-01-26 15:56:43 -08:00
parent 550aa408eb
commit 2df8a6c4de
9 changed files with 618 additions and 544 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
hledger-lib/hledger_journal.5
View File

@ -602,8 +602,21 @@ One workaround is to isolate each commodity into its own subaccount:
.fi
.SS Assertions and prices
.PP
Balance assertion (or assignment) amounts should not have a price, as
the meaning of that would be unclear.
Balance assertions ignore transaction prices, and should normally be
written without one:
.IP
.nf
\f[C]
2019/1/1
\ \ (a)\ \ \ \ \ $1\ \@\ €1\ =\ $1
\f[]
.fi
.PP
We do allow prices to be written there, however, and print shows them,
even though they don\[aq]t affect whether the assertion passes or fails.
This is for backward compatibility (hledger\[aq]s close command used to
generate balance assertions with prices), and because balance
\f[I]assignments\f[] do use them (see below).
.SS Assertions and subaccounts
.PP
Balance assertions do not count the balance from subaccounts; they check
@ -682,6 +695,25 @@ assignment).
Note that using balance assignments makes your journal a little less
explicit; to know the exact amount posted, you have to run hledger or do
the calculations yourself, instead of just reading it.
.SS Balance assignments and prices
.PP
A transaction price in a balance assignment will cause the calculated
amount to have that price attached:
.IP
.nf
\f[C]
2019/1/1
\ \ (a)\ \ \ \ \ \ \ \ \ \ \ \ \ =\ $1\ \@\ €2
\f[]
.fi
.IP
.nf
\f[C]
$\ hledger\ print\ \-\-explicit
2019/01/01
\ \ \ \ (a)\ \ \ \ \ \ \ \ \ $1\ \@\ €2\ =\ $1\ \@\ €2
\f[]
.fi
.SS Transaction prices
.PP
Within a transaction, you can note an amount\[aq]s price in another

158
hledger-lib/hledger_journal.info
View File

@ -573,8 +573,17 @@ File: hledger_journal.info, Node: Assertions and prices, Next: Assertions and
1.9.5 Assertions and prices
---------------------------
Balance assertion (or assignment) amounts should not have a price, as
the meaning of that would be unclear.
Balance assertions ignore transaction prices, and should normally be
written without one:
2019/1/1
(a) $1 @ €1 = $1
We do allow prices to be written there, however, and print shows
them, even though they don't affect whether the assertion passes or
fails. This is for backward compatibility (hledger's close command used
to generate balance assertions with prices), and because balance
_assignments_ do use them (see below).

File: hledger_journal.info, Node: Assertions and subaccounts, Next: Assertions and virtual postings, Prev: Assertions and prices, Up: Balance Assertions
@ -652,6 +661,25 @@ of the commodity to that account since the last balance assertion or
assignment). Note that using balance assignments makes your journal a
little less explicit; to know the exact amount posted, you have to run
hledger or do the calculations yourself, instead of just reading it.
* Menu:
* Balance assignments and prices::

File: hledger_journal.info, Node: Balance assignments and prices, Up: Balance Assignments
1.10.1 Balance assignments and prices
-------------------------------------
A transaction price in a balance assignment will cause the calculated
amount to have that price attached:
2019/1/1
(a) = $1 @ €2
$ hledger print --explicit
2019/01/01
(a) $1 @ €2 = $1 @ €2

File: hledger_journal.info, Node: Transaction prices, Next: Comments, Prev: Balance Assignments, Up: FILE FORMAT
@ -1597,67 +1625,69 @@ Node: Assertions and commodities19383
Ref: #assertions-and-commodities19613
Node: Assertions and prices20801
Ref: #assertions-and-prices21013
Node: Assertions and subaccounts21122
Ref: #assertions-and-subaccounts21349
Node: Assertions and virtual postings21870
Ref: #assertions-and-virtual-postings22110
Node: Assertions and precision22252
Ref: #assertions-and-precision22443
Node: Balance Assignments22710
Ref: #balance-assignments22891
Node: Transaction prices24011
Ref: #transaction-prices24180
Node: Comments26448
Ref: #comments26582
Node: Tags27752
Ref: #tags27870
Node: Directives29272
Ref: #directives29415
Node: Comment blocks35022
Ref: #comment-blocks35167
Node: Including other files35343
Ref: #including-other-files35523
Node: Default year35931
Ref: #default-year36100
Node: Declaring commodities36523
Ref: #declaring-commodities36706
Node: Default commodity37933
Ref: #default-commodity38109
Node: Market prices38745
Ref: #market-prices38910
Node: Declaring accounts39751
Ref: #declaring-accounts39927
Node: Account comments40852
Ref: #account-comments41015
Node: Account subdirectives41410
Ref: #account-subdirectives41605
Node: Account types41918
Ref: #account-types42102
Node: Account display order43746
Ref: #account-display-order43916
Node: Rewriting accounts45045
Ref: #rewriting-accounts45230
Node: Basic aliases45964
Ref: #basic-aliases46110
Node: Regex aliases46814
Ref: #regex-aliases46985
Node: Multiple aliases47703
Ref: #multiple-aliases47878
Node: end aliases48376
Ref: #end-aliases48523
Node: Default parent account48624
Ref: #default-parent-account48790
Node: Periodic transactions49674
Ref: #periodic-transactions49856
Node: Two spaces after the period expression50981
Ref: #two-spaces-after-the-period-expression51226
Node: Forecasting with periodic transactions51711
Ref: #forecasting-with-periodic-transactions52001
Node: Budgeting with periodic transactions53688
Ref: #budgeting-with-periodic-transactions53927
Node: Transaction Modifiers54386
Ref: #transaction-modifiers54549
Node: EDITOR SUPPORT56530
Ref: #editor-support56648
Node: Assertions and subaccounts21453
Ref: #assertions-and-subaccounts21680
Node: Assertions and virtual postings22201
Ref: #assertions-and-virtual-postings22441
Node: Assertions and precision22583
Ref: #assertions-and-precision22774
Node: Balance Assignments23041
Ref: #balance-assignments23222
Node: Balance assignments and prices24386
Ref: #balance-assignments-and-prices24558
Node: Transaction prices24782
Ref: #transaction-prices24951
Node: Comments27219
Ref: #comments27353
Node: Tags28523
Ref: #tags28641
Node: Directives30043
Ref: #directives30186
Node: Comment blocks35793
Ref: #comment-blocks35938
Node: Including other files36114
Ref: #including-other-files36294
Node: Default year36702
Ref: #default-year36871
Node: Declaring commodities37294
Ref: #declaring-commodities37477
Node: Default commodity38704
Ref: #default-commodity38880
Node: Market prices39516
Ref: #market-prices39681
Node: Declaring accounts40522
Ref: #declaring-accounts40698
Node: Account comments41623
Ref: #account-comments41786
Node: Account subdirectives42181
Ref: #account-subdirectives42376
Node: Account types42689
Ref: #account-types42873
Node: Account display order44517
Ref: #account-display-order44687
Node: Rewriting accounts45816
Ref: #rewriting-accounts46001
Node: Basic aliases46735
Ref: #basic-aliases46881
Node: Regex aliases47585
Ref: #regex-aliases47756
Node: Multiple aliases48474
Ref: #multiple-aliases48649
Node: end aliases49147
Ref: #end-aliases49294
Node: Default parent account49395
Ref: #default-parent-account49561
Node: Periodic transactions50445
Ref: #periodic-transactions50627
Node: Two spaces after the period expression51752
Ref: #two-spaces-after-the-period-expression51997
Node: Forecasting with periodic transactions52482
Ref: #forecasting-with-periodic-transactions52772
Node: Budgeting with periodic transactions54459
Ref: #budgeting-with-periodic-transactions54698
Node: Transaction Modifiers55157
Ref: #transaction-modifiers55320
Node: EDITOR SUPPORT57301
Ref: #editor-support57419

End Tag Table

29
hledger-lib/hledger_journal.txt
View File

@ -447,8 +447,17 @@ FILE FORMAT
a:euro 0 == 1
Assertions and prices
Balance assertion (or assignment) amounts should not have a price, as
the meaning of that would be unclear.
Balance assertions ignore transaction prices, and should normally be
written without one:
2019/1/1
(a) $1 @ 1 = $1
We do allow prices to be written there, however, and print shows them,
even though they don't affect whether the assertion passes or fails.
This is for backward compatibility (hledger's close command used to
generate balance assertions with prices), and because balance assign-
ments do use them (see below).
Assertions and subaccounts
Balance assertions do not count the balance from subaccounts; they
@ -506,6 +515,17 @@ FILE FORMAT
less explicit; to know the exact amount posted, you have to run hledger
or do the calculations yourself, instead of just reading it.
Balance assignments and prices
A transaction price in a balance assignment will cause the calculated
amount to have that price attached:
2019/1/1
(a) = $1 @ 2
$ hledger print --explicit
2019/01/01
(a) $1 @ 2 = $1 @ 2
Transaction prices
Within a transaction, you can note an amount's price in another commod-
ity. This can be used to document the cost (in a purchase) or selling
@ -650,6 +670,9 @@ FILE FORMAT
links to more detailed docs.
direc- end subdi- purpose can affect (as of
tive directive rec- 2018/06)
tives
@ -679,8 +702,6 @@ FILE FORMAT
play style: amounts
of that commodity
in reports
D declare a commodity, number commodity: all com-
notation & display style for modityless entries
commodityless amounts in all files; num-

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

@ -424,7 +424,7 @@ Similarly, \f[C]P\f[] toggles pending transactions, and \f[C]C\f[]
toggles cleared transactions.
(By default, transactions with all statuses are shown; if you activate
one or two status filters, only those transactions are shown; and if you
activate all three, the filter is removed.)q
activate all three, the filter is removed.)
.PP
\f[C]R\f[] toggles real mode, in which virtual postings are ignored.
.PP

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

@ -349,7 +349,7 @@ transactions. Similarly, 'P' toggles pending transactions, and 'C'
toggles cleared transactions. (By default, transactions with all
statuses are shown; if you activate one or two status filters, only
those transactions are shown; and if you activate all three, the filter
is removed.)q
is removed.)
'R' toggles real mode, in which virtual postings are ignored.
@ -408,9 +408,9 @@ Node: Accounts screen8148
Ref: #accounts-screen8276
Node: Register screen10492
Ref: #register-screen10647
Node: Transaction screen12644
Ref: #transaction-screen12802
Node: Error screen13672
Ref: #error-screen13794
Node: Transaction screen12643
Ref: #transaction-screen12801
Node: Error screen13671
Ref: #error-screen13793

End Tag Table

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

@ -314,8 +314,7 @@ SCREENS
transactions. Similarly, P toggles pending transactions, and C toggles
cleared transactions. (By default, transactions with all statuses are
shown; if you activate one or two status filters, only those transac-
tions are shown; and if you activate all three, the filter is
removed.)q
tions are shown; and if you activate all three, the filter is removed.)
R toggles real mode, in which virtual postings are ignored.

18
hledger/hledger.1
View File

@ -1639,11 +1639,6 @@ show performance compared to budget goals defined by periodic
transactions
.RS
.RE
.TP
.B \f[C]\-\-show\-unbudgeted\f[]
with \-\-budget, show unbudgeted accounts also
.RS
.RE
.PP
The balance command is hledger\[aq]s most versatile command.
Note, despite the name, it is not always used for showing real\-world
@ -1934,6 +1929,8 @@ Second, all accounts which existed at the report start date will be
considered, not just the ones with activity during the report period
(use \-E to include low\-activity accounts which would otherwise would
be omitted).
With \f[C]\-\-budget\f[], \f[C]\-\-empty\f[] also shows unbudgeted
accounts.
.PP
The \f[C]\-T/\-\-row\-total\f[] flag adds an additional column showing
the total for each row.
@ -2040,12 +2037,11 @@ In the example above, transactions in \f[C]expenses:gifts\f[] and
but accounts \f[C]expenses:gifts\f[] and \f[C]expenses:supplies\f[] are
not shown, as they don\[aq]t have any budgets.
.PP
You can use \f[C]\-\-show\-unbudgeted\f[] shows unbudgeted accounts as
well:
You can use \f[C]\-\-empty\f[] shows unbudgeted accounts as well:
.IP
.nf
\f[C]
$\ hledger\ balance\ \-M\ \-\-budget\ \-\-show\-unbudgeted
$\ hledger\ balance\ \-M\ \-\-budget\ \-\-empty
Budget\ performance\ in\ 2017/11/01\-2017/12/31:
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ ||\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Nov\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Dec\
@ -2174,12 +2170,12 @@ Budget\ performance\ in\ 2019/01:
\f[]
.fi
.PP
And with \f[C]\-\-show\-unbudgeted\f[], we can get a better picture of
budget allocation and consumption:
And with \f[C]\-\-empty\f[], we can get a better picture of budget
allocation and consumption:
.IP
.nf
\f[C]
$\ hledger\ balance\ \-\-budget\ \-M\ \-\-show\-unbudgeted
$\ hledger\ balance\ \-\-budget\ \-M\ \-\-empty
Budget\ performance\ in\ 2019/01:
\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ ||\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ Jan\

190
hledger/hledger.info
View File

@ -1243,9 +1243,6 @@ Show accounts and their balances. Aliases: b, bal.
show performance compared to budget goals defined by periodic
transactions
'--show-unbudgeted'
with -budget, show unbudgeted accounts also
The balance command is hledger's most versatile command. Note,
despite the name, it is not always used for showing real-world account
@ -1510,7 +1507,8 @@ period (without -E, leading and trailing columns with all zeroes are not
shown). Second, all accounts which existed at the report start date
will be considered, not just the ones with activity during the report
period (use -E to include low-activity accounts which would otherwise
would be omitted).
would be omitted). With '--budget', '--empty' also shows unbudgeted
accounts.
The '-T/--row-total' flag adds an additional column showing the total
for each row.
@ -1608,9 +1606,9 @@ are shown. In the example above, transactions in 'expenses:gifts' and
'expenses:gifts' and 'expenses:supplies' are not shown, as they don't
have any budgets.
You can use '--show-unbudgeted' shows unbudgeted accounts as well:
You can use '--empty' shows unbudgeted accounts as well:
$ hledger balance -M --budget --show-unbudgeted
$ hledger balance -M --budget --empty
Budget performance in 2017/11/01-2017/12/31:
|| Nov Dec
@ -1725,10 +1723,10 @@ Budget performance in 2019/01:
-------------------------------++-------------------------------
|| 0 [ 0]
And with '--show-unbudgeted', we can get a better picture of budget
allocation and consumption:
And with '--empty', we can get a better picture of budget allocation
and consumption:
$ hledger balance --budget -M --show-unbudgeted
$ hledger balance --budget -M --empty
Budget performance in 2019/01:
|| Jan
@ -2808,92 +2806,92 @@ Node: add35465
Ref: #add35564
Node: balance38225
Ref: #balance38336
Node: Classic balance report41526
Ref: #classic-balance-report41699
Node: Customising the classic balance report43068
Ref: #customising-the-classic-balance-report43296
Node: Colour support45370
Ref: #colour-support45537
Node: Flat mode45710
Ref: #flat-mode45858
Node: Depth limited balance reports46271
Ref: #depth-limited-balance-reports46471
Node: Multicolumn balance report46927
Ref: #multicolumn-balance-report47125
Node: Budget report52305
Ref: #budget-report52448
Node: Nested budgets57152
Ref: #nested-budgets57264
Ref: #output-format-160764
Node: balancesheet60842
Ref: #balancesheet60978
Node: balancesheetequity63289
Ref: #balancesheetequity63438
Node: cashflow63975
Ref: #cashflow64103
Node: check-dates66226
Ref: #check-dates66353
Node: check-dupes66470
Ref: #check-dupes66594
Node: close66731
Ref: #close66839
Node: files70253
Ref: #files70354
Node: help70495
Ref: #help70595
Node: import71669
Ref: #import71783
Node: incomestatement72513
Ref: #incomestatement72647
Node: prices75051
Ref: #prices75166
Node: print75438
Ref: #print75548
Node: print-unique80442
Ref: #print-unique80568
Node: register80636
Ref: #register80763
Node: Custom register output85264
Ref: #custom-register-output85393
Node: register-match86623
Ref: #register-match86757
Node: rewrite86940
Ref: #rewrite87055
Node: roi87124
Ref: #roi87222
Node: stats87338
Ref: #stats87437
Node: tags88307
Ref: #tags88405
Node: test88641
Ref: #test88725
Node: ADD-ON COMMANDS89433
Ref: #add-on-commands89543
Node: Official add-ons90830
Ref: #official-add-ons90970
Node: api91057
Ref: #api91146
Node: ui91198
Ref: #ui91297
Node: web91355
Ref: #web91444
Node: Third party add-ons91490
Ref: #third-party-add-ons91665
Node: diff91800
Ref: #diff91897
Node: iadd91996
Ref: #iadd92110
Node: interest92193
Ref: #interest92314
Node: irr92409
Ref: #irr92507
Node: Experimental add-ons92638
Ref: #experimental-add-ons92790
Node: autosync93070
Ref: #autosync93181
Node: chart93420
Ref: #chart93539
Node: check93610
Ref: #check93712
Node: Classic balance report41456
Ref: #classic-balance-report41629
Node: Customising the classic balance report42998
Ref: #customising-the-classic-balance-report43226
Node: Colour support45300
Ref: #colour-support45467
Node: Flat mode45640
Ref: #flat-mode45788
Node: Depth limited balance reports46201
Ref: #depth-limited-balance-reports46401
Node: Multicolumn balance report46857
Ref: #multicolumn-balance-report47055
Node: Budget report52295
Ref: #budget-report52438
Node: Nested budgets57122
Ref: #nested-budgets57234
Ref: #output-format-160714
Node: balancesheet60792
Ref: #balancesheet60928
Node: balancesheetequity63239
Ref: #balancesheetequity63388
Node: cashflow63925
Ref: #cashflow64053
Node: check-dates66176
Ref: #check-dates66303
Node: check-dupes66420
Ref: #check-dupes66544
Node: close66681
Ref: #close66789
Node: files70203
Ref: #files70304
Node: help70445
Ref: #help70545
Node: import71619
Ref: #import71733
Node: incomestatement72463
Ref: #incomestatement72597
Node: prices75001
Ref: #prices75116
Node: print75388
Ref: #print75498
Node: print-unique80392
Ref: #print-unique80518
Node: register80586
Ref: #register80713
Node: Custom register output85214
Ref: #custom-register-output85343
Node: register-match86573
Ref: #register-match86707
Node: rewrite86890
Ref: #rewrite87005
Node: roi87074
Ref: #roi87172
Node: stats87288
Ref: #stats87387
Node: tags88257
Ref: #tags88355
Node: test88591
Ref: #test88675
Node: ADD-ON COMMANDS89383
Ref: #add-on-commands89493
Node: Official add-ons90780
Ref: #official-add-ons90920
Node: api91007
Ref: #api91096
Node: ui91148
Ref: #ui91247
Node: web91305
Ref: #web91394
Node: Third party add-ons91440
Ref: #third-party-add-ons91615
Node: diff91750
Ref: #diff91847
Node: iadd91946
Ref: #iadd92060
Node: interest92143
Ref: #interest92264
Node: irr92359
Ref: #irr92457
Node: Experimental add-ons92588
Ref: #experimental-add-ons92740
Node: autosync93020
Ref: #autosync93131
Node: chart93370
Ref: #chart93489
Node: check93560
Ref: #check93662

End Tag Table

16
hledger/hledger.txt
View File

@ -1111,9 +1111,6 @@ COMMANDS
show performance compared to budget goals defined by periodic
transactions
--show-unbudgeted
with --budget, show unbudgeted accounts also
The balance command is hledger's most versatile command. Note, despite
the name, it is not always used for showing real-world account bal-
ances; the more accounting-aware balancesheet and incomestatement may
@ -1348,7 +1345,8 @@ COMMANDS
not shown). Second, all accounts which existed at the report start
date will be considered, not just the ones with activity during the
report period (use -E to include low-activity accounts which would oth-
erwise would be omitted).
erwise would be omitted). With --budget, --empty also shows unbudgeted
accounts.
The -T/--row-total flag adds an additional column showing the total for
each row.
@ -1441,9 +1439,9 @@ COMMANDS
expenses:gifts and expenses:supplies are not shown, as they don't have
any budgets.
You can use --show-unbudgeted shows unbudgeted accounts as well:
You can use --empty shows unbudgeted accounts as well:
$ hledger balance -M --budget --show-unbudgeted
$ hledger balance -M --budget --empty
Budget performance in 2017/11/01-2017/12/31:
|| Nov Dec
@ -1550,10 +1548,10 @@ COMMANDS
-------------------------------++-------------------------------
|| 0 [ 0]
And with --show-unbudgeted, we can get a better picture of budget allo-
cation and consumption:
And with --empty, we can get a better picture of budget allocation and
consumption:
$ hledger balance --budget -M --show-unbudgeted
$ hledger balance --budget -M --empty
Budget performance in 2019/01:
|| Jan