XEmacs 21.4.5 "Civil Service".
[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 Many features require external packages to be installed first.
13 Get them from ftp://ftp.xemacs.org/pub/xemacs/aux.
14
15 Use colons (or quoted spaces) to separate directory names in option
16 values which are PATHs (i.e. lists of directories).
17
18 The results of configure tests are saved in config.log, which is useful
19 for diagnosing problems.
20
21
22 General options:
23
24 --help                  Issue this usage message.
25 --verbose               Accepted but ignored.
26 --extra-verbose         Display more information, useful for debugging.
27
28
29 Compilation options:
30
31 --compiler=PROG         C compiler to use
32 --with-gcc (*)          Use GCC to compile XEmacs.
33 --cflags=FLAGS          Compiler flags (such as -O)
34 --cpp=PROG              C preprocessor to use (e.g. /usr/ccs/lib/cpp or cc -E)
35 --cppflags=FLAGS        C preprocessor flags (e.g. -I/foo or -Dfoo=bar)
36 --libs=LIBS             Additional libraries (e.g. -lfoo)
37 --ldflags=FLAGS         Additional linker flags (e.g. -L/foo)
38 --site-includes=PATH    List of directories to search first for header files
39 --site-libraries=PATH   List of directories to search first for libraries
40 --site-prefixes=PATH    List of directories to search for include/ and lib/
41                         subdirectories, just after 'site-includes' and
42                         'site-libraries'
43 --site-runtime-libraries=PATH
44                         List of ALL directories to search for dynamically
45                         linked libraries at run time
46 --dynamic=yes           Link dynamically if supported by system.
47 --dynamic=no            Force static linking on systems where dynamic
48                         linking is the default.
49 --srcdir=DIR            Look for the XEmacs source files in DIR.
50                         Works best when using GNU Make.
51
52
53 Installation options:
54
55 --prefix=DIR            Install files below DIR.  Defaults to `/usr/local'.
56 --with-prefix=no        Don't compile the value of --prefix into the
57                         executable.
58
59
60 Window-system options:
61
62 --with-gtk              Support GTK on the X Window System. (EXPERIMENTAL)
63 --with-gnome            Support GNOME on the X Window System. (EXPERIMENTAL)
64 --with-x11 (*)          Support the X Window System.
65 --x-includes=DIR        Search for X header files in DIR.
66 --x-libraries=DIR       Search for X libraries in DIR.
67 --with-msw (*)          Support MS Windows as a window system (only under
68                         Cygwin and MinGW).  `--with-msw=no' may be needed on
69                         *nix systems with Wine installed.
70 --with-toolbars=no      Don't compile with any toolbar support.
71 --with-wmcommand=no     Compile without realized leader window which will
72                         keep the WM_COMMAND property.
73 --with-athena=TYPE      Use TYPE Athena widgets
74                         (xaw, 3d, next, 95, or xpm)
75 --with-menubars=TYPE    Use TYPE menubars (lucid, motif, or no).  The Lucid
76                         widgets emulate Motif (mostly) but are faster.
77                         *WARNING*  The Motif menubar is currently broken.
78 --with-scrollbars=TYPE  Use TYPE scrollbars
79                         (lucid, motif, athena, or no).
80 --with-dialogs=TYPE     Use TYPE dialog boxes (lucid, motif, athena, or no).
81                         Lucid menubars and scrollbars are the default.
82                         Motif dialog boxes will be used if Motif can be found.
83 --with-widgets=TYPE     Use TYPE widgets (lucid, motif, athena, or no).
84                         Motif widgets will be used if Motif can be found.
85                         Other widget types are currently unsupported.
86 --with-dragndrop        Compile in the generic drag and drop API. This is
87                         automatically added if one of the drag and drop
88                         protocols is found (currently CDE, OffiX, MSWindows,
89                         and GTK).
90                         *WARNING*  The Drag'n'drop support is under development
91                                    and is considered experimental.
92 --with-cde              Compile in support for CDE drag and drop.
93 --with-offix            Compile in support for OffiX drag and drop.
94                         *WARNING*  If you compile in OffiX, you may not be
95                                    able to use multiple X displays success-
96                                    fully.  If the two servers are from
97                                    different vendors, the results may be
98                                    unpredictable.
99 --with-xmu=no (*)       For those unfortunates whose vendors don't ship Xmu.
100 --external-widget       Compile with external widget support.
101
102
103 TTY (character terminal) options:
104
105 --with-tty=no           Don't support ttys.
106 --with-ncurses (*)      Use the ncurses library for tty support.
107 --with-gpm (*)          Compile in GPM mouse support for ttys.
108
109
110 Image options:
111
112 --with-xpm (*)          Compile with support for XPM images.  PRACTICALLY
113                         REQUIRED.  Although this library is nonstandard and
114                         a real hassle to build, many basic things (e.g.
115                         toolbars) depend on it, and you will run into
116                         many problems without it.
117 --with-png (*)          Compile with support for PNG images.  Recommended
118                         because the images on the About page are not viewable
119                         without it.
120 --with-jpeg (*)         Compile with support for JPEG images.  Useful if
121                         you are using a mail, news reader, or web browser
122                         in XEmacs, so that JPEG images can be displayed.
123 --with-tiff (*)         Compile with support for TIFF images.  Possibly
124                         useful, for the same reason as JPEG images.
125 --with-xface (*)        Compile with support for X-Face mail headers.
126                         Requires the compface package.  Of doubtful
127                         usefulness.
128 --with-gif=no           Compile without the (builtin) support for GIF images.
129
130
131 Sound options:
132
133 --with-sound=TYPE[,TYPE[,...]] (*) Compile with sound support.
134                         Valid types are `native', `nas' and `esd'.
135                         Prefix a type with 'no' to disable.
136                         The first type can be `none' or `all'.  `none' means
137                         `nonative,nonas,noesd'.  `all' means `native,nas,esd'.
138                         Later options override earlier ones for the same TYPE.
139                         Autodetect native and NAS sound unless specified.
140                         ESD must be explicitly requested.
141 --native-sound-lib=LIB  Native sound support library.  Needed on Suns
142                         with `--with-sound=native,nas' because both sound
143                         libraries are called libaudio.
144
145
146 Database options:
147
148 --with-database=TYPE (*) Compile with database support.  Valid types are
149                         `no' or a comma-separated list of one or more
150                         of `berkdb' and either `dbm' or `gnudbm'.
151 --with-ldap (*)         Compile with support for the LDAP protocol.
152 --with-postgresql (*)   Compile with support for the PostgreSQL RDBMS.
153
154
155 Mail options:
156
157 --mail-locking=TYPE (*) Specify the locking to be used by movemail to prevent
158                         concurrent updates of mail spool files. Valid types
159                         are `lockf', `flock', `dot', `locking' or `mmdf'.
160 --with-pop              Support POP for mail retrieval.
161 --with-kerberos         Support Kerberos-authenticated POP.
162 --with-hesiod           Support Hesiod to get the POP server host.
163
164
165 Additional features:
166
167 --with-tooltalk (*)     Support the ToolTalk IPC protocol.
168 --with-workshop         Support the Sun WorkShop (formerly Sparcworks)
169                         development environment.
170 --with-socks            Compile with support for SOCKS (an Internet proxy).
171 --with-dnet (*)         Compile with support for DECnet.
172 --with-modules          Compile in experimental support for dynamically
173                         loaded libraries (Dynamic Shared Objects).
174 --with-netinstall       Compile in support for installation over the internet.
175                         Only functional on the MS Windows platforms.
176 --with-ipv6-cname=no    Don't try to get IPv6 information when canonicalizing
177                         host names.  This option has no effect unless system
178                         supports getaddrinfo(3) and getnameinfo(3).
179 --with-site-lisp=yes    Allow for a site-lisp directory in the XEmacs hierarchy
180                         searched before the installation packages.
181 --with-site-modules=no  Disable site-modules directory in the XEmacs hierarchy,
182                         which is searched before the installation modules.
183 --package-path=PATH     Directories to search for packages to dump with xemacs.
184                         PATH splits into three parts separated by double
185                         colons (::), an early, a late, and a last part,
186                         corresponding to their position in the various
187                         system paths:  The early part is always first,
188                         the late part somewhere in the middle, and the
189                         last part at the very back.
190                         Only the late part gets seen at dump time.
191                         If PATH has only one component, that component
192                         is late.
193                         If PATH has two components, the first is
194                         early, the second is late.
195 --infodir=DIR           Directory to install XEmacs Info manuals and dir in.
196 --infopath=PATH         Directories to search for Info documents, info dir
197                         and localdir files in case run-time searching
198                         for them fails.
199 --moduledir=DIR         Directory to install dynamic modules in.
200 --pdump                 New, experimental, don't-sue-me-if-your-house-
201                         collapses-and-your-wife-leaves-you, portable dumper.
202 --with-file-coding      Allows transparent use of "foreign" line break
203                         conventions in text files (such as LF-delimited text
204                         imported from a Unix system to a Windows environment),
205                         optionally including autodetection.  Defaults to ON
206                         on Windows, OFF on Unix.
207
208 Internationalization options:
209
210 --with-mule             Compile with Mule (MUlti-Lingual Emacs) support,
211                         needed to support non-Latin-1 (including Asian)
212                         languages.
213 --with-xim=xlib         Compile with support for X input methods,
214 --with-xim=motif (*)    Used in conjunction with Mule support.
215                         Use either raw Xlib to provide XIM support, or
216                         the Motif XmIm* routines (when available).
217                         NOTE:  On some systems bugs in X11's XIM support
218                         will cause XEmacs to crash, so by default,
219                         no XIM support is compiled in, unless running
220                         on Solaris and the XmIm* routines are detected.
221 --with-canna (*)        Compile with support for Canna (a Japanese input method
222                         used in conjunction with Mule support).
223 --with-wnn (*)          Compile with support for Wnn (a multi-language input
224                         method used in conjunction with Mule support).
225 --with-wnn6 (*)         Compile with support for the commercial package Wnn6.
226 --with-i18n3            Compile with I18N level 3 (support for message
227                         translation).  This doesn't currently work.
228 --with-xfs              Compile with XFontSet support for internationalized
229                         menubar.  Incompatible with `--with-xim=motif'.
230                         `--with-menubars=lucid' (the default) is desirable.
231
232
233 Debugging options:
234
235 --debug                 Compile with support for debugging XEmacs.
236                         (Causes code-size increase and little loss of speed.)
237 --error-checking=TYPE[,TYPE]...
238                         Compile with internal error-checking added.
239                         Causes noticeable loss of speed.  Valid types
240                         are extents, bufpos, malloc, gc, typecheck.
241 --error-checking=none   Disable all internal error-checking (the default).
242 --error-checking=all    Enable all internal error-checking.
243 --memory-usage-stats    Compile with additional code to allow you to
244                         determine what XEmacs's memory is being used
245                         for.  Causes a small code increase but no loss
246                         of speed.  Normally enabled when --debug is given.
247 --no-doc-file           Don't rebuild the DOC file unless it's explicitly
248                         deleted.  Only use during development. (It speeds
249                         up the compile-run-test cycle.)
250 --use-union-type        Enable or disable use of a union, instead of an
251                         int, for the fundamental Lisp_Object type; this
252                         provides stricter type-checking.  Only works with
253                         some systems and compilers.
254 --with-quantify         Add support for performance debugging using Quantify.
255 --with-purify           Add support for memory debugging using Purify.
256
257
258 Other options:
259
260 --rel-alloc             Use the relocating allocator (default for this option
261                         is system-dependent).
262 --with-dlmalloc         Control usage of Doug Lea malloc on systems that have
263                         it in the standard C library (default is to use it if
264                         it is available).
265 --with-system-malloc    Force use of the system malloc, rather than GNU malloc.
266 --with-debug-malloc     Use the debugging malloc package.
267 --with-clash-detection  Use lock files to detect multiple edits of the same
268                         file.  The default is to do clash detection.
269
270 You may also specify any of the `path' variables found in Makefile.in,
271 including --bindir, --libdir, --docdir, --lispdir, --sitelispdir,
272 --datadir, --infodir, --mandir and so on.  Note that we recommend
273 against explicitly setting any of these variables.  See the INSTALL
274 file for a complete list plus the reasons we advise not changing them.
275
276 If successful, configure leaves its status in config.status.  If
277 unsuccessful after disturbing the status quo, it removes config.status.
278
279 The configure script also recognizes some environment variables, each
280 of which is equivalent to a corresponding configure flag.  Configure
281 flags take precedence over environment variables, if both are specified.
282
283 environment   corresponding
284 variable      configure flag
285 -----------   --------------
286 CC            --compiler
287 CPP           --cpp
288 CFLAGS        --cflags
289 CPPFLAGS      --cppflags
290 LDFLAGS       --ldflags
291 LIBS          --libs
292 LD_RUN_PATH   --site-runtime-libraries
293
294 For more details on the install process, consult the INSTALL file.