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