README 5.41 KB
Newer Older
1
	     Emacs for Windows NT/2000 and Windows 95/98/ME
Dave Love's avatar
#  
Dave Love committed
2

3
  Copyright (C) 2001-2020 Free Software Foundation, Inc.
4
  See the end of the file for license conditions.
Andrew Innes's avatar
Andrew Innes committed
5

6 7 8 9 10
  This directory contains support for compiling and running GNU Emacs on
  Windows NT, Windows 95, and their successors.  This port supports all
  of the major functionality of the Unix version, including
  subprocesses, windowing features (fonts, colors, scroll bars, multiple
  frames, etc.), and networking support.
Dave Love's avatar
#  
Dave Love committed
11

12
  Precompiled distributions are also available; see:
Dave Love's avatar
#  
Dave Love committed
13

14
	https://ftp.gnu.org/gnu/emacs/windows/
Dave Love's avatar
#  
Dave Love committed
15

16
  for the latest precompiled distributions.
Dave Love's avatar
#  
Dave Love committed
17 18 19

* Building and installing

20 21
  See the INSTALL file in this directory for detailed instructions on
  building and installing Emacs on your system.
Dave Love's avatar
#  
Dave Love committed
22

23 24 25 26 27
* EXE files produced

  Building and installing Emacs will produce the following executable
  files in the bin directory.

28
  + emacs.exe - The main Emacs executable.  As this is designed to run
29 30 31 32
    as both a text-mode application (emacs -nw) and as a GUI application,
    it will pop up a command prompt window if run directly from Explorer.

  + runemacs.exe - A wrapper for running Emacs as a GUI application
33 34 35
    without popping up a command prompt window.  If you create a
    desktop shortcut for invoking Emacs, make it point to this
    executable, not to emacs.exe.
36 37

  + emacsclient.exe - A command-line client program that can
38
    communicate with a running Emacs process.  See the `Emacs Server'
Paul Eggert's avatar
Paul Eggert committed
39
    node of the Emacs manual.
40 41 42 43 44 45 46 47

  + emacsclientw.exe - A version of emacsclient that does not open
    a command-line window.

  + addpm.exe - A basic installer that creates Start Menu icons for Emacs.
    Running this is optional.

  + ctags.exe, etags.exe - Tools for generating tag files.  See the
48
    `Tags' node of the Emacs manual.
49 50 51 52

  + ebrowse.exe - A tool for generating C++ browse information.  See the
    `Ebrowse' manual.

53 54 55 56 57 58
  Several helper programs are installed in a version-specific
  subdirectory of the libexec directory:

  + cmdproxy.exe - Used internally by Emacs to work around problems with
    the native shells in various versions of Windows.

59 60 61 62 63 64
  + ddeclient.exe - A tool for interacting with DDE servers.  To be
    invoked as "ddeclient SERVER [TOPIC]", where SERVER is the DDE
    server name, and sends each line of its standard input to the DDE
    server using the DdeClientTransaction API.  This program is
    supposed to be invoked via the 'call-process-region' Emacs
    primitive.
65

66
  + hexl.exe - A tool for producing hex dumps of binary files.  See the
67 68 69 70 71 72
    `Editing Binary Files' node of the Emacs manual.

  + movemail.exe - A helper application for safely moving mail from
    a mail spool or POP server to a local user mailbox.  See the
    `Movemail' node of the Emacs manual.

73 74 75 76 77 78
  + profile.exe - A helper program that generates periodic events for
    profiling Emacs Lisp code.

  + update-game-score.exe - A utility for updating the score files of
    Emacs games.

Dave Love's avatar
#  
Dave Love committed
79 80
* Further information

81 82 83
  The Emacs User manual describes Windows-specific issues in the
  appendix named "Emacs and Microsoft Windows/MS-DOS".  You can read
  it in Emacs by typing
Dave Love's avatar
#  
Dave Love committed
84

85
        C-h r g Microsoft Windows RET
Dave Love's avatar
#  
Dave Love committed
86

87 88
  This appendix is also available (as part of the entire manual) at

89
        https://www.gnu.org/software/emacs/manual/html_mono/emacs.html#Microsoft-Windows
90 91 92 93

  In addition to the manual, there is a mailing list for discussing
  issues related to the Windows port of Emacs.  For information about
  the list, see this Web page:
94

95
	https://mail.gnu.org/mailman/listinfo/help-emacs-windows
96 97 98 99

  To ask questions on the mailing list, send email to
  help-emacs-windows@gnu.org.  (You don't need to subscribe for that.)
  To subscribe to the list or unsubscribe from it, fill the form you
100
  find at https://mail.gnu.org/mailman/listinfo/help-emacs-windows as
101
  explained there.
Dave Love's avatar
#  
Dave Love committed
102

103 104
  Another valuable source of information and help which should not be
  overlooked is the various Usenet news groups dedicated to Emacs.
105
  These are particularly good for help with general issues which aren't
106 107
  specific to the Windows port of Emacs.  The main news groups to use
  for seeking help are:
Dave Love's avatar
#  
Dave Love committed
108

109 110
	gnu.emacs.help
	comp.emacs
Dave Love's avatar
#  
Dave Love committed
111

112 113
  There are also fairly regular postings and announcements of new or
  updated Emacs packages on this group:
Dave Love's avatar
#  
Dave Love committed
114

115
	gnu.emacs.sources
Dave Love's avatar
#  
Dave Love committed
116

117
* Reporting bugs
Dave Love's avatar
#  
Dave Love committed
118

119 120 121 122
  If you encounter a bug in this port of Emacs, we would like to hear
  about it.  First check the file etc/PROBLEMS and the FAQ on the web
  page above to see if the bug is already known and if there are any
  workarounds.  If not, then check whether the bug has something to do
123 124 125 126 127
  with code in your .emacs file, e.g. by invoking Emacs with the "-Q"
  option.

  Use the built in bug reporting functionality in Emacs so that it
  will be seen by the right people.  You can use the command M-x
128
  report-emacs-bug to create and send the bug report.
129 130 131

This file is part of GNU Emacs.

132
GNU Emacs is free software: you can redistribute it and/or modify
133
it under the terms of the GNU General Public License as published by
134 135
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
136 137 138 139 140 141 142

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
143
along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.