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