Previous: , Up: Agent Protocol   [Contents][Index]

2.6.17 Set options for the session

Here is a list of session options which are not yet described with other commands. The general syntax for an Assuan option is:

OPTION  key=value

Supported keys are:


This may be used to tell gpg-agent of which gpg-agent version the client is aware of. gpg-agent uses this information to enable features which might break older clients.


Change the session’s environment to be used for the Pinentry. Valid values are:


Delete envvar name


Set envvar name to the empty string


Set envvar name to the string value.


See Assuan command PKSIGN.


This does not need any value. It is used to enable the PINENTRY_LAUNCHED inquiry.


This option is used to change the operation mode of the pinentry. The following values are defined:


This is the default mode which pops up a pinentry as needed.


Instead of popping up a pinentry, return the error code GPG_ERR_CANCELED.


Instead of popping up a pinentry, return the error code GPG_ERR_NO_PIN_ENTRY.


Use a loopback pinentry. This fakes a pinentry by using inquiries back to the caller to ask for a passphrase. This option may only be set if the agent has been configured for that. To disable this feature use option --no-allow-loopback-pinentry.


This option sets the cache TTL for new entries created by GENKEY and PASSWD commands when using the --preset option. It is not used a default value is used.


Instead of using the standard S2K count (which is computed on the fly), the given S2K count is used for new keys or when changing the passphrase of a key. Values below 65536 are considered to be 0. This option is valid for the entire session or until reset to 0. This option is useful if the key is later used on boxes which are either much slower or faster than the actual box.


This option switches the connection into a restricted mode which handles all further commands in the same way as they would be handled when originating from the extra or browser socket. Note that this option is not available in the restricted mode. Valid values for this option are:


This is a NOP and leaves the connection in the standard way.


Pretend to come from a remote origin in the same way as connections from the --extra-socket.


Pretend to come from a local web browser in the same way as connections from the --browser-socket.

Previous: , Up: Agent Protocol   [Contents][Index]