55cf6e01272ec475edea32aa9b7923de2d36cb42Christian Maeder<?xml version="1.0" encoding="UTF-8" ?>

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski<!DOCTYPE manualpage SYSTEM "/style/manualpage.dtd">

e9458b1a7a19a63aa4c179f9ab20f4d50681c168Jens Elkner<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>

ad001203f4a69f0fcb5220ee6c867d733e095e9fChristian Maeder

847bce917a02f26efadcca96e5a87f25b3f71a13mscodescu

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski<manualpage metafile="win_compiling.xml.meta">

92454b97e1cb66cfb8622cf38efdac493d2b2b2dTill Mossakowski <parentdocument href="./">Platform Specific Notes</parentdocument>

92454b97e1cb66cfb8622cf38efdac493d2b2b2dTill Mossakowski

7857a35e3af533dfbd0f0e18638ebd211e6358a0Christian Maeder <title>Compiling Apache for Microsoft Windows</title>

7857a35e3af533dfbd0f0e18638ebd211e6358a0Christian Maeder

92454b97e1cb66cfb8622cf38efdac493d2b2b2dTill Mossakowski <summary>

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski

2b6e94fde08a2fa9ed3d245ca91130d7a301663bChristian Maeder <p>There are many important points before you begin compiling

7857a35e3af533dfbd0f0e18638ebd211e6358a0Christian Maeder Apache. See <a href="windows.html">Using Apache with Microsoft

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski Windows</a> before you begin.</p>

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski

7857a35e3af533dfbd0f0e18638ebd211e6358a0Christian Maeder </summary>

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski <section id="requirements">

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski <title>Requirements</title>

92454b97e1cb66cfb8622cf38efdac493d2b2b2dTill Mossakowski

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski <p>Compiling Apache requires the following environment to be

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski properly installed:</p>

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski <ul>

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski <li>

7857a35e3af533dfbd0f0e18638ebd211e6358a0Christian Maeder <p>Disk Space</p>

7857a35e3af533dfbd0f0e18638ebd211e6358a0Christian Maeder <p>Make sure you have at least 50 MB of free disk space

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski available. After installation Apache requires approximately

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski 10 MB of disk space, plus space for log and cache files,

a65c6747c9acbbebc93baba7bae94d2e3d8cdafbTill Mossakowski which can grow rapidly. The actual disk space requirements

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski will vary considerably based on your chosen configuration and

b1e41bda40d523db7a6debd7f452fa8eb4e357bbFlorian Mossakowski any third-party modules or libraries.</p>

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski </li>

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski <li>

296c6cdef9162217e9d9d1c17790dc71335b8d72Christian Maeder <p>Microsoft Visual C++ 5.0 or higher.</p>

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski <p>Apache can be built using the command line tools, or from

f8538e4caa6ad25272f6d2f4a6fff53a15e7926cChristian Maeder within the Visual Studio IDE Workbench. The command line

cd6e5706893519bfcf24539afa252fcbed5097ddKlaus Luettich build requires the environment to reflect the <code>PATH</code>,

fbf1cdad9a9775bd7332e85f01b6a307d7dbb1cfChristian Maeder <code>INCLUDE</code>, <code>LIB</code> and other variables

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski that can be configured with the <code>vcvars32</code> batch file:</p>

847bce917a02f26efadcca96e5a87f25b3f71a13mscodescu

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski <example>

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski "c:\Program Files\DevStudio\VC\Bin\vcvars32.bat"

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski </example>

f8538e4caa6ad25272f6d2f4a6fff53a15e7926cChristian Maeder </li>

cd6e5706893519bfcf24539afa252fcbed5097ddKlaus Luettich

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski <li>

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski <p>The Windows Platform SDK.</p>

92454b97e1cb66cfb8622cf38efdac493d2b2b2dTill Mossakowski <p>Visual C++ 5.0 builds require an updated Microsoft Windows

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski Platform SDK to enable some Apache features. For command line

