mod_substitute.html.en revision fd9abdda70912b99b24e3bf1a38f26fde908a74c
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd This file is generated from xml source: DO NOT EDIT
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<title>mod_substitute - Apache HTTP Server Version 2.5</title>
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" />
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<script src="/style/scripts/prettify.min.js" type="text/javascript">
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<link href="/images/favicon.ico" rel="shortcut icon" /></head>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
3f08db06526d6901aa08c110b5bc7dde6bc39905nd<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Modules</a></div>
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung<div id="preamble"><h1>Apache Module mod_substitute</h1>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<p><span>Available Languages: </span><a href="/en/mod/mod_substitute.html" title="English"> en </a></p>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Perform search and replace operations on response bodies</td></tr>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>substitute_module</td></tr>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_substitute.c</td></tr></table>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <p><code class="module"><a href="/mod/mod_substitute.html">mod_substitute</a></code> provides a mechanism to perform
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd both regular expression and fixed string substitutions on
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd response bodies.</p>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<div id="quickview"><h3 class="directives">Directives</h3>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<li><img alt="" src="/images/down.gif" /> <a href="#substitute">Substitute</a></li>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<li><img alt="" src="/images/down.gif" /> <a href="#substitutemaxlinelength">SubstituteMaxLineLength</a></li>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<div class="directive-section"><h2><a name="Substitute" id="Substitute">Substitute</a> <a name="substitute" id="substitute">Directive</a></h2>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Pattern to filter the response content</td></tr>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Substitute <var>s/pattern/substitution/[infq]</var></code></td></tr>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_substitute</td></tr>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <p>The <code class="directive">Substitute</code> directive specifies a
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd search and replace pattern to apply to the response body.</p>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <p>The meaning of the pattern can be modified by using any
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd combination of these flags:</p>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <dd>By default the pattern is treated as a regular expression.
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd Using the <code>n</code> flag forces the pattern to be treated
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd as a fixed string.</dd>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <dd>The <code>f</code> flag causes mod_substitute to flatten the
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd result of a substitution allowing for later substitutions to
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd take place on the boundary of this one. This is the default.</dd>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd flatten the buckets after each substitution. This can
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd result in much faster response and a decrease in memory
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd utilization, but should only be used if there is no possibility
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd that the result of one substitution will ever match a pattern
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd or regex of a subsequent one.</dd>
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd <div class="example"><h3>Example</h3><pre class="prettyprint lang-config"><Location "/">
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd</Location></pre>
5effc8b39fae5cd169d17f342bfc265705840014rbowen <p>If either the pattern or the substitution contain a slash
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd character then an alternative delimiter should be used:</p>
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd <div class="example"><h3>Example of using an alternate delimiter</h3><pre class="prettyprint lang-config"><Location "/">
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd Substitute "s|<BR */?>|<br />|i"
282b62d8e9a4edbc2da22ba2d876ec94afc48084nd</Location></pre>
<div class="example"><h3>Example of using backreferences and captures</h3><pre class="prettyprint lang-config"><Location "/">
<div class="example"><h3>Rewriting URLs embedded in proxied content</h3><pre class="prettyprint lang-config">ProxyPass "/blog/" "http://internal.blog.example.com"
ProxyPassReverse "/blog/" "http://internal.blog.example.com/"
<p><code class="directive"><a href="/mod/mod_proxy.html#proxypassreverse">ProxyPassReverse</a></code>
<div class="directive-section"><h2><a name="SubstituteMaxLineLength" id="SubstituteMaxLineLength">SubstituteMaxLineLength</a> <a name="substitutemaxlinelength" id="substitutemaxlinelength">Directive</a></h2>
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set the maximum line size</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>SubstituteMaxLineLength <var>bytes</var>(b|B|k|K|m|M|g|G)</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>SubstituteMaxLineLength 1m</code></td></tr>
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in httpd 2.4.11 and later</td></tr>
<p>The maximum line size handled by <code class="module"><a href="/mod/mod_substitute.html">mod_substitute</a></code>
<p><span>Available Languages: </span><a href="/en/mod/mod_substitute.html" title="English"> en </a></p>
</div><div class="top"><a href="#page-header"><img src="/images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_substitute.html';
if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
d.write('<div id="comments_thread"><\/div>');
var s = d.createElement('script');
s.type = 'text/javascript';
s.async = true;
s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
(d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
<p class="apache">Copyright 2015 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--