XEmacs 21.4.9 "Informed Management".
[chise/xemacs-chise.git.1] / configure.usage
index dbeeb9a..361a596 100644 (file)
@@ -9,34 +9,40 @@ The option `--without-FEATURE' is a synonym for `--with-FEATURE=no'.
 
 Options marked with a (*) are auto-detected.
 
+Many features require external packages to be installed first.
+Get them from ftp://ftp.xemacs.org/pub/xemacs/aux.
+
 Use colons (or quoted spaces) to separate directory names in option
 values which are PATHs (i.e. lists of directories).
 
+The results of configure tests are saved in config.log, which is useful
+for diagnosing problems.
+
+
 General options:
 
 --help                  Issue this usage message.
---verbose               Display the results of configure tests.
---extra-verbose         Display even more information, useful for debugging.
+--verbose               Accepted but ignored.
+--extra-verbose         Display more information, useful for debugging.
 
 
 Compilation options:
 
---compiler=prog         C compiler to use.
+--compiler=PROG         C compiler to use
 --with-gcc (*)          Use GCC to compile XEmacs.
---without-gcc           Don't use GCC to compile XEmacs.
 --cflags=FLAGS          Compiler flags (such as -O)
---cpp=prog              C preprocessor to use (e.g. /usr/ccs/lib/cpp or cc -E)
+--cpp=PROG              C preprocessor to use (e.g. /usr/ccs/lib/cpp or cc -E)
 --cppflags=FLAGS        C preprocessor flags (e.g. -I/foo or -Dfoo=bar)
 --libs=LIBS             Additional libraries (e.g. -lfoo)
 --ldflags=FLAGS         Additional linker flags (e.g. -L/foo)
---site-includes=PATH    List of directories to search first for header files.
---site-libraries=PATH   List of directories to search first for libraries.
+--site-includes=PATH    List of directories to search first for header files
+--site-libraries=PATH   List of directories to search first for libraries
 --site-prefixes=PATH    List of directories to search for include/ and lib/
                         subdirectories, just after 'site-includes' and
-                        'site-libraries'.
+                        'site-libraries'
 --site-runtime-libraries=PATH
                         List of ALL directories to search for dynamically
-                        linked libraries at run time.
+                        linked libraries at run time
 --dynamic=yes           Link dynamically if supported by system.
 --dynamic=no            Force static linking on systems where dynamic
                         linking is the default.
@@ -47,69 +53,113 @@ Compilation options:
 Installation options:
 
 --prefix=DIR            Install files below DIR.  Defaults to `/usr/local'.
---with-prefix          Compile the value of --prefix into the executable.
-                        Defaults to `yes'.
---without-prefix        Don't compile the value of --prefix into the executable.
+--with-prefix=no        Don't compile the value of --prefix into the
+                        executable.
 
 
 Window-system options:
 
+--with-gtk              Support GTK on the X Window System. (EXPERIMENTAL)
+--with-gnome            Support GNOME on the X Window System. (EXPERIMENTAL)
 --with-x11 (*)          Support the X Window System.
---without-x11           Don't support X.
 --x-includes=DIR        Search for X header files in DIR.
 --x-libraries=DIR       Search for X libraries in DIR.
