Regex, --all-versions and more OR stuff

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

diff --git a/doc/apt-cache.8.yo b/doc/apt-cache.8.yo
index 61248a8c0545934207ca4d98fd649ea379157166..c75af93137944c71751aafceb41ff6497885a154 100644 (file)
--- a/doc/apt-cache.8.yo
+++ b/doc/apt-cache.8.yo
@@ -15,11 +15,14 @@ itemize(
   it() add file1 [file2] [...]
   it() gencaches
   it() showpkg package1 [package2] [...]
-  it() stats 
+  it() stats
   it() dump
   it() dumpavail
   it() unmet
   it() check
+  it() search
+  it() show
+  it() showpkg
 )
 
 Unless the -h, or --help option is given one of the above commands
@@ -135,32 +138,78 @@ dit(bf(check))
 bf(check) is a random function for testing certain aspects of the cache.
 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.
+
+dit(bf(show))
+bf(show) performs the same function as dpkg --print-avail, it displays
+the package records for the named packages.
+
+dit(bf(search))
+bf(search) performs a full text search on all available package files for
+the pattern given. It searchs the package names and the descriptions for
+an occurance of the string and prints out the package name and the short
+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.
+
 enddit()
 
 manpageoptions()
+All command line options may be set using the configuration file, the
+descriptions indicate the configuration option to set. For boolean
+options you can override the config file by using something like bf(-f-),
+bf(--no-f), bf(-f=no) or several other variations.
 
 startdit()
 dit(bf(-h, --help))
 Show a short usage summary.
 
+dit(bf(-v, --version))
+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).
 
 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).
 
 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).
 
 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).
+
+dit(bf(-f --full))
+Print full package records when searching. See bf(APT::Cache::ShowFull).
+
+dit(bf(-a --all-versions))
+Print full records for all available versions, this is only applicable to the
+show command. See bf(APT::Cache::AllVersions)
+
+dit(bf(-g --no-generate))
+Do not perform automatic package cache regeneration, use the cache as it is.
+See bf(APT::Cache::NoGenerate).
+
+dit(bf(--names-only))
+Only search on the package names, not the long description. See
+bf(APT::Cache::Names-Only).
 
 dit(bf(-c, --config-file))
 Configuration File; Specify a configuration file to use. bf(apt-get) will
@@ -186,16 +235,15 @@ itemize(
 )
 
 manpageseealso()
-apt-get (8),
-dpkg (8),
-dselect (8),
-sources.list (5)
+apt-get(8),
+sources.list(5),
+apt.conf(5)
 
 manpagediagnostics()
 apt-cache returns zero on normal operation, decimal 100 on error.
 
 manpagebugs()
-See http://www.debian.org/Bugs/db/pa/lapt.html.  If you wish to report a
+See http://bugs.debian.org/apt.  If you wish to report a
 bug in bf(apt-cache), please see bf(/usr/doc/debian/bug-reporting.txt)
 or the bf(bug(1)) command.