Skip to content

Commit 9cc9a57

Browse files
committed
Tweak man page
1 parent b2dd00e commit 9cc9a57

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

shellcheck.1.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,7 @@ not warn at all, as `ksh` supports decimals in arithmetic contexts.
201201

202202

203203
# DIRECTIVES
204+
204205
ShellCheck directives can be specified as comments in the shell script.
205206
If they appear before the first command, they are considered file-wide.
206207
Otherwise, they apply to the immediately following command or block:
@@ -256,6 +257,7 @@ Valid keys are:
256257
as a more targeted alternative to 'disable=2039'.
257258

258259
# RC FILES
260+
259261
Unless `--norc` is used, ShellCheck will look for a file `.shellcheckrc` or
260262
`shellcheckrc` in the script's directory and each parent directory. If found,
261263
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.
289291

290292

291293
# ENVIRONMENT VARIABLES
294+
292295
The environment variable `SHELLCHECK_OPTS` can be set with default flags:
293296

294297
export SHELLCHECK_OPTS='--shell=bash --exclude=SC2016'
@@ -307,6 +310,7 @@ ShellCheck uses the follow exit codes:
307310
+ 4: ShellCheck was invoked with bad options (e.g. unknown formatter).
308311

309312
# LOCALE
313+
310314
This version of ShellCheck is only available in English. All files are
311315
leniently decoded as UTF-8, with a fallback of ISO-8859-1 for invalid
312316
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).
315319
Windows users seeing `commitBuffer: invalid argument (invalid character)`
316320
should set their terminal to use UTF-8 with `chcp 65001`.
317321

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.
320326

321327
# REPORTING BUGS
328+
322329
Bugs and issues can be reported on GitHub:
323330

324331
https://github.com/koalaman/shellcheck/issues
325332

326333
# COPYRIGHT
327-
Copyright 2012-2019, Vidar Holen.
334+
335+
Copyright 2012-2019, Vidar Holen and contributors.
328336
Licensed under the GNU General Public License version 3 or later,
329337
see https://gnu.org/licenses/gpl.html
330338

331-
332339
# SEE ALSO
333340

334341
sh(1) bash(1)

0 commit comments

Comments
 (0)