Debian Codegraph @

upstream/debian-unstable/man8/rtmon.8

raw
1 .TH RTMON 8
2 .SH "NAME"
3 rtmon \- listens to and monitors RTnetlink
4 .SH "SYNOPSIS"
5 .sp
6 .ad l
7 .in +8
8 .ti -8
9 .B "rtmon"
10 .RI "[ " OPTIONS " ] "
11 .BI "file " FILE
12 .BR "[ " all
13 .RI "| " OBJECTS
14 .RB "]"
15
16 .ti -8
17 .IR OPTIONS
18 .RI ":= { f[amily] { inet | inet6 | link | help } |"
19 .RI "-4 | -6 | -0 | -V[ersion] }"
20
21 .ti -8
22 .I OBJECTS
23 .B ":= [" link "]" "[" address "]" "[" route "]"
24
25 .SH DESCRIPTION
26 This manual page documents briefly the
27 .B rtmon
28 command.
29 .PP
30 .B rtmon
31 listens on
32 .I netlink
33 socket and monitors routing table changes.
34
35 .I rtmon
36 can be started before the first network configuration command is issued.
37 For example if you insert:
38
39 .B rtmon file /var/log/rtmon.log
40
41 in a startup script, you will be able to view the full history later.
42 Certainly, it is possible to start rtmon at any time. It prepends the history with the state snapshot dumped at the moment of starting.
43
44 .SH OPTIONS
45 .I rtmon supports the following options:
46 .TP
47 .B \-Version
48 Print version and exit.
49 .TP
50 .B help
51 Show summary of options.
52 .TP
53 .B file FILE [ all | OBJECTS ]
54 Log output to FILE. OBJECTS is the list of object types that we
55 want to monitor. It may contain 'link', 'address', 'route'
56 and 'all'. 'link' specifies the network device, 'address' the protocol
57 (IP or IPv6) address on a device, 'route' the routing table entry
58 and 'all' does what the name says.
59 .TP
60 .B \-family [ inet | inet6 | link | help ]
61 Specify protocol family. 'inet' is IPv4, 'inet6' is IPv6, 'link'
62 means that no networking protocol is involved and 'help' prints usage information.
63 .TP
64 .B \-4
65 Use IPv4. Shortcut for -family inet.
66 .TP
67 .B \-6
68 Use IPv6. Shortcut for -family inet6.
69 .TP
70 .B \-0
71 Use a special family identifier meaning that no networking protocol is involved. Shortcut for -family link.
72 .SH USAGE EXAMPLES
73 .TP
74 .B # rtmon file /var/log/rtmon.log
75 Log to file /var/log/rtmon.log, then run:
76 .TP
77 .B # ip monitor file /var/log/rtmon.log
78 to display logged output from file.
79 .SH SEE ALSO
80 .BR ip (8)
81 .BR ip-monitor (8)
82 .SH AUTHOR
83 .B rtmon
84 was written by Alexey Kuznetsov <[email protected]>.
85 .PP
86 This manual page was written by Michael Prokop <[email protected]>,
87 for the Debian project (but may be used by others).