[AC21.5] Minor improvements to INSTALL

APPROVE COMMIT 21.5 This patch adds a description of the --with-modules option and its relevance to distro maintainers, changes a bunch of --enable-foos to --with-foos, and improves (?) the wording of some option descriptions. Index: ChangeLog =================================================================== RCS file: /pack/xemacscvs/XEmacs/xemacs/ChangeLog,v retrieving revision 1.465 diff -u -U0 -r1.465 ChangeLog --- ChangeLog 26 Oct 2005 15:13:17 -0000 1.465 +++ ChangeLog 7 Nov 2005 07:36:14 -0000 ＠＠ -0,0 +1,4 ＠＠ +2005-11-07 Stephen J. Turnbull <stephen(a)xemacs.org&gt; + + * INSTALL: Various minor improvements. + --- INSTALL 24 Oct 2005 20:39:38 -0000 1.44 +++ INSTALL 7 Nov 2005 07:36:41 -0000 ＠＠ -16,8 +16,6 ＠＠ and that any new or changed statements about the activities of the Free Software Foundation are approved by the Foundation. -Last modified by Stephen J. Turnbull <stephen(a)xemacs.org&gt; 2003-02-12 - BUILDING AND INSTALLATION FOR UNIX AND CYGWIN (for Microsoft Windows, see nt/README also.) ＠＠ -205,22 +208,36 ＠＠ The `--with-cflags-warning=FLAGS' option specifies the warnings to be generated. There is normally no reason to use this flag, as XEmacs -turns on as many warnings as possible, and is still expected to build -with no, or at most a few warnings. +turns on as many warnings as possible, and is still intended to build +with no warnings. If you get any undocumented warnings, please report +them as bugs---they very often are, or at least indicate possible +bitrot. The `--with-cflags-optimization=FLAGS' option specifies the -optimizations to be used. There is normally no reason to use this flag, -as XEmacs will already set the maximum safe -optimization flags appropriate for the compiler being invoked. +optimizations to be used. There is normally no reason to use this +flag, as XEmacs will already set the maximum safe optimization flags +appropriate for the compiler being invoked. The `--with-cflags-debugging=FLAGS' option specifies debugging -information to be generated. There is normally no reason to use this -flag, as XEmacs will include debugging information whenever possible -(i.e. unless optimization is turned on and the compiler does not permit -debugging and optimization simultaneously). - -The `--with-dynamic' option specifies that configure should try to link -emacs dynamically rather than statically. +information to be generated. You should avoid using this flag, as it +makes most severe or fatal bugs hard-to-impossible to diagnose and +fix. Debugging information does not slow down XEmacs at runtime, and +it doesn't make the binary very much bigger. + +The `--with-dynamic' option specifies that configure should try to +link XEmacs dynamically rather than statically. `--with-static' +specifies the reverse. XEmacs's configure script detects whether +dynamic linking can be done on all platforms we know of; these options +are normally unnecessary. + +The `--with-modules' option specifies that XEmacs be built with +support for runtime loadable modules. NOTE TO OEMS: XEmacs can be +distributed configured to support several options based on external +APIs (currently LDAP, PostgreSQL, and Canna) as loadable modules. You +can distribute an XEmacs binary package with these options enabled +without depending on the external package. XEmacs will fail +gracefully at runtime, issuing an error message indicating that the +required support was not found on the system. You can build XEmacs for several different machine types from a single source directory. To do this, you must use a version of `make' that ＠＠ -275,27 +292,27 ＠＠ The `--without-xmu' option can be used if your vendor doesn't ship the Xmu library. -The `--enable-menubars=TYPE' option allows you to specify which X +The `--with-menubars=TYPE' option allows you to specify which X toolkit you wish to use for the menubar. The valid options are `lucid', `motif' and `no'. The default is `lucid' which is a Motif-lookalike menubar. We highly recommend its usage over the real Motif menubar. (In fact, the Motif menubar is currently broken.) If `no' is specified then support for menubars will not be compiled in. -The `--enable-scrollbars=TYPE' option allows you to specify which X +The `--with-scrollbars=TYPE' option allows you to specify which X toolkit you wish to use for the scrollbars. The valid options are `lucid', `motif', `athena', `athena3d', and `no'. The default is `lucid' which is a Motif-lookalike scrollbar. If `no' is specified then support for scrollbars will not be compiled in. -The `--enable-dialogs=TYPE' option allows you to specify which X toolkit +The `--with-dialogs=TYPE' option allows you to specify which X toolkit you wish to use for the dialog boxes. The valid options are `athena', `athena3d', `motif, and `no. The `lucid' option is accepted and will result in the `athena' toolkit being used. If the Motif toolkit can be found the default is `motif'. Otherwise, the default is `athena'. If `no' is specified then support for dialog boxes will not be compiled in. -The `--enable-toolbars' option allows you to enable or disable toolbar +The `--with-toolbars' option allows you to enable or disable toolbar support. The default is `yes' if support for a windowing system is included. ＠＠ -307,38 +324,41 ＠＠ X-Faces. `configure' will attempt to detect if you have the compface library and define `--with-xface' for you. -The `--enable-database' option specifies that XEmacs should be built +The `--with-database' option specifies that XEmacs should be built with simple database support. The valid options are `no' or a comma-separated list of one or more of `dbm', `gnudbm' or `berkdb'. `configure' will attempt to detect the necessary libraries and header -files and define `--enable-database' for you. +files and define `--with-database' for you. The `--with-postgresql' option specifies that XEmacs should be built with PostgreSQL support, linking with libpq. `configure' will attempt to detect whether PostgreSQL support is available, and automatically -define `--with-postgresql' for you. +define `--with-postgresql' for you. NOTE TO OEMS: If modules are +supported and enabled, the libpq API support will be build as a +module. The `--with-ldap' option specifies that XEmacs should be build with LDAP support, using the OpenLDAP libraries. `configure' will attempt to detect whether LDAP support is available, and automatically define -`--with-ldap' for you. +`--with-ldap' for you. NOTE TO OEMS: If modules are supported and +enabled, the OpenLDAP API support will be build as a module. The `--with-socks' option specifies that XEmacs should be built with SOCKS support. This requires the libsocks library. -The `--enable-external-widget' option specifies that XEmacs should be +The `--with-external-widget' option specifies that XEmacs should be built with support for being used as a widget by other X11 applications. This functionality should be considered beta. -The `--enable-sound=TYPE' option specifies that XEmacs should be built -with sound support. Native (`--enable-sound=native') sound support is +The `--with-sound=TYPE' option specifies that XEmacs should be built +with sound support. Native (`--with-sound=native') sound support is currently available only on Sun SparcStations, SGI's, HP9000s, and systems (such as Linux) with soundcard.h. Network Audio Support (NAS) -(`--enable-sound=nas') is an extension to X that you may or may not have +(`--with-sound=nas') is an extension to X that you may or may not have for your system. For NAS, you will probably need to provide the paths to the nas include and library directories to configure. If -`--enable-sound' is not specified, `configure' will attempt to determine -if your configuration supports native sound and define --enable-sound +`--with-sound' is not specified, `configure' will attempt to determine +if your configuration supports native sound and define --with-sound for you. If your native sound library is not in a standard location you can specify it with the `--with-native-sound-lib=LIB' flag. For Linux, `/dev/audio' is required for SunAudio files and `/dev/dsp' is required ＠＠ -368,7 +388,7 ＠＠ Internationalization Options ---------------------------- -The `--enable-mule' option enables MUlti-Lingual Emacs (Mule) support, +The `--with-mule' option enables MUlti-Lingual Emacs (Mule) support, needed to support non-Latin-1 (including Asian) languages. Mule support is required for Asian language and Unicode (multibyte and wide character) support. With the advent of the Euro and European ＠＠ -409,7 +429,8 ＠＠ it, so you never need to explicitly use this option unless your Canna libraries are somewhere strange. Canna run time support is currently bundled with the `mule-base' package so there is nothing additional to -install in order to use it. +install in order to use it. NOTE TO OEMS: If modules are supported +and enabled, the libcanna API support will be build as a module. The `--with-wnn' and `--with-wnn6' options are for compiling with the Wnn multi-language input method. `--with-wnn' is for compiling with Wnn-4.2, -- School of Systems and Information Engineering http://turnbull.sk.tsukuba.ac.jp University of Tsukuba Tennodai 1-1-1 Tsukuba 305-8573 JAPAN Ask not how you can "do" free software business; ask what your business can "do for" free software.