-.TH ab 1 "March 2000"
-.\" The Apache Software License, Version 1.1
-.\"
-.\" Copyright (c) 2000-2003 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
-.\" <http://www.apache.org/>.
-.\"
-.SH NAME
-ab \- Apache HTTP server benchmarking tool
-.SH SYNOPSIS
-.B ab
-[
-.B \-k
-] [
-.B \-e
-] [
-.B \-q
-] [
-.B \-S
-] [
-.B \-i
-] [
-+ .B \-s
-] [
-.BI \-n " requests"
-] [
-.BI \-t " timelimit"
-] [
-.BI \-c " concurrency"
-] [
-.BI \-p " POST file"
-] [
-.BI \-A " Authentication username:password"
-] [
-.BI \-P " Proxy Authentication username:password"
-] [
-.BI \-H " Custom header"
-] [
-.BI \-C " Cookie name=value"
-] [
-.BI \-T " content-type"
-] [
-.BI \-X " proxy [ :port ]"
-] [
-.BI \-v " verbosity"
-] [
-.BI \-w " output HTML"
-] [
-.BI \-g " output GNUPLOT"
-] [
-.BI \-e " output CSV"
-] [
-.BI \-x " <table> attributes"
-] [
-.BI \-y " <tr> attributes"
-] [
-.BI \-z " <td> attributes"
-]
-.I [http[s]://]hostname[:port]/path
-
-.B ab
-[
-.B \-V
-] [
-.B \-h
-]
+.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+.\" DO NOT EDIT! Generated from XML source.
+.\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
.PP
-.SH DESCRIPTION
-.B ab
-is a tool for benchmarking your Apache HyperText Transfer Protocol (HTTP)
-server. It is designed to give you an impression of how your current
-Apache installation performs. This especially shows you how many
-requests per second your Apache installation is capable of serving.
+\fB\\$1\fR
.PP
-.SH OPTIONS
-.TP 12
-.B \-k
-Enable the HTTP KeepAlive feature, i.e., perform multiple requests within one
-HTTP session. Default is no KeepAlive.
-.TP 12
-.BI \-n " requests"
-Number of requests to perform for the benchmarking session. The default is to
-just perform a single request which usually leads to non-representative
-benchmarking results.
-.TP 12
-.BI \-t " timelimit"
-Maximum number of seconds to spend for benchmarking. This implies
-.B \-d
-Do not display the "percentage served within XX [ms] table". (legacy
-support).
-.TP 12
-.B \-S
-Do not display the median and standard deviation values, nor display
-the warning/error messages when the average and median are more than
-one or two times the standard deviation apart. And default to the
-min/avg/max values. (legacy support).
-.TP 12
-.B \-s
-When compiled in (bb -h will show you) use the SSL protected
-.B https
-rather than the
-.B http
-protocol. This feature is experimental and
-.B very
-rudimentary. You probably do not want to use it.
-.TP 12
-.B \-k
-Enable the HTTP KeepAlive feature; that is, perform multiple requests
-within one HTTP session. Default is no KeepAlive.
-a
-.B \-n
-.B 50000
-internally. Use this to benchmark the server within a fixed total amount of
-time. Per default there is no timelimit.
-.TP 12
-.BI \-c " concurrency"
-Number of multiple requests to perform at a time.
-Default is one request at a time.
-
-.TP 12
-.BI \-p " POST file"
-File containing data to POST.
-
-.TP 12
-.BI \-A " Authentication username:password"
-Supply BASIC Authentication credentials to the server. The username
-and password are separated by a single ':' and sent on the wire uuencoded.
-The string is sent regardless of whether the server needs it; (i.e., has
-sent an 401 authentication needed).
-
-.TP 12
-.BI \-X " proxy[:port]"
-Route all requests through the proxy (at optional port).
-
-.TP 12
-.BI \-P " Proxy-Authentication username:password"
-Supply BASIC Authentication credentials to a proxy en-route. The username
-and password are separated by a single ':' and sent on the wire uuencoded.
-The string is sent regardless of whether the proxy needs it; (i.e., has
-sent an 407 proxy authentication needed).
-
-.TP 12
-.BI \-C " Cookie name=value"
-Add a 'Cookie:' line to the request. The argument is typically in the form
-of a 'name=value' pair. This field is repeatable.
-
-.TP 12
-.BI \-p " Header string"
-Append extra headers to the request. The argument is typically in the form
-of a valid header line, containing a colon-separated field-value pair.
-(i.e., 'Accept-Encoding: zip/zop;8bit').
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "AB" 8 "2003-04-29" "Apache HTTP Server" "ab"
-.TP 12
-.BI \-T " content-type"
-Content-type header to use for POST data.
-
-.TP 12
-.BI \-g " gnuplot file"
-Write all measured values out as a 'gnuplot' or TSV (Tab separate values)
-file. This file can easily be imported into packages like Gnuplot, IDL, Mathematica,
-Igor or even Excell. The labels are on the first line of the file.
-
-.TP 12
-.BI \-q
-When processing more than 150 requsts;
-.B ab
-outputs a progress count on
-.B stderr
-every 10% or 100 requests or so. The
-.B -q
-flag qill suppress these messages.
-
-.TP 12
-.BI \-e " CSV file"
-Write a Comma separated value (CSV) file which contains for each
-percentage (from 1% to 100%) the time (in milli seconds) it took
-to serve that percentage of the requests. This is usually more
-usefull than the 'gnuplot' file; as the results are already
-'binned'.
+.SH NAME
+ab \- Apache HTTP server benchmarking tool
-.TP 12
-.B \-v
-Set verbosity level - 4 and above prints information on headers, 3 and
-above prints response codes (404, 200, etc.), 2 and above prints
-warnings and info.
+.SH "SYNOPSIS"
+
+.PP
+\fBab\fR [ -\fBA\fR \fIauth-username\fR:\fIpassword\fR ] [ -\fBc\fR \fIconcurrency\fR ] [ -\fBC\fR \fIcookie-name\fR=\fIvalue\fR ] [ -\fBd\fR ] [ -\fBe\fR \fIcsv-file\fR ] [ -\fBg\fR \fIgnuplot-file\fR ] [ -\fBh\fR ] [ -\fBH\fR \fIcustom-header\fR ] [ -\fBi\fR ] [ -\fBk\fR ] [ -\fBn\fR \fIrequests\fR ] [ -\fBp\fR \fIPOST-file\fR ] [ -\fBP\fR \fIproxy-auth-username\fR:\fIpassword\fR ] [ -\fBq\fR ] [ -\fBs\fR ] [ -\fBS\fR ] [ -\fBt\fR \fItimelimit\fR ] [ -\fBT\fR \fIcontent-type\fR ] [ -\fBv\fR \fIverbosity\fR] [ -\fBV\fR ] [ -\fBw\fR ] [ -\fBx\fR \fI<table>-attributes\fR ] [ -\fBX\fR \fIproxy\fR[:\fIport\fR] ] [ -\fBy\fR \fI<tr>-attributes\fR ] [ -\fBz\fR \fI<td>-attributes\fR ] [http://]\fIhostname\fR[:\fIport\fR]/\fIpath\fR
+
-.TP 12
-.BI \-w
-Print out results in HTML tables. Default table is two columns wide,
-with a white background.
-.TP 12
-.BI \-x " attributes"
-String to use as attributes for <table>. Attributes are inserted
-<table
-.B here
->
-.TP 12
-.BI \-y " attributes"
-String to use as attributes for <tr>.
-.TP 12
-.BI \-z " attributes"
-String to use as attributes for <td>.
-.TP 12
-.B \-V
-Display version number and exit.
-.TP 12
-.B \-h
-Display usage information.
-.PD
-.SH BUGS
-There are various statically declared buffers of fixed length. Combined
-with the lazy parsing of the command line arguments, the response headers
-from the server and other external inputs, this might bite you.
-.P
-It does not implement HTTP/1.x fully; only accepts some 'expected' forms
-of responses. The rather heavy use of
-.BR strstr(3)
-shows up top in profile,
-which might indicate a performance problem; i.e., you would measure the
-.BR ab
-performance rather than the server's.
+.SH "SUMMARY"
+
+.PP
+ab is a tool for benchmarking your Apache Hypertext Transfer Protocol (HTTP) server\&. It is designed to give you an impression of how your current Apache installation performs\&. This especially shows you how many requests per second your Apache installation is capable of serving\&.
+
-.SH SEE ALSO
-.BR httpd(8)
-.P
-The HTML output is not as complete as the text output.
-.P
-Up to version 1.3d
-.B ab
-has probably reported values way too low for most measurements;
-as a single timeout (which is usually in the order of seconds)
-will shift several thousands of millisecond responses by a
-considerable factor. This was further compounded by a serious
-integer overrun, which would for realistic runs (i.e. those
-longer than a few minutes) produce believable but totally
-bogus results. Thanks to Sander Temme <sander@covalent.net>
-for solving this riddle.
-.
+.SH "OPTIONS"
+
+.RS
+
+.TP
+-A \fIauth-username\fR:\fIpassword\fR
+Supply BASIC Authentication credentials to the server\&. The username and password are separated by a single : and sent on the wire base64 encoded\&. The string is sent regardless of whether the server needs it (\fIi\&.e\&.\fR, has sent an 401 authentication needed)\&.
+.TP
+-c \fIconcurrency\fR
+Number of multiple requests to perform at a time\&. Default is one request at a time\&.
+.TP
+-C \fIcookie-name\fR=\fIvalue\fR
+Add a Cookie: line to the request\&. The argument is typically in the form of a \fIname\fR=\fIvalue\fR pair\&. This field is repeatable\&.
+.TP
+-d
+Do not display the "percentage served within XX [ms] table"\&. (legacy support)\&.
+.TP
+-e \fIcsv-file\fR
+Write a Comma separated value (CSV) file which contains for each percentage (from 1% to 100%) the time (in milli seconds) it took to serve that percentage of the requests\&. This is usually more useful than the 'gnuplot' file; as the results are already 'binned'\&.
+.TP
+-g \fIgnuplot-file\fR
+Write all measured values out as a 'gnuplot' or TSV (Tab separate values) file\&. This file can easily be imported into packages like Gnuplot, IDL, Mathematica, Igor or even Excell\&. The labels are on the first line of the file\&.
+.TP
+-h
+Display usage information\&.
+.TP
+-H \fIcustom-header\fR
+Append extra headers to the request\&. The argument is typically in the form of a valid header line, containing a colon-separated field-value pair (\fIi\&.e\&.\fR, "Accept-Encoding: zip/zop;8bit")\&.
+.TP
+-i
+Do HEAD requests instead of GET\&.
+.TP
+-k
+Enable the HTTP KeepAlive feature, \fIi\&.e\&.\fR, perform multiple requests within one HTTP session\&. Default is no KeepAlive\&.
+.TP
+-n \fIrequests\fR
+Number of requests to perform for the benchmarking session\&. The default is to just perform a single request which usually leads to non-representative benchmarking results\&.
+.TP
+-p \fIPOST-file\fR
+File containing data to POST\&.
+.TP
+-P \fIproxy-auth-username\fR:\fIpassword\fR
+Supply BASIC Authentication credentials to a proxy en-route\&. The username and password are separated by a single : and sent on the wire base64 encoded\&. The string is sent regardless of whether the proxy needs it (\fIi\&.e\&.\fR, has sent an 407 proxy authentication needed)\&.
+.TP
+-q
+When processing more than 150 requests, ab outputs a progress count on stderr every 10% or 100 requests or so\&. The -q flag will suppress these messages\&.
+.TP
+-s
+When compiled in (ab -h will show you) use the SSL protected https rather than the http protocol\&. This feature is experimental and \fIvery\fR rudimentary\&. You probably do not want to use it\&.
+.TP
+-S
+Do not display the median and standard deviation values, nor display the warning/error messages when the average and median are more than one or two times the standard deviation apart\&. And default to the min/avg/max values\&. (legacy support)\&.
+.TP
+-t \fItimelimit\fR
+Maximum number of seconds to spend for benchmarking\&. This implies a -n 50000 internally\&. Use this to benchmark the server within a fixed total amount of time\&. Per default there is no timelimit\&.
+.TP
+-T \fIcontent-type\fR
+Content-type header to use for POST data\&.
+.TP
+-v \fIverbosity\fR
+Set verbosity level - 4 and above prints information on headers, 3 and above prints response codes (404, 200, etc\&.), 2 and above prints warnings and info\&.
+.TP
+-V
+Display version number and exit\&.
+.TP
+-w
+Print out results in HTML tables\&. Default table is two columns wide, with a white background\&.
+.TP
+-x \fI<table>-attributes\fR
+String to use as attributes for <table>\&. Attributes are inserted <table \fIhere\fR >\&.
+.TP
+-X \fIproxy\fR[:\fIport\fR]
+Use a proxy server for the requests\&.
+.TP
+-y \fI<tr>-attributes\fR
+String to use as attributes for <tr>\&.
+.TP
+-z \fI<td>-attributes\fR
+String to use as attributes for <td>\&.
+.RE
+
+.SH "BUGS"
+
+.PP
+There are various statically declared buffers of fixed length\&. Combined with the lazy parsing of the command line arguments, the response headers from the server and other external inputs, this might bite you\&.
+
+.PP
+It does not implement HTTP/1\&.x fully; only accepts some 'expected' forms of responses\&. The rather heavy use of strstr(3) shows up top in profile, which might indicate a performance problem; \fIi\&.e\&.\fR, you would measure the ab performance rather than the server's\&.
+
apachectl \- Apache HTTP Server Control Interface
.SH "SYNOPSIS"
-
+
.PP
When acting in pass-through mode, apachectl can take all the arguments available for the httpd binary\&.
-
+
.PP
\fBapachectl\fR [ \fIhttpd-argument\fR ]
-
+
.PP
When acting in SysV init mode, apachectl takes simple, one-word commands, defined below\&.
-
+
.PP
-\fBapachectl\fR\fIcommand\fR
-
+\fBapachectl\fR \fIcommand\fR
+
.SH "SUMMARY"
-
+
.PP
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\&.
-
+
.PP
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\&.
-
+
.PP
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\&.
-
+
.PP
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\&.
-
+
.SH "OPTIONS"
-
+
.PP
Only the SysV init-style options are defined here\&. Other arguments are defined on the httpd manual page\&.
-
+
.RS
-
+
.TP
start
-Start the Apache httpd daemon\&. Gives an error if it is already running\&. This is equivalent to apachectl -k start\&.
+Start the Apache httpd daemon\&. Gives an error if it is already running\&. This is equivalent to apachectl -k start\&.
.TP
stop
-Stops the Apache httpd daemon\&. This is equivalent to apachectl -k stop\&.
+Stops the Apache httpd daemon\&. This is equivalent to apachectl -k stop\&.
.TP
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\&.
+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\&.
.TP
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\&.
+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\&.
.TP
status
-Displays a brief status report\&. Similar to the fullstatus option, except that the list of requests currently being served is omitted\&.
+Displays a brief status report\&. Similar to the fullstatus option, except that the list of requests currently being served is omitted\&.
.TP
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 configuration files as in configtest before initiating the restart to make sure Apache doesn't die\&. This is equivalent to apachectl -k 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 configuration files as in configtest before initiating the restart to make sure Apache doesn't die\&. This is equivalent to apachectl -k graceful\&.
.TP
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\&.
+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\&.
.RE
-
+
.PP
The following additional option is available, but deprecated\&.
-
+
.RS
-
+
.TP
startssl
-This is equivalent to apachectl -k start -DSSL\&. We recommend that you use that command explicitly, or you adjust your httpd\&.conf to remove the <IfDefine> section so that SSL will always be available\&.
+This is equivalent to apachectl -k start -DSSL\&. We recommend that you use that command explicitly, or you adjust your httpd\&.conf to remove the <IfDefine> section so that SSL will always be available\&.
.RE
-
+
httpd \- Apache Hypertext Transfer Protocol Server
.SH "SYNOPSIS"
-
+
.PP
-\fBhttpd\fR [ -\fBd\fR\fIserverroot\fR ] [ -\fBf\fR\fIconfig\fR ] [ -\fBC\fR\fIdirective\fR ] [ -\fBc\fR\fIdirective\fR ] [ -\fBD\fR\fIparameter\fR ] [ -\fBe\fR\fIlevel\fR ] [ -\fBE\fR\fIfile\fR ] [ \fB-k\fR start|restart|graceful|stop ] [ -\fBR\fR\fIdirectory\fR ] [ -\fBh\fR ] [ -\fBl\fR ] [ -\fBL\fR ] [ -\fBS\fR ] [ -\fBt\fR ] [ -\fBv\fR ] [ -\fBV\fR ] [ -\fBX\fR ]
-
+\fBhttpd\fR [ -\fBd\fR \fIserverroot\fR ] [ -\fBf\fR \fIconfig\fR ] [ -\fBC\fR \fIdirective\fR ] [ -\fBc\fR \fIdirective\fR ] [ -\fBD\fR \fIparameter\fR ] [ -\fBe\fR \fIlevel\fR ] [ -\fBE\fR \fIfile\fR ] [ \fB-k\fR start|restart|graceful|stop ] [ -\fBR\fR \fIdirectory\fR ] [ -\fBh\fR ] [ -\fBl\fR ] [ -\fBL\fR ] [ -\fBS\fR ] [ -\fBt\fR ] [ -\fBv\fR ] [ -\fBV\fR ] [ -\fBX\fR ]
+
.PP
On Windows systems, the following additional arguments are available:
-
+
.PP
-\fBhttpd\fR [ -\fBk\fR install|config|uninstall ] [ -\fBn\fR\fIname\fR ] [ -\fBw\fR ]
-
+\fBhttpd\fR [ -\fBk\fR install|config|uninstall ] [ -\fBn\fR \fIname\fR ] [ -\fBw\fR ]
+
.SH "SUMMARY"
-
+
.PP
httpd is the Apache HyperText Transfer Protocol (HTTP) server program\&. It is designed to be run as a standalone daemon process\&. When used like this it will create a pool of child processes or threads to handle requests\&.
-
+
.PP
In general, httpd should not be invoked directly, but rather should be invoked via apachectl on Unix-based systems or as a service on Windows NT, 2000 and XP and as a console application on Windows 9x and ME\&.
-
+
.SH "OPTIONS"
-
+
.RS
-
+
.TP
-d \fIserverroot\fR
-Set the initial value for the ServerRoot directive to \fIserverroot\fR\&. This can be overridden by the ServerRoot directive in the configuration file\&. The default is /usr/local/apache2\&.
+Set the initial value for the ServerRoot directive to \fIserverroot\fR\&. This can be overridden by the ServerRoot directive in the configuration file\&. The default is /usr/local/apache2\&.
.TP
-f \fIconfig\fR
-Uses the directives in the file \fIconfig\fR on startup\&. If \fIconfig\fR does not begin with a /, then it is taken to be a path relative to the ServerRoot\&. The default is conf/httpd\&.conf\&.
+Uses the directives in the file \fIconfig\fR on startup\&. If \fIconfig\fR does not begin with a /, then it is taken to be a path relative to the ServerRoot\&. The default is conf/httpd\&.conf\&.
.TP
-k start|restart|graceful|stop
-Signals httpd to start, restart, or stop\&. See Stopping Apache for more information\&.
+Signals httpd to start, restart, or stop\&. See Stopping Apache for more information\&.
.TP
-C \fIdirective\fR
-Process the configuration \fIdirective\fR before reading config files\&.
+Process the configuration \fIdirective\fR before reading config files\&.
.TP
-c \fIdirective\fR
-Process the configuration \fIdirective\fR after reading config files\&.
+Process the configuration \fIdirective\fR after reading config files\&.
.TP
-D \fIparameter\fR
-Sets a configuration \fIparameter \fRwhich can be used with <IfDefine> sections in the configuration files to conditionally skip or process commands at server startup and restart\&.
+Sets a configuration \fIparameter \fRwhich can be used with <IfDefine> sections in the configuration files to conditionally skip or process commands at server startup and restart\&.
.TP
-e \fIlevel\fR
-Sets the LogLevel to \fIlevel\fR during server startup\&. This is useful for temporarily increasing the verbosity of the error messages to find problems during startup\&.
+Sets the LogLevel to \fIlevel\fR during server startup\&. This is useful for temporarily increasing the verbosity of the error messages to find problems during startup\&.
.TP
-E \fIfile\fR
-Send error messages during server startup to \fIfile\fR\&.
+Send error messages during server startup to \fIfile\fR\&.
.TP
-R \fIdirectory\fR
-When the server is compiled using the SHARED_CORE rule, this specifies the \fIdirectory\fR for the shared object files\&.
+When the server is compiled using the SHARED_CORE rule, this specifies the \fIdirectory\fR for the shared object files\&.
.TP
-h
-Output a short summary of available command line options\&.
+Output a short summary of available command line options\&.
.TP
-l
-Output a list of modules compiled into the server\&. This will \fBnot\fR list dynamically loaded modules included using the LoadModule directive\&.
+Output a list of modules compiled into the server\&. This will \fBnot\fR list dynamically loaded modules included using the LoadModule directive\&.
.TP
-L
-Output a list of directives together with expected arguments and places where the directive is valid\&.
+Output a list of directives together with expected arguments and places where the directive is valid\&.
.TP
-S
-Show the settings as parsed from the config file (currently only shows the virtualhost settings)\&.
+Show the settings as parsed from the config file (currently only shows the virtualhost settings)\&.
.TP
-t
-Run syntax tests for configuration files only\&. The program immediately exits after these syntax parsing with either a return code of 0 (Syntax OK) or return code not equal to 0 (Syntax Error)\&. If -D \fIDUMP\fR_\fIVHOSTS \fRis also set, details of the virtual host configuration will be printed\&.
+Run syntax tests for configuration files only\&. The program immediately exits after these syntax parsing with either a return code of 0 (Syntax OK) or return code not equal to 0 (Syntax Error)\&. If -D \fIDUMP\fR_\fIVHOSTS \fRis also set, details of the virtual host configuration will be printed\&.
.TP
-v
-Print the version of httpd, and then exit\&.
+Print the version of httpd, and then exit\&.
.TP
-V
-Print the version and build parameters of httpd, and then exit\&.
+Print the version and build parameters of httpd, and then exit\&.
.TP
-X
-Run httpd in debug mode\&. Only one worker will be started and the server will not detach from the console\&.
+Run httpd in debug mode\&. Only one worker will be started and the server will not detach from the console\&.
.RE
-
+
.PP
The following arguments are available only on the Windows platform:
-
+
.RS
-
+
.TP
-k install|config|uninstall
-Install Apache as a Windows NT service; change startup options for the Apache service; and uninstall the Apache service\&.
+Install Apache as a Windows NT service; change startup options for the Apache service; and uninstall the Apache service\&.
.TP
-n \fIname\fR
-The \fIname\fR of the Apache service to signal\&.
+The \fIname\fR of the Apache service to signal\&.
.TP
-w
-Keep the console window open on error so that the error message can be read\&.
+Keep the console window open on error so that the error message can be read\&.
.RE
-
+
logresolve \- Resolve IP-addresses to hostnames in Apache log files
.SH "SYNOPSIS"
-
+
.PP
-\fBlogresolve\fR [ -\fBs\fR\fIfilename\fR ] [ -\fBc\fR ] < \fIaccess_log\fR > \fIaccess_log\&.new\fR
-
+\fBlogresolve\fR [ -\fBs\fR \fIfilename\fR ] [ -\fBc\fR ] < \fIaccess_log\fR > \fIaccess_log\&.new\fR
+
.SH "SUMMARY"
-
+
.PP
logresolve is a post-processing program to resolve IP-addresses in Apache's access logfiles\&. To minimize impact on your nameserver, logresolve has its very own internal hash-table cache\&. This means that each IP number will only be looked up the first time it is found in the log file\&.
-
+
.PP
Takes an Apache log file on standard input\&. The IP addresses must be the first thing on each line and must be seperated from the remainder of the line by a space\&.
-
+
.SH "OPTIONS"
-
+
.RS
-
+
.TP
-s \fIfilename\fR
-Specifies a filename to record statistics\&.
+Specifies a filename to record statistics\&.
.TP
-c
-This causes logresolve to apply some DNS checks: after finding the hostname from the IP address, it looks up the IP addresses for the hostname and checks that one of these matches the original address\&.
+This causes logresolve to apply some DNS checks: after finding the hostname from the IP address, it looks up the IP addresses for the hostname and checks that one of these matches the original address\&.
.RE
-
+
rotatelogs \- Piped logging program to rotate Apache logs
.SH "SYNOPSIS"
-
+
.PP
-\fBrotatelogs\fR\fIlogfile\fR [ \fIrotationtime\fR [ \fIoffset\fR ]] | [ \fIfilesize\fRM ]
-
+\fBrotatelogs\fR \fIlogfile\fR [ \fIrotationtime\fR [ \fIoffset\fR ]] | [ \fIfilesize\fRM ]
+
.SH "SUMMARY"
-
+
.PP
rotatelogs is a simple program for use in conjunction with Apache's piped logfile feature\&. For example:
-
+
.nf
CustomLog "|bin/rotatelogs /var/logs/logfile 86400" common
.fi
-
+
.PP
This creates the files /var/logs/logfile\&.nnnn where nnnn is the system time at which the log nominally starts (this time will always be a multiple of the rotation time, so you can synchronize cron scripts with it)\&. At the end of each rota- tion time (here after 24 hours) a new log is started\&.
-
+
.nf
CustomLog "|bin/rotatelogs /var/logs/logfile 5M" common
.fi
-
+
.PP
This configuration will rotate the logfile whenever it reaches a size of 5 megabytes\&.
-
+
.SH "OPTIONS"
-
+
.RS
-
+
.TP
\fIlogfile\fR
-The path plus basename of the logfile\&. If \fIlogfile\fR includes any '%' characters, it is treated as a format string for strftime(3)\&. Otherwise, the suffix \fI\&.nnnnnnnnnn\fR is automatically added and is the time in seconds\&. Both formats compute the start time from the beginning of the current period\&.
+The path plus basename of the logfile\&. If \fIlogfile\fR includes any '%' characters, it is treated as a format string for strftime(3)\&. Otherwise, the suffix \fI\&.nnnnnnnnnn\fR is automatically added and is the time in seconds\&. Both formats compute the start time from the beginning of the current period\&.
.TP
\fIrotationtime\fR
-The time between log file rotations in seconds\&.
+The time between log file rotations in seconds\&.
.TP
\fIoffset\fR
-The number of minutes offset from UTC\&. If omitted, zero is assumed and UTC is used\&. For example, to use local time in the zone UTC -5 hours, specify a value of -300 for this argument\&.
+The number of minutes offset from UTC\&. If omitted, zero is assumed and UTC is used\&. For example, to use local time in the zone UTC -5 hours, specify a value of -300 for this argument\&.
.TP
\fIfilesize\fRM
-The maximum file size in megabytes followed by the letter M to specify size rather than time\&. Use this parameter in place of both rotationtime and offset\&.
+The maximum file size in megabytes followed by the letter M to specify size rather than time\&. Use this parameter in place of both rotationtime and offset\&.
.RE
-
+
.SH "PORTABILITY"
-
+
.PP
The following logfile format string substitutions should be supported by all strftime(3) implementations, see the strftime(3) man page for library-specific extensions\&.
-
+
.Ip "\(bu \s-1%A\s0 \- full weekday name (localized)
-
+
.Ip "\(bu \s-1%a\s0 \- 3-character weekday name (localized)
-
+
.Ip "\(bu \s-1%B\s0 \- full month name (localized)
-
+
.Ip "\(bu \s-1%b\s0 \- 3-character month name (localized)
-
+
.Ip "\(bu \s-1%c\s0 \- date and time (localized)
-
+
.Ip "\(bu \s-1%d\s0 \- 2-digit day of month
-
+
.Ip "\(bu \s-1%H\s0 \- 2-digit hour (24 hour clock)
-
+
.Ip "\(bu \s-1%I\s0 \- 2-digit hour (12 hour clock)
-
+
.Ip "\(bu \s-1%j\s0 \- 3-digit day of year
-
+
.Ip "\(bu \s-1%M\s0 \- 2-digit minute
-
+
.Ip "\(bu \s-1%m\s0 \- 2-digit month
-
+
.Ip "\(bu \s-1%p\s0 \- am/pm of 12 hour clock (localized)
-
+
.Ip "\(bu \s-1%S\s0 \- 2-digit second
-
+
.Ip "\(bu \s-1%U\s0 \- 2-digit week of year (Sunday first day of week)
-
+
.Ip "\(bu \s-1%W\s0 \- 2-digit week of year (Monday first day of week)
-
+
.Ip "\(bu \s-1%w\s0 \- 1-digit weekday (Sunday first day of week)
-
+
.Ip "\(bu \s-1%X\s0 \- time (localized)
-
+
.Ip "\(bu \s-1%x\s0 \- date (localized)
-
+
.Ip "\(bu \s-1%Y\s0 \- 4-digit year
-
+
.Ip "\(bu \s-1%y\s0 \- 2-digit year
-
+
.Ip "\(bu \s-1%Z\s0 \- time zone name
-
+
.Ip "\(bu \s-1%%\s0 \- literal `%'
-
+
suexec \- Switch user before executing external programs
.SH "SYNOPSIS"
-
+
.PP
\fBsuexec\fR -\fBV\fR
-
+
.SH "SUMMARY"
-
+
.PP
suexec is used by the Apache HTTP Server to switch to another user before executing CGI programs\&. In order to achieve this, it must run as root\&. Since the HTTP daemon normally doesn't run as root, the suexec executable needs the setuid bit set and must be owned by root\&. It should never be writable for any other person than root\&.
-
+
.PP
For further information about the concepts and and the security model of suexec please refer to the suexec documentation (http://httpd\&.apache\&.org/docs-2\&.1/suexec\&.html)\&.
-
+
.SH "OPTIONS"
-
+
.RS
-
+
.TP
-V
-If you are root, this option displays the compile options of suexec\&. For security reasons all configuration options are changable only at compile time\&.
+If you are root, this option displays the compile options of suexec\&. For security reasons all configuration options are changable only at compile time\&.
.RE
-
+
--- /dev/null
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ This file is generated from xml source: DO NOT EDIT
+ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+ -->
+<title>ab - Apache HTTP server benchmarking tool - Apache HTTP Server</title>
+<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
+<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
+<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
+<link href="../images/favicon.ico" rel="shortcut icon" /></head>
+<body id="manual-page"><div id="page-header">
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
+<p class="apache">Apache HTTP Server Version 2.1</p>
+<img alt="" src="../images/feather.gif" /></div>
+<div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
+<div id="path">
+<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.1</a> > <a href="./">Programs</a></div><div id="page-content"><div id="preamble"><h1>ab - Apache HTTP server benchmarking tool</h1>
+ <p><code>ab</code> is a tool for benchmarking your Apache Hypertext
+ Transfer Protocol (HTTP) server. It is designed to give you an impression
+ of how your current Apache installation performs. This especially shows
+ you how many requests per second your Apache installation is capable of
+ serving.</p>
+</div>
+<div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#synopsis">Synopsis</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#options">Options</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#bugs">Bugs</a></li>
+</ul><h3>See also</h3><ul class="seealso"><li><a href="httpd.html">httpd</a></li></ul></div>
+<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="synopsis" id="synopsis">Synopsis</a></h2>
+ <p><code><strong>ab</strong>
+ [ -<strong>A</strong> <var>auth-username</var>:<var>password</var> ]
+ [ -<strong>c</strong> <var>concurrency</var> ]
+ [ -<strong>C</strong> <var>cookie-name</var>=<var>value</var> ]
+ [ -<strong>d</strong> ]
+ [ -<strong>e</strong> <var>csv-file</var> ]
+ [ -<strong>g</strong> <var>gnuplot-file</var> ]
+ [ -<strong>h</strong> ]
+ [ -<strong>H</strong> <var>custom-header</var> ]
+ [ -<strong>i</strong> ]
+ [ -<strong>k</strong> ]
+ [ -<strong>n</strong> <var>requests</var> ]
+ [ -<strong>p</strong> <var>POST-file</var> ]
+ [ -<strong>P</strong> <var>proxy-auth-username</var>:<var>password</var> ]
+ [ -<strong>q</strong> ]
+ [ -<strong>s</strong> ]
+ [ -<strong>S</strong> ]
+ [ -<strong>t</strong> <var>timelimit</var> ]
+ [ -<strong>T</strong> <var>content-type</var> ]
+ [ -<strong>v</strong> <var>verbosity</var>]
+ [ -<strong>V</strong> ]
+ [ -<strong>w</strong> ]
+ [ -<strong>x</strong> <var><table>-attributes</var> ]
+ [ -<strong>X</strong> <var>proxy</var>[:<var>port</var>] ]
+ [ -<strong>y</strong> <var><tr>-attributes</var> ]
+ [ -<strong>z</strong> <var><td>-attributes</var> ]
+ [http://]<var>hostname</var>[:<var>port</var>]/<var>path</var></code></p>
+</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="options" id="options">Options</a></h2>
+ <dl>
+ <dt><code>-A <var>auth-username</var>:<var>password</var></code></dt>
+ <dd>Supply BASIC Authentication credentials to the server. The username and
+ password are separated by a single <code>:</code> and sent on the wire
+ base64 encoded. The string is sent regardless of whether the server needs
+ it (<em>i.e.</em>, has sent an 401 authentication needed).</dd>
+
+ <dt><code>-c <var>concurrency</var></code></dt>
+ <dd>Number of multiple requests to perform at a time. Default is one
+ request at a time.</dd>
+
+ <dt><code>-C <var>cookie-name</var>=<var>value</var></code></dt>
+ <dd>Add a <code>Cookie:</code> line to the request. The argument is
+ typically in the form of a <code><var>name</var>=<var>value</var></code>
+ pair. This field is repeatable.</dd>
+
+ <dt><code>-d</code></dt>
+ <dd>Do not display the "percentage served within XX [ms] table". (legacy
+ support).</dd>
+
+ <dt><code>-e <var>csv-file</var></code></dt>
+ <dd>Write a Comma separated value (CSV) file which contains for each
+ percentage (from 1% to 100%) the time (in milli seconds) it took to serve
+ that percentage of the requests. This is usually more useful than the
+ 'gnuplot' file; as the results are already 'binned'.</dd>
+
+ <dt><code>-g <var>gnuplot-file</var></code></dt>
+ <dd>Write all measured values out as a 'gnuplot' or TSV (Tab separate
+ values) file. This file can easily be imported into packages like Gnuplot,
+ IDL, Mathematica, Igor or even Excell. The labels are on the first line of
+ the file. </dd>
+
+ <dt><code>-h</code></dt>
+ <dd>Display usage information.</dd>
+
+ <dt><code>-H <var>custom-header</var></code></dt>
+ <dd>Append extra headers to the request. The argument is typically in
+ the form of a valid header line, containing a colon-separated field-value
+ pair (<em>i.e.</em>, <code>"Accept-Encoding: zip/zop;8bit"</code>).</dd>
+
+ <dt><code>-i</code></dt>
+ <dd>Do <code>HEAD</code> requests instead of <code>GET</code>.</dd>
+
+ <dt><code>-k</code></dt>
+ <dd>Enable the HTTP KeepAlive feature, <em>i.e.</em>, perform multiple
+ requests within one HTTP session. Default is no KeepAlive.</dd>
+
+ <dt><code>-n <var>requests</var></code></dt>
+ <dd>Number of requests to perform for the benchmarking session. The default
+ is to just perform a single request which usually leads to
+ non-representative benchmarking results.</dd>
+
+ <dt><code>-p <var>POST-file</var></code></dt>
+ <dd>File containing data to POST.</dd>
+
+ <dt><code>-P <var>proxy-auth-username</var>:<var>password</var></code></dt>
+ <dd>Supply BASIC Authentication credentials to a proxy en-route. The
+ username and password are separated by a single <code>:</code> and sent on
+ the wire base64 encoded. The string is sent regardless of whether the
+ proxy needs it (<em>i.e.</em>, has sent an 407 proxy authentication
+ needed).</dd>
+
+ <dt><code>-q</code></dt>
+ <dd>When processing more than 150 requests, <code>ab</code> outputs a
+ progress count on <code>stderr</code> every 10% or 100 requests or so. The
+ <code>-q</code> flag will suppress these messages.</dd>
+
+ <dt><code>-s</code></dt>
+ <dd>When compiled in (<code>ab -h</code> will show you) use the SSL
+ protected <code>https</code> rather than the <code>http</code> protocol.
+ This feature is experimental and <em>very</em> rudimentary. You probably
+ do not want to use it.</dd>
+
+ <dt><code>-S</code></dt>
+ <dd>Do not display the median and standard deviation values, nor display
+ the warning/error messages when the average and median are more than
+ one or two times the standard deviation apart. And default to the
+ min/avg/max values. (legacy support).</dd>
+
+ <dt><code>-t <var>timelimit</var></code></dt>
+ <dd>Maximum number of seconds to spend for benchmarking. This implies a
+ <code>-n 50000</code> internally. Use this to benchmark the server within a
+ fixed total amount of time. Per default there is no timelimit.</dd>
+
+ <dt><code>-T <var>content-type</var></code></dt>
+ <dd>Content-type header to use for POST data.</dd>
+
+ <dt><code>-v <var>verbosity</var></code></dt>
+ <dd>Set verbosity level - <code>4</code> and above prints information on
+ headers, <code>3</code> and above prints response codes (404, 200, etc.),
+ <code>2</code> and above prints warnings and info.</dd>
+
+ <dt><code>-V</code></dt>
+ <dd>Display version number and exit.</dd>
+
+ <dt><code>-w</code></dt>
+ <dd>Print out results in HTML tables. Default table is two columns wide,
+ with a white background.</dd>
+
+ <dt><code>-x <var><table>-attributes</var></code></dt>
+ <dd>String to use as attributes for <code><table></code>. Attributes
+ are inserted <code><table <var>here</var> ></code>.</dd>
+
+ <dt><code>-X <var>proxy</var>[:<var>port</var>]</code></dt>
+ <dd>Use a proxy server for the requests.</dd>
+
+ <dt><code>-y <var><tr>-attributes</var></code></dt>
+ <dd>String to use as attributes for <code><tr></code>.</dd>
+
+ <dt><code>-z <var><td>-attributes</var></code></dt>
+ <dd>String to use as attributes for <code><td></code>.</dd>
+ </dl>
+</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="bugs" id="bugs">Bugs</a></h2>
+ <p>There are various statically declared buffers of fixed length. Combined
+ with the lazy parsing of the command line arguments, the response headers
+ from the server and other external inputs, this might bite you.</p>
+
+ <p>It does not implement HTTP/1.x fully; only accepts some 'expected' forms
+ of responses. The rather heavy use of <code>strstr(3)</code> shows up top
+ in profile, which might indicate a performance problem; <em>i.e.</em>, you
+ would measure the <code>ab</code> performance rather than the server's.</p>
+</div></div>
+<div id="footer">
+<p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
+<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
+</body></html>
\ No newline at end of file
projects / apache / commitdiff