cmdline/apt-report-mirror-failure: port to latest python-apt

[apt.git] / doc / apt-ftparchive.1.xml

diff --git a/doc/apt-ftparchive.1.xml b/doc/apt-ftparchive.1.xml
index e08444fc68a9faafb7adf1baf39f66e88ced45cd..c56ff235a27cd55657e547936f5648b6802c204f 100644 (file)
--- a/doc/apt-ftparchive.1.xml
+++ b/doc/apt-ftparchive.1.xml
@@ -8,11 +8,20 @@
 ]>
 
 <refentry>
 ]>
 
 <refentry>

- &apt-docinfo;
+
+ <refentryinfo>
+   &apt-author.jgunthorpe;
+   &apt-author.team;
+   &apt-email;
+   &apt-product;
+   <!-- The last update date -->
+   <date>17 August 2009</date>
+ </refentryinfo>

  
  <refmeta>
    <refentrytitle>apt-ftparchive</refentrytitle>
    <manvolnum>1</manvolnum>
  
  <refmeta>
    <refentrytitle>apt-ftparchive</refentrytitle>
    <manvolnum>1</manvolnum>

+   <refmiscinfo class="manual">APT</refmiscinfo>

  </refmeta>
  
  <!-- Man page title -->
  </refmeta>
  
  <!-- Man page title -->


@@ -30,7 +39,7 @@
       <arg><option>--delink</option></arg>
       <arg><option>--readonly</option></arg>
       <arg><option>--contents</option></arg>
       <arg><option>--delink</option></arg>
       <arg><option>--readonly</option></arg>
       <arg><option>--contents</option></arg>

-      <arg><option>-o=<replaceable>config string</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><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>


@@ -149,7 +158,7 @@
      <para>
      The <literal>Dir</literal> section defines the standard directories needed to 
      locate the files required during the generation process. These 
      <para>
      The <literal>Dir</literal> 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 
+     directories are prepended certain relative paths defined in later 

      sections to produce a complete an absolute path.</para>
      <variablelist>     
       <varlistentry><term>ArchiveDir</term>
      sections to produce a complete an absolute path.</para>
      <variablelist>     
       <varlistentry><term>ArchiveDir</term>


@@ -276,7 +285,7 @@
       
       <varlistentry><term>Sources</term>
       <listitem><para>
       
       <varlistentry><term>Sources</term>
       <listitem><para>

-      Sets the output Packages file. Defaults to 
+      Sets the output Sources file. Defaults to 

       <filename>$(DIST)/$(SECTION)/source/Sources</filename></para></listitem>
       </varlistentry>
       
       <filename>$(DIST)/$(SECTION)/source/Sources</filename></para></listitem>
       </varlistentry>
       


@@ -319,7 +328,7 @@
       Specifies that instead of walking the directory tree, 
       <command>apt-ftparchive</command> should read the list of files from the given 
       file. Relative files names are prefixed with the archive directory. 
       Specifies that instead of walking the directory tree, 
       <command>apt-ftparchive</command> 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.</para></listitem>
+      This is used when processing source indexes.</para></listitem>

       </varlistentry>
      </variablelist>     
    </refsect2>
       </varlistentry>
      </variablelist>     
    </refsect2>


@@ -341,11 +350,11 @@
      <para>
      When processing a <literal>Tree</literal> section <command>apt-ftparchive</command> 
      performs an operation similar to:
      <para>
      When processing a <literal>Tree</literal> section <command>apt-ftparchive</command> 
      performs an operation similar to:

-<informalexample><programlisting>
+     <programlisting>

 for i in Sections do 
    for j in Architectures do
       Generate for DIST=scope SECTION=i ARCH=j
 for i in Sections do 
    for j in Architectures do
       Generate for DIST=scope SECTION=i ARCH=j

-</programlisting></informalexample></para>
+     </programlisting></para>

 
      <variablelist>     
       <varlistentry><term>Sections</term>
 
      <variablelist>     
       <varlistentry><term>Sections</term>


@@ -399,10 +408,10 @@ for i in Sections do
       Sets the Packages file output.</para></listitem>
       </varlistentry>
       
       Sets the Packages file output.</para></listitem>
       </varlistentry>
       

-      <varlistentry><term>SrcPackages</term>
+      <varlistentry><term>Sources</term>

       <listitem><para>
       Sets the Sources file output. At least one of
       <listitem><para>
       Sets the Sources file output. At least one of

-      <literal>Packages</literal> or <literal>SrcPackages</literal> is required.</para></listitem>
+      <literal>Packages</literal> or <literal>Sources</literal> is required.</para></listitem>

       </varlistentry>
       
       <varlistentry><term>Contents</term>
       </varlistentry>
       
       <varlistentry><term>Contents</term>


@@ -534,7 +543,16 @@ for i in Sections do
      Make the caching databases read only. 
      Configuration Item: <literal>APT::FTPArchive::ReadOnlyDB</literal>.</para></listitem>
      </varlistentry>   
      Make the caching databases read only. 
      Configuration Item: <literal>APT::FTPArchive::ReadOnlyDB</literal>.</para></listitem>
      </varlistentry>   

-   
+
+     <varlistentry><term><option>APT::FTPArchive::LongDescription</option></term>
+     <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>.
+     </para></listitem>
+     </varlistentry>
+

      &apt-commonoptions;
      
    </variablelist>
      &apt-commonoptions;
      
    </variablelist>


@@ -560,6 +578,5 @@ binary packages (.deb):
  </refsect1>
 
  &manbugs;
  </refsect1>
 
  &manbugs;

- &manauthor;

  
 </refentry>
  
 </refentry>