annotate INSTALL @ 38660:65fd4c8a6447

(Position Info): Add a cross-reference to where hl-line-mode is described.
author Eli Zaretskii <eliz@gnu.org>
date Thu, 02 Aug 2001 10:35:40 +0000
parents 202a8b235456
children f644b704f8b8
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
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
2 Copyright (c) 1992, 1994, 1996, 1997, 2000 Free software Foundation, Inc.
34939
44564f6157cc Move the copying conditions to the end of the file.
Eli Zaretskii <eliz@gnu.org>
parents: 34879
diff changeset
3 See the end of the file for copying permissions.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
4
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
5
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
6 BASIC INSTALLATION
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
7
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
8 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
9 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
10 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
11 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
12 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
13 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
14 your system.
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 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
17 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
18 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
19 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
20 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
21 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
22 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
23
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
24 1. If you want to be able to input international characters which
34994
fb1c795f1a5e Minor style and punctuation changes from Kim Storm.
Eli Zaretskii <eliz@gnu.org>
parents: 34939
diff changeset
25 your keyboard doesn't support directly (i.e. you cannot type
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
26 them at the shell prompt), download the leim-M.N.tar.gz
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
27 distribution and unpack it into the same directory where you have
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
28 unpacked the main Emacs distribution. See ADDITIONAL
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
29 DISTRIBUTION FILES, below, for more about this.
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
30
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
31 2. Make sure your system has at least 120 MB of free disk space.
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
32
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
33 3a. `cd' to the directory where you unpacked Emacs and invoke the
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
34 `configure' script:
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
35
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
36 ./configure
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
37
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
38 3b. Alternatively, create a separate directory, outside the source
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
39 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
40 from there:
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
41
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
42 SOURCE-DIR/configure
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
43
35062
3168ff2c349b Tweaks to configure instructions and saving space.
Dave Love <fx@gnu.org>
parents: 35034
diff changeset
44 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
45 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
46
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
47 4. When `configure' finishes, it prints several lines of details
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
48 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
49 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
50 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
51 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
52
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
53 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
54 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
55 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
56 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
57
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
58 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
59 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
60 "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
61
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
62 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
63 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
64
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
65 5. If you need to run the `configure' script more than once (e.g.,
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
66 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
67 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
68
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
69 make distclean
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
70 ./configure
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
71
34994
fb1c795f1a5e Minor style and punctuation changes from Kim Storm.
Eli Zaretskii <eliz@gnu.org>
parents: 34939
diff changeset
72 6. 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
73
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
74 make
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
75
34994
fb1c795f1a5e Minor style and punctuation changes from Kim Storm.
Eli Zaretskii <eliz@gnu.org>
parents: 34939
diff changeset
76 7. If `make' succeeds, it will build an executable program `emacs'
fb1c795f1a5e Minor style and punctuation changes from Kim Storm.
Eli Zaretskii <eliz@gnu.org>
parents: 34939
diff changeset
77 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
78 it works:
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
79
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
80 src/emacs -q
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
81
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
82 8. Assuming that the program `src/emacs' starts and displays its
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
83 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
84 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
85
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
86 make install
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
87
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
88 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
89 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
90 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
91
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
92 make clean
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
93
35062
3168ff2c349b Tweaks to configure instructions and saving space.
Dave Love <fx@gnu.org>
parents: 35034
diff changeset
94 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
95 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
96 versions.
3168ff2c349b Tweaks to configure instructions and saving space.
Dave Love <fx@gnu.org>
parents: 35034
diff changeset
97
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
98
19014
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
99 ADDITIONAL DISTRIBUTION FILES
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
100
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
101 * leim-M.N.tar.gz
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
102
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
103 The Emacs Lisp code for input methods for various international
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
104 character scripts allows you to input characters in scripts which are
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
105 not directly supported by your keyboard. It is distributed in a
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
106 separate tar file because it amounts to a significant fraction of the
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
107 size of the distribution. This tar file is called leim-M.N.tar.gz,
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
108 with the same version number as Emacs, and it unpacks into the
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
109 directory emacs-M.N/leim.
19014
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
110
24799
7f38d541d411 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 24452
diff changeset
111 You should unpack leim-M.N.tar.gz into the same directory where you
7f38d541d411 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 24452
diff changeset
112 have previously unpacked the main Emacs distribution. It fills in the
7f38d541d411 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 24452
diff changeset
113 contents of one subdirectory, which is present in the main Emacs
7f38d541d411 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 24452
diff changeset
114 distribution only in dummy form.
7f38d541d411 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 24452
diff changeset
115
7f38d541d411 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 24452
diff changeset
116 Once you have unpacked the Leim tar file into the Emacs source tree,
7f38d541d411 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 24452
diff changeset
117 building and installing Emacs automatically installs the input method
7f38d541d411 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 24452
diff changeset
118 support as well. If you have built Emacs without unpacking Leim
7f38d541d411 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 24452
diff changeset
119 first, just unpack Leim, build Emacs again, and install it again.
19014
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
120
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
121 * intlfonts-VERSION.tar.gz
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
122
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
123 The intlfonts distribution contains X11 fonts that Emacs needs in
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
124 order to display international characters. If you see a non-ASCII
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
125 character appear as a hollow box, that means you don't have a font for
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
126 it. You might find a font in the intlfonts distribution. If you do
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
127 have a font for a non-ASCII character, but some characters don't look
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
128 right, or appear improperly aligned, a font from the intlfonts
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
129 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
130
24070
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
131 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
132 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
133 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
134 each character set.
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
135
19899
a165ef580ea2 Say a little more about intlfonts. Update copyright year.
Richard M. Stallman <rms@gnu.org>
parents: 19635
diff changeset
136 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
137 in the intlfonts/README file.
19014
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
138
26416
1384b7926bb1 Better ELisp Reference instructions.
Gerd Moellmann <gerd@gnu.org>
parents: 26326
diff changeset
139 * elisp-manual-M.N.tar.gz
1384b7926bb1 Better ELisp Reference instructions.
Gerd Moellmann <gerd@gnu.org>
parents: 26326
diff changeset
140
1384b7926bb1 Better ELisp Reference instructions.
Gerd Moellmann <gerd@gnu.org>
parents: 26326
diff changeset
141 This distribution contains the Emacs Lisp Reference Manual which
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
142 complements the Emacs Manual. (The Emacs Manual is accessible from
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
143 within the editor by typing "C-h i", then selecting the "Emacs" item
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
144 from the menu, or by clicking "Help" in the menu bar and selecting
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
145 "Read Emacs Manual".) It is a good idea to install the Emacs Lisp
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
146 Reference Manual after installing Emacs, to complete the on-line
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
147 documentation of Emacs in Info.
26416
1384b7926bb1 Better ELisp Reference instructions.
Gerd Moellmann <gerd@gnu.org>
parents: 26326
diff changeset
148
1384b7926bb1 Better ELisp Reference instructions.
Gerd Moellmann <gerd@gnu.org>
parents: 26326
diff changeset
149 If you have installed Texinfo, you can install the Emacs Lisp
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
150 Reference Manual this way (after unpacking the elisp-manual-M.N.tar.gz
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
151 file):
26271
b47b74998eef *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 24799
diff changeset
152
26416
1384b7926bb1 Better ELisp Reference instructions.
Gerd Moellmann <gerd@gnu.org>
parents: 26326
diff changeset
153 cd elisp-manual-M.N
1384b7926bb1 Better ELisp Reference instructions.
Gerd Moellmann <gerd@gnu.org>
parents: 26326
diff changeset
154 ./configure --prefix=PREFIXDIR
1384b7926bb1 Better ELisp Reference instructions.
Gerd Moellmann <gerd@gnu.org>
parents: 26326
diff changeset
155 make install
1384b7926bb1 Better ELisp Reference instructions.
Gerd Moellmann <gerd@gnu.org>
parents: 26326
diff changeset
156
1384b7926bb1 Better ELisp Reference instructions.
Gerd Moellmann <gerd@gnu.org>
parents: 26326
diff changeset
157 Otherwise, you can install it manually. Just copy the files elisp and
1384b7926bb1 Better ELisp Reference instructions.
Gerd Moellmann <gerd@gnu.org>
parents: 26326
diff changeset
158 elisp-* from the elisp-manual-M.N directory to your site's info
1384b7926bb1 Better ELisp Reference instructions.
Gerd Moellmann <gerd@gnu.org>
parents: 26326
diff changeset
159 directory (see the description of `infodir', below), and make sure
1384b7926bb1 Better ELisp Reference instructions.
Gerd Moellmann <gerd@gnu.org>
parents: 26326
diff changeset
160 that file `dir' in this directory contains an entry like this:
1384b7926bb1 Better ELisp Reference instructions.
Gerd Moellmann <gerd@gnu.org>
parents: 26326
diff changeset
161
1384b7926bb1 Better ELisp Reference instructions.
Gerd Moellmann <gerd@gnu.org>
parents: 26326
diff changeset
162 * Elisp: (elisp). The Emacs Lisp Reference Manual.
26271
b47b74998eef *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 24799
diff changeset
163
32557
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
164 * Image support libraries
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
165
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
166 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
167 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
168
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
169 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
170 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
171 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
172 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
173 corresponding run time package; typically the dev package will
438ef3d46c8a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36752
diff changeset
174 contain header files and a library archive. Otherwise, you can
438ef3d46c8a *** empty log message ***
Dave Love <fx@gnu.org>
parents: 36752
diff changeset
175 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
176 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
177 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
178
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
179 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
180 can be found:
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
181
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
182 . libXaw3d for fancy 3D-style
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
183 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
184 . libxpm for XPM: ftp://ftp.x.org/contrib/libraries/
38559
202a8b235456 Recommend XPM 3.4k.
Gerd Moellmann <gerd@gnu.org>
parents: 37479
diff changeset
185 Get version 3.4k or later, which lets Emacs
202a8b235456 Recommend XPM 3.4k.
Gerd Moellmann <gerd@gnu.org>
parents: 37479
diff changeset
186 use its own color allocation functions.
32557
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
187 . libpng for PNG: ftp://www.libpng.org/pub/png/
33678
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
188 . libz (for PNG): http://www.info-zip.org/pub/infozip/zlib/
32557
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
189 . libjpeg for JPEG: ftp://ftp.uu.net/graphics/jpeg/
36040
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
190 Get version 6b -- 6a is reported to fail in
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
191 Emacs.
32557
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
192 . libtiff for TIFF: http://www.libtiff.org/
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
193 . libungif for GIF:
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
194 http://prtr-13.ucsc.edu/~badger/software/libungif/index.shtml
35519
e550edb781e6 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 35062
diff changeset
195 Ensure you get version 4.1.0b1 or higher of libungif -- a bug in
e550edb781e6 *** empty log message ***
Dave Love <fx@gnu.org>
parents: 35062
diff changeset
196 4.1.0 can crash Emacs.
32557
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
197
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
198 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
199 `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
200 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
201 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
202 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
203 --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
204
36040
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
205 * Extra fonts
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
206
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
207 To take proper advantage of Emacs 21's mule-unicode charsets, you need
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
208 a Unicode font. For information on Unicode fonts for X, see
36733
274bff56ea1e efont URL
Dave Love <fx@gnu.org>
parents: 36267
diff changeset
209 <URL:http://czyborra.com/unifont/>,
274bff56ea1e efont URL
Dave Love <fx@gnu.org>
parents: 36267
diff changeset
210 <URL:http://openlab.ring.gr.jp/efont/> and
36040
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
211 <URL:http://www.cl.cam.ac.uk/%7Emgk25/ucs-fonts.html>.
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
212 <URL:http://czyborra.com/charsets/> has basic fonts for Emacs's
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
213 ISO-8859 charsets.
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
214
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
215 XFree86 release 4 (from <URL:ftp://ftp.xfree86.org/> and mirrors)
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
216 contains font support for most, if not all, of the charsets that Emacs
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
217 supports. The font files should be usable separately with older X
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
218 releases.
858f9cee9288 extra fonts
Dave Love <fx@gnu.org>
parents: 35576
diff changeset
219
19014
63c862461563 Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents: 16861
diff changeset
220
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
221 DETAILED BUILDING AND INSTALLATION:
15209
884b7293ccc7 Mention Windows 95.
Richard M. Stallman <rms@gnu.org>
parents: 15039
diff changeset
222
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
223 (This is for a Unix or Unix-like system. For MS-DOS and Windows 3.X,
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
224 see below; search for MSDOG. For Windows 9X, Windows ME, Windows NT,
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
225 and Windows 2000, see the file nt/INSTALL. For the Mac, see the file
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
226 mac/INSTALL.)
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
227
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
228 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
229 a program whose pure code is 1.5 MB and whose data area is at
26131b1a1dc1 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32572
diff changeset
230 least 2.5 MB and can reach 80 MB or more. If the swapping space is
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
231 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
232 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
233 running the final dumped Emacs.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
234
33639
26131b1a1dc1 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32572
diff changeset
235 Building Emacs requires about 95 MB of disk space (including the Emacs
26131b1a1dc1 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32572
diff changeset
236 sources), or 130 MB if Leim is used. Once installed, Emacs occupies
26131b1a1dc1 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32572
diff changeset
237 about 60 MB (70 MB with Leim) in the file system where it is
26131b1a1dc1 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32572
diff changeset
238 installed; this includes the executable files, Lisp libraries,
26131b1a1dc1 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32572
diff changeset
239 miscellaneous data files, and on-line documentation. If the building
26131b1a1dc1 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 32572
diff changeset
240 and installation take place in different directories, then the
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
241 installation procedure momentarily requires 95+60 MB (130+70 MB).
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
242
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
243 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
244 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
245 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
246 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
247 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
248 order by the vendor name.)
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
249
16309
fea88c3fb20c Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents: 15936
diff changeset
250 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
251 or in a separate directory.
fea88c3fb20c Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents: 15936
diff changeset
252
fea88c3fb20c Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents: 15936
diff changeset
253 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
254 directory and run the program `configure' as follows:
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
255
22255
7851f4551208 Clarify about omitting CONFIGURATION-NAME with configure.
Richard M. Stallman <rms@gnu.org>
parents: 21692
diff changeset
256 ./configure [CONFIGURATION-NAME] [--OPTION[=VALUE]] ...
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
257
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
258 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
259 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
260
7851f4551208 Clarify about omitting CONFIGURATION-NAME with configure.
Richard M. Stallman <rms@gnu.org>
parents: 21692
diff changeset
261 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
262 `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
263 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
264 try again specifying the proper CONFIGURATION-NAME explicitly.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
265
9760
05fbcd364e6e update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents: 9507
diff changeset
266 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
267 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
268 system has X, and arrange to use it if present.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
269
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
270 The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
271 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
272 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
273 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
274 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
275 accept a list of directories, separated with colons.
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
276
9760
05fbcd364e6e update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents: 9507
diff changeset
277 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
278 configure Emacs; use the option `--with-x-toolkit=TOOLKIT', where
05fbcd364e6e update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents: 9507
diff changeset
279 TOOLKIT is `athena' or `motif' (`yes' and `lucid' are synonyms for
05fbcd364e6e update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents: 9507
diff changeset
280 `athena'). On some systems, it does not work to use a toolkit with
32557
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
281 shared libraries. A free implementation of Motif, called LessTif, is
35576
6dbcd107fbe0 Mention that LessTif and Motif cause File Selection dialog to pop up
Eli Zaretskii <eliz@gnu.org>
parents: 35519
diff changeset
282 available ftom <http://www.lesstif.org>. Compiling with LessTif or
6dbcd107fbe0 Mention that LessTif and Motif cause File Selection dialog to pop up
Eli Zaretskii <eliz@gnu.org>
parents: 35519
diff changeset
283 Motif causes a standard File Selection Dialog to pop up when you type
6dbcd107fbe0 Mention that LessTif and Motif cause File Selection dialog to pop up
Eli Zaretskii <eliz@gnu.org>
parents: 35519
diff changeset
284 "C-x C-f" and similar commands. You can get fancy 3D-style scroll
6dbcd107fbe0 Mention that LessTif and Motif cause File Selection dialog to pop up
Eli Zaretskii <eliz@gnu.org>
parents: 35519
diff changeset
285 bars, even without LessTif/Motif, if you have the Xaw3d library
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
286 installed (see "Image support libraries" above for Xaw3d
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
287 availability).
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
288
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
289 The `--with-gcc' option specifies that the build process should
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
290 compile Emacs using GCC. If you don't want to use GCC, specify
9760
05fbcd364e6e update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents: 9507
diff changeset
291 `--with-gcc=no'. If you omit this option, `configure' will search
05fbcd364e6e update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents: 9507
diff changeset
292 for GCC in your path, and use it if present.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
293
34484
1db330e58c71 No need for --with-pop anymore.
Eli Zaretskii <eliz@gnu.org>
parents: 33812
diff changeset
294 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
295 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
296 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
297 `--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
298 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
299 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
300
33678
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
301 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
302 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
303 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
304 (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
305
33678
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
306 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
307 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
308 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
309
33678
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
310 --without-xpm for XPM image support
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
311 --without-jpeg for JPEG image support
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
312 --without-tiff for TIFF image support
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
313 --without-gif for GIF image support
22b21b3ab3b0 Modify stuff about image libraries.
Dave Love <fx@gnu.org>
parents: 33639
diff changeset
314 --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
315
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
316 Use --without-toolkit-scroll-bars to disable LessTif/Motif or Xaw3d
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
317 scroll bars. --without-xim disables the use of X Input Methods, and
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
318 --disable-largefile omits support for files larger than 2GB on systems
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
319 which support that.
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
320
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
321 The `--prefix=PREFIXDIR' option specifies where the installation process
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
322 should put emacs and its data files. This defaults to `/usr/local'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
323 - Emacs (and the other utilities users run) go in PREFIXDIR/bin
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
324 (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
325 - 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
326 (where VERSION is the version number of Emacs, like `19.27').
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
327 - 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
328 PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
329 (where CONFIGURATION is the configuration name, like mips-dec-ultrix4.2),
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
330 unless the `--exec-prefix' option says otherwise.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
331
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
332 The `--exec-prefix=EXECDIR' option allows you to specify a separate
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
333 portion of the directory tree for installing architecture-specific
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
334 files, like executables and utility programs. If specified,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
335 - Emacs (and the other utilities users run) go in EXECDIR/bin, and
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
336 - 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
337 EXECDIR/libexec/emacs/VERSION/CONFIGURATION.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
338 EXECDIR/bin should be a directory that is normally in users' PATHs.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
339
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
340 For example, the command
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
341
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
342 ./configure mips-dec-ultrix --with-x11
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
343
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
344 configures Emacs to build for a DECstation running Ultrix, with
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
345 support for the X11 window system.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
346
9760
05fbcd364e6e update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents: 9507
diff changeset
347 `configure' doesn't do any compilation or installation
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
348 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
349 `./Makefile', `lib-src/Makefile', `oldXMenu/Makefile',
151b595bc41a Formerly INSTALL.~33~
David J. MacKenzie <djm@gnu.org>
parents: 9498
diff changeset
350 `lwlib/Makefile', `src/Makefile', and `./src/config.h'. For details
151b595bc41a Formerly INSTALL.~33~
David J. MacKenzie <djm@gnu.org>
parents: 9498
diff changeset
351 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
352 HAND', below.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
353
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
354 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
355 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
356 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
357 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
358 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
359 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
360 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
361 `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
362 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
363 disable caching, for debugging `configure'.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
364
34879
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
365 If the description of the system configuration printed by `configure'
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
366 is not right, or if it claims some of the fatures or libraries are not
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
367 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
368 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
369 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
370 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
371 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
372
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
373 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
374 directories for some header files, or link against optional
35034
4b4cc897a985 Fix a typo.
Eli Zaretskii <eliz@gnu.org>
parents: 34994
diff changeset
375 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
376 `configure' and the build process which follows it to do that by
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
377 setting the variables CPPFLAGS, CFLAGS, LDFLAGS, LIBS, and CC before
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
378 running `configure'. CPPFLAGS lists the options passed to the
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
379 preprocessor, CFLAGS are compilation options, LDFLAGS are options used
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
380 when linking, LIBS are libraries to link against, and CC is the
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
381 command which invokes the compiler.
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
382
35062
3168ff2c349b Tweaks to configure instructions and saving space.
Dave Love <fx@gnu.org>
parents: 35034
diff changeset
383 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
384 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
385
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
386 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
387 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
388
b37dd70cce0a Add basic installation procedure which assumes `configure' does its job.
Eli Zaretskii <eliz@gnu.org>
parents: 34695
diff changeset
389 (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
390 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
391 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
392 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
393 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
394 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
395
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
396 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
397 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
398 "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
399 yourself.
fea88c3fb20c Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents: 15936
diff changeset
400
fea88c3fb20c Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents: 15936
diff changeset
401 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
402 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
403
fea88c3fb20c Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents: 15936
diff changeset
404 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
405
fea88c3fb20c Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents: 15936
diff changeset
406 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
407 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
408 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
409
fea88c3fb20c Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents: 15936
diff changeset
410 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
411 that supports the `VPATH' variable, such as GNU `make'.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
412
21692
303a96060ff1 More of previous.
Richard M. Stallman <rms@gnu.org>
parents: 21691
diff changeset
413 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
414 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
415 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
416 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
417
2a33987c0f02 Explain trouble with link farms in `make install'.
Richard M. Stallman <rms@gnu.org>
parents: 21343
diff changeset
418 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
419 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
420 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
421
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
422 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
423 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
424 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
425 itself. YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
426 rather than `defvar', as used by `./lisp/paths.el'. For example,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
427
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
428 (setq news-inews-program "/usr/bin/inews")
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
429
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
430 is how you would override the default value of the variable
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
431 news-inews-program (which is "/usr/local/inews").
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
432
11119
c303d2623f63 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10672
diff changeset
433 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
434 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
435 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
436 doing, you'll make a mistake.
c303d2623f63 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 10672
diff changeset
437
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
438 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
439 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
440 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
441 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
442 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
443 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
444 was build with a non-nil value of `byte-compile-dynamic'.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
445
11732
072d319a485f Clarify effect of setting load-path before dumping.
Richard M. Stallman <rms@gnu.org>
parents: 11729
diff changeset
446 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
447 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
448 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
449
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
450 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
451 not use expand-file-name or any other function which may look
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
452 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
453 See `./etc/PROBLEMS' for more details on which systems this affects.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
454
7627
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
455 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
456 need to create them if you have nothing to put in them.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
457
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
458 6) Refer to the file `./etc/TERMS' for information on fields you may
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
459 wish to add to various termcap entries. The files `./etc/termcap.ucb'
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
460 and `./etc/termcap.dat' may already contain appropriately-modified
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
461 entries.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
462
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
463 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
464 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
465 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
466 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
467 directories ../lisp, ../lib-src, ../info.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
468
11733
ae51069237f2 Clarification about running executable in place.
Richard M. Stallman <rms@gnu.org>
parents: 11732
diff changeset
469 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
470 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
471 are installed in the following directories:
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
472
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
473 `/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
474 `emacs', `etags', `ctags', `b2m', `emacsclient',
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
475 and `rcs-checkin'.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
476
9760
05fbcd364e6e update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents: 9507
diff changeset
477 `/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library;
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
478 `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
479 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
480 Lisp library changes from one version of Emacs to
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
481 another, including the version number in the path
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
482 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
483 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
484 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
485
4d7b8a3fe240 Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents: 14020
diff changeset
486 `/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp
4d7b8a3fe240 Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents: 14020
diff changeset
487 files installed for Emacs version VERSION only.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
488
14147
4d7b8a3fe240 Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents: 14020
diff changeset
489 `/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp
4d7b8a3fe240 Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents: 14020
diff changeset
490 files installed for all Emacs versions.
4d7b8a3fe240 Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents: 14020
diff changeset
491
4d7b8a3fe240 Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents: 14020
diff changeset
492 When Emacs is installed, it searches for its Lisp files
4d7b8a3fe240 Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents: 14020
diff changeset
493 in `/usr/local/share/emacs/VERSION/site-lisp', then in
4d7b8a3fe240 Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents: 14020
diff changeset
494 `/usr/local/share/emacs/site-lisp', and finally in
4d7b8a3fe240 Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents: 14020
diff changeset
495 `/usr/local/share/emacs/VERSION/lisp'.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
496
9760
05fbcd364e6e update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents: 9507
diff changeset
497 `/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
498 file, the `yow' database, and other
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
499 architecture-independent files Emacs might need while
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
500 running. VERSION is as specified for `.../lisp'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
501
9760
05fbcd364e6e update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents: 9507
diff changeset
502 `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
503 programs used by Emacs that users are not expected to
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
504 run themselves.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
505 `VERSION' is the number of the Emacs version you are
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
506 installing, and `CONFIGURATION-NAME' is the argument
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
507 you gave to the `configure' program to identify the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
508 architecture and operating system of your machine,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
509 like `mips-dec-ultrix' or `sparc-sun-sunos'. Since
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
510 these files are specific to the version of Emacs,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
511 operating system, and architecture in use, including
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
512 the configuration name in the path allows you to have
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
513 several versions of Emacs for any mix of machines and
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
514 operating systems installed at the same time; this is
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
515 useful for sites at which different kinds of machines
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
516 share the file system Emacs is installed on.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
517
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
518 `/usr/local/info' holds the on-line documentation for Emacs, known as
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
519 "info files". Many other GNU programs are documented
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
520 using info files as well, so this directory stands
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
521 apart from the other, Emacs-specific directories.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
522
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
523 `/usr/local/man/man1' holds the man pages for the programs installed
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
524 in `/usr/local/bin'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
525
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
526 If these directories are not what you want, you can specify where to
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
527 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
528 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
529 the command. See the section below called `MAKE VARIABLES' for more
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
530 information on this.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
531
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
532 8) Check the file `dir' in your site's info directory (usually
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
533 /usr/local/info) to make sure that it has a menu entry for the Emacs
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
534 info files.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
535
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
536 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
537 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
538 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
539
12620
7f74acc9dfeb Update disk requirements.
Karl Heuer <kwzh@gnu.org>
parents: 12368
diff changeset
540 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
541 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
542 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
543 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
544 of the input methods from the Leim package, you can remove the
9f4d574a38b5 Explain that unused input methods can be removed from the installation
Eli Zaretskii <eliz@gnu.org>
parents: 26416
diff changeset
545 unneeded files in the leim/quail, leim/skk, and leim/skk-dic
9f4d574a38b5 Explain that unused input methods can be removed from the installation
Eli Zaretskii <eliz@gnu.org>
parents: 26416
diff changeset
546 subdirectories of your site's lisp directory (usually
9f4d574a38b5 Explain that unused input methods can be removed from the installation
Eli Zaretskii <eliz@gnu.org>
parents: 26416
diff changeset
547 /usr/local/share/emacs/VERSION/).
12620
7f74acc9dfeb Update disk requirements.
Karl Heuer <kwzh@gnu.org>
parents: 12368
diff changeset
548
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
549
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
550
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
551 MAKE VARIABLES
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
552
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
553 You can change where the build process installs Emacs and its data
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
554 files by specifying values for `make' variables as part of the `make'
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
555 command line. For example, if you type
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
556
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
557 make install bindir=/usr/local/gnubin
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
558
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
559 the `bindir=/usr/local/gnubin' argument indicates that the Emacs
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
560 executable files should go in `/usr/local/gnubin', not
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
561 `/usr/local/bin'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
562
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
563 Here is a complete list of the variables you may want to set.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
564
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
565 `bindir' indicates where to put executable programs that users can
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
566 run. This defaults to /usr/local/bin.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
567
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
568 `datadir' indicates where to put the architecture-independent
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
569 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
570 defaults to /usr/local/share. We create the following
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
571 subdirectories under `datadir':
14147
4d7b8a3fe240 Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents: 14020
diff changeset
572 - `emacs/VERSION/lisp', containing the Emacs Lisp library, and
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
573 - `emacs/VERSION/etc', containing the Emacs tutorial, the DOC
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
574 file, and the `yow' database.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
575 `VERSION' is the number of the Emacs version you are installing,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
576 like `18.59' or `19.0'. Since these files vary from one version
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
577 of Emacs to another, including the version number in the path
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
578 allows you to have several versions of Emacs installed at the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
579 same time; this means that you don't have to make Emacs
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
580 unavailable while installing a new version.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
581
9499
151b595bc41a Formerly INSTALL.~33~
David J. MacKenzie <djm@gnu.org>
parents: 9498
diff changeset
582 `libexecdir' indicates where to put architecture-specific data files that
151b595bc41a Formerly INSTALL.~33~
David J. MacKenzie <djm@gnu.org>
parents: 9498
diff changeset
583 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
584 We create the following subdirectories under `libexecdir':
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
585 - `emacs/VERSION/CONFIGURATION-NAME', containing executable
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
586 programs used by Emacs that users are not expected to run
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
587 themselves.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
588 `VERSION' is the number of the Emacs version you are installing,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
589 and `CONFIGURATION-NAME' is the argument you gave to the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
590 `configure' program to identify the architecture and operating
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
591 system of your machine, like `mips-dec-ultrix' or
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
592 `sparc-sun-sunos'. Since these files are specific to the version
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
593 of Emacs, operating system, and architecture in use, including
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
594 the configuration name in the path allows you to have several
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
595 versions of Emacs for any mix of machines and operating systems
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
596 installed at the same time; this is useful for sites at which
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
597 different kinds of machines share the file system Emacs is
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
598 installed on.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
599
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
600 `infodir' indicates where to put the info files distributed with
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
601 Emacs; it defaults to `/usr/local/info'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
602
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
603 `mandir' indicates where to put the man pages for Emacs and its
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
604 utilities (like `etags'); it defaults to
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
605 `/usr/local/man/man1'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
606
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
607 `manext' gives the extension the man pages should be installed with.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
608 It should contain a period, followed by the appropriate
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
609 digit. It defaults to `.1'. For example given the default
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
610 values for `mandir' and `manext', the Emacs man page would be
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
611 installed as `/usr/local/man/man1/emacs.1'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
612
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
613 `prefix' doesn't give a path for any specific part of Emacs; instead,
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
614 its value is used to determine the defaults for all the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
615 architecture-independent path variables - `datadir',
9499
151b595bc41a Formerly INSTALL.~33~
David J. MacKenzie <djm@gnu.org>
parents: 9498
diff changeset
616 `sharedstatedir', `infodir', and `mandir'. Its default value is
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
617 `/usr/local'; the other variables add on `lib' or `man' to it
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
618 by default.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
619
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
620 For example, suppose your site generally places GNU software
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
621 under `/usr/users/software/gnusoft' instead of `/usr/local'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
622 By including
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
623 `prefix=/usr/users/software/gnusoft'
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
624 in the arguments to `make', you can instruct the build process
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
625 to place all of the Emacs data files in the appropriate
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
626 directories under that path.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
627
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
628 `exec_prefix' serves the same purpose as `prefix', but instead
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
629 determines the default values for the architecture-dependent
9499
151b595bc41a Formerly INSTALL.~33~
David J. MacKenzie <djm@gnu.org>
parents: 9498
diff changeset
630 path variables - `bindir' and `libexecdir'.
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 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
633 GNU software; this variable is specific to Emacs.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
634
12620
7f74acc9dfeb Update disk requirements.
Karl Heuer <kwzh@gnu.org>
parents: 12368
diff changeset
635 `archlibdir' indicates where Emacs installs and expects the executable
7f74acc9dfeb Update disk requirements.
Karl Heuer <kwzh@gnu.org>
parents: 12368
diff changeset
636 files and other architecture-dependent data it uses while
7f74acc9dfeb Update disk requirements.
Karl Heuer <kwzh@gnu.org>
parents: 12368
diff changeset
637 running. Its default value, based on `libexecdir' (which
7f74acc9dfeb Update disk requirements.
Karl Heuer <kwzh@gnu.org>
parents: 12368
diff changeset
638 see), is `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME'
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
639 (where VERSION and CONFIGURATION-NAME are as described above).
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
640
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
641 Remember that you must specify any variable values you need each time
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
642 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
643 emacs, test it, and then run `make' again to install the files, you
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
644 must provide the same variable settings each time. To make the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
645 settings persist, you can edit them into the `Makefile' in the top
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
646 directory, but be aware that running the `configure' program erases
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
647 `Makefile' and rebuilds it from `Makefile.in'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
648
21343
a3059cd301f1 Remove some directories that don't really work now.
Richard M. Stallman <rms@gnu.org>
parents: 21089
diff changeset
649 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
650 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
651 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
652 before you run `make'.
a3059cd301f1 Remove some directories that don't really work now.
Richard M. Stallman <rms@gnu.org>
parents: 21089
diff changeset
653
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
654 The top-level Makefile stores the variable settings it used in the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
655 Makefiles for the subdirectories, so you don't have to specify them
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
656 when running make in the subdirectories.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
657
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
658
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
659 CONFIGURATION BY HAND
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
660
7864
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
661 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
662 following steps.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
663
13667
fbf777f663d3 Correct .in.in and .h.in in file names.
Richard M. Stallman <rms@gnu.org>
parents: 12620
diff changeset
664 1) Copy `./src/config.in' to `./src/config.h'.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
665
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
666 2) Consult `./etc/MACHINES' to see what configuration name you should
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
667 use for your system. Look at the code of the `configure' script to
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
668 see which operating system and architecture description files from
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
669 `src/s' and `src/m' should be used for that configuration name. Edit
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
670 `src/config.h', and change the two `#include' directives to include
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
671 the appropriate system and architecture description files.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
672
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
673 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
674 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
675 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
676 changing the s/*.h and m/*.h files. Occasionally you may need to
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
677 redefine parameters used in `./lib-src/movemail.c'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
678
7864
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
679 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
680 `Makefile.in' files. First copy `Makefile.in' to `Makefile.c',
14020
1ea8008d4bd8 Fix typo.
Karl Heuer <kwzh@gnu.org>
parents: 13926
diff changeset
681 then edit in appropriate substitutions for the @...@ constructs,
7864
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
682 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
683 that run cpp to construct `Makefile'.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
684
7864
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
685 4) Create `Makefile' files in various other directories
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
686 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
687 just a matter of substitution.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
688
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
689 The `configure' script is built from `configure.in' by the `autoconf'
36267
6abfaee147b1 Correct required autoconf version
Dave Love <fx@gnu.org>
parents: 36123
diff changeset
690 program. You need version 2.8 or newer of `autoconf' to rebuild
6abfaee147b1 Correct required autoconf version
Dave Love <fx@gnu.org>
parents: 36123
diff changeset
691 `configure'.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
692
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
693 BUILDING GNU EMACS BY HAND
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
694
9507
6773cf9c2e75 entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 9499
diff changeset
695 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
696 the following steps.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
697
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
698 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
699 `./src/paths.h' from the template file `./src/paths.in', changing
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
700 the paths to the values specified in `./Makefile'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
701
7864
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
702 2) Go to directory `./lib-src' and run `make'. This creates
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
703 executables named `ctags' and `etags' and `wakeup' and `make-docfile'
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
704 and `digest-doc' and `test-distrib'. And others.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
705
7864
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
706 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
707 the `./lisp' and `./lib-src' subdirectories using names `../lisp' and
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
708 `../lib-src'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
709
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
710 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
711 which has another name that contains a version number.
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
712 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
713
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
714 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
715 current Emacs version. This file contains documentation strings for
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
716 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
717 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
718 file for an Emacs version as long as you keep using that Emacs
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
719 version.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
720
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
721
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
722 INSTALLATION 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 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
725 directory of the Emacs distribution.
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) Copy `./lisp' and its subdirectories, `./etc', and the executables
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
728 in `./lib-src' to their final destinations, as selected in `./src/paths.h'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
729
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
730 Strictly speaking, not all of the executables in `./lib-src' need be copied.
7627
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
731 - The programs `cvtmail', `emacsserver', `fakemail', `hexl',
7864
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
732 `movemail', `profile', `rcs2log', `timer', `vcdiff', `wakeup',
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
733 and `yow' are used by Emacs; they do need to be copied.
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
734 - The programs `etags', `ctags', `emacsclient', `b2m', and `rcs-checkin'
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
735 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
736 - The programs `make-docfile' and `test-distrib' were
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
737 used in building Emacs, and are not needed any more.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
738 - The programs `digest-doc' and `sorted-doc' convert a `DOC' file into
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
739 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
740
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
741 2) Copy the files in `./info' to the place specified in
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
742 `./lisp/site-init.el' or `./lisp/paths.el'. Note that if the
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
743 destination directory already contains a file named `dir', you
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
744 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
745 distribution. Instead, you should make sure that the existing `dir'
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
746 file contains an appropriate menu entry for the Emacs info.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
747
23353
2a5d306408cb *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 23330
diff changeset
748 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
749 in users' search paths. `./src/emacs' has an alternate name
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
750 `./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
751 `/usr/local/bin/emacs' pointing to that alternate name, as an easy way
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
752 of installing different versions.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
753
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
754 You can delete `./src/temacs'.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
755
23353
2a5d306408cb *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 23330
diff changeset
756 4) Copy the programs `b2m', `emacsclient', `ctags', `etags', and
7864
e520e9f9a8d9 Formerly INSTALL.~31~
Richard M. Stallman <rms@gnu.org>
parents: 7627
diff changeset
757 `rcs-checkin' from `./lib-src' to `/usr/local/bin'. These programs are
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
758 intended for users to run.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
759
23353
2a5d306408cb *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 23330
diff changeset
760 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
761 appropriate man directories.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
762
23353
2a5d306408cb *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 23330
diff changeset
763 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
764 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
765 the source on line for debugging.
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
766
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
767
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
768 PROBLEMS
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
769
21089
0413a3ff3b8d PROBLEMS is now in the etc directory.
Richard M. Stallman <rms@gnu.org>
parents: 20213
diff changeset
770 See the file PROBLEMS in etc subdirectory for a list of various
3199
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
771 problems sometimes encountered, and what to do about them.
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
772
8788744c0c64 Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
773
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
774 Installation on MSDOG (a.k.a. MSDOS)
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
775
7627
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
776 To install on MSDOG, you need to have the GNU C compiler for MSDOG
15444
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
777 (also known as djgpp), GNU Make, rm, mv, and sed. See the remarks in
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
778 config.bat for more information about locations and versions. The
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
779 file etc/FAQ includes pointers to Internet sites where you can find
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
780 the necessary utilities; search for "MS-DOS". The configuration step
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
781 (see below) will test for these utilities and will refuse to continue
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
782 if any of them isn't found.
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
783
36123
53ca0e322e9e List additional utilities required on MS-DOS to run lisp/Makefile.
Eli Zaretskii <eliz@gnu.org>
parents: 36040
diff changeset
784 Recompiling Lisp files in the `lisp' subdirectory using the various
53ca0e322e9e List additional utilities required on MS-DOS to run lisp/Makefile.
Eli Zaretskii <eliz@gnu.org>
parents: 36040
diff changeset
785 targets in the lisp/Makefile file requires additional utilities:
53ca0e322e9e List additional utilities required on MS-DOS to run lisp/Makefile.
Eli Zaretskii <eliz@gnu.org>
parents: 36040
diff changeset
786 `find' and `xargs' (from Findutils), `touch' (from Fileutils) GNU
53ca0e322e9e List additional utilities required on MS-DOS to run lisp/Makefile.
Eli Zaretskii <eliz@gnu.org>
parents: 36040
diff changeset
787 `echo' and `test' (from Sh-utils), `tr, `sort', and `uniq' (from
53ca0e322e9e List additional utilities required on MS-DOS to run lisp/Makefile.
Eli Zaretskii <eliz@gnu.org>
parents: 36040
diff changeset
788 Textutils), and a port of Bash. However, you should not normally need
53ca0e322e9e List additional utilities required on MS-DOS to run lisp/Makefile.
Eli Zaretskii <eliz@gnu.org>
parents: 36040
diff changeset
789 to run lisp/Makefile, as all the Lisp files are distributed in
53ca0e322e9e List additional utilities required on MS-DOS to run lisp/Makefile.
Eli Zaretskii <eliz@gnu.org>
parents: 36040
diff changeset
790 byte-compiled form as well.
53ca0e322e9e List additional utilities required on MS-DOS to run lisp/Makefile.
Eli Zaretskii <eliz@gnu.org>
parents: 36040
diff changeset
791
15444
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
792 If you are building the MSDOG version of Emacs on an MSDOG-like system
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
793 which supports long file names (e.g. Windows 95), you need to make
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
794 sure that long file names are handled consistently both when you
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
795 unpack the distribution and compile it. If you intend to compile with
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
796 DJGPP v2.0 or later, and long file names support is enabled (LFN=y in
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
797 the environment), you need to unpack Emacs distribution in a way that
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
798 doesn't truncate the original long filenames to the DOS 8.3 namespace;
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
799 the easiest way to do this is to use djtar program which comes with
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
800 DJGPP, since it will note the LFN setting and behave accordingly.
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
801 DJGPP v1 doesn't support long filenames, so you must unpack Emacs with
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
802 a program that truncates the filenames to 8.3 naming as it extracts
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
803 files; again, using djtar after setting LFN=n is the recommended way.
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
804 You can build Emacs with LFN=n even if you use DJGPP v2, if some of
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
805 your tools don't support long file names: just ensure that LFN is set
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
806 to `n' during both unpacking and compiling.
15017
11c175c0b7de Describe djtar.
Richard M. Stallman <rms@gnu.org>
parents: 15016
diff changeset
807
15444
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
808 (By the time you read this, you have already unpacked the Emacs
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
809 distribution, but if the explanations above imply that you should have
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
810 done it differently, it's safer to delete the directory tree created
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
811 by the unpacking program and unpack Emacs again, than to risk running
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
812 into problems during the build process.)
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
813
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
814 It is important to understand that the runtime support of long file
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
815 names by the Emacs binary is NOT affected by the LFN setting during
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
816 compilation; Emacs compiled with DJGPP v2.0 or later will always
32557
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
817 support long file names on Windows 9X no matter what was the setting
15733
e3d77845180c Clarify info about long filenames on MSDOS-like systems.
Karl Heuer <kwzh@gnu.org>
parents: 15444
diff changeset
818 of LFN at compile time. However, if you compiled with LFN disabled
e3d77845180c Clarify info about long filenames on MSDOS-like systems.
Karl Heuer <kwzh@gnu.org>
parents: 15444
diff changeset
819 and want to enable LFN support after Emacs was already built, you need
e3d77845180c Clarify info about long filenames on MSDOS-like systems.
Karl Heuer <kwzh@gnu.org>
parents: 15444
diff changeset
820 to make sure that the support files in the lisp, etc and info
e3d77845180c Clarify info about long filenames on MSDOS-like systems.
Karl Heuer <kwzh@gnu.org>
parents: 15444
diff changeset
821 directories are called by their original long names as found in the
e3d77845180c Clarify info about long filenames on MSDOS-like systems.
Karl Heuer <kwzh@gnu.org>
parents: 15444
diff changeset
822 distribution. You can do this either by renaming the files manually,
e3d77845180c Clarify info about long filenames on MSDOS-like systems.
Karl Heuer <kwzh@gnu.org>
parents: 15444
diff changeset
823 or by extracting them from the original distribution archive with
e3d77845180c Clarify info about long filenames on MSDOS-like systems.
Karl Heuer <kwzh@gnu.org>
parents: 15444
diff changeset
824 djtar after you set LFN=y in the environment.
15017
11c175c0b7de Describe djtar.
Richard M. Stallman <rms@gnu.org>
parents: 15016
diff changeset
825
15444
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
826 To unpack Emacs with djtar, type this command:
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
827
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
828 djtar -x emacs.tgz
12339
3398b88cbd25 Update MSDOS needs list.
Richard M. Stallman <rms@gnu.org>
parents: 12042
diff changeset
829
15444
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
830 (This assumes that the Emacs distribution is called `emacs.tgz' on
19635
c08a8e2d0f27 MSDOS-related changes.
Richard M. Stallman <rms@gnu.org>
parents: 19352
diff changeset
831 your system.)
12343
91d4c394cb61 Fix previous change.
Richard M. Stallman <rms@gnu.org>
parents: 12341
diff changeset
832
24070
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
833 If you need to type international characters, you will need to unpack
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
834 the Leim distribution (see the description near the beginning of this
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
835 file). You unpack it from the same directory where you unpacked
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
836 Emacs. To unpack Leim with djtar, assuming the Leim distribution is
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
837 called `leim.tgz', type this command:
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
838
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
839 djtar -x leim.tgz
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
840
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
841 If you want to print international characters, install the intlfonts
24452
3f25405e6e70 Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents: 24070
diff changeset
842 distribution. For this, create a directory called `fonts' under the
24070
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
843 Emacs top-level directory (usually called `emacs-XX.YY') created by
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
844 unpacking emacs.tgz, chdir into the directory emacs-XX.YY/fonts, and
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
845 type this:
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
846
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
847 djtar -x intlfonts.tgz
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
848
15444
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
849 When unpacking is done, a directory called `emacs-XX.YY' will be
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
850 created, where XX.YY is the Emacs version. To build and install
66a9ef0892a2 Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents: 15209
diff changeset
851 Emacs, chdir to that directory and type these commands:
12339
3398b88cbd25 Update MSDOS needs list.
Richard M. Stallman <rms@gnu.org>
parents: 12042
diff changeset
852
3398b88cbd25 Update MSDOS needs list.
Richard M. Stallman <rms@gnu.org>
parents: 12042
diff changeset
853 config msdos
3398b88cbd25 Update MSDOS needs list.
Richard M. Stallman <rms@gnu.org>
parents: 12042
diff changeset
854 make install
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
855
33812
c41a9a242fed Describe a possible problem with djecho.exe in old
Eli Zaretskii <eliz@gnu.org>
parents: 33678
diff changeset
856 Running "config msdos" checks for several programs that are required
c41a9a242fed Describe a possible problem with djecho.exe in old
Eli Zaretskii <eliz@gnu.org>
parents: 33678
diff changeset
857 to configure and build Emacs; if one of those programs is not found,
c41a9a242fed Describe a possible problem with djecho.exe in old
Eli Zaretskii <eliz@gnu.org>
parents: 33678
diff changeset
858 CONFIG.BAT stops and prints an error message. If you have DJGPP
c41a9a242fed Describe a possible problem with djecho.exe in old
Eli Zaretskii <eliz@gnu.org>
parents: 33678
diff changeset
859 version 2.0 or 2.01, it will complain about a program called
c41a9a242fed Describe a possible problem with djecho.exe in old
Eli Zaretskii <eliz@gnu.org>
parents: 33678
diff changeset
860 DJECHO.EXE. These old versions of DJGPP shipped that program under
c41a9a242fed Describe a possible problem with djecho.exe in old
Eli Zaretskii <eliz@gnu.org>
parents: 33678
diff changeset
861 the name ECHO.EXE, so you can simply copy ECHO.EXE to DJECHO.EXE and
c41a9a242fed Describe a possible problem with djecho.exe in old
Eli Zaretskii <eliz@gnu.org>
parents: 33678
diff changeset
862 rerun CONFIG.BAT. If you have neither ECHO.EXE nor DJECHO.EXE, you
c41a9a242fed Describe a possible problem with djecho.exe in old
Eli Zaretskii <eliz@gnu.org>
parents: 33678
diff changeset
863 should be able to find them in your djdevNNN.zip archive (where NNN is
c41a9a242fed Describe a possible problem with djecho.exe in old
Eli Zaretskii <eliz@gnu.org>
parents: 33678
diff changeset
864 the DJGPP version number).
c41a9a242fed Describe a possible problem with djecho.exe in old
Eli Zaretskii <eliz@gnu.org>
parents: 33678
diff changeset
865
37479
a240b159c8df Mention problems with Windows NT's `redir' program.
Eli Zaretskii <eliz@gnu.org>
parents: 36753
diff changeset
866 On Windows NT or Windows 2000, running "config msdos" might print an
a240b159c8df Mention problems with Windows NT's `redir' program.
Eli Zaretskii <eliz@gnu.org>
parents: 36753
diff changeset
867 error message like "VDM has been already loaded". This is because
a240b159c8df Mention problems with Windows NT's `redir' program.
Eli Zaretskii <eliz@gnu.org>
parents: 36753
diff changeset
868 those systems have a program called `redir.exe' which is incompatible
a240b159c8df Mention problems with Windows NT's `redir' program.
Eli Zaretskii <eliz@gnu.org>
parents: 36753
diff changeset
869 with a program by the same name supplied with DJGPP, which is used by
a240b159c8df Mention problems with Windows NT's `redir' program.
Eli Zaretskii <eliz@gnu.org>
parents: 36753
diff changeset
870 config.bat. To resolve this, move the DJGPP's `bin' subdirectory to
a240b159c8df Mention problems with Windows NT's `redir' program.
Eli Zaretskii <eliz@gnu.org>
parents: 36753
diff changeset
871 the front of your PATH environment variable.
a240b159c8df Mention problems with Windows NT's `redir' program.
Eli Zaretskii <eliz@gnu.org>
parents: 36753
diff changeset
872
24452
3f25405e6e70 Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents: 24070
diff changeset
873 To install the international fonts, chdir to the intlfonts-X.Y
3f25405e6e70 Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents: 24070
diff changeset
874 directory created when you unpacked the intlfonts distribution (X.Y is
3f25405e6e70 Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents: 24070
diff changeset
875 the version number of the fonts' distribution), and type the following
3f25405e6e70 Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents: 24070
diff changeset
876 command:
3f25405e6e70 Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents: 24070
diff changeset
877
3f25405e6e70 Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents: 24070
diff changeset
878 make bdf INSTALLDIR=..
3f25405e6e70 Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents: 24070
diff changeset
879
3f25405e6e70 Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents: 24070
diff changeset
880 After Make finishes, you may remove the directory intlfonts-X.Y; the
3f25405e6e70 Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents: 24070
diff changeset
881 fonts are installed into the fonts/bdf subdirectory of the top-level
3f25405e6e70 Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents: 24070
diff changeset
882 Emacs directory, and that is where Emacs will look for them by
3f25405e6e70 Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents: 24070
diff changeset
883 default.
3f25405e6e70 Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents: 24070
diff changeset
884
15039
43c846d45f79 Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents: 15017
diff changeset
885 Building Emacs creates executable files in the src and lib-src
43c846d45f79 Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents: 15017
diff changeset
886 directories. Installing Emacs on MSDOS moves these executables to a
43c846d45f79 Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents: 15017
diff changeset
887 sibling directory called bin. For example, if you build in directory
43c846d45f79 Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents: 15017
diff changeset
888 /emacs, installing moves the executables from /emacs/src and
43c846d45f79 Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents: 15017
diff changeset
889 /emacs/lib-src to the directory /emacs/bin, so you can then delete the
43c846d45f79 Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents: 15017
diff changeset
890 subdirectories /emacs/src and /emacs/lib-src if you wish. The only
24070
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
891 subdirectories you need to keep are bin, lisp, etc and info. (If you
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
892 installed Leim, keep the leim subdirectory, and if you installed
35062
3168ff2c349b Tweaks to configure instructions and saving space.
Dave Love <fx@gnu.org>
parents: 35034
diff changeset
893 intlfonts, keep the fonts directory and all its subdirectories as well.)
24070
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
894 The bin subdirectory should be added to your PATH. The msdos
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
895 subdirectory includes a PIF and an icon file for Emacs which you might
526d645420b5 Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents: 23353
diff changeset
896 find useful if you run Emacs under MS Windows.
12349
f5ba89f88cfd Talk about MSDOS type conflict workaround.
Richard M. Stallman <rms@gnu.org>
parents: 12343
diff changeset
897
15039
43c846d45f79 Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents: 15017
diff changeset
898 Emacs on MSDOS finds the lisp, etc and info directories by looking in
43c846d45f79 Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents: 15017
diff changeset
899 ../lisp, ../etc and ../info, starting from the directory where the
43c846d45f79 Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents: 15017
diff changeset
900 Emacs executable was run from. You can override this by setting the
19635
c08a8e2d0f27 MSDOS-related changes.
Richard M. Stallman <rms@gnu.org>
parents: 19352
diff changeset
901 environment variables EMACSDATA (for the location of `etc' directory),
c08a8e2d0f27 MSDOS-related changes.
Richard M. Stallman <rms@gnu.org>
parents: 19352
diff changeset
902 EMACSLOADPATH (for the location of `lisp' directory) and INFOPATH (for
c08a8e2d0f27 MSDOS-related changes.
Richard M. Stallman <rms@gnu.org>
parents: 19352
diff changeset
903 the location of the `info' directory).
6062
e9768f0d0653 Formerly INSTALL.~20~
Richard M. Stallman <rms@gnu.org>
parents: 3199
diff changeset
904
7627
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
905 MSDOG is a not a multitasking operating system, so Emacs features such
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
906 as asynchronous subprocesses that depend on multitasking will not
99cf43c08895 Formerly INSTALL.~28~
Richard M. Stallman <rms@gnu.org>
parents: 6062
diff changeset
907 work. Synchronous subprocesses do work.
15825
615a180ced87 Describe djgpp library replacement files.
Richard M. Stallman <rms@gnu.org>
parents: 15733
diff changeset
908
16861
310fd977a344 Update info about DJGPP.
Richard M. Stallman <rms@gnu.org>
parents: 16309
diff changeset
909 Version 2.0 of djgpp has two bugs that affect Emacs. We've included
310fd977a344 Update info about DJGPP.
Richard M. Stallman <rms@gnu.org>
parents: 16309
diff changeset
910 corrected versions of two files from djgpp in the msdos subdirectory:
310fd977a344 Update info about DJGPP.
Richard M. Stallman <rms@gnu.org>
parents: 16309
diff changeset
911 is_exec.c and sigaction.c. To work around the bugs, compile these
32557
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
912 files and link them into temacs. Djgpp versions 2.01 and later have
cd84bd4a3411 Describe the new --with-FOO options for building with image support.
Eli Zaretskii <eliz@gnu.org>
parents: 26905
diff changeset
913 these bugs fixed, so upgrade if you can before building Emacs.
34939
44564f6157cc Move the copying conditions to the end of the file.
Eli Zaretskii <eliz@gnu.org>
parents: 34879
diff changeset
914
34994
fb1c795f1a5e Minor style and punctuation changes from Kim Storm.
Eli Zaretskii <eliz@gnu.org>
parents: 34939
diff changeset
915 COPYING PERMISSIONS
fb1c795f1a5e Minor style and punctuation changes from Kim Storm.
Eli Zaretskii <eliz@gnu.org>
parents: 34939
diff changeset
916
34939
44564f6157cc Move the copying conditions to the end of the file.
Eli Zaretskii <eliz@gnu.org>
parents: 34879
diff changeset
917 Permission is granted to anyone to make or distribute verbatim copies
44564f6157cc Move the copying conditions to the end of the file.
Eli Zaretskii <eliz@gnu.org>
parents: 34879
diff changeset
918 of this document as received, in any medium, provided that the
44564f6157cc Move the copying conditions to the end of the file.
Eli Zaretskii <eliz@gnu.org>
parents: 34879
diff changeset
919 copyright notice and permission notice are preserved,
44564f6157cc Move the copying conditions to the end of the file.
Eli Zaretskii <eliz@gnu.org>
parents: 34879
diff changeset
920 and that the distributor grants the recipient permission
44564f6157cc Move the copying conditions to the end of the file.
Eli Zaretskii <eliz@gnu.org>
parents: 34879
diff changeset
921 for further redistribution as permitted by this notice.
44564f6157cc Move the copying conditions to the end of the file.
Eli Zaretskii <eliz@gnu.org>
parents: 34879
diff changeset
922
44564f6157cc Move the copying conditions to the end of the file.
Eli Zaretskii <eliz@gnu.org>
parents: 34879
diff changeset
923 Permission is granted to distribute modified versions
44564f6157cc Move the copying conditions to the end of the file.
Eli Zaretskii <eliz@gnu.org>
parents: 34879
diff changeset
924 of this document, or of portions of it,
44564f6157cc Move the copying conditions to the end of the file.
Eli Zaretskii <eliz@gnu.org>
parents: 34879
diff changeset
925 under the above conditions, provided also that they
44564f6157cc Move the copying conditions to the end of the file.
Eli Zaretskii <eliz@gnu.org>
parents: 34879
diff changeset
926 carry prominent notices stating who last changed them,
44564f6157cc Move the copying conditions to the end of the file.
Eli Zaretskii <eliz@gnu.org>
parents: 34879
diff changeset
927 and that any new or changed statements about the activities
44564f6157cc Move the copying conditions to the end of the file.
Eli Zaretskii <eliz@gnu.org>
parents: 34879
diff changeset
928 of the Free Software Foundation are approved by the Foundation.