annotate INSTALL @ 7740:0ba4d34bcff4

(roundup): Undef before defining.
author Richard M. Stallman <rms@gnu.org>
date Sat, 28 May 1994 21:46:45 +0000
parents 99cf43c08895
children e520e9f9a8d9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
1 GNU Emacs Installation Guide
7627
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
2 Copyright (c) 1992, 1994 Free software Foundation, Inc.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
3
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
4 Permission is granted to anyone to make or distribute verbatim copies
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
5 of this document as received, in any medium, provided that the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
6 copyright notice and permission notice are preserved,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
7 and that the distributor grants the recipient permission
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
8 for further redistribution as permitted by this notice.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
9
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
10 Permission is granted to distribute modified versions
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
11 of this document, or of portions of it,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
12 under the above conditions, provided also that they
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
13 carry prominent notices stating who last changed them,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
14 and that any new or changed statements about the activities
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
15 of the Free Software Foundation are approved by the Foundation.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
16
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
17
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
18 BUILDING AND INSTALLATION:
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
19 (This is for a Unix or Unix-like system. For MSDOS, see below;
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
20 search for MSDOG.)
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
21
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
22 1) Make sure your system has enough swapping space allocated to handle
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
23 a program whose pure code is 900k bytes and whose data area is at
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
24 least 400k and can reach 8Mb or more. If the swapping space is
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
25 insufficient, you will get an error in the command `temacs -batch -l
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
26 loadup dump', found in `./src/Makefile.in.in', or possibly when
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
27 running the final dumped Emacs.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
28
7627
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
29 Building Emacs requires about 50 Mb of disk space (including the Emacs
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
30 sources). Once installed, Emacs occupies about 20 Mb in the file
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
31 system where it is installed; this includes the executable files, Lisp
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
32 libraries, miscellaneous data files, and on-line documentation. If
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
33 the building and installation take place in different directories,
7627
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
34 then the installation procedure momentarily requires 50+20 Mb.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
35
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
36 2) Consult `./etc/MACHINES' to see what configuration name you should
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
37 give to the `configure' program. That file sometimes offers hints for
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
38 getting around some possible installation problems.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
39
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
40 3) In the top directory of the Emacs distribution, run the program
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
41 `configure' as follows:
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
42
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
43 ./configure CONFIGURATION-NAME [--OPTION[=VALUE]] ...
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
44
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
45 The CONFIGURATION-NAME argument should be a configuration name given
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
46 in `./etc/MACHINES'. If omitted, `configure' will try to guess your
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
47 system type by inspecting its environment; if it cannot, you must find
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
48 the appropriate configuration name in `./etc/MACHINES' and specify it
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
49 explicitly.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
50
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
51 The `--with-x', `--with-x11', and `--with-x10' options specify which
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
52 window system Emacs should support. If you don't want X support,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
53 specify `--with-x=no'. If all of these options are omitted,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
54 `configure' will try to figure out for itself whether your system has
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
55 X11, and arrange to use it if present.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
56
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
57 The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
58 process where the compiler should look for the include files and
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
59 object libraries used with the X Window System. Normally, your
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
60 compiler should be able to find these by default; these options should
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
61 only be necessary if you have your X Window System files installed in
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
62 unusual places.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
63
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
64 You can specify toolkit operation when you configure Emacs; use the
7627
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
65 option --with-x-toolkit.
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
66
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
67 Note: on some systems, it does not work to use the toolkit with shared
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
68 libraries.
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
69
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
70 The `--run-in-place' option sets up default values for the path
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
71 variables in `./Makefile' so that Emacs will expect to find its data
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
72 files (lisp libraries, runnable programs, and the like) in the same
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
73 locations they occupy while Emacs builds. This means that you don't
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
74 have to install Emacs in order to run it; it uses its data files as
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
75 they were unpacked.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
76
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
77 The `--with-gcc' option specifies that the build process should
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
78 compile Emacs using GCC. If you don't want to use GCC, specify
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
79 `--with-gcc=no'. If this option is omitted, `configure' will search
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
80 for GCC in your load path, and use it if present.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
81
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
82 The `--srcdir=DIR' option specifies that the configuration and build
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
83 processes should look for the Emacs source code in DIR, when DIR is
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
84 not the current directory.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
85
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
86 You can use `--srcdir' to build Emacs for several different machine
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
87 types from a single source directory. Make separate build directories
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
88 for the different configuration types, and in each one, build Emacs
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
89 specifying the common source directory with `--srcdir'.
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
90
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
91 The `--prefix=PREFIXDIR' option specifies where the installation process
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
92 should put emacs and its data files. This defaults to `/usr/local'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
93 - Emacs (and the other utilities users run) go in PREFIXDIR/bin
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
94 (unless the `--exec-prefix' option says otherwise).
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
95 - The architecture-independent files go in PREFIXDIR/lib/emacs/VERSION
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
96 (where VERSION is the version number of Emacs, like `19.7').
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
97 - The architecture-dependent files go in
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
98 PREFIXDIR/lib/emacs/VERSION/CONFIGURATION
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
99 (where CONFIGURATION is the configuration name, like mips-dec-ultrix4.2),
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
100 unless the `--exec-prefix' option says otherwise.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
101
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
102 The `--exec-prefix=EXECDIR' option allows you to specify a separate
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
103 portion of the directory tree for installing architecture-specific
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
104 files, like executables and utility programs. If specified,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
105 - Emacs (and the other utilities users run) go in EXECDIR/bin, and
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
106 - The architecture-dependent files go in
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
107 EXECDIR/lib/emacs/VERSION/CONFIGURATION.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
108 EXECDIR/bin should be a directory that is normally in users' PATHs.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
109
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
110 For example, the command
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
111
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
112 ./configure mips-dec-ultrix --with-x11
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
113
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
114 configures Emacs to build for a DECstation running Ultrix, with
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
115 support for the X11 window system.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
116
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
117 The `configure' program does not accept abbreviations for its
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
118 options.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
119
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
120 Note that `configure' doesn't do any compilation or installation
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
121 itself. It just creates the files that influence those things:
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
122 `./Makefile', `build-install', and `./src/config.h'. For details on
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
123 exactly what it does, see the section called `CONFIGURATION BY HAND',
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
124 below.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
125
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
126 When it is done, `configure' prints a description of what it did and
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
127 leaves a copy in the file `config.status'. That file is also a shell
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
128 script which, when run, recreates the same configuration; it contains
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
129 the verbal description as a comment. If `configure' exits with an
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
130 error after disturbing the status quo, it removes `config.status'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
131
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
132 The work of `configure' can be done by editing various files in the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
133 distribution, but using `configure' is supposed to be simpler. See
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
134 the section called "CONFIGURATION BY HAND" below if you want to do the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
135 configuration yourself.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
136
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
137 4) Look at `./lisp/paths.el'; if some of those values are not right
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
138 for your system, edit the file `./lisp/site-init.el' containing Emacs
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
139 Lisp code to override them; you probably don't want to edit paths.el
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
140 itself. YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
141 rather than `defvar', as used by `./lisp/paths.el'. For example,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
142
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
143 (setq news-inews-program "/usr/bin/inews")
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
144
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
145 is how you would override the default value of the variable
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
146 news-inews-program (which is "/usr/local/inews").
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
147
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
148 Note that, on some systems, the code you place in site-init.el must
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
149 not use expand-file-name or any other function which may look
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
150 something up in the system's password and user information database.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
151 See `./PROBLEMS' for more details on which systems this affects.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
152
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
153 5) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
154 Lisp code you want Emacs to load before it is dumped out. Use
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
155 site-load.el for additional libraries if you arrange for their
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
156 documentation strings to be in the etc/DOC file (see
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
157 src/Makefile.in.in if you wish to figure out how to do that). For all
7627
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
158 else, use site-init.el.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
159
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
160 Note that, on some systems, the code you place in site-init.el must
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
161 not use expand-file-name or any other function which may look
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
162 something up in the system's password and user information database.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
163 See `./PROBLEMS' for more details on which systems this affects.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
164
7627
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
165 The `site-*.el' files are nonexistent in the distribution. You do not
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
166 need to create them if you have nothing to put in them.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
167
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
168 6) Refer to the file `./etc/TERMS' for information on fields you may
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
169 wish to add to various termcap entries. The files `./etc/termcap.ucb'
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
170 and `./etc/termcap.dat' may already contain appropriately-modified
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
171 entries.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
172
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
173 7) Run `make' in the top directory of the Emacs distribution to finish
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
174 building Emacs in the standard way. The final executable file will be
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
175 named `src/emacs'. If you want to have Emacs's executable programs
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
176 and data files installed as well, run `make install'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
177
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
178 By default, Emacs installs its files in the following directories:
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
179
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
180 `/usr/local/bin' holds the executable programs users normally run -
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
181 `emacs', `etags', `ctags', `b2m', and `emacsclient'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
182
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
183 `/usr/local/lib/emacs/VERSION/lisp' holds the Emacs Lisp library;
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
184 `VERSION' stands for the number of the Emacs version
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
185 you are installing, like `18.59' or `19.0'. Since the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
186 lisp library changes from one version of Emacs to
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
187 another, including the version number in the path
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
188 allows you to have several versions of Emacs installed
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
189 at the same time; this means that you don't have to
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
190 make Emacs unavailable while installing a new
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
191 version.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
192
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
193 Emacs searches for its lisp files in
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
194 `/usr/local/lib/emacs/site-lisp', then in this
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
195 directory.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
196
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
197 `/usr/local/lib/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
198 file, the `yow' database, and other
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
199 architecture-independent files Emacs might need while
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
200 running. VERSION is as specified for `.../lisp'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
201
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
202 `/usr/local/lib/emacs/lock' contains files indicating who is editing
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
203 what, so Emacs can detect editing clashes between
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
204 users.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
205
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
206 `/usr/local/lib/emacs/VERSION/CONFIGURATION-NAME' contains executable
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
207 programs used by Emacs that users are not expected to
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
208 run themselves.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
209 `VERSION' is the number of the Emacs version you are
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
210 installing, and `CONFIGURATION-NAME' is the argument
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
211 you gave to the `configure' program to identify the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
212 architecture and operating system of your machine,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
213 like `mips-dec-ultrix' or `sparc-sun-sunos'. Since
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
214 these files are specific to the version of Emacs,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
215 operating system, and architecture in use, including
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
216 the configuration name in the path allows you to have
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
217 several versions of Emacs for any mix of machines and
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
218 operating systems installed at the same time; this is
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
219 useful for sites at which different kinds of machines
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
220 share the file system Emacs is installed on.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
221
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
222 `/usr/local/info' holds the on-line documentation for Emacs, known as
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
223 "info files". Many other GNU programs are documented
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
224 using info files as well, so this directory stands
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
225 apart from the other, Emacs-specific directories.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
226
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
227 `/usr/local/man/man1' holds the man pages for the programs installed
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
228 in `/usr/local/bin'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
229
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
230 If these directories are not what you want, you can specify where to
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
231 install Emacs's libraries and data files or where Emacs should search
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
232 for its lisp files by giving values for `make' variables as part of
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
233 the command. See the section below called `MAKE VARIABLES' for more
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
234 information on this.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
235
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
236 8) Check the file `dir' in your site's info directory (usually
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
237 /usr/local/info) to make sure that it has a menu entry for the Emacs
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
238 info files.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
239
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
240 9) If your system uses lock files to interlock access to mailer inbox files,
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
241 then you might need to make the program arch-lib/movemail setuid or setgid
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
242 to enable it to write the lock files. We believe this is safe.
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
243
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
244 10) You are done!
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
245
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
246
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
247 MAKE VARIABLES
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
248
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
249 You can change where the build process installs Emacs and its data
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
250 files by specifying values for `make' variables as part of the `make'
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
251 command line. For example, if you type
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
252
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
253 make install bindir=/usr/local/gnubin
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
254
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
255 the `bindir=/usr/local/gnubin' argument indicates that the Emacs
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
256 executable files should go in `/usr/local/gnubin', not
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
257 `/usr/local/bin'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
258
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
259 Here is a complete list of the variables you may want to set.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
260
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
261 `bindir' indicates where to put executable programs that users can
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
262 run. This defaults to /usr/local/bin.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
263
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
264 `datadir' indicates where to put the architecture-independent
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
265 read-only data files that Emacs refers to while it runs; it
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
266 defaults to /usr/local/lib. We create the following
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
267 subdirectories under `datadir':
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
268 - `emacs/VERSION/lisp', containing the Emacs lisp library, and
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
269 - `emacs/VERSION/etc', containing the Emacs tutorial, the DOC
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
270 file, and the `yow' database.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
271 `VERSION' is the number of the Emacs version you are installing,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
272 like `18.59' or `19.0'. Since these files vary from one version
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
273 of Emacs to another, including the version number in the path
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
274 allows you to have several versions of Emacs installed at the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
275 same time; this means that you don't have to make Emacs
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
276 unavailable while installing a new version.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
277
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
278 `statedir' indicates where to put architecture-independent data files
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
279 that Emacs modifies while it runs; it defaults to
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
280 /usr/local/lib as well. We create the following
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
281 subdirectories under `statedir':
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
282 - `emacs/lock', containing files indicating who is editing
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
283 what, so Emacs can detect editing clashes between
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
284 users.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
285
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
286 `libdir' indicates where to put architecture-specific data files that
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
287 Emacs refers to as it runs; it too defaults to `/usr/local/lib'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
288 We create the following subdirectories under `libdir':
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
289 - `emacs/VERSION/CONFIGURATION-NAME', containing executable
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
290 programs used by Emacs that users are not expected to run
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
291 themselves.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
292 `VERSION' is the number of the Emacs version you are installing,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
293 and `CONFIGURATION-NAME' is the argument you gave to the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
294 `configure' program to identify the architecture and operating
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
295 system of your machine, like `mips-dec-ultrix' or
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
296 `sparc-sun-sunos'. Since these files are specific to the version
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
297 of Emacs, operating system, and architecture in use, including
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
298 the configuration name in the path allows you to have several
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
299 versions of Emacs for any mix of machines and operating systems
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
300 installed at the same time; this is useful for sites at which
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
301 different kinds of machines share the file system Emacs is
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
302 installed on.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
303
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
304 `infodir' indicates where to put the info files distributed with
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
305 Emacs; it defaults to `/usr/local/info'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
306
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
307 `mandir' indicates where to put the man pages for Emacs and its
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
308 utilities (like `etags'); it defaults to
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
309 `/usr/local/man/man1'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
310
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
311 `manext' gives the extension the man pages should be installed with.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
312 It should contain a period, followed by the appropriate
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
313 digit. It defaults to `.1'. For example given the default
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
314 values for `mandir' and `manext', the Emacs man page would be
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
315 installed as `/usr/local/man/man1/emacs.1'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
316
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
317 `prefix' doesn't give a path for any specific part of Emacs; instead,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
318 its value is used to determine the defaults for all the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
319 architecture-independent path variables - `datadir',
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
320 `statedir', `infodir', and `mandir'. Its default value is
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
321 `/usr/local'; the other variables add on `lib' or `man' to it
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
322 by default.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
323
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
324 For example, suppose your site generally places GNU software
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
325 under `/usr/users/software/gnusoft' instead of `/usr/local'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
326 By including
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
327 `prefix=/usr/users/software/gnusoft'
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
328 in the arguments to `make', you can instruct the build process
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
329 to place all of the Emacs data files in the appropriate
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
330 directories under that path.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
331
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
332 `exec_prefix' serves the same purpose as `prefix', but instead
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
333 determines the default values for the architecture-dependent
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
334 path variables - `bindir' and `libdir'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
335
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
336 The above variables serve analogous purposes in the makefiles for all
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
337 GNU software; here are some variables specific to Emacs.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
338
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
339 `lispdir' indicates where Emacs installs and expects its lisp
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
340 library. Its default value, based on `datadir' (see above),
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
341 is `/usr/local/lib/emacs/VERSION/lisp' (where `VERSION' is as
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
342 described above).
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
343
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
344 `locallisppath' indicates where Emacs should search for lisp files
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
345 specific to your site. It should be a colon-separated list of
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
346 directories; Emacs checks them in order before checking
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
347 `lispdir'. Its default value, based on `datadir' (see above),
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
348 is `/usr/local/lib/emacs/site-lisp'.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
349
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
350 `lisppath' is the complete list of directories Emacs should search for
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
351 its lisp files; its default value is the concatenation of
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
352 `lispdir' and `locallisppath'. It should be a colon-separated
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
353 list of directories; Emacs checks them in the order they
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
354 appear.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
355
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
356 `etcdir' indicates where Emacs should install and expect the rest of
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
357 its architecture-independent data, like the tutorial, DOC
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
358 file, and yow database. Its default value, based on `datadir'
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
359 (which see), is `/usr/local/lib/emacs/VERSION/etc'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
360
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
361 `lockdir' indicates the directory where Emacs keeps track of its
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
362 locking information. Its default value, based on `statedir'
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
363 (which see), is `/usr/local/lib/emacs/lock'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
364
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
365 `archlibdir' indicates where Emacs installs and expects the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
366 executable files and other architecture-dependent data it uses
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
367 while running. Its default value, based on `libdir' (which
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
368 see), is `/usr/local/lib/emacs/VERSION/CONFIGURATION-NAME'
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
369 (where VERSION and CONFIGURATION-NAME are as described above).
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
370
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
371 Remember that you must specify any variable values you need each time
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
372 you run `make' in the top directory. If you run `make' once to build
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
373 emacs, test it, and then run `make' again to install the files, you
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
374 must provide the same variable settings each time. To make the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
375 settings persist, you can edit them into the `Makefile' in the top
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
376 directory, but be aware that running the `configure' program erases
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
377 `Makefile' and rebuilds it from `Makefile.in'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
378
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
379 The top-level Makefile stores the variable settings it used in the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
380 Makefiles for the subdirectories, so you don't have to specify them
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
381 when running make in the subdirectories.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
382
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
383
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
384 CONFIGURATION BY HAND
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
385
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
386 Running the `configure' program performs the following steps.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
387
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
388 1) Copy `./src/config.h.in' to `./src/config.h'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
389
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
390 2) Consult `./etc/MACHINES' to see what configuration name you should
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
391 use for your system. Look at the code of the `configure' script to
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
392 see which operating system and architecture description files from
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
393 `src/s' and `src/m' should be used for that configuration name. Edit
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
394 `src/config.h', and change the two `#include' directives to include
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
395 the appropriate system and architecture description files.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
396
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
397 2) Edit `./src/config.h' to set the right options for your system. If
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
398 you need to override any of the definitions in the s/*.h and m/*.h
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
399 files for your system and machine, do so by editing config.h, not by
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
400 changing the s/*.h and m/*.h files. Occasionally you may need to
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
401 redefine parameters used in `./lib-src/movemail.c'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
402
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
403 3) If you're going to use the make utility to build Emacs, you will
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
404 still need to run `configure' first, giving theappropriate values for
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
405 the variables in the sections entitled "Things `configure' Might Edit"
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
406 and "Where To Install Things." Note that you may only need to change
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
407 the variables `prefix' and `exec_prefix', since the rest of the
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
408 variables have reasonable defaults based on them. For each Makefile
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
409 variable of this type, there is a corresponding configure option; for
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
410 example, to change the location of the lock directory, you might use
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
411
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
412 ./configure --lockdir=/nfs/emacslock
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
413
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
414 4) If you're going to use the build-install script to build Emacs,
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
415 copy `./build-ins.in' to `./build-install', and edit the
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
416 definitions found at the top of the script.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
417
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
418 The `configure' script is built from `configure.in' by the `autoconf'
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
419 program. However, since Emacs has configuration requirements that
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
420 autoconf can't meet, `configure.in' uses an marriage of custom-baked
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
421 configuration code and autoconf macros. New versions of autoconf
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
422 could very well break this arrangement, so it may be wise to avoid
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
423 rebuilding `configure' from `configure.in' when possible.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
424
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
425
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
426 BUILDING GNU EMACS BY HAND
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
427
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
428 Once Emacs is configured, running `make' or running the shell script
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
429 `build-install' in the top directory performs the following steps.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
430
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
431 1) Run `make src/paths.h' in the top directory. This produces
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
432 `./src/paths.h' from the template file `./src/paths.h.in', changing
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
433 the paths to the values specified in `./Makefile'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
434
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
435 2) Cd to `./lib-src' and run `make'. This creates executables named
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
436 `ctags' and `etags' and `wakeup' and `make-docfile' and `digest-doc'
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
437 and `test-distrib'. And others.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
438
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
439 3) Cd to `./src' and Run `make'. This refers to files in the `./lisp'
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
440 and `./lib-src' subdirectories using names `../lisp' and
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
441 `../lib-src'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
442
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
443 This creates a file `./src/emacs' which is the runnable Emacs,
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
444 assigning it a new build version number by incrementing the build
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
445 version stored in `./lisp/version.el'.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
446
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
447 It also creates a file in `./etc' whose name is `DOC' followed by the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
448 current Emacs version. This file contains documentation strings for
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
449 all the functions in Emacs. Each time you run make to make a new
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
450 emacs, a new DOC file with a new name is made. You must keep the DOC
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
451 file for an Emacs version as long as you keep using that Emacs
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
452 version.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
453
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
454
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
455 INSTALLATION BY HAND
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
456
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
457 The steps below are done by the shell script `build-install' or by
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
458 running `make install' in the main directory of the Emacs
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
459 distribution.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
460
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
461 1) Copy `./lisp' and its subdirectories, `./etc', and the executables
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
462 in `./lib-src' to their final destinations, as selected in `./src/paths.h'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
463
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
464 Strictly speaking, not all of the executables in `./lib-src' need be copied.
7627
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
465 - The programs `cvtmail', `emacsserver', `fakemail', `hexl',
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
466 `movemail', `timer', `vcdiff', `wakeup', and `yow' are used by
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
467 Emacs; they do need to be copied.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
468 - The programs `etags', `ctags', `emacsclient', `b2m', and `rcs2log'
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
469 are intended to be run by users; they are handled below.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
470 - The programs `make-docfile', `make-path', and `test-distrib' were
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
471 used in building Emacs, and are not needed any more.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
472 - The programs `digest-doc' and `sorted-doc' convert a `DOC' file into
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
473 a file for users to read. There is no important reason to move them.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
474
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
475 2) Copy the files in `./info' to the place specified in
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
476 `./lisp/site-init.el' or `./lisp/paths.el'. Note that if the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
477 destination directory already contains a file named `dir', you
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
478 probably don't want to replace it with the `dir' file in the Emacs
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
479 distribution. Instead, you should make sure that the existing `dir'
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
480 file contains an appropriate menu entry for the Emacs info.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
481
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
482 3) Create a directory for Emacs to use for clash detection, named as
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
483 indicated by the PATH_LOCK macro in `./src/paths.h'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
484
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
485 4) Copy `./src/emacs' to `/usr/local/bin', or to some other directory
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
486 in users' search paths. `./src/emacs' has an alternate name
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
487 `./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
488 `/usr/local/bin/emacs' pointing to that alternate name, as an easy way
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
489 of installing different versions.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
490
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
491 You can delete `./src/temacs'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
492
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
493 5) Copy the programs `b2m', `emacsclient', `ctags', `etags', and
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
494 `rcs2log' from `./lib-src' to `/usr/local/bin'. These programs are
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
495 intended for users to run.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
496
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
497 6) Copy the man pages in `./etc' for emacs, ctags, and etags into the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
498 appropriate man directories.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
499
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
500 7) The files in the `./src' subdirectory, except for `emacs', are not
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
501 used by Emacs once it is built. The source would be handy for
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
502 debugging.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
503
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
504
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
505 PROBLEMS
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
506
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
507 See the file PROBLEMS in this directory for a list of various
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
508 problems sometimes encountered, and what to do about them.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
509
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
510
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
511 Installation on MSDOG (a.k.a. MSDOS)
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
512
7627
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
513 To install on MSDOG, you need to have the GNU C compiler for MSDOG
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
514 (also known as djgpp), GNU Make, rm, mv, chmod, and sed. Type these
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
515 commands:
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
516
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
517 config msdos
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
518 make install
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
519
7627
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
520 To save disk space, Emacs is built with the idea that you will execute
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
521 it from the same place in the file system where you built it. As the
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
522 /usr/local/ subtree does not exist on most MSDOG systems, the
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
523 executables are placed in /emacs/bin/.
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
524
7627
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
525 MSDOG is a not a multitasking operating system, so Emacs features such
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
526 as asynchronous subprocesses that depend on multitasking will not
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
527 work. Synchronous subprocesses do work.