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

doc: More explicit doc for EXTERN and LOCAL modes.

Browse Source 
* doc/gpgme.texi (GPGME_KEYLIST_MODE_EXTERN),
(GPGME_KEYLIST_MODE_LOCATE, GPGME_KEYLIST_MODE_LOCAL): Mention
command line flags for CMS and OpenPGP Protocol.

--
This might help new users coming to gnupg to understand what
the flags do.
This commit is contained in:
Andre Heinecke 2018-07-09 11:10:19 +02:00
parent 7bc5d3c7e4
commit 31bc51e2af
No known key found for this signature in database
GPG Key ID: 2978E9D40CBABA5C
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/gpgme.texi
View File

@ -2763,6 +2763,8 @@ The @code{GPGME_KEYLIST_MODE_LOCAL} symbol specifies that the local
keyring should be searched for keys in the keylisting operation. This keyring should be searched for keys in the keylisting operation. This
is the default. is the default.
Using only this option results in a @code{--list-keys}.
@item GPGME_KEYLIST_MODE_EXTERN @item GPGME_KEYLIST_MODE_EXTERN
The @code{GPGME_KEYLIST_MODE_EXTERN} symbol specifies that an external The @code{GPGME_KEYLIST_MODE_EXTERN} symbol specifies that an external
source should be searched for keys in the keylisting operation. The source should be searched for keys in the keylisting operation. The
@ -2770,10 +2772,14 @@ type of external source is dependent on the crypto engine used and
whether it is combined with @code{GPGME_KEYLIST_MODE_LOCAL}. For whether it is combined with @code{GPGME_KEYLIST_MODE_LOCAL}. For
example, it can be a remote keyserver or LDAP certificate server. example, it can be a remote keyserver or LDAP certificate server.
Using only this option results in a @code{--search-keys} for
@code{GPGME_PROTOCOL_OpenPGP} and something similar to
@code{--list-external-keys} for @code{GPGME_PROTOCOL_CMS}.
@item GPGME_KEYLIST_MODE_LOCATE @item GPGME_KEYLIST_MODE_LOCATE
This is a shortcut for the combination of This is a shortcut for the combination of
@code{GPGME_KEYLIST_MODE_LOCAL} and @code{GPGME_KEYLIST_MODE_EXTERN} @code{GPGME_KEYLIST_MODE_LOCAL} and @code{GPGME_KEYLIST_MODE_EXTERN}, which
and convenient when the --locate-key feature of OpenPGP is desired. results in a @code{--locate-keys} for @code{GPGME_PROTOCOL_OpenPGP}.
@item GPGME_KEYLIST_MODE_SIGS @item GPGME_KEYLIST_MODE_SIGS
The @code{GPGME_KEYLIST_MODE_SIGS} symbol specifies that the key The @code{GPGME_KEYLIST_MODE_SIGS} symbol specifies that the key