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