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