head	1.1;
branch	1.1.1;
access;
symbols
	EMACS_21_3:1.1.1.10
	EMACS_21_2:1.1.1.9
	EMACS_21_1:1.1.1.8
	EMACS_21_0_106:1.1.1.7
	EMACS_21_0_105:1.1.1.6
	EMACS_21_0_103:1.1.1.5
	EMACS_20_7:1.1.1.4
	EMACS_20_6:1.1.1.3
	EMACS_20_5:1.1.1.3
	EMACS_20_4:1.1.1.3
	EMACS_20_3:1.1.1.3
	EMACS_20_2:1.1.1.3
	EMACS_20_1:1.1.1.3
	EMACS_19_34:1.1.1.2
	EMACS_19_33:1.1.1.2
	EMACS_19_32:1.1.1.2
	EMACS_19_31:1.1.1.2
	EMACS_19_30:1.1.1.2
	EMACS_19_29:1.1.1.1
	FSF_DIST:1.1.1;
locks; strict;
comment	@# @;


1.1
date	2004.11.05.09.13.24;	author Ben Wing;	state Exp;
branches
	1.1.1.1;
next	;

1.1.1.1
date	2004.11.05.09.13.24;	author Ben Wing;	state Exp;
branches;
next	1.1.1.2;

1.1.1.2
date	2004.11.05.09.18.59;	author Ben Wing;	state Exp;
branches;
next	1.1.1.3;

1.1.1.3
date	2004.11.05.09.47.55;	author Ben Wing;	state Exp;
branches;
next	1.1.1.4;

1.1.1.4
date	2004.11.05.10.27.50;	author Ben Wing;	state Exp;
branches;
next	1.1.1.5;

1.1.1.5
date	2004.11.05.10.36.44;	author Ben Wing;	state Exp;
branches;
next	1.1.1.6;

1.1.1.6
date	2004.11.05.10.47.40;	author Ben Wing;	state Exp;
branches;
next	1.1.1.7;

1.1.1.7
date	2004.11.05.10.56.15;	author Ben Wing;	state Exp;
branches;
next	1.1.1.8;

1.1.1.8
date	2004.11.05.11.04.28;	author Ben Wing;	state Exp;
branches;
next	1.1.1.9;

1.1.1.9
date	2004.11.05.11.12.42;	author Ben Wing;	state Exp;
branches;
next	1.1.1.10;

1.1.1.10
date	2004.11.05.11.22.51;	author Ben Wing;	state Exp;
branches;
next	;


desc
@@


1.1
log
@Initial revision
@
text
@		      Building and Installing Emacs
		      on Windows NT and Windows 95

You need a compiler package to build and install Emacs on NT or Win95.
If you don't have one, precompiled versions are available in
ftp://ftp.cs.washington.edu/pub/ntemacs/<version>.

Configuring:

(1) In previous versions, you needed to edit makefile.def
    to reflect the compiler package that you are using.  You should no
    longer have to do this if you have defined the INCLUDE and LIB 
    environment variables, as is customary for use with Windows compilers.
    (Unless you are using MSVCNT 1.1, in which case you will need
    to set MSVCNT11 to be a non-zero value at the top of makefile.def.)

(2) Choose the directory into which Emacs will be installed, and
    edit makefile.def to define INSTALL_DIR to be this directory.  
    (Alternatively, if you have INSTALL_DIR set as an environment
    variable, the build process will ignore the value in makefile.def
    and use the value of the environment variable instead.)  Note 
    that if it is not installed in the directory in which it is built,
    the ~16 MB of lisp files will be copied into the installation directory.

    Also, makefile.def is sometimes unpacked read-only; use
   
    > attrib -r makefile.def

    to make it writable.

Building:

(3) The target to compile the sources is "all", and is recursive starting 
    one directory up.  The makefiles for the NT port are in files named 
    "makefile.nt".  To get things started, type in this directory:

    > nmake -f makefile.nt all

    or use the ebuild.bat file.

    When the files are compiled, you will see some warning messages declaring
    that some functions don't return a value, or that some data conversions
    will be lossy, etc.  You can safely ignore these messages.  The warnings
    may be fixed in the main FSF source at some point, but until then we
    will just live with them.

    NOTE: You should not have to edit src\paths.h to get Emacs to run
    correctly.  All of the variables in src\paths.h are configured
    during start up using the nt\emacs.bat file (which gets installed 
    as bin\emacs.bat -- see below).

