Fixed relative paths

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

diff --git a/doc/apt-get.8.yo b/doc/apt-get.8.yo
index a0a87172250dcd7515bd027c307a0fade65b6f09..4983b25816b5edc7cb24f1b9fbf1bd278f364f0f 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


@@ -95,6 +101,10 @@ 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.
 
 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 
 broken packages.
 dit(bf(check))
 bf(check) is a diagnostic tool; it updates the package cache and checks for 
 broken packages.


@@ -125,18 +135,19 @@ 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            

-place. This option may be used alone or in conjunction with any of the  
-command actions, and is sometimes necessary when running APT for the    
-first time; APT itself does not allow broken package dependencies to    
-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).
+place. This option, when used with install/remove, can omit any packages
+to permit APT to deduce a likely soltion. Any Package that are specified
+must completly correct the problem. The option is sometimes necessary when 
+running APT for the first time; APT itself does not allow broken package 
+dependencies to 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. Configuration Item: bf(APT::Get::Fix-Broken).

 
 dit(bf(-h, --help))
 Help; display a helpful usage message and exits.
 
 dit(bf(-h, --help))
 Help; display a helpful usage message and exits.


@@ -148,11 +159,15 @@ 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  
 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.
 
 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.


@@ -161,11 +176,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.
 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


@@ -175,46 +192,65 @@ 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
 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
 
 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 
 a package. This may be useful in conjunction with bf(dist-upgrade) to
 
 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
 
 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
 
 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)
 
 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.
 
 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 
 
 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.
+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