INSTALL 40.8 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
GNU Emacs Installation Guide
2
Copyright (c) 1992, 1994, 1996, 1997, 2000 Free software Foundation, Inc.
3
See the end of the file for copying permissions.
Jim Blandy's avatar
Jim Blandy committed
4 5


6 7 8 9 10 11 12
BASIC INSTALLATION

The simplest way to build Emacs is to use the `configure' shell script
which attempts to guess correct values for various system-dependent
variables and features and find the directories where various system
headers and libraries are kept.  It then creates a `Makefile' in each
subdirectory and a `config.h' file containing system-dependent
13
definitions.  Running the `make' utility then builds the package for
14 15 16 17
your system.

Here's the procedure to build Emacs using `configure' on systems which
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 20 21 22 23 24
doesn't work, you might need to use various non-default options, and
maybe perform some of the steps manually.  The more detailed
description in the rest of the sections of this guide will help you do
that, so please refer to them if the simple procedure does not work.

  1. If you want to be able to input international characters which
25
     your keyboard doesn't support directly (i.e. you cannot type
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
     them at the shell prompt), download the leim-M.N.tar.gz
     distribution and unpack it into the same directory where you have
     unpacked the main Emacs distribution.  See ADDITIONAL
     DISTRIBUTION FILES, below, for more about this.

  2. Make sure your system has at least 120 MB of free disk space.

  3a. `cd' to the directory where you unpacked Emacs and invoke the
      `configure' script:

		 ./configure

  3b. Alternatively, create a separate directory, outside the source
      directory, where you want to build Emacs, and invoke `configure'
      from there:

		 SOURCE-DIR/configure

44 45
      where SOURCE-DIR is the top-level Emacs source directory.  This
      may not work unless you use GNU make.
46 47 48 49 50 51 52 53 54 55 56 57 58

  4. When `configure' finishes, it prints several lines of details
     about the system configuration.  Read those details carefully
     looking for anything suspicious, such as wrong CPU and operating
     system names, wrong places for headers or libraries, missing
     libraries that you know are installed on your system, etc.

     If you find anything wrong, you will have to pass to `configure'
     explicit machine configuration name, and one or more options
     which tell it where to find various headers and libraries; refer
     to DETAILED BUILDING AND INSTALLATION section below.

     If `configure' didn't find some image support libraries, such as
59 60
     Xpm, jpeg, etc., and you want to use them refer to the subsection
     "Image support libraries", below.
61 62 63 64 65 66 67 68 69 70 71

     If the details printed by `configure' don't make any sense to
     you, assume that `configure' did its job and proceed.

  5. If you need to run the `configure' script more than once (e.g.,
     with some non-default options), always clean the source
     directories before running `configure' again:

		make distclean 
		./configure

72
  6. Invoke the `make' program:
73 74 75

		 make

76 77 78
  7. If `make' succeeds, it will build an executable program `emacs'
     in the `src' directory.  You can try this program, to make sure
     it works:
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93

		 src/emacs -q

  8. Assuming that the program `src/emacs' starts and displays its
     opening screen, you can install the program and its auxiliary
     files into their installation directories:

		 make install

  You are now ready to use Emacs.  If you wish to conserve disk space,
  you may remove the program binaries and object files from the
  directory where you built Emacs:

		 make clean

