You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by sl...@locus.apache.org on 2000/09/28 18:56:03 UTC
cvs commit: httpd-docs-2.0/htdocs/manual/mod mod_so.html mod_speling.html mod_status.html mod_unique_id.html mod_userdir.html mod_vhost_alias.html
slive 00/09/28 09:56:00
Modified: htdocs/manual/mod mod_so.html mod_speling.html
mod_status.html mod_unique_id.html mod_userdir.html
mod_vhost_alias.html
Log:
Style update.
Revision Changes Path
1.7 +89 -68 httpd-docs-2.0/htdocs/manual/mod/mod_so.html
Index: mod_so.html
===================================================================
RCS file: /home/cvs/httpd-docs-2.0/htdocs/manual/mod/mod_so.html,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- mod_so.html 1999/02/26 17:07:03 1.6
+++ mod_so.html 2000/09/28 16:55:47 1.7
@@ -15,36 +15,108 @@
<!--#include virtual="header.html" -->
<H1 ALIGN="CENTER">Module mod_so</H1>
-This module is contained in the <CODE>mod_so.c</CODE> file. It is
-compiled in by default on Windows and is not compiled in by default on
-Unix. It provides for loading of executable code and modules into the
-server at start-up or restart time. On Unix, the loaded code typically
-comes from shared object files (usually with <SAMP>.so</SAMP>
-extension), whilst on Windows this module loads <SAMP>DLL</SAMP>
-files. This module is only available in Apache 1.3 and up.
+<p>This module provides for loading of executable code and modules into the
+server at start-up or restart time.</p>
+<P><A
+HREF="module-dict.html#Status"
+REL="Help"
+><STRONG>Status:</STRONG></A> Base (Windows); Experimental (Unix)
+<BR>
+<A
+HREF="module-dict.html#SourceFile"
+REL="Help"
+><STRONG>Source File:</STRONG></A> mod_so.c
+<BR>
+<A
+HREF="module-dict.html#ModuleIdentifier"
+REL="Help"
+><STRONG>Module Identifier:</STRONG></A> so_module
+<BR>
+<A
+HREF="module-dict.html#Compatibility"
+REL="Help"
+><STRONG>Compatibility:</STRONG></A> Available in Apache 1.3 and later.
+</P>
+
+
+<H2>Summary</H2>
+
+<p>This is an experimental module. On selected operating systems it
+can be used to load modules into Apache at runtime via the <A
+HREF="../dso.html">Dynamic Shared Object</A> (DSO) mechanism, rather
+than requiring a recompilation.
+
<P>
+On Unix, the loaded code typically comes from shared object files
+(usually with <SAMP>.so</SAMP> extension), whilst on Windows this
+module loads <SAMP>DLL</SAMP> files. This module is only available in
+Apache 1.3 and up.
+
-In previous releases, the functionality of this module was provided
+<p>In previous releases, the functionality of this module was provided
for Unix by mod_dld, and for Windows by mod_dll. On Windows, mod_dll
was used in beta release 1.3b1 through 1.3b5. mod_so combines these
two modules into a single module for all operating systems.
-<H2>Summary</H2>
-
-This is an experimental module. On selected operating systems it can be used
-to load modules into Apache at runtime via the <A HREF="../dso.html">Dynamic
-Shared Object</A> (DSO) mechanism, rather than requiring a recompilation.
-
<H2>Directives</H2>
<UL>
<LI><A HREF="#loadfile">LoadFile</A>
<LI><A HREF="#loadmodule">LoadModule</A>
</UL>
-<HR>
+<H2><A NAME="creating">Creating DLL Modules for Windows</A></H2>
+
+<P>The Apache module API is unchanged between the Unix and Windows
+ versions. Many modules will run on Windows with no or little change
+ from Unix, although others rely on aspects of the Unix architecture
+ which are not present in Windows, and will not work.</P>
+
+<P>When a module does work, it can be added to the server in one of two
+ ways. As with Unix, it can be compiled into the server. Because Apache
+ for Windows does not have the <CODE>Configure</CODE> program of Apache
+ for Unix, the module's source file must be added to the ApacheCore
+ project file, and its symbols must be added to the
+ <CODE>os\win32\modules.c</CODE> file.</P>
+
+<P>The second way is to compile the module as a DLL, a shared library
+ that can be loaded into the server at runtime, using the
+ <CODE><A HREF="#loadmodule">LoadModule</A></CODE>
+ directive. These module DLLs can be distributed and run on any Apache
+ for Windows installation, without recompilation of the server.</P>
+
+<P>To create a module DLL, a small change is necessary to the module's
+ source file: The module record must be exported from the DLL (which
+ will be created later; see below). To do this, add the
+ <CODE>MODULE_VAR_EXPORT</CODE> (defined in the Apache header files) to
+ your module's module record definition. For example, if your module
+ has:</P>
+<PRE>
+ module foo_module;
+</PRE>
+<P>Replace the above with:</P>
+<PRE>
+ module MODULE_VAR_EXPORT foo_module;
+</PRE>
+<P>Note that this will only be activated on Windows, so the module can
+ continue to be used, unchanged, with Unix if needed. Also, if you are
+ familiar with <CODE>.DEF</CODE> files, you can export the module
+ record with that method instead.</P>
+
+<P>Now, create a DLL containing your module. You will need to link this
+ against the ApacheCore.lib export library that is created when the
+ ApacheCore.dll shared library is compiled. You may also have to change
+ the compiler settings to ensure that the Apache header files are
+ correctly located.</P>
-<H2><A NAME="loadfile">LoadFile</A></H2>
+<P>This should create a DLL version of your module. Now simply place it
+ in the <SAMP>modules</SAMP> directory of your server root, and use
+ the <CODE><A HREF="#loadmodule">LoadModule</A></CODE> directive to
+ load it.</P>
+
+<HR>
+
+<H2><A NAME="loadfile">LoadFile</A> directive</H2>
<!--%plaintext <?INDEX {\tt LoadFile} directive> -->
<A
HREF="directive-dict.html#Syntax"
@@ -69,7 +141,7 @@
work. <EM>Filename</EM> is either and absolute path or relative to <A
HREF="core.html#serverroot">ServerRoot</A>.<P><HR>
-<H2><A NAME="loadmodule">LoadModule</A></H2>
+<H2><A NAME="loadmodule">LoadModule</A> directive</H2>
<!--%plaintext <?INDEX {\tt LoadModule} directive> -->
<A
HREF="directive-dict.html#Syntax"
@@ -105,57 +177,6 @@
loads the named module from the modules subdirectory of the
ServerRoot.<P>
-
-<HR>
-
-<H2><A NAME="creating">Creating DLL Modules for Windows</A></H2>
-
-<P>The Apache module API is unchanged between the Unix and Windows
- versions. Many modules will run on Windows with no or little change
- from Unix, although others rely on aspects of the Unix architecture
- which are not present in Windows, and will not work.</P>
-
-<P>When a module does work, it can be added to the server in one of two
- ways. As with Unix, it can be compiled into the server. Because Apache
- for Windows does not have the <CODE>Configure</CODE> program of Apache
- for Unix, the module's source file must be added to the ApacheCore
- project file, and its symbols must be added to the
- <CODE>os\win32\modules.c</CODE> file.</P>
-
-<P>The second way is to compile the module as a DLL, a shared library
- that can be loaded into the server at runtime, using the
- <CODE><A HREF="#loadmodule">LoadModule</A></CODE>
- directive. These module DLLs can be distributed and run on any Apache
- for Windows installation, without recompilation of the server.</P>
-
-<P>To create a module DLL, a small change is necessary to the module's
- source file: The module record must be exported from the DLL (which
- will be created later; see below). To do this, add the
- <CODE>MODULE_VAR_EXPORT</CODE> (defined in the Apache header files) to
- your module's module record definition. For example, if your module
- has:</P>
-<PRE>
- module foo_module;
-</PRE>
-<P>Replace the above with:</P>
-<PRE>
- module MODULE_VAR_EXPORT foo_module;
-</PRE>
-<P>Note that this will only be activated on Windows, so the module can
- continue to be used, unchanged, with Unix if needed. Also, if you are
- familiar with <CODE>.DEF</CODE> files, you can export the module
- record with that method instead.</P>
-
-<P>Now, create a DLL containing your module. You will need to link this
- against the ApacheCore.lib export library that is created when the
- ApacheCore.dll shared library is compiled. You may also have to change
- the compiler settings to ensure that the Apache header files are
- correctly located.</P>
-
-<P>This should create a DLL version of your module. Now simply place it
- in the <SAMP>modules</SAMP> directory of your server root, and use
- the <CODE><A HREF="#loadmodule">LoadModule</A></CODE> directive to
- load it.</P>
<!--#include virtual="footer.html" -->
1.10 +28 -13 httpd-docs-2.0/htdocs/manual/mod/mod_speling.html
Index: mod_speling.html
===================================================================
RCS file: /home/cvs/httpd-docs-2.0/htdocs/manual/mod/mod_speling.html,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- mod_speling.html 1998/08/06 23:31:55 1.9
+++ mod_speling.html 2000/09/28 16:55:50 1.10
@@ -14,16 +14,31 @@
<!--#include virtual="header.html" -->
<H1 ALIGN="CENTER">Module mod_speling</H1>
<P>
- This module is contained in the <CODE>mod_speling.c</CODE> file,
- and is <STRONG>not</STRONG> compiled in by default.
- It attempts to correct misspellings of
- URLs that users might have entered, by ignoring capitalization
- and by allowing up to one misspelling.<BR>
- This catches the majority of misspelled requests. An automatic
- "spelling corrected" redirection is returned if only one matching
- document was found, and a list of matches is returned if more than
- one document with a sufficiently similar name is found.
- </P>
+ This module attempts to correct misspellings of URLs that users
+ might have entered, by ignoring capitalization and by allowing up to
+ one misspelling.</P>
+
+<P><A
+HREF="module-dict.html#Status"
+REL="Help"
+><STRONG>Status:</STRONG></A> Extension
+<BR>
+<A
+HREF="module-dict.html#SourceFile"
+REL="Help"
+><STRONG>Source File:</STRONG></A> mod_speling.c
+<BR>
+<A
+HREF="module-dict.html#ModuleIdentifier"
+REL="Help"
+><STRONG>Module Identifier:</STRONG></A> speling_module
+<BR>
+<A
+HREF="module-dict.html#Compatibility"
+REL="Help"
+><STRONG>Compatibility:</STRONG></A> Available in Apache 1.3 and later. Available as an External module in Apache 1.1 and later.
+</P>
+
<H2>Summary</H2>
<P>
@@ -52,12 +67,12 @@
<H2>Directives</H2>
- <MENU>
+ <UL>
<LI><A HREF="#checkspelling">CheckSpelling</A>
- </MENU>
+ </UL>
<HR> <!-- the HR is part of the directive description -->
- <H2><A NAME="checkspelling">CheckSpelling</A></H2>
+ <H2><A NAME="checkspelling">CheckSpelling</A> directive</H2>
<!--%plaintext <?INDEX {\tt CheckSpelling} directive> -->
<A
HREF="directive-dict.html#Syntax"
1.18 +74 -40 httpd-docs-2.0/htdocs/manual/mod/mod_status.html
Index: mod_status.html
===================================================================
RCS file: /home/cvs/httpd-docs-2.0/htdocs/manual/mod/mod_status.html,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -r1.17 -r1.18
--- mod_status.html 2000/09/12 15:16:53 1.17
+++ mod_status.html 2000/09/28 16:55:50 1.18
@@ -15,16 +15,40 @@
<!--#include virtual="header.html" -->
<H1 ALIGN="CENTER">Module mod_status</H1>
-The Status Module is only available in Apache 1.1 and later.<P>
+<p>This module provides information on server activity and
+performance.</p>
-<H2>Function</H2>
+<P><A
+HREF="module-dict.html#Status"
+REL="Help"
+><STRONG>Status:</STRONG></A> Base
+<BR>
+<A
+HREF="module-dict.html#SourceFile"
+REL="Help"
+><STRONG>Source File:</STRONG></A> mod_status.c
+<BR>
+<A
+HREF="module-dict.html#ModuleIdentifier"
+REL="Help"
+><STRONG>Module Identifier:</STRONG></A> status_module
+<BR>
+<A
+HREF="module-dict.html#Compatibility"
+REL="Help"
+><STRONG>Compatibility:</STRONG></A> Available in Apache 1.1 and later.
+</P>
+
+
+<H2>Summary</H2>
-The Status module allows a server administrator to find out how well
+<p>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.
+server state.</p>
+
<P>
The details given are:
<UL>
@@ -47,43 +71,12 @@
the instrumentation required for obtaining these statistics does not
exist within standard Apache.
-<H2><A NAME="extendedstatus">ExtendedStatus directive</A></H2>
-<!--%plaintext <?INDEX {\tt ExtendedStatus} directive> -->
-<A
- HREF="directive-dict.html#Syntax"
- REL="Help"
-><STRONG>Syntax:</STRONG></A> ExtendedStatus <EM>On|Off</EM><BR>
-<A
- HREF="directive-dict.html#Default"
- REL="Help"
-><STRONG>Default:</STRONG></A> <CODE>ExtendedStatus Off</CODE><BR>
-<A
- HREF="directive-dict.html#Context"
- REL="Help"
-><STRONG>Context:</STRONG></A> server config <BR>
-<A
- HREF="directive-dict.html#Status"
- REL="Help"
-><STRONG>Status:</STRONG></A> Base<BR>
- <A
- HREF="directive-dict.html#Module"
- REL="Help"
- ><STRONG>Module:</STRONG></A> mod_status<BR>
-<A
- HREF="directive-dict.html#Compatibility"
- REL="Help"
-><STRONG>Compatibility:</STRONG></A> ExtendedStatus is only available
- in Apache 1.3.2 and later.
+<h2>Directives</h2>
-<P>
-This directive controls whether the server keeps track of extended
-status information for each request. This is only useful if the status module
-is enabled on the server.
-</P>
-<P>
-This setting applies to the entire server, and cannot be enabled or
-disabled on a virtualhost-by-virtualhost basis.
-</P>
+<ul>
+<li><a href="#extendedstatus">ExtendedStatus</a></li>
+</ul>
+
<H2>Enabling Status Support</H2>
@@ -126,6 +119,47 @@
security-related ramifications for your site.
</STRONG>
</BLOCKQUOTE>
+
+<hr>
+
+<H2><A NAME="extendedstatus">ExtendedStatus directive</A></H2>
+<!--%plaintext <?INDEX {\tt ExtendedStatus} directive> -->
+<A
+ HREF="directive-dict.html#Syntax"
+ REL="Help"
+><STRONG>Syntax:</STRONG></A> ExtendedStatus <EM>On|Off</EM><BR>
+<A
+ HREF="directive-dict.html#Default"
+ REL="Help"
+><STRONG>Default:</STRONG></A> <CODE>ExtendedStatus Off</CODE><BR>
+<A
+ HREF="directive-dict.html#Context"
+ REL="Help"
+><STRONG>Context:</STRONG></A> server config <BR>
+<A
+ HREF="directive-dict.html#Status"
+ REL="Help"
+><STRONG>Status:</STRONG></A> Base<BR>
+ <A
+ HREF="directive-dict.html#Module"
+ REL="Help"
+ ><STRONG>Module:</STRONG></A> mod_status<BR>
+<A
+ HREF="directive-dict.html#Compatibility"
+ REL="Help"
+><STRONG>Compatibility:</STRONG></A> ExtendedStatus is only available
+ in Apache 1.3.2 and later.
+
+<P>
+This directive controls whether the server keeps track of extended
+status information for each request. This is only useful if the status module
+is enabled on the server.
+</P>
+<P>
+This setting applies to the entire server, and cannot be enabled or
+disabled on a virtualhost-by-virtualhost basis.
+</P>
+
<!--#include virtual="footer.html" -->
</BODY>
</HTML>
1.5 +33 -8 httpd-docs-2.0/htdocs/manual/mod/mod_unique_id.html
Index: mod_unique_id.html
===================================================================
RCS file: /home/cvs/httpd-docs-2.0/htdocs/manual/mod/mod_unique_id.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- mod_unique_id.html 1998/09/17 12:33:08 1.4
+++ mod_unique_id.html 2000/09/28 16:55:51 1.5
@@ -15,14 +15,45 @@
<!--#include virtual="header.html" -->
<H1 ALIGN="CENTER">Module mod_unique_id</H1>
-This module provides a magic token for each request which is guaranteed
+<p>This module provides an environment variable with a unique identifier
+for each request.</p>
+
+<P><A
+HREF="module-dict.html#Status"
+REL="Help"
+><STRONG>Status:</STRONG></A> Extension
+<BR>
+<A
+HREF="module-dict.html#SourceFile"
+REL="Help"
+><STRONG>Source File:</STRONG></A> mod_unique_id.c
+<BR>
+<A
+HREF="module-dict.html#ModuleIdentifier"
+REL="Help"
+><STRONG>Module Identifier:</STRONG></A> unique_id_module
+<BR>
+<A
+HREF="module-dict.html#Compatibility"
+REL="Help"
+><STRONG>Compatibility:</STRONG></A> Available in Apache 1.3 and later.
+</P>
+
+<h2>Summary</h2>
+
+<p>This module provides a magic token for each request which is guaranteed
to be unique across "all" requests under very specific conditions.
The unique identifier is even unique across multiple machines in a
properly configured cluster of machines. The environment variable
<CODE>UNIQUE_ID</CODE> is set to the identifier for each request.
Unique identifiers are useful for various reasons which are beyond the
-scope of this document.
+scope of this document.</p>
+
+<h2>Directives</h2>
+
+<p>This module has no directives.</p>
+
<H2>Theory</H2>
<P>
@@ -168,12 +199,6 @@
situations the identifier can be shortened, but more information needs
to be assumed (for example the 32-bit IP address is overkill for any
site, but there is no portable shorter replacement for it).
-
-<HR>
-
-<H2>Directives</H2>
-
-<CODE>mod_unique_id</CODE> has no directives.
<!--#include virtual="footer.html" -->
</BODY>
1.15 +20 -4 httpd-docs-2.0/htdocs/manual/mod/mod_userdir.html
Index: mod_userdir.html
===================================================================
RCS file: /home/cvs/httpd-docs-2.0/htdocs/manual/mod/mod_userdir.html,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- mod_userdir.html 1998/05/20 14:13:00 1.14
+++ mod_userdir.html 2000/09/28 16:55:52 1.15
@@ -15,17 +15,33 @@
<!--#include virtual="header.html" -->
<H1 ALIGN="CENTER">Module mod_userdir</H1>
-This module is contained in the <CODE>mod_userdir.c</CODE> file, and
-is compiled in by default. It provides for user-specific directories.
+<p>This module provides for user-specific directories.</p>
+<P><A
+HREF="module-dict.html#Status"
+REL="Help"
+><STRONG>Status:</STRONG></A> Base
+<BR>
+<A
+HREF="module-dict.html#SourceFile"
+REL="Help"
+><STRONG>Source File:</STRONG></A> mod_userdir.c
+<BR>
+<A
+HREF="module-dict.html#ModuleIdentifier"
+REL="Help"
+><STRONG>Module Identifier:</STRONG></A> userdir_module
+</P>
+<h2>Directives</h2>
+
+
<UL>
<LI><A HREF="#userdir">UserDir</A>
</UL>
<HR>
-
-<H2><A NAME="userdir">UserDir</A></H2>
+<H2><A NAME="userdir">UserDir</A> directive</H2>
<!--%plaintext <?INDEX {\tt UserDir} directive> -->
<A
HREF="directive-dict.html#Syntax"
1.7 +42 -11 httpd-docs-2.0/htdocs/manual/mod/mod_vhost_alias.html
Index: mod_vhost_alias.html
===================================================================
RCS file: /home/cvs/httpd-docs-2.0/htdocs/manual/mod/mod_vhost_alias.html,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- mod_vhost_alias.html 2000/03/16 18:02:47 1.6
+++ mod_vhost_alias.html 2000/09/28 16:55:53 1.7
@@ -22,12 +22,51 @@
<H1 ALIGN="CENTER">Module mod_vhost_alias</H1>
<P>
-This module is contained in the <CODE>mod_vhost_alias.c</CODE> file
-and is not compiled in by default. It provides support for
-<A HREF="../vhosts/mass.html">dynamically configured mass virtual
+This module provides support for <A
+HREF="../vhosts/mass.html">dynamically configured mass virtual
hosting</A>.
</P>
+<P><A
+HREF="module-dict.html#Status"
+REL="Help"
+><STRONG>Status:</STRONG></A> Extension
+<BR>
+<A
+HREF="module-dict.html#SourceFile"
+REL="Help"
+><STRONG>Source File:</STRONG></A> mod_vhost_alias.c
+<BR>
+<A
+HREF="module-dict.html#ModuleIdentifier"
+REL="Help"
+><STRONG>Module Identifier:</STRONG></A> vhost_alias_module
+<BR>
+<A
+HREF="module-dict.html#Compatibility"
+REL="Help"
+><STRONG>Compatibility:</STRONG></A> Available in Apache 1.3.7 and later.
+</P>
+
+<h2>Summary</h2>
+
+<p>This module creates dynamically configured virtual hosts, by
+allowing the IP address and/or the <code>Host:</code> header of the
+HTTP request to be used as part of the pathname to determine what
+files to serve. This allows for easy use of a huge number of virtual
+hosts with similar configurations.</p>
+
+<H2>Directives</H2>
+<UL>
+ <LI><A HREF="#virtualdocumentroot">VirtualDocumentRoot</A>
+ <LI><A HREF="#virtualdocumentrootip">VirtualDocumentRootIP</A>
+ <LI><A HREF="#virtualscriptalias">VirtualScriptAlias</A>
+ <LI><A HREF="#virtualscriptaliasip">VirtualScriptAliasIP</A>
+</UL>
+
+<p>See also: <a href="core.html#usecanonicalname">UseCanonicalName</a>.</p>
+
+
<H2>Directory Name Interpolation</H2>
<P>
@@ -156,14 +195,6 @@
<HR>
-<H2>Directives</H2>
-<UL>
- <LI><A HREF="#virtualdocumentroot">VirtualDocumentRoot</A>
- <LI><A HREF="#virtualdocumentrootip">VirtualDocumentRootIP</A>
- <LI><A HREF="#virtualscriptalias">VirtualScriptAlias</A>
- <LI><A HREF="#virtualscriptaliasip">VirtualScriptAliasIP</A>
-</UL>
-<HR>
<H2><A NAME="virtualdocumentroot">VirtualDocumentRoot directive</A></H2>
<P>