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