94 95 96 97
  You can also save some space by compressing (with `gzip') Info files
  and installed Lisp source (.el) files which have corresponding .elc
  versions.

Jim Blandy's avatar
Jim Blandy committed
98

99 100 101 102 103
ADDITIONAL DISTRIBUTION FILES

* leim-M.N.tar.gz

The Emacs Lisp code for input methods for various international
104 105 106 107 108 109
character scripts allows you to input characters in scripts which are
not directly supported by your keyboard. It is distributed in a
separate tar file because it amounts to a significant fraction of the
size of the distribution.  This tar file is called leim-M.N.tar.gz,
with the same version number as Emacs, and it unpacks into the
directory emacs-M.N/leim.
Karl Heuer's avatar
Karl Heuer committed
110 111 112 113 114 115 116 117 118 119

You should unpack leim-M.N.tar.gz into the same directory where you
have previously unpacked the main Emacs distribution.  It fills in the
contents of one subdirectory, which is present in the main Emacs
distribution only in dummy form.

Once you have unpacked the Leim tar file into the Emacs source tree,
building and installing Emacs automatically installs the input method
support as well.  If you have built Emacs without unpacking Leim
first, just unpack Leim, build Emacs again, and install it again.
120 121 122 123 124 125

* intlfonts-VERSION.tar.gz

The intlfonts distribution contains X11 fonts that Emacs needs in
order to display international characters.  If you see a non-ASCII
character appear as a hollow box, that means you don't have a font for
126 127 128 129
it.  You might find a font in the intlfonts distribution.  If you do
have a font for a non-ASCII character, but some characters don't look
right, or appear improperly aligned, a font from the intlfonts
distribution might look better.
130

131 132
The fonts in the intlfonts distribution are also used by the ps-print
package for printing international characters.  The file
133
lisp/ps-mule.el defines the *.bdf font files required for printing
134 135
each character set.

136 137
The intlfonts distribution contains its own installation instructions,
in the intlfonts/README file.
138

139 140 141
* elisp-manual-M.N.tar.gz

This distribution contains the Emacs Lisp Reference Manual which
142 143 144 145 146 147
complements the Emacs Manual.  (The Emacs Manual is accessible from
within the editor by typing "C-h i", then selecting the "Emacs" item
from the menu, or by clicking "Help" in the menu bar and selecting
"Read Emacs Manual".)  It is a good idea to install the Emacs Lisp
Reference Manual after installing Emacs, to complete the on-line
documentation of Emacs in Info.
148 149

If you have installed Texinfo, you can install the Emacs Lisp
150 151
Reference Manual this way (after unpacking the elisp-manual-M.N.tar.gz
file):
152 153 154 155 156 157 158 159 160 161 162

     cd elisp-manual-M.N
     ./configure --prefix=PREFIXDIR
     make install

Otherwise, you can install it manually.  Just copy the files elisp and
elisp-* from the elisp-manual-M.N directory to your site's info
directory (see the description of `infodir', below), and make sure
that file `dir' in this directory contains an entry like this:

    * Elisp: (elisp).	The Emacs Lisp Reference Manual.
Gerd Moellmann's avatar
Gerd Moellmann committed
163

164 165 166
* Image support libraries

Emacs needs optional libraries to be able to display images (with the
167 168 169 170 171 172 173
exception of PBM and XBM images whose support is built-in).

On some systems, particularly on GNU/Linux, these libraries may
already be present or available as additional packages.  If not, you
can download and build them from sources.  None of them are vital for
running Emacs; however, note that Emacs will not be able to use color
icons in the toolbar if the XPM support is not available.
174

175 176
Here's the list of these optional libraries, and the URLs where they
can be found:
177

178 179
  . libXaw3d for fancy 3D-style 
      scroll bars:    ftp://ftp.x.org/contrib/widgets/Xaw3d/
180 181
  . libxpm for XPM:   ftp://ftp.x.org/contrib/libraries/
  . libpng for PNG:   ftp://www.libpng.org/pub/png/
182
  . libz (for PNG):   http://www.info-zip.org/pub/infozip/zlib/
183
  . libjpeg for JPEG: ftp://ftp.uu.net/graphics/jpeg/
Dave Love's avatar
Dave Love committed
184 185
                      Get version 6b -- 6a is reported to fail in
                      Emacs.
186 187 188
  . libtiff for TIFF: http://www.libtiff.org/
  . libungif for GIF: 
      http://prtr-13.ucsc.edu/~badger/software/libungif/index.shtml
Dave Love's avatar
Dave Love committed
189 190
      Ensure you get version 4.1.0b1 or higher of libungif -- a bug in
      4.1.0 can crash Emacs.
Dave Love's avatar
Dave Love committed
191

192 193 194 195 196 197
Emacs will configure itself to build with these libraries if the
`configure' script finds them on your system, unless you supply the
appropriate --without-LIB option.  In some cases, older versions of
these libraries won't work because some routines are missing, and
configure should avoid such old versions.  If that happens, use the
--without-LIB options to `configure'.  See below for more details.
198

Dave Love's avatar
Dave Love committed
199 200 201 202 203 204 205 206 207 208 209 210 211 212
* Extra fonts

To take proper advantage of Emacs 21's mule-unicode charsets, you need
a Unicode font.  For information on Unicode fonts for X, see
<URL:http://czyborra.com/unifont/> and
<URL:http://www.cl.cam.ac.uk/%7Emgk25/ucs-fonts.html>.
<URL:http://czyborra.com/charsets/> has basic fonts for Emacs's
ISO-8859 charsets.

XFree86 release 4 (from <URL:ftp://ftp.xfree86.org/> and mirrors)
contains font support for most, if not all, of the charsets that Emacs
supports.  The font files should be usable separately with older X
releases.

213

214
DETAILED BUILDING AND INSTALLATION:
215

216 217 218 219
(This is for a Unix or Unix-like system.  For MS-DOS and Windows 3.X,
see below; search for MSDOG.  For Windows 9X, Windows ME, Windows NT,
and Windows 2000, see the file nt/INSTALL.  For the Mac, see the file
mac/INSTALL.)
Jim Blandy's avatar
Jim Blandy committed
220 221

1) Make sure your system has enough swapping space allocated to handle
Gerd Moellmann's avatar
Gerd Moellmann committed
222 223
a program whose pure code is 1.5 MB and whose data area is at
least 2.5 MB and can reach 80 MB or more.  If the swapping space is
Jim Blandy's avatar
Jim Blandy committed
224
insufficient, you will get an error in the command `temacs -batch -l
225
loadup dump', found in `./src/Makefile.in', or possibly when
Richard M. Stallman's avatar
Richard M. Stallman committed
226
running the final dumped Emacs.
Jim Blandy's avatar
Jim Blandy committed
227
 
Gerd Moellmann's avatar
Gerd Moellmann committed
228 229 230 231 232 233
Building Emacs requires about 95 MB of disk space (including the Emacs
sources), or 130 MB if Leim is used.  Once installed, Emacs occupies
about 60 MB (70 MB with Leim) in the file system where it is
installed; this includes the executable files, Lisp libraries,
miscellaneous data files, and on-line documentation.  If the building
and installation take place in different directories, then the
234
installation procedure momentarily requires 95+60 MB (130+70 MB).
Jim Blandy's avatar
Jim Blandy committed
235 236

2) Consult `./etc/MACHINES' to see what configuration name you should
237
give to the `configure' program.  That file offers hints for
238 239 240 241
getting around some possible installation problems.  The file lists
many different configurations, but only the part for your machine and
operating system is relevant.  (The list is arranged in alphabetical
order by the vendor name.)
Jim Blandy's avatar
Jim Blandy committed
242

243 244 245 246 247
3) You can build Emacs in the top-level Emacs source directory
or in a separate directory.

3a) To build in the top-level Emacs source directory, go to that
directory and run the program `configure' as follows:
Jim Blandy's avatar
Jim Blandy committed
248

249
    ./configure [CONFIGURATION-NAME] [--OPTION[=VALUE]] ...
Jim Blandy's avatar
Jim Blandy committed
250 251

The CONFIGURATION-NAME argument should be a configuration name given
252 253 254 255 256 257
in `./etc/MACHINES', with the system version number added at the end.

