Mercurial > cpython-lru_cache-weakref

annotate Misc/python.man @ 33683:fda36af226fb legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update two URLs
author Andrew M. Kuchling <amk@amk.ca>
date Thu, 07 Oct 2004 12:23:12 +0000
parents 37c65a6b2ef7
children 3e6f56e8104a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19740
8e6e248dfdd8 Change the date field to use $Date$ so it won't be outrageously out of
Guido van Rossum <guido@python.org>
parents: 19739
diff changeset
1 .TH PYTHON "1" "$Date$"
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
2 .SH NAME
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
3 python \- an interpreted, interactive, object-oriented programming language
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
4 .SH SYNOPSIS
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
5 .B python
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
6 [
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
7 .B \-d
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
8 ]
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
9 [
19739
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
10 .B \-E
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
11 ]
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
12 [
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
13 .B \-h
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
14 ]
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
15 [
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
16 .B \-i
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
17 ]
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
18 [
33682
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
19 .B \-m
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
20 .I module-name
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
21 ]
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
22 [
6273
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
23 .B \-O
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
24 ]
19739
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
25 .br
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
26 [
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
27 .B -Q
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
28 .I argument
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
29 ]
6273
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
30 [
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
31 .B \-S
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
32 ]
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
33 [
7965
e8d0b87c8d6b Document -t flag.
Guido van Rossum <guido@python.org>
parents: 6273
diff changeset
34 .B \-t
e8d0b87c8d6b Document -t flag.
Guido van Rossum <guido@python.org>
parents: 6273
diff changeset
35 ]
e8d0b87c8d6b Document -t flag.
Guido van Rossum <guido@python.org>
parents: 6273
diff changeset
36 [
1601
57b9b77da21b Documented -u (unbuffered), undocumented -k (killprint)
Guido van Rossum <guido@python.org>
parents: 1559
diff changeset
37 .B \-u
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
38 ]
19739
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
39 .br
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
40 [
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
41 .B \-v
14602
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents: 14360
diff changeset
42 ]
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents: 14360
diff changeset
43 [
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents: 14360
diff changeset
44 .B \-V
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents: 14360
diff changeset
45 ]
15612
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
46 [
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
47 .B \-W
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
48 .I argument
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
49 ]
19739
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
50 [
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
51 .B \-x
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
52 ]
6273
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
53 .br
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
54 [
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
55 .B \-c
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
56 .I command
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
57 |
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
58 .I script
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
59 |
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
60 \-
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
61 ]
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
62 [
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
63 .I arguments
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
64 ]
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
65 .SH DESCRIPTION
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
66 Python is an interpreted, interactive, object-oriented programming
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
67 language that combines remarkable power with very clear syntax.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
68 For an introduction to programming in Python you are referred to the
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
69 Python Tutorial.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
70 The Python Library Reference documents built-in and standard types,
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
71 constants, functions and modules.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
72 Finally, the Python Reference Manual describes the syntax and
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
73 semantics of the core language in (perhaps too) much detail.
14360
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation
Guido van Rossum <guido@python.org>
parents: 13255
diff changeset
74 (These documents may be located via the
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation
Guido van Rossum <guido@python.org>
parents: 13255
diff changeset
75 .B "INTERNET RESOURCES"
11214
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
76 below; they may be installed on your system as well.)
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
77 .PP
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
78 Python's basic power can be extended with your own modules written in
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
79 C or C++.
3875
2838db83d0ed Got rid of all references to stdwin.
Guido van Rossum <guido@python.org>
parents: 2068
diff changeset
80 On most systems such modules may be dynamically loaded.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
81 Python is also adaptable as an extension language for existing
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
82 applications.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
83 See the internal documentation for hints.
17315
6be8bb4808e1 Mention pydoc in the man page
Andrew M. Kuchling <amk@amk.ca>
parents: 15612
diff changeset
84 .PP
6be8bb4808e1 Mention pydoc in the man page
Andrew M. Kuchling <amk@amk.ca>
parents: 15612
diff changeset
85 Documentation for installed Python modules and packages can be
6be8bb4808e1 Mention pydoc in the man page
Andrew M. Kuchling <amk@amk.ca>
parents: 15612
diff changeset
86 viewed by running the
6be8bb4808e1 Mention pydoc in the man page
Andrew M. Kuchling <amk@amk.ca>
parents: 15612
diff changeset
87 .B pydoc
6be8bb4808e1 Mention pydoc in the man page
Andrew M. Kuchling <amk@amk.ca>
parents: 15612
diff changeset
88 program.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
89 .SH COMMAND LINE OPTIONS
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
90 .TP
19739
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
91 .BI "\-c " command
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
92 Specify the command to execute (see next section).
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
93 This terminates the option list (following options are passed as
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
94 arguments to the command).
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
95 .TP
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
96 .B \-d
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
97 Turn on parser debugging output (for wizards only, depending on
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
98 compilation options).
1559
df0fb788c0c1 Fix weird messed up paragraphs
Guido van Rossum <guido@python.org>
parents: 1529
diff changeset
99 .TP
19739
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
100 .B \-E
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
101 Ignore environment variables like PYTHONPATH and PYTHONHOME that modify
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
102 the behavior of the interpreter.
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
103 .TP
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
104 .B \-h
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
105 Prints the usage for the interpreter executable and exits.
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
106 .TP
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
107 .B \-i
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
108 When a script is passed as first argument or the \fB\-c\fP option is
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
109 used, enter interactive mode after executing the script or the
1559
df0fb788c0c1 Fix weird messed up paragraphs
Guido van Rossum <guido@python.org>
parents: 1529
diff changeset
110 command. It does not read the $PYTHONSTARTUP file. This can be
df0fb788c0c1 Fix weird messed up paragraphs
Guido van Rossum <guido@python.org>
parents: 1529
diff changeset
111 useful to inspect global variables or a stack trace when a script
df0fb788c0c1 Fix weird messed up paragraphs
Guido van Rossum <guido@python.org>
parents: 1529
diff changeset
112 raises an exception.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
113 .TP
33682
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
114 .BI "\-m " module-name
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
115 Searches
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
116 .I sys.path
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
117 for the named module and runs the corresponding
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
118 .I .py
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
119 file as a script.
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
120 .TP
6273
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
121 .B \-O
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
122 Turn on basic optimizations. This changes the filename extension for
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
123 compiled (bytecode) files from
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
124 .I .pyc
11214
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
125 to \fI.pyo\fP. Given twice, causes docstrings to be discarded.
6273
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
126 .TP
19739
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
127 .BI "\-Q " argument
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
128 Division control; see PEP 238. The argument must be one of "old" (the
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
129 default, int/int and long/long return an int or long), "new" (new
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
130 division semantics, i.e. int/int and long/long returns a float),
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
131 "warn" (old division semantics with a warning for int/int and
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
132 long/long), or "warnall" (old division semantics with a warning for
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
133 all use of the division operator). For a use of "warnall", see the
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
134 Tools/scripts/fixdiv.py script.
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
135 .TP
6273
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
136 .B \-S
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
137 Disable the import of the module
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
138 .I site
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
139 and the site-dependent manipulations of
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
140 .I sys.path
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
141 that it entails.
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
142 .TP
7965
e8d0b87c8d6b Document -t flag.
Guido van Rossum <guido@python.org>
parents: 6273
diff changeset
143 .B \-t
e8d0b87c8d6b Document -t flag.
Guido van Rossum <guido@python.org>
parents: 6273
diff changeset
144 Issue a warning when a source file mixes tabs and spaces for
e8d0b87c8d6b Document -t flag.
Guido van Rossum <guido@python.org>
parents: 6273
diff changeset
145 indentation in a way that makes it depend on the worth of a tab
e8d0b87c8d6b Document -t flag.
Guido van Rossum <guido@python.org>
parents: 6273
diff changeset
146 expressed in spaces. Issue an error when the option is given twice.
e8d0b87c8d6b Document -t flag.
Guido van Rossum <guido@python.org>
parents: 6273
diff changeset
147 .TP
1601
57b9b77da21b Documented -u (unbuffered), undocumented -k (killprint)
Guido van Rossum <guido@python.org>
parents: 1559
diff changeset
148 .B \-u
24696
ba3038a27c1e Document that -u puts stdin, stdout, and stderr in binary mode.
Sjoerd Mullender <sjoerd@acm.org>
parents: 24401
diff changeset
149 Force stdin, stdout and stderr to be totally unbuffered. On systems
ba3038a27c1e Document that -u puts stdin, stdout, and stderr in binary mode.
Sjoerd Mullender <sjoerd@acm.org>
parents: 24401
diff changeset
150 where it matters, also put stdin, stdout and stderr in binary mode.
ba3038a27c1e Document that -u puts stdin, stdout, and stderr in binary mode.
Sjoerd Mullender <sjoerd@acm.org>
parents: 24401
diff changeset
151 Note that there is internal buffering in xreadlines(), readlines() and
ba3038a27c1e Document that -u puts stdin, stdout, and stderr in binary mode.
Sjoerd Mullender <sjoerd@acm.org>
parents: 24401
diff changeset
152 file-object iterators ("for line in sys.stdin") which is not
ba3038a27c1e Document that -u puts stdin, stdout, and stderr in binary mode.
Sjoerd Mullender <sjoerd@acm.org>
parents: 24401
diff changeset
153 influenced by this option. To work around this, you will want to use
ba3038a27c1e Document that -u puts stdin, stdout, and stderr in binary mode.
Sjoerd Mullender <sjoerd@acm.org>
parents: 24401
diff changeset
154 "sys.stdin.readline()" inside a "while 1:" loop.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
155 .TP
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
156 .B \-v
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
157 Print a message each time a module is initialized, showing the place
11214
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
158 (filename or built-in module) from which it is loaded. When given
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
159 twice, print a message for each file that is checked for when
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
160 searching for a module. Also provides information on module cleanup
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
161 at exit.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
162 .TP
14602
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents: 14360
diff changeset
163 .B \-V
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents: 14360
diff changeset
164 Prints the Python version number of the executable and exits.
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents: 14360
diff changeset
165 .TP
15612
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
166 .BI "\-W " argument
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
167 Warning control. Python sometimes prints warning message to
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
168 .IR sys.stderr .
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
169 A typical warning message has the following form:
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
170 .IB file ":" line ": " category ": " message.
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
171 By default, each warning is printed once for each source line where it
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
172 occurs. This option controls how often warnings are printed.
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
173 Multiple
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
174 .B \-W
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
175 options may be given; when a warning matches more than one
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
176 option, the action for the last matching option is performed.
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
177 Invalid
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
178 .B \-W
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
179 options are ignored (a warning message is printed about invalid
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
180 options when the first warning is issued). Warnings can also be
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
181 controlled from within a Python program using the
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
182 .I warnings
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
183 module.
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
184
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
185 The simplest form of
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
186 .I argument
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
187 is one of the following
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
188 .I action
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
189 strings (or a unique abbreviation):
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
190 .B ignore
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
191 to ignore all warnings;
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
192 .B default
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
193 to explicitly request the default behavior (printing each warning once
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
194 per source line);
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
195 .B all
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
196 to print a warning each time it occurs (this may generate many
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
197 messages if a warning is triggered repeatedly for the same source
18844
045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this
Fred Drake <fdrake@acm.org>
parents: 18808
diff changeset
198 line, such as inside a loop);
15612
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
199 .B module
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
200 to print each warning only only the first time it occurs in each
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
201 module;
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
202 .B once
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
203 to print each warning only the first time it occurs in the program; or
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
204 .B error
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
205 to raise an exception instead of printing a warning message.
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
206
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
207 The full form of
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
208 .I argument
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
209 is
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
210 .IB action : message : category : module : line.
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
211 Here,
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
212 .I action
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
213 is as explained above but only applies to messages that match the
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
214 remaining fields. Empty fields match all values; trailing empty
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
215 fields may be omitted. The
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
216 .I message
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
217 field matches the start of the warning message printed; this match is
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
218 case-insensitive. The
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
219 .I category
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
220 field matches the warning category. This must be a class name; the
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
221 match test whether the actual warning category of the message is a
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
222 subclass of the specified warning category. The full class name must
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
223 be given. The
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
224 .I module
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
225 field matches the (fully-qualified) module name; this match is
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
226 case-sensitive. The
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
227 .I line
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
228 field matches the line number, where zero matches all line numbers and
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
229 is thus equivalent to an omitted line number.
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
230 .TP
19739
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
231 .B \-x
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
232 Skip the first line of the source. This is intended for a DOS
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
233 specific hack only. Warning: the line numbers in error messages will
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
234 be off by one!
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
235 .SH INTERPRETER INTERFACE
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
236 The interpreter interface resembles that of the UNIX shell: when
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
237 called with standard input connected to a tty device, it prompts for
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
238 commands and executes them until an EOF is read; when called with a
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
239 file name argument or with a file as standard input, it reads and
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
240 executes a
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
241 .I script
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
242 from that file;
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
243 when called with
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
244 .B \-c
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
245 .I command,
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
246 it executes the Python statement(s) given as
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
247 .I command.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
248 Here
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
249 .I command
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
250 may contain multiple statements separated by newlines.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
251 Leading whitespace is significant in Python statements!
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
252 In non-interactive mode, the entire input is parsed befored it is
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
253 executed.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
254 .PP
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
255 If available, the script name and additional arguments thereafter are
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
256 passed to the script in the Python variable
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
257 .I sys.argv ,
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
258 which is a list of strings (you must first
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
259 .I import sys
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
260 to be able to access it).
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
261 If no script name is given,
14360
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation
Guido van Rossum <guido@python.org>
parents: 13255
diff changeset
262 .I sys.argv[0]
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation
Guido van Rossum <guido@python.org>
parents: 13255
diff changeset
263 is an empty string; if
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
264 .B \-c
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
265 is used,
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
266 .I sys.argv[0]
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
267 contains the string
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
268 .I '-c'.
3875
2838db83d0ed Got rid of all references to stdwin.
Guido van Rossum <guido@python.org>
parents: 2068
diff changeset
269 Note that options interpreted by the Python interpreter itself
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
270 are not placed in
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
271 .I sys.argv.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
272 .PP
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
273 In interactive mode, the primary prompt is `>>>'; the second prompt
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
274 (which appears when a command is not complete) is `...'.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
275 The prompts can be changed by assignment to
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
276 .I sys.ps1
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
277 or
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
278 .I sys.ps2.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
279 The interpreter quits when it reads an EOF at a prompt.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
280 When an unhandled exception occurs, a stack trace is printed and
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
281 control returns to the primary prompt; in non-interactive mode, the
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
282 interpreter exits after printing the stack trace.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
283 The interrupt signal raises the
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
284 .I Keyboard\%Interrupt
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
285 exception; other UNIX signals are not caught (except that SIGPIPE is
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
286 sometimes ignored, in favor of the
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
287 .I IOError
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
288 exception). Error messages are written to stderr.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
289 .SH FILES AND DIRECTORIES
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
290 These are subject to difference depending on local installation
11214
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
291 conventions; ${prefix} and ${exec_prefix} are installation-dependent
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
292 and should be interpreted as for GNU software; they may be the same.
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
293 The default for both is \fI/usr/local\fP.
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
294 .IP \fI${exec_prefix}/bin/python\fP
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
295 Recommended location of the interpreter.
11214
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
296 .PP
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
297 .I ${prefix}/lib/python<version>
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
298 .br
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
299 .I ${exec_prefix}/lib/python<version>
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
300 .RS
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
301 Recommended locations of the directories containing the standard
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
302 modules.
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
303 .RE
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
304 .PP
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
305 .I ${prefix}/include/python<version>
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
306 .br
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
307 .I ${exec_prefix}/include/python<version>
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
308 .RS
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
309 Recommended locations of the directories containing the include files
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
310 needed for developing Python extensions and embedding the
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
311 interpreter.
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
312 .RE
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
313 .IP \fI~/.pythonrc.py\fP
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
314 User-specific initialization file loaded by the \fIuser\fP module;
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
315 not used by default or by most applications.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
316 .SH ENVIRONMENT VARIABLES
6273
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
317 .IP PYTHONHOME
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
318 Change the location of the standard Python libraries. By default, the
11214
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
319 libraries are searched in ${prefix}/lib/python<version> and
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
320 ${exec_prefix}/lib/python<version>, where ${prefix} and ${exec_prefix}
6273
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
321 are installation-dependent directories, both defaulting to
11214
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
322 \fI/usr/local\fP. When $PYTHONHOME is set to a single directory, its value
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
323 replaces both ${prefix} and ${exec_prefix}. To specify different values
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
324 for these, set $PYTHONHOME to ${prefix}:${exec_prefix}.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
325 .IP PYTHONPATH
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
326 Augments the default search path for module files.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
327 The format is the same as the shell's $PATH: one or more directory
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
328 pathnames separated by colons.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
329 Non-existant directories are silently ignored.
6273
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
330 The default search path is installation dependent, but generally
11214
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
331 begins with ${prefix}/lib/python<version> (see PYTHONHOME above).
6273
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
332 The default search path is always appended to $PYTHONPATH.
3875
2838db83d0ed Got rid of all references to stdwin.
Guido van Rossum <guido@python.org>
parents: 2068
diff changeset
333 If a script argument is given, the directory containing the script is
2838db83d0ed Got rid of all references to stdwin.
Guido van Rossum <guido@python.org>
parents: 2068
diff changeset
334 inserted in the path in front of $PYTHONPATH.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
335 The search path can be manipulated from within a Python program as the
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
336 variable
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
337 .I sys.path .
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
338 .IP PYTHONSTARTUP
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
339 If this is the name of a readable file, the Python commands in that
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
340 file are executed before the first prompt is displayed in interactive
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
341 mode.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
342 The file is executed in the same name space where interactive commands
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
343 are executed so that objects defined or imported in it can be used
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
344 without qualification in the interactive session.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
345 You can also change the prompts
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
346 .I sys.ps1
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
347 and
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
348 .I sys.ps2
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
349 in this file.
18844
045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this
Fred Drake <fdrake@acm.org>
parents: 18808
diff changeset
350 .IP PYTHONY2K
045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this
Fred Drake <fdrake@acm.org>
parents: 18808
diff changeset
351 Set this to a non-empty string to cause the \fItime\fP module to
045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this
Fred Drake <fdrake@acm.org>
parents: 18808
diff changeset
352 require dates specified as strings to include 4-digit years, otherwise
045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this
Fred Drake <fdrake@acm.org>
parents: 18808
diff changeset
353 2-digit years are converted based on rules described in the \fItime\fP
23406
e0ed68adba33 Fix typo
Andrew M. Kuchling <amk@amk.ca>
parents: 20401
diff changeset
354 module documentation.
20401
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson.
Guido van Rossum <guido@python.org>
parents: 19740
diff changeset
355 .IP PYTHONOPTIMIZE
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson.
Guido van Rossum <guido@python.org>
parents: 19740
diff changeset
356 If this is set to a non-empty string it is equivalent to specifying
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson.
Guido van Rossum <guido@python.org>
parents: 19740
diff changeset
357 the \fB\-O\fP option. If set to an integer, it is equivalent to
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson.
Guido van Rossum <guido@python.org>
parents: 19740
diff changeset
358 specifying \fB\-O\fP multiple times.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
359 .IP PYTHONDEBUG
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
360 If this is set to a non-empty string it is equivalent to specifying
20401
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson.
Guido van Rossum <guido@python.org>
parents: 19740
diff changeset
361 the \fB\-d\fP option. If set to an integer, it is equivalent to
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson.
Guido van Rossum <guido@python.org>
parents: 19740
diff changeset
362 specifying \fB\-d\fP multiple times.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
363 .IP PYTHONINSPECT
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
364 If this is set to a non-empty string it is equivalent to specifying
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
365 the \fB\-i\fP option.
1601
57b9b77da21b Documented -u (unbuffered), undocumented -k (killprint)
Guido van Rossum <guido@python.org>
parents: 1559
diff changeset
366 .IP PYTHONUNBUFFERED
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
367 If this is set to a non-empty string it is equivalent to specifying
1601
57b9b77da21b Documented -u (unbuffered), undocumented -k (killprint)
Guido van Rossum <guido@python.org>
parents: 1559
diff changeset
368 the \fB\-u\fP option.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
369 .IP PYTHONVERBOSE
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
370 If this is set to a non-empty string it is equivalent to specifying
20401
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson.
Guido van Rossum <guido@python.org>
parents: 19740
diff changeset
371 the \fB\-v\fP option. If set to an integer, it is equivalent to
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson.
Guido van Rossum <guido@python.org>
parents: 19740
diff changeset
372 specifying \fB\-v\fP multiple times.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
373 .SH AUTHOR
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
374 .nf
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
375 Guido van Rossum
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
376 .PP
15612
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
377 E-mail: guido@python.org
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
378 .fi
6273
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
379 .PP
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
380 And a cast of thousands.
3875
2838db83d0ed Got rid of all references to stdwin.
Guido van Rossum <guido@python.org>
parents: 2068
diff changeset
381 .SH INTERNET RESOURCES
18844
045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this
Fred Drake <fdrake@acm.org>
parents: 18808
diff changeset
382 Main website: http://www.python.org/
14360
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation
Guido van Rossum <guido@python.org>
parents: 13255
diff changeset
383 .br
33683
fda36af226fb Update two URLs
Andrew M. Kuchling <amk@amk.ca>
parents: 33682
diff changeset
384 Documentation: http://docs.python.org/
3875
2838db83d0ed Got rid of all references to stdwin.
Guido van Rossum <guido@python.org>
parents: 2068
diff changeset
385 .br
18844
045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this
Fred Drake <fdrake@acm.org>
parents: 18808
diff changeset
386 Community website: http://starship.python.net/
14360
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation
Guido van Rossum <guido@python.org>
parents: 13255
diff changeset
387 .br
33683
fda36af226fb Update two URLs
Andrew M. Kuchling <amk@amk.ca>
parents: 33682
diff changeset
388 Developer resources: http://www.python.org/dev/
14360
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation
Guido van Rossum <guido@python.org>
parents: 13255
diff changeset
389 .br
18844
045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this
Fred Drake <fdrake@acm.org>
parents: 18808
diff changeset
390 FTP: ftp://ftp.python.org/pub/python/
14360
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation
Guido van Rossum <guido@python.org>
parents: 13255
diff changeset
391 .br
18844
045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this
Fred Drake <fdrake@acm.org>
parents: 18808
diff changeset
392 Module repository: http://www.vex.net/parnassus/
3875
2838db83d0ed Got rid of all references to stdwin.
Guido van Rossum <guido@python.org>
parents: 2068
diff changeset
393 .br
18844
045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this
Fred Drake <fdrake@acm.org>
parents: 18808
diff changeset
394 Newsgroups: comp.lang.python, comp.lang.python.announce
14360
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation
Guido van Rossum <guido@python.org>
parents: 13255
diff changeset
395 .SH LICENSING
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation
Guido van Rossum <guido@python.org>
parents: 13255
diff changeset
396 Python is distributed under an Open Source license. See the file
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation
Guido van Rossum <guido@python.org>
parents: 13255
diff changeset
397 "LICENSE" in the Python source distribution for information on terms &
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation
Guido van Rossum <guido@python.org>
parents: 13255
diff changeset
398 conditions for accessing and otherwise using Python and for a
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation
Guido van Rossum <guido@python.org>
parents: 13255
diff changeset
399 DISCLAIMER OF ALL WARRANTIES.