slive 01/01/03 10:41:41
Modified: htdocs/manual invoking.html Log: Backport some 2.0 docs into 1.3. In specific, document the apachectl command line options, and add teh windows-specific httpd command line options. Revision Changes Path 1.32 +98 -14 httpd-docs-1.3/htdocs/manual/invoking.html Index: invoking.html =================================================================== RCS file: /home/cvs/httpd-docs-1.3/htdocs/manual/invoking.html,v retrieving revision 1.31 retrieving revision 1.32 diff -u -d -b -u -r1.31 -r1.32 --- invoking.html 2001/01/03 18:36:55 1.31 +++ invoking.html 2001/01/03 18:41:38 1.32 @@ -15,24 +15,88 @@ <!--#include virtual="header.html" --> <H1 ALIGN="CENTER">Starting Apache</H1> -<H2>Invoking Apache</H2> +<h2>Starting Apache On Windows</h2> -On Unix, the <CODE>httpd</CODE> program is usually run as a daemon -which executes continuously, handling requests. It is possible to -invoke Apache by the Internet daemon <CODE>inetd</CODE> each time a -connection to the HTTP service is made (use the <A +<p>On Windows, Apache is normally run as a service on Windows NT, or +as a console application on Windows 95. For details, see <A +HREF="platform/windows.html#run">running Apache for Windows</A>.</p> + +<h2>Starting Apache on Unix</h2> + +<p>On Unix, the <code>httpd</code> program is run as a daemon which +executes continuously in the background to handle requests. It is +possible to invoke Apache by the Internet daemon <CODE>inetd</CODE> +each time a connection to the HTTP service is made (use the <A HREF="mod/core.html#servertype">ServerType</A> directive) but this is -not recommended. +not recommended.</p> -<P>On Windows, Apache is normally run as a service on Windows NT, or as a -console application on Windows 95. See also <A -HREF="windows.html#run">running Apache for Windows</A>. +<p>A shell script called <code>apachectl</code> is +provided which can be used to control the daemon process. This shell +script can often be used as an init script to start <code>httpd</code> +on system boot, or it can be called directly with the options listed +below.</p> -<P>As of Apache 1.3 we provide the script <CODE>apachectl</CODE> -which can be used to start, stop, and restart Apache. It may need a -little customization for your system; see the comments at the top of -the script. +<p>If the <a href="mod/core.html#port">Port</a> specified in the +configuration file is the default of 80, then it is necessary to have +root privileges in order to start apache. If Apache will not start +and no error messages are printed to the console, be sure to check the +<a href="mod/core.html#errorlog">ErrorLog</a> for a report of +the problem. See also the debugging instructions outlined in +the Apache <a href="misc/FAQ.html">FAQ</a>.</p> + +<h2>apachectl Command Line Options</h2> + +<dl> + +<dt><code>start</code></dt> <dd>Start <code>httpd</code>. If +additional command line options need to be passed to +<code>httpd</code> (see below), then the <code>HTTPD</code> variable +at the top of the <code>apachectl</code> script should be edited to +include them.</dd> + +<dt><code>stop</code></dt> +<dd>Stop <code>httpd</code> by issuing the kill signal to the +parent <code>httpd</code> process, whose process ID is contained +in the file pointed to by the +<a href="mod/mpm_common.html#pidfile">PidFile</a> directive.</dd> + +<dt><code>restart</code></dt> +<dd>Restart <code>httpd</code> if it is running by sending a +<code>SIGHUP</code> +signal to the parent process. If the server is not running, then +it will be started. <code>apachectl</code> will refuse to +restart the server if there is a syntax error in the configuration +files (see <code>configtest</code> below).</dd> + +<dt><code>graceful</code></dt> <dd>Restart <code>httpd</code> if it is +running by sending a <code>SIGWINCH</code> signal to the parent +process. This type of restart is less disruptive to current clients. +If the server is not running, then it will be +started. <code>apachectl</code> will refuse to restart the server if +there is a syntax error in the configuration files.</dd> + +<dt><code>fullstatus</code></dt> +<dd>Show a screen indicating the status of the Apache processes. +This option requires the presence of <code>lynx</code>, and +for <a href="mod/mod_status.html">mod_status</a> to be enabled.</dd> + +<dt><code>status</code></dt> +<dd>A shorter form of the <code>fullstatus</code> display. +This option requires the presence of <code>lynx</code>, and +for <a href="mod/mod_status.html">mod_status</a> to be enabled.</dd> +<dt><code>configtest</code></dt> +<dd>Do a syntax test of the Apache configuration files. See +the <code>httpd -t</code> command line option below.</dd> +<dt><code>help</code></dt> +<dd>Show a help screen.</dd> + +</dl> + +<p>For additional information on the effects of the various +<code>apachectl</code> options, see the documentation on <a +href="stopping.html">stopping and restarting Apache</a>.</p> + <H2>Command line options</H2> The following options are recognized on the httpd command line: <DL> @@ -146,6 +210,26 @@ object files.</dd> </DL> + +<p>When Apache is used under Windows, the following additional +command line options are available.</p> + +<dl> + +<dt><code>-n</code> <em>name</em></dt> +<dd>Set service name and use its ServerConfigFile.</dd> + +<DT><CODE>-k</CODE> <EM>option</EM> +<DD>Signal Apache to restart or shutdown. <EM>option</EM> +is one of "shutdown" or "restart". + +<dt><code>-i</code></dt> +<dd>Install an Apache service</dd> + +<dt><code>-u</code></dt> +<dd>Uninstall an Apache Service</dd> + +</dl> <!--#include virtual="footer.html" --> </BODY>
