forked from ansible/ansible
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add manpage for ansible-playbook, since it is a command. More detaile…
…d docs will remain on the web site.
- Loading branch information
Showing
6 changed files
with
135 additions
and
216 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
ansible-playbook(1) | ||
=================== | ||
:doctype:manpage | ||
:man source: Ansible | ||
:man version: 0.0.1 | ||
:man manual: System administration commands | ||
|
||
NAME | ||
---- | ||
ansible-playbook - run an ansible playbook | ||
|
||
|
||
SYNOPSIS | ||
-------- | ||
ansible-playbook <filename.yml> ... [options] | ||
|
||
|
||
DESCRIPTION | ||
----------- | ||
|
||
*Ansible playbooks* are a configuration and multinode deployment system. Ansible-playbook is the tool | ||
used to run them. See the project home page (link below) for more information. | ||
|
||
|
||
ARGUMENTS | ||
--------- | ||
|
||
*filename.yml*:: | ||
|
||
The names of one or more YAML format files to run as ansible playbooks. | ||
|
||
|
||
OPTIONS | ||
------- | ||
|
||
|
||
*-i*, *--inventory*:: | ||
|
||
Path to the inventory hosts file, which defaults to /etc/ansible/hosts. | ||
|
||
|
||
*-M*, *--module-path*:: | ||
|
||
Where to load modules from. The default is /usr/share/ansible | ||
|
||
|
||
*-f*, *--forks*:: | ||
|
||
Desired level of parallelism. Default 5. | ||
|
||
|
||
*-k*, *--ask-pass*:: | ||
|
||
Prompt for the SSH password instead of assuming key-based authentication with ssh-agent. | ||
|
||
|
||
ENVIRONMENT | ||
----------- | ||
|
||
The following environment variables may specified. | ||
|
||
ANSIBLE_HOSTS -- Override the default ansible hosts file | ||
|
||
ANSIBLE_LIBRARY -- Override the default ansible module library path | ||
|
||
|
||
AUTHOR | ||
------ | ||
|
||
Ansible was originally written by Michael DeHaan. See the AUTHORS file | ||
for a complete list of contributors. | ||
|
||
|
||
COPYRIGHT | ||
--------- | ||
|
||
Copyright © 2012, Michael DeHaan | ||
|
||
Ansible is released under the terms of the GPLv3 License. | ||
|
||
|
||
SEE ALSO | ||
-------- | ||
|
||
Extensive documentation as well as IRC and mailing list info | ||
is available on the ansible home page: <https://ansible.github.com/> | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.