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

'\" t
.\"     Title: ansible-doc
.\"    Author: :doctype:manpage
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 05/26/2014
.\"    Manual: System administration commands
.\"    Source: Ansible 1.7
.\"  Language: English
.\"
.TH "ANSIBLE\-DOC" "1" "05/26/2014" "Ansible 1\&.7" "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-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 is available in the documentation site: http://docs\&.ansible\&.com\&. IRC and mailing list info can be found in file CONTRIBUTING\&.md, available in: https://github\&.com/ansible/ansible
.SH "AUTHOR"
.PP
\fB:doctype:manpage\fR
.RS 4
Author.
.RE
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 12 years ago			`'\" t`
			`.\" Title: ansible-doc`
Update test strategies guide. 11 years ago			`.\" Author: :doctype:manpage`
			`.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>`
			`.\" Date: 05/26/2014`
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 12 years ago			`.\" Manual: System administration commands`
Update test strategies guide. 11 years ago			`.\" Source: Ansible 1.7`
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 12 years ago			`.\" Language: English`
			`.\"`
Update test strategies guide. 11 years ago			`.TH "ANSIBLE\-DOC" "1" "05/26/2014" "Ansible 1\&.7" "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 '`
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 12 years ago			`.\" -----------------------------------------------------------------`
			`.\" * 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. 12 years ago			`\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 12 years ago			`.sp`
Update test strategies guide. 11 years ago			`Extensive documentation is available in the documentation site: http://docs\&.ansible\&.com\&. IRC and mailing list info can be found in file CONTRIBUTING\&.md, available in: https://github\&.com/ansible/ansible`
			`.SH "AUTHOR"`
			`.PP`
			`\fB:doctype:manpage\fR`
			`.RS 4`
			`Author.`
			`.RE`