(cmd_error): Cancel echoing here.
[emacs.git] / INSTALL
blob099e6e9362b2f4fa067f09c167e75963fafef82d
1 GNU Emacs Installation Guide
2 Copyright (c) 1992, 1994 Free software Foundation, Inc.
4    Permission is granted to anyone to make or distribute verbatim copies
5    of this document as received, in any medium, provided that the
6    copyright notice and permission notice are preserved,
7    and that the distributor grants the recipient permission
8    for further redistribution as permitted by this notice.
10    Permission is granted to distribute modified versions
11    of this document, or of portions of it,
12    under the above conditions, provided also that they
13    carry prominent notices stating who last changed them,
14    and that any new or changed statements about the activities
15    of the Free Software Foundation are approved by the Foundation.
18 BUILDING AND INSTALLATION:
19 (This is for a Unix or Unix-like system.  For MSDOS, see below;
20 search for MSDOG.)
22 1) Make sure your system has enough swapping space allocated to handle
23 a program whose pure code is 900k bytes and whose data area is at
24 least 400k and can reach 8Mb or more.  If the swapping space is
25 insufficient, you will get an error in the command `temacs -batch -l
26 loadup dump', found in `./src/Makefile.in.in', or possibly when
27 running the final dumped Emacs.
29 Building Emacs requires about 50 Mb of disk space (including the Emacs
30 sources).  Once installed, Emacs occupies about 20 Mb in the file
31 system where it is installed; this includes the executable files, Lisp
32 libraries, miscellaneous data files, and on-line documentation.  If
33 the building and installation take place in different directories,
34 then the installation procedure momentarily requires 50+20 Mb.
36 2) Consult `./etc/MACHINES' to see what configuration name you should
37 give to the `configure' program.  That file offers hints for
38 getting around some possible installation problems.
40 3) In the top directory of the Emacs distribution, run the program
41 `configure' as follows:
43     ./configure CONFIGURATION-NAME [--OPTION[=VALUE]] ...
45 The CONFIGURATION-NAME argument should be a configuration name given
46 in `./etc/MACHINES'.  If omitted, `configure' will try to guess your
47 system type; if it cannot, you must find the appropriate configuration
48 name in `./etc/MACHINES' and specify it explicitly.
50 If you don't want X support, specify `--with-x=no'.  If you omit this
51 option, `configure' will try to figure out for itself whether your
52 system has X, and arrange to use it if present.
54 The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build
55 process where the compiler should look for the include files and
56 object libraries used with the X Window System.  Normally, `configure'
57 is able to find them; these options are necessary if you have your X
58 Window System files installed in unusual places.
60 To get more attractive menus, you can specify an X toolkit when you
61 configure Emacs; use the option `--with-x-toolkit=TOOLKIT', where
62 TOOLKIT is `athena' or `motif' (`yes' and `lucid' are synonyms for
63 `athena').  On some systems, it does not work to use a toolkit with
64 shared libraries.
66 The `--with-gcc' option specifies that the build process should
67 compile Emacs using GCC.  If you don't want to use GCC, specify
68 `--with-gcc=no'.  If you omit this option, `configure' will search
69 for GCC in your path, and use it if present.
71 You can build Emacs for several different machine types from a single
72 source directory.  To do this, you must use a version of `make' that
73 supports the `VPATH' variable, such as GNU `make'.  Make separate
74 build directories for the different configuration types, and in each
75 one, run the Emacs `configure' script.  `configure' looks for the
76 Emacs source code in the directory that `configure' is in.
78 The `--prefix=PREFIXDIR' option specifies where the installation process
79 should put emacs and its data files.  This defaults to `/usr/local'.
80 - Emacs (and the other utilities users run) go in PREFIXDIR/bin
81   (unless the `--exec-prefix' option says otherwise).
82 - The architecture-independent files go in PREFIXDIR/share/emacs/VERSION
83   (where VERSION is the version number of Emacs, like `19.27').
84 - The architecture-dependent files go in
85   PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION
86   (where CONFIGURATION is the configuration name, like mips-dec-ultrix4.2),
87   unless the `--exec-prefix' option says otherwise.
89 The `--exec-prefix=EXECDIR' option allows you to specify a separate
90 portion of the directory tree for installing architecture-specific
91 files, like executables and utility programs.  If specified,
92 - Emacs (and the other utilities users run) go in EXECDIR/bin, and
93 - The architecture-dependent files go in
94   EXECDIR/libexec/emacs/VERSION/CONFIGURATION.
95 EXECDIR/bin should be a directory that is normally in users' PATHs.
97 For example, the command
99     ./configure mips-dec-ultrix --with-x11
101 configures Emacs to build for a DECstation running Ultrix, with
102 support for the X11 window system.
104 `configure' doesn't do any compilation or installation
105 itself.  It just creates the files that influence those things:
106 `./Makefile', `lib-src/Makefile', `oldXMenu/Makefile',
107 `lwlib/Makefile', `src/Makefile', and `./src/config.h'.  For details
108 on exactly what it does, see the section called `CONFIGURATION BY
109 HAND', below.
111 When it is done, `configure' prints a description of what it did and
112 creates a shell script `config.status' which, when run, recreates the
113 same configuration.  If `configure' exits with an error after
114 disturbing the status quo, it removes `config.status'.  `configure'
115 also creates a file `config.cache' that saves the results of its tests
116 to make reconfiguring faster, and a file `config.log' containing compiler
117 output (useful mainly for debugging `configure').  You can give
118 `configure' the option `--cache-file=FILE' to use the results of the
119 tests in FILE instead of `config.cache'.  Set FILE to `/dev/null' to
120 disable caching, for debugging `configure'.
122 The work of `configure' can be done by editing various files in the
123 distribution, but using `configure' is supposed to be simpler.  See
124 the section called "CONFIGURATION BY HAND" below if you want to do the
125 configuration yourself.
127 4) Look at `./lisp/paths.el'; if some of those values are not right
128 for your system, edit the file `./lisp/site-init.el' containing Emacs
129 Lisp code to override them; you probably don't want to edit paths.el
130 itself.  YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES,
131 rather than `defvar', as used by `./lisp/paths.el'.  For example,
133      (setq news-inews-program "/usr/bin/inews")
135 is how you would override the default value of the variable
136 news-inews-program (which is "/usr/local/inews").
138 Note that, on some systems, the code you place in site-init.el must
139 not use expand-file-name or any other function which may look
140 something up in the system's password and user information database.
141 See `./PROBLEMS' for more details on which systems this affects.
143 5) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs
144 Lisp code you want Emacs to load before it is dumped out.  Use
145 site-load.el for additional libraries if you arrange for their
146 documentation strings to be in the etc/DOC file (see
147 src/Makefile.in.in if you wish to figure out how to do that).  For all
148 else, use site-init.el.
150 Note that, on some systems, the code you place in site-init.el must
151 not use expand-file-name or any other function which may look
152 something up in the system's password and user information database.
153 See `./PROBLEMS' for more details on which systems this affects.
155 The `site-*.el' files are nonexistent in the distribution.  You do not
156 need to create them if you have nothing to put in them.
158 6) Refer to the file `./etc/TERMS' for information on fields you may
159 wish to add to various termcap entries.  The files `./etc/termcap.ucb'
160 and `./etc/termcap.dat' may already contain appropriately-modified
161 entries.
163 7) Run `make' in the top directory of the Emacs distribution to finish
164 building Emacs in the standard way.  The final executable file will be
165 named `src/emacs'.  If you want to have Emacs's executable programs
166 and data files installed as well, run `make install'.
168 By default, Emacs installs its files in the following directories:
170 `/usr/local/bin' holds the executable programs users normally run -
171                 `emacs', `etags', `ctags', `b2m', `emacsclient',
172                 and `rcs-checkin'.
174 `/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library;
175                 `VERSION' stands for the number of the Emacs version
176                 you are installing, like `18.59' or `19.27'.  Since the
177                 lisp library changes from one version of Emacs to
178                 another, including the version number in the path
179                 allows you to have several versions of Emacs installed
180                 at the same time; this means that you don't have to
181                 make Emacs unavailable while installing a new
182                 version.
184                 Emacs searches for its lisp files in
185                 `/usr/local/share/emacs/site-lisp', then in this
186                 directory.
188 `/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
189                 file, the `yow' database, and other
190                 architecture-independent files Emacs might need while
191                 running.  VERSION is as specified for `.../lisp'.
193 `/usr/local/com/emacs/lock' contains files indicating who is editing
194                 what, so Emacs can detect editing clashes between
195                 users.
197 `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable
198                 programs used by Emacs that users are not expected to
199                 run themselves.
200                 `VERSION' is the number of the Emacs version you are
201                 installing, and `CONFIGURATION-NAME' is the argument
202                 you gave to the `configure' program to identify the
203                 architecture and operating system of your machine,
204                 like `mips-dec-ultrix' or `sparc-sun-sunos'.  Since
205                 these files are specific to the version of Emacs,
206                 operating system, and architecture in use, including
207                 the configuration name in the path allows you to have
208                 several versions of Emacs for any mix of machines and
209                 operating systems installed at the same time; this is
210                 useful for sites at which different kinds of machines
211                 share the file system Emacs is installed on.
213 `/usr/local/info' holds the on-line documentation for Emacs, known as
214                 "info files".  Many other GNU programs are documented
215                 using info files as well, so this directory stands
216                 apart from the other, Emacs-specific directories.
218 `/usr/local/man/man1' holds the man pages for the programs installed
219                 in `/usr/local/bin'.
221 If these directories are not what you want, you can specify where to
222 install Emacs's libraries and data files or where Emacs should search
223 for its lisp files by giving values for `make' variables as part of
224 the command.  See the section below called `MAKE VARIABLES' for more
225 information on this.
227 8) Check the file `dir' in your site's info directory (usually
228 /usr/local/info) to make sure that it has a menu entry for the Emacs
229 info files.
231 9) If your system uses lock files to interlock access to mailer inbox files,
232 then you might need to make the movemail program setuid or setgid
233 to enable it to write the lock files.  We believe this is safe.
235 10) You are done!
238 MAKE VARIABLES
240 You can change where the build process installs Emacs and its data
241 files by specifying values for `make' variables as part of the `make'
242 command line.  For example, if you type
244     make install bindir=/usr/local/gnubin
246 the `bindir=/usr/local/gnubin' argument indicates that the Emacs
247 executable files should go in `/usr/local/gnubin', not
248 `/usr/local/bin'.
250 Here is a complete list of the variables you may want to set.
252 `bindir' indicates where to put executable programs that users can
253         run.  This defaults to /usr/local/bin.
255 `datadir' indicates where to put the architecture-independent
256         read-only data files that Emacs refers to while it runs; it
257         defaults to /usr/local/share.  We create the following
258         subdirectories under `datadir':
259         - `emacs/VERSION/lisp', containing the Emacs lisp library, and
260         - `emacs/VERSION/etc', containing the Emacs tutorial, the DOC
261                 file, and the `yow' database.
262         `VERSION' is the number of the Emacs version you are installing,
263         like `18.59' or `19.0'.  Since these files vary from one version
264         of Emacs to another, including the version number in the path
265         allows you to have several versions of Emacs installed at the
266         same time; this means that you don't have to make Emacs
267         unavailable while installing a new version.
269 `sharedstatedir' indicates where to put architecture-independent data files
270         that Emacs modifies while it runs; it defaults to
271         /usr/local/com.  We create the following
272         subdirectories under `sharedstatedir':
273         - `emacs/lock', containing files indicating who is editing
274                 what, so Emacs can detect editing clashes between
275                 users.
277 `libexecdir' indicates where to put architecture-specific data files that
278         Emacs refers to as it runs; it defaults to `/usr/local/libexec'.
279         We create the following subdirectories under `libexecdir':
280         - `emacs/VERSION/CONFIGURATION-NAME', containing executable
281                 programs used by Emacs that users are not expected to run
282                 themselves.  
283         `VERSION' is the number of the Emacs version you are installing,
284         and `CONFIGURATION-NAME' is the argument you gave to the
285         `configure' program to identify the architecture and operating
286         system of your machine, like `mips-dec-ultrix' or
287         `sparc-sun-sunos'.  Since these files are specific to the version
288         of Emacs, operating system, and architecture in use, including
289         the configuration name in the path allows you to have several
290         versions of Emacs for any mix of machines and operating systems
291         installed at the same time; this is useful for sites at which
292         different kinds of machines share the file system Emacs is
293         installed on.
295 `infodir' indicates where to put the info files distributed with
296         Emacs; it defaults to `/usr/local/info'.
298 `mandir' indicates where to put the man pages for Emacs and its
299         utilities (like `etags'); it defaults to
300         `/usr/local/man/man1'.
302 `manext' gives the extension the man pages should be installed with.
303         It should contain a period, followed by the appropriate
304         digit.  It defaults to `.1'.  For example given the default
305         values for `mandir' and `manext', the Emacs man page would be
306         installed as `/usr/local/man/man1/emacs.1'.
308 `prefix' doesn't give a path for any specific part of Emacs; instead,
309         its value is used to determine the defaults for all the
310         architecture-independent path variables - `datadir',
311         `sharedstatedir', `infodir', and `mandir'.  Its default value is
312         `/usr/local'; the other variables add on `lib' or `man' to it
313         by default.
315         For example, suppose your site generally places GNU software
316         under `/usr/users/software/gnusoft' instead of `/usr/local'.
317         By including
318             `prefix=/usr/users/software/gnusoft'
319         in the arguments to `make', you can instruct the build process
320         to place all of the Emacs data files in the appropriate
321         directories under that path.
323 `exec_prefix' serves the same purpose as `prefix', but instead
324         determines the default values for the architecture-dependent
325         path variables - `bindir' and `libexecdir'.
327 The above variables serve analogous purposes in the makefiles for all
328 GNU software; here are some variables specific to Emacs.
330 `lispdir' indicates where Emacs installs and expects its lisp
331         library.  Its default value, based on `datadir' (see above),
332         is `/usr/local/lib/emacs/VERSION/lisp' (where `VERSION' is as
333         described above).
335 `locallisppath' indicates where Emacs should search for lisp files
336         specific to your site.  It should be a colon-separated list of
337         directories; Emacs checks them in order before checking
338         `lispdir'.  Its default value, based on `datadir' (see above),
339         is `/usr/local/lib/emacs/site-lisp'.
341 `lisppath' is the complete list of directories Emacs should search for
342         its lisp files; its default value is the concatenation of
343         `lispdir' and `locallisppath'.  It should be a colon-separated
344         list of directories; Emacs checks them in the order they
345         appear.
347 `etcdir' indicates where Emacs should install and expect the rest of
348         its architecture-independent data, like the tutorial, DOC
349         file, and yow database.  Its default value, based on `datadir'
350         (which see), is `/usr/local/lib/emacs/VERSION/etc'.
352 `lockdir' indicates the directory where Emacs keeps track of its
353         locking information.  Its default value, based on `sharedstatedir'
354         (which see), is `/usr/local/lib/emacs/lock'.
356 `archlibdir' indicates where Emacs installs and expects the
357         executable files and other architecture-dependent data it uses
358         while running.  Its default value, based on `libexecdir' (which
359         see), is `/usr/local/lib/emacs/VERSION/CONFIGURATION-NAME'
360         (where VERSION and CONFIGURATION-NAME are as described above).
362 Remember that you must specify any variable values you need each time
363 you run `make' in the top directory.  If you run `make' once to build
364 emacs, test it, and then run `make' again to install the files, you
365 must provide the same variable settings each time.  To make the
366 settings persist, you can edit them into the `Makefile' in the top
367 directory, but be aware that running the `configure' program erases
368 `Makefile' and rebuilds it from `Makefile.in'.
370 The top-level Makefile stores the variable settings it used in the
371 Makefiles for the subdirectories, so you don't have to specify them
372 when running make in the subdirectories.
375 CONFIGURATION BY HAND
377 Instead of running the `configure' program, you have to perform the
378 following steps.
380 1) Copy `./src/config.h.in' to `./src/config.h'.
382 2) Consult `./etc/MACHINES' to see what configuration name you should
383 use for your system.  Look at the code of the `configure' script to
384 see which operating system and architecture description files from
385 `src/s' and `src/m' should be used for that configuration name.  Edit
386 `src/config.h', and change the two `#include' directives to include
387 the appropriate system and architecture description files.
389 2) Edit `./src/config.h' to set the right options for your system.  If
390 you need to override any of the definitions in the s/*.h and m/*.h
391 files for your system and machine, do so by editing config.h, not by
392 changing the s/*.h and m/*.h files.  Occasionally you may need to
393 redefine parameters used in `./lib-src/movemail.c'.
395 3) Create src/Makefile and lib-src/Makefile from the corresponding
396 `Makefile.in.in' files.  First copy `Makefile.in.in' to `Makefile.in',
397 then edit in appropriate substituions for the @...@ constructs,
398 and then copy the shell commands near the end of `configure'
399 that run cpp to construct `Makefile'.
401 4) Create `Makefile' files in various other directories
402 from the corresponding `Makefile.in' files.  This isn't so hard,
403 just a matter of substitution.
405 The `configure' script is built from `configure.in' by the `autoconf'
406 program.  You need version 2.0 or newer of `autoconf' to rebuild `configure'.
408 BUILDING GNU EMACS BY HAND
410 Once Emacs is configured, running `make' in the top directory performs
411 the following steps.
413 1) Run `make src/paths.h' in the top directory.  This produces
414 `./src/paths.h' from the template file `./src/paths.h.in', changing
415 the paths to the values specified in `./Makefile'.
417 2) Go to directory `./lib-src' and run `make'.  This creates
418 executables named `ctags' and `etags' and `wakeup' and `make-docfile'
419 and `digest-doc' and `test-distrib'.  And others.
421 3) Go to directory `./src' and Run `make'.  This refers to files in
422 the `./lisp' and `./lib-src' subdirectories using names `../lisp' and
423 `../lib-src'.
425 This creates a file `./src/emacs' which is the runnable Emacs,
426 which has another name that contains a version number.
427 Each time you do this, that version number increments in the last place.
429 It also creates a file in `./etc' whose name is `DOC' followed by the
430 current Emacs version.  This file contains documentation strings for
431 all the functions in Emacs.  Each time you run make to make a new
432 emacs, a new DOC file with a new name is made.  You must keep the DOC
433 file for an Emacs version as long as you keep using that Emacs
434 version.
437 INSTALLATION BY HAND
439 The steps below are done by running `make install' in the main
440 directory of the Emacs distribution.
442 1) Copy `./lisp' and its subdirectories, `./etc', and the executables
443 in `./lib-src' to their final destinations, as selected in `./src/paths.h'.
445 Strictly speaking, not all of the executables in `./lib-src' need be copied.
446 - The programs `cvtmail', `emacsserver', `fakemail', `hexl',
447     `movemail', `profile', `rcs2log', `timer', `vcdiff', `wakeup',
448     and `yow' are used by Emacs; they do need to be copied.
449 - The programs `etags', `ctags', `emacsclient', `b2m', and `rcs-checkin'
450     are intended to be run by users; they are handled below.
451 - The programs `make-docfile' and `test-distrib' were
452     used in building Emacs, and are not needed any more.
453 - The programs `digest-doc' and `sorted-doc' convert a `DOC' file into
454     a file for users to read.  There is no important reason to move them.
456 2) Copy the files in `./info' to the place specified in
457 `./lisp/site-init.el' or `./lisp/paths.el'.  Note that if the
458 destination directory already contains a file named `dir', you
459 probably don't want to replace it with the `dir' file in the Emacs
460 distribution.  Instead, you should make sure that the existing `dir'
461 file contains an appropriate menu entry for the Emacs info.
463 3) Create a directory for Emacs to use for clash detection, named as
464 indicated by the PATH_LOCK macro in `./src/paths.h'.
466 4) Copy `./src/emacs' to `/usr/local/bin', or to some other directory
467 in users' search paths.  `./src/emacs' has an alternate name
468 `./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named
469 `/usr/local/bin/emacs' pointing to that alternate name, as an easy way
470 of installing different versions.
472 You can delete `./src/temacs'.
474 5) Copy the programs `b2m', `emacsclient', `ctags', `etags', and
475 `rcs-checkin' from `./lib-src' to `/usr/local/bin'.  These programs are
476 intended for users to run.
478 6) Copy the man pages in `./etc' for emacs, ctags, and etags into the
479 appropriate man directories.
481 7) The files in the `./src' subdirectory, except for `emacs', are not
482 used by Emacs once it is built.  However, it is very desirable to keep
483 the source on line for debugging.
486 PROBLEMS
488 See the file PROBLEMS in this directory for a list of various
489 problems sometimes encountered, and what to do about them.
492 Installation on MSDOG (a.k.a. MSDOS)
494 To install on MSDOG, you need to have the GNU C compiler for MSDOG
495 (also known as djgpp), GNU Make, rm, mv, chmod, and sed.  Type these
496 commands:
498 config msdos
499 make install
501 To save disk space, Emacs is built with the idea that you will execute
502 it from the same place in the file system where you built it.  As the
503 /usr/local/ subtree does not exist on most MSDOG systems, the
504 executables are placed in /emacs/bin/.
506 MSDOG is a not a multitasking operating system, so Emacs features such
507 as asynchronous subprocesses that depend on multitasking will not
508 work.  Synchronous subprocesses do work.