about summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorRobin Jarry <robin@jarry.cc>2021-12-07 00:05:36 +0100
committerRobin Jarry <robin@jarry.cc>2021-12-07 21:28:13 +0100
commit5dfeff75f3681429446329e2d644811414100e7c (patch)
treefb19428d90bd3e16197ec3ccf361f435bad3cc7f /doc
parent33aaf946633791f8954784a693de27990c43e0f5 (diff)
downloadaerc-5dfeff75f3681429446329e2d644811414100e7c.tar.gz
imap: add tcp connection options
Allow fine tuning tcp connection options.

Signed-off-by: Robin Jarry <robin@jarry.cc>
Diffstat (limited to 'doc')
-rw-r--r--doc/aerc-imap.5.scd29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/aerc-imap.5.scd b/doc/aerc-imap.5.scd
index 9ef0e63..e6a4460 100644
--- a/doc/aerc-imap.5.scd
+++ b/doc/aerc-imap.5.scd
@@ -61,6 +61,35 @@ available:
 
 	pass hostname/username
 
+*connection-timeout*
+	Maximum delay to establish a connection to the IMAP server. See
+	https://pkg.go.dev/time#ParseDuration.
+
+	Default: 30s
+
+*keepalive-period*
+	The interval between the last data packet sent (simple ACKs are not
+	considered data) and the first keepalive probe. After the connection is
+	marked to need keepalive, this counter is not used any further. See
+	https://pkg.go.dev/time#ParseDuration.
+
+	By default, the system tcp socket settings are used.
+
+*keepalive-probes*
+	The number of unacknowledged probes to send before considering the
+	connection dead and notifying the application layer.
+
+	By default, the system tcp socket settings are used.
+	If keepalive-period is specified, this option defaults to 3 probes.
+
+*keepalive-interval*
+	The interval between subsequential keepalive probes, regardless of what
+	the connection has exchanged in the meantime. Fractional seconds are
+	truncated.
+
+	By default, the system tcp socket settings are used.
+	If keepalive-period is specified, this option defaults to 3s.
+
 # SEE ALSO
 
 *aerc*(1) *aerc-config*(5)