Minor fix for currentframe (SF #1652788).
[python.git] / Modules / Setup.dist
blob46f4253e1c6de31bc5d0c4f8453bcbea0c249ae6
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.
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.)
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.
17 # Lines have the following structure:
19 # <module> ... [<sourcefile> ...] [<cpparg> ...] [<library> ...]
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)
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.)
31 # Lines can also have the form
33 # <name> = <value>
35 # which defines a Make variable definition inserted into Makefile.in
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:
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
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*.)
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.
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.
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!
74 # Directories where library files get installed.
75 # DESTLIB is for Python modules; MACHDESTLIB for shared libraries.
76 DESTLIB=$(LIBDEST)
77 MACHDESTLIB=$(BINLIBDEST)
79 # NOTE: all the paths are now relative to the prefix that is computed
80 # at run time!
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.
85 DESTPATH=
87 # Site specific path components -- should begin with : if non-empty
88 SITEPATH=
90 # Standard path components for test modules
91 TESTPATH=
93 # Path components for machine- or system-dependent modules and shared libraries
94 MACHDEPPATH=:plat-$(MACHDEP)
95 EXTRAMACHDEPPATH=
97 # Path component for the Tkinter-related modules
98 # The TKPATH variable is always enabled, to save you the effort.
99 TKPATH=:lib-tk
101 COREPYTHONPATH=$(DESTPATH)$(SITEPATH)$(TESTPATH)$(MACHDEPPATH)$(EXTRAMACHDEPPATH)$(TKPATH)
102 PYTHONPATH=$(COREPYTHONPATH)
105 # The modules listed here can't be built as shared libraries for
106 # various reasons; therefore they are listed here instead of in the
107 # normal order.
109 # This only contains the minimal set of modules required to run the 
110 # setup.py script in the root of the Python source tree.
112 posix posixmodule.c             # posix (UNIX) system calls
113 errno errnomodule.c             # posix (UNIX) errno values
114 pwd pwdmodule.c                 # this is needed to find out the user's home dir
115                                 # if $HOME is not set
116 _sre _sre.c                     # Fredrik Lundh's new regular expressions
117 _codecs _codecsmodule.c         # access to the builtin codecs and codec registry
119 # The zipimport module is always imported at startup. Having it as a
120 # builtin module avoids some bootstrapping problems and reduces overhead.
121 zipimport zipimport.c
123 # The rest of the modules listed in this file are all commented out by
124 # default.  Usually they can be detected and built as dynamically
125 # loaded modules by the new setup.py script added in Python 2.1.  If
126 # you're on a platform that doesn't support dynamic loading, want to 
127 # compile modules statically into the Python binary, or need to 
128 # specify some odd set of compiler switches, you can uncomment the 
129 # appropriate lines below.
131 # ======================================================================
133 # The Python symtable module depends on .h files that setup.py doesn't track
134 _symtable symtablemodule.c
136 # The SGI specific GL module:
138 GLHACK=-Dclear=__GLclear
139 #gl glmodule.c cgensupport.c -I$(srcdir) $(GLHACK) -lgl -lX11
141 # Pure module.  Cannot be linked dynamically.
142 # -DWITH_QUANTIFY, -DWITH_PURIFY, or -DWITH_ALL_PURE
143 #WHICH_PURE_PRODUCTS=-DWITH_ALL_PURE
144 #PURE_INCLS=-I/usr/local/include
145 #PURE_STUBLIBS=-L/usr/local/lib -lpurify_stubs -lquantify_stubs
146 #pure puremodule.c $(WHICH_PURE_PRODUCTS) $(PURE_INCLS) $(PURE_STUBLIBS)
148 # Uncommenting the following line tells makesetup that all following
149 # modules are to be built as shared libraries (see above for more
150 # detail; also note that *static* reverses this effect):
152 #*shared*
154 # GNU readline.  Unlike previous Python incarnations, GNU readline is
155 # now incorporated in an optional module, configured in the Setup file
156 # instead of by a configure script switch.  You may have to insert a
157 # -L option pointing to the directory where libreadline.* lives,
158 # and you may have to change -ltermcap to -ltermlib or perhaps remove
159 # it, depending on your system -- see the GNU readline instructions.
160 # It's okay for this to be a shared library, too.
162 #readline readline.c -lreadline -ltermcap
165 # Modules that should always be present (non UNIX dependent):
167 #array arraymodule.c    # array objects
168 #cmath cmathmodule.c # -lm # complex math library functions
169 #math mathmodule.c # -lm # math library functions, e.g. sin()
170 #_struct _struct.c      # binary structure packing/unpacking
171 #time timemodule.c # -lm # time operations and variables
172 #operator operator.c    # operator.add() and similar goodies
173 #_weakref _weakref.c    # basic weak reference support
174 #_testcapi _testcapimodule.c    # Python C API test module
175 #_random _randommodule.c        # Random number generator
176 #collections collectionsmodule.c # Container types
177 #itertools itertoolsmodule.c    # Functions creating iterators for efficient looping 
178 #strop stropmodule.c            # String manipulations
180 #unicodedata unicodedata.c    # static Unicode character database
182 # access to ISO C locale support
183 #_locale _localemodule.c  # -lintl
186 # Modules with some UNIX dependencies -- on by default:
187 # (If you have a really backward UNIX, select and socket may not be
188 # supported...)
190 #fcntl fcntlmodule.c    # fcntl(2) and ioctl(2)
191 #spwd spwdmodule.c              # spwd(3) 
192 #grp grpmodule.c                # grp(3)
193 #select selectmodule.c  # select(2); not on ancient System V
195 # Memory-mapped files (also works on Win32).
196 #mmap mmapmodule.c
198 # CSV file helper
199 #_csv _csv.c
201 # Socket module helper for socket(2)
202 #_socket socketmodule.c
204 # Socket module helper for SSL support; you must comment out the other
205 # socket line above, and possibly edit the SSL variable:
206 #SSL=/usr/local/ssl
207 #_ssl _ssl.c \
208 #       -DUSE_SSL -I$(SSL)/include -I$(SSL)/include/openssl \
209 #       -L$(SSL)/lib -lssl -lcrypto
211 # The crypt module is now disabled by default because it breaks builds
212 # on many systems (where -lcrypt is needed), e.g. Linux (I believe).
214 # First, look at Setup.config; configure may have set this for you.
216 #crypt cryptmodule.c # -lcrypt  # crypt(3); needs -lcrypt on some systems
219 # Some more UNIX dependent modules -- off by default, since these
220 # are not supported by all UNIX systems:
222 #nis nismodule.c -lnsl  # Sun yellow pages -- not everywhere
223 #termios termios.c      # Steen Lumholt's termios module
224 #resource resource.c    # Jeremy Hylton's rlimit interface
227 # Multimedia modules -- off by default.
228 # These don't work for 64-bit platforms!!!
229 # #993173 says audioop works on 64-bit platforms, though.
230 # These represent audio samples or images as strings:
232 #audioop audioop.c      # Operations on audio samples
233 #imageop imageop.c      # Operations on images
234 #rgbimg rgbimgmodule.c  # Read SGI RGB image files (but coded portably)
237 # Note that the _md5 and _sha modules are normally only built if the
238 # system does not have the OpenSSL libs containing an optimized version.
240 # The _md5 module implements the RSA Data Security, Inc. MD5
241 # Message-Digest Algorithm, described in RFC 1321.  The necessary files
242 # md5.c and md5.h are included here.
244 #_md5 md5module.c md5.c
247 # The _sha module implements the SHA checksum algorithm.
248 # (NIST's Secure Hash Algorithm.)
249 #_sha shamodule.c
252 # SGI IRIX specific modules -- off by default.
254 # These module work on any SGI machine:
256 # *** gl must be enabled higher up in this file ***
257 #fm fmmodule.c $(GLHACK) -lfm -lgl              # Font Manager
258 #sgi sgimodule.c                        # sgi.nap() and a few more
260 # This module requires the header file
261 # /usr/people/4Dgifts/iristools/include/izoom.h:
262 #imgfile imgfile.c -limage -lgutil -lgl -lm     # Image Processing Utilities
265 # These modules require the Multimedia Development Option (I think):
267 #al almodule.c -laudio                  # Audio Library
268 #cd cdmodule.c -lcdaudio -lds -lmediad  # CD Audio Library
269 #cl clmodule.c -lcl -lawareaudio        # Compression Library
270 #sv svmodule.c yuvconvert.c -lsvideo -lXext -lX11       # Starter Video
273 # The FORMS library, by Mark Overmars, implements user interface
274 # components such as dialogs and buttons using SGI's GL and FM
275 # libraries.  You must ftp the FORMS library separately from
276 # ftp://ftp.cs.ruu.nl/pub/SGI/FORMS.  It was tested with FORMS 2.2a.
277 # NOTE: if you want to be able to use FORMS and curses simultaneously
278 # (or both link them statically into the same binary), you must
279 # compile all of FORMS with the cc option "-Dclear=__GLclear".
281 # The FORMS variable must point to the FORMS subdirectory of the forms
282 # toplevel directory:
284 #FORMS=/ufs/guido/src/forms/FORMS
285 #fl flmodule.c -I$(FORMS) $(GLHACK) $(FORMS)/libforms.a -lfm -lgl
288 # SunOS specific modules -- off by default:
290 #sunaudiodev sunaudiodev.c
293 # A Linux specific module -- off by default; this may also work on 
294 # some *BSDs.
296 #linuxaudiodev linuxaudiodev.c
299 # George Neville-Neil's timing module:
301 #timing timingmodule.c
304 # The _tkinter module.
306 # The command for _tkinter is long and site specific.  Please
307 # uncomment and/or edit those parts as indicated.  If you don't have a
308 # specific extension (e.g. Tix or BLT), leave the corresponding line
309 # commented out.  (Leave the trailing backslashes in!  If you
310 # experience strange errors, you may want to join all uncommented
311 # lines and remove the backslashes -- the backslash interpretation is
312 # done by the shell's "read" command and it may not be implemented on
313 # every system.
315 # *** Always uncomment this (leave the leading underscore in!):
316 # _tkinter _tkinter.c tkappinit.c -DWITH_APPINIT \
317 # *** Uncomment and edit to reflect where your Tcl/Tk libraries are:
318 #       -L/usr/local/lib \
319 # *** Uncomment and edit to reflect where your Tcl/Tk headers are:
320 #       -I/usr/local/include \
321 # *** Uncomment and edit to reflect where your X11 header files are:
322 #       -I/usr/X11R6/include \
323 # *** Or uncomment this for Solaris:
324 #       -I/usr/openwin/include \
325 # *** Uncomment and edit for Tix extension only:
326 #       -DWITH_TIX -ltix8.1.8.2 \
327 # *** Uncomment and edit for BLT extension only:
328 #       -DWITH_BLT -I/usr/local/blt/blt8.0-unoff/include -lBLT8.0 \
329 # *** Uncomment and edit for PIL (TkImaging) extension only:
330 #     (See http://www.pythonware.com/products/pil/ for more info)
331 #       -DWITH_PIL -I../Extensions/Imaging/libImaging  tkImaging.c \
332 # *** Uncomment and edit for TOGL extension only:
333 #       -DWITH_TOGL togl.c \
334 # *** Uncomment and edit to reflect your Tcl/Tk versions:
335 #       -ltk8.2 -ltcl8.2 \
336 # *** Uncomment and edit to reflect where your X11 libraries are:
337 #       -L/usr/X11R6/lib \
338 # *** Or uncomment this for Solaris:
339 #       -L/usr/openwin/lib \
340 # *** Uncomment these for TOGL extension only:
341 #       -lGL -lGLU -lXext -lXmu \
342 # *** Uncomment for AIX:
343 #       -lld \
344 # *** Always uncomment this; X11 libraries to link with:
345 #       -lX11
347 # Lance Ellinghaus's syslog module
348 #syslog syslogmodule.c          # syslog daemon interface
351 # Curses support, requring the System V version of curses, often
352 # provided by the ncurses library.  e.g. on Linux, link with -lncurses
353 # instead of -lcurses).
355 # First, look at Setup.config; configure may have set this for you.
357 #_curses _cursesmodule.c -lcurses -ltermcap
358 # Wrapper for the panel library that's part of ncurses and SYSV curses.
359 #_curses_panel _curses_panel.c -lpanel -lncurses 
362 # Generic (SunOS / SVR4) dynamic loading module.
363 # This is not needed for dynamic loading of Python modules --
364 # it is a highly experimental and dangerous device for calling
365 # *arbitrary* C functions in *arbitrary* shared libraries:
367 #dl dlmodule.c
370 # Modules that provide persistent dictionary-like semantics.  You will
371 # probably want to arrange for at least one of them to be available on
372 # your machine, though none are defined by default because of library
373 # dependencies.  The Python module anydbm.py provides an
374 # implementation independent wrapper for these; dumbdbm.py provides
375 # similar functionality (but slower of course) implemented in Python.
377 # The standard Unix dbm module has been moved to Setup.config so that
378 # it will be compiled as a shared library by default.  Compiling it as
379 # a built-in module causes conflicts with the pybsddb3 module since it
380 # creates a static dependency on an out-of-date version of db.so.
382 # First, look at Setup.config; configure may have set this for you.
384 #dbm dbmmodule.c        # dbm(3) may require -lndbm or similar
386 # Anthony Baxter's gdbm module.  GNU dbm(3) will require -lgdbm:
388 # First, look at Setup.config; configure may have set this for you.
390 #gdbm gdbmmodule.c -I/usr/local/include -L/usr/local/lib -lgdbm
393 # Sleepycat Berkeley DB interface.
395 # This requires the Sleepycat DB code, see http://www.sleepycat.com/
396 # The earliest supported version of that library is 3.0, the latest
397 # supported version is 4.0 (4.1 is specifically not supported, as that
398 # changes the semantics of transactional databases). A list of available
399 # releases can be found at
401 # http://www.sleepycat.com/update/index.html
403 # Edit the variables DB and DBLIBVERto point to the db top directory
404 # and the subdirectory of PORT where you built it.
405 #DB=/usr/local/BerkeleyDB.4.0
406 #DBLIBVER=4.0
407 #DBINC=$(DB)/include
408 #DBLIB=$(DB)/lib
409 #_bsddb _bsddb.c -I$(DBINC) -L$(DBLIB) -ldb-$(DBLIBVER)
411 # Historical Berkeley DB 1.85
413 # This module is deprecated; the 1.85 version of the Berkeley DB library has
414 # bugs that can cause data corruption. If you can, use later versions of the
415 # library instead, available from <http://www.sleepycat.com/>.
417 #DB=/depot/sundry/src/berkeley-db/db.1.85
418 #DBPORT=$(DB)/PORT/irix.5.3
419 #bsddb185 bsddbmodule.c -I$(DBPORT)/include -I$(DBPORT) $(DBPORT)/libdb.a
423 # Helper module for various ascii-encoders
424 #binascii binascii.c
426 # Fred Drake's interface to the Python parser
427 #parser parsermodule.c
429 # cStringIO and cPickle
430 #cStringIO cStringIO.c
431 #cPickle cPickle.c
434 # Lee Busby's SIGFPE modules.
435 # The library to link fpectl with is platform specific.
436 # Choose *one* of the options below for fpectl:
438 # For SGI IRIX (tested on 5.3):
439 #fpectl fpectlmodule.c -lfpe
441 # For Solaris with SunPro compiler (tested on Solaris 2.5 with SunPro C 4.2):
442 # (Without the compiler you don't have -lsunmath.)
443 #fpectl fpectlmodule.c -R/opt/SUNWspro/lib -lsunmath -lm
445 # For other systems: see instructions in fpectlmodule.c.
446 #fpectl fpectlmodule.c ...
448 # Test module for fpectl.  No extra libraries needed.
449 #fpetest fpetestmodule.c
451 # Andrew Kuchling's zlib module.
452 # This require zlib 1.1.3 (or later).
453 # See http://www.gzip.org/zlib/
454 #zlib zlibmodule.c -I$(prefix)/include -L$(exec_prefix)/lib -lz
456 # Interface to the Expat XML parser
458 # Expat was written by James Clark and is now maintained by a group of
459 # developers on SourceForge; see www.libexpat.org for more
460 # information.  The pyexpat module was written by Paul Prescod after a
461 # prototype by Jack Jansen.  Source of Expat 1.95.2 is included in
462 # Modules/expat/.  Usage of a system shared libexpat.so/expat.dll is
463 # not advised.
465 # More information on Expat can be found at www.libexpat.org.
467 #EXPAT_DIR=/usr/local/src/expat-1.95.2
468 #pyexpat pyexpat.c -DHAVE_EXPAT_H -I$(EXPAT_DIR)/lib -L$(EXPAT_DIR) -lexpat
471 # Hye-Shik Chang's CJKCodecs
473 # multibytecodec is required for all the other CJK codec modules
474 #_multibytecodec cjkcodecs/multibytecodec.c
476 #_codecs_cn cjkcodecs/_codecs_cn.c
477 #_codecs_hk cjkcodecs/_codecs_hk.c
478 #_codecs_iso2022 cjkcodecs/_codecs_iso2022.c
479 #_codecs_jp cjkcodecs/_codecs_jp.c
480 #_codecs_kr cjkcodecs/_codecs_kr.c
481 #_codecs_tw cjkcodecs/_codecs_tw.c
483 # Example -- included for reference only:
484 # xx xxmodule.c
486 # Another example -- the 'xxsubtype' module shows C-level subtyping in action
487 xxsubtype xxsubtype.c