Mercurial > cpython-lru_cache-weakref

annotate Misc/python.man @ 70817:dd775b1561ba

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix markup.
author Georg Brandl <georg@python.org>
date Tue, 14 Jun 2011 21:09:55 +0200
parents e2f71bc9b0db
children 599763461943
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$"
33685
9a38625fa2b0 Add helpful comment
Andrew M. Kuchling <amk@amk.ca>
parents: 33684
diff changeset
2
52363
daf661d05442 Merged revisions 70518,70521,70590,70594-70595 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 51805
diff changeset
3 .\" To view this file while editing, run it through groff:
daf661d05442 Merged revisions 70518,70521,70590,70594-70595 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 51805
diff changeset
4 .\" groff -Tascii -man python.man | less
33685
9a38625fa2b0 Add helpful comment
Andrew M. Kuchling <amk@amk.ca>
parents: 33684
diff changeset
5
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
6 .SH NAME
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
7 python \- an interpreted, interactive, object-oriented programming language
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
8 .SH SYNOPSIS
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
9 .B python
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
10 [
58612
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
11 .B \-B
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
12 ]
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
13 [
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
14 .B \-d
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
15 ]
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
16 [
19739
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
17 .B \-E
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
18 ]
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
19 [
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
20 .B \-h
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
21 ]
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
22 [
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
23 .B \-i
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
24 ]
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
25 [
33682
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
26 .B \-m
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
27 .I module-name
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
28 ]
66687
f35a6d7e325f #1772833: add -q command line option.
Georg Brandl <georg@python.org>
parents: 65271
diff changeset
29 [
f35a6d7e325f #1772833: add -q command line option.
Georg Brandl <georg@python.org>
parents: 65271
diff changeset
30 .B \-q
f35a6d7e325f #1772833: add -q command line option.
Georg Brandl <georg@python.org>
parents: 65271
diff changeset
31 ]
58612
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
32 .br
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
33 [
6273
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
34 .B \-O
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
35 ]
58612
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
36 [
69733
c57fdce01eb8 #11971: fix man page; it's -OO not -O0
R David Murray <rdmurray@bitdance.com>
parents: 65273
diff changeset
37 .B \-OO
58612
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
38 ]
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
39 [
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
40 .B \-s
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
41 ]
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
42 [
6273
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
43 .B \-S
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
44 ]
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
45 [
1601
57b9b77da21b Documented -u (unbuffered), undocumented -k (killprint)
Guido van Rossum <guido@python.org>
parents: 1559
diff changeset
46 .B \-u
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
47 ]
19739
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
48 .br
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
49 [
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
50 .B \-v
14602
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents: 14360
diff changeset
51 ]
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents: 14360
diff changeset
52 [
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents: 14360
diff changeset
53 .B \-V
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents: 14360
diff changeset
54 ]
15612
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
55 [
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
56 .B \-W
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
57 .I argument
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
58 ]
19739
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
59 [
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
60 .B \-x
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
61 ]
58612
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
62 [
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
63 .B \-?
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
64 ]
6273
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
65 .br
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
66 [
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
67 .B \-c
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
68 .I command
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
69 |
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
70 .I script
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
71 |
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
72 \-
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
73 ]
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
74 [
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
75 .I arguments
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
76 ]
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
77 .SH DESCRIPTION
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
78 Python is an interpreted, interactive, object-oriented programming
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
79 language that combines remarkable power with very clear syntax.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
80 For an introduction to programming in Python you are referred to the
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
81 Python Tutorial.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
82 The Python Library Reference documents built-in and standard types,
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
83 constants, functions and modules.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
84 Finally, the Python Reference Manual describes the syntax and
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
85 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
86 (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
87 .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
88 below; they may be installed on your system as well.)
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
89 .PP
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
90 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
91 C or C++.
3875
2838db83d0ed Got rid of all references to stdwin.
Guido van Rossum <guido@python.org>
parents: 2068
diff changeset
92 On most systems such modules may be dynamically loaded.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
93 Python is also adaptable as an extension language for existing
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
94 applications.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
95 See the internal documentation for hints.
17315
6be8bb4808e1 Mention pydoc in the man page
Andrew M. Kuchling <amk@amk.ca>
parents: 15612
diff changeset
96 .PP
6be8bb4808e1 Mention pydoc in the man page
Andrew M. Kuchling <amk@amk.ca>
parents: 15612
diff changeset
97 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
98 viewed by running the
6be8bb4808e1 Mention pydoc in the man page
Andrew M. Kuchling <amk@amk.ca>
parents: 15612
diff changeset
99 .B pydoc
6be8bb4808e1 Mention pydoc in the man page
Andrew M. Kuchling <amk@amk.ca>
parents: 15612
diff changeset
100 program.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
101 .SH COMMAND LINE OPTIONS
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
102 .TP
58612
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
103 .B \-B
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
104 Don't write
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
105 .I .py[co]
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
106 files on import. See also PYTHONDONTWRITEBYTECODE.
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
107 .TP
19739
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
108 .BI "\-c " command
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
109 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
110 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
111 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
112 .TP
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
113 .B \-d
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
114 Turn on parser debugging output (for wizards only, depending on
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
115 compilation options).
1559
df0fb788c0c1 Fix weird messed up paragraphs
Guido van Rossum <guido@python.org>
parents: 1529
diff changeset
116 .TP
19739
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
117 .B \-E
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
118 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
119 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
120 .TP
58612
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
121 .B \-h ", " \-? ", "\-\-help
19739
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
122 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
123 .TP
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
124 .B \-i
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
125 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
126 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
127 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
128 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
129 raises an exception.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
130 .TP
33682
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
131 .BI "\-m " module-name
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
132 Searches
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
133 .I sys.path
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
134 for the named module and runs the corresponding
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
135 .I .py
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
136 file as a script.
37c65a6b2ef7 Add -m to man page
Andrew M. Kuchling <amk@amk.ca>
parents: 29264
diff changeset
137 .TP
6273
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
138 .B \-O
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
139 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
140 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
141 .I .pyc
11214
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
142 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
143 .TP
69733
c57fdce01eb8 #11971: fix man page; it's -OO not -O0
R David Murray <rdmurray@bitdance.com>
parents: 65273
diff changeset
144 .B \-OO
58612
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
145 Discard docstrings in addition to the \fB-O\fP optimizations.
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
146 .TP
66687
f35a6d7e325f #1772833: add -q command line option.
Georg Brandl <georg@python.org>
parents: 65271
diff changeset
147 .B \-q
f35a6d7e325f #1772833: add -q command line option.
Georg Brandl <georg@python.org>
parents: 65271
diff changeset
148 Do not print the version and copyright messages. These messages are
f35a6d7e325f #1772833: add -q command line option.
Georg Brandl <georg@python.org>
parents: 65271
diff changeset
149 also suppressed in non-interactive mode.
f35a6d7e325f #1772833: add -q command line option.
Georg Brandl <georg@python.org>
parents: 65271
diff changeset
150 .TP
58612
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
151 .B \-s
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
152 Don't add user site directory to sys.path.
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
153 .TP
6273
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
154 .B \-S
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
155 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
156 .I site
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
157 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
158 .I sys.path
68859
a364719e400a Do not touch sys.path when site is imported and python was started with -S.
Éric Araujo <merwok@netwok.org>
parents: 68257
diff changeset
159 that it entails. Also disable these manipulations if
a364719e400a Do not touch sys.path when site is imported and python was started with -S.
Éric Araujo <merwok@netwok.org>
parents: 68257
diff changeset
160 .I site
a364719e400a Do not touch sys.path when site is imported and python was started with -S.
Éric Araujo <merwok@netwok.org>
parents: 68257
diff changeset
161 is explicitly imported later.
6273
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
162 .TP
1601
57b9b77da21b Documented -u (unbuffered), undocumented -k (killprint)
Guido van Rossum <guido@python.org>
parents: 1559
diff changeset
163 .B \-u
65111
a4c9746cb03c Merged revisions 78959,79170,79175,79177,79180,79183,79186,79193,79581 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58612
diff changeset
164 Force the binary I/O layers of stdin, stdout and stderr to be unbuffered.
a4c9746cb03c Merged revisions 78959,79170,79175,79177,79180,79183,79186,79193,79581 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58612
diff changeset
165 The text I/O layer will still be line-buffered.
a4c9746cb03c Merged revisions 78959,79170,79175,79177,79180,79183,79186,79193,79581 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58612
diff changeset
166 .\" Note that there is internal buffering in readlines() and
a4c9746cb03c Merged revisions 78959,79170,79175,79177,79180,79183,79186,79193,79581 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58612
diff changeset
167 .\" file-object iterators ("for line in sys.stdin") which is not
a4c9746cb03c Merged revisions 78959,79170,79175,79177,79180,79183,79186,79193,79581 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58612
diff changeset
168 .\" influenced by this option. To work around this, you will want to use
a4c9746cb03c Merged revisions 78959,79170,79175,79177,79180,79183,79186,79193,79581 via svnmerge from
Georg Brandl <georg@python.org>
parents: 58612
diff changeset
169 .\" "sys.stdin.readline()" inside a "while 1:" loop.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
170 .TP
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
171 .B \-v
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
172 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
173 (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
174 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
175 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
176 at exit.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
177 .TP
58612
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
178 .B \-V ", " \-\-version
14602
24fbbf13daa5 Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents: 14360
diff changeset
179 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
180 .TP
15612
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
181 .BI "\-W " argument
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
182 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
183 .IR sys.stderr .
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
184 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
185 .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
186 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
187 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
188 Multiple
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
189 .B \-W
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
190 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
191 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
192 Invalid
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
193 .B \-W
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
194 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
195 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
196 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
197 .I warnings
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
198 module.
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
199
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
200 The simplest form of
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
201 .I argument
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
202 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
203 .I action
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
204 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
205 .B ignore
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
206 to ignore all warnings;
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
207 .B default
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
208 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
209 per source line);
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
210 .B all
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
211 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
212 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
213 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
214 .B module
54841
f6cb2932022c Merged revisions 73544 via svnmerge from
Georg Brandl <georg@python.org>
parents: 52363
diff changeset
215 to print each warning only the first time it occurs in each
15612
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
216 module;
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
217 .B once
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
218 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
219 .B error
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
220 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
221
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
222 The full form of
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
223 .I argument
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
224 is
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
225 .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
226 Here,
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
227 .I action
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
228 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
229 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
230 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
231 .I message
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
232 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
233 case-insensitive. The
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
234 .I category
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
235 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
236 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
237 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
238 be given. The
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
239 .I module
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
240 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
241 case-sensitive. The
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
242 .I line
e57f93ae4fe9 Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents: 14602
diff changeset
243 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
244 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
245 .TP
19739
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
246 .B \-x
8d2c7436b9d2 Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents: 18844
diff changeset
247 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
248 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
249 be off by one!
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
250 .SH INTERPRETER INTERFACE
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
251 The interpreter interface resembles that of the UNIX shell: when
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
252 called with standard input connected to a tty device, it prompts for
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
253 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
254 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
255 executes a
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
256 .I script
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
257 from that file;
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
258 when called with
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
259 .B \-c
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
260 .I command,
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
261 it executes the Python statement(s) given as
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
262 .I command.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
263 Here
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
264 .I command
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
265 may contain multiple statements separated by newlines.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
266 Leading whitespace is significant in Python statements!
34779
997b255e1ccc fix two typos in python(1)
Matthias Klose <doko@ubuntu.com>
parents: 33685
diff changeset
267 In non-interactive mode, the entire input is parsed before it is
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
268 executed.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
269 .PP
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
270 If available, the script name and additional arguments thereafter are
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
271 passed to the script in the Python variable
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
272 .I sys.argv ,
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
273 which is a list of strings (you must first
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
274 .I import sys
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
275 to be able to access it).
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
276 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
277 .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
278 is an empty string; if
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
279 .B \-c
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
280 is used,
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
281 .I sys.argv[0]
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
282 contains the string
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
283 .I '-c'.
3875
2838db83d0ed Got rid of all references to stdwin.
Guido van Rossum <guido@python.org>
parents: 2068
diff changeset
284 Note that options interpreted by the Python interpreter itself
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
285 are not placed in
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
286 .I sys.argv.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
287 .PP
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
288 In interactive mode, the primary prompt is `>>>'; the second prompt
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
289 (which appears when a command is not complete) is `...'.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
290 The prompts can be changed by assignment to
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
291 .I sys.ps1
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
292 or
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
293 .I sys.ps2.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
294 The interpreter quits when it reads an EOF at a prompt.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
295 When an unhandled exception occurs, a stack trace is printed and
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
296 control returns to the primary prompt; in non-interactive mode, the
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
297 interpreter exits after printing the stack trace.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
298 The interrupt signal raises the
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
299 .I Keyboard\%Interrupt
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
300 exception; other UNIX signals are not caught (except that SIGPIPE is
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
301 sometimes ignored, in favor of the
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
302 .I IOError
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
303 exception). Error messages are written to stderr.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
304 .SH FILES AND DIRECTORIES
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
305 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
306 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
307 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
308 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
309 .IP \fI${exec_prefix}/bin/python\fP
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
310 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
311 .PP
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
312 .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
313 .br
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
314 .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
315 .RS
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
316 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
317 modules.
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
318 .RE
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
319 .PP
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
320 .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
321 .br
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
322 .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
323 .RS
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
324 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
325 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
326 interpreter.
96501cc3a663 Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents: 7968
diff changeset
327 .RE
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
328 .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
329 .IP PYTHONHOME
4333775b55fd Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents: 5876
diff changeset
330 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
331 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
332 ${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
333 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
334 \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
335 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
336 for these, set $PYTHONHOME to ${prefix}:${exec_prefix}.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
337 .IP PYTHONPATH
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
338 Augments the default search path for module files.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
339 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
340 pathnames separated by colons.
34779
997b255e1ccc fix two typos in python(1)
Matthias Klose <doko@ubuntu.com>
parents: 33685
diff changeset
341 Non-existent 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
342 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
343 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
344 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
345 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
346 inserted in the path in front of $PYTHONPATH.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
347 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
348 variable
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
349 .I sys.path .
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
350 .IP PYTHONSTARTUP
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
351 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
352 file are executed before the first prompt is displayed in interactive
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
353 mode.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
354 The file is executed in the same name space where interactive commands
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
355 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
356 without qualification in the interactive session.
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
357 You can also change the prompts
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
358 .I sys.ps1
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
359 and
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
360 .I sys.ps2
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
361 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
362 .IP PYTHONY2K
045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this
Fred Drake <fdrake@acm.org>
parents: 18808
diff changeset
363 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
364 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
365 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
366 module documentation.
20401
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson.
Guido van Rossum <guido@python.org>
parents: 19740
diff changeset
367 .IP PYTHONOPTIMIZE
b74610c92d8b SF patch #467455 : Enhanced environment variables, by Toby Dickenson.
Guido van Rossum <guido@python.org>
parents: 19740
diff changeset
368 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
369 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
370 specifying \fB\-O\fP multiple times.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
371 .IP PYTHONDEBUG
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
372 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
373 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
374 specifying \fB\-d\fP multiple times.
58612
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
375 .IP PYTHONDONTWRITEBYTECODE
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
376 If this is set to a non-empty string it is equivalent to specifying
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
377 the \fB\-B\fP option (don't try to write
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
378 .I .py[co]
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
379 files).
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
380 .IP PYTHONINSPECT
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
381 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
382 the \fB\-i\fP option.
65273
1f225d66941a Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 65111
diff changeset
383 .IP PYTHONIOENCODING
1f225d66941a Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 65111
diff changeset
384 If this is set before running the interpreter, it overrides the encoding used
1f225d66941a Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 65111
diff changeset
385 for stdin/stdout/stderr, in the syntax
1f225d66941a Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 65111
diff changeset
386 .IB encodingname ":" errorhandler
1f225d66941a Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 65111
diff changeset
387 The
1f225d66941a Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 65111
diff changeset
388 .IB errorhandler
1f225d66941a Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 65111
diff changeset
389 part is optional and has the same meaning as in str.encode. For stderr, the
1f225d66941a Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 65111
diff changeset
390 .IB errorhandler
1f225d66941a Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 65111
diff changeset
391 part is ignored; the handler will always be \'backslashreplace\'.
58612
ce0d4dc488d2 Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents: 55927
diff changeset
392 .IP PYTHONNOUSERSITE
65273
1f225d66941a Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 65111
diff changeset
393 If this is set to a non-empty string it is equivalent to specifying the
1f225d66941a Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 65111
diff changeset
394 \fB\-s\fP option (Don't add the user site directory to sys.path).
1601
57b9b77da21b Documented -u (unbuffered), undocumented -k (killprint)
Guido van Rossum <guido@python.org>
parents: 1559
diff changeset
395 .IP PYTHONUNBUFFERED
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
396 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
397 the \fB\-u\fP option.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
398 .IP PYTHONVERBOSE
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
399 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
400 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
401 specifying \fB\-v\fP multiple times.
60436
f369db0d5845 Merged revisions 79878-79880 via svnmerge from
Philip Jenvey <pjenvey@underboss.org>
parents: 60149
diff changeset
402 .IP PYTHONWARNINGS
f369db0d5845 Merged revisions 79878-79880 via svnmerge from
Philip Jenvey <pjenvey@underboss.org>
parents: 60149
diff changeset
403 If this is set to a comma-separated string it is equivalent to
f369db0d5845 Merged revisions 79878-79880 via svnmerge from
Philip Jenvey <pjenvey@underboss.org>
parents: 60149
diff changeset
404 specifying the \fB\-W\fP option for each separate value.
1529
c9b3f77e18ba Initial revision
Guido van Rossum <guido@python.org>
parents:
diff changeset
405 .SH AUTHOR
33684
3e6f56e8104a Take out Guido's name and put in the PSF
Andrew M. Kuchling <amk@amk.ca>
parents: 33683
diff changeset
406 The Python Software Foundation: http://www.python.org/psf
3875
2838db83d0ed Got rid of all references to stdwin.
Guido van Rossum <guido@python.org>
parents: 2068
diff changeset
407 .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
408 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
409 .br
55927
8bc4c8cac7d7 Merged revisions 74759-74760 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 54841
diff changeset
410 Documentation: http://docs.python.org/py3k/
14360
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation
Guido van Rossum <guido@python.org>
parents: 13255
diff changeset
411 .br
33683
fda36af226fb Update two URLs
Andrew M. Kuchling <amk@amk.ca>
parents: 33682
diff changeset
412 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
413 .br
55927
8bc4c8cac7d7 Merged revisions 74759-74760 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 54841
diff changeset
414 Downloads: http://python.org/download/
14360
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation
Guido van Rossum <guido@python.org>
parents: 13255
diff changeset
415 .br
55927
8bc4c8cac7d7 Merged revisions 74759-74760 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 54841
diff changeset
416 Module repository: http://pypi.python.org/
3875
2838db83d0ed Got rid of all references to stdwin.
Guido van Rossum <guido@python.org>
parents: 2068
diff changeset
417 .br
18844
045f55135ad0 Document the PYTHONY2K environment variable that had been left out of this
Fred Drake <fdrake@acm.org>
parents: 18808
diff changeset
418 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
419 .SH LICENSING
d1d5e2dc29db Clean up a bit. Drop -X option, update date, remove documentation
Guido van Rossum <guido@python.org>
parents: 13255
diff changeset
420 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
421 "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
422 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
423 DISCLAIMER OF ALL WARRANTIES.