summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMichael DeHaan <michael@ansibleworks.com>2013-11-19 00:55:49 +0100
committerMichael DeHaan <michael@ansibleworks.com>2013-11-19 00:55:49 +0100
commitf7c3975f21a0ac1fa33005c3834eb919c70775ff (patch)
tree95b4e3ec50c2ea7c72c8092cbc5a8fea9c714b47 /docs
parentAdd a small disclaimer that the changelog is not 100% comprehensive :) (diff)
downloadansible-f7c3975f21a0ac1fa33005c3834eb919c70775ff.tar.xz
ansible-f7c3975f21a0ac1fa33005c3834eb919c70775ff.zip
Add version_added to all modules missing version_added information, the docs formatter will now
raise errors when omitted, updated changelog with new modules.
Diffstat (limited to 'docs')
-rw-r--r--docs/man/man1/ansible-playbook.116
-rw-r--r--docs/man/man1/ansible-pull.123
-rw-r--r--docs/man/man1/ansible.116
3 files changed, 39 insertions, 16 deletions
diff --git a/docs/man/man1/ansible-playbook.1 b/docs/man/man1/ansible-playbook.1
index 996d1c9448..c545ea4f9c 100644
--- a/docs/man/man1/ansible-playbook.1
+++ b/docs/man/man1/ansible-playbook.1
@@ -1,13 +1,13 @@
'\" t
.\" Title: ansible-playbook
-.\" Author: [see the "AUTHOR" section]
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 09/13/2013
+.\" Author: :doctype:manpage
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 11/18/2013
.\" Manual: System administration commands
.\" Source: Ansible 1.4
.\" Language: English
.\"
-.TH "ANSIBLE\-PLAYBOOK" "1" "09/13/2013" "Ansible 1\&.4" "System administration commands"
+.TH "ANSIBLE\-PLAYBOOK" "1" "11/18/2013" "Ansible 1\&.4" "System administration commands"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -122,7 +122,7 @@ Connection timeout to use when trying to talk to hosts, in
Force all plays to use sudo, even if not marked as such\&.
.RE
.PP
-\fB\-u\fR \fIUSERNAME\fR, \fB\-\-remote\-user=\fR\fIUSERNAME\fR
+\fB\-u\fR \fIUSERNAME\fR, \fB\-\-user=\fR\fIUSERNAME\fR
.RS 4
Use this remote user name on playbook steps that do not indicate a user name to run as\&.
.RE
@@ -171,3 +171,9 @@ Ansible is released under the terms of the GPLv3 License\&.
\fBansible\fR(1), \fBansible\-pull\fR(1), \fBansible\-doc\fR(1)
.sp
Extensive documentation as well as IRC and mailing list info is available on the ansible home page: https://ansible\&.github\&.com/
+.SH "AUTHOR"
+.PP
+\fB:doctype:manpage\fR
+.RS 4
+Author.
+.RE
diff --git a/docs/man/man1/ansible-pull.1 b/docs/man/man1/ansible-pull.1
index 10e9fd40f2..6ef143a8df 100644
--- a/docs/man/man1/ansible-pull.1
+++ b/docs/man/man1/ansible-pull.1
@@ -1,13 +1,13 @@
'\" t
.\" Title: ansible
-.\" Author: [see the "AUTHOR" section]
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 09/13/2013
+.\" Author: :doctype:manpage
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 11/18/2013
.\" Manual: System administration commands
.\" Source: Ansible 1.4
.\" Language: English
.\"
-.TH "ANSIBLE" "1" "09/13/2013" "Ansible 1\&.4" "System administration commands"
+.TH "ANSIBLE" "1" "11/18/2013" "Ansible 1\&.4" "System administration commands"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -45,14 +45,14 @@ This is useful both for extreme scale\-out as well as periodic remediation\&. Us
.PP
\fBfilename\&.yml\fR
.RS 4
-The name of one the YAML format files to run as an ansible playbook\&. This can be a relative path within the checkout\&. If not provided, ansible\-pull will look for a playbook based on the host\(cqs fully\-qualified domain name and finally a playbook named
+The name of one the YAML format files to run as an ansible playbook\&. This can be a relative path within the checkout\&. If not provided, ansible\-pull will look for a playbook based on the host\(cqs fully\-qualified domain name, on the host hostname and finally a playbook named
\fBlocal\&.yml\fR\&.
.RE
.SH "OPTIONS"
.PP
\fB\-d\fR \fIDEST\fR, \fB\-\-directory=\fR\fIDEST\fR
.RS 4
-Directory to checkout repository into\&.
+Directory to checkout repository into\&. If not provided, a subdirectory of ~/\&.ansible/pull/ will be used\&.
.RE
.PP
\fB\-U\fR \fIURL\fR, \fB\-\-url=\fR\fIURL\fR
@@ -65,6 +65,11 @@ URL of the playbook repository to checkout\&.
Branch/Tag/Commit to checkout\&. If not provided, uses default behavior of module used to check out playbook repository\&.
.RE
.PP
+\fB\-f\fR, \fB\-\-force\fR
+.RS 4
+Force running of playbook even if unable to update playbook repository\&. This can be useful, for example, to enforce run\-time state when a network connection may not always be up or possible\&.
+.RE
+.PP
\fB\-i\fR \fIPATH\fR, \fB\-\-inventory=\fR\fIPATH\fR
.RS 4
The
@@ -94,3 +99,9 @@ Ansible is released under the terms of the GPLv3 License\&.
\fBansible\fR(1), \fBansible\-playbook\fR(1), \fBansible\-doc\fR(1)
.sp
Extensive documentation as well as IRC and mailing list info is available on the ansible home page: https://ansible\&.github\&.com/
+.SH "AUTHOR"
+.PP
+\fB:doctype:manpage\fR
+.RS 4
+Author.
+.RE
diff --git a/docs/man/man1/ansible.1 b/docs/man/man1/ansible.1
index 5ca174e7f6..bf8d2701e4 100644
--- a/docs/man/man1/ansible.1
+++ b/docs/man/man1/ansible.1
@@ -1,13 +1,13 @@
'\" t
.\" Title: ansible
-.\" Author: [see the "AUTHOR" section]
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\" Date: 09/13/2013
+.\" Author: :doctype:manpage
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\" Date: 11/18/2013
.\" Manual: System administration commands
.\" Source: Ansible 1.4
.\" Language: English
.\"
-.TH "ANSIBLE" "1" "09/13/2013" "Ansible 1\&.4" "System administration commands"
+.TH "ANSIBLE" "1" "11/18/2013" "Ansible 1\&.4" "System administration commands"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -136,7 +136,7 @@ seconds\&. Requires
\fB\-B\fR\&.
.RE
.PP
-\fB\-u\fR \fIUSERNAME\fR, \fB\-\-remote\-user=\fR\fIUSERNAME\fR
+\fB\-u\fR \fIUSERNAME\fR, \fB\-\-user=\fR\fIUSERNAME\fR
.RS 4
Use this remote
\fIUSERNAME\fR
@@ -206,3 +206,9 @@ Ansible is released under the terms of the GPLv3 License\&.
\fBansible\-playbook\fR(1), \fBansible\-pull\fR(1), \fBansible\-doc\fR(1)
.sp
Extensive documentation as well as IRC and mailing list info is available on the ansible home page: https://ansible\&.github\&.com/
+.SH "AUTHOR"
+.PP
+\fB:doctype:manpage\fR
+.RS 4
+Author.
+.RE