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