doc/apt-key.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  <refentryinfo>
  11    &apt-author.jgunthorpe;
  12    &apt-author.team;
  13    &apt-email;
  14    &apt-product;
  15    <!-- The last update date -->
  16    <date>2012-06-09T00:00:00Z</date>
  17  </refentryinfo>
  18
  19  <refmeta>
  20    <refentrytitle>apt-key</refentrytitle>
  21    <manvolnum>8</manvolnum>
  22    <refmiscinfo class="manual">APT</refmiscinfo>
  23  </refmeta>
  24
  25  <!-- Man page title -->
  26  <refnamediv>
  27     <refname>apt-key</refname>
  28     <refpurpose>APT key management utility</refpurpose>
  29  </refnamediv>
  30
  31  &synopsis-command-apt-key;
  32
  33  <refsect1><title>Description</title>
  34    <para>
  35    <command>apt-key</command> is used to manage the list of keys used
  36    by apt to authenticate packages.  Packages which have been
  37    authenticated using these keys will be considered trusted.
  38    </para>
  39 </refsect1>
  40
  41 <refsect1><title>Commands</title>
  42    <variablelist>
  43      <varlistentry><term><option>add</option> <option>&synopsis-param-filename;</option></term>
  44      <listitem>
  45      <para>
  46        Add a new key to the list of trusted keys.
  47        The key is read from the filename given with the parameter
  48        &synopsis-param-filename; or if the filename is <literal>-</literal>
  49        from standard input.
  50      </para>
  51
  52      </listitem>
  53      </varlistentry>
  54
  55      <varlistentry><term><option>del</option> <option>&synopsis-param-keyid;</option></term>
  56      <listitem>
  57      <para>
  58
  59        Remove a key from the list of trusted keys.
  60
  61      </para>
  62
  63      </listitem>
  64      </varlistentry>
  65
  66      <varlistentry><term><option>export</option> <option>&synopsis-param-keyid;</option></term>
  67      <listitem>
  68      <para>
  69
  70         Output the key &synopsis-param-keyid; to standard output.
  71
  72      </para>
  73
  74      </listitem>
  75      </varlistentry>
  76
  77      <varlistentry><term><option>exportall</option></term>
  78      <listitem>
  79      <para>
  80
  81         Output all trusted keys to standard output.
  82
  83      </para>
  84
  85      </listitem>
  86      </varlistentry>
  87
  88      <varlistentry><term><option>list</option></term>
  89      <listitem>
  90      <para>
  91
  92        List trusted keys.
  93
  94      </para>
  95
  96      </listitem>
  97      </varlistentry>
  98
  99      <varlistentry><term><option>finger</option></term>
 100      <listitem>
 101      <para>
 102
 103      List fingerprints of trusted keys.
 104
 105      </para>
 106
 107      </listitem>
 108      </varlistentry>
 109
 110      <varlistentry><term><option>adv</option></term>
 111      <listitem>
 112      <para>
 113
 114      Pass advanced options to gpg. With adv --recv-key you can download the
 115          public key.
 116
 117      </para>
 118
 119      </listitem>
 120      </varlistentry>
 121
 122      <varlistentry><term><option>update</option></term>
 123      <listitem>
 124      <para>
 125
 126        Update the local keyring with the archive keyring and remove from
 127        the local keyring the archive keys which are no longer valid.
 128        The archive keyring is shipped in the <literal>archive-keyring</literal> package of your
 129        distribution, e.g. the &keyring-package; package in &keyring-distro;.
 130
 131      </para>
 132
 133      </listitem>
 134      </varlistentry>
 135
 136      <varlistentry><term><option>net-update</option></term>
 137      <listitem>
 138      <para>
 139
 140        Perform an update working similarly to the <command>update</command> command above,
 141        but get the archive keyring from a URI instead and validate it against a master key.
 142
 143        This requires an installed &wget; and an APT build configured to have
 144        a server to fetch from and a master keyring to validate.
 145
 146        APT in Debian does not support this command, relying on
 147        <command>update</command> instead, but Ubuntu's APT does.
 148
 149      </para>
 150
 151      </listitem>
 152      </varlistentry>
 153    </variablelist>
 154 </refsect1>
 155
 156  <refsect1><title>Options</title>
 157 <para>Note that options need to be defined before the commands described in the previous section.</para>
 158    <variablelist>
 159       <varlistentry><term><option>--keyring</option> <option>&synopsis-param-filename;</option></term>
 160       <listitem><para>With this option it is possible to specify a particular keyring
 161       file the command should operate on. The default is that a command is executed
 162       on the <filename>trusted.gpg</filename> file as well as on all parts in the
 163       <filename>trusted.gpg.d</filename> directory, though <filename>trusted.gpg</filename>
 164       is the primary keyring which means that e.g. new keys are added to this one.
 165       </para></listitem>
 166       </varlistentry>
 167    </variablelist>
 168  </refsect1>
 169
 170  <refsect1><title>Files</title>
 171    <variablelist>
 172
 173      &file-trustedgpg;
 174
 175      <varlistentry><term><filename>/etc/apt/trustdb.gpg</filename></term>
 176      <listitem><para>Local trust database of archive keys.</para></listitem>
 177      </varlistentry>
 178
 179      <varlistentry><term>&keyring-filename;</term>
 180      <listitem><para>Keyring of &keyring-distro; archive trusted keys.</para></listitem>
 181      </varlistentry>
 182
 183      <varlistentry><term>&keyring-removed-filename;</term>
 184      <listitem><para>Keyring of &keyring-distro; archive removed trusted keys.</para></listitem>
 185      </varlistentry>
 186
 187    </variablelist>
 188
 189 </refsect1>
 190
 191 <refsect1><title>See Also</title>
 192 <para>
 193 &apt-get;, &apt-secure;
 194 </para>
 195 </refsect1>
 196
 197  &manbugs;
 198  &manauthor;
 199
 200 </refentry>
 201