From: Joshua Slive Date: Thu, 18 Jan 2001 19:42:15 +0000 (+0000) Subject: Add html versions of unix man pages. Clearly, some of the man pages X-Git-Tag: APACHE_2_0_BETA_CANDIDATE_1~184 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=25fd6646347f61797c39894286c444ae7e0496e8;p=apache Add html versions of unix man pages. Clearly, some of the man pages have not been updated for 2.0. I will regenerate these html files after the man pages are updated. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@87713 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/index.html b/docs/manual/index.html index b6c0fcc684..250cd8de96 100644 --- a/docs/manual/index.html +++ b/docs/manual/index.html @@ -98,6 +98,8 @@ Modules: By Type or Multi-Processing Modules (MPMs) +Server and Supporting Programs + Dynamic Shared Object (DSO) Support diff --git a/docs/manual/index.html.en b/docs/manual/index.html.en index b6c0fcc684..250cd8de96 100644 --- a/docs/manual/index.html.en +++ b/docs/manual/index.html.en @@ -98,6 +98,8 @@ Modules: By Type or Multi-Processing Modules (MPMs) +Server and Supporting Programs + Dynamic Shared Object (DSO) Support diff --git a/docs/manual/programs/ab.html b/docs/manual/programs/ab.html new file mode 100644 index 0000000000..5cc22202d0 --- /dev/null +++ b/docs/manual/programs/ab.html @@ -0,0 +1,121 @@ + +Manual Page: ab - Apache HTTP Server + + + +
+NAME
+     ab - Apache HTTP server benchmarking tool
+
+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  ]
+     [http://]hostname[:port]/path
+
+     ab [ -V ] [ -h ]
+
+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.
+
+OPTIONS
+     -k          Enable the HTTP KeepAlive feature, i.e.  perform
+                 multiple   requests   within  one  HTTP  session
+                 instead. 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
+                 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.
+
+     -c concurrency
+                 Number of multiple requests per time to perform.
+                 Default is one request per time.
+
+     -p POST file
+                 File containing data to POST.
+
+     -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).
+
+     -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).
+
+     -C Cookie name=value
+                 Add a 'Cookie:' line to the request.  The  argu-
+                 ment  is typically in the form of a 'name=value'
+                 pair. This field is repeatable.
+
+     -p Header string
+                 Postfix 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.
+
+     -T content-type
+                 Content-type header to use for POST data.
+
+     -v          Set verbosity level - 4 and above prints  infor-
+                 mation  on  headers, 3 and above prints response
+                 codes (404, 200, etc.), 2 and above prints warn-
+                 ings and info.
+
+     -w          Print out results in HTML tables.  Default table
+                 is two columns wide, with a white background.
+
+     -x attributes
+                 String to use as attributes for <table>.  Attri-
+                 butes are inserted <table here >
+
+     -y attributes
+                 String to use as attributes for <tr>.
+
+     -z attributes
+                 String to use as attributes for <td>.
+
+     -V          Display version number and exit.
+
+     -h          Display usage information.
+
+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.
+
+     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-
+     mance rather than the server's.
+
+SEE ALSO
+     httpd(8)
+
+
+ + diff --git a/docs/manual/programs/apachectl.html b/docs/manual/programs/apachectl.html new file mode 100644 index 0000000000..b16a717961 --- /dev/null +++ b/docs/manual/programs/apachectl.html @@ -0,0 +1,82 @@ + +Manual Page: apachectl - Apache HTTP Server + + + +
+NAME
+     apachectl - Apache HTTP server control interface
+
+SYNOPSIS
+     apachectl command [...]
+
+DESCRIPTION
+     apachectl is a front end to the  Apache  HyperText  Transfer
+     Protocol (HTTP) server.  It is designed to help the adminis-
+     trator control the functioning of the Apache httpd daemon.
+
+     NOTE: If your Apache installation uses  non-standard  paths,
+     you  will  need  to  edit  the  apachectl  script to set the
+     appropriate paths to your PID file and  your  httpd  binary.
+     See the comments in the script for details.
+
+     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.
+
+     Full   documentation   for   Apache    is    available    at
+     http://www.apache.org/
+
+OPTIONS
+     The command can be any one or more of the following options:
+
+     start       Start the Apache daemon.  Gives an error  if  it
+                 is already running.
+
+     stop        Stops the Apache daemon.
+
+     restart     Restarts the  Apache  daemon  by  sending  it  a
+                 SIGHUP.   If  the  daemon  is not running, it is
+                 started.  This command automatically checks  the
+                 configuration  files  via configtest before ini-
+                 tiating the restart to make sure Apache  doesn't
+                 die.
+
+     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.
+
+     status      Displays a brief status report.  Similar to  the
+                 fullstatus  option,  except  that  the  list  of
+                 requests currently being served is omitted.
+
+     graceful    Gracefully restarts the Apache daemon by sending
+                 it  a SIGUSR1.  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 configura-
+                 tion files via configtest before initiating  the
+                 restart to make sure Apache doesn't die.
+
+     configtest  Run a configuration file syntax test. It  parses
+                 the  configuration files and either reports Syn-
+                 tax Ok or detailed information about the partic-
+                 ular syntax error.
+
+     help        Displays a short help message.
+
+SEE ALSO
+     httpd(8)
+
+
+ + diff --git a/docs/manual/programs/apxs.html b/docs/manual/programs/apxs.html new file mode 100644 index 0000000000..14ff1965c9 --- /dev/null +++ b/docs/manual/programs/apxs.html @@ -0,0 +1,269 @@ + +Manual Page: apxs - Apache HTTP Server + + + +
+NAME
+     apxs - APache eXtenSion tool
+
+SYNOPSIS
+     apxs -g [ -S name=value ] -n modname
+
+     apxs -q [ -S name=value ] query ...
+
+     apxs -c [ -S name=value ] [ -o dsofile ] [ -I incdir ] [  -D
+     name=value  ]  [  -L libdir ] [ -l libname ] [ -Wc,compiler-
+     flags ] [ -Wl,linker-flags ] files ...
+
+     apxs -i [ -S name=value ] [ -n modname ] [ -a ] [ -A ]  dso-
+     file ...
+
+     apxs -e [ -S name=value ] [ -n modname ] [ -a ] [ -A ]  dso-
+     file ...
+
+DESCRIPTION
+     apxs is a tool for building and installing extension modules
+     for  the  Apache  HyperText Transfer Protocol (HTTP) server.
+     This is achieved by building a dynamic shared  object  (DSO)
+     from  one  or  more source or object files which then can be
+     loaded into the Apache server under runtime via the  LoadMo-
+     dule directive from mod_so.
+
+     So to use this extension mechanism your platform has to sup-
+     port  the DSO feature and your Apache httpd binary has to be
+     built with the mod_so module.  The apxs  tool  automatically
+     complains if this is not the case.  You can check this your-
+     self by manually running the command
+
+       $ httpd -l
+
+     The module mod_so should be part of the displayed list.   If
+     these  requirements are fulfilled you can easily extend your
+     Apache server's functionality by installing your own modules
+     with the DSO mechanism by the help of this apxs tool:
+
+       $ 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
+       [activating module `foo' in /path/to/apache/etc/httpd.conf]
+       $ apachectl restart
+       /path/to/apache/sbin/apachectl restart: httpd not running, trying to start
+       [Tue Mar 31 11:27:55 1998] [debug] mod_so.c(303): loaded module foo_module
+       /path/to/apache/sbin/apachectl restart: httpd started
+       $ _
+
+     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
+     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  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
+     apxs uses to compile the object files.
+
+     For more details about DSO support in Apache read the  docu-
+     mentation    of    mod_so   or   perhaps   even   read   the
+     src/modules/standard/mod_so.c source file.
+
+OPTIONS
+     Common options:
+
+     -n modname  This explicitly sets the module name for the  -i
+                 (install)  and  -g (template generation) option.
+                 Use this to explicitly specify the module  name.
+                 For  option  -g  this is required, for option -i
+                 the apxs tool tries to determine the  name  from
+                 the source or (as a fallback) at least by guess-
+                 ing it from the filename.
+
+     Query options:
+
+     -q          Performs a query for apxs's knowledge about cer-
+                 tain  settings.  The query parameters can be one
+                 or more of the following strings:
+                   CC              TARGET
+                   CFLAGS          SBINDIR
+                   CFLAGS_SHLIB    INCLUDEDIR
+                   LD_SHLIB        LIBEXECDIR
+                   LDFLAGS_SHLIB   SYSCONFDIR
+                   LIBS_SHLIB
+                 Use this for manually determining settings.  For
+                 instance use
+                   INC=-I`apxs -q INCLUDEDIR`
+                 inside your own Makefiles  if  you  need  manual
+                 access to Apache's C header files.
+
+     Configuration options:
+
+     -S name=value
+                 This option changes the apxs settings  described
+                 above.
+
+     Template Generation options:
+
+     -g          This generates a subdirectory name  (see  option
+                 -n)  and there two files: A sample module source
+                 file named mod_name.c which can  be  used  as  a
+                 template  for  creating your own modules or as a
+                 quick start for playing with the APXS mechanism.
+                 And  a  corresponding  Makefile  for even easier
+                 build and installing of this module.
+
+     DSO compilation options:
+
+     -c          This indicates  the  compilation  operation.  It
+                 first  compiles the C source files (.c) of files
+                 into corresponding object files  (.o)  and  then
+                 builds a dynamically shared object in dsofile by
+                 linking these object files  plus  the  remaining
+                 object  files  (.o  and  .a)  of  files If no -o
+                 option is specified the output file  is  guessed
+                 from  the  first filename in files and thus usu-
+                 ally defaults to mod_name.so
+
+     -o dsofile  Explicitly specifies the filename of the created
+                 dynamically  shared object. If not specified and
+                 the name cannot be guessed from the files  list,
+                 the fallback name mod_unknown.so is used.
+
+     -D name=value
+                 This option is directly passed  through  to  the
+                 compilation  command(s).   Use  this to add your
+                 own defines to the build process.
+
+     -I incdir   This option is directly passed  through  to  the
+                 compilation  command(s).   Use  this to add your
+                 own include directories to search to  the  build
+                 process.
+
+     -L libdir   This option is directly passed  through  to  the
+                 linker  command.   Use  this  to  add  your  own
+                 library directories to search to the build  pro-
+                 cess.
+
+     -l libname  This option is directly passed  through  to  the
+                 linker  command.   Use  this  to  add  your  own
+                 libraries to search to the build process.
+
+     -Wc,compiler-flags
+                 This option passes compiler-flags as  additional
+                 flags  to the compiler command.  Use this to add
+                 local compiler-specific options.
+
+     -Wl,linker-flags
+                 This option passes  linker-flags  as  additional
+                 flags  to  the  linker command.  Use this to add
+                 local linker-specific options.
+
+     DSO installation and configuration options:
+
+     -i          This indicates the  installation  operation  and
+                 installs  one or more dynamically shared objects
+                 into the server's libexec directory.
+
+     -a          This  activates  the  module  by   automatically
+                 adding   a   corresponding  LoadModule  line  to
+                 Apache's httpd.conf configuration  file,  or  by
+                 enabling it if it already exists.
+
+     -A          Same as option -a  but  the  created  LoadModule
+                 directive is prefixed with a hash sign (#), i.e.
+                 the module is just prepared for later activation
+                 but initially disabled.
+
+     -e          This indicates the editing operation, which  can
+                 be  used with the -a and -A options similarly to
+                 the -i operation  to  edit  Apache's  httpd.conf
+                 configuration file without attempting to install
+                 the module.
+
+EXAMPLES
+     Assume you have an Apache module named  mod_foo.c  available
+     which should extend Apache's server functionality. To accom-
+     plish this you first have to compile the  C  source  into  a
+     shared  object  suitable  for loading into the Apache server
+     under runtime via the following command:
+
+       $ apxs -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
+       $ _
+
+     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
+     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
+       [activating module `foo' in /path/to/apache/etc/httpd.conf]
+       $ _
+
+     This way a line named
+
+       LoadModule foo_module libexec/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
+     option, i.e.
+
+       $ apxs -i -A mod_foo.c
+
+     For a quick test of the APXS mechanism you can create a sam-
+     ple  Apache  module  template  plus a corresponding Makefile
+     via:
+
+       $ apxs -g -n foo
+       Creating [DIR]  foo
+       Creating [FILE] foo/Makefile
+       Creating [FILE] foo/mod_foo.c
+       $ _
+
+     Then you can immediately compile this sample module  into  a
+     shared object and load it into the Apache server:
+
+       $ cd foo
+       $ make all reload
+       apxs -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
+       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
+       [activating module `foo' in /path/to/apache/etc/httpd.conf]
+       apachectl restart
+       /path/to/apache/sbin/apachectl restart: httpd not running, trying to start
+       [Tue Mar 31 11:27:55 1998] [debug] mod_so.c(303): loaded module foo_module
+       /path/to/apache/sbin/apachectl restart: httpd started
+       $ _
+
+     You can even use apxs to compile complex modules outside the
+     Apache source tree, like PHP3:
+
+       $ cd php3
+       $ ./configure --with-shared-apache=../apache-1.3
+       $ apxs -c -o libphp3.so mod_php3.c libmodphp3-so.a
+       gcc -fpic -DSHARED_MODULE -I/tmp/apache/include  -c mod_php3.c
+       ld -Bshareable -o libphp3.so mod_php3.o libmodphp3-so.a
+       $ _
+
+     because apxs automatically recognized  C  source  files  and
+     object  files.   Only  C  source  files  are  compiled while
+     remaining object files are used for the linking phase.
+
+SEE ALSO
+     apachectl(1), httpd(8).
+
+
+ + diff --git a/docs/manual/programs/dbmmanage.html b/docs/manual/programs/dbmmanage.html new file mode 100644 index 0000000000..da860698f5 --- /dev/null +++ b/docs/manual/programs/dbmmanage.html @@ -0,0 +1,103 @@ + +Manual Page: dbmmanage - Apache HTTP Server + + + +
+NAME
+     dbmmanage - Create and update user authentication  files  in
+     DBM format
+
+SYNOPSIS
+     dbmmanage filename [ command ] [ username [ encpasswd ] ]
+
+DESCRIPTION
+     dbmmanage is used to create and update the DBM format  files
+     used  to  store usernames and password for basic authentica-
+     tion of HTTP users.   Resources  available  from  the  httpd
+     Apache web server can be restricted to just the users listed
+     in the files created by dbmmanage. This program can only  be
+     used  when  the usernames are stored in a DBM file. To use a
+     flat-file database see htpasswd.
+
+     This manual page only lists the command line arguments.  For
+     details  of  the  directives  necessary  to  configure  user
+     authentication in httpd see the Apache manual, which is part
+     of   the   Apache   distribution   or   can   be   found  at
+     http://www.apache.org/.
+
+OPTIONS
+     filename
+          The filename of the DBM format  file.  Usually  without
+          the extension .db, .pag, or .dir.
+
+     command
+          This selects the operation to perform:
+
+     add         Adds an entry for username to filename using the
+                 encrypted password encpassword.
+
+     adduser     Asks for a password and then adds an  entry  for
+                 username to filename .
+
+     check       Asks for a password and then checks if  username
+                 is  in filename and if it's password matches the
+                 specified one.
+
+     delete      Deletes the username entry from filename.
+
+     import      Reads username:password entries (one  per  line)
+                 from  STDIN and adds them to filename. The pass-
+                 words already has to be crypted.
+
+     update      Same as the "adduser" command,  except  that  it
+                 makes sure username already exists in filename.
+
+     view        Just displays the complete contents of  the  DBM
+                 file.
+
+     username    The user for which the update operation is  per-
+                 formed.
+
+BUGS
+     One should be aware that there are a number of different DBM
+     file   formats   in  existance,  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
+     different file formats, and you must make sure that the file
+     format used by filename is the same  format  that  dbmmanage
+     expects  to see. dbmmanage currently has no way of determin-
+     ing what type of DBM file it is looking at.  If used against
+     the  wrong format, will simply return nothing, or may create
+     a different DBM file with a different name, or at worst,  it
+     may  corrupt the DBM file if you were attempting to write to
+     it.
+
+     dbmmanage has a list of DBM format preferences,  defined  by
+     the  @AnyDBM::ISA  array  near the beginning of the program.
+     Since we prefer the Berkeley DB 2 file format, the order  in
+     which  dbmmanage  will look for system libraries is Berkeley
+     DB 2, then NDBM, and then GDBM.   The  first  library  found
+     will  be  the  library dbmmanage will attempt to use for all
+     DBM file transactions.  This ordering is slightly  different
+     than  the standard @AnyDBM::ISA ordering in perl, as well as
+     the ordering used by the simple dbmopen() call in  Perl,  so
+     if  you  use  any  other utilities to manage your DBM files,
+     they must also follow  this  preference  ordering.   Similar
+     care  must  be  taken  if using programs in other languages,
+     like C, to access these files.
+
+     Apache's mod_auth_db.c module corresponds to Berkeley  DB  2
+     library,   while  mod_auth_dbm.c  corresponds  to  the  NDBM
+     library.  Also, one can usually use the  file  program  sup-
+     plied  with  most Unix systems to see what format a DBM file
+     is in.
+
+SEE ALSO
+     httpd(8)
+
+
+ + diff --git a/docs/manual/programs/footer.html b/docs/manual/programs/footer.html new file mode 100644 index 0000000000..1e5f739ebe --- /dev/null +++ b/docs/manual/programs/footer.html @@ -0,0 +1,8 @@ +
+ +

+ Apache HTTP Server Version 2.0 +

+ +Index +Home diff --git a/docs/manual/programs/header.html b/docs/manual/programs/header.html new file mode 100644 index 0000000000..9533b02bda --- /dev/null +++ b/docs/manual/programs/header.html @@ -0,0 +1,6 @@ +
+ [APACHE DOCUMENTATION] +

+ Apache HTTP Server Version 2.0 +

+
diff --git a/docs/manual/programs/htdigest.html b/docs/manual/programs/htdigest.html new file mode 100644 index 0000000000..1891e0d066 --- /dev/null +++ b/docs/manual/programs/htdigest.html @@ -0,0 +1,50 @@ + +Manual Page: htdigest - Apache HTTP Server + + + +
+NAME
+     htdigest - Create and update user authentication files
+
+SYNOPSIS
+     htdigest [ -c ] passwdfile realm username
+
+DESCRIPTION
+     htdigest is used to create and update the flat-files used to
+     store  usernames,  realm and password for digest authentica-
+     tion of HTTP users.   Resources  available  from  the  httpd
+     Apache web server can be restricted to just the users listed
+     in the files created by htdigest.
+
+     This manual page only lists the command line arguments.  For
+     details  of  the  directives  necessary  to configure digest
+     authentication in httpd see the Apache manual, which is part
+     of   the   Apache   distribution   or   can   be   found  at
+     http://www.apache.org/.
+
+OPTIONS
+     -c   Create the passwdfile. If passwdfile already exists, it
+          is deleted first.
+
+     passwdfile
+          Name of the file to contain  the  username,  realm  and
+          password.  If  -c  is given, this file is created if it
+          does not already exist, or deleted and recreated if  it
+          does exist.
+
+     realm
+          The realm name to which the user name belongs.
+
+     username
+          The user name to create or  update  in  passwdfile.  If
+          username  does  not  exist  is  this  file, an entry is
+          added. If it does exist, the password is changed.
+
+SEE ALSO
+     httpd(8)
+
+
+ + diff --git a/docs/manual/programs/htpasswd.html b/docs/manual/programs/htpasswd.html new file mode 100644 index 0000000000..6c95b6d77e --- /dev/null +++ b/docs/manual/programs/htpasswd.html @@ -0,0 +1,158 @@ + +Manual Page: htpasswd - Apache HTTP Server + + + +
+NAME
+     htpasswd - Create and update user authentication files
+
+SYNOPSIS
+     htpasswd [ -c ] [ -m ] passwdfile username
+     htpasswd -b [ -c ] [ -m | -d | -p | -s ] passwdfile username
+     password
+     htpasswd -n [ -m | -d | -s | -p ] username
+     htpasswd -nb [ -m | -d | -s | -p ] username password
+
+DESCRIPTION
+     htpasswd is used to create and update the flat-files used to
+     store  usernames  and  password  for basic authentication of
+     HTTP users.  If htpasswd cannot access a file, such  as  not
+     being  able to write to the output file or not being able to
+     read the file in order to update it,  it  returns  an  error
+     status and makes no changes.
+
+     Resources available from the httpd Apache web server can  be
+     restricted  to just the users listed in the files created by
+     htpasswd. This program can only manage usernames  and  pass-
+     words  stored  in  a  flat-file.  It can encrypt and display
+     password information for use in other types of data  stores,
+     though.  To use a DBM database see dbmmanage.
+
+     htpasswd encrypts passwords using either a  version  of  MD5
+     modified for Apache, or the system's crypt() routine.  Files
+     managed by htpasswd may contain  both  types  of  passwords;
+     some  user  records  may  have MD5-encrypted passwords while
+     others in the same file may have  passwords  encrypted  with
+     crypt().
+
+     This manual page only lists the command line arguments.  For
+     details  of  the  directives  necessary  to  configure  user
+     authentication in httpd see the Apache manual, which is part
+     of   the   Apache   distribution   or   can   be   found  at
+     <URL:http://www.apache.org/>.
+
+OPTIONS
+     -b   Use batch mode; i.e., get the password from the command
+          line  rather  than prompting for it. This option should
+          be used  with  extreme  care,  since  the  password  is
+          clearly visible on the command line.
+
+     -c   Create the passwdfile. If passwdfile already exists, it
+          is rewritten and truncated.  This option cannot be com-
+          bined with the -n option.
+
+     -n   Display the results  on  standard  output  rather  than
+          updating  a  file.  This is useful for generating pass-
+          word records acceptable  to  Apache  for  inclusion  in
+          non-text  data  stores.  This option changes the syntax
+          of the command  line,  since  the  passwdfile  argument
+          (usually  the first one) is omitted.  It cannot be com-
+          bined with the -c option.
+
+     -m   Use MD5 encryption for passwords. On Windows  and  TPF,
+          this is the default.
+
+     -d   Use crypt() encryption for passwords.  The  default  on
+          all platforms but Windows and TPF. Though possibly sup-
+          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
+          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
+          accept plain text passwords on Windows and TPF.
+
+     passwdfile
+          Name of the file to contain the user name and password.
+          If  -c  is  given,  this file is created if it does not
+          already exist, or rewritten and truncated  if  it  does
+          exist.
+
+     username
+          The username to create  or  update  in  passwdfile.  If
+          username  does  not  exist  in  this  file, an entry is
+          added. If it does exist, the password is changed.
+
+     password
+          The plaintext password to be encrypted  and  stored  in
+          the file.  Only used with the -b flag.
+
+EXIT STATUS
+     htpasswd returns a zero status ("true") if the username  and
+     password  have  been  successfully  added  or updated in the
+     passwdfile.  htpasswd returns 1 if it encounters some  prob-
+     lem  accessing  files,  2 if there was a syntax problem with
+     the command line, 3 if the  password  was  entered  interac-
+     tively  and  the  verification  entry didn't match, 4 if its
+     operation was interrupted, 5 if a value is too  long  (user-
+     name,  filename,  password, or final computed record), and 6
+     if the username contains illegal characters  (see  the  RES-
+     TRICTIONS section).
+
+EXAMPLES
+     htpasswd /usr/local/etc/apache/.htpasswd-users jsmith
+
+          Adds or modifies the password for user jsmith. The user
+          is prompted for the password.  If executed on a Windows
+          system, the password will be encrypted using the  modi-
+          fied  Apache  MD5  algorithm;  otherwise,  the system's
+          crypt() routine will be used.  If  the  file  does  not
+          exist, htpasswd will do nothing except return an error.
+
+     htpasswd -c /home/doe/public_html/.htpasswd jane
+
+          Creates a new file and stores a record in it  for  user
+          jane.   The  user is prompted for the password.  If the
+          file exists and cannot be read, or cannot  be  written,
+          it  is  not altered and htpasswd will display a message
+          and return an error status.
+
+     htpasswd -mb /usr/web/.htpasswd-all jones Pwd4Steve
+
+          Encrypts the password from the command line (Pwd4Steve)
+          using the MD5 algorithm, and stores it in the specified
+          file.
+
+SECURITY CONSIDERATIONS
+     Web password files such as those managed by htpasswd  should
+     not  be  within  the Web server's URI space -- that is, they
+     should not be fetchable with a browser.
+
+     The use of the -b option is discouraged, since  when  it  is
+     used the unencrypted password appears on the command line.
+
+RESTRICTIONS
+     On the Windows and MPE platforms, passwords  encrypted  with
+     htpasswd  are  limited  to  no  more  than 255 characters in
+     length.  Longer passwords will be truncated to  255  charac-
+     ters.
+
+     The MD5 algorithm used by htpasswd is specific to the Apache
+     software;  passwords  encrypted  using it will not be usable
+     with other Web servers.
+
+     Usernames are limited to 255 bytes and may not  include  the
+     character ':'.
+
+SEE ALSO
+     httpd(8) and the scripts in support/SHA1 which come with the
+     distribution.
+
+
+ + diff --git a/docs/manual/programs/httpd.html b/docs/manual/programs/httpd.html new file mode 100644 index 0000000000..ff5a16f462 --- /dev/null +++ b/docs/manual/programs/httpd.html @@ -0,0 +1,117 @@ + +Manual Page: httpd - Apache HTTP Server + + + +
+NAME
+     httpd - Apache hypertext transfer protocol server
+
+SYNOPSIS
+     httpd [ -X ] [ -R libexecdir ] [ -d serverroot ] [ -f config
+     ] [ -C directive ] [ -c directive ] [ -D parameter ]
+
+     httpd [ -h ] [ -l ] [ -L ] [ -v ] [ -V ] [ -S ] [ -t ] [  -T
+     ]
+
+DESCRIPTION
+     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 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.
+
+     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
+     manual may not reflect those compiled into httpd.
+
+OPTIONS
+     -R libexecdir
+                 This option is  only  available  if  Apache  was
+                 built  with  the  SHARED_CORE rule enabled which
+                 forces the Apache core code to be placed into  a
+                 dynamic  shared  object (DSO) file. This file is
+                 searched in a hardcoded  path  under  ServerRoot
+                 per  default.  Use  this  option  if you want to
+                 override it.
+
+     -d serverroot
+                 Set the initial value for the ServerRoot  direc-
+                 tive  to  serverroot.  This can be overridden by
+                 the  ServerRoot  command  in  the  configuration
+                 file. The default is /usr/local/apache.
+
+     -f config   Execute the  commands  in  the  file  config  on
+                 startup. If config does not begin with a /, then
+                 it is taken to be a path relative to the Server-
+                 Root. The default is conf/httpd.conf.
+
+     -C directive
+                 Process the configuration directive before read-
+                 ing config files.
+
+     -c directive
+                 Process the configuration directive after  read-
+                 ing config files.
+
+     -D parameter
+                 Sets a configuration parameter which can be used
+                 with  <IfDefine>...</IfDefine>  sections  in the
+                 configuration files  to  conditionally  skip  or
+                 process commands.
+
+     -h          Output a short summary of available command line
+                 options.
+
+     -l          Output a  list  of  modules  compiled  into  the
+                 server.
+
+     -L          Output  a  list  of  directives  together   with
+                 expected  arguments  and places where the direc-
+                 tive is valid.
+
+     -S          Show the settings as parsed from the config file
+                 (currently only shows the virtualhost settings).
+
+     -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).
+
+     -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
+                 , and then exit.
+
+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/index.html b/docs/manual/programs/index.html new file mode 100755 index 0000000000..3e246aae4b --- /dev/null +++ b/docs/manual/programs/index.html @@ -0,0 +1,60 @@ + + + + Apache HTTP Server and Supporting Programs + + + + + +

Server and Supporting Programs

+ +

This page documents all the executable programs included with the +Apache HTTP Server.

+ +
+ +
httpd
+
Apache hypertext transfer protocol server
+ +
apachectl
+
Apache HTTP server control interface
+ +
ab
+
Apache HTTP server benchmarking tool
+ +
apxs
+
APache eXtenSion tool
+ +
dbmmanage
+
Create and update user authentication files in DBM format for basic +authentication
+ +
htdigest
+
Create and update user authentication files for digest authentication
+ +
htpasswd
+
Create and update user authentication files for basic authentication
+ +
logresolve
+
Resolve hostnames for IP-addresses in Apache logfiles
+ +
rotatelogs
+
Rotate Apache logs without having to kill the server
+ +
suexec
+
Switch User For Exec
+ +
Other Programs
+ +
+ + + + diff --git a/docs/manual/programs/logresolve.html b/docs/manual/programs/logresolve.html new file mode 100644 index 0000000000..32efc42934 --- /dev/null +++ b/docs/manual/programs/logresolve.html @@ -0,0 +1,38 @@ + +Manual Page: logresolve - Apache HTTP Server + + + +
+
+NAME
+     logresolve - resolve hostnames  for  IP-adresses  in  Apache
+     logfiles
+
+SYNOPSIS
+     logresolve  [  -s  filename  ]  [  -c  ]  <   access_log   >
+     access_log.new
+
+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.
+
+OPTIONS
+     -s filename Specifies a filename to record statistics.
+
+     -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 origi-
+                 nal address.
+
+SEE ALSO
+     httpd(8)
+
+
+ + diff --git a/docs/manual/programs/other.html b/docs/manual/programs/other.html new file mode 100755 index 0000000000..e80e8a2d9b --- /dev/null +++ b/docs/manual/programs/other.html @@ -0,0 +1,48 @@ + + + + Other Programs - Apache HTTP Server + + + + + +

Other Programs

+ +

The following programs are simple support programs included with +the Apache HTTP Server which do not have their own manual pages.

+ + +

log_server_status

+ +

This Perl script is designed to be run at a frequent interval by something +like cron. It connects to the server and downloads the status +information. It reformats the information to a single line and logs +it to a file. Adjust the variables at the top of the script +to specify the location of the resulting logfile.

+ +

split-logfile

+ +

This Perl script will take a combined Web server access +log file and break its contents into separate files. +It assumes that the first field of each line is the +virtual host identity (put there by "%v"), and that +the logfiles should be named that+".log" in the current +directory.

+ +

The combined log file is read from stdin. Records read +will be appended to any existing log files.

+ + + + + + + + diff --git a/docs/manual/programs/rotatelogs.html b/docs/manual/programs/rotatelogs.html new file mode 100644 index 0000000000..70d2295110 --- /dev/null +++ b/docs/manual/programs/rotatelogs.html @@ -0,0 +1,42 @@ + +Manual Page: rotatelogs - Apache HTTP Server + + + +
+
+NAME
+     rotatelogs - rotate Apache logs without having to  kill  the
+     server
+
+SYNOPSIS
+     rotatelogs logfile rotationtime
+
+DESCRIPTION
+     rotatelogs is a simple program for use in  conjunction  with
+     Apache's piped logfile feature which can be used like this:
+
+        TransferLog "|rotatelogs /path/to/logs/access_log 86400"
+
+     This creates the files  /path/to/logs/access_log.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 rotation time (here  after  24  hours)  a  new  log  is
+     started.
+
+OPTIONS
+     logfile
+          The path plus basename of the logfile. The suffix .nnnn
+          is automatically added.
+
+     rotationtime
+          The rotation time in seconds.
+
+SEE ALSO
+     httpd(8)
+
+
+ + diff --git a/docs/manual/programs/suexec.html b/docs/manual/programs/suexec.html new file mode 100644 index 0000000000..f9f9b76a63 --- /dev/null +++ b/docs/manual/programs/suexec.html @@ -0,0 +1,29 @@ + +Manual Page: suexec - Apache HTTP Server + + + +
+
+NAME
+     suexec - Switch User For Exec
+
+SYNOPSIS
+     No synopsis for usage, because this program is  used  inter-
+     nally by Apache only.
+
+DESCRIPTION
+     suexec is the  "wrapper"  support  program  for  the  suEXEC
+     behaviour for Apache.  It is run from within Apache automat-
+     ically to switch the user when an external program has to be
+     run  under  a  different  user.  For  more information about
+     suEXEC  see  the  document  `Apache  suEXEC  Support'  under
+     http://httpd.apache.org/docs-2.0/suexec.html .
+
+SEE ALSO
+     httpd(8)
+
+
+ +