X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/8c6d0ba4e25baa7b0dffc4e06e76fc63a71e656f..011188e3920f21e6883c2dab956b3d4fb4e8cbfa:/doc/apt-key.8.xml diff --git a/doc/apt-key.8.xml b/doc/apt-key.8.xml index 3748b5e17..41628aff6 100644 --- a/doc/apt-key.8.xml +++ b/doc/apt-key.8.xml @@ -1,18 +1,21 @@ <?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; - +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % aptent SYSTEM "apt.ent"> %aptent; +<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment; +<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor; ]> <refentry> - &apt-docinfo; - + <refentryinfo> + &apt-author.jgunthorpe; + &apt-author.team; + &apt-email; + &apt-product; + <!-- The last update date --> + <date>2012-06-09T00:00:00Z</date> + </refentryinfo> + <refmeta> <refentrytitle>apt-key</refentrytitle> <manvolnum>8</manvolnum> @@ -37,19 +40,23 @@ <refsect1><title>Commands</title> <variablelist> - <varlistentry><term>add &synopsis-param-filename;</term> + <varlistentry><term><option>add</option> <option>&synopsis-param-filename;</option></term> <listitem> <para> - - Add a new key to the list of trusted keys. The key is read - from &synopsis-param-filename;, or standard input if - &synopsis-param-filename; is <literal>-</literal>. + Add a new key to the list of trusted keys. + The key is read from the filename given with the parameter + &synopsis-param-filename; or if the filename is <literal>-</literal> + from standard input. + </para> + <para> + It is critical that keys added manually via <command>apt-key</command> are + verified to belong to the owner of the repositories they claim to be for + otherwise the &apt-secure; infrastructure is completely undermined. </para> - </listitem> </varlistentry> - <varlistentry><term>del &synopsis-param-keyid;</term> + <varlistentry><term><option>del</option> <option>&synopsis-param-keyid;</option></term> <listitem> <para> @@ -60,7 +67,7 @@ </listitem> </varlistentry> - <varlistentry><term>export &synopsis-param-keyid;</term> + <varlistentry><term><option>export</option> <option>&synopsis-param-keyid;</option></term> <listitem> <para> @@ -71,7 +78,7 @@ </listitem> </varlistentry> - <varlistentry><term>exportall</term> + <varlistentry><term><option>exportall</option></term> <listitem> <para> @@ -82,7 +89,7 @@ </listitem> </varlistentry> - <varlistentry><term>list</term> + <varlistentry><term><option>list</option></term> <listitem> <para> @@ -93,7 +100,7 @@ </listitem> </varlistentry> - <varlistentry><term>finger</term> + <varlistentry><term><option>finger</option></term> <listitem> <para> @@ -104,43 +111,44 @@ </listitem> </varlistentry> - <varlistentry><term>adv</term> + <varlistentry><term><option>adv</option></term> <listitem> <para> - - Pass advanced options to gpg. With adv --recv-key you can download the - public key. - + Pass advanced options to gpg. With <command>adv --recv-key</command> you + can e.g. download key from keyservers directly into the the trusted set of + keys. Note that there are <emphasis>no</emphasis> checks performed, so it is + easy to completely undermine the &apt-secure; infrastructure if used without + care. </para> </listitem> </varlistentry> - <varlistentry><term>update</term> + <varlistentry><term><option>update</option></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. + distribution, e.g. the &keyring-package; package in &keyring-distro;. </para> </listitem> </varlistentry> - <varlistentry><term>net-update</term> + <varlistentry><term><option>net-update</option></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. + Perform an update working similarly to the <command>update</command> command above, + but get the archive keyring from a 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 + APT in Debian does not support this command, relying on <command>update</command> instead, but Ubuntu's APT does. </para> @@ -153,8 +161,8 @@ <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 &synopsis-param-filename;</term> - <listitem><para>With this option it is possible to specify a specific keyring + <varlistentry><term><option>--keyring</option> <option>&synopsis-param-filename;</option></term> + <listitem><para>With this option it is possible to specify a particular 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> @@ -173,12 +181,12 @@ <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><term>&keyring-filename;</term> + <listitem><para>Keyring of &keyring-distro; 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><term>&keyring-removed-filename;</term> + <listitem><para>Keyring of &keyring-distro; archive removed trusted keys.</para></listitem> </varlistentry> </variablelist>