From 4d176dc07ccdcdefcd0e40043233a8c4f136f5c1 Mon Sep 17 00:00:00 2001 From: Juliusz Chroboczek Date: Tue, 14 Feb 2012 08:52:19 +0100 Subject: babeld: fix documentation. --- doc/babeld.texi | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) (limited to 'doc/babeld.texi') diff --git a/doc/babeld.texi b/doc/babeld.texi index 8f671974..65587a71 100644 --- a/doc/babeld.texi +++ b/doc/babeld.texi @@ -54,18 +54,16 @@ Enable or disable Babel on the given interface. @deffnx {Interface Command} {babel wireless} {} Specifies whether this interface is wireless, which disables a number of optimisations that are only correct on wired interfaces. -Specifying @code{wireless} is always correct, but may cause extra -routing overhead. The default is autodetected if possible, -@code{wireless} otherwise. +Specifying @code{wireless} (the default) is always correct, but may +cause slower convergence and extra routing traffic. @end deffn @deffn {Interface Command} {babel split-horizon} @deffnx {Interface Command} {no babel split-horizon} -Specifies whether to perform split-horizon on the interface. Default -is @code{babel split-horizon} on wired interfaces, and @code{no babel -split-horizon} on wireless interfaces. Please note that performing split -horizon on wireless interfaces is not correct in general, and may lead -to communication failures. +Specifies whether to perform split-horizon on the interface. +Specifying @code{no babel split-horizon} (the default) is always +correct, while @code{babel split-horizon} is an optimisation that +should only be used on symmetric and transitive (wired) networks. @end deffn @deffn {Interface Command} {babel passive-interface} @@ -77,22 +75,23 @@ passive interfaces. @end deffn @deffn {Interface Command} {babel hello-interval <20-655340>} -Specifies the time in milliseconds between two scheduled hellos. -Babel notices a link failure within two hello intervals on wired -links; on wireless links, the link quality value is reestimated at -every hello interval. +Specifies the time in milliseconds between two scheduled hellos. On +wired links, Babel notices a link failure within two hello intervals; +on wireless links, the link quality value is reestimated at every +hello interval. The default is 4000@dmn{ms}. @end deffn @deffn {Interface Command} {babel update-interval <20-655340>} Specifies the time in milliseconds between two scheduled updates. -Since Babel makes extensive use of triggered updates, this can be -set to fairly high values on links with little packet loss. +Since Babel makes extensive use of triggered updates, this can be set +to fairly high values on links with little packet loss. The default +is 20000@dmn{ms}. @end deffn @deffn {Babel Command} {babel resend-delay <20-655340>} Specifies the time in milliseconds after which an ``important'' -request or update will be resent. This is a global, not per-interface -value. +request or update will be resent. The default is 2000@dmn{ms}. You +probably don't want to tweak this value. @end deffn @node Babel redistribution, Show Babel information, Babel configuration, Babel -- cgit v1.2.1