blob: 9c0fb32f8f909577a2735c8cdbae534339366778 [file] [log] [blame]
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00001This is Python version 2.0 beta 1
2=================================
Guido van Rossum91447632000-04-11 17:11:09 +00003
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00004Copyright (c) 2000 BeOpen.com.
5All rights reserved.
6
7Copyright (c) 1995-2000 Corporation for National Research Initiatives.
8All rights reserved.
9
Guido van Rossum6ebd2992000-09-03 04:47:47 +000010Copyright (c) 1991-1995 Stichting Mathematisch Centrum.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000011All rights reserved.
12
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000013
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000014License information
15-------------------
16
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000017See the file "LICENSE" for information on the history of this
18software, terms & conditions for usage, and a DISCLAIMER OF ALL
19WARRANTIES.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000020
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000021This Python distribution contains no GNU General Public Licensed
22(GPLed) code so it may be used in proprietary projects just like prior
23Python distributions. There are interfaces to some GNU code but these
24are entirely optional.
25
26All trademarks referenced herein are property of their respective
27holders.
Guido van Rossum79808261997-12-11 18:01:47 +000028
29
Guido van Rossum8d7d4ed1996-07-30 21:41:07 +000030What's new in this release?
31---------------------------
Guido van Rossum3ff96dd1996-07-30 18:05:04 +000032
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000033See the file "Misc/NEWS"; see also this URL:
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000034http://www.pythonlabs.com/tech/python2.html
Guido van Rossum64773801997-11-26 17:07:02 +000035
Guido van Rossum64773801997-11-26 17:07:02 +000036
37If you don't read instructions
38------------------------------
39
40Congratulations on getting this far. :-)
41
42To start building right away (on UNIX): type "./configure" in the
43current directory and when it finishes, type "make". The section
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000044`Build Instructions' below is still recommended reading, especially
45the part on customizing Modules/Setup.
Guido van Rossum3ff96dd1996-07-30 18:05:04 +000046
47
Guido van Rossum91cb9d21995-04-10 11:47:38 +000048What is Python anyway?
49----------------------
50
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000051Python is an interpreted object-oriented programming language suitable
52(amongst other uses) for distributed application development,
53scripting, numeric computing and system testing. Python is often
54compared to Tcl, Perl, Java, JavaScript, Visual Basic or Scheme. To
55find out more about what Python can do for you, point your browser to
56http://www.pythonlabs.com/.
57
58BeOpen Python releases include pre-built Python executables for major
59platforms and are available from PythonLabs.
Guido van Rossum91cb9d21995-04-10 11:47:38 +000060
61
Guido van Rossumf501b4e1996-10-25 14:32:48 +000062How do I learn Python?
63----------------------
64
Fred Drake0e6444c1999-05-17 19:35:01 +000065The official tutorial is still a good place to start; see
Guido van Rossumd0a42e22000-03-31 20:16:45 +000066http://www.python.org/doc/ for online and downloadable versions, as
67well as a list of other introductions, and reference documentation.
Guido van Rossumf501b4e1996-10-25 14:32:48 +000068
Guido van Rossumd0a42e22000-03-31 20:16:45 +000069There's a quickly growing set of books on Python. See
70http://www.python.org/psa/bookstore/ for a list.
Guido van Rossum8d90f9d1997-05-22 20:13:25 +000071
Guido van Rossumf501b4e1996-10-25 14:32:48 +000072
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000073Documentation
74-------------
Guido van Rossum91cb9d21995-04-10 11:47:38 +000075
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000076All documentation is provided online in a variety of formats. In
77order of importance for new users: Tutorial, Library Reference,
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000078Language Reference, Extending & Embedding, and the Python/C API. The
79Library Reference is especially of immense value since much of
80Python's power is described there, including the built-in data types
81and functions!
Guido van Rossum91cb9d21995-04-10 11:47:38 +000082
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000083All documentation is also available online at the Python web site
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000084(http://www.python.org/doc/, see below). It is available online for
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000085occasional reference, or can be downloaded in many formats for faster
86access. The documentation is available in HTML, PostScript, PDF, HTML
87Help, and LaTeX formats; the LaTeX version is primarily for
88documentation authors or people with special formatting requirements.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000089
90
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000091Web sites
92---------
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000093
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000094New Python releases and related technologies are published at
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000095http://www.pythonlabs.com/. Come visit us!
96
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000097The present Python community web site is http://www.python.org/.
98BeOpen.com is developing a next-generation community site for Python
99and is looking for volunteers to help make this an even better
100resource than the existing community site. If you know Python well
101and would like to volunteer to work with us on this project, please
102contact <volunteer@pythonlabs.com> with a summary of your skills.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000103
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000104
105Newsgroups and Mailing Lists
106----------------------------
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000107
108Read comp.lang.python, a high-volume discussion newsgroup about
109Python, or comp.lang.python.announce, a low-volume moderated newsgroup
110for Python-related announcements. These are also accessible as
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000111mailing lists: see http://www.python.org/psa/MailingLists.html for an
112overview of the many Python-related mailing lists.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000113
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000114Archives are accessible via Deja.com Usenet News: see
115http://www.deja.com/usenet. The mailing lists are also archived, see
116http://www.python.org/psa/MailingLists.html for details.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000117
118
119Bug reports
120-----------
121
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000122To report or search for bugs, please use the Python Bug
123Tracker at http://sourceforge.net/bugs/?group_id=5470.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000124
125
126Patches and contributions
127-------------------------
128
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000129To submit a patch or other contribution, please use the Python
130Patch Manager at http://sourceforge.net/patch/?group_id=5470.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000131
132If you have a proposal to change Python, it's best to submit a Python
133Enhancement Proposal (PEP) first. All current PEPs, as well as
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000134guidelines for submitting a new PEP, are list at
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000135http://python.sourceforge.net/peps/.
136
137
138Questions
139---------
140
141For help, if you can't find it in the manuals or on the web site, it's
142best to post to the comp.lang.python or the Python mailing list (see
143above). If you specifically don't want to involve the newsgroup or
144mailing list, send questions to <help@python.org> (a group of
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000145volunteers who answer questions as they can). The newsgroup is the
146most efficient way to ask public questions.
Guido van Rossum627b2d71993-12-24 10:39:16 +0000147
Guido van Rossum901454e2000-06-29 22:28:44 +0000148
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000149Build instructions
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000150==================
Guido van Rossum627b2d71993-12-24 10:39:16 +0000151
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000152Before you can build Python, you must first configure it. Fortunately,
153the configuration and build process has been streamlined for most Unix
154installations, so all you have to do is type a few commands,
155optionally edit one file, and sit back. There are some platforms
156where things are not quite as smooth; see the platform specific notes
157below. If you want to build for multiple platforms sharing the same
158source tree, see the section on VPATH below.
Guido van Rossum627b2d71993-12-24 10:39:16 +0000159
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000160You start by running the script "./configure", which determines your
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000161system configuration and creates several Makefiles. (It takes a
162minute or two -- please be patient!) When it's done, you are ready to
Guido van Rossum7ac11532000-08-29 21:36:40 +0000163run make. You may want to pass options to the configure script, or
164edit the Setup file -- see the section below on configuration options
165and variables.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000166
167To build Python, you normally type "make" in the toplevel directory.
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000168This will recursively run make in each of the subdirectories: Grammar,
169Parser, Objects, Python and Modules, creating a library file in each
170one (except Grammar). The interpreter executable is built in the top
171level directory. If you want or need to, you can also chdir into each
172subdirectory in turn and run make there manually (do the Modules
173subdirectory last; you must use "make all sharedmods" to build the
174dynamically loadable modules, if you have any).
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000175
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000176Once you have built a Python interpreter, see the subsections below on
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000177testing, configuring additional modules, and installation. If you run
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000178into trouble, see the next section.
Guido van Rossum627b2d71993-12-24 10:39:16 +0000179
Guido van Rossum0a516c91994-09-12 10:58:40 +0000180
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000181Troubleshooting
182---------------
Guido van Rossum627b2d71993-12-24 10:39:16 +0000183
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000184See also the platform specific notes in the next section.
185
Guido van Rossumfaf681a1996-06-20 14:32:08 +0000186If recursive makes fail, try invoking make as "make MAKE=make".
187
Guido van Rossum49523691997-08-15 18:30:14 +0000188If you run into other trouble, see section 3 of the FAQ
Guido van Rossum901454e2000-06-29 22:28:44 +0000189(http://www.python.org/cgi-bin/faqw.py or
Guido van Rossum49523691997-08-15 18:30:14 +0000190http://www.python.org/doc/FAQ.html) for hints on what can go wrong,
191and how to fix it.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000192
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000193If you rerun the configure script with different options, remove all
194object files by running "make clean" before rebuilding. Believe it or
195not, "make clean" sometimes helps to clean up other inexplicable
196problems as well. Try it before sending in a bug report!
197
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000198If the configure script fails or doesn't seem to find things that
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000199should be there, inspect the config.log file. When you fix a
200configure problem, be sure to remove config.cache!
201
202If you get a warning for every file about the -Olimit option being no
203longer supported, you can ignore it. There's no foolproof way to know
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000204whether this option is needed; all we can do is test whether it is
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000205accepted without error. On some systems, e.g. older SGI compilers, it
206is essential for performance (specifically when compiling ceval.c,
207which has more basic blocks than the default limit of 1000). If the
208warning bothers you, edit the Makefile to remove "-Olimit 1500" from
209the OPT variable.
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000210
Guido van Rossum7ac11532000-08-29 21:36:40 +0000211If you get failures in test_long, or sys.maxint gets set to -1, you
212are probably experiencing compiler bugs, usually related to
213optimization. This is a common problem with some versions of gcc and
214egcs, and some vendor-supplied compilers, which can sometimes be
215worked around by turning off optimization. Consider switching to
216stable versions (gcc 2.7.2.3, egcs 1.1.2, or contact your vendor.)
217
218From Python 2.0 onward, all Python C code is ANSI C. Compiling using
219old K&R-C-only compilers is no longer possible. ANSI C compilers are
220available for all modern systems, either in the form of updated
221compilers from the vendor, or one of the free compilers (gcc, egcs).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000222
223Platform specific notes
224-----------------------
225
Guido van Rossum0447a321995-10-08 01:22:33 +0000226(Some of these may no longer apply. If you find you can build Python
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000227on these platforms without the special directions mentioned here, mail
228to <python@pythonlabs.com> so we can remove them!)
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000229
Guido van Rossumc0be2f51997-10-08 05:05:28 +000023064-bit platforms: The modules audioop, imageop and rgbimg don't work.
231 Don't try to enable them in the Modules/Setup file. They
232 contain code that is quite wordsize sensitive. (If you have a
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000233 fix, let us know!)
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000234
Guido van Rossum4462e931997-01-22 21:00:32 +0000235Solaris: When using Sun's C compiler with threads, at least on Solaris
236 2.5.1, you need to add the "-mt" compiler option (the simplest
237 way is probably to specify the compiler with this option as
238 the "CC" environment variable when running the configure
239 script).
240
Guido van Rossum7ac11532000-08-29 21:36:40 +0000241Linux: A problem with threads and fork() was tracked down to a bug in
242 the pthreads code in glibc version 2.0.5; glibc version 2.0.7
243 solves the problem. This causes the popen2 test to fail;
244 problem and solution reported by Pablo Bleyer.
Guido van Rossum4462e931997-01-22 21:00:32 +0000245
Guido van Rossum7ac11532000-08-29 21:36:40 +0000246 Under Linux systems using GNU libc 2 (aka libc6), the crypt
247 module now needs the -lcrypt option. Uncomment this flag in
248 Modules/Setup, or comment out the crypt module in the same
249 file. Most modern Linux systems use glibc2.
Fred Drake61280911997-12-08 14:10:40 +0000250
Guido van Rossum59230501999-06-21 20:51:46 +0000251FreeBSD 3.x and probably platforms with NCurses that use libmytinfo or
252 similar: When using cursesmodule, the linking is not done in
253 the correct order with the defaults. Remove "-ltermcap" from
254 the readline entry in Setup, and use as curses entry: "curses
255 cursesmodule.c -lmytinfo -lncurses -ltermcap" - "mytinfo" (so
256 called on FreeBSD) should be the name of the auxiliary library
257 required on your platform. Normally, it would be linked
258 automatically, but not necessarily in the correct order.
259
Guido van Rossum7ac11532000-08-29 21:36:40 +0000260BSDI: BSDI versions before 4.1 have known problems with threads,
261 which can cause strange errors in a number of modules (for
262 instance, the 'test_signal' test script will hang forever.)
263 Turning off threads (with --with-threads=no) or upgrading to
264 BSDI 4.1 solves this problem.
265
266DEC Unix: Run configure with --with-dec-threads, or with
267 --with-threads=no if no threads are desired (threads are on by
268 default). When using GCC, it is possible to get an internal
269 compiler error if optimization is used. This was reported for
270 GCC 2.7.2.3 on selectmodule.c. Manually compile the affected
271 file without optimization to solve the problem.
Guido van Rossum8eca2c21996-02-14 18:37:46 +0000272
Guido van Rossume1cdb161999-04-10 16:04:07 +0000273DEC Ultrix: compile with GCC to avoid bugs in the native compiler,
274 and pass SHELL=/bin/sh5 to Make when installing.
275
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000276AIX: A complete overhaul of the shared library support is now in
Guido van Rossumcbfcb171997-10-20 22:57:00 +0000277 place. See Misc/AIX-NOTES for some notes on how it's done.
Guido van Rossum9ac9a261998-02-16 22:19:21 +0000278 (The optimizer bug reported at this place in previous releases
279 has been worked around by a minimal code change.)
Guido van Rossumed7f9e21999-11-16 16:03:03 +0000280 In addition, Gary Duzan has a hint for C++ users: to enable
281 full C++ module support, set CC="xlC" (or CC="xlC_r" for thread
282 support in AIX 4.2.1).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000283
Guido van Rossum59a88f41999-04-12 18:16:09 +0000284HP-UX: Please read the file Misc/HPUX-NOTES for shared libraries.
285 When using threading, you may have to add -D_REENTRANT to the
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000286 OPT variable in the top-level Makefile; reported by Pat Knight,
Guido van Rossum59a88f41999-04-12 18:16:09 +0000287 this seems to make a difference (at least for HP-UX 10.20)
288 even though config.h defines it.
Guido van Rossum2094e041998-05-14 15:47:35 +0000289
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000290Minix: When using ack, use "CC=cc AR=aal RANLIB=: ./configure"!
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000291
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000292SCO: The following apply to SCO 3 only; Python builds out of the box
293 on SCO 5 (or so we've heard).
Guido van Rossuma16e2751998-04-13 20:14:05 +0000294
295 1) Everything works much better if you add -U__STDC__ to the
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000296 defs. This is because all the SCO header files are broken.
Guido van Rossum64773801997-11-26 17:07:02 +0000297 Anything that isn't mentioned in the C standard is
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000298 conditionally excluded when __STDC__ is defined.
299
300 2) Due to the U.S. export restrictions, SCO broke the crypt
301 stuff out into a separate library, libcrypt_i.a so the LIBS
302 needed be set to:
303
304 LIBS=' -lsocket -lcrypt_i'
305
Guido van Rossum7ac11532000-08-29 21:36:40 +0000306SunOS 4.x: When using the SunPro C compiler, you may want to use the
Guido van Rossum64773801997-11-26 17:07:02 +0000307 '-Xa' option instead of '-Xc', to enable some needed non-ANSI
308 Sunisms.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000309
Guido van Rossumcc55c2d1996-10-21 15:14:27 +0000310NeXT: To build fat binaries, use the --with-next-archs switch
311 described below.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000312
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000313QNX: Chris Herborth (chrish@qnx.com) writes:
314 configure works best if you use GNU bash; a port is available on
315 ftp.qnx.com in /usr/free. I used the following process to build,
Guido van Rossumd4493421998-12-22 16:37:01 +0000316 test and install Python 1.5.x under QNX:
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000317
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000318 1) CONFIG_SHELL=/usr/local/bin/bash CC=cc RANLIB=: \
319 ./configure --verbose --without-gcc --with-libm=""
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000320
321 2) copy Modules/Setup.in to Modules/Setup; edit Modules/Setup to
322 activate everything that makes sense for your system... tested
323 here at QNX with the following modules:
324
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000325 array, audioop, binascii, cPickle, cStringIO, cmath,
326 crypt, curses, errno, fcntl, gdbm, grp, imageop,
327 _locale, math, md5, new, operator, parser, pcre,
328 posix, pwd, readline, regex, reop, rgbimg, rotor,
329 select, signal, socket, soundex, strop, struct,
Guido van Rossumd4493421998-12-22 16:37:01 +0000330 syslog, termios, time, timing, zlib, audioop, imageop, rgbimg
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000331
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000332 3) make SHELL=/usr/local/bin/bash
333
334 or, if you feel the need for speed:
335
336 make SHELL=/usr/local/bin/bash OPT="-5 -Oil+nrt"
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000337
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000338 4) make SHELL=/usr/local/bin/bash test
339
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000340 Using GNU readline 2.2 seems to behave strangely, but I
341 think that's a problem with my readline 2.2 port. :-\
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000342
343 5) make SHELL=/usr/local/bin/bash install
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000344
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000345 If you get SIGSEGVs while running Python (I haven't yet, but
346 I've only run small programs and the test cases), you're
347 probably running out of stack; the default 32k could be a
348 little tight. To increase the stack size, edit the Makefile
349 in the Modules directory to read: LDFLAGS = -N 48k
Guido van Rossum40d63581997-08-14 19:45:30 +0000350
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000351BeOS: Chris Herborth (chrish@qnx.com) writes:
352 See BeOS/README for notes about compiling/installing Python on
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000353 BeOS R3 or later. Note that only the PowerPC platform is
Guido van Rossumd4493421998-12-22 16:37:01 +0000354 supported for R3; both PowerPC and x86 are supported for R4.
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000355
Guido van Rossum1bf0bf41997-08-20 23:50:51 +0000356Cray T3E: Konrad Hinsen writes:
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000357 1) Don't use gcc. It compiles Python/graminit.c into something
358 that the Cray assembler doesn't like. Cray's cc seems to work
359 fine.
Guido van Rossum7ac11532000-08-29 21:36:40 +0000360 2) Comment out modules md5 (won't compile) and audioop (will
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000361 crash the interpreter during the test suite).
362 If you run the test suite, two tests will fail (rotate and
363 binascii), but these are not the modules you'd expect to need
364 on a Cray.
Guido van Rossum1bf0bf41997-08-20 23:50:51 +0000365
Guido van Rossum0078aaf1997-08-21 03:05:11 +0000366SGI: SGI's standard "make" utility (/bin/make or /usr/bin/make)
367 does not check whether a command actually changed the file it
368 is supposed to build. This means that whenever you say "make"
369 it will redo the link step. The remedy is to use SGI's much
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000370 smarter "smake " utility (/usr/sbin/smake), or GNU make. If
371 you set the first line of the Makefile to #!/usr/sbin/smake
372 smake will be invoked by make (likewise for GNU make).
Guido van Rossum0078aaf1997-08-21 03:05:11 +0000373
Guido van Rossum64773801997-11-26 17:07:02 +0000374OS/2: If you are running Warp3 or Warp4 and have IBM's VisualAge C/C++
375 compiler installed, just change into the pc\os2vacpp directory
376 and type NMAKE. Threading and sockets are supported by default
377 in the resulting binaries of PYTHON15.DLL and PYTHON.EXE.
378
Trent Mick635f6fb2000-08-23 21:33:05 +0000379Monterey (64-bit AIX):
380 The current Monterey C compiler (Visual Age) uses the OBJECT_MODE={32|64}
381 environment variable to set the compilation mode to either 32-bit or
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000382 64-bit (32-bit mode is the default). Presumably you want 64-bit
383 compilation mode for this 64-bit OS. As a result you must first set
384 OBJECT_MODE=64 in your environment before configuring (./configure) or
Trent Mick635f6fb2000-08-23 21:33:05 +0000385 building (make) Python on Monterey.
386
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000387
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000388Configuring threads
389-------------------
390
Guido van Rossum7ac11532000-08-29 21:36:40 +0000391As of Python 2.0, threads are enabled by default. If you wish to
392compile without threads, or if your thread support is broken, pass the
393--with-threads=no switch to configure. Unfortunately, on some
394platforms, additional compiler and/or linker options are required for
395threads to work properly. Below is a table of those options,
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000396collected by Bill Janssen. We would love to automate this process
Guido van Rossum7ac11532000-08-29 21:36:40 +0000397more, but the information below is not enough to write a patch for the
398configure.in file, so manual intervention is required. If you patch
399the configure.in file and are confident that the patch works, please
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000400send in the patch. (Don't bother patching the configure script itself
Guido van Rossum7ac11532000-08-29 21:36:40 +0000401-- it is regenerated each the configure.in file changes.)
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000402
403Compiler switches for threads
404.............................
405
406 OS/Compiler/threads Switches for use with threads
407 (POSIX is draft 10, DCE is draft 4) (1) compile only (2) compile & link
408
409 SunOS 5.{1-5}/{gcc,SunPro cc}/solaris (1) -D_REENTRANT (2) -mt
410 SunOS 5.5/{gcc,SunPro cc}/POSIX (1) -D_REENTRANT
411 DEC OSF/1 3.x/cc/DCE (1) -D_REENTRANT (2) -threads
412 (butenhof@zko.dec.com)
413 Digital UNIX 4.x/cc/DCE (1) -D_REENTRANT (2) -threads
414 (butenhof@zko.dec.com)
415 Digital UNIX 4.x/cc/POSIX (1) -D_REENTRANT (2) -pthread
416 (butenhof@zko.dec.com)
417 AIX 4.1.4/cc_r/d7 (nothing)
418 (buhrt@iquest.net)
419 AIX 4.1.4/cc_r4/DCE (nothing)
420 (buhrt@iquest.net)
421 IRIX 6.2/cc/POSIX (nothing)
422 (robertl@cwi.nl)
423
424
425Linker (ld) libraries and flags for threads
426...........................................
427
428 OS/threads Libraries/switches for use with threads
429
430 SunOS 5.{1-5}/solaris -lthread
431 SunOS 5.5/POSIX -lpthread
432 DEC OSF/1 3.x/DCE -lpthreads -lmach -lc_r -lc
433 (butenhof@zko.dec.com)
434 Digital UNIX 4.x/DCE -lpthreads -lpthread -lmach -lexc -lc
435 (butenhof@zko.dec.com)
436 Digital UNIX 4.x/POSIX -lpthread -lmach -lexc -lc
437 (butenhof@zko.dec.com)
438 AIX 4.1.4/{draft7,DCE} (nothing)
439 (buhrt@iquest.net)
440 IRIX 6.2/POSIX -lpthread
441 (jph@emilia.engr.sgi.com)
442
443
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000444Configuring additional built-in modules
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000445---------------------------------------
Guido van Rossum19e0c261995-01-17 16:36:34 +0000446
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000447You can configure the interpreter to contain fewer or more built-in
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000448modules by editing the Modules/Setup file. This file is initially
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000449copied (when the toplevel Makefile makes Modules/Makefile for the
450first time) from Setup.in; if it does not exist yet, make a copy
451yourself. Never edit Setup.in -- always edit Setup. Read the
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000452comments in the file for information on what kind of edits are
453allowed. When you have edited Setup, Makefile and config.c in the
454Modules directory, the interpreter will automatically be rebuilt the
455next time you run make in the toplevel directory. (When working
456inside the Modules directory, use "make Makefile; make".)
Guido van Rossum627b2d71993-12-24 10:39:16 +0000457
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000458The default collection of modules should build on any Unix system, but
459many optional modules should work on all modern Unices (e.g. try dbm,
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000460nis, termios, timing, syslog, curses, new, soundex, parser). Often
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000461the quickest way to determine whether a particular module works or not
462is to see if it will build: enable it in Setup, then if you get
463compilation or link errors, disable it -- you're missing support.
464
465On SGI IRIX, there are modules that interface to many SGI specific
466system libraries, e.g. the GL library and the audio hardware.
467
468For SunOS and Solaris, enable module "sunaudiodev" to support the
Guido van Rossum7ac11532000-08-29 21:36:40 +0000469audio device. Likewise, for Linux systems, enable "linuxaudiodev".
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000470
Guido van Rossum4462e931997-01-22 21:00:32 +0000471In addition to the file Setup, you can also edit the file Setup.local.
472(the makesetup script processes both). You may find it more
473convenient to edit Setup.local and leave Setup alone. Then, when
474installing a new Python version, you can copy your old Setup.local
475file.
476
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000477
478Setting the optimization/debugging options
479------------------------------------------
480
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000481If you want or need to change the optimization/debugging options for
482the C compiler, assign to the OPT variable on the toplevel make
483command; e.g. "make OPT=-g" will build a debugging version of Python
484on most platforms. The default is OPT=-O; a value for OPT in the
485environment when the configure script is run overrides this default
486(likewise for CC; and the initial value for LIBS is used as the base
487set of libraries to link with).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000488
489
490Testing
491-------
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000492
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000493To test the interpreter, type "make test" in the top-level directory.
Guido van Rossum6ae5d3d1997-05-14 21:39:05 +0000494This runs the test set twice (once with no compiled files, once with
495the compiled files left by the previous test run). The test set
496produces some output. You can generally ignore the messages about
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000497skipped tests due to optional features which can't be imported. (If
498you want to test those modules, edit Modules/Setup to configure them.)
499If a message is printed about a failed test or a traceback or core
500dump is produced, something is wrong. On some Linux systems (those
Guido van Rossum24df6841997-12-30 04:32:30 +0000501that are not yet using glibc 6), test_strftime fails due to a
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000502non-standard implementation of strftime() in the C library. Please
503ignore this, or upgrade to glibc version 6.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000504
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000505IMPORTANT: If the tests fail and you decide to mail a bug report,
506*don't* include the output of "make test". It is useless. Run the
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000507failing test manually, as follows:
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000508
Guido van Rossum6ae5d3d1997-05-14 21:39:05 +0000509 python ../Lib/test/test_whatever.py
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000510
511(substituting the top of the source tree for .. if you built in a
Guido van Rossum6ae5d3d1997-05-14 21:39:05 +0000512different directory). This runs the test in verbose mode.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000513
514
515Installing
516----------
517
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000518To install the Python binary, library modules, shared library modules
519(see below), include files, configuration files, and the manual page,
Guido van Rossum64773801997-11-26 17:07:02 +0000520just type
521
522 make install
523
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000524This will install all platform-independent files in subdirectories of
525the directory given with the --prefix option to configure or to the
526`prefix' Make variable (default /usr/local). All binary and other
527platform-specific files will be installed in subdirectories if the
528directory given by --exec-prefix or the `exec_prefix' Make variable
529(defaults to the --prefix directory) is given.
Guido van Rossum64773801997-11-26 17:07:02 +0000530
531All subdirectories created will have Python's version number in their
532name, e.g. the library modules are installed in
Guido van Rossum901454e2000-06-29 22:28:44 +0000533"/usr/local/lib/python2.0/" by default. The Python binary is
534installed as "python2.0" and a hard link named "python" is created.
Guido van Rossum64773801997-11-26 17:07:02 +0000535The only file not installed with a version number in its name is the
536manual page, installed as "/usr/local/man/man1/python.1" by default.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000537
Guido van Rossum901454e2000-06-29 22:28:44 +0000538If you have a previous installation of a pre-2.0 Python that you don't
Guido van Rossum64773801997-11-26 17:07:02 +0000539want to replace yet, use
540
541 make altinstall
542
543This installs the same set of files as "make install" except it
Guido van Rossum901454e2000-06-29 22:28:44 +0000544doesn't create the hard link to "python2.0" named "python" and it
Guido van Rossum64773801997-11-26 17:07:02 +0000545doesn't install the manual page at all.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000546
547The only thing you may have to install manually is the Python mode for
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000548Emacs found in Misc/python-mode.el. (But then again, more recent
549versions of Emacs may already have it.) Follow the instructions that
550came with Emacs for installation of site-specific files.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000551
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000552
553Configuration options and variables
554-----------------------------------
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000555
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000556Some special cases are handled by passing options to the configure
557script.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000558
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000559WARNING: if you rerun the configure script with different options, you
560must run "make clean" before rebuilding. Exceptions to this rule:
561after changing --prefix or --exec-prefix, all you need to do is remove
Guido van Rossumb06df271997-08-05 21:50:20 +0000562Modules/getpath.o.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000563
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000564--with(out)-gcc: The configure script uses gcc (the GNU C compiler) if
565 it finds it. If you don't want this, or if this compiler is
566 installed but broken on your platform, pass the option
567 --without-gcc. You can also pass "CC=cc" (or whatever the
568 name of the proper C compiler is) in the environment, but the
569 advantage of using --without-gcc is that this option is
570 remembered by the config.status script for its --recheck
571 option.
Guido van Rossum76be6ed1995-01-02 18:33:54 +0000572
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000573--prefix, --exec-prefix: If you want to install the binaries and the
574 Python library somewhere else than in /usr/local/{bin,lib},
575 you can pass the option --prefix=DIRECTORY; the interpreter
576 binary will be installed as DIRECTORY/bin/python and the
577 library files as DIRECTORY/lib/python/*. If you pass
578 --exec-prefix=DIRECTORY (as well) this overrides the
579 installation prefix for architecture-dependent files (like the
580 interpreter binary). Note that --prefix=DIRECTORY also
581 affects the default module search path (sys.path), when
582 Modules/config.c is compiled. Passing make the option
583 prefix=DIRECTORY (and/or exec_prefix=DIRECTORY) overrides the
584 prefix set at configuration time; this may be more convenient
585 than re-running the configure script if you change your mind
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000586 about the install prefix.
Guido van Rossum76be6ed1995-01-02 18:33:54 +0000587
Guido van Rossumb06df271997-08-05 21:50:20 +0000588--with-readline: This option is no longer supported. To use GNU
589 readline, enable module "readline" in the Modules/Setup file.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000590
Guido van Rossum7ac11532000-08-29 21:36:40 +0000591--with-threads: On most Unix systems, you can now use multiple
592 threads, and support for this is enabled by default. To
593 disable this, pass --with-threads=no. If the library required
594 for threads lives in a peculiar place, you can use
595 --with-thread=DIRECTORY. IMPORTANT: run "make clean" after
596 changing (either enabling or disabling) this option, or you
597 will get link errors! Note: for DEC Unix use
Guido van Rossum0e13da91998-02-22 04:36:34 +0000598 --with-dec-threads instead.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000599
600--with-sgi-dl: On SGI IRIX 4, dynamic loading of extension modules is
601 supported by the "dl" library by Jack Jansen, which is
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000602 ftp'able from ftp://ftp.cwi.nl/pub/dynload/dl-1.6.tar.Z.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000603 This is enabled (after you've ftp'ed and compiled the dl
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000604 library) by passing --with-sgi-dl=DIRECTORY where DIRECTORY
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000605 is the absolute pathname of the dl library. (Don't bother on
606 IRIX 5, it already has dynamic linking using SunOS style
607 shared libraries.) Support for this feature is deprecated.
608
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000609--with-dl-dld: Dynamic loading of modules is rumored to be supported
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000610 on some other systems: VAX (Ultrix), Sun3 (SunOS 3.4), Sequent
611 Symmetry (Dynix), and Atari ST. This is done using a
612 combination of the GNU dynamic loading package
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000613 (ftp://ftp.cwi.nl/pub/dynload/dl-dld-1.1.tar.Z) and an
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000614 emulation of the SGI dl library mentioned above (the emulation
615 can be found at
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000616 ftp://ftp.cwi.nl/pub/dynload/dld-3.2.3.tar.Z). To
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000617 enable this, ftp and compile both libraries, then call
618 configure, passing it the option
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000619 --with-dl-dld=DL_DIRECTORY,DLD_DIRECTORY where DL_DIRECTORY is
620 the absolute pathname of the dl emulation library and
621 DLD_DIRECTORY is the absolute pathname of the GNU dld library.
622 (Don't bother on SunOS 4 or 5, they already have dynamic
623 linking using shared libraries.) Support for this feature is
624 deprecated.
625
626--with-libm, --with-libc: It is possible to specify alternative
627 versions for the Math library (default -lm) and the C library
628 (default the empty string) using the options
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000629 --with-libm=STRING and --with-libc=STRING, respectively. For
630 example, if your system requires that you pass -lc_s to the C
631 compiler to use the shared C library, you can pass
632 --with-libc=-lc_s. These libraries are passed after all other
633 libraries, the C library last.
Guido van Rossum3ff96dd1996-07-30 18:05:04 +0000634
635--with-next-archs='arch1 arch2': Under NEXTSTEP, this will build
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000636 all compiled binaries with the architectures listed. This will
637 also correctly set the target architecture-specific resource
Guido van Rossumcc55c2d1996-10-21 15:14:27 +0000638 directory. (This option is not supported on other platforms.)
Guido van Rossum76be6ed1995-01-02 18:33:54 +0000639
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000640--with-libs='libs': Add 'libs' to the LIBS that the python interpreter
641 is linked against.
Guido van Rossumd02ba451996-07-31 17:36:01 +0000642
Guido van Rossum76be6ed1995-01-02 18:33:54 +0000643
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000644Building for multiple architectures (using the VPATH feature)
645-------------------------------------------------------------
646
647If your file system is shared between multiple architectures, it
648usually is not necessary to make copies of the sources for each
649architecture you want to support. If the make program supports the
650VPATH feature, you can create an empty build directory for each
651architecture, and in each directory run the configure script (on the
652appropriate machine with the appropriate options). This creates the
653necessary subdirectories and the Makefiles therein. The Makefiles
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000654contain a line VPATH=... which points to a directory containing the
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000655actual sources. (On SGI systems, use "smake -J1" instead of "make" if
656you use VPATH -- don't try gnumake.)
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000657
658For example, the following is all you need to build a minimal Python
659in /usr/tmp/python (assuming ~guido/src/python is the toplevel
660directory and you want to build in /usr/tmp/python):
661
662 $ mkdir /usr/tmp/python
663 $ cd /usr/tmp/python
664 $ ~guido/src/python/configure
665 [...]
666 $ make
667 [...]
668 $
669
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000670Note that Modules/Makefile copies the original Setup file to the build
671directory if it finds no Setup file there. This means that you can
672edit the Setup file for each architecture independently. For this
673reason, subsequent changes to the original Setup file are not tracked
674automatically, as they might overwrite local changes. To force a copy
675of a changed original Setup file, delete the target Setup file. (The
676makesetup script supports multiple input files, so if you want to be
677fancy you can change the rules to create an empty Setup.local if it
678doesn't exist and run it with arguments $(srcdir)/Setup Setup.local;
679however this assumes that you only need to add modules.)
680
681
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000682Building on non-UNIX systems
683----------------------------
684
Guido van Rossum31ae2071999-04-12 14:47:30 +0000685For Windows 95/98 or NT, assuming you have MS VC++ 5.0 or 6.0, the
686project files are in PCbuild, the workspace is pcbuild.dsw. (The
687project files are for VC++ 5.0, but VC++ 6.0 will convert them for
688you -- start VC++ and then use Open Workspace.)
Guido van Rossum8d7d4ed1996-07-30 21:41:07 +0000689
Guido van Rossum31ae2071999-04-12 14:47:30 +0000690For other non-Unix Windows compilers, in particular Windows 3.1 and
691for OS/2, enter the directory "PC" and read the file "readme.txt".
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000692
693For the Mac, a separate source distribution will be made available,
694for use with the CodeWarrior compiler. If you are interested in Mac
695development, join the PythonMac Special Interest Group
696(http://www.python.org/sigs/pythonmac-sig/, or send email to
697pythonmac-sig-request@python.org).
698
699Of course, there are also binary distributions available for these
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000700platforms -- see http://www.pythonlabs.com/downloads.html.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000701
702To port Python to a new non-UNIX system, you will have to fake the
703effect of running the configure script manually (for Mac and PC, this
704has already been done for you). A good start is to copy the file
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000705config.h.in to config.h and edit the latter to reflect the actual
706configuration of your system. Most symbols must simply be defined as
7071 only if the corresponding feature is present and can be left alone
Tim Peters4f1b2082000-07-23 21:18:09 +0000708otherwise; however the *_t type symbols must be defined as some variant
709of int if they need to be defined at all.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000710
711
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000712
713Miscellaneous issues
714====================
715
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000716Emacs mode
717----------
718
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000719There's an excellent Emacs editing mode for Python code; see the file
720Misc/python-mode.el. Originally written by the famous Tim Peters, it
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000721is now maintained by the equally famous Barry Warsaw (it's no
722coincidence that they now both work at PythonLabs). The latest
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000723version, along with various other contributed Python-related Emacs
724goodies, is online at <http://www.python.org/emacs/python-mode>. And
725if you are planning to edit the Python C code, please pick up the
726latest version of CC Mode <http://www.python.org/emacs/cc-mode>; it
727contains a "python" style used throughout most of the Python C source
728files. (Newer versions of Emacs or XEmacs may already come with the
729latest version of python-mode.)
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000730
731
732The Tk interface
733----------------
734
735Tk (the user interface component of John Ousterhout's Tcl language) is
736also usable from Python. Since this requires that you first build and
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000737install Tcl/Tk, the Tk interface is not enabled by default. Python
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000738supports Tcl/Tk version 8.0 and higher.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000739
Guido van Rossum973e4dc2000-07-01 00:34:39 +0000740See http://dev.ajubasolutions.com/ for more info on Tcl/Tk, including
741the on-line manual pages.
Guido van Rossum64773801997-11-26 17:07:02 +0000742
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000743
744To enable the Python/Tk interface, once you've built and installed
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000745Tcl/Tk, load the file Modules/Setup into your favorite text editor and
Guido van Rossum64773801997-11-26 17:07:02 +0000746search for the string "_tkinter". Then follow the instructions found
747there. If you have installed Tcl/Tk or X11 in unusual places, you
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000748will have to edit the first line to fix or add the -I and -L options.
Guido van Rossum64773801997-11-26 17:07:02 +0000749(Also see the general instructions at the top of that file.)
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000750
Guido van Rossum973e4dc2000-07-01 00:34:39 +0000751For more Tkinter information, see the Tkinter Resource page:
752http://www.python.org/topics/tkinter/
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000753
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000754There are demos in the Demo/tkinter directory, in the subdirectories
755guido, matt and www (the matt and guido subdirectories have been
756overhauled to use more recent Tkinter coding conventions).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000757
758Note that there's a Python module called "Tkinter" (capital T) which
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000759lives in Lib/lib-tk/Tkinter.py, and a C module called "_tkinter"
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000760(lower case t and leading underscore) which lives in
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000761Modules/_tkinter.c. Demos and normal Tk applications import only the
762Python Tkinter module -- the latter uses the C _tkinter module
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000763directly. In order to find the C _tkinter module, it must be compiled
764and linked into the Python interpreter -- the _tkinter line in the
765Setup file does this. In order to find the Python Tkinter module,
766sys.path must be set correctly -- the TKPATH assignment in the Setup
767file takes care of this, but only if you install Python properly
768("make install libinstall"). (You can also use dynamic loading for
769the C _tkinter module, in which case you must manually fix up sys.path
770or set $PYTHONPATH for the Python Tkinter module.)
Guido van Rossum84c8c7f1995-08-28 02:44:24 +0000771
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000772
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000773Distribution structure
774----------------------
775
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000776Most subdirectories have their own README files. Most files have
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000777comments.
778
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000779.cvsignore Additional filename matching patterns for CVS to ignore
780BeOS/ Files specific to the BeOS port
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000781Demo/ Demonstration scripts, modules and programs
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000782Doc/ Documentation sources (LaTeX)
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000783Grammar/ Input for the parser generator
784Include/ Public header files
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000785LICENSE Licensing information
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000786Lib/ Python library modules
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000787Makefile.in Source from which config.status creates the Makefile
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000788Misc/ Miscellaneous useful files
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000789Modules/ Implementation of most built-in modules
790Objects/ Implementation of most built-in object types
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000791PC/ Files specific to PC ports (DOS, Windows, OS/2)
792PCbuild/ Build directory for Microsoft Visual C++
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000793Parser/ The parser and tokenizer and their input handling
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000794Python/ The byte-compiler and interpreter
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000795README The file you're reading now
796Tools/ Some useful programs written in Python
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000797acconfig.h Additional input for the GNU autoheader program
798config.h.in Source from which config.h is created (GNU autoheader output)
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000799configure Configuration shell script (GNU autoconf output)
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000800configure.in Configuration specification (input for GNU autoconf)
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000801install-sh Shell script used to install files
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000802
803The following files will (may) be created in the toplevel directory by
804the configuration and build processes:
805
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000806Makefile Build rules
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000807buildno Keeps track of the build number
808config.cache Cache of configuration variables
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000809config.h Configuration header
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000810config.log Log from last configure run
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000811config.status Status from last run of the configure script
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000812getbuildinfo.o Object file from Modules/getbuildinfo.c
Guido van Rossum901454e2000-06-29 22:28:44 +0000813libpython2.0.a The library archive
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000814python The executable interpreter
815tags, TAGS Tags files for vi and Emacs
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000816
817
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000818That's all, folks!
819------------------
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000820
821
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000822--Guido van Rossum (home page: http://www.pythonlabs.com/~guido/)