bal: document colour support
[ci skip]
This commit is contained in:
Simon Michael
parent
10d85bedec
commit
bc111c49ca
@ -45,7 +45,7 @@ txt, csv.
|
||||
: Use unicode to display prettier tables.
|
||||
|
||||
The balance command displays accounts and balances.
|
||||
It is hledger's most featureful and most useful command.
|
||||
It is hledger's most featureful and versatile command.
|
||||
|
||||
```shell
|
||||
$ hledger balance
|
||||
@ -70,12 +70,12 @@ By default, accounts are displayed hierarchically, with subaccounts
|
||||
indented below their parent.
|
||||
"Boring" accounts, which contain a single interesting
|
||||
subaccount and no balance of their own, are elided into the following
|
||||
line for more compact output. (Use `--no-elide` to prevent this.)
|
||||
line for more compact output. (Use `--no-elide` to prevent this.
|
||||
Eliding of boring accounts is not yet supported in multicolumn reports.)
|
||||
|
||||
Each account's balance is the "inclusive" balance - it includes the
|
||||
balances of any subaccounts.
|
||||
|
||||
|
||||
Accounts which have zero balance (and no non-zero subaccounts) are
|
||||
omitted. Use `-E/--empty` to show them.
|
||||
|
||||
@ -290,6 +290,13 @@ Some example formats:
|
||||
- `%,%-50(account) %25(total)` - account name padded to 50 characters, total padded to 20 characters, with multiple commodities rendered on one line
|
||||
- `%20(total) %2(depth_spacer)%-(account)` - the default format for the single-column balance report
|
||||
|
||||
### Colour support
|
||||
|
||||
The balance command shows negative amounts in red, if:
|
||||
|
||||
- the `TERM` environment variable is not set to `dumb`
|
||||
- the output is not being redirected or piped anywhere
|
||||
|
||||
### Output destination
|
||||
|
||||
The balance, print, register and stats commands can write their output to a
|
||||
|
||||
@ -1354,7 +1354,7 @@ Use unicode to display prettier tables.
|
||||
.RE
|
||||
.PP
|
||||
The balance command displays accounts and balances.
|
||||
It is hledger\[aq]s most featureful and most useful command.
|
||||
It is hledger\[aq]s most featureful and versatile command.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
@ -1385,7 +1385,8 @@ indented below their parent.
|
||||
"Boring" accounts, which contain a single interesting subaccount and no
|
||||
balance of their own, are elided into the following line for more
|
||||
compact output.
|
||||
(Use \f[C]\-\-no\-elide\f[] to prevent this.)
|
||||
(Use \f[C]\-\-no\-elide\f[] to prevent this.
|
||||
Eliding of boring accounts is not yet supported in multicolumn reports.)
|
||||
.PP
|
||||
Each account\[aq]s balance is the "inclusive" balance \- it includes the
|
||||
balances of any subaccounts.
|
||||
@ -1631,6 +1632,13 @@ rendered on one line
|
||||
.IP \[bu] 2
|
||||
\f[C]%20(total)\ \ %2(depth_spacer)%\-(account)\f[] \- the default
|
||||
format for the single\-column balance report
|
||||
.SS Colour support
|
||||
.PP
|
||||
The balance command shows negative amounts in red, if:
|
||||
.IP \[bu] 2
|
||||
the \f[C]TERM\f[] environment variable is not set to \f[C]dumb\f[]
|
||||
.IP \[bu] 2
|
||||
the output is not being redirected or piped anywhere
|
||||
.SS Output destination
|
||||
.PP
|
||||
The balance, print, register and stats commands can write their output
|
||||
|
||||
@ -1013,7 +1013,7 @@ Show accounts and their balances. Alias: bal.
|
||||
Use unicode to display prettier tables.
|
||||
|
||||
The balance command displays accounts and balances. It is hledger's
|
||||
most featureful and most useful command.
|
||||
most featureful and versatile command.
|
||||
|
||||
$ hledger balance
|
||||
$-1 assets
|
||||
@ -1038,7 +1038,8 @@ opening balances, this is the same as the account's ending balance.
|
||||
indented below their parent. "Boring" accounts, which contain a single
|
||||
interesting subaccount and no balance of their own, are elided into the
|
||||
following line for more compact output. (Use '--no-elide' to prevent
|
||||
this.)
|
||||
this. Eliding of boring accounts is not yet supported in multicolumn
|
||||
reports.)
|
||||
|
||||
Each account's balance is the "inclusive" balance - it includes the
|
||||
balances of any subaccounts.
|
||||
@ -1060,6 +1061,7 @@ $ hledger balance -p 2008/6 expenses --no-total
|
||||
* Depth limited balance reports::
|
||||
* Multicolumn balance reports::
|
||||
* Custom balance output::
|
||||
* Colour support::
|
||||
* Output destination::
|
||||
* CSV output::
|
||||
|
||||
@ -1197,7 +1199,7 @@ Balance changes in 2008:
|
||||
# Average is rounded to the dollar here since all journal amounts are
|
||||
|
||||
|
||||
File: hledger.1.info, Node: Custom balance output, Next: Output destination, Prev: Multicolumn balance reports, Up: balance
|
||||
File: hledger.1.info, Node: Custom balance output, Next: Colour support, Prev: Multicolumn balance reports, Up: balance
|
||||
|
||||
4.4.4 Custom balance output
|
||||
---------------------------
|
||||
@ -1257,9 +1259,20 @@ may be needed to get pleasing results.
|
||||
the single-column balance report
|
||||
|
||||
|
||||
File: hledger.1.info, Node: Output destination, Next: CSV output, Prev: Custom balance output, Up: balance
|
||||
File: hledger.1.info, Node: Colour support, Next: Output destination, Prev: Custom balance output, Up: balance
|
||||
|
||||
4.4.5 Output destination
|
||||
4.4.5 Colour support
|
||||
--------------------
|
||||
|
||||
The balance command shows negative amounts in red, if:
|
||||
|
||||
* the 'TERM' environment variable is not set to 'dumb'
|
||||
* the output is not being redirected or piped anywhere
|
||||
|
||||
|
||||
File: hledger.1.info, Node: Output destination, Next: CSV output, Prev: Colour support, Up: balance
|
||||
|
||||
4.4.6 Output destination
|
||||
------------------------
|
||||
|
||||
The balance, print, register and stats commands can write their output
|
||||
@ -1272,7 +1285,7 @@ $ hledger balance -o FILE # write to FILE
|
||||
|
||||
File: hledger.1.info, Node: CSV output, Prev: Output destination, Up: balance
|
||||
|
||||
4.4.6 CSV output
|
||||
4.4.7 CSV output
|
||||
----------------
|
||||
|
||||
The balance, print and register commands can write their output as CSV.
|
||||
@ -2144,83 +2157,85 @@ Node: add27846
|
||||
Ref: #add27947
|
||||
Node: balance30605
|
||||
Ref: #balance30718
|
||||
Node: Flat mode33643
|
||||
Ref: #flat-mode33770
|
||||
Node: Depth limited balance reports34190
|
||||
Ref: #depth-limited-balance-reports34393
|
||||
Node: Multicolumn balance reports34813
|
||||
Ref: #multicolumn-balance-reports35024
|
||||
Node: Custom balance output39672
|
||||
Ref: #custom-balance-output39860
|
||||
Node: Output destination41953
|
||||
Ref: #output-destination42118
|
||||
Node: CSV output42388
|
||||
Ref: #csv-output42507
|
||||
Node: balancesheet42904
|
||||
Ref: #balancesheet43032
|
||||
Node: cashflow44939
|
||||
Ref: #cashflow45056
|
||||
Node: help46924
|
||||
Ref: #help47036
|
||||
Node: incomestatement47874
|
||||
Ref: #incomestatement48004
|
||||
Node: info49896
|
||||
Ref: #info50003
|
||||
Node: man50367
|
||||
Ref: #man50464
|
||||
Node: print50869
|
||||
Ref: #print50974
|
||||
Node: register54730
|
||||
Ref: #register54843
|
||||
Node: Custom register output59339
|
||||
Ref: #custom-register-output59470
|
||||
Node: stats60767
|
||||
Ref: #stats60873
|
||||
Node: test61754
|
||||
Ref: #test61841
|
||||
Node: ADD-ON COMMANDS62209
|
||||
Ref: #add-on-commands62321
|
||||
Node: Official add-ons63608
|
||||
Ref: #official-add-ons63750
|
||||
Node: api63837
|
||||
Ref: #api63928
|
||||
Node: ui63980
|
||||
Ref: #ui64081
|
||||
Node: web64139
|
||||
Ref: #web64230
|
||||
Node: Third party add-ons64276
|
||||
Ref: #third-party-add-ons64453
|
||||
Node: diff64588
|
||||
Ref: #diff64687
|
||||
Node: iadd64786
|
||||
Ref: #iadd64902
|
||||
Node: interest64985
|
||||
Ref: #interest65108
|
||||
Node: irr65203
|
||||
Ref: #irr65303
|
||||
Node: Experimental add-ons65381
|
||||
Ref: #experimental-add-ons65535
|
||||
Node: autosync65928
|
||||
Ref: #autosync66042
|
||||
Node: budget66281
|
||||
Ref: #budget66405
|
||||
Node: chart66471
|
||||
Ref: #chart66590
|
||||
Node: check66661
|
||||
Ref: #check66785
|
||||
Node: check-dates66852
|
||||
Ref: #check-dates66994
|
||||
Node: check-dupes67067
|
||||
Ref: #check-dupes67210
|
||||
Node: equity67287
|
||||
Ref: #equity67415
|
||||
Node: prices67534
|
||||
Ref: #prices67663
|
||||
Node: print-unique67718
|
||||
Ref: #print-unique67867
|
||||
Node: register-match67960
|
||||
Ref: #register-match68116
|
||||
Node: rewrite68214
|
||||
Ref: #rewrite68335
|
||||
Node: Flat mode33733
|
||||
Ref: #flat-mode33860
|
||||
Node: Depth limited balance reports34280
|
||||
Ref: #depth-limited-balance-reports34483
|
||||
Node: Multicolumn balance reports34903
|
||||
Ref: #multicolumn-balance-reports35114
|
||||
Node: Custom balance output39762
|
||||
Ref: #custom-balance-output39946
|
||||
Node: Colour support42039
|
||||
Ref: #colour-support42200
|
||||
Node: Output destination42373
|
||||
Ref: #output-destination42531
|
||||
Node: CSV output42801
|
||||
Ref: #csv-output42920
|
||||
Node: balancesheet43317
|
||||
Ref: #balancesheet43445
|
||||
Node: cashflow45352
|
||||
Ref: #cashflow45469
|
||||
Node: help47337
|
||||
Ref: #help47449
|
||||
Node: incomestatement48287
|
||||
Ref: #incomestatement48417
|
||||
Node: info50309
|
||||
Ref: #info50416
|
||||
Node: man50780
|
||||
Ref: #man50877
|
||||
Node: print51282
|
||||
Ref: #print51387
|
||||
Node: register55143
|
||||
Ref: #register55256
|
||||
Node: Custom register output59752
|
||||
Ref: #custom-register-output59883
|
||||
Node: stats61180
|
||||
Ref: #stats61286
|
||||
Node: test62167
|
||||
Ref: #test62254
|
||||
Node: ADD-ON COMMANDS62622
|
||||
Ref: #add-on-commands62734
|
||||
Node: Official add-ons64021
|
||||
Ref: #official-add-ons64163
|
||||
Node: api64250
|
||||
Ref: #api64341
|
||||
Node: ui64393
|
||||
Ref: #ui64494
|
||||
Node: web64552
|
||||
Ref: #web64643
|
||||
Node: Third party add-ons64689
|
||||
Ref: #third-party-add-ons64866
|
||||
Node: diff65001
|
||||
Ref: #diff65100
|
||||
Node: iadd65199
|
||||
Ref: #iadd65315
|
||||
Node: interest65398
|
||||
Ref: #interest65521
|
||||
Node: irr65616
|
||||
Ref: #irr65716
|
||||
Node: Experimental add-ons65794
|
||||
Ref: #experimental-add-ons65948
|
||||
Node: autosync66341
|
||||
Ref: #autosync66455
|
||||
Node: budget66694
|
||||
Ref: #budget66818
|
||||
Node: chart66884
|
||||
Ref: #chart67003
|
||||
Node: check67074
|
||||
Ref: #check67198
|
||||
Node: check-dates67265
|
||||
Ref: #check-dates67407
|
||||
Node: check-dupes67480
|
||||
Ref: #check-dupes67623
|
||||
Node: equity67700
|
||||
Ref: #equity67828
|
||||
Node: prices67947
|
||||
Ref: #prices68076
|
||||
Node: print-unique68131
|
||||
Ref: #print-unique68280
|
||||
Node: register-match68373
|
||||
Ref: #register-match68529
|
||||
Node: rewrite68627
|
||||
Ref: #rewrite68748
|
||||
|
||||
End Tag Table
|
||||
|
||||
@ -910,7 +910,7 @@ COMMANDS
|
||||
Use unicode to display prettier tables.
|
||||
|
||||
The balance command displays accounts and balances. It is hledger's
|
||||
most featureful and most useful command.
|
||||
most featureful and versatile command.
|
||||
|
||||
$ hledger balance
|
||||
$-1 assets
|
||||
@ -935,7 +935,8 @@ COMMANDS
|
||||
indented below their parent. "Boring" accounts, which contain a single
|
||||
interesting subaccount and no balance of their own, are elided into the
|
||||
following line for more compact output. (Use --no-elide to prevent
|
||||
this.)
|
||||
this. Eliding of boring accounts is not yet supported in multicolumn
|
||||
reports.)
|
||||
|
||||
Each account's balance is the "inclusive" balance - it includes the
|
||||
balances of any subaccounts.
|
||||
@ -1133,6 +1134,13 @@ COMMANDS
|
||||
o %20(total) %2(depth_spacer)%-(account) - the default format for the
|
||||
single-column balance report
|
||||
|
||||
Colour support
|
||||
The balance command shows negative amounts in red, if:
|
||||
|
||||
o the TERM environment variable is not set to dumb
|
||||
|
||||
o the output is not being redirected or piped anywhere
|
||||
|
||||
Output destination
|
||||
The balance, print, register and stats commands can write their output
|
||||
to a destination other than the console. This is controlled by the
|
||||
|
||||
Loading…
Reference in New Issue
Block a user