document list/search
[ntk/apt.git] / doc / apt.8.xml
1 <?xml version="1.0" encoding="utf-8" standalone="no"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
5 <!ENTITY % aptent SYSTEM "apt.ent">
6 %aptent;
7
8 <!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
9 %aptverbatiment;
10
11 ]>
12
13 <refentry>
14
15 <refentryinfo>
16 &apt-author.team;
17 &apt-email;
18 &apt-product;
19 <!-- The last update date -->
20 <date>2013-11-25T00:00:00Z</date>
21 </refentryinfo>
22
23 <refmeta>
24 <refentrytitle>apt</refentrytitle>
25 <manvolnum>8</manvolnum>
26 <refmiscinfo class="manual">APT</refmiscinfo>
27 </refmeta>
28
29 <!-- Man page title -->
30 <refnamediv>
31 <refname>apt</refname>
32 <refpurpose>APT package -- command-line interface</refpurpose>
33 </refnamediv>
34
35 &synopsis-command-apt;
36
37 <refsect1><title>Description</title>
38 <para><command>apt</command> is the command-line tool for handling packages. It provides a commandline interface for the package management of the system.
39
40 See also &apt-get; and &apt-cache; for more low-level command options.
41 </para>
42
43 <variablelist>
44 <varlistentry><term><option>list</option></term>
45 <listitem><para><literal>list</literal> is used to
46 display a list of packages. It supports shell pattern for matching
47 package names and the following options:
48 <option>--installed</option>
49 <option>--upgradable</option>
50 <option>--all-versions</option>
51 are supported.
52 </para></listitem>
53 </varlistentry>
54
55 <varlistentry><term><option>search</option></term>
56 <listitem><para><literal>search</literal> searches for the given
57 term(s) and display matching packages.
58 </para></listitem>
59 </varlistentry>
60
61 <varlistentry><term><option>update</option></term>
62 <listitem><para><literal>update</literal> is used to
63 resynchronize the package index files from their sources.
64 </para></listitem>
65 </varlistentry>
66
67 <varlistentry><term><option>upgrade</option></term>
68 <listitem><para><literal>upgrade</literal> is used to install the
69 newest versions of all packages currently installed on the system
70 from the sources enumerated in
71 <filename>/etc/apt/sources.list</filename>. New package will be
72 installed, but existing package will never removed.
73 </para></listitem>
74 </varlistentry>
75
76 <varlistentry><term><option>install</option></term>
77 <listitem>
78 <para><literal>install</literal> is followed by one or more
79 package names desired for installation or upgrading.
80 </para>
81
82 <para>A specific version of a package can be selected for installation by
83 following the package name with an equals and the version of the package
84 to select. This will cause that version to be located and selected for
85 install. Alternatively a specific distribution can be selected by
86 following the package name with a slash and the version of the
87 distribution or the Archive name (stable, testing, unstable).</para>
88 </listitem>
89 </varlistentry>
90
91 <varlistentry><term><option>remove</option></term>
92 <listitem><para><literal>remove</literal> is identical to <literal>install</literal> except that packages are
93 removed instead of installed. Note that removing a package leaves its
94 configuration files on the system. If a plus sign is appended to the package
95 name (with no intervening space), the identified package will be
96 installed instead of removed.</para></listitem>
97 </varlistentry>
98
99 </variablelist>
100 </refsect1>
101
102 <refsect1><title>options</title>
103 &apt-cmdblurb;
104
105 <variablelist>
106
107 &apt-commonoptions;
108
109 </variablelist>
110 </refsect1>
111
112 <refsect1><title>Differences to &apt-get;</title>
113 <para>The <command>apt</command> command is meant to be pleasant for
114 end users and does not need to be backward compatilbe like
115 &apt-get;. Therefore some options are different:
116
117 <itemizedlist>
118 <listitem>The option <literal>DPkgPM::Progress-Fancy</literal> is enabled.
119 </listitem>
120 <listitem>The option <literal>APT::Color</literal> is enabled.
121 </listitem>
122 <listitem>A new <literal>list</literal> command is available
123 similar to <literal>dpkg --list</literal>.
124 </listitem>
125 <listitem>The option <literal>upgrade</literal> has
126 <literal>--with-new-pkgs</literal> enabled by default.
127 </listitem>
128
129 </itemizedlist>
130
131 </para>
132 </refsect1>
133
134 <refsect1><title>See Also</title>
135 <para>&apt-get; &apt-cache;, &sources-list;,
136 &apt-conf;, &apt-config;,
137 The APT User's guide in &guidesdir;, &apt-preferences;, the APT Howto.</para>
138 </refsect1>
139
140 <refsect1><title>Diagnostics</title>
141 <para><command>apt</command> returns zero on normal operation, decimal 100 on error.</para>
142 </refsect1>
143 &manbugs;
144 </refentry>