nt/README

   1              Emacs for Windows NT/2000 and Windows 95/98/ME
   2
   3   Copyright (C) 2001-2013 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 manual.
  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.  To be
  55     invoked as "ddeclient SERVER [TOPIC]", where SERVER is the DDE
  56     server name, and sends each line of its standard input to the DDE
  57     server using the DdeClientTransaction API.  This program is
  58     supposed to be invoked via the 'call-process-region' Emacs
  59     primitive.
  60
  61   + hexl.exe - A tool for converting files to hex dumps.  See the
  62     `Editing Binary Files' node of the Emacs manual.
  63
  64   + movemail.exe - A helper application for safely moving mail from
  65     a mail spool or POP server to a local user mailbox.  See the
  66     `Movemail' node of the Emacs manual.
  67
  68 * Further information
  69
  70   There is a web page that serves as a FAQ for the Windows port of
  71   Emacs (a.k.a. NTEmacs) at:
  72
  73         http://www.gnu.org/software/emacs/windows/ntemacs.html
  74
  75   There is also a mailing list for discussing issues related to this
  76   port of Emacs.  For information about the list, see this Web page:
  77
  78         http://mail.gnu.org/mailman/listinfo/help-emacs-windows
  79
  80   To ask questions on the mailing list, send email to
  81   help-emacs-windows@gnu.org.  (You don't need to subscribe for that.)
  82   To subscribe to the list or unsubscribe from it, fill the form you
  83   find at http://mail.gnu.org/mailman/listinfo/help-emacs-windows as
  84   explained there.
  85
  86   Another valuable source of information and help which should not be
  87   overlooked is the various Usenet news groups dedicated to Emacs.
  88   These are particularly good for help with general issues which aren't
  89   specific to the Windows port of Emacs.  The main news groups to use
  90   for seeking help are:
  91
  92         gnu.emacs.help
  93         comp.emacs
  94
  95   There are also fairly regular postings and announcements of new or
  96   updated Emacs packages on this group:
  97
  98         gnu.emacs.sources
  99
 100 * Reporting bugs
 101
 102   If you encounter a bug in this port of Emacs, we would like to hear
 103   about it.  First check the file etc/PROBLEMS and the FAQ on the web
 104   page above to see if the bug is already known and if there are any
 105   workarounds.  If not, then check whether the bug has something to do
 106   with code in your .emacs file, e.g. by invoking Emacs with the "-Q"
 107   option.
 108
 109   Use the built in bug reporting functionality in Emacs so that it
 110   will be seen by the right people.  You can use the command M-x
 111   report-emacs-bug to create and send the bug report, but in some
 112   cases there is a function to report bugs in a specific package;
 113   e.g. M-x gnus-bug for Gnus, M-x c-submit-bug-report for C/C++/Java
 114   mode, etc.
 115
 116 \f
 117 This file is part of GNU Emacs.
 118
 119 GNU Emacs is free software: you can redistribute it and/or modify
 120 it under the terms of the GNU General Public License as published by
 121 the Free Software Foundation, either version 3 of the License, or
 122 (at your option) any later version.
 123
 124 GNU Emacs is distributed in the hope that it will be useful,
 125 but WITHOUT ANY WARRANTY; without even the implied warranty of
 126 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 127 GNU General Public License for more details.
 128
 129 You should have received a copy of the GNU General Public License
 130 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.