ansible/docs/man/man1/ansible-doc.1

'\" t
.\"     Title: ansible-doc
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 10/26/2013
.\"    Manual: System administration commands
.\"    Source: Ansible 1.4
.\"  Language: English
.\"
.TH "ANSIBLE\-DOC" "1" "10/26/2013" "Ansible 1\&.4" "System administration commands"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ansible-doc \- show documentation on Ansible modules
.SH "SYNOPSIS"
.sp
ansible\-doc [\-M module_path] [\-l] [\-s] [module\&...]
.SH "DESCRIPTION"
.sp
\fBansible\-doc\fR displays information on modules installed in Ansible libraries\&. It displays a terse listing of modules and their short descriptions, provides a printout of their DOCUMENTATION strings, and it can create a short "snippet" which can be pasted into a playbook\&.
.SH "OPTIONS"
.PP
\fB\-M\fR \fIdirectory\fR, \fB\-\-module\-path=\fR\fIdirectory\fR
.RS 4
Add an additional directory to the default path for finding module libraries\&.
.RE
.PP
\fB\-s\fR, \fB\-\-snippet=\fR
.RS 4
Produce a snippet which can be copied into a playbook for modification, like a kind of task template\&.
.RE
.PP
\fB\-l\fR, \fB\-\-list=\fR
.RS 4
Produce a terse listing of modules and a short description of each\&.
.RE
.SH "AUTHOR"
.sp
ansible\-doc was originally written by Jan\-Piet Mens\&. See the AUTHORS file for a complete list of contributors\&.
.SH "COPYRIGHT"
.sp
Copyright \(co 2012, Jan\-Piet Mens
.sp
Ansible is released under the terms of the GPLv3 License\&.
.SH "SEE ALSO"
.sp
\fBansible\-playbook\fR(1), \fBansible\fR(1), \fBansible\-pull\fR(1)
.sp
Extensive documentation as well as IRC and mailing list info is available on the ansible home page: https://ansible\&.github\&.com/
CLI: ansible-doc shows lists of modules & module docs on command-line check path is directory added manpage & setup small cleanup shut up module_formatter in utils to avoid trace print on crud files in library 2012-11-28 09:39:26 +01:00			`'\" t`
			`.\" Title: ansible-doc`
Fix up some version related things on the devel branch. 2013-02-02 03:38:21 +01:00			`.\" Author: [see the "AUTHOR" section]`
Add module utils path to setup.py 2013-10-26 21:00:59 +02:00			`.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>`
			`.\" Date: 10/26/2013`
CLI: ansible-doc shows lists of modules & module docs on command-line check path is directory added manpage & setup small cleanup shut up module_formatter in utils to avoid trace print on crud files in library 2012-11-28 09:39:26 +01:00			`.\" Manual: System administration commands`
Adding sshpass as packaging requirement and fixing VERSION 2013-09-14 00:39:14 +02:00			`.\" Source: Ansible 1.4`
CLI: ansible-doc shows lists of modules & module docs on command-line check path is directory added manpage & setup small cleanup shut up module_formatter in utils to avoid trace print on crud files in library 2012-11-28 09:39:26 +01:00			`.\" Language: English`
			`.\"`
Add module utils path to setup.py 2013-10-26 21:00:59 +02:00			`.TH "ANSIBLE\-DOC" "1" "10/26/2013" "Ansible 1\&.4" "System administration commands"`
CLI: ansible-doc shows lists of modules & module docs on command-line check path is directory added manpage & setup small cleanup shut up module_formatter in utils to avoid trace print on crud files in library 2012-11-28 09:39:26 +01:00			`.\" -----------------------------------------------------------------`
			`.\" * set default formatting`
			`.\" -----------------------------------------------------------------`
			`.\" disable hyphenation`
			`.nh`
			`.\" disable justification (adjust text to left margin only)`
			`.ad l`
			`.\" -----------------------------------------------------------------`
			`.\" * MAIN CONTENT STARTS HERE *`
			`.\" -----------------------------------------------------------------`
			`.SH "NAME"`
			`ansible-doc \- show documentation on Ansible modules`
			`.SH "SYNOPSIS"`
			`.sp`
			`ansible\-doc [\-M module_path] [\-l] [\-s] [module\&...]`
			`.SH "DESCRIPTION"`
			`.sp`
			`\fBansible\-doc\fR displays information on modules installed in Ansible libraries\&. It displays a terse listing of modules and their short descriptions, provides a printout of their DOCUMENTATION strings, and it can create a short "snippet" which can be pasted into a playbook\&.`
			`.SH "OPTIONS"`
			`.PP`
			`\fB\-M\fR \fIdirectory\fR, \fB\-\-module\-path=\fR\fIdirectory\fR`
			`.RS 4`
			`Add an additional directory to the default path for finding module libraries\&.`
			`.RE`
			`.PP`
			`\fB\-s\fR, \fB\-\-snippet=\fR`
			`.RS 4`
			`Produce a snippet which can be copied into a playbook for modification, like a kind of task template\&.`
			`.RE`
			`.PP`
			`\fB\-l\fR, \fB\-\-list=\fR`
			`.RS 4`
			`Produce a terse listing of modules and a short description of each\&.`
			`.RE`
			`.SH "AUTHOR"`
			`.sp`
			`ansible\-doc was originally written by Jan\-Piet Mens\&. See the AUTHORS file for a complete list of contributors\&.`
			`.SH "COPYRIGHT"`
			`.sp`
			`Copyright \(co 2012, Jan\-Piet Mens`
			`.sp`
			`Ansible is released under the terms of the GPLv3 License\&.`
			`.SH "SEE ALSO"`
			`.sp`
Update release version. 2013-04-03 02:47:57 +02:00			`\fBansible\-playbook\fR(1), \fBansible\fR(1), \fBansible\-pull\fR(1)`
CLI: ansible-doc shows lists of modules & module docs on command-line check path is directory added manpage & setup small cleanup shut up module_formatter in utils to avoid trace print on crud files in library 2012-11-28 09:39:26 +01:00			`.sp`
			`Extensive documentation as well as IRC and mailing list info is available on the ansible home page: https://ansible\&.github\&.com/`