You should try first omitting CONFIGURATION-NAME.  This way,
`configure' will try to guess your system type.  If it cannot guess,
or if something goes wrong in building or installing Emacs this way,
try again specifying the proper CONFIGURATION-NAME explicitly.
Jim Blandy's avatar
Jim Blandy committed
258

259 260 261
If you don't want X support, specify `--with-x=no'.  If you omit this
option, `configure' will try to figure out for itself whether your
system has X, and arrange to use it if present.
Jim Blandy's avatar
Jim Blandy committed
262 263 264

The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build
process where the compiler should look for the include files and
265 266
object libraries used with the X Window System.  Normally, `configure'
is able to find them; these options are necessary if you have your X
267 268
Window System files installed in unusual places.  These options also
accept a list of directories, separated with colons.
Jim Blandy's avatar
Jim Blandy committed
269

270 271 272 273
To get more attractive menus, you can specify an X toolkit when you
configure Emacs; use the option `--with-x-toolkit=TOOLKIT', where
TOOLKIT is `athena' or `motif' (`yes' and `lucid' are synonyms for
`athena').  On some systems, it does not work to use a toolkit with
274
shared libraries.  A free implementation of Motif, called LessTif, is
275 276 277 278
available ftom <http://www.lesstif.org>.  Compiling with LessTif or
Motif causes a standard File Selection Dialog to pop up when you type
"C-x C-f" and similar commands.  You can get fancy 3D-style scroll
bars, even without LessTif/Motif, if you have the Xaw3d library
279 280
installed (see "Image support libraries" above for Xaw3d
availability).
Jim Blandy's avatar
Jim Blandy committed
281 282 283

The `--with-gcc' option specifies that the build process should
compile Emacs using GCC.  If you don't want to use GCC, specify
284 285
`--with-gcc=no'.  If you omit this option, `configure' will search
for GCC in your path, and use it if present.
Jim Blandy's avatar
Jim Blandy committed
286

287 288 289 290 291 292
The Emacs mail reader RMAIL is configured to be able to read mail from
a POP3 server by default.  Versions of the POP protocol older than
POP3 are not supported.  For Kerberos-authenticated POP add
`--with-kerberos', for Hesiod support add `--with-hesiod'.  While POP3
is always enabled, whether Emacs actually uses POP is controlled by
individual users--see the Rmail chapter of the Emacs manual.
293

294 295 296 297
For image support you may have to download, build, and install the
appropriate image support libraries for image types other than XBM and
PBM, see the list of URLs in "ADDITIONAL DISTRIBUTION FILES" above.
(Note that PNG support requires libz in addition to libpng.)
298

299 300 301
To disable individual types of image support in Emacs for some reason,
even though configure finds the libraries, you can configure with one
or more of these options:
302

303 304 305 306 307
  --without-xpm        for XPM image support
  --without-jpeg       for JPEG image support
  --without-tiff       for TIFF image support
  --without-gif        for GIF image support
  --without-png        for PNG image support
308

309 310 311 312 313
Use --without-toolkit-scroll-bars to disable LessTif/Motif or Xaw3d
scroll bars.  --without-xim disables the use of X Input Methods, and
--disable-largefile omits support for files larger than 2GB on systems
which support that.

Jim Blandy's avatar
Jim Blandy committed
314 315 316 317
The `--prefix=PREFIXDIR' option specifies where the installation process
should put emacs and its data files.  This defaults to `/usr/local'.
- Emacs (and the other utilities users run) go in PREFIXDIR/bin
  (unless the `--exec-prefix' option says otherwise).
318 319
- The architecture-independent files go in PREFIXDIR/share/emacs/VERSION
  (where VERSION is the version number of Emacs, like `19.27').
Jim Blandy's avatar
Jim Blandy committed
320
- The architecture-dependent files go in
321
  PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION
Jim Blandy's avatar
Jim Blandy committed
322 323 324 325 326 327 328 329
  (where CONFIGURATION is the configuration name, like mips-dec-ultrix4.2),
  unless the `--exec-prefix' option says otherwise.

The `--exec-prefix=EXECDIR' option allows you to specify a separate
portion of the directory tree for installing architecture-specific
files, like executables and utility programs.  If specified,
- Emacs (and the other utilities users run) go in EXECDIR/bin, and
- The architecture-dependent files go in
330
  EXECDIR/libexec/emacs/VERSION/CONFIGURATION.
Jim Blandy's avatar
Jim Blandy committed
331 332 333 334 335 336 337 338 339
EXECDIR/bin should be a directory that is normally in users' PATHs.

For example, the command

    ./configure mips-dec-ultrix --with-x11

configures Emacs to build for a DECstation running Ultrix, with
support for the X11 window system.

340
`configure' doesn't do any compilation or installation
Jim Blandy's avatar
Jim Blandy committed
341
itself.  It just creates the files that influence those things:
David J. MacKenzie's avatar
David J. MacKenzie committed
342 343 344 345
`./Makefile', `lib-src/Makefile', `oldXMenu/Makefile',
`lwlib/Makefile', `src/Makefile', and `./src/config.h'.  For details
on exactly what it does, see the section called `CONFIGURATION BY
HAND', below.
Jim Blandy's avatar
Jim Blandy committed
346 347

When it is done, `configure' prints a description of what it did and
348 349 350 351 352 353 354 355 356
creates a shell script `config.status' which, when run, recreates the
same configuration.  If `configure' exits with an error after
disturbing the status quo, it removes `config.status'.  `configure'
also creates a file `config.cache' that saves the results of its tests
to make reconfiguring faster, and a file `config.log' containing compiler
output (useful mainly for debugging `configure').  You can give
`configure' the option `--cache-file=FILE' to use the results of the
tests in FILE instead of `config.cache'.  Set FILE to `/dev/null' to
disable caching, for debugging `configure'.
Jim Blandy's avatar
Jim Blandy committed
357

358 359 360 361 362 363 364 365 366 367
If the description of the system configuration printed by `configure'
is not right, or if it claims some of the fatures or libraries are not
available when you know they are, look at the `config.log' file for
the trace of the failed tests performed by `configure' to check
whether these features are supported.  Typically, some test fails
because the compiler cannot find some function in the system
libraries, or some macro-processor definition in the system headers.

Some tests might fail because the compiler should look in special
directories for some header files, or link against optional
Eli Zaretskii's avatar
Eli Zaretskii committed
368
libraries, or use special compilation options.  You can force
369 370 371 372 373 374 375
`configure' and the build process which follows it to do that by
setting the variables CPPFLAGS, CFLAGS, LDFLAGS, LIBS, and CC before
running `configure'.  CPPFLAGS lists the options passed to the
preprocessor, CFLAGS are compilation options, LDFLAGS are options used
when linking, LIBS are libraries to link against, and CC is the
command which invokes the compiler.

376 377
Here's an example of a `configure' invocation, assuming a Bourne-like
shell such as Bash, which uses these variables:
378 379 380 381 382 383 384 385 386 387 388

 CPPFLAGS='-I/foo/myinclude' LDFLAGS='-L/bar/mylib' \
  CFLAGS='-O3' LIBS='-lfoo -lbar' ./configure

(this is all one long line).  This tells `configure' to instruct the
preprocessor to look in the `/foo/myinclude' directory for header
files (in addition to the standard directories), instruct the linker
to look in `/bar/mylib' for libraries, pass the -O3 optimization
switch to the compiler, and link against libfoo.a and libbar.a
libraries in addition to the standard ones.

Jim Blandy's avatar
Jim Blandy committed
389
The work of `configure' can be done by editing various files in the
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
distribution, but using `configure' is easier.  See the section called
"CONFIGURATION BY HAND" below if you want to do the configuration
yourself.

3b) To build in a separate directory, go to that directory
and run the program `configure' as follows:

    SOURCE-DIR/configure CONFIGURATION-NAME [--OPTION[=VALUE]] ...

SOURCE-DIR refers to the top-level Emacs source directory which is
where Emacs's configure script is located.  `configure' looks for the
Emacs source code in the directory that `configure' is in.

To build in a separate directory, you must use a version of `make'
that supports the `VPATH' variable, such as GNU `make'.
Jim Blandy's avatar
Jim Blandy committed
405

Richard M. Stallman's avatar
Richard M. Stallman committed
406 407
3c) Some people try to build in a separate directory by filling
it full of symlinks to the files in the real source directory.
408 409 410 411 412 413 414
If you do that, `make all' does work, but `make install' fails:
it copies the symbolic links rather than the actual files.

As far as is known, there is no particular reason to use
a directory full of links rather than use the standard GNU
facilities to build in a separate directory (see 3b above).

Jim Blandy's avatar
Jim Blandy committed
415
4) Look at `./lisp/paths.el'; if some of those values are not right
Karl Heuer's avatar
Karl Heuer committed
416 417
for your system, set up the file `./lisp/site-init.el' with Emacs
Lisp code to override them; it is not a good idea to edit paths.el
Jim Blandy's avatar
Jim Blandy committed
418 419 420 421 422 423 424 425
itself.  YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES,
rather than `defvar', as used by `./lisp/paths.el'.  For example,

     (setq news-inews-program "/usr/bin/inews")

is how you would override the default value of the variable
news-inews-program (which is "/usr/local/inews").

426 427 428 429 430
Before you override a variable this way, *look at the value* that the
variable gets by default!  Make sure you know what kind of value the
variable should have.  If you don't pay attention to what you are
doing, you'll make a mistake.

Richard M. Stallman's avatar
Richard M. Stallman committed
431 432 433 434
5) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs
Lisp code you want Emacs to load before it is dumped out.  Use
site-load.el for additional libraries if you arrange for their
documentation strings to be in the etc/DOC file (see
435
src/Makefile.in if you wish to figure out how to do that).  For all
436 437
else, use site-init.el.  Do not load byte-compiled code which
was build with a non-nil value of `byte-compile-dynamic'.
Jim Blandy's avatar
Jim Blandy committed
438

439 440 441
If you set load-path to a different value in site-init.el or
site-load.el, Emacs will use *precisely* that value when it starts up
again.  If you do this, you are on your own!
442

Jim Blandy's avatar
Jim Blandy committed
443 444 445
Note that, on some systems, the code you place in site-init.el must
not use expand-file-name or any other function which may look
something up in the system's password and user information database.
446
See `./etc/PROBLEMS' for more details on which systems this affects.
Jim Blandy's avatar
Jim Blandy committed
447

