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