Installing:

(4) Currently, Emacs requires a number of environment variables to be set
    for it to run correctly.  A batch file, emacs.bat, is provided that 
    sets these variables appropriately and then runs the executable
    (emacs.bat is generated using the definition of INSTALL_DIR in
    nt\makefile.def and the contents of nt\emacs.bat.in).

(5) The install process will install the files necessary to run Emacs in 
    INSTALL_DIR (which may be the directory in which it was built), 
    and create a program manager/folder icon in a folder called GNU Emacs.
    From this directory, type:

    > nmake -f makefile.nt install

    or use the install.bat file.

(6) Create the Emacs startup file.  Under Unix, this file is .emacs;
    under NT and Win95, this files is _emacs.  (If you would like to
    use a .emacs file that, for example, you share with a Unix version
    of Emacs, you can invoke Emacs with the -l option to specify the
    .emacs file that you would like to load.)  Note that Emacs requires 
    the environment variable HOME to be set in order for it to locate the 
    _emacs file.  Ideally, HOME should not be set in the emacs.bat file 
    as it will be different for each user.  (HOME could be set, 
    for example, in the System panel of the Control Panel).

(7) Either click on the icon, or run the emacs.bat file, and away you go.

    If you would like to resize the command window that Emacs uses,
    or change the font or colors, click on the program manager icon
    to start Emacs.  Change the settings using the "-" menu in the upper
    left hand corner of the window, making sure to select the "Save"
    options in the dialog boxes as you do so.  Exit Emacs and restart.
@


1.1.1.1
log
@import emacs-19.29
@
text
@@


