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