Newer Older
Dave Love's avatar
Dave Love committed
		      Building and Installing Emacs
		on Windows NT/2K/XP and Windows 95/98/ME
Dave Love's avatar
Dave Love committed

  Copyright (c) 2001,2004,2005 Free Software Foundation, Inc.
Andrew Innes's avatar
Andrew Innes committed
5 6
  See the end of the file for copying permissions.

Eli Zaretskii's avatar
Eli Zaretskii committed
7 8 9
  If you used WinZip to unpack the distribution, we suggest to
  remove the files and unpack again with a different program!
  WinZip is known to create some subtle and hard to debug problems,
  such as converting files to DOS CR-LF format, not creating empty
Eli Zaretskii's avatar
Eli Zaretskii committed
11 12 13
  directories, etc.  We suggest to use djtarnt.exe from the GNU FTP

14 15 16 17
  If you are building out of CVS, then some files in this directory
  (.bat files, nmake.defs and makefile.w32-in) may need the line-ends
  fixing first. The easiest way to do this and avoid future conflicts
  is to run the following command in this (emacs/nt) directory:

     cvs update -kb
20 21 22 23 24 25 26 27

  (WARNING: Do NOT use this suggestion if you have write access to the
  Emacs CVS tree and intend to commit changes to CVS.  This is because -kb
  is sticky: it will be used in all future CVS operations on the files you
  check out like this.)  Alternatively, use programs that convert
  end-of-line format, such as dos2unix and unix2dos available from
  GnuWin32 or dtou and utod from the DJGPP project.

  In addition to this file, you should also read INSTALL.CVS in the
29 30 31
  parent directory, and make sure that you have a version of
  "touch.exe" in your path, and that it will create files that do not
  yet exist.

  To compile Emacs, you will need either Microsoft Visual C++ 2.0 or
  later and nmake, or a Windows port of GCC 2.95 or later with MinGW
  and W32 API support and a port of GNU make.  You can use the Cygwin
  ports of GCC, but Emacs requires the MinGW headers and libraries to
37 38
  build (latest versions of the Cygwin toolkit, at least since v1.3.3,
  include the MinGW headers and libraries as an integral part).

40 41 42 43 44 45 46
  Other compilers may work, but specific reports from people that have
  tried suggest that the Intel C compiler (for example) may produce an
  Emacs executable with strange filename completion behaviour.  Unless
  you would like to assist by finding and fixing the cause of any bugs
  like this, we recommend the use of the supported compilers mentioned
  in the previous paragraph.

47 48 49 50 51
  You will also need a copy of the Posix cp, rm and mv programs.  These
  and other useful Posix utilities can be obtained from one of several

  *                         ( MinGW    )
Juanma Barranquero's avatar
Juanma Barranquero committed
  *                        ( Cygwin   )
53 54
  *              ( UnxUtils )
  *              ( GnuWin32 )

  If you build Emacs on Windows 9X or ME, not on Windows 2K/XP or
  Windows NT, we suggest to install the Cygwin port of Bash.

59 60 61 62
  Additional instructions and help for building Emacs on Windows can be
  found at the Emacs Wiki:
Dave Love's avatar
Dave Love committed

64 65 66 67
  and at this URL:

68 69
  For reference, here is a list of which builds of GNU make are known
  to work or not, and whether they work in the presence and/or absence
70 71 72 73 74 75
  of sh.exe, the Cygwin port of Bash. Note that any version of make
  that is compiled with Cygwin will only work with Cygwin tools, due to
  the use of cygwin style paths. This means Cygwin make is unsuitable
  for building parts of Emacs that need to invoke Emacs itself (leim and
  "make bootstrap", for example). Also see the Trouble-shooting section
  below if you decide to go ahead and use Cygwin make.
Eli Zaretskii's avatar
Eli Zaretskii committed
76 77 78

  In addition, using 4NT as your shell is known to fail the build process,
  at least for 4NT version 3.01.  Use cmd.exe, the default NT shell,
