GpgFrontend/gpgme
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Clarify the FILE command.

Browse Source 
--
This commit is contained in:
Werner Koch 2014-11-19 10:34:32 +01:00
parent 8031341283
commit a9ae0d1428
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/uiserver.texi
View File

@ -226,7 +226,7 @@ before the final OK response:
@deffn {Status line} MICALG @var{string} @deffn {Status line} MICALG @var{string}
The @var{string} represents the hash algorithm used to create the The @var{string} represents the hash algorithm used to create the
signature. It is used with MOSS style signature messages and defined by signature. It is used with RFC-1847 style signature messages and defined by
PGP/MIME (RFC-3156) and S/MIME (RFC-3851). The GPGME library has a PGP/MIME (RFC-3156) and S/MIME (RFC-3851). The GPGME library has a
supporting function @code{gpgme_hash_algo_name} to return the algorithm supporting function @code{gpgme_hash_algo_name} to return the algorithm
name as a string. This string needs to be lowercased and for OpenPGP name as a string. This string needs to be lowercased and for OpenPGP
@ -368,13 +368,18 @@ message.
All file related UI server commands operate on a number of input files All file related UI server commands operate on a number of input files
or directories, specified by one or more @code{FILE} commands: or directories, specified by one or more @code{FILE} commands:
@deffn Command FILE @var{name} [--continued] @deffn Command FILE [--clear] @var{name}
Add the file or directory @var{name} to the list of pathnames to be Add the file or directory @var{name} to the list of pathnames to be
processed by the server. The parameter @var{name} must be an absolute processed by the server. The parameter @var{name} must be an absolute
path name (including the drive letter) and is percent espaced (in path name (including the drive letter) and is percent espaced (in
particular, the characters %, = and white space characters are always particular, the characters %, = and white space characters are always
escaped). The option @code{--continued} is present for all but the escaped). If the option @code{--clear} is given, the list of files is
last @code{FILE} command. cleared before adding @var{name}.
Historical note: The original spec did not define @code{--clear} but
the keyword @code{--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.
@end deffn @end deffn