Browse Source

update man pages

ambrop7 14 years ago
parent
commit
aa6ef3d622
2 changed files with 16 additions and 2 deletions
  1. 8 1
      badvpn-client.8
  2. 8 1
      badvpn-server.8

+ 8 - 1
badvpn-client.8

@@ -1,4 +1,4 @@
-.TH badvpn-client 8 "6 October 2010"
+.TH badvpn-client 8 "21 June 2011"
 .SH NAME
 badvpn-client \- VPN node daemon for the BadVPN peer-to-peer VPN system
 .SH SYNOPSIS
@@ -70,6 +70,8 @@ badvpn-client \- VPN node daemon for the BadVPN peer-to-peer VPN system
 .RS
 .RB "(ssl? [" --peer-ssl "])"
 .br
+.RB "[" --peer-tcp-socket-sndbuf " <bytes / 0>]"
+.br
 .RE
 )
 .br
@@ -214,6 +216,11 @@ When using TCP transport, enables TLS for data connections. Requires using TLS f
 For this to work, the peers must trust each others' cerificates, and the cerificates must grant the
 TLS server usage context. This option must match on all peers.
 .TP
+.BR --peer-tcp-socket-sndbuf " <bytes / 0>"
+Sets the value of the SO_SNDBUF socket option for peer TCP sockets (zero to not set). Lower values
+will improve fairness when data from multiple sources (local and relaying) is being sent to a
+given peer, but may result in lower bandwidth if the network's bandwidth-delay product to too big.
+.TP
 .BR --send-buffer-size " <num-packets>"
 Sets the minimum size of the peers' send buffers for sending frames originating from this system, in
 number of packets.

+ 8 - 1
badvpn-server.8

@@ -1,4 +1,4 @@
-.TH badvpn-server 8 "6 October 2010"
+.TH badvpn-server 8 "21 June 2011"
 .SH NAME
 badvpn-server \- chat server for the BadVPN peer-to-peer VPN system
 .SH SYNOPSIS
@@ -33,6 +33,8 @@ badvpn-server \- chat server for the BadVPN peer-to-peer VPN system
 .br
 .RB "[" --relay-predicate " <string>]"
 .br
+.RB "[" --client-socket-sndbuf " <bytes / 0>]"
+.br
 .RE
 .SH INTRODUCTION
 .P
@@ -122,6 +124,11 @@ name is assumed to be an empty string.
 .BR raddr "(string)"
 - true if the IP address of peer R equals the given string. The string must not be a name.
 .br
+.TP
+.BR --client-socket-sndbuf " <bytes / 0>"
+Sets the value of the SO_SNDBUF socket option for client TCP sockets (zero to not set). Lower values
+will improve fairness when data from multiple peers is being sent to a given peer, but may result in lower
+bandwidth if the network's bandwidth-delay product to too big.
 .SH "EXIT CODE"
 .P
 If initialization fails, exits with code 1. Otherwise runs until termination is requested and exits with code 1.