nt/INSTALL

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