mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 21:00:22 -07:00
Library functions and modules should be in the 3 man page section. Also the files should end in '.3'
This commit is contained in:
parent
53d24ef002
commit
85fb7c6d4b
45 changed files with 10 additions and 8 deletions
31
docs/man/man3/ansible.setup.3
Normal file
31
docs/man/man3/ansible.setup.3
Normal file
|
@ -0,0 +1,31 @@
|
|||
.TH ANSIBLE.SETUP 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
|
||||
." generated from library/setup
|
||||
.SH NAME
|
||||
setup \- Gathers facts about remote hosts
|
||||
." ------ DESCRIPTION
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This module is automatically called by playbooks to gather useful variables about remote hosts that can be used in playbooks. It can also be executed directly by \fC/usr/bin/ansible\fR to check what variables are available to a host. Ansible provides many \fIfacts\fR about the system, automatically.
|
||||
." ------ OPTIONS
|
||||
."
|
||||
."
|
||||
."
|
||||
."
|
||||
." ------ NOTES
|
||||
.SH NOTES
|
||||
.PP
|
||||
More ansible facts will be added with successive releases. If \fIfacter\fR or \fIohai\fR are installed, variables from these programs will also be snapshotted into the JSON file for usage in templating. These variables are prefixed with \fCfacter_\fR and \fCohai_\fR so it's easy to tell their source. All variables are bubbled up to the caller. Using the ansible facts and choosing to not install \fIfacter\fR and \fIohai\fR means you can avoid Ruby-dependencies on your remote systems.
|
||||
."
|
||||
."
|
||||
." ------ EXAMPLES
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
.nf
|
||||
ansible all -m setup -tree /tmp/facts
|
||||
.fi
|
||||
." ------- AUTHOR
|
||||
.SH AUTHOR
|
||||
Michael DeHaan
|
||||
.SH SEE ALSO
|
||||
.IR ansible (1),
|
||||
.I http://ansible.github.com/modules.html#setup
|
Loading…
Add table
Add a link
Reference in a new issue