Release 1.3.2.

[gpgme.git] / doc / uiserver.texi

diff --git a/doc/uiserver.texi b/doc/uiserver.texi
index 14a249a16229431f348e86cce3879a2ff3deb651..f3cd8ade26787d3ef1992bebb40b9fa7a05a30aa 100644 (file)
--- a/doc/uiserver.texi
+++ b/doc/uiserver.texi
@@ -118,10 +118,10 @@ Use the CMS (PKCS#7) protocol (RFC-3852).
 To support automagically selection of the protocol depending on the
 selected keys, the server MAY implement the command:
 
-@deffn Command PREP_ENCRYPT [-@w{}-protocol=@var{name}]
+@deffn Command PREP_ENCRYPT [-@w{}-protocol=@var{name}] [-@w{}-expect-sign]
 
 This commands considers all recipients set so far and decides whether it
-is able to take input and start the actual decryption.  This is kind of
+is able to take input and start the actual encryption.  This is kind of
 a dry-run @command{ENCRYPT} without requiring or using the input and
 output file descriptors.  The server shall cache the result of any user
 selection to avoid asking this again when the actual @command{ENCRYPT}
@@ -129,8 +129,15 @@ command is send.  The @option{--protocol} option is optional; if it is
 not given, the server should allow the user to select the protocol to be
 used based on the recipients given or by any other means.
 
+If @option{--expect-sign} is given the server should expect that the
+message will also be signed and use this hint to present a unified
+recipient and signer selection dialog if possible and desired.  A
+selected signer should then be cached for the expected SIGN command
+(which is expected in the same session but possible on another
+connection).
+
 If this command is given again before a successful @command{ENCRYPT}
-command, the second one takes effect. 
+command, the second one takes effect.
 
 Before sending the OK response the server shall tell the client the
 protocol to be used (either the one given by the argument or the one
@@ -568,7 +575,7 @@ fully brought up).
 When doing an operation on a mail, it is useful to let the server know
 the address of the sender:
 
-@deffn Command SENDER [-@w{}-info] @var{email}
+@deffn Command SENDER [-@w{}-info] [-@w{}-protocol=@var{name}] @var{email}
 @var{email} is the plain ASCII encoded address ("addr-spec" as per
 RFC-2822) enclosed in angle brackets.  The address set with this command
 is valid until a successful completion of the operation or until a
@@ -580,6 +587,9 @@ If option @option{--info} is not given, the server shall also suggest a
 protocol to use for signing.  The client may use this suggested protocol
 on its own discretion.  The same status line as with PREP_ENCRYPT is
 used for this.
+
+The option @option{--protocol} may be used to give the server a hint on
+which signing protocol should be preferred.
 @end deffn
 
 @noindent