The `GnuPG Made Easy' Reference Manual: The `GnuPG Made Easy' Reference Manual

[Top] | [Contents] | [Index] | [ ? ]

# The `GnuPG Made Easy' Reference Manual

This is Edition 0.3.12, last updated 3 September 2002, of The `GnuPG Made Easy' Reference Manual, for Version 0.3.12 of the GPGME library.

> 1. Introduction |  | How to use this manual.
> 2. Preparation |  | What you should do before using the library.
> 3. Protocols and Engines |  | Supported crypto protocols.
> 4. Error Handling |  | Error numbers and their meanings.
> 5. Exchanging Data |  | Passing data to and from GPGME.
> 6. Contexts |  | Handling GPGME contexts.

> Appendices

> A. GNU GENERAL PUBLIC LICENSE |  | The GNU General Public License says how you can copy and share `GnuPG Made Easy'.
> B. GNU Free Documentation License |  | This manual is under the GNU Free Documentation License.

> Indices

> Concept Index |  | Index of concepts and programs.
> Function and Data Index |  | Index of functions, variables and data types.

> -- The Detailed Node Listing ---
> Introduction

> 1.1 Getting Started |  | Purpose of the manual, and how to use it.
> 1.2 Features |  | Reasons to install and use GPGME.
> 1.3 Overview |  | Basic architecture of the GPGME library.

> Preparation

> 2.1 Header |  | What header file you need to include.
> 2.2 Building the Source |  | Compiler options to be used.
> 2.3 Using Automake |  | Compiler options to be used the easy way.
> 2.4 Library Version Check |  | Getting and verifying the library version.
> 2.5 Multi Threading |  | How GPGME can be used in an MT environment.

> Protocols and Engines

> 3.1 Engine Version Check |  | Verifying the engine version.
> 3.2 Engine Information |  | Obtaining more information about the engines.
> 3.3 OpenPGP |  | Support for the OpenPGP protocol.
> 3.4 Cryptographic Message Syntax |  | Support for the CMS.

> Error Handling

> 4.1 Error Values |  | A list of all error values used.
> 4.2 Error Strings |  | How to get a descriptive string from a value.

> Exchanging Data

> 5.1 Creating Data Buffers |  | Creating new data buffers.
> 5.2 Destroying Data Buffers |  | Releasing data buffers.
> 5.3 Manipulating Data Buffers |  | Operations on data buffers.

> Contexts

> 6.1 Creating Contexts |  | Creating new GPGME contexts.
> 6.2 Destroying Contexts |  | Releasing GPGME contexts.
> 6.3 Context Attributes |  | Setting properties of a context.
> 6.4 Key Management |  | Managing keys with GPGME.
> 6.5 Trust Item Management |  | Managing trust items with GPGME.
> 6.6 Crypto Operations |  | Using a context for cryptography.
> 6.7 Run Control |  | Controlling how operations are run.

> Context Attributes

> 6.3.1 Protocol Selection |  | Selecting the protocol used by a context.
> 6.3.2 ASCII Armor |  | Requesting ASCII armored output.
> 6.3.3 Text Mode |  | Choosing canonical text mode.
> 6.3.4 Included Certificates |  | Including a number of certificates.
> 6.3.5 Key Listing Mode |  | Selecting key listing mode.
> 6.3.6 Passphrase Callback |  | Getting the passphrase from the user.
> 6.3.7 Progress Meter Callback |  | Being informed about the progress.

> Key Management

> 6.4.1 Listing Keys |  | Browsing the list of available keys.
> 6.4.2 Information About Keys |  | Requesting detailed information about keys.
> 6.4.3 Manipulating Keys |  | Operations on keys.
> 6.4.4 Generating Keys |  | Creating new key pairs.
> 6.4.5 Exporting Keys |  | Retrieving key data from the key ring.
> 6.4.6 Importing Keys |  | Adding keys to the key ring.
> 6.4.7 Deleting Keys |  | Removing keys from the key ring.

> Trust Item Management

> 6.5.1 Listing Trust Items |  | Browsing the list of available trust items.
> 6.5.2 Information About Trust Items |  | Requesting detailed information about trust items.
> 6.5.3 Manipulating Trust Items |  | Operations on trust items.

> Crypto Operations

> 6.6.1 Decrypt |  | Decrypting a ciphertext.
> 6.6.2 Verify |  | Verifying a signature.
> 6.6.3 Decrypt and Verify |  | Decrypting a signed ciphertext.
> 6.6.4 Sign |  | Creating a signature.
> 6.6.5 Encrypt |  | Encrypting a plaintext.
> 6.6.6 Detailed Results |  | How to obtain more info about the operation.

> Sign

> 6.6.4.1 Selecting Signers |  | How to choose the keys to sign with.
> 6.6.4.2 Creating a Signature |  | How to create a signature.

> Encrypt

> 6.6.5.1 Selecting Recipients |  | How to choose the recipients.
> 6.6.5.2 Encrypting a Plaintext |  | How to encrypt a plaintext.

> Run Control

> 6.7.1 Waiting For Completion |  | Waiting until an operation is completed.
> 6.7.2 Cancelling an Operation |  | Interrupting a running operation.
> 6.7.3 Hooking Up Into Idle Time |  | Doing something when nothing has to be done.
> 6.7.4 Using External Event Loops |  | Advanced control over what happens when.

> Using External Event Loops

> 6.7.4.1 I/O Callback Interface |  | How I/O callbacks are registered.
> 6.7.4.2 Registering I/O Callbacks |  | How to use I/O callbacks for a context.
> 6.7.4.3 I/O Callback Example |  | An example how to use I/O callbacks.
> 6.7.4.4 I/O Callback Example GTK+ |  | How to integrate GPGME in GTK+.
> 6.7.4.5 I/O Callback Example GDK |  | How to integrate GPGME in GDK.

This document was generated by John Goerzen on November, 21 2002 using texi2html