Merge changes from emacs-23 branch
[bpt/emacs.git] / nt / README
1 Emacs for Windows NT/2000 and Windows 95/98/ME
2
3 Copyright (C) 2001-2011 Free Software Foundation, Inc.
4 See the end of the file for license conditions.
5
6 This directory contains support for compiling and running GNU Emacs on
7 Windows NT, Windows 95, and their successors. This port supports all
8 of the major functionality of the Unix version, including
9 subprocesses, windowing features (fonts, colors, scroll bars, multiple
10 frames, etc.), and networking support.
11
12 Precompiled distributions are also available; ftp to
13
14 ftp://ftp.gnu.org/gnu/emacs/windows/
15
16 for the latest precompiled distributions.
17
18 * Building and installing
19
20 See the INSTALL file in this directory for detailed instructions on
21 building and installing Emacs on your system.
22
23 * EXE files produced
24
25 Building and installing Emacs will produce the following executable
26 files in the bin directory.
27
28 + emacs.exe - The main Emacs executable. As this is designed to run
29 as both a text-mode application (emacs -nw) and as a GUI application,
30 it will pop up a command prompt window if run directly from Explorer.
31
32 + runemacs.exe - A wrapper for running Emacs as a GUI application
33 without popping up a command prompt window.
34
35 + emacsclient.exe - A command-line client program that can
36 communicate with a running Emacs process. See the `Emacs Server'
37 node of the Emacs manul.
38
39 + emacsclientw.exe - A version of emacsclient that does not open
40 a command-line window.
41
42 + addpm.exe - A basic installer that creates Start Menu icons for Emacs.
43 Running this is optional.
44
45 + cmdproxy.exe - Used internally by Emacs to work around problems with
46 the native shells in various versions of Windows.
47
48 + ctags.exe, etags.exe - Tools for generating tag files. See the
49 `Tags' node of the Emacs manual.
50
51 + ebrowse.exe - A tool for generating C++ browse information. See the
52 `Ebrowse' manual.
53
54 + ddeclient.exe - A tool for interacting with DDE servers.
55
56 + hexl.exe - A tool for converting files to hex dumps. See the
57 `Editing Binary Files' node of the Emacs manual.
58
59 + movemail.exe - A helper application for safely moving mail from
60 a mail spool or POP server to a local user mailbox. See the
61 `Movemail' node of the Emacs manual.
62
63 * Further information
64
65 There is a web page that serves as a FAQ for the Windows port of
66 Emacs (a.k.a. NTEmacs) at:
67
68 http://www.gnu.org/software/emacs/windows/ntemacs.html
69
70 There is also a mailing list for discussing issues related to this
71 port of Emacs. For information about the list, see this Web page:
72
73 http://mail.gnu.org/mailman/listinfo/help-emacs-windows
74
75 To ask questions on the mailing list, send email to
76 help-emacs-windows@gnu.org. (You don't need to subscribe for that.)
77 To subscribe to the list or unsubscribe from it, fill the form you
78 find at http://mail.gnu.org/mailman/listinfo/help-emacs-windows as
79 explained there.
80
81 Another valuable source of information and help which should not be
82 overlooked is the various Usenet news groups dedicated to Emacs.
83 These are particularly good for help with general issues which aren't
84 specific to the Windows port of Emacs. The main news groups to use
85 for seeking help are:
86
87 gnu.emacs.help
88 comp.emacs
89
90 There are also fairly regular postings and announcements of new or
91 updated Emacs packages on this group:
92
93 gnu.emacs.sources
94
95 * Reporting bugs
96
97 If you encounter a bug in this port of Emacs, we would like to hear
98 about it. First check the file etc/PROBLEMS and the FAQ on the web
99 page above to see if the bug is already known and if there are any
100 workarounds. If not, then check whether the bug has something to do
101 with code in your .emacs file, e.g. by invoking Emacs with the "-Q"
102 option.
103
104 Use the built in bug reporting functionality in Emacs so that it
105 will be seen by the right people. You can use the command M-x
106 report-emacs-bug to create and send the bug report, but in some
107 cases there is a function to report bugs in a specific package;
108 e.g. M-x gnus-bug for Gnus, M-x c-submit-bug-report for C/C++/Java
109 mode, etc.
110
111 \f
112 This file is part of GNU Emacs.
113
114 GNU Emacs is free software: you can redistribute it and/or modify
115 it under the terms of the GNU General Public License as published by
116 the Free Software Foundation, either version 3 of the License, or
117 (at your option) any later version.
118
119 GNU Emacs is distributed in the hope that it will be useful,
120 but WITHOUT ANY WARRANTY; without even the implied warranty of
121 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
122 GNU General Public License for more details.
123
124 You should have received a copy of the GNU General Public License
125 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.