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

;cli: improve --color help

Browse Source
This commit is contained in:
Simon Michael 2020-07-14 12:22:11 -07:00
parent 031f72ac4b
commit 144415f6fa
2 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/common.m4
View File

@ -161,6 +161,12 @@ m4_define({{_reportingoptions_}}, {{
: generate future transactions from [periodic transaction](journal.html#periodic-transactions) rules, for the next 6 months or till report end date. : generate future transactions from [periodic transaction](journal.html#periodic-transactions) rules, for the next 6 months or till report end date.
In hledger-ui, also make ordinary future transactions visible. In hledger-ui, also make ordinary future transactions visible.
`--color=always|yes|never|no|auto (or --colour=...)`
: 'auto' is the default, it tries to use ANSI color codes in terminal output when supported.
: 'always' or 'yes' forces color on, useful when piping output, eg into 'less -R'.
: 'never' or 'no' forces color off.
: A NO_COLOR environment variable also disables color, overriding this option.
When a reporting option appears more than once in the command line, the last one takes precedence. When a reporting option appears more than once in the command line, the last one takes precedence.
Some reporting options can also be written as [query arguments](#queries). Some reporting options can also be written as [query arguments](#queries).

9
hledger/Hledger/Cli/CliOptions.hs
View File

@ -191,13 +191,12 @@ reportflags = [
-- general output-related -- general output-related
,flagReq ["color","colour"] (\s opts -> Right $ setopt "color" s opts) "always|never|auto" ,flagReq ["color","colour"] (\s opts -> Right $ setopt "color" s opts) "always|yes|never|no|auto"
(unwords (unwords
["When to use color (or colour) in terminal output." ["'auto' is the default, it tries to use ANSI color codes in terminal output when supported."
,"'auto' is the default; it tries to enable color when the terminal is color-supporting and interactive." ,"'always' or 'yes' forces color on, useful when piping output, eg into 'less -R'."
,"'always' or 'yes' forces color on, useful eg when piping output into 'less -R'."
,"'never' or 'no' forces color off." ,"'never' or 'no' forces color off."
,"A NO_COLOR environment variable will also force color off, overriding this option." ,"A NO_COLOR environment variable also disables color, overriding this option."
]) ])
] ]