(A-IWDSU+271C4): New abstract node.
[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 CONFIGURATION is an optional architecture-vendor-os triple, such as
6 `sparc-sun-solaris2.7'.  When possible, omit it; configure will detect it.
7
8 Conventions for options:
9 - Boolean options may be explicitly enabled by using `--OPTION=yes' and
10   explicitly disabled by using `--OPTION=no'.  `--OPTION' (with no argument)
11   is equivalent to `--OPTION=yes'.  `--without-FEATURE' is a synonym for
12   `--with-FEATURE=no'.  Denoted `(Bool)' below.
13 - Enumerated options accept one type from a specified list.  These usually
14   accept `--OPTION=no' to disable it entirely, and `--OPTION=yes' often has a
15   useful default.  Denoted `(Enum)'.
16 - Set options accept one or more types from a list of implementations of the
17   feature.  All specified implementations will be included.  Prefix a type
18   with `no' to disable only that implementation (e.g., `--with-sound=nonas'
19   to disable NAS).  The special values `none' and `all' must be first in the
20   list if used.  They change the defaults for all types individually from
21   autodetect to `no' or `yes' respectively.  `--with-sound=none,native' and
22   `--with-sound=noesd,nonas,native' have the same effect.  Denoted `(Set)'.
23 - Other options have special, option-specific formats.
24
25 Options marked with a (*) are auto-detected.  If auto-detected and not
26 explicitly specified, normally
27 - Boolean options default to `yes'.
28 - Enumerated options default to the first detected type in an option-specific
29   priority.  Possible defaults are marked with (*) and listed in order.
30 - Set options default to all detected types.
31
32 Some options are provided mainly to disable features which are on by default.
33 These are indicated by specifying `--OPTION=no'.  Explicitly specifying an
34 autodetected option which defaults to `yes' makes a failure to detect signal
35 a fatal configure error.
36
37 Use colons (or quoted spaces) to separate directory names in option
38 values which are PATHs (i.e. lists of directories).
39
40 Many features require external packages to be installed.  configure will fail
41 if an explicitly requested feature depends on an uninstalled package.  On many
42 Linux systems, you must install -devel versions of the package.
43
44 The results of configure tests are saved in config.log, which is useful
45 for diagnosing problems.  Caching of configure results is disabled.
46 If successful, configure leaves its status in config.status.  If
47 unsuccessful after disturbing the status quo, it removes config.status.
48
49
50 General options:
51
52 --help                  Issue this usage message.
53 --verbose               Accepted but ignored.
54 --extra-verbose         Display more information, useful for debugging.
55
56
57 Compilation options:
58
59 --compiler=PROG         C compiler to use
60 --with-gcc (*)          (Bool) Use GCC to compile XEmacs.
61 --cflags=FLAGS          Compiler flags (such as `-O')
62 --cpp=PROG              Set C preprocessor (e.g. `/usr/ccs/lib/cpp', `cc -E')
63 --cppflags=FLAGS        C preprocessor flags (e.g. `-I/foo' or `-Dfoo=bar')
64 --libs=LIBS             Additional libraries (e.g. `-lfoo')
65 --ldflags=FLAGS         Additional linker flags (e.g. `-L/foo')
66 --site-includes=PATH    List of directories to search first for header files
67 --site-libraries=PATH   List of directories to search first for libraries
68 --site-prefixes=PATH    List of directories to search for include/ and lib/
69                         subdirectories, just after 'site-includes' and
70                         'site-libraries'
71 --site-runtime-libraries=PATH  List of ALL directories to search for
72                         dynamically linked libraries at run time
73 --dynamic (*)           (Bool) Link dynamically if supported by system.
74                         The default is system-dependent.
75 --srcdir=DIR            Use the XEmacs source files in DIR.  Requires a Make
76                         with VPATH; GNU Make is recommended.
77
78
79 Installation options:
80
81 --prefix=DIR            Install files below DIR.  Defaults to `/usr/local'.
82 --with-prefix=no        (Bool) Compile the value of `--prefix' into XEmacs.
83 --infodir=DIR           Install XEmacs Info manuals and dir in DIR.
84 --moduledir=DIR         Install dynamic modules in DIR.
85
86 You may also specify any of the `path' variables found in Makefile.in.in,
87 including `--bindir', `--libdir', `--docdir', `--lispdir', `--sitelispdir',
88 `--datadir', `--mandir' and so on.  These options are DEPRECATED; see INSTALL.
89
90
91 Runtime search path options:
92
93 --with-site-modules=no  (Bool) Search directories in the XEmacs hierarchy named
94                         `site-modules' before the installed module directories.
95 --with-site-lisp        (Bool) Search a site-lisp directory in the XEmacs
96                         hierarchy before the packaged Lisp.  DEPRECATED.
97 --package-path=PATH     Directories to search for packages to dump with xemacs.
98                         PATH splits into three parts separated by double
99                         colons (::), an `early', a `late', and a `last' part,
100                         corresponding to their position in the various
101                         system paths:  The `early' part is always first,
102                         the `late' part somewhere in the middle, and the
103                         `last' part at the very back.
104                         Only the `late' part gets seen at dump time.
105                         If PATH has only one component, it is `late'.  With two
106                         components, the first is `early', the second is `late'.
107 --infopath=PATH         Directories to search for Info documents, info dir
108                         and localdir files if run-time searching fails.
109
110
111 Window-system options:
112
113 --with-gtk              (Bool) Use GTK on the X Window System. (EXPERIMENTAL)
114 --with-gnome            (Bool) Use GNOME on the X Window System. (EXPERIMENTAL)
115 --with-x11 (*)          (Bool) Support the X Window System.
116 --x-includes=DIR        Search for X header files in DIR.
117 --x-libraries=DIR       Search for X libraries in DIR.
118 --with-msw (*)          (Bool) Support MS Windows as a window system (only
119                         under Cygwin and MinGW).  `--with-msw=no' may be needed
120                         on *nix systems with Wine installed.
121 --with-wmcommand=no     (Bool) Compile without realized leader window which
122                         will keep the WM_COMMAND property.
123 --with-xmu=no (*)       (Bool) For systems whose vendors don't ship Xmu.
124
125
126 GUI component options:
127
128 Select the widget set used to implement components, Lucid, Motif, or Athena.
129 If `--with-gtk', `--with-gnome', or `--with-msw' are used or implied, treat
130 component options as Bool.  The `lucid' widgets are a homebrew set, emulating
131 Motif but faster.  Lucid toolbars, menubars, and scrollbars are implemented
132 in Xt.  Lucid dialogs and misc widgets wrap and enhance Motif (or Athena if
133 Motif is not found).  Several enhanced (eg, 3d) Athena libraries may be used,
134 but the default is the X11R6 `libXaw' (flat) widgets.  Use `--with-athena' to
135 explicitly specify which library to link against.
136
137 --with-toolbars=no      (Bool) Don't compile with any toolbar support.
138 --with-menubars=TYPE    (Enum) Types: `lucid'(*), `motif', or `no'.
139                         *WARNING*  The Motif menubar is currently broken.
140 --with-scrollbars=TYPE  (Enum) Types: `lucid'(*), `motif', `athena', or `no'.
141 --with-dialogs=TYPE     (Enum) Types: `lucid'(*), `motif', `athena', or `no'.
142 --with-widgets=TYPE     (Enum) Types: `lucid', `motif', `athena', or `no'(*).
143 --with-athena=TYPE      (Enum) Link with the TYPE Athena library.  Types:
144                         `xaw' [flat], `3d', `next', `95', or `xpm'.
145 --with-dragndrop (*)    Support generic drag and drop API. (EXPERIMENTAL)
146 --with-cde              Support CDE drag and drop API (requires dragndrop).
147 --with-offix            Support OffiX drag and drop API (requires dragndrop).
148                         *WARNING*  OffiX support may interfere with use of
149                         multiple X displays.  If the two servers are from
150                         different vendors, the results may be unpredictable.
151
152
153 TTY (character terminal) options:
154
155 --with-tty=no           Don't support ttys.
156 --with-ncurses (*)      Use the ncurses library for tty support.
157 --with-gpm (*)          Support the GPM mouse library for ttys.
158
159
160 Image options:
161
162 --with-xpm (*)          Support XPM images.  Toolbars depend on it.
163 --with-png (*)          Support PNG images.  Strongly recommended.
164 --with-jpeg (*)         Support JPEG images.
165 --with-tiff (*)         Support TIFF images.
166 --with-xface (*)        Support X-Face mail headers.  Requires libcompface.
167 --with-gif=no           Omit the (builtin) support for GIF images.
168
169
170 Sound options:
171
172 --with-sound=TYPES (*)  (Set) Compile with sound support.
173                         Types: `native', `nas' and `esd'.
174                         Defaults to `noesd', the others are autodetected.
175 --native-sound-lib=LIB  Native sound support library.  Needed on Suns
176                         with `--with-sound=native,nas' because both sound
177                         libraries are called libaudio.
178
179
180 Database options:
181
182 --with-database=TYPES (*)  (Set) Support key:value databases.
183                         Types: `berkdb', `dbm', or `gnudbm'.  `dbm' and
184                         `gnudbm' are incompatible with each other.
185 --with-ldap (*)         (Bool) Support the LDAP protocol.
186 --with-postgresql (*)   (Bool) Support the PostgreSQL RDBMS.
187
188
189 Mail options:
190
191 --mail-locking=TYPE (*) (Enum) Specify the locking method used by movemail.
192                         Types: `lockf', `flock', `dot', `locking' or `mmdf'.
193 --with-pop              (Bool) Support POP for mail retrieval.
194 --with-kerberos         (Bool) Support Kerberos-authenticated POP.
195 --with-hesiod           (Bool) Support Hesiod to get the POP server host.
196
197
198 Internationalization options:
199
200 --with-mule             (Bool) Support non-Latin-1 (including Asian) languages.
201 --with-xim=TYPE         (Enum) Support X Input Method protocol.  Types:
202                         `motif'(*), `xlib', `no'.  Requires Mule.
203 --with-canna (*)        (Bool) Support the Canna input method.  Requires Mule.
204 --with-wnn (*)          (Bool) Support the Wnn input methods.  Requires Mule.
205 --with-wnn6 (*)         (Bool) Support the commercial version of Wnn.
206 --with-xfs              (Bool) Support internationalized menubar via XFontSets.
207                         `--with-menubars=lucid' (the default) is desirable.
208                         Incompatible with `--with-xim=motif'.
209
210
211 Additional features:
212
213 --with-workshop         (Bool) Support the Sun WorkShop (formerly Sparcworks)
214                         development environment.
215 --with-tooltalk (*)     (Bool) Support the ToolTalk IPC protocol.
216 --with-socks            (Bool) Support SOCKS (an Internet proxy).
217 --with-dnet (*)         (Bool) Support DECnet.
218 --with-netinstall       (Bool) Support installation over the internet.
219                         Only functional on MS Windows platforms.
220 --with-ipv6-cname       (Bool) IPv6-ly correct host name canonicalization.
221                         IPv6 is always supported if detected; this option
222                         prevents blocking and unwanted dialup for CNAME lookup.
223 --external-widget       (Bool) Export XEmacs as a text widget. (EXPERIMENTAL)
224 --with-modules (*)      (Bool) Support for dynamically loaded libraries
225                         (Dynamic Shared Objects). (EXPERIMENTAL)
226 --pdump                 (Bool) Somewhat experimental portable dumper.
227 --with-file-coding      (Bool) Support detection and translation of newline
228                         conventions.  Default:  `yes' on Windows, `no' on Unix.
229 --with-clash-detection=no  (Bool) Detect other instances editing the same file.
230
231
232 Memory allocation options:
233
234 --rel-alloc             (Bool) Use the relocating allocator (default for this
235                         option is system-dependent).
236 --with-dlmalloc=no      (Bool) Don't use Doug Lea malloc on systems that have
237                         it in the standard C library.
238 --with-system-malloc    (Bool) Use the system malloc, instead of GNU malloc.
239 --with-debug-malloc     (Bool) Use the debugging malloc package.
240 --use-regex-malloc=no   (Bool) Use malloc (not alloca) for regex fail stack.
241                         Setting this to 'no' allows crashes - it may be
242                         impossible to detect stack exhaustion, and your
243                         XEmacs will crash.
244
245
246 Debugging options:
247
248 --debug                 (Bool) Compile with support for debugging XEmacs.
249                         (Causes code-size increase and little loss of speed.)
250 --memory-usage-stats    (Bool) Compile with additional code to allow you to
251                         determine what XEmacs's memory is being used
252                         for.  Causes a small code increase but no loss
253                         of speed.  Normally enabled when `--debug' is given.
254 --error-checking=TYPES  (Set) Compile with internal error-checking added.
255                         Causes noticeable loss of speed.  Types: `bufpos',
256                         `byte-code', `extents', `gc', `glyphs', `malloc', and
257                         `typecheck'.  The default value is `none'.
258 --use-union-type        (Bool) Define Lisp_Object as a union, not an int.
259                         Use for strict _static_ type-checking.  Implicated in
260                         system-dependent, hard-to-debug crashes.  See PROBLEMS.
261                         Do NOT use in production builds.
262 --no-doc-file           (Bool) Don't rebuild the DOC file unless it's missing.
263                         Only use during development.
264 --quick-build           (Bool) Don't GC when dumping.  Implies `--no-doc-file'.
265 --with-quantify         (Bool) Support performance debugging using Quantify.
266 --with-purify           (Bool) Support memory debugging using Purify.
267
268
269 The configure script also recognizes some environment variables, each
270 of which is equivalent to a corresponding configure flag.  Configure
271 flags take precedence over environment variables, if both are specified.
272
273 environment   corresponding
274 variable      configure flag
275 -----------   --------------
276 CC            --compiler
277 CPP           --cpp
278 CFLAGS        --cflags
279 CPPFLAGS      --cppflags
280 LDFLAGS       --ldflags
281 LIBS          --libs
282 LD_RUN_PATH   --site-runtime-libraries
283
284 For more details on the install process, consult the INSTALL file.