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