]> granicus.if.org Git - apache/commitdiff
apachectl nroff->xml with a few content updates to document
authorJoshua Slive <slive@apache.org>
Thu, 14 Nov 2002 17:24:33 +0000 (17:24 +0000)
committerJoshua Slive <slive@apache.org>
Thu, 14 Nov 2002 17:24:33 +0000 (17:24 +0000)
the new pass-through mode.

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@97519 13f79535-47bb-0310-9956-ffa450edef68

docs/man/apachectl.8 [deleted file]
docs/manual/programs/apachectl.html [deleted file]
docs/manual/programs/apachectl.html.en [new file with mode: 0644]
docs/manual/programs/apachectl.xml [new file with mode: 0644]

diff --git a/docs/man/apachectl.8 b/docs/man/apachectl.8
deleted file mode 100644 (file)
index b40b698..0000000
+++ /dev/null
@@ -1,135 +0,0 @@
-.TH apachectl 1 "September 1997"
-.\" The Apache Software License, Version 1.1
-.\"
-.\" Copyright (c) 2000-2002 The Apache Software Foundation.  All rights
-.\" reserved.
-.\"
-.\" Redistribution and use in source and binary forms, with or without
-.\" modification, are permitted provided that the following conditions
-.\" are met:
-.\"
-.\" 1. Redistributions of source code must retain the above copyright
-.\"    notice, this list of conditions and the following disclaimer.
-.\"
-.\" 2. Redistributions in binary form must reproduce the above copyright
-.\"    notice, this list of conditions and the following disclaimer in
-.\"    the documentation and/or other materials provided with the
-.\"    distribution.
-.\"
-.\" 3. The end-user documentation included with the redistribution,
-.\"    if any, must include the following acknowledgment:
-.\"       "This product includes software developed by the
-.\"        Apache Software Foundation (http://www.apache.org/)."
-.\"    Alternately, this acknowledgment may appear in the software itself,
-.\"    if and wherever such third-party acknowledgments normally appear.
-.\"
-.\" 4. The names "Apache" and "Apache Software Foundation" must
-.\"    not be used to endorse or promote products derived from this
-.\"    software without prior written permission. For written
-.\"    permission, please contact apache@apache.org.
-.\"
-.\" 5. Products derived from this software may not be called "Apache",
-.\"    nor may "Apache" appear in their name, without prior written
-.\"    permission of the Apache Software Foundation.
-.\"
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
-.\" WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
-.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-.\" DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
-.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-.\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
-.\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-.\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
-.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-.\" SUCH DAMAGE.
-.\"
-.\" This software consists of voluntary contributions made by many
-.\" individuals on behalf of the Apache Software Foundation.  For more
-.\" information on the Apache Software Foundation, please see
-.\" <http://www.apache.org/>.
-.\"
-.SH NAME
-apachectl \- Apache HTTP server control interface
-.SH SYNOPSIS
-.B apachectl 
-\fIcommand\fP [...]
-.SH DESCRIPTION
-.B apachectl
-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 
-.B httpd
-daemon.  
-.PP
-.B NOTE: 
-If your Apache installation uses non-standard paths, you will need to 
-edit the 
-.B apachectl
-script to set the appropriate paths to your PID file and your 
-.B httpd
-binary.  See the comments in the script for details.
-.PP
-The 
-.B apachectl
-script returns a 0 exit value on success, and >0 if an error 
-occurs.  For more details, view the comments in the script.
-.PP
-Full documentation for Apache is available at 
-.B http://httpd.apache.org/
-.
-.SH OPTIONS
-The \fIcommand\fP can be any one or more of the following options:
-.TP 12
-.BI start
-Start the Apache daemon.  Gives an error if it is already running.
-.TP
-.BI stop
-Stops the Apache daemon.
-.TP
-.BI restart
-Restarts the Apache daemon by sending it a SIGHUP.  If the daemon
-is not running, it is started.
-This command automatically checks the configuration files via 
-.BI configtest
-before initiating the restart to make sure Apache doesn't die.
-.TP
-.BI fullstatus
-Displays a full status report from 
-.B mod_status. 
-For this to work, you need to have mod_status enabled on your server 
-and a text-based browser such as \fIlynx\fP available on your system.  The
-URL used to access the status report can be set by editing the
-.B STATUSURL
-variable in the script.
-.TP
-.BI status
-Displays a brief status report.  Similar to the fullstatus option,
-except that the list of requests currently being served is omitted.
-.TP
-.BI graceful
-Gracefully restarts the Apache daemon by sending it a SIGUSR1.  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 means that if used in a log rotation script, a substantial delay may be
-necessary to ensure that the old log files are closed before processing them.
-This command automatically checks the configuration files via 
-.BI configtest
-before initiating the restart to make sure Apache doesn't die.
-On certain platforms that do not allow SIGUSR1 to be used for a graceful
-restart, an alternative signal may be used (such as SIGWINCH).  graceful 
-will send the right signal for your platform.
-.TP
-.BI configtest
-Run a configuration file syntax test. It parses the configuration
-files and either reports 
-.B "Syntax Ok"
-or detailed information about the particular syntax error.
-.TP
-.BI help
-Displays a short help message.
-.SH SEE ALSO
-.BR httpd(8)
-.
diff --git a/docs/manual/programs/apachectl.html b/docs/manual/programs/apachectl.html
deleted file mode 100644 (file)
index aa9807a..0000000
+++ /dev/null
@@ -1,99 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
-  <head>
-    <meta name="generator" content="HTML Tidy, see www.w3.org" />
-
-    <title>Manual Page: apachectl - Apache HTTP Server</title>
-  </head>
-
-  <body bgcolor="#ffffff" text="#000000" link="#0000ff"
-  vlink="#000080" alink="#ff0000">
-    <!--#include virtual="header.html" -->
-
-    <h1 align="center">Manual Page: apachectl</h1>
-    <!-- This document was autogenerated from the man page -->
-<pre>
-<strong>NAME</strong>
-     apachectl - Apache HTTP server control interface
-
-<strong>SYNOPSIS</strong>
-     <strong>apachectl</strong> <em>command</em> [...]
-
-<strong>DESCRIPTION</strong>
-     <strong>apachectl</strong> is a front end to the  Apache  HyperText  Transfer
-     Protocol (HTTP) server.  It is designed to help the adminis-
-     trator control the functioning of the Apache <strong>httpd</strong> daemon.
-
-     <strong>NOTE:</strong> If your Apache installation uses  non-standard  paths,
-     you  will  need  to  edit  the  <strong>apachectl</strong>  script to set the
-     appropriate paths to your PID file and  your  <strong>httpd</strong>  binary.
-     See the comments in the script for details.
-
-     The <strong>apachectl</strong> script returns a 0 exit value on success,  and
-     &gt;0  if an error occurs.  For more details, view the comments
-     in the script.
-
-     Full   documentation   for   Apache    is    available    at
-     <strong>http://httpd.apache.org/</strong>
-
-<strong>OPTIONS</strong>
-     The <em>command</em> can be any one or more of the following options:
-
-     <strong>start   </strong>    Start the Apache daemon.  Gives an error  if  it
-                 is already running.
-
-     <strong>stop    </strong>    Stops the Apache daemon.
-
-     <strong>restart </strong>    Restarts the  Apache  daemon  by  sending  it  a
-                 SIGHUP.   If  the  daemon  is not running, it is
-                 started.  This command automatically checks  the
-                 configuration  files  via <strong>configtest</strong> before ini-
-                 tiating the restart to make sure Apache  doesn't
-                 die.
-
-     <strong>fullstatus</strong>  Displays a full status report  from  <strong>mod_status.</strong>
-                 For  this  to  work, you need to have mod_status
-                 enabled on your server and a text-based  browser
-                 such  as <em>lynx</em> available on your system.  The URL
-                 used to access the status report can be  set  by
-                 editing the <strong>STATUSURL</strong> variable in the script.
-
-     <strong>status  </strong>    Displays a brief status report.  Similar to  the
-                 fullstatus  option,  except  that  the  list  of
-                 requests currently being served is omitted.
-
-     <strong>graceful</strong>    Gracefully restarts the Apache daemon by sending
-                 it a SIGUSR1.  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 means that
-                 if used in a log rotation script, a  substantial
-                 delay  may  be  necessary to ensure that the old
-                 log files are  closed  before  processing  them.
-                 This command automatically checks the configura-
-                 tion files via <strong>configtest</strong> before initiating  the
-                 restart to make sure  Apache  doesn't  die.   <i>On 
-                 certain  platforms that  do not allow USR1 to be 
-                 used  for  a  graceful  restart,  an alternative 
-                 signal may be used  (such as WINCH).   apachectl 
-                 graceful will send  the right  signal  for  your 
-                 platform.</i>
-
-     <strong>configtest</strong>  Run a configuration file syntax test. It  parses
-                 the  configuration files and either reports <strong>Syn-</strong>
-                 <strong>tax Ok</strong> or detailed information about the partic-
-                 ular syntax error.
-
-     <strong>help    </strong>    Displays a short help message.
-
-<strong>SEE ALSO</strong>
-     <strong>httpd(8)</strong>
-
-</pre>
-    <!--#include virtual="footer.html" -->
-  </body>
-</html>
-
diff --git a/docs/manual/programs/apachectl.html.en b/docs/manual/programs/apachectl.html.en
new file mode 100644 (file)
index 0000000..bf51f90
--- /dev/null
@@ -0,0 +1,120 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
+        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+              This file is generated from xml source: DO NOT EDIT
+        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+      --><title>apachectl - Apache HTTP Server Control Interface - Apache HTTP Server</title><link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /><link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /><link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link href="../images/favicon.ico" rel="shortcut icon" /></head><body id="manual-page"><div id="page-header"><p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p><p class="apache">Apache HTTP Server Version 2.0</p><img alt="" src="../images/feather.gif" /></div><div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div><div id="path"><a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs-project/">Documentation</a> &gt; <a href="../">Version 2.0</a> &gt; <a href="./">Programs</a></div><div id="page-content"><div id="preamble"><h1>apachectl - Apache HTTP Server Control Interface</h1>
+     <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>
+
+     <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>
+     command that simply sets any necessary environment variables and
+     then invokes <code>httpd</code>, 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>
+
+     <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 arugments.
+     See the comments in the script for details.</p>
+
+     The <code>apachectl</code> script returns a 0 exit value on
+     success, and &gt;0 if an error occurs.  For more details, view
+     the comments in the script.
+</div><div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#synopsis">Synopsis</a></li><li><img alt="" src="../images/down.gif" /> <a href="#options">Options</a></li></ul><h3>See also</h3><ul class="seealso"><li><a href="../invoking.html">Starting Apache</a></li><li><a href="../stopping.html">Stopping Apache</a></li><li><a href="../configuring.html">Configuration Files</a></li><li><a href="../platform/">Platform Docs</a></li><li><a href="httpd.html">httpd</a></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="synopsis" id="synopsis">Synopsis</a></h2>
+
+<p>When acting in pass-through mode, <code>apachectl</code> can take
+all the arguments available for the <a href="httpd.html">httpd</a>
+binary.</p>
+
+<p><code><strong>apachectl</strong> [ <var>httpd-argument</var> ]</code></p>
+
+<p>When acting in SysV init mode, <code>apachectl</code> takes simple,
+one-word commands, defined below.</p>
+
+<p><code><strong>apachectl </strong> <var>command</var></code></p>
+
+</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="options" id="options">Options</a></h2>
+
+<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>
+
+<dl>
+
+<dt><code>start</code></dt>
+
+<dd>Start the Apache <code>httpd</code> 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
+<code>apachectl -k stop</code>.</dd>
+
+<dt><code>restart</code></dt>
+
+<dd>Restarts the Apache <code>httpd</code> 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
+to <code>apachectl -k restart</code>.</dd>
+
+<dt><code>fullstatus</code></dt>
+
+<dd>Displays a full status report from <code class="module"><a href="../mod/mod_status.html">mod_status</a></code>.
+For this to work, you need to have <code class="module"><a href="../mod/mod_status.html">mod_status</a></code> enabled
+on your server and a text-based browser such as <code>lynx</code>
+available on your system.  The URL used to access the status report
+can be set by editing the <code>STATUSURL</code> variable in the
+script.</dd>
+
+<dt><code>status</code></dt>
+
+<dd>Displays a brief status report.  Similar to the
+<code>fullstatus</code> option, except that the list of requests
+currently being served is omitted.</dd>
+
+<dt><code>graceful</code></dt>
+
+<dd>Gracefully restarts the Apache <code>httpd</code> 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
+means that if used in a log rotation script, a substantial delay may
+be necessary to ensure that the old log files are closed before
+processing them.  This command automatically checks the configura-
+tion files as in <code>configtest</code> before initiating the
+restart to make sure Apache doesn't die.  This is equivalent to
+<code>apachectl -k graceful</code>.</dd>
+
+<dt><code>configtest</code></dt>
+
+<dd>Run a configuration file syntax test. It parses the configuration
+files and either reports <code>Syntax Ok</code>
+or detailed information about the particular syntax error.  This is
+equivalent to <code>apachectl -t</code>.</dd>
+
+</dl>
+
+<p>The following additional option is available, but deprecated.</p>
+
+<dl>
+
+<dt><code>startssl</code></dt>
+
+<dd>This is equivalent to <code>apachectl -k start -DSSL</code>.  We
+recommend that you use that command explictly, or you adjust your
+<code>httpd.conf</code> to remove the <code class="directive"><a href="../mod/core.html#ifdefine">&lt;IfDefine&gt;</a></code> section so that SSL will always be
+available.</dd>
+
+</dl>
+
+</div></div><div id="footer"><p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p><p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div></body></html>
\ No newline at end of file
diff --git a/docs/manual/programs/apachectl.xml b/docs/manual/programs/apachectl.xml
new file mode 100644 (file)
index 0000000..db5f1e5
--- /dev/null
@@ -0,0 +1,135 @@
+<?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=".."/>
+<parentdocument href="./">Programs</parentdocument>
+
+  <title>apachectl - Apache HTTP Server Control Interface</title>
+
+<summary>
+     <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>
+
+     <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>
+     command that simply sets any necessary environment variables and
+     then invokes <code>httpd</code>, 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>
+
+     <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 arugments.
+     See the comments in the script for details.</p>
+
+     The <code>apachectl</code> script returns a 0 exit value on
+     success, and &gt;0 if an error occurs.  For more details, view
+     the comments in the script.
+</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/">Platform Docs</a></seealso>
+<seealso><a href="httpd.html">httpd</a></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>
+binary.</p>
+
+<p><code><strong>apachectl</strong> [ <var>httpd-argument</var> ]</code></p>
+
+<p>When acting in SysV init mode, <code>apachectl</code> takes simple,
+one-word commands, defined below.</p>
+
+<p><code><strong>apachectl </strong> <var>command</var></code></p>
+
+</section>
+
+<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>
+
+<dl>
+
+<dt><code>start</code></dt>
+
+<dd>Start the Apache <code>httpd</code> 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
+<code>apachectl -k stop</code>.</dd>
+
+<dt><code>restart</code></dt>
+
+<dd>Restarts the Apache <code>httpd</code> 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
+to <code>apachectl -k restart</code>.</dd>
+
+<dt><code>fullstatus</code></dt>
+
+<dd>Displays a full status report from <module>mod_status</module>.
+For this to work, you need to have <module>mod_status</module> enabled
+on your server and a text-based browser such as <code>lynx</code>
+available on your system.  The URL used to access the status report
+can be set by editing the <code>STATUSURL</code> variable in the
+script.</dd>
+
+<dt><code>status</code></dt>
+
+<dd>Displays a brief status report.  Similar to the
+<code>fullstatus</code> option, except that the list of requests
+currently being served is omitted.</dd>
+
+<dt><code>graceful</code></dt>
+
+<dd>Gracefully restarts the Apache <code>httpd</code> 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
+means that if used in a log rotation script, a substantial delay may
+be necessary to ensure that the old log files are closed before
+processing them.  This command automatically checks the configura-
+tion files as in <code>configtest</code> before initiating the
+restart to make sure Apache doesn't die.  This is equivalent to
+<code>apachectl -k graceful</code>.</dd>
+
+<dt><code>configtest</code></dt>
+
+<dd>Run a configuration file syntax test. It parses the configuration
+files and either reports <code>Syntax Ok</code>
+or detailed information about the particular syntax error.  This is
+equivalent to <code>apachectl -t</code>.</dd>
+
+</dl>
+
+<p>The following additional option is available, but deprecated.</p>
+
+<dl>
+
+<dt><code>startssl</code></dt>
+
+<dd>This is equivalent to <code>apachectl -k start -DSSL</code>.  We
+recommend that you use that command explictly, or you adjust your
+<code>httpd.conf</code> to remove the <directive module="core"
+type="section">IfDefine</directive> section so that SSL will always be
+available.</dd>
+
+</dl>
+
+</section>
+
+</manualpage>