Allow weight to be assigned to Subnets.
[oweals/tinc.git] / doc / tinc.conf.5.in
index 0ad3da3..7486bc8 100644 (file)
@@ -394,7 +394,7 @@ Either the PEM format is used, or exactly one of the above two options must be s
 in each host configuration file,
 if you want to be able to establish a connection with that host.
 
-.It Va Subnet Li = Ar address Ns Op Li / Ns Ar prefixlength
+.It Va Subnet Li = Ar address Ns Op Li / Ns Ar prefixlength Ns Op Li # Ns Ar weight
 The subnet which this tinc daemon will serve.
 .Nm tinc
 tries to look up which other daemon it should send a packet to by searching the appropriate subnet.
@@ -416,6 +416,13 @@ Read a networking HOWTO/FAQ/guide if you don't understand this.
 IPv6 subnets are notated like fec0:0:0:1:0:0:0:0/64.
 MAC addresses are notated like 0:1a:2b:3c:4d:5e.
 
+.Pp
+A Subnet can be given a weight to indicate its priority over identical Subnets
+owned by different nodes.  The default weight is 10. Lower values indicate
+higher priority. Packets will be sent to the node with the highest priority,
+unless that node is not reachable, in which case the node with the next highest
+priority will be tried, and so on.
+
 .It Va TCPOnly Li = yes | no Pq no
 If this variable is set to yes,
 then the packets are tunnelled over the TCP connection instead of a UDP connection.