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