Reformatted.
[chise/xemacs-chise.git] / nt / README
1 Building and Installing XEmacs on Windows 95/98/NT/2000/XP -*- mode:outline -*-
2
3                              David Hobley
4                              Marc Paquette
5                             Jonathan Harris
6                                Ben Wing
7
8 This is a port of XEmacs to Windows 95/98/NT/2000/XP.  If you are looking for a
9 port of GNU Emacs, see http://www.cs.washington.edu/homes/voelker/ntemacs.html.
10 NT 3.51 or later is required for building on Windows NT.  Note that the
11 developers typically use NT 4.0 and Windows 2000, and there may possibly be
12 problems under Windows 95/98 and NT 3.51.  If so, please report them to
13 xemacs-nt@xemacs.org; we are committed to maintaining compatibility with all
14 systems listed.
15
16 * Required tools and sources
17 ============================
18
19 1.  You will need Visual C++ V4.0 or later to compile everything. Personally
20     we have tested V4.0, V4.2, V5.0, v6.0 and v7.0/.NET.
21
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.
24     Your PATH environment variable also needs to include the DevStudio
25     vc\bin and sharedide\bin directories.
26
27     Visual C++ V5.0 and later install a batch file called vcvars32.bat in
28     c:\Program Files\DevStudio\VC\bin\ (or wherever you installed it) that you
29     can run before building to set up all of these environment variables.
30     Alternatively, you can choose at setup time to have these
31     environment variables automatically set up in the registry, which
32     is generally a good idea.
33
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.
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
76
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
93     ftp://sources.redhat.com/pub/cygwin/xfree/
94
95     or numerous mirrors, such as
96
97     ftp://ftp.freesoftware.com/pub/sourceware/cygwin/xfree/
98
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.
110
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
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'.
125
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
130     build procedure works for zlib-1.1.4 and libpng-1.0.9:
131
132     cd to the zlib directory, type 'copy msdos\makefile.w32 Makefile' and
133     then type 'nmake'.
134
135     cd to the libpng directory, rename or move the zlib directory to ..\zlib
136     and type 'nmake -f scripts\makefile.w32'.
137
138 3.  If you want TIFF support, grap the latest version of libtiff (tiff-v3.4
139     as of 2002-04-27) from ftp://ftp.xemacs.org/pub/xemacs/aux/ and unpack
140     it somewhere. Copy nt\tiff.mak from the xemacs sources to the
141     contrib\winnt subdirectory of the tiff sources, cd to that directory and
142     build libtiff with 'nmake -f tiff.mak'. Note: tiff.mak has only been
143     verified to work under WinNT, not Win95 or 98.  However, the latest
144     distribution of libtiff includes a contrib\win95\makefile.w95; that
145     might work.
146
147 4.  If you want JPEG support grab the latest version of jpegsrc (jpeg-6b as
148     of 2002-04-27) from ftp://ftp.xemacs.org/pub/xemacs/aux/ and read the
149     README for details on how to build it.
150
151 5.  If you want X-Face support, grab the compface distribution from
152     ftp://ftp.xemacs.org/pub/xemacs/aux/ and unpack it somewhere.
153     Copy nt\compface.mak from xemacs sources to the compface directory.
154     cd to that directory and build libcompface with 'nmake -f compface.mak'.
155
156
157 * Building
158 ==========
159
160 1.  cd to the nt subdirectory of the xemacs distribution and copy the file
161     config.inc.samp to config.inc.  Make any necessary modifications.  This
162     file controls the options that XEmacs is built with:
163
164     -- If you want international (aka "Mule") support, modify the appropriate
165        line in config.inc as follows:
166
167        HAVE_MULE=1
168
169        NOTE: This support is still quite raw under the Win32 native GUI,
170        but works well if you compile the Cygwin version with X support
171        and disable native Win32 support (--with-msw=no).
172     
173     -- If you're building with XPM support, modify the appropriate lines in
174        config.inc as follows:
175
176        HAVE_XPM=1
177        XPM_DIR="x:\location\of\your\xpm\sources"
178     
179        and similarly for JPEG and TIFF support.
180
181     -- If you're building with PNG support, modify the appropriate lines in
182        config.inc as follows:
183
184        HAVE_PNG=1
185        PNG_DIR="x:\location\of\your\png\sources"
186        ZLIB_DIR="x:\location\of\your\zlib\sources"
187
188     -- If you're building with GIF support, modify the appropriate lines in
189        config.inc as follows:
190
191        HAVE_GIF=1
192
193     -- If you're building with X-Face support, modify the appropriate lines in
194        config.inc as follows:
195
196        HAVE_XFACE=1
197        COMPFACE_DIR="x:\location\of\your\compface\sources"
198
199     -- If you're building for X, modify the appropriate lines in config.inc
200        as follows:
201
202        HAVE_X_WINDOWS=1
203        X11_DIR=x:\root\directory\of\your\X11\installation
204
205     -- By default, XEmacs will expect to find its packages in the
206        subdirectories "site-packages", "mule-packages" and "xemacs-packages"
207        under the directory "c:\Program Files\XEmacs". If you want it to look
208        for these subdirectories elsewhere, modify the appropriate lines in
209        config.inc as follows:
210
211        PACKAGE_PREFIX="x:\your\package\directory"
212
213        Make sure that the directory pointed to by PACKAGE_PREFIX contains
214        the xemacs-packages directory into which you installed the packages.
215
216     -- XEmacs can build its info files more quickly if you have a copy of the
217        makeinfo program. If you have a copy, modify the appropriate lines in
218        config.inc as follows:
219
220        MAKEINFO="x:\location\of\makeinfo.exe"
221
222        If you don't have a copy of makeinfo then you'll need to have installed
223        the XEmacs texinfo package.
224
225 2.  If you want to install XEmacs when you build it, modify the appropriate
226     lines in config.inc as follows (you can also run XEmacs from its build
227     directory):
228
229        INSTALL_DIR="x:\your\installation\directory"
230
231     (By default, XEmacs will be installed in directories under the directory
232     "c:\Program Files\XEmacs\XEmacs-21.4".)
233
234 3.  If you want to build xemacs on the command line, use
235     `nmake install -f xemacs.mak', or just `nmake -f xemacs.mak' if you want
236     to run XEmacs from its build directory.  nmake will build temacs, the DOC
237     file, update the elc's, dump xemacs and (optionally) install the relevant
238     files in the directories under the installation directory.
239
240     If you chose to install XEmacs, the file that you should run to start
241     XEmacs will be installed (by default) as
242         "c:\Program Files\XEmacs\XEmacs-21.4\i586-pc-win32\xemacs.exe".
243
244     To run from the build directory, run the file "src\xemacs.exe" off of the
245     root of the build directory.
246
247     You may want to create a shortcut to the file from your Desktop or
248     Start Menu.
249
250 4.  To build using MS Developer Studio, you can use the workspace file
251     `nt/xemacs.dsw'.  This was prepared for Visual C++ 6.0.  If you are using
252     Visual C++ 5.0, you can use the workspace file `nt/xemacs-vc50.dsw'.  If
253     you have a different version and neither file works, just open up
254     `nt/xemacs.mak' from within MS Developer Studio and it will offer to wrap
255     this Makefile in a workspace file, from which you can build.  Assuming
256     you want to run from the build directory (which you will want to do if
257     you are planning on doing any development work on XEmacs), use the
258     following settings in Project/Settings...:
259
260     Under the General tab:
261
262     Build command line: NMAKE /f xemacs.mak
263     Output file name: ..\src\xemacs.exe
264     Browse info file name: ..\src\temacs.bsc
265
266     Under the Debug tab:
267
268     Executable for debug session: ..\src\xemacs.exe
269
270
271     If you want to install XEmacs when it's built, change the build command
272     line to "NMAKE install /f xemacs.mak". (You will have to make the same
273     change even if you use the provided workspace nt/xemacs.dsw.)
274
275
276 * Debugging under MS Developer Studio
277 =====================================
278
279 The build process always creates debugging and "Source Browser" information
280 in the source tree for use with DevStudio. However that information is not
281 very useful unless you build a debug version of XEmacs:
282
283 1.  Set DEBUG_XEMACS=1 and DEPEND=1 in config.inc and rebuild.
284
285 2.  See instructions above for obtaining a workspace file for use with
286     MS Developer Studio.  Build and debug your XEmacs this way.
287
288 3.  To display the contents of a lisp variable, type Shift-F9 (or use the
289     menu) to bring up the QuickWatch window, type debug_print(variable) and
290     click Recalculate. The output will appear in a console window, as well
291     as in the Debug window in MS Developer Studio.
292
293 4.  To view Lisp variables in the "Watch" window wrap the variable in one of
294     the helper functions from the file src\console-msw.c, for example type
295     DSTRING(variable) in the "Watch" window to inspect a Lisp string.
296
297
298 * Known Problems
299 ================
300
301 Please look at the PROBLEMS file for known problems. Any other problems you
302 need clarified, please email us and we will endeavour to provide any
303 assistance we can:
304
305 The XEmacs NT Mailing List: xemacs-nt@xemacs.org
306 Subscribe address:          xemacs-nt-request@xemacs.org
307
308 Ben Wing (current primary MS Windows maintainer; author of the MS Windows
309           Mule code and some of the dialog box code)
310 Andy Piper (MS Windows contributor; author of the Cygwin support and the
311             MS Windows glyph and widget code)
312 Jonathan Harris (MS Windows contributor; author of the MS Windows redisplay
313                  and underlying GUI code)
314 Kirill Katsnelson (MS Windows contributor; author of the MS Windows process
315                    and printing code and some of the dialog box code;
316                    general guru on obscure MS Windows programming topics)
317 David Hobley (early MS Windows contributor)
318 Marc Paquette (early MS Windows contributor)
319 August Hill (early MS Windows contributor)
320
321 and others.