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