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