Commit 3260454c authored by Joshua Slive's avatar Joshua Slive
Browse files

Bring the HTML man pages up to speed with the nroff ones and 

change the format slightly.


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@87875 13f79535-47bb-0310-9956-ffa450edef68
parent 4ebf8b1b

docs/manual/programs/ab.html

+43 −40
Original line number Diff line number Diff line 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">

<HTML><HEAD><TITLE>Manual Page: ab  - Apache HTTP Server</TITLE></HEAD>

<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF"

VLINK="#000080" ALINK="#FF0000">

<html>

<head><title>Manual Page: ab  - Apache HTTP Server</title></head>

<body bgcolor="#ffffff" text="#000000" link="#0000ff"

vlink="#000080" alink="#ff0000">

<!--#include virtual="header.html" -->

<h1 align="center">Manual Page: ab</h1>

<!-- This document was autogenerated from the man page -->

<pre>

<strong>NAME</strong>
@@ -10,11 +12,11 @@ VLINK="#000080" ALINK="#FF0000"> 


<strong>SYNOPSIS</strong>

     <strong>ab </strong>[ -<strong>k </strong>] [ -<strong>n </strong><em>requests </em>] [ -<strong>t </strong><em>timelimit </em>] [ -<strong>c  </strong><em>concurrency</em>

     ]  [  -<strong>p </strong><em>POST file </em>] [ -<strong>A </strong><em>Authenticate username</em>:<em>password </em>] [

     -<strong>P </strong><em>Proxy Authenticate username</em>:<em>password </em>] [ -<strong>H </strong><em>Custom header</em>

     ]  [ -<strong>C </strong><em>Cookie name</em>=<em>value </em>] [ -<strong>T </strong><em>content</em>-<em>type </em>] [ -<strong>v </strong><em>verbos-</em>

     <em>ity </em>] ] [ -<strong>w </strong><em>output HTML </em>] ] [ -<strong>x </strong>&lt;<em>table</em>&gt; <em>attributes </em>]  ]  [

     -<strong>y   </strong>&lt;<em>tr</em>&gt;   <em>attributes   </em>]   ]   [   -<strong>z  </strong>&lt;<em>td</em>&gt;  <em>attributes  </em>]

     ] [ -<strong>p </strong><em>POST file </em>] [ -<strong>A </strong><em>Authentication username</em>:<em>password </em>] [

     -<strong>P </strong><em>Proxy Authentication  username</em>:<em>password  </em>]  [  -<strong>H  </strong><em>Custom</em>

     <em>header  </em>]  [ -<strong>C </strong><em>Cookie name</em>=<em>value </em>] [ -<strong>T </strong><em>content</em>-<em>type </em>] [ -<strong>v</strong>

     <em>verbosity </em>] ] [ -<strong>w </strong><em>output HTML </em>] ] [ -<strong>x </strong>&lt;<em>table</em>&gt; <em>attributes </em>]

     ]  [  -<strong>y  </strong>&lt;<em>tr</em>&gt;  <em>attributes  </em>]  ]  [  -<strong>z  </strong>&lt;<em>td</em>&gt;  <em>attributes  </em>]

     [<em>http</em>://]<em>hostname</em>[:<em>port</em>]/<em>path</em>



     <strong>ab </strong>[ -<strong>V </strong>] [ -<strong>h </strong>]
@@ -22,48 +24,49 @@ VLINK="#000080" ALINK="#FF0000"> 
<strong>DESCRIPTION</strong>

     <strong>ab </strong>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  instal-

     lation.   This  especially  shows  you how much requests per

     time your Apache installation is capable to serve.

     impression of how your current Apache installation performs.

     This  especially shows you how many requests per second your

     Apache installation is capable of serving.



<strong>OPTIONS</strong>

     -<strong>k          </strong>Enable the HTTP KeepAlive feature, i.e.  perform

                 multiple   requests   within  one  HTTP  session

                 instead. Default is no KeepAlive.

     -<strong>k          </strong>Enable the HTTP KeepAlive feature, i.e., perform

                 multiple   requests  within  one  HTTP  session.

                 Default is no KeepAlive.



     -<strong>n </strong><em>requests </em>Number of requests to perform for the benchmark-

                 ing session.  The default is to just perform one

                 single request which usually leads to  not  very

                 ing  session.   The default is to just perform a

                 single  request  which  usually  leads  to  non-

                 representative benchmarking results.



     -<strong>t </strong><em>timelimit</em>

                 Seconds to max.  spend  for  benchmarking.  This

                 implies  a  -<strong>n  50000  </strong>internally.  Use  this to

                 benchmark the server within a fixed total amount

                 of time.  Per default there is no timelimit.

                 Maximum number of seconds to  spend  for  bench-

                 marking. This implies a -<strong>n 50000 </strong>internally. Use

                 this to benchmark  the  server  within  a  fixed

                 total  amount  of time.  Per default there is no

                 timelimit.



     -<strong>c </strong><em>concurrency</em>

                 Number of multiple requests per time to perform.

                 Default is one request per time.

                 Number of multiple  requests  to  perform  at  a

                 time. Default is one request at a time.



     -<strong>p </strong><em>POST file</em>

                 File containing data to POST.



     -<strong>A </strong><em>Authorization username</em>:<em>password</em>

                 Supply BASIC Authentification credentials to the

     -<strong>A </strong><em>Authentication username</em>:<em>password</em>

                 Supply BASIC Authentication 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).

                 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  authen-

                 tication needed).



     -<strong>p </strong><em>Proxy</em>-<em>Authorization username</em>:<em>password</em>

                 Supply BASIC Authentification credentials  to  a

     -<strong>p </strong><em>Proxy</em>-<em>Authentication username</em>:<em>password</em>

                 Supply BASIC  Authentication  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).

                 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).



     -<strong>C </strong><em>Cookie name</em>=<em>value</em>

                 Add a 'Cookie:' line to the request.  The  argu-
