Commit 4a951944 by Michael DeHaan

Docs rebuild in new project structure.

parent dd727ece
...@@ -62,7 +62,7 @@ tests: ...@@ -62,7 +62,7 @@ tests:
PYTHONPATH=./lib nosetests -d -v PYTHONPATH=./lib nosetests -d -v
# To force a rebuild of the docs run 'touch VERSION && make docs' # To force a rebuild of the docs run 'touch VERSION && make docs'
docs: $(MANPAGES) modulepages docs: $(MANPAGES) modulepages docsite
# Regenerate %.1.asciidoc if %.1.asciidoc.in has been modified more # Regenerate %.1.asciidoc if %.1.asciidoc.in has been modified more
# recently than %.1.asciidoc. # recently than %.1.asciidoc.
...@@ -162,3 +162,6 @@ deb: debian ...@@ -162,3 +162,6 @@ deb: debian
modulepages: modulepages:
hacking/module_formatter.py -A $(VERSION) -t man -o docs/man/man3/ --module-dir=library --template-dir=hacking/templates hacking/module_formatter.py -A $(VERSION) -t man -o docs/man/man3/ --module-dir=library --template-dir=hacking/templates
docsite:
(cd docsite; make docs)
...@@ -2,12 +2,12 @@ ...@@ -2,12 +2,12 @@
.\" Title: ansible .\" Title: ansible
.\" Author: [see the "AUTHOR" section] .\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 09/06/2012 .\" Date: 10/08/2012
.\" Manual: System administration commands .\" Manual: System administration commands
.\" Source: Ansible 0.8 .\" Source: Ansible 0.8
.\" Language: English .\" Language: English
.\" .\"
.TH "ANSIBLE" "1" "09/06/2012" "Ansible 0\&.8" "System administration commands" .TH "ANSIBLE" "1" "10/08/2012" "Ansible 0\&.8" "System administration commands"
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
.\" * set default formatting .\" * set default formatting
.\" ----------------------------------------------------------------- .\" -----------------------------------------------------------------
...@@ -141,11 +141,6 @@ Sudo to ...@@ -141,11 +141,6 @@ Sudo to
instead of root\&. Implies \-\-sudo\&. instead of root\&. Implies \-\-sudo\&.
.RE .RE
.PP .PP
\fB\-\-private\-key=\fR\fIPRIVATE_KEY_FILE\fR
.RS 4
Use this file to authenticate the connection\&.
.RE
.PP
\fB\-c\fR \fICONNECTION\fR, \fB\-\-connection=\fR\fICONNECTION\fR \fB\-c\fR \fICONNECTION\fR, \fB\-\-connection=\fR\fICONNECTION\fR
.RS 4 .RS 4
Connection type to use\&. Possible options are Connection type to use\&. Possible options are
......
.TH ANSIBLE.APT 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.APT 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/apt ." generated from library/apt
.SH NAME .SH NAME
apt \- Manages apt-packages apt \- Manages apt-packages
......
.TH ANSIBLE.APT_REPOSITORY 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.APT_REPOSITORY 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/apt_repository ." generated from library/apt_repository
.SH NAME .SH NAME
apt_repository \- Manages apt repositores apt_repository \- Manages apt repositores
......
.TH ANSIBLE.ASSEMBLE 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.ASSEMBLE 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/assemble ." generated from library/assemble
.SH NAME .SH NAME
assemble \- Assembles a configuration file from fragments assemble \- Assembles a configuration file from fragments
......
.TH ANSIBLE.ASYNC_STATUS 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.ASYNC_STATUS 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/async_status ." generated from library/async_status
.SH NAME .SH NAME
async_status \- Obtain status of asynchronous task async_status \- Obtain status of asynchronous task
......
.TH ANSIBLE.AUTHORIZED_KEY 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.AUTHORIZED_KEY 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/authorized_key ." generated from library/authorized_key
.SH NAME .SH NAME
authorized_key \- Adds or removes an SSH authorized key authorized_key \- Adds or removes an SSH authorized key
......
.TH ANSIBLE.COMMAND 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.COMMAND 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/command ." generated from library/command
.SH NAME .SH NAME
command \- Executes a command on a remote node command \- Executes a command on a remote node
......
.TH ANSIBLE.COPY 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.COPY 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/copy ." generated from library/copy
.SH NAME .SH NAME
copy \- Copies files to remote locations. copy \- Copies files to remote locations.
......
.TH ANSIBLE.EASY_INSTALL 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.EASY_INSTALL 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/easy_install ." generated from library/easy_install
.SH NAME .SH NAME
easy_install \- Installs Python libraries easy_install \- Installs Python libraries
......
.TH ANSIBLE.FACTER 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.FACTER 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/facter ." generated from library/facter
.SH NAME .SH NAME
facter \- Runs the discovery program I(facter) on the remote system facter \- Runs the discovery program I(facter) on the remote system
......
.TH ANSIBLE.FAIL 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.FAIL 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/fail ." generated from library/fail
.SH NAME .SH NAME
fail \- Fail with custom message fail \- Fail with custom message
...@@ -12,7 +12,7 @@ This module fails the progress with a custom message. It can be useful for baili ...@@ -12,7 +12,7 @@ This module fails the progress with a custom message. It can be useful for baili
.SH OPTIONS .SH OPTIONS
.IP msg .IP msg
The customized message used for failing execution. If ommited, fail will simple bail out with a generic message. (default: Failed because only_if condition is true) The customized message used for failing execution. If ommited, fail will simple bail out with a generic message. (default: 'Failed because only_if condition is true')
.IP rc .IP rc
The return code of the failure. This is currently not used by Ansible, but might be used in the future. (default: 1)." The return code of the failure. This is currently not used by Ansible, but might be used in the future. (default: 1)."
." ."
...@@ -23,7 +23,9 @@ The return code of the failure. This is currently not used by Ansible, but might ...@@ -23,7 +23,9 @@ The return code of the failure. This is currently not used by Ansible, but might
.SH EXAMPLES .SH EXAMPLES
.PP .PP
.nf .nf
[{'action': 'fail msg="The system may not be provisioned according to the CMDB status."', 'only_if': "'$cmdb_status' != 'to-be-staged'"}] action: fail msg="The system may not be provisioned according to the CMDB status." rc=100
only_if: "'$cmdb_status' != 'to-be-staged'"
.fi .fi
." ------- AUTHOR ." ------- AUTHOR
.SH AUTHOR .SH AUTHOR
......
.TH ANSIBLE.FETCH 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.FETCH 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/fetch ." generated from library/fetch
.SH NAME .SH NAME
fetch \- Fetches a file from remote nodes fetch \- Fetches a file from remote nodes
......
.TH ANSIBLE.FILE 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.FILE 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/file ." generated from library/file
.SH NAME .SH NAME
file \- Sets attributes of files file \- Sets attributes of files
......
.TH ANSIBLE.FIREBALL 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.FIREBALL 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/fireball ." generated from library/fireball
.SH NAME .SH NAME
fireball \- Enable fireball mode on remote node fireball \- Enable fireball mode on remote node
......
.TH ANSIBLE.GET_URL 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.GET_URL 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/get_url ." generated from library/get_url
.SH NAME .SH NAME
get_url \- Downloads files from HTTP, HTTPS, or FTP to node get_url \- Downloads files from HTTP, HTTPS, or FTP to node
......
.TH ANSIBLE.GIT 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.GIT 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/git ." generated from library/git
.SH NAME .SH NAME
git \- Deploy software (or files) from git checkouts git \- Deploy software (or files) from git checkouts
......
.TH ANSIBLE.GROUP 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.GROUP 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/group ." generated from library/group
.SH NAME .SH NAME
group \- Add or remove groups group \- Add or remove groups
......
.TH ANSIBLE.INI_FILE 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.INI_FILE 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/ini_file ." generated from library/ini_file
.SH NAME .SH NAME
ini_file \- Tweak settings in INI files ini_file \- Tweak settings in INI files
......
.TH ANSIBLE.LINEINFILE 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.LINEINFILE 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/lineinfile ." generated from library/lineinfile
.SH NAME .SH NAME
lineinfile \- Ensure a particular line is in a file lineinfile \- Ensure a particular line is in a file
...@@ -13,16 +13,16 @@ This is primarily useful when you want to change a single line in a file only. F ...@@ -13,16 +13,16 @@ This is primarily useful when you want to change a single line in a file only. F
." ."
.SH OPTIONS .SH OPTIONS
.IP insertafter
Used with \fCstate=present\fR. If specified, the line will be inserted after the specified regular expression. Two special values are available; \fCBOF\fR for inserting the line at the beginning of the file, and \fCEOF\fR for inserting the line at the end of the file.
.IR Choices :
BOF,EOF. (default: EOF)
.IP state .IP state
Whether the line should be there or not. Whether the line should be there or not.
.IR Choices : .IR Choices :
present,absent. (default: present) present,absent. (default: present)
.IP name .IP dest
The file to modify(required) The file to modify(required)
.IP insertafter
Used with \fCstate=present\fR. If specified, the line will be inserted after the specified regular expression. Two special values are available; \fCBOF\fR for inserting the line at the beginning of the file, and \fCEOF\fR for inserting the line at the end of the file.
.IR Choices :
BOF,EOF. (default: EOF)
.IP regexp .IP regexp
The regular expression to look for in the file. For \fCstate=present\fR, the pattern to replace. For \fCstate=absent\fR, the pattern of the line to remove.(required) The regular expression to look for in the file. For \fCstate=present\fR, the pattern to replace. For \fCstate=absent\fR, the pattern of the line to remove.(required)
.IP line .IP line
...@@ -37,11 +37,11 @@ Create a backup file including the timestamp information so you can get the orig ...@@ -37,11 +37,11 @@ Create a backup file including the timestamp information so you can get the orig
.SH EXAMPLES .SH EXAMPLES
.PP .PP
.nf .nf
lineinfile name=/etc/selinux/config regexp=^SELINUX= line=SELINUX=disabled lineinfile dest=/etc/selinux/config regexp=^SELINUX= line=SELINUX=disabled
.fi .fi
.PP .PP
.nf .nf
lineinfile name=/etc/sudoers state=absent regexp="^%wheel" lineinfile dest=/etc/sudoers state=absent regexp="^%wheel"
.fi .fi
." ------- AUTHOR ." ------- AUTHOR
.SH AUTHOR .SH AUTHOR
......
.TH ANSIBLE.MOUNT 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.MOUNT 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/mount ." generated from library/mount
.SH NAME .SH NAME
mount \- Control active and configured mount points mount \- Control active and configured mount points
......
.TH ANSIBLE.MYSQL_DB 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.MYSQL_DB 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/mysql_db ." generated from library/mysql_db
.SH NAME .SH NAME
mysql_db \- Add or remove MySQL databases from a remote host. mysql_db \- Add or remove MySQL databases from a remote host.
......
.TH ANSIBLE.MYSQL_USER 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.MYSQL_USER 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/mysql_user ." generated from library/mysql_user
.SH NAME .SH NAME
mysql_user \- Adds or removes a user from a MySQL database. mysql_user \- Adds or removes a user from a MySQL database.
......
.TH ANSIBLE.NAGIOS 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.NAGIOS 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/nagios ." generated from library/nagios
.SH NAME .SH NAME
nagios \- Perform common tasks in Nagios related to downtime and notifications. nagios \- Perform common tasks in Nagios related to downtime and notifications.
......
.TH ANSIBLE.OHAI 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.OHAI 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/ohai ." generated from library/ohai
.SH NAME .SH NAME
ohai \- Returns inventory data from I(ohai) ohai \- Returns inventory data from I(ohai)
......
.TH ANSIBLE.PAUSE 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.PAUSE 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/pause ." generated from library/pause
.SH NAME .SH NAME
pause \- Pause playbook execution pause \- Pause playbook execution
......
.TH ANSIBLE.PING 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.PING 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/ping ." generated from library/ping
.SH NAME .SH NAME
ping \- Try to connect to host and return pong on success. ping \- Try to connect to host and return pong on success.
......
.TH ANSIBLE.PIP 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.PIP 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/pip ." generated from library/pip
.SH NAME .SH NAME
pip \- Manages Python library dependencies. pip \- Manages Python library dependencies.
......
.TH ANSIBLE.POSTGRESQL_DB 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.POSTGRESQL_DB 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/postgresql_db ." generated from library/postgresql_db
.SH NAME .SH NAME
postgresql_db \- Add or remove PostgreSQL databases from a remote host. postgresql_db \- Add or remove PostgreSQL databases from a remote host.
......
.TH ANSIBLE.POSTGRESQL_USER 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.POSTGRESQL_USER 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/postgresql_user ." generated from library/postgresql_user
.SH NAME .SH NAME
postgresql_user \- Adds or removes a users (roles) from a PostgreSQL database. postgresql_user \- Adds or removes a users (roles) from a PostgreSQL database.
......
.TH ANSIBLE.RAW 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.RAW 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/raw ." generated from library/raw
.SH NAME .SH NAME
raw \- Executes a low-down and dirty SSH command raw \- Executes a low-down and dirty SSH command
......
.TH ANSIBLE.SEBOOLEAN 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.SEBOOLEAN 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/seboolean ." generated from library/seboolean
.SH NAME .SH NAME
seboolean \- Toggles SELinux booleans. seboolean \- Toggles SELinux booleans.
......
.TH ANSIBLE.SELINUX 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.SELINUX 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/selinux ." generated from library/selinux
.SH NAME .SH NAME
selinux \- Change policy and state of SELinux selinux \- Change policy and state of SELinux
......
.TH ANSIBLE.SERVICE 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.SERVICE 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/service ." generated from library/service
.SH NAME .SH NAME
service \- Manage services. service \- Manage services.
......
.TH ANSIBLE.SETUP 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.SETUP 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/setup ." generated from library/setup
.SH NAME .SH NAME
setup \- Gathers facts about remote hosts setup \- Gathers facts about remote hosts
......
.TH ANSIBLE.SHELL 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.SHELL 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/shell ." generated from library/shell
.SH NAME .SH NAME
shell \- Execute commands in nodes. shell \- Execute commands in nodes.
." ------ DESCRIPTION ." ------ DESCRIPTION
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
The shell module takes the command name followed by a list of arguments, space delimited. It is almost exactly like the \fIcommand\fR module but runs the command through the user's configured shell on the remote node. The shell module takes the command name followed by a list of arguments, space delimited. It is almost exactly like the \fIcommand\fR module but runs the command through a shell (\fC/bin/sh\fR) on the remote node.
." ------ OPTIONS ." ------ OPTIONS
." ."
." ."
......
.TH ANSIBLE.SLURP 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.SLURP 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/slurp ." generated from library/slurp
.SH NAME .SH NAME
slurp \- Slurps a file from remote nodes slurp \- Slurps a file from remote nodes
......
.TH ANSIBLE.SUBVERSION 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.SUBVERSION 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/subversion ." generated from library/subversion
.SH NAME .SH NAME
subversion \- Deploys a subversion repository. subversion \- Deploys a subversion repository.
......
.TH ANSIBLE.SUPERVISORCTL 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.SUPERVISORCTL 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/supervisorctl ." generated from library/supervisorctl
.SH NAME .SH NAME
supervisorctl \- Manage the state of a program or group of programs running via Supervisord supervisorctl \- Manage the state of a program or group of programs running via Supervisord
......
.TH ANSIBLE.TEMPLATE 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.TEMPLATE 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/template ." generated from library/template
.SH NAME .SH NAME
template \- Templates a file out to a remote server. template \- Templates a file out to a remote server.
......
.TH ANSIBLE.USER 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.USER 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/user ." generated from library/user
.SH NAME .SH NAME
user \- Manage user accounts user \- Manage user accounts
......
.TH ANSIBLE.VIRT 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.VIRT 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/virt ." generated from library/virt
.SH NAME .SH NAME
virt \- Manages virtual machines supported by libvirt virt \- Manages virtual machines supported by libvirt
......
.TH ANSIBLE.WAIT_FOR 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.WAIT_FOR 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/wait_for ." generated from library/wait_for
.SH NAME .SH NAME
wait_for \- Waits for a given port to become accessible on a server. wait_for \- Waits for a given port to become accessible on a server.
......
.TH ANSIBLE.YUM 5 "2012-10-03" "0.8" "ANSIBLE MODULES" .TH ANSIBLE.YUM 3 "2012-10-08" "0.8" "ANSIBLE MODULES"
." generated from library/yum ." generated from library/yum
.SH NAME .SH NAME
yum \- Manages packages with the I(yum) package manager yum \- Manages packages with the I(yum) package manager
......
...@@ -25,9 +25,6 @@ clean: ...@@ -25,9 +25,6 @@ clean:
.PHONEY: docs clean .PHONEY: docs clean
#modules: $(FORMATTER) ../ansible/hacking/templates/rst.j2
# $(FORMATTER) -t rst --module-dir=../ansible/library -o rst/modules/
modules: $(FORMATTER) ../ansible/hacking/templates/rst.j2 modules: $(FORMATTER) ../ansible/hacking/templates/rst.j2
$(FORMATTER) -t rst --template-dir=../ansible/hacking/templates --module-dir=../ansible/library -o rst/modules/ --includes-file=rst/modules/_list.rst $(FORMATTER) -t rst --template-dir=../ansible/hacking/templates --module-dir=../ansible/library -o rst/modules/ --includes-file=rst/modules/_list.rst
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment