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_macro - 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.min.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.4</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.4</a> > <a href="./">Modules</a></div> 24<div id="page-content"> 25<div id="preamble"><h1>Apache Module mod_macro</h1> 26<div class="toplang"> 27<p><span>Available Languages: </span><a href="/en/mod/mod_macro.html" title="English"> en </a> | 28<a href="/fr/mod/mod_macro.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a></p> 29</div> 30<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Provides macros within apache httpd runtime configuration files</td></tr> 31<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr> 32<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>macro_module</td></tr> 33<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_macro.c</td></tr></table> 34<h3>Summary</h3> 35 36 37 <p>Provides macros within Apache httpd runtime configuration files, 38 to ease the process of creating numerous similar configuration 39 blocks. When the server starts up, the macros are expanded using the 40 provided parameters, and the result is processed as along with the 41 rest of the configuration file.</p> 42 43</div> 44<div id="quickview"><h3 class="directives">Directives</h3> 45<ul id="toc"> 46<li><img alt="" src="/images/down.gif" /> <a href="#macro"><Macro></a></li> 47<li><img alt="" src="/images/down.gif" /> <a href="#undefmacro">UndefMacro</a></li> 48<li><img alt="" src="/images/down.gif" /> <a href="#use">Use</a></li> 49</ul> 50<h3>Topics</h3> 51<ul id="topics"> 52<li><img alt="" src="/images/down.gif" /> <a href="#usage">Usage</a></li> 53<li><img alt="" src="/images/down.gif" /> <a href="#tips">Tips</a></li> 54<li><img alt="" src="/images/down.gif" /> <a href="#examples">Examples</a></li> 55</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 56<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 57<div class="section"> 58<h2><a name="usage" id="usage">Usage</a></h2> 59 60<p>Macros are defined using <code class="directive"><Macro></code> blocks, which contain the portion of 61your configuration that needs to be repeated, complete with variables 62for those parts that will need to be substituted.</p> 63 64<p>For example, you might use a macro to define a <code class="directive"><VirtualHost></code> block, in order to define 65multiple similar virtual hosts:</p> 66 67<pre class="prettyprint lang-config"><Macro VHost $name $domain> 68<VirtualHost *:80> 69 ServerName $domain 70 ServerAlias www.$domain 71 72 DocumentRoot /var/www/vhosts/$name 73 ErrorLog /var/log/httpd/$name.error_log 74 CustomLog /var/log/httpd/$name.access_log combined 75</VirtualHost> 76</Macro></pre> 77 78 79<p>Macro names are case-insensitive, like httpd configuration 80directives. However, variable names are case sensitive.</p> 81 82<p>You would then invoke this macro several times to create virtual 83hosts:</p> 84 85<pre class="prettyprint lang-config">Use VHost example example.com 86Use VHost myhost hostname.org 87Use VHost apache apache.org 88 89UndefMacro VHost</pre> 90 91 92<p>At server startup time, each of these <code class="directive">Use</code> 93invocations would be expanded into a full virtualhost, as 94described by the <code class="directive">Macro</code> definition.</p> 95 96<p>The <code class="directive">UndefMacro</code> directive is used so that later 97macros using the same variable names don't result in conflicting 98definitions.</p> 99 100<p>A more elaborate version of this example may be seen below in the 101Examples section.</p> 102 103</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 104<div class="section"> 105<h2><a name="tips" id="tips">Tips</a></h2> 106 107<p>Parameter names should begin with a sigil such as <code>$</code>, 108<code>%</code>, or <code>@</code>, so that they are clearly 109identifiable, and also in order to help deal with interactions with 110other directives, such as the core <code class="directive"><a href="/mod/core.html#define">Define</a></code> directive. Failure to do so will 111result in a warning. Nevertheless, you are encouraged to have a good 112knowledge of your entire server configuration in order to avoid reusing 113the same variables in different scopes, which can cause confusion.</p> 114 115<p>Parameters prefixed with either <code>$</code> or <code>%</code> are 116not escaped. Parameters prefixes with <code>@</code> are escaped in 117quotes.</p> 118 119<p>Avoid using a parameter which contains another parameter as a prefix, 120(For example, <code>$win</code> and <code>$winter</code>) as this may 121cause confusion at expression evaluation time. In the event of such 122confusion, the longest possible parameter name is used.</p> 123 124<p>If you want to use a value within another string, it is useful to 125surround the parameter in braces, to avoid confusion:</p> 126 127<pre class="prettyprint lang-config"><Macro DocRoot ${docroot}> 128 DocumentRoot /var/www/${docroot}/htdocs 129</Macro></pre> 130 131 132</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 133<div class="section"> 134<h2><a name="examples" id="examples">Examples</a></h2> 135 136 137<h3>Virtual Host Definition</h3> 138 139 140<p>A common usage of <code class="module"><a href="/mod/mod_macro.html">mod_macro</a></code> is for the creation of 141dynamically-generated virtual hosts.</p> 142 143<pre class="prettyprint lang-config">## Define a VHost Macro for repetitive configurations 144 145<Macro VHost $host $port $dir> 146 Listen $port 147 <VirtualHost *:$port> 148 149 ServerName $host 150 DocumentRoot $dir 151 152 # Public document root 153 <Directory $dir> 154 Require all granted 155 </Directory> 156 157 # limit access to intranet subdir. 158 <Directory $dir/intranet> 159 Require ip 10.0.0.0/8 160 </Directory> 161 </VirtualHost> 162</Macro> 163 164## Use of VHost with different arguments. 165 166Use VHost www.apache.org 80 /vhosts/apache/htdocs 167Use VHost example.org 8080 /vhosts/example/htdocs 168Use VHost www.example.fr 1234 /vhosts/example.fr/htdocs</pre> 169 170 171 172<h3>Removal of a macro definition</h3> 173 174 175<p>It's recommended that you undefine a macro once you've used it. This 176avoids confusion in a complex configuration file where there may be 177conflicts in variable names.</p> 178 179<pre class="prettyprint lang-config"><Macro DirGroup $dir $group> 180 <Directory $dir> 181 Require group $group 182 </Directory> 183</Macro> 184 185Use DirGroup /www/apache/private private 186Use DirGroup /www/apache/server admin 187 188UndefMacro DirGroup</pre> 189 190 191 192 193</div> 194<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 195<div class="directive-section"><h2><a name="Macro" id="Macro"><Macro></a> <a name="macro" id="macro">Directive</a></h2> 196<table class="directive"> 197<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Define a configuration file macro</td></tr> 198<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code> 199<Macro <var>name</var> [<var>par1</var> .. <var>parN</var>]> 200... </Macro></code></td></tr> 201<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr> 202<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> 203<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_macro</td></tr> 204</table> 205 <p>The <code class="directive">Macro</code> directive controls the definition of 206 a macro within the server runtime configuration files. 207 The first argument is the name of the macro. 208 Other arguments are parameters to the macro. It is good practice to prefix 209 parameter names with any of '<code>$%@</code>', and not macro names 210 with such characters. 211 </p> 212 213 <pre class="prettyprint lang-config"><Macro LocalAccessPolicy> 214 Require ip 10.2.16.0/24 215</Macro> 216 217<Macro RestrictedAccessPolicy $ipnumbers> 218 Require ip $ipnumbers 219</Macro></pre> 220 221 222</div> 223<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 224<div class="directive-section"><h2><a name="UndefMacro" id="UndefMacro">UndefMacro</a> <a name="undefmacro" id="undefmacro">Directive</a></h2> 225<table class="directive"> 226<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Undefine a macro</td></tr> 227<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>UndefMacro <var>name</var></code></td></tr> 228<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr> 229<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> 230<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_macro</td></tr> 231</table> 232 <p>The <code class="directive">UndefMacro</code> directive undefines a macro 233 which has been defined before hand.</p> 234 235 <pre class="prettyprint lang-config">UndefMacro LocalAccessPolicy 236UndefMacro RestrictedAccessPolicy</pre> 237 238 239</div> 240<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 241<div class="directive-section"><h2><a name="Use" id="Use">Use</a> <a name="use" id="use">Directive</a></h2> 242<table class="directive"> 243<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use a macro</td></tr> 244<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Use <var>name</var> [<var>value1</var> ... <var>valueN</var>] 245</code></td></tr> 246<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr> 247<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> 248<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_macro</td></tr> 249</table> 250 <p>The <code class="directive">Use</code> directive controls the use of a macro. 251 The specified macro is expanded. It must be given the same number of 252 arguments as in the macro definition. The provided values are 253 associated to their corresponding initial parameters and are substituted 254 before processing.</p> 255 256 <pre class="prettyprint lang-config">Use LocalAccessPolicy 257... 258Use RestrictedAccessPolicy "192.54.172.0/24 192.54.148.0/24"</pre> 259 260 261 <p>is equivalent, with the macros defined above, to:</p> 262 263 <pre class="prettyprint lang-config">Require ip 10.2.16.0/24 264... 265Require ip 192.54.172.0/24 192.54.148.0/24</pre> 266 267 268</div> 269</div> 270<div class="bottomlang"> 271<p><span>Available Languages: </span><a href="/en/mod/mod_macro.html" title="English"> en </a> | 272<a href="/fr/mod/mod_macro.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a></p> 273</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> 274<script type="text/javascript"><!--//--><![CDATA[//><!-- 275var comments_shortname = 'httpd'; 276var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_macro.html'; 277(function(w, d) { 278 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 279 d.write('<div id="comments_thread"><\/div>'); 280 var s = d.createElement('script'); 281 s.type = 'text/javascript'; 282 s.async = true; 283 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 284 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 285 } 286 else { 287 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 288 } 289})(window, document); 290//--><!]]></script></div><div id="footer"> 291<p class="apache">Copyright 2014 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> 292<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[//><!-- 293if (typeof(prettyPrint) !== 'undefined') { 294 prettyPrint(); 295} 296//--><!]]></script> 297</body></html>
