home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / pyth_os2.zip / python-1.0.2 / README < prev    next >
Text File  |  1994-05-04  |  19KB  |  414 lines
  1. Python release 1.0.2
  2. ====================
  3.  
  4. ==> This is patch number 2 to Python 1.0, bumping its version string
  5.    to 1.0.2.  It consists mostly of portability fixes.  See the file
  6.    Misc/NEWS for a description of what's new in this patch (as well as
  7.    what's new in 1.0).
  8.  
  9. ==> Python 1.0 is the first "official" Python release in more than
  10.     half a year.  It's significantly improved over version 0.9.9, both
  11.     at the functionality level and (especially) in portability of the
  12.     source -- you should now be able to configure build this without
  13.     manual intervention on almost any type of Unix system.  It is
  14.     known to work at least on IRIX 4 and 5, SunOS 4, Solaris 2, HP-UX,
  15.     Ultrix, OSF/1, AIX, SCO ODT 3.0, Minix, Linux, SEQUENT, and
  16.     through the use of automatic feature detection should work on most
  17.     other Unix flavors as well.  Binaries are available for Macintosh
  18.     and PC platforms (for DOS, DOS w/ 32-bit extender, Windows, and
  19.     Windows NT).
  20.  
  21. ==> If you don't know yet what Python is: it's an interpreted,
  22.     extensible, embeddable, interactive, object-oriented programming
  23.     language.  For a quick summary of what Python can mean for a
  24.     UNIX/C programmer, read Misc/BLURB.LUTZ.
  25.  
  26. ==> If you want to start compiling right away: just type "./configure"
  27.     in the current directory and when it finishes, type "make".  See
  28.     the section Build Instructions below for more details.
  29.  
  30. ==> All documentation is in the subdirectory Doc in the form of LaTeX
  31.     files.  In order of importance for new users: Tutorial (tut),
  32.     Library Reference (lib), Language Reference (ref), Extending
  33.     (ext).  Note that especially the Library Reference is of immense
  34.     value since much of Python's power (including the built-in data
  35.     types and functions!) is described there.  [XXX The ext document
  36.     has not been updated to reflect this release yet.]
  37.  
  38. ==> Python is COPYRIGHTED but free to use for all.  See the copyright
  39.     notice at the end of this file.
  40.  
  41.  
  42. Build instructions
  43. ------------------
  44.  
  45. Before you start building Python, you must first configure it.  This
  46. entails (at least) running the script "./configure", which figures out
  47. your system configuration and creates several Makefiles.  (This will
  48. take a minute or two -- please be patient!)  When it is done, you are
  49. ready to run make.  Typing "make" in the toplevel directory will
  50. recursively run make in each of the subdirectories Parser, Objects,
  51. Python and Modules, creating a library file in each one.  The
  52. executable of the interpreter is built in the Modules subdirectory but
  53. moved up here when it is built.  If you want or need to, you can also
  54. chdir into each subdirectory in turn and run make there manually
  55. (do the Modules subdirectory last!).  If you run into trouble, first
  56. see the section Troubleshooting later in this file.
  57.  
  58. EXCEPTIONS: on SVR4 derived systems, you need to pass the configure
  59. script the option --with-svr4.  See below for more options you can
  60. pass to the configure script.
  61.  
  62. AIX users: read the file Misc/AIX-NOTES before trying to build.
  63.  
  64. Minix users: when using ack, use "CC=cc AR=aal RANLIB=: ./configure"!
  65.  
  66. You can configure the interpreter to contain fewer or more built-in
  67. modules by editing the file Modules/Setup.  This file is initially
  68. copied (when the toplevel Makefile makes Modules/Makefile for the
  69. first time) from Setup.in; if it does not exist yet, make a copy
  70. yourself.  Never edit Setup.in -- always edit Setup.  Read the
  71. comments in the file for information on what kind of edits you can
  72. make.  When you have edited Setup, Makefile and config.c in Modules
  73. will automatically be rebuilt the next time you run make in the
  74. toplevel directory.  (There are some example Setup files which you may
  75. copy to Setup for specific systems; have a look at Setup.*.)
  76.  
  77. If you want to change the optimization level of the build, assign to
  78. the OPT variable on the toplevel make command; e.g. "make OPT=-g" will
  79. build a debugging version of Python on most platforms.
  80.  
  81. To test the interpreter that you have just built, type "make test".
  82. This runs the test set silently, twice (once with no compiled files,
  83. once with the compiled files left by the previous test run).  Each
  84. test run should print "All tests OK." and nothing more.  (The test set
  85. does not test the built-in modules, but will find most other problems
  86. with the interpreter.)
  87.  
  88. To install the interpreter as /usr/local/bin/python, type "make
  89. install".  To install the library as /usr/local/lib/python, type "make
  90. libinstall".  To install the manual page as
  91. /usr/local/man/man1/python.1, type "make maninstall".  To install the
  92. Emacs editing mode for python, manually copy the file
  93. Misc/python-mode.el to your local Emacs lisp directory.  The directory
  94. /usr/local can be overridden at configuration time by passing
  95. --prefix=DIRECTORY to the configure script, or at make time by passing
  96. "prefix=DIRECTORY" to make.  See below for more information on --prefix.
  97.  
  98. If you plan to do development of extension modules or to embed Python
  99. in another application and don't want to reference the original source
  100. tree, you can type "make inclinstall" and "make libainstall" to
  101. install the include files and lib*.a files, respectively, as
  102. /usr/local/include/Py/*.h and /usr/local/lib/python/lib/lib*.a.  The
  103. make libainstall target also installs copies of several other files
  104. used or produced during the build process which are needed to build
  105. extensions or to generate their Makefiles.
  106.  
  107. To print the documentation, cd into the Doc subdirectory, type "make"
  108. (let's hope you have LaTeX installed!), and send the four resulting
  109. PostScript files (tut.ps, lib.ps, ref.ps, and ext.ps) to the printer.
  110. See the README file there; you can also build a texinfo version of the
  111. library manual and from that construct an Emacs info version (the
  112. hypertext format used by the Emacs "info" command) and an HTML version
  113. (the hypertext format used by the World Wide Web distributed
  114. information initiative).  You don't need to have LaTeX installed for
  115. this.  Note that the Python archive sites also carry the resulting
  116. PostScript files, in case you have a PostScript printer but not LaTeX.
  117.  
  118. Some special cases are handled by passing environment variables or
  119. options to the configure script:
  120.  
  121. - The configure script uses gcc (the GNU C compiler) if it finds it.
  122. If you don't want this, or if this compiler is installed but broken on
  123. your platform, pass "CC=cc" (or whatever the name of the proper C
  124. compiler is) in the environment.
  125.  
  126. - On System V, Release 4 derived systems (e.g. SOLARIS 2, but not
  127. IRIX 5) you need to call the configure script with the option
  128. --with-svr4.  This is needed so the libraries -lnsl and -lsocket are
  129. found.  (On some other systems, e.g. IRIX 5, these libraries exist but
  130. are incompatible with other system libraries such as X11 and GL.)
  131.  
  132. - If you want to install the binaries and the Python library somewhere
  133. else than in /usr/local/{bin,lib}, you can pass the option
  134. --prefix=DIRECTORY; the interpreter binary will be installed as
  135. DIRECTORY/bin/python and the library files as DIRECTORY/lib/python/*.
  136. If you pass --exec-prefix=DIRECTORY (as well) this overrides the
  137. installation prefix for architecture-dependent files (like the
  138. interpreter binary).  Note that --prefix=DIRECTORY also affects the
  139. default module search path (sys.path), when Modules/config.c is
  140. compiled.  Passing make the option prefix=DIRECTORY (and/or
  141. exec_prefix=DIRECTORY) overrides the prefix set at configuration time;
  142. this may be more convenient than re-running the configure script if
  143. you change your mind about the install prefix...
  144.  
  145. - You can use the GNU readline library to improve the interactive
  146. user interface: this gives you line editing and command history when
  147. calling python interactively.  You need to build the GNU readline
  148. library before running the configure script.  Its sources are
  149. distributed with Python.  This may involve some editing of the
  150. Makefile there -- I'm sorry, but I don't feel responsible for making
  151. it more portable or adapting it to autoconf...  Pass the configure
  152. script the option --with-readline=DIRECTORY where DIRECTORY is the
  153. absolute pathname of the directory where you've built the readline
  154. library.  A known problem with the readline library is that it
  155. contains entry points which cause conflicts with the STDWIN and SGI GL
  156. libraries.  The stdwin conflict can be solved (and will be, in some
  157. future release of stdwin) by adding a line saying '#define werase
  158. w_erase' to the stdwin.h file (in the stdwin distribution,
  159. subdirectory H).  The GL conflict may be solvable by reordering the -l
  160. options on the final link command, but it appears unsafe...  Another
  161. hint: you may have to add -Dindex=strchr -Drindex=strrchr to
  162. readline's CFLAGS if your system doesn't have index and rindex.
  163.  
  164. - On SGI IRIX, and on Sun SOLARIS 2, you can use multiple threads.  To
  165. enable this, pass --with-thread.  In the Modules/Setup file, enable
  166. the thread module.  (Threads aren't enabled automatically because
  167. there are run-time penalties when support for them is compiled in even
  168. if you don't use them.)
  169.  
  170. - On SGI IRIX, there are modules that interface to many SGI specific
  171. system libraries, e.g. the GL library and the audio hardware.  To
  172. enable these modules, you must edit the Modules/Setup file (or copy the
  173. Setup.irix4 file to it).
  174.  
  175. - On SGI IRIX 4, dynamic loading of extension modules is supported by
  176. the "dl" library by Jack Jansen, which is ftp'able from
  177. ftp://ftp.cwi.nl/pub/dynload/dl-1.6.tar.Z.  This is enabled (after
  178. you've ftp'ed and compiled the dl library!) by passing
  179. --with-sgi-dl=DIRECTORY where DIRECTORY is the absolute pathname of
  180. the dl library.  (Don't bother on IRIX 5, it already has dynamic
  181. linking using SunOS style shared libraries.)
  182.  
  183. - Dynamic loading of modules is rumoured to be supported on some other
  184. systems: VAX (Ultrix), Sun3 (SunOS 3.4), Sequent Symmetry (Dynix), and
  185. Atari ST.  This is done using a combination of the GNU dynamic loading
  186. package (ftp://ftp.cwi.nl/pub/dynload/dl-dld-1.1.tar.Z) and an
  187. emulation of the SGI dl library mentioned above (the emulation can be
  188. found at ftp://ftp.cwi.nl/pub/dynload/dld-3.2.3.tar.Z).  To enable
  189. this, ftp and compile both libraries, then call the configure passing
  190. it the option --with-dl-dld=DL_DIRECTORY,DLD_DIRECTORY where
  191. DL_DIRECTORY is the absolute pathname of the dl emulation library and
  192. DLD_DIRECTORY is the absolute pathname of the GNU dld library.  (Don't
  193. bother on SunOS 4 or 5, they already have dynamic linking using shared
  194. libraries.)
  195.  
  196. - It is possible to specify alternative versions for the Math library
  197. (default -lm) and the C library (default the empty string) using the
  198. options --with-libm=STRING and --with-libc=STRING, respectively.  E.g.
  199. if your system requires that you pass -lc_s to the C compiler to use
  200. the shared C library, you can pass --with-libc=-lc_s.  These libraries
  201. are passed after all other libraries, the C library last.
  202.  
  203. You can also build an "extended" interpreter, using modules that are
  204. not contained in the Modules directory.  Extensions are distributed as
  205. a separate tar file (currently extensions.tar.Z).  See the README file
  206. there.
  207.  
  208.  
  209. Building for multiple architectures (using the VPATH feature)
  210. -------------------------------------------------------------
  211.  
  212. If your file system is shared between multiple architectures, it
  213. usually is not necessary to make copies of the sources for each
  214. architecture you want to support.  If the make program supports the
  215. VPATH feature, you can create an empty build directory for each
  216. architecture, and in each directory run the configure script (on the
  217. appropriate machine with the appropriate options).  This creates the
  218. necessary subdirectories and the Makefiles therein.  The Makefiles
  219. contain a line VPATH=... which points to directory containing the
  220. actual sources.
  221.  
  222. For example, the following is all you need to build a minimal Python
  223. in /usr/tmp/python (assuming ~guido/src/python is the toplevel
  224. directory and you want to build in /usr/tmp/python):
  225.  
  226.     $ mkdir /usr/tmp/python
  227.     $ cd /usr/tmp/python
  228.     $ ~guido/src/python/configure
  229.     [...]
  230.     $ make
  231.     [...]
  232.     $
  233.  
  234. To use the readline library in this case, you will have to create a
  235. subdirectory of your build directory called readline, copy
  236. readline/Makefile into it, edit the Makefile to contain a proper VPATH
  237. line (and possibly edit the compiler flags set in the Makefile), and
  238. pass the configure script a --with-readline=DIRECTORY option giving it
  239. the absolute (!) pathname of the readline build directory.
  240.  
  241. Note that Modules/Makefile copies the original Setup file to the build
  242. directory if it finds no Setup file there.  This means that you can
  243. edit the Setup file for each architecture independently.  For this
  244. reason, subsequent changes to the original Setup file are not tracked
  245. automatically, as they might overwrite local changes.  To force a copy
  246. of a changed original Setup file, delete the target Setup file.  (The
  247. makesetup script supports multiple input files, so if you want to be
  248. fancy you can change the rules to create an empty Setup.local if it
  249. doesn't exist and run it with arguments $(srcdir)/Setup Setup.local;
  250. however this assumes that you only need to add modules.)
  251.  
  252.  
  253. Troubleshooting
  254. ---------------
  255.  
  256. Here is a selection from the FAQ on various common problems.
  257.  
  258. 3.6. Q. Link errors building Python with STDWIN on SGI IRIX.
  259.  
  260. A. Rebuild STDWIN, specifying "CC=cc -cckr" in the Makefile.
  261.  
  262. 3.8. Q. Link errors after rerunning the configure script.
  263.  
  264. A. It is generally necessary to run "make clean" after a configuration
  265. change.
  266.  
  267. 3.9. Q. The python interpreter complains about options passed to a
  268. script (after the script name).
  269.  
  270. A. You are probably linking with GNU getopt, e.g. through -liberty.
  271. Don't.  (If you are using this because you link with -lreadline, use
  272. the readline distributed with Python instead.)
  273.  
  274. 3.10. Q. When building on the SGI, make tries to run python to create
  275. glmodule.c, but python hasn't been built or installed yet.
  276.  
  277. A. Comment out the line mentioning glmodule.c in Setup and build a
  278. python without gl first; install it or make sure it is in your $PATH,
  279. then edit the Setup file again to turn on the gl module, and make
  280. again.  You don't need to do "make clean"; you do need to run "make
  281. Makefile" in the Modules subdirectory (or just run "make" at the
  282. toplevel).
  283.  
  284. 3.13. Q. Other trouble building Python 1.0.2 on platform X.
  285.  
  286. A. Please email the details to <guido@cwi.nl> and I'll look into it.
  287.  
  288.  
  289. Building on non-UNIX systems
  290. ----------------------------
  291.  
  292. On non-UNIX systems, you will have to fake the effect of running the
  293. configure script manually.  A good start is to copy the file
  294. config.h.in to config.h and edit the latter to reflect the actual
  295. configuration of your system.  Most symbols must simply be defined as
  296. 1 only if the corresponding feature is present and can be left alone
  297. otherwise; however RETSIGTYPE must always be defined, either as int or
  298. as void, and the *_t type symbols must be defined as some variant of
  299. int if they need to be defined at all. Then arrange that the symbol
  300. HAVE_CONFIG_H is defined during compilation (usually by passing an
  301. argument of the form `-DHAVE_CONFIG_H' to the compiler, but this is
  302. necessarily system-dependent).
  303.  
  304.  
  305. Distribution structure
  306. ----------------------
  307.  
  308. Most subdirectories have their own README file.  Most files have
  309. comments.
  310.  
  311. ChangeLog    A raw list of changes since the first 1.0.0 BETA release
  312. Contrib/    Contributed code
  313. Demo/        Demonstration scripts, modules and programs
  314. Demo2/        Some more demonstrations (not distributed)
  315. Doc/        Documentation (in LaTeX)
  316. Ext-dummy/    Placeholder for Extensions in the distribution
  317. Extensions/    Extension modules (not distributed)
  318. Grammar/    Input for the parser generator
  319. Include/    Public header files
  320. Lib/        Python library modules
  321. Makefile    Rules for building the distribution
  322. Misc/        Miscellaneous files
  323. Modules/    Implementation of most built-in modules
  324. Objects/    Implementation of most built-in object types
  325. Parser/        The parser and tokenizer and their input handling
  326. Python/        The "compiler" and interpreter
  327. README        The file you're reading now
  328. acconfig.h    Additional input for the autoheader program
  329. config.h    Configuration header (generated)
  330. config.h.in    Source from which config.status creates config.h
  331. config.status    status from last run of configure script (generated)
  332. configure    Configuration shell script (GNU autoconf output)
  333. configure.in    Configuration specification (GNU autoconf input)
  334. tags, TAGS    Tags files for vi and Emacs (generated)
  335. python        The executable interpreter (generated)
  336. readline/    Source code for the GNU readline library
  337.  
  338.  
  339. Ftp access
  340. ----------
  341.  
  342. The latest Python source distribution can be ftp'ed from site
  343. ftp.cwi.nl (IP address 192.16.184.180), directory /pub/python, file
  344. python<version>.tar.Z.  Curerntly <version> is 1.0.2.  You can also
  345. find PostScript of the main Python documentation there, Macintosh and
  346. PC binaries, and the latest STDWIN source distribution (in directory
  347. /pub/stdwin).  Mirror sites are gatekeeper.dec.com
  348. (/pub/plan/python/cwi), ftp.wustl.edu
  349. (/graphics/graphics/sgi-stuff/python) and ftp.uu.net
  350. (/languages/python) -- try these sites first if you are on the US
  351. continent, or at least closer to it than to Europe.  These mirror
  352. sites are at most a day behind on the European archive!
  353.  
  354. If you don't have ftp access, send mail containing only the word HELP
  355. to ftpmail@decwrl.dec.com or bitftp@pucc.princeton.edu, and the
  356. server will send you instructions on how to make requests.
  357.  
  358.  
  359. Mailing list
  360. ------------
  361.  
  362. There is a mailing list devoted to Python programming, design and
  363. bugs.  To subscribe, send mail containing your real name and e-mail
  364. address in Internet form to "python-list-request@cwi.nl".  If you have
  365. built and installed Python, you are urgently to subscribe to this
  366. mailing list.
  367.  
  368.  
  369. Author
  370. ------
  371.  
  372. Guido van Rossum
  373. CWI, dept. CST
  374. P.O. Box 94079
  375. 1090 GB  Amsterdam
  376. The Netherlands
  377.  
  378. E-mail: Guido.van.Rossum@cwi.nl
  379.  
  380.  
  381. Copyright Notice
  382. ----------------
  383.  
  384. The Python source is copyrighted, but you can freely use and copy it
  385. as long as you don't change or remove the copyright:
  386.  
  387. Copyright 1991, 1992, 1993, 1994 by Stichting Mathematisch Centrum,
  388. Amsterdam, The Netherlands.
  389.  
  390.                         All Rights Reserved
  391.  
  392. Permission to use, copy, modify, and distribute this software and its 
  393. documentation for any purpose and without fee is hereby granted, 
  394. provided that the above copyright notice appear in all copies and that
  395. both that copyright notice and this permission notice appear in 
  396. supporting documentation, and that the names of Stichting Mathematisch
  397. Centrum or CWI not be used in advertising or publicity pertaining to
  398. distribution of the software without specific, written prior permission.
  399.  
  400. STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
  401. THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
  402. FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
  403. FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  404. WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  405. ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
  406. OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  407.  
  408.  
  409. Signature
  410. ---------
  411.  
  412. --Guido van Rossum, CWI, Amsterdam <Guido.van.Rossum@cwi.nl>
  413. URL:  <http://www.cwi.nl/cwi/people/Guido.van.Rossum.html>
  414.