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