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