home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F278501_apachectl.xml < prev    next >
Extensible Markup Language  |  2004-02-09  |  6KB  |  152 lines
  1. <?xml version='1.0' encoding='UTF-8' ?>
  2. <!DOCTYPE manualpage SYSTEM "../style/manualpage.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4.  
  5. <!--
  6.  Copyright 2002-2004 The Apache Software Foundation
  7.  
  8.  Licensed under the Apache License, Version 2.0 (the "License");
  9.  you may not use this file except in compliance with the License.
  10.  You may obtain a copy of the License at
  11.  
  12.      http://www.apache.org/licenses/LICENSE-2.0
  13.  
  14.  Unless required by applicable law or agreed to in writing, software
  15.  distributed under the License is distributed on an "AS IS" BASIS,
  16.  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17.  See the License for the specific language governing permissions and
  18.  limitations under the License.
  19. -->
  20.  
  21. <manualpage metafile="apachectl.xml.meta">
  22. <parentdocument href="./">Programs</parentdocument>
  23.  
  24.   <title>apachectl - Apache HTTP Server Control Interface</title>
  25.  
  26. <summary>
  27.      <p><code>apachectl</code> is a front end to the Apache HyperText
  28.      Transfer Protocol (HTTP) server.  It is designed to help the
  29.      administrator control the functioning of the Apache
  30.      <a href="httpd.html">httpd</a> daemon.</p>
  31.  
  32.      <p>The <code>apachectl</code> script can operate in two modes.
  33.      First, it can act as a simple front-end to the <code>httpd</code>
  34.      command that simply sets any necessary environment variables and
  35.      then invokes <code>httpd</code>, passing through any command line
  36.      arguments.  Second, <code>apachectl</code> can act as a SysV init
  37.      script, taking simple one-word arguments like <code>start</code>,
  38.      <code>restart</code>, and <code>stop</code>, and translating them
  39.      into appropriate signals to <code>httpd</code>.</p>
  40.  
  41.      <p>If your Apache installation uses non-standard paths, you will
  42.      need to edit the <code>apachectl</code> script to set the
  43.      appropriate paths to the <code>httpd</code> binary.  You can also
  44.      specify any necessary <code>httpd</code> command line arguments.
  45.      See the comments in the script for details.</p>
  46.  
  47.      <p>The <code>apachectl</code> script returns a 0 exit value on
  48.      success, and >0 if an error occurs.  For more details, view
  49.      the comments in the script.</p>
  50. </summary>
  51. <seealso><a href="../invoking.html">Starting Apache</a></seealso>
  52. <seealso><a href="../stopping.html">Stopping Apache</a></seealso>
  53. <seealso><a href="../configuring.html">Configuration Files</a></seealso>
  54. <seealso><a href="../platform/">Platform Docs</a></seealso>
  55. <seealso><a href="httpd.html">httpd</a></seealso>
  56.  
  57. <section id="synopsis"><title>Synopsis</title>
  58.  
  59. <p>When acting in pass-through mode, <code>apachectl</code> can take
  60. all the arguments available for the <a href="httpd.html">httpd</a>
  61. binary.</p>
  62.  
  63. <p><code><strong>apachectl</strong> [ <var>httpd-argument</var> ]</code></p>
  64.  
  65. <p>When acting in SysV init mode, <code>apachectl</code> takes simple,
  66. one-word commands, defined below.</p>
  67.  
  68. <p><code><strong>apachectl</strong> <var>command</var></code></p>
  69.  
  70. </section>
  71.  
  72. <section id="options"><title>Options</title>
  73.  
  74. <p>Only the SysV init-style options are defined here.  Other arguments
  75. are defined on the <a href="httpd.html">httpd</a> manual page.</p>
  76.  
  77. <dl>
  78.  
  79. <dt><code>start</code></dt>
  80.  
  81. <dd>Start the Apache <code>httpd</code> daemon.  Gives an error if it
  82. is already running.  This is equivalent to <code>apachectl -k
  83. start</code>.</dd>
  84.  
  85. <dt><code>stop</code></dt>
  86.  
  87. <dd>Stops the Apache <code>httpd</code> daemon.  This is equivalent to
  88. <code>apachectl -k stop</code>.</dd>
  89.  
  90. <dt><code>restart</code></dt>
  91.  
  92. <dd>Restarts the Apache <code>httpd</code> daemon.  If the daemon is
  93. not running, it is started.  This command automatically checks the
  94. configuration files as in <code>configtest</code> before initiating
  95. the restart to make sure the daemon doesn't die.  This is equivalent
  96. to <code>apachectl -k restart</code>.</dd>
  97.  
  98. <dt><code>fullstatus</code></dt>
  99.  
  100. <dd>Displays a full status report from <module>mod_status</module>.
  101. For this to work, you need to have <module>mod_status</module> enabled
  102. on your server and a text-based browser such as <code>lynx</code>
  103. available on your system.  The URL used to access the status report
  104. can be set by editing the <code>STATUSURL</code> variable in the
  105. script.</dd>
  106.  
  107. <dt><code>status</code></dt>
  108.  
  109. <dd>Displays a brief status report.  Similar to the
  110. <code>fullstatus</code> option, except that the list of requests
  111. currently being served is omitted.</dd>
  112.  
  113. <dt><code>graceful</code></dt>
  114.  
  115. <dd>Gracefully restarts the Apache <code>httpd</code> daemon.  If the
  116. daemon is not running, it is started.  This differs from a normal
  117. restart in that currently open connections are not aborted.  A side
  118. effect is that old log files will not be closed immediately.  This
  119. means that if used in a log rotation script, a substantial delay may
  120. be necessary to ensure that the old log files are closed before
  121. processing them.  This command automatically checks the configuration
  122. files as in <code>configtest</code> before initiating the
  123. restart to make sure Apache doesn't die.  This is equivalent to
  124. <code>apachectl -k graceful</code>.</dd>
  125.  
  126. <dt><code>configtest</code></dt>
  127.  
  128. <dd>Run a configuration file syntax test. It parses the configuration
  129. files and either reports <code>Syntax Ok</code>
  130. or detailed information about the particular syntax error.  This is
  131. equivalent to <code>apachectl -t</code>.</dd>
  132.  
  133. </dl>
  134.  
  135. <p>The following additional option is available, but deprecated.</p>
  136.  
  137. <dl>
  138.  
  139. <dt><code>startssl</code></dt>
  140.  
  141. <dd>This is equivalent to <code>apachectl -k start -DSSL</code>.  We
  142. recommend that you use that command explicitly, or you adjust your
  143. <code>httpd.conf</code> to remove the <directive module="core"
  144. type="section">IfDefine</directive> section so that SSL will always be
  145. available.</dd>
  146.  
  147. </dl>
  148.  
  149. </section>
  150.  
  151. </manualpage>
  152.