92454b97e1cb66cfb8622cf38efdac493d2b2b2dTill Mossakowski builds, the Platform SDK environment is prepared by the

d6c6b2543c509ec7f6213e4cba675d96304a7fd6Christian Maeder <code>setenv</code> batch file:</p>

d6c6b2543c509ec7f6213e4cba675d96304a7fd6Christian Maeder

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski <example>

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski "c:\Program Files\Platform SDK\setenv.bat"

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski </example>

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski <p>The Platform SDK files distributed with Visual C++ 6.0 and

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski later are sufficient, so users of later version may skip

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski this requirement.</p>

eca4db63ed0bdbd93b62678feea6e3eb80aa47bbChristian Maeder

7857a35e3af533dfbd0f0e18638ebd211e6358a0Christian Maeder <note>Note that the Windows Platform SDK update is required

eca4db63ed0bdbd93b62678feea6e3eb80aa47bbChristian Maeder to enable all supported <module>mod_isapi</module> features.

a7be28e157e9ceeec73a8fd0e642c36ea29d4218Christian Maeder Without a recent update, Apache will issue warnings under

a7be28e157e9ceeec73a8fd0e642c36ea29d4218Christian Maeder MSVC++ 5.0 that some <module>mod_isapi</module> features

a7be28e157e9ceeec73a8fd0e642c36ea29d4218Christian Maeder will be disabled. Look for the update at <a

a7be28e157e9ceeec73a8fd0e642c36ea29d4218Christian Maeder href="http://msdn.microsoft.com/downloads/sdks/platform/platform.asp"

fbf1cdad9a9775bd7332e85f01b6a307d7dbb1cfChristian Maeder >http://msdn.microsoft.com/downloads/sdks/platform/platform.asp</a>.</note>

f8538e4caa6ad25272f6d2f4a6fff53a15e7926cChristian Maeder </li>

df6f4a9e6b3d0542ecc181fbc1bcec2affca1d30Christian Maeder

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski <li>

f8538e4caa6ad25272f6d2f4a6fff53a15e7926cChristian Maeder <p>The awk utility (awk, gawk or similar).</p>

f8538e4caa6ad25272f6d2f4a6fff53a15e7926cChristian Maeder <p>To install Apache within the build system, several files are

f8538e4caa6ad25272f6d2f4a6fff53a15e7926cChristian Maeder modified using the <code>awk.exe</code> utility. awk was chosen since it

f8538e4caa6ad25272f6d2f4a6fff53a15e7926cChristian Maeder is a very small download (compared with Perl or WSH/VB) and

f8538e4caa6ad25272f6d2f4a6fff53a15e7926cChristian Maeder accomplishes the task of generating files. Brian Kernighan's

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski <a href="http://cm.bell-labs.com/cm/cs/who/bwk/"

b1f59a4ea7c96f4c03a4d7cfcb9c5e66871cfbbbChristian Maeder >http://cm.bell-labs.com/cm/cs/who/bwk/</a>

b1f59a4ea7c96f4c03a4d7cfcb9c5e66871cfbbbChristian Maeder site has a compiled native Win32 binary,

b1f59a4ea7c96f4c03a4d7cfcb9c5e66871cfbbbChristian Maeder <a href="http://cm.bell-labs.com/cm/cs/who/bwk/awk95.exe"

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski >http://cm.bell-labs.com/cm/cs/who/bwk/awk95.exe</a> which

92454b97e1cb66cfb8622cf38efdac493d2b2b2dTill Mossakowski you must save with the name <code>awk.exe</code> rather than

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski <code>awk95.exe</code>.</p>

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski

3b06e23643a9f65390cb8c1caabe83fa7e87a708Till Mossakowski <note>Note that Developer Studio IDE will only find

03136b84a0c70d877e227444f0875e209506b9e4Christian Maeder <code>awk.exe</code> from the Tools menu Options... Directories

