[B.A.T.M.A.N.] [PATCH] batctl: Add manpage entry for -w [num] and -t [num]

Linus Lüssing
2010-07-02T00:10:27Z

This patch documents the new ability to specifiy a custom refresh
interval and the new originator timeout filter in the manpage.

Signed-off-by: Linus Lüssing <linus.luessing@web.de>
---
batctl/man/batctl.8 | 16 ++++++++--------
1 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/batctl/man/batctl.8 b/batctl/man/batctl.8
index 8089b24..ccd3546 100644
--- a/batctl/man/batctl.8
+++ b/batctl/man/batctl.8
@@ -56,8 +56,8 @@ protocol.
.IP "\fBinterface\fP|\fBif\fP [\fBadd\fP|\fBdel iface(s)\fP]"
If no parameter is given or the first parameter is neither "add" nor "del" the current interface settings are displayed. In order to add or delete interfaces specify "add" or "del" as first argument and append the interface names you wish to add or delete.
.br
-.IP "\fBoriginators\fP|\fBo\fP [\fB\-w\fP][\fB\-n\fP]"
-Once started batctl will display the list of announced gateways in the network. Use the "\-w" option to let batctl refresh the list every second. If "\-n" is given batctl will not replace the MAC addresses with bat\-host names in the output.
+.IP "\fBoriginators\fP|\fBo\fP [\fB\-w\fP [\fI\interval\fP]][\fB\-n\fP][\fB\-t\fP]"
+Once started batctl will display the list of announced gateways in the network. Use the "\-w" option to let batctl refresh the list every second or add a number to let it refresh at a custom interval in seconds (with optional decimal places). If "\-n" is given batctl will not replace the MAC addresses with bat\-host names in the output. The "\-t" option filters all originators that have not been seen for the specified amount of seconds (with optional decimal places) from the output.
.br
.IP "\fBinterval\fP|\fBit\fP [\fBorig_interval\fP]"
If no parameter is given the current originator interval setting is displayed otherwise the parameter is used to set the originator interval. The interval is in units of milliseconds.
@@ -110,14 +110,14 @@ chooses the gateway with the best link quality but switches to another gateway a
.RE
.RE
.br
-.IP "\fBgateways|gwl\fP [\fB\-w\fP][\fB\-n\fP]"
-Once started batctl will display the list of announced gateways in the network. Use the "\-w" option to let batctl refresh the list every second. If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
+.IP "\fBgateways|gwl\fP [\fB\-w\fP [\fI\interval\fP]][\fB\-n\fP]"
+Once started batctl will display the list of announced gateways in the network. Use the "\-w" option to let batctl refresh the list every second or add a number to let it refresh at a custom interval in seconds (with optional decimal places). If "\-n" was given batctl will not replace the mac addresses with bat\-host names in the output.
.br
-.IP "\fBtranslocal\fP|\fBtl\fP [\fB\-w\fP][\fB\-n\fP]"
-Display the local translation table. batctl will refresh the list every second if the "\-w" option was given. Use "\-n" to let batctl not replace the MAC addresses with bat\-host names in the output.
+.IP "\fBtranslocal\fP|\fBtl\fP [\fB\-w\fP [\fI\interval\fP]][\fB\-n\fP]"
+Display the local translation table. batctl will refresh the list every second if the "\-w" option was given or add a number to let it refresh at a custom interval in seconds (with optional decimal places). Use "\-n" to let batctl not replace the MAC addresses with bat\-host names in the output.
.br
-.IP "\fBtransglobal\fP|\fBtg\fP [\fB\-w\fP][\fB\-n\fP]"
-Display the global translation table. batctl will refresh the list every second if the "\-w" option was given. Use "\-n" to let batctl not replace the MAC addresses with bat\-host names in the output.
+.IP "\fBtransglobal\fP|\fBtg\fP [\fB\-w\fP [\fI\interval\fP]][\fB\-n\fP]"
+Display the global translation table. batctl will refresh the list every second if the "\-w" option was given or add a number to let it refresh at a custom interval in seconds (with optional decimal places). Use "\-n" to let batctl not replace the MAC addresses with bat\-host names in the output.
.br
.IP "\fBvis_mode|vm\fP [\fBmode\fP]\fP"
If no parameter is given the current vis mode is displayed otherwise the parameter is used to set the vis mode.
--
1.5.6.5