From: brian Date: Thu, 21 Nov 1996 08:12:53 +0000 (+0000) Subject: Moving files to mod/ X-Git-Tag: mpm-3~8 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=b2ab672f99920e5019879b8a0e5e0e2808f2f774;p=apache Moving files to mod/ git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@76995 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/mod_access.html b/docs/manual/mod/mod_access.html new file mode 100644 index 0000000000..b93c6e30a8 --- /dev/null +++ b/docs/manual/mod/mod_access.html @@ -0,0 +1,125 @@ + + + + +Apache module mod_access + + + +

+ +

Module mod_access

+ +This module is contained in the mod_access.c file, and +is compiled in by default. It provides access control based on client +hostname or IP address. + + + +

allow +

deny +

order +

+ + +

allow

+ +Syntax: allow from host host ...
+Context: directory, .htaccess
+Override: Limit
+Status: Base
+Module: mod_access

+ +The allow directive affects which hosts can access a given directory; it is +typically used within a <Limit> section. +Host is one of the following: +

all +: all hosts are allowed access +
A (partial) domain-name +: host whose name is, or ends in, this string are allowed access. +
A full IP address +: An IP address of a host allowed access +
A partial IP address +: The first 1 to 3 bytes of an IP address, for subnet restriction. +

+ +Example:

allow from .ncsa.uiuc.edu

+All hosts in the specified domain are allowed access.

+ +Note that this compares whole components; bar.edu +would not match foobar.edu.

+ +See also deny and order.

+ +

deny

+ +Syntax: deny from host host ...
+Context: directory, .htaccess
+Override: Limit
+Status: Base
+Module: mod_access

+ +The deny directive affects which hosts can access a given directory; it is +typically used within a <Limit> section. +Host is one of the following: +

all +: all hosts are denied access +
A (partial) domain-name +: host whose name is, or ends in, this string are denied access. +
A full IP address +: An IP address of a host denied access +
A partial IP address +: The first 1 to 3 bytes of an IP address, for subnet restriction. +

+ +Example:

deny from 16

+All hosts in the specified network are denied access.

+ +Note that this compares whole components; bar.edu +would not match foobar.edu.

+ +See also allow and order.

+ +

order

+ +Syntax: order ordering
+Default: order deny,allow
+Context: directory, .htaccess
+Override: Limit
+Status: Base
+Module: mod_access

+ +The order directive controls the order in which allow and +deny directives are evaluated. Ordering is one +of +

deny,allow +: the deny directives are evaluated before the allow directives. +
allow,deny +: the allow directives are evaluated before the deny directives. +
mutual-failure +: Only those hosts which appear on the allow list and do not appear +on the deny list are granted access. +

+ +Example: +

+order deny,allow +deny from all +allow from .ncsa.uiuc.edu +

+Hosts in the ncsa.uiuc.edu domain are allowed access; all other hosts are +denied access. + + +

+ +

+ + + + diff --git a/docs/manual/mod/mod_actions.html b/docs/manual/mod/mod_actions.html new file mode 100644 index 0000000000..297df17ba8 --- /dev/null +++ b/docs/manual/mod/mod_actions.html @@ -0,0 +1,81 @@ + + + +Apache module mod_actions + + + +

Apache module mod_actions

+ +This module is contained in the mod_actions.c file, and +is compiled in by default. It provides for +executing CGI scripts based on media type or request method. It is not +present in versions prior to Apache 1.1. + +

Summary

+ +This module lets you run CGI scripts whenever a file of a certain type +is requested. This makes it much easier to execute scripts that +process files. + +

Directives

Action +
Script +

+ +

Action

+Syntax: Action mime-type cgi-script
+Context: server config, virutal host, directory, .htaccess
+Override: FileInfo
+Status: Base
+Module: mod_actions
+Compatibility: Action is only available in Apache 1.1 +and later

+ +This directive adds an action, which will activate cgi-script when +a file of content type mime-type is requested. It sends the +URL and file path of the requested document using the standard +CGI PATH_INFO and PATH_TRANSLATED environment variables. + +

+ +

Script

+Syntax: Script method cgi-script
+Context: server config, virutal host, directory
+Status: Base
+Module: mod_actions
+Compatibility: Script is only available in Apache 1.1 +and later

+ +

This directive adds an action, which will activate cgi-script when +a file is requested using the method of method, which can be +one of GET, POST, PUT or +DELETE. It sends the +URL and file path of the requested document using the standard +CGI PATH_INFO and PATH_TRANSLATED environment variables. + +

Note that the Script command defines default actions only. If a CGI +script is called, or some other resource that is capable of handling +the requested method internally, it will do so. Also note that script +with a method of GET will only be called if there are +query arguments present (e.g. foo.html?hi). Otherwise, the request +will proceed normally. + +

Examples: +

+    Script GET /cgi-bin/search     #e.g. for <ISINDEX>-style searching
+    Script PUT /~bob/put.cgi
+

+ +

+ + + + diff --git a/docs/manual/mod/mod_alias.html b/docs/manual/mod/mod_alias.html new file mode 100644 index 0000000000..f217051c95 --- /dev/null +++ b/docs/manual/mod/mod_alias.html @@ -0,0 +1,93 @@ + + + + +Apache module mod_alias + + + +

+ +

Module mod_alias

+ +This module is contained in the mod_alias.c file, and +is compiled in by default. It provides for mapping different parts of the +host filesystem in the the document tree, and for URL redirection. + + + +

Alias +

Redirect +

ScriptAlias +

+ + +

Alias

+ +Syntax: Alias url-path directory-filename
+Context: server config, virtual host
+Status: Base
+Module: mod_alias
+Compatibility: Alias is only available in Apache 1.1 +and later

+ +The Alias directive allows documents to be stored in the local filesystem +other than under the DocumentRoot. +URLs with a (%-decoded) path beginning with url-path will be +mapped to local files beginning with directory-filename. +Example: +

Alias /image /ftp/pub/image

+A request for http://myserver/image/foo.gif would cause the server to +return the file /ftp/pub/image/foo.gif.

+See also ScriptAlias.

+ +

Redirect

+ +Syntax: Redirect url-path url
+Context: server config, virtual host, directory, .htaccess
+Status: Base
+Module: mod_alias
+Compatibility: The directory and .htaccess context's +are only available in versions 1.1 and later

+ +The Redirect directive maps an old URL into a new one. The new URL is returned +to the client which attempts to fetch it again with the new address. +Url-path a (%-decoded) path; any requests for documents beginning with +this path will be returned a redirect error to a new (%-encoded) url +beginning with url. Example: +

Redirect /service +http://foo2.bar.com/service

+If the client requests http://myserver/service/foo.txt, it will be told to +access http://foo2.bar.com/service/foo.txt instead.

+Note: Redirect directives take precedence over Alias and ScriptAlias +directives, irrespective of their ordering in the configuration file.

+ +

ScriptAlias

+ +Syntax: ScriptAlias url-path directory-filename
+Context: server config, virtual host
+Status: Base
+Module: mod_alias
+Compatibility: ScriptAlias is only available in Apache 1.1 +and later

+ +The ScriptAlias directive has the same behaviour as the +Alias directive, except that in addition it +marks the target directory as containing CGI scripts. +URLs with a (%-decoded) path beginning with url-path will be +mapped to scripts beginning with directory-filename. +Example: +

ScriptAlias /cgi-bin/ /web/cgi-bin/

+A request for http://myserver/cgi-bin/foo would cause the server to +run the script /web/cgi-bin/foo.

+ + +

+ +

+ + + + diff --git a/docs/manual/mod/mod_asis.html b/docs/manual/mod/mod_asis.html new file mode 100644 index 0000000000..3597e1618f --- /dev/null +++ b/docs/manual/mod/mod_asis.html @@ -0,0 +1,67 @@ + + + + +Apache module mod_asis + + + +

+ +

Module mod_asis

+ +This module is contained in the mod_asis.c file, and +is compiled in by default. It provides for .asis files. Any +document with mime type httpd/send-as-is will be processed by +this module. + + +

Purpose

+To allow file types to be defined such that Apache sends them without +adding HTTP headers.

+ +This can be used to send any kind of data from the server, including redirects +and other special HTTP responses, without requiring a cgi-script or an nph +script. +

Usage

+In the server configuration file, define a new mime type called +httpd/send-as-is e.g. +

AddType httpd/send-as-is asis

+this defines the .asis file extension as being of the new +httpd/send-as-is mime type. The contents of any file with a +.asis extension will then be sent by Apache to the client with +almost no changes. Clients will need HTTP headers to be attached, so do not +forget them. A Status: header is also required; the data should be the +3-digit HTTP response code, followed by a textual message.

+ +Here's an example of a file whose contents are sent as is so as to +tell the client that a file has redirected. +

+Status: 302 Now where did I leave that URL +Location: http://xyz.abc.com/foo/bar.html +Content-type: text/html + +<HTML> +<HEAD> +<TITLE>Lame excuses'R'us</TITLE> +</HEAD> +<BODY> +<H1>Fred's exceptionally wonderful page has moved to +<A HREF="http://xyz.abc.com/foo/bar.html">Joe's</A> site. +</H1> +</BODY> +</HTML> +

+Notes: the server always adds a Date: and Server: header to the data returned +to the client, so these should not be included in the file. +The server does not add a Last-Modified header; it probably should. +

+ + +

+ +

