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