~ubuntu-branches/ubuntu/trusty/apt/trusty

« back to all changes in this revision

Viewing changes to doc/apt.8.xml

  • Committer: Package Import Robot
  • Author(s): Michael Vogt
  • Date: 2014-04-01 17:48:58 UTC
  • mfrom: (1.4.87 sid)
  • Revision ID: package-import@ubuntu.com-20140401174858-4mv29mm29zu22fn1
Tags: 1.0.1ubuntu1
merge with the debian/sid 1.0.1 version
(LP: #1302033)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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>command-line interface</refpurpose>
 
33
 </refnamediv>
 
34
 
 
35
 &synopsis-command-apt;
 
36
 
 
37
 <refsect1><title>Description</title>
 
38
   <para><command>apt</command> (Advanced Package Tool) is the
 
39
   command-line tool for handling packages. It provides a commandline
 
40
   interface for the package management of the system.
 
41
 
 
42
   See also &apt-get; and &apt-cache; for more low-level command options.
 
43
   </para>
 
44
 
 
45
   <variablelist>
 
46
     <varlistentry><term><option>list</option></term>
 
47
     <listitem><para><literal>list</literal> is used to
 
48
     display a list of packages. It supports shell pattern for matching 
 
49
     package names and the following options:
 
50
       <option>--installed</option>, 
 
51
       <option>--upgradable</option>, 
 
52
       <option>--all-versions</option>
 
53
     are supported.
 
54
     </para></listitem>
 
55
     </varlistentry>
 
56
     
 
57
     <varlistentry><term><option>search</option></term>
 
58
     <listitem><para><literal>search</literal> searches for the given
 
59
     term(s) and display matching packages.
 
60
     </para></listitem>
 
61
     </varlistentry>
 
62
 
 
63
     <varlistentry><term><option>show</option></term>
 
64
     <listitem><para><literal>show</literal> shows the package information
 
65
     for the given package(s).
 
66
     </para></listitem>
 
67
     </varlistentry>
 
68
 
 
69
     <varlistentry><term><option>install</option></term>
 
70
     <listitem>
 
71
         <para><literal>install</literal> is followed by one or more 
 
72
         package names desired for installation or upgrading. 
 
73
         </para>
 
74
 
 
75
     <para>A specific version of a package can be selected for installation by 
 
76
     following the package name with an equals and the version of the package 
 
77
     to select. This will cause that version to be located and selected for
 
78
     install. Alternatively a specific distribution can be selected by 
 
79
     following the package name with a slash and the version of the 
 
80
     distribution or the Archive name (stable, testing, unstable).</para>
 
81
     </listitem>
 
82
     </varlistentry>
 
83
 
 
84
     <varlistentry><term><option>remove</option></term>
 
85
     <listitem><para><literal>remove</literal> is identical to <literal>install</literal> except that packages are 
 
86
         removed instead of installed. Note that removing a package leaves its
 
87
         configuration files on the system. If a plus sign is appended to the package 
 
88
     name (with no intervening space), the identified package will be 
 
89
     installed instead of removed.</para></listitem>
 
90
     </varlistentry>
 
91
 
 
92
     <varlistentry><term><option>edit-sources</option></term>
 
93
     <listitem><para><literal>edit-sources</literal> lets you edit
 
94
     your sources.list file and provides basic sanity checks.
 
95
     </para></listitem>
 
96
     </varlistentry>
 
97
 
 
98
     <varlistentry><term><option>update</option></term>
 
99
     <listitem><para><literal>update</literal> is used to
 
100
     resynchronize the package index files from their sources.
 
101
     </para></listitem>
 
102
     </varlistentry>
 
103
     
 
104
     <varlistentry><term><option>upgrade</option></term>
 
105
     <listitem><para><literal>upgrade</literal> is used to install the
 
106
     newest versions of all packages currently installed on the system
 
107
     from the sources enumerated in
 
108
     <filename>/etc/apt/sources.list</filename>. New package will be
 
109
     installed, but existing package will never removed.
 
110
     </para></listitem>
 
111
     </varlistentry>
 
112
 
 
113
     <varlistentry><term><option>full-upgrade</option></term>
 
114
     <listitem><para><literal>full-upgrade</literal> performs the
 
115
     function of upgrade but may also remove installed packages
 
116
     if that is required in order to resolve a package conflict.
 
117
     </para></listitem>
 
118
     </varlistentry>
 
119
 
 
120
 
 
121
   </variablelist>
 
122
 </refsect1>
 
123
 
 
124
 <refsect1><title>options</title>
 
125
   &apt-cmdblurb;
 
126
 
 
127
   <variablelist>
 
128
 
 
129
     &apt-commonoptions;
 
130
     
 
131
   </variablelist>
 
132
 </refsect1>
 
133
 
 
134
 <refsect1><title>Script usage</title>
 
135
  <para>
 
136
   The &apt; commandline is designed as a end-user tool and it may
 
137
   change the output between versions. While it tries to not break
 
138
   backward compatibility there is no guarantee for it either.
 
139
   All features of &apt; are available in  &apt-cache; and &apt-get;
 
140
   via APT options. Please prefer using these commands in your scripts.
 
141
  </para>
 
142
 </refsect1>
 
143
 
 
144
 <refsect1><title>Differences to &apt-get;</title>
 
145
 <para>The <command>apt</command> command is meant to be pleasant for
 
146
 end users and does not need to be backward compatible like
 
147
 &apt-get;. Therefore some options are different:
 
148
 
 
149
 <itemizedlist>
 
150
   <listitem>
 
151
     <para>The option <literal>DPkgPM::Progress-Fancy</literal> is enabled.
 
152
     </para>
 
153
   </listitem>
 
154
   <listitem>
 
155
     <para>The option <literal>APT::Color</literal> is enabled.
 
156
     </para>
 
157
   </listitem>
 
158
   <listitem>
 
159
     <para>A new <literal>list</literal> command is available
 
160
     similar to <literal>dpkg --list</literal>.
 
161
     </para>
 
162
   </listitem>
 
163
   <listitem>
 
164
     <para>The option <literal>upgrade</literal> has
 
165
     <literal>--with-new-pkgs</literal> enabled by default.
 
166
     </para>
 
167
   </listitem>
 
168
 
 
169
 </itemizedlist>
 
170
 </para>
 
171
 
 
172
 </refsect1>
 
173
 
 
174
 <refsect1><title>See Also</title>
 
175
   <para>&apt-get;, &apt-cache;, &sources-list;,
 
176
   &apt-conf;, &apt-config;, 
 
177
   The APT User's guide in &guidesdir;, &apt-preferences;, the APT Howto.</para>
 
178
 </refsect1>
 
179
 
 
180
 <refsect1><title>Diagnostics</title>
 
181
   <para><command>apt</command> returns zero on normal operation, decimal 100 on error.</para>
 
182
 </refsect1>
 
183
 &manbugs;
 
184
</refentry>