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