Mercurial > emacs
annotate nt/INSTALL @ 110428:6060b86fc551
Merge changes made in Gnus trunk.
nnimap.el (nnimap-finish-retrieve-group-infos): Return data in the nntp buffer so the agent can save it.
nnimap.el (nnimap-open-shell-stream): Bind `process-connection-type' to nil, so that CRLF doesn't get translated to \n; (nnimap-open-connection): Don't make 'shell commands only send \n.
nnimap.el (nnimap-request-group): Don't make `M-g' bug out on group with no marks.
gnus-agent.el (gnus-agent-load-alist): Nix out the alist if the file doesn't exist.
nnimap.el (nnimap-finish-retrieve-group-infos): Protect against groups that have no articles.
nnimap.el (nnimap-request-article): Check that we really got an article when we requested one.
gnus-html.el (gnus-html-schedule-image-fetching): Ignore all errors from url-retrieve, for instance about invalid URLs.
gnus-agent.el: Change default of gnus-agent-auto-agentize-methods to nil.
author | Katsumi Yamaoka <yamaoka@jpl.org> |
---|---|
date | Sun, 19 Sep 2010 10:45:51 +0000 |
parents | 1277fe6717c9 |
children | 043e3c078a67 |
rev | line source |
---|---|
109485
bb9894b5234f
* nt/INSTALL: Add note about backslashes in Windows paths.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
1 Building and Installing Emacs on Windows |
bb9894b5234f
* nt/INSTALL: Add note about backslashes in Windows paths.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
2 (from 95 to 7 and beyond) |
25856 | 3 |
106815 | 4 Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 |
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 | 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 |
106653
903baf781824
* INSTALL: Update for CVS->Bazaar switchover.
Karl Fogel <kfogel@red-bean.com>
parents:
102237
diff
changeset
|
49 (If you are building from Bazaar, 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 |
106653
903baf781824
* INSTALL: Update for CVS->Bazaar switchover.
Karl Fogel <kfogel@red-bean.com>
parents:
102237
diff
changeset
|
63 4. Generate the Info manuals (only if you are building out of Bazaar, |
903baf781824
* INSTALL: Update for CVS->Bazaar switchover.
Karl Fogel <kfogel@red-bean.com>
parents:
102237
diff
changeset
|
64 and 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 | 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 | 86 If you used WinZip to unpack the distribution, we suggest to |
87 remove the files and unpack again with a different program! | |
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 | 90 directories, etc. We suggest to use djtarnt.exe from the GNU FTP |
91 site. | |
92 | |
106653
903baf781824
* INSTALL: Update for CVS->Bazaar switchover.
Karl Fogel <kfogel@red-bean.com>
parents:
102237
diff
changeset
|
93 In addition to this file, you should also read INSTALL.BZR in the |
63308
51d38cfbe542
Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents:
62677
diff
changeset
|
94 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
|
95 "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
|
96 yet exist. |
52416
79fdcc780508
Add note about fixing line ends when building from CVS.
Jason Rumney <jasonr@gnu.org>
parents:
49871
diff
changeset
|
97 |
69567
be544ed33d82
Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents:
68648
diff
changeset
|
98 * Supported development environments |
be544ed33d82
Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents:
68648
diff
changeset
|
99 |
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
|
100 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
|
101 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
|
102 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
|
103 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
|
104 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
|
105 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
|
106 part). |
31083
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
107 |
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
|
108 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
|
109 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
|
110 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
|
111 |
69567
be544ed33d82
Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents:
68648
diff
changeset
|
112 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
|
113 environment. If you just installed such an environment, try |
be544ed33d82
Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents:
68648
diff
changeset
|
114 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
|
115 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
|
116 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
|
117 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
|
118 installed VS.NET. |
69567
be544ed33d82
Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents:
68648
diff
changeset
|
119 |
67016
47fccd30153d
Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents:
64890
diff
changeset
|
120 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
|
121 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
|
122 Make, either the standard COMMAND.COM/CMD.EXE supplied with Windows |
106668
75fb4d306cdf
INSTALL: Remove obsolete notes about line endings, and fix some typos.
Juanma Barranquero <lekktu@gmail.com>
parents:
106653
diff
changeset
|
123 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
|
124 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
|
125 they work in the presence and/or absence of sh.exe, the Cygwin port |
102237
a496b8e22c51
* INSTALL: Add comment about TCC; fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents:
101038
diff
changeset
|
126 of Bash. Note that any version of Make that is compiled with Cygwin |
106668
75fb4d306cdf
INSTALL: Remove obsolete notes about line endings, and fix some typos.
Juanma Barranquero <lekktu@gmail.com>
parents:
106653
diff
changeset
|
127 will only work with Cygwin tools, due to the use of Cygwin style |
67016
47fccd30153d
Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents:
64890
diff
changeset
|
128 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
|
129 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
|
130 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
|
131 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
|
132 |
102237
a496b8e22c51
* INSTALL: Add comment about TCC; fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents:
101038
diff
changeset
|
133 In addition, using 4NT or TCC as your shell is known to fail the build |
a496b8e22c51
* INSTALL: Add comment about TCC; fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents:
101038
diff
changeset
|
134 process, at least since 4NT version 3.01. Use CMD.EXE, the default |
a496b8e22c51
* INSTALL: Add comment about TCC; fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents:
101038
diff
changeset
|
135 Windows shell, instead. MSYS sh.exe also appears to cause various |
a496b8e22c51
* INSTALL: Add comment about TCC; fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents:
101038
diff
changeset
|
136 problems. If you have MSYS installed, try "make SHELL=cmd.exe" to |
a496b8e22c51
* INSTALL: Add comment about TCC; fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents:
101038
diff
changeset
|
137 force the use of cmd.exe instead of sh.exe. |
67016
47fccd30153d
Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents:
64890
diff
changeset
|
138 |
47fccd30153d
Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents:
64890
diff
changeset
|
139 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
|
140 |
47fccd30153d
Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents:
64890
diff
changeset
|
141 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
|
142 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
|
143 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
|
144 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
|
145 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
|
146 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
|
147 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
|
148 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
|
149 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
|
150 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
|
151 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
|
152 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
|
153 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
|
154 |
47fccd30153d
Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents:
64890
diff
changeset
|
155 Notes: |
47fccd30153d
Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents:
64890
diff
changeset
|
156 |
47fccd30153d
Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents:
64890
diff
changeset
|
157 [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
|
158 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
|
159 [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
|
160 [3] requires LC_MESSAGES support to build; cannot build with early |
109485
bb9894b5234f
* nt/INSTALL: Add note about backslashes in Windows paths.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
161 versions of Cygwin. |
67016
47fccd30153d
Rearrange text to make it clear that the make/shell compatibility
Eli Zaretskii <eliz@gnu.org>
parents:
64890
diff
changeset
|
162 [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
|
163 [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
|
164 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
|
165 [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
|
166 (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
|
167 [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
|
168 [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
|
169 |
49871
4f204ad4bdf9
Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
parents:
49600
diff
changeset
|
170 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
|
171 tried suggest that the Intel C compiler (for example) may produce an |
93965 | 172 Emacs executable with strange filename completion behavior. Unless |
49871
4f204ad4bdf9
Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
parents:
49600
diff
changeset
|
173 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
|
174 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
|
175 in the previous paragraph. |
4f204ad4bdf9
Added note about specific problem observed with the Intel compiler.
Jason Rumney <jasonr@gnu.org>
parents:
49600
diff
changeset
|
176 |
109485
bb9894b5234f
* nt/INSTALL: Add note about backslashes in Windows paths.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
177 You will also need a copy of the POSIX cp, rm and mv programs. These |
bb9894b5234f
* nt/INSTALL: Add note about backslashes in Windows paths.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
178 and other useful POSIX utilities can be obtained from one of several |
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
|
179 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
|
180 |
69567
be544ed33d82
Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents:
68648
diff
changeset
|
181 * 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
|
182 * http://www.mingw.org/ ( MinGW ) |
62677 | 183 * 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
|
184 * 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
|
185 |
109485
bb9894b5234f
* nt/INSTALL: Add note about backslashes in Windows paths.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
186 If you build Emacs on 16-bit versions of Windows (9X or ME), we |
bb9894b5234f
* nt/INSTALL: Add note about backslashes in Windows paths.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
187 suggest to install the Cygwin port of Bash. That is because the |
bb9894b5234f
* nt/INSTALL: Add note about backslashes in Windows paths.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
188 native Windows shell COMMAND.COM is too limited; the Emacs build |
bb9894b5234f
* nt/INSTALL: Add note about backslashes in Windows paths.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
189 procedure tries very hard to support even such limited shells, but |
bb9894b5234f
* nt/INSTALL: Add note about backslashes in Windows paths.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
190 as none of the Windows developers of Emacs work on Windows 9X, we |
bb9894b5234f
* nt/INSTALL: Add note about backslashes in Windows paths.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
191 cannot guarantee that it works without a more powerful shell. |
35726
efa42820d1af
Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents:
31625
diff
changeset
|
192 |
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
|
193 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
|
194 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
|
195 |
69567
be544ed33d82
Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents:
68648
diff
changeset
|
196 http://www.emacswiki.org/cgi-bin/wiki/WThirtyTwoInstallationKit |
25856 | 197 |
76278
dc5475982593
Add URL of another site with detailed build instructions.
Eli Zaretskii <eliz@gnu.org>
parents:
76272
diff
changeset
|
198 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
|
199 |
69567
be544ed33d82
Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents:
68648
diff
changeset
|
200 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
|
201 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
|
202 |
106653
903baf781824
* INSTALL: Update for CVS->Bazaar switchover.
Karl Fogel <kfogel@red-bean.com>
parents:
102237
diff
changeset
|
203 Both of those pages were written before Emacs switched from CVS to |
903baf781824
* INSTALL: Update for CVS->Bazaar switchover.
Karl Fogel <kfogel@red-bean.com>
parents:
102237
diff
changeset
|
204 Bazaar, but the parts about building Emacs still apply in Bazaar. |
903baf781824
* INSTALL: Update for CVS->Bazaar switchover.
Karl Fogel <kfogel@red-bean.com>
parents:
102237
diff
changeset
|
205 The second URL has instructions for building with MSVC, as well as |
903baf781824
* INSTALL: Update for CVS->Bazaar switchover.
Karl Fogel <kfogel@red-bean.com>
parents:
102237
diff
changeset
|
206 with MinGW, while the first URL covers only MinGW, but has more |
903baf781824
* INSTALL: Update for CVS->Bazaar switchover.
Karl Fogel <kfogel@red-bean.com>
parents:
102237
diff
changeset
|
207 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
|
208 |
35870
e3bd30e28be6
(Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents:
35814
diff
changeset
|
209 * Configuring |
25856 | 210 |
31083
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
211 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
|
212 `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
|
213 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
|
214 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
|
215 options on the command line when invoking configure. |
25856 | 216 |
31083
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
217 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
|
218 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
|
219 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
|
220 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
|
221 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
|
222 a debugger. |
25856 | 223 |
31625
345a3f5a7193
Add note about expected error messages when configure
Andrew Innes <andrewi@gnu.org>
parents:
31083
diff
changeset
|
224 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
|
225 is running, when gcc support is being tested. These cannot be |
109485
bb9894b5234f
* nt/INSTALL: Add note about backslashes in Windows paths.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
226 suppressed because of limitations in the Windows 9X command.com shell. |
31625
345a3f5a7193
Add note about expected error messages when configure
Andrew Innes <andrewi@gnu.org>
parents:
31083
diff
changeset
|
227 |
63308
51d38cfbe542
Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents:
62677
diff
changeset
|
228 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
|
229 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
|
230 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
|
231 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
|
232 Emacs manual). |
51d38cfbe542
Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents:
62677
diff
changeset
|
233 |
49451
c4911d7933ae
Added notes about PNG support.
Jason Rumney <jasonr@gnu.org>
parents:
42901
diff
changeset
|
234 * Optional image library support |
c4911d7933ae
Added notes about PNG support.
Jason Rumney <jasonr@gnu.org>
parents:
42901
diff
changeset
|
235 |
55896
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents:
52416
diff
changeset
|
236 In addition to its "native" image formats (pbm and xbm), Emacs can |
100849
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
237 handle other image types: xpm, tiff, gif, png, jpeg and experimental |
101038
94fbb2d40d7f
Postscript image support apparently isn't complete on any platform
Jason Rumney <jasonr@gnu.org>
parents:
100954
diff
changeset
|
238 support for svg. |
106668
75fb4d306cdf
INSTALL: Remove obsolete notes about line endings, and fix some typos.
Juanma Barranquero <lekktu@gmail.com>
parents:
106653
diff
changeset
|
239 |
100849
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
240 To build Emacs with support for them, the corresponding headers must |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
241 be in the include path when the configure script is run. This can |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
242 be setup using environment variables, or by specifying --cflags |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
243 -I... options on the command-line to configure.bat. The configure |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
244 script will report whether it was able to detect the headers. If |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
245 the results of this testing appear to be incorrect, please look for |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
246 details in the file config.log: it will show the failed test |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
247 programs and compiler error messages that should explain what is |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
248 wrong. (Usually, any such failures happen because some headers are |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
249 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
|
250 |
109485
bb9894b5234f
* nt/INSTALL: Add note about backslashes in Windows paths.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
251 Note that any file path passed to the compiler or linker must use |
bb9894b5234f
* nt/INSTALL: Add note about backslashes in Windows paths.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
252 forward slashes; using backslashes will cause compiler warnings or |
bb9894b5234f
* nt/INSTALL: Add note about backslashes in Windows paths.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
253 errors about unrecognized escape sequences. |
bb9894b5234f
* nt/INSTALL: Add note about backslashes in Windows paths.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
254 |
55896
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents:
52416
diff
changeset
|
255 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
|
256 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
|
257 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
|
258 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
|
259 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
|
260 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
|
261 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
|
262 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
|
263 |
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents:
52416
diff
changeset
|
264 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
|
265 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
|
266 compile the libraries yourself, you must make sure that any dependency |
93965 | 267 is in the PATH or otherwise accessible and that the binaries are |
55896
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents:
52416
diff
changeset
|
268 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
|
269 |
8b571de37306
Reword the section on image support. Add reference to GnuWin32. Mention
Juanma Barranquero <lekktu@gmail.com>
parents:
52416
diff
changeset
|
270 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
|
271 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
|
272 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
|
273 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
|
274 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
|
275 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
|
276 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
|
277 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
|
278 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
|
279 _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
|
280 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
|
281 |
80108
d616730de510
Add note about GTK image libraries.
Jason Rumney <jasonr@gnu.org>
parents:
80085
diff
changeset
|
282 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
|
283 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
|
284 |
100849
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
285 * Experimental SVG support |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
286 |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
287 SVG support is currently experimental, and not built by default. |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
288 Specify --with-svg and ensure you have all the dependencies in your |
102237
a496b8e22c51
* INSTALL: Add comment about TCC; fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents:
101038
diff
changeset
|
289 include path. Unless you have built a minimalist librsvg yourself |
100849
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
290 (untested), librsvg depends on a significant chunk of GTK+ to build, |
102237
a496b8e22c51
* INSTALL: Add comment about TCC; fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents:
101038
diff
changeset
|
291 plus a few Gnome libraries, libxml2, libbz2 and zlib at runtime. The |
100849
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
292 easiest way to obtain the dependencies required for building is to |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
293 download a pre-bundled GTK+ development environment for Windows. |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
294 GTK puts its header files all over the place, so you will need to |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
295 run pkgconfig to list the include path you will need (either passed |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
296 to configure.bat as --cflags options, or set in the environment). |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
297 |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
298 To use librsvg at runtime, ensure that librsvg and its dependencies |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
299 are on your PATH. If you didn't build librsvg yourself, you will |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
300 need to check with where you downloaded it from for the |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
301 dependencies, as there are different build options. If it is a |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
302 short list, then it most likely only lists the immediate |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
303 dependencies of librsvg, but the dependencies themselves have |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
304 dependencies - so don't download individual libraries from GTK+, |
102237
a496b8e22c51
* INSTALL: Add comment about TCC; fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents:
101038
diff
changeset
|
305 download and install the whole thing. If you think you've got all |
100849
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
306 the dependencies and SVG support is still not working, check your |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
307 PATH for other libraries that shadow the ones you downloaded. |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
308 Libraries of the same name from different sources may not be |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
309 compatible, this problem was encountered with libbzip2 from GnuWin32 |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
310 with libcroco from gnome.org. |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
311 |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
312 If you can see etc/images/splash.svg, then you have managed to get |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
313 SVG support working. Congratulations for making it through DLL hell |
102237
a496b8e22c51
* INSTALL: Add comment about TCC; fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents:
101038
diff
changeset
|
314 to this point. You'll probably find that some SVG images crash |
100849
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
315 Emacs. Problems have been observed in some images that contain |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
316 text, they seem to be a problem in the Windows port of Pango, or |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
317 maybe a problem with the way Cairo or librsvg is using it that |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
318 doesn't show up on other platforms. |
65084615ffd3
* configure.bat: New option --with-svg.
Jason Rumney <jasonr@gnu.org>
parents:
94795
diff
changeset
|
319 |
35870
e3bd30e28be6
(Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents:
35814
diff
changeset
|
320 * Building |
25856 | 321 |
31083
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
322 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
|
323 your compiler to build Emacs. For MSVC, this is nmake; for GCC, it is |
106653
903baf781824
* INSTALL: Update for CVS->Bazaar switchover.
Karl Fogel <kfogel@red-bean.com>
parents:
102237
diff
changeset
|
324 GNU make. (If you are building out of Bazaar, say "make bootstrap" or |
69567
be544ed33d82
Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents:
68648
diff
changeset
|
325 "nmake bootstrap" instead.) |
25856 | 326 |
31083
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
327 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
|
328 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
|
329 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
|
330 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
|
331 until then we will just live with them. |
25856 | 332 |
74820
e50355d072ce
Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents:
73297
diff
changeset
|
333 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
|
334 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
|
335 |
e50355d072ce
Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents:
73297
diff
changeset
|
336 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
|
337 |
e50355d072ce
Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents:
73297
diff
changeset
|
338 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
|
339 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
|
340 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
|
341 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
|
342 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
|
343 if you wish. |
e50355d072ce
Explain how to invoke GNU Make for parallel builds.
Eli Zaretskii <eliz@gnu.org>
parents:
73297
diff
changeset
|
344 |
106653
903baf781824
* INSTALL: Update for CVS->Bazaar switchover.
Karl Fogel <kfogel@red-bean.com>
parents:
102237
diff
changeset
|
345 If you are building from Bazaar, the following commands will produce |
903baf781824
* INSTALL: Update for CVS->Bazaar switchover.
Karl Fogel <kfogel@red-bean.com>
parents:
102237
diff
changeset
|
346 the Info manuals (which are not part of the Bazaar sources): |
69567
be544ed33d82
Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents:
68648
diff
changeset
|
347 |
be544ed33d82
Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents:
68648
diff
changeset
|
348 make info |
be544ed33d82
Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents:
68648
diff
changeset
|
349 or |
be544ed33d82
Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents:
68648
diff
changeset
|
350 nmake info |
be544ed33d82
Add concise build instructions.
Eli Zaretskii <eliz@gnu.org>
parents:
68648
diff
changeset
|
351 |
71548
b1556bb47998
Mention that makeinfo.exe is required for make 'info'.
Eli Zaretskii <eliz@gnu.org>
parents:
71164
diff
changeset
|
352 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
|
353 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
|
354 |
35870
e3bd30e28be6
(Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents:
35814
diff
changeset
|
355 * Installing |
25856 | 356 |
39144
7baf228a27e6
Mention that "make install" can be "nmake install".
Eli Zaretskii <eliz@gnu.org>
parents:
37885
diff
changeset
|
357 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
|
358 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
|
359 do you have. |
25856 | 360 |
31083
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
361 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
|
362 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
|
363 --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
|
364 make, like so: |
25856 | 365 |
31083
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
366 make install INSTALL_DIR=D:/emacs |
25856 | 367 |
39144
7baf228a27e6
Mention that "make install" can be "nmake install".
Eli Zaretskii <eliz@gnu.org>
parents:
37885
diff
changeset
|
368 (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
|
369 |
31083
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
370 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
|
371 to create a Start menu icon for Emacs. |
25856 | 372 |
93965 | 373 * Make targets |
374 | |
375 The following make targets may be used by users building the source | |
106653
903baf781824
* INSTALL: Update for CVS->Bazaar switchover.
Karl Fogel <kfogel@red-bean.com>
parents:
102237
diff
changeset
|
376 distribution, or users who have checked out of Bazaar after |
93965 | 377 an initial bootstrapping. |
378 | |
379 make | |
380 Builds Emacs from the available sources and pre-compiled lisp files. | |
381 | |
382 make install | |
383 Installs programs to the bin directory, and runs addpm to create | |
384 Start Menu icons. | |
385 | |
386 make clean | |
387 Removes object and executable files produced by the build process in | |
388 the current configuration. After make clean, you can rebuild with | |
389 the same configuration using make. | |
390 | |
391 make distclean | |
392 In addition to the files removed by make clean, this also removes | |
393 Makefiles and other generated files to get back to the state of a | |
102237
a496b8e22c51
* INSTALL: Add comment about TCC; fix typos.
Juanma Barranquero <lekktu@gmail.com>
parents:
101038
diff
changeset
|
394 freshly unpacked source distribution. Note that this will not remove |
93965 | 395 installed files, or the results of builds performed with different |
396 compiler or optimization options than the current configuration. | |
397 After make distclean, it is necessary to run configure.bat followed | |
398 by make to rebuild. | |
399 | |
400 make cleanall | |
401 Removes object and executable files that may have been created by | |
402 previous builds with different configure options, in addition to | |
403 the files produced by the current configuration. | |
404 | |
405 make realclean | |
406 Removes the installed files in the bin subdirectory in addition to | |
407 the files removed by make cleanall. | |
408 | |
109507
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
409 make dist |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
410 Builds Emacs from the available sources and pre-compiled lisp files. |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
411 Packages Emacs binaries as full distribution and barebin distribution. |
93965 | 412 |
106653
903baf781824
* INSTALL: Update for CVS->Bazaar switchover.
Karl Fogel <kfogel@red-bean.com>
parents:
102237
diff
changeset
|
413 The following targets are intended only for use with the Bazaar sources. |
93965 | 414 |
415 make bootstrap | |
416 Creates a temporary emacs binary with lisp source files and | |
417 uses it to compile the lisp files. Once the lisp files are built, | |
418 emacs is redumped with the compiled lisp. | |
419 | |
420 make recompile | |
106653
903baf781824
* INSTALL: Update for CVS->Bazaar switchover.
Karl Fogel <kfogel@red-bean.com>
parents:
102237
diff
changeset
|
421 Recompiles any changed lisp files after an update. This saves |
93965 | 422 doing a full bootstrap after every update. If this or a subsequent |
423 make fail, you probably need to perform a full bootstrap, though | |
424 running this target multiple times may eventually sort out the | |
425 interdependencies. | |
426 | |
427 make maintainer-clean | |
428 Removes everything that can be recreated, including compiled lisp | |
106653
903baf781824
* INSTALL: Update for CVS->Bazaar switchover.
Karl Fogel <kfogel@red-bean.com>
parents:
102237
diff
changeset
|
429 files, to get back to the state of a fresh Bazaar tree. After make |
93965 | 430 maintainer-clean, it is necessary to run configure.bat and make |
431 bootstrap to rebuild. Occasionally it may be necessary to run this | |
106653
903baf781824
* INSTALL: Update for CVS->Bazaar switchover.
Karl Fogel <kfogel@red-bean.com>
parents:
102237
diff
changeset
|
432 target after an update. |
93965 | 433 |
109507
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
434 * Creating binary distributions |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
435 |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
436 Binary distributions (full and barebin distributions) can be |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
437 automatically built and packaged from source tarballs or a bzr |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
438 checkout. |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
439 |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
440 When building Emacs binary distributions, the --distfiles argument |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
441 to configure.bat specifies files to be included in the bin directory |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
442 of the binary distributions. This is intended for libraries that are |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
443 not built as part of Emacs, e.g. image libraries. |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
444 |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
445 For example, specifying |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
446 |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
447 --distfiles D:\distfiles\libXpm.dll |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
448 |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
449 results in libXpm.dll being copied from D:\distfiles to the |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
450 bin directory before packaging starts. |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
451 |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
452 Multiple files can be specified using multiple --distfiles arguments: |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
453 |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
454 --distfiles D:\distfiles\libXpm.dll --distfiles C:\jpeglib\jpeg.dll |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
455 |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
456 For packaging the binary distributions, the 'dist' make target uses |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
457 7-Zip (http://www.7-zip.org), which must be installed and available |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
458 on the Windows Path. |
1277fe6717c9
New make target for Windows platform: make dist (bug#6602)
Juanma Barranquero <lekktu@gmail.com>
parents:
109485
diff
changeset
|
459 |
93965 | 460 |
35870
e3bd30e28be6
(Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents:
35814
diff
changeset
|
461 * Trouble-shooting |
25856 | 462 |
31083
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
463 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
|
464 Emacs stem from using an old version of GCC, or old MinGW or W32 API |
109485
bb9894b5234f
* nt/INSTALL: Add note about backslashes in Windows paths.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
465 headers. Additionally, Cygwin ports of GNU make may require the Emacs |
31083
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
466 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
|
467 generated by configure.bat necessarily use DOS line endings. Also, |
109485
bb9894b5234f
* nt/INSTALL: Add note about backslashes in Windows paths.
Juanma Barranquero <lekktu@gmail.com>
parents:
106815
diff
changeset
|
468 Cygwin ports of make must run in UNIX mode, either by specifying |
31083
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
469 --unix on the command line, or MAKE_MODE=UNIX in the environment. |
25856 | 470 |
31083
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
471 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
|
472 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
|
473 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
|
474 sufficient support for anonymous structs and unions to cope with some |
93668
2368e43fd306
Update W32 API requirements.
Jason Rumney <jasonr@gnu.org>
parents:
92148
diff
changeset
|
475 definitions from winnt.h that are used by addsection.c. |
2368e43fd306
Update W32 API requirements.
Jason Rumney <jasonr@gnu.org>
parents:
92148
diff
changeset
|
476 Older versions of the W32 API headers that come with Cygwin and MinGW |
2368e43fd306
Update W32 API requirements.
Jason Rumney <jasonr@gnu.org>
parents:
92148
diff
changeset
|
477 may be missing some definitions required by Emacs, or broken in other |
93685
0573bdbac2e6
Improve wording of last change.
Eli Zaretskii <eliz@gnu.org>
parents:
93668
diff
changeset
|
478 ways. In particular, uniscribe APIs were added to MinGW CVS only on |
93668
2368e43fd306
Update W32 API requirements.
Jason Rumney <jasonr@gnu.org>
parents:
92148
diff
changeset
|
479 2006-03-26, so releases from before then cannot be used. |
25856 | 480 |
63308
51d38cfbe542
Warn about using "cvs up -kb" if one intends to commit
Eli Zaretskii <eliz@gnu.org>
parents:
62677
diff
changeset
|
481 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
|
482 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
|
483 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
|
484 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
|
485 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
|
486 |
35726
efa42820d1af
Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents:
31625
diff
changeset
|
487 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
|
488 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
|
489 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
|
490 for Makefile's used by Emacs.) |
efa42820d1af
Copy the table of tested combinations of development
Eli Zaretskii <eliz@gnu.org>
parents:
31625
diff
changeset
|
491 |
39462
7bc2236b1036
Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents:
39152
diff
changeset
|
492 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
|
493 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
|
494 |
e3bd30e28be6
(Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents:
35814
diff
changeset
|
495 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
|
496 --ldflags -mwin32 |
35870
e3bd30e28be6
(Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents:
35814
diff
changeset
|
497 |
39462
7bc2236b1036
Update as per suggestions by Shayne Steele <steele@cs.fsu.edu>.
Eli Zaretskii <eliz@gnu.org>
parents:
39152
diff
changeset
|
498 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
|
499 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
|
500 |
35870
e3bd30e28be6
(Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents:
35814
diff
changeset
|
501 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
|
502 release. |
e3bd30e28be6
(Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents:
35814
diff
changeset
|
503 |
e3bd30e28be6
(Trouble-shooting): Add note about need to specify extra
Andrew Innes <andrewi@gnu.org>
parents:
35814
diff
changeset
|
504 * Debugging |
25856 | 505 |
31083
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
506 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
|
507 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
|
508 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
|
509 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
|
510 |
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents:
67016
diff
changeset
|
511 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
|
512 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
|
513 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
|
514 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
|
515 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
|
516 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
|
517 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
|
518 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
|
519 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
|
520 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
|
521 error. |
31083
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
522 |
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
523 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
|
524 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
|
525 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
|
526 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
|
527 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
|
528 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
|
529 easily set breakpoints or examine familiar lisp variables by name. |
25856 | 530 |
31083
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
531 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
|
532 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
|
533 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
|
534 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
|
535 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
|
536 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
|
537 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
|
538 |
dc47c26ee643
Add explanation of how to debug with GDB starting from the Emacs Abort dialog.
Eli Zaretskii <eliz@gnu.org>
parents:
67016
diff
changeset
|
539 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
|
540 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
|
541 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
|
542 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
|
543 should be displayed in its "Debug" output window. |
25856 | 544 |
31083
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
545 When you are in the process of debugging Emacs and you would like to |
93965 | 546 examine the contents of a Lisp_Object variable, pop up the QuickWatch |
31083
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
547 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
|
548 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
|
549 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
|
550 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
|
551 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
|
552 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
|
553 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
|
554 (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
|
555 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
|
556 then print out the contents of the lisp variable exec-path. |
25856 | 557 |
31083
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
558 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
|
559 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
|
560 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
|
561 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
|
562 procedure and try using debug_print again. |
25856 | 563 |
31083
f64a9a44e2a3
Rewrite to match new configure process.
Andrew Innes <andrewi@gnu.org>
parents:
25856
diff
changeset
|
564 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
|
565 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
|
566 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
|
567 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
|
568 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
|
569 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
|
570 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
|
571 threads. |
37710 | 572 |
75769
92a0e87ff562
Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents:
75348
diff
changeset
|
573 |
92a0e87ff562
Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents:
75348
diff
changeset
|
574 This file is part of GNU Emacs. |
92a0e87ff562
Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents:
75348
diff
changeset
|
575 |
94795
188974bfdea0
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93965
diff
changeset
|
576 GNU Emacs is free software: you can redistribute it and/or modify |
75769
92a0e87ff562
Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents:
75348
diff
changeset
|
577 it under the terms of the GNU General Public License as published by |
94795
188974bfdea0
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93965
diff
changeset
|
578 the Free Software Foundation, either version 3 of the License, or |
188974bfdea0
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93965
diff
changeset
|
579 (at your option) any later version. |
37710 | 580 |
75769
92a0e87ff562
Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents:
75348
diff
changeset
|
581 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
|
582 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
|
583 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
|
584 GNU General Public License for more details. |
37710 | 585 |
75769
92a0e87ff562
Switch to standard GPL text for license.
Glenn Morris <rgm@gnu.org>
parents:
75348
diff
changeset
|
586 You should have received a copy of the GNU General Public License |
94795
188974bfdea0
Switch to recommended form of GPLv3 permissions notice.
Glenn Morris <rgm@gnu.org>
parents:
93965
diff
changeset
|
587 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |