diff options
author | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2019-05-08 20:57:33 +0200 |
---|---|---|
committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2019-05-08 20:57:33 +0200 |
commit | b38f89c49764f37ddd3a43779888e0f02fdfab2d (patch) | |
tree | 3d9a6ce5b5fcb96ff54b83038a7cbf8f63d933ff /usbhid-dump | |
parent | f3a05e2e368cf17f9882c8d358f2fa205eb1ead6 (diff) | |
download | usbutils-b38f89c49764f37ddd3a43779888e0f02fdfab2d.tar.gz |
usbhid-dump: move manpage to main directory out of subdir
This saves us some extra subdirectories that are not needed.
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'usbhid-dump')
-rw-r--r-- | usbhid-dump/Makefile.am | 2 | ||||
-rw-r--r-- | usbhid-dump/configure.ac | 3 | ||||
-rw-r--r-- | usbhid-dump/doc/.gitignore | 2 | ||||
-rw-r--r-- | usbhid-dump/doc/Makefile.am | 19 | ||||
-rw-r--r-- | usbhid-dump/doc/usbhid-dump.8 | 118 |
5 files changed, 2 insertions, 142 deletions
diff --git a/usbhid-dump/Makefile.am b/usbhid-dump/Makefile.am index 33d1b4f..83db5f7 100644 --- a/usbhid-dump/Makefile.am +++ b/usbhid-dump/Makefile.am @@ -16,7 +16,7 @@ # along with usbhid-dump; if not, write to the Free Software # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -SUBDIRS = include lib src doc +SUBDIRS = include lib src dist_noinst_SCRIPTS = bootstrap diff --git a/usbhid-dump/configure.ac b/usbhid-dump/configure.ac index 3422710..f469f34 100644 --- a/usbhid-dump/configure.ac +++ b/usbhid-dump/configure.ac @@ -97,6 +97,5 @@ AC_CONFIG_FILES([Makefile include/Makefile include/uhd/Makefile lib/Makefile - src/Makefile - doc/Makefile]) + src/Makefile]) AC_OUTPUT diff --git a/usbhid-dump/doc/.gitignore b/usbhid-dump/doc/.gitignore deleted file mode 100644 index b336cc7..0000000 --- a/usbhid-dump/doc/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -/Makefile -/Makefile.in diff --git a/usbhid-dump/doc/Makefile.am b/usbhid-dump/doc/Makefile.am deleted file mode 100644 index 4435bdb..0000000 --- a/usbhid-dump/doc/Makefile.am +++ /dev/null @@ -1,19 +0,0 @@ -# Copyright (C) 2010 Nikolai Kondrashov -# -# This file is part of usbhid-dump. -# -# Usbhid-dump is free software; you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation; either version 2 of the License, or -# (at your option) any later version. -# -# Usbhid-dump is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with usbhid-dump; if not, write to the Free Software -# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - -dist_man_MANS = usbhid-dump.8 diff --git a/usbhid-dump/doc/usbhid-dump.8 b/usbhid-dump/doc/usbhid-dump.8 deleted file mode 100644 index 92753e7..0000000 --- a/usbhid-dump/doc/usbhid-dump.8 +++ /dev/null @@ -1,118 +0,0 @@ -.\" Process this file with -.\" groff -man -Tascii usbhid-dump.8 -.\" -.\" This file is part of usbhid-dump. -.\" -.\" Usbhid-dump is free software; you can redistribute it and/or modify -.\" it under the terms of the GNU General Public License as published by -.\" the Free Software Foundation; either version 2 of the License, or -.\" (at your option) any later version. -.\" -.\" Usbhid-dump is distributed in the hope that it will be useful, -.\" but WITHOUT ANY WARRANTY; without even the implied warranty of -.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.\" GNU General Public License for more details. -.\" -.\" You should have received a copy of the GNU General Public License -.\" along with usbhid-dump; if not, write to the Free Software -.\" Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -.\" -.TH usbhid-dump "8" "February 2012" -.SH NAME -usbhid-dump \- dump USB HID device report descriptors and streams -.SH SYNOPSIS -.B usbhid-dump -[OPTION]... -.SH DESCRIPTION -.B usbhid-dump -uses -.B libusb -to dump report descriptors and streams from HID (human interface device) -interfaces of USB devices. By default, it dumps HID interfaces of all -connected USB devices, but could be limited to a subset of them, or to a single -interface, using options. - -NOTE: usbhid-dump detaches kernel drivers from the interfaces it dumps and uses -them exclusively, so no other program receives the input in the meantime. The -report descriptor dumping is instantaneous, but the stream dumping continues -until terminated with SIGINT (^C from the terminal) or a timeout expires. - -If you accidentally start dumping a stream from the USB keyboard you use to -control the terminal, the system will stop receiving the input and you won't -be able to terminate usbhid-dump. Just stop your input and wait until the -timeout expires. The stream dumping will stop, the keyboard will be -reattached to the kernel driver and you will regain control. - -The default stream dumping timeout is 60 seconds and could be changed with the --t option. -.SH OPTIONS -.TP -.B -h, --help -Output a help message and exit. -.TP -.B -v, --version -Output version information and exit. -.TP -.B -s, -a, --address=bus[:dev] -Limit interfaces by bus number and device address. Both 1-255, decimal. -Zeroes match any bus or device. -.TP -.B -d, -m, --model=vid[:pid] -Limit interfaces by device vendor and product IDs. Both 1-FFFF, hexadecimal. -Zeroes match any vendor or product. -.TP -.B -i, --interface=NUMBER -Limit interfaces by number (0-254), decimal. 255 matches any interface. -.TP -.B -e, --entity=STRING -The entity to dump: either "descriptor", "stream" or "all". The value can be -abbreviated down to one letter. The default is "descriptor". -.TP -.B -t, --stream-timeout=NUMBER -Stream interrupt transfer timeout, ms. Zero means infinity. The default is -60000 (60 seconds). -.TP -.B -p, --stream-paused -Start with the stream dump output paused. -.TP -.B -f, --stream-feedback -Enable stream dumping feedback: print a dot to stderr for every transfer -dumped. -.SH SIGNALS -.TP -.B USR1/USR2 -Pause/resume stream dump output. -.SH OUTPUT FORMAT -.B usbhid-dump -outputs dumps in chunks. Each chunk is separated by an empty line and starts -with the following header line: - -BUS:DEVICE:INTERFACE:ENTITY TIMESTAMP - -Here, BUS, DEVICE and INTERFACE are bus, device and interface numbers -respectively. ENTITY is either "DESCRIPTOR" or "STREAM". TIMESTAMP is -timestamp in seconds since epoch. - -After the header the actual dump data follows as hex bytes. A descriptor -chunk includes the whole report descriptor. Every stream chunk includes a -whole report, usually, but if a report is bigger than endpoint's -wMaxPacketSize, it will span several chunks. -.SH EXAMPLES -.TP -Dump report descriptor for a device with address 3 on bus number 2: -.B usbhid-dump -a 2:3 - -.TP -Dump report stream for a device with vendor ID 0x5543 and product ID 0x0005: -.B usbhid-dump -m 5543:0005 -es - -.TP -Dump report descriptor from interface 1 of a device with vendor ID 0x5543: -.B usbhid-dump -m 5543 -i 1 -ed - -.TP -Dump report streams from all HID interfaces of all USB devices (caution: you will lose control over the terminal if you use USB keyboard): -.B usbhid-dump -es - -.SH AUTHOR -Nikolai Kondrashov <spbnick@gmail.com> |