apt-verbatim.ent is an INCLUDE file as well

[ntk/apt.git] / doc / apt-key.8.xml

<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

<!ENTITY % aptent SYSTEM "apt.ent">
%aptent;

<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
%aptverbatiment;

]>

<refentry>
 &apt-docinfo;
 
 <refmeta>
   <refentrytitle>apt-key</refentrytitle>
   <manvolnum>8</manvolnum>
   <refmiscinfo class="manual">APT</refmiscinfo>
 </refmeta>
 
 <!-- Man page title -->
 <refnamediv>
    <refname>apt-key</refname>
    <refpurpose>APT key management utility</refpurpose>
 </refnamediv>

 <!-- Arguments -->
 <refsynopsisdiv>
   <cmdsynopsis>
      <command>apt-key</command>
      <arg><option>--keyring <replaceable>filename</replaceable></option></arg>
      <arg><replaceable>command</replaceable></arg>
      <arg rep="repeat"><option><replaceable>arguments</replaceable></option></arg>
   </cmdsynopsis>
 </refsynopsisdiv>

 <refsect1><title>Description</title>
   <para>
   <command>apt-key</command> is used to manage the list of keys used
   by apt to authenticate packages.  Packages which have been
   authenticated using these keys will be considered trusted.
   </para>
</refsect1>

<refsect1><title>Commands</title>
   <variablelist>
     <varlistentry><term>add <replaceable>filename</replaceable></term>
     <listitem>
     <para>

       Add a new key to the list of trusted keys.  The key is read
       from <replaceable>filename</replaceable>, or standard input if
       <replaceable>filename</replaceable> is <literal>-</literal>.
     </para>

     </listitem>
     </varlistentry>

     <varlistentry><term>del <replaceable>keyid</replaceable></term>
     <listitem>
     <para>

       Remove a key from the list of trusted keys.

     </para>

     </listitem>
     </varlistentry>

     <varlistentry><term>export <replaceable>keyid</replaceable></term>
     <listitem>
     <para>

        Output the key <replaceable>keyid</replaceable> to standard output.

     </para>

     </listitem>
     </varlistentry>

     <varlistentry><term>exportall</term>
     <listitem>
     <para>

        Output all trusted keys to standard output.

     </para>

     </listitem>
     </varlistentry>

     <varlistentry><term>list</term>
     <listitem>
     <para>

       List trusted keys.

     </para>

     </listitem>
     </varlistentry>
     
	 <varlistentry><term>finger</term>
     <listitem>
     <para>

     List fingerprints of trusted keys.

     </para>

     </listitem>
     </varlistentry>
     
	 <varlistentry><term>adv</term>
     <listitem>
     <para>

     Pass advanced options to gpg. With adv --recv-key you can download the 
	 public key.  

     </para>

     </listitem>
     </varlistentry>

     <varlistentry><term>update</term>
     <listitem>
     <para>

       Update the local keyring with the archive keyring and remove from
       the local keyring the archive keys which are no longer valid.
       The archive keyring is shipped in the <literal>archive-keyring</literal> package of your
       distribution, e.g. the <literal>debian-archive-keyring</literal> package in Debian.

     </para>

     </listitem>
     </varlistentry>
     
     <varlistentry><term>net-update</term>
     <listitem>
     <para>

       Work similar to the <command>update</command> command above, but get the
       archive keyring from an URI instead and validate it against a master key.

       This requires an installed &wget; and an APT build configured to have
       a server to fetch from and a master keyring to validate.

       APT in Debian does not support this command and relies on
       <command>update</command> instead, but Ubuntu's APT does.

     </para>

     </listitem>
     </varlistentry>
   </variablelist>
</refsect1>

 <refsect1><title>Options</title>
<para>Note that options need to be defined before the commands described in the previous section.</para>
   <variablelist>
      <varlistentry><term>--keyring <replaceable>filename</replaceable></term>
      <listitem><para>With this option it is possible to specify a specific keyring
      file the command should operate on. The default is that a command is executed
      on the <filename>trusted.gpg</filename> file as well as on all parts in the
      <filename>trusted.gpg.d</filename> directory, though <filename>trusted.gpg</filename>
      is the primary keyring which means that e.g. new keys are added to this one.
      </para></listitem>
      </varlistentry>
   </variablelist>
 </refsect1>

 <refsect1><title>Files</title>
   <variablelist>

     &file-trustedgpg;

     <varlistentry><term><filename>/etc/apt/trustdb.gpg</filename></term>
     <listitem><para>Local trust database of archive keys.</para></listitem>
     </varlistentry>

     <varlistentry><term><filename>/usr/share/keyrings/debian-archive-keyring.gpg</filename></term>
     <listitem><para>Keyring of Debian archive trusted keys.</para></listitem>
     </varlistentry>

     <varlistentry><term><filename>/usr/share/keyrings/debian-archive-removed-keys.gpg</filename></term>
     <listitem><para>Keyring of Debian archive removed trusted keys.</para></listitem>
     </varlistentry>

   </variablelist>

</refsect1>

<refsect1><title>See Also</title>
<para>
&apt-get;, &apt-secure;
</para>
</refsect1>

 &manbugs;
 &manauthor;

</refentry>