diff options
Diffstat (limited to 'doc/gpgme.info-2')
| -rw-r--r-- | doc/gpgme.info-2 | 92 |
1 files changed, 78 insertions, 14 deletions
diff --git a/doc/gpgme.info-2 b/doc/gpgme.info-2 index 541764b..90274af 100644 --- a/doc/gpgme.info-2 +++ b/doc/gpgme.info-2 @@ -1,6 +1,6 @@ This is gpgme.info, produced by makeinfo version 6.3 from gpgme.texi. -Copyright © 2002–2008, 2010, 2012–2017 g10 Code GmbH. +Copyright © 2002–2008, 2010, 2012–2018 g10 Code GmbH. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License as @@ -19,10 +19,10 @@ END-INFO-DIR-ENTRY This file documents the GPGME library. - This is Edition 1.11.1-beta7, last updated 20 April 2018, of ‘The -‘GnuPG Made Easy’ Reference Manual’, for Version 1.11.1-beta7. + This is Edition 1.11.2-beta291, last updated 30 September 2018, of +‘The ‘GnuPG Made Easy’ Reference Manual’, for Version 1.11.2-beta291. - Copyright © 2002–2008, 2010, 2012–2017 g10 Code GmbH. + Copyright © 2002–2008, 2010, 2012–2018 g10 Code GmbH. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License as @@ -36,6 +36,64 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. +File: gpgme.info, Node: UI Server Set Input Files, Next: UI Server Sign/Encrypt Files, Prev: UI Server Verify, Up: UI Server Protocol + +A.5 UI Server: Specifying the input files to operate on. +======================================================== + +All file related UI server commands operate on a number of input files +or directories, specified by one or more ‘FILE’ commands: + + -- Command: FILE [--clear] NAME + Add the file or directory NAME to the list of pathnames to be + processed by the server. The parameter NAME must be an absolute + path name (including the drive letter) and is percent espaced (in + particular, the characters %, = and white space characters are + always escaped). If the option ‘--clear’ is given, the list of + files is cleared before adding NAME. + + Historical note: The original spec did not define ‘--clear’ but the + keyword ‘--continued’ after the file name to indicate that more + files are to be expected. However, this has never been used and + thus removed from the specs. + + +File: gpgme.info, Node: UI Server Sign/Encrypt Files, Next: UI Server Verify/Decrypt Files, Prev: UI Server Set Input Files, Up: UI Server Protocol + +A.6 UI Server: Encrypting and signing files. +============================================ + +First, the input files need to be specified by one or more ‘FILE’ +commands. Afterwards, the actual operation is requested: + + -- Command: ENCRYPT_FILES --nohup + -- Command: SIGN_FILES --nohup + -- Command: ENCRYPT_SIGN_FILES --nohup + Request that the files specified by ‘FILE’ are encrypted and/or + signed. The command selects the default action. The UI server may + allow the user to change this default afterwards interactively, and + even abort the operation or complete it only on some of the + selected files and directories. + + What it means to encrypt or sign a file or directory is specific to + the preferences of the user, the functionality the UI server + provides, and the selected protocol. Typically, for each input + file a new file is created under the original filename plus a + protocol specific extension (like ‘.gpg’ or ‘.sig’), which contain + the encrypted/signed file or a detached signature. For + directories, the server may offer multiple options to the user (for + example ignore or process recursively). + + The ‘ENCRYPT_SIGN_FILES’ command requests a combined sign and + encrypt operation. It may not be available for all protocols (for + example, it is available for OpenPGP but not for CMS). + + The option ‘--nohup’ is mandatory. It is currently unspecified + what should happen if ‘--nohup’ is not present. Because ‘--nohup’ + is present, the server always returns ‘OK’ promptly, and completes + the operation asynchronously. + + File: gpgme.info, Node: UI Server Verify/Decrypt Files, Next: UI Server Import/Export Keys, Prev: UI Server Sign/Encrypt Files, Up: UI Server Protocol A.7 UI Server: Decrypting and verifying files. @@ -2164,6 +2222,8 @@ Concept Index * ASSUAN: Assuan. (line 6) * attributes, of a key: Information About Keys. (line 6) +* auditlog: Additional Logs. (line 6) +* auditlog, of the engine: Additional Logs. (line 6) * autoconf: Using Automake. (line 6) * automake: Using Automake. (line 6) * backend: Protocols and Engines. (line 6) @@ -2429,6 +2489,8 @@ Function and Data Index (line 12) * gpgme_data_new_from_cbs: Callback Based Data Buffers. (line 80) +* gpgme_data_new_from_estream: File Based Data Buffers. + (line 49) * gpgme_data_new_from_fd: File Based Data Buffers. (line 10) * gpgme_data_new_from_file: Memory Based Data Buffers. @@ -2516,7 +2578,7 @@ Function and Data Index * gpgme_genkey_result_t: Generating Keys. (line 381) * gpgme_get_armor: ASCII Armor. (line 13) * gpgme_get_ctx_flag: Status Message Callback. - (line 122) + (line 141) * gpgme_get_dirinfo: Engine Version Check. (line 6) * gpgme_get_engine_info: Engine Information. (line 46) @@ -2525,7 +2587,7 @@ Function and Data Index * gpgme_get_io_cbs: Registering I/O Callbacks. (line 44) * gpgme_get_key: Listing Keys. (line 178) -* gpgme_get_keylist_mode: Key Listing Mode. (line 88) +* gpgme_get_keylist_mode: Key Listing Mode. (line 95) * gpgme_get_offline: Offline Mode. (line 31) * gpgme_get_passphrase_cb: Passphrase Callback. (line 63) * gpgme_get_pinentry_mode: Pinentry Mode. (line 18) @@ -2591,7 +2653,7 @@ Function and Data Index * gpgme_op_decrypt: Decrypt. (line 6) * gpgme_op_decrypt_ext: Decrypt. (line 30) * gpgme_op_decrypt_ext_start: Decrypt. (line 60) -* gpgme_op_decrypt_result: Decrypt. (line 151) +* gpgme_op_decrypt_result: Decrypt. (line 164) * gpgme_op_decrypt_start: Decrypt. (line 20) * gpgme_op_decrypt_verify: Decrypt and Verify. (line 6) * gpgme_op_decrypt_verify_start: Decrypt and Verify. (line 30) @@ -2621,15 +2683,17 @@ Function and Data Index (line 274) * gpgme_op_encrypt_start: Encrypting a Plaintext. (line 113) -* gpgme_op_export: Exporting Keys. (line 46) -* gpgme_op_export_ext: Exporting Keys. (line 79) -* gpgme_op_export_ext_start: Exporting Keys. (line 101) -* gpgme_op_export_keys: Exporting Keys. (line 113) -* gpgme_op_export_keys_start: Exporting Keys. (line 140) -* gpgme_op_export_start: Exporting Keys. (line 67) +* gpgme_op_export: Exporting Keys. (line 50) +* gpgme_op_export_ext: Exporting Keys. (line 83) +* gpgme_op_export_ext_start: Exporting Keys. (line 105) +* gpgme_op_export_keys: Exporting Keys. (line 117) +* gpgme_op_export_keys_start: Exporting Keys. (line 144) +* gpgme_op_export_start: Exporting Keys. (line 71) * gpgme_op_genkey: Generating Keys. (line 304) * gpgme_op_genkey_result: Generating Keys. (line 418) * gpgme_op_genkey_start: Generating Keys. (line 369) +* gpgme_op_getauditlog: Additional Logs. (line 9) +* gpgme_op_getauditlog_start: Additional Logs. (line 54) * gpgme_op_import: Importing Keys. (line 9) * gpgme_op_import_ext: Deprecated Functions. (line 22) @@ -2677,7 +2741,7 @@ Function and Data Index * gpgme_op_trustlist_next: Listing Trust Items. (line 27) * gpgme_op_trustlist_start: Listing Trust Items. (line 6) * gpgme_op_verify: Verify. (line 6) -* gpgme_op_verify_result: Verify. (line 283) +* gpgme_op_verify_result: Verify. (line 290) * gpgme_op_verify_start: Verify. (line 26) * gpgme_passphrase_cb_t: Passphrase Callback. (line 10) * gpgme_pinentry_mode_t: Pinentry Mode. (line 26) |