platforms but are disallowed by default on FreeBSD, NetBSD, and
OpenBSD in order to match the system-wide policy on those
platforms. But even on systems where it is disallowed by default, a
- special configure parameter can change this behavior for Apache.</p>
+ special <program>configure</program> parameter can change this behavior
+ for Apache.</p>
<p>On the other hand, on some platforms such as Linux and Tru64 the
<strong>only</strong> way to handle both IPv6 and IPv4 is to use
mapped addresses. If you want Apache to handle IPv4 and IPv6 connections
with a minimum of sockets, which requires using IPv4-mapped IPv6
- addresses, specify the <code>--enable-v4-mapped</code> <a
- href="programs/configure.html">configure</a> option.</p>
+ addresses, specify the <code>--enable-v4-mapped</code> <program>
+ configure</program> option.</p>
<p><code>--enable-v4-mapped</code> is the default on all platforms but
FreeBSD, NetBSD, and OpenBSD, so this is probably how your Apache was
<p>If your platform supports it and you want Apache to handle IPv4 and
IPv6 connections on separate sockets (i.e., to disable IPv4-mapped
- addresses), specify the <code>--disable-v4-mapped</code> <a
- href="programs/configure.html">configure</a> option.
- <code>--disable-v4-mapped</code> is the default on FreeBSD,
- NetBSD, and OpenBSD.</p>
+ addresses), specify the <code>--disable-v4-mapped</code> <program>
+ configure</program> option. <code>--disable-v4-mapped</code> is the
+ default on FreeBSD, NetBSD, and OpenBSD.</p>
</section>
<section id="virtualhost">
<p>The addition of <a href="vhosts/name-based.html">name-based
virtual host support</a> in Apache 1.1 requires Apache to know
- the IP address(es) of the host that httpd is running on. To get
- this address it uses either the global
+ the IP address(es) of the host that <program>httpd</program>
+ is running on. To get this address it uses either the global
<directive module="core">ServerName</directive>
(if present) or calls the C function <code>gethostname</code>
(which should return the same as typing "hostname" at the
<p>The Apache HTTP Server is a modular program where the
administrator can choose the functionality to include in the
server by selecting a set of modules. The modules can be
- statically compiled into the <code>httpd</code> binary when the
+ statically compiled into the <program>httpd</program> binary when the
server is built. Alternatively, modules can be compiled as
Dynamic Shared Objects (DSOs) that exist separately from the
- main <code>httpd</code> binary file. DSO modules may be
+ main <program>httpd</program> binary file. DSO modules may be
compiled at the time the server is built, or they may be
compiled and added at a later time using the Apache Extension
- Tool (<a href="programs/apxs.html">apxs</a>).</p>
+ Tool (<program>apxs</program>).</p>
<p>This document describes how to use DSO modules as well as
the theory behind their use.</p>
<module>core</module> which cannot be put into a DSO
itself. Practically all other distributed Apache modules can then
be placed into a DSO by individually enabling the DSO build for
- them via <code>configure</code>'s
+ them via <program>configure</program>'s
<code>--enable-<em>module</em>=shared</code> option as discussed
in the <a href="install.html">install documentation</a>. After a
module is compiled into a DSO named <code>mod_foo.so</code> you
<p>To simplify this creation of DSO files for Apache modules
(especially for third-party modules) a new support program
- named <a href="programs/apxs.html">apxs</a> (<em>APache
- eXtenSion</em>) is available. It can be used to build DSO based
+ named <program>apxs</program> (<dfn>APache
+ eXtenSion</dfn>) is available. It can be used to build DSO based
modules <em>outside of</em> the Apache source tree. The idea is
- simple: When installing Apache the <code>configure</code>'s
+ simple: When installing Apache the <program>configure</program>'s
<code>make install</code> procedure installs the Apache C
header files and puts the platform-dependent compiler and
- linker flags for building DSO files into the <code>apxs</code>
- program. This way the user can use <code>apxs</code> to compile
+ linker flags for building DSO files into the <program>apxs</program>
+ program. This way the user can use <program>apxs</program> to compile
his Apache module sources without the Apache distribution
source tree and without having to fiddle with the
platform-dependent compiler and linker flags for DSO
<code>mod_foo.so</code>:
<example>
-$ ./configure --add-module=module_type:/path/to/3rdparty/mod_foo.c --enable-foo=shared<br />
+$ ./configure --add-module=<var>module_type</var>:/path/to/3rdparty/mod_foo.c \<br />
+<indent>
+ --enable-foo=shared<br />
+</indent>
$ make install
</example>
</li>
Build and install a <em>third-party</em> Apache module, say
<code>mod_foo.c</code>, into its own DSO
<code>mod_foo.so</code> <em>outside of</em> the Apache
- source tree using <a href="programs/apxs.html">apxs</a>:
+ source tree using <program>apxs</program>:
<example>
$ cd /path/to/3rdparty<br />
the actual server process can be assembled at run-time via
<directive module="mod_so">LoadModule</directive>
<code>httpd.conf</code> configuration commands instead of
- <code>configure</code> options at build-time. For instance
+ <program>configure</program> options at build-time. For instance
this way one is able to run different server instances
(standard & SSL version, minimalistic & powered up
version [mod_perl, PHP3], <em>etc.</em>) with only one Apache
<em>etc.</em></li>
<li>Easier Apache module prototyping because with the
- DSO/<code>apxs</code> pair you can both work outside the
+ DSO/<program>apxs</program> pair you can both work outside the
Apache source tree and only need an <code>apxs -i</code>
command followed by an <code>apachectl restart</code> to
bring a new version of your currently developed module into
<li>It is not possible to override or change the standard CGI
variables using the environment manipulation directives.</li>
- <li>When <a href="suexec.html">suexec</a> is used to launch
+ <li>When <program>suexec</program> is used to launch
CGI scripts, the environment will be cleaned down to a set of
<em>safe</em> variables before CGI scripts are launched. The
list of <em>safe</em> variables is defined at compile-time in
ref="module">module</glossary> sources into Dynamic Shared Objects
(<glossary ref="dso">DSO</glossary>s) and helps install them in the
Apache Web server.<br />
- See: <a href="programs/apxs.html">Manual Page: apxs</a>
+ See: Manual Page: <program>apxs</program>
</dd>
<dt><a name="authentication" id="authentication">Authentication</a></dt>
<dt><a name="dynamicsharedobject" id="dynamicsharedobject">Dynamic
Shared Object</a> <a name="dso" id="dso">(DSO)</a></dt>
<dd><glossary ref="module">Modules</glossary> compiled separately from the
- Apache httpd binary that can be loaded on-demand.<br />
+ Apache <program>httpd</program> binary that can be loaded on-demand.<br />
See: <a href="dso.html">Dynamic Shared Object Support</a>
</dd>
<dt><a name="module" id="module">Module</a></dt>
<dd>An independent part of a program. Much of Apache's functionality is
contained in modules that you can choose to include or exclude. Modules
- that are compiled into the Apache httpd binary are called <em>static
- modules</em>, while modules that are stored separately and can be
- optionally loaded at run-time are called <em>dynamic modules</em> or
- <glossary ref="dso">DSOs</glossary>. Modules that are included by default
- are called <em>base modules</em>. Many modules are available for Apache
+ that are compiled into the Apache <program>httpd</program> binary are
+ called <dfn>static modules</dfn>, while modules that are stored
+ separately and can be optionally loaded at run-time are called
+ <dfn>dynamic modules</dfn> or <glossary ref="dso">DSOs</glossary>.
+ Modules that are included by default
+ are called <dfn>base modules</dfn>. Many modules are available for Apache
that are not distributed as part of the Apache HTTP Server <glossary
ref="tarball">tarball</glossary>. These are referred to as
- <em>third-party modules</em>.<br />
+ <dfn>third-party modules</dfn>.<br />
See: <a href="mod/">Module Index</a>
</dd>
might want to put the password file(s) in
<code>/usr/local/apache/passwd</code>.</p>
- <p>To create the file, use the <a
- href="../programs/htpasswd.html">htpasswd</a> utility that came
- with Apache. This will be located in the <code>bin</code> directory
+ <p>To create the file, use the <program>htpasswd</program> utility that
+ came with Apache. This will be located in the <code>bin</code> directory
of wherever you installed Apache. To create the file, type:</p>
<example>
htpasswd -c /usr/local/apache/passwd/passwords rbowen
</example>
- <p><code>htpasswd</code> will ask you for the password, and
+ <p><program>htpasswd</program> will ask you for the password, and
then ask you to type it again to confirm it:</p>
<example>
Adding password for user rbowen
</example>
- <p>If <code>htpasswd</code> is not in your path, of course
+ <p>If <program>htpasswd</program> is not in your path, of course
you'll have to type the full path to the file to get it to run.
On my server, it's located at
<code>/usr/local/apache/bin/htpasswd</code></p>
<p>The <directive module="mod_authn_file">AuthUserFile</directive>
directive sets the path to the password file that we just
- created with <code>htpasswd</code>. If you have a large number
+ created with <program>htpasswd</program>. If you have a large number
of users, it can be quite slow to search through a plain text
file to authenticate the user on each request. Apache also has
the ability to store user information in fast database files.
The <module>mod_authn_dbm</module> module provides the <directive
module="mod_authn_dbm">AuthDBMUserFile</directive> directive. These
- files can be created and manipulated with the <a
- href="../programs/dbmmanage.html">dbmmanage</a> program. Many
+ files can be created and manipulated with the <program>
+ dbmmanage</program> program. Many
other types of authentication options are available from third
party modules in the <a
href="http://modules.apache.org/">Apache Modules
<p>To check if you are using suexec, run <code>apachectl
-V</code> and check for the location of <code>SUEXEC_BIN</code>.
- If Apache finds an suexec binary there on startup, suexec will
- be activated.</p>
+ If Apache finds an <program>suexec</program> binary there on startup,
+ suexec will be activated.</p>
<p>Unless you fully understand suexec, you should not be using it.
- To disable suexec, simply remove (or rename) the <code>suexec</code>
+ To disable suexec, simply remove (or rename) the <program>suexec</program>
binary pointed to by <code>SUEXEC_BIN</code> and then restart the
server. If, after reading about <a href="../suexec.html">suexec</a>,
you still wish to use it, then run <code>suexec -V</code> to find
<dt><a href="http://www.perl.org/">Perl 5</a>
[OPTIONAL]</dt>
- <dd>For some of the support scripts like <a
- href="programs/apxs.html">apxs</a> or <a
- href="programs/dbmmanage.html">dbmmanage</a> (which are
+ <dd>For some of the support scripts like <program>
+ apxs</program> or <program>dbmmanage</program> (which are
written in Perl) the Perl 5 interpreter is required (versions
5.003 or newer are sufficient). If no such interpreter is found by
- the `<code>configure</code>' script there is no harm. Of course, you
+ the <program>configure</program> script there is no harm. Of course, you
still can build and install Apache 2.0. Only those support scripts
cannot be used. If you have multiple Perl interpreters
installed (perhaps a Perl 4 from the vendor and a Perl 5 from
your own), then it is recommended to use the <code>--with-perl</code>
option (see below) to make sure the correct one is selected
- by <code>./configure</code>.</dd>
+ by <program>configure</program>.</dd>
</dl>
</section>
<p>The next step is to configure the Apache source tree for your
particular platform and personal requirements. This is done using
- the script <code><a
- href="programs/configure.html">configure</a></code> included in
+ the script <program>configure</program> included in
the root directory of the distribution. (Developers downloading
the CVS version of the Apache source tree will need to have
<code>autoconf</code> and <code>libtool</code> installed and will
<p>To configure the source tree using all the default options,
simply type <code>./configure</code>. To change the default
- options, <code>configure</code> accepts a variety of variables
+ options, <program>configure</program> accepts a variety of variables
and command line options.</p>
<p>The most important option is the location <code>--prefix</code>
<code>--enable-<var>module</var>=shared</code>. Similarly, you can
disable Base modules with the
<code>--disable-<var>module</var></code> option. Be careful when
- using these options, since <code>configure</code> cannot warn you
+ using these options, since <program>configure</program> cannot warn you
if the module you specify does not exist; it will simply ignore the
option.</p>
<p>In addition, it is sometimes necessary to provide the
- <code>configure</code> script with extra information about the
+ <program>configure</program> script with extra information about the
location of your compiler, libraries, or header files. This is
done by passing either environment variables or command line
- options to <code>configure</code>. For more information, see the
+ options to <program>configure</program>. For more information, see the
<a href="programs/configure.html">configure manual page</a>.</p>
<p>For a short impression of what possibilities you have, here
--enable-speling=shared
</example>
- <p>When <code>configure</code> is run it will take several minutes to
+ <p>When <program>configure</program> is run it will take several minutes to
test for the availability of features on your system and build
Makefiles which will later be used to compile the server.</p>
process will not overwrite any of your existing documents, log
files, or configuration files. In addition, the developers make
every effort to avoid incompatible changes in the
- <code>configure</code> options, run-time configuration, or the
+ <program>configure</program> options, run-time configuration, or the
module API between minor versions. In most cases you should be able to
- use an identical <code>configure</code> command line, an identical
+ use an identical <program>configure</program> command line, an identical
configuration file, and all of your modules should continue to
work. (This is only valid for versions after 2.0.41; earlier
versions have incompatible changes.)</p>
<p>If you kept the source tree from your last installation,
upgrading is even easier. The file <code>config.nice</code> in
the root of the old source tree contains the exact
- <code>configure</code> command line that you used to configure the
+ <program>configure</program> command line that you used to configure the
source tree. Then to upgrade from one version to the next, you
need only copy the <code>config.nice</code> file to the source
tree of the new version, edit it to make any desired changes, and
and <a href="platform/windows.html#wincons">Running Apache as a
Console Application</a>.</p>
- <p>On Unix, the <a href="programs/httpd.html">httpd</a> program
+ <p>On Unix, the <program>httpd</program> program
is run as a daemon that executes continuously in the
background to handle requests. This document describes how
- to invoke <code>httpd</code>.</p>
+ to invoke <program>httpd</program>.</p>
</summary>
<seealso><a href="stopping.html">Stopping and Restarting</a></seealso>
-<seealso><a href="programs/httpd.html">httpd</a></seealso>
-<seealso><a href="programs/apachectl.html">apachectl</a></seealso>
+<seealso><program>httpd</program></seealso>
+<seealso><program>apachectl</program></seealso>
<section id="startup"><title>How Apache Starts</title>
run as a less privileged user. This is controlled by the selected
<a href="mpm.html">Multi-Processing Module</a>.</p>
- <p>The recommended method of invoking the <code>httpd</code>
- executable is to use the <a
- href="programs/apachectl.html">apachectl</a> control script. This
+ <p>The recommended method of invoking the <program>httpd</program>
+ executable is to use the <program>apachectl</program> control script. This
script sets certain environment variables that are necessary for
- <code>httpd</code> to function correctly under some operating
- systems, and then invokes the <code>httpd</code> binary.
- <code>apachectl</code> will pass through any command line
- arguments, so any <code>httpd</code> options may also be used with
- <code>apachectl</code>. You may also directly edit the
- <code>apachectl</code> script by changing the <code>HTTPD</code>
+ <program>httpd</program> to function correctly under some operating
+ systems, and then invokes the <program>httpd</program> binary.
+ <program>apachectl</program> will pass through any command line
+ arguments, so any <program>httpd</program> options may also be used with
+ <program>apachectl</program>. You may also directly edit the
+ <program>apachectl</program> script by changing the <code>HTTPD</code>
variable near the top to specify the correct location of the
- <code>httpd</code> binary and any command-line arguments that you
+ <program>httpd</program> binary and any command-line arguments that you
wish to be <em>always</em> present.</p>
<p>The first thing that <code>httpd</code> does when it is
<section id="boot"><title>Starting at Boot-Time</title>
<p>If you want your server to continue running after a system
- reboot, you should add a call to <code>apachectl</code> to your
+ reboot, you should add a call to <program>apachectl</program> to your
system startup files (typically <code>rc.local</code> or a file in
an <code>rc.N</code> directory). This will start Apache as
root. Before doing this ensure that your server is properly
configured for security and access restrictions.</p>
- <p>The <code>apachectl</code> script is designed to act like a
+ <p>The <program>apachectl</program> script is designed to act like a
standard SysV init script; it can take the arguments
<code>start</code>, <code>restart</code>, and <code>stop</code>
and translate them into the appropriate signals to
- <code>httpd</code>. So you can often simply link
- <code>apachectl</code> into the appropriate init directory. But be
+ <program>httpd</program>. So you can often simply link
+ <program>apachectl</program> into the appropriate init directory. But be
sure to check the exact requirements of your system.</p>
</section>
<section id="info"><title>Additional Information</title>
- <p>Additional information about the command-line options of <a
- href="programs/httpd.html">httpd</a> and <a
- href="programs/apachectl.html">apachectl</a> as well as other
- support programs included with the server is available on the
+ <p>Additional information about the command-line options of <program>
+ httpd</program> and <program>apachectl</program> as well as other support
+ programs included with the server is available on the
<a href="programs/">Server and Supporting Programs</a> page.
There is also documentation on all the <a
href="mod/">modules</a> included with the Apache distribution
the hostname and log it in place of the IP address. However,
this configuration is not recommended since it can
significantly slow the server. Instead, it is best to use a
- log post-processor such as <a
- href="programs/logresolve.html">logresolve</a> to determine
+ log post-processor such as <program>logresolve</program> to determine
the hostnames. The IP address reported here is not
necessarily the address of the machine at which the user is
sitting. If a proxy server exists between the user and the
<p>One important use of piped logs is to allow log rotation
without having to restart the server. The Apache HTTP Server
- includes a simple program called <a
- href="programs/rotatelogs.html">rotatelogs</a> for this
- purpose. For example, to rotate the logs every 24 hours, you
+ includes a simple program called <program>rotatelogs</program>
+ for this purpose. For example, to rotate the logs every 24 hours, you
can use:</p>
<example>
DNS lookup to complete before the request is finished. In
Apache 1.3 this setting defaults to <code>Off</code>. If you need
to have addresses in your log files resolved to hostnames, use the
- <a href="../programs/logresolve.html"><code>logresolve</code></a>
+ <program>logresolve</program>
program that comes with Apache, on one of the numerous log
reporting packages which are available.</p>
semaphore API allows for a denial of service attack by any
CGIs running under the same uid as the webserver
(<em>i.e.</em>, all CGIs, unless you use something like
- <code>suexec</code> or <code>cgiwrapper</code>). For these
+ <program>suexec</program> or <code>cgiwrapper</code>). For these
reasons this method is not used on any architecture except
IRIX (where the previous two are prohibitively expensive
on most IRIX boxes).</p>
</example>
<p>It is assumed that /, /usr, and /usr/local are only modifiable by
- root. When you install the httpd executable, you should ensure that
- it is similarly protected:</p>
+ root. When you install the <program>httpd</program> executable, you
+ should ensure that it is similarly protected:</p>
<example>
cp httpd /usr/local/apache/bin <br />
<p>If you allow non-root users to modify any files that root either
executes or writes on then you open your system to root compromises.
- For example, someone could replace the httpd binary so that the next
- time you start it, it will execute some arbitrary code. If the logs
- directory is writeable (by a non-root user), someone could replace
+ For example, someone could replace the <program>httpd</program> binary so
+ that the next time you start it, it will execute some arbitrary code. If
+ the logs directory is writeable (by a non-root user), someone could replace
a log file with a symlink to some other system file, and then root
might overwrite that file with arbitrary data. If the log files
themselves are writeable (by a non-root user), then someone may be
</contextlist>
<usage>
- <p>This directive sets the directory from which <code>httpd</code>
+ <p>This directive sets the directory from which <program>httpd</program>
will serve files. Unless matched by a directive like <directive
module="mod_alias">Alias</directive>, the server appends the
path from the requested URL to the document root to make the
<override>FileInfo</override>
<usage>
- <p>This directive controls whether the <code>httpd</code> may use
+ <p>This directive controls whether the <program>httpd</program> may use
memory-mapping if it needs to read the contents of a file during
delivery. By default, when the handling of a request requires
access to the data within a file -- for example, when delivering a
<ul>
<li>On some multiprocessor systems, memory-mapping can reduce the
- performance of the <code>httpd</code>.</li>
+ performance of the <program>httpd</program>.</li>
<li>With an NFS-mounted <directive module="core">DocumentRoot</directive>,
- the <code>httpd</code> may crash due to a segmentation fault if a file
- is deleted or truncated while the <code>httpd</code> has it
+ the <program>httpd</program> may crash due to a segmentation fault if a file
+ is deleted or truncated while the <program>httpd</program> has it
memory-mapped.</li>
</ul>
<compatibility>Available in version 2.0.44 and later</compatibility>
<usage>
- <p>This directive controls whether <code>httpd</code> may use the sendfile
- support from the kernel to transmit file contents to the client.
+ <p>This directive controls whether <program>httpd</program> may use the
+ sendfile support from the kernel to transmit file contents to the client.
By default, when the handling of a request requires no access
to the data within a file -- for example, when delivering a
static file -- Apache uses sendfile to deliver the file contents
don't have to suffer the extra latency that a lookup entails.
Heavily loaded sites should leave this directive
<code>Off</code>, since DNS lookups can take considerable
- amounts of time. The utility <a
- href="../programs/logresolve.html">logresolve</a>, compiled by default
- to the <code>bin</code> subdirectory of your installation directory, can
- be used to look up host names from logged IP addresses offline.</p>
+ amounts of time. The utility <program>logresolve</program>, compiled by
+ default to the <code>bin</code> subdirectory of your installation
+ directory, can be used to look up host names from logged IP addresses
+ offline.</p>
</usage>
</directivesynopsis>
<var>parameter-name</var> is <strong>not</strong> defined.</p>
<p>The <var>parameter-name</var> argument is a define as given on
- the <code>httpd</code> command line via <code>-D<var>parameter-</var>
+ the <program>httpd</program> command line via <code>-D<var>parameter-</var>
</code>, at the time the server was started.</p>
<p><directive type="section">IfDefine</directive> sections are
rather than a file, Apache will read all files in that directory
and any subdirectory. But including entire directories is not
recommended, because it is easy to accidentally leave temporary
- files in a directory that can cause <code>httpd</code> to
+ files in a directory that can cause <program>httpd</program> to
fail.</p>
<p>The file path specified may be an absolute path, or may be relative
</example>
</usage>
-<seealso><a href="../programs/apachectl.html">apachectl</a></seealso>
+<seealso><program>apachectl</program></seealso>
</directivesynopsis>
<directivesynopsis>
>http://deuce.doc.wustl.edu/doc/pspdfs/lf.pdf</a>.</p>
<p>To use the <module>leader</module> MPM, add
- <code>--with-mpm=leader</code> to the <code>configure</code> script's
- arguments when building the <code>httpd</code>.</p>
+ <code>--with-mpm=leader</code> to the <program>configure</program>
+ script's arguments when building the <program>httpd</program>.</p>
<p>This MPM depends on APR's atomic compare-and-swap operations for
thread synchronization. If you are compiling for an x86 target
and you don't need to support 386s, or you are compiling for a
SPARC and you don't need to run on pre-UltraSPARC chips, add
- <code>--enable-nonportable-atomics=yes</code> to the <code>configure</code>
- script's arguments. This will cause APR to implement atomic operations
+ <code>--enable-nonportable-atomics=yes</code> to the
+ <program>configure</program> script's arguments. This will cause
+ APR to implement atomic operations
using efficient opcodes not available in older CPUs.</p>
</summary>
URI(s) for this protection space.</p>
<p>Appropriate user (text) files can be created using the
- <a href="../programs/htdigest.html">htdigest</a> tool.</p>
+ <program>htdigest</program> tool.</p>
<example><title>Example:</title>
<Location /private/><br />
problem.</p>
<p>A perl script called
- <a href="../programs/dbmmanage.html">dbmmanage</a> is included with
+ <program>dbmmanage</program> is included with
Apache. This program can be used to create and update DBM
format password files for use with this module.</p>
</usage>
<seealso>
<directive module="mod_auth_digest">AuthDigestProvider</directive>
</seealso>
-<seealso><a href="../programs/htpasswd.html">htpasswd</a></seealso>
-<seealso><a href="../programs/htdigest.html">htdigest</a></seealso>
+<seealso><program>htpasswd</program></seealso>
+<seealso><program>htdigest</program></seealso>
<directivesynopsis>
<name>AuthUserFile</name>
ID is defined multiple times, <module>mod_authn_file</module> will
use the first occurrence to verify the password.</p>
- <p>The utility <a href="../programs/htpasswd.html">htpasswd</a>
+ <p>The utility <program>htpasswd</program>
which is installed as part of the binary distribution, or which
can be found in <code>src/support</code>, is used to maintain
the password file for <em>HTTP Basic Authentication</em>. See the
module="mod_authn_dbm">AuthDBMUserFile</directive> should be used
instead.</p>
- <p>If you are using <em>HTTP Digest Authentication</em>, the <a
- href="../programs/htpasswd.html">htpasswd</a> tool is not sufficient.
- You have to use <a href="../programs/htdigest.html">htdigest</a>
+ <p>If you are using <em>HTTP Digest Authentication</em>, the <program>
+ htpasswd</program> tool is not sufficient.
+ You have to use <program>htdigest</program>
instead. Note that you cannot mix user data for Digest Authentication
and Basic Authentication within the same file.</p>
<p>Once a connection has been made to a server, that
connection remains active for the life of the
- <code>httpd</code> process, or until the LDAP server goes
+ <program>httpd</program> process, or until the LDAP server goes
down.</p>
<p>If the LDAP server goes down and breaks an existing
<seealso><directive module="core">Options</directive></seealso>
<seealso><directive module="mod_alias">ScriptAlias</directive></seealso>
<seealso><directive module="mod_mime">AddHandler</directive></seealso>
-<seealso><a href="../suexec.html">Running CGI programs under different user IDs</a></seealso>
+<seealso><a href="../suexec.html">Running CGI programs under different
+ user IDs</a></seealso>
<seealso><a href="http://hoohoo.ncsa.uiuc.edu/cgi/">CGI Specification</a></seealso>
<section id="env"><title>CGI Environment variables</title>
</summary>
<seealso><module>mod_cgi</module></seealso>
-<seealso><a href="../suexec.html">Running CGI programs under different user IDs</a></seealso>
+<seealso><a href="../suexec.html">Running CGI programs under different
+ user IDs</a></seealso>
<directivesynopsis location="mod_cgi">
<name>ScriptLog</name>
<summary>
<p>This module allows for control of the environment that will
be provided to CGI scripts and SSI pages. Environment variables
- may be passed from the shell which invoked the httpd process.
- Alternatively, environment variables may be set or unset within
+ may be passed from the shell which invoked the <program>httpd</program>
+ process. Alternatively, environment variables may be set or unset within
the configuration process.</p>
</summary>
<seealso><a href="../env.html">Environment Variables</a></seealso>
<usage>
<p>Specifies one or more environment variables to pass to CGI
scripts and SSI pages from the environment of the shell which
- invoked the httpd process.</p>
+ invoked the <program>httpd</program> process.</p>
<example><title>Example</title>
PassEnv LD_LIBRARY_PATH
<ol>
<li>
- Run <code>configure</code> with <code>--enable-example</code>
+ Run <program>configure</program> with <code>--enable-example</code>
option.</li>
<li>Make the server (run "<code>make</code>").</li>
<p>To enable this module, LDAP support must be compiled into
apr-util. This is achieved by adding the <code>--with-ldap</code>
- flag to the <code>./configure</code> script when building
+ flag to the <program>configure</program> script when building
Apache.</p>
<p>SSL support requires that <module>mod_ldap</module> be linked
<p>By fetching the URL <code>http://servername/cache-info</code>,
the administrator can get a status report of every cache that is used
by <module>mod_ldap</module> cache. Note that if Apache does not
- support shared memory, then each <code>httpd</code> instance has its
+ support shared memory, then each <program>httpd</program> instance has its
own cache, so reloading the URL will result in different
- information each time, depending on which <code>httpd</code>
+ information each time, depending on which <program>httpd</program>
instance processes the request.</p>
</section>
</section>
<note type="warning"><title>Security:</title>
<p>If a program is used, then it will be run as the user who
- started httpd. This will be root if the server was started by root;
- be sure that the program is secure.</p>
+ started <program>httpd</program>. This will be root if the server was
+ started by root; be sure that the program is secure.</p>
</note>
<note type="warning"><title>Note</title>
<p>When entering a file path on non-Unix platforms, care should be taken
<note type="warning"><title>Security:</title>
<p>If a program is used, then it will be run as the user who
- started httpd. This will be root if the server was started by root;
- be sure that the program is secure or switches to a less privileged
- user.</p>
+ started <program>httpd</program>. This will be root if the server was
+ started by root; be sure that the program is secure or switches to a
+ less privileged user.</p>
</note>
<note><title>Note</title>
<code>mod_proxy.c</code> is part of the ``<code>httpd
-l</code>'' output. If yes, this functionality is
available to mod_rewrite. If not, then you first have to
- rebuild the ``<code>httpd</code>'' program with mod_proxy
+ rebuild the <program>httpd</program> program with mod_proxy
enabled.</p>
</li>
<summary>
- <p>This module, in combination with the <a
- href="../programs/suexec.html">suexec support program</a> allows
+ <p>This module, in combination with the <program>
+ suexec</program> support program allows
CGI scripts to run as a specified user and Group.</p>
</summary>
process requests one at a time. Each child can serve multiple
requests in its lifetime. For the purpose of this discussion,
the children don't share any data with each other. We'll refer
- to the children as httpd processes.</p>
+ to the children as <dfn>httpd processes</dfn>.</p>
<p>Your website has one or more machines under your
administrative control, together we'll call them a cluster of
<usage>
<p>The <directive type="section">IfVersion</directive> section encloses
- configuration directives which are executed only if the httpd version
+ configuration directives which are executed only if the
+ <program>httpd</program> version
matches the desired criteria. For normal (numeric) comparisons the
<var>version</var> argument has the format
<code><var>major</var>[.<var>minor</var>[.<var>patch</var>]]</code>, e.g.
<p>Special note: Use of this directive in <directive module="core"
type="section">VirtualHost</directive> is no longer supported. To
- configure your server for <a href="mod_suexec.html">suexec</a> use
+ configure your server for <program>suexec</program> use
<directive module="mod_suexec">SuexecUserGroup</directive>.</p>
<note><title>Note</title>
href="../misc/security_tips.html#serverroot">security</a>.</p>
<note><title>Note</title>
- <p>As of Apache 2 it is recommended to use only the <a
- href="../programs/apachectl.html">apachectl</a> script for
- (re-)starting or stopping the server.</p>
+ <p>As of Apache 2 it is recommended to use only the <program>
+ apachectl</program> script for (re-)starting or stopping the server.</p>
</note>
</usage>
</directivesynopsis>
<p>Special note: Use of this directive in <directive module="core"
type="section">VirtualHost</directive> is no longer supported. To
- configure your server for <a href="../suexec.html">suexec</a> use
+ configure your server for <program>suexec</program> use
<directive module="mod_suexec">SuexecUserGroup</directive>.</p>
<note><title>Note</title>
set the privileges of the Apache child processes. The child
processes must be able to read all the content that will be
served, but should have as few privileges beyond that as
- possible. In addition, unless <a
- href="../suexec.html">suexec</a> is used, these directives also
- set the privileges which will be inherited by CGI scripts.</p>
+ possible. In addition, unless <program>suexec</program> is used,
+ these directives also set the privileges which will be inherited
+ by CGI scripts.</p>
<p><directive module="mpm_common">MaxRequestsPerChild</directive>
controls how frequently the
the privileges of the Apache child processes. The child processes
must be able to read all the content that will be served, but
should have as few privileges beyond that as possible. In
- addition, unless <a href="../suexec.html">suexec</a> is used,
+ addition, unless <program>suexec</program> is used,
these directives also set the privileges which will be inherited
by CGI scripts.</p>
is chosen at configuration time and built into Apache.</p>
<p>To actually choose the desired MPM, use the argument
- --with-mpm= <em>NAME</em> with the ./configure script.
+ --with-mpm= <em>NAME</em> with the <program>configure</program> script.
<em>NAME</em> is the name of the desired MPM.</p>
<p>Once the server has been compiled, it is possible to
<dt>Caching</dt>
<dd><module>mod_cache</module>, <module>mod_disk_cache</module>, and
<module>mod_mem_cache</module> have undergone a lot of changes
- are now considered production-quality. <a
- href="programs/htcacheclean.html">htcacheclean</a> has been
- introduced to cleanup <module>mod_disk_cache</module> setups.</dd>
+ are now considered production-quality. <program>htcacheclean</program>
+ has been introduced to cleanup <module>mod_disk_cache</module>
+ setups.</dd>
<dt>Proxying</dt>
<dd>The new <module>mod_proxy_balancer</module> module provides
<dd>A new hook, <code>test_config</code> has been added to aid
modules that want to execute special code only when the user passes
- <code>-t</code> to httpd.</dd>
+ <code>-t</code> to <program>httpd</program>.</dd>
<dt>Set Threaded MPM's Stacksize</dt>
<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>.
+ abs (<program>ab</program> 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,
</example>
<p>You must type this command from the <em>top level</em>
- directory of the <code>httpd</code> source tree. Every
+ directory of the httpd 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>
you how many requests per second your Apache installation is capable of
serving.</p>
</summary>
-<seealso><a href="httpd.html">httpd</a></seealso>
+<seealso><program>httpd</program></seealso>
<section id="synopsis"><title>Synopsis</title>
<p><code><strong>ab</strong>
<p><code>apachectl</code> is a front end to the Apache HyperText
Transfer Protocol (HTTP) server. It is designed to help the
administrator control the functioning of the Apache
- <a href="httpd.html">httpd</a> daemon.</p>
+ <program>httpd</program> daemon.</p>
<p>The <code>apachectl</code> script can operate in two modes.
- First, it can act as a simple front-end to the <code>httpd</code>
+ First, it can act as a simple front-end to the <program>httpd</program>
command that simply sets any necessary environment variables and
- then invokes <code>httpd</code>, passing through any command line
+ then invokes <program>httpd</program>, passing through any command line
arguments. Second, <code>apachectl</code> can act as a SysV init
script, taking simple one-word arguments like <code>start</code>,
<code>restart</code>, and <code>stop</code>, and translating them
- into appropriate signals to <code>httpd</code>.</p>
+ into appropriate signals to <program>httpd</program>.</p>
<p>If your Apache installation uses non-standard paths, you will
need to edit the <code>apachectl</code> script to set the
- appropriate paths to the <code>httpd</code> binary. You can also
- specify any necessary <code>httpd</code> command line arguments.
+ appropriate paths to the <program>httpd</program> binary. You can also
+ specify any necessary <program>httpd</program> command line arguments.
See the comments in the script for details.</p>
<p>The <code>apachectl</code> script returns a 0 exit value on
<seealso><a href="../stopping.html">Stopping Apache</a></seealso>
<seealso><a href="../configuring.html">Configuration Files</a></seealso>
<seealso><a href="../platform/">Platform Docs</a></seealso>
-<seealso><a href="httpd.html">httpd</a></seealso>
+<seealso><program>httpd</program></seealso>
<section id="synopsis"><title>Synopsis</title>
<p>When acting in pass-through mode, <code>apachectl</code> can take
-all the arguments available for the <a href="httpd.html">httpd</a>
+all the arguments available for the <program>httpd</program>
binary.</p>
<p><code><strong>apachectl</strong> [ <var>httpd-argument</var> ]</code></p>
<section id="options"><title>Options</title>
<p>Only the SysV init-style options are defined here. Other arguments
-are defined on the <a href="httpd.html">httpd</a> manual page.</p>
+are defined on the <program>httpd</program> manual page.</p>
<dl>
<dt><code>start</code></dt>
-<dd>Start the Apache <code>httpd</code> daemon. Gives an error if it
+<dd>Start the Apache <program>httpd</program> daemon. Gives an error if it
is already running. This is equivalent to <code>apachectl -k
start</code>.</dd>
<dt><code>stop</code></dt>
-<dd>Stops the Apache <code>httpd</code> daemon. This is equivalent to
+<dd>Stops the Apache <program>httpd</program> daemon. This is equivalent to
<code>apachectl -k stop</code>.</dd>
<dt><code>restart</code></dt>
-<dd>Restarts the Apache <code>httpd</code> daemon. If the daemon is
+<dd>Restarts the Apache <program>httpd</program> daemon. If the daemon is
not running, it is started. This command automatically checks the
configuration files as in <code>configtest</code> before initiating
the restart to make sure the daemon doesn't die. This is equivalent
<dt><code>graceful</code></dt>
-<dd>Gracefully restarts the Apache <code>httpd</code> daemon. If the
+<dd>Gracefully restarts the Apache <program>httpd</program> daemon. If the
daemon is not running, it is started. This differs from a normal
restart in that currently open connections are not aborted. A side
effect is that old log files will not be closed immediately. This
directive from <module>mod_so</module>.</p>
<p>So to use this extension mechanism your platform has to support the DSO
- feature and your Apache <code>httpd</code> binary has to be built with the
+ feature and your Apache <program>httpd</program> binary has to be built with the
<module>mod_so</module> module. The <code>apxs</code> tool automatically
complains if this is not the case. You can check this yourself by manually
running the command</p>
<module>mod_so</module> or perhaps even read the
<code>src/modules/standard/mod_so.c</code> source file.</p>
</summary>
-<seealso><a href="apachectl.html">apachectl</a></seealso>
-<seealso><a href="httpd.html">httpd</a></seealso>
+<seealso><program>apachectl</program></seealso>
+<seealso><program>httpd</program></seealso>
<section id="synopsis"><title>Synopsis</title>
<p><code><strong>apxs</strong> -<strong>g</strong>
everything else is stored at sbindir. ==> clarify/change this -->
<dt><code>--bindir=<var>DIR</var></code></dt>
<dd>Install user executables in <var>DIR</var>. The user executables
- are supporting programs like <code>htpasswd</code>,
- <code>dbmmanage</code>, etc. which are useful for site
+ are supporting programs like <program>htpasswd</program>,
+ <program>dbmmanage</program>, etc. which are useful for site
administrators. By default <var>DIR</var> is set to
<code><var>EPREFIX</var>/bin</code>.</dd>
<dt><code>--sbindir=<var>DIR</var></code></dt>
<dd>Install the system administrator executables in <var>DIR</var>.
- Those are server programs like <code>httpd</code>,
- <code>apachectl</code>, <code>suexec</code>, etc. which are neccessary
- to run the Apache HTTP Server. By default <code>sbindir</code> is
- set to <code><var>EPREFIX</var>/sbin</code>.</dd>
+ Those are server programs like <program>httpd</program>,
+ <program>apachectl</program>, <program>suexec</program>, etc. which
+ are neccessary to run the Apache HTTP Server. By default
+ <code>sbindir</code> is set to
+ <code><var>EPREFIX</var>/sbin</code>.</dd>
<dt><code>--sharedstatedir=<var>DIR</var></code></dt>
<dd>Install modifiable architecture-independent data in <var>DIR</var>.
vendor's documentation.</p>
<note><title>Note</title>
If you want to build a DSO module instead of a statically linked
- use <a href="apxs.html">apxs</a>.</note>
+ use <program>apxs</program>.</note>
</dd>
<dt><code>--with-mpm=MPM</code></dt>
<dt><code>--enable-modules=<var>MODULE-LIST</var></code></dt>
<dd>This option behaves similar to <code>--enable-mods-shared</code>,
but will link the given modules statically. This mean, these modules
- will always be present while running <code>httpd</code>. They need
+ will always be present while running <program>httpd</program>. They need
not be loaded with <directive
module="mod_so">LoadModule</directive>.</dd>
<dd>Allow IPv6 sockets to handle IPv4 connections.</dd>
<dt><code>--with-port=<var>PORT</var></code></dt>
- <dd>This defines the port on which <code>httpd</code> will listen. This
- port number is used when generating the configuration file
+ <dd>This defines the port on which <program>httpd</program> will listen.
+ This port number is used when generating the configuration file
<code>httpd.conf</code>. The default is 80.</dd>
<dt><code>--with-program-name</code></dt>
<section id="packageopt"><title>Specific packages</title>
<dl>
<dt><code>--with-apr=<var>DIR</var>|<var>FILE</var></code></dt>
- <dd>The Apache Portable Runtime (APR) is part of the <code>httpd</code>
+ <dd>The Apache Portable Runtime (APR) is part of the httpd
source distribution and will automatically be build together with the
HTTP server. If you want to use an already installed APR instead you
have to tell <code>configure</code> the path to the
<dt><code>--with-apr-util=<var>DIR</var>|<var>FILE</var></code></dt>
<dd>The Apache Portable Runtime Utilities (APU) are part of the
- <code>httpd</code> source distribution and will automatically be build
+ httpd source distribution and will automatically be build
together with the HTTP server. If you want to use an already installed
APU instead you have to tell <code>configure</code> the path to the
<code>apu-config</code> script. You may set the absolute path and name
dynamically by default.</dd>
<dt><code>--enable-suexec</code></dt>
- <dd>Use this option to enable <code><a
- href="suexec.html">suexec</a></code>, which allows you to set
+ <dd>Use this option to enable <program>
+ suexec</program>, which allows you to set
uid and gid for spawned processes. <strong>Do not use this
option unless you understand all the security implications of
running a suid binary on your server.</strong> Further options
- to configure <
code>suexec</code> are described <a
+ to configure <
program>suexec</program> are described <a
href="#suexec">below</a>.</dd> </dl>
<p>It is possible to create a statically linked binary of a single
<dl>
<dt><code>--enable-static-ab</code></dt>
- <dd>Build a statically linked version of <code><a
- href="ab.html">ab</a></code>.</dd>
+ <dd>Build a statically linked version of <program>
+ ab</program>.</dd>
<!-- missing documentation for chechgid -->
<dt><code>--enable-static-checkgid</code></dt>
<dd>Build a statically linked version of <code>htdbm</code>.</dd>
<dt><code>--enable-static-htdigest</code></dt>
- <dd>Build a statically linked version of <code><a
- href="htdigest.html">htdigest</a></code>.</dd>
+ <dd>Build a statically linked version of <program>
+ htdigest</program>.</dd>
<dt><code>--enable-static-htpasswd</code></dt>
- <dd>Build a statically linked version of <code><a
- href="htpasswd.html">htpasswd</a></code>.</dd>
+ <dd>Build a statically linked version of <program>
+ htpasswd</program>.</dd>
<dt><code>--enable-static-logresolve</code></dt>
- <dd>Build a statically linked version of <code><a
- href="logresolve.html">logresolve</a></code>.</dd>
+ <dd>Build a statically linked version of <program>
+ logresolve</program>.</dd>
<dt><code>--enable-static-rotatelogs</code></dt>
- <dd>Build a statically linked version of <code><a
- href="rotatelogs.html">rotatelogs</a></code>.</dd>
+ <dd>Build a statically linked version of <program>
+ rotatelogs</program>.</dd>
</dl>
<section id="suexec"><title>suexec configuration options</title>
- <p>The following options are used to fine tune the behavior of <code><a
-
href="suexec.html">suexec</a></code>. See <a
+ <p>The following options are used to fine tune the behavior of <program>
+
suexec</program>. See <a
href="suexec.html#install">Configuring and installing suEXEC</a>
for further information.</p>
<dt><code>--with-suexec-bin</code></dt>
<dd>This defines the path to suexec binary. Default is
<code>--sbindir</code> (see <a href="directoryfinetuning">Fine
- tuning of installation directories</a>).</dd>
+ tuning of installation directories</a>).</dd>
<dt><code>--with-suexec-caller</code></dt>
- <dd>This defines the user allowed to call <code>suexec</code>. It should
- be the same as the user under which <code>httpd</code> normally
- runs.</dd>
+ <dd>This defines the user allowed to call <program>suexec</program>.
+ It should be the same as the user under which <program>httpd</program>
+ normally runs.</dd>
<dt><code>--with-suexec-docroot</code></dt>
- <dd>This defines the directory tree under which <code>suexec</code>
- access is allowed for executables. Default value is
+ <dd>This defines the directory tree under which <program>
+ suexec</program> access is allowed for executables. Default value is
<code>--datadir/htdocs</code>.</dd>
<dt><code>--with-suexec-gidmin</code></dt>
<dd>Define this as the lowest GID allowed to be a target user for
- <code>suexec</code>. The default value is 100.</dd>
+ <program>suexec</program>. The default value is 100.</dd>
<dt><code>--with-suexec-logfile</code></dt>
- <dd>This defines the filename of the <code>suexec</code> logfile. By
- default the logfile is named <code>suexec_log</code> and located in
+ <dd>This defines the filename of the <program>suexec</program> logfile.
+ By default the logfile is named <code>suexec_log</code> and located in
<code>--logfiledir</code>.</dd>
<dt><code>--with-suexec-safepath</code></dt>
<dd>Define the value of the environment variable <code>PATH</code> to
- be set for processes started by <code>suexec</code>. Default value is
- <code>/usr/local/bin:/usr/bin:/bin</code>.</dd>
+ be set for processes started by <program>suexec</program>. Default
+ value is <code>/usr/local/bin:/usr/bin:/bin</code>.</dd>
<dt><code>--with-suexec-userdir</code></dt>
<dd>This defines the subdirectory under the user's directory that
- contains all executables for which <code>suexec</code> access is
- allowed. This setting is necessary when you want to use
- <code>suexec</code> together with user-specific directories (as
+ contains all executables for which <program>suexec</program> access
+ is allowed. This setting is necessary when you want to use
+ <program>suexec</program> together with user-specific directories (as
provided by <module>mod_userdir</module>). The default is
<code>public_html</code>.</dd>
<dt><code>--with-suexec-uidmin</code></dt>
<dd>Define this as the lowest UID allowed to be a target user for
- <code>suexec</code>. The default value is 100.</dd>
+ <program>suexec</program>. The default value is 100.</dd>
<dt><code>--with-suexec-umask</code></dt>
- <dd>Set <code>umask</code> for processes started by <code>suexec</code>.
- It defaults to your system settings.</dd>
+ <dd>Set <code>umask</code> for processes started by
+ <program>suexec</program>. It defaults to your system settings.</dd>
</dl>
</section>
</section>
Resources available from the Apache HTTP server can be restricted to just
the users listed in the files created by <code>dbmmanage</code>. This
program can only be used when the usernames are stored in a DBM file. To
- use a flat-file database see <a href="htpasswd.html">htpasswd</a>.</p>
+ use a flat-file database see <program>htpasswd</program>.</p>
<p>This manual page only lists the command line arguments. For details of
the directives necessary to configure user authentication in
- <a href="httpd.html">httpd</a> see the httpd manual, which is part of
+ <program>httpd</program> see the httpd manual, which is part of
the Apache distribution or can be found at <a
href="http://httpd.apache.org/">http://httpd.apache.org/</a>.</p>
</summary>
-<seealso><a href="httpd.html">httpd</a></seealso>
+<seealso><program>httpd</program></seealso>
<seealso><module>mod_authn_dbm</module></seealso>
<seealso><module>mod_authz_dbm</module></seealso>
<p>This manual page only lists the command line arguments. For details of
the directives necessary to configure digest authentication in
- <a href="httpd.html">httpd</a> see the Apache manual, which is part
+ <program>httpd</program> see the Apache manual, which is part
of the Apache distribution or can be found at
<a href="http://httpd.apache.org/">http://httpd.apache.org/</a>.</p>
</summary>
-<seealso><a href="httpd.html">httpd</a></seealso>
+<seealso><program>httpd</program></seealso>
<seealso><module>mod_auth_digest</module></seealso>
<section id="synopsis"><title>Synopsis</title>
just the users listed in the files created by <code>htpasswd</code>. This
program can only manage usernames and passwords stored in a flat-file. It
can encrypt and display password information for use in other types of data
- stores, though. To use a DBM database see <a
- href="dbmmanage.html">dbmmanage</a>.</p>
+ stores, though. To use a DBM database see <program>dbmmanage</program>.</p>
<p><code>htpasswd</code> encrypts passwords using either a version of MD5
modified for Apache, or the system's <code>crypt()</code> routine. Files
<p>This manual page only lists the command line arguments. For details of
the directives necessary to configure user authentication in
- <a href="httpd.html">httpd</a> see the Apache manual, which is part of the
+ <program>httpd</program> see the Apache manual, which is part of the
Apache distribution or can be found at <a href="http://httpd.apache.org"
>http://httpd.apache.org/</a>.</p>
</summary>
-<seealso><a href="httpd.html">httpd</a></seealso>
+<seealso><program>httpd</program></seealso>
<seealso>The scripts in support/SHA1 which come with the
distribution.</seealso>
<dd>Use <code>crypt()</code> encryption for passwords. The default on all
platforms but Windows, Netware and TPF. Though possibly supported by
<code>htpasswd</code> on all platforms, it is not supported by the
- <a href="httpd.html">httpd</a> server on Windows, Netware and TPF.</dd>
+ <program>httpd</program> server on Windows, Netware and TPF.</dd>
<dt><code>-s</code></dt>
<dd>Use SHA encryption for passwords. Facilitates migration from/to Netscape
<dt><code>-p</code></dt>
<dd>Use plaintext passwords. Though <code>htpasswd</code> will support
- creation on all platforms, the <a href="httpd.html">httpd</a> daemon will
+ creation on all platforms, the <program>httpd</program> daemon will
only accept plain text passwords on Windows, Netware and TPF.</dd>
<dt><code>-D</code></dt>
child processes or threads to handle requests.</p>
<p>In general, <code>httpd</code> should not be invoked directly,
- but rather should be invoked via <a
-
href="apachectl.html">apachectl</a> on Unix-based systems or <a
+ but rather should be invoked via <program>
+
apachectl</program> on Unix-based systems or <a
href="../platform/windows.html#winsvc">as a service on Windows NT,
2000 and XP</a> and <a href="../platform/windows.html#wincons">as
a console application on Windows 9x and ME</a>.</p>
<seealso><a href="../stopping.html">Stopping Apache</a></seealso>
<seealso><a href="../configuring.html">Configuration Files</a></seealso>
<seealso><a href="../platform/">Platform-specific Documentation</a></seealso>
-<seealso><a href="apachectl.html">apachectl</a></seealso>
+<seealso><program>apachectl</program></seealso>
<section id="synopsis"><title>Synopsis</title>
<p><code><strong>httpd</strong> [ -<strong>d</strong>
<section id="index"><title>Index</title>
<dl>
- <dt><a href="httpd.html">httpd</a></dt>
+ <dt><program>httpd</program></dt>
<dd>Apache hypertext transfer protocol server</dd>
- <dt><a href="apachectl.html">apachectl</a></dt>
+ <dt><program>apachectl</program></dt>
<dd>Apache HTTP server control interface</dd>
- <dt><a href="ab.html">ab</a></dt>
+ <dt><program>ab</program></dt>
<dd>Apache HTTP server benchmarking tool</dd>
- <dt><a href="apxs.html">apxs</a></dt>
+ <dt><program>apxs</program></dt>
<dd>APache eXtenSion tool</dd>
- <dt><a href="configure.html">configure</a></dt>
+ <dt><program>configure</program></dt>
<dd>Configure the source tree</dd>
- <dt><a href="dbmmanage.html">dbmmanage</a></dt>
+ <dt><program>dbmmanage</program></dt>
<dd>Create and update user authentication files in DBM format
for basic authentication</dd>
- <dt><a href="htcacheclean.html">htcacheclean</a></dt>
+ <dt><program>htcacheclean</program></dt>
<dd>Clean up the disk cache</dd>
- <dt><a href="htdigest.html">htdigest</a></dt>
+ <dt><program>htdigest</program></dt>
<dd>Create and update user authentication files for digest
authentication</dd>
- <dt><a href="htpasswd.html">htpasswd</a></dt>
+ <dt><program>htpasswd</program></dt>
<dd>Create and update user authentication files for basic
authentication</dd>
- <dt><a href="logresolve.html">logresolve</a></dt>
+ <dt><program>logresolve</program></dt>
<dd>Resolve hostnames for IP-addresses in Apache
logfiles</dd>
- <dt><a href="rotatelogs.html">rotatelogs</a></dt>
+ <dt><program>rotatelogs</program></dt>
<dd>Rotate Apache logs without having to kill the server</dd>
- <dt><a href="suexec.html">suexec</a></dt>
+ <dt><program>suexec</program></dt>
<dd>Switch User For Exec</dd>
<p>The <directive type="section" module="core">IfDefine</directive> directive
encloses directives that will only be applied if an appropriate
-parameter is defined on the <code>httpd</code> command line. For example,
+parameter is defined on the <program>httpd</program> command line. For example,
with the following configuration, all requests will be redirected
to another site only if the server is started using
<code>httpd -DClosedForNow</code>:</p>
<section id="refused"><title>Why do I get ``Connection Refused'' messages when trying to access my freshly
installed Apache+mod_ssl server via HTTPS?</title>
<p>There can be various reasons. Some of the common mistakes is that people
- start Apache with just ``<code>apachectl start</code>'' (or
- ``<code>httpd</code>'') instead of ``<code>apachectl startssl</code>'' (or
- ``<code>httpd -DSSL</code>''. Or you're configuration is not correct. At
+ start Apache with just <code>apachectl start</code> (or
+ <program>httpd</program>) instead of <code>apachectl startssl</code> (or
+ <code>httpd -DSSL</code>. Or you're configuration is not correct. At
least make sure that your <directive module="mpm_common">Listen</directive>
directives match your <directive type="section" module="core">VirtualHost</directive>
directives. And if all fails, please do yourself a favor and start over with the
<dl>
<dt>Apache and OpenSSL version information</dt>
<dd>The Apache version can be determined
- by running ``<code>httpd -v</code>''. The OpenSSL version can be
- determined by running ``<code>openssl version</code>''. Alternatively when
- you have Lynx installed you can run the command ``<code>lynx -mime_header
- http://localhost/ | grep Server</code>'' to determine all information in a
+ by running <code>httpd -v</code>. The OpenSSL version can be
+ determined by running <code>openssl version</code>. Alternatively when
+ you have Lynx installed you can run the command <code>lynx -mime_header
+ http://localhost/ | grep Server</code> to determine all information in a
single step.
</dd>
<dt>The details on how you built and installed Apache+mod_ssl+OpenSSL</dt>
<dd>For this you can provide a logfile of your terminal session which shows
the configuration and install steps. Alternatively you can at least
- provide the <code>configure</code> command line you used.
+ provide the <program>configure</program> command line you used.
</dd>
<dt>In case of core dumps please include a Backtrace</dt>
most "current" kernels do not allow a process to dump core after it has
done a <code>setuid()</code> (unless it does an <code>exec()</code>) for
security reasons (there can be privileged information left over in
- memory). Additionally you can run ``<code>/path/to/httpd -X</code>''
+ memory). Additionally you can run <code>/path/to/httpd -X</code>
manually to force Apache to not fork.
</li>
Apache on those platforms.</p>
</summary>
-<seealso><a href="programs/httpd.html">httpd</a></seealso>
-<seealso><a href="programs/apachectl.html">apachectl</a></seealso>
+<seealso><program>httpd</program></seealso>
+<seealso><program>apachectl</program></seealso>
<section id="introduction"><title>Introduction</title>
<p>In order to stop or restart Apache, you must send a signal to
- the running <code>httpd</code> processes. There are two ways to
+ the running <program>httpd</program> processes. There are two ways to
send the signals. First, you can use the unix <code>kill</code>
command to directly send signals to the processes. You will
- notice many <code>httpd</code> executables running on your system,
+ notice many <program>httpd</program> executables running on your system,
but you should not send signals to any of them except the parent,
whose pid is in the <directive
module="mpm_common">PidFile</directive>. That is to say you
<example>kill -TERM `cat /usr/local/apache2/logs/httpd.pid`</example>
- <p>The second method of signaling the <code>httpd</code> processes
+ <p>The second method of signaling the <program>httpd</program> processes
is to use the <code>-k</code> command line options: <code>stop</code>,
<code>restart</code>, and <code>graceful</code>,
- as described below. These are arguments to the <a
- href="programs/httpd.html">httpd</a> binary, but we recommend that
- you send them using the <a
- href="programs/apachectl.html">apachectl</a> control script, which
- will pass them through to <code>httpd</code>.</p>
+ as described below. These are arguments to the <program>
+ httpd</program> binary, but we recommend that
+ you send them using the <program>apachectl</program> control script, which
+ will pass them through to <program>httpd</program>.</p>
- <p>After you have signaled <code>httpd</code>, you can read about
+ <p>After you have signaled <program>httpd</program>, you can read about
its progress by issuing:</p>
<example>tail -f /usr/local/apache2/logs/error_log</example>
attempt to restart the server -- it will not be able to bind to
its listening ports. Before doing a restart, you can check the
syntax of the configuration files with the <code>-t</code>
- command line argument (see <a
- href="programs/httpd.html">httpd</a>). This still will not
+ command line argument (see <program>httpd</program>). This still will not
guarantee that the server will restart correctly. To check the
semantics of the configuration files as well as the syntax, you
- can try starting <code>httpd</code> as a non-root user. If there are no
- errors it will attempt to open its sockets and logs and fail
- because it's not root (or because the currently running <code>httpd</code>
- already has those ports bound). If it fails for any other
- reason then it's probably a config file error and the error
+ can try starting <program>httpd</program> as a non-root user. If there
+ are no errors it will attempt to open its sockets and logs and fail
+ because it's not root (or because the currently running
+ <program>httpd</program> already has those ports bound). If it fails
+ for any other reason then it's probably a config file error and the error
should be fixed before issuing the graceful restart.</note>
</section>
<p><strong>Setting paranoid permissions</strong><br />
Although the suEXEC wrapper will check to ensure that its
caller is the correct user as specified with the
- <code>--with-suexec-caller</code> configure option, there is
+ <code>--with-suexec-caller</code> <program>configure</program>
+ option, there is
always the possibility that a system or library call suEXEC uses
before this check may be exploitable on your system. To counter
this, and because it is best-practise in general, you should use
Group webgroup<br />
</example>
- <p>and <code>suexec</code> is installed at
+ <p>and <program>suexec</program> is installed at
"/usr/local/apache2/sbin/suexec", you should run:</p>
<example>
suEXEC</title>
<p>Upon startup of Apache, it looks for the file
- <code>suexec</code> in the directory defined by the
+ <program>suexec</program> in the directory defined by the
<code>--sbindir</code> option (default is
"/usr/local/apache/sbin/suexec"). If Apache finds a properly
configured suEXEC wrapper, it will print the following message
to the error log:</p>
<example>
- [notice] suEXEC mechanism enabled (wrapper: <em>/path/to/suexec</em>)
+ [notice] suEXEC mechanism enabled (wrapper: <var>/path/to/suexec</var>)
</example>
<p>If you don't see this message at server startup, the server is
restart Apache. Restarting it with a simple HUP or USR1 signal
will not be enough. </p>
<p>If you want to disable suEXEC you should kill and restart
- Apache after you have removed the <code>suexec</code> file. </p>
+ Apache after you have removed the <program>suexec</program> file.</p>
</section>
<section id="usage"><title>Using suEXEC</title>
vhost definition.</p>
<p>If the main_server has no <code>ServerName</code> at this
- point, then the hostname of the machine that httpd is running
- on is used instead. We will call the <em>main_server address
+ point, then the hostname of the machine that <program>httpd</program>
+ is running on is used instead. We will call the <em>main_server address
set</em> those IP addresses returned by a DNS lookup on the
<code>ServerName</code> of the main_server.</p>
<p>This command will dump out a description of how Apache parsed
the configuration file. Careful examination of the IP addresses and
- server names may help uncover configuration mistakes. (See <a
- href="../programs/httpd.html">the docs for the httpd program</a> for
+ server names may help uncover configuration mistakes. (See
+ the docs for the <program>httpd</program> program for
other command line options)</p>
</section>
<section id="howto"><title>How to set up Apache</title>
<p>There are two ways of configuring apache to support multiple
- hosts. Either by running a separate httpd daemon for each
- hostname, or by running a single daemon which supports all the
+ hosts. Either by running a separate <program>httpd</program> daemon for
+ each hostname, or by running a single daemon which supports all the
virtual hosts.</p>
<p>Use multiple daemons when:</p>
address, or to specific addresses. So if you have a need to
listen to a specific address for whatever reason, then you
will need to listen to all specific addresses. (Although one
- httpd could listen to N-1 of the addresses, and another could
+ <program>httpd</program> could listen to N-1 of the addresses, and another could
listen to the remaining address.)</li>
</ul>
<section id="multiple"><title>Setting up multiple daemons</title>
- <p>Create a separate httpd installation for each virtual host. For
- each installation, use the <directive
+ <p>Create a separate <program>httpd</program> installation for each
+ virtual host. For each installation, use the <directive
module="mpm_common">Listen</directive> directive in the
configuration file to select which IP address (or virtual host)
that daemon services. e.g.</p>
<section id="single"><title>Setting up a single daemon
with virtual hosts</title>
- <p>For this case, a single httpd will service requests for the
- main server and all the virtual hosts. The <directive
+ <p>For this case, a single <program>httpd</program> will service
+ requests for the main server and all the virtual hosts. The <directive
module="core">VirtualHost</directive> directive
in the configuration file is used to set the values of <directive
module="core">ServerAdmin</directive>, <directive
projects / apache / commitdiff