mirror of
				https://github.com/catchorg/Catch2.git
				synced 2025-10-31 20:27:11 +01:00 
			
		
		
		
	Add documentation for --use-colour
				
					
				
			The documentation added is based on output from `-?` (help), and comments to #590.
This commit is contained in:
		 Palotás Boldizsár
					Palotás Boldizsár
				
			
				
					committed by
					
						 Martin Hořeňovský
						Martin Hořeňovský
					
				
			
			
				
	
			
			
			 Martin Hořeňovský
						Martin Hořeňovský
					
				
			
						parent
						
							ae590fe216
						
					
				
				
					commit
					dd99a66cf4
				
			| @@ -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 <yes|no|auto></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`. | ||||
|  | ||||
| --- | ||||
|  | ||||
|   | ||||
		Reference in New Issue
	
	Block a user