summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/apt-ftparchive.1.sgml20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/apt-ftparchive.1.sgml b/doc/apt-ftparchive.1.sgml
index 84c26d3c7..220c4a96c 100644
--- a/doc/apt-ftparchive.1.sgml
+++ b/doc/apt-ftparchive.1.sgml
@@ -35,6 +35,7 @@
<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>
@@ -99,6 +100,25 @@
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