* Add an "apt-cache madison" command with an output for...

[apt.git] / doc / apt-cache.8.sgml

diff --git a/doc/apt-cache.8.sgml b/doc/apt-cache.8.sgml
index 93fce51c2d5d89199c75fbc02bef6b4e9483ad66..2ef3a2d259f8a070953a0e451b36cbe3b64631cf 100644 (file)
--- a/doc/apt-cache.8.sgml
+++ b/doc/apt-cache.8.sgml
@@ -43,6 +43,7 @@
          <arg>pkgnames <arg choice="plain"><replaceable>prefix</replaceable></arg></arg>
          <arg>dotty <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
          <arg>policy <arg choice="plain" rep="repeat"><replaceable>pkgs</replaceable></arg></arg>
+         <arg>madison <arg choice="plain" rep="repeat"><replaceable>pkgs</replaceable></arg></arg>
       </group>   
    </cmdsynopsis>
  </refsynopsisdiv>
@@ -206,15 +207,15 @@ Reverse Provides:
 
      <VarListEntry><Term>search <replaceable/regex [ regex ... ]/</Term>
      <ListItem><Para>
-     <literal/search/ performs a full text search on all available package 
-     files for the regex pattern given. It searches the package names and the 
-     descriptions for an occurrence of the string and prints out the package 
-     name and the short description. If <option/--full/ is given then output 
-     identical to <literal/show/ is produced for each matched package, and 
-     if <option/--names-only/ is given then the long description is not 
-     searched, only the package name is.
+     <literal/search/ performs a full text search on all available package
+     lists for the regex pattern given. It searches the package names and the
+     descriptions for an occurrence of the regular expression and prints out
+     the package name and the short description. If <option/--full/ is given
+     then output identical to <literal/show/ is produced for each matched
+     package, and if <option/--names-only/ is given then the long description
+     is not searched, only the package name is.
      <para>
-     Seperate arguments can be used to specify multiple search patterns that 
+     Separate arguments can be used to specify multiple search patterns that 
      are and'ed together.
      </VarListEntry>
 
@@ -259,13 +260,23 @@ Reverse Provides:
      <para>
      Caution, dotty cannot graph larger sets of packages.
      
-     <VarListEntry><Term>policy <replaceable/[ pkg(s) ]</Term>
+     <VarListEntry><Term>policy <replaceable/[ pkg(s) ]/</Term>
      <ListItem><Para>
      <literal/policy/ is ment to help debug issues relating to the 
      preferences file. With no arguments it will print out the 
      priorities of each source. Otherwise it prints out detailed information
      about the priority selection of the named package.
      </VarListEntry>
+
+     <VarListEntry><Term>madison <replaceable/[ pkg(s) ]/</Term>
+     <ListItem><Para>
+
+     <literal/apt-cache/'s <literal/madison/ command attempts to mimic
+     the output format and a subset of the functionality of the katie
+     program, <literal/madison/.  It displays available versions of a
+     package in a tabular format.
+
+     </VarListEntry>
    </VariableList>
  </RefSect1>
  
@@ -292,14 +303,14 @@ Reverse Provides:
      <VarListEntry><term><option/-q/</><term><option/--quiet/</>
      <ListItem><Para>
      Quiet; produces output suitable for logging, omitting progress indicators.
-     More qs will produce more quietness up to a maximum of 2. You can also use
+     More q's will produce more quietness up to a maximum of 2. You can also use
      <option/-q=#/ to set the quietness level, overriding the configuration file.
      Configuration Item: <literal/quiet/.
      </VarListEntry>
 
      <VarListEntry><term><option/-i/</><term><option/--important/</>
      <ListItem><Para>
-     Print only important deps; for use with unmet. Causes only Depends and 
+     Print only important dependencies; for use with unmet. Causes only Depends and 
      Pre-Depends relations to be printed.
      Configuration Item: <literal/APT::Cache::Important/.
      </VarListEntry>
@@ -312,8 +323,11 @@ Reverse Provides:
 
      <VarListEntry><term><option/-a/</><term><option/--all-versions/</>
      <ListItem><Para>
-     Print full records for all available versions. This is only applicable to 
-     the <literal/show/ command. 
+     Print full records for all available versions. This is the
+     default; to turn it off, use <option/--no-all-versions/.
+     If <option/--no-all-versions/ is specified, only the candidate version
+     will displayed (the one which would be selected for installation).
+     This option is only applicable to  the <literal/show/ command.
      Configuration Item: <literal/APT::Cache::AllVersions/.
      </VarListEntry>
 
@@ -324,7 +338,7 @@ Reverse Provides:
      Configuration Item: <literal/APT::Cache::Generate/.
      </VarListEntry>
 
-     <VarListEntry><term><option/--names-only/</><term><options/-n/</>
+     <VarListEntry><term><option/--names-only/</><term><option/-n/</>
      <ListItem><Para>
      Only search on the package names, not the long descriptions. 
      Configuration Item: <literal/APT::Cache::NamesOnly/.
@@ -339,11 +353,18 @@ Reverse Provides:
 
      <VarListEntry><term><option/--recurse/</>
      <ListItem><Para>
-     Make <literal/depends/ recursive so that all packages mentioned are 
-     printed once.
+     Make <literal/depends/ and <literal/rdepends/ recursive so that
+     all packages mentioned are printed once.
      Configuration Item: <literal/APT::Cache::RecurseDepends/.
      </VarListEntry>
 
+     <VarListEntry><term><option/--installed/</>
+     <ListItem><Para>
+     Limit the output of <literal/depends/ and <literal/rdepends/ to
+     packages which are currently installed.
+     Configuration Item: <literal/APT::Cache::Installed/.
+     </VarListEntry>
+
      &apt-commonoptions;
      
    </VariableList>