INSTALL 28.6 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
GNU Emacs Installation Guide
2
Copyright (c) 1992, 1994, 1996, 1997 Free software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

   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.


18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
ADDITIONAL DISTRIBUTION FILES

* leim-M.N.tar.gz

The Emacs Lisp code for input methods for various international
character scripts is distributed in a separate tar file because of its
large size.  This 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.  Thus, if you unpack it in the same directory where
you unpacked the Emacs distribution, it fills in a subdirectory
of the Emacs distribution.

If you have already unpacked the Leim tar file into a subdirectory of
the Emacs sources, building and installing Emacs automatically
installs the input method support as well.  If you unpack the Leim tar
file into the Emacs sources after building and installing Emacs, just
build Emacs again and install it again.

* 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
41 42
it.  You might find a font in the intlfonts distribution.  If some
characters don't look right, or appear improperly aligned, a font
Karl Heuer's avatar
Karl Heuer committed
43
from the intlfonts distribution might look better.
44 45 46

The intlfonts distribution contains its own installation instructions,
in the intlfonts/README file.
47 48


Jim Blandy's avatar
Jim Blandy committed
49
BUILDING AND INSTALLATION:
Richard M. Stallman's avatar
Richard M. Stallman committed
50 51 52

(This is for a Unix or Unix-like system.  For MSDOS, see below; search
for MSDOG.  For Windows NT or Windows 95, see the file nt/INSTALL.)
Jim Blandy's avatar
Jim Blandy committed
53 54 55 56 57

1) Make sure your system has enough swapping space allocated to handle
a program whose pure code is 900k bytes and whose data area is at
least 400k and can reach 8Mb or more.  If the swapping space is
insufficient, you will get an error in the command `temacs -batch -l
58
loadup dump', found in `./src/Makefile.in', or possibly when
Richard M. Stallman's avatar
Richard M. Stallman committed
59
running the final dumped Emacs.
Jim Blandy's avatar
Jim Blandy committed
60
 
Karl Heuer's avatar
Karl Heuer committed
61 62
Building Emacs requires about 70 Mb of disk space (including the Emacs
sources).  Once installed, Emacs occupies about 35 Mb in the file
Richard M. Stallman's avatar
Richard M. Stallman committed
63 64 65
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,
Karl Heuer's avatar
Karl Heuer committed
66
then the installation procedure momentarily requires 70+35 Mb.
Jim Blandy's avatar
Jim Blandy committed
67 68

2) Consult `./etc/MACHINES' to see what configuration name you should
69
give to the `configure' program.  That file offers hints for
Jim Blandy's avatar
Jim Blandy committed
70 71
getting around some possible installation problems.

72 73 74 75 76
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
77

78
    ./configure [CONFIGURATION-NAME] [--OPTION[=VALUE]] ...
Jim Blandy's avatar
Jim Blandy committed
79 80

The CONFIGURATION-NAME argument should be a configuration name given
81 82 83 84 85 86
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
87

88 89 90
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
91 92 93

The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build
process where the compiler should look for the include files and
94 95
object libraries used with the X Window System.  Normally, `configure'
is able to find them; these options are necessary if you have your X
96 97
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
98

99 100 101 102 103
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
shared libraries.
Jim Blandy's avatar
Jim Blandy committed
104 105 106

The `--with-gcc' option specifies that the build process should
compile Emacs using GCC.  If you don't want to use GCC, specify
107 108
`--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
109

110 111 112 113 114 115 116 117
If you want the Emacs mail reader RMAIL to read mail from a POP
server, you must specify `--with-pop'.  This provides support for the
POP3 protocol; older versions are not supported.  For
Kerberos-authenticated POP add `--with-kerberos', for Hesiod support
add `--with-hesiod'.  These options enable Emacs to use POP; whether
Emacs uses POP is controlled by individual users--see the Rmail
chapter of the Emacs manual.

Jim Blandy's avatar
Jim Blandy committed
118 119 120 121
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).
122 123
- 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
124
- The architecture-dependent files go in
125
  PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION
