Mercurial > cpython-lru_cache-weakref
annotate Misc/python.man @ 80661:94de77bd0b4b 2.7
Issue #16194: document imp.load_dynamic problems
when read several extension modules from the same binary object file.
| author | Andrew Svetlov <andrew.svetlov@gmail.com> |
|---|---|
| date | Thu, 29 Nov 2012 19:51:28 +0200 |
| parents | 05f94e7e3b49 |
| children |
| 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 | 2 |
|
52263
d1b0bd48ba15
Merged revisions 70518 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
50786
diff
changeset
|
3 .\" To view this file while editing, run it through groff: |
|
d1b0bd48ba15
Merged revisions 70518 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
50786
diff
changeset
|
4 .\" groff -Tascii -man python.man | less |
| 33685 | 5 |
| 1529 | 6 .SH NAME |
| 7 python \- an interpreted, interactive, object-oriented programming language | |
| 8 .SH SYNOPSIS | |
| 9 .B python | |
| 10 [ | |
|
58610
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
11 .B \-B |
|
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
12 ] |
|
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
13 [ |
| 1529 | 14 .B \-d |
| 15 ] | |
| 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 | 23 .B \-i |
| 24 ] | |
| 25 [ | |
| 33682 | 26 .B \-m |
| 27 .I module-name | |
| 28 ] | |
|
58610
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
29 .br |
|
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
30 [ |
|
6273
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
31 .B \-O |
|
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
32 ] |
|
58610
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
33 [ |
|
69732
d70b0137902b
#11971: fix man page; it's -OO not -O0
R David Murray <rdmurray@bitdance.com>
parents:
68256
diff
changeset
|
34 .B \-OO |
|
58610
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
35 ] |
|
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
36 [ |
|
75100
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
37 .B \-R |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
38 ] |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
39 [ |
|
19739
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
40 .B -Q |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
41 .I argument |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
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 [ |
|
58610
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
44 .B \-s |
|
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
45 ] |
|
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
46 [ |
|
6273
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
47 .B \-S |
|
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
48 ] |
|
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
49 [ |
| 7965 | 50 .B \-t |
| 51 ] | |
| 52 [ | |
|
1601
57b9b77da21b
Documented -u (unbuffered), undocumented -k (killprint)
Guido van Rossum <guido@python.org>
parents:
1559
diff
changeset
|
53 .B \-u |
| 1529 | 54 ] |
|
19739
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
55 .br |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
56 [ |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
57 .B \-v |
|
14602
24fbbf13daa5
Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents:
14360
diff
changeset
|
58 ] |
|
24fbbf13daa5
Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents:
14360
diff
changeset
|
59 [ |
|
24fbbf13daa5
Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents:
14360
diff
changeset
|
60 .B \-V |
|
24fbbf13daa5
Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents:
14360
diff
changeset
|
61 ] |
|
15612
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
62 [ |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
63 .B \-W |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
64 .I argument |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
65 ] |
|
19739
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
66 [ |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
67 .B \-x |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
68 ] |
|
50786
2d453b221bec
Merged revisions 68292,68344,68361,68378,68424,68426,68429-68430,68450,68457,68480-68481,68493,68495,68499,68501,68512,68514-68515 via svnmerge from
Georg Brandl <georg@python.org>
parents:
34779
diff
changeset
|
69 [ |
|
2d453b221bec
Merged revisions 68292,68344,68361,68378,68424,68426,68429-68430,68450,68457,68480-68481,68493,68495,68499,68501,68512,68514-68515 via svnmerge from
Georg Brandl <georg@python.org>
parents:
34779
diff
changeset
|
70 .B \-3 |
|
2d453b221bec
Merged revisions 68292,68344,68361,68378,68424,68426,68429-68430,68450,68457,68480-68481,68493,68495,68499,68501,68512,68514-68515 via svnmerge from
Georg Brandl <georg@python.org>
parents:
34779
diff
changeset
|
71 ] |
|
58610
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
72 [ |
|
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
73 .B \-? |
|
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
74 ] |
|
6273
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
75 .br |
|
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
76 [ |
| 1529 | 77 .B \-c |
| 78 .I command | |
| 79 | | |
| 80 .I script | |
| 81 | | |
| 82 \- | |
| 83 ] | |
| 84 [ | |
| 85 .I arguments | |
| 86 ] | |
| 87 .SH DESCRIPTION | |
| 88 Python is an interpreted, interactive, object-oriented programming | |
| 89 language that combines remarkable power with very clear syntax. | |
| 90 For an introduction to programming in Python you are referred to the | |
| 91 Python Tutorial. | |
| 92 The Python Library Reference documents built-in and standard types, | |
| 93 constants, functions and modules. | |
| 94 Finally, the Python Reference Manual describes the syntax and | |
| 95 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
|
96 (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
|
97 .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
|
98 below; they may be installed on your system as well.) |
| 1529 | 99 .PP |
| 100 Python's basic power can be extended with your own modules written in | |
| 101 C or C++. | |
|
3875
2838db83d0ed
Got rid of all references to stdwin.
Guido van Rossum <guido@python.org>
parents:
2068
diff
changeset
|
102 On most systems such modules may be dynamically loaded. |
| 1529 | 103 Python is also adaptable as an extension language for existing |
| 104 applications. | |
| 105 See the internal documentation for hints. | |
|
17315
6be8bb4808e1
Mention pydoc in the man page
Andrew M. Kuchling <amk@amk.ca>
parents:
15612
diff
changeset
|
106 .PP |
|
6be8bb4808e1
Mention pydoc in the man page
Andrew M. Kuchling <amk@amk.ca>
parents:
15612
diff
changeset
|
107 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
|
108 viewed by running the |
|
6be8bb4808e1
Mention pydoc in the man page
Andrew M. Kuchling <amk@amk.ca>
parents:
15612
diff
changeset
|
109 .B pydoc |
|
6be8bb4808e1
Mention pydoc in the man page
Andrew M. Kuchling <amk@amk.ca>
parents:
15612
diff
changeset
|
110 program. |
| 1529 | 111 .SH COMMAND LINE OPTIONS |
| 112 .TP | |
|
58610
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
113 .B \-B |
|
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
114 Don't write |
|
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
115 .I .py[co] |
|
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
116 files on import. See also PYTHONDONTWRITEBYTECODE. |
|
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
117 .TP |
|
19739
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
118 .BI "\-c " command |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
119 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
|
120 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
|
121 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
|
122 .TP |
| 1529 | 123 .B \-d |
| 124 Turn on parser debugging output (for wizards only, depending on | |
| 125 compilation options). | |
|
1559
df0fb788c0c1
Fix weird messed up paragraphs
Guido van Rossum <guido@python.org>
parents:
1529
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 .B \-E |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
128 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
|
129 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
|
130 .TP |
|
58610
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
131 .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
|
132 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
|
133 .TP |
| 1529 | 134 .B \-i |
| 135 When a script is passed as first argument or the \fB\-c\fP option is | |
| 136 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
|
137 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
|
138 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
|
139 raises an exception. |
| 1529 | 140 .TP |
| 33682 | 141 .BI "\-m " module-name |
| 142 Searches | |
| 143 .I sys.path | |
| 144 for the named module and runs the corresponding | |
| 145 .I .py | |
| 146 file as a script. | |
| 147 .TP | |
|
6273
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
148 .B \-O |
|
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
149 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
|
150 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
|
151 .I .pyc |
|
11214
96501cc3a663
Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents:
7968
diff
changeset
|
152 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
|
153 .TP |
|
69732
d70b0137902b
#11971: fix man page; it's -OO not -O0
R David Murray <rdmurray@bitdance.com>
parents:
68256
diff
changeset
|
154 .B \-OO |
|
58610
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
155 Discard docstrings in addition to the \fB-O\fP optimizations. |
|
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
156 .TP |
|
75100
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
157 .B \-R |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
158 Turn on "hash randomization", so that the hash() values of str, bytes and |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
159 datetime objects are "salted" with an unpredictable pseudo-random value. |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
160 Although they remain constant within an individual Python process, they are |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
161 not predictable between repeated invocations of Python. |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
162 .IP |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
163 This is intended to provide protection against a denial of service |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
164 caused by carefully-chosen inputs that exploit the worst case performance |
|
75158
65d1fe86618f
Remove reST markup from --help output. Also: O(n**2) is dict construction, not single insertion.
Georg Brandl <georg@python.org>
parents:
75100
diff
changeset
|
165 of a dict construction, O(n^2) complexity. See |
|
75100
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
166 http://www.ocert.org/advisories/ocert-2011-003.html |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
167 for details. |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
168 .TP |
|
19739
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
169 .BI "\-Q " argument |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
170 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
|
171 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
|
172 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
|
173 "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
|
174 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
|
175 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
|
176 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
|
177 .TP |
|
58610
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
178 .B \-s |
|
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
179 Don't add user site directory to sys.path. |
|
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
180 .TP |
|
6273
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
181 .B \-S |
|
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
182 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
|
183 .I site |
|
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
184 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
|
185 .I sys.path |
|
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
186 that it entails. |
|
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
187 .TP |
| 7965 | 188 .B \-t |
| 189 Issue a warning when a source file mixes tabs and spaces for | |
| 190 indentation in a way that makes it depend on the worth of a tab | |
| 191 expressed in spaces. Issue an error when the option is given twice. | |
| 192 .TP | |
|
1601
57b9b77da21b
Documented -u (unbuffered), undocumented -k (killprint)
Guido van Rossum <guido@python.org>
parents:
1559
diff
changeset
|
193 .B \-u |
|
24696
ba3038a27c1e
Document that -u puts stdin, stdout, and stderr in binary mode.
Sjoerd Mullender <sjoerd@acm.org>
parents:
24401
diff
changeset
|
194 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
|
195 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
|
196 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
|
197 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
|
198 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
|
199 "sys.stdin.readline()" inside a "while 1:" loop. |
| 1529 | 200 .TP |
| 201 .B \-v | |
| 202 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
|
203 (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
|
204 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
|
205 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
|
206 at exit. |
| 1529 | 207 .TP |
|
58610
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
208 .B \-V ", " \-\-version |
|
14602
24fbbf13daa5
Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents:
14360
diff
changeset
|
209 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
|
210 .TP |
|
15612
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
211 .BI "\-W " argument |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
212 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
|
213 .IR sys.stderr . |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
214 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
|
215 .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
|
216 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
|
217 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
|
218 Multiple |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
219 .B \-W |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
220 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
|
221 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
|
222 Invalid |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
223 .B \-W |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
224 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
|
225 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
|
226 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
|
227 .I warnings |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
228 module. |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
229 |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
230 The simplest form of |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
231 .I argument |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
232 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
|
233 .I action |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
234 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
|
235 .B ignore |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
236 to ignore all warnings; |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
237 .B default |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
238 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
|
239 per source line); |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
240 .B all |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
241 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
|
242 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
|
243 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
|
244 .B module |
|
56814
127d623396ab
Merged revisions 73286,73294,73296,73459,73462-73463,73544,73576-73577,73595-73596,73693-73694,73704-73705,73707,73713,73937-73940,73945,73951,73979 via svnmerge from
Georg Brandl <georg@python.org>
parents:
55924
diff
changeset
|
245 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
|
246 module; |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
247 .B once |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
248 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
|
249 .B error |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
250 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
|
251 |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
252 The full form of |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
253 .I argument |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
254 is |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
255 .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
|
256 Here, |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
257 .I action |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
258 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
|
259 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
|
260 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
|
261 .I message |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
262 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
|
263 case-insensitive. The |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
264 .I category |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
265 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
|
266 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
|
267 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
|
268 be given. The |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
269 .I module |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
270 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
|
271 case-sensitive. The |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
272 .I line |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
273 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
|
274 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
|
275 .TP |
|
19739
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
276 .B \-x |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
277 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
|
278 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
|
279 be off by one! |
|
50786
2d453b221bec
Merged revisions 68292,68344,68361,68378,68424,68426,68429-68430,68450,68457,68480-68481,68493,68495,68499,68501,68512,68514-68515 via svnmerge from
Georg Brandl <georg@python.org>
parents:
34779
diff
changeset
|
280 .TP |
|
2d453b221bec
Merged revisions 68292,68344,68361,68378,68424,68426,68429-68430,68450,68457,68480-68481,68493,68495,68499,68501,68512,68514-68515 via svnmerge from
Georg Brandl <georg@python.org>
parents:
34779
diff
changeset
|
281 .B \-3 |
|
2d453b221bec
Merged revisions 68292,68344,68361,68378,68424,68426,68429-68430,68450,68457,68480-68481,68493,68495,68499,68501,68512,68514-68515 via svnmerge from
Georg Brandl <georg@python.org>
parents:
34779
diff
changeset
|
282 Warn about Python 3.x incompatibilities that 2to3 cannot trivially fix. |
| 1529 | 283 .SH INTERPRETER INTERFACE |
| 284 The interpreter interface resembles that of the UNIX shell: when | |
| 285 called with standard input connected to a tty device, it prompts for | |
| 286 commands and executes them until an EOF is read; when called with a | |
| 287 file name argument or with a file as standard input, it reads and | |
| 288 executes a | |
| 289 .I script | |
| 290 from that file; | |
| 291 when called with | |
| 292 .B \-c | |
| 293 .I command, | |
| 294 it executes the Python statement(s) given as | |
| 295 .I command. | |
| 296 Here | |
| 297 .I command | |
| 298 may contain multiple statements separated by newlines. | |
| 299 Leading whitespace is significant in Python statements! | |
|
34779
997b255e1ccc
fix two typos in python(1)
Matthias Klose <doko@ubuntu.com>
parents:
33685
diff
changeset
|
300 In non-interactive mode, the entire input is parsed before it is |
| 1529 | 301 executed. |
| 302 .PP | |
| 303 If available, the script name and additional arguments thereafter are | |
| 304 passed to the script in the Python variable | |
| 305 .I sys.argv , | |
| 306 which is a list of strings (you must first | |
| 307 .I import sys | |
| 308 to be able to access it). | |
| 309 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
|
310 .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
|
311 is an empty string; if |
| 1529 | 312 .B \-c |
| 313 is used, | |
| 314 .I sys.argv[0] | |
| 315 contains the string | |
| 316 .I '-c'. | |
|
3875
2838db83d0ed
Got rid of all references to stdwin.
Guido van Rossum <guido@python.org>
parents:
2068
diff
changeset
|
317 Note that options interpreted by the Python interpreter itself |
| 1529 | 318 are not placed in |
| 319 .I sys.argv. | |
| 320 .PP | |
| 321 In interactive mode, the primary prompt is `>>>'; the second prompt | |
| 322 (which appears when a command is not complete) is `...'. | |
| 323 The prompts can be changed by assignment to | |
| 324 .I sys.ps1 | |
| 325 or | |
| 326 .I sys.ps2. | |
| 327 The interpreter quits when it reads an EOF at a prompt. | |
| 328 When an unhandled exception occurs, a stack trace is printed and | |
| 329 control returns to the primary prompt; in non-interactive mode, the | |
| 330 interpreter exits after printing the stack trace. | |
| 331 The interrupt signal raises the | |
| 332 .I Keyboard\%Interrupt | |
| 333 exception; other UNIX signals are not caught (except that SIGPIPE is | |
| 334 sometimes ignored, in favor of the | |
| 335 .I IOError | |
| 336 exception). Error messages are written to stderr. | |
| 337 .SH FILES AND DIRECTORIES | |
| 338 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
|
339 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
|
340 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
|
341 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
|
342 .IP \fI${exec_prefix}/bin/python\fP |
| 1529 | 343 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
|
344 .PP |
|
96501cc3a663
Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents:
7968
diff
changeset
|
345 .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
|
346 .br |
|
96501cc3a663
Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents:
7968
diff
changeset
|
347 .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
|
348 .RS |
|
96501cc3a663
Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents:
7968
diff
changeset
|
349 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
|
350 modules. |
|
96501cc3a663
Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents:
7968
diff
changeset
|
351 .RE |
|
96501cc3a663
Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents:
7968
diff
changeset
|
352 .PP |
|
96501cc3a663
Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents:
7968
diff
changeset
|
353 .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
|
354 .br |
|
96501cc3a663
Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents:
7968
diff
changeset
|
355 .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
|
356 .RS |
|
96501cc3a663
Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents:
7968
diff
changeset
|
357 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
|
358 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
|
359 interpreter. |
|
96501cc3a663
Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents:
7968
diff
changeset
|
360 .RE |
|
96501cc3a663
Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents:
7968
diff
changeset
|
361 .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
|
362 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
|
363 not used by default or by most applications. |
| 1529 | 364 .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
|
365 .IP PYTHONHOME |
|
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
366 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
|
367 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
|
368 ${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
|
369 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
|
370 \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
|
371 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
|
372 for these, set $PYTHONHOME to ${prefix}:${exec_prefix}. |
| 1529 | 373 .IP PYTHONPATH |
| 374 Augments the default search path for module files. | |
| 375 The format is the same as the shell's $PATH: one or more directory | |
| 376 pathnames separated by colons. | |
|
34779
997b255e1ccc
fix two typos in python(1)
Matthias Klose <doko@ubuntu.com>
parents:
33685
diff
changeset
|
377 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
|
378 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
|
379 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
|
380 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
|
381 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
|
382 inserted in the path in front of $PYTHONPATH. |
| 1529 | 383 The search path can be manipulated from within a Python program as the |
| 384 variable | |
| 385 .I sys.path . | |
| 386 .IP PYTHONSTARTUP | |
| 387 If this is the name of a readable file, the Python commands in that | |
| 388 file are executed before the first prompt is displayed in interactive | |
| 389 mode. | |
| 390 The file is executed in the same name space where interactive commands | |
| 391 are executed so that objects defined or imported in it can be used | |
| 392 without qualification in the interactive session. | |
| 393 You can also change the prompts | |
| 394 .I sys.ps1 | |
| 395 and | |
| 396 .I sys.ps2 | |
| 397 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
|
398 .IP PYTHONY2K |
|
045f55135ad0
Document the PYTHONY2K environment variable that had been left out of this
Fred Drake <fdrake@acm.org>
parents:
18808
diff
changeset
|
399 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
|
400 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
|
401 2-digit years are converted based on rules described in the \fItime\fP |
| 23406 | 402 module documentation. |
|
20401
b74610c92d8b
SF patch #467455 : Enhanced environment variables, by Toby Dickenson.
Guido van Rossum <guido@python.org>
parents:
19740
diff
changeset
|
403 .IP PYTHONOPTIMIZE |
|
b74610c92d8b
SF patch #467455 : Enhanced environment variables, by Toby Dickenson.
Guido van Rossum <guido@python.org>
parents:
19740
diff
changeset
|
404 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
|
405 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
|
406 specifying \fB\-O\fP multiple times. |
| 1529 | 407 .IP PYTHONDEBUG |
| 408 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
|
409 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
|
410 specifying \fB\-d\fP multiple times. |
|
58610
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
411 .IP PYTHONDONTWRITEBYTECODE |
|
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
412 If this is set to a non-empty string it is equivalent to specifying |
|
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
413 the \fB\-B\fP option (don't try to write |
|
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
414 .I .py[co] |
|
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
415 files). |
| 1529 | 416 .IP PYTHONINSPECT |
| 417 If this is set to a non-empty string it is equivalent to specifying | |
| 418 the \fB\-i\fP option. | |
|
65274
e76f554158a8
Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
60435
diff
changeset
|
419 .IP PYTHONIOENCODING |
|
e76f554158a8
Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
60435
diff
changeset
|
420 If this is set before running the interpreter, it overrides the encoding used |
|
e76f554158a8
Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
60435
diff
changeset
|
421 for stdin/stdout/stderr, in the syntax |
|
e76f554158a8
Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
60435
diff
changeset
|
422 .IB encodingname ":" errorhandler |
|
e76f554158a8
Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
60435
diff
changeset
|
423 The |
|
e76f554158a8
Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
60435
diff
changeset
|
424 .IB errorhandler |
|
e76f554158a8
Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
60435
diff
changeset
|
425 part is optional and has the same meaning as in str.encode. For stderr, the |
|
e76f554158a8
Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
60435
diff
changeset
|
426 .IB errorhandler |
|
e76f554158a8
Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
60435
diff
changeset
|
427 part is ignored; the handler will always be \'backslashreplace\'. |
|
58610
6e6b59413a13
Merged revisions 77875 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
56814
diff
changeset
|
428 .IP PYTHONNOUSERSITE |
|
65274
e76f554158a8
Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
60435
diff
changeset
|
429 If this is set to a non-empty string it is equivalent to specifying the |
|
e76f554158a8
Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
60435
diff
changeset
|
430 \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
|
431 .IP PYTHONUNBUFFERED |
| 1529 | 432 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
|
433 the \fB\-u\fP option. |
| 1529 | 434 .IP PYTHONVERBOSE |
| 435 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
|
436 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
|
437 specifying \fB\-v\fP multiple times. |
|
60435
c9e4e12e9cb6
document new PYTHONWARNINGS env var
Philip Jenvey <pjenvey@underboss.org>
parents:
58609
diff
changeset
|
438 .IP PYTHONWARNINGS |
|
c9e4e12e9cb6
document new PYTHONWARNINGS env var
Philip Jenvey <pjenvey@underboss.org>
parents:
58609
diff
changeset
|
439 If this is set to a comma-separated string it is equivalent to |
|
c9e4e12e9cb6
document new PYTHONWARNINGS env var
Philip Jenvey <pjenvey@underboss.org>
parents:
58609
diff
changeset
|
440 specifying the \fB\-W\fP option for each separate value. |
|
75100
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
441 .IP PYTHONHASHSEED |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
442 If this variable is set to "random", the effect is the same as specifying |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
443 the \fB-R\fP option: a random value is used to seed the hashes of str, |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
444 bytes and datetime objects. |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
445 |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
446 If PYTHONHASHSEED is set to an integer value, it is used as a fixed seed for |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
447 generating the hash() of the types covered by the hash randomization. Its |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
448 purpose is to allow repeatable hashing, such as for selftests for the |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
449 interpreter itself, or to allow a cluster of python processes to share hash |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
450 values. |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
451 |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
452 The integer must be a decimal number in the range [0,4294967295]. Specifying |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
453 the value 0 will lead to the same hash values as when hash randomization is |
|
6b7704fe1be1
- Issue #13703: oCERT-2011-003: add -R command-line option and PYTHONHASHSEED
Barry Warsaw <barry@python.org>
parents:
58610
diff
changeset
|
454 disabled. |
| 1529 | 455 .SH AUTHOR |
|
33684
3e6f56e8104a
Take out Guido's name and put in the PSF
Andrew M. Kuchling <amk@amk.ca>
parents:
33683
diff
changeset
|
456 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
|
457 .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
|
458 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
|
459 .br |
| 33683 | 460 Documentation: http://docs.python.org/ |
|
3875
2838db83d0ed
Got rid of all references to stdwin.
Guido van Rossum <guido@python.org>
parents:
2068
diff
changeset
|
461 .br |
|
75269
05f94e7e3b49
Update lingering references to ex-parrot. I mean ex-devguide.
Éric Araujo <merwok@netwok.org>
parents:
75159
diff
changeset
|
462 Developer resources: http://docs.python.org/devguide/ |
|
14360
d1d5e2dc29db
Clean up a bit. Drop -X option, update date, remove documentation
Guido van Rossum <guido@python.org>
parents:
13255
diff
changeset
|
463 .br |
|
55924
fad0251324d7
Merged revisions 74757 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
52263
diff
changeset
|
464 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
|
465 .br |
|
55924
fad0251324d7
Merged revisions 74757 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
52263
diff
changeset
|
466 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
|
467 .br |
|
18844
045f55135ad0
Document the PYTHONY2K environment variable that had been left out of this
Fred Drake <fdrake@acm.org>
parents:
18808
diff
changeset
|
468 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
|
469 .SH LICENSING |
|
d1d5e2dc29db
Clean up a bit. Drop -X option, update date, remove documentation
Guido van Rossum <guido@python.org>
parents:
13255
diff
changeset
|
470 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
|
471 "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
|
472 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
|
473 DISCLAIMER OF ALL WARRANTIES. |