aboutsummaryrefslogtreecommitdiffstats
path: root/INSTALL
diff options
context:
space:
mode:
authorGlenn Morris2014-10-15 00:02:43 -0700
committerGlenn Morris2014-10-15 00:02:43 -0700
commit83e1e4d26078d2b9ec773fd5cc9fc0ea01d9d690 (patch)
tree612f2a3f4fb4ab0b1eadeb9253814325b2ed6a16 /INSTALL
parent924a09e9161c05d9d69d85fa102910b10ece372f (diff)
downloademacs-83e1e4d26078d2b9ec773fd5cc9fc0ea01d9d690.tar.gz
emacs-83e1e4d26078d2b9ec773fd5cc9fc0ea01d9d690.zip
* INSTALL: Remove the "by hand" sections.
No-one needs to know those details, and this file is too long already.
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL111
1 files changed, 5 insertions, 106 deletions
diff --git a/INSTALL b/INSTALL
index eb8857f9dfd..8ecee65aaa5 100644
--- a/INSTALL
+++ b/INSTALL
@@ -207,9 +207,9 @@ corresponding command is `yum-builddep emacs'.
207 207
208DETAILED BUILDING AND INSTALLATION: 208DETAILED BUILDING AND INSTALLATION:
209 209
210(This is for a Unix or Unix-like system. For MS-DOS and MS Windows 3.X, 210(This is for a Unix or Unix-like system. For GNUstep and Mac OS X,
211see msdos/INSTALL. For later versions of MS Windows, see the file 211see nextstep/INSTALL. For non-ancient versions of MS Windows, see
212nt/INSTALL. For GNUstep and Mac OS X, see nextstep/INSTALL.) 212the file nt/INSTALL. For MS-DOS and MS Windows 3.X, see msdos/INSTALL.)
213 213
2141) See the basic installation summary above for the disk space requirements. 2141) See the basic installation summary above for the disk space requirements.
215 215
@@ -359,8 +359,7 @@ without sound support.
359`configure' doesn't do any compilation or installation itself. 359`configure' doesn't do any compilation or installation itself.
360It just creates the files that influence those things: 360It just creates the files that influence those things:
361`./Makefile' in the top-level directory and several subdirectories; 361`./Makefile' in the top-level directory and several subdirectories;
362and `./src/config.h'. For details on exactly what it does, see the 362and `./src/config.h'.
363section called `CONFIGURATION BY HAND', below.
364 363
365When it is done, `configure' prints a description of what it did and 364When it is done, `configure' prints a description of what it did and
366creates a shell script `config.status' which, when run, recreates the 365creates a shell script `config.status' which, when run, recreates the
@@ -415,11 +414,6 @@ those libraries are. For example:
415 ./configure \ 414 ./configure \
416 PKG_CONFIG_PATH='/usr/local/alsa/lib/pkgconfig:/opt/gtk+-2.8/lib/pkgconfig' 415 PKG_CONFIG_PATH='/usr/local/alsa/lib/pkgconfig:/opt/gtk+-2.8/lib/pkgconfig'
417 416
418The work of `configure' can be done by editing various files in the
419distribution, but using `configure' is easier. See the section called
420"CONFIGURATION BY HAND" below if you want to do the configuration
421yourself.
422
4233b) To build in a separate directory, go to that directory 4173b) To build in a separate directory, go to that directory
424and run the program `configure' as follows: 418and run the program `configure' as follows:
425 419
@@ -429,9 +423,6 @@ SOURCE-DIR refers to the top-level Emacs source directory which is
429where Emacs's configure script is located. `configure' looks for the 423where Emacs's configure script is located. `configure' looks for the
430Emacs source code in the directory that `configure' is in. 424Emacs source code in the directory that `configure' is in.
431 425
432(Do not try to build in a separate directory by creating many links to
433the real source directory--there is no need, and installation will fail.)
434
4354) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs 4264) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs
436Lisp code you want Emacs to load before it is dumped out. Use 427Lisp code you want Emacs to load before it is dumped out. Use
437site-load.el for additional libraries if you arrange for their 428site-load.el for additional libraries if you arrange for their
@@ -544,11 +535,7 @@ to enable it to write the lock files. We believe this is safe.
5449) You are done! You can remove executables and object files from 5359) You are done! You can remove executables and object files from
545the build directory by typing `make clean'. To also remove the files 536the build directory by typing `make clean'. To also remove the files
546that `configure' created (so you can compile Emacs for a different 537that `configure' created (so you can compile Emacs for a different
547configuration), type `make distclean'. If you don't need some, or all 538configuration), type `make distclean'.
548of the input methods from the Leim package, you can remove the
549unneeded files in the leim subdirectories of your site's lisp
550directory (usually /usr/local/share/emacs/VERSION/).
551
552 539
553 540
554MAKE VARIABLES 541MAKE VARIABLES
@@ -656,94 +643,6 @@ Makefiles for the subdirectories, so you don't have to specify them
656when running make in the subdirectories. 643when running make in the subdirectories.
657 644
658 645
659CONFIGURATION BY HAND
660
661This should not be necessary and is not recommended. Instead of
662running the `configure' program, you have to perform the following steps.
663
6641) Copy `./src/config.in' to `./src/config.h'.
665
6662) Edit `./src/config.h' to set the right options for your system.
667
6683) Create `Makefile' files in various directories from the
669corresponding `Makefile.in' files. This isn't so hard, just a matter
670of editing in appropriate substitutions for the @...@ constructs.
671
672The `configure' script is built from `configure.ac' by the
673`autogen.sh' script, which checks that `autoconf' and other build
674tools are sufficiently up to date and then runs the build tools.
675
676BUILDING GNU EMACS BY HAND
677
678Once Emacs is configured, running `make' in the top directory performs
679the following steps.
680
6811) Run `make epaths-force' in the top directory. This produces
682`./src/epaths.h' from the template file `./src/epaths.in', changing
683the paths to the values specified in `./Makefile'.
684
6852) Go to directory `./lib' and run `make'. This creates include files
686and libraries used in later steps.
687
6883) Go to directory `./lib-src' and run `make'. This creates
689executables named `etags', `make-docfile', and others.
690
6914) Go to directory `./src' and run `make'. This refers to files in
692the `./lisp', `./lib', and `./lib-src' subdirectories using names
693`../lisp', `../lib', and `../lib-src'.
694
695This creates a file `./src/emacs' which is the runnable Emacs,
696which has another name that contains a version number.
697Each time you do this, that version number increments in the last place.
698
699It also creates a file in `./etc' whose name is `DOC' followed by the
700current Emacs version. This file contains documentation strings for
701all the functions in Emacs. Each time you run make to make a new
702emacs, a new DOC file with a new name is made. You must keep the DOC
703file for an Emacs version as long as you keep using that Emacs version.
704
705
706INSTALLATION BY HAND
707
708The steps below are done by running `make install' in the main
709directory of the Emacs distribution.
710
7111) Copy `./lisp' and its subdirectories, `./etc', and the executables
712in `./lib-src' to their final destinations, as selected in `./src/epaths.h'.
713
714Strictly speaking, not all of the executables in `./lib-src' need be copied.
715- The programs `hexl', `movemail', `profile', and `rcs2log'
716 are used by Emacs; they do need to be copied.
717- The programs `etags', `ctags', and `emacsclient' are intended to be
718 run by users; they are handled below.
719- The program `make-docfile' was used in building Emacs, and is
720 not needed any more.
721
7222) Copy the files in `./info' to the place specified in
723`./lisp/site-init.el' or `./lisp/info.el'. Note that if the
724destination directory already contains a file named `dir', you
725probably don't want to replace it with the `dir' file in the Emacs
726distribution. Instead, you should make sure that the existing `dir'
727file contains an appropriate menu entry for the Emacs info.
728
7293) Copy `./src/emacs' to `/usr/local/bin', or to some other directory
730in users' search paths. `./src/emacs' has an alternate name
731`./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named
732`/usr/local/bin/emacs' pointing to that alternate name, as an easy way
733of installing different versions.
734
735You can delete `./src/temacs'.
736
7374) Copy the programs `emacsclient', `ctags', and `etags' from `./lib-src'
738to `/usr/local/bin'. These programs are intended for users to run.
739
7405) Copy the man pages in `./doc/man' into the appropriate man directory.
741
7426) The files in the `./src' subdirectory, except for `emacs', are not
743used by Emacs once it is built. However, it is very desirable to keep
744the source on line for debugging.
745
746
747PROBLEMS 646PROBLEMS
748 647
749See the file `./etc/PROBLEMS' for a list of various problems sometimes 648See the file `./etc/PROBLEMS' for a list of various problems sometimes