From f279daa8f92409e5fd573bcd416d7d385197fd6c Mon Sep 17 00:00:00 2001 From: Joshua Slive Date: Sat, 10 Feb 2001 04:04:12 +0000 Subject: [PATCH] Add some VERY basic filter documentation. See followup discussion on apache-docs. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@88047 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/filter.html | 61 +++++++++++++++++++++++++ docs/manual/filter.html.en | 61 +++++++++++++++++++++++++ docs/manual/index.html | 2 + docs/manual/index.html.en | 2 + docs/manual/mod/core.html | 69 +++++++++++++++++++++++++++++ docs/manual/mod/directives.html | 2 + docs/manual/mod/mod_ext_filter.html | 8 ++-- 7 files changed, 201 insertions(+), 4 deletions(-) create mode 100644 docs/manual/filter.html create mode 100644 docs/manual/filter.html.en diff --git a/docs/manual/filter.html b/docs/manual/filter.html new file mode 100644 index 0000000000..9cdcb201d9 --- /dev/null +++ b/docs/manual/filter.html @@ -0,0 +1,61 @@ + + + +Filters - Apache HTTPD + + + + + +

Filters

+ + + + +

+Related Modules

+ +mod_ext_filter
+mod_include
+

+Related Directives

+ +ExtFilterDefine
+ExtFilterOptions
+SetInputFilter
+SetOutputFilter
+

+ + +

A filter is a process which is applied to data that is +sent or received by the server. Data sent by clients to the server +is processed by input filters while data sent by the +server to the client is processed by output filters. +Multiple filters can be applied to the data, and the order +of the filters can be explicitly specified. In addition, +since filters apply to all content, they allow for flexible +manipulation of data such as processing the output of +CGI scripts for Server Side Includes.

+ +

The set of filters which apply to data can be manipulated +with the SetInputFilter and SetOutputFilter +directives.

+ +

The only filter currently included with the Apache distribution +is the INCLUDE filter which is provided by +mod_include to process output +for Server Side Includes. There is also an experimental module +called mod_ext_filter +which allows for external programs to be defined as filters.

+ + + + + + diff --git a/docs/manual/filter.html.en b/docs/manual/filter.html.en new file mode 100644 index 0000000000..9cdcb201d9 --- /dev/null +++ b/docs/manual/filter.html.en @@ -0,0 +1,61 @@ + + + +Filters - Apache HTTPD + + + + + +

Filters

+ + + + +

+Related Modules

+ +mod_ext_filter
+mod_include
+

+Related Directives

+ +ExtFilterDefine
+ExtFilterOptions
+SetInputFilter
+SetOutputFilter
+

+ + +

+ +

The set of filters which apply to data can be manipulated +with the SetInputFilter and SetOutputFilter +directives.

+ +

+ + + + + + diff --git a/docs/manual/index.html b/docs/manual/index.html index 9781742513..235d3a4410 100644 --- a/docs/manual/index.html +++ b/docs/manual/index.html @@ -133,6 +133,8 @@ Modules: By Type or Handlers +Filters + Content negotiation Environment Variables diff --git a/docs/manual/index.html.en b/docs/manual/index.html.en index 9781742513..235d3a4410 100644 --- a/docs/manual/index.html.en +++ b/docs/manual/index.html.en @@ -133,6 +133,8 @@ Modules: By Type or Handlers +Filters + Content negotiation Environment Variables diff --git a/docs/manual/mod/core.html b/docs/manual/mod/core.html index e0fe26a51a..9bf147aa04 100644 --- a/docs/manual/mod/core.html +++ b/docs/manual/mod/core.html @@ -73,6 +73,8 @@ always available.

TimeOut

<VirtualHost> @@ -2479,6 +2481,73 @@ subsequent connections. If you intend running Apache to serve a busy site, standalone will probably be your only option.

SetInputFilter directive

Syntax: SetInputFilter filter +[filter] ...
+Default: none
+Context: directory
+Status: core

+ +

The SetInputFilter directive sets the filters +which will process client requests when they are received by the +server.

+ +

The order of the arguments determines the order in which the +filters will process the content.

+ +

SetOutputFilter directive

Syntax: SetOutputFilter filter +[filter] ...
+Default: none
+Context: directory
+Status: core

+ +

The SetOutputFilter directive sets the filters which +will process responses from the server before they are sent to the +client. For example, the following configuration will process +all files in the /www/data/ directory for +server-side includes.

+ +

+<Directory /www/data/> + SetOutputFilter INCLUDES +</Directory> +

+ +

The order of the arguments determines the order in which the +filters will process the content.

+ +

TimeOut directive

SetEnvIf

ThreadsPerChild diff --git a/docs/manual/mod/mod_ext_filter.html b/docs/manual/mod/mod_ext_filter.html index ea13758315..d6f663fdc3 100644 --- a/docs/manual/mod/mod_ext_filter.html +++ b/docs/manual/mod/mod_ext_filter.html @@ -86,7 +86,7 @@ REL="Help" <Directory "/export/home/trawick/apacheinst/htdocs/c"> # core directive to cause the new filter to be run on output - AddOutputFilter c-to-heml + SetOutputFilter c-to-heml # mod_mime directive to set the type of .c files to text/c AddType text/c .c @@ -108,7 +108,7 @@ REL="Help" <Location /gzipped> # core directive to cause the gzip filter to be run on output - AddOutputFilter gzip + SetOutputFilter gzip # mod_header directive to add "Content-Encoding: gzip" header field Header set Content-Encoding gzip @@ -127,7 +127,7 @@ REL="Help" # core directive to cause the slowdown filter to be run several times on # output - AddOutputFilter slowdown slowdown slowdown + SetOutputFilter slowdown slowdown slowdown </Location> @@ -173,7 +173,7 @@ REL="Help"

filtername specifies the name of the filter being defined. This name - can then be used in AddOutputFilter directives. It must be unique among all + can then be used in SetOutputFilter directives. It must be unique among all registered filters. At the present time, no error is reported by the register-filter API, so a problem with duplicate names isn't reported to the user. -- 2.50.1