+ + + diff --git a/docs/manual/mod/mod_auth.html b/docs/manual/mod/mod_auth.html new file mode 100644 index 0000000000..ac522f549a --- /dev/null +++ b/docs/manual/mod/mod_auth.html @@ -0,0 +1,84 @@ + + + + +Apache module mod_auth + + + +

+ +

Module mod_auth

+ +This module is contained in the mod_auth.c file, and +is compiled in by default. It provides for user authentication using +textual files. + + + +

AuthGroupFile +

AuthUserFile +

+ + +

AuthGroupFile

+ +Syntax: AuthGroupFile filename
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Base
+Module: mod_auth

+ +The AuthGroupFile directive sets the name of a textual file containing the list +of user groups for user authentication. Filename is the absolute path +to the group file.

+Each line of the group file contains a groupname followed by a colon, followed +by the member usernames separated by spaces. Example: +

mygroup: bob joe anne

+Note that searching large groups files is very inefficient; +AuthDBMGroupFile should +be used instead.

+ +Security: make sure that the AuthGroupFile is stored outside the +document tree of the webserver; do not put it in the directory that +it protects. Otherwise, clients will be able to download the AuthGroupFile.

+ +See also AuthName, +AuthType and +AuthUserFile.

+ +

AuthUserFile

+ +Syntax: AuthUserFile filename
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Base
+Module: mod_auth

+ +The AuthUserFile directive sets the name of a textual file containing the list +of users and passwords for user authentication. Filename is the +absolute path to the user file.

+Each line of the user file file contains a username followed by a colon, +followed by the crypt() encrypted password. The behaviour of multiple +occurrences of the same user is undefined.

+Note that searching user groups files is inefficient; +AuthDBMUserFile should +be used instead.

+ +Security: make sure that the AuthUserFile is stored outside the +document tree of the webserver; do not put it in the directory that +it protects. Otherwise, clients will be able to download the AuthUserFile.

+ +See also AuthName, +AuthType and +AuthGroupFile.

+ + +

+ + + + diff --git a/docs/manual/mod/mod_auth_anon.html b/docs/manual/mod/mod_auth_anon.html new file mode 100644 index 0000000000..2a299a1d7e --- /dev/null +++ b/docs/manual/mod/mod_auth_anon.html @@ -0,0 +1,192 @@ + + +4.1a Module mod_auth_anon.c + + +

4.1a Module mod_auth_anon.

+ +This module is contained in the mod_auth_anon.c file and +is compiled in by default. It is only available in Apache 1.1 and +later. +

+It does access control in a manner similar to anonymous-ftp sites; i.e. +have a 'magic' user id 'anonymous' and the email address as a password. +These email addresses can be logged. +

+Combined with other (database) access control methods, this allows for +effective user tracking and customization according to a user profile +while still keeping the site open for 'unregistered' users. One advantage +of using Auth-based user tracking is that, unlike magic-cookies and +funny URL pre/postfixes, it is completely browser independent and it +allows users to share URLs. +

+ +Full description / +Example / +Compile time options / +RevisionHistory / +Person to blame / +Sourcecode +

+ +

Full description of all tokens

+Anonymous < Space separated list > +

+ A list of one or more 'magic' userIDs which are allowed access + without password verification. The userIDs are space separated. + It is possible to use the ' and " quotes to allow a space in + a userID as well as the \ escape character. +

+ Please note that the comparison is case-IN-sensitive. +
+ I strongly suggest that the magic username 'anonymous' + is always one of the allowed userIDs. +

+ Example:
+ + Anonymous: anonymous "Not Registered" 'I don\'t know' +

+ This would allow the user to enter without password verification + by using the userId's 'anonymous', 'AnonyMous','Not Registered' and + 'I Don't Know'. +

+Anonymous_LogEmail < on | off > +

+ When set 'on', the default, the 'password' entered (which hopefully + contains a sensible email address) is logged in the httpd-log file. +

+Anonymous_VerifyEmail < on | off > +