---without-toolbars      Don't compile with any toolbar support.
---without-wmcommand     Compile without realized leader window which will
+--with-msw (*)          Support MS Windows as a window system (only under
+                        Cygwin and MinGW).  `--with-msw=no' may be needed on
+                        *nix systems with Wine installed.
+--with-toolbars=no      Don't compile with any toolbar support.
+--with-wmcommand=no     Compile without realized leader window which will
                         keep the WM_COMMAND property.
+--with-athena=TYPE      Use TYPE Athena widgets
+                        (xaw, 3d, next, 95, or xpm)
 --with-menubars=TYPE    Use TYPE menubars (lucid, motif, or no).  The Lucid
                         widgets emulate Motif (mostly) but are faster.
                         *WARNING*  The Motif menubar is currently broken.
 --with-scrollbars=TYPE  Use TYPE scrollbars
-                        (lucid, motif, athena, athena3d, or no).
---with-dialogs=TYPE     Use TYPE dialog boxes (motif, athena, athena3d, or no).
+                        (lucid, motif, athena, or no).
+--with-dialogs=TYPE     Use TYPE dialog boxes (lucid, motif, athena, or no).
                         Lucid menubars and scrollbars are the default.
                         Motif dialog boxes will be used if Motif can be found.
---with-widgets=TYPE     Use TYPE widgets (motif, athena, athena3d, or no).
+--with-widgets=TYPE     Use TYPE widgets (lucid, motif, athena, or no).
                         Motif widgets will be used if Motif can be found.
                         Other widget types are currently unsupported.
---with-dragndrop (*)    Compile in the generic drag and drop API. This is
+--with-dragndrop        Compile in the generic drag and drop API. This is
                         automatically added if one of the drag and drop
-                        protocols is found (currently CDE, OffiX, MSWindows).
+                        protocols is found (currently CDE, OffiX, MSWindows,
+                        and GTK).
                         *WARNING*  The Drag'n'drop support is under development
                                    and is considered experimental.
---with-cde (*)          Compile in support for CDE drag and drop.
---with-offix (*)        Compile in support for OffiX drag and drop.
+--with-cde              Compile in support for CDE drag and drop.
+--with-offix            Compile in support for OffiX drag and drop.
                         *WARNING*  If you compile in OffiX, you may not be
                                    able to use multiple X displays success-
                                    fully.  If the two servers are from
                                    different vendors, the results may be
                                    unpredictable.
---without-xmu (*)       For those unfortunates whose vendors don't ship Xmu.
+--with-xmu=no (*)       For those unfortunates whose vendors don't ship Xmu.
 --external-widget       Compile with external widget support.
---with-xpm (*)          Compile with support for XPM files.
-                        It is highly recommended that you obtain XPM
-                        (version 3.4h or better) if you don't already
-                        have it.  Get it from the XEmacs FTP site.
---with-xface (*)        Compile with support for X-Face mail header
-                        conversion.  Requires the compface library.
-                        Get it from the XEmacs FTP site.
---without-gif           Compile without the built-in support for GIF image
-                        conversion.
---with-jpeg (*)         Compile with support for JPEG image conversion.
-                        Requires libjpeg from the Independent JPEG Group.
-                        Get it from the XEmacs FTP site.
---with-png (*)          Compile with support for PNG image conversion.
-                        Requires libpng.  Get it from the XEmacs FTP site.
---with-tiff (*)         Compile with support for TIFF image conversion.
-                        Requires Sam Lefflier's libtiff library.
-                        Get if from the XEmacs FTP site.
-
-
-TTY options:
-
---without-tty           Don't support TTY-s.
+
+
+TTY (character terminal) options:
+
+--with-tty=no           Don't support ttys.
 --with-ncurses (*)      Use the ncurses library for tty support.
---with-gpm (*)          Compile in support for General Purpose Mouse.
+--with-gpm (*)          Compile in GPM mouse support for ttys.
+
+
+Image options:
+
+--with-xpm (*)          Compile with support for XPM images.  PRACTICALLY
+                        REQUIRED.  Although this library is nonstandard and
+                        a real hassle to build, many basic things (e.g.
+                        toolbars) depend on it, and you will run into
+                        many problems without it.
+--with-png (*)          Compile with support for PNG images.  Recommended
+                        because the images on the About page are not viewable
+                        without it.
+--with-jpeg (*)         Compile with support for JPEG images.  Useful if
+                        you are using a mail, news reader, or web browser
+                        in XEmacs, so that JPEG images can be displayed.
+--with-tiff (*)         Compile with support for TIFF images.  Possibly
+                        useful, for the same reason as JPEG images.
+--with-xface (*)        Compile with support for X-Face mail headers.
+                        Requires the compface package.  Of doubtful
+                        usefulness.
+--with-gif=no           Compile without the (builtin) support for GIF images.
+
+
+Sound options:
+
+--with-sound=TYPE[,TYPE[,...]] (*) Compile with sound support.
+                        Valid types are `native', `nas' and `esd'.
+                        Prefix a type with 'no' to disable.
+                        The first type can be `none' or `all'.  `none' means
+                        `nonative,nonas,noesd'.  `all' means `native,nas,esd'.
+                        Later options override earlier ones for the same TYPE.
+                        Autodetect native and NAS sound unless specified.
+                        ESD must be explicitly requested.
+--native-sound-lib=LIB  Native sound support library.  Needed on Suns
+                        with `--with-sound=native,nas' because both sound
+                        libraries are called libaudio.
+
+
+Database options:
+
+--with-database=TYPE (*) Compile with database support.  Valid types are
+                        `no' or a comma-separated list of one or more
+                        of `berkdb' and either `dbm' or `gnudbm'.
+--with-ldap (*)         Compile with support for the LDAP protocol.
+--with-postgresql (*)   Compile with support for the PostgreSQL RDBMS.
+
+
+Mail options:
+
+--mail-locking=TYPE (*) Specify the locking to be used by movemail to prevent
+                        concurrent updates of mail spool files. Valid types
+                        are `lockf', `flock', `dot', `locking' or `mmdf'.
+--with-pop              Support POP for mail retrieval.
+--with-kerberos         Support Kerberos-authenticated POP.
+--with-hesiod           Support Hesiod to get the POP server host.
 
 
 Additional features:
