*** empty log message ***
[emacs.git] / INSTALL
blobfe06bff8aaeceed0ac50bd1ff2992452fede4c8e
1 GNU Emacs Installation Guide
2 Copyright (c) 1992, 1994, 1996, 1997, 2000, 2001 Free software Foundation, Inc.
3 See the end of the file for copying permissions.
6 BASIC INSTALLATION
8 The simplest way to build Emacs is to use the `configure' shell script
9 which attempts to guess correct values for various system-dependent
10 variables and features and find the directories where various system
11 headers and libraries are kept.  It then creates a `Makefile' in each
12 subdirectory and a `config.h' file containing system-dependent
13 definitions.  Running the `make' utility then builds the package for
14 your system.
16 Here's the procedure to build Emacs using `configure' on systems which
17 are supported by it.  If this simplified procedure fails, or if you
18 are using a platform such as MS-Windows, where `configure' script
19 doesn't work, you might need to use various non-default options, and
20 maybe perform some of the steps manually.  The more detailed
21 description in the rest of the sections of this guide will help you do
22 that, so please refer to them if the simple procedure does not work.
24   1. Make sure your system has at least 120 MB of free disk space.
26   2a. `cd' to the directory where you unpacked Emacs and invoke the
27       `configure' script:
29                  ./configure
31   2b. Alternatively, create a separate directory, outside the source
32       directory, where you want to build Emacs, and invoke `configure'
33       from there:
35                  SOURCE-DIR/configure
37       where SOURCE-DIR is the top-level Emacs source directory.  This
38       may not work unless you use GNU make.
40   3. When `configure' finishes, it prints several lines of details
41      about the system configuration.  Read those details carefully
42      looking for anything suspicious, such as wrong CPU and operating
43      system names, wrong places for headers or libraries, missing
44      libraries that you know are installed on your system, etc.
46      If you find anything wrong, you will have to pass to `configure'
47      explicit machine configuration name, and one or more options
48      which tell it where to find various headers and libraries; refer
49      to DETAILED BUILDING AND INSTALLATION section below.
51      If `configure' didn't find some image support libraries, such as
52      Xpm, jpeg, etc., and you want to use them refer to the subsection
53      "Image support libraries", below.
55      If the details printed by `configure' don't make any sense to
56      you, assume that `configure' did its job and proceed.
58   4. If you need to run the `configure' script more than once (e.g.,
59      with some non-default options), always clean the source
60      directories before running `configure' again:
62                 make distclean
63                 ./configure
65   5. Invoke the `make' program:
67                  make
69   6. If `make' succeeds, it will build an executable program `emacs'
70      in the `src' directory.  You can try this program, to make sure
71      it works:
73                  src/emacs -q
75   7. Assuming that the program `src/emacs' starts and displays its
76      opening screen, you can install the program and its auxiliary
77      files into their installation directories:
79                  make install
81   You are now ready to use Emacs.  If you wish to conserve disk space,
82   you may remove the program binaries and object files from the
83   directory where you built Emacs:
85                  make clean
87   You can also save some space by compressing (with `gzip') Info files
88   and installed Lisp source (.el) files which have corresponding .elc
89   versions.
92 ADDITIONAL DISTRIBUTION FILES
94 * intlfonts-VERSION.tar.gz
96 The intlfonts distribution contains X11 fonts that Emacs needs in
97 order to display international characters.  If you see a non-ASCII
98 character appear as a hollow box, that means you don't have a font for
99 it.  You might find a font in the intlfonts distribution.  If you do
100 have a font for a non-ASCII character, but some characters don't look
101 right, or appear improperly aligned, a font from the intlfonts
102 distribution might look better.
104 The fonts in the intlfonts distribution are also used by the ps-print
105 package for printing international characters.  The file
106 lisp/ps-mule.el defines the *.bdf font files required for printing
107 each character set.
109 The intlfonts distribution contains its own installation instructions,
110 in the intlfonts/README file.
112 * Image support libraries
114 Emacs needs optional libraries to be able to display images (with the
115 exception of PBM and XBM images whose support is built-in).
117 On some systems, particularly on GNU/Linux, these libraries may
118 already be present or available as additional packages.  Note that if
119 there is a separate `dev' or `devel' package, for use at compilation
120 time rather than run time, you will need that as well as the
121 corresponding run time package; typically the dev package will
122 contain header files and a library archive.  Otherwise, you can
123 download and build libraries from sources.  None of them are vital for
124 running Emacs; however, note that Emacs will not be able to use
125 colored icons in the toolbar if XPM support is not compiled in.
127 Here's the list of these optional libraries, and the URLs where they
128 can be found:
130   . libXaw3d for fancy 3D-style
131       scroll bars:    ftp://ftp.x.org/contrib/widgets/Xaw3d/
132   . libxpm for XPM:   ftp://ftp.x.org/contrib/libraries/
133                       Get version 3.4k or later, which lets Emacs
134                       use its own color allocation functions.
135   . libpng for PNG:   ftp://www.libpng.org/pub/png/
136   . libz (for PNG):   http://www.info-zip.org/pub/infozip/zlib/
137   . libjpeg for JPEG: ftp://ftp.uu.net/graphics/jpeg/
138                       Get version 6b -- 6a is reported to fail in
139                       Emacs.
140   . libtiff for TIFF: http://www.libtiff.org/
141   . libungif for GIF:
142       http://prtr-13.ucsc.edu/~badger/software/libungif/index.shtml
143       Ensure you get version 4.1.0b1 or higher of libungif -- a bug in
144       4.1.0 can crash Emacs.
146 Emacs will configure itself to build with these libraries if the
147 `configure' script finds them on your system, unless you supply the
148 appropriate --without-LIB option.  In some cases, older versions of
149 these libraries won't work because some routines are missing, and
150 configure should avoid such old versions.  If that happens, use the
151 --without-LIB options to `configure'.  See below for more details.
153 * Extra fonts
155 At first, Emacs does not include fonts and does not install them.  You
156 must do this yourself.
158 To take proper advantage of Emacs 21's mule-unicode charsets, you need
159 a Unicode font.  For information on Unicode fonts for X, see
160 <URL:http://czyborra.com/unifont/>,
161 <URL:http://openlab.ring.gr.jp/efont/> and
162 <URL:http://www.cl.cam.ac.uk/%7Emgk25/ucs-fonts.html>.
163 <URL:http://czyborra.com/charsets/> has basic fonts for Emacs's
164 ISO-8859 charsets.
166 XFree86 release 4 (from <URL:ftp://ftp.xfree86.org/> and mirrors)
167 contains font support for most, if not all, of the charsets that Emacs
168 supports.  The font files should be usable separately with older X
169 releases.
171 BDF fonts etl-unicode.tar.gz used by ps-print and ps-mule to print
172 Unicode characters are available from <URL:ftp://ftp.x.org/contrib/fonts/>
173 and <URL:ftp://ftp.xfree86.org/pub/X.Org/contrib/fonts/>.
177 DETAILED BUILDING AND INSTALLATION:
179 (This is for a Unix or Unix-like system.  For MS-DOS and Windows 3.X,
180 see below; search for MSDOG.  For Windows 9X, Windows ME, Windows NT,
181 and Windows 2000, see the file nt/INSTALL.  For the Mac, see the file
182 mac/INSTALL.)
184 1) Make sure your system has enough swapping space allocated to handle
185 a program whose pure code is 1.5 MB and whose data area is at
186 least 2.8 MB and can reach 100 MB or more.  If the swapping space is
187 insufficient, you will get an error in the command `temacs -batch -l
188 loadup dump', found in `./src/Makefile.in', or possibly when
189 running the final dumped Emacs.
191 Building Emacs requires about 140 MB of disk space (including the
192 Emacs sources) Once installed, Emacs occupies about 77 MB in the file
193 system where it is installed; this includes the executable files, Lisp
194 libraries, miscellaneous data files, and on-line documentation.  If
195 the building and installation take place in different directories,
196 then the installation procedure momentarily requires 140+77 MB.
198 2) Consult `./etc/MACHINES' to see what configuration name you should
199 give to the `configure' program.  That file offers hints for
200 getting around some possible installation problems.  The file lists
201 many different configurations, but only the part for your machine and
202 operating system is relevant.  (The list is arranged in alphabetical
203 order by the vendor name.)
205 3) You can build Emacs in the top-level Emacs source directory
206 or in a separate directory.
208 3a) To build in the top-level Emacs source directory, go to that
209 directory and run the program `configure' as follows:
211     ./configure [CONFIGURATION-NAME] [--OPTION[=VALUE]] ...
213 The CONFIGURATION-NAME argument should be a configuration name given
214 in `./etc/MACHINES', with the system version number added at the end.
216 You should try first omitting CONFIGURATION-NAME.  This way,
217 `configure' will try to guess your system type.  If it cannot guess,
218 or if something goes wrong in building or installing Emacs this way,
219 try again specifying the proper CONFIGURATION-NAME explicitly.
221 If you don't want X support, specify `--with-x=no'.  If you omit this
222 option, `configure' will try to figure out for itself whether your
223 system has X, and arrange to use it if present.
225 The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build
226 process where the compiler should look for the include files and
227 object libraries used with the X Window System.  Normally, `configure'
228 is able to find them; these options are necessary if you have your X
229 Window System files installed in unusual places.  These options also
230 accept a list of directories, separated with colons.
232 To get more attractive menus, you can specify an X toolkit when you
233 configure Emacs; use the option `--with-x-toolkit=TOOLKIT', where
234 TOOLKIT is `athena', `motif' or `gtk' (`yes' and `lucid' are synonyms for
235 `athena').  On some systems, it does not work to use a toolkit with
236 shared libraries.  A free implementation of Motif, called LessTif, is
237 available ftom <http://www.lesstif.org>.  Compiling with LessTif or
238 Motif causes a standard File Selection Dialog to pop up when you type
239 "C-x C-f" and similar commands.  You can get fancy 3D-style scroll
240 bars, even without LessTif/Motif, if you have the Xaw3d library
241 installed (see "Image support libraries" above for Xaw3d
242 availability).
244 If `--with-x-toolkit=gtk' is specified, you can tell configure where
245 to search for GTK by specifying `--with-pkg-config-prog=PATH' where
246 PATH is the pathname to pkg-config.  Note that GTK version 2.0 or
247 newer is required for Emacs.
249 The `--with-gcc' option specifies that the build process should
250 compile Emacs using GCC.  If you don't want to use GCC, specify
251 `--with-gcc=no'.  If you omit this option, `configure' will search
252 for GCC in your path, and use it if present.
254 The Emacs mail reader RMAIL is configured to be able to read mail from
255 a POP3 server by default.  Versions of the POP protocol older than
256 POP3 are not supported.  For Kerberos-authenticated POP add
257 `--with-kerberos', for Hesiod support add `--with-hesiod'.  While POP3
258 is always enabled, whether Emacs actually uses POP is controlled by
259 individual users--see the Rmail chapter of the Emacs manual.
261 For image support you may have to download, build, and install the
262 appropriate image support libraries for image types other than XBM and
263 PBM, see the list of URLs in "ADDITIONAL DISTRIBUTION FILES" above.
264 (Note that PNG support requires libz in addition to libpng.)
266 To disable individual types of image support in Emacs for some reason,
267 even though configure finds the libraries, you can configure with one
268 or more of these options:
270   --without-xpm        for XPM image support
271   --without-jpeg       for JPEG image support
272   --without-tiff       for TIFF image support
273   --without-gif        for GIF image support
274   --without-png        for PNG image support
276 Use --without-toolkit-scroll-bars to disable LessTif/Motif or Xaw3d
277 scroll bars.  --without-xim disables the use of X Input Methods, and
278 --disable-largefile omits support for files larger than 2GB on systems
279 which support that.  Use --without-sound to disable sound support.
281 The `--prefix=PREFIXDIR' option specifies where the installation process
282 should put emacs and its data files.  This defaults to `/usr/local'.
283 - Emacs (and the other utilities users run) go in PREFIXDIR/bin
284   (unless the `--exec-prefix' option says otherwise).
285 - The architecture-independent files go in PREFIXDIR/share/emacs/VERSION
286   (where VERSION is the version number of Emacs, like `19.27').
287 - The architecture-dependent files go in
288   PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION
289   (where CONFIGURATION is the configuration name, like mips-dec-ultrix4.2),
290   unless the `--exec-prefix' option says otherwise.
292 The `--exec-prefix=EXECDIR' option allows you to specify a separate
293 portion of the directory tree for installing architecture-specific
294 files, like executables and utility programs.  If specified,
295 - Emacs (and the other utilities users run) go in EXECDIR/bin, and
296 - The architecture-dependent files go in
297   EXECDIR/libexec/emacs/VERSION/CONFIGURATION.
298 EXECDIR/bin should be a directory that is normally in users' PATHs.
300 For example, the command
302     ./configure mips-dec-ultrix --with-x11
304 configures Emacs to build for a DECstation running Ultrix, with
305 support for the X11 window system.
307 `configure' doesn't do any compilation or installation
308 itself.  It just creates the files that influence those things:
309 `./Makefile', `lib-src/Makefile', `oldXMenu/Makefile',
310 `lwlib/Makefile', `src/Makefile', and `./src/config.h'.  For details
311 on exactly what it does, see the section called `CONFIGURATION BY
312 HAND', below.
314 When it is done, `configure' prints a description of what it did and
315 creates a shell script `config.status' which, when run, recreates the
316 same configuration.  If `configure' exits with an error after
317 disturbing the status quo, it removes `config.status'.  `configure'
318 also creates a file `config.cache' that saves the results of its tests
319 to make reconfiguring faster, and a file `config.log' containing compiler
320 output (useful mainly for debugging `configure').  You can give
321 `configure' the option `--cache-file=FILE' to use the results of the
322 tests in FILE instead of `config.cache'.  Set FILE to `/dev/null' to
323 disable caching, for debugging `configure'.
325 If the description of the system configuration printed by `configure'
326 is not right, or if it claims some of the fatures or libraries are not
327 available when you know they are, look at the `config.log' file for
328 the trace of the failed tests performed by `configure' to check
329 whether these features are supported.  Typically, some test fails
330 because the compiler cannot find some function in the system
331 libraries, or some macro-processor definition in the system headers.
333 Some tests might fail because the compiler should look in special
334 directories for some header files, or link against optional
335 libraries, or use special compilation options.  You can force
336 `configure' and the build process which follows it to do that by
337 setting the variables CPPFLAGS, CFLAGS, LDFLAGS, LIBS, and CC before
338 running `configure'.  CPPFLAGS lists the options passed to the
339 preprocessor, CFLAGS are compilation options, LDFLAGS are options used
340 when linking, LIBS are libraries to link against, and CC is the
341 command which invokes the compiler.
343 Here's an example of a `configure' invocation, assuming a Bourne-like
344 shell such as Bash, which uses these variables:
346  CPPFLAGS='-I/foo/myinclude' LDFLAGS='-L/bar/mylib' \
347   CFLAGS='-O3' LIBS='-lfoo -lbar' ./configure
349 (this is all one long line).  This tells `configure' to instruct the
350 preprocessor to look in the `/foo/myinclude' directory for header
351 files (in addition to the standard directories), instruct the linker
352 to look in `/bar/mylib' for libraries, pass the -O3 optimization
353 switch to the compiler, and link against libfoo.a and libbar.a
354 libraries in addition to the standard ones.
356 The work of `configure' can be done by editing various files in the
357 distribution, but using `configure' is easier.  See the section called
358 "CONFIGURATION BY HAND" below if you want to do the configuration
359 yourself.
361 3b) To build in a separate directory, go to that directory
362 and run the program `configure' as follows:
364     SOURCE-DIR/configure CONFIGURATION-NAME [--OPTION[=VALUE]] ...
366 SOURCE-DIR refers to the top-level Emacs source directory which is
367 where Emacs's configure script is located.  `configure' looks for the
368 Emacs source code in the directory that `configure' is in.
370 To build in a separate directory, you must use a version of `make'
371 that supports the `VPATH' variable, such as GNU `make'.
373 3c) Some people try to build in a separate directory by filling
374 it full of symlinks to the files in the real source directory.
375 If you do that, `make all' does work, but `make install' fails:
376 it copies the symbolic links rather than the actual files.
378 As far as is known, there is no particular reason to use
379 a directory full of links rather than use the standard GNU
380 facilities to build in a separate directory (see 3b above).
382 4) Look at `./lisp/paths.el'; if some of those values are not right
383 for your system, set up the file `./lisp/site-init.el' with Emacs
384 Lisp code to override them; it is not a good idea to edit paths.el
385 itself.  YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES,
386 rather than `defvar', as used by `./lisp/paths.el'.  For example,
388      (setq news-inews-program "/usr/bin/inews")
390 is how you would override the default value of the variable
391 news-inews-program (which is "/usr/local/inews").
393 Before you override a variable this way, *look at the value* that the
394 variable gets by default!  Make sure you know what kind of value the
395 variable should have.  If you don't pay attention to what you are
396 doing, you'll make a mistake.
398 5) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs
399 Lisp code you want Emacs to load before it is dumped out.  Use
400 site-load.el for additional libraries if you arrange for their
401 documentation strings to be in the etc/DOC file (see
402 src/Makefile.in if you wish to figure out how to do that).  For all
403 else, use site-init.el.  Do not load byte-compiled code which
404 was build with a non-nil value of `byte-compile-dynamic'.
406 If you set load-path to a different value in site-init.el or
407 site-load.el, Emacs will use *precisely* that value when it starts up
408 again.  If you do this, you are on your own!
410 Note that, on some systems, the code you place in site-init.el must
411 not use expand-file-name or any other function which may look
412 something up in the system's password and user information database.
413 See `./etc/PROBLEMS' for more details on which systems this affects.
415 The `site-*.el' files are nonexistent in the distribution.  You do not
416 need to create them if you have nothing to put in them.
418 6) Refer to the file `./etc/TERMS' for information on fields you may
419 wish to add to various termcap entries.  The files `./etc/termcap.ucb'
420 and `./etc/termcap.dat' may already contain appropriately-modified
421 entries.
423 7) Run `make' in the top directory of the Emacs distribution to finish
424 building Emacs in the standard way.  The final executable file is
425 named `src/emacs'.  You can execute this file "in place" without
426 copying it, if you wish; then it automatically uses the sibling
427 directories ../lisp, ../lib-src, ../info.
429 Or you can "install" the executable and the other Emacs into their
430 installed locations, with `make install'.  By default, Emacs's files
431 are installed in the following directories:
433 `/usr/local/bin' holds the executable programs users normally run -
434                 `emacs', `etags', `ctags', `b2m', `emacsclient',
435                 and `rcs-checkin'.
437 `/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library;
438                 `VERSION' stands for the number of the Emacs version
439                 you are installing, like `18.59' or `19.27'.  Since the
440                 Lisp library changes from one version of Emacs to
441                 another, including the version number in the path
442                 allows you to have several versions of Emacs installed
443                 at the same time; in particular, you don't have to
444                 make Emacs unavailable while installing a new version.
446 `/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp
447                 files installed for Emacs version VERSION only.
449 `/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp
450                 files installed for all Emacs versions.
452                 When Emacs is installed, it searches for its Lisp files
453                 in `/usr/local/share/emacs/VERSION/site-lisp', then in
454                 `/usr/local/share/emacs/site-lisp', and finally in
455                 `/usr/local/share/emacs/VERSION/lisp'.
457 `/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
458                 file, the `yow' database, and other
459                 architecture-independent files Emacs might need while
460                 running.  VERSION is as specified for `.../lisp'.
462 `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable
463                 programs used by Emacs that users are not expected to
464                 run themselves.
465                 `VERSION' is the number of the Emacs version you are
466                 installing, and `CONFIGURATION-NAME' is the argument
467                 you gave to the `configure' program to identify the
468                 architecture and operating system of your machine,
469                 like `mips-dec-ultrix' or `sparc-sun-sunos'.  Since
470                 these files are specific to the version of Emacs,
471                 operating system, and architecture in use, including
472                 the configuration name in the path allows you to have
473                 several versions of Emacs for any mix of machines and
474                 operating systems installed at the same time; this is
475                 useful for sites at which different kinds of machines
476                 share the file system Emacs is installed on.
478 `/usr/local/info' holds the on-line documentation for Emacs, known as
479                 "info files".  Many other GNU programs are documented
480                 using info files as well, so this directory stands
481                 apart from the other, Emacs-specific directories.
483 `/usr/local/man/man1' holds the man pages for the programs installed
484                 in `/usr/local/bin'.
486 If these directories are not what you want, you can specify where to
487 install Emacs's libraries and data files or where Emacs should search
488 for its Lisp files by giving values for `make' variables as part of
489 the command.  See the section below called `MAKE VARIABLES' for more
490 information on this.
492 8) Check the file `dir' in your site's info directory (usually
493 /usr/local/info) to make sure that it has a menu entry for the Emacs
494 info files.
496 9) If your system uses lock files to interlock access to mailer inbox files,
497 then you might need to make the movemail program setuid or setgid
498 to enable it to write the lock files.  We believe this is safe.
500 10) You are done!  You can remove executables and object files from
501 the build directory by typing `make clean'.  To also remove the files
502 that `configure' created (so you can compile Emacs for a different
503 configuration), type `make distclean'.  If you don't need some, or all
504 of the input methods from the Leim package, you can remove the
505 unneeded files in the leim subdirectories of your site's lisp
506 directory (usually /usr/local/share/emacs/VERSION/).
510 MAKE VARIABLES
512 You can change where the build process installs Emacs and its data
513 files by specifying values for `make' variables as part of the `make'
514 command line.  For example, if you type
516     make install bindir=/usr/local/gnubin
518 the `bindir=/usr/local/gnubin' argument indicates that the Emacs
519 executable files should go in `/usr/local/gnubin', not
520 `/usr/local/bin'.
522 Here is a complete list of the variables you may want to set.
524 `bindir' indicates where to put executable programs that users can
525         run.  This defaults to /usr/local/bin.
527 `datadir' indicates where to put the architecture-independent
528         read-only data files that Emacs refers to while it runs; it
529         defaults to /usr/local/share.  We create the following
530         subdirectories under `datadir':
531         - `emacs/VERSION/lisp', containing the Emacs Lisp library, and
532         - `emacs/VERSION/etc', containing the Emacs tutorial, the DOC
533                 file, and the `yow' database.
534         `VERSION' is the number of the Emacs version you are installing,
535         like `18.59' or `19.0'.  Since these files vary from one version
536         of Emacs to another, including the version number in the path
537         allows you to have several versions of Emacs installed at the
538         same time; this means that you don't have to make Emacs
539         unavailable while installing a new version.
541 `libexecdir' indicates where to put architecture-specific data files that
542         Emacs refers to as it runs; it defaults to `/usr/local/libexec'.
543         We create the following subdirectories under `libexecdir':
544         - `emacs/VERSION/CONFIGURATION-NAME', containing executable
545                 programs used by Emacs that users are not expected to run
546                 themselves.
547         `VERSION' is the number of the Emacs version you are installing,
548         and `CONFIGURATION-NAME' is the argument you gave to the
549         `configure' program to identify the architecture and operating
550         system of your machine, like `mips-dec-ultrix' or
551         `sparc-sun-sunos'.  Since these files are specific to the version
552         of Emacs, operating system, and architecture in use, including
553         the configuration name in the path allows you to have several
554         versions of Emacs for any mix of machines and operating systems
555         installed at the same time; this is useful for sites at which
556         different kinds of machines share the file system Emacs is
557         installed on.
559 `infodir' indicates where to put the info files distributed with
560         Emacs; it defaults to `/usr/local/info'.
562 `mandir' indicates where to put the man pages for Emacs and its
563         utilities (like `etags'); it defaults to
564         `/usr/local/man/man1'.
566 `manext' gives the extension the man pages should be installed with.
567         It should contain a period, followed by the appropriate
568         digit.  It defaults to `.1'.  For example given the default
569         values for `mandir' and `manext', the Emacs man page would be
570         installed as `/usr/local/man/man1/emacs.1'.
572 `prefix' doesn't give a path for any specific part of Emacs; instead,
573         its value is used to determine the defaults for all the
574         architecture-independent path variables - `datadir',
575         `sharedstatedir', `infodir', and `mandir'.  Its default value is
576         `/usr/local'; the other variables add on `lib' or `man' to it
577         by default.
579         For example, suppose your site generally places GNU software
580         under `/usr/users/software/gnusoft' instead of `/usr/local'.
581         By including
582             `prefix=/usr/users/software/gnusoft'
583         in the arguments to `make', you can instruct the build process
584         to place all of the Emacs data files in the appropriate
585         directories under that path.
587 `exec_prefix' serves the same purpose as `prefix', but instead
588         determines the default values for the architecture-dependent
589         path variables - `bindir' and `libexecdir'.
591 The above variables serve analogous purposes in the makefiles for all
592 GNU software; this variable is specific to Emacs.
594 `archlibdir' indicates where Emacs installs and expects the executable
595         files and other architecture-dependent data it uses while
596         running.  Its default value, based on `libexecdir' (which
597         see), is `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME'
598         (where VERSION and CONFIGURATION-NAME are as described above).
600 Remember that you must specify any variable values you need each time
601 you run `make' in the top directory.  If you run `make' once to build
602 emacs, test it, and then run `make' again to install the files, you
603 must provide the same variable settings each time.  To make the
604 settings persist, you can edit them into the `Makefile' in the top
605 directory, but be aware that running the `configure' program erases
606 `Makefile' and rebuilds it from `Makefile.in'.
608 The path for finding Lisp files is specified in src/paths.h,
609 a file which is generated by running configure.  To change the path,
610 you can edit the definition of PATH_LOADSEARCH in that file
611 before you run `make'.
613 The top-level Makefile stores the variable settings it used in the
614 Makefiles for the subdirectories, so you don't have to specify them
615 when running make in the subdirectories.
618 CONFIGURATION BY HAND
620 Instead of running the `configure' program, you have to perform the
621 following steps.
623 1) Copy `./src/config.in' to `./src/config.h'.
625 2) Consult `./etc/MACHINES' to see what configuration name you should
626 use for your system.  Look at the code of the `configure' script to
627 see which operating system and architecture description files from
628 `src/s' and `src/m' should be used for that configuration name.  Edit
629 `src/config.h', and change the two `#include' directives to include
630 the appropriate system and architecture description files.
632 2) Edit `./src/config.h' to set the right options for your system.  If
633 you need to override any of the definitions in the s/*.h and m/*.h
634 files for your system and machine, do so by editing config.h, not by
635 changing the s/*.h and m/*.h files.  Occasionally you may need to
636 redefine parameters used in `./lib-src/movemail.c'.
638 3) Create src/Makefile and lib-src/Makefile from the corresponding
639 `Makefile.in' files.  First copy `Makefile.in' to `Makefile.c',
640 then edit in appropriate substitutions for the @...@ constructs,
641 and then copy the shell commands near the end of `configure'
642 that run cpp to construct `Makefile'.
644 4) Create `Makefile' files in various other directories
645 from the corresponding `Makefile.in' files.  This isn't so hard,
646 just a matter of substitution.
648 The `configure' script is built from `configure.in' by the `autoconf'
649 program.  You need version 2.51 or newer of `autoconf' to rebuild
650 `configure'.
652 BUILDING GNU EMACS BY HAND
654 Once Emacs is configured, running `make' in the top directory performs
655 the following steps.
657 1) Run `make src/paths.h' in the top directory.  This produces
658 `./src/paths.h' from the template file `./src/paths.in', changing
659 the paths to the values specified in `./Makefile'.
661 2) Go to directory `./lib-src' and run `make'.  This creates
662 executables named `ctags' and `etags' and `wakeup' and `make-docfile'
663 and `digest-doc' and `test-distrib'.  And others.
665 3) Go to directory `./src' and Run `make'.  This refers to files in
666 the `./lisp' and `./lib-src' subdirectories using names `../lisp' and
667 `../lib-src'.
669 This creates a file `./src/emacs' which is the runnable Emacs,
670 which has another name that contains a version number.
671 Each time you do this, that version number increments in the last place.
673 It also creates a file in `./etc' whose name is `DOC' followed by the
674 current Emacs version.  This file contains documentation strings for
675 all the functions in Emacs.  Each time you run make to make a new
676 emacs, a new DOC file with a new name is made.  You must keep the DOC
677 file for an Emacs version as long as you keep using that Emacs
678 version.
681 INSTALLATION BY HAND
683 The steps below are done by running `make install' in the main
684 directory of the Emacs distribution.
686 1) Copy `./lisp' and its subdirectories, `./etc', and the executables
687 in `./lib-src' to their final destinations, as selected in `./src/paths.h'.
689 Strictly speaking, not all of the executables in `./lib-src' need be copied.
690 - The programs `cvtmail', `fakemail', `hexl',
691     `movemail', `profile', `rcs2log', `timer', `vcdiff', `wakeup',
692     and `yow' are used by Emacs; they do need to be copied.
693 - The programs `etags', `ctags', `emacsclient', `b2m', and `rcs-checkin'
694     are intended to be run by users; they are handled below.
695 - The programs `make-docfile' and `test-distrib' were
696     used in building Emacs, and are not needed any more.
697 - The programs `digest-doc' and `sorted-doc' convert a `DOC' file into
698     a file for users to read.  There is no important reason to move them.
700 2) Copy the files in `./info' to the place specified in
701 `./lisp/site-init.el' or `./lisp/paths.el'.  Note that if the
702 destination directory already contains a file named `dir', you
703 probably don't want to replace it with the `dir' file in the Emacs
704 distribution.  Instead, you should make sure that the existing `dir'
705 file contains an appropriate menu entry for the Emacs info.
707 3) Copy `./src/emacs' to `/usr/local/bin', or to some other directory
708 in users' search paths.  `./src/emacs' has an alternate name
709 `./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named
710 `/usr/local/bin/emacs' pointing to that alternate name, as an easy way
711 of installing different versions.
713 You can delete `./src/temacs'.
715 4) Copy the programs `b2m', `emacsclient', `ctags', `etags', and
716 `rcs-checkin' from `./lib-src' to `/usr/local/bin'.  These programs are
717 intended for users to run.
719 5) Copy the man pages in `./etc' for emacs, ctags, and etags into the
720 appropriate man directories.
722 6) The files in the `./src' subdirectory, except for `emacs', are not
723 used by Emacs once it is built.  However, it is very desirable to keep
724 the source on line for debugging.
727 PROBLEMS
729 See the file PROBLEMS in etc subdirectory for a list of various
730 problems sometimes encountered, and what to do about them.
733 Installation on MSDOG (a.k.a. MSDOS)
735 To install on MSDOG, you need to have the GNU C compiler for MSDOG
736 (also known as djgpp), GNU Make, rm, mv, and sed.  See the remarks in
737 config.bat for more information about locations and versions.  The
738 file etc/FAQ includes pointers to Internet sites where you can find
739 the necessary utilities; search for "MS-DOS".  The configuration step
740 (see below) will test for these utilities and will refuse to continue
741 if any of them isn't found.
743 Recompiling Lisp files in the `lisp' subdirectory using the various
744 targets in the lisp/Makefile file requires additional utilities:
745 `find' and `xargs' (from Findutils), `touch' (from Fileutils) GNU
746 `echo' and `test' (from Sh-utils), `tr, `sort', and `uniq' (from
747 Textutils), and a port of Bash.  However, you should not normally need
748 to run lisp/Makefile, as all the Lisp files are distributed in
749 byte-compiled form as well.
751 If you are building the MSDOG version of Emacs on an MSDOG-like system
752 which supports long file names (e.g. Windows 95), you need to make
753 sure that long file names are handled consistently both when you
754 unpack the distribution and compile it.  If you intend to compile with
755 DJGPP v2.0 or later, and long file names support is enabled (LFN=y in
756 the environment), you need to unpack Emacs distribution in a way that
757 doesn't truncate the original long filenames to the DOS 8.3 namespace;
758 the easiest way to do this is to use djtar program which comes with
759 DJGPP, since it will note the LFN setting and behave accordingly.
760 DJGPP v1 doesn't support long filenames, so you must unpack Emacs with
761 a program that truncates the filenames to 8.3 naming as it extracts
762 files; again, using djtar after setting LFN=n is the recommended way.
763 You can build Emacs with LFN=n even if you use DJGPP v2, if some of
764 your tools don't support long file names: just ensure that LFN is set
765 to `n' during both unpacking and compiling.
767 (By the time you read this, you have already unpacked the Emacs
768 distribution, but if the explanations above imply that you should have
769 done it differently, it's safer to delete the directory tree created
770 by the unpacking program and unpack Emacs again, than to risk running
771 into problems during the build process.)
773 It is important to understand that the runtime support of long file
774 names by the Emacs binary is NOT affected by the LFN setting during
775 compilation; Emacs compiled with DJGPP v2.0 or later will always
776 support long file names on Windows 9X no matter what was the setting
777 of LFN at compile time.  However, if you compiled with LFN disabled
778 and want to enable LFN support after Emacs was already built, you need
779 to make sure that the support files in the lisp, etc and info
780 directories are called by their original long names as found in the
781 distribution.  You can do this either by renaming the files manually,
782 or by extracting them from the original distribution archive with
783 djtar after you set LFN=y in the environment.
785 To unpack Emacs with djtar, type this command:
787     djtar -x emacs.tgz
789 (This assumes that the Emacs distribution is called `emacs.tgz' on
790 your system.)
792 If you want to print international characters, install the intlfonts
793 distribution.  For this, create a directory called `fonts' under the
794 Emacs top-level directory (usually called `emacs-XX.YY') created by
795 unpacking emacs.tgz, chdir into the directory emacs-XX.YY/fonts, and
796 type this:
798     djtar -x intlfonts.tgz
800 When unpacking is done, a directory called `emacs-XX.YY' will be
801 created, where XX.YY is the Emacs version.  To build and install
802 Emacs, chdir to that directory and type these commands:
804     config msdos
805     make install
807 Running "config msdos" checks for several programs that are required
808 to configure and build Emacs; if one of those programs is not found,
809 CONFIG.BAT stops and prints an error message.  If you have DJGPP
810 version 2.0 or 2.01, it will complain about a program called
811 DJECHO.EXE.  These old versions of DJGPP shipped that program under
812 the name ECHO.EXE, so you can simply copy ECHO.EXE to DJECHO.EXE and
813 rerun CONFIG.BAT.  If you have neither ECHO.EXE nor DJECHO.EXE, you
814 should be able to find them in your djdevNNN.zip archive (where NNN is
815 the DJGPP version number).
817 On Windows NT or Windows 2000, running "config msdos" might print an
818 error message like "VDM has been already loaded".  This is because
819 those systems have a program called `redir.exe' which is incompatible
820 with a program by the same name supplied with DJGPP, which is used by
821 config.bat.  To resolve this, move the DJGPP's `bin' subdirectory to
822 the front of your PATH environment variable.
824 To install the international fonts, chdir to the intlfonts-X.Y
825 directory created when you unpacked the intlfonts distribution (X.Y is
826 the version number of the fonts' distribution), and type the following
827 command:
829     make bdf INSTALLDIR=..
831 After Make finishes, you may remove the directory intlfonts-X.Y; the
832 fonts are installed into the fonts/bdf subdirectory of the top-level
833 Emacs directory, and that is where Emacs will look for them by
834 default.
836 Building Emacs creates executable files in the src and lib-src
837 directories.  Installing Emacs on MSDOS moves these executables to a
838 sibling directory called bin.  For example, if you build in directory
839 /emacs, installing moves the executables from /emacs/src and
840 /emacs/lib-src to the directory /emacs/bin, so you can then delete the
841 subdirectories /emacs/src and /emacs/lib-src if you wish.  The only
842 subdirectories you need to keep are bin, lisp, etc and info.  (If you
843 installed intlfonts, keep the fonts directory and all its
844 subdirectories as well.)  The bin subdirectory should be added to your
845 PATH.  The msdos subdirectory includes a PIF and an icon file for
846 Emacs which you might find useful if you run Emacs under MS Windows.
848 Emacs on MSDOS finds the lisp, etc and info directories by looking in
849 ../lisp, ../etc and ../info, starting from the directory where the
850 Emacs executable was run from.  You can override this by setting the
851 environment variables EMACSDATA (for the location of `etc' directory),
852 EMACSLOADPATH (for the location of `lisp' directory) and INFOPATH (for
853 the location of the `info' directory).
855 MSDOG is a not a multitasking operating system, so Emacs features such
856 as asynchronous subprocesses that depend on multitasking will not
857 work.  Synchronous subprocesses do work.
859 Version 2.0 of djgpp has two bugs that affect Emacs.  We've included
860 corrected versions of two files from djgpp in the msdos subdirectory:
861 is_exec.c and sigaction.c.  To work around the bugs, compile these
862 files and link them into temacs.  Djgpp versions 2.01 and later have
863 these bugs fixed, so upgrade if you can before building Emacs.
865 COPYING PERMISSIONS
867    Permission is granted to anyone to make or distribute verbatim copies
868    of this document as received, in any medium, provided that the
869    copyright notice and permission notice are preserved,
870    and that the distributor grants the recipient permission
871    for further redistribution as permitted by this notice.
873    Permission is granted to distribute modified versions
874    of this document, or of portions of it,
875    under the above conditions, provided also that they
876    carry prominent notices stating who last changed them,
877    and that any new or changed statements about the activities
878    of the Free Software Foundation are approved by the Foundation.