[PATCH] doc: elaborate on --default-cache-ttl and --max-cache-ttl

[Martin Ichilevici de Oliveira]

The gpg-agent cache supports infinite ttl, through the --default-cache-ttl
option, which was not documented. That, however, is still subject to
--max-cache-ttl. This patch adds this documentation.

Inspired by Issue 1615: https://bugs.g10code.com/gnupg/issue1615
--

Signed-off-by: Martin Ichilevici de Oliveira <iomartin at iomartin dot net>
---
 doc/gpg-agent.texi | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

diff --git a/doc/gpg-agent.texi b/doc/gpg-agent.texi
index 7eadf59..ff6f5e9 100644
--- a/doc/gpg-agent.texi
+++ b/doc/gpg-agent.texi
@@ -371,28 +371,33 @@ control this behaviour but this command line option takes precedence.
 
 @item --default-cache-ttl @var{n}
 @opindex default-cache-ttl
-Set the time a cache entry is valid to @var{n} seconds.  The default is
-600 seconds.
+Set the time a cache entry is valid to @var{n} seconds.  A value of
+-1 means infinite, but it is still subject to @option{--max-cache-ttl}.  The
+default is 600 seconds.
 
 @item --default-cache-ttl-ssh @var{n}
 @opindex default-cache-ttl
 Set the time a cache entry used for SSH keys is valid to @var{n}
-seconds.  The default is 1800 seconds.
+seconds.  A value of -1 means infinite, but it is still subject to
+ at option{--max-cache-ttl-ssh}.  The default is 1800 seconds.
 
 @item --max-cache-ttl @var{n}
 @opindex max-cache-ttl
 Set the maximum time a cache entry is valid to @var{n} seconds.  After
 this time a cache entry will be expired even if it has been accessed
-recently or has been set using @command{gpg-preset-passphrase}.  The
+recently or if it was set not to expire (either by using
+ at command{gpg-preset-passphrase} or with infinite time to live, as set by
+ at option{--default-cache-ttl}).  It should be a positive value.  The
 default is 2 hours (7200 seconds).
 
 @item --max-cache-ttl-ssh @var{n}
 @opindex max-cache-ttl-ssh
 Set the maximum time a cache entry used for SSH keys is valid to
 @var{n} seconds.  After this time a cache entry will be expired even
-if it has been accessed recently or has been set using
- at command{gpg-preset-passphrase}.  The default is 2 hours (7200
-seconds).
+if it has been accessed recently or if it was set not to expire (either by
+using @command{gpg-preset-passphrase} or with infinite time to live, as set by
+ at option{--default-cache-ttl-ssh}).  It should be a positive value.  The default
+is 2 hours (7200 seconds).
 
 @item --enforce-passphrase-constraints
 @opindex enforce-passphrase-constraints
-- 
2.1.2
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: </pipermail/attachments/20141029/c7ab9529/attachment.sig>