mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-23 05:10: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
43
docs/man/man3/ansible.get_url.3
Normal file
43
docs/man/man3/ansible.get_url.3
Normal file
|
@ -0,0 +1,43 @@
|
|||
.TH ANSIBLE.GET_URL 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
|
||||
." generated from library/get_url
|
||||
.SH NAME
|
||||
get_url \- Downloads files from HTTP, HTTPS, or FTP to node
|
||||
." ------ DESCRIPTION
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Downloads files from HTTP, HTTPS, or FTP to the remote server. The remote server must have direct access to the remote resource.
|
||||
." ------ OPTIONS
|
||||
."
|
||||
."
|
||||
.SH OPTIONS
|
||||
|
||||
.IP url
|
||||
HTTP, HTTPS, or FTP URL(required)
|
||||
.IP dest
|
||||
absolute path of where to download the file to.If \fIdest\fR is a directory, the basename of the file on the remote server will be used. If a directory, \fIthirsty=yes\fR must also be set.(required)
|
||||
.IP thirsty
|
||||
if \fCyes\fR, will download the file every time and replace the file if the contents change. if \fCno\fR, the file will only be downloaded if the destination does not exist. Generally should be \fCyes\fR only for small local files. prior to 0.6, acts if \fCyes\fR by default.
|
||||
.IR Choices :
|
||||
yes,no. (default: no)(Added in Ansible version 0.7.)
|
||||
|
||||
.IP others
|
||||
all arguments accepted by the \fIfile\fR module also work here."
|
||||
."
|
||||
." ------ NOTES
|
||||
.SH NOTES
|
||||
.PP
|
||||
This module doesn't yet support configuration for proxies or passwords.
|
||||
."
|
||||
."
|
||||
." ------ EXAMPLES
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
.nf
|
||||
get_url url=http://example.com/path/file.conf dest=/etc/foo.conf mode=0440
|
||||
.fi
|
||||
." ------- AUTHOR
|
||||
.SH AUTHOR
|
||||
Jan-Piet Mens
|
||||
.SH SEE ALSO
|
||||
.IR ansible (1),
|
||||
.I http://ansible.github.com/modules.html#get-url
|
Loading…
Add table
Add a link
Reference in a new issue