@@ -118,26 +168,14 @@ Additional features:
 --with-workshop         Support the Sun WorkShop (formerly Sparcworks)
                         development environment.
 --with-socks            Compile with support for SOCKS (an Internet proxy).
---with-database=TYPE (*) Compile with database support.  Valid types are
-                        `no' or a comma-separated list of one or more
-                        of `berkdb' and either `dbm' or `gnudbm'.
---with-sound=native (*) Compile with native sound support.
---with-sound=nas        Compile with network sound support.
---with-sound=both       Compile with native and network sound support.
---native-sound-lib=LIB  Native sound support library.  Needed on Suns
-                        with --with-sound=both because both sound libraries
-                        are called libaudio.
---with-pop              support POP for mail retrieval
---with-kerberos         support Kerberos-authenticated POP
---with-hesiod           support Hesiod to get the POP server host
 --with-dnet (*)         Compile with support for DECnet.
---with-ldap (*)         Compile with support for the LDAP protocol (requires
-                        installed LDAP libraries on the system).
---mail-locking=TYPE (*) Specify the locking to be used by movemail to prevent
-                        concurrent updates of mail spool files. Valid types
-                        are `lockf', `flock', and `file'.
---with-modules         Compile in experimental support for dynamically
-                       loaded libraries (Dynamic Shared Objects).
+--with-modules (*)      Compile in experimental support for dynamically
+                        loaded libraries (Dynamic Shared Objects).
+--with-netinstall       Compile in support for installation over the internet.
+                        Only functional on the MS Windows platforms.
+--with-ipv6-cname=yes   Try IPv6 information first when canonicalizing host
+                        names.  This option has no effect unless system
+                        supports getaddrinfo(3) and getnameinfo(3).
 --with-site-lisp=yes    Allow for a site-lisp directory in the XEmacs hierarchy
                         searched before the installation packages.
 --with-site-modules=no  Disable site-modules directory in the XEmacs hierarchy,
@@ -159,6 +197,14 @@ Additional features:
                         and localdir files in case run-time searching
                         for them fails.
 --moduledir=DIR         Directory to install dynamic modules in.
+--pdump                 New, experimental, don't-sue-me-if-your-house-
+                        collapses-and-your-wife-leaves-you, portable dumper.
+--with-file-coding      Allows transparent use of "foreign" line break
+                        conventions in text files (such as LF-delimited text
+                        imported from a Unix system to a Windows environment),
+                        optionally including autodetection.  Defaults to ON
+                        on Windows, OFF on Unix.
+
 
 Internationalization options:
 
@@ -175,15 +221,14 @@ Internationalization options:
                         on Solaris and the XmIm* routines are detected.
 --with-canna (*)        Compile with support for Canna (a Japanese input method
                         used in conjunction with Mule support).
---with-wnn (*)          Compile with support for WNN (a multi-language input
+--with-wnn (*)          Compile with support for Wnn (a multi-language input
                         method used in conjunction with Mule support).
---with-wnn6 (*)         Compile with support for the comercial package WNN
-                        version 6
+--with-wnn6 (*)         Compile with support for the commercial package Wnn6.
 --with-i18n3            Compile with I18N level 3 (support for message
                         translation).  This doesn't currently work.
---with-xfs              Compile with XFontSet support for bilingual menubar.
-                        Can't use this option with --with-xim=motif or xlib.
-                        And should have --with-menubars=lucid.
+--with-xfs              Compile with XFontSet support for internationalized
+                        menubar.  Incompatible with `--with-xim=motif'.
+                        `--with-menubars=lucid' (the default) is desirable.
 
 
 Debugging options:
@@ -203,6 +248,7 @@ Debugging options:
 --no-doc-file           Don't rebuild the DOC file unless it's explicitly
                         deleted.  Only use during development. (It speeds
                         up the compile-run-test cycle.)
+--quick-build           Don't GC when dumping.  Implies --no-doc-file.
 --use-union-type        Enable or disable use of a union, instead of an
                         int, for the fundamental Lisp_Object type; this
                         provides stricter type-checking.  Only works with
@@ -221,12 +267,9 @@ Other options:
 --with-system-malloc    Force use of the system malloc, rather than GNU malloc.
 --with-debug-malloc     Use the debugging malloc package.
 --with-clash-detection  Use lock files to detect multiple edits of the same
-                        file.  The default is to not do clash detection.
---lockdir=DIR           The directory to put clash detection files in, such as
-                        `/var/lock/emacs'.
-                        Defaults to `${statedir}/xemacs/lock'.
+                        file.  The default is to do clash detection.
 
-You may also specify any of the `path' variables found in Makefile.in,
+You may also specify any of the `path' variables found in Makefile.in.in,
 including --bindir, --libdir, --docdir, --lispdir, --sitelispdir,
 --datadir, --infodir, --mandir and so on.  Note that we recommend
 against explicitly setting any of these variables.  See the INSTALL
@@ -236,17 +279,18 @@ If successful, configure leaves its status in config.status.  If
 unsuccessful after disturbing the status quo, it removes config.status.
 
 The configure script also recognizes some environment variables, each
-of which is equivalent to a corresponding configure flag.  A specified
-configure flag always overrides the environment variable.
-
-envvar      configure flag
------       --------------
-CC          --compiler
-CPP         --cpp
-CFLAGS      --cflags
-CPPFLAGS    --cppflags
-LDFLAGS     --ldflags
-LIBS        --libs
-LD_RUN_PATH --site-runtime-libraries
+of which is equivalent to a corresponding configure flag.  Configure
+flags take precedence over environment variables, if both are specified.
+
+environment   corresponding
+variable      configure flag
+-----------   --------------
+CC            --compiler
+CPP           --cpp
+CFLAGS        --cflags
+CPPFLAGS      --cppflags
+LDFLAGS       --ldflags
+LIBS          --libs
+LD_RUN_PATH   --site-runtime-libraries
 
 For more details on the install process, consult the INSTALL file.