blob: b91e7e58e77314ab7b1d79c5c05fe10c4ba81d5a [file] [log] [blame]
Guido van Rossum901454e2000-06-29 22:28:44 +00001This is Python version 2.0
Guido van Rossum91447632000-04-11 17:11:09 +00002==========================
3
Guido van Rossum901454e2000-06-29 22:28:44 +00004There are various beta versions -- these are distinguishable through
5Include/patchlevel.h or by the name of the top-level directory and the
6tar file.
Guido van Rossum79808261997-12-11 18:01:47 +00007
8
Guido van Rossum8d7d4ed1996-07-30 21:41:07 +00009What's new in this release?
10---------------------------
Guido van Rossum3ff96dd1996-07-30 18:05:04 +000011
Guido van Rossum901454e2000-06-29 22:28:44 +000012See http://www.pythonlabs.com/.
13
14
15Why is it called version 2.0?
16-----------------------------
17
18While Pythoneers have grown fond of Python's exceedingly slow version
19incrementing, that same quality makes parts of the rest of the world
20think that Python is barely out of its first alpha test. Especially
21enterprise customers are often fearful of anything that's version 1.x!
22The new version number also clearly marks departure of Python's core
Jeremy Hylton7efcafb2000-06-30 17:30:18 +000023development team from CNRI to join BeOpen.com.
24
25What happened to Python 1.6? It was promoted and renamed Python 2.0.
26There were two alpha releases of Python 1.6 before we decided to
27increment the major version number.
Guido van Rossum901454e2000-06-29 22:28:44 +000028
29Previously, the version number 2.0 was associated with a mythical and
30elusive incompatible future release. That release (still ways off,
31and not as incompatible as people fear!) is now referred to as Python
323000.
Guido van Rossum64773801997-11-26 17:07:02 +000033
Guido van Rossum64773801997-11-26 17:07:02 +000034
35If you don't read instructions
36------------------------------
37
38Congratulations on getting this far. :-)
39
40To start building right away (on UNIX): type "./configure" in the
41current directory and when it finishes, type "make". The section
42Build Instructions below is still recommended reading. :-)
Guido van Rossum3ff96dd1996-07-30 18:05:04 +000043
44
Guido van Rossum91cb9d21995-04-10 11:47:38 +000045What is Python anyway?
46----------------------
47
48Python is an interpreted object-oriented programming language, and is
Guido van Rossumc0be2f51997-10-08 05:05:28 +000049often compared to Tcl, Perl, Java or Scheme. To find out more, point
50your browser to http://www.python.org/.
51
52
53A modest plug
54-------------
55
56************************************************************************
57* Without your support, I won't be able to continue to work on Python! *
58************************************************************************
59
60If you use Python, please consider joining the Python Software
61Activity (PSA). See http://www.python.org/psa/.
62
63Organizations that make heavy use of Python are especially encouraged
Guido van Rossumde64eaf1998-10-17 19:44:20 +000064to become corporate members -- or better still, to join the Python
65Consortium (see http://www.python.org/consortium/).
Guido van Rossum91cb9d21995-04-10 11:47:38 +000066
67
Guido van Rossumf501b4e1996-10-25 14:32:48 +000068How do I learn Python?
69----------------------
70
Fred Drake0e6444c1999-05-17 19:35:01 +000071The official tutorial is still a good place to start; see
Guido van Rossumd0a42e22000-03-31 20:16:45 +000072http://www.python.org/doc/ for online and downloadable versions, as
73well as a list of other introductions, and reference documentation.
Guido van Rossumf501b4e1996-10-25 14:32:48 +000074
Guido van Rossumd0a42e22000-03-31 20:16:45 +000075There's a quickly growing set of books on Python. See
76http://www.python.org/psa/bookstore/ for a list.
Guido van Rossum8d90f9d1997-05-22 20:13:25 +000077
Guido van Rossumf501b4e1996-10-25 14:32:48 +000078
Guido van Rossum91cb9d21995-04-10 11:47:38 +000079Copyright issues
80----------------
81
82Python is COPYRIGHTED but free to use for all. See the full copyright
Guido van Rossum64773801997-11-26 17:07:02 +000083notice at the end of this file and in the file Misc/COPYRIGHT.
Guido van Rossum91cb9d21995-04-10 11:47:38 +000084
85The Python distribution is *not* affected by the GNU Public Licence
86(GPL). There are interfaces to some GNU code but these are entirely
Guido van Rossum64773801997-11-26 17:07:02 +000087optional and no GNU code is distributed with Python.
Guido van Rossum91cb9d21995-04-10 11:47:38 +000088
Guido van Rossum627b2d71993-12-24 10:39:16 +000089
Guido van Rossum901454e2000-06-29 22:28:44 +000090
Guido van Rossum433c8ad1994-08-01 12:07:07 +000091Build instructions
Guido van Rossum91cb9d21995-04-10 11:47:38 +000092==================
Guido van Rossum627b2d71993-12-24 10:39:16 +000093
Guido van Rossum6d9cc801996-08-01 17:31:22 +000094Before you can build Python, you must first configure it.
95Fortunately, the configuration and build process has been streamlined
96for most Unix installations, so all you have to do is type a few
97commands, optionally edit one file, and sit back. There are some
98platforms where things are not quite as smooth; see the platform
99specific notes below. If you want to build for multiple platforms
100sharing the same source tree, see the section on VPATH below.
Guido van Rossum627b2d71993-12-24 10:39:16 +0000101
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000102You start by running the script "./configure", which figures out your
103system configuration and creates several Makefiles. (It takes a
104minute or two -- please be patient!) When it's done, you are ready to
105run make. You may want to pass options to the configure script -- see
106the section below on configuration options and variables.
107
108To build Python, you normally type "make" in the toplevel directory.
109This will recursively run make in each of the subdirectories Parser,
110Objects, Python and Modules, creating a library file in each one. The
111executable of the interpreter is built in the Modules subdirectory and
112moved up here when it is built. If you want or need to, you can also
113chdir into each subdirectory in turn and run make there manually (do
114the Modules subdirectory last!).
115
116Once you have built an interpreter, see the subsections below on
117testing, configuring additional modules, and installation. If you run
118in trouble, see the next section.
Guido van Rossum627b2d71993-12-24 10:39:16 +0000119
Guido van Rossum0a516c91994-09-12 10:58:40 +0000120
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000121Troubleshooting
122---------------
Guido van Rossum627b2d71993-12-24 10:39:16 +0000123
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000124See also the platform specific notes in the next section.
125
Guido van Rossumfaf681a1996-06-20 14:32:08 +0000126If recursive makes fail, try invoking make as "make MAKE=make".
127
Guido van Rossum49523691997-08-15 18:30:14 +0000128If you run into other trouble, see section 3 of the FAQ
Guido van Rossum901454e2000-06-29 22:28:44 +0000129(http://www.python.org/cgi-bin/faqw.py or
Guido van Rossum49523691997-08-15 18:30:14 +0000130http://www.python.org/doc/FAQ.html) for hints on what can go wrong,
131and how to fix it.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000132
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000133If you rerun the configure script with different options, remove all
134object files by running "make clean" before rebuilding. Believe it or
135not, "make clean" sometimes helps to clean up other inexplicable
136problems as well. Try it before sending in a bug report!
137
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000138If the configure script fails or doesn't seem to find things that
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000139should be there, inspect the config.log file. When you fix a
140configure problem, be sure to remove config.cache!
141
142If you get a warning for every file about the -Olimit option being no
143longer supported, you can ignore it. There's no foolproof way to know
144whether this option is needed; all I can do is test whether it is
145accepted without error. On some systems, e.g. older SGI compilers, it
146is essential for performance (specifically when compiling ceval.c,
147which has more basic blocks than the default limit of 1000). If the
148warning bothers you, edit the Makefile to remove "-Olimit 1500" from
149the OPT variable.
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000150
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000151
152Platform specific notes
153-----------------------
154
Guido van Rossum0447a321995-10-08 01:22:33 +0000155(Some of these may no longer apply. If you find you can build Python
156on these platforms without the special directions mentioned here, let
157me know so I can remove them!)
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000158
Guido van Rossumc0be2f51997-10-08 05:05:28 +000015964-bit platforms: The modules audioop, imageop and rgbimg don't work.
160 Don't try to enable them in the Modules/Setup file. They
161 contain code that is quite wordsize sensitive. (If you have a
162 fix, let me know!)
163
Guido van Rossum4462e931997-01-22 21:00:32 +0000164Solaris: When using Sun's C compiler with threads, at least on Solaris
165 2.5.1, you need to add the "-mt" compiler option (the simplest
166 way is probably to specify the compiler with this option as
167 the "CC" environment variable when running the configure
168 script).
169
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000170Linux: On Linux version 1.x, once you've built Python, use it to run
171 the regen script in the Lib/linux1 directory. Apparently
172 the files as distributed don't match the system headers on
173 some Linux versions. (The "h2py" command refers to
174 Tools/scripts/h2py.py.) The modules distributed for Linux 2.x
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000175 should be okay. Shared library support now works by default
Guido van Rossum4462e931997-01-22 21:00:32 +0000176 on ELF-based x86 Linux systems. (Note: when you change the
177 status of a module from static to shared, you must remove its
178 .o file or do a "make clean".)
179
Fred Drake61280911997-12-08 14:10:40 +0000180 Under RedHat Linux 5.0, if upgraded from a previous version,
181 remove the LinuxThreads packages. This is needed because
182 LinuxThreads conflicts with the new thread support provided by
183 glibc. Before running Python's configure script, use the
184 following commands as root (version numbers may differ; these
185 are from a stock 4.2 install):
186
187 % rpm -qa | grep ^linuxthread
188 linuxthreads-0.5-1
189 linuxthreads-devel-0.5-1
190 % rpm -e linuxthreads linuxthreads-devel
191
192 While Python only needs this to be done to allow thread
193 support to be included, the conflicts these packages create
194 with the new glibc may cause other packages which use threads
195 to fail as well, so their removal is a good idea regardless of
196 how you configure python.
197
Guido van Rossumfe23ad71999-04-12 19:01:45 +0000198 More recently, a problem with threads and fork() was tracked
199 down to a bug in the pthreads code in glibc version 2.0.5;
200 glibc version 2.0.7 solves the problem. This causes the
201 popen2 test to fail; problem and solution reported by Pablo
202 Bleyer.
203
Fred Drake61280911997-12-08 14:10:40 +0000204 Also under RedHat Linux 5.0, the crypt module now needs the
205 -lcrypt option. Uncomment this flag in Modules/Setup, or
206 comment out the crypt module in the same file.
207
Guido van Rossum59230501999-06-21 20:51:46 +0000208FreeBSD 3.x and probably platforms with NCurses that use libmytinfo or
209 similar: When using cursesmodule, the linking is not done in
210 the correct order with the defaults. Remove "-ltermcap" from
211 the readline entry in Setup, and use as curses entry: "curses
212 cursesmodule.c -lmytinfo -lncurses -ltermcap" - "mytinfo" (so
213 called on FreeBSD) should be the name of the auxiliary library
214 required on your platform. Normally, it would be linked
215 automatically, but not necessarily in the correct order.
216
Guido van Rossum6ae5d3d1997-05-14 21:39:05 +0000217DEC Unix: When enabling threads, use --with-dec-threads, not
Guido van Rossum9ac9a261998-02-16 22:19:21 +0000218 --with-thread. When using GCC, it is possible to get an
219 internal compiler error if optimization is used. This was
220 reported for GCC 2.7.2.3 on selectmodule.c. Manually compile
221 the affected file without optimization to solve the problem.
Guido van Rossum8eca2c21996-02-14 18:37:46 +0000222
Guido van Rossume1cdb161999-04-10 16:04:07 +0000223DEC Ultrix: compile with GCC to avoid bugs in the native compiler,
224 and pass SHELL=/bin/sh5 to Make when installing.
225
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000226AIX: A complete overhaul of the shared library support is now in
Guido van Rossumcbfcb171997-10-20 22:57:00 +0000227 place. See Misc/AIX-NOTES for some notes on how it's done.
Guido van Rossum9ac9a261998-02-16 22:19:21 +0000228 (The optimizer bug reported at this place in previous releases
229 has been worked around by a minimal code change.)
Guido van Rossumed7f9e21999-11-16 16:03:03 +0000230 In addition, Gary Duzan has a hint for C++ users: to enable
231 full C++ module support, set CC="xlC" (or CC="xlC_r" for thread
232 support in AIX 4.2.1).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000233
Guido van Rossum59a88f41999-04-12 18:16:09 +0000234HP-UX: Please read the file Misc/HPUX-NOTES for shared libraries.
235 When using threading, you may have to add -D_REENTRANT to the
236 OPT variable in the top-level Makefile; reported by Pat Knight
237 this seems to make a difference (at least for HP-UX 10.20)
238 even though config.h defines it.
Guido van Rossum2094e041998-05-14 15:47:35 +0000239
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000240Minix: When using ack, use "CC=cc AR=aal RANLIB=: ./configure"!
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000241
Guido van Rossuma16e2751998-04-13 20:14:05 +0000242SCO: The following only apply to SCO 3; Python builds out of the box
243 on SCO 5 (or so I've heard).
244
245 1) Everything works much better if you add -U__STDC__ to the
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000246 defs. This is because all the SCO header files are broken.
Guido van Rossum64773801997-11-26 17:07:02 +0000247 Anything that isn't mentioned in the C standard is
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000248 conditionally excluded when __STDC__ is defined.
249
250 2) Due to the U.S. export restrictions, SCO broke the crypt
251 stuff out into a separate library, libcrypt_i.a so the LIBS
252 needed be set to:
253
254 LIBS=' -lsocket -lcrypt_i'
255
Guido van Rossuma16e2751998-04-13 20:14:05 +0000256SunOS 4.x: When using the standard "cc" compiler, certain modules may
Guido van Rossum64773801997-11-26 17:07:02 +0000257 not be compilable because they use non-K&R syntax. You should
258 be able to get a basic Python interpreter by commenting out
259 such modules in the Modules/Setup file, but I really recommend
260 using gcc.
261
262 When using the SunPro C compiler, you may want to use the
263 '-Xa' option instead of '-Xc', to enable some needed non-ANSI
264 Sunisms.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000265
Guido van Rossumcc55c2d1996-10-21 15:14:27 +0000266NeXT: To build fat binaries, use the --with-next-archs switch
267 described below.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000268
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000269QNX: Chris Herborth (chrish@qnx.com) writes:
270 configure works best if you use GNU bash; a port is available on
271 ftp.qnx.com in /usr/free. I used the following process to build,
Guido van Rossumd4493421998-12-22 16:37:01 +0000272 test and install Python 1.5.x under QNX:
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000273
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000274 1) CONFIG_SHELL=/usr/local/bin/bash CC=cc RANLIB=: \
275 ./configure --verbose --without-gcc --with-libm=""
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000276
277 2) copy Modules/Setup.in to Modules/Setup; edit Modules/Setup to
278 activate everything that makes sense for your system... tested
279 here at QNX with the following modules:
280
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000281 array, audioop, binascii, cPickle, cStringIO, cmath,
282 crypt, curses, errno, fcntl, gdbm, grp, imageop,
283 _locale, math, md5, new, operator, parser, pcre,
284 posix, pwd, readline, regex, reop, rgbimg, rotor,
285 select, signal, socket, soundex, strop, struct,
Guido van Rossumd4493421998-12-22 16:37:01 +0000286 syslog, termios, time, timing, zlib, audioop, imageop, rgbimg
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000287
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000288 3) make SHELL=/usr/local/bin/bash
289
290 or, if you feel the need for speed:
291
292 make SHELL=/usr/local/bin/bash OPT="-5 -Oil+nrt"
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000293
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000294 4) make SHELL=/usr/local/bin/bash test
295
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000296 Using GNU readline 2.2 seems to behave strangely, but I
297 think that's a problem with my readline 2.2 port. :-\
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000298
299 5) make SHELL=/usr/local/bin/bash install
Guido van Rossumb7f454d1997-12-02 19:44:31 +0000300
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000301 If you get SIGSEGVs while running Python (I haven't yet, but
302 I've only run small programs and the test cases), you're
303 probably running out of stack; the default 32k could be a
304 little tight. To increase the stack size, edit the Makefile
305 in the Modules directory to read: LDFLAGS = -N 48k
Guido van Rossum40d63581997-08-14 19:45:30 +0000306
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000307BeOS: Chris Herborth (chrish@qnx.com) writes:
308 See BeOS/README for notes about compiling/installing Python on
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000309 BeOS R3 or later. Note that only the PowerPC platform is
Guido van Rossumd4493421998-12-22 16:37:01 +0000310 supported for R3; both PowerPC and x86 are supported for R4.
Guido van Rossumec95c7b1998-08-04 17:59:56 +0000311
Guido van Rossum1bf0bf41997-08-20 23:50:51 +0000312Cray T3E: Konrad Hinsen writes:
Guido van Rossum6fa49e21998-08-11 17:31:39 +0000313 1) Don't use gcc. It compiles Python/graminit.c into something
314 that the Cray assembler doesn't like. Cray's cc seems to work
315 fine.
316 2) Uncomment modules md5 (won't compile) and audioop (will
317 crash the interpreter during the test suite).
318 If you run the test suite, two tests will fail (rotate and
319 binascii), but these are not the modules you'd expect to need
320 on a Cray.
Guido van Rossum1bf0bf41997-08-20 23:50:51 +0000321
Guido van Rossum0078aaf1997-08-21 03:05:11 +0000322SGI: SGI's standard "make" utility (/bin/make or /usr/bin/make)
323 does not check whether a command actually changed the file it
324 is supposed to build. This means that whenever you say "make"
325 it will redo the link step. The remedy is to use SGI's much
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000326 smarter "smake " utility (/usr/sbin/smake), or GNU make. If
327 you set the first line of the Makefile to #!/usr/sbin/smake
328 smake will be invoked by make (likewise for GNU make).
Guido van Rossum0078aaf1997-08-21 03:05:11 +0000329
Guido van Rossum9ac9a261998-02-16 22:19:21 +0000330 A bug in the MIPSpro 7.1 compiler's optimizer seems to break
331 Modules/pypcre.c. The short term solution is to compile it
Guido van Rossum0dd010a1998-06-30 16:58:58 +0000332 without optimization. The bug is fixed in version 7.2.1 of
333 the compiler.
Guido van Rossum9ac9a261998-02-16 22:19:21 +0000334
Guido van Rossumf5ade401999-01-11 16:45:44 +0000335 A bug in gcc-2.8.1 sets sys.maxint to -1 which *also* seems to
336 break Modules/pypcre.c. The egcs versions of gcc fix this
Guido van Rossum583b0191999-01-11 16:47:30 +0000337 problem. Or use configure --without-gcc to compile with SGI's
338 compiler, if you have it. (Raj Srinivasan, Kelvin Chu)
Guido van Rossumf5ade401999-01-11 16:45:44 +0000339
Guido van Rossum64773801997-11-26 17:07:02 +0000340OS/2: If you are running Warp3 or Warp4 and have IBM's VisualAge C/C++
341 compiler installed, just change into the pc\os2vacpp directory
342 and type NMAKE. Threading and sockets are supported by default
343 in the resulting binaries of PYTHON15.DLL and PYTHON.EXE.
344
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000345
Guido van Rossumdc8a3cb1998-05-12 15:29:18 +0000346Configuring threads
347-------------------
348
349The main switch to configure threads is to run the configure script
350(see below) with the --with-thread switch (on DEC, use
351--with-dec-threads). Unfortunately, on some platforms, additional
352compiler and/or linker options are required. Below is a table of
353those options, collected by Bill Janssen. I would love to automate
354this process more, but the information below is not enough to write a
355patch for the configure.in file, so manual intervention is required.
356If you patch the configure.in file and are confident that the patch
357works, please send me the patch. (Don't bother patching the configure
358script itself -- it is regenerated each the configure.in file
359changes.)
360
361Compiler switches for threads
362.............................
363
364 OS/Compiler/threads Switches for use with threads
365 (POSIX is draft 10, DCE is draft 4) (1) compile only (2) compile & link
366
367 SunOS 5.{1-5}/{gcc,SunPro cc}/solaris (1) -D_REENTRANT (2) -mt
368 SunOS 5.5/{gcc,SunPro cc}/POSIX (1) -D_REENTRANT
369 DEC OSF/1 3.x/cc/DCE (1) -D_REENTRANT (2) -threads
370 (butenhof@zko.dec.com)
371 Digital UNIX 4.x/cc/DCE (1) -D_REENTRANT (2) -threads
372 (butenhof@zko.dec.com)
373 Digital UNIX 4.x/cc/POSIX (1) -D_REENTRANT (2) -pthread
374 (butenhof@zko.dec.com)
375 AIX 4.1.4/cc_r/d7 (nothing)
376 (buhrt@iquest.net)
377 AIX 4.1.4/cc_r4/DCE (nothing)
378 (buhrt@iquest.net)
379 IRIX 6.2/cc/POSIX (nothing)
380 (robertl@cwi.nl)
381
382
383Linker (ld) libraries and flags for threads
384...........................................
385
386 OS/threads Libraries/switches for use with threads
387
388 SunOS 5.{1-5}/solaris -lthread
389 SunOS 5.5/POSIX -lpthread
390 DEC OSF/1 3.x/DCE -lpthreads -lmach -lc_r -lc
391 (butenhof@zko.dec.com)
392 Digital UNIX 4.x/DCE -lpthreads -lpthread -lmach -lexc -lc
393 (butenhof@zko.dec.com)
394 Digital UNIX 4.x/POSIX -lpthread -lmach -lexc -lc
395 (butenhof@zko.dec.com)
396 AIX 4.1.4/{draft7,DCE} (nothing)
397 (buhrt@iquest.net)
398 IRIX 6.2/POSIX -lpthread
399 (jph@emilia.engr.sgi.com)
400
401
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000402Configuring additional built-in modules
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000403---------------------------------------
Guido van Rossum19e0c261995-01-17 16:36:34 +0000404
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000405You can configure the interpreter to contain fewer or more built-in
406modules by editing the file Modules/Setup. This file is initially
407copied (when the toplevel Makefile makes Modules/Makefile for the
408first time) from Setup.in; if it does not exist yet, make a copy
409yourself. Never edit Setup.in -- always edit Setup. Read the
410comments in the file for information on what kind of edits you can
411make. When you have edited Setup, Makefile and config.c in Modules
412will automatically be rebuilt the next time you run make in the
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000413toplevel directory. (When working inside the Modules directory, use
414"make Makefile; make".)
Guido van Rossum627b2d71993-12-24 10:39:16 +0000415
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000416The default collection of modules should build on any Unix system, but
417many optional modules should work on all modern Unices (e.g. try dbm,
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000418nis, termios, timing, syslog, curses, new, soundex, parser). Often
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000419the quickest way to determine whether a particular module works or not
420is to see if it will build: enable it in Setup, then if you get
421compilation or link errors, disable it -- you're missing support.
422
423On SGI IRIX, there are modules that interface to many SGI specific
424system libraries, e.g. the GL library and the audio hardware.
425
426For SunOS and Solaris, enable module "sunaudiodev" to support the
427audio device.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000428
Guido van Rossum4462e931997-01-22 21:00:32 +0000429In addition to the file Setup, you can also edit the file Setup.local.
430(the makesetup script processes both). You may find it more
431convenient to edit Setup.local and leave Setup alone. Then, when
432installing a new Python version, you can copy your old Setup.local
433file.
434
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000435
436Setting the optimization/debugging options
437------------------------------------------
438
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000439If you want or need to change the optimization/debugging options for
440the C compiler, assign to the OPT variable on the toplevel make
441command; e.g. "make OPT=-g" will build a debugging version of Python
442on most platforms. The default is OPT=-O; a value for OPT in the
443environment when the configure script is run overrides this default
444(likewise for CC; and the initial value for LIBS is used as the base
445set of libraries to link with).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000446
447
448Testing
449-------
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000450
451To test the interpreter that you have just built, type "make test".
Guido van Rossum6ae5d3d1997-05-14 21:39:05 +0000452This runs the test set twice (once with no compiled files, once with
453the compiled files left by the previous test run). The test set
454produces some output. You can generally ignore the messages about
455skipped tests due to an optional feature that can't be imported (if
456you want to test those modules, edit Modules/Setup to configure them).
457If a messages is printed about a failed test or a traceback or core
Guido van Rossum24df6841997-12-30 04:32:30 +0000458dump is produced, something's wrong. On some Linux systems (those
459that are not yet using glibc 6), test_strftime fails due to a
460non-standard-compliant implementation of strftime() in the C library.
461Please ignore this, or upgrade to glibc version 6.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000462
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000463IMPORTANT: If the tests fail and you decide to mail a bug report,
464*don't* include the output of "make test". It is useless. Run the
Guido van Rossum6ae5d3d1997-05-14 21:39:05 +0000465test that fails manually, as follows:
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000466
Guido van Rossum6ae5d3d1997-05-14 21:39:05 +0000467 python ../Lib/test/test_whatever.py
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000468
469(substituting the top of the source tree for .. if you built in a
Guido van Rossum6ae5d3d1997-05-14 21:39:05 +0000470different directory). This runs the test in verbose mode.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000471
472
473Installing
474----------
475
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000476To install the Python binary, library modules, shared library modules
477(see below), include files, configuration files, and the manual page,
Guido van Rossum64773801997-11-26 17:07:02 +0000478just type
479
480 make install
481
482This will install all platform-independent files in subdirectories the
483directory given with the --prefix option to configure or the 'prefix'
484Make variable (default /usr/local), and all binary and other
485platform-specific files in subdirectories if the directory given by
486--exec-prefix or the 'exec_prefix' Make variable (defaults to the
487--prefix directory).
488
489All subdirectories created will have Python's version number in their
490name, e.g. the library modules are installed in
Guido van Rossum901454e2000-06-29 22:28:44 +0000491"/usr/local/lib/python2.0/" by default. The Python binary is
492installed as "python2.0" and a hard link named "python" is created.
Guido van Rossum64773801997-11-26 17:07:02 +0000493The only file not installed with a version number in its name is the
494manual page, installed as "/usr/local/man/man1/python.1" by default.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000495
Guido van Rossum901454e2000-06-29 22:28:44 +0000496If you have a previous installation of a pre-2.0 Python that you don't
Guido van Rossum64773801997-11-26 17:07:02 +0000497want to replace yet, use
498
499 make altinstall
500
501This installs the same set of files as "make install" except it
Guido van Rossum901454e2000-06-29 22:28:44 +0000502doesn't create the hard link to "python2.0" named "python" and it
Guido van Rossum64773801997-11-26 17:07:02 +0000503doesn't install the manual page at all.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000504
505The only thing you may have to install manually is the Python mode for
506Emacs. (But then again, more recent versions of Emacs may already
507have it!) This is the file Misc/python-mode.el; follow the
508instructions that came with Emacs for installation of site specific
509files.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000510
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000511
512Configuration options and variables
513-----------------------------------
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000514
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000515Some special cases are handled by passing options to the configure
516script.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000517
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000518WARNING: if you rerun the configure script with different options, you
519must run "make clean" before rebuilding. Exceptions to this rule:
520after changing --prefix or --exec-prefix, all you need to do is remove
Guido van Rossumb06df271997-08-05 21:50:20 +0000521Modules/getpath.o.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000522
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000523--with(out)-gcc: The configure script uses gcc (the GNU C compiler) if
524 it finds it. If you don't want this, or if this compiler is
525 installed but broken on your platform, pass the option
526 --without-gcc. You can also pass "CC=cc" (or whatever the
527 name of the proper C compiler is) in the environment, but the
528 advantage of using --without-gcc is that this option is
529 remembered by the config.status script for its --recheck
530 option.
Guido van Rossum76be6ed1995-01-02 18:33:54 +0000531
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000532--prefix, --exec-prefix: If you want to install the binaries and the
533 Python library somewhere else than in /usr/local/{bin,lib},
534 you can pass the option --prefix=DIRECTORY; the interpreter
535 binary will be installed as DIRECTORY/bin/python and the
536 library files as DIRECTORY/lib/python/*. If you pass
537 --exec-prefix=DIRECTORY (as well) this overrides the
538 installation prefix for architecture-dependent files (like the
539 interpreter binary). Note that --prefix=DIRECTORY also
540 affects the default module search path (sys.path), when
541 Modules/config.c is compiled. Passing make the option
542 prefix=DIRECTORY (and/or exec_prefix=DIRECTORY) overrides the
543 prefix set at configuration time; this may be more convenient
544 than re-running the configure script if you change your mind
545 about the install prefix...
Guido van Rossum76be6ed1995-01-02 18:33:54 +0000546
Guido van Rossumb06df271997-08-05 21:50:20 +0000547--with-readline: This option is no longer supported. To use GNU
548 readline, enable module "readline" in the Modules/Setup file.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000549
Guido van Rossumfaf681a1996-06-20 14:32:08 +0000550--with-thread: On most Unix systems, you can now use multiple threads.
Guido van Rossum4462e931997-01-22 21:00:32 +0000551 To enable this, pass --with-thread. (--with-threads is an
552 alias.) If the library required for threads lives in a
Guido van Rossum8d90f9d1997-05-22 20:13:25 +0000553 peculiar place, you can use --with-thread=DIRECTORY. NOTE:
554 you must also enable the thread module by uncommenting it in
555 the Modules/Setup file. (Threads aren't enabled automatically
556 because there are run-time penalties when support for them is
557 compiled in even if you don't use them.) IMPORTANT: run "make
558 clean" after changing (either enabling or disabling) this
Guido van Rossum0e13da91998-02-22 04:36:34 +0000559 option, or you will get link errors! Note: for DEC Unix use
560 --with-dec-threads instead.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000561
562--with-sgi-dl: On SGI IRIX 4, dynamic loading of extension modules is
563 supported by the "dl" library by Jack Jansen, which is
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000564 ftp'able from ftp://ftp.cwi.nl/pub/dynload/dl-1.6.tar.Z.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000565 This is enabled (after you've ftp'ed and compiled the dl
566 library!) by passing --with-sgi-dl=DIRECTORY where DIRECTORY
567 is the absolute pathname of the dl library. (Don't bother on
568 IRIX 5, it already has dynamic linking using SunOS style
569 shared libraries.) Support for this feature is deprecated.
570
571--with-dl-dld: Dynamic loading of modules is rumoured to be supported
572 on some other systems: VAX (Ultrix), Sun3 (SunOS 3.4), Sequent
573 Symmetry (Dynix), and Atari ST. This is done using a
574 combination of the GNU dynamic loading package
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000575 (ftp://ftp.cwi.nl/pub/dynload/dl-dld-1.1.tar.Z) and an
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000576 emulation of the SGI dl library mentioned above (the emulation
577 can be found at
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000578 ftp://ftp.cwi.nl/pub/dynload/dld-3.2.3.tar.Z). To
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000579 enable this, ftp and compile both libraries, then call the
580 configure passing it the option
581 --with-dl-dld=DL_DIRECTORY,DLD_DIRECTORY where DL_DIRECTORY is
582 the absolute pathname of the dl emulation library and
583 DLD_DIRECTORY is the absolute pathname of the GNU dld library.
584 (Don't bother on SunOS 4 or 5, they already have dynamic
585 linking using shared libraries.) Support for this feature is
586 deprecated.
587
588--with-libm, --with-libc: It is possible to specify alternative
589 versions for the Math library (default -lm) and the C library
590 (default the empty string) using the options
591 --with-libm=STRING and --with-libc=STRING, respectively. E.g.
592 if your system requires that you pass -lc_s to the C compiler
593 to use the shared C library, you can pass --with-libc=-lc_s.
594 These libraries are passed after all other libraries, the C
595 library last.
Guido van Rossum3ff96dd1996-07-30 18:05:04 +0000596
597--with-next-archs='arch1 arch2': Under NEXTSTEP, this will build
598 all compiled binaries with the architectures listed. Includes
599 correctly setting the target architecture specific resource
Guido van Rossumcc55c2d1996-10-21 15:14:27 +0000600 directory. (This option is not supported on other platforms.)
Guido van Rossum76be6ed1995-01-02 18:33:54 +0000601
Guido van Rossumd02ba451996-07-31 17:36:01 +0000602--with-libs='libs': Add 'libs' to the LIBS that the python
603 linked against.
604
Guido van Rossum76be6ed1995-01-02 18:33:54 +0000605
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000606Building for multiple architectures (using the VPATH feature)
607-------------------------------------------------------------
608
609If your file system is shared between multiple architectures, it
610usually is not necessary to make copies of the sources for each
611architecture you want to support. If the make program supports the
612VPATH feature, you can create an empty build directory for each
613architecture, and in each directory run the configure script (on the
614appropriate machine with the appropriate options). This creates the
615necessary subdirectories and the Makefiles therein. The Makefiles
616contain a line VPATH=... which points to directory containing the
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000617actual sources. (On SGI systems, use "smake -J1" instead of "make" if
618you use VPATH -- don't try gnumake.)
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000619
620For example, the following is all you need to build a minimal Python
621in /usr/tmp/python (assuming ~guido/src/python is the toplevel
622directory and you want to build in /usr/tmp/python):
623
624 $ mkdir /usr/tmp/python
625 $ cd /usr/tmp/python
626 $ ~guido/src/python/configure
627 [...]
628 $ make
629 [...]
630 $
631
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000632Note that Modules/Makefile copies the original Setup file to the build
633directory if it finds no Setup file there. This means that you can
634edit the Setup file for each architecture independently. For this
635reason, subsequent changes to the original Setup file are not tracked
636automatically, as they might overwrite local changes. To force a copy
637of a changed original Setup file, delete the target Setup file. (The
638makesetup script supports multiple input files, so if you want to be
639fancy you can change the rules to create an empty Setup.local if it
640doesn't exist and run it with arguments $(srcdir)/Setup Setup.local;
641however this assumes that you only need to add modules.)
642
643
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000644Building on non-UNIX systems
645----------------------------
646
Guido van Rossum31ae2071999-04-12 14:47:30 +0000647For Windows 95/98 or NT, assuming you have MS VC++ 5.0 or 6.0, the
648project files are in PCbuild, the workspace is pcbuild.dsw. (The
649project files are for VC++ 5.0, but VC++ 6.0 will convert them for
650you -- start VC++ and then use Open Workspace.)
Guido van Rossum8d7d4ed1996-07-30 21:41:07 +0000651
Guido van Rossum31ae2071999-04-12 14:47:30 +0000652For other non-Unix Windows compilers, in particular Windows 3.1 and
653for OS/2, enter the directory "PC" and read the file "readme.txt".
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000654
655For the Mac, a separate source distribution will be made available,
656for use with the CodeWarrior compiler. If you are interested in Mac
657development, join the PythonMac Special Interest Group
658(http://www.python.org/sigs/pythonmac-sig/, or send email to
659pythonmac-sig-request@python.org).
660
661Of course, there are also binary distributions available for these
662platforms -- see http://www.python.org/python/.
663
664To port Python to a new non-UNIX system, you will have to fake the
665effect of running the configure script manually (for Mac and PC, this
666has already been done for you). A good start is to copy the file
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000667config.h.in to config.h and edit the latter to reflect the actual
668configuration of your system. Most symbols must simply be defined as
6691 only if the corresponding feature is present and can be left alone
670otherwise; however RETSIGTYPE must always be defined, either as int or
671as void, and the *_t type symbols must be defined as some variant of
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000672int if they need to be defined at all.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000673
674
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000675
676Miscellaneous issues
677====================
678
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000679Documentation
680-------------
681
Fred Drake0e6444c1999-05-17 19:35:01 +0000682All documentation is provided online in a variety of formats. In
683order of importance for new users: Tutorial, Library Reference,
684Language Reference, Extending & Embedding, and the Python/C API.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000685Especially the Library Reference is of immense value since much of
686Python's power (including the built-in data types and functions!) is
Fred Drake0e6444c1999-05-17 19:35:01 +0000687described there.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000688
Fred Drake0e6444c1999-05-17 19:35:01 +0000689All documentation is also available online via the Python web site
690(http://www.python.org/, see below). It is available online for
691occaissional reference, or can be downloaded in many formats for
692faster access. The documents are available in HTML, PostScript, PDF,
693HTML Help, and LaTeX; the LaTeX version is primarily for documentation
694authors or people with special formatting requirements.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000695
696
697Emacs mode
698----------
699
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000700There's an excellent Emacs editing mode for Python code; see the file
701Misc/python-mode.el. Originally written by the famous Tim Peters, it
702is now maintained by the equally famous Barry Warsaw
Guido van Rossum901454e2000-06-29 22:28:44 +0000703<bwarsaw@python.org>. The latest version, along with various
Barry Warsawfe216b71998-05-29 20:56:34 +0000704other contributed Python-related Emacs goodies, is online at
705<http://www.python.org/emacs/python-mode>. And if you are planning to
706edit the Python C code, please pick up the latest version of CC Mode
707<http://www.python.org/emacs/cc-mode>; it contains a "python" style
708used throughout most of the Python C source files.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000709
710
Guido van Rossum8d7d4ed1996-07-30 21:41:07 +0000711Web site
712--------
713
714Python's own web site has URL http://www.python.org/. Come visit us!
Guido van Rossuma16e2751998-04-13 20:14:05 +0000715There are a number of mirrors, and a list of mirrors is accessible
716from the home page -- try a mirror that's close you you.
Guido van Rossum8d7d4ed1996-07-30 21:41:07 +0000717
718
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000719Ftp site
720--------
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000721
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000722Python's own ftp site is ftp://ftp.python.org/pub/python/. There are
Guido van Rossuma16e2751998-04-13 20:14:05 +0000723numerous mirrors; the list of mirrors is accessible from
724http://www.python.org/.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000725
726
Guido van Rossuma16e2751998-04-13 20:14:05 +0000727Newsgroups
728----------
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000729
Guido van Rossuma16e2751998-04-13 20:14:05 +0000730Read comp.lang.python, a high-volume discussion newsgroup about
731Python, or comp.lang.python.announce, a low-volume moderated newsgroup
732for Python-related announcements. These are also accessible as
733mailing lists, see the next item.
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000734
Guido van Rossuma16e2751998-04-13 20:14:05 +0000735Archives are accessible via Deja News; the Python website has a
736query form for the archives at http://www.python.org/search/.
737
738
739Mailing lists
740-------------
741
742See http://www.python.org/psa/MailingLists.html for an overview of the
743many Python related mailing lists.
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000744
745
746Bug reports
747-----------
748
Guido van Rossuma16e2751998-04-13 20:14:05 +0000749Bugs are best reported to the comp.lang.python newsgroup (or the
750Python mailing list) -- see the section "Newsgroups" above. Before
751posting, check the newsgroup archives (see above) to see if your bug
752has already been reported! If you don't want to go public, send them
753to me: <guido@python.org>.
Guido van Rossumd0fe8451996-08-26 03:02:37 +0000754
755
756Questions
757---------
758
Guido van Rossum49523691997-08-15 18:30:14 +0000759For help, if you can't find it in the manuals or on the web site, it's
760best to post to the comp.lang.python or the Python mailing list (see
761above). If you specifically don't want to involve the newsgroup or
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000762mailing list, send questions to <python-help@python.org> (a group of
763volunteers which does *not* include me). Because of my work and email
764volume, I'm often be slow in answering questions sent to me directly;
765I prefer to answer questions posted to the newsgroup.
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000766
767
768The Tk interface
769----------------
770
771Tk (the user interface component of John Ousterhout's Tcl language) is
772also usable from Python. Since this requires that you first build and
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000773install Tcl/Tk, the Tk interface is not enabled by default. Python
774supports all Tcl/Tk versions from version 7.5/4.1 through 8.0 (and it
775is expected that it will also work with newer versions). Tcl/Tk
Guido van Rossum64773801997-11-26 17:07:02 +00007767.4/4.0 is no longer supported. 8.0 or any later non-alpha non-beta
777release is recommended.
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000778
Guido van Rossum64773801997-11-26 17:07:02 +0000779See http://sunscript.sun.com/ for more info on Tcl/Tk, including the
780on-line manual pages.
781
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000782
783To enable the Python/Tk interface, once you've built and installed
Guido van Rossum64773801997-11-26 17:07:02 +0000784Tcl/Tk, load the file Modules/Setup in your favorite text editor and
785search for the string "_tkinter". Then follow the instructions found
786there. If you have installed Tcl/Tk or X11 in unusual places, you
787will have to edit the first line to fix or add -I and -L options.
788(Also see the general instructions at the top of that file.)
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000789
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000790There is little documentation on how to use Tkinter; however most of
791the Tk manual pages apply quite straightforwardly. Begin with
792fetching the "Tk Lifesaver" document,
793e.g. ftp://ftp.python.org/pub/python/doc/tkinter-doc.tar.gz (a gzipped
794tar file containing a PostScript file) or the on-line version
795http://www.python.org/doc/life-preserver/index.html. Reading the
796Tkinter.py source will reveal most details on how Tkinter calls are
797translated into Tcl code.
798
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000799A more recent introduction to Tkinter programming, by Fredrik Lundh,
800is at http://www.pythonware.com/library/tkinter/introduction/index.htm.
801
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000802There are demos in the Demo/tkinter directory, in the subdirectories
803guido, matt and www (the matt and guido subdirectories have been
804overhauled to use more recent Tkinter coding conventions).
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000805
806Note that there's a Python module called "Tkinter" (capital T) which
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000807lives in Lib/tkinter/Tkinter.py, and a C module called "_tkinter"
808(lower case t and leading underscore) which lives in
809Modules/_tkinter.c. Demos and normal Tk applications only import the
810Python Tkinter module -- only the latter uses the C _tkinter module
811directly. In order to find the C _tkinter module, it must be compiled
812and linked into the Python interpreter -- the _tkinter line in the
813Setup file does this. In order to find the Python Tkinter module,
814sys.path must be set correctly -- the TKPATH assignment in the Setup
815file takes care of this, but only if you install Python properly
816("make install libinstall"). (You can also use dynamic loading for
817the C _tkinter module, in which case you must manually fix up sys.path
818or set $PYTHONPATH for the Python Tkinter module.)
Guido van Rossum84c8c7f1995-08-28 02:44:24 +0000819
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000820
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000821Distribution structure
822----------------------
823
824Most subdirectories have their own README file. Most files have
825comments.
826
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000827Demo/ Demonstration scripts, modules and programs
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000828Grammar/ Input for the parser generator
829Include/ Public header files
830Lib/ Python library modules
831Makefile.in Source from which config.status creates Makefile
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000832Misc/ Miscellaneous useful files
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000833Modules/ Implementation of most built-in modules
834Objects/ Implementation of most built-in object types
Guido van Rossum64773801997-11-26 17:07:02 +0000835PC/ PC porting files (DOS, Windows, OS/2)
836PCbuild/ Directory where you should build for Windows NT/95
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000837Parser/ The parser and tokenizer and their input handling
838Python/ The "compiler" and interpreter
839README The file you're reading now
840Tools/ Some useful programs written in Python
841acconfig.h Additional input for the autoheader program
842config.h.in Source from which config.status creates config.h
843configure Configuration shell script (GNU autoconf output)
844configure.in Configuration specification (GNU autoconf input)
845install-sh Shell script used to install files
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000846
847The following files will (may) be created in the toplevel directory by
848the configuration and build processes:
849
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000850Makefile Build rules
851config.cache cache of configuration variables
852config.h Configuration header
Guido van Rossumc0be2f51997-10-08 05:05:28 +0000853config.log Log from last configure run
854config.status Status from last run of configure script
Guido van Rossum901454e2000-06-29 22:28:44 +0000855libpython2.0.a The library archive
Guido van Rossum6d9cc801996-08-01 17:31:22 +0000856python The executable interpreter
857tags, TAGS Tags files for vi and Emacs
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000858
859
Guido van Rossum901454e2000-06-29 22:28:44 +0000860
861How to reach the author
862=======================
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000863
864Guido van Rossum
Guido van Rossum901454e2000-06-29 22:28:44 +0000865BeOpen.com
866160 Saratoga Avenue, Suite 46
867Santa Clara, CA 95051
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000868
Guido van Rossum901454e2000-06-29 22:28:44 +0000869E-mail: guido@beopen.com or guido@python.org
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000870
871
Guido van Rossum91cb9d21995-04-10 11:47:38 +0000872
873Copyright notice
874================
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000875
876The Python source is copyrighted, but you can freely use and copy it
Guido van Rossum901454e2000-06-29 22:28:44 +0000877as long as you don't change or remove the copyright notice. The
878copyright notice is found in the Misc/COPYRIGHT file.
Guido van Rossum433c8ad1994-08-01 12:07:07 +0000879
880
Guido van Rossumfaf681a1996-06-20 14:32:08 +0000881--Guido van Rossum (home page: http://www.python.org/~guido/)