Initial revision
[emacs.git] / INSTALL
blob522a73905438499a5088f48176b31f03f85b8757
1 GNU Emacs Installation Guide
2 Copyright (c) 1992, 1994 Free software Foundation, Inc.
4    Permission is granted to anyone to make or distribute verbatim copies
5    of this document as received, in any medium, provided that the
6    copyright notice and permission notice are preserved,
7    and that the distributor grants the recipient permission
8    for further redistribution as permitted by this notice.
10    Permission is granted to distribute modified versions
11    of this document, or of portions of it,
12    under the above conditions, provided also that they
13    carry prominent notices stating who last changed them,
14    and that any new or changed statements about the activities
15    of the Free Software Foundation are approved by the Foundation.
18 BUILDING AND INSTALLATION:
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.)
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
27 loadup dump', found in `./src/Makefile.in', or possibly when
28 running the final dumped Emacs.
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
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,
35 then the installation procedure momentarily requires 70+35 Mb.
37 2) Consult `./etc/MACHINES' to see what configuration name you should
38 give to the `configure' program.  That file offers hints for
39 getting around some possible installation problems.
41 3) In the top directory of the Emacs distribution, run the program
42 `configure' as follows:
44     ./configure CONFIGURATION-NAME [--OPTION[=VALUE]] ...
46 The CONFIGURATION-NAME argument should be a configuration name given
47 in `./etc/MACHINES'.  If omitted, `configure' will try to guess your
48 system type; if it cannot, you must find the appropriate configuration
49 name in `./etc/MACHINES' and specify it explicitly.
51 If you don't want X support, specify `--with-x=no'.  If you omit this
52 option, `configure' will try to figure out for itself whether your
53 system has X, and arrange to use it if present.
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
57 object libraries used with the X Window System.  Normally, `configure'
58 is able to find them; these options are necessary if you have your X
59 Window System files installed in unusual places.  These options also
60 accept a list of directories, separated with colons.
62 To get more attractive menus, you can specify an X toolkit when you
63 configure Emacs; use the option `--with-x-toolkit=TOOLKIT', where
64 TOOLKIT is `athena' or `motif' (`yes' and `lucid' are synonyms for
65 `athena').  On some systems, it does not work to use a toolkit with
66 shared libraries.
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
70 `--with-gcc=no'.  If you omit this option, `configure' will search
71 for GCC in your path, and use it if present.
73 If you want the Emacs mail reader RMAIL to read mail from a POP
74 server, you must specify `--with-pop'.  This provides support for the
75 POP3 protocol; older versions are not supported.  For
76 Kerberos-authenticated POP add `--with-kerberos', for Hesiod support
77 add `--with-hesiod'.  These options enable Emacs to use POP; whether
78 Emacs uses POP is controlled by individual users--see the Rmail
79 chapter of the Emacs manual.
81 You can build Emacs for several different machine types from a single
82 source directory.  To do this, you must use a version of `make' that
83 supports the `VPATH' variable, such as GNU `make'.  Make separate
84 build directories for the different configuration types, and in each
85 one, run the Emacs `configure' script.  `configure' looks for the
86 Emacs source code in the directory that `configure' is in.
88 The `--prefix=PREFIXDIR' option specifies where the installation process
89 should put emacs and its data files.  This defaults to `/usr/local'.
90 - Emacs (and the other utilities users run) go in PREFIXDIR/bin
91   (unless the `--exec-prefix' option says otherwise).
92 - The architecture-independent files go in PREFIXDIR/share/emacs/VERSION
93   (where VERSION is the version number of Emacs, like `19.27').
94 - The architecture-dependent files go in
95   PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION
96   (where CONFIGURATION is the configuration name, like mips-dec-ultrix4.2),
97   unless the `--exec-prefix' option says otherwise.
99 The `--exec-prefix=EXECDIR' option allows you to specify a separate
100 portion of the directory tree for installing architecture-specific
101 files, like executables and utility programs.  If specified,
102 - Emacs (and the other utilities users run) go in EXECDIR/bin, and
103 - The architecture-dependent files go in
104   EXECDIR/libexec/emacs/VERSION/CONFIGURATION.
105 EXECDIR/bin should be a directory that is normally in users' PATHs.
107 For example, the command
109     ./configure mips-dec-ultrix --with-x11
111 configures Emacs to build for a DECstation running Ultrix, with
112 support for the X11 window system.
114 `configure' doesn't do any compilation or installation
115 itself.  It just creates the files that influence those things:
116 `./Makefile', `lib-src/Makefile', `oldXMenu/Makefile',
117 `lwlib/Makefile', `src/Makefile', and `./src/config.h'.  For details
118 on exactly what it does, see the section called `CONFIGURATION BY
119 HAND', below.
121 When it is done, `configure' prints a description of what it did and
122 creates a shell script `config.status' which, when run, recreates the
123 same configuration.  If `configure' exits with an error after
124 disturbing the status quo, it removes `config.status'.  `configure'
125 also creates a file `config.cache' that saves the results of its tests
126 to make reconfiguring faster, and a file `config.log' containing compiler
127 output (useful mainly for debugging `configure').  You can give
128 `configure' the option `--cache-file=FILE' to use the results of the
129 tests in FILE instead of `config.cache'.  Set FILE to `/dev/null' to
130 disable caching, for debugging `configure'.
132 The work of `configure' can be done by editing various files in the
133 distribution, but using `configure' is supposed to be simpler.  See
134 the section called "CONFIGURATION BY HAND" below if you want to do the
135 configuration yourself.
137 4) Look at `./lisp/paths.el'; if some of those values are not right
138 for your system, set up the file `./lisp/site-init.el' with Emacs
139 Lisp code to override them; it is not a good idea to edit paths.el
140 itself.  YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES,
141 rather than `defvar', as used by `./lisp/paths.el'.  For example,
143      (setq news-inews-program "/usr/bin/inews")
145 is how you would override the default value of the variable
146 news-inews-program (which is "/usr/local/inews").
148 Before you override a variable this way, *look at the value* that the
149 variable gets by default!  Make sure you know what kind of value the
150 variable should have.  If you don't pay attention to what you are
151 doing, you'll make a mistake.
153 5) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs
154 Lisp code you want Emacs to load before it is dumped out.  Use
155 site-load.el for additional libraries if you arrange for their
156 documentation strings to be in the etc/DOC file (see
157 src/Makefile.in if you wish to figure out how to do that).  For all
158 else, use site-init.el.
160 If you set load-path to a different value in site-init.el or
161 site-load.el, Emacs will use *precisely* that value when it starts up
162 again.  If you do this, you are on your own!
164 Note that, on some systems, the code you place in site-init.el must
165 not use expand-file-name or any other function which may look
166 something up in the system's password and user information database.
167 See `./PROBLEMS' for more details on which systems this affects.
169 The `site-*.el' files are nonexistent in the distribution.  You do not
170 need to create them if you have nothing to put in them.
172 6) Refer to the file `./etc/TERMS' for information on fields you may
173 wish to add to various termcap entries.  The files `./etc/termcap.ucb'
174 and `./etc/termcap.dat' may already contain appropriately-modified
175 entries.
177 7) Run `make' in the top directory of the Emacs distribution to finish
178 building Emacs in the standard way.  The final executable file is
179 named `src/emacs'.  You can execute this file "in place" without
180 copying it, if you wish; then it automatically uses the sibling
181 directories ../lisp, ../lib-src, ../info.
183 Or you can "install" the executable and the other Emacs into their
184 installed locations, with `make install'.  By default, Emacs's files
185 are installed in the following directories:
187 `/usr/local/bin' holds the executable programs users normally run -
188                 `emacs', `etags', `ctags', `b2m', `emacsclient',
189                 and `rcs-checkin'.
191 `/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library;
192                 `VERSION' stands for the number of the Emacs version
193                 you are installing, like `18.59' or `19.27'.  Since the
194                 Lisp library changes from one version of Emacs to
195                 another, including the version number in the path
196                 allows you to have several versions of Emacs installed
197                 at the same time; in particular, you don't have to
198                 make Emacs unavailable while installing a new version.
200 `/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp
201                 files installed for Emacs version VERSION only.
203 `/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp
204                 files installed for all Emacs versions.
206                 When Emacs is installed, it searches for its Lisp files
207                 in `/usr/local/share/emacs/VERSION/site-lisp', then in
208                 `/usr/local/share/emacs/site-lisp', and finally in
209                 `/usr/local/share/emacs/VERSION/lisp'.
211 `/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
212                 file, the `yow' database, and other
213                 architecture-independent files Emacs might need while
214                 running.  VERSION is as specified for `.../lisp'.
216 `/usr/local/com/emacs/lock' contains files indicating who is editing
217                 what, so Emacs can detect editing clashes between
218                 users.
220 `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable
221                 programs used by Emacs that users are not expected to
222                 run themselves.
223                 `VERSION' is the number of the Emacs version you are
224                 installing, and `CONFIGURATION-NAME' is the argument
225                 you gave to the `configure' program to identify the
226                 architecture and operating system of your machine,
227                 like `mips-dec-ultrix' or `sparc-sun-sunos'.  Since
228                 these files are specific to the version of Emacs,
229                 operating system, and architecture in use, including
230                 the configuration name in the path allows you to have
231                 several versions of Emacs for any mix of machines and
232                 operating systems installed at the same time; this is
233                 useful for sites at which different kinds of machines
234                 share the file system Emacs is installed on.
236 `/usr/local/info' holds the on-line documentation for Emacs, known as
237                 "info files".  Many other GNU programs are documented
238                 using info files as well, so this directory stands
239                 apart from the other, Emacs-specific directories.
241 `/usr/local/man/man1' holds the man pages for the programs installed
242                 in `/usr/local/bin'.
244 If these directories are not what you want, you can specify where to
245 install Emacs's libraries and data files or where Emacs should search
246 for its Lisp files by giving values for `make' variables as part of
247 the command.  See the section below called `MAKE VARIABLES' for more
248 information on this.
250 8) Check the file `dir' in your site's info directory (usually
251 /usr/local/info) to make sure that it has a menu entry for the Emacs
252 info files.
254 9) If your system uses lock files to interlock access to mailer inbox files,
255 then you might need to make the movemail program setuid or setgid
256 to enable it to write the lock files.  We believe this is safe.
258 10) You are done!  You can remove executables and object files from
259 the build directory by typing `make clean'.  To also remove the files
260 that `configure' created (so you can compile Emacs for a different
261 configuration), type `make distclean'.
265 MAKE VARIABLES
267 You can change where the build process installs Emacs and its data
268 files by specifying values for `make' variables as part of the `make'
269 command line.  For example, if you type
271     make install bindir=/usr/local/gnubin
273 the `bindir=/usr/local/gnubin' argument indicates that the Emacs
274 executable files should go in `/usr/local/gnubin', not
275 `/usr/local/bin'.
277 Here is a complete list of the variables you may want to set.
279 `bindir' indicates where to put executable programs that users can
280         run.  This defaults to /usr/local/bin.
282 `datadir' indicates where to put the architecture-independent
283         read-only data files that Emacs refers to while it runs; it
284         defaults to /usr/local/share.  We create the following
285         subdirectories under `datadir':
286         - `emacs/VERSION/lisp', containing the Emacs Lisp library, and
287         - `emacs/VERSION/etc', containing the Emacs tutorial, the DOC
288                 file, and the `yow' database.
289         `VERSION' is the number of the Emacs version you are installing,
290         like `18.59' or `19.0'.  Since these files vary from one version
291         of Emacs to another, including the version number in the path
292         allows you to have several versions of Emacs installed at the
293         same time; this means that you don't have to make Emacs
294         unavailable while installing a new version.
296 `sharedstatedir' indicates where to put architecture-independent data files
297         that Emacs modifies while it runs; it defaults to
298         /usr/local/com.  We create the following
299         subdirectories under `sharedstatedir':
300         - `emacs/lock', containing files indicating who is editing
301                 what, so Emacs can detect editing clashes between
302                 users.
304 `libexecdir' indicates where to put architecture-specific data files that
305         Emacs refers to as it runs; it defaults to `/usr/local/libexec'.
306         We create the following subdirectories under `libexecdir':
307         - `emacs/VERSION/CONFIGURATION-NAME', containing executable
308                 programs used by Emacs that users are not expected to run
309                 themselves.  
310         `VERSION' is the number of the Emacs version you are installing,
311         and `CONFIGURATION-NAME' is the argument you gave to the
312         `configure' program to identify the architecture and operating
313         system of your machine, like `mips-dec-ultrix' or
314         `sparc-sun-sunos'.  Since these files are specific to the version
315         of Emacs, operating system, and architecture in use, including
316         the configuration name in the path allows you to have several
317         versions of Emacs for any mix of machines and operating systems
318         installed at the same time; this is useful for sites at which
319         different kinds of machines share the file system Emacs is
320         installed on.
322 `infodir' indicates where to put the info files distributed with
323         Emacs; it defaults to `/usr/local/info'.
325 `mandir' indicates where to put the man pages for Emacs and its
326         utilities (like `etags'); it defaults to
327         `/usr/local/man/man1'.
329 `manext' gives the extension the man pages should be installed with.
330         It should contain a period, followed by the appropriate
331         digit.  It defaults to `.1'.  For example given the default
332         values for `mandir' and `manext', the Emacs man page would be
333         installed as `/usr/local/man/man1/emacs.1'.
335 `prefix' doesn't give a path for any specific part of Emacs; instead,
336         its value is used to determine the defaults for all the
337         architecture-independent path variables - `datadir',
338         `sharedstatedir', `infodir', and `mandir'.  Its default value is
339         `/usr/local'; the other variables add on `lib' or `man' to it
340         by default.
342         For example, suppose your site generally places GNU software
343         under `/usr/users/software/gnusoft' instead of `/usr/local'.
344         By including
345             `prefix=/usr/users/software/gnusoft'
346         in the arguments to `make', you can instruct the build process
347         to place all of the Emacs data files in the appropriate
348         directories under that path.
350 `exec_prefix' serves the same purpose as `prefix', but instead
351         determines the default values for the architecture-dependent
352         path variables - `bindir' and `libexecdir'.
354 The above variables serve analogous purposes in the makefiles for all
355 GNU software; here are some variables specific to Emacs.
357 `lispdir' indicates where Emacs installs and expects its Lisp library.
358         Its default value, based on `datadir' (see above), is
359         `/usr/local/share/emacs/VERSION/lisp' (where `VERSION' is as
360         described above).
362 `locallisppath' indicates where Emacs should search for Lisp files
363         specific to your site.  It should be a colon-separated list of
364         directories; Emacs checks them in order before checking
365         `lispdir'.  Its default value, based on `datadir' (see above), is
366         `/usr/local/share/emacs/VERSION/site-lisp:/usr/local/share/emacs/site-lisp'.
368 `lisppath' is the complete list of directories Emacs should search for
369         its Lisp files; its default value is the concatenation of
370         `locallisppath' and `lispdir'.  It should be a colon-separated
371         list of directories; Emacs checks them in the order they
372         appear.
374 `etcdir' indicates where Emacs should install and expect the rest of
375         its architecture-independent data, like the tutorial, DOC
376         file, and yow database.  Its default value, based on `datadir'
377         (which see), is `/usr/local/share/emacs/VERSION/etc'.
379 `lockdir' indicates the directory where Emacs keeps track of its
380         locking information.  Its default value, based on
381         `sharedstatedir' (which see), is `/usr/local/com/emacs/lock'.
383 `archlibdir' indicates where Emacs installs and expects the executable
384         files and other architecture-dependent data it uses while
385         running.  Its default value, based on `libexecdir' (which
386         see), is `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME'
387         (where VERSION and CONFIGURATION-NAME are as described above).
389 Remember that you must specify any variable values you need each time
390 you run `make' in the top directory.  If you run `make' once to build
391 emacs, test it, and then run `make' again to install the files, you
392 must provide the same variable settings each time.  To make the
393 settings persist, you can edit them into the `Makefile' in the top
394 directory, but be aware that running the `configure' program erases
395 `Makefile' and rebuilds it from `Makefile.in'.
397 The top-level Makefile stores the variable settings it used in the
398 Makefiles for the subdirectories, so you don't have to specify them
399 when running make in the subdirectories.
402 CONFIGURATION BY HAND
404 Instead of running the `configure' program, you have to perform the
405 following steps.
407 1) Copy `./src/config.in' to `./src/config.h'.
409 2) Consult `./etc/MACHINES' to see what configuration name you should
410 use for your system.  Look at the code of the `configure' script to
411 see which operating system and architecture description files from
412 `src/s' and `src/m' should be used for that configuration name.  Edit
413 `src/config.h', and change the two `#include' directives to include
414 the appropriate system and architecture description files.
416 2) Edit `./src/config.h' to set the right options for your system.  If
417 you need to override any of the definitions in the s/*.h and m/*.h
418 files for your system and machine, do so by editing config.h, not by
419 changing the s/*.h and m/*.h files.  Occasionally you may need to
420 redefine parameters used in `./lib-src/movemail.c'.
422 3) Create src/Makefile and lib-src/Makefile from the corresponding
423 `Makefile.in' files.  First copy `Makefile.in' to `Makefile.c',
424 then edit in appropriate substitutions for the @...@ constructs,
425 and then copy the shell commands near the end of `configure'
426 that run cpp to construct `Makefile'.
428 4) Create `Makefile' files in various other directories
429 from the corresponding `Makefile.in' files.  This isn't so hard,
430 just a matter of substitution.
432 The `configure' script is built from `configure.in' by the `autoconf'
433 program.  You need version 2.0 or newer of `autoconf' to rebuild `configure'.
435 BUILDING GNU EMACS BY HAND
437 Once Emacs is configured, running `make' in the top directory performs
438 the following steps.
440 1) Run `make src/paths.h' in the top directory.  This produces
441 `./src/paths.h' from the template file `./src/paths.in', changing
442 the paths to the values specified in `./Makefile'.
444 2) Go to directory `./lib-src' and run `make'.  This creates
445 executables named `ctags' and `etags' and `wakeup' and `make-docfile'
446 and `digest-doc' and `test-distrib'.  And others.
448 3) Go to directory `./src' and Run `make'.  This refers to files in
449 the `./lisp' and `./lib-src' subdirectories using names `../lisp' and
450 `../lib-src'.
452 This creates a file `./src/emacs' which is the runnable Emacs,
453 which has another name that contains a version number.
454 Each time you do this, that version number increments in the last place.
456 It also creates a file in `./etc' whose name is `DOC' followed by the
457 current Emacs version.  This file contains documentation strings for
458 all the functions in Emacs.  Each time you run make to make a new
459 emacs, a new DOC file with a new name is made.  You must keep the DOC
460 file for an Emacs version as long as you keep using that Emacs
461 version.
464 INSTALLATION BY HAND
466 The steps below are done by running `make install' in the main
467 directory of the Emacs distribution.
469 1) Copy `./lisp' and its subdirectories, `./etc', and the executables
470 in `./lib-src' to their final destinations, as selected in `./src/paths.h'.
472 Strictly speaking, not all of the executables in `./lib-src' need be copied.
473 - The programs `cvtmail', `emacsserver', `fakemail', `hexl',
474     `movemail', `profile', `rcs2log', `timer', `vcdiff', `wakeup',
475     and `yow' are used by Emacs; they do need to be copied.
476 - The programs `etags', `ctags', `emacsclient', `b2m', and `rcs-checkin'
477     are intended to be run by users; they are handled below.
478 - The programs `make-docfile' and `test-distrib' were
479     used in building Emacs, and are not needed any more.
480 - The programs `digest-doc' and `sorted-doc' convert a `DOC' file into
481     a file for users to read.  There is no important reason to move them.
483 2) Copy the files in `./info' to the place specified in
484 `./lisp/site-init.el' or `./lisp/paths.el'.  Note that if the
485 destination directory already contains a file named `dir', you
486 probably don't want to replace it with the `dir' file in the Emacs
487 distribution.  Instead, you should make sure that the existing `dir'
488 file contains an appropriate menu entry for the Emacs info.
490 3) Create a directory for Emacs to use for clash detection, named as
491 indicated by the PATH_LOCK macro in `./src/paths.h'.
493 4) Copy `./src/emacs' to `/usr/local/bin', or to some other directory
494 in users' search paths.  `./src/emacs' has an alternate name
495 `./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named
496 `/usr/local/bin/emacs' pointing to that alternate name, as an easy way
497 of installing different versions.
499 You can delete `./src/temacs'.
501 5) Copy the programs `b2m', `emacsclient', `ctags', `etags', and
502 `rcs-checkin' from `./lib-src' to `/usr/local/bin'.  These programs are
503 intended for users to run.
505 6) Copy the man pages in `./etc' for emacs, ctags, and etags into the
506 appropriate man directories.
508 7) The files in the `./src' subdirectory, except for `emacs', are not
509 used by Emacs once it is built.  However, it is very desirable to keep
510 the source on line for debugging.
513 PROBLEMS
515 See the file PROBLEMS in this directory for a list of various
516 problems sometimes encountered, and what to do about them.
519 Installation on MSDOG (a.k.a. MSDOS)
521 To install on MSDOG, you need to have the GNU C compiler for MSDOG
522 (also known as djgpp), GNU Make, rm, mv, and sed.  See the remarks in
523 config.bat for more information about locations and versions.  The
524 file etc/FAQ includes pointers to Internet sites where you can find
525 the necessary utilities; search for "MS-DOS".  The configuration step
526 (see below) will test for these utilities and will refuse to continue
527 if any of them isn't found.
529 If you are building the MSDOG version of Emacs on an MSDOG-like system
530 which supports long file names (e.g. Windows 95), you need to make
531 sure that long file names are handled consistently both when you
532 unpack the distribution and compile it.  If you intend to compile with
533 DJGPP v2.0 or later, and long file names support is enabled (LFN=y in
534 the environment), you need to unpack Emacs distribution in a way that
535 doesn't truncate the original long filenames to the DOS 8.3 namespace;
536 the easiest way to do this is to use djtar program which comes with
537 DJGPP, since it will note the LFN setting and behave accordingly.
538 DJGPP v1 doesn't support long filenames, so you must unpack Emacs with
539 a program that truncates the filenames to 8.3 naming as it extracts
540 files; again, using djtar after setting LFN=n is the recommended way.
541 You can build Emacs with LFN=n even if you use DJGPP v2, if some of
542 your tools don't support long file names: just ensure that LFN is set
543 to `n' during both unpacking and compiling.
545 (By the time you read this, you have already unpacked the Emacs
546 distribution, but if the explanations above imply that you should have
547 done it differently, it's safer to delete the directory tree created
548 by the unpacking program and unpack Emacs again, than to risk running
549 into problems during the build process.)
551 It is important to understand that the runtime support of long file
552 names by the Emacs binary is NOT affected by the LFN setting during
553 compilation; Emacs compiled with DJGPP v2.0 or later will always
554 support long file names on Windows 95 no matter what was the setting
555 of LFN at compile time.  However, if you compiled with LFN disabled
556 and want to enable LFN support after Emacs was already built, you need
557 to make sure that the support files in the lisp, etc and info
558 directories are called by their original long names as found in the
559 distribution.  You can do this either by renaming the files manually,
560 or by extracting them from the original distribution archive with
561 djtar after you set LFN=y in the environment.
563 To unpack Emacs with djtar, type this command:
565     djtar -x emacs.tgz
567 (This assumes that the Emacs distribution is called `emacs.tgz' on
568 your system.)  There are a few files in the archive whose names
569 collide with other files under the 8.3 DOS naming.  On native MSDOS,
570 or if you have set LFN=n on Windows 95, djtar will ask you to supply
571 alternate names for these files; you can just press `Enter' when this
572 happens (which makes djtar skip these files) because they aren't
573 required for MS-DOS.
575 When unpacking is done, a directory called `emacs-XX.YY' will be
576 created, where XX.YY is the Emacs version.  To build and install
577 Emacs, chdir to that directory and type these commands:
579     config msdos
580     make install
582 Building Emacs creates executable files in the src and lib-src
583 directories.  Installing Emacs on MSDOS moves these executables to a
584 sibling directory called bin.  For example, if you build in directory
585 /emacs, installing moves the executables from /emacs/src and
586 /emacs/lib-src to the directory /emacs/bin, so you can then delete the
587 subdirectories /emacs/src and /emacs/lib-src if you wish.  The only
588 subdirectories you need to keep are bin, lisp, etc and info.  The bin
589 subdirectory should be added to your PATH.  The msdos subdirectory
590 includes a PIF and an icon file for Emacs which you might find useful
591 if you run Emacs under MS Windows.
593 Emacs on MSDOS finds the lisp, etc and info directories by looking in
594 ../lisp, ../etc and ../info, starting from the directory where the
595 Emacs executable was run from.  You can override this by setting the
596 environment variable HOME; if you do that, the directories lisp, etc
597 and info are accessed as subdirectories of the HOME directory.
599 MSDOG is a not a multitasking operating system, so Emacs features such
600 as asynchronous subprocesses that depend on multitasking will not
601 work.  Synchronous subprocesses do work.
603 The current version of djgpp 2.0 (as of August 1996) has two bugs that
604 affect Emacs.  We've included corrected versions of two files from
605 djgpp in the msdos subdirectory: is_exec.c and sigaction.c.  To work
606 around the bugs, compile these files and link them into temacs.  The
607 next version of djgpp should have these bugs fixed.