]> code.delx.au - gnu-emacs/blob - nt/README
Refill some copyright headers.
[gnu-emacs] / nt / README
1 Emacs for Windows NT/2000 and Windows 95/98/ME
2
3 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
4 2010, 2011 Free Software Foundation, Inc.
5 See the end of the file for license conditions.
6
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.
12
13 Precompiled distributions are also available; ftp to
14
15 ftp://ftp.gnu.org/gnu/emacs/windows/
16
17 for the latest precompiled distributions.
18
19 * Building and installing
20
21 See the INSTALL file in this directory for detailed instructions on
22 building and installing Emacs on your system.
23
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 * Further information
65
66 There is a web page that serves as a FAQ for the Windows port of
67 Emacs (a.k.a. NTEmacs) at:
68
69 http://www.gnu.org/software/emacs/windows/ntemacs.html
70
71 There is also a mailing list for discussing issues related to this
72 port of Emacs. For information about the list, see this Web page:
73
74 http://mail.gnu.org/mailman/listinfo/help-emacs-windows
75
76 To ask questions on the mailing list, send email to
77 help-emacs-windows@gnu.org. (You don't need to subscribe for that.)
78 To subscribe to the list or unsubscribe from it, fill the form you
79 find at http://mail.gnu.org/mailman/listinfo/help-emacs-windows as
80 explained there.
81
82 Another valuable source of information and help which should not be
83 overlooked is the various Usenet news groups dedicated to Emacs.
84 These are particularly good for help with general issues which aren't
85 specific to the Windows port of Emacs. The main news groups to use
86 for seeking help are:
87
88 gnu.emacs.help
89 comp.emacs
90
91 There are also fairly regular postings and announcements of new or
92 updated Emacs packages on this group:
93
94 gnu.emacs.sources
95
96 * Reporting bugs
97
98 If you encounter a bug in this port of Emacs, we would like to hear
99 about it. First check the file etc/PROBLEMS and the FAQ on the web
100 page above to see if the bug is already known and if there are any
101 workarounds. If not, then check whether the bug has something to do
102 with code in your .emacs file, e.g. by invoking Emacs with the "-Q"
103 option.
104
105 Use the built in bug reporting functionality in Emacs so that it
106 will be seen by the right people. You can use the command M-x
107 report-emacs-bug to create and send the bug report, but in some
108 cases there is a function to report bugs in a specific package;
109 e.g. M-x gnus-bug for Gnus, M-x c-submit-bug-report for C/C++/Java
110 mode, etc.
111
112 \f
113 This file is part of GNU Emacs.
114
115 GNU Emacs is free software: you can redistribute it and/or modify
116 it under the terms of the GNU General Public License as published by
117 the Free Software Foundation, either version 3 of the License, or
118 (at your option) any later version.
119
120 GNU Emacs is distributed in the hope that it will be useful,
121 but WITHOUT ANY WARRANTY; without even the implied warranty of
122 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
123 GNU General Public License for more details.
124
125 You should have received a copy of the GNU General Public License
126 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.