diff options
author | JinWang An <jinwang.an@samsung.com> | 2021-12-01 16:54:34 +0900 |
---|---|---|
committer | JinWang An <jinwang.an@samsung.com> | 2021-12-01 16:54:34 +0900 |
commit | 4db435874bc286631d5dc726f68ba5bb86a1bb89 (patch) | |
tree | 272c0eda6487854588390073f08ce293a82560f0 /doc | |
parent | 670d9afb902f264b6410d307c429f02ed8685fd3 (diff) | |
download | gpgme-4db435874bc286631d5dc726f68ba5bb86a1bb89.tar.gz gpgme-4db435874bc286631d5dc726f68ba5bb86a1bb89.tar.bz2 gpgme-4db435874bc286631d5dc726f68ba5bb86a1bb89.zip |
Imported Upstream version 1.4.3upstream/1.4.3
Diffstat (limited to 'doc')
-rw-r--r-- | doc/gpgme.info | 223 | ||||
-rw-r--r-- | doc/gpgme.info-1 | 90 | ||||
-rw-r--r-- | doc/gpgme.info-2 | 29 | ||||
-rw-r--r-- | doc/gpgme.texi | 58 | ||||
-rw-r--r-- | doc/stamp-vti | 8 | ||||
-rw-r--r-- | doc/uiserver.texi | 38 | ||||
-rw-r--r-- | doc/version.texi | 8 |
7 files changed, 294 insertions, 160 deletions
diff --git a/doc/gpgme.info b/doc/gpgme.info index 5ac6f47..59dd85c 100644 --- a/doc/gpgme.info +++ b/doc/gpgme.info @@ -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. @@ -41,117 +41,118 @@ General Public License for more details. Indirect: -gpgme.info-1: 1756 -gpgme.info-2: 281093 +gpgme.info-1: 1758 +gpgme.info-2: 283468 Tag Table: (Indirect) -Node: Top1756 -Node: Introduction8595 -Node: Getting Started9382 -Node: Features10507 -Node: Overview11657 -Node: Preparation12766 -Node: Header13763 -Node: Building the Source14462 -Node: Largefile Support (LFS)16571 -Node: Using Automake21882 -Node: Using Libtool23518 -Node: Library Version Check23868 -Node: Signal Handling27823 -Node: Multi Threading29039 -Ref: Multi Threading-Footnote-131221 -Node: Protocols and Engines31635 -Node: Engine Version Check33984 -Node: Engine Information34561 -Node: Engine Configuration38261 -Node: OpenPGP39523 -Node: Cryptographic Message Syntax39859 -Node: Algorithms40153 -Ref: Algorithms-Footnote-140632 -Node: Public Key Algorithms40760 -Node: Hash Algorithms42691 -Node: Error Handling43789 -Node: Error Values45651 -Node: Error Sources50729 -Node: Error Codes53056 -Node: Error Strings57695 -Node: Exchanging Data59474 -Node: Creating Data Buffers61303 -Node: Memory Based Data Buffers61819 -Node: File Based Data Buffers65173 -Node: Callback Based Data Buffers67344 -Node: Destroying Data Buffers72900 -Node: Manipulating Data Buffers74259 -Node: Data Buffer I/O Operations74678 -Node: Data Buffer Meta-Data77381 -Node: Contexts80731 -Node: Creating Contexts81854 -Node: Destroying Contexts82665 -Node: Result Management83000 -Node: Context Attributes84406 -Node: Protocol Selection85184 -Node: Crypto Engine86196 -Node: ASCII Armor88017 -Node: Text Mode88629 -Node: Included Certificates89560 -Node: Key Listing Mode90935 -Node: Passphrase Callback94292 -Node: Progress Meter Callback97430 -Node: Locale99354 -Node: Key Management100893 -Node: Listing Keys110818 -Node: Information About Keys118080 -Node: Key Signatures126078 -Node: Manipulating Keys130090 -Node: Generating Keys130932 -Node: Exporting Keys135539 -Node: Importing Keys141438 -Ref: Importing Keys-Footnote-1148601 -Node: Deleting Keys148729 -Node: Changing Passphrases150126 -Node: Advanced Key Editing151387 -Node: Trust Item Management154491 -Node: Listing Trust Items155561 -Node: Information About Trust Items157859 -Node: Manipulating Trust Items159741 -Node: Crypto Operations160702 -Node: Decrypt161946 -Node: Verify165804 -Node: Decrypt and Verify183660 -Node: Sign185664 -Node: Selecting Signers186228 -Node: Creating a Signature187209 -Node: Signature Notation Data191798 -Node: Encrypt193982 -Node: Encrypting a Plaintext194338 -Node: Run Control200183 -Node: Waiting For Completion200930 -Node: Using External Event Loops202976 -Node: I/O Callback Interface204943 -Node: Registering I/O Callbacks210037 -Node: I/O Callback Example212028 -Node: I/O Callback Example GTK+218247 -Node: I/O Callback Example GDK220036 -Node: I/O Callback Example Qt221678 -Node: Cancellation223966 -Node: UI Server Protocol226219 -Ref: UI Server Protocol-Footnote-1227650 -Node: UI Server Encrypt227769 -Node: UI Server Sign232950 -Node: UI Server Decrypt235179 -Node: UI Server Verify236617 -Node: UI Server Set Input Files240119 -Node: UI Server Sign/Encrypt Files240919 -Node: UI Server Verify/Decrypt Files242688 -Node: UI Server Import/Export Keys244534 -Node: UI Server Checksum Files245567 -Node: Miscellaneous UI Server Commands247733 -Ref: command SENDER249645 -Node: Debugging251321 -Node: Library Copying252976 -Node: Copying281093 -Node: Function and Data Index318724 -Node: Concept Index343986 +Node: Top1758 +Node: Introduction8599 +Node: Getting Started9386 +Node: Features10511 +Node: Overview11661 +Node: Preparation12770 +Node: Header13767 +Node: Building the Source14466 +Node: Largefile Support (LFS)16575 +Node: Using Automake21886 +Node: Using Libtool23522 +Node: Library Version Check23872 +Node: Signal Handling27827 +Node: Multi Threading29043 +Ref: Multi Threading-Footnote-131225 +Node: Protocols and Engines31639 +Node: Engine Version Check33988 +Node: Engine Information34565 +Node: Engine Configuration38265 +Node: OpenPGP39527 +Node: Cryptographic Message Syntax39863 +Node: Algorithms40157 +Ref: Algorithms-Footnote-140636 +Node: Public Key Algorithms40764 +Node: Hash Algorithms42695 +Node: Error Handling43793 +Node: Error Values45655 +Node: Error Sources50733 +Node: Error Codes53060 +Node: Error Strings57699 +Node: Exchanging Data59478 +Node: Creating Data Buffers61307 +Node: Memory Based Data Buffers61823 +Node: File Based Data Buffers65177 +Node: Callback Based Data Buffers67348 +Node: Destroying Data Buffers72904 +Node: Manipulating Data Buffers74263 +Node: Data Buffer I/O Operations74755 +Node: Data Buffer Meta-Data77458 +Node: Data Buffer Convenience80840 +Node: Contexts82776 +Node: Creating Contexts83899 +Node: Destroying Contexts84710 +Node: Result Management85045 +Node: Context Attributes86451 +Node: Protocol Selection87229 +Node: Crypto Engine88241 +Node: ASCII Armor90062 +Node: Text Mode90674 +Node: Included Certificates91605 +Node: Key Listing Mode92980 +Node: Passphrase Callback96337 +Node: Progress Meter Callback99475 +Node: Locale101399 +Node: Key Management102938 +Node: Listing Keys112863 +Node: Information About Keys120125 +Node: Key Signatures128123 +Node: Manipulating Keys132135 +Node: Generating Keys132977 +Node: Exporting Keys137584 +Node: Importing Keys143483 +Ref: Importing Keys-Footnote-1150646 +Node: Deleting Keys150774 +Node: Changing Passphrases152171 +Node: Advanced Key Editing153432 +Node: Trust Item Management156536 +Node: Listing Trust Items157606 +Node: Information About Trust Items159904 +Node: Manipulating Trust Items161786 +Node: Crypto Operations162747 +Node: Decrypt163991 +Node: Verify167849 +Node: Decrypt and Verify185705 +Node: Sign187709 +Node: Selecting Signers188273 +Node: Creating a Signature189425 +Node: Signature Notation Data194014 +Node: Encrypt196198 +Node: Encrypting a Plaintext196554 +Node: Run Control202400 +Node: Waiting For Completion203147 +Node: Using External Event Loops205193 +Node: I/O Callback Interface207160 +Node: Registering I/O Callbacks212254 +Node: I/O Callback Example214245 +Node: I/O Callback Example GTK+220464 +Node: I/O Callback Example GDK222253 +Node: I/O Callback Example Qt223895 +Node: Cancellation226183 +Node: UI Server Protocol228436 +Ref: UI Server Protocol-Footnote-1229867 +Node: UI Server Encrypt229986 +Node: UI Server Sign235246 +Node: UI Server Decrypt237554 +Node: UI Server Verify238992 +Node: UI Server Set Input Files242494 +Node: UI Server Sign/Encrypt Files243294 +Node: UI Server Verify/Decrypt Files245063 +Node: UI Server Import/Export Keys246909 +Node: UI Server Checksum Files247942 +Node: Miscellaneous UI Server Commands250108 +Ref: command SENDER252020 +Node: Debugging253696 +Node: Library Copying255351 +Node: Copying283468 +Node: Function and Data Index321099 +Node: Concept Index346851 End Tag Table 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. diff --git a/doc/gpgme.info-2 b/doc/gpgme.info-2 index 287304f..984300d 100644 --- a/doc/gpgme.info-2 +++ b/doc/gpgme.info-2 @@ -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. @@ -778,13 +778,15 @@ Function and Data Index (line 10) * DECRYPT_VERIFY_FILES: UI Server Verify/Decrypt Files. (line 12) -* ENCRYPT: UI Server Encrypt. (line 46) +* ENCRYPT: UI Server Encrypt. (line 47) * ENCRYPT_FILES: UI Server Sign/Encrypt Files. (line 10) * ENCRYPT_SIGN_FILES: UI Server Sign/Encrypt Files. (line 12) * enum gpgme_data_encoding_t: Data Buffer Meta-Data. (line 28) +* enum gpgme_data_type_t: Data Buffer Convenience. + (line 7) * enum gpgme_event_io_t: I/O Callback Interface. (line 57) * enum gpgme_hash_algo_t: Hash Algorithms. (line 10) @@ -815,6 +817,8 @@ Function and Data Index (line 69) * gpgme_data_get_file_name: Data Buffer Meta-Data. (line 7) +* gpgme_data_identify: Data Buffer Convenience. + (line 46) * gpgme_data_new: Memory Based Data Buffers. (line 13) * gpgme_data_new_from_cbs: Callback Based Data Buffers. @@ -852,6 +856,8 @@ Function and Data Index * gpgme_data_set_file_name: Data Buffer Meta-Data. (line 18) * gpgme_data_t: Exchanging Data. (line 14) +* gpgme_data_type_t: Data Buffer Convenience. + (line 7) * gpgme_data_write: Data Buffer I/O Operations. (line 18) * gpgme_data_write_cb_t: Callback Based Data Buffers. @@ -1039,7 +1045,8 @@ Function and Data Index * gpgme_signature_t: Verify. (line 92) * gpgme_signers_add: Selecting Signers. (line 15) * gpgme_signers_clear: Selecting Signers. (line 7) -* gpgme_signers_enum: Selecting Signers. (line 22) +* gpgme_signers_count: Selecting Signers. (line 21) +* gpgme_signers_enum: Selecting Signers. (line 26) * gpgme_ssize_t: Exchanging Data. (line 31) * gpgme_strerror: Error Strings. (line 7) * gpgme_strerror_r: Error Strings. (line 17) @@ -1070,21 +1077,21 @@ Function and Data Index * INPUT <3>: UI Server Sign. (line 13) * INPUT: UI Server Encrypt. (line 23) * MESSAGE: UI Server Verify. (line 11) -* MICALG: UI Server Sign. (line 43) +* MICALG: UI Server Sign. (line 44) * off_t (*gpgme_data_seek_cb_t) (void *HANDLE, off_t OFFSET, int WHENCE): Callback Based Data Buffers. (line 44) * OUTPUT <1>: UI Server Verify. (line 24) * OUTPUT <2>: UI Server Decrypt. (line 20) * OUTPUT <3>: UI Server Sign. (line 19) * OUTPUT: UI Server Encrypt. (line 36) -* PREP_ENCRYPT: UI Server Encrypt. (line 72) -* PROTOCOL: UI Server Encrypt. (line 97) +* PREP_ENCRYPT: UI Server Encrypt. (line 73) +* PROTOCOL: UI Server Encrypt. (line 98) * RECIPIENT: UI Server Encrypt. (line 10) * SENDER: Miscellaneous UI Server Commands. (line 51) * SESSION: Miscellaneous UI Server Commands. (line 70) -* SIGN: UI Server Sign. (line 33) +* SIGN: UI Server Sign. (line 34) * SIGN_FILES: UI Server Sign/Encrypt Files. (line 11) * SIGSTATUS: UI Server Verify. (line 59) @@ -1174,6 +1181,8 @@ Concept Index * cryptographic operation, verification: Verify. (line 6) * cryptographic operation, wait for: Waiting For Completion. (line 6) +* data buffer, convenience: Data Buffer Convenience. + (line 6) * data buffer, creation: Creating Data Buffers. (line 6) * data buffer, destruction: Destroying Data Buffers. (line 6) @@ -1224,6 +1233,8 @@ Concept Index (line 6) * hash algorithms: Hash Algorithms. (line 6) * header file: Header. (line 6) +* identify: Data Buffer Convenience. + (line 6) * include file: Header. (line 6) * key listing: Listing Keys. (line 6) * key listing mode: Key Listing Mode. (line 6) @@ -1303,6 +1314,8 @@ Concept Index (line 6) * trust item, manipulation: Manipulating Trust Items. (line 6) +* type of data: Data Buffer Convenience. + (line 6) * UI server: UI Server Protocol. (line 6) * user interface server: UI Server Protocol. (line 6) * verification: Verify. (line 6) diff --git a/doc/gpgme.texi b/doc/gpgme.texi index 217dc13..4ec0bfe 100644 --- a/doc/gpgme.texi +++ b/doc/gpgme.texi @@ -1885,6 +1885,7 @@ be used to manipulate both. @menu * 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. @end menu @@ -2047,6 +2048,56 @@ The function @code{gpgme_data_set_encoding} changes the encoding of the data object with the handle @var{dh} to @var{enc}. @end deftypefun +@node Data Buffer Convenience +@subsection Data Buffer Convenience Functions +@cindex data buffer, convenience +@cindex type of data +@cindex identify + +@deftp {Data type} {enum gpgme_data_type_t} +@tindex gpgme_data_type_t +The @code{gpgme_data_type_t} type is used to return the detected type +of the content of a data buffer. +@end deftp + +@table @code +@item GPGME_DATA_TYPE_INVALID +This is returned by @code{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. +@item GPGME_DATA_TYPE_UNKNOWN +The type of the data is not known. +@item 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. +@item GPGME_DATA_TYPE_PGP_OTHER +This is a generic OpenPGP message. In most cases this will be +encrypted data. +@item GPGME_DATA_TYPE_PGP_KEY +This is an OpenPGP key (private or public). +@item GPGME_DATA_TYPE_CMS_SIGNED +This is a CMS signed message. +@item GPGME_DATA_TYPE_CMS_ENCRYPTED +This is a CMS encrypted (enveloped data) message. +@item GPGME_DATA_TYPE_CMS_OTHER +This is used for other CMS message types. +@item GPGME_DATA_TYPE_X509_CERT +The data is a X.509 certificate +@item GPGME_DATA_TYPE_PKCS12 +The data is a PKCS#12 message. This is commonly used to exchange +private keys for X.509. +@end table + +@deftypefun gpgme_data_type_t gpgme_data_identify (@w{gpgme_data_t @var{dh}}) +The function @code{gpgme_data_identify} returns the type of the data +with the handle @var{dh}. If it is not possible to perform the +identification, the function returns zero +(@code{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. +@end deftypefun + @c @c Chapter Contexts @@ -4785,6 +4836,11 @@ list of signers in the context @var{ctx}. Calling this function acquires an additional reference for the key. @end deftypefun +@deftypefun @w{unsigned int} gpgme_signers_count (@w{const gpgme_ctx_t @var{ctx}}) +The function @code{gpgme_signers_count} returns the number of signer keys in +the context @var{ctx}. +@end deftypefun + @deftypefun gpgme_key_t gpgme_signers_enum (@w{const gpgme_ctx_t @var{ctx}}, @w{int @var{seq}}) The function @code{gpgme_signers_enum} returns the @var{seq}th key in the list of signers in the context @var{ctx}. An additional reference @@ -4988,7 +5044,7 @@ ciphertext created is determined by the @acronym{ASCII} armor (or, if that is not set, by the encoding specified for @var{cipher}) and the text mode attributes set for the context @var{ctx}. -@var{key} must be a @code{NULL}-terminated array of keys. The user +@var{recp} must be a @code{NULL}-terminated array of keys. The user must keep references for all keys during the whole duration of the call (but see @code{gpgme_op_encrypt_start} for the requirements with the asynchronous variant). diff --git a/doc/stamp-vti b/doc/stamp-vti index 42d8cc5..639222e 100644 --- a/doc/stamp-vti +++ b/doc/stamp-vti @@ -1,4 +1,4 @@ -@set UPDATED 28 May 2013 -@set UPDATED-MONTH May 2013 -@set EDITION 1.4.2 -@set VERSION 1.4.2 +@set UPDATED 9 August 2013 +@set UPDATED-MONTH August 2013 +@set EDITION 1.4.3 +@set VERSION 1.4.3 diff --git a/doc/uiserver.texi b/doc/uiserver.texi index f3cd8ad..859ae02 100644 --- a/doc/uiserver.texi +++ b/doc/uiserver.texi @@ -61,7 +61,7 @@ commands are to be used: @deffn Command INPUT FD=@var{n} Set the file descriptor for the message to be encrypted to @var{n}. The -message send to the server is binary encoded. +message send to the server is binary encoded. GpgOL is a Windows only program, thus @var{n} is not a libc file descriptor but a regular system handle. Given that the Assuan @@ -77,14 +77,15 @@ time replaces the file descriptor set by the last one. @c %Libassuan manual}, on how to do descriptor passing. @end deffn -@deffn Command OUTPUT FD=@var{n} +@deffn Command OUTPUT FD=@var{n} [--binary] Set the file descriptor to be used for the output (i.e. the encrypted -message) to @var{n}. For OpenPGP, the output needs to be ASCII armored; -for CMS, the output needs to be Base-64 encoded. For details on the -file descriptor, see the @code{INPUT} command. +message) to @var{n}. If the option @code{--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 @code{INPUT} command. @end deffn -@noindent +@noindent The setting of the recipients, the data source and destination may happen in any order, even intermixed. If this has been done the actual encryption operation is called using: @@ -193,12 +194,13 @@ descriptor, see the description of @code{INPUT} in the @code{ENCRYPT} section. @end deffn -@deffn Command OUTPUT FD=@var{n} -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 encoded. For details on the -file descriptor, see the @code{INPUT} command. +@deffn Command OUTPUT FD=@var{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. If the option @code{--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 @code{INPUT} command. @end deffn @noindent @@ -209,7 +211,7 @@ SENDER}. @noindent The signing operation is then initiated by: -@deffn Command SIGN -@w{}-protocol=@var{name} [-@w{}-detached] +@deffn Command SIGN -@w{}-protocol=@var{name} [-@w{}-detached] Sign the data set with the @code{INPUT} command and write it to the sink set by OUTPUT. @var{name} is the signing protocol used for the message. For a description of the allowed protocols see the @@ -272,7 +274,7 @@ is an OpenPGP combined message. The server needs to support the verification of opaque signatures as well as detached signatures. The kind of input sources controls what -kind message is to be verified. +kind message is to be verified. @deffn Command MESSAGE FD=@var{n} This command is used with detached signatures to set the file descriptor @@ -309,7 +311,7 @@ to select the appropriate verification mode: @table @asis @item MESSAGE and INPUT This indicates a detached signature. Output data is not applicable. -@item INPUT +@item INPUT This indicates an opaque signature. As no output command has been given, the server is only required to check the signature. @item INPUT and OUTPUT @@ -338,7 +340,7 @@ The signature is fully valid. The signature is valid but additional information was shown regarding the validity of the key. @item red -The signature is not valid. +The signature is not valid. @end table @var{displaystring} is a percent-and-plus-encoded string with a short @@ -539,7 +541,7 @@ data line. To allow the server to pop up the windows in the correct relation to the client, the client is advised to tell the server by sending the option: -@deffn {Command option} window-id @var{number} +@deffn {Command option} window-id @var{number} The @var{number} represents the native window ID of the clients current window. On Windows systems this is a windows handle (@code{HWND}) and on X11 systems it is the @code{X Window ID}. The number needs to be @@ -592,7 +594,7 @@ The option @option{--protocol} may be used to give the server a hint on which signing protocol should be preferred. @end deffn -@noindent +@noindent To allow the UI-server to visually identify a running operation or to associate operations the server MAY support the command: diff --git a/doc/version.texi b/doc/version.texi index 42d8cc5..639222e 100644 --- a/doc/version.texi +++ b/doc/version.texi @@ -1,4 +1,4 @@ -@set UPDATED 28 May 2013 -@set UPDATED-MONTH May 2013 -@set EDITION 1.4.2 -@set VERSION 1.4.2 +@set UPDATED 9 August 2013 +@set UPDATED-MONTH August 2013 +@set EDITION 1.4.3 +@set VERSION 1.4.3 |