81 lines
2.5 KiB
Groff
81 lines
2.5 KiB
Groff
.\" $NetBSD: shmif_dumpbus.1,v 1.2 2011/01/12 19:53:12 wiz Exp $
|
|
.\"
|
|
.\" Copyright (c) 2011 Antti Kantee. All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.Dd January 12, 2011
|
|
.Dt SHMIF_DUMPBUS 1
|
|
.Os
|
|
.Sh NAME
|
|
.Nm shmif_dumpbus
|
|
.Nd examine shmif bus contents
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Fl h
|
|
.Op Fl p Ar pcapfile
|
|
.Ar busfile
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
utility examines the bus of an
|
|
.Xr shmif 4
|
|
Ethernet interface.
|
|
The most useful feature is converting the bus to the
|
|
.Xr pcap 3
|
|
file format for later examination.
|
|
.Nm
|
|
itself is limited to displaying only very basic information about
|
|
each frame.
|
|
.Pp
|
|
.Nm
|
|
accepts the following flags:
|
|
.Bl -tag -width xxxpcapfilexxx
|
|
.It Fl h
|
|
Print bus header only and skip contents.
|
|
.It Fl p Ar pcapfile
|
|
Convert bus contents to the
|
|
.Xr pcap 3
|
|
format and write the result to
|
|
.Ar pcapfile .
|
|
The file
|
|
.Fl
|
|
signifies stdout.
|
|
.El
|
|
.Sh EXAMPLES
|
|
Feed the busfile contents to pcap:
|
|
.Bd -literal -offset indent
|
|
$ shmif_dumpbus -p - busfile | tcpdump -r -
|
|
.Ed
|
|
.Sh SEE ALSO
|
|
.Xr pcap 3 ,
|
|
.Xr shmif 4 ,
|
|
.Xr tcpdump 8
|
|
.Sh CAVEATS
|
|
.Nm
|
|
does not lock the busfile and is best used for post-mortem analysis
|
|
of the bus traffic.
|
|
.Pp
|
|
The timestamp for each frame contains the sender's timestamp and
|
|
may not be monotonically increasing with respect to the frame order
|
|
in the dump.
|