blob: f54b13b7fb4ae97671169f84469791afc8221ba4 [file] [log] [blame]
Barry Warsawc7736b91997-09-04 13:05:14 +00001# -*- makefile -*-
Guido van Rossumb6775db1994-08-01 11:34:53 +00002# The file Setup is used by the makesetup script to construct the files
3# Makefile and config.c, from Makefile.pre and config.c.in,
4# respectively. The file Setup itself is initially copied from
Fred Drakecf3bc8c2000-10-26 17:07:40 +00005# Setup.dist; once it exists it will not be overwritten, so you can edit
Guido van Rossumf4449de1995-04-10 11:37:18 +00006# Setup to your heart's content. Note that Makefile.pre is created
7# from Makefile.pre.in by the toplevel configure script.
Guido van Rossumb6775db1994-08-01 11:34:53 +00008
9# (VPATH notes: Setup and Makefile.pre are in the build directory, as
Fred Drakecf3bc8c2000-10-26 17:07:40 +000010# are Makefile and config.c; the *.in and *.dist files are in the source
Guido van Rossumb6775db1994-08-01 11:34:53 +000011# directory.)
12
Guido van Rossumfba715a1994-01-02 00:26:09 +000013# Each line in this file describes one or more optional modules.
Andrew M. Kuchlingab354bb2001-02-27 03:29:52 +000014# Modules enabled here will not be compiled by the setup.py script,
15# so the file can be used to override setup.py's behavior.
16
Guido van Rossumfba715a1994-01-02 00:26:09 +000017# Lines have the following structure:
18#
Guido van Rossumf6971e21994-08-30 12:25:20 +000019# <module> ... [<sourcefile> ...] [<cpparg> ...] [<library> ...]
Guido van Rossumfba715a1994-01-02 00:26:09 +000020#
Guido van Rossumf6971e21994-08-30 12:25:20 +000021# <sourcefile> is anything ending in .c (.C, .cc, .c++ are C++ files)
Guido van Rossumfba715a1994-01-02 00:26:09 +000022# <cpparg> is anything starting with -I, -D, -U or -C
23# <library> is anything ending in .a or beginning with -l or -L
24# <module> is anything else but should be a valid Python
25# identifier (letters, digits, underscores, beginning with non-digit)
26#
Guido van Rossum613b9431996-08-20 19:50:17 +000027# (As the makesetup script changes, it may recognize some other
28# arguments as well, e.g. *.so and *.sl as libraries. See the big
29# case statement in the makesetup script.)
30#
Guido van Rossumfba715a1994-01-02 00:26:09 +000031# Lines can also have the form
32#
33# <name> = <value>
34#
35# which defines a Make variable definition inserted into Makefile.in
Guido van Rossum7cc5abd1994-09-12 10:42:20 +000036#
Guido van Rossum30e817e1997-12-02 16:46:39 +000037# Finally, if a line contains just the word "*shared*" (without the
38# quotes but with the stars), then the following modules will not be
39# included in the config.c file, nor in the list of objects to be
40# added to the library archive, and their linker options won't be
41# added to the linker options, but rules to create their .o files and
42# their shared libraries will still be added to the Makefile, and
43# their names will be collected in the Make variable SHAREDMODS. This
Guido van Rossum7fef86e1998-10-07 14:41:54 +000044# is used to build modules as shared libraries. (They can be
45# installed using "make sharedinstall", which is implied by the
46# toplevel "make install" target.) (For compatibility,
Guido van Rossum30e817e1997-12-02 16:46:39 +000047# *noconfig* has the same effect as *shared*.)
Guido van Rossumb71c5701999-02-22 18:11:18 +000048#
49# In addition, *static* reverses this effect (negating a previous
50# *shared* line).
Guido van Rossumb6775db1994-08-01 11:34:53 +000051
Guido van Rossumfba715a1994-01-02 00:26:09 +000052# NOTE: As a standard policy, as many modules as can be supported by a
53# platform should be present. The distribution comes with all modules
54# enabled that are supported by most platforms and don't require you
Guido van Rossumf4449de1995-04-10 11:37:18 +000055# to ftp sources from elsewhere.
Guido van Rossumfba715a1994-01-02 00:26:09 +000056
57
Guido van Rossumb6775db1994-08-01 11:34:53 +000058# Some special rules to define PYTHONPATH.
59# Edit the definitions below to indicate which options you are using.
60# Don't add any whitespace or comments!
61
Guido van Rossum0c5e3c81996-07-31 17:49:01 +000062# Directories where library files get installed.
63# DESTLIB is for Python modules; MACHDESTLIB for shared libraries.
64DESTLIB=$(LIBDEST)
65MACHDESTLIB=$(BINLIBDEST)
Guido van Rossumb6775db1994-08-01 11:34:53 +000066
Guido van Rossum97227811997-04-11 17:19:54 +000067# NOTE: all the paths are now relative to the prefix that is computed
68# at run time!
69
Guido van Rossum0c5e3c81996-07-31 17:49:01 +000070# Standard path -- don't edit.
Guido van Rossum97227811997-04-11 17:19:54 +000071# No leading colon since this is the first entry.
72# Empty since this is now just the runtime prefix.
73DESTPATH=
Guido van Rossum1c206481995-09-13 18:39:04 +000074
Guido van Rossum0c5e3c81996-07-31 17:49:01 +000075# Site specific path components -- should begin with : if non-empty
76SITEPATH=
77
78# Standard path components for test modules
Guido van Rossum7d83a5e1999-02-08 21:49:22 +000079TESTPATH=
Guido van Rossumb6775db1994-08-01 11:34:53 +000080
Guido van Rossumd3c1bd31996-07-30 16:54:03 +000081# Path components for machine- or system-dependent modules and shared libraries
Guido van Rossuma9f02b81997-09-28 05:45:40 +000082MACHDEPPATH=:plat-$(MACHDEP)
Guido van Rossumb6775db1994-08-01 11:34:53 +000083
Andrew M. Kuchling93b747e2001-01-27 01:31:35 +000084# Path component for the Tkinter-related modules
Andrew M. Kuchlinge7c66912001-01-29 20:13:11 +000085# The TKPATH variable is always enabled, to save you the effort.
Andrew M. Kuchling93b747e2001-01-27 01:31:35 +000086TKPATH=:lib-tk
87
Guido van Rossum2808b742000-05-03 22:34:12 +000088COREPYTHONPATH=$(DESTPATH)$(SITEPATH)$(TESTPATH)$(MACHDEPPATH)$(TKPATH)
Guido van Rossumf5e0ea81994-09-12 15:35:36 +000089PYTHONPATH=$(COREPYTHONPATH)
Guido van Rossumb6775db1994-08-01 11:34:53 +000090
91
Guido van Rossumcaffcdf1995-03-10 15:14:13 +000092# The modules listed here can't be built as shared libraries for
93# various reasons; therefore they are listed here instead of in the
94# normal order.
Guido van Rossum05bf2801994-10-20 22:01:38 +000095
Andrew M. Kuchling3712d392001-01-17 18:55:13 +000096# This only contains the minimal set of modules required to run the
97# setup.py script in the root of the Python source tree.
Guido van Rossumcaffcdf1995-03-10 15:14:13 +000098
99posix posixmodule.c # posix (UNIX) system calls
Guido van Rossume5679352000-03-31 15:01:27 +0000100_sre _sre.c # Fredrik Lundh's new regular expressions
Barry Warsaw60f01882001-08-22 19:24:42 +0000101new newmodule.c # Tommy Burnette's 'new' module
Guido van Rossumcaffcdf1995-03-10 15:14:13 +0000102
Andrew M. Kuchlinge7c66912001-01-29 20:13:11 +0000103# The rest of the modules listed in this file are all commented out by
104# default. Usually they can be detected and built as dynamically
105# loaded modules by the new setup.py script added in Python 2.1. If
106# you're on a platform that doesn't support dynamic loading, want to
107# compile modules statically into the Python binary, or need to
108# specify some odd set of compiler switches, you can uncomment the
109# appropriate lines below.
110
111# ======================================================================
112
Jeremy Hyltona25d9952001-10-17 13:46:44 +0000113# The Python symtable module depends on .h files that setup.py doesn't track
114_symtable symtablemodule.c
115
Andrew M. Kuchlinge7c66912001-01-29 20:13:11 +0000116# The SGI specific GL module:
117
118GLHACK=-Dclear=__GLclear
119#gl glmodule.c cgensupport.c -I$(srcdir) $(GLHACK) -lgl -lX11
120
121# Pure module. Cannot be linked dynamically.
122# -DWITH_QUANTIFY, -DWITH_PURIFY, or -DWITH_ALL_PURE
123#WHICH_PURE_PRODUCTS=-DWITH_ALL_PURE
124#PURE_INCLS=-I/usr/local/include
125#PURE_STUBLIBS=-L/usr/local/lib -lpurify_stubs -lquantify_stubs
126#pure puremodule.c $(WHICH_PURE_PRODUCTS) $(PURE_INCLS) $(PURE_STUBLIBS)
127
128# Uncommenting the following line tells makesetup that all following
129# modules are to be built as shared libraries (see above for more
130# detail; also note that *static* reverses this effect):
131
132#*shared*
133
134# GNU readline. Unlike previous Python incarnations, GNU readline is
135# now incorporated in an optional module, configured in the Setup file
136# instead of by a configure script switch. You may have to insert a
137# -L option pointing to the directory where libreadline.* lives,
138# and you may have to change -ltermcap to -ltermlib or perhaps remove
139# it, depending on your system -- see the GNU readline instructions.
140# It's okay for this to be a shared library, too.
141
142#readline readline.c -lreadline -ltermcap
143
144
145# Modules that should always be present (non UNIX dependent):
146
147#array arraymodule.c # array objects
148#cmath cmathmodule.c # -lm # complex math library functions
149#math mathmodule.c # -lm # math library functions, e.g. sin()
150#struct structmodule.c # binary structure packing/unpacking
151#time timemodule.c # -lm # time operations and variables
152#operator operator.c # operator.add() and similar goodies
Fred Drake2de74712001-02-01 05:26:54 +0000153#_weakref _weakref.c # basic weak reference support
Andrew M. Kuchlinge7c66912001-01-29 20:13:11 +0000154#_codecs _codecsmodule.c # access to the builtin codecs and codec registry
Tim Petersf36fb692001-02-04 09:18:21 +0000155#_testcapi _testcapimodule.c # Python C API test module
Andrew M. Kuchlinge7c66912001-01-29 20:13:11 +0000156
Martin v. Löwis76192ee2001-02-06 09:34:40 +0000157#unicodedata unicodedata.c # static Unicode character database
Andrew M. Kuchlinge7c66912001-01-29 20:13:11 +0000158
159#_locale _localemodule.c # access to ISO C locale support
160
161
162# Modules with some UNIX dependencies -- on by default:
163# (If you have a really backward UNIX, select and socket may not be
164# supported...)
165
166#fcntl fcntlmodule.c # fcntl(2) and ioctl(2)
167#pwd pwdmodule.c # pwd(3)
168#grp grpmodule.c # grp(3)
169#errno errnomodule.c # posix (UNIX) errno values
170#select selectmodule.c # select(2); not on ancient System V
171
172# Memory-mapped files (also works on Win32).
173#mmap mmapmodule.c
174
175# Dynamic readlines
176#xreadlines xreadlinesmodule.c
177
178# for socket(2), without SSL support.
179#_socket socketmodule.c
180
181# Socket module compiled with SSL support; you must comment out the other
182# socket line above, and possibly edit the SSL variable:
183#SSL=/usr/local/ssl
184#_socket socketmodule.c \
185# -DUSE_SSL -I$(SSL)/include -I$(SSL)/include/openssl \
186# -L$(SSL)/lib -lssl -lcrypto
187
188# The crypt module is now disabled by default because it breaks builds
189# on many systems (where -lcrypt is needed), e.g. Linux (I believe).
190#
191# First, look at Setup.config; configure may have set this for you.
192
193#crypt cryptmodule.c # -lcrypt # crypt(3); needs -lcrypt on some systems
194
195
196# Some more UNIX dependent modules -- off by default, since these
197# are not supported by all UNIX systems:
198
199#nis nismodule.c -lnsl # Sun yellow pages -- not everywhere
200#termios termios.c # Steen Lumholt's termios module
201#resource resource.c # Jeremy Hylton's rlimit interface
202
203
204# Multimedia modules -- off by default.
205# These don't work for 64-bit platforms!!!
206# These represent audio samples or images as strings:
207
208#audioop audioop.c # Operations on audio samples
209#imageop imageop.c # Operations on images
210#rgbimg rgbimgmodule.c # Read SGI RGB image files (but coded portably)
211
212
213# The md5 module implements the RSA Data Security, Inc. MD5
214# Message-Digest Algorithm, described in RFC 1321. The necessary files
215# md5c.c and md5.h are included here.
216
217#md5 md5module.c md5c.c
218
219
220# The sha module implements the SHA checksum algorithm.
221# (NIST's Secure Hash Algorithm.)
222#sha shamodule.c
223
224
225# The mpz module interfaces to the GNU Multiple Precision library.
226# You need to ftp the GNU MP library.
227# The GMP variable must point to the GMP source directory.
228# This was originally written and tested against GMP 1.2 and 1.3.2.
229# It has been modified by Rob Hooft to work with 2.0.2 as well, but I
230# haven't tested it recently.
231
232# A compatible MP library unencombered by the GPL also exists. It was
233# posted to comp.sources.misc in volume 40 and is widely available from
234# FTP archive sites. One URL for it is:
235# ftp://gatekeeper.dec.com/.b/usenet/comp.sources.misc/volume40/fgmp/part01.Z
236
237#GMP=/ufs/guido/src/gmp
238#mpz mpzmodule.c -I$(GMP) $(GMP)/libgmp.a
239
240
241# SGI IRIX specific modules -- off by default.
242
243# These module work on any SGI machine:
244
245# *** gl must be enabled higher up in this file ***
246#fm fmmodule.c $(GLHACK) -lfm -lgl # Font Manager
247#sgi sgimodule.c # sgi.nap() and a few more
248
249# This module requires the header file
250# /usr/people/4Dgifts/iristools/include/izoom.h:
251#imgfile imgfile.c -limage -lgutil -lgl -lm # Image Processing Utilities
252
253
254# These modules require the Multimedia Development Option (I think):
255
256#al almodule.c -laudio # Audio Library
257#cd cdmodule.c -lcdaudio -lds -lmediad # CD Audio Library
258#cl clmodule.c -lcl -lawareaudio # Compression Library
259#sv svmodule.c yuvconvert.c -lsvideo -lXext -lX11 # Starter Video
260
261
262# The FORMS library, by Mark Overmars, implements user interface
263# components such as dialogs and buttons using SGI's GL and FM
264# libraries. You must ftp the FORMS library separately from
265# ftp://ftp.cs.ruu.nl/pub/SGI/FORMS. It was tested with FORMS 2.2a.
266# NOTE: if you want to be able to use FORMS and curses simultaneously
267# (or both link them statically into the same binary), you must
268# compile all of FORMS with the cc option "-Dclear=__GLclear".
269
270# The FORMS variable must point to the FORMS subdirectory of the forms
271# toplevel directory:
272
273#FORMS=/ufs/guido/src/forms/FORMS
274#fl flmodule.c -I$(FORMS) $(GLHACK) $(FORMS)/libforms.a -lfm -lgl
275
276
277# SunOS specific modules -- off by default:
278
279#sunaudiodev sunaudiodev.c
280
281
Andrew M. Kuchlingab354bb2001-02-27 03:29:52 +0000282# A Linux specific module -- off by default; this may also work on
283# some *BSDs.
Andrew M. Kuchlinge7c66912001-01-29 20:13:11 +0000284
285#linuxaudiodev linuxaudiodev.c
286
287
288# George Neville-Neil's timing module:
289
290#timing timingmodule.c
291
292
293# The _tkinter module.
294#
295# The command for _tkinter is long and site specific. Please
296# uncomment and/or edit those parts as indicated. If you don't have a
297# specific extension (e.g. Tix or BLT), leave the corresponding line
298# commented out. (Leave the trailing backslashes in! If you
299# experience strange errors, you may want to join all uncommented
300# lines and remove the backslashes -- the backslash interpretation is
301# done by the shell's "read" command and it may not be implemented on
302# every system.
303
304# *** Always uncomment this (leave the leading underscore in!):
305# _tkinter _tkinter.c tkappinit.c -DWITH_APPINIT \
Guido van Rossum86525222001-03-22 22:18:55 +0000306# *** Uncomment and edit to reflect where your Tcl/Tk libraries are:
307# -L/usr/local/lib \
Andrew M. Kuchlinge7c66912001-01-29 20:13:11 +0000308# *** Uncomment and edit to reflect where your Tcl/Tk headers are:
309# -I/usr/local/include \
310# *** Uncomment and edit to reflect where your X11 header files are:
311# -I/usr/X11R6/include \
312# *** Or uncomment this for Solaris:
313# -I/usr/openwin/include \
314# *** Uncomment and edit for Tix extension only:
Guido van Rossum86525222001-03-22 22:18:55 +0000315# -DWITH_TIX -ltix8.1.8.2 \
Andrew M. Kuchlinge7c66912001-01-29 20:13:11 +0000316# *** Uncomment and edit for BLT extension only:
317# -DWITH_BLT -I/usr/local/blt/blt8.0-unoff/include -lBLT8.0 \
318# *** Uncomment and edit for PIL (TkImaging) extension only:
319# (See http://www.pythonware.com/products/pil/ for more info)
320# -DWITH_PIL -I../Extensions/Imaging/libImaging tkImaging.c \
321# *** Uncomment and edit for TOGL extension only:
322# -DWITH_TOGL togl.c \
Andrew M. Kuchlinge7c66912001-01-29 20:13:11 +0000323# *** Uncomment and edit to reflect your Tcl/Tk versions:
Guido van Rossum86525222001-03-22 22:18:55 +0000324# -ltk8.2 -ltcl8.2 \
Andrew M. Kuchlinge7c66912001-01-29 20:13:11 +0000325# *** Uncomment and edit to reflect where your X11 libraries are:
326# -L/usr/X11R6/lib \
327# *** Or uncomment this for Solaris:
328# -L/usr/openwin/lib \
329# *** Uncomment these for TOGL extension only:
330# -lGL -lGLU -lXext -lXmu \
331# *** Uncomment for AIX:
332# -lld \
333# *** Always uncomment this; X11 libraries to link with:
334# -lX11
335
336# Lance Ellinghaus's modules:
337
338#rotor rotormodule.c # enigma-inspired encryption
339#syslog syslogmodule.c # syslog daemon interface
340
341
342# Curses support, requring the System V version of curses, often
343# provided by the ncurses library. e.g. on Linux, link with -lncurses
344# instead of -lcurses; on SunOS 4.1.3, insert -I/usr/5include
345# -L/usr/5lib before -lcurses).
346#
347# First, look at Setup.config; configure may have set this for you.
348
349#_curses _cursesmodule.c -lcurses -ltermcap
350# Wrapper for the panel library that's part of ncurses and SYSV curses.
351#_curses_panel _curses_panel.c -lpanel -lncurses
352
353
Andrew M. Kuchlinge7c66912001-01-29 20:13:11 +0000354# Generic (SunOS / SVR4) dynamic loading module.
355# This is not needed for dynamic loading of Python modules --
356# it is a highly experimental and dangerous device for calling
357# *arbitrary* C functions in *arbitrary* shared libraries:
358
359#dl dlmodule.c
360
361
362# Modules that provide persistent dictionary-like semantics. You will
363# probably want to arrange for at least one of them to be available on
364# your machine, though none are defined by default because of library
365# dependencies. The Python module anydbm.py provides an
366# implementation independent wrapper for these; dumbdbm.py provides
367# similar functionality (but slower of course) implemented in Python.
368
369# The standard Unix dbm module has been moved to Setup.config so that
370# it will be compiled as a shared library by default. Compiling it as
371# a built-in module causes conflicts with the pybsddb3 module since it
372# creates a static dependency on an out-of-date version of db.so.
373#
374# First, look at Setup.config; configure may have set this for you.
375
376#dbm dbmmodule.c # dbm(3) may require -lndbm or similar
377
378# Anthony Baxter's gdbm module. GNU dbm(3) will require -lgdbm:
379#
380# First, look at Setup.config; configure may have set this for you.
381
382#gdbm gdbmmodule.c -I/usr/local/include -L/usr/local/lib -lgdbm
383
384
385# Berkeley DB interface.
386#
387# This requires the Berkeley DB code, see
388# ftp://ftp.cs.berkeley.edu/pub/4bsd/db.1.85.tar.gz
389#
390# Edit the variables DB and DBPORT to point to the db top directory
391# and the subdirectory of PORT where you built it.
392#
393# (See http://electricrain.com/greg/python/bsddb3/ for an interface to
394# BSD DB 3.x.)
395
396# Note: If a db.h file is found by configure, bsddb will be enabled
397# automatically via Setup.config.in. It only needs to be enabled here
398# if it is not automatically enabled there; check the generated
399# Setup.config before enabling it here.
400
401#DB=/depot/sundry/src/berkeley-db/db.1.85
402#DBPORT=$(DB)/PORT/irix.5.3
403#bsddb bsddbmodule.c -I$(DBPORT)/include -I$(DBPORT) $(DBPORT)/libdb.a
404
405
406
Andrew M. Kuchlinge7c66912001-01-29 20:13:11 +0000407# Helper module for various ascii-encoders
408#binascii binascii.c
409
410# Fred Drake's interface to the Python parser
411#parser parsermodule.c
412
413# Digital Creations' cStringIO and cPickle
414#cStringIO cStringIO.c
415#cPickle cPickle.c
416
417
418# Lee Busby's SIGFPE modules.
419# The library to link fpectl with is platform specific.
420# Choose *one* of the options below for fpectl:
421
422# For SGI IRIX (tested on 5.3):
423#fpectl fpectlmodule.c -lfpe
424
425# For Solaris with SunPro compiler (tested on Solaris 2.5 with SunPro C 4.2):
426# (Without the compiler you don't have -lsunmath.)
427#fpectl fpectlmodule.c -R/opt/SUNWspro/lib -lsunmath -lm
428
429# For other systems: see instructions in fpectlmodule.c.
430#fpectl fpectlmodule.c ...
431
432# Test module for fpectl. No extra libraries needed.
433#fpetest fpetestmodule.c
434
435# Andrew Kuchling's zlib module.
436# This require zlib 1.1.3 (or later).
437# See http://www.cdrom.com/pub/infozip/zlib/
438#zlib zlibmodule.c -I$(prefix)/include -L$(exec_prefix)/lib -lz
439
440# Interface to the Expat XML parser
441#
442# Expat is written by James Clark and must be downloaded separately
443# (see below). The pyexpat module was written by Paul Prescod after a
444# prototype by Jack Jansen.
445#
446# The Expat dist includes Windows .lib and .dll files. Home page is at
447# http://www.jclark.com/xml/expat.html, the current production release is
448# always ftp://ftp.jclark.com/pub/xml/expat.zip.
449#
450# EXPAT_DIR, below, should point to the expat/ directory created by
451# unpacking the Expat source distribution.
452#
453# Note: the expat build process doesn't yet build a libexpat.a; you can
454# do this manually while we try convince the author to add it. To do so,
455# cd to EXPAT_DIR, run "make" if you have not done so, then run:
456#
457# ar cr libexpat.a xmltok/*.o xmlparse/*.o
458#
459#EXPAT_DIR=/usr/local/src/expat
460#pyexpat pyexpat.c -I$(EXPAT_DIR)/xmlparse -L$(EXPAT_DIR) -lexpat
461
462
463# Example -- included for reference only:
464# xx xxmodule.c
465
Tim Peters6d6c1a32001-08-02 04:15:00 +0000466# Another example -- the 'xxsubtype' module shows C-level subtyping in action
467xxsubtype xxsubtype.c