granicus.if.org Git - apache/blob - docs/manual/mod/mod_cern_meta.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Licensed to the Apache Software Foundation (ASF) under one or more
   8  contributor license agreements.  See the NOTICE file distributed with
   9  this work for additional information regarding copyright ownership.
  10  The ASF licenses this file to You under the Apache License, Version 2.0
  11  (the "License"); you may not use this file except in compliance with
  12  the License.  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  16  Unless required by applicable law or agreed to in writing, software
  17  distributed under the License is distributed on an "AS IS" BASIS,
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  See the License for the specific language governing permissions and
  20  limitations under the License.
  21 -->
  22
  23 <modulesynopsis metafile="mod_cern_meta.xml.meta">
  24
  25 <name>mod_cern_meta</name>
  26 <description>CERN httpd metafile semantics</description>
  27 <status>Extension</status>
  28 <sourcefile>mod_cern_meta.c</sourcefile>
  29 <identifier>cern_meta_module</identifier>
  30
  31 <summary>
  32     <p>Emulate the CERN HTTPD Meta file semantics. Meta files are HTTP
  33     headers that can be output in addition to the normal range of
  34     headers for each file accessed. They appear rather like the
  35     Apache .asis files, and are able to provide a crude way of
  36     influencing the Expires: header, as well as providing other
  37     curiosities. There are many ways to manage meta information,
  38     this one was chosen because there is already a large number of
  39     CERN users who can exploit this module.</p>
  40
  41     <p>More information on the <a
  42     href="http://www.w3.org/pub/WWW/Daemon/User/Config/General.html#MetaDir"
  43     >CERN metafile semantics</a> is available.</p>
  44 </summary>
  45
  46 <seealso><module>mod_headers</module></seealso>
  47 <seealso><module>mod_asis</module></seealso>
  48
  49 <directivesynopsis>
  50 <name>MetaFiles</name>
  51 <description>Activates CERN meta-file processing</description>
  52 <syntax>MetaFiles on|off</syntax>
  53 <default>MetaFiles off</default>
  54 <contextlist><context>server config</context>
  55 <context>virtual host</context>
  56 <context>directory</context>
  57 <context>.htaccess</context></contextlist>
  58 <override>Indexes</override>
  59
  60 <usage>
  61     <p>Turns on/off Meta file processing on a per-directory basis.</p>
  62 </usage>
  63 </directivesynopsis>
  64
  65 <directivesynopsis>
  66 <name>MetaDir</name>
  67 <description>Name of the directory to find CERN-style meta information
  68 files</description>
  69 <syntax>MetaDir <var>directory</var></syntax>
  70 <default>MetaDir .web</default>
  71 <contextlist><context>server config</context>
  72 <context>virtual host</context>
  73 <context>directory</context>
  74 <context>.htaccess</context></contextlist>
  75 <override>Indexes</override>
  76
  77 <usage>
  78     <p>Specifies the name of the directory in which Apache can find
  79     meta information files. The directory is usually a 'hidden'
  80     subdirectory of the directory that contains the file being
  81     accessed. Set to "<code>.</code>" to look in the same directory
  82     as the file:</p>
  83
  84     <highlight language="config">MetaDir .</highlight>
  85
  86     <p>Or, to set it to a subdirectory of the directory containing the
  87     files:</p>
  88
  89     <highlight language="config">MetaDir .meta</highlight>
  90 </usage>
  91 </directivesynopsis>
  92
  93 <directivesynopsis>
  94 <name>MetaSuffix</name>
  95 <description>File name suffix for the file containing CERN-style
  96 meta information</description>
  97 <syntax>MetaSuffix <var>suffix</var></syntax>
  98 <default>MetaSuffix .meta</default>
  99 <contextlist><context>server config</context>
 100 <context>virtual host</context>
 101 <context>directory</context>
 102 <context>.htaccess</context></contextlist>
 103 <override>Indexes</override>
 104
 105 <usage>
 106     <p>Specifies the file name suffix for the file containing the
 107     meta information. For example, the default values for the two
 108     directives will cause a request to
 109     <code>DOCUMENT_ROOT/somedir/index.html</code> to look in
 110     <code>DOCUMENT_ROOT/somedir/.web/index.html.meta</code> and
 111     will use its contents to generate additional MIME header
 112     information.</p>
 113
 114     <example><title>Example:</title>
 115     <highlight language="config">
 116       MetaSuffix .meta
 117      </highlight>
 118     </example>
 119 </usage>
 120 </directivesynopsis>
 121
 122 </modulesynopsis>