<arg>packages<arg choice="plain" rep="repeat"><replaceable>path</replaceable></arg><arg><replaceable>override</replaceable><arg><replaceable>pathprefix</replaceable></arg></arg></arg>
<arg>sources<arg choice="plain" rep="repeat"><replaceable>path</replaceable></arg><arg><replaceable>override</replaceable><arg><replaceable>pathprefix</replaceable></arg></arg></arg>
<arg>contents <arg choice="plain"><replaceable>path</replaceable></arg></arg>
+ <arg>release <arg choice="plain"><replaceable>path</replaceable></arg></arg>
<arg>generate <arg choice="plain"><replaceable>config-file</replaceable></arg> <arg choice="plain" rep="repeat"><replaceable>section</replaceable></arg></arg>
<arg>clean <arg choice="plain"><replaceable>config-file</replaceable></arg></arg>
</group>
<para>
<command/apt-ftparchive/ is a superset of the &dpkg-scanpackages; program,
- incorporating it's entire functionality via the <literal/directory/ command.
+ incorporating its entire functionality via the <literal/packages/ command.
It also contains a contents file generator, <literal/contents/, and an
elaborate means to 'script' the generation process for a complete
archive.
performs file-change checks and builds the desired compressed output files.
<para>
- Unless the <option/-h/, or <option/--help/ option is given one of the above
- commands must be present.
+ Unless the <option/-h/, or <option/--help/ option is given one of the
+ commands below must be present.
<VariableList>
<VarListEntry><term>packages</term>
The option <option/--db/ can be used to specify a binary caching DB.
</VarListEntry>
+ <VarListEntry><term>release</term>
+ <ListItem><Para>
+ The <literal/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.
+ <para>
+ Values for the additional metadata fields in the Release file are
+ taken from the corresponding variables under
+ <literal/APT::FTPArchive::Release/,
+ e.g. <literal/APT::FTPArchive::Release::Origin/. The supported fields
+ are: <literal/Origin/, <literal/Label/, <literal/Suite/,
+ <literal/Version/, <literal/Codename/, <literal/Date/,
+ <literal/Architectures/, <literal/Components/, <literal/Description/.
+
+ </VarListEntry>
+
<VarListEntry><term>generate</term>
<ListItem><Para>
The <literal/generate/ command is designed to be runnable from a cron script and
The <literal/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.
- &apt-conf; contains a decsription of the syntax. Note that the generate
+ &apt-conf; contains a description of the syntax. Note that the generate
configuration is parsed in sectional manner, but &apt-conf; is parsed in a
tree manner. This only effects how the scope tag is handled.
<para>
- The generate configuration has 4 separate sections, each decribed below.
+ The generate configuration has 4 separate sections, each described below.
<refsect2><title>Dir Section</>
<Para>
<refsect2><title>TreeDefault Section</>
<para>
- Sets defaults specific to <literal/Tree/ sections. All of these
+ Sets defaults specific to <literal/Tree/ sections. All of these
variables are substitution variables and have the strings $(DIST),
$(SECTION) and $(ARCH) replaced with their respective values.
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
- [overried edit for instance]. A hold off is allowed in hopes that new
+ [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.
</VarListEntry>
<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</>
</VarListEntry>
+ <VarListEntry><term>SrcDirectory</term>
+ <ListItem><Para>
+ Sets the top of the source package directory tree. Defaults to
+ <filename>$(DIST)/$(SECTION)/source/</>
+ </VarListEntry>
+
<VarListEntry><term>Packages</term>
<ListItem><Para>
Sets the output Packages file. Defaults to
<VarListEntry><term>FileList</term>
<ListItem><Para>
- Specifies that instead of walking the directory tree
- that <command/apt-ftparchive/ should read the list of files from the given
+ Specifies that instead of walking the directory tree,
+ <command/apt-ftparchive/ should read the list of files from the given
file. Relative files names are prefixed with the archive directory.
</VarListEntry>
<VarListEntry><term>SourceFileList</term>
<ListItem><Para>
- Specifies that instead of walking the directory tree
- that <command/apt-ftparchive/ should read the list of files from the given
+ Specifies that instead of walking the directory tree,
+ <command/apt-ftparchive/ 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.
</VarListEntry>
<VarListEntry><term>Architectures</term>
<ListItem><Para>
This is a space separated list of all the
- architectures that appear under seach section. The special architecture
+ architectures that appear under search section. The special architecture
'source' is used to indicate that this tree has a source archive.
</VarListEntry>
Sets the binary override file. The override file
contains section, priority and maintainer address information.
</VarListEntry>
-
+
<VarListEntry><term>SrcOverride</term>
<ListItem><Para>
Sets the source override file. The override file
contains section information.
</VarListEntry>
+
+ <VarListEntry><term>ExtraOverride</term>
+ <ListItem><Para>
+ Sets the binary extra override file.
+ </VarListEntry>
+
+ <VarListEntry><term>SrcExtraOverride</term>
+ <ListItem><Para>
+ Sets the source extra override file.
+ </VarListEntry>
</VariableList>
</refsect2>
Sets the Contents file output. (Optional)
</VarListEntry>
- <VarListEntry><term>Binoverride</term>
+ <VarListEntry><term>BinOverride</term>
<ListItem><Para>
Sets the binary override file.
</VarListEntry>
Sets the source override file.
</VarListEntry>
+ <VarListEntry><term>ExtraOverride</term>
+ <ListItem><Para>
+ Sets the binary extra override file.
+ </VarListEntry>
+
+ <VarListEntry><term>SrcExtraOverride</term>
+ <ListItem><Para>
+ Sets the source extra override file.
+ </VarListEntry>
+
<VarListEntry><term>BinCacheDB</term>
<ListItem><Para>
Sets the cache DB.
<RefSect1><Title>The Binary Override File</>
<para>
The binary override file is fully compatible with &dpkg-scanpackages;. It
- contains 4 fields sperated by spaces. The first field is the package name,
+ 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.
package name, the second is the section to assign it.
</RefSect1>
+ <RefSect1><title>The Extra Override File</>
+ <para>
+ 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.
+ </RefSect1>
+
<RefSect1><Title>Options</>
&apt-cmdblurb;
</VariableList>
</RefSect1>
+<RefSect1><Title>Examples</>
+
+<para>To create a compressed Packages file for a directory containing
+binary packages (.deb):
+
+<programlisting
+<command/apt-ftparchive/ packages <replaceable/directory/ | <command/gzip/ > <filename/Packages.gz/
+</programlisting>
+
+</RefSect1>
+
<RefSect1><Title>See Also</>
<para>
&apt-conf;
projects / apt.git / blobdiff