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" />
6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
7 This file is generated from xml source: DO NOT EDIT
8 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
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">
17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
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="<-" alt="<-" src="../images/left.gif" /></a></div>
25 <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>
26 <div id="page-content">
27 <div id="preamble"><h1>Apache Module mod_macro</h1>
29 <p><span>Available Languages: </span><a href="../en/mod/mod_macro.html" title="English"> en </a> |
30 <a href="../fr/mod/mod_macro.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p>
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>
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>
46 <div id="quickview"><h3>Topics</h3>
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>
53 <li><img alt="" src="../images/down.gif" /> <a href="#macro"><Macro></a></li>
54 <li><img alt="" src="../images/down.gif" /> <a href="#undefmacro">UndefMacro</a></li>
55 <li><img alt="" src="../images/down.gif" /> <a href="#use">Use</a></li>
57 <h3>Bugfix checklist:</h3><ul class="seealso"><li><a href="http://httpd.apache.org/dev/dist/CHANGES_2.4">Httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&list_id=144532&product=Apache%20httpd-2&query_format=specific&order=changeddate%20DESC%2Cpriority%2Cbug_severity">Open bugs</a></li></ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
58 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
60 <h2><a name="usage" id="usage">Usage</a></h2>
62 <p>Macros are defined using <code class="directive"><a href="#macro"><Macro></a></code> blocks, which contain the portion of
63 your configuration that needs to be repeated, complete with variables
64 for those parts that will need to be substituted.</p>
66 <p>For example, you might use a macro to define a <code class="directive"><a href="../mod/core.html#virtualhost"><VirtualHost></a></code> block, in order to define
67 multiple similar virtual hosts:</p>
69 <pre class="prettyprint lang-config"><Macro VHost $name $domain>
70 <VirtualHost *:80>
72 ServerAlias www.$domain
74 DocumentRoot "/var/www/vhosts/$name"
75 ErrorLog "/var/log/httpd/$name.error_log"
76 CustomLog "/var/log/httpd/$name.access_log" combined
81 <p>Macro names are case-insensitive, like httpd configuration
82 directives. However, variable names are case sensitive.</p>
84 <p>You would then invoke this macro several times to create virtual
87 <pre class="prettyprint lang-config">Use VHost example example.com
88 Use VHost myhost hostname.org
89 Use VHost apache apache.org
91 UndefMacro VHost</pre>
94 <p>At server startup time, each of these <code class="directive"><a href="#use">Use</a></code>
95 invocations would be expanded into a full virtualhost, as
96 described by the <code class="directive"><a href="#macro"><Macro></a></code>
99 <p>The <code class="directive"><a href="#undefmacro">UndefMacro</a></code> directive is
100 used so that later macros using the same variable names don't result in
101 conflicting definitions.</p>
103 <p>A more elaborate version of this example may be seen below in the
104 Examples section.</p>
106 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
107 <div class="section">
108 <h2><a name="tips" id="tips">Tips</a></h2>
110 <p>Parameter names should begin with a sigil such as <code>$</code>,
111 <code>%</code>, or <code>@</code>, so that they are clearly
112 identifiable, and also in order to help deal with interactions with
113 other directives, such as the core <code class="directive"><a href="../mod/core.html#define">Define</a></code> directive. Failure to do so will
114 result in a warning. Nevertheless, you are encouraged to have a good
115 knowledge of your entire server configuration in order to avoid reusing
116 the same variables in different scopes, which can cause confusion.</p>
118 <p>Parameters prefixed with either <code>$</code> or <code>%</code> are
119 not escaped. Parameters prefixes with <code>@</code> are escaped in
122 <p>Avoid using a parameter which contains another parameter as a prefix,
123 (For example, <code>$win</code> and <code>$winter</code>) as this may
124 cause confusion at expression evaluation time. In the event of such
125 confusion, the longest possible parameter name is used.</p>
127 <p>If you want to use a value within another string, it is useful to
128 surround the parameter in braces, to avoid confusion:</p>
130 <pre class="prettyprint lang-config"><Macro DocRoot ${docroot}>
131 DocumentRoot "/var/www/${docroot}/htdocs"
135 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
136 <div class="section">
137 <h2><a name="examples" id="examples">Examples</a></h2>
140 <h3>Virtual Host Definition</h3>
143 <p>A common usage of <code class="module"><a href="../mod/mod_macro.html">mod_macro</a></code> is for the creation of
144 dynamically-generated virtual hosts.</p>
146 <pre class="prettyprint lang-config">## Define a VHost Macro for repetitive configurations
148 <Macro VHost $host $port $dir>
150 <VirtualHost *:$port>
155 # Public document root
156 <Directory "$dir">
160 # limit access to intranet subdir.
161 <Directory "$dir/intranet">
162 Require ip 10.0.0.0/8
167 ## Use of VHost with different arguments.
169 Use VHost www.apache.org 80 /vhosts/apache/htdocs
170 Use VHost example.org 8080 /vhosts/example/htdocs
171 Use VHost www.example.fr 1234 /vhosts/example.fr/htdocs</pre>
175 <h3>Removal of a macro definition</h3>
178 <p>It's recommended that you undefine a macro once you've used it. This
179 avoids confusion in a complex configuration file where there may be
180 conflicts in variable names.</p>
182 <pre class="prettyprint lang-config"><Macro DirGroup $dir $group>
183 <Directory "$dir">
188 Use DirGroup /www/apache/private private
189 Use DirGroup /www/apache/server admin
191 UndefMacro DirGroup</pre>
197 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
198 <div class="directive-section"><h2><a name="Macro" id="Macro"><Macro></a> <a name="macro" id="macro">Directive</a></h2>
199 <table class="directive">
200 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Define a configuration file macro</td></tr>
201 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>
202 <Macro <var>name</var> [<var>par1</var> .. <var>parN</var>]>
203 ... </Macro></code></td></tr>
204 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
205 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
206 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_macro</td></tr>
208 <p>The <code class="directive"><Macro></code> directive controls the
209 definition of a macro within the server runtime configuration files.
210 The first argument is the name of the macro.
211 Other arguments are parameters to the macro. It is good practice to prefix
212 parameter names with any of '<code>$%@</code>', and not macro names
213 with such characters.
216 <pre class="prettyprint lang-config"><Macro LocalAccessPolicy>
217 Require ip 10.2.16.0/24
220 <Macro RestrictedAccessPolicy $ipnumbers>
221 Require ip $ipnumbers
226 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
227 <div class="directive-section"><h2><a name="UndefMacro" id="UndefMacro">UndefMacro</a> <a name="undefmacro" id="undefmacro">Directive</a></h2>
228 <table class="directive">
229 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Undefine a macro</td></tr>
230 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>UndefMacro <var>name</var></code></td></tr>
231 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
232 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
233 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_macro</td></tr>
235 <p>The <code class="directive">UndefMacro</code> directive undefines a macro
236 which has been defined before hand.</p>
238 <pre class="prettyprint lang-config">UndefMacro LocalAccessPolicy
239 UndefMacro RestrictedAccessPolicy</pre>
243 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
244 <div class="directive-section"><h2><a name="Use" id="Use">Use</a> <a name="use" id="use">Directive</a></h2>
245 <table class="directive">
246 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Use a macro</td></tr>
247 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Use <var>name</var> [<var>value1</var> ... <var>valueN</var>]
249 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
250 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
251 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_macro</td></tr>
253 <p>The <code class="directive">Use</code> directive controls the use of a macro.
254 The specified macro is expanded. It must be given the same number of
255 arguments as in the macro definition. The provided values are
256 associated to their corresponding initial parameters and are substituted
257 before processing.</p>
259 <pre class="prettyprint lang-config">Use LocalAccessPolicy
261 Use RestrictedAccessPolicy "192.54.172.0/24 192.54.148.0/24"</pre>
264 <p>is equivalent, with the macros defined above, to:</p>
266 <pre class="prettyprint lang-config">Require ip 10.2.16.0/24
268 Require ip 192.54.172.0/24 192.54.148.0/24</pre>
273 <div class="bottomlang">
274 <p><span>Available Languages: </span><a href="../en/mod/mod_macro.html" title="English"> en </a> |
275 <a href="../fr/mod/mod_macro.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p>
276 </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>
277 <script type="text/javascript"><!--//--><![CDATA[//><!--
278 var comments_shortname = 'httpd';
279 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_macro.html';
281 if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
282 d.write('<div id="comments_thread"><\/div>');
283 var s = d.createElement('script');
284 s.type = 'text/javascript';
286 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
287 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
290 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
292 })(window, document);
293 //--><!]]></script></div><div id="footer">
294 <p class="apache">Copyright 2016 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>
295 <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[//><!--
296 if (typeof(prettyPrint) !== 'undefined') {