]> git.ipfire.org Git - thirdparty/bird.git/commitdiff
Documentation update
authorOndrej Zajicek <santiago@crfreenet.org>
Sat, 18 Jul 2015 17:05:11 +0000 (19:05 +0200)
committerOndrej Zajicek <santiago@crfreenet.org>
Sat, 18 Jul 2015 17:05:11 +0000 (19:05 +0200)
doc/bird.sgml

index 2ae9f64988ca803531cfab73434e110481ae5c86..df83aacd731563512d28d27090aab381998190c1 100644 (file)
@@ -1707,7 +1707,11 @@ using the following configuration parameters:
        <cf/bgp_next_hop/ is used if it is directly reachable, otherwise the
        neighbor IP address is used. Recursive mode means that the gateway is
        computed by an IGP routing table lookup for the IP address from
-       <cf/bgp_next_hop/. Recursive mode is the behavior specified by the BGP
+       <cf/bgp_next_hop/. Note that there is just one level of indirection in
+       recursive mode - the route obtained by the lookup must not be recursive
+       itself, to prevent mutually recursive routes.
+
+       Recursive mode is the behavior specified by the BGP
        standard. Direct mode is simpler, does not require any routes in a
        routing table, and was used in older versions of BIRD, but does not
        handle well nontrivial iBGP setups and multihop. Recursive mode is
@@ -2081,7 +2085,6 @@ interfaces to be defined for them to work with.
 <p><descrip>
 
        <tag>scan time <m/number/</tag>
-
        Time in seconds between two scans of the network interface list. On
        systems where we are notified about interface status changes
        asynchronously (such as newer versions of Linux), we need to scan the
@@ -2266,6 +2269,20 @@ these attributes:
        The realm of the route. Can be used for traffic classification.
 </descrip>
 
+<p>In Linux, there is also a plenty of obscure route attributes mostly focused
+on tuning TCP performance of local connections. BIRD supports most of these
+attributes, see Linux or iproute2 documentation for their meaning. Attributes
+<cf/krt_lock_*/ and <cf/krt_feature_*/ have type bool, others have type int.
+Supported attributes are:
+
+<cf/krt_mtu/, <cf/krt_lock_mtu/, <cf/krt_window/, <cf/krt_lock_window/,
+<cf/krt_rtt/, <cf/krt_lock_rtt/, <cf/krt_rttvar/, <cf/krt_lock_rttvar/,
+<cf/krt_sstresh/, <cf/krt_lock_sstresh/, <cf/krt_cwnd/, <cf/krt_lock_cwnd/,
+<cf/krt_advmss/, <cf/krt_lock_advmss/, <cf/krt_reordering/, <cf/krt_lock_reordering/,
+<cf/krt_hoplimit/, <cf/krt_lock_hoplimit/, <cf/krt_rto_min/, <cf/krt_lock_rto_min/,
+<cf/krt_initcwnd/, <cf/krt_initrwnd/, <cf/krt_quickack/,
+<cf/krt_feature_ecn/, <cf/krt_feature_allfrag/
+
 <sect1>Example
 
 <p>A simple configuration can look this way:
@@ -3394,7 +3411,9 @@ of the protocol contains mainly a list of static routes:
 
 <descrip>
        <tag>route <m/prefix/ via <m/ip/</tag>
-       Static route through a neighboring router.
+       Static route through a neighboring router. For link-local next hops,
+       interface can be specified as a part of the address (e.g.,
+       <cf/via fe80::1234%eth0/).
 
        <tag>route <m/prefix/ multipath via <m/ip/ [weight <m/num/] [via ...]</tag>
        Static multipath route. Contains several nexthops (gateways), possibly