3199
|
1 GNU Emacs Installation Guide
|
19899
|
2 Copyright (c) 1992, 1994, 1996, 1997 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
|
19014
|
18 ADDITIONAL DISTRIBUTION FILES
|
|
19
|
|
20 * leim-M.N.tar.gz
|
|
21
|
|
22 The Emacs Lisp code for input methods for various international
|
24799
|
23 character scripts is distributed in a separate tar file because it
|
|
24 amounts to a significant fraction of the size of the distribution.
|
|
25 This tar file is called leim-M.N.tar.gz, with the same version number
|
|
26 as Emacs, and it unpacks into the directory emacs-M.N/leim.
|
19014
|
27
|
24799
|
28 You should unpack leim-M.N.tar.gz into the same directory where you
|
|
29 have previously unpacked the main Emacs distribution. It fills in the
|
|
30 contents of one subdirectory, which is present in the main Emacs
|
|
31 distribution only in dummy form.
|
|
32
|
|
33 Once you have unpacked the Leim tar file into the Emacs source tree,
|
|
34 building and installing Emacs automatically installs the input method
|
|
35 support as well. If you have built Emacs without unpacking Leim
|
|
36 first, just unpack Leim, build Emacs again, and install it again.
|
19014
|
37
|
|
38 * intlfonts-VERSION.tar.gz
|
|
39
|
|
40 The intlfonts distribution contains X11 fonts that Emacs needs in
|
|
41 order to display international characters. If you see a non-ASCII
|
|
42 character appear as a hollow box, that means you don't have a font for
|
19899
|
43 it. You might find a font in the intlfonts distribution. If some
|
|
44 characters don't look right, or appear improperly aligned, a font
|
20213
|
45 from the intlfonts distribution might look better.
|
19899
|
46
|
24070
|
47 The fonts in the intlfonts distribution are also used by the ps-print
|
|
48 package for printing international characters. The file
|
|
49 lisp/ps-mule.el defines the .bdf font files required for printing
|
|
50 each character set.
|
|
51
|
19899
|
52 The intlfonts distribution contains its own installation instructions,
|
|
53 in the intlfonts/README file.
|
19014
|
54
|
26416
|
55 * elisp-manual-M.N.tar.gz
|
|
56
|
|
57 This distribution contains the Emacs Lisp Reference Manual which
|
|
58 complements the Emacs Lisp Manual. It is a good idea to install the
|
|
59 Emacs Lisp Reference Manual after installing Emacs, to complete the
|
|
60 on-line documentation of Emacs in Info.
|
|
61
|
|
62 If you have installed Texinfo, you can install the Emacs Lisp
|
|
63 Reference Manual this way:
|
26271
|
64
|
26416
|
65 cd elisp-manual-M.N
|
|
66 ./configure --prefix=PREFIXDIR
|
|
67 make install
|
|
68
|
|
69 Otherwise, you can install it manually. Just copy the files elisp and
|
|
70 elisp-* from the elisp-manual-M.N directory to your site's info
|
|
71 directory (see the description of `infodir', below), and make sure
|
|
72 that file `dir' in this directory contains an entry like this:
|
|
73
|
|
74 * Elisp: (elisp). The Emacs Lisp Reference Manual.
|
26271
|
75
|
19014
|
76
|
3199
|
77 BUILDING AND INSTALLATION:
|
15209
|
78
|
|
79 (This is for a Unix or Unix-like system. For MSDOS, see below; search
|
|
80 for MSDOG. For Windows NT or Windows 95, see the file nt/INSTALL.)
|
3199
|
81
|
|
82 1) Make sure your system has enough swapping space allocated to handle
|
|
83 a program whose pure code is 900k bytes and whose data area is at
|
|
84 least 400k and can reach 8Mb or more. If the swapping space is
|
|
85 insufficient, you will get an error in the command `temacs -batch -l
|
13667
|
86 loadup dump', found in `./src/Makefile.in', or possibly when
|
6062
|
87 running the final dumped Emacs.
|
3199
|
88
|
12620
|
89 Building Emacs requires about 70 Mb of disk space (including the Emacs
|
|
90 sources). Once installed, Emacs occupies about 35 Mb in the file
|
6062
|
91 system where it is installed; this includes the executable files, Lisp
|
|
92 libraries, miscellaneous data files, and on-line documentation. If
|
|
93 the building and installation take place in different directories,
|
12620
|
94 then the installation procedure momentarily requires 70+35 Mb.
|
3199
|
95
|
|
96 2) Consult `./etc/MACHINES' to see what configuration name you should
|
9760
|
97 give to the `configure' program. That file offers hints for
|
3199
|
98 getting around some possible installation problems.
|
|
99
|
16309
|
100 3) You can build Emacs in the top-level Emacs source directory
|
|
101 or in a separate directory.
|
|
102
|
|
103 3a) To build in the top-level Emacs source directory, go to that
|
|
104 directory and run the program `configure' as follows:
|
3199
|
105
|
22255
|
106 ./configure [CONFIGURATION-NAME] [--OPTION[=VALUE]] ...
|
3199
|
107
|
|
108 The CONFIGURATION-NAME argument should be a configuration name given
|
22255
|
109 in `./etc/MACHINES', with the system version number added at the end.
|
|
110
|
|
111 You should try first omitting CONFIGURATION-NAME. This way,
|
|
112 `configure' will try to guess your system type. If it cannot guess,
|
|
113 or if something goes wrong in building or installing Emacs this way,
|
|
114 try again specifying the proper CONFIGURATION-NAME explicitly.
|
3199
|
115
|
9760
|
116 If you don't want X support, specify `--with-x=no'. If you omit this
|
|
117 option, `configure' will try to figure out for itself whether your
|
|
118 system has X, and arrange to use it if present.
|
3199
|
119
|
|
120 The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build
|
|
121 process where the compiler should look for the include files and
|
9760
|
122 object libraries used with the X Window System. Normally, `configure'
|
|
123 is able to find them; these options are necessary if you have your X
|
12042
|
124 Window System files installed in unusual places. These options also
|
|
125 accept a list of directories, separated with colons.
|
6062
|
126
|
9760
|
127 To get more attractive menus, you can specify an X toolkit when you
|
|
128 configure Emacs; use the option `--with-x-toolkit=TOOLKIT', where
|
|
129 TOOLKIT is `athena' or `motif' (`yes' and `lucid' are synonyms for
|
|
130 `athena'). On some systems, it does not work to use a toolkit with
|
|
131 shared libraries.
|
3199
|
132
|
|
133 The `--with-gcc' option specifies that the build process should
|
|
134 compile Emacs using GCC. If you don't want to use GCC, specify
|
9760
|
135 `--with-gcc=no'. If you omit this option, `configure' will search
|
|
136 for GCC in your path, and use it if present.
|
3199
|
137
|
15936
|
138 If you want the Emacs mail reader RMAIL to read mail from a POP
|
|
139 server, you must specify `--with-pop'. This provides support for the
|
|
140 POP3 protocol; older versions are not supported. For
|
|
141 Kerberos-authenticated POP add `--with-kerberos', for Hesiod support
|
|
142 add `--with-hesiod'. These options enable Emacs to use POP; whether
|
|
143 Emacs uses POP is controlled by individual users--see the Rmail
|
|
144 chapter of the Emacs manual.
|
|
145
|
3199
|
146 The `--prefix=PREFIXDIR' option specifies where the installation process
|
|
147 should put emacs and its data files. This defaults to `/usr/local'.
|
|
148 - Emacs (and the other utilities users run) go in PREFIXDIR/bin
|
|
149 (unless the `--exec-prefix' option says otherwise).
|
9760
|
150 - The architecture-independent files go in PREFIXDIR/share/emacs/VERSION
|
|
151 (where VERSION is the version number of Emacs, like `19.27').
|
3199
|
152 - The architecture-dependent files go in
|
9760
|
153 PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION
|
3199
|
154 (where CONFIGURATION is the configuration name, like mips-dec-ultrix4.2),
|
|
155 unless the `--exec-prefix' option says otherwise.
|
|
156
|
|
157 The `--exec-prefix=EXECDIR' option allows you to specify a separate
|
|
158 portion of the directory tree for installing architecture-specific
|
|
159 files, like executables and utility programs. If specified,
|
|
160 - Emacs (and the other utilities users run) go in EXECDIR/bin, and
|
|
161 - The architecture-dependent files go in
|
9760
|
162 EXECDIR/libexec/emacs/VERSION/CONFIGURATION.
|
3199
|
163 EXECDIR/bin should be a directory that is normally in users' PATHs.
|
|
164
|
|
165 For example, the command
|
|
166
|
|
167 ./configure mips-dec-ultrix --with-x11
|
|
168
|
|
169 configures Emacs to build for a DECstation running Ultrix, with
|
|
170 support for the X11 window system.
|
|
171
|
9760
|
172 `configure' doesn't do any compilation or installation
|
3199
|
173 itself. It just creates the files that influence those things:
|
9499
|
174 `./Makefile', `lib-src/Makefile', `oldXMenu/Makefile',
|
|
175 `lwlib/Makefile', `src/Makefile', and `./src/config.h'. For details
|
|
176 on exactly what it does, see the section called `CONFIGURATION BY
|
|
177 HAND', below.
|
3199
|
178
|
|
179 When it is done, `configure' prints a description of what it did and
|
9760
|
180 creates a shell script `config.status' which, when run, recreates the
|
|
181 same configuration. If `configure' exits with an error after
|
|
182 disturbing the status quo, it removes `config.status'. `configure'
|
|
183 also creates a file `config.cache' that saves the results of its tests
|
|
184 to make reconfiguring faster, and a file `config.log' containing compiler
|
|
185 output (useful mainly for debugging `configure'). You can give
|
|
186 `configure' the option `--cache-file=FILE' to use the results of the
|
|
187 tests in FILE instead of `config.cache'. Set FILE to `/dev/null' to
|
|
188 disable caching, for debugging `configure'.
|
3199
|
189
|
|
190 The work of `configure' can be done by editing various files in the
|
16309
|
191 distribution, but using `configure' is easier. See the section called
|
|
192 "CONFIGURATION BY HAND" below if you want to do the configuration
|
|
193 yourself.
|
|
194
|
|
195 3b) To build in a separate directory, go to that directory
|
|
196 and run the program `configure' as follows:
|
|
197
|
|
198 SOURCE-DIR/configure CONFIGURATION-NAME [--OPTION[=VALUE]] ...
|
|
199
|
|
200 SOURCE-DIR refers to the top-level Emacs source directory which is
|
|
201 where Emacs's configure script is located. `configure' looks for the
|
|
202 Emacs source code in the directory that `configure' is in.
|
|
203
|
|
204 To build in a separate directory, you must use a version of `make'
|
|
205 that supports the `VPATH' variable, such as GNU `make'.
|
3199
|
206
|
21692
|
207 3c) Some people try to build in a separate directory by filling
|
|
208 it full of symlinks to the files in the real source directory.
|
21691
|
209 If you do that, `make all' does work, but `make install' fails:
|
|
210 it copies the symbolic links rather than the actual files.
|
|
211
|
|
212 As far as is known, there is no particular reason to use
|
|
213 a directory full of links rather than use the standard GNU
|
|
214 facilities to build in a separate directory (see 3b above).
|
|
215
|
3199
|
216 4) Look at `./lisp/paths.el'; if some of those values are not right
|
11905
|
217 for your system, set up the file `./lisp/site-init.el' with Emacs
|
|
218 Lisp code to override them; it is not a good idea to edit paths.el
|
3199
|
219 itself. YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES,
|
|
220 rather than `defvar', as used by `./lisp/paths.el'. For example,
|
|
221
|
|
222 (setq news-inews-program "/usr/bin/inews")
|
|
223
|
|
224 is how you would override the default value of the variable
|
|
225 news-inews-program (which is "/usr/local/inews").
|
|
226
|
11119
|
227 Before you override a variable this way, *look at the value* that the
|
|
228 variable gets by default! Make sure you know what kind of value the
|
|
229 variable should have. If you don't pay attention to what you are
|
|
230 doing, you'll make a mistake.
|
|
231
|
6062
|
232 5) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs
|
|
233 Lisp code you want Emacs to load before it is dumped out. Use
|
|
234 site-load.el for additional libraries if you arrange for their
|
|
235 documentation strings to be in the etc/DOC file (see
|
13667
|
236 src/Makefile.in if you wish to figure out how to do that). For all
|
23330
|
237 else, use site-init.el. Do not load byte-compiled code which
|
|
238 was build with a non-nil value of `byte-compile-dynamic'.
|
3199
|
239
|
11732
|
240 If you set load-path to a different value in site-init.el or
|
|
241 site-load.el, Emacs will use *precisely* that value when it starts up
|
|
242 again. If you do this, you are on your own!
|
10672
|
243
|
3199
|
244 Note that, on some systems, the code you place in site-init.el must
|
|
245 not use expand-file-name or any other function which may look
|
|
246 something up in the system's password and user information database.
|
21089
|
247 See `./etc/PROBLEMS' for more details on which systems this affects.
|
3199
|
248
|
7627
|
249 The `site-*.el' files are nonexistent in the distribution. You do not
|
|
250 need to create them if you have nothing to put in them.
|
3199
|
251
|
|
252 6) Refer to the file `./etc/TERMS' for information on fields you may
|
|
253 wish to add to various termcap entries. The files `./etc/termcap.ucb'
|
|
254 and `./etc/termcap.dat' may already contain appropriately-modified
|
|
255 entries.
|
|
256
|
|
257 7) Run `make' in the top directory of the Emacs distribution to finish
|
11733
|
258 building Emacs in the standard way. The final executable file is
|
|
259 named `src/emacs'. You can execute this file "in place" without
|
|
260 copying it, if you wish; then it automatically uses the sibling
|
|
261 directories ../lisp, ../lib-src, ../info.
|
3199
|
262
|
11733
|
263 Or you can "install" the executable and the other Emacs into their
|
|
264 installed locations, with `make install'. By default, Emacs's files
|
|
265 are installed in the following directories:
|
3199
|
266
|
|
267 `/usr/local/bin' holds the executable programs users normally run -
|
7864
|
268 `emacs', `etags', `ctags', `b2m', `emacsclient',
|
|
269 and `rcs-checkin'.
|
3199
|
270
|
9760
|
271 `/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library;
|
3199
|
272 `VERSION' stands for the number of the Emacs version
|
9760
|
273 you are installing, like `18.59' or `19.27'. Since the
|
14147
|
274 Lisp library changes from one version of Emacs to
|
3199
|
275 another, including the version number in the path
|
|
276 allows you to have several versions of Emacs installed
|
14147
|
277 at the same time; in particular, you don't have to
|
|
278 make Emacs unavailable while installing a new version.
|
|
279
|
|
280 `/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp
|
|
281 files installed for Emacs version VERSION only.
|
3199
|
282
|
14147
|
283 `/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp
|
|
284 files installed for all Emacs versions.
|
|
285
|
|
286 When Emacs is installed, it searches for its Lisp files
|
|
287 in `/usr/local/share/emacs/VERSION/site-lisp', then in
|
|
288 `/usr/local/share/emacs/site-lisp', and finally in
|
|
289 `/usr/local/share/emacs/VERSION/lisp'.
|
3199
|
290
|
9760
|
291 `/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
|
3199
|
292 file, the `yow' database, and other
|
|
293 architecture-independent files Emacs might need while
|
|
294 running. VERSION is as specified for `.../lisp'.
|
|
295
|
9760
|
296 `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable
|
3199
|
297 programs used by Emacs that users are not expected to
|
|
298 run themselves.
|
|
299 `VERSION' is the number of the Emacs version you are
|
|
300 installing, and `CONFIGURATION-NAME' is the argument
|
|
301 you gave to the `configure' program to identify the
|
|
302 architecture and operating system of your machine,
|
|
303 like `mips-dec-ultrix' or `sparc-sun-sunos'. Since
|
|
304 these files are specific to the version of Emacs,
|
|
305 operating system, and architecture in use, including
|
|
306 the configuration name in the path allows you to have
|
|
307 several versions of Emacs for any mix of machines and
|
|
308 operating systems installed at the same time; this is
|
|
309 useful for sites at which different kinds of machines
|
|
310 share the file system Emacs is installed on.
|
|
311
|
|
312 `/usr/local/info' holds the on-line documentation for Emacs, known as
|
|
313 "info files". Many other GNU programs are documented
|
|
314 using info files as well, so this directory stands
|
|
315 apart from the other, Emacs-specific directories.
|
|
316
|
|
317 `/usr/local/man/man1' holds the man pages for the programs installed
|
|
318 in `/usr/local/bin'.
|
|
319
|
|
320 If these directories are not what you want, you can specify where to
|
|
321 install Emacs's libraries and data files or where Emacs should search
|
14147
|
322 for its Lisp files by giving values for `make' variables as part of
|
3199
|
323 the command. See the section below called `MAKE VARIABLES' for more
|
|
324 information on this.
|
|
325
|
|
326 8) Check the file `dir' in your site's info directory (usually
|
|
327 /usr/local/info) to make sure that it has a menu entry for the Emacs
|
|
328 info files.
|
|
329
|
6062
|
330 9) If your system uses lock files to interlock access to mailer inbox files,
|
9760
|
331 then you might need to make the movemail program setuid or setgid
|
6062
|
332 to enable it to write the lock files. We believe this is safe.
|
|
333
|
12620
|
334 10) You are done! You can remove executables and object files from
|
|
335 the build directory by typing `make clean'. To also remove the files
|
|
336 that `configure' created (so you can compile Emacs for a different
|
26905
9f4d574a38b5
Explain that unused input methods can be removed from the installation
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
337 configuration), type `make distclean'. If you don't need some, or all
|
9f4d574a38b5
Explain that unused input methods can be removed from the installation
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
338 of the input methods from the Leim package, you can remove the
|
9f4d574a38b5
Explain that unused input methods can be removed from the installation
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
339 unneeded files in the leim/quail, leim/skk, and leim/skk-dic
|
9f4d574a38b5
Explain that unused input methods can be removed from the installation
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
340 subdirectories of your site's lisp directory (usually
|
9f4d574a38b5
Explain that unused input methods can be removed from the installation
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
341 /usr/local/share/emacs/VERSION/).
|
12620
|
342
|
3199
|
343
|
|
344
|
|
345 MAKE VARIABLES
|
|
346
|
|
347 You can change where the build process installs Emacs and its data
|
|
348 files by specifying values for `make' variables as part of the `make'
|
|
349 command line. For example, if you type
|
|
350
|
|
351 make install bindir=/usr/local/gnubin
|
|
352
|
|
353 the `bindir=/usr/local/gnubin' argument indicates that the Emacs
|
|
354 executable files should go in `/usr/local/gnubin', not
|
|
355 `/usr/local/bin'.
|
|
356
|
|
357 Here is a complete list of the variables you may want to set.
|
|
358
|
|
359 `bindir' indicates where to put executable programs that users can
|
|
360 run. This defaults to /usr/local/bin.
|
|
361
|
|
362 `datadir' indicates where to put the architecture-independent
|
|
363 read-only data files that Emacs refers to while it runs; it
|
9499
|
364 defaults to /usr/local/share. We create the following
|
3199
|
365 subdirectories under `datadir':
|
14147
|
366 - `emacs/VERSION/lisp', containing the Emacs Lisp library, and
|
3199
|
367 - `emacs/VERSION/etc', containing the Emacs tutorial, the DOC
|
|
368 file, and the `yow' database.
|
|
369 `VERSION' is the number of the Emacs version you are installing,
|
|
370 like `18.59' or `19.0'. Since these files vary from one version
|
|
371 of Emacs to another, including the version number in the path
|
|
372 allows you to have several versions of Emacs installed at the
|
|
373 same time; this means that you don't have to make Emacs
|
|
374 unavailable while installing a new version.
|
|
375
|
9499
|
376 `libexecdir' indicates where to put architecture-specific data files that
|
|
377 Emacs refers to as it runs; it defaults to `/usr/local/libexec'.
|
|
378 We create the following subdirectories under `libexecdir':
|
3199
|
379 - `emacs/VERSION/CONFIGURATION-NAME', containing executable
|
|
380 programs used by Emacs that users are not expected to run
|
|
381 themselves.
|
|
382 `VERSION' is the number of the Emacs version you are installing,
|
|
383 and `CONFIGURATION-NAME' is the argument you gave to the
|
|
384 `configure' program to identify the architecture and operating
|
|
385 system of your machine, like `mips-dec-ultrix' or
|
|
386 `sparc-sun-sunos'. Since these files are specific to the version
|
|
387 of Emacs, operating system, and architecture in use, including
|
|
388 the configuration name in the path allows you to have several
|
|
389 versions of Emacs for any mix of machines and operating systems
|
|
390 installed at the same time; this is useful for sites at which
|
|
391 different kinds of machines share the file system Emacs is
|
|
392 installed on.
|
|
393
|
|
394 `infodir' indicates where to put the info files distributed with
|
|
395 Emacs; it defaults to `/usr/local/info'.
|
|
396
|
|
397 `mandir' indicates where to put the man pages for Emacs and its
|
|
398 utilities (like `etags'); it defaults to
|
|
399 `/usr/local/man/man1'.
|
|
400
|
|
401 `manext' gives the extension the man pages should be installed with.
|
|
402 It should contain a period, followed by the appropriate
|
|
403 digit. It defaults to `.1'. For example given the default
|
|
404 values for `mandir' and `manext', the Emacs man page would be
|
|
405 installed as `/usr/local/man/man1/emacs.1'.
|
|
406
|
|
407 `prefix' doesn't give a path for any specific part of Emacs; instead,
|
|
408 its value is used to determine the defaults for all the
|
|
409 architecture-independent path variables - `datadir',
|
9499
|
410 `sharedstatedir', `infodir', and `mandir'. Its default value is
|
3199
|
411 `/usr/local'; the other variables add on `lib' or `man' to it
|
|
412 by default.
|
|
413
|
|
414 For example, suppose your site generally places GNU software
|
|
415 under `/usr/users/software/gnusoft' instead of `/usr/local'.
|
|
416 By including
|
|
417 `prefix=/usr/users/software/gnusoft'
|
|
418 in the arguments to `make', you can instruct the build process
|
|
419 to place all of the Emacs data files in the appropriate
|
|
420 directories under that path.
|
|
421
|
|
422 `exec_prefix' serves the same purpose as `prefix', but instead
|
|
423 determines the default values for the architecture-dependent
|
9499
|
424 path variables - `bindir' and `libexecdir'.
|
3199
|
425
|
|
426 The above variables serve analogous purposes in the makefiles for all
|
21343
|
427 GNU software; this variable is specific to Emacs.
|
3199
|
428
|
12620
|
429 `archlibdir' indicates where Emacs installs and expects the executable
|
|
430 files and other architecture-dependent data it uses while
|
|
431 running. Its default value, based on `libexecdir' (which
|
|
432 see), is `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME'
|
3199
|
433 (where VERSION and CONFIGURATION-NAME are as described above).
|
|
434
|
|
435 Remember that you must specify any variable values you need each time
|
|
436 you run `make' in the top directory. If you run `make' once to build
|
|
437 emacs, test it, and then run `make' again to install the files, you
|
|
438 must provide the same variable settings each time. To make the
|
|
439 settings persist, you can edit them into the `Makefile' in the top
|
|
440 directory, but be aware that running the `configure' program erases
|
|
441 `Makefile' and rebuilds it from `Makefile.in'.
|
|
442
|
21343
|
443 The path for finding Lisp files is specified in src/paths.h,
|
|
444 a file which is generated by running configure. To change the path,
|
|
445 you can edit the definition of PATH_LOADSEARCH in that file
|
|
446 before you run `make'.
|
|
447
|
3199
|
448 The top-level Makefile stores the variable settings it used in the
|
|
449 Makefiles for the subdirectories, so you don't have to specify them
|
|
450 when running make in the subdirectories.
|
|
451
|
|
452
|
|
453 CONFIGURATION BY HAND
|
|
454
|
7864
|
455 Instead of running the `configure' program, you have to perform the
|
|
456 following steps.
|
3199
|
457
|
13667
|
458 1) Copy `./src/config.in' to `./src/config.h'.
|
3199
|
459
|
|
460 2) Consult `./etc/MACHINES' to see what configuration name you should
|
|
461 use for your system. Look at the code of the `configure' script to
|
|
462 see which operating system and architecture description files from
|
|
463 `src/s' and `src/m' should be used for that configuration name. Edit
|
|
464 `src/config.h', and change the two `#include' directives to include
|
|
465 the appropriate system and architecture description files.
|
|
466
|
|
467 2) Edit `./src/config.h' to set the right options for your system. If
|
|
468 you need to override any of the definitions in the s/*.h and m/*.h
|
|
469 files for your system and machine, do so by editing config.h, not by
|
|
470 changing the s/*.h and m/*.h files. Occasionally you may need to
|
|
471 redefine parameters used in `./lib-src/movemail.c'.
|
|
472
|
7864
|
473 3) Create src/Makefile and lib-src/Makefile from the corresponding
|
13667
|
474 `Makefile.in' files. First copy `Makefile.in' to `Makefile.c',
|
14020
|
475 then edit in appropriate substitutions for the @...@ constructs,
|
7864
|
476 and then copy the shell commands near the end of `configure'
|
|
477 that run cpp to construct `Makefile'.
|
3199
|
478
|
7864
|
479 4) Create `Makefile' files in various other directories
|
|
480 from the corresponding `Makefile.in' files. This isn't so hard,
|
|
481 just a matter of substitution.
|
3199
|
482
|
|
483 The `configure' script is built from `configure.in' by the `autoconf'
|
9760
|
484 program. You need version 2.0 or newer of `autoconf' to rebuild `configure'.
|
3199
|
485
|
|
486 BUILDING GNU EMACS BY HAND
|
|
487
|
9507
|
488 Once Emacs is configured, running `make' in the top directory performs
|
|
489 the following steps.
|
3199
|
490
|
|
491 1) Run `make src/paths.h' in the top directory. This produces
|
13667
|
492 `./src/paths.h' from the template file `./src/paths.in', changing
|
3199
|
493 the paths to the values specified in `./Makefile'.
|
|
494
|
7864
|
495 2) Go to directory `./lib-src' and run `make'. This creates
|
|
496 executables named `ctags' and `etags' and `wakeup' and `make-docfile'
|
|
497 and `digest-doc' and `test-distrib'. And others.
|
3199
|
498
|
7864
|
499 3) Go to directory `./src' and Run `make'. This refers to files in
|
|
500 the `./lisp' and `./lib-src' subdirectories using names `../lisp' and
|
3199
|
501 `../lib-src'.
|
|
502
|
|
503 This creates a file `./src/emacs' which is the runnable Emacs,
|
7864
|
504 which has another name that contains a version number.
|
|
505 Each time you do this, that version number increments in the last place.
|
3199
|
506
|
|
507 It also creates a file in `./etc' whose name is `DOC' followed by the
|
|
508 current Emacs version. This file contains documentation strings for
|
|
509 all the functions in Emacs. Each time you run make to make a new
|
|
510 emacs, a new DOC file with a new name is made. You must keep the DOC
|
|
511 file for an Emacs version as long as you keep using that Emacs
|
|
512 version.
|
|
513
|
|
514
|
|
515 INSTALLATION BY HAND
|
|
516
|
9507
|
517 The steps below are done by running `make install' in the main
|
|
518 directory of the Emacs distribution.
|
3199
|
519
|
|
520 1) Copy `./lisp' and its subdirectories, `./etc', and the executables
|
|
521 in `./lib-src' to their final destinations, as selected in `./src/paths.h'.
|
|
522
|
|
523 Strictly speaking, not all of the executables in `./lib-src' need be copied.
|
7627
|
524 - The programs `cvtmail', `emacsserver', `fakemail', `hexl',
|
7864
|
525 `movemail', `profile', `rcs2log', `timer', `vcdiff', `wakeup',
|
|
526 and `yow' are used by Emacs; they do need to be copied.
|
|
527 - The programs `etags', `ctags', `emacsclient', `b2m', and `rcs-checkin'
|
3199
|
528 are intended to be run by users; they are handled below.
|
9498
|
529 - The programs `make-docfile' and `test-distrib' were
|
3199
|
530 used in building Emacs, and are not needed any more.
|
|
531 - The programs `digest-doc' and `sorted-doc' convert a `DOC' file into
|
|
532 a file for users to read. There is no important reason to move them.
|
|
533
|
|
534 2) Copy the files in `./info' to the place specified in
|
|
535 `./lisp/site-init.el' or `./lisp/paths.el'. Note that if the
|
|
536 destination directory already contains a file named `dir', you
|
|
537 probably don't want to replace it with the `dir' file in the Emacs
|
|
538 distribution. Instead, you should make sure that the existing `dir'
|
|
539 file contains an appropriate menu entry for the Emacs info.
|
|
540
|
23353
|
541 3) Copy `./src/emacs' to `/usr/local/bin', or to some other directory
|
3199
|
542 in users' search paths. `./src/emacs' has an alternate name
|
|
543 `./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named
|
|
544 `/usr/local/bin/emacs' pointing to that alternate name, as an easy way
|
|
545 of installing different versions.
|
|
546
|
|
547 You can delete `./src/temacs'.
|
|
548
|
23353
|
549 4) Copy the programs `b2m', `emacsclient', `ctags', `etags', and
|
7864
|
550 `rcs-checkin' from `./lib-src' to `/usr/local/bin'. These programs are
|
3199
|
551 intended for users to run.
|
|
552
|
23353
|
553 5) Copy the man pages in `./etc' for emacs, ctags, and etags into the
|
3199
|
554 appropriate man directories.
|
|
555
|
23353
|
556 6) The files in the `./src' subdirectory, except for `emacs', are not
|
7864
|
557 used by Emacs once it is built. However, it is very desirable to keep
|
|
558 the source on line for debugging.
|
3199
|
559
|
|
560
|
|
561 PROBLEMS
|
|
562
|
21089
|
563 See the file PROBLEMS in etc subdirectory for a list of various
|
3199
|
564 problems sometimes encountered, and what to do about them.
|
|
565
|
|
566
|
6062
|
567 Installation on MSDOG (a.k.a. MSDOS)
|
|
568
|
7627
|
569 To install on MSDOG, you need to have the GNU C compiler for MSDOG
|
15444
|
570 (also known as djgpp), GNU Make, rm, mv, and sed. See the remarks in
|
|
571 config.bat for more information about locations and versions. The
|
|
572 file etc/FAQ includes pointers to Internet sites where you can find
|
|
573 the necessary utilities; search for "MS-DOS". The configuration step
|
|
574 (see below) will test for these utilities and will refuse to continue
|
|
575 if any of them isn't found.
|
6062
|
576
|
15444
|
577 If you are building the MSDOG version of Emacs on an MSDOG-like system
|
|
578 which supports long file names (e.g. Windows 95), you need to make
|
|
579 sure that long file names are handled consistently both when you
|
|
580 unpack the distribution and compile it. If you intend to compile with
|
|
581 DJGPP v2.0 or later, and long file names support is enabled (LFN=y in
|
|
582 the environment), you need to unpack Emacs distribution in a way that
|
|
583 doesn't truncate the original long filenames to the DOS 8.3 namespace;
|
|
584 the easiest way to do this is to use djtar program which comes with
|
|
585 DJGPP, since it will note the LFN setting and behave accordingly.
|
|
586 DJGPP v1 doesn't support long filenames, so you must unpack Emacs with
|
|
587 a program that truncates the filenames to 8.3 naming as it extracts
|
|
588 files; again, using djtar after setting LFN=n is the recommended way.
|
|
589 You can build Emacs with LFN=n even if you use DJGPP v2, if some of
|
|
590 your tools don't support long file names: just ensure that LFN is set
|
|
591 to `n' during both unpacking and compiling.
|
15017
|
592
|
15444
|
593 (By the time you read this, you have already unpacked the Emacs
|
|
594 distribution, but if the explanations above imply that you should have
|
|
595 done it differently, it's safer to delete the directory tree created
|
|
596 by the unpacking program and unpack Emacs again, than to risk running
|
|
597 into problems during the build process.)
|
|
598
|
|
599 It is important to understand that the runtime support of long file
|
|
600 names by the Emacs binary is NOT affected by the LFN setting during
|
|
601 compilation; Emacs compiled with DJGPP v2.0 or later will always
|
|
602 support long file names on Windows 95 no matter what was the setting
|
15733
|
603 of LFN at compile time. However, if you compiled with LFN disabled
|
|
604 and want to enable LFN support after Emacs was already built, you need
|
|
605 to make sure that the support files in the lisp, etc and info
|
|
606 directories are called by their original long names as found in the
|
|
607 distribution. You can do this either by renaming the files manually,
|
|
608 or by extracting them from the original distribution archive with
|
|
609 djtar after you set LFN=y in the environment.
|
15017
|
610
|
15444
|
611 To unpack Emacs with djtar, type this command:
|
|
612
|
|
613 djtar -x emacs.tgz
|
12339
|
614
|
15444
|
615 (This assumes that the Emacs distribution is called `emacs.tgz' on
|
19635
|
616 your system.)
|
12343
|
617
|
24070
|
618 If you need to type international characters, you will need to unpack
|
|
619 the Leim distribution (see the description near the beginning of this
|
|
620 file). You unpack it from the same directory where you unpacked
|
|
621 Emacs. To unpack Leim with djtar, assuming the Leim distribution is
|
|
622 called `leim.tgz', type this command:
|
|
623
|
|
624 djtar -x leim.tgz
|
|
625
|
|
626 If you want to print international characters, install the intlfonts
|
24452
3f25405e6e70
Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
627 distribution. For this, create a directory called `fonts' under the
|
24070
|
628 Emacs top-level directory (usually called `emacs-XX.YY') created by
|
|
629 unpacking emacs.tgz, chdir into the directory emacs-XX.YY/fonts, and
|
|
630 type this:
|
|
631
|
|
632 djtar -x intlfonts.tgz
|
|
633
|
15444
|
634 When unpacking is done, a directory called `emacs-XX.YY' will be
|
|
635 created, where XX.YY is the Emacs version. To build and install
|
|
636 Emacs, chdir to that directory and type these commands:
|
12339
|
637
|
|
638 config msdos
|
|
639 make install
|
6062
|
640
|
24452
3f25405e6e70
Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
641 To install the international fonts, chdir to the intlfonts-X.Y
|
3f25405e6e70
Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
642 directory created when you unpacked the intlfonts distribution (X.Y is
|
3f25405e6e70
Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
643 the version number of the fonts' distribution), and type the following
|
3f25405e6e70
Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
644 command:
|
3f25405e6e70
Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
645
|
3f25405e6e70
Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
646 make bdf INSTALLDIR=..
|
3f25405e6e70
Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
647
|
3f25405e6e70
Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
648 After Make finishes, you may remove the directory intlfonts-X.Y; the
|
3f25405e6e70
Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
649 fonts are installed into the fonts/bdf subdirectory of the top-level
|
3f25405e6e70
Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
650 Emacs directory, and that is where Emacs will look for them by
|
3f25405e6e70
Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
651 default.
|
3f25405e6e70
Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
652
|
15039
|
653 Building Emacs creates executable files in the src and lib-src
|
|
654 directories. Installing Emacs on MSDOS moves these executables to a
|
|
655 sibling directory called bin. For example, if you build in directory
|
|
656 /emacs, installing moves the executables from /emacs/src and
|
|
657 /emacs/lib-src to the directory /emacs/bin, so you can then delete the
|
|
658 subdirectories /emacs/src and /emacs/lib-src if you wish. The only
|
24070
|
659 subdirectories you need to keep are bin, lisp, etc and info. (If you
|
|
660 installed Leim, keep the leim subdirectory, and if you installed
|
|
661 intlfonts, keep the fonts directory and all its sibdirectories as well.)
|
|
662 The bin subdirectory should be added to your PATH. The msdos
|
|
663 subdirectory includes a PIF and an icon file for Emacs which you might
|
|
664 find useful if you run Emacs under MS Windows.
|
12349
|
665
|
15039
|
666 Emacs on MSDOS finds the lisp, etc and info directories by looking in
|
|
667 ../lisp, ../etc and ../info, starting from the directory where the
|
|
668 Emacs executable was run from. You can override this by setting the
|
19635
|
669 environment variables EMACSDATA (for the location of `etc' directory),
|
|
670 EMACSLOADPATH (for the location of `lisp' directory) and INFOPATH (for
|
|
671 the location of the `info' directory).
|
6062
|
672
|
7627
|
673 MSDOG is a not a multitasking operating system, so Emacs features such
|
|
674 as asynchronous subprocesses that depend on multitasking will not
|
|
675 work. Synchronous subprocesses do work.
|
15825
|
676
|
16861
|
677 Version 2.0 of djgpp has two bugs that affect Emacs. We've included
|
|
678 corrected versions of two files from djgpp in the msdos subdirectory:
|
|
679 is_exec.c and sigaction.c. To work around the bugs, compile these
|
|
680 files and link them into temacs. Djgpp version 2.01 have these bugs
|
|
681 fixed, so upgrade if you can before building Emacs.
|