Jason Rumney's avatar
Jason Rumney committed
79 80 81
  instead. MSYS sh.exe also appears to cause various problems. If you have
  MSYS installed, try "make SHELL=cmd.exe" to force the use of cmd.exe
  instead of sh.exe.

83 84
                                         sh exists     no sh

    cygwin b20.1 make (3.75):            fails[1, 5]   fails[2, 5]
86 87 88
    MSVC compiled gmake 3.77:            okay          okay
    MSVC compiled gmake 3.78.1:          okay          okay
    MSVC compiled gmake 3.79.1:          okay          okay
    mingw32/gcc-2.92.2 make (3.77):      okay          okay[4]
90 91 92
    cygwin compiled gmake 3.77:          fails[1, 5]   fails[2, 5]
    cygwin compiled make 3.78.1:         fails[5]      fails[2, 5]
    cygwin compiled make 3.79.1:         fails[3, 5]   fails[2?, 5]
    mingw32 compiled make 3.79.1:        okay          okay
    mingw32 compiled make 3.80:          okay          unknown[6]
95 96 97 98 99 100


    [1] doesn't cope with makefiles with DOS line endings, so must mount
        emacs source with text!=binary.
    [2] fails when needs to invoke shell commands; okay invoking gcc etc.
101 102
    [3] requires LC_MESSAGES support to build; cannot build with early
        versions of cygwin.
    [4] may fail on Windows 9X and Windows ME; if so, install Bash.
104 105
    [5] fails when building leim due to the use of cygwin style paths.
        May work if building emacs without leim.
    [6] please report if you try this combination.

* Configuring
Dave Love's avatar
Dave Love committed

110 111 112 113 114
  Configuration of Emacs is now handled by running configure.bat in the
  nt subdirectory.  It will detect which compiler you have available,
  and generate makefiles accordingly.  You can override the compiler
  detection, and control optimization and debug settings, by specifying
  options on the command line when invoking configure.
Dave Love's avatar
Dave Love committed

116 117 118
  To configure Emacs to build with GCC or MSVC, whichever is available,
  simply change to the nt subdirectory and run `configure' with no
  options.  To see what options are available, run `configure --help'.
Dave Love's avatar
Dave Love committed

120 121 122 123
  N.B.  It is normal to see a few error messages output while configure
  is running, when gcc support is being tested.  These cannot be
  surpressed because of limitations in the Windows 9x shell.

124 125 126 127 128 129
  You are encouraged to look at the file config.log which shows details
  for failed tests, after configure.bat finishes.  Any unexplained failure
  should be investigated and perhaps reported as a bug (see the section
  about reporting bugs in the file README in this directory and in the
  Emacs manual).

Jason Rumney's avatar
Jason Rumney committed
130 131
* Optional image library support

132 133 134 135 136 137 138
  In addition to its "native" image formats (pbm and xbm), Emacs can
  handle other image types: xpm, tiff, gif, png and jpeg (postscript is
  currently unsupported on Windows).  To build Emacs with support for
  them, the corresponding headers must be in the include path when the
  configure script is run.  This can be setup using environment
  variables, or by specifying --cflags -I... options on the command-line
  to configure.bat.  The configure script will report whether it was
139 140 141 142 143
  able to detect the headers.  If the results of this testing appear to be
  incorrect, please look for details in the file config.log: it will show
  the failed test programs and compiler error messages that should explain
  what is wrong.  (Usually, any such failures happen because some headers
  are missing due to bad packaging of the image support libraries.)
Jason Rumney's avatar
Jason Rumney committed

  To use the external image support, the DLLs implementing the
