diff options
Diffstat (limited to 'doc/gpgme.info-1')
| -rw-r--r-- | doc/gpgme.info-1 | 90 |
1 files changed, 76 insertions, 14 deletions
diff --git a/doc/gpgme.info-1 b/doc/gpgme.info-1 index 2066b90..83cc269 100644 --- a/doc/gpgme.info-1 +++ b/doc/gpgme.info-1 @@ -22,8 +22,8 @@ General Public License for more details. This file documents the GPGME library. - This is Edition 1.4.2, last updated 28 May 2013, of `The `GnuPG Made -Easy' Reference Manual', for Version 1.4.2. + This is Edition 1.4.3, last updated 9 August 2013, of `The `GnuPG +Made Easy' Reference Manual', for Version 1.4.3. Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2010, 2012, 2013 g10 Code GmbH. @@ -45,8 +45,8 @@ File: gpgme.info, Node: Top, Next: Introduction, Up: (dir) Main Menu ********* -This is Edition 1.4.2, last updated 28 May 2013, of `The `GnuPG Made -Easy' Reference Manual', for Version 1.4.2 of the GPGME library. +This is Edition 1.4.3, last updated 9 August 2013, of `The `GnuPG Made +Easy' Reference Manual', for Version 1.4.3 of the GPGME library. * Menu: @@ -1783,6 +1783,7 @@ be used to manipulate both. * Data Buffer I/O Operations:: I/O operations on data buffers. * Data Buffer Meta-Data:: Meta-data manipulation of data buffers. +* Data Buffer Convenience:: Convenience fucntion for data buffers. File: gpgme.info, Node: Data Buffer I/O Operations, Next: Data Buffer Meta-Data, Up: Manipulating Data Buffers @@ -1852,7 +1853,7 @@ be removed in a future version of GPGME. ? gpgme_error_from_errno (errno) : 0; -File: gpgme.info, Node: Data Buffer Meta-Data, Prev: Data Buffer I/O Operations, Up: Manipulating Data Buffers +File: gpgme.info, Node: Data Buffer Meta-Data, Next: Data Buffer Convenience, Prev: Data Buffer I/O Operations, Up: Manipulating Data Buffers 6.3.2 Data Buffer Meta-Data --------------------------- @@ -1930,6 +1931,61 @@ File: gpgme.info, Node: Data Buffer Meta-Data, Prev: Data Buffer I/O Operation data object with the handle DH to ENC. +File: gpgme.info, Node: Data Buffer Convenience, Prev: Data Buffer Meta-Data, Up: Manipulating Data Buffers + +6.3.3 Data Buffer Convenience Functions +--------------------------------------- + + -- Data type: enum gpgme_data_type_t + The `gpgme_data_type_t' type is used to return the detected type + of the content of a data buffer. + +`GPGME_DATA_TYPE_INVALID' + This is returned by `gpgme_data_identify' if it was not possible + to identify the data. Reasons for this might be a non-seekable + stream or a memory problem. The value is 0. + +`GPGME_DATA_TYPE_UNKNOWN' + The type of the data is not known. + +`GPGME_DATA_TYPE_PGP_SIGNED' + The data is an OpenPGP signed message. This may be a binary + signature, a detached one or a cleartext signature. + +`GPGME_DATA_TYPE_PGP_OTHER' + This is a generic OpenPGP message. In most cases this will be + encrypted data. + +`GPGME_DATA_TYPE_PGP_KEY' + This is an OpenPGP key (private or public). + +`GPGME_DATA_TYPE_CMS_SIGNED' + This is a CMS signed message. + +`GPGME_DATA_TYPE_CMS_ENCRYPTED' + This is a CMS encrypted (enveloped data) message. + +`GPGME_DATA_TYPE_CMS_OTHER' + This is used for other CMS message types. + +`GPGME_DATA_TYPE_X509_CERT' + The data is a X.509 certificate + +`GPGME_DATA_TYPE_PKCS12' + The data is a PKCS#12 message. This is commonly used to exchange + private keys for X.509. + + -- Function: gpgme_data_type_t gpgme_data_identify (gpgme_data_t DH) + The function `gpgme_data_identify' returns the type of the data + with the handle DH. If it is not possible to perform the + identification, the function returns zero + (`GPGME_DATA_TYPE_INVALID'). Note that depending on how the data + object has been created the identification may not be possible or + the data object may change its internal state (file pointer + moved). For file or memory based data object, the state should + not change. + + File: gpgme.info, Node: Contexts, Next: UI Server Protocol, Prev: Exchanging Data, Up: Top 7 Contexts @@ -4570,6 +4626,10 @@ File: gpgme.info, Node: Selecting Signers, Next: Creating a Signature, Up: Si Calling this function acquires an additional reference for the key. + -- Function: unsigned int gpgme_signers_count (const gpgme_ctx_t CTX) + The function `gpgme_signers_count' returns the number of signer + keys in the context CTX. + -- Function: gpgme_key_t gpgme_signers_enum (const gpgme_ctx_t CTX, int SEQ) The function `gpgme_signers_enum' returns the SEQth key in the @@ -4767,9 +4827,9 @@ File: gpgme.info, Node: Encrypting a Plaintext, Up: Encrypt encoding specified for CIPHER) and the text mode attributes set for the context CTX. - KEY must be a `NULL'-terminated array of keys. The user must keep - references for all keys during the whole duration of the call (but - see `gpgme_op_encrypt_start' for the requirements with the + RECP must be a `NULL'-terminated array of keys. The user must + keep references for all keys during the whole duration of the call + (but see `gpgme_op_encrypt_start' for the requirements with the asynchronous variant). The value in FLAGS is a bitwise-or combination of one or multiple @@ -5644,10 +5704,11 @@ commands are to be used: implement the `GETINFO pid' command. Sending this command a second time replaces the file descriptor set by the last one. - -- Command: OUTPUT FD=N + -- Command: OUTPUT FD=N [-binary] Set the file descriptor to be used for the output (i.e. the - encrypted message) to N. For OpenPGP, the output needs to be - ASCII armored; for CMS, the output needs to be Base-64 encoded. + encrypted message) to N. If the option `--binary' is given the + output shall be in binary format; if not given, the output for + OpenPGP needs to be ASCII armored and for CMS Base-64 encoded. For details on the file descriptor, see the `INPUT' command. The setting of the recipients, the data source and destination may @@ -5748,11 +5809,12 @@ output file descriptors: file descriptor, see the description of `INPUT' in the `ENCRYPT' section. - -- Command: OUTPUT FD=N + -- Command: OUTPUT FD=N [-binary] Set the file descriptor to be used for the output. The output is either the complete signed message or in case of a detached - signature just that detached signature. For OpenPGP, the output - needs to be ASCII armored; for CMS, the output needs to be Base-64 + signature just that detached signature. If the option `--binary' + is given the output shall be in binary format; if not given, the + output for OpenPGP needs to be ASCII armored and for CMS Base-64 encoded. For details on the file descriptor, see the `INPUT' command. |