annotate nt/INSTALL @ 93570:c450cdd35ee3

(latin1-display): Don't use make-char. Fix the argument to set-char-table-range. (latin1-display-identities): Don't use make-char. (latin1-display-reset): Use map-charset-chars instead of directly calling standard-display-default. (latin1-display-check-font): Don't use make-char. (latin1-display-setup): Likewise. (latin1-display-ucs-per-lynx): Likewise.
author Kenichi Handa <handa@m17n.org>
date Thu, 03 Apr 2008 03:51:54 +0000
parents f991f10f15ec
children 2368e43fd306
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
79730
e27f17d9c8ed Add 2008 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 78246
diff changeset
4 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
5 Free Software Foundation, Inc.
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
6 See the end of the file for license conditions.
37710
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
7
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
8 * For the impatient
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
9
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
10 Here are the concise instructions for configuring and building the
76409
bc888d5165fb There's no such thing as "Windows32" binaries.
Eli Zaretskii <eliz@gnu.org>
parents: 76394
diff changeset
11 native Windows binary of Emacs, for those who want to skip the
bc888d5165fb There's no such thing as "Windows32" binaries.
Eli Zaretskii <eliz@gnu.org>
parents: 76394
diff changeset
12 complex explanations and ``just do it'':
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
13
76419
2aa3b9a00485 Say explicitly this is not for Cygwin.
Richard M. Stallman <rms@gnu.org>
parents: 76411
diff changeset
14 Do not use this recipe with Cygwin. For building on Cygwin,
2aa3b9a00485 Say explicitly this is not for Cygwin.
Richard M. Stallman <rms@gnu.org>
parents: 76411
diff changeset
15 use the normal installation instructions, ../INSTALL.
2aa3b9a00485 Say explicitly this is not for Cygwin.
Richard M. Stallman <rms@gnu.org>
parents: 76411
diff changeset
16
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
17 1. Change to the `nt' directory (the directory of this file):
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
18
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
19 cd nt
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
20
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
21 2. Run configure.bat. From the COMMAND.COM/CMD.EXE command prompt:
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
22
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
23 configure
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
24
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
25 from a Unixy shell prompt:
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
26
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
27 cmd /c configure.bat
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
28 or
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
29 command.com /c configure.bat
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
30
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
31 3. Run the Make utility suitable for your environment. If you build
76278
dc5475982593 Add URL of another site with detailed build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 76272
diff changeset
32 with the Microsoft's Visual C compiler (but see notes about using
dc5475982593 Add URL of another site with detailed build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 76272
diff changeset
33 VC++ 8.0 and later below):
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
34
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
35 nmake
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
36
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
37 For the development environments based on GNU GCC (MinGW, MSYS,
72141
c5e963b6d40d Add notes about Cygwin make to impatient section.
Jason Rumney <jasonr@gnu.org>
parents: 71594
diff changeset
38 Cygwin - but see notes about Cygwin make below), depending on how
c5e963b6d40d Add notes about Cygwin make to impatient section.
Jason Rumney <jasonr@gnu.org>
parents: 71594
diff changeset
39 Make is called, it could be:
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
40
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
41 make
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
42 or
72141
c5e963b6d40d Add notes about Cygwin make to impatient section.
Jason Rumney <jasonr@gnu.org>
parents: 71594
diff changeset
43 mingw32-make
c5e963b6d40d Add notes about Cygwin make to impatient section.
Jason Rumney <jasonr@gnu.org>
parents: 71594
diff changeset
44 or
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
45 gnumake
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
46 or
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
47 gmake
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
48
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
49 (If you are building from CVS, say "make bootstrap" or "nmake
74820
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
50 bootstrap" instead, and avoid using Cygwin make.)
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
51
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
52 With GNU Make, you can use the -j command-line option to have
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
53 Make execute several commands at once, like this:
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
54
74937
e89aaee63398 Update table of supported Make ports. Show "make -j" command that is known
Eli Zaretskii <eliz@gnu.org>
parents: 74820
diff changeset
55 gmake -j 2 XMFLAGS="-j 2"
74820
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
56
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
57 The XMFLAGS variable overrides the default behavior of GNU Make
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
58 on Windows, whereby recursive Make invocations reset the maximum
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
59 number of simultaneous commands to 1. The above command allows
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
60 up to 4 simultaneous commands at once in the top-level Make, and
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
61 up to 3 in each one of the recursive Make's.
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
62
71548
b1556bb47998 Mention that makeinfo.exe is required for make 'info'.
Eli Zaretskii <eliz@gnu.org>
parents: 71164
diff changeset
63 4. Generate the Info manuals (only if you are building out of CVS, and
b1556bb47998 Mention that makeinfo.exe is required for make 'info'.
Eli Zaretskii <eliz@gnu.org>
parents: 71164
diff changeset
64 if you have makeinfo.exe installed):
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
65
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
66 make info
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
67
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
68 (change "make" to "nmake" if you use MSVC).
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
69
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
70 5. Install the produced binaries:
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
71
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
72 make install
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
73
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
74 That's it!
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
75
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
76 If these short instructions somehow fail, read the rest of this
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
77 file.
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
78
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
79 * Preliminaries
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
80
76409
bc888d5165fb There's no such thing as "Windows32" binaries.
Eli Zaretskii <eliz@gnu.org>
parents: 76394
diff changeset
81 If you want to build a Cygwin port of Emacs, use the instructions in
76411
d1b77c63c4d2 Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 76409
diff changeset
82 the INSTALL file in the main Emacs directory (the parent of this
76409
bc888d5165fb There's no such thing as "Windows32" binaries.
Eli Zaretskii <eliz@gnu.org>
parents: 76394
diff changeset
83 directory). These instructions are for building a native Windows
bc888d5165fb There's no such thing as "Windows32" binaries.
Eli Zaretskii <eliz@gnu.org>
parents: 76394
diff changeset
84 binary of Emacs.
bc888d5165fb There's no such thing as "Windows32" binaries.
Eli Zaretskii <eliz@gnu.org>
parents: 76394
diff changeset
85
39152
ac1c50b8ffea Suggest not to use WinZip.
Eli Zaretskii <eliz@gnu.org>
parents: 39144
diff changeset
86 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
87 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
88 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
89 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
90 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
91 site.
ac1c50b8ffea Suggest not to use WinZip.
Eli Zaretskii <eliz@gnu.org>
parents: 39144
diff changeset
92
52416
79fdcc780508 Add note about fixing line ends when building from CVS.
Jason Rumney <jasonr@gnu.org>
parents: 49871
diff changeset
93 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
94 (.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
95 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
96 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
97
52416
79fdcc780508 Add note about fixing line ends when building from CVS.
Jason Rumney <jasonr@gnu.org>
parents: 49871
diff changeset
98 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
99
63571
ba2dabf111a3 Remove warning about -kb. Update W32 build page URL.
Eli Zaretskii <eliz@gnu.org>
parents: 63319
diff changeset
100 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
101 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
102 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
103
92148
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 91772 80108
diff changeset
104 Additionally, the files lisp/international/uni-*.el and
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 91772 80108
diff changeset
105 lisp/ldefs-boot.el need Unix line ends due to some embedded ^M
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 91772 80108
diff changeset
106 characters that are not at the end of the line. So in the
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 91772 80108
diff changeset
107 lisp/international directory you should run the following command, or
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 91772 80108
diff changeset
108 use dos2unix on those files.
91772
db64fb3d9118 Added note about line ends of lisp/international uni-*.el files.
Jason Rumney <jasonr@gnu.org>
parents: 79730
diff changeset
109
db64fb3d9118 Added note about line ends of lisp/international uni-*.el files.
Jason Rumney <jasonr@gnu.org>
parents: 79730
diff changeset
110 cvs update -kb uni-*.el
db64fb3d9118 Added note about line ends of lisp/international uni-*.el files.
Jason Rumney <jasonr@gnu.org>
parents: 79730
diff changeset
111
92148
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 91772 80108
diff changeset
112 and in the lisp directory, use the command:
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 91772 80108
diff changeset
113
f991f10f15ec Merge from emacs--rel--22
Miles Bader <miles@gnu.org>
parents: 91772 80108
diff changeset
114 cvs update -kb lisp/ldefs-boot.el
80085
fec20797989e Add note about ldefs-boot.el line ends.
Jason Rumney <jasonr@gnu.org>
parents: 79730
diff changeset
115
57565
5bab1954e91f Added note to see INSTALL.CVS, and to make sure touch creates files.
Jason Rumney <jasonr@gnu.org>
parents: 55977
diff changeset
116 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
117 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
118 "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
119 yet exist.
52416
79fdcc780508 Add note about fixing line ends when building from CVS.
Jason Rumney <jasonr@gnu.org>
parents: 49871
diff changeset
120
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
121 * Supported development environments
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
122
76272
ca2c6759e770 Noted where we first mention MSVC 2.0 and later that "or later" stops at 7.0.
Jason Rumney <jasonr@gnu.org>
parents: 75769
diff changeset
123 To compile Emacs, you will need either Microsoft Visual C++ 2.0, or
ca2c6759e770 Noted where we first mention MSVC 2.0 and later that "or later" stops at 7.0.
Jason Rumney <jasonr@gnu.org>
parents: 75769
diff changeset
124 later up to 7.0, and nmake, or a Windows port of GCC 2.95 or later
ca2c6759e770 Noted where we first mention MSVC 2.0 and later that "or later" stops at 7.0.
Jason Rumney <jasonr@gnu.org>
parents: 75769
diff changeset
125 with MinGW and W32 API support and a port of GNU Make. You can use
ca2c6759e770 Noted where we first mention MSVC 2.0 and later that "or later" stops at 7.0.
Jason Rumney <jasonr@gnu.org>
parents: 75769
diff changeset
126 the Cygwin ports of GCC, but Emacs requires the MinGW headers and
ca2c6759e770 Noted where we first mention MSVC 2.0 and later that "or later" stops at 7.0.
Jason Rumney <jasonr@gnu.org>
parents: 75769
diff changeset
127 libraries to build (latest versions of the Cygwin toolkit, at least
ca2c6759e770 Noted where we first mention MSVC 2.0 and later that "or later" stops at 7.0.
Jason Rumney <jasonr@gnu.org>
parents: 75769
diff changeset
128 since v1.3.3, include the MinGW headers and libraries as an integral
ca2c6759e770 Noted where we first mention MSVC 2.0 and later that "or later" stops at 7.0.
Jason Rumney <jasonr@gnu.org>
parents: 75769
diff changeset
129 part).
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
130
76272
ca2c6759e770 Noted where we first mention MSVC 2.0 and later that "or later" stops at 7.0.
Jason Rumney <jasonr@gnu.org>
parents: 75769
diff changeset
131 Note that building Emacs with Visual Studio 2005 (VC++ 8.0) is not
76278
dc5475982593 Add URL of another site with detailed build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 76272
diff changeset
132 supported at this time, due to changes introduced by Microsoft into
dc5475982593 Add URL of another site with detailed build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 76272
diff changeset
133 the libraries shipped with the compiler.
74937
e89aaee63398 Update table of supported Make ports. Show "make -j" command that is known
Eli Zaretskii <eliz@gnu.org>
parents: 74820
diff changeset
134
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
135 The rest of this file assumes you have a working development
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
136 environment. If you just installed such an environment, try
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
137 building a trivial C "Hello world" program, and see if it works. If
76827
aa7f7988d3bb Mention the VCVARS32.BAT batch file for VS.NET users.
Eli Zaretskii <eliz@gnu.org>
parents: 76419
diff changeset
138 it doesn't work, resolve that problem first! If you use Microsoft
aa7f7988d3bb Mention the VCVARS32.BAT batch file for VS.NET users.
Eli Zaretskii <eliz@gnu.org>
parents: 76419
diff changeset
139 Visual Studio .NET 2003, don't forget to run the VCVARS32.BAT batch
aa7f7988d3bb Mention the VCVARS32.BAT batch file for VS.NET users.
Eli Zaretskii <eliz@gnu.org>
parents: 76419
diff changeset
140 file from the `Bin' subdirectory of the directory where you have
aa7f7988d3bb Mention the VCVARS32.BAT batch file for VS.NET users.
Eli Zaretskii <eliz@gnu.org>
parents: 76419
diff changeset
141 installed VS.NET.
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
142
67016
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
143 If you use the MinGW port of GCC and GNU Make to build Emacs, there
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
144 are some compatibility issues wrt Make and the shell that is run by
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
145 Make, either the standard COMMAND.COM/CMD.EXE supplied with Windows
73297
f4d7960fe496 Add compatibility data for Cygwin Make 3.81.
Eli Zaretskii <eliz@gnu.org>
parents: 72141
diff changeset
146 or sh.exe., a port of a Unixy shell. For reference, below is a list
67016
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
147 of which builds of GNU Make are known to work or not, and whether
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
148 they work in the presence and/or absence of sh.exe, the Cygwin port
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
149 of Bash. Note that any version of Make that is compiled with Cygwin
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
150 will only work with Cygwin tools, due to the use of cygwin style
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
151 paths. This means Cygwin Make is unsuitable for building parts of
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
152 Emacs that need to invoke Emacs itself (leim and "make bootstrap",
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
153 for example). Also see the Trouble-shooting section below if you
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
154 decide to go ahead and use Cygwin make.
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
155
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
156 In addition, using 4NT as your shell is known to fail the build process,
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
157 at least for 4NT version 3.01. Use CMD.EXE, the default Windows shell,
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
158 instead. MSYS sh.exe also appears to cause various problems. If you have
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
159 MSYS installed, try "make SHELL=cmd.exe" to force the use of cmd.exe
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
160 instead of sh.exe.
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
161
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
162 sh exists no sh
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
163
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
164 cygwin b20.1 make (3.75): fails[1, 5] fails[2, 5]
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
165 MSVC compiled gmake 3.77: okay okay
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
166 MSVC compiled gmake 3.78.1: okay okay
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
167 MSVC compiled gmake 3.79.1: okay okay
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
168 mingw32/gcc-2.92.2 make (3.77): okay okay[4]
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
169 cygwin compiled gmake 3.77: fails[1, 5] fails[2, 5]
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
170 cygwin compiled make 3.78.1: fails[5] fails[2, 5]
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
171 cygwin compiled make 3.79.1: fails[3, 5] fails[2?, 5]
77644
6ec2f8deab6d Add information about building with Cygwin Make 3.80.
Eli Zaretskii <eliz@gnu.org>
parents: 76827
diff changeset
172 cygwin compiled make 3.80: okay[6] fails?[7]
6ec2f8deab6d Add information about building with Cygwin Make 3.80.
Eli Zaretskii <eliz@gnu.org>
parents: 76827
diff changeset
173 cygwin compiled make 3.81: fails fails?[7]
67016
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
174 mingw32 compiled make 3.79.1: okay okay
77644
6ec2f8deab6d Add information about building with Cygwin Make 3.80.
Eli Zaretskii <eliz@gnu.org>
parents: 76827
diff changeset
175 mingw32 compiled make 3.80: okay okay[7]
6ec2f8deab6d Add information about building with Cygwin Make 3.80.
Eli Zaretskii <eliz@gnu.org>
parents: 76827
diff changeset
176 mingw32 compiled make 3.81: okay okay[8]
67016
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
177
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
178 Notes:
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
179
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
180 [1] doesn't cope with makefiles with DOS line endings, so must mount
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
181 emacs source with text!=binary.
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
182 [2] fails when needs to invoke shell commands; okay invoking gcc etc.
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
183 [3] requires LC_MESSAGES support to build; cannot build with early
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
184 versions of cygwin.
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
185 [4] may fail on Windows 9X and Windows ME; if so, install Bash.
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
186 [5] fails when building leim due to the use of cygwin style paths.
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
187 May work if building emacs without leim.
77644
6ec2f8deab6d Add information about building with Cygwin Make 3.80.
Eli Zaretskii <eliz@gnu.org>
parents: 76827
diff changeset
188 [6] need to uncomment 3 lines in nt/gmake.defs that invoke `cygpath'
6ec2f8deab6d Add information about building with Cygwin Make 3.80.
Eli Zaretskii <eliz@gnu.org>
parents: 76827
diff changeset
189 (look for "cygpath" near line 85 of gmake.defs).
6ec2f8deab6d Add information about building with Cygwin Make 3.80.
Eli Zaretskii <eliz@gnu.org>
parents: 76827
diff changeset
190 [7] not recommended; please report if you try this combination.
6ec2f8deab6d Add information about building with Cygwin Make 3.80.
Eli Zaretskii <eliz@gnu.org>
parents: 76827
diff changeset
191 [8] tested only on Windows XP.
67016
47fccd30153d Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents: 64890
diff changeset
192
49871
4f204ad4bdf9 Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
parents: 49600
diff changeset
193 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
194 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
195 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
196 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
197 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
198 in the previous paragraph.
4f204ad4bdf9 Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
parents: 49600
diff changeset
199
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
200 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
201 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
202 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
203
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
204 * http://gnuwin32.sourceforge.net/ ( GnuWin32 )
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
205 * http://www.mingw.org/ ( MinGW )
62677
850c9d934e12 Stupid, stupid me.
Juanma Barranquero <lekktu@gmail.com>
parents: 62675
diff changeset
206 * 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
207 * http://unxutils.sourceforge.net/ ( UnxUtils )
57565
5bab1954e91f Added note to see INSTALL.CVS, and to make sure touch creates files.
Jason Rumney <jasonr@gnu.org>
parents: 55977
diff changeset
208
55896
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
209 If you build Emacs on Windows 9X or ME, not on Windows 2K/XP or
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
210 Windows NT, we suggest to install the Cygwin port of Bash. That is
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
211 because the native Windows shell COMMAND.COM is too limited; the
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
212 Emacs build procedure tries very hard to support even such limited
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
213 shells, but as none of the Windows developers of Emacs work on
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
214 Windows 9x, we cannot guarantee that it works without a more
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
215 powerful shell.
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
216
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
217 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
218 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
219
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
220 http://www.emacswiki.org/cgi-bin/wiki/WThirtyTwoInstallationKit
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
221
76278
dc5475982593 Add URL of another site with detailed build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 76272
diff changeset
222 and on these URLs:
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
223
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
224 http://ourcomments.org/Emacs/w32-build-emacs.html
76278
dc5475982593 Add URL of another site with detailed build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 76272
diff changeset
225 http://derekslager.com/blog/posts/2007/01/emacs-hack-3-compile-emacs-from-cvs-on-windows.ashx
dc5475982593 Add URL of another site with detailed build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 76272
diff changeset
226
dc5475982593 Add URL of another site with detailed build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 76272
diff changeset
227 The second URL above includes instructions for building with MSVC,
dc5475982593 Add URL of another site with detailed build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 76272
diff changeset
228 as well as with MinGW, while the first URL covers only MinGW, but
dc5475982593 Add URL of another site with detailed build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 76272
diff changeset
229 has more details about it.
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
230
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
231 * Configuring
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
232
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
233 Configuration of Emacs is now handled by running configure.bat in the
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
234 `nt' subdirectory. It will detect which compiler you have available,
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
235 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
236 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
237 options on the command line when invoking configure.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
238
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
239 To configure Emacs to build with GCC or MSVC, whichever is available,
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
240 simply change to the `nt' subdirectory and run `configure.bat' with no
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
241 options. To see what options are available, run `configure --help'.
77780
c0c3bc060eb3 Add information about where to find GDB, and warn against --no-debug option
Eli Zaretskii <eliz@gnu.org>
parents: 77754
diff changeset
242 Do NOT use the --no-debug option to configure.bat unless you are
c0c3bc060eb3 Add information about where to find GDB, and warn against --no-debug option
Eli Zaretskii <eliz@gnu.org>
parents: 77754
diff changeset
243 absolutely sure the produced binaries will never need to be run under
c0c3bc060eb3 Add information about where to find GDB, and warn against --no-debug option
Eli Zaretskii <eliz@gnu.org>
parents: 77754
diff changeset
244 a debugger.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
245
31625
345a3f5a7193 Add note about expected error messages when configure
Andrew Innes <andrewi@gnu.org>
parents: 31083
diff changeset
246 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
247 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
248 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
249
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
250 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
251 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
252 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
253 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
254 Emacs manual).
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
255
49451
c4911d7933ae Added notes about PNG support.
Jason Rumney <jasonr@gnu.org>
parents: 42901
diff changeset
256 * Optional image library support
c4911d7933ae Added notes about PNG support.
Jason Rumney <jasonr@gnu.org>
parents: 42901
diff changeset
257
55896
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
258 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
259 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
260 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
261 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
262 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
263 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
264 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
265 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
266 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
267 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
268 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
269 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
270
55896
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
271 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
272 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
273 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
274 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
275 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
276 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
277 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
278 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
279
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
280 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
281 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
282 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
283 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
284 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
285
8b571de37306 Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents: 52416
diff changeset
286 Binaries for the image libraries (among many others) can be found at
80108
d616730de510 Add note about GTK image libraries.
Jason Rumney <jasonr@gnu.org>
parents: 80085
diff changeset
287 the GnuWin32 project. PNG, JPEG and TIFF libraries are also
d616730de510 Add note about GTK image libraries.
Jason Rumney <jasonr@gnu.org>
parents: 80085
diff changeset
288 included with GTK, which is installed along with other Free Software
d616730de510 Add note about GTK image libraries.
Jason Rumney <jasonr@gnu.org>
parents: 80085
diff changeset
289 that requires it. These are built with MinGW, but they can be used
d616730de510 Add note about GTK image libraries.
Jason Rumney <jasonr@gnu.org>
parents: 80085
diff changeset
290 with both GCC/MinGW and MSVC builds of Emacs. See the info on
77754
8ebf54239937 Fix URL of EmacsW32 site where building with image support is described.
Eli Zaretskii <eliz@gnu.org>
parents: 77644
diff changeset
291 http://ourcomments.org/Emacs/w32-build-emacs.html, under "How to Get
8ebf54239937 Fix URL of EmacsW32 site where building with image support is described.
Eli Zaretskii <eliz@gnu.org>
parents: 77644
diff changeset
292 Images Support", for more details about installing image support
8ebf54239937 Fix URL of EmacsW32 site where building with image support is described.
Eli Zaretskii <eliz@gnu.org>
parents: 77644
diff changeset
293 libraries. Note specifically that, due to some packaging snafus in
8ebf54239937 Fix URL of EmacsW32 site where building with image support is described.
Eli Zaretskii <eliz@gnu.org>
parents: 77644
diff changeset
294 the GnuWin32-supplied image libraries, you will need to download
8ebf54239937 Fix URL of EmacsW32 site where building with image support is described.
Eli Zaretskii <eliz@gnu.org>
parents: 77644
diff changeset
295 _source_ packages for some of the libraries in order to get the
8ebf54239937 Fix URL of EmacsW32 site where building with image support is described.
Eli Zaretskii <eliz@gnu.org>
parents: 77644
diff changeset
296 header files necessary for building Emacs with image support.
49451
c4911d7933ae Added notes about PNG support.
Jason Rumney <jasonr@gnu.org>
parents: 42901
diff changeset
297
80108
d616730de510 Add note about GTK image libraries.
Jason Rumney <jasonr@gnu.org>
parents: 80085
diff changeset
298 If GTK 2.0 is installed, addpm will arrange for its image libraries
d616730de510 Add note about GTK image libraries.
Jason Rumney <jasonr@gnu.org>
parents: 80085
diff changeset
299 to be on the DLL search path for Emacs.
d616730de510 Add note about GTK image libraries.
Jason Rumney <jasonr@gnu.org>
parents: 80085
diff changeset
300
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
301 * Building
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
302
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
303 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
304 your compiler to build Emacs. For MSVC, this is nmake; for GCC, it is
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
305 GNU make. (If you are building out of CVS, say "make bootstrap" or
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
306 "nmake bootstrap" instead.)
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
307
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
308 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
309 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
310 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
311 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
312 until then we will just live with them.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
313
74820
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
314 With GNU Make, you can use the -j command-line option to have Make
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
315 execute several commands at once, like this:
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
316
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
317 gmake -j 4 XMFLAGS="-j 3"
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
318
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
319 The XMFLAGS variable overrides the default behavior of GNU Make on
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
320 Windows, whereby recursive Make invocations reset the maximum number
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
321 of simultaneous commands to 1. The above command allows up to 4
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
322 simultaneous commands at once in the top-level Make, and up to 3 in
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
323 each one of the recursive Make's; you can use other numbers of jobs,
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
324 if you wish.
e50355d072ce Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents: 73297
diff changeset
325
69567
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
326 If you are building from CVS, the following commands will produce
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
327 the Info manuals (which are not part of the CVS repository):
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
328
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
329 make info
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
330 or
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
331 nmake info
be544ed33d82 Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents: 68648
diff changeset
332
71548
b1556bb47998 Mention that makeinfo.exe is required for make 'info'.
Eli Zaretskii <eliz@gnu.org>
parents: 71164
diff changeset
333 Note that you will need makeinfo.exe (from the GNU Texinfo package)
b1556bb47998 Mention that makeinfo.exe is required for make 'info'.
Eli Zaretskii <eliz@gnu.org>
parents: 71164
diff changeset
334 in order for this command to succeed.
b1556bb47998 Mention that makeinfo.exe is required for make 'info'.
Eli Zaretskii <eliz@gnu.org>
parents: 71164
diff changeset
335
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
336 * Installing
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
337
39144
7baf228a27e6 Mention that "make install" can be "nmake install".
Eli Zaretskii <eliz@gnu.org>
parents: 37885
diff changeset
338 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
339 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
340 do you have.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
341
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
342 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
343 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
344 --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
345 make, like so:
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
346
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
347 make install INSTALL_DIR=D:/emacs
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
348
39144
7baf228a27e6 Mention that "make install" can be "nmake install".
Eli Zaretskii <eliz@gnu.org>
parents: 37885
diff changeset
349 (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
350
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
351 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
352 to create a Start menu icon for Emacs.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
353
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
354 * Trouble-shooting
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
355
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
356 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
357 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
358 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
359 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
360 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
361 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
362 --unix on the command line, or MAKE_MODE=UNIX in the environment.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
363
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
364 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
365 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
366 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
367 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
368 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
369 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
370 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
371 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
372 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
373 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
374 1999-11-18 onwards are okay.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
375
63308
51d38cfbe542 Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents: 62677
diff changeset
376 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
377 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
378 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
379 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
380 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
381
35726
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
382 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
383 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
384 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
385 for Makefile's used by Emacs.)
efa42820d1af Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents: 31625
diff changeset
386
39462
7bc2236b1036 Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents: 39152
diff changeset
387 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
388 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
389
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
390 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
391 --ldflags -mwin32
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
392
39462
7bc2236b1036 Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents: 39152
diff changeset
393 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
394 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
395
35870
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
396 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
397 release.
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
398
e3bd30e28be6 (Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents: 35814
diff changeset
399 * Debugging
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
400
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
401 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
402 appropriate for the compiler you used, namely DevStudio or Windbg if
77780
c0c3bc060eb3 Add information about where to find GDB, and warn against --no-debug option
Eli Zaretskii <eliz@gnu.org>
parents: 77754
diff changeset
403 compiled with MSVC, or GDB if compiled with GCC. (GDB for Windows
c0c3bc060eb3 Add information about where to find GDB, and warn against --no-debug option
Eli Zaretskii <eliz@gnu.org>
parents: 77754
diff changeset
404 is available from the MinGW site, http://www.mingw.org/download.shtml.)
67437
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
405
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
406 When Emacs aborts due to a fatal internal error, Emacs on Windows
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
407 pops up an Emacs Abort Dialog asking you whether you want to debug
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
408 Emacs or terminate it. If Emacs was built with MSVC, click YES
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
409 twice, and Windbg or the DevStudio debugger will start up
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
410 automatically. If Emacs was built with GCC, first start GDB and
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
411 attach it to the Emacs process with the "gdb -p EMACS-PID" command,
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
412 where EMACS-PID is the Emacs process ID (which you can see in the
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
413 Windows Task Manager), type the "continue" command inside GDB, and
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
414 only then click YES on the abort dialog. This will pass control to
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
415 the debugger, and you will be able to debug the cause of the fatal
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
416 error.
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
417
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
418 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
419 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
420 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
421 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
422 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
423 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
424 easily set breakpoints or examine familiar lisp variables by name.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
425
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
426 Since Emacs data is often in the form of a lisp object, and the
67437
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
427 Lisp_Object type is difficult to examine manually in a debugger,
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
428 Emacs provides a helper routine called debug_print that prints out a
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
429 readable representation of a Lisp_Object. If you are using GDB,
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
430 there is a .gdbinit file in the src directory which provides
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
431 definitions that are useful for examining lisp objects. Therefore,
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
432 the following tips are mainly of interest when using MSVC.
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
433
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
434 The output from debug_print is sent to stderr, and to the debugger
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
435 via the OutputDebugString routine. The output sent to stderr should
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
436 be displayed in the console window that was opened when the
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
437 emacs.exe executable was started. The output sent to the debugger
dc47c26ee643 Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents: 67016
diff changeset
438 should be displayed in its "Debug" output window.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
439
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
440 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
441 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
442 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
443 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
444 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
445 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
446 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
447 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
448 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
449 (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
450 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
451 then print out the contents of the lisp variable exec-path.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
452
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
453 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
454 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
455 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
456 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
457 procedure and try using debug_print again.
25856
Dave Love <fx@gnu.org>
parents:
diff changeset
458
31083
f64a9a44e2a3 Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents: 25856
diff changeset
459 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
460 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
461 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
462 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
463 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
464 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
465 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
466 threads.
37710
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
467
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
468
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
469 This file is part of GNU Emacs.
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
470
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
471 GNU Emacs is free software; you can redistribute it and/or modify
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
472 it under the terms of the GNU General Public License as published by
78246
075eb71f218d Switch license to GPLv3 or later.
Glenn Morris <rgm@gnu.org>
parents: 77780
diff changeset
473 the Free Software Foundation; either version 3, or (at your option)
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
474 any later version.
37710
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
475
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
476 GNU Emacs is distributed in the hope that it will be useful,
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
477 but WITHOUT ANY WARRANTY; without even the implied warranty of
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
478 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
479 GNU General Public License for more details.
37710
4068826e329f Add copyright notice.
Andrew Innes <andrewi@gnu.org>
parents: 36576
diff changeset
480
75769
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
481 You should have received a copy of the GNU General Public License
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
482 along with GNU Emacs; see the file COPYING. If not, write to the
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
483 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
92a0e87ff562 Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents: 75348
diff changeset
484 Boston, MA 02110-1301, USA.