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