146 147 148 149 150 151 152
  functionality must be found when Emacs first needs them, either on the
  PATH, or in the same directory as emacs.exe.  Failure to find a
  library is not an error; the associated image format will simply be
  unavailable.  Note that once Emacs has determined that a library can
  not be found, there's no way to force it to try again, other than
  restarting.  See the variable `image-library-alist' to configure the
  expected names of the libraries.
153 154 155 156 157 158 159 160

  Some image libraries have dependencies on one another, or on zlib.
  For example, tiff support depends on the jpeg library.  If you did not
  compile the libraries yourself, you must make sure that any dependency
  is in the PATH or otherwise accesible and that the binaries are
  compatible (for example, that they were built with the same compiler).

  Binaries for the image libraries (among many others) can be found at
  the GnuWin32 project.  These are built with MinGW, but they can be
162 163 164
  used with both GCC/MinGW and MSVC builds of Emacs.  See the info on for more details about
  installing image support libraries.
Jason Rumney's avatar
Jason Rumney committed

* Building
Dave Love's avatar
Dave Love committed

168 169 170
  After running configure, simply run the appropriate `make' program for
  your compiler to build Emacs.  For MSVC, this is nmake; for GCC, it is
  GNU make.
Dave Love's avatar
Dave Love committed

172 173 174 175 176
  As the files are compiled, you will see some warning messages
  declaring that some functions don't return a value, or that some data
  conversions will be lossy, etc.  You can safely ignore these messages.
  The warnings may be fixed in the main FSF source at some point, but
  until then we will just live with them.
Dave Love's avatar
Dave Love committed

* Installing
Dave Love's avatar
Dave Love committed

180 181 182
  To install Emacs after it has compiled, simply run `nmake install'
  or `make install', depending on which version of the Make utility
  do you have.
Dave Love's avatar
Dave Love committed

184 185 186 187
  By default, Emacs will be installed in the location where it was
  built, but a different location can be specified either using the
  --prefix option to configure, or by setting INSTALL_DIR when running
  make, like so:
Dave Love's avatar
Dave Love committed

     make install INSTALL_DIR=D:/emacs
Dave Love's avatar
Dave Love committed

