annotate nt/README @ 428:3ecd8885ac67 r21-2-22

Import from CVS: tag r21-2-22
author cvs
date Mon, 13 Aug 2007 11:28:15 +0200
parents
children abe6d1db359e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
428
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
1 Building and Installing XEmacs on Windows NT
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
2
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
3 David Hobley
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
4 Marc Paquette
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
5 Jonathan Harris
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
6
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
7 The port was made much easier by the groundbreaking work of Geoff Voelker
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
8 and others who worked on the GNU Emacs port to NT. Their version is available
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
9 from http://www.cs.washington.edu/homes/voelker/ntemacs.html
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
10
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
11 To get it working you will need:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
12
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
13 1. You will need Visual C++ V4.0 or later to compile everything. Personally we
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
14 have tested V4.0, V4.2 and V5.0.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
15 Note that Visual C++ assumes a couple of environment variables INCLUDE and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
16 LIB to be set which specify the location of the includes and libraries.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
17 Your PATH environment variable also needs to include the DevStudio vc\bin
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
18 and sharedide\bin directories.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
19 Visual C++ V5.0 installs a batch file called vcvars32.bat in
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
20 c:\Program Files\DevStudio\VC\bin\ (or wherever you installed it) that you
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
21 can run before building to set up all of these environment variables.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
22
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
23 2. Grab the latest XEmacs source from ftp.xemacs.org if necessary. All Win32
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
24 support is in the nt\ subdirectory. You'll also need the xemacs-base
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
25 package from the binary-packages subdirectory and you'll probably also
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
26 want at least the edit-utils, text-modes, fsf-compat, cc-mode,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
27 prog-modes and xemacs-devel packages.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
28 Unpack the packages into, say, "c:\Program Files\XEmacs\xemacs-packages".
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
29
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
30 3. At this point you can select X or Win32 native GUI support.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
31
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
32 If you want to build for native GUI:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
33
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
34 1. If you want XPM image and toolbar support grab the latest version of the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
35 xpm sources (xpm-3.4k.tar.gz at time of writing) and unpack them somewhere.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
36 Copy nt\xpm.mak from the xemacs sources to the lib subdirectory of the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
37 xpm sources, cd to that directory and build xpm with 'nmake -f xpm.mak'.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
38
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
39 2. You probably also want PNG image support. Grab the latest versions of zlib
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
40 and libpng (zlib-1.1.3 and libpng-1.0.2 at time of writing), unpack them
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
41 somewhere and read the respective READMEs for details on how to build them.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
42 The following build procedure works for zlib-1.1.3 and libpng-1.0.2:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
43
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
44 cd to the zlib directory, type 'copy msdos\makefile.w32 Makefile' and
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
45 then type 'nmake'.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
46
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
47 cd to the libpng directory, rename or move the zlib directory to ..\zlib
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
48 and type 'nmake -f scripts\makefile.w32'.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
49
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
50 3. If you want TIFF support, grap the latest version of libtiff (tiff-v3.4
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
51 at time of writing) and unpack it somewhere. Copy nt\tiff.mak from the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
52 xemacs sources to the contrib\winnt subdirectory of the tiff sources,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
53 cd to that directory and build libtiff with 'nmake -f tiff.mak'. Note:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
54 tiff.mak has only been verified to work under WinNT, not Win95 or 98.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
55 However, the lastest distribution of libtiff includes a
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
56 contrib\win95\makefile.w95; that might work.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
57
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
58 4. If you want JPEG support grab the latest version of jpegsrc (jpeg-6b at
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
59 time of writing) and read the README for details on how to build it.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
60
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
61 5. If you want X-Face support, grab compface distribution and unpack it
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
62 somewhere. Copy nt\compface.mak from xemacs sources to the compface
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
63 directory. cd to that directory and build libcompface with
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
64 'nmake -f compface.mak'.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
65
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
66 6. cd to the nt subdirectory of the xemacs distribution and build xemacs:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
67 `nmake install -f xemacs.mak`, but read on before hitting Enter.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
68
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
69 7. If you're building with XPM support, add this to the nmake command line:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
70 HAVE_XPM=1 XPM_DIR="x:\location\of\your\xpm\sources"
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
71 and similarly for JPEG and TIFF support.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
72
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
73 If you're building with PNG support, add this to the nmake command line:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
74 HAVE_PNG=1 PNG_DIR="x:\location\of\your\png\sources"
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
75 ZLIB_DIR="x:\location\of\your\zlib\sources"
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
76
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
77 If you want to build with GIF support, add this to the nmake command line:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
78 HAVE_GIF=1
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
79
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
80 If you're building with X-Face support, add this to the nmake command line:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
81 HAVE_XFACE=1 COMPFACE_DIR="x:\location\of\your\compface\sources"
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
82
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
83 8. By default, XEmacs will expect to find its packages in the subdirectories
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
84 "site-packages", "mule-packages" and "xemacs-packages" under the package
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
85 prefix directory "c:\Program Files\XEmacs". If you want it to look for
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
86 these subdirectories elsewhere, add this to the nmake command line:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
87 PACKAGE_PREFIX="x:\your\package\directory"
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
88 If you change your mind and want to alter the package prefix directory
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
89 after you've built XEmacs, delete the file .\obj\emacs.obj and rebuild with
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
90 the new PACKAGE_PREFIX.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
91
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
92 9. By default, XEmacs will be installed in directories under the directory
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
93 "c:\Program Files\XEmacs\XEmacs-21.0". If you want to install it elsewhere,
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
94 add this to the nmake command line:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
95 INSTALL_DIR="x:\your\installation\directory"
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
96
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
97 10. Now you can press Enter. nmake will build temacs, the DOC file, update the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
98 elc's, dump xemacs and install the relevant files in the directories under
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
99 the installation directory. Unless you set INSTALL_DIR above, the file that
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
100 you should run to start XEmacs will be installed as
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
101 "c:\Program Files\XEmacs\XEmacs-21.0\i386-pc-win32\runemacs.exe". You may
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
102 want to create a shortcut to that file from your Desktop or Start Menu.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
103
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
104 11. The build process always creates debugging and "Source Browser" information
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
105 in the source tree for use with MS DevStudio. If you actually want to debug
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
106 XEmacs you should run XEmacs from the source directory instead of from the
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
107 installation directory. You should probably also build a debug version of
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
108 XEmacs; to do this start with a clean source tree and add DEBUG_XEMACS=1 to
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
109 the nmake command line. You probably don't want to install your debug build
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
110 so you should tell nmake to build the 'all' target instead of the 'install'
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
111 target.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
112
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
113 To make use of the debugging and "Source Browser" information, create a new
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
114 "console" project in MS DevStudio and, under Project/Settings, set:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
115 Debug: executable name = full path of src\xemacs.exe
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
116 Link: output file name = full path of src\temacs.exe
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
117 Browse Info: browse info file name = full path of src\temacs.bsc
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
118 Remember to close the Source Browser file in DevStudio before rebuilding.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
119
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
120
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
121 If you want support for X you will need:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
122
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
123 1. An X server. MI/X is available on the Internet for free; It is
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
124 available from: http://www.microimages.com/www/html/freestuf/mixdlfrm.htm
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
125
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
126 2. The MIT X11R6.3 libraries available from: ftp.x.org
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
127
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
128 3. You'll need to compile the MIT libraries without multi-thread support.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
129 To do this, there is an example Win32.cf and site.def provided which
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
130 set the relevant flags. You will also need to apply the patch in
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
131 nt/X11.patch in the xc/lib/X11 directory which will fix the DLL definition
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
132 file. Once compiled and installed, you will need to apply the following
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
133 patch to Xmd.h. This is messy and better solutions would be appreciated.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
134
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
135 4. Goto 2 under 'native GUI' above and add this to the nmake command line:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
136 HAVE_X=1 X11_DIR=x:\root\directory\of\your\X11\installation
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
137
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
138 --- Xmd.h~ Thu Jun 08 23:20:40 1995
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
139 +++ Xmd.h Sun Mar 16 13:09:10 1997
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
140 @@ -150,8 +150,9 @@
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
141 typedef CARD16 BITS16;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
142 typedef CARD8 BYTE;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
143
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
144 +#ifndef WIN32
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
145 typedef CARD8 BOOL;
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
146 -
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
147 +#endif
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
148
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
149 Known Problems:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
150 Please look at the TODO list for the current list of problems and people
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
151 working on them.
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
152
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
153 Any other problems you need clarified, please email us and we will endeavour
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
154 to provide any assistance we can:
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
155
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
156 The XEmacs NT Mailing List: xemacs-nt@xemacs.org
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
157 Subscribe address: xemacs-nt-request@xemacs.org
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
158
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
159 David Hobley
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
160 Marc Paquette
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
161 August Hill
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
162 Jonathan Harris
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
163
3ecd8885ac67 Import from CVS: tag r21-2-22
cvs
parents:
diff changeset
164 and others.