From: Joshua Slive Date: Sat, 27 Jan 2001 23:16:22 +0000 (+0000) Subject: Bring the HTML man pages up to speed with the nroff ones and X-Git-Tag: APACHE_2_0_BETA_CANDIDATE_1~72 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=a0e0d6527b31c8878499643e617f1f86e16ebb86;p=apache 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 --- diff --git a/docs/manual/programs/ab.html b/docs/manual/programs/ab.html index 5cc22202d0..eda6305892 100644 --- a/docs/manual/programs/ab.html +++ b/docs/manual/programs/ab.html @@ -1,8 +1,10 @@ -Manual Page: ab - Apache HTTP Server - + +Manual Page: ab - Apache HTTP Server + +

Manual Page: ab

 NAME
@@ -10,11 +12,11 @@ VLINK="#000080" ALINK="#FF0000">
 
 SYNOPSIS
      ab [ -k ] [ -n requests ] [ -t timelimit ] [ -c  concurrency
-     ]  [  -p POST file ] [ -A Authenticate username:password ] [
-     -P Proxy Authenticate username:password ] [ -H Custom header
-     ]  [ -C Cookie name=value ] [ -T content-type ] [ -v verbos-
-     ity ] ] [ -w output HTML ] ] [ -x <table> attributes ]  ]  [
-     -y   <tr>   attributes   ]   ]   [   -z  <td>  attributes  ]
+     ] [ -p POST file ] [ -A Authentication username:password ] [
+     -P Proxy Authentication  username:password  ]  [  -H  Custom
+     header  ]  [ -C Cookie name=value ] [ -T content-type ] [ -v
+     verbosity ] ] [ -w output HTML ] ] [ -x <table> attributes ]
+     ]  [  -y  <tr>  attributes  ]  ]  [  -z  <td>  attributes  ]
      [http://]hostname[:port]/path
 
      ab [ -V ] [ -h ]
@@ -22,48 +24,49 @@ VLINK="#000080" ALINK="#FF0000">
 DESCRIPTION
      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  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.
 
 OPTIONS
-     -k          Enable the HTTP KeepAlive feature, i.e.  perform
-                 multiple   requests   within  one  HTTP  session
-                 instead. Default is no KeepAlive.
+     -k          Enable the HTTP KeepAlive feature, i.e., perform
+                 multiple   requests  within  one  HTTP  session.
+                 Default is no KeepAlive.
 
      -n requests 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.
 
      -t timelimit
-                 Seconds to max.  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.
+                 Maximum number of seconds to  spend  for  bench-
+                 marking. 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.
 
      -c concurrency
-                 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.
 
      -p POST file
                  File containing data to POST.
 
-     -A Authorization username:password
-                 Supply BASIC Authentification credentials to the
+     -A Authentication username:password
+                 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).
 
-     -p Proxy-Authorization username:password
-                 Supply BASIC Authentification credentials  to  a
+     -p Proxy-Authentication username:password
+                 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).
 
      -C Cookie name=value
                  Add a 'Cookie:' line to the request.  The  argu-
@@ -71,10 +74,10 @@ VLINK="#000080" ALINK="#FF0000">
                  pair. This field is repeatable.
 
      -p Header string
-                 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').
 
      -T content-type
                  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
      strstr(3) shows up top in profile, which  might  indicate  a
-     performance  problem;  i.e. you would measure the ab perfor-
+     performance  problem; i.e., you would measure the ab perfor-
      mance rather than the server's.
 
 SEE ALSO
@@ -118,4 +121,4 @@ VLINK="#000080" ALINK="#FF0000">
 
 
- + diff --git a/docs/manual/programs/apachectl.html b/docs/manual/programs/apachectl.html index b16a717961..15f6b7433a 100644 --- a/docs/manual/programs/apachectl.html +++ b/docs/manual/programs/apachectl.html @@ -1,8 +1,10 @@ -Manual Page: apachectl - Apache HTTP Server - + +Manual Page: apachectl - Apache HTTP Server + +

Manual Page: apachectl

 NAME
@@ -26,7 +28,7 @@ VLINK="#000080" ALINK="#FF0000">
      in the script.
 
      Full   documentation   for   Apache    is    available    at
-     http://www.apache.org/
+     http://httpd.apache.org/
 
 OPTIONS
      The command can be any one or more of the following options:
@@ -55,7 +57,7 @@ VLINK="#000080" ALINK="#FF0000">
                  requests currently being served is omitted.
 
      graceful    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">
 
 
- + diff --git a/docs/manual/programs/apxs.html b/docs/manual/programs/apxs.html index 14ff1965c9..38418cac70 100644 --- a/docs/manual/programs/apxs.html +++ b/docs/manual/programs/apxs.html @@ -1,8 +1,10 @@ -Manual Page: apxs - Apache HTTP Server - + +Manual Page: apxs - Apache HTTP Server + +

