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