annotate README @ 3720:b341def4eef8 legacy-trunk

Ignore latex intermediate products.
author Guido van Rossum <guido@python.org>
date Wed, 26 Jun 1996 19:30:01 +0000
parents 97b1c2a70eae
children f9907f57327e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3698
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
1 This is Python release 1.4 beta 1
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
2 =================================
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
3
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
4 It's a beta release. Only use this if you want to help me iron the
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
5 last wrinkles out of the distribution before I release the real 1.4
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
6 release. In particular, I'm interested in porting experiences to Unix
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
7 boxes. It should build out of the box using "./configure; make".
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
8 Also try running configue with the --with-thread and --with-readline
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
9 options (described below).
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
10
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
11
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
12 What's new in this release?
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
13 ---------------------------
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
14
3698
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
15 XXX
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
16
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
17
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
18 What is Python anyway?
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
19 ----------------------
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
20
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
21 Python is an interpreted object-oriented programming language, and is
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
22 often compared to Tcl, Perl or Scheme. For a quick summary of what
3698
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
23 Python can mean for a UNIX/C programmer, read Misc/BLURB.LUTZ. If you
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
24 have web access, point your browser to <URL:http://www.python.org>.
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
25
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
26
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
27 If you don't read instructions
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
28 ------------------------------
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
29
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
30 Congratulations on getting this far. :-)
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
31
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
32 To start building right away (on UNIX): type "./configure" in the
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
33 current directory and when it finishes, type "make". The section
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
34 Build Instructions below is still recommended reading. :-)
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
35
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
36
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
37 Copyright issues
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
38 ----------------
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
39
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
40 Python is COPYRIGHTED but free to use for all. See the full copyright
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
41 notice at the end of this file.
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
42
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
43 The Python distribution is *not* affected by the GNU Public Licence
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
44 (GPL). There are interfaces to some GNU code but these are entirely
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
45 optional and no GNU code is distributed with Python. For all these
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
46 packages, GPL-free public domain versions also exist.
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
47
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
48
3110
5c0a7f7836fb added psa plug
Guido van Rossum <guido@python.org>
parents: 3008
diff changeset
49 A modest plug
5c0a7f7836fb added psa plug
Guido van Rossum <guido@python.org>
parents: 3008
diff changeset
50 =============
5c0a7f7836fb added psa plug
Guido van Rossum <guido@python.org>
parents: 3008
diff changeset
51
5c0a7f7836fb added psa plug
Guido van Rossum <guido@python.org>
parents: 3008
diff changeset
52
3174
f7789945b8de release 1.3 for real
Guido van Rossum <guido@python.org>
parents: 3110
diff changeset
53 *************************************************************************
f7789945b8de release 1.3 for real
Guido van Rossum <guido@python.org>
parents: 3110
diff changeset
54 * *
f7789945b8de release 1.3 for real
Guido van Rossum <guido@python.org>
parents: 3110
diff changeset
55 * Python exists, and is free, thanks to the contributed efforts *
f7789945b8de release 1.3 for real
Guido van Rossum <guido@python.org>
parents: 3110
diff changeset
56 * of many people. The PSA was created to maximize the results *
f7789945b8de release 1.3 for real
Guido van Rossum <guido@python.org>
parents: 3110
diff changeset
57 * of those efforts, by helping to coordinate them. The PSA *
f7789945b8de release 1.3 for real
Guido van Rossum <guido@python.org>
parents: 3110
diff changeset
58 * operates web, ftp and email servers, organizes Python *
f7789945b8de release 1.3 for real
Guido van Rossum <guido@python.org>
parents: 3110
diff changeset
59 * workshops, and engages in other activities that benefit the *
f7789945b8de release 1.3 for real
Guido van Rossum <guido@python.org>
parents: 3110
diff changeset
60 * Python user community. The PSA is seeking support for these *
f7789945b8de release 1.3 for real
Guido van Rossum <guido@python.org>
parents: 3110
diff changeset
61 * activities. See this URL for information on how to join: *
f7789945b8de release 1.3 for real
Guido van Rossum <guido@python.org>
parents: 3110
diff changeset
62 * http://www.python.org/psa/Joining.html *
f7789945b8de release 1.3 for real
Guido van Rossum <guido@python.org>
parents: 3110
diff changeset
63 * *
f7789945b8de release 1.3 for real
Guido van Rossum <guido@python.org>
parents: 3110
diff changeset
64 *************************************************************************
3110
5c0a7f7836fb added psa plug
Guido van Rossum <guido@python.org>
parents: 3008
diff changeset
65
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
66
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
67 Build instructions
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
68 ==================
1453
d773a5f89426 New files
Guido van Rossum <guido@python.org>
parents:
diff changeset
69
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
70 Before you start building Python, you must first configure it. This
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
71 entails (at least) running the script "./configure", which figures out
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
72 your system configuration and creates several Makefiles. (It takes a
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
73 minute or two -- please be patient!) When it's done, you are ready to
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
74 run make. Typing "make" in the toplevel directory will recursively
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
75 run make in each of the subdirectories Parser, Objects, Python and
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
76 Modules, creating a library file in each one. The executable of the
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
77 interpreter is built in the Modules subdirectory and moved up here
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
78 when it is built. If you want or need to, you can also chdir into
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
79 each subdirectory in turn and run make there manually (do the Modules
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
80 subdirectory last!).
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
81
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
82 NOTE: if you rerun the configure script with different options, remove
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
83 all object files by running "make clean" before rebuilding. Believe
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
84 it or not, "make clean" sometimes helps to clean up other inexplicable
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
85 problems as well. Try it before sending in a bug report!
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
86
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
87
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
88 Troubleshooting
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
89 ---------------
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
90
3698
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
91 If recursive makes fail, try invoking make as "make MAKE=make".
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
92
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
93 If you run into other trouble, see section 3 of the FAQ (file
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
94 Misc/FAQ) for hints on what can go wrong, and how to fix it.
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
95
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
96
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
97 Platform specific notes
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
98 -----------------------
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
99
3174
f7789945b8de release 1.3 for real
Guido van Rossum <guido@python.org>
parents: 3110
diff changeset
100 (Some of these may no longer apply. If you find you can build Python
f7789945b8de release 1.3 for real
Guido van Rossum <guido@python.org>
parents: 3110
diff changeset
101 on these platforms without the special directions mentioned here, let
f7789945b8de release 1.3 for real
Guido van Rossum <guido@python.org>
parents: 3110
diff changeset
102 me know so I can remove them!)
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
103
3399
02435fd95277 Added ref to Misc/NEWS file; added hint to run regen script on Linux.
Guido van Rossum <guido@python.org>
parents: 3233
diff changeset
104 Linux: Once you've built Python, use it to run the regen.py script in
02435fd95277 Added ref to Misc/NEWS file; added hint to run regen script on Linux.
Guido van Rossum <guido@python.org>
parents: 3233
diff changeset
105 the Lib/linux1 directory. Apparently the files as distributed
02435fd95277 Added ref to Misc/NEWS file; added hint to run regen script on Linux.
Guido van Rossum <guido@python.org>
parents: 3233
diff changeset
106 don't match the system headers on some Linux versions.
02435fd95277 Added ref to Misc/NEWS file; added hint to run regen script on Linux.
Guido van Rossum <guido@python.org>
parents: 3233
diff changeset
107
3698
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
108 AIX: Read the files Misc/AIX-NOTES* before trying to build.
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
109
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
110 HP-UX: Read the file Misc/HPUX-NOTES if you want to be able to
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
111 use shared libraries for dynamically loaded modules.
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
112
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
113 Minix: When using ack, use "CC=cc AR=aal RANLIB=: ./configure"!
1882
f84b64df09c3 The usual junk
Guido van Rossum <guido@python.org>
parents: 1819
diff changeset
114
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
115 SCO: 1) Everything works much better if you add -U__STDC__ to the
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
116 defs. This is because all the SCO header files are broken.
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
117 Anything that isn't mentioned in the C standard it's
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
118 conditionally excluded when __STDC__ is defined.
1453
d773a5f89426 New files
Guido van Rossum <guido@python.org>
parents:
diff changeset
119
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
120 2) Due to the U.S. export restrictions, SCO broke the crypt
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
121 stuff out into a separate library, libcrypt_i.a so the LIBS
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
122 needed be set to:
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
123
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
124 LIBS=' -lsocket -lcrypt_i'
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
125
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
126
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
127 Configuring the set of built-in modules
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
128 ---------------------------------------
2162
c9aea34ae4b6 add hint for NeXT users
Guido van Rossum <guido@python.org>
parents: 2131
diff changeset
129
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
130 You can configure the interpreter to contain fewer or more built-in
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
131 modules by editing the file Modules/Setup. This file is initially
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
132 copied (when the toplevel Makefile makes Modules/Makefile for the
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
133 first time) from Setup.in; if it does not exist yet, make a copy
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
134 yourself. Never edit Setup.in -- always edit Setup. Read the
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
135 comments in the file for information on what kind of edits you can
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
136 make. When you have edited Setup, Makefile and config.c in Modules
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
137 will automatically be rebuilt the next time you run make in the
1994
fb198e1316b9 the usual
Guido van Rossum <guido@python.org>
parents: 1973
diff changeset
138 toplevel directory.
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
139
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
140 Especially on SGI IRIX, there are modules that interface to many SGI
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
141 specific system libraries, e.g. the GL library and the audio hardware.
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
142
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
143
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
144 Setting the optimization/debugging options
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
145 ------------------------------------------
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
146
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
147 If you want to change the optimization/debugging options for the C
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
148 compiler, assign to the OPT variable on the toplevel make command;
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
149 e.g. "make OPT=-g" will build a debugging version of Python on most
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
150 platforms. The default is OPT=-O; a value for OPT in the environment
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
151 when the configure script is run overrides this default (likewise for
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
152 CC; and the initial value for LIBS is used as the base set of
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
153 libraries to link with).
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
154
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
155
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
156 Testing
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
157 -------
1453
d773a5f89426 New files
Guido van Rossum <guido@python.org>
parents:
diff changeset
158
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
159 To test the interpreter that you have just built, type "make test".
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
160 This runs the test set silently, twice (once with no compiled files,
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
161 once with the compiled files left by the previous test run). Each
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
162 test run should print "All tests OK." and nothing more. (The test set
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
163 does not test the built-in modules, but will find most other problems
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
164 with the interpreter.)
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
165
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
166 IMPORTANT: If the tests fail and you decide to mail a bug report,
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
167 *don't* include the output of "make test". It is useless. Run the
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
168 following command instead:
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
169
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
170 PYTHONPATH=../Lib:../Lib/test:./Modules ./python -c 'import testall'
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
171
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
172 (substituting the top of the source tree for .. if you built in a
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
173 different directory). This gives the output of the tests and shows
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
174 which test failed.
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
175
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
176
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
177 Installing
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
178 ----------
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
179
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
180 To install the interpreter as /usr/local/bin/python, type "make
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
181 install". To install the library as /usr/local/lib/python, type "make
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
182 libinstall". To install the manual page as
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
183 /usr/local/man/man1/python.1, type "make maninstall". To install the
3698
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
184 Emacs editing mode for Python, manually copy the file
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
185 Misc/python-mode.el to your local Emacs lisp directory. The directory
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
186 /usr/local can be overridden at configuration time by passing
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
187 --prefix=DIRECTORY to the configure script, or at make time by passing
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
188 "prefix=DIRECTORY" to make. See below for more information on --prefix.
1453
d773a5f89426 New files
Guido van Rossum <guido@python.org>
parents:
diff changeset
189
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
190 If you plan to do development of extension modules or to embed Python
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
191 in another application and don't want to reference the original source
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
192 tree, you can type "make inclinstall" and "make libainstall" to
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
193 install the include files and lib*.a files, respectively, as
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
194 /usr/local/include/Py/*.h and /usr/local/lib/python/lib/lib*.a. The
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
195 make libainstall target also installs copies of several other files
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
196 used or produced during the build process which are needed to build
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
197 extensions or to generate their Makefiles.
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
198
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
199
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
200 Configuration options and variables
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
201 -----------------------------------
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
202
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
203 Some special cases are handled by passing environment variables or
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
204 options to the configure script.
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
205
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
206 NOTE: if you rerun the configure script with different options, remove
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
207 all object files by running "make clean" before rebuilding.
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
208
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
209 --with(out)-gcc: The configure script uses gcc (the GNU C compiler) if
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
210 it finds it. If you don't want this, or if this compiler is
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
211 installed but broken on your platform, pass the option
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
212 --without-gcc. You can also pass "CC=cc" (or whatever the
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
213 name of the proper C compiler is) in the environment, but the
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
214 advantage of using --without-gcc is that this option is
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
215 remembered by the config.status script for its --recheck
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
216 option.
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
217
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
218 --prefix, --exec-prefix: If you want to install the binaries and the
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
219 Python library somewhere else than in /usr/local/{bin,lib},
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
220 you can pass the option --prefix=DIRECTORY; the interpreter
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
221 binary will be installed as DIRECTORY/bin/python and the
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
222 library files as DIRECTORY/lib/python/*. If you pass
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
223 --exec-prefix=DIRECTORY (as well) this overrides the
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
224 installation prefix for architecture-dependent files (like the
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
225 interpreter binary). Note that --prefix=DIRECTORY also
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
226 affects the default module search path (sys.path), when
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
227 Modules/config.c is compiled. Passing make the option
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
228 prefix=DIRECTORY (and/or exec_prefix=DIRECTORY) overrides the
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
229 prefix set at configuration time; this may be more convenient
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
230 than re-running the configure script if you change your mind
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
231 about the install prefix...
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
232
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
233 --with-readline: You can use the GNU readline library to improve the
3698
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
234 interactive user interface. This gives you line editing and
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
235 command history when calling Python interactively. Unless GNU
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
236 readline is a standard part of your system (it is on Linux),
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
237 you need to configure build the GNU readline library before
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
238 running the configure script. Its sources are not distributed
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
239 with Python; you can ftp them from any GNU mirror site, or
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
240 from its home site:
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
241 <URL:ftp://slc2.ins.cwru.edu/pub/dist/readline-2.0.tar.gz> (or
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
242 a higher version number -- using version 1.x is not
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
243 recommended).
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
244
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
245 A GPL-free version was posted to comp.sources.misc in volume
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
246 31 and is widely available from FTP archive sites, e.g.
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
247 <URL:ftp://gatekeeper.dec.com/.b/usenet/comp.sources.misc/
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
248 volume31/editline/part01.Z>
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
249
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
250 Pass the Python configure script the option
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
251 --with-readline=DIRECTORY where DIRECTORY is the absolute
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
252 pathname of the directory where you've built the readline
3698
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
253 library. If GNU readline is a standard part of your system,
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
254 don't pass '=DIRECTORY'. Some hints on building and using the
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
255 readline library are in the FAQ (file Misc/FAQ).
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
256
3698
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
257 --with-thread: On most Unix systems, you can now use multiple threads.
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
258 To enable this, pass --with-thread. If the library required
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
259 for threads lives in a peculiar place, you can use
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
260 --with-thread=DIRECTORY. In the Modules/Setup file, enable
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
261 the thread module. (Threads aren't enabled automatically
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
262 because there are run-time penalties when support for them is
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
263 compiled in even if you don't use them.)
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
264
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
265 --with-sgi-dl: On SGI IRIX 4, dynamic loading of extension modules is
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
266 supported by the "dl" library by Jack Jansen, which is
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
267 ftp'able from <URL:ftp://ftp.cwi.nl/pub/dynload/dl-1.6.tar.Z>.
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
268 This is enabled (after you've ftp'ed and compiled the dl
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
269 library!) by passing --with-sgi-dl=DIRECTORY where DIRECTORY
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
270 is the absolute pathname of the dl library. (Don't bother on
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
271 IRIX 5, it already has dynamic linking using SunOS style
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
272 shared libraries.) Support for this feature is deprecated.
2049
07cf3b3baf16 The usual changes when a release is nearing...
Guido van Rossum <guido@python.org>
parents: 2015
diff changeset
273
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
274 --with-dl-dld: Dynamic loading of modules is rumoured to be supported
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
275 on some other systems: VAX (Ultrix), Sun3 (SunOS 3.4), Sequent
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
276 Symmetry (Dynix), and Atari ST. This is done using a
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
277 combination of the GNU dynamic loading package
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
278 (<URL:ftp://ftp.cwi.nl/pub/dynload/dl-dld-1.1.tar.Z>) and an
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
279 emulation of the SGI dl library mentioned above (the emulation
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
280 can be found at
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
281 <URL:ftp://ftp.cwi.nl/pub/dynload/dld-3.2.3.tar.Z>). To
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
282 enable this, ftp and compile both libraries, then call the
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
283 configure passing it the option
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
284 --with-dl-dld=DL_DIRECTORY,DLD_DIRECTORY where DL_DIRECTORY is
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
285 the absolute pathname of the dl emulation library and
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
286 DLD_DIRECTORY is the absolute pathname of the GNU dld library.
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
287 (Don't bother on SunOS 4 or 5, they already have dynamic
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
288 linking using shared libraries.) Support for this feature is
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
289 deprecated.
2049
07cf3b3baf16 The usual changes when a release is nearing...
Guido van Rossum <guido@python.org>
parents: 2015
diff changeset
290
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
291 --with-libm, --with-libc: It is possible to specify alternative
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
292 versions for the Math library (default -lm) and the C library
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
293 (default the empty string) using the options
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
294 --with-libm=STRING and --with-libc=STRING, respectively. E.g.
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
295 if your system requires that you pass -lc_s to the C compiler
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
296 to use the shared C library, you can pass --with-libc=-lc_s.
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
297 These libraries are passed after all other libraries, the C
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
298 library last.
2049
07cf3b3baf16 The usual changes when a release is nearing...
Guido van Rossum <guido@python.org>
parents: 2015
diff changeset
299
07cf3b3baf16 The usual changes when a release is nearing...
Guido van Rossum <guido@python.org>
parents: 2015
diff changeset
300
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
301 Extensions
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
302 ----------
1453
d773a5f89426 New files
Guido van Rossum <guido@python.org>
parents:
diff changeset
303
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
304 You can also build an "extended" interpreter, using modules that are
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
305 not contained in the Modules directory. Extensions are distributed as
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
306 a separate tar file (currently extensions.tar.gz). See the README
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
307 file there.
2057
79c171f581fc README: changed URL format to <URL:...>; added section on Tk.
Guido van Rossum <guido@python.org>
parents: 2049
diff changeset
308
79c171f581fc README: changed URL format to <URL:...>; added section on Tk.
Guido van Rossum <guido@python.org>
parents: 2049
diff changeset
309
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
310 Building for multiple architectures (using the VPATH feature)
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
311 -------------------------------------------------------------
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
312
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
313 If your file system is shared between multiple architectures, it
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
314 usually is not necessary to make copies of the sources for each
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
315 architecture you want to support. If the make program supports the
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
316 VPATH feature, you can create an empty build directory for each
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
317 architecture, and in each directory run the configure script (on the
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
318 appropriate machine with the appropriate options). This creates the
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
319 necessary subdirectories and the Makefiles therein. The Makefiles
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
320 contain a line VPATH=... which points to directory containing the
1973
f22cb5fee9c8 remove old readline note, add smake note
Guido van Rossum <guido@python.org>
parents: 1944
diff changeset
321 actual sources. (On SGI systems, use "smake" instead of "make" if you
f22cb5fee9c8 remove old readline note, add smake note
Guido van Rossum <guido@python.org>
parents: 1944
diff changeset
322 use VPATH -- don't try gnumake.)
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
323
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
324 For example, the following is all you need to build a minimal Python
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
325 in /usr/tmp/python (assuming ~guido/src/python is the toplevel
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
326 directory and you want to build in /usr/tmp/python):
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
327
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
328 $ mkdir /usr/tmp/python
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
329 $ cd /usr/tmp/python
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
330 $ ~guido/src/python/configure
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
331 [...]
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
332 $ make
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
333 [...]
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
334 $
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
335
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
336 Note that Modules/Makefile copies the original Setup file to the build
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
337 directory if it finds no Setup file there. This means that you can
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
338 edit the Setup file for each architecture independently. For this
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
339 reason, subsequent changes to the original Setup file are not tracked
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
340 automatically, as they might overwrite local changes. To force a copy
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
341 of a changed original Setup file, delete the target Setup file. (The
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
342 makesetup script supports multiple input files, so if you want to be
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
343 fancy you can change the rules to create an empty Setup.local if it
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
344 doesn't exist and run it with arguments $(srcdir)/Setup Setup.local;
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
345 however this assumes that you only need to add modules.)
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
346
1453
d773a5f89426 New files
Guido van Rossum <guido@python.org>
parents:
diff changeset
347
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
348 Building on non-UNIX systems
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
349 ----------------------------
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
350
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
351 On non-UNIX systems, you will have to fake the effect of running the
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
352 configure script manually. A good start is to copy the file
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
353 config.h.in to config.h and edit the latter to reflect the actual
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
354 configuration of your system. Most symbols must simply be defined as
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
355 1 only if the corresponding feature is present and can be left alone
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
356 otherwise; however RETSIGTYPE must always be defined, either as int or
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
357 as void, and the *_t type symbols must be defined as some variant of
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
358 int if they need to be defined at all. Then arrange that the symbol
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
359 HAVE_CONFIG_H is defined during compilation (usually by passing an
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
360 argument of the form `-DHAVE_CONFIG_H' to the compiler, but this is
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
361 necessarily system-dependent).
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
362
1819
a26b31e159be The usual...
Guido van Rossum <guido@python.org>
parents: 1772
diff changeset
363 I have tried to collect instructions, Makefiles and additional sources
a26b31e159be The usual...
Guido van Rossum <guido@python.org>
parents: 1772
diff changeset
364 for various platforms in this release. The following directories
a26b31e159be The usual...
Guido van Rossum <guido@python.org>
parents: 1772
diff changeset
365 exist:
a26b31e159be The usual...
Guido van Rossum <guido@python.org>
parents: 1772
diff changeset
366
a26b31e159be The usual...
Guido van Rossum <guido@python.org>
parents: 1772
diff changeset
367 Mac/ Apple Macintosh, using THINK C 6.0 or MPW 3.2.
a26b31e159be The usual...
Guido van Rossum <guido@python.org>
parents: 1772
diff changeset
368 Dos/ MS-DOS and Windows 3.1, using Microsoft C.
a26b31e159be The usual...
Guido van Rossum <guido@python.org>
parents: 1772
diff changeset
369 Nt/ Windows NT, using Microsoft Visual C/C++.
a26b31e159be The usual...
Guido van Rossum <guido@python.org>
parents: 1772
diff changeset
370 Os2/ OS/2.
a26b31e159be The usual...
Guido van Rossum <guido@python.org>
parents: 1772
diff changeset
371
a26b31e159be The usual...
Guido van Rossum <guido@python.org>
parents: 1772
diff changeset
372 Most of these instructions were last tested with a previous Python
a26b31e159be The usual...
Guido van Rossum <guido@python.org>
parents: 1772
diff changeset
373 release, so you may still experience occasional problems. If you have
a26b31e159be The usual...
Guido van Rossum <guido@python.org>
parents: 1772
diff changeset
374 fixes or suggestions, please let me know and I'll try to incorporate
a26b31e159be The usual...
Guido van Rossum <guido@python.org>
parents: 1772
diff changeset
375 them in the next release.
a26b31e159be The usual...
Guido van Rossum <guido@python.org>
parents: 1772
diff changeset
376
1453
d773a5f89426 New files
Guido van Rossum <guido@python.org>
parents:
diff changeset
377
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
378
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
379 Miscellaneous issues
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
380 ====================
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
381
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
382
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
383 Documentation
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
384 -------------
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
385
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
386 All documentation is provided in the subdirectory Doc in the form of
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
387 LaTeX files. In order of importance for new users: Tutorial (tut),
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
388 Library Reference (lib), Language Reference (ref), Extending (ext).
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
389 Especially the Library Reference is of immense value since much of
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
390 Python's power (including the built-in data types and functions!) is
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
391 described here.
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
392
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
393 To print the documentation from the LaTeX files, chdir into the Doc
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
394 subdirectory, type "make" (let's hope you have LaTeX installed!), and
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
395 send the four resulting PostScript files (tut.ps, lib.ps, ref.ps, and
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
396 ext.ps) to the printer. See the README file there.
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
397
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
398 All documentation is also available on-line via the World-Wide Web
3698
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
399 (WWW): <URL:http://www.python.org>. It can also be downloaded
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
400 separately from the ftp archives (see below) in Emacs INFO, HTML or
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
401 PostScript form -- see the FAQ (file Misc/FAQ) for more info.
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
402
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
403
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
404 Emacs mode
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
405 ----------
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
406
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
407 There's an excellent Emacs editing mode for Python code; see the file
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
408 Misc/python-mode.el. Originally written by Tim Peters, who's no
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
409 longer on the net, it is now maintained by Barry Warsaw
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
410 <bwarsaw@cnri.reston.va.com>.
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
411
2730
10e105e4cf9c add note about font-lock and fix doc URL
Guido van Rossum <guido@python.org>
parents: 2658
diff changeset
412 BTW, if you want to use font-lock for Python sources, here's something
10e105e4cf9c add note about font-lock and fix doc URL
Guido van Rossum <guido@python.org>
parents: 2658
diff changeset
413 to put in your .emacs file:
10e105e4cf9c add note about font-lock and fix doc URL
Guido van Rossum <guido@python.org>
parents: 2658
diff changeset
414
10e105e4cf9c add note about font-lock and fix doc URL
Guido van Rossum <guido@python.org>
parents: 2658
diff changeset
415 (defun my-python-mode-hook ()
10e105e4cf9c add note about font-lock and fix doc URL
Guido van Rossum <guido@python.org>
parents: 2658
diff changeset
416 (setq font-lock-keywords python-font-lock-keywords)
10e105e4cf9c add note about font-lock and fix doc URL
Guido van Rossum <guido@python.org>
parents: 2658
diff changeset
417 (font-lock-mode 1))
10e105e4cf9c add note about font-lock and fix doc URL
Guido van Rossum <guido@python.org>
parents: 2658
diff changeset
418 (add-hook 'python-mode-hook 'my-python-mode-hook)
10e105e4cf9c add note about font-lock and fix doc URL
Guido van Rossum <guido@python.org>
parents: 2658
diff changeset
419
10e105e4cf9c add note about font-lock and fix doc URL
Guido van Rossum <guido@python.org>
parents: 2658
diff changeset
420
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
421
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
422 Bug reports
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
423 -----------
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
424
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
425 Bugs are best reported to the comp.lang.python newsgroup or the Python
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
426 mailing list -- see the section "Newsgroup and mailing list" below.
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
427 Before posting, read the FAQ (file Misc/FAQ) first to see if your
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
428 problem has already been answered!
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
429
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
430
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
431 Ftp access
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
432 ----------
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
433
3698
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
434 Python's "home ftp site" is ftp.python.org, directory /pub/python.
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
435 See the FAQ (file Misc/FAQ) for a list of other ftp sites carrying the
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
436 Python distribution.
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
437
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
438
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
439 Newsgroup and mailing list
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
440 --------------------------
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
441
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
442 There are a newsgroup and a mailing list devoted to Python
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
443 programming, design and bugs. The newsgroup, comp.lang.python,
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
444 contains exactly the same messages as the mailing list. To subscribe
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
445 to the mailing list, send mail containing your real name and e-mail
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
446 address to "python-list-request@cwi.nl" (a real person reads these
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
447 messages, so no LISTPROC or Majordomo commands, please).
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
448
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
449
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
450 The Tk interface
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
451 ----------------
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
452
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
453 Tk (the user interface component of John Ousterhout's Tcl language) is
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
454 also usable from Python. Since this requires that you first build and
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
455 install Tcl/Tk, the Tk interface is not enabled by default. It
3008
a51022f1980f 1.3b1 notes
Guido van Rossum <guido@python.org>
parents: 2730
diff changeset
456 requires Tcl 7.4 and Tk 4.0. (Support for Tk 3.6 and Tcl 7.3 can be
a51022f1980f 1.3b1 notes
Guido van Rossum <guido@python.org>
parents: 2730
diff changeset
457 found in Lib/tk3inter/.)
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
458
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
459 To enable the Python/Tk interface, once you've built and installed
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
460 Tcl/Tk, all you need to do is edit two lines in Modules/Setup; search
3233
fd573ac75947 Renamed module tkinter to _tkinter
Jack Jansen <jack.jansen@cwi.nl>
parents: 3174
diff changeset
461 for the string "_tkinter". Un-comment one (normally the first) of the
fd573ac75947 Renamed module tkinter to _tkinter
Jack Jansen <jack.jansen@cwi.nl>
parents: 3174
diff changeset
462 lines beginning with "#_tkinter" and un-comment the line beginning with
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
463 "#TKPATH". (If you have installed Tcl/Tk in unusual places you will
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
464 have to edit the first line as well to fix the -I and -L options.)
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
465 See the Build Instructions above for more details.
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
466
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
467 There is little documentation. Begin with fetching the "Tk Lifesaver"
3698
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
468 document,
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
469 e.g. <URL:ftp://ftp.python.org/pub/python/doc/tkinter-doc.tar.gz> (a
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
470 gzipped tar file containing a PostScript file). There are demos in
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
471 the Demo/tkinter directory, in the subdirectories guido, matt and www.
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
472
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
473 Note that there's a Python module called "Tkinter" (capital T) which
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
474 lives in Lib/tkinter/Tkinter.py, and a C module called "tkinter"
3233
fd573ac75947 Renamed module tkinter to _tkinter
Jack Jansen <jack.jansen@cwi.nl>
parents: 3174
diff changeset
475 (lower case t) which lives in Modules/_tkinter.c. Demos and
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
476 normal Tk applications only import the Python Tkinter module -- only
3233
fd573ac75947 Renamed module tkinter to _tkinter
Jack Jansen <jack.jansen@cwi.nl>
parents: 3174
diff changeset
477 the latter uses the C _tkinter module directly. In order to find the C
fd573ac75947 Renamed module tkinter to _tkinter
Jack Jansen <jack.jansen@cwi.nl>
parents: 3174
diff changeset
478 _tkinter module, it must be compiled and linked into the Python
fd573ac75947 Renamed module tkinter to _tkinter
Jack Jansen <jack.jansen@cwi.nl>
parents: 3174
diff changeset
479 interpreter -- the _tkinter line in the Setup file does this. In order
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
480 to find the Python Tkinter module, sys.path must be set correctly --
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
481 the TKPATH assignment in the Setup file takes care of this, but only
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
482 if you install Python properly ("make install libinstall"). (You can
3233
fd573ac75947 Renamed module tkinter to _tkinter
Jack Jansen <jack.jansen@cwi.nl>
parents: 3174
diff changeset
483 also use dynamic loading for the C _tkinter module, in which case you
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
484 must manually fix up sys.path or set $PYTHONPATH for the Python
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
485 Tkinter module.)
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
486
3174
f7789945b8de release 1.3 for real
Guido van Rossum <guido@python.org>
parents: 3110
diff changeset
487 See <URL:http://www.smli.com/research/tcl/> for more info on where
3008
a51022f1980f 1.3b1 notes
Guido van Rossum <guido@python.org>
parents: 2730
diff changeset
488 to get Tcl/Tk.
a51022f1980f 1.3b1 notes
Guido van Rossum <guido@python.org>
parents: 2730
diff changeset
489
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
490
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
491 Distribution structure
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
492 ----------------------
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
493
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
494 Most subdirectories have their own README file. Most files have
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
495 comments.
1453
d773a5f89426 New files
Guido van Rossum <guido@python.org>
parents:
diff changeset
496
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
497 ChangeLog A raw list of changes since the first 1.0.0 BETA release
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
498 Contrib/ Interesting or useful Python code contributed by others
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
499 Demo/ Demonstration scripts, modules and programs
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
500 Doc/ Documentation (LaTeX sources)
1819
a26b31e159be The usual...
Guido van Rossum <guido@python.org>
parents: 1772
diff changeset
501 Extensions/ Extension modules (distributed separately)
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
502 Grammar/ Input for the parser generator
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
503 Include/ Public header files
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
504 Lib/ Python library modules
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
505 Makefile.in Source from which config.status creates Makefile
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
506 Misc/ Miscellaneous files
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
507 Modules/ Implementation of most built-in modules
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
508 Objects/ Implementation of most built-in object types
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
509 Parser/ The parser and tokenizer and their input handling
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
510 Python/ The "compiler" and interpreter
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
511 README The file you're reading now
2510
c29adb338964 add warning about recompiling myreadline.o; add Tools/
Guido van Rossum <guido@python.org>
parents: 2329
diff changeset
512 Tools/ Some useful programs written in Python
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
513 acconfig.h Additional input for the autoheader program
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
514 config.h.in Source from which config.status creates config.h
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
515 configure Configuration shell script (GNU autoconf output)
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
516 configure.in Configuration specification (GNU autoconf input)
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
517
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
518 The following files will (may) be created in the toplevel directory by
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
519 the configuration and build processes:
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
520
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
521 Makefile Build rules
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
522 config.cache cache of configuration variables
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
523 config.h Configuration header
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
524 config.log log from last configure run
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
525 config.status status from last run of configure script
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
526 python The executable interpreter
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
527 tags, TAGS Tags files for vi and Emacs
1453
d773a5f89426 New files
Guido van Rossum <guido@python.org>
parents:
diff changeset
528
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
529
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
530 Author's address
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
531 ----------------
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
532
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
533 Guido van Rossum
3698
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
534 CNRI
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
535 1895 Preston White Drive
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
536 Reston, VA 22094
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
537 USA
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
538
3698
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
539 E-mail: guido@python.org
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
540
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
541
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
542
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
543 Copyright notice
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
544 ================
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
545
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
546 The Python source is copyrighted, but you can freely use and copy it
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
547 as long as you don't change or remove the copyright notice:
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
548
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
549 ----------------------------------------------------------------------
2057
79c171f581fc README: changed URL format to <URL:...>; added section on Tk.
Guido van Rossum <guido@python.org>
parents: 2049
diff changeset
550 Copyright 1991-1995 by Stichting Mathematisch Centrum, Amsterdam,
79c171f581fc README: changed URL format to <URL:...>; added section on Tk.
Guido van Rossum <guido@python.org>
parents: 2049
diff changeset
551 The Netherlands.
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
552
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
553 All Rights Reserved
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
554
1819
a26b31e159be The usual...
Guido van Rossum <guido@python.org>
parents: 1772
diff changeset
555 Permission to use, copy, modify, and distribute this software and its
a26b31e159be The usual...
Guido van Rossum <guido@python.org>
parents: 1772
diff changeset
556 documentation for any purpose and without fee is hereby granted,
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
557 provided that the above copyright notice appear in all copies and that
1819
a26b31e159be The usual...
Guido van Rossum <guido@python.org>
parents: 1772
diff changeset
558 both that copyright notice and this permission notice appear in
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
559 supporting documentation, and that the names of Stichting Mathematisch
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
560 Centrum or CWI not be used in advertising or publicity pertaining to
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
561 distribution of the software without specific, written prior permission.
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
562
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
563 STICHTING MATHEMATISCH CENTRUM DISCLAIMS ALL WARRANTIES WITH REGARD TO
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
564 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
565 FITNESS, IN NO EVENT SHALL STICHTING MATHEMATISCH CENTRUM BE LIABLE
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
566 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
567 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
568 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
569 OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
2658
3a3df231327c revamped README; the usual elsewhere...
Guido van Rossum <guido@python.org>
parents: 2510
diff changeset
570 ----------------------------------------------------------------------
1748
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
571
8286a662502b Merge alpha100 branch back to main trunk
Guido van Rossum <guido@python.org>
parents: 1456
diff changeset
572
3698
97b1c2a70eae Some cleanups. Change of address.
Guido van Rossum <guido@python.org>
parents: 3399
diff changeset
573 --Guido van Rossum (home page: http://www.python.org/~guido/)