mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-24 13:50: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
39
docs/man/man3/ansible.slurp.3
Normal file
39
docs/man/man3/ansible.slurp.3
Normal file
|
@ -0,0 +1,39 @@
|
|||
.TH ANSIBLE.SLURP 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
|
||||
." generated from library/slurp
|
||||
.SH NAME
|
||||
slurp \- Slurps a file from remote nodes
|
||||
." ------ DESCRIPTION
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
This module works like \fIfetch\fR. It is used for fetching a base64- encoded blob containing the data in a remote file.
|
||||
." ------ OPTIONS
|
||||
."
|
||||
."
|
||||
.SH OPTIONS
|
||||
|
||||
.IP src
|
||||
The file on the remote system to fetch. This must be a file, not a directory.(required)."
|
||||
."
|
||||
." ------ NOTES
|
||||
.SH NOTES
|
||||
.PP
|
||||
See also: \fIfetch\fR
|
||||
."
|
||||
."
|
||||
." ------ EXAMPLES
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
.nf
|
||||
ansible host -m slurp -a 'src=/tmp/xx'
|
||||
host | success >> {
|
||||
"content": "aGVsbG8gQW5zaWJsZSB3b3JsZAo=",
|
||||
"encoding": "base64"
|
||||
}
|
||||
|
||||
.fi
|
||||
." ------- AUTHOR
|
||||
.SH AUTHOR
|
||||
Michael DeHaan
|
||||
.SH SEE ALSO
|
||||
.IR ansible (1),
|
||||
.I http://ansible.github.com/modules.html#slurp
|
Loading…
Add table
Add a link
Reference in a new issue