~jr/ubuntu/oneiric/apt/bzr-get-rename

« back to all changes in this revision

Viewing changes to doc/apt-ftparchive.1

  • Committer: Bazaar Package Importer
  • Author(s): Matt Zimmerman
  • Date: 2005-03-07 20:08:33 UTC
  • Revision ID: james.westby@ubuntu.com-20050307200833-0lxdgg2cb4oculdv
Tags: 0.6.35
* Merge apt--mvo--0 (incorporates 0.6.34ubuntu1):
  - Implement MaxSize and MaxAge in apt.cron.daily, to prevent the cache
    from growing too large (Ubuntu #6761)
  - some comments about the pkgAcqMetaSig::Custom600Headers() added
  - use gpg --with-colons
  - commented the ftp no_proxy unseting in methods/ftp.cc
  - added support for "Acquire::gpgv::options" in methods/gpgv.cc
* Merge bubulle@debian.org--2005/apt--main--0
  - Make capitalization more consistent
  - Un-fuzzy translations resulting from capitalization changes
  - Italian translation update

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\" This manpage has been automatically generated by docbook2man-spec
2
 
.\" from a DocBook document.  docbook2man-spec can be found at:
3
 
.\" <http://shell.ipoline.com/~elmert/hacks/docbook2X/> 
4
 
.\" Please send any bug reports, improvements, comments, patches, 
5
 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
6
 
.TH "APT-FTPARCHIVE" "1" "12 March 2001" "" ""
 
1
.\"Generated by db2man.xsl. Don't modify this, modify the source.
 
2
.de Sh \" Subsection
 
3
.br
 
4
.if t .Sp
 
5
.ne 5
 
6
.PP
 
7
\fB\\$1\fR
 
8
.PP
 
9
..
 
10
.de Sp \" Vertical space (when we can't use .PP)
 
11
.if t .sp .5v
 
12
.if n .sp
 
13
..
 
14
.de Ip \" List item
 
15
.br
 
16
.ie \\n(.$>=3 .ne \\$3
 
17
.el .ne 3
 
18
.IP "\\$1" \\$2
 
19
..
 
20
.TH "APT-FTPARCHIVE" 1 "29 February 2004" "Linux" ""
7
21
.SH NAME
8
22
apt-ftparchive \- Utility to generate index files
9
 
.SH SYNOPSIS
10
 
.sp
11
 
\fBapt-ftparchive\fR [ \fB-hvdsq\fR ]  [ \fB--md5\fR ]  [ \fB--delink\fR ]  [ \fB--readonly\fR ]  [ \fB--contents\fR ]  [ \fB-o=\fIconfig string\fB\fR ]  [ \fB-c=\fIfile\fB\fR ]  \fB [ packages \fIpath\fB\fI...\fB [ \fIoverride\fB [ \fIpathprefix\fB ]  ]  ]  [ sources \fIpath\fB\fI...\fB [ \fIoverride\fB [ \fIpathprefix\fB ]  ]  ]  [ contents  \fIpath\fB ]  [ generate  \fIconfig-file\fB  \fIsection\fB\fI...\fB ]  [ clean  \fIconfig-file\fB ] \fR
 
23
.SH "SYNOPSIS"
 
24
.ad l
 
25
.hy 0
 
26
.HP 15
 
27
\fBapt\-ftparchive\fR [\fB\-hvdsq\fR] [\fB\-\-md5\fR] [\fB\-\-delink\fR] [\fB\-\-readonly\fR] [\fB\-\-contents\fR] [\fB\-o=\fIconfig\ string\fR\fR] [\fB\-c=\fIfile\fR\fR] {\fBpackages\ \fIpath\fR...\ [\fIoverride\fR\ [\fIpathprefix\fR]]\fR | \fBsources\ \fIpath\fR...\ [\fIoverride\fR\ [\fIpathprefix\fR]]\fR | \fBcontents\ \fIpath\fR\fR | \fBrelease\ \fIpath\fR\fR | \fBgenerate\ \fIconfig\-file\fR\ \fIsection\fR...\fR | \fBclean\ \fIconfig\-file\fR\fR}
 
28
.ad
 
29
.hy
 
30
 
12
31
.SH "DESCRIPTION"
13
 
.PP
14
 
\fBapt-ftparchive\fR is the command line tool that generates the index 
15
 
files that APT uses to access a distribution source. The index files should 
16
 
be generated on the origin site based on the content of that site.
17
 
.PP
18
 
\fBapt-ftparchive\fR is a superset of the \fBdpkg-scanpackages\fR(8) program,
19
 
incorporating it's entire functionality via the directory command.
20
 
It also contains a contents file generator, contents, and an 
21
 
elaborate means to 'script' the generation process for a complete 
22
 
archive.
23
 
.PP
24
 
Internally \fBapt-ftparchive\fR can make use of binary databases to 
25
 
cache the contents of a .deb file and it does not rely on any external 
26
 
programs aside from \fBgzip\fR(1). When doing a full generate it automatically 
27
 
performs file-change checks and builds the desired compressed output files.
28
 
.PP
29
 
Unless the \fB-h\fR, or \fB--help\fR option is given one of the
30
 
commands below must be present.
31
 
.TP
32
 
\fBpackages\fR
33
 
The packages command generates a package file from a directory tree. It
34
 
takes the given directory and recursively searches it for .deb files, 
35
 
emitting a package record to stdout for each. This command is 
36
 
approximately equivalent to \fBdpkg-scanpackages\fR(8).
37
 
 
38
 
The option \fB--db\fR can be used to specify a binary caching DB.
39
 
.TP
40
 
\fBsources\fR
41
 
The sources command generates a source index file from a directory tree. 
42
 
It takes the given directory and recursively searches it for .dsc files,
43
 
emitting a source record to stdout for each. This command is approximately
44
 
equivalent to \fBdpkg-scansources\fR(8).
45
 
 
46
 
If an override file is specified then a source override file will be 
47
 
looked for with an extension of .src. The --source-override option can be 
48
 
used to change the source override file that will be used.
49
 
.TP
50
 
\fBcontents\fR
51
 
The contents command generates a contents file from a directory tree. It
52
 
takes the given directory and recursively searches it for .deb files, 
53
 
and reads the file list from each file. It then sorts and writes to stdout
54
 
the list of files matched to packages. Directories are not written to 
55
 
the output. If multiple packages own the same file then each package is
56
 
separated by a comma in the output.
57
 
 
58
 
The option \fB--db\fR can be used to specify a binary caching DB.
59
 
.TP
60
 
\fBgenerate\fR
61
 
The generate command is designed to be runnable from a cron script and
62
 
builds indexes according to the given config file. The config language
63
 
provides a flexible means of specifying which index files are built from 
64
 
which directories, as well as providing a simple means of maintaining the
65
 
required settings.
66
 
.TP
67
 
\fBclean\fR
68
 
The clean command tidies the databases used by the given 
69
 
configuration file by removing any records that are no longer necessary.
70
 
.PP
 
32
 
 
33
.PP
 
34
\fBapt\-ftparchive\fR is the command line tool that generates the index files that APT uses to access a distribution source\&. The index files should be generated on the origin site based on the content of that site\&.
 
35
 
 
36
.PP
 
37
\fBapt\-ftparchive\fR is a superset of the \fB\fBdpkg\-scanpackages\fR\fR(8) program, incorporating its entire functionality via the packages command\&. It also contains a contents file generator, contents, and an elaborate means to 'script' the generation process for a complete archive\&.
 
38
 
 
39
.PP
 
40
Internally \fBapt\-ftparchive\fR can make use of binary databases to cache the contents of a \&.deb file and it does not rely on any external programs aside from \fB\fBgzip\fR\fR(1)\&. When doing a full generate it automatically performs file\-change checks and builds the desired compressed output files\&.
 
41
 
 
42
.PP
 
43
Unless the \fB\-h\fR, or \fB\-\-help\fR option is given one of the commands below must be present\&.
 
44
 
 
45
.TP
 
46
packages
 
47
The packages command generates a package file from a directory tree\&. It takes the given directory and recursively searches it for \&.deb files, emitting a package record to stdout for each\&. This command is approximately equivalent to \fB\fBdpkg\-scanpackages\fR\fR(8)\&.
 
48
 
 
49
The option \fB\-\-db\fR can be used to specify a binary caching DB\&.
 
50
 
 
51
.TP
 
52
sources
 
53
The sources command generates a source index file from a directory tree\&. It takes the given directory and recursively searches it for \&.dsc files, emitting a source record to stdout for each\&. This command is approximately equivalent to \fB\fBdpkg\-scansources\fR\fR(8)\&.
 
54
 
 
55
If an override file is specified then a source override file will be looked for with an extension of \&.src\&. The \-\-source\-override option can be used to change the source override file that will be used\&.
 
56
 
 
57
.TP
 
58
contents
 
59
The contents command generates a contents file from a directory tree\&. It takes the given directory and recursively searches it for \&.deb files, and reads the file list from each file\&. It then sorts and writes to stdout the list of files matched to packages\&. Directories are not written to the output\&. If multiple packages own the same file then each package is separated by a comma in the output\&.
 
60
 
 
61
The option \fB\-\-db\fR can be used to specify a binary caching DB\&.
 
62
 
 
63
.TP
 
64
release
 
65
The release command generates a Release file from a directory tree\&. It recursively searches the given directory for Packages, Packages\&.gz, Packages\&.bz2, Sources, Sources\&.gz, Sources\&.bz2, Release and md5sum\&.txt files\&. It then writes to stdout a Release file containing an MD5 digest and SHA1 digest for each file\&.
 
66
 
 
67
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, Architectures, Components, Description\&.
 
68
 
 
69
.TP
 
70
generate
 
71
The generate command is designed to be runnable from a cron script and builds indexes according to the given config file\&. The config language provides a flexible means of specifying which index files are built from which directories, as well as providing a simple means of maintaining the required settings\&.
 
72
 
 
73
.TP
 
74
clean
 
75
The clean command tidies the databases used by the given configuration file by removing any records that are no longer necessary\&.
 
76
 
71
77
.SH "THE GENERATE CONFIGURATION"
72
 
.PP
73
 
The generate command uses a configuration file to describe the 
74
 
archives that are going to be generated. It follows the typical ISC 
75
 
configuration format as seen in ISC tools like bind 8 and dhcpd. 
76
 
\fB\fIapt.conf\fB\fR(5) contains a description of the syntax. Note that the generate 
77
 
configuration is parsed in sectional manner, but \fB\fIapt.conf\fB\fR(5) is parsed in a
78
 
tree manner. This only effects how the scope tag is handled.
79
 
.PP
80
 
The generate configuration has 4 separate sections, each decribed below.
81
 
.SS "DIR SECTION"
82
 
.PP
83
 
The Dir section defines the standard directories needed to 
84
 
locate the files required during the generation process. These 
85
 
directories are prepended to certain relative paths defined in later 
86
 
sections to produce a complete an absolute path.
87
 
.TP
88
 
\fBArchiveDir\fR
89
 
Specifies the root of the FTP archive, in a standard
90
 
Debian configuration this is the directory that contains the 
91
 
\fIls-LR\fR, and dist nodes.
92
 
.TP
93
 
\fBOverrideDir\fR
94
 
Specifies the location of the override files.
95
 
.TP
96
 
\fBCacheDir\fR
 
78
 
 
79
.PP
 
80
The generate command uses a configuration file to describe the archives that are going to be generated\&. It follows the typical ISC configuration format as seen in ISC tools like bind 8 and dhcpd\&. \fB\fIapt\&.conf\fR\fR(5) contains a description of the syntax\&. Note that the generate configuration is parsed in sectional manner, but \fB\fIapt\&.conf\fR\fR(5) is parsed in a tree manner\&. This only effects how the scope tag is handled\&.
 
81
 
 
82
.PP
 
83
The generate configuration has 4 separate sections, each described below\&.
 
84
 
 
85
.SS "Dir Section"
 
86
 
 
87
.PP
 
88
The Dir section defines the standard directories needed to locate the files required during the generation process\&. These directories are prepended to certain relative paths defined in later sections to produce a complete an absolute path\&.
 
89
 
 
90
.TP
 
91
ArchiveDir
 
92
Specifies the root of the FTP archive, in a standard Debian configuration this is the directory that contains the \fIls\-LR\fR and dist nodes\&.
 
93
 
 
94
.TP
 
95
OverrideDir
 
96
Specifies the location of the override files\&.
 
97
 
 
98
.TP
 
99
CacheDir
97
100
Specifies the location of the cache files
98
 
.TP
99
 
\fBFileListDir\fR
100
 
Specifies the location of the file list files, 
101
 
if the FileList setting is used below.
102
 
.PP
103
 
.SS "DEFAULT SECTION"
104
 
.PP
105
 
The Default section specifies default values, and settings 
106
 
that control the operation of the generator. Other sections may override 
107
 
these defaults with a per-section setting.
108
 
.TP
109
 
\fBPackages::Compress\fR
110
 
Sets the default compression schemes to use 
111
 
for the Package index files. It is a string that contains a space 
112
 
separated list of at least one of: '.' (no compression), 'gzip' and 
113
 
\&'bzip2'. The default for all compression schemes is '. gzip'.
114
 
.TP
115
 
\fBPackages::Extensions\fR
116
 
Sets the default list of file extensions that are package files.
117
 
This defaults to '.deb'.
118
 
.TP
119
 
\fBSources::Compress\fR
120
 
This is similar to Packages::Compress 
121
 
except that it controls the compression for the Sources files.
122
 
.TP
123
 
\fBSources::Extensions\fR
124
 
Sets the default list of file extensions that are source files.
125
 
This defaults to '.dsc'.
126
 
.TP
127
 
\fBContents::Compress\fR
128
 
This is similar to Packages::Compress 
129
 
except that it controls the compression for the Contents files.
130
 
.TP
131
 
\fBDeLinkLimit\fR
132
 
Specifies the number of kilobytes to delink (and 
133
 
replace with hard links) per run. This is used in conjunction with the 
134
 
per-section External-Links setting. 
135
 
.TP
136
 
\fBFileMode\fR
137
 
Specifies the mode of all created index files. It 
138
 
defaults to 0644. All index files are set to this mode with no regard 
139
 
to the umask.
140
 
.PP
141
 
.SS "TREEDEFAULT SECTION"
142
 
.PP
143
 
Sets defaults specific to Tree sections. All of these
144
 
variables are substitution variables and have the strings $(DIST), 
145
 
$(SECTION) and $(ARCH) replaced with their respective values.
146
 
.TP
147
 
\fBMaxContentsChange\fR
148
 
Sets the number of kilobytes of contents 
149
 
files that are generated each day. The contents files are round-robined
150
 
so that over several days they will all be rebuilt.
151
 
.TP
152
 
\fBContentsAge\fR
153
 
Controls the number of days a contents file is allowed
154
 
to be checked without changing. If this limit is passed the mtime of the 
155
 
contents file is updated. This case can occur if the package file is 
156
 
changed in such a way that does not result in a new contents file 
157
 
[overried edit for instance]. A hold off is allowed in hopes that new 
158
 
\&.debs will be installed, requiring a new file anyhow. The default is 10, 
159
 
the units are in days.
160
 
.TP
161
 
\fBDirectory\fR
162
 
Sets the top of the .deb directory tree. Defaults to
163
 
\fI$(DIST)/$(SECTION)/binary-$(ARCH)/\fR
164
 
.TP
165
 
\fBPackages\fR
166
 
Sets the output Packages file. Defaults to 
167
 
\fI$(DIST)/$(SECTION)/binary-$(ARCH)/Packages\fR
168
 
.TP
169
 
\fBSources\fR
170
 
Sets the output Packages file. Defaults to 
171
 
\fI$(DIST)/$(SECTION)/source/Sources\fR
172
 
.TP
173
 
\fBInternalPrefix\fR
174
 
Sets the path prefix that causes a symlink to be
175
 
considered an internal link instead of an external link. Defaults to
176
 
\fI$(DIST)/$(SECTION)/\fR
177
 
.TP
178
 
\fBContents\fR
179
 
Sets the output Contents file. Defaults to
180
 
\fI$(DIST)/Contents-$(ARCH)\fR. If this setting causes multiple 
181
 
Packages files to map onto a single Contents file (such as the default) 
182
 
then \fBapt-ftparchive\fR will integrate those package files 
183
 
together automatically.
184
 
.TP
185
 
\fBContents::Header\fR
186
 
Sets header file to prepend to the contents output.
187
 
.TP
188
 
\fBBinCacheDB\fR
189
 
Sets the binary cache database to use for this 
190
 
section. Multiple sections can share the same database.
191
 
.TP
192
 
\fBFileList\fR
193
 
Specifies that instead of walking the directory tree, 
194
 
\fBapt-ftparchive\fR should read the list of files from the given 
195
 
file. Relative files names are prefixed with the archive directory.
196
 
.TP
197
 
\fBSourceFileList\fR
198
 
Specifies that instead of walking the directory tree, 
199
 
\fBapt-ftparchive\fR should read the list of files from the given 
200
 
file. Relative files names are prefixed with the archive directory. 
201
 
This is used when processing source indexs.
202
 
.PP
203
 
.SS "TREE SECTION"
204
 
.PP
205
 
The Tree section defines a standard Debian file tree which 
206
 
consists of a base directory, then multiple sections in that base 
207
 
directory and finally multiple Architectures in each section. The exact 
208
 
pathing used is defined by the Directory substitution variable. 
209
 
.PP
210
 
The Tree section takes a scope tag which sets the 
211
 
$(DIST) variable and defines the root of the tree 
212
 
(the path is prefixed by ArchiveDir).
213
 
Typically this is a setting such as \fIdists/woody\fR.
214
 
.PP
215
 
All of the settings defined in the TreeDefault section can be
216
 
use in a Tree section as well as three new variables.
217
 
.PP
218
 
When processing a Tree section \fBapt-ftparchive\fR 
219
 
performs an operation similar to:
220
 
.PP
221
 
.sp
222
 
.nf
223
 
for i in Sections do 
224
 
   for j in Architectures do
225
 
      Generate for DIST=scope SECTION=i ARCH=j
226
 
.sp
227
 
.fi
228
 
.TP
229
 
\fBSections\fR
230
 
This is a space separated list of sections which appear 
231
 
under the distribution, typically this is something like 
232
 
main contrib non-free.
233
 
.TP
234
 
\fBArchitectures\fR
235
 
This is a space separated list of all the 
236
 
architectures that appear under seach section. The special architecture 
237
 
\&'source' is used to indicate that this tree has a source archive.
238
 
.TP
239
 
\fBBinOverride\fR
240
 
Sets the binary override file. The override file 
241
 
contains section, priority and maintainer address information.
242
 
.TP
243
 
\fBSrcOverride\fR
244
 
Sets the source override file. The override file 
245
 
contains section information.
246
 
.TP
247
 
\fBExtraOverride\fR
248
 
Sets the binary extra override file. 
249
 
.TP
250
 
\fBSrcExtraOverride\fR
251
 
Sets the source extra override file. 
252
 
.PP
253
 
.SS "BINDIRECTORY SECTION"
254
 
.PP
255
 
The bindirectory section defines a binary directory tree 
256
 
with no special structure. The scope tag specifies the location of 
257
 
the binary directory and the settings are similar to the Tree 
258
 
section with no substitution variables or
259
 
SectionArchitecture settings.
260
 
.TP
261
 
\fBPackages\fR
262
 
Sets the Packages file output.
263
 
.TP
264
 
\fBSrcPackages\fR
265
 
Sets the Sources file output. At least one of
266
 
Packages or SrcPackages is required.
267
 
.TP
268
 
\fBContents\fR
269
 
Sets the Contents file output. (Optional)
270
 
.TP
271
 
\fBBinOverride\fR
272
 
Sets the binary override file.
273
 
.TP
274
 
\fBSrcOverride\fR
275
 
Sets the source override file.
276
 
.TP
277
 
\fBExtraOverride\fR
278
 
Sets the binary extra override file.
279
 
.TP
280
 
\fBSrcExtraOverride\fR
281
 
Sets the source extra override file.
282
 
.TP
283
 
\fBBinCacheDB\fR
284
 
Sets the cache DB.
285
 
.TP
286
 
\fBPathPrefix\fR
287
 
Appends a path to all the output paths.
288
 
.TP
289
 
\fBFileList, SourceFileList\fR
290
 
Specifies the file list file.
291
 
.PP
 
101
 
 
102
.TP
 
103
FileListDir
 
104
Specifies the location of the file list files, if the FileList setting is used below\&.
 
105
 
 
106
.SS "Default Section"
 
107
 
 
108
.PP
 
109
The Default section specifies default values, and settings that control the operation of the generator\&. Other sections may override these defaults with a per\-section setting\&.
 
110
 
 
111
.TP
 
112
Packages::Compress
 
113
Sets the default compression schemes to use for the Package index files\&. It is a string that contains a space separated list of at least one of: '\&.' (no compression), 'gzip' and 'bzip2'\&. The default for all compression schemes is '\&. gzip'\&.
 
114
 
 
115
.TP
 
116
Packages::Extensions
 
117
Sets the default list of file extensions that are package files\&. This defaults to '\&.deb'\&.
 
118
 
 
119
.TP
 
120
Sources::Compress
 
121
This is similar to Packages::Compress except that it controls the compression for the Sources files\&.
 
122
 
 
123
.TP
 
124
Sources::Extensions
 
125
Sets the default list of file extensions that are source files\&. This defaults to '\&.dsc'\&.
 
126
 
 
127
.TP
 
128
Contents::Compress
 
129
This is similar to Packages::Compress except that it controls the compression for the Contents files\&.
 
130
 
 
131
.TP
 
132
DeLinkLimit
 
133
Specifies the number of kilobytes to delink (and replace with hard links) per run\&. This is used in conjunction with the per\-section External\-Links setting\&.
 
134
 
 
135
.TP
 
136
FileMode
 
137
Specifies the mode of all created index files\&. It defaults to 0644\&. All index files are set to this mode with no regard to the umask\&.
 
138
 
 
139
.SS "TreeDefault Section"
 
140
 
 
141
.PP
 
142
Sets defaults specific to Tree sections\&. All of these variables are substitution variables and have the strings $(DIST), $(SECTION) and $(ARCH) replaced with their respective values\&.
 
143
 
 
144
.TP
 
145
MaxContentsChange
 
146
Sets the number of kilobytes of contents files that are generated each day\&. The contents files are round\-robined so that over several days they will all be rebuilt\&.
 
147
 
 
148
.TP
 
149
ContentsAge
 
150
Controls the number of days a contents file is allowed to be checked without changing\&. If this limit is passed the mtime of the contents file is updated\&. This case can occur if the package file is changed in such a way that does not result in a new contents file [override edit for instance]\&. A hold off is allowed in hopes that new \&.debs will be installed, requiring a new file anyhow\&. The default is 10, the units are in days\&.
 
151
 
 
152
.TP
 
153
Directory
 
154
Sets the top of the \&.deb directory tree\&. Defaults to \fI$(DIST)/$(SECTION)/binary\-$(ARCH)/\fR
 
155
 
 
156
.TP
 
157
SrcDirectory
 
158
Sets the top of the source package directory tree\&. Defaults to \fI$(DIST)/$(SECTION)/source/\fR
 
159
 
 
160
.TP
 
161
Packages
 
162
Sets the output Packages file\&. Defaults to \fI$(DIST)/$(SECTION)/binary\-$(ARCH)/Packages\fR
 
163
 
 
164
.TP
 
165
Sources
 
166
Sets the output Packages file\&. Defaults to \fI$(DIST)/$(SECTION)/source/Sources\fR
 
167
 
 
168
.TP
 
169
InternalPrefix
 
170
Sets the path prefix that causes a symlink to be considered an internal link instead of an external link\&. Defaults to \fI$(DIST)/$(SECTION)/\fR
 
171
 
 
172
.TP
 
173
Contents
 
174
Sets the output Contents file\&. Defaults to \fI$(DIST)/Contents\-$(ARCH)\fR\&. If this setting causes multiple Packages files to map onto a single Contents file (such as the default) then \fBapt\-ftparchive\fR will integrate those package files together automatically\&.
 
175
 
 
176
.TP
 
177
Contents::Header
 
178
Sets header file to prepend to the contents output\&.
 
179
 
 
180
.TP
 
181
BinCacheDB
 
182
Sets the binary cache database to use for this section\&. Multiple sections can share the same database\&.
 
183
 
 
184
.TP
 
185
FileList
 
186
Specifies that instead of walking the directory tree, \fBapt\-ftparchive\fR should read the list of files from the given file\&. Relative files names are prefixed with the archive directory\&.
 
187
 
 
188
.TP
 
189
SourceFileList
 
190
Specifies that instead of walking the directory tree, \fBapt\-ftparchive\fR should read the list of files from the given file\&. Relative files names are prefixed with the archive directory\&. This is used when processing source indexs\&.
 
191
 
 
192
.SS "Tree Section"
 
193
 
 
194
.PP
 
195
The Tree section defines a standard Debian file tree which consists of a base directory, then multiple sections in that base directory and finally multiple Architectures in each section\&. The exact pathing used is defined by the Directory substitution variable\&.
 
196
 
 
197
.PP
 
198
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 \fIdists/woody\fR\&.
 
199
 
 
200
.PP
 
201
All of the settings defined in the TreeDefault section can be use in a Tree section as well as three new variables\&.
 
202
 
 
203
.PP
 
204
When processing a Tree section \fBapt\-ftparchive\fR performs an operation similar to: .IP .nf for i in Sections do for j in Architectures do Generate for DIST=scope SECTION=i ARCH=j .fi
 
205
 
 
206
.TP
 
207
Sections
 
208
This is a space separated list of sections which appear under the distribution, typically this is something like main contrib non\-free
 
209
 
 
210
.TP
 
211
Architectures
 
212
This is a space separated list of all the architectures that appear under search section\&. The special architecture 'source' is used to indicate that this tree has a source archive\&.
 
213
 
 
214
.TP
 
215
BinOverride
 
216
Sets the binary override file\&. The override file contains section, priority and maintainer address information\&.
 
217
 
 
218
.TP
 
219
SrcOverride
 
220
Sets the source override file\&. The override file contains section information\&.
 
221
 
 
222
.TP
 
223
ExtraOverride
 
224
Sets the binary extra override file\&.
 
225
 
 
226
.TP
 
227
SrcExtraOverride
 
228
Sets the source extra override file\&.
 
229
 
 
230
.SS "BinDirectory Section"
 
231
 
 
232
.PP
 
233
The bindirectory section defines a binary directory tree with no special structure\&. The scope tag specifies the location of the binary directory and the settings are similar to the Tree section with no substitution variables or SectionArchitecture settings\&.
 
234
 
 
235
.TP
 
236
Packages
 
237
Sets the Packages file output\&.
 
238
 
 
239
.TP
 
240
SrcPackages
 
241
Sets the Sources file output\&. At least one of Packages or SrcPackages is required\&.
 
242
 
 
243
.TP
 
244
Contents
 
245
Sets the Contents file output\&. (optional)
 
246
 
 
247
.TP
 
248
BinOverride
 
249
Sets the binary override file\&.
 
250
 
 
251
.TP
 
252
SrcOverride
 
253
Sets the source override file\&.
 
254
 
 
255
.TP
 
256
ExtraOverride
 
257
Sets the binary extra override file\&.
 
258
 
 
259
.TP
 
260
SrcExtraOverride
 
261
Sets the source extra override file\&.
 
262
 
 
263
.TP
 
264
BinCacheDB
 
265
Sets the cache DB\&.
 
266
 
 
267
.TP
 
268
PathPrefix
 
269
Appends a path to all the output paths\&.
 
270
 
 
271
.TP
 
272
FileList, SourceFileList
 
273
Specifies the file list file\&.
 
274
 
292
275
.SH "THE BINARY OVERRIDE FILE"
293
 
.PP
294
 
The binary override file is fully compatible with \fBdpkg-scanpackages\fR(8). It
295
 
contains 4 fields separated by spaces. The first field is the package name,
296
 
the second is the priority to force that package to, the third is the
297
 
the section to force that package to and the final field is the maintainer 
298
 
permutation field. 
299
 
.PP
300
 
The general form of the maintainer field is:
301
 
.sp
 
276
 
 
277
.PP
 
278
The binary override file is fully compatible with \fB\fBdpkg\-scanpackages\fR\fR(8)\&. It contains 4 fields separated by spaces\&. The first field is the package name, the second is the priority to force that package to, the third is the the section to force that package to and the final field is the maintainer permutation field\&.
 
279
 
 
280
.PP
 
281
The general form of the maintainer field is: 
 
282
 
302
283
.nf
303
284
old [// oldn]* => new
304
 
.sp
305
285
.fi
306
 
or simply,
307
 
.sp
 
286
 or simply, 
 
287
 
308
288
.nf
309
289
new
310
 
.sp
311
290
.fi
312
 
The first form allows a double-slash separated list of old email addresses 
313
 
to be specified. If any of those are found then new is substituted for the 
314
 
maintainer field. The second form unconditionally substitutes the 
315
 
maintainer field.
 
291
 The first form allows a double\-slash separated list of old email addresses to be specified\&. If any of those are found then new is substituted for the maintainer field\&. The second form unconditionally substitutes the maintainer field\&.
 
292
 
316
293
.SH "THE SOURCE OVERRIDE FILE"
 
294
 
317
295
.PP
318
 
The source override file is fully compatible with \fBdpkg-scansources\fR(8). It
319
 
contains 2 fields separated by spaces. The first fields is the source 
320
 
package name, the second is the section to assign it.
 
296
The source override file is fully compatible with \fB\fBdpkg\-scansources\fR\fR(8)\&. It contains 2 fields separated by spaces\&. The first fields is the source package name, the second is the section to assign it\&.
 
297
 
321
298
.SH "THE EXTRA OVERRIDE FILE"
 
299
 
322
300
.PP
323
 
The extra override file allows any arbitary tag to be added or replaced
324
 
in the output. It has 3 columns, the first is the package, the second is
325
 
the tag and the remainder of the line is the new value.
 
301
The extra override file allows any arbitrary tag to be added or replaced in the output\&. It has 3 columns, the first is the package, the second is the tag and the remainder of the line is the new value\&.
 
302
 
326
303
.SH "OPTIONS"
327
 
.PP
328
 
All command line options may be set using the configuration file, the
329
 
descriptions indicate the configuration option to set. For boolean
330
 
options you can override the config file by using something like 
331
 
\fB-f-\fR,\fB--no-f\fR, \fB-f=no\fR or several other variations.
332
 
.TP
333
 
\fB--md5\fR
334
 
Generate MD5 sums. This defaults to on, when turned off the generated 
335
 
index files will not have MD5Sum fields where possible.
336
 
Configuration Item: APT::FTPArchive::MD5.
337
 
.TP
338
 
\fB-d\fR
339
 
.TP
340
 
\fB--db\fR
341
 
Use a binary caching DB. This has no effect on the generate command.
342
 
Configuration Item: APT::FTPArchive::DB.
343
 
.TP
344
 
\fB-q\fR
345
 
.TP
346
 
\fB--quiet\fR
347
 
Quiet; produces output suitable for logging, omitting progress indicators.
348
 
More q's will produce more quiet up to a maximum of 2. You can also use
349
 
\fB-q=#\fR to set the quiet level, overriding the configuration file. 
350
 
Configuration Item: quiet.
351
 
.TP
352
 
\fB--delink\fR
353
 
Perform Delinking. If the External-Links setting is used then 
354
 
this option actually enables delinking of the files. It defaults to on and 
355
 
can be turned off with \fB--no-delink\fR.
356
 
Configuration Item: APT::FTPArchive::DeLinkAct.
357
 
.TP
358
 
\fB--contents\fR
359
 
Perform contents generation. When this option is set and package indexes
360
 
are being generated with a cache DB then the file listing will also be
361
 
extracted and stored in the DB for later use. When using the generate 
362
 
command this option also allows the creation of any Contents files. The 
363
 
default is on.
364
 
Configuration Item: APT::FTPArchive::Contents.
365
 
.TP
366
 
\fB-s\fR
367
 
.TP
368
 
\fB--source-override\fR
369
 
Select the source override file to use with the sources command.
370
 
Configuration Item: APT::FTPArchive::SourceOverride.
371
 
.TP
372
 
\fB--readonly\fR
373
 
Make the caching databases read only. 
374
 
Configuration Item: APT::FTPArchive::ReadOnlyDB.
375
 
.TP
376
 
\fB-h\fR
377
 
.TP
378
 
\fB--help\fR
379
 
Show a short usage summary.
380
 
.TP
381
 
\fB-v\fR
382
 
.TP
383
 
\fB--version\fR
384
 
Show the program verison.
385
 
.TP
386
 
\fB-c\fR
387
 
.TP
388
 
\fB--config-file\fR
389
 
Configuration File; Specify a configuration file to use. 
390
 
The program will read the default configuration file and then this 
391
 
configuration file. See \fB\fIapt.conf\fB\fR(5) for syntax information. 
392
 
.TP
393
 
\fB-o\fR
394
 
.TP
395
 
\fB--option\fR
396
 
Set a Configuration Option; This will set an arbitary configuration 
397
 
option. The syntax is \fB-o Foo::Bar=bar\fR.
 
304
 
 
305
.PP
 
306
All command line options may be set using the configuration file, the descriptions indicate the configuration option to set\&. For boolean options you can override the config file by using something like \fB\-f\-\fR,\fB\-\-no\-f\fR, \fB\-f=no\fR or several other variations\&.
 
307
 
 
308
.TP
 
309
\fB\-\-md5\fR
 
310
Generate MD5 sums\&. This defaults to on, when turned off the generated index files will not have MD5Sum fields where possible\&. Configuration Item: APT::FTPArchive::MD5
 
311
 
 
312
.TP
 
313
\fB\-d\fR, \fB\-\-db\fR, 
 
314
Use a binary caching DB\&. This has no effect on the generate command\&. Configuration Item: APT::FTPArchive::DB\&.
 
315
 
 
316
.TP
 
317
\fB\-q\fR, \fB\-\-quiet\fR, 
 
318
Quiet; produces output suitable for logging, omitting progress indicators\&. More q's will produce more quiet up to a maximum of 2\&. You can also use \fB\-q=#\fR to set the quiet level, overriding the configuration file\&. Configuration Item: quiet\&.
 
319
 
 
320
.TP
 
321
\fB\-\-delink\fR
 
322
Perform Delinking\&. If the External\-Links setting is used then this option actually enables delinking of the files\&. It defaults to on and can be turned off with \fB\-\-no\-delink\fR\&. Configuration Item: APT::FTPArchive::DeLinkAct\&.
 
323
 
 
324
.TP
 
325
\fB\-\-contents\fR
 
326
Perform contents generation\&. When this option is set and package indexes are being generated with a cache DB then the file listing will also be extracted and stored in the DB for later use\&. When using the generate command this option also allows the creation of any Contents files\&. The default is on\&. Configuration Item: APT::FTPArchive::Contents\&.
 
327
 
 
328
.TP
 
329
\fB\-s\fR, \fB\-\-source\-override\fR, 
 
330
Select the source override file to use with the sources command\&. Configuration Item: APT::FTPArchive::SourceOverride\&.
 
331
 
 
332
.TP
 
333
\fB\-\-readonly\fR
 
334
Make the caching databases read only\&. Configuration Item: APT::FTPArchive::ReadOnlyDB\&.
 
335
 
 
336
.TP
 
337
\fB\-h\fR, \fB\-\-help\fR, 
 
338
Show a short usage summary\&.
 
339
 
 
340
.TP
 
341
\fB\-v\fR, \fB\-\-version\fR, 
 
342
Show the program version\&.
 
343
 
 
344
.TP
 
345
\fB\-c\fR, \fB\-\-config\-file\fR, 
 
346
Configuration File; Specify a configuration file to use\&. The program will read the default configuration file and then this configuration file\&. See \fB\fIapt\&.conf\fR\fR(5) for syntax information\&.
 
347
 
 
348
.TP
 
349
\fB\-o\fR, \fB\-\-option\fR, 
 
350
Set a Configuration Option; This will set an arbitary configuration option\&. The syntax is \fB\-o Foo::Bar=bar\fR\&.
 
351
 
 
352
.SH "EXAMPLES"
 
353
 
 
354
.PP
 
355
To create a compressed Packages file for a directory containing binary packages (\&.deb): 
 
356
 
 
357
.nf
 
358
 
 
359
\fBapt\-ftparchive\fR packages \fIdirectory\fR | \fBgzip\fR > \fIPackages\&.gz\fR
 
360
 
 
361
.fi
 
362
 
 
363
 
398
364
.SH "SEE ALSO"
 
365
 
399
366
.PP
400
 
\fB\fIapt.conf\fB\fR(5)
 
367
\fB\fIapt\&.conf\fR\fR(5)
 
368
 
401
369
.SH "DIAGNOSTICS"
 
370
 
402
371
.PP
403
 
\fBapt-ftparchive\fR returns zero on normal operation, decimal 100 on error.
 
372
\fBapt\-ftparchive\fR returns zero on normal operation, decimal 100 on error\&.
 
373
 
404
374
.SH "BUGS"
405
 
.PP
406
 
See the APT bug page <URL:http://bugs.debian.org/apt>. 
407
 
If you wish to report a bug in APT, please see 
408
 
\fI/usr/share/doc/debian/bug-reporting.txt\fR or the \fBbug\fR(1) command.
409
 
.SH "AUTHOR"
410
 
.PP
411
 
APT was written by the APT team <apt@packages.debian.org>.
 
375
 
 
376
.PP
 
377
APT bug page: \fIhttp://bugs.debian.org/src:apt\fR\&. If you wish to report a bug in APT, please see \fI/usr/share/doc/debian/bug\-reporting\&.txt\fR or the \fB\fBreportbug\fR\fR(1) command\&.
 
378
 
 
379
.SH AUTHORS
 
380
Jason Gunthorpe, APT team.