mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 12: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
38
docs/man/man3/ansible.shell.3
Normal file
38
docs/man/man3/ansible.shell.3
Normal file
|
@ -0,0 +1,38 @@
|
|||
.TH ANSIBLE.SHELL 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
|
||||
." generated from library/shell
|
||||
.SH NAME
|
||||
shell \- Execute commands in nodes.
|
||||
." ------ DESCRIPTION
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
The shell module takes the command name followed by a list of arguments, space delimited. It is almost exactly like the \fIcommand\fR module but runs the command through the user's configured shell on the remote node.
|
||||
." ------ OPTIONS
|
||||
."
|
||||
."
|
||||
.SH OPTIONS
|
||||
|
||||
.IP creates
|
||||
a filename, when it already exists, this step will NOT be run
|
||||
.IP chdir
|
||||
cd into this directory before running the command (0.6 and later)
|
||||
.IP (free form)
|
||||
The command module takes a free form command to run."
|
||||
."
|
||||
." ------ NOTES
|
||||
.SH NOTES
|
||||
.PP
|
||||
If you want to execute a command securely and predicably, it may be better to use the \fIcommand\fR module instead. Best practices when writing playbooks will follow the trend of using \fIcommand\fR unless \fIshell\fR is explicitly required. When running ad-hoc commands, use your best judgement.
|
||||
."
|
||||
."
|
||||
." ------ EXAMPLES
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
.nf
|
||||
shell somescript.sh >> somelog.txt
|
||||
.fi
|
||||
." ------- AUTHOR
|
||||
.SH AUTHOR
|
||||
Michael DeHaan
|
||||
.SH SEE ALSO
|
||||
.IR ansible (1),
|
||||
.I http://ansible.github.com/modules.html#shell
|
Loading…
Add table
Add a link
Reference in a new issue