Richard M. Stallman's avatar
Richard M. Stallman committed
448 449
The `site-*.el' files are nonexistent in the distribution.  You do not
need to create them if you have nothing to put in them.
Jim Blandy's avatar
Jim Blandy committed
450 451 452 453 454 455 456

6) Refer to the file `./etc/TERMS' for information on fields you may
wish to add to various termcap entries.  The files `./etc/termcap.ucb'
and `./etc/termcap.dat' may already contain appropriately-modified
entries.

7) Run `make' in the top directory of the Emacs distribution to finish
457 458 459 460 461 462 463 464
building Emacs in the standard way.  The final executable file is
named `src/emacs'.  You can execute this file "in place" without
copying it, if you wish; then it automatically uses the sibling
directories ../lisp, ../lib-src, ../info.

Or you can "install" the executable and the other Emacs into their
installed locations, with `make install'.  By default, Emacs's files
are installed in the following directories:
Jim Blandy's avatar
Jim Blandy committed
465 466

`/usr/local/bin' holds the executable programs users normally run -
Richard M. Stallman's avatar
Richard M. Stallman committed
467 468
		`emacs', `etags', `ctags', `b2m', `emacsclient',
		and `rcs-checkin'.
Jim Blandy's avatar
Jim Blandy committed
469

470
`/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library;
Jim Blandy's avatar
Jim Blandy committed
471
		`VERSION' stands for the number of the Emacs version
472
		you are installing, like `18.59' or `19.27'.  Since the
473
		Lisp library changes from one version of Emacs to
