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