INSTALL 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682
  1. GNU Emacs Installation Guide
  2. Copyright (C) 1992, 1994, 1996-1997, 2000-2017 Free Software Foundation,
  3. Inc.
  4. See the end of the file for license conditions.
  5. This file contains general information on building GNU Emacs.
  6. For more information specific to the MS-Windows, GNUstep/macOS, and
  7. MS-DOS ports, also read the files nt/INSTALL, nextstep/INSTALL, and
  8. msdos/INSTALL. For information about building from a repository checkout
  9. (rather than a release), also read the file INSTALL.REPO.
  10. BASIC INSTALLATION
  11. On most Unix systems, you build Emacs by first running the 'configure'
  12. shell script. This attempts to deduce the correct values for
  13. various system-dependent variables and features, and find the
  14. directories where certain system headers and libraries are kept.
  15. In a few cases, you may need to explicitly tell configure where to
  16. find some things, or what options to use.
  17. 'configure' creates a 'Makefile' in several subdirectories, and a
  18. 'src/config.h' file containing system-dependent definitions.
  19. Running the 'make' utility then builds the package for your system.
  20. Building Emacs requires GNU make, <http://www.gnu.org/software/make/>.
  21. On most systems that Emacs supports, this is the default 'make' program.
  22. Here's the procedure to build Emacs using 'configure' on systems which
  23. are supported by it. In some cases, if the simplified procedure fails,
  24. you might need to use various non-default options, and maybe perform
  25. some of the steps manually. The more detailed description in the other
  26. sections of this guide will help you do that, so please refer to those
  27. sections if you need to.
  28. 1. Unpacking the Emacs 25 release requires about 200 MB of free
  29. disk space. Building Emacs uses about another 200 MB of space.
  30. The final installed Emacs uses about 150 MB of disk space.
  31. This includes the space-saving that comes from automatically
  32. compressing the Lisp source files on installation.
  33. 2a. 'cd' to the directory where you unpacked Emacs and invoke the
  34. 'configure' script:
  35. ./configure
  36. 2b. Alternatively, create a separate directory, outside the source
  37. directory, where you want to build Emacs, and invoke 'configure'
  38. from there:
  39. SOURCE-DIR/configure
  40. where SOURCE-DIR is the top-level Emacs source directory.
  41. 3. When 'configure' finishes, it prints several lines of details
  42. about the system configuration. Read those details carefully
  43. looking for anything suspicious, such as wrong CPU and operating
  44. system names, wrong places for headers or libraries, missing
  45. libraries that you know are installed on your system, etc.
  46. If you find anything wrong, you may have to pass to 'configure'
  47. one or more options specifying the explicit machine configuration
  48. name, where to find various headers and libraries, etc.
  49. Refer to the section DETAILED BUILDING AND INSTALLATION below.
  50. If 'configure' didn't find some image support libraries, such as
  51. Xpm and jpeg, refer to "Image support libraries" below.
  52. If the details printed by 'configure' don't make any sense to
  53. you, but there are no obvious errors, assume that 'configure' did
  54. its job and proceed.
  55. 4. Invoke the 'make' program:
  56. make
  57. 5. If 'make' succeeds, it will build an executable program 'emacs'
  58. in the 'src' directory. You can try this program, to make sure
  59. it works:
  60. src/emacs -Q
  61. 6. Assuming that the program 'src/emacs' starts and displays its
  62. opening screen, you can install the program and its auxiliary
  63. files into their installation directories:
  64. make install
  65. You are now ready to use Emacs. If you wish to conserve disk space,
  66. you may remove the program binaries and object files from the
  67. directory where you built Emacs:
  68. make clean
  69. You can delete the entire build directory if you do not plan to
  70. build Emacs again, but it can be useful to keep for debugging.
  71. If you want to build Emacs again with different configure options,
  72. first clean the source directories:
  73. make distclean
  74. Note that the install automatically saves space by compressing
  75. (provided you have the 'gzip' program) those installed Lisp source (.el)
  76. files that have corresponding .elc versions, as well as the Info files.
  77. ADDITIONAL DISTRIBUTION FILES
  78. * Complex Text Layout support libraries
  79. On GNU and Unix systems, Emacs needs the optional libraries "m17n-db",
  80. "libm17n-flt", "libotf" to correctly display such complex scripts as
  81. Indic and Khmer, and also for scripts that require Arabic shaping
  82. support (Arabic and Farsi). On some systems, particularly GNU/Linux,
  83. these libraries may be already present or available as additional
  84. packages. Note that if there is a separate 'dev' or 'devel' package,
  85. for use at compilation time rather than run time, you will need that
  86. as well as the corresponding run time package; typically the dev
  87. package will contain header files and a library archive. Otherwise,
  88. you can download the libraries from <http://www.nongnu.org/m17n/>.
  89. Note that Emacs cannot support complex scripts on a TTY, unless the
  90. terminal includes such a support.
  91. * intlfonts-VERSION.tar.gz
  92. The intlfonts distribution contains X11 fonts in various encodings
  93. that Emacs can use to display international characters. If you see a
  94. non-ASCII character appear as a hollow box, that means you don't have
  95. a font for it. You might find one in the intlfonts distribution. If
  96. you do have a font for a non-ASCII character, but some characters
  97. don't look right, or appear improperly aligned, a font from the
  98. intlfonts distribution might look better.
  99. The fonts in the intlfonts distribution are also used by the ps-print
  100. package for printing international characters. The file
  101. lisp/ps-mule.el defines the *.bdf font files required for printing
  102. each character set.
  103. The intlfonts distribution contains its own installation instructions,
  104. in the intlfonts/README file.
  105. * Image support libraries
  106. Emacs needs libraries to display images, with the exception of PBM and
  107. XBM images whose support is built-in.
  108. On some systems, particularly on GNU/Linux, these libraries may
  109. already be present or available as additional packages. If
  110. there is a separate 'dev' or 'devel' package, for use at compilation
  111. time rather than run time, you will need that as well as the
  112. corresponding run time package; typically the dev package will
  113. contain header files and a library archive. Otherwise, you can
  114. download and build libraries from sources. Although none of them are
  115. essential for running Emacs, some are important enough that
  116. 'configure' will report an error if they are absent from a system that
  117. has X11 support, unless 'configure' is specifically told to omit them.
  118. Here's a list of some of these libraries, and the URLs where they
  119. can be found (in the unlikely event that your distribution does not
  120. provide them). By default, libraries marked with an X are required if
  121. X11 is being used.
  122. libXaw3d http://directory.fsf.org/project/xaw3d/
  123. X libxpm for XPM: http://www.x.org/releases/current/src/lib/
  124. X libpng for PNG: http://www.libpng.org/
  125. libz (for PNG): http://www.zlib.net/
  126. X libjpeg for JPEG: http://www.ijg.org/
  127. X libtiff for TIFF: http://www.remotesensing.org/libtiff/
  128. X libgif for GIF: http://sourceforge.net/projects/giflib/
  129. librsvg2 for SVG: http://wiki.gnome.org/action/show/Projects/LibRsvg
  130. If you supply the appropriate --without-LIB option, 'configure' will
  131. omit the corresponding library from Emacs, even if that makes for a
  132. less-pleasant user interface. Otherwise, Emacs will configure itself
  133. to build with these libraries if 'configure' finds them on your
  134. system, and 'configure' will complain and exit if a library marked 'X'
  135. is not found on a system that uses X11. Use --without-LIB if your
  136. version of a library won't work because some routines are missing.
  137. * Extra fonts
  138. The Emacs distribution does not include fonts and does not install
  139. them.
  140. On the GNU system, Emacs supports both X fonts and local fonts
  141. (i.e. fonts managed by the fontconfig library). If you need more
  142. fonts than your distribution normally provides, you must install them
  143. yourself. See <URL:http://www.gnu.org/software/freefont/> for a large
  144. number of free Unicode fonts.
  145. * GNU/Linux development packages
  146. Many GNU/Linux systems do not come with development packages by default;
  147. they include the files that you need to run Emacs, but not those you
  148. need to compile it. For example, to compile Emacs with support for X
  149. and graphics libraries, you may need to install the X development
  150. package(s), and development versions of the jpeg, png, etc. packages.
  151. The names of the packages that you need varies according to the
  152. GNU/Linux distribution that you use, and the options that you want to
  153. configure Emacs with. On Debian-based systems, you can install all the
  154. packages needed to build the installed version of Emacs with a command
  155. like 'apt-get build-dep emacs24'. On Red Hat systems, the
  156. corresponding command is 'yum-builddep emacs'.
  157. DETAILED BUILDING AND INSTALLATION:
  158. (This is for a Unix or Unix-like system. For GNUstep and macOS,
  159. see nextstep/INSTALL. For non-ancient versions of MS Windows, see
  160. the file nt/INSTALL. For MS-DOS and MS Windows 3.X, see msdos/INSTALL.)
  161. 1) See the basic installation summary above for the disk space requirements.
  162. 2) In the unlikely event that 'configure' does not detect your system
  163. type correctly, consult './etc/MACHINES' to see what --host, --build
  164. options you should pass to 'configure'. That file also offers hints
  165. for getting around some possible installation problems.
  166. 3) You can build Emacs in the top-level Emacs source directory
  167. or in a separate directory.
  168. 3a) To build in the top-level Emacs source directory, go to that
  169. directory and run the program 'configure' as follows:
  170. ./configure [--OPTION[=VALUE]] ...
  171. If 'configure' cannot determine your system type, try again
  172. specifying the proper --build, --host options explicitly.
  173. If you don't want X support, specify '--with-x=no'. If you omit this
  174. option, 'configure' will try to figure out for itself whether your
  175. system has X, and arrange to use it if present.
  176. The '--x-includes=DIR' and '--x-libraries=DIR' options tell the build
  177. process where the compiler should look for the include files and
  178. object libraries used with the X Window System. Normally, 'configure'
  179. is able to find them; these options are necessary if you have your X
  180. Window System files installed in unusual places. These options also
  181. accept a list of directories, separated with colons.
  182. To get more attractive menus, you can specify an X toolkit when you
  183. configure Emacs; use the option '--with-x-toolkit=TOOLKIT', where
  184. TOOLKIT is 'gtk' (the default), 'athena', or 'motif' ('yes' and
  185. 'lucid' are synonyms for 'athena'). Compiling with Motif causes a
  186. standard File Selection Dialog to pop up when you invoke file commands
  187. with the mouse. You can get fancy 3D-style scroll bars, even without
  188. Gtk or Motif, if you have the Xaw3d library installed (see
  189. "Image support libraries" above for Xaw3d availability).
  190. You can tell configure where to search for GTK by giving it the
  191. argument PKG_CONFIG='/full/name/of/pkg-config'.
  192. Emacs will autolaunch a D-Bus session bus, when the environment
  193. variable DISPLAY is set, but no session bus is running. This might be
  194. inconvenient for Emacs when running as daemon or running via a remote
  195. ssh connection. In order to completely prevent the use of D-Bus, configure
  196. Emacs with the options '--without-dbus --without-gconf --without-gsettings'.
  197. To read email via a network protocol like IMAP or POP, you can
  198. configure Emacs with the option '--with-mailutils', so that it always
  199. uses the GNU Mailutils 'movemail' program to retrieve mail; this is
  200. the default if GNU Mailutils is installed. Otherwise the Emacs build
  201. procedure builds and installs an auxiliary 'movemail' program, a
  202. limited and insecure substitute; when this happens, there are several
  203. configure options such as --without-pop that provide fine-grained
  204. control over Emacs 'movemail' construction.
  205. The Emacs mail reader RMAIL is configured to be able to read mail from
  206. a POP3 server by default. Versions of the POP protocol older than
  207. POP3 are not supported. While POP3 support is typically enabled,
  208. whether Emacs actually uses POP3 is controlled by individual users;
  209. see the Rmail chapter of the Emacs manual. Unless --with-mailutils is
  210. in effect, it is a good idea to configure --without-pop so that users
  211. are less likely to inadvertently read email via insecure channels.
  212. For image support you may have to download, build, and install the
  213. appropriate image support libraries for image types other than XBM and
  214. PBM, see the list of URLs in "Image support libraries" above.
  215. (Note that PNG support requires libz in addition to libpng.)
  216. To disable individual types of image support in Emacs for some reason,
  217. even though configure finds the libraries, you can configure with one
  218. or more of these options:
  219. --without-xpm for XPM image support
  220. --without-jpeg for JPEG image support
  221. --without-tiff for TIFF image support
  222. --without-gif for GIF image support
  223. --without-png for PNG image support
  224. --without-rsvg for SVG image support
  225. --without-imagemagick for Imagemagick support
  226. Use --without-toolkit-scroll-bars to disable Motif or Xaw3d scroll bars.
  227. Use --without-xim to inhibit the default use of X Input Methods.
  228. In this case, the X resource useXIM can be used to turn on use of XIM.
  229. Use --disable-largefile to omit support for files larger than 2GB on
  230. systems which support that.
  231. Use --without-sound to disable sound support.
  232. Use --without-all for a smaller executable with fewer dependencies on
  233. external libraries, at the cost of disabling many features. Although
  234. --without-all disables libraries not needed for ordinary Emacs
  235. operation, it does enable X support, and using the GTK2 or GTK3
  236. toolkit creates a lot of library dependencies. So if you want to
  237. build a small executable with very basic X support, use --without-all
  238. --with-x-toolkit=no. For the smallest possible executable without X,
  239. use --without-all --without-x. If you want to build with just a few
  240. features enabled, you can combine --without-all with --with-FEATURE.
  241. For example, you can use --without-all --without-x --with-dbus to
  242. build with D-Bus support and nothing more.
  243. Use --with-wide-int to implement Emacs values with the type 'long long',
  244. even on hosts where a narrower type would do. With this option, on a
  245. typical 32-bit host, Emacs integers have 62 bits instead of 30.
  246. Use --with-cairo to compile Emacs with Cairo drawing.
  247. Use --with-modules to build Emacs with support for dynamic modules.
  248. This needs a C compiler that supports '__attribute__ ((cleanup (...)))',
  249. as in GCC 3.4 and later.
  250. Use --enable-gcc-warnings to enable compile-time checks that warn
  251. about possibly-questionable C code. This is intended for developers
  252. and is useful with GNU-compatible compilers. On a recent GNU system
  253. there should be no warnings; on older and on non-GNU systems the
  254. generated warnings may still be useful, though you may prefer
  255. configuring with --enable-gcc-warnings=warn-only so they are not
  256. treated as errors. The default is --enable-gcc-warnings=warn-only if
  257. it appears to be a developer build, and is --disable-gcc-warnings
  258. otherwise.
  259. Use --disable-silent-rules to cause 'make' to give more details about
  260. the commands it executes. This can be helpful when debugging a build
  261. that goes awry. 'make V=1' also enables the extra chatter.
  262. Use --enable-link-time-optimization to enable link-time optimization.
  263. With GCC, you need GCC 4.5.0 and later, and 'configure' arranges for
  264. linking to be parallelized if possible. With Clang, you need GNU
  265. binutils with the gold linker and plugin support, along with the LLVM
  266. gold plugin <http://llvm.org/docs/GoldPlugin.html>. Link time
  267. optimization is not the default as it tends to cause crashes and to
  268. make Emacs slower.
  269. The '--prefix=PREFIXDIR' option specifies where the installation process
  270. should put emacs and its data files. This defaults to '/usr/local'.
  271. - Emacs (and the other utilities users run) go in PREFIXDIR/bin
  272. (unless the '--exec-prefix' option says otherwise).
  273. - The architecture-independent files go in PREFIXDIR/share/emacs/VERSION
  274. (where VERSION is the version number of Emacs, like '23.2').
  275. - The architecture-dependent files go in
  276. PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION
  277. (where CONFIGURATION is the configuration name, like
  278. i686-pc-linux-gnu), unless the '--exec-prefix' option says otherwise.
  279. The '--exec-prefix=EXECDIR' option allows you to specify a separate
  280. portion of the directory tree for installing architecture-specific
  281. files, like executables and utility programs. If specified,
  282. - Emacs (and the other utilities users run) go in EXECDIR/bin, and
  283. - The architecture-dependent files go in
  284. EXECDIR/libexec/emacs/VERSION/CONFIGURATION.
  285. EXECDIR/bin should be a directory that is normally in users' PATHs.
  286. For example, the command
  287. ./configure --build=i386-linux-gnu --without-sound
  288. configures Emacs to build for a 32-bit GNU/Linux distribution,
  289. without sound support.
  290. 'configure' doesn't do any compilation or installation itself.
  291. It just creates the files that influence those things:
  292. './Makefile' in the top-level directory and several subdirectories;
  293. and './src/config.h'.
  294. When it is done, 'configure' prints a description of what it did and
  295. creates a shell script 'config.status' which, when run, recreates the
  296. same configuration. If 'configure' exits with an error after
  297. disturbing the status quo, it removes 'config.status'. 'configure'
  298. also creates a file 'config.cache' that saves the results of its tests
  299. to make reconfiguring faster, and a file 'config.log' containing compiler
  300. output (useful mainly for debugging 'configure'). You can give
  301. 'configure' the option '--cache-file=FILE' to use the results of the
  302. tests in FILE instead of 'config.cache'. Set FILE to '/dev/null' to
  303. disable caching, for debugging 'configure'.
  304. If the description of the system configuration printed by 'configure'
  305. is not right, or if it claims some of the features or libraries are not
  306. available when you know they are, look at the 'config.log' file for
  307. the trace of the failed tests performed by 'configure' to check
  308. whether these features are supported. Typically, some test fails
  309. because the compiler cannot find some function in the system
  310. libraries, or some macro-processor definition in the system headers.
  311. Some tests might fail because the compiler should look in special
  312. directories for some header files, or link against optional
  313. libraries, or use special compilation options. You can force
  314. 'configure' and the build process which follows it to do that by
  315. setting the variables CPPFLAGS, CFLAGS, LDFLAGS, LIBS, CPP and CC
  316. before running 'configure'. CPP is the command which invokes the
  317. preprocessor, CPPFLAGS lists the options passed to it, CFLAGS are
  318. compilation options, LDFLAGS are options used when linking, LIBS are
  319. libraries to link against, and CC is the command which invokes the
  320. compiler. By default, gcc is used if available.
  321. Here's an example of a 'configure' invocation, assuming a Bourne-like
  322. shell such as Bash, which uses these variables:
  323. ./configure \
  324. CPPFLAGS='-I/foo/myinclude' LDFLAGS='-L/bar/mylib' \
  325. CFLAGS='-O3' LIBS='-lfoo -lbar'
  326. (this is all one shell command). This tells 'configure' to instruct the
  327. preprocessor to look in the '/foo/myinclude' directory for header
  328. files (in addition to the standard directories), instruct the linker
  329. to look in '/bar/mylib' for libraries, pass the -O3 optimization
  330. switch to the compiler, and link against libfoo and libbar
  331. libraries in addition to the standard ones.
  332. For some libraries, like Gtk+, fontconfig and ALSA, 'configure' uses
  333. pkg-config to find where those libraries are installed.
  334. If you want pkg-config to look in special directories, you have to set
  335. PKG_CONFIG_PATH to point to the directories where the .pc-files for
  336. those libraries are. For example:
  337. ./configure \
  338. PKG_CONFIG_PATH='/usr/local/alsa/lib/pkgconfig:/opt/gtk+-2.8/lib/pkgconfig'
  339. 3b) To build in a separate directory, go to that directory
  340. and run the program 'configure' as follows:
  341. SOURCE-DIR/configure CONFIGURATION-NAME [--OPTION[=VALUE]] ...
  342. SOURCE-DIR refers to the top-level Emacs source directory which is
  343. where Emacs's configure script is located. 'configure' looks for the
  344. Emacs source code in the directory that 'configure' is in.
  345. 4) Put into './lisp/site-init.el' or './lisp/site-load.el' any Emacs
  346. Lisp code you want Emacs to load before it is dumped out. Use
  347. site-load.el for additional libraries if you arrange for their
  348. documentation strings to be in the etc/DOC file (see
  349. src/Makefile.in if you wish to figure out how to do that). For all
  350. else, use site-init.el. Do not load byte-compiled code which
  351. was built with a non-nil value of 'byte-compile-dynamic'.
  352. It is not a good idea to edit the normal .el files that come with Emacs.
  353. Instead, use a file like site-init.el to change settings.
  354. To change the value of a variable that is already defined in Emacs,
  355. you should use the Lisp function 'setq', not 'defvar'. For example,
  356. (setq news-inews-program "/usr/bin/inews")
  357. is how you would override the default value of the variable
  358. news-inews-program.
  359. Before you override a variable this way, *look at the value* that the
  360. variable gets by default! Make sure you know what kind of value the
  361. variable should have. If you don't pay attention to what you are
  362. doing, you'll make a mistake.
  363. The 'site-*.el' files are nonexistent in the distribution. You do not
  364. need to create them if you have nothing to put in them.
  365. 5) Refer to the file './etc/TERMS' for information on fields you may
  366. wish to add to various termcap entries. (This is unlikely to be necessary.)
  367. 6) Run 'make' in the top directory of the Emacs distribution to finish
  368. building Emacs in the standard way. The final executable file is
  369. named 'src/emacs'. You can execute this file "in place" without
  370. copying it, if you wish; then it automatically uses the sibling
  371. directories ../lisp, ../lib-src, ../info.
  372. Or you can "install" the executable and the other files into their
  373. installed locations, with 'make install'. By default, Emacs's files
  374. are installed in the following directories:
  375. '/usr/local/bin' holds the executable programs users normally run -
  376. 'emacs', 'etags', 'ctags', 'emacsclient'.
  377. '/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library;
  378. 'VERSION' stands for the number of the Emacs version
  379. you are installing, like '23.1' or '23.2'. Since the
  380. Lisp library changes from one version of Emacs to
  381. another, including the version number in the path
  382. allows you to have several versions of Emacs installed
  383. at the same time; in particular, you don't have to
  384. make Emacs unavailable while installing a new version.
  385. '/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
  386. file, and other architecture-independent files Emacs
  387. might need while running.
  388. '/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable
  389. programs used by Emacs that users are not expected to
  390. run themselves.
  391. 'VERSION' is the number of the Emacs version you are
  392. installing, and 'CONFIGURATION-NAME' is the value
  393. deduced by the 'configure' program to identify the
  394. architecture and operating system of your machine,
  395. like 'i686-pc-linux-gnu' or 'sparc-sun-sunos'. Since
  396. these files are specific to the version of Emacs,
  397. operating system, and architecture in use, including
  398. the configuration name in the path allows you to have
  399. several versions of Emacs for any mix of machines and
  400. operating systems installed at the same time; this is
  401. useful for sites at which different kinds of machines
  402. share the file system Emacs is installed on.
  403. '/usr/local/share/info' holds the on-line documentation for Emacs,
  404. known as "info files". Many other GNU programs are
  405. documented using info files as well, so this directory
  406. stands apart from the other, Emacs-specific directories.
  407. '/usr/local/share/man/man1' holds the man pages for the programs installed
  408. in '/usr/local/bin'.
  409. Any version of Emacs, whether installed or not, also looks for Lisp
  410. files in these directories.
  411. '/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp
  412. files installed for Emacs version VERSION only.
  413. '/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp
  414. files installed for all Emacs versions.
  415. When Emacs is installed, it searches for its Lisp files
  416. in '/usr/local/share/emacs/VERSION/site-lisp', then in
  417. '/usr/local/share/emacs/site-lisp', and finally in
  418. '/usr/local/share/emacs/VERSION/lisp'.
  419. If these directories are not what you want, you can specify where to
  420. install Emacs's libraries and data files or where Emacs should search
  421. for its Lisp files by giving values for 'make' variables as part of
  422. the command. See the section below called 'MAKE VARIABLES' for more
  423. information on this.
  424. 7) Check the file 'dir' in your site's info directory (usually
  425. /usr/local/share/info) to make sure that it has a menu entry for the
  426. Emacs info files.
  427. 8) If your system uses lock files to interlock access to mailer inbox files,
  428. and if --with-mailutils is not in effect, then you might need to
  429. make the Emacs-specific 'movemail' program setuid or setgid in order
  430. to enable it to write the lock files. We believe this is safe.
  431. 9) You are done! You can remove executables and object files from
  432. the build directory by typing 'make clean'. To also remove the files
  433. that 'configure' created (so you can compile Emacs for a different
  434. configuration), type 'make distclean'.
  435. MAKE VARIABLES
  436. You can change where the build process installs Emacs and its data
  437. files by specifying values for 'make' variables as part of the 'make'
  438. command line. For example, if you type
  439. make install bindir=/usr/local/gnubin
  440. the 'bindir=/usr/local/gnubin' argument indicates that the Emacs
  441. executable files should go in '/usr/local/gnubin', not
  442. '/usr/local/bin'.
  443. Here is a complete list of the variables you may want to set.
  444. 'bindir' indicates where to put executable programs that users can
  445. run. This defaults to /usr/local/bin.
  446. 'datadir' indicates where to put the architecture-independent
  447. read-only data files that Emacs refers to while it runs; it
  448. defaults to /usr/local/share. We create the following
  449. subdirectories under 'datadir':
  450. - 'emacs/VERSION/lisp', containing the Emacs Lisp library, and
  451. - 'emacs/VERSION/etc', containing the tutorials, DOC file, etc.
  452. 'VERSION' is the number of the Emacs version you are installing,
  453. like '23.1' or '23.2'. Since these files vary from one version
  454. of Emacs to another, including the version number in the path
  455. allows you to have several versions of Emacs installed at the
  456. same time; this means that you don't have to make Emacs
  457. unavailable while installing a new version.
  458. 'libexecdir' indicates where to put architecture-specific data files that
  459. Emacs refers to as it runs; it defaults to '/usr/local/libexec'.
  460. We create the following subdirectories under 'libexecdir':
  461. - 'emacs/VERSION/CONFIGURATION-NAME', containing executable
  462. programs used by Emacs that users are not expected to run
  463. themselves.
  464. 'VERSION' is the number of the Emacs version you are installing,
  465. and 'CONFIGURATION-NAME' is the value deduced by the
  466. 'configure' program to identify the architecture and operating
  467. system of your machine, like 'i686-pc-linux-gnu' or 'sparc-sun-sunos'.
  468. Since these files are specific to the version of Emacs,
  469. operating system, and architecture in use, including the
  470. configuration name in the path allows you to have several
  471. versions of Emacs for any mix of machines and operating
  472. systems installed at the same time; this is useful for sites
  473. at which different kinds of machines share the file system
  474. Emacs is installed on.
  475. 'infodir' indicates where to put the info files distributed with
  476. Emacs; it defaults to '/usr/local/share/info'.
  477. 'mandir' indicates where to put the man pages for Emacs and its
  478. utilities (like 'etags'); it defaults to
  479. '/usr/local/share/man/man1'.
  480. 'prefix' doesn't give a path for any specific part of Emacs; instead,
  481. its value is used to determine the defaults for all the
  482. architecture-independent path variables - 'datadir',
  483. 'sharedstatedir', 'infodir', and 'mandir'. Its default value is
  484. '/usr/local'; the other variables add on 'lib' or 'man' to it
  485. by default.
  486. For example, suppose your site generally places GNU software
  487. under '/usr/users/software/gnusoft' instead of '/usr/local'.
  488. By including
  489. 'prefix=/usr/users/software/gnusoft'
  490. in the arguments to 'make', you can instruct the build process
  491. to place all of the Emacs data files in the appropriate
  492. directories under that path.
  493. 'exec_prefix' serves the same purpose as 'prefix', but instead
  494. determines the default values for the architecture-dependent
  495. path variables - 'bindir' and 'libexecdir'.
  496. The above variables serve analogous purposes in the makefiles for all
  497. GNU software; the following variables are specific to Emacs.
  498. 'archlibdir' indicates where Emacs installs and expects the executable
  499. files and other architecture-dependent data it uses while
  500. running. Its default value, based on 'libexecdir' (which
  501. see), is '/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME'
  502. (where VERSION and CONFIGURATION-NAME are as described above).
  503. 'GZIP_PROG' is the name of the executable that compresses installed info,
  504. manual, and .el files. It defaults to gzip. Setting it to
  505. the empty string suppresses compression.
  506. Remember that you must specify any variable values you need each time
  507. you run 'make' in the top directory. If you run 'make' once to build
  508. emacs, test it, and then run 'make' again to install the files, you
  509. must provide the same variable settings each time. To make the
  510. settings persist, you can edit them into the 'Makefile' in the top
  511. directory, but be aware that running the 'configure' program erases
  512. 'Makefile' and rebuilds it from 'Makefile.in'.
  513. The path for finding Lisp files is specified in src/epaths.h,
  514. a file which is generated by running configure. To change the path,
  515. you can edit the definition of PATH_LOADSEARCH in that file
  516. before you run 'make'.
  517. The top-level Makefile stores the variable settings it used in the
  518. Makefiles for the subdirectories, so you don't have to specify them
  519. when running make in the subdirectories.
  520. PROBLEMS
  521. See the file './etc/PROBLEMS' for a list of various problems sometimes
  522. encountered, and what to do about them.
  523. This file is part of GNU Emacs.
  524. GNU Emacs is free software: you can redistribute it and/or modify
  525. it under the terms of the GNU General Public License as published by
  526. the Free Software Foundation, either version 3 of the License, or
  527. (at your option) any later version.
  528. GNU Emacs is distributed in the hope that it will be useful,
  529. but WITHOUT ANY WARRANTY; without even the implied warranty of
  530. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  531. GNU General Public License for more details.
  532. You should have received a copy of the GNU General Public License
  533. along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.