Commit | Line | Data |
---|---|---|
a4a9692d | 1 | Building and Installing Emacs |
3dfbc6d8 | 2 | on Windows NT/2K/XP and Windows 95/98/ME |
a4a9692d | 3 | |
bd7bdff8 | 4 | Copyright (c) 2001,2004,2005 Free Software Foundation, Inc. |
4b994b84 AI |
5 | See the end of the file for copying permissions. |
6 | ||
12d70bbb EZ |
7 | If you used WinZip to unpack the distribution, we suggest to |
8 | remove the files and unpack again with a different program! | |
9 | WinZip is known to create some subtle and hard to debug problems, | |
177c0ea7 | 10 | such as converting files to DOS CR-LF format, not creating empty |
12d70bbb EZ |
11 | directories, etc. We suggest to use djtarnt.exe from the GNU FTP |
12 | site. | |
13 | ||
589a591b JR |
14 | If you are building out of CVS, then some files in this directory |
15 | (.bat files, nmake.defs and makefile.w32-in) may need the line-ends | |
16 | fixing first. The easiest way to do this and avoid future conflicts | |
17 | is to run the following command in this (emacs/nt) directory: | |
591cbed1 | 18 | |
589a591b | 19 | cvs update -kb |
591cbed1 EZ |
20 | |
21 | (WARNING: Do NOT use this suggestion if you have write access to the | |
22 | Emacs CVS tree and intend to commit changes to CVS. This is because -kb | |
23 | is sticky: it will be used in all future CVS operations on the files you | |
24 | check out like this.) Alternatively, use programs that convert | |
25 | end-of-line format, such as dos2unix and unix2dos available from | |
26 | GnuWin32 or dtou and utod from the DJGPP project. | |
27 | ||
1040d041 | 28 | In addition to this file, you should also read INSTALL.CVS in the |
591cbed1 EZ |
29 | parent directory, and make sure that you have a version of |
30 | "touch.exe" in your path, and that it will create files that do not | |
31 | yet exist. | |
589a591b | 32 | |
da179dd0 | 33 | To compile Emacs, you will need either Microsoft Visual C++ 2.0 or |
bd7bdff8 | 34 | later and nmake, or a Windows port of GCC 2.95 or later with MinGW |
263f7134 | 35 | and W32 API support and a port of GNU make. You can use the Cygwin |
bd7bdff8 | 36 | ports of GCC, but Emacs requires the MinGW headers and libraries to |
8481e41e EZ |
37 | build (latest versions of the Cygwin toolkit, at least since v1.3.3, |
38 | include the MinGW headers and libraries as an integral part). | |
da179dd0 | 39 | |
ad6b2a36 JR |
40 | Other compilers may work, but specific reports from people that have |
41 | tried suggest that the Intel C compiler (for example) may produce an | |
42 | Emacs executable with strange filename completion behaviour. Unless | |
43 | you would like to assist by finding and fixing the cause of any bugs | |
44 | like this, we recommend the use of the supported compilers mentioned | |
45 | in the previous paragraph. | |
46 | ||
bd7bdff8 JB |
47 | You will also need a copy of the Posix cp, rm and mv programs. These |
48 | and other useful Posix utilities can be obtained from one of several | |
49 | projects: | |
50 | ||
51 | * http://www.mingw.org/ ( MinGW ) | |
f3ece042 | 52 | * http://www.cygwin.com/ ( Cygwin ) |
bd7bdff8 JB |
53 | * http://unxutils.sourceforge.net/ ( UnxUtils ) |
54 | * http://gnuwin32.sourceforge.net/ ( GnuWin32 ) | |
1040d041 | 55 | |
3dfbc6d8 | 56 | If you build Emacs on Windows 9X or ME, not on Windows 2K/XP or |
6d76a603 | 57 | Windows NT, we suggest to install the Cygwin port of Bash. |
4bcec9a2 | 58 | |
bd7bdff8 JB |
59 | Additional instructions and help for building Emacs on Windows can be |
60 | found at the Emacs Wiki: | |
61 | ||
62 | http://www.emacswiki.org/cgi-bin/wiki/WThirtyTwoInstallationKit | |
a4a9692d | 63 | |
591cbed1 EZ |
64 | and at this URL: |
65 | ||
66 | http://ourcomments.org/Emacs/w32-build-emacs.html | |
67 | ||
4bcec9a2 EZ |
68 | For reference, here is a list of which builds of GNU make are known |
69 | to work or not, and whether they work in the presence and/or absence | |
fc813ef6 JR |
70 | of sh.exe, the Cygwin port of Bash. Note that any version of make |
71 | that is compiled with Cygwin will only work with Cygwin tools, due to | |
72 | the use of cygwin style paths. This means Cygwin make is unsuitable | |
73 | for building parts of Emacs that need to invoke Emacs itself (leim and | |
74 | "make bootstrap", for example). Also see the Trouble-shooting section | |
75 | below if you decide to go ahead and use Cygwin make. | |
b147d297 EZ |
76 | |
77 | In addition, using 4NT as your shell is known to fail the build process, | |
78 | at least for 4NT version 3.01. Use cmd.exe, the default NT shell, | |
f9a8480b JR |
79 | instead. MSYS sh.exe also appears to cause various problems. If you have |
80 | MSYS installed, try "make SHELL=cmd.exe" to force the use of cmd.exe | |
81 | instead of sh.exe. | |
177c0ea7 | 82 | |
4bcec9a2 EZ |
83 | sh exists no sh |
84 | ||
fc813ef6 | 85 | cygwin b20.1 make (3.75): fails[1, 5] fails[2, 5] |
4bcec9a2 EZ |
86 | MSVC compiled gmake 3.77: okay okay |
87 | MSVC compiled gmake 3.78.1: okay okay | |
88 | MSVC compiled gmake 3.79.1: okay okay | |
bf95665f | 89 | mingw32/gcc-2.92.2 make (3.77): okay okay[4] |
fc813ef6 JR |
90 | cygwin compiled gmake 3.77: fails[1, 5] fails[2, 5] |
91 | cygwin compiled make 3.78.1: fails[5] fails[2, 5] | |
92 | cygwin compiled make 3.79.1: fails[3, 5] fails[2?, 5] | |
177c0ea7 | 93 | mingw32 compiled make 3.79.1: okay okay |
591cbed1 | 94 | mingw32 compiled make 3.80: okay unknown[6] |
4bcec9a2 EZ |
95 | |
96 | Notes: | |
97 | ||
98 | [1] doesn't cope with makefiles with DOS line endings, so must mount | |
99 | emacs source with text!=binary. | |
100 | [2] fails when needs to invoke shell commands; okay invoking gcc etc. | |
fc813ef6 JR |
101 | [3] requires LC_MESSAGES support to build; cannot build with early |
102 | versions of cygwin. | |
4bcec9a2 | 103 | [4] may fail on Windows 9X and Windows ME; if so, install Bash. |
fc813ef6 JR |
104 | [5] fails when building leim due to the use of cygwin style paths. |
105 | May work if building emacs without leim. | |
591cbed1 | 106 | [6] please report if you try this combination. |
4bcec9a2 | 107 | |
6d76a603 | 108 | * Configuring |
a4a9692d | 109 | |
da179dd0 AI |
110 | Configuration of Emacs is now handled by running configure.bat in the |
111 | nt subdirectory. It will detect which compiler you have available, | |
112 | and generate makefiles accordingly. You can override the compiler | |
113 | detection, and control optimization and debug settings, by specifying | |
114 | options on the command line when invoking configure. | |
a4a9692d | 115 | |
da179dd0 AI |
116 | To configure Emacs to build with GCC or MSVC, whichever is available, |
117 | simply change to the nt subdirectory and run `configure' with no | |
118 | options. To see what options are available, run `configure --help'. | |
a4a9692d | 119 | |
17d4e22c AI |
120 | N.B. It is normal to see a few error messages output while configure |
121 | is running, when gcc support is being tested. These cannot be | |
122 | surpressed because of limitations in the Windows 9x command.com shell. | |
123 | ||
591cbed1 EZ |
124 | You are encouraged to look at the file config.log which shows details |
125 | for failed tests, after configure.bat finishes. Any unexplained failure | |
126 | should be investigated and perhaps reported as a bug (see the section | |
127 | about reporting bugs in the file README in this directory and in the | |
128 | Emacs manual). | |
129 | ||
bfd889ed JR |
130 | * Optional image library support |
131 | ||
3dfbc6d8 JB |
132 | In addition to its "native" image formats (pbm and xbm), Emacs can |
133 | handle other image types: xpm, tiff, gif, png and jpeg (postscript is | |
134 | currently unsupported on Windows). To build Emacs with support for | |
135 | them, the corresponding headers must be in the include path when the | |
136 | configure script is run. This can be setup using environment | |
137 | variables, or by specifying --cflags -I... options on the command-line | |
138 | to configure.bat. The configure script will report whether it was | |
591cbed1 EZ |
139 | able to detect the headers. If the results of this testing appear to be |
140 | incorrect, please look for details in the file config.log: it will show | |
141 | the failed test programs and compiler error messages that should explain | |
142 | what is wrong. (Usually, any such failures happen because some headers | |
143 | are missing due to bad packaging of the image support libraries.) | |
bfd889ed | 144 | |
3dfbc6d8 | 145 | To use the external image support, the DLLs implementing the |
bd7bdff8 JB |
146 | functionality must be found when Emacs first needs them, either on the |
147 | PATH, or in the same directory as emacs.exe. Failure to find a | |
148 | library is not an error; the associated image format will simply be | |
149 | unavailable. Note that once Emacs has determined that a library can | |
150 | not be found, there's no way to force it to try again, other than | |
151 | restarting. See the variable `image-library-alist' to configure the | |
152 | expected names of the libraries. | |
3dfbc6d8 JB |
153 | |
154 | Some image libraries have dependencies on one another, or on zlib. | |
155 | For example, tiff support depends on the jpeg library. If you did not | |
156 | compile the libraries yourself, you must make sure that any dependency | |
157 | is in the PATH or otherwise accesible and that the binaries are | |
158 | compatible (for example, that they were built with the same compiler). | |
159 | ||
160 | Binaries for the image libraries (among many others) can be found at | |
bd7bdff8 | 161 | the GnuWin32 project. These are built with MinGW, but they can be |
591cbed1 EZ |
162 | used with both GCC/MinGW and MSVC builds of Emacs. See the info on |
163 | http://ourcomments.org/Emacs/w32-build-emacs.html for more details about | |
164 | installing image support libraries. | |
bfd889ed | 165 | |
6d76a603 | 166 | * Building |
a4a9692d | 167 | |
da179dd0 AI |
168 | After running configure, simply run the appropriate `make' program for |
169 | your compiler to build Emacs. For MSVC, this is nmake; for GCC, it is | |
170 | GNU make. | |
a4a9692d | 171 | |
da179dd0 AI |
172 | As the files are compiled, you will see some warning messages |
173 | declaring that some functions don't return a value, or that some data | |
174 | conversions will be lossy, etc. You can safely ignore these messages. | |
175 | The warnings may be fixed in the main FSF source at some point, but | |
176 | until then we will just live with them. | |
a4a9692d | 177 | |
6d76a603 | 178 | * Installing |
a4a9692d | 179 | |
0fc7be80 EZ |
180 | To install Emacs after it has compiled, simply run `nmake install' |
181 | or `make install', depending on which version of the Make utility | |
182 | do you have. | |
a4a9692d | 183 | |
da179dd0 AI |
184 | By default, Emacs will be installed in the location where it was |
185 | built, but a different location can be specified either using the | |
186 | --prefix option to configure, or by setting INSTALL_DIR when running | |
187 | make, like so: | |
a4a9692d | 188 | |
da179dd0 | 189 | make install INSTALL_DIR=D:/emacs |
a4a9692d | 190 | |
0fc7be80 EZ |
191 | (for `nmake', type "nmake install INSTALL_DIR=D:/emacs" instead). |
192 | ||
da179dd0 AI |
193 | The install process will run addpm to setup the registry entries, and |
194 | to create a Start menu icon for Emacs. | |
a4a9692d | 195 | |
6d76a603 | 196 | * Trouble-shooting |
a4a9692d | 197 | |
da179dd0 | 198 | The main problems that are likely to be encountered when building |
bd7bdff8 | 199 | Emacs stem from using an old version of GCC, or old MinGW or W32 API |
da179dd0 AI |
200 | headers. Additionally, cygwin ports of GNU make may require the Emacs |
201 | source tree to be mounted with text!=binary, because the makefiles | |
202 | generated by configure.bat necessarily use DOS line endings. Also, | |
203 | cygwin ports of make must run in UNIX mode, either by specifying | |
204 | --unix on the command line, or MAKE_MODE=UNIX in the environment. | |
a4a9692d | 205 | |
da179dd0 AI |
206 | When configure runs, it attempts to detect when GCC itself, or the |
207 | headers it is using, are not suitable for building Emacs. GCC version | |
208 | 2.95 or later is needed, because that is when the Windows port gained | |
209 | sufficient support for anonymous structs and unions to cope with some | |
210 | definitions from winnt.h that are used by addsection.c. The W32 API | |
211 | headers that come with Cygwin b20.1 are incomplete, and do not include | |
212 | some definitions required by addsection.c, for instance. Also, older | |
213 | releases of the W32 API headers from Anders Norlander contain a typo | |
214 | in the definition of IMAGE_FIRST_SECTION in winnt.h, which | |
215 | addsection.c relies on. Versions of w32api-xxx.zip from at least | |
216 | 1999-11-18 onwards are okay. | |
a4a9692d | 217 | |
591cbed1 EZ |
218 | When in doubt about correctness of what configure did, look at the file |
219 | config.log, which shows all the failed test programs and compiler | |
220 | messages associated with the failures. If that doesn't give a clue, | |
221 | please report the problems, together with the relevant fragments from | |
222 | config.log, as bugs. | |
223 | ||
4bcec9a2 EZ |
224 | If configure succeeds, but make fails, install the Cygwin port of |
225 | Bash, even if the table above indicates that Emacs should be able to | |
226 | build without sh.exe. (Some versions of Windows shells are too dumb | |
227 | for Makefile's used by Emacs.) | |
228 | ||
8481e41e | 229 | If you are using certain Cygwin builds of GCC, such as Cygwin version |
6d76a603 AI |
230 | 1.1.8, you may need to specify some extra compiler flags like so: |
231 | ||
232 | configure --with-gcc --cflags -mwin32 --cflags -D__MSVCRT__ | |
315746cc | 233 | --ldflags -mwin32 |
6d76a603 | 234 | |
8481e41e EZ |
235 | However, the latest Cygwin versions, such as 1.3.3, don't need those |
236 | switches; you can simply use "configure --with-gcc". | |
237 | ||
6d76a603 AI |
238 | We will attempt to auto-detect the need for these flags in a future |
239 | release. | |
240 | ||
241 | * Debugging | |
a4a9692d | 242 | |
da179dd0 AI |
243 | You should be able to debug Emacs using the debugger that is |
244 | appropriate for the compiler you used, namely DevStudio or Windbg if | |
245 | compiled with MSVC, or gdb if compiled with gcc. | |
246 | ||
247 | Emacs functions implemented in C use a naming convention that reflects | |
248 | their names in lisp. The names of the C routines are the lisp names | |
249 | prefixed with 'F', and with dashes converted to underscores. For | |
250 | example, the function call-process is implemented in C by | |
251 | Fcall_process. Similarly, lisp variables are prefixed with 'V', again | |
252 | with dashes converted to underscores. These conventions enable you to | |
253 | easily set breakpoints or examine familiar lisp variables by name. | |
254 | ||
255 | Since Emacs data is often in the form of a lisp object, and the | |
256 | Lisp_Object type is difficult to examine manually in the MSVC | |
257 | debugger, Emacs provides a helper routine called debug_print that | |
258 | prints out a readable representation of a Lisp_Object. (If you are | |
259 | using gdb, there is a .gdbinit file in the src directory which | |
260 | provides definitions that are useful for examining lisp objects. The | |
261 | following tips are mainly of interest when using MSVC.) The output | |
262 | from debug_print is sent to stderr, and to the debugger via the | |
263 | OutputDebugString routine. The output sent to stderr should be | |
264 | displayed in the console window that was opened when the emacs.exe | |
265 | executable was started. The output sent to the debugger should be | |
266 | displayed in its "Debug" output window. | |
267 | ||
268 | When you are in the process of debugging Emacs and you would like to | |
269 | examine the contents of a Lisp_Object variable, popup the QuickWatch | |
270 | window (QuickWatch has an eyeglass symbol on its button in the | |
271 | toolbar). In the text field at the top of the window, enter | |
272 | debug_print(<variable>) and hit return. For example, start and run | |
273 | Emacs in the debugger until it is waiting for user input. Then click | |
274 | on the Break button in the debugger to halt execution. Emacs should | |
275 | halt in ZwUserGetMessage waiting for an input event. Use the Call | |
276 | Stack window to select the procedure w32_msp_pump up the call stack | |
277 | (see below for why you have to do this). Open the QuickWatch window | |
278 | and enter debug_print(Vexec_path). Evaluating this expression will | |
279 | then print out the contents of the lisp variable exec-path. | |
280 | ||
281 | If QuickWatch reports that the symbol is unknown, then check the call | |
282 | stack in the Call Stack window. If the selected frame in the call | |
283 | stack is not an Emacs procedure, then the debugger won't recognize | |
284 | Emacs symbols. Instead, select a frame that is inside an Emacs | |
285 | procedure and try using debug_print again. | |
286 | ||
287 | If QuickWatch invokes debug_print but nothing happens, then check the | |
288 | thread that is selected in the debugger. If the selected thread is | |
289 | not the last thread to run (the "current" thread), then it cannot be | |
290 | used to execute debug_print. Use the Debug menu to select the current | |
291 | thread and try using debug_print again. Note that the debugger halts | |
292 | execution (e.g., due to a breakpoint) in the context of the current | |
293 | thread, so this should only be a problem if you've explicitly switched | |
294 | threads. | |
4b994b84 AI |
295 | |
296 | COPYING PERMISSIONS | |
297 | ||
298 | Permission is granted to anyone to make or distribute verbatim copies | |
299 | of this document as received, in any medium, provided that the | |
300 | copyright notice and permission notice are preserved, | |
301 | and that the distributor grants the recipient permission | |
302 | for further redistribution as permitted by this notice. | |
303 | ||
304 | Permission is granted to distribute modified versions | |
305 | of this document, or of portions of it, | |
306 | under the above conditions, provided also that they | |
307 | carry prominent notices stating who last changed them, | |
308 | and that any new or changed statements about the activities | |
309 | of the Free Software Foundation are approved by the Foundation. |