*** empty log message ***
[emacs.git] / nt / INSTALL
bloba96f182452c02d6db4ba11914d85d22387e58179
1                       Building and Installing Emacs
2                 on Windows NT/2K/XP and Windows 95/98/ME
4   Copyright (c) 2001,2004 Free Software Foundation, Inc.
5   See the end of the file for copying permissions.
7   If you used WinZip to unpack the distribution, we suggest to
8   remove the files and unpack again with a different program!
9   WinZip is known to create some subtle and hard to debug problems,
10   such as converting files to DOS CR-LF format, not creating empty
11   directories, etc.  We suggest to use djtarnt.exe from the GNU FTP
12   site.
14   If you are building out of CVS, then some files in this directory
15   (.bat files, nmake.defs and makefile.w32-in) may need the line-ends
16   fixing first. The easiest way to do this and avoid future conflicts
17   is to run the following command in this (emacs/nt) directory:
18      cvs update -kb
19   In addition to this file, you should also read INSTALL.CVS in the
20   parent directory, and make sure that you have a version of "touch.exe"
21   in your path, and that it will create files that do not yet exist.
23   To compile Emacs, you will need either Microsoft Visual C++ 2.0 or
24   later and nmake, or a Windows port of GCC 2.95 or later with Mingw
25   and W32 API support and a port of GNU make.  You can use the Cygwin
26   ports of GCC, but Emacs requires the Mingw headers and libraries to
27   build (latest versions of the Cygwin toolkit, at least since v1.3.3,
28   include the MinGW headers and libraries as an integral part).
30   Other compilers may work, but specific reports from people that have
31   tried suggest that the Intel C compiler (for example) may produce an
32   Emacs executable with strange filename completion behaviour.  Unless
33   you would like to assist by finding and fixing the cause of any bugs
34   like this, we recommend the use of the supported compilers mentioned
35   in the previous paragraph.
37   You will also need a copy of the Posix cp, rm and mv programs. These
38   and other useful Posix utilities can be obtained from the Mingw or
39   Cygwin projects.
41   If you build Emacs on Windows 9X or ME, not on Windows 2K/XP or
42   Windows NT, we suggest to install the Cygwin port of Bash.
44   Please see http://www.mingw.org for pointers to GCC/Mingw and binaries.
46   For reference, here is a list of which builds of GNU make are known
47   to work or not, and whether they work in the presence and/or absence
48   of sh.exe, the Cygwin port of Bash. Note that any version of make
49   that is compiled with Cygwin will only work with Cygwin tools, due to
50   the use of cygwin style paths. This means Cygwin make is unsuitable
51   for building parts of Emacs that need to invoke Emacs itself (leim and
52   "make bootstrap", for example). Also see the Trouble-shooting section
53   below if you decide to go ahead and use Cygwin make.
55   In addition, using 4NT as your shell is known to fail the build process,
56   at least for 4NT version 3.01.  Use cmd.exe, the default NT shell,
57   instead. MSYS sh.exe also appears to cause various problems. If you have
58   MSYS installed, try "make SHELL=cmd.exe" to force the use of cmd.exe
59   instead of sh.exe.
61                                          sh exists     no sh
63     cygwin b20.1 make (3.75):            fails[1, 5]   fails[2, 5]
64     MSVC compiled gmake 3.77:            okay          okay
65     MSVC compiled gmake 3.78.1:          okay          okay
66     MSVC compiled gmake 3.79.1:          okay          okay
67     mingw32/gcc-2.92.2 make (3.77):      okay          okay[4]
68     cygwin compiled gmake 3.77:          fails[1, 5]   fails[2, 5]
69     cygwin compiled make 3.78.1:         fails[5]      fails[2, 5]
70     cygwin compiled make 3.79.1:         fails[3, 5]   fails[2?, 5]
71     mingw32 compiled make 3.79.1:        okay          okay
73   Notes:
75     [1] doesn't cope with makefiles with DOS line endings, so must mount
76         emacs source with text!=binary.
77     [2] fails when needs to invoke shell commands; okay invoking gcc etc.
78     [3] requires LC_MESSAGES support to build; cannot build with early
79         versions of cygwin.
80     [4] may fail on Windows 9X and Windows ME; if so, install Bash.
81     [5] fails when building leim due to the use of cygwin style paths.
82         May work if building emacs without leim.
84 * Configuring
86   Configuration of Emacs is now handled by running configure.bat in the
87   nt subdirectory.  It will detect which compiler you have available,
88   and generate makefiles accordingly.  You can override the compiler
89   detection, and control optimization and debug settings, by specifying
90   options on the command line when invoking configure.
92   To configure Emacs to build with GCC or MSVC, whichever is available,
93   simply change to the nt subdirectory and run `configure' with no
94   options.  To see what options are available, run `configure --help'.
96   N.B.  It is normal to see a few error messages output while configure
97   is running, when gcc support is being tested.  These cannot be
98   surpressed because of limitations in the Windows 9x command.com shell.
100 * Optional image library support
102   In addition to its "native" image formats (pbm and xbm), Emacs can
103   handle other image types: xpm, tiff, gif, png and jpeg (postscript is
104   currently unsupported on Windows).  To build Emacs with support for
105   them, the corresponding headers must be in the include path when the
106   configure script is run.  This can be setup using environment
107   variables, or by specifying --cflags -I... options on the command-line
108   to configure.bat.  The configure script will report whether it was
109   able to detect the headers.
111   To use the external image support, the DLLs implementing the
112   functionality must be found when Emacs is started, either on the PATH,
113   or in the same directory as emacs.exe.  Failure to find a library is
114   not an error; the associated image format will simply be unavailable.
116   Some image libraries have dependencies on one another, or on zlib.
117   For example, tiff support depends on the jpeg library.  If you did not
118   compile the libraries yourself, you must make sure that any dependency
119   is in the PATH or otherwise accesible and that the binaries are
120   compatible (for example, that they were built with the same compiler).
122   Binaries for the image libraries (among many others) can be found at
123   GnuWin32 (http://gnuwin32.sourceforge.net).  These are built with
124   MinGW, and so are very compatible with GCC/MinGW builds of Emacs (like
125   the official binary tarballs for Windows).  Compatibility with MSVC,
126   on the other hand, is still weak and should not be trusted in
127   production environments; if you really need an MSVC-compiled Emacs
128   with image support, you should try to build the required libraries
129   with the same compiler (though it can be extremely non-trivial, and
130   we'll be interested on hearing of any such effort).
132 * Building
134   After running configure, simply run the appropriate `make' program for
135   your compiler to build Emacs.  For MSVC, this is nmake; for GCC, it is
136   GNU make.
138   As the files are compiled, you will see some warning messages
139   declaring that some functions don't return a value, or that some data
140   conversions will be lossy, etc.  You can safely ignore these messages.
141   The warnings may be fixed in the main FSF source at some point, but
142   until then we will just live with them.
144 * Installing
146   To install Emacs after it has compiled, simply run `nmake install'
147   or `make install', depending on which version of the Make utility
148   do you have.
150   By default, Emacs will be installed in the location where it was
151   built, but a different location can be specified either using the
152   --prefix option to configure, or by setting INSTALL_DIR when running
153   make, like so:
155      make install INSTALL_DIR=D:/emacs
157   (for `nmake', type "nmake install INSTALL_DIR=D:/emacs" instead).
159   The install process will run addpm to setup the registry entries, and
160   to create a Start menu icon for Emacs.
162 * Trouble-shooting
164   The main problems that are likely to be encountered when building
165   Emacs stem from using an old version of GCC, or old Mingw or W32 API
166   headers.  Additionally, cygwin ports of GNU make may require the Emacs
167   source tree to be mounted with text!=binary, because the makefiles
168   generated by configure.bat necessarily use DOS line endings.  Also,
169   cygwin ports of make must run in UNIX mode, either by specifying
170   --unix on the command line, or MAKE_MODE=UNIX in the environment.
172   When configure runs, it attempts to detect when GCC itself, or the
173   headers it is using, are not suitable for building Emacs.  GCC version
174   2.95 or later is needed, because that is when the Windows port gained
175   sufficient support for anonymous structs and unions to cope with some
176   definitions from winnt.h that are used by addsection.c.  The W32 API
177   headers that come with Cygwin b20.1 are incomplete, and do not include
178   some definitions required by addsection.c, for instance.  Also, older
179   releases of the W32 API headers from Anders Norlander contain a typo
180   in the definition of IMAGE_FIRST_SECTION in winnt.h, which
181   addsection.c relies on.  Versions of w32api-xxx.zip from at least
182   1999-11-18 onwards are okay.
184   If configure succeeds, but make fails, install the Cygwin port of
185   Bash, even if the table above indicates that Emacs should be able to
186   build without sh.exe.  (Some versions of Windows shells are too dumb
187   for Makefile's used by Emacs.)
189   If you are using certain Cygwin builds of GCC, such as Cygwin version
190   1.1.8, you may need to specify some extra compiler flags like so:
192     configure --with-gcc --cflags -mwin32 --cflags -D__MSVCRT__
193       --ldflags -mwin32
195   However, the latest Cygwin versions, such as 1.3.3, don't need those
196   switches; you can simply use "configure --with-gcc".
198   We will attempt to auto-detect the need for these flags in a future
199   release.
201 * Debugging
203   You should be able to debug Emacs using the debugger that is
204   appropriate for the compiler you used, namely DevStudio or Windbg if
205   compiled with MSVC, or gdb if compiled with gcc.
207   Emacs functions implemented in C use a naming convention that reflects
208   their names in lisp.  The names of the C routines are the lisp names
209   prefixed with 'F', and with dashes converted to underscores.  For
210   example, the function call-process is implemented in C by
211   Fcall_process.  Similarly, lisp variables are prefixed with 'V', again
212   with dashes converted to underscores.  These conventions enable you to
213   easily set breakpoints or examine familiar lisp variables by name.
215   Since Emacs data is often in the form of a lisp object, and the
216   Lisp_Object type is difficult to examine manually in the MSVC
217   debugger, Emacs provides a helper routine called debug_print that
218   prints out a readable representation of a Lisp_Object.  (If you are
219   using gdb, there is a .gdbinit file in the src directory which
220   provides definitions that are useful for examining lisp objects.  The
221   following tips are mainly of interest when using MSVC.)  The output
222   from debug_print is sent to stderr, and to the debugger via the
223   OutputDebugString routine.  The output sent to stderr should be
224   displayed in the console window that was opened when the emacs.exe
225   executable was started.  The output sent to the debugger should be
226   displayed in its "Debug" output window.
228   When you are in the process of debugging Emacs and you would like to
229   examine the contents of a Lisp_Object variable, popup the QuickWatch
230   window (QuickWatch has an eyeglass symbol on its button in the
231   toolbar).  In the text field at the top of the window, enter
232   debug_print(<variable>) and hit return.  For example, start and run
233   Emacs in the debugger until it is waiting for user input.  Then click
234   on the Break button in the debugger to halt execution.  Emacs should
235   halt in ZwUserGetMessage waiting for an input event.  Use the Call
236   Stack window to select the procedure w32_msp_pump up the call stack
237   (see below for why you have to do this).  Open the QuickWatch window
238   and enter debug_print(Vexec_path).  Evaluating this expression will
239   then print out the contents of the lisp variable exec-path.
241   If QuickWatch reports that the symbol is unknown, then check the call
242   stack in the Call Stack window.  If the selected frame in the call
243   stack is not an Emacs procedure, then the debugger won't recognize
244   Emacs symbols.  Instead, select a frame that is inside an Emacs
245   procedure and try using debug_print again.
247   If QuickWatch invokes debug_print but nothing happens, then check the
248   thread that is selected in the debugger.  If the selected thread is
249   not the last thread to run (the "current" thread), then it cannot be
250   used to execute debug_print.  Use the Debug menu to select the current
251   thread and try using debug_print again.  Note that the debugger halts
252   execution (e.g., due to a breakpoint) in the context of the current
253   thread, so this should only be a problem if you've explicitly switched
254   threads.
256 COPYING PERMISSIONS
258   Permission is granted to anyone to make or distribute verbatim copies
259   of this document as received, in any medium, provided that the
260   copyright notice and permission notice are preserved,
261   and that the distributor grants the recipient permission
262   for further redistribution as permitted by this notice.
264   Permission is granted to distribute modified versions
265   of this document, or of portions of it,
266   under the above conditions, provided also that they
267   carry prominent notices stating who last changed them,
268   and that any new or changed statements about the activities
269   of the Free Software Foundation are approved by the Foundation.