doc: update builtin manuals

This commit is contained in:
Simon Michael 2017-06-15 16:27:09 -07:00
parent e119941648
commit cca95d2974
12 changed files with 368 additions and 362 deletions

View File

@ -229,7 +229,7 @@ _
T{ T{
\ \
T}@T{ T}@T{
uncleared (no mark) unmarked
T} T}
T{ T{
\f[C]!\f[] \f[C]!\f[]
@ -244,13 +244,15 @@ T}
.TE .TE
.PP .PP
When reporting, you can filter by status with the 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]\-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 \f[C]status:!\f[], and \f[C]status:*\f[] queries; or the U, P, C keys in
hledger\-ui. hledger\-ui.
.PP .PP
Note from hledger 1.3 onwards, \-U/\-\-uncleared matches the uncleared Note, in Ledger and in older versions of hledger, the "unmarked" state
(unmarked) status only. 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 To replicate Ledger and old hledger\[aq]s behaviour of also matching
pending, combine \-U and \-P. pending, combine \-U and \-P.
.PP .PP

View File

@ -239,18 +239,21 @@ indicating one of three statuses:
mark status mark status
---------------------------- -----------------
uncleared (no mark) unmarked
'!' pending '!' pending
'*' cleared '*' 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:!', '-P/--pending', and '-C/--cleared' flags; or the 'status:', 'status:!',
and 'status:*' queries; or the U, P, C keys in hledger-ui. and 'status:*' queries; or the U, P, C keys in hledger-ui.
Note from hledger 1.3 onwards, -U/-uncleared matches the uncleared Note, in Ledger and in older versions of hledger, the "unmarked"
(unmarked) status only. To replicate Ledger and old hledger's behaviour state is called "uncleared". As of hledger 1.3 we have renamed it to
of also matching pending, combine -U and -P. 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 Status marks are optional, but can be helpful eg for reconciling with
real-world accounts. Some editor modes provide highlighting and real-world accounts. Some editor modes provide highlighting and
@ -1060,67 +1063,67 @@ Node: Posting dates6832
Ref: #posting-dates6963 Ref: #posting-dates6963
Node: Status8337 Node: Status8337
Ref: #status8461 Ref: #status8461
Node: Account names10129 Node: Account names10175
Ref: #account-names10269 Ref: #account-names10315
Node: Amounts10756 Node: Amounts10802
Ref: #amounts10894 Ref: #amounts10940
Node: Virtual Postings12995 Node: Virtual Postings13041
Ref: #virtual-postings13156 Ref: #virtual-postings13202
Node: Balance Assertions14376 Node: Balance Assertions14422
Ref: #balance-assertions14553 Ref: #balance-assertions14599
Node: Assertions and ordering15449 Node: Assertions and ordering15495
Ref: #assertions-and-ordering15637 Ref: #assertions-and-ordering15683
Node: Assertions and included files16337 Node: Assertions and included files16383
Ref: #assertions-and-included-files16580 Ref: #assertions-and-included-files16626
Node: Assertions and multiple -f options16913 Node: Assertions and multiple -f options16959
Ref: #assertions-and-multiple--f-options17169 Ref: #assertions-and-multiple--f-options17215
Node: Assertions and commodities17301 Node: Assertions and commodities17347
Ref: #assertions-and-commodities17538 Ref: #assertions-and-commodities17584
Node: Assertions and subaccounts18234 Node: Assertions and subaccounts18280
Ref: #assertions-and-subaccounts18468 Ref: #assertions-and-subaccounts18514
Node: Assertions and virtual postings18989 Node: Assertions and virtual postings19035
Ref: #assertions-and-virtual-postings19198 Ref: #assertions-and-virtual-postings19244
Node: Balance Assignments19340 Node: Balance Assignments19386
Ref: #balance-assignments19509 Ref: #balance-assignments19555
Node: Prices20628 Node: Prices20674
Ref: #prices20763 Ref: #prices20809
Node: Transaction prices20814 Node: Transaction prices20860
Ref: #transaction-prices20961 Ref: #transaction-prices21007
Node: Market prices23117 Node: Market prices23163
Ref: #market-prices23254 Ref: #market-prices23300
Node: Comments24214 Node: Comments24260
Ref: #comments24338 Ref: #comments24384
Node: Tags25451 Node: Tags25497
Ref: #tags25571 Ref: #tags25617
Node: Implicit tags27000 Node: Implicit tags27046
Ref: #implicit-tags27108 Ref: #implicit-tags27154
Node: Directives27625 Node: Directives27671
Ref: #directives27740 Ref: #directives27786
Node: Account aliases27933 Node: Account aliases27979
Ref: #account-aliases28079 Ref: #account-aliases28125
Node: Basic aliases28683 Node: Basic aliases28729
Ref: #basic-aliases28828 Ref: #basic-aliases28874
Node: Regex aliases29518 Node: Regex aliases29564
Ref: #regex-aliases29688 Ref: #regex-aliases29734
Node: Multiple aliases30403 Node: Multiple aliases30449
Ref: #multiple-aliases30577 Ref: #multiple-aliases30623
Node: end aliases31075 Node: end aliases31121
Ref: #end-aliases31217 Ref: #end-aliases31263
Node: account directive31318 Node: account directive31364
Ref: #account-directive31500 Ref: #account-directive31546
Node: apply account directive31796 Node: apply account directive31842
Ref: #apply-account-directive31994 Ref: #apply-account-directive32040
Node: Multi-line comments32653 Node: Multi-line comments32699
Ref: #multi-line-comments32845 Ref: #multi-line-comments32891
Node: commodity directive32973 Node: commodity directive33019
Ref: #commodity-directive33159 Ref: #commodity-directive33205
Node: Default commodity34031 Node: Default commodity34077
Ref: #default-commodity34206 Ref: #default-commodity34252
Node: Default year34743 Node: Default year34789
Ref: #default-year34910 Ref: #default-year34956
Node: Including other files35333 Node: Including other files35379
Ref: #including-other-files35492 Ref: #including-other-files35538
Node: EDITOR SUPPORT35889 Node: EDITOR SUPPORT35935
Ref: #editor-support36009 Ref: #editor-support36055
 
