From: Joshua Slive Date: Thu, 14 Nov 2002 17:24:33 +0000 (+0000) Subject: apachectl nroff->xml with a few content updates to document X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=7820fe074600047091875fb52d0a1d1f5c310fc3;p=apache apachectl nroff->xml with a few content updates to document the new pass-through mode. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@97519 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/man/apachectl.8 b/docs/man/apachectl.8 deleted file mode 100644 index b40b698e1f..0000000000 --- a/docs/man/apachectl.8 +++ /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 -.\" . -.\" -.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 index aa9807a2b1..0000000000 --- a/docs/manual/programs/apachectl.html +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - Manual Page: apachectl - Apache HTTP Server - - - - - -

Manual Page: apachectl

- -
-NAME
-     apachectl - Apache HTTP server control interface
-
-SYNOPSIS
-     apachectl command [...]
-
-DESCRIPTION
-     apachectl 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 httpd daemon.
-
-     NOTE: If your Apache installation uses  non-standard  paths,
-     you  will  need  to  edit  the  apachectl  script to set the
-     appropriate paths to your PID file and  your  httpd  binary.
-     See the comments in the script for details.
-
-     The apachectl script returns a 0 exit value on success,  and
-     >0  if an error occurs.  For more details, view the comments
-     in the script.
-
-     Full   documentation   for   Apache    is    available    at
-     http://httpd.apache.org/
-
-OPTIONS
-     The command can be any one or more of the following options:
-
-     start       Start the Apache daemon.  Gives an error  if  it
-                 is already running.
-
-     stop        Stops the Apache daemon.
-
-     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 configtest before ini-
-                 tiating the restart to make sure Apache  doesn't
-                 die.
-
-     fullstatus  Displays a full status report  from  mod_status.
-                 For  this  to  work, you need to have mod_status
-                 enabled on your server and a text-based  browser
-                 such  as lynx available on your system.  The URL
-                 used to access the status report can be  set  by
-                 editing the STATUSURL variable in the script.
-
-     status      Displays a brief status report.  Similar to  the
-                 fullstatus  option,  except  that  the  list  of
-                 requests currently being served is omitted.
-
-     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 configura-
-                 tion files via configtest before initiating  the
-                 restart to make sure  Apache  doesn't  die.   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.
-
-     configtest  Run a configuration file syntax test. It  parses
-                 the  configuration files and either reports Syn-
-                 tax Ok or detailed information about the partic-
-                 ular syntax error.
-
-     help        Displays a short help message.
-
-SEE ALSO
-     httpd(8)
-
-
- - - - diff --git a/docs/manual/programs/apachectl.html.en b/docs/manual/programs/apachectl.html.en new file mode 100644 index 0000000000..bf51f90059 --- /dev/null +++ b/docs/manual/programs/apachectl.html.en @@ -0,0 +1,120 @@ + + +apachectl - Apache HTTP Server Control Interface - Apache HTTP Server

Modules | Directives | FAQ | Glossary | Sitemap

Apache HTTP Server Version 2.0

<-

apachectl - Apache HTTP Server Control Interface

+

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 + httpd daemon.

+ +

The apachectl script can operate in two modes. + First, it can act as a simple front-end to the httpd + command that simply sets any necessary environment variables and + then invokes httpd, passing through any command line + arguments. Second, apachectl can act as a SysV init + script, taking simple one-word arguments like start, + restart, and stop, and translating them + into appropriate signals to httpd.

+ +

If your Apache installation uses non-standard paths, you will + need to edit the apachectl script to set the + appropriate paths to the httpd binary. You can also + specify any necessary httpd command line arugments. + See the comments in the script for details.

+ + The apachectl script returns a 0 exit value on + success, and >0 if an error occurs. For more details, view + the comments in the script. +
top

Synopsis

+ +

When acting in pass-through mode, apachectl can take +all the arguments available for the httpd +binary.

+ +

apachectl [ httpd-argument ]

+ +

When acting in SysV init mode, apachectl takes simple, +one-word commands, defined below.

+ +

apachectl command

+ +
top

Options

+ +

Only the SysV init-style options are defined here. Other arguments +are defined on the httpd manual page.

