README
1NetMap
2======
3
4Running NetMap
5--------------
6
7Usage: netmap [options]
8
9 Netmap will (recursively) read the datadir containing the output of
10 makelist. It will then create a list of all ip addresses and there
11 interconnections. Unless the -n option is used, netmap will try to resolve
12 the hostname of the address, but a cache is kept to speed up consecutive
13 runs.
14
15 Unless the -s option is used, netmap will insert an unknown host when a host
16 did not respond on the traceroute. When 2 (or more) consecutive hosts in the
17 route do not reply, they will be grouped in one node and the label will
18 indicate the number of unknown hosts.
19
20 Note that the datadir will be read recursively, this makes it possible to place
21 the makelist output of different hosts in different subdirectories of netdata/.
22
23 Options:
24
25 -v
26 Be verbose
27
28 -o <outfile.dot>
29
30 Name for the dotty output file. The default is ./netmap.dot
31
32 -d <datadir>
33
34 Specify the datadir where the makelist output is located.
35
36
37 The
38 default is ../netdata.
39
40 -m <n>
41
42 Specify the maximum number of hops a node can be removed from the
43 start. 0 gives no maximum, which is the default.
44
45 -i
46
47 With this option netmap will create a directional dotty graph. This
48 option gives a better result when drawing larger maps.
49
50 -n
51
52 Don't resolv hostnames.
53
54 -I <hostfile>
55
56 With this option you can specify a list of ip-hostname pairs, eg for
57 your local network. Lines in this file should start with the ip,
58 followed by the hostname. Lines that don't start with a numeric value
59 are ignored.
60
61 Example:
62
63 #Local network
64 192.168.0.1 alpha
65 192.168.0.42 beta
66 192.168.30.5 gamma
67
68
69 -C <cachedipfile>
70
71 Specify the file to use as local hostname cache. This file is read upon
72 when netmap starts and written when it ends. It has the same format as
73 the hostfile described for the -I option. The default value is
74 ./netmap.hostcache.
75
76 -F <failedipfile>
77
78 Netmap keeps a cache of all ips it failed to resolv. The default value
79 is ./netmap.failedip.
80
81 -s
82
83 By default netmap inserts an unknown host when one host in the route did
84 not reply on the traceroute, but the rest of the route is valid. When
85 this option is used, netmap will stop reading when an invalid host is
86 encountered in the traceroute output.
87
88 -V
89
90 Print version and exit.
91
92
93The output graph
94================
95
96The first node in a graph will be a parallelogram. For all other nodes, the
97shape and the color depends on the number of links it has to other nodes
98
99Legend:
100
101 Number of links Shape Color
102 2 ellipse cornsilk
103 3 box lightsalmon
104 4 box orange
105 5 box orangered
106 6 box crimson
107 >= 7 box maroon
108
109 Invalid host triangle red
110
111See legend.dot for a graphical version.
112