← Back to branch summary

~noskcaj/ubuntu/trusty/gpgme1.0/1.4.3

« back to all changes in this revision

Viewing changes to doc/uiserver.texi

  • Committer: Jackson Doak
  • Date: 2013-10-23 07:02:39 UTC
  • mfrom: (13.1.1 sid)
  • Revision ID: noskcaj@ubuntu.com-20131023070239-bbtonk3q5jdsnamr
http://bugs.debian.org/712813
* Merge from debian unstable. Remaining changes:
  - debian/rules: Switch back to using /usr/bin/gpg and add back gnupg build
    dependency, as we don't install gnupg2 by default. This was missing in the
    previous upload, and unbreaks nautilus-dropbox, seahorse, bzr, and other
    libgpgme consumers.
  - debian/control: Depends on "gnupg | gnupg2" rather than gnupg2,
    default to the old version since the new one depends on gpg-agent, 
    pinentry-gtk2, and a bunch of other packages we don't need/want in the
    default installation
* NMU
* New upstream release.
* debian/control (Build-Depends): Dropped dirmngr (closes: #712813). It is
  not necessary for the build.
  (Vcs-Browser, Vcs-Svn): Fixed vcs-field-not-canonical.
* debian/libgpgme11.symbols: Updated symbols file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/uiserver.texi
61
61
 
62
62
@deffn Command INPUT FD=@var{n}
63
63
Set the file descriptor for the message to be encrypted to @var{n}.  The
64
 
message send to the server is binary encoded. 
 
64
message send to the server is binary encoded.
65
65
 
66
66
GpgOL is a Windows only program, thus @var{n} is not a libc file
67
67
descriptor but a regular system handle.  Given that the Assuan
77
77
@c %Libassuan manual}, on how to do descriptor passing.
78
78
@end deffn
79
79
 
80
 
@deffn Command OUTPUT FD=@var{n}
 
80
@deffn Command OUTPUT FD=@var{n} [--binary]
81
81
Set the file descriptor to be used for the output (i.e. the encrypted
82
 
message) to @var{n}.  For OpenPGP, the output needs to be ASCII armored;
83
 
for CMS, the output needs to be Base-64 encoded.  For details on the
84
 
file descriptor, see the @code{INPUT} command.
 
82
message) to @var{n}.  If the option @code{--binary} is given the
 
83
output shall be in binary format; if not given, the output for OpenPGP
 
84
needs to be ASCII armored and for CMS Base-64 encoded.  For details on
 
85
the file descriptor, see the @code{INPUT} command.
85
86
@end deffn
86
87
 
87
 
@noindent  
 
88
@noindent
88
89
The setting of the recipients, the data source and destination may
89
90
happen in any order, even intermixed.  If this has been done the actual
90
91
encryption operation is called using:
193
194
section.
194
195
@end deffn
195
196
 
196
 
@deffn Command OUTPUT FD=@var{n}
197
 
Set the file descriptor to be used for the output.  The output is either
198
 
the complete signed message or in case of a detached signature just that
199
 
detached signature.  For OpenPGP, the output needs to be ASCII armored;
200
 
for CMS, the output needs to be Base-64 encoded.  For details on the
201
 
file descriptor, see the @code{INPUT} command.
 
197
@deffn Command OUTPUT FD=@var{n} [--binary]
 
198
Set the file descriptor to be used for the output.  The output is
 
199
either the complete signed message or in case of a detached signature
 
200
just that detached signature.  If the option @code{--binary} is given
 
201
the output shall be in binary format; if not given, the output for
 
202
OpenPGP needs to be ASCII armored and for CMS Base-64 encoded.  For
 
203
details on the file descriptor, see the @code{INPUT} command.
202
204
@end deffn
203
205
 
204
206
@noindent
209
211
@noindent
210
212
The signing operation is then initiated by:
211
213
 
212
 
@deffn Command SIGN -@w{}-protocol=@var{name} [-@w{}-detached] 
 
214
@deffn Command SIGN -@w{}-protocol=@var{name} [-@w{}-detached]
213
215
Sign the data set with the @code{INPUT} command and write it to the sink
214
216
set by OUTPUT.  @var{name} is the signing protocol used for the
215
217
message. For a description of the allowed protocols see the
272
274
 
273
275
The server needs to support the verification of opaque signatures as
274
276
well as detached signatures.  The kind of input sources controls what
275
 
kind message is to be verified. 
 
277
kind message is to be verified.
276
278
 
277
279
@deffn Command MESSAGE FD=@var{n}
278
280
This command is used with detached signatures to set the file descriptor
309
311
@table @asis
310
312
@item MESSAGE and INPUT
311
313
This indicates a detached signature.  Output data is not applicable.
312
 
@item INPUT 
 
314
@item INPUT
313
315
This indicates an opaque signature.  As no output command has been given,
314
316
the server is only required to check the signature.
315
317
@item INPUT and OUTPUT
338
340
The signature is valid but additional information was shown regarding the
339
341
validity of the key.
340
342
@item red
341
 
The signature is not valid. 
 
343
The signature is not valid.
342
344
@end table
343
345
 
344
346
@var{displaystring} is a percent-and-plus-encoded string with a short
539
541
To allow the server to pop up the windows in the correct relation to the
540
542
client, the client is advised to tell the server by sending the option:
541
543
 
542
 
@deffn {Command option} window-id @var{number} 
 
544
@deffn {Command option} window-id @var{number}
543
545
The @var{number} represents the native window ID of the clients current
544
546
window.  On Windows systems this is a windows handle (@code{HWND}) and
545
547
on X11 systems it is the @code{X Window ID}.  The number needs to be
592
594
which signing protocol should be preferred.
593
595
@end deffn
594
596
 
595
 
@noindent 
 
597
@noindent
596
598
To allow the UI-server to visually identify a running operation or to
597
599
associate operations the server MAY support the command:
598
600