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