summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMichael DeHaan <michael.dehaan@gmail.com>2013-06-03 09:01:39 -0700
committerMichael DeHaan <michael.dehaan@gmail.com>2013-06-03 09:01:39 -0700
commitf0d7324e25fff307373d2d7cef67e063b79243ae (patch)
tree19776ea174f29754a424217ac93e47fa67d3257f /docs
parentfc0e4f738d12e454b70dec32f5d53a54d3cbce9d (diff)
parent355ab6983c0b9bbdd5ddb602f620c0cf7769ac54 (diff)
downloadansible-f0d7324e25fff307373d2d7cef67e063b79243ae.tar.gz
Merge pull request #3094 from sfromm/issue2464-redux
Updates to ansible-pull and ansible-pull docs
Diffstat (limited to 'docs')
-rw-r--r--docs/man/man1/ansible-pull.1.asciidoc.in21
1 files changed, 20 insertions, 1 deletions
diff --git a/docs/man/man1/ansible-pull.1.asciidoc.in b/docs/man/man1/ansible-pull.1.asciidoc.in
index 4d3147d550..19ed537dea 100644
--- a/docs/man/man1/ansible-pull.1.asciidoc.in
+++ b/docs/man/man1/ansible-pull.1.asciidoc.in
@@ -12,7 +12,7 @@ ansible-pull - set up a remote copy of ansible on each managed node
SYNOPSIS
--------
-ansible -d DEST -U URL [ -C CHECKOUT ]
+ansible -d DEST -U URL [ -C CHECKOUT ] [ -i INVENTORY ] [ <filename.yml> ]
DESCRIPTION
@@ -35,6 +35,17 @@ ansible-pull runs would be an excellent way to gather and analyze
remote logs from ansible-pull.
+OPTIONAL ARGUMENT
+-----------------
+
+*filename.yml*::
+
+The name of one the YAML format files to run as an ansible playbook. This can
+be a relative path within the git checkout. If not provided, ansible-pull
+will look for a playbook based on the host's fully-qualified domain name and
+finally a playbook named *local.yml*.
+
+
OPTIONS
-------
@@ -50,6 +61,14 @@ URL of git repository to clone.
Branch/Tag/Commit to checkout. Defaults to 'HEAD'.
+*-i* 'PATH', *--inventory=*'PATH'::
+
+The 'PATH' to the inventory hosts file. This can be a relative path within
+the git checkout.
+
+*--purge*::
+
+Purge the git checkout after the playbook is run.
AUTHOR