b1f59a4ea7c96f4c03a4d7cfcb9c5e66871cfbbbChristian Maeder tab (the Projects - VC++ Directories pane in Developer Studio 7.0)

2eeec5240b424984e3ee26296da1eeab6c6d739eChristian Maeder listing Executable file paths. Add the path for <code>awk.exe</code>

to this list, and your system <code>PATH</code> environment variable,

as needed.</note>

<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

that the file <code>awk.exe</code> is really a symlink to the <code>gawk.exe</code>

file. The Windows command shell does not recognize symlinks, and because of that

building InstallBin will fail. A workaround is to delete <code>awk.exe</code> from

the cygwin installation and rename <code>gawk.exe</code> to <code>awk.exe</code>.</note>

</li>

<li>

<p>[Optional] OpenSSL libraries (for <module>mod_ssl</module>

and <code>ab.exe</code> with ssl support)</p>

<p><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></p>

<p>OpenSSL must be installed into a <code>srclib</code> subdirectory named

<code>openssl</code>, obtained from <a href="http://www.openssl.org/source/"

>http://www.openssl.org/source/</a>, in order to compile <module>mod_ssl</module>

or the abs project (<code>ab.exe</code> with SSL support.) To prepare OpenSSL

for both <code>release</code> and <code>debug</code> builds of Apache, and

disable the patent protected features in 0.9.7, you might use the following

build commands:</p>

<example>

perl Configure VC-WIN32<br />

perl util\mkfiles.pl &gt;MINFO<br />

perl util\mk1mf.pl dll no-asm no-mdc2 no-rc5 no-idea VC-WIN32 &gt;makefile<br />

perl util\mk1mf.pl dll debug no-asm no-mdc2 no-rc5 no-idea VC-WIN32 &gt;makefile.dbg<br />

perl util\mkdef.pl 32 libeay no-asm no-mdc2 no-rc5 no-idea &gt;ms\libeay32.def<br />

perl util\mkdef.pl 32 ssleay no-asm no-mdc2 no-rc5 no-idea &gt;ms\ssleay32.def<br />

nmake<br />

nmake -f makefile.dbg

</example>

</li>

<li>

<p>[Optional] zlib sources (for <module>mod_deflate</module>)</p>

<p>Zlib must be installed into a <code>srclib</code> subdirectory named

<code>zlib</code>, however those sources need not be compiled. The build system

will compile the compression sources directly into the <module>mod_deflate</module>

module. Zlib can be obtained from <a href="http://www.gzip.org/zlib/"

>http://www.gzip.org/zlib/</a> -- <module>mod_deflate</module> is

confirmed to build correctly with version 1.1.4.</p>

</li>

</ul>

</section>

<section id="commandbuild">

<title>Command-Line Build</title>

<p>First, unpack the Apache distribution into an appropriate

directory. Open a command-line prompt and <code>cd</code> to that

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

<code>release</code> or <code>debug</code> build, respectively:</p>

<example><pre>

nmake /f Makefile.win _apacher

nmake /f Makefile.win _apached

</pre></example>

<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>

</section>

<section id="workspacebuild">

<title>Developer Studio Workspace IDE Build</title>

<p>Apache can also be compiled using VC++'s Visual Studio

development environment. To simplify this process, a

Visual Studio workspace, <code>Apache.dsw</code>, is provided.

This workspace exposes the entire list of working <code>.dsp</code>

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 <code>Apache.dsw</code> workspace, and select

<code>InstallBin</code> (<code>Release</code> or <code>Debug</code> build,

as desired) as the Active Project. <code>InstallBin</code> causes all

related project to be built, and then invokes <code>Makefile.win</code> to

move the compiled executables and dlls. You may personalize the

<code>INSTDIR=</code> choice by changing <code>InstallBin</code>'s Settings,

General tab, Build command line entry. <code>INSTDIR</code> defaults to the

<code>/Apache2</code> directory. If you only want a test compile (without

installing) you may build the <code>BuildBin</code> project instead.</p>

<p>The <code>.dsp</code> 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 <code>Apache.dsw</code> plus the <code>.dsp</code>

