nt/README.W32

   1 Copyright (C) 2001-2016 Free Software Foundation, Inc.
   2 See the end of the file for license conditions.
   3
   4                 Emacs version 25.1.91 for MS-Windows
   5
   6   This README file describes how to set up and run a precompiled
   7   distribution of the latest version of GNU Emacs for MS-Windows.  You
   8   can find the precompiled distribution on the ftp.gnu.org server and
   9   its mirrors:
  10
  11        ftp://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   file under the name README.W32.  If you received this file as part
  20   of the Emacs source distribution, and are looking for information on
  21   how to build Emacs on MS-Windows, please read those 2 files and not
  22   this one.
  23
  24 * Preliminaries
  25
  26   There are two binary distributions named
  27   emacs-VER-x86_64-w64-mingw32.zip and emacs-VER-i686-w64-mingw32.zip,
  28   where VER is the Emacs version.  These are 64-bit and 32-bit builds,
  29   respectively.  If you are running a 32-bit version of MS-Windows,
  30   you need to install the 32-bit build; users of 64-bit Windows can
  31   use either build, but we recommend to install the 64-bit one, as it
  32   will be able to edit larger buffers and will generally run faster.
  33
  34   The binary distribution has these top-level directories:
  35
  36   + bin
  37   + libexec
  38   + share
  39   + var
  40
  41 * Setting up Emacs
  42
  43   To install Emacs, simply unpack the binary package into a directory
  44   of your choice.  If you use the Windows Explorer and its "Extract"
  45   action, by default this will be in a top-level directory with the
  46   same name as the zip file.
  47
  48   We also provide a set of optional dependencies, in
  49   emacs-MVER-x86_64-deps.zip or emacs-MVER-i686-deps.zip respectively,
  50   where MVER is the major Emacs version that should use these
  51   libraries.  These provide Emacs with a number of additional optional
  52   capabilities, described in detail below.  To use these, unpack them
  53   directly over the emacs directory structure.  Note that, if
  54   extracting with the Windows Explorer, you will have to override the
  55   directory where it wants to put the file with the same directory
  56   where you extracted the Emacs binary package.
  57
  58   Finally, and also optionally, you can run the program addpm.exe in
  59   the bin subdirectory which will place an icon for Emacs on the start
  60   page.  (This is no longer needed in latest versions of Emacs, so we
  61   recommend you not do that, as running addpm.exe will insert entries
  62   into the Registry which might get in the way if you upgrade to later
  63   versions without updating those entries, or would like to uninstall
  64   Emacs.)
  65
  66   Emacs is completely portable.  You can create your own shortcut to
  67   runemacs.exe and place this wherever you find it convenient (the
  68   desktop and/or the Taskbar), or run it from a USB or network drive
  69   without copying or installing anything on the machine itself.
  70
  71 * Prerequisites for Windows 9X
  72
  73   The 32-bit build supports MS-Windows 9X (Windows 95/98/Me).  To run
  74   Emacs on these versions of Windows, you will need to have the
  75   Microsoft Layer for Unicode (MSLU) installed.  It can be downloaded
  76   from the Microsoft site, and comes in a form of a single dynamic
  77   library called UNICOWS.DLL.  If this library is not accessible to
  78   Emacs on Windows 9X, it will pop up a dialog saying that it cannot
  79   find the UNICOWS library, and will refuse to start up.
  80
  81 * Starting Emacs
  82
  83   To run Emacs, simply select Emacs from the Start Menu, or invoke
  84   runemacs.exe directly from Explorer or from a command prompt.  This
  85   will start Emacs in its default GUI mode, ready to use.  If you have
  86   never used Emacs before, you should follow the tutorial at this
  87   point (select Emacs Tutorial from the Help menu), since Emacs is
  88   quite different from ordinary Windows applications in many respects.
  89
  90   If you want to use Emacs in tty or character mode within a command
  91   window, you can start it by typing "emacs -nw" at the command prompt.
  92   (Obviously, you need to ensure that the Emacs bin subdirectory is in
  93   your Path first, or specify the path to emacs.exe.)  The -nw
  94   (non-windowed) mode of operation is most useful if you have a telnet
  95   server on your machine, allowing you to run Emacs remotely.
  96
  97 * EXE files included
  98
  99   Emacs comes with the following executable files in the bin directory.
 100
 101   + emacs.exe - The main Emacs executable.  As this is designed to run
 102     as both a text-mode application (emacs -nw) and as a GUI application,
 103     it will pop up a command prompt window if run directly from Explorer.
 104
 105   + runemacs.exe - A wrapper for running Emacs as a GUI application
 106     without popping up a command prompt window.  If you create a
 107     desktop shortcut for invoking Emacs, make it point to this
 108     executable, not to emacs.exe.
 109
 110   + emacsclient.exe - A command-line client program that can
 111     communicate with a running Emacs process.  See the `Emacs Server'
 112     node of the Emacs manual.
 113
 114   + emacsclientw.exe - A version of emacsclient that does not open
 115     a command-line window.
 116
 117   + addpm.exe - A basic installer that adds Emacs to "Start" menus and
 118     adds Emacs-related entries to the Windows Registry.
 119
 120   + ctags.exe, etags.exe - Tools for generating tag files.  See the
 121     `Tags' node of the Emacs manual.
 122
 123   + ebrowse.exe - A tool for generating C++ browse information.  See the
 124     `Ebrowse' manual.
 125
 126   Several helper programs are in a version-specific subdirectory of
 127   the libexec directory:
 128
 129   + cmdproxy.exe - Used internally by Emacs to work around problems with
 130     the native shells in various versions of Windows.
 131
 132   + ddeclient.exe - A tool for interacting with DDE servers.  To be
 133     invoked as "ddeclient SERVER [TOPIC]", where SERVER is the DDE
 134     server name, and sends each line of its standard input to the DDE
 135     server using the DdeClientTransaction API.  This program is
 136     supposed to be invoked via the 'call-process-region' Emacs
 137     primitive.
 138
 139   + hexl.exe - A tool for producing hex dumps of binary files.  See the
 140     `Editing Binary Files' node of the Emacs manual.
 141
 142   + movemail.exe - A helper application for safely moving mail from
 143     a mail spool or POP server to a local user mailbox.  See the
 144     `Movemail' node of the Emacs manual.
 145
 146   + profile.exe - A helper program that generates periodic events for
 147     profiling Emacs Lisp code.
 148
 149   + update-game-score.exe - A utility for updating the score files of
 150     Emacs games.
 151
 152 * Optional dependency libraries
 153
 154   Emacs has built in support for XBM and PPM/PGM/PBM images, and the
 155   libXpm library is bundled, providing XPM support (required for color
 156   toolbar icons and splash screen).  Source for libXpm should be
 157   available from the same place from which you got this binary
 158   distribution.
 159
 160   Emacs has a number of optional features which need additional
 161   libraries.  These are provided in a separate bundle of dependencies,
 162   as described above, and enable support for the following:
 163
 164   - displaying inline images of many types (PNG, JPEG, GIF, TIFF, SVG)
 165   - SSL/TLS secure network communications (HTTPS, IMAPS, etc.)
 166   - HTML and XML parsing (necessary for the built-in EWW browser)
 167   - built-in decompression of compressed text
 168
 169   The optional dependency libraries are in emacs-MVER-x86_64-deps.zip
 170   (64-bit) and emacs-MVER-i686-deps.zip (32-bit), and their sources
 171   are in emacs-MVER-deps-mingw-w64-src.zip, where MVER is the major
 172   version of Emacs that should use these dependencies.  Note that a
 173   64-bit Emacs will only work with the 64-bit dependencies, and the
 174   32-bit Emacs only with the 32-bit dependencies.
 175
 176   Newer/updated builds for these optional libraries are available at
 177   http://msys2.github.io/ and
 178   http://sourceforge.net/projects/ezwinports/files/ (but you shouldn't
 179   need these except in emergencies).
 180
 181   If you install the libraries in a directory different from where you
 182   have the Emacs executable programs, we recommend to add the
 183   directory with DLLs to your Path, so that Emacs will be able to find
 184   those DLLs when needed.
 185
 186 * Installing Emacs with an existing MSYS2 installation
 187
 188   You may also use Emacs with an existing MSYS2 installation by simply
 189   unpacking the Emacs distribution over MSYS2.  You can then use the
 190   'pacman' utility to install dependencies.  You should not use the
 191   optional dependencies bundle from this site, as this will overwrite
 192   MSYS2 files (the dependency bundle derives from MSYS2, but may be a
 193   different version).
 194
 195   Some of the optional libraries need to be of certain versions to
 196   work with your Emacs binary.  Make sure you install those versions
 197   of dependencies, and no others.  Emacs variables such as
 198   libpng-version and libjpeg-version tell what versions of the
 199   corresponding libraries are expected by Emacs.  (We recommend that
 200   you use the dependency bundle, where these issues are always
 201   resolved.)
 202
 203   To install the optional libraries, start the MSYS2 Bash window and
 204   type the following command:
 205
 206     pacman -S PACKAGES
 207
 208   where PACKAGES is the list of packages you want to install.  The
 209   full list is as follows:
 210
 211     mingw-w64-x86_64-giflib
 212     mingw-w64-x86_64-gnutls
 213     mingw-w64-x86_64-libjpeg-turbo
 214     mingw-w64-x86_64-libpng
 215     mingw-w64-x86_64-librsvg
 216     mingw-w64-x86_64-libtiff
 217     mingw-w64-x86_64-libxml2
 218     mingw-w64-x86_64-xpm-nox
 219
 220   You can type any subset of this list.  When asked whether to proceed
 221   with installation, answer Y.
 222
 223   Alternatively, you could install the packages manually from this
 224   page:
 225
 226    https://sourceforge.net/projects/msys2/files/REPOS/MINGW/x86_64/
 227
 228   However, the packages there are not self-contained, so you will need
 229   to manually download all their dependencies as well.
 230
 231 * Uninstalling Emacs
 232
 233   If you should need to uninstall Emacs, simply delete all the files
 234   and subdirectories from the directory where it was unpacked (Emacs
 235   does not install or update any files in system directories or
 236   anywhere else).
 237
 238   If you ran the addpm.exe program to create the Start menu icon, this
 239   can be removed by right-clicking and "Uninstall".
 240
 241   Finally, addpm.exe also creates a few registry entries; these can be
 242   safely left, but if you really wish to remove them, all of the
 243   settings are written under the Software\GNU\Emacs key in
 244   HKEY_LOCAL_MACHINE, or if you didn't have administrator privileges
 245   when you installed, the same key in HKEY_CURRENT_USER.  Just delete
 246   the whole Software\GNU\Emacs key.
 247
 248 * Troubleshooting
 249
 250   Some known problems and their solutions can be found in the file
 251   etc\PROBLEMS in the unpacked Emacs distribution.
 252
 253   Virus scanners
 254
 255   Some virus scanners interfere with Emacs' use of subprocesses.  If you
 256   are unable to use subprocesses and you use Dr. Solomon's WinGuard or
 257   McAfee's Vshield, turn off "Scan all files" (WinGuard) or "boot sector
 258   scanning" (McAfee exclusion properties).
 259
 260   Windows 9X
 261
 262   On Windows 9X, make sure you have the UNICOWS.DLL library either in
 263   the same directory where you have emacs.exe or in the directory
 264   where system-wide DLLs are kept.
 265
 266 * Further information
 267
 268   The Emacs User manual describes Windows-specific issues in the
 269   appendix named "Emacs and Microsoft Windows/MS-DOS".  You can read
 270   it in Emacs by typing
 271
 272         C-h r g Microsoft Windows RET
 273
 274   This appendix is also available (as part of the entire manual) at
 275
 276         http://www.gnu.org/software/emacs/manual/html_mono/emacs.html#Microsoft-Windows
 277
 278   In addition to the manual, there is a mailing list for help with
 279   Emacs here:
 280
 281        http://lists.gnu.org/mailman/listinfo/help-gnu-emacs
 282
 283   To ask questions on this mailing list, send email to
 284   help-gnu-emacs@gnu.org.
 285
 286   A mailing list for issues specifically related to the MS-Windows port
 287   of Emacs is here:
 288
 289         http://lists.gnu.org/mailman/listinfo/help-emacs-windows
 290
 291   To ask questions on this mailing list, send email to
 292   help-emacs-windows@gnu.org.
 293
 294 * Reporting bugs
 295
 296   If you encounter a bug in this port of Emacs, we would like to hear
 297   about it.  First check the FAQ on the web page above to see if the bug
 298   is already known and if there are any workarounds.  Then check whether
 299   the bug has something to do with code in your `.emacs' file, e.g. by
 300   invoking Emacs with the "-Q" option.
 301
 302   If you decide that it is a bug in Emacs, use the built in bug
 303   reporting facility to report it (from the menu: Help -> Send Bug Report).
 304   If you have not yet configured Emacs for mail, then when you press
 305   C-c C-c to send the report, it will ask you to paste the text of the
 306   report into your mail client.  If the bug is related to subprocesses,
 307   also specify which shell you are using (e.g., include the values of
 308   `shell-file-name' and `explicit-shell-file-name' in your message).
 309
 310   Enjoy!
 311
 312 \f
 313 This file is part of GNU Emacs.
 314
 315 GNU Emacs is free software: you can redistribute it and/or modify
 316 it under the terms of the GNU General Public License as published by
 317 the Free Software Foundation, either version 3 of the License, or
 318 (at your option) any later version.
 319
 320 GNU Emacs is distributed in the hope that it will be useful,
 321 but WITHOUT ANY WARRANTY; without even the implied warranty of
 322 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 323 GNU General Public License for more details.
 324
 325 You should have received a copy of the GNU General Public License
 326 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.