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 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Copyright 2002-2005 The Apache Software Foundation or its licensors, as
   8  applicable.
   9
  10  Licensed under the Apache License, Version 2.0 (the "License");
  11  you may not use this file except in compliance with the License.
  12  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 <manualpage metafile="filter.xml.meta">
  24
  25   <title>Filters</title>
  26
  27   <summary>
  28     <p>This document describes the use of filters in Apache.</p>
  29   </summary>
  30
  31   <section id="filters">
  32     <title>Filters</title>
  33     <related>
  34       <modulelist>
  35         <module>mod_deflate</module>
  36         <module>mod_ext_filter</module>
  37         <module>mod_include</module>
  38       </modulelist>
  39       <directivelist>
  40         <directive module="mod_mime">AddInputFilter</directive>
  41         <directive module="mod_mime">AddOutputFilter</directive>
  42         <directive module="mod_mime">RemoveInputFilter</directive>
  43         <directive module="mod_mime">RemoveOutputFilter</directive>
  44         <directive module="mod_ext_filter">ExtFilterDefine</directive>
  45         <directive module="mod_ext_filter">ExtFilterOptions</directive>
  46         <directive module="core">SetInputFilter</directive>
  47         <directive module="core">SetOutputFilter</directive>
  48       </directivelist>
  49     </related>
  50
  51     <p>A <em>filter</em> is a process that is applied to data that
  52     is sent or received by the server. Data sent by clients to the
  53     server is processed by <em>input filters</em> while data sent
  54     by the server to the client is processed by <em>output
  55     filters</em>. Multiple filters can be applied to the data, and
  56     the order of the filters can be explicitly specified.</p>
  57
  58     <p>Filters are used internally by Apache to perform functions such
  59     as chunking and byte-range request handling. In addition, modules
  60     can provide filters that are selectable using run-time
  61     configuration directives. The set of filters that apply to data
  62     can be manipulated with the
  63     <directive module="core">SetInputFilter</directive>,
  64     <directive module="core">SetOutputFilter</directive>,
  65     <directive module="mod_mime">AddInputFilter</directive>,
  66     <directive module="mod_mime">AddOutputFilter</directive>,
  67     <directive module="mod_mime">RemoveInputFilter</directive>, and
  68     <directive module="mod_mime">RemoveOutputFilter</directive>
  69     directives.</p>
  70
  71     <p>The following user-selectable filters are currently provided
  72     with the Apache HTTP Server distribution.</p>
  73
  74     <dl>
  75       <dt>INCLUDES</dt>
  76       <dd>Server-Side Includes processing by <module>mod_include</module></dd>
  77       <dt>DEFLATE</dt>
  78       <dd>Compress output before sending it to the client using
  79           <module>mod_deflate</module>
  80       </dd>
  81     </dl>
  82
  83     <p>In addition, the module <module>mod_ext_filter</module> allows
  84     for external programs to be defined as filters.</p>
  85   </section>
  86 </manualpage>