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
44
docs/man/man3/ansible.copy.3
Normal file
44
docs/man/man3/ansible.copy.3
Normal file
|
@ -0,0 +1,44 @@
|
|||
.TH ANSIBLE.COPY 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
|
||||
." generated from library/copy
|
||||
.SH NAME
|
||||
copy \- Copies files to remote locations.
|
||||
." ------ DESCRIPTION
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
The \fIcopy\fR module copies a file on the local box to remote locations.
|
||||
." ------ OPTIONS
|
||||
."
|
||||
."
|
||||
.SH OPTIONS
|
||||
|
||||
.IP dest
|
||||
Remote absolute path where the file should be copied to.(required)
|
||||
.IP src
|
||||
Local path to a file to copy to the remote server; can be absolute or relative.(required)
|
||||
.IP backup
|
||||
Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
|
||||
.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
|
||||
."
|
||||
."
|
||||
." ------ EXAMPLES
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
.nf
|
||||
copy src=/srv/myfiles/foo.conf dest=/etc/foo.conf owner=foo group=foo mode=0644
|
||||
.fi
|
||||
.PP
|
||||
.nf
|
||||
copy src=/mine/ntp.conf dest=/etc/ntp.conf owner=root group=root mode=644 backup=yes
|
||||
.fi
|
||||
." ------- AUTHOR
|
||||
.SH AUTHOR
|
||||
Michael DeHaan
|
||||
.SH SEE ALSO
|
||||
.IR ansible (1),
|
||||
.I http://ansible.github.com/modules.html#copy
|
Loading…
Add table
Add a link
Reference in a new issue