httpd-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Marc Slemko <ma...@znep.com>
Subject apachectl man page
Date Fri, 05 Sep 1997 23:07:18 GMT
I will be adding the below as a man page for apachectl.  Suggestions
welcome.  This isn't exactly how I would normally write a man page, 
but I tried to be portable at the expense of being stupid.


.TH apachectl 1 "September 1997"
.\" Copyright (c) 1997 The Apache Group. 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. All advertising materials mentioning features or use of this
.\"    software must display the following acknowledgment:
.\"    "This product includes software developed by the Apache Group
.\"    for use in the Apache HTTP server project (http://www.apache.org/)."
.\"
.\" 4. The names "Apache Server" and "Apache Group" must not be used to
.\"    endorse or promote products derived from this software without
.\"    prior written permission.
.\"
.\" 5. Redistributions of any form whatsoever must retain the following
.\"    acknowledgment:
.\"    "This product includes software developed by the Apache Group
.\"    for use in the Apache HTTP server project (http://www.apache.org/)."
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE APACHE GROUP ``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 GROUP 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 Group and was originally based
.\" on public domain software written at the National Center for
.\" Supercomputing Applications, University of Illinois, Urbana-Champaign.
.\" For more information on the Apache Group and the Apache HTTP server
.\" project, please see <http://www.apache.org/>.
.SH NAME
apachectl \- Apache HTTP server control interface
.SH SYNOPSIS
.B apachectl 
command [...]
.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(8)
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://www.apache.org/
.
.SH OPTIONS
The command 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.
.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 lynx 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.
.TP
.BI help
Displays a short help message.
.SH SEE ALSO
.BR httpd(8)
.


Mime
View raw message