netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [IPROUTE] manpage for rtmon
@ 2006-10-27 17:22 Michael Prokop
  2006-10-27 17:37 ` Stephen Hemminger
  0 siblings, 1 reply; 2+ messages in thread
From: Michael Prokop @ 2006-10-27 17:22 UTC (permalink / raw)
  To: netdev; +Cc: Stephen Hemminger


[-- Attachment #1.1: Type: text/plain, Size: 284 bytes --]

Hello,

another manpage, this time for rtmon. Would be great if it could be
applied to the next release too.

regards,
-mika-
-- 
 ,'"`.         http://www.michael-prokop.at/
(  grml.org -» Linux Live-CD for texttool-users and sysadmins
 `._,'         http://www.grml.org/

[-- Attachment #1.2: rtmon.8 --]
[-- Type: text/plain, Size: 1948 bytes --]

.TH RTMON 8
.SH NAME
rtmon \- listens to and monitors RTnetlink
.SH SYNOPSIS
.B rtmon
.RI "[ options ] file FILE [ all | LISTofOBJECTS ]"
.SH DESCRIPTION
This manual page documents briefly the
.B rtmon
command.
.PP
\fBrtmon\fP is a RTnetlink listener. RTnetlink allows the kernel's routing tables to be read and altered.

rtmon should be started before the first network configuration command is issued. For example if you insert:

 rtmon file /var/log/rtmon.log

in a startup script, you will be able to view the full history later.
Certainly, it is possible to start rtmon at any time. It prepends the history with the state snapshot dumped at the moment of starting.
.SH OPTIONS
rtmon supports the following options:
.TP
.B \-Version
Print version and exit.
.TP
.B help
Show summary of options.
.TP
.B file FILE [ all | LISTofOBJECTS ]
Log output to FILE. LISTofOBJECTS is the list of object types that we want to monitor.
It may contain 'link', 'address', 'route' and 'all'. 'link' specifies the network device, 'address'
the protocol (IP or IPv6) address on a device, 'route' the routing table entry and 'all' does what the name says.
.TP
.B \-family [ inet | inet6 | link | help ]
Specify protocol family. 'inet' is IPv4, 'inet6' is IPv6, 'link' means that no networking protocol is involved and 'help' prints usage information.
.TP
.B \-4
Use IPv4. Shortcut for -family inet.
.TP
.B \-6
Use IPv6. Shortcut for -family inet6.
.TP
.B \-0
Use a special family identifier meaning that no networking protocol is involved. Shortcut for -family link.
.SH USAGE EXAMPLES
.TP
.B # rtmon file /var/log/rtmon.log
Log to file /var/log/rtmon.log, then run:
.TP
.B # ip monitor file /var/log/rtmon.log
to display logged output from file.
.SH SEE ALSO
.BR ip (8)
.SH AUTHOR
rtmon was written by Alexey Kuznetsov <kuznet@ms2.inr.ac.ru>.
.PP
This manual page was written by Michael Prokop <mika@grml.org>,
for the Debian project (but may be used by others).

[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2006-10-27 17:37 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2006-10-27 17:22 [IPROUTE] manpage for rtmon Michael Prokop
2006-10-27 17:37 ` Stephen Hemminger

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).