1.1.1.2
log
@import emacs-19.30
@
text
@a30 3
(3) You may need to edit nt/paths.h to specify some other device
    instead of `C:'.

d33 1
a33 1
(4) The target to compile the sources is "all", and is recursive starting 
d54 1
a54 1
(5) Currently, Emacs requires a number of environment variables to be set
d60 1
a60 1
(6) The install process will install the files necessary to run Emacs in 
d69 1
a69 1
(7) Create the Emacs startup file.  Under Unix, this file is .emacs;
d79 1
a79 1
(8) Either click on the icon, or run the emacs.bat file, and away you go.
@


1.1.1.3
log
@import emacs-20.1
@
text
@d72 17
a88 94
(7) Create the Emacs startup file.  This file can be named either .emacs,
    as on Unix, or _emacs.  Note that Emacs requires the environment 
    variable HOME to be set in order for it to locate the startup file.  
    HOME could be set, for example, in the System panel of the Control
    Panel on NT, or in autoexec.bat on Win95.

(8) Start up Emacs.

    The installation process should have run the addpm.exe program, which
    does two things.  First, it will create a set of registry keys that
    tell Emacs where to find its support files (lisp, info, etc.).
    Second, it will create a folder containing an icon linked to
    runemacs.exe (a wrapper program for invoking Emacs).  You can
    also invoke addpm.exe by hand, giving the absolute directory name
    of the installation directory as the first argument:

        addpm.exe %INSTALL_DIR%

    Now, to run Emacs, simply click on the icon in the newly created
    folder or invoke runemacs.exe from a command prompt.

    Another alternative for running Emacs is to use the emacs.bat batch
    file in the bin directory (this was the traditional method of invoking
    Emacs).  Edit the emacs.bat file to change the emacs_dir environment
    variable to point to the Emacs installation directory and invoke the
    emacs.bat file to run Emacs.

    Note that, on Win95, you are likely to get "Out of environment space"
    messages when invoking the emacs.bat batch file.  The problem is that
    the console process in which the script is executed runs out of memory
    in which to set the Emacs environment variables.  To get around this
    problem, create a shortcut icon to the emacs.bat script.  Then right
    click on the icon and select Properties.  In the dialog box that pops
    up, select the Memory tab and then change the Environment memory
    allocation from "Auto" to "1024".  Close the dialog box and then
    double click on the icon to start Emacs.

Debugging:

(9) You should be able to debug Emacs using the MSVC debugger as you would
    any other program.  To ensure that Emacs uses the lisp files associated
    with the source distribution that you are debugging, it is useful
    to set the Emacs environment variables to point Emacs to the
    source distribution.  You can use the debug.bat batch file in this
    directory to setup the environment and invoke msdev on the
    emacs.exe executable.

    Emacs functions implemented in C use a naming convention that
    reflects their names in lisp.  The names of the C routines are
    the lisp names prefixed with 'F', and with dashes converted to 
    underscores.  For example, the function call-process is implemented
    in C by Fcall_process.  Similarly, lisp variables are prefixed
    with 'V', again with dashes converted to underscores.  These 
    conventions enable you to easily set breakpoints or examine familiar
    lisp variables by name.

    Since Emacs data is often in the form of a lisp object, and the
    Lisp_Object type is difficult to examine manually in the debugger,
    Emacs provides a helper routine called debug_print that prints out
    a readable representation of a Lisp_Object.  The output from 
    debug_print is sent to stderr, and to the debugger via the
    OutputDebugString routine.  The output sent to stderr should be
    displayed in the console window that was opened when the emacs.exe
    executable was started.  The output sent to the debugger should be
    displayed in its "Debug" output window.

    When you are in the process of debugging Emacs and you would like
    to examine the contents of a Lisp_Object variable, popup the
    QuickWatch window (QuickWatch has an eyeglass symbol on its button
    in the toolbar).  In the text field at the top of the window, enter
    debug_print(<variable>) and hit return.  For example, start
    and run Emacs in the debugger until it is waiting for user input.
    Then click on the Break button in the debugger to halt execution.
    Emacs should halt in ZwUserGetMessage waiting for an input event.
    Use the Call Stack window to select the procedure w32_msp_pump
    up the call stack (see below for why you have to do this).  Open
    the QuickWatch window and enter debug_print(Vexec_path).  Evaluating
    this expression will then print out the contents of the lisp
    variable exec-path.

    If QuickWatch reports that the symbol is unknown, then check the
    call stack in the Call Stack window.  If the selected frame in the
    call stack is not an Emacs procedure, then the debugger won't
    recognize Emacs symbols.  Instead, select a frame that is inside
    an Emacs procedure and try using debug_print again.

    If QuickWatch invokes debug_print but nothing happens, then check
    the thread that is selected in the debugger.  If the selected
    thread is not the last thread to run (the "current" thread), then
    it cannot be used to execute debug_print.  Use the Debug menu
    to select the current thread and try using debug_print again.
    Note that the debugger halts execution (e.g., due to a breakpoint)
    in the context of the current thread, so this should only be a problem
    if you've explicitly switched threads.
@


1.1.1.4
log
@import emacs-20.7
@
text
@a16 8
    Previous versions also required the use of DOS batch files to set
    environment variables before running or debugging Emacs. As of
    20.6, Emacs will default to sensible values if the environment
    variables are not set, so these batch files are no longer included
    with the distribution. Old emacs.bat and debug.bat files will
    still work if you have a special need for them, provided the paths
    are updated for this version of Emacs.

d57 7
a63 1
(5) The install process will install the files necessary to run Emacs in 
d72 1
a72 1
(6) Create the Emacs startup file.  This file can be named either .emacs,
d78 1
a78 1
(7) Start up Emacs.
d93 16
d111 7
a117 2
(8) You should be able to debug Emacs using the MSVC debugger as you would
    any other program.
@


1.1.1.5
log
@import emacs-21.0.103
@
text
@d2 1
a2 1
		on Windows NT/2000 and Windows 95/98/ME
d4 143
a146 166
  To compile Emacs, you will need either Microsoft Visual C++ 2.0 or
  later, or a Windows port of GCC 2.95 or later with Mingw and W32 API
  support and a port of GNU make.  You can use the Cygwin ports of GCC,
  but Emacs requires the Mingw headers and libraries to build.

  If you build Emacs on Windows 9X or ME, not on Windows 2000 or
  Windows NT, we suggest to install the Cygwin port of Bash.

  Please see http://www.mingw.org for pointers to GCC/Mingw binaries.

  For reference, here is a list of which builds of GNU make are known
  to work or not, and whether they work in the presence and/or absence
  of sh.exe, the Cygwin port of Bash.
 
                                         sh exists     no sh

    cygwin b20.1 make (3.75):            okay[1]       fails[2]
    MSVC compiled gmake 3.77:            okay          okay
    MSVC compiled gmake 3.78.1:          okay          okay
    MSVC compiled gmake 3.79.1:          okay          okay
    mingw32/gcc-2.92.2 make (3.77):      okay          okay[4]
    cygwin compiled gmake 3.77:          okay[1]       fails[2]
    cygwin compiled gmake 3.78.1:        okay          fails[2]
    cygwin compiled gmake 3.79.1:        couldn't build make[3]

  Notes:

    [1] doesn't cope with makefiles with DOS line endings, so must mount
        emacs source with text!=binary.
    [2] fails when needs to invoke shell commands; okay invoking gcc etc.
    [3] requires LC_MESSAGES support to build; maybe 2.95.x update to
        cygwin provides this?
    [4] may fail on Windows 9X and Windows ME; if so, install Bash.

* Configuring

  Configuration of Emacs is now handled by running configure.bat in the
  nt subdirectory.  It will detect which compiler you have available,
  and generate makefiles accordingly.  You can override the compiler
  detection, and control optimization and debug settings, by specifying
  options on the command line when invoking configure.

  To configure Emacs to build with GCC or MSVC, whichever is available,
  simply change to the nt subdirectory and run `configure' with no
  options.  To see what options are available, run `configure --help'.

  N.B.  It is normal to see a few error messages output while configure
  is running, when gcc support is being tested.  These cannot be
  surpressed because of limitations in the Windows 9x command.com shell.

* Building

  After running configure, simply run the appropriate `make' program for
  your compiler to build Emacs.  For MSVC, this is nmake; for GCC, it is
  GNU make.

  As the files are compiled, you will see some warning messages
  declaring that some functions don't return a value, or that some data
  conversions will be lossy, etc.  You can safely ignore these messages.
  The warnings may be fixed in the main FSF source at some point, but
  until then we will just live with them.

