annotate nt/README @ 308:33bdb3d4b97f r21-0b52

Import from CVS: tag r21-0b52
author cvs
date Mon, 13 Aug 2007 10:42:44 +0200
parents 70ad99077275
children 341dac730539
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
169
15872534500d Import from CVS: tag r20-3b11
cvs
parents: 155
diff changeset
1 Building and Installing XEmacs on Windows NT
155
43dd3413c7c7 Import from CVS: tag r20-3b4
cvs
parents: 100
diff changeset
2
169
15872534500d Import from CVS: tag r20-3b11
cvs
parents: 155
diff changeset
3 David Hobley
15872534500d Import from CVS: tag r20-3b11
cvs
parents: 155
diff changeset
4 Marc Paquette
215
1f0dabaa0855 Import from CVS: tag r20-4b6
cvs
parents: 213
diff changeset
5 Jonathan Harris
155
43dd3413c7c7 Import from CVS: tag r20-3b4
cvs
parents: 100
diff changeset
6
169
15872534500d Import from CVS: tag r20-3b11
cvs
parents: 155
diff changeset
7 The port was made much easier by the groundbreaking work of Geoff Voelker
15872534500d Import from CVS: tag r20-3b11
cvs
parents: 155
diff changeset
8 and others who worked on the GNU Emacs port to NT. Their version is available
15872534500d Import from CVS: tag r20-3b11
cvs
parents: 155
diff changeset
9 from http://www.cs.washington.edu/homes/voelker/ntemacs.html
15872534500d Import from CVS: tag r20-3b11
cvs
parents: 155
diff changeset
10
15872534500d Import from CVS: tag r20-3b11
cvs
parents: 155
diff changeset
11 To get it working you will need:
155
43dd3413c7c7 Import from CVS: tag r20-3b4
cvs
parents: 100
diff changeset
12
308
33bdb3d4b97f Import from CVS: tag r21-0b52
cvs
parents: 298
diff changeset
13 1. You will need Visual C++ V4.0 or later to compile everything. Personally we
33bdb3d4b97f Import from CVS: tag r21-0b52
cvs
parents: 298
diff changeset
14 have tested V4.0, V4.2 and V5.0.
213
78f53ef88e17 Import from CVS: tag r20-4b5
cvs
parents: 195
diff changeset
15 Note that Visual C++ assumes a couple of environment variables INCLUDE and
78f53ef88e17 Import from CVS: tag r20-4b5
cvs
parents: 195
diff changeset
16 LIB to be set which specify the location of the includes and libraries.
308
33bdb3d4b97f Import from CVS: tag r21-0b52
cvs
parents: 298
diff changeset
17 Your PATH environment variable also needs to include the DevStudio vc\bin
33bdb3d4b97f Import from CVS: tag r21-0b52
cvs
parents: 298
diff changeset
18 and sharedide\bin directories.
33bdb3d4b97f Import from CVS: tag r21-0b52
cvs
parents: 298
diff changeset
19 Visual C++ V5.0 installs a batch file called vcvars32.bat in
33bdb3d4b97f Import from CVS: tag r21-0b52
cvs
parents: 298
diff changeset
20 c:\Program Files\DevStudio\VC\bin\ (or wherever you installed it) that you
33bdb3d4b97f Import from CVS: tag r21-0b52
cvs
parents: 298
diff changeset
21 can run before building to set up all of these environment variables.
298
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
22
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
23 2. Grab the latest XEmacs source from ftp.xemacs.org if necessary. All Win32
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
24 support is in the nt\ subdirectory. You'll also need the xemacs-base
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
25 package from the binary-packages subdirectory and you'll probably also
276
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 215
diff changeset
26 want at least the edit-utils, text-utils, cc-mode and prog-utils packages.
298
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
27 Unpack the packages into, say, "c:\Program Files\XEmacs\packages".
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
28
308
33bdb3d4b97f Import from CVS: tag r21-0b52
cvs
parents: 298
diff changeset
29 3. At this point you can select X or Win32 native GUI support.
276
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 215
diff changeset
30
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 215
diff changeset
31 If you want to build for native GUI:
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 215
diff changeset
32
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 215
diff changeset
33 1. If you want XPM and toolbar support grab the latest version of the xpm
298
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
34 sources (xpm-3.4k.tar.gz at time of writing) and unpack them somewhere.
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
35 Copy nt\xpm.mak from the xemacs sources to the lib subdirectory of the
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
36 xpm sources, cd to that directory and build xpm with `nmake -f xpm.mak`.
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
37
276
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 215
diff changeset
38 2. cd to the nt subdirectory of the xemacs distribution and build xemacs:
298
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
39 `nmake install -f xemacs.mak`, but read on before hitting Enter.
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
40
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
41 3. If you're building with XPM support, add this to the nmake command line:
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
42 HAVE_XPM=1 XPM_DIR="x:\location\of\your\xpm\source\tree"
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
43
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
44 4. By default, XEmacs will look for packages in
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
45 "c:\Program Files\XEmacs\packages". If you want it to look elsewhere,
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
46 add this to the nmake command line:
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
47 PACKAGEPATH="x:\\location\\of\\your\\packages"
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
48 Note the doubled-up backslashes in that path. If you want to change the
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
49 package path after you've already built XEmacs, delete the file
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
50 .\obj\emacs.obj and rebuild with the new value of PACKAGEPATH.
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
51
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
52 5. By default, XEmacs will be installed in directories under the directory
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
53 "c:\Program Files\XEmacs\XEmacs-21.0". If you want to install it
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
54 elsewhere, add this to the nmake command line:
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
55 INSTALL_DIR="x:\your\installation\directory"
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
56
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
57 6. Now you can press Enter. nmake will build temacs, the DOC file, update the
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
58 elc's, dump xemacs and install the relevant files in the directories under
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
59 the installation directory. Unless you set INSTALL_DIR in step 5 above, the
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
60 file that you should run to start XEmacs will be installed as
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
61 "c:\Program Files\XEmacs\XEmacs-21.0\i386-pc-win32\runemacs.exe". You may
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
62 want to create a shortcut to that file from your Desktop or Start Menu.
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
63
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
64 7. The build process always creates debugging and "Source Browser" information
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
65 in the source tree for use with MS DevStudio. If you actually want to debug
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
66 XEmacs you should run XEmacs from the source directory instead of from the
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
67 installation directory. You should probably also build a debug version of
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
68 XEmacs; to do this start with a clean source tree and add DEBUG_XEMACS=1 to
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
69 the nmake command line. You probably don't want to install your debug build
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
70 so you should tell nmake to build the 'all' target instead of the 'install'
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
71 target.
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
72
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
73 To make use of the debugging and "Source Browser" information, create a new
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
74 "console" project in MS DevStudio and, under Project/Settings, set:
276
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 215
diff changeset
75 Debug: executable name = full path of src\xemacs.exe
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 215
diff changeset
76 Link: output file name = full path of src\temacs.exe
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 215
diff changeset
77 Browse Info: browse info file name = full path of src\temacs.bsc
6330739388db Import from CVS: tag r21-0b36
cvs
parents: 215
diff changeset
78 Remember to close the Source Browser file in DevStudio before rebuilding.
213
78f53ef88e17 Import from CVS: tag r20-4b5
cvs
parents: 195
diff changeset
79
298
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
80
213
78f53ef88e17 Import from CVS: tag r20-4b5
cvs
parents: 195
diff changeset
81 If you want support for X you will need:
78f53ef88e17 Import from CVS: tag r20-4b5
cvs
parents: 195
diff changeset
82
195
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 169
diff changeset
83 1. An X server. MI/X is available on the Internet for free; It is
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 169
diff changeset
84 available from: http://www.microimages.com/www/html/freestuf/mixdlfrm.htm
298
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
85
195
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 169
diff changeset
86 2. The MIT X11R6.3 libraries available from: ftp.x.org
298
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
87
195
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 169
diff changeset
88 3. You'll need to compile the MIT libraries without multi-thread support.
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 169
diff changeset
89 To do this, there is an example Win32.cf and site.def provided which
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 169
diff changeset
90 set the relevant flags. You will also need to apply the patch in
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 169
diff changeset
91 nt/X11.patch in the xc/lib/X11 directory which will fix the DLL definition
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 169
diff changeset
92 file. Once compiled and installed, you will need to apply the following
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 169
diff changeset
93 patch to Xmd.h. This is messy and better solutions would be appreciated.
298
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
94
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
95 4. Goto 2 under 'native GUI' above and add this to the nmake command line:
70ad99077275 Import from CVS: tag r21-0b47
cvs
parents: 276
diff changeset
96 HAVE_X=1 X11_DIR=x:\root\directory\of\your\X11\installation
155
43dd3413c7c7 Import from CVS: tag r20-3b4
cvs
parents: 100
diff changeset
97
43dd3413c7c7 Import from CVS: tag r20-3b4
cvs
parents: 100
diff changeset
98 --- Xmd.h~ Thu Jun 08 23:20:40 1995
43dd3413c7c7 Import from CVS: tag r20-3b4
cvs
parents: 100
diff changeset
99 +++ Xmd.h Sun Mar 16 13:09:10 1997
43dd3413c7c7 Import from CVS: tag r20-3b4
cvs
parents: 100
diff changeset
100 @@ -150,8 +150,9 @@
43dd3413c7c7 Import from CVS: tag r20-3b4
cvs
parents: 100
diff changeset
101 typedef CARD16 BITS16;
43dd3413c7c7 Import from CVS: tag r20-3b4
cvs
parents: 100
diff changeset
102 typedef CARD8 BYTE;
43dd3413c7c7 Import from CVS: tag r20-3b4
cvs
parents: 100
diff changeset
103
43dd3413c7c7 Import from CVS: tag r20-3b4
cvs
parents: 100
diff changeset
104 +#ifndef WIN32
43dd3413c7c7 Import from CVS: tag r20-3b4
cvs
parents: 100
diff changeset
105 typedef CARD8 BOOL;
43dd3413c7c7 Import from CVS: tag r20-3b4
cvs
parents: 100
diff changeset
106 -
43dd3413c7c7 Import from CVS: tag r20-3b4
cvs
parents: 100
diff changeset
107 +#endif
195
a2f645c6b9f8 Import from CVS: tag r20-3b24
cvs
parents: 169
diff changeset
108
169
15872534500d Import from CVS: tag r20-3b11
cvs
parents: 155
diff changeset
109 Known Problems:
15872534500d Import from CVS: tag r20-3b11
cvs
parents: 155
diff changeset
110 Please look at the TODO list for the current list of problems and people
15872534500d Import from CVS: tag r20-3b11
cvs
parents: 155
diff changeset
111 working on them.
15872534500d Import from CVS: tag r20-3b11
cvs
parents: 155
diff changeset
112
15872534500d Import from CVS: tag r20-3b11
cvs
parents: 155
diff changeset
113 Any other problems you need clarified, please email us and we will endeavour
15872534500d Import from CVS: tag r20-3b11
cvs
parents: 155
diff changeset
114 to provide any assistance we can:
155
43dd3413c7c7 Import from CVS: tag r20-3b4
cvs
parents: 100
diff changeset
115
213
78f53ef88e17 Import from CVS: tag r20-4b5
cvs
parents: 195
diff changeset
116 The XEmacs NT Mailing List: xemacs-nt@xemacs.org
78f53ef88e17 Import from CVS: tag r20-4b5
cvs
parents: 195
diff changeset
117 Subscribe address: xemacs-nt-request@xemacs.org
155
43dd3413c7c7 Import from CVS: tag r20-3b4
cvs
parents: 100
diff changeset
118
213
78f53ef88e17 Import from CVS: tag r20-4b5
cvs
parents: 195
diff changeset
119 David Hobley
78f53ef88e17 Import from CVS: tag r20-4b5
cvs
parents: 195
diff changeset
120 Marc Paquette
78f53ef88e17 Import from CVS: tag r20-4b5
cvs
parents: 195
diff changeset
121 August Hill
215
1f0dabaa0855 Import from CVS: tag r20-4b6
cvs
parents: 213
diff changeset
122 Jonathan Harris
155
43dd3413c7c7 Import from CVS: tag r20-3b4
cvs
parents: 100
diff changeset
123
213
78f53ef88e17 Import from CVS: tag r20-4b5
cvs
parents: 195
diff changeset
124 and others.