7x31
/
shellcheck
mirror of https://github.com/koalaman/shellcheck.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Tweak man page

This commit is contained in:
Vidar Holen 2019-07-28 18:12:11 -07:00
parent b2dd00e4ee
commit 9cc9a575b2
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
shellcheck.1.md
View File

@ -201,6 +201,7 @@ not warn at all, as `ksh` supports decimals in arithmetic contexts.
# DIRECTIVES # DIRECTIVES
ShellCheck directives can be specified as comments in the shell script. ShellCheck directives can be specified as comments in the shell script.
If they appear before the first command, they are considered file-wide. If they appear before the first command, they are considered file-wide.
Otherwise, they apply to the immediately following command or block: Otherwise, they apply to the immediately following command or block:
@ -256,6 +257,7 @@ Valid keys are:
as a more targeted alternative to 'disable=2039'. as a more targeted alternative to 'disable=2039'.
# RC FILES # RC FILES
Unless `--norc` is used, ShellCheck will look for a file `.shellcheckrc` or Unless `--norc` is used, ShellCheck will look for a file `.shellcheckrc` or
`shellcheckrc` in the script's directory and each parent directory. If found, `shellcheckrc` in the script's directory and each parent directory. If found,
it will read `key=value` pairs from it and treat them as file-wide directives. 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.
# ENVIRONMENT VARIABLES # ENVIRONMENT VARIABLES
The environment variable `SHELLCHECK_OPTS` can be set with default flags: The environment variable `SHELLCHECK_OPTS` can be set with default flags:
export SHELLCHECK_OPTS='--shell=bash --exclude=SC2016' export SHELLCHECK_OPTS='--shell=bash --exclude=SC2016'
@ -307,6 +310,7 @@ ShellCheck uses the follow exit codes:
+ 4: ShellCheck was invoked with bad options (e.g. unknown formatter). + 4: ShellCheck was invoked with bad options (e.g. unknown formatter).
# LOCALE # LOCALE
This version of ShellCheck is only available in English. All files are This version of ShellCheck is only available in English. All files are
leniently decoded as UTF-8, with a fallback of ISO-8859-1 for invalid leniently decoded as UTF-8, with a fallback of ISO-8859-1 for invalid
sequences. `LC_CTYPE` is respected for output, and defaults to UTF-8 for 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).
Windows users seeing `commitBuffer: invalid argument (invalid character)` Windows users seeing `commitBuffer: invalid argument (invalid character)`
should set their terminal to use UTF-8 with `chcp 65001`. should set their terminal to use UTF-8 with `chcp 65001`.
# AUTHOR # AUTHORS
ShellCheck is written and maintained by Vidar Holen.
ShellCheck is developed and maintained by Vidar Holen, with assistance from a
long list of wonderful contributors.
# REPORTING BUGS # REPORTING BUGS
Bugs and issues can be reported on GitHub: Bugs and issues can be reported on GitHub:
https://github.com/koalaman/shellcheck/issues https://github.com/koalaman/shellcheck/issues
# COPYRIGHT # COPYRIGHT
Copyright 2012-2019, Vidar Holen.
Copyright 2012-2019, Vidar Holen and contributors.
Licensed under the GNU General Public License version 3 or later, Licensed under the GNU General Public License version 3 or later,
see https://gnu.org/licenses/gpl.html see https://gnu.org/licenses/gpl.html
# SEE ALSO # SEE ALSO
sh(1) bash(1) sh(1) bash(1)