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