xemacs-beta: INSTALL annotate

annotate INSTALL @ 5853:1044acf60048

Revert part of Jerry's December 2014 that broke gnuclient on some OS X. lib-src/ChangeLog addition: 2015-03-08 Aidan Kehoe <kehoea@parhasard.net> * gnuserv.c (echo_request): No longer close the file handle unconditionally, leave this to the individual socket types. * gnuserv.c (handle_internet_request): Close the file handle here. * gnuserv.c (handle_unix_request): Don't close the file handle here, document why (it broke gnuclient under OS X). It should actually be OK, but my suspicion is that the issues is that the Unix (local) domain sockets are still underdocumented compared to the internet sockets.

author	Aidan Kehoe <kehoea@parhasard.net>
date	Sun, 08 Mar 2015 20:59:25 +0000
parents	9c17f7be0b92
children

rev	line source
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	1 XEmacs Installation Guide
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	2
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	3 Copyright (c) 1994-1996 Board of Trustees, University of Illinois
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	4 Copyright (c) 1994-1999, 2003, 2008, 2012 Free Software Foundation, Inc.
412 697ef44129c6 Import from CVS: tag r21-2-14 cvs parents: 410 diff changeset	5
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	6 Permission is granted to anyone to make or distribute verbatim copies
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	7 of this document as received, in any medium, provided that the
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	8 copyright notice and permission notice are preserved,
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	9 and that the distributor grants the recipient permission
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	10 for further redistribution as permitted by this notice.
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	11
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	12 Permission is granted to distribute modified versions
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	13 of this document, or of portions of it,
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	14 under the above conditions, provided also that they
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	15 carry prominent notices stating who last changed them,
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	16 and that any new or changed statements about the activities
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	17 of the Free Software Foundation are approved by the Foundation.
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	18
442 abe6d1db359e Import from CVS: tag r21-2-36 cvs parents: 426 diff changeset	19 BUILDING AND INSTALLATION FOR UNIX AND CYGWIN
abe6d1db359e Import from CVS: tag r21-2-36 cvs parents: 426 diff changeset	20
abe6d1db359e Import from CVS: tag r21-2-36 cvs parents: 426 diff changeset	21 (for Microsoft Windows, see nt/README also.)
abe6d1db359e Import from CVS: tag r21-2-36 cvs parents: 426 diff changeset	22
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	23 This file is in the process of revision. Some random information that didn't
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	24 fit elsewhere is appended to the end of the file.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	25
442 abe6d1db359e Import from CVS: tag r21-2-36 cvs parents: 426 diff changeset	26 PREREQUISITES
abe6d1db359e Import from CVS: tag r21-2-36 cvs parents: 426 diff changeset	27 =============
404 2f8bb876ab1d Import from CVS: tag r21-2-32 cvs parents: 400 diff changeset	28
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	29 Modern systems generally have more than enough RAM and virtual memory to run
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	30 XEmacs well. If you run into an "insufficient memory" error when building
5704 37b107e878b8 More corrections to INSTALL by Robert Royer. Stephen J. Turnbull <stephen@xemacs.org> parents: 5699 diff changeset	31 or on the first execution, see the 'PROBLEMS' file. Insufficient stack
37b107e878b8 More corrections to INSTALL by Robert Royer. Stephen J. Turnbull <stephen@xemacs.org> parents: 5699 diff changeset	32 space is a separate problem, also addressed in 'PROBLEMS'.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	33
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	34 Building XEmacs requires about 100 Mb of disk space (including the XEmacs
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	35 sources). Once installed, XEmacs occupies about 200 MB in the file system
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	36 where it is installed, including the executable files, Lisp libraries,
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	37 miscellaneous data files, and on-line documentation.
149 538048ae2ab8 Import from CVS: tag r20-3b1 cvs parents: 126 diff changeset	38
2427 97dd9f867cef [xemacs-hg @ 2004-12-07 12:52:30 by malcolmp] malcolmp parents: 2283 diff changeset	39 XEmacs requires an ANSI C compiler, such as GCC. If you wish to build the
5744 9c17f7be0b92 Require makeinfo 4.12 or later to build the info files. See xemacs-beta Jerry James <james@xemacs.org> parents: 5704 diff changeset	40 documentation yourself, you will need at least version 4.12 of makeinfo (GNU
9c17f7be0b92 Require makeinfo 4.12 or later to build the info files. See xemacs-beta Jerry James <james@xemacs.org> parents: 5704 diff changeset	41 texinfo-4.12).
398 74fd4e045ea6 Import from CVS: tag r21-2-29 cvs parents: 392 diff changeset	42
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	43 BASIC INSTALLATION
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	44 ==================
424 11054d720c21 Import from CVS: tag r21-2-20 cvs parents: 420 diff changeset	45
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	46 Since you are reading this, we assume you have already acquired XEmacs in
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	47 source form, and the packages as tarballs. If not, see www.xemacs.org.
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	48
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	49 Building and installing XEmacs from source can be as simple as
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	50
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	51 cd /usr/local/src/xemacs; ./configure; make; make install
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	52
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	53 followed by installing the packages
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	54
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	55 mkdir -p /usr/local/share/xemacs
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	56 cd /usr/local/share/xemacs
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	57 tar xzf /tmp/xemacs-sumo.tar.gz
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	58
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	59 However, this depends on the presence of relevant development resources on
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	60 your system, and there are a few frequently used features that are not built
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	61 in by default. To build XEmacs incorporating such features, the steps
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	62 required are exactly as above, except that you need to start by confirming
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	63 the availability of required libraries and headers, and select them by
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	64 invoking configure with the appropriate options.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	65
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	66 Add-on Libraries
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	67 ----------------
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	68
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	69 A note on terminology: unfortunately the terms "library" and "package" are
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	70 heavily overloaded. In this section, "library" refers to an external body of
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	71 executable code which may be linked with XEmacs at build time to provide
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	72 support for system features, such as images, audio, stream compression,
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	73 databases, and input methods. Libraries must be available when XEmacs is
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	74 built. A "module" is also a dynamically loadable library, but it is built
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	75 from the XEmacs sources, after the XEmacs executable is built.
149 538048ae2ab8 Import from CVS: tag r20-3b1 cvs parents: 126 diff changeset	76
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	77 We assume that your system has a GUI windowing system, specifically X11 (the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	78 X Window System) or Microsoft Windows. XEmacs can also use various toolkits
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	79 and widget kits for X11, including Xt, GTK+/GNOME, and CDE, depending on
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	80 platform. If you don't have a window system installed, XEmacs will be built
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	81 only with terminal support. (For unreleased ports to Qt/KDE and Mac OS X,
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	82 ask on the xemacs-beta@xemacs.org mailing list.)
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	83
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	84 XEmacs can use a large number of additional libraries that are commonly
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	85 available in many operating system distributions. Many are also available as
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	86 open source distributions. These include:
594 fd49b88b9f06 [xemacs-hg @ 2001-05-31 12:47:21 by ben] ben parents: 442 diff changeset	87
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	88 GTK+, GNOME:
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	89 An alternative to the Xt toolkit on X11-based window systems. GNOME
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	90 is the desktop environment usually used with GTK+.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	91 Xaw3d, XawNeXT, XawXPM, Xaw95:
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	92 Variants on the basic Athena widgets, which change the "look and feel"
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	93 of XEmacs built using the Xt toolkit.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	94 Motif, CDE, Tooltalk:
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	95 Mostly useful on Solaris systems (CDE and Tooltalk may be obsolete).
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	96 Motif may be substituted for the Athena widgets on most systems
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	97 supporting X11.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	98 XPM, JPEG, TIFF, PNG, compface:
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	99 Image format libraries. XPM and PNG are almost essential (they are
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	100 used to display parts of the XEmacs GUI).
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	101 zlib:
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	102 Supports gzip compression and decompression.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	103 socks:
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	104 An old system for passing firewalls (may be obsolete).
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	105 GMP, MP:
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	106 Multiple precision arithmetic libraries ("bignums") from GNU and BSD.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	107 curses, ncurses, termcap:
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	108 Character-based terminal support.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	109 ALSA, OSS, ESD, NAS:
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	110 Various systems for audio output.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	111 Canna, SJ3, Wnn:
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	112 Input systems for Japanese. (XEmacs accesses these libraries directly
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	113 rather than through more modern protocols such ibus and IIIMF. XEmacs
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	114 can use XIM, but that is now considered obsolete.)
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	115 Databases:
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	116 GNU DBM, Berkeley DB, PostgreSQL, LDAP.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	117
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	118 WARNING: In many distributions, you may have the necessary libraries
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	119 installed, but not the "header files" which provide the APIs used by XEmacs
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	120 to link to the libraries. Such distributions provide additional packages,
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	121 usually given names ending in "-dev" or "-devel", to supply the header files.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	122
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	123 XEmacs looks only in the default system directories for header files and
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	124 libraries. This will be sufficient unless you have built and installed
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	125 libraries yourself, or you use an add-on package manager like MacPorts on Mac
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	126 OS X. In this case you will need to supply the "--with-site-prefixes"
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	127 option, setting it to the root of the installation of such packages. Eg, the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	128 most common setting is "--with-site-prefixes=/usr/local", which tells the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	129 build process to search for headers in "/usr/local/include" for libraries
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	130 under "/usr/local/lib". (Use a colon to separate multiple directories.)
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	131
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	132 If you need help installing additional libraries and header files, the best
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	133 resource is the help channels for your OS distribution. If that doesn't
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	134 help, or you think you have the right files installed but the built XEmacs
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	135 doesn't seem to have all the corresponding features, check with the newsgroup
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	136 'comp.emacs.xemacs' or the mailing list 'xemacs-beta@xemacs.org'.
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	137
5704 37b107e878b8 More corrections to INSTALL by Robert Royer. Stephen J. Turnbull <stephen@xemacs.org> parents: 5699 diff changeset	138 SELECTING CONFIGURE OPTIONS
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	139 ===========================
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	140
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	141 Options are generally of the form `--with-FEATURE' to use a feature or
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	142 `--without-FEATURE' to not use a feature. (Unlike the `configure' program
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	143 used in other applications, either `--with-FEATURE' or `--enable-FEATURE' can
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	144 be used to enable the same feature.)
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	145
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	146 To get a long list of options and usage for the `configure' script, use
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	147 `./configure --help' (piped to less if you prefer that to scrolling your
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	148 terminal).
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	149
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	150 Each option's explanation says what its default is. For Boolean options, the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	151 default may be "yes", "no", or "auto". If the default is "no", the feature
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	152 will not be included, and if any option that depends on it is enabled,
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	153 configure will fail with a fatal error. If the default is "yes", the feature
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	154 will be included, and configure will fail with a fatal error if any required
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	155 headers or libraries cannot be found. If the default is "auto", the feature
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	156 will be included if configure can find the needed headers and libraries.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	157
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	158 Even if a feature's default is "auto", it is useful to explicitly request its
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	159 configuration. If the necessary headers or libraries aren't found, configure
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	160 will fail loudly instead of silently configuring an XEmacs without your
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	161 favorite features.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	162
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	163 Configuring the Installation Locations
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	164 --------------------------------------
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	165
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	166 Often the default location for the XEmacs installation ("/usr/local") is
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	167 appropriate. If you prefer to put the installation somewhere else, use the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	168 `--prefix' option, such as `--prefix=/opt/local/xemacs'.
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	169
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	170 As of late 2011, XEmacs is transitioning from the traditional "$prefix/lib"
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	171 location to the FHS-conforming location "$prefix/share" for packages. If you
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	172 already have packages installed under, say, "/usr/local/lib" and would prefer
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	173 not to move them, use `--with-system-packages=/usr/local/lib/xemacs'. (The
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	174 value of this option should be the name of the directory containing the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	175 "xemacs-packages", "mule-packages", and/or "site-packages" hierarchies.)
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	176
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	177 The standard configuration of XEmacs builds in absolute paths for its various
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	178 support files. It is possible to make the XEmacs installation relocatable by
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	179 using the option `--without-prefix'. Then all paths are computed at runtime
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	180 relative to the "bin" directory where the XEmacs executable is located.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	181
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	182 There are a plethora of additional options for controlling exactly where
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	183 different parts of XEmacs are installed. We strongly recommend sticking
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	184 with the standard layout, except as just described. If you want to
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	185 experiment, these additional configure options are described in a later
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	186 section.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	187
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	188 Internationalization Options
314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	189 ----------------------------
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	190
3050 67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	191 The `--with-mule' option enables MUlti-Lingual Emacs (Mule) support,
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	192 needed to support non-Latin-1 (including Asian) languages. Mule
314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	193 support is required for Asian language and Unicode (multibyte and wide
314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	194 character) support. With the advent of the Euro and European
314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	195 Community expansion, Mule support is also recommended for Western
314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	196 Europeans. Enabling Mule support requires the mule-base package
314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	197 installed prior to building XEmacs. The `--with-xim', --with-xfs',
314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	198 `--with-canna', `--with-wnn' and `--with-wnn6' options require
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	199 Mule support. (Default: no.)
243 f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	200
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	201 The `--with-canna' option enables the use of the Canna Japanese input method.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	202 This is stable code and fairly well tested. In order to use it, you will
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	203 have to have the Canna server installed and running. Canna versions 3.2pl2,
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	204 3.5b2, and 3.7p3 are known to work. Version 3.2pl2 is considered more stable
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	205 than version 3.5b2; the stability of 3.7p3 is still unknown. If Canna is
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	206 already installed, configure will autodetect it, so you never need to
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	207 explicitly use this option unless your Canna libraries are somewhere strange.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	208 Canna run time support is currently bundled with the `mule-base' package so
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	209 there is nothing additional to install in order to use it. NOTE TO OEMS: If
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	210 modules are supported and enabled, the libcanna API support will be build as
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	211 a module. (Default: no.)
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	212
243 f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	213 The `--with-wnn' and `--with-wnn6' options are for compiling with the Wnn
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	214 multi-language input method. `--with-wnn' is for compiling with Wnn-4.2, the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	215 Free version of WNN. `--with-wnn6' is for compiling against WNN6, the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	216 commercial version of WNN available from OMRON Corporation. This is stable
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	217 code and fairly well tested. In order to build with this option, you will
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	218 need to have the `egg-its' lisp package already installed. (Default: no.)
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	219
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	220 The `--with-xim' option enables use of the X11 XIM mechanism to allow an
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	221 input method to input text into XEmacs. The input method is shared among all
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	222 the X applications sharing an X display and using the same language. The XIM
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	223 support comes in two flavors: `motif' and `xlib'. The Motif support (the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	224 XmIm* functions) is preferred when available. The XIM support defaults to
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	225 `no' except when Motif is detected where it is stable with OSF libraries.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	226 The XIM support in Lesstif (a Free Motif replacement) does not work as of
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	227 v0.82. If you enable this option, you will probably wish to install the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	228 `locale' package which contains localized Splash screens and Menubars.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	229
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	230 (This option is deprecated and will be removed.) The `--with-xfs' option
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	231 enables use of a multilingual Menubar. At the present time, only Japanese
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	232 and French locales are supported. In order to use a multilingual Menubar you
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	233 must have the `locale' package installed. The `locale' package does not have
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	234 to be installed when building XEmacs. (Default: no.)
243 f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	235
f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	236 Please note that it is safe to build with as many of the options
f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	237 `--with-xim', `--with-canna' and `--with-wnn' as your system
f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	238 supports.
104 cf808b4c4290 Import from CVS: tag r20-1b4 cvs parents: 70 diff changeset	239
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	240 Configuring the Window System
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	241 -----------------------------
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	242
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	243 If you prefer the GTK+ look and feel to Xt, specify `--with-gtk'. You can
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	244 also enable support for some GNOME desktop features with `--with-gnome'. You
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	245 cannot use both GTK+ and Xt at the same time.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	246
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	247 If you don't want X Window System support at all, specify `--without-x'. If
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	248 you omit this option, `configure' will try to autodetect whether your system
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	249 has X Window System support, and arrange to use it if present.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	250
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	251 On Cygwin, you can configure support for the "native" MS Windows GUI with
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	252 `--with-msw'. XEmacs supports both `--with-msw' and `--with-x' at the same
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	253 time.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	254
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	255 The `--with-menubars=TYPE' option allows you to specify which X
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	256 toolkit you wish to use for the menubar. The valid options are
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	257 `lucid', `motif' and `no'. The default is `lucid' which is a
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	258 Motif-lookalike menubar. We highly recommend its usage over the real
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	259 Motif menubar. (In fact, the Motif menubar is currently broken.) If
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	260 `no' is specified then support for menubars will not be compiled in.
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	261
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	262 The `--with-scrollbars=TYPE' option allows you to specify which X toolkit you
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	263 wish to use for the scrollbars. The valid options are `lucid', `motif',
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	264 `athena', and `no'. The default is `lucid' which is a Motif-lookalike
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	265 scrollbar. If `no' is specified then support for scrollbars will not be
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	266 compiled in.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	267
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	268 The `--with-dialogs=TYPE' option allows you to specify which X toolkit you
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	269 wish to use for the dialog boxes. The valid options are `athena', `motif,
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	270 and `no. The `lucid' option is accepted and will result in the `athena'
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	271 toolkit being used. If the Motif toolkit can be found the default is
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	272 `motif'. Otherwise, the default is `athena'. If `no' is specified then
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	273 support for dialog boxes will not be compiled in.
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	274
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	275 The `--with-toolbars' option allows you to enable or disable toolbar
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	276 support. The default is `yes' if support for a windowing system is
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	277 included.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	278
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	279 The `--with-dragndrop' option compiles in the generic drag and drop API.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	280 This is automatically added if one of the drag and drop protocols is found
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	281 (currently CDE, MSWindows, and GTK). WARNING The Drag'n'drop support is
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	282 under development and is considered experimental.
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	283
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	284 Miscellaneous Features
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	285 ----------------------
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	286
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	287 The `--with-xpm' option specifies that XEmacs should support X11
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	288 Pixmaps. (Default: auto.)
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	289
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	290 The `--with-xface' option specifies that XEmacs should support
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	291 X-Faces. (Default: auto.)
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	292
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	293 The `--with-database' option specifies that XEmacs should be built with
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	294 simple database support. The valid options are `no' or a comma-separated
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	295 list of one or more of `dbm', `gnudbm' or `berkdb'. (Default: auto.)
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	296
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	297 The `--with-postgresql' option specifies that XEmacs should be built with
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	298 PostgreSQL support, linking with libpq. (Default: auto.) NOTE TO OEMS: If
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	299 modules are enabled, the libpq API support will be build as a module.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	300
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	301 The `--with-ldap' option specifies that XEmacs should be build with LDAP
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	302 support, using the OpenLDAP libraries. (Default: auto.) NOTE TO OEMS: If
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	303 modules are enabled, the OpenLDAP API support will be build as a module.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	304
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	305 The `--with-socks' option specifies that XEmacs should be built with
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	306 SOCKS support. This requires the libsocks library. (Default: no.)
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	307
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	308 The `--with-sound=TYPE' option specifies that XEmacs should be built with
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	309 sound support. Native (`--with-sound=native') sound support is currently
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	310 available only on Sun SparcStations, SGI's, HP9000s, and systems (such as
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	311 Linux) with soundcard.h. Network Audio Support (NAS) (`--with-sound=nas') is
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	312 an extension to X that you may or may not have for your system. For NAS, you
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	313 will probably need to provide the paths to the nas include and library
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	314 directories to configure. ESD ("Enlightened Sound Daemon")
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	315 (`--with-sound=esd') is a third-party library which interacts with a special
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	316 sound daemon. If `--with-sound' is not specified, `configure' will attempt
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	317 to determine if your configuration supports native sound and define
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	318 --with-sound for you. If your native sound library is not in a standard
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	319 location you can specify it with the `--with-native-sound-lib=LIB' flag. For
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	320 Linux, `/dev/audio' is required for SunAudio files and `/dev/dsp' is required
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	321 for raw data and WAVE format files. You may specify as many sound types as
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	322 your system supports, separated by commas: `--with-sound=nas,native'.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	323 (Default: auto.)
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	324
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	325 The `--with-tty' option enables TTY support. (Default: yes.)
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	326
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	327 The `--with-ncurses' options specifies use of the ncurses library for tty
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	328 support. (Default: auto.)
442 abe6d1db359e Import from CVS: tag r21-2-36 cvs parents: 426 diff changeset	329
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	330 The `--with-gpm' option compiles in GPM mouse support for ttys. (Default:
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	331 no.)
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	332
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	333 The `--with-external-widget' option specifies that XEmacs should be
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	334 built with support for being used as a widget by other X11 applications.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	335 This functionality should be considered beta. (Default: no.)
845 77624ff6e2da [xemacs-hg @ 2002-05-16 15:11:22 by stephent] stephent parents: 594 diff changeset	336
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	337 The `--with-tooltalk' option specifies that XEmacs should be built
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	338 with ToolTalk support for interconnecting with other applications.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	339 ToolTalk is not yet supported on all architectures. If you use this
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	340 option, you should have the tooltalk package (see etc/PACKAGES)
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	341 installed prior to building XEmacs. (Default: no.)
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	342
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	343 The `--with-sparcworks' option specifies that XEmacs should be built
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	344 with support for Sun Sparcworks 3.0.1 and up (including Sun WorkShop).
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	345 This functionality is only of use on SunOS 4.1.x and Solaris 2.x
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	346 systems. If you use this option, you should have the Sun package (see
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	347 etc/PACKAGES) installed prior to building XEmacs. (Default: no.)
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	348
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	349 The `--with-cde' option allows you to enable or disable CDE drag and
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	350 drop support. `configure' will attempt to detect this option and
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	351 define `--with-cde' for you. (Default: no.)
442 abe6d1db359e Import from CVS: tag r21-2-36 cvs parents: 426 diff changeset	352
abe6d1db359e Import from CVS: tag r21-2-36 cvs parents: 426 diff changeset	353 RUNNING CONFIGURE
abe6d1db359e Import from CVS: tag r21-2-36 cvs parents: 426 diff changeset	354 =================
abe6d1db359e Import from CVS: tag r21-2-36 cvs parents: 426 diff changeset	355
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	356 `configure' doesn't do any compilation or installation itself. It just
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	357 creates the files that influence those things: `./src/config.h', and all the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	358 Makefiles in the build tree.
442 abe6d1db359e Import from CVS: tag r21-2-36 cvs parents: 426 diff changeset	359
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	360 XEmacs supports the implicit --srcdir option to allow building outside of the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	361 source tree. This is recommended; it only requires adding a single build
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	362 directory, cd'ing there, and invoking configure:
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	363
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	364 mkdir +build
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	365 cd +build
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	366 ../configure [--OPTION[=VALUE]] ...
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	367
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	368 If you want to build in the source tree for some reason, cd to the top level
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	369 directory of the XEmacs distribution, and run the program `configure' as
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	370 follows:
371 cc15677e0335 Import from CVS: tag r21-2b1 cvs parents: 367 diff changeset	371
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	372 ./configure [--OPTION[=VALUE]] ...
442 abe6d1db359e Import from CVS: tag r21-2-36 cvs parents: 426 diff changeset	373
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	374 When it is done, `configure' prints a description of what it did and creates
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	375 a shell script `config.status' which, when run, recreates the same
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	376 configuration. If `configure' exits with an error after disturbing the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	377 status quo, it removes `config.status'. If `configure' doesn't work as
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	378 expected, the file `config.log' contains details of the tests run and their
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	379 results.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	380
442 abe6d1db359e Import from CVS: tag r21-2-36 cvs parents: 426 diff changeset	381 RUNNING MAKE
abe6d1db359e Import from CVS: tag r21-2-36 cvs parents: 426 diff changeset	382 ============
abe6d1db359e Import from CVS: tag r21-2-36 cvs parents: 426 diff changeset	383
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	384 `configure' also creates an `Installation' file in the top directory of the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	385 build tree. Do read this file before running `make'! It's not very long.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	386 You can save much grief by checking that expected features are listed there.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	387
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	388 Run `make' in the top directory of the XEmacs distribution to finish building
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	389 XEmacs in the standard way. The final executable file is named `src/xemacs'.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	390 You can execute this file in place without copying it, if you wish; then it
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	391 automatically uses the sibling directories ../lisp, ../lib-src, ../info.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	392
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	393 Or you can install the executable and the other XEmacs into their permanent
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	394 locations, with `make install'. By default, XEmacs's files are installed in
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	395 the following directories:
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	396
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	397 `/usr/local/bin' holds the executable programs users normally run -
388 aabb7f5b1c81 Import from CVS: tag r21-2-9 cvs parents: 380 diff changeset	398 `xemacs', `etags', `ctags', `b2m', `emacsclient', `ellcc',
4782 1523f1d28be1 Remove more obsolete files. See xemacs-patches message with ID Jerry James <james@xemacs.org> parents: 4769 diff changeset	399 `gnuclient', `gnudoit', and `gnuattach'.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	400
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	401 `/usr/local/share/xemacs-VERSION/lisp' holds the basic Emacs Lisp libraries
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	402 (including core implementations of many Lisp primitives);
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	403 `VERSION' stands for the number of the XEmacs version
5704 37b107e878b8 More corrections to INSTALL by Robert Royer. Stephen J. Turnbull <stephen@xemacs.org> parents: 5699 diff changeset	404 you are installing, like `21.4.22' or `21.5-b32'. Since
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	405 the lisp libraries change from one version of XEmacs to
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	406 another, including the version number in the path
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	407 allows you to have several versions of XEmacs installed
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	408 at the same time; this means that you don't have to
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	409 make XEmacs unavailable while installing a new version.
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	410
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	411 `/usr/local/share/xemacs/xemacs-packages'
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	412 `/usr/local/share/xemacs/mule-packages'
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	413 `/usr/local/share/xemacs/site-packages'
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	414 XEmacs searches for "packaged" Emacs Lisp applications or
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	415 extensions and their support files in these hierarchies.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	416 Each hierarchy has its own set of lisp, etc, info, lib-src,
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	417 and pkginfo subdirectories. The pkginfo subdirectory
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	418 contains "MANIFEST" files used when installing or removing
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	419 packages. Each of the others has the same purpose as the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	420 similarly-named directory for "core XEmacs".
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	421
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	422 `/usr/local/share/xemacs/site-lisp'
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	423 A last-resort location for Lisp files (optional).
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	424
5150 0353d546dc1e Reflect change from `lib' to `share' in INSTALL. Mike Sperber <sperber@deinprogramm.de> parents: 4842 diff changeset	425 `/usr/local/share/xemacs-VERSION/etc' holds the XEmacs tutorial, the
4785 d6cfba1cc388 Remove the lib-src/yow binary, which is currently unused anyway. See message Jerry James <james@xemacs.org> parents: 4782 diff changeset	426 Unicode database, and other architecture-independent
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	427 files XEmacs might need while running. VERSION is as
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	428 specified for `.../lisp'.
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	429
5150 0353d546dc1e Reflect change from `lib' to `share' in INSTALL. Mike Sperber <sperber@deinprogramm.de> parents: 4842 diff changeset	430 `/usr/local/share/xemacs/lock' contains files indicating who is
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	431 editing what, so XEmacs can detect editing clashes
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	432 between users.
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	433
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	434 `/usr/local/lib/xemacs-VERSION/CONFIGURATION-NAME' contains executable
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	435 programs used by XEmacs that users are not expected to
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	436 run themselves, and the DOC file. `VERSION' is the
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	437 number of the XEmacs version you are installing, and
243 f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	438 `CONFIGURATION-NAME' is the host type of your system.
f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	439 Since these files are specific to the version of
f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	440 XEmacs, operating system, and architecture in use,
f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	441 including the configuration name in the path allows
f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	442 you to have several versions of XEmacs for any mix of
f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	443 machines and operating systems installed at the same
f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	444 time; this is useful for sites at which different
f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	445 kinds of machines share the file system XEmacs is
f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	446 installed on.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	447
388 aabb7f5b1c81 Import from CVS: tag r21-2-9 cvs parents: 380 diff changeset	448 `/usr/local/lib/xemacs-VERSION/CONFIGURATION-NAME/modules' holds the Emacs
aabb7f5b1c81 Import from CVS: tag r21-2-9 cvs parents: 380 diff changeset	449 dynamically loadable modules. These are special programs
aabb7f5b1c81 Import from CVS: tag r21-2-9 cvs parents: 380 diff changeset	450 typically written in C that can be loaded in much the same
aabb7f5b1c81 Import from CVS: tag r21-2-9 cvs parents: 380 diff changeset	451 way that Lisp packages are. Not all systems support
aabb7f5b1c81 Import from CVS: tag r21-2-9 cvs parents: 380 diff changeset	452 dynamic modules, so do not be alarmed if this directory
aabb7f5b1c81 Import from CVS: tag r21-2-9 cvs parents: 380 diff changeset	453 does not exist or is empty.
aabb7f5b1c81 Import from CVS: tag r21-2-9 cvs parents: 380 diff changeset	454
aabb7f5b1c81 Import from CVS: tag r21-2-9 cvs parents: 380 diff changeset	455 XEmacs searches for modules in this directory, or any
aabb7f5b1c81 Import from CVS: tag r21-2-9 cvs parents: 380 diff changeset	456 sub-directory of it, and then in
aabb7f5b1c81 Import from CVS: tag r21-2-9 cvs parents: 380 diff changeset	457 `/usr/local/lib/xemacs/site-modules/*'.
aabb7f5b1c81 Import from CVS: tag r21-2-9 cvs parents: 380 diff changeset	458
5150 0353d546dc1e Reflect change from `lib' to `share' in INSTALL. Mike Sperber <sperber@deinprogramm.de> parents: 4842 diff changeset	459 `/usr/local/share/xemacs-VERSION/info' holds the on-line documentation
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	460 for XEmacs, known as "info files".
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	461
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	462 `/usr/local/man/man1' holds the man pages for the programs installed
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	463 in `/usr/local/bin'.
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	464
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	465 If you have specified the `--prefix' option, it will replace "/usr/local"
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	466 in the locations above.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	467
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	468 STRIPPING BINARIES
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	469 ==================
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	470
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	471 This saves nothing but a small (by modern standards) amount of disk space;
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	472 the symbol table is not loaded into memory at execution time. If you do
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	473 encounter a crash or other serious bug, the first thing the developers will
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	474 do is ask you to build an XEmacs with a full symbol table, anyway. Don't
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	475 strip the XEmacs binary.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	476
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	477 MAIL-LOCKING POST-INSTALLATION
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	478 ==============================
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	479
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	480 If your system uses dot-locking to interlock access to mailer inbox files,
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	481 then you might need to make the movemail program setuid or setgid to enable
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	482 it to write the lock files. We believe this is not a security hole. The
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	483 setuid/setgid bits need not be set on any other XEmacs-related executables.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	484
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	485 CLEANING UP
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	486 ==========
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	487
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	488 You are done with the hard part! You can remove executables and object files
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	489 from the build directory by typing `make clean'. To also remove the files
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	490 that `configure' created (so you can compile XEmacs for a different
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	491 configuration), type `make distclean'.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	492
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	493 READ THE FAQ
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	494 ============
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	495
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	496 Do it!
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	497
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	498 PROBLEMS
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	499 ========
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	500
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	501 The most common problem is that you forgot to read and follow the directions
5704 37b107e878b8 More corrections to INSTALL by Robert Royer. Stephen J. Turnbull <stephen@xemacs.org> parents: 5699 diff changeset	502 for installing bootstrap packages in the FAQ. You cannot have a normal
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	503 XEmacs without downloading some additional packages.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	504
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	505 See the file PROBLEMS in this directory for a list of various problems
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	506 sometimes encountered, and what to do about them. PROBLEMS is also the place
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	507 where platform-specific build notes can be found.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	508
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	509 ADVANCED CONFIGURATION
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	510 ======================
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	511
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	512 There are a large number of options to configure that can be used to control
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	513 the build and installation process. These are primarily of interest to
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	514 developers and OEMs.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	515
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	516 Controlling the Host Type
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	517 -------------------------
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	518
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	519 Almost always, you should let `configure' (actually the shell script
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	520 `config.guess') guess your host type, by omitting the CONFIGURATION-NAME
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	521 argument. If you like to experiment, specify a configuration name in the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	522 form MACHINE-VENDOR-OPSYS, for example:
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	523
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	524 sparc-sun-solaris2.6
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	525
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	526 using the command form
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	527
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	528 ./configure [CONFIGURATION-NAME] [--OPTION[=VALUE]] ...
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	529
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	530 See config.guess and configure.ac for valid values for MACHINE, VENDOR, and
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	531 OPSYS. Also check `./etc/MACHINES' for advice on building on particular
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	532 machines.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	533
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	534 Specifying Location of Headers and Libraries
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	535 --------------------------------------------
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	536
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	537 The `--with-site-includes=DIR' and `--with-site-libraries=DIR' options allow
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	538 you to specify additional places the compiler should look for include files
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	539 and object libraries. You may specify multiple DIR's by enclosing the list
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	540 in quotes. All the external libraries you want to use with XEmacs (e.g. xpm,
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	541 wnn, ...) described later should have their include and library directories
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	542 defined using these options.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	543
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	544 The `--with-site-runtime-libraries=DIR' option specifies directories to
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	545 search for shared libraries at run time. If you use this option, you must
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	546 specify ALL of the directories containing shared libraries at run time,
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	547 including system directories. Please read the information about "ADD-ON
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	548 LIBRARIES" above very carefully.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	549
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	550 The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build process
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	551 where the compiler should look for the include files and object libraries
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	552 used with the X Window System. Normally, `configure' is able to find them;
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	553 these options are necessary if you have your X Window System files installed
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	554 in unusual places.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	555
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	556 Configuring the Build Process
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	557 -----------------------------
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	558
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	559 The `--with-gcc=PROGRAM' option specifies that the build process should
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	560 compile XEmacs using GCC. The `--with-compiler' option allows you to specify
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	561 some other compiler to be used to compile XEmacs. If neither option is
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	562 specified, the environment variable CC is used instead. Otherwise the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	563 compiler will then default to 'cc'.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	564
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	565 The `--with-xemacs-compiler=PROGRAM' option specifies the compiler control
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	566 program for the xemacs binary only. Other C code will be compiled according
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	567 to the `--with-gcc' and `--with-compiler' options above. This is useful if
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	568 you wish to compile XEmacs with a C++ compiler, because the utilities in
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	569 ./lib-src cannot be compiled as C++. This option is primarily intended for
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	570 use by the maintainers.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	571
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	572 The `--with-cflags=FLAGS' option specifies all of the CFLAGS the build
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	573 process should use when compiling XEmacs, except for flags controlling
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	574 warning generation. Otherwise the value of the environment variable CFLAGS
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	575 is consulted. If that is also undefined, CFLAGS defaults to "-g -O" for gcc
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	576 and "-g" for all other compilers.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	577
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	578 The `--with-cflags-warning=FLAGS' option specifies the warnings to be
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	579 generated. There is normally no reason to use this flag, as XEmacs turns on
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	580 as many warnings as possible, and is still intended to build with no
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	581 warnings. If you get any undocumented warnings, please report them as
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	582 bugs---they very often are, or at least indicate possible bitrot.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	583
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	584 The `--with-cflags-optimization=FLAGS' option specifies the optimizations to
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	585 be used. There is normally no reason to use this flag, as XEmacs will
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	586 already set the maximum safe optimization flags appropriate for the compiler
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	587 being invoked.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	588
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	589 The `--with-cflags-debugging=FLAGS' option specifies debugging information to
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	590 be generated. You should avoid using this flag, as it makes most severe or
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	591 fatal bugs hard-to-impossible to diagnose and fix. Debugging information
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	592 does not slow down XEmacs at runtime, and it doesn't make the binary very
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	593 much bigger.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	594
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	595 The `--with-dynamic' option specifies that configure should try to link
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	596 XEmacs dynamically rather than statically. `--with-static' specifies the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	597 reverse. XEmacs's configure script detects whether dynamic linking can be
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	598 done on all platforms we know of; these options are normally unnecessary.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	599
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	600 The `--with-modules' option specifies that XEmacs be built with support for
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	601 runtime loadable modules. NOTE TO OEMS: XEmacs can be distributed configured
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	602 to support several options based on external APIs (currently LDAP,
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	603 PostgreSQL, and Canna) as loadable modules. You can distribute an XEmacs
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	604 binary package with these options enabled without depending on the external
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	605 package. XEmacs will fail gracefully at runtime, issuing an error message
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	606 indicating that the required support was not found on the system.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	607
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	608 You can build XEmacs for several different machine types from a single source
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	609 directory. To do this, you must use a version of `make' that supports the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	610 `VPATH' variable, such as GNU `make'. Create separate build directories for
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	611 the different configuration types, and in each one, run the XEmacs
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	612 `configure' script. `configure' looks for the Emacs source code in the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	613 directory that `configure' is in. The `--srcdir' option may not work
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	614 correctly (traditionally it was overridden by the directory containing
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	615 `configure').
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	616
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	617 Configuring the Installation Layout
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	618 -----------------------------------
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	619
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	620 The `--prefix=PREFIXDIR' option specifies where the installation process
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	621 should put XEmacs and its data files. This defaults to `/usr/local'.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	622 - XEmacs (and the other utilities users run) go in PREFIXDIR/bin
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	623 (unless the `--exec-prefix' option says otherwise).
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	624 - The architecture-independent files go in PREFIXDIR/share/xemacs-VERSION
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	625 (where VERSION is the version number of XEmacs, like `21.0').
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	626 - The architecture-dependent files go in
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	627 PREFIXDIR/lib/xemacs-VERSION/CONFIGURATION-NAME
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	628 (where CONFIGURATION-NAME is the host type, like mips-dec-ultrix4.2),
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	629 unless the `--exec-prefix' option says otherwise.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	630
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	631 The `--exec-prefix=EXECDIR' option allows you to specify a separate portion
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	632 of the directory tree for installing architecture-specific files, like
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	633 executables and utility programs. If specified,
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	634 - XEmacs (and the other utilities users run) go in EXECDIR/bin, and
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	635 - The architecture-dependent files go in
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	636 EXECDIR/lib/xemacs-VERSION/CONFIGURATION-NAME.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	637 EXECDIR/bin should be a directory that is normally in users' PATHs.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	638
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	639 If you specify --prefix (or any of the other installation directory options),
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	640 they will get compiled into the xemacs executable so it will be able to find
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	641 its various associated files. However, XEmacs has quite elaborate logic to
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	642 find out the locations of these directories dynamically. Sometimes, it is
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	643 desirable not to compile these directories into the executable so you can
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	644 move the XEmacs installation around (as whole) at will. This is true for
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	645 binary kits, for instance. Therefore, you can specify --without-prefix on
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	646 the configure command line to prevent the installation prefix to become part
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	647 of the generated executable; everything else will continue to work as usual.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	648
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	649 Unlike previous versions of XEmacs (21.4 or earlier),
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	650 architecture-independent files (in particular, the Lisp files and
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	651 package hierarchies) by default get installed under `/usr/local/share'
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	652 rather than `/usr/local/lib'. To create a setup as in previous
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	653 versions, use the `--datadir=/usr/local/lib' option to configure.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	654
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	655 Options for Developers and Special Requirements
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	656 -----------------------------------------------
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	657
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	658 The `--with-rel-alloc' option can be used to either enable or disable
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	659 use of the relocating allocator. Turning on --with-rel-alloc will allow
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	660 XEmacs to return unused memory to the operating system, thereby reducing
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	661 its memory footprint. However, it may make XEmacs runs more slowly,
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	662 especially if your system's `mmap' implementation is missing or
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	663 inefficient. Generally, it's best to go with the default configuration
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	664 for your system. You can tweak this based on how you use XEmacs, and
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	665 the memory and cpu resources available on your system.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	666
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	667 The `--with-system-malloc' option can be used to either enable or
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	668 disable use of the system malloc. Generally, it's best to go with the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	669 default configuration for your system. Note that on many systems
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	670 using the system malloc disables the use of the relocating allocator.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	671
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	672 The `--with-debug-malloc' option can be used to link a special
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	673 debugging version of malloc. Debug Malloc is not included with XEmacs
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	674 and is intended for use only by the developers. It may be obtained
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	675 from <URL:http://www.letters.com/dmalloc/>.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	676
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	677 The `--with-debug' and `--with-error-checking' options are primarily
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	678 useful to the developers. `--with-debug' incorporates code for
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	679 performing various tests, but does not impose a speed penalty.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	680 `--with-error-checking' adds additional tests to many of the commonly
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	681 used macros, and imposes a speed penalty. Using either or both of these
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	682 options can make bug reports more useful to the developers.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	683
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	684 The `--verbose' option is useful only to the developers. It displays
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	685 additional information, useful for debugging `configure'.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	686
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	687 AUXILIARY PATHS
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	688 ===============
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	689
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	690 After configuring, look at `./lisp/paths.el'; if some of those values are not
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	691 right for your system, set up the file `./lisp/site-init.el' with XEmacs Lisp
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	692 code to override them; it is not a good idea to edit paths.el itself. YOU
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	693 MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES, rather than `defvar', as
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	694 used by `./lisp/paths.el'. For example,
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	695
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	696 (setq news-inews-program "/usr/bin/inews")
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	697
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	698 is how you would override the default value of the variable
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	699 news-inews-program (which is "/usr/local/inews").
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	700
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	701 Before you override a variable this way, look at the value that the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	702 variable gets by default! Make sure you know what kind of value the variable
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	703 should have. If you don't pay attention to what you are doing, you'll make a
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	704 mistake.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	705
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	706 Things may malfunction if the variable `directory-abbrev-alist' is not set up
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	707 to translate "temporary" automounter mount points into the canonical form.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	708 XEmacs tries to detect how your automounter is configured. If you have an
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	709 unusual automounter configuration that XEmacs cannot detect, you may need to
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	710 change the value of `directory-abbrev-alist'.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	711
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	712 SITE-SPECIFIC STARTUP CODE
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	713 ==========================
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	714
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	715 Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs Lisp code
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	716 you want XEmacs to load before it is dumped out. Use site-load.el for
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	717 additional libraries if you arrange for their documentation strings to be in
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	718 the lib-src/DOC file (see src/Makefile.in.in if you wish to figure out how to
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	719 do that). For all else, use site-init.el.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	720
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	721 Note that, on some systems, the code you place in site-init.el must not use
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	722 expand-file-name or any other function which may look something up in the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	723 system's password and user information database. See `./PROBLEMS' for more
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	724 details on which systems this affects.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	725
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	726 The `site-*.el' files are nonexistent in the distribution. You do not need
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	727 to create them if you have nothing to put in them.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	728
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	729 TERMCAP CONFIGURATION
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	730 =====================
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	731
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	732 Refer to the file `./etc/TERMS' for information on fields you may wish to add
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	733 to various termcap entries. The files `./etc/termcap.ucb' and
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	734 `./etc/termcap.dat' may already contain appropriately-modified entries.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	735
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	736 ADVANCED MAKE
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	737 =============
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	738
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	739 If the default installation directories are not what you want, you can
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	740 specify where to install XEmacs's libraries and data files or where XEmacs
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	741 should search for its lisp files by giving values for `make' variables as
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	742 part of the command.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	743
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	744 You can change where the build process installs XEmacs and its data files by
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	745 specifying values for `make' variables as part of the `make' command line.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	746 For example, if you type
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	747
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	748 make install bindir=/usr/local/gnubin
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	749
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	750 the `bindir=/usr/local/gnubin' argument indicates that the XEmacs executable
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	751 files should go in `/usr/local/gnubin', not `/usr/local/bin'.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	752
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	753 Note that this is not tested or recommended, and specifying installation
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	754 locations here rather than via `configure' may not work as expected. Here
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	755 is a complete list of the variables you may want to set.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	756
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	757 `bindir' indicates where to put executable programs that users can
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	758 run. This defaults to /usr/local/bin.
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	759
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	760 `datadir' indicates where to put the architecture-independent
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	761 read-only data files that XEmacs refers to while it runs; it
5704 37b107e878b8 More corrections to INSTALL by Robert Royer. Stephen J. Turnbull <stephen@xemacs.org> parents: 5699 diff changeset	762 defaults to /usr/local/share. We create the following
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	763 subdirectories under `datadir':
5704 37b107e878b8 More corrections to INSTALL by Robert Royer. Stephen J. Turnbull <stephen@xemacs.org> parents: 5699 diff changeset	764
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	765 - `xemacs-VERSION/lisp', containing the XEmacs lisp libraries, and
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	766
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	767 - `xemacs-VERSION/etc', containing the XEmacs tutorial and the
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	768 `yow' database.
5704 37b107e878b8 More corrections to INSTALL by Robert Royer. Stephen J. Turnbull <stephen@xemacs.org> parents: 5699 diff changeset	769
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	770 `VERSION' is the number of the XEmacs version you are installing,
5704 37b107e878b8 More corrections to INSTALL by Robert Royer. Stephen J. Turnbull <stephen@xemacs.org> parents: 5699 diff changeset	771 like `21.4.22' or `21.5-b32'. Since these files vary from one
37b107e878b8 More corrections to INSTALL by Robert Royer. Stephen J. Turnbull <stephen@xemacs.org> parents: 5699 diff changeset	772 version of XEmacs to another, including the version number in the
37b107e878b8 More corrections to INSTALL by Robert Royer. Stephen J. Turnbull <stephen@xemacs.org> parents: 5699 diff changeset	773 path allows you to have several versions of XEmacs installed at
37b107e878b8 More corrections to INSTALL by Robert Royer. Stephen J. Turnbull <stephen@xemacs.org> parents: 5699 diff changeset	774 the same time; this means that you don't have to make XEmacs
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	775 unavailable while installing a new version.
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	776
5150 0353d546dc1e Reflect change from `lib' to `share' in INSTALL. Mike Sperber <sperber@deinprogramm.de> parents: 4842 diff changeset	777 `datarootdir' indicates where to put the documentation. (Usually,
0353d546dc1e Reflect change from `lib' to `share' in INSTALL. Mike Sperber <sperber@deinprogramm.de> parents: 4842 diff changeset	778 this is identical to `datadir'---in the default configuration
0353d546dc1e Reflect change from `lib' to `share' in INSTALL. Mike Sperber <sperber@deinprogramm.de> parents: 4842 diff changeset	779 `datadir' is set to the value of `datarootdir'.)
0353d546dc1e Reflect change from `lib' to `share' in INSTALL. Mike Sperber <sperber@deinprogramm.de> parents: 4842 diff changeset	780 Specifically, the man pages are put in the `man' subdirectory
0353d546dc1e Reflect change from `lib' to `share' in INSTALL. Mike Sperber <sperber@deinprogramm.de> parents: 4842 diff changeset	781 of `datarootdir', and the info pages are put in the
0353d546dc1e Reflect change from `lib' to `share' in INSTALL. Mike Sperber <sperber@deinprogramm.de> parents: 4842 diff changeset	782 `xemacs/info' subdirectory.
0353d546dc1e Reflect change from `lib' to `share' in INSTALL. Mike Sperber <sperber@deinprogramm.de> parents: 4842 diff changeset	783
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	784 `statedir' indicates where to put architecture-independent data files
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	785 that XEmacs modifies while it runs; it defaults to
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	786 /usr/local/lib as well. We create the following
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	787 subdirectories under `statedir':
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	788 - `xemacs/lock', containing files indicating who is editing
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	789 what, so XEmacs can detect editing clashes between
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	790 users.
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	791
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	792 `libdir' indicates where to put architecture-specific data files that
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	793 XEmacs refers to as it runs; it too defaults to `/usr/local/lib'.
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	794 We create the following subdirectories under `libdir':
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	795 - `xemacs-VERSION/CONFIGURATION-NAME', containing executable
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	796 programs used by XEmacs that users are not expected to run
1338 314c4e18dda0 [xemacs-hg @ 2003-03-03 10:35:29 by stephent] stephent parents: 1283 diff changeset	797 themselves, and the DOC file.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	798 `VERSION' is the number of the XEmacs version you are installing,
243 f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	799 and `CONFIGURATION-NAME' is the host type of your system.
f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	800 Since these files are specific to the version of XEmacs,
f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	801 operating system, and architecture in use, including the
f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	802 configuration name in the path allows you to have several
f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	803 versions of XEmacs for any mix of machines and operating
f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	804 systems installed at the same time; this is useful for sites
f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	805 at which different kinds of machines share the file system
f220cc83d72e Import from CVS: tag r20-5b20 cvs parents: 227 diff changeset	806 XEmacs is installed on.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	807
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	808 `infodir' indicates where to put the info files distributed with
5150 0353d546dc1e Reflect change from `lib' to `share' in INSTALL. Mike Sperber <sperber@deinprogramm.de> parents: 4842 diff changeset	809 XEmacs; it defaults to `/usr/local/share/xemacs-VERSION/info'.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	810
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	811 `mandir' indicates where to put the man pages for XEmacs and its
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	812 utilities (like `etags'); it defaults to
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	813 `/usr/local/man/man1'.
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	814
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	815 `prefix' doesn't give a path for any specific part of XEmacs; instead,
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	816 its value is used to determine the defaults for all the
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	817 architecture-independent path variables - `datadir',
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	818 `statedir', `infodir', and `mandir'. Its default value is
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	819 `/usr/local'; the other variables add on `lib' or `man' to it
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	820 by default.
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	821
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	822 For example, suppose your site generally places GNU software
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	823 under `/usr/users/software/gnusoft' instead of `/usr/local'.
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	824 By including
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	825 `prefix=/usr/users/software/gnusoft'
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	826 in the arguments to `make', you can instruct the build process
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	827 to place all of the XEmacs data files in the appropriate
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	828 directories under that path.
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	829
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	830 `exec_prefix' serves the same purpose as `prefix', but instead
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	831 determines the default values for the architecture-dependent
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	832 path variables - `bindir' and `libdir'.
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	833
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	834 The above variables serve analogous purposes in the makefiles for all GNU
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	835 software; here are some variables specific to XEmacs.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	836
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	837 `lispdir' indicates where XEmacs installs and expects its lisp
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	838 libraries. Its default value, based on `datadir' (see above),
5150 0353d546dc1e Reflect change from `lib' to `share' in INSTALL. Mike Sperber <sperber@deinprogramm.de> parents: 4842 diff changeset	839 is `/usr/local/share/xemacs-VERSION/lisp' (where `VERSION' is as
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	840 described above).
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	841
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	842 `sitelispdir' indicates where XEmacs should search for lisp libraries
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	843 specific to your site. XEmacs checks them in order before
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	844 checking `lispdir'. Its default value, based on `datadir'
5150 0353d546dc1e Reflect change from `lib' to `share' in INSTALL. Mike Sperber <sperber@deinprogramm.de> parents: 4842 diff changeset	845 (see above), is `/usr/local/share/xemacs/site-lisp'.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	846
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	847 `etcdir' indicates where XEmacs should install and expect the rest of
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	848 its architecture-independent data, like the tutorial and yow
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	849 database. Its default value, based on `datadir'
5150 0353d546dc1e Reflect change from `lib' to `share' in INSTALL. Mike Sperber <sperber@deinprogramm.de> parents: 4842 diff changeset	850 (see above), is `/usr/local/share/xemacs-VERSION/etc' (where
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	851 `VERSION' is as described above).
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	852
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	853 `lockdir' indicates the directory where XEmacs keeps track of its
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	854 locking information. Its default value, based on `statedir'
5150 0353d546dc1e Reflect change from `lib' to `share' in INSTALL. Mike Sperber <sperber@deinprogramm.de> parents: 4842 diff changeset	855 (see above), is `/usr/local/share/xemacs/lock'.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	856
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	857 `archlibdir' indicates where XEmacs installs and expects the
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	858 executable files and other architecture-dependent data it uses
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	859 while running. Its default value, based on `libdir' (see
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	860 above), is `/usr/local/lib/xemacs-VERSION/CONFIGURATION-NAME'
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	861 (where VERSION and CONFIGURATION-NAME are as described above).
376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	862
420 41dbb7a9d5f2 Import from CVS: tag r21-2-18 cvs parents: 412 diff changeset	863 `docdir' indicates where to put Lisp documentation strings that XEmacs
442 abe6d1db359e Import from CVS: tag r21-2-36 cvs parents: 426 diff changeset	864 refers to as it runs. It defaults to the value of `archlibdir'
420 41dbb7a9d5f2 Import from CVS: tag r21-2-18 cvs parents: 412 diff changeset	865 (see above).
41dbb7a9d5f2 Import from CVS: tag r21-2-18 cvs parents: 412 diff changeset	866
388 aabb7f5b1c81 Import from CVS: tag r21-2-9 cvs parents: 380 diff changeset	867 `moduledir' indicates where XEmacs installs and expects to find
aabb7f5b1c81 Import from CVS: tag r21-2-9 cvs parents: 380 diff changeset	868 any dynamic modules. Its default value, based on
aabb7f5b1c81 Import from CVS: tag r21-2-9 cvs parents: 380 diff changeset	869 `archlibdir' (see above) is
aabb7f5b1c81 Import from CVS: tag r21-2-9 cvs parents: 380 diff changeset	870 `/usr/local/lib/xemacs-VERSION/CONFIGURATION-NAME/modules'
aabb7f5b1c81 Import from CVS: tag r21-2-9 cvs parents: 380 diff changeset	871 (where VERSION and CONFIGURATION-NAME are as described above).
aabb7f5b1c81 Import from CVS: tag r21-2-9 cvs parents: 380 diff changeset	872 By their very nature, dynamic loadable modules are architecture-
442 abe6d1db359e Import from CVS: tag r21-2-36 cvs parents: 426 diff changeset	873 dependent, and care should be taken not to set this directory
abe6d1db359e Import from CVS: tag r21-2-36 cvs parents: 426 diff changeset	874 to a system- or architecture-independent directory.
388 aabb7f5b1c81 Import from CVS: tag r21-2-9 cvs parents: 380 diff changeset	875
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	876 Remember that you must specify any variable values you need each time you run
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	877 `make' in the top directory. If you run `make' once to build xemacs, test
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	878 it, and then run `make' again to install the files, you must provide the same
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	879 variable settings each time. To make the settings persist, you can edit them
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	880 into the `Makefile' in the top directory, but be aware that running the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	881 `configure' program erases `Makefile' and rebuilds it from `Makefile.in'.
1283 32bc2bab419c [xemacs-hg @ 2003-02-10 14:28:09 by stephent] stephent parents: 1202 diff changeset	882
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	883 The top-level Makefile stores the variable settings it used in the Makefiles
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	884 for the subdirectories, so you don't have to specify them when running make
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	885 in the subdirectories.
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	886
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	887 Using GNU Make allows for simultaneous builds with and without the --srcdir
5704 37b107e878b8 More corrections to INSTALL by Robert Royer. Stephen J. Turnbull <stephen@xemacs.org> parents: 5699 diff changeset	888 option (see the section Running Configure).
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	889
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	890 MAIL LOCKING
4508 742a23369b74 Improve package documentation. Stephen J. Turnbull <stephen@xemacs.org> parents: 3179 diff changeset	891 ============
0 376386a54a3c Import from CVS: tag r19-14 cvs parents: diff changeset	892
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	893 For most platforms, configure or the src/s file have the preferred method for
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	894 locking mail spool files preconfigured. Otherwise you must find out for
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	895 yourself. Do not choose a locking protocol "on the objective merits."
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	896 XEmacs must use the same method as other mail utilities on your system, or
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	897 you WILL lose mail.
398 74fd4e045ea6 Import from CVS: tag r21-2-29 cvs parents: 392 diff changeset	898
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	899 Presently, XEmacs supports lockf, flock, and dot locking. Specify the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	900 locking method via the --with-mail-locking=METHOD option to configure. Valid
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	901 values for METHOD are --with-mail-locking are `lockf', `flock', and `dot'.
3050 67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	902
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	903 APPENDIX: CORRESPONDENCE TO OLD CONFIGURE OPTIONS
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	904 =================================================
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	905
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	906 Here is a full translation of command line arguments. Note that any option
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	907 starting with "--with" may also be specified with "--enable". This list may
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	908 not be up-to-date.
3050 67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	909
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	910 Old \| New
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	911 ------------------------------------------
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	912 General options:
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	913 ----------------
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	914
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	915 --help Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	916 --usage Removed
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	917 --verbose Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	918 --extra-verbose Removed
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	919
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	920 Compilation options:
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	921 --------------------
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	922
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	923 --compiler --with-compiler
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	924 --xemacs-compiler --with-xemacs-compiler
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	925 --with-gcc Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	926 --cflags --with-cflags
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	927 --cflags-warning --with-cflags-warning
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	928 --debug --with-debug
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	929 New --with-cflags-debug
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	930 New --with-optimization
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	931 New --with-cflags-optimization
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	932 --cpp --with-cpp
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	933 --cppflags --with-cppflags
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	934 --libs --with-libs
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	935 --ldflags --with-ldflags
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	936 --site-includes --with-site-includes
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	937 --site-libraries --with-site-libraries
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	938 --site-prefixes --with-site-prefixes
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	939 --site-runtime-libraries --with-site-runtime-libraries
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	940 --dynamic --with-dynamic
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	941 --srcdir Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	942
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	943 Installation options:
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	944 ---------------------
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	945
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	946 --prefix Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	947 --with-prefix Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	948 --with-netinstall Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	949 --bindir Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	950 --datadir Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	951 --statedir Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	952 --libdir Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	953 --infodir Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	954 --mandir Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	955 --lispdir --with-lispdir
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	956 --sitelispdir Removed
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	957 --etcdir --with-etcdir
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	958 --lockdir Removed
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	959 --archlibdir --with-archlibdir
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	960 --docdir --with-docdir
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	961 --moduledir --with-moduledir
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	962
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	963 Run-time path-searching options:
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	964 --------------------------------
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	965
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	966 --with-site-lisp Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	967 --with-site-modules Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	968 --package-path --with-package-path
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	969 --infopath --with-infopath
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	970
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	971 Window-system options:
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	972 ----------------------
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	973
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	974 --with-gtk Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	975 --with-gnome Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	976 --with-x11 Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	977 --x-includes Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	978 --x-libraries Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	979 --with-msw Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	980 --with-toolbars Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	981 --with-wmcommand Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	982 --with-athena Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	983 --with-menubars Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	984 --with-scrollbars Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	985 --with-dialogs Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	986 --with-widgets Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	987 --with-dragndrop Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	988 --with-cde Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	989 --with-xmu Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	990 --external-widget --with-external-widget
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	991
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	992 TTY (character terminal) options:
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	993 ---------------------------------
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	994
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	995 --with-tty Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	996 --with-ncurses Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	997 --with-gpm Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	998
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	999 Image options:
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1000 --------------
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1001
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1002 --with-xpm Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1003 --with-png Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1004 --with-jpeg Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1005 --with-tiff Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1006 --with-xface Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1007 --with-gif Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1008
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1009 Sound options:
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1010 --------------
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1011
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1012 --with-sound Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1013 --native-sound-lib=LIB --with-native-sound-lib
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1014
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1015 Internationalization options:
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1016 -----------------------------
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1017
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1018 --with-mule Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1019 --with-xim Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1020 --with-canna Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1021 --with-wnn Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1022 --with-wnn6 Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1023 --with-xfs Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1024
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1025 File-related options:
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1026 ---------------------
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1027
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1028 --with-default-eol-detection Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1029 --with-clash-detection Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1030
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1031 Database options:
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1032 -----------------
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1033
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1034 --with-database Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1035 --with-ldap Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1036 --with-postgresql Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1037
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1038 Mail options:
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1039 -------------
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1040
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1041 --mail-locking=TYPE --with-mail-locking
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1042 --with-pop Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1043 --with-kerberos Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1044 --with-hesiod Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1045
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1046 Networking options:
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1047 -------------------
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1048
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1049 --with-tooltalk Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1050 --with-socks Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1051 --with-dnet Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1052 --with-ipv6-cname Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1053
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1054 Memory allocation options:
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1055 --------------------------
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1056
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1057 --rel-alloc --with-rel-alloc
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1058 --with-dlmalloc Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1059 --with-system-malloc Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1060 --with-debug-malloc Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1061
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1062 Emacs Lisp options:
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1063 -------------------
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1064
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1065 --use-number-lib --with-bignum
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1066
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1067 Debugging options:
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1068 ------------------
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1069
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1070 --debug --with-debug
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1071 --error-checking --with-error-checking
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1072 --memory-usage-stats --with-memory-usage-stats
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1073 --quick-build --with-quick-build
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1074 --use-union-type --with-union-type
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1075 --with-quantify Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1076 --with-purify Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1077
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1078 Developer options:
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1079 ------------------
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1080
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1081 --with-workshop Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1082 --pdump --with-pdump
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1083 --use-kkcc --with-kkcc
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1084 --with-modules Unchanged
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1085
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1086 The output files produced by this new configure should be almost identical to
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1087 those produced by the old. This can be tested with the provided regression
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1088 test script. This script runs the two versions of configure with the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1089 supplied list of command line arguments and reports any differences. Please
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1090 add your favorite configuration command lines to the list before running the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1091 test. The script is run as:
3050 67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1092
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1093 $ tests/autoconf/regressiontest.pl /absolute/path/to/2.13/configure \
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1094 /absolute/path/to/2.59/configure >diffs.txt
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1095
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1096 The only differences should be:
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1097 - those related to changes in the command line arguments
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1098 - the change of SYS_SIGLIST_DECLARED to HAVE_DECL_SYS_SIGLIST (because the old
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1099 form has been removed), and
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1100 - The removal of trailing comments in src/config.h.
67b6f3514ffc [xemacs-hg @ 2005-11-07 08:49:12 by stephent] stephent parents: 3018 diff changeset	1101
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1102 RANDOM NOTES
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1103 ============
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1104
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1105 Definitions
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1106 -----------
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1107
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1108 A note on terminology: unfortunately the terms "library" and "package" are
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1109 heavily overloaded. In the following, "library" refers to an external body
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1110 of executable code which may be linked with XEmacs at build time to provide
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1111 support for system features, such as images, audio, stream compression,
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1112 databases, and input methods. A "Lisp library" is a file of Lisp code which
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1113 may be loaded into XEmacs at run-time to provide editor features. A
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1114 "package" is a specially prepared Lisp library or set of Lisp libraries,
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1115 providing for easy installation, upgrade, and removal of applications written
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1116 in Lisp.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1117
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1118 Package System
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1119 --------------
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1120
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1121 The FAQ sections 1.7 and 2.1 contain information vital to have a fully
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1122 working XEmacs. It includes a description of available packages, and how to
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1123 bootstrap XEmacs from a minimal or a complete set of packages. This
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1124 information was not included in this file only because it is too large for
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1125 this terse INSTALL. The FAQ is available in Texinfo format in
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1126 man/xemacs-faq.texi, as an Info file once you build XEmacs, and online at
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1127 http://www.xemacs.org/Documentation/21.5/html/xemacs-faq_1.html.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1128
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1129 Other
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1130 -----
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1131
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1132 On some systems, X11, Motif and CDE are optional additions. On MacOS/X
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1133 systems prior to 10.2, you may download X11R6 for Mac OS X from
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1134 http://www.apple.com/macosx/x11/download/. In later releases X11 is
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1135 available as an optional package on the installation CDs. In either case you
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1136 need both the runtime libraries and the SDK (in a sidebar of that page at the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1137 time of writing). There is also a 3rd-party implementation of X11R6 for the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1138 Mac at http://www.xdarwin.org/. On Solaris, the SUNWaudmo package enables
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1139 native sound support.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1140
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1141 You can get (most of) them from the XEmacs FTP archive at
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1142 <ftp://ftp.xemacs.org/pub/xemacs/aux>. Information about what
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1143 each library does is available in the file
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1144 <ftp://ftp.xemacs.org/pub/xemacs/aux/00README.txt>.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1145
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1146 (This note is probably obsolete.) Dynamic linking has pros and cons.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1147 Dynamically linking 3rd party libraries to XEmacs decreases the size of the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1148 binary, and means you don't need to rebuild XEmacs to take advantage of
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1149 improvements in the libraries. On the other hand, XEmacs can fail subtly if
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1150 the semantics of a library changes, other users may not be able to use your
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1151 "private" copies of the libraries, and you may have to relink XEmacs, or even
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1152 omit the feature, if the ABI changes when the libraries are upgraded.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1153
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1154 Use the `--with-site-includes' and `--with-site-libraries' options when
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1155 building XEmacs to allow configure to find the external software packages.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1156 For your convenience these can be set together by using the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1157 `--with-site-prefixes' option. This will set these variables as needed
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1158 assuming your libraries are organised as a typical /usr tree.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1159
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1160 If you link dynamically with external libraries, usually denoted by ".so"
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1161 (Unix), ".dll" (Windows), or ".dylib" (MacOS) file extensions, on some
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1162 systems you may also need to add the library directories to the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1163 `--with-site-runtime-libraries' option. It is typically necessary only if
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1164 you link with dynamic libraries that are installed in non-standard
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1165 directories, or if you expect some of the libraries used to build XEmacs to
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1166 be in a different directory at run time than at build time.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1167
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1168 NOTE: This option has unusual semantics. ONLY libraries found in the
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1169 directories specified in this option will be used at runtime. This means you
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1170 must specify ALL directories you want searched at runtime in this option
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1171 (perhaps excluding a very small number of standard system library paths).
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1172
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1173 Directories specified with `--with-site-libraries' are NOT automatically
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1174 added. The rationale is that most users will not need this option, and this
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1175 allows the builder to specify exactly the needed directories. Specifying
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1176 unnecessary directories leads to obscure problems (typically startup delays)
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1177 if those directories are mounted over a network, and the automounter
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1178 configuration changes. Not all systems need this option; it's best to avoid
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1179 using it if you can.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1180
5704 37b107e878b8 More corrections to INSTALL by Robert Royer. Stephen J. Turnbull <stephen@xemacs.org> parents: 5699 diff changeset	1181 To specify multiple directories in these commands, use a list delimited by
37b107e878b8 More corrections to INSTALL by Robert Royer. Stephen J. Turnbull <stephen@xemacs.org> parents: 5699 diff changeset	1182 spaces, colons, or commas. You will need to protect space-delimited lists
37b107e878b8 More corrections to INSTALL by Robert Royer. Stephen J. Turnbull <stephen@xemacs.org> parents: 5699 diff changeset	1183 from shell parsing by quoting them.
37b107e878b8 More corrections to INSTALL by Robert Royer. Stephen J. Turnbull <stephen@xemacs.org> parents: 5699 diff changeset	1184
5699 a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1185 If you haven't built XEmacs 21.5 recently, the change from the configure
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1186 script based on Autoconf 2.13 can be a shock. Appendix: Correspondence to
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1187 Old Configure Options (at the end of this document) contains a list of old
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1188 options and their new equivalents.
a95c89dc9695 Reorganize and update INSTALL. Stephen J. Turnbull <stephen@xemacs.org> parents: 5384 diff changeset	1189

Mercurial > hg > xemacs-beta

annotate INSTALL @ 5853:1044acf60048