1
<!-- -*- mode: sgml; mode: fold -*- -->
2
<!-- translation of version 1.5 -->
3
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
5
<!ENTITY % aptent SYSTEM "apt.ent.fr">
14
<refentrytitle>apt-ftparchive</>
18
<!-- Man page title -->
20
<refname>apt-ftparchive</>
21
<refpurpose>Un outil pour cr�er des index
27
<command>apt-ftparchive</>
28
<arg><option>-hvdsq</></arg>
29
<arg><option>--md5</></arg>
30
<arg><option>--delink</></arg>
31
<arg><option>--readonly</></arg>
32
<arg><option>--contents</></arg>
33
<arg><option>-o=<replaceable/option de configuration/</></arg>
34
<arg><option>-c=<replaceable/fichier/</></arg>
36
<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>
37
<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>
38
<arg>contents <arg choice="plain"><replaceable>chemin</replaceable></arg></arg>
39
<arg>generate <arg choice="plain"><replaceable>fichier-de-configuration</replaceable></arg> <arg choice="plain" rep="repeat"><replaceable>section</replaceable></arg></arg>
40
<arg>clean <arg choice="plain"><replaceable>fichier-de-configuration</replaceable></arg></arg>
45
<RefSect1><Title>Description</>
47
<command/apt-ftparchive/ est l'outil en ligne de commande qui cr�e les index
48
dont APT se sert pour acc�der aux sources des distributions. Un index doit
49
�tre cr�� pour un site et bas� sur le contenu de ce site.
52
<command/apt-ftparchive/ est un ensemble comprenant le programme
53
&dpkg-scanpackages; et toutes ses fonctionnalit�s via la commande
54
<literal/directory/ ; il comprend aussi un g�n�rateur de fichier
55
� Contents �, la commande <literal/contents/, et une technique
56
�labor�e pour � scripter � le processus de cr�ation d'une archive
60
<command/apt-ftparchive/ peut utiliser lui-m�me des bases de donn�es binaires
61
pour � cacher � le contenu d'un fichier .deb ; il n'a pas
62
besoin de programmes ext�rieurs, sauf &gzip;. Lors d'une ex�cution, il
63
v�rifie les changements dans les fichiers et cr�e les fichiers compress�s
67
� moins que l'option <option/-h/ ou <option/--help/ ne soit donn�e, l'une des
68
commandes suivantes doit �tre pr�sente :
71
<VarListEntry><term>packages</term>
73
La commande <literal/packages/ cr�e un fichier � Packages � � partir d'une
74
arborescence. Elle recherche r�cursivement � travers le r�pertoire donn�
75
les fichiers .deb et, pour chaque fichier trouv�, envoie une entr�e pour ce
76
paquet sur la sortie standard. Cette commande est approximativement
77
�quivalente � &dpkg-scanpackages;.
79
On peut se servir de l'option <option/--db/ pour demander un cache binaire.
82
<VarListEntry><term>sources</term>
84
La commande <literal/sources/ cr�e un index des sources � partir d'une
85
arborescence. Elle recherche r�cursivement � travers le r�pertoire donn�
86
les fichiers .dsc et, pour chaque fichier trouv�, envoie une entr�e pour ce
87
paquet sur la sortie standard. Cette commande est approximativement
88
�quivalente � &dpkg-scansources;.
90
Quand on pr�cise un fichier � override �, c'est un fichier source
91
avec une extension .src qui est recherch�. On peut se servir de l'option
92
<option/--source-override/ pour changer de fichier source d'� override �.
95
<VarListEntry><term>contents</term>
97
La commande <literal/contents/ cr�e un fichier � Contents � � partir d'une
98
arborescence. Elle recherche r�cursivement � travers le r�pertoire donn�
99
les fichiers .deb et, pour chaque fichier trouv�, lit la liste des
100
fichiers. Elle trie la liste des fichiers correspondant � des paquets et
101
l'envoie sur la sortie standard. Les r�pertoires ne font pas partie du
102
r�sultat. Quand un fichier appartient � plusieurs paquets, une virgule
105
On peut se servir de l'option <option/--db/ pour demander un cache binaire.
108
<VarListEntry><term>generate</term>
110
La commande <literal/generate/ est con�ue pour �tre ex�cutable par le
111
programme cron et elle cr�e un index en suivant le fichier de configuration
112
donn�. Le langage de configuration fournit un moyen souple de pr�ciser
113
index et r�pertoires aussi bien que les param�tres requis.
116
<VarListEntry><term>clean</term>
118
La commande <literal/clean/ range les bases de donn�es utilis�es par le
119
fichier de configuration en supprimant les enregistrements qui ne sont
126
<RefSect1><Title>Configuration de la commande generate</>
128
La commande <literal/generate/ utilise un fichier de configuration pour
129
d�crire l'archive qui va �tre cr��e. Le format de ce fichier est le format
130
ISC classique utilis� par des outils ISC comme bind 8 et dhcpd. &apt-conf;
131
d�crit ce format. Il faut noter que l'analyse de ce fichier se fait
132
par section tandis que celle d'&apt-conf; se fait par arborescence. Cela
133
n'affecte que l'usage de l'�tiquette de vis�e (scope tag).
136
Ce fichier de configuration poss�de quatre sections, d�crites ci-dessous.
138
<refsect2><title>La section Dir</>
140
La section <literal/Dir/ d�finit les r�pertoires standards o� situer les
141
fichiers n�cessaires au processus de cr�ation. Ces r�pertoires sont
142
pr�c�d�s de chemins relatifs d�finis dans les sections suivantes de mani�re
143
� produire un chemin absolu et complet.
145
<VarListEntry><term>ArchiveDir</term>
147
Indique la racine de l'archive FTP ; Pour une configuration Debian
149
c'est le r�pertoire qui contient le fichier <filename/ls-LR/, et les noeuds
153
<VarListEntry><term>OverrideDir</term>
155
Indique l'emplacement des fichiers d'� override �.
158
<VarListEntry><term>CacheDir</term>
160
Indique l'emplacement des fichiers de cache.
163
<VarListEntry><term>FileListDir</term>
165
Indique l'emplacement des fichiers contenant la liste des fichiers (si on se
166
sert de la valeur <literal/FileList/ d�finie plus bas).
171
<refsect2><title>La section Default</>
173
La section <literal/Default/ pr�cise les valeurs par d�faut et les param�tres
174
qui contr�lent la marche du g�n�rateur. Ces valeurs peuvent �tre annul�es dans
175
d'autres sections (param�trage par section).
177
<VarListEntry><term>Packages::Compress</term>
179
Indique comment sont compress�s les fichiers d'index. C'est une cha�ne qui
180
contient des valeurs s�par�es par des espaces ; elle contient au moins
181
l'une des valeurs suivantes : � . � (pas de compression),
182
� gzip �, � bzip2 �.
183
Par d�faut, c'est la cha�ne � . gzip �.
186
<VarListEntry><term>Packages::Extensions</term>
188
Indique la liste par d�faut des extensions de fichier qui constituent des
189
paquets. Par d�faut, c'est � .deb �.
192
<VarListEntry><term>Sources::Compress</term>
194
Identique � <literal/Packages::Compress/ mais pr�cise comment sont compress�s
195
les fichiers sources.
198
<VarListEntry><term>Sources::Extensions</term>
200
Indique la liste par d�faut des extensions de fichier qui constituent des
201
fichiers sources. Par d�faut, c'est � .dsc �.
204
<VarListEntry><term>Contents::Compress</term>
206
Identique � <literal/Packages::Compress/ mais pr�cise comment sont compress�s
207
les fichiers � Contents �.
210
<VarListEntry><term>DeLinkLimit</term>
212
Indique le nombre de kilooctets � d�lier (et � remplacer par des liens en dur)
213
pour chaque ex�cution. On s'en sert, pour chaque section, avec le param�tre
214
<literal/External-Links/.
217
<VarListEntry><term>FileMode</term>
219
Indique le syst�me de permissions des fichiers d'index cr��s. Par d�faut,
220
c'est le mode 0644. Tous les fichiers d'index ont ce mode et le masque
221
utilisateur (umasq) est ignor�.
226
<refsect2><title>La section TreeDefault</>
228
On indique les valeurs par d�faut particuli�res � la section
229
� Tree �. Toutes ces variables sont des variables de
230
substitution ; les cha�nes $(DIST),
231
$(SECTION) et $(ARCH) sont remplac�es par leur valeur respective.
234
<VarListEntry><term>MaxContentsChange</term>
236
Indique le nombre de kilooctets de fichiers � Contents � qui sont
237
cr��s chaque jour. Les fichiers � Contents � sont tir�s au sort
238
selon le syst�me <emphasis>round-robin</emphasis> de mani�re que, sur
239
plusieurs jours, tous soient reconstruits.
242
<VarListEntry><term>ContentsAge</term>
244
Contr�le le nombre de jours pendant lequel un fichier � Contents �
245
peut �tre utilis� sans actualisation. Quand cette limite est franchie,
246
le � mtime � du fichier � Contents � est mis � jour. Cela
247
peut arriver quand un fichier est modifi� sans que cela modifie le fichier
248
� Contents � (modification par � override � par exemple).
249
Un d�lai est permis dans l'espoir que de nouveaux � .deb � seront
250
install�s, exigeant un nouveau � Contents �. Par
251
d�faut ce nombre vaut 10, l'unit� �tant le jour.
254
<VarListEntry><term>Directory</term>
256
Indique la racine de l'arborescence des � .deb �. Par d�faut, c'est
257
<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</>.
260
<VarListEntry><term>Packages</term>
262
Indique le fichier � Packages � cr��. Par d�faut, c'est
263
<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</>.
266
<VarListEntry><term>Sources</term>
268
Indique le fichier � Packages � cr�e. Par d�faut, c'est
269
<filename>$(DIST)/$(SECTION)/source/Sources</>.
272
<VarListEntry><term>InternalPrefix</term>
274
Indique un pr�fixe de chemin ; ce pr�fixe fait qu'un lien symbolique sera
275
consid�r� comme un lien interne plut�t que comme un lien externe. Par d�faut,
276
c'est <filename>$(DIST)/$(SECTION)/</>.
279
<VarListEntry><term>Contents</term>
281
Indique le fichier � Contents � cr��. Par d�faut, c'est
282
<filename>$(DIST)/Contents-$(ARCH)</>. Quand le param�trage fait que
283
diff�rents fichiers � Packages � se r�f�rent � un seul fichier
284
� Contents �, <command/apt-ftparchive/ les int�gre automatiquement.
287
<VarListEntry><term>Contents::Header</term>
289
Indique l'en-t�te � pr�fixer au fichier � Contents � cr��.
292
<VarListEntry><term>BinCacheDB</term>
294
Indique la base de donn�es binaire servant de cache pour cette section.
295
Diff�rentes sections peuvent partager cette base de donn�es.
298
<VarListEntry><term>FileList</term>
300
Indique qu'au lieu de lire l'arborescence, <command/apt-ftparchive/ doit lire
301
la liste de fichiers dans le fichier donn� en argument. Les noms relatifs
302
sont pr�fix�s par le r�pertoire de l'archive.
305
<VarListEntry><term>SourceFileList</term>
307
Indique qu'au lieu de lire l'arborescence, <command/apt-ftparchive/ doit lire
308
la liste de fichiers dans le fichier donn� en argument. Les noms relatifs
309
sont pr�fix�s par le r�pertoire de l'archive. On s'en sert pour traiter les
315
<refsect2><title>La section Tree</>
317
La section <literal/Tree/ d�finit une arborescence debian classique avec
318
un r�pertoire de base, diff�rentes sections dans ce r�pertoire et
319
diff�rentes architectures dans chaque section. Le chemin exact est d�fini
320
par la variable de substitution <literal/Directory/.
322
La section <literal/Tree/ accepte une �tiquette de vis�e (scope tag) qui
323
d�termine la variable <literal/$(DIST)/ et la racine de l'arborescence
324
(le chemin est pr�fix� par <literal/ArchiveDir/). C'est par exemple :
325
<filename>dists/woody</>.
327
Tous les param�tres d�finis dans la section <literal/TreeDefault/ peuvent
328
s'utiliser dans la section <literal/Tree/ ainsi que les trois nouvelles
331
Quand il ex�cute la section <literal/Tree/, <command/apt-ftparchive/
333
<informalexample><programlisting>
335
for j in Architectures do
336
Generate for DIST=scope SECTION=i ARCH=j
337
</programlisting></informalexample>
340
<VarListEntry><term>Sections</term>
342
C'est une liste de sections s�par�es par des espaces qui appartiennent � une
343
distribution ; classiquement, on trouve <literal/main contrib non-free/.
346
<VarListEntry><term>Architectures</term>
348
C'est une liste de toutes les architectures qui appartiennent � chaque
349
section. L'architecture sp�ciale � source � indique que
350
l'arborescence est une arborescence de sources.
353
<VarListEntry><term>BinOverride</term>
355
Indique le fichier binaire d'� override �. le fichier d'� override � contient
356
des informations sur la section, la priorit� et le responsable de paquet.
359
<VarListEntry><term>SrcOverride</term>
361
Indique le fichier source d'� override �. Le fichier
362
d'� override � contient des informations sur la section.
365
<VarListEntry><term>ExtraOverride</term>
367
Indique le fichier suppl�mentaire d'� override � pour les binaires.
370
<VarListEntry><term>SrcExtraOverride</term>
372
Indique le fichier suppl�mentaire d'� override � pour les sources.
378
<refsect2><title>La section BinDirectory</>
380
La section <literal/bindirectory/ d�finit une arborescence binaire sans
381
structure particuli�re. L'�tiquette de vis�e (scope tag) indique l'emplacement
382
du r�pertoire binaire et le param�trage est identique � celui pour la
383
section <literal/Tree/ sans substitution de variables ou au param�trage de
384
<literal>Section</><literal>Architecture</>.
386
<VarListEntry><term>Packages</term>
388
Indique le fichier � Packages � cr��.
391
<VarListEntry><term>SrcPackages</term>
393
Indique le fichier � Sources � cr��. L'un des deux fichiers,
394
<literal/Packages/ ou <literal/SrcPackages/ est n�cessaire.
397
<VarListEntry><term>Contents</term>
399
Indique le fichier � Contents � cr��.
402
<VarListEntry><term>Binoverride</term>
404
Indique le fichier d'� override � pour les binaires.
407
<VarListEntry><term>SrcOverride</term>
409
Indique le fichier d'� override � pour les sources.
411
<VarListEntry><term>ExtraOverride</term>
413
Indique le fichier suppl�mentaire d'� override � pour les binaires.
416
<VarListEntry><term>SrcExtraOverride</term>
418
Indique le fichier suppl�mentaire d'� override � pour les sources.
421
<VarListEntry><term>BinCacheDB</term>
423
Indique une base de donn�es cache.
426
<VarListEntry><term>PathPrefix</term>
428
Ajoute un chemin � tous les chemins cr��s.
431
<VarListEntry><term>FileList, SourceFileList</term>
433
Indique le fichier contenant la liste des fichiers.
439
<RefSect1><Title>Le fichier d'� Override � pour les binaires.</>
441
Le fichier d'� Override � est pleinement compatible avec
442
&dpkg-scanpackages;. Il contient quatre champs s�par�s par des espaces. Le
443
premier est le nom du paquet ; le deuxi�me est la priorit� � donner � ce
444
paquet ; le troisi�me est sa section et le dernier champ est un champ
445
pour changer le nom du responsable de paquet.
447
Le champ du responsable est de cette forme :
448
<literallayout>old [// oldn]* => new</literallayout>
450
<literallayout>new</literallayout>
451
La premi�re forme permet de sp�cifier de vieilles adresses dans une liste (le
452
s�parateur est la double barre oblique). Si l'une de ces deux formes est
453
rencontr�e, la valeur de new remplace la valeur du champ. La deuxi�me forme
454
remplace inconditionnellement le champ.
457
<RefSect1><title>Le fichier d'� Override � pour les sources</>
459
Le fichier d'� Override � est pleinement compatible avec
460
&dpkg-scansources;. Il contient deux champs. Le premier est le nom du paquet
461
source ; le second, sa section.
464
<RefSect1><title>Le fichier suppl�mentaire d'� Override �</>
466
Le fichier suppl�mentaire d'� Override � permet d'ajouter ou de
467
remplacer des �tiquettes sur la sortie. Il poss�de trois colonnes :
468
la premi�re repr�sente le paquet, la seconde est une �tiquette et la
469
troisi�me en fin de ligne est la nouvelle valeur.
472
<RefSect1><Title>Les options</>
476
<VarListEntry><term><option/--md5/</>
478
Cr�er la somme de contr�le MD5. Cette option est activ�e par d�faut. Quand
479
elle est d�sactiv�e, les fichiers d'index n'ont pas les champs MD5Sum l� o�
481
�l�ment de configuration : <literal/APT::FTPArchive::MD5/.
484
<VarListEntry><term><option/-d/</><term><option/--db/</>
486
Utiliser une base de donn�es binaire pour cache. Cela n'a aucun effet sur la
488
�l�ment de configuration : <literal/APT::FTPArchive::DB/.
491
<VarListEntry><term><option/-q/</><term><option/--quiet/</>
493
Mode silencieux ; cette commande produit une sortie destin�e �
494
l'enregistrement dans un fichier-journal en omettant les indicateurs de
495
progression. Un plus grand nombre de � q � (2 au plus) produit un
497
On peut aussi utiliser <option/-q=#/ pour positionner le niveau de silence,
498
et annuler le fichier de configuration.
499
�l�ment de configuration : <literal/quiet/.
502
<VarListEntry><term><option/--delink/</>
504
Faire une d�liaison. Si <literal/External-Links/ est activ�, cette option
505
permet r�ellement la d�liaison des fichiers. Par d�faut, elle est activ�e mais
506
elle peut �tre d�sactiv�e avec l'option <option/--no-delink/.
507
�l�ment de configuration : <literal/APT::FTPArchive::DeLinkAct/.
510
<VarListEntry><term><option/--contents/</>
512
Permettre la cr�ation d'un fichier � Contents �. Quand cette option
513
est activ�e et que les index sont cr��s sous forme de base de donn�es binaire,
514
la liste des fichiers est aussi extraite et conserv�e dans la base de donn�es
515
pour un usage futur. Avec la commande generate, cette option permet la
516
cr�ation de fichiers � Contents �. Par d�faut, elle est activ�e.
517
�l�ment de configuration : <literal/APT::FTPArchive::Contents/.
520
<VarListEntry><term><option/-s/</><term><option/--source-override/</>
522
Indique le fichier d'� override � � utiliser avec la commande
524
�l�ment de configuration : <literal/APT::FTPArchive::SourceOverride/.
527
<VarListEntry><term><option/--readonly/</>
529
N'autoriser que la lecture pour les bases de donn�es de cache.
530
�l�ment de configuration : <literal/APT::FTPArchive::ReadOnlyDB/.
538
<RefSect1><Title>Voir aussi</>
543
<RefSect1><Title>Diagnostics</>
545
<command/apt-ftparchive/ retourne z�ro si tout se passe bien, le nombre
546
d�cimal 100 en cas d'erreur.
added
removed
doc/fr/apt-ftparchive.fr.1.sgml
