From dd99a66cf448f67113e5cf82eacb287668d2e4da Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Palot=C3=A1s=20Boldizs=C3=A1r?= Date: Wed, 25 Apr 2018 10:59:38 +0200 Subject: [PATCH] Add documentation for `--use-colour` The documentation added is based on output from `-?` (help), and comments to #590. --- docs/command-line.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/command-line.md b/docs/command-line.md index 78d83625..9a095a04 100644 --- a/docs/command-line.md +++ b/docs/command-line.md @@ -24,6 +24,7 @@ [Usage](#usage)
[Specify the section to run](#specify-the-section-to-run)
[Filenames as tags](#filenames-as-tags)
+[Override output colouring](#use-colour)
Catch works quite nicely without any command line options at all - but for those times when you want greater control the following options are available. Click one of the followings links to take you straight to that option - or scroll on to browse the available options. @@ -57,6 +58,7 @@ Click one of the followings links to take you straight to that option - or scrol ` --libidentify`
` --wait-for-keypress`
` --benchmark-resolution-multiple`
+ ` --use-colour`

@@ -329,6 +331,16 @@ filename it is found in, with any extension stripped, prefixed with the `#` char So, for example, tests within the file `~\Dev\MyProject\Ferrets.cpp` would be tagged `[#Ferrets]`. + +## Override output colouring +
--use-colour <yes|no|auto>
+ +Catch colours output for terminals, but omits colouring when it detects that +output is being sent to a pipe. This is done to avoid interfering with automated +processing of output. + +`--use-colour yes` forces coloured output, `--use-colour no` disables coloured +output. The default behaviour is `--use-colour auto`. ---