SYNOPSIS
apt-ftparchive [-hvdsq] [--md5] [--delink] [--readonly] [--contents]
[-o=option de configuration] [-c=fichier]
{[packages chemin... [override [prfixe-de-chemin]]] |
[sources chemin... [override [prfixe-de-chemin]]] |
[contents chemin] | [release chemin] |
[generate fichier-de-configuration section...] |
[clean fichier-de-configuration]}
DESCRIPTION
apt-ftparchive est l'outil en ligne de commande qui cre les index dont
APT se sert pour accder 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(8) et toutes ses fonctionnalits via la commande
packages ; il comprend aussi un gnrateur de fichier Contents , la
commande contents, et une technique labore pour scripter le processus
de cration d'une archive complte.
Apt-ftparchive peut utiliser lui-mme des bases de donnes binaires pour
cacher le contenu d'un fichier .deb ; il n'a pas besoin de programmes
extrieurs, sauf gzip(1). Lors d'une excution, il vrifie les changements
dans les fichiers et cre les fichiers compresss voulus.
moins que l'option -h ou --help ne soit donne, l'une des commandes
suivantes doit tre prsente :
packages
La commande packages cre un fichier Packages partir d'une
arborescence. Elle recherche rcursivement travers le rpertoire donn
les fichiers .deb et, pour chaque fichier trouv, envoie une entre
pour ce paquet sur la sortie standard. Cette commande est
approximativement quivalente dpkg-scanpackages(8).
On peut se servir de l'option --db pour demander un cache binaire.
sources
La commande sources cre un index des sources partir d'une
arborescence. Elle recherche rcursivement travers le rpertoire donn
les fichiers .dsc et, pour chaque fichier trouv, envoie une entre
pour ce paquet sur la sortie standard. Cette commande est
approximativement quivalente dpkg-scansources(8).
Quand on prcise 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 cre un fichier Contents partir d'une
arborescence. Elle recherche rcursivement travers le rpertoire donn
La valeur des autres champs du fichier Release est tire de la valeur
correspondante dans APT::FTPArchive::Release, p. ex.
APT::FTPArchive::Release::Origin. Les champs reconnus sont : Origin,
Label, Suite, Version, Codename, Date, Architectures, Components,
Description.
generate
La commande generate est conue pour tre excutable par le programme
cron et elle cre un index en suivant le fichier de configuration
donn. Le langage de configuration fournit un moyen souple de prciser
index et rpertoires aussi bien que les paramtres requis.
clean
La commande clean range les bases de donnes utilises par le fichier
de configuration en supprimant les enregistrements qui ne sont plus
ncessaires.
CONFIGURATION DE LA COMMANDE GENERATE
La commande generate utilise un fichier de configuration pour dcrire
l'archive qui va tre cre. 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) dcrit 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 vise (scope
tag).
Ce fichier de configuration possde quatre sections, dcrites ci-dessous.
La section Dir
La section Dir dfinit les rpertoires standards o situer les fichiers
ncessaires au processus de cration. Ces rpertoires sont prcds de
chemins relatifs dfinis dans les sections suivantes de manire produire
un chemin absolu et complet.
ArchiveDir
Indique la racine de l'archive FTP ; Pour une configuration Debian
classique, c'est le rpertoire qui contient le fichier ls-LR et les
noeuds des distributions.
OverrideDir
Indique l'emplacement des fichiers d' override .
CacheDir
Indique l'emplacement des fichiers de cache.
FileListDir
Indique l'emplacement des fichiers contenant la liste des fichiers
(si on se sert de la valeur FileList dfinie plus bas).
La section Default
La section Default prcise les valeurs par dfaut et les paramtres qui
Identique Packages::Compress mais prcise comment sont compresss les
fichiers sources.
Sources::Extensions
Indique la liste par dfaut des extensions de fichier qui constituent
des fichiers sources. Par dfaut, c'est .dsc .
Contents::Compress
Identique Packages::Compress mais prcise comment sont compresss les
fichiers Contents .
DeLinkLimit
Indique le nombre de kilooctets dlier (et remplacer par des liens
en dur) pour chaque excution. On s'en sert, pour chaque section,
avec le paramtre External-Links.
FileMode
Indique le systme de permissions des fichiers d'index crs. Par
dfaut, c'est le mode 0644. Tous les fichiers d'index ont ce mode et
le masque utilisateur (umasq) est ignor.
La section TreeDefault
On indique les valeurs par dfaut particulires la section Tree. Toutes
ces variables sont des variables de substitution ; les chanes $(DIST),
$(SECTION) et $(ARCH) sont remplaces par leur valeur respective.
MaxContentsChange
Indique le nombre de kilooctets de fichiers Contents qui sont crs
chaque jour. Les fichiers Contents sont tirs au sort selon le
systme round-robin de manire que, sur plusieurs jours, tous soient
reconstruits.
ContentsAge
Contrle 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 dlai est permis dans
l'espoir que de nouveaux .deb seront installs, exigeant un nouveau
Contents . Par dfaut ce nombre vaut 10, l'unit tant le jour.
Directory
Indique la racine de l'arborescence des .deb . Par dfaut, c'est
$(DIST)/$(SECTION)/binary-$(ARCH)/.
SrcDirectory
Indique la racine de l'arborescence des paquets source. Par dfaut,
c'est $(DIST)/$(SECTION)/source/.
Packages
Indique le fichier Packages cr. Par dfaut, c'est
$(DIST)/$(SECTION)/binary-$(ARCH)/Packages.
apt-ftparchive les intgre automatiquement.
Contents::Header
Indique l'en-tte prfixer au fichier Contents cr.
BinCacheDB
Indique la base de donnes binaire servant de cache pour cette
section. Diffrentes sections peuvent partager cette base de donnes.
FileList
Indique qu'au lieu de lire l'arborescence, apt-ftparchive doit lire
la liste de fichiers dans le fichier donn en argument. Les noms
relatifs sont prfixs par le rpertoire de l'archive.
SourceFileList
Indique qu'au lieu de lire l'arborescence, apt-ftparchive doit lire
la liste de fichiers dans le fichier donn en argument. Les noms
relatifs sont prfixs par le rpertoire de l'archive. On s'en sert
pour traiter les index de sources.
La section Tree
La section Tree dfinit une arborescence debian classique avec un
rpertoire de base, diffrentes sections dans ce rpertoire et diffrentes
architectures dans chaque section. Le chemin exact est dfini par la
variable de substitution Directory.
La section Tree accepte une tiquette de vise (scope tag) qui dtermine
la variable $(DIST) et la racine de l'arborescence (le chemin est prfix
par ArchiveDir). C'est par exemple : dists/woody.
Tous les paramtres dfinis dans la section TreeDefault peuvent
s'utiliser dans la section Tree ainsi que les trois nouvelles variables
suivantes.
Quand il excute la section Tree, apt-ftparchive agit ainsi :
Sections
C'est une liste de sections spares par des espaces qui appartiennent
une distribution ; classiquement, on trouve main contrib non-free.
Architectures
C'est une liste de toutes les architectures qui appartiennent
chaque section. L'architecture spciale source indique que
l'arborescence est une arborescence de sources.
BinOverride
Indique le fichier binaire d' override . Ce fichier contient des
informations sur la section, la priorit et le responsable du paquet.
SrcOverride
Indique le fichier source d' override . Ce fichier contient des
informations sur la section.
Packages
Indique le fichier Packages cr.
Sources
Indique le fichier Sources cr. L'un des deux fichiers, Packages ou
Sources est ncessaire.
Contents
Indique le fichier Contents cr.
Binoverride
Indique le fichier d' override pour les binaires.
SrcOverride
Indique le fichier d' override pour les sources.
ExtraOverride
Indique un autre fichier d' override pour les binaires.
SrcExtraOverride
Indique un autre fichier d' override pour les sources.
BinCacheDB
Indique une base de donnes cache.
PathPrefix
Ajoute un chemin tous les chemins crs.
FileList, SourceFileList
Indique le fichier contenant la liste des fichiers.
LE FICHIER D' OVERRIDE POUR LES BINAIRES.
Le fichier d' Override est pleinement compatible avec
dpkg-scanpackages(8). Il contient quatre champs spars par des espaces.
Le premier est le nom du paquet ; le deuxime est la priorit donner ce
paquet ; le troisime 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 premire forme permet de spcifier de vieilles adresses dans une liste
(le sparateur est la double barre oblique). Si l'une de ces deux formes
est rencontre, la valeur de new remplace la valeur du champ. La deuxime
forme remplace inconditionnellement le champ.
LE FICHIER D' OVERRIDE POUR LES SOURCES
on peut annuler le fichier de configuration en utilisant quelque chose
comme -f-,--no-f, -f=no ou d'autres variantes.
--md5
Crer la somme de contrle MD5. Cette option est active par dfaut.
Quand elle est dsactive, les fichiers d'index n'ont pas les champs
MD5Sum l o c'est possible. lment de configuration :
APT::FTPArchive::MD5.
-d, --db
Utiliser une base de donnes binaire pour cache. Cela n'a aucun effet
sur la commande generate. lment de configuration :
APT::FTPArchive::DB.
-q, --quiet
Mode silencieux ; cette commande produit une sortie destine
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 -q=# pour positionner le
niveau de silence, et annuler le fichier de configuration. lment de
configuration : quiet.
--delink
Faire une dliaison. Si External-Links est activ, cette option permet
rellement la dliaison des fichiers. Par dfaut, elle est active mais
elle peut tre dsactive avec l'option --no-delink. lment de
configuration : APT::FTPArchive::DeLinkAct.
--contents
Permettre la cration d'un fichier Contents . Quand cette option est
active et que les index sont crs sous forme de base de donnes
binaire, la liste des fichiers est aussi extraite et conserve dans
la base de donnes pour un usage futur. Avec la commande generate,
cette option permet la cration de fichiers Contents . Par dfaut,
elle est active. lment de configuration : APT::FTPArchive::Contents.
-s, --source-override
Indique le fichier d' override utiliser avec la commande sources.
lment de configuration : APT::FTPArchive::SourceOverride.
--readonly
N'autoriser que la lecture pour les bases de donnes de cache. lment
de configuration : APT::FTPArchive::ReadOnlyDB.
-h, --help
Affiche un mode d'emploi succinct.
-v, --version
Affiche la version du programme.
-c, --config-file
Fichier de configuration ; indique quel fichier de configuration
BOGUES
Voyez la [1] page concernant les bogues d'APT. Si vous voulez signaler
un bogue, consultez le texte /usr/share/doc/debian/bug-reporting.txt ou
utilisez la commande reportbug(1).
TRADUCTION
Philippe Batailler. <debian-l10n-french@lists.debian.org>. 2005.
AUTHORS
Jason Gunthorpe
Auteur.
APT team
Auteur.
REFERENCES
1. page concernant les bogues d'APT
http://bugs.debian.org/src:apt
Linux 29 Fvrier 2004 APT-FTPARCHIVE(1)
Man(1) output converted with
man2html