... | ... |
@@ -62,7 +62,7 @@ tests: |
62 | 62 |
PYTHONPATH=./lib nosetests -d -v |
63 | 63 |
|
64 | 64 |
# To force a rebuild of the docs run 'touch VERSION && make docs' |
65 |
-docs: $(MANPAGES) modulepages |
|
65 |
+docs: $(MANPAGES) modulepages docsite |
|
66 | 66 |
|
67 | 67 |
# Regenerate %.1.asciidoc if %.1.asciidoc.in has been modified more |
68 | 68 |
# recently than %.1.asciidoc. |
... | ... |
@@ -162,3 +162,6 @@ deb: debian |
162 | 162 |
|
163 | 163 |
modulepages: |
164 | 164 |
hacking/module_formatter.py -A $(VERSION) -t man -o docs/man/man3/ --module-dir=library --template-dir=hacking/templates |
165 |
+ |
|
166 |
+docsite: |
|
167 |
+ (cd docsite; make docs) |
... | ... |
@@ -2,12 +2,12 @@ |
2 | 2 |
.\" Title: ansible |
3 | 3 |
.\" Author: [see the "AUTHOR" section] |
4 | 4 |
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> |
5 |
-.\" Date: 09/06/2012 |
|
5 |
+.\" Date: 10/08/2012 |
|
6 | 6 |
.\" Manual: System administration commands |
7 | 7 |
.\" Source: Ansible 0.8 |
8 | 8 |
.\" Language: English |
9 | 9 |
.\" |
10 |
-.TH "ANSIBLE" "1" "09/06/2012" "Ansible 0\&.8" "System administration commands" |
|
10 |
+.TH "ANSIBLE" "1" "10/08/2012" "Ansible 0\&.8" "System administration commands" |
|
11 | 11 |
.\" ----------------------------------------------------------------- |
12 | 12 |
.\" * set default formatting |
13 | 13 |
.\" ----------------------------------------------------------------- |
... | ... |
@@ -141,11 +141,6 @@ Sudo to |
141 | 141 |
instead of root\&. Implies \-\-sudo\&. |
142 | 142 |
.RE |
143 | 143 |
.PP |
144 |
-\fB\-\-private\-key=\fR\fIPRIVATE_KEY_FILE\fR |
|
145 |
-.RS 4 |
|
146 |
-Use this file to authenticate the connection\&. |
|
147 |
-.RE |
|
148 |
-.PP |
|
149 | 144 |
\fB\-c\fR \fICONNECTION\fR, \fB\-\-connection=\fR\fICONNECTION\fR |
150 | 145 |
.RS 4 |
151 | 146 |
Connection type to use\&. Possible options are |
... | ... |
@@ -1,4 +1,4 @@ |
1 |
-.TH ANSIBLE.FAIL 5 "2012-10-03" "0.8" "ANSIBLE MODULES" |
|
1 |
+.TH ANSIBLE.FAIL 3 "2012-10-08" "0.8" "ANSIBLE MODULES" |
|
2 | 2 |
." generated from library/fail |
3 | 3 |
.SH NAME |
4 | 4 |
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 | 12 |
.SH OPTIONS |
13 | 13 |
|
14 | 14 |
.IP msg |
15 |
-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) |
|
15 |
+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') |
|
16 | 16 |
.IP rc |
17 | 17 |
The return code of the failure. This is currently not used by Ansible, but might be used in the future. (default: 1)." |
18 | 18 |
." |
... | ... |
@@ -23,7 +23,9 @@ The return code of the failure. This is currently not used by Ansible, but might |
23 | 23 |
.SH EXAMPLES |
24 | 24 |
.PP |
25 | 25 |
.nf |
26 |
-[{'action': 'fail msg="The system may not be provisioned according to the CMDB status."', 'only_if': "'$cmdb_status' != 'to-be-staged'"}] |
|
26 |
+action: fail msg="The system may not be provisioned according to the CMDB status." rc=100 |
|
27 |
+only_if: "'$cmdb_status' != 'to-be-staged'" |
|
28 |
+ |
|
27 | 29 |
.fi |
28 | 30 |
." ------- AUTHOR |
29 | 31 |
.SH AUTHOR |
... | ... |
@@ -1,4 +1,4 @@ |
1 |
-.TH ANSIBLE.LINEINFILE 5 "2012-10-03" "0.8" "ANSIBLE MODULES" |
|
1 |
+.TH ANSIBLE.LINEINFILE 3 "2012-10-08" "0.8" "ANSIBLE MODULES" |
|
2 | 2 |
." generated from library/lineinfile |
3 | 3 |
.SH NAME |
4 | 4 |
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 | 13 |
." |
14 | 14 |
.SH OPTIONS |
15 | 15 |
|
16 |
+.IP insertafter |
|
17 |
+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. |
|
18 |
+.IR Choices : |
|
19 |
+BOF,EOF. (default: EOF) |
|
16 | 20 |
.IP state |
17 | 21 |
Whether the line should be there or not. |
18 | 22 |
.IR Choices : |
19 | 23 |
present,absent. (default: present) |
20 |
-.IP name |
|
24 |
+.IP dest |
|
21 | 25 |
The file to modify(required) |
22 |
-.IP insertafter |
|
23 |
-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. |
|
24 |
-.IR Choices : |
|
25 |
-BOF,EOF. (default: EOF) |
|
26 | 26 |
.IP regexp |
27 | 27 |
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) |
28 | 28 |
.IP line |
... | ... |
@@ -37,11 +37,11 @@ Create a backup file including the timestamp information so you can get the orig |
37 | 37 |
.SH EXAMPLES |
38 | 38 |
.PP |
39 | 39 |
.nf |
40 |
-lineinfile name=/etc/selinux/config regexp=^SELINUX= line=SELINUX=disabled |
|
40 |
+lineinfile dest=/etc/selinux/config regexp=^SELINUX= line=SELINUX=disabled |
|
41 | 41 |
.fi |
42 | 42 |
.PP |
43 | 43 |
.nf |
44 |
-lineinfile name=/etc/sudoers state=absent regexp="^%wheel" |
|
44 |
+lineinfile dest=/etc/sudoers state=absent regexp="^%wheel" |
|
45 | 45 |
.fi |
46 | 46 |
." ------- AUTHOR |
47 | 47 |
.SH AUTHOR |
... | ... |
@@ -1,4 +1,4 @@ |
1 |
-.TH ANSIBLE.POSTGRESQL_USER 5 "2012-10-03" "0.8" "ANSIBLE MODULES" |
|
1 |
+.TH ANSIBLE.POSTGRESQL_USER 3 "2012-10-08" "0.8" "ANSIBLE MODULES" |
|
2 | 2 |
." generated from library/postgresql_user |
3 | 3 |
.SH NAME |
4 | 4 |
postgresql_user \- Adds or removes a users (roles) from a PostgreSQL database. |
... | ... |
@@ -1,11 +1,11 @@ |
1 |
-.TH ANSIBLE.SHELL 5 "2012-10-03" "0.8" "ANSIBLE MODULES" |
|
1 |
+.TH ANSIBLE.SHELL 3 "2012-10-08" "0.8" "ANSIBLE MODULES" |
|
2 | 2 |
." generated from library/shell |
3 | 3 |
.SH NAME |
4 | 4 |
shell \- Execute commands in nodes. |
5 | 5 |
." ------ DESCRIPTION |
6 | 6 |
.SH DESCRIPTION |
7 | 7 |
.PP |
8 |
-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. |
|
8 |
+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. |
|
9 | 9 |
." ------ OPTIONS |
10 | 10 |
." |
11 | 11 |
." |
... | ... |
@@ -1,4 +1,4 @@ |
1 |
-.TH ANSIBLE.SUPERVISORCTL 5 "2012-10-03" "0.8" "ANSIBLE MODULES" |
|
1 |
+.TH ANSIBLE.SUPERVISORCTL 3 "2012-10-08" "0.8" "ANSIBLE MODULES" |
|
2 | 2 |
." generated from library/supervisorctl |
3 | 3 |
.SH NAME |
4 | 4 |
supervisorctl \- Manage the state of a program or group of programs running via Supervisord |
... | ... |
@@ -25,9 +25,6 @@ clean: |
25 | 25 |
|
26 | 26 |
.PHONEY: docs clean |
27 | 27 |
|
28 |
-#modules: $(FORMATTER) ../ansible/hacking/templates/rst.j2 |
|
29 |
-# $(FORMATTER) -t rst --module-dir=../ansible/library -o rst/modules/ |
|
30 |
- |
|
31 | 28 |
modules: $(FORMATTER) ../ansible/hacking/templates/rst.j2 |
32 | 29 |
$(FORMATTER) -t rst --template-dir=../ansible/hacking/templates --module-dir=../ansible/library -o rst/modules/ --includes-file=rst/modules/_list.rst |
33 | 30 |
|