|
0
|
1 XEmacs Installation Guide
|
|
|
2 Copyright (c) 1994, 1995, 1996 Board of Trustees, University of Illinois
|
|
|
3 Copyright (c) 1994 Free Software Foundation, Inc.
|
|
|
4
|
|
|
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
|
|
|
19 BUILDING AND INSTALLATION:
|
|
|
20
|
|
|
21 1) Make sure your system has enough swapping space allocated to handle
|
|
|
22 a program whose pure code is 900k bytes and whose data area is at
|
|
|
23 least 400k and can reach 8Mb or more. If the swapping space is
|
|
|
24 insufficient, you will get an error in the command `temacs -batch -l
|
|
|
25 loadup dump', found in `./src/Makefile.in.in', or possibly when
|
|
|
26 running the final dumped XEmacs.
|
|
|
27
|
|
|
28 Building XEmacs requires about 70 Mb of disk space (including the
|
|
|
29 XEmacs sources). Once installed, XEmacs occupies about 50 Mb in the
|
|
|
30 file system where it is installed; this includes the executable files,
|
|
|
31 Lisp libraries, miscellaneous data files, and on-line documentation.
|
|
|
32 If the building and installation take place in different directories,
|
|
|
33 then the installation procedure momentarily requires 70+50 Mb.
|
|
|
34
|
|
|
35 XEmacs requires an ANSI C compiler, such as LCC or GCC.
|
|
|
36
|
|
|
37 2) Consult `./etc/MACHINES' to see what configuration name you should
|
|
|
38 give to the `configure' program. That file offers hints for
|
|
|
39 getting around some possible installation problems.
|
|
|
40
|
|
|
41 3) In the top directory of the XEmacs distribution, run the program
|
|
|
42 `configure' as follows:
|
|
|
43
|
|
|
44 ./configure CONFIGURATION-NAME [--OPTION[=VALUE]] ...
|
|
|
45
|
|
|
46 The CONFIGURATION-NAME argument should be a configuration name given
|
|
|
47 in `./etc/MACHINES'. If omitted, `configure' will try to guess your
|
|
|
48 system type; if it cannot, you must find the appropriate configuration
|
|
|
49 name in `./etc/MACHINES' and specify it explicitly.
|
|
|
50
|
|
|
51 If you don't want X support, specify `--with-x=no'. If you omit this
|
|
|
52 option, `configure' will try to figure out for itself whether your
|
|
|
53 system has X, and arrange to use it if present.
|
|
|
54
|
|
|
55 Additional support can be included for the NeXTstep system by
|
|
50
|
56 specifying the flag `--with-ns'. This was never implemented, and code
|
|
|
57 referencing it has been removed from XEmacs 20.3.
|
|
0
|
58
|
|
|
59 The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build
|
|
|
60 process where the compiler should look for the include files and
|
|
|
61 object libraries used with the X Window System. Normally, `configure'
|
|
|
62 is able to find them; these options are necessary if you have your X
|
|
|
63 Window System files installed in unusual places.
|
|
|
64
|
|
|
65 The `--site-includes=DIR' and `--site-libraries=DIR' options allow you
|
|
|
66 to specify additional places the compiler should look for include
|
|
|
67 files and object libraries. You may specify multiple DIR's by
|
|
|
68 enclosing the list in quotes. On some systems (noticeably Solaris) you
|
|
|
69 may need to use `--site-runtime-libraries=DIR'. This will add -R
|
|
|
70 versions of each path in addition to the -L versions.
|
|
|
71
|
|
|
72 The `--with-gcc' option specifies that the build process should
|
|
|
73 compile XEmacs using GCC. The `--with-lcc' option specifies that the
|
|
|
74 build process should compile XEmacs using Lucid C. The `--compiler'
|
|
|
75 option allows you to specify some other compiler to be used to compile
|
|
|
76 XEmacs. It is compatible with both the `--with-gcc' and `--with-lcc'
|
|
|
77 options, so if the compiler that you specify is a special version of
|
|
|
78 either gcc or lcc, then use the appropriate --with-gcc or --with-lcc
|
|
|
79 flag as well as the --compiler flag. If none of these flags is
|
|
|
80 specified, `configure' will search for GCC in your load path, and use
|
|
|
81 it if present. If you don't want to use GCC, specify `--with-gcc=no'
|
|
|
82 and the compiler will then default to 'cc'.
|
|
|
83
|
|
|
84 The `--cflags' option specifies the CFLAGS the build process should
|
|
|
85 use when compiling XEmacs. If not used CFLAGS defaults to "-g -O" for
|
|
|
86 gcc and "-g" for all other compilers.
|
|
|
87
|
|
|
88 The `--with-gnu-make' option specifies that Makefiles should be
|
|
|
89 written to take advantage of special features of GNU Make. GNU Make
|
|
|
90 works fine on Makefiles even without this option. This flag just
|
|
|
91 allows for simultaneous in-place and --srcdir building.
|
|
|
92
|
|
|
93 The `--dynamic' option specifies that configure should try to link
|
|
|
94 emacs dynamically rather than statically.
|
|
|
95
|
|
|
96 The `--const-is-losing' option is for use if you have trouble
|
|
|
97 compiling due to the `const' storage class in C. This is defined by
|
|
|
98 default. Most users should have no need to change this.
|
|
|
99
|
|
|
100 You can build XEmacs for several different machine types from a single
|
|
|
101 source directory. To do this, you must use a version of `make' that
|
|
|
102 supports the `VPATH' variable, such as GNU `make'. Make separate
|
|
|
103 build directories for the different configuration types, and in each
|
|
|
104 one, run the XEmacs `configure' script. `configure' looks for the
|
|
|
105 Emacs source code in the directory that `configure' is in.
|
|
|
106
|
|
|
107 The `--prefix=PREFIXDIR' option specifies where the installation process
|
|
|
108 should put XEmacs and its data files. This defaults to `/usr/local'.
|
|
|
109 - XEmacs (and the other utilities users run) go in PREFIXDIR/bin
|
|
|
110 (unless the `--exec-prefix' option says otherwise).
|
|
|
111 - The architecture-independent files go in PREFIXDIR/lib/xemacs-VERSION
|
|
|
112 (where VERSION is the version number of XEmacs, like `19.14').
|
|
|
113 - The architecture-dependent files go in
|
|
|
114 PREFIXDIR/lib/xemacs-VERSION/CONFIGURATION
|
|
|
115 (where CONFIGURATION is the configuration name, like mips-dec-ultrix4.2),
|
|
|
116 unless the `--exec-prefix' option says otherwise.
|
|
|
117
|
|
|
118 The `--exec-prefix=EXECDIR' option allows you to specify a separate
|
|
|
119 portion of the directory tree for installing architecture-specific
|
|
|
120 files, like executables and utility programs. If specified,
|
|
|
121 - XEmacs (and the other utilities users run) go in EXECDIR/bin, and
|
|
|
122 - The architecture-dependent files go in
|
|
|
123 EXECDIR/lib/xemacs-VERSION/CONFIGURATION.
|
|
|
124 EXECDIR/bin should be a directory that is normally in users' PATHs.
|
|
|
125
|
|
|
126 For example, the command
|
|
|
127
|
|
|
128 ./configure mips-dec-ultrix --with-x
|
|
|
129
|
|
|
130 configures XEmacs to build for a DECstation running Ultrix, with
|
|
|
131 support for the X11 window system.
|
|
|
132
|
|
|
133 The `--run-in-place' option will make the installed binaries reference
|
|
|
134 the source tree for the elisp files.
|
|
|
135
|
|
|
136 The `--with-menubars=TYPE' option allows you to specify which X
|
|
|
137 toolkit you wish to use for the menubar. The valid options are
|
|
|
138 `lucid', `motif' and `none'. The default is `lucid' which is a
|
|
|
139 Motif-lookalike menubar. We highly recommend its usage over the real
|
|
|
140 Motif menubar. (In fact, the Motif menubar is currently broken.) If
|
|
|
141 `none' is specified then support for menubars will not be compiled in.
|
|
|
142
|
|
|
143 The `--with-scrollbars=TYPE' option allows you to specify which X
|
|
|
144 toolkit you wish to use for the scrollbars. The valid options are
|
|
|
145 `lucid', `motif', `athena' and `none'. The default is `lucid' which
|
|
|
146 is a Motif-lookalike scrollbar. If `none' is specified then support
|
|
|
147 for scrollbars will not be compiled in.
|
|
|
148
|
|
|
149 The `--with-dialogs=TYPE' option allows you to specify which X toolkit
|
|
|
150 you wish to use for the scrollbars. The valid options are `athena',
|
|
|
151 `motif, and `none. The `lucid' option is accepted and will result in
|
|
|
152 the `athena' toolkit being used. If the Motif toolkit can be found
|
|
|
153 the default is `motif'. Otherwise, the default is `athena'. If
|
|
|
154 `none' is specified then support for dialog boxes will not be compiled
|
|
|
155 in.
|
|
|
156
|
|
|
157 The `--with-toolbars' option allows you to enable or disable toolbar
|
|
|
158 support. The default is `yes' as long as support for a windowing
|
|
|
159 system is included.
|
|
|
160
|
|
|
161 The `--with-xpm' option specifies that XEmacs should support X
|
|
|
162 Pixmaps. `configure' will attempt to detect if you have the Xpm
|
|
|
163 libraries and define `--with-xpm' for you.
|
|
|
164
|
|
|
165 The `--with-xface' option specifies that XEmacs should support
|
|
|
166 X-Faces. `configure' will attempt to detect if you have the compface
|
|
|
167 library and define `--with-xface' for you.
|
|
|
168
|
|
|
169 The `--with-gif' option specifies that XEmacs should support GIF image
|
|
|
170 conversion. No extra libraries are required. This options defaults
|
|
|
171 to `yes'.
|
|
|
172
|
|
|
173 The `--with-jpeg' option specifies that XEmacs should support JPEG
|
|
|
174 image conversion. This option requires libjpeg from the Independent
|
|
|
175 JPEG Group which is available on the XEmacs ftp site. `configure'
|
|
|
176 will attempt to detect if you have libjpeg and define `--with-jpeg'
|
|
|
177 for you.
|
|
|
178
|
|
|
179 The `--with-png option specifies that XEmacs should support PNG image
|
|
|
180 conversion. The valid options at `yes', `no' and `gnuz'. This option
|
|
|
181 requires libpng which is available on the XEmacs ftp site. This
|
|
|
182 option also requires a decompression library, either libz or libgz.
|
|
|
183 The default is to use libz. Specify `gnuz' as the option to use libgz
|
|
|
184 instead. `configure' will attempt to detect if you have libpng and
|
|
|
185 define `--with-png' for you.
|
|
|
186
|
|
|
187 The `--with-database' option specifies that XEmacs should be built
|
|
|
188 with additional database support. The valid options are `no' or a
|
|
|
189 comma-separated list of one or more of `dbm', `gnudbm' or `berkdb'.
|
|
|
190 `configure' will attempt to detect the necessary libraries and header
|
|
|
191 files and define `--with-database' for you.
|
|
|
192
|
|
|
193 The `--with-socks' option specifies that XEmacs should be built with
|
|
|
194 SOCKS support.
|
|
|
195
|
|
|
196 The `--with-term' option specifies that XEmacs should be built with
|
|
|
197 TERM support. TERM is a way to multiplex serial lines over a simple
|
|
|
198 dialup connection, used on Linux and other systems. We cannot
|
|
|
199 guarantee that our TERM support coexists well with standard Internet
|
|
|
200 connections.
|
|
|
201
|
|
|
202 The `--with-tooltalk' option specifies that XEmacs should be built
|
|
|
203 with ToolTalk support for interconnecting with other applications.
|
|
|
204 ToolTalk is not yet supported on all architectures.
|
|
|
205
|
|
|
206 The `--with-sparcworks' option specifies that XEmacs should be built
|
|
|
207 with support for Sun Sparcworks 3.0.1 and up. This functionality is
|
|
|
208 only of use on SunOS 4.1.x and Solaris 2.x systems.
|
|
|
209
|
|
|
210 The `--with-cde option allows you to enable or disable CDE drag and
|
|
|
211 drop support. `configure' will attempt to detect this option and
|
|
|
212 define `--with-cde' for you.
|
|
|
213
|
|
2
|
214 The `--with-offix option allows you to enable or disable OffiX drag and
|
|
|
215 drop support. `configure' will attempt to detect this option and
|
|
|
216 define `--with-offix' for you.
|
|
|
217
|
|
0
|
218 The `--with-energize' option specifies that XEmacs should be built
|
|
|
219 with support for the Lucid Energize system. (If you have not
|
|
|
220 purchased Energize, specifying this option won't gain you anything.)
|
|
50
|
221 This doesn't work and has been removed from XEmacs 20.3.
|
|
0
|
222
|
|
|
223 The `--external-widget' option specifies that XEmacs should be built
|
|
50
|
224 with support for being used as a widget. This apparently doesn't work.
|
|
0
|
225
|
|
|
226 The `--with-mocklisp' option specifies that XEmacs should be built
|
|
|
227 with support for Mocklisp. Do not use this option unless you have a
|
|
50
|
228 Mocklisp program that you need to run. Mocklisp support has been removed
|
|
|
229 as of XEmacs 20.3.
|
|
0
|
230
|
|
|
231 The `--with-xmu=no' option can be used if your vendor doesn't ship
|
|
|
232 the Xmu library.
|
|
|
233
|
|
|
234 The `--puresize' option can be used to change the amount of purespace
|
|
|
235 allocated for the dumped XEmacs.
|
|
|
236
|
|
|
237 The `--with-sound=TYPE' option specifies that XEmacs should be built
|
|
|
238 with sound support. Native (`--with-sound=native') sound support is
|
|
|
239 currently available only on Sun SparcStations, SGI's, HP9000s, and
|
|
|
240 Linux. Network Audio Support (NAS) (`--with-sound=nas' or
|
|
|
241 `--with-sound=both') is an extension to X that you may or may not have
|
|
|
242 for your system. For NAS, you will probably need to provide the paths
|
|
|
243 to the nas include and library directories to configure. `configure'
|
|
|
244 will attempt to determine if your configuration supports sound and
|
|
|
245 define --with-sound for you. If your native sound library is not in a
|
|
|
246 standard location you can specify where it is with the
|
|
|
247 `--native-sound-lib=LIB' flag. For Linux, `/dev/audio' is required
|
|
|
248 for SunAudio files and `/dev/dsp' is required for raw data and WAVE
|
|
|
249 format files.
|
|
|
250
|
|
|
251 The `--rel-alloc' option can be used to either enable or disable use
|
|
|
252 of the relocating allocator. Generally, it's best to go with the
|
|
|
253 default configuration for your system.
|
|
|
254
|
|
|
255 The `--use-system-malloc' option can be use to either enable or
|
|
|
256 disable use of the relocating allocator. Generally, it's best to go
|
|
|
257 with the default configuration for your system. Note that on many
|
|
|
258 systems using the system malloc disables the use of the relocating
|
|
|
259 allocator.
|
|
|
260
|
|
|
261 The `--with-epoch' option enables functionality taken from Epoch.
|
|
50
|
262 Currently this doesn't work and the option has been removed from XEmacs 20.3.
|
|
0
|
263
|
|
|
264 The `--debug' and `--error-checking' options are intended for use only
|
|
|
265 by the developers. `--debug' adds code to be compiled in for
|
|
|
266 performing various tests. `--error-checking' adds additional tests to
|
|
|
267 many of the commonly used macros.
|
|
|
268
|
|
|
269 The `--verbose' and `--extra-verbose' options are intended for use
|
|
|
270 only by the developers. `--verbose' causes the results of all
|
|
|
271 configure tests to be displayed. `--extra-verbose' also displays the
|
|
|
272 output of any compiler invocations done by configure.
|
|
|
273
|
|
|
274 `configure' doesn't do any compilation or installation
|
|
|
275 itself. It just creates the files that influence those things:
|
|
|
276 `./Makefile', `src/Makefile', `lwlib/Makefile', `lib-src/Makefile',
|
|
|
277 `man/Makefile', `dynodump/Makefile', and `./src/config.h'. For
|
|
|
278 details on exactly what it does, see the section called `CONFIGURATION
|
|
|
279 BY HAND', below.
|
|
|
280
|
|
|
281 When it is done, `configure' prints a description of what it did and
|
|
|
282 creates a shell script `config.status' which, when run, recreates the
|
|
|
283 same configuration. If `configure' exits with an error after
|
|
|
284 disturbing the status quo, it removes `config.status'.
|
|
|
285
|
|
|
286 The work of `configure' can be done by editing various files in the
|
|
|
287 distribution, but using `configure' is supposed to be simpler. See
|
|
|
288 the section called "CONFIGURATION BY HAND" below if you want to do the
|
|
|
289 configuration yourself.
|
|
|
290
|
|
|
291 4) Look at `./lisp/paths.el'; if some of those values are not right
|
|
|
292 for your system, set up the file `./lisp/site-init.el' with XEmacs
|
|
|
293 Lisp code to override them; it is not a good idea to edit paths.el
|
|
|
294 itself. YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES,
|
|
|
295 rather than `defvar', as used by `./lisp/paths.el'. For example,
|
|
|
296
|
|
|
297 (setq news-inews-program "/usr/bin/inews")
|
|
|
298
|
|
|
299 is how you would override the default value of the variable
|
|
|
300 news-inews-program (which is "/usr/local/inews").
|
|
|
301
|
|
|
302 Before you override a variable this way, *look at the value* that the
|
|
|
303 variable gets by default! Make sure you know what kind of value the
|
|
|
304 variable should have. If you don't pay attention to what you are
|
|
|
305 doing, you'll make a mistake.
|
|
|
306
|
|
|
307 Things may malfunction if the variable `directory-abbrev-alist' is not set
|
|
|
308 up to translate "temporary" automounter mount points into the canonical
|
|
|
309 form. The default value of this variable contains the translation
|
|
|
310
|
|
|
311 ("^/tmp_mnt/" . "/")
|
|
|
312
|
|
|
313 meaning translate "/tmp_mnt/net/FOO" into "/net/FOO", which is appropriate
|
|
|
314 for the default configuration of the Sun automounter, but which may be
|
|
|
315 inappropriate for different vendor's automounters, or if you have customized
|
|
|
316 your mount-point names.
|
|
|
317
|
|
|
318 5) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs
|
|
|
319 Lisp code you want XEmacs to load before it is dumped out. Use
|
|
|
320 site-load.el for additional libraries if you arrange for their
|
|
|
321 documentation strings to be in the lib-src/DOC file (see
|
|
|
322 src/Makefile.in.in if you wish to figure out how to do that). For all
|
|
|
323 else, use site-init.el.
|
|
|
324
|
|
|
325 If you set load-path to a different value in site-init.el or
|
|
|
326 site-load.el, XEmacs will use *precisely* that value when it starts up
|
|
|
327 again. If you do this, you are on your own!
|
|
|
328
|
|
|
329 Note that, on some systems, the code you place in site-init.el must
|
|
|
330 not use expand-file-name or any other function which may look
|
|
|
331 something up in the system's password and user information database.
|
|
|
332 See `./PROBLEMS' for more details on which systems this affects.
|
|
|
333
|
|
|
334 The `site-*.el' files are nonexistent in the distribution. You do not
|
|
|
335 need to create them if you have nothing to put in them.
|
|
|
336
|
|
|
337 6) Refer to the file `./etc/TERMS' for information on fields you may
|
|
|
338 wish to add to various termcap entries. The files `./etc/termcap.ucb'
|
|
|
339 and `./etc/termcap.dat' may already contain appropriately-modified
|
|
|
340 entries.
|
|
|
341
|
|
|
342 7) Run `make' in the top directory of the XEmacs distribution to finish
|
|
|
343 building XEmacs in the standard way. The final executable file is
|
|
|
344 named `src/emacs'. You can execute this file "in place" without
|
|
|
345 copying it, if you wish; then it automatically uses the sibling
|
|
|
346 directories ../lisp, ../lib-src, ../info.
|
|
|
347
|
|
|
348 Or you can "install" the executable and the other XEmacs into their
|
|
|
349 installed locations, with `make install'. By default, XEmacs's files
|
|
|
350 are installed in the following directories:
|
|
|
351
|
|
|
352 By default, XEmacs installs its files in the following directories:
|
|
|
353
|
|
|
354 `/usr/local/bin' holds the executable programs users normally run -
|
|
|
355 `xemacs', `etags', `ctags', `b2m', `emacsclient',
|
|
|
356 `gnuclient', `gnudoit', `gnuattach', and `rcs-checkin'.
|
|
|
357
|
|
|
358 `/usr/local/lib/xemacs-VERSION/lisp' holds the Emacs Lisp libraries;
|
|
|
359 `VERSION' stands for the number of the XEmacs version
|
|
|
360 you are installing, like `18.59' or `19.14'. Since
|
|
|
361 the lisp libraries change from one version of XEmacs to
|
|
|
362 another, including the version number in the path
|
|
|
363 allows you to have several versions of XEmacs installed
|
|
|
364 at the same time; this means that you don't have to
|
|
|
365 make XEmacs unavailable while installing a new version.
|
|
|
366
|
|
|
367 XEmacs searches for its lisp files in these
|
|
|
368 directories, and then in
|
|
|
369 `/usr/local/lib/xemacs/site-lisp/*'.
|
|
|
370
|
|
|
371 `/usr/local/lib/xemacs-VERSION/etc' holds the XEmacs tutorial, the
|
|
|
372 `yow' database, and other architecture-independent
|
|
|
373 files XEmacs might need while running. VERSION is as
|
|
|
374 specified for `.../lisp'.
|
|
|
375
|
|
|
376 `/usr/local/lib/xemacs/lock' contains files indicating who is
|
|
|
377 editing what, so XEmacs can detect editing clashes
|
|
|
378 between users.
|
|
|
379
|
|
|
380 `/usr/local/lib/xemacs-VERSION/CONFIGURATION-NAME' contains executable
|
|
|
381 programs used by XEmacs that users are not expected to
|
|
|
382 run themselves, and the DOC file. `VERSION' is the
|
|
|
383 number of the XEmacs version you are installing, and
|
|
|
384 `CONFIGURATION-NAME' is the argument you gave to the
|
|
|
385 `configure' program to identify the architecture and
|
|
|
386 operating system of your machine, like
|
|
|
387 `mips-dec-ultrix' or `sparc-sun-sunos'. Since these
|
|
|
388 files are specific to the version of XEmacs, operating
|
|
|
389 system, and architecture in use, including the
|
|
|
390 configuration name in the path allows you to have
|
|
|
391 several versions of XEmacs for any mix of machines and
|
|
|
392 operating systems installed at the same time; this is
|
|
|
393 useful for sites at which different kinds of machines
|
|
|
394 share the file system XEmacs is installed on.
|
|
|
395
|
|
|
396 `/usr/local/lib/xemacs-VERSION/info' holds the on-line documentation
|
|
|
397 for XEmacs, known as "info files".
|
|
|
398
|
|
|
399 `/usr/local/man/man1' holds the man pages for the programs installed
|
|
|
400 in `/usr/local/bin'.
|
|
|
401
|
|
|
402 If these directories are not what you want, you can specify where to
|
|
|
403 install XEmacs's libraries and data files or where XEmacs should search
|
|
|
404 for its lisp files by giving values for `make' variables as part of
|
|
|
405 the command. See the section below called `MAKE VARIABLES' for more
|
|
|
406 information on this.
|
|
|
407
|
|
|
408 8) If your system uses lock files to interlock access to mailer inbox files,
|
|
|
409 then you might need to make the movemail program setuid or setgid
|
|
|
410 to enable it to write the lock files. We believe this is safe.
|
|
|
411 The setuid/setgid bits need not be set on any other XEmacs-related
|
|
|
412 executables.
|
|
|
413
|
|
|
414 9) You are done! You can remove executables and object files from
|
|
|
415 the build directory by typing `make clean'. To also remove the files
|
|
|
416 that `configure' created (so you can compile XEmacs for a different
|
|
|
417 configuration), type `make distclean'.
|
|
|
418
|
|
|
419
|
|
|
420 MAKE VARIABLES
|
|
|
421
|
|
|
422 You can change where the build process installs XEmacs and its data
|
|
|
423 files by specifying values for `make' variables as part of the `make'
|
|
|
424 command line. For example, if you type
|
|
|
425
|
|
|
426 make install bindir=/usr/local/gnubin
|
|
|
427
|
|
|
428 the `bindir=/usr/local/gnubin' argument indicates that the XEmacs
|
|
|
429 executable files should go in `/usr/local/gnubin', not
|
|
|
430 `/usr/local/bin'.
|
|
|
431
|
|
|
432 Here is a complete list of the variables you may want to set.
|
|
|
433
|
|
|
434 `bindir' indicates where to put executable programs that users can
|
|
|
435 run. This defaults to /usr/local/bin.
|
|
|
436
|
|
|
437 `datadir' indicates where to put the architecture-independent
|
|
|
438 read-only data files that XEmacs refers to while it runs; it
|
|
|
439 defaults to /usr/local/lib. We create the following
|
|
|
440 subdirectories under `datadir':
|
|
|
441 - `xemacs-VERSION/lisp', containing the XEmacs lisp libraries, and
|
|
|
442
|
|
|
443 - `xemacs-VERSION/etc', containing the XEmacs tutorial and the
|
|
|
444 `yow' database.
|
|
|
445 `VERSION' is the number of the XEmacs version you are installing,
|
|
|
446 like `18.59' or `19.14'. Since these files vary from one version
|
|
|
447 of XEmacs to another, including the version number in the path
|
|
|
448 allows you to have several versions of XEmacs installed at the
|
|
|
449 same time; this means that you don't have to make XEmacs
|
|
|
450 unavailable while installing a new version.
|
|
|
451
|
|
|
452 `statedir' indicates where to put architecture-independent data files
|
|
|
453 that XEmacs modifies while it runs; it defaults to
|
|
|
454 /usr/local/lib as well. We create the following
|
|
|
455 subdirectories under `statedir':
|
|
|
456 - `xemacs/lock', containing files indicating who is editing
|
|
|
457 what, so XEmacs can detect editing clashes between
|
|
|
458 users.
|
|
|
459
|
|
|
460 `libdir' indicates where to put architecture-specific data files that
|
|
|
461 XEmacs refers to as it runs; it too defaults to `/usr/local/lib'.
|
|
|
462 We create the following subdirectories under `libdir':
|
|
|
463 - `xemacs-VERSION/CONFIGURATION-NAME', containing executable
|
|
|
464 programs used by XEmacs that users are not expected to run
|
|
|
465 themselves and the DOC file.
|
|
|
466 `VERSION' is the number of the XEmacs version you are installing,
|
|
|
467 and `CONFIGURATION-NAME' is the argument you gave to the
|
|
|
468 `configure' program to identify the architecture and operating
|
|
|
469 system of your machine, like `mips-dec-ultrix' or
|
|
|
470 `sparc-sun-sunos'. Since these files are specific to the version
|
|
|
471 of XEmacs, operating system, and architecture in use, including
|
|
|
472 the configuration name in the path allows you to have several
|
|
|
473 versions of XEmacs for any mix of machines and operating systems
|
|
|
474 installed at the same time; this is useful for sites at which
|
|
|
475 different kinds of machines share the file system XEmacs is
|
|
|
476 installed on.
|
|
|
477
|
|
|
478 `infodir' indicates where to put the info files distributed with
|
|
|
479 XEmacs; it defaults to `/usr/local/lib/xemacs-VERSION/info'.
|
|
|
480
|
|
|
481 `mandir' indicates where to put the man pages for XEmacs and its
|
|
|
482 utilities (like `etags'); it defaults to
|
|
|
483 `/usr/local/man/man1'.
|
|
|
484
|
|
|
485 `prefix' doesn't give a path for any specific part of XEmacs; instead,
|
|
|
486 its value is used to determine the defaults for all the
|
|
|
487 architecture-independent path variables - `datadir',
|
|
|
488 `statedir', `infodir', and `mandir'. Its default value is
|
|
|
489 `/usr/local'; the other variables add on `lib' or `man' to it
|
|
|
490 by default.
|
|
|
491
|
|
|
492 For example, suppose your site generally places GNU software
|
|
|
493 under `/usr/users/software/gnusoft' instead of `/usr/local'.
|
|
|
494 By including
|
|
|
495 `prefix=/usr/users/software/gnusoft'
|
|
|
496 in the arguments to `make', you can instruct the build process
|
|
|
497 to place all of the XEmacs data files in the appropriate
|
|
|
498 directories under that path.
|
|
|
499
|
|
|
500 `exec_prefix' serves the same purpose as `prefix', but instead
|
|
|
501 determines the default values for the architecture-dependent
|
|
|
502 path variables - `bindir' and `libdir'.
|
|
|
503
|
|
|
504 The above variables serve analogous purposes in the makefiles for all
|
|
|
505 GNU software; here are some variables specific to XEmacs.
|
|
|
506
|
|
|
507 `lispdir' indicates where XEmacs installs and expects its lisp
|
|
|
508 libraries. Its default value, based on `datadir' (see above),
|
|
|
509 is `/usr/local/lib/xemacs-VERSION/lisp' (where `VERSION' is as
|
|
|
510 described above).
|
|
|
511
|
|
|
512 `sitelispdir' indicates where XEmacs should search for lisp libraries
|
|
|
513 specific to your site. XEmacs checks them in order before
|
|
|
514 checking `lispdir'. Its default value, based on `datadir'
|
|
|
515 (see above), is `/usr/local/lib/xemacs/site-lisp'.
|
|
|
516
|
|
|
517 `etcdir' indicates where XEmacs should install and expect the rest of
|
|
|
518 its architecture-independent data, like the tutorial and yow
|
|
|
519 database. Its default value, based on `datadir'
|
|
|
520 (see above), is `/usr/local/lib/xemacs-VERSION/etc' (where
|
|
|
521 `VERSION' is as described above).
|
|
|
522
|
|
|
523 `lockdir' indicates the directory where XEmacs keeps track of its
|
|
|
524 locking information. Its default value, based on `statedir'
|
|
|
525 (see above), is `/usr/local/lib/xemacs/lock'.
|
|
|
526
|
|
|
527 `archlibdir' indicates where XEmacs installs and expects the
|
|
|
528 executable files and other architecture-dependent data it uses
|
|
|
529 while running. Its default value, based on `libdir' (see
|
|
|
530 above), is `/usr/local/lib/xemacs-VERSION/CONFIGURATION-NAME'
|
|
|
531 (where VERSION and CONFIGURATION-NAME are as described above).
|
|
|
532
|
|
|
533 Remember that you must specify any variable values you need each time
|
|
|
534 you run `make' in the top directory. If you run `make' once to build
|
|
|
535 xemacs, test it, and then run `make' again to install the files, you
|
|
|
536 must provide the same variable settings each time. To make the
|
|
|
537 settings persist, you can edit them into the `Makefile' in the top
|
|
|
538 directory, but be aware that running the `configure' program erases
|
|
|
539 `Makefile' and rebuilds it from `Makefile.in'.
|
|
|
540
|
|
|
541 The top-level Makefile stores the variable settings it used in the
|
|
|
542 Makefiles for the subdirectories, so you don't have to specify them
|
|
|
543 when running make in the subdirectories.
|
|
|
544
|
|
|
545
|
|
|
546 CONFIGURATION BY HAND
|
|
|
547
|
|
|
548 Instead of running the `configure' program, you have to perform the
|
|
|
549 following steps.
|
|
|
550
|
|
|
551 1) Copy `./src/config.h.in' to `./src/config.h'.
|
|
|
552
|
|
|
553 2) Consult `./etc/MACHINES' to see what configuration name you should
|
|
|
554 use for your system. Look at the code of the `configure' script to
|
|
|
555 see which operating system and architecture description files from
|
|
|
556 `src/s' and `src/m' should be used for that configuration name. Edit
|
|
|
557 `src/config.h', and change the two `#include' directives to include
|
|
|
558 the appropriate system and architecture description files.
|
|
|
559
|
|
|
560 2) Edit `./src/config.h' to set the right options for your system. If
|
|
|
561 you need to override any of the definitions in the s/*.h and m/*.h
|
|
|
562 files for your system and machine, do so by editing config.h, not by
|
|
|
563 changing the s/*.h and m/*.h files. Occasionally you may need to
|
|
|
564 redefine parameters used in `./lib-src/movemail.c'.
|
|
|
565
|
|
|
566 3) If you're going to use the make utility to build XEmacs, you will
|
|
|
567 still need to run `configure' first, giving the appropriate values for
|
|
|
568 the variables in the sections entitled "Things `configure' Might Edit"
|
|
|
569 and "Where To Install Things." Note that you may only need to change
|
|
|
570 the variables `prefix' and `exec_prefix', since the rest of the
|
|
|
571 variables have reasonable defaults based on them. For each Makefile
|
|
|
572 variable of this type, there is a corresponding configure option; for
|
|
|
573 example, to change the location of the lock directory, you might use
|
|
|
574
|
|
|
575 ./configure --lockdir=/nfs/xemacslock
|
|
|
576
|
|
|
577 The `configure' script is built from `configure.in' by the `autoconf'
|
|
|
578 program. However, since XEmacs has configuration requirements that
|
|
|
579 autoconf can't meet, `configure.in' uses an marriage of custom-baked
|
|
|
580 configuration code and autoconf macros. New versions of autoconf
|
|
|
581 could very well break this arrangement, so it may be wise to avoid
|
|
|
582 rebuilding `configure' from `configure.in' when possible.
|
|
|
583
|
|
|
584
|
|
|
585 BUILDING XEMACS BY HAND
|
|
|
586
|
|
|
587 Once XEmacs is configured, running `make' in the top directory performs
|
|
|
588 the following steps.
|
|
|
589
|
|
|
590 1) Run `make src/paths.h' in the top directory. This produces
|
|
|
591 `./src/paths.h' from the template file `./src/paths.h.in', changing
|
|
|
592 the paths to the values specified in `./Makefile'.
|
|
|
593
|
|
|
594 2) Cd to `./lib-src' and run `make'. This creates executables named
|
|
|
595 `ctags' and `etags' and `wakeup' and `make-docfile' and `digest-doc'
|
|
|
596 and `test-distrib'. And others.
|
|
|
597
|
|
|
598 3) Cd to `./src' and Run `make'. This refers to files in the `./lisp'
|
|
|
599 and `./lib-src' subdirectories using names `../lisp' and
|
|
|
600 `../lib-src'.
|
|
|
601
|
|
|
602 This creates a file `./src/xemacs' which is the runnable XEmacs,
|
|
|
603 assigning it a new build version number by incrementing the build
|
|
|
604 version stored in `./lisp/version.el'.
|
|
|
605
|
|
|
606 It also creates a file in `./lib-src' whose name is `DOC' followed by
|
|
|
607 the current XEmacs version. This file contains documentation strings
|
|
|
608 for all the functions in XEmacs. Each time you run make to make a new
|
|
|
609 xemacs, a new DOC file with a new name is made. You must keep the DOC
|
|
|
610 file for an XEmacs version as long as you keep using that XEmacs
|
|
|
611 version.
|
|
|
612
|
|
|
613
|
|
|
614 INSTALLATION BY HAND
|
|
|
615
|
|
|
616 The steps below are done by running `make install' in the main
|
|
|
617 directory of the XEmacs distribution.
|
|
|
618
|
|
|
619 1) Copy `./lisp' and its subdirectories, `./etc', and the executables
|
|
|
620 in `./lib-src' to their final destinations, as selected in `./src/paths.h'.
|
|
|
621
|
|
|
622 Strictly speaking, not all of the executables in `./lib-src' need be copied.
|
|
|
623 - The programs `cvtmail', `emacsserver', `env', `fakemail', `hexl',
|
|
|
624 `movemail', `timer', `vcdiff', `wakeup', and `yow' are used by
|
|
|
625 XEmacs; they do need to be copied.
|
|
|
626 - The programs `etags', `ctags', `emacsclient', `b2m', `rcs2log',
|
|
|
627 `gnuclient', `gnudoit', and `gnuattach' are intended to be run
|
|
|
628 by users; they are handled below.
|
|
|
629 - The programs `make-docfile' and `test-distrib' were
|
|
|
630 used in building XEmacs, and are not needed any more.
|
|
|
631 - The programs `digest-doc' and `sorted-doc' convert a `DOC' file into
|
|
|
632 a file for users to read. There is no important reason to move them.
|
|
|
633
|
|
|
634 2) Copy the files in `./info' to the place specified in
|
|
|
635 `./lisp/site-init.el' or `./lisp/paths.el'. Note that if the
|
|
|
636 destination directory already contains a file named `dir', you
|
|
|
637 probably don't want to replace it with the `dir' file in the XEmacs
|
|
|
638 distribution. Instead, you should make sure that the existing `dir'
|
|
|
639 file contains an appropriate menu entry for the XEmacs info.
|
|
|
640
|
|
|
641 3) Create a directory for XEmacs to use for clash detection, named as
|
|
|
642 indicated by the PATH_LOCK macro in `./src/paths.h'.
|
|
|
643
|
|
|
644 4) Copy `./src/xemacs' to `/usr/local/bin', or to some other directory
|
|
|
645 in users' search paths. `./src/xemacs' has an alternate name
|
|
|
646 `./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named
|
|
|
647 `/usr/local/bin/xemacs' pointing to that alternate name, as an easy way
|
|
|
648 of installing different versions.
|
|
|
649
|
|
|
650 You can delete `./src/temacs'.
|
|
|
651
|
|
|
652 5) Copy the programs `b2m', `emacsclient', `ctags', `etags', `rcs2log',
|
|
|
653 `gnuclient', `gnudoit', and `gnuattach' from `./lib-src' to
|
|
|
654 `/usr/local/bin'. These programs are intended for users to run.
|
|
|
655
|
|
|
656 6) Copy the man pages in `./etc' for xemacs, ctags, etags, and gnuserv
|
|
|
657 into the appropriate man directories.
|
|
|
658
|
|
|
659 7) The files in the `./src' subdirectory, except for `xemacs', are not
|
|
|
660 used by XEmacs once it is built. The source would be handy for
|
|
|
661 debugging.
|
|
|
662
|
|
|
663
|
|
|
664 PROBLEMS
|
|
|
665
|
|
|
666 See the file PROBLEMS in this directory for a list of various
|
|
|
667 problems sometimes encountered, and what to do about them.
|
