Doc fix

Author: jgg
Date: 1999-10-31 06:32:27 GMT
Doc fix

4 files changed, 35 insertions, 31 deletions

diff --git a/doc/apt-cache.8.yo b/doc/apt-cache.8.yo
index c75af9313..2100dd727 100644
--- a/doc/apt-cache.8.yo
+++ b/doc/apt-cache.8.yo
@@ -176,40 +176,40 @@ 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. See bf(APT::Cache::AllVersions)
+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.
-See bf(APT::Cache::NoGenerate).
+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::Names-Only).
 
 dit(bf(-c, --config-file))
 Configuration File; Specify a configuration file to use. bf(apt-get) will
diff --git a/doc/apt-cdrom.8.yo b/doc/apt-cdrom.8.yo
index f017a9e59..9d5b598a2 100644
--- a/doc/apt-cdrom.8.yo
+++ b/doc/apt-cdrom.8.yo
@@ -49,23 +49,23 @@ Show the program verison.
 dit(bf(-d --cdrom))
 Mount point; specify the location to mount the cdrom. This mount point must
 be listed in bf(/etc/fstab) and propely configured. 
-See bf(Acquire::cdrom::mount).
+Configuration Item: bf(Acquire::cdrom::mount).
 
 dit(bf(-r --rename))
 Rename a disc; change the label of a disk or override the disks given label.
 This option will cause bf(apt-cdrom) to prompt for a new label
-See bf(APT::CDROM::Rename).
+Configuration Item: bf(APT::CDROM::Rename).
 
 dit(bf(-m, --no-mount))
 No mounting; prevent bf(apt-cdrom) from mounting and unmounting the mount
 point.
-See bf(APT::CDROM::NoMount).
+Configuration Item: bf(APT::CDROM::NoMount).
 
 dit(bf(-f, --fast))
 Fast Copy; Assume the package files are valid and do not check every package.
 This option should be used only if bf(apt-cdrom) has been run on this disc
 before and did not detect any errors.
-See bf(APT::CDROM::Fast).
+Configuration Item: bf(APT::CDROM::Fast).
 
 dit(bf(-a, --thorough))
 Thorough Package Scan; This option may be needed with some old Debian 1.1/1.2
@@ -75,7 +75,7 @@ scan the CD but will pick them all up.
 dit(bf(-n --just-print, --recon, --no-act))
 No Changes; Do not change the sources.list and do not write package files. 
 Everything is still checked however.
-See bf(APT::CDROM::NoAct).
+Configuration Item: bf(APT::CDROM::NoAct).
 
 dit(bf(-c, --config-file))
 Configuration File; Specify a configuration file to use. bf(apt-get) will
diff --git a/doc/apt-get.8.yo b/doc/apt-get.8.yo
index 3266581f7..c5b8a7162 100644
--- a/doc/apt-get.8.yo
+++ b/doc/apt-get.8.yo
@@ -131,7 +131,7 @@ bf(--no-f), bf(-f=no) or several other variations.
 startdit()
 dit(bf(-d, --download-only))
 Download only; package files are only retrieved, not unpacked or installed.
-See bf(APT::Get::Download-Only).
+Configuration Item: bf(APT::Get::Download-Only).
 
 dit(bf(-f, --fix-broken))
 Fix; attempt to correct a system with broken dependencies in            
@@ -142,7 +142,7 @@ exist on a system. It is possible that a system's dependency structure
 can be so corrupt as to require manual intervention (which usually
 means using dselect or dpkg --remove to eliminate some of the offending 
 packages). Use of this option together with -m may produce an error in
-some situations. See bf(APT::Get::Fix-Broken).
+some situations. Configuration Item: bf(APT::Get::Fix-Broken).
 
 dit(bf(-h, --help))
 Help; display a helpful usage message and exits.
@@ -154,7 +154,7 @@ dit(bf(-m, --ignore-missing, --fix-missing))
 Ignore missing packages; If packages cannot be retrieved or fail the    
 integrity check after retrieval (corrupted package files), hold back    
 those packages and handle the result. Use of this option together with  
--f may produce an error in some situations. See bf(ignore-missing).
+-f may produce an error in some situations. Configuration Item: bf(ignore-missing).
 
 dit(bf(--no-download))
 Disables downloading of packages. This is best used with --ignore-missing to
