aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPhillip Lord2016-11-04 20:50:55 +0000
committerPhillip Lord2016-11-04 20:50:55 +0000
commitd8fac734e563df1169e3d8d715cca3481dfec8ac (patch)
treef812a1ba70770be38958db3a7ed9bff76dc553eb
parent23570fd995a1a5586c85b440d552ec5b6077ed39 (diff)
downloademacs-d8fac734e563df1169e3d8d715cca3481dfec8ac.tar.gz
emacs-d8fac734e563df1169e3d8d715cca3481dfec8ac.zip
Update README for precompiled windows Emacs.
* nt/README.W32: Describe 64 and 32-bit downloads, optional dependencies bundle. Remove old material on sourcing dependencies. Remove references to Windows 95. Update GUI references to recent Windows. Remove references to Usenet.
-rw-r--r--nt/README.W32292
1 files changed, 70 insertions, 222 deletions
diff --git a/nt/README.W32 b/nt/README.W32
index 5bd87962650..4149c3b65b5 100644
--- a/nt/README.W32
+++ b/nt/README.W32
@@ -3,24 +3,30 @@ See the end of the file for license conditions.
3 3
4 Emacs for Windows 4 Emacs for Windows
5 5
6 This README.W32 file describes how to set up and run a precompiled 6 This README file describes how to set up and run a precompiled
7 distribution of GNU Emacs for Windows. You can find the precompiled 7 distribution of GNU Emacs for Windows. You can find the precompiled
8 distribution on the ftp.gnu.org server and its mirrors: 8 distribution on the ftp.gnu.org server and its mirrors:
9 9
10 ftp://ftp.gnu.org/gnu/emacs/windows/ 10 ftp://ftp.gnu.org/gnu/emacs/windows/
11 11
12 This server contains other distributions, including the full Emacs 12 This server contains other distributions, including the full Emacs
13 source distribution, as well as older releases of Emacs for Windows. 13 source distribution, as well as older releases of Emacs for Windows.
14 14
15 Information on how to compile Emacs from sources on Windows is in 15 Information on how to compile Emacs from sources on Windows is in
16 the files README and INSTALL in the nt/ sub-directory of the 16 the files README and INSTALL in the nt/ sub-directory of the
17 top-level Emacs directory in the source distribution. If you 17 top-level Emacs directory in the source distribution, as is this
18 received this file as part of the Emacs source distribution, and are 18 file as README.precompiled. If you received this file as part of
19 looking for information on how to build Emacs on MS-Windows, please 19 the Emacs source distribution, and are looking for information on
20 read those 2 files and not this one. 20 how to build Emacs on MS-Windows, please read those 2 files and not
21 this one.
21 22
22* Preliminaries 23* Preliminaries
23 24
25 There are two binary distributions named
26 emacs-n-x86_64-w64-mingw32.zip and
27 emacs-n-i686-w64-mingw32.zip. These are for 64-bit and 32-bit
28 machines respectively.
29
24 The binary distribution has these top-level directories: 30 The binary distribution has these top-level directories:
25 + bin 31 + bin
26 + libexec 32 + libexec
@@ -30,33 +36,24 @@ See the end of the file for license conditions.
30* Setting up Emacs 36* Setting up Emacs
31 37
32 To install Emacs, simply unpack the binary package into a directory 38 To install Emacs, simply unpack the binary package into a directory
33 of your choice. To complete the installation process, you can 39 of your choice. If you use File Explorer and "Extract" by default
34 optionally run the program addpm.exe in the bin subdirectory. This 40 this will be in a top-level directory with the same name as the zip
35 will put an icon for Emacs in the Start Menu under 41 file.
36 "Start -> Programs -> Gnu Emacs". 42
37 43 We also provide a set of optional dependencies, in
38 Some users have reported that the Start Menu item is not created for 44 emacs-25-x86_64-deps.zip or emacs-25-i686-deps.zip respectively,
39 them. If this happens, just create your own shortcut to runemacs.exe, 45 which provide Emacs with an number of additional capabilities. To
40 eg. by dragging it on to the desktop or the Start button. 46 add these, unpack them directly over the emacs directory structure.
41 47
42 Note that running addpm is now an optional step; Emacs is able to 48 Finally, and also optionally, you can run the program addpm.exe in
43 locate all of its files without needing any information to be set in 49 the bin subdirectory which will place an icon for Emacs on the start
44 the environment or the registry, although such settings will still 50 page.
45 be obeyed if present. This is convenient for running Emacs on a 51
46 machine which disallows registry changes, or on which software 52 Emacs is completely portable. You can create your own shortcut to
47 should not be installed. For instance, you can now run Emacs 53 runemacs.exe and place this where ever you find it convienient, or
48 directly from a CD or USB flash drive without copying or installing 54 run it from a USB or network drive without copying or installing
49 anything on the machine itself. 55 anything on the machine itself.
50 56
51* Prerequisites for Windows 9X
52
53 To run Emacs on Windows 9X (Windows 95/98/Me), you will need to have
54 the Microsoft Layer for Unicode (MSLU) installed. It can be
55 downloaded from the Microsoft site, and comes in a form of a single
56 dynamic library called UNICOWS.DLL. If this library is not
57 accessible to Emacs, it will pop up a dialog saying that it cannot
58 find the library, and will refuse to start up.
59
60* Starting Emacs 57* Starting Emacs
61 58
62 To run Emacs, simply select Emacs from the Start Menu, or invoke 59 To run Emacs, simply select Emacs from the Start Menu, or invoke
@@ -93,8 +90,7 @@ See the end of the file for license conditions.
93 + emacsclientw.exe - A version of emacsclient that does not open 90 + emacsclientw.exe - A version of emacsclient that does not open
94 a command-line window. 91 a command-line window.
95 92
96 + addpm.exe - A basic installer that creates Start Menu icons for Emacs. 93 + addpm.exe - The installer that adds Emacs to "Start".
97 Running this is optional.
98 94
99 + ctags.exe, etags.exe - Tools for generating tag files. See the 95 + ctags.exe, etags.exe - Tools for generating tag files. See the
100 `Tags' node of the Emacs manual. 96 `Tags' node of the Emacs manual.
@@ -128,128 +124,26 @@ See the end of the file for license conditions.
128 + update-game-score.exe - A utility for updating the score files of 124 + update-game-score.exe - A utility for updating the score files of
129 Emacs games. 125 Emacs games.
130 126
131* Image support 127* Optional Dependencies
132 128
133 Emacs has built in support for XBM and PPM/PGM/PBM images, and the 129 Emacs has built in support for XBM and PPM/PGM/PBM images, and the
134 libXpm library is bundled, providing XPM support (required for color 130 libXpm library is bundled, providing XPM support (required for color
135 toolbar icons and splash screen). Source for libXpm should be available 131 toolbar icons and splash screen). Source for libXpm should be
136 from the same place from which you got this binary distribution. 132 available from the same place from which you got this binary
137 133 distribution.
138 Emacs can also support some other image formats with appropriate
139 libraries. These libraries are all available on the following sites:
140
141 1. http://sourceforge.net/projects/ezwinports/files/
142 -- up-to-date builds, self-contained archives, only for 32-bit Emacs
143 2. Libraries from the MSYS2 project on ftp.gnu.org:
144 http://ftp.gnu.org/gnu/emacs/windows/emacs-NN-i686-deps.zip (32-bit)
145 http://ftp.gnu.org/gnu/emacs/windows/emacs-NN-x86_64-deps.zip (64-bit)
146 where NN is the Emacs version to which the libraries correspond.
147 3. The MSYS2 project -- for 64-bit Emacs:
148 http://msys2.github.io/
149 https://sourceforge.net/projects/msys2/files/REPOS/MINGW/x86_64/
150 4. GnuWin32 project -- very old 32-bit builds, not recommended
151
152 The libraries to download are mentioned below. Some libraries
153 depend on others that need to be downloaded separately from the same
154 site; please consult the download instructions on each site for the
155 details. In general, the ezwinports site mentioned above has all
156 the dependencies bundled in the same zip archive, so installing from
157 there is the easiest. For MSYS2 builds, we recommend that you
158 install and use the 'pacman' utility (available from the MSYS2
159 site), see the instructions below -- it will automatically install
160 all the dependencies.
161
162 Emacs will find these libraries if the directory they are installed
163 in is on the PATH or in the same directory where you have emacs.exe.
164 Here are some specific comments about each image type:
165
166 PNG: requires the PNG reference library 1.4 or later, which will
167 be named libpngNN.dll or libpngNN-NN.dll. LibPNG requires zlib,
168 which should come from the same source as you got libpng.
169 Starting with Emacs 23.3, the precompiled Emacs binaries are
170 built with libpng 1.4.x and later, and are incompatible with
171 earlier versions of libpng DLLs. So if you have libpng 1.2.x,
172 the PNG support will not work, and you will have to download
173 newer versions.
174
175 JPEG: requires the Independent JPEG Group's libjpeg 6b or later,
176 which will be called jpeg62.dll, libjpeg.dll, jpeg-62.dll or jpeg.dll.
177
178 TIFF: requires libTIFF 3.0 or later, which will be called libtiffN.dll
179 or libtiff-N.dll or libtiff.dll.
180
181 GIF: requires libungif or giflib 4.1 or later, which will be
182 called libgif-6.dll, giflib4.dll, libungif4.dll or libungif.dll.
183
184 SVG: requires librsvg 2.x whose DLL will be called
185 librsvg-2-2.dll. SVG also requires several dependency DLLs,
186 such as Pango, Cairo, and Glib, all of them found on the
187 above-mentioned sites. If you download from the ezwinports
188 site, you need only librsvg-2.nn.mm-x-w32-bin.zip, it comes with
189 all the other dependencies bundled.
190
191 If you have image support DLLs under different names, customize the
192 value of `dynamic-library-alist'.
193
194* GnuTLS support
195
196 GnuTLS provides SSL/TLS network support for Emacs (https, imaps and
197 so on.)
198
199 In order to support GnuTLS at runtime, Emacs must be able to find
200 the relevant DLLs during startup; failure to do so is not an error,
201 but GnuTLS won't be available to the running session.
202
203 You can get pre-built binaries (including any dependency DLLs) at
204 http://sourceforge.net/projects/ezwinports/files/ and on
205 http://ftp.gnu.org/gnu/emacs/windows/
206
207* libxml2 support
208
209 libxml2 provides HTML parsing support for Emacs, which is necessary
210 to use the built-in eww browser.
211
212 In order to support libxml2 at runtime, a libxml2-enabled Emacs must
213 be able to find the relevant DLLs during startup; failure to do so
214 is not an error, but libxml2 features won't be available to the
215 running session.
216
217 You can get pre-built binaries (including any required DLL and the
218 header files) at http://sourceforge.net/projects/ezwinports/files/ and
219 http://ftp.gnu.org/gnu/emacs/windows/
220
221* zlib support
222
223 zlib provides support for decompressing text, which is necessary for
224 the zlib-decompress-region primitive.
225 134
226 Prebuilt binaries of zlib DLL (for 32-bit builds of Emacs) are 135 In addition, as described, there is a separate dependency bundle
227 available from the ezwinports site and on ftp.gnu.org; see above for 136 providing support for many images formats, TLS, XML parsing and
228 the URLs. For the 64-bit DLL, see the instructions below for 137 compression.
229 installing from MSYS2 site.
230 138
231 (This library is also a prerequisite for several image libraries, so 139* Installing with an existing MSYS2 installation.
232 you may already have it; look for zlib1.dll or libz-1.dll.)
233 140
234* Installing 64-bit optional libraries from the MSYS2 site 141 You may also use Emacs with an existing MSYS2 installation by simply
235 142 unpacking the Emacs distribution over MSYS2. You can then use the
236 We recommend that you use the 'pacman' utility to download the 143 'pacman' utility to install dependencies. You should not use the
237 libraries you need and all of their dependencies. If you don't have 144 optional dependencies bundle, as this will overwrite MSYS2 files
238 'pacman' installed, proceed as follows: 145 (the dependency bundle derives from MSYS2, but may be a different
239 146 version).
240 . Install the MSYS2 64-bit (x86_64) installer, named
241 msys2-x86_64-YYYYMMDD.exe (where "YYYYMMDD" is the release date,
242 like 20160205) from http://msys2.github.io/.
243
244 . Run the installer, select the installation directory, make sure
245 "Run MSYS2 now" checkbox is checked, and click "Finish". A Bash
246 window will open.
247
248 . Type into the Bash window the following command:
249
250 pacman -Sy pacman
251
252 When asked whether to proceed with installation, type Y.
253 147
254 To install the optional libraries, start the MSYS2 Bash window and 148 To install the optional libraries, start the MSYS2 Bash window and
255 type the following command: 149 type the following command:
@@ -259,72 +153,36 @@ See the end of the file for license conditions.
259 where PACKAGES is the list of packages you want to install. The 153 where PACKAGES is the list of packages you want to install. The
260 full list is as follows: 154 full list is as follows:
261 155
262 mingw-w64-x86_64-xpm-nox mingw-w64-x86_64-libtiff mingw-w64-x86_64-giflib 156 mingw-w64-x86_64-giflib
263 mingw-w64-x86_64-libpng mingw-w64-x86_64-libjpeg-turbo 157 mingw-w64-x86_64-gnutls
264 mingw-w64-x86_64-librsvg mingw-w64-x86_64-libxml2 mingw-w64-x86_64-gnutls 158 mingw-w64-x86_64-libjpeg-turbo
265 mingw-w64-x86_64-zlib 159 mingw-w64-x86_64-libpng
160 mingw-w64-x86_64-librsvg
161 mingw-w64-x86_64-libtiff
162 mingw-w64-x86_64-libxml2
163 mingw-w64-x86_64-xpm-nox
266 164
267 You can type any subset of this list. Once again, when asked 165 You can type any subset of this list. Once again, when asked
268 whether to proceed with installation, answer Y. 166 whether to proceed with installation, answer Y.
269 167
270 Alternatively, you could install the packages manually from this
271 page:
272
273 https://sourceforge.net/projects/msys2/files/REPOS/MINGW/x86_64/
274
275 However, the packages there are not self-contained, so you will need
276 to download all their dependencies as well.
277
278 After the installation, if you will be installing Emacs in a
279 directory different from where the DLLs were installed, we recommend
280 to add the directory with DLLs to your PATH, so that Emacs will be
281 able to find those DLLs.
282
283* Uninstalling Emacs 168* Uninstalling Emacs
284 169
285 If you should need to uninstall Emacs, simply delete all the files 170 If you should need to uninstall Emacs, simply delete all the files
286 and subdirectories from the directory where it was unpacked (Emacs 171 and subdirectories from the directory where it was unpacked (Emacs
287 does not install or update any files in system directories or 172 does not install or update any files in system directories or
288 anywhere else). If you ran the addpm.exe program to create the 173 anywhere else).
289 registry entries and the Start menu icon, then you can remove the
290 registry entries using regedit. All of the settings are written
291 under the Software\GNU\Emacs key in HKEY_LOCAL_MACHINE, or if you
292 didn't have administrator privileges when you installed, the same
293 key in HKEY_CURRENT_USER. Just delete the whole Software\GNU\Emacs
294 key.
295
296 The Start menu entry can be removed by right-clicking on the Taskbar
297 and selecting Properties, then using the Remove option on the Start
298 Menu Programs page. (If you installed under an account with
299 administrator privileges, then you need to click the Advanced button
300 and look for the Gnu Emacs menu item under All Users.)
301 174
302* Troubleshooting 175 If you ran the addpm.exe program to create the Start menu icon, this
303 176 can be removed by right-clicking and "Uninstall".
304 Unpacking the distributions
305
306 If you encounter trouble trying to run Emacs, there are a number of
307 possible causes. Check the following for indications that the
308 distribution was not corrupted by the tools used to unpack it:
309
310 * Be sure to disable CR/LF translation or the executables will
311 be unusable. Older versions of WinZipNT would enable this
312 translation by default. If you are using WinZipNT, disable it.
313 (I don't have WinZipNT myself, and I do not know the specific
314 commands necessary to disable it.)
315
316 * Check that filenames were not truncated to 8.3. For example,
317 there should be a file lisp\abbrevlist.elc; if this has been
318 truncated to abbrevli.elc, your distribution has been corrupted
319 while unpacking and Emacs will not start.
320 177
321 * On Windows 9X, make sure you have the UNICOWS.DLL library either 178 Finally, addpm.exe also creates a few registry entries; these can be
322 in the same directory where you have emacs.exe or in the 179 safely left, but if you really wish to remove them, all of the
323 directory where system-wide DLLs are kept. 180 settings are written under the Software\GNU\Emacs key in
181 HKEY_LOCAL_MACHINE, or if you didn't have administrator privileges
182 when you installed, the same key in HKEY_CURRENT_USER. Just delete
183 the whole Software\GNU\Emacs key.
324 184
325 If you believe you have unpacked the distributions correctly and are 185* Troubleshooting
326 still encountering problems, see the section on Further Information
327 below.
328 186
329 Virus scanners 187 Virus scanners
330 188
@@ -345,31 +203,21 @@ See the end of the file for license conditions.
345 203
346 http://www.gnu.org/software/emacs/manual/html_mono/emacs.html#Microsoft-Windows 204 http://www.gnu.org/software/emacs/manual/html_mono/emacs.html#Microsoft-Windows
347 205
348 In addition to the manual, there is a mailing list for discussing 206 In addition to the manual, there is a mailing list for help with
349 issues related to the Windows port of Emacs. For information about 207 Emacs here:
350 the list, see this Web page:
351 208
352 http://lists.gnu.org/mailman/listinfo/help-emacs-windows 209 https://lists.gnu.org/mailman/listinfo/help-gnu-emacs
353 210
354 To ask questions on the mailing list, send email to 211 To ask questions on the mailing list, send email to
355 help-emacs-windows@gnu.org. (You don't need to subscribe for that.) 212 help-gnu-emacs@gnu.org.
356 To subscribe to the list or unsubscribe from it, fill the form you
357 find at http://lists.gnu.org/mailman/listinfo/help-emacs-windows as
358 explained there.
359
360 Another valuable source of information and help which should not be
361 overlooked is the various Usenet news groups dedicated to Emacs.
362 These are particularly good for help with general issues which aren't
363 specific to the Windows port of Emacs. The main news groups to use
364 for seeking help are:
365 213
366 gnu.emacs.help 214 And a more specific one for issues related to the Windows port of
367 comp.emacs 215 Emacs. For information about the list, see this Web page:
368 216
369 There are also fairly regular postings and announcements of new or 217 http://lists.gnu.org/mailman/listinfo/help-emacs-windows
370 updated Emacs packages on this group:
371 218
372 gnu.emacs.sources 219 To ask questions on the mailing list, send email to
220 help-emacs-windows@gnu.org.
373 221
374* Reporting bugs 222* Reporting bugs
375 223