@@ -71,10 +74,10 @@ VLINK="#000080" ALINK="#FF0000"> 
                 pair. This field is repeatable.



     -<strong>p </strong><em>Header string</em>

                 Postfix extra headers to the request. The  argu-

                 Append extra headers to the request.  The  argu-

                 ment  is typically in the form of a valid header

                 line; containing a colon separated  field  value

                 pair. (i.e.

                 line, containing a  colon-separated  field-value

                 pair.  (i.e., 'Accept-Encoding: zip/zop;8bit').



     -<strong>T </strong><em>content</em>-<em>type</em>

                 Content-type header to use for POST data.
@@ -105,12 +108,12 @@ VLINK="#000080" ALINK="#FF0000"> 
     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.

     external inputs, this might bite you.



     It does not implement  HTTP/1.x  fully;  only  accepts  some

     'expected'  forms  of  responses.  The  rather  heavy use of

     <strong>strstr(3) </strong>shows up top in profile, which  might  indicate  a

     performance  problem;  i.e. you would measure the <strong>ab </strong>perfor-

     performance  problem; i.e., you would measure the <strong>ab </strong>perfor-

     mance rather than the server's.



<strong>SEE ALSO</strong>
@@ -118,4 +121,4 @@ VLINK="#000080" ALINK="#FF0000"> 


</pre>

<!--#include virtual="footer.html" -->

</BODY></HTML>
 
</body></html>

docs/manual/programs/apachectl.html

+8 −6
Original line number Diff line number Diff line 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">

<HTML><HEAD><TITLE>Manual Page: apachectl  - Apache HTTP Server</TITLE></HEAD>

<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF"

VLINK="#000080" ALINK="#FF0000">

<html>

<head><title>Manual Page: apachectl  - Apache HTTP Server</title></head>

<body bgcolor="#ffffff" text="#000000" link="#0000ff"

vlink="#000080" alink="#ff0000">

<!--#include virtual="header.html" -->

<h1 align="center">Manual Page: apachectl</h1>

<!-- This document was autogenerated from the man page -->

<pre>

<strong>NAME</strong>
@@ -26,7 +28,7 @@ VLINK="#000080" ALINK="#FF0000"> 
     in the script.



     Full   documentation   for   Apache    is    available    at

     <strong>http://www.apache.org/</strong>

     <strong>http://httpd.apache.org/</strong>



<strong>OPTIONS</strong>

     The <em>command </em>can be any one or more of the following options:
@@ -55,7 +57,7 @@ VLINK="#000080" ALINK="#FF0000"> 
                 requests currently being served is omitted.



     <strong>graceful    </strong>Gracefully restarts the Apache daemon by sending

                 it  a SIGUSR1.  If the daemon is not running, it

                 it a SIGWINCH.  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
@@ -79,4 +81,4 @@ VLINK="#000080" ALINK="#FF0000"> 


</pre>

<!--#include virtual="footer.html" -->

</BODY></HTML>
 
</body></html>

docs/manual/programs/apxs.html

+18 −16
Original line number Diff line number Diff line 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">

<HTML><HEAD><TITLE>Manual Page: apxs  - Apache HTTP Server</TITLE></HEAD>

<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF"

VLINK="#000080" ALINK="#FF0000">

<html>

<head><title>Manual Page: apxs  - Apache HTTP Server</title></head>

<body bgcolor="#ffffff" text="#000000" link="#0000ff"

vlink="#000080" alink="#ff0000">

<!--#include virtual="header.html" -->

<h1 align="center">Manual Page: apxs</h1>

<!-- This document was autogenerated from the man page -->

<pre>

<strong>NAME</strong>
@@ -47,8 +49,8 @@ VLINK="#000080" ALINK="#FF0000"> 
       $ apxs -i -a -c mod_foo.c

       gcc -fpic -DSHARED_MODULE -I/path/to/apache/include -c mod_foo.c

       ld -Bshareable -o mod_foo.so mod_foo.o

       cp mod_foo.so /path/to/apache/libexec/mod_foo.so

       chmod 755 /path/to/apache/libexec/mod_foo.so

       cp mod_foo.so /path/to/apache/modules/mod_foo.so

       chmod 755 /path/to/apache/modules/mod_foo.so

       [activating module `foo' in /path/to/apache/etc/httpd.conf]

       $ apachectl restart

       /path/to/apache/sbin/apachectl restart: httpd not running, trying to start
@@ -58,11 +60,11 @@ VLINK="#000080" ALINK="#FF0000"> 


     The arguments <em>files </em>can be any C source file (.c), a  object

     file  (.o)  or  even  a  library archive (.a). The <strong>apxs </strong>tool

     automatically recognizes these extensions and  automtaically

     automatically recognizes these extensions and  automatically

     used the C source files for compilation while just using the

     object and archive files for the  linking  phase.  But  when

     using  such pre-compiled objects make sure they are compiled

     for position independend code (PIC) to be able to  use  them

     for position independent code (PIC) to be able to  use  them

     for  a  dynamically loaded shared object.  For instance with

     GCC you always just have to use <strong>-fpic</strong>.   For  other  C  com-

     pilers  consult  its  manual  page or at watch for the flags
@@ -166,7 +168,7 @@ VLINK="#000080" ALINK="#FF0000"> 


     -<strong>i          </strong>This indicates the  installation  operation  and

                 installs  one or more dynamically shared objects

                 into the server's <em>libexec </em>directory.

                 into the server's <em>modules </em>directory.



     -<strong>a          </strong>This  activates  the  module  by   automatically

                 adding   a   corresponding  <strong>LoadModule  </strong>line  to
@@ -199,22 +201,22 @@ VLINK="#000080" ALINK="#FF0000"> 
     Then you have to update the Apache configuration  by  making

     sure  a  <strong>LoadModule </strong>directive is present to load this shared

     object. To simplify this step <strong>apxs </strong>provides an automatic way

     to  install the shared object in its "libexec" directory and

     to  install the shared object in its "modules" directory and

     updating  the  <strong>httpd.conf  </strong>file  accordingly.  This  can  be

     achieved by running:



       $ apxs -i -a mod_foo.c

       cp mod_foo.so /path/to/apache/libexec/mod_foo.so

       chmod 755 /path/to/apache/libexec/mod_foo.so

       cp mod_foo.so /path/to/apache/modules/mod_foo.so

       chmod 755 /path/to/apache/modules/mod_foo.so

       [activating module `foo' in /path/to/apache/etc/httpd.conf]

       $ _



     This way a line named



       LoadModule foo_module libexec/mod_foo.so

       LoadModule foo_module modules/mod_foo.so



     is added to the configuration file if still not present.  If

     you  want  to have this this disabled per default use the -<strong>A</strong>

     you  want  to  have  this  disabled  per  default use the -<strong>A</strong>

     option, i.e.



       $ apxs -i -A mod_foo.c
@@ -238,8 +240,8 @@ VLINK="#000080" ALINK="#FF0000"> 
       gcc -fpic -DSHARED_MODULE -I/path/to/apache/include -c mod_foo.c

       ld -Bshareable -o mod_foo.so mod_foo.o

       apxs -i -a -n "foo" mod_foo.so

       cp mod_foo.so /path/to/apache/libexec/mod_foo.so

       chmod 755 /path/to/apache/libexec/mod_foo.so

       cp mod_foo.so /path/to/apache/modules/mod_foo.so

       chmod 755 /path/to/apache/modules/mod_foo.so

       [activating module `foo' in /path/to/apache/etc/httpd.conf]

       apachectl restart

       /path/to/apache/sbin/apachectl restart: httpd not running, trying to start
@@ -266,4 +268,4 @@ VLINK="#000080" ALINK="#FF0000"> 


</pre>

<!--#include virtual="footer.html" -->

</BODY></HTML>
 
</body></html>

docs/manual/programs/dbmmanage.html

+7 −5
Original line number Diff line number Diff line 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">

<HTML><HEAD><TITLE>Manual Page: dbmmanage  - Apache HTTP Server</TITLE></HEAD>

<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF"

VLINK="#000080" ALINK="#FF0000">

<html>

<head><title>Manual Page: dbmmanage  - Apache HTTP Server</title></head>

<body bgcolor="#ffffff" text="#000000" link="#0000ff"

vlink="#000080" alink="#ff0000">

<!--#include virtual="header.html" -->

<h1 align="center">Manual Page: dbmmanage</h1>

<!-- This document was autogenerated from the man page -->

<pre>

<strong>NAME</strong>
@@ -62,7 +64,7 @@ VLINK="#000080" ALINK="#FF0000"> 


<strong>BUGS</strong>

     One should be aware that there are a number of different DBM

     file   formats   in  existance,  and  with  all  likelihood,

     file   formats   in  existence,  and  with  all  likelihood,

     libraries for more than one format may exist on your system.

     The three primary examples are NDBM, the GNU project's GDBM,

     and Berkeley DB 2.  Unfortunately, all these  libraries  use
@@ -100,4 +102,4 @@ VLINK="#000080" ALINK="#FF0000"> 


</pre>

<!--#include virtual="footer.html" -->

</BODY></HTML>
 
</body></html>

docs/manual/programs/htdigest.html

+6 −4
Original line number Diff line number Diff line 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">

<HTML><HEAD><TITLE>Manual Page: htdigest  - Apache HTTP Server</TITLE></HEAD>

<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF"

VLINK="#000080" ALINK="#FF0000">

<html>

<head><title>Manual Page: htdigest  - Apache HTTP Server</title></head>

<body bgcolor="#ffffff" text="#000000" link="#0000ff"

vlink="#000080" alink="#ff0000">

<!--#include virtual="header.html" -->

<h1 align="center">Manual Page: htdigest</h1>

<!-- This document was autogenerated from the man page -->

<pre>

<strong>NAME</strong>
@@ -47,4 +49,4 @@ VLINK="#000080" ALINK="#FF0000"> 


</pre>

<!--#include virtual="footer.html" -->

</BODY></HTML>
 
</body></html>