Jim Blandy's avatar
Jim Blandy committed
474 475
		another, including the version number in the path
		allows you to have several versions of Emacs installed
476 477
		at the same time; in particular, you don't have to
		make Emacs unavailable while installing a new version.
Jim Blandy's avatar
Jim Blandy committed
478

479 480 481 482 483 484 485 486 487 488
`/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp
		files installed for Emacs version VERSION only.

`/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp
		files installed for all Emacs versions.

		When Emacs is installed, it searches for its Lisp files
		in `/usr/local/share/emacs/VERSION/site-lisp', then in
		`/usr/local/share/emacs/site-lisp', and finally in
		`/usr/local/share/emacs/VERSION/lisp'.
Jim Blandy's avatar
Jim Blandy committed
489

490
`/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
Jim Blandy's avatar
Jim Blandy committed
491 492 493 494
		file, the `yow' database, and other
		architecture-independent files Emacs might need while
		running.  VERSION is as specified for `.../lisp'.

495
`/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable
Jim Blandy's avatar
Jim Blandy committed
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
		programs used by Emacs that users are not expected to
		run themselves.
		`VERSION' is the number of the Emacs version you are
		installing, and `CONFIGURATION-NAME' is the argument
		you gave to the `configure' program to identify the
		architecture and operating system of your machine,
		like `mips-dec-ultrix' or `sparc-sun-sunos'.  Since
		these files are specific to the version of Emacs,
		operating system, and architecture in use, including
		the configuration name in the path allows you to have
		several versions of Emacs for any mix of machines and
		operating systems installed at the same time; this is
		useful for sites at which different kinds of machines
		share the file system Emacs is installed on.

`/usr/local/info' holds the on-line documentation for Emacs, known as
		"info files".  Many other GNU programs are documented
		using info files as well, so this directory stands
		apart from the other, Emacs-specific directories.

`/usr/local/man/man1' holds the man pages for the programs installed
		in `/usr/local/bin'.

If these directories are not what you want, you can specify where to
install Emacs's libraries and data files or where Emacs should search
521
for its Lisp files by giving values for `make' variables as part of
Jim Blandy's avatar
Jim Blandy committed
522 523 524 525 526 527 528
the command.  See the section below called `MAKE VARIABLES' for more
information on this.

8) Check the file `dir' in your site's info directory (usually
/usr/local/info) to make sure that it has a menu entry for the Emacs
info files.

Richard M. Stallman's avatar
Richard M. Stallman committed
529
9) If your system uses lock files to interlock access to mailer inbox files,
530
then you might need to make the movemail program setuid or setgid
Richard M. Stallman's avatar
Richard M. Stallman committed
531 532
to enable it to write the lock files.  We believe this is safe.

Karl Heuer's avatar
Karl Heuer committed
533 534 535
10) You are done!  You can remove executables and object files from
the build directory by typing `make clean'.  To also remove the files
that `configure' created (so you can compile Emacs for a different
536 537 538 539 540
configuration), type `make distclean'.  If you don't need some, or all
of the input methods from the Leim package, you can remove the
unneeded files in the leim/quail, leim/skk, and leim/skk-dic
subdirectories of your site's lisp directory (usually
/usr/local/share/emacs/VERSION/).
Karl Heuer's avatar
Karl Heuer committed
541

Jim Blandy's avatar
Jim Blandy committed
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562


MAKE VARIABLES

You can change where the build process installs Emacs and its data
files by specifying values for `make' variables as part of the `make'
command line.  For example, if you type

    make install bindir=/usr/local/gnubin

the `bindir=/usr/local/gnubin' argument indicates that the Emacs
executable files should go in `/usr/local/gnubin', not
`/usr/local/bin'.

Here is a complete list of the variables you may want to set.

`bindir' indicates where to put executable programs that users can
	run.  This defaults to /usr/local/bin.

`datadir' indicates where to put the architecture-independent
	read-only data files that Emacs refers to while it runs; it
David J. MacKenzie's avatar
David J. MacKenzie committed
563
	defaults to /usr/local/share.  We create the following
Jim Blandy's avatar
Jim Blandy committed
564
	subdirectories under `datadir':
565
	- `emacs/VERSION/lisp', containing the Emacs Lisp library, and
Jim Blandy's avatar
Jim Blandy committed
566 567 568 569 570 571 572 573 574
	- `emacs/VERSION/etc', containing the Emacs tutorial, the DOC
		file, and the `yow' database.
	`VERSION' is the number of the Emacs version you are installing,
	like `18.59' or `19.0'.  Since these files vary from one version
	of Emacs to another, including the version number in the path
	allows you to have several versions of Emacs installed at the
	same time; this means that you don't have to make Emacs
	unavailable while installing a new version.

