mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-08-11 16:44: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
42
docs/man/man3/ansible.template.3
Normal file
42
docs/man/man3/ansible.template.3
Normal file
|
@ -0,0 +1,42 @@
|
|||
.TH ANSIBLE.TEMPLATE 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
|
||||
." generated from library/template
|
||||
.SH NAME
|
||||
template \- Templates a file out to a remote server.
|
||||
." ------ DESCRIPTION
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Templates are processed by the Jinja2 templating language (\fIhttp://jinja.pocoo.org/docs/\fR) - documentation on the template formatting can be found in the Template Designer Documentation (\fIhttp://jinja.pocoo.org/docs/templates/\fR).
|
||||
." ------ OPTIONS
|
||||
."
|
||||
."
|
||||
.SH OPTIONS
|
||||
|
||||
.IP dest
|
||||
Location to render the template to on the remote machine.(required)
|
||||
.IP src
|
||||
Path of a Jinja2 formatted template on the local server. This can be a relative or absolute path.(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)
|
||||
.IP others
|
||||
all arguments accepted by the \fIfile\fR module also work here."
|
||||
."
|
||||
." ------ NOTES
|
||||
.SH NOTES
|
||||
.PP
|
||||
Since Ansible version 0.9, templates are loaded with \fCtrim_blocks=True\fR.
|
||||
."
|
||||
."
|
||||
." ------ EXAMPLES
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
.nf
|
||||
template src=/mytemplates/foo.j2 dest=/etc/file.conf owner=bin group=wheel mode=0644
|
||||
.fi
|
||||
." ------- AUTHOR
|
||||
.SH AUTHOR
|
||||
Michael DeHaan
|
||||
.SH SEE ALSO
|
||||
.IR ansible (1),
|
||||
.I http://ansible.github.com/modules.html#template
|
Loading…
Add table
Add a link
Reference in a new issue