Add docstring.

diff --git a/epg.el b/epg.el
index b2ac8f1..fb1f183 100644 (file)
--- a/epg.el
+++ b/epg.el
@@ -896,7 +896,11 @@ This function is for internal use only."
   (let ((args (append (list "--with-colons" "--no-greeting" "--batch"
                            "--with-fingerprint"
                            "--with-fingerprint"
   (let ((args (append (list "--with-colons" "--no-greeting" "--batch"
                            "--with-fingerprint"
                            "--with-fingerprint"

-                           (if mode "--list-secret-keys" "--list-keys"))
+                           (if (or (eq mode t) (eq mode 'secret))
+                               "--list-secret-keys"
+                             (if mode
+                                 "--list-sigs"
+                               "--list-keys")))

                      (unless (eq (epg-context-protocol context) 'CMS)
                        '("--fixed-list-mode"))
                      (if name (list name))))
                      (unless (eq (epg-context-protocol context) 'CMS)
                        '("--fixed-list-mode"))
                      (if name (list name))))

@@ -935,6 +939,11 @@ This function is for internal use only."
    (aref line 6)))
 
 (defun epg-list-keys (context &optional name mode)
    (aref line 6)))
 
 (defun epg-list-keys (context &optional name mode)

+  "Return a list of epg-key objects matched with NAME.
+If MODE is nil, only public keyring should be searched.
+If MODE is t or 'secret, only secret keyring should be searched. 
+Otherwise, only public keyring should be searched and the key
+signatures should be included."

   (let ((lines (epg-list-keys-1 context name mode))
        keys cert)
     (while lines
   (let ((lines (epg-list-keys-1 context name mode))
        keys cert)
     (while lines