From 7d1fa92bd4256640d48967f3fa729f6136140b8c Mon Sep 17 00:00:00 2001 From: Tomas Babej Date: Wed, 2 Sep 2015 07:20:24 +0200 Subject: [PATCH] docs: Document rule.color.merge --- ChangeLog | 2 ++ NEWS | 3 +++ doc/man/task-color.5.in | 3 +++ doc/man/taskrc.5.in | 16 ++++++++++++++++ 4 files changed, 24 insertions(+) diff --git a/ChangeLog b/ChangeLog index 823bd84d2..ecb82b19e 100644 --- a/ChangeLog +++ b/ChangeLog @@ -174,6 +174,8 @@ task is created. - New 'unwait' verbosity token generates a notification message when a waiting task becomes visible. +- New 'rule.color.merge=yes|no' configuration option, that can optionally + turn off color blending engine. ------ current release --------------------------- diff --git a/NEWS b/NEWS index eba7e0021..ef262d8f6 100644 --- a/NEWS +++ b/NEWS @@ -25,6 +25,9 @@ New configuration options in Taskwarrior 2.4.5 generated. - The new 'unwait' verbosity token generates a message when a waiting task becomes visible. + - The new 'rule.color.merge' configuration option can disable merging of colors + produced by different color rules. Use if your color scheme produces + unpleasing foreground and background combinations. Newly deprecated features in Taskwarrior 2.4.5 diff --git a/doc/man/task-color.5.in b/doc/man/task-color.5.in index b02855596..6e737656c 100644 --- a/doc/man/task-color.5.in +++ b/doc/man/task-color.5.in @@ -240,6 +240,9 @@ It is possible to create a very colorful mix of rules. With 256-color support, those colors can be made subtle, and complementary, but without care, this can be a visual mess. Beware! +In such cases, consider using the 'rule.color.merge=no' option to disable the +color blending. + The precedence for the color rules is determined by the configuration variable 'rule.precedence.color', which by default contains: diff --git a/doc/man/taskrc.5.in b/doc/man/taskrc.5.in index 106c075da..f8908206a 100644 --- a/doc/man/taskrc.5.in +++ b/doc/man/taskrc.5.in @@ -881,6 +881,22 @@ nothing, for example: .RE .RE +.RS +By default, colors produced by rules blend. This has the advantage of +conveying additional information, by producing combinations that are not used +by any particular rule directly. + +However, color blending can produce highlighting combinations which are not +desired. In such cases, use the following option to disable this behaviour: +.RE + +.TP +.B rule.color.merge=yes +Can be "yes" or "no". When "no", disables merging of colors produced by +different color rules. Use if your color scheme produces unpleasing +foreground and background combinations. + + See the task-color(5) man pages for color details. .RE