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