Merge pull request #6 from tbielawa/manpage

Because everything should have a man page

.gitignore

+*~
+*.py[co]
+build

AUTHORS.md

@@ -4,7 +4,7 @@ Patches and Contributions
    * Michael DeHaan - michael.dehaan AT gmail DOT com
    * Jeremy Katz - katzj AT fedoraproject DOT org
    * Seth Vidal - skvidal AT fedoraproject DOT org
-   * Tim Bielawa - tbielawa AT gmail DOT com
+   * Tim Bielawa - tbielawa AT redhat DOT com
 
 Send in a github pull request to get your name here.
 

Makefile

+#!/usr/bin/make
+
+ASCII2MAN = a2x -D $(dir $@) -d manpage -f manpage $<
+ASCII2HTMLMAN = a2x -D docs/html/man/ -d manpage -f xhtml
+MANPAGES := docs/man/man1/ansible.1
+SITELIB = $(shell python -c "from distutils.sysconfig import get_python_lib; print get_python_lib()")
+
+docs: manuals
+
+manuals: $(MANPAGES)
+
+%.1: %.1.asciidoc
+	$(ASCII2MAN)
+
+%.5: %.5.asciidoc
+	$(ASCII2MAN)
+
+pep8:
+	@echo "#############################################"
+	@echo "# Running PEP8 Compliance Tests"
+	@echo "#############################################"
+	pep8 lib/
+
+clean:
+	find . -type f -name "*.pyc" -delete
+	find . -type f -name "*.pyo" -delete
+	find . -type f -name "*~" -delete
+	find ./docs/ -type f -name "*.xml" -delete
+	find . -type f -name "#*" -delete
+
+.PHONEY: docs manual clean pep8
+vpath %.asciidoc docs/man/man1

docs/man/.gitignore

+*.xml
\ No newline at end of file

docs/man/man1/ansible.1

+'\" t
+.\"     Title: ansible
+.\"    Author: [see the "AUTHOR" section]
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 02/24/2012
+.\"    Manual: System administration commands
+.\"    Source: Ansible 0.0.1
+.\"  Language: English
+.\"
+.TH "ANSIBLE" "1" "02/24/2012" "Ansible 0\&.0\&.1" "System administration commands"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+ansible \- run a command somewhere else
+.SH "SYNOPSIS"
+.sp
+ansible [\-H hosts_path] [\-L library_path] [\-f forks] [\-n module_name] [\-a [args1 [args2 \&...]]] [\-p host_pattern] [\-u remote_user]
+.SH "DESCRIPTION"
+.sp
+\fBAnsible\fR is an extra\-simple Python API for doing \*(Aqremote things\*(Aq over SSH\&.
+.SH "OPTIONS"
+.PP
+\fB\-P\fR, \fB\-\-askpass\fR
+.RS 4
+Ask the user to input the ssh password for connecting\&.
+.RE
+.PP
+\fB\-H\fR, \fB\-\-host\-list\fR
+.RS 4
+Path to hosts list\&.
+.RE
+.PP
+\fB\-L\fR, \fB\-\-library\fR
+.RS 4
+Path to module library\&.
+.RE
+.PP
+\fB\-f\fR, \fB\-\-forks\fR
+.RS 4
+Level of parallelism\&. Specify as an integer\&.
+.RE
+.PP
+\fB\-n\fR, \fB\-\-name\fR
+.RS 4
+Module name to execute\&.
+.RE
+.PP
+\fB\-a\fR, \fB\-\-args\fR
+.RS 4
+Arguments to module\&.
+.RE
+.PP
+\fB\-p\fR, \fB\-\-pattern\fR
+.RS 4
+Hostname pattern\&. Accepts shell\-like globs\&.
+.RE
+.PP
+\fB\-r\fR, \fB\-\-run\-playbook\fR
+.RS 4
+Playbook file to run\&. Replaces the
+\fB\-n\fR
+and
+\fB\-a\fR
+options\&.
+.RE
+.PP
+\fB\-u\fR, \fB\-\-remote\-user\fR
+.RS 4
+Remote user to connect as\&. Uses
+\fIroot\fR
+by default\&.
+.RE
+.SH "INVENTORY"
+.sp
+Ansible stores the hosts it can potentially operate on in an inventory file\&. The syntax is simple: one host per line\&. Organize your hosts into multiple groups by separating them into multiple inventory files\&.
+.SH "FILES"
+.sp
+/etc/ansible/hosts \(em Default hosts file
+.sp
+/usr/share/ansible \(em Default module library
+.SH "AUTHOR"
+.sp
+Ansible was originally written by Michael DeHaan\&. See the AUTHORS file for a complete list of contributors\&.
+.SH "COPYRIGHT"
+.sp
+Copyright \(co 2012, Michael DeHaan
+.sp
+Ansible is released under the terms of the MIT license\&.
+.SH "SEE ALSO"
+.sp
+Ansible home page: https://github\&.com/mpdehaan/ansible/

docs/man/man1/ansible.1.asciidoc

+ansible(1)
+=========
+:doctype:manpage
+:man source:   Ansible
+:man version:  0.0.1
+:man manual:   System administration commands
+
+NAME
+----
+ansible - run a command somewhere else
+
+
+SYNOPSIS
+--------
+ansible [-H hosts_path] [-L library_path] [-f forks] [-n module_name]
+        [-a [args1 [args2 ...]]] [-p host_pattern] [-u remote_user]
+
+
+DESCRIPTION
+-----------
+
+*Ansible* is an extra-simple Python API for doing \'remote things' over
+SSH.
+
+
+OPTIONS
+-------
+
+*-P*, *--askpass*::
+
+Ask the user to input the ssh password for connecting.
+
+
+*-H*, *--host-list*::
+
+Path to hosts list.
+
+
+*-L*, *--library*::
+
+Path to module library.
+
+
+*-f*, *--forks*::
+
+Level of parallelism. Specify as an integer.
+
+
+*-n*, *--name*::
+
+Module name to execute.
+
+
+*-a*, *--args*::
+
+Arguments to module.
+
+
+*-p*, *--pattern*::
+
+Hostname pattern. Accepts shell-like globs.
+
+
+*-r*, *--run-playbook*::
+
+Playbook file to run. Replaces the *-n* and *-a* options.
+
+
+*-u*, *--remote-user*::
+
+Remote user to connect as. Uses __root__ by default.
+
+
+INVENTORY
+---------
+
+Ansible stores the hosts it can potentially operate on in an inventory
+file. The syntax is simple: one host per line. Organize your hosts
+into multiple groups by separating them into multiple inventory files.
+
+
+FILES
+-----
+
+/etc/ansible/hosts -- Default hosts file
+
+/usr/share/ansible -- Default module library
+
+
+AUTHOR
+------
+
+Ansible was originally written by Michael DeHaan. See the AUTHORS file
+for a complete list of contributors.
+
+
+COPYRIGHT
+---------
+
+Copyright © 2012, Michael DeHaan
+
+Ansible is released under the terms of the MIT license.
+
+
+
+SEE ALSO
+--------
+
+Ansible home page: <https://github.com/mpdehaan/ansible/>

setup.py

@@ -19,10 +19,12 @@ setup(name='ansible',
              'library/command',
              'library/facter',
              'library/copy',
+         ]),
+         ('man/man1', [
+                'docs/man/man1/ansible.1'
          ])
       ],
       scripts=[
          'bin/ansible',
       ]
 )
-