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