From d1df3713cadaa143b7bb37b50c32d91f3c68dbfd Mon Sep 17 00:00:00 2001 From: Vidar Holen Date: Sat, 5 Dec 2015 13:16:31 -0800 Subject: [PATCH] Document --color in the man page. --- shellcheck.1.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/shellcheck.1.md b/shellcheck.1.md index ae0c05d..2755c4c 100644 --- a/shellcheck.1.md +++ b/shellcheck.1.md @@ -16,7 +16,7 @@ errors and pitfalls where the shell just gives a cryptic error message or strange behavior, but it also reports on a few more advanced issues where corner cases can cause delayed failures. -ShellCheck gives shell specific advice. Consider the line: +ShellCheck gives shell specific advice. Consider this line: (( area = 3.14*r*r )) @@ -32,6 +32,12 @@ not warn at all, as `ksh` supports decimals in arithmetic contexts. # OPTIONS +**-C**\ [*WHEN*],\ **--color**[=*WHEN*] + +: For TTY outut, enable colors *always*, *never* or *auto*. The default + is *auto*. **--color** without an argument is equivalent to + **--color=always**. + **-e**\ *CODE1*[,*CODE2*...],\ **--exclude=***CODE1*[,*CODE2*...] : Explicitly exclude the specified codes from the report. Subsequent **-e** @@ -54,7 +60,7 @@ not warn at all, as `ksh` supports decimals in arithmetic contexts. : Print version information and exit. -**-x**,\ **-external-sources** +**-x**,\ **--external-sources** : Follow 'source' statements even when the file is not specified as input. By default, `shellcheck` will only follow files specified on the command