aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard M. Stallman1994-06-13 15:30:51 +0000
committerRichard M. Stallman1994-06-13 15:30:51 +0000
commitc9da80160967cbcb376d9592d073c82377b5d864 (patch)
treefbf845e60ed5166e88b05286531879b171ae3426
parent485efad04beb4aebd59b06f4b3342c46c4104bf2 (diff)
downloademacs-c9da80160967cbcb376d9592d073c82377b5d864.tar.gz
emacs-c9da80160967cbcb376d9592d073c82377b5d864.zip
Formerly INSTALL.~31~
-rw-r--r--INSTALL62
1 files changed, 34 insertions, 28 deletions
diff --git a/INSTALL b/INSTALL
index 12bea68ad1b..5be8d083287 100644
--- a/INSTALL
+++ b/INSTALL
@@ -70,9 +70,14 @@ libraries.
70The `--run-in-place' option sets up default values for the path 70The `--run-in-place' option sets up default values for the path
71variables in `./Makefile' so that Emacs will expect to find its data 71variables in `./Makefile' so that Emacs will expect to find its data
72files (lisp libraries, runnable programs, and the like) in the same 72files (lisp libraries, runnable programs, and the like) in the same
73locations they occupy while Emacs builds. This means that you don't 73locations they occupy while Emacs builds. If you use `--run-in-place'
74have to install Emacs in order to run it; it uses its data files as 74then you don't need to do `make install'.
75they were unpacked. 75
76`--run-in-place' is pretty much obsolete now. If you put the Emacs
77executable in a subdirectory named src, which has siblings named lisp,
78lib-src, etc, info and so on, Emacs automatically uses those sibling
79directories if the standard installation directory names don't contain
80what Emacs needs.
76 81
77The `--with-gcc' option specifies that the build process should 82The `--with-gcc' option specifies that the build process should
78compile Emacs using GCC. If you don't want to use GCC, specify 83compile Emacs using GCC. If you don't want to use GCC, specify
@@ -178,7 +183,8 @@ and data files installed as well, run `make install'.
178By default, Emacs installs its files in the following directories: 183By default, Emacs installs its files in the following directories:
179 184
180`/usr/local/bin' holds the executable programs users normally run - 185`/usr/local/bin' holds the executable programs users normally run -
181 `emacs', `etags', `ctags', `b2m', and `emacsclient'. 186 `emacs', `etags', `ctags', `b2m', `emacsclient',
187 and `rcs-checkin'.
182 188
183`/usr/local/lib/emacs/VERSION/lisp' holds the Emacs Lisp library; 189`/usr/local/lib/emacs/VERSION/lisp' holds the Emacs Lisp library;
184 `VERSION' stands for the number of the Emacs version 190 `VERSION' stands for the number of the Emacs version
@@ -383,7 +389,8 @@ when running make in the subdirectories.
383 389
384CONFIGURATION BY HAND 390CONFIGURATION BY HAND
385 391
386Running the `configure' program performs the following steps. 392Instead of running the `configure' program, you have to perform the
393following steps.
387 394
3881) Copy `./src/config.h.in' to `./src/config.h'. 3951) Copy `./src/config.h.in' to `./src/config.h'.
389 396
@@ -400,18 +407,17 @@ files for your system and machine, do so by editing config.h, not by
400changing the s/*.h and m/*.h files. Occasionally you may need to 407changing the s/*.h and m/*.h files. Occasionally you may need to
401redefine parameters used in `./lib-src/movemail.c'. 408redefine parameters used in `./lib-src/movemail.c'.
402 409
4033) If you're going to use the make utility to build Emacs, you will 4103) Create src/Makefile and lib-src/Makefile from the corresponding
404still need to run `configure' first, giving theappropriate values for 411`Makefile.in.in' files. First copy `Makefile.in.in' to `Makefile.in',
405the variables in the sections entitled "Things `configure' Might Edit" 412then edit in appropriate substituions for the @...@ constructs,
406and "Where To Install Things." Note that you may only need to change 413and then copy the shell commands near the end of `configure'
407the variables `prefix' and `exec_prefix', since the rest of the 414that run cpp to construct `Makefile'.
408variables have reasonable defaults based on them. For each Makefile
409variable of this type, there is a corresponding configure option; for
410example, to change the location of the lock directory, you might use
411 415
412 ./configure --lockdir=/nfs/emacslock 4164) Create `Makefile' files in various other directories
417from the corresponding `Makefile.in' files. This isn't so hard,
418just a matter of substitution.
413 419
4144) If you're going to use the build-install script to build Emacs, 4205) If you're going to use the build-install script to build Emacs,
415copy `./build-ins.in' to `./build-install', and edit the 421copy `./build-ins.in' to `./build-install', and edit the
416definitions found at the top of the script. 422definitions found at the top of the script.
417 423
@@ -432,17 +438,17 @@ Once Emacs is configured, running `make' or running the shell script
432`./src/paths.h' from the template file `./src/paths.h.in', changing 438`./src/paths.h' from the template file `./src/paths.h.in', changing
433the paths to the values specified in `./Makefile'. 439the paths to the values specified in `./Makefile'.
434 440
4352) Cd to `./lib-src' and run `make'. This creates executables named 4412) Go to directory `./lib-src' and run `make'. This creates
436`ctags' and `etags' and `wakeup' and `make-docfile' and `digest-doc' 442executables named `ctags' and `etags' and `wakeup' and `make-docfile'
437and `test-distrib'. And others. 443and `digest-doc' and `test-distrib'. And others.
438 444
4393) Cd to `./src' and Run `make'. This refers to files in the `./lisp' 4453) Go to directory `./src' and Run `make'. This refers to files in
440and `./lib-src' subdirectories using names `../lisp' and 446the `./lisp' and `./lib-src' subdirectories using names `../lisp' and
441`../lib-src'. 447`../lib-src'.
442 448
443This creates a file `./src/emacs' which is the runnable Emacs, 449This creates a file `./src/emacs' which is the runnable Emacs,
444assigning it a new build version number by incrementing the build 450which has another name that contains a version number.
445version stored in `./lisp/version.el'. 451Each time you do this, that version number increments in the last place.
446 452
447It also creates a file in `./etc' whose name is `DOC' followed by the 453It also creates a file in `./etc' whose name is `DOC' followed by the
448current Emacs version. This file contains documentation strings for 454current Emacs version. This file contains documentation strings for
@@ -463,9 +469,9 @@ in `./lib-src' to their final destinations, as selected in `./src/paths.h'.
463 469
464Strictly speaking, not all of the executables in `./lib-src' need be copied. 470Strictly speaking, not all of the executables in `./lib-src' need be copied.
465- The programs `cvtmail', `emacsserver', `fakemail', `hexl', 471- The programs `cvtmail', `emacsserver', `fakemail', `hexl',
466 `movemail', `timer', `vcdiff', `wakeup', and `yow' are used by 472 `movemail', `profile', `rcs2log', `timer', `vcdiff', `wakeup',
467 Emacs; they do need to be copied. 473 and `yow' are used by Emacs; they do need to be copied.
468- The programs `etags', `ctags', `emacsclient', `b2m', and `rcs2log' 474- The programs `etags', `ctags', `emacsclient', `b2m', and `rcs-checkin'
469 are intended to be run by users; they are handled below. 475 are intended to be run by users; they are handled below.
470- The programs `make-docfile', `make-path', and `test-distrib' were 476- The programs `make-docfile', `make-path', and `test-distrib' were
471 used in building Emacs, and are not needed any more. 477 used in building Emacs, and are not needed any more.
@@ -491,15 +497,15 @@ of installing different versions.
491You can delete `./src/temacs'. 497You can delete `./src/temacs'.
492 498
4935) Copy the programs `b2m', `emacsclient', `ctags', `etags', and 4995) Copy the programs `b2m', `emacsclient', `ctags', `etags', and
494`rcs2log' from `./lib-src' to `/usr/local/bin'. These programs are 500`rcs-checkin' from `./lib-src' to `/usr/local/bin'. These programs are
495intended for users to run. 501intended for users to run.
496 502
4976) Copy the man pages in `./etc' for emacs, ctags, and etags into the 5036) Copy the man pages in `./etc' for emacs, ctags, and etags into the
498appropriate man directories. 504appropriate man directories.
499 505
5007) The files in the `./src' subdirectory, except for `emacs', are not 5067) The files in the `./src' subdirectory, except for `emacs', are not
501used by Emacs once it is built. The source would be handy for 507used by Emacs once it is built. However, it is very desirable to keep
502debugging. 508the source on line for debugging.
503 509
504 510
505PROBLEMS 511PROBLEMS