blob: a5fbc01b07b25f5b9e6a421218d19d86f4603204 [file]
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html lang="fr"><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta content="width=device-width, initial-scale=1" name="viewport">
<!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-->
<title>mod_macro - Serveur HTTP Apache Version 2.5</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">
<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">
<script src="../style/scripts/prettify.min.js">
</script>
<link href="../images/favicon.png" rel="shortcut icon"></head>
<body>
<div id="page-header">
<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="https://cwiki.apache.org/confluence/display/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossaire</a> | <a href="../sitemap.html">Plan du site</a> | <a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2">Signaler un bug</a></p>
<p class="apache">Serveur HTTP Apache Version 2.5</p>
<img alt="" src="../images/feather.png"></div>
<div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif"></a></div>
<div id="path">
<a href="https://www.apache.org/">Apache</a> &gt; <a href="https://httpd.apache.org/">Serveur HTTP</a> &gt; <a href="https://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
<div id="page-content">
<div id="preamble"><h1>Module Apache mod_macro</h1>
<button aria-label="Toggle language list" class="lang-toggle"><svg xmlns="http://www.w3.org/2000/svg" stroke-width="2" stroke="currentColor" fill="none" viewBox="0 0 24 24" height="16" width="16"><circle r="10" cy="12" cx="12"/><line y2="12" x2="22" y1="12" x1="2"/><path d="M12 2a15.3 15.3 0 0 1 4 10 15.3 15.3 0 0 1-4 10 15.3 15.3 0 0 1-4-10 15.3 15.3 0 0 1 4-10z"/></svg></button>
<div class="toplang">
<p><span>Langues Disponibles: </span><a href="../en/mod/mod_macro.html" hreflang="en" rel="alternate" title="English">&nbsp;en&nbsp;</a> |
<a href="../fr/mod/mod_macro.html" title="Fran&ccedil;ais">&nbsp;fr&nbsp;</a></p>
</div>
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Ce module permet d'utiliser des macros dans les fichiers
de configuration Apache.</td></tr>
<tr><th><a href="module-dict.html#Status">Statut:</a></th><td>Base</td></tr>
<tr><th><a href="module-dict.html#ModuleIdentifier">Identificateur&nbsp;de&nbsp;Module:</a></th><td>macro_module</td></tr>
<tr><th><a href="module-dict.html#SourceFile">Fichier&nbsp;Source:</a></th><td>mod_macro.c</td></tr>
<tr><th><a href="module-dict.html#Compatibility">Compatibilit&eacute;:</a></th><td>Disponible &agrave; partir de la version 2.4.5 du serveur HTTP Apache</td></tr></table>
<h3>Sommaire</h3>
<p>Ce module permet d'utiliser des macros dans les fichiers de
configuration &agrave; l'ex&eacute;cution du serveur HTTP Apache afin de faciliter
la cr&eacute;ation de nombreux blocs de configuration similaires. Quand le
serveur d&eacute;marre, les macros sont ex&eacute;cut&eacute;es avec les param&egrave;tres
fournis, et le r&eacute;sultat obtenu est trait&eacute; au m&ecirc;me titre que le reste
du fichier de configuration.</p>
</div>
<div id="quickview"><h3>Sujets</h3>
<ul id="topics">
<li><img alt="" src="../images/down.gif"> <a href="#usage">Utilisation</a></li>
<li><img alt="" src="../images/down.gif"> <a href="#tips">Conseils</a></li>
<li><img alt="" src="../images/down.gif"> <a href="#examples">Exemples</a></li>
</ul><h3 class="directives">Directives</h3>
<ul id="toc">
<li><img alt="" src="../images/down.gif"> <a href="#macro">&lt;Macro&gt;</a></li>
<li><img alt="" src="../images/down.gif"> <a href="#macroignorebadnesting">MacroIgnoreBadNesting</a></li>
<li><img alt="" src="../images/down.gif"> <a href="#macroignoreemptyargs">MacroIgnoreEmptyArgs</a></li>
<li><img alt="" src="../images/down.gif"> <a href="#undefmacro">UndefMacro</a></li>
<li><img alt="" src="../images/down.gif"> <a href="#use">Use</a></li>
</ul>
<h3>Traitement des bugs</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">Journal des modifications de httpd</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">Probl&egrave;mes connus</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_macro">Signaler un bug</a></li></ul></div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif"></a></div>
<div class="section">
<h2 id="usage">Utilisation <a title="Lien permanent" href="#usage" class="permalink">&para;</a></h2>
<p>On d&eacute;finit une macro &agrave; l'aide des blocs <code class="directive"><a href="#macro">&lt;Macro&gt;</a></code> qui contiennent la portion de votre
configuration qui intervient de mani&egrave;re r&eacute;p&eacute;titive, y compris les
variables pour les parties qui devront &ecirc;tre substitu&eacute;es.</p>
<p>Par exemple, vous pouvez utiliser une macro pour d&eacute;finir un bloc
<code class="directive"><a href="../mod/core.html#virtualhost">&lt;VirtualHost&gt;</a></code>, afin de pouvoir
d&eacute;finir de nombreux serveurs virtuels similaires :</p>
<pre class="prettyprint lang-config">&lt;Macro VHost $name $domain&gt;
&lt;VirtualHost *:80&gt;
ServerName $domain
ServerAlias www.$domain
DocumentRoot "/var/www/vhosts/$name"
ErrorLog "/var/log/httpd/$name.error_log"
CustomLog "/var/log/httpd/$name.access_log" combined
&lt;/VirtualHost&gt;
&lt;/Macro&gt;</pre>
<p>Comme les directives de configuration httpd, les noms des macros sont
insensibles &agrave; la casse, &agrave; la diff&eacute;rence des variables qui y sont, elles,
sensibles.</p>
<p>Vous pouvez alors invoquer cette macro autant de fois que vous le
voulez pour cr&eacute;er des serveurs virtuels </p>
<pre class="prettyprint lang-config">Use VHost example example.com
Use VHost myhost hostname.org
Use VHost apache apache.org
UndefMacro VHost</pre>
<p>Au d&eacute;marrage du serveur, chacune de ces invocations
<code class="directive"><a href="#use">Use</a></code> sera remplac&eacute;e par une d&eacute;finition de serveur
virtuel compl&egrave;te, comme d&eacute;crit dans la d&eacute;finition de la
<code class="directive"><a href="#macro">&lt;Macro&gt;</a></code>.</p>
<p>La directive <code class="directive"><a href="#undefmacro">UndefMacro</a></code> permet d'&eacute;viter les
conflits de d&eacute;finitions qui pourraient provenir de l'utilisation
ult&eacute;rieure de macros contenant les m&ecirc;mes noms de variables.</p>
<p>Vous trouverez une version plus &eacute;labor&eacute;e de cet exemple plus loin
dans la section Exemples.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif"></a></div>
<div class="section">
<h2 id="tips">Conseils <a title="Lien permanent" href="#tips" class="permalink">&para;</a></h2>
<p>Les noms de param&egrave;tres doivent commencer par un sigil tel que
<code>$</code>, <code>%</code>, ou <code>@</code>, de fa&ccedil;on &agrave; ce qu'ils
soient clairement identifiables, mais aussi afin de faciliter les
interactions avec les autres directives, comme la directive de base
<code class="directive"><a href="../mod/core.html#define">Define</a></code>. Dans le cas contraire, vous
recevrez un avertissement. En tout &eacute;tat de cause, il est conseill&eacute;
d'avoir une bonne connaissance globale de la configuration du serveur,
afin d'&eacute;viter la r&eacute;utilisation des m&ecirc;mes variables &agrave; diff&eacute;rents niveaux,
ce qui peut &ecirc;tre &agrave; l'origine de confusions.</p>
<p>Les param&egrave;tres pr&eacute;fix&eacute;s par <code>$</code> ou <code>%</code> ne sont
pas &eacute;chapp&eacute;s. Les param&egrave;tres pr&eacute;fix&eacute;s par <code>@</code> sont &eacute;chapp&eacute;s
entre guillemets.</p>
<p>Evitez de pr&eacute;fixer un param&egrave;tre par le nom d'un autre param&egrave;tre (par
exemple, pr&eacute;sence simultan&eacute;e des param&egrave;tres <code>$win</code> et
<code>$winter</code>), car ceci peut introduire de la confusion lors de
l'&eacute;valuation des expressions. Si cela se produit, c'est le nom de
param&egrave;tre le plus long possible qui sera utilis&eacute;.</p>
<p>Si vous d&eacute;sirez ins&eacute;rer une valeur dans une cha&icirc;ne, il est conseill&eacute;
de l'entourer de parenth&egrave;ses afin d'&eacute;viter toute confusion. Plut&ocirc;t que
d&rsquo;utiliser la syntaxe <code>${...}</code>, il est pr&eacute;f&eacute;rable d&rsquo;utiliser la
syntaxe <code>$(...)</code>, car la premi&egrave;re entre en conflit avec la syntaxe
des variables de <code class="directive"><a href="../mod/core.html#define">Define</a></code>&nbsp;:</p>
<pre class="prettyprint lang-config">&lt;Macro DocRoot $(docroot)&gt;
DocumentRoot "/var/www/$(docroot)/htdocs"
&lt;/Macro&gt;</pre>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif"></a></div>
<div class="section">
<h2 id="examples">Exemples <a title="Lien permanent" href="#examples" class="permalink">&para;</a></h2>
<h3>D&eacute;finition de serveurs virtuels</h3>
<p>Un exemple typique d'utilisation de <code class="module"><a href="../mod/mod_macro.html">mod_macro</a></code> est la
cr&eacute;ation dynamique de serveurs virtuels.</p>
<pre class="prettyprint lang-config">## D&eacute;finition d'une macro VHost pour les configurations r&eacute;p&eacute;titives
&lt;Macro VHost $host $port $dir&gt;
Listen $port
&lt;VirtualHost *:$port&gt;
ServerName $host
DocumentRoot "$dir"
# Racine des documents publique
&lt;Directory "$dir"&gt;
Require all granted
&lt;/Directory&gt;
# restriction d'acc&egrave;s au sous-r&eacute;pertoire intranet.
&lt;Directory "$dir/intranet"&gt;
Require ip 10.0.0.0/8
&lt;/Directory&gt;
&lt;/VirtualHost&gt;
&lt;/Macro&gt;
## Utilisation de la macro VHost avec diff&eacute;rents arguments.
Use VHost www.apache.org 80 /vhosts/apache/htdocs
Use VHost example.org 8080 /vhosts/example/htdocs
Use VHost www.example.fr 1234 /vhosts/example.fr/htdocs</pre>
<h3>Suppression d'une d&eacute;finition de macro</h3>
<p>Il est recommand&eacute; de supprimer la d&eacute;finition d'une macro apr&egrave;s
l'avoir utilis&eacute;e. Ceci permet d'&eacute;viter les confusions au sein d'un
fichier de configuration complexe o&ugrave; des conflits entre noms de
variables peuvent survenir.</p>
<pre class="prettyprint lang-config">&lt;Macro DirGroup $dir $group&gt;
&lt;Directory "$dir"&gt;
Require group $group
&lt;/Directory&gt;
&lt;/Macro&gt;
Use DirGroup /www/apache/private private
Use DirGroup /www/apache/server admin
UndefMacro DirGroup</pre>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif"></a></div>
<div class="directive-section"><h2 id="macro">Directive <span id="Macro">&lt;Macro&gt;</span> <a title="Lien permanent" href="#macro" class="permalink">&para;</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>D&eacute;finition d'une macro dans un fichier de configuration</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>
&lt;Macro <var>nom</var> [<var>par1</var> .. <var>parN</var>]&gt;
... &lt;/Macro&gt;</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration globale, serveur virtuel, r&eacute;pertoire</td></tr>
<tr><th><a href="directive-dict.html#Override">Surcharges autoris&eacute;es:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Statut:</a></th><td>Base</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_macro</td></tr>
</table>
<p>La directive <code class="directive">&lt;Macro&gt;</code> permet de d&eacute;finir une macro
dans un fichier de configuration Apache. Le premier argument est le nom
de la macro, et les arguments suivants sont les param&egrave;tres. Il
est de bon aloi de pr&eacute;fixer les noms des param&egrave;tres d'une macro
avec un caract&egrave;re parmi '<code>$%@</code>', et d'&eacute;viter d'en faire
de m&ecirc;me avec les noms de macros.
</p>
<pre class="prettyprint lang-config">&lt;Macro LocalAccessPolicy&gt;
Require ip 10.2.16.0/24
&lt;/Macro&gt;
&lt;Macro RestrictedAccessPolicy $ipnumbers&gt;
Require ip $ipnumbers
&lt;/Macro&gt;</pre>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif"></a></div>
<div class="directive-section"><h2 id="macroignorebadnesting">Directive <span id="MacroIgnoreBadNesting">MacroIgnoreBadNesting</span> <a title="Lien permanent" href="#macroignorebadnesting" class="permalink">&para;</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Ignore les avertissements et n'inscrit rien dans le journal &agrave;
propos d'une imbrication de Macros non conforme</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>MacroIgnoreBadNesting</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration globale, serveur virtuel, r&eacute;pertoire</td></tr>
<tr><th><a href="directive-dict.html#Override">Surcharges autoris&eacute;es:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Statut:</a></th><td>Base</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_macro</td></tr>
</table>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif"></a></div>
<div class="directive-section"><h2 id="macroignoreemptyargs">Directive <span id="MacroIgnoreEmptyArgs">MacroIgnoreEmptyArgs</span> <a title="Lien permanent" href="#macroignoreemptyargs" class="permalink">&para;</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Ignore les avertissements et n'inscrit rien dans le journal &agrave;
propos des arguments de Macro vides</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>MacroIgnoreEmptyArgs</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration globale, serveur virtuel, r&eacute;pertoire</td></tr>
<tr><th><a href="directive-dict.html#Override">Surcharges autoris&eacute;es:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Statut:</a></th><td>Base</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_macro</td></tr>
</table>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif"></a></div>
<div class="directive-section"><h2 id="undefmacro">Directive <span id="UndefMacro">UndefMacro</span> <a title="Lien permanent" href="#undefmacro" class="permalink">&para;</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Supprime une macro</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>UndefMacro <var>nom</var></code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration globale, serveur virtuel, r&eacute;pertoire</td></tr>
<tr><th><a href="directive-dict.html#Override">Surcharges autoris&eacute;es:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Statut:</a></th><td>Base</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_macro</td></tr>
</table>
<p>La directive <code class="directive">UndefMacro</code> annule la d&eacute;finition
d'une macro qui doit avoir &eacute;t&eacute; d&eacute;finie auparavant.</p>
<pre class="prettyprint lang-config">UndefMacro LocalAccessPolicy
UndefMacro RestrictedAccessPolicy</pre>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif"></a></div>
<div class="directive-section"><h2 id="use">Directive <span id="Use">Use</span> <a title="Lien permanent" href="#use" class="permalink">&para;</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Utilisation d'une macro</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>Use <var>nom</var> [<var>valeur1</var> ... <var>valeurN</var>]
</code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration globale, serveur virtuel, r&eacute;pertoire</td></tr>
<tr><th><a href="directive-dict.html#Override">Surcharges autoris&eacute;es:</a></th><td>All</td></tr>
<tr><th><a href="directive-dict.html#Status">Statut:</a></th><td>Base</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_macro</td></tr>
</table>
<p> La directive <code class="directive">Use</code> permet d'utiliser une macro.
La macro consid&eacute;r&eacute;e est expans&eacute;e. Son nombre d'arguments doit &ecirc;tre &eacute;gal au
nombre de param&egrave;tres pr&eacute;cis&eacute;s dans sa d&eacute;finition. Les valeurs pass&eacute;es en
argument sont attribu&eacute;es aux param&egrave;tres correspondants et
substitu&eacute;es avant l'interpr&eacute;tation du texte de la macro.</p>
<pre class="prettyprint lang-config">Use LocalAccessPolicy
...
Use RestrictedAccessPolicy "192.54.172.0/24 192.54.148.0/24"</pre>
<p>est &eacute;quivalent, avec les macros d&eacute;finies ci-dessus &agrave; :</p>
<pre class="prettyprint lang-config">Require ip 10.2.16.0/24
...
Require ip 192.54.172.0/24 192.54.148.0/24</pre>
</div>
</div>
<div class="bottomlang">
<p><span>Langues Disponibles: </span><a href="../en/mod/mod_macro.html" hreflang="en" rel="alternate" title="English">&nbsp;en&nbsp;</a> |
<a href="../fr/mod/mod_macro.html" title="Fran&ccedil;ais">&nbsp;fr&nbsp;</a></p>
</div><div id="footer">
<p class="apache">Copyright 2026 The Apache Software Foundation.<br>Autoris&eacute; sous <a href="https://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/quickreference.html">Directives</a> | <a href="https://cwiki.apache.org/confluence/display/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossaire</a> | <a href="../sitemap.html">Plan du site</a> | <a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2">Signaler un bug</a></p></div><script><!--//--><![CDATA[//><!--
if (typeof(prettyPrint) !== 'undefined') {
prettyPrint();
}
var langToggle = document.querySelector('.lang-toggle');
var topLang = document.querySelector('.toplang');
if (langToggle && topLang) {
langToggle.addEventListener('click', function() { topLang.classList.toggle('open'); });
}
var qv = document.getElementById('quickview');
if (qv) {
document.body.appendChild(qv);
var qvBtn = document.createElement('button');
qvBtn.className = 'qv-toggle';
qvBtn.setAttribute('aria-label', 'Toggle page navigation');
qvBtn.innerHTML = '&#9776;';
document.body.appendChild(qvBtn);
qvBtn.addEventListener('click', function() {
var isOpen = qv.classList.toggle('open');
if (isOpen) {
qv.style.top = window.scrollY + 10 + 'px';
}
});
window.addEventListener('scroll', function() { qv.classList.remove('open'); });
}
//--><!]]></script>
</body></html>