package name lister in apt-cache

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

diff --git a/doc/apt-get.8.yo b/doc/apt-get.8.yo
index ed63766a0d016b939e6e11e52fc59ffc10e36f5b..d46eb9bcba4a4827283e296e4d968baf5b04ca08 100644 (file)
--- a/doc/apt-get.8.yo
+++ b/doc/apt-get.8.yo
@@ -78,6 +78,12 @@ hyphen is appended to the package name (with no intervening space), the
 identified package will be removed if it is installed. This latter feature 
 may be used to override decisions made by apt-get's conflict resolution system.
 
 identified package will be removed if it is installed. This latter feature 
 may be used to override decisions made by apt-get's conflict resolution system.
 

+If no package matches the given expression and the expression contains one
+of '.', '?' or '*' then it is assumed to be a POSIX regex and it is applied
+to all package names in the database. Any matches are then installed (or
+removed). Note that matching is done by substring so 'lo*' matches 'how-lo'
+and 'lowest'. If this is undesired prefix with a '^' character.
+

 dit(bf(remove))
 bf(remove) is identical to bf(install) except that packages are removed
 instead of installed. If a plus sign is appended to the package name (with no
 dit(bf(remove))
 bf(remove) is identical to bf(install) except that packages are removed
 instead of installed. If a plus sign is appended to the package name (with no


@@ -87,17 +93,21 @@ dit(bf(source))
 bf(source) causes apt-get to fetch source packages. APT will examine the
 available packages to decide which source package to fetch. It will then
 find and download into the current directory the newest available version of
 bf(source) causes apt-get to fetch source packages. APT will examine the
 available packages to decide which source package to fetch. It will then
 find and download into the current directory the newest available version of

-that source package. Source packages are tracked seperately from binary
-packages via df(deb-src) type lines in the bf(/etc/apt/sources.list) file.
+that source package. Source packages are tracked separately from binary
+packages via bf(deb-src) type lines in the bf(/etc/apt/sources.list) file.

 This probably will mean that you will not get the same source as the package
 you have installed or as you could install. If the --compile options is
 specified then the package will be compiled to a binary .deb using
 dpkg-buildpackage, if --download-only is specified then the source package
 will not be unpacked.
 
 This probably will mean that you will not get the same source as the package
 you have installed or as you could install. If the --compile options is
 specified then the package will be compiled to a binary .deb using
 dpkg-buildpackage, if --download-only is specified then the source package
 will not be unpacked.
 

+Note that source packages are not tracked like binary packages, they exist
+only in the current directory and are similar to downloading source
+tar balls.
+

 dit(bf(check))
 bf(check) is a diagnostic tool; it updates the package cache and checks for 
 dit(bf(check))
 bf(check) is a diagnostic tool; it updates the package cache and checks for 

-brokenpackages.
+broken packages.

 
 dit(bf(clean))
 bf(clean) clears out the local repository of retrieved package files. It 
 
 dit(bf(clean))
 bf(clean) clears out the local repository of retrieved package files. It 


@@ -125,7 +135,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.
 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            
 
 dit(bf(-f, --fix-broken))
 Fix; attempt to correct a system with broken dependencies in            


@@ -136,32 +146,42 @@ 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
 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.
 
 dit(bf(-v, --version))
 
 dit(bf(-h, --help))
 Help; display a helpful usage message and exits.
 
 dit(bf(-v, --version))

-Show the program verison.
+Show the program version.

 
 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  
 
 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. If a package is selected for 
+installation (particularly if it is mentioned on the command line) and it
+could not be downloaded then it will be silently held back.
+Configuration Item: bf(APT::Get::ignore-missing).
+
+dit(bf(--no-download))
+Disables downloading of packages. This is best used with --ignore-missing to
+force APT to use only the .debs it has already downloaded.
+Configuration Item: bf(APT::Get::No-Download).

 
 dit(bf(-q, --quiet))
 Quiet; produces output suitable for logging, omitting progress indicators.
 
 dit(bf(-q, --quiet))
 Quiet; produces output suitable for logging, omitting progress indicators.

-More qs will produce more quiet up to a maximum of 2. You can also use
+More q's will produce more quiet up to a maximum of 2. You can also use

 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.
 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
 
 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
 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


@@ -169,39 +189,67 @@ and empty set of square brackets meaning breaks that are of no consequence
 
 dit(bf(-y, --yes, --assume-yes))
 Automatic yes to prompts; assume "yes" as answer to all prompts and run
 
 dit(bf(-y, --yes, --assume-yes))
 Automatic yes to prompts; assume "yes" as answer to all prompts and run

-non-interactively. If an undesireable situation, such as changing a held
-package or removing an essential package occures then bf(apt-get) will
-abort. See bf(APT::Get::Assume-Yes).
+non-interactively. If an undesirable situation, such as changing a held
+package or removing an essential package occurs then bf(apt-get) will
+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
 
 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.
 
 dit(bf(-b, --compile, --build))
 Compile source packages after downloading them.

+Configuration Item: bf(APT::Get::Compile).

 
 dit(bf(--ignore-hold))
 Ignore package Holds; This causes bf(apt-get) to ignore a hold placed on 
 
 dit(bf(--ignore-hold))
 Ignore package Holds; This causes bf(apt-get) to ignore a hold placed on 

-a package. This may be usefull in conjunction with bf(dist-upgrade) to
-override a large number of undesired holds. See bf(APT::Ingore-Hold).
+a package. This may be useful in conjunction with bf(dist-upgrade) to
+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
 
 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
 
 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 harmfull. It should not be used
+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
 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)
 
 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.
+Configuration Item: bf(APT::Get::Purge).
+
+dit(bf(--reinstall))
+Re-Install packages that are already installed and at the newest version.
+
+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. 
+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. Configuration Item: bf(APT::Get::Trivial-Only)
+
+dit(bf(--no-remove))
+If any packages are to be removed apt-get immediately aborts without
+prompting. Configuration Item: bf(APT::Get::No-Remove)
+
+dit(bf(--diff-only), bf(--tar-only))
+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
 
 dit(bf(-c, --config-file))
 Configuration File; Specify a configuration file to use. bf(apt-get) will


@@ -209,7 +257,7 @@ read the default configuration file and then this configuration file. See
 bf(apt.conf(5)) for syntax information.
 
 dit(bf(-o, --option))
 bf(apt.conf(5)) for syntax information.
 
 dit(bf(-o, --option))

-Set a Configuration Option; This will set an arbitary configuration option.
+Set a Configuration Option; This will set an arbitrary configuration option.

 The syntax is 
 verb(-o Foo::Bar=bar)
 enddit()
 The syntax is 
 verb(-o Foo::Bar=bar)
 enddit()