apxs - Utilitaire pour les extensions d'Apache

Syntaxe

apxs -g [ -S nom=valeur ] -n nom-module

apxs -q [ -v ] [ -S nom=valeur ] requ�te ...

apxs -c [ -S nom=valeur ] [ -o fichier-dso ] [ -I r�pertoire-inc ] [ -D nom=valeur ] [ -L r�pertoire-lib ] [ -l nom-biblioth�que ] [ -Wc,options-compilation ] [ -Wl,options-edition-liens ] fichiers ...

apxs -i [ -S nom=valeur ] [ -n nom-module ] [ -a ] [ -A ] fichier-dso ...

apxs -e [ -S nom=valeur ] [ -n nom-module ] [ -a ] [ -A ] fichier-dso ...

Options

Options courantes

-n nom-module

D�finit explicitement le nom du module pour les options -i (install) et -g (g�n�ration de mod�les). Utilisez cette option pour sp�cifier de mani�re explicite le nom du module. Pour l'option -g, cette option est n�cessaire ; pour l'option -i, l'utilitaire apxs tente de d�terminer le nom du module � partir des sources, ou (� d�faut) en le d�duisant du nom de fichier.

Options de requ�te

-q

Effectue une requ�te � propos des variables et de l'environnement utilis�s pour compiler httpd. Lorsqu'elle est invoqu�e sans param�tre requ�te, cette option affiche toutes les variables connues, ainsi que leurs valeurs. Le param�tre optionnel -v formate la liste affich�e.

Utilisez cette option pour d�terminer manuellement les options utilis�es pour compiler le binaire httpd qui chargera votre module. Ajoutez par exemple

INC=-I`apxs -q INCLUDEDIR`

dans vos propres Makefiles si vous devez acc�der manuellement aux fichiers d'en-t�tes C d'Apache.

Options de configuration

-S nom=valeur

Cette option permet de modifier la configuration d'apxs d�crite ci-dessus.

Option de g�n�ration des mod�les

-g

Cette option permet de g�n�rer un sous-r�pertoire nom (voir option -n) contenant deux fichiers : le premier fichier est un exemple de fichier source de module nomm� mod_nom.c que l'on peut utiliser comme mod�le pour cr�er ses propres modules, ou comme point de d�part pour se familiariser avec le m�canisme apxs ; le second fichier est le Makefile correspondant facilitant la compilation et l'installation de ce module.

Options de compilation DSO

-c

Cette option indique une op�ration de compilation. Tout d'abord, les fichiers sources (.c) sp�cifi�s par fichiers sont compil�s en fichiers objets correspondants (.o), puis un objet dynamiquement partag� fichier-dso est compil� via une �dition de liens de ces fichiers objets avec les autres fichiers objets (.o and .a) sp�cifi�s par fichiers. Si l'option -o n'est pas sp�cifi�e, le nom du fichier r�sultant est d�duit du premier nom de fichier sp�cifi� par fichiers, et ainsi prend en g�n�ral pour valeur par d�faut mod_nom.so.

-o fichier-dso

Sp�cifie de mani�re explicite le nom de fichier de l'objet partag� dynamiquement cr��. Sans cette option, et si le nom ne peut pas �tre d�duit de la liste fichiers, c'est le nom par d�faut mod_unknown.so qui sera utilis�.

-D nom=valeur

Cette option est transmise directement � la commande de compilation. Vous pouvez l'utiliser pour ajouter vos propres d�finitions au processus de compilation.

-I r�pertoire-inc

Cette option est transmise directement � la commande de compilation. Vous pouvez l'utiliser pour ajouter vos propres chemins de recherche des r�pertoires include au processus de compilation.

-L r�pertoire-lib

Cette option est transmise directement � la commande d'�dition de liens. Vous pouvez l'utiliser pour ajouter vos propres chemins de recherche des r�pertoires de biblioth�ques au processus de compilation.

-l nom-biblioth�que

Cette option est transmise directement � la commande d'�dition de liens. Vous pouvez l'utiliser pour ajouter vos propres biblioth�ques � rechercher au processus de compilation.

-Wc,options-compilation

Cette option transmet les options-compilation en tant qu'options suppl�mentaires � la commande libtool --mode=compile. Vous pouvez l'utiliser pour ajouter des options locales sp�cifiques au compilateur.

-Wl,options-edition-liens

Cette option transmet les options-edition-liens en tant qu'options suppl�mentaires � la commande libtool --mode=link. Vous pouvez l'utiliser pour ajouter des options locales sp�cifiques � l'�diteur de liens.

-p

Avec cette option, apxs effectue l'�dition de liens avec les biblioth�ques apr/apr-util. Elle permet de compiler les programmes helper qui utilisent les biblioth�ques apr/apr-util.

Options d'installation et de configuration DSO

-i

Cette option indique une op�ration d'installation et installe un ou plusieurs objets dynamiquement partag�s dans le r�pertoire modules du serveur.

-a

Cette option active le module en ajoutant automatiquement une directive LoadModule correspondante au fichier de configuration d'Apache apache2.conf, ou en l'activant s'il existe d�j�.

-A

Identique � l'option -a, � la diff�rence que la directive LoadModule cr��e est pr�fix�e par un caract�re di�se (#) ; le module est ainsi pr�par� pour une activation ult�rieure, mais est d�sactiv� dans un premier temps.

-e

Cette option indique une op�ration d'�dition de liens et peut �tre utilis�e avec les options -a et -A de la m�me mani�re qu'au cours de l'op�ration d'installation pour �diter le fichier de configuration d'Apache apache2.conf, sans toutefois installer le module.

Exemples

Supposons que vous disposiez d'un module Apache nomm� mod_foo.c et destin� � �tendre les fonctionnalit�s du serveur. Pour ce faire, vous devez tout d'abord compiler le fichier source C en un objet partag� pouvant �tre charg� dans le serveur Apache � l'ex�cution, via la commande suivante :

Vous devez ensuite v�rifier la configuration d'Apache en vous assurant qu'une directive LoadModule est bien pr�sente pour charger cet objet partag�. Pour simplifier cette �tape, apxs propose une m�thode automatique d'installation de l'objet partag� dans son r�pertoire "modules", et de mise � jour du fichier apache2.conf en cons�quence. Pour b�n�ficier de cette automatisation, utilisez la commande suivante :

Une ligne contenant

est alors ajout�e au fichier de configuration si ce n'est pas d�j� fait. Si vous voulez que le module soit d�sactiv� par d�faut, utilisez l'option -A comme suit :

Pour un test rapide du m�canisme apxs, vous pouvez cr�er un exemple de mod�le de module Apache, ainsi que le Makefile correspondant via :

Vous pouvez ensuite compiler imm�diatement ce module exemple en objet partag� et le charger dans le serveur Apache :