Commit | Line | Data |
---|---|---|
067d23c9 | 1 | GNU Emacs Installation Guide |
acaf905b | 2 | Copyright (C) 1992, 1994, 1996-1997, 2000-2012 |
067d23c9 KY |
3 | Free Software Foundation, Inc. |
4 | See the end of the file for license conditions. | |
5 | ||
6 | ||
7 | This file contains general information on building GNU Emacs. | |
8 | For more information specific to the MS-Windows, GNUstep/Mac OS X, and | |
9 | MS-DOS ports, also read the files nt/INSTALL, nextstep/INSTALL, and | |
10 | msdos/INSTALL. For information about building from a Bazaar checkout | |
11 | (rather than a release), also read the file INSTALL.BZR. | |
12 | ||
13 | ||
14 | BASIC INSTALLATION | |
15 | ||
16 | On most Unix systems, you build Emacs by first running the `configure' | |
17 | shell script. This attempts to deduce the correct values for | |
18 | various system-dependent variables and features, and find the | |
19 | directories where certain system headers and libraries are kept. | |
20 | In a few cases, you may need to explicitly tell configure where to | |
21 | find some things, or what options to use. | |
22 | ||
23 | `configure' creates a `Makefile' in several subdirectories, and a | |
24 | `src/config.h' file containing system-dependent definitions. | |
25 | Running the `make' utility then builds the package for your system. | |
26 | ||
27 | Here's the procedure to build Emacs using `configure' on systems which | |
28 | are supported by it. In some cases, if the simplified procedure fails, | |
29 | you might need to use various non-default options, and maybe perform | |
30 | some of the steps manually. The more detailed description in the other | |
31 | sections of this guide will help you do that, so please refer to those | |
32 | sections if you need to. | |
33 | ||
1c889bf6 GM |
34 | 1. Unpacking the Emacs 24.1 release requires about 180 MB of free |
35 | disk space. Building Emacs uses about another 70 MB of space. | |
36 | The final installed Emacs uses about 110 MB of disk space. | |
067d23c9 KY |
37 | This includes the space-saving that comes from automatically |
38 | compressing the Lisp source files on installation. | |
39 | ||
40 | 2a. `cd' to the directory where you unpacked Emacs and invoke the | |
41 | `configure' script: | |
42 | ||
43 | ./configure | |
44 | ||
45 | 2b. Alternatively, create a separate directory, outside the source | |
46 | directory, where you want to build Emacs, and invoke `configure' | |
47 | from there: | |
48 | ||
49 | SOURCE-DIR/configure | |
50 | ||
51 | where SOURCE-DIR is the top-level Emacs source directory. | |
52 | This may not work unless you use GNU make. | |
53 | ||
54 | 3. When `configure' finishes, it prints several lines of details | |
55 | about the system configuration. Read those details carefully | |
56 | looking for anything suspicious, such as wrong CPU and operating | |
57 | system names, wrong places for headers or libraries, missing | |
58 | libraries that you know are installed on your system, etc. | |
59 | ||
60 | If you find anything wrong, you may have to pass to `configure' | |
61 | one or more options specifying the explicit machine configuration | |
62 | name, where to find various headers and libraries, etc. | |
63 | Refer to the section DETAILED BUILDING AND INSTALLATION below. | |
64 | ||
65 | If `configure' didn't find some (optional) image support libraries, | |
66 | such as Xpm, jpeg, etc., and you want to use them, refer to the | |
67 | subsection "Image support libraries" below. | |
68 | ||
69 | If the details printed by `configure' don't make any sense to | |
70 | you, but there are no obvious errors, assume that `configure' did | |
71 | its job and proceed. | |
72 | ||
73 | 4. If you need to run the `configure' script more than once (e.g., | |
74 | with some non-default options), always clean the source | |
75 | directories before running `configure' again: | |
76 | ||
77 | make distclean | |
78 | ./configure | |
79 | ||
80 | 5. Invoke the `make' program: | |
81 | ||
82 | make | |
83 | ||
84 | 6. If `make' succeeds, it will build an executable program `emacs' | |
85 | in the `src' directory. You can try this program, to make sure | |
86 | it works: | |
87 | ||
88 | src/emacs -Q | |
89 | ||
90 | 7. Assuming that the program `src/emacs' starts and displays its | |
91 | opening screen, you can install the program and its auxiliary | |
92 | files into their installation directories: | |
93 | ||
94 | make install | |
95 | ||
96 | You are now ready to use Emacs. If you wish to conserve disk space, | |
97 | you may remove the program binaries and object files from the | |
98 | directory where you built Emacs: | |
99 | ||
100 | make clean | |
101 | ||
102 | You can delete the entire build directory if you do not plan to | |
103 | build Emacs again, but it can be useful to keep for debugging. | |
104 | ||
105 | Note that the install automatically saves space by compressing | |
106 | (provided you have the `gzip' program) those installed Lisp source (.el) | |
107 | files that have corresponding .elc versions, as well as the Info files. | |
108 | ||
109 | ||
110 | ADDITIONAL DISTRIBUTION FILES | |
111 | ||
112 | * Complex Text Layout support libraries | |
113 | ||
e1504b9b EZ |
114 | On GNU and Unix systems, Emacs needs the optional libraries "m17n-db", |
115 | "libm17n-flt", "libotf" to correctly display such complex scripts as | |
116 | Indic and Khmer, and also for scripts that require Arabic shaping | |
117 | support (Arabic and Farsi). On some systems, particularly GNU/Linux, | |
118 | these libraries may be already present or available as additional | |
119 | packages. Note that if there is a separate `dev' or `devel' package, | |
120 | for use at compilation time rather than run time, you will need that | |
121 | as well as the corresponding run time package; typically the dev | |
122 | package will contain header files and a library archive. Otherwise, | |
123 | you can download and build libraries from sources. | |
067d23c9 KY |
124 | |
125 | The sources of these libraries are available by anonymous CVS from | |
126 | cvs.m17n.org. | |
127 | ||
128 | % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/m17n login | |
129 | % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/m17n co m17n-db | |
130 | % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/m17n co m17n-lib | |
131 | % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/m17n co libotf | |
132 | ||
133 | For m17n-lib, if you have problems with making the whole package | |
134 | because you lack some other packages on which m17n-lib depends, try to | |
135 | configure it with the option "--without-gui". | |
136 | ||
e1504b9b EZ |
137 | Note that Emacs cannot support complex scripts on a TTY, unless the |
138 | terminal includes such a support. | |
139 | ||
067d23c9 KY |
140 | * intlfonts-VERSION.tar.gz |
141 | ||
142 | The intlfonts distribution contains X11 fonts in various encodings | |
143 | that Emacs can use to display international characters. If you see a | |
144 | non-ASCII character appear as a hollow box, that means you don't have | |
145 | a font for it. You might find one in the intlfonts distribution. If | |
146 | you do have a font for a non-ASCII character, but some characters | |
147 | don't look right, or appear improperly aligned, a font from the | |
148 | intlfonts distribution might look better. | |
149 | ||
150 | The fonts in the intlfonts distribution are also used by the ps-print | |
151 | package for printing international characters. The file | |
152 | lisp/ps-mule.el defines the *.bdf font files required for printing | |
153 | each character set. | |
154 | ||
155 | The intlfonts distribution contains its own installation instructions, | |
156 | in the intlfonts/README file. | |
157 | ||
158 | * Image support libraries | |
159 | ||
160 | Emacs needs optional libraries to be able to display images (with the | |
161 | exception of PBM and XBM images whose support is built-in). | |
162 | ||
163 | On some systems, particularly on GNU/Linux, these libraries may | |
164 | already be present or available as additional packages. Note that if | |
165 | there is a separate `dev' or `devel' package, for use at compilation | |
166 | time rather than run time, you will need that as well as the | |
167 | corresponding run time package; typically the dev package will | |
168 | contain header files and a library archive. Otherwise, you can | |
169 | download and build libraries from sources. None of them are vital for | |
170 | running Emacs; however, note that Emacs will not be able to use | |
171 | colored icons in the toolbar if XPM support is not compiled in. | |
172 | ||
173 | Here's the list of some of these optional libraries, and the URLs | |
174 | where they can be found (in the unlikely event that your distribution | |
175 | does not provide them): | |
176 | ||
177 | . libXaw3d http://directory.fsf.org/project/xaw3d/ | |
178 | . libxpm for XPM: http://www.x.org/releases/current/src/lib/ | |
179 | . libpng for PNG: http://www.libpng.org/ | |
180 | . libz (for PNG): http://www.zlib.net/ | |
181 | . libjpeg for JPEG: http://www.ijg.org/ | |
182 | . libtiff for TIFF: http://www.libtiff.org/ | |
183 | . libgif for GIF: http://sourceforge.net/projects/giflib/ | |
184 | ||
185 | Emacs will configure itself to build with these libraries if the | |
186 | `configure' script finds them on your system, unless you supply the | |
187 | appropriate --without-LIB option. In some cases, older versions of | |
188 | these libraries won't work because some routines are missing, and | |
189 | configure should avoid such old versions. If that happens, use the | |
190 | --without-LIB options to `configure', if you need to. | |
191 | ||
192 | * Extra fonts | |
193 | ||
194 | The Emacs distribution does not include fonts and does not install | |
195 | them. | |
196 | ||
197 | On the GNU system, Emacs supports both X fonts and local fonts | |
198 | (i.e. fonts managed by the fontconfig library). If you need more | |
199 | fonts than your distribution normally provides, you must install them | |
200 | yourself. See <URL:http://www.gnu.org/software/freefont/> for a large | |
201 | number of free Unicode fonts. | |
202 | ||
203 | * GNU/Linux development packages | |
204 | ||
205 | Many GNU/Linux systems do not come with development packages by default; | |
206 | they include the files that you need to run Emacs, but not those you | |
207 | need to compile it. For example, to compile Emacs with support for X | |
208 | and graphics libraries, you may need to install the `X development' | |
209 | package(s), and development versions of the jpeg, png, etc. packages. | |
210 | ||
211 | The names of the packages that you need varies according to the | |
212 | GNU/Linux distribution that you use, and the options that you want to | |
213 | configure Emacs with. On Debian-based systems, you can install all the | |
214 | packages needed to build the installed version of Emacs with a command | |
1d8d4d70 GM |
215 | like `apt-get build-dep emacs23'. On Red Hat systems, the |
216 | corresponding command is `yum-builddep emacs'. | |
067d23c9 KY |
217 | |
218 | ||
219 | DETAILED BUILDING AND INSTALLATION: | |
220 | ||
221 | (This is for a Unix or Unix-like system. For MS-DOS and MS Windows 3.X, | |
222 | see msdos/INSTALL. For later versions of MS Windows, see the file | |
223 | nt/INSTALL. For GNUstep and Mac OS X, see nextstep/INSTALL.) | |
224 | ||
225 | 1) Make sure your system has enough swapping space allocated to handle | |
226 | a program whose pure code is 1.5 MB and whose data area is at | |
227 | least 2.8 MB and can reach 100 MB or more. If the swapping space is | |
228 | insufficient, you will get an error in the command `temacs -batch -l | |
229 | loadup dump', found in `./src/Makefile.in', or possibly when | |
230 | running the final dumped Emacs. (This should not be an issue | |
231 | on any recent system.) | |
232 | ||
233 | Building Emacs requires about 230 MB of disk space (including the | |
234 | Emacs sources). Once installed, Emacs occupies about 120 MB in the file | |
235 | system where it is installed; this includes the executable files, Lisp | |
236 | libraries, miscellaneous data files, and on-line documentation. If | |
237 | the building and installation take place in different directories, | |
238 | then the installation procedure momentarily requires 230+120 MB. | |
239 | ||
240 | 2) In the unlikely event that `configure' does not detect your system | |
241 | type correctly, consult `./etc/MACHINES' to see what --host, --build | |
242 | options you should pass to `configure'. That file also offers hints | |
243 | for getting around some possible installation problems. | |
244 | ||
245 | 3) You can build Emacs in the top-level Emacs source directory | |
246 | or in a separate directory. | |
247 | ||
248 | 3a) To build in the top-level Emacs source directory, go to that | |
249 | directory and run the program `configure' as follows: | |
250 | ||
251 | ./configure [--OPTION[=VALUE]] ... | |
252 | ||
253 | If `configure' cannot determine your system type, try again | |
254 | specifying the proper --build, --host options explicitly. | |
255 | ||
256 | If you don't want X support, specify `--with-x=no'. If you omit this | |
257 | option, `configure' will try to figure out for itself whether your | |
258 | system has X, and arrange to use it if present. | |
259 | ||
260 | The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build | |
261 | process where the compiler should look for the include files and | |
262 | object libraries used with the X Window System. Normally, `configure' | |
263 | is able to find them; these options are necessary if you have your X | |
264 | Window System files installed in unusual places. These options also | |
265 | accept a list of directories, separated with colons. | |
266 | ||
267 | To get more attractive menus, you can specify an X toolkit when you | |
268 | configure Emacs; use the option `--with-x-toolkit=TOOLKIT', where | |
269 | TOOLKIT is `gtk' (the default), `athena', or `motif' (`yes' and | |
270 | `lucid' are synonyms for `athena'). On some systems, it does not work | |
271 | to use a toolkit with shared libraries. A free implementation of | |
272 | Motif, called LessTif, is available from <http://www.lesstif.org>. | |
273 | Compiling with LessTif or Motif causes a standard File Selection | |
274 | Dialog to pop up when you invoke file commands with the mouse. You | |
275 | can get fancy 3D-style scroll bars, even without Gtk or LessTif/Motif, | |
276 | if you have the Xaw3d library installed (see "Image support libraries" | |
277 | above for Xaw3d availability). | |
278 | ||
279 | You can tell configure where to search for GTK by specifying | |
280 | `--with-pkg-config-prog=PATH' where PATH is the pathname to | |
281 | pkg-config. Note that GTK version 2.6 or newer is required for Emacs. | |
282 | ||
283 | The Emacs mail reader RMAIL is configured to be able to read mail from | |
284 | a POP3 server by default. Versions of the POP protocol older than | |
285 | POP3 are not supported. For Kerberos-authenticated POP add | |
286 | `--with-kerberos', for Hesiod support add `--with-hesiod'. While POP3 | |
287 | is always enabled, whether Emacs actually uses POP is controlled by | |
288 | individual users--see the Rmail chapter of the Emacs manual. | |
289 | ||
290 | For image support you may have to download, build, and install the | |
291 | appropriate image support libraries for image types other than XBM and | |
292 | PBM, see the list of URLs in "ADDITIONAL DISTRIBUTION FILES" above. | |
293 | (Note that PNG support requires libz in addition to libpng.) | |
294 | ||
295 | To disable individual types of image support in Emacs for some reason, | |
296 | even though configure finds the libraries, you can configure with one | |
297 | or more of these options: | |
298 | ||
299 | --without-xpm for XPM image support | |
300 | --without-jpeg for JPEG image support | |
301 | --without-tiff for TIFF image support | |
302 | --without-gif for GIF image support | |
303 | --without-png for PNG image support | |
304 | ||
305 | Use --without-toolkit-scroll-bars to disable LessTif/Motif or Xaw3d | |
306 | scroll bars. | |
307 | ||
308 | Use --without-xim to inhibit the default use of X Input Methods. | |
309 | In this case, the X resource useXIM can be used to turn on use of XIM. | |
310 | ||
311 | Use --disable-largefile to omit support for files larger than 2GB on | |
312 | systems which support that. | |
313 | ||
314 | Use --without-sound to disable sound support. | |
315 | ||
81eafe29 PE |
316 | Use --with-wide-int to implement Emacs values with the type 'long long', |
317 | even on hosts where a narrower type would do. With this option, on a | |
318 | typical 32-bit host, Emacs integers have 62 bits instead of 30. | |
319 | ||
067d23c9 KY |
320 | The `--prefix=PREFIXDIR' option specifies where the installation process |
321 | should put emacs and its data files. This defaults to `/usr/local'. | |
322 | - Emacs (and the other utilities users run) go in PREFIXDIR/bin | |
323 | (unless the `--exec-prefix' option says otherwise). | |
324 | - The architecture-independent files go in PREFIXDIR/share/emacs/VERSION | |
325 | (where VERSION is the version number of Emacs, like `23.2'). | |
326 | - The architecture-dependent files go in | |
327 | PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION | |
328 | (where CONFIGURATION is the configuration name, like | |
329 | i686-pc-linux-gnu), unless the `--exec-prefix' option says otherwise. | |
330 | ||
331 | The `--exec-prefix=EXECDIR' option allows you to specify a separate | |
332 | portion of the directory tree for installing architecture-specific | |
333 | files, like executables and utility programs. If specified, | |
334 | - Emacs (and the other utilities users run) go in EXECDIR/bin, and | |
335 | - The architecture-dependent files go in | |
336 | EXECDIR/libexec/emacs/VERSION/CONFIGURATION. | |
337 | EXECDIR/bin should be a directory that is normally in users' PATHs. | |
338 | ||
339 | For example, the command | |
340 | ||
341 | ./configure --build=i386-linux-gnu --without-sound | |
342 | ||
343 | configures Emacs to build for a 32-bit GNU/Linux distribution, | |
344 | without sound support. | |
345 | ||
346 | `configure' doesn't do any compilation or installation itself. | |
347 | It just creates the files that influence those things: | |
348 | `./Makefile' in the top-level directory and several subdirectories; | |
349 | and `./src/config.h'. For details on exactly what it does, see the | |
350 | section called `CONFIGURATION BY HAND', below. | |
351 | ||
352 | When it is done, `configure' prints a description of what it did and | |
353 | creates a shell script `config.status' which, when run, recreates the | |
354 | same configuration. If `configure' exits with an error after | |
355 | disturbing the status quo, it removes `config.status'. `configure' | |
356 | also creates a file `config.cache' that saves the results of its tests | |
357 | to make reconfiguring faster, and a file `config.log' containing compiler | |
358 | output (useful mainly for debugging `configure'). You can give | |
359 | `configure' the option `--cache-file=FILE' to use the results of the | |
360 | tests in FILE instead of `config.cache'. Set FILE to `/dev/null' to | |
361 | disable caching, for debugging `configure'. | |
362 | ||
363 | If the description of the system configuration printed by `configure' | |
364 | is not right, or if it claims some of the features or libraries are not | |
365 | available when you know they are, look at the `config.log' file for | |
366 | the trace of the failed tests performed by `configure' to check | |
367 | whether these features are supported. Typically, some test fails | |
368 | because the compiler cannot find some function in the system | |
369 | libraries, or some macro-processor definition in the system headers. | |
370 | ||
371 | Some tests might fail because the compiler should look in special | |
372 | directories for some header files, or link against optional | |
373 | libraries, or use special compilation options. You can force | |
374 | `configure' and the build process which follows it to do that by | |
375 | setting the variables CPPFLAGS, CFLAGS, LDFLAGS, LIBS, CPP and CC | |
376 | before running `configure'. CPP is the command which invokes the | |
377 | preprocessor, CPPFLAGS lists the options passed to it, CFLAGS are | |
378 | compilation options, LDFLAGS are options used when linking, LIBS are | |
379 | libraries to link against, and CC is the command which invokes the | |
380 | compiler. By default, gcc is used if available. | |
381 | ||
382 | Here's an example of a `configure' invocation, assuming a Bourne-like | |
383 | shell such as Bash, which uses these variables: | |
384 | ||
385 | CPPFLAGS='-I/foo/myinclude' LDFLAGS='-L/bar/mylib' \ | |
386 | CFLAGS='-O3' LIBS='-lfoo -lbar' ./configure | |
387 | ||
388 | (this is all one long line). This tells `configure' to instruct the | |
389 | preprocessor to look in the `/foo/myinclude' directory for header | |
390 | files (in addition to the standard directories), instruct the linker | |
391 | to look in `/bar/mylib' for libraries, pass the -O3 optimization | |
392 | switch to the compiler, and link against libfoo and libbar | |
393 | libraries in addition to the standard ones. | |
394 | ||
395 | For some libraries, like Gtk+, fontconfig and ALSA, `configure' uses | |
396 | pkg-config to find where those libraries are installed. | |
397 | If you want pkg-config to look in special directories, you have to set | |
398 | the environment variable PKG_CONFIG_PATH to point to the directories | |
399 | where the .pc-files for those libraries are. | |
400 | For example: | |
401 | ||
402 | PKG_CONFIG_PATH='/usr/local/alsa/lib/pkgconfig:/opt/gtk+-2.8/lib/pkgconfig' \ | |
403 | ./configure | |
404 | ||
405 | The work of `configure' can be done by editing various files in the | |
406 | distribution, but using `configure' is easier. See the section called | |
407 | "CONFIGURATION BY HAND" below if you want to do the configuration | |
408 | yourself. | |
409 | ||
410 | 3b) To build in a separate directory, go to that directory | |
411 | and run the program `configure' as follows: | |
412 | ||
413 | SOURCE-DIR/configure CONFIGURATION-NAME [--OPTION[=VALUE]] ... | |
414 | ||
415 | SOURCE-DIR refers to the top-level Emacs source directory which is | |
416 | where Emacs's configure script is located. `configure' looks for the | |
417 | Emacs source code in the directory that `configure' is in. | |
418 | ||
419 | To build in a separate directory, you must use a version of `make' | |
420 | that supports the `VPATH' variable, such as GNU `make'. | |
421 | ||
422 | (Do not try to build in a separate directory by creating many links | |
423 | to the real source directory--there is no need, and installation will | |
424 | fail.) | |
425 | ||
426 | 4) Look at `./lisp/paths.el'; if some of those values are not right | |
427 | for your system, set up the file `./lisp/site-init.el' with Emacs | |
428 | Lisp code to override them; it is not a good idea to edit paths.el | |
429 | itself. YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES, | |
430 | rather than `defvar', as used by `./lisp/paths.el'. For example, | |
431 | ||
432 | (setq news-inews-program "/usr/bin/inews") | |
433 | ||
434 | is how you would override the default value of the variable | |
435 | news-inews-program. | |
436 | ||
437 | Before you override a variable this way, *look at the value* that the | |
438 | variable gets by default! Make sure you know what kind of value the | |
439 | variable should have. If you don't pay attention to what you are | |
440 | doing, you'll make a mistake. | |
441 | ||
442 | 5) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs | |
443 | Lisp code you want Emacs to load before it is dumped out. Use | |
444 | site-load.el for additional libraries if you arrange for their | |
445 | documentation strings to be in the etc/DOC file (see | |
446 | src/Makefile.in if you wish to figure out how to do that). For all | |
447 | else, use site-init.el. Do not load byte-compiled code which | |
448 | was built with a non-nil value of `byte-compile-dynamic'. | |
449 | ||
450 | If you set load-path to a different value in site-init.el or | |
451 | site-load.el, Emacs will use *precisely* that value when it starts up | |
452 | again. If you do this, you are on your own! | |
453 | ||
454 | The `site-*.el' files are nonexistent in the distribution. You do not | |
455 | need to create them if you have nothing to put in them. | |
456 | ||
457 | 6) Refer to the file `./etc/TERMS' for information on fields you may | |
458 | wish to add to various termcap entries. (This is unlikely to be necessary.) | |
459 | ||
460 | 7) Run `make' in the top directory of the Emacs distribution to finish | |
461 | building Emacs in the standard way. The final executable file is | |
462 | named `src/emacs'. You can execute this file "in place" without | |
463 | copying it, if you wish; then it automatically uses the sibling | |
464 | directories ../lisp, ../lib-src, ../info. | |
465 | ||
466 | Or you can "install" the executable and the other files into their | |
467 | installed locations, with `make install'. By default, Emacs's files | |
468 | are installed in the following directories: | |
469 | ||
470 | `/usr/local/bin' holds the executable programs users normally run - | |
471 | `emacs', `etags', `ctags', `emacsclient', | |
472 | `grep-changelog', and `rcs-checkin'. | |
473 | ||
474 | `/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library; | |
475 | `VERSION' stands for the number of the Emacs version | |
476 | you are installing, like `23.1' or `23.2'. Since the | |
477 | Lisp library changes from one version of Emacs to | |
478 | another, including the version number in the path | |
479 | allows you to have several versions of Emacs installed | |
480 | at the same time; in particular, you don't have to | |
481 | make Emacs unavailable while installing a new version. | |
482 | ||
483 | `/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC | |
484 | file, and other architecture-independent files Emacs | |
485 | might need while running. | |
486 | ||
487 | `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable | |
488 | programs used by Emacs that users are not expected to | |
489 | run themselves. | |
490 | `VERSION' is the number of the Emacs version you are | |
491 | installing, and `CONFIGURATION-NAME' is the value | |
492 | deduced by the `configure' program to identify the | |
493 | architecture and operating system of your machine, | |
494 | like `i686-pc-linux-gnu' or `sparc-sun-sunos'. Since | |
495 | these files are specific to the version of Emacs, | |
496 | operating system, and architecture in use, including | |
497 | the configuration name in the path allows you to have | |
498 | several versions of Emacs for any mix of machines and | |
499 | operating systems installed at the same time; this is | |
500 | useful for sites at which different kinds of machines | |
501 | share the file system Emacs is installed on. | |
502 | ||
503 | `/usr/local/share/info' holds the on-line documentation for Emacs, | |
504 | known as "info files". Many other GNU programs are | |
505 | documented using info files as well, so this directory | |
506 | stands apart from the other, Emacs-specific directories. | |
507 | ||
508 | `/usr/local/share/man/man1' holds the man pages for the programs installed | |
509 | in `/usr/local/bin'. | |
510 | ||
511 | Any version of Emacs, whether installed or not, also looks for Lisp | |
512 | files in these directories. | |
513 | ||
514 | `/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp | |
515 | files installed for Emacs version VERSION only. | |
516 | ||
517 | `/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp | |
518 | files installed for all Emacs versions. | |
519 | ||
520 | When Emacs is installed, it searches for its Lisp files | |
521 | in `/usr/local/share/emacs/VERSION/site-lisp', then in | |
522 | `/usr/local/share/emacs/site-lisp', and finally in | |
523 | `/usr/local/share/emacs/VERSION/lisp'. | |
524 | ||
525 | If these directories are not what you want, you can specify where to | |
526 | install Emacs's libraries and data files or where Emacs should search | |
527 | for its Lisp files by giving values for `make' variables as part of | |
528 | the command. See the section below called `MAKE VARIABLES' for more | |
529 | information on this. | |
530 | ||
531 | 8) Check the file `dir' in your site's info directory (usually | |
532 | /usr/local/share/info) to make sure that it has a menu entry for the | |
533 | Emacs info files. | |
534 | ||
535 | 9) If your system uses lock files to interlock access to mailer inbox files, | |
536 | then you might need to make the movemail program setuid or setgid | |
537 | to enable it to write the lock files. We believe this is safe. | |
538 | ||
539 | 10) You are done! You can remove executables and object files from | |
540 | the build directory by typing `make clean'. To also remove the files | |
541 | that `configure' created (so you can compile Emacs for a different | |
542 | configuration), type `make distclean'. If you don't need some, or all | |
543 | of the input methods from the Leim package, you can remove the | |
544 | unneeded files in the leim subdirectories of your site's lisp | |
545 | directory (usually /usr/local/share/emacs/VERSION/). | |
546 | ||
547 | ||
548 | ||
549 | MAKE VARIABLES | |
550 | ||
551 | You can change where the build process installs Emacs and its data | |
552 | files by specifying values for `make' variables as part of the `make' | |
553 | command line. For example, if you type | |
554 | ||
555 | make install bindir=/usr/local/gnubin | |
556 | ||
557 | the `bindir=/usr/local/gnubin' argument indicates that the Emacs | |
558 | executable files should go in `/usr/local/gnubin', not | |
559 | `/usr/local/bin'. | |
560 | ||
561 | Here is a complete list of the variables you may want to set. | |
562 | ||
563 | `bindir' indicates where to put executable programs that users can | |
564 | run. This defaults to /usr/local/bin. | |
565 | ||
566 | `datadir' indicates where to put the architecture-independent | |
567 | read-only data files that Emacs refers to while it runs; it | |
568 | defaults to /usr/local/share. We create the following | |
569 | subdirectories under `datadir': | |
570 | - `emacs/VERSION/lisp', containing the Emacs Lisp library, and | |
571 | - `emacs/VERSION/etc', containing the tutorials, DOC file, etc. | |
572 | `VERSION' is the number of the Emacs version you are installing, | |
573 | like `23.1' or `23.2'. Since these files vary from one version | |
574 | of Emacs to another, including the version number in the path | |
575 | allows you to have several versions of Emacs installed at the | |
576 | same time; this means that you don't have to make Emacs | |
577 | unavailable while installing a new version. | |
578 | ||
579 | `libexecdir' indicates where to put architecture-specific data files that | |
580 | Emacs refers to as it runs; it defaults to `/usr/local/libexec'. | |
581 | We create the following subdirectories under `libexecdir': | |
582 | - `emacs/VERSION/CONFIGURATION-NAME', containing executable | |
583 | programs used by Emacs that users are not expected to run | |
584 | themselves. | |
585 | `VERSION' is the number of the Emacs version you are installing, | |
586 | and `CONFIGURATION-NAME' is the value deduced by the | |
587 | `configure' program to identify the architecture and operating | |
588 | system of your machine, like `i686-pc-linux-gnu' or `sparc-sun-sunos'. | |
589 | Since these files are specific to the version of Emacs, | |
590 | operating system, and architecture in use, including the | |
591 | configuration name in the path allows you to have several | |
592 | versions of Emacs for any mix of machines and operating | |
593 | systems installed at the same time; this is useful for sites | |
594 | at which different kinds of machines share the file system | |
595 | Emacs is installed on. | |
596 | ||
597 | `infodir' indicates where to put the info files distributed with | |
598 | Emacs; it defaults to `/usr/local/share/info'. | |
599 | ||
600 | `mandir' indicates where to put the man pages for Emacs and its | |
601 | utilities (like `etags'); it defaults to | |
602 | `/usr/local/share/man/man1'. | |
603 | ||
604 | `prefix' doesn't give a path for any specific part of Emacs; instead, | |
605 | its value is used to determine the defaults for all the | |
606 | architecture-independent path variables - `datadir', | |
607 | `sharedstatedir', `infodir', and `mandir'. Its default value is | |
608 | `/usr/local'; the other variables add on `lib' or `man' to it | |
609 | by default. | |
610 | ||
611 | For example, suppose your site generally places GNU software | |
612 | under `/usr/users/software/gnusoft' instead of `/usr/local'. | |
613 | By including | |
614 | `prefix=/usr/users/software/gnusoft' | |
615 | in the arguments to `make', you can instruct the build process | |
616 | to place all of the Emacs data files in the appropriate | |
617 | directories under that path. | |
618 | ||
619 | `exec_prefix' serves the same purpose as `prefix', but instead | |
620 | determines the default values for the architecture-dependent | |
621 | path variables - `bindir' and `libexecdir'. | |
622 | ||
623 | The above variables serve analogous purposes in the makefiles for all | |
624 | GNU software; the following variable is specific to Emacs. | |
625 | ||
626 | `archlibdir' indicates where Emacs installs and expects the executable | |
627 | files and other architecture-dependent data it uses while | |
628 | running. Its default value, based on `libexecdir' (which | |
629 | see), is `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' | |
630 | (where VERSION and CONFIGURATION-NAME are as described above). | |
631 | ||
632 | Remember that you must specify any variable values you need each time | |
633 | you run `make' in the top directory. If you run `make' once to build | |
634 | emacs, test it, and then run `make' again to install the files, you | |
635 | must provide the same variable settings each time. To make the | |
636 | settings persist, you can edit them into the `Makefile' in the top | |
637 | directory, but be aware that running the `configure' program erases | |
638 | `Makefile' and rebuilds it from `Makefile.in'. | |
639 | ||
640 | The path for finding Lisp files is specified in src/epaths.h, | |
641 | a file which is generated by running configure. To change the path, | |
642 | you can edit the definition of PATH_LOADSEARCH in that file | |
643 | before you run `make'. | |
644 | ||
645 | The top-level Makefile stores the variable settings it used in the | |
646 | Makefiles for the subdirectories, so you don't have to specify them | |
647 | when running make in the subdirectories. | |
648 | ||
649 | ||
650 | CONFIGURATION BY HAND | |
651 | ||
652 | This should not be necessary and is not recommended. Instead of | |
653 | running the `configure' program, you have to perform the following steps. | |
654 | ||
655 | 1) Copy `./src/config.in' to `./src/config.h'. | |
656 | ||
657 | 2) Consult `./etc/MACHINES' to see what configuration name you should | |
658 | use for your system. Look at the code of the `configure' script to | |
659 | see which operating system and architecture description files from | |
660 | `src/s' and `src/m' should be used for that configuration name. Edit | |
661 | `src/config.h', and change the two `#include' directives to include | |
662 | the appropriate system and architecture description files. | |
663 | ||
664 | 2) Edit `./src/config.h' to set the right options for your system. If | |
665 | you need to override any of the definitions in the s/*.h and m/*.h | |
666 | files for your system and machine, do so by editing config.h, not by | |
667 | changing the s/*.h and m/*.h files. | |
668 | ||
669 | 3) Create `Makefile' files in various directories from the | |
670 | corresponding `Makefile.in' files. This isn't so hard, just a matter | |
671 | of editing in appropriate substitutions for the @...@ constructs. | |
672 | ||
673 | The `configure' script is built from `configure.in' by the `autoconf' | |
674 | program. You need at least the version of autoconf specified in the | |
675 | AC_PREREQ(...) command to rebuild `configure' from `configure.in'. | |
676 | ||
677 | BUILDING GNU EMACS BY HAND | |
678 | ||
679 | Once Emacs is configured, running `make' in the top directory performs | |
680 | the following steps. | |
681 | ||
682 | 1) Run `make epaths-force' in the top directory. This produces | |
683 | `./src/epaths.h' from the template file `./src/epaths.in', changing | |
684 | the paths to the values specified in `./Makefile'. | |
685 | ||
9a514d4a PE |
686 | 2) Go to directory `./lib' and run `make'. This creates include files |
687 | and libraries used in later steps. | |
688 | ||
689 | 3) Go to directory `./lib-src' and run `make'. This creates | |
067d23c9 KY |
690 | executables named `etags', `make-docfile', and others. |
691 | ||
9a514d4a PE |
692 | 4) Go to directory `./src' and run `make'. This refers to files in |
693 | the `./lisp', `./lib', and `./lib-src' subdirectories using names | |
694 | `../lisp', `../lib', and `../lib-src'. | |
067d23c9 KY |
695 | |
696 | This creates a file `./src/emacs' which is the runnable Emacs, | |
697 | which has another name that contains a version number. | |
698 | Each time you do this, that version number increments in the last place. | |
699 | ||
700 | It also creates a file in `./etc' whose name is `DOC' followed by the | |
701 | current Emacs version. This file contains documentation strings for | |
702 | all the functions in Emacs. Each time you run make to make a new | |
703 | emacs, a new DOC file with a new name is made. You must keep the DOC | |
704 | file for an Emacs version as long as you keep using that Emacs version. | |
705 | ||
706 | ||
707 | INSTALLATION BY HAND | |
708 | ||
709 | The steps below are done by running `make install' in the main | |
710 | directory of the Emacs distribution. | |
711 | ||
712 | 1) Copy `./lisp' and its subdirectories, `./etc', and the executables | |
713 | in `./lib-src' to their final destinations, as selected in `./src/epaths.h'. | |
714 | ||
715 | Strictly speaking, not all of the executables in `./lib-src' need be copied. | |
c136e5cd GM |
716 | - The programs `hexl', `movemail', `profile', `rcs2log', and `vcdiff' |
717 | are used by Emacs; they do need to be copied. | |
067d23c9 KY |
718 | - The programs `etags', `ctags', `emacsclient', and `rcs-checkin' |
719 | are intended to be run by users; they are handled below. | |
720 | - The programs `make-docfile' and `test-distrib' were | |
721 | used in building Emacs, and are not needed any more. | |
722 | ||
723 | 2) Copy the files in `./info' to the place specified in | |
724 | `./lisp/site-init.el' or `./lisp/paths.el'. Note that if the | |
725 | destination directory already contains a file named `dir', you | |
726 | probably don't want to replace it with the `dir' file in the Emacs | |
727 | distribution. Instead, you should make sure that the existing `dir' | |
728 | file contains an appropriate menu entry for the Emacs info. | |
729 | ||
730 | 3) Copy `./src/emacs' to `/usr/local/bin', or to some other directory | |
731 | in users' search paths. `./src/emacs' has an alternate name | |
732 | `./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named | |
733 | `/usr/local/bin/emacs' pointing to that alternate name, as an easy way | |
734 | of installing different versions. | |
735 | ||
736 | You can delete `./src/temacs'. | |
737 | ||
738 | 4) Copy the programs `emacsclient', `ctags', `etags', and `rcs-checkin' | |
739 | from `./lib-src' to `/usr/local/bin'. These programs are intended for | |
740 | users to run. | |
741 | ||
742 | 5) Copy the man pages in `./doc/man' into the appropriate man directory. | |
743 | ||
744 | 6) The files in the `./src' subdirectory, except for `emacs', are not | |
745 | used by Emacs once it is built. However, it is very desirable to keep | |
746 | the source on line for debugging. | |
747 | ||
748 | ||
749 | PROBLEMS | |
750 | ||
751 | See the file `./etc/PROBLEMS' for a list of various problems sometimes | |
752 | encountered, and what to do about them. | |
753 | \f | |
754 | This file is part of GNU Emacs. | |
755 | ||
756 | GNU Emacs is free software: you can redistribute it and/or modify | |
757 | it under the terms of the GNU General Public License as published by | |
758 | the Free Software Foundation, either version 3 of the License, or | |
759 | (at your option) any later version. | |
760 | ||
761 | GNU Emacs is distributed in the hope that it will be useful, | |
762 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
763 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
764 | GNU General Public License for more details. | |
765 | ||
766 | You should have received a copy of the GNU General Public License | |
767 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |