Skip to content

Commit 4c9be9d

Browse files
freddrakefreddrake
committed
Various updates, mostly to add information to the SEE ALSO and
INTERNET RESOURCES sections based on c.l.py comments.
1 parent 008edbf commit 4c9be9d

1 file changed

Lines changed: 64 additions & 21 deletions

File tree

‎Misc/python.man‎

Lines changed: 64 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ python \- an interpreted, interactive, object-oriented programming language
2424
[
2525
.B \-v
2626
]
27-
[
27+
.br
28+
[
2829
.B \-x
2930
]
3031
[
@@ -51,6 +52,9 @@ The Python Library Reference documents built-in and standard types,
5152
constants, functions and modules.
5253
Finally, the Python Reference Manual describes the syntax and
5354
semantics of the core language in (perhaps too) much detail.
55+
(Information on locating these documents is included in
56+
.B "SEE ALSO"
57+
below; they may be installed on your system as well.)
5458
.PP
5559
Python's basic power can be extended with your own modules written in
5660
C or C++.
@@ -75,8 +79,7 @@ raises an exception.
7579
Turn on basic optimizations. This changes the filename extension for
7680
compiled (bytecode) files from
7781
.I .pyc
78-
to
79-
.I pyo.
82+
to \fI.pyo\fP. Given twice, causes docstrings to be discarded.
8083
.TP
8184
.B \-S
8285
Disable the import of the module
@@ -95,7 +98,10 @@ Force stdin, stdout and stderr to be totally unbuffered.
9598
.TP
9699
.B \-v
97100
Print a message each time a module is initialized, showing the place
98-
(filename or built-in module) from which it is loaded.
101+
(filename or built-in module) from which it is loaded. When given
102+
twice, print a message for each file that is checked for when
103+
searching for a module. Also provides information on module cleanup
104+
at exit.
99105
.TP
100106
.B \-x
101107
Skip the first line of the source. This is intended for a DOS
@@ -104,7 +110,8 @@ be off by one!
104110
.TP
105111
.B \-X
106112
Make the standard exceptions strings instead of classes.
107-
Use for backward compatibility with old code only.
113+
Use for backward compatibility with old code only. This is not
114+
necessary for most uses of string exceptions.
108115
.TP
109116
.BI "\-c " command
110117
Specify the command to execute (see next section).
@@ -166,27 +173,47 @@ sometimes ignored, in favor of the
166173
exception). Error messages are written to stderr.
167174
.SH FILES AND DIRECTORIES
168175
These are subject to difference depending on local installation
169-
conventions:
170-
.IP /usr/local/bin/python
176+
conventions; ${prefix} and ${exec_prefix} are installation-dependent
177+
and should be interpreted as for GNU software; they may be the same.
178+
The default for both is \fI/usr/local\fP.
179+
.IP \fI${exec_prefix}/bin/python\fP
171180
Recommended location of the interpreter.
172-
.IP /usr/local/lib/python<version>
173-
Recommended location of the directory containing the standard modules.
181+
.PP
182+
.I ${prefix}/lib/python<version>
183+
.br
184+
.I ${exec_prefix}/lib/python<version>
185+
.RS
186+
Recommended locations of the directories containing the standard
187+
modules.
188+
.RE
189+
.PP
190+
.I ${prefix}/include/python<version>
191+
.br
192+
.I ${exec_prefix}/include/python<version>
193+
.RS
194+
Recommended locations of the directories containing the include files
195+
needed for developing Python extensions and embedding the
196+
interpreter.
197+
.RE
198+
.IP \fI~/.pythonrc.py\fP
199+
User-specific initialization file loaded by the \fIuser\fP module;
200+
not used by default or by most applications.
174201
.SH ENVIRONMENT VARIABLES
175202
.IP PYTHONHOME
176203
Change the location of the standard Python libraries. By default, the
177-
libraries are searched in <prefix>/lib/python<version> and
178-
<exec_prefix>/lib/python<version>, where <prefix> and <exec_prefix>
204+
libraries are searched in ${prefix}/lib/python<version> and
205+
${exec_prefix}/lib/python<version>, where ${prefix} and ${exec_prefix}
179206
are installation-dependent directories, both defaulting to
180-
/usr/local. When $PYTHONHOME is set to a single directory, its value
181-
replaces both <prefix> and <exec_prefix>. To specify different values
182-
for these, set $PYTHONHOME to <prefix>:<exec_prefix>.
207+
\fI/usr/local\fP. When $PYTHONHOME is set to a single directory, its value
208+
replaces both ${prefix} and ${exec_prefix}. To specify different values
209+
for these, set $PYTHONHOME to ${prefix}:${exec_prefix}.
183210
.IP PYTHONPATH
184211
Augments the default search path for module files.
185212
The format is the same as the shell's $PATH: one or more directory
186213
pathnames separated by colons.
187214
Non-existant directories are silently ignored.
188215
The default search path is installation dependent, but generally
189-
begins with <prefix>/lib/python<version> (see PYTHONHOME below).
216+
begins with ${prefix}/lib/python<version> (see PYTHONHOME above).
190217
The default search path is always appended to $PYTHONPATH.
191218
If a script argument is given, the directory containing the script is
192219
inserted in the path in front of $PYTHONPATH.
@@ -218,11 +245,19 @@ the \fB\-u\fP option.
218245
If this is set to a non-empty string it is equivalent to specifying
219246
the \fB\-v\fP option.
220247
.SH SEE ALSO
221-
Python Tutorial
222-
.br
223-
Python Library Reference
224-
.br
225-
Python Reference Manual
248+
.IP "Python Tutorial"
249+
URL: http://www.python.org/doc/tut/tut.html
250+
.IP "Python Library Reference"
251+
URL: http://www.python.org/doc/lib/lib.html
252+
.IP "Python Reference Manual"
253+
URL: http://www.python.org/doc/ref/ref.html
254+
.IP "Extending and Embedding the Python Interpreter"
255+
URL: http://www.python.org/doc/ext/ext.html
256+
.IP "Python/C API"
257+
URL: http://www.python.org/doc/api/api.html
258+
.PP
259+
Downloadable versions of these documents in many formats are available
260+
at the Python website; see \fB\INTERNET RESOURCES\fP below.
226261
.SH AUTHOR
227262
.nf
228263
Guido van Rossum
@@ -240,7 +275,15 @@ Web site: http://www.python.org
240275
.br
241276
FTP site: ftp://ftp.python.org
242277
.br
243-
Newsgroup: comp.lang.python
278+
Newsgroups: comp.lang.python, comp.lang.python.announce
279+
.PP
280+
There are many mirror sites; a current list is available at
281+
http://www.python.org/mirrors.html.
282+
.PP
283+
The \fI\Python Software Activity\fP provides many mailing lists which
284+
serve various special interests within the Python community;
285+
information on these special interest groups is available at
286+
http://www.python.org/sigs/.
244287
.SH COPYRIGHT
245288
Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
246289
The Netherlands.

0 commit comments

Comments
 (0)