* Installing

  To install Emacs after it has compiled, simply run `make install'.

  By default, Emacs will be installed in the location where it was
  built, but a different location can be specified either using the
  --prefix option to configure, or by setting INSTALL_DIR when running
  make, like so:

     make install INSTALL_DIR=D:/emacs

  The install process will run addpm to setup the registry entries, and
  to create a Start menu icon for Emacs.

* Trouble-shooting

  The main problems that are likely to be encountered when building
  Emacs stem from using an old version of GCC, or old Mingw or W32 API
  headers.  Additionally, cygwin ports of GNU make may require the Emacs
  source tree to be mounted with text!=binary, because the makefiles
  generated by configure.bat necessarily use DOS line endings.  Also,
  cygwin ports of make must run in UNIX mode, either by specifying
  --unix on the command line, or MAKE_MODE=UNIX in the environment.

  When configure runs, it attempts to detect when GCC itself, or the
  headers it is using, are not suitable for building Emacs.  GCC version
  2.95 or later is needed, because that is when the Windows port gained
  sufficient support for anonymous structs and unions to cope with some
  definitions from winnt.h that are used by addsection.c.  The W32 API
  headers that come with Cygwin b20.1 are incomplete, and do not include
  some definitions required by addsection.c, for instance.  Also, older
  releases of the W32 API headers from Anders Norlander contain a typo
  in the definition of IMAGE_FIRST_SECTION in winnt.h, which
  addsection.c relies on.  Versions of w32api-xxx.zip from at least
  1999-11-18 onwards are okay.

  If configure succeeds, but make fails, install the Cygwin port of
  Bash, even if the table above indicates that Emacs should be able to
  build without sh.exe.  (Some versions of Windows shells are too dumb
  for Makefile's used by Emacs.)

  If you are using a recent Cygwin build of GCC, such as Cygwin version
  1.1.8, you may need to specify some extra compiler flags like so:

    configure --with-gcc --cflags -mwin32 --cflags -D__MSVCRT__
      --ldflags -mwin32

  We will attempt to auto-detect the need for these flags in a future
  release.

* Debugging

  You should be able to debug Emacs using the debugger that is
  appropriate for the compiler you used, namely DevStudio or Windbg if
  compiled with MSVC, or gdb if compiled with gcc.

  Emacs functions implemented in C use a naming convention that reflects
  their names in lisp.  The names of the C routines are the lisp names
  prefixed with 'F', and with dashes converted to underscores.  For
  example, the function call-process is implemented in C by
  Fcall_process.  Similarly, lisp variables are prefixed with 'V', again
  with dashes converted to underscores.  These conventions enable you to
  easily set breakpoints or examine familiar lisp variables by name.

  Since Emacs data is often in the form of a lisp object, and the
  Lisp_Object type is difficult to examine manually in the MSVC
  debugger, Emacs provides a helper routine called debug_print that
  prints out a readable representation of a Lisp_Object.  (If you are
  using gdb, there is a .gdbinit file in the src directory which
  provides definitions that are useful for examining lisp objects.  The
  following tips are mainly of interest when using MSVC.)  The output
  from debug_print is sent to stderr, and to the debugger via the
  OutputDebugString routine.  The output sent to stderr should be
  displayed in the console window that was opened when the emacs.exe
  executable was started.  The output sent to the debugger should be
  displayed in its "Debug" output window.

  When you are in the process of debugging Emacs and you would like to
  examine the contents of a Lisp_Object variable, popup the QuickWatch
  window (QuickWatch has an eyeglass symbol on its button in the
  toolbar).  In the text field at the top of the window, enter
  debug_print(<variable>) and hit return.  For example, start and run
  Emacs in the debugger until it is waiting for user input.  Then click
  on the Break button in the debugger to halt execution.  Emacs should
  halt in ZwUserGetMessage waiting for an input event.  Use the Call
  Stack window to select the procedure w32_msp_pump up the call stack
  (see below for why you have to do this).  Open the QuickWatch window
  and enter debug_print(Vexec_path).  Evaluating this expression will
  then print out the contents of the lisp variable exec-path.

  If QuickWatch reports that the symbol is unknown, then check the call
  stack in the Call Stack window.  If the selected frame in the call
  stack is not an Emacs procedure, then the debugger won't recognize
  Emacs symbols.  Instead, select a frame that is inside an Emacs
  procedure and try using debug_print again.

  If QuickWatch invokes debug_print but nothing happens, then check the
  thread that is selected in the debugger.  If the selected thread is
  not the last thread to run (the "current" thread), then it cannot be
  used to execute debug_print.  Use the Debug menu to select the current
  thread and try using debug_print again.  Note that the debugger halts
  execution (e.g., due to a breakpoint) in the context of the current
  thread, so this should only be a problem if you've explicitly switched
  threads.
@


1.1.1.6
log
@import emacs-21.0.105
@
text
@a3 3
  Copyright (c) 2001 Free Software Foundation, Inc.
  See the end of the file for copying permissions.

d5 3
a7 4
  later and nmake, or a Windows port of GCC 2.95 or later with Mingw
  and W32 API support and a port of GNU make.  You can use the Cygwin
  ports of GCC, but Emacs requires the Mingw headers and libraries to
  build.
a169 15

COPYING PERMISSIONS

  Permission is granted to anyone to make or distribute verbatim copies
  of this document as received, in any medium, provided that the
  copyright notice and permission notice are preserved,
  and that the distributor grants the recipient permission
  for further redistribution as permitted by this notice.

  Permission is granted to distribute modified versions
  of this document, or of portions of it,
  under the above conditions, provided also that they
  carry prominent notices stating who last changed them,
  and that any new or changed statements about the activities
  of the Free Software Foundation are approved by the Foundation.
@


1.1.1.7
log
@import emacs-21.0.106
@
text
@a6 7
  If you used WinZip to unpack the distribution, we suggest to
  remove the files and unpack again with a different program!
  WinZip is known to create some subtle and hard to debug problems,
  such as converting files to DOS CR-LF format, not creating empty 
  directories, etc.  We suggest to use djtarnt.exe from the GNU FTP
  site.

d72 1
a72 3
  To install Emacs after it has compiled, simply run `nmake install'
  or `make install', depending on which version of the Make utility
  do you have.
a80 2
  (for `nmake', type "nmake install INSTALL_DIR=D:/emacs" instead).

