NAME
apt-ftparchive - Outil de cration de fichiers d'index
SYNOPSIS
apt-ftparchive [-hvdsq] [--md5] [--delink] [--readonly] [--contents]
[--arch architecture] [-o option de configuration=chane]
[-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]}
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(1) 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(1).
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(1).
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 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 rpertoires ne font
pas partie du rsultat. Quand un fichier appartient plusieurs
paquets, une virgule spare les paquets.
On peut se servir de l'option --db pour demander un cache binaire.
release
La commande release cre un fichier << Releases >> partir d'un
rpertoire. Elle cherche rcursivement dans ce rpertoire 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 rsum MD5 et un rsum SHA1
pour chaque fichier.
Values for the additional metadata fields in the Release file are
taken from the corresponding variables under
APT::FTPArchive::Release, e.g. APT::FTPArchive::Release::Origin.
The supported fields are: Origin, Label, Suite, Version, Codename,
Date, Valid-Until, 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 nettoie 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
contrlent la marche du gnrateur. Ces valeurs peuvent tre annules dans
d'autres sections (paramtrage par section).
Packages::Compress
Indique comment sont compresss les fichiers d'index. C'est une
chane qui contient des valeurs spares par des espaces ; elle
contient au moins l'une des valeurs suivantes : << . >> (pas de
compression), << gzip >>, << bzip2 >>. Par dfaut, c'est la chane
<< . gzip >>.
Packages::Extensions
Indique la liste par dfaut des extensions de fichier qui
constituent des paquets. Par dfaut, c'est << .deb >>.
Sources::Compress
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 >>.
Translation::Compress
This is similar to Packages::Compress except that it controls the
compression for the Translation-en master file.
DeLinkLimit
Indique le nombre de kilo-octets 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.
LongDescription
Sets if long descriptions should be included in the Packages file
or split out into a master Translation-en file.
La section TreeDefault
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 kilo-octets de fichiers << Contents >> qui
sont crs chaque jour. Les fichiers << Contents >> sont choisis
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.
Sources
Indique le fichier << Sources >> cr. Par dfaut, c'est
$(DIST)/$(SECTION)/source/Sources.
Translation
Set the output Translation-en master file with the long
descriptions if they should be not included in the Packages file.
Defaults to $(DIST)/$(SECTION)/i18n/Translation-en
InternalPrefix
Indique un prfixe de chemin ; ce prfixe fait qu'un lien symbolique
sera considr comme un lien interne plutt que comme un lien externe.
Par dfaut, c'est $(DIST)/$(SECTION)/.
Contents
Indique le fichier << Contents >> cr. Par dfaut, c'est
$(DIST)/Contents-$(ARCH). Quand le paramtrage fait que diffrents
fichiers << Packages >> se rfrent un seul fichier << Contents >>,
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 paramtre. 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 paramtre. 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.
The Tree section takes a scope tag which sets the $(DIST) variable and
defines the root of the tree (the path is prefixed by ArchiveDir).
Typically this is a setting such as dists/lenny.
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 effectue une opration
analogue :
for i in Sections do
for j in Architectures do
Generate for DIST=scope SECTION=i ARCH=j
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 spares par des espaces
qui appartiennent chaque section. L'architecture spciale
<< source >> indique que l'arborescence est une arborescence de
sources.
LongDescription
Sets if long descriptions should be included in the Packages file
or split out into a master Translation-en file.
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.
ExtraOverride
Indique un autre fichier d'<< override >> pour les binaires.
SrcExtraOverride
Indique un autre fichier d'<< override >> pour les sources.
La section BinDirectory
La section bindirectory dfinit une arborescence binaire sans structure
particulire. L'tiquette de vise (scope tag) indique l'emplacement du
rpertoire binaire et le paramtrage est identique celui pour la section
Tree sans substitution de variables ou au paramtrage de
SectionArchitecture.
Packages
Dfinit le fichier << Packages >> cr.
Sources
Dfinit le fichier << Sources >> cr. L'un des deux fichiers,
Packages ou Sources est ncessaire.
Contents
Dfinit le fichier << Contents >> cr.
BinOverride
Dfinit le fichier d'<< override >> pour les binaires.
SrcOverride
Dfinit 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
Dfinit la base de donnes cache.
PathPrefix
Ajoute un chemin tous les chemins crs.
FileList, SourceFileList
Dfinit le fichier contenant la liste des fichiers.
LE FICHIER D'<< OVERRIDE >> POUR LES BINAIRES.
Le fichier d'<< Override >> est pleinement compatible avec dpkg-
scanpackages(1). 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
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 SUPPLMENTAIRE D'<< OVERRIDE >>
Le fichier supplmentaire d'<< Override >> permet d'ajouter ou de
remplacer des tiquettes sur la sortie. Il possde trois colonnes : la
premire reprsente le paquet, la seconde est une tiquette et la troisime
en fin de ligne est la nouvelle valeur.
OPTIONS
Toutes les options de la ligne de commande peuvent tre dfinies dans le
fichier de configuration, les descriptions indiquant l'option de
configuration concerne. Pour les options boolennes, vous pouvez
inverser les rglages du fichiers de configuration avec -f-,--no-f,
-f=no et d'autres variantes analogues.
--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
Dfaire une liaison. Si External-Links est activ, cette option
permet rellement de dlier les 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.
-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.lment de configuration :
APT::FTPArchive::Architecture.
APT::FTPArchive::AlwaysStat
apt-ftparchive(1) met le plus de mtadonnes possible en cache dans
une base de donnes. Si les paquets sont recompils ou republis avec
nouveau la mme version, cela pourra causer des problmes car, alors,
les mtadonnes en cache (p. ex. les tailles et les sommes de
contrle) seront utilises. Si cette option est choisie, cela
n'arrivera plus car le fichier sera contrl pour vrifier s'il a t
modifi. Veuillez noter que cette option n'est pas active par dfaut
car il est dconseill d'envoyer dans les archives des versions
identiques. En thorie, donc, ces problme ne devraient pas survenir
et l'ensemble de ces contrles devient inutile.
APT::FTPArchive::LongDescription
This configuration option defaults to "true" and should only be set
to "false" if the Archive generated with apt-ftparchive(1) also
provides Translation files. Note that the Translation-en master
file can only be created in the generate command.
-h, --help
Afficher un bref rsum de l'utilisation.
-v, --version
Afficher la version du programme.
-c, --config-file
Configuration File; Specify a configuration file to use. The
program will read the default configuration file and then this
configuration file. If configuration settings need to be set before
the default configuration files are parsed specify a file with the
APT_CONFIG environment variable. See apt.conf(5) for syntax
information.
-o, --option
Dfinir une option de configuration ; permet de rgler une option de
configuration donne. La syntaxe est -o Foo::Bar=bar. -o et
--option peuvent tre utilises plusieurs fois pour dfinir des
options diffrentes.
EXEMPLES
Cration d'un fichier << Packages >> compress pour un rpertoire
contenant des paquets binaires (.deb):
apt-ftparchive packages rpertoire | gzip > Packages.gz
VOIR AUSSI
apt.conf(5)
DIAGNOSTICS
apt-ftparchive retourne zro si tout se passe bien, le nombre 100 en cas
d'erreur.
BOGUES
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).
TRADUCTEURS
Jrme Marant, Philippe Batailler, Christian Perrier bubulle@debian.org
(2000, 2005, 2009, 2010), quipe de traduction francophone de Debian
debian-l10n-french@lists.debian.org
Veuillez noter que cette traduction peut contenir des parties non
traduites Cela est volontaire, pour viter de perdre du contenu quand la
traduction est lgrement en retard sur le contenu d'origine.
AUTHORS
Mike O'Connor
quipe de dveloppement d'APT
NOTES
1. Page des bogues d'APT
http://bugs.debian.org/src:apt