From 26b59d78c43d72fa28609fb2c0d80fb377393127 Mon Sep 17 00:00:00 2001 From: Ben Kibbey Date: Tue, 3 Apr 2012 20:53:19 -0400 Subject: [PATCH] Document CLEAR_PASSPHRASE. And describe the --mode=normal option. --- doc/gpg-agent.texi | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) 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] +@end ifset +@ifclear gpgtwoone + CLEAR_PASSPHRASE +@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