aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBen Kibbey <[email protected]>2012-04-04 00:53:19 +0000
committerWerner Koch <[email protected]>2012-04-04 09:56:29 +0000
commit26b59d78c43d72fa28609fb2c0d80fb377393127 (patch)
tree7eb62c6d2c508f02426dd1540ecb62fcfc2bd629
parentFix timegm regression test. (diff)
downloadgnupg-26b59d78c43d72fa28609fb2c0d80fb377393127.tar.gz
gnupg-26b59d78c43d72fa28609fb2c0d80fb377393127.zip
Document CLEAR_PASSPHRASE.
And describe the --mode=normal option.
-rw-r--r--doc/gpg-agent.texi23
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/gpg-agent.texi b/doc/gpg-agent.texi
index 4c7f13f33..19f7c303f 100644
--- a/doc/gpg-agent.texi
+++ b/doc/gpg-agent.texi
@@ -804,6 +804,7 @@ secret keys.
* Agent EXPORT:: Exporting a Secret Key
* Agent ISTRUSTED:: Importing a Root Certificate
* Agent GET_PASSPHRASE:: Ask for a passphrase
+* Agent CLEAR_PASSPHRASE:: Expire a cached passphrase
* Agent GET_CONFIRMATION:: Ask for confirmation
* Agent HAVEKEY:: Check whether a key is available
* Agent LEARN:: Register a smartcard
@@ -1173,6 +1174,28 @@ may be used to invalidate the cache entry for a passphrase. The
function returns with OK even when there is no cached passphrase.
+
+@node Agent CLEAR_PASSPHRASE
+@subsection Remove a cached passphrase
+
+Use this command to remove a cached passphrase.
+
+@example
+@ifset gpgtwoone
+ CLEAR_PASSPHRASE [--mode=normal] <cache_id>
+@end ifset
+@ifclear gpgtwoone
+ CLEAR_PASSPHRASE <cache_id>
+@end ifclear
+@end example
+
+@ifset gpgtwoone
+The @option{--mode=normal} option can be used to clear a @var{cache_id} that
+was set by gpg-agent.
+@end ifset
+
+
+
@node Agent GET_CONFIRMATION
@subsection Ask for confirmation