<?xml version="1.0" encoding="iso-8859-15" standalone="no"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ <!ENTITY % aptent SYSTEM "apt.ent.fr"> %aptent; ]> <refentry lang="fr"> <refentryinfo> &apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <!-- The last update date --> <date>29 F�vrier 2004</date> </refentryinfo> <refmeta> <refentrytitle>apt-ftparchive</refentrytitle> <manvolnum>1</manvolnum> </refmeta> <refnamediv><refname>apt-ftparchive</refname> <refpurpose>Un outil pour cr�er des index </refpurpose> </refnamediv> <refsynopsisdiv> <cmdsynopsis> <command>apt-ftparchive</command> <arg><option>-hvdsq</option></arg><arg> <option>--md5</option></arg><arg> <option>--delink</option></arg> <arg><option>--readonly</option></arg> <arg><option>--contents</option></arg> <arg><option>-o=<replaceable>option de configuration</replaceable></option></arg> <arg><option>-c=<replaceable>fichier</replaceable></option></arg> <group choice="req"> <arg>packages<arg choice="plain" rep="repeat"><replaceable>chemin</replaceable></arg><arg><replaceable>override</replaceable><arg><replaceable>pr�fixe-de-chemin</replaceable></arg></arg></arg> <arg>sources<arg choice="plain" rep="repeat"><replaceable>chemin</replaceable></arg><arg><replaceable>override</replaceable><arg><replaceable>pr�fixe-de-chemin</replaceable></arg></arg></arg> <arg>contents <arg choice="plain"><replaceable>chemin</replaceable></arg></arg> <arg>release <arg choice="plain"><replaceable>chemin</replaceable></arg></arg> <arg>generate <arg choice="plain"><replaceable>fichier-de-configuration</replaceable></arg><arg choice="plain" rep="repeat"><replaceable>section</replaceable></arg></arg> <arg>clean <arg choice="plain"><replaceable>fichier-de-configuration</replaceable></arg></arg> </group> </cmdsynopsis> </refsynopsisdiv> <refsect1><title>Description</title> <para> <command>apt-ftparchive</command> est l'outil en ligne de commande qui cr�e les index dont APT se sert pour acc�der aux sources des distributions. Un index doit �tre cr�� pour un site et bas� sur le contenu de ce site. </para> <para><command>apt-ftparchive</command> est un ensemble comprenant le programme &dpkg-scanpackages; et toutes ses fonctionnalit�s via la commande <literal>packages</literal> ; il comprend aussi un g�n�rateur de fichier � Contents �, la commande <literal>contents</literal>, et une technique �labor�e pour � scripter � le processus de cr�ation d'une archive compl�te. </para> <para> <command>Apt-ftparchive</command> peut utiliser lui-m�me des bases de donn�es binaires pour � cacher � le contenu d'un fichier .deb ; il n'a pas besoin de programmes ext�rieurs, sauf &gzip;. Lors d'une ex�cution, il v�rifie les changements dans les fichiers et cr�e les fichiers compress�s voulus. </para> <para> � moins que l'option <option>-h</option> ou <option>--help</option> ne soit donn�e, l'une des commandes suivantes doit �tre pr�sente : <variablelist> <varlistentry><term>packages</term> <listitem><para> La commande <literal>packages</literal> cr�e un fichier � Packages � � partir d'une arborescence. Elle recherche r�cursivement � travers le r�pertoire donn� les fichiers .deb et, pour chaque fichier trouv�, envoie une entr�e pour ce paquet sur la sortie standard. Cette commande est approximativement �quivalente � &dpkg-scanpackages;. </para> <para> On peut se servir de l'option <option>--db</option> pour demander un cache binaire. </para></listitem> </varlistentry> <varlistentry><term>sources</term> <listitem><para> La commande <literal>sources</literal> cr�e un index des sources � partir d'une arborescence. Elle recherche r�cursivement � travers le r�pertoire donn� les fichiers .dsc et, pour chaque fichier trouv�, envoie une entr�e pour ce paquet sur la sortie standard. Cette commande est approximativement �quivalente � &dpkg-scansources;. </para> <para> Quand on pr�cise un fichier � override �, c'est un fichier source avec une extension .src qui est recherch�. On peut se servir de l'option <option>--source-override</option> pour changer de fichier source d'� override �. </para></listitem> </varlistentry> <varlistentry><term>contents</term> <listitem><para> La commande <literal>contents</literal> cr�e un fichier � Contents � � partir d'une arborescence. Elle recherche r�cursivement � travers le r�pertoire donn� les fichiers .deb et, pour chaque fichier trouv�, lit la liste des fichiers. Elle trie la liste des fichiers correspondant � des paquets et l'envoie sur la sortie standard. Les r�pertoires ne font pas partie du r�sultat. Quand un fichier appartient � plusieurs paquets, une virgule s�pare les paquets. </para> <para>On peut se servir de l'option <option>--db</option> pour demander un cache binaire. </para></listitem> </varlistentry> <varlistentry><term>release</term> <listitem><para> La commande <literal>release</literal> cr�e un fichier Releases � partir d'un r�pertoire. Elle cherche r�cursivement dans ce r�pertoire les fichiers Packages, Packages.gz, Packages.bz2, Sources, Sources.gz, Sources.bz2, Release et md5sum.txt. Elle envoie alors un fichier Release sur la sortie standard avec un r�sum� MD5 et un r�sum� SHA1 pour chaque fichier. </para> <para> La valeur des autres champs du fichier Release est tir�e de la valeur correspondante dans <literal>APT::FTPArchive::Release</literal>, p. ex. <literal>APT::FTPArchive::Release::Origin</literal>. Les champs reconnus sont : <literal>Origin</literal>, <literal>Label</literal>, <literal>Suite</literal>, <literal>Version</literal>, <literal>Codename</literal>, <literal>Date</literal>, <literal>Architectures</literal>, <literal>Components</literal>, <literal>Description</literal>. </para></listitem> </varlistentry> <varlistentry><term>generate</term> <listitem><para> La commande <literal>generate</literal> est con�ue pour �tre ex�cutable par le programme cron et elle cr�e un index en suivant le fichier de configuration donn�. Le langage de configuration fournit un moyen souple de pr�ciser index et r�pertoires aussi bien que les param�tres requis. </para></listitem> </varlistentry> <varlistentry><term>clean</term> <listitem><para> La commande <literal>clean</literal> range les bases de donn�es utilis�es par le fichier de configuration en supprimant les enregistrements qui ne sont plus n�cessaires. </para></listitem> </varlistentry> </variablelist> </para> </refsect1> <refsect1><title>Configuration de la commande generate</title> <para> La commande <literal>generate</literal> utilise un fichier de configuration pour d�crire l'archive qui va �tre cr��e. Le format de ce fichier est le format ISC classique utilis� par des outils ISC comme bind 8 et dhcpd. Le fichier &apt-conf; d�crit ce format. Il faut noter que l'analyse de ce fichier se fait par section tandis que celle d'&apt-conf; se fait par arborescence. Cela n'affecte que l'usage de l'�tiquette de vis�e (scope tag). </para> <para> Ce fichier de configuration poss�de quatre sections, d�crites ci-dessous. </para> <refsect2><title>La section Dir</title> <para> La section <literal>Dir</literal> d�finit les r�pertoires standards o� situer les fichiers n�cessaires au processus de cr�ation. Ces r�pertoires sont pr�c�d�s de chemins relatifs d�finis dans les sections suivantes de mani�re � produire un chemin absolu et complet. </para> <variablelist> <varlistentry><term>ArchiveDir</term> <listitem><para> Indique la racine de l'archive FTP ; Pour une configuration Debian classique, c'est le r�pertoire qui contient le fichier <filename>ls-LR</filename> et les noeuds des distributions. </para></listitem> </varlistentry> <varlistentry><term>OverrideDir</term> <listitem><para> Indique l'emplacement des fichiers d'� override �. </para></listitem> </varlistentry> <varlistentry><term>CacheDir</term> <listitem><para> Indique l'emplacement des fichiers de cache. </para></listitem> </varlistentry> <varlistentry><term>FileListDir</term> <listitem><para> Indique l'emplacement des fichiers contenant la liste des fichiers (si on se sert de la valeur <literal>FileList</literal> d�finie plus bas). </para></listitem> </varlistentry> </variablelist> </refsect2> <refsect2><title>La section Default</title> <para> La section <literal>Default</literal> pr�cise les valeurs par d�faut et les param�tres qui contr�lent la marche du g�n�rateur. Ces valeurs peuvent �tre annul�es dans d'autres sections (param�trage par section). </para> <variablelist> <varlistentry><term>Packages::Compress</term> <listitem><para> Indique comment sont compress�s les fichiers d'index. C'est une cha�ne qui contient des valeurs s�par�es par des espaces ; elle contient au moins l'une des valeurs suivantes : � . � (pas de compression), � gzip �, � bzip2 �. Par d�faut, c'est la cha�ne � . gzip �. </para></listitem> </varlistentry> <varlistentry><term>Packages::Extensions</term> <listitem><para> Indique la liste par d�faut des extensions de fichier qui constituent des paquets. Par d�faut, c'est � .deb �. </para></listitem> </varlistentry> <varlistentry><term>Sources::Compress</term> <listitem><para> Identique � <literal>Packages::Compress</literal> mais pr�cise comment sont compress�s les fichiers sources. </para></listitem> </varlistentry> <varlistentry><term>Sources::Extensions</term> <listitem><para> Indique la liste par d�faut des extensions de fichier qui constituent des fichiers sources. Par d�faut, c'est � .dsc �. </para></listitem> </varlistentry> <varlistentry><term>Contents::Compress</term> <listitem><para> Identique � <literal>Packages::Compress</literal> mais pr�cise comment sont compress�s les fichiers � Contents �. </para></listitem> </varlistentry> <varlistentry><term>DeLinkLimit</term> <listitem><para> Indique le nombre de kilooctets � d�lier (et � remplacer par des liens en dur) pour chaque ex�cution. On s'en sert, pour chaque section, avec le param�tre <literal>External-Links</literal>. </para></listitem> </varlistentry> <varlistentry><term>FileMode</term> <listitem><para> Indique le syst�me de permissions des fichiers d'index cr��s. Par d�faut, c'est le mode 0644. Tous les fichiers d'index ont ce mode et le masque utilisateur (umasq) est ignor�. </para></listitem> </varlistentry> </variablelist> </refsect2> <refsect2><title>La section TreeDefault</title> <para> On indique les valeurs par d�faut particuli�res � la section <literal>Tree</literal>. Toutes ces variables sont des variables de substitution ; les cha�nes $(DIST), $(SECTION) et $(ARCH) sont remplac�es par leur valeur respective. </para> <variablelist> <varlistentry><term>MaxContentsChange</term> <listitem><para> Indique le nombre de kilooctets de fichiers � Contents � qui sont cr��s chaque jour. Les fichiers � Contents � sont tir�s au sort selon le syst�me <emphasis>round-robin</emphasis> de mani�re que, sur plusieurs jours, tous soient reconstruits. </para></listitem> </varlistentry> <varlistentry><term>ContentsAge</term> <listitem><para> Contr�le le nombre de jours pendant lequel un fichier � Contents � peut �tre utilis� sans actualisation. Quand cette limite est franchie, le � mtime � du fichier � Contents � est mis � jour. Cela peut arriver quand un fichier est modifi� sans que cela modifie le fichier � Contents � (modification par � override � par exemple). Un d�lai est permis dans l'espoir que de nouveaux � .deb � seront install�s, exigeant un nouveau � Contents �. Par d�faut ce nombre vaut 10, l'unit� �tant le jour. </para></listitem> </varlistentry> <varlistentry><term>Directory</term> <listitem><para> Indique la racine de l'arborescence des � .deb �. Par d�faut, c'est <filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</filename>. </para></listitem> </varlistentry> <varlistentry><term>SrcDirectory</term> <listitem><para> Indique la racine de l'arborescence des paquets source. Par d�faut, c'est <filename>$(DIST)/$(SECTION)/source/</filename>. </para></listitem> </varlistentry> <varlistentry><term>Packages</term> <listitem><para> Indique le fichier � Packages � cr��. Par d�faut, c'est <filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</filename>. </para></listitem> </varlistentry> <varlistentry><term>Sources</term> <listitem><para> Indique le fichier � Packages � cr�e. Par d�faut, c'est <filename>$(DIST)/$(SECTION)/source/Sources</filename>. </para></listitem> </varlistentry> <varlistentry><term>InternalPrefix</term> <listitem><para>Indique un pr�fixe de chemin ; ce pr�fixe fait qu'un lien symbolique sera consid�r� comme un lien interne plut�t que comme un lien externe. Par d�faut, c'est <filename>$(DIST)/$(SECTION)/</filename>. </para></listitem> </varlistentry> <varlistentry><term>Contents</term> <listitem><para> Indique le fichier � Contents � cr��. Par d�faut, c'est <filename>$(DIST)/Contents-$(ARCH)</filename>. Quand le param�trage fait que diff�rents fichiers � Packages � se r�f�rent � un seul fichier � Contents �, <command>apt-ftparchive</command> les int�gre automatiquement. </para></listitem> </varlistentry> <varlistentry><term>Contents::Header</term> <listitem><para> Indique l'en-t�te � pr�fixer au fichier � Contents � cr��. </para></listitem> </varlistentry> <varlistentry><term>BinCacheDB</term> <listitem><para> Indique la base de donn�es binaire servant de cache pour cette section. Diff�rentes sections peuvent partager cette base de donn�es. </para></listitem> </varlistentry> <varlistentry><term>FileList</term> <listitem><para> Indique qu'au lieu de lire l'arborescence, <command>apt-ftparchive</command> doit lire la liste de fichiers dans le fichier donn� en argument. Les noms relatifs sont pr�fix�s par le r�pertoire de l'archive. </para></listitem> </varlistentry> <varlistentry><term>SourceFileList</term> <listitem><para> Indique qu'au lieu de lire l'arborescence, <command>apt-ftparchive</command> doit lire la liste de fichiers dans le fichier donn� en argument. Les noms relatifs sont pr�fix�s par le r�pertoire de l'archive. On s'en sert pour traiter les index de sources. </para></listitem> </varlistentry> </variablelist> </refsect2> <refsect2><title>La section Tree</title> <para> La section <literal>Tree</literal> d�finit une arborescence debian classique avec un r�pertoire de base, diff�rentes sections dans ce r�pertoire et diff�rentes architectures dans chaque section. Le chemin exact est d�fini par la variable de substitution <literal>Directory</literal>. </para> <para> La section <literal>Tree</literal> accepte une �tiquette de vis�e (scope tag) qui d�termine la variable <literal>$(DIST)</literal> et la racine de l'arborescence (le chemin est pr�fix� par <literal>ArchiveDir</literal>). C'est par exemple : <filename>dists/woody</filename>. </para> <para>Tous les param�tres d�finis dans la section <literal>TreeDefault</literal> peuvent s'utiliser dans la section <literal>Tree</literal> ainsi que les trois nouvelles variables suivantes. </para> <para> Quand il ex�cute la section <literal>Tree</literal>, <command>apt-ftparchive</command> agit ainsi : <informalexample><programlisting> for i in Sections do for j in Architectures do Generate for DIST=scope SECTION=i ARCH=j </programlisting></informalexample> </para> <variablelist> <varlistentry><term>Sections</term> <listitem><para> C'est une liste de sections s�par�es par des espaces qui appartiennent � une distribution ; classiquement, on trouve <literal>main contrib non-free</literal>. </para></listitem> </varlistentry> <varlistentry><term>Architectures</term> <listitem><para> C'est une liste de toutes les architectures qui appartiennent � chaque section. L'architecture sp�ciale � source � indique que l'arborescence est une arborescence de sources. </para></listitem> </varlistentry> <varlistentry><term>BinOverride</term> <listitem><para> Indique le fichier binaire d'� override �. Ce fichier contient des informations sur la section, la priorit� et le responsable du paquet. </para></listitem> </varlistentry> <varlistentry><term>SrcOverride</term> <listitem><para> Indique le fichier source d'� override �. Ce fichier contient des informations sur la section. </para></listitem> </varlistentry> <varlistentry><term>ExtraOverride</term> <listitem><para> Indique un autre fichier d'� override � pour les binaires. </para></listitem> </varlistentry> <varlistentry><term>SrcExtraOverride</term> <listitem><para> Indique un autre fichier d'� override � pour les sources. </para></listitem> </varlistentry> </variablelist> </refsect2> <refsect2><title>La section BinDirectory</title> <para> La section <literal>bindirectory</literal> d�finit une arborescence binaire sans structure particuli�re. L'�tiquette de vis�e (scope tag) indique l'emplacement du r�pertoire binaire et le param�trage est identique � celui pour la section <literal>Tree</literal> sans substitution de variables ou au param�trage de <literal>Section</literal><literal>Architecture</literal>. </para> <variablelist> <varlistentry><term>Packages</term> <listitem><para> Indique le fichier � Packages � cr��. </para></listitem> </varlistentry> <varlistentry><term>SrcPackages</term> <listitem><para> Indique le fichier � Sources � cr��. L'un des deux fichiers, <literal>Packages</literal> ou <literal>SrcPackages</literal> est n�cessaire. </para></listitem> </varlistentry> <varlistentry><term>Contents</term> <listitem><para> Indique le fichier � Contents � cr��. </para></listitem> </varlistentry> <varlistentry><term>Binoverride</term> <listitem><para> Indique le fichier d'� override � pour les binaires. </para></listitem> </varlistentry> <varlistentry><term>SrcOverride</term> <listitem><para> Indique le fichier d'� override � pour les sources. </para></listitem> </varlistentry> <varlistentry><term>ExtraOverride</term> <listitem><para> Indique un autre fichier d'� override � pour les binaires. </para></listitem> </varlistentry> <varlistentry><term>SrcExtraOverride</term> <listitem><para> Indique un autre fichier d'� override � pour les sources. </para></listitem> </varlistentry> <varlistentry><term>BinCacheDB</term> <listitem><para> Indique une base de donn�es cache. </para></listitem> </varlistentry> <varlistentry><term>PathPrefix</term> <listitem><para> Ajoute un chemin � tous les chemins cr��s. </para></listitem> </varlistentry> <varlistentry><term>FileList, SourceFileList</term> <listitem><para> Indique le fichier contenant la liste des fichiers. </para></listitem> </varlistentry> </variablelist> </refsect2> </refsect1> <refsect1><title>Le fichier d'� Override � pour les binaires.</title> <para> Le fichier d'� Override � est pleinement compatible avec &dpkg-scanpackages;. Il contient quatre champs s�par�s par des espaces. Le premier est le nom du paquet ; le deuxi�me est la priorit� � donner � ce paquet ; le troisi�me est sa section et le dernier champ est un champ pour changer le nom du responsable de paquet. </para> <para>Le champ du responsable est de cette forme : <literallayout>old [// oldn]* => new</literallayout> ou simplement, <literallayout>new</literallayout> La premi�re forme permet de sp�cifier de vieilles adresses dans une liste (le s�parateur est la double barre oblique). Si l'une de ces deux formes est rencontr�e, la valeur de new remplace la valeur du champ. La deuxi�me forme remplace inconditionnellement le champ. </para> </refsect1> <refsect1><title>Le fichier d'� Override � pour les sources</title> <para> Le fichier d'� Override � est pleinement compatible avec &dpkg-scansources;. Il contient deux champs. Le premier est le nom du paquet source ; le second, sa section. </para> </refsect1> <refsect1><title>Le fichier suppl�mentaire d'� Override �</title> <para> Le fichier suppl�mentaire d'� Override � permet d'ajouter ou de remplacer des �tiquettes sur la sortie. Il poss�de trois colonnes : la premi�re repr�sente le paquet, la seconde est une �tiquette et la troisi�me en fin de ligne est la nouvelle valeur. </para> </refsect1> <refsect1><title>Les options</title> &apt-cmdblurb; <variablelist> <varlistentry><term><option>--md5</option></term> <listitem><para> Cr�er la somme de contr�le MD5. Cette option est activ�e par d�faut. Quand elle est d�sactiv�e, les fichiers d'index n'ont pas les champs MD5Sum l� o� c'est possible. �l�ment de configuration : <literal>APT::FTPArchive::MD5</literal>. </para></listitem> </varlistentry> <varlistentry><term><option>-d</option></term><term><option>--db</option></term> <listitem><para> Utiliser une base de donn�es binaire pour cache. Cela n'a aucun effet sur la commande generate. �l�ment de configuration : <literal>APT::FTPArchive::DB</literal>. </para></listitem> </varlistentry> <varlistentry><term><option>-q</option></term><term><option>--quiet</option></term> <listitem><para> Mode silencieux ; cette commande produit une sortie destin�e � l'enregistrement dans un fichier-journal en omettant les indicateurs de progression. Un plus grand nombre de � q � (2 au plus) produit un plus grand silence. On peut aussi utiliser <option>-q=#</option> pour positionner le niveau de silence, et annuler le fichier de configuration. �l�ment de configuration : <literal>quiet</literal>. </para></listitem> </varlistentry> <varlistentry><term><option>--delink</option></term> <listitem><para> Faire une d�liaison. Si <literal>External-Links</literal> est activ�, cette option permet r�ellement la d�liaison des fichiers. Par d�faut, elle est activ�e mais elle peut �tre d�sactiv�e avec l'option <option>--no-delink</option>. �l�ment de configuration : <literal>APT::FTPArchive::DeLinkAct</literal>. </para></listitem> </varlistentry> <varlistentry><term><option>--contents</option></term> <listitem><para> Permettre la cr�ation d'un fichier � Contents �. Quand cette option est activ�e et que les index sont cr��s sous forme de base de donn�es binaire, la liste des fichiers est aussi extraite et conserv�e dans la base de donn�es pour un usage futur. Avec la commande generate, cette option permet la cr�ation de fichiers � Contents �. Par d�faut, elle est activ�e. �l�ment de configuration : <literal>APT::FTPArchive::Contents</literal>. </para></listitem> </varlistentry> <varlistentry><term><option>-s</option></term><term><option>--source-override</option></term> <listitem><para> Indique le fichier d'� override � � utiliser avec la commande <literal>sources</literal>. �l�ment de configuration : <literal>APT::FTPArchive::SourceOverride</literal>. </para></listitem> </varlistentry><varlistentry><term><option>--readonly</option></term> <listitem><para> N'autoriser que la lecture pour les bases de donn�es de cache. �l�ment de configuration : <literal>APT::FTPArchive::ReadOnlyDB</literal>. </para></listitem> </varlistentry> &apt-commonoptions; </variablelist> </refsect1> <refsect1><title>Voir aussi</title> <para>&apt-conf; </para> </refsect1> <refsect1><title>Diagnostics</title> <para> <command>apt-ftparchive</command> retourne z�ro si tout se passe bien, le nombre d�cimal 100 en cas d'erreur. </para> </refsect1> &manbugs; &traducteur; </refentry>