/Modules/Setup.dist

  1# -*- makefile -*-
  2# 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
  5# Setup.dist; once it exists it will not be overwritten, so you can edit
  6# Setup to your heart's content.  Note that Makefile.pre is created
  7# from Makefile.pre.in by the toplevel configure script.
  8
  9# (VPATH notes: Setup and Makefile.pre are in the build directory, as
 10# are Makefile and config.c; the *.in and *.dist files are in the source
 11# directory.)
 12
 13# Each line in this file describes one or more optional modules.
 14# 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
 17# Lines have the following structure:
 18#
 19# <module> ... [<sourcefile> ...] [<cpparg> ...] [<library> ...]
 20#
 21# <sourcefile> is anything ending in .c (.C, .cc, .c++ are C++ files)
 22# <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#
 27# (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#
 31# Lines can also have the form
 32#
 33# <name> = <value>
 34#
 35# which defines a Make variable definition inserted into Makefile.in
 36#
 37# 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# built statically.  The build process works like this:
 40#
 41# 1. Build all modules that are declared as static in Modules/Setup,
 42#    combine them into libpythonxy.a, combine that into python.
 43# 2. Build all modules that are listed as shared in Modules/Setup.
 44# 3. Invoke setup.py. That builds all modules that
 45#    a) are not builtin, and
 46#    b) are not listed in Modules/Setup, and
 47#    c) can be build on the target
 48#
 49# Therefore, modules declared to be shared will not be
 50# included in the config.c file, nor in the list of objects to be
 51# added to the library archive, and their linker options won't be
 52# added to the linker options. Rules to create their .o files and
 53# their shared libraries will still be added to the Makefile, and
 54# their names will be collected in the Make variable SHAREDMODS.  This
 55# is used to build modules as shared libraries.  (They can be
 56# installed using "make sharedinstall", which is implied by the
 57# toplevel "make install" target.)  (For compatibility,
 58# *noconfig* has the same effect as *shared*.)
 59#
 60# In addition, *static* explicitly declares the following modules to
 61# be static.  Lines containing "*static*" and "*shared*" may thus
 62# alternate throughout this file.
 63
 64# NOTE: As a standard policy, as many modules as can be supported by a
 65# platform should be present.  The distribution comes with all modules
 66# enabled that are supported by most platforms and don't require you
 67# to ftp sources from elsewhere.
 68
 69
 70# Some special rules to define PYTHONPATH.
 71# Edit the definitions below to indicate which options you are using.
 72# Don't add any whitespace or comments!
 73
 74# Directories where library files get installed.
 75# DESTLIB is for Python modules; MACHDESTLIB for shared libraries.
 76DESTLIB=$(LIBDEST)
 77MACHDESTLIB=$(BINLIBDEST)
 78
 79# NOTE: all the paths are now relative to the prefix that is computed
 80# at run time!
 81
 82# Standard path -- don't edit.
 83# No leading colon since this is the first entry.
 84# Empty since this is now just the runtime prefix.
 85DESTPATH=
 86
 87# Site specific path components -- should begin with : if non-empty
 88SITEPATH=
 89
 90# Standard path components for test modules
 91TESTPATH=
 92
 93# Path components for machine- or system-dependent modules and shared libraries
 94MACHDEPPATH=:plat-$(MACHDEP)
 95EXTRAMACHDEPPATH=
 96
 97# Path component for the Tkinter-related modules
 98# The TKPATH variable is always enabled, to save you the effort.
 99TKPATH=:lib-tk