+ +
+ +
start
+ +
Start the Apache httpd daemon. Gives an error if it +is already running. This is equivalent to apachectl -k +start.
+ +
stop
+ +
Stops the Apache httpd daemon. This is equivalent to +apachectl -k stop.
+ +
restart
+ +
Restarts the Apache httpd daemon. If the daemon is +not running, it is started. This command automatically checks the +configuration files as in configtest before initiating +the restart to make sure the daemon doesn't die. This is equivalent +to apachectl -k restart.
+ +
fullstatus
+ +
Displays a full status report from mod_status. +For this to work, you need to have mod_status enabled +on your server and a text-based browser such as lynx +available on your system. The URL used to access the status report +can be set by editing the STATUSURL variable in the +script.
+ +
status
+ +
Displays a brief status report. Similar to the +fullstatus option, except that the list of requests +currently being served is omitted.
+ +
graceful
+ +
Gracefully restarts the Apache httpd 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 configtest before initiating the +restart to make sure Apache doesn't die. This is equivalent to +apachectl -k graceful.
+ +
configtest
+ +
Run a configuration file syntax test. It parses the configuration +files and either reports Syntax Ok +or detailed information about the particular syntax error. This is +equivalent to apachectl -t.
+ +
+ +

The following additional option is available, but deprecated.

+ +
+ +
startssl
+ +
This is equivalent to apachectl -k start -DSSL. We +recommend that you use that command explictly, or you adjust your +httpd.conf to remove the <IfDefine> section so that SSL will always be +available.
+ +
+ +
\ No newline at end of file diff --git a/docs/manual/programs/apachectl.xml b/docs/manual/programs/apachectl.xml new file mode 100644 index 0000000000..db5f1e530b --- /dev/null +++ b/docs/manual/programs/apachectl.xml @@ -0,0 +1,135 @@ + + + + + +Programs + + apachectl - Apache HTTP Server Control Interface + + +

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 + httpd daemon.

+ +

The apachectl script can operate in two modes. + First, it can act as a simple front-end to the httpd + command that simply sets any necessary environment variables and + then invokes httpd, passing through any command line + arguments. Second, apachectl can act as a SysV init + script, taking simple one-word arguments like start, + restart, and stop, and translating them + into appropriate signals to httpd.

+ +

If your Apache installation uses non-standard paths, you will + need to edit the apachectl script to set the + appropriate paths to the httpd binary. You can also + specify any necessary httpd command line arugments. + See the comments in the script for details.

+ + The apachectl script returns a 0 exit value on + success, and >0 if an error occurs. For more details, view + the comments in the script. + +Starting Apache +Stopping Apache +Configuration Files +Platform Docs +httpd + +
Synopsis + +

When acting in pass-through mode, apachectl can take +all the arguments available for the httpd +binary.

+ +

apachectl [ httpd-argument ]

+ +

When acting in SysV init mode, apachectl takes simple, +one-word commands, defined below.

+ +

apachectl command

+ +
+ +
Options + +

Only the SysV init-style options are defined here. Other arguments +are defined on the httpd manual page.

+ +
+ +
start
+ +
Start the Apache httpd daemon. Gives an error if it +is already running. This is equivalent to apachectl -k +start.
+ +
stop
+ +
Stops the Apache httpd daemon. This is equivalent to +apachectl -k stop.
+ +
restart
+ +
Restarts the Apache httpd daemon. If the daemon is +not running, it is started. This command automatically checks the +configuration files as in configtest before initiating +the restart to make sure the daemon doesn't die. This is equivalent +to apachectl -k restart.
+ +
fullstatus
+ +
Displays a full status report from mod_status. +For this to work, you need to have mod_status enabled +on your server and a text-based browser such as lynx +available on your system. The URL used to access the status report +can be set by editing the STATUSURL variable in the +script.
+ +
status
+ +
Displays a brief status report. Similar to the +fullstatus option, except that the list of requests +currently being served is omitted.
+ +
graceful
+ +
Gracefully restarts the Apache httpd 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 configtest before initiating the +restart to make sure Apache doesn't die. This is equivalent to +apachectl -k graceful.
+ +
configtest
+ +
Run a configuration file syntax test. It parses the configuration +files and either reports Syntax Ok +or detailed information about the particular syntax error. This is +equivalent to apachectl -t.
+ +
+ +

The following additional option is available, but deprecated.

+ +
+ +
startssl
+ +
This is equivalent to apachectl -k start -DSSL. We +recommend that you use that command explictly, or you adjust your +httpd.conf to remove the IfDefine section so that SSL will always be +available.
+ +
+ +
+ +