files into an <code>Apache.sln</code> plus <code>.msproj</code> files,

be sure you reconvert the <code>.msproj</code> file if any of the source

<code>.dsp</code> files change! This is really trivial, just open

<code>Apache.dsw</code> in the VC++ 7.0 IDE once again.</p>

<p>Visual C++ 7.0 (.net) users should also use the Build

menu, Configuration Manager dialog to uncheck both the <code>Debug</code>

and <code>Release</code> Solution modules abs, <module>mod_ssl</module>

and <module>mod_deflate</module>.

These modules are built by invoking <code>nmake</code> or the IDE directly

with the <code>BinBuild</code> target to build those modules explicitly,

only if the <code>srclib</code> directories <code>openssl</code>

and/or <code>zlib</code> exist.</p>

<p>Exported <code>.mak</code> files pose a greater hassle, but they are

required for Visual C++ 5.0 users to build <module>mod_ssl</module>,

abs (ab with SSL support) and/or <module>mod_deflate</module>.

VC++ 7.0 (.net) users also benefit, <code>nmake</code> builds

are faster than <code>binenv</code> builds.

Build the entire project from within the VC++ 5.0 or 6.0 IDE,

then use the Project Menu Export for all makefiles.

You must build the projects first 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:</p>

<example>

perl srclib\apr\build\fixwin32mak.pl

</example>

<p>You must type this command from the <em>top level</em>

directory of the <code>httpd</code> source tree. Every

<code>.mak</code> and <code>.dep</code> project file within

the current directory and below will be corrected, and the

timestamps adjusted to reflect the <code>.dsp</code>.</p>

<p>If you contribute back a patch that revises project files, we

must commit project files in Visual Studio 6.0 format. Changes

should be simple, with minimal compilation and linkage flags that

will be recognized by all VC++ 5.0 through 7.0 environments.</p>

</section>

<section id="projectcomponents">

<title>Project Components</title>

<p>The <code>Apache.dsw</code> workspace and <code>makefile.win</code>

<code>nmake</code> script both build the <code>.dsp</code> 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 of the following

<code>nmake</code> commands:</p>

<example><pre>

nmake /f Makefile.win installr INSTDIR=<em>dir</em>

nmake /f Makefile.win installd INSTDIR=<em>dir</em>

</pre></example>

<p>The <em>dir</em> argument to <code>INSTDIR</code> gives

the installation directory; it can be omitted if Apache is

to be installed into <code>\Apache2</code>.</p>

<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>

<section id="projectcomponents-warn">

<title>Warning about building Apache from the development tree</title>

<note>Note only the <code>.dsp</code> files are maintained between <code>release</code>

builds. The <code>.mak</code> files are NOT regenerated, due to the tremendous

waste of reviewer's time. Therefore, you cannot rely on the <code>NMAKE</code>

commands above to build revised <code>.dsp</code> project files unless you

then export all <code>.mak</code> files yourself from the project. This is

unnecessary if you build from within the Microsoft

Developer Studio environment.</note>

<note>Also note it is very worthwhile to build the <code>BuildBin</code>

target project (or the command line <code>_apacher</code> or

<code>_apached</code> 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.</note>

<p>In order to create distribution <code>.mak</code> files, always review

the generated <code>.mak</code> (or <code>.dep</code>) dependencies for

Platform SDK or other garbage includes. The <code>DevStudio\SharedIDE\bin\</code>

(VC5) or <code>DevStudio\Common\MSDev98\bin\</code> (VC6) directory contains

the <code>sysincl.dat</code> file, which must list all exceptions. Update this

file (including both forward and backslashed paths, such as both

<code>sys/time.h</code> and <code>sys\time.h</code>) to include such dependencies.

Including local-install paths in a distributed <code>.mak</code> file will

cause the build to fail completely. And don't forget to run

<code>srclib/apr/build/fixwin32mak.pl</code> in order to fix absolute

paths within the <code>.mak</code> files.</p>

</section>

</section>

</manualpage>