removed all the .cvsignre files - they should be local
[gpgme.git] / doc / gpgme.texi
index ddd9432..573742f 100644 (file)
@@ -2,13 +2,6 @@
 @setfilename gpgme.info
 @settitle The `GnuPG Made Easy' Reference Manual
 
-@c TODO:
-@c char *gpgme_get_op_info (GpgmeCtx c, int reserved);
-@c void       gpgme_cancel (GpgmeCtx c);
-@c GpgmeCtx   gpgme_wait (GpgmeCtx c, int hang);
-@c char *gpgme_get_notation (GpgmeCtx c);
-@c void        gpgme_register_idle (void (*fnc)(void));
-
 @dircategory GNU Libraries
 @direntry
 * @acronym{GPGME}: (gpgme)           Adding support for cryptography to your program.
@@ -78,7 +71,7 @@ This is Edition @value{EDITION}, last updated @value{UPDATED}, of
 
 @menu
 * Introduction::                  How to use this manual.
-* Preperation::                   What you should do before using the library.
+* Preparation::                   What you should do before using the library.
 * Protocols and Engines::         Supported crypto protocols.
 * Error Handling::                Error numbers and their meanings.
 * Exchanging Data::               Passing data to and from @acronym{GPGME}.
@@ -106,82 +99,90 @@ Introduction
 * Features::                      Reasons to install and use @acronym{GPGME}.
 * Overview::                      Basic architecture of the @acronym{GPGME} library.
 
-Preperation
+Preparation
 
 * Header::                        What header file you need to include.
-* Building the source::           Compiler options to be used.
-* Library version check::         Getting and verifying the library version.
+* Building the Source::           Compiler options to be used.
+* Library Version Check::         Getting and verifying the library version.
 
 Protocols and Engines
 
-* Engine version check::          Verifying the engine version.
-* Engine information::            Obtaining more information about the engines.
+* Engine Version Check::          Verifying the engine version.
+* Engine Information::            Obtaining more information about the engines.
 * OpenPGP::                       Support for the OpenPGP protocol.
 * Cryptographic Message Syntax::  Support for the CMS.
 
 Error Handling
 
-* Error values::                  A list of all error values used.
-* Error strings::                 How to get a descriptive string from a value.
+* Error Values::                  A list of all error values used.
+* Error Strings::                 How to get a descriptive string from a value.
 
 Exchanging Data 
 
-* Creating data buffers::         Creating new data buffers.
-* Destroying data buffers::       Releasing data buffers.
-* Manipulating data buffers::     Operations on data buffers.
+* Creating Data Buffers::         Creating new data buffers.
+* Destroying Data Buffers::       Releasing data buffers.
+* Manipulating Data Buffers::     Operations on data buffers.
 
 Contexts
 
-* Creating contexts::             Creating new @acronym{GPGME} contexts.
-* Destroying contexts::           Releasing @acronym{GPGME} contexts.
-* Context attributes::            Setting properties of a context.
+* Creating Contexts::             Creating new @acronym{GPGME} contexts.
+* Destroying Contexts::           Releasing @acronym{GPGME} contexts.
+* Context Attributes::            Setting properties of a context.
 * Key Management::                Managing keys with @acronym{GPGME}.
 * Trust Item Management::         Managing trust items with @acronym{GPGME}.
 * Crypto Operations::             Using a context for cryptography.
+* Run Control::                   Controlling how operations are run.
 
-Context attributes
+Context Attributes
 
-* Protocol selection::            Selecting the protocol used by a context.
-* @acronym{ASCII} armor::                   Requesting @acronym{ASCII} armored output.
-* Text mode::                     Choosing canonical text mode.
-* Key listing mode::              Selecting key listing mode.
-* Passphrase callback::           Getting the passphrase from the user.
-* Progress meter callback::       Being informed about the progress.
+* Protocol Selection::            Selecting the protocol used by a context.
+* @acronym{ASCII} Armor::                   Requesting @acronym{ASCII} armored output.
+* Text Mode::                     Choosing canonical text mode.
+* Included Certificates::         Including a number of certificates.
+* Key Listing Mode::              Selecting key listing mode.
+* Passphrase Callback::           Getting the passphrase from the user.
+* Progress Meter Callback::       Being informed about the progress.
 
 Key Management
 
-* Listing keys::                  Browsing the list of available keys.
-* Information about keys::        Requesting detailed information about keys.
-* Manipulating keys::             Operations on keys.
-* Generating keys::               Creating new key pairs.
-* Exporting keys::                Retrieving key data from the key ring.
-* Importing keys::                Adding keys to the keyring.
-* Deleting keys::                 Removing keys from the keyring.
+* Listing Keys::                  Browsing the list of available keys.
+* Information About Keys::        Requesting detailed information about keys.
+* Manipulating Keys::             Operations on keys.
+* Generating Keys::               Creating new key pairs.
+* Exporting Keys::                Retrieving key data from the key ring.
+* Importing Keys::                Adding keys to the key ring.
+* Deleting Keys::                 Removing keys from the key ring.
 
 Trust Item Management
 
-* Listing trust items::           Browsing the list of available trust items.
-* Information about trust items:: Requesting detailed information about trust items.
-* Manipulating trust items::      Operations on trust items.
+* Listing Trust Items::           Browsing the list of available trust items.
+* Information About Trust Items:: Requesting detailed information about trust items.
+* Manipulating Trust Items::      Operations on trust items.
 
 Crypto Operations
 
 * Decrypt::                       Decrypting a ciphertext.
 * Verify::                        Verifying a signature.
-* Decrypt and verify::            Decrypting a signed ciphertext.
+* Decrypt and Verify::            Decrypting a signed ciphertext.
 * Sign::                          Creating a signature.
 * Encrypt::                       Encrypting a plaintext.
+* Detailed Results::              How to obtain more info about the operation.
 
 Sign
 
-* Selecting signers::             How to choose the keys to sign with.
-* Creating a signature::          How to create a signature.
+* Selecting Signers::             How to choose the keys to sign with.
+* Creating a Signature::          How to create a signature.
 
 Encrypt
 
-* Selecting recipients::          How to choose the recipients.
-* Encrypting a plaintext::        How to encrypt a plaintext.
+* Selecting Recipients::          How to choose the recipients.
+* Encrypting a Plaintext::        How to encrypt a plaintext.
+
+Run Control
 
+* Waiting For Completion::        Waiting until an operation is completed.
+* Cancelling an Operation::       Interrupting a running operation.
+* Hooking Up Into Idle Time::     Doing something when nothing has to be done.
 
 @end detailmenu
 @end menu
@@ -197,7 +198,7 @@ encryption, decryption, signing, signature verification and key
 management.
 
 @acronym{GPGME} uses GnuPG and GpgSM as its backends to support
-OpenPGP and the Cryptograhic Message Syntax (CMS).
+OpenPGP and the Cryptographic Message Syntax (CMS).
 
 @menu
 * Getting Started::               Purpose of the manual, and how to use it.
@@ -213,7 +214,7 @@ This library documents the @acronym{GPGME} library programming
 interface.  All functions and data types provided by the library are
 explained.
 
-The reader is assumed to posess basic knowledge about cryptography in
+The reader is assumed to possess basic knowledge about cryptography in
 general, and public key cryptography in particular.  The underlying
 cryptographic engines that are used by the library are not explained,
 but where necessary, special features or requirements by an engine are
@@ -277,13 +278,15 @@ including listing keys, querying their attributes, generating,
 importing, exporting and deleting keys, and acquiring information
 about the trust path.
 
+@cindex thread-safeness
+@cindex multi-threading
 @strong{Caution:} The @acronym{GPGME} library is not thread-safe.  It
 will be to some extent in the future, but currently great care has to
 be taken if @acronym{GPGME} is used in a multi-threaded environment.
 
 
-@node Preperation
-@chapter Preperation
+@node Preparation
+@chapter Preparation
 
 To use @acronym{GPGME}, you have to perform some changes to your
 sources and the build system.  The necessary changes are small and
@@ -293,13 +296,15 @@ of the library are verified.
 
 @menu
 * Header::                        What header file you need to include.
-* Building the source::           Compiler options to be used.
-* Library version check::         Getting and verifying the library version.
+* Building the Source::           Compiler options to be used.
+* Library Version Check::         Getting and verifying the library version.
 @end menu
 
 
 @node Header
 @section Header
+@cindex header file
+@cindex include file
 
 All interfaces (data types and functions) of the library are defined
 in the header file `gpgme.h'.  You must include this in all programs
@@ -315,8 +320,10 @@ names, @code{Gpgme*} for data types and @code{GPGME_*} for other
 symbols.
 
 
-@node Building the source
-@section Building the source
+@node Building the Source
+@section Building the Source
+@cindex compiler options
+@cindex compiler flags
 
 If you want to compile a source file including the `gpgme.h' header
 file, you must make sure that the compiler can find it in the
@@ -362,8 +369,9 @@ gcc -o foo foo.c `gpgme-config --cflags --libs`
 @end example
 
 
-@node Library version check
-@section Library version check
+@node Library Version Check
+@section Library Version Check
+@cindex version check, of the library
 
 @deftypefun {const char *} gpgme_check_version (@w{const char *@var{required_version}})
 The function @code{gpgme_check_version} has three purposes.  It can be
@@ -396,6 +404,11 @@ features are provided by the installed version of the library.
 
 @node Protocols and Engines
 @chapter Protocols and Engines
+@cindex protocol
+@cindex engine
+@cindex crypto engine
+@cindex backend
+@cindex crypto backend
 
 @acronym{GPGME} supports several cryptographic protocols, however, it
 does not implement them.  Rather it uses backends (also called
@@ -409,6 +422,7 @@ necessary, @acronym{GPGME} provides the necessary callback function
 hooks and further interfaces.
 
 @deftp {Data type} {enum GpgmeProtocol}
+@tindex GpgmeProtocol
 The @code{GpgmeProtocol} type specifies the set of possible protocol
 values that are supported by @acronym{GPGME}.  The following protocols
 are supported:
@@ -422,15 +436,16 @@ This specifies the Cryptographic Message Syntax.
 @end deftp
 
 @menu
-* Engine version check::          Verifying the engine version.
-* Engine information::            Obtaining more information about the engines.
+* Engine Version Check::          Verifying the engine version.
+* Engine Information::            Obtaining more information about the engines.
 * OpenPGP::                       Support for the OpenPGP protocol.
 * Cryptographic Message Syntax::  Support for the CMS.
 @end menu
 
 
-@node Engine version check
-@section Engine version check
+@node Engine Version Check
+@section Engine Version Check
+@cindex version check, of the engines
 
 @deftypefun GpgmeError gpgme_engine_check_version (@w{GpgmeProtocol @var{protocol}})
 The function @code{gpgme_engine_check_version} verifies that the
@@ -453,8 +468,9 @@ only.  It is obsoleted by @code{gpgme_engine_check_version}.
 @end deftypefun
 
 
-@node Engine information
-@section Engine information
+@node Engine Information
+@section Engine Information
+@cindex engine, information about
 
 @deftypefun {const char *} gpgme_get_engine_info (void)
 The function @code{gpgme_get_engine_info} returns an @acronym{XML}
@@ -496,6 +512,10 @@ return on your system:
 
 @node OpenPGP
 @section OpenPGP
+@cindex OpenPGP
+@cindex GnuPG
+@cindex protocol, GnuPG
+@cindex engine, GnuPG
 
 OpenPGP is implemented by GnuPG, the @acronym{GNU} Privacy Guard.
 This is the first protocol that was supported by @acronym{GPGME}.
@@ -505,6 +525,13 @@ The OpenPGP protocol is specified by @code{GPGME_PROTOCOL_OpenPGP}.
 
 @node Cryptographic Message Syntax
 @section Cryptographic Message Syntax
+@cindex CMS
+@cindex cryptographic message syntax
+@cindex GpgSM
+@cindex protocol, CMS
+@cindex engine, GpgSM
+@cindex S/MIME
+@cindex protocol, S/MIME
 
 @acronym{CMS} is implemented by GpgSM, the S/MIME implementation for
 GnuPG.
@@ -514,6 +541,7 @@ The @acronym{CMS} protocol is specified by @code{GPGME_PROTOCOL_CMS}.
 
 @node Error Handling
 @chapter Error Handling
+@cindex error handling
 
 Many functions in @acronym{GPGME} can return an error if they fail.
 For this reason, the application should always catch the error
@@ -531,15 +559,17 @@ specific meanings if returned by a specific function.  Such cases are
 described in the documentation of those functions.
 
 @menu
-* Error values::                  A list of all error values used.
-* Error strings::                 How to get a descriptive string from a value.
+* Error Values::                  A list of all error values used.
+* Error Strings::                 How to get a descriptive string from a value.
 @end menu
 
 
-@node Error values
-@section Error values
+@node Error Values
+@section Error Values
+@cindex error values, list of
 
 @deftp {Data type} {enum GpgmeError}
+@tindex GpgmeError
 The @code{GpgmeError} type specifies the set of all error values that
 are used by @acronym{GPGME}.  Possible values are:
 
@@ -553,10 +583,10 @@ This value indicates success.  The value of this error is @code{0}.
 @item GPGME_General_Error
 This value means that something went wrong, but either there is not
 enough information about the problem to return a more useful error
-value, or there is no seperate error value for this type of problem.
+value, or there is no separate error value for this type of problem.
 
 @item GPGME_Out_Of_Core
-This value means that an out-of-memory condition occured.
+This value means that an out-of-memory condition occurred.
 
 @item GPGME_Invalid_Value
 This value means that some user provided data was out of range.  This
@@ -567,7 +597,7 @@ value is returned.
 @item GPGME_Busy
 This value is returned if you try to start a new operation in a
 context that is already busy with some earlier operation which was not
-canceled or finished yet.
+cancelled or finished yet.
 
 @item GPGME_No_Request
 This value is in some sense the opposite of @code{GPGME_Busy}.  There
@@ -575,7 +605,7 @@ is no pending operation, but it is required for the function to
 succeed.
 
 @item GPGME_Exec_Error
-This value means that an error occured when trying to spawn a child
+This value means that an error occurred when trying to spawn a child
 process.
 
 @item GPGME_Too_Many_Procs
@@ -585,14 +615,18 @@ This value means that there are too many active backend processes.
 This value means that the creation of a pipe failed.
 
 @item GPGME_No_Recipients 
-This value means that no recipients for a message have been set.
+This value means that no valid recipients for a message have been set.
+
+@item GPGME_Invalid_Recipients 
+This value means that some, but not all, recipients for a message have
+been invalid.
 
 @item GPGME_No_Data
 This value means that a @code{GpgmeData} object which was expected to
 have content was found empty.
 
 @item GPGME_Conflict
-This value means that a conflict of some sort occured.
+This value means that a conflict of some sort occurred.
 
 @item GPGME_Not_Implemented
 This value indicates that the specific function (or operation) is not
@@ -642,19 +676,35 @@ engine is not installed properly.
 @end deftp
 
 
-@node Error strings
-@section Error strings
+@node Error Strings
+@section Error Strings
+@cindex error values, printing of
+@cindex error strings
 
 @deftypefun {const char *} gpgme_strerror (@w{GpgmeError @var{err}})
 The function @code{gpgme_strerror} returns a pointer to a statically
 allocated string containing a description of the error with the error
 value @var{err}.  This string can be used to output a diagnostic
 message to the user.
+
+The following example illustrates the use of @code{gpgme_strerror}:
+
+@example
+GpgmeCtx ctx;
+GpgmeError err = gpgme_new (&ctx);
+if (err)
+  @{
+    fprintf (stderr, "%s: creating GpgME context failed: %s\n",
+             argv[0], gpgme_strerror (err));
+    exit (1);
+  @}
+@end example
 @end deftypefun
 
 
 @node Exchanging Data
 @chapter Exchanging Data
+@cindex data, exchanging
 
 A lot of data has to be exchanged between the user and the crypto
 engine, like plaintext messages, ciphertext, signatures and
@@ -670,14 +720,15 @@ data, which is used by @acronym{GPGME} to exchange data with the user.
 @end deftp
 
 @menu
-* Creating data buffers::         Creating new data buffers.
-* Destroying data buffers::       Releasing data buffers.
-* Manipulating data buffers::     Operations on data buffers.
+* Creating Data Buffers::         Creating new data buffers.
+* Destroying Data Buffers::       Releasing data buffers.
+* Manipulating Data Buffers::     Operations on data buffers.
 @end menu
 
 
-@node Creating data buffers
-@section Creating data buffers
+@node Creating Data Buffers
+@section Creating Data Buffers
+@cindex data buffer, creation
 
 @deftypefun GpgmeError gpgme_data_new (@w{GpgmeData *@var{dh}})
 The function @code{gpgme_data_new} creates a new @code{GpgmeData}
@@ -741,7 +792,6 @@ exactly one of @var{filename} and @var{fp} is not a valid pointer,
 @code{GPGME_Out_Of_Core} if not enough memory is available.
 @end deftypefun
 
-
 @deftypefun GpgmeError gpgme_data_new_with_read_cb (@w{GpgmeData *@var{dh}}, @w{int (*@var{readfunc})} (@w{void *@var{hook}}, @w{char *@var{buffer}}, @w{size_t @var{count}}, @w{size_t *@var{nread}}), @w{void *@var{hook_value}})
 The function @code{gpgme_data_new_with_read_cb} creates a new
 @code{GpgmeData} object and uses the callback function @var{readfunc}
@@ -766,8 +816,9 @@ not enough memory is available.
 @end deftypefun
 
 
-@node Destroying data buffers
-@section Destroying data buffers
+@node Destroying Data Buffers
+@section Destroying Data Buffers
+@cindex data buffer, destruction
 
 @deftypefun void gpgme_data_release (@w{GpgmeData @var{dh}})
 The function @code{gpgme_data_release} destroys the data object with
@@ -789,8 +840,9 @@ be returned to the user, the function will return @code{NULL}.
 @end deftypefun
 
 
-@node Manipulating data buffers
-@section Manipulating data buffers
+@node Manipulating Data Buffers
+@section Manipulating Data Buffers
+@cindex data buffere, manipulation
 
 @deftypefun GpgmeError gpgme_data_read (@w{GpgmeData @var{dh}}, @w{char *@var{buffer}}, @w{size_t @var{length}}, @w{size_t *@var{nread}})
 The function @code{gpgme_data_read} reads up to @var{length} bytes
@@ -836,6 +888,7 @@ available.
 @end deftypefun
 
 @deftp {Data type} {enum GpgmeDataType}
+@tindex GpgmeDataType
 The @code{GpgmeDataType} type specifies the type of a @code{GpgmeData} object.
 The following data types are available:
 
@@ -867,8 +920,9 @@ object with the handle @var{dh}.  If @var{dh} is not a valid pointer,
 
 @node Contexts
 @chapter Contexts
+@cindex context
 
-All cryptograhic operations in @acronym{GPGME} are performed within a
+All cryptographic operations in @acronym{GPGME} are performed within a
 context, which contains the internal state of the operation as well as
 configuration parameters.  By using several contexts you can run
 several cryptographic operations in parallel, with different
@@ -881,17 +935,19 @@ cryptographic operations.
 @end deftp
 
 @menu
-* Creating contexts::             Creating new @acronym{GPGME} contexts.
-* Destroying contexts::           Releasing @acronym{GPGME} contexts.
-* Context attributes::            Setting properties of a context.
+* Creating Contexts::             Creating new @acronym{GPGME} contexts.
+* Destroying Contexts::           Releasing @acronym{GPGME} contexts.
+* Context Attributes::            Setting properties of a context.
 * Key Management::                Managing keys with @acronym{GPGME}.
 * Trust Item Management::         Managing trust items with @acronym{GPGME}.
 * Crypto Operations::             Using a context for cryptography.
+* Run Control::                   Controlling how operations are run.
 @end menu
 
 
-@node Creating contexts
-@section Creating contexts
+@node Creating Contexts
+@section Creating Contexts
+@cindex context, creation
 
 @deftypefun GpgmeError gpgme_new (@w{GpgmeCtx *@var{ctx}})
 The function @code{gpgme_data_new} creates a new @code{GpgmeCtx}
@@ -904,9 +960,9 @@ available.
 @end deftypefun
 
 
-
-@node Destroying contexts
-@section Destroying contexts
+@node Destroying Contexts
+@section Destroying Contexts
+@cindex context, destruction
 
 @deftypefun void gpgme_release (@w{GpgmeCtx @var{ctx}})
 The function @code{gpgme_release} destroys the context with the handle
@@ -914,21 +970,25 @@ The function @code{gpgme_release} destroys the context with the handle
 @end deftypefun
 
 
-@node Context attributes
-@section Context attributes
+@node Context Attributes
+@section Context Attributes
+@cindex context, attributes
 
 @menu
-* Protocol selection::            Selecting the protocol used by a context.
-* @acronym{ASCII} armor::                   Requesting @acronym{ASCII} armored output.
-* Text mode::                     Choosing canonical text mode.
-* Key listing mode::              Selecting key listing mode.
-* Passphrase callback::           Getting the passphrase from the user.
-* Progress meter callback::       Being informed about the progress.
+* Protocol Selection::            Selecting the protocol used by a context.
+* @acronym{ASCII} Armor::                   Requesting @acronym{ASCII} armored output.
+* Text Mode::                     Choosing canonical text mode.
+* Included Certificates::       Including a number of certificates.
+* Key Listing Mode::              Selecting key listing mode.
+* Passphrase Callback::           Getting the passphrase from the user.
+* Progress Meter Callback::       Being informed about the progress.
 @end menu
 
 
-@node Protocol selection
-@subsection Protocol selection
+@node Protocol Selection
+@subsection Protocol Selection
+@cindex context, selecting protocol
+@cindex protocol, selecting
 
 @deftypefun GpgmeError gpgme_set_protocol (@w{GpgmeCtx @var{ctx}}, @w{GpgmeProtocol @var{proto}})
 The function @code{gpgme_set_protocol} sets the protocol used within
@@ -938,7 +998,7 @@ performed by the crypto engine configured for that protocol.
 
 Setting the protocol with @code{gpgme_set_protocol} does not check if
 the crypto engine for that protocol is available and installed
-correctly.  @xref{Engine version check}.
+correctly.  @xref{Engine Version Check}.
 
 The function returns @code{GPGME_No_Error} if the protocol could be
 set successfully, and @code{GPGME_Invalid_Value} if @var{protocol} is
@@ -946,8 +1006,11 @@ not a valid protocol.
 @end deftypefun
 
 
-@node @acronym{ASCII} armor
-@subsection @acronym{ASCII} armor
+@node @acronym{ASCII} Armor
+@subsection @acronym{ASCII} Armor
+@cindex context, armor mode
+@cindex @acronym{ASCII} armor
+@cindex armor mode
 
 @deftypefun void gpgme_set_armor (@w{GpgmeCtx @var{ctx}}, @w{int @var{yes}})
 The function @code{gpgme_set_armor} specifies if the output should be
@@ -965,8 +1028,11 @@ not a valid pointer.
 @end deftypefun
 
 
-@node Text mode
-@subsection Text mode
+@node Text Mode
+@subsection Text Mode
+@cindex context, text mode
+@cindex text mode
+@cindex canonical text mode
 
 @deftypefun void gpgme_set_textmode (@w{GpgmeCtx @var{ctx}}, @w{int @var{yes}})
 The function @code{gpgme_set_textmode} specifies if canonical text mode
@@ -976,6 +1042,9 @@ Text mode is for example used for the RFC2015 signatures; note that
 the updated RFC 3156 mandates that the mail user agent does some
 preparations so that text mode is not needed anymore.
 
+This option is only relevant to the OpenPGP crypto engine, and ignored
+by all other engines.
+
 Canonical text mode is disabled if @var{yes} is zero, and enabled
 otherwise.
 @end deftypefun
@@ -987,28 +1056,101 @@ valid pointer.
 @end deftypefun
 
 
-@node Key listing mode
-@subsection Key listing mode
+@node Included Certificates
+@subsection Included Certificates
+@cindex certificates, included
 
-@deftypefun void gpgme_set_keylist_mode (@w{GpgmeCtx @var{ctx}}, @w{int @var{mode}})
-The function @code{gpgme_set_keylist_mode} changes the default
-behaviour of the key listing functions.  Defined values for @var{mode}
-are:
+@deftypefun void gpgme_set_include_certs (@w{GpgmeCtx @var{ctx}}, @w{int @var{nr_of_certs}})
+The function @code{gpgme_set_include_certs} specifies how many
+certificates should be included in an S/MIME signed message.  By
+default, only the sender's certificate is included.  The possible
+values of @var{nr_of_certs} are:
 
 @table @code
+@item -2
+Include all certificates except the root certificate.
+@item -1
+Include all certificates.
 @item 0
-Normal listing.
+Include no certificates.
 @item 1
-Fast listing without information about the key validity.
+Include the sender's certificate only.
+@item n
+Include the first n certificates of the certificates path, starting
+from the sender's certificate.  The number @code{n} must be positive.
 @end table
+
+Values of @var{nr_of_certs} smaller than -2 are undefined.
+
+This option is only relevant to the CMS crypto engine, and ignored
+by all other engines.
+@end deftypefun
+
+@deftypefun int gpgme_get_include_certs (@w{GpgmeCtx @var{ctx}})
+The function @code{gpgme_get_include_certs} returns the number of
+certificates to include into an S/MIME signed message.
 @end deftypefun
 
 
-@node Passphrase callback
-@subsection Passphrase callback
+@node Key Listing Mode
+@subsection Key Listing Mode
+@cindex key listing mode
+@cindex key listing, mode of
 
-@deftp {Data type} {const char *(*GpgmePassphraseCb)(void *@var{hook}, const char *@var{desc}, void *@var{r_hd})}
-The @code{GpgmePasshraseCb} type is the type of functions usable as
+@deftypefun void gpgme_set_keylist_mode (@w{GpgmeCtx @var{ctx}}, @w{int @var{mode}})
+The function @code{gpgme_set_keylist_mode} changes the default
+behaviour of the key listing functions.  The value in @var{mode} is a
+bitwise-or combination of one or multiple of the following bit values:
+
+@table @code
+@item GPGME_KEYLIST_MODE_LOCAL
+The @code{GPGME_KEYLIST_MODE_LOCAL} symbol specifies that the local
+keyring should be searched for keys in the keylisting operation.  This
+is the default.
+
+@item GPGME_KEYLIST_MODE_EXTERN
+The @code{GPGME_KEYLIST_MODE_EXTERN} symbol specifies that an external
+source should be should be searched for keys in the keylisting
+operation.  The type of external source is dependant on the crypto
+engine used.  For example, it can be a remote keyserver or LDAP
+certificate server.
+@end table
+
+At least one of @code{GPGME_KEYLIST_MODE_LOCAL} and
+@code{GPGME_KEYLIST_MODE_EXTERN} must be specified.  For future binary
+compatibility, you should get the current mode with
+@code{gpgme_get_keylist_mode} and modify it by setting or clearing the
+appropriate bits, and then using that calulcated value in the
+@code{gpgme_set_keylisting_mode} operation.  This will leave all other
+bits in the mode value intact (in particular those that are not used
+in the current version of the library).
+
+The function returns @code{GPGME_No_Error} if the mode could be set
+correctly, and @code{GPGME_Invalid_Value} if @var{ctx} is not a valid
+pointer or @var{mode} is not a valid mode.
+@end deftypefun
+
+
+@deftypefun int gpgme_get_keylist_mode (@w{GpgmeCtx @var{ctx}})
+The function @code{gpgme_get_keylist_mode} returns the current key
+listing mode of the context @var{ctx}.  This value can then be
+modified and used in a subsequent @code{gpgme_set_keylist_mode}
+operation to only affect the desired bits (and leave all others
+intact).
+
+The function returns 0 if @var{ctx} is not a valid pointer, and the
+current mode otherwise.  Note that 0 is not a valid mode value.
+@end deftypefun
+
+
+@node Passphrase Callback
+@subsection Passphrase Callback
+@cindex callback, passphrase
+@cindex passphrase callback
+
+@deftp {Data type} {const char *(*GpgmePassphraseCb)(void *@var{hook}, const char *@var{desc}, void **@var{r_hd})}
+@tindex GpgmePassphraseCb
+The @code{GpgmePassphraseCb} type is the type of functions usable as
 passphrase callback function.
 
 The string @var{desc} contains a test usable to be displayed to the
@@ -1041,10 +1183,13 @@ calling @code{gpgme_set_passphrase_cb} with @var{passfunc} being
 @end deftypefun
 
 
-@node Progress meter callback
-@subsection Progress meter callback
+@node Progress Meter Callback
+@subsection Progress Meter Callback
+@cindex callback, progress meter
+@cindex progress meter callback
 
 @deftp {Data type} {const char *(*GpgmeProgressCb)(void *@var{hook}, const char *@var{what}, int @var{type}, int @var{current}, int @var{total})}
+@tindex GpgmeProgressCb
 The @code{GpgmeProgressCb} type is the type of functions usable as
 progress callback function.
 
@@ -1073,6 +1218,7 @@ calling @code{gpgme_set_progress_cb} with @var{progfunc} being
 
 @node Key Management
 @section Key Management
+@cindex key management
 
 Some of the cryptographic operations require that recipients or
 signers are specified.  This is always done by specifying the
@@ -1087,18 +1233,23 @@ A key can contain several user IDs and sub keys.
 @end deftp
 
 @menu
-* Listing keys::                  Browsing the list of available keys.
-* Information about keys::        Requesting detailed information about keys.
-* Manipulating keys::             Operations on keys.
-* Generating keys::               Creating new key pairs.
-* Exporting keys::                Retrieving key data from the key ring.
-* Importing keys::                Adding keys to the keyring.
-* Deleting keys::                 Removing keys from the keyring.
+* Listing Keys::                  Browsing the list of available keys.
+* Information About Keys::        Requesting detailed information about keys.
+* Manipulating Keys::             Operations on keys.
+* Generating Keys::               Creating new key pairs.
+* Exporting Keys::                Retrieving key data from the key ring.
+* Importing Keys::                Adding keys to the key ring.
+* Deleting Keys::                 Removing keys from the key ring.
 @end menu
 
 
-@node Listing keys
-@subsection Listing keys
+@node Listing Keys
+@subsection Listing Keys
+@cindex listing keys
+@cindex key listing
+@cindex key listing, start
+@cindex key ring, list
+@cindex key ring, search
 
 @deftypefun GpgmeError gpgme_op_keylist_start (@w{GpgmeCtx @var{ctx}}, @w{const char *@var{pattern}}, @w{int @var{secret_only}})
 The function @code{gpgme_op_keylist_start} initiates a key listing
@@ -1122,11 +1273,36 @@ valid pointer, and passes through any errors that are reported by the
 crypto engine support routines.
 @end deftypefun
 
+@deftypefun GpgmeError gpgme_op_keylist_ext_start (@w{GpgmeCtx @var{ctx}}, @w{const char *@var{pattern}[]}, @w{int @var{secret_only}}, @w{int @var{reserved}})
+The function @code{gpgme_op_keylist_ext_start} initiates an extended
+key listing operation inside the context @var{ctx}.  It sets
+everything up so that subsequent invocations of
+@code{gpgme_op_keylist_next} return the keys in the list.
+
+If @var{pattern} or @var{*pattern} is @code{NULL}, all available keys
+are returned.  Otherwise, @var{pattern} is a @code{NULL} terminated
+array of strings that are used to limit the list to all keys matching
+at least one of the patterns verbatim.
+
+If @var{secret_only} is not @code{0}, the list is restricted to secret
+keys only.
+
+The value of @var{reserved} must be @code{0}.
+
+The context will be busy until either all keys are received (and
+@code{gpgme_op_keylist_next} returns @code{GPGME_EOF}), or
+@code{gpgme_op_keylist_end} is called to finish the operation.
+
+The function returns @code{GPGME_Invalid_Value} if @var{ctx} is not a
+valid pointer, and passes through any errors that are reported by the
+crypto engine support routines.
+@end deftypefun
+
 @deftypefun GpgmeError gpgme_op_keylist_next (@w{GpgmeCtx @var{ctx}}, @w{GpgmeKey *@var{r_key}})
 The function @code{gpgme_op_keylist_next} returns the next key in the
 list created by a previous @code{gpgme_op_keylist_start} operation in
 the context @var{ctx}.  The key will have one reference for the user.
-@xref{Manipulating keys}.
+@xref{Manipulating Keys}.
 
 This is the only way to get at @code{GpgmeKey} objects in
 @acronym{GPGME}.
@@ -1150,9 +1326,41 @@ operation, @code{GPGME_Out_Of_Core} if at some time during the
 operation there was not enough memory available.
 @end deftypefun
 
+The following example illustrates how all keys containing a certain
+string (@code{g10code}) can be listed with their key ID and the name
+and e-mail address of the main user ID:
+
+@example
+GpgmeCtx ctx;
+GpgmeError err = gpgme_new (&ctx);
+
+if (!err)
+  @{
+    err = gpgme_op_keylist_start (ctx, "g10code", 0);
+    while (!err && (err = gpgme_op_keylist_next (ctx, &key)) != GPGME_EOF)
+      @{
+        printf ("%s: %s <%s>\n",
+                gpgme_key_get_string_attr (key, GPGME_ATTR_KEYID, 0, 0),
+               gpgme_key_get_string_attr (key, GPGME_ATTR_NAME, 0, 0),
+               gpgme_key_get_string_attr (key, GPGME_ATTR_EMAIL, 0, 0));
+        gpgme_key_release (key);
+      @}
+    gpgme_release (ctx);
+  @}
+if (err)
+  @{
+    fprintf (stderr, "%s: can not list keys: %s\n",
+             argv[0], gpgme_strerror (err));
+    exit (1);
+  @}
+@end example
+
 
-@node Information about keys
-@subsection Information about keys
+@node Information About Keys
+@subsection Information About Keys
+@cindex key, information about
+@cindex key, attributes
+@cindex attributes, of a key
 
 @deftypefun {char *} gpgme_key_get_as_xml (@w{GpgmeKey @var{key}})
 The function @code{gpgme_key_get_as_xml} returns a string in
@@ -1191,7 +1399,8 @@ This is the timestamp at creation time of a sub key.  It is
 representable as a number.
 
 @item GPGME_ATTR_EXPIRE
-XXX FIXME
+This is the expiration time of a sub key.  It is representable as a
+number.
 
 @item GPGME_ATTR_OTRUST
 XXX FIXME  (also for trust items)
@@ -1240,7 +1449,7 @@ This is the type of a trust item.
 @item GPGME_ATTR_IS_SECRET
 This specifies if the key is a secret key.  It is representable as a
 string or a number.  If the key is a secret key, the representation is
-``1'' or @code{1}, otherwise it is NULL or @code{0}.
+``1'' or @code{1}, otherwise it is @code{NULL} or @code{0}.
 
 @item GPGME_ATTR_KEY_REVOKED
 This specifies if a sub key is revoked.  It is representable as a
@@ -1341,8 +1550,9 @@ or @var{reserved} not @code{NULL}.
 @end deftypefun
 
 
-@node Manipulating keys
-@subsection Manipulating keys
+@node Manipulating Keys
+@subsection Manipulating Keys
+@cindex key, manipulation
 
 @deftypefun void gpgme_key_ref (@w{GpgmeKey @var{key}})
 The function @code{gpgme_key_ref} acquires an additional reference for
@@ -1360,28 +1570,36 @@ The function @code{gpgme_key_release} is an alias for
 @end deftypefun
 
 
-@node Generating keys
-@subsection Generating keys
+@node Generating Keys
+@subsection Generating Keys
+@cindex key, creation
+@cindex key ring, add
 
 @deftypefun GpgmeError gpgme_op_genkey (@w{GpgmeCtx @var{ctx}}, @w{const char *@var{parms}}, @w{GpgmeData @var{pubkey}}, @w{GpgmeData @var{seckey}})
 The function @code{gpgme_op_genkey} generates a new key pair in the
-context @var{ctx} and puts it into the standard keyring if both
+context @var{ctx} and puts it into the standard key ring if both
 @var{pubkey} and @var{seckey} are @code{NULL}.  In this case the
 function returns immediately after starting the operation, and does
-not wait for it to complete.  @var{pubkey} and @var{seckey} are
-reserved for later use and should be @code{NULL}.  (The function
-should return the public key in the data buffer @var{pubkey} and the
-secret key in the data buffer @var{seckey}, but this is not
-implemented yet).
+not wait for it to complete.  If @var{pubkey} is not @code{NULL} it
+should be the handle for an empty (newly created) data object, and
+upon successful completion the data object will contain the public
+key.  If @var{seckey} is not @code{NULL} it should be the handle for
+an empty (newly created) data object, and upon successful completion
+the data object will contain the secret key.
+
+Note that not all crypto engines support this interface equally.
+GnuPG does not support @var{pubkey} and @var{subkey}, they should be
+both @code{NULL}, and the key pair will be added to the standard key
+ring.  GpgSM does only support @var{pubkey}, the secret key will be
+stored by @command{gpg-agent}.  GpgSM expects @var{pubkey} being not
+@code{NULL}.
 
 The argument @var{parms} specifies parameters for the key in an XML
 string.  The details about the format of @var{parms} are specific to
-teh crypto engine used by @var{ctx}.  Here is an example for GnuPG as
+the crypto engine used by @var{ctx}.  Here is an example for GnuPG as
 the crypto engine:
 
 @example
-<literal>
-<![CDATA[
 <GnupgKeyParms format="internal">
 Key-Type: DSA
 Key-Length: 1024
@@ -1393,8 +1611,16 @@ Name-Email: joe@@foo.bar
 Expire-Date: 0
 Passphrase: abc
 </GnupgKeyParms>
-]]>
-</literal>
+@end example
+
+Here is an example for GpgSM as the crypto engine:
+@example
+<GnupgKeyParms format="internal">
+Key-Type: RSA
+Key-Length: 1024
+Name-DN: C=de,O=g10 code,OU=Testlab,CN=Joe 2 Tester
+Name-Email: joe@@foo.bar
+</GnupgKeyParms>
 @end example
 
 Strings should be given in UTF-8 encoding.  The only format supported
@@ -1403,14 +1629,28 @@ container is passed verbatim to GnuPG.  Control statements are not
 allowed.
 
 The function returns @code{GPGME_No_Error} if the operation could be
-started, @code{GPGME_Invalid_Value} if @var{parms} is not a valid XML
-string, and @code{GPGME_Not_Supported} if @var{pubkey} or @var{seckey}
-is not @code{NULL}.
+started successfully, @code{GPGME_Invalid_Value} if @var{parms} is not
+a valid XML string, @code{GPGME_Not_Supported} if @var{pubkey} or
+@var{seckey} is not valid, and @code{GPGME_General_Error} if no key
+was created by the backend.
 @end deftypefun
 
+@deftypefun GpgmeError gpgme_op_genkey_start (@w{GpgmeCtx @var{ctx}}, @w{const char *@var{parms}}, @w{GpgmeData @var{pubkey}}, @w{GpgmeData @var{seckey}})
+The function @code{gpgme_op_genkey_start} initiates a
+@code{gpgme_op_genkey} operation.  It can be completed by calling
+@code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
+
+The function returns @code{GPGME_No_Error} if the operation could be
+started successfully, @code{GPGME_Invalid_Value} if @var{parms} is not
+a valid XML string, and @code{GPGME_Not_Supported} if @var{pubkey} or
+@var{seckey} is not @code{NULL}.
+@end deftypefun
 
-@node Exporting keys
-@subsection Exporting keys
+
+@node Exporting Keys
+@subsection Exporting Keys
+@cindex key, export
+@cindex key ring, export from
 
 @deftypefun GpgmeError gpgme_op_export (@w{GpgmeCtx @var{ctx}}, @w{GpgmeRecipients @var{recipients}}, @w{GpgmeData @var{keydata}})
 The function @code{gpgme_op_export} extracts the public keys of the
@@ -1425,9 +1665,22 @@ passes through any errors that are reported by the crypto engine
 support routines.
 @end deftypefun
 
+@deftypefun GpgmeError gpgme_op_export_start (@w{GpgmeCtx @var{ctx}}, @w{GpgmeRecipients @var{recipients}}, @w{GpgmeData @var{keydata}})
+The function @code{gpgme_op_export_start} initiates a
+@code{gpgme_op_export} operation.  It can be completed by calling
+@code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
+
+The function returns @code{GPGME_No_Error} if the operation could be
+started successfully, and @code{GPGME_Invalid_Value} if
+@var{recipients} is @code{NULL} or @var{keydata} is not a valid empty
+data buffer.
+@end deftypefun
+
 
-@node Importing keys
-@subsection Importing keys
+@node Importing Keys
+@subsection Importing Keys
+@cindex key, import
+@cindex key ring, import to
 
 @deftypefun GpgmeError gpgme_op_import (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{keydata}})
 The function @code{gpgme_op_import} adds the keys in the data buffer
@@ -1435,15 +1688,31 @@ The function @code{gpgme_op_import} adds the keys in the data buffer
 The format of @var{keydata} can be @var{ASCII} armored, for example,
 but the details are specific to the crypto engine.
 
+More information about the import is available with
+@code{gpgme_get_op_info}.  @xref{Detailed Results}.
+
 The function returns @code{GPGME_No_Error} if the import was completed
 successfully, @code{GPGME_Invalid_Value} if @var{keydata} if @var{ctx}
 or @var{keydata} is not a valid pointer, and @code{GPGME_No_Data} if
 @var{keydata} is an empty data buffer.
 @end deftypefun
 
+@deftypefun GpgmeError gpgme_op_import_start (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{keydata}})
+The function @code{gpgme_op_import_start} initiates a
+@code{gpgme_op_import} operation.  It can be completed by calling
+@code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
 
-@node Deleting keys
-@subsection Deleting keys
+The function returns @code{GPGME_No_Error} if the import could be
+started successfully, @code{GPGME_Invalid_Value} if @var{keydata} if
+@var{ctx} or @var{keydata} is not a valid pointer, and
+@code{GPGME_No_Data} if @var{keydata} is an empty data buffer.
+@end deftypefun
+
+
+@node Deleting Keys
+@subsection Deleting Keys
+@cindex key, delete
+@cindex key ring, delete from
 
 @deftypefun GpgmeError gpgme_op_delete (@w{GpgmeCtx @var{ctx}}, @w{const GpgmeKey @var{key}}, @w{int @var{allow_secret}})
 The function @code{gpgme_op_delete} deletes the key @var{key} from the
@@ -1452,13 +1721,26 @@ key ring of the crypto engine used by @var{ctx}.  If
 otherwise secret keys are deleted as well.
 
 The function returns @code{GPGME_No_Error} if the key was deleted
-successfully, and @code{GPGME_Invalid_Value} if @var{ctx} or @var{key}
-is not a valid pointer.
+successfully, @code{GPGME_Invalid_Value} if @var{ctx} or @var{key} is
+not a valid pointer, @code{GPGME_Invalid_Key} if @var{key} could not
+be found in the keyring, and @code{GPGME_Conflict} if the secret key
+for @var{key} is available, but @var{allow_secret} is zero.
+@end deftypefun
+
+@deftypefun GpgmeError gpgme_op_delete_start (@w{GpgmeCtx @var{ctx}}, @w{const GpgmeKey @var{key}}, @w{int @var{allow_secret}})
+The function @code{gpgme_op_delete_start} initiates a
+@code{gpgme_op_delete} operation.  It can be completed by calling
+@code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
+
+The function returns @code{GPGME_No_Error} if the operation was
+started successfully, and @code{GPGME_Invalid_Value} if @var{ctx} or
+@var{key} is not a valid pointer.
 @end deftypefun
 
 
 @node Trust Item Management
 @section Trust Item Management
+@cindex trust item
 
 @strong{Caution:} The trust items interface is experimental.
 
@@ -1467,20 +1749,21 @@ The @code{GpgmeTrustItem} type is a handle for a trust item.
 @end deftp
 
 @menu
-* Listing trust items::           Browsing the list of available trust items.
-* Information about trust items:: Requesting detailed information about trust items.
-* Manipulating trust items::      Operations on trust items.
+* Listing Trust Items::           Browsing the list of available trust items.
+* Information About Trust Items:: Requesting detailed information about trust items.
+* Manipulating Trust Items::      Operations on trust items.
 @end menu
 
 
-@node Listing trust items
-@subsection Listing trust items
+@node Listing Trust Items
+@subsection Listing Trust Items
+@cindex trust item list
 
 @deftypefun GpgmeError gpgme_op_trustlist_start (@w{GpgmeCtx @var{ctx}}, @w{const char *@var{pattern}}, @w{int @var{max_level}})
 The function @code{gpgme_op_trustlist_start} initiates a trust item
 listing operation inside the context @var{ctx}.  It sets everything up
 so that subsequent invocations of @code{gpgme_op_trustlist_next} return
-the trsut items in the list.
+the trust items in the list.
 
 The string @var{pattern} contains an engine specific expression that
 is used to limit the list to all trust items matching the pattern.  It
@@ -1501,7 +1784,7 @@ crypto engine support routines.
 The function @code{gpgme_op_trustlist_next} returns the next trust
 item in the list created by a previous @code{gpgme_op_trustlist_start}
 operation in the context @var{ctx}.  The trust item can be destroyed
-with @code{gpgme_trust_item_release}.  @xref{Manipulating trust items}.
+with @code{gpgme_trust_item_release}.  @xref{Manipulating Trust Items}.
 
 This is the only way to get at @code{GpgmeTrustItem} objects in
 @acronym{GPGME}.
@@ -1526,12 +1809,15 @@ operation there was not enough memory available.
 @end deftypefun
 
 
-@node Information about trust items
-@subsection Information about trust items
+@node Information About Trust Items
+@subsection Information About Trust Items
+@cindex trust item, information about
+@cindex trust item, attributes
+@cindex attributes, of a trust item
 
 Trust items have attributes which can be queried using the interfaces
 below.  The attribute identifiers are shared with those for key
-attributes.  @xref{Information about keys}.
+attributes.  @xref{Information About Keys}.
 
 @deftypefun {const char *} gpgme_trust_item_get_string_attr (@w{GpgmeTrustItem @var{item}}, @w{GpgmeAttr @var{what}}, @w{const void *@var{reserved}}, @w{int @var{idx}})
 The function @code{gpgme_trust_item_get_string_attr} returns the value
@@ -1562,8 +1848,9 @@ or @var{reserved} not @code{NULL}.
 @end deftypefun
 
 
-@node Manipulating trust items
-@subsection Manipulating trust items
+@node Manipulating Trust Items
+@subsection Manipulating Trust Items
+@cindex trust item, manipulation
 
 @deftypefun void gpgme_trust_item_release (@w{GpgmeTrustItem @var{item}})
 The function @code{gpgme_trust_item_release} destroys a
@@ -1572,18 +1859,22 @@ The function @code{gpgme_trust_item_release} destroys a
 
 @node Crypto Operations
 @section Crypto Operations
+@cindex cryptographic operation
 
 @menu
 * Decrypt::                       Decrypting a ciphertext.
 * Verify::                        Verifying a signature.
-* Decrypt and verify::            Decrypting a signed ciphertext.
+* Decrypt and Verify::            Decrypting a signed ciphertext.
 * Sign::                          Creating a signature.
 * Encrypt::                       Encrypting a plaintext.
+* Detailed Results::              How to obtain more info about the operation.
 @end menu
 
 
 @node Decrypt
 @subsection Decrypt
+@cindex decryption
+@cindex cryptographic operation, decryption
 
 @deftypefun GpgmeError gpgme_op_decrypt (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{cipher}}, @w{GpgmeData @var{plain}})
 The function @code{gpgme_op_decrypt} decrypts the ciphertext in the
@@ -1600,22 +1891,27 @@ secret key could not be retrieved, and passes through any errors that
 are reported by the crypto engine support routines.
 @end deftypefun
 
-@c @deftypefun GpgmeError gpgme_op_decrypt_start (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{cipher}}, @w{GpgmeData @var{plain}})
-@c The function @code{gpgme_op_decrypt_start} initiates a
-@c @code{gpgme_op_decrypt} operation.  It can be completed by calling
-@c @code{gpgme_wait} on the context.
+@deftypefun GpgmeError gpgme_op_decrypt_start (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{cipher}}, @w{GpgmeData @var{plain}})
+The function @code{gpgme_op_decrypt_start} initiates a
+@code{gpgme_op_decrypt} operation.  It can be completed by calling
+@code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
 
-@c The function returns @code{GPGME_No_Error} if the operation could be
-@c started, @code{GPGME_Invalid_Value} if @var{cipher} or @var{plain} is
-@c not a valid pointer, and passes through any errors that are reported
-@c by the crypto engine support routines.
-@c @end deftypefun
+The function returns @code{GPGME_No_Error} if the operation could be
+started successfully, and @code{GPGME_Invalid_Value} if @var{cipher}
+or @var{plain} is not a valid pointer.
+@end deftypefun
 
 
 @node Verify
 @subsection Verify
+@cindex verification
+@cindex signature, verification
+@cindex cryptographic operation, verification
+@cindex cryptographic operation, signature check
+@cindex signature, status
 
 @deftp {Data type} {enum GpgmeSigStat}
+@tindex GpgmeSigStat
 The @code{GpgmeSigStat} type holds the result of a signature check, or
 the combined result of all signatures.  The following results are
 possible:
@@ -1653,9 +1949,14 @@ have a different status.  You can get each key's status with
 @end deftp
 
 @deftypefun GpgmeError gpgme_op_verify (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{sig}}, @w{GpgmeData @var{plain}}, @w{GpgmeSigStat *@var{r_stat}})
-The function @code{gpgme_op_verify} verifies that the detached
-signature in the data object @var{sig} is a valid signature for the
-plaintext in the data object @var{plain}.
+The function @code{gpgme_op_verify} verifies that the signature in the
+data object @var{sig} is a valid signature.  If @var{plain} is
+initialized with plaintext data, it is assumed that @var{sig} is a
+detached signature, and its validity for the plaintext given in
+@var{plain} is verified.  If @var{plain} is an uninitialized data
+object, it is assumed that @var{sig} is a normal (or cleartext)
+signature, and the plaintext is available in @var{plain} after
+successful verification.
 
 The combined status of all signatures is returned in @var{r_stat}.
 The results of the individual signature verifications can be retrieved
@@ -1664,12 +1965,22 @@ with @code{gpgme_get_sig_status} and @code{gpgme_get_sig_key}.
 The function returns @code{GPGME_No_Error} if the operation could be
 completed successfully, @code{GPGME_Invalid_Value} if @var{ctx},
 @var{sig}, @var{plain} or @var{r_stat} is not a valid pointer,
-@code{GPGME_No_Data} if @var{sig} or @var{plain} does not contain any
-data to verify, and passes through any errors that are reported by the
-crypto engine support routines.
+@code{GPGME_No_Data} if @var{sig} does not contain any data to verify,
+and passes through any errors that are reported by the crypto engine
+support routines.
 @end deftypefun
 
-@c GpgmeError gpgme_op_verify_start (GpgmeCtx ctx, GpgmeData sig, GpgmeData plain);
+@deftypefun GpgmeError gpgme_op_verify_start (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{sig}}, @w{GpgmeData @var{plain}})
+The function @code{gpgme_op_verify_start} initiates a
+@code{gpgme_op_verify} operation.  It can be completed by calling
+@code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
+
+The function returns @code{GPGME_No_Error} if the operation could be
+started successfully, @code{GPGME_Invalid_Value} if @var{ctx},
+@var{sig}, @var{plain} or @var{r_stat} is not a valid pointer, and
+@code{GPGME_No_Data} if @var{sig} or @var{plain} does not contain any
+data to verify.
+@end deftypefun
 
 @deftypefun {const char *} gpgme_get_sig_status (@w{GpgmeCtx @var{ctx}}, @w{int @var{idx}}, @w{GpgmeSigStat *@var{r_stat}}, @w{time_t *@var{r_created}})
 The function @code{gpgme_get_sig_status} receives information about a
@@ -1705,12 +2016,30 @@ The function returns @code{GPGME_No_Error} if the key could be
 returned, @code{GPGME_Invalid_Value} if @var{r_key} is not a valid
 pointer, @code{GPGME_Invalid_Key} if the fingerprint is not valid,
 @code{GPGME_EOF} if @var{idx} is too large, or some other error value
-if a problem occured requesting the key.
+if a problem occurred requesting the key.
+@end deftypefun
+
+@deftypefun {char *} gpgme_get_notation (@w{GpgmeCtx @var{ctx}})
+The function @code{gpgme_get_notation} can be used to retrieve
+notation data from the last signature check in the context @var{ctx}.
+
+If there is notation data available from the last signature check,
+this function may be used to return this notation data as a string.
+The string is an XML representation of that data embedded in a
+<notation> container.  The user has to release the string with
+@code{free}.
+
+The function returns a string if the notation data is available or
+@code{NULL} if there is no such data available.
 @end deftypefun
 
 
-@node Decrypt and verify
-@subsection Decrypt and verify
+@node Decrypt and Verify
+@subsection Decrypt and Verify
+@cindex decryption and verification
+@cindex verification and decryption
+@cindex signature check
+@cindex cryptographic operation, decryption and verification
 
 @deftypefun GpgmeError gpgme_op_decrypt_verify (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{cipher}}, @w{GpgmeData @var{plain}}, @w{GpgmeSigStat *@var{r_stat}})
 The function @code{gpgme_op_decrypt_verify} decrypts the ciphertext in
@@ -1732,11 +2061,25 @@ secret key could not be retrieved, and passes through any errors that
 are reported by the crypto engine support routines.
 @end deftypefun
 
-@c GpgmeError gpgme_op_decrypt_verify (GpgmeCtx c, GpgmeData in, GpgmeData out, GpgmeSigStat *r_status);
+@deftypefun GpgmeError gpgme_op_decrypt_verify (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{cipher}}, @w{GpgmeData @var{plain}})
+The function @code{gpgme_op_decrypt_verify_start} initiates a
+@code{gpgme_op_decrypt_verify} operation.  It can be completed by
+calling @code{gpgme_wait} on the context.  @xref{Waiting For
+Completion}.
+
+The function returns @code{GPGME_No_Error} if the operation could be
+started successfully, @code{GPGME_Invalid_Value} if @var{ctx},
+@var{cipher}, @var{plain} or @var{r_stat} is not a valid pointer, and
+@code{GPGME_No_Data} if @var{cipher} does not contain any data to
+decrypt.
+@end deftypefun
 
 
 @node Sign
 @subsection Sign
+@cindex signature, creation
+@cindex sign
+@cindex cryptographic operation, signing
 
 A signature can contain signatures by one or more keys.  The set of
 keys used to create a signatures is contained in a context, and is
@@ -1744,13 +2087,15 @@ applied to all following signing operations in this context (until the
 set is changed).
 
 @menu
-* Selecting signers::             How to choose the keys to sign with.
-* Creating a signature::          How to create a signature.
+* Selecting Signers::             How to choose the keys to sign with.
+* Creating a Signature::          How to create a signature.
 @end menu
 
 
-@node Selecting signers
-@subsubsection Selecting signers
+@node Selecting Signers
+@subsubsection Selecting Signers
+@cindex signature, selecting signers
+@cindex signers, selecting
 
 @deftypefun void gpgme_signers_clear (@w{GpgmeCtx @var{ctx}})
 The function @code{gpgme_signers_clear} releases a reference for each
@@ -1760,7 +2105,6 @@ context @var{ctx}.
 Every context starts with an empty list.
 @end deftypefun
 
-
 @deftypefun GpgmeError gpgme_signers_add (@w{GpgmeCtx @var{ctx}}, @w{const GpgmeKey @var{key}})
 The function @code{gpgme_signers_add} adds the key @var{key} to the
 list of signers in the context @var{ctx}.
@@ -1777,10 +2121,11 @@ If @var{seq} is out of range, @code{NULL} is returned.
 @end deftypefun
 
 
-@node Creating a signature
-@subsubsection Creating a signature
+@node Creating a Signature
+@subsubsection Creating a Signature
 
 @deftp {Data type} {enum GpgmeSigMode}
+@tindex GpgmeSigMode
 The @code{GpgmeSigMode} type is used to specify the desired type of a
 signature.  The following modes are available:
 
@@ -1805,6 +2150,13 @@ the data object @var{plain} and returns it in the data object
 @acronym{ASCII} armor and text mode attributes set for the context
 @var{ctx} and the requested signature mode @var{mode}.
 
+More information about the signatures is available with
+@code{gpgme_get_op_info}.  @xref{Detailed Results}.
+
+If an S/MIME signed message is created using the CMS crypto engine,
+the number of certificates to include in the message can be specified
+with @code{gpgme_set_include_certs}.  @xref{Included Certificates}.
+
 The function returns @code{GPGME_No_Error} if the signature could be
 created successfully, @code{GPGME_Invalid_Value} if @var{ctx},
 @var{plain} or @var{sig} is not a valid pointer, @code{GPGME_No_Data}
@@ -1814,22 +2166,36 @@ through any errors that are reported by the crypto engine support
 routines.
 @end deftypefun
 
+@deftypefun GpgmeError gpgme_op_sign (@w{GpgmeCtx @var{ctx}}, @w{GpgmeData @var{plain}}, @w{GpgmeData @var{sig}}, @w{GpgmeSigMode @var{mode}})
+The function @code{gpgme_op_sign_start} initiates a
+@code{gpgme_op_sign} operation.  It can be completed by calling
+@code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
+
+The function returns @code{GPGME_No_Error} if the operation could be
+started successfully, and @code{GPGME_Invalid_Value} if @var{ctx},
+@var{plain} or @var{sig} is not a valid pointer.
+@end deftypefun
+
 
 @node Encrypt
 @subsection Encrypt
+@cindex encryption
+@cindex cryptographic operation, encryption
 
 One plaintext can be encrypted for several recipients at the same
 time.  The list of recipients is created independently of any context,
 and then passed to the encryption operation.
 
 @menu
-* Selecting recipients::          How to choose the recipients.
-* Encrypting a plaintext::        How to encrypt a plaintext.
+* Selecting Recipients::          How to choose the recipients.
+* Encrypting a Plaintext::        How to encrypt a plaintext.
 @end menu
 
 
-@node Selecting recipients
-@subsubsection Selecting recipients
+@node Selecting Recipients
+@subsubsection Selecting Recipients
+@cindex encryption, selecting recipients
+@cindex recipients
 
 @deftp {Data type} GpgmeRecipients
 The @code{GpgmeRecipients} type is a handle for a set of recipients
@@ -1867,7 +2233,7 @@ The function @code{gpgme_recipients_add_name_with_validity} adds the
 recipient @var{name} with the validity @var{val} to the set of
 recipients @var{rset}.  If the validity is not known, the function
 @code{gpgme_recipients_add_name} can be used.
-@xref{Information about keys}, for the possible values for @var{val}.
+@xref{Information About Keys}, for the possible values for @var{val}.
 
 The function returns @code{GPGME_No_Error} if the recipient was added
 successfully, @code{GPGME_Invalid_Value} if @var{rset} or @var{name}
@@ -1907,23 +2273,188 @@ The function @code{gpgme_recipients_enum_close} releases the iterator
 @end deftypefun
 
 
-@node Encrypting a plaintext
-@subsubsection Encrypting a plaintext
+@node Encrypting a Plaintext
+@subsubsection Encrypting a Plaintext
 
 @deftypefun GpgmeError gpgme_op_encrypt (@w{GpgmeCtx @var{ctx}}, @w{GpgmeRecipients @var{rset}}, @w{GpgmeData @var{plain}}, @w{GpgmeData @var{cipher}})
-The function @code{gpgme_op_crypt} encrypts the plaintext in the data
+The function @code{gpgme_op_encrypt} encrypts the plaintext in the data
 object @var{plain} for the recipients @var{rset} and stores the
 ciphertext in the data object @var{cipher}.  The type of the
 ciphertext created is determined by the @acronym{ASCII} armor and text
 mode attributes set for the context @var{ctx}.
 
+If @code{GPGME_Invalid_Recipients} is returned, some recipients in
+@var{rset} are invalid, but not all.  In this case the plaintext is
+encrypted for all valid recipients and returned in @var{cipher}.  More
+information about the invalid recipients is available with
+@code{gpgme_get_op_info}.  @xref{Detailed Results}.
+
+If @var{recp} is @code{NULL}, symmetric rather than public key
+encryption is performed.  Symmetrically encrypted cipher text can be
+deciphered with @code{gpgme_op_decrypt}.  Note that in this case the
+crypto backend needs to retrieve a passphrase from the user.
+Symmetric encryption is currently only supported for the OpenPGP
+crypto backend.
+
 The function returns @code{GPGME_No_Error} if the ciphertext could be
 created successfully, @code{GPGME_Invalid_Value} if @var{ctx},
 @var{rset}, @var{plain} or @var{cipher} is not a valid pointer,
-@code{GPGME_No_Recipient} if @var{rset} does not contain any
-valid recipients, @code{GPGME_No_Passphrase} if the passphrase for the
-secret key could not be retrieved, and passes through any errors that
-are reported by the crypto engine support routines.
+@code{GPGME_No_Recipients} if @var{rset} does not contain any valid
+recipients, @code{GPGME_Invalid_Recipients} if @var{rset} contains
+some invalid recipients, @code{GPGME_No_Passphrase} if the passphrase
+for the secret key could not be retrieved, and passes through any
+errors that are reported by the crypto engine support routines.
+@end deftypefun
+
+@deftypefun GpgmeError gpgme_op_encrypt_start (@w{GpgmeCtx @var{ctx}}, @w{GpgmeRecipients @var{rset}}, @w{GpgmeData @var{plain}}, @w{GpgmeData @var{cipher}})
+The function @code{gpgme_op_encrypt_start} initiates a
+@code{gpgme_op_encrypt} operation.  It can be completed by calling
+@code{gpgme_wait} on the context.  @xref{Waiting For Completion}.
+
+The function returns @code{GPGME_No_Error} if the operation could be
+started successfully, @code{GPGME_Invalid_Value} if @var{ctx},
+@var{rset}, @var{plain} or @var{cipher} is not a valid pointer, and
+@code{GPGME_No_Recipients} if @var{rset} does not contain any valid
+recipients.
+@end deftypefun
+
+
+@deftypefun GpgmeError gpgme_op_encrypt_sign (@w{GpgmeCtx @var{ctx}}, @w{GpgmeRecipients @var{rset}}, @w{GpgmeData @var{plain}}, @w{GpgmeData @var{cipher}})
+The function @code{gpgme_op_encrypt_sign} does a combined encrypt and
+sign operation.  It is used like @code{gpgme_op_encrypt}, but the
+ciphertext also contains signatures for the signers listed in
+@var{ctx}.
+
+The combined encrypt and sign operation is currently only available
+for the OpenPGP crypto engine.
+@end deftypefun
+
+@deftypefun GpgmeError gpgme_op_encrypt_sign_start (@w{GpgmeCtx @var{ctx}}, @w{GpgmeRecipients @var{rset}}, @w{GpgmeData @var{plain}}, @w{GpgmeData @var{cipher}})
+The function @code{gpgme_op_encrypt_sign_start} initiates a
+@code{gpgme_op_encrypt_sign} operation.  It can be completed by
+calling @code{gpgme_wait} on the context.  @xref{Waiting For
+Completion}.
+
+The function returns @code{GPGME_No_Error} if the operation could be
+started successfully, @code{GPGME_Invalid_Value} if @var{ctx},
+@var{rset}, @var{plain} or @var{cipher} is not a valid pointer, and
+@code{GPGME_No_Recipients} if @var{rset} does not contain any valid
+recipients.
+@end deftypefun
+
+
+@node Detailed Results
+@subsection Detailed Results
+@cindex cryptographic operation, detailed results
+
+@deftypefun {char *} gpgme_get_op_info (@w{GpgmeCtx @var{ctx}}, @w{int @var{reserved}})
+The function @code{gpgme_get_op_info} retrieves more information about
+the last crypto operation.
+
+The function returns a string in the XML format.  The user has to
+release the string with @code{free}.
+
+Here is a sample of the information that might be returned:
+@example
+<GnupgOperationInfo>
+  <signature>
+    <detached/> <!-- or cleartext or standard -->
+    <algo>17</algo>
+    <hashalgo>2</hashalgo>
+    <micalg>pgp-sha1</micalg>
+    <sigclass>01</sigclass>
+    <created>9222222</created>
+    <fpr>121212121212121212</fpr>
+  </signature>
+</GnupgOperationInfo>
+@end example
+
+Currently, the only operations that return additional information are
+encrypt, sign and import.  @xref{Encrypt}, @xref{Sign}, @xref(Importing Keys}.
+
+The function returns a string or @code{NULL} if no such data is
+available.
+@end deftypefun
+
+
+@node Run Control
+@section Run Control
+@cindex run control
+@cindex cryptographic operation, running
+
+Some basic support for running operations asynchronously is available
+in @acronym{GPGME}.  You can use it to set up a context completely up
+to initiating the desired operation, but delay performing it to a
+later point.
+
+@menu
+* Waiting For Completion::        Waiting until an operation is completed.
+* Cancelling an Operation::       Interrupting a running operation.
+* Hooking Up Into Idle Time::     Doing something when nothing has to be done.
+@end menu
+
+
+@node Waiting For Completion
+@subsection Waiting For Completion
+@cindex cryptographic operation, wait for
+@cindex wait for completion
+
+@deftypefun GpgmeCtx gpgme_wait (@w{GpgmeCtx @var{ctx}}, @w{GpgmeError *@var{status}}, @w{int @var{hang}})
+The function @code{gpgme_wait} does continue the pending operation
+within the context @var{ctx}.  In particular, it ensures the data
+exchange between @acronym{GPGME} and the crypto backend and watches
+over the run time status of the backend process.
+
+If @var{hang} is true, the function does not return until the
+operation is completed or cancelled.  Otherwise the function will not
+block for a long time.
+
+The error status of the finished operation is returned in
+@var{status}.
+
+The @var{ctx} argument can be @code{NULL}.  In that case,
+@code{gpgme_wait} waits for any context to complete its operation.
+
+The function returns the @var{ctx} of the context which has finished
+the operation.
+@end deftypefun
+
+
+@node Cancelling an Operation
+@subsection Cancelling an Operation
+@cindex cancellation
+@cindex cryptographic operation, cancel
+
+@deftypefun void gpgme_cancel (@w{GpgmeCtx @var{ctx}})
+The function @code{gpgme_cancel} tries to cancel the pending
+operation.  The function @code{gpgme_wait} might notice the
+cancellation flag and return.  It is currently not guaranteed to work
+under all circumstances.  It's current primary purpose is to prevent
+asking for a passphrase again in the passphrase callback.
+@end deftypefun
+
+
+@node Hooking Up Into Idle Time
+@subsection Hooking Up Into Idle Time
+@cindex idle time
+@cindex idle function
+
+@deftp {Data type} {void (*GpgmeIdleFunc) (void)}
+@tindex GpgmeIdleFunc
+The @code{GpgmeIdleFunc} type is the type of functions usable as
+an idle function that can be registered with @code{gpgme_register_idle}.
+@end deftp
+
+@deftypefun GpgmeIdleFunc gpgme_register_idle (@w{GpgmeIdleFunc @var{idle}})
+The function @code{gpgme_register_idle} can be used to register
+@var{idle} as the idle function.
+
+@var{idle} will be called whenever @acronym{GPGME} thinks that it is
+idle and time can better be spent elsewhere.  Setting @var{idle} to
+@code{NULL} disables use of the idle function (this is the default).
+
+The function returns the old idle function, or @code{NULL} if none was
+registered yet.
 @end deftypefun