Clearly documented '/<release>' and '=<version>' in apt-get.8.
[ntk/apt.git] / doc / apt-get.8.xml
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" [
4
5 <!ENTITY % aptent SYSTEM "apt.ent">
6 %aptent;
7
8 ]>
9
10 <refentry>
11
12 <refentryinfo>
13 &apt-author.jgunthorpe;
14 &apt-author.team;
15 &apt-email;
16 &apt-product;
17 <!-- The last update date -->
18 <date>28 October 2008</date>
19 </refentryinfo>
20
21 <refmeta>
22 <refentrytitle>apt-get</refentrytitle>
23 <manvolnum>8</manvolnum>
24 </refmeta>
25
26 <!-- Man page title -->
27 <refnamediv>
28 <refname>apt-get</refname>
29 <refpurpose>APT package handling utility -- command-line interface</refpurpose>
30 </refnamediv>
31
32 <!-- Arguments -->
33 <refsynopsisdiv>
34 <cmdsynopsis>
35 <command>apt-get</command>
36 <arg><option>-hvs</option></arg>
37 <arg><option>-o=<replaceable>config string</replaceable></option></arg>
38 <arg><option>-c=<replaceable>file</replaceable></option></arg>
39 <group choice="req">
40 <arg>update</arg>
41 <arg>upgrade</arg>
42 <arg>dselect-upgrade</arg>
43 <arg>install
44 <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable>
45 <group choice='opt'>
46 <arg>
47 =<replaceable>pkg_version_number</replaceable>
48 </arg>
49 <arg>
50 /<replaceable>target_release_name</replaceable>
51 </arg>
52 </group>
53 </arg>
54 </arg>
55 <arg>remove <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
56 <arg>purge <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
57 </arg>
58 <arg>source
59 <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable>
60 <group choice='opt'>
61 <arg>
62 =<replaceable>pkg_version_number</replaceable>
63 </arg>
64 </group>
65 </arg>
66 </arg>
67 <arg>build-dep <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
68 <arg>check</arg>
69 <arg>clean</arg>
70 <arg>autoclean</arg>
71 <arg>autoremove</arg>
72 </group>
73 </cmdsynopsis>
74 </refsynopsisdiv>
75
76 <refsect1><title>Description</title>
77 <para><command>apt-get</command> is the command-line tool for handling packages, and may be
78 considered the user's "back-end" to other tools using the APT
79 library. Several "front-end" interfaces exist, such as dselect(8),
80 aptitude, synaptic, gnome-apt and wajig.</para>
81
82 <para>Unless the <option>-h</option>, or <option>--help</option> option is given, one of the
83 commands below must be present.</para>
84
85 <variablelist>
86 <varlistentry><term>update</term>
87 <listitem><para><literal>update</literal> is used to resynchronize the package index files from
88 their sources. The indexes of available packages are fetched from the
89 location(s) specified in <filename>/etc/apt/sources.list</filename>.
90 For example, when using a Debian archive, this command retrieves and
91 scans the <filename>Packages.gz</filename> files, so that information about new
92 and updated packages is available. An <literal>update</literal> should always be
93 performed before an <literal>upgrade</literal> or <literal>dist-upgrade</literal>. Please
94 be aware that the overall progress meter will be incorrect as the size
95 of the package files cannot be known in advance.</para></listitem>
96 </varlistentry>
97
98 <varlistentry><term>upgrade</term>
99 <listitem><para><literal>upgrade</literal> is used to install the newest versions of all packages
100 currently installed on the system from the sources enumerated in
101 <filename>/etc/apt/sources.list</filename>. Packages currently installed with
102 new versions available are retrieved and upgraded; under no circumstances
103 are currently installed packages removed, or packages not already installed
104 retrieved and installed. New versions of currently installed packages that
105 cannot be upgraded without changing the install status of another package
106 will be left at their current version. An <literal>update</literal> must be
107 performed first so that <command>apt-get</command> knows that new versions of packages are
108 available.</para></listitem>
109 </varlistentry>
110
111 <varlistentry><term>dselect-upgrade</term>
112 <listitem><para><literal>dselect-upgrade</literal>
113 is used in conjunction with the traditional Debian packaging
114 front-end, &dselect;. <literal>dselect-upgrade</literal>
115 follows the changes made by &dselect; to the <literal>Status</literal>
116 field of available packages, and performs the actions necessary to realize
117 that state (for instance, the removal of old and the installation of new
118 packages).</para></listitem>
119 </varlistentry>
120
121 <varlistentry><term>dist-upgrade</term>
122 <listitem><para><literal>dist-upgrade</literal> in addition to performing the function of
123 <literal>upgrade</literal>, also intelligently handles changing dependencies
124 with new versions of packages; <command>apt-get</command> has a "smart" conflict
125 resolution system, and it will attempt to upgrade the most important
126 packages at the expense of less important ones if necessary.
127 The <filename>/etc/apt/sources.list</filename> file contains a list of locations
128 from which to retrieve desired package files.
129 See also &apt-preferences; for a mechanism for
130 overriding the general settings for individual packages.</para></listitem>
131 </varlistentry>
132
133 <varlistentry><term>install</term>
134 <listitem><para><literal>install</literal> is followed by one or more packages desired for
135 installation. Each package is a package name, not a fully qualified
136 filename (for instance, in a Debian GNU/Linux system, libc6 would be the
137 argument provided, not <literal>libc6_1.9.6-2.deb</literal>) All packages required
138 by the package(s) specified for installation will also be retrieved and
139 installed. The <filename>/etc/apt/sources.list</filename> file is used to locate
140 the desired packages. If a hyphen is appended to the package name (with
141 no intervening space), the identified package will be removed if it is
142 installed. Similarly a plus sign can be used to designate a package to
143 install. These latter features may be used to override decisions made by
144 apt-get's conflict resolution system.</para>
145
146 <para>A specific version of a package can be selected for installation by
147 following the package name with an equals and the version of the package
148 to select. This will cause that version to be located and selected for
149 install. Alternatively a specific distribution can be selected by
150 following the package name with a slash and the version of the
151 distribution or the Archive name (stable, testing, unstable).</para>
152
153 <para>Both of the version selection mechanisms can downgrade packages and must
154 be used with care.</para>
155
156 <para>Finally, the &apt-preferences; mechanism allows you to
157 create an alternative installation policy for
158 individual packages.</para>
159
160 <para>If no package matches the given expression and the expression contains one
161 of '.', '?' or '*' then it is assumed to be a POSIX regular expression,
162 and it is applied
163 to all package names in the database. Any matches are then installed (or
164 removed). Note that matching is done by substring so 'lo.*' matches 'how-lo'
165 and 'lowest'. If this is undesired, anchor the regular expression
166 with a '^' or '$' character, or create a more specific regular expression.</para></listitem>
167 </varlistentry>
168
169 <varlistentry><term>remove</term>
170 <listitem><para><literal>remove</literal> is identical to <literal>install</literal> except that packages are
171 removed instead of installed. If a plus sign is appended to the package
172 name (with no intervening space), the identified package will be
173 installed instead of removed.</para></listitem>
174 </varlistentry>
175
176 <varlistentry><term>purge</term>
177 <listitem><para><literal>purge</literal> is identical to <literal>remove</literal> except that packages are
178 removed and purged.</para></listitem>
179 </varlistentry>
180
181 <varlistentry><term>source</term>
182 <listitem><para><literal>source</literal> causes <command>apt-get</command> to fetch source packages. APT
183 will examine the available packages to decide which source package to
184 fetch. It will then find and download into the current directory the
185 newest available version of that source package. Source packages are
186 tracked separately from binary packages via <literal>deb-src</literal> type lines
187 in the &sources-list; file. This probably will mean that you will not
188 get the same source as the package you have installed or as you could
189 install. If the --compile options is specified then the package will be
190 compiled to a binary .deb using dpkg-buildpackage, if --download-only is
191 specified then the source package will not be unpacked.</para>
192
193 <para>A specific source version can be retrieved by postfixing the source name
194 with an equals and then the version to fetch, similar to the mechanism
195 used for the package files. This enables exact matching of the source
196 package name and version, implicitly enabling the
197 <literal>APT::Get::Only-Source</literal> option.</para>
198
199 <para>Note that source packages are not tracked like binary packages, they
200 exist only in the current directory and are similar to downloading source
201 tar balls.</para></listitem>
202 </varlistentry>
203
204 <varlistentry><term>build-dep</term>
205 <listitem><para><literal>build-dep</literal> causes apt-get to install/remove packages in an
206 attempt to satisfy the build dependencies for a source package.</para></listitem>
207 </varlistentry>
208
209 <varlistentry><term>check</term>
210 <listitem><para><literal>check</literal> is a diagnostic tool; it updates the package cache and checks
211 for broken dependencies.</para></listitem>
212 </varlistentry>
213
214 <varlistentry><term>clean</term>
215 <listitem><para><literal>clean</literal> clears out the local repository of retrieved package
216 files. It removes everything but the lock file from
217 <filename>&cachedir;/archives/</filename> and
218 <filename>&cachedir;/archives/partial/</filename>. When APT is used as a
219 &dselect; method, <literal>clean</literal> is run automatically.
220 Those who do not use dselect will likely want to run <literal>apt-get clean</literal>
221 from time to time to free up disk space.</para></listitem>
222 </varlistentry>
223
224 <varlistentry><term>autoclean</term>
225 <listitem><para>Like <literal>clean</literal>, <literal>autoclean</literal> clears out the local
226 repository of retrieved package files. The difference is that it only
227 removes package files that can no longer be downloaded, and are largely
228 useless. This allows a cache to be maintained over a long period without
229 it growing out of control. The configuration option
230 <literal>APT::Clean-Installed</literal> will prevent installed packages from being
231 erased if it is set to off.</para></listitem>
232 </varlistentry>
233
234 <varlistentry><term>autoremove</term>
235 <listitem><para><literal>autoremove</literal> is used to remove packages that were automatically
236 installed to satisfy dependencies for some package and that are no more needed.</para></listitem>
237 </varlistentry>
238 </variablelist>
239 </refsect1>
240
241 <refsect1><title>options</title>
242 &apt-cmdblurb;
243
244 <variablelist>
245 <varlistentry><term><option>-d</option></term><term><option>--download-only</option></term>
246 <listitem><para>Download only; package files are only retrieved, not unpacked or installed.
247 Configuration Item: <literal>APT::Get::Download-Only</literal>.</para></listitem>
248 </varlistentry>
249
250 <varlistentry><term><option>-f</option></term><term><option>--fix-broken</option></term>
251 <listitem><para>Fix; attempt to correct a system with broken dependencies in
252 place. This option, when used with install/remove, can omit any packages
253 to permit APT to deduce a likely solution. Any Package that are specified
254 must completely correct the problem. The option is sometimes necessary when
255 running APT for the first time; APT itself does not allow broken package
256 dependencies to exist on a system. It is possible that a system's
257 dependency structure can be so corrupt as to require manual intervention
258 (which usually means using &dselect; or <command>dpkg --remove</command> to eliminate some of
259 the offending packages). Use of this option together with <option>-m</option> may produce an
260 error in some situations.
261 Configuration Item: <literal>APT::Get::Fix-Broken</literal>.</para></listitem>
262 </varlistentry>
263
264 <varlistentry><term><option>-m</option></term><term><option>--ignore-missing</option></term>
265 <term><option>--fix-missing</option></term>
266 <listitem><para>Ignore missing packages; If packages cannot be retrieved or fail the
267 integrity check after retrieval (corrupted package files), hold back
268 those packages and handle the result. Use of this option together with
269 <option>-f</option> may produce an error in some situations. If a package is
270 selected for installation (particularly if it is mentioned on the
271 command line) and it could not be downloaded then it will be silently
272 held back.
273 Configuration Item: <literal>APT::Get::Fix-Missing</literal>.</para></listitem>
274 </varlistentry>
275
276 <varlistentry><term><option>--no-download</option></term>
277 <listitem><para>Disables downloading of packages. This is best used with
278 <option>--ignore-missing</option> to force APT to use only the .debs it has
279 already downloaded.
280 Configuration Item: <literal>APT::Get::Download</literal>.</para></listitem>
281 </varlistentry>
282
283 <varlistentry><term><option>-q</option></term><term><option>--quiet</option></term>
284 <listitem><para>Quiet; produces output suitable for logging, omitting progress indicators.
285 More q's will produce more quiet up to a maximum of 2. You can also use
286 <option>-q=#</option> to set the quiet level, overriding the configuration file.
287 Note that quiet level 2 implies <option>-y</option>, you should never use -qq
288 without a no-action modifier such as -d, --print-uris or -s as APT may
289 decided to do something you did not expect.
290 Configuration Item: <literal>quiet</literal>.</para></listitem>
291 </varlistentry>
292
293 <varlistentry><term><option>-s</option></term>
294 <term><option>--simulate</option></term>
295 <term><option>--just-print</option></term>
296 <term><option>--dry-run</option></term>
297 <term><option>--recon</option></term>
298 <term><option>--no-act</option></term>
299 <listitem><para>No action; perform a simulation of events that would occur but do not
300 actually change the system.
301 Configuration Item: <literal>APT::Get::Simulate</literal>.</para>
302
303 <para>Simulate prints out
304 a series of lines each one representing a dpkg operation, Configure (Conf),
305 Remove (Remv), Unpack (Inst). Square brackets indicate broken packages with
306 and empty set of square brackets meaning breaks that are of no consequence
307 (rare).</para></listitem>
308 </varlistentry>
309
310 <varlistentry><term><option>-y</option></term><term><option>--yes</option></term>
311 <term><option>--assume-yes</option></term>
312 <listitem><para>Automatic yes to prompts; assume "yes" as answer to all prompts and run
313 non-interactively. If an undesirable situation, such as changing a held
314 package, trying to install a unauthenticated package or removing an essential package
315 occurs then <literal>apt-get</literal> will abort.
316 Configuration Item: <literal>APT::Get::Assume-Yes</literal>.</para></listitem>
317 </varlistentry>
318
319 <varlistentry><term><option>-u</option></term><term><option>--show-upgraded</option></term>
320 <listitem><para>Show upgraded packages; Print out a list of all packages that are to be
321 upgraded.
322 Configuration Item: <literal>APT::Get::Show-Upgraded</literal>.</para></listitem>
323 </varlistentry>
324
325 <varlistentry><term><option>-V</option></term><term><option>--verbose-versions</option></term>
326 <listitem><para>Show full versions for upgraded and installed packages.
327 Configuration Item: <literal>APT::Get::Show-Versions</literal>.</para></listitem>
328 </varlistentry>
329
330 <varlistentry><term><option>-b</option></term><term><option>--compile</option></term>
331 <term><option>--build</option></term>
332 <listitem><para>Compile source packages after downloading them.
333 Configuration Item: <literal>APT::Get::Compile</literal>.</para></listitem>
334 </varlistentry>
335
336 <varlistentry><term><option>--ignore-hold</option></term>
337 <listitem><para>Ignore package Holds; This causes <command>apt-get</command> to ignore a hold
338 placed on a package. This may be useful in conjunction with
339 <literal>dist-upgrade</literal> to override a large number of undesired holds.
340 Configuration Item: <literal>APT::Ignore-Hold</literal>.</para></listitem>
341 </varlistentry>
342
343 <varlistentry><term><option>--no-upgrade</option></term>
344 <listitem><para>Do not upgrade packages; When used in conjunction with <literal>install</literal>,
345 <literal>no-upgrade</literal> will prevent packages on the command line
346 from being upgraded if they are already installed.
347 Configuration Item: <literal>APT::Get::Upgrade</literal>.</para></listitem>
348 </varlistentry>
349
350 <varlistentry><term><option>--force-yes</option></term>
351 <listitem><para>Force yes; This is a dangerous option that will cause apt to continue
352 without prompting if it is doing something potentially harmful. It
353 should not be used except in very special situations. Using
354 <literal>force-yes</literal> can potentially destroy your system!
355 Configuration Item: <literal>APT::Get::force-yes</literal>.</para></listitem>
356 </varlistentry>
357
358 <varlistentry><term><option>--print-uris</option></term>
359 <listitem><para>Instead of fetching the files to install their URIs are printed. Each
360 URI will have the path, the destination file name, the size and the expected
361 md5 hash. Note that the file name to write to will not always match
362 the file name on the remote site! This also works with the
363 <literal>source</literal> and <literal>update</literal> commands. When used with the
364 <literal>update</literal> command the MD5 and size are not included, and it is
365 up to the user to decompress any compressed files.
366 Configuration Item: <literal>APT::Get::Print-URIs</literal>.</para></listitem>
367 </varlistentry>
368
369 <varlistentry><term><option>--purge</option></term>
370 <listitem><para>Use purge instead of remove for anything that would be removed.
371 An asterisk ("*") will be displayed next to packages which are
372 scheduled to be purged.
373 Configuration Item: <literal>APT::Get::Purge</literal>.</para></listitem>
374 </varlistentry>
375
376 <varlistentry><term><option>--reinstall</option></term>
377 <listitem><para>Re-Install packages that are already installed and at the newest version.
378 Configuration Item: <literal>APT::Get::ReInstall</literal>.</para></listitem>
379 </varlistentry>
380
381 <varlistentry><term><option>--list-cleanup</option></term>
382 <listitem><para>This option defaults to on, use <literal>--no-list-cleanup</literal> to turn it
383 off. When on <command>apt-get</command> will automatically manage the contents of
384 <filename>&statedir;/lists</filename> to ensure that obsolete files are erased.
385 The only reason to turn it off is if you frequently change your source
386 list.
387 Configuration Item: <literal>APT::Get::List-Cleanup</literal>.</para></listitem>
388 </varlistentry>
389
390 <varlistentry><term><option>-t</option></term>
391 <term><option>--target-release</option></term>
392 <term><option>--default-release</option></term>
393 <listitem><para>This option controls the default input to the policy engine, it creates
394 a default pin at priority 990 using the specified release string.
395 This overrides the general settings in <filename>/etc/apt/preferences</filename>.
396 Specifically pinned packages are not affected by the value
397 of this option. In short, this option
398 lets you have simple control over which distribution packages will be
399 retrieved from. Some common examples might be
400 <option>-t '2.1*'</option> or <option>-t unstable</option>.
401 Configuration Item: <literal>APT::Default-Release</literal>;
402 see also the &apt-preferences; manual page.</para></listitem>
403 </varlistentry>
404
405 <varlistentry><term><option>--trivial-only</option></term>
406 <listitem><para>
407 Only perform operations that are 'trivial'. Logically this can be considered
408 related to <option>--assume-yes</option>, where <option>--assume-yes</option> will answer
409 yes to any prompt, <option>--trivial-only</option> will answer no.
410 Configuration Item: <literal>APT::Get::Trivial-Only</literal>.</para></listitem>
411 </varlistentry>
412
413 <varlistentry><term><option>--no-remove</option></term>
414 <listitem><para>If any packages are to be removed apt-get immediately aborts without
415 prompting.
416 Configuration Item: <literal>APT::Get::Remove</literal>.</para></listitem>
417 </varlistentry>
418
419 <varlistentry><term><option>--auto-remove</option></term>
420 <listitem><para>If the command is either <literal>install</literal> or <literal>remove</literal>,
421 then this option acts like running <literal>autoremove</literal> command, removing the unused
422 dependency packages. Configuration Item: <literal>APT::Get::AutomaticRemove</literal>.
423 </para></listitem>
424 </varlistentry>
425
426 <varlistentry><term><option>--only-source</option></term>
427 <listitem><para>Only has meaning for the
428 <literal>source</literal> and <literal>build-dep</literal>
429 commands. Indicates that the given source names are not to be
430 mapped through the binary table. This means that if this option
431 is specified, these commands will only accept source package
432 names as arguments, rather than accepting binary package names
433 and looking up the corresponding source package. Configuration
434 Item: <literal>APT::Get::Only-Source</literal>.</para></listitem>
435 </varlistentry>
436
437 <varlistentry><term><option>--diff-only</option></term><term><option>--dsc-only</option></term><term><option>--tar-only</option></term>
438 <listitem><para>Download only the diff, dsc, or tar file of a source archive.
439 Configuration Item: <literal>APT::Get::Diff-Only</literal>, <literal>APT::Get::Dsc-Only</literal>, and
440 <literal>APT::Get::Tar-Only</literal>.</para></listitem>
441 </varlistentry>
442
443 <varlistentry><term><option>--arch-only</option></term>
444 <listitem><para>Only process architecture-dependent build-dependencies.
445 Configuration Item: <literal>APT::Get::Arch-Only</literal>.</para></listitem>
446 </varlistentry>
447
448 <varlistentry><term><option>--allow-unauthenticated</option></term>
449 <listitem><para>Ignore if packages can't be authenticated and don't prompt about it.
450 This is useful for tools like pbuilder.
451 Configuration Item: <literal>APT::Get::AllowUnauthenticated</literal>.</para></listitem>
452 </varlistentry>
453
454
455 &apt-commonoptions;
456
457 </variablelist>
458 </refsect1>
459
460 <refsect1><title>Files</title>
461 <variablelist>
462 <varlistentry><term><filename>/etc/apt/sources.list</filename></term>
463 <listitem><para>Locations to fetch packages from.
464 Configuration Item: <literal>Dir::Etc::SourceList</literal>.</para></listitem>
465 </varlistentry>
466
467 <varlistentry><term><filename>/etc/apt/apt.conf</filename></term>
468 <listitem><para>APT configuration file.
469 Configuration Item: <literal>Dir::Etc::Main</literal>.</para></listitem>
470 </varlistentry>
471
472 <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term>
473 <listitem><para>APT configuration file fragments
474 Configuration Item: <literal>Dir::Etc::Parts</literal>.</para></listitem>
475 </varlistentry>
476
477 <varlistentry><term><filename>/etc/apt/preferences</filename></term>
478 <listitem><para>Version preferences file.
479 This is where you would specify "pinning",
480 i.e. a preference to get certain packages
481 from a separate source
482 or from a different version of a distribution.
483 Configuration Item: <literal>Dir::Etc::Preferences</literal>.</para></listitem>
484 </varlistentry>
485
486 <varlistentry><term><filename>&cachedir;/archives/</filename></term>
487 <listitem><para>Storage area for retrieved package files.
488 Configuration Item: <literal>Dir::Cache::Archives</literal>.</para></listitem>
489 </varlistentry>
490
491 <varlistentry><term><filename>&cachedir;/archives/partial/</filename></term>
492 <listitem><para>Storage area for package files in transit.
493 Configuration Item: <literal>Dir::Cache::Archives</literal> (implicit partial). </para></listitem>
494 </varlistentry>
495
496 <varlistentry><term><filename>&statedir;/lists/</filename></term>
497 <listitem><para>Storage area for state information for each package resource specified in
498 &sources-list;
499 Configuration Item: <literal>Dir::State::Lists</literal>.</para></listitem>
500 </varlistentry>
501
502 <varlistentry><term><filename>&statedir;/lists/partial/</filename></term>
503 <listitem><para> Storage area for state information in transit.
504 Configuration Item: <literal>Dir::State::Lists</literal> (implicit partial).</para></listitem>
505 </varlistentry>
506 </variablelist>
507 </refsect1>
508
509 <refsect1><title>See Also</title>
510 <para>&apt-cache;, &apt-cdrom;, &dpkg;, &dselect;, &sources-list;,
511 &apt-conf;, &apt-config;, &apt-secure;,
512 The APT User's guide in &guidesdir;, &apt-preferences;, the APT Howto.</para>
513 </refsect1>
514
515 <refsect1><title>Diagnostics</title>
516 <para><command>apt-get</command> returns zero on normal operation, decimal 100 on error.</para>
517 </refsect1>
518 <refsect1>
519 <title>ORIGINAL AUTHORS</title>
520 &apt-author.jgunthorpe;
521 </refsect1>
522 <refsect2>
523 <title>CURRENT AUTHORS</title>
524 &apt-author.team;
525 &apt-qapage;
526 </refsect2>
527 &manbugs;
528 </refentry>