[Openvpn-devel] [PATCH] man: Improve the --keepalive section

[David S. <da...@op...>]

Just minor clarifications and corrections of the --keepalive option.

Signed-off-by: David Sommerseth <da...@op...>
---
 doc/openvpn.8 | 29 +++++++++++++++++++----------
 1 file changed, 19 insertions(+), 10 deletions(-)

diff --git a/doc/openvpn.8 b/doc/openvpn.8
index e73517a..0dd149d 100644
--- a/doc/openvpn.8
+++ b/doc/openvpn.8
@@ -1614,15 +1614,24 @@ and
 are mutually exclusive and cannot be used together.
 .\"*********************************************************
 .TP
-.B \-\-keepalive n m
+.B \-\-keepalive ps pto
 A helper directive designed to simplify the expression of
 .B \-\-ping
 and
+.B \-\-ping\-restart.
+
+This option can be used on both client and server side, but it is
+in most cases enough to add this on the server side as it will
+push appropriate
+.B \-\-ping
+and
 .B \-\-ping\-restart
-in server mode configurations.
+options to the client.  If used on both server and client,
+the values pushed from server will override the client local values.
 
-The server timeout is set twice the value of the second argument.
-This ensures that a timeout is detected on client side
+The server-side timeout is the
+.B pto
+argument doubled. This ensures that a timeout is detected on client side
 before the server side drops the connection.
 
 For example,
@@ -1633,13 +1642,13 @@ expands as follows:
 .ft 3
 .in +4
  if mode server:
-   ping 10
-   ping\-restart 120
-   push "ping 10"
-   push "ping\-restart 60"
+   ping 10                    # Argument: ps
+   ping\-restart 120           # Argument: pto*2
+   push "ping 10"             # Argument: ps
+   push "ping\-restart 60"     # Argument: pto
  else
-   ping 10
-   ping\-restart 60
+   ping 10                    # Argument: ps
+   ping\-restart 60            # Argument: pto
 .in -4
 .ft
 .fi
-- 
1.8.3.1