home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 15 / AACD15.ISO / AACD / Programming / Python2 / Python20_source / README < prev    next >
Encoding:
Text File  |  2000-10-25  |  35.1 KB  |  839 lines

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