README

   1 This is Python version 2.2
   2 ==========================
   3
   4 Copyright (c) 2001 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 If you don't read instructions
  39 ------------------------------
  40
  41 Congratulations on getting this far. :-)
  42
  43 To start building right away (on UNIX): type "./configure" in the
  44 current directory and when it finishes, type "make".  The section
  45 `Build Instructions' below is still recommended reading, especially
  46 the part on customizing Modules/Setup.
  47
  48
  49 What is Python anyway?
  50 ----------------------
  51
  52 Python is an interpreted object-oriented programming language suitable
  53 (amongst other uses) for distributed application development,
  54 scripting, numeric computing and system testing.  Python is often
  55 compared to Tcl, Perl, Java, JavaScript, Visual Basic or Scheme.  To
  56 find out more about what Python can do for you, point your browser to
  57 http://www.python.org/.
  58
  59
  60 How do I learn Python?
  61 ----------------------
  62
  63 The official tutorial is still a good place to start; see
  64 http://www.python.org/doc/ for online and downloadable versions, as
  65 well as a list of other introductions, and reference documentation.
  66
  67 There's a quickly growing set of books on Python.  See
  68 http://www.python.org/psa/bookstore/ for a list.
  69
  70
  71 Documentation
  72 -------------
  73
  74 All documentation is provided online in a variety of formats.  In
  75 order of importance for new users: Tutorial, Library Reference,
  76 Language Reference, Extending & Embedding, and the Python/C API.  The
  77 Library Reference is especially of immense value since much of
  78 Python's power is described there, including the built-in data types
  79 and functions!
  80
  81 All documentation is also available online at the Python web site
  82 (http://www.python.org/doc/, see below).  It is available online for
  83 occasional reference, or can be downloaded in many formats for faster
  84 access.  The documentation is available in HTML, PostScript, PDF, and
  85 LaTeX formats; the LaTeX version is primarily for documentation
  86 authors, translators, and people with special formatting requirements.
  87
  88
  89 Web sites
  90 ---------
  91
  92 New Python releases and related technologies are published at
  93 http://www.python.org/.  Come visit us!
  94
  95 There's also a Python community web site at http://starship.python.net/.
  96
  97
  98 Newsgroups and Mailing Lists
  99 ----------------------------
 100
 101 Read comp.lang.python, a high-volume discussion newsgroup about
 102 Python, or comp.lang.python.announce, a low-volume moderated newsgroup
 103 for Python-related announcements.  These are also accessible as
 104 mailing lists: see http://www.python.org/psa/MailingLists.html for an
 105 overview of the many Python-related mailing lists.
 106
 107 Archives are accessible via Deja.com Usenet News: see
 108 http://www.deja.com/usenet.  The mailing lists are also archived, see
 109 http://www.python.org/psa/MailingLists.html for details.
 110
 111
 112 Bug reports
 113 -----------
 114
 115 To report or search for bugs, please use the Python Bug
 116 Tracker at http://sourceforge.net/bugs/?group_id=5470.
 117
 118
 119 Patches and contributions
 120 -------------------------
 121
 122 To submit a patch or other contribution, please use the Python Patch
 123 Manager at http://sourceforge.net/patch/?group_id=5470.  Guidelines
 124 for patch submission may be found at http://www.python.org/patches/.
 125
 126 If you have a proposal to change Python, it's best to submit a Python
 127 Enhancement Proposal (PEP) first.  All current PEPs, as well as
 128 guidelines for submitting a new PEP, are list at
 129 http://python.sourceforge.net/peps/.
 130
 131
 132 Questions
 133 ---------
 134
 135 For help, if you can't find it in the manuals or on the web site, it's
 136 best to post to the comp.lang.python or the Python mailing list (see
 137 above).  If you specifically don't want to involve the newsgroup or
 138 mailing list, send questions to help@python.org (a group of volunteers
 139 who answer questions as they can).  The newsgroup is the most
 140 efficient way to ask public questions.
 141
 142
 143 Build instructions
 144 ==================
 145
 146 Before you can build Python, you must first configure it.  Fortunately,
 147 the configuration and build process has been streamlined for most Unix
 148 installations, so all you have to do is type a few commands,
 149 optionally edit one file, and sit back.  There are some platforms
 150 where things are not quite as smooth; see the platform specific notes
 151 below.  If you want to build for multiple platforms sharing the same
 152 source tree, see the section on VPATH below.
 153
 154 Start by running the script "./configure", which determines your system
 155 configuration and creates the Makefile.  (It takes a minute or two --
 156 please be patient!)  You may want to pass options to the configure
 157 script or edit the Modules/Setup file after running configure -- see the
 158 section below on configuration options and variables.  When it's done,
 159 you are ready to run make.
 160
 161 To build Python, you normally type "make" in the toplevel directory.  If
 162 you have changed the configuration or have modified Modules/Setup, the
 163 Makefile may have to be rebuilt.  In this case you may have to run make
 164 again to correctly build your desired target.  The interpreter
 165 executable is built in the top level directory.
 166
 167 Once you have built a Python interpreter, see the subsections below on
 168 testing, configuring additional modules, and installation.  If you run
 169 into trouble, see the next section.  Editing the Modules/Setup file
 170 after running make is supported; just run "make" again after making
 171 the desired changes.
 172
 173
 174 Troubleshooting
 175 ---------------
 176
 177 See also the platform specific notes in the next section.
 178
 179 If you run into other trouble, see section 3 of the FAQ
 180 (http://www.python.org/cgi-bin/faqw.py or
 181 http://www.python.org/doc/FAQ.html) for hints on what can go wrong,
 182 and how to fix it.
 183
 184 If you rerun the configure script with different options, remove all
 185 object files by running "make clean" before rebuilding.  Believe it or
 186 not, "make clean" sometimes helps to clean up other inexplicable
 187 problems as well.  Try it before sending in a bug report!
 188
 189 If the configure script fails or doesn't seem to find things that
 190 should be there, inspect the config.log file.  When you fix a
 191 configure problem, be sure to remove config.cache!
 192
 193 If you get a warning for every file about the -Olimit option being no
 194 longer supported, you can ignore it.  There's no foolproof way to know
 195 whether this option is needed; all we can do is test whether it is
 196 accepted without error.  On some systems, e.g. older SGI compilers, it
 197 is essential for performance (specifically when compiling ceval.c,
 198 which has more basic blocks than the default limit of 1000).  If the
 199 warning bothers you, edit the Makefile to remove "-Olimit 1500" from
 200 the OPT variable.
 201
 202 If you get failures in test_long, or sys.maxint gets set to -1, you
 203 are probably experiencing compiler bugs, usually related to
 204 optimization.  This is a common problem with some versions of gcc and
 205 egcs, and some vendor-supplied compilers, which can sometimes be
 206 worked around by turning off optimization.  Consider switching to
 207 stable versions (gcc 2.7.2.3, egcs 1.1.2, or contact your vendor.)
 208
 209 From Python 2.0 onward, all Python C code is ANSI C.  Compiling using
 210 old K&R-C-only compilers is no longer possible.  ANSI C compilers are
 211 available for all modern systems, either in the form of updated
 212 compilers from the vendor, or one of the free compilers (gcc, egcs).
 213
 214 Platform specific notes
 215 -----------------------
 216
 217 (Some of these may no longer apply.  If you find you can build Python
 218 on these platforms without the special directions mentioned here,
 219 submit a documentation bug report to SourceForge (see Bug Reports
 220 above) so we can remove them!)
 221
 222 64-bit platforms: The modules audioop, imageop and rgbimg don't work.
 223         Don't try to enable them in the Modules/Setup file.  They
 224         contain code that is quite wordsize sensitive.  (If you have a
 225         fix, let us know!)
 226
 227 Solaris: When using Sun's C compiler with threads, at least on Solaris
 228         2.5.1, you need to add the "-mt" compiler option (the simplest
 229         way is probably to specify the compiler with this option as
 230         the "CC" environment variable when running the configure
 231         script).
 232
 233 Linux:  A problem with threads and fork() was tracked down to a bug in
 234         the pthreads code in glibc version 2.0.5; glibc version 2.0.7
 235         solves the problem.  This causes the popen2 test to fail;
 236         problem and solution reported by Pablo Bleyer.
 237
 238         Under Linux systems using GNU libc 2 (aka libc6), the crypt
 239         module now needs the -lcrypt option.  Uncomment this flag in
 240         Modules/Setup, or comment out the crypt module in the same
 241         file. Most modern Linux systems use glibc2.
 242
 243 FreeBSD 3.x and probably platforms with NCurses that use libmytinfo or
 244         similar: When using cursesmodule, the linking is not done in
 245         the correct order with the defaults.  Remove "-ltermcap" from
 246         the readline entry in Setup, and use as curses entry: "curses
 247         cursesmodule.c -lmytinfo -lncurses -ltermcap" - "mytinfo" (so
 248         called on FreeBSD) should be the name of the auxiliary library
 249         required on your platform.  Normally, it would be linked
 250         automatically, but not necessarily in the correct order.
 251
 252 BSDI:   BSDI versions before 4.1 have known problems with threads,
 253         which can cause strange errors in a number of modules (for
 254         instance, the 'test_signal' test script will hang forever.)
 255         Turning off threads (with --with-threads=no) or upgrading to
 256         BSDI 4.1 solves this problem.
 257
 258 DEC Unix: Run configure with --with-dec-threads, or with
 259         --with-threads=no if no threads are desired (threads are on by
 260         default).  When using GCC, it is possible to get an internal
 261         compiler error if optimization is used.  This was reported for
 262         GCC 2.7.2.3 on selectmodule.c.  Manually compile the affected
 263         file without optimization to solve the problem.
 264
 265 DEC Ultrix: compile with GCC to avoid bugs in the native compiler,
 266         and pass SHELL=/bin/sh5 to Make when installing.
 267
 268 AIX:    A complete overhaul of the shared library support is now in
 269         place.  See Misc/AIX-NOTES for some notes on how it's done.
 270         (The optimizer bug reported at this place in previous releases
 271         has been worked around by a minimal code change.) If you get
 272         errors about ptread_* functions, during compile or during
 273         testing, try setting CC to a thread-safe (reentrant) compiler,
 274         like "cc_r".  For full C++ module support, set CC="xlC_r" (or
 275         CC="xlC" without thread support).
 276
 277 HP-UX:  Please read the file Misc/HPUX-NOTES for shared libraries.
 278         When using threading, you may have to add -D_REENTRANT to the
 279         OPT variable in the top-level Makefile; reported by Pat Knight,
 280         this seems to make a difference (at least for HP-UX 10.20)
 281         even though config.h defines it.
 282
 283 Minix:  When using ack, use "CC=cc AR=aal RANLIB=: ./configure"!
 284
 285 SCO:    The following apply to SCO 3 only; Python builds out of the box
 286         on SCO 5 (or so we've heard).
 287
 288         1) Everything works much better if you add -U__STDC__ to the
 289         defs.  This is because all the SCO header files are broken.
 290         Anything that isn't mentioned in the C standard is
 291         conditionally excluded when __STDC__ is defined.
 292
 293         2) Due to the U.S. export restrictions, SCO broke the crypt
 294         stuff out into a separate library, libcrypt_i.a so the LIBS
 295         needed be set to:
 296
 297                 LIBS=' -lsocket -lcrypt_i'
 298
 299 SunOS 4.x: When using the SunPro C compiler, you may want to use the
 300         '-Xa' option instead of '-Xc', to enable some needed non-ANSI
 301         Sunisms.
 302
 303 NeXT:   To build fat binaries, use the --with-next-archs switch
 304         described below.
 305
 306 QNX:    Chris Herborth (chrish@qnx.com) writes:
 307         configure works best if you use GNU bash; a port is available on
 308         ftp.qnx.com in /usr/free.  I used the following process to build,
 309         test and install Python 1.5.x under QNX:
 310
 311         1) CONFIG_SHELL=/usr/local/bin/bash CC=cc RANLIB=: \
 312             ./configure --verbose --without-gcc --with-libm=""
 313
 314         2) edit Modules/Setup to activate everything that makes sense for
 315            your system... tested here at QNX with the following modules:
 316
 317                 array, audioop, binascii, cPickle, cStringIO, cmath,
 318                 crypt, curses, errno, fcntl, gdbm, grp, imageop,
 319                 _locale, math, md5, new, operator, parser, pcre,
 320                 posix, pwd, readline, regex, reop, rgbimg, rotor,
 321                 select, signal, socket, soundex, strop, struct,
 322                 syslog, termios, time, timing, zlib, audioop, imageop, rgbimg
 323
 324         3) make SHELL=/usr/local/bin/bash
 325
 326            or, if you feel the need for speed:
 327
 328            make SHELL=/usr/local/bin/bash OPT="-5 -Oil+nrt"
 329
 330         4) make SHELL=/usr/local/bin/bash test
 331
 332            Using GNU readline 2.2 seems to behave strangely, but I
 333            think that's a problem with my readline 2.2 port.  :-\
 334
 335         5) make SHELL=/usr/local/bin/bash install
 336
 337         If you get SIGSEGVs while running Python (I haven't yet, but
 338         I've only run small programs and the test cases), you're
 339         probably running out of stack; the default 32k could be a
 340         little tight.  To increase the stack size, edit the Makefile
 341         to read: LDFLAGS = -N 48k
 342
 343 BeOS:   Chris Herborth (chrish@qnx.com) writes:
 344         See BeOS/README for notes about compiling/installing Python on
 345         BeOS R3 or later.  Note that only the PowerPC platform is
 346         supported for R3; both PowerPC and x86 are supported for R4.
 347
 348 Cray T3E: Konrad Hinsen writes:
 349         1) Don't use gcc. It compiles Python/graminit.c into something
 350            that the Cray assembler doesn't like. Cray's cc seems to work
 351            fine.
 352         2) Comment out modules md5 (won't compile) and audioop (will
 353            crash the interpreter during the test suite).
 354         If you run the test suite, two tests will fail (rotate and
 355         binascii), but these are not the modules you'd expect to need
 356         on a Cray.
 357
 358 SGI:    SGI's standard "make" utility (/bin/make or /usr/bin/make)
 359         does not check whether a command actually changed the file it
 360         is supposed to build.  This means that whenever you say "make"
 361         it will redo the link step.  The remedy is to use SGI's much
 362         smarter "smake" utility (/usr/sbin/smake), or GNU make.  If
 363         you set the first line of the Makefile to #!/usr/sbin/smake
 364         smake will be invoked by make (likewise for GNU make).
 365
 366         WARNING: There are bugs in the optimizer of some versions of
 367         SGI's compilers that can cause bus errors or other strange
 368         behavior, especially on numerical operations.  To avoid this,
 369         try building with "make OPT=".
 370
 371 OS/2:   If you are running Warp3 or Warp4 and have IBM's VisualAge C/C++
 372         compiler installed, just change into the pc\os2vacpp directory
 373         and type NMAKE.  Threading and sockets are supported by default
 374         in the resulting binaries of PYTHON15.DLL and PYTHON.EXE.
 375
 376 Monterey (64-bit AIX): The current Monterey C compiler (Visual Age)
 377         uses the OBJECT_MODE={32|64} environment variable to set the
 378         compilation mode to either 32-bit or 64-bit (32-bit mode is
 379         the default).  Presumably you want 64-bit compilation mode for
 380         this 64-bit OS.  As a result you must first set OBJECT_MODE=64
 381         in your environment before configuring (./configure) or
 382         building (make) Python on Monterey.
 383
 384 Reliant UNIX: The thread support does not compile on Reliant UNIX, and
 385         there is a (minor) problem in the configure script for that
 386         platform as well.  This should be resolved in time for a
 387         future release.
 388
 389 Mac OS X 10.0: Run configure with "OPT='-no-cpp-precomp' ./configure
 390         --with-suffix=.exe --with-dyld".  This generates executable
 391         file: 'python.exe' (it cannot be named 'python' on an HFS or
 392         HFS+ disk as the file name clashes with directory 'Python').
 393         The '-no-cpp-precomp' option prevents a large number of
 394         compilation warnings.  One of the regular expression tests
 395         fails with a SEGV due to the small stack size used by default
 396         (how to change this?), and the test_largefile test is only
 397         expected to work on a Unix UFS filesystem (how to check for
 398         this on Mac OS X?).
 399
 400 Cygwin: Cygwin Python builds OOTB when configured as follows:
 401
 402             configure --with-threads=no
 403
 404         assuming Cygwin 1.1.8-2 and gcc 2.95.3-1 or later.  At the time
 405         of this writing, Cygwin pthread support is being significantly
 406         enhanced.  Hopefully, there will be a Cygwin Python with thread
 407         support soon.
 408
 409         Cygwin Python supports the building of shared extensions via the
 410         traditional Misc/Makefile.pre.in and the newer distutils methods.
 411
 412         On NT/2000, the following regression tests fail:
 413
 414             test_poll (hang)
 415             test_strftime
 416
 417         Due to the test_poll hang on NT/2000, one should run the
 418         regression test using the following:
 419
 420             PYTHONPATH= ./python.exe -tt ./Lib/test/regrtest.py -l -x test_poll
 421
 422         On 9X/Me, in addition the above NT/2000 failures, it has been
 423         reported that the following regression tests also fail:
 424
 425             test_pwd
 426             test_select (hang)
 427             test_socket
 428
 429         Due to the test_poll and test_select hang on 9X/Me, one should
 430         run the regression test using the following:
 431
 432             PYTHONPATH= ./python.exe -tt ./Lib/test/regrtest.py -l -x test_poll -x test_select
 433
 434         Help trying to track down the root causes for these known problems
 435         will be greatly appreciated.
 436
 437
 438 Configuring threads
 439 -------------------
 440
 441 As of Python 2.0, threads are enabled by default.  If you wish to
 442 compile without threads, or if your thread support is broken, pass the
 443 --with-threads=no switch to configure.  Unfortunately, on some
 444 platforms, additional compiler and/or linker options are required for
 445 threads to work properly.  Below is a table of those options,
 446 collected by Bill Janssen.  We would love to automate this process
 447 more, but the information below is not enough to write a patch for the
 448 configure.in file, so manual intervention is required.  If you patch
 449 the configure.in file and are confident that the patch works, please
 450 send in the patch.  (Don't bother patching the configure script itself
 451 -- it is regenerated each the configure.in file changes.)
 452
 453 Compiler switches for threads
 454 .............................
 455
 456 The definition of _REENTRANT should be configured automatically, if
 457 that does not work on your system, or if _REENTRANT is defined
 458 incorrectly, please report that as a bug.
 459
 460     OS/Compiler/threads                     Switches for use with threads
 461     (POSIX is draft 10, DCE is draft 4)     compile & link
 462
 463     SunOS 5.{1-5}/{gcc,SunPro cc}/solaris   -mt
 464     SunOS 5.5/{gcc,SunPro cc}/POSIX         (nothing)
 465     DEC OSF/1 3.x/cc/DCE                    -threads
 466             (butenhof@zko.dec.com)
 467     Digital UNIX 4.x/cc/DCE                 -threads
 468             (butenhof@zko.dec.com)
 469     Digital UNIX 4.x/cc/POSIX               -pthread
 470             (butenhof@zko.dec.com)
 471     AIX 4.1.4/cc_r/d7                       (nothing)
 472             (buhrt@iquest.net)
 473     AIX 4.1.4/cc_r4/DCE                     (nothing)
 474             (buhrt@iquest.net)
 475     IRIX 6.2/cc/POSIX                       (nothing)
 476             (robertl@cwi.nl)
 477
 478
 479 Linker (ld) libraries and flags for threads
 480 ...........................................
 481
 482     OS/threads                          Libraries/switches for use with threads
 483
 484     SunOS 5.{1-5}/solaris               -lthread
 485     SunOS 5.5/POSIX                     -lpthread
 486     DEC OSF/1 3.x/DCE                   -lpthreads -lmach -lc_r -lc
 487             (butenhof@zko.dec.com)
 488     Digital UNIX 4.x/DCE                -lpthreads -lpthread -lmach -lexc -lc
 489             (butenhof@zko.dec.com)
 490     Digital UNIX 4.x/POSIX              -lpthread -lmach -lexc -lc
 491             (butenhof@zko.dec.com)
 492     AIX 4.1.4/{draft7,DCE}              (nothing)
 493             (buhrt@iquest.net)
 494     IRIX 6.2/POSIX                      -lpthread
 495             (jph@emilia.engr.sgi.com)
 496
 497
 498 Configuring additional built-in modules
 499 ---------------------------------------
 500
 501 Starting with Python 2.1, the setup.py script at the top of the source
 502 distribution attempts to detect which modules can be built and
 503 automatically compiles them.  Autodetection doesn't always work, so
 504 you can customize the configuration by editing the Modules/Setup file.
 505 This file is initially copied from Setup.dist by the configure script;
 506 if it does not exist yet, create it by copying Modules/Setup.dist
 507 yourself (configure will never overwrite it).  Never edit Setup.dist
 508 -- always edit Setup or Setup.local (see below).  Read the comments in
 509 the file for information on what kind of edits are allowed.  When you
 510 have edited Setup in the Modules directory, the interpreter will
 511 automatically be rebuilt the next time you run make in the toplevel
 512 directory.  (When working inside the Modules directory, use "make
 513 Makefile; make".)
 514
 515 Many useful modules can be built on any Unix system, but some optional
 516 modules can't be reliably autodetected.  Often the quickest way to
 517 determine whether a particular module works or not is to see if it
 518 will build: enable it in Setup, then if you get compilation or link
 519 errors, disable it -- you're either missing support or need to adjust
 520 the compilation and linking parameters for that module.
 521
 522 On SGI IRIX, there are modules that interface to many SGI specific
 523 system libraries, e.g. the GL library and the audio hardware.  These
 524 modules will not be built by the setup.py script.
 525
 526 In addition to the file Setup, you can also edit the file Setup.local.
 527 (the makesetup script processes both).  You may find it more
 528 convenient to edit Setup.local and leave Setup alone.  Then, when
 529 installing a new Python version, you can copy your old Setup.local
 530 file.
 531
 532
 533 Setting the optimization/debugging options
 534 ------------------------------------------
 535
 536 If you want or need to change the optimization/debugging options for
 537 the C compiler, assign to the OPT variable on the toplevel make
 538 command; e.g. "make OPT=-g" will build a debugging version of Python
 539 on most platforms.  The default is OPT=-O; a value for OPT in the
 540 environment when the configure script is run overrides this default
 541 (likewise for CC; and the initial value for LIBS is used as the base
 542 set of libraries to link with).
 543
 544 When compiling with GCC, the default value of OPT will also include
 545 the -Wall and -Wstrict-prototypes options.
 546
 547 Additional debugging code to help debug memory management problems can
 548 be enabled by using the --with-pydebug option to the configure script.
 549
 550
 551 Testing
 552 -------
 553
 554 To test the interpreter, type "make test" in the top-level directory.
 555 This runs the test set twice (once with no compiled files, once with
 556 the compiled files left by the previous test run).  The test set
 557 produces some output.  You can generally ignore the messages about
 558 skipped tests due to optional features which can't be imported.  (If
 559 you want to test those modules, edit Modules/Setup to configure them.)
 560 If a message is printed about a failed test or a traceback or core
 561 dump is produced, something is wrong.  On some Linux systems (those
 562 that are not yet using glibc 6), test_strftime fails due to a
 563 non-standard implementation of strftime() in the C library. Please
 564 ignore this, or upgrade to glibc version 6.
 565
 566 IMPORTANT: If the tests fail and you decide to mail a bug report,
 567 *don't* include the output of "make test".  It is useless.  Run the
 568 failing test manually, as follows:
 569
 570         python ../Lib/test/test_whatever.py
 571
 572 (substituting the top of the source tree for .. if you built in a
 573 different directory).  This runs the test in verbose mode.
 574
 575
 576 Installing
 577 ----------
 578
 579 To install the Python binary, library modules, shared library modules
 580 (see below), include files, configuration files, and the manual page,
 581 just type
 582
 583         make install
 584
 585 This will install all platform-independent files in subdirectories of
 586 the directory given with the --prefix option to configure or to the
 587 `prefix' Make variable (default /usr/local).  All binary and other
 588 platform-specific files will be installed in subdirectories if the
 589 directory given by --exec-prefix or the `exec_prefix' Make variable
 590 (defaults to the --prefix directory) is given.
 591
 592 All subdirectories created will have Python's version number in their
 593 name, e.g. the library modules are installed in
 594 "/usr/local/lib/python<version>/" by default, where <version> is the
 595 <major>.<minor> release number (e.g. "2.1").  The Python binary is
 596 installed as "python<version>" and a hard link named "python" is
 597 created.  The only file not installed with a version number in its
 598 name is the manual page, installed as "/usr/local/man/man1/python.1"
 599 by default.
 600
 601 If you have a previous installation of Python that you don't
 602 want to replace yet, use
 603
 604         make altinstall
 605
 606 This installs the same set of files as "make install" except it
 607 doesn't create the hard link to "python<version>" named "python" and
 608 it doesn't install the manual page at all.
 609
 610 Alpha/beta revision levels are stripped from the executable and
 611 library filenames during installation. For example, Python2.1a2 will
 612 install as python2.1, overwriting the previous python2.1. To avoid
 613 this, you could set the Makefile VERSION variable manually
 614 (e.g. VERSION=2.1a2) before running "make install" or "make altinstall".
 615
 616 The only thing you may have to install manually is the Python mode for
 617 Emacs found in Misc/python-mode.el.  (But then again, more recent
 618 versions of Emacs may already have it.)  Follow the instructions that
 619 came with Emacs for installation of site-specific files.
 620
 621
 622 Configuration options and variables
 623 -----------------------------------
 624
 625 Some special cases are handled by passing options to the configure
 626 script.
 627
 628 WARNING: if you rerun the configure script with different options, you
 629 must run "make clean" before rebuilding.  Exceptions to this rule:
 630 after changing --prefix or --exec-prefix, all you need to do is remove
 631 Modules/getpath.o.
 632
 633 --with(out)-gcc: The configure script uses gcc (the GNU C compiler) if
 634         it finds it.  If you don't want this, or if this compiler is
 635         installed but broken on your platform, pass the option
 636         --without-gcc.  You can also pass "CC=cc" (or whatever the
 637         name of the proper C compiler is) in the environment, but the
 638         advantage of using --without-gcc is that this option is
 639         remembered by the config.status script for its --recheck
 640         option.
 641
 642 --prefix, --exec-prefix: If you want to install the binaries and the
 643         Python library somewhere else than in /usr/local/{bin,lib},
 644         you can pass the option --prefix=DIRECTORY; the interpreter
 645         binary will be installed as DIRECTORY/bin/python and the
 646         library files as DIRECTORY/lib/python/*.  If you pass
 647         --exec-prefix=DIRECTORY (as well) this overrides the
 648         installation prefix for architecture-dependent files (like the
 649         interpreter binary).  Note that --prefix=DIRECTORY also
 650         affects the default module search path (sys.path), when
 651         Modules/config.c is compiled.  Passing make the option
 652         prefix=DIRECTORY (and/or exec_prefix=DIRECTORY) overrides the
 653         prefix set at configuration time; this may be more convenient
 654         than re-running the configure script if you change your mind
 655         about the install prefix.
 656
 657 --with-readline: This option is no longer supported.  To use GNU
 658         readline, enable module "readline" in the Modules/Setup file.
 659
 660 --with-threads: On most Unix systems, you can now use multiple
 661         threads, and support for this is enabled by default.  To
 662         disable this, pass --with-threads=no.  If the library required
 663         for threads lives in a peculiar place, you can use
 664         --with-thread=DIRECTORY.  IMPORTANT: run "make clean" after
 665         changing (either enabling or disabling) this option, or you
 666         will get link errors!  Note: for DEC Unix use
 667         --with-dec-threads instead.
 668
 669 --with-sgi-dl: On SGI IRIX 4, dynamic loading of extension modules is
 670         supported by the "dl" library by Jack Jansen, which is
 671         ftp'able from ftp://ftp.cwi.nl/pub/dynload/dl-1.6.tar.Z.
 672         This is enabled (after you've ftp'ed and compiled the dl
 673         library) by passing --with-sgi-dl=DIRECTORY where DIRECTORY
 674         is the absolute pathname of the dl library.  (Don't bother on
 675         IRIX 5, it already has dynamic linking using SunOS style
 676         shared libraries.)  Support for this feature is deprecated.
 677
 678 --with-dl-dld: Dynamic loading of modules is rumored to be supported
 679         on some other systems: VAX (Ultrix), Sun3 (SunOS 3.4), Sequent
 680         Symmetry (Dynix), and Atari ST.  This is done using a
 681         combination of the GNU dynamic loading package
 682         (ftp://ftp.cwi.nl/pub/dynload/dl-dld-1.1.tar.Z) and an
 683         emulation of the SGI dl library mentioned above (the emulation
 684         can be found at
 685         ftp://ftp.cwi.nl/pub/dynload/dld-3.2.3.tar.Z).  To
 686         enable this, ftp and compile both libraries, then call
 687         configure, passing it the option
 688         --with-dl-dld=DL_DIRECTORY,DLD_DIRECTORY where DL_DIRECTORY is
 689         the absolute pathname of the dl emulation library and
 690         DLD_DIRECTORY is the absolute pathname of the GNU dld library.
 691         (Don't bother on SunOS 4 or 5, they already have dynamic
 692         linking using shared libraries.)  Support for this feature is
 693         deprecated.
 694
 695 --with-libm, --with-libc: It is possible to specify alternative
 696         versions for the Math library (default -lm) and the C library
 697         (default the empty string) using the options
 698         --with-libm=STRING and --with-libc=STRING, respectively.  For
 699         example, if your system requires that you pass -lc_s to the C
 700         compiler to use the shared C library, you can pass
 701         --with-libc=-lc_s. These libraries are passed after all other
 702         libraries, the C library last.
 703
 704 --with-next-archs='arch1 arch2': Under NEXTSTEP, this will build
 705         all compiled binaries with the architectures listed.  This will
 706         also correctly set the target architecture-specific resource
 707         directory.  (This option is not supported on other platforms.)
 708
 709 --with-libs='libs': Add 'libs' to the LIBS that the python interpreter
 710         is linked against.
 711
 712 --with-cxx=<compiler>: Some C++ compilers require that main() is
 713         compiled with the C++ if there is any C++ code in the application.
 714         Specifically, g++ on a.out systems may require that to support
 715         construction of global objects. With this option, the main() function
 716         of Python will be compiled with <compiler>; use that only if you
 717         plan to use C++ extension modules, and if your compiler requires
 718         compilation of main() as a C++ program.
 719
 720
 721 --with-pydebug:  Enable additional debugging code to help track down
 722         memory management problems.  This allows printing a list of all
 723         live objects when the interpreter terminates.
 724
 725
 726 Building for multiple architectures (using the VPATH feature)
 727 -------------------------------------------------------------
 728
 729 If your file system is shared between multiple architectures, it
 730 usually is not necessary to make copies of the sources for each
 731 architecture you want to support.  If the make program supports the
 732 VPATH feature, you can create an empty build directory for each
 733 architecture, and in each directory run the configure script (on the
 734 appropriate machine with the appropriate options).  This creates the
 735 necessary subdirectories and the Makefiles therein.  The Makefiles
 736 contain a line VPATH=... which points to a directory containing the
 737 actual sources.  (On SGI systems, use "smake -J1" instead of "make" if
 738 you use VPATH -- don't try gnumake.)
 739
 740 For example, the following is all you need to build a minimal Python
 741 in /usr/tmp/python (assuming ~guido/src/python is the toplevel
 742 directory and you want to build in /usr/tmp/python):
 743
 744         $ mkdir /usr/tmp/python
 745         $ cd /usr/tmp/python
 746         $ ~guido/src/python/configure
 747         [...]
 748         $ make
 749         [...]
 750         $
 751
 752 Note that configure copies the original Setup file to the build
 753 directory if it finds no Setup file there.  This means that you can
 754 edit the Setup file for each architecture independently.  For this
 755 reason, subsequent changes to the original Setup file are not tracked
 756 automatically, as they might overwrite local changes.  To force a copy
 757 of a changed original Setup file, delete the target Setup file.  (The
 758 makesetup script supports multiple input files, so if you want to be
 759 fancy you can change the rules to create an empty Setup.local if it
 760 doesn't exist and run it with arguments $(srcdir)/Setup Setup.local;
 761 however this assumes that you only need to add modules.)
 762
 763
 764 Building on non-UNIX systems
 765 ----------------------------
 766
 767 For Windows (2000/NT/ME/98/95), assuming you have MS VC++ 6.0, the
 768 project files are in PCbuild, the workspace is pcbuild.dsw.  See
 769 PCbuild\readme.txt for detailed instructions.
 770
 771 For other non-Unix Windows compilers, in particular Windows 3.1 and
 772 for OS/2, enter the directory "PC" and read the file "readme.txt".
 773
 774 For the Mac, a separate source distribution will be made available,
 775 for use with the CodeWarrior compiler.  If you are interested in Mac
 776 development, join the PythonMac Special Interest Group
 777 (http://www.python.org/sigs/pythonmac-sig/, or send email to
 778 pythonmac-sig-request@python.org).
 779
 780 Of course, there are also binary distributions available for these
 781 platforms -- see http://www.python.org/.
 782
 783 To port Python to a new non-UNIX system, you will have to fake the
 784 effect of running the configure script manually (for Mac and PC, this
 785 has already been done for you).  A good start is to copy the file
 786 config.h.in to config.h and edit the latter to reflect the actual
 787 configuration of your system.  Most symbols must simply be defined as
 788 1 only if the corresponding feature is present and can be left alone
 789 otherwise; however the *_t type symbols must be defined as some variant
 790 of int if they need to be defined at all.
 791
 792
 793
 794 Miscellaneous issues
 795 ====================
 796
 797 Emacs mode
 798 ----------
 799
 800 There's an excellent Emacs editing mode for Python code; see the file
 801 Misc/python-mode.el.  Originally written by the famous Tim Peters, it
 802 is now maintained by the equally famous Barry Warsaw (it's no
 803 coincidence that they now both work on the same team).  The latest
 804 version, along with various other contributed Python-related Emacs
 805 goodies, is online at http://www.python.org/emacs/python-mode.  And
 806 if you are planning to edit the Python C code, please pick up the
 807 latest version of CC Mode http://www.python.org/emacs/cc-mode; it
 808 contains a "python" style used throughout most of the Python C source
 809 files.  (Newer versions of Emacs or XEmacs may already come with the
 810 latest version of python-mode.)
 811
 812
 813 The Tk interface
 814 ----------------
 815
 816 Tk (the user interface component of John Ousterhout's Tcl language) is
 817 also usable from Python.  Since this requires that you first build and
 818 install Tcl/Tk, the Tk interface is not enabled by default when
 819 building Python from source.  Python supports Tcl/Tk version 8.0 and
 820 higher.
 821
 822 See http://dev.ajubasolutions.com/ for more info on Tcl/Tk, including
 823 the on-line manual pages.
 824
 825
 826 To enable the Python/Tk interface, once you've built and installed
 827 Tcl/Tk, load the file Modules/Setup into your favorite text editor and
 828 search for the string "_tkinter".  Then follow the instructions found
 829 there.  If you have installed Tcl/Tk or X11 in unusual places, you
 830 will have to edit the first line to fix or add the -I and -L options.
 831 (Also see the general instructions at the top of that file.)
 832
 833 For more Tkinter information, see the Tkinter Resource page:
 834 http://www.python.org/topics/tkinter/
 835
 836 There are demos in the Demo/tkinter directory, in the subdirectories
 837 guido, matt and www (the matt and guido subdirectories have been
 838 overhauled to use more recent Tkinter coding conventions).
 839
 840 Note that there's a Python module called "Tkinter" (capital T) which
 841 lives in Lib/lib-tk/Tkinter.py, and a C module called "_tkinter"
 842 (lower case t and leading underscore) which lives in
 843 Modules/_tkinter.c.  Demos and normal Tk applications import only the
 844 Python Tkinter module -- the latter uses the C _tkinter module
 845 directly.  In order to find the C _tkinter module, it must be compiled
 846 and linked into the Python interpreter -- the _tkinter line in the
 847 Setup file does this.  In order to find the Python Tkinter module,
 848 sys.path must be set correctly -- the TKPATH assignment in the Setup
 849 file takes care of this, but only if you install Python properly
 850 ("make install libinstall").  (You can also use dynamic loading for
 851 the C _tkinter module, in which case you must manually fix up sys.path
 852 or set $PYTHONPATH for the Python Tkinter module.)
 853
 854
 855 Distribution structure
 856 ----------------------
 857
 858 Most subdirectories have their own README files.  Most files have
 859 comments.
 860
 861 .cvsignore      Additional filename matching patterns for CVS to ignore
 862 BeOS/           Files specific to the BeOS port
 863 Demo/           Demonstration scripts, modules and programs
 864 Doc/            Documentation sources (LaTeX)
 865 Grammar/        Input for the parser generator
 866 Include/        Public header files
 867 LICENSE         Licensing information
 868 Lib/            Python library modules
 869 Makefile.pre.in Source from which config.status creates the Makefile.pre
 870 Misc/           Miscellaneous useful files
 871 Modules/        Implementation of most built-in modules
 872 Objects/        Implementation of most built-in object types
 873 PC/             Files specific to PC ports (DOS, Windows, OS/2)
 874 PCbuild/        Build directory for Microsoft Visual C++
 875 Parser/         The parser and tokenizer and their input handling
 876 Python/         The byte-compiler and interpreter
 877 README          The file you're reading now
 878 Tools/          Some useful programs written in Python
 879 acconfig.h      Additional input for the GNU autoheader program
 880 config.h.in     Source from which config.h is created (GNU autoheader output)
 881 configure       Configuration shell script (GNU autoconf output)
 882 configure.in    Configuration specification (input for GNU autoconf)
 883 install-sh      Shell script used to install files
 884
 885 The following files will (may) be created in the toplevel directory by
 886 the configuration and build processes:
 887
 888 Makefile        Build rules
 889 Makefile.pre    Build rules before running Modules/makesetup
 890 buildno         Keeps track of the build number
 891 config.cache    Cache of configuration variables
 892 config.h        Configuration header
 893 config.log      Log from last configure run
 894 config.status   Status from last run of the configure script
 895 getbuildinfo.o  Object file from Modules/getbuildinfo.c
 896 libpython<version>.a    The library archive
 897 python          The executable interpreter
 898 tags, TAGS      Tags files for vi and Emacs
 899
 900
 901 That's all, folks!
 902 ------------------
 903
 904
 905 --Guido van Rossum (home page: http://www.python.org/~guido/)