XEmacs 21.2-b4
[chise/xemacs-chise.git.1] / configure.usage
1 Usage: configure [--OPTION[=VALUE] ...] [CONFIGURATION]
2
3 Set compilation and installation parameters for XEmacs, and report.
4
5 Note that for most of the following options, you can explicitly enable
6 them using `--OPTION=yes' and explicitly disable them using `--OPTION=no'.  
7 This is especially useful for auto-detected options.
8 The option `--without-FEATURE' is a synonym for `--with-FEATURE=no'.
9
10 Options marked with a (*) are auto-detected.
11
12 Use colons (or quoted spaces) to separate directory names in option
13 values which are PATHs (i.e. lists of directories).
14
15 General options:
16
17 --help                  Issue this usage message.
18 --verbose               Display the results of configure tests.
19 --extra-verbose         Display even more information, useful for debugging.
20
21
22 Compilation options:
23
24 --compiler=prog         C compiler to use.
25 --with-gcc (*)          Use GCC to compile XEmacs.
26 --without-gcc           Don't use GCC to compile XEmacs.
27 --with-gnu-make         Write the Makefiles to take advantage of
28                         special features of GNU Make. (GNU Make
29                         works fine on the Makefiles even without this
30                         option.  This just allows for simultaneous
31                         in-place and --srcdir building.)
32 --cflags=FLAGS          Compiler flags (such as -O)
33 --cpp=prog              C preprocessor to use (e.g. /usr/ccs/lib/cpp or cc -E)
34 --cppflags=FLAGS        C preprocessor flags (e.g. -I/foo or -Dfoo=bar)
35 --libs=LIBS             Additional libraries (e.g. -lfoo)
36 --ldflags=FLAGS         Additional linker flags (e.g. -L/foo)
37 --site-includes=PATH    List of directories to search first for header files.
38 --site-libraries=PATH   List of directories to search first for libraries.
39 --site-prefixes=PATH    List of directories to search for include/ and lib/
40                         subdirectories, just after 'site-includes' and
41                         'site-libraries'.
42 --site-runtime-libraries=PATH
43                         List of ALL directories to search for dynamically
44                         linked libraries at run time.
45 --dynamic=yes           Link dynamically if supported by system.
46 --dynamic=no            Force static linking on systems where dynamic
47                         linking is the default.
48 --srcdir=DIR            Look for the XEmacs source files in DIR.
49                         See also --with-gnu-make.
50 --use-indexed-lrecord-implementation
51 --use-minimal-tagbits
52 --gung-ho               Build with new-style Lisp_Objects.
53                         Equivalent to both of the 2 previous options combined.
54
55
56 Installation options:
57
58 --prefix=DIR            Install files below DIR.  Defaults to `/usr/local'.
59
60
61 Window-system options:
62
63 --with-x11 (*)          Support the X Window System.
64 --without-x11           Don't support X.
65 --x-includes=DIR        Search for X header files in DIR.
66 --x-libraries=DIR       Search for X libraries in DIR.
67 --without-toolbars      Don't compile with any toolbar support.
68 --without-session       Compile without realized leader window which will
69                         keep the WM_COMMAND property. Required for proper
70                         session-management.
71 --with-menubars=TYPE    Use TYPE menubars (lucid, motif, or no).  The Lucid
72                         widgets emulate Motif (mostly) but are faster.
73                         *WARNING*  The Motif menubar is currently broken.
74 --with-scrollbars=TYPE  Use TYPE scrollbars
75                         (lucid, motif, athena, athena3d, or no).
76 --with-dialogs=TYPE     Use TYPE dialog boxes (motif, athena, athena3d, or no).
77                         Lucid menubars and scrollbars are the default.
78                         Motif dialog boxes will be used if Motif can be found.
79 --with-dragndrop (*)    Compile in the generic drag and drop API. This is
80                         automatically added if one of the drag and drop
81                         protocols is found (currently CDE, OffiX, MSWindows).
82                         *WARNING*  The Drag'n'drop support is under development
83                                    and is considered experimental.
84 --with-cde (*)          Compile in support for CDE drag and drop.
85 --with-offix (*)        Compile in support for OffiX drag and drop.
86                         *WARNING*  If you compile in OffiX, you may not be
87                                    able to use multiple X displays success-
88                                    fully.  If the two servers are from
89                                    different vendors, the results may be
90                                    unpredictable.
91 --without-xmu (*)       For those unfortunates whose vendors don't ship Xmu.
92 --external-widget       Compile with external widget support.
93 --with-xpm (*)          Compile with support for XPM files.
94                         It is highly recommended that you obtain XPM
95                         (version 3.4h or better) if you don't already
96                         have it.  Get it from the XEmacs FTP site.
97 --with-xface (*)        Compile with support for X-Face mail header
98                         conversion.  Requires the compface library.
99                         Get it from the XEmacs FTP site.
100 --without-gif           Compile without the built-in support for GIF image
101                         conversion.
102 --with-jpeg (*)         Compile with support for JPEG image conversion.
103                         Requires libjpeg from the Independent JPEG Group.
104                         Get it from the XEmacs FTP site.
105 --with-png (*)          Compile with support for PNG image conversion.
106                         Requires libpng.  Get it from the XEmacs FTP site.
107 --with-tiff (*)         Compile with support for TIFF image conversion.
108                         Requires Sam Lefflier's libtiff library.
109                         Get if from the XEmacs FTP site.
110
111
112 TTY options:
113
114 --without-tty           Don't support TTY-s.
115 --with-ncurses (*)      Use the ncurses library for tty support.
116 --with-gpm (*)          Compile in support for General Purpose Mouse.
117
118
119 Additional features:
120
121 --with-tooltalk (*)     Support the ToolTalk IPC protocol.
122 --with-workshop         Support the Sun WorkShop (formerly Sparcworks)
123                         development environment.
124 --with-socks            Compile with support for SOCKS (an Internet proxy).
125 --with-database=TYPE (*) Compile with database support.  Valid types are
126                         `no' or a comma-separated list of one or more
127                         of `dbm', `gnudbm', or `berkdb'.
128 --with-sound=native (*) Compile with native sound support.
129 --with-sound=nas        Compile with network sound support.
130 --with-sound=both       Compile with native and network sound support.
131 --native-sound-lib=LIB  Native sound support library.  Needed on Suns
132                         with --with-sound=both because both sound libraries
133                         are called libaudio.
134 --with-pop              support POP for mail retrieval
135 --with-kerberos         support Kerberos-authenticated POP
136 --with-hesiod           support Hesiod to get the POP server host
137 --with-dnet (*)         Compile with support for DECnet.
138 --with-ldap (*)         Compile with support for the LDAP protocol (requires
139                         installed LDAP libraries on the system).
140 --mail-locking=TYPE (*) Specify the locking to be used by movemail to prevent
141                         concurrent updates of mail spool files. Valid types
142                         are `lockf', `flock', and `file'.
143 --with-site-lisp        Allow for a site-lisp directory in the XEmacs hierarchy 
144                         searched before the installation packages.
145 --package-path=PATH     Directories to search for packages to dump with xemacs.
146                         PATH splits into three parts separated
147                         by double colons (::), an early, a late, and a last part,
148                         corresponding to their position in the various
149                         system paths:  The early part is always first, 
150                         the late part somewhere in the middle, and the 
151                         last part at the very back.
152                         Only the late part gets seen at dump time.
153                         If PATH has only one component, that component 
154                         is late.
155                         If PATH has two components, the first is
156                         early, the second is late.
157 --infodir=DIR           Directory to install the XEmacs Info manuals and dir in.
158 --infopath=PATH         Directories to search for Info documents, info dir
159                         and localdir files in case run-time searching
160                         for them fails.
161
162 Internationalization options:
163
164 --with-mule             Compile with Mule (MUlti-Lingual Emacs) support,
165                         needed to support non-Latin-1 (including Asian) languages.
166 --with-xim=xlib         Compile with support for X input methods,
167 --with-xim=motif (*)    Used in conjunction with Mule support.
168                         Use either raw Xlib to provide XIM support, or
169                         the Motif XmIm* routines (when available).
170                         NOTE:  On some systems bugs in X11's XIM support
171                         will cause XEmacs to crash, so by default,
172                         no XIM support is compiled in, unless running
173                         on Solaris and the XmIm* routines are detected.
174 --with-canna (*)        Compile with support for Canna (a Japanese input method
175                         used in conjunction with Mule support).
176 --with-wnn (*)          Compile with support for WNN (a multi-language input method
177                         used in conjunction with Mule support).
178 --with-wnn6 (*)         Compile with support for the comercial package WNN version 6
179 --with-i18n3            Compile with I18N level 3 (support for message
180                         translation).  This doesn't currently work.
181 --with-xfs              Compile with XFontSet support for bilingual menubar.
182                         Can't use this option with --with-xim=motif or xlib.
183                         And should have --with-menubars=lucid.
184
185
186 Debugging options:
187
188 --debug                 Compile with support for debugging XEmacs.
189                         (Causes code-size increase and little loss of speed.)
190 --error-checking=TYPE[,TYPE]...
191                         Compile with internal error-checking added.
192                         Causes noticeable loss of speed.  Valid types
193                         are extents, bufpos, malloc, gc, typecheck.
194 --error-checking=none   Disable all internal error-checking (the default).
195 --error-checking=all    Enable all internal error-checking.
196 --memory-usage-stats    Compile with additional code to allow you to
197                         determine what XEmacs's memory is being used
198                         for.  Causes a small code increase but no loss
199                         of speed.  Normally enabled when --debug is given.
200 --no-doc-file           Don't rebuild the DOC file unless it's explicitly
201                         deleted.  Only use during development. (It speeds
202                         up the compile-run-test cycle.)
203 --use-union-type        Enable or disable use of a union, instead of an
204                         int, for the fundamental Lisp_Object type; this
205                         provides stricter type-checking.  Only works with
206                         some systems and compilers.
207
208
209 Other options:
210
211 --puresize=VALUE        Override default amount of space for pure Lisp code.
212 --rel-alloc             Use the relocating allocator (default for this option
213                         is system-dependent).
214 --with-dlmalloc         Control usage of Doug Lea malloc on systems that have
215                         it in the standard C library (default is to use it if
216                         it is available).
217 --with-clash-detection  Use lock files to detect multiple edits of the same file.
218                         The default is to not do clash detection.
219 --lockdir=DIR           The directory to put clash detection files in, such as
220                         `/var/lock/emacs'.
221     Defaults to `${statedir}/xemacs/lock'.
222 --with-system-malloc    Force use of the system malloc, rather than GNU malloc.
223 --with-debug-malloc     Use the debugging malloc package.
224
225 You may also specify any of the `path' variables found in Makefile.in,
226 including --bindir, --libdir, --lispdir, --sitelispdir, --datadir,
227 --infodir, --mandir and so on.  Note that we recommend against
228 explicitly setting any of these variables.  See the INSTALL file for a
229 complete list plus the reasons we advise not changing them.
230
231 If successful, configure leaves its status in config.status.  If
232 unsuccessful after disturbing the status quo, it removes config.status.
233
234 The configure script also recognizes some environment variables, each
235 of which is equivalent to a corresponding configure flag.  A specified
236 configure flag always overrides the environment variable.
237
238 envvar      configure flag
239 -----       --------------
240 CC          --compiler
241 CPP         --cpp
242 CFLAGS      --cflags
243 CPPFLAGS    --cppflags
244 LDFLAGS     --ldflags
245 LIBS        --libs
246 LD_RUN_PATH --site-runtime-libraries
247
248 For more details on the install process, consult the INSTALL file.