README

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