From 16bd52333a893a2584059c38ac14f21eb50aa496 Mon Sep 17 00:00:00 2001 From: Vidar Holen Date: Sun, 19 Jan 2014 12:36:48 -0800 Subject: [PATCH] man page: Added Directives section --- shellcheck.1.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/shellcheck.1.md b/shellcheck.1.md index 49f92f2..1a9e2c3 100644 --- a/shellcheck.1.md +++ b/shellcheck.1.md @@ -85,6 +85,34 @@ examines the file's shebang to determine which one to use. ... ] +# DIRECTIVES +ShellCheck directives can be specified as comments in the shell script +before a command or block: + + # shellcheck key=value key=value + command-or-structure + +For example, to suppress SC2035 about using `./*.jpg`: + + # shellcheck disable=SC2035 + echo "Files: " *.jpg + +Valid keys are: + +**disable** +: Disables a comma separated list of error codes for the following command. + The command can be a simple command like `echo foo`, or a compound command + like a function definition, subshell block or loop. + + +# AUTHOR +ShellCheck is written and maintained by Vidar Holen. + +# REPORTING BUGS +Bugs and issues can be reported on GitHub: + +https://github.com/koalaman/shellcheck/issues + # SEE ALSO sh(1) bash(1)