Commit | Line | Data |
---|---|---|
a0e671c7 | 1 | GNU Emacs Installation Guide |
887af595 | 2 | Copyright (c) 1992, 1994, 1996, 1997 Free software Foundation, Inc. |
a0e671c7 JB |
3 | |
4 | Permission is granted to anyone to make or distribute verbatim copies | |
5 | of this document as received, in any medium, provided that the | |
6 | copyright notice and permission notice are preserved, | |
7 | and that the distributor grants the recipient permission | |
8 | for further redistribution as permitted by this notice. | |
9 | ||
10 | Permission is granted to distribute modified versions | |
11 | of this document, or of portions of it, | |
12 | under the above conditions, provided also that they | |
13 | carry prominent notices stating who last changed them, | |
14 | and that any new or changed statements about the activities | |
15 | of the Free Software Foundation are approved by the Foundation. | |
16 | ||
17 | ||
85da25e9 RS |
18 | ADDITIONAL DISTRIBUTION FILES |
19 | ||
20 | * leim-M.N.tar.gz | |
21 | ||
22 | The Emacs Lisp code for input methods for various international | |
becd5943 KH |
23 | character scripts is distributed in a separate tar file because it |
24 | amounts to a significant fraction of the size of the distribution. | |
25 | This tar file is called leim-M.N.tar.gz, with the same version number | |
26 | as Emacs, and it unpacks into the directory emacs-M.N/leim. | |
27 | ||
28 | You should unpack leim-M.N.tar.gz into the same directory where you | |
29 | have previously unpacked the main Emacs distribution. It fills in the | |
30 | contents of one subdirectory, which is present in the main Emacs | |
31 | distribution only in dummy form. | |
32 | ||
33 | Once you have unpacked the Leim tar file into the Emacs source tree, | |
34 | building and installing Emacs automatically installs the input method | |
35 | support as well. If you have built Emacs without unpacking Leim | |
36 | first, just unpack Leim, build Emacs again, and install it again. | |
85da25e9 RS |
37 | |
38 | * intlfonts-VERSION.tar.gz | |
39 | ||
40 | The intlfonts distribution contains X11 fonts that Emacs needs in | |
41 | order to display international characters. If you see a non-ASCII | |
42 | character appear as a hollow box, that means you don't have a font for | |
887af595 RS |
43 | it. You might find a font in the intlfonts distribution. If some |
44 | characters don't look right, or appear improperly aligned, a font | |
330a9ebb | 45 | from the intlfonts distribution might look better. |
887af595 | 46 | |
1d173668 EZ |
47 | The fonts in the intlfonts distribution are also used by the ps-print |
48 | package for printing international characters. The file | |
49 | lisp/ps-mule.el defines the .bdf font files required for printing | |
50 | each character set. | |
51 | ||
887af595 RS |
52 | The intlfonts distribution contains its own installation instructions, |
53 | in the intlfonts/README file. | |
85da25e9 | 54 | |
b610290e GM |
55 | * elisp-manual-M.N.tar.gz |
56 | ||
57 | This distribution contains the Emacs Lisp Reference Manual which | |
58 | complements the Emacs Lisp Manual. It is a good idea to install the | |
59 | Emacs Lisp Reference Manual after installing Emacs, to complete the | |
60 | on-line documentation of Emacs in Info. | |
61 | ||
62 | If you have installed Texinfo, you can install the Emacs Lisp | |
63 | Reference Manual this way: | |
64 | ||
65 | cd elisp-manual-M.N | |
66 | ./configure --prefix=PREFIXDIR | |
67 | make install | |
68 | ||
69 | Otherwise, you can install it manually. Just copy the files elisp and | |
70 | elisp-* from the elisp-manual-M.N directory to your site's info | |
71 | directory (see the description of `infodir', below), and make sure | |
72 | that file `dir' in this directory contains an entry like this: | |
73 | ||
74 | * Elisp: (elisp). The Emacs Lisp Reference Manual. | |
400a1ed0 | 75 | |
45e680a8 EZ |
76 | * Image support libraries |
77 | ||
78 | Emacs needs optional libraries to be able to display images (with the | |
9792d8ac DL |
79 | exception of PBM and XBM images whose support is built-in). On some |
80 | systems these may already be present or available as additional | |
81 | packages, particularly on GNU/Linux. (In some cases older versions | |
82 | won't work because some routines are missing, and configure should | |
83 | avoid such old versions.) | |
84 | ||
85 | If necessary, you can build them from source. None are vital for | |
86 | running Emacs. Here's the list of these optional libraries, and the | |
87 | URLs where they can be found: | |
45e680a8 EZ |
88 | |
89 | . libxpm for XPM: ftp://ftp.x.org/contrib/libraries/ | |
90 | . libpng for PNG: ftp://www.libpng.org/pub/png/ | |
9792d8ac | 91 | . libz (for PNG): http://www.info-zip.org/pub/infozip/zlib/ |
45e680a8 EZ |
92 | . libjpeg for JPEG: ftp://ftp.uu.net/graphics/jpeg/ |
93 | . libtiff for TIFF: http://www.libtiff.org/ | |
94 | . libungif for GIF: | |
95 | http://prtr-13.ucsc.edu/~badger/software/libungif/index.shtml | |
ec6bd013 DL |
96 | |
97 | [libungif-4.1.0 can crash Emacs with uncompressed GIFs -- use | |
98 | libungif-4.1.0b1.] | |
45e680a8 | 99 | |
9792d8ac DL |
100 | Emacs will configure itself to build with these libraries if configure |
101 | finds them on your system unless you supply the appropriate | |
102 | --without-LIB option. See below for more details. | |
45e680a8 | 103 | |
85da25e9 | 104 | |
a0e671c7 | 105 | BUILDING AND INSTALLATION: |
00af31ec RS |
106 | |
107 | (This is for a Unix or Unix-like system. For MSDOS, see below; search | |
f1d6d1e8 GM |
108 | for MSDOG. For Windows NT or Windows 95, see the file nt/INSTALL. |
109 | For the Mac, see the file mac/INSTALL.) | |
a0e671c7 JB |
110 | |
111 | 1) Make sure your system has enough swapping space allocated to handle | |
f1d6d1e8 GM |
112 | a program whose pure code is 1.5 MB and whose data area is at |
113 | least 2.5 MB and can reach 80 MB or more. If the swapping space is | |
a0e671c7 | 114 | insufficient, you will get an error in the command `temacs -batch -l |
bde335e3 | 115 | loadup dump', found in `./src/Makefile.in', or possibly when |
42db5687 | 116 | running the final dumped Emacs. |
a0e671c7 | 117 | |
f1d6d1e8 GM |
118 | Building Emacs requires about 95 MB of disk space (including the Emacs |
119 | sources), or 130 MB if Leim is used. Once installed, Emacs occupies | |
120 | about 60 MB (70 MB with Leim) in the file system where it is | |
121 | installed; this includes the executable files, Lisp libraries, | |
122 | miscellaneous data files, and on-line documentation. If the building | |
123 | and installation take place in different directories, then the | |
124 | installation procedure momentarily requires 95+60 MB (130+170 MB). | |
a0e671c7 JB |
125 | |
126 | 2) Consult `./etc/MACHINES' to see what configuration name you should | |
f40423fa | 127 | give to the `configure' program. That file offers hints for |
a0e671c7 JB |
128 | getting around some possible installation problems. |
129 | ||
ea3165c7 RS |
130 | 3) You can build Emacs in the top-level Emacs source directory |
131 | or in a separate directory. | |
132 | ||
133 | 3a) To build in the top-level Emacs source directory, go to that | |
134 | directory and run the program `configure' as follows: | |
a0e671c7 | 135 | |
e4e772f1 | 136 | ./configure [CONFIGURATION-NAME] [--OPTION[=VALUE]] ... |
a0e671c7 JB |
137 | |
138 | The CONFIGURATION-NAME argument should be a configuration name given | |
e4e772f1 RS |
139 | in `./etc/MACHINES', with the system version number added at the end. |
140 | ||
141 | You should try first omitting CONFIGURATION-NAME. This way, | |
142 | `configure' will try to guess your system type. If it cannot guess, | |
143 | or if something goes wrong in building or installing Emacs this way, | |
144 | try again specifying the proper CONFIGURATION-NAME explicitly. | |
a0e671c7 | 145 | |
f40423fa DM |
146 | If you don't want X support, specify `--with-x=no'. If you omit this |
147 | option, `configure' will try to figure out for itself whether your | |
148 | system has X, and arrange to use it if present. | |
a0e671c7 JB |
149 | |
150 | The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build | |
151 | process where the compiler should look for the include files and | |
f40423fa DM |
152 | object libraries used with the X Window System. Normally, `configure' |
153 | is able to find them; these options are necessary if you have your X | |
763b1847 KH |
154 | Window System files installed in unusual places. These options also |
155 | accept a list of directories, separated with colons. | |
a0e671c7 | 156 | |
f40423fa DM |
157 | To get more attractive menus, you can specify an X toolkit when you |
158 | configure Emacs; use the option `--with-x-toolkit=TOOLKIT', where | |
159 | TOOLKIT is `athena' or `motif' (`yes' and `lucid' are synonyms for | |
160 | `athena'). On some systems, it does not work to use a toolkit with | |
45e680a8 EZ |
161 | shared libraries. A free implementation of Motif, called LessTif, is |
162 | available ftom <http://www.lesstif.org>. | |
a0e671c7 JB |
163 | |
164 | The `--with-gcc' option specifies that the build process should | |
165 | compile Emacs using GCC. If you don't want to use GCC, specify | |
f40423fa DM |
166 | `--with-gcc=no'. If you omit this option, `configure' will search |
167 | for GCC in your path, and use it if present. | |
a0e671c7 | 168 | |
e10f2277 EZ |
169 | The Emacs mail reader RMAIL is configured to be able to read mail from |
170 | a POP3 server by default. Versions of the POP protocol older than | |
171 | POP3 are not supported. For Kerberos-authenticated POP add | |
172 | `--with-kerberos', for Hesiod support add `--with-hesiod'. While POP3 | |
173 | is always enabled, whether Emacs actually uses POP is controlled by | |
174 | individual users--see the Rmail chapter of the Emacs manual. | |
c5f329d6 | 175 | |
9792d8ac DL |
176 | For image support you may have to download, build, and install the |
177 | appropriate image support libraries for image types other than XBM and | |
178 | PBM, see the list of URLs in "ADDITIONAL DISTRIBUTION FILES" above. | |
179 | (Note that PNG support requires libz in addition to libpng.) | |
45e680a8 | 180 | |
9792d8ac DL |
181 | To disable individual types of image support in Emacs for some reason, |
182 | even though configure finds the libraries, you can configure with one | |
183 | or more of these options: | |
45e680a8 | 184 | |
9792d8ac DL |
185 | --without-xpm for XPM image support |
186 | --without-jpeg for JPEG image support | |
187 | --without-tiff for TIFF image support | |
188 | --without-gif for GIF image support | |
189 | --without-png for PNG image support | |
45e680a8 | 190 | |
a0e671c7 JB |
191 | The `--prefix=PREFIXDIR' option specifies where the installation process |
192 | should put emacs and its data files. This defaults to `/usr/local'. | |
193 | - Emacs (and the other utilities users run) go in PREFIXDIR/bin | |
194 | (unless the `--exec-prefix' option says otherwise). | |
f40423fa DM |
195 | - The architecture-independent files go in PREFIXDIR/share/emacs/VERSION |
196 | (where VERSION is the version number of Emacs, like `19.27'). | |
a0e671c7 | 197 | - The architecture-dependent files go in |
f40423fa | 198 | PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION |
a0e671c7 JB |
199 | (where CONFIGURATION is the configuration name, like mips-dec-ultrix4.2), |
200 | unless the `--exec-prefix' option says otherwise. | |
201 | ||
202 | The `--exec-prefix=EXECDIR' option allows you to specify a separate | |
203 | portion of the directory tree for installing architecture-specific | |
204 | files, like executables and utility programs. If specified, | |
205 | - Emacs (and the other utilities users run) go in EXECDIR/bin, and | |
206 | - The architecture-dependent files go in | |
f40423fa | 207 | EXECDIR/libexec/emacs/VERSION/CONFIGURATION. |
a0e671c7 JB |
208 | EXECDIR/bin should be a directory that is normally in users' PATHs. |
209 | ||
210 | For example, the command | |
211 | ||
212 | ./configure mips-dec-ultrix --with-x11 | |
213 | ||
214 | configures Emacs to build for a DECstation running Ultrix, with | |
215 | support for the X11 window system. | |
216 | ||
f40423fa | 217 | `configure' doesn't do any compilation or installation |
a0e671c7 | 218 | itself. It just creates the files that influence those things: |
908477d9 DM |
219 | `./Makefile', `lib-src/Makefile', `oldXMenu/Makefile', |
220 | `lwlib/Makefile', `src/Makefile', and `./src/config.h'. For details | |
221 | on exactly what it does, see the section called `CONFIGURATION BY | |
222 | HAND', below. | |
a0e671c7 JB |
223 | |
224 | When it is done, `configure' prints a description of what it did and | |
f40423fa DM |
225 | creates a shell script `config.status' which, when run, recreates the |
226 | same configuration. If `configure' exits with an error after | |
227 | disturbing the status quo, it removes `config.status'. `configure' | |
228 | also creates a file `config.cache' that saves the results of its tests | |
229 | to make reconfiguring faster, and a file `config.log' containing compiler | |
230 | output (useful mainly for debugging `configure'). You can give | |
231 | `configure' the option `--cache-file=FILE' to use the results of the | |
232 | tests in FILE instead of `config.cache'. Set FILE to `/dev/null' to | |
233 | disable caching, for debugging `configure'. | |
a0e671c7 JB |
234 | |
235 | The work of `configure' can be done by editing various files in the | |
ea3165c7 RS |
236 | distribution, but using `configure' is easier. See the section called |
237 | "CONFIGURATION BY HAND" below if you want to do the configuration | |
238 | yourself. | |
239 | ||
240 | 3b) To build in a separate directory, go to that directory | |
241 | and run the program `configure' as follows: | |
242 | ||
243 | SOURCE-DIR/configure CONFIGURATION-NAME [--OPTION[=VALUE]] ... | |
244 | ||
245 | SOURCE-DIR refers to the top-level Emacs source directory which is | |
246 | where Emacs's configure script is located. `configure' looks for the | |
247 | Emacs source code in the directory that `configure' is in. | |
248 | ||
249 | To build in a separate directory, you must use a version of `make' | |
250 | that supports the `VPATH' variable, such as GNU `make'. | |
a0e671c7 | 251 | |
793faff1 RS |
252 | 3c) Some people try to build in a separate directory by filling |
253 | it full of symlinks to the files in the real source directory. | |
e1655e2b RS |
254 | If you do that, `make all' does work, but `make install' fails: |
255 | it copies the symbolic links rather than the actual files. | |
256 | ||
257 | As far as is known, there is no particular reason to use | |
258 | a directory full of links rather than use the standard GNU | |
259 | facilities to build in a separate directory (see 3b above). | |
260 | ||
a0e671c7 | 261 | 4) Look at `./lisp/paths.el'; if some of those values are not right |
0b60f47d KH |
262 | for your system, set up the file `./lisp/site-init.el' with Emacs |
263 | Lisp code to override them; it is not a good idea to edit paths.el | |
a0e671c7 JB |
264 | itself. YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES, |
265 | rather than `defvar', as used by `./lisp/paths.el'. For example, | |
266 | ||
267 | (setq news-inews-program "/usr/bin/inews") | |
268 | ||
269 | is how you would override the default value of the variable | |
270 | news-inews-program (which is "/usr/local/inews"). | |
271 | ||
35b12ec0 RS |
272 | Before you override a variable this way, *look at the value* that the |
273 | variable gets by default! Make sure you know what kind of value the | |
274 | variable should have. If you don't pay attention to what you are | |
275 | doing, you'll make a mistake. | |
276 | ||
42db5687 RS |
277 | 5) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs |
278 | Lisp code you want Emacs to load before it is dumped out. Use | |
279 | site-load.el for additional libraries if you arrange for their | |
280 | documentation strings to be in the etc/DOC file (see | |
bde335e3 | 281 | src/Makefile.in if you wish to figure out how to do that). For all |
8c10f3e4 RS |
282 | else, use site-init.el. Do not load byte-compiled code which |
283 | was build with a non-nil value of `byte-compile-dynamic'. | |
a0e671c7 | 284 | |
0d75540d RS |
285 | If you set load-path to a different value in site-init.el or |
286 | site-load.el, Emacs will use *precisely* that value when it starts up | |
287 | again. If you do this, you are on your own! | |
d07ee75a | 288 | |
a0e671c7 JB |
289 | Note that, on some systems, the code you place in site-init.el must |
290 | not use expand-file-name or any other function which may look | |
291 | something up in the system's password and user information database. | |
4fece393 | 292 | See `./etc/PROBLEMS' for more details on which systems this affects. |
a0e671c7 | 293 | |
eaa91904 RS |
294 | The `site-*.el' files are nonexistent in the distribution. You do not |
295 | need to create them if you have nothing to put in them. | |
a0e671c7 JB |
296 | |
297 | 6) Refer to the file `./etc/TERMS' for information on fields you may | |
298 | wish to add to various termcap entries. The files `./etc/termcap.ucb' | |
299 | and `./etc/termcap.dat' may already contain appropriately-modified | |
300 | entries. | |
301 | ||
302 | 7) Run `make' in the top directory of the Emacs distribution to finish | |
c5f48ce3 RS |
303 | building Emacs in the standard way. The final executable file is |
304 | named `src/emacs'. You can execute this file "in place" without | |
305 | copying it, if you wish; then it automatically uses the sibling | |
306 | directories ../lisp, ../lib-src, ../info. | |
307 | ||
308 | Or you can "install" the executable and the other Emacs into their | |
309 | installed locations, with `make install'. By default, Emacs's files | |
310 | are installed in the following directories: | |
a0e671c7 JB |
311 | |
312 | `/usr/local/bin' holds the executable programs users normally run - | |
c9da8016 RS |
313 | `emacs', `etags', `ctags', `b2m', `emacsclient', |
314 | and `rcs-checkin'. | |
a0e671c7 | 315 | |
f40423fa | 316 | `/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library; |
a0e671c7 | 317 | `VERSION' stands for the number of the Emacs version |
f40423fa | 318 | you are installing, like `18.59' or `19.27'. Since the |
cdb49480 | 319 | Lisp library changes from one version of Emacs to |
a0e671c7 JB |
320 | another, including the version number in the path |
321 | allows you to have several versions of Emacs installed | |
cdb49480 RS |
322 | at the same time; in particular, you don't have to |
323 | make Emacs unavailable while installing a new version. | |
a0e671c7 | 324 | |
cdb49480 RS |
325 | `/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp |
326 | files installed for Emacs version VERSION only. | |
327 | ||
328 | `/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp | |
329 | files installed for all Emacs versions. | |
330 | ||
331 | When Emacs is installed, it searches for its Lisp files | |
332 | in `/usr/local/share/emacs/VERSION/site-lisp', then in | |
333 | `/usr/local/share/emacs/site-lisp', and finally in | |
334 | `/usr/local/share/emacs/VERSION/lisp'. | |
a0e671c7 | 335 | |
f40423fa | 336 | `/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC |
a0e671c7 JB |
337 | file, the `yow' database, and other |
338 | architecture-independent files Emacs might need while | |
339 | running. VERSION is as specified for `.../lisp'. | |
340 | ||
f40423fa | 341 | `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable |
a0e671c7 JB |
342 | programs used by Emacs that users are not expected to |
343 | run themselves. | |
344 | `VERSION' is the number of the Emacs version you are | |
345 | installing, and `CONFIGURATION-NAME' is the argument | |
346 | you gave to the `configure' program to identify the | |
347 | architecture and operating system of your machine, | |
348 | like `mips-dec-ultrix' or `sparc-sun-sunos'. Since | |
349 | these files are specific to the version of Emacs, | |
350 | operating system, and architecture in use, including | |
351 | the configuration name in the path allows you to have | |
352 | several versions of Emacs for any mix of machines and | |
353 | operating systems installed at the same time; this is | |
354 | useful for sites at which different kinds of machines | |
355 | share the file system Emacs is installed on. | |
356 | ||
357 | `/usr/local/info' holds the on-line documentation for Emacs, known as | |
358 | "info files". Many other GNU programs are documented | |
359 | using info files as well, so this directory stands | |
360 | apart from the other, Emacs-specific directories. | |
361 | ||
362 | `/usr/local/man/man1' holds the man pages for the programs installed | |
363 | in `/usr/local/bin'. | |
364 | ||
365 | If these directories are not what you want, you can specify where to | |
366 | install Emacs's libraries and data files or where Emacs should search | |
cdb49480 | 367 | for its Lisp files by giving values for `make' variables as part of |
a0e671c7 JB |
368 | the command. See the section below called `MAKE VARIABLES' for more |
369 | information on this. | |
370 | ||
371 | 8) Check the file `dir' in your site's info directory (usually | |
372 | /usr/local/info) to make sure that it has a menu entry for the Emacs | |
373 | info files. | |
374 | ||
42db5687 | 375 | 9) If your system uses lock files to interlock access to mailer inbox files, |
f40423fa | 376 | then you might need to make the movemail program setuid or setgid |
42db5687 RS |
377 | to enable it to write the lock files. We believe this is safe. |
378 | ||
2d475b5f KH |
379 | 10) You are done! You can remove executables and object files from |
380 | the build directory by typing `make clean'. To also remove the files | |
381 | that `configure' created (so you can compile Emacs for a different | |
f12b4dea EZ |
382 | configuration), type `make distclean'. If you don't need some, or all |
383 | of the input methods from the Leim package, you can remove the | |
384 | unneeded files in the leim/quail, leim/skk, and leim/skk-dic | |
385 | subdirectories of your site's lisp directory (usually | |
386 | /usr/local/share/emacs/VERSION/). | |
2d475b5f | 387 | |
a0e671c7 JB |
388 | |
389 | ||
390 | MAKE VARIABLES | |
391 | ||
392 | You can change where the build process installs Emacs and its data | |
393 | files by specifying values for `make' variables as part of the `make' | |
394 | command line. For example, if you type | |
395 | ||
396 | make install bindir=/usr/local/gnubin | |
397 | ||
398 | the `bindir=/usr/local/gnubin' argument indicates that the Emacs | |
399 | executable files should go in `/usr/local/gnubin', not | |
400 | `/usr/local/bin'. | |
401 | ||
402 | Here is a complete list of the variables you may want to set. | |
403 | ||
404 | `bindir' indicates where to put executable programs that users can | |
405 | run. This defaults to /usr/local/bin. | |
406 | ||
407 | `datadir' indicates where to put the architecture-independent | |
408 | read-only data files that Emacs refers to while it runs; it | |
908477d9 | 409 | defaults to /usr/local/share. We create the following |
a0e671c7 | 410 | subdirectories under `datadir': |
cdb49480 | 411 | - `emacs/VERSION/lisp', containing the Emacs Lisp library, and |
a0e671c7 JB |
412 | - `emacs/VERSION/etc', containing the Emacs tutorial, the DOC |
413 | file, and the `yow' database. | |
414 | `VERSION' is the number of the Emacs version you are installing, | |
415 | like `18.59' or `19.0'. Since these files vary from one version | |
416 | of Emacs to another, including the version number in the path | |
417 | allows you to have several versions of Emacs installed at the | |
418 | same time; this means that you don't have to make Emacs | |
419 | unavailable while installing a new version. | |
420 | ||
908477d9 DM |
421 | `libexecdir' indicates where to put architecture-specific data files that |
422 | Emacs refers to as it runs; it defaults to `/usr/local/libexec'. | |
423 | We create the following subdirectories under `libexecdir': | |
a0e671c7 JB |
424 | - `emacs/VERSION/CONFIGURATION-NAME', containing executable |
425 | programs used by Emacs that users are not expected to run | |
426 | themselves. | |
427 | `VERSION' is the number of the Emacs version you are installing, | |
428 | and `CONFIGURATION-NAME' is the argument you gave to the | |
429 | `configure' program to identify the architecture and operating | |
430 | system of your machine, like `mips-dec-ultrix' or | |
431 | `sparc-sun-sunos'. Since these files are specific to the version | |
432 | of Emacs, operating system, and architecture in use, including | |
433 | the configuration name in the path allows you to have several | |
434 | versions of Emacs for any mix of machines and operating systems | |
435 | installed at the same time; this is useful for sites at which | |
436 | different kinds of machines share the file system Emacs is | |
437 | installed on. | |
438 | ||
439 | `infodir' indicates where to put the info files distributed with | |
440 | Emacs; it defaults to `/usr/local/info'. | |
441 | ||
442 | `mandir' indicates where to put the man pages for Emacs and its | |
443 | utilities (like `etags'); it defaults to | |
444 | `/usr/local/man/man1'. | |
445 | ||
446 | `manext' gives the extension the man pages should be installed with. | |
447 | It should contain a period, followed by the appropriate | |
448 | digit. It defaults to `.1'. For example given the default | |
449 | values for `mandir' and `manext', the Emacs man page would be | |
450 | installed as `/usr/local/man/man1/emacs.1'. | |
451 | ||
452 | `prefix' doesn't give a path for any specific part of Emacs; instead, | |
453 | its value is used to determine the defaults for all the | |
454 | architecture-independent path variables - `datadir', | |
908477d9 | 455 | `sharedstatedir', `infodir', and `mandir'. Its default value is |
a0e671c7 JB |
456 | `/usr/local'; the other variables add on `lib' or `man' to it |
457 | by default. | |
458 | ||
459 | For example, suppose your site generally places GNU software | |
460 | under `/usr/users/software/gnusoft' instead of `/usr/local'. | |
461 | By including | |
462 | `prefix=/usr/users/software/gnusoft' | |
463 | in the arguments to `make', you can instruct the build process | |
464 | to place all of the Emacs data files in the appropriate | |
465 | directories under that path. | |
466 | ||
467 | `exec_prefix' serves the same purpose as `prefix', but instead | |
468 | determines the default values for the architecture-dependent | |
908477d9 | 469 | path variables - `bindir' and `libexecdir'. |
a0e671c7 JB |
470 | |
471 | The above variables serve analogous purposes in the makefiles for all | |
5c462624 | 472 | GNU software; this variable is specific to Emacs. |
a0e671c7 | 473 | |
2d475b5f KH |
474 | `archlibdir' indicates where Emacs installs and expects the executable |
475 | files and other architecture-dependent data it uses while | |
476 | running. Its default value, based on `libexecdir' (which | |
477 | see), is `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' | |
a0e671c7 JB |
478 | (where VERSION and CONFIGURATION-NAME are as described above). |
479 | ||
480 | Remember that you must specify any variable values you need each time | |
481 | you run `make' in the top directory. If you run `make' once to build | |
482 | emacs, test it, and then run `make' again to install the files, you | |
483 | must provide the same variable settings each time. To make the | |
484 | settings persist, you can edit them into the `Makefile' in the top | |
485 | directory, but be aware that running the `configure' program erases | |
486 | `Makefile' and rebuilds it from `Makefile.in'. | |
487 | ||
5c462624 RS |
488 | The path for finding Lisp files is specified in src/paths.h, |
489 | a file which is generated by running configure. To change the path, | |
490 | you can edit the definition of PATH_LOADSEARCH in that file | |
491 | before you run `make'. | |
492 | ||
a0e671c7 JB |
493 | The top-level Makefile stores the variable settings it used in the |
494 | Makefiles for the subdirectories, so you don't have to specify them | |
495 | when running make in the subdirectories. | |
496 | ||
497 | ||
498 | CONFIGURATION BY HAND | |
499 | ||
c9da8016 RS |
500 | Instead of running the `configure' program, you have to perform the |
501 | following steps. | |
a0e671c7 | 502 | |
bde335e3 | 503 | 1) Copy `./src/config.in' to `./src/config.h'. |
a0e671c7 JB |
504 | |
505 | 2) Consult `./etc/MACHINES' to see what configuration name you should | |
506 | use for your system. Look at the code of the `configure' script to | |
507 | see which operating system and architecture description files from | |
508 | `src/s' and `src/m' should be used for that configuration name. Edit | |
509 | `src/config.h', and change the two `#include' directives to include | |
510 | the appropriate system and architecture description files. | |
511 | ||
512 | 2) Edit `./src/config.h' to set the right options for your system. If | |
513 | you need to override any of the definitions in the s/*.h and m/*.h | |
514 | files for your system and machine, do so by editing config.h, not by | |
515 | changing the s/*.h and m/*.h files. Occasionally you may need to | |
516 | redefine parameters used in `./lib-src/movemail.c'. | |
517 | ||
c9da8016 | 518 | 3) Create src/Makefile and lib-src/Makefile from the corresponding |
bde335e3 | 519 | `Makefile.in' files. First copy `Makefile.in' to `Makefile.c', |
94684a2e | 520 | then edit in appropriate substitutions for the @...@ constructs, |
c9da8016 RS |
521 | and then copy the shell commands near the end of `configure' |
522 | that run cpp to construct `Makefile'. | |
a0e671c7 | 523 | |
c9da8016 RS |
524 | 4) Create `Makefile' files in various other directories |
525 | from the corresponding `Makefile.in' files. This isn't so hard, | |
526 | just a matter of substitution. | |
a0e671c7 | 527 | |
a0e671c7 | 528 | The `configure' script is built from `configure.in' by the `autoconf' |
f40423fa | 529 | program. You need version 2.0 or newer of `autoconf' to rebuild `configure'. |
a0e671c7 JB |
530 | |
531 | BUILDING GNU EMACS BY HAND | |
532 | ||
a4af02f3 RS |
533 | Once Emacs is configured, running `make' in the top directory performs |
534 | the following steps. | |
a0e671c7 JB |
535 | |
536 | 1) Run `make src/paths.h' in the top directory. This produces | |
bde335e3 | 537 | `./src/paths.h' from the template file `./src/paths.in', changing |
a0e671c7 JB |
538 | the paths to the values specified in `./Makefile'. |
539 | ||
c9da8016 RS |
540 | 2) Go to directory `./lib-src' and run `make'. This creates |
541 | executables named `ctags' and `etags' and `wakeup' and `make-docfile' | |
542 | and `digest-doc' and `test-distrib'. And others. | |
a0e671c7 | 543 | |
c9da8016 RS |
544 | 3) Go to directory `./src' and Run `make'. This refers to files in |
545 | the `./lisp' and `./lib-src' subdirectories using names `../lisp' and | |
a0e671c7 JB |
546 | `../lib-src'. |
547 | ||
548 | This creates a file `./src/emacs' which is the runnable Emacs, | |
c9da8016 RS |
549 | which has another name that contains a version number. |
550 | Each time you do this, that version number increments in the last place. | |
a0e671c7 JB |
551 | |
552 | It also creates a file in `./etc' whose name is `DOC' followed by the | |
553 | current Emacs version. This file contains documentation strings for | |
554 | all the functions in Emacs. Each time you run make to make a new | |
555 | emacs, a new DOC file with a new name is made. You must keep the DOC | |
556 | file for an Emacs version as long as you keep using that Emacs | |
557 | version. | |
558 | ||
559 | ||
560 | INSTALLATION BY HAND | |
561 | ||
a4af02f3 RS |
562 | The steps below are done by running `make install' in the main |
563 | directory of the Emacs distribution. | |
a0e671c7 JB |
564 | |
565 | 1) Copy `./lisp' and its subdirectories, `./etc', and the executables | |
566 | in `./lib-src' to their final destinations, as selected in `./src/paths.h'. | |
567 | ||
568 | Strictly speaking, not all of the executables in `./lib-src' need be copied. | |
eaa91904 | 569 | - The programs `cvtmail', `emacsserver', `fakemail', `hexl', |
c9da8016 RS |
570 | `movemail', `profile', `rcs2log', `timer', `vcdiff', `wakeup', |
571 | and `yow' are used by Emacs; they do need to be copied. | |
572 | - The programs `etags', `ctags', `emacsclient', `b2m', and `rcs-checkin' | |
a0e671c7 | 573 | are intended to be run by users; they are handled below. |
3ae888e8 | 574 | - The programs `make-docfile' and `test-distrib' were |
a0e671c7 JB |
575 | used in building Emacs, and are not needed any more. |
576 | - The programs `digest-doc' and `sorted-doc' convert a `DOC' file into | |
577 | a file for users to read. There is no important reason to move them. | |
578 | ||
579 | 2) Copy the files in `./info' to the place specified in | |
580 | `./lisp/site-init.el' or `./lisp/paths.el'. Note that if the | |
581 | destination directory already contains a file named `dir', you | |
582 | probably don't want to replace it with the `dir' file in the Emacs | |
583 | distribution. Instead, you should make sure that the existing `dir' | |
584 | file contains an appropriate menu entry for the Emacs info. | |
585 | ||
100b770b | 586 | 3) Copy `./src/emacs' to `/usr/local/bin', or to some other directory |
a0e671c7 JB |
587 | in users' search paths. `./src/emacs' has an alternate name |
588 | `./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named | |
589 | `/usr/local/bin/emacs' pointing to that alternate name, as an easy way | |
590 | of installing different versions. | |
591 | ||
592 | You can delete `./src/temacs'. | |
593 | ||
100b770b | 594 | 4) Copy the programs `b2m', `emacsclient', `ctags', `etags', and |
c9da8016 | 595 | `rcs-checkin' from `./lib-src' to `/usr/local/bin'. These programs are |
a0e671c7 JB |
596 | intended for users to run. |
597 | ||
100b770b | 598 | 5) Copy the man pages in `./etc' for emacs, ctags, and etags into the |
a0e671c7 JB |
599 | appropriate man directories. |
600 | ||
100b770b | 601 | 6) The files in the `./src' subdirectory, except for `emacs', are not |
c9da8016 RS |
602 | used by Emacs once it is built. However, it is very desirable to keep |
603 | the source on line for debugging. | |
a0e671c7 JB |
604 | |
605 | ||
606 | PROBLEMS | |
607 | ||
4fece393 | 608 | See the file PROBLEMS in etc subdirectory for a list of various |
a0e671c7 JB |
609 | problems sometimes encountered, and what to do about them. |
610 | ||
611 | ||
42db5687 RS |
612 | Installation on MSDOG (a.k.a. MSDOS) |
613 | ||
eaa91904 | 614 | To install on MSDOG, you need to have the GNU C compiler for MSDOG |
3f0ec1b7 RS |
615 | (also known as djgpp), GNU Make, rm, mv, and sed. See the remarks in |
616 | config.bat for more information about locations and versions. The | |
617 | file etc/FAQ includes pointers to Internet sites where you can find | |
618 | the necessary utilities; search for "MS-DOS". The configuration step | |
619 | (see below) will test for these utilities and will refuse to continue | |
620 | if any of them isn't found. | |
621 | ||
622 | If you are building the MSDOG version of Emacs on an MSDOG-like system | |
623 | which supports long file names (e.g. Windows 95), you need to make | |
624 | sure that long file names are handled consistently both when you | |
625 | unpack the distribution and compile it. If you intend to compile with | |
626 | DJGPP v2.0 or later, and long file names support is enabled (LFN=y in | |
627 | the environment), you need to unpack Emacs distribution in a way that | |
628 | doesn't truncate the original long filenames to the DOS 8.3 namespace; | |
629 | the easiest way to do this is to use djtar program which comes with | |
630 | DJGPP, since it will note the LFN setting and behave accordingly. | |
631 | DJGPP v1 doesn't support long filenames, so you must unpack Emacs with | |
632 | a program that truncates the filenames to 8.3 naming as it extracts | |
633 | files; again, using djtar after setting LFN=n is the recommended way. | |
634 | You can build Emacs with LFN=n even if you use DJGPP v2, if some of | |
635 | your tools don't support long file names: just ensure that LFN is set | |
636 | to `n' during both unpacking and compiling. | |
637 | ||
638 | (By the time you read this, you have already unpacked the Emacs | |
639 | distribution, but if the explanations above imply that you should have | |
640 | done it differently, it's safer to delete the directory tree created | |
641 | by the unpacking program and unpack Emacs again, than to risk running | |
642 | into problems during the build process.) | |
643 | ||
644 | It is important to understand that the runtime support of long file | |
645 | names by the Emacs binary is NOT affected by the LFN setting during | |
646 | compilation; Emacs compiled with DJGPP v2.0 or later will always | |
45e680a8 | 647 | support long file names on Windows 9X no matter what was the setting |
e60ea278 KH |
648 | of LFN at compile time. However, if you compiled with LFN disabled |
649 | and want to enable LFN support after Emacs was already built, you need | |
650 | to make sure that the support files in the lisp, etc and info | |
651 | directories are called by their original long names as found in the | |
652 | distribution. You can do this either by renaming the files manually, | |
653 | or by extracting them from the original distribution archive with | |
654 | djtar after you set LFN=y in the environment. | |
3f0ec1b7 RS |
655 | |
656 | To unpack Emacs with djtar, type this command: | |
657 | ||
658 | djtar -x emacs.tgz | |
659 | ||
660 | (This assumes that the Emacs distribution is called `emacs.tgz' on | |
e2726984 | 661 | your system.) |
3f0ec1b7 | 662 | |
1d173668 EZ |
663 | If you need to type international characters, you will need to unpack |
664 | the Leim distribution (see the description near the beginning of this | |
665 | file). You unpack it from the same directory where you unpacked | |
666 | Emacs. To unpack Leim with djtar, assuming the Leim distribution is | |
667 | called `leim.tgz', type this command: | |
668 | ||
669 | djtar -x leim.tgz | |
670 | ||
671 | If you want to print international characters, install the intlfonts | |
46ccfd36 | 672 | distribution. For this, create a directory called `fonts' under the |
1d173668 EZ |
673 | Emacs top-level directory (usually called `emacs-XX.YY') created by |
674 | unpacking emacs.tgz, chdir into the directory emacs-XX.YY/fonts, and | |
675 | type this: | |
676 | ||
677 | djtar -x intlfonts.tgz | |
678 | ||
3f0ec1b7 RS |
679 | When unpacking is done, a directory called `emacs-XX.YY' will be |
680 | created, where XX.YY is the Emacs version. To build and install | |
681 | Emacs, chdir to that directory and type these commands: | |
0287f07c RS |
682 | |
683 | config msdos | |
684 | make install | |
42db5687 | 685 | |
84391f69 EZ |
686 | Running "config msdos" checks for several programs that are required |
687 | to configure and build Emacs; if one of those programs is not found, | |
688 | CONFIG.BAT stops and prints an error message. If you have DJGPP | |
689 | version 2.0 or 2.01, it will complain about a program called | |
690 | DJECHO.EXE. These old versions of DJGPP shipped that program under | |
691 | the name ECHO.EXE, so you can simply copy ECHO.EXE to DJECHO.EXE and | |
692 | rerun CONFIG.BAT. If you have neither ECHO.EXE nor DJECHO.EXE, you | |
693 | should be able to find them in your djdevNNN.zip archive (where NNN is | |
694 | the DJGPP version number). | |
695 | ||
46ccfd36 EZ |
696 | To install the international fonts, chdir to the intlfonts-X.Y |
697 | directory created when you unpacked the intlfonts distribution (X.Y is | |
698 | the version number of the fonts' distribution), and type the following | |
699 | command: | |
700 | ||
701 | make bdf INSTALLDIR=.. | |
702 | ||
703 | After Make finishes, you may remove the directory intlfonts-X.Y; the | |
704 | fonts are installed into the fonts/bdf subdirectory of the top-level | |
705 | Emacs directory, and that is where Emacs will look for them by | |
706 | default. | |
707 | ||
db50afc0 RS |
708 | Building Emacs creates executable files in the src and lib-src |
709 | directories. Installing Emacs on MSDOS moves these executables to a | |
710 | sibling directory called bin. For example, if you build in directory | |
711 | /emacs, installing moves the executables from /emacs/src and | |
712 | /emacs/lib-src to the directory /emacs/bin, so you can then delete the | |
713 | subdirectories /emacs/src and /emacs/lib-src if you wish. The only | |
1d173668 EZ |
714 | subdirectories you need to keep are bin, lisp, etc and info. (If you |
715 | installed Leim, keep the leim subdirectory, and if you installed | |
716 | intlfonts, keep the fonts directory and all its sibdirectories as well.) | |
717 | The bin subdirectory should be added to your PATH. The msdos | |
718 | subdirectory includes a PIF and an icon file for Emacs which you might | |
719 | find useful if you run Emacs under MS Windows. | |
db50afc0 RS |
720 | |
721 | Emacs on MSDOS finds the lisp, etc and info directories by looking in | |
722 | ../lisp, ../etc and ../info, starting from the directory where the | |
723 | Emacs executable was run from. You can override this by setting the | |
e2726984 RS |
724 | environment variables EMACSDATA (for the location of `etc' directory), |
725 | EMACSLOADPATH (for the location of `lisp' directory) and INFOPATH (for | |
726 | the location of the `info' directory). | |
42db5687 | 727 | |
eaa91904 RS |
728 | MSDOG is a not a multitasking operating system, so Emacs features such |
729 | as asynchronous subprocesses that depend on multitasking will not | |
730 | work. Synchronous subprocesses do work. | |
d536be4a | 731 | |
22609647 RS |
732 | Version 2.0 of djgpp has two bugs that affect Emacs. We've included |
733 | corrected versions of two files from djgpp in the msdos subdirectory: | |
734 | is_exec.c and sigaction.c. To work around the bugs, compile these | |
45e680a8 EZ |
735 | files and link them into temacs. Djgpp versions 2.01 and later have |
736 | these bugs fixed, so upgrade if you can before building Emacs. |