End Tag Table End Tag Table

View File

@ -176,18 +176,21 @@ FILE FORMAT
mark status mark status
----------------------------- ------------------
uncleared (no mark) unmarked
! pending ! pending
* cleared * 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 -P/--pending, and -C/--cleared flags; or the status:, status:!, and
status:* queries; or the U, P, C keys in hledger-ui. status:* queries; or the U, P, C keys in hledger-ui.
Note from hledger 1.3 onwards, -U/--uncleared matches the uncleared Note, in Ledger and in older versions of hledger, the "unmarked" state
(unmarked) status only. To replicate Ledger and old hledger's behav- is called "uncleared". As of hledger 1.3 we have renamed it to
iour of also matching pending, combine -U and -P. 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 Status marks are optional, but can be helpful eg for reconciling with
real-world accounts. Some editor modes provide highlighting and short- real-world accounts. Some editor modes provide highlighting and short-
@ -198,7 +201,6 @@ FILE FORMAT
Here's one suggestion: Here's one suggestion:
status meaning status meaning
-------------------------------------------------------------------------- --------------------------------------------------------------------------
uncleared recorded but not yet reconciled; needs review uncleared recorded but not yet reconciled; needs review
@ -805,7 +807,6 @@ EDITOR SUPPORT
lime-Text lime-Text
Textmate https://github.com/ledger/ledger/wiki/Using-Text- Textmate https://github.com/ledger/ledger/wiki/Using-Text-
Mate-2 Mate-2
Text Wrangler https://github.com/ledger/ledger/wiki/Edit- Text Wrangler https://github.com/ledger/ledger/wiki/Edit-
ing-Ledger-files-with-TextWrangler ing-Ledger-files-with-TextWrangler

View File

@ -156,7 +156,7 @@ include only pending postings/txns
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-U\ \-\-uncleared\f[] .B \f[C]\-U\ \-\-unmarked\f[]
include only unmarked postings/txns include only unmarked postings/txns
.RS .RS
.RE .RE

View File

@ -110,7 +110,7 @@ the data.
'-P --pending' '-P --pending'
include only pending postings/txns include only pending postings/txns
'-U --uncleared' '-U --unmarked'
include only unmarked postings/txns include only unmarked postings/txns
'-R --real' '-R --real'
@ -359,17 +359,17 @@ Tag Table:
Node: Top73 Node: Top73
Node: OPTIONS831 Node: OPTIONS831
Ref: #options930 Ref: #options930
Node: KEYS3644 Node: KEYS3643
Ref: #keys3741 Ref: #keys3740
Node: SCREENS6330 Node: SCREENS6329
Ref: #screens6417 Ref: #screens6416
Node: Accounts screen6507 Node: Accounts screen6506
Ref: #accounts-screen6637 Ref: #accounts-screen6636
Node: Register screen8767 Node: Register screen8766
Ref: #register-screen8924 Ref: #register-screen8923
Node: Transaction screen10867 Node: Transaction screen10866
Ref: #transaction-screen11027 Ref: #transaction-screen11026
Node: Error screen11897 Node: Error screen11896
Ref: #error-screen12021 Ref: #error-screen12020
 
