admin/nt/README-ftp-server

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