David J. MacKenzie's avatar
David J. MacKenzie committed
575 576 577
`libexecdir' indicates where to put architecture-specific data files that
	Emacs refers to as it runs; it defaults to `/usr/local/libexec'.
	We create the following subdirectories under `libexecdir':
Jim Blandy's avatar
Jim Blandy committed
578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
	- `emacs/VERSION/CONFIGURATION-NAME', containing executable
		programs used by Emacs that users are not expected to run
		themselves.  
	`VERSION' is the number of the Emacs version you are installing,
	and `CONFIGURATION-NAME' is the argument you gave to the
	`configure' program to identify the architecture and operating
	system of your machine, like `mips-dec-ultrix' or
	`sparc-sun-sunos'.  Since these files are specific to the version
	of Emacs, operating system, and architecture in use, including
	the configuration name in the path allows you to have several
	versions of Emacs for any mix of machines and operating systems
	installed at the same time; this is useful for sites at which
	different kinds of machines share the file system Emacs is
	installed on.

`infodir' indicates where to put the info files distributed with
	Emacs; it defaults to `/usr/local/info'.

`mandir' indicates where to put the man pages for Emacs and its
	utilities (like `etags'); it defaults to
	`/usr/local/man/man1'.

`manext' gives the extension the man pages should be installed with.
	It should contain a period, followed by the appropriate
	digit.  It defaults to `.1'.  For example given the default
	values for `mandir' and `manext', the Emacs man page would be
	installed as `/usr/local/man/man1/emacs.1'.

`prefix' doesn't give a path for any specific part of Emacs; instead,
	its value is used to determine the defaults for all the
	architecture-independent path variables - `datadir',
David J. MacKenzie's avatar
David J. MacKenzie committed
609
	`sharedstatedir', `infodir', and `mandir'.  Its default value is
Jim Blandy's avatar
Jim Blandy committed
610 611 612 613 614 615 616 617 618 619 620 621 622
	`/usr/local'; the other variables add on `lib' or `man' to it
	by default.

	For example, suppose your site generally places GNU software
	under `/usr/users/software/gnusoft' instead of `/usr/local'.
	By including
	    `prefix=/usr/users/software/gnusoft'
	in the arguments to `make', you can instruct the build process
	to place all of the Emacs data files in the appropriate
	directories under that path.

`exec_prefix' serves the same purpose as `prefix', but instead
	determines the default values for the architecture-dependent
David J. MacKenzie's avatar
David J. MacKenzie committed
623
	path variables - `bindir' and `libexecdir'.
Jim Blandy's avatar
Jim Blandy committed
624 625

The above variables serve analogous purposes in the makefiles for all
626
GNU software; this variable is specific to Emacs.
Jim Blandy's avatar
Jim Blandy committed
627

Karl Heuer's avatar
Karl Heuer committed
628 629 630 631
`archlibdir' indicates where Emacs installs and expects the executable
	files and other architecture-dependent data it uses while
	running.  Its default value, based on `libexecdir' (which
	see), is `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME'
Jim Blandy's avatar
Jim Blandy committed
632 633 634 635 636 637 638 639 640 641
	(where VERSION and CONFIGURATION-NAME are as described above).

Remember that you must specify any variable values you need each time
you run `make' in the top directory.  If you run `make' once to build
emacs, test it, and then run `make' again to install the files, you
must provide the same variable settings each time.  To make the
settings persist, you can edit them into the `Makefile' in the top
directory, but be aware that running the `configure' program erases
`Makefile' and rebuilds it from `Makefile.in'.

642 643 644 645 646
The path for finding Lisp files is specified in src/paths.h,
a file which is generated by running configure.  To change the path,
you can edit the definition of PATH_LOADSEARCH in that file
before you run `make'.

Jim Blandy's avatar
Jim Blandy committed
647 648 649 650 651 652 653
The top-level Makefile stores the variable settings it used in the
Makefiles for the subdirectories, so you don't have to specify them
when running make in the subdirectories.


CONFIGURATION BY HAND

Richard M. Stallman's avatar
Richard M. Stallman committed
654 655
Instead of running the `configure' program, you have to perform the
following steps.
Jim Blandy's avatar
Jim Blandy committed
656

657
1) Copy `./src/config.in' to `./src/config.h'.
Jim Blandy's avatar
Jim Blandy committed
658 659 660 661 662 663 664 665 666 667 668 669 670 671

2) Consult `./etc/MACHINES' to see what configuration name you should
use for your system.  Look at the code of the `configure' script to
see which operating system and architecture description files from
`src/s' and `src/m' should be used for that configuration name.  Edit
`src/config.h', and change the two `#include' directives to include
the appropriate system and architecture description files.

2) Edit `./src/config.h' to set the right options for your system.  If
you need to override any of the definitions in the s/*.h and m/*.h
files for your system and machine, do so by editing config.h, not by
changing the s/*.h and m/*.h files.  Occasionally you may need to
redefine parameters used in `./lib-src/movemail.c'.

Richard M. Stallman's avatar
Richard M. Stallman committed
672
3) Create src/Makefile and lib-src/Makefile from the corresponding
673
`Makefile.in' files.  First copy `Makefile.in' to `Makefile.c',
Karl Heuer's avatar
Karl Heuer committed
674
then edit in appropriate substitutions for the @...@ constructs,
Richard M. Stallman's avatar
Richard M. Stallman committed
675 676
and then copy the shell commands near the end of `configure'
that run cpp to construct `Makefile'.
Jim Blandy's avatar
Jim Blandy committed
677

Richard M. Stallman's avatar
Richard M. Stallman committed
678 679 680
4) Create `Makefile' files in various other directories
from the corresponding `Makefile.in' files.  This isn't so hard,
just a matter of substitution.
Jim Blandy's avatar
Jim Blandy committed
681 682

The `configure' script is built from `configure.in' by the `autoconf'
Dave Love's avatar
Dave Love committed
683 684
program.  You need version 2.8 or newer of `autoconf' to rebuild
`configure'.
Jim Blandy's avatar
Jim Blandy committed
685 686 687

BUILDING GNU EMACS BY HAND

Richard M. Stallman's avatar
Richard M. Stallman committed
688 689
Once Emacs is configured, running `make' in the top directory performs
the following steps.
Jim Blandy's avatar
Jim Blandy committed
690 691

1) Run `make src/paths.h' in the top directory.  This produces
692
`./src/paths.h' from the template file `./src/paths.in', changing
Jim Blandy's avatar
Jim Blandy committed
693 694
the paths to the values specified in `./Makefile'.

Richard M. Stallman's avatar
Richard M. Stallman committed
695 696 697
2) Go to directory `./lib-src' and run `make'.  This creates
executables named `ctags' and `etags' and `wakeup' and `make-docfile'
and `digest-doc' and `test-distrib'.  And others.
Jim Blandy's avatar
Jim Blandy committed
698

