diff options
author | Jason McIntyre <jmc@cvs.openbsd.org> | 2004-12-06 11:17:42 +0000 |
---|---|---|
committer | Jason McIntyre <jmc@cvs.openbsd.org> | 2004-12-06 11:17:42 +0000 |
commit | 20a47c27fa36d4839346341c60f8c62af173d82d (patch) | |
tree | becde35b55577c90b84220475cc49aad5e0344de /usr.sbin/httpd | |
parent | 86f11d1ddd3b474eca26a50e956355b6880ce724 (diff) |
convert to mdoc;
Diffstat (limited to 'usr.sbin/httpd')
-rw-r--r-- | usr.sbin/httpd/src/support/apachectl.8 | 175 |
1 files changed, 91 insertions, 84 deletions
diff --git a/usr.sbin/httpd/src/support/apachectl.8 b/usr.sbin/httpd/src/support/apachectl.8 index 1aaeb37d5eb..f356fed2fb1 100644 --- a/usr.sbin/httpd/src/support/apachectl.8 +++ b/usr.sbin/httpd/src/support/apachectl.8 @@ -1,4 +1,5 @@ -.TH apachectl 1 "September 1997" +.\" $OpenBSD: apachectl.8,v 1.6 2004/12/06 11:17:41 jmc Exp $ +.\" .\" ==================================================================== .\" The Apache Software License, Version 1.1 .\" @@ -56,90 +57,96 @@ .\" originally written at the National Center for Supercomputing Applications, .\" University of Illinois, Urbana-Champaign. .\" -.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. -If the Apache daemon runs chrooted (default in OpenBSD) and -3rd party modules are loaded, restart may fail due to path -inconsistency. Completely -.BI stop -and -.BI start -the daemon instead. -.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 +.Dd December 6, 2004 +.Dt APACHECTL 8 +.Os +.Sh NAME +.Nm apachectl +.Nd Apache HTTP server control interface +.Sh SYNOPSIS +.Nm +.Ar command +.Op Ar ... +.Sh DESCRIPTION +.Nm +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 +.Xr httpd 8 +daemon. +.Pp +NOTE: +If your Apache installation uses non-standard paths, +you will need to edit the +.Nm +script to set the appropriate paths to your PID file and your +.Xr httpd 8 +binary. +See the comments in the script for details. +.Pp +The +.Nm +script returns a 0 exit value on success, and \*(Gt0 if an error occurs. +For more details, view the comments in the script. +.Pp +Full documentation for Apache is available at +.Pa http://httpd.apache.org/ . +.Sh OPTIONS +.Ar command +can be any one or more of the following options: +.Bl -tag -width "configtestXX" +.It Ic configtest +Run a configuration file syntax test. +It parses the configuration files and either reports +.Dq Syntax Ok +or detailed information about the particular syntax error. +.It Ic fullstatus +Displays a full status report from +.Dq mod_status . +For this to work, you need to have mod_status enabled on your server +and a text-based browser such as +.Xr lynx 1 +available on your system. +The URL used to access the status report can be set by editing the +.Dv 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. +.It Ic graceful +Gracefully restarts the Apache daemon by sending it a +.Dv 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 +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 +.Ic configtest before initiating the restart to make sure Apache doesn't die. -.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 +.It Ic help Displays a short help message. -.SH SEE ALSO -.BR httpd(8) -. +.It Ic restart +Restarts the Apache daemon by sending it a +.Dv SIGHUP . +If the daemon is not running, it is started. +This command automatically checks the configuration files via +.Ic configtest +before initiating the restart to make sure Apache doesn't die. +If the Apache daemon runs chrooted +(default in +.Ox ) +and 3rd party modules are loaded, +restart may fail due to path inconsistency. +Completely stop and start the daemon instead. +.It Ic start +Start the Apache daemon. +Gives an error if it is already running. +.It Ic status +Displays a brief status report. +Similar to the fullstatus option, +except that the list of requests currently being served is omitted. +.It Ic stop +Stops the Apache daemon. +.El +.Sh SEE ALSO +.Xr httpd 8 |