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 19:04:57 UTC
cvs commit: httpd-docs-1.3/htdocs/manual/mod mod_env.html mod_include.html mod_mime_magic.html
slive 00/09/28 10:04:57
Modified: htdocs/manual/mod mod_env.html mod_include.html
mod_mime_magic.html
Log:
A few more style updates I missed committing.
Remarkably, I'm almost done.
Revision Changes Path
1.15 +29 -10 httpd-docs-1.3/htdocs/manual/mod/mod_env.html
Index: mod_env.html
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/htdocs/manual/mod/mod_env.html,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- mod_env.html 1999/03/22 23:38:20 1.14
+++ mod_env.html 2000/09/28 17:04:57 1.15
@@ -15,18 +15,37 @@
<!--#include virtual="header.html" -->
<H1 ALIGN="CENTER">Apache module mod_env</H1>
-This module is contained in the <CODE>mod_env.c</CODE> file, and
-is compiled in by default. It provides for
-passing environment variables to CGI/SSI scripts. Is is only available
-in Apache 1.1 and later.
+<p>This module provides for
+passing environment variables to CGI/SSI scripts.</p>
-<H2>Summary</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_env.c
+<BR>
+<A
+HREF="module-dict.html#ModuleIdentifier"
+REL="Help"
+><STRONG>Module Identifier:</STRONG></A> env_module
+<BR>
+<A
+HREF="module-dict.html#Compatibility"
+REL="Help"
+><STRONG>Compatibility:</STRONG></A> Available in Apache 1.1 and later.
+</P>
-This module allows Apache's CGI and SSI environment to inherit
+<H2>Summary</H2>
+<!-- XXX: Should mention mod_setenvif and the effect of suexec -->
+<p>This module allows Apache's CGI and SSI environment to inherit
environment variables from the shell which invoked the httpd process.
CERN web-servers are able to do this, so this module is especially
useful to web-admins who wish to migrate from CERN to Apache without
-rewriting all their scripts
+rewriting all their scripts</p>
<H2>Directives</H2>
<UL>
@@ -37,7 +56,7 @@
<HR>
-<H2><A NAME="passenv">PassEnv</A></H2>
+<H2><A NAME="passenv">PassEnv</A> directive</H2>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
@@ -68,7 +87,7 @@
<HR>
-<H2><A NAME="setenv">SetEnv</A></H2>
+<H2><A NAME="setenv">SetEnv</A> directive</H2>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
@@ -99,7 +118,7 @@
<HR>
-<H2><A NAME="unsetenv">UnsetEnv</A></H2>
+<H2><A NAME="unsetenv">UnsetEnv</A> directive</H2>
<A
HREF="directive-dict.html#Syntax"
REL="Help"
1.29 +43 -20 httpd-docs-1.3/htdocs/manual/mod/mod_include.html
Index: mod_include.html
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/htdocs/manual/mod/mod_include.html,v
retrieving revision 1.28
retrieving revision 1.29
diff -u -r1.28 -r1.29
--- mod_include.html 2000/05/28 01:46:35 1.28
+++ mod_include.html 2000/09/28 17:04:57 1.29
@@ -15,13 +15,42 @@
<!--#include virtual="header.html" -->
<H1 ALIGN="CENTER">Module mod_include</H1>
-This module is contained in the <CODE>mod_include.c</CODE> file, and
-is compiled in by default. It provides for server-parsed html
-documents. Several directives beyond the original NCSA definition were
-introduced in Apache 1.2 - these are flagged below with the phrase
-"Apache 1.2 and above". Of particular significance are the new flow
-control directives documented at the bottom.
+<p>This module provides for server-parsed html documents.</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_include.c
+<BR>
+<A
+HREF="module-dict.html#ModuleIdentifier"
+REL="Help"
+><STRONG>Module Identifier:</STRONG></A> include_module
+</P>
+
+<h2>Summary</h2>
+
+<p>This module provides a handler which will process files before they
+are sent to the client. The processing is controlled by specially
+formated SGML comments, referred to as <em>elements</em>. These
+elements allow conditional text, the inclusion other files or
+programs, as well as the setting and printing of environment
+variables.</p>
+
+<H2>Directives</H2>
+<UL>
+<LI><A HREF="#xbithack">XBitHack</A>
+</UL>
+
+<p>See also: <a href="core.html#options">Options</a>
+and <a href="mod_mime.html#addhandler">AddHandler</a>.</p>
+
+
<H2>Enabling Server-Side Includes</H2>
Any document with handler of "server-parsed" will be parsed by this
@@ -372,15 +401,16 @@
<EM>'string1 string2'</EM> results in <EM>string1 string2</EM>
</PRE>
-<HR>
-<H2>Directives</H2>
-<UL>
-<LI><A HREF="#xbithack">XBitHack</A>
-</UL>
-<HR>
+<H2>Using Server Side Includes for ErrorDocuments</H2>
+
+There is <A HREF="../misc/custom_errordocs.html">a document</A> which
+describes how to use the features of mod_include to offer internationalized
+customized server error documents.
+<P>
+<HR>
-<H2><A NAME="xbithack">XBitHack</A></H2>
+<H2><A NAME="xbithack">XBitHack</A> directive</H2>
<!--%plaintext <?INDEX {\tt XBitHack} directive> -->
<A
HREF="directive-dict.html#Syntax"
@@ -429,13 +459,6 @@
</DL>
<P>
-<HR>
-<H2>Using Server Side Includes for ErrorDocuments</H2>
-
-There is <A HREF="../misc/custom_errordocs.html">a document</A> which
-describes how to use the features of mod_include to offer internationalized
-customized server error documents.
-<P>
<!--#include virtual="footer.html" -->
</BODY>
1.11 +86 -72 httpd-docs-1.3/htdocs/manual/mod/mod_mime_magic.html
Index: mod_mime_magic.html
===================================================================
RCS file: /home/cvs/httpd-docs-1.3/htdocs/manual/mod/mod_mime_magic.html,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- mod_mime_magic.html 1998/09/17 12:33:08 1.10
+++ mod_mime_magic.html 2000/09/28 17:04:57 1.11
@@ -17,34 +17,56 @@
<H1 align="CENTER">Module mod_mime_magic</H1>
- This module is contained in the mod_mime_magic.c file, and is
- an optional extension to the Apache HTTPD server.
- It can be used to determine the MIME type of a file by looking at a
- few bytes of its contents, the same way the Unix file(1) command works.
- To use mod_mime_magic you have to enable the following line in the
- server build <TT>Configuration</TT> file:
-
- <PRE>
- AddModule modules/standard/mod_mime_magic.o
- </PRE>
-
- This should be listed <EM>before</EM> mod_mime in the build
- <TT>Configuration</TT> file so that it will be used after mod_mime.
- mod_mime_magic is intended as a "second line of defense" for cases
- mod_mime cannot resolve.
+ <p>This module provides for determining the MIME type of a file by
+ looking at a few bytes of its contents.</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_mime_magic.c
+<BR>
+<A
+HREF="module-dict.html#ModuleIdentifier"
+REL="Help"
+><STRONG>Module Identifier:</STRONG></A> mime_magic_module
+</P>
+
+
+
<H2>Summary</H2>
- This module is derived from a free version of the <CODE>file(1)</CODE>
- command for Unix,
- which uses "magic numbers" and other hints from a file's contents to
- figure out what the contents are.
- In the case of this module,
- it tries to figure out the MIME type of the file.
- <P>
- This module active only if the magic file is specified by the
- <A HREF="#mimemagicfile"><CODE>MimeMagicFile</CODE></A> directive.
+ <p>This module determines the MIME type of files in the same way the
+ Unix file(1) command works: it looks at the first few bytes of
+ the file. It is intended as a "second line of defense" for cases
+ that <a href="mod_mime.html">mod_mime</a> can't resolve. To assure
+ that mod_mime gets first try at determining a file's MIME type,
+ be sure to list mod_mime_magic <STRONG>before</STRONG> mod_mime
+ in the configuration.
+
+ <p>This module is derived from a free version of the
+ <CODE>file(1)</CODE> command for Unix, which uses "magic numbers"
+ and other hints from a file's contents to figure out what the
+ contents are. This module is active only if the magic file is
+ specified by the <A
+ HREF="#mimemagicfile"><CODE>MimeMagicFile</CODE></A> directive.
+
+
+ <H2>Directives</H2>
<P>
+ <UL>
+ <LI><A HREF="#mimemagicfile">MimeMagicFile</A>
+ </LI>
+ </UL>
+ </P>
+
+ <h2>Format of the Magic File</h2>
+
+<P>
The contents of the file are plain ASCII text in 4-5 columns.
Blank lines are allowed but ignored.
Commented lines use a hash mark "#".
@@ -135,7 +157,7 @@
0 string \037\213 application/octet-stream x-gzip
</PRE>
- <H3>Performance Issues</H3>
+ <H2>Performance Issues</H2>
This module is not for every system. If your system is barely keeping
up with its load or if you're performing a web server benchmark,
@@ -158,53 +180,6 @@
listed in increasing priority so that will mean this one is used only
as a last resort, just like it was designed to.
- <H2>Directives</H2>
- <P>
- <UL>
- <LI><A HREF="#mimemagicfile">MimeMagicFile</A>
- </LI>
- </UL>
- </P>
- <HR>
- <H2><A NAME="mimemagicfile">
- MimeMagicFile
- </A></H2>
- <P>
- <A
- HREF="directive-dict.html#Syntax"
- REL="Help"
- ><STRONG>Syntax:</STRONG></A> MimeMagicFile <EM>magic-file-name</EM>
- <BR>
- <A
- HREF="directive-dict.html#Default"
- REL="Help"
- ><STRONG>Default:</STRONG></A> none
- <BR>
- <A
- HREF="directive-dict.html#Context"
- REL="Help"
- ><STRONG>Context:</STRONG></A> server config, virtual host
- <BR>
- <A
- HREF="directive-dict.html#Status"
- REL="Help"
- ><STRONG>Status:</STRONG></A> Extension
- <BR>
- <A
- HREF="directive-dict.html#Module"
- REL="Help"
- ><STRONG>Module:</STRONG></A> mod_mime_magic
- <P>
-
- The <CODE>MimeMagicFile</CODE> directive can be used to enable this module,
- the default file is distributed at <CODE>conf/magic</CODE>.
- Non-rooted paths are relative to the ServerRoot. Virtual hosts
- will use the same file as the main server unless a more specific setting
- is used, in which case the more specific setting overrides the main server's
- file.
- <P>
- <HR>
-
<H2><A NAME="notes">Notes</A></H2>
The following notes apply to the mod_mime_magic module and are
@@ -270,6 +245,45 @@
*
*/
</PRE>
+
+ <HR>
+ <H2><A NAME="mimemagicfile">
+ MimeMagicFile
+ </A></H2>
+ <P>
+ <A
+ HREF="directive-dict.html#Syntax"
+ REL="Help"
+ ><STRONG>Syntax:</STRONG></A> MimeMagicFile <EM>magic-file-name</EM>
+ <BR>
+ <A
+ HREF="directive-dict.html#Default"
+ REL="Help"
+ ><STRONG>Default:</STRONG></A> none
+ <BR>
+ <A
+ HREF="directive-dict.html#Context"
+ REL="Help"
+ ><STRONG>Context:</STRONG></A> server config, virtual host
+ <BR>
+ <A
+ HREF="directive-dict.html#Status"
+ REL="Help"
+ ><STRONG>Status:</STRONG></A> Extension
+ <BR>
+ <A
+ HREF="directive-dict.html#Module"
+ REL="Help"
+ ><STRONG>Module:</STRONG></A> mod_mime_magic
+ <P>
+
+ The <CODE>MimeMagicFile</CODE> directive can be used to enable this module,
+ the default file is distributed at <CODE>conf/magic</CODE>.
+ Non-rooted paths are relative to the ServerRoot. Virtual hosts
+ will use the same file as the main server unless a more specific setting
+ is used, in which case the more specific setting overrides the main server's
+ file.
+ <P>
</BODY>
</HTML>