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

blob: 2b3c97116bd3287397e73cfd652c5cfbb8f530e8 [file] [log] [blame]

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