nt/INSTALL

   1                       Building and Installing Emacs
   2                 on Windows NT/2000 and Windows 95/98/ME
   3
   4   Copyright (c) 2001 Free Software Foundation, Inc.
   5   See the end of the file for copying permissions.
   6
   7   To compile Emacs, you will need either Microsoft Visual C++ 2.0 or
   8   later and nmake, or a Windows port of GCC 2.95 or later with Mingw
   9   and W32 API support and a port of GNU make.  You can use the Cygwin
  10   ports of GCC, but Emacs requires the Mingw headers and libraries to
  11   build.
  12
  13   If you build Emacs on Windows 9X or ME, not on Windows 2000 or
  14   Windows NT, we suggest to install the Cygwin port of Bash.
  15
  16   Please see http://www.mingw.org for pointers to GCC/Mingw binaries.
  17
  18   For reference, here is a list of which builds of GNU make are known
  19   to work or not, and whether they work in the presence and/or absence
  20   of sh.exe, the Cygwin port of Bash.
  21
  22                                          sh exists     no sh
  23
  24     cygwin b20.1 make (3.75):            okay[1]       fails[2]
  25     MSVC compiled gmake 3.77:            okay          okay
  26     MSVC compiled gmake 3.78.1:          okay          okay
  27     MSVC compiled gmake 3.79.1:          okay          okay
  28     mingw32/gcc-2.92.2 make (3.77):      okay          okay[4]
  29     cygwin compiled gmake 3.77:          okay[1]       fails[2]
  30     cygwin compiled gmake 3.78.1:        okay          fails[2]
  31     cygwin compiled gmake 3.79.1:        couldn't build make[3]
  32
  33   Notes:
  34
  35     [1] doesn't cope with makefiles with DOS line endings, so must mount
  36         emacs source with text!=binary.
  37     [2] fails when needs to invoke shell commands; okay invoking gcc etc.
  38     [3] requires LC_MESSAGES support to build; maybe 2.95.x update to
  39         cygwin provides this?
  40     [4] may fail on Windows 9X and Windows ME; if so, install Bash.
  41
  42 * Configuring
  43
  44   Configuration of Emacs is now handled by running configure.bat in the
  45   nt subdirectory.  It will detect which compiler you have available,
  46   and generate makefiles accordingly.  You can override the compiler
  47   detection, and control optimization and debug settings, by specifying
  48   options on the command line when invoking configure.
  49
  50   To configure Emacs to build with GCC or MSVC, whichever is available,
  51   simply change to the nt subdirectory and run `configure' with no
  52   options.  To see what options are available, run `configure --help'.
  53
  54   N.B.  It is normal to see a few error messages output while configure
  55   is running, when gcc support is being tested.  These cannot be
  56   surpressed because of limitations in the Windows 9x command.com shell.
  57
  58 * Building
  59
  60   After running configure, simply run the appropriate `make' program for
  61   your compiler to build Emacs.  For MSVC, this is nmake; for GCC, it is
  62   GNU make.
  63
  64   As the files are compiled, you will see some warning messages
  65   declaring that some functions don't return a value, or that some data
  66   conversions will be lossy, etc.  You can safely ignore these messages.
  67   The warnings may be fixed in the main FSF source at some point, but
  68   until then we will just live with them.
  69
  70 * Installing
  71
  72   To install Emacs after it has compiled, simply run `make install'.
  73
  74   By default, Emacs will be installed in the location where it was
  75   built, but a different location can be specified either using the
  76   --prefix option to configure, or by setting INSTALL_DIR when running
  77   make, like so:
  78
  79      make install INSTALL_DIR=D:/emacs
  80
  81   The install process will run addpm to setup the registry entries, and
  82   to create a Start menu icon for Emacs.
  83
  84 * Trouble-shooting
  85
  86   The main problems that are likely to be encountered when building
  87   Emacs stem from using an old version of GCC, or old Mingw or W32 API
  88   headers.  Additionally, cygwin ports of GNU make may require the Emacs
  89   source tree to be mounted with text!=binary, because the makefiles
  90   generated by configure.bat necessarily use DOS line endings.  Also,
  91   cygwin ports of make must run in UNIX mode, either by specifying
  92   --unix on the command line, or MAKE_MODE=UNIX in the environment.
  93
  94   When configure runs, it attempts to detect when GCC itself, or the
  95   headers it is using, are not suitable for building Emacs.  GCC version
  96   2.95 or later is needed, because that is when the Windows port gained
  97   sufficient support for anonymous structs and unions to cope with some
  98   definitions from winnt.h that are used by addsection.c.  The W32 API
  99   headers that come with Cygwin b20.1 are incomplete, and do not include
 100   some definitions required by addsection.c, for instance.  Also, older
 101   releases of the W32 API headers from Anders Norlander contain a typo
 102   in the definition of IMAGE_FIRST_SECTION in winnt.h, which
 103   addsection.c relies on.  Versions of w32api-xxx.zip from at least
 104   1999-11-18 onwards are okay.
 105
 106   If configure succeeds, but make fails, install the Cygwin port of
 107   Bash, even if the table above indicates that Emacs should be able to
 108   build without sh.exe.  (Some versions of Windows shells are too dumb
 109   for Makefile's used by Emacs.)
 110
 111   If you are using a recent Cygwin build of GCC, such as Cygwin version
 112   1.1.8, you may need to specify some extra compiler flags like so:
 113
 114     configure --with-gcc --cflags -mwin32 --cflags -D__MSVCRT__
 115       --ldflags -mwin32
 116
 117   We will attempt to auto-detect the need for these flags in a future
 118   release.
 119
 120 * Debugging
 121
 122   You should be able to debug Emacs using the debugger that is
 123   appropriate for the compiler you used, namely DevStudio or Windbg if
 124   compiled with MSVC, or gdb if compiled with gcc.
 125
 126   Emacs functions implemented in C use a naming convention that reflects
 127   their names in lisp.  The names of the C routines are the lisp names
 128   prefixed with 'F', and with dashes converted to underscores.  For
 129   example, the function call-process is implemented in C by
 130   Fcall_process.  Similarly, lisp variables are prefixed with 'V', again
 131   with dashes converted to underscores.  These conventions enable you to
 132   easily set breakpoints or examine familiar lisp variables by name.
 133
 134   Since Emacs data is often in the form of a lisp object, and the
 135   Lisp_Object type is difficult to examine manually in the MSVC
 136   debugger, Emacs provides a helper routine called debug_print that
 137   prints out a readable representation of a Lisp_Object.  (If you are
 138   using gdb, there is a .gdbinit file in the src directory which
 139   provides definitions that are useful for examining lisp objects.  The
 140   following tips are mainly of interest when using MSVC.)  The output
 141   from debug_print is sent to stderr, and to the debugger via the
 142   OutputDebugString routine.  The output sent to stderr should be
 143   displayed in the console window that was opened when the emacs.exe
 144   executable was started.  The output sent to the debugger should be
 145   displayed in its "Debug" output window.
 146
 147   When you are in the process of debugging Emacs and you would like to
 148   examine the contents of a Lisp_Object variable, popup the QuickWatch
 149   window (QuickWatch has an eyeglass symbol on its button in the
 150   toolbar).  In the text field at the top of the window, enter
 151   debug_print(<variable>) and hit return.  For example, start and run
 152   Emacs in the debugger until it is waiting for user input.  Then click
 153   on the Break button in the debugger to halt execution.  Emacs should
 154   halt in ZwUserGetMessage waiting for an input event.  Use the Call
 155   Stack window to select the procedure w32_msp_pump up the call stack
 156   (see below for why you have to do this).  Open the QuickWatch window
 157   and enter debug_print(Vexec_path).  Evaluating this expression will
 158   then print out the contents of the lisp variable exec-path.
 159
 160   If QuickWatch reports that the symbol is unknown, then check the call
 161   stack in the Call Stack window.  If the selected frame in the call
 162   stack is not an Emacs procedure, then the debugger won't recognize
 163   Emacs symbols.  Instead, select a frame that is inside an Emacs
 164   procedure and try using debug_print again.
 165
 166   If QuickWatch invokes debug_print but nothing happens, then check the
 167   thread that is selected in the debugger.  If the selected thread is
 168   not the last thread to run (the "current" thread), then it cannot be
 169   used to execute debug_print.  Use the Debug menu to select the current
 170   thread and try using debug_print again.  Note that the debugger halts
 171   execution (e.g., due to a breakpoint) in the context of the current
 172   thread, so this should only be a problem if you've explicitly switched
 173   threads.
 174
 175 COPYING PERMISSIONS
 176
 177   Permission is granted to anyone to make or distribute verbatim copies
 178   of this document as received, in any medium, provided that the
 179   copyright notice and permission notice are preserved,
 180   and that the distributor grants the recipient permission
 181   for further redistribution as permitted by this notice.
 182
 183   Permission is granted to distribute modified versions
 184   of this document, or of portions of it,
 185   under the above conditions, provided also that they
 186   carry prominent notices stating who last changed them,
 187   and that any new or changed statements about the activities
 188   of the Free Software Foundation are approved by the Foundation.