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