diff --git a/usr.sbin/usbdump/usbdump.8 b/usr.sbin/usbdump/usbdump.8 index 33b759e3406d..96be9f738e2d 100644 --- a/usr.sbin/usbdump/usbdump.8 +++ b/usr.sbin/usbdump/usbdump.8 @@ -1,183 +1,186 @@ .\" .\" Copyright (c) 2010 Weongyo Jeong. .\" 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 May 14, 2021 .Dt USBDUMP 8 .Os .Sh NAME .Nm usbdump .Nd "dump traffic on USB host controller" .Sh SYNOPSIS .Nm .Op Fl d Ar [ugen]B .Op Fl d Ar [ugen]B.D .Op Fl d Ar [ugen]B.D.E .Op Fl i Ar ifname .Op Fl r Ar file .Op Fl s Ar snaplen +.Op Fl u .Op Fl v .Op Fl w Ar file .Op Fl f Ar filter .Op Fl b Ar file .Op Fl h .Sh DESCRIPTION The .Nm utility provides a way to dump USB packets on host controllers. .Pp The following options are accepted: .Bl -tag -width ".Fl f Ar file" .It Fl d Ar [ugen]bus Shortcut for .Fl i option. The argument may be prefixed by "ugen". The option may be specified multiple times, but the bus specified must be the same. .It Fl d Ar [ugen]bus.device Shortcut for .Fl i and .Fl f options. The argument may be prefixed by "ugen". The option may be specified multiple times, but the bus specified must be the same. .It Fl d Ar [ugen]bus.device.endpoint Shortcut for .Fl i and .Fl f options. The argument may be prefixed by "ugen". The option may be specified multiple times, but the bus specified must be the same. .It Fl b Ar file Store data part of the USB trace in binary format to the given .Ar file . This option also works with the -r and -f options. .It Fl i Ar ifname Listen on USB bus interface .Ar ifname . .It Fl r Ar file Read the raw packets from .Ar file . This option also works with the -f option. .It Fl s Ar snaplen Snapshot .Ar snaplen bytes from each packet. +.It Fl u +Unbuffered output. .It Fl v Enable debugging messages. When defined multiple times the verbosity level increases. .It Fl w Ar file Write the raw packets to .Ar file . This option also works with the -s and -v options. .It Fl f Ar filter The filter argument consists of either one or two numbers separated by a dot. The first indicates the device unit number which should be traced. The second number which is optional indicates the endpoint which should be traced. To get all traffic for the control endpoint, two filters should be created, one for endpoint 0 and one for endpoint 128. If 128 is added to the endpoint number that means IN direction, else OUT direction is implied. A device unit or endpoint value of -1 means ignore this field. If no filters are specified, all packets are passed through using the default -1,-1 filter. This option can be specified multiple times. .It Fl h This option displays a summary of the command line options. .El .Sh EXAMPLES Capture the USB raw packets on usbus2: .Pp .Dl "usbdump -i usbus2 -s 256 -v" .Pp Dump the USB raw packets of usbus2 into the file without packet size limit: .Pp .Dl "usbdump -i usbus2 -s 0 -w /tmp/dump_pkts" .Pp Dump the USB raw packets of usbus2, but only the control endpoint traffic of device unit number 3: .Pp .Dl "usbdump -i usbus2 -s 0 -f 3.0 -f 3.128 -w /tmp/dump_pkts" .Pp Read and display 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 "