run-in-thread accepts a new optional argument: nolock.
[emacs.git] / nt / INSTALL
blobda36b4e3390a626dfd63542cbdeb9fc63d075ba9
1                       Building and Installing Emacs
2                 on Windows NT/2K/XP and Windows 95/98/ME
4   Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5     Free Software Foundation, Inc.
6   See the end of the file for license conditions.
8 * For the impatient
10   Here are the concise instructions for configuring and building the
11   native Windows binary of Emacs, for those who want to skip the
12   complex explanations and ``just do it'':
14   Do not use this recipe with Cygwin.  For building on Cygwin,
15   use the normal installation instructions, ../INSTALL.
17   1. Change to the `nt' directory (the directory of this file):
19        cd nt
21   2. Run configure.bat.  From the COMMAND.COM/CMD.EXE command prompt:
23        configure
25      from a Unixy shell prompt:
27        cmd /c configure.bat
28      or
29        command.com /c configure.bat
31   3. Run the Make utility suitable for your environment.  If you build
32      with the Microsoft's Visual C compiler (but see notes about using
33      VC++ 8.0 and later below):
35        nmake
37      For the development environments based on GNU GCC (MinGW, MSYS,
38      Cygwin - but see notes about Cygwin make below), depending on how
39      Make is called, it could be:
41        make
42      or
43        mingw32-make
44      or
45        gnumake
46      or
47        gmake
49      (If you are building from Bazaar, say "make bootstrap" or "nmake
50      bootstrap" instead, and avoid using Cygwin make.)
52      With GNU Make, you can use the -j command-line option to have
53      Make execute several commands at once, like this:
55        gmake -j 2 XMFLAGS="-j 2"
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.
63   4. Generate the Info manuals (only if you are building out of Bazaar,
64      and if you have makeinfo.exe installed):
66      make info
68      (change "make" to "nmake" if you use MSVC).
70   5. Install the produced binaries:
72      make install
74   That's it!
76   If these short instructions somehow fail, read the rest of this
77   file.
79 * Preliminaries
81   If you want to build a Cygwin port of Emacs, use the instructions in
82   the INSTALL file in the main Emacs directory (the parent of this
83   directory).  These instructions are for building a native Windows
84   binary of Emacs.
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,
89   such as converting files to DOS CR-LF format, not creating empty
90   directories, etc.  We suggest to use djtarnt.exe from the GNU FTP
91   site.
93   In addition to this file, you should also read INSTALL.BZR in the
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.
98 * Supported development environments
100   To compile Emacs, you will need either Microsoft Visual C++ 2.0, or
101   later up to 7.0, and nmake, or a Windows port of GCC 2.95 or later
102   with MinGW and W32 API support and a port of GNU Make.  You can use
103   the Cygwin ports of GCC, but Emacs requires the MinGW headers and
104   libraries to build (latest versions of the Cygwin toolkit, at least
105   since v1.3.3, include the MinGW headers and libraries as an integral
106   part).
108   Note that building Emacs with Visual Studio 2005 (VC++ 8.0) is not
109   supported at this time, due to changes introduced by Microsoft into
110   the libraries shipped with the compiler.
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
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.
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
123   or sh.exe, a port of a Unixy shell.  For reference, below is a list
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
126   of Bash.  Note that any version of Make that is compiled with Cygwin
127   will only work with Cygwin tools, due to the use of Cygwin style
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.
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.
139                                          sh exists     no sh
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]
149     cygwin compiled make 3.80:           okay[6]       fails?[7]
150     cygwin compiled make 3.81:           fails         fails?[7]
151     mingw32 compiled make 3.79.1:        okay          okay
152     mingw32 compiled make 3.80:          okay          okay[7]
153     mingw32 compiled make 3.81:          okay          okay[8]
155   Notes:
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
161         versions of cygwin.
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.
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.
170   Other compilers may work, but specific reports from people that have
171   tried suggest that the Intel C compiler (for example) may produce an
172   Emacs executable with strange filename completion behavior.  Unless
173   you would like to assist by finding and fixing the cause of any bugs
174   like this, we recommend the use of the supported compilers mentioned
175   in the previous paragraph.
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
179   projects:
181   * http://gnuwin32.sourceforge.net/              ( GnuWin32 )
182   * http://www.mingw.org/                         ( MinGW    )
183   * http://www.cygwin.com/                        ( Cygwin   )
184   * http://unxutils.sourceforge.net/              ( UnxUtils )
186   If you build Emacs on Windows 9X or ME, not on Windows 2K/XP or
187   Windows NT, we suggest to install the Cygwin port of Bash.  That is
188   because the native Windows shell COMMAND.COM is too limited; the
189   Emacs build procedure tries very hard to support even such limited
190   shells, but as none of the Windows developers of Emacs work on
191   Windows 9x, we cannot guarantee that it works without a more
192   powerful shell.
194   Additional instructions and help for building Emacs on Windows can be
195   found at the Emacs Wiki:
197     http://www.emacswiki.org/cgi-bin/wiki/WThirtyTwoInstallationKit
199   and on these URLs:
201     http://ourcomments.org/Emacs/w32-build-emacs.html
202     http://derekslager.com/blog/posts/2007/01/emacs-hack-3-compile-emacs-from-cvs-on-windows.ashx
204   Both of those pages were written before Emacs switched from CVS to
205   Bazaar, but the parts about building Emacs still apply in Bazaar.
206   The second URL has instructions for building with MSVC, as well as
207   with MinGW, while the first URL covers only MinGW, but has more
208   details about it.
210 * Configuring
212   Configuration of Emacs is now handled by running configure.bat in the
213   `nt' subdirectory.  It will detect which compiler you have available,
214   and generate makefiles accordingly.  You can override the compiler
215   detection, and control optimization and debug settings, by specifying
216   options on the command line when invoking configure.
218   To configure Emacs to build with GCC or MSVC, whichever is available,
219   simply change to the `nt' subdirectory and run `configure.bat' with no
220   options.  To see what options are available, run `configure --help'.
221   Do NOT use the --no-debug option to configure.bat unless you are
222   absolutely sure the produced binaries will never need to be run under
223   a debugger.
225   N.B.  It is normal to see a few error messages output while configure
226   is running, when gcc support is being tested.  These cannot be
227   suppressed because of limitations in the Windows 9x command.com shell.
229   You are encouraged to look at the file config.log which shows details
230   for failed tests, after configure.bat finishes.  Any unexplained failure
231   should be investigated and perhaps reported as a bug (see the section
232   about reporting bugs in the file README in this directory and in the
233   Emacs manual).
235 * Optional image library support
237   In addition to its "native" image formats (pbm and xbm), Emacs can
238   handle other image types: xpm, tiff, gif, png, jpeg and experimental
239   support for svg.
241   To build Emacs with support for them, the corresponding headers must
242   be in the include path when the configure script is run.  This can
243   be setup using environment variables, or by specifying --cflags
244   -I... options on the command-line to configure.bat.  The configure
245   script will report whether it was able to detect the headers.  If
246   the results of this testing appear to be incorrect, please look for
247   details in the file config.log: it will show the failed test
248   programs and compiler error messages that should explain what is
249   wrong.  (Usually, any such failures happen because some headers are
250   missing due to bad packaging of the image support libraries.)
252   To use the external image support, the DLLs implementing the
253   functionality must be found when Emacs first needs them, either on the
254   PATH, or in the same directory as emacs.exe.  Failure to find a
255   library is not an error; the associated image format will simply be
256   unavailable.  Note that once Emacs has determined that a library can
257   not be found, there's no way to force it to try again, other than
258   restarting.  See the variable `image-library-alist' to configure the
259   expected names of the libraries.
261   Some image libraries have dependencies on one another, or on zlib.
262   For example, tiff support depends on the jpeg library.  If you did not
263   compile the libraries yourself, you must make sure that any dependency
264   is in the PATH or otherwise accessible and that the binaries are
265   compatible (for example, that they were built with the same compiler).
267   Binaries for the image libraries (among many others) can be found at
268   the GnuWin32 project.  PNG, JPEG and TIFF libraries are also
269   included with GTK, which is installed along with other Free Software
270   that requires it.  These are built with MinGW, but they can be used
271   with both GCC/MinGW and MSVC builds of Emacs.  See the info on
272   http://ourcomments.org/Emacs/w32-build-emacs.html, under "How to Get
273   Images Support", for more details about installing image support
274   libraries.  Note specifically that, due to some packaging snafus in
275   the GnuWin32-supplied image libraries, you will need to download
276   _source_ packages for some of the libraries in order to get the
277   header files necessary for building Emacs with image support.
279   If GTK 2.0 is installed, addpm will arrange for its image libraries
280   to be on the DLL search path for Emacs.
282 * Experimental SVG support
284   SVG support is currently experimental, and not built by default.
285   Specify --with-svg and ensure you have all the dependencies in your
286   include path.  Unless you have built a minimalist librsvg yourself
287   (untested), librsvg depends on a significant chunk of GTK+ to build,
288   plus a few Gnome libraries, libxml2, libbz2 and zlib at runtime.  The
289   easiest way to obtain the dependencies required for building is to
290   download a pre-bundled GTK+ development environment for Windows.
291   GTK puts its header files all over the place, so you will need to
292   run pkgconfig to list the include path you will need (either passed
293   to configure.bat as --cflags options, or set in the environment).
295   To use librsvg at runtime, ensure that librsvg and its dependencies
296   are on your PATH.  If you didn't build librsvg yourself, you will
297   need to check with where you downloaded it from for the
298   dependencies, as there are different build options.  If it is a
299   short list, then it most likely only lists the immediate
300   dependencies of librsvg, but the dependencies themselves have
301   dependencies - so don't download individual libraries from GTK+,
302   download and install the whole thing.  If you think you've got all
303   the dependencies and SVG support is still not working, check your
304   PATH for other libraries that shadow the ones you downloaded.
305   Libraries of the same name from different sources may not be
306   compatible, this problem was encountered with libbzip2 from GnuWin32
307   with libcroco from gnome.org.
309   If you can see etc/images/splash.svg, then you have managed to get
310   SVG support working.  Congratulations for making it through DLL hell
311   to this point.  You'll probably find that some SVG images crash
312   Emacs.  Problems have been observed in some images that contain
313   text, they seem to be a problem in the Windows port of Pango, or
314   maybe a problem with the way Cairo or librsvg is using it that
315   doesn't show up on other platforms.
317 * Building
319   After running configure, simply run the appropriate `make' program for
320   your compiler to build Emacs.  For MSVC, this is nmake; for GCC, it is
321   GNU make.  (If you are building out of Bazaar, say "make bootstrap" or
322   "nmake bootstrap" instead.)
324   As the files are compiled, you will see some warning messages
325   declaring that some functions don't return a value, or that some data
326   conversions will be lossy, etc.  You can safely ignore these messages.
327   The warnings may be fixed in the main FSF source at some point, but
328   until then we will just live with them.
330   With GNU Make, you can use the -j command-line option to have Make
331   execute several commands at once, like this:
333     gmake -j 4 XMFLAGS="-j 3"
335   The XMFLAGS variable overrides the default behavior of GNU Make on
336   Windows, whereby recursive Make invocations reset the maximum number
337   of simultaneous commands to 1.  The above command allows up to 4
338   simultaneous commands at once in the top-level Make, and up to 3 in
339   each one of the recursive Make's; you can use other numbers of jobs,
340   if you wish.
342   If you are building from Bazaar, the following commands will produce
343   the Info manuals (which are not part of the Bazaar sources):
345     make info
346   or
347     nmake info
349   Note that you will need makeinfo.exe (from the GNU Texinfo package)
350   in order for this command to succeed.
352 * Installing
354   To install Emacs after it has compiled, simply run `nmake install'
355   or `make install', depending on which version of the Make utility
356   do you have.
358   By default, Emacs will be installed in the location where it was
359   built, but a different location can be specified either using the
360   --prefix option to configure, or by setting INSTALL_DIR when running
361   make, like so:
363      make install INSTALL_DIR=D:/emacs
365   (for `nmake', type "nmake install INSTALL_DIR=D:/emacs" instead).
367   The install process will run addpm to setup the registry entries, and
368   to create a Start menu icon for Emacs.
370 * Make targets
372   The following make targets may be used by users building the source
373   distribution, or users who have checked out of Bazaar after
374   an initial bootstrapping.
376   make
377   Builds Emacs from the available sources and pre-compiled lisp files.
379   make install
380   Installs programs to the bin directory, and runs addpm to create
381   Start Menu icons.
383   make clean
384   Removes object and executable files produced by the build process in
385   the current configuration.  After make clean, you can rebuild with
386   the same configuration using make.
388   make distclean
389   In addition to the files removed by make clean, this also removes
390   Makefiles and other generated files to get back to the state of a
391   freshly unpacked source distribution.  Note that this will not remove
392   installed files, or the results of builds performed with different
393   compiler or optimization options than the current configuration.
394   After make distclean, it is necessary to run configure.bat followed
395   by make to rebuild.
397   make cleanall
398   Removes object and executable files that may have been created by
399   previous builds with different configure options, in addition to
400   the files produced by the current configuration.
402   make realclean
403   Removes the installed files in the bin subdirectory in addition to
404   the files removed by make cleanall.
407   The following targets are intended only for use with the Bazaar sources.
409   make bootstrap
410   Creates a temporary emacs binary with lisp source files and
411   uses it to compile the lisp files.  Once the lisp files are built,
412   emacs is redumped with the compiled lisp.
414   make recompile
415   Recompiles any changed lisp files after an update.  This saves
416   doing a full bootstrap after every update.  If this or a subsequent
417   make fail, you probably need to perform a full bootstrap, though
418   running this target multiple times may eventually sort out the
419   interdependencies.
421   make maintainer-clean
422   Removes everything that can be recreated, including compiled lisp
423   files, to get back to the state of a fresh Bazaar tree.  After make
424   maintainer-clean, it is necessary to run configure.bat and make
425   bootstrap to rebuild.  Occasionally it may be necessary to run this
426   target after an update.
429 * Trouble-shooting
431   The main problems that are likely to be encountered when building
432   Emacs stem from using an old version of GCC, or old MinGW or W32 API
433   headers.  Additionally, cygwin ports of GNU make may require the Emacs
434   source tree to be mounted with text!=binary, because the makefiles
435   generated by configure.bat necessarily use DOS line endings.  Also,
436   cygwin ports of make must run in UNIX mode, either by specifying
437   --unix on the command line, or MAKE_MODE=UNIX in the environment.
439   When configure runs, it attempts to detect when GCC itself, or the
440   headers it is using, are not suitable for building Emacs.  GCC version
441   2.95 or later is needed, because that is when the Windows port gained
442   sufficient support for anonymous structs and unions to cope with some
443   definitions from winnt.h that are used by addsection.c.
444   Older versions of the W32 API headers that come with Cygwin and MinGW
445   may be missing some definitions required by Emacs, or broken in other
446   ways.  In particular, uniscribe APIs were added to MinGW CVS only on
447   2006-03-26, so releases from before then cannot be used.
449   When in doubt about correctness of what configure did, look at the file
450   config.log, which shows all the failed test programs and compiler
451   messages associated with the failures.  If that doesn't give a clue,
452   please report the problems, together with the relevant fragments from
453   config.log, as bugs.
455   If configure succeeds, but make fails, install the Cygwin port of
456   Bash, even if the table above indicates that Emacs should be able to
457   build without sh.exe.  (Some versions of Windows shells are too dumb
458   for Makefile's used by Emacs.)
460   If you are using certain Cygwin builds of GCC, such as Cygwin version
461   1.1.8, you may need to specify some extra compiler flags like so:
463     configure --with-gcc --cflags -mwin32 --cflags -D__MSVCRT__
464       --ldflags -mwin32
466   However, the latest Cygwin versions, such as 1.3.3, don't need those
467   switches; you can simply use "configure --with-gcc".
469   We will attempt to auto-detect the need for these flags in a future
470   release.
472 * Debugging
474   You should be able to debug Emacs using the debugger that is
475   appropriate for the compiler you used, namely DevStudio or Windbg if
476   compiled with MSVC, or GDB if compiled with GCC.  (GDB for Windows
477   is available from the MinGW site, http://www.mingw.org/download.shtml.)
479   When Emacs aborts due to a fatal internal error, Emacs on Windows
480   pops up an Emacs Abort Dialog asking you whether you want to debug
481   Emacs or terminate it.  If Emacs was built with MSVC, click YES
482   twice, and Windbg or the DevStudio debugger will start up
483   automatically.  If Emacs was built with GCC, first start GDB and
484   attach it to the Emacs process with the "gdb -p EMACS-PID" command,
485   where EMACS-PID is the Emacs process ID (which you can see in the
486   Windows Task Manager), type the "continue" command inside GDB, and
487   only then click YES on the abort dialog.  This will pass control to
488   the debugger, and you will be able to debug the cause of the fatal
489   error.
491   Emacs functions implemented in C use a naming convention that reflects
492   their names in lisp.  The names of the C routines are the lisp names
493   prefixed with 'F', and with dashes converted to underscores.  For
494   example, the function call-process is implemented in C by
495   Fcall_process.  Similarly, lisp variables are prefixed with 'V', again
496   with dashes converted to underscores.  These conventions enable you to
497   easily set breakpoints or examine familiar lisp variables by name.
499   Since Emacs data is often in the form of a lisp object, and the
500   Lisp_Object type is difficult to examine manually in a debugger,
501   Emacs provides a helper routine called debug_print that prints out a
502   readable representation of a Lisp_Object.  If you are using GDB,
503   there is a .gdbinit file in the src directory which provides
504   definitions that are useful for examining lisp objects.  Therefore,
505   the following tips are mainly of interest when using MSVC.
507   The output from debug_print is sent to stderr, and to the debugger
508   via the OutputDebugString routine.  The output sent to stderr should
509   be displayed in the console window that was opened when the
510   emacs.exe executable was started.  The output sent to the debugger
511   should be displayed in its "Debug" output window.
513   When you are in the process of debugging Emacs and you would like to
514   examine the contents of a Lisp_Object variable, pop up the QuickWatch
515   window (QuickWatch has an eyeglass symbol on its button in the
516   toolbar).  In the text field at the top of the window, enter
517   debug_print(<variable>) and hit return.  For example, start and run
518   Emacs in the debugger until it is waiting for user input.  Then click
519   on the Break button in the debugger to halt execution.  Emacs should
520   halt in ZwUserGetMessage waiting for an input event.  Use the Call
521   Stack window to select the procedure w32_msp_pump up the call stack
522   (see below for why you have to do this).  Open the QuickWatch window
523   and enter debug_print(Vexec_path).  Evaluating this expression will
524   then print out the contents of the lisp variable exec-path.
526   If QuickWatch reports that the symbol is unknown, then check the call
527   stack in the Call Stack window.  If the selected frame in the call
528   stack is not an Emacs procedure, then the debugger won't recognize
529   Emacs symbols.  Instead, select a frame that is inside an Emacs
530   procedure and try using debug_print again.
532   If QuickWatch invokes debug_print but nothing happens, then check the
533   thread that is selected in the debugger.  If the selected thread is
534   not the last thread to run (the "current" thread), then it cannot be
535   used to execute debug_print.  Use the Debug menu to select the current
536   thread and try using debug_print again.  Note that the debugger halts
537   execution (e.g., due to a breakpoint) in the context of the current
538   thread, so this should only be a problem if you've explicitly switched
539   threads.
542 This file is part of GNU Emacs.
544 GNU Emacs is free software: you can redistribute it and/or modify
545 it under the terms of the GNU General Public License as published by
546 the Free Software Foundation, either version 3 of the License, or
547 (at your option) any later version.
549 GNU Emacs is distributed in the hope that it will be useful,
550 but WITHOUT ANY WARRANTY; without even the implied warranty of
551 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
552 GNU General Public License for more details.
554 You should have received a copy of the GNU General Public License
555 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.