annotate INSTALL @ 104132:75a1b898c727

* INSTALL: Fix free fonts URL.
author Chong Yidong <cyd@stupidchicken.com>
date Sun, 02 Aug 2009 22:49:24 +0000
parents 76e34fe20234
children a744eb12af2c
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
75348
3d45362f1d38 Add 2007 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 75274
diff changeset
2 Copyright (C) 1992, 1994, 1996, 1997, 2000, 2001, 2002, 2003, 2004,
100902
cf89f5c49828 Mention INSTALL.CVS.
Glenn Morris <rgm@gnu.org>
parents: 99467
diff changeset
3 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
4 See the end of the file for license conditions.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
5
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
6
98461
976ed432b7ec Mention nt and nextstep INSTALL files at the start.
Glenn Morris <rgm@gnu.org>
parents: 98460
diff changeset
7 This file contains general information. For more specific information
99467
41a356a46f3f Move MS-DOS specific instructions to msdos/INSTALL.
Eli Zaretskii <eliz@gnu.org>
parents: 98512
diff changeset
8 for the Windows, GNUstep/Mac OS X, and MS-DOS ports, also see the files
100902
cf89f5c49828 Mention INSTALL.CVS.
Glenn Morris <rgm@gnu.org>
parents: 99467
diff changeset
9 nt/INSTALL nextstep/INSTALL, and msdos/INSTALL. For information
cf89f5c49828 Mention INSTALL.CVS.
Glenn Morris <rgm@gnu.org>
parents: 99467
diff changeset
10 specific to building from a CVS checkout (rather than a release), see
cf89f5c49828 Mention INSTALL.CVS.
Glenn Morris <rgm@gnu.org>
parents: 99467
diff changeset
11 the file INSTALL.CVS.
98461
976ed432b7ec Mention nt and nextstep INSTALL files at the start.
Glenn Morris <rgm@gnu.org>
parents: 98460
diff changeset
12
976ed432b7ec Mention nt and nextstep INSTALL files at the start.
Glenn Morris <rgm@gnu.org>
parents: 98460
diff changeset
13
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
14 BASIC INSTALLATION
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
15
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
16 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>
parents: 34695
diff changeset
17 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>
parents: 34695
diff changeset
18 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>
parents: 34695
diff changeset
19 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>
parents: 34695
diff changeset
20 subdirectory and a `config.h' file containing system-dependent
34994
fb1c795f1a5e Minor style and punctuation changes from Kim Storm.
Eli Zaretskii <eliz@gnu.org>
parents: 34939
diff changeset
21 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>
parents: 34695
diff changeset
22 your system.
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
23
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
24 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>
parents: 34695
diff changeset
25 are supported by it. If this simplified procedure fails, or if you
34994
fb1c795f1a5e Minor style and punctuation changes from Kim Storm.
Eli Zaretskii <eliz@gnu.org>
parents: 34939
diff changeset
26 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>
parents: 34695
diff changeset
27 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>
parents: 34695
diff changeset
28 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>
parents: 34695
diff changeset
29 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>
parents: 34695
diff changeset
30 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>
parents: 34695
diff changeset
31
42213
a85200bb3831 Remove text that describes Leim as a separate package.
Eli Zaretskii <eliz@gnu.org>
parents: 40890
diff changeset
32 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>
parents: 34695
diff changeset
33
42213
a85200bb3831 Remove text that describes Leim as a separate package.
Eli Zaretskii <eliz@gnu.org>
parents: 40890
diff changeset
34 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>
parents: 34695
diff changeset
35 `configure' script:
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
36
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
37 ./configure
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
38
42213
a85200bb3831 Remove text that describes Leim as a separate package.
Eli Zaretskii <eliz@gnu.org>
parents: 40890
diff changeset
39 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>
parents: 34695
diff changeset
40 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>
parents: 34695
diff changeset
41 from there:
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
42
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
43 SOURCE-DIR/configure
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
44
35062
3168ff2c349b Tweaks to configure instructions and saving space.
Dave Love <fx@gnu.org>
parents: 35034
diff changeset
45 where SOURCE-DIR is the top-level Emacs source directory. This
3168ff2c349b Tweaks to configure instructions and saving space.
Dave Love <fx@gnu.org>
parents: 35034
diff changeset
46 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>
parents: 34695
diff changeset
47
42213
a85200bb3831 Remove text that describes Leim as a separate package.
Eli Zaretskii <eliz@gnu.org>
parents: 40890
diff changeset
48 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>
parents: 34695
diff changeset
49 about the system configuration. Read those details carefully
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
50 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>
parents: 34695
diff changeset
51 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>
parents: 34695
diff changeset
52 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>
parents: 34695
diff changeset
53
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
54 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>
parents: 34695
diff changeset
55 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>
parents: 34695
diff changeset
56 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>
parents: 34695
diff changeset
57 to DETAILED BUILDING AND INSTALLATION section below.
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
58
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
59 If `configure' didn't find some image support libraries, such as
35062
3168ff2c349b Tweaks to configure instructions and saving space.
Dave Love <fx@gnu.org>
parents: 35034
diff changeset
60 Xpm, jpeg, etc., and you want to use them refer to the subsection
3168ff2c349b Tweaks to configure instructions and saving space.
Dave Love <fx@gnu.org>
parents: 35034
diff changeset
61 "Image support libraries", below.
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
62
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
63 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>
parents: 34695
diff changeset
64 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>
parents: 34695
diff changeset
65
42213
a85200bb3831 Remove text that describes Leim as a separate package.
Eli Zaretskii <eliz@gnu.org>
parents: 40890
diff changeset
66 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>
parents: 34695
diff changeset
67 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>
parents: 34695
diff changeset
68 directories before running `configure' again:
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
69
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49322
diff changeset
70 make distclean
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
71 ./configure
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
72
42213
a85200bb3831 Remove text that describes Leim as a separate package.
Eli Zaretskii <eliz@gnu.org>
parents: 40890
diff changeset
73 5. Invoke the `make' program:
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
74
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
75 make
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
76
42213
a85200bb3831 Remove text that describes Leim as a separate package.
Eli Zaretskii <eliz@gnu.org>
parents: 40890
diff changeset
77 6. If `make' succeeds, it will build an executable program `emacs'
34994
fb1c795f1a5e Minor style and punctuation changes from Kim Storm.
Eli Zaretskii <eliz@gnu.org>
parents: 34939
diff changeset
78 in the `src' directory. You can try this program, to make sure
fb1c795f1a5e Minor style and punctuation changes from Kim Storm.
Eli Zaretskii <eliz@gnu.org>
parents: 34939
diff changeset
79 it works:
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
80
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
81 src/emacs -q
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
82
42213
a85200bb3831 Remove text that describes Leim as a separate package.
Eli Zaretskii <eliz@gnu.org>
parents: 40890
diff changeset
83 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>
parents: 34695
diff changeset
84 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>
parents: 34695
diff changeset
85 files into their installation directories:
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
86
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
87 make install
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
88
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
89 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>
parents: 34695
diff changeset
90 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>
parents: 34695
diff changeset
91 directory where you built Emacs:
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
92
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
93 make clean
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
94
35062
3168ff2c349b Tweaks to configure instructions and saving space.
Dave Love <fx@gnu.org>
parents: 35034
diff changeset
95 You can also save some space by compressing (with `gzip') Info files
3168ff2c349b Tweaks to configure instructions and saving space.
Dave Love <fx@gnu.org>
parents: 35034
diff changeset
96 and installed Lisp source (.el) files which have corresponding .elc
3168ff2c349b Tweaks to configure instructions and saving space.
Dave Love <fx@gnu.org>
parents: 35034
diff changeset
97 versions.
3168ff2c349b Tweaks to configure instructions and saving space.
Dave Love <fx@gnu.org>
parents: 35034
diff changeset
98
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
99
19014
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
100 ADDITIONAL DISTRIBUTION FILES
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
101
102826
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
102 * Complex Text Layout support libraries
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
103
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
104 Emacs needs the optional libraries "m17n-db", "libm17n-flt", "libotf"
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
105 to correctly display such complex scripts as Indic and Khmer.
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
106 On some systems, particularly GNU/Linux, these libraries may be
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
107 already present or available as additional packages. Note that if
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
108 there is a separate `dev' or `devel' package, for use at compilation
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
109 time rather than run time, you will need that as well as the
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
110 corresponding run time package; typically the dev package will contain
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
111 header files and a library archive. Otherwise, you can download and
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
112 build libraries from sources.
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
113
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
114 The sources of these libraries are available by anonymous CVS from
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
115 cvs.m17n.org.
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
116
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
117 % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/m17n login
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
118 % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/m17n co m17n-db
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
119 % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/m17n co m17n-lib
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
120 % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/m17n co libotf
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
121
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
122 For m17n-lib, if you have problems with making the whole package
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
123 because you lack some other packages on which m17n-lib depends, try to
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
124 configure it with the option "--without-gui".
76e34fe20234 Make the section "Complex Text Layout support
Kenichi Handa <handa@m17n.org>
parents: 100902
diff changeset
125
19014
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
126 * intlfonts-VERSION.tar.gz
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
127
51114
afe35f1e1cbb Notes on fonts, Debian packages.
Dave Love <fx@gnu.org>
parents: 50751
diff changeset
128 The intlfonts distribution contains X11 fonts in various encodings
afe35f1e1cbb Notes on fonts, Debian packages.
Dave Love <fx@gnu.org>
parents: 50751
diff changeset
129 that Emacs can use to display international characters. If you see a
afe35f1e1cbb Notes on fonts, Debian packages.
Dave Love <fx@gnu.org>
parents: 50751
diff changeset
130 non-ASCII character appear as a hollow box, that means you don't have
afe35f1e1cbb Notes on fonts, Debian packages.
Dave Love <fx@gnu.org>
parents: 50751
diff changeset
131 a font for it. You might find one in the intlfonts distribution. If
afe35f1e1cbb Notes on fonts, Debian packages.
Dave Love <fx@gnu.org>
parents: 50751
diff changeset
132 you do have a font for a non-ASCII character, but some characters
afe35f1e1cbb Notes on fonts, Debian packages.
Dave Love <fx@gnu.org>
parents: 50751
diff changeset
133 don't look right, or appear improperly aligned, a font from the
afe35f1e1cbb Notes on fonts, Debian packages.
Dave Love <fx@gnu.org>
parents: 50751
diff changeset
134 intlfonts distribution might look better.
19899
a165ef580ea2 Say a little more about intlfonts. Update copyright year.
Richard M. Stallman <rms@gnu.org>
parents: 19635
diff changeset
135
24070
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
136 The fonts in the intlfonts distribution are also used by the ps-print
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
137 package for printing international characters. The file
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
138 lisp/ps-mule.el defines the *.bdf font files required for printing
24070
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
139 each character set.
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
140
19899
a165ef580ea2 Say a little more about intlfonts. Update copyright year.
Richard M. Stallman <rms@gnu.org>
parents: 19635
diff changeset
141 The intlfonts distribution contains its own installation instructions,
a165ef580ea2 Say a little more about intlfonts. Update copyright year.
Richard M. Stallman <rms@gnu.org>
parents: 19635
diff changeset
142 in the intlfonts/README file.
19014
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
143
32557
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
144 * Image support libraries
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
145
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
146 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>
parents: 34695
diff changeset
147 exception of PBM and XBM images whose support is built-in).
33678
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
148
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
149 On some systems, particularly on GNU/Linux, these libraries may
36752
8d4af7d652c4 Need library devel packages.
Dave Love <fx@gnu.org>
parents: 36733
diff changeset
150 already be present or available as additional packages. Note that if
36753
438ef3d46c8a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36752
diff changeset
151 there is a separate `dev' or `devel' package, for use at compilation
438ef3d46c8a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36752
diff changeset
152 time rather than run time, you will need that as well as the
438ef3d46c8a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36752
diff changeset
153 corresponding run time package; typically the dev package will
438ef3d46c8a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36752
diff changeset
154 contain header files and a library archive. Otherwise, you can
438ef3d46c8a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36752
diff changeset
155 download and build libraries from sources. None of them are vital for
438ef3d46c8a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36752
diff changeset
156 running Emacs; however, note that Emacs will not be able to use
438ef3d46c8a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36752
diff changeset
157 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>
parents: 26905
diff changeset
158
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
159 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>
parents: 34695
diff changeset
160 can be found:
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
161
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49322
diff changeset
162 . libXaw3d for fancy 3D-style
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
163 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>
parents: 26905
diff changeset
164 . libxpm for XPM: ftp://ftp.x.org/contrib/libraries/
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49322
diff changeset
165 Get version 3.4k or later, which lets Emacs
38559
202a8b235456 Recommend XPM 3.4k.
Gerd Moellmann <gerd@gnu.org>
parents: 37479
diff changeset
166 use its own color allocation functions.
69701
6cd56cde7cd4 updated broken link(s)
Ramprasad B <ramprasad_i82@yahoo.com>
parents: 54951
diff changeset
167 . libpng for PNG: ftp://ftp.simplesystems.org/pub/libpng/png/
6cd56cde7cd4 updated broken link(s)
Ramprasad B <ramprasad_i82@yahoo.com>
parents: 54951
diff changeset
168 . 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>
parents: 26905
diff changeset
169 . libjpeg for JPEG: ftp://ftp.uu.net/graphics/jpeg/
36040
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
170 Get version 6b -- 6a is reported to fail in
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
171 Emacs.
32557
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
172 . libtiff for TIFF: http://www.libtiff.org/
91541
5d2d50a49e37 Recommend giflib, not libungif.
Juanma Barranquero <lekktu@gmail.com>
parents: 91534
diff changeset
173 . libgif for GIF: http://sourceforge.net/projects/giflib/
32557
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
174
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
175 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>
parents: 34695
diff changeset
176 `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>
parents: 34695
diff changeset
177 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>
parents: 34695
diff changeset
178 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>
parents: 34695
diff changeset
179 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>
parents: 34695
diff changeset
180 --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>
parents: 26905
diff changeset
181
36040
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
182 * Extra fonts
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
183
71461
90cf42c37682 Mention www.nongnu.org pages that list free Unicode fonts.
Eli Zaretskii <eliz@gnu.org>
parents: 70121
diff changeset
184 The Emacs distribution does not include fonts and does not install
90cf42c37682 Mention www.nongnu.org pages that list free Unicode fonts.
Eli Zaretskii <eliz@gnu.org>
parents: 70121
diff changeset
185 them. You must do that yourself.
49759
e09f7a4a26cd (* Extra fonts): Say that Emacs doesn't include fonts.
Kenichi Handa <handa@m17n.org>
parents: 49600
diff changeset
186
97547
1c58e58f90a5 (Extra fonts): Mention local fonts, don't mention mule-unicode.
Kenichi Handa <handa@m17n.org>
parents: 97043
diff changeset
187 Emacs running on the GNU system supports both X fonts and local fonts
1c58e58f90a5 (Extra fonts): Mention local fonts, don't mention mule-unicode.
Kenichi Handa <handa@m17n.org>
parents: 97043
diff changeset
188 (i.e. the fonts managed by the fontconfig library).
1c58e58f90a5 (Extra fonts): Mention local fonts, don't mention mule-unicode.
Kenichi Handa <handa@m17n.org>
parents: 97043
diff changeset
189
1c58e58f90a5 (Extra fonts): Mention local fonts, don't mention mule-unicode.
Kenichi Handa <handa@m17n.org>
parents: 97043
diff changeset
190 For `Unicode' (ISO 10646) X fonts, see
69701
6cd56cde7cd4 updated broken link(s)
Ramprasad B <ramprasad_i82@yahoo.com>
parents: 54951
diff changeset
191 <URL:http://czyborra.com/unifont/> (packaged in Debian),
51114
afe35f1e1cbb Notes on fonts, Debian packages.
Dave Love <fx@gnu.org>
parents: 50751
diff changeset
192 <URL:http://openlab.ring.gr.jp/efont/> (packaged in Debian). (In
afe35f1e1cbb Notes on fonts, Debian packages.
Dave Love <fx@gnu.org>
parents: 50751
diff changeset
193 recent Debian versions, there is an extensive `misc-fixed' iso10646-1
afe35f1e1cbb Notes on fonts, Debian packages.
Dave Love <fx@gnu.org>
parents: 50751
diff changeset
194 in the default X installation.) Perhaps also see
36040
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
195 <URL:http://www.cl.cam.ac.uk/%7Emgk25/ucs-fonts.html>.
51114
afe35f1e1cbb Notes on fonts, Debian packages.
Dave Love <fx@gnu.org>
parents: 50751
diff changeset
196
36040
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
197 <URL:http://czyborra.com/charsets/> has basic fonts for Emacs's
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
198 ISO-8859 charsets.
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
199
69701
6cd56cde7cd4 updated broken link(s)
Ramprasad B <ramprasad_i82@yahoo.com>
parents: 54951
diff changeset
200 XFree86 release 4 (from <URL:ftp://ftp.xfree86.org/pub/XFree86/> and mirrors)
36040
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
201 contains font support for most, if not all, of the charsets that Emacs
51114
afe35f1e1cbb Notes on fonts, Debian packages.
Dave Love <fx@gnu.org>
parents: 50751
diff changeset
202 currently supports, including iso10646-1 encoded fonts for use with
afe35f1e1cbb Notes on fonts, Debian packages.
Dave Love <fx@gnu.org>
parents: 50751
diff changeset
203 the mule-unicode charsets. The font files should also be usable with
afe35f1e1cbb Notes on fonts, Debian packages.
Dave Love <fx@gnu.org>
parents: 50751
diff changeset
204 older X releases. Note that XFree 4 contains many iso10646-1 fonts
afe35f1e1cbb Notes on fonts, Debian packages.
Dave Love <fx@gnu.org>
parents: 50751
diff changeset
205 with minimal character repertoires, which can cause problems -- see
afe35f1e1cbb Notes on fonts, Debian packages.
Dave Love <fx@gnu.org>
parents: 50751
diff changeset
206 etc/PROBLEMS.
36040
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
207
71540
3171e85739c2 etl-unicode fonts are good for display, not only for ps-print.
Eli Zaretskii <eliz@gnu.org>
parents: 71461
diff changeset
208 BDF Unicode fonts etl-unicode.tar.gz are available from
3171e85739c2 etl-unicode fonts are good for display, not only for ps-print.
Eli Zaretskii <eliz@gnu.org>
parents: 71461
diff changeset
209 <URL:ftp://ftp.x.org/contrib/fonts/> and
3171e85739c2 etl-unicode fonts are good for display, not only for ps-print.
Eli Zaretskii <eliz@gnu.org>
parents: 71461
diff changeset
210 <URL:ftp://ftp.xfree86.org/pub/mirror/X.Org/contrib/fonts/>. These
3171e85739c2 etl-unicode fonts are good for display, not only for ps-print.
Eli Zaretskii <eliz@gnu.org>
parents: 71461
diff changeset
211 fonts can also be used by ps-print and ps-mule to print Unicode
3171e85739c2 etl-unicode fonts are good for display, not only for ps-print.
Eli Zaretskii <eliz@gnu.org>
parents: 71461
diff changeset
212 characters.
45112
19de9bf49e2d Add information about BDF fonts in etl-unicode.tar.gz.
Eli Zaretskii <eliz@gnu.org>
parents: 44432
diff changeset
213
71461
90cf42c37682 Mention www.nongnu.org pages that list free Unicode fonts.
Eli Zaretskii <eliz@gnu.org>
parents: 70121
diff changeset
214 Finally, the Web pages <URL:http://www.nongnu.org/freefont/index.html>
104132
75a1b898c727 * INSTALL: Fix free fonts URL.
Chong Yidong <cyd@stupidchicken.com>
parents: 102826
diff changeset
215 and <URL:http://www.gnu.org/software/freefont/sources/resources.html>
75a1b898c727 * INSTALL: Fix free fonts URL.
Chong Yidong <cyd@stupidchicken.com>
parents: 102826
diff changeset
216 list a large number of free Unicode fonts.
71461
90cf42c37682 Mention www.nongnu.org pages that list free Unicode fonts.
Eli Zaretskii <eliz@gnu.org>
parents: 70121
diff changeset
217
50742
4c3754d75224 (* GNU/Linux development packages): Tell people to
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49801
diff changeset
218 * GNU/Linux development packages
4c3754d75224 (* GNU/Linux development packages): Tell people to
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49801
diff changeset
219
4c3754d75224 (* GNU/Linux development packages): Tell people to
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49801
diff changeset
220 Many GNU/Linux systems do not come with development packages by
4c3754d75224 (* GNU/Linux development packages): Tell people to
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49801
diff changeset
221 default; they just include the files that you need to run Emacs, but
4c3754d75224 (* GNU/Linux development packages): Tell people to
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49801
diff changeset
222 not those you need to compile it. For example, to compile Emacs with
4c3754d75224 (* GNU/Linux development packages): Tell people to
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 49801
diff changeset
223 X11 support, you may need to install the special `X11 development'
50751
ec954e051a6b (* GNU/Linux development packages): Mention Debian and
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 50742
diff changeset
224 package. For example, in April 2003, the package names to install
77155
0913bc126b05 Fix typos.
Glenn Morris <rgm@gnu.org>
parents: 75769
diff changeset
225 were `XFree86-devel' and `Xaw3d-devel' on Red Hat. On Debian, the
51114
afe35f1e1cbb Notes on fonts, Debian packages.
Dave Love <fx@gnu.org>
parents: 50751
diff changeset
226 packages necessary to build the installed version should be
afe35f1e1cbb Notes on fonts, Debian packages.
Dave Love <fx@gnu.org>
parents: 50751
diff changeset
227 sufficient; they can be installed using `apt-get build-dep emacs21' in
afe35f1e1cbb Notes on fonts, Debian packages.
Dave Love <fx@gnu.org>
parents: 50751
diff changeset
228 Debian 3 and above.
19014
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
229
47715
b03e194a48e7 *** empty log message ***
Kenichi Handa <handa@m17n.org>
parents: 47616
diff changeset
230
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
231 DETAILED BUILDING AND INSTALLATION:
15209
884b7293ccc7 Mention Windows 95.
Richard M. Stallman <rms@gnu.org>
parents: 15039
diff changeset
232
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
233 (This is for a Unix or Unix-like system. For MS-DOS and Windows 3.X,
99467
41a356a46f3f Move MS-DOS specific instructions to msdos/INSTALL.
Eli Zaretskii <eliz@gnu.org>
parents: 98512
diff changeset
234 see msdos/INSTALL. For Windows 9X, Windows ME, Windows NT, Windows
41a356a46f3f Move MS-DOS specific instructions to msdos/INSTALL.
Eli Zaretskii <eliz@gnu.org>
parents: 98512
diff changeset
235 2000, Windows XP/2003, and Windows Vista/2008, see the file
98512
7d9a5b179102 Fix case of "GNUstep".
Glenn Morris <rgm@gnu.org>
parents: 98461
diff changeset
236 nt/INSTALL. For GNUstep and Mac OS X, see nextstep/INSTALL.)
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
237
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
238 1) Make sure your system has enough swapping space allocated to handle
33639
26131b1a1dc1 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32572
diff changeset
239 a program whose pure code is 1.5 MB and whose data area is at
42221
1af7ce62a225 Update Emacs memory and disk usage numbers.
Eli Zaretskii <eliz@gnu.org>
parents: 42213
diff changeset
240 least 2.8 MB and can reach 100 MB or more. If the swapping space is
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
241 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
242 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
243 running the final dumped Emacs.
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49322
diff changeset
244
42221
1af7ce62a225 Update Emacs memory and disk usage numbers.
Eli Zaretskii <eliz@gnu.org>
parents: 42213
diff changeset
245 Building Emacs requires about 140 MB of disk space (including the
1af7ce62a225 Update Emacs memory and disk usage numbers.
Eli Zaretskii <eliz@gnu.org>
parents: 42213
diff changeset
246 Emacs sources) Once installed, Emacs occupies about 77 MB in the file
42213
a85200bb3831 Remove text that describes Leim as a separate package.
Eli Zaretskii <eliz@gnu.org>
parents: 40890
diff changeset
247 system where it is installed; this includes the executable files, Lisp
a85200bb3831 Remove text that describes Leim as a separate package.
Eli Zaretskii <eliz@gnu.org>
parents: 40890
diff changeset
248 libraries, miscellaneous data files, and on-line documentation. If
a85200bb3831 Remove text that describes Leim as a separate package.
Eli Zaretskii <eliz@gnu.org>
parents: 40890
diff changeset
249 the building and installation take place in different directories,
42221
1af7ce62a225 Update Emacs memory and disk usage numbers.
Eli Zaretskii <eliz@gnu.org>
parents: 42213
diff changeset
250 then the installation procedure momentarily requires 140+77 MB.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
251
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
252 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
253 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>
parents: 34695
diff changeset
254 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>
parents: 34695
diff changeset
255 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>
parents: 34695
diff changeset
256 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>
parents: 34695
diff changeset
257 order by the vendor name.)
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
258
16309
fea88c3fb20c Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents: 15936
diff changeset
259 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
260 or in a separate directory.
fea88c3fb20c Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents: 15936
diff changeset
261
fea88c3fb20c Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents: 15936
diff changeset
262 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
263 directory and run the program `configure' as follows:
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
264
22255
7851f4551208 Clarify about omitting CONFIGURATION-NAME with configure.
Richard M. Stallman <rms@gnu.org>
parents: 21692
diff changeset
265 ./configure [CONFIGURATION-NAME] [--OPTION[=VALUE]] ...
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
266
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
267 The CONFIGURATION-NAME argument should be a configuration name given
22255
7851f4551208 Clarify about omitting CONFIGURATION-NAME with configure.
Richard M. Stallman <rms@gnu.org>
parents: 21692
diff changeset
268 in `./etc/MACHINES', with the system version number added at the end.
7851f4551208 Clarify about omitting CONFIGURATION-NAME with configure.
Richard M. Stallman <rms@gnu.org>
parents: 21692
diff changeset
269
7851f4551208 Clarify about omitting CONFIGURATION-NAME with configure.
Richard M. Stallman <rms@gnu.org>
parents: 21692
diff changeset
270 You should try first omitting CONFIGURATION-NAME. This way,
7851f4551208 Clarify about omitting CONFIGURATION-NAME with configure.
Richard M. Stallman <rms@gnu.org>
parents: 21692
diff changeset
271 `configure' will try to guess your system type. If it cannot guess,
7851f4551208 Clarify about omitting CONFIGURATION-NAME with configure.
Richard M. Stallman <rms@gnu.org>
parents: 21692
diff changeset
272 or if something goes wrong in building or installing Emacs this way,
7851f4551208 Clarify about omitting CONFIGURATION-NAME with configure.
Richard M. Stallman <rms@gnu.org>
parents: 21692
diff changeset
273 try again specifying the proper CONFIGURATION-NAME explicitly.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
274
9760
05fbcd364e6e update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents: 9507
diff changeset
275 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
276 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
277 system has X, and arrange to use it if present.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
278
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
279 The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
280 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
281 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
282 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
283 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
284 accept a list of directories, separated with colons.
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
285
9760
05fbcd364e6e update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents: 9507
diff changeset
286 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
287 configure Emacs; use the option `--with-x-toolkit=TOOLKIT', where
71724
706c31ef66dc (DETAILED BUILDING AND INSTALLATION): Minor corrections.
Richard M. Stallman <rms@gnu.org>
parents: 71540
diff changeset
288 TOOLKIT is `athena', `motif' or `gtk' (`yes' and `lucid' are synonyms
706c31ef66dc (DETAILED BUILDING AND INSTALLATION): Minor corrections.
Richard M. Stallman <rms@gnu.org>
parents: 71540
diff changeset
289 for `athena'). On some systems, it does not work to use a toolkit
706c31ef66dc (DETAILED BUILDING AND INSTALLATION): Minor corrections.
Richard M. Stallman <rms@gnu.org>
parents: 71540
diff changeset
290 with shared libraries. A free implementation of Motif, called
706c31ef66dc (DETAILED BUILDING AND INSTALLATION): Minor corrections.
Richard M. Stallman <rms@gnu.org>
parents: 71540
diff changeset
291 LessTif, is available from <http://www.lesstif.org>. Compiling with
706c31ef66dc (DETAILED BUILDING AND INSTALLATION): Minor corrections.
Richard M. Stallman <rms@gnu.org>
parents: 71540
diff changeset
292 LessTif or Motif causes a standard File Selection Dialog to pop up
706c31ef66dc (DETAILED BUILDING AND INSTALLATION): Minor corrections.
Richard M. Stallman <rms@gnu.org>
parents: 71540
diff changeset
293 when you invoke file commands with the mouse. You can get fancy
706c31ef66dc (DETAILED BUILDING AND INSTALLATION): Minor corrections.
Richard M. Stallman <rms@gnu.org>
parents: 71540
diff changeset
294 3D-style scroll bars, even without LessTif/Motif, if you have the
706c31ef66dc (DETAILED BUILDING AND INSTALLATION): Minor corrections.
Richard M. Stallman <rms@gnu.org>
parents: 71540
diff changeset
295 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>
parents: 34695
diff changeset
296 availability).
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
297
49322
2cbb0b823e83 GTK version
Jan Djärv <jan.h.d@swipnet.se>
parents: 47716
diff changeset
298 If `--with-x-toolkit=gtk' is specified, you can tell configure where
2cbb0b823e83 GTK version
Jan Djärv <jan.h.d@swipnet.se>
parents: 47716
diff changeset
299 to search for GTK by specifying `--with-pkg-config-prog=PATH' where
69735
382d6be8bd43 Change gtk 2.0 to gtk 2.4
Jan Djärv <jan.h.d@swipnet.se>
parents: 69701
diff changeset
300 PATH is the pathname to pkg-config. Note that GTK version 2.4 or
49322
2cbb0b823e83 GTK version
Jan Djärv <jan.h.d@swipnet.se>
parents: 47716
diff changeset
301 newer is required for Emacs.
2cbb0b823e83 GTK version
Jan Djärv <jan.h.d@swipnet.se>
parents: 47716
diff changeset
302
34484
1db330e58c71 No need for --with-pop anymore.
Eli Zaretskii <eliz@gnu.org>
parents: 33812
diff changeset
303 The Emacs mail reader RMAIL is configured to be able to read mail from
1db330e58c71 No need for --with-pop anymore.
Eli Zaretskii <eliz@gnu.org>
parents: 33812
diff changeset
304 a POP3 server by default. Versions of the POP protocol older than
1db330e58c71 No need for --with-pop anymore.
Eli Zaretskii <eliz@gnu.org>
parents: 33812
diff changeset
305 POP3 are not supported. For Kerberos-authenticated POP add
1db330e58c71 No need for --with-pop anymore.
Eli Zaretskii <eliz@gnu.org>
parents: 33812
diff changeset
306 `--with-kerberos', for Hesiod support add `--with-hesiod'. While POP3
1db330e58c71 No need for --with-pop anymore.
Eli Zaretskii <eliz@gnu.org>
parents: 33812
diff changeset
307 is always enabled, whether Emacs actually uses POP is controlled by
1db330e58c71 No need for --with-pop anymore.
Eli Zaretskii <eliz@gnu.org>
parents: 33812
diff changeset
308 individual users--see the Rmail chapter of the Emacs manual.
15936
6a126c5c87bb Describe --with-pop and related options.
Richard M. Stallman <rms@gnu.org>
parents: 15828
diff changeset
309
33678
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
310 For image support you may have to download, build, and install the
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
311 appropriate image support libraries for image types other than XBM and
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
312 PBM, see the list of URLs in "ADDITIONAL DISTRIBUTION FILES" above.
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
313 (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>
parents: 26905
diff changeset
314
33678
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
315 To disable individual types of image support in Emacs for some reason,
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
316 even though configure finds the libraries, you can configure with one
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
317 or more of these options:
32557
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
318
33678
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
319 --without-xpm for XPM image support
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
320 --without-jpeg for JPEG image support
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
321 --without-tiff for TIFF image support
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
322 --without-gif for GIF image support
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
323 --without-png for PNG image support
32557
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
324
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
325 Use --without-toolkit-scroll-bars to disable LessTif/Motif or Xaw3d
77540
a04ea5f96dad (DETAILED BUILDING AND INSTALLATION): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 77289
diff changeset
326 scroll bars.
51826
19ef2c37b89f (DETAILED BUILDING AND INSTALLATION): Describe new
Kim F. Storm <storm@cua.dk>
parents: 51114
diff changeset
327
19ef2c37b89f (DETAILED BUILDING AND INSTALLATION): Describe new
Kim F. Storm <storm@cua.dk>
parents: 51114
diff changeset
328 Use --without-xim to inhibit the default use of X Input Methods. In
19ef2c37b89f (DETAILED BUILDING AND INSTALLATION): Describe new
Kim F. Storm <storm@cua.dk>
parents: 51114
diff changeset
329 this case, the X resource useXIM can be used to turn on use of XIM.
19ef2c37b89f (DETAILED BUILDING AND INSTALLATION): Describe new
Kim F. Storm <storm@cua.dk>
parents: 51114
diff changeset
330
19ef2c37b89f (DETAILED BUILDING AND INSTALLATION): Describe new
Kim F. Storm <storm@cua.dk>
parents: 51114
diff changeset
331 Use --disable-largefile omits support for files larger than 2GB on
77540
a04ea5f96dad (DETAILED BUILDING AND INSTALLATION): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 77289
diff changeset
332 systems which support that.
51826
19ef2c37b89f (DETAILED BUILDING AND INSTALLATION): Describe new
Kim F. Storm <storm@cua.dk>
parents: 51114
diff changeset
333
19ef2c37b89f (DETAILED BUILDING AND INSTALLATION): Describe new
Kim F. Storm <storm@cua.dk>
parents: 51114
diff changeset
334 Use --without-sound to disable sound support.
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
335
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
336 The `--prefix=PREFIXDIR' option specifies where the installation process
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
337 should put emacs and its data files. This defaults to `/usr/local'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
338 - Emacs (and the other utilities users run) go in PREFIXDIR/bin
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
339 (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
340 - 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
341 (where VERSION is the version number of Emacs, like `19.27').
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
342 - 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
343 PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
344 (where CONFIGURATION is the configuration name, like mips-dec-ultrix4.2),
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
345 unless the `--exec-prefix' option says otherwise.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
346
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
347 The `--exec-prefix=EXECDIR' option allows you to specify a separate
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
348 portion of the directory tree for installing architecture-specific
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
349 files, like executables and utility programs. If specified,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
350 - Emacs (and the other utilities users run) go in EXECDIR/bin, and
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
351 - 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
352 EXECDIR/libexec/emacs/VERSION/CONFIGURATION.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
353 EXECDIR/bin should be a directory that is normally in users' PATHs.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
354
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
355 For example, the command
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
356
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
357 ./configure mips-dec-ultrix --with-x11
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
358
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
359 configures Emacs to build for a DECstation running Ultrix, with
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
360 support for the X11 window system.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
361
9760
05fbcd364e6e update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents: 9507
diff changeset
362 `configure' doesn't do any compilation or installation
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
363 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
364 `./Makefile', `lib-src/Makefile', `oldXMenu/Makefile',
151b595bc41a Formerly INSTALL.~33~
David J. MacKenzie <djm@gnu.org>
parents: 9498
diff changeset
365 `lwlib/Makefile', `src/Makefile', and `./src/config.h'. For details
151b595bc41a Formerly INSTALL.~33~
David J. MacKenzie <djm@gnu.org>
parents: 9498
diff changeset
366 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
367 HAND', below.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
368
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
369 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
370 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
371 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
372 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
373 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
374 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
375 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
376 `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
377 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
378 disable caching, for debugging `configure'.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
379
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
380 If the description of the system configuration printed by `configure'
77155
0913bc126b05 Fix typos.
Glenn Morris <rgm@gnu.org>
parents: 75769
diff changeset
381 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>
parents: 34695
diff changeset
382 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>
parents: 34695
diff changeset
383 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>
parents: 34695
diff changeset
384 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>
parents: 34695
diff changeset
385 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>
parents: 34695
diff changeset
386 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>
parents: 34695
diff changeset
387
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
388 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>
parents: 34695
diff changeset
389 directories for some header files, or link against optional
35034
4b4cc897a985 Fix a typo.
Eli Zaretskii <eliz@gnu.org>
parents: 34994
diff changeset
390 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>
parents: 34695
diff changeset
391 `configure' and the build process which follows it to do that by
77540
a04ea5f96dad (DETAILED BUILDING AND INSTALLATION): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 77289
diff changeset
392 setting the variables CPPFLAGS, CFLAGS, LDFLAGS, LIBS, CPP and CC
a04ea5f96dad (DETAILED BUILDING AND INSTALLATION): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 77289
diff changeset
393 before running `configure'. CPP is the command which invokes the
77289
c853532ee388 Mention CPP.
Glenn Morris <rgm@gnu.org>
parents: 77155
diff changeset
394 preprocessor, CPPFLAGS lists the options passed to it, CFLAGS are
c853532ee388 Mention CPP.
Glenn Morris <rgm@gnu.org>
parents: 77155
diff changeset
395 compilation options, LDFLAGS are options used when linking, LIBS are
c853532ee388 Mention CPP.
Glenn Morris <rgm@gnu.org>
parents: 77155
diff changeset
396 libraries to link against, and CC is the command which invokes the
91573
9ab8772424c0 Mention that gcc is the default compiler.
Glenn Morris <rgm@gnu.org>
parents: 91566
diff changeset
397 compiler. By default, gcc is used if available.
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
398
35062
3168ff2c349b Tweaks to configure instructions and saving space.
Dave Love <fx@gnu.org>
parents: 35034
diff changeset
399 Here's an example of a `configure' invocation, assuming a Bourne-like
3168ff2c349b Tweaks to configure instructions and saving space.
Dave Love <fx@gnu.org>
parents: 35034
diff changeset
400 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>
parents: 34695
diff changeset
401
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
402 CPPFLAGS='-I/foo/myinclude' LDFLAGS='-L/bar/mylib' \
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
403 CFLAGS='-O3' LIBS='-lfoo -lbar' ./configure
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
404
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
405 (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>
parents: 34695
diff changeset
406 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>
parents: 34695
diff changeset
407 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>
parents: 34695
diff changeset
408 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>
parents: 34695
diff changeset
409 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>
parents: 34695
diff changeset
410 libraries in addition to the standard ones.
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
411
77540
a04ea5f96dad (DETAILED BUILDING AND INSTALLATION): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 77289
diff changeset
412 For some libraries, like Gtk+, fontconfig and ALSA, `configure' use
a04ea5f96dad (DETAILED BUILDING AND INSTALLATION): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 77289
diff changeset
413 pkg-config to find where those libraries are installed.
a04ea5f96dad (DETAILED BUILDING AND INSTALLATION): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 77289
diff changeset
414 If you want pkg-config to look in special directories, you have to set
a04ea5f96dad (DETAILED BUILDING AND INSTALLATION): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 77289
diff changeset
415 the environment variable PKG_CONFIG_PATH to point to the directories
74486
917f46cb7b70 (DETAILED BUILDING AND INSTALLATION): Document usage
Jan Djärv <jan.h.d@swipnet.se>
parents: 74439
diff changeset
416 where the .pc-files for those libraries are.
917f46cb7b70 (DETAILED BUILDING AND INSTALLATION): Document usage
Jan Djärv <jan.h.d@swipnet.se>
parents: 74439
diff changeset
417 For example:
917f46cb7b70 (DETAILED BUILDING AND INSTALLATION): Document usage
Jan Djärv <jan.h.d@swipnet.se>
parents: 74439
diff changeset
418
917f46cb7b70 (DETAILED BUILDING AND INSTALLATION): Document usage
Jan Djärv <jan.h.d@swipnet.se>
parents: 74439
diff changeset
419 PKG_CONFIG_PATH='/usr/local/alsa/lib/pkgconfig:/opt/gtk+-2.8/lib/pkgconfig' \
917f46cb7b70 (DETAILED BUILDING AND INSTALLATION): Document usage
Jan Djärv <jan.h.d@swipnet.se>
parents: 74439
diff changeset
420 ./configure
917f46cb7b70 (DETAILED BUILDING AND INSTALLATION): Document usage
Jan Djärv <jan.h.d@swipnet.se>
parents: 74439
diff changeset
421
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
422 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
423 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
424 "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
425 yourself.
fea88c3fb20c Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents: 15936
diff changeset
426
fea88c3fb20c Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents: 15936
diff changeset
427 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
428 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
429
fea88c3fb20c Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents: 15936
diff changeset
430 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
431
fea88c3fb20c Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents: 15936
diff changeset
432 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
433 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
434 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
435
fea88c3fb20c Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents: 15936
diff changeset
436 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
437 that supports the `VPATH' variable, such as GNU `make'.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
438
21692
303a96060ff1 More of previous.
Richard M. Stallman <rms@gnu.org>
parents: 21691
diff changeset
439 3c) Some people try to build in a separate directory by filling
303a96060ff1 More of previous.
Richard M. Stallman <rms@gnu.org>
parents: 21691
diff changeset
440 it full of symlinks to the files in the real source directory.
21691
2a33987c0f02 Explain trouble with link farms in `make install'.
Richard M. Stallman <rms@gnu.org>
parents: 21343
diff changeset
441 If you do that, `make all' does work, but `make install' fails:
2a33987c0f02 Explain trouble with link farms in `make install'.
Richard M. Stallman <rms@gnu.org>
parents: 21343
diff changeset
442 it copies the symbolic links rather than the actual files.
2a33987c0f02 Explain trouble with link farms in `make install'.
Richard M. Stallman <rms@gnu.org>
parents: 21343
diff changeset
443
2a33987c0f02 Explain trouble with link farms in `make install'.
Richard M. Stallman <rms@gnu.org>
parents: 21343
diff changeset
444 As far as is known, there is no particular reason to use
2a33987c0f02 Explain trouble with link farms in `make install'.
Richard M. Stallman <rms@gnu.org>
parents: 21343
diff changeset
445 a directory full of links rather than use the standard GNU
2a33987c0f02 Explain trouble with link farms in `make install'.
Richard M. Stallman <rms@gnu.org>
parents: 21343
diff changeset
446 facilities to build in a separate directory (see 3b above).
2a33987c0f02 Explain trouble with link farms in `make install'.
Richard M. Stallman <rms@gnu.org>
parents: 21343
diff changeset
447
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
448 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
449 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
450 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
451 itself. YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
452 rather than `defvar', as used by `./lisp/paths.el'. For example,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
453
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
454 (setq news-inews-program "/usr/bin/inews")
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
455
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
456 is how you would override the default value of the variable
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
457 news-inews-program (which is "/usr/local/inews").
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
458
11119
c303d2623f63 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10672
diff changeset
459 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
460 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
461 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
462 doing, you'll make a mistake.
c303d2623f63 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10672
diff changeset
463
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
464 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
465 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
466 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
467 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
468 src/Makefile.in if you wish to figure out how to do that). For all
23330
3f2ab6f2bb5c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22255
diff changeset
469 else, use site-init.el. Do not load byte-compiled code which
3f2ab6f2bb5c *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22255
diff changeset
470 was build with a non-nil value of `byte-compile-dynamic'.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
471
11732
072d319a485f Clarify effect of setting load-path before dumping.
Richard M. Stallman <rms@gnu.org>
parents: 11729
diff changeset
472 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
473 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
474 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
475
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
476 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
477 not use expand-file-name or any other function which may look
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
478 something up in the system's password and user information database.
21089
0413a3ff3b8d PROBLEMS is now in the etc directory.
Richard M. Stallman <rms@gnu.org>
parents: 20213
diff changeset
479 See `./etc/PROBLEMS' for more details on which systems this affects.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
480
7627
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
481 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
482 need to create them if you have nothing to put in them.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
483
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
484 6) Refer to the file `./etc/TERMS' for information on fields you may
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
485 wish to add to various termcap entries. The files `./etc/termcap.ucb'
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
486 and `./etc/termcap.dat' may already contain appropriately-modified
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
487 entries.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
488
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
489 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
490 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
491 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
492 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
493 directories ../lisp, ../lib-src, ../info.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
494
11733
ae51069237f2 Clarification about running executable in place.
Richard M. Stallman <rms@gnu.org>
parents: 11732
diff changeset
495 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
496 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
497 are installed in the following directories:
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
498
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
499 `/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
500 `emacs', `etags', `ctags', `b2m', `emacsclient',
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
501 and `rcs-checkin'.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
502
9760
05fbcd364e6e update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents: 9507
diff changeset
503 `/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library;
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
504 `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
505 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
506 Lisp library changes from one version of Emacs to
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
507 another, including the version number in the path
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
508 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
509 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
510 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
511
9760
05fbcd364e6e update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents: 9507
diff changeset
512 `/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
513 file, the `yow' database, and other
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
514 architecture-independent files Emacs might need while
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
515 running. VERSION is as specified for `.../lisp'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
516
9760
05fbcd364e6e update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents: 9507
diff changeset
517 `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
518 programs used by Emacs that users are not expected to
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
519 run themselves.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
520 `VERSION' is the number of the Emacs version you are
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
521 installing, and `CONFIGURATION-NAME' is the argument
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
522 you gave to the `configure' program to identify the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
523 architecture and operating system of your machine,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
524 like `mips-dec-ultrix' or `sparc-sun-sunos'. Since
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
525 these files are specific to the version of Emacs,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
526 operating system, and architecture in use, including
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
527 the configuration name in the path allows you to have
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
528 several versions of Emacs for any mix of machines and
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
529 operating systems installed at the same time; this is
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
530 useful for sites at which different kinds of machines
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
531 share the file system Emacs is installed on.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
532
75274
2e668483dd85 Info files moved to share/info.
Chong Yidong <cyd@stupidchicken.com>
parents: 74486
diff changeset
533 `/usr/local/share/info' holds the on-line documentation for Emacs,
2e668483dd85 Info files moved to share/info.
Chong Yidong <cyd@stupidchicken.com>
parents: 74486
diff changeset
534 known as "info files". Many other GNU programs are
2e668483dd85 Info files moved to share/info.
Chong Yidong <cyd@stupidchicken.com>
parents: 74486
diff changeset
535 documented using info files as well, so this directory
2e668483dd85 Info files moved to share/info.
Chong Yidong <cyd@stupidchicken.com>
parents: 74486
diff changeset
536 stands apart from the other, Emacs-specific
2e668483dd85 Info files moved to share/info.
Chong Yidong <cyd@stupidchicken.com>
parents: 74486
diff changeset
537 directories.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
538
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
539 `/usr/local/man/man1' holds the man pages for the programs installed
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
540 in `/usr/local/bin'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
541
54951
88d561445a39 Move the info about site-lisp dirs,
Richard M. Stallman <rms@gnu.org>
parents: 52772
diff changeset
542 Any version of Emacs, whether installed or not, also looks for Lisp
88d561445a39 Move the info about site-lisp dirs,
Richard M. Stallman <rms@gnu.org>
parents: 52772
diff changeset
543 files in these directories.
88d561445a39 Move the info about site-lisp dirs,
Richard M. Stallman <rms@gnu.org>
parents: 52772
diff changeset
544
88d561445a39 Move the info about site-lisp dirs,
Richard M. Stallman <rms@gnu.org>
parents: 52772
diff changeset
545 `/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp
88d561445a39 Move the info about site-lisp dirs,
Richard M. Stallman <rms@gnu.org>
parents: 52772
diff changeset
546 files installed for Emacs version VERSION only.
88d561445a39 Move the info about site-lisp dirs,
Richard M. Stallman <rms@gnu.org>
parents: 52772
diff changeset
547
88d561445a39 Move the info about site-lisp dirs,
Richard M. Stallman <rms@gnu.org>
parents: 52772
diff changeset
548 `/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp
88d561445a39 Move the info about site-lisp dirs,
Richard M. Stallman <rms@gnu.org>
parents: 52772
diff changeset
549 files installed for all Emacs versions.
88d561445a39 Move the info about site-lisp dirs,
Richard M. Stallman <rms@gnu.org>
parents: 52772
diff changeset
550
88d561445a39 Move the info about site-lisp dirs,
Richard M. Stallman <rms@gnu.org>
parents: 52772
diff changeset
551 When Emacs is installed, it searches for its Lisp files
88d561445a39 Move the info about site-lisp dirs,
Richard M. Stallman <rms@gnu.org>
parents: 52772
diff changeset
552 in `/usr/local/share/emacs/VERSION/site-lisp', then in
88d561445a39 Move the info about site-lisp dirs,
Richard M. Stallman <rms@gnu.org>
parents: 52772
diff changeset
553 `/usr/local/share/emacs/site-lisp', and finally in
88d561445a39 Move the info about site-lisp dirs,
Richard M. Stallman <rms@gnu.org>
parents: 52772
diff changeset
554 `/usr/local/share/emacs/VERSION/lisp'.
88d561445a39 Move the info about site-lisp dirs,
Richard M. Stallman <rms@gnu.org>
parents: 52772
diff changeset
555
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
556 If these directories are not what you want, you can specify where to
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
557 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
558 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
559 the command. See the section below called `MAKE VARIABLES' for more
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
560 information on this.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
561
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
562 8) Check the file `dir' in your site's info directory (usually
75274
2e668483dd85 Info files moved to share/info.
Chong Yidong <cyd@stupidchicken.com>
parents: 74486
diff changeset
563 /usr/local/share/info) to make sure that it has a menu entry for the
2e668483dd85 Info files moved to share/info.
Chong Yidong <cyd@stupidchicken.com>
parents: 74486
diff changeset
564 Emacs info files.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
565
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
566 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
567 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
568 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
569
12620
7f74acc9dfeb Update disk requirements.
Karl Heuer <kwzh@gnu.org>
parents: 12368
diff changeset
570 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
571 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
572 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>
parents: 26416
diff changeset
573 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>
parents: 26416
diff changeset
574 of the input methods from the Leim package, you can remove the
47561
5bb8339ffc9e Remove outdated details about leim subdir.
Richard M. Stallman <rms@gnu.org>
parents: 45112
diff changeset
575 unneeded files in the leim subdirectories of your site's lisp
5bb8339ffc9e Remove outdated details about leim subdir.
Richard M. Stallman <rms@gnu.org>
parents: 45112
diff changeset
576 directory (usually /usr/local/share/emacs/VERSION/).
12620
7f74acc9dfeb Update disk requirements.
Karl Heuer <kwzh@gnu.org>
parents: 12368
diff changeset
577
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
578
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
579
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
580 MAKE VARIABLES
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
581
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
582 You can change where the build process installs Emacs and its data
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
583 files by specifying values for `make' variables as part of the `make'
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
584 command line. For example, if you type
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
585
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
586 make install bindir=/usr/local/gnubin
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
587
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
588 the `bindir=/usr/local/gnubin' argument indicates that the Emacs
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
589 executable files should go in `/usr/local/gnubin', not
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
590 `/usr/local/bin'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
591
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
592 Here is a complete list of the variables you may want to set.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
593
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
594 `bindir' indicates where to put executable programs that users can
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
595 run. This defaults to /usr/local/bin.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
596
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
597 `datadir' indicates where to put the architecture-independent
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
598 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
599 defaults to /usr/local/share. We create the following
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
600 subdirectories under `datadir':
14147
4d7b8a3fe240 Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents: 14020
diff changeset
601 - `emacs/VERSION/lisp', containing the Emacs Lisp library, and
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
602 - `emacs/VERSION/etc', containing the Emacs tutorial, the DOC
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
603 file, and the `yow' database.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
604 `VERSION' is the number of the Emacs version you are installing,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
605 like `18.59' or `19.0'. Since these files vary from one version
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
606 of Emacs to another, including the version number in the path
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
607 allows you to have several versions of Emacs installed at the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
608 same time; this means that you don't have to make Emacs
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
609 unavailable while installing a new version.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
610
9499
151b595bc41a Formerly INSTALL.~33~
David J. MacKenzie <djm@gnu.org>
parents: 9498
diff changeset
611 `libexecdir' indicates where to put architecture-specific data files that
151b595bc41a Formerly INSTALL.~33~
David J. MacKenzie <djm@gnu.org>
parents: 9498
diff changeset
612 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
613 We create the following subdirectories under `libexecdir':
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
614 - `emacs/VERSION/CONFIGURATION-NAME', containing executable
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
615 programs used by Emacs that users are not expected to run
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49322
diff changeset
616 themselves.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
617 `VERSION' is the number of the Emacs version you are installing,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
618 and `CONFIGURATION-NAME' is the argument you gave to the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
619 `configure' program to identify the architecture and operating
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
620 system of your machine, like `mips-dec-ultrix' or
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
621 `sparc-sun-sunos'. Since these files are specific to the version
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
622 of Emacs, operating system, and architecture in use, including
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
623 the configuration name in the path allows you to have several
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
624 versions of Emacs for any mix of machines and operating systems
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
625 installed at the same time; this is useful for sites at which
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
626 different kinds of machines share the file system Emacs is
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
627 installed on.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
628
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
629 `infodir' indicates where to put the info files distributed with
75274
2e668483dd85 Info files moved to share/info.
Chong Yidong <cyd@stupidchicken.com>
parents: 74486
diff changeset
630 Emacs; it defaults to `/usr/local/share/info'.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
631
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
632 `mandir' indicates where to put the man pages for Emacs and its
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
633 utilities (like `etags'); it defaults to
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
634 `/usr/local/man/man1'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
635
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
636 `manext' gives the extension the man pages should be installed with.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
637 It should contain a period, followed by the appropriate
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
638 digit. It defaults to `.1'. For example given the default
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
639 values for `mandir' and `manext', the Emacs man page would be
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
640 installed as `/usr/local/man/man1/emacs.1'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
641
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
642 `prefix' doesn't give a path for any specific part of Emacs; instead,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
643 its value is used to determine the defaults for all the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
644 architecture-independent path variables - `datadir',
9499
151b595bc41a Formerly INSTALL.~33~
David J. MacKenzie <djm@gnu.org>
parents: 9498
diff changeset
645 `sharedstatedir', `infodir', and `mandir'. Its default value is
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
646 `/usr/local'; the other variables add on `lib' or `man' to it
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
647 by default.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
648
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
649 For example, suppose your site generally places GNU software
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
650 under `/usr/users/software/gnusoft' instead of `/usr/local'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
651 By including
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
652 `prefix=/usr/users/software/gnusoft'
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
653 in the arguments to `make', you can instruct the build process
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
654 to place all of the Emacs data files in the appropriate
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
655 directories under that path.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
656
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
657 `exec_prefix' serves the same purpose as `prefix', but instead
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
658 determines the default values for the architecture-dependent
9499
151b595bc41a Formerly INSTALL.~33~
David J. MacKenzie <djm@gnu.org>
parents: 9498
diff changeset
659 path variables - `bindir' and `libexecdir'.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
660
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
661 The above variables serve analogous purposes in the makefiles for all
21343
a3059cd301f1 Remove some directories that don't really work now.
Richard M. Stallman <rms@gnu.org>
parents: 21089
diff changeset
662 GNU software; this variable is specific to Emacs.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
663
12620
7f74acc9dfeb Update disk requirements.
Karl Heuer <kwzh@gnu.org>
parents: 12368
diff changeset
664 `archlibdir' indicates where Emacs installs and expects the executable
7f74acc9dfeb Update disk requirements.
Karl Heuer <kwzh@gnu.org>
parents: 12368
diff changeset
665 files and other architecture-dependent data it uses while
7f74acc9dfeb Update disk requirements.
Karl Heuer <kwzh@gnu.org>
parents: 12368
diff changeset
666 running. Its default value, based on `libexecdir' (which
7f74acc9dfeb Update disk requirements.
Karl Heuer <kwzh@gnu.org>
parents: 12368
diff changeset
667 see), is `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME'
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
668 (where VERSION and CONFIGURATION-NAME are as described above).
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
669
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
670 Remember that you must specify any variable values you need each time
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
671 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
672 emacs, test it, and then run `make' again to install the files, you
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
673 must provide the same variable settings each time. To make the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
674 settings persist, you can edit them into the `Makefile' in the top
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
675 directory, but be aware that running the `configure' program erases
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
676 `Makefile' and rebuilds it from `Makefile.in'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
677
21343
a3059cd301f1 Remove some directories that don't really work now.
Richard M. Stallman <rms@gnu.org>
parents: 21089
diff changeset
678 The path for finding Lisp files is specified in src/paths.h,
a3059cd301f1 Remove some directories that don't really work now.
Richard M. Stallman <rms@gnu.org>
parents: 21089
diff changeset
679 a file which is generated by running configure. To change the path,
a3059cd301f1 Remove some directories that don't really work now.
Richard M. Stallman <rms@gnu.org>
parents: 21089
diff changeset
680 you can edit the definition of PATH_LOADSEARCH in that file
a3059cd301f1 Remove some directories that don't really work now.
Richard M. Stallman <rms@gnu.org>
parents: 21089
diff changeset
681 before you run `make'.
a3059cd301f1 Remove some directories that don't really work now.
Richard M. Stallman <rms@gnu.org>
parents: 21089
diff changeset
682
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
683 The top-level Makefile stores the variable settings it used in the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
684 Makefiles for the subdirectories, so you don't have to specify them
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
685 when running make in the subdirectories.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
686
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
687
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
688 CONFIGURATION BY HAND
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
689
7864
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
690 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
691 following steps.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
692
13667
fbf777f663d3 Correct .in.in and .h.in in file names.
Richard M. Stallman <rms@gnu.org>
parents: 12620
diff changeset
693 1) Copy `./src/config.in' to `./src/config.h'.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
694
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
695 2) Consult `./etc/MACHINES' to see what configuration name you should
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
696 use for your system. Look at the code of the `configure' script to
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
697 see which operating system and architecture description files from
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
698 `src/s' and `src/m' should be used for that configuration name. Edit
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
699 `src/config.h', and change the two `#include' directives to include
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
700 the appropriate system and architecture description files.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
701
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
702 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
703 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
704 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
705 changing the s/*.h and m/*.h files. Occasionally you may need to
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
706 redefine parameters used in `./lib-src/movemail.c'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
707
7864
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
708 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
709 `Makefile.in' files. First copy `Makefile.in' to `Makefile.c',
14020
1ea8008d4bd8 Fix typo.
Karl Heuer <kwzh@gnu.org>
parents: 13926
diff changeset
710 then edit in appropriate substitutions for the @...@ constructs,
7864
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
711 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
712 that run cpp to construct `Makefile'.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
713
7864
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
714 4) Create `Makefile' files in various other directories
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
715 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
716 just a matter of substitution.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
717
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
718 The `configure' script is built from `configure.in' by the `autoconf'
42396
f8555eb1fe49 <CONFIGURATION BY HAND> Now requires autoconf 2.51.
Kim F. Storm <storm@cua.dk>
parents: 42221
diff changeset
719 program. You need version 2.51 or newer of `autoconf' to rebuild
36267
6abfaee147b1 Correct required autoconf version
Dave Love <fx@gnu.org>
parents: 36123
diff changeset
720 `configure'.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
721
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
722 BUILDING GNU EMACS BY HAND
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
723
9507
6773cf9c2e75 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 9499
diff changeset
724 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
725 the following steps.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
726
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
727 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
728 `./src/paths.h' from the template file `./src/paths.in', changing
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
729 the paths to the values specified in `./Makefile'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
730
7864
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
731 2) Go to directory `./lib-src' and run `make'. This creates
77155
0913bc126b05 Fix typos.
Glenn Morris <rgm@gnu.org>
parents: 75769
diff changeset
732 executables named `ctags' and `etags' and `make-docfile' and
0913bc126b05 Fix typos.
Glenn Morris <rgm@gnu.org>
parents: 75769
diff changeset
733 `digest-doc' and `test-distrib'. And others.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
734
7864
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
735 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
736 the `./lisp' and `./lib-src' subdirectories using names `../lisp' and
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
737 `../lib-src'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
738
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
739 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
740 which has another name that contains a version number.
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
741 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
742
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
743 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
744 current Emacs version. This file contains documentation strings for
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
745 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
746 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
747 file for an Emacs version as long as you keep using that Emacs
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
748 version.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
749
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
750
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
751 INSTALLATION BY HAND
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
752
9507
6773cf9c2e75 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 9499
diff changeset
753 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
754 directory of the Emacs distribution.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
755
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
756 1) Copy `./lisp' and its subdirectories, `./etc', and the executables
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
757 in `./lib-src' to their final destinations, as selected in `./src/paths.h'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
758
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
759 Strictly speaking, not all of the executables in `./lib-src' need be copied.
47616
fb782cfe9a36 *** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 47561
diff changeset
760 - The programs `cvtmail', `fakemail', `hexl',
77155
0913bc126b05 Fix typos.
Glenn Morris <rgm@gnu.org>
parents: 75769
diff changeset
761 `movemail', `profile', `rcs2log', and `vcdiff' are used by Emacs;
0913bc126b05 Fix typos.
Glenn Morris <rgm@gnu.org>
parents: 75769
diff changeset
762 they do need to be copied.
7864
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
763 - The programs `etags', `ctags', `emacsclient', `b2m', and `rcs-checkin'
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
764 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
765 - The programs `make-docfile' and `test-distrib' were
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
766 used in building Emacs, and are not needed any more.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
767 - The programs `digest-doc' and `sorted-doc' convert a `DOC' file into
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
768 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
769
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
770 2) Copy the files in `./info' to the place specified in
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
771 `./lisp/site-init.el' or `./lisp/paths.el'. Note that if the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
772 destination directory already contains a file named `dir', you
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
773 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
774 distribution. Instead, you should make sure that the existing `dir'
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
775 file contains an appropriate menu entry for the Emacs info.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
776
23353
2a5d306408cb *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 23330
diff changeset
777 3) Copy `./src/emacs' to `/usr/local/bin', or to some other directory
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
778 in users' search paths. `./src/emacs' has an alternate name
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
779 `./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
780 `/usr/local/bin/emacs' pointing to that alternate name, as an easy way
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
781 of installing different versions.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
782
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
783 You can delete `./src/temacs'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
784
23353
2a5d306408cb *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 23330
diff changeset
785 4) Copy the programs `b2m', `emacsclient', `ctags', `etags', and
7864
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
786 `rcs-checkin' from `./lib-src' to `/usr/local/bin'. These programs are
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
787 intended for users to run.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
788
23353
2a5d306408cb *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 23330
diff changeset
789 5) Copy the man pages in `./etc' for emacs, ctags, and etags into the
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
790 appropriate man directories.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
791
23353
2a5d306408cb *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 23330
diff changeset
792 6) 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
793 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
794 the source on line for debugging.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
795
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
796
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
797 PROBLEMS
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
798
21089
0413a3ff3b8d PROBLEMS is now in the etc directory.
Richard M. Stallman <rms@gnu.org>
parents: 20213
diff changeset
799 See the file PROBLEMS in etc subdirectory for a list of various
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
800 problems sometimes encountered, and what to do about them.
34939
44564f6157cc Move the copying conditions to the end of the file.
Eli Zaretskii <eliz@gnu.org>
parents: 34879
diff changeset
801
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
802 This file is part of GNU Emacs.
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
803
94719
1a762a842f80 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 91573
diff changeset
804 GNU Emacs is free software: you can redistribute it and/or modify
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
805 it under the terms of the GNU General Public License as published by
94719
1a762a842f80 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 91573
diff changeset
806 the Free Software Foundation, either version 3 of the License, or
1a762a842f80 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 91573
diff changeset
807 (at your option) any later version.
34994
fb1c795f1a5e Minor style and punctuation changes from Kim Storm.
Eli Zaretskii <eliz@gnu.org>
parents: 34939
diff changeset
808
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
809 GNU Emacs is distributed in the hope that it will be useful,
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
810 but WITHOUT ANY WARRANTY; without even the implied warranty of
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
811 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
812 GNU General Public License for more details.
34939
44564f6157cc Move the copying conditions to the end of the file.
Eli Zaretskii <eliz@gnu.org>
parents: 34879
diff changeset
813
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
814 You should have received a copy of the GNU General Public License
94719
1a762a842f80 Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents: 91573
diff changeset
815 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.