cli: clearer command-line help for --date2 (fixes #604)

This commit is contained in:
Simon Michael 2017-08-21 17:19:06 -07:00
parent e0d9efeb86
commit d8696c5ea0
13 changed files with 522 additions and 516 deletions

View File

@ -127,7 +127,7 @@ m4_define({{_reportingoptions_}}, {{
: set start date, end date, and/or reporting interval all at once (overrides the flags above) : set start date, end date, and/or reporting interval all at once (overrides the flags above)
`--date2` `--date2`
: show, and match with -b/-e/-p/date:, secondary dates instead : match the secondary date instead (see command help for other effects)
`-U --unmarked` `-U --unmarked`
: include only unmarked postings/txns (can combine with -P or -C) : include only unmarked postings/txns (can combine with -P or -C)

View File

@ -142,7 +142,7 @@ set start date, end date, and/or reporting interval all at once
.RE .RE
.TP .TP
.B \f[C]\-\-date2\f[] .B \f[C]\-\-date2\f[]
show, and match with \-b/\-e/\-p/date:, secondary dates instead match the secondary date instead (see command help for other effects)
.RS .RS
.RE .RE
.TP .TP

View File

@ -103,7 +103,8 @@ the data.
(overrides the flags above) (overrides the flags above)
'--date2' '--date2'
show, and match with -b/-e/-p/date:, secondary dates instead match the secondary date instead (see command help for other
effects)
'-U --unmarked' '-U --unmarked'
include only unmarked postings/txns (can combine with -P or -C) include only unmarked postings/txns (can combine with -P or -C)
@ -357,17 +358,17 @@ Tag Table:
Node: Top73 Node: Top73
Node: OPTIONS831 Node: OPTIONS831
Ref: #options930 Ref: #options930
Node: KEYS3465 Node: KEYS3479
Ref: #keys3562 Ref: #keys3576
Node: SCREENS6358 Node: SCREENS6372
Ref: #screens6445 Ref: #screens6459
Node: Accounts screen6535 Node: Accounts screen6549
Ref: #accounts-screen6665 Ref: #accounts-screen6679
Node: Register screen8895 Node: Register screen8909
Ref: #register-screen9052 Ref: #register-screen9066
Node: Transaction screen11126 Node: Transaction screen11140
Ref: #transaction-screen11286 Ref: #transaction-screen11300
Node: Error screen12156 Node: Error screen12170
Ref: #error-screen12280 Ref: #error-screen12294
 
End Tag Table End Tag Table

View File

@ -99,7 +99,8 @@ OPTIONS
(overrides the flags above) (overrides the flags above)
--date2 --date2
show, and match with -b/-e/-p/date:, secondary dates instead match the secondary date instead (see command help for other
effects)
-U --unmarked -U --unmarked
include only unmarked postings/txns (can combine with -P or -C) include only unmarked postings/txns (can combine with -P or -C)

View File

@ -198,7 +198,7 @@ set start date, end date, and/or reporting interval all at once
.RE .RE
.TP .TP
.B \f[C]\-\-date2\f[] .B \f[C]\-\-date2\f[]
show, and match with \-b/\-e/\-p/date:, secondary dates instead match the secondary date instead (see command help for other effects)
.RS .RS
.RE .RE
.TP .TP

View File

@ -148,7 +148,8 @@ options as shown above.
(overrides the flags above) (overrides the flags above)
'--date2' '--date2'
show, and match with -b/-e/-p/date:, secondary dates instead match the secondary date instead (see command help for other
effects)
'-U --unmarked' '-U --unmarked'
include only unmarked postings/txns (can combine with -P or -C) include only unmarked postings/txns (can combine with -P or -C)

View File

@ -144,7 +144,8 @@ OPTIONS
(overrides the flags above) (overrides the flags above)
--date2 --date2
show, and match with -b/-e/-p/date:, secondary dates instead match the secondary date instead (see command help for other
effects)
-U --unmarked -U --unmarked
include only unmarked postings/txns (can combine with -P or -C) include only unmarked postings/txns (can combine with -P or -C)

View File

@ -138,7 +138,7 @@ reportflags = [
,flagNone ["quarterly","Q"] (setboolopt "quarterly") "multiperiod/multicolumn report by quarter" ,flagNone ["quarterly","Q"] (setboolopt "quarterly") "multiperiod/multicolumn report by quarter"
,flagNone ["yearly","Y"] (setboolopt "yearly") "multiperiod/multicolumn report by year" ,flagNone ["yearly","Y"] (setboolopt "yearly") "multiperiod/multicolumn report by year"
,flagReq ["period","p"] (\s opts -> Right $ setopt "period" s opts) "PERIODEXP" "set start date, end date, and/or report interval all at once (overrides the flags above)" ,flagReq ["period","p"] (\s opts -> Right $ setopt "period" s opts) "PERIODEXP" "set start date, end date, and/or report interval all at once (overrides the flags above)"
,flagNone ["date2"] (setboolopt "date2") "show, and make -b/-e/-p/date: match, secondary dates instead" ,flagNone ["date2"] (setboolopt "date2") "match the secondary date instead (see command help for other effects)"
,flagNone ["unmarked","U"] (setboolopt "unmarked") "include only unmarked postings/txns (can combine with -P or -C)" ,flagNone ["unmarked","U"] (setboolopt "unmarked") "include only unmarked postings/txns (can combine with -P or -C)"
,flagNone ["pending","P"] (setboolopt "pending") "include only pending postings/txns" ,flagNone ["pending","P"] (setboolopt "pending") "include only pending postings/txns"

View File

@ -28,7 +28,7 @@ import Hledger.Cli.Add ( transactionsSimilarTo )
printmode = (defCommandMode $ ["print"] ++ aliases) { printmode = (defCommandMode $ ["print"] ++ aliases) {
modeHelp = "show transaction journal entries" `withAliases` aliases modeHelp = "show transaction journal entries, sorted by date. With --date2, sort by secondary date instead." `withAliases` aliases
,modeGroupFlags = Group { ,modeGroupFlags = Group {
groupUnnamed = [ groupUnnamed = [
let matcharg = "STR" let matcharg = "STR"

View File

@ -29,7 +29,7 @@ import Hledger.Cli.Utils
registermode = (defCommandMode $ ["register"] ++ aliases) { registermode = (defCommandMode $ ["register"] ++ aliases) {
modeHelp = "show postings and running total" `withAliases` aliases modeHelp = "show postings and running total. With --date2, show and sort by secondary date instead." `withAliases` aliases
,modeGroupFlags = Group { ,modeGroupFlags = Group {
groupUnnamed = [ groupUnnamed = [
flagNone ["cumulative"] (\opts -> setboolopt "change" opts) flagNone ["cumulative"] (\opts -> setboolopt "change" opts)

View File

@ -253,7 +253,7 @@ set start date, end date, and/or reporting interval all at once
.RE .RE
.TP .TP
.B \f[C]\-\-date2\f[] .B \f[C]\-\-date2\f[]
show, and match with \-b/\-e/\-p/date:, secondary dates instead match the secondary date instead (see command help for other effects)
.RS .RS
.RE .RE
.TP .TP

View File

@ -203,7 +203,8 @@ different, like git.)
(overrides the flags above) (overrides the flags above)
'--date2' '--date2'
show, and match with -b/-e/-p/date:, secondary dates instead match the secondary date instead (see command help for other
effects)
'-U --unmarked' '-U --unmarked'
include only unmarked postings/txns (can combine with -P or -C) include only unmarked postings/txns (can combine with -P or -C)
@ -2087,121 +2088,121 @@ Node: OPTIONS3640
Ref: #options3744 Ref: #options3744
Node: General options4025 Node: General options4025
Ref: #general-options4152 Ref: #general-options4152
Node: Command options6484 Node: Command options6498
Ref: #command-options6637 Ref: #command-options6651
Node: Command arguments7035 Node: Command arguments7049
Ref: #command-arguments7195 Ref: #command-arguments7209
Node: Special characters7316 Node: Special characters7330
Ref: #special-characters7474 Ref: #special-characters7488
Node: Input files8642 Node: Input files8656
Ref: #input-files8780 Ref: #input-files8794
Node: Smart dates10743 Node: Smart dates10757
Ref: #smart-dates10886 Ref: #smart-dates10900
Node: Report start & end date11865 Node: Report start & end date11879
Ref: #report-start-end-date12037 Ref: #report-start-end-date12051
Node: Report intervals13103 Node: Report intervals13117
Ref: #report-intervals13268 Ref: #report-intervals13282
Node: Period expressions13669 Node: Period expressions13683
Ref: #period-expressions13829 Ref: #period-expressions13843
Node: Depth limiting16169 Node: Depth limiting16183
Ref: #depth-limiting16315 Ref: #depth-limiting16329
Node: Pivoting16516 Node: Pivoting16530
Ref: #pivoting16636 Ref: #pivoting16650
Node: Cost18407 Node: Cost18421
Ref: #cost18517 Ref: #cost18531
Node: Market value18635 Node: Market value18649
Ref: #market-value18772 Ref: #market-value18786
Node: Regular expressions20072 Node: Regular expressions20086
Ref: #regular-expressions20210 Ref: #regular-expressions20224
Node: QUERIES21571 Node: QUERIES21585
Ref: #queries21675 Ref: #queries21689
Node: COMMANDS25340 Node: COMMANDS25354
Ref: #commands25454 Ref: #commands25468
Node: accounts26110 Node: accounts26124
Ref: #accounts26210 Ref: #accounts26224
Node: activity27192 Node: activity27206
Ref: #activity27304 Ref: #activity27318
Node: add27663 Node: add27677
Ref: #add27764 Ref: #add27778
Node: balance30422 Node: balance30436
Ref: #balance30535 Ref: #balance30549
Node: Flat mode33550 Node: Flat mode33564
Ref: #flat-mode33677 Ref: #flat-mode33691
Node: Depth limited balance reports34097 Node: Depth limited balance reports34111
Ref: #depth-limited-balance-reports34300 Ref: #depth-limited-balance-reports34314
Node: Multicolumn balance reports34720 Node: Multicolumn balance reports34734
Ref: #multicolumn-balance-reports34931 Ref: #multicolumn-balance-reports34945
Node: Custom balance output39579 Node: Custom balance output39593
Ref: #custom-balance-output39763 Ref: #custom-balance-output39777
Node: Colour support41856 Node: Colour support41870
Ref: #colour-support42017 Ref: #colour-support42031
Node: Output destination42190 Node: Output destination42204
Ref: #output-destination42348 Ref: #output-destination42362
Node: CSV output42618 Node: CSV output42632
Ref: #csv-output42737 Ref: #csv-output42751
Node: balancesheet43134 Node: balancesheet43148
Ref: #balancesheet43262 Ref: #balancesheet43276
Node: cashflow45169 Node: cashflow45183
Ref: #cashflow45286 Ref: #cashflow45300
Node: help47154 Node: help47168
Ref: #help47266 Ref: #help47280
Node: incomestatement48340 Node: incomestatement48354
Ref: #incomestatement48471 Ref: #incomestatement48485
Node: print50363 Node: print50377
Ref: #print50478 Ref: #print50492
Node: register54234 Node: register54248
Ref: #register54347 Ref: #register54361
Node: Custom register output58843 Node: Custom register output58857
Ref: #custom-register-output58974 Ref: #custom-register-output58988
Node: stats60271 Node: stats60285
Ref: #stats60377 Ref: #stats60391
Node: test61258 Node: test61272
Ref: #test61345 Ref: #test61359
Node: ADD-ON COMMANDS61713 Node: ADD-ON COMMANDS61727
Ref: #add-on-commands61825 Ref: #add-on-commands61839
Node: Official add-ons63112 Node: Official add-ons63126
Ref: #official-add-ons63254 Ref: #official-add-ons63268
Node: api63341 Node: api63355
Ref: #api63432 Ref: #api63446
Node: ui63484 Node: ui63498
Ref: #ui63585 Ref: #ui63599
Node: web63643 Node: web63657
Ref: #web63734 Ref: #web63748
Node: Third party add-ons63780 Node: Third party add-ons63794
Ref: #third-party-add-ons63957 Ref: #third-party-add-ons63971
Node: diff64092 Node: diff64106
Ref: #diff64191 Ref: #diff64205
Node: iadd64290 Node: iadd64304
Ref: #iadd64406 Ref: #iadd64420
Node: interest64489 Node: interest64503
Ref: #interest64612 Ref: #interest64626
Node: irr64707 Node: irr64721
Ref: #irr64807 Ref: #irr64821
Node: Experimental add-ons64885 Node: Experimental add-ons64899
Ref: #experimental-add-ons65039 Ref: #experimental-add-ons65053
Node: autosync65441 Node: autosync65455
Ref: #autosync65555 Ref: #autosync65569
Node: budget65794 Node: budget65808
Ref: #budget65918 Ref: #budget65932
Node: chart65984 Node: chart65998
Ref: #chart66103 Ref: #chart66117
Node: check66174 Node: check66188
Ref: #check66298 Ref: #check66312
Node: check-dates66365 Node: check-dates66379
Ref: #check-dates66507 Ref: #check-dates66521
Node: check-dupes66580 Node: check-dupes66594
Ref: #check-dupes66723 Ref: #check-dupes66737
Node: equity66800 Node: equity66814
Ref: #equity66928 Ref: #equity66942
Node: prices67047 Node: prices67061
Ref: #prices67176 Ref: #prices67190
Node: print-unique67231 Node: print-unique67245
Ref: #print-unique67380 Ref: #print-unique67394
Node: register-match67473 Node: register-match67487
Ref: #register-match67629 Ref: #register-match67643
Node: rewrite67727 Node: rewrite67741
Ref: #rewrite67861 Ref: #rewrite67875
Node: tags67939 Node: tags67953
Ref: #tags68044 Ref: #tags68058
 
End Tag Table End Tag Table

View File

@ -174,7 +174,8 @@ OPTIONS
(overrides the flags above) (overrides the flags above)
--date2 --date2
show, and match with -b/-e/-p/date:, secondary dates instead match the secondary date instead (see command help for other
effects)
-U --unmarked -U --unmarked
include only unmarked postings/txns (can combine with -P or -C) include only unmarked postings/txns (can combine with -P or -C)