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