Add man page

Add man page documentation

Change-Id: I4b4994ac35684002dd9140fecbf9f1825dad4538
This commit is contained in:
Ian Wienand 2014-10-29 12:32:21 +11:00
parent 421ebc0d36
commit cffe2b5952
3 changed files with 54 additions and 0 deletions

@ -45,3 +45,8 @@ Obsolete and deprecated syntax
Rules to identify obsolete and deprecated syntax that should not be used
- E041: Usage of $[ for arithmetic is deprecated for $((
See also
~~~~~~~~
See also :doc:`/man/bashate`.

@ -49,6 +49,13 @@ add_module_names = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# Grouping the document tree for man pages.
# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
man_pages = [
('man/bashate', 'bashate', u'Style checker for bash scripts',
[u'OpenStack Foundation'], 1),
]
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with

@ -0,0 +1,42 @@
===========================
: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
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