diff options
Diffstat (limited to 'doc/apt-get.8.sgml')
| -rw-r--r-- | doc/apt-get.8.sgml | 451 |
1 files changed, 451 insertions, 0 deletions
diff --git a/doc/apt-get.8.sgml b/doc/apt-get.8.sgml new file mode 100644 index 000000000..cf35b65b0 --- /dev/null +++ b/doc/apt-get.8.sgml @@ -0,0 +1,451 @@ +<!-- -*- mode: sgml; mode: fold -*- --> +<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [ + +<!ENTITY % aptent SYSTEM "apt.ent"> +%aptent; + +]> + +<refentry> + &apt-docinfo; + + <refmeta> + <refentrytitle>apt-get</> + <manvolnum>8</> + </refmeta> + + <!-- Man page title --> + <refnamediv> + <refname>apt-get</> + <refpurpose>APT package handling utility -- command-line interface</> + </refnamediv> + + <!-- Arguments --> + <refsynopsisdiv> + <cmdsynopsis> + <command>apt-config</> + <arg><option>-hvs</></arg> + <arg><option>-o=<replaceable/config string/</></arg> + <arg><option>-c=<replaceable/file/</></arg> + <group choice=req> + <arg>update</> + <arg>upgrade</> + <arg>dselect-upgrade</> + <arg>install <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg> + <arg>remove <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg> + <arg>source <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg> + <arg>build-dep <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg> + <arg>check</> + <arg>clean</> + <arg>autoclean</> + </group> + </cmdsynopsis> + </refsynopsisdiv> + + <RefSect1><Title>Description</> + <para> + <command/apt-get/ is the command-line tool for handling packages, and may be + considered the user's "back-end" to other tools using the APT library. + <para> + Unless the <option/-h/, or <option/--help/ option is given one of the + above commands must be present. + + <VariableList> + <VarListEntry><Term>update</Term> + <ListItem><Para> + <literal/update/ is used to resynchronize the package index files from + their sources. The indexes of available packages are fetched from the + location(s) specified in <filename>/etc/apt/sources.list</>. + For example, when using a Debian archive, this command retrieves and + scans the <filename>Packages.gz</> files, so that information about new + and updated packages is available. An <literal/update/ should always be + performed before an <literal/upgrade/ or <literal/dist-upgrade/. Please + be aware that the overall progress meter will be incorrect as the size + of the package files cannot be known in advance. + </VarListEntry> + + <VarListEntry><Term>upgrade</Term> + <ListItem><Para> + <literal/upgrade/ is used to install the newest versions of all packages + currently installed on the system from the sources enumerated in + <filename>/etc/apt/sources.list</>. Packages currently installed with + new versions available are retrieved and upgraded; under no circumstances + are currently installed packages removed, or packages not already installed + retrieved and installed. New versions of currently installed packages that + cannot be upgraded without changing the install status of another package + will be left at their current version. An <literal/update/ must be + performed first so that <command/apt-get/ knows that new versions of packages are + available. + </VarListEntry> + + <VarListEntry><Term>dselect-upgrade</Term> + <ListItem><Para> + is used in conjunction with the traditional Debian GNU/Linux packaging + front-end, &dselect;. <literal/dselect-upgrade/ + follows the changes made by &dselect; to the <literal/Status/ + field of available packages, and performs the actions necessary to realize + that state (for instance, the removal of old and the installation of new + packages). + </VarListEntry> + + <VarListEntry><Term>dist-upgrade</Term> + <ListItem><Para> + <literal/dist-upgrade/, in addition to performing the function of + <literal/upgrade/, also intelligently handles changing dependencies + with new versions of packages; <command/apt-get/ has a "smart" conflict + resolution system, and it will attempt to upgrade the most important + packages at the expense of less important ones if necessary. + The <filename>/etc/apt/sources.list</> file contains a list of locations + from which to retrieve desired package files. + </VarListEntry> + + <VarListEntry><Term>install</Term> + <ListItem><Para> + <literal/install/ is followed by one or more packages desired for + installation. Each package is a package name, not a fully qualified + filename (for instance, in a Debian GNU/Linux system, libc6 would be the + argument provided, not em(libc6_1.9.6-2.deb)). All packages required + by the package(s) specified for installation will also be retrieved and + installed. The <filename>/etc/apt/sources.list</> file is used to locate + the desired packages. If a hyphen is appended to the package name (with + no intervening space), the identified package will be removed if it is + installed. Similarly a plus sign can be used to designate a package to + isntall. These latter feature may be used to override decisions made by + apt-get's conflict resolution system. + <para> + A specific version of a package can be selected for installation by + following the package name with an equals and the version of the package + to select. This will cause that version to be located and selected for + install. Alternatively a specific distribution can be selected by + following the package name with a slash and the version of the + distribution or the Archive name (stable, frozen, unstable). + <para> + Both of the version selection mechansims can downgrade packages and must + be used with care. + <para> + 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. + </VarListEntry> + + <VarListEntry><Term>remove</Term> + <ListItem><Para> + <literal/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 intervening space), the identified package will be + installed. + </VarListEntry> + + <VarListEntry><Term>source</Term> + <ListItem><Para> + <literal/source/ causes <command/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 separately from binary packages via <literal/deb-src/ type lines + in the &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. + <para> + A specific source version can be retrieved by postfixing the source name + with an equals and then the version to fetch, similar to the mechanism + used for the package files. This enables exact matching of the source + package name and version, implicitly enabling the + <literal/APT::Get::Only-Source/ option. + + <para> + 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. + </VarListEntry> + + <VarListEntry><Term>build-dep</Term> + <ListItem><Para> + <literal/build-dep/ causes apt-get to install/remove packages in an + attempt to satisfy the build dependencies for a source packages. Right + now virtual package build depends choose a package at random. + </VarListEntry> + + <VarListEntry><Term>check</Term> + <ListItem><Para> + <literal/check/ is a diagnostic tool; it updates the package cache and checks + for broken dependencies. + </VarListEntry> + + <VarListEntry><Term>clean</Term> + <ListItem><Para> + <literal/clean/ clears out the local repository of retrieved package + files. It removes everything but the lock file from + <filename>&cachedir;/archives/</> and + <filename>&cachedir;/archive/partial/</>. When APT is used as a + &dselect; method, <literal/clean/ is run automatically. + Those who do not use dselect will likely want to run <literal/apt-get clean/ + from time to time to free up disk space. + </VarListEntry> + + <VarListEntry><Term>autoclean</Term> + <ListItem><Para> + Like <literal/clean/, <literal/autoclean/ clears out the local + repository of retrieved package files. The difference is that it only + removes package files that can no longer be downloaded, and are largely + useless. This allows a cache to be maintained over a long period without + it growing out of control. The configuration option + <literal/APT::Clean-Installed/ will prevent installed packages from being + erased if it is set off. + </VarListEntry> + </VariableList> + </RefSect1> + + <RefSect1><Title>Options</> + &apt-cmdblurb; + + <VariableList> + <VarListEntry><term><option/-d/</><term><option/--download-only/</> + <ListItem><Para> + Download only; package files are only retrieved, not unpacked or installed. + Configuration Item: <literal/APT::Get::Download-Only/. + </VarListEntry> + + <VarListEntry><term><option/-f/</><term><option/--fix-broken/</> + <ListItem><Para> + Fix; attempt to correct a system with broken dependencies in + 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 <command/dpkg --remove/ to eliminate some of + the offending packages). Use of this option together with <option/-m/ may produce an + error in some situations. + Configuration Item: <literal/APT::Get::Fix-Broken/. + </VarListEntry> + + <VarListEntry><term><option/-m/</><term><option/--ignore-missing/</> + <term><option/--fix-missing/</> + <ListItem><Para> + 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 + <option/-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: <literal/APT::Get::Fix-Missing/. + </VarListEntry> + + <VarListEntry><term><option/--no-download/</> + <ListItem><Para> + Disables downloading of packages. This is best used with + <option/--ignore-missing/ to force APT to use only the .debs it has + already downloaded. + Configuration Item: <literal/APT::Get::Download/. + </VarListEntry> + + <VarListEntry><term><option/-q/</><term><option/--quiet/</> + <ListItem><Para> + Quiet; produces output suitable for logging, omitting progress indicators. + More q's will produce more quiet up to a maximum of 2. You can also use + <option/-q=#/ to set the quiet level, overriding the configuration file. + Note that quiet level 2 implies <option/-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. + Configuration Item: <literal/quiet/. + </VarListEntry> + + <VarListEntry><term><option/-s/</> + <term><option/--simulate/</> + <term><option/--just-print/</> + <term><option/--dry-run/</> + <term><option/--recon/</> + <term><option/--no-act/</> + <ListItem><Para> + No action; perform a simulation of events that would occur but do not + actually change the system. + Configuration Item: <literal/APT::Get::Simulate/. + <para> + 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 + (rare). + </VarListEntry> + + <VarListEntry><term><option/-y/</><term><option/--yes/</> + <term><option/--assume-yes/</> + <ListItem><Para> + 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 <literal/apt-get/ + will abort. + Configuration Item: <literal/APT::Get::Assume-Yes/. + </VarListEntry> + + <VarListEntry><term><option/-u/</><term><option/--show-upgraded/</> + <ListItem><Para> + Show upgraded packages; Print out a list of all packages that are to be + upgraded. + Configuration Item: <literal/APT::Get::Show-Upgraded/. + </VarListEntry> + + <VarListEntry><term><option/-b/</><term><option/--compile/</> + <term><option/--build/</> + <ListItem><Para> + Compile source packages after downloading them. + Configuration Item: <literal/APT::Get::Compile/. + </VarListEntry> + + <VarListEntry><term><option/--ignore-hold/</> + <ListItem><Para> + Ignore package Holds; This causes <command/apt-get/ to ignore a hold + placed on a package. This may be useful in conjunction with + <literal/dist-upgrade/ to override a large number of undesired holds. + Configuration Item: <literal/APT::Ignore-Hold/. + </VarListEntry> + + <VarListEntry><term><option/--no-upgrade/</> + <ListItem><Para> + Do not upgrade packages; When used in conjunction with <literal/install/ + <literal/no-upgrade/ will prevent packages listed from being upgraded + if they are already installed. + Configuration Item: <literal/APT::Get::Upgrade/. + </VarListEntry> + + <VarListEntry><term><option/--force-yes/</> + <ListItem><Para> + 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 + <literal/force-yes/ can potentially destroy your system! + Configuration Item: <literal/APT::Get::force-yes/. + </VarListEntry> + + <VarListEntry><term><option/--print-uris/</> + <ListItem><Para> + 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 /source/ + command. Configuration Item: <literal/APT::Get::Print-URIs/. + </VarListEntry> + + <VarListEntry><term><option/--purge/</> + <ListItem><Para> + Use purge instead of remove for anything that would be removed. + Configuration Item: <literal/APT::Get::Purge/. + </VarListEntry> + + <VarListEntry><term><option/--reinstall/</> + <ListItem><Para> + Re-Install packages that are already installed and at the newest version. + Configuration Item: <literal/APT::Get::ReInstall/. + </VarListEntry> + + <VarListEntry><term><option/--list-cleanup/</> + <ListItem><Para> + This option defaults to on, use <literal/--no-list-cleanup/ to turn it + off. When on <command/apt-get/ will automatically manage the contents of + <filename>&statedir;/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: <literal/APT::Get::List-Cleanup/. + </VarListEntry> + + <VarListEntry><term><option/-t/</> + <term><option/--target-release/</> + <term><option/--default-release/</> + <ListItem><Para> + This option controls the default input to the policy engine, it creates + a default pin at priority 990 using the specified release string. The + preferences file may further override this setting. In short, this option + lets you have simple control over which distribution packages will be + retrieved from. Some common examples might me + <option>-t '2.1*'</> or <option>-t unstable</>. + Configuration Item: <literal/APT::Default-Release/ + </VarListEntry> + + <VarListEntry><term><option/--trivial-only/</> + <ListItem><Para> + Only perform operations are 'trivial'. Logically this can be considered + related to <option/--assume-yes/, where <option/--assume-yes/ will answer + yes to any prompt, <option/--trivial-only/ will answer no. + Configuration Item: <literal/APT::Get::Trivial-Only/. + </VarListEntry> + + <VarListEntry><term><option/--no-remove/</> + <ListItem><Para> + If any packages are to be removed apt-get immediately aborts without + prompting. + Configuration Item: <literal/APT::Get::Remove/ + </VarListEntry> + + <VarListEntry><term><option/--only-source/</> + <ListItem><Para> + Only has meaning for the <literal/source/ command. indicates that the + given source names are not to be mapped through the binary table. + Configuration Item: <literal/APT::Get::Only-Source/ + </VarListEntry> + + <VarListEntry><term><option/--diff-only/</><term><option/--tar-only/</> + <ListItem><Para> + Download only the diff or tar file of a source archive. + Configuration Item: <literal/APT::Get::Diff-Only/ and + <literal/APT::Get::Tar-Only/ + </VarListEntry> + </VariableList> + </RefSect1> + + <RefSect1><Title>Files</> + <variablelist> + <VarListEntry><term><filename>/etc/apt/sources.list</></term> + <ListItem><Para> + locations to fetch packages from. + Configuration Item: <literal/Dir::Etc::SourceList/. + </VarListEntry> + + <VarListEntry><term><filename>&cachedir;/archives/</></term> + <ListItem><Para> + storage area for retrieved package files + Configuration Item: <literal/Dir::Cache::Archives/. + </VarListEntry> + + <VarListEntry><term><filename>&cachedir;/archives/partial/</></term> + <ListItem><Para> + storage area for package files in transit + Configuration Item: <literal/Dir::Cache::Archives/ (implicit partial). + </VarListEntry> + + <VarListEntry><term><filename>&statedir;/lists/</></term> + <ListItem><Para> + storage area for state information for each package resource specified in + &sources-list; + Configuration Item: <literal/Dir::State::Lists/. + </VarListEntry> + + <VarListEntry><term><filename>&statedir;/lists/partial/</></term> + <ListItem><Para> + storage area for state information in transit. + Configuration Item: <literal/Dir::State::Lists/ (implicit partial). + </VarListEntry> + </variablelist> + </RefSect1> + + <RefSect1><Title>See Also</> + <para> + &apt-cache;, &dpkg;, &dselect;, &sources-list;, &apt-conf;, The + APT users guide in &docdir;. + </RefSect1> + + <RefSect1><Title>Diagnostics</> + <para> + <command/apt-get/ returns zero on normal operation, decimal 100 on error. + </RefSect1> + + &manbugs; + &manauthor; + +</refentry> |