Man page 1 : apt-ftparchive

apt-ftparchive - Outil de création de fichiers d'index

apt-ftparchive [-dsq] [--md5] [--delink] [--readonly] [--contents] [--arch architecture] [-o=chaîne_de_configuration] [-c=fichier_de_configuration] {packages chemin... [fichier-override [préfixe_de_chemin]] | sources chemin... [fichier-override [préfixe_de_chemin]] | contents chemin | release chemin | generate fichier_de_configuration section... | clean fichier_de_configuration | {-v | --version} | {-h | --help}}

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.

apt-ftparchive est un ensemble comprenant le programme dpkg-scanpackages(1) et toutes ses fonctionnalités via la commande packages ; il comprend aussi un générateur de fichier « Contents », la commande contents, et une technique élaborée pour automatiser le processus de création d'une archive complète.

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(1). Lors d'une exécution, il vérifie les changements dans les fichiers et crée les fichiers compressés voulus.

(`A moins que l'option -h ou --help ne soit donnée, l'une des commandes suivantes doit être présente.

packages
    La commande 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 une entrée pour ce paquet sur la sortie standard. Cette commande est approximativement équivalente à dpkg-scanpackages(1).
On peut se servir de l'option --db pour demander un cache binaire.

sources
    La commande 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 une entrée pour ce paquet sur la sortie standard. Cette commande est approximativement équivalente à dpkg-scansources(1).
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 --source-override pour changer de fichier source d'« override ».

contents
    La commande 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.
On peut se servir de l'option --db pour demander un cache binaire.

release
    La commande release crée un fichier Release à partir d'une arborescence. Elle recherche récursivement dans le répertoire indiqué des fichiers Packages et Sources non compressés et compressés avec gzip, bzip2 ou lzma ainsi que des fichiers Release et md5sum.txt par défaut (APT::FTPArchive::Release::Default-Patterns). Des motifs supplémentaires pour les noms de fichiers peuvent être ajoutés en les mentionnant dans APT::FTPArchive::Release::Patterns. Le fichier Release est ensuite affiché et comporte des sommes de contrôle MD5, SHA1 et SHA256 pour chaque fichier.
La valeur des autres champs de métadonnées du fichier Release sont tirées de la valeur correspondante dans APT::FTPArchive::Release, p. ex. APT::FTPArchive::Release::Origin. Les champs reconnus sont : Origin, Label, Suite, Version, Codename, Date, Valid-Until, Architectures, Components, Description.

generate
    La commande 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.

clean
    La commande clean nettoie les bases de données utilisées par le fichier de configuration en supprimant les enregistrements qui ne sont plus nécessaires.

La commande 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. Le fichier apt.conf(5) décrit ce format. Il faut noter que l'analyse de ce fichier se fait par section tandis que celle d'apt.conf(5) se fait par arborescence. Cela n'affecte que l'usage de l'étiquette de visée (scope tag).

Ce fichier de configuration possède quatre sections, décrites ci-dessous.

4.1. La section Dir ▲

4.2. La section Default ▲

4.3. La section TreeDefault ▲

4.4. La section Tree ▲

for i in Sections do
   for j in Architectures do
      Generate for DIST=scope SECTION=i ARCH=j

4.5. La section BinDirectory ▲

Le fichier d'« Override » est pleinement compatible avec dpkg-scanpackages(1). 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.

Le champ du responsable est de cette forme :

    

old [// oldn]* => new

ou simplement,

    

new

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.

Le fichier d'« Override » est pleinement compatible avec dpkg-scansources(1). Il contient deux champs. Le premier est le nom du paquet source ; le second, sa section.

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.

Toutes les options de la ligne de commande peuvent être définies dans le fichier de configuration, les descriptions indiquant l'option de configuration concernée. Pour les options booléennes, vous pouvez inverser les réglages du fichiers de configuration avec -f-,--no-f, -f=no et d'autres variantes analogues.

--md5, --sha1, --sha256
    Crée la somme de contrôle indiquée. Si ces options sont actives par défaut. Quand elles sont désactivées, les fichiers d'index créés n'auront pas de champ de somme de contrôle là o(`u cela était possible. ('Eléments de configuration :APT::FTPArchive::Checksum et APT::FTPArchive::Index::Checksum o(`u Index peut être Packages, Sources ou Release et Checksum peut être MD5, SHA1 ou SHA256.

-d, --db
    Utiliser une base de données binaire pour cache. Cela n'a aucun effet sur la commande generate. ('Elément de configuration : APT::FTPArchive::DB.

-q, --quiet
    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) rend le programme de plus en plus silencieux. On peut aussi utiliser -q=# pour définir ce « niveau de silence », et ne plus tenir compte des réglages du fichier de configuration. ('Elément de configuration : quiet.

--delink
    Défaire une liaison. Si External-Links est activé, cette option permet réellement de délier les fichiers. Par défaut, elle est activée mais elle peut être désactivée avec l'option --no-delink. ('Elément de configuration : APT::FTPArchive::DeLinkAct.

--contents
    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. ('Elément de configuration : APT::FTPArchive::Contents.

-s, --source-override
    Indique le fichier d'« override » à utiliser avec la commande sources. ('Elément de configuration : APT::FTPArchive::SourceOverride.

--readonly
    N'autoriser que la lecture pour les bases de données de cache. ('Elément de configuration : APT::FTPArchive::ReadOnlyDB.

-a, --arch
    N'accepte dans les commandes packages et contents que les fichiers de paquets correspondant à *_arch.deb ou *_all.deb au lieu de tous les fichiers de paquets du chemin indiqué.('Elément de configuration : APT::FTPArchive::Architecture.

APT::FTPArchive::AlwaysStat
     apt-ftparchive(1) met le plus de métadonnées possible en cache dans une base de données. Si les paquets sont recompilés ou republiés avec à nouveau la même version, cela pourra causer des problèmes car, alors, les métadonnées en cache (p. ex. les tailles et les sommes de contrôle) seront utilisées. Si cette option est choisie, cela n'arrivera plus car le fichier sera contrôlé pour vérifier s'il a été modifié. Veuillez noter que cette option n'est pas activée par défaut car il est déconseillé d'envoyer dans les archives des versions identiques. En théorie, donc, ces problème ne devraient pas survenir et l'ensemble de ces contrôles devient inutile.

APT::FTPArchive::LongDescription
    Cette option de configuration a « true » comme valeur par défaut et ne devrait être placée sur « false » que si l'archive créée avec apt-ftparchive(1) fournit également des fichiers Translation. Veuillez noter que le fichier maître Translation-en ne peut être créé que par la commande generate.

-h, --help
    Afficher un bref résumé de l'utilisation.

-v, --version
    Afficher la version du programme.

-c, --config-file
    Fichier de configuration ; indique le fichier de configuration à utiliser. Le programme lira le fichier de configuration par défaut puis le fichier indiqué ici. Si les réglages de configuration doivent être établis avant l'analyse des fichiers de configuration par défaut, un fichier peut être indiqué avec la variable d'environnement APT_CONFIG. Veuillez consulter apt.conf(5) pour des informations sur la syntaxe d'utilisation.

-o, --option
    Définir une option de configuration ; permet de régler une option de configuration donnée. La syntaxe est -o Foo::Bar=bar. -o et --option peuvent être utilisées plusieurs fois pour définir des options différentes.

Création d'un fichier « Packages » compressé pour un répertoire contenant des paquets binaires (.deb):

    

apt-ftparchive packages répertoire | gzip > Packages.gz

apt.conf(5)

apt-ftparchive retourne zéro si tout se passe bien, le nombre 100 en cas d'erreur.

Page des bogues d'APT[1]. Si vous souhaitez signaler un bogue à propos d'APT, veuillez lire /usr/share/doc/debian/bug-reporting.txt ou utiliser la commande reportbug(1).

Jérôme Marant, Philippe Batailler, Christian Perrier <> (2000, 2005, 2009, 2010), ('Equipe de traduction francophone de Debian <>

Veuillez noter que cette traduction peut contenir des parties non traduites. Cela est volontaire, pour éviter de perdre du contenu quand la traduction est légèrement en retard sur le contenu d'origine.

Jason Gunthorpe

('Equipe de développement d'APT

1. 4 Page des bogues d'APT
    http://bugs.debian.org/src:apt