Skip site navigation (1)Skip section navigation (2)
Date:      Sat, 29 Apr 2017 16:44:36 +0000 (UTC)
From:      Ngie Cooper <ngie@FreeBSD.org>
To:        src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-head@freebsd.org
Subject:   svn commit: r317594 - head/share/man/man4
Message-ID:  <201704291644.v3TGiaDt047655@repo.freebsd.org>

next in thread | raw e-mail | index | archive | help
Author: ngie
Date: Sat Apr 29 16:44:36 2017
New Revision: 317594
URL: https://svnweb.freebsd.org/changeset/base/317594

Log:
  usb(4): manpage cleanup
  
  1. Wrap at <80 columns for readability when editing. Rewrap some lines
     prematurely wrapped to better fit in <80 columns and not waste
     vertical space.
  2. Fix SEE ALSO sorting (sort by section first, then manpage name).
  3. Tweak the compound device description slightly by adding soft stops
     via commas.
  
  MFC after:	1 week
  Reported by:	igor [3], manlint [2]
  Sponsored by Dell EMC Isilon

Modified:
  head/share/man/man4/usb.4

Modified: head/share/man/man4/usb.4
==============================================================================
--- head/share/man/man4/usb.4	Sat Apr 29 15:35:30 2017	(r317593)
+++ head/share/man/man4/usb.4	Sat Apr 29 16:44:36 2017	(r317594)
@@ -24,7 +24,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd November 26, 2013
+.Dd April 29, 2017
 .Dt USB 4
 .Os
 .Sh NAME
@@ -78,8 +78,7 @@ bus.
 .Pp
 The
 .Nm uhub
-device will always be present as it is needed for the
-root hub.
+device will always be present as it is needed for the root hub.
 .Sh INTRODUCTION TO USB
 The
 .Tn USB
@@ -94,38 +93,34 @@ The most common USB speeds are:
 Each
 .Tn USB
 has a USB controller that is the master of the bus.
-The physical communication is simplex which means the host controller only communicates with one USB device at a time.
+The physical communication is simplex which means the host controller only
+communicates with one USB device at a time.
 .Pp
 There can be up to 127 devices connected to an USB HUB tree.
-The addresses are assigned
-dynamically by the host when each device is attached to the bus.
+The addresses are assigned dynamically by the host when each device is
+attached to the bus.
 .Pp
 Within each device there can be up to 16 endpoints.
-Each endpoint
-is individually addressed and the addresses are static.
+Each endpoint is individually addressed and the addresses are static.
 Each of these endpoints will communicate in one of four different modes:
 .Em control , isochronous , bulk ,
 or
 .Em interrupt .
 A device always has at least one endpoint.
-This endpoint has address 0 and is a control
-endpoint and is used to give commands to and extract basic data,
-such as descriptors, from the device.
+This endpoint has address 0 and is a control endpoint and is used to give
+commands to and extract basic data, such as descriptors, from the device.
 Each endpoint, except the control endpoint, is unidirectional.
 .Pp
 The endpoints in a device are grouped into interfaces.
-An interface is a logical unit within a device; e.g.\&
-a compound device with both a keyboard and a trackball would present
-one interface for each.
-An interface can sometimes be set into different modes,
-called alternate settings, which affects how it operates.
-Different alternate settings can have different endpoints
-within it.
+An interface is a logical unit within a device, e.g., a compound device with
+both a keyboard and a trackball, would present one interface for each.
+An interface can sometimes be set into different modes, called alternate
+settings, which affects how it operates.
+Different alternate settings can have different endpoints within it.
 .Pp
 A device may operate in different configurations.
-Depending on the
-configuration, the device may present different sets of endpoints
-and interfaces.
+Depending on the configuration, the device may present different sets of
+endpoints and interfaces.
 .Pp
 The bus enumeration of the
 .Tn USB
@@ -144,7 +139,6 @@ specifications can be found at:
 .D1 Pa http://www.usb.org/developers/docs/
 .Pp
 .Xr libusb 3 ,
-.Xr usbdi 9 ,
 .Xr aue 4 ,
 .Xr axe 4 ,
 .Xr axge 4 ,
@@ -166,8 +160,9 @@ specifications can be found at:
 .Xr uplcom 4 ,
 .Xr urio 4 ,
 .Xr uvscom 4 ,
-.Xr usbconfig 8 ,
 .Xr xhci 4
+.Xr usbconfig 8 ,
+.Xr usbdi 9 ,
 .Sh STANDARDS
 The
 .Nm



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201704291644.v3TGiaDt047655>