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.0</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/">Documentation</a> > <a href="../">Version 2.0</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> |
22 <a href="../ko/platform/win_compiling.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
26 <p>There are many important points before you begin compiling
27 Apache. See <a href="windows.html">Using Apache with Microsoft
28 Windows</a> before you begin.</p>
31 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#requirements">Requirements</a></li>
32 <li><img alt="" src="../images/down.gif" /> <a href="#commandbuild">Command-Line Build</a></li>
33 <li><img alt="" src="../images/down.gif" /> <a href="#workspacebuild">Developer Studio Workspace IDE Build</a></li>
34 <li><img alt="" src="../images/down.gif" /> <a href="#projectcomponents">Project Components</a></li>
36 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
38 <h2><a name="requirements" id="requirements">Requirements</a></h2>
42 <p>Compiling Apache requires the following environment to be
43 properly installed:</p>
48 <p>Make sure you have at least 50 MB of free disk space
49 available. After installation Apache requires approximately
50 10 MB of disk space, plus space for log and cache files,
51 which can grow rapidly. The actual disk space requirements
52 will vary considerably based on your chosen configuration and
53 any third-party modules or libraries.</p>
57 <p>Microsoft Visual C++ 5.0 or higher.</p>
58 <p>Apache can be built using the command line tools, or from
59 within the Visual Studio IDE Workbench. The command line
60 build requires the environment to reflect the <code>PATH</code>,
61 <code>INCLUDE</code>, <code>LIB</code> and other variables
62 that can be configured with the <code>vcvars32</code> batch file:</p>
64 <div class="example"><p><code>
65 "c:\Program Files\DevStudio\VC\Bin\vcvars32.bat"
70 <p>The Windows Platform SDK.</p>
71 <p>Visual C++ 5.0 builds require an updated Microsoft Windows
72 Platform SDK to enable some Apache features. For command line
73 builds, the Platform SDK environment is prepared by the
74 <code>setenv</code> batch file:</p>
76 <div class="example"><p><code>
77 "c:\Program Files\Platform SDK\setenv.bat"
80 <p>The Platform SDK files distributed with Visual C++ 6.0 and
81 later are sufficient, so users of later version may skip
84 <div class="note">Note that the Windows Platform SDK update is required
85 to enable all supported <code class="module"><a href="../mod/mod_isapi.html">mod_isapi</a></code> features.
86 Without a recent update, Apache will issue warnings under
87 MSVC++ 5.0 that some <code class="module"><a href="../mod/mod_isapi.html">mod_isapi</a></code> features
88 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>
92 <p>The awk utility (awk, gawk or similar).</p>
93 <p>To install Apache within the build system, several files are
94 modified using the <code>awk.exe</code> utility. awk was chosen since it
95 is a very small download (compared with Perl or WSH/VB) and
96 accomplishes the task of generating files. Brian Kernighan's
97 <a href="http://cm.bell-labs.com/cm/cs/who/bwk/">http://cm.bell-labs.com/cm/cs/who/bwk/</a>
98 site has a compiled native Win32 binary,
99 <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
100 you must save with the name <code>awk.exe</code> rather than
101 <code>awk95.exe</code>.</p>
103 <div class="note">Note that Developer Studio IDE will only find
104 <code>awk.exe</code> from the Tools menu Options... Directories
105 tab (the Projects - VC++ Directories pane in Developer Studio 7.0)
106 listing Executable file paths. Add the path for <code>awk.exe</code>
107 to this list, and your system <code>PATH</code> environment variable,
110 <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
111 that the file <code>awk.exe</code> is really a symlink to the <code>gawk.exe</code>
112 file. The Windows command shell does not recognize symlinks, and because of that
113 building InstallBin will fail. A workaround is to delete <code>awk.exe</code> from
114 the cygwin installation and rename <code>gawk.exe</code> to <code>awk.exe</code>.</div>
118 <p>[Optional] OpenSSL libraries (for <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code>
119 and <code>ab.exe</code> with ssl support)</p>
120 <p><strong>Caution: there are significant restrictions and
121 prohibitions on the use and distribution of strong cryptography
122 and patented intellectual property throughout the world.</strong>
123 OpenSSL includes strong cryptography controlled by both export
124 regulations and domestic law, as well as intellectual property
125 protected by patent, in the United States and elsewhere. Neither
126 the Apache Software Foundation nor the OpenSSL project can provide
127 legal advise regarding possession, use, or distribution of the code
128 provided by the OpenSSL project. <strong>Consult your own legal
129 counsel, you are responsible for your own actions.</strong></p>
131 <p>OpenSSL must be installed into a <code>srclib</code> subdirectory named
132 <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>
133 or the abs project (<code>ab.exe</code> with SSL support.) To prepare OpenSSL
134 for both <code>release</code> and <code>debug</code> builds of Apache, and
135 disable the patent protected features in OpenSSL, you might use the following
138 <div class="example"><p><code>
139 perl Configure VC-WIN32<br />
140 perl util\mkfiles.pl >MINFO<br />
141 perl util\mk1mf.pl dll no-asm no-mdc2 no-rc5 no-idea VC-WIN32 >makefile.rel<br />
142 perl util\mk1mf.pl dll debug no-asm no-mdc2 no-rc5 no-idea VC-WIN32 >makefile.dbg<br />
143 perl util\mkdef.pl 32 libeay no-asm no-mdc2 no-rc5 no-idea >ms\libeay32.def<br />
144 perl util\mkdef.pl 32 ssleay no-asm no-mdc2 no-rc5 no-idea >ms\ssleay32.def<br />
145 nmake -f makefile.rel<br />
146 nmake -f makefile.dbg
149 <p>Note; you can use the scripts in the <code>ms\</code> subdirectory, however,
150 it's rather tricky to force <code>ms\do_masm.bat</code>, for example, to perform
151 the patent encumberances as mentioned above. Patches to add the $* argument list
152 to the appropriate .bat lines in these scripts aren't incorporated, thus far.</p>
156 <p>[Optional] zlib sources (for <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code>)</p>
157 <p>Zlib must be installed into a <code>srclib</code> subdirectory named
158 <code>zlib</code>, however those sources need not be compiled. The build system
159 will compile the compression sources directly into the <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code>
160 module. Zlib can be obtained from <a href="http://www.zlib.net/">http://www.zlib.net/</a> -- <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code> is confirmed to build
161 correctly with version 1.1.4. To use a later version of zlib, upgrade to
162 Apache HTTP Server release 2.2 or later.</p>
167 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
168 <div class="section">
169 <h2><a name="commandbuild" id="commandbuild">Command-Line Build</a></h2>
173 <p>First, unpack the Apache distribution into an appropriate
174 directory. Open a command-line prompt and <code>cd</code> to that
177 <p>The master Apache makefile instructions are contained in the
178 <code>Makefile.win</code> file. To compile Apache on Windows
179 NT, simply use one of the following commands to compiled the
180 <code>release</code> or <code>debug</code> build, respectively:</p>
182 <div class="example"><pre>
183 nmake /f Makefile.win _apacher
185 nmake /f Makefile.win _apached
188 <p>Either command will compile Apache. The latter will include
189 debugging information in the resulting files, making it easier
190 to find bugs and track down problems.</p>
192 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
193 <div class="section">
194 <h2><a name="workspacebuild" id="workspacebuild">Developer Studio Workspace IDE Build</a></h2>
198 <p>Apache can also be compiled using VC++'s Visual Studio
199 development environment. To simplify this process, a
200 Visual Studio workspace, <code>Apache.dsw</code>, is provided.
201 This workspace exposes the entire list of working <code>.dsp</code>
202 projects that are required for the complete Apache binary release.
203 It includes dependencies between the projects to assure that they
204 are built in the appropriate order.</p>
206 <p>Open the <code>Apache.dsw</code> workspace, and select
207 <code>InstallBin</code> (<code>Release</code> or <code>Debug</code> build,
208 as desired) as the Active Project. <code>InstallBin</code> causes all
209 related project to be built, and then invokes <code>Makefile.win</code> to
210 move the compiled executables and dlls. You may personalize the
211 <code>INSTDIR=</code> choice by changing <code>InstallBin</code>'s Settings,
212 General tab, Build command line entry. <code>INSTDIR</code> defaults to the
213 <code>/Apache2</code> directory. If you only want a test compile (without
214 installing) you may build the <code>BuildBin</code> project instead.</p>
216 <p>The <code>.dsp</code> project files are distributed in Visual
217 C++ 6.0 format. Visual C++ 5.0 (97) will recognize them. Visual C++
218 7.0 (.net) must convert <code>Apache.dsw</code> plus the <code>.dsp</code>
219 files into an <code>Apache.sln</code> plus <code>.msproj</code> files,
220 be sure you reconvert the <code>.msproj</code> file if any of the source
221 <code>.dsp</code> files change! This is really trivial, just open
222 <code>Apache.dsw</code> in the VC++ 7.0 IDE once again.</p>
224 <p>Visual C++ 7.0 (.net) users should also use the Build
225 menu, Configuration Manager dialog to uncheck both the <code>Debug</code>
226 and <code>Release</code> Solution modules abs, <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code>
227 and <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code>.
228 These modules are built by invoking <code>nmake</code> or the IDE directly
229 with the <code>BinBuild</code> target to build those modules explicitly,
230 only if the <code>srclib</code> directories <code>openssl</code>
231 and/or <code>zlib</code> exist.</p>
233 <p>Exported <code>.mak</code> files pose a greater hassle, but they are
234 required for Visual C++ 5.0 users to build <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code>,
235 abs (<code class="program"><a href="../programs/ab.html">ab</a></code> with SSL support) and/or
236 <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code>.
237 VC++ 7.0 (.net) users also benefit, <code>nmake</code> builds
238 are faster than <code>binenv</code> builds.
239 Build the entire project from within the VC++ 5.0 or 6.0 IDE,
240 then use the Project Menu Export for all makefiles.
241 You must build the projects first in order to create all dynamic
242 auto-generated targets, so that dependencies can be parsed
243 correctly. Run the following command to fix the paths so they
244 will build anywhere:</p>
246 <div class="example"><p><code>
247 perl srclib\apr\build\fixwin32mak.pl
250 <p>You must type this command from the <em>top level</em>
251 directory of the httpd source tree. Every
252 <code>.mak</code> and <code>.dep</code> project file within
253 the current directory and below will be corrected, and the
254 timestamps adjusted to reflect the <code>.dsp</code>.</p>
256 <p>If you contribute back a patch that revises project files, we
257 must commit project files in Visual Studio 6.0 format. Changes
258 should be simple, with minimal compilation and linkage flags that
259 will be recognized by all VC++ 5.0 through 7.0 environments.</p>
261 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
262 <div class="section">
263 <h2><a name="projectcomponents" id="projectcomponents">Project Components</a></h2>
267 <p>The <code>Apache.dsw</code> workspace and <code>makefile.win</code>
268 <code>nmake</code> script both build the <code>.dsp</code> projects
269 of the Apache server in the following sequence:</p>
272 <li><code>srclib\apr\apr.dsp</code></li>
274 <li><code>srclib\apr\libapr.dsp</code></li>
276 <li><code>srclib\apr-util\uri\gen_uri_delims.dsp</code></li>
278 <li><code>srclib\apr-util\xml\expat\lib\xml.dsp</code></li>
280 <li><code>srclib\apr-util\aprutil.dsp</code></li>
282 <li><code>srclib\apr-util\libaprutil.dsp</code></li>
284 <li><code>srclib\pcre\dftables.dsp</code></li>
286 <li><code>srclib\pcre\pcre.dsp</code></li>
288 <li><code>srclib\pcre\pcreposix.dsp</code></li>
290 <li><code>server\gen_test_char.dsp</code></li>
292 <li><code>libhttpd.dsp</code></li>
294 <li><code>Apache.dsp</code></li>
297 <p>In addition, the <code>modules\</code> subdirectory tree contains
298 project files for the majority of the modules.</p>
300 <p>The <code>support\</code> directory contains project files for
301 additional programs that are not part of the Apache runtime,
302 but are used by the administrator to test Apache and maintain
303 password and log files. Windows-specific support projects are
304 broken out in the <code>support\win32\</code> directory.</p>
307 <li><code>support\ab.dsp</code></li>
309 <li><code>support\htdigest.dsp</code></li>
311 <li><code>support\htpasswd.dsp</code></li>
313 <li><code>support\logresolve.dsp</code></li>
315 <li><code>support\rotatelogs.dsp</code></li>
317 <li><code>support\win32\ApacheMonitor.dsp</code></li>
319 <li><code>support\win32\wintty.dsp</code></li>
322 <p>Once Apache has been compiled, it needs to be installed in
323 its server root directory. The default is the
324 <code>\Apache2</code> directory, of the same drive.</p>
326 <p>To build and install all the files into the desired folder
327 <em>dir</em> automatically, use one of the following
328 <code>nmake</code> commands:</p>
330 <div class="example"><pre>
331 nmake /f Makefile.win installr INSTDIR=<em>dir</em>
333 nmake /f Makefile.win installd INSTDIR=<em>dir</em>
336 <p>The <em>dir</em> argument to <code>INSTDIR</code> gives
337 the installation directory; it can be omitted if Apache is
338 to be installed into <code>\Apache2</code>.</p>
340 <p>This will install the following:</p>
343 <li><code><em>dir</em>\bin\Apache.exe</code> - Apache
346 <li><code><em>dir</em>\bin\ApacheMonitor.exe</code> - Service
347 monitor taskbar icon utility</li>
349 <li><code><em>dir</em>\bin\htdigest.exe</code> - Digest auth
350 password file utility</li>
352 <li><code><em>dir</em>\bin\htdbm.exe</code> - SDBM auth
353 database password file utility</li>
355 <li><code><em>dir</em>\bin\htpasswd.exe</code> - Basic auth
356 password file utility</li>
358 <li><code><em>dir</em>\bin\logresolve.exe</code> - Log file
359 dns name lookup utility</li>
361 <li><code><em>dir</em>\bin\rotatelogs.exe</code> - Log file
364 <li><code><em>dir</em>\bin\wintty.exe</code> - Console window
367 <li><code><em>dir</em>\bin\libapr.dll</code> - Apache
368 Portable Runtime shared library</li>
370 <li><code><em>dir</em>\bin\libaprutil.dll</code> - Apache
371 Utility Runtime shared library</li>
373 <li><code><em>dir</em>\bin\libhttpd.dll</code> - Apache Core
376 <li><code><em>dir</em>\modules\mod_*.so</code> - Loadable
379 <li><code><em>dir</em>\conf</code> - Configuration
382 <li><code><em>dir</em>\logs</code> - Empty logging
385 <li><code><em>dir</em>\include</code> - C language header
388 <li><code><em>dir</em>\lib</code> - Link library files</li>
391 <h3><a name="projectcomponents-warn" id="projectcomponents-warn">Warning about building Apache from the development tree</a></h3>
395 <div class="note">Note only the <code>.dsp</code> files are maintained between <code>release</code>
396 builds. The <code>.mak</code> files are NOT regenerated, due to the tremendous
397 waste of reviewer's time. Therefore, you cannot rely on the <code>NMAKE</code>
398 commands above to build revised <code>.dsp</code> project files unless you
399 then export all <code>.mak</code> files yourself from the project. This is
400 unnecessary if you build from within the Microsoft
401 Developer Studio environment.</div>
403 <div class="note">Also note it is very worthwhile to build the <code>BuildBin</code>
404 target project (or the command line <code>_apacher</code> or
405 <code>_apached</code> target) prior to exporting the make files.
406 Many files are autogenerated in the build process. Only a full
407 build provides all of the dependent files required to build proper
408 dependency trees for correct build behavior.</div>
410 <p>In order to create distribution <code>.mak</code> files, always review
411 the generated <code>.mak</code> (or <code>.dep</code>) dependencies for
412 Platform SDK or other garbage includes. The <code>DevStudio\SharedIDE\bin\</code>
413 (VC5) or <code>DevStudio\Common\MSDev98\bin\</code> (VC6) directory contains
414 the <code>sysincl.dat</code> file, which must list all exceptions. Update this
415 file (including both forward and backslashed paths, such as both
416 <code>sys/time.h</code> and <code>sys\time.h</code>) to include such dependencies.
417 Including local-install paths in a distributed <code>.mak</code> file will
418 cause the build to fail completely. And don't forget to run
419 <code>srclib/apr/build/fixwin32mak.pl</code> in order to fix absolute
420 paths within the <code>.mak</code> files.</p>
425 <div class="bottomlang">
426 <p><span>Available Languages: </span><a href="../en/platform/win_compiling.html" title="English"> en </a> |
427 <a href="../ko/platform/win_compiling.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
428 </div><div id="footer">
429 <p class="apache">Copyright 2009 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
430 <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>