1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
4 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5 This file is generated from xml source: DO NOT EDIT
6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8 <title>Compiling Apache for Microsoft Windows - Apache HTTP Server</title>
9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
13 <body id="manual-page"><div id="page-header">
14 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
15 <p class="apache">Apache HTTP Server Version 2.1</p>
16 <img alt="" src="../images/feather.gif" /></div>
17 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
19 <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.1</a> > <a href="./">Platform Specific Notes</a></div><div id="page-content"><div id="preamble"><h1>Compiling Apache for Microsoft Windows</h1>
21 <p><span>Available Languages: </span><a href="../en/platform/win_compiling.html" title="English"> en </a></p>
25 <p>There are many important points before you begin compiling
26 Apache. See <a href="windows.html">Using Apache with Microsoft
27 Windows</a> before you begin.</p>
30 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#requirements">Requirements</a></li>
31 <li><img alt="" src="../images/down.gif" /> <a href="#commandbuild">Command-Line Build</a></li>
32 <li><img alt="" src="../images/down.gif" /> <a href="#workspacebuild">Developer Studio Workspace IDE Build</a></li>
33 <li><img alt="" src="../images/down.gif" /> <a href="#projectcomponents">Project Components</a></li>
35 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
37 <h2><a name="requirements" id="requirements">Requirements</a></h2>
41 <p>Compiling Apache requires the following environment to be
42 properly installed:</p>
47 <p>Make sure you have at least 50 MB of free disk space
48 available. After installation Apache requires approximately
49 10 MB of disk space, plus space for log and cache files,
50 which can grow rapidly. The actual disk space requirements
51 will vary considerably based on your chosen configuration and
52 any third-party modules or libraries.</p>
56 <p>Microsoft Visual C++ 5.0 or higher.</p>
57 <p>Apache can be built using the command line tools, or from
58 within the Visual Studio IDE Workbench. The command line
59 build requires the environment to reflect the <code>PATH</code>,
60 <code>INCLUDE</code>, <code>LIB</code> and other variables
61 that can be configured with the <code>vcvars32</code> batch file:</p>
63 <div class="example"><p><code>
64 "c:\Program Files\DevStudio\VC\Bin\vcvars32.bat"
69 <p>The Windows Platform SDK.</p>
70 <p>Visual C++ 5.0 builds require an updated Microsoft Windows
71 Platform SDK to enable some Apache features. For command line
72 builds, the Platform SDK environment is prepared by the
73 <code>setenv</code> batch file:</p>
75 <div class="example"><p><code>
76 "c:\Program Files\Platform SDK\setenv.bat"
79 <p>The Platform SDK files distributed with Visual C++ 6.0 and
80 later are sufficient, so users of later version may skip
83 <div class="note">Note that the Windows Platform SDK update is required
84 to enable all supported <code class="module"><a href="../mod/mod_isapi.html">mod_isapi</a></code> features.
85 Without a recent update, Apache will issue warnings under
86 MSVC++ 5.0 that some <code class="module"><a href="../mod/mod_isapi.html">mod_isapi</a></code> features
87 will be disabled. Look for the update at <a href="http://msdn.microsoft.com/downloads/sdks/platform/platform.asp">http://msdn.microsoft.com/downloads/sdks/platform/platform.asp</a>.</div>
91 <p>The awk utility (awk, gawk or similar).</p>
92 <p>To install Apache within the build system, several files are
93 modified using the <code>awk.exe</code> utility. awk was chosen since it
94 is a very small download (compared with Perl or WSH/VB) and
95 accomplishes the task of generating files. Brian Kernighan's
96 <a href="http://cm.bell-labs.com/cm/cs/who/bwk/">http://cm.bell-labs.com/cm/cs/who/bwk/</a>
97 site has a compiled native Win32 binary,
98 <a href="http://cm.bell-labs.com/cm/cs/who/bwk/awk95.exe">http://cm.bell-labs.com/cm/cs/who/bwk/awk95.exe</a> which
99 you must save with the name <code>awk.exe</code> rather than
100 <code>awk95.exe</code>.</p>
102 <div class="note">Note that Developer Studio IDE will only find
103 <code>awk.exe</code> from the Tools menu Options... Directories
104 tab (the Projects - VC++ Directories pane in Developer Studio 7.0)
105 listing Executable file paths. Add the path for <code>awk.exe</code>
106 to this list, and your system <code>PATH</code> environment variable,
109 <div class="note">Also note that if you are using Cygwin (<a href="http://www.cygwin.com/">http://www.cygwin.com/</a>) the awk utility is named <code>gawk.exe</code> and
110 that the file <code>awk.exe</code> is really a symlink to the <code>gawk.exe</code>
111 file. The Windows command shell does not recognize symlinks, and because of that
112 building InstallBin will fail. A workaround is to delete <code>awk.exe</code> from
113 the cygwin installation and rename <code>gawk.exe</code> to <code>awk.exe</code>.</div>
117 <p>[Optional] OpenSSL libraries (for <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code>
118 and <code>ab.exe</code> with ssl support)</p>
119 <p><strong>Caution: there are significant restrictions and
120 prohibitions on the use and distribution of strong cryptography
121 and patented intellectual property throughout the world.</strong>
122 OpenSSL includes strong cryptography controlled by both export
123 regulations and domestic law, as well as intellectual property
124 protected by patent, in the United States and elsewhere. Neither
125 the Apache Software Foundation nor the OpenSSL project can provide
126 legal advise regarding possession, use, or distribution of the code
127 provided by the OpenSSL project. <strong>Consult your own legal
128 counsel, you are responsible for your own actions.</strong></p>
130 <p>OpenSSL must be installed into a <code>srclib</code> subdirectory named
131 <code>openssl</code>, obtained from <a href="http://www.openssl.org/source/">http://www.openssl.org/source/</a>, in order to compile <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code>
132 or the abs project (<code>ab.exe</code> with SSL support.) To prepare OpenSSL
133 for both <code>release</code> and <code>debug</code> builds of Apache, and
134 disable the patent protected features in 0.9.7, you might use the following
137 <div class="example"><p><code>
138 perl Configure VC-WIN32<br />
139 perl util\mkfiles.pl >MINFO<br />
140 perl util\mk1mf.pl dll no-asm no-mdc2 no-rc5 no-idea VC-WIN32 >makefile<br />
141 perl util\mk1mf.pl dll debug no-asm no-mdc2 no-rc5 no-idea VC-WIN32 >makefile.dbg<br />
142 perl util\mkdef.pl 32 libeay no-asm no-mdc2 no-rc5 no-idea >ms\libeay32.def<br />
143 perl util\mkdef.pl 32 ssleay no-asm no-mdc2 no-rc5 no-idea >ms\ssleay32.def<br />
145 nmake -f makefile.dbg
151 <p>[Optional] zlib sources (for <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code>)</p>
152 <p>Zlib must be installed into a <code>srclib</code> subdirectory named
153 <code>zlib</code>, however those sources need not be compiled. The build system
154 will compile the compression sources directly into the <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code>
155 module. Zlib can be obtained from <a href="http://www.gzip.org/zlib/">http://www.gzip.org/zlib/</a> -- <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code> is
156 confirmed to build correctly with version 1.1.4.</p>
161 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
162 <div class="section">
163 <h2><a name="commandbuild" id="commandbuild">Command-Line Build</a></h2>
167 <p>First, unpack the Apache distribution into an appropriate
168 directory. Open a command-line prompt and <code>cd</code> to that
171 <p>The master Apache makefile instructions are contained in the
172 <code>Makefile.win</code> file. To compile Apache on Windows
173 NT, simply use one of the following commands to compiled the
174 <code>release</code> or <code>debug</code> build, respectively:</p>
176 <div class="example"><pre>
177 nmake /f Makefile.win _apacher
179 nmake /f Makefile.win _apached
182 <p>Either command will compile Apache. The latter will include
183 debugging information in the resulting files, making it easier
184 to find bugs and track down problems.</p>
186 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
187 <div class="section">
188 <h2><a name="workspacebuild" id="workspacebuild">Developer Studio Workspace IDE Build</a></h2>
192 <p>Apache can also be compiled using VC++'s Visual Studio
193 development environment. To simplify this process, a
194 Visual Studio workspace, <code>Apache.dsw</code>, is provided.
195 This workspace exposes the entire list of working <code>.dsp</code>
196 projects that are required for the complete Apache binary release.
197 It includes dependencies between the projects to assure that they
198 are built in the appropriate order.</p>
200 <p>Open the <code>Apache.dsw</code> workspace, and select
201 <code>InstallBin</code> (<code>Release</code> or <code>Debug</code> build,
202 as desired) as the Active Project. <code>InstallBin</code> causes all
203 related project to be built, and then invokes <code>Makefile.win</code> to
204 move the compiled executables and dlls. You may personalize the
205 <code>INSTDIR=</code> choice by changing <code>InstallBin</code>'s Settings,
206 General tab, Build command line entry. <code>INSTDIR</code> defaults to the
207 <code>/Apache2</code> directory. If you only want a test compile (without
208 installing) you may build the <code>BuildBin</code> project instead.</p>
210 <p>The <code>.dsp</code> project files are distributed in Visual
211 C++ 6.0 format. Visual C++ 5.0 (97) will recognize them. Visual C++
212 7.0 (.net) must convert <code>Apache.dsw</code> plus the <code>.dsp</code>
213 files into an <code>Apache.sln</code> plus <code>.msproj</code> files,
214 be sure you reconvert the <code>.msproj</code> file if any of the source
215 <code>.dsp</code> files change! This is really trivial, just open
216 <code>Apache.dsw</code> in the VC++ 7.0 IDE once again.</p>
218 <p>Visual C++ 7.0 (.net) users should also use the Build
219 menu, Configuration Manager dialog to uncheck both the <code>Debug</code>
220 and <code>Release</code> Solution modules abs, <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code>
221 and <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code>.
222 These modules are built by invoking <code>nmake</code> or the IDE directly
223 with the <code>BinBuild</code> target to build those modules explicitly,
224 only if the <code>srclib</code> directories <code>openssl</code>
225 and/or <code>zlib</code> exist.</p>
227 <p>Exported <code>.mak</code> files pose a greater hassle, but they are
228 required for Visual C++ 5.0 users to build <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code>,
229 abs (ab with SSL support) and/or <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code>.
230 VC++ 7.0 (.net) users also benefit, <code>nmake</code> builds
231 are faster than <code>binenv</code> builds.
232 Build the entire project from within the VC++ 5.0 or 6.0 IDE,
233 then use the Project Menu Export for all makefiles.
234 You must build the projects first in order to create all dynamic
235 auto-generated targets, so that dependencies can be parsed
236 correctly. Run the following command to fix the paths so they
237 will build anywhere:</p>
239 <div class="example"><p><code>
240 perl srclib\apr\build\fixwin32mak.pl
243 <p>You must type this command from the <em>top level</em>
244 directory of the <code>httpd</code> source tree. Every
245 <code>.mak</code> and <code>.dep</code> project file within
246 the current directory and below will be corrected, and the
247 timestamps adjusted to reflect the <code>.dsp</code>.</p>
249 <p>If you contribute back a patch that revises project files, we
250 must commit project files in Visual Studio 6.0 format. Changes
251 should be simple, with minimal compilation and linkage flags that
252 will be recognized by all VC++ 5.0 through 7.0 environments.</p>
254 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
255 <div class="section">
256 <h2><a name="projectcomponents" id="projectcomponents">Project Components</a></h2>
260 <p>The <code>Apache.dsw</code> workspace and <code>makefile.win</code>
261 <code>nmake</code> script both build the <code>.dsp</code> projects
262 of the Apache server in the following sequence:</p>
265 <li><code>srclib\apr\apr.dsp</code></li>
267 <li><code>srclib\apr\libapr.dsp</code></li>
269 <li><code>srclib\apr-util\uri\gen_uri_delims.dsp</code></li>
271 <li><code>srclib\apr-util\xml\expat\lib\xml.dsp</code></li>
273 <li><code>srclib\apr-util\aprutil.dsp</code></li>
275 <li><code>srclib\apr-util\libaprutil.dsp</code></li>
277 <li><code>srclib\pcre\dftables.dsp</code></li>
279 <li><code>srclib\pcre\pcre.dsp</code></li>
281 <li><code>srclib\pcre\pcreposix.dsp</code></li>
283 <li><code>server\gen_test_char.dsp</code></li>
285 <li><code>libhttpd.dsp</code></li>
287 <li><code>Apache.dsp</code></li>
290 <p>In addition, the <code>modules\</code> subdirectory tree contains
291 project files for the majority of the modules.</p>
293 <p>The <code>support\</code> directory contains project files for
294 additional programs that are not part of the Apache runtime,
295 but are used by the administrator to test Apache and maintain
296 password and log files. Windows-specific support projects are
297 broken out in the <code>support\win32\</code> directory.</p>
300 <li><code>support\ab.dsp</code></li>
302 <li><code>support\htdigest.dsp</code></li>
304 <li><code>support\htpasswd.dsp</code></li>
306 <li><code>support\logresolve.dsp</code></li>
308 <li><code>support\rotatelogs.dsp</code></li>
310 <li><code>support\win32\ApacheMonitor.dsp</code></li>
312 <li><code>support\win32\wintty.dsp</code></li>
315 <p>Once Apache has been compiled, it needs to be installed in
316 its server root directory. The default is the
317 <code>\Apache2</code> directory, of the same drive.</p>
319 <p>To build and install all the files into the desired folder
320 <em>dir</em> automatically, use one of the following
321 <code>nmake</code> commands:</p>
323 <div class="example"><pre>
324 nmake /f Makefile.win installr INSTDIR=<em>dir</em>
326 nmake /f Makefile.win installd INSTDIR=<em>dir</em>
329 <p>The <em>dir</em> argument to <code>INSTDIR</code> gives
330 the installation directory; it can be omitted if Apache is
331 to be installed into <code>\Apache2</code>.</p>
333 <p>This will install the following:</p>
336 <li><code><em>dir</em>\bin\Apache.exe</code> - Apache
339 <li><code><em>dir</em>\bin\ApacheMonitor.exe</code> - Service
340 monitor taskbar icon utility</li>
342 <li><code><em>dir</em>\bin\htdigest.exe</code> - Digest auth
343 password file utility</li>
345 <li><code><em>dir</em>\bin\htdbm.exe</code> - SDBM auth
346 database password file utility</li>
348 <li><code><em>dir</em>\bin\htpasswd.exe</code> - Basic auth
349 password file utility</li>
351 <li><code><em>dir</em>\bin\logresolve.exe</code> - Log file
352 dns name lookup utility</li>
354 <li><code><em>dir</em>\bin\rotatelogs.exe</code> - Log file
357 <li><code><em>dir</em>\bin\wintty.exe</code> - Console window
360 <li><code><em>dir</em>\bin\libapr.dll</code> - Apache
361 Portable Runtime shared library</li>
363 <li><code><em>dir</em>\bin\libaprutil.dll</code> - Apache
364 Utility Runtime shared library</li>
366 <li><code><em>dir</em>\bin\libhttpd.dll</code> - Apache Core
369 <li><code><em>dir</em>\modules\mod_*.so</code> - Loadable
372 <li><code><em>dir</em>\conf</code> - Configuration
375 <li><code><em>dir</em>\logs</code> - Empty logging
378 <li><code><em>dir</em>\include</code> - C language header
381 <li><code><em>dir</em>\lib</code> - Link library files</li>
384 <h3><a name="projectcomponents-warn" id="projectcomponents-warn">Warning about building Apache from the development tree</a></h3>
388 <div class="note">Note only the <code>.dsp</code> files are maintained between <code>release</code>
389 builds. The <code>.mak</code> files are NOT regenerated, due to the tremendous
390 waste of reviewer's time. Therefore, you cannot rely on the <code>NMAKE</code>
391 commands above to build revised <code>.dsp</code> project files unless you
392 then export all <code>.mak</code> files yourself from the project. This is
393 unnecessary if you build from within the Microsoft
394 Developer Studio environment.</div>
396 <div class="note">Also note it is very worthwhile to build the <code>BuildBin</code>
397 target project (or the command line <code>_apacher</code> or
398 <code>_apached</code> target) prior to exporting the make files.
399 Many files are autogenerated in the build process. Only a full
400 build provides all of the dependent files required to build proper
401 dependency trees for correct build behavior.</div>
403 <p>In order to create distribution <code>.mak</code> files, always review
404 the generated <code>.mak</code> (or <code>.dep</code>) dependencies for
405 Platform SDK or other garbage includes. The <code>DevStudio\SharedIDE\bin\</code>
406 (VC5) or <code>DevStudio\Common\MSDev98\bin\</code> (VC6) directory contains
407 the <code>sysincl.dat</code> file, which must list all exceptions. Update this
408 file (including both forward and backslashed paths, such as both
409 <code>sys/time.h</code> and <code>sys\time.h</code>) to include such dependencies.
410 Including local-install paths in a distributed <code>.mak</code> file will
411 cause the build to fail completely. And don't forget to run
412 <code>srclib/apr/build/fixwin32mak.pl</code> in order to fix absolute
413 paths within the <code>.mak</code> files.</p>
418 <div class="bottomlang">
419 <p><span>Available Languages: </span><a href="../en/platform/win_compiling.html" title="English"> en </a></p>
420 </div><div id="footer">
421 <p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
422 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>