Jim Blandy's avatar
Jim Blandy committed
126 127 128 129 130 131 132 133
  (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
134
  EXECDIR/libexec/emacs/VERSION/CONFIGURATION.
Jim Blandy's avatar
Jim Blandy committed
135 136 137 138 139 140 141 142 143
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.

144
`configure' doesn't do any compilation or installation
Jim Blandy's avatar
Jim Blandy committed
145
itself.  It just creates the files that influence those things:
David J. MacKenzie's avatar
David J. MacKenzie committed
146 147 148 149
`./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
150 151

When it is done, `configure' prints a description of what it did and
152 153 154 155 156 157 158 159 160
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
161 162

The work of `configure' can be done by editing various files in the
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
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
178

Richard M. Stallman's avatar
Richard M. Stallman committed
179 180
3c) Some people try to build in a separate directory by filling
it full of symlinks to the files in the real source directory.
181 182 183 184 185 186 187
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
188
4) Look at `./lisp/paths.el'; if some of those values are not right
Karl Heuer's avatar
Karl Heuer committed
189 190
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
191 192 193 194 195 196 197 198
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").

199 200 201 202 203
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
204 205 206 207
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
208
src/Makefile.in if you wish to figure out how to do that).  For all
209 210
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
211

212 213 214
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!
215

Jim Blandy's avatar
Jim Blandy committed
216 217 218
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.
219
See `./etc/PROBLEMS' for more details on which systems this affects.
Jim Blandy's avatar
Jim Blandy committed
220

Richard M. Stallman's avatar
Richard M. Stallman committed
221 222
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
223 224 225 226 227 228 229

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
230 231 232 233 234 235 236 237
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
238 239

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

243
`/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library;
Jim Blandy's avatar
Jim Blandy committed
244
		`VERSION' stands for the number of the Emacs version
245
		you are installing, like `18.59' or `19.27'.  Since the
246
		Lisp library changes from one version of Emacs to
Jim Blandy's avatar
Jim Blandy committed
247 248
		another, including the version number in the path
		allows you to have several versions of Emacs installed
249 250
		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
251

252 253 254 255 256 257 258 259 260 261
`/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
262

263
`/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
Jim Blandy's avatar
Jim Blandy committed
264 265 266 267
		file, the `yow' database, and other
		architecture-independent files Emacs might need while
		running.  VERSION is as specified for `.../lisp'.

268
`/usr/local/com/emacs/lock' contains files indicating who is editing
Jim Blandy's avatar
Jim Blandy committed
269 270 271
		what, so Emacs can detect editing clashes between
		users.

272
`/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable
Jim Blandy's avatar
Jim Blandy committed
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
		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
298
for its Lisp files by giving values for `make' variables as part of
Jim Blandy's avatar
Jim Blandy committed
299 300 301 302 303 304 305
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
306
9) If your system uses lock files to interlock access to mailer inbox files,
307
then you might need to make the movemail program setuid or setgid
Richard M. Stallman's avatar
Richard M. Stallman committed
308 309
to enable it to write the lock files.  We believe this is safe.

Karl Heuer's avatar
Karl Heuer committed
310 311 312 313 314
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
configuration), type `make distclean'.

Jim Blandy's avatar
Jim Blandy committed
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335


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
336
	defaults to /usr/local/share.  We create the following
Jim Blandy's avatar
Jim Blandy committed
337
	subdirectories under `datadir':
338
	- `emacs/VERSION/lisp', containing the Emacs Lisp library, and
Jim Blandy's avatar
Jim Blandy committed
339 340 341 342 343 344 345 346 347
	- `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
348
`sharedstatedir' indicates where to put architecture-independent data files
Jim Blandy's avatar
Jim Blandy committed
349
	that Emacs modifies while it runs; it defaults to
David J. MacKenzie's avatar
David J. MacKenzie committed
350 351
	/usr/local/com.  We create the following
	subdirectories under `sharedstatedir':
Jim Blandy's avatar
Jim Blandy committed
352 353 354 355
	- `emacs/lock', containing files indicating who is editing
		what, so Emacs can detect editing clashes between
		users.

David J. MacKenzie's avatar
David J. MacKenzie committed
356 357 358
`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
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
	- `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
390
	`sharedstatedir', `infodir', and `mandir'.  Its default value is
Jim Blandy's avatar
Jim Blandy committed
391 392 393 394 395 396 397 398 399 400 401 402 403
	`/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
404
	path variables - `bindir' and `libexecdir'.
Jim Blandy's avatar
Jim Blandy committed
405 406

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

Karl Heuer's avatar
Karl Heuer committed
409 410 411 412
`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
413 414 415 416 417 418 419 420 421 422
	(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'.

423 424 425 426 427
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
428 429 430 431 432 433 434
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
435 436
Instead of running the `configure' program, you have to perform the
following steps.
Jim Blandy's avatar
Jim Blandy committed
437

438
1) Copy `./src/config.in' to `./src/config.h'.
Jim Blandy's avatar
Jim Blandy committed
439 440 441 442 443 444 445 446 447 448 449 450 451 452

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
453
3) Create src/Makefile and lib-src/Makefile from the corresponding
454
`Makefile.in' files.  First copy `Makefile.in' to `Makefile.c',
Karl Heuer's avatar
Karl Heuer committed
455
then edit in appropriate substitutions for the @...@ constructs,
Richard M. Stallman's avatar
Richard M. Stallman committed
456 457
and then copy the shell commands near the end of `configure'
that run cpp to construct `Makefile'.
Jim Blandy's avatar
Jim Blandy committed
458

Richard M. Stallman's avatar
Richard M. Stallman committed
459 460 461
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
462 463

The `configure' script is built from `configure.in' by the `autoconf'
464
program.  You need version 2.0 or newer of `autoconf' to rebuild `configure'.
Jim Blandy's avatar
Jim Blandy committed
465 466 467

BUILDING GNU EMACS BY HAND

Richard M. Stallman's avatar
Richard M. Stallman committed
468 469
Once Emacs is configured, running `make' in the top directory performs
the following steps.
Jim Blandy's avatar
Jim Blandy committed
470 471

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

Richard M. Stallman's avatar
Richard M. Stallman committed
475 476 477
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
478

Richard M. Stallman's avatar
Richard M. Stallman committed
479 480
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
481 482 483
`../lib-src'.

This creates a file `./src/emacs' which is the runnable Emacs,
Richard M. Stallman's avatar
Richard M. Stallman committed
484 485
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
486 487 488 489 490 491 492 493 494 495 496

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
497 498
The steps below are done by running `make install' in the main
directory of the Emacs distribution.
Jim Blandy's avatar
Jim Blandy committed
499 500 501 502 503

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
504
- The programs `cvtmail', `emacsserver', `fakemail', `hexl',
Richard M. Stallman's avatar
Richard M. Stallman committed
505 506 507
    `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
508
    are intended to be run by users; they are handled below.
David J. MacKenzie's avatar
David J. MacKenzie committed
509
- The programs `make-docfile' and `test-distrib' were
Jim Blandy's avatar
Jim Blandy committed
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
    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.

3) Create a directory for Emacs to use for clash detection, named as
indicated by the PATH_LOCK macro in `./src/paths.h'.

4) Copy `./src/emacs' to `/usr/local/bin', or to some other directory
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'.

5) Copy the programs `b2m', `emacsclient', `ctags', `etags', and
Richard M. Stallman's avatar
Richard M. Stallman committed
533
`rcs-checkin' from `./lib-src' to `/usr/local/bin'.  These programs are
Jim Blandy's avatar
Jim Blandy committed
534 535 536 537 538 539
intended for users to run.

6) Copy the man pages in `./etc' for emacs, ctags, and etags into the
appropriate man directories.

7) The files in the `./src' subdirectory, except for `emacs', are not
Richard M. Stallman's avatar
Richard M. Stallman committed
540 541
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
542 543 544 545


PROBLEMS

546
See the file PROBLEMS in etc subdirectory for a list of various
Jim Blandy's avatar
Jim Blandy committed
547 548 549
problems sometimes encountered, and what to do about them.


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

Richard M. Stallman's avatar
Richard M. Stallman committed
552
To install on MSDOG, you need to have the GNU C compiler for MSDOG
553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
(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.

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
support long file names on Windows 95 no matter what was the setting
586 587 588 589 590 591 592
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.
593 594 595 596 597 598

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
599
your system.)
600 601 602 603

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
604 605 606

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

608 609 610 611 612 613
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
614 615 616 617
subdirectories you need to keep are bin, lisp, etc and info.  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.
618 619 620 621

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
622 623 624
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
625

Richard M. Stallman's avatar
Richard M. Stallman committed
626 627 628
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.
629

Richard M. Stallman's avatar
Richard M. Stallman committed
630 631 632 633 634
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
files and link them into temacs.  Djgpp version 2.01 have these bugs
fixed, so upgrade if you can before building Emacs.