Mercurial > emacs
annotate INSTALL @ 15342:e64bd8310edc
(init_winsock): Dynamically link to SetHandleInformation.
(sys_socket): If possible, use SetHandleInformation to make socket
handle non-inheritable to avoid a bug in NT.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Thu, 06 Jun 1996 17:07:00 +0000 |
parents | 884b7293ccc7 |
children | 66a9ef0892a2 |
rev | line source |
---|---|
3199 | 1 GNU Emacs Installation Guide |
7627 | 2 Copyright (c) 1992, 1994 Free software Foundation, Inc. |
3199 | 3 |
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. | |
9 | |
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. | |
16 | |
17 | |
18 BUILDING AND INSTALLATION: | |
15209 | 19 |
20 (This is for a Unix or Unix-like system. For MSDOS, see below; search | |
21 for MSDOG. For Windows NT or Windows 95, see the file nt/INSTALL.) | |
3199 | 22 |
23 1) Make sure your system has enough swapping space allocated to handle | |
24 a program whose pure code is 900k bytes and whose data area is at | |
25 least 400k and can reach 8Mb or more. If the swapping space is | |
26 insufficient, you will get an error in the command `temacs -batch -l | |
13667
fbf777f663d3
Correct .in.in and .h.in in file names.
Richard M. Stallman <rms@gnu.org>
parents:
12620
diff
changeset
|
27 loadup dump', found in `./src/Makefile.in', or possibly when |
6062 | 28 running the final dumped Emacs. |
3199 | 29 |
12620 | 30 Building Emacs requires about 70 Mb of disk space (including the Emacs |
31 sources). Once installed, Emacs occupies about 35 Mb in the file | |
6062 | 32 system where it is installed; this includes the executable files, Lisp |
33 libraries, miscellaneous data files, and on-line documentation. If | |
34 the building and installation take place in different directories, | |
12620 | 35 then the installation procedure momentarily requires 70+35 Mb. |
3199 | 36 |
37 2) Consult `./etc/MACHINES' to see what configuration name you should | |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
38 give to the `configure' program. That file offers hints for |
3199 | 39 getting around some possible installation problems. |
40 | |
41 3) In the top directory of the Emacs distribution, run the program | |
42 `configure' as follows: | |
43 | |
44 ./configure CONFIGURATION-NAME [--OPTION[=VALUE]] ... | |
45 | |
46 The CONFIGURATION-NAME argument should be a configuration name given | |
47 in `./etc/MACHINES'. If omitted, `configure' will try to guess your | |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
48 system type; if it cannot, you must find the appropriate configuration |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
49 name in `./etc/MACHINES' and specify it explicitly. |
3199 | 50 |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
51 If you don't want X support, specify `--with-x=no'. If you omit this |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
52 option, `configure' will try to figure out for itself whether your |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
53 system has X, and arrange to use it if present. |
3199 | 54 |
55 The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build | |
56 process where the compiler should look for the include files and | |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
57 object libraries used with the X Window System. Normally, `configure' |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
58 is able to find them; these options are necessary if you have your X |
12042
02b843631c0f
Document how to specify a list to --x-includes and --x-libraries.
Karl Heuer <kwzh@gnu.org>
parents:
11905
diff
changeset
|
59 Window System files installed in unusual places. These options also |
02b843631c0f
Document how to specify a list to --x-includes and --x-libraries.
Karl Heuer <kwzh@gnu.org>
parents:
11905
diff
changeset
|
60 accept a list of directories, separated with colons. |
6062 | 61 |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
62 To get more attractive menus, you can specify an X toolkit when you |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
63 configure Emacs; use the option `--with-x-toolkit=TOOLKIT', where |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
64 TOOLKIT is `athena' or `motif' (`yes' and `lucid' are synonyms for |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
65 `athena'). On some systems, it does not work to use a toolkit with |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
66 shared libraries. |
3199 | 67 |
68 The `--with-gcc' option specifies that the build process should | |
69 compile Emacs using GCC. If you don't want to use GCC, specify | |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
70 `--with-gcc=no'. If you omit this option, `configure' will search |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
71 for GCC in your path, and use it if present. |
3199 | 72 |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
73 You can build Emacs for several different machine types from a single |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
74 source directory. To do this, you must use a version of `make' that |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
75 supports the `VPATH' variable, such as GNU `make'. Make separate |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
76 build directories for the different configuration types, and in each |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
77 one, run the Emacs `configure' script. `configure' looks for the |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
78 Emacs source code in the directory that `configure' is in. |
6062 | 79 |
3199 | 80 The `--prefix=PREFIXDIR' option specifies where the installation process |
81 should put emacs and its data files. This defaults to `/usr/local'. | |
82 - Emacs (and the other utilities users run) go in PREFIXDIR/bin | |
83 (unless the `--exec-prefix' option says otherwise). | |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
84 - The architecture-independent files go in PREFIXDIR/share/emacs/VERSION |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
85 (where VERSION is the version number of Emacs, like `19.27'). |
3199 | 86 - The architecture-dependent files go in |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
87 PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION |
3199 | 88 (where CONFIGURATION is the configuration name, like mips-dec-ultrix4.2), |
89 unless the `--exec-prefix' option says otherwise. | |
90 | |
91 The `--exec-prefix=EXECDIR' option allows you to specify a separate | |
92 portion of the directory tree for installing architecture-specific | |
93 files, like executables and utility programs. If specified, | |
94 - Emacs (and the other utilities users run) go in EXECDIR/bin, and | |
95 - The architecture-dependent files go in | |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
96 EXECDIR/libexec/emacs/VERSION/CONFIGURATION. |
3199 | 97 EXECDIR/bin should be a directory that is normally in users' PATHs. |
98 | |
99 For example, the command | |
100 | |
101 ./configure mips-dec-ultrix --with-x11 | |
102 | |
103 configures Emacs to build for a DECstation running Ultrix, with | |
104 support for the X11 window system. | |
105 | |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
106 `configure' doesn't do any compilation or installation |
3199 | 107 itself. It just creates the files that influence those things: |
9499 | 108 `./Makefile', `lib-src/Makefile', `oldXMenu/Makefile', |
109 `lwlib/Makefile', `src/Makefile', and `./src/config.h'. For details | |
110 on exactly what it does, see the section called `CONFIGURATION BY | |
111 HAND', below. | |
3199 | 112 |
113 When it is done, `configure' prints a description of what it did and | |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
114 creates a shell script `config.status' which, when run, recreates the |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
115 same configuration. If `configure' exits with an error after |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
116 disturbing the status quo, it removes `config.status'. `configure' |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
117 also creates a file `config.cache' that saves the results of its tests |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
118 to make reconfiguring faster, and a file `config.log' containing compiler |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
119 output (useful mainly for debugging `configure'). You can give |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
120 `configure' the option `--cache-file=FILE' to use the results of the |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
121 tests in FILE instead of `config.cache'. Set FILE to `/dev/null' to |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
122 disable caching, for debugging `configure'. |
3199 | 123 |
124 The work of `configure' can be done by editing various files in the | |
125 distribution, but using `configure' is supposed to be simpler. See | |
126 the section called "CONFIGURATION BY HAND" below if you want to do the | |
127 configuration yourself. | |
128 | |
129 4) Look at `./lisp/paths.el'; if some of those values are not right | |
11905 | 130 for your system, set up the file `./lisp/site-init.el' with Emacs |
131 Lisp code to override them; it is not a good idea to edit paths.el | |
3199 | 132 itself. YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES, |
133 rather than `defvar', as used by `./lisp/paths.el'. For example, | |
134 | |
135 (setq news-inews-program "/usr/bin/inews") | |
136 | |
137 is how you would override the default value of the variable | |
138 news-inews-program (which is "/usr/local/inews"). | |
139 | |
11119
c303d2623f63
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10672
diff
changeset
|
140 Before you override a variable this way, *look at the value* that the |
c303d2623f63
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10672
diff
changeset
|
141 variable gets by default! Make sure you know what kind of value the |
c303d2623f63
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10672
diff
changeset
|
142 variable should have. If you don't pay attention to what you are |
c303d2623f63
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10672
diff
changeset
|
143 doing, you'll make a mistake. |
c303d2623f63
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10672
diff
changeset
|
144 |
6062 | 145 5) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs |
146 Lisp code you want Emacs to load before it is dumped out. Use | |
147 site-load.el for additional libraries if you arrange for their | |
148 documentation strings to be in the etc/DOC file (see | |
13667
fbf777f663d3
Correct .in.in and .h.in in file names.
Richard M. Stallman <rms@gnu.org>
parents:
12620
diff
changeset
|
149 src/Makefile.in if you wish to figure out how to do that). For all |
7627 | 150 else, use site-init.el. |
3199 | 151 |
11732
072d319a485f
Clarify effect of setting load-path before dumping.
Richard M. Stallman <rms@gnu.org>
parents:
11729
diff
changeset
|
152 If you set load-path to a different value in site-init.el or |
072d319a485f
Clarify effect of setting load-path before dumping.
Richard M. Stallman <rms@gnu.org>
parents:
11729
diff
changeset
|
153 site-load.el, Emacs will use *precisely* that value when it starts up |
072d319a485f
Clarify effect of setting load-path before dumping.
Richard M. Stallman <rms@gnu.org>
parents:
11729
diff
changeset
|
154 again. If you do this, you are on your own! |
10672
0582cd3a31a6
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
9760
diff
changeset
|
155 |
3199 | 156 Note that, on some systems, the code you place in site-init.el must |
157 not use expand-file-name or any other function which may look | |
158 something up in the system's password and user information database. | |
159 See `./PROBLEMS' for more details on which systems this affects. | |
160 | |
7627 | 161 The `site-*.el' files are nonexistent in the distribution. You do not |
162 need to create them if you have nothing to put in them. | |
3199 | 163 |
164 6) Refer to the file `./etc/TERMS' for information on fields you may | |
165 wish to add to various termcap entries. The files `./etc/termcap.ucb' | |
166 and `./etc/termcap.dat' may already contain appropriately-modified | |
167 entries. | |
168 | |
169 7) Run `make' in the top directory of the Emacs distribution to finish | |
11733
ae51069237f2
Clarification about running executable in place.
Richard M. Stallman <rms@gnu.org>
parents:
11732
diff
changeset
|
170 building Emacs in the standard way. The final executable file is |
ae51069237f2
Clarification about running executable in place.
Richard M. Stallman <rms@gnu.org>
parents:
11732
diff
changeset
|
171 named `src/emacs'. You can execute this file "in place" without |
ae51069237f2
Clarification about running executable in place.
Richard M. Stallman <rms@gnu.org>
parents:
11732
diff
changeset
|
172 copying it, if you wish; then it automatically uses the sibling |
ae51069237f2
Clarification about running executable in place.
Richard M. Stallman <rms@gnu.org>
parents:
11732
diff
changeset
|
173 directories ../lisp, ../lib-src, ../info. |
3199 | 174 |
11733
ae51069237f2
Clarification about running executable in place.
Richard M. Stallman <rms@gnu.org>
parents:
11732
diff
changeset
|
175 Or you can "install" the executable and the other Emacs into their |
ae51069237f2
Clarification about running executable in place.
Richard M. Stallman <rms@gnu.org>
parents:
11732
diff
changeset
|
176 installed locations, with `make install'. By default, Emacs's files |
ae51069237f2
Clarification about running executable in place.
Richard M. Stallman <rms@gnu.org>
parents:
11732
diff
changeset
|
177 are installed in the following directories: |
3199 | 178 |
179 `/usr/local/bin' holds the executable programs users normally run - | |
7864 | 180 `emacs', `etags', `ctags', `b2m', `emacsclient', |
181 and `rcs-checkin'. | |
3199 | 182 |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
183 `/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library; |
3199 | 184 `VERSION' stands for the number of the Emacs version |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
185 you are installing, like `18.59' or `19.27'. Since the |
14147
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
186 Lisp library changes from one version of Emacs to |
3199 | 187 another, including the version number in the path |
188 allows you to have several versions of Emacs installed | |
14147
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
189 at the same time; in particular, you don't have to |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
190 make Emacs unavailable while installing a new version. |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
191 |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
192 `/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
193 files installed for Emacs version VERSION only. |
3199 | 194 |
14147
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
195 `/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
196 files installed for all Emacs versions. |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
197 |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
198 When Emacs is installed, it searches for its Lisp files |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
199 in `/usr/local/share/emacs/VERSION/site-lisp', then in |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
200 `/usr/local/share/emacs/site-lisp', and finally in |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
201 `/usr/local/share/emacs/VERSION/lisp'. |
3199 | 202 |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
203 `/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC |
3199 | 204 file, the `yow' database, and other |
205 architecture-independent files Emacs might need while | |
206 running. VERSION is as specified for `.../lisp'. | |
207 | |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
208 `/usr/local/com/emacs/lock' contains files indicating who is editing |
3199 | 209 what, so Emacs can detect editing clashes between |
210 users. | |
211 | |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
212 `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable |
3199 | 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. | |
227 | |
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. | |
232 | |
233 `/usr/local/man/man1' holds the man pages for the programs installed | |
234 in `/usr/local/bin'. | |
235 | |
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 | |
14147
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
238 for its Lisp files by giving values for `make' variables as part of |
3199 | 239 the command. See the section below called `MAKE VARIABLES' for more |
240 information on this. | |
241 | |
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. | |
245 | |
6062 | 246 9) If your system uses lock files to interlock access to mailer inbox files, |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
247 then you might need to make the movemail program setuid or setgid |
6062 | 248 to enable it to write the lock files. We believe this is safe. |
249 | |
12620 | 250 10) You are done! You can remove executables and object files from |
251 the build directory by typing `make clean'. To also remove the files | |
252 that `configure' created (so you can compile Emacs for a different | |
253 configuration), type `make distclean'. | |
254 | |
3199 | 255 |
256 | |
257 MAKE VARIABLES | |
258 | |
259 You can change where the build process installs Emacs and its data | |
260 files by specifying values for `make' variables as part of the `make' | |
261 command line. For example, if you type | |
262 | |
263 make install bindir=/usr/local/gnubin | |
264 | |
265 the `bindir=/usr/local/gnubin' argument indicates that the Emacs | |
266 executable files should go in `/usr/local/gnubin', not | |
267 `/usr/local/bin'. | |
268 | |
269 Here is a complete list of the variables you may want to set. | |
270 | |
271 `bindir' indicates where to put executable programs that users can | |
272 run. This defaults to /usr/local/bin. | |
273 | |
274 `datadir' indicates where to put the architecture-independent | |
275 read-only data files that Emacs refers to while it runs; it | |
9499 | 276 defaults to /usr/local/share. We create the following |
3199 | 277 subdirectories under `datadir': |
14147
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
278 - `emacs/VERSION/lisp', containing the Emacs Lisp library, and |
3199 | 279 - `emacs/VERSION/etc', containing the Emacs tutorial, the DOC |
280 file, and the `yow' database. | |
281 `VERSION' is the number of the Emacs version you are installing, | |
282 like `18.59' or `19.0'. Since these files vary from one version | |
283 of Emacs to another, including the version number in the path | |
284 allows you to have several versions of Emacs installed at the | |
285 same time; this means that you don't have to make Emacs | |
286 unavailable while installing a new version. | |
287 | |
9499 | 288 `sharedstatedir' indicates where to put architecture-independent data files |
3199 | 289 that Emacs modifies while it runs; it defaults to |
9499 | 290 /usr/local/com. We create the following |
291 subdirectories under `sharedstatedir': | |
3199 | 292 - `emacs/lock', containing files indicating who is editing |
293 what, so Emacs can detect editing clashes between | |
294 users. | |
295 | |
9499 | 296 `libexecdir' indicates where to put architecture-specific data files that |
297 Emacs refers to as it runs; it defaults to `/usr/local/libexec'. | |
298 We create the following subdirectories under `libexecdir': | |
3199 | 299 - `emacs/VERSION/CONFIGURATION-NAME', containing executable |
300 programs used by Emacs that users are not expected to run | |
301 themselves. | |
302 `VERSION' is the number of the Emacs version you are installing, | |
303 and `CONFIGURATION-NAME' is the argument you gave to the | |
304 `configure' program to identify the architecture and operating | |
305 system of your machine, like `mips-dec-ultrix' or | |
306 `sparc-sun-sunos'. Since these files are specific to the version | |
307 of Emacs, operating system, and architecture in use, including | |
308 the configuration name in the path allows you to have several | |
309 versions of Emacs for any mix of machines and operating systems | |
310 installed at the same time; this is useful for sites at which | |
311 different kinds of machines share the file system Emacs is | |
312 installed on. | |
313 | |
314 `infodir' indicates where to put the info files distributed with | |
315 Emacs; it defaults to `/usr/local/info'. | |
316 | |
317 `mandir' indicates where to put the man pages for Emacs and its | |
318 utilities (like `etags'); it defaults to | |
319 `/usr/local/man/man1'. | |
320 | |
321 `manext' gives the extension the man pages should be installed with. | |
322 It should contain a period, followed by the appropriate | |
323 digit. It defaults to `.1'. For example given the default | |
324 values for `mandir' and `manext', the Emacs man page would be | |
325 installed as `/usr/local/man/man1/emacs.1'. | |
326 | |
327 `prefix' doesn't give a path for any specific part of Emacs; instead, | |
328 its value is used to determine the defaults for all the | |
329 architecture-independent path variables - `datadir', | |
9499 | 330 `sharedstatedir', `infodir', and `mandir'. Its default value is |
3199 | 331 `/usr/local'; the other variables add on `lib' or `man' to it |
332 by default. | |
333 | |
334 For example, suppose your site generally places GNU software | |
335 under `/usr/users/software/gnusoft' instead of `/usr/local'. | |
336 By including | |
337 `prefix=/usr/users/software/gnusoft' | |
338 in the arguments to `make', you can instruct the build process | |
339 to place all of the Emacs data files in the appropriate | |
340 directories under that path. | |
341 | |
342 `exec_prefix' serves the same purpose as `prefix', but instead | |
343 determines the default values for the architecture-dependent | |
9499 | 344 path variables - `bindir' and `libexecdir'. |
3199 | 345 |
346 The above variables serve analogous purposes in the makefiles for all | |
347 GNU software; here are some variables specific to Emacs. | |
348 | |
14147
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
349 `lispdir' indicates where Emacs installs and expects its Lisp library. |
12620 | 350 Its default value, based on `datadir' (see above), is |
351 `/usr/local/share/emacs/VERSION/lisp' (where `VERSION' is as | |
3199 | 352 described above). |
353 | |
14147
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
354 `locallisppath' indicates where Emacs should search for Lisp files |
3199 | 355 specific to your site. It should be a colon-separated list of |
356 directories; Emacs checks them in order before checking | |
14147
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
357 `lispdir'. Its default value, based on `datadir' (see above), is |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
358 `/usr/local/share/emacs/VERSION/site-lisp:/usr/local/share/emacs/site-lisp'. |
3199 | 359 |
360 `lisppath' is the complete list of directories Emacs should search for | |
14147
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
361 its Lisp files; its default value is the concatenation of |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
362 `locallisppath' and `lispdir'. It should be a colon-separated |
3199 | 363 list of directories; Emacs checks them in the order they |
364 appear. | |
365 | |
366 `etcdir' indicates where Emacs should install and expect the rest of | |
367 its architecture-independent data, like the tutorial, DOC | |
368 file, and yow database. Its default value, based on `datadir' | |
12620 | 369 (which see), is `/usr/local/share/emacs/VERSION/etc'. |
3199 | 370 |
371 `lockdir' indicates the directory where Emacs keeps track of its | |
12620 | 372 locking information. Its default value, based on |
373 `sharedstatedir' (which see), is `/usr/local/com/emacs/lock'. | |
3199 | 374 |
12620 | 375 `archlibdir' indicates where Emacs installs and expects the executable |
376 files and other architecture-dependent data it uses while | |
377 running. Its default value, based on `libexecdir' (which | |
378 see), is `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' | |
3199 | 379 (where VERSION and CONFIGURATION-NAME are as described above). |
380 | |
381 Remember that you must specify any variable values you need each time | |
382 you run `make' in the top directory. If you run `make' once to build | |
383 emacs, test it, and then run `make' again to install the files, you | |
384 must provide the same variable settings each time. To make the | |
385 settings persist, you can edit them into the `Makefile' in the top | |
386 directory, but be aware that running the `configure' program erases | |
387 `Makefile' and rebuilds it from `Makefile.in'. | |
388 | |
389 The top-level Makefile stores the variable settings it used in the | |
390 Makefiles for the subdirectories, so you don't have to specify them | |
391 when running make in the subdirectories. | |
392 | |
393 | |
394 CONFIGURATION BY HAND | |
395 | |
7864 | 396 Instead of running the `configure' program, you have to perform the |
397 following steps. | |
3199 | 398 |
13667
fbf777f663d3
Correct .in.in and .h.in in file names.
Richard M. Stallman <rms@gnu.org>
parents:
12620
diff
changeset
|
399 1) Copy `./src/config.in' to `./src/config.h'. |
3199 | 400 |
401 2) Consult `./etc/MACHINES' to see what configuration name you should | |
402 use for your system. Look at the code of the `configure' script to | |
403 see which operating system and architecture description files from | |
404 `src/s' and `src/m' should be used for that configuration name. Edit | |
405 `src/config.h', and change the two `#include' directives to include | |
406 the appropriate system and architecture description files. | |
407 | |
408 2) Edit `./src/config.h' to set the right options for your system. If | |
409 you need to override any of the definitions in the s/*.h and m/*.h | |
410 files for your system and machine, do so by editing config.h, not by | |
411 changing the s/*.h and m/*.h files. Occasionally you may need to | |
412 redefine parameters used in `./lib-src/movemail.c'. | |
413 | |
7864 | 414 3) Create src/Makefile and lib-src/Makefile from the corresponding |
13667
fbf777f663d3
Correct .in.in and .h.in in file names.
Richard M. Stallman <rms@gnu.org>
parents:
12620
diff
changeset
|
415 `Makefile.in' files. First copy `Makefile.in' to `Makefile.c', |
14020 | 416 then edit in appropriate substitutions for the @...@ constructs, |
7864 | 417 and then copy the shell commands near the end of `configure' |
418 that run cpp to construct `Makefile'. | |
3199 | 419 |
7864 | 420 4) Create `Makefile' files in various other directories |
421 from the corresponding `Makefile.in' files. This isn't so hard, | |
422 just a matter of substitution. | |
3199 | 423 |
424 The `configure' script is built from `configure.in' by the `autoconf' | |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
425 program. You need version 2.0 or newer of `autoconf' to rebuild `configure'. |
3199 | 426 |
427 BUILDING GNU EMACS BY HAND | |
428 | |
9507 | 429 Once Emacs is configured, running `make' in the top directory performs |
430 the following steps. | |
3199 | 431 |
432 1) Run `make src/paths.h' in the top directory. This produces | |
13667
fbf777f663d3
Correct .in.in and .h.in in file names.
Richard M. Stallman <rms@gnu.org>
parents:
12620
diff
changeset
|
433 `./src/paths.h' from the template file `./src/paths.in', changing |
3199 | 434 the paths to the values specified in `./Makefile'. |
435 | |
7864 | 436 2) Go to directory `./lib-src' and run `make'. This creates |
437 executables named `ctags' and `etags' and `wakeup' and `make-docfile' | |
438 and `digest-doc' and `test-distrib'. And others. | |
3199 | 439 |
7864 | 440 3) Go to directory `./src' and Run `make'. This refers to files in |
441 the `./lisp' and `./lib-src' subdirectories using names `../lisp' and | |
3199 | 442 `../lib-src'. |
443 | |
444 This creates a file `./src/emacs' which is the runnable Emacs, | |
7864 | 445 which has another name that contains a version number. |
446 Each time you do this, that version number increments in the last place. | |
3199 | 447 |
448 It also creates a file in `./etc' whose name is `DOC' followed by the | |
449 current Emacs version. This file contains documentation strings for | |
450 all the functions in Emacs. Each time you run make to make a new | |
451 emacs, a new DOC file with a new name is made. You must keep the DOC | |
452 file for an Emacs version as long as you keep using that Emacs | |
453 version. | |
454 | |
455 | |
456 INSTALLATION BY HAND | |
457 | |
9507 | 458 The steps below are done by running `make install' in the main |
459 directory of the Emacs distribution. | |
3199 | 460 |
461 1) Copy `./lisp' and its subdirectories, `./etc', and the executables | |
462 in `./lib-src' to their final destinations, as selected in `./src/paths.h'. | |
463 | |
464 Strictly speaking, not all of the executables in `./lib-src' need be copied. | |
7627 | 465 - The programs `cvtmail', `emacsserver', `fakemail', `hexl', |
7864 | 466 `movemail', `profile', `rcs2log', `timer', `vcdiff', `wakeup', |
467 and `yow' are used by Emacs; they do need to be copied. | |
468 - The programs `etags', `ctags', `emacsclient', `b2m', and `rcs-checkin' | |
3199 | 469 are intended to be run by users; they are handled below. |
9498 | 470 - The programs `make-docfile' and `test-distrib' were |
3199 | 471 used in building Emacs, and are not needed any more. |
472 - The programs `digest-doc' and `sorted-doc' convert a `DOC' file into | |
473 a file for users to read. There is no important reason to move them. | |
474 | |
475 2) Copy the files in `./info' to the place specified in | |
476 `./lisp/site-init.el' or `./lisp/paths.el'. Note that if the | |
477 destination directory already contains a file named `dir', you | |
478 probably don't want to replace it with the `dir' file in the Emacs | |
479 distribution. Instead, you should make sure that the existing `dir' | |
480 file contains an appropriate menu entry for the Emacs info. | |
481 | |
482 3) Create a directory for Emacs to use for clash detection, named as | |
483 indicated by the PATH_LOCK macro in `./src/paths.h'. | |
484 | |
485 4) Copy `./src/emacs' to `/usr/local/bin', or to some other directory | |
486 in users' search paths. `./src/emacs' has an alternate name | |
487 `./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named | |
488 `/usr/local/bin/emacs' pointing to that alternate name, as an easy way | |
489 of installing different versions. | |
490 | |
491 You can delete `./src/temacs'. | |
492 | |
493 5) Copy the programs `b2m', `emacsclient', `ctags', `etags', and | |
7864 | 494 `rcs-checkin' from `./lib-src' to `/usr/local/bin'. These programs are |
3199 | 495 intended for users to run. |
496 | |
497 6) Copy the man pages in `./etc' for emacs, ctags, and etags into the | |
498 appropriate man directories. | |
499 | |
500 7) The files in the `./src' subdirectory, except for `emacs', are not | |
7864 | 501 used by Emacs once it is built. However, it is very desirable to keep |
502 the source on line for debugging. | |
3199 | 503 |
504 | |
505 PROBLEMS | |
506 | |
507 See the file PROBLEMS in this directory for a list of various | |
508 problems sometimes encountered, and what to do about them. | |
509 | |
510 | |
6062 | 511 Installation on MSDOG (a.k.a. MSDOS) |
512 | |
7627 | 513 To install on MSDOG, you need to have the GNU C compiler for MSDOG |
15016
6c9d4880793a
Don't sey djgpp must be version 1.
Richard M. Stallman <rms@gnu.org>
parents:
14601
diff
changeset
|
514 (also known as djgpp), GNU Make, rm, mv, chmod, and sed. See the |
6c9d4880793a
Don't sey djgpp must be version 1.
Richard M. Stallman <rms@gnu.org>
parents:
14601
diff
changeset
|
515 remarks in config.bat for more information about locations and |
6c9d4880793a
Don't sey djgpp must be version 1.
Richard M. Stallman <rms@gnu.org>
parents:
14601
diff
changeset
|
516 versions. |
6062 | 517 |
15017 | 518 If you are compiling on an MSDOG-like system which has long file |
519 names, you may need to do `SET LFN=y' for some of the commands, | |
520 especially the compilation commands. It might be more convenient to | |
15039
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
521 unpack the Emacs distribution with djtar, which comes with djgpp; if |
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
522 you do `SET LFN=n' before unpacking, djtar truncates file names to 8.3 |
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
523 naming as it extracts files, even if the system allows long file |
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
524 names, and this ensures that build procedures designed for 8.3 file |
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
525 names still work. Use djtar with the command `djtar -x foo.tar' or |
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
526 `djtar -x foo.tgz'. |
15017 | 527 |
12343 | 528 Some users report that running Emacs 19.29 requires dpmi memory |
12339
3398b88cbd25
Update MSDOS needs list.
Richard M. Stallman <rms@gnu.org>
parents:
12042
diff
changeset
|
529 management. We do not know why this is so, since 19.28 did not need |
15017 | 530 it. If we find out what change introduced this requirement, we may |
531 try to eliminate it. ("May" because perhaps djgpp version 2's | |
532 improved dpmi handling means this is no longer a problem.) | |
533 | |
534 It is possible that this problem happens only when there is not enough | |
535 physical memory on the machine. | |
12339
3398b88cbd25
Update MSDOS needs list.
Richard M. Stallman <rms@gnu.org>
parents:
12042
diff
changeset
|
536 |
12343 | 537 You can find out if you have a dpmi host by running go32 (part of |
538 djgpp) without arguments; it will tell you if it uses dpmi memory. | |
539 For more information about dpmi memory, consult the djgpp FAQ. | |
540 | |
12339
3398b88cbd25
Update MSDOS needs list.
Richard M. Stallman <rms@gnu.org>
parents:
12042
diff
changeset
|
541 To build and install Emacs, type these commands: |
3398b88cbd25
Update MSDOS needs list.
Richard M. Stallman <rms@gnu.org>
parents:
12042
diff
changeset
|
542 |
3398b88cbd25
Update MSDOS needs list.
Richard M. Stallman <rms@gnu.org>
parents:
12042
diff
changeset
|
543 config msdos |
3398b88cbd25
Update MSDOS needs list.
Richard M. Stallman <rms@gnu.org>
parents:
12042
diff
changeset
|
544 make install |
6062 | 545 |
15039
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
546 Building Emacs creates executable files in the src and lib-src |
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
547 directories. Installing Emacs on MSDOS moves these executables to a |
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
548 sibling directory called bin. For example, if you build in directory |
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
549 /emacs, installing moves the executables from /emacs/src and |
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
550 /emacs/lib-src to the directory /emacs/bin, so you can then delete the |
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
551 subdirectories /emacs/src and /emacs/lib-src if you wish. The only |
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
552 subdirectories you need to keep are bin, lisp, etc and info. |
12349
f5ba89f88cfd
Talk about MSDOS type conflict workaround.
Richard M. Stallman <rms@gnu.org>
parents:
12343
diff
changeset
|
553 |
15039
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
554 Emacs on MSDOS finds the lisp, etc and info directories by looking in |
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
555 ../lisp, ../etc and ../info, starting from the directory where the |
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
556 Emacs executable was run from. You can override this by setting the |
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
557 environment variable HOME; if you do that, the directories lisp, etc |
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
558 and info are accessed as subdirectories of the HOME directory. |
6062 | 559 |
7627 | 560 MSDOG is a not a multitasking operating system, so Emacs features such |
561 as asynchronous subprocesses that depend on multitasking will not | |
562 work. Synchronous subprocesses do work. |