Richard M. Stallman's avatar
Richard M. Stallman committed
699 700
3) Go to directory `./src' and Run `make'.  This refers to files in
the `./lisp' and `./lib-src' subdirectories using names `../lisp' and
Jim Blandy's avatar
Jim Blandy committed
701 702 703
`../lib-src'.

This creates a file `./src/emacs' which is the runnable Emacs,
Richard M. Stallman's avatar
Richard M. Stallman committed
704 705
which has another name that contains a version number.
Each time you do this, that version number increments in the last place.
Jim Blandy's avatar
Jim Blandy committed
706 707 708 709 710 711 712 713 714 715 716

It also creates a file in `./etc' whose name is `DOC' followed by the
current Emacs version.  This file contains documentation strings for
all the functions in Emacs.  Each time you run make to make a new
emacs, a new DOC file with a new name is made.  You must keep the DOC
file for an Emacs version as long as you keep using that Emacs
version.


INSTALLATION BY HAND

Richard M. Stallman's avatar
Richard M. Stallman committed
717 718
The steps below are done by running `make install' in the main
directory of the Emacs distribution.
Jim Blandy's avatar
Jim Blandy committed
719 720 721 722 723

1) Copy `./lisp' and its subdirectories, `./etc', and the executables
in `./lib-src' to their final destinations, as selected in `./src/paths.h'.

Strictly speaking, not all of the executables in `./lib-src' need be copied.
Richard M. Stallman's avatar
Richard M. Stallman committed
724
- The programs `cvtmail', `emacsserver', `fakemail', `hexl',
Richard M. Stallman's avatar
Richard M. Stallman committed
725 726 727
    `movemail', `profile', `rcs2log', `timer', `vcdiff', `wakeup',
    and `yow' are used by Emacs; they do need to be copied.
- The programs `etags', `ctags', `emacsclient', `b2m', and `rcs-checkin'
Jim Blandy's avatar
Jim Blandy committed
728
    are intended to be run by users; they are handled below.
David J. MacKenzie's avatar
David J. MacKenzie committed
729
- The programs `make-docfile' and `test-distrib' were
Jim Blandy's avatar
Jim Blandy committed
730 731 732 733 734 735 736 737 738 739 740
    used in building Emacs, and are not needed any more.
- The programs `digest-doc' and `sorted-doc' convert a `DOC' file into
    a file for users to read.  There is no important reason to move them.

2) Copy the files in `./info' to the place specified in
`./lisp/site-init.el' or `./lisp/paths.el'.  Note that if the
destination directory already contains a file named `dir', you
probably don't want to replace it with the `dir' file in the Emacs
distribution.  Instead, you should make sure that the existing `dir'
file contains an appropriate menu entry for the Emacs info.

Karl Heuer's avatar
Karl Heuer committed
741
3) Copy `./src/emacs' to `/usr/local/bin', or to some other directory
Jim Blandy's avatar
Jim Blandy committed
742 743 744 745 746 747 748
in users' search paths.  `./src/emacs' has an alternate name
`./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named
`/usr/local/bin/emacs' pointing to that alternate name, as an easy way
of installing different versions.

You can delete `./src/temacs'.

Karl Heuer's avatar
Karl Heuer committed
749
4) Copy the programs `b2m', `emacsclient', `ctags', `etags', and
Richard M. Stallman's avatar
Richard M. Stallman committed
750
`rcs-checkin' from `./lib-src' to `/usr/local/bin'.  These programs are
Jim Blandy's avatar
Jim Blandy committed
751 752
intended for users to run.

Karl Heuer's avatar
Karl Heuer committed
753
5) Copy the man pages in `./etc' for emacs, ctags, and etags into the
Jim Blandy's avatar
Jim Blandy committed
754 755
appropriate man directories.

Karl Heuer's avatar
Karl Heuer committed
756
6) The files in the `./src' subdirectory, except for `emacs', are not
Richard M. Stallman's avatar
Richard M. Stallman committed
757 758
used by Emacs once it is built.  However, it is very desirable to keep
the source on line for debugging.
Jim Blandy's avatar
Jim Blandy committed
759 760 761 762


PROBLEMS

763
See the file PROBLEMS in etc subdirectory for a list of various
Jim Blandy's avatar
Jim Blandy committed
764 765 766
problems sometimes encountered, and what to do about them.


Richard M. Stallman's avatar
Richard M. Stallman committed
767 768
Installation on MSDOG (a.k.a. MSDOS)

Richard M. Stallman's avatar
Richard M. Stallman committed
769
To install on MSDOG, you need to have the GNU C compiler for MSDOG
770 771 772 773 774 775 776
(also known as djgpp), GNU Make, rm, mv, and sed.  See the remarks in
config.bat for more information about locations and versions.  The
file etc/FAQ includes pointers to Internet sites where you can find
the necessary utilities; search for "MS-DOS".  The configuration step
(see below) will test for these utilities and will refuse to continue
if any of them isn't found.

777 778 779 780 781 782 783 784
Recompiling Lisp files in the `lisp' subdirectory using the various
targets in the lisp/Makefile file requires additional utilities:
`find' and `xargs' (from Findutils), `touch' (from Fileutils) GNU
`echo' and `test' (from Sh-utils), `tr, `sort', and `uniq' (from
Textutils), and a port of Bash.  However, you should not normally need
to run lisp/Makefile, as all the Lisp files are distributed in
byte-compiled form as well.

