Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorPalotás Boldizsár2018-04-25 10:59:38 +0200
committerMartin Hořeňovský2018-05-06 11:37:00 +0200
commitdd99a66cf448f67113e5cf82eacb287668d2e4da (patch)
tree1f58eecf8c2859bc03791c78224b9c4a6b65b542
parentae590fe2163270685ebec4ed1541d3e8e9401692 (diff)
downloadcatch3-dd99a66cf448f67113e5cf82eacb287668d2e4da.tar.gz
Add documentation for `--use-colour`
The documentation added is based on output from `-?` (help), and comments to #590.
-rw-r--r--docs/command-line.md12
1 files changed, 12 insertions, 0 deletions
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)<br>
[Specify the section to run](#specify-the-section-to-run)<br>
[Filenames as tags](#filenames-as-tags)<br>
+[Override output colouring](#use-colour)<br>
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
<a href="#libidentify"> ` --libidentify`</a><br />
<a href="#wait-for-keypress"> ` --wait-for-keypress`</a><br />
<a href="#benchmark-resolution-multiple"> ` --benchmark-resolution-multiple`</a><br />
+<a href="#use-colour"> ` --use-colour`</a><br />
</br>
@@ -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]`.
+<a id="use-colour"></a>
+## Override output colouring
+<pre>--use-colour &lt;yes|no|auto&gt;</pre>
+
+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`.
---