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.assemble.3
Normal file
39
docs/man/man3/ansible.assemble.3
Normal file
|
@ -0,0 +1,39 @@
|
|||
.TH ANSIBLE.ASSEMBLE 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
|
||||
." generated from library/assemble
|
||||
.SH NAME
|
||||
assemble \- Assembles a configuration file from fragments
|
||||
." ------ DESCRIPTION
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Assembles a configuration file from fragments. Often a particular program will take a single configuration file and does not support a \fCconf.d\fR style structure where it is easy to build up the configuration from multiple sources. Assemble will take a directory of files that have already been transferred to the system, and concatenate them together to produce a destination file. Files are assembled in string sorting order. Puppet calls this idea \fIfragments\fR.
|
||||
." ------ OPTIONS
|
||||
."
|
||||
."
|
||||
.SH OPTIONS
|
||||
|
||||
.IP dest
|
||||
A file to create using the concatenation of all of the source files.(required)
|
||||
.IP src
|
||||
An already existing directory full of source files.(required)
|
||||
.IP backup
|
||||
Create a backup file (if \fCyes\fR), 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
|
||||
."
|
||||
."
|
||||
." ------ EXAMPLES
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
.nf
|
||||
assemble src=/etc/someapp/fragments dest=/etc/someapp/someapp.conf
|
||||
.fi
|
||||
." ------- AUTHOR
|
||||
.SH AUTHOR
|
||||
Stephen Fromm
|
||||
.SH SEE ALSO
|
||||
.IR ansible (1),
|
||||
.I http://ansible.github.com/modules.html#assemble
|
Loading…
Add table
Add a link
Reference in a new issue