annotate nt/INSTALL @ 33132:73ec1ee4f829

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