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/29 00:42:14 UTC

cvs commit: httpd-docs-1.3/htdocs/manual/mod mod_negotiation.html mod_rewrite.html mod_vhost_alias.html mod_digest.html mod_cgi.html mod_usertrack.html mod_example.html

slive       00/09/28 15:42:14

  Modified:    htdocs/manual/mod mod_negotiation.html mod_rewrite.html
                        mod_vhost_alias.html mod_digest.html mod_cgi.html
                        mod_usertrack.html mod_example.html
  Log:
  The last few modules file style changes, plus a few little
  adjustments to previously changed modules.  I have not
  touched the "obsolete" modules, and I have only made the
  minimum change in mod_rewrite.html.
  
  Revision  Changes    Path
  1.16      +1 -1      httpd-docs-1.3/htdocs/manual/mod/mod_negotiation.html
  
  Index: mod_negotiation.html
  ===================================================================
  RCS file: /home/cvs/httpd-docs-1.3/htdocs/manual/mod/mod_negotiation.html,v
  retrieving revision 1.15
  retrieving revision 1.16
  diff -u -r1.15 -r1.16
  --- mod_negotiation.html	2000/09/27 18:34:09	1.15
  +++ mod_negotiation.html	2000/09/28 22:42:13	1.16
  @@ -58,7 +58,7 @@
   <A HREF="./mod_mime.html#addencoding">AddEncoding</A>,
   <A HREF="./mod_mime.html#addlanguage">AddLanguage</A>,
   <A HREF="./mod_mime.html#addtype">AddType</A>, and
  -<A HREF="core.html#options">Option</A>.
  +<A HREF="core.html#options">Options</A>.
   
   <H2>Type maps</H2>
   A type map has the same format as RFC822 mail headers. It contains document
  
  
  
  1.51      +24 -8     httpd-docs-1.3/htdocs/manual/mod/mod_rewrite.html
  
  Index: mod_rewrite.html
  ===================================================================
  RCS file: /home/cvs/httpd-docs-1.3/htdocs/manual/mod/mod_rewrite.html,v
  retrieving revision 1.50
  retrieving revision 1.51
  diff -u -r1.50 -r1.51
  --- mod_rewrite.html	2000/09/09 18:38:17	1.50
  +++ mod_rewrite.html	2000/09/28 22:42:13	1.51
  @@ -21,14 +21,30 @@
   <BR>
   <H1 ALIGN="CENTER">Module mod_rewrite<BR>URL Rewriting Engine</H1>
   
  -This module is contained in the <CODE>mod_rewrite.c</CODE> file, with Apache
  -1.2 and later. It provides a rule-based rewriting engine to rewrite requested
  -URLs on the fly. It is not compiled into the server by default. To use
  -<CODE>mod_rewrite</CODE> you have to enable the following line in the server
  -build <CODE>Configuration</CODE> file:
  -<PRE>
  -    AddModule  modules/standard/mod_rewrite.o
  -</PRE>
  +<p>This module provides a rule-based rewriting engine to rewrite requested
  +URLs on the fly.</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_rewrite.c
  +<BR>
  +<A
  +HREF="module-dict.html#ModuleIdentifier"
  +REL="Help"
  +><STRONG>Module Identifier:</STRONG></A> rewrite_module
  +<BR>
  +<A
  +HREF="module-dict.html#Compatibility"
  +REL="Help"
  +><STRONG>Compatibility:</STRONG></A> Available in Apache 1.2 and later.
  +</P>
  +
   
   <P>
   <HR NOSHADE SIZE=1>
  
  
  
  1.8       +1 -7      httpd-docs-1.3/htdocs/manual/mod/mod_vhost_alias.html
  
  Index: mod_vhost_alias.html
  ===================================================================
  RCS file: /home/cvs/httpd-docs-1.3/htdocs/manual/mod/mod_vhost_alias.html,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- mod_vhost_alias.html	2000/09/28 16:54:41	1.7
  +++ mod_vhost_alias.html	2000/09/28 22:42:13	1.8
  @@ -12,13 +12,7 @@
    VLINK="#000080"
    ALINK="#FF0000"
   >
  -<DIV ALIGN="CENTER">
  - <IMG SRC="../images/sub.gif" ALT="[APACHE DOCUMENTATION]">
  - <H3>
  -  Apache HTTP Server Version 1.3
  - </H3>
  -</DIV>
  -
  +<!--#include virtual="header.html" -->
   <H1 ALIGN="CENTER">Module mod_vhost_alias</H1>
   
   <P>
  
  
  
  1.12      +46 -21    httpd-docs-1.3/htdocs/manual/mod/mod_digest.html
  
  Index: mod_digest.html
  ===================================================================
  RCS file: /home/cvs/httpd-docs-1.3/htdocs/manual/mod/mod_digest.html,v
  retrieving revision 1.11
  retrieving revision 1.12
  diff -u -r1.11 -r1.12
  --- mod_digest.html	2000/09/08 20:03:56	1.11
  +++ mod_digest.html	2000/09/28 22:42:13	1.12
  @@ -15,24 +15,63 @@
   <!--#include virtual="header.html" -->
   <H1 ALIGN="CENTER">Module mod_digest</H1>
   
  -<P>This module is contained in the <CODE>mod_digest.c</CODE> file, and is
  -not compiled in by default. It is only available in Apache 1.1 and
  -later. It provides for user authentication using MD5 Digest
  +<P>This module provides for user authentication using MD5 Digest
   Authentication.
   
  -<P><STRONG>Please Note:</STRONG> This module implements an older
  +<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_digest.c
  +<BR>
  +<A
  +HREF="module-dict.html#ModuleIdentifier"
  +REL="Help"
  +><STRONG>Module Identifier:</STRONG></A> digest_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>
  +
  +<P>This module implements an older
   version of the MD5 Digest Authentication specification which will
   probably not work with modern browsers.  Please see <A
   HREF="mod_auth_digest.html">mod_auth_digest</A> for a module which implements
   the most recent version of the standard.
   
  -<MENU>
  +<h2>Directives</h2>
  +
  +<ul>
   <LI><A HREF="#authdigestfile">AuthDigestFile</A>
  -</MENU>
  +</ul>
  +
  +
  +<H2>Using Digest Authentication</H2>
  +
  +<P>Using MD5 Digest authentication is very simple. Simply set up
  +authentication normally. However, use "AuthType Digest" and
  +"AuthDigestFile" instead of the normal "AuthType Basic" and
  +"AuthUserFile". Everything else should remain the same.</P>
  +
  +<P>MD5 authentication provides a more secure password system, but only
  +works with supporting browsers. As of this writing (July 1996), the
  +majority of browsers do not support digest authentication. Therefore, we
  +do not recommend using this feature on a large Internet site. However, for
  +personal and intra-net use, where browser users can be controlled, it is
  +ideal.</P>
  +
   <HR>
   
   
  -<H2><A NAME="authdigestfile">AuthDigestFile</A></H2>
  +<H2><A NAME="authdigestfile">AuthDigestFile</A> directive</H2>
   <A
    HREF="directive-dict.html#Syntax"
    REL="Help"
  @@ -63,21 +102,7 @@
   created using the "htdigest" utility found in the support/ subdirectory of
   the Apache distribution.</P>
   
  -<HR>
   
  -<H3>Using Digest Authentication</H3>
  -
  -<P>Using MD5 Digest authentication is very simple. Simply set up
  -authentication normally. However, use "AuthType Digest" and
  -"AuthDigestFile" instead of the normal "AuthType Basic" and
  -"AuthUserFile". Everything else should remain the same.</P>
  -
  -<P>MD5 authentication provides a more secure password system, but only
  -works with supporting browsers. As of this writing (July 1996), the
  -majority of browsers do not support digest authentication. Therefore, we
  -do not recommend using this feature on a large Internet site. However, for
  -personal and intra-net use, where browser users can be controlled, it is
  -ideal.</P>
   
   <!--#include virtual="footer.html" -->
   </BODY>
  
  
  
  1.20      +3 -2      httpd-docs-1.3/htdocs/manual/mod/mod_cgi.html
  
  Index: mod_cgi.html
  ===================================================================
  RCS file: /home/cvs/httpd-docs-1.3/htdocs/manual/mod/mod_cgi.html,v
  retrieving revision 1.19
  retrieving revision 1.20
  diff -u -r1.19 -r1.20
  --- mod_cgi.html	2000/09/26 19:13:26	1.19
  +++ mod_cgi.html	2000/09/28 22:42:13	1.20
  @@ -61,8 +61,9 @@
   </ul>
   
   <p>See also: <a href="core.html#options">Options</a>, <a
  -href="mod_alias.html#scriptalias">ScriptAlias</a> and <a
  -href="mod_mime.html#addtype">AddType</a>.
  +href="mod_alias.html#scriptalias">ScriptAlias</a>, <a
  +href="mod_mime.html#addtype">AddType</a> and <a
  +href="mod_mime.html#addhandler">AddHandler</a>.
   
   <H2>CGI Environment variables</H2>
   The server will set the CGI environment variables as described in the
  
  
  
  1.19      +81 -55    httpd-docs-1.3/htdocs/manual/mod/mod_usertrack.html
  
  Index: mod_usertrack.html
  ===================================================================
  RCS file: /home/cvs/httpd-docs-1.3/htdocs/manual/mod/mod_usertrack.html,v
  retrieving revision 1.18
  retrieving revision 1.19
  diff -u -r1.18 -r1.19
  --- mod_usertrack.html	1999/04/29 15:44:32	1.18
  +++ mod_usertrack.html	2000/09/28 22:42:13	1.19
  @@ -15,25 +15,57 @@
   <!--#include virtual="header.html" -->
   <H1 ALIGN="CENTER">Module mod_usertrack</H1>
   
  -Previous releases of Apache have included a module which generates a
  +<p>This module uses cookies to provide for a <em>clickstream</em> log of user
  +activity on a site.</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_usertrack.c
  +<BR>
  +<A
  +HREF="module-dict.html#ModuleIdentifier"
  +REL="Help"
  +><STRONG>Module Identifier:</STRONG></A> usertrack_module
  +<BR>
  +<A
  +HREF="module-dict.html#Compatibility"
  +REL="Help"
  +><STRONG>Compatibility:</STRONG></A> Known as mod_cookies prior to 
  +Apache 1.3.
  +</P>
  +
  +<h2>Summary</h2>
  +
  +<p>Previous releases of Apache have included a module which generates a
   'clickstream' log of user activity on a site using cookies. This was
   called the "cookies" module, mod_cookies. In Apache 1.2 and later this
   module has been renamed the "user tracking" module,
   mod_usertrack. This module has been simplified and new directives
  -added.
  +added.</p>
   
  -<HR>
  +<H2>Directives</H2>
   
  +<UL>
  +<LI><A HREF="#cookieexpires">CookieExpires</A>
  +<LI><A HREF="#cookiename">CookieName</A>
  +<LI><A HREF="#cookietracking">CookieTracking</A>
  +</UL>
  +
   <H2>Logging</H2>
   
  -Previously, the cookies module (now the user tracking module) did its
  +<p>Previously, the cookies module (now the user tracking module) did its
   own logging, using the <TT>CookieLog</TT> directive. In this release,
   this module does no logging at all. Instead, a configurable log
   format file should be used to log user click-streams. This is possible
   because the logging module now allows <A
   HREF="../multilogs.html">multiple log files</A>. The cookie itself is
   logged by using the text <TT>%{cookie}n </TT>
  -
   in the log file format. For example:
   <PRE>
   CustomLog logs/clickstream "%{cookie}n %r %t"
  @@ -43,17 +75,50 @@
   old <TT>CookieLog</TT> directive, but this should be upgraded to the
   above <TT>CustomLog</TT> directive.
   
  -<H2>Directives</H2>
  +<H2>2-digit or 4-digit dates for cookies?</H2>
   
  -<UL>
  -<LI><A HREF="#cookieexpires">CookieExpires</A>
  -<LI><A HREF="#cookiename">CookieName</A>
  -<LI><A HREF="#cookietracking">CookieTracking</A>
  -</UL>
  +(the following is from message
  +&lt;022701bda43d$9d32bbb0$1201a8c0@christian.office.sane.com&gt; in
  +the new-httpd archives)
  +
  +<P>
  +
  +<PRE>
  +From: "Christian Allen" &lt;christian@sane.com&gt;
  +Subject: Re: Apache Y2K bug in mod_usertrack.c
  +Date: Tue, 30 Jun 1998 11:41:56 -0400
  +
  +Did some work with cookies and dug up some info that might be useful.
  +
  +True, Netscape claims that the correct format NOW is four digit dates, and
  +four digit dates do in fact work... for Netscape 4.x (Communicator), that
  +is.  However, 3.x and below do NOT accept them.  It seems that Netscape
  +originally had a 2-digit standard, and then with all of the Y2K hype and
  +probably a few complaints, changed to a four digit date for Communicator.
  +Fortunately, 4.x also understands the 2-digit format, and so the best way to
  +ensure that your expiration date is legible to the client's browser is to
  +use 2-digit dates.
  +
  +However, this does not limit expiration dates to the year 2000; if you use
  +an expiration year of "13", for example, it is interpreted as 2013, NOT
  +1913!  In fact, you can use an expiration year of up to "37", and it will be
  +understood as "2037" by both MSIE and Netscape versions 3.x and up (not sure
  +about versions previous to those).  Not sure why Netscape used that
  +particular year as its cut-off point, but my guess is that it was in respect
  +to UNIX's 2038 problem.  Netscape/MSIE 4.x seem to be able to understand
  +2-digit years beyond that, at least until "50" for sure (I think they
  +understand up until about "70", but not for sure).
  +
  +Summary:  Mozilla 3.x and up understands two digit dates up until "37"
  +(2037).  Mozilla 4.x understands up until at least "50" (2050) in 2-digit
  +form, but also understands 4-digit years, which can probably reach up until
  +9999.  Your best bet for sending a long-life cookie is to send it for some
  +time late in the year "37".
  +</PRE>
   
   <HR>
   
  -<H2><A NAME="cookieexpires">CookieExpires</A></H2>
  +<H2><A NAME="cookieexpires">CookieExpires</A> directive</H2>
   <A
    HREF="directive-dict.html#Syntax"
    REL="Help"
  @@ -82,7 +147,8 @@
   <P>If this directive is not used, cookies last only for the current
   browser session.</P>
   
  -<H2><A NAME="cookiename">CookieName</A></H2>
  +<HR>
  +<H2><A NAME="cookiename">CookieName</A> directive</H2>
   <A
    HREF="directive-dict.html#Syntax"
    REL="Help"
  @@ -122,7 +188,8 @@
   include A-Z, a-z, 0-9, "_", and "-".
   </P>
   
  -<H2><A NAME="cookietracking">CookieTracking</A></H2>
  +<hr>
  +<H2><A NAME="cookietracking">CookieTracking</A> directive</H2>
   <A
    HREF="directive-dict.html#Syntax"
    REL="Help"
  @@ -151,48 +218,7 @@
   on a per-server or per-directory basis.  By default, compiling
   mod_usertrack will not activate cookies.
   
  -<HR>
   
  -<H2>2-digit or 4-digit dates for cookies?</H2>
  -
  -(the following is from message
  -&lt;022701bda43d$9d32bbb0$1201a8c0@christian.office.sane.com&gt; in
  -the new-httpd archives)
  -
  -<P>
  -
  -<PRE>
  -From: "Christian Allen" &lt;christian@sane.com&gt;
  -Subject: Re: Apache Y2K bug in mod_usertrack.c
  -Date: Tue, 30 Jun 1998 11:41:56 -0400
  -
  -Did some work with cookies and dug up some info that might be useful.
  -
  -True, Netscape claims that the correct format NOW is four digit dates, and
  -four digit dates do in fact work... for Netscape 4.x (Communicator), that
  -is.  However, 3.x and below do NOT accept them.  It seems that Netscape
  -originally had a 2-digit standard, and then with all of the Y2K hype and
  -probably a few complaints, changed to a four digit date for Communicator.
  -Fortunately, 4.x also understands the 2-digit format, and so the best way to
  -ensure that your expiration date is legible to the client's browser is to
  -use 2-digit dates.
  -
  -However, this does not limit expiration dates to the year 2000; if you use
  -an expiration year of "13", for example, it is interpreted as 2013, NOT
  -1913!  In fact, you can use an expiration year of up to "37", and it will be
  -understood as "2037" by both MSIE and Netscape versions 3.x and up (not sure
  -about versions previous to those).  Not sure why Netscape used that
  -particular year as its cut-off point, but my guess is that it was in respect
  -to UNIX's 2038 problem.  Netscape/MSIE 4.x seem to be able to understand
  -2-digit years beyond that, at least until "50" for sure (I think they
  -understand up until about "70", but not for sure).
  -
  -Summary:  Mozilla 3.x and up understands two digit dates up until "37"
  -(2037).  Mozilla 4.x understands up until at least "50" (2050) in 2-digit
  -form, but also understands 4-digit years, which can probably reach up until
  -9999.  Your best bet for sending a long-life cookie is to send it for some
  -time late in the year "37".
  -</PRE>
   
   <!--#include virtual="footer.html" -->
   </BODY>
  
  
  
  1.9       +32 -12    httpd-docs-1.3/htdocs/manual/mod/mod_example.html
  
  Index: mod_example.html
  ===================================================================
  RCS file: /home/cvs/httpd-docs-1.3/htdocs/manual/mod/mod_example.html,v
  retrieving revision 1.8
  retrieving revision 1.9
  diff -u -r1.8 -r1.9
  --- mod_example.html	1999/06/29 12:06:36	1.8
  +++ mod_example.html	2000/09/28 22:42:13	1.9
  @@ -14,8 +14,7 @@
     <!--#include virtual="header.html" -->
     <H1 ALIGN="CENTER">Module mod_example</H1>
     <P>
  -  This module is contained in the <CODE>modules/mod_example.c</CODE> file, and
  -  <STRONG>is not</STRONG> compiled in by default.  It illustrates many of
  +  This module illustrates many of
     the aspects of the
     <A
      HREF="../misc/API.html"
  @@ -24,6 +23,24 @@
     and, when used, demonstrates the manner in which module callbacks are
     triggered by the server.
     </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_example.c
  +<BR>
  +<A
  +HREF="module-dict.html#ModuleIdentifier"
  +REL="Help"
  +><STRONG>Module Identifier:</STRONG></A> example_module
  +</P>
  +
  +
     <H2>Summary</H2>
     <P>
     The files in the <CODE>src/modules/example directory</CODE> under the
  @@ -43,6 +60,15 @@
     some of the tracing the example module did as the various callbacks
     were made.
     </P>
  +  <H2>Directives</H2>
  +  <P>
  +  <UL>
  +   <LI><A HREF="#example">Example</A>
  +   </LI>
  +  </UL>
  +  </P>
  +
  +  <h2>Compiling the example module</h2>
     <P>
     To include the example module in your server, follow the steps below:
     </P>
  @@ -78,9 +104,9 @@
      <LI>Follow steps [1] through [3] above, with appropriate changes.
      </LI>
     </OL>
  -  <H3>
  +  <H2>
      Using the <SAMP>mod_example</SAMP> Module
  -  </H3>
  +  </H2>
     <P>
     To activate the example module, include a block similar to the
     following in your <SAMP>srm.conf</SAMP> file:
  @@ -104,17 +130,11 @@
     <P>
     After reloading/restarting your server, you should be able to browse
     to this location and see the brief display mentioned earlier.
  -  </P>
  -  <H2>Directives</H2>
  -  <P>
  -  <UL>
  -   <LI><A HREF="#example">Example</A>
  -   </LI>
  -  </UL>
     </P>
  +
     <HR>
     <H2><A NAME="example">
  -   Example
  +   Example directive
     </A></H2>
     <P>
     <A