aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBen Kibbey <[email protected]>2012-04-04 00:53:20 +0000
committerWerner Koch <[email protected]>2012-04-04 09:56:35 +0000
commit96e107fc29db625b247022ae1bf2cbe90b939c5d (patch)
tree41e41c5c7a5de2afaa5c11c7867e43fc44be652a
parentDocument CLEAR_PASSPHRASE. (diff)
downloadgnupg-96e107fc29db625b247022ae1bf2cbe90b939c5d.tar.gz
gnupg-96e107fc29db625b247022ae1bf2cbe90b939c5d.zip
Document PRESET_PASSPHRASE.
-rw-r--r--doc/gpg-agent.texi27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/gpg-agent.texi b/doc/gpg-agent.texi
index 19f7c303f..eb5b334f6 100644
--- a/doc/gpg-agent.texi
+++ b/doc/gpg-agent.texi
@@ -805,6 +805,9 @@ secret keys.
* Agent ISTRUSTED:: Importing a Root Certificate
* Agent GET_PASSPHRASE:: Ask for a passphrase
* Agent CLEAR_PASSPHRASE:: Expire a cached passphrase
+@ifset gpgtwoone
+* Agent PRESET_PASSPHRASE:: Set a passphrase for a keygrip
+@end ifset
* Agent GET_CONFIRMATION:: Ask for confirmation
* Agent HAVEKEY:: Check whether a key is available
* Agent LEARN:: Register a smartcard
@@ -1196,6 +1199,30 @@ was set by gpg-agent.
+@ifset gpgtwoone
+@node Agent PRESET_PASSPHRASE
+@subsection Set a passphrase for a keygrip
+
+This command adds a passphrase to the cache for the specified @var{keygrip}.
+
+@example
+ PRESET_PASSPHRASE [--inquire] <string_or_keygrip> <timeout> [<hexstring>]
+@end example
+
+The passphrase is a hexidecimal string when specified. When not specified, the
+passphrase will be retrieved from the pinentry module unless the
+@option{--inquire} option was specified in which case the passphrase will be
+retrieved from the client.
+
+The @var{timeout} parameter keeps the passphrase cached for the specified
+number of seconds. A value of @code{-1} means infinate while @code{0} means
+the default (currently only a timeout of -1 is allowed, which means to never
+expire it).
+@end ifset
+
+
+
+
@node Agent GET_CONFIRMATION
@subsection Ask for confirmation