An XML version of the httpd man page is attached.

As far as format, I've stuck fairly close to true "man page" format, but
I've changed a couple things (like moving the synopsis into the
<summary>).  I've deliberately not used any new xml tags -- just the ones
we already have defined.  If we want to add a couple more symantically
accurate tags in the future, we could consider that.

I have also done a quick job of bringing things up-to-date by scanning
through main.c looking for undocumented arguments.

Comments welcome.  I'll nuke the nroff version at the same time that I
commit this.

Joshua.
<?xml version='1.0' encoding='UTF-8' ?>
<!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
<manualpage>
<relativepath href=".."/>

  <title>httpd - Apache Hypertext Transfer Protocol Server</title>

<summary>
     <p><code>httpd</code> is the Apache HyperText Transfer Protocol
     (HTTP) server program.  It is designed to be run as a standalone
     daemon process. When used like this it will create a pool of
     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 systems or as an NT
     service under win32.</p>
</summary>

<seealso><a href="../invoking.html">Starting Apache</a></seealso>
<seealso><a href="../stopping.html">Stopping Apache</a></seealso>
<seealso><a href="../configuring.html">Configuration Files</a></seealso>
<seealso><a href="../platform/windows.html">Windows Platform</a></seealso>
<seealso><a href="apachectl.html">apachectl</a></seealso>

<section id="synopsis"><title>Synopsis</title>

     <p><strong>httpd </strong>[ -<strong>d </strong><var>serverroot
     </var>] [ -<strong>f </strong><var>config </var>] [ -<strong>C
     </strong> <var>directive </var>] [ -<strong>c </strong>
     <var>directive</var>] [ -<strong>D </strong> <var>parameter
     </var>] [ -<strong>e </strong> <var>level</var> ] [ -<strong>E
     </strong> <var>file</var> ] [ <strong>-k </strong>
     <code>start|restart|graceful|stop</code> ] [ -<strong>R </strong>
     <var>directory</var> ] [ -<strong>h </strong>] [ -<strong>l
     </strong>] [ -<strong>L </strong>] [-<strong>S</strong>] [
     -<strong>t </strong>] [ -<strong>v </strong>] [ -<strong>V
     </strong>] [ -<strong>X </strong>]</p>

     <p>On <a href="../platform/windows.html">Win32 systems</a>, the
     following additional arguments are available:</p>

     <p><strong>httpd </strong>
     [ -<strong>k </strong> <code>install|config|uninstall</code> ]
     [ -<strong>n </strong> <var>name</var> ] [ -<strong>w</strong> ]</p>

</section>

<section id="options"><title>Options</title>

<dl>
<dt>-d <var>serverroot</var></dt>

<dd>Set the initial value for the <directive
module="core">ServerRoot</directive> directive to
<var>serverroot</var>.  This can be overridden by the ServerRoot
directive in the configuration file. The default is
<code>/usr/local/apache2</code>.</dd>

<dt>-f <var>config</var></dt>

<dd>Uses the directives in the file <var>config</var> on startup. If
<var>config</var> does not begin with a /, then it is taken to be a
path relative to the <directive
module="core">ServerRoot</directive>. The default is
<code>conf/httpd.conf</code>.</dd>

<dt>-k <code>start|restart|graceful|stop</code></dt>

<dd>Signals <code>httpd</code> to start, restart, or stop.  See <a
href="../stopping.html">Stopping Apache</a> for more information.</dd>

<dt>-C <var>directive</var></dt>

<dd>Process the configuration <var>directive</var> before reading
config files.</dd>

<dt>-c <var>directive</var></dt>

<dd>Process the configuration <var>directive</var> after reading config
files.</dd>


<dt>-D <var>parameter</var></dt>

<dd>Sets a configuration <var>parameter </var>which can be used with
<directive type="section" module="core">IfDefine</directive> sections
in the configuration files to conditionally skip or process
commands at server startup and restart.</dd>

<dt>-e <var>level</var></dt>

<dd>Sets the <directive module="core">LogLevel</directive> to
<var>level</var> during server startup.  This is useful for
temporarily increasing the verbosity of the error messages to find
problems during startup.</dd>

<dt>-E <var>file</var></dt>

<dd>Send error messages during server startup to <var>file</var>.</dd>

<dt>-R <var>directory</var></dt>

<dd>When the server is compiled using the <code>SHARED_CORE</code>
rule, this specifies the <var>directory</var> for the shared
object files.</dd>

<dt>-h</dt>

<dd>Output a short summary of available command line options.</dd>

<dt>-l</dt>

<dd>Output a list of modules compiled into the server.  This will
<strong>not</strong> list dynamically loaded modules included using
the <directive module="mod_so">LoadModule</directive> directive.</dd>

<dt>-L</dt>

<dd>Output a list of directives together with expected arguments and
places where the directive is valid.</dd>

<dt>-S</dt>

<dd>Show the settings as parsed from the config file (currently only
shows the virtualhost settings).</dd>

<dt>-t</dt>

<dd>Run syntax tests for configuration files only.  The program
immediately exits after these syntax parsing with either a return code
of 0 (Syntax OK) or return code not equal to 0 (Syntax Error).  If -D
<var>DUMP</var>_<var>VHOSTS </var>is also set, details of the virtual host
configuration will be printed.</dd>

<dt>-v</dt>

<dd>Print the version of <code>httpd</code>, and then exit.</dd>

<dt>-V</dt>

<dd>Print the version and build parameters of <code>httpd</code>, and
then exit.</dd>

<dt>-X</dt>

<dd>Run httpd in debug mode.  Only one worker will be started and the
server will not detach from the console.</dd>

</dl>

<p>The following arguments are available only on the <a
href="../platform/windows.html">win32 platform</a>:</p>

<dl>

<dt>-k <code>install|config|uninstall</code></dt>

<dd>Install Apache as a Windows NT service; change startup options for
the Apache service; and uninstall the Apache service.</dd>

<dt>-n <var>name</var></dt>

<dd>The <var>name</var> of the Apache service to signal.</dd>

<dt>-w</dt>

<dd>Hold the console window open on error so that the error message can 
be read.</dd>

</dl>

</section>

</manualpage>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to