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