granicus.if.org Git - apache/blob - docs/manual/mod/mod_macro.html.en

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