X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/319810767180e5c57c296b06c93e3ebec9f36a8e..177645edb5775337ccf6d3971835a122b12318d4:/doc/apt-ftparchive.1.xml?ds=sidebyside
diff --git a/doc/apt-ftparchive.1.xml b/doc/apt-ftparchive.1.xml
index f88dbe631..93b109af1 100644
--- a/doc/apt-ftparchive.1.xml
+++ b/doc/apt-ftparchive.1.xml
@@ -5,6 +5,9 @@
<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;
+<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
+%aptverbatiment;
+
]>
<refentry>
@@ -30,29 +33,8 @@
<refpurpose>Utility to generate index files</refpurpose>
</refnamediv>
- <!-- Arguments -->
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>apt-ftparchive</command>
- <arg><option>-hvdsq</option></arg>
- <arg><option>--md5</option></arg>
- <arg><option>--delink</option></arg>
- <arg><option>--readonly</option></arg>
- <arg><option>--contents</option></arg>
- <arg><option>--arch <replaceable>architecture</replaceable></option></arg>
- <arg><option>-o <replaceable>config</replaceable>=<replaceable>string</replaceable></option></arg>
- <arg><option>-c=<replaceable>file</replaceable></option></arg>
- <group choice="req">
- <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>
- </cmdsynopsis>
- </refsynopsisdiv>
-
+ &synopsis-command-apt-ftparchive;
+
<refsect1><title>Description</title>
<para><command>apt-ftparchive</command> is the command line tool that generates the index
files that APT uses to access a distribution source. The index files should
@@ -110,10 +92,13 @@
<varlistentry><term>release</term>
<listitem><para>
The <literal>release</literal> 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
+ directory tree. It recursively searches the given directory for uncompressed
+ <filename>Packages</filename> and <filename>Sources</filename> files and the ones
+ compressed with <command>gzip</command>, <command>bzip2</command> or <command>lzma</command>
+ as well as <filename>Release</filename> and <filename>md5sum.txt</filename> files by default
+ (<literal>APT::FTPArchive::Release::Default-Patterns</literal>). Additional filename patterns
+ can be added by listing them in <literal>APT::FTPArchive::Release::Patterns</literal>.
+ It then writes to stdout a Release file containing a MD5, SHA1 and SHA256 digest
for each file.</para>
<para>
Values for the additional metadata fields in the Release file are
@@ -122,7 +107,8 @@
e.g. <literal>APT::FTPArchive::Release::Origin</literal>. The supported fields
are: <literal>Origin</literal>, <literal>Label</literal>, <literal>Suite</literal>,
<literal>Version</literal>, <literal>Codename</literal>, <literal>Date</literal>,
- <literal>Architectures</literal>, <literal>Components</literal>, <literal>Description</literal>.</para></listitem>
+ <literal>Valid-Until</literal>, <literal>Architectures</literal>,
+ <literal>Components</literal>, <literal>Description</literal>.</para></listitem>
</varlistentry>
@@ -224,7 +210,13 @@
This is similar to <literal>Packages::Compress</literal>
except that it controls the compression for the Contents files.</para></listitem>
</varlistentry>
-
+
+ <varlistentry><term>Translation::Compress</term>
+ <listitem><para>
+ This is similar to <literal>Packages::Compress</literal>
+ except that it controls the compression for the Translation-en master file.</para></listitem>
+ </varlistentry>
+
<varlistentry><term>DeLinkLimit</term>
<listitem><para>
Specifies the number of kilobytes to delink (and
@@ -238,6 +230,12 @@
defaults to 0644. All index files are set to this mode with no regard
to the umask.</para></listitem>
</varlistentry>
+
+ <varlistentry><term>LongDescription</term>
+ <listitem><para>
+ Sets if long descriptions should be included in the Packages file or split
+ out into a master Translation-en file.</para></listitem>
+ </varlistentry>
</variablelist>
</refsect2>
@@ -289,7 +287,14 @@
Sets the output Sources file. Defaults to
<filename>$(DIST)/$(SECTION)/source/Sources</filename></para></listitem>
</varlistentry>
-
+
+ <varlistentry><term>Translation</term>
+ <listitem><para>
+ Set the output Translation-en master file with the long descriptions if they
+ should be not included in the Packages file. Defaults to
+ <filename>$(DIST)/$(SECTION)/i18n/Translation-en</filename></para></listitem>
+ </varlistentry>
+
<varlistentry><term>InternalPrefix</term>
<listitem><para>
Sets the path prefix that causes a symlink to be
@@ -344,7 +349,7 @@
The <literal>Tree</literal> section takes a scope tag which sets the
<literal>$(DIST)</literal> variable and defines the root of the tree
(the path is prefixed by <literal>ArchiveDir</literal>).
- Typically this is a setting such as <filename>dists/woody</filename>.</para>
+ Typically this is a setting such as <filename>dists/&stable-codename;</filename>.</para>
<para>
All of the settings defined in the <literal>TreeDefault</literal> section can be
use in a <literal>Tree</literal> section as well as three new variables.</para>
@@ -371,7 +376,13 @@ for i in Sections do
architectures that appear under search section. The special architecture
'source' is used to indicate that this tree has a source archive.</para></listitem>
</varlistentry>
-
+
+ <varlistentry><term>LongDescription</term>
+ <listitem><para>
+ Sets if long descriptions should be included in the Packages file or split
+ out into a master Translation-en file.</para></listitem>
+ </varlistentry>
+
<varlistentry><term>BinOverride</term>
<listitem><para>
Sets the binary override file. The override file
@@ -494,11 +505,15 @@ for i in Sections do
&apt-cmdblurb;
<variablelist>
- <varlistentry><term><option>--md5</option></term>
+ <varlistentry><term><option>--md5</option>, <option>--sha1</option>, <option>--sha256</option></term>
<listitem><para>
- Generate MD5 sums. This defaults to on, when turned off the generated
- index files will not have MD5Sum fields where possible.
- Configuration Item: <literal>APT::FTPArchive::MD5</literal></para></listitem>
+ Generate the given checksum. These options default to on, when turned off the generated
+ index files will not have the checksum fields where possible.
+ Configuration Items: <literal>APT::FTPArchive::<replaceable>Checksum</replaceable></literal> and
+ <literal>APT::FTPArchive::<replaceable>Index</replaceable>::<replaceable>Checksum</replaceable></literal> where
+ <literal><replaceable>Index</replaceable></literal> can be <literal>Packages</literal>, <literal>Sources</literal> or
+ <literal>Release</literal> and <literal><replaceable>Checksum</replaceable></literal> can be <literal>MD5</literal>,
+ <literal>SHA1</literal> or <literal>SHA256</literal>.</para></listitem>
</varlistentry>
<varlistentry><term><option>-d</option></term><term><option>--db</option></term>
@@ -568,8 +583,8 @@ for i in Sections do
<listitem><para>
This configuration option defaults to "<literal>true</literal>" and should only be set to
<literal>"false"</literal> if the Archive generated with &apt-ftparchive; also provides
- <filename>Translation</filename> files. Note that it is currently not possible to create these
- files with <command>apt-ftparchive</command>.
+ <filename>Translation</filename> files. Note that the <filename>Translation-en</filename>
+ master file can only be created in the generate command.
</para></listitem>
</varlistentry>