+ When set 'on', the default is 'off', the 'password' entered is + checked for at least one '@' and a '.' to encourage users to enter + valid email addressses (see the above Auth_LogEmail. +

+Anonymous_NoUserID < on | off > +

+ When set 'on', the default is 'off', users can leave + the userID (and perhaps the password field) empty. This + can be very convenient for MS-Explorer users who can + just hit return or click directly on the OK button; which + seems a natural reaction. +

+Anonymous_Authorative < on | off > +

+ Default is 'off'. When set 'on', there is no + fall-through to other authorization methods. So if a + userID does not match the values specified in the + Anonymous directive, access is denied. +

+ Be sure you know what you are doing when you decide to switch + it on. And remember that it is the linking order of the modules + (in the Configuration / Make file) which details the order + in which the Authorization modules are queried. +

+ + +

Example

+ +The example below (when combined with the Auth directives +of a htpasswd-file based (or GDM, mSQL etc) base access +control system allows users in as 'guests' with the +following properties: +

+It insists that the user enters a userId. (Anonymous_NoUserId) +
+It insists that the user enters a password. (Anonymous_MustGiveEmail) +
+The password entered must be a valid email address, ie. contain at least one '@' and a '.'. +(Anonymous_VerifyEmail) +
+The userID must be one of anonymous guest www test welcome +and comparison is not case sensitive. +<directory /web/docs/public> +
+And the Email addresses entered in the passswd field are logged to +the httpd-log file +(Anonymous_LogEmail) +

+Excerp of access.conf: +

+Anonymous anonymous guest www test welcome +Anonymous_MustGiveEmail on +Anonymous_VerifyEmail on +Anonymous_NoUserId off +Anonymous_LogEmail on + +AuthName Use 'anonymous' & Email address for guest entry +AuthType basic + +

+ Normal Apache/NCSA tokens for access control +

+ <limit get post head>
+ order deny,allow
+ allow from all
+

+ require valid-user
+ <limit>
+

+ + +

Compile Time Options

+ +Currently there are no Compile options. + +

Revision History

+ +This version: 23 Nov 1995, 24 Feb 1996, 16 May 1996. + +

Version 0.4: First release +
Version 0.5: Added 'VerifyEmail' and 'LogEmail' options. Multiple + 'anonymous' tokes allowed. more docs. Added Authorative + functionality. +

+ + +

Contact/person to blame

+ +This module was written for the +European Wide Service Exchange by +<Dirk.vanGulik@jrc.it>. +Feel free to contact me if you have any problems, icecreams or bugs. This +documentation, courtesy of Nick Himba, +<himba@cs.utwente.nl>. +

+ + +

Sourcecode

+ +The source code can be found at


+http://www.apache.org

. A snapshot of a development version +usually resides at


+http://me-www.jrc.it/~dirkx/mod_auth_anon.c

. Please make sure +that you always quote the version you use when filing a bug report. +

+ + + + diff --git a/docs/manual/mod/mod_auth_db.html b/docs/manual/mod/mod_auth_db.html new file mode 100644 index 0000000000..a1fe3033f7 --- /dev/null +++ b/docs/manual/mod/mod_auth_db.html @@ -0,0 +1,83 @@ + + + + +Apache module mod_auth_db + + + + + +

Module mod_auth_db

+ +This module is contained in the mod_auth_db.c file, and +is not compiled in by default. It provides for user authentication using +Berkeley DB files. It is an alternative to DBM +files for those systems which support DB and not DBM. It is only +available in Apache 1.1 and later. + + + +

AuthDBGroupFile +

AuthDBUserFile +

+ + +

AuthDBGroupFile

+ +Syntax: AuthDBGroupFile filename
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Extension
+Module: mod_auth_db

+ +The AuthDBGroupFile directive sets the name of a DB file containing the list +of user groups for user authentication. Filename is the absolute path +to the group file.

+ +The group file is keyed on the username. The value for a user is a +comma-separated list of the groups to which the users belongs. There must +be no whitespace within the value, and it must never contain any colons.

+ +Security: make sure that the AuthDBGroupFile is stored outside the +document tree of the webserver; do not put it in the directory that +it protects. Otherwise, clients will be able to download the +AuthDBGroupFile.

+ +See also AuthName, +AuthType and +AuthDBUserFile.

+ +

AuthDBUserFile

+ +Syntax: AuthDBUserFile filename
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Extension
+Module: mod_auth_db

+ +The AuthDBUserFile directive sets the name of a DB file containing the list +of users and passwords for user authentication. Filename is the +absolute path to the user file.

+The user file is keyed on the username. The value for a user is the crypt() +encrypted password, optionally followed by a colon and arbitrary data. +The colon and the data following it will be ignored by the server.

+ +Security: make sure that the AuthDBUserFile is stored outside the +document tree of the webserver; do not put it in the directory that +it protects. Otherwise, clients will be able to download the +AuthDBUserFile.

+ +See also AuthName, +AuthType and +AuthDBGroupFile.

+ + +

+ + + + diff --git a/docs/manual/mod/mod_auth_dbm.html b/docs/manual/mod/mod_auth_dbm.html new file mode 100644 index 0000000000..230d5e351d --- /dev/null +++ b/docs/manual/mod/mod_auth_dbm.html @@ -0,0 +1,81 @@ + + + + +Apache module mod_auth_dbm + + + +

+ +

Module mod_auth_dbm

+ +This module is contained in the mod_auth_dbm.c file, and +is not compiled in by default. It provides for user authentication using +DBM files. See the DBM user documentation. + + + +

AuthDBMGroupFile +

AuthDBMUserFile +

+ + +

AuthDbmGroupFile

+ +Syntax: AuthGroupFile filename
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Extension
+Module: mod_auth_dbm

+ +The AuthDBMGroupFile directive sets the name of a DBM file containing the list +of user groups for user authentication. Filename is the absolute path +to the group file.

+ +Security: make sure that the AuthDBMGroupFile is stored outside the +document tree of the webserver; do not put it in the directory that +it protects. Otherwise, clients will be able to download the +AuthDBMGroupFile.

+ +See also AuthName, +AuthType and +AuthDBMUserFile.

+ +

AuthDBMUserFile

+ +Syntax: AuthDBMUserFile filename
+Context: directory, .htaccess
+Override: AuthConfig
+Status: Extension
+Module: mod_auth_dbm

+ +The AuthDBMUserFile directive sets the name of a DBM file containing the list +of users and passwords for user authentication. Filename is the +absolute path to the user file.

+ +Security: make sure that the AuthDBMUserFile is stored outside the +document tree of the webserver; do not put it in the directory that +it protects. Otherwise, clients will be able to download the +AuthDBMUserFile.

+ +See also AuthName, +AuthType and +AuthDBMGroupFile.

+ + +

+ + + + diff --git a/docs/manual/mod/mod_autoindex.html b/docs/manual/mod/mod_autoindex.html new file mode 100644 index 0000000000..960c89ca13 --- /dev/null +++ b/docs/manual/mod/mod_autoindex.html @@ -0,0 +1,309 @@ + + + + +Apache module mod_dir + + + +

+ +

Module mod_dir

+ +This module is contained in the mod_dir.c file, and +is compiled in by default. It provides for directory indexing. + +

Summary

+This module controls the directory indexing. The index of a directory +can come from one of two sources: +

A file written by the user, typically called index.html. +The DirectoryIndex directive sets the name +of this file. +
Otherwise, a listing generated by the server. The other directives +control the format of this listing. The AddIcon, +AddIconByEncoding and +AddIconByType are used to set a list of +icons to display for various file types; for each file listed, the +first icon listed that matches the file is displayed. +

+ + +

Directives

+ + +

AddIcon +

+ + +

AddDescription

+ +Syntax: AddDescription string file file...
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

+ +This sets the description to display for a file, for +FancyIndexing. File is a file +extension, partial filename, wildcard expression or full filename for files +to describe. String is enclosed in double quotes +("). Example: +

AddDescription "The planet Mars" /web/pics/mars.gif +

+ +

AddIcon

+ +Syntax: AddIcon icon name name ...
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

+ +This sets the icon to display next to a file ending in name for +FancyIndexing. Icon is either a +(%-escaped) relative URL to the icon, or of the format +(alttext,url) where alttext is the text tag given +for an icon for non-graphical browsers.

+ +Name is either ^^DIRECTORY^^ for directories, ^^BLANKICON^^ for +blank lines (to format the list correctly), a file extension, a wildcard +expression, a partial filename or a complete filename. Examples: +

+AddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm +AddIcon /icons/dir.xbm ^^DIRECTORY^^ +AddIcon /icons/backup.xbm *~ +

+AddIconByType should be used in preference to +AddIcon, when possible.

+ +

AddIconByEncoding

+ +Syntax: AddIconByEncoding icon mime-encoding mime-encoding +...
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

+ +This sets the icon to display next to files with +mime-encoding for FancyIndexing. +Icon is either a (%-escaped) relative URL to the icon, or of the +format (alttext,url) where alttext is the text tag +given for an icon for non-graphical browsers.

+ +Mime-encoding is a wildcard expression matching required the +content-encoding. Examples: +

+AddIconByEncoding /icons/compress.xbm x-compress +

+ +

AddIconByType

+ +Syntax: AddIconByType icon mime-type mime-type ...
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

+ +This sets the icon to display next to files of type mime-type for +FancyIndexing. Icon is either a +(%-escaped) relative URL to the icon, or of the format +(alttext,url) where alttext is the text tag given +for an icon for non-graphical browsers.

+Mime-type is a wildcard expression matching required the mime types. +Examples: +

+AddIconByType (IMG,/icons/image.xbm) image/* +

+ +

DefaultIcon

+ +Syntax: DefaultIcon url
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

+ +The DefaultIcon directive sets the icon to display for files when no +specific icon is known, for FancyIndexing. +Url is a (%-escaped) relative URL to the icon. Examples: +

+DefaultIcon /icon/unknown.xbm +

+ +

DirectoryIndex

+ +Syntax: DirectoryIndex local-url local-url ...
+Default: DirectoryIndex index.html
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

+ +The DirectoryIndex directive sets the list of resources to look for, when +the client requests an index of the directory by specifying a NULL file +at the end of the a directory name. Local-url is the (%-encoded) URL +of a document on the server relative to the requested directory; it is usually +the name of a file in the directory. Several URLs may be given; the server +will return the first one that it finds. If none of the resources exist, +then the server will generate its own listing of the directory. +Example: +

+DirectoryIndex index.html +

+then a request for http://myserver/docs/ would return +http://myserver/docs/index.html if it exists, or would list +the directory if it did not.

+ +Note that the documents do not need to be relative to the directory; +

+DirectoryIndex index.html index.txt /cgi-bin/index.pl

+would cause the CGI script /cgi-bin/index.pl to be executed +if neither index.html or index.txt existed in +a directory.

+ +

FancyIndexing

+ +Syntax: FancyIndexing boolean
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

+ +The FancyIndexing directive sets the FancyIndexing option for a directory. +Boolean can be on or off. The +IndexOptions directive should be used in +preference.

+ +

HeaderName

+ +Syntax: HeaderName filename
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

+ +The HeaderName directive sets the name of the file that will be inserted +at the top of the index listing. Filename is the name of the file +to include, and is taken to be relative to the directory being indexed. +The server first attempts to include filename.html +as an HTML document, otherwise it will include filename as plain +text. Example: +

HeaderName HEADER

+when indexing the directory /web, the server will first look for +the HTML file /web/HEADER.html and include it if found, otherwise +it will include the plain text file /web/HEADER, if it exists. + +

IndexIgnore

+ +Syntax: IndexIgnore file file ...
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

+ +The IndexIgnore directive adds to the list of files to hide when listing +a directory. File is a file extension, partial filename, +wildcard expression or full filename for files to ignore. Multiple +IndexIgnore directives add to the list, rather than the replacing the list +of ignored files. By default, the list contains `.'. Example: +

+IndexIgnore README .htaccess *~ +

+ +

IndexOptions

+ +Syntax: IndexOptions option option ...
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

+ +The IndexOptions directive specifies the behaviour of the directory indexing. +Option can be one of +

FancyIndexing +: +This turns on fancy indexing of directories. +
IconsAreLinks +: + +This makes the icons part of the anchor for the filename, for +fancy indexing. +
ScanHTMLTitles +: +This enables the extraction of the title from HTML documents for fancy +indexing. If the file does not have a description given by +AddDescription then httpd will read the +document for the value of the TITLE tag. This is CPU and disk intensive. +
SuppressLastModified +: + +This will suppress the display of the last modification date, in fancy +indexing listings. +
SuppressSize +: + +This will suppress the file size in fancy indexing listings. +
SuppressDescription +: + +This will suppress the file description in fancy indexing listings. +

+This default is that no options are enabled. If multiple IndexOptions +could apply to a directory, then the most specific one is taken complete; +the options are not merged. For example: +

+<Directory /web/docs> +IndexOptions FancyIndexing +</Directory> +<Directory /web/docs/spec> +IndexOptions ScanHTMLTitles +</Directory> +

+then only ScanHTMLTitles will be set for the /web/docs/spec +directory.

+ +

ReadmeName

+ +Syntax: ReadmeName filename
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

+ +The ReadmeName directive sets the name of the file that will be appended +to the end of the index listing. Filename is the name of the file +to include, and is taken to be relative to the directory being indexed. +The server first attempts to include filename.html +as an HTML document, otherwise it will include filename as plain +text. Example: +

ReadmeName README

+when indexing the directory /web, the server will first look for +the HTML file /web/README.html and include it if found, otherwise +it will include the plain text file /web/README, if it exists. + +

Apache module mod_cern_meta

+ +This module is contained in the mod_cern_meta.c file, and +is not compiled in by default. It provides for CERN httpd metafile +semantics. It is only available in Apache 1.1 and later. + +

Summary

+ +Emulate the CERN HTTPD Meta file semantics. Meta files are HTTP +headers that can be output in addition to the normal range of headers +for each file accessed. They appear rather like the Apache +.asis files, and are able to provide a crude way of influencing +the Expires: header, as well as providing other curiosities. +There are many ways to manage meta information, this one was +chosen because there is already a large number of CERN users +who can exploit this module. + +

More information on the +CERN metafile semantics is available. + +

+ +

MetaDir

+Syntax: MetaDir directory name
+Default: MetaDir .web
+Context: server config
+Status: Base
+Module: mod_cern_meta
+Compatibility: MetaDir is only available in Apache 1.1 +and later.

+ +Specifies the name of the directory in which Apache can find +meta information files. The directory is usually a 'hidden' +subdirectory of the directory that contains the file being +accessed. Set to "." to look in the same directory as the +file. + +

MetaSuffix

+Syntax: MetaSuffix suffix
+Default: MetaSuffix .meta
+Context: server config
+Status: Base
+Module: mod_cern_meta
+Compatibility: MetaSuffix is only available in Apache 1.1 +and later.

+ +Specifies the file name suffix for the file containing the +meta information. For example, the default values for the two +directives will cause a request to +DOCUMENT_ROOT/somedir/index.html to look in +DOCUMENT_ROOT/somedir/.web/index.html.meta and will use +its contents to generate additional MIME header information. + +

+ +

+ + + + diff --git a/docs/manual/mod/mod_cgi.html b/docs/manual/mod/mod_cgi.html new file mode 100644 index 0000000000..5bf6ea78c9 --- /dev/null +++ b/docs/manual/mod/mod_cgi.html @@ -0,0 +1,53 @@ + + + + +Apache module mod_cgi + + + +

+ +

Module mod_cgi

+ +This module is contained in the mod_cgi.c file, and +is compiled in by default. It provides for execution of CGI scripts. +Any file with mime type application/x-httpd-cgi will be +processed by this module. + + + +

Summary

+Any file that has the mime type application/x-httpd-cgi +will be treated as a CGI script, and run by the server, with its output +being returned to the client. Files acquire this type either by +having a name ending in an extension defined by the +AddType directive, or by being in +a ScriptAlias directory.

+ +When the server invokes a CGI script, it will add a variable called +DOCUMENT_ROOT to the environment. This variable will contain the +value of the DocumentRoot +configuration variable. + +

CGI Environment variables

+The server will set the CGI environment variables as described in the CGI +specification, with the following provisos: +

REMOTE_HOST +: This will only be set if the server has not been compiled with +MINIMAL_DNS. +
REMOTE_IDENT +: This will only be set if +IdentityCheck is set to on. +
REMOTE_USER +: This will only be set if the CGI script is subject to authentication. +

+ +

+ + + diff --git a/docs/manual/mod/mod_dir.html b/docs/manual/mod/mod_dir.html new file mode 100644 index 0000000000..960c89ca13 --- /dev/null +++ b/docs/manual/mod/mod_dir.html @@ -0,0 +1,309 @@ + + + + +Apache module mod_dir + + + +

+ +

Module mod_dir

+ +This module is contained in the mod_dir.c file, and +is compiled in by default. It provides for directory indexing. + +

Summary

+This module controls the directory indexing. The index of a directory +can come from one of two sources: +

A file written by the user, typically called index.html. +The DirectoryIndex directive sets the name +of this file. +
Otherwise, a listing generated by the server. The other directives +control the format of this listing. The AddIcon, +AddIconByEncoding and +AddIconByType are used to set a list of +icons to display for various file types; for each file listed, the +first icon listed that matches the file is displayed. +

+ + +

Directives

+ + +

AddIcon +

+ + +

AddDescription

+ +Syntax: AddDescription string file file...
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

AddDescription "The planet Mars" /web/pics/mars.gif +

+ +

AddIcon

+ +Syntax: AddIcon icon name name ...
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

+AddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm +AddIcon /icons/dir.xbm ^^DIRECTORY^^ +AddIcon /icons/backup.xbm *~ +

+AddIconByType should be used in preference to +AddIcon, when possible.

+ +

AddIconByEncoding

+ +Syntax: AddIconByEncoding icon mime-encoding mime-encoding +...
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

+ +Mime-encoding is a wildcard expression matching required the +content-encoding. Examples: +

+AddIconByEncoding /icons/compress.xbm x-compress +

+ +

AddIconByType

+ +Syntax: AddIconByType icon mime-type mime-type ...
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

+Mime-type is a wildcard expression matching required the mime types. +Examples: +

+AddIconByType (IMG,/icons/image.xbm) image/* +

+ +

DefaultIcon

+ +Syntax: DefaultIcon url
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

+ +The DefaultIcon directive sets the icon to display for files when no +specific icon is known, for FancyIndexing. +Url is a (%-escaped) relative URL to the icon. Examples: +

+DefaultIcon /icon/unknown.xbm +

+ +

DirectoryIndex

+DirectoryIndex index.html +

+then a request for http://myserver/docs/ would return +http://myserver/docs/index.html if it exists, or would list +the directory if it did not.

+ +Note that the documents do not need to be relative to the directory; +

+DirectoryIndex index.html index.txt /cgi-bin/index.pl

+would cause the CGI script /cgi-bin/index.pl to be executed +if neither index.html or index.txt existed in +a directory.

+ +

FancyIndexing

+ +Syntax: FancyIndexing boolean
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

+ +The FancyIndexing directive sets the FancyIndexing option for a directory. +Boolean can be on or off. The +IndexOptions directive should be used in +preference.

+ +

HeaderName

+ +Syntax: HeaderName filename
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

HeaderName HEADER

IndexIgnore

+ +Syntax: IndexIgnore file file ...
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

+IndexIgnore README .htaccess *~ +

+ +

IndexOptions

+ +Syntax: IndexOptions option option ...
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

+ +The IndexOptions directive specifies the behaviour of the directory indexing. +Option can be one of +

FancyIndexing +: +This turns on fancy indexing of directories. +
IconsAreLinks +: + +This makes the icons part of the anchor for the filename, for +fancy indexing. +
ScanHTMLTitles +: +This enables the extraction of the title from HTML documents for fancy +indexing. If the file does not have a description given by +AddDescription then httpd will read the +document for the value of the TITLE tag. This is CPU and disk intensive. +
SuppressLastModified +: + +This will suppress the display of the last modification date, in fancy +indexing listings. +
SuppressSize +: + +This will suppress the file size in fancy indexing listings. +
SuppressDescription +: + +This will suppress the file description in fancy indexing listings. +

+This default is that no options are enabled. If multiple IndexOptions +could apply to a directory, then the most specific one is taken complete; +the options are not merged. For example: +

+<Directory /web/docs> +IndexOptions FancyIndexing +</Directory> +<Directory /web/docs/spec> +IndexOptions ScanHTMLTitles +</Directory> +

+then only ScanHTMLTitles will be set for the /web/docs/spec +directory.

+ +

ReadmeName

+ +Syntax: ReadmeName filename
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Status: Base
+Module: mod_dir

ReadmeName README

Apache module mod_env

+ +This module is contained in the mod_env.c file, and +is not compiled in by default. It provides for +passing environment variables to CGI/SSI scripts. Is is only available +in Apache 1.1 and later. + +

Summary

+ +This module allows Apache's CGI and SSI environment to inherit +environment variables from the shell which invoked the httpd process. +CERN webservers are able to do this, so this module is especially +useful to webadmins who wish to migrate from CERN to Apache without +rewriting all their scripts + +

Directives

PassEnv +
SetEnv +

+ +

PassEnv

+Syntax: PassEnv variable
+Context: server config, virtual host
+Status: Base
+Module: mod_env
+Compatibility: PassEnv is only available in +Apache 1.1 and later.

+ +Passes an environment variable to CGI scripts from the servers's own +environment. Example: +

+    PassEnv LD_LIBRARY_PATH
+

+ + +

SetEnv

+Syntax: SetEnv variable value
+Context: server config, virtual host
+Status: Base
+Module: mod_env
+Compatibility: SetEnv is only available in +Apache 1.1 and later.

+ +Sets an environment variable, which is then passed on to CGI +scripts. Example: +

+    SetEnv SPECIAL_PATH /foo/bin
+

+ +

+ + + + diff --git a/docs/manual/mod/mod_imap.html b/docs/manual/mod/mod_imap.html new file mode 100644 index 0000000000..195ae374b4 --- /dev/null +++ b/docs/manual/mod/mod_imap.html @@ -0,0 +1,284 @@ + + + + +Apache module mod_imap + + + +

+ +

Module mod_imap

+ +This module is contained in the mod_imap.c file, and +is compiled in by default. It provides for .map files, +replacing the functionality of the imagemap CGI program. Any +directory or document type configured to use the handler imap-file +(using either

AddHandler
+

or SetHandler) + +will be +processed by this module. + +

Summary

+ +This module is in the default Apache distribution. The following directive will +activate files ending with .map as imagemap files: + +

AddHandler imap-file map

+ +Note that the following is still supported: + +

AddType application/x-httpd-imap map

+ +However, we are trying to phase out "magic MIME types" so we are deprecating +this method. + +

New Features

+The imagemap module adds some new features that were not +possible with previously distributed imagemap programs.

+ +

URL references relative to the Referer: information. +
Default <BASE> assignment through a new map directive +base. +
No need for imagemap.conf file. +
Point references. +
Configurable generation of imagemap menus. +

+ +

Configuration Directives

ImapMenu +
ImapDefault +
ImapBase +

+ + +

+ +

ImapMenu

+Syntax: ImapMenu

{none, formatted, semiformatted,
+                                                      unformatted}

+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Module: mod_imap.c
+Compatibility: ImapMenu is only available in Apache +1.1 and later.

+ +The ImapMenu directive determines the action taken if an imagemap file +is called without valid coordinates. +

none +: If ImapMenu is + none, no menu is generated, and the default + action is performed. +
formatted +: A formatted menu is the simplest menu. Comments + in the imagemap file are ignored. A level one header is + printed, then an hrule, then the links each on a separate line. + The menu has a consistent, plain look close to that of + a directory listing. +
semiformatted +: In the semiformatted menu, comments are printed + where they occur in the imagemap file. Blank lines are turned + into HTML breaks. No header or hrule is printed, but otherwise + the menu is the same as a formatted menu. +
unformatted +: Comments are printed, blank lines are ignored. Nothing is + printed that does not appear in the imagemap file. All breaks + and headers must be included as comments in the imagemap file. + This gives you the most flexibility over the appearance of your + menus, but requires you to treat your map files as HTML instead + of plaintext. +

+ +

ImapDefault

+Syntax: ImapDefault

{error, nocontent,
+                                                 map, referer, URL}

+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Module: mod_imap.c
+Compatibility: ImapDefault is only available in Apache +1.1 and later.

+ + +The ImapDefault directive sets the default default used in +the imagemap files. It's value is overridden by a default +directive within the imagemap file. If not present, the +default action is nocontent, which means +that a 204 No Content is sent to the client. In this +case, the client should continue to display the original page. + +

+ +

ImapBase

+Syntax: ImapBase {map, referer, URL}
+Context: server config, virtual host, directory, .htaccess
+Override: Indexes
+Module: mod_imap.c
+Compatibility: ImapBase is only available in Apache +1.1 and later.

+ +The ImapBase directive sets the default base used in +the imagemap files. It's value is overridden by a base +directive within the imagemap file. If not present, the +base defaults to http://servername/. + +

+ +

Imagemap File

+The lines in the imagemap files can have one of several formats: +

+directive value [x,y ...]
+directive value "Menu text" [x,y ...]
+directive value x,y ... "Menu text"
+

+The directive is one of base, default, +poly, circle, rect, or +point. The value is an absolute or relative URL, or one +of the special values listed below. The coordinates are +x,y pairs seperated by whitespace. The quoted text is +used as the text of the link if a imagemap menu is generated. Lines +beginning with '#' are comments. + +

Imagemap File Directives

+There are six directives allowed in the imagemap file. The directives +can come in any order, but are processed in the order they are found +in the imagemap file. +

base Directive +: Has the effect of <BASE href="value">. The + non-absolute URLs of the mapfile are taken relative to this value. + The base directive overrides ImapBase as set in a + .htaccess file or in the server configuration files. In the absence + of an ImapBase configuration directive, base defaults to + http://server_name/.
+ base_uri is synonymous with base. Note that + a trailing slash on the URL is significant. +
+
default Directive +: The action taken if the coordinates given do not fit any of the + poly, circle or rect + directives, and there are no point directives. Defaults + to nocontent in the absence of an ImapDefault + configuration setting, causing a status code of 204 No + Content to be returned. The client should keep the same + page displayed. +
+
poly Directive +: Takes three to one-hundred points, and is obeyed if the user selected + coordinates fall within the polygon defined by these points. +
+
circle +: Takes the center coordinates of a circle and a point on the circle. Is + obeyed if the user selected point is with the circle. +
+
rect Directive +: Takes the coordinates of two opposing corners of a rectangle. Obeyed + if the point selected is within this rectangle. +
+
point Directive +: Takes a single point. The point directive closest to the user + selected point is obeyed if no other directives are satisfied. + Note that default will not be followed if a + point directive is present and valid coordinates are + given. +

+ + + +

Values

+The values for each of the directives can any of the following: +

a URL +: The URL can be relative or absolute URL. Relative URLs can + contain '..' syntax and will be resolved relative to the + base value.
+ base itself will not resolved according to the current + value. A statement base mailto: will work properly, though. +
+
map +: Equivalent to the URL of the imagemap file itself. No + coordinates are sent with this, so a menu will be generated + unless ImapMenu is set to 'none'. +
+
menu +: Synonymous with map. +
+
referer +: Equivalent to the URL of the refering document. + Defaults to http://servername/ if no Referer: + header was present. +
+
nocontent +: Sends a status code of 204 No Content, + telling the client to keep the same page displayed. Valid for + all but base. +
+
error +: Fails with a 500 Server Error. Valid for all but + base, but sort of silly for anything but + default. +

+ +

Coordinates

0,0 200,200 +: A coordinate consists of an x and a y value + separated by a comma. The coordinates are separated from each other + by whitespace. To accomodate the way Lynx handles imagemaps, should a + user select the coordinate 0,0, it is as if + no coordinate had been selected. +

+ +

Quoted Text

"Menu Text" +: After the value or after the coordinates, the line optionally may + contain text within double quotes. This string is used as the + text for the link if a menu is generated:
+ <a href="http://foo.com/">Menu text</a>
+ If no quoted text is present, the name of the link will be used + as the text:
+ <a href="http://foo.com/">http://foo.com</a>
+ It is impossible to escape double quotes within this text. +

+ +

Example Mapfile

+#Comments are printed in a 'formatted' or 'semiformatted' menu. +#And can contain html tags. <hr> +base referer +poly map "Could I have a menu, please?" 0,0 0,10 10,10 10,0 +rect .. 0,0 77,27 "the directory of the referer" +circle http://www.inetnebr.com/lincoln/feedback/ 195,0 305,27 +rect another_file "in same directory as referer" 306,0 419,27 +point http://www.zyzzyva.com/ 100,100 +point http://www.tripod.com/ 200,200 +rect mailto:nate@tripod.com 100,150 200,0 "Bugs?" +

+ +

Referencing your mapfile

+<A HREF="/maps/imagmap1.map"> +<IMG ISMAP SRC="/images/imagemap1.gif"> +</A> +

+ +

+ + + + diff --git a/docs/manual/mod/mod_include.html b/docs/manual/mod/mod_include.html new file mode 100644 index 0000000000..770a8e2521 --- /dev/null +++ b/docs/manual/mod/mod_include.html @@ -0,0 +1,211 @@ + + + + +Apache module mod_include + + + +

+ +

Module mod_include

+ +This module is contained in the mod_include.c file, and +is compiled in by default. It provides for server-parsed html documents, +known as SPML documents. +Any document with mime type text/x-server-parsed-html or +text/x-server-parsed-html3 will be parsed by this module, +with the resulting output given the mime type text/html. + + + +

SPML -- Include file Format

+ +The document is parsed as an HTML document, with special commands embedded +as SGML comments. A command has the syntax: +

+ +

+The value will often be enclosed in double quotes; many commands only allow +a single attribute-value pair. +

+The allowed elements are:

config +

+ +This command controls various aspects of the parsing. The valid attributes +are: +

errmsg +: The value is a message that is sent back to the client if an error occurs +whilst parsing the document. +
sizefmt +: The value sets the format to be used which displaying the size of a file. +Valid values are bytes for a count in bytes, or +abbrev for a count in Kb or Mb as appropriate. +
timefmt +: The value is a string to be used by the strftime(3) library +routine when printing dates. +

+ +

echo +

+ +This command prints one of the include variables, defined below. +If the variable is unset, it is printed as (none). +Any dates printed are subject to the currently configured timefmt. +Attributes: +

var +: The value is the name of the variable to print. +

+ +

exec +

+ +The exec command executes a given shell command or CGI script. +The IncludesNOEXEC Option disables this command +completely. The valid attributes are: +

cgi +

+ +The value specifies a (%-encoded) URL relative path to the CGI script. +If the path does not begin with a (/), then it is taken to be relative to +the current document. The document referenced by this path is invoked +as a CGI script, even if the server would not normally recognise it as +such. However, the directory containing the script must be enabled for +CGI scripts (with ScriptAlias +or the ExecCGI Option).

+ + +The CGI script is given the PATH_INFO and query string (QUERY_STRING) of the +original request from the client; these cannot be specified in the URL path. +The include variables will be available to the script in addition to the +standard CGI environment.

+If the script returns a Location: header instead of output, then this +will be translated into an HTML anchor.

+The include virtual element should be used in preference to +exec cgi. +

cmd +

The server will execute the given string using /bin/sh. +The include variables are available to the command. +

+ +

fsize +

+ +This command prints the size of the specified file, subject to the +sizefmt format specification. Attributes: +

file +: The value is a path relative to the directory containing the current +document being parsed. +
virtual +: The value is a (%-encoded) URL-path relative to the current document being +parsed. If it does not begin with a slash (/) then it is taken to be relative +to the current document. +

+ +

flastmod +

+This command prints the last modification date of the specified file, +subject to the timefmt format specification. The attributes are +the same as for the fsize command. + +

include +

+This command inserts the text of another document or file into the parsed +file. Any included file is subject to the usual access control. If the +directory containing the parsed file has the +Option +IncludesNOEXEC set, and the including the document would cause a program +to be executed, then it will not be included; this prevents the execution of +CGI scripts. Otherwise CGI scripts are invoked as normal using the complete +URL given in the command, including any query string. + +

+ +An attribute defines the location of the document; the inclusion is done for +each attribute given to the include command. The valid attributes are: +

file +: The value is a path relative to the directory containing the current +document being parsed. It cannot contain ../, nor can it be an +absolute path. The virtual attribute should always be used +in preference to this one. +
virtual +: The value is a (%-encoded) URL relative to the current document being +parsed. The URL cannot contain a scheme or hostname, only a path and +an optional query string. If it does not begin with a slash (/) then it +is taken to be relative to the current document. +

+A URL is constructed from the attribute, and the output the server +would return if the URL were accessed by the client is included in the parsed +output. Thus included files can be nested. +

+ +

Include variables

+These are available for the echo command, and to any program +invoked by the document. +

DATE_GMT +: The current date in Greenwich Mean Time. +
DATE_LOCAL +: The current date in the local time zone. +
DOCUMENT_NAME +: The filename (excluding directories) of the document requested by the +user. +
DOCUMENT_URI +: The (%-decoded) URL path of the document requested by the user. Note that +in the case of nested include files, this is not then URL for the +current document. +
LAST_MODIFIED +: The last modification date of the document requested by the user. +

+ + +

Directives

XBitHack +

+ + +

XBitHack

+ +Syntax: XBitHack status
+Default: XBitHack off
+Context: server config, virtual host, directory, .htaccess
+Override: Options
+Status: Base
+Module: mod_include

+ +The XBitHack directives controls the parsing of ordinary html documents. +Status can have the following values: +

off +: No special treatment of executable files. +
on +: Any file that has the user-execute bit set will be treated as a +server-parsed html document. +
full +: As for on but also test the group-execute bit. If it +is set, then set the Last-modified date of the returned file to be the +last modified time of the file. If it is not set, then no last-modified date +is sent. Setting this bit allows clients and proxies to cache the result of +the request. +

+ +

+ + + + diff --git a/docs/manual/mod/mod_info.html b/docs/manual/mod/mod_info.html new file mode 100644 index 0000000000..6261f5f32b --- /dev/null +++ b/docs/manual/mod/mod_info.html @@ -0,0 +1,44 @@ + + + +Apache module mod_info + + + +

Module mod_info

+ +This module is contained in the mod_info.c file. It +provides a comprehensive overview of the current server configuration +including all installed modules. This module is not compiled into the +server by default. It is only available in Apache 1.1 and later. To +enable it, add the following line to the server build Configuration +file, and rebuild the server: + +

+Module info_module   mod_info.o
+

+ +

+To configure it, add the following to your access.conf file. + +

+<Location /server-info>
+SetHandler server-info
+</Location>
+

+ +You may wish to add a limit clause inside the location directive to limit +access to your server configuration information.

+Once configured, the server information is obtained by accessing +http://your.host.dom/server-info

+ + +

+ + + + diff --git a/docs/manual/mod/mod_log_agent.html b/docs/manual/mod/mod_log_agent.html new file mode 100644 index 0000000000..47de105b5a --- /dev/null +++ b/docs/manual/mod/mod_log_agent.html @@ -0,0 +1,54 @@ + + + + +Apache module mod_log_agent + + + +

+ +

Module mod_log_agent

+ +This module is contained in the mod_log_agent.c file, and is not +compiled in by default. It provides for logging of the client user agents. + + +

AgentLog +

+ + +

AgentLog

+ +Syntax: AgentLog file-pipe
+Default: AgentLog logs/agent_log
+Context: server config, virtual host
+Status: Extension
+Module: mod_log_agent

+ +The AgentLog directive sets the name of the file to which the server will +log the UserAgent header of incoming requests. File-pipe is one +of +

A filename +: A filename relative to the ServerRoot. +
`|' followed by a command +: A program to receive the agent log information on its standard input. +Note the a new program will not be started for a VirtualHost if it inherits +the AgentLog from the main server. +

+Security: if a program is used, then it will be +run under the user who started httpd. This will be root if the server +was started by root; be sure that the program is secure.

+ +This directive is provided for compatibility with NCSA 1.4.

+ +

+ + + + diff --git a/docs/manual/mod/mod_log_config.html b/docs/manual/mod/mod_log_config.html new file mode 100644 index 0000000000..6855ec5c61 --- /dev/null +++ b/docs/manual/mod/mod_log_config.html @@ -0,0 +1,144 @@ + + + + +Apache module mod_log_config + + + +

+ +

Module mod_log_config

+ +This module is contained in the mod_log_config.c file, and is not +compiled in by default. It provides for logging of the requests made to +the server, using a user-specified format. + +

Summary

+This is an EXPERIMENTAL module, which implements the TransferLog directive +(same as the common log module), and an additional directive, LogFormat. +Bugs would not surprise me.

+ +The argument to the LogFormat is a string, which can +include literal characters copied into the log files, and `%' directives as +follows: + +

+%...h:          Remote host
+%...l:          Remote logname (from identd, if supplied)
+%...u:          Remote user (from auth; may be bogus if return 
+                status (%s) is 401)
+%...t:          Time, in common log format time format
+%...r:          First line of request
+%...s:          Status.  For requests that got internally redirected, 
+                this is status of the original request --- %...>s 
+                for the last.
+%...b:          Bytes sent.
+%...{Foobar}i:  The contents of Foobar: header line(s) in the request
+                sent to the client.
+%...{Foobar}o:  The contents of Foobar: header line(s) in the reply.
+

+ +The `...' can be nothing at all (e.g. "%h %u %r %s %b"), or it can +indicate conditions for inclusion of the item (which will cause it +to be replaced with `-' if the condition is not met). Note that +there is no escaping performed on the strings from %r, %...i and +%...o; some with long memories may remember that I thought this was +a bad idea, once upon a time, and I'm still not comfortable with +it, but it is difficult to see how to `do the right thing' with all +of `%..i', unless we URL-escape everything and break with CLF. + +

+ +The forms of condition are a list of HTTP status codes, which may +or may not be preceded by `!'. Thus, `%400,501{User-agent}i' logs +User-agent: on 400 errors and 501 errors (Bad Request, Not +Implemented) only; `%!200,304,302{Referer}i' logs Referer: on all +requests which did not return some sort of normal status. + +

+ +The default LogFormat reproduces CLF; see below. + +

+ +The way this is supposed to work with virtual hosts is as follows: +a virtual host can have its own LogFormat, or its own TransferLog. +If it doesn't have its own LogFormat, it inherits from the main +server. If it doesn't have its own TransferLog, it writes to the +same descriptor (meaning the same process for `| ...'). + +

+ +That means that you can do things like: + +

+<VirtualHost hosta.com> +LogFormat "hosta ..." +... +</VirtualHost> + +<VirtualHost hosta.com> +LogFormat "hostb ..." +... +</VirtualHost>

+ +... to have different virtual servers write into the same log file, +but have some indication which host they came from, though a %v +directive may well be a better way to handle this. Look for more +changes to come to this format.

+ + + + +

Directives

+ +

LogFormat +
TransferLog +

+ + +

LogFormat

+ +Syntax: LogFormat string
+Default:

LogFormat "%h %l %u %t \"%r\"
+%s %b"

+Context: server config, virtual host
+Status: Experimental
+Module: mod_log_config

+ +This sets the format of the logfile.

+ + +

TransferLog

+ +Syntax: TransferLog file-pipe
+Default: TransferLog logs/transfer_log
+Context: server config, virtual host
+Status: Experimental
+Module: mod_log_config

+ +The TransferLog directive sets the name of the file to which the server will +log the incoming requests. File-pipe is one +of +

A filename +: A filename relative to the ServerRoot. +
`|' followed by a command +: A program to receive the agent log information on its standard input. +Note the a new program will not be started for a VirtualHost if it inherits +the TransferLog from the main server. +

+Security: if a program is used, then it will be +run under the user who started httpd. This will be root if the server +was started by root; be sure that the program is secure.

+ + +

+ + + + diff --git a/docs/manual/mod/mod_log_referer.html b/docs/manual/mod/mod_log_referer.html new file mode 100644 index 0000000000..c16e60a0a6 --- /dev/null +++ b/docs/manual/mod/mod_log_referer.html @@ -0,0 +1,80 @@ + + + + +Apache module mod_log_referer + + + +

+ +

Module mod_log_referer

+ +This module is contained in the mod_log_referer.c file, and is not +compiled in by default. It provides for logging of the documents which +reference documents on the server. + +

Log file format

+The log file contains a separate line for each refer. Each line has the +format +

uri -> document

+where uri is the (%-escaped) URI for the document that references +the one requested by the client, and document is the (%-decoded) +local URL to the document being referred to. + + +

Directives

RefererIgnore +
RefererLog +

+ + +

RefererIgnore

+ +Syntax: RefererIgnore string string ...
+Context: server config, virtual host
+Status: Extension
+Module: mod_log_referer

+ +The RefererIgnore directive adds to the list of strings to ignore in +Referer headers. If any of the strings in the list is contained in +the Referer header, then no referrer information will be logged for the +request. Example: +

RefererIgnore www.ncsa.uiuc.edu

+This avoids logging references from www.ncsa.uiuc.edu. +

+ + +

RefererLog

+ +Syntax: RefererLog file-pipe
+Default: RefererLog logs/referer_log
+Context: server config, virtual host
+Status: Extension
+Module: mod_log_referer

+ +The RefererLog directive sets the name of the file to which the server will +log the Referer header of incoming requests. File-pipe is one +of +

A filename +: A filename relative to the ServerRoot. +
`|' followed by a command +: A program to receive the referrer log information on its standard input. +Note the a new program will not be started for a VirtualHost if it inherits +the RefererLog from the main server. +

+Security: if a program is used, then it will be +run under the user who started httpd. This will be root if the server +was started by root; be sure that the program is secure.

+ +This directive is provided for compatibility with NCSA 1.4.

+ +

+ + + + diff --git a/docs/manual/mod/mod_mime.html b/docs/manual/mod/mod_mime.html new file mode 100644 index 0000000000..c3dc14af92 --- /dev/null +++ b/docs/manual/mod/mod_mime.html @@ -0,0 +1,210 @@ + + + + +Apache module mod_mime + + + +

+ +

Module mod_mime

+ +This module is contained in the mod_mime.c file, and is +compiled in by default. It provides for determining the types of files +from the filename. + +

Summary

+This module is used to determine the mime types of documents. Some mime +types indicate special processing to be performed by the server, otherwise +the type is returned to the client so that the browser can deal with +the document appropriately.

+ +The filename of a document is treated as being composed of a basename followed +by some extensions, in the following order: +

base.type.language.enc

+The type extension sets the type of the document; types are defined +in the TypesConfig file and by the +AddType directive. The language extension +sets the language of the document, as defined by the +AddLanguage directive. Finally, the +enc directive sets the encoding of the document, as defined by +the AddEncoding directive. + + +

Directives

AddEncoding +
AddHandler +
AddLanguage +
AddType +
ForceType +
SetHandler +
TypesConfig +

+ + +

AddEncoding

+ +Syntax: AddEncoding mime-enc extension extension...
+Context: server config, virtual host, directory, .htaccess
+Override: FileInfo
+Status: Base
+Module: mod_mime

+ +The AddEncoding directive adds to the list of filename extensions which +filenames may end in for the specified encoding type. Mime-enc +is the mime encoding to use for documents ending in extension. +Example: +

+AddEncoding x-gzip gz +AddEncoding x-compress Z +

+ +This will cause files ending in .gz to be marked as encoded using the x-gzip +encoding, and .Z files to be marked as encoded with x-compress.

+ +

AddHandler

+ +Syntax: <AddHandler handler-name extention>
+Context: server config, virtual host, directory, .htaccess
+Status: Base
+Module: mod_mime
+Compatibility: AddHandler is only available in Apache +1.1 and later

+ +

AddHandler maps the filename extension extension to the +handler +handler-name. For example, to activate CGI scripts +with the file extension ".cgi", you might use: +

+    AddHandler cgi-script cgi
+

+ +

Once that has been put into your srm.conf or httpd.conf file, any +file ending with ".cgi" will be treated as a CGI +program.

+ + +

AddLanguage

+ +Syntax: AddLanguage mime-lang extension extension...
+Context: server config, virtual host, directory, .htaccess
+Override: FileInfo
+Status: Base
+Module: mod_mime

+ +The AddLanguage directive adds to the list of filename extensions which +filenames may end in for the specified content language. Mime-lang +is the mime language of files with names ending extension, +after any content encoding extensions have been removed. Example: +

+AddEncoding x-compress Z +AddLanguage en .en +AddLanguage fr .fr +

+ +Then the document xxxx.en.Z will be treated as being a compressed +English document. Although the content language is reported to the client, +the browser is unlikely to use this information. The AddLanguage directive +is more useful for content negotiation, where the server returns one +from several documents based on the client's language preference.

+ +

AddType

+ +Syntax: AddType mime-type extension extension...
+Context: server config, virtual host, directory, .htaccess
+Override: FileInfo
+Status: Base
+Module: mod_mime

+ +The AddType directive adds to the list of filename extensions which +filenames may end in for the specified content type. Mime-enc +is the mime type to use for documents ending in extension. +after content-encoding and language extensions have been removed. Example: +

+AddType image/gif GIF +

+It is recommended that new mime types be added using the AddType directive +rather than changing the TypesConfig file.

+Note that, unlike the NCSA httpd, this directive cannot be used to set the +type of particular files.

+ +

ForceType

+ +Syntax: <ForceType media type>
+Context: directory, .htaccess
+Status: Base
+Module: mod_mime
+Compatibility: ForceType is only available in Apache +1.1 and later.

+ +

When placed into an .htaccess file or a +<Directory> or <Location section, +this directive forces all matching files to be served +as the content type given by media type. For example, if you +had a directory full of GIF files, but did not want to label them all with +".gif", you might want to use: +

+    ForceType image/gif
+

Note that this will override any filename extensions that might +media type.

+ +

SetHandler

+ +Syntax: <SetHandler handler-name>
+Context: directory, .htaccess
+Status: Base
+Module: mod_mime
+Compatibility: SetHandler is only available in Apache +1.1 and later.

+ +

When placed into an .htaccess file or a +<Directory> or <Location section, +this directive forces all matching files to be parsed through the +handler +given by handler-name. For example, if you had a +directory you wanted to be parsed entirely as imagemap rule files, +regardless of extension, you might put the following into an +.htaccess file in that directory: +

+    SetHandler imap-file
+

+ +

Another example: if you wanted to have the server display a status +report whenever a URL of http://servername/status was +called, you might put the following into access.conf: +

+    <Location /status>
+    SetHandler server-status
+    </Location>
+

+ + +

TypesConfig

+ +Syntax: TypesConfig filename
+Default: TypesConfig conf/mime.types
+Context: server config
+Status: Base
+Module: mod_mime

+ +The TypesConfig directive sets the location of the mime types configuration +file. Filename is relative to the +ServerRoot. This file sets the default list of +mappings from filename extensions to content types; changing this file is not +recommended. Use the AddType directive instead. The +file contains lines in the format of the arguments to an AddType command: +

mime-type extension extension ...

+The extensions are lower-cased. Blank lines, and lines beginning with a hash +character (`#') are ignored.

+ +

+ + + + diff --git a/docs/manual/mod/mod_negotiation.html b/docs/manual/mod/mod_negotiation.html new file mode 100644 index 0000000000..6b8ac6e7d5 --- /dev/null +++ b/docs/manual/mod/mod_negotiation.html @@ -0,0 +1,134 @@ + + + + +Apache module mod_negotiation + + + +

+ +

Module mod_negotiation

+ +This module is contained in the mod_negotiation.c file, and +is compiled in by default. It provides for +content negotiation. Any document with +mime type application/x-type-map will be processed by this module. + + +

Summary

+Content negotiation, or more accurately content selection, is the +selection of the document that best matches the clients +capabilities, from one of several available documents. +There are two implementations of this. +

A type map (a file with the mime type application/x-type-map) +which explicitly lists the files containing the variants. +
A MultiViews search (enabled by the MultiViews +Option, where the server does an implicit +filename pattern match, and choose from amongst the results. +

+ +

Type maps

+A type map has the same format as RFC822 mail headers. It contains document +descriptions separated by blank lines, with lines beginning with a hash +character ('#') treated as comments. A document description consists of +several header records; records may be continued on multiple lines if the +continuation lines start with spaces. The leading space will be deleted +and the lines concatenated. A header record consists of a keyword +name, which always ends in a colon, followed by a value. Whitespace is allowed +between the header name and value, and between the tokens of value. + +The headers +allowed are: + +

Content-Encoding: +

The encoding of the file. Currently only two encodings are recognised +by http; x-compress for compressed files, and x-gzip +for gzipped files. +

Content-Language: +

The language of the variant, as an Internet standard language code, such +as en. +

Content-Length: +

The length of the file, in bytes. If this header is not present, then +the actual length of the file is used. +

Content-Type: +

The MIME media type of the document, with optional parameters. +parameters are separated from the media type and from one another by +semi-colons. Parameter syntax is name=value; allowed parameters are: +

level +: the value is an integer, which specifies the version of the media type. +For text/html this defaults to 2, otherwise 0. +
qs +: the value is a floating-point number with value between 0. and 1. +It indications the 'quality' of this variant. +

+Example: +

Content-Type: image/jpeg; qs=0.8

URI: +

The path to the file containing this variant, relative to the map file. +

+ +

MultiViews

+A MultiViews search is enabled by the MultiViews +Option. +If the server receives a request for /some/dir/foo and +/some/dir/foo does not exist, then the server reads the +directory looking for all files named foo.*, and effectively +fakes up a type map which names all those files, assigning them the same media +types and content-encodings it would have if the client had asked for +one of them by name. It then chooses the best match to the client's +requirements, and returns that document.

+ + + +

Directives

CacheNegotiatedDocs +
LanguagePriority +

+ + +

CacheNegotiatedDocs

+Syntax: CacheNegotiatedDocs
+Context: server config
+Status: Base
+Module: mod_negotiation
+Compatibility: CacheNegotiatedDocs is only available +in Apache 1.1 and later.

+ +

If set, this directive allows content-negotiated documents to be cached +by +proxy servers. This could mean that clients behind those proxys could +retrieve versions of the documents that are not the best match for +their abilities, but it will make caching more efficient.

+ + +

LanguagePriority

+ +Syntax: LanguagePriority mime-lang mime-lang...
+Context: server config, virtual host, directory, .htaccess
+Override: FileInfo
+Status: Base
+Module: mod_negotiation

+ +The LanguagePriority sets the precedence of language variants for the case +where the client does not express a preference, when handling a +MultiViews request. The list of mime-lang are in order of decreasing +preference. Example: +

LanguagePriority en fr de

+For a request for foo.html, where foo.html.fr +and foo.html.de both existed, but the browser did not express +a language preference, then foo.html.fr would be returned.

+ +

+ + + + diff --git a/docs/manual/mod/mod_proxy.html b/docs/manual/mod/mod_proxy.html new file mode 100644 index 0000000000..b64dcd9c6d --- /dev/null +++ b/docs/manual/mod/mod_proxy.html @@ -0,0 +1,212 @@ + + + +Apache module mod_proxy + + + +

Apache module mod_proxy

+ +This module is contained in the mod_proxy.c file, and +is not compiled in by default. It provides for a caching proxy server. +It is only available in Apache 1.1 and later. + +

Note:

This module is experimental. Use at your own risk.

+ +

Summary

+ +This module implements a proxy/cache for Apache. It implements +proxying capability for +FTP, +HTTP/0.9, and +HTTP/1.0. +The module can be configured to connect to other proxy modules for these +and other protocols. + +

Directives

ProxyRequests +
ProxyRemote +
ProxyPass +
CacheRoot +
CacheSize +
CacheGcInterval +
CacheMaxExpire +
CacheLastModifiedFactor +
CacheDefaultExpire +
NoCache +

+ +

ProxyRequests

+Syntax: ProxyRequests on/off
+Default: ProxyRequests Off
+Context: server config
+Status: Base
+Module: mod_proxy
+Compatibility: ProxyRequest is only available in +Apache 1.1 and later.

+ +This allows or prevents Apache from functioning as a proxy +server. Setting ProxyRequests to 'off' does not disable use of the ProxyPass directive. + +

ProxyRemote

+Syntax: ProxyRemote <match> <remote-server>
+Context: server config
+Status: Base
+Module: mod_proxy
+Compatibility: ProxyRemote is only available in +Apache 1.1 and later.

+ +This defines remote proxies to this proxy. <match> is either the +name of a URL-scheme that the remote server supports, or a partial URL +for which the remote server should be used, or '$' to indicate the +server should be contacted for all requests. <remote-server> is a +partial URL for the remote server. Syntax: + +

+  <remote-server> = <protocol>://<hostname>[:port]
+

+<protocol> is the protocol that should be used to communicate with the +remote +server; only "http" is supported by this module. + +Example: +

+  ProxyRemote ftp http://ftpproxy.mydomain.com:8080
+  ProxyRemote http://goodguys.com/ http://mirrorguys.com:8000
+  ProxyRemote * http://cleversite.com
+

+ +

ProxyPass

+Syntax: ProxyPass <path> <url>
+Context: server config
+Status: Base
+Module: mod_proxy
+Compatibility: ProxyPass is only available in +Apache 1.1 and later.

+ +This directive allows remote servers to be mapped into the space of the local +server; the local server does not act as a proxy in the conventional sense, +but appears to be a mirror of the remote server. <path> is the name of +a local virtual path; <url> is a partial URL for the remote server. + +Suppose the local server has address http://wibble.org; then +

+   ProxyPass /mirror/foo http://foo.com
+

+Will cause a local request for the http://wibble.org/mirror/foo/bar to be +internally converted into a proxy request to http://foo.com/bar + +

CacheRoot

+Syntax: CacheRoot <directory>
+Context: server config
+Status: Base
+Module: mod_proxy
+Compatibility: CacheRoot is only available in +Apache 1.1 and later.

+ +Sets the name of the directory to contain cache files; this must be +writable +by the httpd server. + +

CacheSize

+Syntax: CacheSize <size>
+Default: CacheSize 5
+Context: server config
+Status: Base
+Module: mod_proxy
+Compatibility: CacheSize is only available in +Apache 1.1 and later.

+ +Sets the desired space usage of the cache, in Kb (1024 byte units). Although +usage may grow above this setting, the garbage collection will delete files +until the usage is at or below this setting. + +

CacheGcInterval

+Syntax: CacheGcInterval <time>
+Context: server config
+Status: Base
+Module: mod_proxy
+Compatibility: CacheGcinterval is only available in +Apache 1.1 and later.

+ +Check the cache every <time> hours, and delete files if the space +usage is greater than that set by CacheSize. + +

CacheMaxExpire

+Syntax: CacheMaxExpire <time>
+Default: CacheMaxExpire 24
+Context: server config
+Status: Base
+Module: mod_proxy
+Compatibility: CacheMaxExpire is only available in +Apache 1.1 and later.

+ +Cachable HTTP documents will be retained for at most <time> hours without +checking the origin server. Thus documents can be at most <time> +hours out of date. This restriction is enforced even if an expiry date +was supplied with the document. + +

CacheLastModifiedFactor

+Syntax: CacheLastModifiedFactor <factor>
+Default: CacheLastModifiedFactor 0.1
+Context: server config
+Status: Base
+Module: mod_proxy
+Compatibility: CacheLastModified is only available in +Apache 1.1 and later.

+ +If the origin HTTP server did not supply an expiry date for the +document, then estimate on using the formula +

+  expiry-period = time-since-last-modification * <factor>
+

+For example, if the document was last modified 10 hours ago, and +<factor> is 0.1, then the expiry period wil be set to 10*0.1 = 1 hour. + +

If the expiry-period would be longer than that set by CacheMaxExpire, +then the latter takes precedence. + +

CacheDefaultExpire

+Syntax: CacheDefaultExpire <time>
+Default: CacheDefaultExpire 1
+Context: server config
+Status: Base
+Module: mod_proxy
+Compatibility: CacheDefaultExpire is only available in +Apache 1.1 and later.

+ +If the document is fetched via a protocol that does not support expirytimes, +then use <time> as the expiry time. +CacheMaxExpire does not +override. + +

NoCache

+Syntax: NoCache <host/domain list>
+Context: server config
+Status: Base
+Module: mod_proxy
+Compatibility: NoCache is only available in +Apache 1.1 and later.

+ +The NoCache directive specifies a list of hosts and/or domains, separated +by spaces. HTTP documents from hosts or domains in the list are not +cached by the proxy server. Example: + +

+  NoCache joes.garage.com some.host.co.uk wotsamattau.edu
+

+ +

+ + + + diff --git a/docs/manual/mod/mod_status.html b/docs/manual/mod/mod_status.html new file mode 100644 index 0000000000..34ce9b6cc9 --- /dev/null +++ b/docs/manual/mod/mod_status.html @@ -0,0 +1,94 @@ + +Apache Status Module + + +

Apache Status Module

+ +The Status Module is only available in Apache 1.1 and later.

+ +

Function

+ +The Status module allows a server administrator to find out how well +their server is performing. A HTML page is presented that gives +the current server statistics in an easily readable form. If required +this page can be made to automatically refresh (given a compatible +browser). Another page gives a simple machine-readable list of the current +server state. +

+The details given are: +

The number of children serving requests +
The number of idle children +
The status of each child, the number of requests that child has +performed and the total number of bytes served by the child (*) +
A total number of accesses and byte count served (*) +
The time the server was started/restarted and the +time it has been running for +
Averages giving the number of requests per second, +the number of bytes served per second and the average number +of bytes per request (*) +
The current percentage CPU used by each child and in total by +Apache (*) +
The current hosts and requests being processed (*) +

+ +A compile-time option must be used to display the details marked "(*)" as +the instrumentation required for obtaining these statistics does not +exist within standard Apache. + +

Enabling Status Support

+ +To enable status reports only for browsers from the foo.com +domain add this code to your access.conf configuration file +

+    <Location /server-status>
+    SetHandler server-status
+    
+    <Limit GET POST>
+    order deny,allow
+    deny from all
+    allow from .foo.com
+    </Limit>
+    </Location>
+

+You can now access server statistics by using a Web browser to access the +page http://your.server.name/server-status +

Automatic Updates

+You can get the status page to update itself automatically if you have +a browser that supports "refresh". Access the page +http://your.server.name/server-status?refresh=N to refresh the page +every N seconds. +

Machine Readable Status File

+A machine-readable version of the status file is available by accessing the +page http://your.server.name/server-status?auto. This is useful +when automatically run, see the Perl program in the /support +directory of Apache, log_server_status. + +

Full Instrumentation

+ +To obtain full statistics you must compile Apache with a special +directive. On some machines there may be a small performance loss +if you do this. Try full statistics and see if you notice any +difference. If you do please contact +mark@ukweb.com and tell me your configuration. + +

+Do this by adding the following to the AUX_CFLAGS line in the +"Configuration" file and then recompiling as usual. +

+	AUX_CFLAGS= (something) -DSTATUS
+

+ + + + +

+ + + + diff --git a/docs/manual/mod/mod_userdir.html b/docs/manual/mod/mod_userdir.html new file mode 100644 index 0000000000..a1a517faff --- /dev/null +++ b/docs/manual/mod/mod_userdir.html @@ -0,0 +1,54 @@ + + + + +Apache module mod_userdir + + + +

+ +

Module mod_userdir

+ +This module is contained in the mod_userdir.c file, and +is compiled in by default. It provides for user-specific directories. + + +

UserDir +

+ + +

UserDir

+ +Syntax: UserDir directory/filename
+Default: UserDir public_html
+Context: server config, virtual host
+Status: Base
+Module: mod_userdir

+ +The UserDir directive sets the real directory in a user's home directory +to use when a request for a document for a user is received. +Directory is either disabled, to disable this feature, + or the name of a directory, following one of the following +patterns. If not disabled, then a request for +http://www.foo.com/~bar/one/two.html will be translated to: +

+UserDir public_html     -> ~bar/public_html/one/two.html
+UserDir /usr/web        -> /usr/web/bar/one/two.html
+UserDir /home/*/www     -> /home/bar/www/one/two.html
+

+The following directives will send redirects to the client: +

+UserDir http://www.x.com/users   -> http//www.x.com/users/bar/one/two.html
+UserDir http://www.x.com/*/y     -> http://www.x.com/y/one/two.html
+

+ +

+ + + + diff --git a/docs/manual/mod/mod_usertrack.html b/docs/manual/mod/mod_usertrack.html new file mode 100644 index 0000000000..c327020c8f --- /dev/null +++ b/docs/manual/mod/mod_usertrack.html @@ -0,0 +1,41 @@ + + + + +Apache module mod_usertrack + + + +

+ +

Module mod_usertrack

+ +This module is contained in the mod_usertrack.c file, and +is not compiled in by default. It provides for user tracking using cookies. +There is no documentation available for this module. Mark is writing this. + + + +

CookieLog +

+ + +

CookieLog

+ +Syntax: CookieLog filename
+Context: server config, virtual host
+Status: Experimental
+Module: mod_cookies

+ +The CookieLog directive sets the filename for logging of cookies. +The filename is relative to the ServerRoot. +

+ +

+ + + +