1 Building and Installing XEmacs on Windows NT -*- mode:outline -*-
7 The port was made much easier by the groundbreaking work of Geoff Voelker
8 and others who worked on the GNU Emacs port to NT. Their version is available
9 from http://www.cs.washington.edu/homes/voelker/ntemacs.html
12 * Required tools and sources
13 ============================
15 1. You will need Visual C++ V4.0 or later to compile everything. Personally
16 we have tested V4.0, V4.2, V5.0 and v6.0.
18 Note that Visual C++ assumes that the environment variables INCLUDE and
19 LIB are set to specify the location of the includes and libraries.
20 Your PATH environment variable also needs to include the DevStudio
21 vc\bin and sharedide\bin directories.
23 Visual C++ V5.0 installs a batch file called vcvars32.bat in
24 c:\Program Files\DevStudio\VC\bin\ (or wherever you installed it) that you
25 can run before building to set up all of these environment variables.
27 2. Grab the latest XEmacs source from ftp.xemacs.org if necessary.
29 You'll also need the xemacs-base package from the binary-packages
30 subdirectory and you'll probably also want at least the edit-utils,
31 text-modes, fsf-compat, cc-mode, prog-modes and xemacs-devel
34 You'll also need the texinfo package unless you have a copy of
35 makeinfo.exe on your machine.
37 Unpack the packages into, say, "c:\Program Files\XEmacs\xemacs-packages".
39 3. At this point you can choose to build for X and/or for Win32 native GUI.
40 If you only want to build for the Win32 native GUI then skip the next
44 ** Extra tools and sources required for X
46 If you want support for X you will also need:
48 1. An X server. MI/X is available on the Internet for free; It is
49 available from: http://www.microimages.com/www/html/freestuf/mixdlfrm.htm
51 2. Source for the MIT X11R6.3 libraries, available from: ftp.x.org
53 3. You'll need to compile the MIT libraries without multi-thread support.
54 To do this, there is an example Win32.cf and site.def provided which set
55 the relevant flags. You will also need to apply the patch in nt/X11.patch
56 in the xc/lib/X11 directory which will fix the DLL definition file.
58 Once compiled and installed, you will need to apply the patch in
59 nt/Xmd.patch. This is messy and better solutions would be appreciated.
61 4. Goto step 2 under 'Optional libraries' below.
67 1. If you want XPM image and toolbar support grab the latest version of the
68 xpm sources (xpm-3.4k.tar.gz at time of writing) and unpack them somewhere.
69 Copy nt\xpm.mak from the xemacs sources to the lib subdirectory of the
70 xpm sources, cd to that directory and build xpm with 'nmake -f xpm.mak'.
72 2. You probably also want PNG image support. Grab the latest versions of zlib
73 and libpng (zlib-1.1.3 and libpng-1.0.2 at time of writing), unpack them
74 somewhere and read the respective READMEs for details on how to build them.
75 The following build procedure works for zlib-1.1.3 and libpng-1.0.2:
77 cd to the zlib directory, type 'copy msdos\makefile.w32 Makefile' and
80 cd to the libpng directory, rename or move the zlib directory to ..\zlib
81 and type 'nmake -f scripts\makefile.w32'.
83 3. If you want TIFF support, grap the latest version of libtiff (tiff-v3.4
84 at time of writing) and unpack it somewhere. Copy nt\tiff.mak from the
85 xemacs sources to the contrib\winnt subdirectory of the tiff sources,
86 cd to that directory and build libtiff with 'nmake -f tiff.mak'. Note:
87 tiff.mak has only been verified to work under WinNT, not Win95 or 98.
88 However, the lastest distribution of libtiff includes a
89 contrib\win95\makefile.w95; that might work.
91 4. If you want JPEG support grab the latest version of jpegsrc (jpeg-6b at
92 time of writing) and read the README for details on how to build it.
94 5. If you want X-Face support, grab compface distribution and unpack it
95 somewhere. Copy nt\compface.mak from xemacs sources to the compface
96 directory. cd to that directory and build libcompface with
97 'nmake -f compface.mak'.
103 1. cd to the nt subdirectory of the xemacs distribution and build xemacs:
104 `nmake install -f xemacs.mak`, but read on before hitting Enter.
106 2. If you're building with XPM support, add this to the nmake command line:
107 HAVE_XPM=1 XPM_DIR="x:\location\of\your\xpm\sources"
108 and similarly for JPEG and TIFF support.
110 If you're building with PNG support, add this to the nmake command line:
111 HAVE_PNG=1 PNG_DIR="x:\location\of\your\png\sources"
112 ZLIB_DIR="x:\location\of\your\zlib\sources"
114 If you want to build with GIF support, add this to the nmake command line:
117 If you're building with X-Face support, add this to the nmake command line:
118 HAVE_XFACE=1 COMPFACE_DIR="x:\location\of\your\compface\sources"
120 If you're building for X, add this to the nmake command line:
121 HAVE_X=1 X11_DIR=x:\root\directory\of\your\X11\installation
123 3. By default, XEmacs will expect to find its packages in the subdirectories
124 "site-packages", "mule-packages" and "xemacs-packages" under the package
125 prefix directory "c:\Program Files\XEmacs". If you want it to look for
126 these subdirectories elsewhere, add this to the nmake command line:
127 PACKAGE_PREFIX="x:\your\package\directory"
128 If you change your mind and want to alter the package prefix directory
129 after you've built XEmacs, delete the file nt\obj\emacs.obj and rebuild
130 with the new PACKAGE_PREFIX setting.
132 4. By default, XEmacs will be installed in directories under the directory
133 "c:\Program Files\XEmacs\XEmacs-21.2". If you want to install it
134 elsewhere, add this to the nmake command line:
135 INSTALL_DIR="x:\your\installation\directory"
137 5. XEmacs can build its info files more quickly if you have a copy of the
138 makeinfo program. If you have a copy, add this to the nmake command line:
139 MAKEINFO="x:\location\of\makeinfo.exe"
140 If you don't have a copy of makeinfo then you'll need to have installed
141 the XEmacs texinfo package.
143 6. Now you can press Enter. nmake will build temacs, the DOC file, update
144 the elc's, dump xemacs and install the relevant files in the directories
145 under the installation directory.
147 Unless you set INSTALL_DIR above, the file that you should run to start
148 XEmacs will be installed as
149 "c:\Program Files\XEmacs\XEmacs-21.2\i586-pc-win32\runxemacs.exe".
150 You may want to create a shortcut to that file from your Desktop or
154 * Debugging under MS Developer Studio
155 =====================================
157 The build process always creates debugging and "Source Browser" information
158 in the source tree for use with DevStudio. If you actually want to debug
159 XEmacs you should probably build a debug version of XEmacs:
161 1. Delete the directory nt\obj and it's contents.
163 2. Add DEBUG_XEMACS=1 to the nmake command line and rebuild. You probably
164 don't want to install your debug build so you should tell nmake to build
165 the 'all' target instead of the 'install' target.
167 3. To make use of the debugging and "Source Browser" information, create a
168 new "console" project in DevStudio and, under Project/Settings, set:
169 Debug: executable name = full path of src\xemacs.exe
170 Link: output file name = full path of src\temacs.exe
171 Browse Info: browse info file name = full path of src\temacs.bsc
172 Remember to close the Source Browser file in DevStudio before rebuilding.
174 4. Start XEmacs from within DevStudio or by running src\xemacs.exe so that
175 you get a console window which may contain helpful debugging info.
177 5. To display the contents of a lisp variable click Debug/QuickWatch, type
178 debug_print(variable) and click Recalculate. The output will appear in
181 6. To view lisp variables in the "Watch" window wrap the variable in one of
182 the helper functions from the file src\console-msw.c. eg type
183 DSTRING(variable) in the "Watch" window to inspect a lisp string.
189 Please look at the PROBLEMS file for known problems and at the TODO list for
190 the current list of problems and people working on them.
192 Any other problems you need clarified, please email us and we will endeavour
193 to provide any assistance we can:
195 The XEmacs NT Mailing List: xemacs-nt@xemacs.org
196 Subscribe address: xemacs-nt-request@xemacs.org