docs/139605: [patch] Add basic examples to usbconfig man page

Warren Block wblock at wonkity.com
Wed Oct 14 15:30:02 UTC 2009


>Number:         139605
>Category:       docs
>Synopsis:       [patch] Add basic examples to usbconfig man page
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          sw-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Oct 14 15:30:02 UTC 2009
>Closed-Date:
>Last-Modified:
>Originator:     Warren Block
>Release:        8.0-RC1
>Organization:
>Environment:
FreeBSD lightning 8.0-RC1 FreeBSD 8.0-RC1 #5: Wed Oct 14 05:35:25 MDT 2009     root at lightning:/usr/obj/usr/src/sys/LIGHTNING  i386
>Description:
usbconfig man page shows no examples of what kind of input format to use.  usbconfig shows devices in the "ugen3.2" format but does not accept that format for input.
>How-To-Repeat:
Search the usbconfig(8) manpage for an example of whether usbconfig wants /dev/usb/3.2.0, ugen3.2, or any of a number of other possible formats.
>Fix:
Apply attached patch as a starting point.  More examples are needed, particularly about quirks.

Patch attached with submission follows:

--- usbconfig.8.orig	2009-10-14 08:59:00.000000000 -0600
+++ usbconfig.8	2009-10-14 09:22:24.000000000 -0600
@@ -49,5 +49,14 @@
 .It Fl h
 Show help and available commands.
 .El
+.Sh EXAMPLES
+.Pp
+List all USB devices:
+.Pp
+.Dl usbconfig
+.Pp
+Show information about the device on USB bus 1 at address 2:
+.Pp
+.Dl usbconfig -u 1 -a 2 dump_info
 .Sh SEE ALSO
 .Xr usb 4


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



More information about the freebsd-doc mailing list