win_compiling.html revision 9c7d84d0aee1160bf48fe35bc90fd572577e9fdc
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Compiling Apache for Microsoft Windows</title>
</head>
<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
<body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
vlink="#000080" alink="#FF0000">
<!--#include virtual="header.html" -->
<h1 align="center">Compiling Apache for Microsoft Windows</h1>
<p>There are many important points before you begin compiling
Apache. See <a href="windows.html">Using Apache with Microsoft
Windows</a> before you begin.</p>
<h3><a id="requirements"
name="requirements">Requirements</a></h3>
<p>Compiling Apache requires the following environment to be
properly installed;</p>
<ul>
<li>Disk Space<br />
<br />
Make sure you have at least 50 MB of free disk space
available. After installation Apache requires approximately
10 MB of disk space, plus space for log and cache files,
which can grow rapidly. The actual disk space requirements
will vary considerably based on your chosen configuration and
any third-party modules or libraries.<br />
<br />
</li>
<li>
Microsoft Visual C++ 5.0 or higher.<br />
<br />
Apache can be built using the command line tools, or from
within the Visual Studio IDE Workbench. The command line
build requires the environment to reflect the PATH, INCLUDE,
LIB and other variables that can be configured with the
vcvars32 batch file:
<pre>
"c:\Program Files\DevStudio\VC\Bin\vcvars32.bat"
</pre>
</li>
<li>
The Windows Platform SDK.<br />
<br />
Visual C++ 5.0 builds require an updated Microsoft Windows
Platform SDK to enable some Apache features. For command line
builds, the Platform SDK environment is prepared by the
setenv batch file:
<pre>
"c:\Program Files\Platform SDK\setenv.bat"
</pre>
The Platform SDK files distributed with Visual C++ 6.0 and
later are sufficient, so users of later version may skip
this requirement.<br />
<br />
<strong>Note</strong> that the Windows Platform SDK update
is required to enable all supported mod_isapi features.
Without a recent update, Apache will issue warnings under
MSVC++ 5.0 that some mod_isapi features will be disabled.
Look for the update at <a
<br />
</li>
<li>The awk utility (awk, gawk or similar.)<br />
<br />
To install Apache within the build system, several files are
modified using the awk.exe utility. awk was chosen since it
accomplishes the task of generating files. Brian Kernighan's
<a href="http://cm.bell-labs.com/cm/cs/who/bwk/"
site has a compiled native Win32 binary,
<br />
Note that Developer Studio IDE will only find awk.exe from
the <u>T</u>ools menu <u>O</u>ptions... Directories tab
(the Projects - VC++ Directories pane in Developer Studio 7.0)
listing Executable file paths. Add the path for awk.exe to this
list, and your system PATH environment variable, as needed.<br />
<br />
</li>
<br />
<strong>Caution: there are significant restrictions and
prohibitions on the use and distribution of strong cryptography
and patented intellectual property throughout the world.</strong>
OpenSSL includes strong cryptography controlled by both export
regulations and domestic law, as well as intellectual property
protected by patent, in the United States and elsewhere. Neither
the Apache Software Foundation nor the OpenSSL project can provide
legal advise regarding possession, use, or distribution of the code
provided by the OpenSSL project. <strong>Consult your own legal
counsel, you are responsible for your own actions.</strong><br />
<br />
OpenSSL must be installed into a srclib subdirectory named openssl,
obtained from <a href="http://www.openssl.org/source/"
>http://www.openssl.org/source/</a>, in order to compile mod_ssl
or the abs project (ab.exe with SSL support.) To prepare OpenSSL
for both release and debug builds of Apache, and disable the patent
protected features in 0.9.6d (as built by the ASF for binary
distribution from the United States), you might use the following
build commands;
<pre>
perl util\mkfiles.pl >MINFO
perl util\mk1mf.pl dll no-asm no-mdc2 no-rc5 no-idea VC-WIN32 >makefile
perl util\mk1mf.pl dll debug no-asm no-mdc2 no-rc5 no-idea VC-WIN32 >makefile.dbg
perl util\mkdef.pl 32 libeay no-asm no-mdc2 no-rc5 no-idea >ms\libeay32.def
perl util\mkdef.pl 32 ssleay no-asm no-mdc2 no-rc5 no-idea >ms\ssleay32.def
nmake
nmake -f makefile.dbg
</pre>
</li>
<li>[Optional] zlib sources (for mod_deflate)<br />
<br />
Zlib must be installed into a srclib subdirectory named zlib,
however those sources need not be compiled. The build system will
compile the compression sources directly into the mod_deflate
module. Zlib can be obtained from <a href="http://www.gzip.org/zlib/"
>http://www.gzip.org/zlib/</a> -- mod_deflate is confirmed to
build correctly with version 1.1.4.<br />
<br />
</li>
</ul>
<h3><a id="commandbuild" name="commandbuild">Command-Line
Build</a></h3>
<p>First, unpack the Apache distribution into an appropriate
directory. Open a command-line prompt and cd to that
directory.</p>
<p>The master Apache makefile instructions are contained in the
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>
build the .dsp projects of the Apache server in the following
sequence:</p>
<ol>
</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>
</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 of the following nmake
commands:</p>
<pre>
</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>
executable</li>
monitor taskbar icon utility</li>
password file utility</li>
database password file utility</li>
password file utility</li>
dns name lookup utility</li>
cycling utility</li>
utility</li>
Portable Runtime shared library</li>
Utility Runtime shared library</li>
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
Including local-install paths in a distributed .mak file will
cause the build to fail completely. And don't forget to run
paths within the .mak files.</p>
<!--#include virtual="footer.html" --> </body>
</html>