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