cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Docs rebuild in new project structure.

Browse source
This commit is contained in:
Michael DeHaan 2012-10-08 08:09:27 -04:00
parent dd727ecebf
commit 4a95194424
45 changed files with 61 additions and 64 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
Makefile
View file

@ -62,7 +62,7 @@ tests:
PYTHONPATH=./lib nosetests -d -v
# 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
# recently than %.1.asciidoc.
@ -162,3 +162,6 @@ deb: debian
modulepages:
hacking/module_formatter.py -A $(VERSION) -t man -o docs/man/man3/ --module-dir=library --template-dir=hacking/templates
docsite:
(cd docsite; make docs)

9
docs/man/man1/ansible.1
View file

@ -2,12 +2,12 @@
.\" Title: ansible
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 09/06/2012
.\" Date: 10/08/2012
.\" Manual: System administration commands
.\" Source: Ansible 0.8
.\" 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
.\" -----------------------------------------------------------------
@ -141,11 +141,6 @@ Sudo to
instead of root\&. Implies \-\-sudo\&.
.RE
.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
.RS 4
Connection type to use\&. Possible options are

2
docs/man/man3/ansible.apt.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
apt \- Manages apt-packages

2
docs/man/man3/ansible.apt_repository.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
apt_repository \- Manages apt repositores

2
docs/man/man3/ansible.assemble.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
assemble \- Assembles a configuration file from fragments

2
docs/man/man3/ansible.async_status.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
async_status \- Obtain status of asynchronous task

2
docs/man/man3/ansible.authorized_key.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
authorized_key \- Adds or removes an SSH authorized key

2
docs/man/man3/ansible.command.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
command \- Executes a command on a remote node

2
docs/man/man3/ansible.copy.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
copy \- Copies files to remote locations.

2
docs/man/man3/ansible.easy_install.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
easy_install \- Installs Python libraries

2
docs/man/man3/ansible.facter.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
facter \- Runs the discovery program I(facter) on the remote system

8
docs/man/man3/ansible.fail.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
fail \- Fail with custom message
@ -12,7 +12,7 @@ This module fails the progress with a custom message. It can be useful for baili
.SH OPTIONS
.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
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
.SH EXAMPLES
.PP
.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
." ------- AUTHOR
.SH AUTHOR

2
docs/man/man3/ansible.fetch.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
fetch \- Fetches a file from remote nodes

2
docs/man/man3/ansible.file.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
file \- Sets attributes of files

2
docs/man/man3/ansible.fireball.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
fireball \- Enable fireball mode on remote node

2
docs/man/man3/ansible.get_url.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
get_url \- Downloads files from HTTP, HTTPS, or FTP to node

2
docs/man/man3/ansible.git.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
git \- Deploy software (or files) from git checkouts

2
docs/man/man3/ansible.group.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
group \- Add or remove groups

2
docs/man/man3/ansible.ini_file.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
ini_file \- Tweak settings in INI files

18
docs/man/man3/ansible.lineinfile.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
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
."
.SH OPTIONS
.IP state
Whether the line should be there or not.
.IR Choices :
present,absent. (default: present)
.IP name
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 state
Whether the line should be there or not.
.IR Choices :
present,absent. (default: present)
.IP dest
The file to modify(required)
.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)
.IP line
@ -37,11 +37,11 @@ Create a backup file including the timestamp information so you can get the orig
.SH EXAMPLES
.PP
.nf
lineinfile name=/etc/selinux/config regexp=^SELINUX= line=SELINUX=disabled
lineinfile dest=/etc/selinux/config regexp=^SELINUX= line=SELINUX=disabled
.fi
.PP
.nf
lineinfile name=/etc/sudoers state=absent regexp="^%wheel"
lineinfile dest=/etc/sudoers state=absent regexp="^%wheel"
.fi
." ------- AUTHOR
.SH AUTHOR

2
docs/man/man3/ansible.mount.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
mount \- Control active and configured mount points

2
docs/man/man3/ansible.mysql_db.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
mysql_db \- Add or remove MySQL databases from a remote host.

2
docs/man/man3/ansible.mysql_user.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
mysql_user \- Adds or removes a user from a MySQL database.

2
docs/man/man3/ansible.nagios.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
nagios \- Perform common tasks in Nagios related to downtime and notifications.

2
docs/man/man3/ansible.ohai.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
ohai \- Returns inventory data from I(ohai)

2
docs/man/man3/ansible.pause.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
pause \- Pause playbook execution

2
docs/man/man3/ansible.ping.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
ping \- Try to connect to host and return pong on success.

2
docs/man/man3/ansible.pip.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
pip \- Manages Python library dependencies.

2
docs/man/man3/ansible.postgresql_db.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
postgresql_db \- Add or remove PostgreSQL databases from a remote host.

2
docs/man/man3/ansible.postgresql_user.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
postgresql_user \- Adds or removes a users (roles) from a PostgreSQL database.

2
docs/man/man3/ansible.raw.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
raw \- Executes a low-down and dirty SSH command

2
docs/man/man3/ansible.seboolean.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
seboolean \- Toggles SELinux booleans.

2
docs/man/man3/ansible.selinux.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
selinux \- Change policy and state of SELinux

2
docs/man/man3/ansible.service.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
service \- Manage services.

2
docs/man/man3/ansible.setup.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
setup \- Gathers facts about remote hosts

4
docs/man/man3/ansible.shell.3
View file

@ -1,11 +1,11 @@
.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
.SH NAME
shell \- Execute commands in nodes.
." ------ DESCRIPTION
.SH DESCRIPTION
.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
."
."

2
docs/man/man3/ansible.slurp.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
slurp \- Slurps a file from remote nodes

2
docs/man/man3/ansible.subversion.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
subversion \- Deploys a subversion repository.

2
docs/man/man3/ansible.supervisorctl.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
supervisorctl \- Manage the state of a program or group of programs running via Supervisord

2
docs/man/man3/ansible.template.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
template \- Templates a file out to a remote server.

2
docs/man/man3/ansible.user.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
user \- Manage user accounts

2
docs/man/man3/ansible.virt.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
virt \- Manages virtual machines supported by libvirt

2
docs/man/man3/ansible.wait_for.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
wait_for \- Waits for a given port to become accessible on a server.

2
docs/man/man3/ansible.yum.3
View file

@ -1,4 +1,4 @@
.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
.SH NAME
yum \- Manages packages with the I(yum) package manager

3
docsite/Makefile
View file

@ -25,9 +25,6 @@ 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
$(FORMATTER) -t rst --template-dir=../ansible/hacking/templates --module-dir=../ansible/library -o rst/modules/ --includes-file=rst/modules/_list.rst