Updated for 2.1a3
[python/dscho.git] / Modules / Setup.dist
blob192704831b3e1cf4cd6353b00c352ce3ac297b4a
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 # 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
44 # 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,
47 # *noconfig* has the same effect as *shared*.)
49 # In addition, *static* reverses this effect (negating a previous
50 # *shared* line).
52 # 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
55 # to ftp sources from elsewhere.
58 # 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!
62 # Directories where library files get installed.
63 # DESTLIB is for Python modules; MACHDESTLIB for shared libraries.
64 DESTLIB=$(LIBDEST)
65 MACHDESTLIB=$(BINLIBDEST)
67 # NOTE: all the paths are now relative to the prefix that is computed
68 # at run time!
70 # Standard path -- don't edit.
71 # No leading colon since this is the first entry.
72 # Empty since this is now just the runtime prefix.
73 DESTPATH=
75 # Site specific path components -- should begin with : if non-empty
76 SITEPATH=
78 # Standard path components for test modules
79 TESTPATH=
81 # Path components for machine- or system-dependent modules and shared libraries
82 MACHDEPPATH=:plat-$(MACHDEP)
84 # Path component for the Tkinter-related modules
85 # The TKPATH variable is always enabled, to save you the effort.
86 TKPATH=:lib-tk
88 COREPYTHONPATH=$(DESTPATH)$(SITEPATH)$(TESTPATH)$(MACHDEPPATH)$(TKPATH)
89 PYTHONPATH=$(COREPYTHONPATH)
92 # 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.
96 # This only contains the minimal set of modules required to run the 
97 # setup.py script in the root of the Python source tree.
99 posix posixmodule.c             # posix (UNIX) system calls
100 _sre _sre.c                     # Fredrik Lundh's new regular expressions
102 # The rest of the modules listed in this file are all commented out by
103 # default.  Usually they can be detected and built as dynamically
104 # loaded modules by the new setup.py script added in Python 2.1.  If
105 # you're on a platform that doesn't support dynamic loading, want to 
106 # compile modules statically into the Python binary, or need to 
107 # specify some odd set of compiler switches, you can uncomment the 
108 # appropriate lines below.
110 # ======================================================================
112 # The SGI specific GL module:
114 GLHACK=-Dclear=__GLclear
115 #gl glmodule.c cgensupport.c -I$(srcdir) $(GLHACK) -lgl -lX11
117 # Pure module.  Cannot be linked dynamically.
118 # -DWITH_QUANTIFY, -DWITH_PURIFY, or -DWITH_ALL_PURE
119 #WHICH_PURE_PRODUCTS=-DWITH_ALL_PURE
120 #PURE_INCLS=-I/usr/local/include
121 #PURE_STUBLIBS=-L/usr/local/lib -lpurify_stubs -lquantify_stubs
122 #pure puremodule.c $(WHICH_PURE_PRODUCTS) $(PURE_INCLS) $(PURE_STUBLIBS)
124 # Uncommenting the following line tells makesetup that all following
125 # modules are to be built as shared libraries (see above for more
126 # detail; also note that *static* reverses this effect):
128 #*shared*
130 # GNU readline.  Unlike previous Python incarnations, GNU readline is
131 # now incorporated in an optional module, configured in the Setup file
132 # instead of by a configure script switch.  You may have to insert a
133 # -L option pointing to the directory where libreadline.* lives,
134 # and you may have to change -ltermcap to -ltermlib or perhaps remove
135 # it, depending on your system -- see the GNU readline instructions.
136 # It's okay for this to be a shared library, too.
138 #readline readline.c -lreadline -ltermcap
141 # Modules that should always be present (non UNIX dependent):
143 #array arraymodule.c    # array objects
144 #cmath cmathmodule.c # -lm # complex math library functions
145 #math mathmodule.c # -lm # math library functions, e.g. sin()
146 #struct structmodule.c  # binary structure packing/unpacking
147 #time timemodule.c # -lm # time operations and variables
148 #operator operator.c    # operator.add() and similar goodies
149 #_weakref _weakref.c    # basic weak reference support
150 #_codecs _codecsmodule.c        # access to the builtin codecs and codec registry
151 #_testcapi _testcapimodule.c    # Python C API test module
153 #unicodedata unicodedata.c    # static Unicode character database
155 #_locale _localemodule.c  # access to ISO C locale support
158 # Modules with some UNIX dependencies -- on by default:
159 # (If you have a really backward UNIX, select and socket may not be
160 # supported...)
162 #fcntl fcntlmodule.c    # fcntl(2) and ioctl(2)
163 #pwd pwdmodule.c                # pwd(3) 
164 #grp grpmodule.c                # grp(3)
165 #errno errnomodule.c    # posix (UNIX) errno values
166 #select selectmodule.c  # select(2); not on ancient System V
168 # Memory-mapped files (also works on Win32).
169 #mmap mmapmodule.c
171 # Dynamic readlines
172 #xreadlines xreadlinesmodule.c
174 # for socket(2), without SSL support.
175 #_socket socketmodule.c
177 # Socket module compiled with SSL support; you must comment out the other
178 # socket line above, and possibly edit the SSL variable:
179 #SSL=/usr/local/ssl
180 #_socket socketmodule.c \
181 #       -DUSE_SSL -I$(SSL)/include -I$(SSL)/include/openssl \
182 #       -L$(SSL)/lib -lssl -lcrypto
184 # The crypt module is now disabled by default because it breaks builds
185 # on many systems (where -lcrypt is needed), e.g. Linux (I believe).
187 # First, look at Setup.config; configure may have set this for you.
189 #crypt cryptmodule.c # -lcrypt  # crypt(3); needs -lcrypt on some systems
192 # Some more UNIX dependent modules -- off by default, since these
193 # are not supported by all UNIX systems:
195 #nis nismodule.c -lnsl  # Sun yellow pages -- not everywhere
196 #termios termios.c      # Steen Lumholt's termios module
197 #resource resource.c    # Jeremy Hylton's rlimit interface
200 # Multimedia modules -- off by default.
201 # These don't work for 64-bit platforms!!!
202 # These represent audio samples or images as strings:
204 #audioop audioop.c      # Operations on audio samples
205 #imageop imageop.c      # Operations on images
206 #rgbimg rgbimgmodule.c  # Read SGI RGB image files (but coded portably)
209 # The md5 module implements the RSA Data Security, Inc. MD5
210 # Message-Digest Algorithm, described in RFC 1321.  The necessary files
211 # md5c.c and md5.h are included here.
213 #md5 md5module.c md5c.c
216 # The sha module implements the SHA checksum algorithm.
217 # (NIST's Secure Hash Algorithm.)
218 #sha shamodule.c
221 # The mpz module interfaces to the GNU Multiple Precision library.
222 # You need to ftp the GNU MP library.  
223 # The GMP variable must point to the GMP source directory.
224 # This was originally written and tested against GMP 1.2 and 1.3.2.
225 # It has been modified by Rob Hooft to work with 2.0.2 as well, but I
226 # haven't tested it recently.
228 # A compatible MP library unencombered by the GPL also exists.  It was
229 # posted to comp.sources.misc in volume 40 and is widely available from
230 # FTP archive sites. One URL for it is:
231 # ftp://gatekeeper.dec.com/.b/usenet/comp.sources.misc/volume40/fgmp/part01.Z
233 #GMP=/ufs/guido/src/gmp
234 #mpz mpzmodule.c -I$(GMP) $(GMP)/libgmp.a
237 # SGI IRIX specific modules -- off by default.
239 # These module work on any SGI machine:
241 # *** gl must be enabled higher up in this file ***
242 #fm fmmodule.c $(GLHACK) -lfm -lgl              # Font Manager
243 #sgi sgimodule.c                        # sgi.nap() and a few more
245 # This module requires the header file
246 # /usr/people/4Dgifts/iristools/include/izoom.h:
247 #imgfile imgfile.c -limage -lgutil -lgl -lm     # Image Processing Utilities
250 # These modules require the Multimedia Development Option (I think):
252 #al almodule.c -laudio                  # Audio Library
253 #cd cdmodule.c -lcdaudio -lds -lmediad  # CD Audio Library
254 #cl clmodule.c -lcl -lawareaudio        # Compression Library
255 #sv svmodule.c yuvconvert.c -lsvideo -lXext -lX11       # Starter Video
258 # The FORMS library, by Mark Overmars, implements user interface
259 # components such as dialogs and buttons using SGI's GL and FM
260 # libraries.  You must ftp the FORMS library separately from
261 # ftp://ftp.cs.ruu.nl/pub/SGI/FORMS.  It was tested with FORMS 2.2a.
262 # NOTE: if you want to be able to use FORMS and curses simultaneously
263 # (or both link them statically into the same binary), you must
264 # compile all of FORMS with the cc option "-Dclear=__GLclear".
266 # The FORMS variable must point to the FORMS subdirectory of the forms
267 # toplevel directory:
269 #FORMS=/ufs/guido/src/forms/FORMS
270 #fl flmodule.c -I$(FORMS) $(GLHACK) $(FORMS)/libforms.a -lfm -lgl
273 # SunOS specific modules -- off by default:
275 #sunaudiodev sunaudiodev.c
278 # A Linux specific module -- off by default; this may also work on 
279 # some *BSDs.
281 #linuxaudiodev linuxaudiodev.c
284 # George Neville-Neil's timing module:
286 #timing timingmodule.c
289 # The _tkinter module.
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.
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
332 # Lance Ellinghaus's modules:
334 #rotor rotormodule.c            # enigma-inspired encryption
335 #syslog syslogmodule.c          # syslog daemon interface
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).
343 # First, look at Setup.config; configure may have set this for you.
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 
350 # Tommy Burnette's 'new' module (creates new empty objects of certain kinds):
352 #new newmodule.c
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:
360 #dl dlmodule.c
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.
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.
375 # First, look at Setup.config; configure may have set this for you.
377 #dbm dbmmodule.c        # dbm(3) may require -lndbm or similar
379 # Anthony Baxter's gdbm module.  GNU dbm(3) will require -lgdbm:
381 # First, look at Setup.config; configure may have set this for you.
383 #gdbm gdbmmodule.c -I/usr/local/include -L/usr/local/lib -lgdbm
386 # Berkeley DB interface.
388 # This requires the Berkeley DB code, see
389 # ftp://ftp.cs.berkeley.edu/pub/4bsd/db.1.85.tar.gz
391 # Edit the variables DB and DBPORT to point to the db top directory
392 # and the subdirectory of PORT where you built it.
394 # (See http://electricrain.com/greg/python/bsddb3/ for an interface to
395 # BSD DB 3.x.)
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.
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
408 # Helper module for various ascii-encoders
409 #binascii binascii.c
411 # Fred Drake's interface to the Python parser
412 #parser parsermodule.c
414 # Digital Creations' cStringIO and cPickle
415 #cStringIO cStringIO.c
416 #cPickle cPickle.c
419 # Lee Busby's SIGFPE modules.
420 # The library to link fpectl with is platform specific.
421 # Choose *one* of the options below for fpectl:
423 # For SGI IRIX (tested on 5.3):
424 #fpectl fpectlmodule.c -lfpe
426 # For Solaris with SunPro compiler (tested on Solaris 2.5 with SunPro C 4.2):
427 # (Without the compiler you don't have -lsunmath.)
428 #fpectl fpectlmodule.c -R/opt/SUNWspro/lib -lsunmath -lm
430 # For other systems: see instructions in fpectlmodule.c.
431 #fpectl fpectlmodule.c ...
433 # Test module for fpectl.  No extra libraries needed.
434 #fpetest fpetestmodule.c
436 # Andrew Kuchling's zlib module.
437 # This require zlib 1.1.3 (or later).
438 # See http://www.cdrom.com/pub/infozip/zlib/
439 #zlib zlibmodule.c -I$(prefix)/include -L$(exec_prefix)/lib -lz
441 # Interface to the Expat XML parser
443 # Expat is written by James Clark and must be downloaded separately
444 # (see below).  The pyexpat module was written by Paul Prescod after a
445 # prototype by Jack Jansen.
447 # The Expat dist includes Windows .lib and .dll files.  Home page is at
448 # http://www.jclark.com/xml/expat.html, the current production release is
449 # always ftp://ftp.jclark.com/pub/xml/expat.zip.
451 # EXPAT_DIR, below, should point to the expat/ directory created by
452 # unpacking the Expat source distribution.
454 # Note: the expat build process doesn't yet build a libexpat.a; you can
455 # do this manually while we try convince the author to add it.  To do so,
456 # cd to EXPAT_DIR, run "make" if you have not done so, then run:
458 #    ar cr libexpat.a xmltok/*.o xmlparse/*.o
460 #EXPAT_DIR=/usr/local/src/expat
461 #pyexpat pyexpat.c -I$(EXPAT_DIR)/xmlparse -L$(EXPAT_DIR) -lexpat
464 # Example -- included for reference only:
465 # xx xxmodule.c