		 Emacs for Windows NT and Windows 95/98
			   Version 20.3.1

			  August 26, 1998
		
This README file describes how to set up and run a precompiled version
of GNU Emacs for Windows NT and Windows 95/98.  This distribution can
be found on the ftp server:

	ftp://ftp.cs.washington.edu/pub/ntemacs/20.3

This server contains other distributions, including the full Emacs
source distribution and the lisp source distribution.

Further information about this port of GNU Emacs and related software
packages can be found via http or ftp:

	http://www.cs.washington.edu/homes/voelker/ntemacs.html
	ftp://ftp.cs.washington.edu/pub/ntemacs/docs/ntemacs.html

* Preliminaries

Along with this file should be six subdirectories (bin, etc, info,
lisp, lock, site-lisp).  In the past, the lisp subdirectory has
contained both the elisp source and compiled lisp files.  To make the
precompiled distribution smaller, the lisp subdirectory now only
contains the compiled lisp files.  You can obtain the elisp source by
downloading the lisp source distribution or the full source
distribution from the ftp site mentioned above.

* Setting up Emacs

Let's assume that the directory in which you have unpacked Emacs is
c:\emacs (note that it can be anything you want it to be).  First, you
will want to run the program bin\addpm.exe, giving the Emacs directory
as an optional argument (in case addpm.exe is not in the Emacs bin
directory that you are installing from).  In this example, both
of the following do the same thing:

	c:\emacs\bin\addpm.exe
	c:\emacs\bin\addpm.exe c:\emacs

First, addpm will create a set of registry keys that tell Emacs where
to find its support files (lisp, info, etc.).  Second, it will create
a folder containing an icon linked to runemacs.exe (a wrapper program
for invoking Emacs), as well as the Start Menu item
"Start->Programs->Gnu Emacs".  Some users have reported that the Start
Menu item is not created for them.  If this happens, addpm should
still be updating the registry, so you can create your own links to
runemacs.exe and Emacs should run.

To run Emacs, simply click on the icon in the newly created folder,
select the Emacs Start Menu item, or invoke runemacs.exe from a
command prompt.

* An alternative

Another alternative for running Emacs is to use the emacs.bat batch
file in the bin directory (this was the old method of invoking Emacs).
Edit the emacs.bat file to change the emacs_dir environment variable
to point to the Emacs installation directory and invoke the emacs.bat
file to run Emacs.

Note that, on Win95/98, you are likely to get "Out of environment
space" messages when invoking the emacs.bat batch file.  The problem
is that the console process in which the script is executed runs out
of memory in which to create the Emacs environment variables.  To get
around this problem, create a shortcut icon to the emacs.bat script.
Then right click on the icon and select Properties.  In the dialog box
that pops up, select the Memory tab and then change the Environment
memory allocation from "Auto" to "1024".  Close the dialog box and
then double click on the icon to start Emacs.

* Troubleshooting

Unpacking the distributions

If you encounter trouble trying to run Emacs, there are a number of
possible causes.  If you didn't use the versions of tar and gunzip on
the above ftp site, it is possible that the distribution became
corrupted while it was being unpacked.  Check the following for
indications that the distribution was not corrupted:

  * Be sure to disable the CR/LF translation or the executables will
    be unusable.  Older versions of WinZipNT would enable this translation
    by default.  If you are using WinZipNT, disable it.  (I don't have
    WinZipNT myself, and I do not know the specific commands necessary to
    disable it.)

  * Check that filenames were not truncated to 8.3.  For example, there
    should be a file lisp\term\win32-win.el; if this has been truncated to
    win32-wi.el, your distribution has been corrupted while unpacking and
    Emacs will not start.

  * Users have said that some utilities (WinZip again?) don't create the
    lock subdirectory.  You can create the lock directory by hand (it is
    normally empty).

  * Users have also reported that the gnu-win32 tar corrupts the
    executables.  Use the version of tar on the ftp.cs.washington.edu 
    site instead.

If you believe you have unpacked the distributions correctly and are
still encountering problems, see the section on Further Information
below.

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).

* Further information

If you have access to the World Wide Web, I would recommend pointing
your favorite web browser to following the document (if you haven't
already):

	http://www.cs.washington.edu/homes/voelker/ntemacs.html

This above document serves as a FAQ and a source for further
information about the port and related software packages.

There is also a mailing list for discussing issues related to this
port of Emacs.  The name of the list is "ntemacs-users@cs.washington.edu".
For information about the list, send a message to
"ntemacs-users-request@cs.washington.edu" with the word "info" in the
*body* of the message.  To subscribe to the list, send a message to
the same address with the word "subscribe" in the body of the message;
similarly, to unsubscribe from the list, send a message with the word
"unsubscribe" in the message body.

* 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
the bug has something to do with code in your .emacs file: invoke
Emacs with the "-q" option and see if the bug remains.  If the problem
is due to something in your .emacs file, decide whether it is a bug in
your .emacs file or whether it is really an Emacs bug.  If you decide
that it is a bug in Emacs, send a message to the mailing list
(ntemacs-users@cs.washington.edu) describing the bug, the version of
Emacs that you are using, and the operating system that you are
running on.  If the bug is related to subprocesses, also specify which
shell you are using (e.g., include the values of shell-file-name and
shell-explicit-file-name in your message).

Enjoy.

Geoff Voelker
(voelker@cs.washington.edu)

Andrew Innes
(andrewi@harlequin.co.uk)
