README.W32 12.2 KB
Newer Older
Paul Eggert's avatar
Paul Eggert committed
1
Copyright (C) 2001-2020 Free Software Foundation, Inc.
2 3
See the end of the file for license conditions.

Eli Zaretskii's avatar
Eli Zaretskii committed
4
		Emacs version 28.0.50 for MS-Windows
5

6
  This README file describes how to set up and run a precompiled
7 8 9
  distribution of the latest version of GNU Emacs for MS-Windows.  You
  can find the precompiled distribution on the ftp.gnu.org server and
  its mirrors:
10

11
       https://ftp.gnu.org/gnu/emacs/windows/
12 13

  This server contains other distributions, including the full Emacs
14
  source distribution, as well as older releases of Emacs for Windows.
15

16
  Information on how to compile Emacs from sources on Windows is in
17
  the files README and INSTALL in the nt/ sub-directory of the
18
  top-level Emacs directory in the source distribution, as is this
19 20
  file under the name README.W32.  If you received this file as part
  of the Emacs source distribution, and are looking for information on
21 22
  how to build Emacs on MS-Windows, please read those 2 files and not
  this one.
23

24 25
* Preliminaries

26
  There are two binary distributions named
Phillip Lord's avatar
Phillip Lord committed
27
  emacs-VER-x86_64.zip and emacs-VER-i686.zip,
28 29 30 31 32
  where VER is the Emacs version.  These are 64-bit and 32-bit builds,
  respectively.  If you are running a 32-bit version of MS-Windows,
  you need to install the 32-bit build; users of 64-bit Windows can
  use either build, but we recommend to install the 64-bit one, as it
  will be able to edit larger buffers and will generally run faster.
33

34
  The binary distribution has these top-level directories:
35

36 37 38 39
  + bin
  + libexec
  + share
  + var
40 41 42

* Setting up Emacs

43
  To install Emacs, simply unpack the binary package into a directory
44 45 46
  of your choice.  If you use the Windows Explorer and its "Extract"
  action, by default this will be in a top-level directory with the
  same name as the zip file.
47

48 49 50 51 52
  Emacs is completely portable.  You can create your own shortcut to
  runemacs.exe and place this wherever you find it convenient (the
  desktop and/or the Taskbar), or run it from a USB or network drive
  without copying or installing anything on the machine itself.

Phillip Lord's avatar
Phillip Lord committed
53 54 55
  It is also possible, although not recommended to use the program
  bin/addpm.exe which will place an icon for Emacs on the start page.

56 57 58 59 60 61 62 63 64
* Prerequisites for Windows 9X

  The 32-bit build supports MS-Windows 9X (Windows 95/98/Me).  To run
  Emacs on these versions of Windows, you will need to have the
  Microsoft Layer for Unicode (MSLU) installed.  It can be downloaded
  from the Microsoft site, and comes in a form of a single dynamic
  library called UNICOWS.DLL.  If this library is not accessible to
  Emacs on Windows 9X, it will pop up a dialog saying that it cannot
  find the UNICOWS library, and will refuse to start up.
65 66 67 68

* Starting Emacs

  To run Emacs, simply select Emacs from the Start Menu, or invoke
69 70 71 72 73
  runemacs.exe directly from Explorer or from a command prompt.  This
  will start Emacs in its default GUI mode, ready to use.  If you have
  never used Emacs before, you should follow the tutorial at this
  point (select Emacs Tutorial from the Help menu), since Emacs is
  quite different from ordinary Windows applications in many respects.
74 75 76 77

  If you want to use Emacs in tty or character mode within a command
  window, you can start it by typing "emacs -nw" at the command prompt.
  (Obviously, you need to ensure that the Emacs bin subdirectory is in
78
  your Path first, or specify the path to emacs.exe.)  The -nw
79 80 81
  (non-windowed) mode of operation is most useful if you have a telnet
  server on your machine, allowing you to run Emacs remotely.

82 83 84 85
* EXE files included

  Emacs comes with the following executable files in the bin directory.

86
  + emacs.exe - The main Emacs executable.  As this is designed to run
87 88 89 90
    as both a text-mode application (emacs -nw) and as a GUI application,
    it will pop up a command prompt window if run directly from Explorer.

  + runemacs.exe - A wrapper for running Emacs as a GUI application
91 92
    without popping up a command prompt window.  If you create a
    desktop shortcut for invoking Emacs, make it point to this
93 94 95
    executable, not to emacs.exe.  If you pin Emacs to the task bar,
    edit the properties of the pinned shortcut (with Shift-right mouse
    click) to point to this executable.
96 97

  + emacsclient.exe - A command-line client program that can
