GNU Emacs Installation GuideCopyright (C) 1992, 1994, 1996, 1997, 2000, 2001, 2002, 2003, 2004,2005, 2006, 2007 Free Software Foundation, Inc.See the end of the file for license conditions.BASIC INSTALLATIONThe simplest way to build Emacs is to use the `configure' shell scriptwhich attempts to guess correct values for various system-dependentvariables and features and find the directories where various systemheaders and libraries are kept. It then creates a `Makefile' in eachsubdirectory and a `config.h' file containing system-dependentdefinitions. Running the `make' utility then builds the package foryour system.Here's the procedure to build Emacs using `configure' on systems whichare supported by it. If this simplified procedure fails, or if youare using a platform such as MS-Windows, where `configure' scriptdoesn't work, you might need to use various non-default options, andmaybe perform some of the steps manually. The more detaileddescription in the rest of the sections of this guide will help you dothat, so please refer to them if the simple procedure does not work. 1. Make sure your system has at least 120 MB of free disk space. 2a. `cd' to the directory where you unpacked Emacs and invoke the `configure' script: ./configure 2b. Alternatively, create a separate directory, outside the source directory, where you want to build Emacs, and invoke `configure' from there: SOURCE-DIR/configure where SOURCE-DIR is the top-level Emacs source directory. This may not work unless you use GNU make. 3. 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 Xpm, jpeg, etc., and you want to use them refer to the subsection "Image support libraries", below. If the details printed by `configure' don't make any sense to you, assume that `configure' did its job and proceed. 4. 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 5. Invoke the `make' program: make 6. If `make' succeeds, it will build an executable program `emacs' in the `src' directory. You can try this program, to make sure it works: src/emacs -q 7. 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 You can also save some space by compressing (with `gzip') Info files and installed Lisp source (.el) files which have corresponding .elc versions.ADDITIONAL DISTRIBUTION FILES* intlfonts-VERSION.tar.gzThe intlfonts distribution contains X11 fonts in various encodingsthat Emacs can use to display international characters. If you see anon-ASCII character appear as a hollow box, that means you don't havea font for it. You might find one in the intlfonts distribution. Ifyou do have a font for a non-ASCII character, but some charactersdon't look right, or appear improperly aligned, a font from theintlfonts distribution might look better.The fonts in the intlfonts distribution are also used by the ps-printpackage for printing international characters. The filelisp/ps-mule.el defines the *.bdf font files required for printingeach character set.The intlfonts distribution contains its own installation instructions,in the intlfonts/README file.* Image support librariesEmacs needs optional libraries to be able to display images (with theexception of PBM and XBM images whose support is built-in).On some systems, particularly on GNU/Linux, these libraries mayalready be present or available as additional packages. Note that ifthere is a separate `dev' or `devel' package, for use at compilationtime rather than run time, you will need that as well as thecorresponding run time package; typically the dev package willcontain header files and a library archive. Otherwise, you candownload and build libraries from sources. None of them are vital forrunning Emacs; however, note that Emacs will not be able to usecolored icons in the toolbar if XPM support is not compiled in.Here's the list of these optional libraries, and the URLs where theycan be found: . libXaw3d for fancy 3D-style scroll bars: ftp://ftp.x.org/contrib/widgets/Xaw3d/ . libxpm for XPM: ftp://ftp.x.org/contrib/libraries/ Get version 3.4k or later, which lets Emacs use its own color allocation functions. . libpng for PNG: ftp://ftp.simplesystems.org/pub/libpng/png/ . libz (for PNG): http://www.zlib.net/ . libjpeg for JPEG: ftp://ftp.uu.net/graphics/jpeg/ Get version 6b -- 6a is reported to fail in Emacs. . libtiff for TIFF: http://www.libtiff.org/ . libungif for GIF: http://sourceforge.net/projects/libungif Ensure you get version 4.1.0b1 or higher of libungif -- a bug in 4.1.0 can crash Emacs.Emacs will configure itself to build with these libraries if the`configure' script finds them on your system, unless you supply theappropriate --without-LIB option. In some cases, older versions ofthese libraries won't work because some routines are missing, andconfigure should avoid such old versions. If that happens, use the--without-LIB options to `configure'. See below for more details.* Extra fontsThe Emacs distribution does not include fonts and does not installthem. You must do that yourself.To take proper advantage of Emacs 21's mule-unicode charsets, you needa suitable font. For `Unicode' (ISO 10646) fonts for X, see<URL:http://czyborra.com/unifont/> (packaged in Debian),<URL:http://openlab.ring.gr.jp/efont/> (packaged in Debian). (Inrecent Debian versions, there is an extensive `misc-fixed' iso10646-1in the default X installation.) Perhaps also see<URL:http://www.cl.cam.ac.uk/%7Emgk25/ucs-fonts.html>.<URL:http://czyborra.com/charsets/> has basic fonts for Emacs'sISO-8859 charsets.XFree86 release 4 (from <URL:ftp://ftp.xfree86.org/pub/XFree86/> and mirrors)contains font support for most, if not all, of the charsets that Emacscurrently supports, including iso10646-1 encoded fonts for use withthe mule-unicode charsets. The font files should also be usable witholder X releases. Note that XFree 4 contains many iso10646-1 fontswith minimal character repertoires, which can cause problems -- seeetc/PROBLEMS.BDF Unicode fonts etl-unicode.tar.gz are available from<URL:ftp://ftp.x.org/contrib/fonts/> and<URL:ftp://ftp.xfree86.org/pub/mirror/X.Org/contrib/fonts/>. Thesefonts can also be used by ps-print and ps-mule to print Unicodecharacters.Finally, the Web pages <URL:http://www.nongnu.org/freefont/index.html>and <URL:http://www.nongnu.org/freefont/resources.html> list a largenumber of free Unicode fonts.* GNU/Linux development packagesMany GNU/Linux systems do not come with development packages bydefault; they just include the files that you need to run Emacs, butnot those you need to compile it. For example, to compile Emacs withX11 support, you may need to install the special `X11 development'package. For example, in April 2003, the package names to installwere `XFree86-devel' and `Xaw3d-devel' on Red Hat. On Debian, thepackages necessary to build the installed version should besufficient; they can be installed using `apt-get build-dep emacs21' inDebian 3 and above.DETAILED BUILDING AND INSTALLATION:(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 filemac/INSTALL.)1) Make sure your system has enough swapping space allocated to handlea program whose pure code is 1.5 MB and whose data area is atleast 2.8 MB and can reach 100 MB or more. If the swapping space isinsufficient, you will get an error in the command `temacs -batch -lloadup dump', found in `./src/Makefile.in', or possibly whenrunning the final dumped Emacs.Building Emacs requires about 140 MB of disk space (including theEmacs sources) Once installed, Emacs occupies about 77 MB in the filesystem where it is installed; this includes the executable files, Lisplibraries, miscellaneous data files, and on-line documentation. Ifthe building and installation take place in different directories,then the installation procedure momentarily requires 140+77 MB.2) Consult `./etc/MACHINES' to see what configuration name you shouldgive to the `configure' program. That file offers hints forgetting around some possible installation problems. The file listsmany different configurations, but only the part for your machine andoperating system is relevant. (The list is arranged in alphabeticalorder by the vendor name.)3) You can build Emacs in the top-level Emacs source directoryor in a separate directory.3a) To build in the top-level Emacs source directory, go to thatdirectory and run the program `configure' as follows: ./configure [CONFIGURATION-NAME] [--OPTION[=VALUE]] ...The CONFIGURATION-NAME argument should be a configuration name givenin `./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.If you don't want X support, specify `--with-x=no'. If you omit thisoption, `configure' will try to figure out for itself whether yoursystem has X, and arrange to use it if present.The `--x-includes=DIR' and `--x-libraries=DIR' options tell the buildprocess where the compiler should look for the include files andobject libraries used with the X Window System. Normally, `configure'is able to find them; these options are necessary if you have your XWindow System files installed in unusual places. These options alsoaccept a list of directories, separated with colons.To get more attractive menus, you can specify an X toolkit when youconfigure Emacs; use the option `--with-x-toolkit=TOOLKIT', whereTOOLKIT is `athena', `motif' or `gtk' (`yes' and `lucid' are synonymsfor `athena'). On some systems, it does not work to use a toolkitwith shared libraries. A free implementation of Motif, calledLessTif, is available from <http://www.lesstif.org>. Compiling withLessTif or Motif causes a standard File Selection Dialog to pop upwhen you invoke file commands with the mouse. You can get fancy3D-style scroll bars, even without LessTif/Motif, if you have theXaw3d library installed (see "Image support libraries" above for Xaw3davailability).If `--with-x-toolkit=gtk' is specified, you can tell configure whereto search for GTK by specifying `--with-pkg-config-prog=PATH' wherePATH is the pathname to pkg-config. Note that GTK version 2.4 ornewer is required for Emacs.The `--with-gcc' option specifies that the build process shouldcompile Emacs using GCC. If you don't want to use GCC, specify`--with-gcc=no'. If you omit this option, `configure' will searchfor GCC in your path, and use it if present.The Emacs mail reader RMAIL is configured to be able to read mail froma POP3 server by default. Versions of the POP protocol older thanPOP3 are not supported. For Kerberos-authenticated POP add`--with-kerberos', for Hesiod support add `--with-hesiod'. While POP3is always enabled, whether Emacs actually uses POP is controlled byindividual users--see the Rmail chapter of the Emacs manual.For image support you may have to download, build, and install theappropriate image support libraries for image types other than XBM andPBM, see the list of URLs in "ADDITIONAL DISTRIBUTION FILES" above.(Note that PNG support requires libz in addition to libpng.)To disable individual types of image support in Emacs for some reason,even though configure finds the libraries, you can configure with oneor more of these options: --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 supportUse --without-toolkit-scroll-bars to disable LessTif/Motif or Xaw3dscroll bars.Use --without-xim to inhibit the default use of X Input Methods. Inthis case, the X resource useXIM can be used to turn on use of XIM.Use --disable-largefile omits support for files larger than 2GB onsystems which support that.Use --without-sound to disable sound support.The `--prefix=PREFIXDIR' option specifies where the installation processshould 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).- The architecture-independent files go in PREFIXDIR/share/emacs/VERSION (where VERSION is the version number of Emacs, like `19.27').- The architecture-dependent files go in PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION (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 separateportion of the directory tree for installing architecture-specificfiles, 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 EXECDIR/libexec/emacs/VERSION/CONFIGURATION.EXECDIR/bin should be a directory that is normally in users' PATHs.For example, the command ./configure mips-dec-ultrix --with-x11configures Emacs to build for a DECstation running Ultrix, withsupport for the X11 window system.`configure' doesn't do any compilation or installationitself. It just creates the files that influence those things:`./Makefile', `lib-src/Makefile', `oldXMenu/Makefile',`lwlib/Makefile', `src/Makefile', and `./src/config.h'. For detailson exactly what it does, see the section called `CONFIGURATION BYHAND', below.When it is done, `configure' prints a description of what it did andcreates a shell script `config.status' which, when run, recreates thesame configuration. If `configure' exits with an error afterdisturbing the status quo, it removes `config.status'. `configure'also creates a file `config.cache' that saves the results of its teststo make reconfiguring faster, and a file `config.log' containing compileroutput (useful mainly for debugging `configure'). You can give`configure' the option `--cache-file=FILE' to use the results of thetests in FILE instead of `config.cache'. Set FILE to `/dev/null' todisable caching, for debugging `configure'.If the description of the system configuration printed by `configure'is not right, or if it claims some of the features or libraries are notavailable when you know they are, look at the `config.log' file forthe trace of the failed tests performed by `configure' to checkwhether these features are supported. Typically, some test failsbecause the compiler cannot find some function in the systemlibraries, or some macro-processor definition in the system headers.Some tests might fail because the compiler should look in specialdirectories for some header files, or link against optionallibraries, or use special compilation options. You can force`configure' and the build process which follows it to do that bysetting the variables CPPFLAGS, CFLAGS, LDFLAGS, LIBS, CPP and CCbefore running `configure'. CPP is the command which invokes thepreprocessor, CPPFLAGS lists the options passed to it, CFLAGS arecompilation options, LDFLAGS are options used when linking, LIBS arelibraries to link against, and CC is the command which invokes thecompiler.Here's an example of a `configure' invocation, assuming a Bourne-likeshell such as Bash, which uses these variables: 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 thepreprocessor to look in the `/foo/myinclude' directory for headerfiles (in addition to the standard directories), instruct the linkerto look in `/bar/mylib' for libraries, pass the -O3 optimizationswitch to the compiler, and link against libfoo.a and libbar.alibraries in addition to the standard ones.For some libraries, like Gtk+, fontconfig and ALSA, `configure' usepkg-config to find where those libraries are installed.If you want pkg-config to look in special directories, you have to setthe environment variable PKG_CONFIG_PATH to point to the directorieswhere the .pc-files for those libraries are.For example: PKG_CONFIG_PATH='/usr/local/alsa/lib/pkgconfig:/opt/gtk+-2.8/lib/pkgconfig' \ ./configureThe work of `configure' can be done by editing various files in thedistribution, but using `configure' is easier. See the section called"CONFIGURATION BY HAND" below if you want to do the configurationyourself.3b) To build in a separate directory, go to that directoryand run the program `configure' as follows: SOURCE-DIR/configure CONFIGURATION-NAME [--OPTION[=VALUE]] ...SOURCE-DIR refers to the top-level Emacs source directory which iswhere Emacs's configure script is located. `configure' looks for theEmacs 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'.3c) Some people try to build in a separate directory by fillingit full of symlinks to the files in the real source directory.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 usea directory full of links rather than use the standard GNUfacilities to build in a separate directory (see 3b above).4) Look at `./lisp/paths.el'; if some of those values are not rightfor your system, set up the file `./lisp/site-init.el' with EmacsLisp code to override them; it is not a good idea to edit paths.elitself. 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 variablenews-inews-program (which is "/usr/local/inews").Before you override a variable this way, *look at the value* that thevariable gets by default! Make sure you know what kind of value thevariable should have. If you don't pay attention to what you aredoing, you'll make a mistake.5) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any EmacsLisp code you want Emacs to load before it is dumped out. Usesite-load.el for additional libraries if you arrange for theirdocumentation strings to be in the etc/DOC file (seesrc/Makefile.in if you wish to figure out how to do that). For allelse, use site-init.el. Do not load byte-compiled code whichwas build with a non-nil value of `byte-compile-dynamic'.If you set load-path to a different value in site-init.el orsite-load.el, Emacs will use *precisely* that value when it starts upagain. If you do this, you are on your own!Note that, on some systems, the code you place in site-init.el mustnot use expand-file-name or any other function which may looksomething up in the system's password and user information database.See `./etc/PROBLEMS' for more details on which systems this affects.The `site-*.el' files are nonexistent in the distribution. You do notneed to create them if you have nothing to put in them.6) Refer to the file `./etc/TERMS' for information on fields you maywish to add to various termcap entries. The files `./etc/termcap.ucb'and `./etc/termcap.dat' may already contain appropriately-modifiedentries.7) Run `make' in the top directory of the Emacs distribution to finishbuilding Emacs in the standard way. The final executable file isnamed `src/emacs'. You can execute this file "in place" withoutcopying it, if you wish; then it automatically uses the siblingdirectories ../lisp, ../lib-src, ../info.Or you can "install" the executable and the other Emacs into theirinstalled locations, with `make install'. By default, Emacs's filesare installed in the following directories:`/usr/local/bin' holds the executable programs users normally run - `emacs', `etags', `ctags', `b2m', `emacsclient', and `rcs-checkin'.`/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library; `VERSION' stands for the number of the Emacs version you are installing, like `18.59' or `19.27'. Since the Lisp library changes 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; in particular, you don't have to make Emacs unavailable while installing a new version.`/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC file, the `yow' database, and other architecture-independent files Emacs might need while running. VERSION is as specified for `.../lisp'.`/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains 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.`/usr/local/share/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'.Any version of Emacs, whether installed or not, also looks for Lispfiles in these directories.`/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'.If these directories are not what you want, you can specify where toinstall Emacs's libraries and data files or where Emacs should searchfor its Lisp files by giving values for `make' variables as part ofthe command. See the section below called `MAKE VARIABLES' for moreinformation on this.8) Check the file `dir' in your site's info directory (usually/usr/local/share/info) to make sure that it has a menu entry for theEmacs info files.9) If your system uses lock files to interlock access to mailer inbox files,then you might need to make the movemail program setuid or setgidto enable it to write the lock files. We believe this is safe.10) You are done! You can remove executables and object files fromthe build directory by typing `make clean'. To also remove the filesthat `configure' created (so you can compile Emacs for a differentconfiguration), type `make distclean'. If you don't need some, or allof the input methods from the Leim package, you can remove theunneeded files in the leim subdirectories of your site's lispdirectory (usually /usr/local/share/emacs/VERSION/).MAKE VARIABLESYou can change where the build process installs Emacs and its datafiles by specifying values for `make' variables as part of the `make'command line. For example, if you type make install bindir=/usr/local/gnubinthe `bindir=/usr/local/gnubin' argument indicates that the Emacsexecutable 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 defaults to /usr/local/share. We create the following subdirectories under `datadir': - `emacs/VERSION/lisp', containing the Emacs Lisp library, and - `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.`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': - `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/share/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', `sharedstatedir', `infodir', and `mandir'. Its default value is `/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 path variables - `bindir' and `libexecdir'.The above variables serve analogous purposes in the makefiles for allGNU software; this variable is specific to Emacs.`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' (where VERSION and CONFIGURATION-NAME are as described above).Remember that you must specify any variable values you need each timeyou run `make' in the top directory. If you run `make' once to buildemacs, test it, and then run `make' again to install the files, youmust provide the same variable settings each time. To make thesettings persist, you can edit them into the `Makefile' in the topdirectory, but be aware that running the `configure' program erases`Makefile' and rebuilds it from `Makefile.in'.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 filebefore you run `make'.The top-level Makefile stores the variable settings it used in theMakefiles for the subdirectories, so you don't have to specify themwhen running make in the subdirectories.CONFIGURATION BY HANDInstead of running the `configure' program, you have to perform thefollowing steps.1) Copy `./src/config.in' to `./src/config.h'.2) Consult `./etc/MACHINES' to see what configuration name you shoulduse for your system. Look at the code of the `configure' script tosee 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 includethe appropriate system and architecture description files.2) Edit `./src/config.h' to set the right options for your system. Ifyou need to override any of the definitions in the s/*.h and m/*.hfiles for your system and machine, do so by editing config.h, not bychanging the s/*.h and m/*.h files. Occasionally you may need toredefine parameters used in `./lib-src/movemail.c'.3) Create src/Makefile and lib-src/Makefile from the corresponding`Makefile.in' files. First copy `Makefile.in' to `Makefile.c',then edit in appropriate substitutions for the @...@ constructs,and then copy the shell commands near the end of `configure'that run cpp to construct `Makefile'.4) Create `Makefile' files in various other directoriesfrom the corresponding `Makefile.in' files. This isn't so hard,just a matter of substitution.The `configure' script is built from `configure.in' by the `autoconf'program. You need version 2.51 or newer of `autoconf' to rebuild`configure'.BUILDING GNU EMACS BY HANDOnce Emacs is configured, running `make' in the top directory performsthe following steps.1) Run `make src/paths.h' in the top directory. This produces`./src/paths.h' from the template file `./src/paths.in', changingthe paths to the values specified in `./Makefile'.2) Go to directory `./lib-src' and run `make'. This createsexecutables named `ctags' and `etags' and `make-docfile' and`digest-doc' and `test-distrib'. And others.3) Go to directory `./src' and Run `make'. This refers to files inthe `./lisp' and `./lib-src' subdirectories using names `../lisp' and`../lib-src'.This creates a file `./src/emacs' which is the runnable Emacs,which has another name that contains a version number.Each time you do this, that version number increments in the last place.It also creates a file in `./etc' whose name is `DOC' followed by thecurrent Emacs version. This file contains documentation strings forall the functions in Emacs. Each time you run make to make a newemacs, a new DOC file with a new name is made. You must keep the DOCfile for an Emacs version as long as you keep using that Emacsversion.INSTALLATION BY HANDThe steps below are done by running `make install' in the maindirectory of the Emacs distribution.1) Copy `./lisp' and its subdirectories, `./etc', and the executablesin `./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.- The programs `cvtmail', `fakemail', `hexl', `movemail', `profile', `rcs2log', and `vcdiff' are used by Emacs; they do need to be copied.- The programs `etags', `ctags', `emacsclient', `b2m', and `rcs-checkin' are intended to be run by users; they are handled below.- The programs `make-docfile' and `test-distrib' were 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 thedestination directory already contains a file named `dir', youprobably don't want to replace it with the `dir' file in the Emacsdistribution. Instead, you should make sure that the existing `dir'file contains an appropriate menu entry for the Emacs info.3) Copy `./src/emacs' to `/usr/local/bin', or to some other directoryin 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 wayof installing different versions.You can delete `./src/temacs'.4) Copy the programs `b2m', `emacsclient', `ctags', `etags', and`rcs-checkin' from `./lib-src' to `/usr/local/bin'. These programs areintended for users to run.5) Copy the man pages in `./etc' for emacs, ctags, and etags into theappropriate man directories.6) The files in the `./src' subdirectory, except for `emacs', are notused by Emacs once it is built. However, it is very desirable to keepthe source on line for debugging.PROBLEMSSee the file PROBLEMS in etc subdirectory for a list of variousproblems sometimes encountered, and what to do about them.Installation on MSDOG (a.k.a. MSDOS)To install on MSDOG, you need to have the GNU C compiler for MSDOG(also known as djgpp), GNU Make, rm, mv, and sed. See the remarks inconfig.bat for more information about locations and versions. Thefile etc/FAQ includes pointers to Internet sites where you can findthe necessary utilities; search for "MS-DOS". The configuration step(see below) will test for these utilities and will refuse to continueif any of them isn't found.Recompiling Lisp files in the `lisp' subdirectory using the varioustargets 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' (fromTextutils), and a port of Bash. However, you should not normally needto run lisp/Makefile, as all the Lisp files are distributed inbyte-compiled form as well.If you are building the MSDOG version of Emacs on an MSDOG-like systemwhich supports long file names (e.g. Windows 95), you need to makesure that long file names are handled consistently both when youunpack the distribution and compile it. If you intend to compile withDJGPP v2.0 or later, and long file names support is enabled (LFN=y inthe environment), you need to unpack Emacs distribution in a way thatdoesn'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 withDJGPP, since it will note the LFN setting and behave accordingly.DJGPP v1 doesn't support long filenames, so you must unpack Emacs witha program that truncates the filenames to 8.3 naming as it extractsfiles; 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 ofyour tools don't support long file names: just ensure that LFN is setto `n' during both unpacking and compiling.(By the time you read this, you have already unpacked the Emacsdistribution, but if the explanations above imply that you should havedone it differently, it's safer to delete the directory tree createdby the unpacking program and unpack Emacs again, than to risk runninginto problems during the build process.)It is important to understand that the runtime support of long filenames by the Emacs binary is NOT affected by the LFN setting duringcompilation; Emacs compiled with DJGPP v2.0 or later will alwayssupport long file names on Windows 9X no matter what was the settingof LFN at compile time. However, if you compiled with LFN disabledand want to enable LFN support after Emacs was already built, you needto make sure that the support files in the lisp, etc and infodirectories are called by their original long names as found in thedistribution. You can do this either by renaming the files manually,or by extracting them from the original distribution archive withdjtar after you set LFN=y in the environment.To unpack Emacs with djtar, type this command: djtar -x emacs.tgz(This assumes that the Emacs distribution is called `emacs.tgz' onyour system.)If you want to print international characters, install the intlfontsdistribution. For this, create a directory called `fonts' under theEmacs top-level directory (usually called `emacs-XX.YY') created byunpacking emacs.tgz, chdir into the directory emacs-XX.YY/fonts, andtype this: djtar -x intlfonts.tgzWhen unpacking is done, a directory called `emacs-XX.YY' will becreated, where XX.YY is the Emacs version. To build and installEmacs, chdir to that directory and type these commands: config msdos make installRunning "config msdos" checks for several programs that are requiredto configure and build Emacs; if one of those programs is not found,CONFIG.BAT stops and prints an error message. If you have DJGPPversion 2.0 or 2.01, it will complain about a program calledDJECHO.EXE. These old versions of DJGPP shipped that program underthe name ECHO.EXE, so you can simply copy ECHO.EXE to DJECHO.EXE andrerun CONFIG.BAT. If you have neither ECHO.EXE nor DJECHO.EXE, youshould be able to find them in your djdevNNN.zip archive (where NNN isthe DJGPP version number).On Windows NT or Windows 2000, running "config msdos" might print anerror message like "VDM has been already loaded". This is becausethose systems have a program called `redir.exe' which is incompatiblewith a program by the same name supplied with DJGPP, which is used byconfig.bat. To resolve this, move the DJGPP's `bin' subdirectory tothe front of your PATH environment variable.To install the international fonts, chdir to the intlfonts-X.Ydirectory created when you unpacked the intlfonts distribution (X.Y isthe version number of the fonts' distribution), and type the followingcommand: make bdf INSTALLDIR=..After Make finishes, you may remove the directory intlfonts-X.Y; thefonts are installed into the fonts/bdf subdirectory of the top-levelEmacs directory, and that is where Emacs will look for them bydefault.Building Emacs creates executable files in the src and lib-srcdirectories. Installing Emacs on MSDOS moves these executables to asibling 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 thesubdirectories /emacs/src and /emacs/lib-src if you wish. The onlysubdirectories you need to keep are bin, lisp, etc and info. (If youinstalled intlfonts, keep the fonts directory and all itssubdirectories as well.) The bin subdirectory should be added to yourPATH. The msdos subdirectory includes a PIF and an icon file forEmacs which you might find useful if you run Emacs under MS Windows.Emacs on MSDOS finds the lisp, etc and info directories by looking in../lisp, ../etc and ../info, starting from the directory where theEmacs executable was run from. You can override this by setting theenvironment variables EMACSDATA (for the location of `etc' directory),EMACSLOADPATH (for the location of `lisp' directory) and INFOPATH (forthe location of the `info' directory).MSDOG is a not a multitasking operating system, so Emacs features suchas asynchronous subprocesses that depend on multitasking will notwork. Synchronous subprocesses do work.Version 2.0 of djgpp has two bugs that affect Emacs. We've includedcorrected versions of two files from djgpp in the msdos subdirectory:is_exec.c and sigaction.c. To work around the bugs, compile thesefiles and link them into temacs. Djgpp versions 2.01 and later havethese bugs fixed, so upgrade if you can before building Emacs.This file is part of GNU Emacs.GNU Emacs is free software; you can redistribute it and/or modifyit under the terms of the GNU General Public License as published bythe Free Software Foundation; either version 3, or (at your option)any later version.GNU Emacs is distributed in the hope that it will be useful,but WITHOUT ANY WARRANTY; without even the implied warranty ofMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See theGNU General Public License for more details.You should have received a copy of the GNU General Public Licensealong with GNU Emacs; see the file COPYING. If not, write to theFree Software Foundation, Inc., 51 Franklin Street, Fifth Floor,Boston, MA 02110-1301, USA.