End Tag Table End Tag Table

View File

@ -107,7 +107,7 @@ OPTIONS
-P --pending -P --pending
include only pending postings/txns include only pending postings/txns
-U --uncleared -U --unmarked
include only unmarked postings/txns include only unmarked postings/txns
-R --real -R --real

View File

@ -212,7 +212,7 @@ include only pending postings/txns
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-U\ \-\-uncleared\f[] .B \f[C]\-U\ \-\-unmarked\f[]
include only unmarked postings/txns include only unmarked postings/txns
.RS .RS
.RE .RE

View File

@ -155,7 +155,7 @@ options as shown above.
'-P --pending' '-P --pending'
include only pending postings/txns include only pending postings/txns
'-U --uncleared' '-U --unmarked'
include only unmarked postings/txns include only unmarked postings/txns
'-R --real' '-R --real'

View File

@ -152,7 +152,7 @@ OPTIONS
-P --pending -P --pending
include only pending postings/txns include only pending postings/txns
-U --uncleared -U --unmarked
include only unmarked postings/txns include only unmarked postings/txns
-R --real -R --real

View File

@ -283,7 +283,7 @@ include only pending postings/txns
.RS .RS
.RE .RE
.TP .TP
.B \f[C]\-U\ \-\-uncleared\f[] .B \f[C]\-U\ \-\-unmarked\f[]
include only unmarked postings/txns include only unmarked postings/txns
.RS .RS
.RE .RE

View File

