admin/nt/README-ftp-server

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