annotate nt/INSTALL @ 63979:386fe46d1e12

(pgg-gpg): Finish `defgroup' description with period.
author Juanma Barranquero <lekktu@gmail.com>
date Mon, 04 Jul 2005 00:56:54 +0000
parents ba2dabf111a3
children 3723093a21fd b7da78284d4c
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
55896
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
2 on Windows NT/2K/XP and Windows 95/98/ME
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
3
62675
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
4 Copyright (c) 2001,2004,2005 Free Software Foundation, Inc.
37710
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:
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
18
52416
79fdcc780508 Add note about fixing line ends when building from CVS.
Jason Rumney <jasonr@gnu.org>
parents: 49871
diff changeset
19 cvs update -kb
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
20
63571
ba2dabf111a3 Remove warning about -kb. Update W32 build page URL.
Eli Zaretskii <eliz@gnu.org>
parents: 63319
diff changeset
21 Alternatively, use programs that convert end-of-line format, such as
ba2dabf111a3 Remove warning about -kb. Update W32 build page URL.
Eli Zaretskii <eliz@gnu.org>
parents: 63319
diff changeset
22 dos2unix and unix2dos available from GnuWin32 or dtou and utod from
ba2dabf111a3 Remove warning about -kb. Update W32 build page URL.
Eli Zaretskii <eliz@gnu.org>
parents: 63319
diff changeset
23 the DJGPP project.
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
24
57565
5bab1954e91f Added note to see INSTALL.CVS, and to make sure touch creates files.
Jason Rumney <jasonr@gnu.org>
parents: 55977
diff changeset
25 In addition to this file, you should also read INSTALL.CVS in the
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
26 parent directory, and make sure that you have a version of
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
27 "touch.exe" in your path, and that it will create files that do not
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
28 yet exist.
52416
79fdcc780508 Add note about fixing line ends when building from CVS.
Jason Rumney <jasonr@gnu.org>
parents: 49871
diff changeset
29
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
30 To compile Emacs, you will need either Microsoft Visual C++ 2.0 or
62675
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
31 later and nmake, or a Windows port of GCC 2.95 or later with MinGW
37885
0cd37e185384 Clarify that building with MSVC requires nmake.
Jason Rumney <jasonr@gnu.org>
parents: 37710
diff changeset
32 and W32 API support and a port of GNU make. You can use the Cygwin
62675
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
33 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
34 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
35 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
36
49871
4f204ad4bdf9 Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
parents: 49600
diff changeset
37 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
38 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
39 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
40 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
41 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
42 in the previous paragraph.
4f204ad4bdf9 Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
parents: 49600
diff changeset
43
62675
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
44 You will also need a copy of the Posix cp, rm and mv programs. These
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
45 and other useful Posix utilities can be obtained from one of several
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
46 projects:
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
47
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
48 * http://www.mingw.org/ ( MinGW )
62677
850c9d934e12 Stupid, stupid me.
Juanma Barranquero <lekktu@gmail.com>
parents: 62675
diff changeset
49 * http://www.cygwin.com/ ( Cygwin )
62675
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
50 * http://unxutils.sourceforge.net/ ( UnxUtils )
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
51 * http://gnuwin32.sourceforge.net/ ( GnuWin32 )
57565
5bab1954e91f Added note to see INSTALL.CVS, and to make sure touch creates files.
Jason Rumney <jasonr@gnu.org>
parents: 55977
diff changeset
52
55896
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
53 If you build Emacs on Windows 9X or ME, not on Windows 2K/XP or
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
54 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
55
62675
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
56 Additional instructions and help for building Emacs on Windows can be
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
57 found at the Emacs Wiki:
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
58
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
59 http://www.emacswiki.org/cgi-bin/wiki/WThirtyTwoInstallationKit
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
60
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
61 and at this URL:
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
62
63571
ba2dabf111a3 Remove warning about -kb. Update W32 build page URL.
Eli Zaretskii <eliz@gnu.org>
parents: 63319
diff changeset
63 http://ourcomments.org/Emacs/w32-build-emacs.html
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
64
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
65 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
66 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
67 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
68 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
69 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
70 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
71 "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
72 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
73
a8392117d6de Document problems with 4NT.
Eli Zaretskii <eliz@gnu.org>
parents: 41327
diff changeset
74 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
75 at least for 4NT version 3.01. Use cmd.exe, the default NT shell,
57697
64443697a546 Add note about MSYS sh.exe
Jason Rumney <jasonr@gnu.org>
parents: 57565
diff changeset
76 instead. MSYS sh.exe also appears to cause various problems. If you have
64443697a546 Add note about MSYS sh.exe
Jason Rumney <jasonr@gnu.org>
parents: 57565
diff changeset
77 MSYS installed, try "make SHELL=cmd.exe" to force the use of cmd.exe
64443697a546 Add note about MSYS sh.exe
Jason Rumney <jasonr@gnu.org>
parents: 57565
diff changeset
78 instead of sh.exe.
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 49565
diff changeset
79
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
80 sh exists no sh
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
81
41327
f45165ce5cbc Update table of versions of make that are suitable
Jason Rumney <jasonr@gnu.org>
parents: 39462
diff changeset
82 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
83 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
84 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
85 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
86 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
87 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
88 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
89 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
90 mingw32 compiled make 3.79.1: okay okay
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
91 mingw32 compiled make 3.80: okay unknown[6]
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
92
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
93 Notes:
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
94
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
95 [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
96 emacs source with text!=binary.
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
97 [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
98 [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
99 versions of cygwin.
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
100 [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
101 [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
102 May work if building emacs without leim.
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
103 [6] please report if you try this combination.
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
104
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
105 * Configuring
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
106
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
107 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
108 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
109 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
110 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
111 options on the command line when invoking configure.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
112
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
113 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
114 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
115 options. To see what options are available, run `configure --help'.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
116
31625
345a3f5a7193 Add note about expected error messages when configure
Andrew Innes <andrewi@gnu.org>
parents: 31083
diff changeset
117 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
118 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
119 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
120
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
121 You are encouraged to look at the file config.log which shows details
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
122 for failed tests, after configure.bat finishes. Any unexplained failure
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
123 should be investigated and perhaps reported as a bug (see the section
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
124 about reporting bugs in the file README in this directory and in the
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
125 Emacs manual).
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
126
49451
c4911d7933ae Added notes about PNG support.
Jason Rumney <jasonr@gnu.org>
parents: 42901
diff changeset
127 * Optional image library support
c4911d7933ae Added notes about PNG support.
Jason Rumney <jasonr@gnu.org>
parents: 42901
diff changeset
128
55896
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
129 In addition to its "native" image formats (pbm and xbm), Emacs can
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
130 handle other image types: xpm, tiff, gif, png and jpeg (postscript is
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
131 currently unsupported on Windows). To build Emacs with support for
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
132 them, the corresponding headers must be in the include path when the
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
133 configure script is run. This can be setup using environment
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
134 variables, or by specifying --cflags -I... options on the command-line
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
135 to configure.bat. The configure script will report whether it was
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
136 able to detect the headers. If the results of this testing appear to be
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
137 incorrect, please look for details in the file config.log: it will show
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
138 the failed test programs and compiler error messages that should explain
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
139 what is wrong. (Usually, any such failures happen because some headers
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
140 are missing due to bad packaging of the image support libraries.)
49451
c4911d7933ae Added notes about PNG support.
Jason Rumney <jasonr@gnu.org>
parents: 42901
diff changeset
141
55896
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
142 To use the external image support, the DLLs implementing the
62675
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
143 functionality must be found when Emacs first needs them, either on the
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
144 PATH, or in the same directory as emacs.exe. Failure to find a
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
145 library is not an error; the associated image format will simply be
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
146 unavailable. Note that once Emacs has determined that a library can
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
147 not be found, there's no way to force it to try again, other than
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
148 restarting. See the variable `image-library-alist' to configure the
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
149 expected names of the libraries.
55896
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
150
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
151 Some image libraries have dependencies on one another, or on zlib.
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
152 For example, tiff support depends on the jpeg library. If you did not
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
153 compile the libraries yourself, you must make sure that any dependency
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
154 is in the PATH or otherwise accesible and that the binaries are
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
155 compatible (for example, that they were built with the same compiler).
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
156
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
157 Binaries for the image libraries (among many others) can be found at
62675
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
158 the GnuWin32 project. These are built with MinGW, but they can be
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
159 used with both GCC/MinGW and MSVC builds of Emacs. See the info on
63319
382121c868f8 Update the URL of the Emacs Windows build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 63308
diff changeset
160 http://ourcomments.org/Emacs/EmacsW32.html for more details about
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
161 installing image support libraries.
49451
c4911d7933ae Added notes about PNG support.
Jason Rumney <jasonr@gnu.org>
parents: 42901
diff changeset
162
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
163 * Building
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
164
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
165 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
166 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
167 GNU make.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
168
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
169 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
170 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
171 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
172 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
173 until then we will just live with them.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
174
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
175 * Installing
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
176
39144
7baf228a27e6 Mention that "make install" can be "nmake install".
Eli Zaretskii <eliz@gnu.org>
parents: 37885
diff changeset
177 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
178 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
179 do you have.
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 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
182 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
183 --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
184 make, like so:
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
185
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
186 make install INSTALL_DIR=D:/emacs
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
187
39144
7baf228a27e6 Mention that "make install" can be "nmake install".
Eli Zaretskii <eliz@gnu.org>
parents: 37885
diff changeset
188 (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
189
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
190 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
191 to create a Start menu icon for Emacs.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
192
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
193 * Trouble-shooting
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
194
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
195 The main problems that are likely to be encountered when building
62675
114ecd5ee47b Add more pointers to ports of Unix tools to Windows, and to the Emacs Wiki
Juanma Barranquero <lekktu@gmail.com>
parents: 57697
diff changeset
196 Emacs stem from using an old version of GCC, or old MinGW or W32 API
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
197 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
198 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
199 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
200 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
201 --unix on the command line, or MAKE_MODE=UNIX in the environment.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
202
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
203 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
204 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
205 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
206 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
207 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
208 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
209 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
210 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
211 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
212 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
213 1999-11-18 onwards are okay.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
214
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
215 When in doubt about correctness of what configure did, look at the file
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
216 config.log, which shows all the failed test programs and compiler
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
217 messages associated with the failures. If that doesn't give a clue,
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
218 please report the problems, together with the relevant fragments from
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
219 config.log, as bugs.
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
220
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
221 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
222 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
223 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
224 for Makefile's used by Emacs.)
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
225
39462
7bc2236b1036 Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents: 39152
diff changeset
226 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
227 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
228
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
229 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
230 --ldflags -mwin32
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
231
39462
7bc2236b1036 Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents: 39152
diff changeset
232 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
233 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
234
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
235 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
236 release.
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
237
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
238 * Debugging
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
239
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
240 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
241 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
242 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
243
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
244 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
245 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
246 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
247 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
248 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
249 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
250 easily set breakpoints or examine familiar lisp variables by name.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
251
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
252 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
253 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
254 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
255 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
256 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
257 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
258 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
259 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
260 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
261 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
262 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
263 displayed in its "Debug" output window.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
264
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
265 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
266 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
267 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
268 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
269 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
270 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
271 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
272 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
273 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
274 (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
275 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
276 then print out the contents of the lisp variable exec-path.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
277
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
278 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
279 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
280 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
281 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
282 procedure and try using debug_print again.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
283
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
284 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
285 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
286 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
287 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
288 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
289 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
290 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
291 threads.
37710
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
292
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
293 COPYING PERMISSIONS
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
294
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
295 Permission is granted to anyone to make or distribute verbatim copies
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
296 of this document as received, in any medium, provided that the
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
297 copyright notice and permission notice are preserved,
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
298 and that the distributor grants the recipient permission
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
299 for further redistribution as permitted by this notice.
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
300
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
301 Permission is granted to distribute modified versions
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
302 of this document, or of portions of it,
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
303 under the above conditions, provided also that they
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
304 carry prominent notices stating who last changed them,
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
305 and that any new or changed statements about the activities
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
306 of the Free Software Foundation are approved by the Foundation.