diff options
| author | Joachim Breitner <mail@joachim-breitner.de> | 2014-06-24 05:02:27 +0400 |
|---|---|---|
| committer | Joachim Breitner <mail@joachim-breitner.de> | 2014-06-24 05:02:27 +0400 |
| commit | 663e01f07c0d41d69fa2022cac79ee26d056b62e (patch) | |
| tree | fea3695519435f024e5ab33149b250d366029628 /p/shellcheck/debian | |
| parent | 09668d04dc0c2d96bd04f4bb170d1f7def647090 (diff) | |
| download | DHG_packages-663e01f07c0d41d69fa2022cac79ee26d056b62e.tar.gz | |
shellcheck: Add manpage
Diffstat (limited to 'p/shellcheck/debian')
| -rw-r--r-- | p/shellcheck/debian/manpages | 1 | ||||
| -rw-r--r-- | p/shellcheck/debian/shellcheck.1 | 35 |
2 files changed, 36 insertions, 0 deletions
diff --git a/p/shellcheck/debian/manpages b/p/shellcheck/debian/manpages new file mode 100644 index 000000000..351c17675 --- /dev/null +++ b/p/shellcheck/debian/manpages @@ -0,0 +1 @@ +shellcheck.1 diff --git a/p/shellcheck/debian/shellcheck.1 b/p/shellcheck/debian/shellcheck.1 new file mode 100644 index 000000000..6da97d95f --- /dev/null +++ b/p/shellcheck/debian/shellcheck.1 @@ -0,0 +1,35 @@ +.TH SHELLCHECK 1 "23 JUNE 2014" +.SH NAME +shellcheck \- analyse shell scripts +.SH SYNOPSIS +\fBshellcheck\fP [ \-f \fIformat\fP ] [ \-e \fIcode\fP ] [ \-s \fIshell\fP ] \fIfiles\fP +.SH DESCRIPTION +\fBshellcheck\fP syntactically analyzes shell scripts and points out typical issues. +Among other things, it is able to spot wrong usage of unicode characters, non-matching parentheses, wrong spacing, usage of features unavailable to the selected shell, corner cases with respect to quoting, needlessly complex snippets and unused variables. +The analysis does not actually execute any shell commands. +.SH OPTIONS +.TP +\fB\-f\fP \fIformat\fP, \fB\-\-format\fP \fIformat\fP +Select the format used for printing diagnostics. +Available formats are \fBcheckstyle\fP (XML based format), \fBgcc\fP, \fBjson\fP and and \fBtty\fP (colorful). +The default format is \fBtty\fP. +.TP +\fB\-e\fP \fIcode\fP, \fB\-\-exclude\fP \fIcode\fP +Suppress emission of given diagnostic codes. +Diagnostic codes consist of four decimal digits. +To suppress multiple codes, the option can be given multiple times or codes can be separated using commas. +.TP +\fB\-s\fP \fIshell\fP, \fB\-\-shell\fP \fIshell\fP +Select shell dialect. +Available shells are \fBbash\fP, \fBksh\fP (Korn shell), \fBsh\fP (POSIX compatible), and \fBzsh\fP. +If this option is not given, the dialect is guessed from the shebang. +Defaults to \fBbash\fP. +.SH "SEE ALSO" +.BR bash(1), +.BR ksh(1), +.BR sh(1), +.BR zsh(1) +.SH AUTHORS +shellcheck was written by Vidar Holen. +.PP +This manual page was written by Helmut Grohne for the Debian project (but may be used by others). |