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
.RE
.TP
.B \f[C]\-C\ \-\-cleared\f[]
include only cleared postings/txns
.B \f[C]\-U\ \-\-unmarked\f[]
include only unmarked postings/txns (can combine with \-P or \-C)
.RS
.RE
.TP
@ -156,8 +156,8 @@ include only pending postings/txns
.RS
.RE
.TP
.B \f[C]\-U\ \-\-unmarked\f[]
include only unmarked postings/txns
.B \f[C]\-C\ \-\-cleared\f[]
include only cleared postings/txns
.RS
.RE
.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 are more useful eg when viewing a time log.
.PP
\f[C]C\f[] toggles cleared mode, which shows balances for postings with
cleared status only.
Similarly, \f[C]P\f[] toggles pending mode, which shows balances for
pending postings only, and \f[C]U\f[] toggles uncleared mode, which
shows balances for unmarked postings only.
\f[C]U\f[] toggles filtering by unmarked status, including or excluding
unmarked postings in the balances.
Similarly, \f[C]P\f[] toggles pending postings, and \f[C]C\f[] toggles
cleared postings.
(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
\f[C]R\f[] toggles real mode, in which virtual postings are ignored.
.PP
@ -368,11 +370,13 @@ In other words, the register always shows the transactions responsible
for the period balance shown on the accounts screen.
As on the accounts screen, this can be toggled with \f[C]F\f[].
.PP
\f[C]C\f[] toggles cleared mode, which shows transactions with cleared
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
\f[C]U\f[] toggles filtering by unmarked status, showing or hiding
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
\f[C]R\f[] toggles real mode, in which virtual postings are ignored.
.PP

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

@ -104,15 +104,15 @@ the data.
'--date2'
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'
include only pending postings/txns
'-U --unmarked'
'-C --cleared'
include only unmarked postings/txns
include only cleared postings/txns
'-R --real'
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
the report period. They are more useful eg when viewing a time log.
'C' toggles cleared mode, which shows balances for postings with
cleared status only. Similarly, 'P' toggles pending mode, which shows
balances for pending postings only, and 'U' toggles uncleared mode,
which shows balances for unmarked postings only.
'U' toggles filtering by unmarked status, including or excluding
unmarked postings in the balances. Similarly, 'P' toggles pending
postings, and 'C' toggles cleared postings. (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.)
'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
the accounts screen, this can be toggled with 'F'.
'C' toggles cleared mode, which shows transactions with cleared
status only. Similarly, 'P' toggles pending mode, which shows only
pending transactions, and 'U' toggles uncleared mode, which shows only
unmarked transactions.
'U' toggles filtering by unmarked status, showing or hiding unmarked
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
'R' toggles real mode, in which virtual postings are ignored.
@ -359,17 +363,17 @@ Tag Table:
Node: Top73
Node: OPTIONS831
Ref: #options930
Node: KEYS3643
Ref: #keys3740
Node: SCREENS6329
Ref: #screens6416
Node: Accounts screen6506
Ref: #accounts-screen6636
Node: Register screen8766
Ref: #register-screen8923
Node: Transaction screen10866
Ref: #transaction-screen11026
Node: Error screen11896
Ref: #error-screen12020
Node: KEYS3671
Ref: #keys3768
Node: SCREENS6357
Ref: #screens6444
Node: Accounts screen6534
Ref: #accounts-screen6664
Node: Register screen8894
Ref: #register-screen9051
Node: Transaction screen11125
Ref: #transaction-screen11285
Node: Error screen12155
Ref: #error-screen12279

End Tag Table

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

@ -101,14 +101,14 @@ OPTIONS
--date2
show, and match with -b/-e/-p/date:, secondary dates instead
-C --cleared
include only cleared postings/txns
-U --unmarked
include only unmarked postings/txns (can combine with -P or -C)
-P --pending
include only pending postings/txns
-U --unmarked
include only unmarked postings/txns
-C --cleared
include only cleared postings/txns
-R --real
include only non-virtual postings
@ -226,10 +226,11 @@ SCREENS
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.
C toggles cleared mode, which shows balances for postings with cleared
status only. Similarly, P toggles pending mode, which shows balances
for pending postings only, and U toggles uncleared mode, which shows
balances for unmarked postings only.
U toggles filtering by unmarked status, including or excluding unmarked
postings in the balances. Similarly, P toggles pending postings, and C
toggles cleared postings. (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.)
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
screen. As on the accounts screen, this can be toggled with F.
C toggles cleared mode, which shows transactions with cleared status
only. Similarly, P toggles pending mode, which shows only pending
transactions, and U toggles uncleared mode, which shows only unmarked
transactions.
U toggles filtering by unmarked status, showing or hiding unmarked
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
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
.RE
.TP
.B \f[C]\-C\ \-\-cleared\f[]
include only cleared postings/txns
.B \f[C]\-U\ \-\-unmarked\f[]
include only unmarked postings/txns (can combine with \-P or \-C)
.RS
.RE
.TP
@ -212,8 +212,8 @@ include only pending postings/txns
.RS
.RE
.TP
.B \f[C]\-U\ \-\-unmarked\f[]
include only unmarked postings/txns
.B \f[C]\-C\ \-\-cleared\f[]
include only cleared postings/txns
.RS
.RE
.TP

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

@ -149,15 +149,15 @@ options as shown above.
'--date2'
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'
include only pending postings/txns
'-U --unmarked'
'-C --cleared'
include only unmarked postings/txns
include only cleared postings/txns
'-R --real'
include only non-virtual postings

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

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

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

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

End Tag Table

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

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