diff options
| author | André Malo <nd@apache.org> | 2002-11-13 00:17:04 +0000 |
|---|---|---|
| committer | André Malo <nd@apache.org> | 2002-11-13 00:17:04 +0000 |
| commit | ec594c37b1e6d3532d08b61a8a56b8c0a679c7cb (patch) | |
| tree | 9e169329fd88dfe7b2ccca3c3c5ead2dd3554e3d /docs/manual/mod/mod_ext_filter.html.en | |
| parent | a171a5e55be6cd734d35b8839506bc4c184a7b20 (diff) | |
| download | httpd-ec594c37b1e6d3532d08b61a8a56b8c0a679c7cb.tar.gz | |
update transformation
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@97502 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs/manual/mod/mod_ext_filter.html.en')
| -rw-r--r-- | docs/manual/mod/mod_ext_filter.html.en | 347 |
1 files changed, 187 insertions, 160 deletions
diff --git a/docs/manual/mod/mod_ext_filter.html.en b/docs/manual/mod/mod_ext_filter.html.en index ea4e0ae19b..c199f6e0b8 100644 --- a/docs/manual/mod/mod_ext_filter.html.en +++ b/docs/manual/mod/mod_ext_filter.html.en @@ -5,9 +5,8 @@ This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX --><title>mod_ext_filter - Apache HTTP Server</title><link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /><link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /><link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link href="../images/favicon.ico" rel="shortcut icon" /></head><body><div id="page-header"><p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p><p class="apache">Apache HTTP Server Version 2.0</p><img alt="" src="../images/feather.gif" /></div><div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div><div id="path"><a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Modules</a></div><div id="page-content"><div id="preamble"><h1>Apache Module mod_ext_filter</h1><table class="module"><tr><th><a href="module-dict.html#Description">Description: - </a></th><td>Pass the response body - through an external program before delivery to the - client</td></tr><tr><th><a href="module-dict.html#Status">Status: + </a></th><td>Pass the response body through an external program before +delivery to the client</td></tr><tr><th><a href="module-dict.html#Status">Status: </a></th><td>Experimental</td></tr><tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier: </a></th><td>ext_filter_module</td></tr><tr><th><a href="module-dict.html#SourceFile">Source File: </a></th><td>mod_ext_filter.c</td></tr></table><h3>Summary</h3> @@ -42,128 +41,159 @@ a prototype environment for filters.</p> </div><div id="quickview"><h3 class="directives">Directives</h3><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#extfilterdefine">ExtFilterDefine</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#extfilteroptions">ExtFilterOptions</a></li> -</ul><h3>Topics</h3><ul id="topics"><li><img alt="" src="../images/down.gif" /> Examples</li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2>Examples</h2> - -<h3>Generating HTML from some other type of response</h3> -<div class="example"><pre> -# mod_ext_filter directive to define a filter to HTML-ize text/c files -# using the external program /usr/bin/enscript, with the type of the -# result set to text/html -ExtFilterDefine c-to-html mode=output intype=text/c outtype=text/html \ - cmd="/usr/bin/enscript --color -W html -Ec -o - -" - -<Directory "/export/home/trawick/apacheinst/htdocs/c"> - -# core directive to cause the new filter to be run on output -SetOutputFilter c-to-html - -# mod_mime directive to set the type of .c files to text/c -AddType text/c .c - -# mod_ext_filter directive to set the debug level just high -# enough to see a log message per request showing the configuration -# in force -ExtFilterOptions DebugLevel=1 - -</Directory> -</pre></div> - - -<h3>Implementing a content encoding filter</h3> -<div class="example"><pre> -# mod_ext_filter directive to define the external filter -ExtFilterDefine gzip mode=output cmd=/bin/gzip - -<Location /gzipped> - -# core directive to cause the gzip filter to be run on output -SetOutputFilter gzip - -# mod_header directive to add "Content-Encoding: gzip" header field -Header set Content-Encoding gzip - -</Location> -</pre></div> - - <p>Note: this gzip example is just for the purposes of illustration. - Please refer to <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code> for a practical - implementation.</p> - - -<h3>Slowing down the server</h3> -<div class="example"><pre> -# mod_ext_filter directive to define a filter which runs everything -# through cat; cat doesn't modify anything; it just introduces extra -# pathlength and consumes more resources -ExtFilterDefine slowdown mode=output cmd=/bin/cat preservescontentlength - -<Location /> - -# core directive to cause the slowdown filter to be run several times on -# output -SetOutputFilter slowdown slowdown slowdown - -</Location> -</pre></div> - - -<h3>Using sed to replace text in the response</h3> -<div class="example"><pre> -# mod_ext_filter directive to define a filter which replaces text in -# the response -ExtFilterDefine fixtext mode=output cmd="/bin/sed s/verdana/arial/g" intype=text/html - -<Location /> - -# core directive to cause the fixtext filter to be run on output -# output -SetOutputFilter fixtext - -</Location> -</pre></div> - - -<h3>Tracing another filter</h3> -<div class="example"><pre> -# Trace the data read and written by mod_deflate for a particular -# client (IP 192.168.1.31) experiencing compression problems. -# This filter will trace what goes into mod_deflate. -ExtFilterDefine tracebefore cmd="/bin/tracefilter.pl /tmp/tracebefore" \ - EnableEnv=trace_this_client -# This filter will trace what goes after mod_deflate. Note that without -# the ftype parameter, the default filter type of AP_FTYPE_RESOURCE would -# cause the filter to be placed *before* mod_deflate in the filter -# chain. Giving it a numeric value slightly higher than -# AP_FTYPE_CONTENT_SET will ensure that it is placed after mod_deflate. -ExtFilterDefine traceafter cmd="/bin/tracefilter.pl /tmp/traceafter" \ - EnableEnv=trace_this_client ftype=21 - -<Directory /usr/local/docs> - SetEnvIf Remote_Addr 192.168.1.31 trace_this_client - SetOutputFilter tracebefore;deflate;traceafter -</Directory> -</pre></div> - -<div class="example"><h3>Here is the filter which traces the data:</h3><pre> -#!/usr/local/bin/perl -w - -use strict; - -open(SAVE, ">$ARGV[0]") or die "can't open $ARGV[0]: $?"; - -while (<STDIN>) -{ - print SAVE $_; - print $_; -} - -close(SAVE); -</pre></div> - - +</ul><h3>Topics</h3><ul id="topics"><li><img alt="" src="../images/down.gif" /> <a href="#examples">Examples</a></li></ul><h3>See also</h3><ul class="seealso"><li><a href="../filter.html">The filter documentation</a></li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2><a name="examples" id="examples">Examples</a></h2> + + <h3>Generating HTML from some other type of response</h3> + <div class="example"><p><code> + # mod_ext_filter directive to define a filter<br /> + # to HTML-ize text/c files using the external<br /> + # program /usr/bin/enscript, with the type of<br /> + # the result set to text/html<br /> + ExtFilterDefine c-to-html mode=output \<br /> + <span class="indent"> + intype=text/c outtype=text/html \<br /> + cmd="/usr/bin/enscript --color -W html -Ec -o - -"<br /> + </span> + <br /> + <Directory "/export/home/trawick/apacheinst/htdocs/c"><br /> + <span class="indent"> + # core directive to cause the new filter to<br /> + # be run on output<br /> + SetOutputFilter c-to-html<br /> + <br /> + # mod_mime directive to set the type of .c<br /> + # files to text/c<br /> + AddType text/c .c<br /> + <br /> + # mod_ext_filter directive to set the debug<br /> + # level just high enough to see a log message<br /> + # per request showing the configuration in force<br /> + ExtFilterOptions DebugLevel=1<br /> + </span> + </Directory> + </code></p></div> + + + <h3>Implementing a content encoding filter</h3> + <p>Note: this gzip example is just for the purposes of illustration. + Please refer to <code class="module"><a href="../mod/mod_deflate.html">mod_deflate</a></code> for a practical + implementation.</p> + + <div class="example"><p><code> + # mod_ext_filter directive to define the external filter<br /> + ExtFilterDefine gzip mode=output cmd=/bin/gzip<br /> + <br /> + <Location /gzipped><br /> + <span class="indent"> + # core directive to cause the gzip filter to be<br /> + # run on output<br /> + SetOutputFilter gzip<br /> + <br /> + # mod_header directive to add<br /> + # "Content-Encoding: gzip" header field<br /> + Header set Content-Encoding gzip<br /> + </span> + </Location> + </code></p></div> + + + <h3>Slowing down the server</h3> + <div class="example"><p><code> + # mod_ext_filter directive to define a filter<br /> + # which runs everything through cat; cat doesn't<br /> + # modify anything; it just introduces extra pathlength<br /> + # and consumes more resources<br /> + ExtFilterDefine slowdown mode=output cmd=/bin/cat \<br /> + <span class="indent"> + preservescontentlength<br /> + </span> + <br /> + <Location /><br /> + <span class="indent"> + # core directive to cause the slowdown filter to<br /> + # be run several times on output<br /> + #<br /> + SetOutputFilter slowdown;slowdown;slowdown<br /> + </span> + </Location> + </code></p></div> + + + <h3>Using sed to replace text in the response</h3> + <div class="example"><p><code> + # mod_ext_filter directive to define a filter which<br /> + # replaces text in the response<br /> + #<br /> + ExtFilterDefine fixtext mode=output intype=text/html \<br /> + <span class="indent"> + cmd="/bin/sed s/verdana/arial/g"<br /> + </span> + <br /> + <Location /><br /> + <span class="indent"> + # core directive to cause the fixtext filter to<br /> + # be run on output<br /> + SetOutputFilter fixtext<br /> + </span> + </Location> + </code></p></div> + + + <h3>Tracing another filter</h3> + <div class="example"><p><code> + # Trace the data read and written by mod_deflate<br /> + # for a particular client (IP 192.168.1.31)<br /> + # experiencing compression problems.<br /> + # This filter will trace what goes into mod_deflate.<br /> + ExtFilterDefine tracebefore \<br /> + <span class="indent"> + cmd="/bin/tracefilter.pl /tmp/tracebefore" \<br /> + EnableEnv=trace_this_client<br /> + </span> + <br /> + # This filter will trace what goes after mod_deflate.<br /> + # Note that without the ftype parameter, the default<br /> + # filter type of AP_FTYPE_RESOURCE would cause the<br /> + # filter to be placed *before* mod_deflate in the filter<br /> + # chain. Giving it a numeric value slightly higher than<br /> + # AP_FTYPE_CONTENT_SET will ensure that it is placed<br /> + # after mod_deflate.<br /> + ExtFilterDefine traceafter \<br /> + <span class="indent"> + cmd="/bin/tracefilter.pl /tmp/traceafter" \<br /> + EnableEnv=trace_this_client ftype=21<br /> + </span> + <br /> + <Directory /usr/local/docs><br /> + <span class="indent"> + SetEnvIf Remote_Addr 192.168.1.31 trace_this_client<br /> + SetOutputFilter tracebefore;deflate;traceafter<br /> + </span> + </Directory> + </code></p></div> + + <div class="example"><h3>Here is the filter which traces the data:</h3><p><code> + #!/usr/local/bin/perl -w<br /> + use strict;<br /> + <br /> + open(SAVE, ">$ARGV[0]")<br /> + <span class="indent"> + or die "can't open $ARGV[0]: $?";<br /> + </span> + <br /> + while (<STDIN>) {<br /> + <span class="indent"> + print SAVE $_;<br /> + print $_;<br /> + </span> + }<br /> + <br /> + close(SAVE); + </code></p></div> + </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="ExtFilterDefine" id="ExtFilterDefine">ExtFilterDefine</a> <a name="extfilterdefine" id="extfilterdefine">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description: - </a></th><td /></tr><tr><th><a href="directive-dict.html#Syntax">Syntax: - </a></th><td><code>ExtFilterDefine <em>filtername</em> <em>parameters</em></code></td></tr><tr><th><a href="directive-dict.html#Context">Context: + </a></th><td>Define an external filter</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax: + </a></th><td><code>ExtFilterDefine <var>filtername</var> <var>parameters</var></code></td></tr><tr><th><a href="directive-dict.html#Context">Context: </a></th><td>server config</td></tr><tr><th><a href="directive-dict.html#Status">Status: </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module: </a></th><td>mod_ext_filter</td></tr></table> @@ -171,7 +201,7 @@ close(SAVE); characteristics of an external filter, including the program to run and its arguments.</p> - <p><em>filtername</em> specifies the name of the filter being + <p><var>filtername</var> specifies the name of the filter being defined. This name can then be used in SetOutputFilter directives. It must be unique among all registered filters. <em>At the present time, no error is reported by the @@ -180,48 +210,48 @@ close(SAVE); <p>Subsequent parameters can appear in any order and define the external command to run and certain other characteristics. The - only required parameter is <em>cmd=</em>. These parameters + only required parameter is <code>cmd=</code>. These parameters are:</p> <dl> - <dt>cmd=<em>cmdline</em></dt> + <dt><code>cmd=<var>cmdline</var></code></dt> <dd>The <code>cmd=</code> keyword allows you to specify the external command to run. If there are arguments after the program name, the command line should be surrounded in - quotation marks (e.g., <em>cmd="/bin/mypgm arg1 arg2"</em>. - Normal shell quoting is not necessary since the program is - run directly, bypassing the shell. Program arguments are - blank-delimited. A backslash can be used to escape blanks - which should be part of a program argument. Any backslashes - which are part of the argument must be escaped with backslash - themselves. In addition to the standard CGI environment + quotation marks (<em>e.g.</em>, <code>cmd="<var>/bin/mypgm</var> + <var>arg1</var> <var>arg2</var>"</code>. Normal shell quoting is + not necessary since the program is run directly, bypassing the shell. + Program arguments are blank-delimited. A backslash can be used to + escape blanks which should be part of a program argument. Any + backslashes which are part of the argument must be escaped with + backslash themselves. In addition to the standard CGI environment variables, DOCUMENT_URI, DOCUMENT_PATH_INFO, and QUERY_STRING_UNESCAPED will also be set for the program.</dd> - <dt>mode=<em>mode</em></dt> + <dt><code>mode=<var>mode</var></code></dt> - <dd><em>mode</em> should be <em>output</em> for now (the - default). In the future, <em>mode=input</em> will be used to + <dd><code>mode</code> should be <code>output</code> for now (the + default). In the future, <code>mode=input</code> will be used to specify a filter for request bodies.</dd> - <dt>intype=<em>imt</em></dt> + <dt><code>intype=<var>imt</var></code></dt> - <dd>This parameter specifies the internet media type (i.e., + <dd>This parameter specifies the internet media type (<em>i.e.</em>, MIME type) of documents which should be filtered. By default, all documents are filtered. If <code>intype=</code> is specified, the filter will be disabled for documents of other types.</dd> - <dt>outtype=<em>imt</em></dt> + <dt><code>outtype=<var>imt</var></code></dt> - <dd>This parameter specifies the internet media type (i.e., + <dd>This parameter specifies the internet media type (<em>i.e.</em>, MIME type) of filtered documents. It is useful when the filter changes the internet media type as part of the filtering operation. By default, the internet media type is unchanged.</dd> - <dt>PreservesContentLength</dt> + <dt><code>PreservesContentLength</code></dt> <dd>The <code>PreservesContentLength</code> keyword specifies that the filter preserves the content length. This is not the @@ -229,7 +259,7 @@ close(SAVE); event that the filter doesn't modify the length, this keyword should be specified.</dd> - <dt>ftype=<em>filtertype</em></dt> + <dt><code>ftype=<var>filtertype</var></code></dt> <dd>This parameter specifies the numeric value for filter type that the filter should be registered as. The default value, @@ -239,36 +269,34 @@ close(SAVE); the AP_FTYPE_foo definitions in util_filter.h for appropriate values.</dd> - <dt>disableenv=<em>env</em></dt> + <dt><code>disableenv=<var>env</var></code></dt> <dd>This parameter specifies the name of an environment variable which, if set, will disable the filter.</dd> - <dt>enableenv=<em>env</em></dt> + <dt><code>enableenv=<var>env</var></code></dt> <dd>This parameter specifies the name of an environment variable which must be set, or the filter will be disabled.</dd> - </dl> </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="directive-section"><h2><a name="ExtFilterOptions" id="ExtFilterOptions">ExtFilterOptions</a> <a name="extfilteroptions" id="extfilteroptions">Directive</a></h2><table class="directive"><tr><th><a href="directive-dict.html#Description">Description: - </a></th><td /></tr><tr><th><a href="directive-dict.html#Syntax">Syntax: - </a></th><td><code>ExtFilterOptions - <em>option</em> [<em>option</em>] ...</code></td></tr><tr><th><a href="directive-dict.html#Default">Default: + </a></th><td>Configure mod_ext_filter options</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax: + </a></th><td><code>ExtFilterOptions <var>option</var> [<var>option</var>] ...</code></td></tr><tr><th><a href="directive-dict.html#Default">Default: </a></th><td><code>ExtFilterOptions DebugLevel=0 NoLogStderr</code></td></tr><tr><th><a href="directive-dict.html#Context">Context: </a></th><td>directory</td></tr><tr><th><a href="directive-dict.html#Status">Status: </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module: </a></th><td>mod_ext_filter</td></tr></table> <p>The <code class="directive">ExtFilterOptions</code> directive specifies - special processing options for <code>mod_ext_filter</code>. - <em>Option</em> can be one of</p> + special processing options for <code class="module"><a href="../mod/mod_ext_filter.html">mod_ext_filter</a></code>. + <var>Option</var> can be one of</p> <dl> - <dt>DebugLevel=<em>n</em></dt> + <dt><code>DebugLevel=<var>n</var></code></dt> <dd> The <code>DebugLevel</code> keyword allows you to specify the level of debug messages generated by - <code>mod_ext_filter</code>. By default, no debug messages + <code class="module"><a href="../mod/mod_ext_filter.html">mod_ext_filter</a></code>. By default, no debug messages are generated. This is equivalent to <code>DebugLevel=0</code>. With higher numbers, more debug messages are generated, and server performance will be @@ -276,12 +304,11 @@ close(SAVE); described with the definitions of the DBGLVL_ constants near the beginning of <code>mod_ext_filter.c</code>. - <p>Note: The core directive LogLevel should be used to - cause debug messages to be stored in the Apache error - log.</p> + <p>Note: The core directive <code class="directive"><a href="../mod/core.html#loglevel">LogLevel</a></code> should be used to cause debug messages to + be stored in the Apache error log.</p> </dd> - <dt>LogStderr | NoLogStderr</dt> + <dt><code>LogStderr | NoLogStderr</code></dt> <dd>The <code>LogStderr</code> keyword specifies that messages written to standard error by the external filter @@ -289,9 +316,9 @@ close(SAVE); <code>NoLogStderr</code> disables this feature.</dd> </dl> -<div class="example"><h3>Example</h3><p><code> - ExtFilterOptions LogStderr DebugLevel=0 -</code></p></div> + <div class="example"><h3>Example</h3><p><code> + ExtFilterOptions LogStderr DebugLevel=0 + </code></p></div> <p>Messages written to the filter's standard error will be stored in the Apache error log. No debug messages will be generated by |