Document PRESET_PASSPHRASE.

This commit is contained in:
Ben Kibbey 2012-04-03 20:53:20 -04:00 committed by Werner Koch
parent 26b59d78c4
commit 96e107fc29
1 changed files with 27 additions and 0 deletions

View File

@ -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