191 192
  (for `nmake', type "nmake install INSTALL_DIR=D:/emacs" instead).

193 194
  The install process will run addpm to setup the registry entries, and
  to create a Start menu icon for Emacs.
Dave Love's avatar
Dave Love committed

* Trouble-shooting
Dave Love's avatar
Dave Love committed

  The main problems that are likely to be encountered when building
  Emacs stem from using an old version of GCC, or old MinGW or W32 API
200 201 202 203 204
  headers.  Additionally, cygwin ports of GNU make may require the Emacs
  source tree to be mounted with text!=binary, because the makefiles
  generated by configure.bat necessarily use DOS line endings.  Also,
  cygwin ports of make must run in UNIX mode, either by specifying
  --unix on the command line, or MAKE_MODE=UNIX in the environment.
Dave Love's avatar
Dave Love committed

206 207 208 209 210 211 212 213 214 215 216
  When configure runs, it attempts to detect when GCC itself, or the
  headers it is using, are not suitable for building Emacs.  GCC version
  2.95 or later is needed, because that is when the Windows port gained
  sufficient support for anonymous structs and unions to cope with some
  definitions from winnt.h that are used by addsection.c.  The W32 API
  headers that come with Cygwin b20.1 are incomplete, and do not include
  some definitions required by addsection.c, for instance.  Also, older
  releases of the W32 API headers from Anders Norlander contain a typo
  in the definition of IMAGE_FIRST_SECTION in winnt.h, which
  addsection.c relies on.  Versions of from at least
  1999-11-18 onwards are okay.
Dave Love's avatar
Dave Love committed

218 219 220 221 222 223
  When in doubt about correctness of what configure did, look at the file
  config.log, which shows all the failed test programs and compiler
  messages associated with the failures.  If that doesn't give a clue,
  please report the problems, together with the relevant fragments from
  config.log, as bugs.

224 225 226 227 228
  If configure succeeds, but make fails, install the Cygwin port of
  Bash, even if the table above indicates that Emacs should be able to
  build without sh.exe.  (Some versions of Windows shells are too dumb
  for Makefile's used by Emacs.)

  If you are using certain Cygwin builds of GCC, such as Cygwin version
230 231 232
  1.1.8, you may need to specify some extra compiler flags like so:

    configure --with-gcc --cflags -mwin32 --cflags -D__MSVCRT__
      --ldflags -mwin32

235 236 237
  However, the latest Cygwin versions, such as 1.3.3, don't need those
  switches; you can simply use "configure --with-gcc".

238 239 240 241
  We will attempt to auto-detect the need for these flags in a future

* Debugging
Dave Love's avatar
Dave Love committed

243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
  You should be able to debug Emacs using the debugger that is
  appropriate for the compiler you used, namely DevStudio or Windbg if
  compiled with MSVC, or gdb if compiled with gcc.

  Emacs functions implemented in C use a naming convention that reflects
  their names in lisp.  The names of the C routines are the lisp names
  prefixed with 'F', and with dashes converted to underscores.  For
  example, the function call-process is implemented in C by
  Fcall_process.  Similarly, lisp variables are prefixed with 'V', again
  with dashes converted to underscores.  These conventions enable you to
  easily set breakpoints or examine familiar lisp variables by name.

  Since Emacs data is often in the form of a lisp object, and the
  Lisp_Object type is difficult to examine manually in the MSVC
  debugger, Emacs provides a helper routine called debug_print that
  prints out a readable representation of a Lisp_Object.  (If you are
  using gdb, there is a .gdbinit file in the src directory which
  provides definitions that are useful for examining lisp objects.  The
  following tips are mainly of interest when using MSVC.)  The output
  from debug_print is sent to stderr, and to the debugger via the
  OutputDebugString routine.  The output sent to stderr should be
  displayed in the console window that was opened when the emacs.exe
  executable was started.  The output sent to the debugger should be
  displayed in its "Debug" output window.

  When you are in the process of debugging Emacs and you would like to
  examine the contents of a Lisp_Object variable, popup the QuickWatch
  window (QuickWatch has an eyeglass symbol on its button in the
  toolbar).  In the text field at the top of the window, enter
  debug_print(<variable>) and hit return.  For example, start and run
  Emacs in the debugger until it is waiting for user input.  Then click
  on the Break button in the debugger to halt execution.  Emacs should
  halt in ZwUserGetMessage waiting for an input event.  Use the Call
  Stack window to select the procedure w32_msp_pump up the call stack
  (see below for why you have to do this).  Open the QuickWatch window
  and enter debug_print(Vexec_path).  Evaluating this expression will
  then print out the contents of the lisp variable exec-path.

  If QuickWatch reports that the symbol is unknown, then check the call
  stack in the Call Stack window.  If the selected frame in the call
  stack is not an Emacs procedure, then the debugger won't recognize
  Emacs symbols.  Instead, select a frame that is inside an Emacs
  procedure and try using debug_print again.

  If QuickWatch invokes debug_print but nothing happens, then check the
  thread that is selected in the debugger.  If the selected thread is
  not the last thread to run (the "current" thread), then it cannot be
  used to execute debug_print.  Use the Debug menu to select the current
  thread and try using debug_print again.  Note that the debugger halts
  execution (e.g., due to a breakpoint) in the context of the current
  thread, so this should only be a problem if you've explicitly switched
Andrew Innes's avatar
Andrew Innes committed
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309


  Permission is granted to anyone to make or distribute verbatim copies
  of this document as received, in any medium, provided that the
  copyright notice and permission notice are preserved,
  and that the distributor grants the recipient permission
  for further redistribution as permitted by this notice.

  Permission is granted to distribute modified versions
  of this document, or of portions of it,
  under the above conditions, provided also that they
  carry prominent notices stating who last changed them,
  and that any new or changed statements about the activities
  of the Free Software Foundation are approved by the Foundation.