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