@ -220,7 +220,7 @@ different, like git.)
'-P --pending' '-P --pending'
include only pending postings/txns include only pending postings/txns
'-U --uncleared' '-U --unmarked'
include only unmarked postings/txns include only unmarked postings/txns
'-R --real' '-R --real'
@ -2120,123 +2120,123 @@ Node: OPTIONS3640
Ref: #options3744 Ref: #options3744
Node: General options4025 Node: General options4025
Ref: #general-options4152 Ref: #general-options4152
Node: Command options6663 Node: Command options6662
Ref: #command-options6816 Ref: #command-options6815
Node: Command arguments7214 Node: Command arguments7213
Ref: #command-arguments7374 Ref: #command-arguments7373
Node: Special characters7495 Node: Special characters7494
Ref: #special-characters7653 Ref: #special-characters7652
Node: Input files8821 Node: Input files8820
Ref: #input-files8959 Ref: #input-files8958
Node: Smart dates10922 Node: Smart dates10921
Ref: #smart-dates11065 Ref: #smart-dates11064
Node: Report start & end date12044 Node: Report start & end date12043
Ref: #report-start-end-date12216 Ref: #report-start-end-date12215
Node: Report intervals13282 Node: Report intervals13281
Ref: #report-intervals13447 Ref: #report-intervals13446
Node: Period expressions13848 Node: Period expressions13847
Ref: #period-expressions14008 Ref: #period-expressions14007
Node: Depth limiting16348 Node: Depth limiting16347
Ref: #depth-limiting16494 Ref: #depth-limiting16493
Node: Pivoting16695 Node: Pivoting16694
Ref: #pivoting16815 Ref: #pivoting16814
Node: Cost18586 Node: Cost18585
Ref: #cost18696 Ref: #cost18695
Node: Market value18814 Node: Market value18813
Ref: #market-value18951 Ref: #market-value18950
Node: Regular expressions20251 Node: Regular expressions20250
Ref: #regular-expressions20389 Ref: #regular-expressions20388
Node: QUERIES21750 Node: QUERIES21749
Ref: #queries21854 Ref: #queries21853
Node: COMMANDS25533 Node: COMMANDS25532
Ref: #commands25647 Ref: #commands25646
Node: accounts26320 Node: accounts26319
Ref: #accounts26420 Ref: #accounts26419
Node: activity27402 Node: activity27401
Ref: #activity27514 Ref: #activity27513
Node: add27873 Node: add27872
Ref: #add27974 Ref: #add27973
Node: balance30632 Node: balance30631
Ref: #balance30745 Ref: #balance30744
Node: Flat mode33760 Node: Flat mode33759
Ref: #flat-mode33887 Ref: #flat-mode33886
Node: Depth limited balance reports34307 Node: Depth limited balance reports34306
Ref: #depth-limited-balance-reports34510 Ref: #depth-limited-balance-reports34509
Node: Multicolumn balance reports34930 Node: Multicolumn balance reports34929
Ref: #multicolumn-balance-reports35141 Ref: #multicolumn-balance-reports35140
Node: Custom balance output39789 Node: Custom balance output39788
Ref: #custom-balance-output39973 Ref: #custom-balance-output39972
Node: Colour support42066 Node: Colour support42065
Ref: #colour-support42227 Ref: #colour-support42226
Node: Output destination42400 Node: Output destination42399
Ref: #output-destination42558 Ref: #output-destination42557
Node: CSV output42828 Node: CSV output42827
Ref: #csv-output42947 Ref: #csv-output42946
Node: balancesheet43344 Node: balancesheet43343
Ref: #balancesheet43472 Ref: #balancesheet43471
Node: cashflow45379 Node: cashflow45378
Ref: #cashflow45496 Ref: #cashflow45495
Node: help47364 Node: help47363
Ref: #help47476 Ref: #help47475
Node: incomestatement48314 Node: incomestatement48313
Ref: #incomestatement48444 Ref: #incomestatement48443
Node: info50336 Node: info50335
Ref: #info50443 Ref: #info50442
Node: man50807 Node: man50806
Ref: #man50904 Ref: #man50903
Node: print51309 Node: print51308
Ref: #print51414 Ref: #print51413
Node: register55170 Node: register55169
Ref: #register55283 Ref: #register55282
Node: Custom register output59779 Node: Custom register output59778
Ref: #custom-register-output59910 Ref: #custom-register-output59909
Node: stats61207 Node: stats61206
Ref: #stats61313 Ref: #stats61312
Node: test62194 Node: test62193
Ref: #test62281 Ref: #test62280
Node: ADD-ON COMMANDS62649 Node: ADD-ON COMMANDS62648
Ref: #add-on-commands62761 Ref: #add-on-commands62760
Node: Official add-ons64048 Node: Official add-ons64047
Ref: #official-add-ons64190 Ref: #official-add-ons64189
Node: api64277 Node: api64276
Ref: #api64368 Ref: #api64367
Node: ui64420 Node: ui64419
Ref: #ui64521 Ref: #ui64520
Node: web64579 Node: web64578
Ref: #web64670 Ref: #web64669
Node: Third party add-ons64716 Node: Third party add-ons64715
Ref: #third-party-add-ons64893 Ref: #third-party-add-ons64892
Node: diff65028 Node: diff65027
Ref: #diff65127 Ref: #diff65126
Node: iadd65226 Node: iadd65225
Ref: #iadd65342 Ref: #iadd65341
Node: interest65425 Node: interest65424
Ref: #interest65548 Ref: #interest65547
Node: irr65643 Node: irr65642
Ref: #irr65743 Ref: #irr65742
Node: Experimental add-ons65821 Node: Experimental add-ons65820
Ref: #experimental-add-ons65975 Ref: #experimental-add-ons65974
Node: autosync66368 Node: autosync66367
Ref: #autosync66482 Ref: #autosync66481
Node: budget66721 Node: budget66720
Ref: #budget66845 Ref: #budget66844
Node: chart66911 Node: chart66910
Ref: #chart67030 Ref: #chart67029
Node: check67101 Node: check67100
Ref: #check67225 Ref: #check67224
Node: check-dates67292 Node: check-dates67291
Ref: #check-dates67434 Ref: #check-dates67433
Node: check-dupes67507 Node: check-dupes67506
Ref: #check-dupes67650 Ref: #check-dupes67649
Node: equity67727 Node: equity67726
Ref: #equity67855 Ref: #equity67854
Node: prices67974 Node: prices67973
Ref: #prices68103 Ref: #prices68102
Node: print-unique68158 Node: print-unique68157
Ref: #print-unique68307 Ref: #print-unique68306
Node: register-match68400 Node: register-match68399
Ref: #register-match68556 Ref: #register-match68555
Node: rewrite68654 Node: rewrite68653
Ref: #rewrite68775 Ref: #rewrite68774
 
End Tag Table End Tag Table

View File

@ -188,7 +188,7 @@ OPTIONS
-P --pending -P --pending
include only pending postings/txns include only pending postings/txns
-U --uncleared -U --unmarked
include only unmarked postings/txns include only unmarked postings/txns
-R --real -R --real