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 cf0a11691eafb0128a0a3e972bf09a5468096992..5ce5c48a9ff43c6427f0546f1b5f0b2d4e2ea05b 100644 (file)
--- a/doc/apt-cache.8.yo
+++ b/doc/apt-cache.8.yo
@@ -24,7 +24,8 @@ itemize(
   it() show
   it() showpkg
   it() depends
-  it() pkgnames  
+  it() pkgnames
+  it() dotty
 )
 
 Unless the -h, or --help option is given one of the above commands
@@ -101,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".
 
@@ -131,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.
@@ -142,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))
@@ -166,6 +167,22 @@ 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()