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