← Back to branch summary

~ubuntu-branches/ubuntu/feisty/apache2/feisty

« back to all changes in this revision

Viewing changes to docs/man/apachectl.8

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Barth
  • Date: 2006-12-09 21:05:45 UTC
  • mfrom: (0.6.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20061209210545-h70s0xaqc2v8vqr2
Tags: 2.2.3-3.2
http://bugs.debian.org/396265
* Non-maintainer upload.
* 043_ajp_connection_reuse: Patch from upstream Bugzilla, fixing a critical
  issue with regard to connection reuse in mod_proxy_ajp.
  Closes: #396265

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/apachectl.8
 
1
.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 
2
.\" DO NOT EDIT! Generated from XML source.
 
3
.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 
4
.de Sh \" Subsection
 
5
.br
 
6
.if t .Sp
 
7
.ne 5
 
8
.PP
 
9
\fB\\$1\fR
 
10
.PP
 
11
..
 
12
.de Sp \" Vertical space (when we can't use .PP)
 
13
.if t .sp .5v
 
14
.if n .sp
 
15
..
 
16
.de Ip \" List item
 
17
.br
 
18
.ie \\n(.$>=3 .ne \\$3
 
19
.el .ne 3
 
20
.IP "\\$1" \\$2
 
21
..
 
22
.TH "APACHECTL" 8 "2005-09-20" "Apache HTTP Server" "apachectl"
 
23
 
 
24
.SH NAME
 
25
apachectl \- Apache HTTP Server Control Interface
 
26
 
 
27
.SH "SYNOPSIS"
 
28
 
 
29
.PP
 
30
When acting in pass-through mode, apachectl can take all the arguments available for the httpd binary\&.
 
31
 
 
32
.PP
 
33
\fBapachectl\fR [ \fIhttpd-argument\fR ]
 
34
 
 
35
.PP
 
36
When acting in SysV init mode, apachectl takes simple, one-word commands, defined below\&.
 
37
 
 
38
.PP
 
39
\fBapachectl\fR \fIcommand\fR
 
40
 
 
41
 
 
42
.SH "SUMMARY"
 
43
 
 
44
.PP
 
45
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\&.
 
46
 
 
47
.PP
 
48
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\&.
 
49
 
 
50
.PP
 
51
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 arguments\&. See the comments in the script for details\&.
 
52
 
 
53
.PP
 
54
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\&.
 
55
 
 
56
 
 
57
.SH "OPTIONS"
 
58
 
 
59
.PP
 
60
Only the SysV init-style options are defined here\&. Other arguments are defined on the httpd manual page\&.
 
61
 
 
62
 
 
63
.TP
 
64
start
 
65
Start the Apache httpd daemon\&. Gives an error if it is already running\&. This is equivalent to apachectl -k start\&.  
 
66
.TP
 
67
stop
 
68
Stops the Apache httpd daemon\&. This is equivalent to apachectl -k stop\&.  
 
69
.TP
 
70
restart
 
71
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\&.  
 
72
.TP
 
73
fullstatus
 
74
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\&.  
 
75
.TP
 
76
status
 
77
Displays a brief status report\&. Similar to the fullstatus option, except that the list of requests currently being served is omitted\&.  
 
78
.TP
 
79
graceful
 
80
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 configuration files as in configtest before initiating the restart to make sure Apache doesn't die\&. This is equivalent to apachectl -k graceful\&.  
 
81
.TP
 
82
graceful-stop
 
83
Gracefully stops the Apache httpd daemon\&. This differs from a normal stop in that currently open connections are not aborted\&. A side effect is that old log files will not be closed immediately\&. This is equivalent to apachectl -k graceful-stop\&.  
 
84
.TP
 
85
configtest
 
86
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\&.  
 
87
 
 
88
.PP
 
89
The following option was available in earlier versions but has been removed\&.
 
90
 
 
91
 
 
92
.TP
 
93
startssl
 
94
To start httpd with SSL support, you should edit your configuration file to include the relevant directives and then use the normal apachectl start\&.  
 
95