bashate/doc/source/man/bashate.rst
Riccardo Pittau ebc1f46a82 correcting typo in EXAMPLES section
-I should be -i

Change-Id: I442f9247d869329a64d03b53c0619acdfd394fdc
2017-04-05 18:01:51 +02:00

45 lines
884 B
ReStructuredText

===========================
:program:`bashate` man page
===========================
.. program:: bashate
.. highlight:: bash
SYNOPSIS
========
:program:`bashate` [options] <file> [files...]
DESCRIPTION
===========
The :program:`bashate` command line utility is a style-checker for
bash scripts.
The name is derived from :program:`pep8`, a Python lint-type tool.
OPTIONS
=======
--help, -h Print help
--verbose, -v Verbose output
--ignore, -i Tests to ignore, comma separated
--error, -e Tests to trigger errors instead of warnings, comma separated
--warn, -w Tests to trigger warnings instead of errors, comma separated
EXAMPLES
========
Run all tests on a single file::
bashate file.sh
Run tests on several files, while also ignoring several errors::
bashate -i E010,E011 file.sh file2.sh
BUGS
====
http://bugs.launchpad.net/bash8