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