Repository : ssh://git@open-mesh.org/batctl
On branches: master,next
commit 678022a33afb46c0ad335652092f0801d51cef1e Merge: acd06db f38cae7 Author: Sven Eckelmann sven@narfation.org Date: Sun Aug 19 22:15:43 2012 +0200
Merge tag 'v2012.3.0'
batctl 2012.3.0
Conflicts: man/batctl.8
678022a33afb46c0ad335652092f0801d51cef1e man/batctl.8 | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-)
diff --cc man/batctl.8 index 1a11508,3b8b333..f904719 --- a/man/batctl.8 +++ b/man/batctl.8 @@@ -142,57 -112,55 +142,56 @@@ least XX TQ better than the currently s .RE .RE .br -.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 [\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 [\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 "\fBclaimtable\fP|\fBcl\fP [\fB-w\fP [\fI\interval\fP]][\fB-n\fP]" -Display the bridge loop avoidance claim 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. -.br -.IP "\fBvis_data|vd dot\fP [\fB-n\fP|\fB--numbers\fP][\fB-T\fP|\fB--no-TT\fP][\fB-2\fP|\fB--no-2nd\fP]" -Display the visualisation data in graphviz \fBdot\fP(1) format. If -"--numbers" or "-n" is given batctl will not replace the MAC -addresses with bat-host names in the output. With "--no-TT" or -"-T" the TT entries are not displayed, so the pure mesh topology can -be seen. With "--no-2nd" or "-2" a dot cluster is not formed around -primary and secondary addresses from the same device. -.br -.IP "\fBvis_data|vd json\fP [\fB-n\fP|\fB--numbers\fP][\fB-T\fP|\fB--no-TT\fP][\fB-2\fP|\fB--no-2nd\fP]" -Display the visualisation data in JSON format. If "--numbers" or -"-n" is given batctl will not replace the MAC addresses with bat-host -names in the output. With "--no-TT" or "-T" the TT entries are -not displayed, so the pure mesh topology can be seen. With -"--no-2nd" or "-2" a dot cluster is not formed around primary and -secondary addresses from the same device. -.br -.IP "\fBaggregation\fP|\fBag\fP [\fB1\fP|\fB0\fP]" -If no parameter is given the current aggregation setting is displayed. Otherwise the parameter is used to enable or disable packet aggregation. +.IP "\fBvis_data|vd dot\fP [\fB-n\fP|\fB--numbers\fP][\fB-T\fP|\fB--no-TT\fP][\fB-2\fP|\fB--no-2nd\fP]" +Display the visualisation data in graphviz \fBdot\fP(1) format. If "--numbers" or "-n" is given batctl will not replace +the MAC addresses with bat-host names in the output. With "--no-TT" or "-T" the TT entries are not displayed, so the pure +mesh topology can be seen. With "--no-2nd" or "-2" a dot cluster is not formed around primary and secondary addresses +from the same device. .br -.IP "\fBbonding\fP|\fBb\fP [\fB1\fP|\fB0\fP]" -If no parameter is given the current bonding mode setting is displayed. Otherwise the parameter is used to enable or disable the bonding mode. -.br -.IP "\fBbridge_loop_avoidance\fP|\fBbl\fP [\fB1\fP|\fB0\fP]" -If no parameter is given the current bridge loop avoidance setting is displayed. Otherwise the parameter is used to enable or disable the bridge loop avoidance. -.br -.IP "\fBfragmentation\fP|\fBf\fP [\fB1\fP|\fB0\fP]" -If no parameter is given the current fragmentation mode setting is displayed. Otherwise the parameter is used to enable or disable fragmentation. -.br -.IP "\fBap_isolation\fP|\fBap\fP [\fB1\fP|\fB0\fP]" -If no parameter is given the current ap isolation setting is displayed. Otherwise the parameter is used to enable or disable ap isolation. +.PP +.I \fBdebug tables: +.IP +The batman-adv kernel module comes with a variety of debug tables containing various information about the state of the mesh +seen by each individual node. These tables are exported via debugfs and easily accessible via batctl. You will need debugfs +support compiled into your kernel and preferrably have mounted the debugfs to a well-known mountpoint. If debugfs is not +mounted batctl will attempt to do this step for you. + +All of the debug tables support the following options: +.RS 10 +-w refresh the list every second or add a number to let it refresh at a custom interval in seconds (with optional decimal places) +.RE +.RS 10 +-n do not replace the MAC addresses with bat-host names in the output +.RE + +.RS 7 +The originator table also supports the "-t" filter option to remove all originators from the output that have not been seen +for the specified amount of seconds (with optional decimal places). + +List of debug tables: +.RS 10 +- originators|o +.RE +.RS 10 +- gateways|gwl +.RE +.RS 10 +- translocal|tl +.RE +.RS 10 +- transglobal|tg +.RE +.RS 10 +- claimtable|cl (compile time option) +.RE +.RS 10 +- backbonetable|bbt (compile time option) +.RE +.RE .br .IP "\fBstatistics\fP|\fBs\fP" -Retrieve traffic counters from batman-adv kernel module. The output may vary depending on which features have -been compiled into the kernel module. +Retrieve traffic counters from batman-adv kernel module. The output may vary depending on which features have been compiled - into the kernel module. For example, if the distributed arp table (short: dat) wasn't selected as an option at compile time - its counters won't be shown. ++into the kernel module. .br Each module subsystem has its own counters which are indicated by their prefixes: .RS 15