Fix bug #14762 with insufficient and outdated w32 installation documentation.
authorEli Zaretskii <eliz@gnu.org>
Sat, 8 Feb 2014 10:25:33 +0000 (12:25 +0200)
committerEli Zaretskii <eliz@gnu.org>
Sat, 8 Feb 2014 10:25:33 +0000 (12:25 +0200)
 nt/INSTALL: Update for Emacs 24.4.
 nt/README: Update for Emacs 24.4.
 nt/README.W32: Update and improve instructions.

nt/ChangeLog
nt/INSTALL
nt/README
nt/README.W32

index d3447b5..4c20ce5 100644 (file)
@@ -1,3 +1,11 @@
+2014-02-08  Eli Zaretskii  <eliz@gnu.org>
+
+       * INSTALL: Update for Emacs 24.4.
+
+       * README: Update for Emacs 24.4.
+
+       * README.W32: Update and improve instructions.  (Bug#14762)
+
 2014-02-08  Lars Ingebrigtsen  <larsi@gnus.org>
 
        * README.W32: Say what GnuTLS and libxml2 does (bug#14762).
index 088c5f9..6262e96 100644 (file)
@@ -568,6 +568,14 @@ Windows 9X as well).
   libraries that are known to be compatible with the version given by
   `libgif-version'.
 
+  For JPEG images, you will need libjpeg 6b or later, which will be
+  called libjpeg-N.dll, jpeg62.dll, libjpeg.dll, or jpeg.dll.  You can
+  find these on the ezwinports site.
+
+  TIFF images require libTIFF 3.0 or later, which will be called
+  libtiffN.dll or libtiff-N.dll or libtiff.dll.  These can be found on
+  the ezwinports site.
+
   Pre-built versions of librsvg and its dependencies can be found in
   one of these places:
 
index bade1ce..14c89a0 100644 (file)
--- a/nt/README
+++ b/nt/README
   Building and installing Emacs will produce the following executable
   files in the bin directory.
 
-  + emacs.exe - The main Emacs executable. As this is designed to run
+  + emacs.exe - The main Emacs executable.  As this is designed to run
     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
-    without popping up a command prompt window.
+    without popping up a command prompt window.  If you create a
+    desktop shortcut for invoking Emacs, make it point to this
+    executable, not to emacs.exe.
 
   + emacsclient.exe - A command-line client program that can
-    communicate with a running Emacs process. See the `Emacs Server'
+    communicate with a running Emacs process.  See the `Emacs Server'
     node of the Emacs manual.
 
   + emacsclientw.exe - A version of emacsclient that does not open
   + addpm.exe - A basic installer that creates Start Menu icons for Emacs.
     Running this is optional.
 
-  + cmdproxy.exe - Used internally by Emacs to work around problems with
-    the native shells in various versions of Windows.
-
   + ctags.exe, etags.exe - Tools for generating tag files.  See the
-  `Tags' node of the Emacs manual.
+    `Tags' node of the Emacs manual.
 
   + ebrowse.exe - A tool for generating C++ browse information.  See the
     `Ebrowse' manual.
 
+  Several helper programs are installed 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.
+
   + 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
     supposed to be invoked via the 'call-process-region' Emacs
     primitive.
 
-  + hexl.exe - A tool for converting files to hex dumps.  See the
+  + hexl.exe - A tool for producing hex dumps of binary files.  See the
     `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.
 
+  + 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.
+
 * Further information
 
   The FAQ for the MS Windows port of Emacs is distributed with Emacs
index 4f94b60..c4e4cf3 100644 (file)
@@ -10,13 +10,14 @@ See the end of the file for license conditions.
        ftp://ftp.gnu.org/gnu/emacs/windows/
 
   This server contains other distributions, including the full Emacs
-  source distribution and a barebin distribution which can be installed
-  over it, as well as older releases of Emacs for Windows.
+  source distribution, as well as older releases of Emacs for Windows.
 
   Information on how to compile Emacs from sources on Windows is in
-  the files README and INSTALL in this directory.  If you received
-  this file as part of the Emacs source distribution, please read
-  those 2 files and not this one.
+  the files README and INSTALL in the nt/ sub-directory of the
+  top-level Emacs directory in the source distribution.  If you
+  received this file as part of the Emacs source distribution, and are
+  looking for information on how to build Emacs on MS-Windows, please
+  read those 2 files and not this one.
 
 * Preliminaries
 
@@ -26,11 +27,10 @@ See the end of the file for license conditions.
 * Setting up Emacs
 
   To install Emacs, simply unpack all the files into a directory of
-  your choice, but note that you might encounter minor problems if
-  there is a space anywhere in the directory name.  To complete the
-  installation process, you can optionally run the program addpm.exe
-  in the bin subdirectory.  This will put an icon for Emacs in the
-  Start Menu under "Start -> Programs -> Gnu Emacs".
+  your choice.  To complete the installation process, you can
+  optionally run the program addpm.exe in the bin subdirectory.  This
+  will put an icon for Emacs in the Start Menu under
+  "Start -> Programs -> Gnu Emacs".
 
   Some users have reported that the Start Menu item is not created for
   them.  If this happens, just create your own shortcut to runemacs.exe,
@@ -52,9 +52,7 @@ See the end of the file for license conditions.
   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, it will pop up a dialog saying that it cannot
-  find the library, and will refuse to start up a GUI session.
-  (However, it is still possible to use Emacs in text mode, even
-  without UNICOWS.DLL, by invoking it as "emacs -nw", see below.)
+  find the library, and will refuse to start up.
 
 * Starting Emacs
 
@@ -130,24 +128,31 @@ See the end of the file for license conditions.
 * Image support
 
   Emacs has 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.
+
+  Emacs can also support some other image formats with appropriate
   libraries.  These libraries are all available on the following sites:
 
   1. http://sourceforge.net/projects/ezwinports/files/
      -- leaner, more up-to-date builds, only for 32-bit Emacs
   2. http://www.gtk.org/download/win32.php
      http://www.gtk.org/download/win64.php
-     -- GTK project site; offers much fatter builds, but includes 64-bit
-        DLLs
+     -- the GTK project site; offers much fatter builds, but includes
+        64-bit DLLs (from the 2nd URL)
   3. GnuWin32 project -- very old builds, not recommended
 
-  Emacs will find these libraries if the directory they are installed
-  in is on the PATH.
+  The libraries to download are mentioned below.  Some libraries
+  depend on others that need to be downloaded separately from the same
+  site; please consult the download instructions on each site for the
+  details.  In general, the ezwinports site mentioned above has all
+  the dependencies bundled in the same zip archive, so installing from
+  there is the easiest.
 
-  Emacs can also support some other image formats with appropriate
-  libraries.  These libraries are all available as part of GTK
-  download for Windows (http://www.gtk.org/download/win32.php), or
-  from the GnuWin32 project.  Emacs will find them if the directory
-  they are installed in is on the PATH.
+  Emacs will find these libraries if the directory they are installed
+  in is on the PATH or in the same directory where you have emacs.exe.
+  Here are some specific comments about each image type:
 
       PNG: requires the PNG reference library 1.4 or later, which will
       be named libpngNN.dll or libpngNN-NN.dll.  LibPNG requires zlib,
@@ -161,8 +166,8 @@ See the end of the file for license conditions.
       JPEG: requires the Independent JPEG Group's libjpeg 6b or later,
       which will be called jpeg62.dll, libjpeg.dll, jpeg-62.dll or jpeg.dll.
 
-      TIFF: requires libTIFF 3.0 or later, which will be called libtiff3.dll
-      or libtiff.dll.
+      TIFF: requires libTIFF 3.0 or later, which will be called libtiffN.dll
+      or libtiff-N.dll or libtiff.dll.
 
       GIF: requires libungif or giflib 4.1 or later, which will be
       called libgif-6.dll, giflib4.dll, libungif4.dll or libungif.dll.
@@ -171,18 +176,12 @@ See the end of the file for license conditions.
       librsvg-2-2.dll.  SVG also requires several dependency DLLs,
       such as Pango, Cairo, and Glib, all of them found on the
       above-mentioned sites.  If you download from the ezwinports
-      site, you need only librsvg-2.nn.x-bin.zip, it comes with all
-      the other dependencies bundled.
+      site, you need only librsvg-2.nn.mm-x-w32-bin.zip, it comes with
+      all the other dependencies bundled.
 
    If you have image support DLLs under different names, customize the
    value of `dynamic-library-alist'.
 
-   In addition, Emacs can be compiled to support SVG.  This precompiled
-   distribution has not been compiled that way, since the SVG library
-   or one or more of its extensive dependencies appear to be
-   unreliable under Windows.  See nt/INSTALL in the src distribution if
-   you wish to compile Emacs with SVG support.
-
 * GnuTLS support
 
   GnuTLS provides SSL/TLS network support for Emacs (https, imaps and