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