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