Commit | Line | Data |
---|---|---|
31098a38 | 1 | Precompiled Distributions of |
e53925a5 | 2 | Emacs for Windows |
31098a38 | 3 | |
5f561867 | 4 | Version 22.1 |
177c0ea7 | 5 | |
5f561867 | 6 | May 22, 2007 |
e53925a5 | 7 | |
31098a38 | 8 | This directory contains source and precompiled distributions for GNU |
5f561867 JR |
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 | |
e53925a5 | 11 | Foundation; the precompiled distributions are provided here for |
5f561867 JR |
12 | convenience since the majority of Windows users are not accustomed |
13 | to compiling programs themselves. | |
31098a38 AI |
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, | |
5f561867 | 29 | if you put the emacs-22.1-bin-i386.tar.gz file from this directory on |
31098a38 | 30 | an Internet site, you must arrange to distribute the source files of |
1455e482 | 31 | the SAME version (i.e. ../emacs-22.1.tar.gz). |
31098a38 AI |
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 | ||
a7ebea8b JR |
38 | * Files in this directory |
39 | ||
40 | + emacs-22.1-bin-i386.zip | |
41 | Windows binaries of Emacs-22.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-22.1-barebin-i386.zip | |
53 | Windows binaries of Emacs-22.1, 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 | + emacs-21.3-bin-i386.tar.gz | |
64 | Windows binaries of Emacs 21.3, with compiled lisp code and some | |
65 | documentation included. | |
66 | ||
67 | This is provided for users who require the older version. | |
68 | ||
69 | + emacs-21.3-leim.tar.gz | |
70 | Compiled lisp input methods. This optional addition to Emacs-21.3 | |
71 | is required if you want to enter languages that are not directly | |
72 | supported by your keyboard. | |
73 | ||
74 | * Image support | |
75 | ||
76 | Emacs 22.1 contains support for images, however for most image formats | |
77 | supporting libraries are required. This distribution has been tested | |
78 | with the libraries that are distributed with GTK for Windows, and the | |
79 | libraries found at http://gnuwin32.sourceforge.net/. The following image | |
80 | formats are supported: | |
81 | ||
82 | PBM/PGM/PPM: Supported natively by Emacs. This format is used for | |
83 | the black and white versions of the toolbar icons. | |
84 | ||
85 | XPM: requires a Windows port of the XPM library 3.4 or later, | |
86 | which will be named xpm4.dll, libxpm-nox4.dll or | |
87 | libxpm.dll. This format is used for the color versions of the | |
88 | toolbar icons, and other images in Emacs. | |
89 | ||
90 | PNG: requires the PNG reference library 1.2 or later, which will | |
91 | be named libpng13d.dll, libpng13.dll, libpng12d.dll, libpng12.dll | |
92 | or libpng.dll. LibPNG requires zlib, which should come from the same | |
93 | source as you got libpng. | |
94 | ||
95 | JPEG: requires the Independant JPEG Group's libjpeg 6b or later, | |
96 | which will be called jpeg62.dll, libjpeg.dll, jpeg-62.dll or jpeg.dll. | |
97 | ||
98 | TIFF: requires libTIFF 3.0 or later, which will be called libtiff3.dll | |
99 | or libtiff.dll. | |
100 | ||
101 | GIF: requires libungif or giflib 4.1 or later, which will be | |
102 | called giflib4.dll, libungif4.dll or libungif.dll. | |
103 | ||
5f561867 | 104 | * Distributions in .tar.gz and .zip format |
31098a38 | 105 | |
5f561867 | 106 | Emacs is distributed primarily as source code in a large gzipped tar file |
31098a38 | 107 | (*.tar.gz). Because Emacs is quite large and therefore difficult to |
5f561867 JR |
108 | download over unreliable connections, the Windows binaries are provided |
109 | in several combinations, ranging from the complete source plus executables, | |
110 | to just the minimal amount needed to run without any source, plus a | |
111 | couple of optional packages. Formerly, we used the same .tar.gz format | |
112 | but since there are no longer legal problems with .zip files, and the | |
113 | latest versions of Windows support these natively, the Windows binaries | |
114 | of Emacs are now distributed as .zip files. | |
31098a38 | 115 | |
31098a38 AI |
116 | * Distributions for non-x86 platforms |
117 | ||
3ad0c616 JR |
118 | Distributions for non-x86 platforms are no longer supplied. Older |
119 | platforms supported by Windows NT no longer seem to be in demand, | |
120 | and Emacs is yet to be ported to 64bit Windows platforms. If you are | |
5f561867 | 121 | willing to help port Emacs 23 to 64bit versions of Windows, your |
3ad0c616 | 122 | contribution will be welcome on the emacs-devel mailing list. |
31098a38 AI |
123 | |
124 | * Unpacking distributions | |
125 | ||
5f561867 JR |
126 | Ports of GNU gzip and GNU tar for handling the source distribution file |
127 | format can be found in several places that distribute ports of GNU | |
3ad0c616 | 128 | programs, for example: |
31098a38 | 129 | |
3ad0c616 JR |
130 | Cygwin: http://www.cygwin.com/ |
131 | GnuWin32: http://gnuwin32.sourceforge.net/ | |
31098a38 | 132 | |
3ad0c616 JR |
133 | Many other popular file compression utilities for Windows are also |
134 | able to handle gzipped tar files. | |
31098a38 AI |
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 | ||
a7ebea8b | 160 | Zip files can be unpacked using unzip.exe from info-zip.org |
262be72a MB |
161 | if you do not already have other tools to do this. |
162 | ||
163 | % unzip some.zip | |
164 | ||
5f561867 JR |
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 | ||
31098a38 AI |
170 | Once you have unpacked a precompiled distribution of Emacs, it should |
171 | have the following subdirectories: | |
172 | ||
3ad0c616 | 173 | bin etc info lisp site-lisp |
e53925a5 | 174 | |
31098a38 AI |
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 | ||
5f561867 JR |
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.) | |
31098a38 AI |
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 | ||
3ad0c616 JR |
192 | + I've also had reports that some older "gnuwin32" port of tar |
193 | corrupts the executables. Use the latest version from the gnuwin32 | |
194 | site or another port of tar instead. | |
31098a38 AI |
195 | |
196 | If you believe you have unpacked the distributions correctly and are | |
197 | still encountering problems, see the section on Further Information | |
198 | below. | |
199 | ||
200 | ||
201 | * Compiling from source | |
202 | ||
203 | If you would like to compile Emacs from source, download the source | |
204 | distribution, unpack it in the same manner as a precompiled | |
3ad0c616 JR |
205 | distribution, and look in the file nt/INSTALL for detailed |
206 | directions. You can either use the Microsoft compiler included with | |
207 | Visual C++ 2003 or earlier, or GCC 2.95 or later with MinGW support, | |
208 | to compile the source. The port of GCC included in Cygwin is | |
209 | supported, but check the nt/INSTALL file if you have trouble since | |
210 | some builds of GNU make aren't supported. | |
31098a38 AI |
211 | |
212 | ||
213 | * Further information | |
214 | ||
e53925a5 AI |
215 | If you have access to the World Wide Web, I would recommend pointing |
216 | your favorite web browser to following the document (if you haven't | |
217 | already): | |
31098a38 AI |
218 | |
219 | http://www.gnu.org/software/emacs/windows/ntemacs.html | |
220 | ||
e53925a5 | 221 | This document serves as an FAQ and a source for further information |
a7ebea8b JR |
222 | about the Windows port and related software packages. Note that as |
223 | of writing, most of the information in that FAQ was for Emacs-21.3 | |
224 | and earlier versions, so some information may not be relevant to | |
225 | Emacs-22.1. | |
e53925a5 AI |
226 | |
227 | In addition to the FAQ, there is a mailing list for discussing issues | |
228 | related to the Windows port of Emacs. For information about the | |
229 | list, see this Web page: | |
230 | ||
6e3645dc | 231 | http://lists.gnu.org/mailman/listinfo/help-emacs-windows |
e53925a5 AI |
232 | |
233 | To ask questions on the mailing list, send email to | |
234 | help-emacs-windows@gnu.org. (You don't need to subscribe for that.) | |
235 | To subscribe to the list or unsubscribe from it, fill the form you | |
236 | find at http://mail.gnu.org/mailman/listinfo/help-emacs-windows as | |
237 | explained there. | |
31098a38 AI |
238 | |
239 | Another valuable source of information and help which should not be | |
240 | overlooked is the various Usenet news groups dedicated to Emacs. | |
241 | These are particuarly good for help with general issues which aren't | |
242 | specific to the Windows port of Emacs. The main news groups to use | |
243 | for seeking help are: | |
244 | ||
245 | gnu.emacs.help | |
246 | comp.emacs | |
247 | ||
248 | There are also fairly regular postings and announcements of new or | |
249 | updated Emacs packages on this group: | |
250 | ||
251 | gnu.emacs.sources | |
252 | ||
31098a38 AI |
253 | Enjoy! |
254 | ||
3ad0c616 JR |
255 | Jason Rumney |
256 | (jasonr@gnu.org) | |
257 | ||
258 | Most of this README was contributed by former maintainer Andrew Innes | |
259 | (andrewi@gnu.org) |