]> granicus.if.org Git - apache/commitdiff
Deprecate the direct use of httpd and recommend instead the use
authorJoshua Slive <slive@apache.org>
Wed, 13 Nov 2002 20:54:35 +0000 (20:54 +0000)
committerJoshua Slive <slive@apache.org>
Wed, 13 Nov 2002 20:54:35 +0000 (20:54 +0000)
of apachectl.

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

docs/manual/invoking.html.en
docs/manual/invoking.xml

index 1579dc05e621c9691af8e9d76512bc894b157a28..a7a14dae642d629f00a01309e6e63b7150e1374e 100644 (file)
@@ -14,7 +14,7 @@
     is run as a daemon that executes continuously in the
     background to handle requests.  This document describes how
     to invoke <code>httpd</code>.</p>
-</div><div id="quickview"><ul id="toc"><li><img alt="" src="./images/down.gif" /> <a href="#startup">How Apache Starts</a></li><li><img alt="" src="./images/down.gif" /> <a href="#errors">Errors During Start-up</a></li><li><img alt="" src="./images/down.gif" /> <a href="#boot">Starting at Boot-Time</a></li><li><img alt="" src="./images/down.gif" /> <a href="#info">Additional Information</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="startup" id="startup">How Apache Starts</a></h2>
+</div><div id="quickview"><ul id="toc"><li><img alt="" src="./images/down.gif" /> <a href="#startup">How Apache Starts</a></li><li><img alt="" src="./images/down.gif" /> <a href="#errors">Errors During Start-up</a></li><li><img alt="" src="./images/down.gif" /> <a href="#boot">Starting at Boot-Time</a></li><li><img alt="" src="./images/down.gif" /> <a href="#info">Additional Information</a></li></ul><h3>See also</h3><ul class="seealso"><li><a href="stopping.html">Stopping Apache</a></li><li><a href="programs/httpd.html">httpd</a></li><li><a href="programs/apachectl.html">apachectl</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="startup" id="startup">How Apache Starts</a></h2>
 
     <p>If the <code class="directive"><a href="./mod/mpm_common.html#listen">Listen</a></code>
     specified in the configuration file is default of 80 (or any other
     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
+    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>
+    variable near the top to specify the correct location of the
+    <code>httpd</code> 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
     invoked is to locate and read the <a href="configuring.html">configuration file</a>
     <code>httpd.conf</code>. The location of this file is set at
     compile-time, but it is possible to specify its location at run
     time using the <code>-f</code> command-line option as in</p>
 
-<div class="example"><p><code>/usr/local/apache/bin/httpd -f
+<div class="example"><p><code>/usr/local/apache2/bin/apachectl -f
       /usr/local/apache/conf/httpd.conf</code></p></div>
 
-    <p>As an alternative to invoking the <code>httpd</code> binary
-    directly, a shell script called <a href="programs/apachectl.html">apachectl</a> is provided which
-    can be used to control the daemon process with simple commands
-    such as <code>apachectl start</code> and <code>apachectl
-    stop</code>.</p>
-
     <p>If all goes well during startup, the server will detach from
     the terminal and the command prompt will return almost
     immediately. This indicates that the server is up and running.
 </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div><div class="section"><h2><a name="boot" id="boot">Starting at Boot-Time</a></h2>
 
     <p>If you want your server to continue running after a system
-    reboot, you should add a call to <code>httpd</code> or
-    <code>apachectl</code> 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. The <code>apachectl</code> script is
-    designed so that it can often be linked directly as an init
-    script, but be sure to check the exact requirements of your
-    system.</p>
+    reboot, you should add a call to <code>apachectl</code> 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
+    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
+    sure to check the exact requirements of your system.</p>
 </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div><div class="section"><h2><a name="info" id="info">Additional Information</a></h2>
 
     <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
index a50adcafe607c228186ef1f5a18b7dd741b4ffb7..7a044eed39fcfccb089e4233d0d9eceeaed54b66 100644 (file)
     to invoke <code>httpd</code>.</p>
 </summary>
 
+<seealso><a href="stopping.html">Stopping Apache</a></seealso>
+<seealso><a href="programs/httpd.html">httpd</a></seealso>
+<seealso><a href="programs/apachectl.html">apachectl</a></seealso>
+
 <section id="startup"><title>How Apache Starts</title>
 
     <p>If the <directive module="mpm_common">Listen</directive>
     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
+    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>
+    variable near the top to specify the correct location of the
+    <code>httpd</code> 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
     invoked is to locate and read the <a
     href="configuring.html">configuration file</a>
     compile-time, but it is possible to specify its location at run
     time using the <code>-f</code> command-line option as in</p>
 
-<example>/usr/local/apache/bin/httpd -f
+<example>/usr/local/apache2/bin/apachectl -f
       /usr/local/apache/conf/httpd.conf</example>
 
-    <p>As an alternative to invoking the <code>httpd</code> binary
-    directly, a shell script called <a
-    href="programs/apachectl.html">apachectl</a> is provided which
-    can be used to control the daemon process with simple commands
-    such as <code>apachectl start</code> and <code>apachectl
-    stop</code>.</p>
-
     <p>If all goes well during startup, the server will detach from
     the terminal and the command prompt will return almost
     immediately. This indicates that the server is up and running.
 <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>httpd</code> or
-    <code>apachectl</code> 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. The <code>apachectl</code> script is
-    designed so that it can often be linked directly as an init
-    script, but be sure to check the exact requirements of your
-    system.</p>
+    reboot, you should add a call to <code>apachectl</code> 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
+    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
+    sure to check the exact requirements of your system.</p>
 </section>
 
 <section id="info"><title>Additional Information</title>