~ubuntu-branches/ubuntu/precise/iproute/precise

« back to all changes in this revision

Viewing changes to debian/man/rtmon.8

  • Committer: Bazaar Package Importer
  • Author(s): Alexander Wirt, Andreas Henriksson, Justin B Rye, Alexander Wirt
  • Date: 2008-05-11 11:18:29 UTC
  • mfrom: (1.1.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20080511111829-rfewew7s6kiev0bh
Tags: 20080417-1
[ Andreas Henriksson ]
* New upstream release, v2.6.25 a.k.a. snapshot 20080417.
  - Initial documentation for xfrm (Partially fixes #451337)
  - Fixes manpage error caught by lintian!
* Fix typos (syntax error) in ip(8) manpage.
  - Introduced by upstream, caught by lintian yet again!
* Don't ship useless headers in iproute-dev (Closes: #467557)
* Cherry-pick "Fix bad hash calculation because of signed address" from
  upstream. (Closes: #480173)

[ Justin B Rye ]
* Update package description (Closes: #464521)

[ Alexander Wirt ]
* Fix typo in short package description.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH RTMON 8
2
 
.SH NAME
3
 
rtmon \- listens to and monitors RTnetlink
4
 
.SH SYNOPSIS
5
 
.B rtmon
6
 
.RI "[ options ] file FILE [ all | LISTofOBJECTS ]"
7
 
.SH DESCRIPTION
8
 
This manual page documents briefly the
9
 
.B rtmon
10
 
command.
11
 
.PP
12
 
\fBrtmon\fP is a RTnetlink listener. RTnetlink allows the kernel's routing tables to be read and altered.
13
 
 
14
 
rtmon should be started before the first network configuration command is issued. For example if you insert:
15
 
 
16
 
 rtmon file /var/log/rtmon.log
17
 
 
18
 
in a startup script, you will be able to view the full history later.
19
 
Certainly, it is possible to start rtmon at any time. It prepends the history with the state snapshot dumped at the moment of starting.
20
 
.SH OPTIONS
21
 
rtmon supports the following options:
22
 
.TP
23
 
.B \-Version
24
 
Print version and exit.
25
 
.TP
26
 
.B help
27
 
Show summary of options.
28
 
.TP
29
 
.B file FILE [ all | LISTofOBJECTS ]
30
 
Log output to FILE. LISTofOBJECTS is the list of object types that we want to monitor.
31
 
It may contain 'link', 'address', 'route' and 'all'. 'link' specifies the network device, 'address'
32
 
the protocol (IP or IPv6) address on a device, 'route' the routing table entry and 'all' does what the name says.
33
 
.TP
34
 
.B \-family [ inet | inet6 | link | help ]
35
 
Specify protocol family. 'inet' is IPv4, 'inet6' is IPv6, 'link' means that no networking protocol is involved and 'help' prints usage information.
36
 
.TP
37
 
.B \-4
38
 
Use IPv4. Shortcut for -family inet.
39
 
.TP
40
 
.B \-6
41
 
Use IPv6. Shortcut for -family inet6.
42
 
.TP
43
 
.B \-0
44
 
Use a special family identifier meaning that no networking protocol is involved. Shortcut for -family link.
45
 
.SH USAGE EXAMPLES
46
 
.TP
47
 
.B # rtmon file /var/log/rtmon.log
48
 
Log to file /var/log/rtmon.log, then run:
49
 
.TP
50
 
.B # ip monitor file /var/log/rtmon.log
51
 
to display logged output from file.
52
 
.SH SEE ALSO
53
 
.BR ip (8)
54
 
.SH AUTHOR
55
 
rtmon was written by Alexey Kuznetsov <kuznet@ms2.inr.ac.ru>.
56
 
.PP
57
 
This manual page was written by Michael Prokop <mika@grml.org>,
58
 
for the Debian project (but may be used by others).