100
101# Path component for old modules.
102OLDPATH=:lib-old
103
104COREPYTHONPATH=$(DESTPATH)$(SITEPATH)$(TESTPATH)$(MACHDEPPATH)$(EXTRAMACHDEPPATH)$(TKPATH)$(OLDPATH)
105PYTHONPATH=$(COREPYTHONPATH)
106
107
108# The modules listed here can't be built as shared libraries for
109# various reasons; therefore they are listed here instead of in the
110# normal order.
111
112# This only contains the minimal set of modules required to run the 
113# setup.py script in the root of the Python source tree.
114
115posix posixmodule.c		# posix (UNIX) system calls
116errno errnomodule.c		# posix (UNIX) errno values
117pwd pwdmodule.c			# this is needed to find out the user's home dir
118				# if $HOME is not set
119_sre _sre.c			# Fredrik Lundh's new regular expressions
120_codecs _codecsmodule.c		# access to the builtin codecs and codec registry
121
122# The zipimport module is always imported at startup. Having it as a
123# builtin module avoids some bootstrapping problems and reduces overhead.
124zipimport zipimport.c
125
126# The rest of the modules listed in this file are all commented out by
127# default.  Usually they can be detected and built as dynamically
128# loaded modules by the new setup.py script added in Python 2.1.  If
129# you're on a platform that doesn't support dynamic loading, want to 
130# compile modules statically into the Python binary, or need to 
131# specify some odd set of compiler switches, you can uncomment the 
132# appropriate lines below.
133
134# ======================================================================
135
136# The Python symtable module depends on .h files that setup.py doesn't track
137_symtable symtablemodule.c
138
139# The SGI specific GL module:
140
141GLHACK=-Dclear=__GLclear
142#gl glmodule.c cgensupport.c -I$(srcdir) $(GLHACK) -lgl -lX11
143
144# Pure module.  Cannot be linked dynamically.
145# -DWITH_QUANTIFY, -DWITH_PURIFY, or -DWITH_ALL_PURE
146#WHICH_PURE_PRODUCTS=-DWITH_ALL_PURE
147#PURE_INCLS=-I/usr/local/include
148#PURE_STUBLIBS=-L/usr/local/lib -lpurify_stubs -lquantify_stubs
149#pure puremodule.c $(WHICH_PURE_PRODUCTS) $(PURE_INCLS) $(PURE_STUBLIBS)
150
151# Uncommenting the following line tells makesetup that all following
152# modules are to be built as shared libraries (see above for more
153# detail; also note that *static* reverses this effect):
154
155#*shared*
156
157# GNU readline.  Unlike previous Python incarnations, GNU readline is
158# now incorporated in an optional module, configured in the Setup file
159# instead of by a configure script switch.  You may have to insert a
160# -L option pointing to the directory where libreadline.* lives,
161# and you may have to change -ltermcap to -ltermlib or perhaps remove
162# it, depending on your system -- see the GNU readline instructions.
163# It's okay for this to be a shared library, too.
164
165#readline readline.c -lreadline -ltermcap
166
167
168# Modules that should always be present (non UNIX dependent):
169
170#array arraymodule.c	# array objects
171#cmath cmathmodule.c # -lm # complex math library functions
172#math mathmodule.c # -lm # math library functions, e.g. sin()
173#_struct _struct.c	# binary structure packing/unpacking
174#time timemodule.c # -lm # time operations and variables
175#operator operator.c	# operator.add() and similar goodies
176#_weakref _weakref.c	# basic weak reference support
177#_testcapi _testcapimodule.c    # Python C API test module
178#_random _randommodule.c	# Random number generator
179#_collections _collectionsmodule.c # Container types
180#itertools itertoolsmodule.c	# Functions creating iterators for efficient looping 
181#strop stropmodule.c		# String manipulations
182#_functools _functoolsmodule.c	# Tools for working with functions and callable objects
183#_elementtree -I$(srcdir)/Modules/expat -DHAVE_EXPAT_CONFIG_H -DUSE_PYEXPAT_CAPI _elementtree.c	# elementtree accelerator
184#_pickle _pickle.c	# pickle accelerator
185#datetime datetimemodule.c	# date/time type
186#_bisect _bisectmodule.c	# Bisection algorithms
187
188#unicodedata unicodedata.c    # static Unicode character database
189
190# access to ISO C locale support
191#_locale _localemodule.c  # -lintl
192
193
194# Modules with some UNIX dependencies -- on by default:
195# (If you have a really backward UNIX, select and socket may not be
196# supported...)
197
198#fcntl fcntlmodule.c	# fcntl(2) and ioctl(2)
199#spwd spwdmodule.c		# spwd(3) 
200#grp grpmodule.c		# grp(3)
201#select selectmodule.c	# select(2); not on ancient System V
202
203# Memory-mapped files (also works on Win32).
204#mmap mmapmodule.c
205
206# CSV file helper
207#_csv _csv.c
208
209# Socket module helper for socket(2)
210#_socket socketmodule.c
211
212# Socket module helper for SSL support; you must comment out the other
213# socket line above, and possibly edit the SSL variable:
214#SSL=/usr/local/ssl
215#_ssl _ssl.c \
216#	-DUSE_SSL -I$(SSL)/include -I$(SSL)/include/openssl \
217#	-L$(SSL)/lib -lssl -lcrypto
218
219# The crypt module is now disabled by default because it breaks builds
220# on many systems (where -lcrypt is needed), e.g. Linux (I believe).
221#
222# First, look at Setup.config; configure may have set this for you.
223
224#crypt cryptmodule.c # -lcrypt	# crypt(3); needs -lcrypt on some systems
225
226
227# Some more UNIX dependent modules -- off by default, since these
228# are not supported by all UNIX systems:
229
230#nis nismodule.c -lnsl	# Sun yellow pages -- not everywhere
231#termios termios.c	# Steen Lumholt's termios module
232#resource resource.c	# Jeremy Hylton's rlimit interface
233
234
235# Multimedia modules -- off by default.
236# These don't work for 64-bit platforms!!!
237# #993173 says audioop works on 64-bit platforms, though.
238# These represent audio samples or images as strings:
239
240#audioop audioop.c	# Operations on audio samples
241#imageop imageop.c	# Operations on images
242
243
244# Note that the _md5 and _sha modules are normally only built if the
245# system does not have the OpenSSL libs containing an optimized version.
246
247# The _md5 module implements the RSA Data Security, Inc. MD5
248# Message-Digest Algorithm, described in RFC 1321.  The necessary files
249# md5.c and md5.h are included here.
250
251#_md5 md5module.c md5.c
252
253
254# The _sha module implements the SHA checksum algorithms.
255# (NIST's Secure Hash Algorithms.)
256#_sha shamodule.c
257#_sha256 sha256module.c
258#_sha512 sha512module.c
259
260
261# SGI IRIX specific modules -- off by default.
262
263# These module work on any SGI machine:
264
265# *** gl must be enabled higher up in this file ***
266#fm fmmodule.c $(GLHACK) -lfm -lgl		# Font Manager
267#sgi sgimodule.c			# sgi.nap() and a few more
268
269# This module requires the header file
270# /usr/people/4Dgifts/iristools/include/izoom.h:
271#imgfile imgfile.c -limage -lgutil -lgl -lm	# Image Processing Utilities
272
273
274# These modules require the Multimedia Development Option (I think):
275
276#al almodule.c -laudio			# Audio Library
277#cd cdmodule.c -lcdaudio -lds -lmediad	# CD Audio Library
278#cl clmodule.c -lcl -lawareaudio	# Compression Library
279#sv svmodule.c yuvconvert.c -lsvideo -lXext -lX11	# Starter Video
280
281
282# The FORMS library, by Mark Overmars, implements user interface
283# components such as dialogs and buttons using SGI's GL and FM
284# libraries.  You must ftp the FORMS library separately from
285# ftp://ftp.cs.ruu.nl/pub/SGI/FORMS.  It was tested with FORMS 2.2a.
286# NOTE: if you want to be able to use FORMS and curses simultaneously
287# (or both link them statically into the same binary), you must
288# compile all of FORMS with the cc option "-Dclear=__GLclear".
289
290# The FORMS variable must point to the FORMS subdirectory of the forms
291# toplevel directory:
292
293#FORMS=/ufs/guido/src/forms/FORMS
294#fl flmodule.c -I$(FORMS) $(GLHACK) $(FORMS)/libforms.a -lfm -lgl
295
296
297# SunOS specific modules -- off by default:
298
299#sunaudiodev sunaudiodev.c
300
301
302# A Linux specific module -- off by default; this may also work on 
303# some *BSDs.
304
305#linuxaudiodev linuxaudiodev.c
306
307
308# George Neville-Neil's timing module:
309
310#timing timingmodule.c
311
312
313# The _tkinter module.
314#
315# The command for _tkinter is long and site specific.  Please
316# uncomment and/or edit those parts as indicated.  If you don't have a
317# specific extension (e.g. Tix or BLT), leave the corresponding line
318# commented out.  (Leave the trailing backslashes in!  If you
319# experience strange errors, you may want to join all uncommented
320# lines and remove the backslashes -- the backslash interpretation is
321# done by the shell's "read" command and it may not be implemented on
322# every system.
323
324# *** Always uncomment this (leave the leading underscore in!):
325# _tkinter _tkinter.c tkappinit.c -DWITH_APPINIT \
326# *** Uncomment and edit to reflect where your Tcl/Tk libraries are:
327#	-L/usr/local/lib \
328# *** Uncomment and edit to reflect where your Tcl/Tk headers are:
329#	-I/usr/local/include \
330# *** Uncomment and edit to reflect where your X11 header files are:
331#	-I/usr/X11R6/include \
332# *** Or uncomment this for Solaris:
333#	-I/usr/openwin/include \
334# *** Uncomment and edit for Tix extension only:
335#	-DWITH_TIX -ltix8.1.8.2 \
336# *** Uncomment and edit for BLT extension only:
337#	-DWITH_BLT -I/usr/local/blt/blt8.0-unoff/include -lBLT8.0 \
338# *** Uncomment and edit for PIL (TkImaging) extension only:
339#     (See http://www.pythonware.com/products/pil/ for more info)
340#	-DWITH_PIL -I../Extensions/Imaging/libImaging  tkImaging.c \
341# *** Uncomment and edit for TOGL extension only:
342#	-DWITH_TOGL togl.c \
343# *** Uncomment and edit to reflect your Tcl/Tk versions:
344#	-ltk8.2 -ltcl8.2 \
345# *** Uncomment and edit to reflect where your X11 libraries are:
346#	-L/usr/X11R6/lib \
347# *** Or uncomment this for Solaris:
348#	-L/usr/openwin/lib \
349# *** Uncomment these for TOGL extension only:
350#	-lGL -lGLU -lXext -lXmu \
351# *** Uncomment for AIX:
352#	-lld \
353# *** Always uncomment this; X11 libraries to link with:
354#	-lX11
355
356# Lance Ellinghaus's syslog module
357#syslog syslogmodule.c		# syslog daemon interface
358
359
360# Curses support, requring the System V version of curses, often
361# provided by the ncurses library.  e.g. on Linux, link with -lncurses
362# instead of -lcurses).
363#
364# First, look at Setup.config; configure may have set this for you.
365
366#_curses _cursesmodule.c -lcurses -ltermcap
367# Wrapper for the panel library that's part of ncurses and SYSV curses.
368#_curses_panel _curses_panel.c -lpanel -lncurses 
369
370
371# Generic (SunOS / SVR4) dynamic loading module.
372# This is not needed for dynamic loading of Python modules --
373# it is a highly experimental and dangerous device for calling
374# *arbitrary* C functions in *arbitrary* shared libraries:
375
376#dl dlmodule.c
377
378
379# Modules that provide persistent dictionary-like semantics.  You will
380# probably want to arrange for at least one of them to be available on
381# your machine, though none are defined by default because of library
382# dependencies.  The Python module anydbm.py provides an
383# implementation independent wrapper for these; dumbdbm.py provides
384# similar functionality (but slower of course) implemented in Python.
385
386# The standard Unix dbm module has been moved to Setup.config so that
387# it will be compiled as a shared library by default.  Compiling it as
388# a built-in module causes conflicts with the pybsddb3 module since it
389# creates a static dependency on an out-of-date version of db.so.
390#
391# First, look at Setup.config; configure may have set this for you.
392
393#dbm dbmmodule.c 	# dbm(3) may require -lndbm or similar
394
395# Anthony Baxter's gdbm module.  GNU dbm(3) will require -lgdbm:
396#
397# First, look at Setup.config; configure may have set this for you.
398
399#gdbm gdbmmodule.c -I/usr/local/include -L/usr/local/lib -lgdbm
400
401
402# Sleepycat Berkeley DB interface.
403#
404# This requires the Sleepycat DB code, see http://www.sleepycat.com/
405# The earliest supported version of that library is 3.0, the latest
406# supported version is 4.0 (4.1 is specifically not supported, as that
407# changes the semantics of transactional databases). A list of available
408# releases can be found at
409#
410# http://www.sleepycat.com/update/index.html
411#
412# Edit the variables DB and DBLIBVERto point to the db top directory
413# and the subdirectory of PORT where you built it.
414#DB=/usr/local/BerkeleyDB.4.0
415#DBLIBVER=4.0
416#DBINC=$(DB)/include
417#DBLIB=$(DB)/lib
418#_bsddb _bsddb.c -I$(DBINC) -L$(DBLIB) -ldb-$(DBLIBVER)
419
420# Historical Berkeley DB 1.85
421#
422# This module is deprecated; the 1.85 version of the Berkeley DB library has
423# bugs that can cause data corruption. If you can, use later versions of the
424# library instead, available from <http://www.sleepycat.com/>.
425
426#DB=/depot/sundry/src/berkeley-db/db.1.85
427#DBPORT=$(DB)/PORT/irix.5.3
428#bsddb185 bsddbmodule.c -I$(DBPORT)/include -I$(DBPORT) $(DBPORT)/libdb.a
429
430
431
432# Helper module for various ascii-encoders
433#binascii binascii.c
434
435# Fred Drake's interface to the Python parser
436#parser parsermodule.c
437
438# cStringIO and cPickle
439#cStringIO cStringIO.c
440#cPickle cPickle.c
441
442
443# Lee Busby's SIGFPE modules.
444# The library to link fpectl with is platform specific.
445# Choose *one* of the options below for fpectl:
446
447# For SGI IRIX (tested on 5.3):
448#fpectl fpectlmodule.c -lfpe
449
450# For Solaris with SunPro compiler (tested on Solaris 2.5 with SunPro C 4.2):
451# (Without the compiler you don't have -lsunmath.)
452#fpectl fpectlmodule.c -R/opt/SUNWspro/lib -lsunmath -lm
453
454# For other systems: see instructions in fpectlmodule.c.
455#fpectl fpectlmodule.c ...
456
457# Test module for fpectl.  No extra libraries needed.
458#fpetest fpetestmodule.c
459
460# Andrew Kuchling's zlib module.
461# This require zlib 1.1.3 (or later).
462# See http://www.gzip.org/zlib/
463#zlib zlibmodule.c -I$(prefix)/include -L$(exec_prefix)/lib -lz
464
465# Interface to the Expat XML parser
466#
467# Expat was written by James Clark and is now maintained by a group of
468# developers on SourceForge; see www.libexpat.org for more
469# information.  The pyexpat module was written by Paul Prescod after a
470# prototype by Jack Jansen.  Source of Expat 1.95.2 is included in
471# Modules/expat/.  Usage of a system shared libexpat.so/expat.dll is
472# not advised.
473#
474# More information on Expat can be found at www.libexpat.org.
475#
476#pyexpat expat/xmlparse.c expat/xmlrole.c expat/xmltok.c pyexpat.c -I$(srcdir)/Modules/expat -DHAVE_EXPAT_CONFIG_H -DUSE_PYEXPAT_CAPI
477
478
479# Hye-Shik Chang's CJKCodecs
480
481# multibytecodec is required for all the other CJK codec modules
482#_multibytecodec cjkcodecs/multibytecodec.c
483
484#_codecs_cn cjkcodecs/_codecs_cn.c
485#_codecs_hk cjkcodecs/_codecs_hk.c
486#_codecs_iso2022 cjkcodecs/_codecs_iso2022.c
487#_codecs_jp cjkcodecs/_codecs_jp.c
488#_codecs_kr cjkcodecs/_codecs_kr.c
489#_codecs_tw cjkcodecs/_codecs_tw.c
490
491# Example -- included for reference only:
492# xx xxmodule.c
493
494# Another example -- the 'xxsubtype' module shows C-level subtyping in action
495xxsubtype xxsubtype.c