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">
13 &apt-author.jgunthorpe;
17 <!-- The last update date -->
18 <date>08 November
2008</date>
22 <refentrytitle>apt-get
</refentrytitle>
23 <manvolnum>8</manvolnum>
24 <refmiscinfo class=
"manual">APT
</refmiscinfo>
27 <!-- Man page title -->
29 <refname>apt-get
</refname>
30 <refpurpose>APT package handling utility -- command-line interface
</refpurpose>
36 <command>apt-get
</command>
37 <arg><option>-sqdyfmubV
</option></arg>
40 <replaceable>config_string
</replaceable>
45 <replaceable>config_file
</replaceable>
52 <replaceable>target_release_name
</replaceable>
55 <replaceable>target_release_number_expression
</replaceable>
58 <replaceable>target_release_codename
</replaceable>
64 <arg choice='plain'
>update
</arg>
65 <arg choice='plain'
>upgrade
</arg>
66 <arg choice='plain'
>dselect-upgrade
</arg>
67 <arg choice='plain'
>dist-upgrade
</arg>
68 <arg choice='plain'
>install
69 <arg choice=
"plain" rep=
"repeat"><replaceable>pkg
</replaceable>
73 =
<replaceable>pkg_version_number
</replaceable>
76 /
<replaceable>target_release_name
</replaceable>
79 /
<replaceable>target_release_codename
</replaceable>
85 <arg choice='plain'
>remove
<arg choice=
"plain" rep=
"repeat"><replaceable>pkg
</replaceable></arg></arg>
86 <arg choice='plain'
>purge
<arg choice=
"plain" rep=
"repeat"><replaceable>pkg
</replaceable></arg></arg>
87 <arg choice='plain'
>source
88 <arg choice=
"plain" rep=
"repeat"><replaceable>pkg
</replaceable>
92 =
<replaceable>pkg_version_number
</replaceable>
95 /
<replaceable>target_release_name
</replaceable>
98 /
<replaceable>target_release_codename
</replaceable>
104 <arg choice='plain'
>build-dep
<arg choice=
"plain" rep=
"repeat"><replaceable>pkg
</replaceable></arg></arg>
105 <arg choice='plain'
>check
</arg>
106 <arg choice='plain'
>clean
</arg>
107 <arg choice='plain'
>autoclean
</arg>
108 <arg choice='plain'
>autoremove
</arg>
111 <arg choice='plain'
>-v
</arg>
112 <arg choice='plain'
>--version
</arg>
117 <arg choice='plain'
>-h
</arg>
118 <arg choice='plain'
>--help
</arg>
125 <refsect1><title>Description
</title>
126 <para><command>apt-get
</command> is the command-line tool for handling packages, and may be
127 considered the user's "back-end" to other tools using the APT
128 library. Several "front-end" interfaces exist, such as
&dselect;,
129 &aptitude;,
&synaptic;, &gnome-apt; and
&wajig;.
</para>
131 <para>Unless the
<option>-h
</option>, or
<option>--help
</option> option is given, one of the
132 commands below must be present.
</para>
135 <varlistentry><term>update
</term>
136 <listitem><para><literal>update
</literal> is used to resynchronize the package index files from
137 their sources. The indexes of available packages are fetched from the
138 location(s) specified in
<filename>/etc/apt/sources.list
</filename>.
139 For example, when using a Debian archive, this command retrieves and
140 scans the
<filename>Packages.gz
</filename> files, so that information about new
141 and updated packages is available. An
<literal>update
</literal> should always be
142 performed before an
<literal>upgrade
</literal> or
<literal>dist-upgrade
</literal>. Please
143 be aware that the overall progress meter will be incorrect as the size
144 of the package files cannot be known in advance.
</para></listitem>
147 <varlistentry><term>upgrade
</term>
148 <listitem><para><literal>upgrade
</literal> is used to install the newest versions of all packages
149 currently installed on the system from the sources enumerated in
150 <filename>/etc/apt/sources.list
</filename>. Packages currently installed with
151 new versions available are retrieved and upgraded; under no circumstances
152 are currently installed packages removed, or packages not already installed
153 retrieved and installed. New versions of currently installed packages that
154 cannot be upgraded without changing the install status of another package
155 will be left at their current version. An
<literal>update
</literal> must be
156 performed first so that
<command>apt-get
</command> knows that new versions of packages are
157 available.
</para></listitem>
160 <varlistentry><term>dselect-upgrade
</term>
161 <listitem><para><literal>dselect-upgrade
</literal>
162 is used in conjunction with the traditional Debian packaging
163 front-end,
&dselect;.
<literal>dselect-upgrade
</literal>
164 follows the changes made by
&dselect; to the
<literal>Status
</literal>
165 field of available packages, and performs the actions necessary to realize
166 that state (for instance, the removal of old and the installation of new
167 packages).
</para></listitem>
170 <varlistentry><term>dist-upgrade
</term>
171 <listitem><para><literal>dist-upgrade
</literal> in addition to performing the function of
172 <literal>upgrade
</literal>, also intelligently handles changing dependencies
173 with new versions of packages;
<command>apt-get
</command> has a "smart" conflict
174 resolution system, and it will attempt to upgrade the most important
175 packages at the expense of less important ones if necessary.
176 So,
<literal>dist-upgrade
</literal> command may remove some packages.
177 The
<filename>/etc/apt/sources.list
</filename> file contains a list of locations
178 from which to retrieve desired package files.
179 See also &apt-preferences; for a mechanism for
180 overriding the general settings for individual packages.
</para></listitem>
183 <varlistentry><term>install
</term>
185 <para><literal>install
</literal> is followed by one or more
186 packages desired for installation or upgrading.
187 Each package is a package name, not a fully qualified
188 filename (for instance, in a Debian GNU/Linux system,
189 libc6 would be the argument provided, not
190 <literal>libc6_1.9
.6-
2.deb
</literal>). All packages required
191 by the package(s) specified for installation will also
192 be retrieved and installed.
193 The
<filename>/etc/apt/sources.list
</filename> file is
194 used to locate the desired packages. If a hyphen is
195 appended to the package name (with no intervening space),
196 the identified package will be removed if it is installed.
197 Similarly a plus sign can be used to designate a
198 package to install. These latter features may be used
199 to override decisions made by apt-get's conflict
203 <para>A specific version of a package can be selected for installation by
204 following the package name with an equals and the version of the package
205 to select. This will cause that version to be located and selected for
206 install. Alternatively a specific distribution can be selected by
207 following the package name with a slash and the version of the
208 distribution or the Archive name (stable, testing, unstable).
</para>
210 <para>Both of the version selection mechanisms can downgrade packages and must
211 be used with care.
</para>
213 <para>This is also the target to use if you want to upgrade one or
214 more already-installed packages without upgrading every package
215 you have on your system. Unlike the "upgrade" target, which
216 installs the newest version of all currently installed packages,
217 "install" will install the newest version of only the package(s)
218 specified. Simply provide the name of the package(s) you wish
219 to upgrade, and if a newer version is available, it (and its
220 dependencies, as described above) will be downloaded and
224 <para>Finally, the &apt-preferences; mechanism allows you to
225 create an alternative installation policy for
226 individual packages.
</para>
228 <para>If no package matches the given expression and the expression contains one
229 of '.', '?' or '*' then it is assumed to be a POSIX regular expression,
231 to all package names in the database. Any matches are then installed (or
232 removed). Note that matching is done by substring so 'lo.*' matches 'how-lo'
233 and 'lowest'. If this is undesired, anchor the regular expression
234 with a '^' or '$' character, or create a more specific regular expression.
</para></listitem>
237 <varlistentry><term>remove
</term>
238 <listitem><para><literal>remove
</literal> is identical to
<literal>install
</literal> except that packages are
239 removed instead of installed. Note the removing a package leaves its
240 configuration files in system. If a plus sign is appended to the package
241 name (with no intervening space), the identified package will be
242 installed instead of removed.
</para></listitem>
245 <varlistentry><term>purge
</term>
246 <listitem><para><literal>purge
</literal> is identical to
<literal>remove
</literal> except that packages are
247 removed and purged (any configuration files are deleted too).
</para></listitem>
250 <varlistentry><term>source
</term>
251 <listitem><para><literal>source
</literal> causes
<command>apt-get
</command> to fetch source packages. APT
252 will examine the available packages to decide which source package to
253 fetch. It will then find and download into the current directory the
254 newest available version of that source package while respect the
255 default release, set with the option
<literal>APT::Default-Release
</literal>,
256 the
<option>-t
</option> option or per package with the
257 <literal>pkg/release
</literal> syntax, if possible.
</para>
259 <para>Source packages are tracked separately
260 from binary packages via
<literal>deb-src
</literal> type lines
261 in the &sources-list; file. This means that you will need to add such a line
262 for each repository you want to get sources from. If you don't do this
263 you will properly get another (newer, older or none) source version than
264 the one you have installed or could install.
</para>
266 <para>If the
<option>--compile
</option> option is specified
267 then the package will be compiled to a binary .deb using
268 <command>dpkg-buildpackage
</command>, if
<option>--download-only
</option>
269 is specified then the source package will not be unpacked.
</para>
271 <para>A specific source version can be retrieved by postfixing the source name
272 with an equals and then the version to fetch, similar to the mechanism
273 used for the package files. This enables exact matching of the source
274 package name and version, implicitly enabling the
275 <literal>APT::Get::Only-Source
</literal> option.
</para>
277 <para>Note that source packages are not tracked like binary packages, they
278 exist only in the current directory and are similar to downloading source
279 tar balls.
</para></listitem>
282 <varlistentry><term>build-dep
</term>
283 <listitem><para><literal>build-dep
</literal> causes apt-get to install/remove packages in an
284 attempt to satisfy the build dependencies for a source package.
</para></listitem>
287 <varlistentry><term>check
</term>
288 <listitem><para><literal>check
</literal> is a diagnostic tool; it updates the package cache and checks
289 for broken dependencies.
</para></listitem>
292 <varlistentry><term>clean
</term>
293 <listitem><para><literal>clean
</literal> clears out the local repository of retrieved package
294 files. It removes everything but the lock file from
295 <filename>&cachedir;/archives/
</filename> and
296 <filename>&cachedir;/archives/partial/
</filename>. When APT is used as a
297 &dselect; method,
<literal>clean
</literal> is run automatically.
298 Those who do not use dselect will likely want to run
<literal>apt-get clean
</literal>
299 from time to time to free up disk space.
</para></listitem>
302 <varlistentry><term>autoclean
</term>
303 <listitem><para>Like
<literal>clean
</literal>,
<literal>autoclean
</literal> clears out the local
304 repository of retrieved package files. The difference is that it only
305 removes package files that can no longer be downloaded, and are largely
306 useless. This allows a cache to be maintained over a long period without
307 it growing out of control. The configuration option
308 <literal>APT::Clean-Installed
</literal> will prevent installed packages from being
309 erased if it is set to off.
</para></listitem>
312 <varlistentry><term>autoremove
</term>
313 <listitem><para><literal>autoremove
</literal> is used to remove packages that were automatically
314 installed to satisfy dependencies for some package and that are no more needed.
</para></listitem>
319 <refsect1><title>options
</title>
323 <varlistentry><term><option>--no-install-recommends
</option></term>
324 <listitem><para>Do not consider recommended packages as a dependency for installing.
325 Configuration Item:
<literal>APT::Install-Recommends
</literal>.
</para></listitem>
328 <varlistentry><term><option>-d
</option></term><term><option>--download-only
</option></term>
329 <listitem><para>Download only; package files are only retrieved, not unpacked or installed.
330 Configuration Item:
<literal>APT::Get::Download-Only
</literal>.
</para></listitem>
333 <varlistentry><term><option>-f
</option></term><term><option>--fix-broken
</option></term>
334 <listitem><para>Fix; attempt to correct a system with broken dependencies in
335 place. This option, when used with install/remove, can omit any packages
336 to permit APT to deduce a likely solution. If packages are specified,
337 these have to completely correct the problem. The option is sometimes necessary when
338 running APT for the first time; APT itself does not allow broken package
339 dependencies to exist on a system. It is possible that a system's
340 dependency structure can be so corrupt as to require manual intervention
341 (which usually means using
&dselect; or
<command>dpkg --remove
</command> to eliminate some of
342 the offending packages). Use of this option together with
<option>-m
</option> may produce an
343 error in some situations.
344 Configuration Item:
<literal>APT::Get::Fix-Broken
</literal>.
</para></listitem>
347 <varlistentry><term><option>-m
</option></term><term><option>--ignore-missing
</option></term>
348 <term><option>--fix-missing
</option></term>
349 <listitem><para>Ignore missing packages; If packages cannot be retrieved or fail the
350 integrity check after retrieval (corrupted package files), hold back
351 those packages and handle the result. Use of this option together with
352 <option>-f
</option> may produce an error in some situations. If a package is
353 selected for installation (particularly if it is mentioned on the
354 command line) and it could not be downloaded then it will be silently
356 Configuration Item:
<literal>APT::Get::Fix-Missing
</literal>.
</para></listitem>
359 <varlistentry><term><option>--no-download
</option></term>
360 <listitem><para>Disables downloading of packages. This is best used with
361 <option>--ignore-missing
</option> to force APT to use only the .debs it has
363 Configuration Item:
<literal>APT::Get::Download
</literal>.
</para></listitem>
366 <varlistentry><term><option>-q
</option></term><term><option>--quiet
</option></term>
367 <listitem><para>Quiet; produces output suitable for logging, omitting progress indicators.
368 More q's will produce more quiet up to a maximum of
2. You can also use
369 <option>-q=#
</option> to set the quiet level, overriding the configuration file.
370 Note that quiet level
2 implies
<option>-y
</option>, you should never use -qq
371 without a no-action modifier such as -d, --print-uris or -s as APT may
372 decided to do something you did not expect.
373 Configuration Item:
<literal>quiet
</literal>.
</para></listitem>
376 <varlistentry><term><option>-s
</option></term>
377 <term><option>--simulate
</option></term>
378 <term><option>--just-print
</option></term>
379 <term><option>--dry-run
</option></term>
380 <term><option>--recon
</option></term>
381 <term><option>--no-act
</option></term>
382 <listitem><para>No action; perform a simulation of events that would occur but do not
383 actually change the system.
384 Configuration Item:
<literal>APT::Get::Simulate
</literal>.
</para>
386 <para>Simulation run as user will deactivate locking (
<literal>Debug::NoLocking
</literal>)
387 automatic. Also a notice will be displayed indicating that this is only a simulation,
388 if the option
<literal>APT::Get::Show-User-Simulation-Note
</literal> is set (Default: true).
389 Neither NoLocking nor the notice will be triggered if run as root (root should know what
390 he is doing without further warnings by
<literal>apt-get
</literal>).
</para>
392 <para>Simulate prints out
393 a series of lines each one representing a dpkg operation, Configure (Conf),
394 Remove (Remv), Unpack (Inst). Square brackets indicate broken packages
395 and empty set of square brackets meaning breaks that are of no consequence
396 (rare).
</para></listitem>
399 <varlistentry><term><option>-y
</option></term><term><option>--yes
</option></term>
400 <term><option>--assume-yes
</option></term>
401 <listitem><para>Automatic yes to prompts; assume "yes" as answer to all prompts and run
402 non-interactively. If an undesirable situation, such as changing a held
403 package, trying to install a unauthenticated package or removing an essential package
404 occurs then
<literal>apt-get
</literal> will abort.
405 Configuration Item:
<literal>APT::Get::Assume-Yes
</literal>.
</para></listitem>
408 <varlistentry><term><option>-u
</option></term><term><option>--show-upgraded
</option></term>
409 <listitem><para>Show upgraded packages; Print out a list of all packages that are to be
411 Configuration Item:
<literal>APT::Get::Show-Upgraded
</literal>.
</para></listitem>
414 <varlistentry><term><option>-V
</option></term><term><option>--verbose-versions
</option></term>
415 <listitem><para>Show full versions for upgraded and installed packages.
416 Configuration Item:
<literal>APT::Get::Show-Versions
</literal>.
</para></listitem>
419 <varlistentry><term><option>-b
</option></term><term><option>--compile
</option></term>
420 <term><option>--build
</option></term>
421 <listitem><para>Compile source packages after downloading them.
422 Configuration Item:
<literal>APT::Get::Compile
</literal>.
</para></listitem>
425 <varlistentry><term><option>--install-recommends
</option></term>
426 <listitem><para>Also install recommended packages.
</para></listitem>
429 <varlistentry><term><option>--no-install-recommends
</option></term>
430 <listitem><para>Do not install recommended packages.
</para></listitem>
433 <varlistentry><term><option>--ignore-hold
</option></term>
434 <listitem><para>Ignore package Holds; This causes
<command>apt-get
</command> to ignore a hold
435 placed on a package. This may be useful in conjunction with
436 <literal>dist-upgrade
</literal> to override a large number of undesired holds.
437 Configuration Item:
<literal>APT::Ignore-Hold
</literal>.
</para></listitem>
440 <varlistentry><term><option>--no-upgrade
</option></term>
441 <listitem><para>Do not upgrade packages; When used in conjunction with
<literal>install
</literal>,
442 <literal>no-upgrade
</literal> will prevent packages on the command line
443 from being upgraded if they are already installed.
444 Configuration Item:
<literal>APT::Get::Upgrade
</literal>.
</para></listitem>
447 <varlistentry><term><option>--only-upgrade
</option></term>
448 <listitem><para>Do not install new packages; When used in conjunction with
<literal>install
</literal>,
449 <literal>only-upgrade
</literal> will prevent packages on the command line
450 from being upgraded if they are not already installed.
451 Configuration Item:
<literal>APT::Get::Only-Upgrade
</literal>.
</para></listitem>
454 <varlistentry><term><option>--force-yes
</option></term>
455 <listitem><para>Force yes; This is a dangerous option that will cause apt to continue
456 without prompting if it is doing something potentially harmful. It
457 should not be used except in very special situations. Using
458 <literal>force-yes
</literal> can potentially destroy your system!
459 Configuration Item:
<literal>APT::Get::force-yes
</literal>.
</para></listitem>
462 <varlistentry><term><option>--print-uris
</option></term>
463 <listitem><para>Instead of fetching the files to install their URIs are printed. Each
464 URI will have the path, the destination file name, the size and the expected
465 md5 hash. Note that the file name to write to will not always match
466 the file name on the remote site! This also works with the
467 <literal>source
</literal> and
<literal>update
</literal> commands. When used with the
468 <literal>update
</literal> command the MD5 and size are not included, and it is
469 up to the user to decompress any compressed files.
470 Configuration Item:
<literal>APT::Get::Print-URIs
</literal>.
</para></listitem>
473 <varlistentry><term><option>--purge
</option></term>
474 <listitem><para>Use purge instead of remove for anything that would be removed.
475 An asterisk ("*") will be displayed next to packages which are
476 scheduled to be purged.
<option>remove --purge
</option> is equivalent to the
477 <option>purge
</option> command.
478 Configuration Item:
<literal>APT::Get::Purge
</literal>.
</para></listitem>
481 <varlistentry><term><option>--reinstall
</option></term>
482 <listitem><para>Re-Install packages that are already installed and at the newest version.
483 Configuration Item:
<literal>APT::Get::ReInstall
</literal>.
</para></listitem>
486 <varlistentry><term><option>--list-cleanup
</option></term>
487 <listitem><para>This option defaults to on, use
<literal>--no-list-cleanup
</literal> to turn it
488 off. When on
<command>apt-get
</command> will automatically manage the contents of
489 <filename>&statedir;/lists
</filename> to ensure that obsolete files are erased.
490 The only reason to turn it off is if you frequently change your source
492 Configuration Item:
<literal>APT::Get::List-Cleanup
</literal>.
</para></listitem>
495 <varlistentry><term><option>-t
</option></term>
496 <term><option>--target-release
</option></term>
497 <term><option>--default-release
</option></term>
498 <listitem><para>This option controls the default input to the policy engine, it creates
499 a default pin at priority
990 using the specified release string.
500 This overrides the general settings in
<filename>/etc/apt/preferences
</filename>.
501 Specifically pinned packages are not affected by the value
502 of this option. In short, this option
503 lets you have simple control over which distribution packages will be
504 retrieved from. Some common examples might be
505 <option>-t '
2.1*'
</option>,
<option>-t unstable
</option>
506 or
<option>-t sid
</option>.
507 Configuration Item:
<literal>APT::Default-Release
</literal>;
508 see also the &apt-preferences; manual page.
</para></listitem>
511 <varlistentry><term><option>--trivial-only
</option></term>
513 Only perform operations that are 'trivial'. Logically this can be considered
514 related to
<option>--assume-yes
</option>, where
<option>--assume-yes
</option> will answer
515 yes to any prompt,
<option>--trivial-only
</option> will answer no.
516 Configuration Item:
<literal>APT::Get::Trivial-Only
</literal>.
</para></listitem>
519 <varlistentry><term><option>--no-remove
</option></term>
520 <listitem><para>If any packages are to be removed apt-get immediately aborts without
522 Configuration Item:
<literal>APT::Get::Remove
</literal>.
</para></listitem>
525 <varlistentry><term><option>--auto-remove
</option></term>
526 <listitem><para>If the command is either
<literal>install
</literal> or
<literal>remove
</literal>,
527 then this option acts like running
<literal>autoremove
</literal> command, removing the unused
528 dependency packages. Configuration Item:
<literal>APT::Get::AutomaticRemove
</literal>.
532 <varlistentry><term><option>--only-source
</option></term>
533 <listitem><para>Only has meaning for the
534 <literal>source
</literal> and
<literal>build-dep
</literal>
535 commands. Indicates that the given source names are not to be
536 mapped through the binary table. This means that if this option
537 is specified, these commands will only accept source package
538 names as arguments, rather than accepting binary package names
539 and looking up the corresponding source package. Configuration
540 Item:
<literal>APT::Get::Only-Source
</literal>.
</para></listitem>
543 <varlistentry><term><option>--diff-only
</option></term><term><option>--dsc-only
</option></term><term><option>--tar-only
</option></term>
544 <listitem><para>Download only the diff, dsc, or tar file of a source archive.
545 Configuration Item:
<literal>APT::Get::Diff-Only
</literal>,
<literal>APT::Get::Dsc-Only
</literal>, and
546 <literal>APT::Get::Tar-Only
</literal>.
</para></listitem>
549 <varlistentry><term><option>--arch-only
</option></term>
550 <listitem><para>Only process architecture-dependent build-dependencies.
551 Configuration Item:
<literal>APT::Get::Arch-Only
</literal>.
</para></listitem>
554 <varlistentry><term><option>--allow-unauthenticated
</option></term>
555 <listitem><para>Ignore if packages can't be authenticated and don't prompt about it.
556 This is useful for tools like pbuilder.
557 Configuration Item:
<literal>APT::Get::AllowUnauthenticated
</literal>.
</para></listitem>
566 <refsect1><title>Files
</title>
576 <refsect1><title>See Also
</title>
577 <para>&apt-cache;, &apt-cdrom;,
&dpkg;,
&dselect;, &sources-list;,
578 &apt-conf;, &apt-config;, &apt-secure;,
579 The APT User's guide in
&guidesdir;, &apt-preferences;, the APT Howto.
</para>
582 <refsect1><title>Diagnostics
</title>
583 <para><command>apt-get
</command> returns zero on normal operation, decimal
100 on error.
</para>
586 <title>ORIGINAL AUTHORS
</title>
587 <para>&apt-author.jgunthorpe;
</para>
590 <title>CURRENT AUTHORS
</title>