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