|
0
|
1 XEmacs Installation Guide
|
|
|
2 Copyright (c) 1994, 1995, 1996 Board of Trustees, University of Illinois
|
|
424
|
3 Copyright (c) 1994-1999 Free Software Foundation, Inc.
|
|
412
|
4
|
|
0
|
5 Permission is granted to anyone to make or distribute verbatim copies
|
|
|
6 of this document as received, in any medium, provided that the
|
|
|
7 copyright notice and permission notice are preserved,
|
|
|
8 and that the distributor grants the recipient permission
|
|
|
9 for further redistribution as permitted by this notice.
|
|
|
10
|
|
|
11 Permission is granted to distribute modified versions
|
|
|
12 of this document, or of portions of it,
|
|
|
13 under the above conditions, provided also that they
|
|
|
14 carry prominent notices stating who last changed them,
|
|
|
15 and that any new or changed statements about the activities
|
|
|
16 of the Free Software Foundation are approved by the Foundation.
|
|
|
17
|
|
|
18
|
|
442
|
19 BUILDING AND INSTALLATION FOR UNIX AND CYGWIN
|
|
|
20
|
|
|
21 (for Microsoft Windows, see nt/README also.)
|
|
|
22
|
|
|
23 PREREQUISITES
|
|
|
24 =============
|
|
404
|
25
|
|
442
|
26 Make sure your system has enough swapping space allocated to handle a
|
|
|
27 program whose pure code is 900k bytes and whose data area is at least
|
|
|
28 400k and can reach 8Mb or more. Note that a typical XEmacs build is
|
|
|
29 much bigger. If the swapping space is insufficient, you will get an
|
|
|
30 error in the command `temacs -batch -l loadup dump', found in
|
|
|
31 `./src/Makefile.in.in', or possibly when running the final dumped
|
|
|
32 XEmacs.
|
|
0
|
33
|
|
442
|
34 Verify that your users have a high enough stack limit. On some systems
|
|
|
35 such as OpenBSD and OSF/Tru64 the default is 2MB which is too low. See
|
|
|
36 'PROBLEMS' for details.
|
|
424
|
37
|
|
|
38 Building XEmacs requires about 100 Mb of disk space (including the
|
|
|
39 XEmacs sources). Once installed, XEmacs occupies between 20 and 100 Mb
|
|
|
40 in the file system where it is installed; this includes the executable files,
|
|
|
41 Lisp libraries, miscellaneous data files, and on-line documentation. The
|
|
|
42 exact amount depends greatly on the number of extra lisp packages that are
|
|
|
43 installed
|
|
149
|
44
|
|
255
|
45 XEmacs requires an ANSI C compiler, such as GCC. If you wish to build
|
|
|
46 the documentation yourself, you will need at least version 1.68 of
|
|
|
47 makeinfo (GNU texinfo-3.11).
|
|
149
|
48
|
|
442
|
49 ADD-ON LIBRARIES
|
|
|
50 ================
|
|
149
|
51
|
|
442
|
52 Decide on what other software packages you would like to use with
|
|
149
|
53 XEmacs, but are not yet available on your system. On some systems,
|
|
|
54 Motif and CDE are optional additions. On Solaris, the SUNWaudmo
|
|
|
55 package enables native sound support. There are also a number of free
|
|
|
56 software packages that XEmacs can use. If these are not yet available
|
|
|
57 on your system, obtain, build and install those external packages
|
|
|
58 before building XEmacs. The packages XEmacs can use are:
|
|
0
|
59
|
|
272
|
60 Xaw3d, XPM, JPEG, compface, PNG, zlib, GNU DBM, Berkeley DB, socks,
|
|
|
61 term, NAS, Canna, Kinput2, SJ3, Wnn.
|
|
149
|
62
|
|
|
63 You can get (most of) them from the XEmacs ftp site at
|
|
243
|
64 ftp://ftp.xemacs.org/pub/xemacs/aux
|
|
0
|
65
|
|
149
|
66 If you want users on other systems to be able to use the XEmacs you
|
|
|
67 have built, try to build those packages so that the generated
|
|
|
68 libraries are statically linked.
|
|
|
69
|
|
|
70 Use the --site-includes and --site-libraries options when building
|
|
272
|
71 XEmacs to allow configure to find the external software packages.
|
|
201
|
72 If you link with dynamic (``.so'') external package libraries, which
|
|
|
73 is not recommended, you will also need to add the library directories
|
|
424
|
74 to the --site-runtime-libraries option. For your convenience these can
|
|
|
75 be set together by using the --with-site-prefix command. This will set
|
|
|
76 these variables as needed assuming your libraries are organised as a
|
|
|
77 typical /usr tree.
|
|
398
|
78
|
|
442
|
79 PACKAGE SYSTEM
|
|
|
80 ==============
|
|
424
|
81
|
|
442
|
82 The file README.packages contain information vital to have a fully
|
|
|
83 working XEmacs. This information was not included in this file only
|
|
|
84 because it is too large for this terse INSTALL. Please read
|
|
424
|
85 README.packages now!
|
|
|
86
|
|
442
|
87 CONFIGURATION OPTIONS
|
|
|
88 =====================
|
|
269
|
89
|
|
442
|
90 In the top level directory of the XEmacs distribution, run the
|
|
|
91 program `configure' as follows:
|
|
0
|
92
|
|
149
|
93 ./configure [CONFIGURATION-NAME] [--OPTION[=VALUE]] ...
|
|
0
|
94
|
|
243
|
95 Almost always, you should let `configure' (actually the shell script
|
|
|
96 `config.guess') guess your host type, by omitting the
|
|
149
|
97 CONFIGURATION-NAME argument. If you like to experiment, specify a
|
|
|
98 configuration name in the form MACHINE-VENDOR-OPSYS, for example:
|
|
|
99
|
|
|
100 sparc-sun-solaris2.6
|
|
|
101
|
|
|
102 See config.guess and configure.in for valid values for MACHINE,
|
|
|
103 VENDOR, and OPSYS. Also check `./etc/MACHINES' for advice on building
|
|
|
104 on particular machines.
|
|
0
|
105
|
|
272
|
106 If you don't want X support, specify `--without-x'. If you omit this
|
|
149
|
107 option, `configure' will try to autodetect whether your system has X,
|
|
|
108 and arrange to use it if present.
|
|
0
|
109
|
|
|
110 The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build
|
|
|
111 process where the compiler should look for the include files and
|
|
|
112 object libraries used with the X Window System. Normally, `configure'
|
|
|
113 is able to find them; these options are necessary if you have your X
|
|
|
114 Window System files installed in unusual places.
|
|
|
115
|
|
|
116 The `--site-includes=DIR' and `--site-libraries=DIR' options allow you
|
|
|
117 to specify additional places the compiler should look for include
|
|
|
118 files and object libraries. You may specify multiple DIR's by
|
|
149
|
119 enclosing the list in quotes. All the external packages you want to
|
|
272
|
120 use with XEmacs (e.g. xpm, wnn, ...) described later should have their
|
|
149
|
121 include and library directories defined using these options.
|
|
|
122
|
|
201
|
123 The `--site-runtime-libraries=DIR' option specifies directories to
|
|
|
124 search for shared libraries at run time. This may be necessary if you
|
|
|
125 link with dynamic libraries that are installed in non-standard
|
|
|
126 directories, or if you expect some of the libraries used to build
|
|
|
127 XEmacs to be in a different directory at run time than at build time.
|
|
|
128 Usually this will add a `-R' to each directory specified and use that
|
|
|
129 when linking XEmacs. If you use this option, you must specify ALL of
|
|
|
130 the directories containing shared libraries at run time, including
|
|
|
131 system directories.
|
|
|
132
|
|
|
133 Rationale: Some people think that directories in --site-libraries
|
|
|
134 should be automatically used to update --site-runtime-libraries.
|
|
|
135 Here's a real-life scenario that explains why this is not done: You
|
|
|
136 build binaries for your company using static libs in
|
|
|
137 /net/toy/hack/lib. XEmacs adds /net/toy/hack/lib to the runpath of
|
|
|
138 the executable you've built. Since there are only static libs there,
|
|
|
139 the system runtime loader will look in this dir, and ignore it,
|
|
|
140 causing only a .01 second delay in starting XEmacs. You leave the
|
|
|
141 company for a job at a small Silicon Valley startup. Time passes.
|
|
|
142 The next guy who inherits your machine objects to working on a machine
|
|
|
143 named `toy', and gets the sysadmin to rename the machine `godzilla'.
|
|
|
144 The SA forgets to remove the old entry for `toy' from the hosts file.
|
|
|
145 Now the system loader will still try to access /net/toy/, and the
|
|
|
146 automounter will hang trying to access /net/toy. XEmacs suddenly
|
|
|
147 takes 30 seconds longer to start up, no one can figure out why, and
|
|
|
148 everyone at your old company curses your name, thinking that you've
|
|
|
149 put a time bomb into XEmacs. And they're right!
|
|
0
|
150
|
|
|
151 The `--with-gcc' option specifies that the build process should
|
|
149
|
152 compile XEmacs using GCC. The `--compiler' option allows you to
|
|
|
153 specify some other compiler to be used to compile XEmacs. If neither
|
|
|
154 option is specified, the environment variable CC is used instead.
|
|
|
155 Otherwise the compiler will then default to 'cc'.
|
|
0
|
156
|
|
|
157 The `--cflags' option specifies the CFLAGS the build process should
|
|
149
|
158 use when compiling XEmacs. Otherwise the value of the environment
|
|
|
159 variable CFLAGS is consulted. If that is also undefined, CFLAGS
|
|
|
160 defaults to "-g -O" for gcc and "-g" for all other compilers.
|
|
0
|
161
|
|
|
162 The `--dynamic' option specifies that configure should try to link
|
|
|
163 emacs dynamically rather than statically.
|
|
|
164
|
|
|
165 You can build XEmacs for several different machine types from a single
|
|
|
166 source directory. To do this, you must use a version of `make' that
|
|
442
|
167 supports the `VPATH' variable, such as GNU `make'. Create separate
|
|
0
|
168 build directories for the different configuration types, and in each
|
|
|
169 one, run the XEmacs `configure' script. `configure' looks for the
|
|
|
170 Emacs source code in the directory that `configure' is in.
|
|
|
171
|
|
|
172 The `--prefix=PREFIXDIR' option specifies where the installation process
|
|
|
173 should put XEmacs and its data files. This defaults to `/usr/local'.
|
|
|
174 - XEmacs (and the other utilities users run) go in PREFIXDIR/bin
|
|
|
175 (unless the `--exec-prefix' option says otherwise).
|
|
|
176 - The architecture-independent files go in PREFIXDIR/lib/xemacs-VERSION
|
|
276
|
177 (where VERSION is the version number of XEmacs, like `21.0').
|
|
0
|
178 - The architecture-dependent files go in
|
|
243
|
179 PREFIXDIR/lib/xemacs-VERSION/CONFIGURATION-NAME
|
|
|
180 (where CONFIGURATION-NAME is the host type, like mips-dec-ultrix4.2),
|
|
0
|
181 unless the `--exec-prefix' option says otherwise.
|
|
|
182
|
|
|
183 The `--exec-prefix=EXECDIR' option allows you to specify a separate
|
|
|
184 portion of the directory tree for installing architecture-specific
|
|
|
185 files, like executables and utility programs. If specified,
|
|
|
186 - XEmacs (and the other utilities users run) go in EXECDIR/bin, and
|
|
|
187 - The architecture-dependent files go in
|
|
243
|
188 EXECDIR/lib/xemacs-VERSION/CONFIGURATION-NAME.
|
|
0
|
189 EXECDIR/bin should be a directory that is normally in users' PATHs.
|
|
|
190
|
|
442
|
191 If you specify --prefix (or any of the other installation directory
|
|
|
192 options), they will get compiled into the xemacs executable so it will
|
|
|
193 be able to find its various associated file. However, XEmacs has
|
|
|
194 quite elaborate logic to find out the locations of these directories
|
|
|
195 dynamically. Sometimes, it is desirable *not* to compile these
|
|
|
196 directories into the executable so you can move the XEmacs
|
|
|
197 installation around (as whole) at will. This is true for binary kits,
|
|
|
198 for instance. Therefore, you can specify --without-prefix on the
|
|
|
199 configure command line to prevent the installation prefix to become
|
|
|
200 part of the generated executable; everything else will continue to
|
|
|
201 work as usual.
|
|
0
|
202
|
|
|
203 The `--with-menubars=TYPE' option allows you to specify which X
|
|
|
204 toolkit you wish to use for the menubar. The valid options are
|
|
149
|
205 `lucid', `motif' and `no'. The default is `lucid' which is a
|
|
0
|
206 Motif-lookalike menubar. We highly recommend its usage over the real
|
|
|
207 Motif menubar. (In fact, the Motif menubar is currently broken.) If
|
|
149
|
208 `no' is specified then support for menubars will not be compiled in.
|
|
0
|
209
|
|
|
210 The `--with-scrollbars=TYPE' option allows you to specify which X
|
|
|
211 toolkit you wish to use for the scrollbars. The valid options are
|
|
149
|
212 `lucid', `motif', `athena', `athena3d', and `no'. The default is
|
|
|
213 `lucid' which is a Motif-lookalike scrollbar. If `no' is specified
|
|
104
|
214 then support for scrollbars will not be compiled in.
|
|
0
|
215
|
|
|
216 The `--with-dialogs=TYPE' option allows you to specify which X toolkit
|
|
219
|
217 you wish to use for the dialog boxes. The valid options are `athena',
|
|
243
|
218 `athena3d', `motif, and `no. The `lucid' option is accepted and will
|
|
|
219 result in the `athena' toolkit being used. If the Motif toolkit can be
|
|
|
220 found the default is `motif'. Otherwise, the default is `athena'. If
|
|
149
|
221 `no' is specified then support for dialog boxes will not be compiled
|
|
0
|
222 in.
|
|
|
223
|
|
|
224 The `--with-toolbars' option allows you to enable or disable toolbar
|
|
|
225 support. The default is `yes' as long as support for a windowing
|
|
|
226 system is included.
|
|
|
227
|
|
149
|
228 The `--with-xpm' option specifies that XEmacs should support X11
|
|
0
|
229 Pixmaps. `configure' will attempt to detect if you have the Xpm
|
|
|
230 libraries and define `--with-xpm' for you.
|
|
|
231
|
|
|
232 The `--with-xface' option specifies that XEmacs should support
|
|
|
233 X-Faces. `configure' will attempt to detect if you have the compface
|
|
|
234 library and define `--with-xface' for you.
|
|
|
235
|
|
|
236 The `--with-database' option specifies that XEmacs should be built
|
|
|
237 with additional database support. The valid options are `no' or a
|
|
|
238 comma-separated list of one or more of `dbm', `gnudbm' or `berkdb'.
|
|
|
239 `configure' will attempt to detect the necessary libraries and header
|
|
|
240 files and define `--with-database' for you.
|
|
|
241
|
|
|
242 The `--with-socks' option specifies that XEmacs should be built with
|
|
149
|
243 SOCKS support. This requires the libsocks library.
|
|
0
|
244
|
|
|
245 The `--with-tooltalk' option specifies that XEmacs should be built
|
|
|
246 with ToolTalk support for interconnecting with other applications.
|
|
243
|
247 ToolTalk is not yet supported on all architectures. If you use this
|
|
|
248 option, you should have the tooltalk package (see etc/PACKAGES)
|
|
|
249 installed prior to building XEmacs.
|
|
0
|
250
|
|
|
251 The `--with-sparcworks' option specifies that XEmacs should be built
|
|
149
|
252 with support for Sun Sparcworks 3.0.1 and up (including Sun WorkShop).
|
|
|
253 This functionality is only of use on SunOS 4.1.x and Solaris 2.x
|
|
272
|
254 systems. If you use this option, you should have the Sun package (see
|
|
243
|
255 etc/PACKAGES) installed prior to building XEmacs.
|
|
0
|
256
|
|
149
|
257 The `--with-cde' option allows you to enable or disable CDE drag and
|
|
0
|
258 drop support. `configure' will attempt to detect this option and
|
|
|
259 define `--with-cde' for you.
|
|
|
260
|
|
272
|
261 The `--with-offix' option allows you to enable or disable OffiX drag
|
|
|
262 and drop support. This requires no external library support, so if
|
|
|
263 X11 support is available, then this option defaults to `yes'. OffiX
|
|
274
|
264 support can be explicitly disabled via the `--with-offix=no' option.
|
|
2
|
265
|
|
0
|
266 The `--external-widget' option specifies that XEmacs should be built
|
|
149
|
267 with support for being used as a widget by other X11 applications.
|
|
|
268 This functionality should be considered beta.
|
|
0
|
269
|
|
272
|
270 The `--without-xmu' option can be used if your vendor doesn't ship
|
|
0
|
271 the Xmu library.
|
|
|
272
|
|
|
273 The `--puresize' option can be used to change the amount of purespace
|
|
104
|
274 allocated for the dumped XEmacs. As of XEmacs 20.1 usage of this
|
|
243
|
275 parameter is deprecated and will be ignored.
|
|
0
|
276
|
|
|
277 The `--with-sound=TYPE' option specifies that XEmacs should be built
|
|
|
278 with sound support. Native (`--with-sound=native') sound support is
|
|
|
279 currently available only on Sun SparcStations, SGI's, HP9000s, and
|
|
149
|
280 systems (such as Linux) with soundcard.h. Network Audio Support (NAS)
|
|
|
281 (`--with-sound=nas' or `--with-sound=both') is an extension to X that
|
|
|
282 you may or may not have for your system. For NAS, you will probably
|
|
|
283 need to provide the paths to the nas include and library directories
|
|
|
284 to configure. If `--with-sound' is not specified, `configure' will
|
|
|
285 attempt to determine if your configuration supports native sound and
|
|
0
|
286 define --with-sound for you. If your native sound library is not in a
|
|
149
|
287 standard location you can specify it with the `--native-sound-lib=LIB'
|
|
|
288 flag. For Linux, `/dev/audio' is required for SunAudio files and
|
|
|
289 `/dev/dsp' is required for raw data and WAVE format files.
|
|
0
|
290
|
|
|
291 The `--rel-alloc' option can be used to either enable or disable use
|
|
151
|
292 of the relocating allocator. Turning on --rel-alloc will allow XEmacs
|
|
|
293 to return unused memory to the operating system, thereby reducing its
|
|
|
294 memory footprint. However, it may make XEmacs runs more slowly,
|
|
442
|
295 especially if your system's `mmap' implementation is missing or
|
|
151
|
296 inefficient. Generally, it's best to go with the default
|
|
|
297 configuration for your system. You can tweak this based on how you
|
|
|
298 use XEmacs, and the memory and cpu resources available on your system.
|
|
0
|
299
|
|
426
|
300 The `--with-system-malloc' option can be use to either enable or
|
|
149
|
301 disable use of the system malloc. Generally, it's best to go with the
|
|
|
302 default configuration for your system. Note that on many systems
|
|
|
303 using the system malloc disables the use of the relocating allocator.
|
|
0
|
304
|
|
426
|
305 The `--with-debug-malloc' option can be used to link a special debugging
|
|
177
|
306 version of malloc. Debug Malloc is not included with XEmacs, is
|
|
|
307 intended for use only by the developers and may be obtained from
|
|
|
308 <URL:http://www.letters.com/dmalloc/>.
|
|
|
309
|
|
0
|
310 The `--debug' and `--error-checking' options are intended for use only
|
|
|
311 by the developers. `--debug' adds code to be compiled in for
|
|
|
312 performing various tests. `--error-checking' adds additional tests to
|
|
|
313 many of the commonly used macros.
|
|
|
314
|
|
|
315 The `--verbose' and `--extra-verbose' options are intended for use
|
|
|
316 only by the developers. `--verbose' causes the results of all
|
|
149
|
317 configure tests to be displayed. `--extra-verbose' displays
|
|
|
318 additional information, useful for debugging. Another help for
|
|
|
319 determining configure failures is the file `config.log', which
|
|
|
320 contains the results of the compile and link tests used by configure.
|
|
|
321
|
|
|
322 The `--with-mule' option enables (MUlti-Lingual Emacs) support, needed
|
|
442
|
323 to support non-Latin-1 (including Asian) languages. The Mule support
|
|
243
|
324 is not yet as stable or efficient as the `Latin1' support. Enabling
|
|
|
325 Mule support requires the mule-base package installed prior to
|
|
|
326 building XEmacs. The following options require Mule support:
|
|
149
|
327
|
|
|
328 The `--with-xim' option enables use of the X11 XIM mechanism to allow
|
|
|
329 an input method to input text into XEmacs. The input method is shared
|
|
|
330 among all the X applications sharing an X display and using the same
|
|
151
|
331 language. The XIM support comes in two flavors: `motif' and `xlib'.
|
|
|
332 The Motif support (the XmIm* functions) is preferred when available.
|
|
243
|
333 The xlib XIM support works reasonably well so long as the X11 libraries
|
|
|
334 are recent enough. It has been fairly well tested on Linux with glibc
|
|
|
335 2.0.5 and 2.0.6 and Kinput2 as an XIM server. In this configuration
|
|
|
336 X11 must be recompiled with X_LOCALE defined because glibc is lacking
|
|
|
337 localization for Japanese. The XIM support defaults to `no' except
|
|
|
338 when Motif is detected where it is stable with OSF libraries. The XIM
|
|
|
339 support in Lesstif (a Free Motif replacement) does not work as of
|
|
|
340 v0.82. If you enable this option, you will probably wish to install
|
|
|
341 the `locale' package which contains localized Splash screens and
|
|
|
342 Menubars.
|
|
|
343
|
|
272
|
344 The `--with-xfs' option enables use of a multilingual Menubar. At the
|
|
243
|
345 present time, only Japanese and French locales are supported. In
|
|
272
|
346 order to use a multilingual Menubar you must have the `locale' package
|
|
243
|
347 installed. The `locale' package does not have to be installed when
|
|
|
348 building XEmacs.
|
|
149
|
349
|
|
|
350 The `--with-canna' option enables the use of the Canna Japanese input
|
|
243
|
351 method. This is stable code and fairly well tested. In order to use
|
|
|
352 it, you will have to have the Canna server installed and running.
|
|
|
353 Canna versions 3.2pl2 and 3.5b2 are known to work. Version 3.2pl2 is
|
|
|
354 considered most stable than version 3.5b2. If Canna is already
|
|
|
355 installed, configure will autodetect it, so you never need to
|
|
|
356 explicitly use this option unless your Canna libraries are somewhere
|
|
|
357 strange. Canna run time support is currently bundled with the
|
|
272
|
358 `mule-base' package so there is nothing additional to install in order
|
|
243
|
359 to use it.
|
|
0
|
360
|
|
243
|
361 The `--with-wnn' and `--with-wnn6' options are for compiling with the Wnn
|
|
|
362 multi-language input method. `--with-wnn' is for compiling with Wnn-4.2,
|
|
|
363 the Free version of WNN. `--with-wnn6' is for compiling against WNN6,
|
|
|
364 the commercial version of WNN available from OMRON Corporation. This is
|
|
|
365 stable code and fairly well tested. In order to build with this
|
|
|
366 option, you will need to have the `egg-its' lisp package already
|
|
|
367 installed.
|
|
|
368
|
|
|
369 Please note that it is safe to build with as many of the options
|
|
|
370 `--with-xim', `--with-canna' and `--with-wnn' as your system
|
|
|
371 supports.
|
|
104
|
372
|
|
442
|
373 MAIL LOCKING
|
|
|
374 ============
|
|
|
375
|
|
|
376 Find out what the preferred method for locking mail spool files is in
|
|
|
377 your environment. Presently, XEmacs supports lockf, flock, and dot
|
|
|
378 locking. Specify the locking method via the --mail-locking=METHOD
|
|
|
379 option to configure. Valid values for METHOD are --mail-locking are
|
|
|
380 `lockf', `flock', and `dot'.
|
|
|
381
|
|
|
382 RUNNING CONFIGURE
|
|
|
383 =================
|
|
|
384
|
|
149
|
385 `configure' doesn't do any compilation or installation itself. It
|
|
|
386 just creates the files that influence those things: `./src/config.h',
|
|
|
387 and all the Makefile's in the build tree.
|
|
104
|
388
|
|
0
|
389 When it is done, `configure' prints a description of what it did and
|
|
|
390 creates a shell script `config.status' which, when run, recreates the
|
|
|
391 same configuration. If `configure' exits with an error after
|
|
|
392 disturbing the status quo, it removes `config.status'.
|
|
|
393
|
|
442
|
394 AUXILIARY PATHS
|
|
|
395 ===============
|
|
|
396
|
|
|
397 Look at `./lisp/paths.el'; if some of those values are not right for
|
|
|
398 your system, set up the file `./lisp/site-init.el' with XEmacs Lisp
|
|
|
399 code to override them; it is not a good idea to edit paths.el itself.
|
|
|
400 YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES, rather than
|
|
|
401 `defvar', as used by `./lisp/paths.el'. For example,
|
|
0
|
402
|
|
|
403 (setq news-inews-program "/usr/bin/inews")
|
|
|
404
|
|
|
405 is how you would override the default value of the variable
|
|
|
406 news-inews-program (which is "/usr/local/inews").
|
|
|
407
|
|
|
408 Before you override a variable this way, *look at the value* that the
|
|
|
409 variable gets by default! Make sure you know what kind of value the
|
|
|
410 variable should have. If you don't pay attention to what you are
|
|
|
411 doing, you'll make a mistake.
|
|
|
412
|
|
392
|
413 Things may malfunction if the variable `directory-abbrev-alist' is not
|
|
|
414 set up to translate "temporary" automounter mount points into the
|
|
|
415 canonical form. XEmacs tries to detect how your automounter is
|
|
|
416 configured. If you have an unusual automounter configuration that
|
|
|
417 XEmacs cannot detect, you may need to change the value of
|
|
|
418 `directory-abbrev-alist'.
|
|
371
|
419
|
|
442
|
420 SITE-SPECIFIC STARTUP CODE
|
|
|
421 ==========================
|
|
|
422
|
|
|
423 Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs Lisp
|
|
|
424 code you want XEmacs to load before it is dumped out. Use
|
|
0
|
425 site-load.el for additional libraries if you arrange for their
|
|
|
426 documentation strings to be in the lib-src/DOC file (see
|
|
|
427 src/Makefile.in.in if you wish to figure out how to do that). For all
|
|
|
428 else, use site-init.el.
|
|
|
429
|
|
|
430 Note that, on some systems, the code you place in site-init.el must
|
|
|
431 not use expand-file-name or any other function which may look
|
|
|
432 something up in the system's password and user information database.
|
|
|
433 See `./PROBLEMS' for more details on which systems this affects.
|
|
|
434
|
|
|
435 The `site-*.el' files are nonexistent in the distribution. You do not
|
|
|
436 need to create them if you have nothing to put in them.
|
|
|
437
|
|
442
|
438 TERMCAP CONFIGURATION
|
|
|
439 =====================
|
|
|
440
|
|
|
441 Refer to the file `./etc/TERMS' for information on fields you may
|
|
0
|
442 wish to add to various termcap entries. The files `./etc/termcap.ucb'
|
|
|
443 and `./etc/termcap.dat' may already contain appropriately-modified
|
|
|
444 entries.
|
|
|
445
|
|
442
|
446 RUNNING MAKE
|
|
|
447 ============
|
|
|
448
|
|
|
449 Run `make' in the top directory of the XEmacs distribution to finish
|
|
0
|
450 building XEmacs in the standard way. The final executable file is
|
|
|
451 named `src/emacs'. You can execute this file "in place" without
|
|
|
452 copying it, if you wish; then it automatically uses the sibling
|
|
|
453 directories ../lisp, ../lib-src, ../info.
|
|
|
454
|
|
|
455 Or you can "install" the executable and the other XEmacs into their
|
|
|
456 installed locations, with `make install'. By default, XEmacs's files
|
|
|
457 are installed in the following directories:
|
|
|
458
|
|
|
459 By default, XEmacs installs its files in the following directories:
|
|
|
460
|
|
|
461 `/usr/local/bin' holds the executable programs users normally run -
|
|
388
|
462 `xemacs', `etags', `ctags', `b2m', `emacsclient', `ellcc',
|
|
0
|
463 `gnuclient', `gnudoit', `gnuattach', and `rcs-checkin'.
|
|
|
464
|
|
|
465 `/usr/local/lib/xemacs-VERSION/lisp' holds the Emacs Lisp libraries;
|
|
|
466 `VERSION' stands for the number of the XEmacs version
|
|
|
467 you are installing, like `18.59' or `19.14'. Since
|
|
|
468 the lisp libraries change from one version of XEmacs to
|
|
|
469 another, including the version number in the path
|
|
|
470 allows you to have several versions of XEmacs installed
|
|
|
471 at the same time; this means that you don't have to
|
|
|
472 make XEmacs unavailable while installing a new version.
|
|
|
473
|
|
|
474 XEmacs searches for its lisp files in these
|
|
|
475 directories, and then in
|
|
|
476 `/usr/local/lib/xemacs/site-lisp/*'.
|
|
|
477
|
|
|
478 `/usr/local/lib/xemacs-VERSION/etc' holds the XEmacs tutorial, the
|
|
|
479 `yow' database, and other architecture-independent
|
|
|
480 files XEmacs might need while running. VERSION is as
|
|
|
481 specified for `.../lisp'.
|
|
|
482
|
|
|
483 `/usr/local/lib/xemacs/lock' contains files indicating who is
|
|
|
484 editing what, so XEmacs can detect editing clashes
|
|
|
485 between users.
|
|
|
486
|
|
|
487 `/usr/local/lib/xemacs-VERSION/CONFIGURATION-NAME' contains executable
|
|
|
488 programs used by XEmacs that users are not expected to
|
|
|
489 run themselves, and the DOC file. `VERSION' is the
|
|
|
490 number of the XEmacs version you are installing, and
|
|
243
|
491 `CONFIGURATION-NAME' is the host type of your system.
|
|
|
492 Since these files are specific to the version of
|
|
|
493 XEmacs, operating system, and architecture in use,
|
|
|
494 including the configuration name in the path allows
|
|
|
495 you to have several versions of XEmacs for any mix of
|
|
|
496 machines and operating systems installed at the same
|
|
|
497 time; this is useful for sites at which different
|
|
|
498 kinds of machines share the file system XEmacs is
|
|
|
499 installed on.
|
|
0
|
500
|
|
388
|
501 `/usr/local/lib/xemacs-VERSION/CONFIGURATION-NAME/modules' holds the Emacs
|
|
|
502 dynamically loadable modules. These are special programs
|
|
|
503 typically written in C that can be loaded in much the same
|
|
|
504 way that Lisp packages are. Not all systems support
|
|
|
505 dynamic modules, so do not be alarmed if this directory
|
|
|
506 does not exist or is empty.
|
|
|
507
|
|
|
508 XEmacs searches for modules in this directory, or any
|
|
|
509 sub-directory of it, and then in
|
|
|
510 `/usr/local/lib/xemacs/site-modules/*'.
|
|
|
511
|
|
0
|
512 `/usr/local/lib/xemacs-VERSION/info' holds the on-line documentation
|
|
|
513 for XEmacs, known as "info files".
|
|
|
514
|
|
|
515 `/usr/local/man/man1' holds the man pages for the programs installed
|
|
|
516 in `/usr/local/bin'.
|
|
|
517
|
|
|
518 If these directories are not what you want, you can specify where to
|
|
|
519 install XEmacs's libraries and data files or where XEmacs should search
|
|
|
520 for its lisp files by giving values for `make' variables as part of
|
|
442
|
521 the command.
|
|
0
|
522
|
|
|
523 You can change where the build process installs XEmacs and its data
|
|
|
524 files by specifying values for `make' variables as part of the `make'
|
|
|
525 command line. For example, if you type
|
|
|
526
|
|
|
527 make install bindir=/usr/local/gnubin
|
|
|
528
|
|
|
529 the `bindir=/usr/local/gnubin' argument indicates that the XEmacs
|
|
|
530 executable files should go in `/usr/local/gnubin', not
|
|
|
531 `/usr/local/bin'.
|
|
|
532
|
|
|
533 Here is a complete list of the variables you may want to set.
|
|
|
534
|
|
|
535 `bindir' indicates where to put executable programs that users can
|
|
|
536 run. This defaults to /usr/local/bin.
|
|
|
537
|
|
|
538 `datadir' indicates where to put the architecture-independent
|
|
|
539 read-only data files that XEmacs refers to while it runs; it
|
|
|
540 defaults to /usr/local/lib. We create the following
|
|
|
541 subdirectories under `datadir':
|
|
|
542 - `xemacs-VERSION/lisp', containing the XEmacs lisp libraries, and
|
|
|
543
|
|
|
544 - `xemacs-VERSION/etc', containing the XEmacs tutorial and the
|
|
|
545 `yow' database.
|
|
|
546 `VERSION' is the number of the XEmacs version you are installing,
|
|
|
547 like `18.59' or `19.14'. Since these files vary from one version
|
|
|
548 of XEmacs to another, including the version number in the path
|
|
|
549 allows you to have several versions of XEmacs installed at the
|
|
|
550 same time; this means that you don't have to make XEmacs
|
|
|
551 unavailable while installing a new version.
|
|
|
552
|
|
|
553 `statedir' indicates where to put architecture-independent data files
|
|
|
554 that XEmacs modifies while it runs; it defaults to
|
|
|
555 /usr/local/lib as well. We create the following
|
|
|
556 subdirectories under `statedir':
|
|
|
557 - `xemacs/lock', containing files indicating who is editing
|
|
|
558 what, so XEmacs can detect editing clashes between
|
|
|
559 users.
|
|
|
560
|
|
|
561 `libdir' indicates where to put architecture-specific data files that
|
|
|
562 XEmacs refers to as it runs; it too defaults to `/usr/local/lib'.
|
|
|
563 We create the following subdirectories under `libdir':
|
|
|
564 - `xemacs-VERSION/CONFIGURATION-NAME', containing executable
|
|
|
565 programs used by XEmacs that users are not expected to run
|
|
|
566 themselves and the DOC file.
|
|
|
567 `VERSION' is the number of the XEmacs version you are installing,
|
|
243
|
568 and `CONFIGURATION-NAME' is the host type of your system.
|
|
|
569 Since these files are specific to the version of XEmacs,
|
|
|
570 operating system, and architecture in use, including the
|
|
|
571 configuration name in the path allows you to have several
|
|
|
572 versions of XEmacs for any mix of machines and operating
|
|
|
573 systems installed at the same time; this is useful for sites
|
|
|
574 at which different kinds of machines share the file system
|
|
|
575 XEmacs is installed on.
|
|
0
|
576
|
|
|
577 `infodir' indicates where to put the info files distributed with
|
|
|
578 XEmacs; it defaults to `/usr/local/lib/xemacs-VERSION/info'.
|
|
|
579
|
|
|
580 `mandir' indicates where to put the man pages for XEmacs and its
|
|
|
581 utilities (like `etags'); it defaults to
|
|
|
582 `/usr/local/man/man1'.
|
|
|
583
|
|
|
584 `prefix' doesn't give a path for any specific part of XEmacs; instead,
|
|
|
585 its value is used to determine the defaults for all the
|
|
|
586 architecture-independent path variables - `datadir',
|
|
|
587 `statedir', `infodir', and `mandir'. Its default value is
|
|
|
588 `/usr/local'; the other variables add on `lib' or `man' to it
|
|
|
589 by default.
|
|
|
590
|
|
|
591 For example, suppose your site generally places GNU software
|
|
|
592 under `/usr/users/software/gnusoft' instead of `/usr/local'.
|
|
|
593 By including
|
|
|
594 `prefix=/usr/users/software/gnusoft'
|
|
|
595 in the arguments to `make', you can instruct the build process
|
|
|
596 to place all of the XEmacs data files in the appropriate
|
|
|
597 directories under that path.
|
|
|
598
|
|
|
599 `exec_prefix' serves the same purpose as `prefix', but instead
|
|
|
600 determines the default values for the architecture-dependent
|
|
|
601 path variables - `bindir' and `libdir'.
|
|
|
602
|
|
|
603 The above variables serve analogous purposes in the makefiles for all
|
|
|
604 GNU software; here are some variables specific to XEmacs.
|
|
|
605
|
|
|
606 `lispdir' indicates where XEmacs installs and expects its lisp
|
|
|
607 libraries. Its default value, based on `datadir' (see above),
|
|
|
608 is `/usr/local/lib/xemacs-VERSION/lisp' (where `VERSION' is as
|
|
|
609 described above).
|
|
|
610
|
|
|
611 `sitelispdir' indicates where XEmacs should search for lisp libraries
|
|
|
612 specific to your site. XEmacs checks them in order before
|
|
|
613 checking `lispdir'. Its default value, based on `datadir'
|
|
|
614 (see above), is `/usr/local/lib/xemacs/site-lisp'.
|
|
|
615
|
|
|
616 `etcdir' indicates where XEmacs should install and expect the rest of
|
|
|
617 its architecture-independent data, like the tutorial and yow
|
|
|
618 database. Its default value, based on `datadir'
|
|
|
619 (see above), is `/usr/local/lib/xemacs-VERSION/etc' (where
|
|
|
620 `VERSION' is as described above).
|
|
|
621
|
|
|
622 `lockdir' indicates the directory where XEmacs keeps track of its
|
|
|
623 locking information. Its default value, based on `statedir'
|
|
|
624 (see above), is `/usr/local/lib/xemacs/lock'.
|
|
|
625
|
|
|
626 `archlibdir' indicates where XEmacs installs and expects the
|
|
|
627 executable files and other architecture-dependent data it uses
|
|
|
628 while running. Its default value, based on `libdir' (see
|
|
|
629 above), is `/usr/local/lib/xemacs-VERSION/CONFIGURATION-NAME'
|
|
|
630 (where VERSION and CONFIGURATION-NAME are as described above).
|
|
|
631
|
|
420
|
632 `docdir' indicates where to put Lisp documentation strings that XEmacs
|
|
442
|
633 refers to as it runs. It defaults to the value of `archlibdir'
|
|
420
|
634 (see above).
|
|
|
635
|
|
388
|
636 `moduledir' indicates where XEmacs installs and expects to find
|
|
|
637 any dynamic modules. Its default value, based on
|
|
|
638 `archlibdir' (see above) is
|
|
|
639 `/usr/local/lib/xemacs-VERSION/CONFIGURATION-NAME/modules'
|
|
|
640 (where VERSION and CONFIGURATION-NAME are as described above).
|
|
|
641 By their very nature, dynamic loadable modules are architecture-
|
|
442
|
642 dependent, and care should be taken not to set this directory
|
|
|
643 to a system- or architecture-independent directory.
|
|
388
|
644
|
|
0
|
645 Remember that you must specify any variable values you need each time
|
|
|
646 you run `make' in the top directory. If you run `make' once to build
|
|
|
647 xemacs, test it, and then run `make' again to install the files, you
|
|
|
648 must provide the same variable settings each time. To make the
|
|
|
649 settings persist, you can edit them into the `Makefile' in the top
|
|
|
650 directory, but be aware that running the `configure' program erases
|
|
|
651 `Makefile' and rebuilds it from `Makefile.in'.
|
|
|
652
|
|
|
653 The top-level Makefile stores the variable settings it used in the
|
|
|
654 Makefiles for the subdirectories, so you don't have to specify them
|
|
|
655 when running make in the subdirectories.
|
|
|
656
|
|
442
|
657 Using GNU Make allows for simultaneous builds with and without the
|
|
|
658 --srcdir option.
|
|
0
|
659
|
|
442
|
660 MAIL-LOCKING POST-INSTALLATION
|
|
|
661 ==============================
|
|
0
|
662
|
|
442
|
663 If your system uses dot-locking to interlock access to mailer inbox
|
|
|
664 files, then you might need to make the movemail program setuid or
|
|
|
665 setgid to enable it to write the lock files. We believe this is safe.
|
|
|
666 The setuid/setgid bits need not be set on any other XEmacs-related
|
|
|
667 executables.
|
|
0
|
668
|
|
442
|
669 CLEANING UP
|
|
|
670 ==========
|
|
0
|
671
|
|
442
|
672 You are done with the hard part! You can remove executables and
|
|
|
673 object files from the build directory by typing `make clean'. To also
|
|
|
674 remove the files that `configure' created (so you can compile XEmacs
|
|
|
675 for a different configuration), type `make distclean'.
|
|
0
|
676
|
|
442
|
677 READ README.packages
|
|
|
678 ====================
|
|
0
|
679
|
|
442
|
680 Do it!
|
|
0
|
681
|
|
|
682 PROBLEMS
|
|
442
|
683 ========
|
|
398
|
684
|
|
424
|
685 The most likely problem is that you forgot to read and follow the
|
|
|
686 directions in README.packages. You can not have a working XEmacs
|
|
|
687 without downloading some additional packages.
|
|
|
688
|
|
0
|
689 See the file PROBLEMS in this directory for a list of various
|
|
|
690 problems sometimes encountered, and what to do about them.
|
