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

blob: c263936b72cac09ee4aea13128be5132e3ed7675 [file] [log] [blame]

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