Commit | Line | Data |
---|---|---|
a917e3f2 JB |
1 | Building and Installing Emacs on Windows |
2 | (from 95 to 7 and beyond) | |
a4a9692d | 3 | |
114f9c96 | 4 | Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 |
0939da72 | 5 | Free Software Foundation, Inc. |
7f6d64f8 | 6 | See the end of the file for license conditions. |
4b994b84 | 7 | |
0939da72 EZ |
8 | * For the impatient |
9 | ||
10 | Here are the concise instructions for configuring and building the | |
195e32b7 EZ |
11 | native Windows binary of Emacs, for those who want to skip the |
12 | complex explanations and ``just do it'': | |
0939da72 | 13 | |
029e4603 RS |
14 | Do not use this recipe with Cygwin. For building on Cygwin, |
15 | use the normal installation instructions, ../INSTALL. | |
16 | ||
0939da72 EZ |
17 | 1. Change to the `nt' directory (the directory of this file): |
18 | ||
19 | cd nt | |
20 | ||
21 | 2. Run configure.bat. From the COMMAND.COM/CMD.EXE command prompt: | |
22 | ||
23 | configure | |
24 | ||
25 | from a Unixy shell prompt: | |
26 | ||
27 | cmd /c configure.bat | |
28 | or | |
29 | command.com /c configure.bat | |
30 | ||
31 | 3. Run the Make utility suitable for your environment. If you build | |
309c91ff EZ |
32 | with the Microsoft's Visual C compiler (but see notes about using |
33 | VC++ 8.0 and later below): | |
0939da72 EZ |
34 | |
35 | nmake | |
36 | ||
37 | For the development environments based on GNU GCC (MinGW, MSYS, | |
ac70d20b JR |
38 | Cygwin - but see notes about Cygwin make below), depending on how |
39 | Make is called, it could be: | |
0939da72 EZ |
40 | |
41 | make | |
ac70d20b JR |
42 | or |
43 | mingw32-make | |
0939da72 EZ |
44 | or |
45 | gnumake | |
46 | or | |
47 | gmake | |
48 | ||
ee6f37f2 | 49 | (If you are building from Bazaar, say "make bootstrap" or "nmake |
e84b63f1 EZ |
50 | bootstrap" instead, and avoid using Cygwin make.) |
51 | ||
52 | With GNU Make, you can use the -j command-line option to have | |
53 | Make execute several commands at once, like this: | |
54 | ||
ecfd8ceb | 55 | gmake -j 2 XMFLAGS="-j 2" |
e84b63f1 EZ |
56 | |
57 | The XMFLAGS variable overrides the default behavior of GNU Make | |
58 | on Windows, whereby recursive Make invocations reset the maximum | |
59 | number of simultaneous commands to 1. The above command allows | |
60 | up to 4 simultaneous commands at once in the top-level Make, and | |
61 | up to 3 in each one of the recursive Make's. | |
0939da72 | 62 | |
ee6f37f2 KF |
63 | 4. Generate the Info manuals (only if you are building out of Bazaar, |
64 | and if you have makeinfo.exe installed): | |
0939da72 EZ |
65 | |
66 | make info | |
67 | ||
68 | (change "make" to "nmake" if you use MSVC). | |
69 | ||
70 | 5. Install the produced binaries: | |
71 | ||
72 | make install | |
73 | ||
74 | That's it! | |
75 | ||
76 | If these short instructions somehow fail, read the rest of this | |
77 | file. | |
78 | ||
79 | * Preliminaries | |
80 | ||
195e32b7 | 81 | If you want to build a Cygwin port of Emacs, use the instructions in |
0d801288 | 82 | the INSTALL file in the main Emacs directory (the parent of this |
195e32b7 EZ |
83 | directory). These instructions are for building a native Windows |
84 | binary of Emacs. | |
85 | ||
12d70bbb EZ |
86 | If you used WinZip to unpack the distribution, we suggest to |
87 | remove the files and unpack again with a different program! | |
88 | WinZip is known to create some subtle and hard to debug problems, | |
177c0ea7 | 89 | such as converting files to DOS CR-LF format, not creating empty |
12d70bbb EZ |
90 | directories, etc. We suggest to use djtarnt.exe from the GNU FTP |
91 | site. | |
92 | ||
ee6f37f2 | 93 | In addition to this file, you should also read INSTALL.BZR in the |
591cbed1 EZ |
94 | parent directory, and make sure that you have a version of |
95 | "touch.exe" in your path, and that it will create files that do not | |
96 | yet exist. | |
589a591b | 97 | |
0939da72 EZ |
98 | * Supported development environments |
99 | ||
bbf5b365 JR |
100 | To compile Emacs, you will need either Microsoft Visual C++ 2.0, or |
101 | later up to 7.0, and nmake, or a Windows port of GCC 2.95 or later | |
102 | with MinGW and W32 API support and a port of GNU Make. You can use | |
103 | the Cygwin ports of GCC, but Emacs requires the MinGW headers and | |
104 | libraries to build (latest versions of the Cygwin toolkit, at least | |
105 | since v1.3.3, include the MinGW headers and libraries as an integral | |
106 | part). | |
107 | ||
108 | Note that building Emacs with Visual Studio 2005 (VC++ 8.0) is not | |
309c91ff EZ |
109 | supported at this time, due to changes introduced by Microsoft into |
110 | the libraries shipped with the compiler. | |
ecfd8ceb | 111 | |
0939da72 EZ |
112 | The rest of this file assumes you have a working development |
113 | environment. If you just installed such an environment, try | |
114 | building a trivial C "Hello world" program, and see if it works. If | |
5376eb82 EZ |
115 | it doesn't work, resolve that problem first! If you use Microsoft |
116 | Visual Studio .NET 2003, don't forget to run the VCVARS32.BAT batch | |
117 | file from the `Bin' subdirectory of the directory where you have | |
118 | installed VS.NET. | |
0939da72 | 119 | |
6c72c0c7 EZ |
120 | If you use the MinGW port of GCC and GNU Make to build Emacs, there |
121 | are some compatibility issues wrt Make and the shell that is run by | |
122 | Make, either the standard COMMAND.COM/CMD.EXE supplied with Windows | |
6d96d18f | 123 | or sh.exe, a port of a Unixy shell. For reference, below is a list |
6c72c0c7 EZ |
124 | of which builds of GNU Make are known to work or not, and whether |
125 | they work in the presence and/or absence of sh.exe, the Cygwin port | |
1640b452 | 126 | of Bash. Note that any version of Make that is compiled with Cygwin |
6d96d18f | 127 | will only work with Cygwin tools, due to the use of Cygwin style |
6c72c0c7 EZ |
128 | paths. This means Cygwin Make is unsuitable for building parts of |
129 | Emacs that need to invoke Emacs itself (leim and "make bootstrap", | |
130 | for example). Also see the Trouble-shooting section below if you | |
131 | decide to go ahead and use Cygwin make. | |
b147d297 | 132 | |
1640b452 JB |
133 | In addition, using 4NT or TCC as your shell is known to fail the build |
134 | process, at least since 4NT version 3.01. Use CMD.EXE, the default | |
135 | Windows shell, instead. MSYS sh.exe also appears to cause various | |
136 | problems. If you have MSYS installed, try "make SHELL=cmd.exe" to | |
137 | force the use of cmd.exe instead of sh.exe. | |
177c0ea7 | 138 | |
4bcec9a2 EZ |
139 | sh exists no sh |
140 | ||
fc813ef6 | 141 | cygwin b20.1 make (3.75): fails[1, 5] fails[2, 5] |
4bcec9a2 EZ |
142 | MSVC compiled gmake 3.77: okay okay |
143 | MSVC compiled gmake 3.78.1: okay okay | |
144 | MSVC compiled gmake 3.79.1: okay okay | |
bf95665f | 145 | mingw32/gcc-2.92.2 make (3.77): okay okay[4] |
fc813ef6 JR |
146 | cygwin compiled gmake 3.77: fails[1, 5] fails[2, 5] |
147 | cygwin compiled make 3.78.1: fails[5] fails[2, 5] | |
148 | cygwin compiled make 3.79.1: fails[3, 5] fails[2?, 5] | |
16fb735f EZ |
149 | cygwin compiled make 3.80: okay[6] fails?[7] |
150 | cygwin compiled make 3.81: fails fails?[7] | |
177c0ea7 | 151 | mingw32 compiled make 3.79.1: okay okay |
16fb735f EZ |
152 | mingw32 compiled make 3.80: okay okay[7] |
153 | mingw32 compiled make 3.81: okay okay[8] | |
4bcec9a2 EZ |
154 | |
155 | Notes: | |
156 | ||
157 | [1] doesn't cope with makefiles with DOS line endings, so must mount | |
158 | emacs source with text!=binary. | |
159 | [2] fails when needs to invoke shell commands; okay invoking gcc etc. | |
fc813ef6 | 160 | [3] requires LC_MESSAGES support to build; cannot build with early |
a917e3f2 | 161 | versions of Cygwin. |
4bcec9a2 | 162 | [4] may fail on Windows 9X and Windows ME; if so, install Bash. |
fc813ef6 JR |
163 | [5] fails when building leim due to the use of cygwin style paths. |
164 | May work if building emacs without leim. | |
16fb735f EZ |
165 | [6] need to uncomment 3 lines in nt/gmake.defs that invoke `cygpath' |
166 | (look for "cygpath" near line 85 of gmake.defs). | |
167 | [7] not recommended; please report if you try this combination. | |
168 | [8] tested only on Windows XP. | |
4bcec9a2 | 169 | |
6c72c0c7 EZ |
170 | Other compilers may work, but specific reports from people that have |
171 | tried suggest that the Intel C compiler (for example) may produce an | |
5739d6f8 | 172 | Emacs executable with strange filename completion behavior. Unless |
6c72c0c7 EZ |
173 | you would like to assist by finding and fixing the cause of any bugs |
174 | like this, we recommend the use of the supported compilers mentioned | |
175 | in the previous paragraph. | |
176 | ||
a917e3f2 JB |
177 | You will also need a copy of the POSIX cp, rm and mv programs. These |
178 | and other useful POSIX utilities can be obtained from one of several | |
6c72c0c7 EZ |
179 | projects: |
180 | ||
0939da72 | 181 | * http://gnuwin32.sourceforge.net/ ( GnuWin32 ) |
6c72c0c7 EZ |
182 | * http://www.mingw.org/ ( MinGW ) |
183 | * http://www.cygwin.com/ ( Cygwin ) | |
184 | * http://unxutils.sourceforge.net/ ( UnxUtils ) | |
6c72c0c7 | 185 | |
a917e3f2 JB |
186 | If you build Emacs on 16-bit versions of Windows (9X or ME), we |
187 | suggest to install the Cygwin port of Bash. That is because the | |
188 | native Windows shell COMMAND.COM is too limited; the Emacs build | |
189 | procedure tries very hard to support even such limited shells, but | |
190 | as none of the Windows developers of Emacs work on Windows 9X, we | |
191 | cannot guarantee that it works without a more powerful shell. | |
6c72c0c7 EZ |
192 | |
193 | Additional instructions and help for building Emacs on Windows can be | |
194 | found at the Emacs Wiki: | |
195 | ||
0939da72 | 196 | http://www.emacswiki.org/cgi-bin/wiki/WThirtyTwoInstallationKit |
6c72c0c7 | 197 | |
309c91ff | 198 | and on these URLs: |
6c72c0c7 | 199 | |
0939da72 | 200 | http://ourcomments.org/Emacs/w32-build-emacs.html |
309c91ff EZ |
201 | http://derekslager.com/blog/posts/2007/01/emacs-hack-3-compile-emacs-from-cvs-on-windows.ashx |
202 | ||
ee6f37f2 KF |
203 | Both of those pages were written before Emacs switched from CVS to |
204 | Bazaar, but the parts about building Emacs still apply in Bazaar. | |
205 | The second URL has instructions for building with MSVC, as well as | |
206 | with MinGW, while the first URL covers only MinGW, but has more | |
207 | details about it. | |
6c72c0c7 | 208 | |
6d76a603 | 209 | * Configuring |
a4a9692d | 210 | |
da179dd0 | 211 | Configuration of Emacs is now handled by running configure.bat in the |
0939da72 | 212 | `nt' subdirectory. It will detect which compiler you have available, |
da179dd0 AI |
213 | and generate makefiles accordingly. You can override the compiler |
214 | detection, and control optimization and debug settings, by specifying | |
215 | options on the command line when invoking configure. | |
a4a9692d | 216 | |
da179dd0 | 217 | To configure Emacs to build with GCC or MSVC, whichever is available, |
0939da72 | 218 | simply change to the `nt' subdirectory and run `configure.bat' with no |
da179dd0 | 219 | options. To see what options are available, run `configure --help'. |
23636b09 EZ |
220 | Do NOT use the --no-debug option to configure.bat unless you are |
221 | absolutely sure the produced binaries will never need to be run under | |
222 | a debugger. | |
a4a9692d | 223 | |
17d4e22c AI |
224 | N.B. It is normal to see a few error messages output while configure |
225 | is running, when gcc support is being tested. These cannot be | |
a917e3f2 | 226 | suppressed because of limitations in the Windows 9X command.com shell. |
17d4e22c | 227 | |
591cbed1 EZ |
228 | You are encouraged to look at the file config.log which shows details |
229 | for failed tests, after configure.bat finishes. Any unexplained failure | |
230 | should be investigated and perhaps reported as a bug (see the section | |
231 | about reporting bugs in the file README in this directory and in the | |
232 | Emacs manual). | |
233 | ||
bfd889ed JR |
234 | * Optional image library support |
235 | ||
3dfbc6d8 | 236 | In addition to its "native" image formats (pbm and xbm), Emacs can |
8bc63b1a | 237 | handle other image types: xpm, tiff, gif, png, jpeg and experimental |
707a78b2 | 238 | support for svg. |
6d96d18f | 239 | |
8bc63b1a JR |
240 | To build Emacs with support for them, the corresponding headers must |
241 | be in the include path when the configure script is run. This can | |
242 | be setup using environment variables, or by specifying --cflags | |
243 | -I... options on the command-line to configure.bat. The configure | |
244 | script will report whether it was able to detect the headers. If | |
245 | the results of this testing appear to be incorrect, please look for | |
246 | details in the file config.log: it will show the failed test | |
247 | programs and compiler error messages that should explain what is | |
248 | wrong. (Usually, any such failures happen because some headers are | |
249 | missing due to bad packaging of the image support libraries.) | |
bfd889ed | 250 | |
a917e3f2 JB |
251 | Note that any file path passed to the compiler or linker must use |
252 | forward slashes; using backslashes will cause compiler warnings or | |
253 | errors about unrecognized escape sequences. | |
254 | ||
3dfbc6d8 | 255 | To use the external image support, the DLLs implementing the |
bd7bdff8 JB |
256 | functionality must be found when Emacs first needs them, either on the |
257 | PATH, or in the same directory as emacs.exe. Failure to find a | |
258 | library is not an error; the associated image format will simply be | |
259 | unavailable. Note that once Emacs has determined that a library can | |
260 | not be found, there's no way to force it to try again, other than | |
261 | restarting. See the variable `image-library-alist' to configure the | |
262 | expected names of the libraries. | |
3dfbc6d8 JB |
263 | |
264 | Some image libraries have dependencies on one another, or on zlib. | |
265 | For example, tiff support depends on the jpeg library. If you did not | |
266 | compile the libraries yourself, you must make sure that any dependency | |
5739d6f8 | 267 | is in the PATH or otherwise accessible and that the binaries are |
3dfbc6d8 JB |
268 | compatible (for example, that they were built with the same compiler). |
269 | ||
270 | Binaries for the image libraries (among many others) can be found at | |
a74722ee JR |
271 | the GnuWin32 project. PNG, JPEG and TIFF libraries are also |
272 | included with GTK, which is installed along with other Free Software | |
273 | that requires it. These are built with MinGW, but they can be used | |
274 | with both GCC/MinGW and MSVC builds of Emacs. See the info on | |
55fcf5c6 EZ |
275 | http://ourcomments.org/Emacs/w32-build-emacs.html, under "How to Get |
276 | Images Support", for more details about installing image support | |
277 | libraries. Note specifically that, due to some packaging snafus in | |
278 | the GnuWin32-supplied image libraries, you will need to download | |
279 | _source_ packages for some of the libraries in order to get the | |
280 | header files necessary for building Emacs with image support. | |
bfd889ed | 281 | |
a74722ee JR |
282 | If GTK 2.0 is installed, addpm will arrange for its image libraries |
283 | to be on the DLL search path for Emacs. | |
284 | ||
8bc63b1a JR |
285 | * Experimental SVG support |
286 | ||
287 | SVG support is currently experimental, and not built by default. | |
288 | Specify --with-svg and ensure you have all the dependencies in your | |
1640b452 | 289 | include path. Unless you have built a minimalist librsvg yourself |
8bc63b1a | 290 | (untested), librsvg depends on a significant chunk of GTK+ to build, |
1640b452 | 291 | plus a few Gnome libraries, libxml2, libbz2 and zlib at runtime. The |
8bc63b1a JR |
292 | easiest way to obtain the dependencies required for building is to |
293 | download a pre-bundled GTK+ development environment for Windows. | |
294 | GTK puts its header files all over the place, so you will need to | |
295 | run pkgconfig to list the include path you will need (either passed | |
296 | to configure.bat as --cflags options, or set in the environment). | |
297 | ||
298 | To use librsvg at runtime, ensure that librsvg and its dependencies | |
299 | are on your PATH. If you didn't build librsvg yourself, you will | |
300 | need to check with where you downloaded it from for the | |
301 | dependencies, as there are different build options. If it is a | |
302 | short list, then it most likely only lists the immediate | |
303 | dependencies of librsvg, but the dependencies themselves have | |
304 | dependencies - so don't download individual libraries from GTK+, | |
1640b452 | 305 | download and install the whole thing. If you think you've got all |
8bc63b1a JR |
306 | the dependencies and SVG support is still not working, check your |
307 | PATH for other libraries that shadow the ones you downloaded. | |
308 | Libraries of the same name from different sources may not be | |
309 | compatible, this problem was encountered with libbzip2 from GnuWin32 | |
310 | with libcroco from gnome.org. | |
311 | ||
312 | If you can see etc/images/splash.svg, then you have managed to get | |
313 | SVG support working. Congratulations for making it through DLL hell | |
1640b452 | 314 | to this point. You'll probably find that some SVG images crash |
8bc63b1a JR |
315 | Emacs. Problems have been observed in some images that contain |
316 | text, they seem to be a problem in the Windows port of Pango, or | |
317 | maybe a problem with the way Cairo or librsvg is using it that | |
318 | doesn't show up on other platforms. | |
319 | ||
6d76a603 | 320 | * Building |
a4a9692d | 321 | |
da179dd0 AI |
322 | After running configure, simply run the appropriate `make' program for |
323 | your compiler to build Emacs. For MSVC, this is nmake; for GCC, it is | |
ee6f37f2 | 324 | GNU make. (If you are building out of Bazaar, say "make bootstrap" or |
0939da72 | 325 | "nmake bootstrap" instead.) |
a4a9692d | 326 | |
da179dd0 AI |
327 | As the files are compiled, you will see some warning messages |
328 | declaring that some functions don't return a value, or that some data | |
329 | conversions will be lossy, etc. You can safely ignore these messages. | |
330 | The warnings may be fixed in the main FSF source at some point, but | |
331 | until then we will just live with them. | |
a4a9692d | 332 | |
e84b63f1 EZ |
333 | With GNU Make, you can use the -j command-line option to have Make |
334 | execute several commands at once, like this: | |
335 | ||
336 | gmake -j 4 XMFLAGS="-j 3" | |
337 | ||
338 | The XMFLAGS variable overrides the default behavior of GNU Make on | |
339 | Windows, whereby recursive Make invocations reset the maximum number | |
340 | of simultaneous commands to 1. The above command allows up to 4 | |
341 | simultaneous commands at once in the top-level Make, and up to 3 in | |
342 | each one of the recursive Make's; you can use other numbers of jobs, | |
343 | if you wish. | |
344 | ||
ee6f37f2 KF |
345 | If you are building from Bazaar, the following commands will produce |
346 | the Info manuals (which are not part of the Bazaar sources): | |
0939da72 EZ |
347 | |
348 | make info | |
349 | or | |
350 | nmake info | |
351 | ||
c6911ab9 EZ |
352 | Note that you will need makeinfo.exe (from the GNU Texinfo package) |
353 | in order for this command to succeed. | |
354 | ||
6d76a603 | 355 | * Installing |
a4a9692d | 356 | |
0fc7be80 EZ |
357 | To install Emacs after it has compiled, simply run `nmake install' |
358 | or `make install', depending on which version of the Make utility | |
359 | do you have. | |
a4a9692d | 360 | |
da179dd0 AI |
361 | By default, Emacs will be installed in the location where it was |
362 | built, but a different location can be specified either using the | |
363 | --prefix option to configure, or by setting INSTALL_DIR when running | |
364 | make, like so: | |
a4a9692d | 365 | |
da179dd0 | 366 | make install INSTALL_DIR=D:/emacs |
a4a9692d | 367 | |
0fc7be80 EZ |
368 | (for `nmake', type "nmake install INSTALL_DIR=D:/emacs" instead). |
369 | ||
da179dd0 AI |
370 | The install process will run addpm to setup the registry entries, and |
371 | to create a Start menu icon for Emacs. | |
a4a9692d | 372 | |
5739d6f8 JR |
373 | * Make targets |
374 | ||
375 | The following make targets may be used by users building the source | |
ee6f37f2 | 376 | distribution, or users who have checked out of Bazaar after |
5739d6f8 JR |
377 | an initial bootstrapping. |
378 | ||
379 | make | |
380 | Builds Emacs from the available sources and pre-compiled lisp files. | |
381 | ||
382 | make install | |
383 | Installs programs to the bin directory, and runs addpm to create | |
384 | Start Menu icons. | |
385 | ||
386 | make clean | |
387 | Removes object and executable files produced by the build process in | |
388 | the current configuration. After make clean, you can rebuild with | |
389 | the same configuration using make. | |
390 | ||
391 | make distclean | |
392 | In addition to the files removed by make clean, this also removes | |
393 | Makefiles and other generated files to get back to the state of a | |
1640b452 | 394 | freshly unpacked source distribution. Note that this will not remove |
5739d6f8 JR |
395 | installed files, or the results of builds performed with different |
396 | compiler or optimization options than the current configuration. | |
397 | After make distclean, it is necessary to run configure.bat followed | |
398 | by make to rebuild. | |
399 | ||
400 | make cleanall | |
401 | Removes object and executable files that may have been created by | |
402 | previous builds with different configure options, in addition to | |
403 | the files produced by the current configuration. | |
404 | ||
405 | make realclean | |
406 | Removes the installed files in the bin subdirectory in addition to | |
407 | the files removed by make cleanall. | |
408 | ||
e3aef5c6 CS |
409 | make dist |
410 | Builds Emacs from the available sources and pre-compiled lisp files. | |
411 | Packages Emacs binaries as full distribution and barebin distribution. | |
5739d6f8 | 412 | |
ee6f37f2 | 413 | The following targets are intended only for use with the Bazaar sources. |
5739d6f8 JR |
414 | |
415 | make bootstrap | |
416 | Creates a temporary emacs binary with lisp source files and | |
417 | uses it to compile the lisp files. Once the lisp files are built, | |
418 | emacs is redumped with the compiled lisp. | |
419 | ||
420 | make recompile | |
ee6f37f2 | 421 | Recompiles any changed lisp files after an update. This saves |
5739d6f8 JR |
422 | doing a full bootstrap after every update. If this or a subsequent |
423 | make fail, you probably need to perform a full bootstrap, though | |
424 | running this target multiple times may eventually sort out the | |
425 | interdependencies. | |
426 | ||
427 | make maintainer-clean | |
428 | Removes everything that can be recreated, including compiled lisp | |
ee6f37f2 | 429 | files, to get back to the state of a fresh Bazaar tree. After make |
5739d6f8 JR |
430 | maintainer-clean, it is necessary to run configure.bat and make |
431 | bootstrap to rebuild. Occasionally it may be necessary to run this | |
ee6f37f2 | 432 | target after an update. |
5739d6f8 | 433 | |
e3aef5c6 CS |
434 | * Creating binary distributions |
435 | ||
436 | Binary distributions (full and barebin distributions) can be | |
437 | automatically built and packaged from source tarballs or a bzr | |
438 | checkout. | |
439 | ||
440 | When building Emacs binary distributions, the --distfiles argument | |
441 | to configure.bat specifies files to be included in the bin directory | |
442 | of the binary distributions. This is intended for libraries that are | |
443 | not built as part of Emacs, e.g. image libraries. | |
444 | ||
445 | For example, specifying | |
446 | ||
447 | --distfiles D:\distfiles\libXpm.dll | |
448 | ||
449 | results in libXpm.dll being copied from D:\distfiles to the | |
450 | bin directory before packaging starts. | |
451 | ||
452 | Multiple files can be specified using multiple --distfiles arguments: | |
453 | ||
454 | --distfiles D:\distfiles\libXpm.dll --distfiles C:\jpeglib\jpeg.dll | |
455 | ||
456 | For packaging the binary distributions, the 'dist' make target uses | |
457 | 7-Zip (http://www.7-zip.org), which must be installed and available | |
458 | on the Windows Path. | |
459 | ||
5739d6f8 | 460 | |
6d76a603 | 461 | * Trouble-shooting |
a4a9692d | 462 | |
da179dd0 | 463 | The main problems that are likely to be encountered when building |
bd7bdff8 | 464 | Emacs stem from using an old version of GCC, or old MinGW or W32 API |
a917e3f2 | 465 | headers. Additionally, Cygwin ports of GNU make may require the Emacs |
da179dd0 AI |
466 | source tree to be mounted with text!=binary, because the makefiles |
467 | generated by configure.bat necessarily use DOS line endings. Also, | |
a917e3f2 | 468 | Cygwin ports of make must run in UNIX mode, either by specifying |
da179dd0 | 469 | --unix on the command line, or MAKE_MODE=UNIX in the environment. |
a4a9692d | 470 | |
da179dd0 AI |
471 | When configure runs, it attempts to detect when GCC itself, or the |
472 | headers it is using, are not suitable for building Emacs. GCC version | |
473 | 2.95 or later is needed, because that is when the Windows port gained | |
474 | sufficient support for anonymous structs and unions to cope with some | |
a25fe288 JR |
475 | definitions from winnt.h that are used by addsection.c. |
476 | Older versions of the W32 API headers that come with Cygwin and MinGW | |
477 | may be missing some definitions required by Emacs, or broken in other | |
4a00b4b3 | 478 | ways. In particular, uniscribe APIs were added to MinGW CVS only on |
a25fe288 | 479 | 2006-03-26, so releases from before then cannot be used. |
a4a9692d | 480 | |
591cbed1 EZ |
481 | When in doubt about correctness of what configure did, look at the file |
482 | config.log, which shows all the failed test programs and compiler | |
483 | messages associated with the failures. If that doesn't give a clue, | |
484 | please report the problems, together with the relevant fragments from | |
485 | config.log, as bugs. | |
486 | ||
4bcec9a2 EZ |
487 | If configure succeeds, but make fails, install the Cygwin port of |
488 | Bash, even if the table above indicates that Emacs should be able to | |
489 | build without sh.exe. (Some versions of Windows shells are too dumb | |
490 | for Makefile's used by Emacs.) | |
491 | ||
8481e41e | 492 | If you are using certain Cygwin builds of GCC, such as Cygwin version |
6d76a603 AI |
493 | 1.1.8, you may need to specify some extra compiler flags like so: |
494 | ||
495 | configure --with-gcc --cflags -mwin32 --cflags -D__MSVCRT__ | |
315746cc | 496 | --ldflags -mwin32 |
6d76a603 | 497 | |
8481e41e EZ |
498 | However, the latest Cygwin versions, such as 1.3.3, don't need those |
499 | switches; you can simply use "configure --with-gcc". | |
500 | ||
6d76a603 AI |
501 | We will attempt to auto-detect the need for these flags in a future |
502 | release. | |
503 | ||
504 | * Debugging | |
a4a9692d | 505 | |
da179dd0 AI |
506 | You should be able to debug Emacs using the debugger that is |
507 | appropriate for the compiler you used, namely DevStudio or Windbg if | |
23636b09 EZ |
508 | compiled with MSVC, or GDB if compiled with GCC. (GDB for Windows |
509 | is available from the MinGW site, http://www.mingw.org/download.shtml.) | |
3a817827 EZ |
510 | |
511 | When Emacs aborts due to a fatal internal error, Emacs on Windows | |
512 | pops up an Emacs Abort Dialog asking you whether you want to debug | |
513 | Emacs or terminate it. If Emacs was built with MSVC, click YES | |
514 | twice, and Windbg or the DevStudio debugger will start up | |
515 | automatically. If Emacs was built with GCC, first start GDB and | |
516 | attach it to the Emacs process with the "gdb -p EMACS-PID" command, | |
517 | where EMACS-PID is the Emacs process ID (which you can see in the | |
518 | Windows Task Manager), type the "continue" command inside GDB, and | |
519 | only then click YES on the abort dialog. This will pass control to | |
520 | the debugger, and you will be able to debug the cause of the fatal | |
521 | error. | |
da179dd0 AI |
522 | |
523 | Emacs functions implemented in C use a naming convention that reflects | |
524 | their names in lisp. The names of the C routines are the lisp names | |
525 | prefixed with 'F', and with dashes converted to underscores. For | |
526 | example, the function call-process is implemented in C by | |
527 | Fcall_process. Similarly, lisp variables are prefixed with 'V', again | |
528 | with dashes converted to underscores. These conventions enable you to | |
529 | easily set breakpoints or examine familiar lisp variables by name. | |
530 | ||
531 | Since Emacs data is often in the form of a lisp object, and the | |
3a817827 EZ |
532 | Lisp_Object type is difficult to examine manually in a debugger, |
533 | Emacs provides a helper routine called debug_print that prints out a | |
534 | readable representation of a Lisp_Object. If you are using GDB, | |
535 | there is a .gdbinit file in the src directory which provides | |
536 | definitions that are useful for examining lisp objects. Therefore, | |
537 | the following tips are mainly of interest when using MSVC. | |
538 | ||
539 | The output from debug_print is sent to stderr, and to the debugger | |
540 | via the OutputDebugString routine. The output sent to stderr should | |
541 | be displayed in the console window that was opened when the | |
542 | emacs.exe executable was started. The output sent to the debugger | |
543 | should be displayed in its "Debug" output window. | |
da179dd0 AI |
544 | |
545 | When you are in the process of debugging Emacs and you would like to | |
5739d6f8 | 546 | examine the contents of a Lisp_Object variable, pop up the QuickWatch |
da179dd0 AI |
547 | window (QuickWatch has an eyeglass symbol on its button in the |
548 | toolbar). In the text field at the top of the window, enter | |
549 | debug_print(<variable>) and hit return. For example, start and run | |
550 | Emacs in the debugger until it is waiting for user input. Then click | |
551 | on the Break button in the debugger to halt execution. Emacs should | |
552 | halt in ZwUserGetMessage waiting for an input event. Use the Call | |
553 | Stack window to select the procedure w32_msp_pump up the call stack | |
554 | (see below for why you have to do this). Open the QuickWatch window | |
555 | and enter debug_print(Vexec_path). Evaluating this expression will | |
556 | then print out the contents of the lisp variable exec-path. | |
557 | ||
558 | If QuickWatch reports that the symbol is unknown, then check the call | |
559 | stack in the Call Stack window. If the selected frame in the call | |
560 | stack is not an Emacs procedure, then the debugger won't recognize | |
561 | Emacs symbols. Instead, select a frame that is inside an Emacs | |
562 | procedure and try using debug_print again. | |
563 | ||
564 | If QuickWatch invokes debug_print but nothing happens, then check the | |
565 | thread that is selected in the debugger. If the selected thread is | |
566 | not the last thread to run (the "current" thread), then it cannot be | |
567 | used to execute debug_print. Use the Debug menu to select the current | |
568 | thread and try using debug_print again. Note that the debugger halts | |
569 | execution (e.g., due to a breakpoint) in the context of the current | |
570 | thread, so this should only be a problem if you've explicitly switched | |
571 | threads. | |
4b994b84 | 572 | |
7f6d64f8 GM |
573 | \f |
574 | This file is part of GNU Emacs. | |
4b994b84 | 575 | |
eef0be9e | 576 | GNU Emacs is free software: you can redistribute it and/or modify |
7f6d64f8 | 577 | it under the terms of the GNU General Public License as published by |
eef0be9e GM |
578 | the Free Software Foundation, either version 3 of the License, or |
579 | (at your option) any later version. | |
4b994b84 | 580 | |
7f6d64f8 GM |
581 | GNU Emacs is distributed in the hope that it will be useful, |
582 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
583 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
584 | GNU General Public License for more details. | |
585 | ||
586 | You should have received a copy of the GNU General Public License | |
eef0be9e | 587 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |