<?xml version="1.0" encoding="utf-8"?>
<refentry xml:id="function.rnp-key-export-revocation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>rnp_key_export_revocation</refname>
  <refpurpose>Generate and export primary key revocation signature</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>rnp_key_export_revocation</methodname>
   <methodparam><type>RnpFFI</type><parameter>ffi</parameter></methodparam>
   <methodparam><type>string</type><parameter>key_fp</parameter></methodparam>
   <methodparam><type>int</type><parameter>flags</parameter></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
  </methodsynopsis>
  <para>
   Note: to revoke a key you'll need to import this signature into the keystore or use
   <function>rnp_key_revoke</function> function.
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>ffi</parameter></term>
    <listitem>
     <para>
      &rnp.parameter.ffi-description;
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>key_fp</parameter></term>
    <listitem>
     <para>
      Key fingerprint of the primary key to be revoked.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>flags</parameter></term>
    <listitem>
     <para>
      <constant>RNP_KEY_EXPORT_ARMORED</constant> or 0.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>options</parameter></term>
    <listitem>
     <para>
      An associative array with options.
     </para>
     <informaltable>
      <tgroup cols="2">
       <thead>
        <row>
         <entry>Key</entry>
         <entry>Data type</entry>
         <entry>&Description;</entry>
        </row>
       </thead>
       <tbody>
        <row>
         <entry><literal>"hash"</literal></entry>
         <entry>string</entry>
         <entry>Set hash algorithm used during signature calculation.</entry>
        </row>
        <row>
         <entry><literal>"code"</literal></entry>
         <entry>string</entry>
         <entry>Code reason for revocation code. Possible values: 'no', 'superseded', 'compromised',
          'retired'. If not defined, then value 'no' will be used by default.</entry>
        </row>
        <row>
         <entry><literal>"reason"</literal></entry>
         <entry>string</entry>
         <entry>Textual representation of the reason for revocation.</entry>
        </row>
       </tbody>
      </tgroup>
     </informaltable>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Exported revocation signature on success&return.falseforfailure;.
  </para>
 </refsect1>


</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
