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