Mercurial > emacs
annotate INSTALL @ 26059:2a7f35e0072b
(Fminibuffer_complete_and_exit): Supply value for new
ESCAPE_FROM_EDGE parameter to Ffield_beginning.
(Fminibuffer_complete_word): Use
Ffield_beginning to find the prompt end.
(Fminibuffer_complete_and_exit): Test for an empty
input string by seeing where the field begins, instead of
looking at text-properties.
(read_minibuf): Don't save minibuffer prompt length on
minibuf_save_list.
Don't initialize minibuffer prompt length.
Wrap prompt text-properties around the entire prompt.
Add 'prompt text-property to prompt.
Get final value with Ffield_string instead of make_buffer_string.
(read_minibuf_unwind): Don't restore minibuffer prompt length from
minibuf_save_list.
(do_completion): Get minibuffer input with Ffield_string
instead of Fbuffer_string.
Erase minibuffer input with Ferase_field instead of erase_buffer.
(Fminibuffer_complete_and_exit): Likewise.
Test whether buffer is empty by looking for the 'prompt text
property at the end.
Set prompt length by looking for the end of the prompt text property,
and save prompt length for later use (since there is no longer a
buffer variable to get it from).
(Fminibuffer_prompt_width, Fminibuffer_prompt_end): Functions removed.
(syms_of_minibuf): Remove initializations of
Sminibuffer_prompt_width and Sminibuffer_prompt_end.
author | Gerd Moellmann <gerd@gnu.org> |
---|---|
date | Sun, 17 Oct 1999 12:55:49 +0000 |
parents | 7f38d541d411 |
children | b47b74998eef |
rev | line source |
---|---|
3199 | 1 GNU Emacs Installation Guide |
19899
a165ef580ea2
Say a little more about intlfonts. Update copyright year.
Richard M. Stallman <rms@gnu.org>
parents:
19635
diff
changeset
|
2 Copyright (c) 1992, 1994, 1996, 1997 Free software Foundation, Inc. |
3199 | 3 |
4 Permission is granted to anyone to make or distribute verbatim copies | |
5 of this document as received, in any medium, provided that the | |
6 copyright notice and permission notice are preserved, | |
7 and that the distributor grants the recipient permission | |
8 for further redistribution as permitted by this notice. | |
9 | |
10 Permission is granted to distribute modified versions | |
11 of this document, or of portions of it, | |
12 under the above conditions, provided also that they | |
13 carry prominent notices stating who last changed them, | |
14 and that any new or changed statements about the activities | |
15 of the Free Software Foundation are approved by the Foundation. | |
16 | |
17 | |
19014
63c862461563
Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents:
16861
diff
changeset
|
18 ADDITIONAL DISTRIBUTION FILES |
63c862461563
Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents:
16861
diff
changeset
|
19 |
63c862461563
Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents:
16861
diff
changeset
|
20 * leim-M.N.tar.gz |
63c862461563
Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents:
16861
diff
changeset
|
21 |
63c862461563
Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents:
16861
diff
changeset
|
22 The Emacs Lisp code for input methods for various international |
24799 | 23 character scripts is distributed in a separate tar file because it |
24 amounts to a significant fraction of the size of the distribution. | |
25 This tar file is called leim-M.N.tar.gz, with the same version number | |
26 as Emacs, and it unpacks into the directory emacs-M.N/leim. | |
19014
63c862461563
Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents:
16861
diff
changeset
|
27 |
24799 | 28 You should unpack leim-M.N.tar.gz into the same directory where you |
29 have previously unpacked the main Emacs distribution. It fills in the | |
30 contents of one subdirectory, which is present in the main Emacs | |
31 distribution only in dummy form. | |
32 | |
33 Once you have unpacked the Leim tar file into the Emacs source tree, | |
34 building and installing Emacs automatically installs the input method | |
35 support as well. If you have built Emacs without unpacking Leim | |
36 first, just unpack Leim, build Emacs again, and install it again. | |
19014
63c862461563
Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents:
16861
diff
changeset
|
37 |
63c862461563
Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents:
16861
diff
changeset
|
38 * intlfonts-VERSION.tar.gz |
63c862461563
Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents:
16861
diff
changeset
|
39 |
63c862461563
Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents:
16861
diff
changeset
|
40 The intlfonts distribution contains X11 fonts that Emacs needs in |
63c862461563
Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents:
16861
diff
changeset
|
41 order to display international characters. If you see a non-ASCII |
63c862461563
Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents:
16861
diff
changeset
|
42 character appear as a hollow box, that means you don't have a font for |
19899
a165ef580ea2
Say a little more about intlfonts. Update copyright year.
Richard M. Stallman <rms@gnu.org>
parents:
19635
diff
changeset
|
43 it. You might find a font in the intlfonts distribution. If some |
a165ef580ea2
Say a little more about intlfonts. Update copyright year.
Richard M. Stallman <rms@gnu.org>
parents:
19635
diff
changeset
|
44 characters don't look right, or appear improperly aligned, a font |
20213 | 45 from the 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
|
46 |
24070
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
47 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
|
48 package for printing international characters. The file |
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
49 lisp/ps-mule.el defines the .bdf font files required for printing |
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
50 each character set. |
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
51 |
19899
a165ef580ea2
Say a little more about intlfonts. Update copyright year.
Richard M. Stallman <rms@gnu.org>
parents:
19635
diff
changeset
|
52 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
|
53 in the intlfonts/README file. |
19014
63c862461563
Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents:
16861
diff
changeset
|
54 |
63c862461563
Describe the separate distributions leim and intlfonts.
Richard M. Stallman <rms@gnu.org>
parents:
16861
diff
changeset
|
55 |
3199 | 56 BUILDING AND INSTALLATION: |
15209 | 57 |
58 (This is for a Unix or Unix-like system. For MSDOS, see below; search | |
59 for MSDOG. For Windows NT or Windows 95, see the file nt/INSTALL.) | |
3199 | 60 |
61 1) Make sure your system has enough swapping space allocated to handle | |
62 a program whose pure code is 900k bytes and whose data area is at | |
63 least 400k and can reach 8Mb or more. If the swapping space is | |
64 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
|
65 loadup dump', found in `./src/Makefile.in', or possibly when |
6062 | 66 running the final dumped Emacs. |
3199 | 67 |
12620 | 68 Building Emacs requires about 70 Mb of disk space (including the Emacs |
69 sources). Once installed, Emacs occupies about 35 Mb in the file | |
6062 | 70 system where it is installed; this includes the executable files, Lisp |
71 libraries, miscellaneous data files, and on-line documentation. If | |
72 the building and installation take place in different directories, | |
12620 | 73 then the installation procedure momentarily requires 70+35 Mb. |
3199 | 74 |
75 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
|
76 give to the `configure' program. That file offers hints for |
3199 | 77 getting around some possible installation problems. |
78 | |
16309
fea88c3fb20c
Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents:
15936
diff
changeset
|
79 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
|
80 or in a separate directory. |
fea88c3fb20c
Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents:
15936
diff
changeset
|
81 |
fea88c3fb20c
Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents:
15936
diff
changeset
|
82 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
|
83 directory and run the program `configure' as follows: |
3199 | 84 |
22255
7851f4551208
Clarify about omitting CONFIGURATION-NAME with configure.
Richard M. Stallman <rms@gnu.org>
parents:
21692
diff
changeset
|
85 ./configure [CONFIGURATION-NAME] [--OPTION[=VALUE]] ... |
3199 | 86 |
87 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
|
88 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
|
89 |
7851f4551208
Clarify about omitting CONFIGURATION-NAME with configure.
Richard M. Stallman <rms@gnu.org>
parents:
21692
diff
changeset
|
90 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
|
91 `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
|
92 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
|
93 try again specifying the proper CONFIGURATION-NAME explicitly. |
3199 | 94 |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
95 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
|
96 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
|
97 system has X, and arrange to use it if present. |
3199 | 98 |
99 The `--x-includes=DIR' and `--x-libraries=DIR' options tell the build | |
100 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
|
101 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
|
102 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
|
103 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
|
104 accept a list of directories, separated with colons. |
6062 | 105 |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
106 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
|
107 configure Emacs; use the option `--with-x-toolkit=TOOLKIT', where |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
108 TOOLKIT is `athena' or `motif' (`yes' and `lucid' are synonyms for |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
109 `athena'). On some systems, it does not work to use a toolkit with |
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
110 shared libraries. |
3199 | 111 |
112 The `--with-gcc' option specifies that the build process should | |
113 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
|
114 `--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
|
115 for GCC in your path, and use it if present. |
3199 | 116 |
15936
6a126c5c87bb
Describe --with-pop and related options.
Richard M. Stallman <rms@gnu.org>
parents:
15828
diff
changeset
|
117 If you want the Emacs mail reader RMAIL to read mail from a POP |
6a126c5c87bb
Describe --with-pop and related options.
Richard M. Stallman <rms@gnu.org>
parents:
15828
diff
changeset
|
118 server, you must specify `--with-pop'. This provides support for the |
6a126c5c87bb
Describe --with-pop and related options.
Richard M. Stallman <rms@gnu.org>
parents:
15828
diff
changeset
|
119 POP3 protocol; older versions are not supported. For |
6a126c5c87bb
Describe --with-pop and related options.
Richard M. Stallman <rms@gnu.org>
parents:
15828
diff
changeset
|
120 Kerberos-authenticated POP add `--with-kerberos', for Hesiod support |
6a126c5c87bb
Describe --with-pop and related options.
Richard M. Stallman <rms@gnu.org>
parents:
15828
diff
changeset
|
121 add `--with-hesiod'. These options enable Emacs to use POP; whether |
6a126c5c87bb
Describe --with-pop and related options.
Richard M. Stallman <rms@gnu.org>
parents:
15828
diff
changeset
|
122 Emacs uses POP is controlled by individual users--see the Rmail |
6a126c5c87bb
Describe --with-pop and related options.
Richard M. Stallman <rms@gnu.org>
parents:
15828
diff
changeset
|
123 chapter of the Emacs manual. |
6a126c5c87bb
Describe --with-pop and related options.
Richard M. Stallman <rms@gnu.org>
parents:
15828
diff
changeset
|
124 |
3199 | 125 The `--prefix=PREFIXDIR' option specifies where the installation process |
126 should put emacs and its data files. This defaults to `/usr/local'. | |
127 - Emacs (and the other utilities users run) go in PREFIXDIR/bin | |
128 (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
|
129 - 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
|
130 (where VERSION is the version number of Emacs, like `19.27'). |
3199 | 131 - 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
|
132 PREFIXDIR/libexec/emacs/VERSION/CONFIGURATION |
3199 | 133 (where CONFIGURATION is the configuration name, like mips-dec-ultrix4.2), |
134 unless the `--exec-prefix' option says otherwise. | |
135 | |
136 The `--exec-prefix=EXECDIR' option allows you to specify a separate | |
137 portion of the directory tree for installing architecture-specific | |
138 files, like executables and utility programs. If specified, | |
139 - Emacs (and the other utilities users run) go in EXECDIR/bin, and | |
140 - 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
|
141 EXECDIR/libexec/emacs/VERSION/CONFIGURATION. |
3199 | 142 EXECDIR/bin should be a directory that is normally in users' PATHs. |
143 | |
144 For example, the command | |
145 | |
146 ./configure mips-dec-ultrix --with-x11 | |
147 | |
148 configures Emacs to build for a DECstation running Ultrix, with | |
149 support for the X11 window system. | |
150 | |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
151 `configure' doesn't do any compilation or installation |
3199 | 152 itself. It just creates the files that influence those things: |
9499 | 153 `./Makefile', `lib-src/Makefile', `oldXMenu/Makefile', |
154 `lwlib/Makefile', `src/Makefile', and `./src/config.h'. For details | |
155 on exactly what it does, see the section called `CONFIGURATION BY | |
156 HAND', below. | |
3199 | 157 |
158 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
|
159 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
|
160 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
|
161 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
|
162 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
|
163 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
|
164 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
|
165 `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
|
166 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
|
167 disable caching, for debugging `configure'. |
3199 | 168 |
169 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
|
170 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
|
171 "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
|
172 yourself. |
fea88c3fb20c
Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents:
15936
diff
changeset
|
173 |
fea88c3fb20c
Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents:
15936
diff
changeset
|
174 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
|
175 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
|
176 |
fea88c3fb20c
Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents:
15936
diff
changeset
|
177 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
|
178 |
fea88c3fb20c
Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents:
15936
diff
changeset
|
179 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
|
180 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
|
181 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
|
182 |
fea88c3fb20c
Explain better about building in separate directory.
Richard M. Stallman <rms@gnu.org>
parents:
15936
diff
changeset
|
183 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
|
184 that supports the `VPATH' variable, such as GNU `make'. |
3199 | 185 |
21692 | 186 3c) Some people try to build in a separate directory by filling |
187 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
|
188 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
|
189 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
|
190 |
2a33987c0f02
Explain trouble with link farms in `make install'.
Richard M. Stallman <rms@gnu.org>
parents:
21343
diff
changeset
|
191 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
|
192 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
|
193 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
|
194 |
3199 | 195 4) Look at `./lisp/paths.el'; if some of those values are not right |
11905 | 196 for your system, set up the file `./lisp/site-init.el' with Emacs |
197 Lisp code to override them; it is not a good idea to edit paths.el | |
3199 | 198 itself. YOU MUST USE THE LISP FUNCTION `setq' TO ASSIGN VALUES, |
199 rather than `defvar', as used by `./lisp/paths.el'. For example, | |
200 | |
201 (setq news-inews-program "/usr/bin/inews") | |
202 | |
203 is how you would override the default value of the variable | |
204 news-inews-program (which is "/usr/local/inews"). | |
205 | |
11119
c303d2623f63
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10672
diff
changeset
|
206 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
|
207 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
|
208 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
|
209 doing, you'll make a mistake. |
c303d2623f63
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
10672
diff
changeset
|
210 |
6062 | 211 5) Put into `./lisp/site-init.el' or `./lisp/site-load.el' any Emacs |
212 Lisp code you want Emacs to load before it is dumped out. Use | |
213 site-load.el for additional libraries if you arrange for their | |
214 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
|
215 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
|
216 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
|
217 was build with a non-nil value of `byte-compile-dynamic'. |
3199 | 218 |
11732
072d319a485f
Clarify effect of setting load-path before dumping.
Richard M. Stallman <rms@gnu.org>
parents:
11729
diff
changeset
|
219 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
|
220 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
|
221 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
|
222 |
3199 | 223 Note that, on some systems, the code you place in site-init.el must |
224 not use expand-file-name or any other function which may look | |
225 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
|
226 See `./etc/PROBLEMS' for more details on which systems this affects. |
3199 | 227 |
7627 | 228 The `site-*.el' files are nonexistent in the distribution. You do not |
229 need to create them if you have nothing to put in them. | |
3199 | 230 |
231 6) Refer to the file `./etc/TERMS' for information on fields you may | |
232 wish to add to various termcap entries. The files `./etc/termcap.ucb' | |
233 and `./etc/termcap.dat' may already contain appropriately-modified | |
234 entries. | |
235 | |
236 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
|
237 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
|
238 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
|
239 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
|
240 directories ../lisp, ../lib-src, ../info. |
3199 | 241 |
11733
ae51069237f2
Clarification about running executable in place.
Richard M. Stallman <rms@gnu.org>
parents:
11732
diff
changeset
|
242 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
|
243 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
|
244 are installed in the following directories: |
3199 | 245 |
246 `/usr/local/bin' holds the executable programs users normally run - | |
7864 | 247 `emacs', `etags', `ctags', `b2m', `emacsclient', |
248 and `rcs-checkin'. | |
3199 | 249 |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
250 `/usr/local/share/emacs/VERSION/lisp' holds the Emacs Lisp library; |
3199 | 251 `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
|
252 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
|
253 Lisp library changes from one version of Emacs to |
3199 | 254 another, including the version number in the path |
255 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
|
256 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
|
257 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
|
258 |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
259 `/usr/local/share/emacs/VERSION/site-lisp' holds the local Emacs Lisp |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
260 files installed for Emacs version VERSION only. |
3199 | 261 |
14147
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
262 `/usr/local/share/emacs/site-lisp' holds the local Emacs Lisp |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
263 files installed for all Emacs versions. |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
264 |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
265 When Emacs is installed, it searches for its Lisp files |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
266 in `/usr/local/share/emacs/VERSION/site-lisp', then in |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
267 `/usr/local/share/emacs/site-lisp', and finally in |
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
268 `/usr/local/share/emacs/VERSION/lisp'. |
3199 | 269 |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
270 `/usr/local/share/emacs/VERSION/etc' holds the Emacs tutorial, the DOC |
3199 | 271 file, the `yow' database, and other |
272 architecture-independent files Emacs might need while | |
273 running. VERSION is as specified for `.../lisp'. | |
274 | |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
275 `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' contains executable |
3199 | 276 programs used by Emacs that users are not expected to |
277 run themselves. | |
278 `VERSION' is the number of the Emacs version you are | |
279 installing, and `CONFIGURATION-NAME' is the argument | |
280 you gave to the `configure' program to identify the | |
281 architecture and operating system of your machine, | |
282 like `mips-dec-ultrix' or `sparc-sun-sunos'. Since | |
283 these files are specific to the version of Emacs, | |
284 operating system, and architecture in use, including | |
285 the configuration name in the path allows you to have | |
286 several versions of Emacs for any mix of machines and | |
287 operating systems installed at the same time; this is | |
288 useful for sites at which different kinds of machines | |
289 share the file system Emacs is installed on. | |
290 | |
291 `/usr/local/info' holds the on-line documentation for Emacs, known as | |
292 "info files". Many other GNU programs are documented | |
293 using info files as well, so this directory stands | |
294 apart from the other, Emacs-specific directories. | |
295 | |
296 `/usr/local/man/man1' holds the man pages for the programs installed | |
297 in `/usr/local/bin'. | |
298 | |
299 If these directories are not what you want, you can specify where to | |
300 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
|
301 for its Lisp files by giving values for `make' variables as part of |
3199 | 302 the command. See the section below called `MAKE VARIABLES' for more |
303 information on this. | |
304 | |
305 8) Check the file `dir' in your site's info directory (usually | |
306 /usr/local/info) to make sure that it has a menu entry for the Emacs | |
307 info files. | |
308 | |
6062 | 309 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
|
310 then you might need to make the movemail program setuid or setgid |
6062 | 311 to enable it to write the lock files. We believe this is safe. |
312 | |
12620 | 313 10) You are done! You can remove executables and object files from |
314 the build directory by typing `make clean'. To also remove the files | |
315 that `configure' created (so you can compile Emacs for a different | |
316 configuration), type `make distclean'. | |
317 | |
3199 | 318 |
319 | |
320 MAKE VARIABLES | |
321 | |
322 You can change where the build process installs Emacs and its data | |
323 files by specifying values for `make' variables as part of the `make' | |
324 command line. For example, if you type | |
325 | |
326 make install bindir=/usr/local/gnubin | |
327 | |
328 the `bindir=/usr/local/gnubin' argument indicates that the Emacs | |
329 executable files should go in `/usr/local/gnubin', not | |
330 `/usr/local/bin'. | |
331 | |
332 Here is a complete list of the variables you may want to set. | |
333 | |
334 `bindir' indicates where to put executable programs that users can | |
335 run. This defaults to /usr/local/bin. | |
336 | |
337 `datadir' indicates where to put the architecture-independent | |
338 read-only data files that Emacs refers to while it runs; it | |
9499 | 339 defaults to /usr/local/share. We create the following |
3199 | 340 subdirectories under `datadir': |
14147
4d7b8a3fe240
Describe version-specific site-lisp dirs.
Richard M. Stallman <rms@gnu.org>
parents:
14020
diff
changeset
|
341 - `emacs/VERSION/lisp', containing the Emacs Lisp library, and |
3199 | 342 - `emacs/VERSION/etc', containing the Emacs tutorial, the DOC |
343 file, and the `yow' database. | |
344 `VERSION' is the number of the Emacs version you are installing, | |
345 like `18.59' or `19.0'. Since these files vary from one version | |
346 of Emacs to another, including the version number in the path | |
347 allows you to have several versions of Emacs installed at the | |
348 same time; this means that you don't have to make Emacs | |
349 unavailable while installing a new version. | |
350 | |
9499 | 351 `libexecdir' indicates where to put architecture-specific data files that |
352 Emacs refers to as it runs; it defaults to `/usr/local/libexec'. | |
353 We create the following subdirectories under `libexecdir': | |
3199 | 354 - `emacs/VERSION/CONFIGURATION-NAME', containing executable |
355 programs used by Emacs that users are not expected to run | |
356 themselves. | |
357 `VERSION' is the number of the Emacs version you are installing, | |
358 and `CONFIGURATION-NAME' is the argument you gave to the | |
359 `configure' program to identify the architecture and operating | |
360 system of your machine, like `mips-dec-ultrix' or | |
361 `sparc-sun-sunos'. Since these files are specific to the version | |
362 of Emacs, operating system, and architecture in use, including | |
363 the configuration name in the path allows you to have several | |
364 versions of Emacs for any mix of machines and operating systems | |
365 installed at the same time; this is useful for sites at which | |
366 different kinds of machines share the file system Emacs is | |
367 installed on. | |
368 | |
369 `infodir' indicates where to put the info files distributed with | |
370 Emacs; it defaults to `/usr/local/info'. | |
371 | |
372 `mandir' indicates where to put the man pages for Emacs and its | |
373 utilities (like `etags'); it defaults to | |
374 `/usr/local/man/man1'. | |
375 | |
376 `manext' gives the extension the man pages should be installed with. | |
377 It should contain a period, followed by the appropriate | |
378 digit. It defaults to `.1'. For example given the default | |
379 values for `mandir' and `manext', the Emacs man page would be | |
380 installed as `/usr/local/man/man1/emacs.1'. | |
381 | |
382 `prefix' doesn't give a path for any specific part of Emacs; instead, | |
383 its value is used to determine the defaults for all the | |
384 architecture-independent path variables - `datadir', | |
9499 | 385 `sharedstatedir', `infodir', and `mandir'. Its default value is |
3199 | 386 `/usr/local'; the other variables add on `lib' or `man' to it |
387 by default. | |
388 | |
389 For example, suppose your site generally places GNU software | |
390 under `/usr/users/software/gnusoft' instead of `/usr/local'. | |
391 By including | |
392 `prefix=/usr/users/software/gnusoft' | |
393 in the arguments to `make', you can instruct the build process | |
394 to place all of the Emacs data files in the appropriate | |
395 directories under that path. | |
396 | |
397 `exec_prefix' serves the same purpose as `prefix', but instead | |
398 determines the default values for the architecture-dependent | |
9499 | 399 path variables - `bindir' and `libexecdir'. |
3199 | 400 |
401 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
|
402 GNU software; this variable is specific to Emacs. |
3199 | 403 |
12620 | 404 `archlibdir' indicates where Emacs installs and expects the executable |
405 files and other architecture-dependent data it uses while | |
406 running. Its default value, based on `libexecdir' (which | |
407 see), is `/usr/local/libexec/emacs/VERSION/CONFIGURATION-NAME' | |
3199 | 408 (where VERSION and CONFIGURATION-NAME are as described above). |
409 | |
410 Remember that you must specify any variable values you need each time | |
411 you run `make' in the top directory. If you run `make' once to build | |
412 emacs, test it, and then run `make' again to install the files, you | |
413 must provide the same variable settings each time. To make the | |
414 settings persist, you can edit them into the `Makefile' in the top | |
415 directory, but be aware that running the `configure' program erases | |
416 `Makefile' and rebuilds it from `Makefile.in'. | |
417 | |
21343
a3059cd301f1
Remove some directories that don't really work now.
Richard M. Stallman <rms@gnu.org>
parents:
21089
diff
changeset
|
418 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
|
419 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
|
420 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
|
421 before you run `make'. |
a3059cd301f1
Remove some directories that don't really work now.
Richard M. Stallman <rms@gnu.org>
parents:
21089
diff
changeset
|
422 |
3199 | 423 The top-level Makefile stores the variable settings it used in the |
424 Makefiles for the subdirectories, so you don't have to specify them | |
425 when running make in the subdirectories. | |
426 | |
427 | |
428 CONFIGURATION BY HAND | |
429 | |
7864 | 430 Instead of running the `configure' program, you have to perform the |
431 following steps. | |
3199 | 432 |
13667
fbf777f663d3
Correct .in.in and .h.in in file names.
Richard M. Stallman <rms@gnu.org>
parents:
12620
diff
changeset
|
433 1) Copy `./src/config.in' to `./src/config.h'. |
3199 | 434 |
435 2) Consult `./etc/MACHINES' to see what configuration name you should | |
436 use for your system. Look at the code of the `configure' script to | |
437 see which operating system and architecture description files from | |
438 `src/s' and `src/m' should be used for that configuration name. Edit | |
439 `src/config.h', and change the two `#include' directives to include | |
440 the appropriate system and architecture description files. | |
441 | |
442 2) Edit `./src/config.h' to set the right options for your system. If | |
443 you need to override any of the definitions in the s/*.h and m/*.h | |
444 files for your system and machine, do so by editing config.h, not by | |
445 changing the s/*.h and m/*.h files. Occasionally you may need to | |
446 redefine parameters used in `./lib-src/movemail.c'. | |
447 | |
7864 | 448 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
|
449 `Makefile.in' files. First copy `Makefile.in' to `Makefile.c', |
14020 | 450 then edit in appropriate substitutions for the @...@ constructs, |
7864 | 451 and then copy the shell commands near the end of `configure' |
452 that run cpp to construct `Makefile'. | |
3199 | 453 |
7864 | 454 4) Create `Makefile' files in various other directories |
455 from the corresponding `Makefile.in' files. This isn't so hard, | |
456 just a matter of substitution. | |
3199 | 457 |
458 The `configure' script is built from `configure.in' by the `autoconf' | |
9760
05fbcd364e6e
update for Autoconf 2.0 and other recent changes.
David J. MacKenzie <djm@gnu.org>
parents:
9507
diff
changeset
|
459 program. You need version 2.0 or newer of `autoconf' to rebuild `configure'. |
3199 | 460 |
461 BUILDING GNU EMACS BY HAND | |
462 | |
9507 | 463 Once Emacs is configured, running `make' in the top directory performs |
464 the following steps. | |
3199 | 465 |
466 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
|
467 `./src/paths.h' from the template file `./src/paths.in', changing |
3199 | 468 the paths to the values specified in `./Makefile'. |
469 | |
7864 | 470 2) Go to directory `./lib-src' and run `make'. This creates |
471 executables named `ctags' and `etags' and `wakeup' and `make-docfile' | |
472 and `digest-doc' and `test-distrib'. And others. | |
3199 | 473 |
7864 | 474 3) Go to directory `./src' and Run `make'. This refers to files in |
475 the `./lisp' and `./lib-src' subdirectories using names `../lisp' and | |
3199 | 476 `../lib-src'. |
477 | |
478 This creates a file `./src/emacs' which is the runnable Emacs, | |
7864 | 479 which has another name that contains a version number. |
480 Each time you do this, that version number increments in the last place. | |
3199 | 481 |
482 It also creates a file in `./etc' whose name is `DOC' followed by the | |
483 current Emacs version. This file contains documentation strings for | |
484 all the functions in Emacs. Each time you run make to make a new | |
485 emacs, a new DOC file with a new name is made. You must keep the DOC | |
486 file for an Emacs version as long as you keep using that Emacs | |
487 version. | |
488 | |
489 | |
490 INSTALLATION BY HAND | |
491 | |
9507 | 492 The steps below are done by running `make install' in the main |
493 directory of the Emacs distribution. | |
3199 | 494 |
495 1) Copy `./lisp' and its subdirectories, `./etc', and the executables | |
496 in `./lib-src' to their final destinations, as selected in `./src/paths.h'. | |
497 | |
498 Strictly speaking, not all of the executables in `./lib-src' need be copied. | |
7627 | 499 - The programs `cvtmail', `emacsserver', `fakemail', `hexl', |
7864 | 500 `movemail', `profile', `rcs2log', `timer', `vcdiff', `wakeup', |
501 and `yow' are used by Emacs; they do need to be copied. | |
502 - The programs `etags', `ctags', `emacsclient', `b2m', and `rcs-checkin' | |
3199 | 503 are intended to be run by users; they are handled below. |
9498 | 504 - The programs `make-docfile' and `test-distrib' were |
3199 | 505 used in building Emacs, and are not needed any more. |
506 - The programs `digest-doc' and `sorted-doc' convert a `DOC' file into | |
507 a file for users to read. There is no important reason to move them. | |
508 | |
509 2) Copy the files in `./info' to the place specified in | |
510 `./lisp/site-init.el' or `./lisp/paths.el'. Note that if the | |
511 destination directory already contains a file named `dir', you | |
512 probably don't want to replace it with the `dir' file in the Emacs | |
513 distribution. Instead, you should make sure that the existing `dir' | |
514 file contains an appropriate menu entry for the Emacs info. | |
515 | |
23353 | 516 3) Copy `./src/emacs' to `/usr/local/bin', or to some other directory |
3199 | 517 in users' search paths. `./src/emacs' has an alternate name |
518 `./src/emacs-EMACSVERSION'; you may wish to make a symbolic link named | |
519 `/usr/local/bin/emacs' pointing to that alternate name, as an easy way | |
520 of installing different versions. | |
521 | |
522 You can delete `./src/temacs'. | |
523 | |
23353 | 524 4) Copy the programs `b2m', `emacsclient', `ctags', `etags', and |
7864 | 525 `rcs-checkin' from `./lib-src' to `/usr/local/bin'. These programs are |
3199 | 526 intended for users to run. |
527 | |
23353 | 528 5) Copy the man pages in `./etc' for emacs, ctags, and etags into the |
3199 | 529 appropriate man directories. |
530 | |
23353 | 531 6) The files in the `./src' subdirectory, except for `emacs', are not |
7864 | 532 used by Emacs once it is built. However, it is very desirable to keep |
533 the source on line for debugging. | |
3199 | 534 |
535 | |
536 PROBLEMS | |
537 | |
21089
0413a3ff3b8d
PROBLEMS is now in the etc directory.
Richard M. Stallman <rms@gnu.org>
parents:
20213
diff
changeset
|
538 See the file PROBLEMS in etc subdirectory for a list of various |
3199 | 539 problems sometimes encountered, and what to do about them. |
540 | |
541 | |
6062 | 542 Installation on MSDOG (a.k.a. MSDOS) |
543 | |
7627 | 544 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
|
545 (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
|
546 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
|
547 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
|
548 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
|
549 (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
|
550 if any of them isn't found. |
6062 | 551 |
15444
66a9ef0892a2
Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents:
15209
diff
changeset
|
552 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
|
553 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
|
554 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
|
555 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
|
556 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
|
557 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
|
558 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
|
559 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
|
560 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
|
561 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
|
562 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
|
563 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
|
564 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
|
565 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
|
566 to `n' during both unpacking and compiling. |
15017 | 567 |
15444
66a9ef0892a2
Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents:
15209
diff
changeset
|
568 (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
|
569 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
|
570 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
|
571 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
|
572 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
|
573 |
66a9ef0892a2
Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents:
15209
diff
changeset
|
574 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
|
575 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
|
576 compilation; Emacs compiled with DJGPP v2.0 or later will always |
66a9ef0892a2
Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents:
15209
diff
changeset
|
577 support long file names on Windows 95 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
|
578 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
|
579 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
|
580 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
|
581 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
|
582 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
|
583 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
|
584 djtar after you set LFN=y in the environment. |
15017 | 585 |
15444
66a9ef0892a2
Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents:
15209
diff
changeset
|
586 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
|
587 |
66a9ef0892a2
Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents:
15209
diff
changeset
|
588 djtar -x emacs.tgz |
12339
3398b88cbd25
Update MSDOS needs list.
Richard M. Stallman <rms@gnu.org>
parents:
12042
diff
changeset
|
589 |
15444
66a9ef0892a2
Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents:
15209
diff
changeset
|
590 (This assumes that the Emacs distribution is called `emacs.tgz' on |
19635 | 591 your system.) |
12343 | 592 |
24070
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
593 If you need to type international characters, you will need to unpack |
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
594 the Leim distribution (see the description near the beginning of this |
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
595 file). You unpack it from the same directory where you unpacked |
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
596 Emacs. To unpack Leim with djtar, assuming the Leim distribution is |
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
597 called `leim.tgz', type this command: |
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
598 |
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
599 djtar -x leim.tgz |
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
600 |
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
601 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
|
602 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
|
603 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
|
604 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
|
605 type this: |
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
606 |
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
607 djtar -x intlfonts.tgz |
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
608 |
15444
66a9ef0892a2
Explain about MSDOS installation and long file name support.
Richard M. Stallman <rms@gnu.org>
parents:
15209
diff
changeset
|
609 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
|
610 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
|
611 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
|
612 |
3398b88cbd25
Update MSDOS needs list.
Richard M. Stallman <rms@gnu.org>
parents:
12042
diff
changeset
|
613 config msdos |
3398b88cbd25
Update MSDOS needs list.
Richard M. Stallman <rms@gnu.org>
parents:
12042
diff
changeset
|
614 make install |
6062 | 615 |
24452
3f25405e6e70
Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents:
24070
diff
changeset
|
616 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
|
617 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
|
618 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
|
619 command: |
3f25405e6e70
Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents:
24070
diff
changeset
|
620 |
3f25405e6e70
Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents:
24070
diff
changeset
|
621 make bdf INSTALLDIR=.. |
3f25405e6e70
Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents:
24070
diff
changeset
|
622 |
3f25405e6e70
Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents:
24070
diff
changeset
|
623 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
|
624 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
|
625 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
|
626 default. |
3f25405e6e70
Add detailed instructions to unpack and install intlfonts on MS-DOS.
Eli Zaretskii <eliz@gnu.org>
parents:
24070
diff
changeset
|
627 |
15039
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
628 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
|
629 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
|
630 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
|
631 /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
|
632 /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
|
633 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
|
634 subdirectories you need to keep are bin, lisp, etc and info. (If you |
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
635 installed Leim, keep the leim subdirectory, and if you installed |
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
636 intlfonts, keep the fonts directory and all its sibdirectories as well.) |
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
637 The bin subdirectory should be added to your PATH. The msdos |
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
638 subdirectory includes a PIF and an icon file for Emacs which you might |
526d645420b5
Explain that intlfonts are used by ps-print as well.
Eli Zaretskii <eliz@gnu.org>
parents:
23353
diff
changeset
|
639 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
|
640 |
15039
43c846d45f79
Clarify MSDOS installing and unpacking.
Richard M. Stallman <rms@gnu.org>
parents:
15017
diff
changeset
|
641 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
|
642 ../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
|
643 Emacs executable was run from. You can override this by setting the |
19635 | 644 environment variables EMACSDATA (for the location of `etc' directory), |
645 EMACSLOADPATH (for the location of `lisp' directory) and INFOPATH (for | |
646 the location of the `info' directory). | |
6062 | 647 |
7627 | 648 MSDOG is a not a multitasking operating system, so Emacs features such |
649 as asynchronous subprocesses that depend on multitasking will not | |
650 work. Synchronous subprocesses do work. | |
15825
615a180ced87
Describe djgpp library replacement files.
Richard M. Stallman <rms@gnu.org>
parents:
15733
diff
changeset
|
651 |
16861
310fd977a344
Update info about DJGPP.
Richard M. Stallman <rms@gnu.org>
parents:
16309
diff
changeset
|
652 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
|
653 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
|
654 is_exec.c and sigaction.c. To work around the bugs, compile these |
310fd977a344
Update info about DJGPP.
Richard M. Stallman <rms@gnu.org>
parents:
16309
diff
changeset
|
655 files and link them into temacs. Djgpp version 2.01 have these bugs |
310fd977a344
Update info about DJGPP.
Richard M. Stallman <rms@gnu.org>
parents:
16309
diff
changeset
|
656 fixed, so upgrade if you can before building Emacs. |