From nobody@FreeBSD.org  Wed Oct 14 15:23:54 2009
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id A4DC9106566C
	for <freebsd-gnats-submit@FreeBSD.org>; Wed, 14 Oct 2009 15:23:54 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (www.freebsd.org [IPv6:2001:4f8:fff6::21])
	by mx1.freebsd.org (Postfix) with ESMTP id 93E398FC18
	for <freebsd-gnats-submit@FreeBSD.org>; Wed, 14 Oct 2009 15:23:54 +0000 (UTC)
Received: from www.freebsd.org (localhost [127.0.0.1])
	by www.freebsd.org (8.14.3/8.14.3) with ESMTP id n9EFNsgO050587
	for <freebsd-gnats-submit@FreeBSD.org>; Wed, 14 Oct 2009 15:23:54 GMT
	(envelope-from nobody@www.freebsd.org)
Received: (from nobody@localhost)
	by www.freebsd.org (8.14.3/8.14.3/Submit) id n9EFNriA050586;
	Wed, 14 Oct 2009 15:23:53 GMT
	(envelope-from nobody)
Message-Id: <200910141523.n9EFNriA050586@www.freebsd.org>
Date: Wed, 14 Oct 2009 15:23:53 GMT
From: Warren Block <wblock@wonkity.com>
To: freebsd-gnats-submit@FreeBSD.org
Subject: [patch] Add basic examples to usbconfig man page
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         139605
>Category:       docs
>Synopsis:       [patch] Add basic examples to usbconfig(8)
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    brueffer
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          sw-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Oct 14 15:30:02 UTC 2009
>Closed-Date:    Sun Nov 08 13:09:08 CET 2009
>Last-Modified:  Sun Nov 08 13:09:08 CET 2009
>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@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:
State-Changed-From-To: open->patched 
State-Changed-By: brueffer 
State-Changed-When: Sun Nov 1 12:39:14 CET 2009 
State-Changed-Why:  
I've committed a slightly different version, as some of the 
information was really missing from the DESCRIPTION section. 
Thanks! 


Responsible-Changed-From-To: freebsd-doc->brueffer 
Responsible-Changed-By: brueffer 
Responsible-Changed-When: Sun Nov 1 12:39:14 CET 2009 
Responsible-Changed-Why:  
MFC reminder. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=139605 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/139605: commit references a PR
Date: Sun,  1 Nov 2009 11:39:22 +0000 (UTC)

 Author: brueffer
 Date: Sun Nov  1 11:39:07 2009
 New Revision: 198750
 URL: http://svn.freebsd.org/changeset/base/198750
 
 Log:
   Expand DESCRIPTION and a basic EXAMPLES section.
   
   PR:		139605
   Submitted by:	Warren Block <wblock@wonkity.com>
   MFC after:	1 week
 
 Modified:
   head/usr.sbin/usbconfig/usbconfig.8
 
 Modified: head/usr.sbin/usbconfig/usbconfig.8
 ==============================================================================
 --- head/usr.sbin/usbconfig/usbconfig.8	Sun Nov  1 11:34:13 2009	(r198749)
 +++ head/usr.sbin/usbconfig/usbconfig.8	Sun Nov  1 11:39:07 2009	(r198750)
 @@ -23,7 +23,7 @@
  .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  .\" SUCH DAMAGE.
  .\"
 -.Dd Sep 28, 2008
 +.Dd November 1, 2009
  .Dt USBCONFIG 8
  .Os
  .Sh NAME
 @@ -49,5 +49,13 @@ Should only be used in conjunction with 
  .It Fl h
  Show help and available commands.
  .El
 +.Pp
 +When called without options,
 +.Nm
 +prints a list of all available USB devices.
 +.Sh EXAMPLES
 +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
 _______________________________________________
 svn-src-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-src-all
 To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
 
State-Changed-From-To: patched->closed 
State-Changed-By: brueffer 
State-Changed-When: Sun Nov 8 13:08:53 CET 2009 
State-Changed-Why:  
MFC done. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=139605 
>Unformatted:
