Mercurial > cpython-lru_cache-weakref
annotate Misc/python.man @ 87690:66c1c9f32567 default tip
Add use_weakref option to functools.lru_cache
The use_weakref option makes lru_cache create weak references to the function
arguments when creating the cache key, which prevents them from staying in the
memory forever even after all other references to them are gone.
This is a proof of concept for http://bugs.python.org/issue19859
| author | Radomir Dopieralski <devel@sheep.art.pl> |
|---|---|
| date | Tue, 03 Dec 2013 16:02:48 +0100 |
| parents | dd0d751cc7f1 |
| 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 |
|
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 | 5 |
| 1529 | 6 .SH NAME |
| 7 python \- an interpreted, interactive, object-oriented programming language | |
| 8 .SH SYNOPSIS | |
| 9 .B python | |
| 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 [ |
|
84224
dfead0696a71
Add -b and -X options to python man page.
Senthil Kumaran <senthil@uthcode.com>
parents:
77524
diff
changeset
|
14 .B \-b |
|
dfead0696a71
Add -b and -X options to python man page.
Senthil Kumaran <senthil@uthcode.com>
parents:
77524
diff
changeset
|
15 ] |
|
dfead0696a71
Add -b and -X options to python man page.
Senthil Kumaran <senthil@uthcode.com>
parents:
77524
diff
changeset
|
16 [ |
| 1529 | 17 .B \-d |
| 18 ] | |
| 19 [ | |
|
19739
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
20 .B \-E |
|
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 [ |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
23 .B \-h |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
24 ] |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
25 [ |
| 1529 | 26 .B \-i |
| 27 ] | |
| 28 [ | |
|
85081
dd0d751cc7f1
Issue #16400: Add command line option for isolated mode.
Christian Heimes <christian@cheimes.de>
parents:
84811
diff
changeset
|
29 .B \-I |
|
dd0d751cc7f1
Issue #16400: Add command line option for isolated mode.
Christian Heimes <christian@cheimes.de>
parents:
84811
diff
changeset
|
30 ] |
|
dd0d751cc7f1
Issue #16400: Add command line option for isolated mode.
Christian Heimes <christian@cheimes.de>
parents:
84811
diff
changeset
|
31 .br |
|
dd0d751cc7f1
Issue #16400: Add command line option for isolated mode.
Christian Heimes <christian@cheimes.de>
parents:
84811
diff
changeset
|
32 [ |
|
84224
dfead0696a71
Add -b and -X options to python man page.
Senthil Kumaran <senthil@uthcode.com>
parents:
77524
diff
changeset
|
33 .B \-m |
| 33682 | 34 .I module-name |
| 35 ] | |
|
85081
dd0d751cc7f1
Issue #16400: Add command line option for isolated mode.
Christian Heimes <christian@cheimes.de>
parents:
84811
diff
changeset
|
36 [ |
|
84224
dfead0696a71
Add -b and -X options to python man page.
Senthil Kumaran <senthil@uthcode.com>
parents:
77524
diff
changeset
|
37 .B \-q |
|
dfead0696a71
Add -b and -X options to python man page.
Senthil Kumaran <senthil@uthcode.com>
parents:
77524
diff
changeset
|
38 ] |
|
dfead0696a71
Add -b and -X options to python man page.
Senthil Kumaran <senthil@uthcode.com>
parents:
77524
diff
changeset
|
39 [ |
|
6273
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
40 .B \-O |
|
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
41 ] |
|
58612
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
42 [ |
|
69733
c57fdce01eb8
#11971: fix man page; it's -OO not -O0
R David Murray <rdmurray@bitdance.com>
parents:
65273
diff
changeset
|
43 .B \-OO |
|
58612
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
44 ] |
|
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
45 [ |
|
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
46 .B \-s |
|
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
47 ] |
|
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
48 [ |
|
6273
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
49 .B \-S |
|
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
50 ] |
|
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
51 [ |
|
1601
57b9b77da21b
Documented -u (unbuffered), undocumented -k (killprint)
Guido van Rossum <guido@python.org>
parents:
1559
diff
changeset
|
52 .B \-u |
| 1529 | 53 ] |
|
19739
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
54 .br |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
55 [ |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
56 .B \-v |
|
14602
24fbbf13daa5
Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents:
14360
diff
changeset
|
57 ] |
|
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 .B \-V |
|
24fbbf13daa5
Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents:
14360
diff
changeset
|
60 ] |
|
15612
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
61 [ |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
62 .B \-W |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
63 .I argument |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
64 ] |
|
19739
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
65 [ |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
66 .B \-x |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
67 ] |
|
58612
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
68 [ |
|
84224
dfead0696a71
Add -b and -X options to python man page.
Senthil Kumaran <senthil@uthcode.com>
parents:
77524
diff
changeset
|
69 [ |
|
dfead0696a71
Add -b and -X options to python man page.
Senthil Kumaran <senthil@uthcode.com>
parents:
77524
diff
changeset
|
70 .B \-X |
|
dfead0696a71
Add -b and -X options to python man page.
Senthil Kumaran <senthil@uthcode.com>
parents:
77524
diff
changeset
|
71 .I option |
|
dfead0696a71
Add -b and -X options to python man page.
Senthil Kumaran <senthil@uthcode.com>
parents:
77524
diff
changeset
|
72 ] |
|
58612
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
73 .B \-? |
|
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
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 | |
|
58612
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
113 .B \-B |
|
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
114 Don't write |
|
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
115 .I .py[co] |
|
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
116 files on import. See also PYTHONDONTWRITEBYTECODE. |
|
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
117 .TP |
|
84224
dfead0696a71
Add -b and -X options to python man page.
Senthil Kumaran <senthil@uthcode.com>
parents:
77524
diff
changeset
|
118 .B \-b |
|
dfead0696a71
Add -b and -X options to python man page.
Senthil Kumaran <senthil@uthcode.com>
parents:
77524
diff
changeset
|
119 Issue warnings about str(bytes_instance), str(bytearray_instance) |
|
dfead0696a71
Add -b and -X options to python man page.
Senthil Kumaran <senthil@uthcode.com>
parents:
77524
diff
changeset
|
120 and comparing bytes/bytearray with str. (-bb: issue errors) |
|
dfead0696a71
Add -b and -X options to python man page.
Senthil Kumaran <senthil@uthcode.com>
parents:
77524
diff
changeset
|
121 .TP |
|
19739
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
122 .BI "\-c " command |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
123 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
|
124 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
|
125 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
|
126 .TP |
| 1529 | 127 .B \-d |
| 128 Turn on parser debugging output (for wizards only, depending on | |
| 129 compilation options). | |
|
1559
df0fb788c0c1
Fix weird messed up paragraphs
Guido van Rossum <guido@python.org>
parents:
1529
diff
changeset
|
130 .TP |
|
19739
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
131 .B \-E |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
132 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
|
133 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
|
134 .TP |
|
58612
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
135 .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
|
136 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
|
137 .TP |
| 1529 | 138 .B \-i |
| 139 When a script is passed as first argument or the \fB\-c\fP option is | |
| 140 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
|
141 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
|
142 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
|
143 raises an exception. |
| 1529 | 144 .TP |
|
85081
dd0d751cc7f1
Issue #16400: Add command line option for isolated mode.
Christian Heimes <christian@cheimes.de>
parents:
84811
diff
changeset
|
145 .B \-I |
|
dd0d751cc7f1
Issue #16400: Add command line option for isolated mode.
Christian Heimes <christian@cheimes.de>
parents:
84811
diff
changeset
|
146 Run Python in isolated mode. This also implies \fB\-E\fP and \fB\-S\fP. In |
|
dd0d751cc7f1
Issue #16400: Add command line option for isolated mode.
Christian Heimes <christian@cheimes.de>
parents:
84811
diff
changeset
|
147 isolated mode sys.path contains neither the script’s directory nor the user’s |
|
dd0d751cc7f1
Issue #16400: Add command line option for isolated mode.
Christian Heimes <christian@cheimes.de>
parents:
84811
diff
changeset
|
148 site-packages directory. All PYTHON* environment variables are ignored, too. |
|
dd0d751cc7f1
Issue #16400: Add command line option for isolated mode.
Christian Heimes <christian@cheimes.de>
parents:
84811
diff
changeset
|
149 Further restrictions may be imposed to prevent the user from injecting |
|
dd0d751cc7f1
Issue #16400: Add command line option for isolated mode.
Christian Heimes <christian@cheimes.de>
parents:
84811
diff
changeset
|
150 malicious code. |
|
dd0d751cc7f1
Issue #16400: Add command line option for isolated mode.
Christian Heimes <christian@cheimes.de>
parents:
84811
diff
changeset
|
151 .TP |
| 33682 | 152 .BI "\-m " module-name |
| 153 Searches | |
| 154 .I sys.path | |
| 155 for the named module and runs the corresponding | |
| 156 .I .py | |
| 157 file as a script. | |
| 158 .TP | |
|
6273
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
159 .B \-O |
|
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
160 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
|
161 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
|
162 .I .pyc |
|
11214
96501cc3a663
Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents:
7968
diff
changeset
|
163 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
|
164 .TP |
|
69733
c57fdce01eb8
#11971: fix man page; it's -OO not -O0
R David Murray <rdmurray@bitdance.com>
parents:
65273
diff
changeset
|
165 .B \-OO |
|
58612
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
166 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
|
167 .TP |
|
66687
f35a6d7e325f
#1772833: add -q command line option.
Georg Brandl <georg@python.org>
parents:
65271
diff
changeset
|
168 .B \-q |
|
f35a6d7e325f
#1772833: add -q command line option.
Georg Brandl <georg@python.org>
parents:
65271
diff
changeset
|
169 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
|
170 also suppressed in non-interactive mode. |
|
f35a6d7e325f
#1772833: add -q command line option.
Georg Brandl <georg@python.org>
parents:
65271
diff
changeset
|
171 .TP |
|
58612
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
172 .B \-s |
|
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
173 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
|
174 .TP |
|
6273
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
175 .B \-S |
|
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
176 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
|
177 .I site |
|
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
178 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
|
179 .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
|
180 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
|
181 .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
|
182 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
|
183 .TP |
|
1601
57b9b77da21b
Documented -u (unbuffered), undocumented -k (killprint)
Guido van Rossum <guido@python.org>
parents:
1559
diff
changeset
|
184 .B \-u |
|
84811
4b33f74ab0f1
#16937: document that stdin is always buffered, even when -u is used. Patch by Elena Oat.
Ezio Melotti <ezio.melotti@gmail.com>
parents:
84224
diff
changeset
|
185 Force the binary I/O layers of stdout and stderr to be unbuffered. |
|
4b33f74ab0f1
#16937: document that stdin is always buffered, even when -u is used. Patch by Elena Oat.
Ezio Melotti <ezio.melotti@gmail.com>
parents:
84224
diff
changeset
|
186 stdin is always buffered. |
|
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
|
187 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
|
188 .\" 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
|
189 .\" 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
|
190 .\" 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
|
191 .\" "sys.stdin.readline()" inside a "while 1:" loop. |
| 1529 | 192 .TP |
| 193 .B \-v | |
| 194 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
|
195 (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
|
196 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
|
197 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
|
198 at exit. |
| 1529 | 199 .TP |
|
58612
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
200 .B \-V ", " \-\-version |
|
14602
24fbbf13daa5
Describe the -h and -V flags. Closes patch #101496
Barry Warsaw <barry@python.org>
parents:
14360
diff
changeset
|
201 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
|
202 .TP |
|
15612
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
203 .BI "\-W " argument |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
204 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
|
205 .IR sys.stderr . |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
206 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
|
207 .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
|
208 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
|
209 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
|
210 Multiple |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
211 .B \-W |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
212 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
|
213 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
|
214 Invalid |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
215 .B \-W |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
216 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
|
217 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
|
218 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
|
219 .I warnings |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
220 module. |
|
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 simplest 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 one of the following |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
225 .I action |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
226 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
|
227 .B ignore |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
228 to ignore all warnings; |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
229 .B default |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
230 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
|
231 per source line); |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
232 .B all |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
233 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
|
234 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
|
235 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
|
236 .B module |
|
54841
f6cb2932022c
Merged revisions 73544 via svnmerge from
Georg Brandl <georg@python.org>
parents:
52363
diff
changeset
|
237 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
|
238 module; |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
239 .B once |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
240 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
|
241 .B error |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
242 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
|
243 |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
244 The full form of |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
245 .I argument |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
246 is |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
247 .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
|
248 Here, |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
249 .I action |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
250 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
|
251 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
|
252 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
|
253 .I message |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
254 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
|
255 case-insensitive. The |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
256 .I category |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
257 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
|
258 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
|
259 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
|
260 be given. The |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
261 .I module |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
262 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
|
263 case-sensitive. The |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
264 .I line |
|
e57f93ae4fe9
Document the -W option as best as I can.
Guido van Rossum <guido@python.org>
parents:
14602
diff
changeset
|
265 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
|
266 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
|
267 .TP |
|
84224
dfead0696a71
Add -b and -X options to python man page.
Senthil Kumaran <senthil@uthcode.com>
parents:
77524
diff
changeset
|
268 .BI "\-X " option |
|
dfead0696a71
Add -b and -X options to python man page.
Senthil Kumaran <senthil@uthcode.com>
parents:
77524
diff
changeset
|
269 Set implementation specific option. |
|
dfead0696a71
Add -b and -X options to python man page.
Senthil Kumaran <senthil@uthcode.com>
parents:
77524
diff
changeset
|
270 .TP |
|
19739
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
271 .B \-x |
|
8d2c7436b9d2
Document -Q. Move arguments around to be in strict alphabetical
Guido van Rossum <guido@python.org>
parents:
18844
diff
changeset
|
272 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
|
273 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
|
274 be off by one! |
| 1529 | 275 .SH INTERPRETER INTERFACE |
| 276 The interpreter interface resembles that of the UNIX shell: when | |
| 277 called with standard input connected to a tty device, it prompts for | |
| 278 commands and executes them until an EOF is read; when called with a | |
| 279 file name argument or with a file as standard input, it reads and | |
| 280 executes a | |
| 281 .I script | |
| 282 from that file; | |
| 283 when called with | |
| 284 .B \-c | |
|
77524
c1c632e2560d
Do not italicize punctuation in python(1) manual page (Matt Kraai).
doko@ubuntu.com
parents:
75157
diff
changeset
|
285 .IR command , |
| 1529 | 286 it executes the Python statement(s) given as |
|
77524
c1c632e2560d
Do not italicize punctuation in python(1) manual page (Matt Kraai).
doko@ubuntu.com
parents:
75157
diff
changeset
|
287 .IR command . |
| 1529 | 288 Here |
| 289 .I command | |
| 290 may contain multiple statements separated by newlines. | |
| 291 Leading whitespace is significant in Python statements! | |
|
34779
997b255e1ccc
fix two typos in python(1)
Matthias Klose <doko@ubuntu.com>
parents:
33685
diff
changeset
|
292 In non-interactive mode, the entire input is parsed before it is |
| 1529 | 293 executed. |
| 294 .PP | |
| 295 If available, the script name and additional arguments thereafter are | |
| 296 passed to the script in the Python variable | |
|
77524
c1c632e2560d
Do not italicize punctuation in python(1) manual page (Matt Kraai).
doko@ubuntu.com
parents:
75157
diff
changeset
|
297 .IR sys.argv , |
| 1529 | 298 which is a list of strings (you must first |
| 299 .I import sys | |
| 300 to be able to access it). | |
| 301 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
|
302 .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
|
303 is an empty string; if |
| 1529 | 304 .B \-c |
| 305 is used, | |
| 306 .I sys.argv[0] | |
| 307 contains the string | |
| 308 .I '-c'. | |
|
3875
2838db83d0ed
Got rid of all references to stdwin.
Guido van Rossum <guido@python.org>
parents:
2068
diff
changeset
|
309 Note that options interpreted by the Python interpreter itself |
| 1529 | 310 are not placed in |
|
77524
c1c632e2560d
Do not italicize punctuation in python(1) manual page (Matt Kraai).
doko@ubuntu.com
parents:
75157
diff
changeset
|
311 .IR sys.argv . |
| 1529 | 312 .PP |
| 313 In interactive mode, the primary prompt is `>>>'; the second prompt | |
| 314 (which appears when a command is not complete) is `...'. | |
| 315 The prompts can be changed by assignment to | |
| 316 .I sys.ps1 | |
| 317 or | |
|
77524
c1c632e2560d
Do not italicize punctuation in python(1) manual page (Matt Kraai).
doko@ubuntu.com
parents:
75157
diff
changeset
|
318 .IR sys.ps2 . |
| 1529 | 319 The interpreter quits when it reads an EOF at a prompt. |
| 320 When an unhandled exception occurs, a stack trace is printed and | |
| 321 control returns to the primary prompt; in non-interactive mode, the | |
| 322 interpreter exits after printing the stack trace. | |
| 323 The interrupt signal raises the | |
| 324 .I Keyboard\%Interrupt | |
| 325 exception; other UNIX signals are not caught (except that SIGPIPE is | |
| 326 sometimes ignored, in favor of the | |
| 327 .I IOError | |
| 328 exception). Error messages are written to stderr. | |
| 329 .SH FILES AND DIRECTORIES | |
| 330 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
|
331 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
|
332 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
|
333 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
|
334 .IP \fI${exec_prefix}/bin/python\fP |
| 1529 | 335 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
|
336 .PP |
|
96501cc3a663
Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents:
7968
diff
changeset
|
337 .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
|
338 .br |
|
96501cc3a663
Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents:
7968
diff
changeset
|
339 .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
|
340 .RS |
|
96501cc3a663
Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents:
7968
diff
changeset
|
341 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
|
342 modules. |
|
96501cc3a663
Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents:
7968
diff
changeset
|
343 .RE |
|
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}/include/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}/include/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 include files |
|
96501cc3a663
Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents:
7968
diff
changeset
|
350 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
|
351 interpreter. |
|
96501cc3a663
Various updates, mostly to add information to the SEE ALSO and
Fred Drake <fdrake@acm.org>
parents:
7968
diff
changeset
|
352 .RE |
| 1529 | 353 .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
|
354 .IP PYTHONHOME |
|
4333775b55fd
Brought up to date with new options and env vars.
Guido van Rossum <guido@python.org>
parents:
5876
diff
changeset
|
355 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
|
356 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
|
357 ${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
|
358 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
|
359 \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
|
360 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
|
361 for these, set $PYTHONHOME to ${prefix}:${exec_prefix}. |
| 1529 | 362 .IP PYTHONPATH |
| 363 Augments the default search path for module files. | |
| 364 The format is the same as the shell's $PATH: one or more directory | |
| 365 pathnames separated by colons. | |
|
34779
997b255e1ccc
fix two typos in python(1)
Matthias Klose <doko@ubuntu.com>
parents:
33685
diff
changeset
|
366 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
|
367 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
|
368 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
|
369 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
|
370 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
|
371 inserted in the path in front of $PYTHONPATH. |
| 1529 | 372 The search path can be manipulated from within a Python program as the |
| 373 variable | |
|
77524
c1c632e2560d
Do not italicize punctuation in python(1) manual page (Matt Kraai).
doko@ubuntu.com
parents:
75157
diff
changeset
|
374 .IR sys.path . |
| 1529 | 375 .IP PYTHONSTARTUP |
| 376 If this is the name of a readable file, the Python commands in that | |
| 377 file are executed before the first prompt is displayed in interactive | |
| 378 mode. | |
| 379 The file is executed in the same name space where interactive commands | |
| 380 are executed so that objects defined or imported in it can be used | |
| 381 without qualification in the interactive session. | |
| 382 You can also change the prompts | |
| 383 .I sys.ps1 | |
| 384 and | |
| 385 .I sys.ps2 | |
| 386 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
|
387 .IP PYTHONY2K |
|
045f55135ad0
Document the PYTHONY2K environment variable that had been left out of this
Fred Drake <fdrake@acm.org>
parents:
18808
diff
changeset
|
388 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
|
389 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
|
390 2-digit years are converted based on rules described in the \fItime\fP |
| 23406 | 391 module documentation. |
|
20401
b74610c92d8b
SF patch #467455 : Enhanced environment variables, by Toby Dickenson.
Guido van Rossum <guido@python.org>
parents:
19740
diff
changeset
|
392 .IP PYTHONOPTIMIZE |
|
b74610c92d8b
SF patch #467455 : Enhanced environment variables, by Toby Dickenson.
Guido van Rossum <guido@python.org>
parents:
19740
diff
changeset
|
393 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
|
394 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
|
395 specifying \fB\-O\fP multiple times. |
| 1529 | 396 .IP PYTHONDEBUG |
| 397 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
|
398 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
|
399 specifying \fB\-d\fP multiple times. |
|
58612
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
400 .IP PYTHONDONTWRITEBYTECODE |
|
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
401 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
|
402 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
|
403 .I .py[co] |
|
ce0d4dc488d2
Merged revisions 77877 via svnmerge from
Matthias Klose <doko@ubuntu.com>
parents:
55927
diff
changeset
|
404 files). |
| 1529 | 405 .IP PYTHONINSPECT |
| 406 If this is set to a non-empty string it is equivalent to specifying | |
| 407 the \fB\-i\fP option. | |
|
65273
1f225d66941a
Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
65111
diff
changeset
|
408 .IP PYTHONIOENCODING |
|
1f225d66941a
Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
65111
diff
changeset
|
409 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
|
410 for stdin/stdout/stderr, in the syntax |
|
1f225d66941a
Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
65111
diff
changeset
|
411 .IB encodingname ":" errorhandler |
|
1f225d66941a
Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
65111
diff
changeset
|
412 The |
|
1f225d66941a
Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
65111
diff
changeset
|
413 .IB errorhandler |
|
1f225d66941a
Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
65111
diff
changeset
|
414 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
|
415 .IB errorhandler |
|
1f225d66941a
Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
65111
diff
changeset
|
416 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
|
417 .IP PYTHONNOUSERSITE |
|
65273
1f225d66941a
Merged revisions 85436 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
65111
diff
changeset
|
418 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
|
419 \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
|
420 .IP PYTHONUNBUFFERED |
| 1529 | 421 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
|
422 the \fB\-u\fP option. |
| 1529 | 423 .IP PYTHONVERBOSE |
| 424 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
|
425 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
|
426 specifying \fB\-v\fP multiple times. |
|
60436
f369db0d5845
Merged revisions 79878-79880 via svnmerge from
Philip Jenvey <pjenvey@underboss.org>
parents:
60149
diff
changeset
|
427 .IP PYTHONWARNINGS |
|
f369db0d5845
Merged revisions 79878-79880 via svnmerge from
Philip Jenvey <pjenvey@underboss.org>
parents:
60149
diff
changeset
|
428 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
|
429 specifying the \fB\-W\fP option for each separate value. |
|
75066
f4b7ecf8a5f8
Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime)
Georg Brandl <georg@python.org>
parents:
69733
diff
changeset
|
430 .IP PYTHONHASHSEED |
|
75152
198e31774f0f
enable hash randomization by default
Benjamin Peterson <benjamin@python.org>
parents:
75097
diff
changeset
|
431 If this variable is set to "random", a random value is used to seed the hashes |
|
198e31774f0f
enable hash randomization by default
Benjamin Peterson <benjamin@python.org>
parents:
75097
diff
changeset
|
432 of str, bytes and datetime objects. |
|
75066
f4b7ecf8a5f8
Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime)
Georg Brandl <georg@python.org>
parents:
69733
diff
changeset
|
433 |
|
f4b7ecf8a5f8
Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime)
Georg Brandl <georg@python.org>
parents:
69733
diff
changeset
|
434 If PYTHONHASHSEED is set to an integer value, it is used as a fixed seed for |
|
f4b7ecf8a5f8
Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime)
Georg Brandl <georg@python.org>
parents:
69733
diff
changeset
|
435 generating the hash() of the types covered by the hash randomization. Its |
|
f4b7ecf8a5f8
Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime)
Georg Brandl <georg@python.org>
parents:
69733
diff
changeset
|
436 purpose is to allow repeatable hashing, such as for selftests for the |
|
f4b7ecf8a5f8
Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime)
Georg Brandl <georg@python.org>
parents:
69733
diff
changeset
|
437 interpreter itself, or to allow a cluster of python processes to share hash |
|
f4b7ecf8a5f8
Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime)
Georg Brandl <georg@python.org>
parents:
69733
diff
changeset
|
438 values. |
|
f4b7ecf8a5f8
Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime)
Georg Brandl <georg@python.org>
parents:
69733
diff
changeset
|
439 |
|
f4b7ecf8a5f8
Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime)
Georg Brandl <georg@python.org>
parents:
69733
diff
changeset
|
440 The integer must be a decimal number in the range [0,4294967295]. Specifying |
|
75152
198e31774f0f
enable hash randomization by default
Benjamin Peterson <benjamin@python.org>
parents:
75097
diff
changeset
|
441 the value 0 will disable hash randomization. |
| 1529 | 442 .SH AUTHOR |
|
33684
3e6f56e8104a
Take out Guido's name and put in the PSF
Andrew M. Kuchling <amk@amk.ca>
parents:
33683
diff
changeset
|
443 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
|
444 .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
|
445 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
|
446 .br |
|
55927
8bc4c8cac7d7
Merged revisions 74759-74760 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
54841
diff
changeset
|
447 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
|
448 .br |
|
73785
49d69219fa59
Fix last remaining references to ex-devguide
Éric Araujo <merwok@netwok.org>
parents:
69734
diff
changeset
|
449 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
|
450 .br |
|
55927
8bc4c8cac7d7
Merged revisions 74759-74760 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
54841
diff
changeset
|
451 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
|
452 .br |
|
55927
8bc4c8cac7d7
Merged revisions 74759-74760 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents:
54841
diff
changeset
|
453 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
|
454 .br |
|
18844
045f55135ad0
Document the PYTHONY2K environment variable that had been left out of this
Fred Drake <fdrake@acm.org>
parents:
18808
diff
changeset
|
455 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
|
456 .SH LICENSING |
|
d1d5e2dc29db
Clean up a bit. Drop -X option, update date, remove documentation
Guido van Rossum <guido@python.org>
parents:
13255
diff
changeset
|
457 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
|
458 "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
|
459 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
|
460 DISCLAIMER OF ALL WARRANTIES. |
