summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorStephen Fromm <sfromm@gmail.com>2013-06-01 21:42:26 -0700
committerStephen Fromm <sfromm@gmail.com>2013-06-01 21:44:52 -0700
commita611027329315648e80c5207848b6a78846d2c1d (patch)
treed4107438fc495b4a8edba4cbc2f79f06ebb42e96 /docs
parent291fb9e9440a00ecb4ebd321efadaf47a3a60597 (diff)
downloadansible-a611027329315648e80c5207848b6a78846d2c1d.tar.gz
Update ansible-pull documentation
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