Manual Page: apxs

 NAME
@@ -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 files can be any C source file (.c), a  object
      file  (.o)  or  even  a  library archive (.a). The apxs 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 -fpic.   For  other  C  com-
      pilers  consult  its  manual  page or at watch for the flags
@@ -166,7 +168,7 @@ VLINK="#000080" ALINK="#FF0000">
 
      -i          This indicates the  installation  operation  and
                  installs  one or more dynamically shared objects
-                 into the server's libexec directory.
+                 into the server's modules directory.
 
      -a          This  activates  the  module  by   automatically
                  adding   a   corresponding  LoadModule  line  to
@@ -199,22 +201,22 @@ VLINK="#000080" ALINK="#FF0000">
      Then you have to update the Apache configuration  by  making
      sure  a  LoadModule directive is present to load this shared
      object. To simplify this step apxs 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  httpd.conf  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 -A
+     you  want  to  have  this  disabled  per  default use the -A
      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">
 
 
- + diff --git a/docs/manual/programs/dbmmanage.html b/docs/manual/programs/dbmmanage.html index da860698f5..45ec0672d4 100644 --- a/docs/manual/programs/dbmmanage.html +++ b/docs/manual/programs/dbmmanage.html @@ -1,8 +1,10 @@ -Manual Page: dbmmanage - Apache HTTP Server - + +Manual Page: dbmmanage - Apache HTTP Server + +

Manual Page: dbmmanage

 NAME
@@ -62,7 +64,7 @@ VLINK="#000080" ALINK="#FF0000">
 
 BUGS
      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">
 
 
- + diff --git a/docs/manual/programs/htdigest.html b/docs/manual/programs/htdigest.html index 1891e0d066..c4c00f813e 100644 --- a/docs/manual/programs/htdigest.html +++ b/docs/manual/programs/htdigest.html @@ -1,8 +1,10 @@ -Manual Page: htdigest - Apache HTTP Server - + +Manual Page: htdigest - Apache HTTP Server + +

Manual Page: htdigest

 NAME
@@ -47,4 +49,4 @@ VLINK="#000080" ALINK="#FF0000">
 
 
- + diff --git a/docs/manual/programs/htpasswd.html b/docs/manual/programs/htpasswd.html index 6c95b6d77e..9088b8495f 100644 --- a/docs/manual/programs/htpasswd.html +++ b/docs/manual/programs/htpasswd.html @@ -1,8 +1,10 @@ -Manual Page: htpasswd - Apache HTTP Server - + +Manual Page: htpasswd - Apache HTTP Server + +

Manual Page: htpasswd

 NAME
@@ -69,12 +71,12 @@ VLINK="#000080" ALINK="#FF0000">
           ported by htpasswd on all platforms,  it  is  not  sup-
           ported by the httpd server on Windows and TPF.
 
-     -s   Use SHA encryption for passwords. Faciliates  migration
+     -s   Use SHA encryption for passwords. Facilitates migration
           from/to  Netscape  servers  using  the  LDAP  Directory
           Interchange Format (ldif).
 
      -p   Use plaintext passwords. Though htpasswd  will  support
-          creation  on  all platofrms, the httpd deamon will only
+          creation  on  all platforms, the httpd daemon will only
           accept plain text passwords on Windows and TPF.
 
      passwdfile
@@ -155,4 +157,4 @@ VLINK="#000080" ALINK="#FF0000">
 
 
- + diff --git a/docs/manual/programs/httpd.html b/docs/manual/programs/httpd.html index ff5a16f462..c69a53f2d4 100644 --- a/docs/manual/programs/httpd.html +++ b/docs/manual/programs/httpd.html @@ -1,19 +1,20 @@ -Manual Page: httpd - Apache HTTP Server - + +Manual Page: httpd - Apache HTTP Server + +

Manual Page: httpd

 NAME
      httpd - Apache hypertext transfer protocol server
 
 SYNOPSIS
-     httpd [ -X ] [ -R libexecdir ] [ -d serverroot ] [ -f config
-     ] [ -C directive ] [ -c directive ] [ -D parameter ]
+     httpd [ -R libexecdir ] [ -d serverroot ] [ -f config ] [ -C
+     directive ] [ -c directive ] [ -D parameter ]
 
-     httpd [ -h ] [ -l ] [ -L ] [ -v ] [ -V ] [ -S ] [ -t ] [  -T
-     ]
+     httpd [ -h ] [ -l ] [ -L ] [ -v ] [ -V ] [ -t ] [ -T ]
 
 DESCRIPTION
      httpd is  the  Apache  HyperText  Transfer  Protocol  (HTTP)
