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