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

doc: update builtin manuals

Browse Source
This commit is contained in:
Simon Michael 2017-06-15 18:47:28 -07:00
parent 22e751983b
commit 40699af34a
9 changed files with 431 additions and 422 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
hledger-ui/doc/hledger-ui.1
View File

@ -146,8 +146,8 @@ show, and match with \-b/\-e/\-p/date:, secondary dates instead
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-C\ \-\-cleared\f[] .B \f[C]\-U\ \-\-unmarked\f[]
include only cleared postings/txns include only unmarked postings/txns (can combine with \-P or \-C)
.RS .RS
.RE .RE
.TP .TP
@ -156,8 +156,8 @@ include only pending postings/txns
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-U\ \-\-unmarked\f[] .B \f[C]\-C\ \-\-cleared\f[]
include only unmarked postings/txns include only cleared postings/txns
.RS .RS
.RE .RE
.TP .TP
@ -322,11 +322,13 @@ Period balances ignore transactions before the report start date, so
they show the change in balance during the report period. they show the change in balance during the report period.
They are more useful eg when viewing a time log. They are more useful eg when viewing a time log.
.PP .PP
\f[C]C\f[] toggles cleared mode, which shows balances for postings with \f[C]U\f[] toggles filtering by unmarked status, including or excluding
cleared status only. unmarked postings in the balances.
Similarly, \f[C]P\f[] toggles pending mode, which shows balances for Similarly, \f[C]P\f[] toggles pending postings, and \f[C]C\f[] toggles
pending postings only, and \f[C]U\f[] toggles uncleared mode, which cleared postings.
shows balances for unmarked postings only. (By default, balances include all postings; if you activate one or two
status filters, only those postings are included; and if you activate
all three, the filter is removed.)
.PP .PP
\f[C]R\f[] toggles real mode, in which virtual postings are ignored. \f[C]R\f[] toggles real mode, in which virtual postings are ignored.
.PP .PP
@ -368,11 +370,13 @@ In other words, the register always shows the transactions responsible
for the period balance shown on the accounts screen. for the period balance shown on the accounts screen.
As on the accounts screen, this can be toggled with \f[C]F\f[]. As on the accounts screen, this can be toggled with \f[C]F\f[].
.PP .PP
\f[C]C\f[] toggles cleared mode, which shows transactions with cleared \f[C]U\f[] toggles filtering by unmarked status, showing or hiding
status only.
Similarly, \f[C]P\f[] toggles pending mode, which shows only pending
transactions, and \f[C]U\f[] toggles uncleared mode, which shows only
unmarked transactions. unmarked transactions.
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
.PP .PP
\f[C]R\f[] toggles real mode, in which virtual postings are ignored. \f[C]R\f[] toggles real mode, in which virtual postings are ignored.
.PP .PP

52
hledger-ui/doc/hledger-ui.1.info
View File

