xref: /netbsd-src/usr.bin/shmif_dumpbus/shmif_dumpbus.1 (revision 3117ece4fc4a4ca4489ba793710b60b0d26bab6c)
1.\"	$NetBSD: shmif_dumpbus.1,v 1.2 2011/01/12 19:53:12 wiz Exp $
2.\"
3.\" Copyright (c) 2011 Antti Kantee.  All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.Dd January 12, 2011
27.Dt SHMIF_DUMPBUS 1
28.Os
29.Sh NAME
30.Nm shmif_dumpbus
31.Nd examine shmif bus contents
32.Sh SYNOPSIS
33.Nm
34.Op Fl h
35.Op Fl p Ar pcapfile
36.Ar busfile
37.Sh DESCRIPTION
38The
39.Nm
40utility examines the bus of an
41.Xr shmif 4
42Ethernet interface.
43The most useful feature is converting the bus to the
44.Xr pcap 3
45file format for later examination.
46.Nm
47itself is limited to displaying only very basic information about
48each frame.
49.Pp
50.Nm
51accepts the following flags:
52.Bl -tag -width xxxpcapfilexxx
53.It Fl h
54Print bus header only and skip contents.
55.It Fl p Ar pcapfile
56Convert bus contents to the
57.Xr pcap 3
58format and write the result to
59.Ar pcapfile .
60The file
61.Fl
62signifies stdout.
63.El
64.Sh EXAMPLES
65Feed the busfile contents to pcap:
66.Bd -literal -offset indent
67$ shmif_dumpbus -p - busfile | tcpdump -r -
68.Ed
69.Sh SEE ALSO
70.Xr pcap 3 ,
71.Xr shmif 4 ,
72.Xr tcpdump 8
73.Sh CAVEATS
74.Nm
75does not lock the busfile and is best used for post-mortem analysis
76of the bus traffic.
77.Pp
78The timestamp for each frame contains the sender's timestamp and
79may not be monotonically increasing with respect to the frame order
80in the dump.
81