Google Git
Sign in
chromium / external / github.com / python / cpython / refs/tags/v2.3.7 / . / README
blob: 7fc19e68e02ffbf1a80bea628b3a83a652fe81b6 [file] [log] [blame]
Martin v. Löwisb0f96352008-03-11 18:00:08[diff] [blame]1This is Python version 2.3.7
2============================
Guido van Rossum91447632000-04-11 17:11:09[diff] [blame]3
Martin v. Löwiscb6727e2008-03-02 20:39:32[diff] [blame]4Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Python Software Foundation.
Guido van Rossum67345eb2001-01-18 14:51:12[diff] [blame]5All rights reserved.
6
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]7Copyright (c) 2000 BeOpen.com.
8All rights reserved.
9
Guido van Rossum23f7aed2001-04-12 20:53:31[diff] [blame]10Copyright (c) 1995-2001 Corporation for National Research Initiatives.
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]11All rights reserved.
12
Guido van Rossum6ebd2992000-09-03 04:47:47[diff] [blame]13Copyright (c) 1991-1995 Stichting Mathematisch Centrum.
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]14All rights reserved.
15
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]16
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]17License information
18-------------------
19
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]20See 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[diff] [blame]23
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]24This 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[diff] [blame]31
32
Guido van Rossum8d7d4ed1996-07-30 21:41:07[diff] [blame]33What's new in this release?
34---------------------------
Guido van Rossum3ff96dd1996-07-30 18:05:04[diff] [blame]35
Guido van Rossum67345eb2001-01-18 14:51:12[diff] [blame]36See the file "Misc/NEWS".
Guido van Rossum64773801997-11-26 17:07:02[diff] [blame]37
Barry Warsawb26f32f2003-08-04 22:49:46[diff] [blame]38
Guido van Rossum64773801997-11-26 17:07:02[diff] [blame]39If you don't read instructions
40------------------------------
41
42Congratulations on getting this far. :-)
43
44To start building right away (on UNIX): type "./configure" in the
Guido van Rossum2dcec0c2002-02-04 01:59:23[diff] [blame]45current directory and when it finishes, type "make". This creates an
46executable "./python"; to install in /usr/local, first do "su root"
47and then "make install".
48
Guido van Rossum59b0b602002-02-08 22:22:35[diff] [blame]49The section `Build instructions' below is still recommended reading,
Guido van Rossum2dcec0c2002-02-04 01:59:23[diff] [blame]50especially the part on customizing Modules/Setup.
Guido van Rossum3ff96dd1996-07-30 18:05:04[diff] [blame]51
52
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]53What is Python anyway?
54----------------------
55
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]56Python is an interpreted object-oriented programming language suitable
57(amongst other uses) for distributed application development,
58scripting, numeric computing and system testing. Python is often
59compared to Tcl, Perl, Java, JavaScript, Visual Basic or Scheme. To
60find out more about what Python can do for you, point your browser to
Guido van Rossum67345eb2001-01-18 14:51:12[diff] [blame]61http://www.python.org/.
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]62
63
Guido van Rossumf501b4e1996-10-25 14:32:48[diff] [blame]64How do I learn Python?
65----------------------
66
Fred Drake0e6444c1999-05-17 19:35:01[diff] [blame]67The official tutorial is still a good place to start; see
Guido van Rossumd0a42e22000-03-31 20:16:45[diff] [blame]68http://www.python.org/doc/ for online and downloadable versions, as
69well as a list of other introductions, and reference documentation.
Guido van Rossumf501b4e1996-10-25 14:32:48[diff] [blame]70
Guido van Rossumd0a42e22000-03-31 20:16:45[diff] [blame]71There's a quickly growing set of books on Python. See
Skip Montanaro932dab62003-06-12 14:04:33[diff] [blame]72http://www.python.org/cgi-bin/moinmoin/PythonBooks for a list.
Guido van Rossum8d90f9d1997-05-22 20:13:25[diff] [blame]73
Guido van Rossumf501b4e1996-10-25 14:32:48[diff] [blame]74
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]75Documentation
76-------------
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]77
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]78All documentation is provided online in a variety of formats. In
79order of importance for new users: Tutorial, Library Reference,
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]80Language Reference, Extending & Embedding, and the Python/C API. The
81Library Reference is especially of immense value since much of
82Python's power is described there, including the built-in data types
83and functions!
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]84
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]85All documentation is also available online at the Python web site
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]86(http://www.python.org/doc/, see below). It is available online for
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]87occasional reference, or can be downloaded in many formats for faster
Fred Drake6caae142000-10-25 17:51:02[diff] [blame]88access. The documentation is available in HTML, PostScript, PDF, and
89LaTeX formats; the LaTeX version is primarily for documentation
90authors, translators, and people with special formatting requirements.
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]91
Michael W. Hudsonbe6e0f42002-06-23 16:29:36[diff] [blame]92The best documentation for the new (in Python 2.2) type/class
93unification features is Guido's tutorial introduction, at
Barry Warsaw06557452001-12-14 20:47:12[diff] [blame]94
Guido van Rossum1c63a592002-07-09 18:44:09[diff] [blame]95 http://www.python.org/2.2.1/descrintro.html
Barry Warsaw06557452001-12-14 20:47:12[diff] [blame]96
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]97
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]98Web sites
99---------
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]100
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]101New Python releases and related technologies are published at
Guido van Rossum67345eb2001-01-18 14:51:12[diff] [blame]102http://www.python.org/. Come visit us!
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]103
Michael W. Hudsonbe6e0f42002-06-23 16:29:36[diff] [blame]104There's also a Python community web site at
105http://starship.python.net/.
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]106
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]107
108Newsgroups and Mailing Lists
109----------------------------
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]110
111Read comp.lang.python, a high-volume discussion newsgroup about
112Python, or comp.lang.python.announce, a low-volume moderated newsgroup
113for Python-related announcements. These are also accessible as
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]114mailing lists: see http://www.python.org/psa/MailingLists.html for an
115overview of the many Python-related mailing lists.
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]116
Michael W. Hudsonbe6e0f42002-06-23 16:29:36[diff] [blame]117Archives are accessible via the Google Groups usenet archive; see
118http://groups.google.com/. The mailing lists are also archived, see
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]119http://www.python.org/psa/MailingLists.html for details.
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]120
121
122Bug reports
123-----------
124
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]125To report or search for bugs, please use the Python Bug
126Tracker at http://sourceforge.net/bugs/?group_id=5470.
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]127
128
129Patches and contributions
130-------------------------
131
Fred Drake6caae142000-10-25 17:51:02[diff] [blame]132To submit a patch or other contribution, please use the Python Patch
133Manager at http://sourceforge.net/patch/?group_id=5470. Guidelines
134for patch submission may be found at http://www.python.org/patches/.
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]135
136If you have a proposal to change Python, it's best to submit a Python
137Enhancement Proposal (PEP) first. All current PEPs, as well as
Walter Dörwald7dc65d62003-02-02 23:37:05[diff] [blame]138guidelines for submitting a new PEP, are listed at
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]139http://python.sourceforge.net/peps/.
140
141
142Questions
143---------
144
145For help, if you can't find it in the manuals or on the web site, it's
146best to post to the comp.lang.python or the Python mailing list (see
147above). If you specifically don't want to involve the newsgroup or
Guido van Rossum67345eb2001-01-18 14:51:12[diff] [blame]148mailing list, send questions to help@python.org (a group of volunteers
149who answer questions as they can). The newsgroup is the most
150efficient way to ask public questions.
Guido van Rossum627b2d71993-12-24 10:39:16[diff] [blame]151
Guido van Rossum901454e2000-06-29 22:28:44[diff] [blame]152
Guido van Rossum433c8ad1994-08-01 12:07:07[diff] [blame]153Build instructions
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]154==================
Guido van Rossum627b2d71993-12-24 10:39:16[diff] [blame]155
Guido van Rossum59b0b602002-02-08 22:22:35[diff] [blame]156Before you can build Python, you must first configure it.
157Fortunately, the configuration and build process has been automated
158for Unix and Linux installations, so all you usually have to do is
159type a few commands and sit back. There are some platforms where
160things are not quite as smooth; see the platform specific notes below.
161If you want to build for multiple platforms sharing the same source
162tree, see the section on VPATH below.
Guido van Rossum627b2d71993-12-24 10:39:16[diff] [blame]163
Guido van Rossum59b0b602002-02-08 22:22:35[diff] [blame]164Start by running the script "./configure", which determines your
165system configuration and creates the Makefile. (It takes a minute or
166two -- please be patient!) You may want to pass options to the
167configure script -- see the section below on configuration options and
168variables. When it's done, you are ready to run make.
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]169
Guido van Rossum59b0b602002-02-08 22:22:35[diff] [blame]170To build Python, you normally type "make" in the toplevel directory.
171If you have changed the configuration, the Makefile may have to be
172rebuilt. In this case you may have to run make again to correctly
173build your desired target. The interpreter executable is built in the
174top level directory.
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]175
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]176Once you have built a Python interpreter, see the subsections below on
Guido van Rossum59b0b602002-02-08 22:22:35[diff] [blame]177testing and installation. If you run into trouble, see the next
178section.
179
180Previous versions of Python used a manual configuration process that
181involved editing the file Modules/Setup. While this file still exists
182and manual configuration is still supported, it is rarely needed any
183more: almost all modules are automatically built as appropriate under
184guidance of the setup.py script, which is run by Make after the
185interpreter has been built.
Guido van Rossum627b2d71993-12-24 10:39:16[diff] [blame]186
Guido van Rossum0a516c91994-09-12 10:58:40[diff] [blame]187
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]188Troubleshooting
189---------------
Guido van Rossum627b2d71993-12-24 10:39:16[diff] [blame]190
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]191See also the platform specific notes in the next section.
192
Guido van Rossum49523691997-08-15 18:30:14[diff] [blame]193If you run into other trouble, see section 3 of the FAQ
Guido van Rossum901454e2000-06-29 22:28:44[diff] [blame]194(http://www.python.org/cgi-bin/faqw.py or
Guido van Rossum49523691997-08-15 18:30:14[diff] [blame]195http://www.python.org/doc/FAQ.html) for hints on what can go wrong,
196and how to fix it.
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]197
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]198If you rerun the configure script with different options, remove all
199object files by running "make clean" before rebuilding. Believe it or
200not, "make clean" sometimes helps to clean up other inexplicable
201problems as well. Try it before sending in a bug report!
202
Guido van Rossumd0fe8451996-08-26 03:02:37[diff] [blame]203If the configure script fails or doesn't seem to find things that
Guido van Rossumc0be2f51997-10-08 05:05:28[diff] [blame]204should be there, inspect the config.log file. When you fix a
205configure problem, be sure to remove config.cache!
206
207If you get a warning for every file about the -Olimit option being no
208longer supported, you can ignore it. There's no foolproof way to know
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]209whether this option is needed; all we can do is test whether it is
Guido van Rossumc0be2f51997-10-08 05:05:28[diff] [blame]210accepted without error. On some systems, e.g. older SGI compilers, it
211is essential for performance (specifically when compiling ceval.c,
212which has more basic blocks than the default limit of 1000). If the
213warning bothers you, edit the Makefile to remove "-Olimit 1500" from
214the OPT variable.
Guido van Rossumd0fe8451996-08-26 03:02:37[diff] [blame]215
Guido van Rossum7ac11532000-08-29 21:36:40[diff] [blame]216If you get failures in test_long, or sys.maxint gets set to -1, you
217are probably experiencing compiler bugs, usually related to
Martin v. Löwis9cea5f52002-11-15 07:28:05[diff] [blame]218optimization. This is a common problem with some versions of gcc, and
219some vendor-supplied compilers, which can sometimes be worked around
220by turning off optimization. Consider switching to stable versions
221(gcc 2.95.2, or contact your vendor.)
Guido van Rossum7ac11532000-08-29 21:36:40[diff] [blame]222
223From Python 2.0 onward, all Python C code is ANSI C. Compiling using
224old K&R-C-only compilers is no longer possible. ANSI C compilers are
225available for all modern systems, either in the form of updated
Martin v. Löwis9cea5f52002-11-15 07:28:05[diff] [blame]226compilers from the vendor, or one of the free compilers (gcc).
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]227
Barry Warsawb26f32f2003-08-04 22:49:46[diff] [blame]228
Martin v. Löwis779ffc02002-12-02 22:17:01[diff] [blame]229Unsupported systems
230-------------------
231
232A number of features are not supported in Python 2.3 anymore. Some
233support code is still present, but will be removed in Python 2.4.
234If you still need to use current Python versions on these systems,
235please send a message to python-dev@python.org indicating that you
236volunteer to support this system.
237
238More specifically, the following systems are not supported any
239longer:
240- SunOS 4
241- DYNIX
242- dgux
243- Minix
244- Irix 4 and --with-sgi-dl
245- Linux 1
246- Systems defining __d6_pthread_create (configure.in)
247- Systems defining PY_PTHREAD_D4, PY_PTHREAD_D6,
248 or PY_PTHREAD_D7 in thread_pthread.h
249- Systems using --with-dl-dld
Martin v. Löwis7e4cfcb2002-12-19 16:21:49[diff] [blame]250- Systems using --without-universal-newlines
Martin v. Löwis779ffc02002-12-02 22:17:01[diff] [blame]251
Barry Warsawb26f32f2003-08-04 22:49:46[diff] [blame]252
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]253Platform specific notes
254-----------------------
255
Guido van Rossum0447a321995-10-08 01:22:33[diff] [blame]256(Some of these may no longer apply. If you find you can build Python
Guido van Rossum67345eb2001-01-18 14:51:12[diff] [blame]257on these platforms without the special directions mentioned here,
258submit a documentation bug report to SourceForge (see Bug Reports
259above) so we can remove them!)
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]260
Skip Montanaro6dc4a8e2003-05-02 15:27:59[diff] [blame]261Unix platforms: If your vendor still ships (and you still use) Berkeley DB
262 1.85 you will need to edit Modules/Setup to build the bsddb185
263 module and add a line to sitecustomize.py which makes it the
264 default. In Modules/Setup a line like
265
266 bsddb185 bsddbmodule.c
267
268 should work. (You may need to add -I, -L or -l flags to direct the
269 compiler and linker to your include files and libraries.) You can
270 then force it to be the version people import by adding
271
272 import bsddb185 as bsddb
273
274 in sitecustomize.py.
275
Guido van Rossumc0be2f51997-10-08 05:05:28[diff] [blame]27664-bit platforms: The modules audioop, imageop and rgbimg don't work.
Guido van Rossum59b0b602002-02-08 22:22:35[diff] [blame]277 The setup.py script disables them on 64-bit installations.
Guido van Rossumc0be2f51997-10-08 05:05:28[diff] [blame]278 Don't try to enable them in the Modules/Setup file. They
279 contain code that is quite wordsize sensitive. (If you have a
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]280 fix, let us know!)
Guido van Rossumc0be2f51997-10-08 05:05:28[diff] [blame]281
Guido van Rossum4462e931997-01-22 21:00:32[diff] [blame]282Solaris: When using Sun's C compiler with threads, at least on Solaris
283 2.5.1, you need to add the "-mt" compiler option (the simplest
284 way is probably to specify the compiler with this option as
285 the "CC" environment variable when running the configure
286 script).
287
Guido van Rossum42992312002-09-23 14:02:18[diff] [blame]288 When using GCC on Solaris, beware of binutils 2.13 or GCC
289 versions built using it. This mistakenly enables the
290 -zcombreloc option which creates broken shared libraries on
291 Solaris. binutils 2.12 works, and the binutils maintainers
Skip Montanaro4de9cba2003-01-03 16:26:23[diff] [blame]292 are aware of the problem. Binutils 2.13.1 only partially
293 fixed things. It appears that 2.13.2 solves the problem
294 completely. This problem is known to occur with Solaris 2.7
295 and 2.8, but may also affect earlier and later versions of the
296 OS.
Guido van Rossum42992312002-09-23 14:02:18[diff] [blame]297
Martin v. Löwis9cea5f52002-11-15 07:28:05[diff] [blame]298 When the dynamic loader complains about errors finding shared
299 libraries, such as
300
301 ld.so.1: ./python: fatal: libstdc++.so.5: open failed:
302 No such file or directory
303
304 you need to first make sure that the library is available on
305 your system. Then, you need to instruct the dynamic loader how
Walter Dörwald7dc65d62003-02-02 23:37:05[diff] [blame]306 to find it. You can choose any of the following strategies:
Martin v. Löwis9cea5f52002-11-15 07:28:05[diff] [blame]307
308 1. When compiling Python, set LD_RUN_PATH to the directories
309 containing missing libraries.
310 2. When running Python, set LD_LIBRARY_PATH to these directories.
311 3. Use crle(8) to extend the search path of the loader.
312 4. Modify the installed GCC specs file, adding -R options into the
313 *link: section.
314
Guido van Rossum7ac11532000-08-29 21:36:40[diff] [blame]315Linux: A problem with threads and fork() was tracked down to a bug in
316 the pthreads code in glibc version 2.0.5; glibc version 2.0.7
317 solves the problem. This causes the popen2 test to fail;
318 problem and solution reported by Pablo Bleyer.
Guido van Rossum4462e931997-01-22 21:00:32[diff] [blame]319
Guido van Rossum7ac11532000-08-29 21:36:40[diff] [blame]320 Under Linux systems using GNU libc 2 (aka libc6), the crypt
Guido van Rossum59b0b602002-02-08 22:22:35[diff] [blame]321 module now needs the -lcrypt option. The setup.py script
322 takes care of this automatically.
Fred Drake61280911997-12-08 14:10:40[diff] [blame]323
Martin v. Löwis3efa04a2003-06-14 05:29:27[diff] [blame]324Red Hat Linux: Red Hat 9 built Python2.2 in UCS-4 mode and hacked
325 Tcl to support it. To compile Python2.3 with Tkinter, you will
326 need to pass --enable-unicode=ucs4 flag to ./configure.
327
328 There's an executable /usr/bin/python which is Python
329 1.5.2 on most older Red Hat installations; several key Red Hat tools
Guido van Rossum2dcec0c2002-02-04 01:59:23[diff] [blame]330 require this version. Python 2.1.x may be installed as
331 /usr/bin/python2. The Makefile installs Python as
332 /usr/local/bin/python, which may or may not take precedence
333 over /usr/bin/python, depending on how you have set up $PATH.
334
Guido van Rossum59230501999-06-21 20:51:46[diff] [blame]335FreeBSD 3.x and probably platforms with NCurses that use libmytinfo or
336 similar: When using cursesmodule, the linking is not done in
337 the correct order with the defaults. Remove "-ltermcap" from
338 the readline entry in Setup, and use as curses entry: "curses
339 cursesmodule.c -lmytinfo -lncurses -ltermcap" - "mytinfo" (so
340 called on FreeBSD) should be the name of the auxiliary library
341 required on your platform. Normally, it would be linked
342 automatically, but not necessarily in the correct order.
343
Guido van Rossum7ac11532000-08-29 21:36:40[diff] [blame]344BSDI: BSDI versions before 4.1 have known problems with threads,
345 which can cause strange errors in a number of modules (for
346 instance, the 'test_signal' test script will hang forever.)
347 Turning off threads (with --with-threads=no) or upgrading to
348 BSDI 4.1 solves this problem.
349
350DEC Unix: Run configure with --with-dec-threads, or with
351 --with-threads=no if no threads are desired (threads are on by
352 default). When using GCC, it is possible to get an internal
353 compiler error if optimization is used. This was reported for
354 GCC 2.7.2.3 on selectmodule.c. Manually compile the affected
355 file without optimization to solve the problem.
Guido van Rossum8eca2c21996-02-14 18:37:46[diff] [blame]356
Guido van Rossume1cdb161999-04-10 16:04:07[diff] [blame]357DEC Ultrix: compile with GCC to avoid bugs in the native compiler,
358 and pass SHELL=/bin/sh5 to Make when installing.
359
Guido van Rossumd0fe8451996-08-26 03:02:37[diff] [blame]360AIX: A complete overhaul of the shared library support is now in
Guido van Rossum16e809e2001-04-16 02:07:08[diff] [blame]361 place. See Misc/AIX-NOTES for some notes on how it's done.
Guido van Rossum9ac9a261998-02-16 22:19:21[diff] [blame]362 (The optimizer bug reported at this place in previous releases
Thomas Wouters8ee06142001-02-15 11:45:29[diff] [blame]363 has been worked around by a minimal code change.) If you get
Fred Drake59518b02002-05-11 03:36:26[diff] [blame]364 errors about pthread_* functions, during compile or during
Thomas Wouters8ee06142001-02-15 11:45:29[diff] [blame]365 testing, try setting CC to a thread-safe (reentrant) compiler,
366 like "cc_r". For full C++ module support, set CC="xlC_r" (or
367 CC="xlC" without thread support).
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]368
Skip Montanaro2d98db62003-01-06 17:23:37[diff] [blame]369HP-UX: When using threading, you may have to add -D_REENTRANT to the
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]370 OPT variable in the top-level Makefile; reported by Pat Knight,
Guido van Rossum59a88f41999-04-12 18:16:09[diff] [blame]371 this seems to make a difference (at least for HP-UX 10.20)
Anthony Baxter73affa92003-10-01 07:25:31[diff] [blame]372 even though pyconfig.h defines it. This seems unnecessary when
373 using HP/UX 11 and later - threading works "out of the box".
374
375HP-UX ia64: When building on the ia64 (Itanium) platform using HP's
376 compiler, some experience has shown that the compiler's
377 optimiser produces a completely broken version of python
378 (see http://www.python.org/sf/814976). To work around this,
379 edit the Makefile and remove -O from the OPT line.
Guido van Rossum2094e041998-05-14 15:47:35[diff] [blame]380
Guido van Rossum4e1dd7d2002-04-23 13:06:07[diff] [blame]381HP PA-RISC 2.0: A recent bug report (http://www.python.org/sf/546117)
382 suggests that the C compiler in this 64-bit system has bugs
383 in the optimizer that break Python. Compiling without
384 optimization solves the problems.
385
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]386SCO: The following apply to SCO 3 only; Python builds out of the box
387 on SCO 5 (or so we've heard).
Guido van Rossuma16e2751998-04-13 20:14:05[diff] [blame]388
389 1) Everything works much better if you add -U__STDC__ to the
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]390 defs. This is because all the SCO header files are broken.
Guido van Rossum64773801997-11-26 17:07:02[diff] [blame]391 Anything that isn't mentioned in the C standard is
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]392 conditionally excluded when __STDC__ is defined.
393
394 2) Due to the U.S. export restrictions, SCO broke the crypt
395 stuff out into a separate library, libcrypt_i.a so the LIBS
396 needed be set to:
397
398 LIBS=' -lsocket -lcrypt_i'
399
Martin v. Löwis387c5472001-09-06 08:16:17[diff] [blame]400UnixWare: There are known bugs in the math library of the system, as well as
401 problems in the handling of threads (calling fork in one
402 thread may interrupt system calls in others). Therefore, test_math and
403 tests involving threads will fail until those problems are fixed.
404
Guido van Rossum7ac11532000-08-29 21:36:40[diff] [blame]405SunOS 4.x: When using the SunPro C compiler, you may want to use the
Guido van Rossum64773801997-11-26 17:07:02[diff] [blame]406 '-Xa' option instead of '-Xc', to enable some needed non-ANSI
407 Sunisms.
Martin v. Löwis779ffc02002-12-02 22:17:01[diff] [blame]408 THIS SYSTEM IS NO LONGER SUPPORTED.
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]409
Jack Jansena39ef862001-08-19 21:17:03[diff] [blame]410NeXT: Not supported anymore. Start with the MacOSX/Darwin code if you
411 want to revive it.
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]412
Guido van Rossumb7f454d1997-12-02 19:44:31[diff] [blame]413QNX: Chris Herborth (chrish@qnx.com) writes:
414 configure works best if you use GNU bash; a port is available on
415 ftp.qnx.com in /usr/free. I used the following process to build,
Guido van Rossumd4493421998-12-22 16:37:01[diff] [blame]416 test and install Python 1.5.x under QNX:
Guido van Rossumb7f454d1997-12-02 19:44:31[diff] [blame]417
Guido van Rossumec95c7b1998-08-04 17:59:56[diff] [blame]418 1) CONFIG_SHELL=/usr/local/bin/bash CC=cc RANLIB=: \
419 ./configure --verbose --without-gcc --with-libm=""
Guido van Rossumb7f454d1997-12-02 19:44:31[diff] [blame]420
Fred Drake80078492000-10-26 17:13:19[diff] [blame]421 2) edit Modules/Setup to activate everything that makes sense for
422 your system... tested here at QNX with the following modules:
Guido van Rossumb7f454d1997-12-02 19:44:31[diff] [blame]423
Guido van Rossum6fa49e21998-08-11 17:31:39[diff] [blame]424 array, audioop, binascii, cPickle, cStringIO, cmath,
425 crypt, curses, errno, fcntl, gdbm, grp, imageop,
426 _locale, math, md5, new, operator, parser, pcre,
427 posix, pwd, readline, regex, reop, rgbimg, rotor,
428 select, signal, socket, soundex, strop, struct,
Guido van Rossumd4493421998-12-22 16:37:01[diff] [blame]429 syslog, termios, time, timing, zlib, audioop, imageop, rgbimg
Guido van Rossumb7f454d1997-12-02 19:44:31[diff] [blame]430
Guido van Rossum16e809e2001-04-16 02:07:08[diff] [blame]431 3) make SHELL=/usr/local/bin/bash
432
Guido van Rossumec95c7b1998-08-04 17:59:56[diff] [blame]433 or, if you feel the need for speed:
Guido van Rossum16e809e2001-04-16 02:07:08[diff] [blame]434
Guido van Rossumec95c7b1998-08-04 17:59:56[diff] [blame]435 make SHELL=/usr/local/bin/bash OPT="-5 -Oil+nrt"
Guido van Rossumb7f454d1997-12-02 19:44:31[diff] [blame]436
Guido van Rossumec95c7b1998-08-04 17:59:56[diff] [blame]437 4) make SHELL=/usr/local/bin/bash test
438
Guido van Rossum6fa49e21998-08-11 17:31:39[diff] [blame]439 Using GNU readline 2.2 seems to behave strangely, but I
440 think that's a problem with my readline 2.2 port. :-\
Guido van Rossumec95c7b1998-08-04 17:59:56[diff] [blame]441
442 5) make SHELL=/usr/local/bin/bash install
Guido van Rossumb7f454d1997-12-02 19:44:31[diff] [blame]443
Guido van Rossum6fa49e21998-08-11 17:31:39[diff] [blame]444 If you get SIGSEGVs while running Python (I haven't yet, but
445 I've only run small programs and the test cases), you're
446 probably running out of stack; the default 32k could be a
447 little tight. To increase the stack size, edit the Makefile
Neil Schemenauer73f8ab22001-01-26 22:18:55[diff] [blame]448 to read: LDFLAGS = -N 48k
Guido van Rossum40d63581997-08-14 19:45:30[diff] [blame]449
Skip Montanaro2d98db62003-01-06 17:23:37[diff] [blame]450BeOS: See Misc/BeOS-NOTES for notes about compiling/installing
451 Python on BeOS R3 or later. Note that only the PowerPC
452 platform is supported for R3; both PowerPC and x86 are
453 supported for R4.
Guido van Rossumec95c7b1998-08-04 17:59:56[diff] [blame]454
Michael W. Hudson33876f52002-07-31 09:55:25[diff] [blame]455Cray T3E: Mark Hadfield (m.hadfield@niwa.co.nz) writes:
456 Python can be built satisfactorily on a Cray T3E but based on
457 my experience with the NIWA T3E (2002-05-22, version 2.2.1)
458 there are a few bugs and gotchas. For more information see a
459 thread on comp.lang.python in May 2002 entitled "Building
460 Python on Cray T3E".
461
462 1) Use Cray's cc and not gcc. The latter was reported not to
463 work by Konrad Hinsen. It may work now, but it may not.
464
465 2) To set sys.platform to something sensible, pass the
466 following environment variable to the configure script:
467
468 MACHDEP=unicosmk
469
470 2) Run configure with option "--enable-unicode=ucs4".
471
472 3) The Cray T3E does not support dynamic linking, so extension
473 modules have to be built by adding (or uncommenting) lines
474 in Modules/Setup. The minimum set of modules is
475
476 posix, new, _sre, unicodedata
477
478 On NIWA's vanilla T3E system the following have also been
479 included successfully:
480
481 _codecs, _locale, _socket, _symtable, _testcapi, _weakref
482 array, binascii, cmath, cPickle, crypt, cStringIO, dbm
483 errno, fcntl, grp, math, md5, operator, parser, pcre, pwd
484 regex, rotor, select, struct, strop, syslog, termios
485 time, timing, xreadlines
486
487 4) Once the python executable and library have been built, make
488 will execute setup.py, which will attempt to build remaining
489 extensions and link them dynamically. Each of these attempts
490 will fail but should not halt the make process. This is
491 normal.
492
493 5) Running "make test" uses a lot of resources and causes
494 problems on our system. You might want to try running tests
495 singly or in small groups.
Guido van Rossum1bf0bf41997-08-20 23:50:51[diff] [blame]496
Guido van Rossum0078aaf1997-08-21 03:05:11[diff] [blame]497SGI: SGI's standard "make" utility (/bin/make or /usr/bin/make)
498 does not check whether a command actually changed the file it
499 is supposed to build. This means that whenever you say "make"
500 it will redo the link step. The remedy is to use SGI's much
Guido van Rossum7be8ca02001-04-14 13:09:53[diff] [blame]501 smarter "smake" utility (/usr/sbin/smake), or GNU make. If
Guido van Rossumc0be2f51997-10-08 05:05:28[diff] [blame]502 you set the first line of the Makefile to #!/usr/sbin/smake
503 smake will be invoked by make (likewise for GNU make).
Guido van Rossum0078aaf1997-08-21 03:05:11[diff] [blame]504
Guido van Rossum7be8ca02001-04-14 13:09:53[diff] [blame]505 WARNING: There are bugs in the optimizer of some versions of
506 SGI's compilers that can cause bus errors or other strange
507 behavior, especially on numerical operations. To avoid this,
508 try building with "make OPT=".
Fred Drake0b5fb2b2000-09-29 17:45:05[diff] [blame]509
Guido van Rossum64773801997-11-26 17:07:02[diff] [blame]510OS/2: If you are running Warp3 or Warp4 and have IBM's VisualAge C/C++
511 compiler installed, just change into the pc\os2vacpp directory
512 and type NMAKE. Threading and sockets are supported by default
513 in the resulting binaries of PYTHON15.DLL and PYTHON.EXE.
514
Fred Drake36ed5602000-10-06 01:58:48[diff] [blame]515Monterey (64-bit AIX): The current Monterey C compiler (Visual Age)
516 uses the OBJECT_MODE={32|64} environment variable to set the
517 compilation mode to either 32-bit or 64-bit (32-bit mode is
518 the default). Presumably you want 64-bit compilation mode for
519 this 64-bit OS. As a result you must first set OBJECT_MODE=64
520 in your environment before configuring (./configure) or
521 building (make) Python on Monterey.
522
523Reliant UNIX: The thread support does not compile on Reliant UNIX, and
524 there is a (minor) problem in the configure script for that
525 platform as well. This should be resolved in time for a
526 future release.
Trent Mick635f6fb2000-08-23 21:33:05[diff] [blame]527
Barry Warsaw6a8557d2002-10-14 18:04:39[diff] [blame]528MacOSX: The tests will crash on both 10.1 and 10.2 with SEGV in
Barry Warsaw6e753642002-10-14 18:15:35[diff] [blame]529 test_re and test_sre due to the small default stack size. If
530 you set the stack size to 2048 before doing a "make test" the
531 failure can be avoided. If you're using the tcsh (the default
532 on OSX), or csh shells use "limit stacksize 2048" and for the
533 bash shell, use "ulimit -s 2048".
Barry Warsaw06557452001-12-14 20:47:12[diff] [blame]534
Jack Jansen6a77cf12001-12-06 21:49:02[diff] [blame]535 On naked Darwin you may want to add the configure option
Jack Jansen4c398fd2001-10-08 13:21:15[diff] [blame]536 "--disable-toolbox-glue" to disable the glue code for the Carbon
Jack Jansen6a77cf12001-12-06 21:49:02[diff] [blame]537 interface modules. The modules themselves are currently only built
538 if you add the --enable-framework option, see below.
Barry Warsaw06557452001-12-14 20:47:12[diff] [blame]539
540 On a clean OSX /usr/local does not exist. Do a
Jack Jansen61fec302002-01-04 15:59:57[diff] [blame]541 "sudo mkdir -m 775 /usr/local"
Jack Jansen84a01642002-08-04 21:19:55[diff] [blame]542 before you do a make install. It is probably not a good idea to
543 do "sudo make install" which installs everything as superuser,
544 as this may later cause problems when installing distutils-based
545 additions.
546
547 Some people have reported problems building Python after using "fink"
548 to install additional unix software. Disabling fink (remove all references
549 to /sw from your .profile or .login) should solve this.
Barry Warsaw06557452001-12-14 20:47:12[diff] [blame]550
551 You may want to try the configure option "--enable-framework"
552 which installs Python as a framework. The location can be set
553 as argument to the --enable-framework option (default
Jack Jansen84a01642002-08-04 21:19:55[diff] [blame]554 /Library/Frameworks). A framework install is probably needed if you
555 want to use any Aqua-based GUI toolkit (whether Tkinter, wxPython,
556 Carbon, Cocoa or anything else).
557
558 See Mac/OSX/README for more information on framework builds.
Fred Drakedabed752001-02-01 19:41:13[diff] [blame]559
Michael W. Hudson1c4523f2001-12-19 19:49:58[diff] [blame]560Cygwin: With recent (relative to the time of writing, 2001-12-19)
561 Cygwin installations, there are problems with the interaction
562 of dynamic linking and fork(). This manifests itself in build
563 failures during the execution of setup.py.
Tim Peters42fc7cc2001-04-04 18:35:19[diff] [blame]564
Michael W. Hudson1c4523f2001-12-19 19:49:58[diff] [blame]565 There are two workarounds that both enable Python (albeit
566 without threading support) to build and pass all tests on
567 NT/2000 (and most likely XP as well, though reports of testing
568 on XP would be appreciated).
Guido van Rossum16e809e2001-04-16 02:07:08[diff] [blame]569
Michael W. Hudson1c4523f2001-12-19 19:49:58[diff] [blame]570 The workarounds:
571
572 (a) the band-aid fix is to link the _socket module statically
573 rather than dynamically (which is the default).
574
575 To do this, run "./configure --with-threads=no" including any
576 other options you need (--prefix, etc.). Then in Modules/Setup
Walter Dörwald7dc65d62003-02-02 23:37:05[diff] [blame]577 uncomment the lines:
Tim Peters42fc7cc2001-04-04 18:35:19[diff] [blame]578
Michael W. Hudsonbe5ce182001-12-12 11:46:52[diff] [blame]579 #SSL=/usr/local/ssl
580 #_socket socketmodule.c \
581 # -DUSE_SSL -I$(SSL)/include -I$(SSL)/include/openssl \
582 # -L$(SSL)/lib -lssl -lcrypto
Guido van Rossum16e809e2001-04-16 02:07:08[diff] [blame]583
Michael W. Hudson1c4523f2001-12-19 19:49:58[diff] [blame]584 and remove "local/" from the SSL variable. Finally, just run
585 "make"!
Tim Peters42fc7cc2001-04-04 18:35:19[diff] [blame]586
Michael W. Hudsonb6554642001-12-19 22:09:09[diff] [blame]587 (b) The "proper" fix is to rebase the Cygwin DLLs to prevent
Michael W. Hudson1c4523f2001-12-19 19:49:58[diff] [blame]588 base address conflicts. Details on how to do this can be
589 found in the following mail:
590
591 http://sources.redhat.com/ml/cygwin/2001-12/msg00894.html
592
593 It is hoped that a version of this solution will be
Michael W. Hudsonb6554642001-12-19 22:09:09[diff] [blame]594 incorporated into the Cygwin distribution fairly soon.
Michael W. Hudson1c4523f2001-12-19 19:49:58[diff] [blame]595
596 Two additional problems:
597
598 (1) Threading support should still be disabled due to a known
599 bug in Cygwin pthreads that causes test_threadedtempfile to
600 hang.
601
Neal Norwitz4ebde092001-12-19 20:44:13[diff] [blame]602 (2) The _curses module does not build. This is a known
Michael W. Hudson1c4523f2001-12-19 19:49:58[diff] [blame]603 Cygwin ncurses problem that should be resolved the next time
604 that this package is released.
Guido van Rossum16e809e2001-04-16 02:07:08[diff] [blame]605
Michael W. Hudsonbe5ce182001-12-12 11:46:52[diff] [blame]606 On older versions of Cygwin, test_poll may hang and test_strftime
607 may fail.
Tim Peters42fc7cc2001-04-04 18:35:19[diff] [blame]608
Michael W. Hudson1c4523f2001-12-19 19:49:58[diff] [blame]609 The situation on 9X/Me is not accurately known at present.
610 Some time ago, there were reports that the following
611 regression tests failed:
Tim Peters42fc7cc2001-04-04 18:35:19[diff] [blame]612
613 test_pwd
614 test_select (hang)
615 test_socket
616
Michael W. Hudson1c4523f2001-12-19 19:49:58[diff] [blame]617 Due to the test_select hang on 9X/Me, one should run the
618 regression test using the following:
Tim Peters42fc7cc2001-04-04 18:35:19[diff] [blame]619
Michael W. Hudsonbe5ce182001-12-12 11:46:52[diff] [blame]620 make TESTOPTS='-l -x test_select' test
Tim Peters42fc7cc2001-04-04 18:35:19[diff] [blame]621
Michael W. Hudson1c4523f2001-12-19 19:49:58[diff] [blame]622 News regarding these platforms with more recent Cygwin
623 versions would be appreciated!
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]624
Skip Montanaro56d83012003-01-04 04:05:51[diff] [blame]625AtheOS: From Octavian Cerna <tavy at ylabs.com>:
626
627 Before building:
628
629 Make sure you have shared versions of the libraries you
630 want to use with Python. You will have to compile them
631 yourself, or download precompiled packages.
632
633 Recommended libraries:
634
635 ncurses-4.2
636 readline-4.2a
637 zlib-1.1.4
638
639 Build:
640
641 $ ./configure --prefix=/usr/python
642 $ make
643
644 Python is always built as a shared library, otherwise
645 dynamic loading would not work.
646
647 Testing:
648
649 $ make test
650
651 Install:
652
653 # make install
654 # pkgmanager -a /usr/python
655
656
657 AtheOS issues:
658
659 - large file support: due to a stdio bug in glibc/libio,
660 access to large files may not work correctly. fseeko()
661 tries to seek to a negative offset. ftello() returns a
662 negative offset, it looks like a 32->64bit
663 sign-extension issue. The lowlevel functions (open,
664 lseek, etc) are OK.
665 - sockets: AF_UNIX is defined in the C library and in
666 Python, but not implemented in the system.
667 - select: poll is available in the C library, but does not
668 work (It does not return POLLNVAL for bad fds and
669 hangs).
Nicholas Bastineeeca4a2004-03-22 20:20:33[diff] [blame]670 (Believed fixed, unverified - autoconf check for broken poll)
Skip Montanaro56d83012003-01-04 04:05:51[diff] [blame]671 - posix: statvfs and fstatvfs always return ENOSYS.
672 - disabled modules:
673 - mmap: not yet implemented in AtheOS
674 - nis: broken (on an unconfigured system
675 yp_get_default_domain() returns junk instead of
676 error)
677 - dl: dynamic loading doesn't work via dlopen()
678 - resource: getrimit and setrlimit are not yet
679 implemented
680
681 - if you are getting segmentation faults, you probably are
682 low on memory. AtheOS doesn't handle very well an
683 out-of-memory condition and simply SEGVs the process.
684
685 Tested on:
686
687 AtheOS-0.3.7
688 gcc-2.95
689 binutils-2.10
690 make-3.78
691
692
Skip Montanaro57454e52002-06-14 20:30:31[diff] [blame]693Configuring the bsddb and dbm modules
694-------------------------------------
695
Skip Montanaro56d83012003-01-04 04:05:51[diff] [blame]696Beginning with Python version 2.3, the PyBsddb package
697<http://pybsddb.sf.net/> was adopted into Python as the bsddb package,
698exposing a set of package-level functions which provide
699backwards-compatible behavior. Only versions 3.1 through 4.1 of
700Sleepycat's libraries provide the necessary API, so older versions
701aren't supported through this interface. The old bsddb module has
702been retained as bsddb185, though it is not built by default. Users
703wishing to use it will have to tweak Modules/Setup to build it. The
704dbm module will still be built against the Sleepycat libraries if
705other preferred alternatives (ndbm, gdbm) are not found, though
706versions of the Sleepycat library prior to 3.1 are not considered.
Guido van Rossum62d45c02002-12-02 15:49:13[diff] [blame]707
Skip Montanaro57454e52002-06-14 20:30:31[diff] [blame]708
Guido van Rossumdc8a3cb1998-05-12 15:29:18[diff] [blame]709Configuring threads
710-------------------
711
Guido van Rossum7ac11532000-08-29 21:36:40[diff] [blame]712As of Python 2.0, threads are enabled by default. If you wish to
713compile without threads, or if your thread support is broken, pass the
714--with-threads=no switch to configure. Unfortunately, on some
715platforms, additional compiler and/or linker options are required for
716threads to work properly. Below is a table of those options,
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]717collected by Bill Janssen. We would love to automate this process
Guido van Rossum7ac11532000-08-29 21:36:40[diff] [blame]718more, but the information below is not enough to write a patch for the
719configure.in file, so manual intervention is required. If you patch
720the configure.in file and are confident that the patch works, please
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]721send in the patch. (Don't bother patching the configure script itself
Walter Dörwald7dc65d62003-02-02 23:37:05[diff] [blame]722-- it is regenerated each time the configure.in file changes.)
Guido van Rossumdc8a3cb1998-05-12 15:29:18[diff] [blame]723
724Compiler switches for threads
725.............................
726
Martin v. Löwis1c24f9c2001-03-06 12:07:27[diff] [blame]727The definition of _REENTRANT should be configured automatically, if
728that does not work on your system, or if _REENTRANT is defined
729incorrectly, please report that as a bug.
Guido van Rossumdc8a3cb1998-05-12 15:29:18[diff] [blame]730
Martin v. Löwis1c24f9c2001-03-06 12:07:27[diff] [blame]731 OS/Compiler/threads Switches for use with threads
732 (POSIX is draft 10, DCE is draft 4) compile & link
733
734 SunOS 5.{1-5}/{gcc,SunPro cc}/solaris -mt
735 SunOS 5.5/{gcc,SunPro cc}/POSIX (nothing)
Guido van Rossum16e809e2001-04-16 02:07:08[diff] [blame]736 DEC OSF/1 3.x/cc/DCE -threads
Guido van Rossumdc8a3cb1998-05-12 15:29:18[diff] [blame]737 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08[diff] [blame]738 Digital UNIX 4.x/cc/DCE -threads
Guido van Rossumdc8a3cb1998-05-12 15:29:18[diff] [blame]739 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08[diff] [blame]740 Digital UNIX 4.x/cc/POSIX -pthread
Guido van Rossumdc8a3cb1998-05-12 15:29:18[diff] [blame]741 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08[diff] [blame]742 AIX 4.1.4/cc_r/d7 (nothing)
Guido van Rossumdc8a3cb1998-05-12 15:29:18[diff] [blame]743 (buhrt@iquest.net)
Guido van Rossum16e809e2001-04-16 02:07:08[diff] [blame]744 AIX 4.1.4/cc_r4/DCE (nothing)
Guido van Rossumdc8a3cb1998-05-12 15:29:18[diff] [blame]745 (buhrt@iquest.net)
Guido van Rossum16e809e2001-04-16 02:07:08[diff] [blame]746 IRIX 6.2/cc/POSIX (nothing)
Guido van Rossumdc8a3cb1998-05-12 15:29:18[diff] [blame]747 (robertl@cwi.nl)
748
749
750Linker (ld) libraries and flags for threads
751...........................................
752
753 OS/threads Libraries/switches for use with threads
754
755 SunOS 5.{1-5}/solaris -lthread
756 SunOS 5.5/POSIX -lpthread
Guido van Rossum16e809e2001-04-16 02:07:08[diff] [blame]757 DEC OSF/1 3.x/DCE -lpthreads -lmach -lc_r -lc
Guido van Rossumdc8a3cb1998-05-12 15:29:18[diff] [blame]758 (butenhof@zko.dec.com)
759 Digital UNIX 4.x/DCE -lpthreads -lpthread -lmach -lexc -lc
760 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08[diff] [blame]761 Digital UNIX 4.x/POSIX -lpthread -lmach -lexc -lc
Guido van Rossumdc8a3cb1998-05-12 15:29:18[diff] [blame]762 (butenhof@zko.dec.com)
Guido van Rossum16e809e2001-04-16 02:07:08[diff] [blame]763 AIX 4.1.4/{draft7,DCE} (nothing)
Guido van Rossumdc8a3cb1998-05-12 15:29:18[diff] [blame]764 (buhrt@iquest.net)
Guido van Rossum16e809e2001-04-16 02:07:08[diff] [blame]765 IRIX 6.2/POSIX -lpthread
Guido van Rossumdc8a3cb1998-05-12 15:29:18[diff] [blame]766 (jph@emilia.engr.sgi.com)
767
768
Martin v. Löwis1142de32002-03-29 16:28:31[diff] [blame]769Building a shared libpython
770---------------------------
771
772Starting with Python 2.3, the majority of the interpreter can be built
773into a shared library, which can then be used by the interpreter
774executable, and by applications embedding Python. To enable this feature,
Martin v. Löwis65069672002-08-03 21:38:27[diff] [blame]775configure with --enable-shared.
776
Fred Drake55512dc2003-07-21 16:01:39[diff] [blame]777If you enable this feature, the same object files will be used to create
778a static library. In particular, the static library will contain object
779files using position-independent code (PIC) on platforms where PIC flags
780are needed for the shared library.
Martin v. Löwis1142de32002-03-29 16:28:31[diff] [blame]781
782
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]783Configuring additional built-in modules
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]784---------------------------------------
Guido van Rossum19e0c261995-01-17 16:36:34[diff] [blame]785
Andrew M. Kuchlingebe30452001-02-27 03:24:24[diff] [blame]786Starting with Python 2.1, the setup.py script at the top of the source
787distribution attempts to detect which modules can be built and
788automatically compiles them. Autodetection doesn't always work, so
Guido van Rossum59b0b602002-02-08 22:22:35[diff] [blame]789you can still customize the configuration by editing the Modules/Setup
790file; but this should be considered a last resort. The rest of this
791section only applies if you decide to edit the Modules/Setup file.
792You also need this to enable static linking of certain modules (which
793is needed to enable profiling on some systems).
794
Andrew M. Kuchlingebe30452001-02-27 03:24:24[diff] [blame]795This file is initially copied from Setup.dist by the configure script;
796if it does not exist yet, create it by copying Modules/Setup.dist
797yourself (configure will never overwrite it). Never edit Setup.dist
798-- always edit Setup or Setup.local (see below). Read the comments in
799the file for information on what kind of edits are allowed. When you
800have edited Setup in the Modules directory, the interpreter will
Guido van Rossumef67ded2001-10-05 17:04:42[diff] [blame]801automatically be rebuilt the next time you run make (in the toplevel
802directory).
Guido van Rossum627b2d71993-12-24 10:39:16[diff] [blame]803
Andrew M. Kuchlingebe30452001-02-27 03:24:24[diff] [blame]804Many useful modules can be built on any Unix system, but some optional
805modules can't be reliably autodetected. Often the quickest way to
806determine whether a particular module works or not is to see if it
807will build: enable it in Setup, then if you get compilation or link
Fred Drake6caae142000-10-25 17:51:02[diff] [blame]808errors, disable it -- you're either missing support or need to adjust
809the compilation and linking parameters for that module.
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]810
811On SGI IRIX, there are modules that interface to many SGI specific
Andrew M. Kuchlingebe30452001-02-27 03:24:24[diff] [blame]812system libraries, e.g. the GL library and the audio hardware. These
813modules will not be built by the setup.py script.
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]814
Guido van Rossum4462e931997-01-22 21:00:32[diff] [blame]815In addition to the file Setup, you can also edit the file Setup.local.
816(the makesetup script processes both). You may find it more
817convenient to edit Setup.local and leave Setup alone. Then, when
818installing a new Python version, you can copy your old Setup.local
819file.
820
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]821
822Setting the optimization/debugging options
823------------------------------------------
824
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]825If you want or need to change the optimization/debugging options for
826the C compiler, assign to the OPT variable on the toplevel make
827command; e.g. "make OPT=-g" will build a debugging version of Python
828on most platforms. The default is OPT=-O; a value for OPT in the
829environment when the configure script is run overrides this default
830(likewise for CC; and the initial value for LIBS is used as the base
831set of libraries to link with).
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]832
Fred Drake6caae142000-10-25 17:51:02[diff] [blame]833When compiling with GCC, the default value of OPT will also include
834the -Wall and -Wstrict-prototypes options.
835
836Additional debugging code to help debug memory management problems can
837be enabled by using the --with-pydebug option to the configure script.
838
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]839
Guido van Rossuma68ca352001-10-04 17:00:07[diff] [blame]840Profiling
841---------
842
843If you want C profiling turned on, the easiest way is to run configure
844with the CC environment variable to the necessary compiler
845invocation. For example, on Linux, this works for profiling using
846gprof(1):
847
848 CC="gcc -pg" ./configure
849
850Note that on Linux, gprof apparently does not work for shared
851libraries. The Makefile/Setup mechanism can be used to compile and
Walter Dörwald7dc65d62003-02-02 23:37:05[diff] [blame]852link most extension modules statically.
Guido van Rossuma68ca352001-10-04 17:00:07[diff] [blame]853
854
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]855Testing
856-------
Guido van Rossum433c8ad1994-08-01 12:07:07[diff] [blame]857
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]858To test the interpreter, type "make test" in the top-level directory.
Guido van Rossum6ae5d3d1997-05-14 21:39:05[diff] [blame]859This runs the test set twice (once with no compiled files, once with
860the compiled files left by the previous test run). The test set
861produces some output. You can generally ignore the messages about
Guido van Rossum59b0b602002-02-08 22:22:35[diff] [blame]862skipped tests due to optional features which can't be imported.
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]863If a message is printed about a failed test or a traceback or core
864dump is produced, something is wrong. On some Linux systems (those
Guido van Rossum24df6841997-12-30 04:32:30[diff] [blame]865that are not yet using glibc 6), test_strftime fails due to a
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]866non-standard implementation of strftime() in the C library. Please
867ignore this, or upgrade to glibc version 6.
Guido van Rossum433c8ad1994-08-01 12:07:07[diff] [blame]868
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]869IMPORTANT: If the tests fail and you decide to mail a bug report,
870*don't* include the output of "make test". It is useless. Run the
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]871failing test manually, as follows:
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]872
Andrew M. Kuchling83d042d2002-03-21 23:52:20[diff] [blame]873 ./python ./Lib/test/test_whatever.py
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]874
Andrew M. Kuchling83d042d2002-03-21 23:52:20[diff] [blame]875(substituting the top of the source tree for '.' if you built in a
Guido van Rossum6ae5d3d1997-05-14 21:39:05[diff] [blame]876different directory). This runs the test in verbose mode.
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]877
878
879Installing
880----------
881
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]882To install the Python binary, library modules, shared library modules
883(see below), include files, configuration files, and the manual page,
Guido van Rossum64773801997-11-26 17:07:02[diff] [blame]884just type
885
886 make install
887
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]888This will install all platform-independent files in subdirectories of
889the directory given with the --prefix option to configure or to the
890`prefix' Make variable (default /usr/local). All binary and other
891platform-specific files will be installed in subdirectories if the
892directory given by --exec-prefix or the `exec_prefix' Make variable
893(defaults to the --prefix directory) is given.
Guido van Rossum64773801997-11-26 17:07:02[diff] [blame]894
Martin v. Löwis3b8ee082003-05-11 20:25:35[diff] [blame]895If DESTDIR is set, it will be taken as the root directory of the
896installation, and files will be installed into $(DESTDIR)$(prefix),
897$(DESTDIR)$(exec_prefix), etc.
898
Guido van Rossum64773801997-11-26 17:07:02[diff] [blame]899All subdirectories created will have Python's version number in their
900name, e.g. the library modules are installed in
Guido van Rossum67345eb2001-01-18 14:51:12[diff] [blame]901"/usr/local/lib/python<version>/" by default, where <version> is the
902<major>.<minor> release number (e.g. "2.1"). The Python binary is
903installed as "python<version>" and a hard link named "python" is
904created. The only file not installed with a version number in its
905name is the manual page, installed as "/usr/local/man/man1/python.1"
906by default.
Guido van Rossum433c8ad1994-08-01 12:07:07[diff] [blame]907
Neil Schemenauer0e91dc72001-02-16 04:18:08[diff] [blame]908If you have a previous installation of Python that you don't
Guido van Rossum64773801997-11-26 17:07:02[diff] [blame]909want to replace yet, use
910
911 make altinstall
912
913This installs the same set of files as "make install" except it
Guido van Rossum67345eb2001-01-18 14:51:12[diff] [blame]914doesn't create the hard link to "python<version>" named "python" and
915it doesn't install the manual page at all.
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]916
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]917The only thing you may have to install manually is the Python mode for
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]918Emacs found in Misc/python-mode.el. (But then again, more recent
919versions of Emacs may already have it.) Follow the instructions that
920came with Emacs for installation of site-specific files.
Guido van Rossum433c8ad1994-08-01 12:07:07[diff] [blame]921
Jack Jansena39ef862001-08-19 21:17:03[diff] [blame]922On Mac OS X, if you have configured Python with --enable-framework, you
923should use "make frameworkinstall" to do the installation. Note that this
924installs the Python executable in a place that is not normally on your
925PATH, you may want to set up a symlink in /usr/local/bin.
926
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]927
928Configuration options and variables
929-----------------------------------
Guido van Rossum433c8ad1994-08-01 12:07:07[diff] [blame]930
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]931Some special cases are handled by passing options to the configure
932script.
Guido van Rossum433c8ad1994-08-01 12:07:07[diff] [blame]933
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]934WARNING: if you rerun the configure script with different options, you
935must run "make clean" before rebuilding. Exceptions to this rule:
936after changing --prefix or --exec-prefix, all you need to do is remove
Guido van Rossumb06df271997-08-05 21:50:20[diff] [blame]937Modules/getpath.o.
Guido van Rossum433c8ad1994-08-01 12:07:07[diff] [blame]938
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]939--with(out)-gcc: The configure script uses gcc (the GNU C compiler) if
940 it finds it. If you don't want this, or if this compiler is
941 installed but broken on your platform, pass the option
942 --without-gcc. You can also pass "CC=cc" (or whatever the
943 name of the proper C compiler is) in the environment, but the
944 advantage of using --without-gcc is that this option is
945 remembered by the config.status script for its --recheck
946 option.
Guido van Rossum76be6ed1995-01-02 18:33:54[diff] [blame]947
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]948--prefix, --exec-prefix: If you want to install the binaries and the
949 Python library somewhere else than in /usr/local/{bin,lib},
950 you can pass the option --prefix=DIRECTORY; the interpreter
951 binary will be installed as DIRECTORY/bin/python and the
952 library files as DIRECTORY/lib/python/*. If you pass
953 --exec-prefix=DIRECTORY (as well) this overrides the
954 installation prefix for architecture-dependent files (like the
955 interpreter binary). Note that --prefix=DIRECTORY also
956 affects the default module search path (sys.path), when
957 Modules/config.c is compiled. Passing make the option
958 prefix=DIRECTORY (and/or exec_prefix=DIRECTORY) overrides the
959 prefix set at configuration time; this may be more convenient
960 than re-running the configure script if you change your mind
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]961 about the install prefix.
Guido van Rossum76be6ed1995-01-02 18:33:54[diff] [blame]962
Guido van Rossum59b0b602002-02-08 22:22:35[diff] [blame]963--with-readline: This option is no longer supported. GNU
964 readline is automatically enabled by setup.py when present.
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]965
Guido van Rossum7ac11532000-08-29 21:36:40[diff] [blame]966--with-threads: On most Unix systems, you can now use multiple
967 threads, and support for this is enabled by default. To
968 disable this, pass --with-threads=no. If the library required
969 for threads lives in a peculiar place, you can use
970 --with-thread=DIRECTORY. IMPORTANT: run "make clean" after
971 changing (either enabling or disabling) this option, or you
972 will get link errors! Note: for DEC Unix use
Guido van Rossum0e13da91998-02-22 04:36:34[diff] [blame]973 --with-dec-threads instead.
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]974
975--with-sgi-dl: On SGI IRIX 4, dynamic loading of extension modules is
976 supported by the "dl" library by Jack Jansen, which is
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]977 ftp'able from ftp://ftp.cwi.nl/pub/dynload/dl-1.6.tar.Z.
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]978 This is enabled (after you've ftp'ed and compiled the dl
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]979 library) by passing --with-sgi-dl=DIRECTORY where DIRECTORY
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]980 is the absolute pathname of the dl library. (Don't bother on
981 IRIX 5, it already has dynamic linking using SunOS style
Martin v. Löwis779ffc02002-12-02 22:17:01[diff] [blame]982 shared libraries.) THIS OPTION IS UNSUPPORTED.
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]983
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]984--with-dl-dld: Dynamic loading of modules is rumored to be supported
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]985 on some other systems: VAX (Ultrix), Sun3 (SunOS 3.4), Sequent
986 Symmetry (Dynix), and Atari ST. This is done using a
987 combination of the GNU dynamic loading package
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]988 (ftp://ftp.cwi.nl/pub/dynload/dl-dld-1.1.tar.Z) and an
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]989 emulation of the SGI dl library mentioned above (the emulation
990 can be found at
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]991 ftp://ftp.cwi.nl/pub/dynload/dld-3.2.3.tar.Z). To
Guido van Rossum16e809e2001-04-16 02:07:08[diff] [blame]992 enable this, ftp and compile both libraries, then call
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]993 configure, passing it the option
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]994 --with-dl-dld=DL_DIRECTORY,DLD_DIRECTORY where DL_DIRECTORY is
995 the absolute pathname of the dl emulation library and
996 DLD_DIRECTORY is the absolute pathname of the GNU dld library.
997 (Don't bother on SunOS 4 or 5, they already have dynamic
Martin v. Löwis779ffc02002-12-02 22:17:01[diff] [blame]998 linking using shared libraries.) THIS OPTION IS UNSUPPORTED.
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]999
1000--with-libm, --with-libc: It is possible to specify alternative
1001 versions for the Math library (default -lm) and the C library
1002 (default the empty string) using the options
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]1003 --with-libm=STRING and --with-libc=STRING, respectively. For
1004 example, if your system requires that you pass -lc_s to the C
1005 compiler to use the shared C library, you can pass
1006 --with-libc=-lc_s. These libraries are passed after all other
1007 libraries, the C library last.
Guido van Rossum16e809e2001-04-16 02:07:08[diff] [blame]1008
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]1009--with-libs='libs': Add 'libs' to the LIBS that the python interpreter
1010 is linked against.
Guido van Rossumd02ba451996-07-31 17:36:01[diff] [blame]1011
Martin v. Löwis2df66942000-12-13 14:14:32[diff] [blame]1012--with-cxx=<compiler>: Some C++ compilers require that main() is
1013 compiled with the C++ if there is any C++ code in the application.
1014 Specifically, g++ on a.out systems may require that to support
1015 construction of global objects. With this option, the main() function
1016 of Python will be compiled with <compiler>; use that only if you
1017 plan to use C++ extension modules, and if your compiler requires
1018 compilation of main() as a C++ program.
1019
1020
Fred Drake6caae142000-10-25 17:51:02[diff] [blame]1021--with-pydebug: Enable additional debugging code to help track down
1022 memory management problems. This allows printing a list of all
1023 live objects when the interpreter terminates.
Jack Jansen7b8c7542002-04-14 20:12:41[diff] [blame]1024
1025--with(out)-universal-newlines: enable reading of text files with
1026 foreign newline convention (default: enabled). In other words,
1027 any of \r, \n or \r\n is acceptable as end-of-line character.
1028 If enabled import and execfile will automatically accept any newline
1029 in files. Python code can open a file with open(file, 'U') to
Martin v. Löwis7e4cfcb2002-12-19 16:21:49[diff] [blame]1030 read it in universal newline mode. THIS OPTION IS UNSUPPORTED.
Fred Drake6caae142000-10-25 17:51:02[diff] [blame]1031
Guido van Rossum76be6ed1995-01-02 18:33:54[diff] [blame]1032
Guido van Rossum433c8ad1994-08-01 12:07:07[diff] [blame]1033Building for multiple architectures (using the VPATH feature)
1034-------------------------------------------------------------
1035
1036If your file system is shared between multiple architectures, it
1037usually is not necessary to make copies of the sources for each
1038architecture you want to support. If the make program supports the
1039VPATH feature, you can create an empty build directory for each
1040architecture, and in each directory run the configure script (on the
1041appropriate machine with the appropriate options). This creates the
1042necessary subdirectories and the Makefiles therein. The Makefiles
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]1043contain a line VPATH=... which points to a directory containing the
Guido van Rossumd0fe8451996-08-26 03:02:37[diff] [blame]1044actual sources. (On SGI systems, use "smake -J1" instead of "make" if
1045you use VPATH -- don't try gnumake.)
Guido van Rossum433c8ad1994-08-01 12:07:07[diff] [blame]1046
1047For example, the following is all you need to build a minimal Python
1048in /usr/tmp/python (assuming ~guido/src/python is the toplevel
1049directory and you want to build in /usr/tmp/python):
1050
1051 $ mkdir /usr/tmp/python
1052 $ cd /usr/tmp/python
1053 $ ~guido/src/python/configure
1054 [...]
1055 $ make
1056 [...]
1057 $
1058
Neil Schemenauer73f8ab22001-01-26 22:18:55[diff] [blame]1059Note that configure copies the original Setup file to the build
Guido van Rossum433c8ad1994-08-01 12:07:07[diff] [blame]1060directory if it finds no Setup file there. This means that you can
1061edit the Setup file for each architecture independently. For this
1062reason, subsequent changes to the original Setup file are not tracked
1063automatically, as they might overwrite local changes. To force a copy
1064of a changed original Setup file, delete the target Setup file. (The
1065makesetup script supports multiple input files, so if you want to be
1066fancy you can change the rules to create an empty Setup.local if it
1067doesn't exist and run it with arguments $(srcdir)/Setup Setup.local;
1068however this assumes that you only need to add modules.)
1069
1070
Guido van Rossum433c8ad1994-08-01 12:07:07[diff] [blame]1071Building on non-UNIX systems
1072----------------------------
1073
Tim Peters03444242000-09-19 00:38:35[diff] [blame]1074For Windows (2000/NT/ME/98/95), assuming you have MS VC++ 6.0, the
1075project files are in PCbuild, the workspace is pcbuild.dsw. See
1076PCbuild\readme.txt for detailed instructions.
Guido van Rossum8d7d4ed1996-07-30 21:41:07[diff] [blame]1077
Guido van Rossum31ae2071999-04-12 14:47:30[diff] [blame]1078For other non-Unix Windows compilers, in particular Windows 3.1 and
1079for OS/2, enter the directory "PC" and read the file "readme.txt".
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]1080
1081For the Mac, a separate source distribution will be made available,
1082for use with the CodeWarrior compiler. If you are interested in Mac
1083development, join the PythonMac Special Interest Group
1084(http://www.python.org/sigs/pythonmac-sig/, or send email to
1085pythonmac-sig-request@python.org).
1086
1087Of course, there are also binary distributions available for these
Guido van Rossum67345eb2001-01-18 14:51:12[diff] [blame]1088platforms -- see http://www.python.org/.
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]1089
1090To port Python to a new non-UNIX system, you will have to fake the
1091effect of running the configure script manually (for Mac and PC, this
1092has already been done for you). A good start is to copy the file
Michael W. Hudsonbe6e0f42002-06-23 16:29:36[diff] [blame]1093pyconfig.h.in to pyconfig.h and edit the latter to reflect the actual
Guido van Rossum433c8ad1994-08-01 12:07:07[diff] [blame]1094configuration of your system. Most symbols must simply be defined as
10951 only if the corresponding feature is present and can be left alone
Michael W. Hudsonbe6e0f42002-06-23 16:29:36[diff] [blame]1096otherwise; however the *_t type symbols must be defined as some
1097variant of int if they need to be defined at all.
Guido van Rossum433c8ad1994-08-01 12:07:07[diff] [blame]1098
Barry Warsaw06557452001-12-14 20:47:12[diff] [blame]1099For all platforms, it's important that the build arrange to define the
1100preprocessor symbol NDEBUG on the compiler command line in a release
1101build of Python (else assert() calls remain in the code, hurting
1102release-build performance). The Unix, Windows and Mac builds already
1103do this.
Guido van Rossum433c8ad1994-08-01 12:07:07[diff] [blame]1104
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]1105
1106Miscellaneous issues
1107====================
1108
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]1109Emacs mode
1110----------
1111
Guido van Rossumc0be2f51997-10-08 05:05:28[diff] [blame]1112There's an excellent Emacs editing mode for Python code; see the file
1113Misc/python-mode.el. Originally written by the famous Tim Peters, it
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]1114is now maintained by the equally famous Barry Warsaw (it's no
Guido van Rossum67345eb2001-01-18 14:51:12[diff] [blame]1115coincidence that they now both work on the same team). The latest
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]1116version, along with various other contributed Python-related Emacs
Guido van Rossum67345eb2001-01-18 14:51:12[diff] [blame]1117goodies, is online at http://www.python.org/emacs/python-mode. And
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]1118if you are planning to edit the Python C code, please pick up the
Guido van Rossum67345eb2001-01-18 14:51:12[diff] [blame]1119latest version of CC Mode http://www.python.org/emacs/cc-mode; it
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]1120contains a "python" style used throughout most of the Python C source
1121files. (Newer versions of Emacs or XEmacs may already come with the
1122latest version of python-mode.)
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]1123
1124
Guido van Rossum59b0b602002-02-08 22:22:35[diff] [blame]1125Tkinter
1126-------
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]1127
Guido van Rossum59b0b602002-02-08 22:22:35[diff] [blame]1128The setup.py script automatically configures this when it detects a
1129usable Tcl/Tk installation. This requires Tcl/Tk version 8.0 or
Fred Drake8179a9d2000-09-28 23:28:30[diff] [blame]1130higher.
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]1131
Guido van Rossum973e4dc2000-07-01 00:34:39[diff] [blame]1132For more Tkinter information, see the Tkinter Resource page:
1133http://www.python.org/topics/tkinter/
Guido van Rossumc0be2f51997-10-08 05:05:28[diff] [blame]1134
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]1135There are demos in the Demo/tkinter directory, in the subdirectories
1136guido, matt and www (the matt and guido subdirectories have been
1137overhauled to use more recent Tkinter coding conventions).
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]1138
1139Note that there's a Python module called "Tkinter" (capital T) which
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]1140lives in Lib/lib-tk/Tkinter.py, and a C module called "_tkinter"
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]1141(lower case t and leading underscore) which lives in
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]1142Modules/_tkinter.c. Demos and normal Tk applications import only the
Guido van Rossum59b0b602002-02-08 22:22:35[diff] [blame]1143Python Tkinter module -- only the latter imports the C _tkinter
1144module. In order to find the C _tkinter module, it must be compiled
1145and linked into the Python interpreter -- the setup.py script does
1146this. In order to find the Python Tkinter module, sys.path must be
1147set correctly -- normal installation takes care of this.
Guido van Rossum84c8c7f1995-08-28 02:44:24[diff] [blame]1148
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]1149
Guido van Rossum433c8ad1994-08-01 12:07:07[diff] [blame]1150Distribution structure
1151----------------------
1152
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]1153Most subdirectories have their own README files. Most files have
Guido van Rossum433c8ad1994-08-01 12:07:07[diff] [blame]1154comments.
1155
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]1156.cvsignore Additional filename matching patterns for CVS to ignore
1157BeOS/ Files specific to the BeOS port
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]1158Demo/ Demonstration scripts, modules and programs
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]1159Doc/ Documentation sources (LaTeX)
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]1160Grammar/ Input for the parser generator
1161Include/ Public header files
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]1162LICENSE Licensing information
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]1163Lib/ Python library modules
Michael W. Hudsonbe6e0f42002-06-23 16:29:36[diff] [blame]1164Mac/ Macintosh specific resources
Neil Schemenauer3f52da52001-01-24 17:49:59[diff] [blame]1165Makefile.pre.in Source from which config.status creates the Makefile.pre
Guido van Rossumc0be2f51997-10-08 05:05:28[diff] [blame]1166Misc/ Miscellaneous useful files
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]1167Modules/ Implementation of most built-in modules
1168Objects/ Implementation of most built-in object types
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]1169PC/ Files specific to PC ports (DOS, Windows, OS/2)
1170PCbuild/ Build directory for Microsoft Visual C++
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]1171Parser/ The parser and tokenizer and their input handling
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]1172Python/ The byte-compiler and interpreter
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]1173README The file you're reading now
1174Tools/ Some useful programs written in Python
Michael W. Hudsonbe6e0f42002-06-23 16:29:36[diff] [blame]1175pyconfig.h.in Source from which pyconfig.h is created (GNU autoheader output)
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]1176configure Configuration shell script (GNU autoconf output)
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]1177configure.in Configuration specification (input for GNU autoconf)
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]1178install-sh Shell script used to install files
Guido van Rossum91cb9d21995-04-10 11:47:38[diff] [blame]1179
1180The following files will (may) be created in the toplevel directory by
1181the configuration and build processes:
1182
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]1183Makefile Build rules
Neil Schemenauer3f52da52001-01-24 17:49:59[diff] [blame]1184Makefile.pre Build rules before running Modules/makesetup
Michael W. Hudsonbe6e0f42002-06-23 16:29:36[diff] [blame]1185buildno Keeps track of the build number
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]1186config.cache Cache of configuration variables
Michael W. Hudsonbe6e0f42002-06-23 16:29:36[diff] [blame]1187pyconfig.h Configuration header
Guido van Rossumc0be2f51997-10-08 05:05:28[diff] [blame]1188config.log Log from last configure run
Guido van Rossum4f40c2d2000-09-05 16:46:22[diff] [blame]1189config.status Status from last run of the configure script
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]1190getbuildinfo.o Object file from Modules/getbuildinfo.c
Guido van Rossum67345eb2001-01-18 14:51:12[diff] [blame]1191libpython<version>.a The library archive
Guido van Rossum6d9cc801996-08-01 17:31:22[diff] [blame]1192python The executable interpreter
1193tags, TAGS Tags files for vi and Emacs
Guido van Rossum433c8ad1994-08-01 12:07:07[diff] [blame]1194
1195
Guido van Rossumc07d5fa2000-09-01 22:50:02[diff] [blame]1196That's all, folks!
1197------------------
Guido van Rossum433c8ad1994-08-01 12:07:07[diff] [blame]1198
1199
Guido van Rossum67345eb2001-01-18 14:51:12[diff] [blame]1200--Guido van Rossum (home page: http://www.python.org/~guido/)