Bug 139605

Summary: [patch] Add basic examples to usbconfig(8)
Product: Documentation Reporter: Warren Block <wblock>
Component: Books & ArticlesAssignee: Christian Brueffer <brueffer>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description Warren Block 2009-10-14 16:30:02 UTC 
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.

Fix: Apply attached patch as a starting point.  More examples are needed, particularly about quirks.

Patch attached with submission follows:
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.
Comment 1 Christian Brueffer freebsd_committer freebsd_triage 2009-11-01 11:39:14 UTC 
State Changed
From-To: open->patched

I've committed a slightly different version, as some of the 
information was really missing from the DESCRIPTION section. 
Thanks!
Comment 2 Christian Brueffer freebsd_committer freebsd_triage 2009-11-01 11:39:14 UTC 
Responsible Changed
From-To: freebsd-doc->brueffer

MFC reminder.
Comment 3 dfilter service freebsd_committer freebsd_triage 2009-11-01 11:39:22 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"
Comment 4 Christian Brueffer freebsd_committer freebsd_triage 2009-11-08 12:08:53 UTC 
State Changed
From-To: patched->closed

MFC done.