Browse code

man: Improve the --keepalive section

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

v2 - Changed from ps/pto to interval/timeout
- Rephrased the server-side timeout doubling parapgraph

Signed-off-by: David Sommerseth <davids@openvpn.net>
Acked-by: Gert Doering <gert@greenie.muc.de>
Message-Id: <1478007489-17163-1-git-send-email-davids@openvpn.net>
URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg12866.html
Signed-off-by: Gert Doering <gert@greenie.muc.de>
(cherry picked from commit beaa6564a7ce3e48473a8bde7b4f9291df490d62)

David Sommerseth authored on 2016/11/01 22:38:09
Showing 1 changed files
... ...
@@ -1626,16 +1626,25 @@ and
1626 1626
 are mutually exclusive and cannot be used together.
1627 1627
 .\"*********************************************************
1628 1628
 .TP
1629
-.B \-\-keepalive n m
1629
+.B \-\-keepalive interval timeout
1630 1630
 A helper directive designed to simplify the expression of
1631 1631
 .B \-\-ping
1632 1632
 and
1633
+.B \-\-ping\-restart.
1634
+
1635
+This option can be used on both client and server side, but it is
1636
+in enough to add this on the server side as it will push appropriate
1637
+.B \-\-ping
1638
+and
1633 1639
 .B \-\-ping\-restart
1634
-in server mode configurations.
1640
+options to the client.  If used on both server and client,
1641
+the values pushed from server will override the client local values.
1635 1642
 
1636
-The server timeout is set twice the value of the second argument.
1637
-This ensures that a timeout is detected on client side
1638
-before the server side drops the connection.
1643
+The
1644
+.B timeout
1645
+argument will be twice as long on the server side.  This ensures that
1646
+a timeout is detected on client side before the server side drops
1647
+the connection.
1639 1648
 
1640 1649
 For example,
1641 1650
 .B \-\-keepalive 10 60
... ...
@@ -1645,13 +1654,13 @@ expands as follows:
1645 1645
 .ft 3
1646 1646
 .in +4
1647 1647
  if mode server:
1648
-   ping 10
1649
-   ping-restart 120
1650
-   push "ping 10"
1651
-   push "ping-restart 60"
1648
+   ping 10                    # Argument: interval
1649
+   ping\-restart 120           # Argument: timeout*2
1650
+   push "ping 10"             # Argument: interval
1651
+   push "ping\-restart 60"     # Argument: timeout
1652 1652
  else
1653
-   ping 10
1654
-   ping-restart 60
1653
+   ping 10                    # Argument: interval
1654
+   ping\-restart 60            # Argument: timeout
1655 1655
 .in -4
1656 1656
 .ft
1657 1657
 .fi