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