Author: simon Date: 2010-03-21 22:34:03 +0100 (Sun, 21 Mar 2010) New Revision: 1607

Modified: branches/batctl-0.2.x/man/batctl.8 Log: batctl-0.2.x: adjust "-w" option, vis options and minor layout things

This patch adds documentation for the new way of enabling/disabling and handling the vis server. It also adds documentation for the change from "-b" to "-w" in the according options. Furthermore, the sub-option alignment has been altered in some places.

Signed-off-by: Linus L?\195?\188ssing linus.luessing@web.de Signed-off-by: Marek Lindner lindner_marek@yahoo.de

Modified: branches/batctl-0.2.x/man/batctl.8 =================================================================== --- branches/batctl-0.2.x/man/batctl.8 2010-03-21 20:44:37 UTC (rev 1606) +++ branches/batctl-0.2.x/man/batctl.8 2010-03-21 21:34:03 UTC (rev 1607) @@ -58,10 +58,9 @@ otherwise the parameter(s) are added as new interfaces. Use the "none" keyword to deactivate all interfaces. .br -.IP "\fBoriginators\fP|\fBo\fP [\fB-b\fP][\fB-n\fP]" -Display the originator table. Once started batctl will refresh the -displayed originator table every second. The "-b" option causes the -table to be displayed only once (useful for scripts). If "-n" is +.IP "\fBoriginators\fP|\fBo\fP [\fB-w\fP][\fB-n\fP]" +Once started batctl will display the originator table. 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. .br @@ -73,42 +72,38 @@ .IP "\fBloglevel\fP|\fBll\fP [\fIlevel\fP]" If no parameter is given the current log level settings are displayed otherwise the parameter is used to set the log level. Level 0 disables -all logging. Level 1 enables messages related to routing / flooding / -broadcasting. Level 2 enables messages related to route or hna added / -changed / deleted. Level 3 enables all messages. The messages are sent -to the kernel log. Use \fBdmesg\fP(1) to see them. +all verbose logging. Level 1 enables messages related to routing / flooding / broadcasting. +Level 2 enables messages related to route or hna added / changed / deleted. +Level 3 enables all messages. The messages are sent to the kernel log. +Use \fBdmesg\fP(1) to see them. Make sure to have debugging output +enabled when compiling the module otherwise the verbose logging output as +well as the loglevel options won't be available. .br -.IP "\fBlog\fP|\fBl\fP [\fIlogfile\fP][\fB-b\fP][\fB-n\fP]\fP" +.IP "\fBlog\fP|\fBl\fP [\fIlogfile\fP][\fB-w\fP][\fB-n\fP]\fP" batctl will read the file logfile, or stdin if the logfile parameter is not given, applying filtering so only the B.A.T.M.A.N. Advanced -messages are displayed. Whenever there are new log messages appended -to the file batctl will display them. The option "-b" causes batctl -to exit once the end of the file has been reached. If "-n" is given -batctl will not replace the MAC addresses with bat-host names in the -output. +messages are displayed. Once the end of the file has been reached batctl +will exit unless the option "-w" was specified which causes batctl to +continue reading the file and print log output whenever new log data has +been appended to the file. If "-n" is given batctl will not replace the +MAC addresses with bat-host names in the output. .br -.IP "\fBtranslocal\fP|\fBtl\fP [\fB-b\fP][\fB-n\fP]" -Display the local translation table. batctl will refresh the -displayed table every second. The "-b" option causes the table to be -displayed only once (useful for scripts). If "-n" is given batctl -will not replace the MAC addresses with bat-host names in the output. +.IP "\fBtranslocal\fP|\fBtl\fP [\fB-w\fP][\fB-n\fP]" +Display the local translation table. 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. .br -.IP "\fBtransglobal\fP|\fBtg\fP [\fB-b\fP][\fB-n\fP]" -Display the global translation table. batctl will refresh the -displayed table every second. The "-b" option causes the table to be -displayed only once (useful for scripts). If "-n" is given batctl -will not replace the MAC addresses with bat-host names in the output. +.IP "\fBtransglobal\fP|\fBtg\fP [\fB-w\fP][\fB-n\fP]" +Display the global translation table. 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. .br -.IP "\fBvis dot\fP [\fB-n\fP|\fB--numbers\fP][\fB-H\fP|\fB--no-HNA\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-HNA" or -"-H" the HNA 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. +.IP "\fBvis_server\fP|\fBvs\fP [\fBenabled\fP|\fBdisabled\fP]" +If no parameter is given the current vis server setting is displayed. +Otherwise the parameter is used to enable or disable the vis server. .br -.IP "\fBvis json\fP [\fB-n\fP|\fB--numbers\fP][\fB-H\fP|\fB--no-HNA\fP][\fB-2\fP|\fB--no-2nd\fP]" -Display the visualisation data in JSON format. If "--numbers" or +.IP "\fBvis_data\fP|\fBvd\fP \fBdot|\fBjson [\fB-n\fP|\fB--numbers\fP][\fB-H\fP|\fB--no-HNA\fP][\fB-2\fP|\fB--no-2nd\fP]" +Display the visualisation data in \fBdot\fP(1) or JSON format. If "--numbers" or "-n" is given batctl will not replace the MAC addresses with bat-host names in the output. With "--no-HNA" or "-H" the HNA entries are not displayed, so the pure mesh topology can be seen. With @@ -129,14 +124,14 @@ you can set the default interval between pings and the timeout time for replies, both in seconds. .br -.IP "\fBtraceroute\fP|\fBtr\fP [\fB-n\fP] \fIMAC_address\fP|\fIbat-host_name\fP" +.IP "\fBtraceroute\fP|\fBtr\fP [\fB-n\fP] \fIMAC_address\fP|\fBbat-host_name\fP" Layer 2 traceroute to a MAC address or bat-host name. batctl will try to find the bat-host name if the given parameter was not a MAC address. batctl will send 3 packets to each host and display the response time. If "-n" is given batctl will not replace the MAC addresses with bat-host names in the output. .br -.IP "\fBtcpdump\fP|\fBtd\fP [\fB-p \fP\fIfilter\fP][\fB-n\fP] \fIinterface ...\fP" +.IP "\fBtcpdump\fP|\fBtd\fP [\fB-p \fP\fIfilter\fP][\fB-n\fP] \fBinterface ...\fP" batctl will display all packets that are seen on the given interface(s). The "-p" options allows the filtering of certain packet types: 1 - batman ogm packets, 2 - batman icmp packets, 4 - unicast @@ -146,7 +141,7 @@ packets only. If "-n" is given batctl will not replace the MAC addresses with bat-host names in the output. .br -.IP "\fBbisect\fP [\fB-l \fP\fIMAC\fP][\fB-t \fP\fIMAC\fP][\fB-r \fP\fIMAC\fP][\fB-s \fP\fImin\fP [\fB- \fP\fImax\fP]][\fB-o \fP\fIMAC\fP][\fB-n\fP] \fIlogfile1\fP [\fIlogfile2\fP ... \fIlogfileN\fP]" +.IP "\fBbisect\fP [\fB-l \fP\fIMAC\fP][\fB-t \fP\fIMAC\fP][\fB-r \fP\fIMAC\fP][\fB-s \fP\fImin\fP [\fB- \fP\fImax\fP]][\fB-o \fP\fIMAC\fP][\fB-n\fP] \fIlogfile1\fP [\fIlogfile2\fP ... \fIlogfileN\fP]" Analyses the logfiles to build a small internal database of all sent sequence numbers and routing table changes. This database can then be analyzed in a number of different ways. With "-l" the database can be