diff --git a/docs/man/man1/ansible.1 b/docs/man/man1/ansible.1 new file mode 100644 index 00000000000..7ff7233b0e5 --- /dev/null +++ b/docs/man/man1/ansible.1 @@ -0,0 +1,108 @@ +'\" t +.\" Title: ansible +.\" Author: [see the "AUTHOR" section] +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 02/24/2012 +.\" Manual: System administration commands +.\" Source: Ansible 0.0.1 +.\" Language: English +.\" +.TH "ANSIBLE" "1" "02/24/2012" "Ansible 0\&.0\&.1" "System administration commands" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +ansible \- run a command somewhere else +.SH "SYNOPSIS" +.sp +ansible [\-H hosts_path] [\-L library_path] [\-f forks] [\-n module_name] [\-a [args1 [args2 \&...]]] [\-p host_pattern] [\-u remote_user] +.SH "DESCRIPTION" +.sp +\fBAnsible\fR is an extra\-simple Python API for doing \*(Aqremote things\*(Aq over SSH\&. +.SH "OPTIONS" +.PP +\fB\-P\fR, \fB\-\-askpass\fR +.RS 4 +Ask the user to input the ssh password for connecting\&. +.RE +.PP +\fB\-H\fR, \fB\-\-host\-list\fR +.RS 4 +Path to hosts list\&. +.RE +.PP +\fB\-L\fR, \fB\-\-library\fR +.RS 4 +Path to module library\&. +.RE +.PP +\fB\-f\fR, \fB\-\-forks\fR +.RS 4 +Level of parallelism\&. Specify as an integer\&. +.RE +.PP +\fB\-n\fR, \fB\-\-name\fR +.RS 4 +Module name to execute\&. +.RE +.PP +\fB\-a\fR, \fB\-\-args\fR +.RS 4 +Arguments to module\&. +.RE +.PP +\fB\-p\fR, \fB\-\-pattern\fR +.RS 4 +Hostname pattern\&. Accepts shell\-like globs\&. +.RE +.PP +\fB\-r\fR, \fB\-\-run\-playbook\fR +.RS 4 +Playbook file to run\&. Replaces the +\fB\-n\fR +and +\fB\-a\fR +options\&. +.RE +.PP +\fB\-u\fR, \fB\-\-remote\-user\fR +.RS 4 +Remote user to connect as\&. Uses +\fIroot\fR +by default\&. +.RE +.SH "INVENTORY" +.sp +Ansible stores the hosts it can potentially operate on in an inventory file\&. The syntax is simple: one host per line\&. Organize your hosts into multiple groups by separating them into multiple inventory files\&. +.SH "FILES" +.sp +/etc/ansible/hosts \(em Default hosts file +.sp +/usr/share/ansible \(em Default module library +.SH "AUTHOR" +.sp +Ansible was originally written by Michael DeHaan\&. See the AUTHORS file for a complete list of contributors\&. +.SH "COPYRIGHT" +.sp +Copyright \(co 2012, Michael DeHaan +.sp +Ansible is released under the terms of the MIT license\&. +.SH "SEE ALSO" +.sp +Ansible home page: https://github\&.com/mpdehaan/ansible/