98
    communicate with a running Emacs process.  See the `Emacs Server'
99
    node of the Emacs manual.
100 101 102 103

  + emacsclientw.exe - A version of emacsclient that does not open
    a command-line window.

104 105
  + addpm.exe - A basic installer that adds Emacs to "Start" menus and
    adds Emacs-related entries to the Windows Registry.
106 107

  + ctags.exe, etags.exe - Tools for generating tag files.  See the
108
    `Tags' node of the Emacs manual.
109 110 111 112

  + ebrowse.exe - A tool for generating C++ browse information.  See the
    `Ebrowse' manual.

113 114 115 116 117 118
  Several helper programs are in a version-specific subdirectory of
  the libexec directory:

  + cmdproxy.exe - Used internally by Emacs to work around problems with
    the native shells in various versions of Windows.

119 120 121 122 123 124
  + ddeclient.exe - A tool for interacting with DDE servers.  To be
    invoked as "ddeclient SERVER [TOPIC]", where SERVER is the DDE
    server name, and sends each line of its standard input to the DDE
    server using the DdeClientTransaction API.  This program is
    supposed to be invoked via the 'call-process-region' Emacs
    primitive.
125

126
  + hexl.exe - A tool for producing hex dumps of binary files.  See the
127 128 129 130 131 132
    `Editing Binary Files' node of the Emacs manual.

  + movemail.exe - A helper application for safely moving mail from
    a mail spool or POP server to a local user mailbox.  See the
    `Movemail' node of the Emacs manual.

133 134 135 136 137 138
  + profile.exe - A helper program that generates periodic events for
    profiling Emacs Lisp code.

  + update-game-score.exe - A utility for updating the score files of
    Emacs games.

Phillip Lord's avatar
Phillip Lord committed
139
* Emacs without optional dependencies
Jason Rumney's avatar
Jason Rumney committed
140

Phillip Lord's avatar
Phillip Lord committed
141 142
  The files emacs-VER-x86_64.zip and emacs-VER-i686.zip contain a
  large number of optional dependencies for Emacs.
143

Phillip Lord's avatar
Phillip Lord committed
144 145
  Emacs has a number of optional features which use these additional
  dependencies.  They enable support for the following:
146 147 148 149 150 151

  - displaying inline images of many types (PNG, JPEG, GIF, TIFF, SVG)
  - SSL/TLS secure network communications (HTTPS, IMAPS, etc.)
  - HTML and XML parsing (necessary for the built-in EWW browser)
  - built-in decompression of compressed text

Phillip Lord's avatar
Phillip Lord committed
152 153 154 155
  If you do not want these files (if you have them already for
  instance, or you want the smallest possible Emacs), then you may use
  the files emacs-VER-x86_64-no-deps.zip or
  emacs-VER-i686-no-deps.zip. The dependency files are also available
Phillip Lord's avatar
Phillip Lord committed
156
  as emacs-MVER-x86_64-deps.zip and emacs-MVER-i686-deps.zip. Source
Phillip Lord's avatar
Phillip Lord committed
157 158
  code for these dependencies is available as
  emacs-26-deps-mingw-w64-src.zip.
159

Phillip Lord's avatar
Phillip Lord committed
160 161 162 163 164
  All distributions of Emacs have built in support for XBM and
  PPM/PGM/PBM images, and the libXpm library is bundled, providing XPM
  support (required for color toolbar icons and splash screen).
  Source for libXpm should be available from the same place from which
  you got this binary distribution.
165

166
* Installing Emacs with an existing MSYS2 installation
167

Phillip Lord's avatar
Phillip Lord committed
168 169 170 171 172 173
  You may also use Emacs with an existing MSYS2 installation by
  unpacking the emacs-VER-x86_64-no-deps.zip over the MSYS2
  distribution. You should not use the emacs-VER-x86_64.zip from this
  site, as this will overwrite MSYS2 files (the dependency bundle
  derives from MSYS2, but will be from a different version). You can
  then use the 'pacman' utility to install dependencies.
174 175 176 177 178 179 180 181

  Some of the optional libraries need to be of certain versions to
  work with your Emacs binary.  Make sure you install those versions
  of dependencies, and no others.  Emacs variables such as
  libpng-version and libjpeg-version tell what versions of the
  corresponding libraries are expected by Emacs.  (We recommend that
  you use the dependency bundle, where these issues are always
  resolved.)
182 183 184 185 186 187 188 189 190

  To install the optional libraries, start the MSYS2 Bash window and
  type the following command:

    pacman -S PACKAGES

  where PACKAGES is the list of packages you want to install.  The
  full list is as follows:

191 192 193 194 195 196 197 198
    mingw-w64-x86_64-giflib
    mingw-w64-x86_64-gnutls
    mingw-w64-x86_64-libjpeg-turbo
    mingw-w64-x86_64-libpng
    mingw-w64-x86_64-librsvg
    mingw-w64-x86_64-libtiff
    mingw-w64-x86_64-libxml2
    mingw-w64-x86_64-xpm-nox
Phillip Lord's avatar
Phillip Lord committed
199
    mingw-w64-x86_64-lcms2
200

201 202 203 204 205 206 207 208 209 210
  You can type any subset of this list.  When asked whether to proceed
  with installation, answer Y.

  Alternatively, you could install the packages manually from this
  page:

   https://sourceforge.net/projects/msys2/files/REPOS/MINGW/x86_64/

  However, the packages there are not self-contained, so you will need
  to manually download all their dependencies as well.
211

212 213
* Uninstalling Emacs

214 215 216
  If you should need to uninstall Emacs, simply delete all the files
  and subdirectories from the directory where it was unpacked (Emacs
  does not install or update any files in system directories or
217
  anywhere else).
218

219 220
  If you ran the addpm.exe program to create the Start menu icon, this
  can be removed by right-clicking and "Uninstall".
221

222 223 224 225 226 227
  Finally, addpm.exe also creates a few registry entries; these can be
  safely left, but if you really wish to remove them, all of the
  settings are written under the Software\GNU\Emacs key in
  HKEY_LOCAL_MACHINE, or if you didn't have administrator privileges
  when you installed, the same key in HKEY_CURRENT_USER.  Just delete
  the whole Software\GNU\Emacs key.
228

229
* Troubleshooting
230

231 232 233
  Some known problems and their solutions can be found in the file
  etc\PROBLEMS in the unpacked Emacs distribution.

234 235 236 237 238 239 240
  Virus scanners

  Some virus scanners interfere with Emacs' use of subprocesses.  If you
  are unable to use subprocesses and you use Dr. Solomon's WinGuard or
  McAfee's Vshield, turn off "Scan all files" (WinGuard) or "boot sector
  scanning" (McAfee exclusion properties).

241 242 243 244 245 246
  Windows 9X

  On Windows 9X, make sure you have the UNICOWS.DLL library either in
  the same directory where you have emacs.exe or in the directory
  where system-wide DLLs are kept.

247 248
* Further information

249 250 251
  The Emacs User manual describes Windows-specific issues in the
  appendix named "Emacs and Microsoft Windows/MS-DOS".  You can read
  it in Emacs by typing
252

253
        C-h r g Microsoft Windows RET
254

255 256
  This appendix is also available (as part of the entire manual) at

Paul Eggert's avatar
Paul Eggert committed
257
        https://www.gnu.org/software/emacs/manual/html_mono/emacs.html#Microsoft-Windows
258

259 260
  In addition to the manual, there is a mailing list for help with
  Emacs here:
261

Paul Eggert's avatar
Paul Eggert committed
262
       https://lists.gnu.org/mailman/listinfo/help-gnu-emacs
263

264
  To ask questions on this mailing list, send email to
265
  help-gnu-emacs@gnu.org.
266

Paul Eggert's avatar
Paul Eggert committed
267
  A mailing list for issues specifically related to the MS-Windows port
268
  of Emacs is here:
269

Paul Eggert's avatar
Paul Eggert committed
270
	https://lists.gnu.org/mailman/listinfo/help-emacs-windows
271

272
  To ask questions on this mailing list, send email to
273
  help-emacs-windows@gnu.org.
274 275 276 277 278 279

* Reporting bugs

  If you encounter a bug in this port of Emacs, we would like to hear
  about it.  First check the FAQ on the web page above to see if the bug
  is already known and if there are any workarounds.  Then check whether
280
  the bug has something to do with code in your `.emacs' file, e.g. by
281 282 283
  invoking Emacs with the "-Q" option.

  If you decide that it is a bug in Emacs, use the built in bug
284
  reporting facility to report it (from the menu: Help -> Send Bug Report).
285 286
  If you have not yet configured Emacs for mail, then when you press
  C-c C-c to send the report, it will ask you to paste the text of the
287 288 289
  report into your mail client.  If the bug is related to subprocesses,
  also specify which shell you are using (e.g., include the values of
  `shell-file-name' and `explicit-shell-file-name' in your message).
290

Andrew Innes's avatar
Andrew Innes committed
291
  Enjoy!
292 293 294 295


This file is part of GNU Emacs.

296
GNU Emacs is free software: you can redistribute it and/or modify
297
it under the terms of the GNU General Public License as published by
298 299
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
300 301 302 303 304 305 306

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
Paul Eggert's avatar
Paul Eggert committed
307
along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.