Added filename completion in inferior tcl mode
[emacs.git] / INSTALL
blob5be8d0832876ed97f396e963c6efb420f12fd6b7
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 sometimes 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 by inspecting its environment; if it cannot, you must find
48 the appropriate configuration name in `./etc/MACHINES' and specify it
49 explicitly.
51 The `--with-x', `--with-x11', and `--with-x10' options specify which
52 window system Emacs should support.  If you don't want X support,
53 specify `--with-x=no'.  If all of these options are omitted,
54 `configure' will try to figure out for itself whether your system has
55 X11, and arrange to use it if present.
57 The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build
58 process where the compiler should look for the include files and
59 object libraries used with the X Window System.  Normally, your
60 compiler should be able to find these by default; these options should
61 only be necessary if you have your X Window System files installed in
62 unusual places.
64 You can specify toolkit operation when you configure Emacs; use the
65 option --with-x-toolkit.
67 Note: on some systems, it does not work to use the toolkit with shared
68 libraries.
70 The `--run-in-place' option sets up default values for the path
71 variables in `./Makefile' so that Emacs will expect to find its data
72 files (lisp libraries, runnable programs, and the like) in the same
73 locations they occupy while Emacs builds.  If you use `--run-in-place'
74 then you don't need to do `make install'.
76 `--run-in-place' is pretty much obsolete now.  If you put the Emacs
77 executable in a subdirectory named src, which has siblings named lisp,
78 lib-src, etc, info and so on, Emacs automatically uses those sibling
79 directories if the standard installation directory names don't contain
80 what Emacs needs.
82 The `--with-gcc' option specifies that the build process should
83 compile Emacs using GCC.  If you don't want to use GCC, specify
84 `--with-gcc=no'.  If this option is omitted, `configure' will search
85 for GCC in your load path, and use it if present.
87 The `--srcdir=DIR' option specifies that the configuration and build
88 processes should look for the Emacs source code in DIR, when DIR is
89 not the current directory.
91 You can use `--srcdir' to build Emacs for several different machine
92 types from a single source directory.  Make separate build directories
93 for the different configuration types, and in each one, build Emacs
94 specifying the common source directory with `--srcdir'.
96 The `--prefix=PREFIXDIR' option specifies where the installation process
97 should put emacs and its data files.  This defaults to `/usr/local'.
98 - Emacs (and the other utilities users run) go in PREFIXDIR/bin
99   (unless the `--exec-prefix' option says otherwise).
100 - The architecture-independent files go in PREFIXDIR/lib/emacs/VERSION
101   (where VERSION is the version number of Emacs, like `19.7').
102 - The architecture-dependent files go in
103   PREFIXDIR/lib/emacs/VERSION/CONFIGURATION
104   (where CONFIGURATION is the configuration name, like mips-dec-ultrix4.2),
105   unless the `--exec-prefix' option says otherwise.
107 The `--exec-prefix=EXECDIR' option allows you to specify a separate
108 portion of the directory tree for installing architecture-specific
109 files, like executables and utility programs.  If specified,
110 - Emacs (and the other utilities users run) go in EXECDIR/bin, and
111 - The architecture-dependent files go in
112   EXECDIR/lib/emacs/VERSION/CONFIGURATION.
113 EXECDIR/bin should be a directory that is normally in users' PATHs.
115 For example, the command
117     ./configure mips-dec-ultrix --with-x11
119 configures Emacs to build for a DECstation running Ultrix, with
120 support for the X11 window system.
122 The `configure' program does not accept abbreviations for its
123 options.
125 Note that `configure' doesn't do any compilation or installation
126 itself.  It just creates the files that influence those things:
127 `./Makefile', `build-install', and `./src/config.h'.  For details on
128 exactly what it does, see the section called `CONFIGURATION BY HAND',
129 below.
131 When it is done, `configure' prints a description of what it did and
132 leaves a copy in the file `config.status'.  That file is also a shell
133 script which, when run, recreates the same configuration; it contains
134 the verbal description as a comment.  If `configure' exits with an
135 error after disturbing the status quo, it removes `config.status'.
137 The work of `configure' can be done by editing various files in the
138 distribution, but using `configure' is supposed to be simpler.  See
139 the section called "CONFIGURATION BY HAND" below if you want to do the
140 configuration yourself.
142 4) Look at `./lisp/paths.el'; if some of those values are not right
143 for your system, edit the file `./lisp/site-init.el' containing Emacs
144 Lisp code to override them; you probably don't want to edit paths.el
145 itself.  YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES,
146 rather than `defvar', as used by `./lisp/paths.el'.  For example,
148      (setq news-inews-program "/usr/bin/inews")
150 is how you would override the default value of the variable
151 news-inews-program (which is "/usr/local/inews").
153 Note that, on some systems, the code you place in site-init.el must
154 not use expand-file-name or any other function which may look
155 something up in the system's password and user information database.
156 See `./PROBLEMS' for more details on which systems this affects.
158 5) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs
159 Lisp code you want Emacs to load before it is dumped out.  Use
160 site-load.el for additional libraries if you arrange for their
161 documentation strings to be in the etc/DOC file (see
162 src/Makefile.in.in if you wish to figure out how to do that).  For all
163 else, use site-init.el.
165 Note that, on some systems, the code you place in site-init.el must
166 not use expand-file-name or any other function which may look
167 something up in the system's password and user information database.
168 See `./PROBLEMS' for more details on which systems this affects.
170 The `site-*.el' files are nonexistent in the distribution.  You do not
171 need to create them if you have nothing to put in them.
173 6) Refer to the file `./etc/TERMS' for information on fields you may
174 wish to add to various termcap entries.  The files `./etc/termcap.ucb'
175 and `./etc/termcap.dat' may already contain appropriately-modified
176 entries.
178 7) Run `make' in the top directory of the Emacs distribution to finish
179 building Emacs in the standard way.  The final executable file will be
180 named `src/emacs'.  If you want to have Emacs's executable programs
181 and data files installed as well, run `make install'.
183 By default, Emacs installs its files in the following directories:
185 `/usr/local/bin' holds the executable programs users normally run -
186                 `emacs', `etags', `ctags', `b2m', `emacsclient',
187                 and `rcs-checkin'.
189 `/usr/local/lib/emacs/VERSION/lisp' holds the Emacs Lisp library;
190                 `VERSION' stands for the number of the Emacs version
191                 you are installing, like `18.59' or `19.0'.  Since the
192                 lisp library changes from one version of Emacs to
193                 another, including the version number in the path
194                 allows you to have several versions of Emacs installed
195                 at the same time; this means that you don't have to
196                 make Emacs unavailable while installing a new
197                 version.
199                 Emacs searches for its lisp files in
200                 `/usr/local/lib/emacs/site-lisp', then in this
201                 directory.
203 `/usr/local/lib/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
204                 file, the `yow' database, and other
205                 architecture-independent files Emacs might need while
206                 running.  VERSION is as specified for `.../lisp'.
208 `/usr/local/lib/emacs/lock' contains files indicating who is editing
209                 what, so Emacs can detect editing clashes between
210                 users.
212 `/usr/local/lib/emacs/VERSION/CONFIGURATION-NAME' contains executable
213                 programs used by Emacs that users are not expected to
214                 run themselves.
215                 `VERSION' is the number of the Emacs version you are
216                 installing, and `CONFIGURATION-NAME' is the argument
217                 you gave to the `configure' program to identify the
218                 architecture and operating system of your machine,
219                 like `mips-dec-ultrix' or `sparc-sun-sunos'.  Since
220                 these files are specific to the version of Emacs,
221                 operating system, and architecture in use, including
222                 the configuration name in the path allows you to have
223                 several versions of Emacs for any mix of machines and
224                 operating systems installed at the same time; this is
225                 useful for sites at which different kinds of machines
226                 share the file system Emacs is installed on.
228 `/usr/local/info' holds the on-line documentation for Emacs, known as
229                 "info files".  Many other GNU programs are documented
230                 using info files as well, so this directory stands
231                 apart from the other, Emacs-specific directories.
233 `/usr/local/man/man1' holds the man pages for the programs installed
234                 in `/usr/local/bin'.
236 If these directories are not what you want, you can specify where to
237 install Emacs's libraries and data files or where Emacs should search
238 for its lisp files by giving values for `make' variables as part of
239 the command.  See the section below called `MAKE VARIABLES' for more
240 information on this.
242 8) Check the file `dir' in your site's info directory (usually
243 /usr/local/info) to make sure that it has a menu entry for the Emacs
244 info files.
246 9) If your system uses lock files to interlock access to mailer inbox files,
247 then you might need to make the program arch-lib/movemail setuid or setgid
248 to enable it to write the lock files.  We believe this is safe.
250 10) You are done!
253 MAKE VARIABLES
255 You can change where the build process installs Emacs and its data
256 files by specifying values for `make' variables as part of the `make'
257 command line.  For example, if you type
259     make install bindir=/usr/local/gnubin
261 the `bindir=/usr/local/gnubin' argument indicates that the Emacs
262 executable files should go in `/usr/local/gnubin', not
263 `/usr/local/bin'.
265 Here is a complete list of the variables you may want to set.
267 `bindir' indicates where to put executable programs that users can
268         run.  This defaults to /usr/local/bin.
270 `datadir' indicates where to put the architecture-independent
271         read-only data files that Emacs refers to while it runs; it
272         defaults to /usr/local/lib.  We create the following
273         subdirectories under `datadir':
274         - `emacs/VERSION/lisp', containing the Emacs lisp library, and
275         - `emacs/VERSION/etc', containing the Emacs tutorial, the DOC
276                 file, and the `yow' database.
277         `VERSION' is the number of the Emacs version you are installing,
278         like `18.59' or `19.0'.  Since these files vary from one version
279         of Emacs to another, including the version number in the path
280         allows you to have several versions of Emacs installed at the
281         same time; this means that you don't have to make Emacs
282         unavailable while installing a new version.
284 `statedir' indicates where to put architecture-independent data files
285         that Emacs modifies while it runs; it defaults to
286         /usr/local/lib as well.  We create the following
287         subdirectories under `statedir':
288         - `emacs/lock', containing files indicating who is editing
289                 what, so Emacs can detect editing clashes between
290                 users.
292 `libdir' indicates where to put architecture-specific data files that
293         Emacs refers to as it runs; it too defaults to `/usr/local/lib'.
294         We create the following subdirectories under `libdir':
295         - `emacs/VERSION/CONFIGURATION-NAME', containing executable
296                 programs used by Emacs that users are not expected to run
297                 themselves.  
298         `VERSION' is the number of the Emacs version you are installing,
299         and `CONFIGURATION-NAME' is the argument you gave to the
300         `configure' program to identify the architecture and operating
301         system of your machine, like `mips-dec-ultrix' or
302         `sparc-sun-sunos'.  Since these files are specific to the version
303         of Emacs, operating system, and architecture in use, including
304         the configuration name in the path allows you to have several
305         versions of Emacs for any mix of machines and operating systems
306         installed at the same time; this is useful for sites at which
307         different kinds of machines share the file system Emacs is
308         installed on.
310 `infodir' indicates where to put the info files distributed with
311         Emacs; it defaults to `/usr/local/info'.
313 `mandir' indicates where to put the man pages for Emacs and its
314         utilities (like `etags'); it defaults to
315         `/usr/local/man/man1'.
317 `manext' gives the extension the man pages should be installed with.
318         It should contain a period, followed by the appropriate
319         digit.  It defaults to `.1'.  For example given the default
320         values for `mandir' and `manext', the Emacs man page would be
321         installed as `/usr/local/man/man1/emacs.1'.
323 `prefix' doesn't give a path for any specific part of Emacs; instead,
324         its value is used to determine the defaults for all the
325         architecture-independent path variables - `datadir',
326         `statedir', `infodir', and `mandir'.  Its default value is
327         `/usr/local'; the other variables add on `lib' or `man' to it
328         by default.
330         For example, suppose your site generally places GNU software
331         under `/usr/users/software/gnusoft' instead of `/usr/local'.
332         By including
333             `prefix=/usr/users/software/gnusoft'
334         in the arguments to `make', you can instruct the build process
335         to place all of the Emacs data files in the appropriate
336         directories under that path.
338 `exec_prefix' serves the same purpose as `prefix', but instead
339         determines the default values for the architecture-dependent
340         path variables - `bindir' and `libdir'.
342 The above variables serve analogous purposes in the makefiles for all
343 GNU software; here are some variables specific to Emacs.
345 `lispdir' indicates where Emacs installs and expects its lisp
346         library.  Its default value, based on `datadir' (see above),
347         is `/usr/local/lib/emacs/VERSION/lisp' (where `VERSION' is as
348         described above).
350 `locallisppath' indicates where Emacs should search for lisp files
351         specific to your site.  It should be a colon-separated list of
352         directories; Emacs checks them in order before checking
353         `lispdir'.  Its default value, based on `datadir' (see above),
354         is `/usr/local/lib/emacs/site-lisp'.
356 `lisppath' is the complete list of directories Emacs should search for
357         its lisp files; its default value is the concatenation of
358         `lispdir' and `locallisppath'.  It should be a colon-separated
359         list of directories; Emacs checks them in the order they
360         appear.
362 `etcdir' indicates where Emacs should install and expect the rest of
363         its architecture-independent data, like the tutorial, DOC
364         file, and yow database.  Its default value, based on `datadir'
365         (which see), is `/usr/local/lib/emacs/VERSION/etc'.
367 `lockdir' indicates the directory where Emacs keeps track of its
368         locking information.  Its default value, based on `statedir'
369         (which see), is `/usr/local/lib/emacs/lock'.
371 `archlibdir' indicates where Emacs installs and expects the
372         executable files and other architecture-dependent data it uses
373         while running.  Its default value, based on `libdir' (which
374         see), is `/usr/local/lib/emacs/VERSION/CONFIGURATION-NAME'
375         (where VERSION and CONFIGURATION-NAME are as described above).
377 Remember that you must specify any variable values you need each time
378 you run `make' in the top directory.  If you run `make' once to build
379 emacs, test it, and then run `make' again to install the files, you
380 must provide the same variable settings each time.  To make the
381 settings persist, you can edit them into the `Makefile' in the top
382 directory, but be aware that running the `configure' program erases
383 `Makefile' and rebuilds it from `Makefile.in'.
385 The top-level Makefile stores the variable settings it used in the
386 Makefiles for the subdirectories, so you don't have to specify them
387 when running make in the subdirectories.
390 CONFIGURATION BY HAND
392 Instead of running the `configure' program, you have to perform the
393 following steps.
395 1) Copy `./src/config.h.in' to `./src/config.h'.
397 2) Consult `./etc/MACHINES' to see what configuration name you should
398 use for your system.  Look at the code of the `configure' script to
399 see which operating system and architecture description files from
400 `src/s' and `src/m' should be used for that configuration name.  Edit
401 `src/config.h', and change the two `#include' directives to include
402 the appropriate system and architecture description files.
404 2) Edit `./src/config.h' to set the right options for your system.  If
405 you need to override any of the definitions in the s/*.h and m/*.h
406 files for your system and machine, do so by editing config.h, not by
407 changing the s/*.h and m/*.h files.  Occasionally you may need to
408 redefine parameters used in `./lib-src/movemail.c'.
410 3) Create src/Makefile and lib-src/Makefile from the corresponding
411 `Makefile.in.in' files.  First copy `Makefile.in.in' to `Makefile.in',
412 then edit in appropriate substituions for the @...@ constructs,
413 and then copy the shell commands near the end of `configure'
414 that run cpp to construct `Makefile'.
416 4) Create `Makefile' files in various other directories
417 from the corresponding `Makefile.in' files.  This isn't so hard,
418 just a matter of substitution.
420 5) If you're going to use the build-install script to build Emacs,
421 copy `./build-ins.in' to `./build-install', and edit the
422 definitions found at the top of the script.
424 The `configure' script is built from `configure.in' by the `autoconf'
425 program.  However, since Emacs has configuration requirements that
426 autoconf can't meet, `configure.in' uses an marriage of custom-baked
427 configuration code and autoconf macros.  New versions of autoconf
428 could very well break this arrangement, so it may be wise to avoid
429 rebuilding `configure' from `configure.in' when possible.
432 BUILDING GNU EMACS BY HAND
434 Once Emacs is configured, running `make' or running the shell script
435 `build-install' in the top directory performs the following steps.
437 1) Run `make src/paths.h' in the top directory.  This produces
438 `./src/paths.h' from the template file `./src/paths.h.in', changing
439 the paths to the values specified in `./Makefile'.
441 2) Go to directory `./lib-src' and run `make'.  This creates
442 executables named `ctags' and `etags' and `wakeup' and `make-docfile'
443 and `digest-doc' and `test-distrib'.  And others.
445 3) Go to directory `./src' and Run `make'.  This refers to files in
446 the `./lisp' and `./lib-src' subdirectories using names `../lisp' and
447 `../lib-src'.
449 This creates a file `./src/emacs' which is the runnable Emacs,
450 which has another name that contains a version number.
451 Each time you do this, that version number increments in the last place.
453 It also creates a file in `./etc' whose name is `DOC' followed by the
454 current Emacs version.  This file contains documentation strings for
455 all the functions in Emacs.  Each time you run make to make a new
456 emacs, a new DOC file with a new name is made.  You must keep the DOC
457 file for an Emacs version as long as you keep using that Emacs
458 version.
461 INSTALLATION BY HAND
463 The steps below are done by the shell script `build-install' or by
464 running `make install' in the main directory of the Emacs
465 distribution.
467 1) Copy `./lisp' and its subdirectories, `./etc', and the executables
468 in `./lib-src' to their final destinations, as selected in `./src/paths.h'.
470 Strictly speaking, not all of the executables in `./lib-src' need be copied.
471 - The programs `cvtmail', `emacsserver', `fakemail', `hexl',
472     `movemail', `profile', `rcs2log', `timer', `vcdiff', `wakeup',
473     and `yow' are used by Emacs; they do need to be copied.
474 - The programs `etags', `ctags', `emacsclient', `b2m', and `rcs-checkin'
475     are intended to be run by users; they are handled below.
476 - The programs `make-docfile', `make-path', and `test-distrib' were
477     used in building Emacs, and are not needed any more.
478 - The programs `digest-doc' and `sorted-doc' convert a `DOC' file into
479     a file for users to read.  There is no important reason to move them.
481 2) Copy the files in `./info' to the place specified in
482 `./lisp/site-init.el' or `./lisp/paths.el'.  Note that if the
483 destination directory already contains a file named `dir', you
484 probably don't want to replace it with the `dir' file in the Emacs
485 distribution.  Instead, you should make sure that the existing `dir'
486 file contains an appropriate menu entry for the Emacs info.
488 3) Create a directory for Emacs to use for clash detection, named as
489 indicated by the PATH_LOCK macro in `./src/paths.h'.
491 4) Copy `./src/emacs' to `/usr/local/bin', or to some other directory
492 in users' search paths.  `./src/emacs' has an alternate name
493 `./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named
494 `/usr/local/bin/emacs' pointing to that alternate name, as an easy way
495 of installing different versions.
497 You can delete `./src/temacs'.
499 5) Copy the programs `b2m', `emacsclient', `ctags', `etags', and
500 `rcs-checkin' from `./lib-src' to `/usr/local/bin'.  These programs are
501 intended for users to run.
503 6) Copy the man pages in `./etc' for emacs, ctags, and etags into the
504 appropriate man directories.
506 7) The files in the `./src' subdirectory, except for `emacs', are not
507 used by Emacs once it is built.  However, it is very desirable to keep
508 the source on line for debugging.
511 PROBLEMS
513 See the file PROBLEMS in this directory for a list of various
514 problems sometimes encountered, and what to do about them.
517 Installation on MSDOG (a.k.a. MSDOS)
519 To install on MSDOG, you need to have the GNU C compiler for MSDOG
520 (also known as djgpp), GNU Make, rm, mv, chmod, and sed.  Type these
521 commands:
523 config msdos
524 make install
526 To save disk space, Emacs is built with the idea that you will execute
527 it from the same place in the file system where you built it.  As the
528 /usr/local/ subtree does not exist on most MSDOG systems, the
529 executables are placed in /emacs/bin/.
531 MSDOG is a not a multitasking operating system, so Emacs features such
532 as asynchronous subprocesses that depend on multitasking will not
533 work.  Synchronous subprocesses do work.