diff options
| author | David Sommerseth | 2016-11-01 14:38:09 +0100 |
|---|---|---|
| committer | Gert Doering | 2016-11-01 22:12:48 +0100 |
| commit | 28778220dd50fd68f0f81cbcc1c73fdd16f04be8 (patch) | |
| tree | c6fca87013be12cb564f62bc8c011aa6e33e43c2 | |
| parent | bac347da53d930abff9df7415c325e70b5bb7be0 (diff) | |
| download | openvpn-28778220dd50fd68f0f81cbcc1c73fdd16f04be8.zip openvpn-28778220dd50fd68f0f81cbcc1c73fdd16f04be8.tar.gz | |
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)
| -rw-r--r-- | doc/openvpn.8 | 31 |
1 files changed, 20 insertions, 11 deletions
diff --git a/doc/openvpn.8 b/doc/openvpn.8 index 7be30ec..31db2eb 100644 --- a/doc/openvpn.8 +++ b/doc/openvpn.8 @@ -1626,16 +1626,25 @@ and are mutually exclusive and cannot be used together. .\"********************************************************* .TP -.B \-\-keepalive n m +.B \-\-keepalive interval timeout 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 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 -before the server side drops the connection. +The +.B timeout +argument will be twice as long on the server side. This ensures that +a timeout is detected on client side before the server side drops +the connection. For example, .B \-\-keepalive 10 60 @@ -1645,13 +1654,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: interval + ping\-restart 120 # Argument: timeout*2 + push "ping 10" # Argument: interval + push "ping\-restart 60" # Argument: timeout else - ping 10 - ping-restart 60 + ping 10 # Argument: interval + ping\-restart 60 # Argument: timeout .in -4 .ft .fi |