Commit | Line | Data |
---|---|---|
31098a38 AI |
1 | Emacs for Windows NT and Windows 95/98/2000 |
2 | ||
3 | Version 21.0.104 pretest | |
4 | ||
5 | July 16, 2001 | |
6 | ||
7 | This README file describes how to set up and run a precompiled version | |
8 | of GNU Emacs for Windows NT and Windows 95/98/2000. This distribution | |
9 | can be found on the ftp.gnu.org server and its mirrors: | |
10 | ||
11 | ftp://ftp.gnu.org/gnu/windows/emacs/ | |
12 | ||
13 | This server contains other distributions, including the full Emacs | |
14 | source distribution and the lisp source distribution, as well as older | |
15 | releases of Emacs for Windows. | |
16 | ||
17 | Answers to frequently asked questions, and further information about | |
18 | this port of GNU Emacs and related software packages can be found via | |
19 | http or ftp: | |
20 | ||
21 | http://www.gnu.org/software/emacs/windows/ntemacs.html | |
22 | ftp://ftp.gnu.org/gnu/windows/emacs/docs/ntemacs.html | |
23 | ||
24 | * Preliminaries | |
25 | ||
26 | Along with this file should be six subdirectories (bin, etc, info, | |
27 | lisp, lock, site-lisp). Depending on which distribution you have | |
28 | installed, the lisp subdirectory might contain both the lisp source | |
29 | (*.el) and compiled lisp files (*.elc), or just the compiled lisp | |
30 | files. If you don't have the lisp source files, you can obtain them | |
31 | by downloading the lisp source distribution or the full source | |
32 | distribution from the ftp site mentioned above. | |
33 | ||
34 | * Setting up Emacs | |
35 | ||
36 | To install Emacs, simply unpack all the files into a directory of your | |
37 | choice, but note that you might encounter minor problems if there is a | |
38 | space anywhere in the directory name. To complete the installation | |
39 | process, you can optionally run the program addpm.exe in the bin | |
40 | subdirectory. This will add some entries to the registry that tell | |
41 | Emacs where to find its support files, and put an icon for Emacs in | |
42 | the Start Menu under "Start -> Programs -> Gnu Emacs -> Emacs". | |
43 | ||
44 | Some users have reported that the Start Menu item is not created for | |
45 | them. If this happens, just create your own shortcut to runemacs.exe, | |
46 | eg. by dragging it on to the desktop or the Start button. | |
47 | ||
48 | Note that running addpm is now an optional step; Emacs is able to | |
49 | locate all of its files without needing the information to be set in | |
50 | the environment or the registry, although such settings will still be | |
51 | obeyed if present. This is convenient for running Emacs on a machine | |
52 | which disallows registry changes, or on which software should not be | |
53 | installed. For instance, you can now run Emacs directly from a CD | |
54 | without copying or installing anything on the machine itself. | |
55 | ||
56 | * Starting Emacs | |
57 | ||
58 | To run Emacs, simply select Emacs from the Start Menu, or invoke | |
59 | runemacs.exe directly from Explorer or a command prompt. This will | |
60 | start Emacs in its default GUI mode, ready to use. If you have never | |
61 | used Emacs before, you should follow the tutorial at this point | |
62 | (select Emacs Tutorial from the Help menu), since Emacs is quite | |
63 | different from ordinary Windows applications in many respects. | |
64 | ||
65 | If you want to use Emacs in tty or character mode within a command | |
66 | window, you can start it by typing "emacs -nw" at the command prompt. | |
67 | (Obviously, you need to ensure that the Emacs bin subdirectory is in | |
68 | your PATH first, or specify the path to emacs.exe.) The -nw | |
69 | (non-windowed) mode of operation is most useful if you have a telnet | |
70 | server on your machine, allowing you to run Emacs remotely. | |
71 | ||
72 | * Uninstalling Emacs | |
73 | ||
74 | If you should need to uninstall Emacs, simply delete all the files and | |
75 | subdirectories from the directory where it was unpacked (Emacs does | |
76 | not install or update any files in system directories or anywhere | |
77 | else). If you ran the addpm.exe program to create the registry | |
78 | entries and the Start menu icon, then you can remove the registry | |
79 | entries using regedit. All of the settings are written under the | |
80 | Software\GNU\Emacs key in HKEY_LOCAL_MACHINE, or if you didn't have | |
81 | administrator privileges, the same key in HKEY_CURRENT_USER. Just | |
82 | delete the Software\GNU\Emacs key. | |
83 | ||
84 | The Start menu entry can be removed by right-clicking on the Task bar | |
85 | and selecting Properties, then using the Remove option on the Start | |
86 | Menu Programs page. (If you installed under an account with | |
87 | administrator privileges, then you need to click the Advanced button | |
88 | and look for the Gnu Emacs menu item under All Users.) | |
89 | ||
90 | * Troubleshooting | |
91 | ||
92 | Unpacking the distributions | |
93 | ||
94 | If you encounter trouble trying to run Emacs, there are a number of | |
95 | possible causes. If you didn't use the versions of tar and gunzip (or | |
96 | djtarnt) on the above ftp site, it is possible that the distribution | |
97 | became corrupted while it was being unpacked. Check the following for | |
98 | indications that the distribution was not corrupted: | |
99 | ||
100 | * Be sure to disable the CR/LF translation or the executables will | |
101 | be unusable. Older versions of WinZipNT would enable this | |
102 | translation by default. If you are using WinZipNT, disable it. | |
103 | (I don't have WinZipNT myself, and I do not know the specific | |
104 | commands necessary to disable it.) | |
105 | ||
106 | * Check that filenames were not truncated to 8.3. For example, | |
107 | there should be a file lisp\abbrevlist.elc; if this has been | |
108 | truncated to abbrevli.elc, your distribution has been corrupted | |
109 | while unpacking and Emacs will not start. | |
110 | ||
111 | * Users have said that some utilities (WinZip again?) don't create | |
112 | the lock subdirectory. You can create the lock directory by hand | |
113 | (it is normally empty). | |
114 | ||
115 | * Users have also reported that the gnu-win32 tar corrupts the | |
116 | executables. Use the version of tar or djtarnt on the ftp.gnu.org | |
117 | site instead. | |
118 | ||
119 | If you believe you have unpacked the distributions correctly and are | |
120 | still encountering problems, see the section on Further Information | |
121 | below. | |
122 | ||
123 | Virus scanners | |
124 | ||
125 | Some virus scanners interfere with Emacs' use of subprocesses. If you | |
126 | are unable to use subprocesses and you use Dr. Solomon's WinGuard or | |
127 | McAfee's Vshield, turn off "Scan all files" (WinGuard) or "boot sector | |
128 | scanning" (McAfee exclusion properties). | |
129 | ||
130 | * Further information | |
131 | ||
132 | If you have access to the World Wide Web, I would recommend pointing | |
133 | your favorite web browser to following the document (if you haven't | |
134 | already): | |
135 | ||
136 | http://www.gnu.org/software/emacs/windows/ntemacs.html | |
137 | ||
138 | This document serves as an FAQ and a source for further information | |
139 | about the Windows port and related software packages. | |
140 | ||
141 | In addition to the FAQ, there is a mailing list for discussing issues | |
142 | related to the Windows port of Emacs. The name of the list is | |
143 | "ntemacs-users@cs.washington.edu". For information about the list, | |
144 | send a message to "ntemacs-users-request@cs.washington.edu" with the | |
145 | word "info" in the body of the message. To subscribe to the list, | |
146 | send a message to the same address with the word "subscribe" in the | |
147 | body of the message; similarly, to unsubscribe from the list, send a | |
148 | message with the word "unsubscribe" in the message body. | |
149 | ||
150 | Another valuable source of information and help which should not be | |
151 | overlooked is the various Usenet news groups dedicated to Emacs. | |
152 | These are particuarly good for help with general issues which aren't | |
153 | specific to the Windows port of Emacs. The main news groups to use | |
154 | for seeking help are: | |
155 | ||
156 | gnu.emacs.help | |
157 | comp.emacs | |
158 | ||
159 | There are also fairly regular postings and announcements of new or | |
160 | updated Emacs packages on this group: | |
161 | ||
162 | gnu.emacs.sources | |
163 | ||
164 | * Reporting bugs | |
165 | ||
166 | If you encounter a bug in this port of Emacs, we would like to hear | |
167 | about it. First check the FAQ on the web page above to see if the bug | |
168 | is already known and if there are any workarounds. Then check whether | |
169 | the bug has something to do with code in your .emacs file, e.g. by | |
170 | invoking Emacs with the "-q --no-site-file" options. | |
171 | ||
172 | If you decide that it is a bug in Emacs that might be specific to the | |
173 | Windows port, send a message to the ntemacs-users@cs.washington.edu | |
174 | mailing list describing the bug, the version of Emacs that you are | |
175 | using, and the operating system that you are running on (Windows NT, | |
176 | 2000, 95 or 98 including service pack level if known). If the bug is | |
177 | related to subprocesses, also specify which shell you are using (e.g., | |
178 | include the values of `shell-file-name' and `shell-explicit-file-name' | |
179 | in your message). | |
180 | ||
181 | If you think the bug is not specific to the Windows port of Emacs, | |
182 | then it is better to mail the bug report to bug-gnu-emacs@gnu.org so | |
183 | that it will be seen by the right people. If Emacs has been set up to | |
184 | send mail, you can use the command M-x report-emacs-bug to create and | |
185 | send the bug report, but in some cases there is a function to report | |
186 | bugs in a specific package; e.g. M-x gnus-bug for Gnus, M-x | |
187 | c-submit-bug-report for C/C++/Java mode, etc. | |
188 | ||
189 | Enjoy. | |
190 | ||
191 | Andrew Innes | |
192 | (andrewi@gnu.org) |