Blame - README - external/github.com/python/cpython

blob: f173116c1f74776bb01b783a487320db92f556bb [file] [log] [blame]

Anthony Baxter	bd43255	2005-01-25 12:43:57	[diff] [blame]	1	This is Python version 2.4
				2	==========================
Guido van Rossum	9144763	2000-04-11 17:11:09	[diff] [blame]	3
Anthony Baxter	bd43255	2005-01-25 12:43:57	[diff] [blame]	4	Copyright (c) 2001, 2002, 2003, 2004, 2005 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
Guido van Rossum	2dcec0c	2002-02-04 01:59:23	[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	[diff] [blame]	48	The section `Build instructions' below is still recommended reading,
Guido van Rossum	2dcec0c	2002-02-04 01:59:23	[diff] [blame]	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
Skip Montanaro	932dab6	2003-06-12 14:04:33	[diff] [blame]	71	http://www.python.org/cgi-bin/moinmoin/PythonBooks 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
Michael W. Hudson	be6e0f4	2002-06-23 16:29:36	[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	[diff] [blame]	93
Guido van Rossum	1c63a59	2002-07-09 18:44:09	[diff] [blame]	94	http://www.python.org/2.2.1/descrintro.html
Barry Warsaw	0655745	2001-12-14 20:47:12	[diff] [blame]	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
Michael W. Hudson	be6e0f4	2002-06-23 16:29:36	[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	[diff] [blame]	105
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	106
				107	Newsgroups and Mailing Lists
				108	----------------------------
Guido van Rossum	c07d5fa	2000-09-01 22:50:02	[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	[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	[diff] [blame]	115
Michael W. Hudson	be6e0f4	2002-06-23 16:29:36	[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	[diff] [blame]	118	http://www.python.org/psa/MailingLists.html for details.
Guido van Rossum	c07d5fa	2000-09-01 22:50:02	[diff] [blame]	119
				120
				121	Bug reports
				122	-----------
				123
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[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	[diff] [blame]	126
				127
				128	Patches and contributions
				129	-------------------------
				130
Fred Drake	6caae14	2000-10-25 17:51:02	[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	[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
Walter Dörwald	7dc65d6	2003-02-02 23:37:05	[diff] [blame]	137	guidelines for submitting a new PEP, are listed at
Guido van Rossum	c07d5fa	2000-09-01 22:50:02	[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	[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	[diff] [blame]	150
Guido van Rossum	901454e	2000-06-29 22:28:44	[diff] [blame]	151
Guido van Rossum	433c8ad	1994-08-01 12:07:07	[diff] [blame]	152	Build instructions
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	153	==================
Guido van Rossum	627b2d7	1993-12-24 10:39:16	[diff] [blame]	154
Guido van Rossum	59b0b60	2002-02-08 22:22:35	[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	[diff] [blame]	162
Guido van Rossum	59b0b60	2002-02-08 22:22:35	[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	[diff] [blame]	168
Guido van Rossum	59b0b60	2002-02-08 22:22:35	[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	[diff] [blame]	174
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[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	[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	[diff] [blame]	185
Guido van Rossum	0a516c9	1994-09-12 10:58:40	[diff] [blame]	186
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	187	Troubleshooting
				188	---------------
Guido van Rossum	627b2d7	1993-12-24 10:39:16	[diff] [blame]	189
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	190	See also the platform specific notes in the next section.
				191
Guido van Rossum	4952369	1997-08-15 18:30:14	[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	[diff] [blame]	193	(http://www.python.org/cgi-bin/faqw.py or
Guido van Rossum	4952369	1997-08-15 18:30:14	[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	[diff] [blame]	196
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[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	[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	[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	[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	[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	[diff] [blame]	214
Guido van Rossum	7ac1153	2000-08-29 21:36:40	[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
Martin v. Löwis	9cea5f5	2002-11-15 07:28:05	[diff] [blame]	217	optimization. This is a common problem with some versions of gcc, and
				218	some vendor-supplied compilers, which can sometimes be worked around
				219	by turning off optimization. Consider switching to stable versions
Anthony Baxter	e9d719b	2004-11-30 01:49:18	[diff] [blame]	220	(gcc 2.95.2, gcc 3.x, or contact your vendor.)
Guido van Rossum	7ac1153	2000-08-29 21:36:40	[diff] [blame]	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
Martin v. Löwis	9cea5f5	2002-11-15 07:28:05	[diff] [blame]	225	compilers from the vendor, or one of the free compilers (gcc).
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	226
Martin v. Löwis	779ffc0	2002-12-02 22:17:01	[diff] [blame]	227	Unsupported systems
				228	-------------------
				229
Anthony Baxter	28b81a9	2004-12-13 17:09:28	[diff] [blame]	230	A number of features have not been supported since Python 2.3, and
				231	the code to support them was removed in Python 2.4. If you still
				232	need to use current Python versions on these systems, please send
				233	a message to python-dev@python.org indicating that you volunteer
				234	to support this system. There is more detail on this in PEP 11.
Martin v. Löwis	779ffc0	2002-12-02 22:17:01	[diff] [blame]	235
Anthony Baxter	28b81a9	2004-12-13 17:09:28	[diff] [blame]	236	More specifically, the following systems are no longer supported:
				237
Martin v. Löwis	779ffc0	2002-12-02 22:17:01	[diff] [blame]	238	- SunOS 4
				239	- DYNIX
				240	- dgux
				241	- Minix
				242	- Irix 4 and --with-sgi-dl
				243	- Linux 1
				244	- Systems defining __d6_pthread_create (configure.in)
				245	- Systems defining PY_PTHREAD_D4, PY_PTHREAD_D6,
				246	or PY_PTHREAD_D7 in thread_pthread.h
				247	- Systems using --with-dl-dld
Martin v. Löwis	7e4cfcb	2002-12-19 16:21:49	[diff] [blame]	248	- Systems using --without-universal-newlines
Martin v. Löwis	779ffc0	2002-12-02 22:17:01	[diff] [blame]	249
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	250	Platform specific notes
				251	-----------------------
				252
Guido van Rossum	0447a32	1995-10-08 01:22:33	[diff] [blame]	253	(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]	254	on these platforms without the special directions mentioned here,
				255	submit a documentation bug report to SourceForge (see Bug Reports
				256	above) so we can remove them!)
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	257
Skip Montanaro	6dc4a8e	2003-05-02 15:27:59	[diff] [blame]	258	Unix platforms: If your vendor still ships (and you still use) Berkeley DB
				259	1.85 you will need to edit Modules/Setup to build the bsddb185
				260	module and add a line to sitecustomize.py which makes it the
				261	default. In Modules/Setup a line like
				262
				263	bsddb185 bsddbmodule.c
				264
				265	should work. (You may need to add -I, -L or -l flags to direct the
				266	compiler and linker to your include files and libraries.) You can
				267	then force it to be the version people import by adding
				268
				269	import bsddb185 as bsddb
				270
				271	in sitecustomize.py.
				272
Guido van Rossum	c0be2f5	1997-10-08 05:05:28	[diff] [blame]	273	64-bit platforms: The modules audioop, imageop and rgbimg don't work.
Guido van Rossum	59b0b60	2002-02-08 22:22:35	[diff] [blame]	274	The setup.py script disables them on 64-bit installations.
Guido van Rossum	c0be2f5	1997-10-08 05:05:28	[diff] [blame]	275	Don't try to enable them in the Modules/Setup file. They
				276	contain code that is quite wordsize sensitive. (If you have a
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	277	fix, let us know!)
Guido van Rossum	c0be2f5	1997-10-08 05:05:28	[diff] [blame]	278
Guido van Rossum	4462e93	1997-01-22 21:00:32	[diff] [blame]	279	Solaris: When using Sun's C compiler with threads, at least on Solaris
				280	2.5.1, you need to add the "-mt" compiler option (the simplest
				281	way is probably to specify the compiler with this option as
				282	the "CC" environment variable when running the configure
				283	script).
				284
Guido van Rossum	4299231	2002-09-23 14:02:18	[diff] [blame]	285	When using GCC on Solaris, beware of binutils 2.13 or GCC
				286	versions built using it. This mistakenly enables the
				287	-zcombreloc option which creates broken shared libraries on
				288	Solaris. binutils 2.12 works, and the binutils maintainers
Skip Montanaro	4de9cba	2003-01-03 16:26:23	[diff] [blame]	289	are aware of the problem. Binutils 2.13.1 only partially
				290	fixed things. It appears that 2.13.2 solves the problem
				291	completely. This problem is known to occur with Solaris 2.7
				292	and 2.8, but may also affect earlier and later versions of the
				293	OS.
Guido van Rossum	4299231	2002-09-23 14:02:18	[diff] [blame]	294
Martin v. Löwis	9cea5f5	2002-11-15 07:28:05	[diff] [blame]	295	When the dynamic loader complains about errors finding shared
				296	libraries, such as
				297
				298	ld.so.1: ./python: fatal: libstdc++.so.5: open failed:
				299	No such file or directory
				300
				301	you need to first make sure that the library is available on
				302	your system. Then, you need to instruct the dynamic loader how
Walter Dörwald	7dc65d6	2003-02-02 23:37:05	[diff] [blame]	303	to find it. You can choose any of the following strategies:
Martin v. Löwis	9cea5f5	2002-11-15 07:28:05	[diff] [blame]	304
				305	1. When compiling Python, set LD_RUN_PATH to the directories
				306	containing missing libraries.
				307	2. When running Python, set LD_LIBRARY_PATH to these directories.
				308	3. Use crle(8) to extend the search path of the loader.
				309	4. Modify the installed GCC specs file, adding -R options into the
				310	*link: section.
				311
Guido van Rossum	7ac1153	2000-08-29 21:36:40	[diff] [blame]	312	Linux: A problem with threads and fork() was tracked down to a bug in
				313	the pthreads code in glibc version 2.0.5; glibc version 2.0.7
				314	solves the problem. This causes the popen2 test to fail;
				315	problem and solution reported by Pablo Bleyer.
Guido van Rossum	4462e93	1997-01-22 21:00:32	[diff] [blame]	316
Guido van Rossum	7ac1153	2000-08-29 21:36:40	[diff] [blame]	317	Under Linux systems using GNU libc 2 (aka libc6), the crypt
Guido van Rossum	59b0b60	2002-02-08 22:22:35	[diff] [blame]	318	module now needs the -lcrypt option. The setup.py script
				319	takes care of this automatically.
Fred Drake	6128091	1997-12-08 14:10:40	[diff] [blame]	320
Martin v. Löwis	3efa04a	2003-06-14 05:29:27	[diff] [blame]	321	Red Hat Linux: Red Hat 9 built Python2.2 in UCS-4 mode and hacked
Anthony Baxter	28b81a9	2004-12-13 17:09:28	[diff] [blame]	322	Tcl to support it. To compile Python with Tkinter on these
				323	systems, you will need to pass --enable-unicode=ucs4 flag
				324	to ./configure. This is no longer needed in Fedora Core.
Martin v. Löwis	3efa04a	2003-06-14 05:29:27	[diff] [blame]	325
Anthony Baxter	28b81a9	2004-12-13 17:09:28	[diff] [blame]	326	On older Red Hat releases, there's an executable
				327	/usr/bin/python which is Python 1.5.2 on most older Red Hat
				328	installations; several key Red Hat tools require this version.
				329	Python 2.1.x may be installed as /usr/bin/python2 (you can also
				330	use "make altinstall" to install Python in a way that won't replace
				331	the 'python' executable, but instead only create a "python2.4"
				332	binary). The Makefile installs Python as /usr/local/bin/python,
				333	which may or may not take precedence over /usr/bin/python, depending
				334	on how you have set up $PATH.
Guido van Rossum	2dcec0c	2002-02-04 01:59:23	[diff] [blame]	335
Guido van Rossum	5923050	1999-06-21 20:51:46	[diff] [blame]	336	FreeBSD 3.x and probably platforms with NCurses that use libmytinfo or
				337	similar: When using cursesmodule, the linking is not done in
				338	the correct order with the defaults. Remove "-ltermcap" from
				339	the readline entry in Setup, and use as curses entry: "curses
				340	cursesmodule.c -lmytinfo -lncurses -ltermcap" - "mytinfo" (so
				341	called on FreeBSD) should be the name of the auxiliary library
				342	required on your platform. Normally, it would be linked
				343	automatically, but not necessarily in the correct order.
				344
Guido van Rossum	7ac1153	2000-08-29 21:36:40	[diff] [blame]	345	BSDI: BSDI versions before 4.1 have known problems with threads,
				346	which can cause strange errors in a number of modules (for
				347	instance, the 'test_signal' test script will hang forever.)
				348	Turning off threads (with --with-threads=no) or upgrading to
				349	BSDI 4.1 solves this problem.
				350
				351	DEC Unix: Run configure with --with-dec-threads, or with
				352	--with-threads=no if no threads are desired (threads are on by
				353	default). When using GCC, it is possible to get an internal
				354	compiler error if optimization is used. This was reported for
				355	GCC 2.7.2.3 on selectmodule.c. Manually compile the affected
				356	file without optimization to solve the problem.
Guido van Rossum	8eca2c2	1996-02-14 18:37:46	[diff] [blame]	357
Guido van Rossum	e1cdb16	1999-04-10 16:04:07	[diff] [blame]	358	DEC Ultrix: compile with GCC to avoid bugs in the native compiler,
				359	and pass SHELL=/bin/sh5 to Make when installing.
				360
Guido van Rossum	d0fe845	1996-08-26 03:02:37	[diff] [blame]	361	AIX: A complete overhaul of the shared library support is now in
Guido van Rossum	16e809e	2001-04-16 02:07:08	[diff] [blame]	362	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]	363	(The optimizer bug reported at this place in previous releases
Thomas Wouters	8ee0614	2001-02-15 11:45:29	[diff] [blame]	364	has been worked around by a minimal code change.) If you get
Fred Drake	59518b0	2002-05-11 03:36:26	[diff] [blame]	365	errors about pthread_* functions, during compile or during
Thomas Wouters	8ee0614	2001-02-15 11:45:29	[diff] [blame]	366	testing, try setting CC to a thread-safe (reentrant) compiler,
				367	like "cc_r". For full C++ module support, set CC="xlC_r" (or
				368	CC="xlC" without thread support).
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	369
Anthony Baxter	7c49747	2003-10-01 07:24:54	[diff] [blame]	370	HP-UX: When using threading, you may have to add -D_REENTRANT to the
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	371	OPT variable in the top-level Makefile; reported by Pat Knight,
Guido van Rossum	59a88f4	1999-04-12 18:16:09	[diff] [blame]	372	this seems to make a difference (at least for HP-UX 10.20)
Anthony Baxter	7c49747	2003-10-01 07:24:54	[diff] [blame]	373	even though pyconfig.h defines it. This seems unnecessary when
				374	using HP/UX 11 and later - threading seems to work "out of the
				375	box".
				376
				377	HP-UX ia64: When building on the ia64 (Itanium) platform using HP's
				378	compiler, some experience has shown that the compiler's
				379	optimiser produces a completely broken version of python
				380	(see http://www.python.org/sf/814976). To work around this,
				381	edit the Makefile and remove -O from the OPT line.
Guido van Rossum	2094e04	1998-05-14 15:47:35	[diff] [blame]	382
Guido van Rossum	4e1dd7d	2002-04-23 13:06:07	[diff] [blame]	383	HP PA-RISC 2.0: A recent bug report (http://www.python.org/sf/546117)
				384	suggests that the C compiler in this 64-bit system has bugs
				385	in the optimizer that break Python. Compiling without
				386	optimization solves the problems.
				387
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	388	SCO: The following apply to SCO 3 only; Python builds out of the box
				389	on SCO 5 (or so we've heard).
Guido van Rossum	a16e275	1998-04-13 20:14:05	[diff] [blame]	390
				391	1) Everything works much better if you add -U__STDC__ to the
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	392	defs. This is because all the SCO header files are broken.
Guido van Rossum	6477380	1997-11-26 17:07:02	[diff] [blame]	393	Anything that isn't mentioned in the C standard is
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	394	conditionally excluded when __STDC__ is defined.
				395
				396	2) Due to the U.S. export restrictions, SCO broke the crypt
				397	stuff out into a separate library, libcrypt_i.a so the LIBS
				398	needed be set to:
				399
				400	LIBS=' -lsocket -lcrypt_i'
				401
Martin v. Löwis	387c547	2001-09-06 08:16:17	[diff] [blame]	402	UnixWare: There are known bugs in the math library of the system, as well as
				403	problems in the handling of threads (calling fork in one
				404	thread may interrupt system calls in others). Therefore, test_math and
				405	tests involving threads will fail until those problems are fixed.
				406
Guido van Rossum	7ac1153	2000-08-29 21:36:40	[diff] [blame]	407	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]	408	'-Xa' option instead of '-Xc', to enable some needed non-ANSI
				409	Sunisms.
Martin v. Löwis	779ffc0	2002-12-02 22:17:01	[diff] [blame]	410	THIS SYSTEM IS NO LONGER SUPPORTED.
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	411
Jack Jansen	a39ef86	2001-08-19 21:17:03	[diff] [blame]	412	NeXT: Not supported anymore. Start with the MacOSX/Darwin code if you
				413	want to revive it.
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	414
Guido van Rossum	b7f454d	1997-12-02 19:44:31	[diff] [blame]	415	QNX: Chris Herborth (chrish@qnx.com) writes:
				416	configure works best if you use GNU bash; a port is available on
				417	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]	418	test and install Python 1.5.x under QNX:
Guido van Rossum	b7f454d	1997-12-02 19:44:31	[diff] [blame]	419
Guido van Rossum	ec95c7b	1998-08-04 17:59:56	[diff] [blame]	420	1) CONFIG_SHELL=/usr/local/bin/bash CC=cc RANLIB=: \
				421	./configure --verbose --without-gcc --with-libm=""
Guido van Rossum	b7f454d	1997-12-02 19:44:31	[diff] [blame]	422
Fred Drake	8007849	2000-10-26 17:13:19	[diff] [blame]	423	2) edit Modules/Setup to activate everything that makes sense for
				424	your system... tested here at QNX with the following modules:
Guido van Rossum	b7f454d	1997-12-02 19:44:31	[diff] [blame]	425
Guido van Rossum	6fa49e2	1998-08-11 17:31:39	[diff] [blame]	426	array, audioop, binascii, cPickle, cStringIO, cmath,
				427	crypt, curses, errno, fcntl, gdbm, grp, imageop,
				428	_locale, math, md5, new, operator, parser, pcre,
				429	posix, pwd, readline, regex, reop, rgbimg, rotor,
				430	select, signal, socket, soundex, strop, struct,
Guido van Rossum	d449342	1998-12-22 16:37:01	[diff] [blame]	431	syslog, termios, time, timing, zlib, audioop, imageop, rgbimg
Guido van Rossum	b7f454d	1997-12-02 19:44:31	[diff] [blame]	432
Guido van Rossum	16e809e	2001-04-16 02:07:08	[diff] [blame]	433	3) make SHELL=/usr/local/bin/bash
				434
Guido van Rossum	ec95c7b	1998-08-04 17:59:56	[diff] [blame]	435	or, if you feel the need for speed:
Guido van Rossum	16e809e	2001-04-16 02:07:08	[diff] [blame]	436
Guido van Rossum	ec95c7b	1998-08-04 17:59:56	[diff] [blame]	437	make SHELL=/usr/local/bin/bash OPT="-5 -Oil+nrt"
Guido van Rossum	b7f454d	1997-12-02 19:44:31	[diff] [blame]	438
Guido van Rossum	ec95c7b	1998-08-04 17:59:56	[diff] [blame]	439	4) make SHELL=/usr/local/bin/bash test
				440
Guido van Rossum	6fa49e2	1998-08-11 17:31:39	[diff] [blame]	441	Using GNU readline 2.2 seems to behave strangely, but I
				442	think that's a problem with my readline 2.2 port. :-\
Guido van Rossum	ec95c7b	1998-08-04 17:59:56	[diff] [blame]	443
				444	5) make SHELL=/usr/local/bin/bash install
Guido van Rossum	b7f454d	1997-12-02 19:44:31	[diff] [blame]	445
Guido van Rossum	6fa49e2	1998-08-11 17:31:39	[diff] [blame]	446	If you get SIGSEGVs while running Python (I haven't yet, but
				447	I've only run small programs and the test cases), you're
				448	probably running out of stack; the default 32k could be a
				449	little tight. To increase the stack size, edit the Makefile
Neil Schemenauer	73f8ab2	2001-01-26 22:18:55	[diff] [blame]	450	to read: LDFLAGS = -N 48k
Guido van Rossum	40d6358	1997-08-14 19:45:30	[diff] [blame]	451
Skip Montanaro	2d98db6	2003-01-06 17:23:37	[diff] [blame]	452	BeOS: See Misc/BeOS-NOTES for notes about compiling/installing
				453	Python on BeOS R3 or later. Note that only the PowerPC
				454	platform is supported for R3; both PowerPC and x86 are
				455	supported for R4.
Guido van Rossum	ec95c7b	1998-08-04 17:59:56	[diff] [blame]	456
Michael W. Hudson	33876f5	2002-07-31 09:55:25	[diff] [blame]	457	Cray T3E: Mark Hadfield (m.hadfield@niwa.co.nz) writes:
				458	Python can be built satisfactorily on a Cray T3E but based on
				459	my experience with the NIWA T3E (2002-05-22, version 2.2.1)
				460	there are a few bugs and gotchas. For more information see a
				461	thread on comp.lang.python in May 2002 entitled "Building
				462	Python on Cray T3E".
				463
				464	1) Use Cray's cc and not gcc. The latter was reported not to
				465	work by Konrad Hinsen. It may work now, but it may not.
				466
				467	2) To set sys.platform to something sensible, pass the
				468	following environment variable to the configure script:
				469
				470	MACHDEP=unicosmk
				471
				472	2) Run configure with option "--enable-unicode=ucs4".
				473
				474	3) The Cray T3E does not support dynamic linking, so extension
				475	modules have to be built by adding (or uncommenting) lines
				476	in Modules/Setup. The minimum set of modules is
				477
				478	posix, new, _sre, unicodedata
				479
				480	On NIWA's vanilla T3E system the following have also been
				481	included successfully:
				482
				483	_codecs, _locale, _socket, _symtable, _testcapi, _weakref
				484	array, binascii, cmath, cPickle, crypt, cStringIO, dbm
				485	errno, fcntl, grp, math, md5, operator, parser, pcre, pwd
				486	regex, rotor, select, struct, strop, syslog, termios
				487	time, timing, xreadlines
				488
				489	4) Once the python executable and library have been built, make
				490	will execute setup.py, which will attempt to build remaining
				491	extensions and link them dynamically. Each of these attempts
				492	will fail but should not halt the make process. This is
				493	normal.
				494
				495	5) Running "make test" uses a lot of resources and causes
				496	problems on our system. You might want to try running tests
				497	singly or in small groups.
Guido van Rossum	1bf0bf4	1997-08-20 23:50:51	[diff] [blame]	498
Guido van Rossum	0078aaf	1997-08-21 03:05:11	[diff] [blame]	499	SGI: SGI's standard "make" utility (/bin/make or /usr/bin/make)
				500	does not check whether a command actually changed the file it
				501	is supposed to build. This means that whenever you say "make"
				502	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]	503	smarter "smake" utility (/usr/sbin/smake), or GNU make. If
Guido van Rossum	c0be2f5	1997-10-08 05:05:28	[diff] [blame]	504	you set the first line of the Makefile to #!/usr/sbin/smake
				505	smake will be invoked by make (likewise for GNU make).
Guido van Rossum	0078aaf	1997-08-21 03:05:11	[diff] [blame]	506
Guido van Rossum	7be8ca0	2001-04-14 13:09:53	[diff] [blame]	507	WARNING: There are bugs in the optimizer of some versions of
				508	SGI's compilers that can cause bus errors or other strange
				509	behavior, especially on numerical operations. To avoid this,
				510	try building with "make OPT=".
Fred Drake	0b5fb2b	2000-09-29 17:45:05	[diff] [blame]	511
Guido van Rossum	6477380	1997-11-26 17:07:02	[diff] [blame]	512	OS/2: If you are running Warp3 or Warp4 and have IBM's VisualAge C/C++
				513	compiler installed, just change into the pc\os2vacpp directory
				514	and type NMAKE. Threading and sockets are supported by default
				515	in the resulting binaries of PYTHON15.DLL and PYTHON.EXE.
				516
Fred Drake	36ed560	2000-10-06 01:58:48	[diff] [blame]	517	Monterey (64-bit AIX): The current Monterey C compiler (Visual Age)
				518	uses the OBJECT_MODE={32\|64} environment variable to set the
				519	compilation mode to either 32-bit or 64-bit (32-bit mode is
				520	the default). Presumably you want 64-bit compilation mode for
				521	this 64-bit OS. As a result you must first set OBJECT_MODE=64
				522	in your environment before configuring (./configure) or
				523	building (make) Python on Monterey.
				524
				525	Reliant UNIX: The thread support does not compile on Reliant UNIX, and
				526	there is a (minor) problem in the configure script for that
				527	platform as well. This should be resolved in time for a
				528	future release.
Trent Mick	635f6fb	2000-08-23 21:33:05	[diff] [blame]	529
Barry Warsaw	6a8557d	2002-10-14 18:04:39	[diff] [blame]	530	MacOSX: The tests will crash on both 10.1 and 10.2 with SEGV in
Barry Warsaw	6e75364	2002-10-14 18:15:35	[diff] [blame]	531	test_re and test_sre due to the small default stack size. If
				532	you set the stack size to 2048 before doing a "make test" the
				533	failure can be avoided. If you're using the tcsh (the default
				534	on OSX), or csh shells use "limit stacksize 2048" and for the
				535	bash shell, use "ulimit -s 2048".
Barry Warsaw	0655745	2001-12-14 20:47:12	[diff] [blame]	536
Jack Jansen	6a77cf1	2001-12-06 21:49:02	[diff] [blame]	537	On naked Darwin you may want to add the configure option
Jack Jansen	4c398fd	2001-10-08 13:21:15	[diff] [blame]	538	"--disable-toolbox-glue" to disable the glue code for the Carbon
Jack Jansen	6a77cf1	2001-12-06 21:49:02	[diff] [blame]	539	interface modules. The modules themselves are currently only built
				540	if you add the --enable-framework option, see below.
Barry Warsaw	0655745	2001-12-14 20:47:12	[diff] [blame]	541
				542	On a clean OSX /usr/local does not exist. Do a
Jack Jansen	61fec30	2002-01-04 15:59:57	[diff] [blame]	543	"sudo mkdir -m 775 /usr/local"
Jack Jansen	84a0164	2002-08-04 21:19:55	[diff] [blame]	544	before you do a make install. It is probably not a good idea to
				545	do "sudo make install" which installs everything as superuser,
				546	as this may later cause problems when installing distutils-based
				547	additions.
				548
				549	Some people have reported problems building Python after using "fink"
				550	to install additional unix software. Disabling fink (remove all references
				551	to /sw from your .profile or .login) should solve this.
Barry Warsaw	0655745	2001-12-14 20:47:12	[diff] [blame]	552
				553	You may want to try the configure option "--enable-framework"
				554	which installs Python as a framework. The location can be set
				555	as argument to the --enable-framework option (default
Jack Jansen	84a0164	2002-08-04 21:19:55	[diff] [blame]	556	/Library/Frameworks). A framework install is probably needed if you
				557	want to use any Aqua-based GUI toolkit (whether Tkinter, wxPython,
				558	Carbon, Cocoa or anything else).
				559
				560	See Mac/OSX/README for more information on framework builds.
Fred Drake	dabed75	2001-02-01 19:41:13	[diff] [blame]	561
Michael W. Hudson	1c4523f	2001-12-19 19:49:58	[diff] [blame]	562	Cygwin: With recent (relative to the time of writing, 2001-12-19)
				563	Cygwin installations, there are problems with the interaction
				564	of dynamic linking and fork(). This manifests itself in build
				565	failures during the execution of setup.py.
Tim Peters	42fc7cc	2001-04-04 18:35:19	[diff] [blame]	566
Michael W. Hudson	1c4523f	2001-12-19 19:49:58	[diff] [blame]	567	There are two workarounds that both enable Python (albeit
				568	without threading support) to build and pass all tests on
				569	NT/2000 (and most likely XP as well, though reports of testing
				570	on XP would be appreciated).
Guido van Rossum	16e809e	2001-04-16 02:07:08	[diff] [blame]	571
Michael W. Hudson	1c4523f	2001-12-19 19:49:58	[diff] [blame]	572	The workarounds:
				573
				574	(a) the band-aid fix is to link the _socket module statically
				575	rather than dynamically (which is the default).
				576
				577	To do this, run "./configure --with-threads=no" including any
				578	other options you need (--prefix, etc.). Then in Modules/Setup
Walter Dörwald	7dc65d6	2003-02-02 23:37:05	[diff] [blame]	579	uncomment the lines:
Tim Peters	42fc7cc	2001-04-04 18:35:19	[diff] [blame]	580
Michael W. Hudson	be5ce18	2001-12-12 11:46:52	[diff] [blame]	581	#SSL=/usr/local/ssl
				582	#_socket socketmodule.c \
				583	# -DUSE_SSL -I$(SSL)/include -I$(SSL)/include/openssl \
				584	# -L$(SSL)/lib -lssl -lcrypto
Guido van Rossum	16e809e	2001-04-16 02:07:08	[diff] [blame]	585
Michael W. Hudson	1c4523f	2001-12-19 19:49:58	[diff] [blame]	586	and remove "local/" from the SSL variable. Finally, just run
				587	"make"!
Tim Peters	42fc7cc	2001-04-04 18:35:19	[diff] [blame]	588
Michael W. Hudson	b655464	2001-12-19 22:09:09	[diff] [blame]	589	(b) The "proper" fix is to rebase the Cygwin DLLs to prevent
Michael W. Hudson	1c4523f	2001-12-19 19:49:58	[diff] [blame]	590	base address conflicts. Details on how to do this can be
				591	found in the following mail:
				592
				593	http://sources.redhat.com/ml/cygwin/2001-12/msg00894.html
				594
				595	It is hoped that a version of this solution will be
Michael W. Hudson	b655464	2001-12-19 22:09:09	[diff] [blame]	596	incorporated into the Cygwin distribution fairly soon.
Michael W. Hudson	1c4523f	2001-12-19 19:49:58	[diff] [blame]	597
				598	Two additional problems:
				599
				600	(1) Threading support should still be disabled due to a known
				601	bug in Cygwin pthreads that causes test_threadedtempfile to
				602	hang.
				603
Neal Norwitz	4ebde09	2001-12-19 20:44:13	[diff] [blame]	604	(2) The _curses module does not build. This is a known
Michael W. Hudson	1c4523f	2001-12-19 19:49:58	[diff] [blame]	605	Cygwin ncurses problem that should be resolved the next time
				606	that this package is released.
Guido van Rossum	16e809e	2001-04-16 02:07:08	[diff] [blame]	607
Michael W. Hudson	be5ce18	2001-12-12 11:46:52	[diff] [blame]	608	On older versions of Cygwin, test_poll may hang and test_strftime
				609	may fail.
Tim Peters	42fc7cc	2001-04-04 18:35:19	[diff] [blame]	610
Michael W. Hudson	1c4523f	2001-12-19 19:49:58	[diff] [blame]	611	The situation on 9X/Me is not accurately known at present.
				612	Some time ago, there were reports that the following
				613	regression tests failed:
Tim Peters	42fc7cc	2001-04-04 18:35:19	[diff] [blame]	614
				615	test_pwd
				616	test_select (hang)
				617	test_socket
				618
Michael W. Hudson	1c4523f	2001-12-19 19:49:58	[diff] [blame]	619	Due to the test_select hang on 9X/Me, one should run the
				620	regression test using the following:
Tim Peters	42fc7cc	2001-04-04 18:35:19	[diff] [blame]	621
Michael W. Hudson	be5ce18	2001-12-12 11:46:52	[diff] [blame]	622	make TESTOPTS='-l -x test_select' test
Tim Peters	42fc7cc	2001-04-04 18:35:19	[diff] [blame]	623
Michael W. Hudson	1c4523f	2001-12-19 19:49:58	[diff] [blame]	624	News regarding these platforms with more recent Cygwin
				625	versions would be appreciated!
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	626
Skip Montanaro	56d8301	2003-01-04 04:05:51	[diff] [blame]	627	AtheOS: From Octavian Cerna <tavy at ylabs.com>:
				628
				629	Before building:
				630
				631	Make sure you have shared versions of the libraries you
				632	want to use with Python. You will have to compile them
				633	yourself, or download precompiled packages.
				634
				635	Recommended libraries:
				636
				637	ncurses-4.2
				638	readline-4.2a
				639	zlib-1.1.4
				640
				641	Build:
				642
				643	$ ./configure --prefix=/usr/python
				644	$ make
				645
				646	Python is always built as a shared library, otherwise
				647	dynamic loading would not work.
				648
				649	Testing:
				650
				651	$ make test
				652
				653	Install:
				654
				655	# make install
				656	# pkgmanager -a /usr/python
				657
				658
				659	AtheOS issues:
				660
				661	- large file support: due to a stdio bug in glibc/libio,
				662	access to large files may not work correctly. fseeko()
				663	tries to seek to a negative offset. ftello() returns a
				664	negative offset, it looks like a 32->64bit
				665	sign-extension issue. The lowlevel functions (open,
				666	lseek, etc) are OK.
				667	- sockets: AF_UNIX is defined in the C library and in
				668	Python, but not implemented in the system.
				669	- select: poll is available in the C library, but does not
				670	work (It does not return POLLNVAL for bad fds and
				671	hangs).
				672	- posix: statvfs and fstatvfs always return ENOSYS.
				673	- disabled modules:
				674	- mmap: not yet implemented in AtheOS
				675	- nis: broken (on an unconfigured system
				676	yp_get_default_domain() returns junk instead of
				677	error)
				678	- dl: dynamic loading doesn't work via dlopen()
				679	- resource: getrimit and setrlimit are not yet
				680	implemented
				681
				682	- if you are getting segmentation faults, you probably are
				683	low on memory. AtheOS doesn't handle very well an
				684	out-of-memory condition and simply SEGVs the process.
				685
				686	Tested on:
				687
				688	AtheOS-0.3.7
				689	gcc-2.95
				690	binutils-2.10
				691	make-3.78
				692
				693
Skip Montanaro	57454e5	2002-06-14 20:30:31	[diff] [blame]	694	Configuring the bsddb and dbm modules
				695	-------------------------------------
				696
Skip Montanaro	56d8301	2003-01-04 04:05:51	[diff] [blame]	697	Beginning with Python version 2.3, the PyBsddb package
				698	<http://pybsddb.sf.net/> was adopted into Python as the bsddb package,
				699	exposing a set of package-level functions which provide
				700	backwards-compatible behavior. Only versions 3.1 through 4.1 of
				701	Sleepycat's libraries provide the necessary API, so older versions
				702	aren't supported through this interface. The old bsddb module has
				703	been retained as bsddb185, though it is not built by default. Users
				704	wishing to use it will have to tweak Modules/Setup to build it. The
				705	dbm module will still be built against the Sleepycat libraries if
				706	other preferred alternatives (ndbm, gdbm) are not found, though
				707	versions of the Sleepycat library prior to 3.1 are not considered.
Guido van Rossum	62d45c0	2002-12-02 15:49:13	[diff] [blame]	708
Skip Montanaro	57454e5	2002-06-14 20:30:31	[diff] [blame]	709
Guido van Rossum	dc8a3cb	1998-05-12 15:29:18	[diff] [blame]	710	Configuring threads
				711	-------------------
				712
Guido van Rossum	7ac1153	2000-08-29 21:36:40	[diff] [blame]	713	As of Python 2.0, threads are enabled by default. If you wish to
				714	compile without threads, or if your thread support is broken, pass the
				715	--with-threads=no switch to configure. Unfortunately, on some
				716	platforms, additional compiler and/or linker options are required for
				717	threads to work properly. Below is a table of those options,
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	718	collected by Bill Janssen. We would love to automate this process
Guido van Rossum	7ac1153	2000-08-29 21:36:40	[diff] [blame]	719	more, but the information below is not enough to write a patch for the
				720	configure.in file, so manual intervention is required. If you patch
				721	the configure.in file and are confident that the patch works, please
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	722	send in the patch. (Don't bother patching the configure script itself
Walter Dörwald	7dc65d6	2003-02-02 23:37:05	[diff] [blame]	723	-- it is regenerated each time the configure.in file changes.)
Guido van Rossum	dc8a3cb	1998-05-12 15:29:18	[diff] [blame]	724
				725	Compiler switches for threads
				726	.............................
				727
Martin v. Löwis	1c24f9c	2001-03-06 12:07:27	[diff] [blame]	728	The definition of _REENTRANT should be configured automatically, if
				729	that does not work on your system, or if _REENTRANT is defined
				730	incorrectly, please report that as a bug.
Guido van Rossum	dc8a3cb	1998-05-12 15:29:18	[diff] [blame]	731
Martin v. Löwis	1c24f9c	2001-03-06 12:07:27	[diff] [blame]	732	OS/Compiler/threads Switches for use with threads
				733	(POSIX is draft 10, DCE is draft 4) compile & link
				734
				735	SunOS 5.{1-5}/{gcc,SunPro cc}/solaris -mt
				736	SunOS 5.5/{gcc,SunPro cc}/POSIX (nothing)
Guido van Rossum	16e809e	2001-04-16 02:07:08	[diff] [blame]	737	DEC OSF/1 3.x/cc/DCE -threads
Guido van Rossum	dc8a3cb	1998-05-12 15:29:18	[diff] [blame]	738	(butenhof@zko.dec.com)
Guido van Rossum	16e809e	2001-04-16 02:07:08	[diff] [blame]	739	Digital UNIX 4.x/cc/DCE -threads
Guido van Rossum	dc8a3cb	1998-05-12 15:29:18	[diff] [blame]	740	(butenhof@zko.dec.com)
Guido van Rossum	16e809e	2001-04-16 02:07:08	[diff] [blame]	741	Digital UNIX 4.x/cc/POSIX -pthread
Guido van Rossum	dc8a3cb	1998-05-12 15:29:18	[diff] [blame]	742	(butenhof@zko.dec.com)
Guido van Rossum	16e809e	2001-04-16 02:07:08	[diff] [blame]	743	AIX 4.1.4/cc_r/d7 (nothing)
Guido van Rossum	dc8a3cb	1998-05-12 15:29:18	[diff] [blame]	744	(buhrt@iquest.net)
Guido van Rossum	16e809e	2001-04-16 02:07:08	[diff] [blame]	745	AIX 4.1.4/cc_r4/DCE (nothing)
Guido van Rossum	dc8a3cb	1998-05-12 15:29:18	[diff] [blame]	746	(buhrt@iquest.net)
Guido van Rossum	16e809e	2001-04-16 02:07:08	[diff] [blame]	747	IRIX 6.2/cc/POSIX (nothing)
Guido van Rossum	dc8a3cb	1998-05-12 15:29:18	[diff] [blame]	748	(robertl@cwi.nl)
				749
				750
				751	Linker (ld) libraries and flags for threads
				752	...........................................
				753
				754	OS/threads Libraries/switches for use with threads
				755
				756	SunOS 5.{1-5}/solaris -lthread
				757	SunOS 5.5/POSIX -lpthread
Guido van Rossum	16e809e	2001-04-16 02:07:08	[diff] [blame]	758	DEC OSF/1 3.x/DCE -lpthreads -lmach -lc_r -lc
Guido van Rossum	dc8a3cb	1998-05-12 15:29:18	[diff] [blame]	759	(butenhof@zko.dec.com)
				760	Digital UNIX 4.x/DCE -lpthreads -lpthread -lmach -lexc -lc
				761	(butenhof@zko.dec.com)
Guido van Rossum	16e809e	2001-04-16 02:07:08	[diff] [blame]	762	Digital UNIX 4.x/POSIX -lpthread -lmach -lexc -lc
Guido van Rossum	dc8a3cb	1998-05-12 15:29:18	[diff] [blame]	763	(butenhof@zko.dec.com)
Guido van Rossum	16e809e	2001-04-16 02:07:08	[diff] [blame]	764	AIX 4.1.4/{draft7,DCE} (nothing)
Guido van Rossum	dc8a3cb	1998-05-12 15:29:18	[diff] [blame]	765	(buhrt@iquest.net)
Guido van Rossum	16e809e	2001-04-16 02:07:08	[diff] [blame]	766	IRIX 6.2/POSIX -lpthread
Guido van Rossum	dc8a3cb	1998-05-12 15:29:18	[diff] [blame]	767	(jph@emilia.engr.sgi.com)
				768
				769
Martin v. Löwis	1142de3	2002-03-29 16:28:31	[diff] [blame]	770	Building a shared libpython
				771	---------------------------
				772
				773	Starting with Python 2.3, the majority of the interpreter can be built
				774	into a shared library, which can then be used by the interpreter
				775	executable, and by applications embedding Python. To enable this feature,
Martin v. Löwis	6506967	2002-08-03 21:38:27	[diff] [blame]	776	configure with --enable-shared.
				777
Fred Drake	55512dc	2003-07-21 16:01:39	[diff] [blame]	778	If you enable this feature, the same object files will be used to create
				779	a static library. In particular, the static library will contain object
				780	files using position-independent code (PIC) on platforms where PIC flags
				781	are needed for the shared library.
Martin v. Löwis	1142de3	2002-03-29 16:28:31	[diff] [blame]	782
				783
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	784	Configuring additional built-in modules
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	785	---------------------------------------
Guido van Rossum	19e0c26	1995-01-17 16:36:34	[diff] [blame]	786
Andrew M. Kuchling	ebe3045	2001-02-27 03:24:24	[diff] [blame]	787	Starting with Python 2.1, the setup.py script at the top of the source
				788	distribution attempts to detect which modules can be built and
				789	automatically compiles them. Autodetection doesn't always work, so
Guido van Rossum	59b0b60	2002-02-08 22:22:35	[diff] [blame]	790	you can still customize the configuration by editing the Modules/Setup
				791	file; but this should be considered a last resort. The rest of this
				792	section only applies if you decide to edit the Modules/Setup file.
				793	You also need this to enable static linking of certain modules (which
				794	is needed to enable profiling on some systems).
				795
Andrew M. Kuchling	ebe3045	2001-02-27 03:24:24	[diff] [blame]	796	This file is initially copied from Setup.dist by the configure script;
				797	if it does not exist yet, create it by copying Modules/Setup.dist
				798	yourself (configure will never overwrite it). Never edit Setup.dist
				799	-- always edit Setup or Setup.local (see below). Read the comments in
				800	the file for information on what kind of edits are allowed. When you
				801	have edited Setup in the Modules directory, the interpreter will
Guido van Rossum	ef67ded	2001-10-05 17:04:42	[diff] [blame]	802	automatically be rebuilt the next time you run make (in the toplevel
				803	directory).
Guido van Rossum	627b2d7	1993-12-24 10:39:16	[diff] [blame]	804
Andrew M. Kuchling	ebe3045	2001-02-27 03:24:24	[diff] [blame]	805	Many useful modules can be built on any Unix system, but some optional
				806	modules can't be reliably autodetected. Often the quickest way to
				807	determine whether a particular module works or not is to see if it
				808	will build: enable it in Setup, then if you get compilation or link
Fred Drake	6caae14	2000-10-25 17:51:02	[diff] [blame]	809	errors, disable it -- you're either missing support or need to adjust
				810	the compilation and linking parameters for that module.
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	811
				812	On SGI IRIX, there are modules that interface to many SGI specific
Andrew M. Kuchling	ebe3045	2001-02-27 03:24:24	[diff] [blame]	813	system libraries, e.g. the GL library and the audio hardware. These
				814	modules will not be built by the setup.py script.
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	815
Guido van Rossum	4462e93	1997-01-22 21:00:32	[diff] [blame]	816	In addition to the file Setup, you can also edit the file Setup.local.
				817	(the makesetup script processes both). You may find it more
				818	convenient to edit Setup.local and leave Setup alone. Then, when
				819	installing a new Python version, you can copy your old Setup.local
				820	file.
				821
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	822
				823	Setting the optimization/debugging options
				824	------------------------------------------
				825
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	826	If you want or need to change the optimization/debugging options for
				827	the C compiler, assign to the OPT variable on the toplevel make
				828	command; e.g. "make OPT=-g" will build a debugging version of Python
				829	on most platforms. The default is OPT=-O; a value for OPT in the
				830	environment when the configure script is run overrides this default
				831	(likewise for CC; and the initial value for LIBS is used as the base
				832	set of libraries to link with).
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	833
Fred Drake	6caae14	2000-10-25 17:51:02	[diff] [blame]	834	When compiling with GCC, the default value of OPT will also include
				835	the -Wall and -Wstrict-prototypes options.
				836
				837	Additional debugging code to help debug memory management problems can
				838	be enabled by using the --with-pydebug option to the configure script.
				839
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	840
Guido van Rossum	a68ca35	2001-10-04 17:00:07	[diff] [blame]	841	Profiling
				842	---------
				843
				844	If you want C profiling turned on, the easiest way is to run configure
				845	with the CC environment variable to the necessary compiler
				846	invocation. For example, on Linux, this works for profiling using
				847	gprof(1):
				848
				849	CC="gcc -pg" ./configure
				850
				851	Note that on Linux, gprof apparently does not work for shared
				852	libraries. The Makefile/Setup mechanism can be used to compile and
Walter Dörwald	7dc65d6	2003-02-02 23:37:05	[diff] [blame]	853	link most extension modules statically.
Guido van Rossum	a68ca35	2001-10-04 17:00:07	[diff] [blame]	854
				855
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	856	Testing
				857	-------
Guido van Rossum	433c8ad	1994-08-01 12:07:07	[diff] [blame]	858
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	859	To test the interpreter, type "make test" in the top-level directory.
Guido van Rossum	6ae5d3d	1997-05-14 21:39:05	[diff] [blame]	860	This runs the test set twice (once with no compiled files, once with
				861	the compiled files left by the previous test run). The test set
				862	produces some output. You can generally ignore the messages about
Guido van Rossum	59b0b60	2002-02-08 22:22:35	[diff] [blame]	863	skipped tests due to optional features which can't be imported.
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	864	If a message is printed about a failed test or a traceback or core
				865	dump is produced, something is wrong. On some Linux systems (those
Guido van Rossum	24df684	1997-12-30 04:32:30	[diff] [blame]	866	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]	867	non-standard implementation of strftime() in the C library. Please
				868	ignore this, or upgrade to glibc version 6.
Guido van Rossum	433c8ad	1994-08-01 12:07:07	[diff] [blame]	869
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	870	IMPORTANT: If the tests fail and you decide to mail a bug report,
				871	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]	872	failing test manually, as follows:
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	873
Andrew M. Kuchling	83d042d	2002-03-21 23:52:20	[diff] [blame]	874	./python ./Lib/test/test_whatever.py
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	875
Andrew M. Kuchling	83d042d	2002-03-21 23:52:20	[diff] [blame]	876	(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]	877	different directory). This runs the test in verbose mode.
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	878
				879
				880	Installing
				881	----------
				882
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	883	To install the Python binary, library modules, shared library modules
				884	(see below), include files, configuration files, and the manual page,
Guido van Rossum	6477380	1997-11-26 17:07:02	[diff] [blame]	885	just type
				886
				887	make install
				888
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	889	This will install all platform-independent files in subdirectories of
				890	the directory given with the --prefix option to configure or to the
				891	`prefix' Make variable (default /usr/local). All binary and other
				892	platform-specific files will be installed in subdirectories if the
				893	directory given by --exec-prefix or the `exec_prefix' Make variable
				894	(defaults to the --prefix directory) is given.
Guido van Rossum	6477380	1997-11-26 17:07:02	[diff] [blame]	895
Martin v. Löwis	3b8ee08	2003-05-11 20:25:35	[diff] [blame]	896	If DESTDIR is set, it will be taken as the root directory of the
				897	installation, and files will be installed into $(DESTDIR)$(prefix),
				898	$(DESTDIR)$(exec_prefix), etc.
				899
Guido van Rossum	6477380	1997-11-26 17:07:02	[diff] [blame]	900	All subdirectories created will have Python's version number in their
				901	name, e.g. the library modules are installed in
Guido van Rossum	67345eb	2001-01-18 14:51:12	[diff] [blame]	902	"/usr/local/lib/python<version>/" by default, where <version> is the
				903	<major>.<minor> release number (e.g. "2.1"). The Python binary is
				904	installed as "python<version>" and a hard link named "python" is
				905	created. The only file not installed with a version number in its
				906	name is the manual page, installed as "/usr/local/man/man1/python.1"
				907	by default.
Guido van Rossum	433c8ad	1994-08-01 12:07:07	[diff] [blame]	908
Neil Schemenauer	0e91dc7	2001-02-16 04:18:08	[diff] [blame]	909	If you have a previous installation of Python that you don't
Guido van Rossum	6477380	1997-11-26 17:07:02	[diff] [blame]	910	want to replace yet, use
				911
				912	make altinstall
				913
				914	This installs the same set of files as "make install" except it
Guido van Rossum	67345eb	2001-01-18 14:51:12	[diff] [blame]	915	doesn't create the hard link to "python<version>" named "python" and
				916	it doesn't install the manual page at all.
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	917
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	918	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]	919	Emacs found in Misc/python-mode.el. (But then again, more recent
				920	versions of Emacs may already have it.) Follow the instructions that
				921	came with Emacs for installation of site-specific files.
Guido van Rossum	433c8ad	1994-08-01 12:07:07	[diff] [blame]	922
Jack Jansen	a39ef86	2001-08-19 21:17:03	[diff] [blame]	923	On Mac OS X, if you have configured Python with --enable-framework, you
				924	should use "make frameworkinstall" to do the installation. Note that this
				925	installs the Python executable in a place that is not normally on your
				926	PATH, you may want to set up a symlink in /usr/local/bin.
				927
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	928
				929	Configuration options and variables
				930	-----------------------------------
Guido van Rossum	433c8ad	1994-08-01 12:07:07	[diff] [blame]	931
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	932	Some special cases are handled by passing options to the configure
				933	script.
Guido van Rossum	433c8ad	1994-08-01 12:07:07	[diff] [blame]	934
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	935	WARNING: if you rerun the configure script with different options, you
				936	must run "make clean" before rebuilding. Exceptions to this rule:
				937	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]	938	Modules/getpath.o.
Guido van Rossum	433c8ad	1994-08-01 12:07:07	[diff] [blame]	939
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	940	--with(out)-gcc: The configure script uses gcc (the GNU C compiler) if
				941	it finds it. If you don't want this, or if this compiler is
				942	installed but broken on your platform, pass the option
				943	--without-gcc. You can also pass "CC=cc" (or whatever the
				944	name of the proper C compiler is) in the environment, but the
				945	advantage of using --without-gcc is that this option is
				946	remembered by the config.status script for its --recheck
				947	option.
Guido van Rossum	76be6ed	1995-01-02 18:33:54	[diff] [blame]	948
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	949	--prefix, --exec-prefix: If you want to install the binaries and the
				950	Python library somewhere else than in /usr/local/{bin,lib},
				951	you can pass the option --prefix=DIRECTORY; the interpreter
				952	binary will be installed as DIRECTORY/bin/python and the
				953	library files as DIRECTORY/lib/python/*. If you pass
				954	--exec-prefix=DIRECTORY (as well) this overrides the
				955	installation prefix for architecture-dependent files (like the
				956	interpreter binary). Note that --prefix=DIRECTORY also
				957	affects the default module search path (sys.path), when
				958	Modules/config.c is compiled. Passing make the option
				959	prefix=DIRECTORY (and/or exec_prefix=DIRECTORY) overrides the
				960	prefix set at configuration time; this may be more convenient
				961	than re-running the configure script if you change your mind
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	962	about the install prefix.
Guido van Rossum	76be6ed	1995-01-02 18:33:54	[diff] [blame]	963
Guido van Rossum	59b0b60	2002-02-08 22:22:35	[diff] [blame]	964	--with-readline: This option is no longer supported. GNU
				965	readline is automatically enabled by setup.py when present.
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	966
Guido van Rossum	7ac1153	2000-08-29 21:36:40	[diff] [blame]	967	--with-threads: On most Unix systems, you can now use multiple
				968	threads, and support for this is enabled by default. To
				969	disable this, pass --with-threads=no. If the library required
				970	for threads lives in a peculiar place, you can use
				971	--with-thread=DIRECTORY. IMPORTANT: run "make clean" after
				972	changing (either enabling or disabling) this option, or you
				973	will get link errors! Note: for DEC Unix use
Guido van Rossum	0e13da9	1998-02-22 04:36:34	[diff] [blame]	974	--with-dec-threads instead.
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	975
				976	--with-sgi-dl: On SGI IRIX 4, dynamic loading of extension modules is
				977	supported by the "dl" library by Jack Jansen, which is
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	978	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]	979	This is enabled (after you've ftp'ed and compiled the dl
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	980	library) by passing --with-sgi-dl=DIRECTORY where DIRECTORY
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	981	is the absolute pathname of the dl library. (Don't bother on
				982	IRIX 5, it already has dynamic linking using SunOS style
Martin v. Löwis	779ffc0	2002-12-02 22:17:01	[diff] [blame]	983	shared libraries.) THIS OPTION IS UNSUPPORTED.
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	984
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	985	--with-dl-dld: Dynamic loading of modules is rumored to be supported
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	986	on some other systems: VAX (Ultrix), Sun3 (SunOS 3.4), Sequent
				987	Symmetry (Dynix), and Atari ST. This is done using a
				988	combination of the GNU dynamic loading package
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	989	(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]	990	emulation of the SGI dl library mentioned above (the emulation
				991	can be found at
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	992	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]	993	enable this, ftp and compile both libraries, then call
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	994	configure, passing it the option
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	995	--with-dl-dld=DL_DIRECTORY,DLD_DIRECTORY where DL_DIRECTORY is
				996	the absolute pathname of the dl emulation library and
				997	DLD_DIRECTORY is the absolute pathname of the GNU dld library.
				998	(Don't bother on SunOS 4 or 5, they already have dynamic
Martin v. Löwis	779ffc0	2002-12-02 22:17:01	[diff] [blame]	999	linking using shared libraries.) THIS OPTION IS UNSUPPORTED.
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	1000
				1001	--with-libm, --with-libc: It is possible to specify alternative
				1002	versions for the Math library (default -lm) and the C library
				1003	(default the empty string) using the options
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	1004	--with-libm=STRING and --with-libc=STRING, respectively. For
				1005	example, if your system requires that you pass -lc_s to the C
				1006	compiler to use the shared C library, you can pass
				1007	--with-libc=-lc_s. These libraries are passed after all other
				1008	libraries, the C library last.
Guido van Rossum	16e809e	2001-04-16 02:07:08	[diff] [blame]	1009
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	1010	--with-libs='libs': Add 'libs' to the LIBS that the python interpreter
				1011	is linked against.
Guido van Rossum	d02ba45	1996-07-31 17:36:01	[diff] [blame]	1012
Martin v. Löwis	2df6694	2000-12-13 14:14:32	[diff] [blame]	1013	--with-cxx=<compiler>: Some C++ compilers require that main() is
				1014	compiled with the C++ if there is any C++ code in the application.
				1015	Specifically, g++ on a.out systems may require that to support
				1016	construction of global objects. With this option, the main() function
				1017	of Python will be compiled with <compiler>; use that only if you
				1018	plan to use C++ extension modules, and if your compiler requires
				1019	compilation of main() as a C++ program.
				1020
				1021
Fred Drake	6caae14	2000-10-25 17:51:02	[diff] [blame]	1022	--with-pydebug: Enable additional debugging code to help track down
				1023	memory management problems. This allows printing a list of all
				1024	live objects when the interpreter terminates.
Jack Jansen	7b8c754	2002-04-14 20:12:41	[diff] [blame]	1025
				1026	--with(out)-universal-newlines: enable reading of text files with
				1027	foreign newline convention (default: enabled). In other words,
				1028	any of \r, \n or \r\n is acceptable as end-of-line character.
				1029	If enabled import and execfile will automatically accept any newline
				1030	in files. Python code can open a file with open(file, 'U') to
Martin v. Löwis	7e4cfcb	2002-12-19 16:21:49	[diff] [blame]	1031	read it in universal newline mode. THIS OPTION IS UNSUPPORTED.
Fred Drake	6caae14	2000-10-25 17:51:02	[diff] [blame]	1032
Martin v. Löwis	f30d60e	2004-06-08 08:17:44	[diff] [blame]	1033	--with-tsc: Profile using the Pentium timestamping counter (TSC).
Guido van Rossum	76be6ed	1995-01-02 18:33:54	[diff] [blame]	1034
Guido van Rossum	433c8ad	1994-08-01 12:07:07	[diff] [blame]	1035	Building for multiple architectures (using the VPATH feature)
				1036	-------------------------------------------------------------
				1037
				1038	If your file system is shared between multiple architectures, it
				1039	usually is not necessary to make copies of the sources for each
				1040	architecture you want to support. If the make program supports the
				1041	VPATH feature, you can create an empty build directory for each
				1042	architecture, and in each directory run the configure script (on the
				1043	appropriate machine with the appropriate options). This creates the
				1044	necessary subdirectories and the Makefiles therein. The Makefiles
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	1045	contain a line VPATH=... which points to a directory containing the
Guido van Rossum	d0fe845	1996-08-26 03:02:37	[diff] [blame]	1046	actual sources. (On SGI systems, use "smake -J1" instead of "make" if
				1047	you use VPATH -- don't try gnumake.)
Guido van Rossum	433c8ad	1994-08-01 12:07:07	[diff] [blame]	1048
				1049	For example, the following is all you need to build a minimal Python
				1050	in /usr/tmp/python (assuming ~guido/src/python is the toplevel
				1051	directory and you want to build in /usr/tmp/python):
				1052
				1053	$ mkdir /usr/tmp/python
				1054	$ cd /usr/tmp/python
				1055	$ ~guido/src/python/configure
				1056	[...]
				1057	$ make
				1058	[...]
				1059	$
				1060
Neil Schemenauer	73f8ab2	2001-01-26 22:18:55	[diff] [blame]	1061	Note that configure copies the original Setup file to the build
Guido van Rossum	433c8ad	1994-08-01 12:07:07	[diff] [blame]	1062	directory if it finds no Setup file there. This means that you can
				1063	edit the Setup file for each architecture independently. For this
				1064	reason, subsequent changes to the original Setup file are not tracked
				1065	automatically, as they might overwrite local changes. To force a copy
				1066	of a changed original Setup file, delete the target Setup file. (The
				1067	makesetup script supports multiple input files, so if you want to be
				1068	fancy you can change the rules to create an empty Setup.local if it
				1069	doesn't exist and run it with arguments $(srcdir)/Setup Setup.local;
				1070	however this assumes that you only need to add modules.)
				1071
				1072
Guido van Rossum	433c8ad	1994-08-01 12:07:07	[diff] [blame]	1073	Building on non-UNIX systems
				1074	----------------------------
				1075
Martin v. Löwis	938118a	2004-12-24 08:27:20	[diff] [blame]	1076	For Windows (2000/NT/ME/98/95), assuming you have MS VC++ 7.1, the
Tim Peters	0344424	2000-09-19 00:38:35	[diff] [blame]	1077	project files are in PCbuild, the workspace is pcbuild.dsw. See
				1078	PCbuild\readme.txt for detailed instructions.
Guido van Rossum	8d7d4ed	1996-07-30 21:41:07	[diff] [blame]	1079
Martin v. Löwis	938118a	2004-12-24 08:27:20	[diff] [blame]	1080	For other non-Unix Windows compilers, in particular MS VC++ 6.0 and
Guido van Rossum	31ae207	1999-04-12 14:47:30	[diff] [blame]	1081	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]	1082
				1083	For the Mac, a separate source distribution will be made available,
				1084	for use with the CodeWarrior compiler. If you are interested in Mac
				1085	development, join the PythonMac Special Interest Group
				1086	(http://www.python.org/sigs/pythonmac-sig/, or send email to
				1087	pythonmac-sig-request@python.org).
				1088
				1089	Of course, there are also binary distributions available for these
Guido van Rossum	67345eb	2001-01-18 14:51:12	[diff] [blame]	1090	platforms -- see http://www.python.org/.
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	1091
				1092	To port Python to a new non-UNIX system, you will have to fake the
				1093	effect of running the configure script manually (for Mac and PC, this
				1094	has already been done for you). A good start is to copy the file
Michael W. Hudson	be6e0f4	2002-06-23 16:29:36	[diff] [blame]	1095	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]	1096	configuration of your system. Most symbols must simply be defined as
				1097	1 only if the corresponding feature is present and can be left alone
Michael W. Hudson	be6e0f4	2002-06-23 16:29:36	[diff] [blame]	1098	otherwise; however the *_t type symbols must be defined as some
				1099	variant of int if they need to be defined at all.
Guido van Rossum	433c8ad	1994-08-01 12:07:07	[diff] [blame]	1100
Barry Warsaw	0655745	2001-12-14 20:47:12	[diff] [blame]	1101	For all platforms, it's important that the build arrange to define the
				1102	preprocessor symbol NDEBUG on the compiler command line in a release
				1103	build of Python (else assert() calls remain in the code, hurting
				1104	release-build performance). The Unix, Windows and Mac builds already
				1105	do this.
Guido van Rossum	433c8ad	1994-08-01 12:07:07	[diff] [blame]	1106
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	1107
				1108	Miscellaneous issues
				1109	====================
				1110
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	1111	Emacs mode
				1112	----------
				1113
Guido van Rossum	c0be2f5	1997-10-08 05:05:28	[diff] [blame]	1114	There's an excellent Emacs editing mode for Python code; see the file
				1115	Misc/python-mode.el. Originally written by the famous Tim Peters, it
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	1116	is now maintained by the equally famous Barry Warsaw (it's no
Guido van Rossum	67345eb	2001-01-18 14:51:12	[diff] [blame]	1117	coincidence that they now both work on the same team). The latest
Guido van Rossum	c07d5fa	2000-09-01 22:50:02	[diff] [blame]	1118	version, along with various other contributed Python-related Emacs
Guido van Rossum	67345eb	2001-01-18 14:51:12	[diff] [blame]	1119	goodies, is online at http://www.python.org/emacs/python-mode. And
Guido van Rossum	c07d5fa	2000-09-01 22:50:02	[diff] [blame]	1120	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]	1121	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]	1122	contains a "python" style used throughout most of the Python C source
				1123	files. (Newer versions of Emacs or XEmacs may already come with the
				1124	latest version of python-mode.)
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	1125
				1126
Guido van Rossum	59b0b60	2002-02-08 22:22:35	[diff] [blame]	1127	Tkinter
				1128	-------
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	1129
Guido van Rossum	59b0b60	2002-02-08 22:22:35	[diff] [blame]	1130	The setup.py script automatically configures this when it detects a
				1131	usable Tcl/Tk installation. This requires Tcl/Tk version 8.0 or
Fred Drake	8179a9d	2000-09-28 23:28:30	[diff] [blame]	1132	higher.
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	1133
Guido van Rossum	973e4dc	2000-07-01 00:34:39	[diff] [blame]	1134	For more Tkinter information, see the Tkinter Resource page:
				1135	http://www.python.org/topics/tkinter/
Guido van Rossum	c0be2f5	1997-10-08 05:05:28	[diff] [blame]	1136
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	1137	There are demos in the Demo/tkinter directory, in the subdirectories
				1138	guido, matt and www (the matt and guido subdirectories have been
				1139	overhauled to use more recent Tkinter coding conventions).
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	1140
				1141	Note that there's a Python module called "Tkinter" (capital T) which
Guido van Rossum	c07d5fa	2000-09-01 22:50:02	[diff] [blame]	1142	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]	1143	(lower case t and leading underscore) which lives in
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	1144	Modules/_tkinter.c. Demos and normal Tk applications import only the
Guido van Rossum	59b0b60	2002-02-08 22:22:35	[diff] [blame]	1145	Python Tkinter module -- only the latter imports the C _tkinter
				1146	module. In order to find the C _tkinter module, it must be compiled
				1147	and linked into the Python interpreter -- the setup.py script does
				1148	this. In order to find the Python Tkinter module, sys.path must be
				1149	set correctly -- normal installation takes care of this.
Guido van Rossum	84c8c7f	1995-08-28 02:44:24	[diff] [blame]	1150
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	1151
Guido van Rossum	433c8ad	1994-08-01 12:07:07	[diff] [blame]	1152	Distribution structure
				1153	----------------------
				1154
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	1155	Most subdirectories have their own README files. Most files have
Guido van Rossum	433c8ad	1994-08-01 12:07:07	[diff] [blame]	1156	comments.
				1157
Guido van Rossum	c07d5fa	2000-09-01 22:50:02	[diff] [blame]	1158	.cvsignore Additional filename matching patterns for CVS to ignore
				1159	BeOS/ Files specific to the BeOS port
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	1160	Demo/ Demonstration scripts, modules and programs
Guido van Rossum	c07d5fa	2000-09-01 22:50:02	[diff] [blame]	1161	Doc/ Documentation sources (LaTeX)
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	1162	Grammar/ Input for the parser generator
				1163	Include/ Public header files
Guido van Rossum	c07d5fa	2000-09-01 22:50:02	[diff] [blame]	1164	LICENSE Licensing information
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	1165	Lib/ Python library modules
Michael W. Hudson	be6e0f4	2002-06-23 16:29:36	[diff] [blame]	1166	Mac/ Macintosh specific resources
Neil Schemenauer	3f52da5	2001-01-24 17:49:59	[diff] [blame]	1167	Makefile.pre.in Source from which config.status creates the Makefile.pre
Guido van Rossum	c0be2f5	1997-10-08 05:05:28	[diff] [blame]	1168	Misc/ Miscellaneous useful files
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	1169	Modules/ Implementation of most built-in modules
				1170	Objects/ Implementation of most built-in object types
Guido van Rossum	c07d5fa	2000-09-01 22:50:02	[diff] [blame]	1171	PC/ Files specific to PC ports (DOS, Windows, OS/2)
				1172	PCbuild/ Build directory for Microsoft Visual C++
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	1173	Parser/ The parser and tokenizer and their input handling
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	1174	Python/ The byte-compiler and interpreter
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	1175	README The file you're reading now
				1176	Tools/ Some useful programs written in Python
Michael W. Hudson	be6e0f4	2002-06-23 16:29:36	[diff] [blame]	1177	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]	1178	configure Configuration shell script (GNU autoconf output)
Guido van Rossum	c07d5fa	2000-09-01 22:50:02	[diff] [blame]	1179	configure.in Configuration specification (input for GNU autoconf)
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	1180	install-sh Shell script used to install files
Guido van Rossum	91cb9d2	1995-04-10 11:47:38	[diff] [blame]	1181
				1182	The following files will (may) be created in the toplevel directory by
				1183	the configuration and build processes:
				1184
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	1185	Makefile Build rules
Neil Schemenauer	3f52da5	2001-01-24 17:49:59	[diff] [blame]	1186	Makefile.pre Build rules before running Modules/makesetup
Michael W. Hudson	be6e0f4	2002-06-23 16:29:36	[diff] [blame]	1187	buildno Keeps track of the build number
Guido van Rossum	c07d5fa	2000-09-01 22:50:02	[diff] [blame]	1188	config.cache Cache of configuration variables
Michael W. Hudson	be6e0f4	2002-06-23 16:29:36	[diff] [blame]	1189	pyconfig.h Configuration header
Guido van Rossum	c0be2f5	1997-10-08 05:05:28	[diff] [blame]	1190	config.log Log from last configure run
Guido van Rossum	4f40c2d	2000-09-05 16:46:22	[diff] [blame]	1191	config.status Status from last run of the configure script
Guido van Rossum	c07d5fa	2000-09-01 22:50:02	[diff] [blame]	1192	getbuildinfo.o Object file from Modules/getbuildinfo.c
Guido van Rossum	67345eb	2001-01-18 14:51:12	[diff] [blame]	1193	libpython<version>.a The library archive
Guido van Rossum	6d9cc80	1996-08-01 17:31:22	[diff] [blame]	1194	python The executable interpreter
				1195	tags, TAGS Tags files for vi and Emacs
Guido van Rossum	433c8ad	1994-08-01 12:07:07	[diff] [blame]	1196
				1197
Guido van Rossum	c07d5fa	2000-09-01 22:50:02	[diff] [blame]	1198	That's all, folks!
				1199	------------------
Guido van Rossum	433c8ad	1994-08-01 12:07:07	[diff] [blame]	1200
				1201
Guido van Rossum	67345eb	2001-01-18 14:51:12	[diff] [blame]	1202	--Guido van Rossum (home page: http://www.python.org/~guido/)