blob: 8e5264a84a785f52d92b7f2233fb7aea2ee95b87 [file] [log] [blame]
Barry Warsawc0bf33e2003-07-25 01:12:48 +00001This is Python version 2.3 release candidate 2
Jeremy Hyltonfa2d0eb2003-07-17 17:58:38 +00002==============================================
Guido van Rossum91447632000-04-11 17:11:09 +00003
Guido van Rossumf1226882002-12-31 01:50:07 +00004Copyright (c) 2001, 2002, 2003 Python Software Foundation.
Guido van Rossum67345eb2001-01-18 14:51:12 +00005All rights reserved.
6
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00007Copyright (c) 2000 BeOpen.com.
8All rights reserved.
9
Guido van Rossum23f7aed2001-04-12 20:53:31 +000010Copyright (c) 1995-2001 Corporation for National Research Initiatives.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000011All rights reserved.
12
Guido van Rossum6ebd2992000-09-03 04:47:47 +000013Copyright (c) 1991-1995 Stichting Mathematisch Centrum.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000014All rights reserved.
15
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000016
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000017License information
18-------------------
19
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000020See the file "LICENSE" for information on the history of this
21software, terms & conditions for usage, and a DISCLAIMER OF ALL
22WARRANTIES.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000023
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000024This Python distribution contains no GNU General Public Licensed
25(GPLed) code so it may be used in proprietary projects just like prior
26Python distributions. There are interfaces to some GNU code but these
27are entirely optional.
28
29All trademarks referenced herein are property of their respective
30holders.
Guido van Rossum79808261997-12-11 18:01:47 +000031
32
Guido van Rossum8d7d4ed1996-07-30 21:41:07 +000033What's new in this release?
34---------------------------
Guido van Rossum3ff96dd1996-07-30 18:05:04 +000035
Guido van Rossum67345eb2001-01-18 14:51:12 +000036See the file "Misc/NEWS".
Guido van Rossum64773801997-11-26 17:07:02 +000037
38If you don't read instructions
39------------------------------
40
41Congratulations on getting this far. :-)
42
43To start building right away (on UNIX): type "./configure" in the
Guido van Rossum2dcec0c2002-02-04 01:59:23 +000044current directory and when it finishes, type "make". This creates an
45executable "./python"; to install in /usr/local, first do "su root"
46and then "make install".
47
Guido van Rossum59b0b602002-02-08 22:22:35 +000048The section `Build instructions' below is still recommended reading,
Guido van Rossum2dcec0c2002-02-04 01:59:23 +000049especially the part on customizing Modules/Setup.
Guido van Rossum3ff96dd1996-07-30 18:05:04 +000050
51
Guido van Rossum91cb9d21995-04-10 11:47:38 +000052What is Python anyway?
53----------------------
54
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000055Python is an interpreted object-oriented programming language suitable
56(amongst other uses) for distributed application development,
57scripting, numeric computing and system testing. Python is often
58compared to Tcl, Perl, Java, JavaScript, Visual Basic or Scheme. To
59find out more about what Python can do for you, point your browser to
Guido van Rossum67345eb2001-01-18 14:51:12 +000060http://www.python.org/.
Guido van Rossum91cb9d21995-04-10 11:47:38 +000061
62
Guido van Rossumf501b4e1996-10-25 14:32:48 +000063How do I learn Python?
64----------------------
65
Fred Drake0e6444c1999-05-17 19:35:01 +000066The official tutorial is still a good place to start; see
Guido van Rossumd0a42e22000-03-31 20:16:45 +000067http://www.python.org/doc/ for online and downloadable versions, as
68well as a list of other introductions, and reference documentation.
Guido van Rossumf501b4e1996-10-25 14:32:48 +000069
Guido van Rossumd0a42e22000-03-31 20:16:45 +000070There's a quickly growing set of books on Python. See
Skip Montanaro932dab62003-06-12 14:04:33 +000071http://www.python.org/cgi-bin/moinmoin/PythonBooks for a list.
Guido van Rossum8d90f9d1997-05-22 20:13:25 +000072
Guido van Rossumf501b4e1996-10-25 14:32:48 +000073
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000074Documentation
75-------------
Guido van Rossum91cb9d21995-04-10 11:47:38 +000076
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000077All documentation is provided online in a variety of formats. In
78order of importance for new users: Tutorial, Library Reference,
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000079Language Reference, Extending & Embedding, and the Python/C API. The
80Library Reference is especially of immense value since much of
81Python's power is described there, including the built-in data types
82and functions!
Guido van Rossum91cb9d21995-04-10 11:47:38 +000083
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000084All documentation is also available online at the Python web site
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000085(http://www.python.org/doc/, see below). It is available online for
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000086occasional reference, or can be downloaded in many formats for faster
Fred Drake6caae142000-10-25 17:51:02 +000087access. The documentation is available in HTML, PostScript, PDF, and
88LaTeX formats; the LaTeX version is primarily for documentation
89authors, translators, and people with special formatting requirements.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000090
Michael W. Hudsonbe6e0f42002-06-23 16:29:36 +000091The best documentation for the new (in Python 2.2) type/class
92unification features is Guido's tutorial introduction, at
Barry Warsaw06557452001-12-14 20:47:12 +000093
Guido van Rossum1c63a592002-07-09 18:44:09 +000094 http://www.python.org/2.2.1/descrintro.html
Barry Warsaw06557452001-12-14 20:47:12 +000095
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000096
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000097Web sites
98---------
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000099
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000100New Python releases and related technologies are published at
Guido van Rossum67345eb2001-01-18 14:51:12 +0000101http://www.python.org/. Come visit us!
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000102
Michael W. Hudsonbe6e0f42002-06-23 16:29:36 +0000103There's also a Python community web site at
104http://starship.python.net/.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000105
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000106
107Newsgroups and Mailing Lists
108----------------------------
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000109
110Read comp.lang.python, a high-volume discussion newsgroup about
111Python, or comp.lang.python.announce, a low-volume moderated newsgroup
112for Python-related announcements. These are also accessible as
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000113mailing lists: see http://www.python.org/psa/MailingLists.html for an
114overview of the many Python-related mailing lists.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000115
Michael W. Hudsonbe6e0f42002-06-23 16:29:36 +0000116Archives are accessible via the Google Groups usenet archive; see
117http://groups.google.com/. The mailing lists are also archived, see
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000118http://www.python.org/psa/MailingLists.html for details.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000119
120
121Bug reports
122-----------
123
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000124To report or search for bugs, please use the Python Bug
125Tracker at http://sourceforge.net/bugs/?group_id=5470.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000126
127
128Patches and contributions
129-------------------------
130
Fred Drake6caae142000-10-25 17:51:02 +0000131To submit a patch or other contribution, please use the Python Patch
132Manager at http://sourceforge.net/patch/?group_id=5470. Guidelines
133for patch submission may be found at http://www.python.org/patches/.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000134
135If you have a proposal to change Python, it's best to submit a Python
136Enhancement Proposal (PEP) first. All current PEPs, as well as
Walter Dörwald7dc65d62003-02-02 23:37:05 +0000137guidelines for submitting a new PEP, are listed at
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000138http://python.sourceforge.net/peps/.
139
140
141Questions
142---------
143
144For help, if you can't find it in the manuals or on the web site, it's
145best to post to the comp.lang.python or the Python mailing list (see
146above). If you specifically don't want to involve the newsgroup or
Guido van Rossum67345eb2001-01-18 14:51:12 +0000147mailing list, send questions to help@python.org (a group of volunteers
148who answer questions as they can). The newsgroup is the most
149efficient way to ask public questions.
Guido van Rossum627b2d71993-12-24 10:39:16 +0000150
Guido van Rossum901454e2000-06-29 22:28:44 +0000151
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000152Build instructions
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000153==================
Guido van Rossum627b2d71993-12-24 10:39:16 +0000154
Guido van Rossum59b0b602002-02-08 22:22:35 +0000155Before you can build Python, you must first configure it.
156Fortunately, the configuration and build process has been automated
157for Unix and Linux installations, so all you usually have to do is
158type a few commands and sit back. There are some platforms where
159things are not quite as smooth; see the platform specific notes below.
160If you want to build for multiple platforms sharing the same source
161tree, see the section on VPATH below.
Guido van Rossum627b2d71993-12-24 10:39:16 +0000162
Guido van Rossum59b0b602002-02-08 22:22:35 +0000163Start by running the script "./configure", which determines your
164system configuration and creates the Makefile. (It takes a minute or
165two -- please be patient!) You may want to pass options to the
166configure script -- see the section below on configuration options and
167variables. When it's done, you are ready to run make.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000168
Guido van Rossum59b0b602002-02-08 22:22:35 +0000169To build Python, you normally type "make" in the toplevel directory.
170If you have changed the configuration, the Makefile may have to be
171rebuilt. In this case you may have to run make again to correctly
172build your desired target. The interpreter executable is built in the
173top level directory.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000174
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000175Once you have built a Python interpreter, see the subsections below on
Guido van Rossum59b0b602002-02-08 22:22:35 +0000176testing and installation. If you run into trouble, see the next
177section.
178
179Previous versions of Python used a manual configuration process that
180involved editing the file Modules/Setup. While this file still exists
181and manual configuration is still supported, it is rarely needed any
182more: almost all modules are automatically built as appropriate under
183guidance of the setup.py script, which is run by Make after the
184interpreter has been built.
Guido van Rossum627b2d71993-12-24 10:39:16 +0000185
Guido van Rossum0a516c91994-09-12 10:58:40 +0000186
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000187Troubleshooting
188---------------
Guido van Rossum627b2d71993-12-24 10:39:16 +0000189
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000190See also the platform specific notes in the next section.
191
Guido van Rossum49523691997-08-15 18:30:14 +0000192If you run into other trouble, see section 3 of the FAQ
Guido van Rossum901454e2000-06-29 22:28:44 +0000193(http://www.python.org/cgi-bin/faqw.py or
Guido van Rossum49523691997-08-15 18:30:14 +0000194http://www.python.org/doc/FAQ.html) for hints on what can go wrong,
195and how to fix it.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000196
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000197If you rerun the configure script with different options, remove all
198object files by running "make clean" before rebuilding. Believe it or
199not, "make clean" sometimes helps to clean up other inexplicable
200problems as well. Try it before sending in a bug report!
201
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000202If the configure script fails or doesn't seem to find things that
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000203should be there, inspect the config.log file. When you fix a
204configure problem, be sure to remove config.cache!
205
206If you get a warning for every file about the -Olimit option being no
207longer supported, you can ignore it. There's no foolproof way to know
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000208whether this option is needed; all we can do is test whether it is
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000209accepted without error. On some systems, e.g. older SGI compilers, it
210is essential for performance (specifically when compiling ceval.c,
211which has more basic blocks than the default limit of 1000). If the
212warning bothers you, edit the Makefile to remove "-Olimit 1500" from
213the OPT variable.
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000214
Guido van Rossum7ac11532000-08-29 21:36:40 +0000215If you get failures in test_long, or sys.maxint gets set to -1, you
216are probably experiencing compiler bugs, usually related to
Martin v. Löwis9cea5f52002-11-15 07:28:05 +0000217optimization. This is a common problem with some versions of gcc, and
218some vendor-supplied compilers, which can sometimes be worked around
219by turning off optimization. Consider switching to stable versions
220(gcc 2.95.2, or contact your vendor.)
Guido van Rossum7ac11532000-08-29 21:36:40 +0000221
222From Python 2.0 onward, all Python C code is ANSI C. Compiling using
223old K&R-C-only compilers is no longer possible. ANSI C compilers are
224available for all modern systems, either in the form of updated
Martin v. Löwis9cea5f52002-11-15 07:28:05 +0000225compilers from the vendor, or one of the free compilers (gcc).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000226
Martin v. Löwis779ffc02002-12-02 22:17:01 +0000227Unsupported systems
228-------------------
229
230A number of features are not supported in Python 2.3 anymore. Some
231support code is still present, but will be removed in Python 2.4.
232If you still need to use current Python versions on these systems,
233please send a message to python-dev@python.org indicating that you
234volunteer to support this system.
235
236More specifically, the following systems are not supported any
237longer:
238- SunOS 4
239- DYNIX
240- dgux
241- Minix
242- Irix 4 and --with-sgi-dl
243- Linux 1
244- Systems defining __d6_pthread_create (configure.in)
245- Systems defining PY_PTHREAD_D4, PY_PTHREAD_D6,
246 or PY_PTHREAD_D7 in thread_pthread.h
247- Systems using --with-dl-dld
Martin v. Löwis7e4cfcb2002-12-19 16:21:49 +0000248- Systems using --without-universal-newlines
Martin v. Löwis779ffc02002-12-02 22:17:01 +0000249
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000250Platform specific notes
251-----------------------
252
Guido van Rossum0447a321995-10-08 01:22:33 +0000253(Some of these may no longer apply. If you find you can build Python
Guido van Rossum67345eb2001-01-18 14:51:12 +0000254on these platforms without the special directions mentioned here,
255submit a documentation bug report to SourceForge (see Bug Reports
256above) so we can remove them!)
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000257
Skip Montanaro6dc4a8e2003-05-02 15:27:59 +0000258Unix platforms: If your vendor still ships (and you still use) Berkeley DB
259 1.85 you will need to edit Modules/Setup to build the bsddb185
260 module and add a line to sitecustomize.py which makes it the
261 default. In Modules/Setup a line like
262
263 bsddb185 bsddbmodule.c
264
265 should work. (You may need to add -I, -L or -l flags to direct the
266 compiler and linker to your include files and libraries.) You can
267 then force it to be the version people import by adding
268
269 import bsddb185 as bsddb
270
271 in sitecustomize.py.
272
Guido van Rossumc0be2f51997-10-08 05:05:28 +000027364-bit platforms: The modules audioop, imageop and rgbimg don't work.
Guido van Rossum59b0b602002-02-08 22:22:35 +0000274 The setup.py script disables them on 64-bit installations.
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000275 Don't try to enable them in the Modules/Setup file. They
276 contain code that is quite wordsize sensitive. (If you have a
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000277 fix, let us know!)
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000278
Guido van Rossum4462e931997-01-22 21:00:32 +0000279Solaris: When using Sun's C compiler with threads, at least on Solaris
280 2.5.1, you need to add the "-mt" compiler option (the simplest
281 way is probably to specify the compiler with this option as
282 the "CC" environment variable when running the configure
283 script).
284
Guido van Rossum42992312002-09-23 14:02:18 +0000285 When using GCC on Solaris, beware of binutils 2.13 or GCC
286 versions built using it. This mistakenly enables the
287 -zcombreloc option which creates broken shared libraries on
288 Solaris. binutils 2.12 works, and the binutils maintainers
Skip Montanaro4de9cba2003-01-03 16:26:23 +0000289 are aware of the problem. Binutils 2.13.1 only partially
290 fixed things. It appears that 2.13.2 solves the problem
291 completely. This problem is known to occur with Solaris 2.7
292 and 2.8, but may also affect earlier and later versions of the
293 OS.
Guido van Rossum42992312002-09-23 14:02:18 +0000294
Martin v. Löwis9cea5f52002-11-15 07:28:05 +0000295 When the dynamic loader complains about errors finding shared
296 libraries, such as
297
298 ld.so.1: ./python: fatal: libstdc++.so.5: open failed:
299 No such file or directory
300
301 you need to first make sure that the library is available on
302 your system. Then, you need to instruct the dynamic loader how
Walter Dörwald7dc65d62003-02-02 23:37:05 +0000303 to find it. You can choose any of the following strategies:
Martin v. Löwis9cea5f52002-11-15 07:28:05 +0000304
305 1. When compiling Python, set LD_RUN_PATH to the directories
306 containing missing libraries.
307 2. When running Python, set LD_LIBRARY_PATH to these directories.
308 3. Use crle(8) to extend the search path of the loader.
309 4. Modify the installed GCC specs file, adding -R options into the
310 *link: section.
311
Guido van Rossum7ac11532000-08-29 21:36:40 +0000312Linux: A problem with threads and fork() was tracked down to a bug in
313 the pthreads code in glibc version 2.0.5; glibc version 2.0.7
314 solves the problem. This causes the popen2 test to fail;
315 problem and solution reported by Pablo Bleyer.
Guido van Rossum4462e931997-01-22 21:00:32 +0000316
Guido van Rossum7ac11532000-08-29 21:36:40 +0000317 Under Linux systems using GNU libc 2 (aka libc6), the crypt
Guido van Rossum59b0b602002-02-08 22:22:35 +0000318 module now needs the -lcrypt option. The setup.py script
319 takes care of this automatically.
Fred Drake61280911997-12-08 14:10:40 +0000320
Martin v. Löwis3efa04a2003-06-14 05:29:27 +0000321Red Hat Linux: Red Hat 9 built Python2.2 in UCS-4 mode and hacked
322 Tcl to support it. To compile Python2.3 with Tkinter, you will
323 need to pass --enable-unicode=ucs4 flag to ./configure.
324
325 There's an executable /usr/bin/python which is Python
326 1.5.2 on most older Red Hat installations; several key Red Hat tools
Guido van Rossum2dcec0c2002-02-04 01:59:23 +0000327 require this version. Python 2.1.x may be installed as
328 /usr/bin/python2. The Makefile installs Python as
329 /usr/local/bin/python, which may or may not take precedence
330 over /usr/bin/python, depending on how you have set up $PATH.
331
Guido van Rossum59230501999-06-21 20:51:46 +0000332FreeBSD 3.x and probably platforms with NCurses that use libmytinfo or
333 similar: When using cursesmodule, the linking is not done in
334 the correct order with the defaults. Remove "-ltermcap" from
335 the readline entry in Setup, and use as curses entry: "curses
336 cursesmodule.c -lmytinfo -lncurses -ltermcap" - "mytinfo" (so
337 called on FreeBSD) should be the name of the auxiliary library
338 required on your platform. Normally, it would be linked
339 automatically, but not necessarily in the correct order.
340
Guido van Rossum7ac11532000-08-29 21:36:40 +0000341BSDI: BSDI versions before 4.1 have known problems with threads,
342 which can cause strange errors in a number of modules (for
343 instance, the 'test_signal' test script will hang forever.)
344 Turning off threads (with --with-threads=no) or upgrading to
345 BSDI 4.1 solves this problem.
346
347DEC Unix: Run configure with --with-dec-threads, or with
348 --with-threads=no if no threads are desired (threads are on by
349 default). When using GCC, it is possible to get an internal
350 compiler error if optimization is used. This was reported for
351 GCC 2.7.2.3 on selectmodule.c. Manually compile the affected
352 file without optimization to solve the problem.
Guido van Rossum8eca2c21996-02-14 18:37:46 +0000353
Guido van Rossume1cdb161999-04-10 16:04:07 +0000354DEC Ultrix: compile with GCC to avoid bugs in the native compiler,
355 and pass SHELL=/bin/sh5 to Make when installing.
356
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000357AIX: A complete overhaul of the shared library support is now in
Guido van Rossum16e809e2001-04-16 02:07:08 +0000358 place. See Misc/AIX-NOTES for some notes on how it's done.
Guido van Rossum9ac9a261998-02-16 22:19:21 +0000359 (The optimizer bug reported at this place in previous releases
Thomas Wouters8ee06142001-02-15 11:45:29 +0000360 has been worked around by a minimal code change.) If you get
Fred Drake59518b02002-05-11 03:36:26 +0000361 errors about pthread_* functions, during compile or during
Thomas Wouters8ee06142001-02-15 11:45:29 +0000362 testing, try setting CC to a thread-safe (reentrant) compiler,
363 like "cc_r". For full C++ module support, set CC="xlC_r" (or
364 CC="xlC" without thread support).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000365
Skip Montanaro2d98db62003-01-06 17:23:37 +0000366HP-UX: When using threading, you may have to add -D_REENTRANT to the
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000367 OPT variable in the top-level Makefile; reported by Pat Knight,
Guido van Rossum59a88f41999-04-12 18:16:09 +0000368 this seems to make a difference (at least for HP-UX 10.20)
Anthony Baxter9b32acd2003-09-23 15:01:49 +0000369 even though pyconfig.h defines it. Experience seems to show that
370 building with HP's compiler works best if you set CC="cc -Ae".
Guido van Rossum2094e041998-05-14 15:47:35 +0000371
Guido van Rossum4e1dd7d2002-04-23 13:06:07 +0000372HP PA-RISC 2.0: A recent bug report (http://www.python.org/sf/546117)
373 suggests that the C compiler in this 64-bit system has bugs
374 in the optimizer that break Python. Compiling without
375 optimization solves the problems.
376
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000377SCO: The following apply to SCO 3 only; Python builds out of the box
378 on SCO 5 (or so we've heard).
Guido van Rossuma16e2751998-04-13 20:14:05 +0000379
380 1) Everything works much better if you add -U__STDC__ to the
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000381 defs. This is because all the SCO header files are broken.
Guido van Rossum64773801997-11-26 17:07:02 +0000382 Anything that isn't mentioned in the C standard is
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000383 conditionally excluded when __STDC__ is defined.
384
385 2) Due to the U.S. export restrictions, SCO broke the crypt
386 stuff out into a separate library, libcrypt_i.a so the LIBS
387 needed be set to:
388
389 LIBS=' -lsocket -lcrypt_i'
390
Martin v. Löwis387c5472001-09-06 08:16:17 +0000391UnixWare: There are known bugs in the math library of the system, as well as
392 problems in the handling of threads (calling fork in one
393 thread may interrupt system calls in others). Therefore, test_math and
394 tests involving threads will fail until those problems are fixed.
395
Guido van Rossum7ac11532000-08-29 21:36:40 +0000396SunOS 4.x: When using the SunPro C compiler, you may want to use the
Guido van Rossum64773801997-11-26 17:07:02 +0000397 '-Xa' option instead of '-Xc', to enable some needed non-ANSI
398 Sunisms.
Martin v. Löwis779ffc02002-12-02 22:17:01 +0000399 THIS SYSTEM IS NO LONGER SUPPORTED.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000400
Jack Jansena39ef862001-08-19 21:17:03 +0000401NeXT: Not supported anymore. Start with the MacOSX/Darwin code if you
402 want to revive it.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000403
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000404QNX: Chris Herborth (chrish@qnx.com) writes:
405 configure works best if you use GNU bash; a port is available on
406 ftp.qnx.com in /usr/free. I used the following process to build,
Guido van Rossumd4493421998-12-22 16:37:01 +0000407 test and install Python 1.5.x under QNX:
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000408
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000409 1) CONFIG_SHELL=/usr/local/bin/bash CC=cc RANLIB=: \
410 ./configure --verbose --without-gcc --with-libm=""
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000411
Fred Drake80078492000-10-26 17:13:19 +0000412 2) edit Modules/Setup to activate everything that makes sense for
413 your system... tested here at QNX with the following modules:
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000414
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000415 array, audioop, binascii, cPickle, cStringIO, cmath,
416 crypt, curses, errno, fcntl, gdbm, grp, imageop,
417 _locale, math, md5, new, operator, parser, pcre,
418 posix, pwd, readline, regex, reop, rgbimg, rotor,
419 select, signal, socket, soundex, strop, struct,
Guido van Rossumd4493421998-12-22 16:37:01 +0000420 syslog, termios, time, timing, zlib, audioop, imageop, rgbimg
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000421
Guido van Rossum16e809e2001-04-16 02:07:08 +0000422 3) make SHELL=/usr/local/bin/bash
423
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000424 or, if you feel the need for speed:
Guido van Rossum16e809e2001-04-16 02:07:08 +0000425
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000426 make SHELL=/usr/local/bin/bash OPT="-5 -Oil+nrt"
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000427
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000428 4) make SHELL=/usr/local/bin/bash test
429
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000430 Using GNU readline 2.2 seems to behave strangely, but I
431 think that's a problem with my readline 2.2 port. :-\
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000432
433 5) make SHELL=/usr/local/bin/bash install
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000434
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000435 If you get SIGSEGVs while running Python (I haven't yet, but
436 I've only run small programs and the test cases), you're
437 probably running out of stack; the default 32k could be a
438 little tight. To increase the stack size, edit the Makefile
Neil Schemenauer73f8ab22001-01-26 22:18:55 +0000439 to read: LDFLAGS = -N 48k
Guido van Rossum40d63581997-08-14 19:45:30 +0000440
Skip Montanaro2d98db62003-01-06 17:23:37 +0000441BeOS: See Misc/BeOS-NOTES for notes about compiling/installing
442 Python on BeOS R3 or later. Note that only the PowerPC
443 platform is supported for R3; both PowerPC and x86 are
444 supported for R4.
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000445
Michael W. Hudson33876f52002-07-31 09:55:25 +0000446Cray T3E: Mark Hadfield (m.hadfield@niwa.co.nz) writes:
447 Python can be built satisfactorily on a Cray T3E but based on
448 my experience with the NIWA T3E (2002-05-22, version 2.2.1)
449 there are a few bugs and gotchas. For more information see a
450 thread on comp.lang.python in May 2002 entitled "Building
451 Python on Cray T3E".
452
453 1) Use Cray's cc and not gcc. The latter was reported not to
454 work by Konrad Hinsen. It may work now, but it may not.
455
456 2) To set sys.platform to something sensible, pass the
457 following environment variable to the configure script:
458
459 MACHDEP=unicosmk
460
461 2) Run configure with option "--enable-unicode=ucs4".
462
463 3) The Cray T3E does not support dynamic linking, so extension
464 modules have to be built by adding (or uncommenting) lines
465 in Modules/Setup. The minimum set of modules is
466
467 posix, new, _sre, unicodedata
468
469 On NIWA's vanilla T3E system the following have also been
470 included successfully:
471
472 _codecs, _locale, _socket, _symtable, _testcapi, _weakref
473 array, binascii, cmath, cPickle, crypt, cStringIO, dbm
474 errno, fcntl, grp, math, md5, operator, parser, pcre, pwd
475 regex, rotor, select, struct, strop, syslog, termios
476 time, timing, xreadlines
477
478 4) Once the python executable and library have been built, make
479 will execute setup.py, which will attempt to build remaining
480 extensions and link them dynamically. Each of these attempts
481 will fail but should not halt the make process. This is
482 normal.
483
484 5) Running "make test" uses a lot of resources and causes
485 problems on our system. You might want to try running tests
486 singly or in small groups.
Guido van Rossum1bf0bf41997-08-20 23:50:51 +0000487
Guido van Rossum0078aaf1997-08-21 03:05:11 +0000488SGI: SGI's standard "make" utility (/bin/make or /usr/bin/make)
489 does not check whether a command actually changed the file it
490 is supposed to build. This means that whenever you say "make"
491 it will redo the link step. The remedy is to use SGI's much
Guido van Rossum7be8ca02001-04-14 13:09:53 +0000492 smarter "smake" utility (/usr/sbin/smake), or GNU make. If
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000493 you set the first line of the Makefile to #!/usr/sbin/smake
494 smake will be invoked by make (likewise for GNU make).
Guido van Rossum0078aaf1997-08-21 03:05:11 +0000495
Guido van Rossum7be8ca02001-04-14 13:09:53 +0000496 WARNING: There are bugs in the optimizer of some versions of
497 SGI's compilers that can cause bus errors or other strange
498 behavior, especially on numerical operations. To avoid this,
499 try building with "make OPT=".
Fred Drake0b5fb2b2000-09-29 17:45:05 +0000500
Guido van Rossum64773801997-11-26 17:07:02 +0000501OS/2: If you are running Warp3 or Warp4 and have IBM's VisualAge C/C++
502 compiler installed, just change into the pc\os2vacpp directory
503 and type NMAKE. Threading and sockets are supported by default
504 in the resulting binaries of PYTHON15.DLL and PYTHON.EXE.
505
Fred Drake36ed5602000-10-06 01:58:48 +0000506Monterey (64-bit AIX): The current Monterey C compiler (Visual Age)
507 uses the OBJECT_MODE={32|64} environment variable to set the
508 compilation mode to either 32-bit or 64-bit (32-bit mode is
509 the default). Presumably you want 64-bit compilation mode for
510 this 64-bit OS. As a result you must first set OBJECT_MODE=64
511 in your environment before configuring (./configure) or
512 building (make) Python on Monterey.
513
514Reliant UNIX: The thread support does not compile on Reliant UNIX, and
515 there is a (minor) problem in the configure script for that
516 platform as well. This should be resolved in time for a
517 future release.
Trent Mick635f6fb2000-08-23 21:33:05 +0000518
Barry Warsaw6a8557d2002-10-14 18:04:39 +0000519MacOSX: The tests will crash on both 10.1 and 10.2 with SEGV in
Barry Warsaw6e753642002-10-14 18:15:35 +0000520 test_re and test_sre due to the small default stack size. If
521 you set the stack size to 2048 before doing a "make test" the
522 failure can be avoided. If you're using the tcsh (the default
523 on OSX), or csh shells use "limit stacksize 2048" and for the
524 bash shell, use "ulimit -s 2048".
Barry Warsaw06557452001-12-14 20:47:12 +0000525
Jack Jansen6a77cf12001-12-06 21:49:02 +0000526 On naked Darwin you may want to add the configure option
Jack Jansen4c398fd2001-10-08 13:21:15 +0000527 "--disable-toolbox-glue" to disable the glue code for the Carbon
Jack Jansen6a77cf12001-12-06 21:49:02 +0000528 interface modules. The modules themselves are currently only built
529 if you add the --enable-framework option, see below.
Barry Warsaw06557452001-12-14 20:47:12 +0000530
531 On a clean OSX /usr/local does not exist. Do a
Jack Jansen61fec302002-01-04 15:59:57 +0000532 "sudo mkdir -m 775 /usr/local"
Jack Jansen84a01642002-08-04 21:19:55 +0000533 before you do a make install. It is probably not a good idea to
534 do "sudo make install" which installs everything as superuser,
535 as this may later cause problems when installing distutils-based
536 additions.
537
538 Some people have reported problems building Python after using "fink"
539 to install additional unix software. Disabling fink (remove all references
540 to /sw from your .profile or .login) should solve this.
Barry Warsaw06557452001-12-14 20:47:12 +0000541
542 You may want to try the configure option "--enable-framework"
543 which installs Python as a framework. The location can be set
544 as argument to the --enable-framework option (default
Jack Jansen84a01642002-08-04 21:19:55 +0000545 /Library/Frameworks). A framework install is probably needed if you
546 want to use any Aqua-based GUI toolkit (whether Tkinter, wxPython,
547 Carbon, Cocoa or anything else).
548
549 See Mac/OSX/README for more information on framework builds.
Fred Drakedabed752001-02-01 19:41:13 +0000550
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000551Cygwin: With recent (relative to the time of writing, 2001-12-19)
552 Cygwin installations, there are problems with the interaction
553 of dynamic linking and fork(). This manifests itself in build
554 failures during the execution of setup.py.
Tim Peters42fc7cc2001-04-04 18:35:19 +0000555
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000556 There are two workarounds that both enable Python (albeit
557 without threading support) to build and pass all tests on
558 NT/2000 (and most likely XP as well, though reports of testing
559 on XP would be appreciated).
Guido van Rossum16e809e2001-04-16 02:07:08 +0000560
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000561 The workarounds:
562
563 (a) the band-aid fix is to link the _socket module statically
564 rather than dynamically (which is the default).
565
566 To do this, run "./configure --with-threads=no" including any
567 other options you need (--prefix, etc.). Then in Modules/Setup
Walter Dörwald7dc65d62003-02-02 23:37:05 +0000568 uncomment the lines:
Tim Peters42fc7cc2001-04-04 18:35:19 +0000569
Michael W. Hudsonbe5ce182001-12-12 11:46:52 +0000570 #SSL=/usr/local/ssl
571 #_socket socketmodule.c \
572 # -DUSE_SSL -I$(SSL)/include -I$(SSL)/include/openssl \
573 # -L$(SSL)/lib -lssl -lcrypto
Guido van Rossum16e809e2001-04-16 02:07:08 +0000574
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000575 and remove "local/" from the SSL variable. Finally, just run
576 "make"!
Tim Peters42fc7cc2001-04-04 18:35:19 +0000577
Michael W. Hudsonb6554642001-12-19 22:09:09 +0000578 (b) The "proper" fix is to rebase the Cygwin DLLs to prevent
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000579 base address conflicts. Details on how to do this can be
580 found in the following mail:
581
582 http://sources.redhat.com/ml/cygwin/2001-12/msg00894.html
583
584 It is hoped that a version of this solution will be
Michael W. Hudsonb6554642001-12-19 22:09:09 +0000585 incorporated into the Cygwin distribution fairly soon.
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000586
587 Two additional problems:
588
589 (1) Threading support should still be disabled due to a known
590 bug in Cygwin pthreads that causes test_threadedtempfile to
591 hang.
592
Neal Norwitz4ebde092001-12-19 20:44:13 +0000593 (2) The _curses module does not build. This is a known
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000594 Cygwin ncurses problem that should be resolved the next time
595 that this package is released.
Guido van Rossum16e809e2001-04-16 02:07:08 +0000596
Michael W. Hudsonbe5ce182001-12-12 11:46:52 +0000597 On older versions of Cygwin, test_poll may hang and test_strftime
598 may fail.
Tim Peters42fc7cc2001-04-04 18:35:19 +0000599
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000600 The situation on 9X/Me is not accurately known at present.
601 Some time ago, there were reports that the following
602 regression tests failed:
Tim Peters42fc7cc2001-04-04 18:35:19 +0000603
604 test_pwd
605 test_select (hang)
606 test_socket
607
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000608 Due to the test_select hang on 9X/Me, one should run the
609 regression test using the following:
Tim Peters42fc7cc2001-04-04 18:35:19 +0000610
Michael W. Hudsonbe5ce182001-12-12 11:46:52 +0000611 make TESTOPTS='-l -x test_select' test
Tim Peters42fc7cc2001-04-04 18:35:19 +0000612
Michael W. Hudson1c4523f2001-12-19 19:49:58 +0000613 News regarding these platforms with more recent Cygwin
614 versions would be appreciated!
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000615
Skip Montanaro56d83012003-01-04 04:05:51 +0000616AtheOS: From Octavian Cerna <tavy at ylabs.com>:
617
618 Before building:
619
620 Make sure you have shared versions of the libraries you
621 want to use with Python. You will have to compile them
622 yourself, or download precompiled packages.
623
624 Recommended libraries:
625
626 ncurses-4.2
627 readline-4.2a
628 zlib-1.1.4
629
630 Build:
631
632 $ ./configure --prefix=/usr/python
633 $ make
634
635 Python is always built as a shared library, otherwise
636 dynamic loading would not work.
637
638 Testing:
639
640 $ make test
641
642 Install:
643
644 # make install
645 # pkgmanager -a /usr/python
646
647
648 AtheOS issues:
649
650 - large file support: due to a stdio bug in glibc/libio,
651 access to large files may not work correctly. fseeko()
652 tries to seek to a negative offset. ftello() returns a
653 negative offset, it looks like a 32->64bit
654 sign-extension issue. The lowlevel functions (open,
655 lseek, etc) are OK.
656 - sockets: AF_UNIX is defined in the C library and in
657 Python, but not implemented in the system.
658 - select: poll is available in the C library, but does not
659 work (It does not return POLLNVAL for bad fds and
660 hangs).
661 - posix: statvfs and fstatvfs always return ENOSYS.
662 - disabled modules:
663 - mmap: not yet implemented in AtheOS
664 - nis: broken (on an unconfigured system
665 yp_get_default_domain() returns junk instead of
666 error)
667 - dl: dynamic loading doesn't work via dlopen()
668 - resource: getrimit and setrlimit are not yet
669 implemented
670
671 - if you are getting segmentation faults, you probably are
672 low on memory. AtheOS doesn't handle very well an
673 out-of-memory condition and simply SEGVs the process.
674
675 Tested on:
676
677 AtheOS-0.3.7
678 gcc-2.95
679 binutils-2.10
680 make-3.78
681
682
Skip Montanaro57454e52002-06-14 20:30:31 +0000683Configuring the bsddb and dbm modules
684-------------------------------------
685
Skip Montanaro56d83012003-01-04 04:05:51 +0000686Beginning with Python version 2.3, the PyBsddb package
687<http://pybsddb.sf.net/> was adopted into Python as the bsddb package,
688exposing a set of package-level functions which provide
689backwards-compatible behavior. Only versions 3.1 through 4.1 of
690Sleepycat's libraries provide the necessary API, so older versions
691aren't supported through this interface. The old bsddb module has
692been retained as bsddb185, though it is not built by default. Users
693wishing to use it will have to tweak Modules/Setup to build it. The
694dbm module will still be built against the Sleepycat libraries if
695other preferred alternatives (ndbm, gdbm) are not found, though
696versions of the Sleepycat library prior to 3.1 are not considered.
Guido van Rossum62d45c02002-12-02 15:49:13 +0000697
Skip Montanaro57454e52002-06-14 20:30:31 +0000698
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000699Configuring threads
700-------------------
701
Guido van Rossum7ac11532000-08-29 21:36:40 +0000702As of Python 2.0, threads are enabled by default. If you wish to
703compile without threads, or if your thread support is broken, pass the
704--with-threads=no switch to configure. Unfortunately, on some
705platforms, additional compiler and/or linker options are required for
706threads to work properly. Below is a table of those options,
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000707collected by Bill Janssen. We would love to automate this process
Guido van Rossum7ac11532000-08-29 21:36:40 +0000708more, but the information below is not enough to write a patch for the
709configure.in file, so manual intervention is required. If you patch
710the configure.in file and are confident that the patch works, please
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000711send in the patch. (Don't bother patching the configure script itself
Walter Dörwald7dc65d62003-02-02 23:37:05 +0000712-- it is regenerated each time the configure.in file changes.)
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000713
714Compiler switches for threads
715.............................
716
Martin v. Löwis1c24f9c2001-03-06 12:07:27 +0000717The definition of _REENTRANT should be configured automatically, if
718that does not work on your system, or if _REENTRANT is defined
719incorrectly, please report that as a bug.
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000720
Martin v. Löwis1c24f9c2001-03-06 12:07:27 +0000721 OS/Compiler/threads Switches for use with threads
722 (POSIX is draft 10, DCE is draft 4) compile & link
723
724 SunOS 5.{1-5}/{gcc,SunPro cc}/solaris -mt
725 SunOS 5.5/{gcc,SunPro cc}/POSIX (nothing)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000726 DEC OSF/1 3.x/cc/DCE -threads
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000727 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000728 Digital UNIX 4.x/cc/DCE -threads
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000729 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000730 Digital UNIX 4.x/cc/POSIX -pthread
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000731 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000732 AIX 4.1.4/cc_r/d7 (nothing)
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000733 (buhrt@iquest.net)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000734 AIX 4.1.4/cc_r4/DCE (nothing)
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000735 (buhrt@iquest.net)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000736 IRIX 6.2/cc/POSIX (nothing)
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000737 (robertl@cwi.nl)
738
739
740Linker (ld) libraries and flags for threads
741...........................................
742
743 OS/threads Libraries/switches for use with threads
744
745 SunOS 5.{1-5}/solaris -lthread
746 SunOS 5.5/POSIX -lpthread
Guido van Rossum16e809e2001-04-16 02:07:08 +0000747 DEC OSF/1 3.x/DCE -lpthreads -lmach -lc_r -lc
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000748 (butenhof@zko.dec.com)
749 Digital UNIX 4.x/DCE -lpthreads -lpthread -lmach -lexc -lc
750 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000751 Digital UNIX 4.x/POSIX -lpthread -lmach -lexc -lc
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000752 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000753 AIX 4.1.4/{draft7,DCE} (nothing)
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000754 (buhrt@iquest.net)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000755 IRIX 6.2/POSIX -lpthread
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000756 (jph@emilia.engr.sgi.com)
757
758
Martin v. Löwis1142de32002-03-29 16:28:31 +0000759Building a shared libpython
760---------------------------
761
762Starting with Python 2.3, the majority of the interpreter can be built
763into a shared library, which can then be used by the interpreter
764executable, and by applications embedding Python. To enable this feature,
Martin v. Löwis65069672002-08-03 21:38:27 +0000765configure with --enable-shared.
766
Fred Drake55512dc2003-07-21 16:01:39 +0000767If you enable this feature, the same object files will be used to create
768a static library. In particular, the static library will contain object
769files using position-independent code (PIC) on platforms where PIC flags
770are needed for the shared library.
Martin v. Löwis1142de32002-03-29 16:28:31 +0000771
772
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000773Configuring additional built-in modules
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000774---------------------------------------
Guido van Rossum19e0c261995-01-17 16:36:34 +0000775
Andrew M. Kuchlingebe30452001-02-27 03:24:24 +0000776Starting with Python 2.1, the setup.py script at the top of the source
777distribution attempts to detect which modules can be built and
778automatically compiles them. Autodetection doesn't always work, so
Guido van Rossum59b0b602002-02-08 22:22:35 +0000779you can still customize the configuration by editing the Modules/Setup
780file; but this should be considered a last resort. The rest of this
781section only applies if you decide to edit the Modules/Setup file.
782You also need this to enable static linking of certain modules (which
783is needed to enable profiling on some systems).
784
Andrew M. Kuchlingebe30452001-02-27 03:24:24 +0000785This file is initially copied from Setup.dist by the configure script;
786if it does not exist yet, create it by copying Modules/Setup.dist
787yourself (configure will never overwrite it). Never edit Setup.dist
788-- always edit Setup or Setup.local (see below). Read the comments in
789the file for information on what kind of edits are allowed. When you
790have edited Setup in the Modules directory, the interpreter will
Guido van Rossumef67ded2001-10-05 17:04:42 +0000791automatically be rebuilt the next time you run make (in the toplevel
792directory).
Guido van Rossum627b2d71993-12-24 10:39:16 +0000793
Andrew M. Kuchlingebe30452001-02-27 03:24:24 +0000794Many useful modules can be built on any Unix system, but some optional
795modules can't be reliably autodetected. Often the quickest way to
796determine whether a particular module works or not is to see if it
797will build: enable it in Setup, then if you get compilation or link
Fred Drake6caae142000-10-25 17:51:02 +0000798errors, disable it -- you're either missing support or need to adjust
799the compilation and linking parameters for that module.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000800
801On SGI IRIX, there are modules that interface to many SGI specific
Andrew M. Kuchlingebe30452001-02-27 03:24:24 +0000802system libraries, e.g. the GL library and the audio hardware. These
803modules will not be built by the setup.py script.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000804
Guido van Rossum4462e931997-01-22 21:00:32 +0000805In addition to the file Setup, you can also edit the file Setup.local.
806(the makesetup script processes both). You may find it more
807convenient to edit Setup.local and leave Setup alone. Then, when
808installing a new Python version, you can copy your old Setup.local
809file.
810
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000811
812Setting the optimization/debugging options
813------------------------------------------
814
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000815If you want or need to change the optimization/debugging options for
816the C compiler, assign to the OPT variable on the toplevel make
817command; e.g. "make OPT=-g" will build a debugging version of Python
818on most platforms. The default is OPT=-O; a value for OPT in the
819environment when the configure script is run overrides this default
820(likewise for CC; and the initial value for LIBS is used as the base
821set of libraries to link with).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000822
Fred Drake6caae142000-10-25 17:51:02 +0000823When compiling with GCC, the default value of OPT will also include
824the -Wall and -Wstrict-prototypes options.
825
826Additional debugging code to help debug memory management problems can
827be enabled by using the --with-pydebug option to the configure script.
828
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000829
Guido van Rossuma68ca352001-10-04 17:00:07 +0000830Profiling
831---------
832
833If you want C profiling turned on, the easiest way is to run configure
834with the CC environment variable to the necessary compiler
835invocation. For example, on Linux, this works for profiling using
836gprof(1):
837
838 CC="gcc -pg" ./configure
839
840Note that on Linux, gprof apparently does not work for shared
841libraries. The Makefile/Setup mechanism can be used to compile and
Walter Dörwald7dc65d62003-02-02 23:37:05 +0000842link most extension modules statically.
Guido van Rossuma68ca352001-10-04 17:00:07 +0000843
844
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000845Testing
846-------
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000847
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000848To test the interpreter, type "make test" in the top-level directory.
Guido van Rossum6ae5d3d1997-05-14 21:39:05 +0000849This runs the test set twice (once with no compiled files, once with
850the compiled files left by the previous test run). The test set
851produces some output. You can generally ignore the messages about
Guido van Rossum59b0b602002-02-08 22:22:35 +0000852skipped tests due to optional features which can't be imported.
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000853If a message is printed about a failed test or a traceback or core
854dump is produced, something is wrong. On some Linux systems (those
Guido van Rossum24df6841997-12-30 04:32:30 +0000855that are not yet using glibc 6), test_strftime fails due to a
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000856non-standard implementation of strftime() in the C library. Please
857ignore this, or upgrade to glibc version 6.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000858
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000859IMPORTANT: If the tests fail and you decide to mail a bug report,
860*don't* include the output of "make test". It is useless. Run the
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000861failing test manually, as follows:
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000862
Andrew M. Kuchling83d042d2002-03-21 23:52:20 +0000863 ./python ./Lib/test/test_whatever.py
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000864
Andrew M. Kuchling83d042d2002-03-21 23:52:20 +0000865(substituting the top of the source tree for '.' if you built in a
Guido van Rossum6ae5d3d1997-05-14 21:39:05 +0000866different directory). This runs the test in verbose mode.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000867
868
869Installing
870----------
871
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000872To install the Python binary, library modules, shared library modules
873(see below), include files, configuration files, and the manual page,
Guido van Rossum64773801997-11-26 17:07:02 +0000874just type
875
876 make install
877
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000878This will install all platform-independent files in subdirectories of
879the directory given with the --prefix option to configure or to the
880`prefix' Make variable (default /usr/local). All binary and other
881platform-specific files will be installed in subdirectories if the
882directory given by --exec-prefix or the `exec_prefix' Make variable
883(defaults to the --prefix directory) is given.
Guido van Rossum64773801997-11-26 17:07:02 +0000884
Martin v. Löwis3b8ee082003-05-11 20:25:35 +0000885If DESTDIR is set, it will be taken as the root directory of the
886installation, and files will be installed into $(DESTDIR)$(prefix),
887$(DESTDIR)$(exec_prefix), etc.
888
Guido van Rossum64773801997-11-26 17:07:02 +0000889All subdirectories created will have Python's version number in their
890name, e.g. the library modules are installed in
Guido van Rossum67345eb2001-01-18 14:51:12 +0000891"/usr/local/lib/python<version>/" by default, where <version> is the
892<major>.<minor> release number (e.g. "2.1"). The Python binary is
893installed as "python<version>" and a hard link named "python" is
894created. The only file not installed with a version number in its
895name is the manual page, installed as "/usr/local/man/man1/python.1"
896by default.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000897
Neil Schemenauer0e91dc72001-02-16 04:18:08 +0000898If you have a previous installation of Python that you don't
Guido van Rossum64773801997-11-26 17:07:02 +0000899want to replace yet, use
900
901 make altinstall
902
903This installs the same set of files as "make install" except it
Guido van Rossum67345eb2001-01-18 14:51:12 +0000904doesn't create the hard link to "python<version>" named "python" and
905it doesn't install the manual page at all.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000906
907The only thing you may have to install manually is the Python mode for
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000908Emacs found in Misc/python-mode.el. (But then again, more recent
909versions of Emacs may already have it.) Follow the instructions that
910came with Emacs for installation of site-specific files.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000911
Jack Jansena39ef862001-08-19 21:17:03 +0000912On Mac OS X, if you have configured Python with --enable-framework, you
913should use "make frameworkinstall" to do the installation. Note that this
914installs the Python executable in a place that is not normally on your
915PATH, you may want to set up a symlink in /usr/local/bin.
916
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000917
918Configuration options and variables
919-----------------------------------
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000920
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000921Some special cases are handled by passing options to the configure
922script.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000923
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000924WARNING: if you rerun the configure script with different options, you
925must run "make clean" before rebuilding. Exceptions to this rule:
926after changing --prefix or --exec-prefix, all you need to do is remove
Guido van Rossumb06df271997-08-05 21:50:20 +0000927Modules/getpath.o.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000928
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000929--with(out)-gcc: The configure script uses gcc (the GNU C compiler) if
930 it finds it. If you don't want this, or if this compiler is
931 installed but broken on your platform, pass the option
932 --without-gcc. You can also pass "CC=cc" (or whatever the
933 name of the proper C compiler is) in the environment, but the
934 advantage of using --without-gcc is that this option is
935 remembered by the config.status script for its --recheck
936 option.
Guido van Rossum76be6ed1995-01-02 18:33:54 +0000937
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000938--prefix, --exec-prefix: If you want to install the binaries and the
939 Python library somewhere else than in /usr/local/{bin,lib},
940 you can pass the option --prefix=DIRECTORY; the interpreter
941 binary will be installed as DIRECTORY/bin/python and the
942 library files as DIRECTORY/lib/python/*. If you pass
943 --exec-prefix=DIRECTORY (as well) this overrides the
944 installation prefix for architecture-dependent files (like the
945 interpreter binary). Note that --prefix=DIRECTORY also
946 affects the default module search path (sys.path), when
947 Modules/config.c is compiled. Passing make the option
948 prefix=DIRECTORY (and/or exec_prefix=DIRECTORY) overrides the
949 prefix set at configuration time; this may be more convenient
950 than re-running the configure script if you change your mind
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000951 about the install prefix.
Guido van Rossum76be6ed1995-01-02 18:33:54 +0000952
Guido van Rossum59b0b602002-02-08 22:22:35 +0000953--with-readline: This option is no longer supported. GNU
954 readline is automatically enabled by setup.py when present.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000955
Guido van Rossum7ac11532000-08-29 21:36:40 +0000956--with-threads: On most Unix systems, you can now use multiple
957 threads, and support for this is enabled by default. To
958 disable this, pass --with-threads=no. If the library required
959 for threads lives in a peculiar place, you can use
960 --with-thread=DIRECTORY. IMPORTANT: run "make clean" after
961 changing (either enabling or disabling) this option, or you
962 will get link errors! Note: for DEC Unix use
Guido van Rossum0e13da91998-02-22 04:36:34 +0000963 --with-dec-threads instead.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000964
965--with-sgi-dl: On SGI IRIX 4, dynamic loading of extension modules is
966 supported by the "dl" library by Jack Jansen, which is
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000967 ftp'able from ftp://ftp.cwi.nl/pub/dynload/dl-1.6.tar.Z.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000968 This is enabled (after you've ftp'ed and compiled the dl
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000969 library) by passing --with-sgi-dl=DIRECTORY where DIRECTORY
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000970 is the absolute pathname of the dl library. (Don't bother on
971 IRIX 5, it already has dynamic linking using SunOS style
Martin v. Löwis779ffc02002-12-02 22:17:01 +0000972 shared libraries.) THIS OPTION IS UNSUPPORTED.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000973
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000974--with-dl-dld: Dynamic loading of modules is rumored to be supported
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000975 on some other systems: VAX (Ultrix), Sun3 (SunOS 3.4), Sequent
976 Symmetry (Dynix), and Atari ST. This is done using a
977 combination of the GNU dynamic loading package
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000978 (ftp://ftp.cwi.nl/pub/dynload/dl-dld-1.1.tar.Z) and an
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000979 emulation of the SGI dl library mentioned above (the emulation
980 can be found at
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000981 ftp://ftp.cwi.nl/pub/dynload/dld-3.2.3.tar.Z). To
Guido van Rossum16e809e2001-04-16 02:07:08 +0000982 enable this, ftp and compile both libraries, then call
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000983 configure, passing it the option
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000984 --with-dl-dld=DL_DIRECTORY,DLD_DIRECTORY where DL_DIRECTORY is
985 the absolute pathname of the dl emulation library and
986 DLD_DIRECTORY is the absolute pathname of the GNU dld library.
987 (Don't bother on SunOS 4 or 5, they already have dynamic
Martin v. Löwis779ffc02002-12-02 22:17:01 +0000988 linking using shared libraries.) THIS OPTION IS UNSUPPORTED.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000989
990--with-libm, --with-libc: It is possible to specify alternative
991 versions for the Math library (default -lm) and the C library
992 (default the empty string) using the options
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000993 --with-libm=STRING and --with-libc=STRING, respectively. For
994 example, if your system requires that you pass -lc_s to the C
995 compiler to use the shared C library, you can pass
996 --with-libc=-lc_s. These libraries are passed after all other
997 libraries, the C library last.
Guido van Rossum16e809e2001-04-16 02:07:08 +0000998
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000999--with-libs='libs': Add 'libs' to the LIBS that the python interpreter
1000 is linked against.
Guido van Rossumd02ba451996-07-31 17:36:01 +00001001
Martin v. Löwis2df66942000-12-13 14:14:32 +00001002--with-cxx=<compiler>: Some C++ compilers require that main() is
1003 compiled with the C++ if there is any C++ code in the application.
1004 Specifically, g++ on a.out systems may require that to support
1005 construction of global objects. With this option, the main() function
1006 of Python will be compiled with <compiler>; use that only if you
1007 plan to use C++ extension modules, and if your compiler requires
1008 compilation of main() as a C++ program.
1009
1010
Fred Drake6caae142000-10-25 17:51:02 +00001011--with-pydebug: Enable additional debugging code to help track down
1012 memory management problems. This allows printing a list of all
1013 live objects when the interpreter terminates.
Jack Jansen7b8c7542002-04-14 20:12:41 +00001014
1015--with(out)-universal-newlines: enable reading of text files with
1016 foreign newline convention (default: enabled). In other words,
1017 any of \r, \n or \r\n is acceptable as end-of-line character.
1018 If enabled import and execfile will automatically accept any newline
1019 in files. Python code can open a file with open(file, 'U') to
Martin v. Löwis7e4cfcb2002-12-19 16:21:49 +00001020 read it in universal newline mode. THIS OPTION IS UNSUPPORTED.
Fred Drake6caae142000-10-25 17:51:02 +00001021
Guido van Rossum76be6ed1995-01-02 18:33:54 +00001022
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001023Building for multiple architectures (using the VPATH feature)
1024-------------------------------------------------------------
1025
1026If your file system is shared between multiple architectures, it
1027usually is not necessary to make copies of the sources for each
1028architecture you want to support. If the make program supports the
1029VPATH feature, you can create an empty build directory for each
1030architecture, and in each directory run the configure script (on the
1031appropriate machine with the appropriate options). This creates the
1032necessary subdirectories and the Makefiles therein. The Makefiles
Guido van Rossum4f40c2d2000-09-05 16:46:22 +00001033contain a line VPATH=... which points to a directory containing the
Guido van Rossumd0fe8451996-08-26 03:02:37 +00001034actual sources. (On SGI systems, use "smake -J1" instead of "make" if
1035you use VPATH -- don't try gnumake.)
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001036
1037For example, the following is all you need to build a minimal Python
1038in /usr/tmp/python (assuming ~guido/src/python is the toplevel
1039directory and you want to build in /usr/tmp/python):
1040
1041 $ mkdir /usr/tmp/python
1042 $ cd /usr/tmp/python
1043 $ ~guido/src/python/configure
1044 [...]
1045 $ make
1046 [...]
1047 $
1048
Neil Schemenauer73f8ab22001-01-26 22:18:55 +00001049Note that configure copies the original Setup file to the build
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001050directory if it finds no Setup file there. This means that you can
1051edit the Setup file for each architecture independently. For this
1052reason, subsequent changes to the original Setup file are not tracked
1053automatically, as they might overwrite local changes. To force a copy
1054of a changed original Setup file, delete the target Setup file. (The
1055makesetup script supports multiple input files, so if you want to be
1056fancy you can change the rules to create an empty Setup.local if it
1057doesn't exist and run it with arguments $(srcdir)/Setup Setup.local;
1058however this assumes that you only need to add modules.)
1059
1060
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001061Building on non-UNIX systems
1062----------------------------
1063
Tim Peters03444242000-09-19 00:38:35 +00001064For Windows (2000/NT/ME/98/95), assuming you have MS VC++ 6.0, the
1065project files are in PCbuild, the workspace is pcbuild.dsw. See
1066PCbuild\readme.txt for detailed instructions.
Guido van Rossum8d7d4ed1996-07-30 21:41:07 +00001067
Guido van Rossum31ae2071999-04-12 14:47:30 +00001068For other non-Unix Windows compilers, in particular Windows 3.1 and
1069for OS/2, enter the directory "PC" and read the file "readme.txt".
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001070
1071For the Mac, a separate source distribution will be made available,
1072for use with the CodeWarrior compiler. If you are interested in Mac
1073development, join the PythonMac Special Interest Group
1074(http://www.python.org/sigs/pythonmac-sig/, or send email to
1075pythonmac-sig-request@python.org).
1076
1077Of course, there are also binary distributions available for these
Guido van Rossum67345eb2001-01-18 14:51:12 +00001078platforms -- see http://www.python.org/.
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001079
1080To port Python to a new non-UNIX system, you will have to fake the
1081effect of running the configure script manually (for Mac and PC, this
1082has already been done for you). A good start is to copy the file
Michael W. Hudsonbe6e0f42002-06-23 16:29:36 +00001083pyconfig.h.in to pyconfig.h and edit the latter to reflect the actual
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001084configuration of your system. Most symbols must simply be defined as
10851 only if the corresponding feature is present and can be left alone
Michael W. Hudsonbe6e0f42002-06-23 16:29:36 +00001086otherwise; however the *_t type symbols must be defined as some
1087variant of int if they need to be defined at all.
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001088
Barry Warsaw06557452001-12-14 20:47:12 +00001089For all platforms, it's important that the build arrange to define the
1090preprocessor symbol NDEBUG on the compiler command line in a release
1091build of Python (else assert() calls remain in the code, hurting
1092release-build performance). The Unix, Windows and Mac builds already
1093do this.
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001094
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001095
1096Miscellaneous issues
1097====================
1098
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001099Emacs mode
1100----------
1101
Guido van Rossumc0be2f51997-10-08 05:05:28 +00001102There's an excellent Emacs editing mode for Python code; see the file
1103Misc/python-mode.el. Originally written by the famous Tim Peters, it
Guido van Rossum4f40c2d2000-09-05 16:46:22 +00001104is now maintained by the equally famous Barry Warsaw (it's no
Guido van Rossum67345eb2001-01-18 14:51:12 +00001105coincidence that they now both work on the same team). The latest
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001106version, along with various other contributed Python-related Emacs
Guido van Rossum67345eb2001-01-18 14:51:12 +00001107goodies, is online at http://www.python.org/emacs/python-mode. And
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001108if you are planning to edit the Python C code, please pick up the
Guido van Rossum67345eb2001-01-18 14:51:12 +00001109latest version of CC Mode http://www.python.org/emacs/cc-mode; it
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001110contains a "python" style used throughout most of the Python C source
1111files. (Newer versions of Emacs or XEmacs may already come with the
1112latest version of python-mode.)
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001113
1114
Guido van Rossum59b0b602002-02-08 22:22:35 +00001115Tkinter
1116-------
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001117
Guido van Rossum59b0b602002-02-08 22:22:35 +00001118The setup.py script automatically configures this when it detects a
1119usable Tcl/Tk installation. This requires Tcl/Tk version 8.0 or
Fred Drake8179a9d2000-09-28 23:28:30 +00001120higher.
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001121
Guido van Rossum973e4dc2000-07-01 00:34:39 +00001122For more Tkinter information, see the Tkinter Resource page:
1123http://www.python.org/topics/tkinter/
Guido van Rossumc0be2f51997-10-08 05:05:28 +00001124
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001125There are demos in the Demo/tkinter directory, in the subdirectories
1126guido, matt and www (the matt and guido subdirectories have been
1127overhauled to use more recent Tkinter coding conventions).
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001128
1129Note that there's a Python module called "Tkinter" (capital T) which
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001130lives in Lib/lib-tk/Tkinter.py, and a C module called "_tkinter"
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001131(lower case t and leading underscore) which lives in
Guido van Rossum4f40c2d2000-09-05 16:46:22 +00001132Modules/_tkinter.c. Demos and normal Tk applications import only the
Guido van Rossum59b0b602002-02-08 22:22:35 +00001133Python Tkinter module -- only the latter imports the C _tkinter
1134module. In order to find the C _tkinter module, it must be compiled
1135and linked into the Python interpreter -- the setup.py script does
1136this. In order to find the Python Tkinter module, sys.path must be
1137set correctly -- normal installation takes care of this.
Guido van Rossum84c8c7f1995-08-28 02:44:24 +00001138
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001139
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001140Distribution structure
1141----------------------
1142
Guido van Rossum4f40c2d2000-09-05 16:46:22 +00001143Most subdirectories have their own README files. Most files have
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001144comments.
1145
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001146.cvsignore Additional filename matching patterns for CVS to ignore
1147BeOS/ Files specific to the BeOS port
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001148Demo/ Demonstration scripts, modules and programs
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001149Doc/ Documentation sources (LaTeX)
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001150Grammar/ Input for the parser generator
1151Include/ Public header files
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001152LICENSE Licensing information
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001153Lib/ Python library modules
Michael W. Hudsonbe6e0f42002-06-23 16:29:36 +00001154Mac/ Macintosh specific resources
Neil Schemenauer3f52da52001-01-24 17:49:59 +00001155Makefile.pre.in Source from which config.status creates the Makefile.pre
Guido van Rossumc0be2f51997-10-08 05:05:28 +00001156Misc/ Miscellaneous useful files
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001157Modules/ Implementation of most built-in modules
1158Objects/ Implementation of most built-in object types
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001159PC/ Files specific to PC ports (DOS, Windows, OS/2)
1160PCbuild/ Build directory for Microsoft Visual C++
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001161Parser/ The parser and tokenizer and their input handling
Guido van Rossum4f40c2d2000-09-05 16:46:22 +00001162Python/ The byte-compiler and interpreter
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001163README The file you're reading now
1164Tools/ Some useful programs written in Python
Michael W. Hudsonbe6e0f42002-06-23 16:29:36 +00001165pyconfig.h.in Source from which pyconfig.h is created (GNU autoheader output)
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001166configure Configuration shell script (GNU autoconf output)
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001167configure.in Configuration specification (input for GNU autoconf)
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001168install-sh Shell script used to install files
Guido van Rossum91cb9d21995-04-10 11:47:38 +00001169
1170The following files will (may) be created in the toplevel directory by
1171the configuration and build processes:
1172
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001173Makefile Build rules
Neil Schemenauer3f52da52001-01-24 17:49:59 +00001174Makefile.pre Build rules before running Modules/makesetup
Michael W. Hudsonbe6e0f42002-06-23 16:29:36 +00001175buildno Keeps track of the build number
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001176config.cache Cache of configuration variables
Michael W. Hudsonbe6e0f42002-06-23 16:29:36 +00001177pyconfig.h Configuration header
Guido van Rossumc0be2f51997-10-08 05:05:28 +00001178config.log Log from last configure run
Guido van Rossum4f40c2d2000-09-05 16:46:22 +00001179config.status Status from last run of the configure script
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001180getbuildinfo.o Object file from Modules/getbuildinfo.c
Guido van Rossum67345eb2001-01-18 14:51:12 +00001181libpython<version>.a The library archive
Guido van Rossum6d9cc801996-08-01 17:31:22 +00001182python The executable interpreter
1183tags, TAGS Tags files for vi and Emacs
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001184
1185
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001186That's all, folks!
1187------------------
Guido van Rossum433c8ad1994-08-01 12:07:07 +00001188
1189
Guido van Rossum67345eb2001-01-18 14:51:12 +00001190--Guido van Rossum (home page: http://www.python.org/~guido/)