|
109485
|
1 Building and Installing Emacs on Windows
|
|
|
2 (from 95 to 7 and beyond)
|
|
25856
|
3
|
|
106815
|
4 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
|
|
69567
|
5 Free Software Foundation, Inc.
|
|
75769
|
6 See the end of the file for license conditions.
|
|
37710
|
7
|
|
69567
|
8 * For the impatient
|
|
|
9
|
|
|
10 Here are the concise instructions for configuring and building the
|
|
76409
|
11 native Windows binary of Emacs, for those who want to skip the
|
|
|
12 complex explanations and ``just do it'':
|
|
69567
|
13
|
|
76419
|
14 Do not use this recipe with Cygwin. For building on Cygwin,
|
|
|
15 use the normal installation instructions, ../INSTALL.
|
|
|
16
|
|
69567
|
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
|
|
76278
|
32 with the Microsoft's Visual C compiler (but see notes about using
|
|
|
33 VC++ 8.0 and later below):
|
|
69567
|
34
|
|
|
35 nmake
|
|
|
36
|
|
|
37 For the development environments based on GNU GCC (MinGW, MSYS,
|
|
72141
|
38 Cygwin - but see notes about Cygwin make below), depending on how
|
|
|
39 Make is called, it could be:
|
|
69567
|
40
|
|
|
41 make
|
|
|
42 or
|
|
72141
|
43 mingw32-make
|
|
|
44 or
|
|
69567
|
45 gnumake
|
|
|
46 or
|
|
|
47 gmake
|
|
|
48
|
|
106653
|
49 (If you are building from Bazaar, say "make bootstrap" or "nmake
|
|
74820
|
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
|
74937
e89aaee63398
Update table of supported Make ports. Show "make -j" command that is known
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
55 gmake -j 2 XMFLAGS="-j 2"
|
|
74820
|
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.
|
|
69567
|
62
|
|
106653
|
63 4. Generate the Info manuals (only if you are building out of Bazaar,
|
|
|
64 and if you have makeinfo.exe installed):
|
|
69567
|
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
|
|
76409
|
81 If you want to build a Cygwin port of Emacs, use the instructions in
|
|
76411
|
82 the INSTALL file in the main Emacs directory (the parent of this
|
|
76409
|
83 directory). These instructions are for building a native Windows
|
|
|
84 binary of Emacs.
|
|
|
85
|
|
39152
|
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,
|
|
49600
|
89 such as converting files to DOS CR-LF format, not creating empty
|
|
39152
|
90 directories, etc. We suggest to use djtarnt.exe from the GNU FTP
|
|
|
91 site.
|
|
|
92
|
|
106653
|
93 In addition to this file, you should also read INSTALL.BZR in the
|
|
63308
|
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.
|
|
52416
|
97
|
|
69567
|
98 * Supported development environments
|
|
|
99
|
76272
ca2c6759e770
Noted where we first mention MSVC 2.0 and later that "or later" stops at 7.0.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
100 To compile Emacs, you will need either Microsoft Visual C++ 2.0, or
|
ca2c6759e770
Noted where we first mention MSVC 2.0 and later that "or later" stops at 7.0.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
101 later up to 7.0, and nmake, or a Windows port of GCC 2.95 or later
|
ca2c6759e770
Noted where we first mention MSVC 2.0 and later that "or later" stops at 7.0.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
102 with MinGW and W32 API support and a port of GNU Make. You can use
|
ca2c6759e770
Noted where we first mention MSVC 2.0 and later that "or later" stops at 7.0.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
103 the Cygwin ports of GCC, but Emacs requires the MinGW headers and
|
ca2c6759e770
Noted where we first mention MSVC 2.0 and later that "or later" stops at 7.0.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
104 libraries to build (latest versions of the Cygwin toolkit, at least
|
ca2c6759e770
Noted where we first mention MSVC 2.0 and later that "or later" stops at 7.0.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
105 since v1.3.3, include the MinGW headers and libraries as an integral
|
ca2c6759e770
Noted where we first mention MSVC 2.0 and later that "or later" stops at 7.0.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
106 part).
|
|
31083
|
107
|
76272
ca2c6759e770
Noted where we first mention MSVC 2.0 and later that "or later" stops at 7.0.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
108 Note that building Emacs with Visual Studio 2005 (VC++ 8.0) is not
|
|
76278
|
109 supported at this time, due to changes introduced by Microsoft into
|
|
|
110 the libraries shipped with the compiler.
|
74937
e89aaee63398
Update table of supported Make ports. Show "make -j" command that is known
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
111
|
|
69567
|
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
|
|
76827
|
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.
|
|
69567
|
119
|
|
67016
|
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
|
106668
75fb4d306cdf
INSTALL: Remove obsolete notes about line endings, and fix some typos.
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
123 or sh.exe, a port of a Unixy shell. For reference, below is a list
|
|
67016
|
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
|
|
102237
|
126 of Bash. Note that any version of Make that is compiled with Cygwin
|
106668
75fb4d306cdf
INSTALL: Remove obsolete notes about line endings, and fix some typos.
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
127 will only work with Cygwin tools, due to the use of Cygwin style
|
|
67016
|
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.
|
|
|
132
|
|
102237
|
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.
|
|
67016
|
138
|
|
|
139 sh exists no sh
|
|
|
140
|
|
|
141 cygwin b20.1 make (3.75): fails[1, 5] fails[2, 5]
|
|
|
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
|
|
|
145 mingw32/gcc-2.92.2 make (3.77): okay okay[4]
|
|
|
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]
|
|
77644
|
149 cygwin compiled make 3.80: okay[6] fails?[7]
|
|
|
150 cygwin compiled make 3.81: fails fails?[7]
|
|
67016
|
151 mingw32 compiled make 3.79.1: okay okay
|
|
77644
|
152 mingw32 compiled make 3.80: okay okay[7]
|
|
|
153 mingw32 compiled make 3.81: okay okay[8]
|
|
67016
|
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.
|
|
|
160 [3] requires LC_MESSAGES support to build; cannot build with early
|
|
109485
|
161 versions of Cygwin.
|
|
67016
|
162 [4] may fail on Windows 9X and Windows ME; if so, install Bash.
|
|
|
163 [5] fails when building leim due to the use of cygwin style paths.
|
|
|
164 May work if building emacs without leim.
|
|
77644
|
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.
|
|
67016
|
169
|
49871
4f204ad4bdf9
Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
170 Other compilers may work, but specific reports from people that have
|
4f204ad4bdf9
Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
171 tried suggest that the Intel C compiler (for example) may produce an
|
|
93965
|
172 Emacs executable with strange filename completion behavior. Unless
|
49871
4f204ad4bdf9
Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
173 you would like to assist by finding and fixing the cause of any bugs
|
4f204ad4bdf9
Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
174 like this, we recommend the use of the supported compilers mentioned
|
4f204ad4bdf9
Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
175 in the previous paragraph.
|
4f204ad4bdf9
Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
176
|
|
109485
|
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
|
62675
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
179 projects:
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
180
|
|
69567
|
181 * http://gnuwin32.sourceforge.net/ ( GnuWin32 )
|
62675
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
182 * http://www.mingw.org/ ( MinGW )
|
|
62677
|
183 * http://www.cygwin.com/ ( Cygwin )
|
62675
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
184 * http://unxutils.sourceforge.net/ ( UnxUtils )
|
57565
5bab1954e91f
Added note to see INSTALL.CVS, and to make sure touch creates files.
Jason Rumney <jasonr@gnu.org>
diff
changeset
|
185
|
|
109485
|
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.
|
|
35726
|
192
|
62675
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
193 Additional instructions and help for building Emacs on Windows can be
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
194 found at the Emacs Wiki:
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
195
|
|
69567
|
196 http://www.emacswiki.org/cgi-bin/wiki/WThirtyTwoInstallationKit
|
|
25856
|
197
|
|
76278
|
198 and on these URLs:
|
|
63308
|
199
|
|
69567
|
200 http://ourcomments.org/Emacs/w32-build-emacs.html
|
|
76278
|
201 http://derekslager.com/blog/posts/2007/01/emacs-hack-3-compile-emacs-from-cvs-on-windows.ashx
|
|
|
202
|
|
106653
|
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.
|
|
63308
|
208
|
|
35870
|
209 * Configuring
|
|
25856
|
210
|
|
31083
|
211 Configuration of Emacs is now handled by running configure.bat in the
|
|
69567
|
212 `nt' subdirectory. It will detect which compiler you have available,
|
|
31083
|
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.
|
|
25856
|
216
|
|
31083
|
217 To configure Emacs to build with GCC or MSVC, whichever is available,
|
|
69567
|
218 simply change to the `nt' subdirectory and run `configure.bat' with no
|
|
31083
|
219 options. To see what options are available, run `configure --help'.
|
77780
c0c3bc060eb3
Add information about where to find GDB, and warn against --no-debug option
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
220 Do NOT use the --no-debug option to configure.bat unless you are
|
c0c3bc060eb3
Add information about where to find GDB, and warn against --no-debug option
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
221 absolutely sure the produced binaries will never need to be run under
|
c0c3bc060eb3
Add information about where to find GDB, and warn against --no-debug option
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
222 a debugger.
|
|
25856
|
223
|
|
31625
|
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
|
|
109485
|
226 suppressed because of limitations in the Windows 9X command.com shell.
|
|
31625
|
227
|
|
63308
|
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
|
|
49451
|
234 * Optional image library support
|
|
|
235
|
55896
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
236 In addition to its "native" image formats (pbm and xbm), Emacs can
|
|
100849
|
237 handle other image types: xpm, tiff, gif, png, jpeg and experimental
|
|
101038
|
238 support for svg.
|
106668
75fb4d306cdf
INSTALL: Remove obsolete notes about line endings, and fix some typos.
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
239
|
|
100849
|
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.)
|
|
49451
|
250
|
|
109485
|
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
|
55896
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
255 To use the external image support, the DLLs implementing the
|
62675
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
256 functionality must be found when Emacs first needs them, either on the
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
257 PATH, or in the same directory as emacs.exe. Failure to find a
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
258 library is not an error; the associated image format will simply be
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
259 unavailable. Note that once Emacs has determined that a library can
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
260 not be found, there's no way to force it to try again, other than
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
261 restarting. See the variable `image-library-alist' to configure the
|
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
262 expected names of the libraries.
|
55896
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
263
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
264 Some image libraries have dependencies on one another, or on zlib.
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
265 For example, tiff support depends on the jpeg library. If you did not
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
266 compile the libraries yourself, you must make sure that any dependency
|
|
93965
|
267 is in the PATH or otherwise accessible and that the binaries are
|
55896
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
268 compatible (for example, that they were built with the same compiler).
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
269
|
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
270 Binaries for the image libraries (among many others) can be found at
|
|
80108
|
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
|
77754
8ebf54239937
Fix URL of EmacsW32 site where building with image support is described.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
275 http://ourcomments.org/Emacs/w32-build-emacs.html, under "How to Get
|
8ebf54239937
Fix URL of EmacsW32 site where building with image support is described.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
276 Images Support", for more details about installing image support
|
8ebf54239937
Fix URL of EmacsW32 site where building with image support is described.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
277 libraries. Note specifically that, due to some packaging snafus in
|
8ebf54239937
Fix URL of EmacsW32 site where building with image support is described.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
278 the GnuWin32-supplied image libraries, you will need to download
|
8ebf54239937
Fix URL of EmacsW32 site where building with image support is described.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
279 _source_ packages for some of the libraries in order to get the
|
8ebf54239937
Fix URL of EmacsW32 site where building with image support is described.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
280 header files necessary for building Emacs with image support.
|
|
49451
|
281
|
|
80108
|
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
|
|
100849
|
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
|
|
102237
|
289 include path. Unless you have built a minimalist librsvg yourself
|
|
100849
|
290 (untested), librsvg depends on a significant chunk of GTK+ to build,
|
|
102237
|
291 plus a few Gnome libraries, libxml2, libbz2 and zlib at runtime. The
|
|
100849
|
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+,
|
|
102237
|
305 download and install the whole thing. If you think you've got all
|
|
100849
|
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
|
|
102237
|
314 to this point. You'll probably find that some SVG images crash
|
|
100849
|
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
|
|
35870
|
320 * Building
|
|
25856
|
321
|
|
31083
|
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
|
|
106653
|
324 GNU make. (If you are building out of Bazaar, say "make bootstrap" or
|
|
69567
|
325 "nmake bootstrap" instead.)
|
|
25856
|
326
|
|
31083
|
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.
|
|
25856
|
332
|
|
74820
|
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
|
|
106653
|
345 If you are building from Bazaar, the following commands will produce
|
|
|
346 the Info manuals (which are not part of the Bazaar sources):
|
|
69567
|
347
|
|
|
348 make info
|
|
|
349 or
|
|
|
350 nmake info
|
|
|
351
|
|
71548
|
352 Note that you will need makeinfo.exe (from the GNU Texinfo package)
|
|
|
353 in order for this command to succeed.
|
|
|
354
|
|
35870
|
355 * Installing
|
|
25856
|
356
|
|
39144
|
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.
|
|
25856
|
360
|
|
31083
|
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:
|
|
25856
|
365
|
|
31083
|
366 make install INSTALL_DIR=D:/emacs
|
|
25856
|
367
|
|
39144
|
368 (for `nmake', type "nmake install INSTALL_DIR=D:/emacs" instead).
|
|
|
369
|
|
31083
|
370 The install process will run addpm to setup the registry entries, and
|
|
|
371 to create a Start menu icon for Emacs.
|
|
25856
|
372
|
|
93965
|
373 * Make targets
|
|
|
374
|
|
|
375 The following make targets may be used by users building the source
|
|
106653
|
376 distribution, or users who have checked out of Bazaar after
|
|
93965
|
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
|
|
102237
|
394 freshly unpacked source distribution. Note that this will not remove
|
|
93965
|
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
|
|
109507
|
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.
|
|
93965
|
412
|
|
106653
|
413 The following targets are intended only for use with the Bazaar sources.
|
|
93965
|
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
|
|
106653
|
421 Recompiles any changed lisp files after an update. This saves
|
|
93965
|
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
|
|
106653
|
429 files, to get back to the state of a fresh Bazaar tree. After make
|
|
93965
|
430 maintainer-clean, it is necessary to run configure.bat and make
|
|
|
431 bootstrap to rebuild. Occasionally it may be necessary to run this
|
|
106653
|
432 target after an update.
|
|
93965
|
433
|
|
109507
|
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
|
|
93965
|
460
|
|
35870
|
461 * Trouble-shooting
|
|
25856
|
462
|
|
31083
|
463 The main problems that are likely to be encountered when building
|
62675
114ecd5ee47b
Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
diff
changeset
|
464 Emacs stem from using an old version of GCC, or old MinGW or W32 API
|
|
109485
|
465 headers. Additionally, Cygwin ports of GNU make may require the Emacs
|
|
31083
|
466 source tree to be mounted with text!=binary, because the makefiles
|
|
|
467 generated by configure.bat necessarily use DOS line endings. Also,
|
|
109485
|
468 Cygwin ports of make must run in UNIX mode, either by specifying
|
|
31083
|
469 --unix on the command line, or MAKE_MODE=UNIX in the environment.
|
|
25856
|
470
|
|
31083
|
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
|
|
93668
|
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
|
|
93685
|
478 ways. In particular, uniscribe APIs were added to MinGW CVS only on
|
|
93668
|
479 2006-03-26, so releases from before then cannot be used.
|
|
25856
|
480
|
|
63308
|
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
|
|
35726
|
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
|
|
39462
|
492 If you are using certain Cygwin builds of GCC, such as Cygwin version
|
|
35870
|
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__
|
|
36576
|
496 --ldflags -mwin32
|
|
35870
|
497
|
|
39462
|
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
|
|
35870
|
501 We will attempt to auto-detect the need for these flags in a future
|
|
|
502 release.
|
|
|
503
|
|
|
504 * Debugging
|
|
25856
|
505
|
|
31083
|
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
|
77780
c0c3bc060eb3
Add information about where to find GDB, and warn against --no-debug option
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
508 compiled with MSVC, or GDB if compiled with GCC. (GDB for Windows
|
c0c3bc060eb3
Add information about where to find GDB, and warn against --no-debug option
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
509 is available from the MinGW site, http://www.mingw.org/download.shtml.)
|
67437
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
510
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
511 When Emacs aborts due to a fatal internal error, Emacs on Windows
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
512 pops up an Emacs Abort Dialog asking you whether you want to debug
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
513 Emacs or terminate it. If Emacs was built with MSVC, click YES
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
514 twice, and Windbg or the DevStudio debugger will start up
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
515 automatically. If Emacs was built with GCC, first start GDB and
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
516 attach it to the Emacs process with the "gdb -p EMACS-PID" command,
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
517 where EMACS-PID is the Emacs process ID (which you can see in the
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
518 Windows Task Manager), type the "continue" command inside GDB, and
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
519 only then click YES on the abort dialog. This will pass control to
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
520 the debugger, and you will be able to debug the cause of the fatal
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
521 error.
|
|
31083
|
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.
|
|
25856
|
530
|
|
31083
|
531 Since Emacs data is often in the form of a lisp object, and the
|
67437
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
532 Lisp_Object type is difficult to examine manually in a debugger,
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
533 Emacs provides a helper routine called debug_print that prints out a
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
534 readable representation of a Lisp_Object. If you are using GDB,
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
535 there is a .gdbinit file in the src directory which provides
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
536 definitions that are useful for examining lisp objects. Therefore,
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
537 the following tips are mainly of interest when using MSVC.
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
538
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
539 The output from debug_print is sent to stderr, and to the debugger
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
540 via the OutputDebugString routine. The output sent to stderr should
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
541 be displayed in the console window that was opened when the
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
542 emacs.exe executable was started. The output sent to the debugger
|
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
diff
changeset
|
543 should be displayed in its "Debug" output window.
|
|
25856
|
544
|
|
31083
|
545 When you are in the process of debugging Emacs and you would like to
|
|
93965
|
546 examine the contents of a Lisp_Object variable, pop up the QuickWatch
|
|
31083
|
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.
|
|
25856
|
557
|
|
31083
|
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.
|
|
25856
|
563
|
|
31083
|
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.
|
|
37710
|
572
|
|
75769
|
573
|
|
|
574 This file is part of GNU Emacs.
|
|
|
575
|
|
94795
|
576 GNU Emacs is free software: you can redistribute it and/or modify
|
|
75769
|
577 it under the terms of the GNU General Public License as published by
|
|
94795
|
578 the Free Software Foundation, either version 3 of the License, or
|
|
|
579 (at your option) any later version.
|
|
37710
|
580
|
|
75769
|
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.
|
|
37710
|
585
|
|
75769
|
586 You should have received a copy of the GNU General Public License
|
|
94795
|
587 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
