blob: 44d9166b8e7c05cc3257b1faf61bdf995de5f6de [file] [log] [blame]
Guido van Rossumba909092000-09-26 12:14:11 +00001This is Python version 2.0 beta 2
Guido van Rossumc07d5fa2000-09-01 22:50:02 +00002=================================
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 Rossumba909092000-09-26 12:14:11 +000034http://www.pythonlabs.com/products/python2.0/
Guido van Rossum64773801997-11-26 17:07:02 +000035
36If you don't read instructions
37------------------------------
38
39Congratulations on getting this far. :-)
40
41To start building right away (on UNIX): type "./configure" in the
42current directory and when it finishes, type "make". The section
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000043`Build Instructions' below is still recommended reading, especially
44the part on customizing Modules/Setup.
Guido van Rossum3ff96dd1996-07-30 18:05:04 +000045
46
Guido van Rossum91cb9d21995-04-10 11:47:38 +000047What is Python anyway?
48----------------------
49
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000050Python is an interpreted object-oriented programming language suitable
51(amongst other uses) for distributed application development,
52scripting, numeric computing and system testing. Python is often
53compared to Tcl, Perl, Java, JavaScript, Visual Basic or Scheme. To
54find out more about what Python can do for you, point your browser to
55http://www.pythonlabs.com/.
56
Guido van Rossum7a12ef32000-09-05 20:04:35 +000057BeOpen.com offers corporate support, custom development and
58sponsorships for Python. Contact <sales@beopen.com> for more
59information.
60
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000061BeOpen Python releases include pre-built Python executables for major
62platforms and are available from PythonLabs.
Guido van Rossum91cb9d21995-04-10 11:47:38 +000063
64
Guido van Rossumf501b4e1996-10-25 14:32:48 +000065How do I learn Python?
66----------------------
67
Fred Drake0e6444c1999-05-17 19:35:01 +000068The official tutorial is still a good place to start; see
Guido van Rossumd0a42e22000-03-31 20:16:45 +000069http://www.python.org/doc/ for online and downloadable versions, as
70well as a list of other introductions, and reference documentation.
Guido van Rossumf501b4e1996-10-25 14:32:48 +000071
Guido van Rossumd0a42e22000-03-31 20:16:45 +000072There's a quickly growing set of books on Python. See
73http://www.python.org/psa/bookstore/ for a list.
Guido van Rossum8d90f9d1997-05-22 20:13:25 +000074
Guido van Rossumf501b4e1996-10-25 14:32:48 +000075
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000076Documentation
77-------------
Guido van Rossum91cb9d21995-04-10 11:47:38 +000078
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000079All documentation is provided online in a variety of formats. In
80order of importance for new users: Tutorial, Library Reference,
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000081Language Reference, Extending & Embedding, and the Python/C API. The
82Library Reference is especially of immense value since much of
83Python's power is described there, including the built-in data types
84and functions!
Guido van Rossum91cb9d21995-04-10 11:47:38 +000085
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000086All documentation is also available online at the Python web site
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000087(http://www.python.org/doc/, see below). It is available online for
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000088occasional reference, or can be downloaded in many formats for faster
89access. The documentation is available in HTML, PostScript, PDF, HTML
90Help, and LaTeX formats; the LaTeX version is primarily for
91documentation authors or people with special formatting requirements.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000092
93
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000094Web sites
95---------
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000096
Guido van Rossum4f40c2d2000-09-05 16:46:22 +000097New Python releases and related technologies are published at
Guido van Rossumc07d5fa2000-09-01 22:50:02 +000098http://www.pythonlabs.com/. Come visit us!
99
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000100The present Python community web site is http://www.python.org/.
101BeOpen.com is developing a next-generation community site for Python
102and is looking for volunteers to help make this an even better
103resource than the existing community site. If you know Python well
104and would like to volunteer to work with us on this project, please
105contact <volunteer@pythonlabs.com> with a summary of your skills.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000106
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000107
108Newsgroups and Mailing Lists
109----------------------------
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000110
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 +0000114mailing 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 +0000116
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000117Archives are accessible via Deja.com Usenet News: see
118http://www.deja.com/usenet. The mailing lists are also archived, see
119http://www.python.org/psa/MailingLists.html for details.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000120
121
122Bug reports
123-----------
124
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000125To 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 +0000127
128
129Patches and contributions
130-------------------------
131
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000132To submit a patch or other contribution, please use the Python
133Patch Manager at http://sourceforge.net/patch/?group_id=5470.
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000134
135If you have a proposal to change Python, it's best to submit a Python
136Enhancement Proposal (PEP) first. All current PEPs, as well as
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000137guidelines for submitting a new PEP, are list at
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000138http://python.sourceforge.net/peps/.
139
140
141Questions
142---------
143
144For help, if you can't find it in the manuals or on the web site, it's
145best to post to the comp.lang.python or the Python mailing list (see
146above). If you specifically don't want to involve the newsgroup or
147mailing list, send questions to <help@python.org> (a group of
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000148volunteers who answer questions as they can). The newsgroup is the
149most efficient way to ask public questions.
Guido van Rossum627b2d71993-12-24 10:39:16 +0000150
Guido van Rossum901454e2000-06-29 22:28:44 +0000151
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000152Build instructions
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000153==================
Guido van Rossum627b2d71993-12-24 10:39:16 +0000154
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000155Before you can build Python, you must first configure it. Fortunately,
156the configuration and build process has been streamlined for most Unix
157installations, so all you have to do is type a few commands,
158optionally edit one file, and sit back. There are some platforms
159where things are not quite as smooth; see the platform specific notes
160below. If you want to build for multiple platforms sharing the same
161source tree, see the section on VPATH below.
Guido van Rossum627b2d71993-12-24 10:39:16 +0000162
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000163You start by running the script "./configure", which determines your
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000164system configuration and creates several Makefiles. (It takes a
165minute or two -- please be patient!) When it's done, you are ready to
Guido van Rossum7ac11532000-08-29 21:36:40 +0000166run make. You may want to pass options to the configure script, or
167edit the Setup file -- see the section below on configuration options
168and variables.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000169
170To build Python, you normally type "make" in the toplevel directory.
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000171This will recursively run make in each of the subdirectories: Grammar,
172Parser, Objects, Python and Modules, creating a library file in each
173one (except Grammar). The interpreter executable is built in the top
174level directory. If you want or need to, you can also chdir into each
175subdirectory in turn and run make there manually (do the Modules
176subdirectory last; you must use "make all sharedmods" to build the
177dynamically loadable modules, if you have any).
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000178
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000179Once you have built a Python interpreter, see the subsections below on
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000180testing, configuring additional modules, and installation. If you run
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000181into trouble, see the next section.
Guido van Rossum627b2d71993-12-24 10:39:16 +0000182
Guido van Rossum0a516c91994-09-12 10:58:40 +0000183
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000184Troubleshooting
185---------------
Guido van Rossum627b2d71993-12-24 10:39:16 +0000186
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000187See also the platform specific notes in the next section.
188
Guido van Rossumfaf681a1996-06-20 14:32:08 +0000189If recursive makes fail, try invoking make as "make MAKE=make".
190
Guido van Rossum49523691997-08-15 18:30:14 +0000191If you run into other trouble, see section 3 of the FAQ
Guido van Rossum901454e2000-06-29 22:28:44 +0000192(http://www.python.org/cgi-bin/faqw.py or
Guido van Rossum49523691997-08-15 18:30:14 +0000193http://www.python.org/doc/FAQ.html) for hints on what can go wrong,
194and how to fix it.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000195
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000196If you rerun the configure script with different options, remove all
197object files by running "make clean" before rebuilding. Believe it or
198not, "make clean" sometimes helps to clean up other inexplicable
199problems as well. Try it before sending in a bug report!
200
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000201If the configure script fails or doesn't seem to find things that
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000202should be there, inspect the config.log file. When you fix a
203configure problem, be sure to remove config.cache!
204
205If you get a warning for every file about the -Olimit option being no
206longer supported, you can ignore it. There's no foolproof way to know
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000207whether this option is needed; all we can do is test whether it is
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000208accepted without error. On some systems, e.g. older SGI compilers, it
209is essential for performance (specifically when compiling ceval.c,
210which has more basic blocks than the default limit of 1000). If the
211warning bothers you, edit the Makefile to remove "-Olimit 1500" from
212the OPT variable.
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000213
Guido van Rossum7ac11532000-08-29 21:36:40 +0000214If you get failures in test_long, or sys.maxint gets set to -1, you
215are probably experiencing compiler bugs, usually related to
216optimization. This is a common problem with some versions of gcc and
217egcs, and some vendor-supplied compilers, which can sometimes be
218worked around by turning off optimization. Consider switching to
219stable versions (gcc 2.7.2.3, egcs 1.1.2, or contact your vendor.)
220
221From Python 2.0 onward, all Python C code is ANSI C. Compiling using
222old K&R-C-only compilers is no longer possible. ANSI C compilers are
223available for all modern systems, either in the form of updated
224compilers from the vendor, or one of the free compilers (gcc, egcs).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000225
226Platform specific notes
227-----------------------
228
Guido van Rossum0447a321995-10-08 01:22:33 +0000229(Some of these may no longer apply. If you find you can build Python
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000230on these platforms without the special directions mentioned here, mail
231to <python@pythonlabs.com> so we can remove them!)
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000232
Guido van Rossumc0be2f51997-10-08 05:05:28 +000023364-bit platforms: The modules audioop, imageop and rgbimg don't work.
234 Don't try to enable them in the Modules/Setup file. They
235 contain code that is quite wordsize sensitive. (If you have a
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000236 fix, let us know!)
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000237
Guido van Rossum4462e931997-01-22 21:00:32 +0000238Solaris: When using Sun's C compiler with threads, at least on Solaris
239 2.5.1, you need to add the "-mt" compiler option (the simplest
240 way is probably to specify the compiler with this option as
241 the "CC" environment variable when running the configure
242 script).
243
Guido van Rossum7ac11532000-08-29 21:36:40 +0000244Linux: A problem with threads and fork() was tracked down to a bug in
245 the pthreads code in glibc version 2.0.5; glibc version 2.0.7
246 solves the problem. This causes the popen2 test to fail;
247 problem and solution reported by Pablo Bleyer.
Guido van Rossum4462e931997-01-22 21:00:32 +0000248
Guido van Rossum7ac11532000-08-29 21:36:40 +0000249 Under Linux systems using GNU libc 2 (aka libc6), the crypt
250 module now needs the -lcrypt option. Uncomment this flag in
251 Modules/Setup, or comment out the crypt module in the same
252 file. Most modern Linux systems use glibc2.
Fred Drake61280911997-12-08 14:10:40 +0000253
Guido van Rossum59230501999-06-21 20:51:46 +0000254FreeBSD 3.x and probably platforms with NCurses that use libmytinfo or
255 similar: When using cursesmodule, the linking is not done in
256 the correct order with the defaults. Remove "-ltermcap" from
257 the readline entry in Setup, and use as curses entry: "curses
258 cursesmodule.c -lmytinfo -lncurses -ltermcap" - "mytinfo" (so
259 called on FreeBSD) should be the name of the auxiliary library
260 required on your platform. Normally, it would be linked
261 automatically, but not necessarily in the correct order.
262
Guido van Rossum7ac11532000-08-29 21:36:40 +0000263BSDI: BSDI versions before 4.1 have known problems with threads,
264 which can cause strange errors in a number of modules (for
265 instance, the 'test_signal' test script will hang forever.)
266 Turning off threads (with --with-threads=no) or upgrading to
267 BSDI 4.1 solves this problem.
268
269DEC Unix: Run configure with --with-dec-threads, or with
270 --with-threads=no if no threads are desired (threads are on by
271 default). When using GCC, it is possible to get an internal
272 compiler error if optimization is used. This was reported for
273 GCC 2.7.2.3 on selectmodule.c. Manually compile the affected
274 file without optimization to solve the problem.
Guido van Rossum8eca2c21996-02-14 18:37:46 +0000275
Guido van Rossume1cdb161999-04-10 16:04:07 +0000276DEC Ultrix: compile with GCC to avoid bugs in the native compiler,
277 and pass SHELL=/bin/sh5 to Make when installing.
278
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000279AIX: A complete overhaul of the shared library support is now in
Guido van Rossumcbfcb171997-10-20 22:57:00 +0000280 place. See Misc/AIX-NOTES for some notes on how it's done.
Guido van Rossum9ac9a261998-02-16 22:19:21 +0000281 (The optimizer bug reported at this place in previous releases
282 has been worked around by a minimal code change.)
Guido van Rossumed7f9e21999-11-16 16:03:03 +0000283 In addition, Gary Duzan has a hint for C++ users: to enable
284 full C++ module support, set CC="xlC" (or CC="xlC_r" for thread
285 support in AIX 4.2.1).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000286
Guido van Rossum59a88f41999-04-12 18:16:09 +0000287HP-UX: Please read the file Misc/HPUX-NOTES for shared libraries.
288 When using threading, you may have to add -D_REENTRANT to the
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000289 OPT variable in the top-level Makefile; reported by Pat Knight,
Guido van Rossum59a88f41999-04-12 18:16:09 +0000290 this seems to make a difference (at least for HP-UX 10.20)
291 even though config.h defines it.
Guido van Rossum2094e041998-05-14 15:47:35 +0000292
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000293Minix: When using ack, use "CC=cc AR=aal RANLIB=: ./configure"!
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000294
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000295SCO: The following apply to SCO 3 only; Python builds out of the box
296 on SCO 5 (or so we've heard).
Guido van Rossuma16e2751998-04-13 20:14:05 +0000297
298 1) Everything works much better if you add -U__STDC__ to the
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000299 defs. This is because all the SCO header files are broken.
Guido van Rossum64773801997-11-26 17:07:02 +0000300 Anything that isn't mentioned in the C standard is
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000301 conditionally excluded when __STDC__ is defined.
302
303 2) Due to the U.S. export restrictions, SCO broke the crypt
304 stuff out into a separate library, libcrypt_i.a so the LIBS
305 needed be set to:
306
307 LIBS=' -lsocket -lcrypt_i'
308
Guido van Rossum7ac11532000-08-29 21:36:40 +0000309SunOS 4.x: When using the SunPro C compiler, you may want to use the
Guido van Rossum64773801997-11-26 17:07:02 +0000310 '-Xa' option instead of '-Xc', to enable some needed non-ANSI
311 Sunisms.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000312
Guido van Rossumcc55c2d1996-10-21 15:14:27 +0000313NeXT: To build fat binaries, use the --with-next-archs switch
314 described below.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000315
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000316QNX: Chris Herborth (chrish@qnx.com) writes:
317 configure works best if you use GNU bash; a port is available on
318 ftp.qnx.com in /usr/free. I used the following process to build,
Guido van Rossumd4493421998-12-22 16:37:01 +0000319 test and install Python 1.5.x under QNX:
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000320
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000321 1) CONFIG_SHELL=/usr/local/bin/bash CC=cc RANLIB=: \
322 ./configure --verbose --without-gcc --with-libm=""
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000323
324 2) copy Modules/Setup.in to Modules/Setup; edit Modules/Setup to
325 activate everything that makes sense for your system... tested
326 here at QNX with the following modules:
327
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000328 array, audioop, binascii, cPickle, cStringIO, cmath,
329 crypt, curses, errno, fcntl, gdbm, grp, imageop,
330 _locale, math, md5, new, operator, parser, pcre,
331 posix, pwd, readline, regex, reop, rgbimg, rotor,
332 select, signal, socket, soundex, strop, struct,
Guido van Rossumd4493421998-12-22 16:37:01 +0000333 syslog, termios, time, timing, zlib, audioop, imageop, rgbimg
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000334
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000335 3) make SHELL=/usr/local/bin/bash
336
337 or, if you feel the need for speed:
338
339 make SHELL=/usr/local/bin/bash OPT="-5 -Oil+nrt"
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000340
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000341 4) make SHELL=/usr/local/bin/bash test
342
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000343 Using GNU readline 2.2 seems to behave strangely, but I
344 think that's a problem with my readline 2.2 port. :-\
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000345
346 5) make SHELL=/usr/local/bin/bash install
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000347
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000348 If you get SIGSEGVs while running Python (I haven't yet, but
349 I've only run small programs and the test cases), you're
350 probably running out of stack; the default 32k could be a
351 little tight. To increase the stack size, edit the Makefile
352 in the Modules directory to read: LDFLAGS = -N 48k
Guido van Rossum40d63581997-08-14 19:45:30 +0000353
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000354BeOS: Chris Herborth (chrish@qnx.com) writes:
355 See BeOS/README for notes about compiling/installing Python on
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000356 BeOS R3 or later. Note that only the PowerPC platform is
Guido van Rossumd4493421998-12-22 16:37:01 +0000357 supported for R3; both PowerPC and x86 are supported for R4.
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000358
Guido van Rossum1bf0bf41997-08-20 23:50:51 +0000359Cray T3E: Konrad Hinsen writes:
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000360 1) Don't use gcc. It compiles Python/graminit.c into something
361 that the Cray assembler doesn't like. Cray's cc seems to work
362 fine.
Guido van Rossum7ac11532000-08-29 21:36:40 +0000363 2) Comment out modules md5 (won't compile) and audioop (will
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000364 crash the interpreter during the test suite).
365 If you run the test suite, two tests will fail (rotate and
366 binascii), but these are not the modules you'd expect to need
367 on a Cray.
Guido van Rossum1bf0bf41997-08-20 23:50:51 +0000368
Guido van Rossum0078aaf1997-08-21 03:05:11 +0000369SGI: SGI's standard "make" utility (/bin/make or /usr/bin/make)
370 does not check whether a command actually changed the file it
371 is supposed to build. This means that whenever you say "make"
372 it will redo the link step. The remedy is to use SGI's much
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000373 smarter "smake " utility (/usr/sbin/smake), or GNU make. If
374 you set the first line of the Makefile to #!/usr/sbin/smake
375 smake will be invoked by make (likewise for GNU make).
Guido van Rossum0078aaf1997-08-21 03:05:11 +0000376
Guido van Rossum64773801997-11-26 17:07:02 +0000377OS/2: If you are running Warp3 or Warp4 and have IBM's VisualAge C/C++
378 compiler installed, just change into the pc\os2vacpp directory
379 and type NMAKE. Threading and sockets are supported by default
380 in the resulting binaries of PYTHON15.DLL and PYTHON.EXE.
381
Trent Mick635f6fb2000-08-23 21:33:05 +0000382Monterey (64-bit AIX):
383 The current Monterey C compiler (Visual Age) uses the OBJECT_MODE={32|64}
384 environment variable to set the compilation mode to either 32-bit or
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000385 64-bit (32-bit mode is the default). Presumably you want 64-bit
386 compilation mode for this 64-bit OS. As a result you must first set
387 OBJECT_MODE=64 in your environment before configuring (./configure) or
Trent Mick635f6fb2000-08-23 21:33:05 +0000388 building (make) Python on Monterey.
389
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000390
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000391Configuring threads
392-------------------
393
Guido van Rossum7ac11532000-08-29 21:36:40 +0000394As of Python 2.0, threads are enabled by default. If you wish to
395compile without threads, or if your thread support is broken, pass the
396--with-threads=no switch to configure. Unfortunately, on some
397platforms, additional compiler and/or linker options are required for
398threads to work properly. Below is a table of those options,
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000399collected by Bill Janssen. We would love to automate this process
Guido van Rossum7ac11532000-08-29 21:36:40 +0000400more, but the information below is not enough to write a patch for the
401configure.in file, so manual intervention is required. If you patch
402the configure.in file and are confident that the patch works, please
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000403send in the patch. (Don't bother patching the configure script itself
Guido van Rossum7ac11532000-08-29 21:36:40 +0000404-- it is regenerated each the configure.in file changes.)
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000405
406Compiler switches for threads
407.............................
408
409 OS/Compiler/threads Switches for use with threads
410 (POSIX is draft 10, DCE is draft 4) (1) compile only (2) compile & link
411
412 SunOS 5.{1-5}/{gcc,SunPro cc}/solaris (1) -D_REENTRANT (2) -mt
413 SunOS 5.5/{gcc,SunPro cc}/POSIX (1) -D_REENTRANT
414 DEC OSF/1 3.x/cc/DCE (1) -D_REENTRANT (2) -threads
415 (butenhof@zko.dec.com)
416 Digital UNIX 4.x/cc/DCE (1) -D_REENTRANT (2) -threads
417 (butenhof@zko.dec.com)
418 Digital UNIX 4.x/cc/POSIX (1) -D_REENTRANT (2) -pthread
419 (butenhof@zko.dec.com)
420 AIX 4.1.4/cc_r/d7 (nothing)
421 (buhrt@iquest.net)
422 AIX 4.1.4/cc_r4/DCE (nothing)
423 (buhrt@iquest.net)
424 IRIX 6.2/cc/POSIX (nothing)
425 (robertl@cwi.nl)
426
427
428Linker (ld) libraries and flags for threads
429...........................................
430
431 OS/threads Libraries/switches for use with threads
432
433 SunOS 5.{1-5}/solaris -lthread
434 SunOS 5.5/POSIX -lpthread
435 DEC OSF/1 3.x/DCE -lpthreads -lmach -lc_r -lc
436 (butenhof@zko.dec.com)
437 Digital UNIX 4.x/DCE -lpthreads -lpthread -lmach -lexc -lc
438 (butenhof@zko.dec.com)
439 Digital UNIX 4.x/POSIX -lpthread -lmach -lexc -lc
440 (butenhof@zko.dec.com)
441 AIX 4.1.4/{draft7,DCE} (nothing)
442 (buhrt@iquest.net)
443 IRIX 6.2/POSIX -lpthread
444 (jph@emilia.engr.sgi.com)
445
446
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000447Configuring additional built-in modules
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000448---------------------------------------
Guido van Rossum19e0c261995-01-17 16:36:34 +0000449
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000450You can configure the interpreter to contain fewer or more built-in
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000451modules by editing the Modules/Setup file. This file is initially
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000452copied (when the toplevel Makefile makes Modules/Makefile for the
453first time) from Setup.in; if it does not exist yet, make a copy
454yourself. Never edit Setup.in -- always edit Setup. Read the
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000455comments in the file for information on what kind of edits are
456allowed. When you have edited Setup, Makefile and config.c in the
457Modules directory, the interpreter will automatically be rebuilt the
458next time you run make in the toplevel directory. (When working
459inside the Modules directory, use "make Makefile; make".)
Guido van Rossum627b2d71993-12-24 10:39:16 +0000460
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000461The default collection of modules should build on any Unix system, but
462many optional modules should work on all modern Unices (e.g. try dbm,
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000463nis, termios, timing, syslog, curses, new, soundex, parser). Often
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000464the quickest way to determine whether a particular module works or not
465is to see if it will build: enable it in Setup, then if you get
466compilation or link errors, disable it -- you're missing support.
467
468On SGI IRIX, there are modules that interface to many SGI specific
469system libraries, e.g. the GL library and the audio hardware.
470
471For SunOS and Solaris, enable module "sunaudiodev" to support the
Guido van Rossum7ac11532000-08-29 21:36:40 +0000472audio device. Likewise, for Linux systems, enable "linuxaudiodev".
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000473
Guido van Rossum4462e931997-01-22 21:00:32 +0000474In addition to the file Setup, you can also edit the file Setup.local.
475(the makesetup script processes both). You may find it more
476convenient to edit Setup.local and leave Setup alone. Then, when
477installing a new Python version, you can copy your old Setup.local
478file.
479
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000480
481Setting the optimization/debugging options
482------------------------------------------
483
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000484If you want or need to change the optimization/debugging options for
485the C compiler, assign to the OPT variable on the toplevel make
486command; e.g. "make OPT=-g" will build a debugging version of Python
487on most platforms. The default is OPT=-O; a value for OPT in the
488environment when the configure script is run overrides this default
489(likewise for CC; and the initial value for LIBS is used as the base
490set of libraries to link with).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000491
492
493Testing
494-------
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000495
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000496To test the interpreter, type "make test" in the top-level directory.
Guido van Rossum6ae5d3d1997-05-14 21:39:05 +0000497This runs the test set twice (once with no compiled files, once with
498the compiled files left by the previous test run). The test set
499produces some output. You can generally ignore the messages about
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000500skipped tests due to optional features which can't be imported. (If
501you want to test those modules, edit Modules/Setup to configure them.)
502If a message is printed about a failed test or a traceback or core
503dump is produced, something is wrong. On some Linux systems (those
Guido van Rossum24df6841997-12-30 04:32:30 +0000504that are not yet using glibc 6), test_strftime fails due to a
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000505non-standard implementation of strftime() in the C library. Please
506ignore this, or upgrade to glibc version 6.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000507
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000508IMPORTANT: If the tests fail and you decide to mail a bug report,
509*don't* include the output of "make test". It is useless. Run the
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000510failing test manually, as follows:
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000511
Guido van Rossum6ae5d3d1997-05-14 21:39:05 +0000512 python ../Lib/test/test_whatever.py
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000513
514(substituting the top of the source tree for .. if you built in a
Guido van Rossum6ae5d3d1997-05-14 21:39:05 +0000515different directory). This runs the test in verbose mode.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000516
517
518Installing
519----------
520
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000521To install the Python binary, library modules, shared library modules
522(see below), include files, configuration files, and the manual page,
Guido van Rossum64773801997-11-26 17:07:02 +0000523just type
524
525 make install
526
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000527This will install all platform-independent files in subdirectories of
528the directory given with the --prefix option to configure or to the
529`prefix' Make variable (default /usr/local). All binary and other
530platform-specific files will be installed in subdirectories if the
531directory given by --exec-prefix or the `exec_prefix' Make variable
532(defaults to the --prefix directory) is given.
Guido van Rossum64773801997-11-26 17:07:02 +0000533
534All subdirectories created will have Python's version number in their
535name, e.g. the library modules are installed in
Guido van Rossum901454e2000-06-29 22:28:44 +0000536"/usr/local/lib/python2.0/" by default. The Python binary is
537installed as "python2.0" and a hard link named "python" is created.
Guido van Rossum64773801997-11-26 17:07:02 +0000538The only file not installed with a version number in its name is the
539manual page, installed as "/usr/local/man/man1/python.1" by default.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000540
Guido van Rossum901454e2000-06-29 22:28:44 +0000541If you have a previous installation of a pre-2.0 Python that you don't
Guido van Rossum64773801997-11-26 17:07:02 +0000542want to replace yet, use
543
544 make altinstall
545
546This installs the same set of files as "make install" except it
Guido van Rossum901454e2000-06-29 22:28:44 +0000547doesn't create the hard link to "python2.0" named "python" and it
Guido van Rossum64773801997-11-26 17:07:02 +0000548doesn't install the manual page at all.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000549
550The only thing you may have to install manually is the Python mode for
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000551Emacs found in Misc/python-mode.el. (But then again, more recent
552versions of Emacs may already have it.) Follow the instructions that
553came with Emacs for installation of site-specific files.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000554
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000555
556Configuration options and variables
557-----------------------------------
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000558
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000559Some special cases are handled by passing options to the configure
560script.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000561
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000562WARNING: if you rerun the configure script with different options, you
563must run "make clean" before rebuilding. Exceptions to this rule:
564after changing --prefix or --exec-prefix, all you need to do is remove
Guido van Rossumb06df271997-08-05 21:50:20 +0000565Modules/getpath.o.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000566
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000567--with(out)-gcc: The configure script uses gcc (the GNU C compiler) if
568 it finds it. If you don't want this, or if this compiler is
569 installed but broken on your platform, pass the option
570 --without-gcc. You can also pass "CC=cc" (or whatever the
571 name of the proper C compiler is) in the environment, but the
572 advantage of using --without-gcc is that this option is
573 remembered by the config.status script for its --recheck
574 option.
Guido van Rossum76be6ed1995-01-02 18:33:54 +0000575
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000576--prefix, --exec-prefix: If you want to install the binaries and the
577 Python library somewhere else than in /usr/local/{bin,lib},
578 you can pass the option --prefix=DIRECTORY; the interpreter
579 binary will be installed as DIRECTORY/bin/python and the
580 library files as DIRECTORY/lib/python/*. If you pass
581 --exec-prefix=DIRECTORY (as well) this overrides the
582 installation prefix for architecture-dependent files (like the
583 interpreter binary). Note that --prefix=DIRECTORY also
584 affects the default module search path (sys.path), when
585 Modules/config.c is compiled. Passing make the option
586 prefix=DIRECTORY (and/or exec_prefix=DIRECTORY) overrides the
587 prefix set at configuration time; this may be more convenient
588 than re-running the configure script if you change your mind
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000589 about the install prefix.
Guido van Rossum76be6ed1995-01-02 18:33:54 +0000590
Guido van Rossumb06df271997-08-05 21:50:20 +0000591--with-readline: This option is no longer supported. To use GNU
592 readline, enable module "readline" in the Modules/Setup file.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000593
Guido van Rossum7ac11532000-08-29 21:36:40 +0000594--with-threads: On most Unix systems, you can now use multiple
595 threads, and support for this is enabled by default. To
596 disable this, pass --with-threads=no. If the library required
597 for threads lives in a peculiar place, you can use
598 --with-thread=DIRECTORY. IMPORTANT: run "make clean" after
599 changing (either enabling or disabling) this option, or you
600 will get link errors! Note: for DEC Unix use
Guido van Rossum0e13da91998-02-22 04:36:34 +0000601 --with-dec-threads instead.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000602
603--with-sgi-dl: On SGI IRIX 4, dynamic loading of extension modules is
604 supported by the "dl" library by Jack Jansen, which is
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000605 ftp'able from ftp://ftp.cwi.nl/pub/dynload/dl-1.6.tar.Z.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000606 This is enabled (after you've ftp'ed and compiled the dl
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000607 library) by passing --with-sgi-dl=DIRECTORY where DIRECTORY
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000608 is the absolute pathname of the dl library. (Don't bother on
609 IRIX 5, it already has dynamic linking using SunOS style
610 shared libraries.) Support for this feature is deprecated.
611
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000612--with-dl-dld: Dynamic loading of modules is rumored to be supported
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000613 on some other systems: VAX (Ultrix), Sun3 (SunOS 3.4), Sequent
614 Symmetry (Dynix), and Atari ST. This is done using a
615 combination of the GNU dynamic loading package
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000616 (ftp://ftp.cwi.nl/pub/dynload/dl-dld-1.1.tar.Z) and an
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000617 emulation of the SGI dl library mentioned above (the emulation
618 can be found at
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000619 ftp://ftp.cwi.nl/pub/dynload/dld-3.2.3.tar.Z). To
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000620 enable this, ftp and compile both libraries, then call
621 configure, passing it the option
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000622 --with-dl-dld=DL_DIRECTORY,DLD_DIRECTORY where DL_DIRECTORY is
623 the absolute pathname of the dl emulation library and
624 DLD_DIRECTORY is the absolute pathname of the GNU dld library.
625 (Don't bother on SunOS 4 or 5, they already have dynamic
626 linking using shared libraries.) Support for this feature is
627 deprecated.
628
629--with-libm, --with-libc: It is possible to specify alternative
630 versions for the Math library (default -lm) and the C library
631 (default the empty string) using the options
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000632 --with-libm=STRING and --with-libc=STRING, respectively. For
633 example, if your system requires that you pass -lc_s to the C
634 compiler to use the shared C library, you can pass
635 --with-libc=-lc_s. These libraries are passed after all other
636 libraries, the C library last.
Guido van Rossum3ff96dd1996-07-30 18:05:04 +0000637
638--with-next-archs='arch1 arch2': Under NEXTSTEP, this will build
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000639 all compiled binaries with the architectures listed. This will
640 also correctly set the target architecture-specific resource
Guido van Rossumcc55c2d1996-10-21 15:14:27 +0000641 directory. (This option is not supported on other platforms.)
Guido van Rossum76be6ed1995-01-02 18:33:54 +0000642
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000643--with-libs='libs': Add 'libs' to the LIBS that the python interpreter
644 is linked against.
Guido van Rossumd02ba451996-07-31 17:36:01 +0000645
Guido van Rossum76be6ed1995-01-02 18:33:54 +0000646
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000647Building for multiple architectures (using the VPATH feature)
648-------------------------------------------------------------
649
650If your file system is shared between multiple architectures, it
651usually is not necessary to make copies of the sources for each
652architecture you want to support. If the make program supports the
653VPATH feature, you can create an empty build directory for each
654architecture, and in each directory run the configure script (on the
655appropriate machine with the appropriate options). This creates the
656necessary subdirectories and the Makefiles therein. The Makefiles
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000657contain a line VPATH=... which points to a directory containing the
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000658actual sources. (On SGI systems, use "smake -J1" instead of "make" if
659you use VPATH -- don't try gnumake.)
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000660
661For example, the following is all you need to build a minimal Python
662in /usr/tmp/python (assuming ~guido/src/python is the toplevel
663directory and you want to build in /usr/tmp/python):
664
665 $ mkdir /usr/tmp/python
666 $ cd /usr/tmp/python
667 $ ~guido/src/python/configure
668 [...]
669 $ make
670 [...]
671 $
672
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000673Note that Modules/Makefile copies the original Setup file to the build
674directory if it finds no Setup file there. This means that you can
675edit the Setup file for each architecture independently. For this
676reason, subsequent changes to the original Setup file are not tracked
677automatically, as they might overwrite local changes. To force a copy
678of a changed original Setup file, delete the target Setup file. (The
679makesetup script supports multiple input files, so if you want to be
680fancy you can change the rules to create an empty Setup.local if it
681doesn't exist and run it with arguments $(srcdir)/Setup Setup.local;
682however this assumes that you only need to add modules.)
683
684
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000685Building on non-UNIX systems
686----------------------------
687
Tim Peters03444242000-09-19 00:38:35 +0000688For Windows (2000/NT/ME/98/95), assuming you have MS VC++ 6.0, the
689project files are in PCbuild, the workspace is pcbuild.dsw. See
690PCbuild\readme.txt for detailed instructions.
Guido van Rossum8d7d4ed1996-07-30 21:41:07 +0000691
Guido van Rossum31ae2071999-04-12 14:47:30 +0000692For other non-Unix Windows compilers, in particular Windows 3.1 and
693for OS/2, enter the directory "PC" and read the file "readme.txt".
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000694
695For the Mac, a separate source distribution will be made available,
696for use with the CodeWarrior compiler. If you are interested in Mac
697development, join the PythonMac Special Interest Group
698(http://www.python.org/sigs/pythonmac-sig/, or send email to
699pythonmac-sig-request@python.org).
700
701Of course, there are also binary distributions available for these
Guido van Rossumba909092000-09-26 12:14:11 +0000702platforms -- see http://www.pythonlabs.com/products/python2.0/.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000703
704To port Python to a new non-UNIX system, you will have to fake the
705effect of running the configure script manually (for Mac and PC, this
706has already been done for you). A good start is to copy the file
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000707config.h.in to config.h and edit the latter to reflect the actual
708configuration of your system. Most symbols must simply be defined as
7091 only if the corresponding feature is present and can be left alone
Tim Peters4f1b2082000-07-23 21:18:09 +0000710otherwise; however the *_t type symbols must be defined as some variant
711of int if they need to be defined at all.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000712
713
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000714
715Miscellaneous issues
716====================
717
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000718Emacs mode
719----------
720
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000721There's an excellent Emacs editing mode for Python code; see the file
722Misc/python-mode.el. Originally written by the famous Tim Peters, it
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000723is now maintained by the equally famous Barry Warsaw (it's no
724coincidence that they now both work at PythonLabs). The latest
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000725version, along with various other contributed Python-related Emacs
726goodies, is online at <http://www.python.org/emacs/python-mode>. And
727if you are planning to edit the Python C code, please pick up the
728latest version of CC Mode <http://www.python.org/emacs/cc-mode>; it
729contains a "python" style used throughout most of the Python C source
730files. (Newer versions of Emacs or XEmacs may already come with the
731latest version of python-mode.)
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000732
733
734The Tk interface
735----------------
736
737Tk (the user interface component of John Ousterhout's Tcl language) is
738also usable from Python. Since this requires that you first build and
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000739install Tcl/Tk, the Tk interface is not enabled by default. Python
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000740supports Tcl/Tk version 8.0 and higher.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000741
Guido van Rossum973e4dc2000-07-01 00:34:39 +0000742See http://dev.ajubasolutions.com/ for more info on Tcl/Tk, including
743the on-line manual pages.
Guido van Rossum64773801997-11-26 17:07:02 +0000744
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000745
746To enable the Python/Tk interface, once you've built and installed
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000747Tcl/Tk, load the file Modules/Setup into your favorite text editor and
Guido van Rossum64773801997-11-26 17:07:02 +0000748search for the string "_tkinter". Then follow the instructions found
749there. If you have installed Tcl/Tk or X11 in unusual places, you
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000750will have to edit the first line to fix or add the -I and -L options.
Guido van Rossum64773801997-11-26 17:07:02 +0000751(Also see the general instructions at the top of that file.)
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000752
Guido van Rossum973e4dc2000-07-01 00:34:39 +0000753For more Tkinter information, see the Tkinter Resource page:
754http://www.python.org/topics/tkinter/
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000755
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000756There are demos in the Demo/tkinter directory, in the subdirectories
757guido, matt and www (the matt and guido subdirectories have been
758overhauled to use more recent Tkinter coding conventions).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000759
760Note that there's a Python module called "Tkinter" (capital T) which
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000761lives in Lib/lib-tk/Tkinter.py, and a C module called "_tkinter"
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000762(lower case t and leading underscore) which lives in
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000763Modules/_tkinter.c. Demos and normal Tk applications import only the
764Python Tkinter module -- the latter uses the C _tkinter module
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000765directly. In order to find the C _tkinter module, it must be compiled
766and linked into the Python interpreter -- the _tkinter line in the
767Setup file does this. In order to find the Python Tkinter module,
768sys.path must be set correctly -- the TKPATH assignment in the Setup
769file takes care of this, but only if you install Python properly
770("make install libinstall"). (You can also use dynamic loading for
771the C _tkinter module, in which case you must manually fix up sys.path
772or set $PYTHONPATH for the Python Tkinter module.)
Guido van Rossum84c8c7f1995-08-28 02:44:24 +0000773
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000774
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000775Distribution structure
776----------------------
777
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000778Most subdirectories have their own README files. Most files have
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000779comments.
780
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000781.cvsignore Additional filename matching patterns for CVS to ignore
782BeOS/ Files specific to the BeOS port
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000783Demo/ Demonstration scripts, modules and programs
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000784Doc/ Documentation sources (LaTeX)
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000785Grammar/ Input for the parser generator
786Include/ Public header files
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000787LICENSE Licensing information
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000788Lib/ Python library modules
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000789Makefile.in Source from which config.status creates the Makefile
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000790Misc/ Miscellaneous useful files
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000791Modules/ Implementation of most built-in modules
792Objects/ Implementation of most built-in object types
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000793PC/ Files specific to PC ports (DOS, Windows, OS/2)
794PCbuild/ Build directory for Microsoft Visual C++
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000795Parser/ The parser and tokenizer and their input handling
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000796Python/ The byte-compiler and interpreter
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000797README The file you're reading now
798Tools/ Some useful programs written in Python
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000799acconfig.h Additional input for the GNU autoheader program
800config.h.in Source from which config.h is created (GNU autoheader output)
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000801configure Configuration shell script (GNU autoconf output)
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000802configure.in Configuration specification (input for GNU autoconf)
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000803install-sh Shell script used to install files
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000804
805The following files will (may) be created in the toplevel directory by
806the configuration and build processes:
807
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000808Makefile Build rules
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000809buildno Keeps track of the build number
810config.cache Cache of configuration variables
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000811config.h Configuration header
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000812config.log Log from last configure run
Guido van Rossum4f40c2d2000-09-05 16:46:22 +0000813config.status Status from last run of the configure script
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000814getbuildinfo.o Object file from Modules/getbuildinfo.c
Guido van Rossum901454e2000-06-29 22:28:44 +0000815libpython2.0.a The library archive
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000816python The executable interpreter
817tags, TAGS Tags files for vi and Emacs
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000818
819
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000820That's all, folks!
821------------------
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000822
823
Guido van Rossumc07d5fa2000-09-01 22:50:02 +0000824--Guido van Rossum (home page: http://www.pythonlabs.com/~guido/)