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

bal: document colour support

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2017-04-25 18:42:35 -07:00
parent 10d85bedec
commit bc111c49ca
4 changed files with 279 additions and 241 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
hledger/doc/balance.m4.md
View File

@ -45,7 +45,7 @@ txt, csv.
: Use unicode to display prettier tables. : Use unicode to display prettier tables.
The balance command displays accounts and balances. 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 ```shell
$ hledger balance $ hledger balance
@ -70,12 +70,12 @@ By default, accounts are displayed hierarchically, with subaccounts
indented below their parent. indented below their parent.
"Boring" accounts, which contain a single interesting "Boring" accounts, which contain a single interesting
subaccount and no balance of their own, are elided into the following 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 Each account's balance is the "inclusive" balance - it includes the
balances of any subaccounts. balances of any subaccounts.
Accounts which have zero balance (and no non-zero subaccounts) are Accounts which have zero balance (and no non-zero subaccounts) are
omitted. Use `-E/--empty` to show them. 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 - `%,%-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 - `%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 ### Output destination
The balance, print, register and stats commands can write their output to a The balance, print, register and stats commands can write their output to a

12
hledger/doc/hledger.1
View File

@ -1354,7 +1354,7 @@ Use unicode to display prettier tables.
.RE .RE
.PP .PP
The balance command displays accounts and balances. 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 .IP
.nf .nf
\f[C] \f[C]
@ -1385,7 +1385,8 @@ indented below their parent.
"Boring" accounts, which contain a single interesting subaccount and no "Boring" accounts, which contain a single interesting subaccount and no
balance of their own, are elided into the following line for more balance of their own, are elided into the following line for more
compact output. 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 .PP
Each account\[aq]s balance is the "inclusive" balance \- it includes the Each account\[aq]s balance is the "inclusive" balance \- it includes the
balances of any subaccounts. balances of any subaccounts.
@ -1631,6 +1632,13 @@ rendered on one line
.IP \[bu] 2 .IP \[bu] 2
\f[C]%20(total)\ \ %2(depth_spacer)%\-(account)\f[] \- the default \f[C]%20(total)\ \ %2(depth_spacer)%\-(account)\f[] \- the default
format for the single\-column balance report 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 .SS Output destination
.PP .PP
The balance, print, register and stats commands can write their output The balance, print, register and stats commands can write their output

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

@ -1013,7 +1013,7 @@ Show accounts and their balances. Alias: bal.
Use unicode to display prettier tables. Use unicode to display prettier tables.
The balance command displays accounts and balances. It is hledger's The balance command displays accounts and balances. It is hledger's
most featureful and most useful command. most featureful and versatile command.
$ hledger balance $ hledger balance
$-1 assets $-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 indented below their parent. "Boring" accounts, which contain a single
interesting subaccount and no balance of their own, are elided into the interesting subaccount and no balance of their own, are elided into the
following line for more compact output. (Use '--no-elide' to prevent 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 Each account's balance is the "inclusive" balance - it includes the
balances of any subaccounts. balances of any subaccounts.
@ -1060,6 +1061,7 @@ $ hledger balance -p 2008/6 expenses --no-total
* Depth limited balance reports:: * Depth limited balance reports::
* Multicolumn balance reports:: * Multicolumn balance reports::
* Custom balance output:: * Custom balance output::
* Colour support::
* Output destination:: * Output destination::
* CSV output:: * CSV output::
@ -1197,7 +1199,7 @@ Balance changes in 2008:
# Average is rounded to the dollar here since all journal amounts are # 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 4.4.4 Custom balance output
--------------------------- ---------------------------
@ -1257,9 +1259,20 @@ may be needed to get pleasing results.
the single-column balance report 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 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 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. The balance, print and register commands can write their output as CSV.
@ -2144,83 +2157,85 @@ Node: add27846
Ref: #add27947 Ref: #add27947
Node: balance30605 Node: balance30605
Ref: #balance30718 Ref: #balance30718
Node: Flat mode33643 Node: Flat mode33733
Ref: #flat-mode33770 Ref: #flat-mode33860
Node: Depth limited balance reports34190 Node: Depth limited balance reports34280
Ref: #depth-limited-balance-reports34393 Ref: #depth-limited-balance-reports34483
Node: Multicolumn balance reports34813 Node: Multicolumn balance reports34903
Ref: #multicolumn-balance-reports35024 Ref: #multicolumn-balance-reports35114
Node: Custom balance output39672 Node: Custom balance output39762
Ref: #custom-balance-output39860 Ref: #custom-balance-output39946
Node: Output destination41953 Node: Colour support42039
Ref: #output-destination42118 Ref: #colour-support42200
Node: CSV output42388 Node: Output destination42373
Ref: #csv-output42507 Ref: #output-destination42531
Node: balancesheet42904 Node: CSV output42801
Ref: #balancesheet43032 Ref: #csv-output42920
Node: cashflow44939 Node: balancesheet43317
Ref: #cashflow45056 Ref: #balancesheet43445
Node: help46924 Node: cashflow45352
Ref: #help47036 Ref: #cashflow45469
Node: incomestatement47874 Node: help47337
Ref: #incomestatement48004 Ref: #help47449
Node: info49896 Node: incomestatement48287
Ref: #info50003 Ref: #incomestatement48417
Node: man50367 Node: info50309
Ref: #man50464 Ref: #info50416
Node: print50869 Node: man50780
Ref: #print50974 Ref: #man50877
Node: register54730 Node: print51282
Ref: #register54843 Ref: #print51387
Node: Custom register output59339 Node: register55143
Ref: #custom-register-output59470 Ref: #register55256
Node: stats60767 Node: Custom register output59752
Ref: #stats60873 Ref: #custom-register-output59883
Node: test61754 Node: stats61180
Ref: #test61841 Ref: #stats61286
Node: ADD-ON COMMANDS62209 Node: test62167
Ref: #add-on-commands62321 Ref: #test62254
Node: Official add-ons63608 Node: ADD-ON COMMANDS62622
Ref: #official-add-ons63750 Ref: #add-on-commands62734
Node: api63837 Node: Official add-ons64021
Ref: #api63928 Ref: #official-add-ons64163
Node: ui63980 Node: api64250
Ref: #ui64081 Ref: #api64341
Node: web64139 Node: ui64393
Ref: #web64230 Ref: #ui64494
Node: Third party add-ons64276 Node: web64552
Ref: #third-party-add-ons64453 Ref: #web64643
Node: diff64588 Node: Third party add-ons64689
Ref: #diff64687 Ref: #third-party-add-ons64866
Node: iadd64786 Node: diff65001
Ref: #iadd64902 Ref: #diff65100
Node: interest64985 Node: iadd65199
Ref: #interest65108 Ref: #iadd65315
Node: irr65203 Node: interest65398
Ref: #irr65303 Ref: #interest65521
Node: Experimental add-ons65381 Node: irr65616
Ref: #experimental-add-ons65535 Ref: #irr65716
Node: autosync65928 Node: Experimental add-ons65794
Ref: #autosync66042 Ref: #experimental-add-ons65948
Node: budget66281 Node: autosync66341
Ref: #budget66405 Ref: #autosync66455
Node: chart66471 Node: budget66694
Ref: #chart66590 Ref: #budget66818
Node: check66661 Node: chart66884
Ref: #check66785 Ref: #chart67003
Node: check-dates66852 Node: check67074
Ref: #check-dates66994 Ref: #check67198
Node: check-dupes67067 Node: check-dates67265
Ref: #check-dupes67210 Ref: #check-dates67407
Node: equity67287 Node: check-dupes67480
Ref: #equity67415 Ref: #check-dupes67623
Node: prices67534 Node: equity67700
Ref: #prices67663 Ref: #equity67828
Node: print-unique67718 Node: prices67947
Ref: #print-unique67867 Ref: #prices68076
Node: register-match67960 Node: print-unique68131
Ref: #register-match68116 Ref: #print-unique68280
Node: rewrite68214 Node: register-match68373
Ref: #rewrite68335 Ref: #register-match68529
Node: rewrite68627
Ref: #rewrite68748
 
End Tag Table End Tag Table

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

@ -910,7 +910,7 @@ COMMANDS
Use unicode to display prettier tables. Use unicode to display prettier tables.
The balance command displays accounts and balances. It is hledger's The balance command displays accounts and balances. It is hledger's
most featureful and most useful command. most featureful and versatile command.
$ hledger balance $ hledger balance
$-1 assets $-1 assets
@ -935,7 +935,8 @@ COMMANDS
indented below their parent. "Boring" accounts, which contain a single indented below their parent. "Boring" accounts, which contain a single
interesting subaccount and no balance of their own, are elided into the interesting subaccount and no balance of their own, are elided into the
following line for more compact output. (Use --no-elide to prevent 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 Each account's balance is the "inclusive" balance - it includes the
balances of any subaccounts. balances of any subaccounts.
@ -1133,6 +1134,13 @@ COMMANDS
o %20(total) %2(depth_spacer)%-(account) - the default format for the o %20(total) %2(depth_spacer)%-(account) - the default format for the
single-column balance report 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 Output destination
The balance, print, register and stats commands can write their output The balance, print, register and stats commands can write their output
to a destination other than the console. This is controlled by the to a destination other than the console. This is controlled by the