start adding apt.8.xml
[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.jgunthorpe;
17 &apt-author.team;
18 &apt-email;
19 &apt-product;
20 <!-- The last update date -->
21 <date>2013-11-25T00:00:00Z</date>
22 </refentryinfo>
23
24 <refmeta>
25 <refentrytitle>apt</refentrytitle>
26 <manvolnum>8</manvolnum>
27 <refmiscinfo class="manual">APT</refmiscinfo>
28 </refmeta>
29
30 <!-- Man page title -->
31 <refnamediv>
32 <refname>apt</refname>
33 <refpurpose>APT package -- command-line interface</refpurpose>
34 </refnamediv>
35
36 &synopsis-command-apt;
37
38 <refsect1><title>Description</title>
39 <para><command>apt</command> is the command-line tool for handling packages. It provides a commandline interface for the package management of the system.
40
41 See also &apt-get; and &apt-cache; for more low-level command options.
42 </para>
43
44 <variablelist>
45 <varlistentry><term><option>update</option></term>
46 <listitem><para><literal>update</literal> is used to
47 resynchronize the package index files from their sources.
48 </para></listitem>
49 </varlistentry>
50
51 <varlistentry><term><option>upgrade</option></term>
52 <listitem><para><literal>upgrade</literal> is used to install the
53 newest versions of all packages currently installed on the system
54 from the sources enumerated in
55 <filename>/etc/apt/sources.list</filename>. New package will be
56 installed, but existing package will never removed.
57 </para></listitem>
58 </varlistentry>
59
60 <varlistentry><term><option>install</option></term>
61 <listitem>
62 <para><literal>install</literal> is followed by one or more
63 package names desired for installation or upgrading.
64 </para>
65
66 <para>A specific version of a package can be selected for installation by
67 following the package name with an equals and the version of the package
68 to select. This will cause that version to be located and selected for
69 install. Alternatively a specific distribution can be selected by
70 following the package name with a slash and the version of the
71 distribution or the Archive name (stable, testing, unstable).</para>
72 </listitem>
73 </varlistentry>
74
75 <varlistentry><term><option>remove</option></term>
76 <listitem><para><literal>remove</literal> is identical to <literal>install</literal> except that packages are
77 removed instead of installed. Note that removing a package leaves its
78 configuration files on the system. If a plus sign is appended to the package
79 name (with no intervening space), the identified package will be
80 installed instead of removed.</para></listitem>
81 </varlistentry>
82
83 </variablelist>
84 </refsect1>
85
86 <refsect1><title>options</title>
87 &apt-cmdblurb;
88
89 <variablelist>
90
91 &apt-commonoptions;
92
93 </variablelist>
94 </refsect1>
95
96 <refsect1><title>Differences to &apt-get;</title>
97 <para>The <command>apt</command> command is meant to be pleasant for
98 end users and does not need to be backward compatilbe like
99 &apt-get;. Therefore some options are different:
100
101 <itemizedlist>
102 <listitem>The option <literal>DPkgPM::Progress-Fancy</literal> is enabled.
103 </listitem>
104 <listitem>The option <literal>APT::Color</literal> is enabled.
105 </listitem>
106 <listitem>A new <literal>list</literal> command is available
107 similar to <literal>dpkg --list</literal>.
108 </listitem>
109 <listitem>The option <literal>upgrade</literal> has
110 <literal>--with-new-pkgs</literal> enabled by default.
111 </listitem>
112
113 </itemizedlist>
114
115 </para>
116 </refsect1>
117
118 <refsect1><title>See Also</title>
119 <para>&apt-get; &apt-cache;, &sources-list;,
120 &apt-conf;, &apt-config;,
121 The APT User's guide in &guidesdir;, &apt-preferences;, the APT Howto.</para>
122 </refsect1>
123
124 <refsect1><title>Diagnostics</title>
125 <para><command>apt</command> returns zero on normal operation, decimal 100 on error.</para>
126 </refsect1>
127 &manbugs;
128 </refentry>