granicus.if.org Git - apache/blob - docs/manual/platform/win_compiling.html.en

   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
   7       -->
   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.3</p>
  16 <img alt="" src="../images/feather.gif" /></div>
  17 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  18 <div id="path">
  19 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.3</a> &gt; <a href="./">Platform Specific Notes</a></div><div id="page-content"><div id="preamble"><h1>Compiling Apache for Microsoft Windows</h1>
  20 <div class="toplang">
  21 <p><span>Available Languages: </span><a href="../en/platform/win_compiling.html" title="English">&nbsp;en&nbsp;</a> |
  22 <a href="../ko/platform/win_compiling.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
  23 <a href="../zh-cn/platform/win_compiling.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese">&nbsp;zh-cn&nbsp;</a></p>
  24 </div>
  25
  26
  27     <p>There are many important points to consider before you begin compiling
  28     Apache. See <a href="windows.html">Using Apache with Microsoft
  29     Windows</a> before you begin.</p>
  30
  31   </div>
  32 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#requirements">Requirements</a></li>
  33 <li><img alt="" src="../images/down.gif" /> <a href="#commandbuild">Command-Line Build</a></li>
  34 <li><img alt="" src="../images/down.gif" /> <a href="#workspacebuild">Developer Studio Workspace IDE Build</a></li>
  35 <li><img alt="" src="../images/down.gif" /> <a href="#exportingmakfiles">Exporting command-line .mak files</a></li>
  36 <li><img alt="" src="../images/down.gif" /> <a href="#installation">Installation</a></li>
  37 <li><img alt="" src="../images/down.gif" /> <a href="#projectcomponents-warn">Warning about building Apache from the development tree</a></li>
  38 </ul></div>
  39 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  40 <div class="section">
  41 <h2><a name="requirements" id="requirements">Requirements</a></h2>
  42
  43
  44
  45     <p>Compiling Apache requires the following environment to be
  46     properly installed:</p>
  47
  48     <ul>
  49       <li>
  50         <p>Disk Space</p>
  51
  52         <p>Make sure you have at least 200 MB of free disk space
  53         available. After installation Apache requires approximately
  54         80 MB of disk space, plus space for log and cache files,
  55         which can grow rapidly. The actual disk space requirements
  56         will vary considerably based on your chosen configuration and
  57         any third-party modules or libraries, especially when OpenSSL
  58         is also built.  Because many files are text and very easily
  59         compressed, NTFS filesystem compression cuts these requirements
  60         in half.</p>
  61       </li>
  62
  63       <li>
  64         <p>Appropriate Patches</p>
  65
  66         <p>The httpd binary is built with the help of several patches to
  67         third party packages, which ensure the released code is buildable
  68         and debuggable.  These patches are available and distributed from <a href="http://www.apache.org/dist/httpd/binaries/win32/patches_applied/">http://www.apache.org/dist/httpd/binaries/win32/patches_applied/</a>
  69         and are recommended to be applied to obtain identical results as the
  70         "official" ASF distributed binaries.</p>
  71       </li>
  72
  73       <li>
  74         <p>Microsoft Visual C++ 6.0 (Visual Studio 97) or later.</p>
  75
  76         <p>Apache can be built using the command line tools, or from
  77         within the Visual Studio IDE Workbench.  The command line
  78         build requires the environment to reflect the <code>PATH</code>,
  79         <code>INCLUDE</code>, <code>LIB</code> and other variables
  80         that can be configured with the <code>vcvars32.bat</code> script.</p>
  81
  82         <div class="note">You may want the Visual Studio Processor Pack for your older
  83         version of Visual Studio, or a full (not Express) version of newer
  84         Visual Studio editions, for the ml.exe assembler.  This will allow
  85         you to build OpenSSL, if desired, using the more efficient assembly
  86         code implementation.</div>
  87
  88         <div class="note">Only the Microsoft compiler tool chain is actively supported by
  89         the active httpd contributors.  Although the project regularly accepts
  90         patches to ensure MinGW and other alternative builds work and improve
  91         upon them, they are not actively maintained and are often broken in
  92         the course of normal development.</div>
  93       </li>
  94
  95       <li>
  96         <p>Updated Microsoft Windows Platform SDK, February 2003 or later.</p>
  97
  98         <p>An appropriate Windows Platform SDK is included by default in the
  99         full (not express/lite) versions  of Visual C++ 7.1 (Visual Studio 2002)
 100         and later, these users can ignore these steps unless explicitly choosing
 101         a newer or different version of the Platform SDK.</p>
 102
 103         <p>To use Visual C++ 6.0 or 7.0 (Studio 2000 .NET), the Platform SDK
 104         environment must be prepared using the <code>setenv.bat</code>
 105         script (installed by the Platform SDK) before starting the command
 106         line build or launching the msdev/devenv GUI environment.  Installing
 107         the Platform SDK for Visual Studio Express versions (2003 and later)
 108         should adjust the default environment appropriately.</p>
 109
 110         <div class="example"><p><code>
 111           "c:\Program Files\Microsoft Visual Studio\VC98\Bin\VCVARS32"<br />
 112           "c:\Program Files\Platform SDK\setenv.bat"
 113         </code></p></div>
 114       </li>
 115
 116       <li>
 117         <p>Perl and awk</p>
 118
 119         <p>Several steps recommended here require a perl interpreter during
 120         the build preparation process, but it is otherwise not required.</p>
 121
 122         <p>To install Apache within the build system, several files are
 123         modified using the <code>awk.exe</code> utility. awk was chosen since
 124         it is a very small download (compared with Perl or WSH/VB) and
 125         accomplishes the task of modifying configuration files upon
 126         installation.  Brian Kernighan's
 127         <a href="http://www.cs.princeton.edu/~bwk/btl.mirror/">http://www.cs.princeton.edu/~bwk/btl.mirror/</a>
 128         site has a compiled native Win32 binary,
 129         <a href="http://www.cs.princeton.edu/~bwk/btl.mirror/awk95.exe">http://www.cs.princeton.edu/~bwk/btl.mirror/awk95.exe</a> which
 130         you must save with the name <code>awk.exe</code> (rather than
 131         <code>awk95.exe</code>).</p>
 132
 133         <div class="note">If awk.exe is not found, Makefile.win's install target
 134         will not perform substitutions in the installed .conf files.
 135         You must manually modify the installed .conf files to allow
 136         the server to start.  Search and replace all "@token@" tags
 137         as appropriate.</div>
 138
 139         <div class="note">The Visual Studio IDE will only find <code>awk.exe</code>
 140         from the PATH, or executable path specified in the menu option
 141         Tools -&gt; Options -&gt; (Projects -&gt;) Directories.  Ensure
 142         awk.exe is in your system path.</div>
 143
 144         <div class="note">Also note that if you are using Cygwin tools
 145         (<a href="http://www.cygwin.com/">http://www.cygwin.com/</a>)
 146         the awk utility is named <code>gawk.exe</code> and that the file
 147         <code>awk.exe</code> is really a symlink to the <code>gawk.exe</code>
 148         file. The Windows command shell does not recognize symlinks, and
 149         because of this building InstallBin will fail. A workaround is
 150         to delete <code>awk.exe</code> from the cygwin installation and
 151         copy <code>gawk.exe</code> to <code>awk.exe</code>.  Also note the
 152         cygwin/mingw ports of gawk 3.0.x were buggy, please upgrade to 3.1.x
 153         before attempting to use any gawk port.</div>
 154       </li>
 155
 156       <li>
 157         <p>[Optional] zlib library (for <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code>)</p>
 158
 159         <p>Zlib must be installed into a <code>srclib</code> subdirectory named
 160         <code>zlib</code>.  This must be built in-place.  Zlib can be obtained
 161         from <a href="http://www.zlib.net/">http://www.zlib.net/</a> -- the
 162         <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code> is confirmed to work correctly with
 163         version 1.2.3.</p>
 164
 165         <div class="example"><p><code>
 166           nmake -f win32\Makefile.msc<br />
 167           nmake -f win32\Makefile.msc test
 168         </code></p></div>
 169       </li>
 170
 171       <li>
 172         <p>[Optional] OpenSSL libraries (for <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code>
 173         and <code>ab.exe</code> with ssl support)</p>
 174
 175         <div class="note">The OpenSSL library is cryptographic software.  The country
 176         in which you currently reside may have restrictions on the import,
 177         possession, use, and/or re-export to another country, of encryption
 178         software.  BEFORE using any encryption software, please check your
 179         country's laws, regulations and policies concerning the import,
 180         possession, or use, and re-export of encryption software, to see
 181         if this is permitted.  See
 182         <a href="http://www.wassenaar.org/">http://www.wassenaar.org/</a>
 183         for more information.</div>
 184
 185         <p>Configuring and building OpenSSL requires perl to be installed.</p>
 186
 187         <p>OpenSSL must be installed into a <code>srclib</code> subdirectory
 188         named <code>openssl</code>, obtained from
 189         <a href="http://www.openssl.org/source/">http://www.openssl.org/source/</a>, in order to compile
 190         <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> or the <code>abs.exe</code> project, which
 191         is ab.c with SSL support enabled.  To prepare OpenSSL to be linked
 192         to Apache mod_ssl or abs.exe, and disable patent encumbered features
 193         in OpenSSL,  you might use the following build commands:</p>
 194
 195         <div class="example"><p><code>
 196           perl Configure no-rc5 no-idea enable-mdc2 enable-zlib VC-WIN32
 197                -Ipath/to/srclib/zlib -Lpath/to/srclib/zlib<br />
 198           ms\do_masm.bat<br />
 199           nmake -f ms\ntdll.mak
 200         </code></p></div>
 201
 202         <div class="note">It is not advisable to use zlib-dynamic, as that transfers
 203         the cost of deflating SSL streams to the first request which must
 204         load the zlib dll.  Note the suggested patch enables the -L flag to
 205         work with windows builds, corrects the name of zdll.lib and ensures
 206         .pdb files are generated for troubleshooting.  If the assembler is
 207         not installed, you would add no-asm above and use ms\do_ms.bat
 208         instead of the ms\do_masm.bat script.</div>
 209       </li>
 210
 211       <li>
 212         <p>[Optional] Database libraries (for <code class="module"><a href="../mod/mod_dbd.html">mod_dbd</a></code>
 213         and <code class="module"><a href="../mod/mod_authn_dbm.html">mod_authn_dbm</a></code>)</p>
 214
 215         <p>The apr-util library exposes dbm (keyed database) and dbd (query
 216         oriented database) client functionality to the httpd server and its
 217         modules, such as authentication and authorization.  The sdbm dbm and
 218         odbc dbd providers are compiled unconditionally.</p>
 219
 220         <p>The dbd support includes the Oracle instantclient package, MySQL,
 221         PostgreSQL and sqlite.  To build these all, for example, set up the
 222         LIB to include the library path, INCLUDE to include the headers path,
 223         and PATH to include the dll bin path of all four SDK's, and set the
 224         DBD_LIST environment variable to inform the build which client driver
 225         SDKs are installed correctly, e.g.;</p>
 226
 227         <div class="example"><p><code>
 228           set DBD_LIST=sqlite3 pgsql oracle mysql
 229         </code></p></div>
 230
 231         <p>Similarly, the dbm support can be extended with DBM_LIST to
 232         build a Berkeley DB provider (db) and/or gdbm provider, by similarly
 233         configuring LIB, INCLUDE and PATH first to ensure the client library
 234         libs and headers are available.</p>
 235
 236         <div class="example"><p><code>
 237           set DBM_LIST=db gdbm
 238         </code></p></div>
 239
 240         <div class="note">Depending on the choice of database distributions, it may be
 241         necessary to change the actual link target name (e.g. gdbm.lib vs.
 242         libgdb.lib) that are listed in the corresponding .dsp/.mak files
 243         within the directories srclib\apr-util\dbd or ...\dbm.</div>
 244
 245         <p>See the README-win32.txt file for more hints on obtaining the
 246         various database driver SDKs.</p>
 247       </li>
 248     </ul>
 249
 250   </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 251 <div class="section">
 252 <h2><a name="commandbuild" id="commandbuild">Command-Line Build</a></h2>
 253
 254
 255
 256     <p><code>Makefile.win</code> is the top level Apache makefile.
 257     To compile Apache on Windows, simply use one of the following commands
 258     to build the <code>release</code> or <code>debug</code> flavor:</p>
 259
 260     <div class="example"><p><code>
 261       nmake /f Makefile.win _apacher<br /><br />
 262       nmake /f Makefile.win _apached
 263     </code></p></div>
 264
 265     <p>Either command will compile Apache. The latter will disable
 266     optimization of the resulting files, making it easier to single
 267     step the code to find bugs and track down problems.</p>
 268
 269     <p>You can add your apr-util dbd and dbm provider choices with the
 270     additional make (environment) variables DBD_LIST and DBM_LIST,
 271     see the comments about [Optional] Database libraries, above.
 272     Review the initial comments in Makefile.win for additional options
 273     that can be provided when invoking the build.</p>
 274
 275   </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 276 <div class="section">
 277 <h2><a name="workspacebuild" id="workspacebuild">Developer Studio Workspace IDE Build</a></h2>
 278
 279
 280
 281     <p>Apache can also be compiled using VC++'s Visual Studio
 282     development environment. To simplify this process, a
 283     Visual Studio workspace, <code>Apache.dsw</code>, is provided.
 284     This workspace exposes the entire list of working <code>.dsp</code>
 285     projects that are required for the complete Apache binary release.
 286     It includes dependencies between the projects to assure that they
 287     are built in the appropriate order.</p>
 288
 289     <p>Open the <code>Apache.dsw</code> workspace, and select
 290     <code>InstallBin</code> (<code>Release</code> or <code>Debug</code> build,
 291     as desired) as the Active Project. <code>InstallBin</code> causes all
 292     related project to be built, and then invokes <code>Makefile.win</code> to
 293     move the compiled executables and dlls. You may personalize the
 294     <code>INSTDIR=</code> choice by changing <code>InstallBin</code>'s Settings,
 295     General tab, Build command line entry. <code>INSTDIR</code> defaults to the
 296     <code>/Apache2</code> directory. If you only want a test compile (without
 297     installing) you may build the <code>BuildBin</code> project instead.</p>
 298
 299     <p>The <code>.dsp</code> project files are distributed in Visual Studio 6.0
 300     (98) format. Visual C++ 5.0 (97) will recognize them. Visual Studio
 301     2002 (.NET) and later users must convert <code>Apache.dsw</code> plus
 302     the <code>.dsp</code> files into an <code>Apache.sln</code> plus
 303     <code>.msproj</code> files.  Be sure you reconvert the <code>.msproj</code>
 304     file again if its source <code>.dsp</code> file changes! This is really
 305     trivial, just open <code>Apache.dsw</code> in the VC++ 7.0 IDE once again
 306     and reconvert.</p>
 307
 308     <div class="note">There is a flaw in the .vcproj conversion of .dsp files.  devenv.exe
 309     will mis-parse the /D flag for RC flags containing long quoted /D'efines
 310     which contain spaces.  The command:
 311     <div class="example"><p><code>
 312       perl srclib\apr\build\cvtdsp.pl -2005
 313     </code></p></div>
 314     will convert the /D flags for RC flags to use an alternate, parseable
 315     syntax; unfortunately this syntax isn't supported by Visual Studio 97
 316     or its exported .mak files.  These /D flags are used to pass the long
 317     description of the mod_apachemodule.so files to the shared .rc resource
 318     version-identifier build.</div>
 319
 320     <p>Visual Studio 2002 (.NET) and later users should also use the Build
 321     menu, Configuration Manager dialog to uncheck both the <code>Debug</code>
 322     and <code>Release</code> Solution modules <code>abs</code>,
 323     <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code> and <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code> components, as
 324     well as every component starting with <code>apr_db*</code>.  These modules
 325     are built by invoking <code>nmake</code>, or the IDE directly with the
 326     <code>BinBuild</code> target, which builds those modules conditionally
 327     if the <code>srclib</code> directories <code>openssl</code> and/or
 328     <code>zlib</code> exist, and based on the setting of <code>DBD_LIST</code>
 329     and <code>DBM_LIST</code> environment variables.</p>
 330
 331   </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 332 <div class="section">
 333 <h2><a name="exportingmakfiles" id="exportingmakfiles">Exporting command-line .mak files</a></h2>
 334
 335
 336
 337     <p>Exported <code>.mak</code> files pose a greater hassle, but they are
 338     required for Visual C++ 5.0 users to build <code class="module"><a href="../mod/mod_ssl.html">mod_ssl</a></code>,
 339     abs (<code class="program"><a href="../programs/ab.html">ab</a></code> with SSL support) and/or
 340     <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code>.  The .mak files also support a broader
 341     range of C++ tool chain distributions, such as Visual Studio Express.</p>
 342
 343     <p>You must first build all projects in order to create all dynamic
 344     auto-generated targets, so that dependencies can be parsed correctly.
 345     Build the entire project from within the Visual Studio 6.0 (98) IDE,
 346     using the <code>BuildAll</code> target, then use the Project Menu Export
 347     for all makefiles (checking on "with dependencies".)  Run the following
 348     command to correct absolute paths into relative paths so they will build
 349     anywhere:</p>
 350
 351     <div class="example"><p><code>
 352       perl srclib\apr\build\fixwin32mak.pl
 353     </code></p></div>
 354
 355     <p>You must type this command from the <em>top level</em>
 356     directory of the httpd source tree. Every
 357     <code>.mak</code> and <code>.dep</code> project file within
 358     the current directory and below will be corrected, and the
 359     timestamps adjusted to reflect the <code>.dsp</code>.</p>
 360
 361     <p>Always review the generated <code>.mak</code> and <code>.dep</code>
 362     files for Platform SDK or other local, machine specific file paths.
 363     The <code>DevStudio\Common\MSDev98\bin\</code> (VC6) directory contains
 364     a <code>sysincl.dat</code> file, which lists all exceptions.  Update
 365     this file (including both forward and backslashed paths, such as both
 366     <code>sys/time.h</code> and <code>sys\time.h</code>) to ignore such
 367     newer dependencies.  Including local-install paths in a distributed
 368     <code>.mak</code> file will cause the build to fail completely.</p>
 369
 370     <p>If you contribute back a patch that revises project files, we
 371     must commit project files in Visual Studio 6.0 format. Changes
 372     should be simple, with minimal compilation and linkage flags that
 373     can be recognized by all Visual Studio environments.</p>
 374
 375   </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 376 <div class="section">
 377 <h2><a name="installation" id="installation">Installation</a></h2>
 378
 379
 380
 381     <p>Once Apache has been compiled, it needs to be installed in
 382     its server root directory. The default is the
 383     <code>\Apache2</code> directory, of the same drive.</p>
 384
 385     <p>To build and install all the files into the desired folder
 386     <em>dir</em> automatically, use one of the following
 387     <code>nmake</code> commands:</p>
 388
 389     <div class="example"><p><code>
 390       nmake /f Makefile.win installr INSTDIR=<em>dir</em><br />
 391       nmake /f Makefile.win installd INSTDIR=<em>dir</em>
 392     </code></p></div>
 393
 394     <p>The <em>dir</em> argument to <code>INSTDIR</code> provides
 395     the installation directory; it can be omitted if Apache is
 396     to be installed into <code>\Apache22</code> (of the current
 397     drive).</p>
 398
 399   </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 400 <div class="section">
 401 <h2><a name="projectcomponents-warn" id="projectcomponents-warn">Warning about building Apache from the development tree</a></h2>
 402
 403
 404
 405     <div class="note">Note only the <code>.dsp</code> files are maintained between <code>release</code>
 406     builds. The <code>.mak</code> files are NOT regenerated, due to the tremendous
 407     waste of reviewer's time. Therefore, you cannot rely on the <code>NMAKE</code>
 408     commands above to build revised <code>.dsp</code> project files unless you
 409     then export all <code>.mak</code> files yourself from the project. This is
 410     unnecessary if you build from within the Microsoft
 411     Developer Studio environment.</div>
 412
 413   </div></div>
 414 <div class="bottomlang">
 415 <p><span>Available Languages: </span><a href="../en/platform/win_compiling.html" title="English">&nbsp;en&nbsp;</a> |
 416 <a href="../ko/platform/win_compiling.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a> |
 417 <a href="../zh-cn/platform/win_compiling.html" hreflang="zh-cn" rel="alternate" title="Simplified Chinese">&nbsp;zh-cn&nbsp;</a></p>
 418 </div><div id="footer">
 419 <p class="apache">Copyright 2011 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>
 420 <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>
 421 </body></html>