annotate INSTALL @ 19307:5745bc43cfe9

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