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>edit-sources</option></term>
  90      <listitem><para><literal>edit-sources</literal> lets you edit
  91      your sources.list file and provides basic sanity checks.
  92      </para></listitem>
  93      </varlistentry>
  94
  95      <varlistentry><term><option>update</option></term>
  96      <listitem><para><literal>update</literal> is used to
  97      resynchronize the package index files from their sources.
  98      </para></listitem>
  99      </varlistentry>
 100
 101      <varlistentry><term><option>upgrade</option></term>
 102      <listitem><para><literal>upgrade</literal> is used to install the
 103      newest versions of all packages currently installed on the system
 104      from the sources enumerated in
 105      <filename>/etc/apt/sources.list</filename>. New packages will be
 106      installed, but existing packages will never be removed.
 107      </para></listitem>
 108      </varlistentry>
 109
 110      <varlistentry><term><option>full-upgrade</option></term>
 111      <listitem><para><literal>full-upgrade</literal> performs the
 112      function of upgrade but may also remove installed packages
 113      if that is required in order to resolve a package conflict.
 114      </para></listitem>
 115      </varlistentry>
 116
 117
 118    </variablelist>
 119  </refsect1>
 120
 121  <refsect1><title>options</title>
 122    &apt-cmdblurb;
 123
 124    <variablelist>
 125
 126      &apt-commonoptions;
 127
 128    </variablelist>
 129  </refsect1>
 130
 131  <refsect1><title>Script usage</title>
 132   <para>
 133    The &apt; commandline is designed as a end-user tool and it may
 134    change the output between versions. While it tries to not break
 135    backward compatibility there is no guarantee for it either.
 136    All features of &apt; are available in  &apt-cache; and &apt-get;
 137    via APT options. Please prefer using these commands in your scripts.
 138   </para>
 139  </refsect1>
 140
 141  <refsect1><title>Differences to &apt-get;</title>
 142  <para>The <command>apt</command> command is meant to be pleasant for
 143  end users and does not need to be backward compatible like
 144  &apt-get;. Therefore some options are different:
 145
 146  <itemizedlist>
 147    <listitem>
 148      <para>The option <literal>DPkg::Progress-Fancy</literal> is enabled.
 149      </para>
 150    </listitem>
 151    <listitem>
 152      <para>The option <literal>APT::Color</literal> is enabled.
 153      </para>
 154    </listitem>
 155    <listitem>
 156      <para>A new <literal>list</literal> command is available
 157      similar to <literal>dpkg --list</literal>.
 158      </para>
 159    </listitem>
 160    <listitem>
 161      <para>The option <literal>upgrade</literal> has
 162      <literal>--with-new-pkgs</literal> enabled by default.
 163      </para>
 164    </listitem>
 165
 166  </itemizedlist>
 167  </para>
 168
 169  </refsect1>
 170
 171  <refsect1><title>See Also</title>
 172    <para>&apt-get;, &apt-cache;, &sources-list;,
 173    &apt-conf;, &apt-config;,
 174    The APT User's guide in &guidesdir;, &apt-preferences;, the APT Howto.</para>
 175  </refsect1>
 176
 177  <refsect1><title>Diagnostics</title>
 178    <para><command>apt</command> returns zero on normal operation, decimal 100 on error.</para>
 179  </refsect1>
 180  &manbugs;
 181 </refentry>