("Korean"): Doc fix.
[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 4) Look at `./lisp/paths.el'; if some of those values are not right
177 for your system, set up the file `./lisp/site-init.el' with Emacs
178 Lisp code to override them; it is not a good idea to edit paths.el
179 itself. YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES,
180 rather than `defvar', as used by `./lisp/paths.el'. For example,
181
182 (setq news-inews-program "/usr/bin/inews")
183
184 is how you would override the default value of the variable
185 news-inews-program (which is "/usr/local/inews").
186
187 Before you override a variable this way, *look at the value* that the
188 variable gets by default! Make sure you know what kind of value the
189 variable should have. If you don't pay attention to what you are
190 doing, you'll make a mistake.
191
192 5) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs
193 Lisp code you want Emacs to load before it is dumped out. Use
194 site-load.el for additional libraries if you arrange for their
195 documentation strings to be in the etc/DOC file (see
196 src/Makefile.in if you wish to figure out how to do that). For all
197 else, use site-init.el.
198
199 If you set load-path to a different value in site-init.el or
200 site-load.el, Emacs will use *precisely* that value when it starts up
201 again. If you do this, you are on your own!
202
203 Note that, on some systems, the code you place in site-init.el must
204 not use expand-file-name or any other function which may look
205 something up in the system's password and user information database.
206 See `./etc/PROBLEMS' for more details on which systems this affects.
207
208 The `site-*.el' files are nonexistent in the distribution. You do not
209 need to create them if you have nothing to put in them.
210
211 6) Refer to the file `./etc/TERMS' for information on fields you may
212 wish to add to various termcap entries. The files `./etc/termcap.ucb'
213 and `./etc/termcap.dat' may already contain appropriately-modified
214 entries.
215
216 7) Run `make' in the top directory of the Emacs distribution to finish
217 building Emacs in the standard way. The final executable file is
218 named `src/emacs'. You can execute this file "in place" without
219 copying it, if you wish; then it automatically uses the sibling
220 directories ../lisp, ../lib-src, ../info.
221
222 Or you can "install" the executable and the other Emacs into their
223 installed locations, with `make install'. By default, Emacs's files
224 are installed in the following directories:
225
226 `/usr/local/bin' holds the executable programs users normally run -
227 `emacs', `etags', `ctags', `b2m', `emacsclient',
228 and `rcs-checkin'.
229
230 `/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library;
231 `VERSION' stands for the number of the Emacs version
232 you are installing, like `18.59' or `19.27'. Since the
233 Lisp library changes from one version of Emacs to
234 another, including the version number in the path
235 allows you to have several versions of Emacs installed
236 at the same time; in particular, you don't have to
237 make Emacs unavailable while installing a new version.
238
239 `/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp
240 files installed for Emacs version VERSION only.
241
242 `/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp
243 files installed for all Emacs versions.
244
245 When Emacs is installed, it searches for its Lisp files
246 in `/usr/local/share/emacs/VERSION/site-lisp', then in
247 `/usr/local/share/emacs/site-lisp', and finally in
248 `/usr/local/share/emacs/VERSION/lisp'.
249
250 `/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
251 file, the `yow' database, and other
252 architecture-independent files Emacs might need while
253 running. VERSION is as specified for `.../lisp'.
254
255 `/usr/local/com/emacs/lock' contains files indicating who is editing
256 what, so Emacs can detect editing clashes between
257 users.
258
259 `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable
260 programs used by Emacs that users are not expected to
261 run themselves.
262 `VERSION' is the number of the Emacs version you are
263 installing, and `CONFIGURATION-NAME' is the argument
264 you gave to the `configure' program to identify the
265 architecture and operating system of your machine,
266 like `mips-dec-ultrix' or `sparc-sun-sunos'. Since
267 these files are specific to the version of Emacs,
268 operating system, and architecture in use, including
269 the configuration name in the path allows you to have
270 several versions of Emacs for any mix of machines and
271 operating systems installed at the same time; this is
272 useful for sites at which different kinds of machines
273 share the file system Emacs is installed on.
274
275 `/usr/local/info' holds the on-line documentation for Emacs, known as
276 "info files". Many other GNU programs are documented
277 using info files as well, so this directory stands
278 apart from the other, Emacs-specific directories.
279
280 `/usr/local/man/man1' holds the man pages for the programs installed
281 in `/usr/local/bin'.
282
283 If these directories are not what you want, you can specify where to
284 install Emacs's libraries and data files or where Emacs should search
285 for its Lisp files by giving values for `make' variables as part of
286 the command. See the section below called `MAKE VARIABLES' for more
287 information on this.
288
289 8) Check the file `dir' in your site's info directory (usually
290 /usr/local/info) to make sure that it has a menu entry for the Emacs
291 info files.
292
293 9) If your system uses lock files to interlock access to mailer inbox files,
294 then you might need to make the movemail program setuid or setgid
295 to enable it to write the lock files. We believe this is safe.
296
297 10) You are done! You can remove executables and object files from
298 the build directory by typing `make clean'. To also remove the files
299 that `configure' created (so you can compile Emacs for a different
300 configuration), type `make distclean'.
301
302
303
304 MAKE VARIABLES
305
306 You can change where the build process installs Emacs and its data
307 files by specifying values for `make' variables as part of the `make'
308 command line. For example, if you type
309
310 make install bindir=/usr/local/gnubin
311
312 the `bindir=/usr/local/gnubin' argument indicates that the Emacs
313 executable files should go in `/usr/local/gnubin', not
314 `/usr/local/bin'.
315
316 Here is a complete list of the variables you may want to set.
317
318 `bindir' indicates where to put executable programs that users can
319 run. This defaults to /usr/local/bin.
320
321 `datadir' indicates where to put the architecture-independent
322 read-only data files that Emacs refers to while it runs; it
323 defaults to /usr/local/share. We create the following
324 subdirectories under `datadir':
325 - `emacs/VERSION/lisp', containing the Emacs Lisp library, and
326 - `emacs/VERSION/etc', containing the Emacs tutorial, the DOC
327 file, and the `yow' database.
328 `VERSION' is the number of the Emacs version you are installing,
329 like `18.59' or `19.0'. Since these files vary from one version
330 of Emacs to another, including the version number in the path
331 allows you to have several versions of Emacs installed at the
332 same time; this means that you don't have to make Emacs
333 unavailable while installing a new version.
334
335 `sharedstatedir' indicates where to put architecture-independent data files
336 that Emacs modifies while it runs; it defaults to
337 /usr/local/com. We create the following
338 subdirectories under `sharedstatedir':
339 - `emacs/lock', containing files indicating who is editing
340 what, so Emacs can detect editing clashes between
341 users.
342
343 `libexecdir' indicates where to put architecture-specific data files that
344 Emacs refers to as it runs; it defaults to `/usr/local/libexec'.
345 We create the following subdirectories under `libexecdir':
346 - `emacs/VERSION/CONFIGURATION-NAME', containing executable
347 programs used by Emacs that users are not expected to run
348 themselves.
349 `VERSION' is the number of the Emacs version you are installing,
350 and `CONFIGURATION-NAME' is the argument you gave to the
351 `configure' program to identify the architecture and operating
352 system of your machine, like `mips-dec-ultrix' or
353 `sparc-sun-sunos'. Since these files are specific to the version
354 of Emacs, operating system, and architecture in use, including
355 the configuration name in the path allows you to have several
356 versions of Emacs for any mix of machines and operating systems
357 installed at the same time; this is useful for sites at which
358 different kinds of machines share the file system Emacs is
359 installed on.
360
361 `infodir' indicates where to put the info files distributed with
362 Emacs; it defaults to `/usr/local/info'.
363
364 `mandir' indicates where to put the man pages for Emacs and its
365 utilities (like `etags'); it defaults to
366 `/usr/local/man/man1'.
367
368 `manext' gives the extension the man pages should be installed with.
369 It should contain a period, followed by the appropriate
370 digit. It defaults to `.1'. For example given the default
371 values for `mandir' and `manext', the Emacs man page would be
372 installed as `/usr/local/man/man1/emacs.1'.
373
374 `prefix' doesn't give a path for any specific part of Emacs; instead,
375 its value is used to determine the defaults for all the
376 architecture-independent path variables - `datadir',
377 `sharedstatedir', `infodir', and `mandir'. Its default value is
378 `/usr/local'; the other variables add on `lib' or `man' to it
379 by default.
380
381 For example, suppose your site generally places GNU software
382 under `/usr/users/software/gnusoft' instead of `/usr/local'.
383 By including
384 `prefix=/usr/users/software/gnusoft'
385 in the arguments to `make', you can instruct the build process
386 to place all of the Emacs data files in the appropriate
387 directories under that path.
388
389 `exec_prefix' serves the same purpose as `prefix', but instead
390 determines the default values for the architecture-dependent
391 path variables - `bindir' and `libexecdir'.
392
393 The above variables serve analogous purposes in the makefiles for all
394 GNU software; this variable is specific to Emacs.
395
396 `archlibdir' indicates where Emacs installs and expects the executable
397 files and other architecture-dependent data it uses while
398 running. Its default value, based on `libexecdir' (which
399 see), is `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME'
400 (where VERSION and CONFIGURATION-NAME are as described above).
401
402 Remember that you must specify any variable values you need each time
403 you run `make' in the top directory. If you run `make' once to build
404 emacs, test it, and then run `make' again to install the files, you
405 must provide the same variable settings each time. To make the
406 settings persist, you can edit them into the `Makefile' in the top
407 directory, but be aware that running the `configure' program erases
408 `Makefile' and rebuilds it from `Makefile.in'.
409
410 The path for finding Lisp files is specified in src/paths.h,
411 a file which is generated by running configure. To change the path,
412 you can edit the definition of PATH_LOADSEARCH in that file
413 before you run `make'.
414
415 The top-level Makefile stores the variable settings it used in the
416 Makefiles for the subdirectories, so you don't have to specify them
417 when running make in the subdirectories.
418
419
420 CONFIGURATION BY HAND
421
422 Instead of running the `configure' program, you have to perform the
423 following steps.
424
425 1) Copy `./src/config.in' to `./src/config.h'.
426
427 2) Consult `./etc/MACHINES' to see what configuration name you should
428 use for your system. Look at the code of the `configure' script to
429 see which operating system and architecture description files from
430 `src/s' and `src/m' should be used for that configuration name. Edit
431 `src/config.h', and change the two `#include' directives to include
432 the appropriate system and architecture description files.
433
434 2) Edit `./src/config.h' to set the right options for your system. If
435 you need to override any of the definitions in the s/*.h and m/*.h
436 files for your system and machine, do so by editing config.h, not by
437 changing the s/*.h and m/*.h files. Occasionally you may need to
438 redefine parameters used in `./lib-src/movemail.c'.
439
440 3) Create src/Makefile and lib-src/Makefile from the corresponding
441 `Makefile.in' files. First copy `Makefile.in' to `Makefile.c',
442 then edit in appropriate substitutions for the @...@ constructs,
443 and then copy the shell commands near the end of `configure'
444 that run cpp to construct `Makefile'.
445
446 4) Create `Makefile' files in various other directories
447 from the corresponding `Makefile.in' files. This isn't so hard,
448 just a matter of substitution.
449
450 The `configure' script is built from `configure.in' by the `autoconf'
451 program. You need version 2.0 or newer of `autoconf' to rebuild `configure'.
452
453 BUILDING GNU EMACS BY HAND
454
455 Once Emacs is configured, running `make' in the top directory performs
456 the following steps.
457
458 1) Run `make src/paths.h' in the top directory. This produces
459 `./src/paths.h' from the template file `./src/paths.in', changing
460 the paths to the values specified in `./Makefile'.
461
462 2) Go to directory `./lib-src' and run `make'. This creates
463 executables named `ctags' and `etags' and `wakeup' and `make-docfile'
464 and `digest-doc' and `test-distrib'. And others.
465
466 3) Go to directory `./src' and Run `make'. This refers to files in
467 the `./lisp' and `./lib-src' subdirectories using names `../lisp' and
468 `../lib-src'.
469
470 This creates a file `./src/emacs' which is the runnable Emacs,
471 which has another name that contains a version number.
472 Each time you do this, that version number increments in the last place.
473
474 It also creates a file in `./etc' whose name is `DOC' followed by the
475 current Emacs version. This file contains documentation strings for
476 all the functions in Emacs. Each time you run make to make a new
477 emacs, a new DOC file with a new name is made. You must keep the DOC
478 file for an Emacs version as long as you keep using that Emacs
479 version.
480
481
482 INSTALLATION BY HAND
483
484 The steps below are done by running `make install' in the main
485 directory of the Emacs distribution.
486
487 1) Copy `./lisp' and its subdirectories, `./etc', and the executables
488 in `./lib-src' to their final destinations, as selected in `./src/paths.h'.
489
490 Strictly speaking, not all of the executables in `./lib-src' need be copied.
491 - The programs `cvtmail', `emacsserver', `fakemail', `hexl',
492 `movemail', `profile', `rcs2log', `timer', `vcdiff', `wakeup',
493 and `yow' are used by Emacs; they do need to be copied.
494 - The programs `etags', `ctags', `emacsclient', `b2m', and `rcs-checkin'
495 are intended to be run by users; they are handled below.
496 - The programs `make-docfile' and `test-distrib' were
497 used in building Emacs, and are not needed any more.
498 - The programs `digest-doc' and `sorted-doc' convert a `DOC' file into
499 a file for users to read. There is no important reason to move them.
500
501 2) Copy the files in `./info' to the place specified in
502 `./lisp/site-init.el' or `./lisp/paths.el'. Note that if the
503 destination directory already contains a file named `dir', you
504 probably don't want to replace it with the `dir' file in the Emacs
505 distribution. Instead, you should make sure that the existing `dir'
506 file contains an appropriate menu entry for the Emacs info.
507
508 3) Create a directory for Emacs to use for clash detection, named as
509 indicated by the PATH_LOCK macro in `./src/paths.h'.
510
511 4) Copy `./src/emacs' to `/usr/local/bin', or to some other directory
512 in users' search paths. `./src/emacs' has an alternate name
513 `./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named
514 `/usr/local/bin/emacs' pointing to that alternate name, as an easy way
515 of installing different versions.
516
517 You can delete `./src/temacs'.
518
519 5) Copy the programs `b2m', `emacsclient', `ctags', `etags', and
520 `rcs-checkin' from `./lib-src' to `/usr/local/bin'. These programs are
521 intended for users to run.
522
523 6) Copy the man pages in `./etc' for emacs, ctags, and etags into the
524 appropriate man directories.
525
526 7) The files in the `./src' subdirectory, except for `emacs', are not
527 used by Emacs once it is built. However, it is very desirable to keep
528 the source on line for debugging.
529
530
531 PROBLEMS
532
533 See the file PROBLEMS in etc subdirectory for a list of various
534 problems sometimes encountered, and what to do about them.
535
536
537 Installation on MSDOG (a.k.a. MSDOS)
538
539 To install on MSDOG, you need to have the GNU C compiler for MSDOG
540 (also known as djgpp), GNU Make, rm, mv, and sed. See the remarks in
541 config.bat for more information about locations and versions. The
542 file etc/FAQ includes pointers to Internet sites where you can find
543 the necessary utilities; search for "MS-DOS". The configuration step
544 (see below) will test for these utilities and will refuse to continue
545 if any of them isn't found.
546
547 If you are building the MSDOG version of Emacs on an MSDOG-like system
548 which supports long file names (e.g. Windows 95), you need to make
549 sure that long file names are handled consistently both when you
550 unpack the distribution and compile it. If you intend to compile with
551 DJGPP v2.0 or later, and long file names support is enabled (LFN=y in
552 the environment), you need to unpack Emacs distribution in a way that
553 doesn't truncate the original long filenames to the DOS 8.3 namespace;
554 the easiest way to do this is to use djtar program which comes with
555 DJGPP, since it will note the LFN setting and behave accordingly.
556 DJGPP v1 doesn't support long filenames, so you must unpack Emacs with
557 a program that truncates the filenames to 8.3 naming as it extracts
558 files; again, using djtar after setting LFN=n is the recommended way.
559 You can build Emacs with LFN=n even if you use DJGPP v2, if some of
560 your tools don't support long file names: just ensure that LFN is set
561 to `n' during both unpacking and compiling.
562
563 (By the time you read this, you have already unpacked the Emacs
564 distribution, but if the explanations above imply that you should have
565 done it differently, it's safer to delete the directory tree created
566 by the unpacking program and unpack Emacs again, than to risk running
567 into problems during the build process.)
568
569 It is important to understand that the runtime support of long file
570 names by the Emacs binary is NOT affected by the LFN setting during
571 compilation; Emacs compiled with DJGPP v2.0 or later will always
572 support long file names on Windows 95 no matter what was the setting
573 of LFN at compile time. However, if you compiled with LFN disabled
574 and want to enable LFN support after Emacs was already built, you need
575 to make sure that the support files in the lisp, etc and info
576 directories are called by their original long names as found in the
577 distribution. You can do this either by renaming the files manually,
578 or by extracting them from the original distribution archive with
579 djtar after you set LFN=y in the environment.
580
581 To unpack Emacs with djtar, type this command:
582
583 djtar -x emacs.tgz
584
585 (This assumes that the Emacs distribution is called `emacs.tgz' on
586 your system.)
587
588 When unpacking is done, a directory called `emacs-XX.YY' will be
589 created, where XX.YY is the Emacs version. To build and install
590 Emacs, chdir to that directory and type these commands:
591
592 config msdos
593 make install
594
595 Building Emacs creates executable files in the src and lib-src
596 directories. Installing Emacs on MSDOS moves these executables to a
597 sibling directory called bin. For example, if you build in directory
598 /emacs, installing moves the executables from /emacs/src and
599 /emacs/lib-src to the directory /emacs/bin, so you can then delete the
600 subdirectories /emacs/src and /emacs/lib-src if you wish. The only
601 subdirectories you need to keep are bin, lisp, etc and info. The bin
602 subdirectory should be added to your PATH. The msdos subdirectory
603 includes a PIF and an icon file for Emacs which you might find useful
604 if you run Emacs under MS Windows.
605
606 Emacs on MSDOS finds the lisp, etc and info directories by looking in
607 ../lisp, ../etc and ../info, starting from the directory where the
608 Emacs executable was run from. You can override this by setting the
609 environment variables EMACSDATA (for the location of `etc' directory),
610 EMACSLOADPATH (for the location of `lisp' directory) and INFOPATH (for
611 the location of the `info' directory).
612
613 MSDOG is a not a multitasking operating system, so Emacs features such
614 as asynchronous subprocesses that depend on multitasking will not
615 work. Synchronous subprocesses do work.
616
617 Version 2.0 of djgpp has two bugs that affect Emacs. We've included
618 corrected versions of two files from djgpp in the msdos subdirectory:
619 is_exec.c and sigaction.c. To work around the bugs, compile these
620 files and link them into temacs. Djgpp version 2.01 have these bugs
621 fixed, so upgrade if you can before building Emacs.