Merged revisions 82952,82954 via svnmerge from
[python/dscho.git] / Modules / Setup.dist
blob9f189deb4c077520f395f428d72ed49513e5e031
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 COREPYTHONPATH=$(DESTPATH)$(SITEPATH)$(TESTPATH)$(MACHDEPPATH)$(EXTRAMACHDEPPATH)
98 PYTHONPATH=$(COREPYTHONPATH)
101 # The modules listed here can't be built as shared libraries for
102 # various reasons; therefore they are listed here instead of in the
103 # normal order.
105 # This only contains the minimal set of modules required to run the 
106 # setup.py script in the root of the Python source tree.
108 posix posixmodule.c             # posix (UNIX) system calls
109 errno errnomodule.c             # posix (UNIX) errno values
110 pwd pwdmodule.c                 # this is needed to find out the user's home dir
111                                 # if $HOME is not set
112 _sre _sre.c                     # Fredrik Lundh's new regular expressions
113 _codecs _codecsmodule.c         # access to the builtin codecs and codec registry
114 _weakref _weakref.c             # weak references
115 _functools _functoolsmodule.c   # Tools for working with functions and callable objects
117 # access to ISO C locale support
118 _locale _localemodule.c  # -lintl
120 # Standard I/O baseline
121 _io -I$(srcdir)/Modules/_io _io/_iomodule.c _io/iobase.c _io/fileio.c _io/bytesio.c _io/bufferedio.c _io/textio.c _io/stringio.c
123 # The zipimport module is always imported at startup. Having it as a
124 # builtin module avoids some bootstrapping problems and reduces overhead.
125 zipimport zipimport.c
127 # The rest of the modules listed in this file are all commented out by
128 # default.  Usually they can be detected and built as dynamically
129 # loaded modules by the new setup.py script added in Python 2.1.  If
130 # you're on a platform that doesn't support dynamic loading, want to 
131 # compile modules statically into the Python binary, or need to 
132 # specify some odd set of compiler switches, you can uncomment the 
133 # appropriate lines below.
135 # ======================================================================
137 # The Python symtable module depends on .h files that setup.py doesn't track
138 _symtable symtablemodule.c
140 # Uncommenting the following line tells makesetup that all following
141 # modules are to be built as shared libraries (see above for more
142 # detail; also note that *static* reverses this effect):
144 #*shared*
146 # GNU readline.  Unlike previous Python incarnations, GNU readline is
147 # now incorporated in an optional module, configured in the Setup file
148 # instead of by a configure script switch.  You may have to insert a
149 # -L option pointing to the directory where libreadline.* lives,
150 # and you may have to change -ltermcap to -ltermlib or perhaps remove
151 # it, depending on your system -- see the GNU readline instructions.
152 # It's okay for this to be a shared library, too.
154 #readline readline.c -lreadline -ltermcap
157 # Modules that should always be present (non UNIX dependent):
159 #array arraymodule.c    # array objects
160 #cmath cmathmodule.c # -lm # complex math library functions
161 #math mathmodule.c # -lm # math library functions, e.g. sin()
162 #_struct _struct.c      # binary structure packing/unpacking
163 #time timemodule.c # -lm # time operations and variables
164 #operator operator.c    # operator.add() and similar goodies
165 #_weakref _weakref.c    # basic weak reference support
166 #_testcapi _testcapimodule.c    # Python C API test module
167 #_random _randommodule.c        # Random number generator
168 #_collections _collectionsmodule.c # Container types
169 #itertools itertoolsmodule.c    # Functions creating iterators for efficient looping 
170 #atexit atexitmodule.c      # Register functions to be run at interpreter-shutdown
171 #_elementtree -I$(srcdir)/Modules/expat -DHAVE_EXPAT_CONFIG_H -DUSE_PYEXPAT_CAPI _elementtree.c # elementtree accelerator
172 #_pickle _pickle.c      # pickle accelerator
173 #datetime datetimemodule.c      # date/time type
174 #_bisect _bisectmodule.c        # Bisection algorithms
175 #_heapq _heapqmodule.c  # Heap queue algorithm
177 #unicodedata unicodedata.c    # static Unicode character database
180 # Modules with some UNIX dependencies -- on by default:
181 # (If you have a really backward UNIX, select and socket may not be
182 # supported...)
184 #fcntl fcntlmodule.c    # fcntl(2) and ioctl(2)
185 #spwd spwdmodule.c              # spwd(3) 
186 #grp grpmodule.c                # grp(3)
187 #select selectmodule.c  # select(2); not on ancient System V
189 # Memory-mapped files (also works on Win32).
190 #mmap mmapmodule.c
192 # CSV file helper
193 #_csv _csv.c
195 # Socket module helper for socket(2)
196 #_socket socketmodule.c
198 # Socket module helper for SSL support; you must comment out the other
199 # socket line above, and possibly edit the SSL variable:
200 #SSL=/usr/local/ssl
201 #_ssl _ssl.c \
202 #       -DUSE_SSL -I$(SSL)/include -I$(SSL)/include/openssl \
203 #       -L$(SSL)/lib -lssl -lcrypto
205 # The crypt module is now disabled by default because it breaks builds
206 # on many systems (where -lcrypt is needed), e.g. Linux (I believe).
208 # First, look at Setup.config; configure may have set this for you.
210 #crypt cryptmodule.c # -lcrypt  # crypt(3); needs -lcrypt on some systems
213 # Some more UNIX dependent modules -- off by default, since these
214 # are not supported by all UNIX systems:
216 #nis nismodule.c -lnsl  # Sun yellow pages -- not everywhere
217 #termios termios.c      # Steen Lumholt's termios module
218 #resource resource.c    # Jeremy Hylton's rlimit interface
221 # Multimedia modules -- off by default.
222 # These don't work for 64-bit platforms!!!
223 # #993173 says audioop works on 64-bit platforms, though.
224 # These represent audio samples or images as strings:
226 #audioop audioop.c      # Operations on audio samples
229 # Note that the _md5 and _sha modules are normally only built if the
230 # system does not have the OpenSSL libs containing an optimized version.
232 # The _md5 module implements the RSA Data Security, Inc. MD5
233 # Message-Digest Algorithm, described in RFC 1321.  The necessary files
234 # md5.c and md5.h are included here.
236 #_md5 md5module.c md5.c
239 # The _sha module implements the SHA checksum algorithms.
240 # (NIST's Secure Hash Algorithms.)
241 #_sha shamodule.c
242 #_sha256 sha256module.c
243 #_sha512 sha512module.c
246 # The _tkinter module.
248 # The command for _tkinter is long and site specific.  Please
249 # uncomment and/or edit those parts as indicated.  If you don't have a
250 # specific extension (e.g. Tix or BLT), leave the corresponding line
251 # commented out.  (Leave the trailing backslashes in!  If you
252 # experience strange errors, you may want to join all uncommented
253 # lines and remove the backslashes -- the backslash interpretation is
254 # done by the shell's "read" command and it may not be implemented on
255 # every system.
257 # *** Always uncomment this (leave the leading underscore in!):
258 # _tkinter _tkinter.c tkappinit.c -DWITH_APPINIT \
259 # *** Uncomment and edit to reflect where your Tcl/Tk libraries are:
260 #       -L/usr/local/lib \
261 # *** Uncomment and edit to reflect where your Tcl/Tk headers are:
262 #       -I/usr/local/include \
263 # *** Uncomment and edit to reflect where your X11 header files are:
264 #       -I/usr/X11R6/include \
265 # *** Or uncomment this for Solaris:
266 #       -I/usr/openwin/include \
267 # *** Uncomment and edit for Tix extension only:
268 #       -DWITH_TIX -ltix8.1.8.2 \
269 # *** Uncomment and edit for BLT extension only:
270 #       -DWITH_BLT -I/usr/local/blt/blt8.0-unoff/include -lBLT8.0 \
271 # *** Uncomment and edit for PIL (TkImaging) extension only:
272 #     (See http://www.pythonware.com/products/pil/ for more info)
273 #       -DWITH_PIL -I../Extensions/Imaging/libImaging  tkImaging.c \
274 # *** Uncomment and edit for TOGL extension only:
275 #       -DWITH_TOGL togl.c \
276 # *** Uncomment and edit to reflect your Tcl/Tk versions:
277 #       -ltk8.2 -ltcl8.2 \
278 # *** Uncomment and edit to reflect where your X11 libraries are:
279 #       -L/usr/X11R6/lib \
280 # *** Or uncomment this for Solaris:
281 #       -L/usr/openwin/lib \
282 # *** Uncomment these for TOGL extension only:
283 #       -lGL -lGLU -lXext -lXmu \
284 # *** Uncomment for AIX:
285 #       -lld \
286 # *** Always uncomment this; X11 libraries to link with:
287 #       -lX11
289 # Lance Ellinghaus's syslog module
290 #syslog syslogmodule.c          # syslog daemon interface
293 # Curses support, requring the System V version of curses, often
294 # provided by the ncurses library.  e.g. on Linux, link with -lncurses
295 # instead of -lcurses).
297 # First, look at Setup.config; configure may have set this for you.
299 #_curses _cursesmodule.c -lcurses -ltermcap
300 # Wrapper for the panel library that's part of ncurses and SYSV curses.
301 #_curses_panel _curses_panel.c -lpanel -lncurses 
304 # Modules that provide persistent dictionary-like semantics.  You will
305 # probably want to arrange for at least one of them to be available on
306 # your machine, though none are defined by default because of library
307 # dependencies.  The Python module dbm/__init__.py provides an
308 # implementation independent wrapper for these; dbm/dumb.py provides
309 # similar functionality (but slower of course) implemented in Python.
311 # The standard Unix dbm module has been moved to Setup.config so that
312 # it will be compiled as a shared library by default.  Compiling it as
313 # a built-in module causes conflicts with the pybsddb3 module since it
314 # creates a static dependency on an out-of-date version of db.so.
316 # First, look at Setup.config; configure may have set this for you.
318 #_dbm _dbmmodule.c      # dbm(3) may require -lndbm or similar
320 # Anthony Baxter's gdbm module.  GNU dbm(3) will require -lgdbm:
322 # First, look at Setup.config; configure may have set this for you.
324 #_gdbm _gdbmmodule.c -I/usr/local/include -L/usr/local/lib -lgdbm
327 # Helper module for various ascii-encoders
328 #binascii binascii.c
330 # Fred Drake's interface to the Python parser
331 #parser parsermodule.c
334 # Lee Busby's SIGFPE modules.
335 # The library to link fpectl with is platform specific.
336 # Choose *one* of the options below for fpectl:
338 # For SGI IRIX (tested on 5.3):
339 #fpectl fpectlmodule.c -lfpe
341 # For Solaris with SunPro compiler (tested on Solaris 2.5 with SunPro C 4.2):
342 # (Without the compiler you don't have -lsunmath.)
343 #fpectl fpectlmodule.c -R/opt/SUNWspro/lib -lsunmath -lm
345 # For other systems: see instructions in fpectlmodule.c.
346 #fpectl fpectlmodule.c ...
348 # Test module for fpectl.  No extra libraries needed.
349 #fpetest fpetestmodule.c
351 # Andrew Kuchling's zlib module.
352 # This require zlib 1.1.3 (or later).
353 # See http://www.gzip.org/zlib/
354 #zlib zlibmodule.c -I$(prefix)/include -L$(exec_prefix)/lib -lz
356 # Interface to the Expat XML parser
358 # Expat was written by James Clark and is now maintained by a group of
359 # developers on SourceForge; see www.libexpat.org for more
360 # information.  The pyexpat module was written by Paul Prescod after a
361 # prototype by Jack Jansen.  Source of Expat 1.95.2 is included in
362 # Modules/expat/.  Usage of a system shared libexpat.so/expat.dll is
363 # not advised.
365 # More information on Expat can be found at www.libexpat.org.
367 #pyexpat expat/xmlparse.c expat/xmlrole.c expat/xmltok.c pyexpat.c -I$(srcdir)/Modules/expat -DHAVE_EXPAT_CONFIG_H -DUSE_PYEXPAT_CAPI
369 # Hye-Shik Chang's CJKCodecs
371 # multibytecodec is required for all the other CJK codec modules
372 #_multibytecodec cjkcodecs/multibytecodec.c
374 #_codecs_cn cjkcodecs/_codecs_cn.c
375 #_codecs_hk cjkcodecs/_codecs_hk.c
376 #_codecs_iso2022 cjkcodecs/_codecs_iso2022.c
377 #_codecs_jp cjkcodecs/_codecs_jp.c
378 #_codecs_kr cjkcodecs/_codecs_kr.c
379 #_codecs_tw cjkcodecs/_codecs_tw.c
381 # Example -- included for reference only:
382 # xx xxmodule.c
384 # Another example -- the 'xxsubtype' module shows C-level subtyping in action
385 xxsubtype xxsubtype.c