X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/d2793259e3dcf76e5c547a5eb72845211bc14905..a1b5561a036ebbe416cccfb2bd476a838ddb6286:/doc/apt-key.8.xml?ds=sidebyside diff --git a/doc/apt-key.8.xml b/doc/apt-key.8.xml index eac61307d..6a36d08ca 100644 --- a/doc/apt-key.8.xml +++ b/doc/apt-key.8.xml @@ -1,18 +1,29 @@ <?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" [ +<!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; + ]> <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> + <refmiscinfo class="manual">APT</refmiscinfo> </refmeta> <!-- Man page title --> @@ -21,14 +32,7 @@ <refpurpose>APT key management utility</refpurpose> </refnamediv> - <!-- Arguments --> - <refsynopsisdiv> - <cmdsynopsis> - <command>apt-key</command> - <arg><replaceable>command</replaceable>/</arg> - <arg rep="repeat"><option><replaceable>arguments</replaceable></option></arg> - </cmdsynopsis> - </refsynopsisdiv> + &synopsis-command-apt-key; <refsect1><title>Description</title> <para> @@ -40,19 +44,19 @@ <refsect1><title>Commands</title> <variablelist> - <varlistentry><term>add <replaceable>filename</replaceable></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 <replaceable>filename</replaceable>, or standard input if - <replaceable>filename</replaceable> 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> </listitem> </varlistentry> - <varlistentry><term>del <replaceable>keyid</replaceable></term> + <varlistentry><term><option>del</option> <option>&synopsis-param-keyid;</option></term> <listitem> <para> @@ -63,7 +67,29 @@ </listitem> </varlistentry> - <varlistentry><term>list</term> + <varlistentry><term><option>export</option> <option>&synopsis-param-keyid;</option></term> + <listitem> + <para> + + Output the key &synopsis-param-keyid; to standard output. + + </para> + + </listitem> + </varlistentry> + + <varlistentry><term><option>exportall</option></term> + <listitem> + <para> + + Output all trusted keys to standard output. + + </para> + + </listitem> + </varlistentry> + + <varlistentry><term><option>list</option></term> <listitem> <para> @@ -73,14 +99,56 @@ </listitem> </varlistentry> + + <varlistentry><term><option>finger</option></term> + <listitem> + <para> + + List fingerprints of trusted keys. - <varlistentry><term>update</term> + </para> + + </listitem> + </varlistentry> + + <varlistentry><term><option>adv</option></term> + <listitem> + <para> + + Pass advanced options to gpg. With adv --recv-key you can download the + public key. + + </para> + + </listitem> + </varlistentry> + + <varlistentry><term><option>update</option></term> <listitem> <para> - Update the local keyring with the keyring of Debian archive - keys and removes from the keyring the archive keys which are no - longer valid. + 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><option>net-update</option></term> + <listitem> + <para> + + 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, relying on + <command>update</command> instead, but Ubuntu's APT does. </para> @@ -89,11 +157,24 @@ </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><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> + 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> - <varlistentry><term><filename>/etc/apt/trusted.gpg</filename></term> - <listitem><para>Keyring of local trusted keys, new keys will be added here.</para></listitem> - </varlistentry> + + &file-trustedgpg; <varlistentry><term><filename>/etc/apt/trustdb.gpg</filename></term> <listitem><para>Local trust database of archive keys.</para></listitem> @@ -107,8 +188,6 @@ <listitem><para>Keyring of Debian archive removed trusted keys.</para></listitem> </varlistentry> - - </variablelist> </refsect1>