785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
If you are building the MSDOG version of Emacs on an MSDOG-like system
which supports long file names (e.g. Windows 95), you need to make
sure that long file names are handled consistently both when you
unpack the distribution and compile it.  If you intend to compile with
DJGPP v2.0 or later, and long file names support is enabled (LFN=y in
the environment), you need to unpack Emacs distribution in a way that
doesn't truncate the original long filenames to the DOS 8.3 namespace;
the easiest way to do this is to use djtar program which comes with
DJGPP, since it will note the LFN setting and behave accordingly.
DJGPP v1 doesn't support long filenames, so you must unpack Emacs with
a program that truncates the filenames to 8.3 naming as it extracts
files; again, using djtar after setting LFN=n is the recommended way.
You can build Emacs with LFN=n even if you use DJGPP v2, if some of
your tools don't support long file names: just ensure that LFN is set
to `n' during both unpacking and compiling.

(By the time you read this, you have already unpacked the Emacs
distribution, but if the explanations above imply that you should have
done it differently, it's safer to delete the directory tree created
by the unpacking program and unpack Emacs again, than to risk running
into problems during the build process.)

It is important to understand that the runtime support of long file
names by the Emacs binary is NOT affected by the LFN setting during
compilation; Emacs compiled with DJGPP v2.0 or later will always
810
support long file names on Windows 9X no matter what was the setting
811 812 813 814 815 816 817
of LFN at compile time.  However, if you compiled with LFN disabled
and want to enable LFN support after Emacs was already built, you need
to make sure that the support files in the lisp, etc and info
directories are called by their original long names as found in the
distribution.  You can do this either by renaming the files manually,
or by extracting them from the original distribution archive with
djtar after you set LFN=y in the environment.
818 819 820 821 822 823

To unpack Emacs with djtar, type this command:

    djtar -x emacs.tgz

(This assumes that the Emacs distribution is called `emacs.tgz' on
Richard M. Stallman's avatar
Richard M. Stallman committed
824
your system.)
825

826 827 828 829 830 831 832 833 834
If you need to type international characters, you will need to unpack
the Leim distribution (see the description near the beginning of this
file).  You unpack it from the same directory where you unpacked
Emacs.  To unpack Leim with djtar, assuming the Leim distribution is
called `leim.tgz', type this command:

    djtar -x leim.tgz

If you want to print international characters, install the intlfonts
835
distribution.  For this, create a directory called `fonts' under the
836 837 838 839 840 841
Emacs top-level directory (usually called `emacs-XX.YY') created by
unpacking emacs.tgz, chdir into the directory emacs-XX.YY/fonts, and
type this:

    djtar -x intlfonts.tgz

842 843 844
When unpacking is done, a directory called `emacs-XX.YY' will be
created, where XX.YY is the Emacs version.  To build and install
Emacs, chdir to that directory and type these commands:
Richard M. Stallman's avatar
Richard M. Stallman committed
845 846 847

    config msdos
    make install
Richard M. Stallman's avatar
Richard M. Stallman committed
848

849 850 851 852 853 854 855 856 857 858
Running "config msdos" checks for several programs that are required
to configure and build Emacs; if one of those programs is not found,
CONFIG.BAT stops and prints an error message.  If you have DJGPP
version 2.0 or 2.01, it will complain about a program called
DJECHO.EXE.  These old versions of DJGPP shipped that program under
the name ECHO.EXE, so you can simply copy ECHO.EXE to DJECHO.EXE and
rerun CONFIG.BAT.  If you have neither ECHO.EXE nor DJECHO.EXE, you
should be able to find them in your djdevNNN.zip archive (where NNN is
the DJGPP version number).

859 860 861 862 863 864 865 866 867 868 869 870
To install the international fonts, chdir to the intlfonts-X.Y
directory created when you unpacked the intlfonts distribution (X.Y is
the version number of the fonts' distribution), and type the following
command:

    make bdf INSTALLDIR=..

After Make finishes, you may remove the directory intlfonts-X.Y; the
fonts are installed into the fonts/bdf subdirectory of the top-level
Emacs directory, and that is where Emacs will look for them by
default.

871 872 873 874 875 876
Building Emacs creates executable files in the src and lib-src
directories.  Installing Emacs on MSDOS moves these executables to a
sibling directory called bin.  For example, if you build in directory
/emacs, installing moves the executables from /emacs/src and
/emacs/lib-src to the directory /emacs/bin, so you can then delete the
subdirectories /emacs/src and /emacs/lib-src if you wish.  The only
877 878
subdirectories you need to keep are bin, lisp, etc and info.  (If you
installed Leim, keep the leim subdirectory, and if you installed
879
intlfonts, keep the fonts directory and all its subdirectories as well.)
880 881 882
The bin subdirectory should be added to your PATH.  The msdos
subdirectory includes a PIF and an icon file for Emacs which you might
find useful if you run Emacs under MS Windows.
883 884 885 886

Emacs on MSDOS finds the lisp, etc and info directories by looking in
../lisp, ../etc and ../info, starting from the directory where the
Emacs executable was run from.  You can override this by setting the
Richard M. Stallman's avatar
Richard M. Stallman committed
887 888 889
environment variables EMACSDATA (for the location of `etc' directory),
EMACSLOADPATH (for the location of `lisp' directory) and INFOPATH (for
the location of the `info' directory).
Richard M. Stallman's avatar
Richard M. Stallman committed
890

Richard M. Stallman's avatar
Richard M. Stallman committed
891 892 893
MSDOG is a not a multitasking operating system, so Emacs features such
as asynchronous subprocesses that depend on multitasking will not
work.  Synchronous subprocesses do work.
894

Richard M. Stallman's avatar
Richard M. Stallman committed
895 896 897
Version 2.0 of djgpp has two bugs that affect Emacs.  We've included
corrected versions of two files from djgpp in the msdos subdirectory:
is_exec.c and sigaction.c.  To work around the bugs, compile these
898 899
files and link them into temacs.  Djgpp versions 2.01 and later have
these bugs fixed, so upgrade if you can before building Emacs.
900

901 902
COPYING PERMISSIONS

903 904 905 906 907 908 909 910 911 912 913 914
   Permission is granted to anyone to make or distribute verbatim copies
   of this document as received, in any medium, provided that the
   copyright notice and permission notice are preserved,
   and that the distributor grants the recipient permission
   for further redistribution as permitted by this notice.

   Permission is granted to distribute modified versions
   of this document, or of portions of it,
   under the above conditions, provided also that they
   carry prominent notices stating who last changed them,
   and that any new or changed statements about the activities
   of the Free Software Foundation are approved by the Foundation.