mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-31 09:01:23 -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.easy_install.3
Normal file
42
docs/man/man3/ansible.easy_install.3
Normal file
|
@ -0,0 +1,42 @@
|
|||
.TH ANSIBLE.EASY_INSTALL 5 "2012-10-02" "0.8" "ANSIBLE MODULES"
|
||||
." generated from library/easy_install
|
||||
.SH NAME
|
||||
easy_install \- Installs Python libraries
|
||||
." ------ DESCRIPTION
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
Installs Python libraries, optionally in a \fIvirtualenv\fR
|
||||
." ------ OPTIONS
|
||||
."
|
||||
."
|
||||
.SH OPTIONS
|
||||
|
||||
.IP virtualenv
|
||||
an optional \fIvirtualenv\fR directory path to install into. If the \fIvirtualenv\fR does not exist, it is created automatically
|
||||
.IP name
|
||||
A Python library name(required)."
|
||||
."
|
||||
." ------ NOTES
|
||||
.SH NOTES
|
||||
.PP
|
||||
Please note that the \fIeasy_install\fR module can only install Python libraries. Thus this module is not able to remove libraries. It is generally recommended to use the \fIpip\fR module which you can first install using \fIeasy_install\fR.
|
||||
.PP
|
||||
Also note that \fIvirtualenv\fR must be installed on the remote host if the \fCvirtualenv\fR parameter is specified.
|
||||
."
|
||||
."
|
||||
." ------ EXAMPLES
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
.nf
|
||||
easy_install name=pip
|
||||
.fi
|
||||
.PP
|
||||
.nf
|
||||
easy_install name=flask virtualenv=/webapps/myapp/venv
|
||||
.fi
|
||||
." ------- AUTHOR
|
||||
.SH AUTHOR
|
||||
Matt Wright
|
||||
.SH SEE ALSO
|
||||
.IR ansible (1),
|
||||
.I http://ansible.github.com/modules.html#easy-install
|
Loading…
Add table
Add a link
Reference in a new issue