0.5.15

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

diff --git a/doc/apt-ftparchive.1.sgml b/doc/apt-ftparchive.1.sgml
index a385aebd70a21987d3d2af4a216878632d0518e0..84c26d3c735b6b9efd91f4269aa7d0dc8ac549e9 100644 (file)
--- a/doc/apt-ftparchive.1.sgml
+++ b/doc/apt-ftparchive.1.sgml
@@ -49,7 +49,7 @@
 
    <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.
@@ -127,7 +127,7 @@
    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>
@@ -235,7 +235,7 @@
       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>
@@ -246,6 +246,12 @@
       <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 
@@ -336,7 +342,7 @@ for i in Sections do
       <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>
       
@@ -345,12 +351,22 @@ for i in Sections do
       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>
    
@@ -378,7 +394,7 @@ for i in Sections do
       Sets the Contents file output. (Optional)
       </VarListEntry>
       
-      <VarListEntry><term>Binoverride</term>
+      <VarListEntry><term>BinOverride</term>
       <ListItem><Para>
       Sets the binary override file.
       </VarListEntry>
@@ -388,6 +404,16 @@ for i in Sections do
       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.
@@ -431,6 +457,13 @@ for i in Sections do
    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;
    
@@ -491,6 +524,17 @@ for i in Sections do
    </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;