aboutsummaryrefslogtreecommitdiff
path: root/openvpn.8
diff options
context:
space:
mode:
authorjames <james@e7ae566f-a301-0410-adde-c780ea21d3b5>2008-11-18 05:15:22 +0000
committerjames <james@e7ae566f-a301-0410-adde-c780ea21d3b5>2008-11-18 05:15:22 +0000
commitae3b37460b677ebd6f1ad12dab76055e7879fcaf (patch)
tree3dbc37295b45822f221c4bbb23ab7e1fd0d2a9ad /openvpn.8
parentCleaned up man page synopsis. (diff)
downloadopenvpn-ae3b37460b677ebd6f1ad12dab76055e7879fcaf.tar.xz
Added --tcp-nodelay option: Macro that sets TCP_NODELAY socket
flag on the server as well as pushes it to connecting clients. git-svn-id: http://svn.openvpn.net/projects/openvpn/branches/BETA21/openvpn@3513 e7ae566f-a301-0410-adde-c780ea21d3b5
Diffstat (limited to '')
-rw-r--r--openvpn.825
1 files changed, 25 insertions, 0 deletions
diff --git a/openvpn.8 b/openvpn.8
index 790501d..ab56e97 100644
--- a/openvpn.8
+++ b/openvpn.8
@@ -2866,6 +2866,31 @@ OpenVPN will start to drop outgoing packets directed
at this client.
.\"*********************************************************
.TP
+.B --tcp-nodelay
+This macro sets the TCP_NODELAY socket flag on the server
+as well as pushes it to connecting clients. The TCP_NODELAY
+flag disables the Nagle algorithm on TCP sockets causing
+packets to be transmitted immediately with low latency,
+rather than waiting a short period of time in order
+to aggregate several packets into a larger containing
+packet. In VPN applications over TCP, TCP_NODELAY
+is generally a good latency optimization.
+
+The macro expands as follows:
+
+.RS
+.ft 3
+.nf
+.sp
+ if mode server:
+ socket-flags TCP_NODELAY
+ push "socket-flags TCP_NODELAY"
+.ft
+.LP
+.RE
+.fi
+.\"*********************************************************
+.TP
.B --max-clients n
Limit server to a maximum of
.B n