Barry Warsaw | cf9727f | 2003-05-22 15:15:05 | [diff] [blame] | 1 | This is Python version 2.2.3 |
Guido van Rossum | 241aa8b | 2002-10-14 12:35:53 | [diff] [blame] | 2 | ============================ |
Guido van Rossum | 9144763 | 2000-04-11 17:11:09 | [diff] [blame] | 3 | |
Barry Warsaw | cf9727f | 2003-05-22 15:15:05 | [diff] [blame] | 4 | Copyright (c) 2001, 2002, 2003 Python Software Foundation. |
Guido van Rossum | 67345eb | 2001-01-18 14:51:12 | [diff] [blame] | 5 | All rights reserved. |
| 6 | |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 7 | Copyright (c) 2000 BeOpen.com. |
| 8 | All rights reserved. |
| 9 | |
Guido van Rossum | 23f7aed | 2001-04-12 20:53:31 | [diff] [blame] | 10 | Copyright (c) 1995-2001 Corporation for National Research Initiatives. |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 11 | All rights reserved. |
| 12 | |
Guido van Rossum | 6ebd299 | 2000-09-03 04:47:47 | [diff] [blame] | 13 | Copyright (c) 1991-1995 Stichting Mathematisch Centrum. |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 14 | All rights reserved. |
| 15 | |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 16 | |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 17 | License information |
| 18 | ------------------- |
| 19 | |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 20 | See the file "LICENSE" for information on the history of this |
| 21 | software, terms & conditions for usage, and a DISCLAIMER OF ALL |
| 22 | WARRANTIES. |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 23 | |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 24 | This Python distribution contains no GNU General Public Licensed |
| 25 | (GPLed) code so it may be used in proprietary projects just like prior |
| 26 | Python distributions. There are interfaces to some GNU code but these |
| 27 | are entirely optional. |
| 28 | |
| 29 | All trademarks referenced herein are property of their respective |
| 30 | holders. |
Guido van Rossum | 7980826 | 1997-12-11 18:01:47 | [diff] [blame] | 31 | |
| 32 | |
Guido van Rossum | 8d7d4ed | 1996-07-30 21:41:07 | [diff] [blame] | 33 | What's new in this release? |
| 34 | --------------------------- |
Guido van Rossum | 3ff96dd | 1996-07-30 18:05:04 | [diff] [blame] | 35 | |
Guido van Rossum | 67345eb | 2001-01-18 14:51:12 | [diff] [blame] | 36 | See the file "Misc/NEWS". |
Guido van Rossum | 6477380 | 1997-11-26 17:07:02 | [diff] [blame] | 37 | |
| 38 | If you don't read instructions |
| 39 | ------------------------------ |
| 40 | |
| 41 | Congratulations on getting this far. :-) |
| 42 | |
| 43 | To start building right away (on UNIX): type "./configure" in the |
Michael W. Hudson | c104d89 | 2002-03-17 19:39:24 | [diff] [blame] | 44 | current directory and when it finishes, type "make". This creates an |
| 45 | executable "./python"; to install in /usr/local, first do "su root" |
| 46 | and then "make install". |
| 47 | |
| 48 | The section `Build Instructions' below is still recommended reading, |
| 49 | especially the part on customizing Modules/Setup. |
Guido van Rossum | 3ff96dd | 1996-07-30 18:05:04 | [diff] [blame] | 50 | |
| 51 | |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 52 | What is Python anyway? |
| 53 | ---------------------- |
| 54 | |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 55 | Python is an interpreted object-oriented programming language suitable |
| 56 | (amongst other uses) for distributed application development, |
| 57 | scripting, numeric computing and system testing. Python is often |
| 58 | compared to Tcl, Perl, Java, JavaScript, Visual Basic or Scheme. To |
| 59 | find out more about what Python can do for you, point your browser to |
Guido van Rossum | 67345eb | 2001-01-18 14:51:12 | [diff] [blame] | 60 | http://www.python.org/. |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 61 | |
| 62 | |
Guido van Rossum | f501b4e | 1996-10-25 14:32:48 | [diff] [blame] | 63 | How do I learn Python? |
| 64 | ---------------------- |
| 65 | |
Fred Drake | 0e6444c | 1999-05-17 19:35:01 | [diff] [blame] | 66 | The official tutorial is still a good place to start; see |
Guido van Rossum | d0a42e2 | 2000-03-31 20:16:45 | [diff] [blame] | 67 | http://www.python.org/doc/ for online and downloadable versions, as |
| 68 | well as a list of other introductions, and reference documentation. |
Guido van Rossum | f501b4e | 1996-10-25 14:32:48 | [diff] [blame] | 69 | |
Guido van Rossum | d0a42e2 | 2000-03-31 20:16:45 | [diff] [blame] | 70 | There's a quickly growing set of books on Python. See |
| 71 | http://www.python.org/psa/bookstore/ for a list. |
Guido van Rossum | 8d90f9d | 1997-05-22 20:13:25 | [diff] [blame] | 72 | |
Guido van Rossum | f501b4e | 1996-10-25 14:32:48 | [diff] [blame] | 73 | |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 74 | Documentation |
| 75 | ------------- |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 76 | |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 77 | All documentation is provided online in a variety of formats. In |
| 78 | order of importance for new users: Tutorial, Library Reference, |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 79 | Language Reference, Extending & Embedding, and the Python/C API. The |
| 80 | Library Reference is especially of immense value since much of |
| 81 | Python's power is described there, including the built-in data types |
| 82 | and functions! |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 83 | |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 84 | All documentation is also available online at the Python web site |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 85 | (http://www.python.org/doc/, see below). It is available online for |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 86 | occasional reference, or can be downloaded in many formats for faster |
Fred Drake | 6caae14 | 2000-10-25 17:51:02 | [diff] [blame] | 87 | access. The documentation is available in HTML, PostScript, PDF, and |
| 88 | LaTeX formats; the LaTeX version is primarily for documentation |
| 89 | authors, translators, and people with special formatting requirements. |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 90 | |
Barry Warsaw | 0655745 | 2001-12-14 20:47:12 | [diff] [blame] | 91 | The best documentation for the new (in Python 2.2) type/class unification |
| 92 | features is Guido's tutorial introduction, at |
| 93 | |
| 94 | http://www.python.org/2.2/descrintro.html |
| 95 | |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 96 | |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 97 | Web sites |
| 98 | --------- |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 99 | |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 100 | New Python releases and related technologies are published at |
Guido van Rossum | 67345eb | 2001-01-18 14:51:12 | [diff] [blame] | 101 | http://www.python.org/. Come visit us! |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 102 | |
Guido van Rossum | 67345eb | 2001-01-18 14:51:12 | [diff] [blame] | 103 | There's also a Python community web site at http://starship.python.net/. |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 104 | |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 105 | |
| 106 | Newsgroups and Mailing Lists |
| 107 | ---------------------------- |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 108 | |
| 109 | Read comp.lang.python, a high-volume discussion newsgroup about |
| 110 | Python, or comp.lang.python.announce, a low-volume moderated newsgroup |
| 111 | for Python-related announcements. These are also accessible as |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 112 | mailing lists: see http://www.python.org/psa/MailingLists.html for an |
| 113 | overview of the many Python-related mailing lists. |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 114 | |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 115 | Archives are accessible via Deja.com Usenet News: see |
| 116 | http://www.deja.com/usenet. The mailing lists are also archived, see |
| 117 | http://www.python.org/psa/MailingLists.html for details. |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 118 | |
| 119 | |
| 120 | Bug reports |
| 121 | ----------- |
| 122 | |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 123 | To report or search for bugs, please use the Python Bug |
| 124 | Tracker at http://sourceforge.net/bugs/?group_id=5470. |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 125 | |
| 126 | |
| 127 | Patches and contributions |
| 128 | ------------------------- |
| 129 | |
Fred Drake | 6caae14 | 2000-10-25 17:51:02 | [diff] [blame] | 130 | To submit a patch or other contribution, please use the Python Patch |
| 131 | Manager at http://sourceforge.net/patch/?group_id=5470. Guidelines |
| 132 | for patch submission may be found at http://www.python.org/patches/. |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 133 | |
| 134 | If you have a proposal to change Python, it's best to submit a Python |
| 135 | Enhancement Proposal (PEP) first. All current PEPs, as well as |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 136 | guidelines for submitting a new PEP, are list at |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 137 | http://python.sourceforge.net/peps/. |
| 138 | |
| 139 | |
| 140 | Questions |
| 141 | --------- |
| 142 | |
| 143 | For help, if you can't find it in the manuals or on the web site, it's |
| 144 | best to post to the comp.lang.python or the Python mailing list (see |
| 145 | above). If you specifically don't want to involve the newsgroup or |
Guido van Rossum | 67345eb | 2001-01-18 14:51:12 | [diff] [blame] | 146 | mailing list, send questions to help@python.org (a group of volunteers |
| 147 | who answer questions as they can). The newsgroup is the most |
| 148 | efficient way to ask public questions. |
Guido van Rossum | 627b2d7 | 1993-12-24 10:39:16 | [diff] [blame] | 149 | |
Guido van Rossum | 901454e | 2000-06-29 22:28:44 | [diff] [blame] | 150 | |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 | [diff] [blame] | 151 | Build instructions |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 152 | ================== |
Guido van Rossum | 627b2d7 | 1993-12-24 10:39:16 | [diff] [blame] | 153 | |
Michael W. Hudson | 45c44fb | 2002-02-22 13:50:51 | [diff] [blame] | 154 | Before you can build Python, you must first configure it. |
| 155 | Fortunately, the configuration and build process has been automated |
| 156 | for Unix and Linux installations, so all you usually have to do is |
| 157 | type a few commands and sit back. There are some platforms where |
| 158 | things are not quite as smooth; see the platform specific notes below. |
| 159 | If you want to build for multiple platforms sharing the same source |
| 160 | tree, see the section on VPATH below. |
Guido van Rossum | 627b2d7 | 1993-12-24 10:39:16 | [diff] [blame] | 161 | |
Michael W. Hudson | 45c44fb | 2002-02-22 13:50:51 | [diff] [blame] | 162 | Start by running the script "./configure", which determines your |
| 163 | system configuration and creates the Makefile. (It takes a minute or |
| 164 | two -- please be patient!) You may want to pass options to the |
| 165 | configure script -- see the section below on configuration options and |
| 166 | variables. When it's done, you are ready to run make. |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 167 | |
Michael W. Hudson | 45c44fb | 2002-02-22 13:50:51 | [diff] [blame] | 168 | To build Python, you normally type "make" in the toplevel directory. |
| 169 | If you have changed the configuration, the Makefile may have to be |
| 170 | rebuilt. In this case you may have to run make again to correctly |
| 171 | build your desired target. The interpreter executable is built in the |
| 172 | top level directory. |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 173 | |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 174 | Once you have built a Python interpreter, see the subsections below on |
Michael W. Hudson | 45c44fb | 2002-02-22 13:50:51 | [diff] [blame] | 175 | testing and installation. If you run into trouble, see the next |
| 176 | section. |
| 177 | |
| 178 | Previous versions of Python used a manual configuration process that |
| 179 | involved editing the file Modules/Setup. While this file still exists |
| 180 | and manual configuration is still supported, it is rarely needed any |
| 181 | more: almost all modules are automatically built as appropriate under |
| 182 | guidance of the setup.py script, which is run by Make after the |
| 183 | interpreter has been built. |
Guido van Rossum | 627b2d7 | 1993-12-24 10:39:16 | [diff] [blame] | 184 | |
Guido van Rossum | 0a516c9 | 1994-09-12 10:58:40 | [diff] [blame] | 185 | |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 186 | Troubleshooting |
| 187 | --------------- |
Guido van Rossum | 627b2d7 | 1993-12-24 10:39:16 | [diff] [blame] | 188 | |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 189 | See also the platform specific notes in the next section. |
| 190 | |
Guido van Rossum | 4952369 | 1997-08-15 18:30:14 | [diff] [blame] | 191 | If you run into other trouble, see section 3 of the FAQ |
Guido van Rossum | 901454e | 2000-06-29 22:28:44 | [diff] [blame] | 192 | (http://www.python.org/cgi-bin/faqw.py or |
Guido van Rossum | 4952369 | 1997-08-15 18:30:14 | [diff] [blame] | 193 | http://www.python.org/doc/FAQ.html) for hints on what can go wrong, |
| 194 | and how to fix it. |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 195 | |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 196 | If you rerun the configure script with different options, remove all |
| 197 | object files by running "make clean" before rebuilding. Believe it or |
| 198 | not, "make clean" sometimes helps to clean up other inexplicable |
| 199 | problems as well. Try it before sending in a bug report! |
| 200 | |
Guido van Rossum | d0fe845 | 1996-08-26 03:02:37 | [diff] [blame] | 201 | If the configure script fails or doesn't seem to find things that |
Guido van Rossum | c0be2f5 | 1997-10-08 05:05:28 | [diff] [blame] | 202 | should be there, inspect the config.log file. When you fix a |
| 203 | configure problem, be sure to remove config.cache! |
| 204 | |
| 205 | If you get a warning for every file about the -Olimit option being no |
| 206 | longer supported, you can ignore it. There's no foolproof way to know |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 207 | whether this option is needed; all we can do is test whether it is |
Guido van Rossum | c0be2f5 | 1997-10-08 05:05:28 | [diff] [blame] | 208 | accepted without error. On some systems, e.g. older SGI compilers, it |
| 209 | is essential for performance (specifically when compiling ceval.c, |
| 210 | which has more basic blocks than the default limit of 1000). If the |
| 211 | warning bothers you, edit the Makefile to remove "-Olimit 1500" from |
| 212 | the OPT variable. |
Guido van Rossum | d0fe845 | 1996-08-26 03:02:37 | [diff] [blame] | 213 | |
Guido van Rossum | 7ac1153 | 2000-08-29 21:36:40 | [diff] [blame] | 214 | If you get failures in test_long, or sys.maxint gets set to -1, you |
| 215 | are probably experiencing compiler bugs, usually related to |
Martin v. Löwis | cd0cbbe | 2002-11-15 07:27:03 | [diff] [blame] | 216 | optimization. This is a common problem with some versions of gcc, and |
| 217 | some vendor-supplied compilers, which can sometimes be worked around |
| 218 | by turning off optimization. Consider switching to stable versions |
| 219 | (gcc 2.95.2, or contact your vendor.) |
Guido van Rossum | 7ac1153 | 2000-08-29 21:36:40 | [diff] [blame] | 220 | |
| 221 | From Python 2.0 onward, all Python C code is ANSI C. Compiling using |
| 222 | old K&R-C-only compilers is no longer possible. ANSI C compilers are |
| 223 | available for all modern systems, either in the form of updated |
Martin v. Löwis | cd0cbbe | 2002-11-15 07:27:03 | [diff] [blame] | 224 | compilers from the vendor, or one of the free compilers (gcc). |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 225 | |
| 226 | Platform specific notes |
| 227 | ----------------------- |
| 228 | |
Guido van Rossum | 0447a32 | 1995-10-08 01:22:33 | [diff] [blame] | 229 | (Some of these may no longer apply. If you find you can build Python |
Guido van Rossum | 67345eb | 2001-01-18 14:51:12 | [diff] [blame] | 230 | on these platforms without the special directions mentioned here, |
| 231 | submit a documentation bug report to SourceForge (see Bug Reports |
| 232 | above) so we can remove them!) |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 233 | |
Guido van Rossum | c0be2f5 | 1997-10-08 05:05:28 | [diff] [blame] | 234 | 64-bit platforms: The modules audioop, imageop and rgbimg don't work. |
Michael W. Hudson | 45c44fb | 2002-02-22 13:50:51 | [diff] [blame] | 235 | The setup.py script disables them on 64-bit installations. |
Guido van Rossum | c0be2f5 | 1997-10-08 05:05:28 | [diff] [blame] | 236 | Don't try to enable them in the Modules/Setup file. They |
| 237 | contain code that is quite wordsize sensitive. (If you have a |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 238 | fix, let us know!) |
Guido van Rossum | c0be2f5 | 1997-10-08 05:05:28 | [diff] [blame] | 239 | |
Guido van Rossum | 4462e93 | 1997-01-22 21:00:32 | [diff] [blame] | 240 | Solaris: When using Sun's C compiler with threads, at least on Solaris |
| 241 | 2.5.1, you need to add the "-mt" compiler option (the simplest |
| 242 | way is probably to specify the compiler with this option as |
| 243 | the "CC" environment variable when running the configure |
| 244 | script). |
| 245 | |
Guido van Rossum | 9eda652 | 2002-09-23 14:02:44 | [diff] [blame] | 246 | When using GCC on Solaris, beware of binutils 2.13 or GCC |
| 247 | versions built using it. This mistakenly enables the |
| 248 | -zcombreloc option which creates broken shared libraries on |
| 249 | Solaris. binutils 2.12 works, and the binutils maintainers |
| 250 | are aware of the problem, so binutils 2.13.1 will probably fix |
| 251 | this problem. |
| 252 | |
Martin v. Löwis | cd0cbbe | 2002-11-15 07:27:03 | [diff] [blame] | 253 | When the dynamic loader complains about errors finding shared |
| 254 | libraries, such as |
| 255 | |
| 256 | ld.so.1: ./python: fatal: libstdc++.so.5: open failed: |
| 257 | No such file or directory |
| 258 | |
| 259 | you need to first make sure that the library is available on |
| 260 | your system. Then, you need to instruct the dynamic loader how |
| 261 | to find it. You can chose any of the following strategies: |
| 262 | |
| 263 | 1. When compiling Python, set LD_RUN_PATH to the directories |
| 264 | containing missing libraries. |
| 265 | 2. When running Python, set LD_LIBRARY_PATH to these directories. |
| 266 | 3. Use crle(8) to extend the search path of the loader. |
| 267 | 4. Modify the installed GCC specs file, adding -R options into the |
| 268 | *link: section. |
| 269 | |
Guido van Rossum | 7ac1153 | 2000-08-29 21:36:40 | [diff] [blame] | 270 | Linux: A problem with threads and fork() was tracked down to a bug in |
| 271 | the pthreads code in glibc version 2.0.5; glibc version 2.0.7 |
| 272 | solves the problem. This causes the popen2 test to fail; |
| 273 | problem and solution reported by Pablo Bleyer. |
Guido van Rossum | 4462e93 | 1997-01-22 21:00:32 | [diff] [blame] | 274 | |
Guido van Rossum | 7ac1153 | 2000-08-29 21:36:40 | [diff] [blame] | 275 | Under Linux systems using GNU libc 2 (aka libc6), the crypt |
Michael W. Hudson | 45c44fb | 2002-02-22 13:50:51 | [diff] [blame] | 276 | module now needs the -lcrypt option. The setup.py script |
| 277 | takes care of this automatically. |
Fred Drake | 6128091 | 1997-12-08 14:10:40 | [diff] [blame] | 278 | |
Michael W. Hudson | c104d89 | 2002-03-17 19:39:24 | [diff] [blame] | 279 | Red Hat Linux: There's an executable /usr/bin/python which is Python |
| 280 | 1.5.2 on most Red Hat installations; several key Red Hat tools |
| 281 | require this version. Python 2.1.x may be installed as |
| 282 | /usr/bin/python2. The Makefile installs Python as |
| 283 | /usr/local/bin/python, which may or may not take precedence |
| 284 | over /usr/bin/python, depending on how you have set up $PATH. |
| 285 | |
Guido van Rossum | 5923050 | 1999-06-21 20:51:46 | [diff] [blame] | 286 | FreeBSD 3.x and probably platforms with NCurses that use libmytinfo or |
| 287 | similar: When using cursesmodule, the linking is not done in |
| 288 | the correct order with the defaults. Remove "-ltermcap" from |
| 289 | the readline entry in Setup, and use as curses entry: "curses |
| 290 | cursesmodule.c -lmytinfo -lncurses -ltermcap" - "mytinfo" (so |
| 291 | called on FreeBSD) should be the name of the auxiliary library |
| 292 | required on your platform. Normally, it would be linked |
| 293 | automatically, but not necessarily in the correct order. |
| 294 | |
Guido van Rossum | 7ac1153 | 2000-08-29 21:36:40 | [diff] [blame] | 295 | BSDI: BSDI versions before 4.1 have known problems with threads, |
| 296 | which can cause strange errors in a number of modules (for |
| 297 | instance, the 'test_signal' test script will hang forever.) |
| 298 | Turning off threads (with --with-threads=no) or upgrading to |
| 299 | BSDI 4.1 solves this problem. |
| 300 | |
| 301 | DEC Unix: Run configure with --with-dec-threads, or with |
| 302 | --with-threads=no if no threads are desired (threads are on by |
| 303 | default). When using GCC, it is possible to get an internal |
| 304 | compiler error if optimization is used. This was reported for |
| 305 | GCC 2.7.2.3 on selectmodule.c. Manually compile the affected |
| 306 | file without optimization to solve the problem. |
Guido van Rossum | 8eca2c2 | 1996-02-14 18:37:46 | [diff] [blame] | 307 | |
Guido van Rossum | e1cdb16 | 1999-04-10 16:04:07 | [diff] [blame] | 308 | DEC Ultrix: compile with GCC to avoid bugs in the native compiler, |
| 309 | and pass SHELL=/bin/sh5 to Make when installing. |
| 310 | |
Guido van Rossum | d0fe845 | 1996-08-26 03:02:37 | [diff] [blame] | 311 | AIX: A complete overhaul of the shared library support is now in |
Guido van Rossum | 16e809e | 2001-04-16 02:07:08 | [diff] [blame] | 312 | place. See Misc/AIX-NOTES for some notes on how it's done. |
Guido van Rossum | 9ac9a26 | 1998-02-16 22:19:21 | [diff] [blame] | 313 | (The optimizer bug reported at this place in previous releases |
Thomas Wouters | 8ee0614 | 2001-02-15 11:45:29 | [diff] [blame] | 314 | has been worked around by a minimal code change.) If you get |
Fred Drake | 8520b36 | 2002-05-11 03:37:15 | [diff] [blame] | 315 | errors about pthread_* functions, during compile or during |
Thomas Wouters | 8ee0614 | 2001-02-15 11:45:29 | [diff] [blame] | 316 | testing, try setting CC to a thread-safe (reentrant) compiler, |
| 317 | like "cc_r". For full C++ module support, set CC="xlC_r" (or |
| 318 | CC="xlC" without thread support). |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 319 | |
Guido van Rossum | 59a88f4 | 1999-04-12 18:16:09 | [diff] [blame] | 320 | HP-UX: Please read the file Misc/HPUX-NOTES for shared libraries. |
| 321 | When using threading, you may have to add -D_REENTRANT to the |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 322 | OPT variable in the top-level Makefile; reported by Pat Knight, |
Guido van Rossum | 59a88f4 | 1999-04-12 18:16:09 | [diff] [blame] | 323 | this seems to make a difference (at least for HP-UX 10.20) |
Fred Drake | 622dca0 | 2002-11-04 20:50:39 | [diff] [blame] | 324 | even though pyconfig.h defines it. |
Guido van Rossum | 2094e04 | 1998-05-14 15:47:35 | [diff] [blame] | 325 | |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 326 | Minix: When using ack, use "CC=cc AR=aal RANLIB=: ./configure"! |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 327 | |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 328 | SCO: The following apply to SCO 3 only; Python builds out of the box |
| 329 | on SCO 5 (or so we've heard). |
Guido van Rossum | a16e275 | 1998-04-13 20:14:05 | [diff] [blame] | 330 | |
| 331 | 1) Everything works much better if you add -U__STDC__ to the |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 332 | defs. This is because all the SCO header files are broken. |
Guido van Rossum | 6477380 | 1997-11-26 17:07:02 | [diff] [blame] | 333 | Anything that isn't mentioned in the C standard is |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 334 | conditionally excluded when __STDC__ is defined. |
| 335 | |
| 336 | 2) Due to the U.S. export restrictions, SCO broke the crypt |
| 337 | stuff out into a separate library, libcrypt_i.a so the LIBS |
| 338 | needed be set to: |
| 339 | |
| 340 | LIBS=' -lsocket -lcrypt_i' |
| 341 | |
Martin v. Löwis | 387c547 | 2001-09-06 08:16:17 | [diff] [blame] | 342 | UnixWare: There are known bugs in the math library of the system, as well as |
| 343 | problems in the handling of threads (calling fork in one |
| 344 | thread may interrupt system calls in others). Therefore, test_math and |
| 345 | tests involving threads will fail until those problems are fixed. |
| 346 | |
Guido van Rossum | 7ac1153 | 2000-08-29 21:36:40 | [diff] [blame] | 347 | 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 | [diff] [blame] | 348 | '-Xa' option instead of '-Xc', to enable some needed non-ANSI |
| 349 | Sunisms. |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 350 | |
Jack Jansen | a39ef86 | 2001-08-19 21:17:03 | [diff] [blame] | 351 | NeXT: Not supported anymore. Start with the MacOSX/Darwin code if you |
| 352 | want to revive it. |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 353 | |
Guido van Rossum | b7f454d | 1997-12-02 19:44:31 | [diff] [blame] | 354 | QNX: Chris Herborth (chrish@qnx.com) writes: |
| 355 | configure works best if you use GNU bash; a port is available on |
| 356 | ftp.qnx.com in /usr/free. I used the following process to build, |
Guido van Rossum | d449342 | 1998-12-22 16:37:01 | [diff] [blame] | 357 | test and install Python 1.5.x under QNX: |
Guido van Rossum | b7f454d | 1997-12-02 19:44:31 | [diff] [blame] | 358 | |
Guido van Rossum | ec95c7b | 1998-08-04 17:59:56 | [diff] [blame] | 359 | 1) CONFIG_SHELL=/usr/local/bin/bash CC=cc RANLIB=: \ |
| 360 | ./configure --verbose --without-gcc --with-libm="" |
Guido van Rossum | b7f454d | 1997-12-02 19:44:31 | [diff] [blame] | 361 | |
Fred Drake | 8007849 | 2000-10-26 17:13:19 | [diff] [blame] | 362 | 2) edit Modules/Setup to activate everything that makes sense for |
| 363 | your system... tested here at QNX with the following modules: |
Guido van Rossum | b7f454d | 1997-12-02 19:44:31 | [diff] [blame] | 364 | |
Guido van Rossum | 6fa49e2 | 1998-08-11 17:31:39 | [diff] [blame] | 365 | array, audioop, binascii, cPickle, cStringIO, cmath, |
| 366 | crypt, curses, errno, fcntl, gdbm, grp, imageop, |
| 367 | _locale, math, md5, new, operator, parser, pcre, |
| 368 | posix, pwd, readline, regex, reop, rgbimg, rotor, |
| 369 | select, signal, socket, soundex, strop, struct, |
Guido van Rossum | d449342 | 1998-12-22 16:37:01 | [diff] [blame] | 370 | syslog, termios, time, timing, zlib, audioop, imageop, rgbimg |
Guido van Rossum | b7f454d | 1997-12-02 19:44:31 | [diff] [blame] | 371 | |
Guido van Rossum | 16e809e | 2001-04-16 02:07:08 | [diff] [blame] | 372 | 3) make SHELL=/usr/local/bin/bash |
| 373 | |
Guido van Rossum | ec95c7b | 1998-08-04 17:59:56 | [diff] [blame] | 374 | or, if you feel the need for speed: |
Guido van Rossum | 16e809e | 2001-04-16 02:07:08 | [diff] [blame] | 375 | |
Guido van Rossum | ec95c7b | 1998-08-04 17:59:56 | [diff] [blame] | 376 | make SHELL=/usr/local/bin/bash OPT="-5 -Oil+nrt" |
Guido van Rossum | b7f454d | 1997-12-02 19:44:31 | [diff] [blame] | 377 | |
Guido van Rossum | ec95c7b | 1998-08-04 17:59:56 | [diff] [blame] | 378 | 4) make SHELL=/usr/local/bin/bash test |
| 379 | |
Guido van Rossum | 6fa49e2 | 1998-08-11 17:31:39 | [diff] [blame] | 380 | Using GNU readline 2.2 seems to behave strangely, but I |
| 381 | think that's a problem with my readline 2.2 port. :-\ |
Guido van Rossum | ec95c7b | 1998-08-04 17:59:56 | [diff] [blame] | 382 | |
| 383 | 5) make SHELL=/usr/local/bin/bash install |
Guido van Rossum | b7f454d | 1997-12-02 19:44:31 | [diff] [blame] | 384 | |
Guido van Rossum | 6fa49e2 | 1998-08-11 17:31:39 | [diff] [blame] | 385 | If you get SIGSEGVs while running Python (I haven't yet, but |
| 386 | I've only run small programs and the test cases), you're |
| 387 | probably running out of stack; the default 32k could be a |
| 388 | little tight. To increase the stack size, edit the Makefile |
Neil Schemenauer | 73f8ab2 | 2001-01-26 22:18:55 | [diff] [blame] | 389 | to read: LDFLAGS = -N 48k |
Guido van Rossum | 40d6358 | 1997-08-14 19:45:30 | [diff] [blame] | 390 | |
Guido van Rossum | ec95c7b | 1998-08-04 17:59:56 | [diff] [blame] | 391 | BeOS: Chris Herborth (chrish@qnx.com) writes: |
| 392 | See BeOS/README for notes about compiling/installing Python on |
Guido van Rossum | 6fa49e2 | 1998-08-11 17:31:39 | [diff] [blame] | 393 | BeOS R3 or later. Note that only the PowerPC platform is |
Guido van Rossum | d449342 | 1998-12-22 16:37:01 | [diff] [blame] | 394 | supported for R3; both PowerPC and x86 are supported for R4. |
Guido van Rossum | ec95c7b | 1998-08-04 17:59:56 | [diff] [blame] | 395 | |
Michael W. Hudson | 227c769 | 2002-07-31 11:19:49 | [diff] [blame] | 396 | Cray T3E: Mark Hadfield (m.hadfield@niwa.co.nz) writes: |
| 397 | Python can be built satisfactorily on a Cray T3E but based on |
| 398 | my experience with the NIWA T3E (2002-05-22, version 2.2.1) |
| 399 | there are a few bugs and gotchas. For more information see a |
| 400 | thread on comp.lang.python in May 2002 entitled "Building |
| 401 | Python on Cray T3E". |
| 402 | |
| 403 | 1) Use Cray's cc and not gcc. The latter was reported not to |
| 404 | work by Konrad Hinsen. It may work now, but it may not. |
| 405 | |
| 406 | 2) To set sys.platform to something sensible, pass the |
| 407 | following environment variable to the configure script: |
| 408 | |
| 409 | MACHDEP=unicosmk |
| 410 | |
| 411 | 2) Run configure with option "--enable-unicode=ucs4". |
| 412 | |
| 413 | 3) The Cray T3E does not support dynamic linking, so extension |
| 414 | modules have to be built by adding (or uncommenting) lines |
| 415 | in Modules/Setup. The minimum set of modules is |
| 416 | |
| 417 | posix, new, _sre, unicodedata |
| 418 | |
| 419 | On NIWA's vanilla T3E system the following have also been |
| 420 | included successfully: |
| 421 | |
| 422 | _codecs, _locale, _socket, _symtable, _testcapi, _weakref |
| 423 | array, binascii, cmath, cPickle, crypt, cStringIO, dbm |
| 424 | errno, fcntl, grp, math, md5, operator, parser, pcre, pwd |
| 425 | regex, rotor, select, struct, strop, syslog, termios |
| 426 | time, timing, xreadlines |
| 427 | |
| 428 | 4) Once the python executable and library have been built, make |
| 429 | will execute setup.py, which will attempt to build remaining |
| 430 | extensions and link them dynamically. Each of these attempts |
| 431 | will fail but should not halt the make process. This is |
| 432 | normal. |
| 433 | |
| 434 | 5) Running "make test" uses a lot of resources and causes |
| 435 | problems on our system. You might want to try running tests |
| 436 | singly or in small groups. |
Guido van Rossum | 1bf0bf4 | 1997-08-20 23:50:51 | [diff] [blame] | 437 | |
Guido van Rossum | 0078aaf | 1997-08-21 03:05:11 | [diff] [blame] | 438 | SGI: SGI's standard "make" utility (/bin/make or /usr/bin/make) |
| 439 | does not check whether a command actually changed the file it |
| 440 | is supposed to build. This means that whenever you say "make" |
| 441 | it will redo the link step. The remedy is to use SGI's much |
Guido van Rossum | 7be8ca0 | 2001-04-14 13:09:53 | [diff] [blame] | 442 | smarter "smake" utility (/usr/sbin/smake), or GNU make. If |
Guido van Rossum | c0be2f5 | 1997-10-08 05:05:28 | [diff] [blame] | 443 | you set the first line of the Makefile to #!/usr/sbin/smake |
| 444 | smake will be invoked by make (likewise for GNU make). |
Guido van Rossum | 0078aaf | 1997-08-21 03:05:11 | [diff] [blame] | 445 | |
Guido van Rossum | 7be8ca0 | 2001-04-14 13:09:53 | [diff] [blame] | 446 | WARNING: There are bugs in the optimizer of some versions of |
| 447 | SGI's compilers that can cause bus errors or other strange |
| 448 | behavior, especially on numerical operations. To avoid this, |
| 449 | try building with "make OPT=". |
Fred Drake | 0b5fb2b | 2000-09-29 17:45:05 | [diff] [blame] | 450 | |
Guido van Rossum | 6477380 | 1997-11-26 17:07:02 | [diff] [blame] | 451 | OS/2: If you are running Warp3 or Warp4 and have IBM's VisualAge C/C++ |
| 452 | compiler installed, just change into the pc\os2vacpp directory |
| 453 | and type NMAKE. Threading and sockets are supported by default |
| 454 | in the resulting binaries of PYTHON15.DLL and PYTHON.EXE. |
| 455 | |
Fred Drake | 36ed560 | 2000-10-06 01:58:48 | [diff] [blame] | 456 | Monterey (64-bit AIX): The current Monterey C compiler (Visual Age) |
| 457 | uses the OBJECT_MODE={32|64} environment variable to set the |
| 458 | compilation mode to either 32-bit or 64-bit (32-bit mode is |
| 459 | the default). Presumably you want 64-bit compilation mode for |
| 460 | this 64-bit OS. As a result you must first set OBJECT_MODE=64 |
| 461 | in your environment before configuring (./configure) or |
| 462 | building (make) Python on Monterey. |
| 463 | |
| 464 | Reliant UNIX: The thread support does not compile on Reliant UNIX, and |
| 465 | there is a (minor) problem in the configure script for that |
| 466 | platform as well. This should be resolved in time for a |
| 467 | future release. |
Trent Mick | 635f6fb | 2000-08-23 21:33:05 | [diff] [blame] | 468 | |
Barry Warsaw | b606e3d | 2002-10-14 18:03:04 | [diff] [blame] | 469 | MacOSX: The tests will crash on both 10.1 and 10.2 with SEGV in |
Barry Warsaw | 9edaba6 | 2002-10-14 18:13:24 | [diff] [blame] | 470 | test_re and test_sre due to the small default stack size. If |
| 471 | you set the stack size to 2048 before doing a "make test" the |
| 472 | failure can be avoided. If you're using the tcsh (the default |
Jack Jansen | 8b4226b | 2003-05-20 21:49:31 | [diff] [blame] | 473 | on OSX), or csh shells use "limit stacksize 2048"; for the |
| 474 | bash or zsh shells, use "ulimit -s 2048". |
Barry Warsaw | 0655745 | 2001-12-14 20:47:12 | [diff] [blame] | 475 | |
Jack Jansen | 6a77cf1 | 2001-12-06 21:49:02 | [diff] [blame] | 476 | On naked Darwin you may want to add the configure option |
Jack Jansen | 4c398fd | 2001-10-08 13:21:15 | [diff] [blame] | 477 | "--disable-toolbox-glue" to disable the glue code for the Carbon |
Jack Jansen | 6a77cf1 | 2001-12-06 21:49:02 | [diff] [blame] | 478 | interface modules. The modules themselves are currently only built |
| 479 | if you add the --enable-framework option, see below. |
Barry Warsaw | 0655745 | 2001-12-14 20:47:12 | [diff] [blame] | 480 | |
| 481 | On a clean OSX /usr/local does not exist. Do a |
| 482 | "sudo mkdir -m 775 /usr/local" |
Jack Jansen | 6a77cf1 | 2001-12-06 21:49:02 | [diff] [blame] | 483 | before you do a make install. Alternatively, do "sudo make install" |
Jack Jansen | f8197d4 | 2001-11-12 14:11:13 | [diff] [blame] | 484 | which installs everything as superuser. |
Barry Warsaw | 0655745 | 2001-12-14 20:47:12 | [diff] [blame] | 485 | |
| 486 | You may want to try the configure option "--enable-framework" |
| 487 | which installs Python as a framework. The location can be set |
| 488 | as argument to the --enable-framework option (default |
| 489 | /Library/Frameworks). You may also want to check out ./Mac/OSX |
| 490 | for building a Python.app. You may also want to manually |
| 491 | install a symlink in /usr/local/bin/python to the executable |
| 492 | deep down in the framework. |
Fred Drake | dabed75 | 2001-02-01 19:41:13 | [diff] [blame] | 493 | |
Michael W. Hudson | 1c4523f | 2001-12-19 19:49:58 | [diff] [blame] | 494 | Cygwin: With recent (relative to the time of writing, 2001-12-19) |
| 495 | Cygwin installations, there are problems with the interaction |
| 496 | of dynamic linking and fork(). This manifests itself in build |
| 497 | failures during the execution of setup.py. |
Tim Peters | 42fc7cc | 2001-04-04 18:35:19 | [diff] [blame] | 498 | |
Michael W. Hudson | 1c4523f | 2001-12-19 19:49:58 | [diff] [blame] | 499 | There are two workarounds that both enable Python (albeit |
| 500 | without threading support) to build and pass all tests on |
| 501 | NT/2000 (and most likely XP as well, though reports of testing |
| 502 | on XP would be appreciated). |
Guido van Rossum | 16e809e | 2001-04-16 02:07:08 | [diff] [blame] | 503 | |
Michael W. Hudson | 1c4523f | 2001-12-19 19:49:58 | [diff] [blame] | 504 | The workarounds: |
| 505 | |
| 506 | (a) the band-aid fix is to link the _socket module statically |
| 507 | rather than dynamically (which is the default). |
| 508 | |
| 509 | To do this, run "./configure --with-threads=no" including any |
| 510 | other options you need (--prefix, etc.). Then in Modules/Setup |
| 511 | uncomment the lines: |
Tim Peters | 42fc7cc | 2001-04-04 18:35:19 | [diff] [blame] | 512 | |
Michael W. Hudson | be5ce18 | 2001-12-12 11:46:52 | [diff] [blame] | 513 | #SSL=/usr/local/ssl |
| 514 | #_socket socketmodule.c \ |
| 515 | # -DUSE_SSL -I$(SSL)/include -I$(SSL)/include/openssl \ |
| 516 | # -L$(SSL)/lib -lssl -lcrypto |
Guido van Rossum | 16e809e | 2001-04-16 02:07:08 | [diff] [blame] | 517 | |
Michael W. Hudson | 1c4523f | 2001-12-19 19:49:58 | [diff] [blame] | 518 | and remove "local/" from the SSL variable. Finally, just run |
| 519 | "make"! |
Tim Peters | 42fc7cc | 2001-04-04 18:35:19 | [diff] [blame] | 520 | |
Michael W. Hudson | b655464 | 2001-12-19 22:09:09 | [diff] [blame] | 521 | (b) The "proper" fix is to rebase the Cygwin DLLs to prevent |
Michael W. Hudson | 1c4523f | 2001-12-19 19:49:58 | [diff] [blame] | 522 | base address conflicts. Details on how to do this can be |
| 523 | found in the following mail: |
| 524 | |
| 525 | http://sources.redhat.com/ml/cygwin/2001-12/msg00894.html |
| 526 | |
| 527 | It is hoped that a version of this solution will be |
Michael W. Hudson | b655464 | 2001-12-19 22:09:09 | [diff] [blame] | 528 | incorporated into the Cygwin distribution fairly soon. |
Michael W. Hudson | 1c4523f | 2001-12-19 19:49:58 | [diff] [blame] | 529 | |
| 530 | Two additional problems: |
| 531 | |
| 532 | (1) Threading support should still be disabled due to a known |
| 533 | bug in Cygwin pthreads that causes test_threadedtempfile to |
| 534 | hang. |
| 535 | |
Neal Norwitz | 4ebde09 | 2001-12-19 20:44:13 | [diff] [blame] | 536 | (2) The _curses module does not build. This is a known |
Michael W. Hudson | 1c4523f | 2001-12-19 19:49:58 | [diff] [blame] | 537 | Cygwin ncurses problem that should be resolved the next time |
| 538 | that this package is released. |
Guido van Rossum | 16e809e | 2001-04-16 02:07:08 | [diff] [blame] | 539 | |
Michael W. Hudson | be5ce18 | 2001-12-12 11:46:52 | [diff] [blame] | 540 | On older versions of Cygwin, test_poll may hang and test_strftime |
| 541 | may fail. |
Tim Peters | 42fc7cc | 2001-04-04 18:35:19 | [diff] [blame] | 542 | |
Michael W. Hudson | 1c4523f | 2001-12-19 19:49:58 | [diff] [blame] | 543 | The situation on 9X/Me is not accurately known at present. |
| 544 | Some time ago, there were reports that the following |
| 545 | regression tests failed: |
Tim Peters | 42fc7cc | 2001-04-04 18:35:19 | [diff] [blame] | 546 | |
| 547 | test_pwd |
| 548 | test_select (hang) |
| 549 | test_socket |
| 550 | |
Michael W. Hudson | 1c4523f | 2001-12-19 19:49:58 | [diff] [blame] | 551 | Due to the test_select hang on 9X/Me, one should run the |
| 552 | regression test using the following: |
Tim Peters | 42fc7cc | 2001-04-04 18:35:19 | [diff] [blame] | 553 | |
Michael W. Hudson | be5ce18 | 2001-12-12 11:46:52 | [diff] [blame] | 554 | make TESTOPTS='-l -x test_select' test |
Tim Peters | 42fc7cc | 2001-04-04 18:35:19 | [diff] [blame] | 555 | |
Michael W. Hudson | 1c4523f | 2001-12-19 19:49:58 | [diff] [blame] | 556 | News regarding these platforms with more recent Cygwin |
| 557 | versions would be appreciated! |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 558 | |
Guido van Rossum | dc8a3cb | 1998-05-12 15:29:18 | [diff] [blame] | 559 | Configuring threads |
| 560 | ------------------- |
| 561 | |
Guido van Rossum | 7ac1153 | 2000-08-29 21:36:40 | [diff] [blame] | 562 | As of Python 2.0, threads are enabled by default. If you wish to |
| 563 | compile without threads, or if your thread support is broken, pass the |
| 564 | --with-threads=no switch to configure. Unfortunately, on some |
| 565 | platforms, additional compiler and/or linker options are required for |
| 566 | threads to work properly. Below is a table of those options, |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 567 | collected by Bill Janssen. We would love to automate this process |
Guido van Rossum | 7ac1153 | 2000-08-29 21:36:40 | [diff] [blame] | 568 | more, but the information below is not enough to write a patch for the |
| 569 | configure.in file, so manual intervention is required. If you patch |
| 570 | the configure.in file and are confident that the patch works, please |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 571 | send in the patch. (Don't bother patching the configure script itself |
Guido van Rossum | 7ac1153 | 2000-08-29 21:36:40 | [diff] [blame] | 572 | -- it is regenerated each the configure.in file changes.) |
Guido van Rossum | dc8a3cb | 1998-05-12 15:29:18 | [diff] [blame] | 573 | |
| 574 | Compiler switches for threads |
| 575 | ............................. |
| 576 | |
Martin v. Löwis | 1c24f9c | 2001-03-06 12:07:27 | [diff] [blame] | 577 | The definition of _REENTRANT should be configured automatically, if |
| 578 | that does not work on your system, or if _REENTRANT is defined |
| 579 | incorrectly, please report that as a bug. |
Guido van Rossum | dc8a3cb | 1998-05-12 15:29:18 | [diff] [blame] | 580 | |
Martin v. Löwis | 1c24f9c | 2001-03-06 12:07:27 | [diff] [blame] | 581 | OS/Compiler/threads Switches for use with threads |
| 582 | (POSIX is draft 10, DCE is draft 4) compile & link |
| 583 | |
| 584 | SunOS 5.{1-5}/{gcc,SunPro cc}/solaris -mt |
| 585 | SunOS 5.5/{gcc,SunPro cc}/POSIX (nothing) |
Guido van Rossum | 16e809e | 2001-04-16 02:07:08 | [diff] [blame] | 586 | DEC OSF/1 3.x/cc/DCE -threads |
Guido van Rossum | dc8a3cb | 1998-05-12 15:29:18 | [diff] [blame] | 587 | (butenhof@zko.dec.com) |
Guido van Rossum | 16e809e | 2001-04-16 02:07:08 | [diff] [blame] | 588 | Digital UNIX 4.x/cc/DCE -threads |
Guido van Rossum | dc8a3cb | 1998-05-12 15:29:18 | [diff] [blame] | 589 | (butenhof@zko.dec.com) |
Guido van Rossum | 16e809e | 2001-04-16 02:07:08 | [diff] [blame] | 590 | Digital UNIX 4.x/cc/POSIX -pthread |
Guido van Rossum | dc8a3cb | 1998-05-12 15:29:18 | [diff] [blame] | 591 | (butenhof@zko.dec.com) |
Guido van Rossum | 16e809e | 2001-04-16 02:07:08 | [diff] [blame] | 592 | AIX 4.1.4/cc_r/d7 (nothing) |
Guido van Rossum | dc8a3cb | 1998-05-12 15:29:18 | [diff] [blame] | 593 | (buhrt@iquest.net) |
Guido van Rossum | 16e809e | 2001-04-16 02:07:08 | [diff] [blame] | 594 | AIX 4.1.4/cc_r4/DCE (nothing) |
Guido van Rossum | dc8a3cb | 1998-05-12 15:29:18 | [diff] [blame] | 595 | (buhrt@iquest.net) |
Guido van Rossum | 16e809e | 2001-04-16 02:07:08 | [diff] [blame] | 596 | IRIX 6.2/cc/POSIX (nothing) |
Guido van Rossum | dc8a3cb | 1998-05-12 15:29:18 | [diff] [blame] | 597 | (robertl@cwi.nl) |
| 598 | |
| 599 | |
| 600 | Linker (ld) libraries and flags for threads |
| 601 | ........................................... |
| 602 | |
| 603 | OS/threads Libraries/switches for use with threads |
| 604 | |
| 605 | SunOS 5.{1-5}/solaris -lthread |
| 606 | SunOS 5.5/POSIX -lpthread |
Guido van Rossum | 16e809e | 2001-04-16 02:07:08 | [diff] [blame] | 607 | DEC OSF/1 3.x/DCE -lpthreads -lmach -lc_r -lc |
Guido van Rossum | dc8a3cb | 1998-05-12 15:29:18 | [diff] [blame] | 608 | (butenhof@zko.dec.com) |
| 609 | Digital UNIX 4.x/DCE -lpthreads -lpthread -lmach -lexc -lc |
| 610 | (butenhof@zko.dec.com) |
Guido van Rossum | 16e809e | 2001-04-16 02:07:08 | [diff] [blame] | 611 | Digital UNIX 4.x/POSIX -lpthread -lmach -lexc -lc |
Guido van Rossum | dc8a3cb | 1998-05-12 15:29:18 | [diff] [blame] | 612 | (butenhof@zko.dec.com) |
Guido van Rossum | 16e809e | 2001-04-16 02:07:08 | [diff] [blame] | 613 | AIX 4.1.4/{draft7,DCE} (nothing) |
Guido van Rossum | dc8a3cb | 1998-05-12 15:29:18 | [diff] [blame] | 614 | (buhrt@iquest.net) |
Guido van Rossum | 16e809e | 2001-04-16 02:07:08 | [diff] [blame] | 615 | IRIX 6.2/POSIX -lpthread |
Guido van Rossum | dc8a3cb | 1998-05-12 15:29:18 | [diff] [blame] | 616 | (jph@emilia.engr.sgi.com) |
| 617 | |
| 618 | |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 619 | Configuring additional built-in modules |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 620 | --------------------------------------- |
Guido van Rossum | 19e0c26 | 1995-01-17 16:36:34 | [diff] [blame] | 621 | |
Andrew M. Kuchling | ebe3045 | 2001-02-27 03:24:24 | [diff] [blame] | 622 | Starting with Python 2.1, the setup.py script at the top of the source |
| 623 | distribution attempts to detect which modules can be built and |
| 624 | automatically compiles them. Autodetection doesn't always work, so |
Michael W. Hudson | 45c44fb | 2002-02-22 13:50:51 | [diff] [blame] | 625 | you can still customize the configuration by editing the Modules/Setup |
| 626 | file; but this should be considered a last resort. The rest of this |
| 627 | section only applies if you decide to edit the Modules/Setup file. |
| 628 | You also need this to enable static linking of certain modules (which |
| 629 | is needed to enable profiling on some systems). |
| 630 | |
Andrew M. Kuchling | ebe3045 | 2001-02-27 03:24:24 | [diff] [blame] | 631 | This file is initially copied from Setup.dist by the configure script; |
| 632 | if it does not exist yet, create it by copying Modules/Setup.dist |
| 633 | yourself (configure will never overwrite it). Never edit Setup.dist |
| 634 | -- always edit Setup or Setup.local (see below). Read the comments in |
| 635 | the file for information on what kind of edits are allowed. When you |
| 636 | have edited Setup in the Modules directory, the interpreter will |
Guido van Rossum | ef67ded | 2001-10-05 17:04:42 | [diff] [blame] | 637 | automatically be rebuilt the next time you run make (in the toplevel |
| 638 | directory). |
Guido van Rossum | 627b2d7 | 1993-12-24 10:39:16 | [diff] [blame] | 639 | |
Andrew M. Kuchling | ebe3045 | 2001-02-27 03:24:24 | [diff] [blame] | 640 | Many useful modules can be built on any Unix system, but some optional |
| 641 | modules can't be reliably autodetected. Often the quickest way to |
| 642 | determine whether a particular module works or not is to see if it |
| 643 | will build: enable it in Setup, then if you get compilation or link |
Fred Drake | 6caae14 | 2000-10-25 17:51:02 | [diff] [blame] | 644 | errors, disable it -- you're either missing support or need to adjust |
| 645 | the compilation and linking parameters for that module. |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 646 | |
| 647 | On SGI IRIX, there are modules that interface to many SGI specific |
Andrew M. Kuchling | ebe3045 | 2001-02-27 03:24:24 | [diff] [blame] | 648 | system libraries, e.g. the GL library and the audio hardware. These |
| 649 | modules will not be built by the setup.py script. |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 650 | |
Guido van Rossum | 4462e93 | 1997-01-22 21:00:32 | [diff] [blame] | 651 | In addition to the file Setup, you can also edit the file Setup.local. |
| 652 | (the makesetup script processes both). You may find it more |
| 653 | convenient to edit Setup.local and leave Setup alone. Then, when |
| 654 | installing a new Python version, you can copy your old Setup.local |
| 655 | file. |
| 656 | |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 657 | |
| 658 | Setting the optimization/debugging options |
| 659 | ------------------------------------------ |
| 660 | |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 661 | If you want or need to change the optimization/debugging options for |
| 662 | the C compiler, assign to the OPT variable on the toplevel make |
| 663 | command; e.g. "make OPT=-g" will build a debugging version of Python |
| 664 | on most platforms. The default is OPT=-O; a value for OPT in the |
| 665 | environment when the configure script is run overrides this default |
| 666 | (likewise for CC; and the initial value for LIBS is used as the base |
| 667 | set of libraries to link with). |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 668 | |
Fred Drake | 6caae14 | 2000-10-25 17:51:02 | [diff] [blame] | 669 | When compiling with GCC, the default value of OPT will also include |
| 670 | the -Wall and -Wstrict-prototypes options. |
| 671 | |
| 672 | Additional debugging code to help debug memory management problems can |
| 673 | be enabled by using the --with-pydebug option to the configure script. |
| 674 | |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 675 | |
Guido van Rossum | a68ca35 | 2001-10-04 17:00:07 | [diff] [blame] | 676 | Profiling |
| 677 | --------- |
| 678 | |
| 679 | If you want C profiling turned on, the easiest way is to run configure |
| 680 | with the CC environment variable to the necessary compiler |
| 681 | invocation. For example, on Linux, this works for profiling using |
| 682 | gprof(1): |
| 683 | |
| 684 | CC="gcc -pg" ./configure |
| 685 | |
| 686 | Note that on Linux, gprof apparently does not work for shared |
| 687 | libraries. The Makefile/Setup mechanism can be used to compile and |
| 688 | link most extension module statically. |
| 689 | |
| 690 | |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 691 | Testing |
| 692 | ------- |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 | [diff] [blame] | 693 | |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 694 | To test the interpreter, type "make test" in the top-level directory. |
Guido van Rossum | 6ae5d3d | 1997-05-14 21:39:05 | [diff] [blame] | 695 | This runs the test set twice (once with no compiled files, once with |
| 696 | the compiled files left by the previous test run). The test set |
| 697 | produces some output. You can generally ignore the messages about |
Michael W. Hudson | 45c44fb | 2002-02-22 13:50:51 | [diff] [blame] | 698 | skipped tests due to optional features which can't be imported. |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 699 | If a message is printed about a failed test or a traceback or core |
| 700 | dump is produced, something is wrong. On some Linux systems (those |
Guido van Rossum | 24df684 | 1997-12-30 04:32:30 | [diff] [blame] | 701 | that are not yet using glibc 6), test_strftime fails due to a |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 702 | non-standard implementation of strftime() in the C library. Please |
| 703 | ignore this, or upgrade to glibc version 6. |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 | [diff] [blame] | 704 | |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 705 | IMPORTANT: If the tests fail and you decide to mail a bug report, |
| 706 | *don't* include the output of "make test". It is useless. Run the |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 707 | failing test manually, as follows: |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 708 | |
Michael W. Hudson | 777f143 | 2002-03-25 13:15:52 | [diff] [blame] | 709 | ./python ./Lib/test/test_whatever.py |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 710 | |
Michael W. Hudson | 777f143 | 2002-03-25 13:15:52 | [diff] [blame] | 711 | (substituting the top of the source tree for '.' if you built in a |
Guido van Rossum | 6ae5d3d | 1997-05-14 21:39:05 | [diff] [blame] | 712 | different directory). This runs the test in verbose mode. |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 713 | |
| 714 | |
| 715 | Installing |
| 716 | ---------- |
| 717 | |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 718 | To install the Python binary, library modules, shared library modules |
| 719 | (see below), include files, configuration files, and the manual page, |
Guido van Rossum | 6477380 | 1997-11-26 17:07:02 | [diff] [blame] | 720 | just type |
| 721 | |
| 722 | make install |
| 723 | |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 724 | This will install all platform-independent files in subdirectories of |
| 725 | the directory given with the --prefix option to configure or to the |
| 726 | `prefix' Make variable (default /usr/local). All binary and other |
| 727 | platform-specific files will be installed in subdirectories if the |
| 728 | directory given by --exec-prefix or the `exec_prefix' Make variable |
| 729 | (defaults to the --prefix directory) is given. |
Guido van Rossum | 6477380 | 1997-11-26 17:07:02 | [diff] [blame] | 730 | |
| 731 | All subdirectories created will have Python's version number in their |
| 732 | name, e.g. the library modules are installed in |
Guido van Rossum | 67345eb | 2001-01-18 14:51:12 | [diff] [blame] | 733 | "/usr/local/lib/python<version>/" by default, where <version> is the |
| 734 | <major>.<minor> release number (e.g. "2.1"). The Python binary is |
| 735 | installed as "python<version>" and a hard link named "python" is |
| 736 | created. The only file not installed with a version number in its |
| 737 | name is the manual page, installed as "/usr/local/man/man1/python.1" |
| 738 | by default. |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 | [diff] [blame] | 739 | |
Neil Schemenauer | 0e91dc7 | 2001-02-16 04:18:08 | [diff] [blame] | 740 | If you have a previous installation of Python that you don't |
Guido van Rossum | 6477380 | 1997-11-26 17:07:02 | [diff] [blame] | 741 | want to replace yet, use |
| 742 | |
| 743 | make altinstall |
| 744 | |
| 745 | This installs the same set of files as "make install" except it |
Guido van Rossum | 67345eb | 2001-01-18 14:51:12 | [diff] [blame] | 746 | doesn't create the hard link to "python<version>" named "python" and |
| 747 | it doesn't install the manual page at all. |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 748 | |
Neil Schemenauer | 0e91dc7 | 2001-02-16 04:18:08 | [diff] [blame] | 749 | Alpha/beta revision levels are stripped from the executable and |
| 750 | library filenames during installation. For example, Python2.1a2 will |
| 751 | install as python2.1, overwriting the previous python2.1. To avoid |
| 752 | this, you could set the Makefile VERSION variable manually |
| 753 | (e.g. VERSION=2.1a2) before running "make install" or "make altinstall". |
| 754 | |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 755 | The only thing you may have to install manually is the Python mode for |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 756 | Emacs found in Misc/python-mode.el. (But then again, more recent |
| 757 | versions of Emacs may already have it.) Follow the instructions that |
| 758 | came with Emacs for installation of site-specific files. |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 | [diff] [blame] | 759 | |
Jack Jansen | a39ef86 | 2001-08-19 21:17:03 | [diff] [blame] | 760 | On Mac OS X, if you have configured Python with --enable-framework, you |
| 761 | should use "make frameworkinstall" to do the installation. Note that this |
| 762 | installs the Python executable in a place that is not normally on your |
| 763 | PATH, you may want to set up a symlink in /usr/local/bin. |
| 764 | |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 765 | |
| 766 | Configuration options and variables |
| 767 | ----------------------------------- |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 | [diff] [blame] | 768 | |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 769 | Some special cases are handled by passing options to the configure |
| 770 | script. |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 | [diff] [blame] | 771 | |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 772 | WARNING: if you rerun the configure script with different options, you |
| 773 | must run "make clean" before rebuilding. Exceptions to this rule: |
| 774 | after changing --prefix or --exec-prefix, all you need to do is remove |
Guido van Rossum | b06df27 | 1997-08-05 21:50:20 | [diff] [blame] | 775 | Modules/getpath.o. |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 | [diff] [blame] | 776 | |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 777 | --with(out)-gcc: The configure script uses gcc (the GNU C compiler) if |
| 778 | it finds it. If you don't want this, or if this compiler is |
| 779 | installed but broken on your platform, pass the option |
| 780 | --without-gcc. You can also pass "CC=cc" (or whatever the |
| 781 | name of the proper C compiler is) in the environment, but the |
| 782 | advantage of using --without-gcc is that this option is |
| 783 | remembered by the config.status script for its --recheck |
| 784 | option. |
Guido van Rossum | 76be6ed | 1995-01-02 18:33:54 | [diff] [blame] | 785 | |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 786 | --prefix, --exec-prefix: If you want to install the binaries and the |
| 787 | Python library somewhere else than in /usr/local/{bin,lib}, |
| 788 | you can pass the option --prefix=DIRECTORY; the interpreter |
| 789 | binary will be installed as DIRECTORY/bin/python and the |
| 790 | library files as DIRECTORY/lib/python/*. If you pass |
| 791 | --exec-prefix=DIRECTORY (as well) this overrides the |
| 792 | installation prefix for architecture-dependent files (like the |
| 793 | interpreter binary). Note that --prefix=DIRECTORY also |
| 794 | affects the default module search path (sys.path), when |
| 795 | Modules/config.c is compiled. Passing make the option |
| 796 | prefix=DIRECTORY (and/or exec_prefix=DIRECTORY) overrides the |
| 797 | prefix set at configuration time; this may be more convenient |
| 798 | than re-running the configure script if you change your mind |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 799 | about the install prefix. |
Guido van Rossum | 76be6ed | 1995-01-02 18:33:54 | [diff] [blame] | 800 | |
Michael W. Hudson | 45c44fb | 2002-02-22 13:50:51 | [diff] [blame] | 801 | --with-readline: This option is no longer supported. GNU |
| 802 | readline is automatically enabled by setup.py when present. |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 803 | |
Guido van Rossum | 7ac1153 | 2000-08-29 21:36:40 | [diff] [blame] | 804 | --with-threads: On most Unix systems, you can now use multiple |
| 805 | threads, and support for this is enabled by default. To |
| 806 | disable this, pass --with-threads=no. If the library required |
| 807 | for threads lives in a peculiar place, you can use |
| 808 | --with-thread=DIRECTORY. IMPORTANT: run "make clean" after |
| 809 | changing (either enabling or disabling) this option, or you |
| 810 | will get link errors! Note: for DEC Unix use |
Guido van Rossum | 0e13da9 | 1998-02-22 04:36:34 | [diff] [blame] | 811 | --with-dec-threads instead. |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 812 | |
| 813 | --with-sgi-dl: On SGI IRIX 4, dynamic loading of extension modules is |
| 814 | supported by the "dl" library by Jack Jansen, which is |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 815 | ftp'able from ftp://ftp.cwi.nl/pub/dynload/dl-1.6.tar.Z. |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 816 | This is enabled (after you've ftp'ed and compiled the dl |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 817 | library) by passing --with-sgi-dl=DIRECTORY where DIRECTORY |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 818 | is the absolute pathname of the dl library. (Don't bother on |
| 819 | IRIX 5, it already has dynamic linking using SunOS style |
| 820 | shared libraries.) Support for this feature is deprecated. |
| 821 | |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 822 | --with-dl-dld: Dynamic loading of modules is rumored to be supported |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 823 | on some other systems: VAX (Ultrix), Sun3 (SunOS 3.4), Sequent |
| 824 | Symmetry (Dynix), and Atari ST. This is done using a |
| 825 | combination of the GNU dynamic loading package |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 826 | (ftp://ftp.cwi.nl/pub/dynload/dl-dld-1.1.tar.Z) and an |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 827 | emulation of the SGI dl library mentioned above (the emulation |
| 828 | can be found at |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 829 | ftp://ftp.cwi.nl/pub/dynload/dld-3.2.3.tar.Z). To |
Guido van Rossum | 16e809e | 2001-04-16 02:07:08 | [diff] [blame] | 830 | enable this, ftp and compile both libraries, then call |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 831 | configure, passing it the option |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 832 | --with-dl-dld=DL_DIRECTORY,DLD_DIRECTORY where DL_DIRECTORY is |
| 833 | the absolute pathname of the dl emulation library and |
| 834 | DLD_DIRECTORY is the absolute pathname of the GNU dld library. |
| 835 | (Don't bother on SunOS 4 or 5, they already have dynamic |
| 836 | linking using shared libraries.) Support for this feature is |
| 837 | deprecated. |
| 838 | |
| 839 | --with-libm, --with-libc: It is possible to specify alternative |
| 840 | versions for the Math library (default -lm) and the C library |
| 841 | (default the empty string) using the options |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 842 | --with-libm=STRING and --with-libc=STRING, respectively. For |
| 843 | example, if your system requires that you pass -lc_s to the C |
| 844 | compiler to use the shared C library, you can pass |
| 845 | --with-libc=-lc_s. These libraries are passed after all other |
| 846 | libraries, the C library last. |
Guido van Rossum | 16e809e | 2001-04-16 02:07:08 | [diff] [blame] | 847 | |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 848 | --with-libs='libs': Add 'libs' to the LIBS that the python interpreter |
| 849 | is linked against. |
Guido van Rossum | d02ba45 | 1996-07-31 17:36:01 | [diff] [blame] | 850 | |
Martin v. Löwis | 2df6694 | 2000-12-13 14:14:32 | [diff] [blame] | 851 | --with-cxx=<compiler>: Some C++ compilers require that main() is |
| 852 | compiled with the C++ if there is any C++ code in the application. |
| 853 | Specifically, g++ on a.out systems may require that to support |
| 854 | construction of global objects. With this option, the main() function |
| 855 | of Python will be compiled with <compiler>; use that only if you |
| 856 | plan to use C++ extension modules, and if your compiler requires |
| 857 | compilation of main() as a C++ program. |
| 858 | |
| 859 | |
Fred Drake | 6caae14 | 2000-10-25 17:51:02 | [diff] [blame] | 860 | --with-pydebug: Enable additional debugging code to help track down |
| 861 | memory management problems. This allows printing a list of all |
| 862 | live objects when the interpreter terminates. |
| 863 | |
Guido van Rossum | 76be6ed | 1995-01-02 18:33:54 | [diff] [blame] | 864 | |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 | [diff] [blame] | 865 | Building for multiple architectures (using the VPATH feature) |
| 866 | ------------------------------------------------------------- |
| 867 | |
| 868 | If your file system is shared between multiple architectures, it |
| 869 | usually is not necessary to make copies of the sources for each |
| 870 | architecture you want to support. If the make program supports the |
| 871 | VPATH feature, you can create an empty build directory for each |
| 872 | architecture, and in each directory run the configure script (on the |
| 873 | appropriate machine with the appropriate options). This creates the |
| 874 | necessary subdirectories and the Makefiles therein. The Makefiles |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 875 | contain a line VPATH=... which points to a directory containing the |
Guido van Rossum | d0fe845 | 1996-08-26 03:02:37 | [diff] [blame] | 876 | actual sources. (On SGI systems, use "smake -J1" instead of "make" if |
| 877 | you use VPATH -- don't try gnumake.) |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 | [diff] [blame] | 878 | |
| 879 | For example, the following is all you need to build a minimal Python |
| 880 | in /usr/tmp/python (assuming ~guido/src/python is the toplevel |
| 881 | directory and you want to build in /usr/tmp/python): |
| 882 | |
| 883 | $ mkdir /usr/tmp/python |
| 884 | $ cd /usr/tmp/python |
| 885 | $ ~guido/src/python/configure |
| 886 | [...] |
| 887 | $ make |
| 888 | [...] |
| 889 | $ |
| 890 | |
Neil Schemenauer | 73f8ab2 | 2001-01-26 22:18:55 | [diff] [blame] | 891 | Note that configure copies the original Setup file to the build |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 | [diff] [blame] | 892 | directory if it finds no Setup file there. This means that you can |
| 893 | edit the Setup file for each architecture independently. For this |
| 894 | reason, subsequent changes to the original Setup file are not tracked |
| 895 | automatically, as they might overwrite local changes. To force a copy |
| 896 | of a changed original Setup file, delete the target Setup file. (The |
| 897 | makesetup script supports multiple input files, so if you want to be |
| 898 | fancy you can change the rules to create an empty Setup.local if it |
| 899 | doesn't exist and run it with arguments $(srcdir)/Setup Setup.local; |
| 900 | however this assumes that you only need to add modules.) |
| 901 | |
| 902 | |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 | [diff] [blame] | 903 | Building on non-UNIX systems |
| 904 | ---------------------------- |
| 905 | |
Tim Peters | 0344424 | 2000-09-19 00:38:35 | [diff] [blame] | 906 | For Windows (2000/NT/ME/98/95), assuming you have MS VC++ 6.0, the |
| 907 | project files are in PCbuild, the workspace is pcbuild.dsw. See |
| 908 | PCbuild\readme.txt for detailed instructions. |
Guido van Rossum | 8d7d4ed | 1996-07-30 21:41:07 | [diff] [blame] | 909 | |
Guido van Rossum | 31ae207 | 1999-04-12 14:47:30 | [diff] [blame] | 910 | For other non-Unix Windows compilers, in particular Windows 3.1 and |
| 911 | for OS/2, enter the directory "PC" and read the file "readme.txt". |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 912 | |
| 913 | For the Mac, a separate source distribution will be made available, |
| 914 | for use with the CodeWarrior compiler. If you are interested in Mac |
| 915 | development, join the PythonMac Special Interest Group |
| 916 | (http://www.python.org/sigs/pythonmac-sig/, or send email to |
| 917 | pythonmac-sig-request@python.org). |
| 918 | |
| 919 | Of course, there are also binary distributions available for these |
Guido van Rossum | 67345eb | 2001-01-18 14:51:12 | [diff] [blame] | 920 | platforms -- see http://www.python.org/. |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 921 | |
| 922 | To port Python to a new non-UNIX system, you will have to fake the |
| 923 | effect of running the configure script manually (for Mac and PC, this |
| 924 | has already been done for you). A good start is to copy the file |
Fred Drake | 622dca0 | 2002-11-04 20:50:39 | [diff] [blame] | 925 | pyconfig.h.in to pyconfig.h and edit the latter to reflect the actual |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 | [diff] [blame] | 926 | configuration of your system. Most symbols must simply be defined as |
| 927 | 1 only if the corresponding feature is present and can be left alone |
Tim Peters | 4f1b208 | 2000-07-23 21:18:09 | [diff] [blame] | 928 | otherwise; however the *_t type symbols must be defined as some variant |
| 929 | of int if they need to be defined at all. |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 | [diff] [blame] | 930 | |
Barry Warsaw | 0655745 | 2001-12-14 20:47:12 | [diff] [blame] | 931 | For all platforms, it's important that the build arrange to define the |
| 932 | preprocessor symbol NDEBUG on the compiler command line in a release |
| 933 | build of Python (else assert() calls remain in the code, hurting |
| 934 | release-build performance). The Unix, Windows and Mac builds already |
| 935 | do this. |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 | [diff] [blame] | 936 | |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 937 | |
| 938 | Miscellaneous issues |
| 939 | ==================== |
| 940 | |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 941 | Emacs mode |
| 942 | ---------- |
| 943 | |
Guido van Rossum | c0be2f5 | 1997-10-08 05:05:28 | [diff] [blame] | 944 | There's an excellent Emacs editing mode for Python code; see the file |
| 945 | Misc/python-mode.el. Originally written by the famous Tim Peters, it |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 946 | is now maintained by the equally famous Barry Warsaw (it's no |
Guido van Rossum | 67345eb | 2001-01-18 14:51:12 | [diff] [blame] | 947 | coincidence that they now both work on the same team). The latest |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 948 | version, along with various other contributed Python-related Emacs |
Guido van Rossum | 67345eb | 2001-01-18 14:51:12 | [diff] [blame] | 949 | goodies, is online at http://www.python.org/emacs/python-mode. And |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 950 | if you are planning to edit the Python C code, please pick up the |
Guido van Rossum | 67345eb | 2001-01-18 14:51:12 | [diff] [blame] | 951 | latest version of CC Mode http://www.python.org/emacs/cc-mode; it |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 952 | contains a "python" style used throughout most of the Python C source |
| 953 | files. (Newer versions of Emacs or XEmacs may already come with the |
| 954 | latest version of python-mode.) |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 955 | |
| 956 | |
Michael W. Hudson | 45c44fb | 2002-02-22 13:50:51 | [diff] [blame] | 957 | Tkinter |
| 958 | ------- |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 959 | |
Michael W. Hudson | 45c44fb | 2002-02-22 13:50:51 | [diff] [blame] | 960 | The setup.py script automatically configures this when it detects a |
| 961 | usable Tcl/Tk installation. This requires Tcl/Tk version 8.0 or |
Fred Drake | 8179a9d | 2000-09-28 23:28:30 | [diff] [blame] | 962 | higher. |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 963 | |
Guido van Rossum | 973e4dc | 2000-07-01 00:34:39 | [diff] [blame] | 964 | For more Tkinter information, see the Tkinter Resource page: |
| 965 | http://www.python.org/topics/tkinter/ |
Guido van Rossum | c0be2f5 | 1997-10-08 05:05:28 | [diff] [blame] | 966 | |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 967 | There are demos in the Demo/tkinter directory, in the subdirectories |
| 968 | guido, matt and www (the matt and guido subdirectories have been |
| 969 | overhauled to use more recent Tkinter coding conventions). |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 970 | |
| 971 | Note that there's a Python module called "Tkinter" (capital T) which |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 972 | lives in Lib/lib-tk/Tkinter.py, and a C module called "_tkinter" |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 973 | (lower case t and leading underscore) which lives in |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 974 | Modules/_tkinter.c. Demos and normal Tk applications import only the |
Michael W. Hudson | 45c44fb | 2002-02-22 13:50:51 | [diff] [blame] | 975 | Python Tkinter module -- only the latter imports the C _tkinter |
| 976 | module. In order to find the C _tkinter module, it must be compiled |
| 977 | and linked into the Python interpreter -- the setup.py script does |
| 978 | this. In order to find the Python Tkinter module, sys.path must be |
| 979 | set correctly -- normal installation takes care of this. |
Guido van Rossum | 84c8c7f | 1995-08-28 02:44:24 | [diff] [blame] | 980 | |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 981 | |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 | [diff] [blame] | 982 | Distribution structure |
| 983 | ---------------------- |
| 984 | |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 985 | Most subdirectories have their own README files. Most files have |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 | [diff] [blame] | 986 | comments. |
| 987 | |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 988 | .cvsignore Additional filename matching patterns for CVS to ignore |
| 989 | BeOS/ Files specific to the BeOS port |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 990 | Demo/ Demonstration scripts, modules and programs |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 991 | Doc/ Documentation sources (LaTeX) |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 992 | Grammar/ Input for the parser generator |
| 993 | Include/ Public header files |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 994 | LICENSE Licensing information |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 995 | Lib/ Python library modules |
Neil Schemenauer | 3f52da5 | 2001-01-24 17:49:59 | [diff] [blame] | 996 | Makefile.pre.in Source from which config.status creates the Makefile.pre |
Guido van Rossum | c0be2f5 | 1997-10-08 05:05:28 | [diff] [blame] | 997 | Misc/ Miscellaneous useful files |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 998 | Modules/ Implementation of most built-in modules |
| 999 | Objects/ Implementation of most built-in object types |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 1000 | PC/ Files specific to PC ports (DOS, Windows, OS/2) |
| 1001 | PCbuild/ Build directory for Microsoft Visual C++ |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 1002 | Parser/ The parser and tokenizer and their input handling |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 1003 | Python/ The byte-compiler and interpreter |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 1004 | README The file you're reading now |
| 1005 | Tools/ Some useful programs written in Python |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 1006 | acconfig.h Additional input for the GNU autoheader program |
Fred Drake | 622dca0 | 2002-11-04 20:50:39 | [diff] [blame] | 1007 | pyconfig.h.in Source from which pyconfig.h is created (GNU autoheader output) |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 1008 | configure Configuration shell script (GNU autoconf output) |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 1009 | configure.in Configuration specification (input for GNU autoconf) |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 1010 | install-sh Shell script used to install files |
Guido van Rossum | 91cb9d2 | 1995-04-10 11:47:38 | [diff] [blame] | 1011 | |
| 1012 | The following files will (may) be created in the toplevel directory by |
| 1013 | the configuration and build processes: |
| 1014 | |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 1015 | Makefile Build rules |
Neil Schemenauer | 3f52da5 | 2001-01-24 17:49:59 | [diff] [blame] | 1016 | Makefile.pre Build rules before running Modules/makesetup |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 1017 | buildno Keeps track of the build number |
| 1018 | config.cache Cache of configuration variables |
Fred Drake | 622dca0 | 2002-11-04 20:50:39 | [diff] [blame] | 1019 | pyconfig.h Configuration header |
Guido van Rossum | c0be2f5 | 1997-10-08 05:05:28 | [diff] [blame] | 1020 | config.log Log from last configure run |
Guido van Rossum | 4f40c2d | 2000-09-05 16:46:22 | [diff] [blame] | 1021 | config.status Status from last run of the configure script |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 1022 | getbuildinfo.o Object file from Modules/getbuildinfo.c |
Guido van Rossum | 67345eb | 2001-01-18 14:51:12 | [diff] [blame] | 1023 | libpython<version>.a The library archive |
Guido van Rossum | 6d9cc80 | 1996-08-01 17:31:22 | [diff] [blame] | 1024 | python The executable interpreter |
| 1025 | tags, TAGS Tags files for vi and Emacs |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 | [diff] [blame] | 1026 | |
| 1027 | |
Guido van Rossum | c07d5fa | 2000-09-01 22:50:02 | [diff] [blame] | 1028 | That's all, folks! |
| 1029 | ------------------ |
Guido van Rossum | 433c8ad | 1994-08-01 12:07:07 | [diff] [blame] | 1030 | |
| 1031 | |
Guido van Rossum | 67345eb | 2001-01-18 14:51:12 | [diff] [blame] | 1032 | --Guido van Rossum (home page: http://www.python.org/~guido/) |