admin/nt/README-ftp-server

   1                       Precompiled Distributions of
   2                            Emacs for Windows
   3
   4                               Version 22.2
   5
   6                              May 22, 2007
   7
   8   This directory contains source and precompiled distributions for GNU
   9   Emacs on Windows NT/2000/XP and Windows 95/98/Me.  This port is a
  10   part of the standard GNU Emacs distribution from the Free Software
  11   Foundation; the precompiled distributions are provided here for
  12   convenience since the majority of Windows users are not accustomed
  13   to compiling programs themselves.
  14
  15   If you have access to the World Wide Web, I would recommend pointing
  16   your favorite web browser to the following document (if you haven't
  17   already):
  18
  19         http://www.gnu.org/software/emacs/windows/ntemacs.html
  20
  21   The above web document is a far more complete version of this README
  22   file.  If you don't have access to the Web, however, then read on.
  23
  24
  25 * IMPORTANT LEGAL REMINDER
  26
  27   If you want to redistribute any of the precompiled distributions of
  28   Emacs, be careful to check the implications of the GPL.  For instance,
  29   if you put the emacs-22.2-bin-i386.tar.gz file from this directory on
  30   an Internet site, you must arrange to distribute the source files of
  31   the SAME version (i.e. ../emacs-22.2.tar.gz).
  32
  33   Making a link to our copy of the source is NOT sufficient, since we
  34   might upgrade to a new version while you are still distributing the
  35   old binaries.
  36
  37
  38 * Files in this directory
  39
  40   + emacs-22.2-bin-i386.zip
  41     Windows binaries of Emacs-22.2, with all lisp code and documentation
  42     included.
  43
  44     Download this file if you want a single installation package, and
  45     are not interested in the C source code for Emacs. After
  46     unpacking, you can optionally run the file bin/addpm.exe to have
  47     Emacs add icons to the Start Menu.
  48
  49     If you need the C source code at a later date, it will be safe to
  50     unpack the source distribution on top of this installation.
  51
  52   + emacs-22.2-barebin-i386.zip
  53     Windows binaries of Emacs-22.2, without lisp code or documentation.
  54
  55     Download this file if you already have the source distribution, or
  56     if you need to redump the emacs.exe executable.
  57
  58     Unpack this over the top of either the source distribution or the
  59     bin distribution above. It contains the bin subdirectory and etc/DOC
  60     file, plus temacs.exe and dump.bat, which are required if you want to
  61     redump emacs without recompiling it.
  62
  63   + libxpm-3.5.7-w32-src.zip
  64     Source code required to compile libXpm-3.5.7 on Windows. Contains
  65     a basic Makefile for compiling with mingw32 and a .def file for
  66     generating a DLL with the appropriate exports in addition to the
  67     source code to provide the subset of functionality Emacs uses from
  68     libXpm. This corresponds to the libXpm.dll in emacs-22.2-bin-i386.zip
  69     and emacs-22.2-barebin-i386.zip.
  70
  71
  72     The following are provided for users who require older versions.
  73
  74   + emacs-22.1-bin-i386.zip
  75   + emacs-22-1-barebin-i386.zip
  76     Windows binaries of Emacs 22.1, contents as above.
  77
  78   + emacs-21.3-bin-i386.tar.gz
  79     Windows binaries of Emacs 21.3, with compiled lisp code and some
  80     documentation included.
  81
  82   + emacs-21.3-leim.tar.gz
  83     Compiled lisp input methods. This optional addition to Emacs-21.3
  84     is required if you want to enter languages that are not directly
  85     supported by your keyboard.
  86
  87 * Image support
  88
  89   Emacs 22.2 contains support for images, however for most image formats
  90   supporting libraries are required.  This distribution has been tested
  91   with the libraries that are distributed with GTK for Windows, and the
  92   libraries found at http://gnuwin32.sourceforge.net/. The following image
  93   formats are supported:
  94
  95       PBM/PGM/PPM: Supported natively by Emacs. This format is used for
  96       the black and white versions of the toolbar icons.
  97
  98       XPM: a Windows port of the XPM library corresponding to the x.org
  99       release of X11R7.3 is included with the binary distribution, but
 100       can be replaced by other versions with the name xpm4.dll,
 101       libxpm-nox4.dll or libxpm.dll.
 102
 103       PNG: requires the PNG reference library 1.2 or later, which will
 104       be named libpng13d.dll, libpng13.dll, libpng12d.dll, libpng12.dll
 105       or libpng.dll. LibPNG requires zlib, which should come from the same
 106       source as you got libpng.
 107
 108       JPEG: requires the Independant JPEG Group's libjpeg 6b or later,
 109       which will be called jpeg62.dll, libjpeg.dll, jpeg-62.dll or jpeg.dll.
 110
 111       TIFF: requires libTIFF 3.0 or later, which will be called libtiff3.dll
 112       or libtiff.dll.
 113
 114       GIF: requires libungif or giflib 4.1 or later, which will be
 115       called giflib4.dll, libungif4.dll or libungif.dll.
 116
 117 * Distributions in .tar.gz and .zip format
 118
 119   Emacs is distributed primarily as source code in a large gzipped tar file
 120   (*.tar.gz).  Because Emacs is quite large and therefore difficult to
 121   download over unreliable connections, the Windows binaries are provided
 122   in several combinations, ranging from the complete source plus executables,
 123   to just the minimal amount needed to run without any source, plus a
 124   couple of optional packages.  Formerly, we used the same .tar.gz format
 125   but since there are no longer legal problems with .zip files, and the
 126   latest versions of Windows support these natively, the Windows binaries
 127   of Emacs are now distributed as .zip files.
 128
 129 * Distributions for non-x86 platforms
 130
 131   Distributions for non-x86 platforms are no longer supplied. Older
 132   platforms supported by Windows NT no longer seem to be in demand,
 133   and Emacs is yet to be ported to 64bit Windows platforms. If you are
 134   willing to help port Emacs 23 to 64bit versions of Windows, your
 135   contribution will be welcome on the emacs-devel mailing list.
 136
 137 * Unpacking distributions
 138
 139   Ports of GNU gzip and GNU tar for handling the source distribution file
 140   format can be found in several places that distribute ports of GNU
 141   programs, for example:
 142
 143     Cygwin:   http://www.cygwin.com/
 144     GnuWin32: http://gnuwin32.sourceforge.net/
 145
 146   Many other popular file compression utilities for Windows are also
 147   able to handle gzipped tar files.
 148
 149   Open a command prompt (MSDOS) window.  Decide on a directory in which
 150   to place Emacs.  Move the distribution to that directory, and then
 151   unpack it as follows.
 152
 153   If you have the gzipped tar version, use gunzip to uncompress the tar
 154   file on the fly, and pipe the output through tar with the "xvf" flags
 155   to extract the files from the tar file:
 156
 157     % gunzip -c some.tar.gz | tar xvf -
 158
 159   You may see messages from tar about not being able to change the
 160   modification time on directories, and from gunzip complaining about a
 161   broken pipe.  These messages are harmless and you can ignore them.  On
 162   Windows NT, unpacking tarballs this way leaves them in compressed
 163   form, taking up less space on disk.  Unfortunately, on Windows 95 and
 164   98, a large temporary file is created, so it is better to use the
 165   djtarnt.exe program, which performs the equivalent operation in one
 166   step:
 167
 168     % djtarnt -x some.tar.gz
 169
 170   You may be prompted to rename or overwrite directories when using
 171   djtarnt: simply type return to continue (this is harmless).
 172
 173   Zip files can be unpacked using unzip.exe from info-zip.org
 174   if you do not already have other tools to do this.
 175
 176     % unzip some.zip
 177
 178   The precompiled binaries can be unpacked using unzip.exe from info-zip.org
 179   if you do not already have other tools to do this.
 180
 181     % unzip some.zip
 182
 183   Once you have unpacked a precompiled distribution of Emacs, it should
 184   have the following subdirectories:
 185
 186         bin     etc     info    lisp    site-lisp
 187
 188
 189 * Unpacking with other tools
 190
 191   If you do use other utility programs to unpack the distribution, check
 192   the following to be sure the distribution was not corrupted:
 193
 194   + Be sure to disable the CR/LF translation or the executables will
 195     be unusable.  Older versions of WinZip would enable this
 196     translation by default when unpacking .tar files.  If you are
 197     using WinZip, disable it.  (I don't have WinZip myself, and I do
 198     not know the specific commands necessary to disable it.)
 199
 200   + Check that filenames were not truncated to 8.3.  For example, there
 201     should be a file lisp/abbrevlist.el; if this has been truncated to
 202     abbrevli.el, your distribution has been corrupted while unpacking
 203     and Emacs will not start.
 204
 205   + I've also had reports that some older "gnuwin32" port of tar
 206     corrupts the executables.  Use the latest version from the gnuwin32
 207     site or another port of tar instead.
 208
 209   If you believe you have unpacked the distributions correctly and are
 210   still encountering problems, see the section on Further Information
 211   below.
 212
 213
 214 * Compiling from source
 215
 216   If you would like to compile Emacs from source, download the source
 217   distribution, unpack it in the same manner as a precompiled
 218   distribution, and look in the file nt/INSTALL for detailed
 219   directions.  You can either use the Microsoft compiler included with
 220   Visual C++ 2003 or earlier, or GCC 2.95 or later with MinGW support,
 221   to compile the source.  The port of GCC included in Cygwin is
 222   supported, but check the nt/INSTALL file if you have trouble since
 223   some builds of GNU make aren't supported.
 224
 225
 226 * Further information
 227
 228   If you have access to the World Wide Web, I would recommend pointing
 229   your favorite web browser to following the document (if you haven't
 230   already):
 231
 232         http://www.gnu.org/software/emacs/windows/ntemacs.html
 233
 234   This document serves as an FAQ and a source for further information
 235   about the Windows port and related software packages. Note that as
 236   of writing, most of the information in that FAQ was for Emacs-21.3
 237   and earlier versions, so some information may not be relevant to
 238   Emacs-22.2.
 239
 240   In addition to the FAQ, there is a mailing list for discussing issues
 241   related to the Windows port of Emacs.  For information about the
 242   list, see this Web page:
 243
 244         http://lists.gnu.org/mailman/listinfo/help-emacs-windows
 245
 246   To ask questions on the mailing list, send email to
 247   help-emacs-windows@gnu.org.  (You don't need to subscribe for that.)
 248   To subscribe to the list or unsubscribe from it, fill the form you
 249   find at http://mail.gnu.org/mailman/listinfo/help-emacs-windows as
 250   explained there.
 251
 252   Another valuable source of information and help which should not be
 253   overlooked is the various Usenet news groups dedicated to Emacs.
 254   These are particuarly good for help with general issues which aren't
 255   specific to the Windows port of Emacs.  The main news groups to use
 256   for seeking help are:
 257
 258         gnu.emacs.help
 259         comp.emacs
 260
 261   There are also fairly regular postings and announcements of new or
 262   updated Emacs packages on this group:
 263
 264         gnu.emacs.sources
 265
 266   Enjoy!
 267
 268   Jason Rumney
 269   (jasonr@gnu.org)
 270
 271   Most of this README was contributed by former maintainer Andrew Innes
 272   (andrewi@gnu.org)