@ -104,15 +104,15 @@ the data.
'--date2' '--date2'
show, and match with -b/-e/-p/date:, secondary dates instead show, and match with -b/-e/-p/date:, secondary dates instead
'-C --cleared' '-U --unmarked'
include only cleared postings/txns include only unmarked postings/txns (can combine with -P or -C)
'-P --pending' '-P --pending'
include only pending postings/txns include only pending postings/txns
'-U --unmarked' '-C --cleared'
include only unmarked postings/txns include only cleared postings/txns
'-R --real' '-R --real'
include only non-virtual postings include only non-virtual postings
@ -260,10 +260,12 @@ disturbed by a filter query). Period balances ignore transactions
before the report start date, so they show the change in balance during before the report start date, so they show the change in balance during
the report period. They are more useful eg when viewing a time log. the report period. They are more useful eg when viewing a time log.
'C' toggles cleared mode, which shows balances for postings with 'U' toggles filtering by unmarked status, including or excluding
cleared status only. Similarly, 'P' toggles pending mode, which shows unmarked postings in the balances. Similarly, 'P' toggles pending
balances for pending postings only, and 'U' toggles uncleared mode, postings, and 'C' toggles cleared postings. (By default, balances
which shows balances for unmarked postings only. include all postings; if you activate one or two status filters, only
those postings are included; and if you activate all three, the filter
is removed.)
'R' toggles real mode, in which virtual postings are ignored. 'R' toggles real mode, in which virtual postings are ignored.
@ -305,10 +307,12 @@ subaccounts. In other words, the register always shows the transactions
responsible for the period balance shown on the accounts screen. As on responsible for the period balance shown on the accounts screen. As on
the accounts screen, this can be toggled with 'F'. the accounts screen, this can be toggled with 'F'.
'C' toggles cleared mode, which shows transactions with cleared 'U' toggles filtering by unmarked status, showing or hiding unmarked
status only. Similarly, 'P' toggles pending mode, which shows only transactions. Similarly, 'P' toggles pending transactions, and 'C'
pending transactions, and 'U' toggles uncleared mode, which shows only toggles cleared transactions. (By default, transactions with all
unmarked transactions. 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
'R' toggles real mode, in which virtual postings are ignored. 'R' toggles real mode, in which virtual postings are ignored.
@ -359,17 +363,17 @@ Tag Table:
Node: Top73 Node: Top73
Node: OPTIONS831 Node: OPTIONS831
Ref: #options930 Ref: #options930
Node: KEYS3643 Node: KEYS3671
Ref: #keys3740 Ref: #keys3768
Node: SCREENS6329 Node: SCREENS6357
Ref: #screens6416 Ref: #screens6444
Node: Accounts screen6506 Node: Accounts screen6534
Ref: #accounts-screen6636 Ref: #accounts-screen6664
Node: Register screen8766 Node: Register screen8894
Ref: #register-screen8923 Ref: #register-screen9051
Node: Transaction screen10866 Node: Transaction screen11125
Ref: #transaction-screen11026 Ref: #transaction-screen11285
Node: Error screen11896 Node: Error screen12155
Ref: #error-screen12020 Ref: #error-screen12279
 
End Tag Table End Tag Table

27
hledger-ui/doc/hledger-ui.1.txt
View File

@ -101,14 +101,14 @@ OPTIONS
--date2 --date2
show, and match with -b/-e/-p/date:, secondary dates instead show, and match with -b/-e/-p/date:, secondary dates instead
-C --cleared -U --unmarked
include only cleared postings/txns include only unmarked postings/txns (can combine with -P or -C)
-P --pending -P --pending
include only pending postings/txns include only pending postings/txns
-U --unmarked -C --cleared
include only unmarked postings/txns include only cleared postings/txns
-R --real -R --real
include only non-virtual postings include only non-virtual postings
@ -226,10 +226,11 @@ SCREENS
before the report start date, so they show the change in balance during before the report start date, so they show the change in balance during
the report period. They are more useful eg when viewing a time log. the report period. They are more useful eg when viewing a time log.
C toggles cleared mode, which shows balances for postings with cleared U toggles filtering by unmarked status, including or excluding unmarked
status only. Similarly, P toggles pending mode, which shows balances postings in the balances. Similarly, P toggles pending postings, and C
for pending postings only, and U toggles uncleared mode, which shows toggles cleared postings. (By default, balances include all postings;
balances for unmarked postings only. if you activate one or two status filters, only those postings are
included; and if you activate all three, the filter is removed.)
R toggles real mode, in which virtual postings are ignored. R toggles real mode, in which virtual postings are ignored.
@ -266,10 +267,12 @@ SCREENS
actions responsible for the period balance shown on the accounts actions responsible for the period balance shown on the accounts
screen. As on the accounts screen, this can be toggled with F. screen. As on the accounts screen, this can be toggled with F.
C toggles cleared mode, which shows transactions with cleared status U toggles filtering by unmarked status, showing or hiding unmarked
only. Similarly, P toggles pending mode, which shows only pending transactions. Similarly, P toggles pending transactions, and C toggles
transactions, and U toggles uncleared mode, which shows only unmarked cleared transactions. (By default, transactions with all statuses are
transactions. 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
R toggles real mode, in which virtual postings are ignored. R toggles real mode, in which virtual postings are ignored.

8
hledger-web/doc/hledger-web.1
View File

@ -202,8 +202,8 @@ show, and match with \-b/\-e/\-p/date:, secondary dates instead
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-C\ \-\-cleared\f[] .B \f[C]\-U\ \-\-unmarked\f[]
include only cleared postings/txns include only unmarked postings/txns (can combine with \-P or \-C)
.RS .RS
.RE .RE
.TP .TP
@ -212,8 +212,8 @@ include only pending postings/txns
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-U\ \-\-unmarked\f[] .B \f[C]\-C\ \-\-cleared\f[]
include only unmarked postings/txns include only cleared postings/txns
.RS .RS
.RE .RE
.TP .TP

8
hledger-web/doc/hledger-web.1.info
View File

@ -149,15 +149,15 @@ options as shown above.
'--date2' '--date2'
show, and match with -b/-e/-p/date:, secondary dates instead show, and match with -b/-e/-p/date:, secondary dates instead
'-C --cleared' '-U --unmarked'
include only cleared postings/txns include only unmarked postings/txns (can combine with -P or -C)
'-P --pending' '-P --pending'
include only pending postings/txns include only pending postings/txns
'-U --unmarked' '-C --cleared'
include only unmarked postings/txns include only cleared postings/txns
'-R --real' '-R --real'
include only non-virtual postings include only non-virtual postings

8
hledger-web/doc/hledger-web.1.txt
View File

@ -146,14 +146,14 @@ OPTIONS
--date2 --date2
show, and match with -b/-e/-p/date:, secondary dates instead show, and match with -b/-e/-p/date:, secondary dates instead
-C --cleared -U --unmarked
include only cleared postings/txns include only unmarked postings/txns (can combine with -P or -C)
-P --pending -P --pending
include only pending postings/txns include only pending postings/txns
-U --unmarked -C --cleared
include only unmarked postings/txns include only cleared postings/txns
-R --real -R --real
include only non-virtual postings include only non-virtual postings

12
hledger/doc/hledger.1
View File

@ -273,8 +273,8 @@ show, and match with \-b/\-e/\-p/date:, secondary dates instead
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-C\ \-\-cleared\f[] .B \f[C]\-U\ \-\-unmarked\f[]
include only cleared postings/txns include only unmarked postings/txns (can combine with \-P or \-C)
.RS .RS
.RE .RE
.TP .TP
@ -283,8 +283,8 @@ include only pending postings/txns
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-U\ \-\-unmarked\f[] .B \f[C]\-C\ \-\-cleared\f[]
include only unmarked postings/txns include only cleared postings/txns
.RS .RS
.RE .RE
.TP .TP
@ -1052,8 +1052,8 @@ match real or virtual postings respectively
.RS .RS
.RE .RE
.TP .TP
.B \f[B]\f[C]status:*,\ status:!,\ status:\f[]\f[] .B \f[B]\f[C]status:,\ status:!,\ status:*\f[]\f[]
match cleared, pending, or uncleared/pending transactions respectively match unmarked, pending, or cleared transactions respectively
.RS .RS
.RE .RE
.TP .TP

249
hledger/doc/hledger.1.info
View File

@ -214,15 +214,15 @@ different, like git.)
'--date2' '--date2'
show, and match with -b/-e/-p/date:, secondary dates instead show, and match with -b/-e/-p/date:, secondary dates instead
'-C --cleared' '-U --unmarked'
include only cleared postings/txns include only unmarked postings/txns (can combine with -P or -C)
'-P --pending' '-P --pending'
include only pending postings/txns include only pending postings/txns
'-U --unmarked' '-C --cleared'
include only unmarked postings/txns include only cleared postings/txns
'-R --real' '-R --real'
include only non-virtual postings include only non-virtual postings
@ -744,10 +744,9 @@ match (or negatively match)
*'real:, real:0'* *'real:, real:0'*
match real or virtual postings respectively match real or virtual postings respectively
*'status:*, status:!, status:'* *'status:, status:!, status:*'*
match cleared, pending, or uncleared/pending transactions match unmarked, pending, or cleared transactions respectively
respectively
*'tag:REGEX[=REGEX]'* *'tag:REGEX[=REGEX]'*
match by tag name, and optionally also by tag value. Note a tag: match by tag name, and optionally also by tag value. Note a tag:
@ -2120,123 +2119,123 @@ Node: OPTIONS3640
Ref: #options3744 Ref: #options3744
Node: General options4025 Node: General options4025
Ref: #general-options4152 Ref: #general-options4152
Node: Command options6662 Node: Command options6690
Ref: #command-options6815 Ref: #command-options6843
Node: Command arguments7213 Node: Command arguments7241
Ref: #command-arguments7373 Ref: #command-arguments7401
Node: Special characters7494 Node: Special characters7522
Ref: #special-characters7652 Ref: #special-characters7680
Node: Input files8820 Node: Input files8848
Ref: #input-files8958 Ref: #input-files8986
Node: Smart dates10921 Node: Smart dates10949
Ref: #smart-dates11064 Ref: #smart-dates11092
Node: Report start & end date12043 Node: Report start & end date12071
Ref: #report-start-end-date12215 Ref: #report-start-end-date12243
Node: Report intervals13281 Node: Report intervals13309
Ref: #report-intervals13446 Ref: #report-intervals13474
Node: Period expressions13847 Node: Period expressions13875
Ref: #period-expressions14007 Ref: #period-expressions14035
Node: Depth limiting16347 Node: Depth limiting16375
Ref: #depth-limiting16493 Ref: #depth-limiting16521
Node: Pivoting16694 Node: Pivoting16722
Ref: #pivoting16814 Ref: #pivoting16842
Node: Cost18585 Node: Cost18613
Ref: #cost18695 Ref: #cost18723
Node: Market value18813 Node: Market value18841
Ref: #market-value18950 Ref: #market-value18978
Node: Regular expressions20250 Node: Regular expressions20278
Ref: #regular-expressions20388 Ref: #regular-expressions20416
Node: QUERIES21749 Node: QUERIES21777
Ref: #queries21853 Ref: #queries21881
Node: COMMANDS25532 Node: COMMANDS25546
Ref: #commands25646 Ref: #commands25660
Node: accounts26319 Node: accounts26333
Ref: #accounts26419 Ref: #accounts26433
Node: activity27401 Node: activity27415
Ref: #activity27513 Ref: #activity27527
Node: add27872 Node: add27886
Ref: #add27973 Ref: #add27987
Node: balance30631 Node: balance30645
Ref: #balance30744 Ref: #balance30758
Node: Flat mode33759 Node: Flat mode33773
Ref: #flat-mode33886 Ref: #flat-mode33900
Node: Depth limited balance reports34306 Node: Depth limited balance reports34320
Ref: #depth-limited-balance-reports34509 Ref: #depth-limited-balance-reports34523
Node: Multicolumn balance reports34929 Node: Multicolumn balance reports34943
Ref: #multicolumn-balance-reports35140 Ref: #multicolumn-balance-reports35154
Node: Custom balance output39788 Node: Custom balance output39802
Ref: #custom-balance-output39972 Ref: #custom-balance-output39986
Node: Colour support42065 Node: Colour support42079
Ref: #colour-support42226 Ref: #colour-support42240
Node: Output destination42399 Node: Output destination42413
Ref: #output-destination42557 Ref: #output-destination42571
Node: CSV output42827 Node: CSV output42841
Ref: #csv-output42946 Ref: #csv-output42960
Node: balancesheet43343 Node: balancesheet43357
Ref: #balancesheet43471 Ref: #balancesheet43485
Node: cashflow45378 Node: cashflow45392
Ref: #cashflow45495 Ref: #cashflow45509
Node: help47363 Node: help47377
Ref: #help47475 Ref: #help47489
Node: incomestatement48313 Node: incomestatement48327
Ref: #incomestatement48443 Ref: #incomestatement48457
Node: info50335 Node: info50349
Ref: #info50442 Ref: #info50456
Node: man50806 Node: man50820
Ref: #man50903 Ref: #man50917
Node: print51308 Node: print51322
Ref: #print51413 Ref: #print51427
Node: register55169 Node: register55183
Ref: #register55282 Ref: #register55296
Node: Custom register output59778 Node: Custom register output59792
Ref: #custom-register-output59909 Ref: #custom-register-output59923
Node: stats61206 Node: stats61220
Ref: #stats61312 Ref: #stats61326
Node: test62193 Node: test62207
Ref: #test62280 Ref: #test62294
Node: ADD-ON COMMANDS62648 Node: ADD-ON COMMANDS62662
Ref: #add-on-commands62760 Ref: #add-on-commands62774
Node: Official add-ons64047 Node: Official add-ons64061
Ref: #official-add-ons64189 Ref: #official-add-ons64203
Node: api64276 Node: api64290
Ref: #api64367 Ref: #api64381
Node: ui64419 Node: ui64433
Ref: #ui64520 Ref: #ui64534
Node: web64578 Node: web64592
Ref: #web64669 Ref: #web64683
Node: Third party add-ons64715 Node: Third party add-ons64729
Ref: #third-party-add-ons64892 Ref: #third-party-add-ons64906
Node: diff65027 Node: diff65041
Ref: #diff65126 Ref: #diff65140
Node: iadd65225 Node: iadd65239
Ref: #iadd65341 Ref: #iadd65355
Node: interest65424 Node: interest65438
Ref: #interest65547 Ref: #interest65561
Node: irr65642 Node: irr65656
Ref: #irr65742 Ref: #irr65756
Node: Experimental add-ons65820 Node: Experimental add-ons65834
Ref: #experimental-add-ons65974 Ref: #experimental-add-ons65988
Node: autosync66367 Node: autosync66381
Ref: #autosync66481 Ref: #autosync66495
Node: budget66720 Node: budget66734
Ref: #budget66844 Ref: #budget66858
Node: chart66910 Node: chart66924
Ref: #chart67029 Ref: #chart67043
Node: check67100 Node: check67114
Ref: #check67224 Ref: #check67238
Node: check-dates67291 Node: check-dates67305
Ref: #check-dates67433 Ref: #check-dates67447
Node: check-dupes67506 Node: check-dupes67520
Ref: #check-dupes67649 Ref: #check-dupes67663
Node: equity67726 Node: equity67740
Ref: #equity67854 Ref: #equity67868
Node: prices67973 Node: prices67987
Ref: #prices68102 Ref: #prices68116
Node: print-unique68157 Node: print-unique68171
Ref: #print-unique68306 Ref: #print-unique68320
Node: register-match68399 Node: register-match68413
Ref: #register-match68555 Ref: #register-match68569
Node: rewrite68653 Node: rewrite68667
Ref: #rewrite68774 Ref: #rewrite68788
 
End Tag Table End Tag Table

13
hledger/doc/hledger.1.txt
View File

@ -182,14 +182,14 @@ OPTIONS
--date2 --date2
show, and match with -b/-e/-p/date:, secondary dates instead show, and match with -b/-e/-p/date:, secondary dates instead
-C --cleared -U --unmarked
include only cleared postings/txns include only unmarked postings/txns (can combine with -P or -C)
-P --pending -P --pending
include only pending postings/txns include only pending postings/txns
-U --unmarked -C --cleared
include only unmarked postings/txns include only cleared postings/txns
-R --real -R --real
include only non-virtual postings include only non-virtual postings
@ -684,9 +684,8 @@ QUERIES
real:, real:0 real:, real:0
match real or virtual postings respectively match real or virtual postings respectively
status:*, status:!, status: status:, status:!, status:*
match cleared, pending, or uncleared/pending transactions match unmarked, pending, or cleared transactions respectively
respectively
tag:REGEX[=REGEX] tag:REGEX[=REGEX]
match by tag name, and optionally also by tag value. Note a match by tag name, and optionally also by tag value. Note a