@@ -167,11 +167,13 @@ bf(-q=#) to set the quiet level, overriding the configuration file. Note that
 quiet level 2 implies -y, you should never use -qq without a no-action
 modifier such as -d, --print-uris or -s as APT may decided to do something
 you did not expect.
-See bf(quiet)
+Configuration Item: bf(quiet)
 
 dit(bf(-s, --simulate, --just-print, --dry-run, --recon, --no-act))
 No action; perform a simulation of events that would occur but do not
-actually change the system. See bf(APT::Get::Simulate). Simulate prints out
+actually change the system. Configuration Item: bf(APT::Get::Simulate). 
+
+Simulate prints out
 a series of lines each one representing a dpkg operation, Configure (Conf),
 Remove (Remv), Unpack (Inst). Square brackets indicate broken packages with
 and empty set of square brackets meaning breaks that are of no consequence
@@ -181,11 +183,11 @@ dit(bf(-y, --yes, --assume-yes))
 Automatic yes to prompts; assume "yes" as answer to all prompts and run
 non-interactively. If an undesirable situation, such as changing a held
 package or removing an essential package occurs then bf(apt-get) will
-abort. See bf(APT::Get::Assume-Yes).
+abort. Configuration Item: bf(APT::Get::Assume-Yes).
 
 dit(bf(-u, --show-upgraded))
 Show upgraded packages; Print out a list of all packages that are to be
-upgraded. See bf(APT::Get::Show-Upgraded).
+upgraded. Configuration Item: bf(APT::Get::Show-Upgraded).
 
 dit(bf(-b, --compile, --build))
 Compile source packages after downloading them.
@@ -193,25 +195,25 @@ Compile source packages after downloading them.
 dit(bf(--ignore-hold))
 Ignore package Holds; This causes bf(apt-get) to ignore a hold placed on 
 a package. This may be useful in conjunction with bf(dist-upgrade) to
-override a large number of undesired holds. See bf(APT::Ignore-Hold).
+override a large number of undesired holds. Configuration Item: bf(APT::Ignore-Hold).
 
 dit(bf(--no-upgrade))
 Do not upgrade packages; When used in conjunction with bf(install)
 bf(no-upgrade) will prevent packages listed from being upgraded if they
-are already installed. See bf(APT::Get::no-upgrade).
+are already installed. Configuration Item: bf(APT::Get::no-upgrade).
 
 dit(bf(--force-yes))
 Force yes; This is a dangerous option that will cause apt to continue without
 prompting if it is doing something potentially harmful. It should not be used
 except in very special situations. Using bf(force-yes) can potentially destroy
-your system! See bf(APT::Get::force-yes).
+your system! Configuration Item: bf(APT::Get::force-yes).
 
 dit(bf(--print-uris))
 Instead of fetching the files to install their URIs are printed. Each
 URI will have the path, the destination file name, the size and the expected
 md5 hash. Note that the file name to write to will not always match
 the file name on the remote site! This also works with the bf(source)
-command See bf(APT::Get::Print-URIs).
+command. Configuration Item: bf(APT::Get::Print-URIs).
 
 dit(bf(--purge))
 Use purge instead of remove for anything that would be removed.
@@ -223,20 +225,21 @@ dit(bf(--list-cleanup))
 This option defaults to on, use bf(--no-list-cleanup) to turn it off.
 When on apt-get will automatically manage the contents of 
 /var/state/apt/lists to ensure that obsolete files are erased. The only 
-reason to turn it off is if you frequently change your source list. See
-bf(APT::Get::List-Cleanup)
+reason to turn it off is if you frequently change your source list. 
+Configuration Item: bf(APT::Get::List-Cleanup)
 
 dit(bf(--trivial-only))
 Only perform operations are 'trivial'. Logically this can be considered
 related to --assume-yes, where --assume-yes will answer yes to any prompt,
---trivial-only will answer no. See bf(APT::Get::Trivial-Only)
+--trivial-only will answer no. Configuration Item: bf(APT::Get::Trivial-Only)
 
 dit(bf(--no-remove))
 If any packages are to be removed apt-get immediately aborts without
-prompting. See bf(APT::Get::No-Remove)
+prompting. Configuration Item: bf(APT::Get::No-Remove)
 
 dit(bf(--diff-only), bd(--tar-only))
-Download only the diff or tar file of a source archive.
+Download only the diff or tar file of a source archive. 
+Configuration Item: bf(APT::Get::Diff-Only)
 
 dit(bf(-c, --config-file))
 Configuration File; Specify a configuration file to use. bf(apt-get) will
diff --git a/doc/examples/apt.conf b/doc/examples/apt.conf
index c6e506cb8..6bd04c5e5 100644
--- a/doc/examples/apt.conf
+++ b/doc/examples/apt.conf
@@ -1,4 +1,4 @@
-// $Id: apt.conf,v 1.41 1999/10/29 04:49:37 jgg Exp $
+// $Id: apt.conf,v 1.42 1999/10/31 06:32:28 jgg Exp $
 /* This file is an index of all APT configuration directives. It should
    NOT actually be used as a real config file, though it is a completely
    valid file. Most of the options have sane default values, unless
@@ -78,6 +78,7 @@ Acquire
     Proxy "http://127.0.0.1:3128";
     Proxy::http.us.debian.org "DIRECT";  // Specific per-host setting
     Timeout "120";
+    Pipeline-Depth "5";
     
     // Cache Control. Note these do not work with Squid 2.0.2
     No-Cache "false";