annotate nt/INSTALL @ 52674:7490e5357dba

A lot of comments updated. (desktop-save-mode): Minor mode introduced. (desktop-enable, desktop-clear-preserve-buffers): Variables made obsolete. (desktop-load-default): Function made obsolete. (desktop-locals-to-save): Variable made customizable. (desktop-read): Optional parameter `dirname' added. (desktop-change-dir, desktop-revert): Parameter `dirname' in `desktop-read' used. (desktop-save-in-load-dir): Renamed to `desktop-save-in-desktop-dir'.
author Lars Hansen <larsh@soem.dk>
date Tue, 30 Sep 2003 07:22:22 +0000
parents 79fdcc780508
children 8b571de37306 375f2633d815
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
1 Building and Installing Emacs
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
2 on Windows NT/2000 and Windows 95/98/ME
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
3
37710
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
4 Copyright (c) 2001 Free Software Foundation, Inc.
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
5 See the end of the file for copying permissions.
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
6
39152
ac1c50b8ffea Suggest not to use WinZip.
Eli Zaretskii <eliz@gnu.org>
parents: 39144
diff changeset
7 If you used WinZip to unpack the distribution, we suggest to
ac1c50b8ffea Suggest not to use WinZip.
Eli Zaretskii <eliz@gnu.org>
parents: 39144
diff changeset
8 remove the files and unpack again with a different program!
ac1c50b8ffea Suggest not to use WinZip.
Eli Zaretskii <eliz@gnu.org>
parents: 39144
diff changeset
9 WinZip is known to create some subtle and hard to debug problems,
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49565
diff changeset
10 such as converting files to DOS CR-LF format, not creating empty
39152
ac1c50b8ffea Suggest not to use WinZip.
Eli Zaretskii <eliz@gnu.org>
parents: 39144
diff changeset
11 directories, etc. We suggest to use djtarnt.exe from the GNU FTP
ac1c50b8ffea Suggest not to use WinZip.
Eli Zaretskii <eliz@gnu.org>
parents: 39144
diff changeset
12 site.
ac1c50b8ffea Suggest not to use WinZip.
Eli Zaretskii <eliz@gnu.org>
parents: 39144
diff changeset
13
52416
79fdcc780508 Add note about fixing line ends when building from CVS.
Jason Rumney <jasonr@gnu.org>
parents: 49871
diff changeset
14 If you are building out of CVS, then some files in this directory
79fdcc780508 Add note about fixing line ends when building from CVS.
Jason Rumney <jasonr@gnu.org>
parents: 49871
diff changeset
15 (.bat files, nmake.defs and makefile.w32-in) may need the line-ends
79fdcc780508 Add note about fixing line ends when building from CVS.
Jason Rumney <jasonr@gnu.org>
parents: 49871
diff changeset
16 fixing first. The easiest way to do this and avoid future conflicts
79fdcc780508 Add note about fixing line ends when building from CVS.
Jason Rumney <jasonr@gnu.org>
parents: 49871
diff changeset
17 is to run the following command in this (emacs/nt) directory:
79fdcc780508 Add note about fixing line ends when building from CVS.
Jason Rumney <jasonr@gnu.org>
parents: 49871
diff changeset
18 cvs update -kb
79fdcc780508 Add note about fixing line ends when building from CVS.
Jason Rumney <jasonr@gnu.org>
parents: 49871
diff changeset
19
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
20 To compile Emacs, you will need either Microsoft Visual C++ 2.0 or
37885
0cd37e185384 Clarify that building with MSVC requires nmake.
Jason Rumney <jasonr@gnu.org>
parents: 37710
diff changeset
21 later and nmake, or a Windows port of GCC 2.95 or later with Mingw
0cd37e185384 Clarify that building with MSVC requires nmake.
Jason Rumney <jasonr@gnu.org>
parents: 37710
diff changeset
22 and W32 API support and a port of GNU make. You can use the Cygwin
0cd37e185384 Clarify that building with MSVC requires nmake.
Jason Rumney <jasonr@gnu.org>
parents: 37710
diff changeset
23 ports of GCC, but Emacs requires the Mingw headers and libraries to
39462
7bc2236b1036 Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents: 39152
diff changeset
24 build (latest versions of the Cygwin toolkit, at least since v1.3.3,
7bc2236b1036 Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents: 39152
diff changeset
25 include the MinGW headers and libraries as an integral part).
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
26
49871
4f204ad4bdf9 Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
parents: 49600
diff changeset
27 Other compilers may work, but specific reports from people that have
4f204ad4bdf9 Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
parents: 49600
diff changeset
28 tried suggest that the Intel C compiler (for example) may produce an
4f204ad4bdf9 Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
parents: 49600
diff changeset
29 Emacs executable with strange filename completion behaviour. Unless
4f204ad4bdf9 Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
parents: 49600
diff changeset
30 you would like to assist by finding and fixing the cause of any bugs
4f204ad4bdf9 Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
parents: 49600
diff changeset
31 like this, we recommend the use of the supported compilers mentioned
4f204ad4bdf9 Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
parents: 49600
diff changeset
32 in the previous paragraph.
4f204ad4bdf9 Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
parents: 49600
diff changeset
33
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
34 If you build Emacs on Windows 9X or ME, not on Windows 2000 or
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
35 Windows NT, we suggest to install the Cygwin port of Bash.
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
36
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
37 Please see http://www.mingw.org for pointers to GCC/Mingw binaries.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
38
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
39 For reference, here is a list of which builds of GNU make are known
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
40 to work or not, and whether they work in the presence and/or absence
41327
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
41 of sh.exe, the Cygwin port of Bash. Note that any version of make
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
42 that is compiled with Cygwin will only work with Cygwin tools, due to
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
43 the use of cygwin style paths. This means Cygwin make is unsuitable
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
44 for building parts of Emacs that need to invoke Emacs itself (leim and
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
45 "make bootstrap", for example). Also see the Trouble-shooting section
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
46 below if you decide to go ahead and use Cygwin make.
42901
a8392117d6de Document problems with 4NT.
Eli Zaretskii <eliz@gnu.org>
parents: 41327
diff changeset
47
a8392117d6de Document problems with 4NT.
Eli Zaretskii <eliz@gnu.org>
parents: 41327
diff changeset
48 In addition, using 4NT as your shell is known to fail the build process,
a8392117d6de Document problems with 4NT.
Eli Zaretskii <eliz@gnu.org>
parents: 41327
diff changeset
49 at least for 4NT version 3.01. Use cmd.exe, the default NT shell,
a8392117d6de Document problems with 4NT.
Eli Zaretskii <eliz@gnu.org>
parents: 41327
diff changeset
50 instead.
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49565
diff changeset
51
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
52 sh exists no sh
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
53
41327
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
54 cygwin b20.1 make (3.75): fails[1, 5] fails[2, 5]
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
55 MSVC compiled gmake 3.77: okay okay
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
56 MSVC compiled gmake 3.78.1: okay okay
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
57 MSVC compiled gmake 3.79.1: okay okay
35814
70ef76f45876 Move note [4] to the no-sh column.
Eli Zaretskii <eliz@gnu.org>
parents: 35726
diff changeset
58 mingw32/gcc-2.92.2 make (3.77): okay okay[4]
41327
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
59 cygwin compiled gmake 3.77: fails[1, 5] fails[2, 5]
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
60 cygwin compiled make 3.78.1: fails[5] fails[2, 5]
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
61 cygwin compiled make 3.79.1: fails[3, 5] fails[2?, 5]
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49565
diff changeset
62 mingw32 compiled make 3.79.1: okay okay
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
63
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
64 Notes:
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
65
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
66 [1] doesn't cope with makefiles with DOS line endings, so must mount
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
67 emacs source with text!=binary.
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
68 [2] fails when needs to invoke shell commands; okay invoking gcc etc.
41327
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
69 [3] requires LC_MESSAGES support to build; cannot build with early
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
70 versions of cygwin.
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
71 [4] may fail on Windows 9X and Windows ME; if so, install Bash.
41327
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
72 [5] fails when building leim due to the use of cygwin style paths.
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
73 May work if building emacs without leim.
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
74
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
75 * Configuring
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
76
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
77 Configuration of Emacs is now handled by running configure.bat in the
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
78 nt subdirectory. It will detect which compiler you have available,
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
79 and generate makefiles accordingly. You can override the compiler
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
80 detection, and control optimization and debug settings, by specifying
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
81 options on the command line when invoking configure.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
82
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
83 To configure Emacs to build with GCC or MSVC, whichever is available,
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
84 simply change to the nt subdirectory and run `configure' with no
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
85 options. To see what options are available, run `configure --help'.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
86
31625
345a3f5a7193 Add note about expected error messages when configure
Andrew Innes <andrewi@gnu.org>
parents: 31083
diff changeset
87 N.B. It is normal to see a few error messages output while configure
345a3f5a7193 Add note about expected error messages when configure
Andrew Innes <andrewi@gnu.org>
parents: 31083
diff changeset
88 is running, when gcc support is being tested. These cannot be
345a3f5a7193 Add note about expected error messages when configure
Andrew Innes <andrewi@gnu.org>
parents: 31083
diff changeset
89 surpressed because of limitations in the Windows 9x command.com shell.
345a3f5a7193 Add note about expected error messages when configure
Andrew Innes <andrewi@gnu.org>
parents: 31083
diff changeset
90
49451
c4911d7933ae Added notes about PNG support.
Jason Rumney <jasonr@gnu.org>
parents: 42901
diff changeset
91 * Optional image library support
c4911d7933ae Added notes about PNG support.
Jason Rumney <jasonr@gnu.org>
parents: 42901
diff changeset
92
49565
f728725eb539 More image notes.
Jason Rumney <jasonr@gnu.org>
parents: 49458
diff changeset
93 To build Emacs with support for PNG images, the libpng and zlib
49458
5ddabc4c81b0 Added notes for JPEG library.
Jason Rumney <jasonr@gnu.org>
parents: 49451
diff changeset
94 headers must be in the include path when the configure script is
49565
f728725eb539 More image notes.
Jason Rumney <jasonr@gnu.org>
parents: 49458
diff changeset
95 run. This can be setup using environment variables, or by
49458
5ddabc4c81b0 Added notes for JPEG library.
Jason Rumney <jasonr@gnu.org>
parents: 49451
diff changeset
96 specifying --cflags -I... options on the command-line to
49565
f728725eb539 More image notes.
Jason Rumney <jasonr@gnu.org>
parents: 49458
diff changeset
97 configure.bat. Similarly, the jpeg-6b, libXpm, tiff and libungif
f728725eb539 More image notes.
Jason Rumney <jasonr@gnu.org>
parents: 49458
diff changeset
98 headers need to be in the include path for support for those image
f728725eb539 More image notes.
Jason Rumney <jasonr@gnu.org>
parents: 49458
diff changeset
99 formats to work. The configure script will report whether it was
f728725eb539 More image notes.
Jason Rumney <jasonr@gnu.org>
parents: 49458
diff changeset
100 able to detect the headers.
49451
c4911d7933ae Added notes about PNG support.
Jason Rumney <jasonr@gnu.org>
parents: 42901
diff changeset
101
c4911d7933ae Added notes about PNG support.
Jason Rumney <jasonr@gnu.org>
parents: 42901
diff changeset
102 To use the PNG support, zlib.dll (or zlibd.dll) and libpng.dll (or
c4911d7933ae Added notes about PNG support.
Jason Rumney <jasonr@gnu.org>
parents: 42901
diff changeset
103 libpng13.dll, or libpng13d.dll) must be on the PATH or in the same
49565
f728725eb539 More image notes.
Jason Rumney <jasonr@gnu.org>
parents: 49458
diff changeset
104 directory as emacs.exe when Emacs is started. Similar instructions
f728725eb539 More image notes.
Jason Rumney <jasonr@gnu.org>
parents: 49458
diff changeset
105 apply for other image libraries. Note that tiff support depends on
f728725eb539 More image notes.
Jason Rumney <jasonr@gnu.org>
parents: 49458
diff changeset
106 the jpeg library. If you did not compile the libraries yourself, you
f728725eb539 More image notes.
Jason Rumney <jasonr@gnu.org>
parents: 49458
diff changeset
107 must make sure that the jpeg library you install is the same one
f728725eb539 More image notes.
Jason Rumney <jasonr@gnu.org>
parents: 49458
diff changeset
108 that the tiff library was compiled against.
49451
c4911d7933ae Added notes about PNG support.
Jason Rumney <jasonr@gnu.org>
parents: 42901
diff changeset
109
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
110 * Building
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
111
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
112 After running configure, simply run the appropriate `make' program for
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
113 your compiler to build Emacs. For MSVC, this is nmake; for GCC, it is
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
114 GNU make.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
115
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
116 As the files are compiled, you will see some warning messages
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
117 declaring that some functions don't return a value, or that some data
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
118 conversions will be lossy, etc. You can safely ignore these messages.
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
119 The warnings may be fixed in the main FSF source at some point, but
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
120 until then we will just live with them.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
121
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
122 * Installing
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
123
39144
7baf228a27e6 Mention that "make install" can be "nmake install".
Eli Zaretskii <eliz@gnu.org>
parents: 37885
diff changeset
124 To install Emacs after it has compiled, simply run `nmake install'
7baf228a27e6 Mention that "make install" can be "nmake install".
Eli Zaretskii <eliz@gnu.org>
parents: 37885
diff changeset
125 or `make install', depending on which version of the Make utility
7baf228a27e6 Mention that "make install" can be "nmake install".
Eli Zaretskii <eliz@gnu.org>
parents: 37885
diff changeset
126 do you have.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
127
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
128 By default, Emacs will be installed in the location where it was
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
129 built, but a different location can be specified either using the
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
130 --prefix option to configure, or by setting INSTALL_DIR when running
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
131 make, like so:
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
132
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
133 make install INSTALL_DIR=D:/emacs
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
134
39144
7baf228a27e6 Mention that "make install" can be "nmake install".
Eli Zaretskii <eliz@gnu.org>
parents: 37885
diff changeset
135 (for `nmake', type "nmake install INSTALL_DIR=D:/emacs" instead).
7baf228a27e6 Mention that "make install" can be "nmake install".
Eli Zaretskii <eliz@gnu.org>
parents: 37885
diff changeset
136
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
137 The install process will run addpm to setup the registry entries, and
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
138 to create a Start menu icon for Emacs.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
139
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
140 * Trouble-shooting
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
141
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
142 The main problems that are likely to be encountered when building
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
143 Emacs stem from using an old version of GCC, or old Mingw or W32 API
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
144 headers. Additionally, cygwin ports of GNU make may require the Emacs
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
145 source tree to be mounted with text!=binary, because the makefiles
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
146 generated by configure.bat necessarily use DOS line endings. Also,
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
147 cygwin ports of make must run in UNIX mode, either by specifying
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
148 --unix on the command line, or MAKE_MODE=UNIX in the environment.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
149
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
150 When configure runs, it attempts to detect when GCC itself, or the
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
151 headers it is using, are not suitable for building Emacs. GCC version
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
152 2.95 or later is needed, because that is when the Windows port gained
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
153 sufficient support for anonymous structs and unions to cope with some
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
154 definitions from winnt.h that are used by addsection.c. The W32 API
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
155 headers that come with Cygwin b20.1 are incomplete, and do not include
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
156 some definitions required by addsection.c, for instance. Also, older
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
157 releases of the W32 API headers from Anders Norlander contain a typo
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
158 in the definition of IMAGE_FIRST_SECTION in winnt.h, which
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
159 addsection.c relies on. Versions of w32api-xxx.zip from at least
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
160 1999-11-18 onwards are okay.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
161
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
162 If configure succeeds, but make fails, install the Cygwin port of
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
163 Bash, even if the table above indicates that Emacs should be able to
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
164 build without sh.exe. (Some versions of Windows shells are too dumb
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
165 for Makefile's used by Emacs.)
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
166
39462
7bc2236b1036 Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents: 39152
diff changeset
167 If you are using certain Cygwin builds of GCC, such as Cygwin version
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
168 1.1.8, you may need to specify some extra compiler flags like so:
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
169
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
170 configure --with-gcc --cflags -mwin32 --cflags -D__MSVCRT__
36576
9f0620f192bd Add --ldflags to configure line for building with
Andrew Innes <andrewi@gnu.org>
parents: 35870
diff changeset
171 --ldflags -mwin32
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
172
39462
7bc2236b1036 Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents: 39152
diff changeset
173 However, the latest Cygwin versions, such as 1.3.3, don't need those
7bc2236b1036 Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents: 39152
diff changeset
174 switches; you can simply use "configure --with-gcc".
7bc2236b1036 Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents: 39152
diff changeset
175
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
176 We will attempt to auto-detect the need for these flags in a future
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
177 release.
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
178
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
179 * Debugging
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
180
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
181 You should be able to debug Emacs using the debugger that is
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
182 appropriate for the compiler you used, namely DevStudio or Windbg if
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
183 compiled with MSVC, or gdb if compiled with gcc.
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
184
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
185 Emacs functions implemented in C use a naming convention that reflects
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
186 their names in lisp. The names of the C routines are the lisp names
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
187 prefixed with 'F', and with dashes converted to underscores. For
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
188 example, the function call-process is implemented in C by
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
189 Fcall_process. Similarly, lisp variables are prefixed with 'V', again
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
190 with dashes converted to underscores. These conventions enable you to
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
191 easily set breakpoints or examine familiar lisp variables by name.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
192
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
193 Since Emacs data is often in the form of a lisp object, and the
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
194 Lisp_Object type is difficult to examine manually in the MSVC
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
195 debugger, Emacs provides a helper routine called debug_print that
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
196 prints out a readable representation of a Lisp_Object. (If you are
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
197 using gdb, there is a .gdbinit file in the src directory which
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
198 provides definitions that are useful for examining lisp objects. The
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
199 following tips are mainly of interest when using MSVC.) The output
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
200 from debug_print is sent to stderr, and to the debugger via the
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
201 OutputDebugString routine. The output sent to stderr should be
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
202 displayed in the console window that was opened when the emacs.exe
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
203 executable was started. The output sent to the debugger should be
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
204 displayed in its "Debug" output window.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
205
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
206 When you are in the process of debugging Emacs and you would like to
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
207 examine the contents of a Lisp_Object variable, popup the QuickWatch
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
208 window (QuickWatch has an eyeglass symbol on its button in the
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
209 toolbar). In the text field at the top of the window, enter
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
210 debug_print(<variable>) and hit return. For example, start and run
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
211 Emacs in the debugger until it is waiting for user input. Then click
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
212 on the Break button in the debugger to halt execution. Emacs should
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
213 halt in ZwUserGetMessage waiting for an input event. Use the Call
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
214 Stack window to select the procedure w32_msp_pump up the call stack
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
215 (see below for why you have to do this). Open the QuickWatch window
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
216 and enter debug_print(Vexec_path). Evaluating this expression will
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
217 then print out the contents of the lisp variable exec-path.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
218
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
219 If QuickWatch reports that the symbol is unknown, then check the call
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
220 stack in the Call Stack window. If the selected frame in the call
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
221 stack is not an Emacs procedure, then the debugger won't recognize
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
222 Emacs symbols. Instead, select a frame that is inside an Emacs
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
223 procedure and try using debug_print again.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
224
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
225 If QuickWatch invokes debug_print but nothing happens, then check the
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
226 thread that is selected in the debugger. If the selected thread is
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
227 not the last thread to run (the "current" thread), then it cannot be
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
228 used to execute debug_print. Use the Debug menu to select the current
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
229 thread and try using debug_print again. Note that the debugger halts
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
230 execution (e.g., due to a breakpoint) in the context of the current
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
231 thread, so this should only be a problem if you've explicitly switched
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
232 threads.
37710
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
233
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
234 COPYING PERMISSIONS
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
235
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
236 Permission is granted to anyone to make or distribute verbatim copies
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
237 of this document as received, in any medium, provided that the
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
238 copyright notice and permission notice are preserved,
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
239 and that the distributor grants the recipient permission
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
240 for further redistribution as permitted by this notice.
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
241
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
242 Permission is granted to distribute modified versions
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
243 of this document, or of portions of it,
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
244 under the above conditions, provided also that they
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
245 carry prominent notices stating who last changed them,
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
246 and that any new or changed statements about the activities
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
247 of the Free Software Foundation are approved by the Foundation.