summaryrefslogtreecommitdiffstats
path: root/usr.sbin
diff options
context:
space:
mode:
authorweongyo <weongyo@FreeBSD.org>2011-01-13 16:37:12 +0000
committerweongyo <weongyo@FreeBSD.org>2011-01-13 16:37:12 +0000
commitd3183a65c9e24fe00dcccaf85ef60f8badbe1128 (patch)
tree7716fe2a6730d356290b2dcef310b423c44895cc /usr.sbin
parent393b39d5b3ea27996a36c627fd8ccab74bc90888 (diff)
downloadFreeBSD-src-d3183a65c9e24fe00dcccaf85ef60f8badbe1128.zip
FreeBSD-src-d3183a65c9e24fe00dcccaf85ef60f8badbe1128.tar.gz
Documents OUTPUT formats. While I'm here cleans up styles and words.
Reviewed by: brueffer@
Diffstat (limited to 'usr.sbin')
-rw-r--r--usr.sbin/usbdump/usbdump.877
1 files changed, 66 insertions, 11 deletions
diff --git a/usr.sbin/usbdump/usbdump.8 b/usr.sbin/usbdump/usbdump.8
index edd883a..f2b00e4 100644
--- a/usr.sbin/usbdump/usbdump.8
+++ b/usr.sbin/usbdump/usbdump.8
@@ -25,7 +25,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd October 14, 2010
+.Dd December 4, 2010
.Dt usbdump 8
.Os
.Sh NAME
@@ -41,24 +41,29 @@
.Sh DESCRIPTION
The
.Nm
-utility provides a way to dump USB packets on each host controller.
+utility provides a way to dump USB packets on host controllers.
.Pp
-The following options are accepted.
+The following options are accepted:
.Bl -tag -width ".Fl f Ar file"
.It Fl i Ar ifname
-Listen on USB bus interface.
+Listen on USB bus interface
+.Ar ifname .
.It Fl r Ar file
-Read the raw packets from file.
+Read the raw packets from
+.Ar file .
.It Fl s Ar snaplen
-Snapshot bytes from each packet.
+Snapshot
+.Ar snaplen
+bytes from each packet.
.It Fl v
Enable debugging messages.
-When it defined multiple times the verbose level increases.
+When defined multiple times the verbosity level increases.
.It Fl w Ar file
-Write the raw packets to file.
+Write the raw packets to
+.Ar file .
.El
.Sh EXAMPLES
-Captures the USB raw packets alive on usbus2:
+Captures USB raw packets on usbus2:
.Pp
.Dl "usbdump -i usbus2 -s 256 -v"
.Pp
@@ -67,11 +72,61 @@ size limit:
.Pp
.Dl "usbdump -i usbus2 -s 0 -w /tmp/dump_pkts"
.Pp
-Read the USB raw packets from the file:
+Read the USB raw packets from previous file:
.Pp
.Dl "usbdump -r /tmp/dump_pkts -v"
+.Sh OUTPUT FORMAT
+The output format of
+.Nm
+is as follows:
+.Pp
+.Dl "<time> <bus>.<addr> <ep> <xfertype> <S/D> (<frames>/<length>) <...>"
+.Pp
+The meaning of the output format elements is as follows:
+.Bl -tag -width "<xfertype>"
+.It <time>
+A timestamp preceding all output lines.
+The timestamp has the format "hh:mm:ss.frac" and is as accurate as
+the kernel's clock.
+.It <bus>
+The USB host controller's bus unit number.
+.It <addr>
+The unique number of the USB device as allocated by the host controller driver.
+.It <ep>
+The USB endpoint address that indicates whether the address is
+.Dv OUT
+or
+.Dv IN .
+.It <xfertype>
+The USB transfer type.
+Can be
+.Dv CTRL ,
+.Dv ISOC ,
+.Dv BULK
+or
+.Dv INTR .
+.It <S/D>
+`S' indicates a USB submit.
+`D' indicates a USB transfer done.
+.It <frames>
+Numbers of frames in this packets.
+If this is a USB submit, its value is
+.Li xfer->nframes
+which means how many frames are acceptable or registered to transfer.
+If this is a USB done,
+.Li xfer->aframes
+is the actual number of frames.
+.It <length>
+Total packet size.
+If this is a USB submit, its value is
+.Li xfer->sumlen .
+If this is a USB done, its value is
+.Li xfer->actlen .
+.It <...>
+Optional field used for printing an error string if the packet is from USB done.
+.El
.Sh SEE ALSO
.Xr usbconfig 8
.Sh AUTHORS
.An Weongyo Jeong
-.Aq weongyo@FreeBSD.org .
+.Aq weongyo@FreeBSD.org
OpenPOWER on IntegriCloud