@@ -201,6 +201,7 @@ not warn at all, as `ksh` supports decimals in arithmetic contexts.
201
201
202
202
203
203
# DIRECTIVES
204
+
204
205
ShellCheck directives can be specified as comments in the shell script.
205
206
If they appear before the first command, they are considered file-wide.
206
207
Otherwise, they apply to the immediately following command or block:
@@ -256,6 +257,7 @@ Valid keys are:
256
257
as a more targeted alternative to 'disable=2039'.
257
258
258
259
# RC FILES
260
+
259
261
Unless ` --norc ` is used, ShellCheck will look for a file ` .shellcheckrc ` or
260
262
` shellcheckrc ` in the script's directory and each parent directory. If found,
261
263
it will read ` key=value ` pairs from it and treat them as file-wide directives.
@@ -289,6 +291,7 @@ are mounted in the container, so `~/.shellcheckrc` will not be read.
289
291
290
292
291
293
# ENVIRONMENT VARIABLES
294
+
292
295
The environment variable ` SHELLCHECK_OPTS ` can be set with default flags:
293
296
294
297
export SHELLCHECK_OPTS='--shell=bash --exclude=SC2016'
@@ -307,6 +310,7 @@ ShellCheck uses the follow exit codes:
307
310
+ 4: ShellCheck was invoked with bad options (e.g. unknown formatter).
308
311
309
312
# LOCALE
313
+
310
314
This version of ShellCheck is only available in English. All files are
311
315
leniently decoded as UTF-8, with a fallback of ISO-8859-1 for invalid
312
316
sequences. ` LC_CTYPE ` is respected for output, and defaults to UTF-8 for
@@ -315,20 +319,23 @@ locales where encoding is unspecified (such as the `C` locale).
315
319
Windows users seeing ` commitBuffer: invalid argument (invalid character) `
316
320
should set their terminal to use UTF-8 with ` chcp 65001 ` .
317
321
318
- # AUTHOR
319
- ShellCheck is written and maintained by Vidar Holen.
322
+ # AUTHORS
323
+
324
+ ShellCheck is developed and maintained by Vidar Holen, with assistance from a
325
+ long list of wonderful contributors.
320
326
321
327
# REPORTING BUGS
328
+
322
329
Bugs and issues can be reported on GitHub:
323
330
324
331
https://github.com/koalaman/shellcheck/issues
325
332
326
333
# COPYRIGHT
327
- Copyright 2012-2019, Vidar Holen.
334
+
335
+ Copyright 2012-2019, Vidar Holen and contributors.
328
336
Licensed under the GNU General Public License version 3 or later,
329
337
see https://gnu.org/licenses/gpl.html
330
338
331
-
332
339
# SEE ALSO
333
340
334
341
sh(1) bash(1)
0 commit comments