doc: update builtin manuals
This commit is contained in:
Simon Michael
parent
e119941648
commit
cca95d2974
@ -229,7 +229,7 @@ _
|
||||
T{
|
||||
\
|
||||
T}@T{
|
||||
uncleared (no mark)
|
||||
unmarked
|
||||
T}
|
||||
T{
|
||||
\f[C]!\f[]
|
||||
@ -244,13 +244,15 @@ T}
|
||||
.TE
|
||||
.PP
|
||||
When reporting, you can filter by status with the
|
||||
\f[C]\-U/\-\-uncleared\f[], \f[C]\-P/\-\-pending\f[], and
|
||||
\f[C]\-U/\-\-unmarked\f[], \f[C]\-P/\-\-pending\f[], and
|
||||
\f[C]\-C/\-\-cleared\f[] flags; or the \f[C]status:\f[],
|
||||
\f[C]status:!\f[], and \f[C]status:*\f[] queries; or the U, P, C keys in
|
||||
hledger\-ui.
|
||||
.PP
|
||||
Note from hledger 1.3 onwards, \-U/\-\-uncleared matches the uncleared
|
||||
(unmarked) status only.
|
||||
Note, in Ledger and in older versions of hledger, the "unmarked" state
|
||||
is called "uncleared".
|
||||
As of hledger 1.3 we have renamed it to unmarked for clarity.
|
||||
.PP
|
||||
To replicate Ledger and old hledger\[aq]s behaviour of also matching
|
||||
pending, combine \-U and \-P.
|
||||
.PP
|
||||
|
||||
@ -239,18 +239,21 @@ indicating one of three statuses:
|
||||
|
||||
mark status
|
||||
|
||||
----------------------------
|
||||
uncleared (no mark)
|
||||
-----------------
|
||||
unmarked
|
||||
'!' pending
|
||||
'*' cleared
|
||||
|
||||
When reporting, you can filter by status with the '-U/--uncleared',
|
||||
When reporting, you can filter by status with the '-U/--unmarked',
|
||||
'-P/--pending', and '-C/--cleared' flags; or the 'status:', 'status:!',
|
||||
and 'status:*' queries; or the U, P, C keys in hledger-ui.
|
||||
|
||||
Note from hledger 1.3 onwards, -U/-uncleared matches the uncleared
|
||||
(unmarked) status only. To replicate Ledger and old hledger's behaviour
|
||||
of also matching pending, combine -U and -P.
|
||||
Note, in Ledger and in older versions of hledger, the "unmarked"
|
||||
state is called "uncleared". As of hledger 1.3 we have renamed it to
|
||||
unmarked for clarity.
|
||||
|
||||
To replicate Ledger and old hledger's behaviour of also matching
|
||||
pending, combine -U and -P.
|
||||
|
||||
Status marks are optional, but can be helpful eg for reconciling with
|
||||
real-world accounts. Some editor modes provide highlighting and
|
||||
@ -1060,67 +1063,67 @@ Node: Posting dates6832
|
||||
Ref: #posting-dates6963
|
||||
Node: Status8337
|
||||
Ref: #status8461
|
||||
Node: Account names10129
|
||||
Ref: #account-names10269
|
||||
Node: Amounts10756
|
||||
Ref: #amounts10894
|
||||
Node: Virtual Postings12995
|
||||
Ref: #virtual-postings13156
|
||||
Node: Balance Assertions14376
|
||||
Ref: #balance-assertions14553
|
||||
Node: Assertions and ordering15449
|
||||
Ref: #assertions-and-ordering15637
|
||||
Node: Assertions and included files16337
|
||||
Ref: #assertions-and-included-files16580
|
||||
Node: Assertions and multiple -f options16913
|
||||
Ref: #assertions-and-multiple--f-options17169
|
||||
Node: Assertions and commodities17301
|
||||
Ref: #assertions-and-commodities17538
|
||||
Node: Assertions and subaccounts18234
|
||||
Ref: #assertions-and-subaccounts18468
|
||||
Node: Assertions and virtual postings18989
|
||||
Ref: #assertions-and-virtual-postings19198
|
||||
Node: Balance Assignments19340
|
||||
Ref: #balance-assignments19509
|
||||
Node: Prices20628
|
||||
Ref: #prices20763
|
||||
Node: Transaction prices20814
|
||||
Ref: #transaction-prices20961
|
||||
Node: Market prices23117
|
||||
Ref: #market-prices23254
|
||||
Node: Comments24214
|
||||
Ref: #comments24338
|
||||
Node: Tags25451
|
||||
Ref: #tags25571
|
||||
Node: Implicit tags27000
|
||||
Ref: #implicit-tags27108
|
||||
Node: Directives27625
|
||||
Ref: #directives27740
|
||||
Node: Account aliases27933
|
||||
Ref: #account-aliases28079
|
||||
Node: Basic aliases28683
|
||||
Ref: #basic-aliases28828
|
||||
Node: Regex aliases29518
|
||||
Ref: #regex-aliases29688
|
||||
Node: Multiple aliases30403
|
||||
Ref: #multiple-aliases30577
|
||||
Node: end aliases31075
|
||||
Ref: #end-aliases31217
|
||||
Node: account directive31318
|
||||
Ref: #account-directive31500
|
||||
Node: apply account directive31796
|
||||
Ref: #apply-account-directive31994
|
||||
Node: Multi-line comments32653
|
||||
Ref: #multi-line-comments32845
|
||||
Node: commodity directive32973
|
||||
Ref: #commodity-directive33159
|
||||
Node: Default commodity34031
|
||||
Ref: #default-commodity34206
|
||||
Node: Default year34743
|
||||
Ref: #default-year34910
|
||||
Node: Including other files35333
|
||||
Ref: #including-other-files35492
|
||||
Node: EDITOR SUPPORT35889
|
||||
Ref: #editor-support36009
|
||||
Node: Account names10175
|
||||
Ref: #account-names10315
|
||||
Node: Amounts10802
|
||||
Ref: #amounts10940
|
||||
Node: Virtual Postings13041
|
||||
Ref: #virtual-postings13202
|
||||
Node: Balance Assertions14422
|
||||
Ref: #balance-assertions14599
|
||||
Node: Assertions and ordering15495
|
||||
Ref: #assertions-and-ordering15683
|
||||
Node: Assertions and included files16383
|
||||
Ref: #assertions-and-included-files16626
|
||||
Node: Assertions and multiple -f options16959
|
||||
Ref: #assertions-and-multiple--f-options17215
|
||||
Node: Assertions and commodities17347
|
||||
Ref: #assertions-and-commodities17584
|
||||
Node: Assertions and subaccounts18280
|
||||
Ref: #assertions-and-subaccounts18514
|
||||
Node: Assertions and virtual postings19035
|
||||
Ref: #assertions-and-virtual-postings19244
|
||||
Node: Balance Assignments19386
|
||||
Ref: #balance-assignments19555
|
||||
Node: Prices20674
|
||||
Ref: #prices20809
|
||||
Node: Transaction prices20860
|
||||
Ref: #transaction-prices21007
|
||||
Node: Market prices23163
|
||||
Ref: #market-prices23300
|
||||
Node: Comments24260
|
||||
Ref: #comments24384
|
||||
Node: Tags25497
|
||||
Ref: #tags25617
|
||||
Node: Implicit tags27046
|
||||
Ref: #implicit-tags27154
|
||||
Node: Directives27671
|
||||
Ref: #directives27786
|
||||
Node: Account aliases27979
|
||||
Ref: #account-aliases28125
|
||||
Node: Basic aliases28729
|
||||
Ref: #basic-aliases28874
|
||||
Node: Regex aliases29564
|
||||
Ref: #regex-aliases29734
|
||||
Node: Multiple aliases30449
|
||||
Ref: #multiple-aliases30623
|
||||
Node: end aliases31121
|
||||
Ref: #end-aliases31263
|
||||
Node: account directive31364
|
||||
Ref: #account-directive31546
|
||||
Node: apply account directive31842
|
||||
Ref: #apply-account-directive32040
|
||||
Node: Multi-line comments32699
|
||||
Ref: #multi-line-comments32891
|
||||
Node: commodity directive33019
|
||||
Ref: #commodity-directive33205
|
||||
Node: Default commodity34077
|
||||
Ref: #default-commodity34252
|
||||
Node: Default year34789
|
||||
Ref: #default-year34956
|
||||
Node: Including other files35379
|
||||
Ref: #including-other-files35538
|
||||
Node: EDITOR SUPPORT35935
|
||||
Ref: #editor-support36055
|
||||
|
||||
End Tag Table
|
||||
|
||||
@ -176,18 +176,21 @@ FILE FORMAT
|
||||
|
||||
|
||||
mark status
|
||||
-----------------------------
|
||||
uncleared (no mark)
|
||||
------------------
|
||||
unmarked
|
||||
! pending
|
||||
* cleared
|
||||
|
||||
When reporting, you can filter by status with the -U/--uncleared,
|
||||
When reporting, you can filter by status with the -U/--unmarked,
|
||||
-P/--pending, and -C/--cleared flags; or the status:, status:!, and
|
||||
status:* queries; or the U, P, C keys in hledger-ui.
|
||||
|
||||
Note from hledger 1.3 onwards, -U/--uncleared matches the uncleared
|
||||
(unmarked) status only. To replicate Ledger and old hledger's behav-
|
||||
iour of also matching pending, combine -U and -P.
|
||||
Note, in Ledger and in older versions of hledger, the "unmarked" state
|
||||
is called "uncleared". As of hledger 1.3 we have renamed it to
|
||||
unmarked for clarity.
|
||||
|
||||
To replicate Ledger and old hledger's behaviour of also matching pend-
|
||||
ing, combine -U and -P.
|
||||
|
||||
Status marks are optional, but can be helpful eg for reconciling with
|
||||
real-world accounts. Some editor modes provide highlighting and short-
|
||||
@ -198,7 +201,6 @@ FILE FORMAT
|
||||
Here's one suggestion:
|
||||
|
||||
|
||||
|
||||
status meaning
|
||||
--------------------------------------------------------------------------
|
||||
uncleared recorded but not yet reconciled; needs review
|
||||
@ -805,7 +807,6 @@ EDITOR SUPPORT
|
||||
lime-Text
|
||||
Textmate https://github.com/ledger/ledger/wiki/Using-Text-
|
||||
Mate-2
|
||||
|
||||
Text Wrangler https://github.com/ledger/ledger/wiki/Edit-
|
||||
ing-Ledger-files-with-TextWrangler
|
||||
|
||||
|
||||
@ -156,7 +156,7 @@ include only pending postings/txns
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[C]\-U\ \-\-uncleared\f[]
|
||||
.B \f[C]\-U\ \-\-unmarked\f[]
|
||||
include only unmarked postings/txns
|
||||
.RS
|
||||
.RE
|
||||
|
||||
@ -110,7 +110,7 @@ the data.
|
||||
'-P --pending'
|
||||
|
||||
include only pending postings/txns
|
||||
'-U --uncleared'
|
||||
'-U --unmarked'
|
||||
|
||||
include only unmarked postings/txns
|
||||
'-R --real'
|
||||
@ -359,17 +359,17 @@ Tag Table:
|
||||
Node: Top73
|
||||
Node: OPTIONS831
|
||||
Ref: #options930
|
||||
Node: KEYS3644
|
||||
Ref: #keys3741
|
||||
Node: SCREENS6330
|
||||
Ref: #screens6417
|
||||
Node: Accounts screen6507
|
||||
Ref: #accounts-screen6637
|
||||
Node: Register screen8767
|
||||
Ref: #register-screen8924
|
||||
Node: Transaction screen10867
|
||||
Ref: #transaction-screen11027
|
||||
Node: Error screen11897
|
||||
Ref: #error-screen12021
|
||||
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
|
||||
|
||||
End Tag Table
|
||||
|
||||
@ -107,7 +107,7 @@ OPTIONS
|
||||
-P --pending
|
||||
include only pending postings/txns
|
||||
|
||||
-U --uncleared
|
||||
-U --unmarked
|
||||
include only unmarked postings/txns
|
||||
|
||||
-R --real
|
||||
|
||||
@ -212,7 +212,7 @@ include only pending postings/txns
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[C]\-U\ \-\-uncleared\f[]
|
||||
.B \f[C]\-U\ \-\-unmarked\f[]
|
||||
include only unmarked postings/txns
|
||||
.RS
|
||||
.RE
|
||||
|
||||
@ -155,7 +155,7 @@ options as shown above.
|
||||
'-P --pending'
|
||||
|
||||
include only pending postings/txns
|
||||
'-U --uncleared'
|
||||
'-U --unmarked'
|
||||
|
||||
include only unmarked postings/txns
|
||||
'-R --real'
|
||||
|
||||
@ -152,7 +152,7 @@ OPTIONS
|
||||
-P --pending
|
||||
include only pending postings/txns
|
||||
|
||||
-U --uncleared
|
||||
-U --unmarked
|
||||
include only unmarked postings/txns
|
||||
|
||||
-R --real
|
||||
|
||||
@ -283,7 +283,7 @@ include only pending postings/txns
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[C]\-U\ \-\-uncleared\f[]
|
||||
.B \f[C]\-U\ \-\-unmarked\f[]
|
||||
include only unmarked postings/txns
|
||||
.RS
|
||||
.RE
|
||||
|
||||
@ -220,7 +220,7 @@ different, like git.)
|
||||
'-P --pending'
|
||||
|
||||
include only pending postings/txns
|
||||
'-U --uncleared'
|
||||
'-U --unmarked'
|
||||
|
||||
include only unmarked postings/txns
|
||||
'-R --real'
|
||||
@ -2120,123 +2120,123 @@ Node: OPTIONS3640
|
||||
Ref: #options3744
|
||||
Node: General options4025
|
||||
Ref: #general-options4152
|
||||
Node: Command options6663
|
||||
Ref: #command-options6816
|
||||
Node: Command arguments7214
|
||||
Ref: #command-arguments7374
|
||||
Node: Special characters7495
|
||||
Ref: #special-characters7653
|
||||
Node: Input files8821
|
||||
Ref: #input-files8959
|
||||
Node: Smart dates10922
|
||||
Ref: #smart-dates11065
|
||||
Node: Report start & end date12044
|
||||
Ref: #report-start-end-date12216
|
||||
Node: Report intervals13282
|
||||
Ref: #report-intervals13447
|
||||
Node: Period expressions13848
|
||||
Ref: #period-expressions14008
|
||||
Node: Depth limiting16348
|
||||
Ref: #depth-limiting16494
|
||||
Node: Pivoting16695
|
||||
Ref: #pivoting16815
|
||||
Node: Cost18586
|
||||
Ref: #cost18696
|
||||
Node: Market value18814
|
||||
Ref: #market-value18951
|
||||
Node: Regular expressions20251
|
||||
Ref: #regular-expressions20389
|
||||
Node: QUERIES21750
|
||||
Ref: #queries21854
|
||||
Node: COMMANDS25533
|
||||
Ref: #commands25647
|
||||
Node: accounts26320
|
||||
Ref: #accounts26420
|
||||
Node: activity27402
|
||||
Ref: #activity27514
|
||||
Node: add27873
|
||||
Ref: #add27974
|
||||
Node: balance30632
|
||||
Ref: #balance30745
|
||||
Node: Flat mode33760
|
||||
Ref: #flat-mode33887
|
||||
Node: Depth limited balance reports34307
|
||||
Ref: #depth-limited-balance-reports34510
|
||||
Node: Multicolumn balance reports34930
|
||||
Ref: #multicolumn-balance-reports35141
|
||||
Node: Custom balance output39789
|
||||
Ref: #custom-balance-output39973
|
||||
Node: Colour support42066
|
||||
Ref: #colour-support42227
|
||||
Node: Output destination42400
|
||||
Ref: #output-destination42558
|
||||
Node: CSV output42828
|
||||
Ref: #csv-output42947
|
||||
Node: balancesheet43344
|
||||
Ref: #balancesheet43472
|
||||
Node: cashflow45379
|
||||
Ref: #cashflow45496
|
||||
Node: help47364
|
||||
Ref: #help47476
|
||||
Node: incomestatement48314
|
||||
Ref: #incomestatement48444
|
||||
Node: info50336
|
||||
Ref: #info50443
|
||||
Node: man50807
|
||||
Ref: #man50904
|
||||
Node: print51309
|
||||
Ref: #print51414
|
||||
Node: register55170
|
||||
Ref: #register55283
|
||||
Node: Custom register output59779
|
||||
Ref: #custom-register-output59910
|
||||
Node: stats61207
|
||||
Ref: #stats61313
|
||||
Node: test62194
|
||||
Ref: #test62281
|
||||
Node: ADD-ON COMMANDS62649
|
||||
Ref: #add-on-commands62761
|
||||
Node: Official add-ons64048
|
||||
Ref: #official-add-ons64190
|
||||
Node: api64277
|
||||
Ref: #api64368
|
||||
Node: ui64420
|
||||
Ref: #ui64521
|
||||
Node: web64579
|
||||
Ref: #web64670
|
||||
Node: Third party add-ons64716
|
||||
Ref: #third-party-add-ons64893
|
||||
Node: diff65028
|
||||
Ref: #diff65127
|
||||
Node: iadd65226
|
||||
Ref: #iadd65342
|
||||
Node: interest65425
|
||||
Ref: #interest65548
|
||||
Node: irr65643
|
||||
Ref: #irr65743
|
||||
Node: Experimental add-ons65821
|
||||
Ref: #experimental-add-ons65975
|
||||
Node: autosync66368
|
||||
Ref: #autosync66482
|
||||
Node: budget66721
|
||||
Ref: #budget66845
|
||||
Node: chart66911
|
||||
Ref: #chart67030
|
||||
Node: check67101
|
||||
Ref: #check67225
|
||||
Node: check-dates67292
|
||||
Ref: #check-dates67434
|
||||
Node: check-dupes67507
|
||||
Ref: #check-dupes67650
|
||||
Node: equity67727
|
||||
Ref: #equity67855
|
||||
Node: prices67974
|
||||
Ref: #prices68103
|
||||
Node: print-unique68158
|
||||
Ref: #print-unique68307
|
||||
Node: register-match68400
|
||||
Ref: #register-match68556
|
||||
Node: rewrite68654
|
||||
Ref: #rewrite68775
|
||||
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
|
||||
|
||||
End Tag Table
|
||||
|
||||
@ -188,7 +188,7 @@ OPTIONS
|
||||
-P --pending
|
||||
include only pending postings/txns
|
||||
|
||||
-U --uncleared
|
||||
-U --unmarked
|
||||
include only unmarked postings/txns
|
||||
|
||||
-R --real
|
||||
|
||||
Loading…
Reference in New Issue
Block a user