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