XEmacs 21.2.24 "Hecate".
[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 --cflags=FLAGS          Compiler flags (such as -O)
28 --cpp=prog              C preprocessor to use (e.g. /usr/ccs/lib/cpp or cc -E)
29 --cppflags=FLAGS        C preprocessor flags (e.g. -I/foo or -Dfoo=bar)
30 --libs=LIBS             Additional libraries (e.g. -lfoo)
31 --ldflags=FLAGS         Additional linker flags (e.g. -L/foo)
32 --site-includes=PATH    List of directories to search first for header files.
33 --site-libraries=PATH   List of directories to search first for libraries.
34 --site-prefixes=PATH    List of directories to search for include/ and lib/
35                         subdirectories, just after 'site-includes' and
36                         'site-libraries'.
37 --site-runtime-libraries=PATH
38                         List of ALL directories to search for dynamically
39                         linked libraries at run time.
40 --dynamic=yes           Link dynamically if supported by system.
41 --dynamic=no            Force static linking on systems where dynamic
42                         linking is the default.
43 --srcdir=DIR            Look for the XEmacs source files in DIR.
44                         Works best when using GNU Make.
45
46
47 Installation options:
48
49 --prefix=DIR            Install files below DIR.  Defaults to `/usr/local'.
50 --with-prefix           Compile the value of --prefix into the executable.
51                         Defaults to `yes'.
52 --without-prefix        Don't compile the value of --prefix into the executable.
53
54
55 Window-system options:
56
57 --with-x11 (*)          Support the X Window System.
58 --without-x11           Don't support X.
59 --x-includes=DIR        Search for X header files in DIR.
60 --x-libraries=DIR       Search for X libraries in DIR.
61 --without-toolbars      Don't compile with any toolbar support.
62 --without-wmcommand     Compile without realized leader window which will
63                         keep the WM_COMMAND property.
64 --with-menubars=TYPE    Use TYPE menubars (lucid, motif, or no).  The Lucid
65                         widgets emulate Motif (mostly) but are faster.
66                         *WARNING*  The Motif menubar is currently broken.
67 --with-scrollbars=TYPE  Use TYPE scrollbars
68                         (lucid, motif, athena, athena3d, or no).
69 --with-dialogs=TYPE     Use TYPE dialog boxes (motif, athena, athena3d, or no).
70                         Lucid menubars and scrollbars are the default.
71                         Motif dialog boxes will be used if Motif can be found.
72 --with-widgets=TYPE     Use TYPE widgets (motif, athena, athena3d, or no).
73                         Motif widgets will be used if Motif can be found.
74                         Other widget types are currently unsupported.
75 --with-dragndrop (*)    Compile in the generic drag and drop API. This is
76                         automatically added if one of the drag and drop
77                         protocols is found (currently CDE, OffiX, MSWindows).
78                         *WARNING*  The Drag'n'drop support is under development
79                                    and is considered experimental.
80 --with-cde (*)          Compile in support for CDE drag and drop.
81 --with-offix (*)        Compile in support for OffiX drag and drop.
82                         *WARNING*  If you compile in OffiX, you may not be
83                                    able to use multiple X displays success-
84                                    fully.  If the two servers are from
85                                    different vendors, the results may be
86                                    unpredictable.
87 --without-xmu (*)       For those unfortunates whose vendors don't ship Xmu.
88 --external-widget       Compile with external widget support.
89 --with-xpm (*)          Compile with support for XPM files.
90                         It is highly recommended that you obtain XPM
91                         (version 3.4h or better) if you don't already
92                         have it.  Get it from the XEmacs FTP site.
93 --with-xface (*)        Compile with support for X-Face mail header
94                         conversion.  Requires the compface library.
95                         Get it from the XEmacs FTP site.
96 --without-gif           Compile without the built-in support for GIF image
97                         conversion.
98 --with-jpeg (*)         Compile with support for JPEG image conversion.
99                         Requires libjpeg from the Independent JPEG Group.
100                         Get it from the XEmacs FTP site.
101 --with-png (*)          Compile with support for PNG image conversion.
102                         Requires libpng.  Get it from the XEmacs FTP site.
103 --with-tiff (*)         Compile with support for TIFF image conversion.
104                         Requires Sam Lefflier's libtiff library.
105                         Get if from the XEmacs FTP site.
106
107
108 TTY options:
109
110 --without-tty           Don't support TTY-s.
111 --with-ncurses (*)      Use the ncurses library for tty support.
112 --with-gpm (*)          Compile in support for General Purpose Mouse.
113
114
115 Additional features:
116
117 --with-tooltalk (*)     Support the ToolTalk IPC protocol.
118 --with-workshop         Support the Sun WorkShop (formerly Sparcworks)
119                         development environment.
120 --with-socks            Compile with support for SOCKS (an Internet proxy).
121 --with-database=TYPE (*) Compile with database support.  Valid types are
122                         `no' or a comma-separated list of one or more
123                         of `berkdb' and either `dbm' or `gnudbm'.
124 --with-sound=TYPE,[TYPE],... Compile with native sound support.
125                         Valid types are `native', `nas' and `esd'.
126                         Prefix a type with 'no' to disable.
127                         The first option can be `none' or `all'.
128                         `none' is a synonym for `nonative,nonas,noesd'.
129                         `all' is a synonym for native,nas,esd or `all'.
130                         The default is to autodetect all 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-modules          Compile in experimental support for dynamically
144                         loaded libraries (Dynamic Shared Objects).
145 --with-site-lisp=yes    Allow for a site-lisp directory in the XEmacs hierarchy
146                         searched before the installation packages.
147 --with-site-modules=no  Disable site-modules directory in the XEmacs hierarchy,
148                         which is searched before the installation modules.
149 --package-path=PATH     Directories to search for packages to dump with xemacs.
150                         PATH splits into three parts separated by double
151                         colons (::), an early, a late, and a last part,
152                         corresponding to their position in the various
153                         system paths:  The early part is always first,
154                         the late part somewhere in the middle, and the
155                         last part at the very back.
156                         Only the late part gets seen at dump time.
157                         If PATH has only one component, that component
158                         is late.
159                         If PATH has two components, the first is
160                         early, the second is late.
161 --infodir=DIR           Directory to install XEmacs Info manuals and dir in.
162 --infopath=PATH         Directories to search for Info documents, info dir
163                         and localdir files in case run-time searching
164                         for them fails.
165 --moduledir=DIR         Directory to install dynamic modules in.
166 --pdump                 New, experimental, non-working, don't-sue-me-if-
167                         your-house-collapses-and-your-wife-goes-away,
168                         portable dumper.
169
170 Internationalization options:
171
172 --with-mule             Compile with Mule (MUlti-Lingual Emacs) support,
173                         needed to support non-Latin-1 (including Asian)
174                         languages.
175 --with-xim=xlib         Compile with support for X input methods,
176 --with-xim=motif (*)    Used in conjunction with Mule support.
177                         Use either raw Xlib to provide XIM support, or
178                         the Motif XmIm* routines (when available).
179                         NOTE:  On some systems bugs in X11's XIM support
180                         will cause XEmacs to crash, so by default,
181                         no XIM support is compiled in, unless running
182                         on Solaris and the XmIm* routines are detected.
183 --with-canna (*)        Compile with support for Canna (a Japanese input method
184                         used in conjunction with Mule support).
185 --with-wnn (*)          Compile with support for WNN (a multi-language input
186                         method used in conjunction with Mule support).
187 --with-wnn6 (*)         Compile with support for the comercial package WNN
188                         version 6
189 --with-i18n3            Compile with I18N level 3 (support for message
190                         translation).  This doesn't currently work.
191 --with-xfs              Compile with XFontSet support for bilingual menubar.
192                         Can't use this option with --with-xim=motif or xlib.
193                         And should have --with-menubars=lucid.
194
195
196 Debugging options:
197
198 --debug                 Compile with support for debugging XEmacs.
199                         (Causes code-size increase and little loss of speed.)
200 --error-checking=TYPE[,TYPE]...
201                         Compile with internal error-checking added.
202                         Causes noticeable loss of speed.  Valid types
203                         are extents, bufpos, malloc, gc, typecheck.
204 --error-checking=none   Disable all internal error-checking (the default).
205 --error-checking=all    Enable all internal error-checking.
206 --memory-usage-stats    Compile with additional code to allow you to
207                         determine what XEmacs's memory is being used
208                         for.  Causes a small code increase but no loss
209                         of speed.  Normally enabled when --debug is given.
210 --no-doc-file           Don't rebuild the DOC file unless it's explicitly
211                         deleted.  Only use during development. (It speeds
212                         up the compile-run-test cycle.)
213 --use-union-type        Enable or disable use of a union, instead of an
214                         int, for the fundamental Lisp_Object type; this
215                         provides stricter type-checking.  Only works with
216                         some systems and compilers.
217 --with-quantify         Add support for performance debugging using Quantify.
218 --with-purify           Add support for memory debugging using Purify.
219
220
221 Other options:
222
223 --rel-alloc             Use the relocating allocator (default for this option
224                         is system-dependent).
225 --with-dlmalloc         Control usage of Doug Lea malloc on systems that have
226                         it in the standard C library (default is to use it if
227                         it is available).
228 --with-system-malloc    Force use of the system malloc, rather than GNU malloc.
229 --with-debug-malloc     Use the debugging malloc package.
230 --with-clash-detection  Use lock files to detect multiple edits of the same
231                         file.  The default is to not do clash detection.
232 --lockdir=DIR           The directory to put clash detection files in, such as
233                         `/var/lock/emacs'.
234                         Defaults to `${statedir}/xemacs/lock'.
235
236 You may also specify any of the `path' variables found in Makefile.in,
237 including --bindir, --libdir, --docdir, --lispdir, --sitelispdir,
238 --datadir, --infodir, --mandir and so on.  Note that we recommend
239 against explicitly setting any of these variables.  See the INSTALL
240 file for a complete list plus the reasons we advise not changing them.
241
242 If successful, configure leaves its status in config.status.  If
243 unsuccessful after disturbing the status quo, it removes config.status.
244
245 The configure script also recognizes some environment variables, each
246 of which is equivalent to a corresponding configure flag.  A specified
247 configure flag always overrides the environment variable.
248
249 envvar      configure flag
250 -----       --------------
251 CC          --compiler
252 CPP         --cpp
253 CFLAGS      --cflags
254 CPPFLAGS    --cppflags
255 LDFLAGS     --ldflags
256 LIBS        --libs
257 LD_RUN_PATH --site-runtime-libraries
258
259 For more details on the install process, consult the INSTALL file.