<!-- -*- mode: sgml; mode: fold -*- --> <!-- translation of version 1.4 --> <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [ <!ENTITY % aptent SYSTEM "apt.ent.fr"> %aptent; ]> <refentry lang=fr> &apt-docinfo; <refmeta> <refentrytitle>apt-ftparchive</> <manvolnum>1</> </refmeta> <!-- Man page title --> <refnamediv> <refname>apt-ftparchive</> <refpurpose>Un outil pour cr�er des index </refnamediv> <!-- Arguments --> <refsynopsisdiv> <cmdsynopsis> <command>apt-ftparchive</> <arg><option>-hvdsq</></arg> <arg><option>--md5</></arg> <arg><option>--delink</></arg> <arg><option>--readonly</></arg> <arg><option>--contents</></arg> <arg><option>-o=<replaceable/option de configuration/</></arg> <arg><option>-c=<replaceable/fichier/</></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>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</> <para> <command/apt-ftparchive/ 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> <command/apt-ftparchive/ est un ensemble comprenant le programme &dpkg-scanpackages; et toutes ses fonctionnalit�s via la commande <literal/directory/ ; il comprend aussi un g�n�rateur de fichier � Contents �, la commande <literal/contents/, et une technique �labor�e pour � scripter � le processus de cr�ation d'une archive compl�te. <para> <command/apt-ftparchive/ 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> � moins que l'option <option/-h/ ou <option/--help/ ne soit donn�e, l'une des commandes suivantes doit �tre pr�sente : <VariableList> <VarListEntry><term>packages</term> <ListItem><Para> La commande <literal/packages/ 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 l'enregistrement du paquet sur la sortie standard. Cette commande est approximativement �quivalente � &dpkg-scanpackages;. <para> On peut se servir de l'option <option/--db/ pour demander un cache binaire. </VarListEntry> <VarListEntry><term>sources</term> <ListItem><Para> La commande <literal/sources/ 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 l'enregistrement du paquet sur la sortie standard. Cette commande est approximativement �quivalente � &dpkg-scansources;. <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/ pour changer de fichier source d'� override �. </VarListEntry> <VarListEntry><term>contents</term> <ListItem><Para> La commande <literal/contents/ 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> On peut se servir de l'option <option/--db/ pour demander un cache binaire. </VarListEntry> <VarListEntry><term>generate</term> <ListItem><Para> La commande <literal/generate/ 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. </VarListEntry> <VarListEntry><term>clean</term> <ListItem><Para> La commande <literal/clean/ range les bases de donn�es utilis�es par le fichier de configuration en supprimant les enregistrements qui ne sont plus n�cessaires. </VarListEntry> </VariableList> </RefSect1> <RefSect1><Title>Configuration de la commande generate</> <para> La commande <literal/generate/ 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. &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> Ce fichier de configuration poss�de quatre sections, d�crites ci-dessous. <refsect2><title>La section Dir</> <Para> La section <literal/Dir/ 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. <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/, et les noeuds des distributions. </VarListEntry> <VarListEntry><term>OverrideDir</term> <ListItem><Para> Indique l'emplacement des fichiers d'� override �. </VarListEntry> <VarListEntry><term>CacheDir</term> <ListItem><Para> Indique l'emplacement des fichiers de cache. </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/ d�finie plus bas). </VarListEntry> </VariableList> </refsect2> <refsect2><title>La section Default</> <para> La section <literal/Default/ 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). <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 �. </VarListEntry> <VarListEntry><term>Packages::Extensions</term> <ListItem><Para> Indique la liste par d�faut des extensions de fichier qui constituent des fichiers-paquets. Par d�faut, c'est � .deb �. </VarListEntry> <VarListEntry><term>Sources::Compress</term> <ListItem><Para> Identique � <literal/Packages::Compress/ mais pr�cise comment sont compress�s les fichiers sources. </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 �. </VarListEntry> <VarListEntry><term>Contents::Compress</term> <ListItem><Para> Identique � <literal/Packages::Compress/ mais pr�cise comment sont compress�s les fichiers � Contents �. </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/. </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�. </VarListEntry> </VariableList> </refsect2> <refsect2><title>La section TreeDefault</> <para> On indique les valeurs par d�faut particuli�res � la section � Tree �. Toutes ces variables sont des variables de substitution ; les cha�nes $(DIST), $(SECTION) et $(ARCH) sont remplac�es par leur valeur respective. <VariableList> <VarListEntry><term>MaxContentsChange</term> <ListItem><Para> Indique le nombre de kilooctets de fichiers � Contents � qui sont cr�es 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. </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. </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)/</>. </VarListEntry> <VarListEntry><term>Packages</term> <ListItem><Para> Indique le fichier � Packages � cr�e. Par d�faut, c'est <filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</>. </VarListEntry> <VarListEntry><term>Sources</term> <ListItem><Para> Indique le fichier � Packages � cr�e. Par d�faut, c'est <filename>$(DIST)/$(SECTION)/source/Sources</>. </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)/</>. </VarListEntry> <VarListEntry><term>Contents</term> <ListItem><Para> Indique le fichier � Contents � cr�e. Par d�faut, c'est <filename>$(DIST)/Contents-$(ARCH)</>. Quand le param�trage fait que diff�rents fichiers � Packages � se r�f�rent � un seul fichier � Contents �, <command/apt-ftparchive/ les int�gre automatiquement. </VarListEntry> <VarListEntry><term>Contents::Header</term> <ListItem><Para> Indique l'en-t�te � pr�fixer au fichier � Contents � cr�e. </VarListEntry> <VarListEntry><term>BinCacheDB</term> <ListItem><Para> Indique la base de donn�e binaire servant de cache pour cette section. Diff�rentes sections peuvent partager cette base de donn�es. </VarListEntry> <VarListEntry><term>FileList</term> <ListItem><Para> Indique qu'au lieu de lire l'arborescence, <command/apt-ftparchive/ 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. </VarListEntry> <VarListEntry><term>SourceFileList</term> <ListItem><Para> Indique qu'au lieu de lire l'arborescence, <command/apt-ftparchive/ 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 cr�er des index de sources. </VarListEntry> </VariableList> </refsect2> <refsect2><title>La section Tree</> <para> La section <literal/Tree/ 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/. <para> La section <literal/Tree/ accepte une �tiquette de vis�e (scope tag) qui d�termine la variable <literal/$(DIST)/ et la racine de l'arborescence (le chemin est pr�fix� par <literal/ArchiveDir/). C'est par exemple : <filename>dists/woody</>. <para> Tous les param�tres d�finis dans la section <literal/TreeDefault/ peuvent s'utiliser dans la section <literal/Tree/ ainsi que les trois nouvelles variables suivantes. <para> Quand il ex�cute la section <literal/Tree/, <command/apt-ftparchive/ agit ainsi : <informalexample><programlisting> for i in Sections do for j in Architectures do Generate for DIST=scope SECTION=i ARCH=j </programlisting></informalexample> <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/. </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. </VarListEntry> <VarListEntry><term>BinOverride</term> <ListItem><Para> Indique le fichier binaire d'� override �. le fichier d'� override � contient des informations sur la section, la priorit� et le responsable de paquet. </VarListEntry> <VarListEntry><term>SrcOverride</term> <ListItem><Para> Indique le fichier source d'� override �. Le fichier d'� override � contient des informations sur la section. </VarListEntry> </VariableList> </refsect2> <refsect2><title>La section BinDirectory</> <para> La section <literal/bindirectory/ 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/ sans substitution de variables ou au param�trage de <literal>Section</><literal>Architecture</>. <VariableList> <VarListEntry><term>Packages</term> <ListItem><Para> Indique le fichier � Packages � cr�e. </VarListEntry> <VarListEntry><term>SrcPackages</term> <ListItem><Para> Indique le fichier � Sources � cr�e. L'un des deux fichiers, <literal/Packages/ ou <literal/SrcPackages/ est n�cessaire. </VarListEntry> <VarListEntry><term>Contents</term> <ListItem><Para> Indique le fichier � Contents � cr�e. </VarListEntry> <VarListEntry><term>Binoverride</term> <ListItem><Para> Indique le fichier binaire d'� override �. </VarListEntry> <VarListEntry><term>SrcOverride</term> <ListItem><Para> Indique le fichier source d'� override �. </VarListEntry> <VarListEntry><term>BinCacheDB</term> <ListItem><Para> Indique une base de donn�es cache. </VarListEntry> <VarListEntry><term>PathPrefix</term> <ListItem><Para> Ajoute un chemin � tous les chemins cr��s. </VarListEntry> <VarListEntry><term>FileList, SourceFileList</term> <ListItem><Para> Indique le fichier contenant la liste des fichiers. </VarListEntry> </VariableList> </refsect2> </RefSect1> <RefSect1><Title>Le fichier binaire � Override �</> <para> Le fichier binaire � 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 une permutation du responsable du paquet. <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. </RefSect1> <RefSect1><title>Le fichier Source � Override �</> <para> Le fichier Source � Override � est pleinement compatible avec &dpkg-scansources;. Il contient deux champs. Le premier est le nom du paquet source; le second, sa section. </RefSect1> <RefSect1><Title>Les options</> &apt-cmdblurb; <VariableList> <VarListEntry><term><option/--md5/</> <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/. </VarListEntry> <VarListEntry><term><option/-d/</><term><option/--db/</> <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/. </VarListEntry> <VarListEntry><term><option/-q/</><term><option/--quiet/</> <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=#/ pour positionner le niveau de silence, et annuler le fichier de configuration. �l�ment de configuration : <literal/quiet/. </VarListEntry> <VarListEntry><term><option/--delink/</> <ListItem><Para> Faire une d�liaison. Si <literal/External-Links/ 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/. �l�ment de configuration : <literal/APT::FTPArchive::DeLinkAct/. </VarListEntry> <VarListEntry><term><option/--contents/</> <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/. </VarListEntry> <VarListEntry><term><option/-s/</><term><option/--source-override/</> <ListItem><Para> Indique le fichier source d'� override � � utiliser avec la commande <literal/sources/. �l�ment de configuration : <literal/APT::FTPArchive::SourceOverride/. </VarListEntry> <VarListEntry><term><option/--readonly/</> <ListItem><Para> N'autoriser que la lecture pour les bases de donn�es de cache. �l�ment de configuration : <literal/APT::FTPArchive::ReadOnlyDB/. </VarListEntry> &apt-commonoptions; </VariableList> </RefSect1> <RefSect1><Title>Voir aussi</> <para> &apt-conf; </RefSect1> <RefSect1><Title>Diagnostics</> <para> <command/apt-ftparchive/ retourne z�ro si tout se passe bien, le nombre d�cimal 100 en cas d'erreur. </RefSect1> &manbugs; &manauthor; &traducteur; </refentry>