blob: 12869244baa4304389636150c5578eeab3a52265 [file] [log] [blame]
Guido van Rossum6db412b2001-04-18 04:37:57 +00001This is Python version 2.2
Jeremy Hyltonb6750812000-10-16 18:26:42 +00002==========================
Guido van Rossum91447632000-04-11 17:11:09 +00003
Guido van Rossuma0ea7c12001-03-22 15:29:37 +00004Copyright (c) 2001 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
44current directory and when it finishes, type "make". The section
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000045`Build Instructions' below is still recommended reading, especially
46the part on customizing Modules/Setup.
Guido van Rossum3ff96dd1996-07-30 18:05:04 +000047
48
Guido van Rossum91cb9d21995-04-10 11:47:38 +000049What is Python anyway?
50----------------------
51
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000052Python is an interpreted object-oriented programming language suitable
53(amongst other uses) for distributed application development,
54scripting, numeric computing and system testing. Python is often
55compared to Tcl, Perl, Java, JavaScript, Visual Basic or Scheme. To
56find out more about what Python can do for you, point your browser to
Guido van Rossum67345eb2001-01-18 14:51:12 +000057http://www.python.org/.
Guido van Rossum91cb9d21995-04-10 11:47:38 +000058
59
Guido van Rossumf501b4e1996-10-25 14:32:48 +000060How do I learn Python?
61----------------------
62
Fred Drake0e6444c1999-05-17 19:35:01 +000063The official tutorial is still a good place to start; see
Guido van Rossumd0a42e22000-03-31 20:16:45 +000064http://www.python.org/doc/ for online and downloadable versions, as
65well as a list of other introductions, and reference documentation.
Guido van Rossumf501b4e1996-10-25 14:32:48 +000066
Guido van Rossumd0a42e22000-03-31 20:16:45 +000067There's a quickly growing set of books on Python. See
68http://www.python.org/psa/bookstore/ for a list.
Guido van Rossum8d90f9d1997-05-22 20:13:25 +000069
Guido van Rossumf501b4e1996-10-25 14:32:48 +000070
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000071Documentation
72-------------
Guido van Rossum91cb9d21995-04-10 11:47:38 +000073
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000074All documentation is provided online in a variety of formats. In
75order of importance for new users: Tutorial, Library Reference,
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000076Language Reference, Extending & Embedding, and the Python/C API. The
77Library Reference is especially of immense value since much of
78Python's power is described there, including the built-in data types
79and functions!
Guido van Rossum91cb9d21995-04-10 11:47:38 +000080
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000081All documentation is also available online at the Python web site
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000082(http://www.python.org/doc/, see below). It is available online for
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000083occasional reference, or can be downloaded in many formats for faster
Fred Drake6caae142000-10-25 17:51:02 +000084access. The documentation is available in HTML, PostScript, PDF, and
85LaTeX formats; the LaTeX version is primarily for documentation
86authors, translators, and people with special formatting requirements.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000087
88
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000089Web sites
90---------
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000091
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000092New Python releases and related technologies are published at
Guido van Rossum67345eb2001-01-18 14:51:12 +000093http://www.python.org/. Come visit us!
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000094
Guido van Rossum67345eb2001-01-18 14:51:12 +000095There's also a Python community web site at http://starship.python.net/.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000096
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000097
98Newsgroups and Mailing Lists
99----------------------------
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000100
101Read comp.lang.python, a high-volume discussion newsgroup about
102Python, or comp.lang.python.announce, a low-volume moderated newsgroup
103for Python-related announcements. These are also accessible as
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000104mailing lists: see http://www.python.org/psa/MailingLists.html for an
105overview of the many Python-related mailing lists.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000106
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000107Archives are accessible via Deja.com Usenet News: see
108http://www.deja.com/usenet. The mailing lists are also archived, see
109http://www.python.org/psa/MailingLists.html for details.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000110
111
112Bug reports
113-----------
114
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000115To report or search for bugs, please use the Python Bug
116Tracker at http://sourceforge.net/bugs/?group_id=5470.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000117
118
119Patches and contributions
120-------------------------
121
Fred Drake6caae142000-10-25 17:51:02 +0000122To submit a patch or other contribution, please use the Python Patch
123Manager at http://sourceforge.net/patch/?group_id=5470. Guidelines
124for patch submission may be found at http://www.python.org/patches/.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000125
126If you have a proposal to change Python, it's best to submit a Python
127Enhancement Proposal (PEP) first. All current PEPs, as well as
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000128guidelines for submitting a new PEP, are list at
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000129http://python.sourceforge.net/peps/.
130
131
132Questions
133---------
134
135For help, if you can't find it in the manuals or on the web site, it's
136best to post to the comp.lang.python or the Python mailing list (see
137above). If you specifically don't want to involve the newsgroup or
Guido van Rossum67345eb2001-01-18 14:51:12 +0000138mailing list, send questions to help@python.org (a group of volunteers
139who answer questions as they can). The newsgroup is the most
140efficient way to ask public questions.
Guido van Rossum627b2d71993-12-24 10:39:16 +0000141
Guido van Rossum901454e2000-06-29 22:28:44 +0000142
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000143Build instructions
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000144==================
Guido van Rossum627b2d71993-12-24 10:39:16 +0000145
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000146Before you can build Python, you must first configure it. Fortunately,
147the configuration and build process has been streamlined for most Unix
148installations, so all you have to do is type a few commands,
149optionally edit one file, and sit back. There are some platforms
150where things are not quite as smooth; see the platform specific notes
151below. If you want to build for multiple platforms sharing the same
152source tree, see the section on VPATH below.
Guido van Rossum627b2d71993-12-24 10:39:16 +0000153
Neil Schemenauer3f52da52001-01-24 17:49:59 +0000154Start by running the script "./configure", which determines your system
155configuration and creates the Makefile. (It takes a minute or two --
156please be patient!) You may want to pass options to the configure
157script or edit the Modules/Setup file after running configure -- see the
158section below on configuration options and variables. When it's done,
159you are ready to run make.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000160
Neil Schemenauer3f52da52001-01-24 17:49:59 +0000161To build Python, you normally type "make" in the toplevel directory. If
162you have changed the configuration or have modified Modules/Setup, the
163Makefile may have to be rebuilt. In this case you may have to run make
164again to correctly build your desired target. The interpreter
165executable is built in the top level directory.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000166
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000167Once you have built a Python interpreter, see the subsections below on
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000168testing, configuring additional modules, and installation. If you run
Fred Drake80078492000-10-26 17:13:19 +0000169into trouble, see the next section. Editing the Modules/Setup file
170after running make is supported; just run "make" again after making
171the desired changes.
Guido van Rossum627b2d71993-12-24 10:39:16 +0000172
Guido van Rossum0a516c91994-09-12 10:58:40 +0000173
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000174Troubleshooting
175---------------
Guido van Rossum627b2d71993-12-24 10:39:16 +0000176
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000177See also the platform specific notes in the next section.
178
Guido van Rossum49523691997-08-15 18:30:14 +0000179If you run into other trouble, see section 3 of the FAQ
Guido van Rossum901454e2000-06-29 22:28:44 +0000180(http://www.python.org/cgi-bin/faqw.py or
Guido van Rossum49523691997-08-15 18:30:14 +0000181http://www.python.org/doc/FAQ.html) for hints on what can go wrong,
182and how to fix it.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000183
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000184If you rerun the configure script with different options, remove all
185object files by running "make clean" before rebuilding. Believe it or
186not, "make clean" sometimes helps to clean up other inexplicable
187problems as well. Try it before sending in a bug report!
188
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000189If the configure script fails or doesn't seem to find things that
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000190should be there, inspect the config.log file. When you fix a
191configure problem, be sure to remove config.cache!
192
193If you get a warning for every file about the -Olimit option being no
194longer supported, you can ignore it. There's no foolproof way to know
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000195whether this option is needed; all we can do is test whether it is
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000196accepted without error. On some systems, e.g. older SGI compilers, it
197is essential for performance (specifically when compiling ceval.c,
198which has more basic blocks than the default limit of 1000). If the
199warning bothers you, edit the Makefile to remove "-Olimit 1500" from
200the OPT variable.
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000201
Guido van Rossum7ac11532000-08-29 21:36:40 +0000202If you get failures in test_long, or sys.maxint gets set to -1, you
203are probably experiencing compiler bugs, usually related to
204optimization. This is a common problem with some versions of gcc and
205egcs, and some vendor-supplied compilers, which can sometimes be
206worked around by turning off optimization. Consider switching to
207stable versions (gcc 2.7.2.3, egcs 1.1.2, or contact your vendor.)
208
209From Python 2.0 onward, all Python C code is ANSI C. Compiling using
210old K&R-C-only compilers is no longer possible. ANSI C compilers are
211available for all modern systems, either in the form of updated
212compilers from the vendor, or one of the free compilers (gcc, egcs).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000213
214Platform specific notes
215-----------------------
216
Guido van Rossum0447a321995-10-08 01:22:33 +0000217(Some of these may no longer apply. If you find you can build Python
Guido van Rossum67345eb2001-01-18 14:51:12 +0000218on these platforms without the special directions mentioned here,
219submit a documentation bug report to SourceForge (see Bug Reports
220above) so we can remove them!)
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000221
Guido van Rossumc0be2f51997-10-08 05:05:28 +000022264-bit platforms: The modules audioop, imageop and rgbimg don't work.
223 Don't try to enable them in the Modules/Setup file. They
224 contain code that is quite wordsize sensitive. (If you have a
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000225 fix, let us know!)
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000226
Guido van Rossum4462e931997-01-22 21:00:32 +0000227Solaris: When using Sun's C compiler with threads, at least on Solaris
228 2.5.1, you need to add the "-mt" compiler option (the simplest
229 way is probably to specify the compiler with this option as
230 the "CC" environment variable when running the configure
231 script).
232
Guido van Rossum7ac11532000-08-29 21:36:40 +0000233Linux: A problem with threads and fork() was tracked down to a bug in
234 the pthreads code in glibc version 2.0.5; glibc version 2.0.7
235 solves the problem. This causes the popen2 test to fail;
236 problem and solution reported by Pablo Bleyer.
Guido van Rossum4462e931997-01-22 21:00:32 +0000237
Guido van Rossum7ac11532000-08-29 21:36:40 +0000238 Under Linux systems using GNU libc 2 (aka libc6), the crypt
239 module now needs the -lcrypt option. Uncomment this flag in
240 Modules/Setup, or comment out the crypt module in the same
241 file. Most modern Linux systems use glibc2.
Fred Drake61280911997-12-08 14:10:40 +0000242
Guido van Rossum59230501999-06-21 20:51:46 +0000243FreeBSD 3.x and probably platforms with NCurses that use libmytinfo or
244 similar: When using cursesmodule, the linking is not done in
245 the correct order with the defaults. Remove "-ltermcap" from
246 the readline entry in Setup, and use as curses entry: "curses
247 cursesmodule.c -lmytinfo -lncurses -ltermcap" - "mytinfo" (so
248 called on FreeBSD) should be the name of the auxiliary library
249 required on your platform. Normally, it would be linked
250 automatically, but not necessarily in the correct order.
251
Guido van Rossum7ac11532000-08-29 21:36:40 +0000252BSDI: BSDI versions before 4.1 have known problems with threads,
253 which can cause strange errors in a number of modules (for
254 instance, the 'test_signal' test script will hang forever.)
255 Turning off threads (with --with-threads=no) or upgrading to
256 BSDI 4.1 solves this problem.
257
258DEC Unix: Run configure with --with-dec-threads, or with
259 --with-threads=no if no threads are desired (threads are on by
260 default). When using GCC, it is possible to get an internal
261 compiler error if optimization is used. This was reported for
262 GCC 2.7.2.3 on selectmodule.c. Manually compile the affected
263 file without optimization to solve the problem.
Guido van Rossum8eca2c21996-02-14 18:37:46 +0000264
Guido van Rossume1cdb161999-04-10 16:04:07 +0000265DEC Ultrix: compile with GCC to avoid bugs in the native compiler,
266 and pass SHELL=/bin/sh5 to Make when installing.
267
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000268AIX: A complete overhaul of the shared library support is now in
Guido van Rossum16e809e2001-04-16 02:07:08 +0000269 place. See Misc/AIX-NOTES for some notes on how it's done.
Guido van Rossum9ac9a261998-02-16 22:19:21 +0000270 (The optimizer bug reported at this place in previous releases
Thomas Wouters8ee06142001-02-15 11:45:29 +0000271 has been worked around by a minimal code change.) If you get
272 errors about ptread_* functions, during compile or during
273 testing, try setting CC to a thread-safe (reentrant) compiler,
274 like "cc_r". For full C++ module support, set CC="xlC_r" (or
275 CC="xlC" without thread support).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000276
Guido van Rossum59a88f41999-04-12 18:16:09 +0000277HP-UX: Please read the file Misc/HPUX-NOTES for shared libraries.
278 When using threading, you may have to add -D_REENTRANT to the
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000279 OPT variable in the top-level Makefile; reported by Pat Knight,
Guido van Rossum59a88f41999-04-12 18:16:09 +0000280 this seems to make a difference (at least for HP-UX 10.20)
281 even though config.h defines it.
Guido van Rossum2094e041998-05-14 15:47:35 +0000282
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000283Minix: When using ack, use "CC=cc AR=aal RANLIB=: ./configure"!
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000284
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000285SCO: The following apply to SCO 3 only; Python builds out of the box
286 on SCO 5 (or so we've heard).
Guido van Rossuma16e2751998-04-13 20:14:05 +0000287
288 1) Everything works much better if you add -U__STDC__ to the
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000289 defs. This is because all the SCO header files are broken.
Guido van Rossum64773801997-11-26 17:07:02 +0000290 Anything that isn't mentioned in the C standard is
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000291 conditionally excluded when __STDC__ is defined.
292
293 2) Due to the U.S. export restrictions, SCO broke the crypt
294 stuff out into a separate library, libcrypt_i.a so the LIBS
295 needed be set to:
296
297 LIBS=' -lsocket -lcrypt_i'
298
Martin v. Löwis387c5472001-09-06 08:16:17 +0000299UnixWare: There are known bugs in the math library of the system, as well as
300 problems in the handling of threads (calling fork in one
301 thread may interrupt system calls in others). Therefore, test_math and
302 tests involving threads will fail until those problems are fixed.
303
Guido van Rossum7ac11532000-08-29 21:36:40 +0000304SunOS 4.x: When using the SunPro C compiler, you may want to use the
Guido van Rossum64773801997-11-26 17:07:02 +0000305 '-Xa' option instead of '-Xc', to enable some needed non-ANSI
306 Sunisms.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000307
Jack Jansena39ef862001-08-19 21:17:03 +0000308NeXT: Not supported anymore. Start with the MacOSX/Darwin code if you
309 want to revive it.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000310
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000311QNX: Chris Herborth (chrish@qnx.com) writes:
312 configure works best if you use GNU bash; a port is available on
313 ftp.qnx.com in /usr/free. I used the following process to build,
Guido van Rossumd4493421998-12-22 16:37:01 +0000314 test and install Python 1.5.x under QNX:
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000315
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000316 1) CONFIG_SHELL=/usr/local/bin/bash CC=cc RANLIB=: \
317 ./configure --verbose --without-gcc --with-libm=""
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000318
Fred Drake80078492000-10-26 17:13:19 +0000319 2) edit Modules/Setup to activate everything that makes sense for
320 your system... tested here at QNX with the following modules:
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000321
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000322 array, audioop, binascii, cPickle, cStringIO, cmath,
323 crypt, curses, errno, fcntl, gdbm, grp, imageop,
324 _locale, math, md5, new, operator, parser, pcre,
325 posix, pwd, readline, regex, reop, rgbimg, rotor,
326 select, signal, socket, soundex, strop, struct,
Guido van Rossumd4493421998-12-22 16:37:01 +0000327 syslog, termios, time, timing, zlib, audioop, imageop, rgbimg
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000328
Guido van Rossum16e809e2001-04-16 02:07:08 +0000329 3) make SHELL=/usr/local/bin/bash
330
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000331 or, if you feel the need for speed:
Guido van Rossum16e809e2001-04-16 02:07:08 +0000332
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000333 make SHELL=/usr/local/bin/bash OPT="-5 -Oil+nrt"
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000334
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000335 4) make SHELL=/usr/local/bin/bash test
336
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000337 Using GNU readline 2.2 seems to behave strangely, but I
338 think that's a problem with my readline 2.2 port. :-\
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000339
340 5) make SHELL=/usr/local/bin/bash install
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000341
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000342 If you get SIGSEGVs while running Python (I haven't yet, but
343 I've only run small programs and the test cases), you're
344 probably running out of stack; the default 32k could be a
345 little tight. To increase the stack size, edit the Makefile
Neil Schemenauer73f8ab22001-01-26 22:18:55 +0000346 to read: LDFLAGS = -N 48k
Guido van Rossum40d63581997-08-14 19:45:30 +0000347
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000348BeOS: Chris Herborth (chrish@qnx.com) writes:
349 See BeOS/README for notes about compiling/installing Python on
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000350 BeOS R3 or later. Note that only the PowerPC platform is
Guido van Rossumd4493421998-12-22 16:37:01 +0000351 supported for R3; both PowerPC and x86 are supported for R4.
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000352
Guido van Rossum1bf0bf41997-08-20 23:50:51 +0000353Cray T3E: Konrad Hinsen writes:
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000354 1) Don't use gcc. It compiles Python/graminit.c into something
355 that the Cray assembler doesn't like. Cray's cc seems to work
356 fine.
Guido van Rossum7ac11532000-08-29 21:36:40 +0000357 2) Comment out modules md5 (won't compile) and audioop (will
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000358 crash the interpreter during the test suite).
359 If you run the test suite, two tests will fail (rotate and
360 binascii), but these are not the modules you'd expect to need
361 on a Cray.
Guido van Rossum1bf0bf41997-08-20 23:50:51 +0000362
Guido van Rossum0078aaf1997-08-21 03:05:11 +0000363SGI: SGI's standard "make" utility (/bin/make or /usr/bin/make)
364 does not check whether a command actually changed the file it
365 is supposed to build. This means that whenever you say "make"
366 it will redo the link step. The remedy is to use SGI's much
Guido van Rossum7be8ca02001-04-14 13:09:53 +0000367 smarter "smake" utility (/usr/sbin/smake), or GNU make. If
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000368 you set the first line of the Makefile to #!/usr/sbin/smake
369 smake will be invoked by make (likewise for GNU make).
Guido van Rossum0078aaf1997-08-21 03:05:11 +0000370
Guido van Rossum7be8ca02001-04-14 13:09:53 +0000371 WARNING: There are bugs in the optimizer of some versions of
372 SGI's compilers that can cause bus errors or other strange
373 behavior, especially on numerical operations. To avoid this,
374 try building with "make OPT=".
Fred Drake0b5fb2b2000-09-29 17:45:05 +0000375
Guido van Rossum64773801997-11-26 17:07:02 +0000376OS/2: If you are running Warp3 or Warp4 and have IBM's VisualAge C/C++
377 compiler installed, just change into the pc\os2vacpp directory
378 and type NMAKE. Threading and sockets are supported by default
379 in the resulting binaries of PYTHON15.DLL and PYTHON.EXE.
380
Fred Drake36ed5602000-10-06 01:58:48 +0000381Monterey (64-bit AIX): The current Monterey C compiler (Visual Age)
382 uses the OBJECT_MODE={32|64} environment variable to set the
383 compilation mode to either 32-bit or 64-bit (32-bit mode is
384 the default). Presumably you want 64-bit compilation mode for
385 this 64-bit OS. As a result you must first set OBJECT_MODE=64
386 in your environment before configuring (./configure) or
387 building (make) Python on Monterey.
388
389Reliant UNIX: The thread support does not compile on Reliant UNIX, and
390 there is a (minor) problem in the configure script for that
391 platform as well. This should be resolved in time for a
392 future release.
Trent Mick635f6fb2000-08-23 21:33:05 +0000393
Jack Jansena39ef862001-08-19 21:17:03 +0000394Mac OS X 10.0: Run configure with "./configure --with-suffix=.exe".
395 This generates executable file: 'python.exe' (it cannot be named
396 'python' on an HFS or HFS+ disk as the file name clashes with
397 directory 'Python'). One of the regular expression tests fails
398 with a SEGV due to the small stack size used by default (how to
399 change this?), and the test_largefile test is only expected to
400 work on a Unix UFS filesystem (how to check for this on Mac OS
401 X?).
402 On naked Darwin you may have to add the configure option
Jack Jansen4c398fd2001-10-08 13:21:15 +0000403 "--disable-toolbox-glue" to disable the glue code for the Carbon
Jack Jansena39ef862001-08-19 21:17:03 +0000404 interface modules. (The modules themselves are currently not built
405 by default as they are experimental, on real OSX you can enable them
406 in setup.py).
407 You may want to try the configure option "--enable-framework" which
408 installs Python as a framework. The location can be set as argument
409 to the --enable-framework option (default /Library/Frameworks).
Fred Drakedabed752001-02-01 19:41:13 +0000410
Tim Peters42fc7cc2001-04-04 18:35:19 +0000411Cygwin: Cygwin Python builds OOTB when configured as follows:
412
413 configure --with-threads=no
Guido van Rossum16e809e2001-04-16 02:07:08 +0000414
Tim Peters42fc7cc2001-04-04 18:35:19 +0000415 assuming Cygwin 1.1.8-2 and gcc 2.95.3-1 or later. At the time
416 of this writing, Cygwin pthread support is being significantly
417 enhanced. Hopefully, there will be a Cygwin Python with thread
418 support soon.
419
420 Cygwin Python supports the building of shared extensions via the
421 traditional Misc/Makefile.pre.in and the newer distutils methods.
Guido van Rossum16e809e2001-04-16 02:07:08 +0000422
Tim Peters42fc7cc2001-04-04 18:35:19 +0000423 On NT/2000, the following regression tests fail:
424
425 test_poll (hang)
426 test_strftime
Guido van Rossum16e809e2001-04-16 02:07:08 +0000427
Tim Peters42fc7cc2001-04-04 18:35:19 +0000428 Due to the test_poll hang on NT/2000, one should run the
429 regression test using the following:
430
431 PYTHONPATH= ./python.exe -tt ./Lib/test/regrtest.py -l -x test_poll
Guido van Rossum16e809e2001-04-16 02:07:08 +0000432
Tim Peters42fc7cc2001-04-04 18:35:19 +0000433 On 9X/Me, in addition the above NT/2000 failures, it has been
434 reported that the following regression tests also fail:
435
436 test_pwd
437 test_select (hang)
438 test_socket
439
440 Due to the test_poll and test_select hang on 9X/Me, one should
441 run the regression test using the following:
442
443 PYTHONPATH= ./python.exe -tt ./Lib/test/regrtest.py -l -x test_poll -x test_select
444
445 Help trying to track down the root causes for these known problems
446 will be greatly appreciated.
Guido van Rossum16e809e2001-04-16 02:07:08 +0000447
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000448
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000449Configuring threads
450-------------------
451
Guido van Rossum7ac11532000-08-29 21:36:40 +0000452As of Python 2.0, threads are enabled by default. If you wish to
453compile without threads, or if your thread support is broken, pass the
454--with-threads=no switch to configure. Unfortunately, on some
455platforms, additional compiler and/or linker options are required for
456threads to work properly. Below is a table of those options,
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000457collected by Bill Janssen. We would love to automate this process
Guido van Rossum7ac11532000-08-29 21:36:40 +0000458more, but the information below is not enough to write a patch for the
459configure.in file, so manual intervention is required. If you patch
460the configure.in file and are confident that the patch works, please
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000461send in the patch. (Don't bother patching the configure script itself
Guido van Rossum7ac11532000-08-29 21:36:40 +0000462-- it is regenerated each the configure.in file changes.)
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000463
464Compiler switches for threads
465.............................
466
Martin v. Löwis1c24f9c2001-03-06 12:07:27 +0000467The definition of _REENTRANT should be configured automatically, if
468that does not work on your system, or if _REENTRANT is defined
469incorrectly, please report that as a bug.
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000470
Martin v. Löwis1c24f9c2001-03-06 12:07:27 +0000471 OS/Compiler/threads Switches for use with threads
472 (POSIX is draft 10, DCE is draft 4) compile & link
473
474 SunOS 5.{1-5}/{gcc,SunPro cc}/solaris -mt
475 SunOS 5.5/{gcc,SunPro cc}/POSIX (nothing)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000476 DEC OSF/1 3.x/cc/DCE -threads
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000477 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000478 Digital UNIX 4.x/cc/DCE -threads
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000479 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000480 Digital UNIX 4.x/cc/POSIX -pthread
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000481 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000482 AIX 4.1.4/cc_r/d7 (nothing)
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000483 (buhrt@iquest.net)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000484 AIX 4.1.4/cc_r4/DCE (nothing)
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000485 (buhrt@iquest.net)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000486 IRIX 6.2/cc/POSIX (nothing)
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000487 (robertl@cwi.nl)
488
489
490Linker (ld) libraries and flags for threads
491...........................................
492
493 OS/threads Libraries/switches for use with threads
494
495 SunOS 5.{1-5}/solaris -lthread
496 SunOS 5.5/POSIX -lpthread
Guido van Rossum16e809e2001-04-16 02:07:08 +0000497 DEC OSF/1 3.x/DCE -lpthreads -lmach -lc_r -lc
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000498 (butenhof@zko.dec.com)
499 Digital UNIX 4.x/DCE -lpthreads -lpthread -lmach -lexc -lc
500 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000501 Digital UNIX 4.x/POSIX -lpthread -lmach -lexc -lc
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000502 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000503 AIX 4.1.4/{draft7,DCE} (nothing)
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000504 (buhrt@iquest.net)
Guido van Rossum16e809e2001-04-16 02:07:08 +0000505 IRIX 6.2/POSIX -lpthread
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000506 (jph@emilia.engr.sgi.com)
507
508
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000509Configuring additional built-in modules
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000510---------------------------------------
Guido van Rossum19e0c261995-01-17 16:36:34 +0000511
Andrew M. Kuchlingebe30452001-02-27 03:24:24 +0000512Starting with Python 2.1, the setup.py script at the top of the source
513distribution attempts to detect which modules can be built and
514automatically compiles them. Autodetection doesn't always work, so
515you can customize the configuration by editing the Modules/Setup file.
516This file is initially copied from Setup.dist by the configure script;
517if it does not exist yet, create it by copying Modules/Setup.dist
518yourself (configure will never overwrite it). Never edit Setup.dist
519-- always edit Setup or Setup.local (see below). Read the comments in
520the file for information on what kind of edits are allowed. When you
521have edited Setup in the Modules directory, the interpreter will
Guido van Rossumef67ded2001-10-05 17:04:42 +0000522automatically be rebuilt the next time you run make (in the toplevel
523directory).
Guido van Rossum627b2d71993-12-24 10:39:16 +0000524
Andrew M. Kuchlingebe30452001-02-27 03:24:24 +0000525Many useful modules can be built on any Unix system, but some optional
526modules can't be reliably autodetected. Often the quickest way to
527determine whether a particular module works or not is to see if it
528will build: enable it in Setup, then if you get compilation or link
Fred Drake6caae142000-10-25 17:51:02 +0000529errors, disable it -- you're either missing support or need to adjust
530the compilation and linking parameters for that module.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000531
532On SGI IRIX, there are modules that interface to many SGI specific
Andrew M. Kuchlingebe30452001-02-27 03:24:24 +0000533system libraries, e.g. the GL library and the audio hardware. These
534modules will not be built by the setup.py script.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000535
Guido van Rossum4462e931997-01-22 21:00:32 +0000536In addition to the file Setup, you can also edit the file Setup.local.
537(the makesetup script processes both). You may find it more
538convenient to edit Setup.local and leave Setup alone. Then, when
539installing a new Python version, you can copy your old Setup.local
540file.
541
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000542
543Setting the optimization/debugging options
544------------------------------------------
545
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000546If you want or need to change the optimization/debugging options for
547the C compiler, assign to the OPT variable on the toplevel make
548command; e.g. "make OPT=-g" will build a debugging version of Python
549on most platforms. The default is OPT=-O; a value for OPT in the
550environment when the configure script is run overrides this default
551(likewise for CC; and the initial value for LIBS is used as the base
552set of libraries to link with).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000553
Fred Drake6caae142000-10-25 17:51:02 +0000554When compiling with GCC, the default value of OPT will also include
555the -Wall and -Wstrict-prototypes options.
556
557Additional debugging code to help debug memory management problems can
558be enabled by using the --with-pydebug option to the configure script.
559
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000560
Guido van Rossuma68ca352001-10-04 17:00:07 +0000561Profiling
562---------
563
564If you want C profiling turned on, the easiest way is to run configure
565with the CC environment variable to the necessary compiler
566invocation. For example, on Linux, this works for profiling using
567gprof(1):
568
569 CC="gcc -pg" ./configure
570
571Note that on Linux, gprof apparently does not work for shared
572libraries. The Makefile/Setup mechanism can be used to compile and
573link most extension module statically.
574
575
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000576Testing
577-------
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000578
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000579To test the interpreter, type "make test" in the top-level directory.
Guido van Rossum6ae5d3d1997-05-14 21:39:05 +0000580This runs the test set twice (once with no compiled files, once with
581the compiled files left by the previous test run). The test set
582produces some output. You can generally ignore the messages about
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000583skipped tests due to optional features which can't be imported. (If
584you want to test those modules, edit Modules/Setup to configure them.)
585If a message is printed about a failed test or a traceback or core
586dump is produced, something is wrong. On some Linux systems (those
Guido van Rossum24df6841997-12-30 04:32:30 +0000587that are not yet using glibc 6), test_strftime fails due to a
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000588non-standard implementation of strftime() in the C library. Please
589ignore this, or upgrade to glibc version 6.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000590
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000591IMPORTANT: If the tests fail and you decide to mail a bug report,
592*don't* include the output of "make test". It is useless. Run the
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000593failing test manually, as follows:
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000594
Guido van Rossum6ae5d3d1997-05-14 21:39:05 +0000595 python ../Lib/test/test_whatever.py
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000596
597(substituting the top of the source tree for .. if you built in a
Guido van Rossum6ae5d3d1997-05-14 21:39:05 +0000598different directory). This runs the test in verbose mode.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000599
600
601Installing
602----------
603
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000604To install the Python binary, library modules, shared library modules
605(see below), include files, configuration files, and the manual page,
Guido van Rossum64773801997-11-26 17:07:02 +0000606just type
607
608 make install
609
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000610This will install all platform-independent files in subdirectories of
611the directory given with the --prefix option to configure or to the
612`prefix' Make variable (default /usr/local). All binary and other
613platform-specific files will be installed in subdirectories if the
614directory given by --exec-prefix or the `exec_prefix' Make variable
615(defaults to the --prefix directory) is given.
Guido van Rossum64773801997-11-26 17:07:02 +0000616
617All subdirectories created will have Python's version number in their
618name, e.g. the library modules are installed in
Guido van Rossum67345eb2001-01-18 14:51:12 +0000619"/usr/local/lib/python<version>/" by default, where <version> is the
620<major>.<minor> release number (e.g. "2.1"). The Python binary is
621installed as "python<version>" and a hard link named "python" is
622created. The only file not installed with a version number in its
623name is the manual page, installed as "/usr/local/man/man1/python.1"
624by default.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000625
Neil Schemenauer0e91dc72001-02-16 04:18:08 +0000626If you have a previous installation of Python that you don't
Guido van Rossum64773801997-11-26 17:07:02 +0000627want to replace yet, use
628
629 make altinstall
630
631This installs the same set of files as "make install" except it
Guido van Rossum67345eb2001-01-18 14:51:12 +0000632doesn't create the hard link to "python<version>" named "python" and
633it doesn't install the manual page at all.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000634
Neil Schemenauer0e91dc72001-02-16 04:18:08 +0000635Alpha/beta revision levels are stripped from the executable and
636library filenames during installation. For example, Python2.1a2 will
637install as python2.1, overwriting the previous python2.1. To avoid
638this, you could set the Makefile VERSION variable manually
639(e.g. VERSION=2.1a2) before running "make install" or "make altinstall".
640
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000641The only thing you may have to install manually is the Python mode for
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000642Emacs found in Misc/python-mode.el. (But then again, more recent
643versions of Emacs may already have it.) Follow the instructions that
644came with Emacs for installation of site-specific files.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000645
Jack Jansena39ef862001-08-19 21:17:03 +0000646On Mac OS X, if you have configured Python with --enable-framework, you
647should use "make frameworkinstall" to do the installation. Note that this
648installs the Python executable in a place that is not normally on your
649PATH, you may want to set up a symlink in /usr/local/bin.
650
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000651
652Configuration options and variables
653-----------------------------------
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000654
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000655Some special cases are handled by passing options to the configure
656script.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000657
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000658WARNING: if you rerun the configure script with different options, you
659must run "make clean" before rebuilding. Exceptions to this rule:
660after changing --prefix or --exec-prefix, all you need to do is remove
Guido van Rossumb06df271997-08-05 21:50:20 +0000661Modules/getpath.o.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000662
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000663--with(out)-gcc: The configure script uses gcc (the GNU C compiler) if
664 it finds it. If you don't want this, or if this compiler is
665 installed but broken on your platform, pass the option
666 --without-gcc. You can also pass "CC=cc" (or whatever the
667 name of the proper C compiler is) in the environment, but the
668 advantage of using --without-gcc is that this option is
669 remembered by the config.status script for its --recheck
670 option.
Guido van Rossum76be6ed1995-01-02 18:33:54 +0000671
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000672--prefix, --exec-prefix: If you want to install the binaries and the
673 Python library somewhere else than in /usr/local/{bin,lib},
674 you can pass the option --prefix=DIRECTORY; the interpreter
675 binary will be installed as DIRECTORY/bin/python and the
676 library files as DIRECTORY/lib/python/*. If you pass
677 --exec-prefix=DIRECTORY (as well) this overrides the
678 installation prefix for architecture-dependent files (like the
679 interpreter binary). Note that --prefix=DIRECTORY also
680 affects the default module search path (sys.path), when
681 Modules/config.c is compiled. Passing make the option
682 prefix=DIRECTORY (and/or exec_prefix=DIRECTORY) overrides the
683 prefix set at configuration time; this may be more convenient
684 than re-running the configure script if you change your mind
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000685 about the install prefix.
Guido van Rossum76be6ed1995-01-02 18:33:54 +0000686
Guido van Rossumb06df271997-08-05 21:50:20 +0000687--with-readline: This option is no longer supported. To use GNU
688 readline, enable module "readline" in the Modules/Setup file.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000689
Guido van Rossum7ac11532000-08-29 21:36:40 +0000690--with-threads: On most Unix systems, you can now use multiple
691 threads, and support for this is enabled by default. To
692 disable this, pass --with-threads=no. If the library required
693 for threads lives in a peculiar place, you can use
694 --with-thread=DIRECTORY. IMPORTANT: run "make clean" after
695 changing (either enabling or disabling) this option, or you
696 will get link errors! Note: for DEC Unix use
Guido van Rossum0e13da91998-02-22 04:36:34 +0000697 --with-dec-threads instead.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000698
699--with-sgi-dl: On SGI IRIX 4, dynamic loading of extension modules is
700 supported by the "dl" library by Jack Jansen, which is
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000701 ftp'able from ftp://ftp.cwi.nl/pub/dynload/dl-1.6.tar.Z.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000702 This is enabled (after you've ftp'ed and compiled the dl
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000703 library) by passing --with-sgi-dl=DIRECTORY where DIRECTORY
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000704 is the absolute pathname of the dl library. (Don't bother on
705 IRIX 5, it already has dynamic linking using SunOS style
706 shared libraries.) Support for this feature is deprecated.
707
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000708--with-dl-dld: Dynamic loading of modules is rumored to be supported
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000709 on some other systems: VAX (Ultrix), Sun3 (SunOS 3.4), Sequent
710 Symmetry (Dynix), and Atari ST. This is done using a
711 combination of the GNU dynamic loading package
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000712 (ftp://ftp.cwi.nl/pub/dynload/dl-dld-1.1.tar.Z) and an
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000713 emulation of the SGI dl library mentioned above (the emulation
714 can be found at
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000715 ftp://ftp.cwi.nl/pub/dynload/dld-3.2.3.tar.Z). To
Guido van Rossum16e809e2001-04-16 02:07:08 +0000716 enable this, ftp and compile both libraries, then call
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000717 configure, passing it the option
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000718 --with-dl-dld=DL_DIRECTORY,DLD_DIRECTORY where DL_DIRECTORY is
719 the absolute pathname of the dl emulation library and
720 DLD_DIRECTORY is the absolute pathname of the GNU dld library.
721 (Don't bother on SunOS 4 or 5, they already have dynamic
722 linking using shared libraries.) Support for this feature is
723 deprecated.
724
725--with-libm, --with-libc: It is possible to specify alternative
726 versions for the Math library (default -lm) and the C library
727 (default the empty string) using the options
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000728 --with-libm=STRING and --with-libc=STRING, respectively. For
729 example, if your system requires that you pass -lc_s to the C
730 compiler to use the shared C library, you can pass
731 --with-libc=-lc_s. These libraries are passed after all other
732 libraries, the C library last.
Guido van Rossum16e809e2001-04-16 02:07:08 +0000733
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000734--with-libs='libs': Add 'libs' to the LIBS that the python interpreter
735 is linked against.
Guido van Rossumd02ba451996-07-31 17:36:01 +0000736
Martin v. Löwis2df66942000-12-13 14:14:32 +0000737--with-cxx=<compiler>: Some C++ compilers require that main() is
738 compiled with the C++ if there is any C++ code in the application.
739 Specifically, g++ on a.out systems may require that to support
740 construction of global objects. With this option, the main() function
741 of Python will be compiled with <compiler>; use that only if you
742 plan to use C++ extension modules, and if your compiler requires
743 compilation of main() as a C++ program.
744
745
Fred Drake6caae142000-10-25 17:51:02 +0000746--with-pydebug: Enable additional debugging code to help track down
747 memory management problems. This allows printing a list of all
748 live objects when the interpreter terminates.
749
Guido van Rossum76be6ed1995-01-02 18:33:54 +0000750
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000751Building for multiple architectures (using the VPATH feature)
752-------------------------------------------------------------
753
754If your file system is shared between multiple architectures, it
755usually is not necessary to make copies of the sources for each
756architecture you want to support. If the make program supports the
757VPATH feature, you can create an empty build directory for each
758architecture, and in each directory run the configure script (on the
759appropriate machine with the appropriate options). This creates the
760necessary subdirectories and the Makefiles therein. The Makefiles
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000761contain a line VPATH=... which points to a directory containing the
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000762actual sources. (On SGI systems, use "smake -J1" instead of "make" if
763you use VPATH -- don't try gnumake.)
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000764
765For example, the following is all you need to build a minimal Python
766in /usr/tmp/python (assuming ~guido/src/python is the toplevel
767directory and you want to build in /usr/tmp/python):
768
769 $ mkdir /usr/tmp/python
770 $ cd /usr/tmp/python
771 $ ~guido/src/python/configure
772 [...]
773 $ make
774 [...]
775 $
776
Neil Schemenauer73f8ab22001-01-26 22:18:55 +0000777Note that configure copies the original Setup file to the build
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000778directory if it finds no Setup file there. This means that you can
779edit the Setup file for each architecture independently. For this
780reason, subsequent changes to the original Setup file are not tracked
781automatically, as they might overwrite local changes. To force a copy
782of a changed original Setup file, delete the target Setup file. (The
783makesetup script supports multiple input files, so if you want to be
784fancy you can change the rules to create an empty Setup.local if it
785doesn't exist and run it with arguments $(srcdir)/Setup Setup.local;
786however this assumes that you only need to add modules.)
787
788
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000789Building on non-UNIX systems
790----------------------------
791
Tim Peters03444242000-09-19 00:38:35 +0000792For Windows (2000/NT/ME/98/95), assuming you have MS VC++ 6.0, the
793project files are in PCbuild, the workspace is pcbuild.dsw. See
794PCbuild\readme.txt for detailed instructions.
Guido van Rossum8d7d4ed1996-07-30 21:41:07 +0000795
Guido van Rossum31ae2071999-04-12 14:47:30 +0000796For other non-Unix Windows compilers, in particular Windows 3.1 and
797for OS/2, enter the directory "PC" and read the file "readme.txt".
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000798
799For the Mac, a separate source distribution will be made available,
800for use with the CodeWarrior compiler. If you are interested in Mac
801development, join the PythonMac Special Interest Group
802(http://www.python.org/sigs/pythonmac-sig/, or send email to
803pythonmac-sig-request@python.org).
804
805Of course, there are also binary distributions available for these
Guido van Rossum67345eb2001-01-18 14:51:12 +0000806platforms -- see http://www.python.org/.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000807
808To port Python to a new non-UNIX system, you will have to fake the
809effect of running the configure script manually (for Mac and PC, this
810has already been done for you). A good start is to copy the file
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000811config.h.in to config.h and edit the latter to reflect the actual
812configuration of your system. Most symbols must simply be defined as
8131 only if the corresponding feature is present and can be left alone
Tim Peters4f1b2082000-07-23 21:18:09 +0000814otherwise; however the *_t type symbols must be defined as some variant
815of int if they need to be defined at all.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000816
817
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000818
819Miscellaneous issues
820====================
821
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000822Emacs mode
823----------
824
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000825There's an excellent Emacs editing mode for Python code; see the file
826Misc/python-mode.el. Originally written by the famous Tim Peters, it
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000827is now maintained by the equally famous Barry Warsaw (it's no
Guido van Rossum67345eb2001-01-18 14:51:12 +0000828coincidence that they now both work on the same team). The latest
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000829version, along with various other contributed Python-related Emacs
Guido van Rossum67345eb2001-01-18 14:51:12 +0000830goodies, is online at http://www.python.org/emacs/python-mode. And
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000831if you are planning to edit the Python C code, please pick up the
Guido van Rossum67345eb2001-01-18 14:51:12 +0000832latest version of CC Mode http://www.python.org/emacs/cc-mode; it
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000833contains a "python" style used throughout most of the Python C source
834files. (Newer versions of Emacs or XEmacs may already come with the
835latest version of python-mode.)
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000836
837
838The Tk interface
839----------------
840
841Tk (the user interface component of John Ousterhout's Tcl language) is
842also usable from Python. Since this requires that you first build and
Fred Drake8179a9d2000-09-28 23:28:30 +0000843install Tcl/Tk, the Tk interface is not enabled by default when
844building Python from source. Python supports Tcl/Tk version 8.0 and
845higher.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000846
Guido van Rossum973e4dc2000-07-01 00:34:39 +0000847See http://dev.ajubasolutions.com/ for more info on Tcl/Tk, including
848the on-line manual pages.
Guido van Rossum64773801997-11-26 17:07:02 +0000849
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000850
851To enable the Python/Tk interface, once you've built and installed
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000852Tcl/Tk, load the file Modules/Setup into your favorite text editor and
Guido van Rossum64773801997-11-26 17:07:02 +0000853search for the string "_tkinter". Then follow the instructions found
854there. If you have installed Tcl/Tk or X11 in unusual places, you
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000855will have to edit the first line to fix or add the -I and -L options.
Guido van Rossum64773801997-11-26 17:07:02 +0000856(Also see the general instructions at the top of that file.)
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000857
Guido van Rossum973e4dc2000-07-01 00:34:39 +0000858For more Tkinter information, see the Tkinter Resource page:
859http://www.python.org/topics/tkinter/
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000860
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000861There are demos in the Demo/tkinter directory, in the subdirectories
862guido, matt and www (the matt and guido subdirectories have been
863overhauled to use more recent Tkinter coding conventions).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000864
865Note that there's a Python module called "Tkinter" (capital T) which
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000866lives in Lib/lib-tk/Tkinter.py, and a C module called "_tkinter"
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000867(lower case t and leading underscore) which lives in
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000868Modules/_tkinter.c. Demos and normal Tk applications import only the
869Python Tkinter module -- the latter uses the C _tkinter module
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000870directly. In order to find the C _tkinter module, it must be compiled
871and linked into the Python interpreter -- the _tkinter line in the
872Setup file does this. In order to find the Python Tkinter module,
873sys.path must be set correctly -- the TKPATH assignment in the Setup
874file takes care of this, but only if you install Python properly
875("make install libinstall"). (You can also use dynamic loading for
876the C _tkinter module, in which case you must manually fix up sys.path
877or set $PYTHONPATH for the Python Tkinter module.)
Guido van Rossum84c8c7f1995-08-28 02:44:24 +0000878
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000879
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000880Distribution structure
881----------------------
882
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000883Most subdirectories have their own README files. Most files have
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000884comments.
885
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000886.cvsignore Additional filename matching patterns for CVS to ignore
887BeOS/ Files specific to the BeOS port
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000888Demo/ Demonstration scripts, modules and programs
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000889Doc/ Documentation sources (LaTeX)
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000890Grammar/ Input for the parser generator
891Include/ Public header files
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000892LICENSE Licensing information
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000893Lib/ Python library modules
Neil Schemenauer3f52da52001-01-24 17:49:59 +0000894Makefile.pre.in Source from which config.status creates the Makefile.pre
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000895Misc/ Miscellaneous useful files
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000896Modules/ Implementation of most built-in modules
897Objects/ Implementation of most built-in object types
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000898PC/ Files specific to PC ports (DOS, Windows, OS/2)
899PCbuild/ Build directory for Microsoft Visual C++
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000900Parser/ The parser and tokenizer and their input handling
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000901Python/ The byte-compiler and interpreter
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000902README The file you're reading now
903Tools/ Some useful programs written in Python
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000904acconfig.h Additional input for the GNU autoheader program
905config.h.in Source from which config.h is created (GNU autoheader output)
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000906configure Configuration shell script (GNU autoconf output)
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000907configure.in Configuration specification (input for GNU autoconf)
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000908install-sh Shell script used to install files
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000909
910The following files will (may) be created in the toplevel directory by
911the configuration and build processes:
912
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000913Makefile Build rules
Neil Schemenauer3f52da52001-01-24 17:49:59 +0000914Makefile.pre Build rules before running Modules/makesetup
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000915buildno Keeps track of the build number
916config.cache Cache of configuration variables
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000917config.h Configuration header
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000918config.log Log from last configure run
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000919config.status Status from last run of the configure script
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000920getbuildinfo.o Object file from Modules/getbuildinfo.c
Guido van Rossum67345eb2001-01-18 14:51:12 +0000921libpython<version>.a The library archive
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000922python The executable interpreter
923tags, TAGS Tags files for vi and Emacs
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000924
925
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000926That's all, folks!
927------------------
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000928
929
Guido van Rossum67345eb2001-01-18 14:51:12 +0000930--Guido van Rossum (home page: http://www.python.org/~guido/)