@


1.1.1.8
log
@import emacs-21.1
@
text
@d18 1
a18 2
  build (latest versions of the Cygwin toolkit, at least since v1.3.3,
  include the MinGW headers and libraries as an integral part).
d37 2
a38 2
    cygwin compiled make 3.78.1:         okay          fails[2]
    cygwin compiled make 3.79.1:         couldn't build make[3]
d122 1
a122 1
  If you are using certain Cygwin builds of GCC, such as Cygwin version
a127 3
  However, the latest Cygwin versions, such as 1.3.3, don't need those
  switches; you can simply use "configure --with-gcc".

@


1.1.1.9
log
@import emacs-21.2
@
text
@d28 1
a28 6
  of sh.exe, the Cygwin port of Bash. Note that any version of make
  that is compiled with Cygwin will only work with Cygwin tools, due to
  the use of cygwin style paths. This means Cygwin make is unsuitable
  for building parts of Emacs that need to invoke Emacs itself (leim and
  "make bootstrap", for example). Also see the Trouble-shooting section
  below if you decide to go ahead and use Cygwin make.
d32 1
a32 1
    cygwin b20.1 make (3.75):            fails[1, 5]   fails[2, 5]
d37 3
a39 4
    cygwin compiled gmake 3.77:          fails[1, 5]   fails[2, 5]
    cygwin compiled make 3.78.1:         fails[5]      fails[2, 5]
    cygwin compiled make 3.79.1:         fails[3, 5]   fails[2?, 5]
    mingw32 compiled make 3.79.1:        okay          okay 
