*** empty log message ***
[emacs.git] / INSTALL
blob5b4c2bef0153f3f05d9b9958e2c00b6a28ad50ad
1 GNU Emacs Installation Guide
2 Copyright (C) 1992, 1994, 1996, 1997, 2000, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007  Free Software Foundation, Inc.
4 See the end of the file for license conditions.
7 BASIC INSTALLATION
9 The simplest way to build Emacs is to use the `configure' shell script
10 which attempts to guess correct values for various system-dependent
11 variables and features and find the directories where various system
12 headers and libraries are kept.  It then creates a `Makefile' in each
13 subdirectory and a `config.h' file containing system-dependent
14 definitions.  Running the `make' utility then builds the package for
15 your system.
17 Here's the procedure to build Emacs using `configure' on systems which
18 are supported by it.  If this simplified procedure fails, or if you
19 are using a platform such as MS-Windows, where `configure' script
20 doesn't work, you might need to use various non-default options, and
21 maybe perform some of the steps manually.  The more detailed
22 description in the rest of the sections of this guide will help you do
23 that, so please refer to them if the simple procedure does not work.
25   1. Make sure your system has at least 120 MB of free disk space.
27   2a. `cd' to the directory where you unpacked Emacs and invoke the
28       `configure' script:
30                  ./configure
32   2b. Alternatively, create a separate directory, outside the source
33       directory, where you want to build Emacs, and invoke `configure'
34       from there:
36                  SOURCE-DIR/configure
38       where SOURCE-DIR is the top-level Emacs source directory.  This
39       may not work unless you use GNU make.
41   3. When `configure' finishes, it prints several lines of details
42      about the system configuration.  Read those details carefully
43      looking for anything suspicious, such as wrong CPU and operating
44      system names, wrong places for headers or libraries, missing
45      libraries that you know are installed on your system, etc.
47      If you find anything wrong, you will have to pass to `configure'
48      explicit machine configuration name, and one or more options
49      which tell it where to find various headers and libraries; refer
50      to DETAILED BUILDING AND INSTALLATION section below.
52      If `configure' didn't find some image support libraries, such as
53      Xpm, jpeg, etc., and you want to use them refer to the subsection
54      "Image support libraries", below.
56      If the details printed by `configure' don't make any sense to
57      you, assume that `configure' did its job and proceed.
59   4. If you need to run the `configure' script more than once (e.g.,
60      with some non-default options), always clean the source
61      directories before running `configure' again:
63                 make distclean
64                 ./configure
66   5. Invoke the `make' program:
68                  make
70   6. If `make' succeeds, it will build an executable program `emacs'
71      in the `src' directory.  You can try this program, to make sure
72      it works:
74                  src/emacs -q
76   7. Assuming that the program `src/emacs' starts and displays its
77      opening screen, you can install the program and its auxiliary
78      files into their installation directories:
80                  make install
82   You are now ready to use Emacs.  If you wish to conserve disk space,
83   you may remove the program binaries and object files from the
84   directory where you built Emacs:
86                  make clean
88   You can also save some space by compressing (with `gzip') Info files
89   and installed Lisp source (.el) files which have corresponding .elc
90   versions.
93 ADDITIONAL DISTRIBUTION FILES
95 * intlfonts-VERSION.tar.gz
97 The intlfonts distribution contains X11 fonts in various encodings
98 that Emacs can use to display international characters.  If you see a
99 non-ASCII character appear as a hollow box, that means you don't have
100 a font for it.  You might find one in the intlfonts distribution.  If
101 you do have a font for a non-ASCII character, but some characters
102 don't look right, or appear improperly aligned, a font from the
103 intlfonts distribution might look better.
105 The fonts in the intlfonts distribution are also used by the ps-print
106 package for printing international characters.  The file
107 lisp/ps-mule.el defines the *.bdf font files required for printing
108 each character set.
110 The intlfonts distribution contains its own installation instructions,
111 in the intlfonts/README file.
113 * Image support libraries
115 Emacs needs optional libraries to be able to display images (with the
116 exception of PBM and XBM images whose support is built-in).
118 On some systems, particularly on GNU/Linux, these libraries may
119 already be present or available as additional packages.  Note that if
120 there is a separate `dev' or `devel' package, for use at compilation
121 time rather than run time, you will need that as well as the
122 corresponding run time package; typically the dev package will
123 contain header files and a library archive.  Otherwise, you can
124 download and build libraries from sources.  None of them are vital for
125 running Emacs; however, note that Emacs will not be able to use
126 colored icons in the toolbar if XPM support is not compiled in.
128 Here's the list of these optional libraries, and the URLs where they
129 can be found:
131   . libXaw3d for fancy 3D-style
132       scroll bars:    ftp://ftp.x.org/contrib/widgets/Xaw3d/
133   . libxpm for XPM:   ftp://ftp.x.org/contrib/libraries/
134                       Get version 3.4k or later, which lets Emacs
135                       use its own color allocation functions.
136   . libpng for PNG:   ftp://ftp.simplesystems.org/pub/libpng/png/
137   . libz (for PNG):   http://www.zlib.net/
138   . libjpeg for JPEG: ftp://ftp.uu.net/graphics/jpeg/
139                       Get version 6b -- 6a is reported to fail in
140                       Emacs.
141   . libtiff for TIFF: http://www.libtiff.org/
142   . libungif for GIF:
143       http://sourceforge.net/projects/libungif
144       Ensure you get version 4.1.0b1 or higher of libungif -- a bug in
145       4.1.0 can crash Emacs.
147 Emacs will configure itself to build with these libraries if the
148 `configure' script finds them on your system, unless you supply the
149 appropriate --without-LIB option.  In some cases, older versions of
150 these libraries won't work because some routines are missing, and
151 configure should avoid such old versions.  If that happens, use the
152 --without-LIB options to `configure'.  See below for more details.
154 * Extra fonts
156 The Emacs distribution does not include fonts and does not install
157 them.  You must do that yourself.
159 To take proper advantage of Emacs 21's mule-unicode charsets, you need
160 a suitable font.  For `Unicode' (ISO 10646) fonts for X, see
161 <URL:http://czyborra.com/unifont/> (packaged in Debian),
162 <URL:http://openlab.ring.gr.jp/efont/> (packaged in Debian).  (In
163 recent Debian versions, there is an extensive `misc-fixed' iso10646-1
164 in the default X installation.)  Perhaps also see
165 <URL:http://www.cl.cam.ac.uk/%7Emgk25/ucs-fonts.html>.
167 <URL:http://czyborra.com/charsets/> has basic fonts for Emacs's
168 ISO-8859 charsets.
170 XFree86 release 4 (from <URL:ftp://ftp.xfree86.org/pub/XFree86/> and mirrors)
171 contains font support for most, if not all, of the charsets that Emacs
172 currently supports, including iso10646-1 encoded fonts for use with
173 the mule-unicode charsets.  The font files should also be usable with
174 older X releases.  Note that XFree 4 contains many iso10646-1 fonts
175 with minimal character repertoires, which can cause problems -- see
176 etc/PROBLEMS.
178 BDF Unicode fonts etl-unicode.tar.gz are available from
179 <URL:ftp://ftp.x.org/contrib/fonts/> and
180 <URL:ftp://ftp.xfree86.org/pub/mirror/X.Org/contrib/fonts/>.  These
181 fonts can also be used by ps-print and ps-mule to print Unicode
182 characters.
184 Finally, the Web pages <URL:http://www.nongnu.org/freefont/index.html>
185 and <URL:http://www.nongnu.org/freefont/resources.html> list a large
186 number of free Unicode fonts.
188 * GNU/Linux development packages
190 Many GNU/Linux systems do not come with development packages by
191 default; they just include the files that you need to run Emacs, but
192 not those you need to compile it.  For example, to compile Emacs with
193 X11 support, you may need to install the special `X11 development'
194 package.  For example, in April 2003, the package names to install
195 were `XFree86-devel' and `Xaw3d-devel' on RedHat.  On Debian, the
196 packages necessary to build the installed version should be
197 sufficient; they can be installed using `apt-get build-dep emacs21' in
198 Debian 3 and above.
201 DETAILED BUILDING AND INSTALLATION:
203 (This is for a Unix or Unix-like system.  For MS-DOS and Windows 3.X,
204 see below; search for MSDOG.  For Windows 9X, Windows ME, Windows NT,
205 and Windows 2000, see the file nt/INSTALL.  For the Mac, see the file
206 mac/INSTALL.)
208 1) Make sure your system has enough swapping space allocated to handle
209 a program whose pure code is 1.5 MB and whose data area is at
210 least 2.8 MB and can reach 100 MB or more.  If the swapping space is
211 insufficient, you will get an error in the command `temacs -batch -l
212 loadup dump', found in `./src/Makefile.in', or possibly when
213 running the final dumped Emacs.
215 Building Emacs requires about 140 MB of disk space (including the
216 Emacs sources) Once installed, Emacs occupies about 77 MB in the file
217 system where it is installed; this includes the executable files, Lisp
218 libraries, miscellaneous data files, and on-line documentation.  If
219 the building and installation take place in different directories,
220 then the installation procedure momentarily requires 140+77 MB.
222 2) Consult `./etc/MACHINES' to see what configuration name you should
223 give to the `configure' program.  That file offers hints for
224 getting around some possible installation problems.  The file lists
225 many different configurations, but only the part for your machine and
226 operating system is relevant.  (The list is arranged in alphabetical
227 order by the vendor name.)
229 3) You can build Emacs in the top-level Emacs source directory
230 or in a separate directory.
232 3a) To build in the top-level Emacs source directory, go to that
233 directory and run the program `configure' as follows:
235     ./configure [CONFIGURATION-NAME] [--OPTION[=VALUE]] ...
237 The CONFIGURATION-NAME argument should be a configuration name given
238 in `./etc/MACHINES', with the system version number added at the end.
240 You should try first omitting CONFIGURATION-NAME.  This way,
241 `configure' will try to guess your system type.  If it cannot guess,
242 or if something goes wrong in building or installing Emacs this way,
243 try again specifying the proper CONFIGURATION-NAME explicitly.
245 If you don't want X support, specify `--with-x=no'.  If you omit this
246 option, `configure' will try to figure out for itself whether your
247 system has X, and arrange to use it if present.
249 The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build
250 process where the compiler should look for the include files and
251 object libraries used with the X Window System.  Normally, `configure'
252 is able to find them; these options are necessary if you have your X
253 Window System files installed in unusual places.  These options also
254 accept a list of directories, separated with colons.
256 To get more attractive menus, you can specify an X toolkit when you
257 configure Emacs; use the option `--with-x-toolkit=TOOLKIT', where
258 TOOLKIT is `athena', `motif' or `gtk' (`yes' and `lucid' are synonyms
259 for `athena').  On some systems, it does not work to use a toolkit
260 with shared libraries.  A free implementation of Motif, called
261 LessTif, is available from <http://www.lesstif.org>.  Compiling with
262 LessTif or Motif causes a standard File Selection Dialog to pop up
263 when you invoke file commands with the mouse.  You can get fancy
264 3D-style scroll bars, even without LessTif/Motif, if you have the
265 Xaw3d library installed (see "Image support libraries" above for Xaw3d
266 availability).
268 If `--with-x-toolkit=gtk' is specified, you can tell configure where
269 to search for GTK by specifying `--with-pkg-config-prog=PATH' where
270 PATH is the pathname to pkg-config.  Note that GTK version 2.4 or
271 newer is required for Emacs.
273 The `--with-gcc' option specifies that the build process should
274 compile Emacs using GCC.  If you don't want to use GCC, specify
275 `--with-gcc=no'.  If you omit this option, `configure' will search
276 for GCC in your path, and use it if present.
278 The Emacs mail reader RMAIL is configured to be able to read mail from
279 a POP3 server by default.  Versions of the POP protocol older than
280 POP3 are not supported.  For Kerberos-authenticated POP add
281 `--with-kerberos', for Hesiod support add `--with-hesiod'.  While POP3
282 is always enabled, whether Emacs actually uses POP is controlled by
283 individual users--see the Rmail chapter of the Emacs manual.
285 For image support you may have to download, build, and install the
286 appropriate image support libraries for image types other than XBM and
287 PBM, see the list of URLs in "ADDITIONAL DISTRIBUTION FILES" above.
288 (Note that PNG support requires libz in addition to libpng.)
290 To disable individual types of image support in Emacs for some reason,
291 even though configure finds the libraries, you can configure with one
292 or more of these options:
294   --without-xpm        for XPM image support
295   --without-jpeg       for JPEG image support
296   --without-tiff       for TIFF image support
297   --without-gif        for GIF image support
298   --without-png        for PNG image support
300 Use --without-toolkit-scroll-bars to disable LessTif/Motif or Xaw3d
301 scroll bars.  
303 Use --without-xim to inhibit the default use of X Input Methods.  In
304 this case, the X resource useXIM can be used to turn on use of XIM.
306 Use --disable-largefile omits support for files larger than 2GB on
307 systems which support that.  
309 Use --without-sound to disable sound support.
311 The `--prefix=PREFIXDIR' option specifies where the installation process
312 should put emacs and its data files.  This defaults to `/usr/local'.
313 - Emacs (and the other utilities users run) go in PREFIXDIR/bin
314   (unless the `--exec-prefix' option says otherwise).
315 - The architecture-independent files go in PREFIXDIR/share/emacs/VERSION
316   (where VERSION is the version number of Emacs, like `19.27').
317 - The architecture-dependent files go in
318   PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION
319   (where CONFIGURATION is the configuration name, like mips-dec-ultrix4.2),
320   unless the `--exec-prefix' option says otherwise.
322 The `--exec-prefix=EXECDIR' option allows you to specify a separate
323 portion of the directory tree for installing architecture-specific
324 files, like executables and utility programs.  If specified,
325 - Emacs (and the other utilities users run) go in EXECDIR/bin, and
326 - The architecture-dependent files go in
327   EXECDIR/libexec/emacs/VERSION/CONFIGURATION.
328 EXECDIR/bin should be a directory that is normally in users' PATHs.
330 For example, the command
332     ./configure mips-dec-ultrix --with-x11
334 configures Emacs to build for a DECstation running Ultrix, with
335 support for the X11 window system.
337 `configure' doesn't do any compilation or installation
338 itself.  It just creates the files that influence those things:
339 `./Makefile', `lib-src/Makefile', `oldXMenu/Makefile',
340 `lwlib/Makefile', `src/Makefile', and `./src/config.h'.  For details
341 on exactly what it does, see the section called `CONFIGURATION BY
342 HAND', below.
344 When it is done, `configure' prints a description of what it did and
345 creates a shell script `config.status' which, when run, recreates the
346 same configuration.  If `configure' exits with an error after
347 disturbing the status quo, it removes `config.status'.  `configure'
348 also creates a file `config.cache' that saves the results of its tests
349 to make reconfiguring faster, and a file `config.log' containing compiler
350 output (useful mainly for debugging `configure').  You can give
351 `configure' the option `--cache-file=FILE' to use the results of the
352 tests in FILE instead of `config.cache'.  Set FILE to `/dev/null' to
353 disable caching, for debugging `configure'.
355 If the description of the system configuration printed by `configure'
356 is not right, or if it claims some of the fatures or libraries are not
357 available when you know they are, look at the `config.log' file for
358 the trace of the failed tests performed by `configure' to check
359 whether these features are supported.  Typically, some test fails
360 because the compiler cannot find some function in the system
361 libraries, or some macro-processor definition in the system headers.
363 Some tests might fail because the compiler should look in special
364 directories for some header files, or link against optional
365 libraries, or use special compilation options.  You can force
366 `configure' and the build process which follows it to do that by
367 setting the variables CPPFLAGS, CFLAGS, LDFLAGS, LIBS, and CC before
368 running `configure'.  CPPFLAGS lists the options passed to the
369 preprocessor, CFLAGS are compilation options, LDFLAGS are options used
370 when linking, LIBS are libraries to link against, and CC is the
371 command which invokes the compiler.
373 Here's an example of a `configure' invocation, assuming a Bourne-like
374 shell such as Bash, which uses these variables:
376  CPPFLAGS='-I/foo/myinclude' LDFLAGS='-L/bar/mylib' \
377   CFLAGS='-O3' LIBS='-lfoo -lbar' ./configure
379 (this is all one long line).  This tells `configure' to instruct the
380 preprocessor to look in the `/foo/myinclude' directory for header
381 files (in addition to the standard directories), instruct the linker
382 to look in `/bar/mylib' for libraries, pass the -O3 optimization
383 switch to the compiler, and link against libfoo.a and libbar.a
384 libraries in addition to the standard ones.
386 For some libraries, like Gtk+, fontconfig and ALSA, `configure' use 
387 pkg-config to find where those libraries are installed. 
388 If you wan't pkg-config to look in special directories, you have to set 
389 the environment variable PKG_CONFIG_PATH to point to the directories 
390 where the .pc-files for those libraries are.
391 For example:
393  PKG_CONFIG_PATH='/usr/local/alsa/lib/pkgconfig:/opt/gtk+-2.8/lib/pkgconfig' \
394    ./configure
396 The work of `configure' can be done by editing various files in the
397 distribution, but using `configure' is easier.  See the section called
398 "CONFIGURATION BY HAND" below if you want to do the configuration
399 yourself.
401 3b) To build in a separate directory, go to that directory
402 and run the program `configure' as follows:
404     SOURCE-DIR/configure CONFIGURATION-NAME [--OPTION[=VALUE]] ...
406 SOURCE-DIR refers to the top-level Emacs source directory which is
407 where Emacs's configure script is located.  `configure' looks for the
408 Emacs source code in the directory that `configure' is in.
410 To build in a separate directory, you must use a version of `make'
411 that supports the `VPATH' variable, such as GNU `make'.
413 3c) Some people try to build in a separate directory by filling
414 it full of symlinks to the files in the real source directory.
415 If you do that, `make all' does work, but `make install' fails:
416 it copies the symbolic links rather than the actual files.
418 As far as is known, there is no particular reason to use
419 a directory full of links rather than use the standard GNU
420 facilities to build in a separate directory (see 3b above).
422 4) Look at `./lisp/paths.el'; if some of those values are not right
423 for your system, set up the file `./lisp/site-init.el' with Emacs
424 Lisp code to override them; it is not a good idea to edit paths.el
425 itself.  YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES,
426 rather than `defvar', as used by `./lisp/paths.el'.  For example,
428      (setq news-inews-program "/usr/bin/inews")
430 is how you would override the default value of the variable
431 news-inews-program (which is "/usr/local/inews").
433 Before you override a variable this way, *look at the value* that the
434 variable gets by default!  Make sure you know what kind of value the
435 variable should have.  If you don't pay attention to what you are
436 doing, you'll make a mistake.
438 5) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs
439 Lisp code you want Emacs to load before it is dumped out.  Use
440 site-load.el for additional libraries if you arrange for their
441 documentation strings to be in the etc/DOC file (see
442 src/Makefile.in if you wish to figure out how to do that).  For all
443 else, use site-init.el.  Do not load byte-compiled code which
444 was build with a non-nil value of `byte-compile-dynamic'.
446 If you set load-path to a different value in site-init.el or
447 site-load.el, Emacs will use *precisely* that value when it starts up
448 again.  If you do this, you are on your own!
450 Note that, on some systems, the code you place in site-init.el must
451 not use expand-file-name or any other function which may look
452 something up in the system's password and user information database.
453 See `./etc/PROBLEMS' for more details on which systems this affects.
455 The `site-*.el' files are nonexistent in the distribution.  You do not
456 need to create them if you have nothing to put in them.
458 6) Refer to the file `./etc/TERMS' for information on fields you may
459 wish to add to various termcap entries.  The files `./etc/termcap.ucb'
460 and `./etc/termcap.dat' may already contain appropriately-modified
461 entries.
463 7) Run `make' in the top directory of the Emacs distribution to finish
464 building Emacs in the standard way.  The final executable file is
465 named `src/emacs'.  You can execute this file "in place" without
466 copying it, if you wish; then it automatically uses the sibling
467 directories ../lisp, ../lib-src, ../info.
469 Or you can "install" the executable and the other Emacs into their
470 installed locations, with `make install'.  By default, Emacs's files
471 are installed in the following directories:
473 `/usr/local/bin' holds the executable programs users normally run -
474                 `emacs', `etags', `ctags', `b2m', `emacsclient',
475                 and `rcs-checkin'.
477 `/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library;
478                 `VERSION' stands for the number of the Emacs version
479                 you are installing, like `18.59' or `19.27'.  Since the
480                 Lisp library changes from one version of Emacs to
481                 another, including the version number in the path
482                 allows you to have several versions of Emacs installed
483                 at the same time; in particular, you don't have to
484                 make Emacs unavailable while installing a new version.
486 `/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
487                 file, the `yow' database, and other
488                 architecture-independent files Emacs might need while
489                 running.  VERSION is as specified for `.../lisp'.
491 `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable
492                 programs used by Emacs that users are not expected to
493                 run themselves.
494                 `VERSION' is the number of the Emacs version you are
495                 installing, and `CONFIGURATION-NAME' is the argument
496                 you gave to the `configure' program to identify the
497                 architecture and operating system of your machine,
498                 like `mips-dec-ultrix' or `sparc-sun-sunos'.  Since
499                 these files are specific to the version of Emacs,
500                 operating system, and architecture in use, including
501                 the configuration name in the path allows you to have
502                 several versions of Emacs for any mix of machines and
503                 operating systems installed at the same time; this is
504                 useful for sites at which different kinds of machines
505                 share the file system Emacs is installed on.
507 `/usr/local/share/info' holds the on-line documentation for Emacs,
508                 known as "info files".  Many other GNU programs are
509                 documented using info files as well, so this directory
510                 stands apart from the other, Emacs-specific
511                 directories.
513 `/usr/local/man/man1' holds the man pages for the programs installed
514                 in `/usr/local/bin'.
516 Any version of Emacs, whether installed or not, also looks for Lisp
517 files in these directories.
519 `/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp
520                 files installed for Emacs version VERSION only.
522 `/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp
523                 files installed for all Emacs versions.
525                 When Emacs is installed, it searches for its Lisp files
526                 in `/usr/local/share/emacs/VERSION/site-lisp', then in
527                 `/usr/local/share/emacs/site-lisp', and finally in
528                 `/usr/local/share/emacs/VERSION/lisp'.
530 If these directories are not what you want, you can specify where to
531 install Emacs's libraries and data files or where Emacs should search
532 for its Lisp files by giving values for `make' variables as part of
533 the command.  See the section below called `MAKE VARIABLES' for more
534 information on this.
536 8) Check the file `dir' in your site's info directory (usually
537 /usr/local/share/info) to make sure that it has a menu entry for the
538 Emacs info files.
540 9) If your system uses lock files to interlock access to mailer inbox files,
541 then you might need to make the movemail program setuid or setgid
542 to enable it to write the lock files.  We believe this is safe.
544 10) You are done!  You can remove executables and object files from
545 the build directory by typing `make clean'.  To also remove the files
546 that `configure' created (so you can compile Emacs for a different
547 configuration), type `make distclean'.  If you don't need some, or all
548 of the input methods from the Leim package, you can remove the
549 unneeded files in the leim subdirectories of your site's lisp
550 directory (usually /usr/local/share/emacs/VERSION/).
554 MAKE VARIABLES
556 You can change where the build process installs Emacs and its data
557 files by specifying values for `make' variables as part of the `make'
558 command line.  For example, if you type
560     make install bindir=/usr/local/gnubin
562 the `bindir=/usr/local/gnubin' argument indicates that the Emacs
563 executable files should go in `/usr/local/gnubin', not
564 `/usr/local/bin'.
566 Here is a complete list of the variables you may want to set.
568 `bindir' indicates where to put executable programs that users can
569         run.  This defaults to /usr/local/bin.
571 `datadir' indicates where to put the architecture-independent
572         read-only data files that Emacs refers to while it runs; it
573         defaults to /usr/local/share.  We create the following
574         subdirectories under `datadir':
575         - `emacs/VERSION/lisp', containing the Emacs Lisp library, and
576         - `emacs/VERSION/etc', containing the Emacs tutorial, the DOC
577                 file, and the `yow' database.
578         `VERSION' is the number of the Emacs version you are installing,
579         like `18.59' or `19.0'.  Since these files vary from one version
580         of Emacs to another, including the version number in the path
581         allows you to have several versions of Emacs installed at the
582         same time; this means that you don't have to make Emacs
583         unavailable while installing a new version.
585 `libexecdir' indicates where to put architecture-specific data files that
586         Emacs refers to as it runs; it defaults to `/usr/local/libexec'.
587         We create the following subdirectories under `libexecdir':
588         - `emacs/VERSION/CONFIGURATION-NAME', containing executable
589                 programs used by Emacs that users are not expected to run
590                 themselves.
591         `VERSION' is the number of the Emacs version you are installing,
592         and `CONFIGURATION-NAME' is the argument you gave to the
593         `configure' program to identify the architecture and operating
594         system of your machine, like `mips-dec-ultrix' or
595         `sparc-sun-sunos'.  Since these files are specific to the version
596         of Emacs, operating system, and architecture in use, including
597         the configuration name in the path allows you to have several
598         versions of Emacs for any mix of machines and operating systems
599         installed at the same time; this is useful for sites at which
600         different kinds of machines share the file system Emacs is
601         installed on.
603 `infodir' indicates where to put the info files distributed with
604         Emacs; it defaults to `/usr/local/share/info'.
606 `mandir' indicates where to put the man pages for Emacs and its
607         utilities (like `etags'); it defaults to
608         `/usr/local/man/man1'.
610 `manext' gives the extension the man pages should be installed with.
611         It should contain a period, followed by the appropriate
612         digit.  It defaults to `.1'.  For example given the default
613         values for `mandir' and `manext', the Emacs man page would be
614         installed as `/usr/local/man/man1/emacs.1'.
616 `prefix' doesn't give a path for any specific part of Emacs; instead,
617         its value is used to determine the defaults for all the
618         architecture-independent path variables - `datadir',
619         `sharedstatedir', `infodir', and `mandir'.  Its default value is
620         `/usr/local'; the other variables add on `lib' or `man' to it
621         by default.
623         For example, suppose your site generally places GNU software
624         under `/usr/users/software/gnusoft' instead of `/usr/local'.
625         By including
626             `prefix=/usr/users/software/gnusoft'
627         in the arguments to `make', you can instruct the build process
628         to place all of the Emacs data files in the appropriate
629         directories under that path.
631 `exec_prefix' serves the same purpose as `prefix', but instead
632         determines the default values for the architecture-dependent
633         path variables - `bindir' and `libexecdir'.
635 The above variables serve analogous purposes in the makefiles for all
636 GNU software; this variable is specific to Emacs.
638 `archlibdir' indicates where Emacs installs and expects the executable
639         files and other architecture-dependent data it uses while
640         running.  Its default value, based on `libexecdir' (which
641         see), is `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME'
642         (where VERSION and CONFIGURATION-NAME are as described above).
644 Remember that you must specify any variable values you need each time
645 you run `make' in the top directory.  If you run `make' once to build
646 emacs, test it, and then run `make' again to install the files, you
647 must provide the same variable settings each time.  To make the
648 settings persist, you can edit them into the `Makefile' in the top
649 directory, but be aware that running the `configure' program erases
650 `Makefile' and rebuilds it from `Makefile.in'.
652 The path for finding Lisp files is specified in src/paths.h,
653 a file which is generated by running configure.  To change the path,
654 you can edit the definition of PATH_LOADSEARCH in that file
655 before you run `make'.
657 The top-level Makefile stores the variable settings it used in the
658 Makefiles for the subdirectories, so you don't have to specify them
659 when running make in the subdirectories.
662 CONFIGURATION BY HAND
664 Instead of running the `configure' program, you have to perform the
665 following steps.
667 1) Copy `./src/config.in' to `./src/config.h'.
669 2) Consult `./etc/MACHINES' to see what configuration name you should
670 use for your system.  Look at the code of the `configure' script to
671 see which operating system and architecture description files from
672 `src/s' and `src/m' should be used for that configuration name.  Edit
673 `src/config.h', and change the two `#include' directives to include
674 the appropriate system and architecture description files.
676 2) Edit `./src/config.h' to set the right options for your system.  If
677 you need to override any of the definitions in the s/*.h and m/*.h
678 files for your system and machine, do so by editing config.h, not by
679 changing the s/*.h and m/*.h files.  Occasionally you may need to
680 redefine parameters used in `./lib-src/movemail.c'.
682 3) Create src/Makefile and lib-src/Makefile from the corresponding
683 `Makefile.in' files.  First copy `Makefile.in' to `Makefile.c',
684 then edit in appropriate substitutions for the @...@ constructs,
685 and then copy the shell commands near the end of `configure'
686 that run cpp to construct `Makefile'.
688 4) Create `Makefile' files in various other directories
689 from the corresponding `Makefile.in' files.  This isn't so hard,
690 just a matter of substitution.
692 The `configure' script is built from `configure.in' by the `autoconf'
693 program.  You need version 2.51 or newer of `autoconf' to rebuild
694 `configure'.
696 BUILDING GNU EMACS BY HAND
698 Once Emacs is configured, running `make' in the top directory performs
699 the following steps.
701 1) Run `make src/paths.h' in the top directory.  This produces
702 `./src/paths.h' from the template file `./src/paths.in', changing
703 the paths to the values specified in `./Makefile'.
705 2) Go to directory `./lib-src' and run `make'.  This creates
706 executables named `ctags' and `etags' and `wakeup' and `make-docfile'
707 and `digest-doc' and `test-distrib'.  And others.
709 3) Go to directory `./src' and Run `make'.  This refers to files in
710 the `./lisp' and `./lib-src' subdirectories using names `../lisp' and
711 `../lib-src'.
713 This creates a file `./src/emacs' which is the runnable Emacs,
714 which has another name that contains a version number.
715 Each time you do this, that version number increments in the last place.
717 It also creates a file in `./etc' whose name is `DOC' followed by the
718 current Emacs version.  This file contains documentation strings for
719 all the functions in Emacs.  Each time you run make to make a new
720 emacs, a new DOC file with a new name is made.  You must keep the DOC
721 file for an Emacs version as long as you keep using that Emacs
722 version.
725 INSTALLATION BY HAND
727 The steps below are done by running `make install' in the main
728 directory of the Emacs distribution.
730 1) Copy `./lisp' and its subdirectories, `./etc', and the executables
731 in `./lib-src' to their final destinations, as selected in `./src/paths.h'.
733 Strictly speaking, not all of the executables in `./lib-src' need be copied.
734 - The programs `cvtmail', `fakemail', `hexl',
735     `movemail', `profile', `rcs2log', `timer', `vcdiff', `wakeup',
736     and `yow' are used by Emacs; they do need to be copied.
737 - The programs `etags', `ctags', `emacsclient', `b2m', and `rcs-checkin'
738     are intended to be run by users; they are handled below.
739 - The programs `make-docfile' and `test-distrib' were
740     used in building Emacs, and are not needed any more.
741 - The programs `digest-doc' and `sorted-doc' convert a `DOC' file into
742     a file for users to read.  There is no important reason to move them.
744 2) Copy the files in `./info' to the place specified in
745 `./lisp/site-init.el' or `./lisp/paths.el'.  Note that if the
746 destination directory already contains a file named `dir', you
747 probably don't want to replace it with the `dir' file in the Emacs
748 distribution.  Instead, you should make sure that the existing `dir'
749 file contains an appropriate menu entry for the Emacs info.
751 3) Copy `./src/emacs' to `/usr/local/bin', or to some other directory
752 in users' search paths.  `./src/emacs' has an alternate name
753 `./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named
754 `/usr/local/bin/emacs' pointing to that alternate name, as an easy way
755 of installing different versions.
757 You can delete `./src/temacs'.
759 4) Copy the programs `b2m', `emacsclient', `ctags', `etags', and
760 `rcs-checkin' from `./lib-src' to `/usr/local/bin'.  These programs are
761 intended for users to run.
763 5) Copy the man pages in `./etc' for emacs, ctags, and etags into the
764 appropriate man directories.
766 6) The files in the `./src' subdirectory, except for `emacs', are not
767 used by Emacs once it is built.  However, it is very desirable to keep
768 the source on line for debugging.
771 PROBLEMS
773 See the file PROBLEMS in etc subdirectory for a list of various
774 problems sometimes encountered, and what to do about them.
777 Installation on MSDOG (a.k.a. MSDOS)
779 To install on MSDOG, you need to have the GNU C compiler for MSDOG
780 (also known as djgpp), GNU Make, rm, mv, and sed.  See the remarks in
781 config.bat for more information about locations and versions.  The
782 file etc/FAQ includes pointers to Internet sites where you can find
783 the necessary utilities; search for "MS-DOS".  The configuration step
784 (see below) will test for these utilities and will refuse to continue
785 if any of them isn't found.
787 Recompiling Lisp files in the `lisp' subdirectory using the various
788 targets in the lisp/Makefile file requires additional utilities:
789 `find' and `xargs' (from Findutils), `touch' (from Fileutils) GNU
790 `echo' and `test' (from Sh-utils), `tr, `sort', and `uniq' (from
791 Textutils), and a port of Bash.  However, you should not normally need
792 to run lisp/Makefile, as all the Lisp files are distributed in
793 byte-compiled form as well.
795 If you are building the MSDOG version of Emacs on an MSDOG-like system
796 which supports long file names (e.g. Windows 95), you need to make
797 sure that long file names are handled consistently both when you
798 unpack the distribution and compile it.  If you intend to compile with
799 DJGPP v2.0 or later, and long file names support is enabled (LFN=y in
800 the environment), you need to unpack Emacs distribution in a way that
801 doesn't truncate the original long filenames to the DOS 8.3 namespace;
802 the easiest way to do this is to use djtar program which comes with
803 DJGPP, since it will note the LFN setting and behave accordingly.
804 DJGPP v1 doesn't support long filenames, so you must unpack Emacs with
805 a program that truncates the filenames to 8.3 naming as it extracts
806 files; again, using djtar after setting LFN=n is the recommended way.
807 You can build Emacs with LFN=n even if you use DJGPP v2, if some of
808 your tools don't support long file names: just ensure that LFN is set
809 to `n' during both unpacking and compiling.
811 (By the time you read this, you have already unpacked the Emacs
812 distribution, but if the explanations above imply that you should have
813 done it differently, it's safer to delete the directory tree created
814 by the unpacking program and unpack Emacs again, than to risk running
815 into problems during the build process.)
817 It is important to understand that the runtime support of long file
818 names by the Emacs binary is NOT affected by the LFN setting during
819 compilation; Emacs compiled with DJGPP v2.0 or later will always
820 support long file names on Windows 9X no matter what was the setting
821 of LFN at compile time.  However, if you compiled with LFN disabled
822 and want to enable LFN support after Emacs was already built, you need
823 to make sure that the support files in the lisp, etc and info
824 directories are called by their original long names as found in the
825 distribution.  You can do this either by renaming the files manually,
826 or by extracting them from the original distribution archive with
827 djtar after you set LFN=y in the environment.
829 To unpack Emacs with djtar, type this command:
831     djtar -x emacs.tgz
833 (This assumes that the Emacs distribution is called `emacs.tgz' on
834 your system.)
836 If you want to print international characters, install the intlfonts
837 distribution.  For this, create a directory called `fonts' under the
838 Emacs top-level directory (usually called `emacs-XX.YY') created by
839 unpacking emacs.tgz, chdir into the directory emacs-XX.YY/fonts, and
840 type this:
842     djtar -x intlfonts.tgz
844 When unpacking is done, a directory called `emacs-XX.YY' will be
845 created, where XX.YY is the Emacs version.  To build and install
846 Emacs, chdir to that directory and type these commands:
848     config msdos
849     make install
851 Running "config msdos" checks for several programs that are required
852 to configure and build Emacs; if one of those programs is not found,
853 CONFIG.BAT stops and prints an error message.  If you have DJGPP
854 version 2.0 or 2.01, it will complain about a program called
855 DJECHO.EXE.  These old versions of DJGPP shipped that program under
856 the name ECHO.EXE, so you can simply copy ECHO.EXE to DJECHO.EXE and
857 rerun CONFIG.BAT.  If you have neither ECHO.EXE nor DJECHO.EXE, you
858 should be able to find them in your djdevNNN.zip archive (where NNN is
859 the DJGPP version number).
861 On Windows NT or Windows 2000, running "config msdos" might print an
862 error message like "VDM has been already loaded".  This is because
863 those systems have a program called `redir.exe' which is incompatible
864 with a program by the same name supplied with DJGPP, which is used by
865 config.bat.  To resolve this, move the DJGPP's `bin' subdirectory to
866 the front of your PATH environment variable.
868 To install the international fonts, chdir to the intlfonts-X.Y
869 directory created when you unpacked the intlfonts distribution (X.Y is
870 the version number of the fonts' distribution), and type the following
871 command:
873     make bdf INSTALLDIR=..
875 After Make finishes, you may remove the directory intlfonts-X.Y; the
876 fonts are installed into the fonts/bdf subdirectory of the top-level
877 Emacs directory, and that is where Emacs will look for them by
878 default.
880 Building Emacs creates executable files in the src and lib-src
881 directories.  Installing Emacs on MSDOS moves these executables to a
882 sibling directory called bin.  For example, if you build in directory
883 /emacs, installing moves the executables from /emacs/src and
884 /emacs/lib-src to the directory /emacs/bin, so you can then delete the
885 subdirectories /emacs/src and /emacs/lib-src if you wish.  The only
886 subdirectories you need to keep are bin, lisp, etc and info.  (If you
887 installed intlfonts, keep the fonts directory and all its
888 subdirectories as well.)  The bin subdirectory should be added to your
889 PATH.  The msdos subdirectory includes a PIF and an icon file for
890 Emacs which you might find useful if you run Emacs under MS Windows.
892 Emacs on MSDOS finds the lisp, etc and info directories by looking in
893 ../lisp, ../etc and ../info, starting from the directory where the
894 Emacs executable was run from.  You can override this by setting the
895 environment variables EMACSDATA (for the location of `etc' directory),
896 EMACSLOADPATH (for the location of `lisp' directory) and INFOPATH (for
897 the location of the `info' directory).
899 MSDOG is a not a multitasking operating system, so Emacs features such
900 as asynchronous subprocesses that depend on multitasking will not
901 work.  Synchronous subprocesses do work.
903 Version 2.0 of djgpp has two bugs that affect Emacs.  We've included
904 corrected versions of two files from djgpp in the msdos subdirectory:
905 is_exec.c and sigaction.c.  To work around the bugs, compile these
906 files and link them into temacs.  Djgpp versions 2.01 and later have
907 these bugs fixed, so upgrade if you can before building Emacs.
909 This file is part of GNU Emacs.
911 GNU Emacs is free software; you can redistribute it and/or modify
912 it under the terms of the GNU General Public License as published by
913 the Free Software Foundation; either version 2, or (at your option)
914 any later version.
916 GNU Emacs is distributed in the hope that it will be useful,
917 but WITHOUT ANY WARRANTY; without even the implied warranty of
918 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
919 GNU General Public License for more details.
921 You should have received a copy of the GNU General Public License
922 along with GNU Emacs; see the file COPYING.  If not, write to the
923 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
924 Boston, MA 02110-1301, USA.