batadv-vis - html man page (v2025.2-1-g16a7397)
[1mDESCRIPTION[0m
batadv-vis can be used to visualize your batman-adv mesh network. It
read the neighbor information and local client table and distributes
this information via alfred in the network. By gathering this local in-
formation, any vis node can get the whole picture of the network.
[1mOPTIONS[0m
[1m-v[22m, [1m--version[0m
Print the version
[1m-h[22m, [1m--help[0m
Display a brief help message.
[1m-u[22m, [1m--unix-path [4m[22mpath[0m
path to unix socket used for alfred server communication.
[1m-i[22m, [1m--interface [4m[22miface[0m
Specify the batman-adv interface configured on the system (de-
fault: bat0)
[1m-s[22m, [1m--server[0m
Start up in server mode. This server will read the neighbor and
client information from batman-adv every 10 seconds and set it
in alfred via unix socket. The alfred server must run too to get
this information set.
[1m-f[22m, [1m--format [4m[22mformat[0m
Specify the output format for client mode (either "json", "json-
doc" or "dot")
[1mEXAMPLES[0m
Start an batadv-vis server which is fetching the information for bat0:
[1mbatadv-vis -i bat0 -s[0m
To get a graphviz-compatible vis output:
[1mbatadv-vis[0m
digraph {
subgraph "cluster_fe:f0:00:00:04:01" {
"fe:f0:00:00:04:01"
}
"fe:f0:00:00:04:01" -> "fe:f0:00:00:05:01" [label="1.000"]
"fe:f0:00:00:04:01" -> "fe:f0:00:00:03:01" [label="1.004"]
"fe:f0:00:00:04:01" -> "00:00:43:05:00:04" [label="TT"]
"fe:f0:00:00:04:01" -> "fe:f1:00:00:04:01" [label="TT"]
subgraph "cluster_fe:f0:00:00:02:01" {
"fe:f0:00:00:02:01"
}
"fe:f0:00:00:02:01" -> "fe:f0:00:00:03:01" [label="1.000"]
"fe:f0:00:00:02:01" -> "fe:f0:00:00:01:01" [label="1.008"]
"fe:f0:00:00:02:01" -> "fe:f0:00:00:08:01" [label="1.000"]
"fe:f0:00:00:02:01" -> "fe:f1:00:00:02:01" [label="TT"]
"fe:f0:00:00:02:01" -> "00:00:43:05:00:02" [label="TT"]
subgraph "cluster_fe:f0:00:00:08:01" {
"fe:f0:00:00:08:01"
}
[...]
}
To get a json vis output:
[1mbatadv-vis -f json[0m
{ "primary" : "fe:f0:00:00:04:01" }
{ "router" : "fe:f0:00:00:04:01", "neighbor" : "fe:f0:00:00:05:01", "label" : "1.000" }
{ "router" : "fe:f0:00:00:04:01", "neighbor" : "fe:f0:00:00:03:01", "label" : "1.008" }
{ "router" : "fe:f0:00:00:04:01", "gateway" : "00:00:43:05:00:04", "label" : "TT" }
{ "router" : "fe:f0:00:00:04:01", "gateway" : "fe:f1:00:00:04:01", "label" : "TT" }
{ "primary" : "fe:f0:00:00:02:01" }
{ "router" : "fe:f0:00:00:02:01", "neighbor" : "fe:f0:00:00:03:01", "label" : "1.000" }
{ "router" : "fe:f0:00:00:02:01", "neighbor" : "fe:f0:00:00:01:01", "label" : "1.016" }
{ "router" : "fe:f0:00:00:02:01", "neighbor" : "fe:f0:00:00:08:01", "label" : "1.000" }
{ "router" : "fe:f0:00:00:02:01", "gateway" : "fe:f1:00:00:02:01", "label" : "TT" }
{ "router" : "fe:f0:00:00:02:01", "gateway" : "00:00:43:05:00:02", "label" : "TT" }
{ "primary" : "fe:f0:00:00:08:01" }
[...]
To get output where the complete document is json:
[1mbatadv-vis -f jsondoc[0m
{
"source_version" : "2013.3.0-14-gcd34783",
"algorithm" : 4,
"vis" : [
{ "primary" : "fe:f0:00:00:04:01",
"neighbors" : [
{ "router" : "fe:f0:00:00:04:01",
"neighbor" : "fe:f0:00:00:05:01",
"metric" : "1.000" },
{ "router" : "fe:f0:00:00:04:01",
"neighbor" : "fe:f0:00:00:03:01",
"metric" : "1.008" }
],
"clients" : [
"00:00:43:05:00:04",
"fe:f1:00:00:04:01"
]
},
{ "primary" : "fe:f0:00:00:02:01",
"neighbors" : [
{ "router" : "fe:f0:00:00:02:01",
"neighbor" : "fe:f0:00:00:03:01",
"metric" : "1.000" },
{ "router" : "fe:f0:00:00:02:01",
"neighbor" : "fe:f0:00:00:01:01",
"metric" : "1.016" },
{ "router" : "fe:f0:00:00:02:01",
"neighbor" : "fe:f0:00:00:08:01",
"metric" : "1.000" }
],
"clients" : [
"fe:f1:00:00:02:01",
"00:00:43:05:00:02"
]
},
{ "primary" : "fe:f0:00:00:08:01",
[...]
[1mSEE ALSO[0m
[1malfred[22m(8), [1mbatctl[22m(8)
[1mAUTHOR[0m
batadv-vis was written by Simon Wunderlich <sw@simonwunderlich.de>.
This manual page was written by Simon Wunderlich <sw@simonwunder-
lich.de> and Sven Eckelmann <sven@open-mesh.com>.
Linux Sep 21, 2013 [4mBATADV-VIS[24m(8)
Man(1) output converted with
man2html