Undid undoing for bug 65952, fix is in aliencode

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

diff --git a/doc/apt-cache.8.yo b/doc/apt-cache.8.yo
index 123f41dc2b934a207661c9b1336c54feb0ffe1f2..5ce5c48a9ff43c6427f0546f1b5f0b2d4e2ea05b 100644 (file)
--- a/doc/apt-cache.8.yo
+++ b/doc/apt-cache.8.yo
@@ -23,6 +23,9 @@ itemize(
   it() search
   it() show
   it() showpkg
+  it() depends
+  it() pkgnames
+  it() dotty
 )
 
 Unless the -h, or --help option is given one of the above commands
@@ -99,7 +102,7 @@ itemize(
    package named "mail-transport-agent".
    
    it() bf(Single virtual packages) is the number of packages with only one 
-   package providing a particular virtual package. For instance, in the 
+   package providing a particular virtual package. For example, in the 
    Debian GNU/Linux system, "X11-text-viewer" is a virtual package, but only 
    one package, xless, provides "X11-text-viewer".
 
@@ -129,7 +132,7 @@ for debugging.
 
 dit(bf(dumpavail))
 bf(dumpavail) prints out an available list to stdout. This is suitable for use
-with df(dpkg) and is used by the bf(dselect) method.
+with bf(dpkg) and is used by the bf(dselect) method.
 
 dit(bf(unmet))
 bf(unmet) displays a summary of all unmet dependencies in the package cache.
@@ -140,10 +143,10 @@ Do not use it.
 
 dit(bf(showpkg))
 bf(showpkg) displays a listing of the given package cache structure and some
-related information about it. The list is ment primarily for debugging.
+related information about it. The list is meant primarily for debugging.
 
 dit(bf(show))
-bf(show) performs the same function as dpkg --print-avail, it displays
+bf(show) performs a function similar to dpkg --print-avail, it displays
 the package records for the named packages.
 
 dit(bf(search))
@@ -154,6 +157,32 @@ description. If --full is given then output identical to bf(show) is produced
 for each matched package and if --names-only is given then the long
 description is not searched, only the package name is.
 
+dit(bf(depends))
+bf(depends) shows a listing of each dependency a package has and all
+the possible other packages that can fullfill that dependency.
+
+dit(bf(pkgnames))
+This command prints the name of each package in the system. The optional
+argument is a prefix match to filter the name list. The output is suitable
+for use in a shell tab complete function and the output is generated extremly
+quickly. This command is best used with the bf(--no-generate) option.
+
+dit(bf(dotty))
+bf(dotty) Takes a list of packages on the command line and gernerates output
+suitable for use by dotty from the GraphVis
+(http://www.research.att.com/sw/tools/graphviz/) package. The result will be
+a set of nodes and edges representing the relationships between the
+packages. By default the given packages will trace out all dependent packages
+which can produce a very large graph. This can be turned off by setting the 
+APT::Cache::GivenOnly option.
+
+The resulting nodes will have several shapse, normal packages are boxes,
+pure provides are triangles, mixed provides are diamonds, 
+hexagons are missing packages. Orange boxes mean recursion was stopped 
+[leaf packages], blue lines are prre-depends, green lines are conflicts.
+
+Caution, dotty cannot graph larger sets of packages.
+
 enddit()
 
 manpageoptions()
@@ -172,32 +201,44 @@ Show the program verison.
 dit(bf(-p --pkg-cache))
 Select the file to store the package cache. The package cache is the primary
 cache used by all operations.
-See bf(Dir::Cache::pkgcache).
+Configuration Item: bf(Dir::Cache::pkgcache).
 
 dit(bf(-s --src-cache))
 Select the file to store the source cache. The source is used only by
 bf(gencaches) and it stores a parsed version of the package information from
 remote sources. When building the package cache the source cache is used
 to advoid reparsing all of the package files.
-See bf(Dir::Cache::srcpkgcache).
+Configuration Item: bf(Dir::Cache::srcpkgcache).
 
 dit(bf(-q, --quiet))
 Quiet; produces output suitable for logging, omitting progress indicators.
 More qs will produce more quite up to a maximum of 2. You can also use
 bf(-q=#) to set the quiet level, overriding the configuration file.
-See bf(quiet).
+Configuration Item: bf(quiet).
 
 dit(bf(-i --important))
 Print only important deps; for use with unmet causes only em(Depends) and 
 em(Pre-Depends) relations to be printed.
-See bf(APT::Cache::Important).
+Configuration Item: bf(APT::Cache::Important).
 
 dit(bf(-f --full))
-Print full package records when searching. See bf(APT::Cache::ShowFull).
+Print full package records when searching. Configuration Item: bf(APT::Cache::ShowFull).
+
+dit(bf(-a --all-versions))
+Print full records for all available versions, this is only applicable to the
+show command. Configuration Item: bf(APT::Cache::AllVersions)
+
+dit(bf(-g --no-generate))
+Do not perform automatic package cache regeneration, use the cache as it is.
+Configuration Item: bf(APT::Cache::NoGenerate).
 
 dit(bf(--names-only))
-Only search on the package names, not the long description. See
-bf(APT::Cache::Names-Only).
+Only search on the package names, not the long description. 
+Configuration Item: bf(APT::Cache::NamesOnly).
+
+dit(bf(--all-names))
+Make bf(pkgnames) print all names, including virtual packages and missing
+dependencies. Configuration Item: bf(APT::Cache::AllNames).
 
 dit(bf(-c, --config-file))
 Configuration File; Specify a configuration file to use. bf(apt-get) will