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