@@ -22,14 +23,12 @@ VLINK="#000080" ALINK="#FF0000">
      child  processes to handle requests. To stop it, send a TERM
      signal to the initial (parent) process. The PID of this pro-
      cess  is  written  to  a  file as given in the configuration
-     file.  Alternatively httpd may be invoked  by  the  Internet
-     daemon  inetd(8)  each time a connection to the HTTP service
-     is made.
+     file.
 
      This manual page only lists the command line arguments.  For
      details  of  the directives necessary to configure httpd see
      the Apache manual, which is part of the Apache  distribution
-     or  can  be  found  at http://www.apache.org/. Paths in this
+     or  can  be found at http://httpd.apache.org/. Paths in this
      manual may not reflect those compiled into httpd.
 
 OPTIONS
@@ -58,8 +57,8 @@ VLINK="#000080" ALINK="#FF0000">
                  ing config files.
 
      -c directive
-                 Process the configuration directive after  read-
-                 ing config files.
+                 Process  the   configuration   directive   after
+                 reading config files.
 
      -D parameter
                  Sets a configuration parameter which can be used
@@ -84,16 +83,13 @@ VLINK="#000080" ALINK="#FF0000">
                  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).
+                 Error).  If -D DUMP_VHOSTS is also set,  details
+                 of   the  virtual  host  configuration  will  be
+                 printed.
 
      -T          Same as option -t but does not check the config-
                  ured document roots.
 
-     -X          Run in single-process mode, for internal  debug-
-                 ging  purposes  only; the daemon does not detach
-                 from the terminal or fork any children.  Do  NOT
-                 use this mode to provide ordinary web service.
-
      -v          Print the version of httpd , and then exit.
 
      -V          Print the version and build parameters of  httpd
@@ -101,17 +97,12 @@ VLINK="#000080" ALINK="#FF0000">
 
 FILES
      /usr/local/apache/conf/httpd.conf
-     /usr/local/apache/conf/srm.conf
-     /usr/local/apache/conf/access.conf
      /usr/local/apache/conf/mime.types
      /usr/local/apache/conf/magic
      /usr/local/apache/logs/error_log
      /usr/local/apache/logs/access_log
      /usr/local/apache/logs/httpd.pid
 
-SEE ALSO
-     inetd(8).
-
 
- + diff --git a/docs/manual/programs/logresolve.html b/docs/manual/programs/logresolve.html index 32efc42934..1c5b1bd67e 100644 --- a/docs/manual/programs/logresolve.html +++ b/docs/manual/programs/logresolve.html @@ -1,13 +1,14 @@ -Manual Page: logresolve - Apache HTTP Server - + +Manual Page: logresolve - Apache HTTP Server + +

Manual Page: logresolve

-
 NAME
-     logresolve - resolve hostnames  for  IP-adresses  in  Apache
+     logresolve - resolve hostnames for  IP-addresses  in  Apache
      logfiles
 
 SYNOPSIS
@@ -16,10 +17,10 @@ VLINK="#000080" ALINK="#FF0000">
 
 DESCRIPTION
      logresolve is  a  post-processing  program  to  resolve  IP-
-     adresses 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.
+     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.
 
 OPTIONS
      -s filename Specifies a filename to record statistics.
@@ -35,4 +36,4 @@ VLINK="#000080" ALINK="#FF0000">
 
 
- + diff --git a/docs/manual/programs/rotatelogs.html b/docs/manual/programs/rotatelogs.html index 70d2295110..60f6a71f98 100644 --- a/docs/manual/programs/rotatelogs.html +++ b/docs/manual/programs/rotatelogs.html @@ -1,11 +1,12 @@ -Manual Page: rotatelogs - Apache HTTP Server - + +Manual Page: rotatelogs - Apache HTTP Server + +

Manual Page: rotatelogs

-
 NAME
      rotatelogs - rotate Apache logs without having to  kill  the
      server
@@ -39,4 +40,4 @@ VLINK="#000080" ALINK="#FF0000">
 
 
- + diff --git a/docs/manual/programs/suexec.html b/docs/manual/programs/suexec.html index f9f9b76a63..cad00ed48d 100644 --- a/docs/manual/programs/suexec.html +++ b/docs/manual/programs/suexec.html @@ -1,11 +1,12 @@ -Manual Page: suexec - Apache HTTP Server - + +Manual Page: suexec - Apache HTTP Server + +

Manual Page: suexec

-
 NAME
      suexec - Switch User For Exec
 
@@ -26,4 +27,4 @@ VLINK="#000080" ALINK="#FF0000">
 
 
- +