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