aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndre Heinecke <[email protected]>2018-07-09 09:10:19 +0000
committerAndre Heinecke <[email protected]>2018-07-09 09:10:19 +0000
commit31bc51e2aff0a28b551410c9def2f578d0d28cea (patch)
tree363b618418a5cd077f6bf14b8fb83921b086b3e8
parentAdd ctx flag for auto-key-locate (diff)
downloadgpgme-31bc51e2aff0a28b551410c9def2f578d0d28cea.tar.gz
gpgme-31bc51e2aff0a28b551410c9def2f578d0d28cea.zip
doc: More explicit doc for EXTERN and LOCAL modes.
* 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.
Diffstat (limited to '')
-rw-r--r--doc/gpgme.texi10
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/gpgme.texi b/doc/gpgme.texi
index 6e328e69..38d34809 100644
--- a/doc/gpgme.texi
+++ b/doc/gpgme.texi
@@ -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
is the default.
+Using only this option results in a @code{--list-keys}.
+
@item GPGME_KEYLIST_MODE_EXTERN
The @code{GPGME_KEYLIST_MODE_EXTERN} symbol specifies that an external
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
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
This is a shortcut for the combination of
-@code{GPGME_KEYLIST_MODE_LOCAL} and @code{GPGME_KEYLIST_MODE_EXTERN}
-and convenient when the --locate-key feature of OpenPGP is desired.
+@code{GPGME_KEYLIST_MODE_LOCAL} and @code{GPGME_KEYLIST_MODE_EXTERN}, which
+results in a @code{--locate-keys} for @code{GPGME_PROTOCOL_OpenPGP}.
@item GPGME_KEYLIST_MODE_SIGS
The @code{GPGME_KEYLIST_MODE_SIGS} symbol specifies that the key