documentation/5489: ab man page contains many errors.

[David MacKenzie <dj...@web.us.uu.net>]

>Number:         5489
>Category:       documentation
>Synopsis:       ab man page contains many errors.
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    apache
>State:          open
>Class:          doc-bug
>Submitter-Id:   apache
>Arrival-Date:   Fri Dec 17 08:20:01 PST 1999
>Last-Modified:
>Originator:     djm@web.us.uu.net
>Organization:
apache
>Release:        1.3.9
>Environment:
All environments.
>Description:
ab man page contains errors in troff formatting, spelling, punctuation,
English idiom, and factual detail.
>How-To-Repeat:
Have a good English speaker read the man page.
>Fix:
This box is awfully small on the bug reporting form.

--- ab.8        1999/09/08 03:47:01     1.1.1.2
+++ ab.8        1999/12/17 16:15:13
@@ -103,14 +103,15 @@
 .SH DESCRIPTION
 .B ab
 is a tool for benchmarking your Apache HyperText Transfer Protocol (HTTP)
-server. It is designed to give you an impression on how performant is your
-current Apache installation.  This especially shows you how much requests per
-time your Apache installation is capable to serve. 
+server. It is designed to give you an impression on how well your
+current Apache installation performs.
+This especially shows you how many requests per
+unit of time your Apache installation is capable of serving. 
 .PP
 .SH OPTIONS
 .TP 12
 .B \-k 
-Enable the HTTP KeepAlive feature, i.e. perform multiple requests within one
+Enable the HTTP KeepAlive feature, i.e., perform multiple requests within one
 HTTP session instead. Default is no KeepAlive.
 .TP 12
 .BI \-n " requests"
@@ -120,15 +121,17 @@
 .TP 12
 .BI \-t " timelimit"
 Seconds to max. spend for benchmarking. This implies
-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. 
+internally (though that can be overridden by a later
+.B \-n
+option).
+Use this to benchmark the server within a fixed total amount of
+time.  By default there is no timelimit. 
 .TP 12
 .BI \-c " concurrency"
-Number of multiple requests per time to perform. 
-Default is one request per time.
+Number of requests to send before waiting for a response.
+Default is one at a time.
 
 .TP 12
 .BI \-p " POST file"
@@ -136,17 +139,17 @@
 
 .TP 12
 .BI \-A " Authorization username:password"
-Supply BASIC Authentification credentials to the server. The username
-and password are separated by a single ':' and send on the wire uuencoded.
-The string is send regardless of wether the server needs it; (i.e. has
-send an 401. Authentifcation needed).
+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 401 Authorization Required).
 
 .TP 12
 .BI \-p " Proxy-Authorization username:password"
-Supply BASIC Authentification credentials to a proxy en-route. The username
-and password are separated by a single ':' and send on the wire uuencoded.
-The string is send regardless of wether the proxy needs it; (i.e. has
-send an 407 Proxy authentifcation needed).
+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 407 Proxy Authentication Required).
 
 .TP 12
 .BI \-C " Cookie name=value"
@@ -155,9 +158,9 @@
 
 .TP 12
 .BI \-p " Header string"
-Postfix 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').
+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').
 
 .TP 12
 .BI \-T " content-type"
@@ -201,10 +204,9 @@
 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
+which might indicate a performance problem; i.e., you would measure the
 .BR ab
 performance rather than the server's.
 
 .SH SEE ALSO
 .BR httpd(8)
-.
>Audit-Trail:
>Unformatted:
[In order for any reply to be added to the PR database, you need]
[to include <ap...@Apache.Org> in the Cc line and make sure the]
[subject line starts with the report component and number, with ]
[or without any 'Re:' prefixes (such as "general/1098:" or      ]
["Re: general/1098:").  If the subject doesn't match this       ]
[pattern, your message will be misfiled and ignored.  The       ]
["apbugs" address is not added to the Cc line of messages from  ]
[the database automatically because of the potential for mail   ]
[loops.  If you do not include this Cc, your reply may be ig-   ]
[nored unless you are responding to an explicit request from a  ]
[developer.  Reply only with text; DO NOT SEND ATTACHMENTS!     ]