1<?xml version="1.0" encoding="ISO-8859-1"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!-- 4 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 5 This file is generated from xml source: DO NOT EDIT 6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 7 --> 8<title>mod_substitute - Apache HTTP Server</title> 9<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> 10<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> 11<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" /> 12<script src="/style/scripts/prettify.js" type="text/javascript"> 13</script> 14 15<link href="/images/favicon.ico" rel="shortcut icon" /></head> 16<body> 17<div id="page-header"> 18<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.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> 19<p class="apache">Apache HTTP Server Version 2.2</p> 20<img alt="" src="/images/feather.gif" /></div> 21<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div> 22<div id="path"> 23<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.2</a> > <a href="./">Modules</a></div> 24<div id="page-content"> 25<div id="preamble"><h1>Apache Module mod_substitute</h1> 26<div class="toplang"> 27<p><span>Available Languages: </span><a href="/en/mod/mod_substitute.html" title="English"> en </a></p> 28</div> 29<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> 30<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr> 31<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>substitute_module</td></tr> 32<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_substitute.c</td></tr> 33<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.2.7 and later</td></tr></table> 34<h3>Summary</h3> 35 36 <p><code class="module"><a href="/mod/mod_substitute.html">mod_substitute</a></code> provides a mechanism to perform 37 both regular expression and fixed string substitutions on 38 response bodies.</p> 39</div> 40<div id="quickview"><h3 class="directives">Directives</h3> 41<ul id="toc"> 42<li><img alt="" src="/images/down.gif" /> <a href="#substitute">Substitute</a></li> 43</ul> 44<ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 45 46<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 47<div class="directive-section"><h2><a name="Substitute" id="Substitute">Substitute</a> <a name="substitute" id="substitute">Directive</a></h2> 48<table class="directive"> 49<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Pattern to filter the response content</td></tr> 50<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Substitute <var>s/pattern/substitution/[infq]</var></code></td></tr> 51<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> 52<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr> 53<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> 54<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_substitute</td></tr> 55</table> 56 <p>The <code class="directive">Substitute</code> directive specifies a 57 search and replace pattern to apply to the response body.</p> 58 59 <p>The meaning of the pattern can be modified by using any 60 combination of these flags:</p> 61 62 <dl> 63 <dt><code>i</code></dt> 64 <dd>Perform a case-insensitive match.</dd> 65 <dt><code>n</code></dt> 66 <dd>By default the pattern is treated as a regular expression. 67 Using the <code>n</code> flag forces the pattern to be treated 68 as a fixed string.</dd> 69 <dt><code>f</code></dt> 70 <dd>The <code>f</code> flag causes mod_substitute to flatten the 71 result of a substitution allowing for later substitutions to 72 take place on the boundary of this one. This is the default.</dd> 73 <dt><code>q</code></dt> 74 <dd>The <code>q</code> flag causes mod_substitute to not 75 flatten the buckets after each substitution. This can 76 result in much faster response and a decrease in memory 77 utilization, but should only be used if there is no possibility 78 that the result of one substitution will ever match a pattern 79 or regex of a subsequent one.</dd> 80 </dl> 81 82 <div class="example"><h3>Example</h3><p><code> 83 <Location /> 84 <span class="indent"> 85 AddOutputFilterByType SUBSTITUTE text/html<br /> 86 Substitute s/foo/bar/ni<br /> 87 </span> 88 </Location> 89 </code></p></div> 90 91 <p>If either the pattern or the substitution contain a slash 92 character then an alternative delimiter should be used:</p> 93 94 <div class="example"><h3>Example of using an alternate delimiter</h3><p><code> 95 <Location /> 96 <span class="indent"> 97 AddOutputFilterByType SUBSTITUTE text/html<br /> 98 Substitute "s|<BR */?>|<br />|i" 99 </span> 100 </Location> 101 </code></p></div> 102 103</div> 104</div> 105<div class="bottomlang"> 106<p><span>Available Languages: </span><a href="/en/mod/mod_substitute.html" title="English"> en </a></p> 107</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> 108<script type="text/javascript"><!--//--><![CDATA[//><!-- 109var comments_shortname = 'httpd'; 110var comments_identifier = 'http://httpd.apache.org/docs/2.2/mod/mod_substitute.html'; 111(function(w, d) { 112 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 113 d.write('<div id="comments_thread"><\/div>'); 114 var s = d.createElement('script'); 115 s.type = 'text/javascript'; 116 s.async = true; 117 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 118 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 119 } 120 else { 121 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 122 } 123})(window, document); 124//--><!]]></script></div><div id="footer"> 125<p class="apache">Copyright 2013 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> 126<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.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[//><!-- 127if (typeof(prettyPrint) !== 'undefined') { 128 prettyPrint(); 129} 130//--><!]]></script> 131</body></html>
