1 <?xml version=
"1.0" encoding=
"utf-8" standalone=
"no"?>
2 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
5 <!ENTITY % aptent SYSTEM
"apt.ent">
8 <!ENTITY % aptverbatiment SYSTEM
"apt-verbatim.ent">
16 &apt-author.jgunthorpe;
20 <!-- The last update date -->
21 <date>08 November
2008</date>
25 <refentrytitle>apt-get
</refentrytitle>
26 <manvolnum>8</manvolnum>
27 <refmiscinfo class=
"manual">APT
</refmiscinfo>
30 <!-- Man page title -->
32 <refname>apt-get
</refname>
33 <refpurpose>APT package handling utility -- command-line interface
</refpurpose>
36 &synopsis-command-apt-get;
38 <refsect1><title>Description
</title>
39 <para><command>apt-get
</command> is the command-line tool for handling packages, and may be
40 considered the user's "back-end" to other tools using the APT
41 library. Several "front-end" interfaces exist, such as
&dselect;,
42 &aptitude;,
&synaptic; and
&wajig;.
</para>
44 <para>Unless the
<option>-h
</option>, or
<option>--help
</option> option is given, one of the
45 commands below must be present.
</para>
48 <varlistentry><term>update
</term>
49 <listitem><para><literal>update
</literal> is used to resynchronize the package index files from
50 their sources. The indexes of available packages are fetched from the
51 location(s) specified in
<filename>/etc/apt/sources.list
</filename>.
52 For example, when using a Debian archive, this command retrieves and
53 scans the
<filename>Packages.gz
</filename> files, so that information about new
54 and updated packages is available. An
<literal>update
</literal> should always be
55 performed before an
<literal>upgrade
</literal> or
<literal>dist-upgrade
</literal>. Please
56 be aware that the overall progress meter will be incorrect as the size
57 of the package files cannot be known in advance.
</para></listitem>
60 <varlistentry><term>upgrade
</term>
61 <listitem><para><literal>upgrade
</literal> is used to install the newest versions of all packages
62 currently installed on the system from the sources enumerated in
63 <filename>/etc/apt/sources.list
</filename>. Packages currently installed with
64 new versions available are retrieved and upgraded; under no circumstances
65 are currently installed packages removed, or packages not already installed
66 retrieved and installed. New versions of currently installed packages that
67 cannot be upgraded without changing the install status of another package
68 will be left at their current version. An
<literal>update
</literal> must be
69 performed first so that
<command>apt-get
</command> knows that new versions of packages are
70 available.
</para></listitem>
73 <varlistentry><term>dselect-upgrade
</term>
74 <listitem><para><literal>dselect-upgrade
</literal>
75 is used in conjunction with the traditional Debian packaging
76 front-end,
&dselect;.
<literal>dselect-upgrade
</literal>
77 follows the changes made by
&dselect; to the
<literal>Status
</literal>
78 field of available packages, and performs the actions necessary to realize
79 that state (for instance, the removal of old and the installation of new
80 packages).
</para></listitem>
83 <varlistentry><term>dist-upgrade
</term>
84 <listitem><para><literal>dist-upgrade
</literal> in addition to performing the function of
85 <literal>upgrade
</literal>, also intelligently handles changing dependencies
86 with new versions of packages;
<command>apt-get
</command> has a "smart" conflict
87 resolution system, and it will attempt to upgrade the most important
88 packages at the expense of less important ones if necessary.
89 So,
<literal>dist-upgrade
</literal> command may remove some packages.
90 The
<filename>/etc/apt/sources.list
</filename> file contains a list of locations
91 from which to retrieve desired package files.
92 See also &apt-preferences; for a mechanism for
93 overriding the general settings for individual packages.
</para></listitem>
96 <varlistentry><term>install
</term>
98 <para><literal>install
</literal> is followed by one or more
99 packages desired for installation or upgrading.
100 Each package is a package name, not a fully qualified
101 filename (for instance, in a Debian GNU/Linux system,
102 libc6 would be the argument provided, not
103 <literal>libc6_1.9
.6-
2.deb
</literal>). All packages required
104 by the package(s) specified for installation will also
105 be retrieved and installed.
106 The
<filename>/etc/apt/sources.list
</filename> file is
107 used to locate the desired packages. If a hyphen is
108 appended to the package name (with no intervening space),
109 the identified package will be removed if it is installed.
110 Similarly a plus sign can be used to designate a
111 package to install. These latter features may be used
112 to override decisions made by apt-get's conflict
116 <para>A specific version of a package can be selected for installation by
117 following the package name with an equals and the version of the package
118 to select. This will cause that version to be located and selected for
119 install. Alternatively a specific distribution can be selected by
120 following the package name with a slash and the version of the
121 distribution or the Archive name (stable, testing, unstable).
</para>
123 <para>Both of the version selection mechanisms can downgrade packages and must
124 be used with care.
</para>
126 <para>This is also the target to use if you want to upgrade one or
127 more already-installed packages without upgrading every package
128 you have on your system. Unlike the "upgrade" target, which
129 installs the newest version of all currently installed packages,
130 "install" will install the newest version of only the package(s)
131 specified. Simply provide the name of the package(s) you wish
132 to upgrade, and if a newer version is available, it (and its
133 dependencies, as described above) will be downloaded and
137 <para>Finally, the &apt-preferences; mechanism allows you to
138 create an alternative installation policy for
139 individual packages.
</para>
141 <para>If no package matches the given expression and the expression contains one
142 of '.', '?' or '*' then it is assumed to be a POSIX regular expression,
144 to all package names in the database. Any matches are then installed (or
145 removed). Note that matching is done by substring so 'lo.*' matches 'how-lo'
146 and 'lowest'. If this is undesired, anchor the regular expression
147 with a '^' or '$' character, or create a more specific regular expression.
</para></listitem>
150 <varlistentry><term>remove
</term>
151 <listitem><para><literal>remove
</literal> is identical to
<literal>install
</literal> except that packages are
152 removed instead of installed. Note the removing a package leaves its
153 configuration files in system. If a plus sign is appended to the package
154 name (with no intervening space), the identified package will be
155 installed instead of removed.
</para></listitem>
158 <varlistentry><term>purge
</term>
159 <listitem><para><literal>purge
</literal> is identical to
<literal>remove
</literal> except that packages are
160 removed and purged (any configuration files are deleted too).
</para></listitem>
163 <varlistentry><term>source
</term>
164 <listitem><para><literal>source
</literal> causes
<command>apt-get
</command> to fetch source packages. APT
165 will examine the available packages to decide which source package to
166 fetch. It will then find and download into the current directory the
167 newest available version of that source package while respecting the
168 default release, set with the option
<literal>APT::Default-Release
</literal>,
169 the
<option>-t
</option> option or per package with the
170 <literal>pkg/release
</literal> syntax, if possible.
</para>
172 <para>Source packages are tracked separately
173 from binary packages via
<literal>deb-src
</literal> type lines
174 in the &sources-list; file. This means that you will need to add such a line
175 for each repository you want to get sources from. If you don't do this
176 you will properly get another (newer, older or none) source version than
177 the one you have installed or could install.
</para>
179 <para>If the
<option>--compile
</option> option is specified
180 then the package will be compiled to a binary .deb using
181 <command>dpkg-buildpackage
</command> for the architecture as
182 defined by the
<command>--host-architecture
</command> option.
183 If
<option>--download-only
</option> is specified then the source package
184 will not be unpacked.
</para>
186 <para>A specific source version can be retrieved by postfixing the source name
187 with an equals and then the version to fetch, similar to the mechanism
188 used for the package files. This enables exact matching of the source
189 package name and version, implicitly enabling the
190 <literal>APT::Get::Only-Source
</literal> option.
</para>
192 <para>Note that source packages are not tracked like binary packages, they
193 exist only in the current directory and are similar to downloading source
194 tar balls.
</para></listitem>
197 <varlistentry><term>build-dep
</term>
198 <listitem><para><literal>build-dep
</literal> causes apt-get to install/remove packages in an
199 attempt to satisfy the build dependencies for a source package. By default the dependencies are
200 satisfied to build the package natively. If desired a host-architecture can be specified
201 with the
<option>--host-architecture
</option> option instead.
</para></listitem>
204 <varlistentry><term>check
</term>
205 <listitem><para><literal>check
</literal> is a diagnostic tool; it updates the package cache and checks
206 for broken dependencies.
</para></listitem>
209 <varlistentry><term>download
</term>
210 <listitem><para><literal>download
</literal> will download the given
211 binary package into the current directory.
215 <varlistentry><term>clean
</term>
216 <listitem><para><literal>clean
</literal> clears out the local repository of retrieved package
217 files. It removes everything but the lock file from
218 <filename>&cachedir;/archives/
</filename> and
219 <filename>&cachedir;/archives/partial/
</filename>. When APT is used as a
220 &dselect; method,
<literal>clean
</literal> is run automatically.
221 Those who do not use dselect will likely want to run
<literal>apt-get clean
</literal>
222 from time to time to free up disk space.
</para></listitem>
225 <varlistentry><term>autoclean
</term>
226 <listitem><para>Like
<literal>clean
</literal>,
<literal>autoclean
</literal> clears out the local
227 repository of retrieved package files. The difference is that it only
228 removes package files that can no longer be downloaded, and are largely
229 useless. This allows a cache to be maintained over a long period without
230 it growing out of control. The configuration option
231 <literal>APT::Clean-Installed
</literal> will prevent installed packages from being
232 erased if it is set to off.
</para></listitem>
235 <varlistentry><term>autoremove
</term>
236 <listitem><para><literal>autoremove
</literal> is used to remove packages that were automatically
237 installed to satisfy dependencies for other packages and are now no longer needed.
</para></listitem>
240 <varlistentry><term>changelog
</term>
241 <listitem><para><literal>changelog
</literal> downloads a package changelog and displays
242 it through
<command>sensible-pager
</command>. The server name and base
243 directory is defined in the
<literal>APT::Changelogs::Server
</literal>
244 variable (e. g.
<ulink>http://packages.debian.org/changelogs
</ulink> for
245 Debian or
<ulink>http://changelogs.ubuntu.com/changelogs
</ulink> for
247 By default it displays the changelog for the version that is
248 installed. However, you can specify the same options as for
249 the
<option>install
</option> command.
259 <refsect1><title>options
</title>
263 <varlistentry><term><option>--no-install-recommends
</option></term>
264 <listitem><para>Do not consider recommended packages as a dependency for installing.
265 Configuration Item:
<literal>APT::Install-Recommends
</literal>.
</para></listitem>
268 <varlistentry><term><option>--install-suggests
</option></term>
269 <listitem><para>Consider suggested packages as a dependency for installing.
270 Configuration Item:
<literal>APT::Install-Suggests
</literal>.
</para></listitem>
273 <varlistentry><term><option>-d
</option></term><term><option>--download-only
</option></term>
274 <listitem><para>Download only; package files are only retrieved, not unpacked or installed.
275 Configuration Item:
<literal>APT::Get::Download-Only
</literal>.
</para></listitem>
278 <varlistentry><term><option>-f
</option></term><term><option>--fix-broken
</option></term>
279 <listitem><para>Fix; attempt to correct a system with broken dependencies in
280 place. This option, when used with install/remove, can omit any packages
281 to permit APT to deduce a likely solution. If packages are specified,
282 these have to completely correct the problem. The option is sometimes necessary when
283 running APT for the first time; APT itself does not allow broken package
284 dependencies to exist on a system. It is possible that a system's
285 dependency structure can be so corrupt as to require manual intervention
286 (which usually means using
&dselect; or
<command>dpkg --remove
</command> to eliminate some of
287 the offending packages). Use of this option together with
<option>-m
</option> may produce an
288 error in some situations.
289 Configuration Item:
<literal>APT::Get::Fix-Broken
</literal>.
</para></listitem>
292 <varlistentry><term><option>-m
</option></term><term><option>--ignore-missing
</option></term>
293 <term><option>--fix-missing
</option></term>
294 <listitem><para>Ignore missing packages; If packages cannot be retrieved or fail the
295 integrity check after retrieval (corrupted package files), hold back
296 those packages and handle the result. Use of this option together with
297 <option>-f
</option> may produce an error in some situations. If a package is
298 selected for installation (particularly if it is mentioned on the
299 command line) and it could not be downloaded then it will be silently
301 Configuration Item:
<literal>APT::Get::Fix-Missing
</literal>.
</para></listitem>
304 <varlistentry><term><option>--no-download
</option></term>
305 <listitem><para>Disables downloading of packages. This is best used with
306 <option>--ignore-missing
</option> to force APT to use only the .debs it has
308 Configuration Item:
<literal>APT::Get::Download
</literal>.
</para></listitem>
311 <varlistentry><term><option>-q
</option></term><term><option>--quiet
</option></term>
312 <listitem><para>Quiet; produces output suitable for logging, omitting progress indicators.
313 More q's will produce more quiet up to a maximum of
2. You can also use
314 <option>-q=#
</option> to set the quiet level, overriding the configuration file.
315 Note that quiet level
2 implies
<option>-y
</option>, you should never use -qq
316 without a no-action modifier such as -d, --print-uris or -s as APT may
317 decided to do something you did not expect.
318 Configuration Item:
<literal>quiet
</literal>.
</para></listitem>
321 <varlistentry><term><option>-s
</option></term>
322 <term><option>--simulate
</option></term>
323 <term><option>--just-print
</option></term>
324 <term><option>--dry-run
</option></term>
325 <term><option>--recon
</option></term>
326 <term><option>--no-act
</option></term>
327 <listitem><para>No action; perform a simulation of events that would occur but do not
328 actually change the system.
329 Configuration Item:
<literal>APT::Get::Simulate
</literal>.
</para>
331 <para>Simulation run as user will deactivate locking (
<literal>Debug::NoLocking
</literal>)
332 automatic. Also a notice will be displayed indicating that this is only a simulation,
333 if the option
<literal>APT::Get::Show-User-Simulation-Note
</literal> is set (Default: true).
334 Neither NoLocking nor the notice will be triggered if run as root (root should know what
335 he is doing without further warnings by
<literal>apt-get
</literal>).
</para>
337 <para>Simulate prints out
338 a series of lines each one representing a dpkg operation, Configure (Conf),
339 Remove (Remv), Unpack (Inst). Square brackets indicate broken packages
340 and empty set of square brackets meaning breaks that are of no consequence
341 (rare).
</para></listitem>
344 <varlistentry><term><option>-y
</option></term><term><option>--yes
</option></term>
345 <term><option>--assume-yes
</option></term>
346 <listitem><para>Automatic yes to prompts; assume "yes" as answer to all prompts and run
347 non-interactively. If an undesirable situation, such as changing a held
348 package, trying to install a unauthenticated package or removing an essential package
349 occurs then
<literal>apt-get
</literal> will abort.
350 Configuration Item:
<literal>APT::Get::Assume-Yes
</literal>.
</para></listitem>
353 <varlistentry><term><option>--assume-no
</option></term>
354 <listitem><para>Automatic "no" to all prompts.
355 Configuration Item:
<literal>APT::Get::Assume-No
</literal>.
</para></listitem>
358 <varlistentry><term><option>-u
</option></term><term><option>--show-upgraded
</option></term>
359 <listitem><para>Show upgraded packages; Print out a list of all packages that are to be
361 Configuration Item:
<literal>APT::Get::Show-Upgraded
</literal>.
</para></listitem>
364 <varlistentry><term><option>-V
</option></term><term><option>--verbose-versions
</option></term>
365 <listitem><para>Show full versions for upgraded and installed packages.
366 Configuration Item:
<literal>APT::Get::Show-Versions
</literal>.
</para></listitem>
369 <varlistentry><term><option>-a
</option></term>
370 <term><option>--host-architecture
</option></term>
371 <listitem><para>This option controls the architecture packages are built for
372 by
<command>apt-get source --compile
</command> and how cross-builddependencies
373 are satisfied. By default is it not set which means that the host architecture
374 is the same as the build architecture (which is defined by
<literal>APT::Architecture
</literal>).
375 Configuration Item:
<literal>APT::Get::Host-Architecture
</literal>
379 <varlistentry><term><option>-b
</option></term><term><option>--compile
</option></term>
380 <term><option>--build
</option></term>
381 <listitem><para>Compile source packages after downloading them.
382 Configuration Item:
<literal>APT::Get::Compile
</literal>.
</para></listitem>
385 <varlistentry><term><option>--ignore-hold
</option></term>
386 <listitem><para>Ignore package Holds; This causes
<command>apt-get
</command> to ignore a hold
387 placed on a package. This may be useful in conjunction with
388 <literal>dist-upgrade
</literal> to override a large number of undesired holds.
389 Configuration Item:
<literal>APT::Ignore-Hold
</literal>.
</para></listitem>
392 <varlistentry><term><option>--no-upgrade
</option></term>
393 <listitem><para>Do not upgrade packages; When used in conjunction with
<literal>install
</literal>,
394 <literal>no-upgrade
</literal> will prevent packages on the command line
395 from being upgraded if they are already installed.
396 Configuration Item:
<literal>APT::Get::Upgrade
</literal>.
</para></listitem>
399 <varlistentry><term><option>--only-upgrade
</option></term>
400 <listitem><para>Do not install new packages; When used in conjunction
401 with
<literal>install
</literal>,
<literal>only-upgrade
</literal> will
402 install upgrades for already installed packages only and ignore requests
403 to install new packages.
404 Configuration Item:
<literal>APT::Get::Only-Upgrade
</literal>.
</para></listitem>
407 <varlistentry><term><option>--force-yes
</option></term>
408 <listitem><para>Force yes; This is a dangerous option that will cause apt to continue
409 without prompting if it is doing something potentially harmful. It
410 should not be used except in very special situations. Using
411 <literal>force-yes
</literal> can potentially destroy your system!
412 Configuration Item:
<literal>APT::Get::force-yes
</literal>.
</para></listitem>
415 <varlistentry><term><option>--print-uris
</option></term>
416 <listitem><para>Instead of fetching the files to install their URIs are printed. Each
417 URI will have the path, the destination file name, the size and the expected
418 md5 hash. Note that the file name to write to will not always match
419 the file name on the remote site! This also works with the
420 <literal>source
</literal> and
<literal>update
</literal> commands. When used with the
421 <literal>update
</literal> command the MD5 and size are not included, and it is
422 up to the user to decompress any compressed files.
423 Configuration Item:
<literal>APT::Get::Print-URIs
</literal>.
</para></listitem>
426 <varlistentry><term><option>--purge
</option></term>
427 <listitem><para>Use purge instead of remove for anything that would be removed.
428 An asterisk ("*") will be displayed next to packages which are
429 scheduled to be purged.
<option>remove --purge
</option> is equivalent to the
430 <option>purge
</option> command.
431 Configuration Item:
<literal>APT::Get::Purge
</literal>.
</para></listitem>
434 <varlistentry><term><option>--reinstall
</option></term>
435 <listitem><para>Re-Install packages that are already installed and at the newest version.
436 Configuration Item:
<literal>APT::Get::ReInstall
</literal>.
</para></listitem>
439 <varlistentry><term><option>--list-cleanup
</option></term>
440 <listitem><para>This option defaults to on, use
<literal>--no-list-cleanup
</literal> to turn it
441 off. When on
<command>apt-get
</command> will automatically manage the contents of
442 <filename>&statedir;/lists
</filename> to ensure that obsolete files are erased.
443 The only reason to turn it off is if you frequently change your source
445 Configuration Item:
<literal>APT::Get::List-Cleanup
</literal>.
</para></listitem>
448 <varlistentry><term><option>-t
</option></term>
449 <term><option>--target-release
</option></term>
450 <term><option>--default-release
</option></term>
451 <listitem><para>This option controls the default input to the policy engine, it creates
452 a default pin at priority
990 using the specified release string.
453 This overrides the general settings in
<filename>/etc/apt/preferences
</filename>.
454 Specifically pinned packages are not affected by the value
455 of this option. In short, this option
456 lets you have simple control over which distribution packages will be
457 retrieved from. Some common examples might be
458 <option>-t '
2.1*'
</option>,
<option>-t unstable
</option>
459 or
<option>-t sid
</option>.
460 Configuration Item:
<literal>APT::Default-Release
</literal>;
461 see also the &apt-preferences; manual page.
</para></listitem>
464 <varlistentry><term><option>--trivial-only
</option></term>
466 Only perform operations that are 'trivial'. Logically this can be considered
467 related to
<option>--assume-yes
</option>, where
<option>--assume-yes
</option> will answer
468 yes to any prompt,
<option>--trivial-only
</option> will answer no.
469 Configuration Item:
<literal>APT::Get::Trivial-Only
</literal>.
</para></listitem>
472 <varlistentry><term><option>--no-remove
</option></term>
473 <listitem><para>If any packages are to be removed apt-get immediately aborts without
475 Configuration Item:
<literal>APT::Get::Remove
</literal>.
</para></listitem>
478 <varlistentry><term><option>--auto-remove
</option></term>
479 <listitem><para>If the command is either
<literal>install
</literal> or
<literal>remove
</literal>,
480 then this option acts like running
<literal>autoremove
</literal> command, removing the unused
481 dependency packages. Configuration Item:
<literal>APT::Get::AutomaticRemove
</literal>.
485 <varlistentry><term><option>--only-source
</option></term>
486 <listitem><para>Only has meaning for the
487 <literal>source
</literal> and
<literal>build-dep
</literal>
488 commands. Indicates that the given source names are not to be
489 mapped through the binary table. This means that if this option
490 is specified, these commands will only accept source package
491 names as arguments, rather than accepting binary package names
492 and looking up the corresponding source package. Configuration
493 Item:
<literal>APT::Get::Only-Source
</literal>.
</para></listitem>
496 <varlistentry><term><option>--diff-only
</option></term><term><option>--dsc-only
</option></term><term><option>--tar-only
</option></term>
497 <listitem><para>Download only the diff, dsc, or tar file of a source archive.
498 Configuration Item:
<literal>APT::Get::Diff-Only
</literal>,
<literal>APT::Get::Dsc-Only
</literal>, and
499 <literal>APT::Get::Tar-Only
</literal>.
</para></listitem>
502 <varlistentry><term><option>--arch-only
</option></term>
503 <listitem><para>Only process architecture-dependent build-dependencies.
504 Configuration Item:
<literal>APT::Get::Arch-Only
</literal>.
</para></listitem>
507 <varlistentry><term><option>--allow-unauthenticated
</option></term>
508 <listitem><para>Ignore if packages can't be authenticated and don't prompt about it.
509 This is useful for tools like pbuilder.
510 Configuration Item:
<literal>APT::Get::AllowUnauthenticated
</literal>.
</para></listitem>
519 <refsect1><title>Files
</title>
529 <refsect1><title>See Also
</title>
530 <para>&apt-cache;, &apt-cdrom;,
&dpkg;,
&dselect;, &sources-list;,
531 &apt-conf;, &apt-config;, &apt-secure;,
532 The APT User's guide in
&guidesdir;, &apt-preferences;, the APT Howto.
</para>
535 <refsect1><title>Diagnostics
</title>
536 <para><command>apt-get
</command> returns zero on normal operation, decimal
100 on error.
</para>
539 <title>ORIGINAL AUTHORS
</title>
540 <para>&apt-author.jgunthorpe;
</para>
543 <title>CURRENT AUTHORS
</title>