nt/README

   1              Emacs for Windows NT/2000 and Windows 95/98/ME
   2
   3   Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006,
   4      2007, 2008, 2009 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   + digest-doc.exe, sorted-doc.exe - Tools for rebuilding the
  65   built-in documentation.
  66
  67 * Further information
  68
  69   There is a web page that serves as a FAQ for the Windows port of
  70   Emacs (a.k.a. NTEmacs) at:
  71
  72         http://www.gnu.org/software/emacs/windows/ntemacs.html
  73
  74   There is also a mailing list for discussing issues related to this
  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.
  84
  85   Another valuable source of information and help which should not be
  86   overlooked is the various Usenet news groups dedicated to Emacs.
  87   These are particularly good for help with general issues which aren't
  88   specific to the Windows port of Emacs.  The main news groups to use
  89   for seeking help are:
  90
  91         gnu.emacs.help
  92         comp.emacs
  93
  94   There are also fairly regular postings and announcements of new or
  95   updated Emacs packages on this group:
  96
  97         gnu.emacs.sources
  98
  99 * Reporting bugs
 100
 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
 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.
 114
 115 \f
 116 This file is part of GNU Emacs.
 117
 118 GNU Emacs is free software: you can redistribute it and/or modify
 119 it under the terms of the GNU General Public License as published by
 120 the Free Software Foundation, either version 3 of the License, or
 121 (at your option) any later version.
 122
 123 GNU Emacs is distributed in the hope that it will be useful,
 124 but WITHOUT ANY WARRANTY; without even the implied warranty of
 125 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 126 GNU General Public License for more details.
 127
 128 You should have received a copy of the GNU General Public License
 129 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.