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