flags.html.en revision e953a3ed43a5521c980dbd1c1390d14b7f903b85
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-->
<title>Apache mod_rewrite Flags - 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" />
<body id="manual-page"><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.3</p>
<div class="up"><a href="/index.html"><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/">Documentation</a> > <a href="../">Version 2.3</a></div><div id="page-content"><div id="preamble"><h1>Apache mod_rewrite Flags</h1>
<div class="toplang">
<p><span>Available Languages: </span><a href="/en/rewrite/flags.html" title="English"> en </a></p>
</div>
<p>This document discusses the flags which are available to the
<code class="directive"><a href="/mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> directive,
providing more detailed explanations and examples of each.</p>
</div>
<div id="quickview"><ul id="toc"><li><img alt="" src="/images/down.gif" /> <a href="#introduction">Introduction</a></li>
</ul><h3>See also</h3><ul class="seealso"><li><a href="/mod/mod_rewrite.html">Module documentation</a></li><li><a href="rewrite_tech.html">Technical details</a></li><li><a href="rewrite_guide.html">Rewrite Guide - useful examples</a></li><li><a href="rewrite_guide_advanced.html">Advanced Rewrite Guide -
advanced useful examples</a></li></ul></div>
<div class="section">
<h2><a name="introduction" id="introduction">Introduction</a></h2>
<p><code class="directive"><a href="/mod/mod_rewrite.html#rewriterule">RewriteRule</a></code>s can have
their behavior modified by one or more flags. Flags are included in
square brackets at the end of the rule, and multiple flags are separated
by commas.</p>
<div class="example"><p><code>
RewriteRule pattern target [Flag1,Flag2,Flag3]
</code></p></div>
<p>The flags all have a short form, such as <code>CO</code>, as well as
a longer form, such as <code>cookie</code>. Some flags take one or more
arguments. Flags are not case sensitive.</p>
<div class="section">
<h2><a name="flags" id="flags">The flags</a></h2>
<p>Each flag has a long and short form. While it is most common to use
the short form, it is recommended that you familiarize yourself with the
long form, so that you remember what each flag is supposed to do.</p>
<p>Presented here are each of the available flags, along with an example
of how you might use them.</p>
<h3><a name="flag_c" id="flag_c">C|chain</a></h3>
<p>The [C] or [chain] flag indicates that the <code class="directive"><a href="/mod/mod_rewrite.html#rewriterule">RewriteRule</a></code> is chained to the next
rule. That is, if the rule matches, then it is processed as usual and
control moves on to the next rule. However, if it does not match, then
the next rule, and any other rules that are chained together, will be
skipped.</p>
<h3><a name="flag_co" id="flag_co">CO|cookie</a></h3>
<p>The [CO], or [cookie] flag, allows you to set a cookie when a
particular <code class="directive"><a href="/mod/mod_rewrite.html#rewriterule">RewriteRule</a></code>
matches. The argument consists of three required fields and two optional
fields.</p>
<p>You must declare a name and value for the cookie to be set, and the
domain for which you wish the cookie to be valid. You may optionally set
the lifetime of the cookie, and the path for which it should be
returned.</p>
<p>By default, the lifetime of the cookie is the current browser
session.</p>
<p>By default, the path for which the cookie will be valid is "/" - that
is, the entire website.</p>
<p>Several examples are offered here:</p>
<div class="example"><p><code>
RewriteEngine On<br />
RewriteRule ^/index.html - [CO=frontdoor=yes:.apache.org:1440:/]
</code></p></div>
<p>This rule doesn't rewrite the request (the "-" rewrite target tells
mod_rewrite to pass the request through unchanged) but sets a cookie
called 'frontdoor' to a value of 'yes'. The cookie is valid for any host
minutes (24 hours) and will be returned for all URIs.</p>
<h3><a name="flag_e" id="flag_e">E|env</a></h3>
<p>With the [E], or [env] flag, you can set the value of an environment
variable. Note that some environment variables may be set after the rule
is run, thus unsetting what you have set. See <a href="/env.html">the
Environment Variables document</a> for more details on how Environment
variables work.</p>
<p>The following example sets an evironment variable called 'image' to a
value of '1' if the requested URI is an image file. Then, that
environment variable is used to exclude those requests from the access
log.</p>
<div class="example"><p><code>
RewriteRule %{REQUEST_URI} \.(png|gif|jpg) - [E=image:1]<br />
CustomLog logs/access_log combined env=!image
</code></p></div>
<p>Note that this same effect can be obtained using <code class="directive"><a href="/mod/mod_setenvif.html#setenvif">SetEnvIf</a></code>. This technique is offered as
an example, not as a recommendation.</p>
<h3><a name="flag_f" id="flag_f">F|forbidden</a></h3>
<p>Forbidden flag</p>
<h3><a name="flag_g" id="flag_g">G|gone</a></h3>
<p>Gone flag</p>
<h3><a name="flag_h" id="flag_h">H|handler</a></h3>
<p>Handler flag</p>
<h3><a name="flag_l" id="flag_l">L|last</a></h3>
<p>Last flag</p>
<h3><a name="flag_n" id="flag_n">N|next</a></h3>
<p>Next round flag</p>
<h3><a name="flag_nc" id="flag_nc">NC|nocase</a></h3>
<p>No case flag</p>
<h3><a name="flag_ne" id="flag_ne">NE|noescape</a></h3>
<p>No escape flag</p>
<h3><a name="flag_ns" id="flag_ns">NS|nosubreq</a></h3>
<p>No internal subrequest flag</p>
<h3><a name="flag_p" id="flag_p">P|proxy</a></h3>
<p>Proxy flag</p>
<h3><a name="flag_pt" id="flag_pt">PT|passthrough</a></h3>
<p>Passthrough flag</p>
<h3><a name="flag_pt" id="flag_pt">PT|passthrough</a></h3>
<p>Passthrough flag</p>
<h3><a name="flag_qsa" id="flag_qsa">QSA|qsappend</a></h3>
<p>Query String Append flag</p>
<h3><a name="flag_r" id="flag_r">R|redirect</a></h3>
<p>Redirect flag</p>
<h3><a name="flag_s" id="flag_s">S|skip</a></h3>
<p>Skip flag</p>
<h3><a name="flag_t" id="flag_t">T|type</a></h3>
<p>Type flag</p>
</div></div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="/en/rewrite/flags.html" title="English"> en </a></p>
</div><div id="footer">
<p class="apache">Copyright 1995-2006 The Apache Software Foundation or its licensors, as applicable.<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/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div>
</body></html>