win_compiling.html revision 3ebc47c97ee0d9a45b18666a70a80bffb18c4eb2
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync<html xmlns="http://www.w3.org/1999/xhtml">
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <head>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <meta name="generator" content="HTML Tidy, see www.w3.org" />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <title>Compiling Apache for Microsoft Windows</title>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync </head>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync vlink="#000080" alink="#FF0000">
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <!--#include virtual="header.html" -->
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <h1 align="center">Compiling Apache for Microsoft Windows</h1>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <p>There are many important points before you begin compiling
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync Apache. See <a href="windows.html">Using Apache with Microsoft
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync Windows</a> before you begin.</p>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <h3><a id="requirements"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync name="requirements">Requirements</a></h3>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <p>Compiling Apache requires the following environment to be
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync properly installed;</p>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <ul>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <li>Disk Space<br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync Make sure you have at least 50 MB of free disk space
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync available. After installation Apache requires approximately
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync 10 MB of disk space, plus space for log and cache files,
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync which can grow rapidly. The actual disk space requirements
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync will vary considerably based on your chosen configuration and
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync any third-party modules or libraries.<br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync </li>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <li>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync Microsoft Visual C++ 5.0 or higher.<br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync Apache can be built using the command line tools, or from
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync within the Visual Studio IDE Workbench. The command line
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync build requires the environment to reflect the PATH, INCLUDE,
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync LIB and other variables that can be configured with the
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync vcvars32 batch file:
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync<pre>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync "c:\Program Files\DevStudio\VC\Bin\vcvars32.bat"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync</pre>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync </li>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <li>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync The Windows Platform SDK.<br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync Visual C++ 5.0 builds require an updated Microsoft Windows
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync Platform SDK to enable some Apache features. For command line
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync builds, the Platform SDK environment is prepared by the
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync setenv batch file:
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync<pre>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync "c:\Program Files\Platform SDK\setenv.bat"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync</pre>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync The Platform SDK files distributed with Visual C++ 6.0 and
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync later are sufficient, so users of later version may skip
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync this requirement.<br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <strong>Note</strong> that the Windows Platform SDK update
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync is required to enable all supported mod_isapi features.
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync Without a recent update, Apache will issue warnings under
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync MSVC++ 5.0 that some mod_isapi features will be disabled.
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync Look for the update at <a
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync href="http://msdn.microsoft.com/downloads/sdks/platform/platform.asp">
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync http://msdn.microsoft.com/downloads/sdks/platform/platform.asp</a>.<br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync </li>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <li>The awk utility (awk, gawk or similar.)<br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync To install Apache within the build system, several files are
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync modified using the awk.exe utility. awk was chosen since it
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync is a very small download (compared with Perl or WSH/VB) and
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync accomplishes the task of generating files. Brian Kernighan's
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <a href="http://cm.bell-labs.com/cm/cs/who/bwk/"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync >http://cm.bell-labs.com/cm/cs/who/bwk/</a>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync site has a compiled native Win32 binary,
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <a href="http://cm.bell-labs.com/cm/cs/who/bwk/awk95.exe"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync >http://cm.bell-labs.com/cm/cs/who/bwk/awk95.exe</a> which
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync you must save with the name awk.exe rather than awk95.exe.<br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync Note that Developer Studio IDE will only find awk.exe from
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync the <u>T</u>ools menu <u>O</u>ptions... Directories tab list of
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync Executable file paths. Add the path for awk.exe to this list,
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync and your system PATH environment variable, as needed.<br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync </li>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <li>[Optional] OpenSSL libraries (for mod_ssl and ab.exe with ssl support)<br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <strong>Caution: there are significant restrictions and
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync prohibitions on the use and distribution of strong cryptography
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync and patented intellectual property throughout the world.</strong>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync OpenSSL includes strong cryptography controlled by both export
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync regulations and domestic law, as well as intellectual property
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync protected by patent, in the United States and elsewhere. Neither
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync the Apache Software Foundation nor the OpenSSL project can provide
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync legal advise regarding possession, use, or distribution of the code
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync provided by the OpenSSL project. <strong>Consult your own legal
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync counsel, you are responsible for your own actions.</strong><br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync OpenSSL must be installed into a srclib subdirectory named openssl,
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync obtained from <a href="http://www.openssl.org/source/"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync >http://www.openssl.org/source/</a>, in order to compile mod_ssl
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync or the abs project (ab.exe with SSL support.) To prepare OpenSSL
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync for both release and debug builds of Apache, and disable the patent
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync protected features in 0.9.6c (as built by the ASF for binary
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync distribution from the United States), you might use the following
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync build commands;
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync<pre>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync perl util\mkfiles.pl >MINFO
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync perl util\mk1mf.pl dll no-asm no-mdc2 no-rc5 no-idea VC-WIN32 >makefile
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync perl util\mk1mf.pl dll debug no-asm no-mdc2 no-rc5 no-idea VC-WIN32 >makefile.dbg
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync perl util\mkdef.pl 32 libeay no-asm no-mdc2 no-rc5 no-idea >ms\libeay32.def
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync perl util\mkdef.pl 32 ssleay no-asm no-mdc2 no-rc5 no-idea >ms\ssleay32.def
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync nmake
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync nmake -f makefile.dbg
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync</pre>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync </li>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <li>[Optional] zlib sources (for mod_deflate)<br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync Zlib must be installed into a srclib subdirectory named zlib,
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync however those sources need not be compiled. The build system will
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync compile the compression sources directly into the mod_deflate
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync module. Zlib can be obtained from <a href="http://www.gzip.org/zlib/"
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync >http://www.gzip.org/zlib/</a> -- mod_deflate is confirmed to
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync build correctly with version 1.1.4.<br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <br />
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync </li>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync </ul>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <h3><a id="commandbuild" name="commandbuild">Command-Line
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync Build</a></h3>
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync <p>First, unpack the Apache distribution into an appropriate
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync directory. Open a command-line prompt and cd to that
a5e7ae69e440f6816420fc99599f044e79e716b6vboxsync directory.</p>
<p>The master Apache makefile instructions are contained in the
<code>Makefile.win</code> file. To compile Apache on Windows
NT, simply use one of the following commands to compiled the
release or debug build, respectively:</p>
<pre>
nmake /f Makefile.win _apacher
nmake /f Makefile.win _apached
</pre>
<p>Either command will compile Apache. The latter will include
debugging information in the resulting files, making it easier
to find bugs and track down problems.</p>
<h3><a id="workspacebuild" name="workspacebuild">Developer
Studio Workspace IDE Build</a></h3>
<p>Apache can also be compiled using VC++'s VisualStudio
development environment. To simplify this process, a
VisualStudio workspace, Apache.dsw, is provided. This workspace
exposes the entire list of working .dsp projects that are
required for the complete Apache binary release. It includes
dependencies between the projects to assure that they are built
in the appropriate order.</p>
<p>Open the Apache.dsw workspace, and select InstallBin
(Release or Debug build, as desired) as the Active Project.
InstallBin causes all related project to be built, and then
invokes Makefile.win to move the compiled executables and dlls.
You may personalize the INSTDIR= choice by changing
InstallBin's Settings, General tab, Build command line entry.
INSTDIR defaults to the /Apache2 directory. If you only want
a test compile (without installing) you may build the BuildBin
project instead.</p>
<p>The .dsp project files are distributed in Visual C++ 6.0
format. Visual C++ 5.0 (97) will recognize them. Visual C++
7.0 (.net) must convert Apache.dsw plus the .dsp files into an
.msproj format, be sure you reconvert the .msproj file if any
of the source .dsp files change!</p>
<p>Exported .mak files pose a greater hassle, but they are
required for Visual C++ 5.0 and 7.0 users to build mod_ssl, ab
with SSL support or mod_deflate, since only VC 6.0 knows how
to invoke .dsp files directly. Build the entire project from
within the IDE, then export all makefiles. You must build the
projects in order to create all dynamic auto-generated targets,
so that dependencies can be parsed correctly. Run the following
command to fix the paths so they will build anywhere;
<pre>
perl srclib\apr\build\fixwin32mak.pl
</pre>
You must type this command from the <em>top level</em>
directory of the httpd source tree. Every .mak and .dep project
file within the current directory and below will be converted,
and the timestamps adjusted to reflect the .dsp. If you contribute
back a patch that revises project files, you must submit project
files in Visual Studio 6.0 format.<br />
<br />
<h3><a id="projectcomponents" name="projectcomponents">Project
Components</a></h3>
<p>The Apache.dsw workspace and makefile.win nmake script both
build the .dsp projects of the Apache server in the following
sequence:</p>
<ol>
<li><code>srclib\apr\apr.dsp</code></li>
<li><code>srclib\apr\libapr.dsp</code></li>
<li><code>srclib\apr-util\uri\gen_uri_delims.dsp</code></li>
<li><code>srclib\apr-util\xml\expat\lib\xml.dsp</code></li>
<li><code>srclib\apr-util\aprutil.dsp</code></li>
<li><code>srclib\apr-util\libaprutil.dsp</code></li>
<li><code>srclib\pcre\dftables.dsp</code></li>
<li><code>srclib\pcre\pcre.dsp</code></li>
<li><code>srclib\pcre\pcreposix.dsp</code></li>
<li><code>server\gen_test_char.dsp</code></li>
<li><code>libhttpd.dsp</code></li>
<li><code>Apache.dsp</code></li>
</ol>
<p>In addition, the <code>modules\</code> subdirectory tree contains
project files for the majority of the modules.</p>
<p>The <code>support\</code> directory contains project files for
additional programs that are not part of the Apache runtime,
but are used by the administrator to test Apache and maintain
password and log files. Windows-specific support projects are
broken out in the <code>support\win32\</code> directory.</p>
<ol>
<li><code>support\ab.dsp</code></li>
<li><code>support\htdigest.dsp</code></li>
<li><code>support\htpasswd.dsp</code></li>
<li><code>support\logresolve.dsp</code></li>
<li><code>support\rotatelogs.dsp</code></li>
<li><code>support\win32\ApacheMonitor.dsp</code></li>
<li><code>support\win32\wintty.dsp</code></li>
</ol>
<p>Once Apache has been compiled, it needs to be installed in
its server root directory. The default is the
<code>\Apache2</code> directory, of the same drive.</p>
<p>To build and install all the files into the desired folder
<em>dir</em> automatically, use one the following nmake
commands:</p>
<pre>
nmake /f Makefile.win installr INSTDIR=<em>dir</em>
nmake /f Makefile.win installd INSTDIR=<em>dir</em>
</pre>
The <em>dir</em> argument to INSTDIR gives the installation
directory; it can be omitted if Apache is to be installed into
<samp>\Apache2</samp>.<br />
<br />
<p>This will install the following:</p>
<ul>
<li><code><em>dir</em>\bin\Apache.exe</code> - Apache
executable</li>
<li><code><em>dir</em>\bin\ApacheMonitor.exe</code> - Service
monitor taskbar icon utility</li>
<li><code><em>dir</em>\bin\htdigest.exe</code> - Digest auth
password file utility</li>
<li><code><em>dir</em>\bin\htdbm.exe</code> - SDBM auth
database password file utility</li>
<li><code><em>dir</em>\bin\htpasswd.exe</code> - Basic auth
password file utility</li>
<li><code><em>dir</em>\bin\logresolve.exe</code> - Log file
dns name lookup utility</li>
<li><code><em>dir</em>\bin\rotatelogs.exe</code> - Log file
cycling utility</li>
<li><code><em>dir</em>\bin\wintty.exe</code> - Console window
utility</li>
<li><code><em>dir</em>\bin\libapr.dll</code> - Apache
Portable Runtime shared library</li>
<li><code><em>dir</em>\bin\libaprutil.dll</code> - Apache
Utility Runtime shared library</li>
<li><code><em>dir</em>\bin\libhttpd.dll</code> - Apache Core
library</li>
<li><code><em>dir</em>\modules\mod_*.so</code> - Loadable
Apache modules</li>
<li><code><em>dir</em>\conf</code> - Configuration
directory</li>
<li><code><em>dir</em>\logs</code> - Empty logging
directory</li>
<li><code><em>dir</em>\include</code> - C language header
files</li>
<li><code><em>dir</em>\lib</code> - Link library files</li>
</ul>
<p><strong>Warning about building Apache from the development
tree</strong></p>
<p>Note; only the .dsp files are maintained between release builds.
The .mak files are NOT regenerated, due to the tremendous waste
of reviewer's time. Therefore, you cannot rely on the NMAKE
commands above to build revised .dsp project files unless you
then export all .mak files yourself from the project. This is
unnecessary if you build from within the Microsoft
Developer Studio environment.</p>
<p><strong>Note:</strong> it is very worthwhile to build the
BuildBin target project (or the command line _apacher or _apached
target) prior to exporting the make files. Many files are
autogenerated in the build process. Only a full build provides
all of the dependent files required to build proper dependency
trees for correct build behavior.</p>
<p>In order to create distribution .mak files, always review
the generated .mak (or .dep) dependencies for Platform SDK or
other garbage includes. The DevStudio\SharedIDE\bin\ (VC5) or
DevStudio\Common\MSDev98\bin\ (VC6) directory contains the
sysincl.dat file, which must list all exceptions. Update this
file (including both forward and backslashed paths, such as
both sys/time.h and sys\time.h) to include such dependencies.
Including local-install paths in a distributed .mak file will
cause the build to fail completely. And don't forget to run
srclib/apr/build/fixwin32mak.pl in order to fix absolute
paths within the .mak files.</p>
<!--#include virtual="footer.html" --> </body>
</html>