d46 2
a47 2
    [3] requires LC_MESSAGES support to build; cannot build with early
        versions of cygwin.
a48 2
    [5] fails when building leim due to the use of cygwin style paths.
        May work if building emacs without leim.
@


1.1.1.10
log
@import emacs-21.3
@
text
@d10 1
a10 1
  such as converting files to DOS CR-LF format, not creating empty
a20 7
  Other compilers may work, but specific reports from people that have
  tried suggest that the Intel C compiler (for example) may produce an
  Emacs executable with strange filename completion behaviour.  Unless
  you would like to assist by finding and fixing the cause of any bugs
  like this, we recommend the use of the supported compilers mentioned
  in the previous paragraph.

d34 1
a34 5

  In addition, using 4NT as your shell is known to fail the build process,
  at least for 4NT version 3.01.  Use cmd.exe, the default NT shell,
  instead.

d45 1
a45 1
    mingw32 compiled make 3.79.1:        okay          okay
a73 19
* Optional image library support

  To build Emacs with support for PNG images, the libpng and zlib
  headers must be in the include path when the configure script is
  run.  This can be setup using environment variables, or by
  specifying --cflags -I...  options on the command-line to
  configure.bat.  Similarly, the jpeg-6b, libXpm, tiff and libungif
  headers need to be in the include path for support for those image
  formats to work. The configure script will report whether it was
  able to detect the headers.

  To use the PNG support, zlib.dll (or zlibd.dll) and libpng.dll (or
  libpng13.dll, or libpng13d.dll) must be on the PATH or in the same
  directory as emacs.exe when Emacs is started. Similar instructions
  apply for other image libraries. Note that tiff support depends on
  the jpeg library. If you did not compile the libraries yourself, you
  must make sure that the jpeg library you install is the same one
  that the tiff library was compiled against.

@


