docs/103420: [patch] usbhidctl(1): update manual page to include write support

Rene Ladan r.c.ladan at gmail.com
Wed Sep 20 14:40:41 UTC 2006


>Number:         103420
>Category:       docs
>Synopsis:       [patch] usbhidctl(1): update manual page to include write support
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          change-request
>Submitter-Id:   current-users
>Arrival-Date:   Wed Sep 20 14:40:26 GMT 2006
>Closed-Date:
>Last-Modified:
>Originator:     Rene Ladan
>Release:        FreeBSD 6.2 PRELEASE i386 2006-09-19
>Organization:
>Environment:
FreeBSD s000655.campus.tue.nl 6.2-PRERELEASE FreeBSD 6.2-PRERELEASE #5: Tue Sep 19 21:13:50 CEST 2006     root at s000655.campus.tue.nl:/usr/obj/usr/src6/sys/RENE  i386

>Description:
Update the usbhidctl manual page to include write support by adding a
description of the -w flag and updating the BUGS section.

Also bump .Dd to 2006-09-20

[linimon's note while rescuing from GNATS spam-queue: this needs to be
committed only after the usb PR for usbhidctl from the same submitter]
>How-To-Repeat:

>Fix:
--- /usr/src/usr.bin/usbhidctl/usbhidctl.1	Tue Jan 18 14:43:55 2005
+++ usbhidctl.1	Tue Sep 19 23:46:47 2006
@@ -35,7 +35,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd July 12, 1998
+.Dd September 20, 2006
 .Dt USBHIDCTL 1
 .Os
 .Sh NAME
@@ -51,13 +51,22 @@
 .Op Fl t Ar table
 .Op Fl v
 .Op Ar item ...
+.Nm
+.Fl f Ar device
+.Op t ar table
+.Fl w Ar name Ns = Ar value ...
 .Sh DESCRIPTION
 The
 .Nm
-utility can be used to dump the state of a USB HID (Human Interface Device).
+utility can be used to dump or modify the state of a USB HID (Human Interface Device).
 Each named
 .Ar item
 is printed.
+If the
+.Fl w
+flag is specified
+.Nm
+attempts to set the specified items to the given values.
 .Pp
 The options are as follows:
 .Bl -tag -width Ds
@@ -67,6 +76,7 @@
 Specify a path name for the device to operate on.
 .It Fl l
 Loop and dump the device data every time it changes.
+Only 'input' items are displayed in this mode.
 .It Fl n
 Suppress printing of the item name.
 .It Fl r
@@ -75,6 +85,9 @@
 Specify a path name for the HID usage table file.
 .It Fl v
 Be verbose.
+.It Fl w
+Change item values.
+Only 'output' and 'feature' kinds can be set with this option.
 .El
 .Sh FILES
 .Pa /usr/share/misc/usb_hid_usages
@@ -91,4 +104,4 @@
 .Sh BUGS
 The
 .Nm
-utility cannot show nor set output and feature items.
+utility cannot show feature items.

>Release-Note:
>Audit-Trail:
>Unformatted:



More information about the freebsd-doc mailing list