nt/README.W32

   1 Copyright (C) 2001-2015 Free Software Foundation, Inc.
   2 See the end of the file for license conditions.
   3
   4                            Emacs for Windows
   5
   6   This README.W32 file describes how to set up and run a precompiled
   7   distribution of GNU Emacs for Windows.  You can find the precompiled
   8   distribution on the ftp.gnu.org server and its mirrors:
   9
  10         ftp://ftp.gnu.org/gnu/emacs/windows/
  11
  12   This server contains other distributions, including the full Emacs
  13   source distribution, as well as older releases of Emacs for Windows.
  14
  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
  17   top-level Emacs directory in the source distribution.  If you
  18   received this file as part of the Emacs source distribution, and are
  19   looking for information on how to build Emacs on MS-Windows, please
  20   read those 2 files and not this one.
  21
  22 * Preliminaries
  23
  24   The binary distribution has these top-level directories:
  25   + bin
  26   + libexec
  27   + share
  28   + var
  29
  30 * Setting up Emacs
  31
  32   To install Emacs, simply unpack the binary package into a directory
  33   of your choice.  To complete the installation process, you can
  34   optionally run the program addpm.exe in the bin subdirectory.  This
  35   will put an icon for Emacs in the Start Menu under
  36   "Start -> Programs -> Gnu Emacs".
  37
  38   Some users have reported that the Start Menu item is not created for
  39   them.  If this happens, just create your own shortcut to runemacs.exe,
  40   eg. by dragging it on to the desktop or the Start button.
  41
  42   Note that running addpm is now an optional step; Emacs is able to
  43   locate all of its files without needing any information to be set in
  44   the environment or the registry, although such settings will still
  45   be obeyed if present.  This is convenient for running Emacs on a
  46   machine which disallows registry changes, or on which software
  47   should not be installed.  For instance, you can now run Emacs
  48   directly from a CD or USB flash drive without copying or installing
  49   anything on the machine itself.
  50
  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
  61
  62   To run Emacs, simply select Emacs from the Start Menu, or invoke
  63   runemacs.exe directly from Explorer or from a command prompt.  This
  64   will start Emacs in its default GUI mode, ready to use.  If you have
  65   never used Emacs before, you should follow the tutorial at this
  66   point (select Emacs Tutorial from the Help menu), since Emacs is
  67   quite different from ordinary Windows applications in many respects.
  68
  69   If you want to use Emacs in tty or character mode within a command
  70   window, you can start it by typing "emacs -nw" at the command prompt.
  71   (Obviously, you need to ensure that the Emacs bin subdirectory is in
  72   your PATH first, or specify the path to emacs.exe.)  The -nw
  73   (non-windowed) mode of operation is most useful if you have a telnet
  74   server on your machine, allowing you to run Emacs remotely.
  75
  76 * EXE files included
  77
  78   Emacs comes with the following executable files in the bin directory.
  79
  80   + emacs.exe - The main Emacs executable.  As this is designed to run
  81     as both a text-mode application (emacs -nw) and as a GUI application,
  82     it will pop up a command prompt window if run directly from Explorer.
  83
  84   + runemacs.exe - A wrapper for running Emacs as a GUI application
  85     without popping up a command prompt window.  If you create a
  86     desktop shortcut for invoking Emacs, make it point to this
  87     executable, not to emacs.exe.
  88
  89   + emacsclient.exe - A command-line client program that can
  90     communicate with a running Emacs process.  See the `Emacs Server'
  91     node of the Emacs manual.
  92
  93   + emacsclientw.exe - A version of emacsclient that does not open
  94     a command-line window.
  95
  96   + addpm.exe - A basic installer that creates Start Menu icons for Emacs.
  97     Running this is optional.
  98
  99   + ctags.exe, etags.exe - Tools for generating tag files.  See the
 100     `Tags' node of the Emacs manual.
 101
 102   + ebrowse.exe - A tool for generating C++ browse information.  See the
 103     `Ebrowse' manual.
 104
 105   Several helper programs are in a version-specific subdirectory of
 106   the libexec directory:
 107
 108   + cmdproxy.exe - Used internally by Emacs to work around problems with
 109     the native shells in various versions of Windows.
 110
 111   + ddeclient.exe - A tool for interacting with DDE servers.  To be
 112     invoked as "ddeclient SERVER [TOPIC]", where SERVER is the DDE
 113     server name, and sends each line of its standard input to the DDE
 114     server using the DdeClientTransaction API.  This program is
 115     supposed to be invoked via the 'call-process-region' Emacs
 116     primitive.
 117
 118   + hexl.exe - A tool for producing hex dumps of binary files.  See the
 119     `Editing Binary Files' node of the Emacs manual.
 120
 121   + movemail.exe - A helper application for safely moving mail from
 122     a mail spool or POP server to a local user mailbox.  See the
 123     `Movemail' node of the Emacs manual.
 124
 125   + profile.exe - A helper program that generates periodic events for
 126     profiling Emacs Lisp code.
 127
 128   + update-game-score.exe - A utility for updating the score files of
 129     Emacs games.
 130
 131 * Image support
 132
 133   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
 135   toolbar icons and splash screen).  Source for libXpm should be available
 136   from the same place from which you got this binary distribution.
 137
 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      -- leaner, more up-to-date builds, only for 32-bit Emacs
 143   2. http://www.gtk.org/download/win32.php
 144      http://www.gtk.org/download/win64.php
 145      -- the GTK project site; offers much fatter builds, but includes
 146         64-bit DLLs (from the 2nd URL)
 147   3. GnuWin32 project -- very old builds, not recommended
 148
 149   The libraries to download are mentioned below.  Some libraries
 150   depend on others that need to be downloaded separately from the same
 151   site; please consult the download instructions on each site for the
 152   details.  In general, the ezwinports site mentioned above has all
 153   the dependencies bundled in the same zip archive, so installing from
 154   there is the easiest.
 155
 156   Emacs will find these libraries if the directory they are installed
 157   in is on the PATH or in the same directory where you have emacs.exe.
 158   Here are some specific comments about each image type:
 159
 160       PNG: requires the PNG reference library 1.4 or later, which will
 161       be named libpngNN.dll or libpngNN-NN.dll.  LibPNG requires zlib,
 162       which should come from the same source as you got libpng.
 163       Starting with Emacs 23.3, the precompiled Emacs binaries are
 164       built with libpng 1.4.x and later, and are incompatible with
 165       earlier versions of libpng DLLs.  So if you have libpng 1.2.x,
 166       the PNG support will not work, and you will have to download
 167       newer versions.
 168
 169       JPEG: requires the Independent JPEG Group's libjpeg 6b or later,
 170       which will be called jpeg62.dll, libjpeg.dll, jpeg-62.dll or jpeg.dll.
 171
 172       TIFF: requires libTIFF 3.0 or later, which will be called libtiffN.dll
 173       or libtiff-N.dll or libtiff.dll.
 174
 175       GIF: requires libungif or giflib 4.1 or later, which will be
 176       called libgif-6.dll, giflib4.dll, libungif4.dll or libungif.dll.
 177
 178       SVG: requires librsvg 2.x whose DLL will be called
 179       librsvg-2-2.dll.  SVG also requires several dependency DLLs,
 180       such as Pango, Cairo, and Glib, all of them found on the
 181       above-mentioned sites.  If you download from the ezwinports
 182       site, you need only librsvg-2.nn.mm-x-w32-bin.zip, it comes with
 183       all the other dependencies bundled.
 184
 185    If you have image support DLLs under different names, customize the
 186    value of `dynamic-library-alist'.
 187
 188 * GnuTLS support
 189
 190   GnuTLS provides SSL/TLS network support for Emacs (https, imaps and
 191   so on.)
 192
 193   In order to support GnuTLS at runtime, Emacs must be able to find
 194   the relevant DLLs during startup; failure to do so is not an error,
 195   but GnuTLS won't be available to the running session.
 196
 197   You can get pre-built binaries (including any dependency DLLs) at
 198   http://sourceforge.net/projects/ezwinports/files/.
 199
 200 * libxml2 support
 201
 202   libxml2 provides HTML parsing support for Emacs, which is necessary
 203   to use the built-in eww browser.
 204
 205   In order to support libxml2 at runtime, a libxml2-enabled Emacs must
 206   be able to find the relevant DLLs during startup; failure to do so
 207   is not an error, but libxml2 features won't be available to the
 208   running session.
 209
 210   You can get pre-built binaries (including any required DLL and the
 211   header files) at http://sourceforge.net/projects/ezwinports/files/.
 212
 213 * Uninstalling Emacs
 214
 215   If you should need to uninstall Emacs, simply delete all the files
 216   and subdirectories from the directory where it was unpacked (Emacs
 217   does not install or update any files in system directories or
 218   anywhere else).  If you ran the addpm.exe program to create the
 219   registry entries and the Start menu icon, then you can remove the
 220   registry entries using regedit.  All of the settings are written
 221   under the Software\GNU\Emacs key in HKEY_LOCAL_MACHINE, or if you
 222   didn't have administrator privileges when you installed, the same
 223   key in HKEY_CURRENT_USER.  Just delete the whole Software\GNU\Emacs
 224   key.
 225
 226   The Start menu entry can be removed by right-clicking on the Taskbar
 227   and selecting Properties, then using the Remove option on the Start
 228   Menu Programs page.  (If you installed under an account with
 229   administrator privileges, then you need to click the Advanced button
 230   and look for the Gnu Emacs menu item under All Users.)
 231
 232 * Troubleshooting
 233
 234   Unpacking the distributions
 235
 236   If you encounter trouble trying to run Emacs, there are a number of
 237   possible causes.  Check the following for indications that the
 238   distribution was not corrupted by the tools used to unpack it:
 239
 240     * Be sure to disable CR/LF translation or the executables will
 241       be unusable.  Older versions of WinZipNT would enable this
 242       translation by default.  If you are using WinZipNT, disable it.
 243       (I don't have WinZipNT myself, and I do not know the specific
 244       commands necessary to disable it.)
 245
 246     * Check that filenames were not truncated to 8.3.  For example,
 247       there should be a file lisp\abbrevlist.elc; if this has been
 248       truncated to abbrevli.elc, your distribution has been corrupted
 249       while unpacking and Emacs will not start.
 250
 251     * On Windows 9X, make sure you have the UNICOWS.DLL library either
 252       in the same directory where you have emacs.exe or in the
 253       directory where system-wide DLLs are kept.
 254
 255   If you believe you have unpacked the distributions correctly and are
 256   still encountering problems, see the section on Further Information
 257   below.
 258
 259   Virus scanners
 260
 261   Some virus scanners interfere with Emacs' use of subprocesses.  If you
 262   are unable to use subprocesses and you use Dr. Solomon's WinGuard or
 263   McAfee's Vshield, turn off "Scan all files" (WinGuard) or "boot sector
 264   scanning" (McAfee exclusion properties).
 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 discussing
 279   issues related to the Windows port of Emacs.  For information about
 280   the list, see this Web page:
 281
 282         http://lists.gnu.org/mailman/listinfo/help-emacs-windows
 283
 284   To ask questions on the mailing list, send email to
 285   help-emacs-windows@gnu.org.  (You don't need to subscribe for that.)
 286   To subscribe to the list or unsubscribe from it, fill the form you
 287   find at http://lists.gnu.org/mailman/listinfo/help-emacs-windows as
 288   explained there.
 289
 290   Another valuable source of information and help which should not be
 291   overlooked is the various Usenet news groups dedicated to Emacs.
 292   These are particularly good for help with general issues which aren't
 293   specific to the Windows port of Emacs.  The main news groups to use
 294   for seeking help are:
 295
 296         gnu.emacs.help
 297         comp.emacs
 298
 299   There are also fairly regular postings and announcements of new or
 300   updated Emacs packages on this group:
 301
 302         gnu.emacs.sources
 303
 304 * Reporting bugs
 305
 306   If you encounter a bug in this port of Emacs, we would like to hear
 307   about it.  First check the FAQ on the web page above to see if the bug
 308   is already known and if there are any workarounds.  Then check whether
 309   the bug has something to do with code in your .emacs file, e.g. by
 310   invoking Emacs with the "-Q" option.
 311
 312   If you decide that it is a bug in Emacs, use the built in bug
 313   reporting facility to report it (from the menu; Help -> Send Bug Report).
 314   If you have not yet configured Emacs for mail, then when you press
 315   C-c C-c to send the report, it will ask you to paste the text of the
 316   report into your mail client.  If the bug is related to subprocesses,
 317   also specify which shell you are using (e.g., include the values of
 318   `shell-file-name' and `explicit-shell-file-name' in your message).
 319
 320   Enjoy!
 321
 322 \f
 323 This file is part of GNU Emacs.
 324
 325 GNU Emacs is free software: you can redistribute it and/or modify
 326 it under the terms of the GNU General Public License as published by
 327 the Free Software Foundation, either version 3 of the License, or
 328 (at your option) any later version.
 329
 330 GNU Emacs is distributed in the hope that it will be useful,
 331 but WITHOUT ANY WARRANTY; without even the implied warranty of
 332 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 333 GNU General Public License for more details.
 334
 335 You should have received a copy of the GNU General Public License
 336 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.