You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by nd...@apache.org on 2003/01/18 21:24:33 UTC

cvs commit: httpd-2.0/docs/manual sitemap.xml

nd          2003/01/18 12:24:33

  Modified:    docs/manual/mod core.xml mod_log_config.xml
               docs/manual sitemap.xml
  Added:       docs/manual/mod mod_ident.xml
  Log:
  add mod_ident documentation
  
  Reviewed by: Joshua Slive, Astrid Ke�ler
  
  Revision  Changes    Path
  1.53      +0 -26     httpd-2.0/docs/manual/mod/core.xml
  
  Index: core.xml
  ===================================================================
  RCS file: /home/cvs/httpd-2.0/docs/manual/mod/core.xml,v
  retrieving revision 1.52
  retrieving revision 1.53
  diff -u -r1.52 -r1.53
  --- core.xml	18 Jan 2003 19:39:06 -0000	1.52
  +++ core.xml	18 Jan 2003 20:24:32 -0000	1.53
  @@ -1152,32 +1152,6 @@
   </usage>
   </directivesynopsis>
   
  -<directivesynopsis>
  -<name>IdentityCheck</name>
  -<description>Enables logging of the RFC1413 identity of the remote
  -user</description>
  -<syntax>IdentityCheck On|Off</syntax>
  -<default>IdentityCheck Off</default>
  -<contextlist><context>server config</context><context>virtual host</context>
  -<context>directory</context></contextlist>
  -<usage>
  -    <p>This directive enables RFC1413-compliant logging of the
  -    remote user name for each connection, where the client machine
  -    runs identd or something similar. This information is logged in
  -    the access log.</p>
  -
  -    <p>The information should not be trusted in any way except for
  -    rudimentary usage tracking.</p>
  -
  -    <p>Note that this can cause serious latency problems accessing
  -    your server since every request requires one of these lookups
  -    to be performed. When firewalls are involved each lookup might
  -    possibly fail and add 30 seconds of latency to each hit. So in
  -    general this is not very useful on public servers accessible
  -    from the Internet.</p>
  -</usage>
  -</directivesynopsis>
  -
   <directivesynopsis type="section">
   <name>IfDefine</name>
   <description>Encloses directives that will be processed only
  
  
  
  1.15      +4 -1      httpd-2.0/docs/manual/mod/mod_log_config.xml
  
  Index: mod_log_config.xml
  ===================================================================
  RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_log_config.xml,v
  retrieving revision 1.14
  retrieving revision 1.15
  diff -u -r1.14 -r1.15
  --- mod_log_config.xml	26 Nov 2002 09:34:41 -0000	1.14
  +++ mod_log_config.xml	18 Jan 2003 20:24:32 -0000	1.15
  @@ -88,7 +88,10 @@
           in the request sent to the server.</td></tr>
   
       <tr><td><code>%...l</code></td>
  -        <td>Remote logname (from identd, if supplied)</td></tr>
  +        <td>Remote logname (from identd, if supplied). This will return a
  +        dash unless <module>mod_ident</module> is present and <directive
  +        module="mod_ident">IdentityCheck</directive> is set
  +        <code>On</code>.</td></tr>
   
       <tr><td><code>%...m</code></td>
           <td>The request method</td></tr>
  
  
  
  1.1                  httpd-2.0/docs/manual/mod/mod_ident.xml
  
  Index: mod_ident.xml
  ===================================================================
  <?xml version="1.0"?>
  <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
  <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  <modulesynopsis>
  
  <name>mod_ident</name>
  <description>RFC 1413 ident lookups</description>
  <status>Extension</status>
  <sourcefile>mod_ident.c</sourcefile>
  <identifier>ident_module</identifier>
  <compatibility>Available in Apache 2.1 and later</compatibility>
  
  <summary>
      <p>This module queries an <a href="http://www.ietf.org/rfc/rfc1413.txt"
      >RFC 1413</a> compatible daemon on a remote host to look up the owner of
      a connection.</p>
  </summary>
  <seealso><module>mod_log_config</module></seealso>
  
  <directivesynopsis>
  <name>IdentityCheck</name>
  <description>Enables logging of the RFC 1413 identity of the remote
  user</description>
  <syntax>IdentityCheck On|Off</syntax>
  <default>IdentityCheck Off</default>
  <contextlist><context>server config</context><context>virtual host</context>
  <context>directory</context></contextlist>
  <compatibility>Moved out of core in Apache 2.1</compatibility>
  
  <usage>
      <p>This directive enables <a href="http://www.ietf.org/rfc/rfc1413.txt"
      >RFC 1413</a>-compliant logging of the remote user name for each
      connection, where the client machine runs identd or something similar.
      This information is logged in the access log using the <code>%...l</code>
      <a href="mod_log_config.html#formats">format string</a>.</p>
  
      <note>
        The information should not be trusted in any way except for
        rudimentary usage tracking.
      </note>
  
      <p>Note that this can cause serious latency problems accessing
      your server since every request requires one of these lookups
      to be performed. When firewalls or proxy servers are involved,
      each lookup might possibly fail and add a latency duration as
      defined by the <directive module="mod_ident"
      >IdentityCheckTimeout</directive> directive to each hit. So in
      general this is not very useful on public servers accessible from
      the Internet.</p>
  </usage>
  </directivesynopsis>
  
  <directivesynopsis>
  <name>IdentityCheckTimeout</name>
  <description>Determines the timeout duration for ident requests</description>
  <syntax>IdentityCheckTimeout <var>seconds</var></syntax>
  <default>IdentityCheckTimeout 30</default>
  <contextlist><context>server config</context><context>virtual host</context>
  <context>directory</context></contextlist>
  <usage>
      <p>This directive specifies the timeout duration of an ident
      request. The default value of 30 seconds is recommended by <a
      href="http://www.ietf.org/rfc/rfc1413.txt">RFC 1413</a>, mainly because
      of possible network latency. However, you may want to adjust the
      timeout value according to your local network speed.</p>
  </usage>
  </directivesynopsis>
  
  </modulesynopsis>
  
  
  
  
  1.21      +1 -0      httpd-2.0/docs/manual/sitemap.xml
  
  Index: sitemap.xml
  ===================================================================
  RCS file: /home/cvs/httpd-2.0/docs/manual/sitemap.xml,v
  retrieving revision 1.20
  retrieving revision 1.21
  diff -u -r1.20 -r1.21
  --- sitemap.xml	17 Jan 2003 01:53:07 -0000	1.20
  +++ sitemap.xml	18 Jan 2003 20:24:33 -0000	1.21
  @@ -159,6 +159,7 @@
     <modulefile>mod_ext_filter.xml</modulefile>
     <modulefile>mod_file_cache.xml</modulefile>
     <modulefile>mod_headers.xml</modulefile>
  +  <modulefile>mod_ident.xml</modulefile>
     <modulefile>mod_imap.xml</modulefile>
     <modulefile>mod_include.xml</modulefile>
     <modulefile>mod_info.xml</modulefile>