<modulesynopsis metafile="mod_sed.xml.meta">
<name>mod_sed</name>
-<description>Filtering Input (request) and Output (response) content using sed commands</description>
+<description>Filter Input (request) and Output (response) content using <code>sed</code> syntax</description>
<status>Experimental</status>
<sourcefile>mod_sed.c sed0.c sed1.c regexp.c regexp.h sed.h</sourcefile>
<identifier>sed_module</identifier>
<summary>
<p>
-mod_sed is an in-process content filter. The mod_sed filter implements the sed edit
-commands implemented by the Solaris 10 sed
-program as described in the <a href="http://docs.sun.com/app/docs/doc/816-5165/sed-1b?a=view">man
-page</a>. However, unlike sed, mod_sed doesn't take data from
+<module>mod_sed</module> is an in-process content filter. The <module>mod_sed</module> filter implements the <code>sed</code> editing
+commands implemented by the Solaris 10 <code>sed</code>
+program as described in the <a href="http://docs.sun.com/app/docs/doc/816-5165/sed-1b?a=view">manual
+page</a>. However, unlike <code>sed</code>, <module>mod_sed</module> doesn't take data from
standard
input. Instead, the filter acts on the entity data sent between client and
-server. mod_sed can be used as an input or output filter. mod_sed is a
+server. <module>mod_sed</module> can be used as an input or output filter. <module>mod_sed</module> is a
content filter, which means that it cannot be used to modify client or
server http headers.
</p>
<p>
-The mod_sed output filter accepts a chunk of data, executes the sed scripts on the data, and generates the output which is passed to next filter in the filter chain.
+The <module>mod_sed</module> output filter accepts a chunk of data, executes the <code>sed</code> scripts on the data, and generates the output which is passed to the next filter in the chain.
</p>
<p>
-The mod_sed input filter reads the data from the next filter in filter chain, executes the sed scripts, and returns the generated data to the caller filter in the filter chain.
+The <module>mod_sed</module> input filter reads the data from the next filter in the chain, executes the <code>sed</code> scripts, and returns the generated data to the caller filter in the filter chain.
</p>
<p>
-Both the input and output filter only process the data if new line characters are seen in the content. At the end of the data, the rest of the data is treated as the last line.
+Both the input and output filters only process the data if newline characters are seen in the content. At the end of the data, the rest of the data is treated as the last line.
</p>
-<p>A tutorial article on mod_sed, and why it is more powerful than simple
+<p>A tutorial article on <module>mod_sed</module>, and why it is more powerful than simple
string or regular expression search and replace, is available <a
href="http://blogs.sun.com/basant/entry/using_mod_sed_to_filter">on
the author's blog</a>.</p>
<section id="sampleconf"><title>Sample Configuration</title>
<example><title>Adding an output filter </title>
- # In following example, the sed filter will change the string <br />
- # "monday" to "MON" and the string "sunday" to SUN in html document <br />
- # before sending to client. <br />
+ # In the following example, the sed filter will change the string<br />
+ # "monday" to "MON" and the string "sunday" to SUN in html documents<br />
+ # before sending to the client.<br />
<indent>
<Directory "/var/www/docs/sed"> <br />
<indent>
</example>
<example><title>Adding an input filter </title>
- # In following example, the sed filter will change the string <br />
- # "monday" to "MON" and the string "sunday" to SUN in the POST data <br />
- # sent to php <br />
+ # In the following example, the sed filter will change the string<br />
+ # "monday" to "MON" and the string "sunday" to SUN in the POST data<br />
+ # sent to PHP.<br />
<indent>
<Directory "/var/www/docs/sed"> <br />
<indent>
</section>
<section id="sed_commands"><title>Sed Commands</title>
<p>
- Complete details of the sed command can be found from the
- <a href="http://docs.sun.com/app/docs/doc/816-5165/sed-1b?a=view">sed man
+ Complete details of the <code>sed</code> command can be found from the
+ <a href="http://docs.sun.com/app/docs/doc/816-5165/sed-1b?a=view">sed manual
page</a>.
</p>
<dl>
<dt><code>b</code></dt>
- <dd>branch to the label specified (Similar to goto)</dd>
+ <dd>branch to the label specified (similar to goto).</dd>
<dt><code>h</code></dt>
<dd>Copy the current line to the hold buffer.</dd>
<dt><code>H</code></dt>
<dd>Append the current line to the hold buffer.</dd>
<dt><code>g</code></dt>
- <dd>Copy the hold buffer into the current line</dd>
+ <dd>Copy the hold buffer into the current line.</dd>
<dt><code>G</code></dt>
- <dd>Append the hold buffer to the current line</dd>
+ <dd>Append the hold buffer to the current line.</dd>
<dt><code>x</code></dt>
- <dd>Swap the content of the hold buffer and the current line</dd>
+ <dd>Swap the content of the hold buffer and the current line.</dd>
</dl>
</section>
<directivesynopsis>
<name>OutputSed</name>
-<description>Sed command for filtering the response content</description>
+<description>Sed command for filtering response content</description>
<syntax>OutputSed <var>sed-command</var></syntax>
<contextlist><context>directory</context><context>.htaccess</context>
</contextlist>
<usage>
- <p>The <directive>OutputSed</directive> directive specifies the sed
- command which will be executed on the response.
+ <p>The <directive>OutputSed</directive> directive specifies the <code>sed</code>
+ command to execute on the response.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>InputSed</name>
-<description>Sed command to filter the request data (typically post data)</description>
+<description>Sed command to filter request data (typically <code>POST</code> data)</description>
<syntax>InputSed <var>sed-command</var></syntax>
<contextlist><context>directory</context><context>.htaccess</context>
</contextlist>
<usage>
- <p>The <directive>InputSed</directive> directive specifies the sed command
- which will be executed on the request data e.g POST data.
+ <p>The <directive>InputSed</directive> directive specifies the <code>sed</code> command
+ to execute on the request data e.g., <code>POST</code> data.
</p>
</usage>
</directivesynopsis>
projects / apache / commitdiff