|
900
|
1 Building and Installing XEmacs on Windows 95/98/NT/2000/XP -*- mode:outline -*-
|
|
428
|
2
|
|
|
3 David Hobley
|
|
442
|
4 Marc Paquette
|
|
|
5 Jonathan Harris
|
|
|
6 Ben Wing
|
|
428
|
7
|
|
900
|
8 This is a port of XEmacs to Windows 95/98/NT/2000/XP. If you are looking for a
|
|
916
|
9 port of GNU Emacs, get the latest release of the 21.x series from gnu.org.
|
|
|
10 (At the time of writing, GNU Emacs does not support images but does support
|
|
|
11 Mule.) NT 4.0 or later is required for building on Windows NT. Note that the
|
|
442
|
12 developers typically use NT 4.0 and Windows 2000, and there may possibly be
|
|
827
|
13 problems under Windows 95/98. If so, please report them to
|
|
442
|
14 xemacs-nt@xemacs.org; we are committed to maintaining compatibility with all
|
|
|
15 systems listed.
|
|
428
|
16
|
|
442
|
17 * Required tools and sources
|
|
|
18 ============================
|
|
|
19
|
|
900
|
20 1. You will need Visual C++ V6.0, Visual Studio .NET or later to compile
|
|
|
21 everything.
|
|
428
|
22
|
|
442
|
23 Note that Visual C++ assumes that the environment variables INCLUDE and
|
|
|
24 LIB are set to specify the location of the includes and libraries.
|
|
827
|
25 Your PATH environment variable also needs to include the Visual Studio
|
|
442
|
26 vc\bin and sharedide\bin directories.
|
|
|
27
|
|
900
|
28 Visual C++ V6.0 installs a batch file called vcvars32.bat in
|
|
812
|
29 c:\Program Files\Microsoft Visual Studio\VC98\bin\ (or wherever you
|
|
|
30 installed it) that you can run before building to set up all of these
|
|
|
31 environment variables. Alternatively, you can choose at setup time to
|
|
|
32 have these environment variables automatically set up in the registry,
|
|
|
33 which is generally a good idea.
|
|
428
|
34
|
|
900
|
35 Visual Studio .NET calls this batch file vsvars32.bat and installs it in
|
|
|
36 $Installdir\Common7\Tools, but doesn't offer at install time to
|
|
|
37 automatically set these environment variables up in the registry.
|
|
442
|
38
|
|
|
39 2. Grab the latest XEmacs source from
|
|
|
40
|
|
|
41 ftp://ftp.xemacs.org/pub/xemacs/
|
|
|
42
|
|
|
43 or one of its mirrors listed at http://www.xemacs.org/Download/index.html.
|
|
|
44
|
|
|
45 (NOTE: If you are behind a firewall and have problems with FTP access,
|
|
|
46 the URL http://ftp.xemacs.org/pub/xemacs/ works just as well.)
|
|
|
47
|
|
|
48 You'll also need the packages. You probably want to get the unified
|
|
|
49 packages bundle from
|
|
|
50
|
|
|
51 ftp://ftp.xemacs.org/pub/xemacs/packages/xemacs-sumo.tar.gz
|
|
|
52
|
|
|
53 If you are building with international support, you also need
|
|
|
54
|
|
|
55 ftp://ftp.xemacs.org/pub/xemacs/packages/xemacs-mule-sumo.tar.gz
|
|
|
56
|
|
|
57 Although we don't recommend it, you can also retrieve just the packages
|
|
|
58 you really need if you have an extremely slow net connection or are very
|
|
|
59 short on disk space. You can find the various packages in
|
|
|
60 ftp://ftp.xemacs.org/pub/xemacs/packages/. You will need the xemacs-base
|
|
|
61 package (and mule-base, if building with international support). You'll
|
|
|
62 also need the texinfo package unless you have a copy of makeinfo.exe on
|
|
|
63 your machine. If you want to download additional or updated packages
|
|
|
64 from within XEmacs you'll need the efs, dired and vm packages. You'll
|
|
|
65 probably also want at least the edit-utils, text-modes, fsf-compat,
|
|
|
66 cc-mode, prog-modes and xemacs-devel packages.
|
|
|
67
|
|
|
68 Unpack the packages into "x:\your\choice\XEmacs\xemacs-packages",
|
|
|
69 for example "c:\Program Files\XEmacs\xemacs-packages".
|
|
|
70
|
|
1330
|
71 3. The native build no longer supports X Windows. There is no point,
|
|
|
72 since the Cygwin build is actively maintained and supports X Windows
|
|
|
73 very well. See the FAQ if you want to build with Cygwin.
|
|
442
|
74
|
|
|
75
|
|
|
76 * Optional libraries
|
|
|
77 ====================
|
|
|
78
|
|
827
|
79 1. You really want the XPM library. Grab the latest version of the xpm
|
|
|
80 sources (xpm-3.4k.tar.gz as of 2002-04-27) from
|
|
|
81 ftp://ftp.xemacs.org/pub/xemacs/aux/ and unpack them somewhere. Copy
|
|
|
82 nt\xpm.mak from the xemacs sources to the lib subdirectory of the xpm
|
|
|
83 sources, cd to that directory and build xpm with 'nmake -f xpm.mak'.
|
|
428
|
84
|
|
827
|
85 2. You probably also want PNG image support. Grab the latest versions of
|
|
|
86 zlib and libpng (zlib-1.1.4 and libpng-1.0.9 as of 2002-04-27) from
|
|
|
87 ftp://ftp.xemacs.org/pub/xemacs/aux/, unpack them somewhere and read the
|
|
|
88 respective READMEs for details on how to build them. The following
|
|
817
|
89 build procedure works for zlib-1.1.4 and libpng-1.0.9:
|
|
428
|
90
|
|
817
|
91 cd to the zlib directory and type 'nmake -f msdos\makefile.w32'.
|
|
428
|
92
|
|
|
93 cd to the libpng directory, rename or move the zlib directory to ..\zlib
|
|
817
|
94 and type 'nmake -f scripts\makefile.vcwin32'.
|
|
428
|
95
|
|
|
96 3. If you want TIFF support, grap the latest version of libtiff (tiff-v3.4
|
|
827
|
97 as of 2002-04-27) from ftp://ftp.xemacs.org/pub/xemacs/aux/ and unpack
|
|
442
|
98 it somewhere. Copy nt\tiff.mak from the xemacs sources to the
|
|
|
99 contrib\winnt subdirectory of the tiff sources, cd to that directory and
|
|
|
100 build libtiff with 'nmake -f tiff.mak'. Note: tiff.mak has only been
|
|
444
|
101 verified to work under WinNT, not Win95 or 98. However, the latest
|
|
827
|
102 distribution of libtiff includes a contrib\win95\makefile.w95; that
|
|
|
103 might work.
|
|
428
|
104
|
|
827
|
105 4. If you want JPEG support grab the latest version of jpegsrc (jpeg-6b as
|
|
|
106 of 2002-04-27) from ftp://ftp.xemacs.org/pub/xemacs/aux/ and read the
|
|
442
|
107 README for details on how to build it.
|
|
428
|
108
|
|
442
|
109 5. If you want X-Face support, grab the compface distribution from
|
|
|
110 ftp://ftp.xemacs.org/pub/xemacs/aux/ and unpack it somewhere.
|
|
|
111 Copy nt\compface.mak from xemacs sources to the compface directory.
|
|
|
112 cd to that directory and build libcompface with 'nmake -f compface.mak'.
|
|
428
|
113
|
|
|
114
|
|
442
|
115 * Building
|
|
|
116 ==========
|
|
|
117
|
|
|
118 1. cd to the nt subdirectory of the xemacs distribution and copy the file
|
|
|
119 config.inc.samp to config.inc. Make any necessary modifications. This
|
|
|
120 file controls the options that XEmacs is built with:
|
|
|
121
|
|
|
122 -- If you want international (aka "Mule") support, modify the appropriate
|
|
|
123 line in config.inc as follows:
|
|
|
124
|
|
771
|
125 MULE=1
|
|
428
|
126
|
|
442
|
127 -- If you're building with XPM support, modify the appropriate lines in
|
|
|
128 config.inc as follows:
|
|
|
129
|
|
|
130 HAVE_XPM=1
|
|
|
131 XPM_DIR="x:\location\of\your\xpm\sources"
|
|
|
132
|
|
|
133 and similarly for JPEG and TIFF support.
|
|
428
|
134
|
|
442
|
135 -- If you're building with PNG support, modify the appropriate lines in
|
|
|
136 config.inc as follows:
|
|
|
137
|
|
|
138 HAVE_PNG=1
|
|
|
139 PNG_DIR="x:\location\of\your\png\sources"
|
|
|
140 ZLIB_DIR="x:\location\of\your\zlib\sources"
|
|
|
141
|
|
|
142 -- If you're building with GIF support, modify the appropriate lines in
|
|
|
143 config.inc as follows:
|
|
|
144
|
|
|
145 HAVE_GIF=1
|
|
428
|
146
|
|
442
|
147 -- If you're building with X-Face support, modify the appropriate lines in
|
|
|
148 config.inc as follows:
|
|
|
149
|
|
|
150 HAVE_XFACE=1
|
|
|
151 COMPFACE_DIR="x:\location\of\your\compface\sources"
|
|
|
152
|
|
|
153 -- By default, XEmacs will expect to find its packages in the
|
|
|
154 subdirectories "site-packages", "mule-packages" and "xemacs-packages"
|
|
|
155 under the directory "c:\Program Files\XEmacs". If you want it to look
|
|
|
156 for these subdirectories elsewhere, modify the appropriate lines in
|
|
|
157 config.inc as follows:
|
|
428
|
158
|
|
442
|
159 PACKAGE_PREFIX="x:\your\package\directory"
|
|
|
160
|
|
|
161 Make sure that the directory pointed to by PACKAGE_PREFIX contains
|
|
|
162 the xemacs-packages directory into which you installed the packages.
|
|
|
163
|
|
|
164 -- XEmacs can build its info files more quickly if you have a copy of the
|
|
|
165 makeinfo program. If you have a copy, modify the appropriate lines in
|
|
|
166 config.inc as follows:
|
|
|
167
|
|
|
168 MAKEINFO="x:\location\of\makeinfo.exe"
|
|
|
169
|
|
|
170 If you don't have a copy of makeinfo then you'll need to have installed
|
|
|
171 the XEmacs texinfo package.
|
|
|
172
|
|
|
173 2. If you want to install XEmacs when you build it, modify the appropriate
|
|
|
174 lines in config.inc as follows (you can also run XEmacs from its build
|
|
|
175 directory):
|
|
|
176
|
|
|
177 INSTALL_DIR="x:\your\installation\directory"
|
|
428
|
178
|
|
442
|
179 (By default, XEmacs will be installed in directories under the directory
|
|
827
|
180 "c:\Program Files\XEmacs\XEmacs-21.5".)
|
|
442
|
181
|
|
1330
|
182 3. If you want the built files to go into a different tree than the source
|
|
|
183 tree (e.g. this allows you to build multiple versions of XEmacs, with
|
|
|
184 different configuration settings, from the same source tree), use the
|
|
|
185 script `make-build-dir' to create a skeleton build tree, create a
|
|
|
186 config.inc in that tree, and then run nmake from that tree. This is
|
|
|
187 similar to running `configure --srcdir=PATH' under Unix. See the
|
|
|
188 comments in `config.inc.samp' for more information.
|
|
|
189
|
|
|
190 4. If you want to build xemacs on the command line, use
|
|
442
|
191 `nmake install -f xemacs.mak', or just `nmake -f xemacs.mak' if you want
|
|
|
192 to run XEmacs from its build directory. nmake will build temacs, the DOC
|
|
|
193 file, update the elc's, dump xemacs and (optionally) install the relevant
|
|
|
194 files in the directories under the installation directory.
|
|
|
195
|
|
|
196 If you chose to install XEmacs, the file that you should run to start
|
|
|
197 XEmacs will be installed (by default) as
|
|
827
|
198 "c:\Program Files\XEmacs\XEmacs-21.5\i586-pc-win32\xemacs.exe".
|
|
442
|
199
|
|
827
|
200 To run from the build directory, run the file "src\xemacs.exe" off of the
|
|
442
|
201 root of the build directory.
|
|
|
202
|
|
|
203 You may want to create a shortcut to the file from your Desktop or
|
|
|
204 Start Menu.
|
|
|
205
|
|
1330
|
206 5. To build using MS Visual Studio, you can use the workspace file
|
|
827
|
207 `nt/xemacs.dsw'. This was prepared for Visual C++ 6.0. If you have a
|
|
|
208 different version and neither file works, just open up `nt/xemacs.mak'
|
|
900
|
209 from within Visual Studio and it will offer to wrap this Makefile in a
|
|
|
210 workspace file, from which you can build. Assuming you want to run from
|
|
|
211 the build directory (which you will want to do if you are planning on
|
|
|
212 doing any development work on XEmacs), use the following settings in
|
|
827
|
213 Project/Settings...:
|
|
442
|
214
|
|
|
215 Under the General tab:
|
|
|
216
|
|
|
217 Build command line: NMAKE /f xemacs.mak
|
|
|
218 Output file name: ..\src\xemacs.exe
|
|
|
219 Browse info file name: ..\src\temacs.bsc
|
|
|
220
|
|
|
221 Under the Debug tab:
|
|
428
|
222
|
|
442
|
223 Executable for debug session: ..\src\xemacs.exe
|
|
|
224
|
|
|
225
|
|
|
226 If you want to install XEmacs when it's built, change the build command
|
|
|
227 line to "NMAKE install /f xemacs.mak". (You will have to make the same
|
|
|
228 change even if you use the provided workspace nt/xemacs.dsw.)
|
|
|
229
|
|
|
230
|
|
|
231 * Debugging under MS Developer Studio
|
|
|
232 =====================================
|
|
|
233
|
|
|
234 The build process always creates debugging and "Source Browser" information
|
|
|
235 in the source tree for use with DevStudio. However that information is not
|
|
|
236 very useful unless you build a debug version of XEmacs:
|
|
|
237
|
|
|
238 1. Set DEBUG_XEMACS=1 and DEPEND=1 in config.inc and rebuild.
|
|
|
239
|
|
|
240 2. See instructions above for obtaining a workspace file for use with
|
|
|
241 MS Developer Studio. Build and debug your XEmacs this way.
|
|
|
242
|
|
|
243 3. To display the contents of a lisp variable, type Shift-F9 (or use the
|
|
1203
|
244 menu) to bring up the QuickWatch window, type dp(variable) and click
|
|
|
245 Recalculate. The output will appear in a console window, as well as in
|
|
|
246 the Debug window in MS Developer Studio.
|
|
442
|
247
|
|
1203
|
248 4. To display a current Lisp backtrace, type db() in the QuickWatch window,
|
|
|
249 as in the previous item.
|
|
|
250
|
|
|
251 5. To view Lisp variables in the "Watch" window wrap the variable in one of
|
|
442
|
252 the helper functions from the file src\console-msw.c, for example type
|
|
|
253 DSTRING(variable) in the "Watch" window to inspect a Lisp string.
|
|
|
254
|
|
1203
|
255 6. For further information on debugging XEmacs, see the item
|
|
|
256 `How to Debug an XEmacs problem with a debugger' in the XEmacs FAQ.
|
|
|
257
|
|
442
|
258
|
|
|
259 * Known Problems
|
|
|
260 ================
|
|
|
261
|
|
|
262 Please look at the PROBLEMS file for known problems. Any other problems you
|
|
|
263 need clarified, please email us and we will endeavour to provide any
|
|
|
264 assistance we can:
|
|
428
|
265
|
|
|
266 The XEmacs NT Mailing List: xemacs-nt@xemacs.org
|
|
|
267 Subscribe address: xemacs-nt-request@xemacs.org
|
|
|
268
|
|
442
|
269 Ben Wing (current primary MS Windows maintainer; author of the MS Windows
|
|
|
270 Mule code and some of the dialog box code)
|
|
|
271 Andy Piper (MS Windows contributor; author of the Cygwin support and the
|
|
|
272 MS Windows glyph and widget code)
|
|
|
273 Jonathan Harris (MS Windows contributor; author of the MS Windows redisplay
|
|
|
274 and underlying GUI code)
|
|
|
275 Kirill Katsnelson (MS Windows contributor; author of the MS Windows process
|
|
|
276 and printing code and some of the dialog box code;
|
|
|
277 general guru on obscure MS Windows programming topics)
|
|
|
278 David Hobley (early MS Windows contributor)
|
|
|
279 Marc Paquette (early MS Windows contributor)
|
|
|
280 August Hill (early MS Windows contributor)
|
|
428
|
281
|
|
|
282 and others.
|
