From 4a95194424e207608eaa81a8e5c6c767ced4f044 Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Mon, 8 Oct 2012 08:09:27 -0400 Subject: [PATCH] Docs rebuild in new project structure. --- Makefile | 5 ++++- docs/man/man1/ansible.1 | 9 ++------- docs/man/man3/ansible.apt.3 | 2 +- docs/man/man3/ansible.apt_repository.3 | 2 +- docs/man/man3/ansible.assemble.3 | 2 +- docs/man/man3/ansible.async_status.3 | 2 +- docs/man/man3/ansible.authorized_key.3 | 2 +- docs/man/man3/ansible.command.3 | 2 +- docs/man/man3/ansible.copy.3 | 2 +- docs/man/man3/ansible.easy_install.3 | 2 +- docs/man/man3/ansible.facter.3 | 2 +- docs/man/man3/ansible.fail.3 | 8 +++++--- docs/man/man3/ansible.fetch.3 | 2 +- docs/man/man3/ansible.file.3 | 2 +- docs/man/man3/ansible.fireball.3 | 2 +- docs/man/man3/ansible.get_url.3 | 2 +- docs/man/man3/ansible.git.3 | 2 +- docs/man/man3/ansible.group.3 | 2 +- docs/man/man3/ansible.ini_file.3 | 2 +- docs/man/man3/ansible.lineinfile.3 | 18 +++++++++--------- docs/man/man3/ansible.mount.3 | 2 +- docs/man/man3/ansible.mysql_db.3 | 2 +- docs/man/man3/ansible.mysql_user.3 | 2 +- docs/man/man3/ansible.nagios.3 | 2 +- docs/man/man3/ansible.ohai.3 | 2 +- docs/man/man3/ansible.pause.3 | 2 +- docs/man/man3/ansible.ping.3 | 2 +- docs/man/man3/ansible.pip.3 | 2 +- docs/man/man3/ansible.postgresql_db.3 | 2 +- docs/man/man3/ansible.postgresql_user.3 | 2 +- docs/man/man3/ansible.raw.3 | 2 +- docs/man/man3/ansible.seboolean.3 | 2 +- docs/man/man3/ansible.selinux.3 | 2 +- docs/man/man3/ansible.service.3 | 2 +- docs/man/man3/ansible.setup.3 | 2 +- docs/man/man3/ansible.shell.3 | 4 ++-- docs/man/man3/ansible.slurp.3 | 2 +- docs/man/man3/ansible.subversion.3 | 2 +- docs/man/man3/ansible.supervisorctl.3 | 2 +- docs/man/man3/ansible.template.3 | 2 +- docs/man/man3/ansible.user.3 | 2 +- docs/man/man3/ansible.virt.3 | 2 +- docs/man/man3/ansible.wait_for.3 | 2 +- docs/man/man3/ansible.yum.3 | 2 +- docsite/Makefile | 3 --- 45 files changed, 61 insertions(+), 64 deletions(-) diff --git a/Makefile b/Makefile index 1173452fea..09272705ec 100644 --- a/Makefile +++ b/Makefile @@ -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) diff --git a/docs/man/man1/ansible.1 b/docs/man/man1/ansible.1 index 7dfb951913..dd5955a839 100644 --- a/docs/man/man1/ansible.1 +++ b/docs/man/man1/ansible.1 @@ -2,12 +2,12 @@ .\" Title: ansible .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" 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 diff --git a/docs/man/man3/ansible.apt.3 b/docs/man/man3/ansible.apt.3 index 2c54e34710..f2e6069872 100644 --- a/docs/man/man3/ansible.apt.3 +++ b/docs/man/man3/ansible.apt.3 @@ -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 diff --git a/docs/man/man3/ansible.apt_repository.3 b/docs/man/man3/ansible.apt_repository.3 index 72dca1e987..fe7fe09d54 100644 --- a/docs/man/man3/ansible.apt_repository.3 +++ b/docs/man/man3/ansible.apt_repository.3 @@ -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 diff --git a/docs/man/man3/ansible.assemble.3 b/docs/man/man3/ansible.assemble.3 index 6c49574114..d8d5b26295 100644 --- a/docs/man/man3/ansible.assemble.3 +++ b/docs/man/man3/ansible.assemble.3 @@ -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 diff --git a/docs/man/man3/ansible.async_status.3 b/docs/man/man3/ansible.async_status.3 index 1da8c88715..70e82f9d3e 100644 --- a/docs/man/man3/ansible.async_status.3 +++ b/docs/man/man3/ansible.async_status.3 @@ -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 diff --git a/docs/man/man3/ansible.authorized_key.3 b/docs/man/man3/ansible.authorized_key.3 index 9cea5981b4..7b16bccf0f 100644 --- a/docs/man/man3/ansible.authorized_key.3 +++ b/docs/man/man3/ansible.authorized_key.3 @@ -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 diff --git a/docs/man/man3/ansible.command.3 b/docs/man/man3/ansible.command.3 index c857d54169..34b4cf3f4f 100644 --- a/docs/man/man3/ansible.command.3 +++ b/docs/man/man3/ansible.command.3 @@ -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 diff --git a/docs/man/man3/ansible.copy.3 b/docs/man/man3/ansible.copy.3 index 14005a2bc7..ebe997d7cf 100644 --- a/docs/man/man3/ansible.copy.3 +++ b/docs/man/man3/ansible.copy.3 @@ -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. diff --git a/docs/man/man3/ansible.easy_install.3 b/docs/man/man3/ansible.easy_install.3 index 1aa31e9178..23e2825be1 100644 --- a/docs/man/man3/ansible.easy_install.3 +++ b/docs/man/man3/ansible.easy_install.3 @@ -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 diff --git a/docs/man/man3/ansible.facter.3 b/docs/man/man3/ansible.facter.3 index acfe540192..8d6191233f 100644 --- a/docs/man/man3/ansible.facter.3 +++ b/docs/man/man3/ansible.facter.3 @@ -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 diff --git a/docs/man/man3/ansible.fail.3 b/docs/man/man3/ansible.fail.3 index c648d92ae3..cec2da9000 100644 --- a/docs/man/man3/ansible.fail.3 +++ b/docs/man/man3/ansible.fail.3 @@ -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 diff --git a/docs/man/man3/ansible.fetch.3 b/docs/man/man3/ansible.fetch.3 index cf03d7a7d5..4d230692a7 100644 --- a/docs/man/man3/ansible.fetch.3 +++ b/docs/man/man3/ansible.fetch.3 @@ -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 diff --git a/docs/man/man3/ansible.file.3 b/docs/man/man3/ansible.file.3 index 8c4f366f48..37673239cb 100644 --- a/docs/man/man3/ansible.file.3 +++ b/docs/man/man3/ansible.file.3 @@ -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 diff --git a/docs/man/man3/ansible.fireball.3 b/docs/man/man3/ansible.fireball.3 index c3f7ea4f78..7c6293c98a 100644 --- a/docs/man/man3/ansible.fireball.3 +++ b/docs/man/man3/ansible.fireball.3 @@ -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 diff --git a/docs/man/man3/ansible.get_url.3 b/docs/man/man3/ansible.get_url.3 index ab778673fb..56cdbc8de6 100644 --- a/docs/man/man3/ansible.get_url.3 +++ b/docs/man/man3/ansible.get_url.3 @@ -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 diff --git a/docs/man/man3/ansible.git.3 b/docs/man/man3/ansible.git.3 index 2bc807dcfb..d0fa9df6f9 100644 --- a/docs/man/man3/ansible.git.3 +++ b/docs/man/man3/ansible.git.3 @@ -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 diff --git a/docs/man/man3/ansible.group.3 b/docs/man/man3/ansible.group.3 index 32b08f2ae2..7c8cd5bc56 100644 --- a/docs/man/man3/ansible.group.3 +++ b/docs/man/man3/ansible.group.3 @@ -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 diff --git a/docs/man/man3/ansible.ini_file.3 b/docs/man/man3/ansible.ini_file.3 index 5fe0ea61c7..ca850faae7 100644 --- a/docs/man/man3/ansible.ini_file.3 +++ b/docs/man/man3/ansible.ini_file.3 @@ -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 diff --git a/docs/man/man3/ansible.lineinfile.3 b/docs/man/man3/ansible.lineinfile.3 index 0ab9bdc3df..080d6b9d22 100644 --- a/docs/man/man3/ansible.lineinfile.3 +++ b/docs/man/man3/ansible.lineinfile.3 @@ -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 diff --git a/docs/man/man3/ansible.mount.3 b/docs/man/man3/ansible.mount.3 index 49b8219b55..c68aad997d 100644 --- a/docs/man/man3/ansible.mount.3 +++ b/docs/man/man3/ansible.mount.3 @@ -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 diff --git a/docs/man/man3/ansible.mysql_db.3 b/docs/man/man3/ansible.mysql_db.3 index 443730db89..6659e062df 100644 --- a/docs/man/man3/ansible.mysql_db.3 +++ b/docs/man/man3/ansible.mysql_db.3 @@ -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. diff --git a/docs/man/man3/ansible.mysql_user.3 b/docs/man/man3/ansible.mysql_user.3 index fc9a59a9aa..6a9bcfcf35 100644 --- a/docs/man/man3/ansible.mysql_user.3 +++ b/docs/man/man3/ansible.mysql_user.3 @@ -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. diff --git a/docs/man/man3/ansible.nagios.3 b/docs/man/man3/ansible.nagios.3 index 050168aaa2..d240ef53c6 100644 --- a/docs/man/man3/ansible.nagios.3 +++ b/docs/man/man3/ansible.nagios.3 @@ -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. diff --git a/docs/man/man3/ansible.ohai.3 b/docs/man/man3/ansible.ohai.3 index c2627fb9ab..b1194e2e81 100644 --- a/docs/man/man3/ansible.ohai.3 +++ b/docs/man/man3/ansible.ohai.3 @@ -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) diff --git a/docs/man/man3/ansible.pause.3 b/docs/man/man3/ansible.pause.3 index a57cb4e1b5..1d8f43f70c 100644 --- a/docs/man/man3/ansible.pause.3 +++ b/docs/man/man3/ansible.pause.3 @@ -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 diff --git a/docs/man/man3/ansible.ping.3 b/docs/man/man3/ansible.ping.3 index c309b2b042..3640f101ef 100644 --- a/docs/man/man3/ansible.ping.3 +++ b/docs/man/man3/ansible.ping.3 @@ -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. diff --git a/docs/man/man3/ansible.pip.3 b/docs/man/man3/ansible.pip.3 index 4496617de1..fe9a509551 100644 --- a/docs/man/man3/ansible.pip.3 +++ b/docs/man/man3/ansible.pip.3 @@ -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. diff --git a/docs/man/man3/ansible.postgresql_db.3 b/docs/man/man3/ansible.postgresql_db.3 index 66b9337a12..8dac895d54 100644 --- a/docs/man/man3/ansible.postgresql_db.3 +++ b/docs/man/man3/ansible.postgresql_db.3 @@ -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. diff --git a/docs/man/man3/ansible.postgresql_user.3 b/docs/man/man3/ansible.postgresql_user.3 index 61ae42ec08..1b9049157d 100644 --- a/docs/man/man3/ansible.postgresql_user.3 +++ b/docs/man/man3/ansible.postgresql_user.3 @@ -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. diff --git a/docs/man/man3/ansible.raw.3 b/docs/man/man3/ansible.raw.3 index 4263435c65..4da4a7dfc3 100644 --- a/docs/man/man3/ansible.raw.3 +++ b/docs/man/man3/ansible.raw.3 @@ -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 diff --git a/docs/man/man3/ansible.seboolean.3 b/docs/man/man3/ansible.seboolean.3 index 8e7a1e7d67..e1b672af5a 100644 --- a/docs/man/man3/ansible.seboolean.3 +++ b/docs/man/man3/ansible.seboolean.3 @@ -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. diff --git a/docs/man/man3/ansible.selinux.3 b/docs/man/man3/ansible.selinux.3 index ca219dc9c2..3a6dd7e686 100644 --- a/docs/man/man3/ansible.selinux.3 +++ b/docs/man/man3/ansible.selinux.3 @@ -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 diff --git a/docs/man/man3/ansible.service.3 b/docs/man/man3/ansible.service.3 index 5c666d14db..c708cead35 100644 --- a/docs/man/man3/ansible.service.3 +++ b/docs/man/man3/ansible.service.3 @@ -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. diff --git a/docs/man/man3/ansible.setup.3 b/docs/man/man3/ansible.setup.3 index 2c5ee24c97..942ae243a4 100644 --- a/docs/man/man3/ansible.setup.3 +++ b/docs/man/man3/ansible.setup.3 @@ -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 diff --git a/docs/man/man3/ansible.shell.3 b/docs/man/man3/ansible.shell.3 index 72a1d79be5..31f92a97b5 100644 --- a/docs/man/man3/ansible.shell.3 +++ b/docs/man/man3/ansible.shell.3 @@ -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 ." ." diff --git a/docs/man/man3/ansible.slurp.3 b/docs/man/man3/ansible.slurp.3 index 3d2240ea15..dfff3b9eee 100644 --- a/docs/man/man3/ansible.slurp.3 +++ b/docs/man/man3/ansible.slurp.3 @@ -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 diff --git a/docs/man/man3/ansible.subversion.3 b/docs/man/man3/ansible.subversion.3 index bcf720311b..dea3750902 100644 --- a/docs/man/man3/ansible.subversion.3 +++ b/docs/man/man3/ansible.subversion.3 @@ -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. diff --git a/docs/man/man3/ansible.supervisorctl.3 b/docs/man/man3/ansible.supervisorctl.3 index 83d9e9e74b..e9d303b9bc 100644 --- a/docs/man/man3/ansible.supervisorctl.3 +++ b/docs/man/man3/ansible.supervisorctl.3 @@ -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 diff --git a/docs/man/man3/ansible.template.3 b/docs/man/man3/ansible.template.3 index 34c295e00f..1d8b7ec10b 100644 --- a/docs/man/man3/ansible.template.3 +++ b/docs/man/man3/ansible.template.3 @@ -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. diff --git a/docs/man/man3/ansible.user.3 b/docs/man/man3/ansible.user.3 index fa84ba9158..21e28fcd0c 100644 --- a/docs/man/man3/ansible.user.3 +++ b/docs/man/man3/ansible.user.3 @@ -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 diff --git a/docs/man/man3/ansible.virt.3 b/docs/man/man3/ansible.virt.3 index 4be6708eb6..31d5e22c03 100644 --- a/docs/man/man3/ansible.virt.3 +++ b/docs/man/man3/ansible.virt.3 @@ -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 diff --git a/docs/man/man3/ansible.wait_for.3 b/docs/man/man3/ansible.wait_for.3 index 4b515d8353..29dbddaabe 100644 --- a/docs/man/man3/ansible.wait_for.3 +++ b/docs/man/man3/ansible.wait_for.3 @@ -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. diff --git a/docs/man/man3/ansible.yum.3 b/docs/man/man3/ansible.yum.3 index 47420440ac..d194d08ad7 100644 --- a/docs/man/man3/ansible.yum.3 +++ b/docs/man/man3/ansible.yum.3 @@ -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 diff --git a/docsite/Makefile b/docsite/Makefile index b204190be1..55096cb524 100644 --- a/docsite/Makefile +++ b/docsite/Makefile @@ -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