admin/nt/README-ftp-server

   1                       Precompiled Distributions of
   2                            Emacs for Windows
   3
   4                               Version 21.3
   5
   6                              April 22, 2003
   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 part
  10   of the standard GNU Emacs distribution from the Free Software
  11   Foundation; the precompiled distributions are provided here for
  12   convenience since, unlike Unix, the majority of Windows users do not
  13   have access to a compiler (and, besides, do you really want to compile
  14   Emacs when you don't have to?).
  15
  16   If you have access to the World Wide Web, I would recommend pointing
  17   your favorite web browser to the following document (if you haven't
  18   already):
  19
  20         http://www.gnu.org/software/emacs/windows/ntemacs.html
  21
  22   The above web document is a far more complete version of this README
  23   file.  If you don't have access to the Web, however, then read on.
  24
  25
  26 * IMPORTANT LEGAL REMINDER
  27
  28   If you want to redistribute any of the precompiled distributions of
  29   Emacs, be careful to check the implications of the GPL.  For instance,
  30   if you put the emacs-21.3-bin-i386.tar.gz file from this directory on
  31   an Internet site, you must arrange to distribute the source files of
  32   the SAME version (i.e. emacs-21.3-src.tar.gz).
  33
  34   Making a link to our copy of the source is NOT sufficient, since we
  35   might upgrade to a new version while you are still distributing the
  36   old binaries.
  37
  38
  39 * Distributions in .tar.gz format
  40
  41   Emacs is distributed primarily as a set of large gzipped tar files
  42   (*.tar.gz).  Because Emacs is quite large and therefore difficult to
  43   download over unreliable connections, it is provided in several
  44   combinations, ranging from the complete source plus executables, to
  45   just the minimal amount needed to run without any source, plus a
  46   couple of optional packages.  Here are the combinations (i386 in the
  47   name indicates a tarball contains executables compiled for
  48   Intel-compatible x86 systems):
  49
  50   + Primary precompiled distribution, including lisp source:
  51
  52       emacs-21.3-fullbin-i386.tar.gz
  53
  54   + Minimal precompiled distribution, which excludes lisp source:
  55
  56       emacs-21.3-bin-i386.tar.gz
  57
  58     You can download emacs-21.3-lisp.tar.gz to get the lisp source, if
  59     you later decide you want it - it is useful for understanding how
  60     packages work, and how they can best be setup or customized.
  61
  62
  63   NB. If you just want to run Emacs, get one of the distributions above.
  64
  65
  66   + Bare executables, only useful if you want to get the complete source
  67     release below, but can't compile Emacs yourself:
  68
  69       emacs-21.3-barebin-i386.tar.gz  (requires emacs-21.3-src.tar.gz)
  70
  71   + Undumped executable, only needed for rebuilding Emacs after changing
  72     certain core lisp files:
  73
  74       emacs-21.3-undumped-i386.tar.gz
  75
  76   + Optional package providing the Library of Emacs Input Methods for
  77     typing non-ascii characters, notably Chinese, Japanese and Korean,
  78     but also including European and other character sets:
  79
  80       emacs-21.3-leim.tar.gz
  81
  82   + The complete official source for Emacs:
  83
  84       emacs-21.3-src.tar.gz
  85
  86   + The complete official source for LEIM:
  87
  88       leim-21.3-src.tar.gz
  89
  90
  91 * Distributions in multi-file .zip format
  92
  93   A second distribution in the form of multiple small .zip files is also
  94   provided, for the benefit of people who have unreliable internet
  95   connections, or who need to copy the distribution onto floppy disks:
  96
  97       em213b*.zip
  98
  99   This is equivalent to getting emacs-21.3-bin-i386.tar.gz above.
 100   The lisp source is available as em213l*.zip.
 101
 102
 103 * Distributions for non-x86 platforms
 104
 105   I try to make this port available for all platforms supported by
 106   Windows (it should build on all supported Windows NT/9x platforms).
 107   However, I do not always have access to non-x86 platforms, and so I
 108   cannot guarantee to provide precompiled distributions for the other
 109   platforms myself.  If you find there are no binaries for your
 110   platform, and you have access to a Microsoft compiler, then you can
 111   download the source and compile Emacs yourself (and, if you do, please
 112   consider contributing your executables; send me mail and we can make
 113   arrangements for making them available on this ftp server.)
 114
 115
 116 * Unpacking distributions
 117
 118   Programs for handling the distribution file formats can be found in
 119   the utilities directory:
 120
 121     ftp://ftp.gnu.org/gnu/windows/emacs/utilities
 122
 123   For gzipped tar files, you will need either gunzip.exe and tar.exe
 124   together, or djtarnt.exe.  djtarnt.exe can also unpack .zip files.  I
 125   strongly urge you to use these utilities since they were the ones used
 126   to create the distributions; the most common problem people have in
 127   trying to get Emacs to run is due to some other utility program
 128   corrupting the distribution while unpacking.
 129
 130   Open a command prompt (MSDOS) window.  Decide on a directory in which
 131   to place Emacs.  Move the distribution to that directory, and then
 132   unpack it as follows.
 133
 134   If you have the gzipped tar version, use gunzip to uncompress the tar
 135   file on the fly, and pipe the output through tar with the "xvf" flags
 136   to extract the files from the tar file:
 137
 138     % gunzip -c some.tar.gz | tar xvf -
 139
 140   You may see messages from tar about not being able to change the
 141   modification time on directories, and from gunzip complaining about a
 142   broken pipe.  These messages are harmless and you can ignore them.  On
 143   Windows NT, unpacking tarballs this way leaves them in compressed
 144   form, taking up less space on disk.  Unfortunately, on Windows 95 and
 145   98, a large temporary file is created, so it is better to use the
 146   djtarnt.exe program, which performs the equivalent operation in one
 147   step:
 148
 149     % djtarnt -x some.tar.gz
 150
 151   You may be prompted to rename or overwrite directories when using
 152   djtarnt: simply type return to continue (this is harmless).
 153
 154   If you have the multi-file .zip distribution, use djtarnt to unpack
 155   all of the .zip files:
 156
 157     % djtarnt -x *.zip
 158
 159   Once you have unpacked a precompiled distribution of Emacs, it should
 160   have the following subdirectories:
 161
 162         bin     etc     info    lisp    lock    site-lisp
 163
 164   If your utility failed to create the lock directory, then you can
 165   simply create it by hand (it is initially empty).
 166
 167   One final step is needed only when installing from the multi-file .zip
 168   distribution, in order to recreate emacs.exe from its fragments (it is
 169   too big to fit on a floppy even when zipped):
 170
 171     % cd emacs-21.3\bin
 172     % stitch
 173
 174
 175 * Unpacking with other tools
 176
 177   If you do use other utility programs to unpack the distribution, check
 178   the following to be sure the distribution was not corrupted:
 179
 180   + Be sure to disable the CR/LF translation or the executables will be
 181     unusable.  Older versions of WinZipNT would enable this translation
 182     by default.  If you are using WinZipNT, disable it.  (I don't have
 183     WinZipNT myself, and I do not know the specific commands necessary
 184     to disable it.)
 185
 186   + Check that filenames were not truncated to 8.3.  For example, there
 187     should be a file lisp/abbrevlist.el; if this has been truncated to
 188     abbrevli.el, your distribution has been corrupted while unpacking
 189     and Emacs will not start.
 190
 191   + I've been told that some utilities (WinZip again?) don't create the
 192     lock subdirectory.  The lock subdirectory needs to be created.
 193
 194   + I've also had reports that the "gnu-win32" port of tar corrupts the
 195     executables.  Use the version of tar or djtarnt in the utilities
 196     directory instead.
 197
 198   If you believe you have unpacked the distributions correctly and are
 199   still encountering problems, see the section on Further Information
 200   below.
 201
 202
 203 * Compiling from source
 204
 205   If you would like to compile Emacs from source, download the source
 206   distribution, unpack it in the same manner as a precompiled
 207   distribution, and look in the file nt/INSTALL for detailed directions.
 208   You can either use the Microsoft compiler included with Visual C++, or
 209   GCC 2.95 or later with MinGW support, to compile the source.  The port
 210   of GCC included in Cygwin is supported, but check the nt/INSTALL file
 211   if you have trouble since some builds of GNU make aren't supported.
 212
 213
 214 * Further information
 215
 216   If you have access to the World Wide Web, I would recommend pointing
 217   your favorite web browser to following the document (if you haven't
 218   already):
 219
 220         http://www.gnu.org/software/emacs/windows/ntemacs.html
 221
 222   This document serves as an FAQ and a source for further information
 223   about the Windows port and related software packages.
 224
 225   In addition to the FAQ, there is a mailing list for discussing issues
 226   related to the Windows port of Emacs.  For information about the
 227   list, see this Web page:
 228
 229         http://mail.gnu.org/mailman/listinfo/help-emacs-windows
 230
 231   To ask questions on the mailing list, send email to
 232   help-emacs-windows@gnu.org.  (You don't need to subscribe for that.)
 233   To subscribe to the list or unsubscribe from it, fill the form you
 234   find at http://mail.gnu.org/mailman/listinfo/help-emacs-windows as
 235   explained there.
 236
 237   Another valuable source of information and help which should not be
 238   overlooked is the various Usenet news groups dedicated to Emacs.
 239   These are particuarly good for help with general issues which aren't
 240   specific to the Windows port of Emacs.  The main news groups to use
 241   for seeking help are:
 242
 243         gnu.emacs.help
 244         comp.emacs
 245
 246   There are also fairly regular postings and announcements of new or
 247   updated Emacs packages on this group:
 248
 249         gnu.emacs.sources
 250
 251   Enjoy!
 252
 253   Andrew Innes
 254   (andrewi@gnu.org)