<?xml version="1.0"?>

<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">

<?xml-stylesheet type="text/xsl" href="/style/manual.fr.xsl"?>

<modulesynopsis metafile="mod_example.xml.meta">

<name>mod_example</name>

<description>Illustration de l'API des modules Apache</description>

<status>Experimental</status>

<sourcefile>mod_example.c</sourcefile>

<identifier>example_module</identifier>

<summary>

<p>Certains fichiers situ&eacute;s dans le r&eacute;pertoire

<code>modules/experimental</code> de l'arborescence de la

distribution d'Apache sont fournis &agrave; titre d'exemples pour ceux qui

souhaitent &eacute;crire des modules qui utilisent l'API d'Apache.</p>

<p>Le fichier principal est <code>mod_example.c</code>, qui

constitue une illustration exhaustive des diff&eacute;rents m&eacute;canismes et

syntaxes d'appels. En aucun cas un module additionnel n'aura &agrave;

inclure des routines pour tous les appels - il n'en n&eacute;cessitera au

contraire qu'un petit nombre !</p>

<p>Le module example fonctionne r&eacute;ellement. Si vous le chargez dans

votre serveur, activez le gestionnaire "example-handler" dans une

section location, et essayez d'acc&eacute;der &agrave; la zone du site web

correspondante, vous verrez s'afficher certaines sorties que le

module example produit au cours des diff&eacute;rents appels.</p>

</summary>

<section id="compiling"><title>Compilation du module example</title>

<p>Pour inclure le module example dans votre serveur, effectuez les

&eacute;tapes suivantes :</p>

<ol>

<li>Ex&eacute;cutez <program>configure</program> avec l'option

<code>--enable-example</code>.</li>

<li>Compilez le serveur (ex&eacute;cutez la commande

"<code>make</code>").</li>

</ol>

<p>Pour ajouter votre propre module :</p>

<ol type="A">

<li><code>cp modules/experimental/mod_example.c

modules/nouveau_module/<em>mod_monexemple.c</em></code></li>

<li>Modifiez le fichier.</li>

<li>Cr&eacute;ez <code>modules/nouveau_module/config.m4</code>.

<ol>

<li>Ajoutez <code>APACHE_MODPATH_INIT(nouveau_module)</code>.</li>

<li>Copiez la ligne APACHE_MODULE contenant "example" depuis

<code>modules/experimental/config.m4</code>.</li>

<li>Remplacez le premier argument "example" par

<em>monexemple</em>.</li>

<li>Remplacez le second argument par une br&egrave;ve description de

votre module. Cette description sera utilis&eacute;e par la commande

<code>configure --help</code>.</li>

<li>Si la compilation de votre module n&eacute;cessite des drapeaux

de compilation C, des drapeaux d'&eacute;dition de liens, ou de

biblioth&egrave;ques suppl&eacute;mentaires, ajoutez les respectivement &agrave;

CFLAGS, LDFLAGS et LIBS. Reportez-vous aux fichiers

<code>config.m4</code> des r&eacute;pertoires des autres modules pour

plus d'exemples.</li>

<li>Ajoutez <code>APACHE_MODPATH_FINISH</code>.</li>

</ol>

</li>

<li>Cr&eacute;ez le fichier

<code>module/nouveau_module/Makefile.in</code>.

Si la compilation de votre module ne n&eacute;cessite pas d'instructions

particuli&egrave;res, ce fichier ne doit contenir que la ligne

<code>include $(top_srcdir)/build/special.mk</code>.</li>

<li>Ex&eacute;cutez /buildconf &agrave; la racine du r&eacute;pertoire.</li>

<li>Compilez le serveur apr&egrave;s avoir ex&eacute;cut&eacute; la commande configure

avec l'option --enable-monexemple.</li>

</ol>

</section>

<section id="using"><title>Utilisation du module

<code>mod_example</code></title>

<p>Pour activer le module example, ajoutez &agrave; votre fichier

<code>httpd.conf</code> un bloc du style :</p>

<highlight language="config">

&lt;Location /example-info&gt;

SetHandler example-handler

&lt;/Location&gt;

</highlight>

<p>Vous pouvez aussi ajouter ce qui suit dans un fichier <a

href="core.html#accessfilename"><code>.htaccess</code></a>, puis

acc&eacute;der au fichier "test.example" &agrave; partir du r&eacute;pertoire

correspondant :</p>

<highlight language="config">

AddHandler example-handler .example

</highlight>

<p>Apr&egrave;s avoir recharg&eacute; la configuration ou red&eacute;marr&eacute; votre serveur,

vous devriez pouvoir acc&eacute;der &agrave; ce fichier et voir s'afficher ce qui

a &eacute;t&eacute; d&eacute;crit plus haut.</p>

</section>

<directivesynopsis>

<name>Example</name>

<description>Directive de d&eacute;monstration pour illustrer l'API des modules

Apache</description>

<syntax>Example</syntax>

<contextlist><context>server config</context>

<context>virtual host</context><context>directory</context>

<context>.htaccess</context></contextlist>

<usage>

<p>La directive <directive>Example</directive> n'a pour fonction que

de d&eacute;finir un drapeau de d&eacute;monstration que le gestionnaire de

contenu du module example va afficher. Elle ne poss&egrave;de aucun

argument. Si vous naviguez vers une URL &agrave; laquelle le gestionnaire

de contenu example s'applique, vous verrez s'afficher les routines

du module, ainsi que l'ordre dans lequel elles ont &eacute;t&eacute; appel&eacute;es pour

servir le document demand&eacute;. On peut observer l'effet de cette

directive dans la phrase "<code>Example

directive declared here: YES/NO</code>".</p>

</usage>

</directivesynopsis>

</modulesynopsis>