mod_macro.html.fr revision 63befe0983261d711e62457b380e24ecc3b7b79e
<?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>mod_macro - Serveur Apache HTTP</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>
<body>
<div id="page-header">
<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">Glossaire</a> | <a href="/sitemap.html">Plan du site</a></p>
<p class="apache">Serveur Apache HTTP Version 2.5</p>
<div id="path">
<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">Serveur HTTP</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Modules</a></div>
<div id="page-content">
<div id="preamble"><h1>Module Apache mod_macro</h1>
<div class="toplang">
<p><span>Langues Disponibles: </span><a href="/en/mod/mod_macro.html" hreflang="en" rel="alternate" title="English"> en </a> |
</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#ModuleIdentifier">Identificateur�de�Module:</a></th><td>macro_module</td></tr>
<tr><th><a href="module-dict.html#SourceFile">Fichier�Source:</a></th><td>mod_macro.c</td></tr></table>
<h3>Sommaire</h3>
<p>Ce module permet de d�finir et d'utiliser des macros dans les fichiers
de configuration Apache. Ces macros peuvent avoir des param�tres qui sont
expans�s � l'utilisation (les param�tres sont remplac�s par la valeur
pass�e en argument), et le r�sultat de la substitution est trait�
normalement.</p>
</div>
<div id="quickview"><h3 class="directives">Directives</h3>
<ul id="toc">
</ul>
<h3>Sujets</h3>
<ul id="topics">
</ul><ul class="seealso"><li><a href="#comments_section">Commentaires</a></li></ul></div>
<div class="section">
<h2><a name="features" id="features">Caract�ristiques</a></h2>
<p>D�finition d'une macro :</p>
<ul>
<li> dans une section <Macro> au style conforme � la
syntaxe des fichiers de configuration Apache.</li>
<li> l'utilisateur choisit le nom de la macro et de ses param�tres.</li>
<li> les noms de macro sont insensibles � la casse, comme les directives Apache.</li>
<li> les noms de param�tres sont par contre sensibles � la casse.</li>
<li> les param�tres d'une macro doivent avoir des noms distincts.</li>
<li> il y a une erreur si un param�tre a un nom vide.</li>
<li> la red�finition d'une macro g�n�re un avertissement.</li>
<li> des d�finitions de macros peuvent �tre imbriqu�es les unes dans les autres... (mais dans quel but ?)</li>
<li> les param�tres inutilis�s g�n�rent un avertissement.</li>
<li> les noms de param�tre en pr�fixe les uns des autres g�n�rent un avertissement.</li>
<li> les noms de param�tre non pr�fix�s par un des caract�res '<code>$%@</code>' g�n�rent un
avertissement pour encourager cette bonne pratique.</li>
<li> les diff�rents pr�fixes propos�s permettent de g�rer les interactions
avec d'autres directives comme <code class="directive"><a href="/mod/core.html#define">Define</a></code>.</li>
<li> un conseil : il peut �tre utile d'ajouter des accolades autour du nom d'un
param�tre, par exemple <code>${foo}</code>, de mani�re � ce que le
param�tre puisse �tre utilis� entour� de caract�res,
par exemple <code>bla${foo}bla</code>.</li>
<li> g�n�re un avertissement si le contenu de la macro est vide.</li>
<li> g�n�re un avertissement si le syst�me d�tecte que les sections � l'int�rieur
d'une macro ne sont pas correctement imbriqu�es.</li>
<li> la port�e lexicale des param�tres d'une macro est restreinte au texte
de la macro elle-m�me... en particulier elle n'est pas propag�e aux inclusions.</li>
<li> il n'y a pas de contrainte sur le contenu d'une macro.
<p>Cela signifie que vous pouvez mettre une section perl ou n'importe
quoi d'autre dans une macro. Il n'y a pas d'autre contrainte sur la
structure lexicale et syntaxique de la macro (guillemets, espaces...)
que d'attendre une s�quence de ligne avec �ventuellement des
continuations.</p></li>
</ul>
<p>Utilisation d'une macro:</p>
<ul>
<li> le nombre d'arguments doit �tre coh�rent avec la d�finition.</li>
<li> toutes les occurences des param�tres sont substitu�es par leur valeur.</li>
<li> en cas de conflit, le nom le plus long est choisi.</li>
<li> une r�cursion dans l'expansion d'une macro est d�tect�e et interrompue avec envoi d'un message d'erreur.</li>
<li> si un argument vide est d�tect�, un avertissement est g�n�r�.</li>
<li> le syst�me s'efforce de g�n�rer une description pr�cise de la localisation des erreurs.</li>
<li> les valeurs des param�tres pr�fix�es par <code>$</code> et <code>%</code> ne sont pas �chapp�es.</li>
<li> les valeurs des param�tres pr�fix�es par <code>@</code> sont �chapp�es par des guillemets.</li>
</ul>
<p>Suppression de la d�finition d'une macro :</p>
<ul>
<li> la macro supprim�e doit avoir �t� d�finie auparavant.</li>
</ul>
<pre class="prettyprint lang-config">
<Macro DirGroup $dir $group>
<Directory $dir>
require group $group
</Directory>
</Macro>
UndefMacro DirGroup
</pre>
<div class="section">
<h2><a name="examples" id="examples">Exemples</a></h2>
<p>Un exemple typique d'utilisation de <code class="module"><a href="/mod/mod_macro.html">mod_macro</a></code> est la
cr�ation dynamique de serveurs virtuels.</p>
<pre class="prettyprint lang-config">
## D�finition d'une macro VHost pour les configurations r�p�titives
<Macro VHost $host $port $dir>
Listen $port
<VirtualHost *:$port>
ServerName $host
DocumentRoot $dir
<Directory $dir>
# directives propres au r�pertoire $dir ...
</Directory>
# restriction d'acc�s au sous-r�pertoire intranet.
Require ip 10.0.0.0/8
</Directory>
</VirtualHost>
</Macro>
## Utilisation de la macro VHost avec diff�rents arguments.
</pre>
</div>
<div class="directive-section"><h2><a name="Macro" id="Macro"><Macro></a> <a name="macro" id="macro">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>D�finition d'une macro dans un fichier de configuration</td></tr>
<Macro <var>nom</var> [<var>par1</var> .. <var>parN</var>]>
... </Macro></code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur, serveur virtuel, r�pertoire</td></tr>
</table>
<p>La directive <code class="directive">Macro</code> permet de d�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�tres. Il
est de bon aloi de pr�fixer les noms des param�tres d'une macro
avec un caract�re parmi '<code>$%@</code>', et d'�viter d'en faire
de m�me avec les noms de macros.
</p>
<pre class="prettyprint lang-config">
<Macro LocalAccessPolicy>
</Macro>
<Macro RestrictedAccessPolicy $ipnumbers>
Require ip $ipnumbers
</Macro>
</pre>
</div>
<div class="directive-section"><h2><a name="UndefMacro" id="UndefMacro">UndefMacro</a> <a name="undefmacro" id="undefmacro">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Undefine a macro</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntaxe:</a></th><td><code>UndefMacro <var>name</var></code></td></tr>
<tr><th><a href="directive-dict.html#Context">Contexte:</a></th><td>configuration du serveur, serveur virtuel, r�pertoire</td></tr>
</table><p>La documentation de cette directive
n'a pas encore t traduite. Veuillez vous reporter la version
en langue anglaise.</p></div>
<div class="directive-section"><h2><a name="Use" id="Use">Use</a> <a name="use" id="use">Directive</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 du serveur, serveur virtuel, r�pertoire</td></tr>
</table>
<p> La directive <code class="directive">Use</code> permet d'utiliser une macro.
La macro consid�r�e est expans�e. Son nombre d'arguments doit �tre �gal au
nombre de param�tres pr�cis�s dans sa d�finition. Les valeurs pass�es en
argument sont attribu�es aux param�tres correspondants et
substitu�es avant l'interpr�tation du texte de la macro.</p>
<pre class="prettyprint lang-config">
Use LocalAccessPolicy
...
</pre>
<p>est �quivalent, avec les macros d�finies ci-dessus � :</p>
<pre class="prettyprint lang-config">
...
</pre>
</div>
</div>
<div class="bottomlang">
<p><span>Langues Disponibles: </span><a href="/en/mod/mod_macro.html" hreflang="en" rel="alternate" title="English"> en </a> |
</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">Commentaires</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>
var comments_shortname = 'httpd';
var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_macro.html';
(function(w, d) {
if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
d.write('<div id="comments_thread"><\/div>');
var s = d.createElement('script');
s.type = 'text/javascript';
s.async = true;
s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
(d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
}
else {
d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
}
})(window, document);
//--><!]]></script></div><div id="footer">
<p class="apache">Copyright 2013 The Apache Software Foundation.<br />Autoris� sous <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/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossaire</a> | <a href="/sitemap.html">Plan du site</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
if (typeof(prettyPrint) !== 'undefined') {
prettyPrint();
}
//--><!]]></script>
</body></html>