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

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2 <!DOCTYPE manualpage SYSTEM "./style/manualpage.dtd">
   3 <?xml-stylesheet type="text/xsl" href="./style/manual.en.xsl"?>
   4 <!-- $Revision: 1.10 $ -->
   5
   6 <!--
   7  Copyright 2002-2004 The Apache Software Foundation
   8
   9  Licensed under the Apache License, Version 2.0 (the "License");
  10  you may not use this file except in compliance with the License.
  11  You may obtain a copy of the License at
  12
  13      http://www.apache.org/licenses/LICENSE-2.0
  14
  15  Unless required by applicable law or agreed to in writing, software
  16  distributed under the License is distributed on an "AS IS" BASIS,
  17  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  See the License for the specific language governing permissions and
  19  limitations under the License.
  20 -->
  21
  22 <manualpage metafile="filter.xml.meta">
  23
  24   <title>Filters</title>
  25
  26   <summary>
  27     <p>This document describes the use of filters in Apache.</p>
  28   </summary>
  29
  30   <section id="filters">
  31     <title>Filters</title>
  32     <related>
  33       <modulelist>
  34         <module>mod_deflate</module>
  35         <module>mod_ext_filter</module>
  36         <module>mod_include</module>
  37       </modulelist>
  38       <directivelist>
  39         <directive module="mod_mime">AddInputFilter</directive>
  40         <directive module="mod_mime">AddOutputFilter</directive>
  41         <directive module="mod_mime">RemoveInputFilter</directive>
  42         <directive module="mod_mime">RemoveOutputFilter</directive>
  43         <directive module="mod_ext_filter">ExtFilterDefine</directive>
  44         <directive module="mod_ext_filter">ExtFilterOptions</directive>
  45         <directive module="core">SetInputFilter</directive>
  46         <directive module="core">SetOutputFilter</directive>
  47       </directivelist>
  48     </related>
  49
  50     <p>A <em>filter</em> is a process that is applied to data that
  51     is sent or received by the server. Data sent by clients to the
  52     server is processed by <em>input filters</em> while data sent
  53     by the server to the client is processed by <em>output
  54     filters</em>. Multiple filters can be applied to the data, and
  55     the order of the filters can be explicitly specified.</p>
  56
  57     <p>Filters are used internally by Apache to perform functions such
  58     as chunking and byte-range request handling. In addition, modules
  59     can provide filters that are selectable using run-time
  60     configuration directives. The set of filters that apply to data
  61     can be manipulated with the
  62     <directive module="core">SetInputFilter</directive>,
  63     <directive module="core">SetOutputFilter</directive>,
  64     <directive module="mod_mime">AddInputFilter</directive>,
  65     <directive module="mod_mime">AddOutputFilter</directive>,
  66     <directive module="mod_mime">RemoveInputFilter</directive>, and
  67     <directive module="mod_mime">RemoveOutputFilter</directive>
  68     directives.</p>
  69
  70     <p>The following user-selectable filters are currently provided
  71     with the Apache HTTP Server distribution.</p>
  72
  73     <dl>
  74       <dt>INCLUDES</dt>
  75       <dd>Server-Side Includes processing by <module>mod_include</module></dd>
  76       <dt>DEFLATE</dt>
  77       <dd>Compress output before sending it to the client using
  78           <module>mod_deflate</module>
  79       </dd>
  80     </dl>
  81
  82     <p>In addition, the module <module>mod_ext_filter</module> allows
  83     for external programs to be defined as filters.</p>
  84   </section>
  85 </manualpage>