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

Tweaked man page format

This commit is contained in:
Vidar Holen 2013-12-15 19:40:05 -08:00
parent d540a98d33
commit 78d9a7ad97
2 changed files with 46 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Makefile
View File

@ -17,7 +17,8 @@ shellcheck.1: shellcheck.1.md
pandoc -s -t man $< -o $@
clean:
rm -f .tests shellcheck *.hi *.o ShellCheck/*.hi ShellCheck/*.o
rm -f .tests shellcheck shellcheck.1
rm -f *.hi *.o ShellCheck/*.hi ShellCheck/*.o
rm -rf dist
regardless:

89
shellcheck.1.md
View File

@ -20,71 +20,70 @@ corner cases can cause delayed failures.
**-f** *FORMAT*, **--format=***FORMAT*
: Specify the output format of shellcheck, which prints its results in the
standard output. Subsequent **-f** options are ignored, see **FORMATS**
below for more information.
: Specify the output format of shellcheck, which prints its results in the
standard output. Subsequent **-f** options are ignored, see **FORMATS**
below for more information.
**-e**\ *CODE1*[,*CODE2*...],\ **--exclude=***CODE1*[,*CODE2*...]
: Explicitly exclude the specified codes from the report. Subsequent **-e**
options are cumulative, but all the codes can be specified at once,
coma-separated as a single argument.
: Explicitly exclude the specified codes from the report. Subsequent **-e**
options are cumulative, but all the codes can be specified at once,
comma-separated as a single argument.
Also note that shellcheck supports multiple Bourne shell dialects, and
examines the file's shebang to determine which one to use.
# FORMATS
**tty**
: This is the default format, a plain text output. If your terminal handles
colors, messages are printed with a different color depending on their
types (error, warnings etc). You get a pretty terminal frontend.
: Plain text, human readable output. This is the default.
**gcc**
: This format outputs messages similar to those from gcc.
: GCC compatible output. Useful for editors that support compiling and
showing syntax errors.
`<file>:<line>:<column>: <type>: <message>`
For example, in Vim, `:set makeprg=shellcheck\ -f\ gcc\ %` will allow
using `:make` to check the script, and `:cnext` to jump to the next error.
<file>:<line>:<column>: <type>: <message>
**checkstyle**
: Checkstyle is a development tool to help programmers write Java code that
adheres to a coding standard. Checkstyle reports are XML files that can
be integrated with a wide range of tools from text editors to continuous
integration platforms.
: Checkstyle compatible XML output. Supported directly or through plugins
by many IDEs and build monitoring systems.
```
<?xml version='1.0' encoding='UTF-8'?>
<checkstyle version='4.3'>
<file name='file'>
<error
line='line'
column='column'
severity='severity'
message='message'
source='ShellCheck.SC####' />
...
</file>
...
</checkstyle>
```
<?xml version='1.0' encoding='UTF-8'?>
<checkstyle version='4.3'>
<file name='file'>
<error
line='line'
column='column'
severity='severity'
message='message'
source='ShellCheck.SC####' />
...
</file>
...
</checkstyle>
**json**
: Json is a popular serialization format that is more suitable for web
applications. ShellCheck's json is compact and contains only the strict
minimum.
: Json is a popular serialization format that is more suitable for web
applications. ShellCheck's json is compact and contains only the bare
minimum.
```
[
{
"line": line,
"column": column,
"level": level,
"code": ####,
"message": message
},
...
]
```
[
{
"line": line,
"column": column,
"level": level,
"code": ####,
"message": message
},
...
]
# SEE ALSO