1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
<?xml version='1.0' encoding='ISO-8859-1'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!--
Process this file with an XSLT processor: `xsltproc \
-''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
manpages/docbook.xsl manpage.dbk'. A manual page
<package>.<section> will be generated. You may view the
manual page with: nroff -man <package>.<section> | less'. A
typical entry in a Makefile or Makefile.am is:
DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
manpages/docbook.xsl
XP=xsltproc -''-nonet
manpage.1: manpage.dbk
$(XP) $(DB2MAN) $<
The xsltproc binary is found in the xsltproc package. The
XSL files are in docbook-xsl. Please remember that if you
create the nroff version in one of the debian/rules file
targets (such as build), you will need to include xsltproc
and docbook-xsl in your Build-Depends control field.
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Jeff</firstname>">
<!ENTITY dhsurname "<surname>Licquia</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>November 17, 2007</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>licquia@debian.org</email>">
<!ENTITY dhusername "Jeff Licquia">
<!ENTITY dhucpackage "<refentrytitle>VIRTUALENV</refentrytitle>">
<!ENTITY dhpackage "virtualenv">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
]>
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<copyright>
<year>2007</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>create virtual Python instances</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg><option>--version</option></arg>
<arg><option>--help</option></arg>
<arg><option>--verbose</option></arg>
<arg><option>--quiet</option></arg>
<arg><option>--clear</option></arg>
<arg><option>--no-site-packages</option></arg>
<arg>destination-directory</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This manual page documents briefly the
<command>&dhpackage;</command>
command.</para>
<para>This manual page was written for the &debian; distribution
because the original program does not have a manual page.</para>
<para><command>&dhpackage;</command> creates virtual Python
executables, each of which can have its own set of installed
modules. Programs that require different versions of modules
or sets of modules that may be incompatible with others to be
installed on the same system without conflicts.</para>
<para>The result is a directory containing its own Python
executables (in DIR/bin/pythonVER and DIR/bin/python) and its
own module directory containing the standard library as
installed by the system. Additional modules may be installed
via setuptools, as invoked from the binary directory
(DIR/bin/easy_install). The system's site-packages directories
will be available, but can be overriden with locally-installed
modules.</para>
<para>In addition, a shell script called "activate" will be
installed in the bin directory. If sourced, this will cause
normal invokations of the Python executable to use the virtual
environment.</para>
<para>By running the &dhpackage; command explicitly under the
desired Python interpreter, the user can control which version
of Python is created in the virtual environment.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>These programs follow the usual &gnu; command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below.</para>
<variablelist>
<varlistentry>
<term><option>-h</option>
<option>--help</option>
</term>
<listitem>
<para>Show summary of options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--version</option>
</term>
<listitem>
<para>Show version of program.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option>
<option>--verbose</option>
</term>
<listitem>
<para>Be more verbose.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-q</option>
<option>--quiet</option>
</term>
<listitem>
<para>Be less verbose; suppress unimportant output.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--clear</option>
</term>
<listitem>
<para>Clear out a previously-created virtual Python instance
in this location before creating a new one.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<option>--no-site-packages</option>
</term>
<listitem>
<para>Don't give access to the global site-packages modules
to the virtual environment.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>The upstream documentation, stored in
/usr/share/doc/&dhpackage;.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>This manual page was written by &dhusername; &dhemail; for
the &debian; system (but may be used by others). Permission is
granted to copy, distribute and/or modify this document under
the terms of the &gnu; General Public License, Version 2 any
later version published by the Free Software Foundation.
</para>
<para>
On Debian systems, the complete text of the GNU General Public
License can be found in /usr/share/common-licenses/GPL.
</para>
</refsect1>
</refentry>
|
