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

;doc: regen manuals

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2020-02-08 11:56:03 -08:00
parent 54e633e186
commit 98d0cc9c17
6 changed files with 544 additions and 532 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
hledger-lib/hledger_journal.5
View File

@ -239,7 +239,7 @@ Here\[aq]s one suggestion:
.PP .PP
.TS .TS
tab(@); tab(@);
lw(9.9n) lw(60.1n). lw(9.7n) lw(60.3n).
T{ T{
status status
T}@T{ T}@T{
@ -1033,7 +1033,7 @@ And some definitions:
.PP .PP
.TS .TS
tab(@); tab(@);
lw(8.9n) lw(61.1n). lw(6.0n) lw(64.0n).
T{ T{
subdirective subdirective
T}@T{ T}@T{

113
hledger-lib/hledger_journal.info
View File

@ -913,12 +913,11 @@ account' apply account names inline/included
And some definitions: And some definitions:
subdirectiveoptional indented directive line immediately following a subdirectiveoptional indented directive line immediately following a parent
parent directive directive
number how to interpret numbers when parsing journal entries (the number how to interpret numbers when parsing journal entries (the
notation identity of the decimal separator character). (Currently notationidentity of the decimal separator character). (Currently each
each commodity can have its own notation, even in the same commodity can have its own notation, even in the same file.)
file.)
displayhow to display amounts of a commodity in reports (symbol side displayhow to display amounts of a commodity in reports (symbol side
style and spacing, digit groups, decimal separator, decimal places) style and spacing, digit groups, decimal separator, decimal places)
directivewhich entries and (when there are multiple files) which files directivewhich entries and (when there are multiple files) which files
@ -1789,58 +1788,58 @@ Node: Balance assignments and prices29327
Ref: #balance-assignments-and-prices29499 Ref: #balance-assignments-and-prices29499
Node: Directives29723 Node: Directives29723
Ref: #directives29882 Ref: #directives29882
Node: Comment blocks35561 Node: Comment blocks35530
Ref: #comment-blocks35706 Ref: #comment-blocks35675
Node: Including other files35882 Node: Including other files35851
Ref: #including-other-files36062 Ref: #including-other-files36031
Node: Default year36470 Node: Default year36439
Ref: #default-year36639 Ref: #default-year36608
Node: Declaring commodities37046 Node: Declaring commodities37015
Ref: #declaring-commodities37229 Ref: #declaring-commodities37198
Node: Default commodity38890 Node: Default commodity38859
Ref: #default-commodity39066 Ref: #default-commodity39035
Node: Market prices39700 Node: Market prices39669
Ref: #market-prices39865 Ref: #market-prices39834
Node: Declaring accounts40706 Node: Declaring accounts40675
Ref: #declaring-accounts40882 Ref: #declaring-accounts40851
Node: Account comments41807 Node: Account comments41776
Ref: #account-comments41970 Ref: #account-comments41939
Node: Account subdirectives42394 Node: Account subdirectives42363
Ref: #account-subdirectives42589 Ref: #account-subdirectives42558
Node: Account types42902 Node: Account types42871
Ref: #account-types43086 Ref: #account-types43055
Node: Account display order44728 Node: Account display order44697
Ref: #account-display-order44898 Ref: #account-display-order44867
Node: Rewriting accounts46049 Node: Rewriting accounts46018
Ref: #rewriting-accounts46234 Ref: #rewriting-accounts46203
Node: Basic aliases46960 Node: Basic aliases46929
Ref: #basic-aliases47106 Ref: #basic-aliases47075
Node: Regex aliases47810 Node: Regex aliases47779
Ref: #regex-aliases47982 Ref: #regex-aliases47951
Node: Combining aliases48700 Node: Combining aliases48669
Ref: #combining-aliases48878 Ref: #combining-aliases48847
Node: end aliases50154 Node: end aliases50123
Ref: #end-aliases50302 Ref: #end-aliases50271
Node: Default parent account50403 Node: Default parent account50372
Ref: #default-parent-account50569 Ref: #default-parent-account50538
Node: Periodic transactions51453 Node: Periodic transactions51422
Ref: #periodic-transactions51652 Ref: #periodic-transactions51621
Node: Periodic rule syntax53524 Node: Periodic rule syntax53493
Ref: #periodic-rule-syntax53730 Ref: #periodic-rule-syntax53699
Node: Two spaces between period expression and description!54434 Node: Two spaces between period expression and description!54403
Ref: #two-spaces-between-period-expression-and-description54753 Ref: #two-spaces-between-period-expression-and-description54722
Node: Forecasting with periodic transactions55437 Node: Forecasting with periodic transactions55406
Ref: #forecasting-with-periodic-transactions55742 Ref: #forecasting-with-periodic-transactions55711
Node: Budgeting with periodic transactions57768 Node: Budgeting with periodic transactions57737
Ref: #budgeting-with-periodic-transactions58007 Ref: #budgeting-with-periodic-transactions57976
Node: Auto postings / transaction modifiers58456 Node: Auto postings / transaction modifiers58425
Ref: #auto-postings-transaction-modifiers58668 Ref: #auto-postings-transaction-modifiers58637
Node: Auto postings and dates61153 Node: Auto postings and dates61122
Ref: #auto-postings-and-dates61410 Ref: #auto-postings-and-dates61379
Node: Auto postings and transaction balancing / inferred amounts / balance assertions61585 Node: Auto postings and transaction balancing / inferred amounts / balance assertions61554
Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions61960 Ref: #auto-postings-and-transaction-balancing-inferred-amounts-balance-assertions61929
Node: Auto posting tags62338 Node: Auto posting tags62307
Ref: #auto-posting-tags62577 Ref: #auto-posting-tags62546
 
End Tag Table End Tag Table

22
hledger-lib/hledger_journal.txt
View File

@ -710,16 +710,18 @@ FILE FORMAT
And some definitions: And some definitions:
subdirec- optional indented directive line immediately following a par- subdi- optional indented directive line immediately following a parent
tive ent directive rec- directive
number how to interpret numbers when parsing journal entries (the tive
notation identity of the decimal separator character). (Currently number how to interpret numbers when parsing journal entries (the iden-
each commodity can have its own notation, even in the same nota- tity of the decimal separator character). (Currently each com-
file.) tion modity can have its own notation, even in the same file.)
display how to display amounts of a commodity in reports (symbol side dis- how to display amounts of a commodity in reports (symbol side
style and spacing, digit groups, decimal separator, decimal places) play and spacing, digit groups, decimal separator, decimal places)
directive which entries and (when there are multiple files) which files style
scope are affected by a directive direc- which entries and (when there are multiple files) which files
tive are affected by a directive
scope
As you can see, directives vary in which journal entries and files they As you can see, directives vary in which journal entries and files they
affect, and whether they are focussed on input (parsing) or output (re- affect, and whether they are focussed on input (parsing) or output (re-

91
hledger/hledger.1
View File

@ -1117,7 +1117,7 @@ Examples:
.PP .PP
.TS .TS
tab(@); tab(@);
l l. lw(24.2n) lw(45.8n).
T{ T{
\f[C]2004/10/1\f[R], \f[C]2004-01-01\f[R], \f[C]2004.9.1\f[R] \f[C]2004/10/1\f[R], \f[C]2004-01-01\f[R], \f[C]2004.9.1\f[R]
T}@T{ T}@T{
@ -1176,7 +1176,7 @@ results:
.PP .PP
.TS .TS
tab(@); tab(@);
l l. lw(11.4n) lw(58.6n).
T{ T{
\f[C]201813\f[R] \f[C]201813\f[R]
T}@T{ T}@T{
@ -1230,12 +1230,11 @@ Examples:
.PP .PP
.TS .TS
tab(@); tab(@);
l l. lw(11.9n) lw(58.1n).
T{ T{
\f[C]-b 2016/3/17\f[R] \f[C]-b 2016/3/17\f[R]
T}@T{ T}@T{
begin on St. begin on St.\ Patrick\[cq]s day 2016
Patrick\[aq]s day 2016
T} T}
T{ T{
\f[C]-e 12/1\f[R] \f[C]-e 12/1\f[R]
@ -1362,21 +1361,21 @@ start and end date like so:
.PP .PP
.TS .TS
tab(@); tab(@);
l r. l l.
T{ T{
\f[C]-p \[dq]2009\[dq]\f[R] \f[C]-p \[dq]2009\[dq]\f[R]
T}@T{ T}@T{
the year 2009; equivalent to \[dq]2009/1/1 to 2010/1/1\[dq] the year 2009; equivalent to \[lq]2009/1/1 to 2010/1/1\[rq]
T} T}
T{ T{
\f[C]-p \[dq]2009/1\[dq]\f[R] \f[C]-p \[dq]2009/1\[dq]\f[R]
T}@T{ T}@T{
the month of jan; equivalent to \[dq]2009/1/1 to 2009/2/1\[dq] the month of jan; equivalent to \[lq]2009/1/1 to 2009/2/1\[rq]
T} T}
T{ T{
\f[C]-p \[dq]2009/1/1\[dq]\f[R] \f[C]-p \[dq]2009/1/1\[dq]\f[R]
T}@T{ T}@T{
just that day; equivalent to \[dq]2009/1/1 to 2009/1/2\[dq] just that day; equivalent to \[lq]2009/1/1 to 2009/1/2\[rq]
T} T}
.TE .TE
.PP .PP
@ -1415,22 +1414,27 @@ For example:
.PP .PP
.TS .TS
tab(@); tab(@);
l. lw(25.5n) lw(44.5n).
T{ T{
\f[C]-p \[dq]weekly from 2009/1/1 to 2009/4/1\[dq]\f[R] -- starts on \f[C]-p \[dq]weekly from 2009/1/1 to 2009/4/1\[dq]\f[R]
2008/12/29, closest preceding Monday T}@T{
starts on 2008/12/29, closest preceding Monday
T} T}
T{ T{
\f[C]-p \[dq]monthly in 2008/11/25\[dq]\f[R] -- starts on 2018/11/01 \f[C]-p \[dq]monthly in 2008/11/25\[dq]\f[R]
T}@T{
starts on 2018/11/01
T} T}
T{ T{
\f[C]-p \[dq]quarterly from 2009-05-05 to 2009-06-01\[dq]\f[R] - starts \f[C]-p \[dq]quarterly from 2009-05-05 to 2009-06-01\[dq]\f[R]
on 2009/04/01, ends on 2009/06/30, which are first and last days of Q2 T}@T{
2009 starts on 2009/04/01, ends on 2009/06/30, which are first and last days
of Q2 2009
T} T}
T{ T{
\f[C]-p \[dq]yearly from 2009-12-29\[dq]\f[R] - starts on 2009/01/01, \f[C]-p \[dq]yearly from 2009-12-29\[dq]\f[R]
first day of 2009 T}@T{
starts on 2009/01/01, first day of 2009
T} T}
.TE .TE
.PP .PP
@ -1446,18 +1450,21 @@ Examples:
.PP .PP
.TS .TS
tab(@); tab(@);
l. lw(25.5n) lw(44.5n).
T{ T{
\f[C]-p \[dq]bimonthly from 2008\[dq]\f[R] -- periods will have \f[C]-p \[dq]bimonthly from 2008\[dq]\f[R]
boundaries on 2008/01/01, 2008/03/01, ... T}@T{
periods will have boundaries on 2008/01/01, 2008/03/01, ...
T} T}
T{ T{
\f[C]-p \[dq]every 2 weeks\[dq]\f[R] -- starts on closest preceding \f[C]-p \[dq]every 2 weeks\[dq]\f[R]
Monday T}@T{
starts on closest preceding Monday
T} T}
T{ T{
\f[C]-p \[dq]every 5 month from 2009/03\[dq]\f[R] -- periods will have \f[C]-p \[dq]every 5 month from 2009/03\[dq]\f[R]
boundaries on 2009/03/01, 2009/08/01, ... T}@T{
periods will have boundaries on 2009/03/01, 2009/08/01, ...
T} T}
.TE .TE
.PP .PP
@ -1473,31 +1480,41 @@ Examples:
.PP .PP
.TS .TS
tab(@); tab(@);
l. lw(23.9n) lw(46.1n).
T{ T{
\f[C]-p \[dq]every 2nd day of week\[dq]\f[R] -- periods will go from Tue \f[C]-p \[dq]every 2nd day of week\[dq]\f[R]
to Tue T}@T{
periods will go from Tue to Tue
T} T}
T{ T{
\f[C]-p \[dq]every Tue\[dq]\f[R] -- same \f[C]-p \[dq]every Tue\[dq]\f[R]
T}@T{
same
T} T}
T{ T{
\f[C]-p \[dq]every 15th day\[dq]\f[R] -- period boundaries will be on \f[C]-p \[dq]every 15th day\[dq]\f[R]
15th of each month T}@T{
period boundaries will be on 15th of each month
T} T}
T{ T{
\f[C]-p \[dq]every 2nd Monday\[dq]\f[R] -- period boundaries will be on \f[C]-p \[dq]every 2nd Monday\[dq]\f[R]
second Monday of each month T}@T{
period boundaries will be on second Monday of each month
T} T}
T{ T{
\f[C]-p \[dq]every 11/05\[dq]\f[R] -- yearly periods with boundaries on \f[C]-p \[dq]every 11/05\[dq]\f[R]
5th of Nov T}@T{
yearly periods with boundaries on 5th of Nov
T} T}
T{ T{
\f[C]-p \[dq]every 5th Nov\[dq]\f[R] -- same \f[C]-p \[dq]every 5th Nov\[dq]\f[R]
T}@T{
same
T} T}
T{ T{
\f[C]-p \[dq]every Nov 5th\[dq]\f[R] -- same \f[C]-p \[dq]every Nov 5th\[dq]\f[R]
T}@T{
same
T} T}
.TE .TE
.PP .PP

338
hledger/hledger.info
View File

@ -1051,23 +1051,29 @@ omitted (defaulting to 1).
Examples: Examples:
'2004/10/1', '2004-01-01', '2004.9.1' exact date, several separators allowed. Year is 4+ digits, month is 1-12, day is 1-31 '2004/10/1', exact date, several separators allowed. Year
'2004-01-01', is 4+ digits, month is 1-12, day is 1-31
'2004.9.1'
'2004' start of year '2004' start of year
'2004/10' start of month '2004/10' start of month
'10/1' month and day in current year '10/1' month and day in current year
'21' day in current month '21' day in current month
'october, oct' start of month in current year 'october, oct' start of month in current year
'yesterday, today, tomorrow' -1, 0, 1 days from today 'yesterday, today, -1, 0, 1 days from today
tomorrow'
'last/this/next -1, 0, 1 periods from the current period 'last/this/next -1, 0, 1 periods from the current period
day/week/month/quarter/year' day/week/month/quarter/year'
'20181201' 8 digit YYYYMMDD with valid year month and day '20181201' 8 digit YYYYMMDD with valid year month and
day
'201812' 6 digit YYYYMM with valid year and month '201812' 6 digit YYYYMM with valid year and month
Counterexamples - malformed digit sequences might give surprising Counterexamples - malformed digit sequences might give surprising
results: results:
'201813' 6 digits with an invalid month is parsed as start of 6-digit year '201813' 6 digits with an invalid month is parsed as start of
'20181301' 8 digits with an invalid month is parsed as start of 8-digit year 6-digit year
'20181301' 8 digits with an invalid month is parsed as start of
8-digit year
'20181232' 8 digits with an invalid day gives an error '20181232' 8 digits with an invalid day gives an error
'201801012' 9+ digits beginning with a valid YYYYMMDD gives an error '201801012' 9+ digits beginning with a valid YYYYMMDD gives an error
@ -1100,10 +1106,14 @@ these accept the smart date syntax.
Examples: Examples:
'-b 2016/3/17' begin on St. Patrick's day 2016 '-b begin on St. Patrick's day 2016
'-e 12/1' end at the start of december 1st of the current year (11/30 will be the last date included) 2016/3/17'
'-b thismonth' all transactions on or after the 1st of the current month '-e 12/1' end at the start of december 1st of the current year
'-p thismonth' all transactions in the current month (11/30 will be the last date included)
'-b all transactions on or after the 1st of the current month
thismonth'
'-p all transactions in the current month
thismonth'
'date:2016/3/17-'the above written as queries instead 'date:2016/3/17-'the above written as queries instead
'date:-12/1' 'date:-12/1'
'date:thismonth-' 'date:thismonth-'
@ -1163,9 +1173,9 @@ the earliest or latest transaction in your journal:
A single date with no "from" or "to" defines both the start and end A single date with no "from" or "to" defines both the start and end
date like so: date like so:
'-p "2009"' the year 2009; equivalent to "2009/1/1 to 2010/1/1" '-p "2009"' the year 2009; equivalent to “2009/1/1 to 2010/1/1”
'-p "2009/1"' the month of jan; equivalent to "2009/1/1 to 2009/2/1" '-p "2009/1"' the month of jan; equivalent to “2009/1/1 to 2009/2/1”
'-p "2009/1/1"' just that day; equivalent to "2009/1/1 to 2009/1/2" '-p "2009/1/1"' just that day; equivalent to “2009/1/1 to 2009/1/2”
The argument of '-p' can also begin with, or be, a report interval The argument of '-p' can also begin with, or be, a report interval
expression. The basic report intervals are 'daily', 'weekly', expression. The basic report intervals are 'daily', 'weekly',
@ -1185,10 +1195,15 @@ date.
For example: For example:
'-p "weekly from 2009/1/1 to 2009/4/1"' - starts on 2008/12/29, closest preceding Monday '-p "weekly from starts on 2008/12/29, closest preceding
'-p "monthly in 2008/11/25"' - starts on 2018/11/01 2009/1/1 to 2009/4/1"' Monday
'-p "quarterly from 2009-05-05 to 2009-06-01"' - starts on 2009/04/01, ends on 2009/06/30, which are first and last days of Q2 2009 '-p "monthly in starts on 2018/11/01
'-p "yearly from 2009-12-29"' - starts on 2009/01/01, first day of 2009 2008/11/25"'
'-p "quarterly from starts on 2009/04/01, ends on 2009/06/30,
2009-05-05 to which are first and last days of Q2 2009
2009-06-01"'
'-p "yearly from starts on 2009/01/01, first day of 2009
2009-12-29"'
The following more complex report intervals are also supported: The following more complex report intervals are also supported:
'biweekly', 'bimonthly', 'every day|week|month|quarter|year', 'every N 'biweekly', 'bimonthly', 'every day|week|month|quarter|year', 'every N
@ -1199,9 +1214,11 @@ end on the last one, as described above.
Examples: Examples:
'-p "bimonthly from 2008"' - periods will have boundaries on 2008/01/01, 2008/03/01, ... '-p "bimonthly from periods will have boundaries on 2008/01/01,
'-p "every 2 weeks"' - starts on closest preceding Monday 2008"' 2008/03/01, ...
'-p "every 5 month from 2009/03"' - periods will have boundaries on 2009/03/01, 2009/08/01, ... '-p "every 2 weeks"' starts on closest preceding Monday
'-p "every 5 month from periods will have boundaries on 2009/03/01,
2009/03"' 2009/08/01, ...
If you want intervals that start on arbitrary day of your choosing If you want intervals that start on arbitrary day of your choosing
and span a week, month or year, you need to use any of the following: and span a week, month or year, you need to use any of the following:
@ -1212,13 +1229,16 @@ Nth MMM [of year]', 'every MMM Nth [of year]'.
Examples: Examples:
'-p "every 2nd day of week"' - periods will go from Tue to Tue '-p "every 2nd day of periods will go from Tue to Tue
'-p "every Tue"' - same week"'
'-p "every 15th day"' - period boundaries will be on 15th of each month '-p "every Tue"' same
'-p "every 2nd Monday"' - period boundaries will be on second Monday of each month '-p "every 15th day"' period boundaries will be on 15th of each
'-p "every 11/05"' - yearly periods with boundaries on 5th of Nov month
'-p "every 5th Nov"' - same '-p "every 2nd period boundaries will be on second Monday of
'-p "every Nov 5th"' - same Monday"' each month
'-p "every 11/05"' yearly periods with boundaries on 5th of Nov
'-p "every 5th Nov"' same
'-p "every Nov 5th"' same
Show historical balances at end of 15th each month (N is exclusive Show historical balances at end of 15th each month (N is exclusive
end date): end date):
@ -3696,139 +3716,139 @@ Node: Regular expressions32899
Ref: #regular-expressions33056 Ref: #regular-expressions33056
Node: Smart dates34417 Node: Smart dates34417
Ref: #smart-dates34568 Ref: #smart-dates34568
Node: Report start & end date35974 Node: Report start & end date35929
Ref: #report-start-end-date36146 Ref: #report-start-end-date36101
Node: Report intervals37570 Node: Report intervals37539
Ref: #report-intervals37735 Ref: #report-intervals37704
Node: Period expressions38125 Node: Period expressions38094
Ref: #period-expressions38285 Ref: #period-expressions38254
Node: Depth limiting42240 Node: Depth limiting42380
Ref: #depth-limiting42384 Ref: #depth-limiting42524
Node: Pivoting42726 Node: Pivoting42866
Ref: #pivoting42849 Ref: #pivoting42989
Node: Valuation44525 Node: Valuation44665
Ref: #valuation44627 Ref: #valuation44767
Node: -B Cost44807 Node: -B Cost44947
Ref: #b-cost44918 Ref: #b-cost45058
Node: -V Market value45116 Node: -V Market value45256
Ref: #v-market-value45290 Ref: #v-market-value45430
Node: -X Market value in specified commodity46722 Node: -X Market value in specified commodity46862
Ref: #x-market-value-in-specified-commodity46961 Ref: #x-market-value-in-specified-commodity47101
Node: --value Flexible valuation47137 Node: --value Flexible valuation47277
Ref: #value-flexible-valuation47363 Ref: #value-flexible-valuation47503
Node: Effect of --value on reports51553 Node: Effect of --value on reports51693
Ref: #effect-of---value-on-reports51769 Ref: #effect-of---value-on-reports51909
Node: Combining -B -V -X --value56700 Node: Combining -B -V -X --value56840
Ref: #combining--b--v--x---value56883 Ref: #combining--b--v--x---value57023
Node: COMMANDS56919 Node: COMMANDS57059
Ref: #commands57027 Ref: #commands57167
Node: accounts58111 Node: accounts58251
Ref: #accounts58209 Ref: #accounts58349
Node: activity58908 Node: activity59048
Ref: #activity59018 Ref: #activity59158
Node: add59401 Node: add59541
Ref: #add59500 Ref: #add59640
Node: balance62239 Node: balance62379
Ref: #balance62350 Ref: #balance62490
Node: Classic balance report63808 Node: Classic balance report63948
Ref: #classic-balance-report63981 Ref: #classic-balance-report64121
Node: Customising the classic balance report65350 Node: Customising the classic balance report65490
Ref: #customising-the-classic-balance-report65578 Ref: #customising-the-classic-balance-report65718
Node: Colour support67654 Node: Colour support67794
Ref: #colour-support67821 Ref: #colour-support67961
Node: Flat mode67994 Node: Flat mode68134
Ref: #flat-mode68142 Ref: #flat-mode68282
Node: Depth limited balance reports68555 Node: Depth limited balance reports68695
Ref: #depth-limited-balance-reports68740 Ref: #depth-limited-balance-reports68880
Node: Percentages69196 Node: Percentages69336
Ref: #percentages69362 Ref: #percentages69502
Node: Multicolumn balance report70499 Node: Multicolumn balance report70639
Ref: #multicolumn-balance-report70679 Ref: #multicolumn-balance-report70819
Node: Budget report75993 Node: Budget report76133
Ref: #budget-report76136 Ref: #budget-report76276
Node: Nested budgets81338 Node: Nested budgets81478
Ref: #nested-budgets81450 Ref: #nested-budgets81590
Ref: #output-format-184931 Ref: #output-format-185071
Node: balancesheet85009 Node: balancesheet85149
Ref: #balancesheet85145 Ref: #balancesheet85285
Node: balancesheetequity86528 Node: balancesheetequity86668
Ref: #balancesheetequity86677 Ref: #balancesheetequity86817
Node: cashflow87238 Node: cashflow87378
Ref: #cashflow87366 Ref: #cashflow87506
Node: check-dates88462 Node: check-dates88602
Ref: #check-dates88589 Ref: #check-dates88729
Node: check-dupes88868 Node: check-dupes89008
Ref: #check-dupes88992 Ref: #check-dupes89132
Node: close89285 Node: close89425
Ref: #close89399 Ref: #close89539
Node: close usage90921 Node: close usage91061
Ref: #close-usage91014 Ref: #close-usage91154
Node: commodities93827 Node: commodities93967
Ref: #commodities93954 Ref: #commodities94094
Node: descriptions94036 Node: descriptions94176
Ref: #descriptions94164 Ref: #descriptions94304
Node: diff94345 Node: diff94485
Ref: #diff94451 Ref: #diff94591
Node: files95498 Node: files95638
Ref: #files95598 Ref: #files95738
Node: help95745 Node: help95885
Ref: #help95845 Ref: #help95985
Node: import96926 Node: import97066
Ref: #import97040 Ref: #import97180
Node: Importing balance assignments97933 Node: Importing balance assignments98073
Ref: #importing-balance-assignments98081 Ref: #importing-balance-assignments98221
Node: incomestatement98730 Node: incomestatement98870
Ref: #incomestatement98863 Ref: #incomestatement99003
Node: notes100267 Node: notes100407
Ref: #notes100380 Ref: #notes100520
Node: payees100506 Node: payees100646
Ref: #payees100612 Ref: #payees100752
Node: prices100770 Node: prices100910
Ref: #prices100876 Ref: #prices101016
Node: print101217 Node: print101357
Ref: #print101327 Ref: #print101467
Node: print-unique105971 Node: print-unique106111
Ref: #print-unique106097 Ref: #print-unique106237
Node: register106382 Node: register106522
Ref: #register106509 Ref: #register106649
Node: Custom register output110681 Node: Custom register output110821
Ref: #custom-register-output110810 Ref: #custom-register-output110950
Node: register-match112072 Node: register-match112212
Ref: #register-match112206 Ref: #register-match112346
Node: rewrite112557 Node: rewrite112697
Ref: #rewrite112672 Ref: #rewrite112812
Node: Re-write rules in a file114527 Node: Re-write rules in a file114667
Ref: #re-write-rules-in-a-file114661 Ref: #re-write-rules-in-a-file114801
Node: Diff output format115871 Node: Diff output format116011
Ref: #diff-output-format116040 Ref: #diff-output-format116180
Node: rewrite vs print --auto117132 Node: rewrite vs print --auto117272
Ref: #rewrite-vs.-print---auto117311 Ref: #rewrite-vs.-print---auto117451
Node: roi117867 Node: roi118007
Ref: #roi117965 Ref: #roi118105
Node: stats118977 Node: stats119117
Ref: #stats119076 Ref: #stats119216
Node: tags119864 Node: tags120004
Ref: #tags119962 Ref: #tags120102
Node: test120256 Node: test120396
Ref: #test120364 Ref: #test120504
Node: Add-on Commands121111 Node: Add-on Commands121251
Ref: #add-on-commands121228 Ref: #add-on-commands121368
Node: ui122571 Node: ui122711
Ref: #ui122659 Ref: #ui122799
Node: web122713 Node: web122853
Ref: #web122816 Ref: #web122956
Node: iadd122932 Node: iadd123072
Ref: #iadd123043 Ref: #iadd123183
Node: interest123125 Node: interest123265
Ref: #interest123232 Ref: #interest123372
Node: ENVIRONMENT123472 Node: ENVIRONMENT123612
Ref: #environment123584 Ref: #environment123724
Node: FILES124413 Node: FILES124553
Ref: #files-1124516 Ref: #files-1124656
Node: LIMITATIONS124729 Node: LIMITATIONS124869
Ref: #limitations124848 Ref: #limitations124988
Node: TROUBLESHOOTING125590 Node: TROUBLESHOOTING125730
Ref: #troubleshooting125703 Ref: #troubleshooting125843
 
End Tag Table End Tag Table

118
hledger/hledger.txt
View File

@ -894,40 +894,30 @@ OPTIONS
Examples: Examples:
2004/10/1, 2004-01-01, exact date, several sepa- 2004/10/1, 2004-01-01, exact date, several separators allowed. Year
2004.9.1 rators allowed. Year is 2004.9.1 is 4+ digits, month is 1-12, day is 1-31
4+ digits, month is 1-12,
day is 1-31
2004 start of year 2004 start of year
2004/10 start of month 2004/10 start of month
10/1 month and day in current 10/1 month and day in current year
year
21 day in current month 21 day in current month
october, oct start of month in current october, oct start of month in current year
year yesterday, today, tomor- -1, 0, 1 days from today
yesterday, today, tomorrow -1, 0, 1 days from today row
last/this/next -1, 0, 1 periods from the last/this/next -1, 0, 1 periods from the current period
day/week/month/quar- current period day/week/month/quar-
ter/year ter/year
20181201 8 digit YYYYMMDD with 20181201 8 digit YYYYMMDD with valid year month and day
valid year month and day 201812 6 digit YYYYMM with valid year and month
201812 6 digit YYYYMM with valid
year and month
Counterexamples - malformed digit sequences might give surprising re- Counterexamples - malformed digit sequences might give surprising re-
sults: sults:
201813 6 digits with an invalid 201813 6 digits with an invalid month is parsed as start of
month is parsed as start 6-digit year
of 6-digit year 20181301 8 digits with an invalid month is parsed as start of
20181301 8 digits with an invalid 8-digit year
month is parsed as start 20181232 8 digits with an invalid day gives an error
of 8-digit year 201801012 9+ digits beginning with a valid YYYYMMDD gives an error
20181232 8 digits with an invalid
day gives an error
201801012 9+ digits beginning with a
valid YYYYMMDD gives an
error
Report start & end date Report start & end date
Most hledger reports show the full span of time represented by the Most hledger reports show the full span of time represented by the
@ -955,19 +945,12 @@ OPTIONS
Examples: Examples:
-b 2016/3/17 begin on St. Patrick's -b 2016/3/17 begin on St. Patrick's day 2016
day 2016 -e 12/1 end at the start of december 1st of the current year
-e 12/1 end at the start of decem- (11/30 will be the last date included)
ber 1st of the current -b thismonth all transactions on or after the 1st of the current month
year (11/30 will be the -p thismonth all transactions in the current month
last date included) date:2016/3/17- the above written as queries instead
-b thismonth all transactions on or af-
ter the 1st of the current
month
-p thismonth all transactions in the
current month
date:2016/3/17- the above written as
queries instead
date:-12/1 date:-12/1
date:thismonth- date:thismonth-
date:thismonth date:thismonth
@ -995,7 +978,6 @@ OPTIONS
"-". These are equivalent to the above: "-". These are equivalent to the above:
-p "2009/1/1 2009/4/1" -p "2009/1/1 2009/4/1"
-p2009/1/1to2009/4/1 -p2009/1/1to2009/4/1
-p2009/1/1-2009/4/1 -p2009/1/1-2009/4/1
@ -1013,6 +995,7 @@ 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
@ -1044,17 +1027,14 @@ OPTIONS
For example: For example:
-p "weekly from 2009/1/1 to 2009/4/1" -p "weekly from 2009/1/1 starts on 2008/12/29, closest preceding Mon-
-- starts on 2008/12/29, closest pre- to 2009/4/1" day
ceding Monday -p "monthly in starts on 2018/11/01
-p "monthly in 2008/11/25" -- starts on 2008/11/25"
2018/11/01 -p "quarterly from starts on 2009/04/01, ends on 2009/06/30,
-p "quarterly from 2009-05-05 to 2009-05-05 to 2009-06-01" which are first and last days of Q2 2009
2009-06-01" - starts on 2009/04/01, -p "yearly from starts on 2009/01/01, first day of 2009
ends on 2009/06/30, which are first and 2009-12-29"
last days of Q2 2009
-p "yearly from 2009-12-29" - starts on
2009/01/01, first day of 2009
The following more complex report intervals are also supported: bi- The following more complex report intervals are also supported: bi-
weekly, bimonthly, every day|week|month|quarter|year, every N weekly, bimonthly, every day|week|month|quarter|year, every N
@ -1065,14 +1045,11 @@ OPTIONS
Examples: Examples:
-p "bimonthly from 2008" -- periods -p "bimonthly from 2008" periods will have boundaries on 2008/01/01,
will have boundaries on 2008/01/01,
2008/03/01, ... 2008/03/01, ...
-p "every 2 weeks" -- starts on closest -p "every 2 weeks" starts on closest preceding Monday
preceding Monday -p "every 5 month from periods will have boundaries on 2009/03/01,
-p "every 5 month from 2009/03" -- pe- 2009/03" 2009/08/01, ...
riods will have boundaries on
2009/03/01, 2009/08/01, ...
If you want intervals that start on arbitrary day of your choosing and If you want intervals that start on arbitrary day of your choosing and
span a week, month or year, you need to use any of the following: span a week, month or year, you need to use any of the following:
@ -1083,18 +1060,17 @@ OPTIONS
Examples: Examples:
-p "every 2nd day of week" -- periods -p "every 2nd day of periods will go from Tue to Tue
will go from Tue to Tue week"
-p "every Tue" -- same
-p "every 15th day" -- period bound- -p "every Tue" same
aries will be on 15th of each month -p "every 15th day" period boundaries will be on 15th of each
-p "every 2nd Monday" -- period bound-
aries will be on second Monday of each
month month
-p "every 11/05" -- yearly periods with -p "every 2nd Monday" period boundaries will be on second Monday of
boundaries on 5th of Nov each month
-p "every 5th Nov" -- same -p "every 11/05" yearly periods with boundaries on 5th of Nov
-p "every Nov 5th" -- same -p "every 5th Nov" same
-p "every Nov 5th" same
Show historical balances at end of 15th each month (N is exclusive end Show historical balances at end of 15th each month (N is exclusive end
date): date):
@ -1403,9 +1379,6 @@ OPTIONS
ance (with -H) before report before report DATE/today ance (with -H) before report before report DATE/today
or journal or journal or journal or journal
start start start start
posting cost value at report value at report value at posting cost value at report value at report value at
amounts (no end or today or journal end DATE/today amounts (no end or today or journal end DATE/today
report inter- report inter-
@ -1424,6 +1397,7 @@ OPTIONS
report inter- end or today of or journal end DATE/today of report inter- end or today of or journal end DATE/today of
val) sums of post- of sums of sums of post- val) sums of post- of sums of sums of post-
ings postings ings ings postings ings
balances (with sums of costs value at period value at period value at balances (with sums of costs value at period value at period value at
report inter- ends of sums of ends of sums of DATE/today of report inter- ends of sums of ends of sums of DATE/today of
val) postings postings sums of post- val) postings postings sums of post-