Sync some USB serial driver manual pages with FreeBSD.
authorSascha Wildner <saw@online.de>
Tue, 11 Mar 2014 12:33:55 +0000 (13:33 +0100)
committerSascha Wildner <saw@online.de>
Tue, 11 Mar 2014 12:33:55 +0000 (13:33 +0100)
uark(4)
uchcom(4)
uftdi(4)
ulpt(4)
umct(4)
umodem(4)

share/man/man4/uark.4
share/man/man4/uchcom.4
share/man/man4/uftdi.4
share/man/man4/ulpt.4
share/man/man4/umct.4
share/man/man4/umodem.4

index 054cc5d..10af115 100644 (file)
@@ -14,7 +14,9 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd August 15, 2007
+.\" $FreeBSD: head/share/man/man4/uark.4 233648 2012-03-29 05:02:12Z eadler $
+.\"
+.Dd November 20, 2011
 .Dt UARK 4
 .Os
 .Sh NAME
@@ -25,8 +27,9 @@ To compile this driver into the kernel,
 place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device uark"
+.Cd "device usb"
 .Cd "device ucom"
+.Cd "device uark"
 .Ed
 .Pp
 Alternatively, to load the driver as a
@@ -39,10 +42,11 @@ uark_load="YES"
 The
 .Nm
 driver supports Arkmicro Technologies ARK3116 based serial adapters.
-.Pp
-The following devices should work with the
+.Sh HARDWARE
+The
 .Nm
-driver:
+driver supports the following adapters:
+.Pp
 .Bl -bullet -compact
 .It
 HL USB-RS232
@@ -64,12 +68,17 @@ device driver first appeared in
 .Ox 4.0
 and was imported into
 .Dx 1.11 .
+The first
+.Fx
+release to include it was
+.Fx 7.0 .
 .Sh AUTHORS
 .An -nosplit
 The
 .Nm
 driver was written by
-.An Jonathan Gray Aq Mt jsg@openbsd.org .
+.An Jonathan Gray
+.Aq Mt jsg@openbsd.org .
 .Sh CAVEATS
 Setting hardware flow control is not currently supported.
 It is not yet known how to ask the hardware to send a break.
index de98886..27826f5 100644 (file)
@@ -1,5 +1,4 @@
-.\" $NetBSD: uchcom.4,v 1.1 2007/09/03 18:02:17 tshiozak Exp $
-.\" $DragonFly: src/share/man/man4/uchcom.4,v 1.1 2007/11/07 09:07:44 hasso Exp $
+.\" $NetBSD: uchcom.4,v 1.2 2008/04/30 13:10:54 martin Exp $
 .\"
 .\" Copyright (c) 2007 The NetBSD Foundation, Inc.
 .\" All rights reserved.
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
-.\" 3. All advertising materials mentioning features or use of this software
-.\"    must display the following acknowledgement:
-.\"        This product includes software developed by the NetBSD
-.\"        Foundation, Inc. and its contributors.
-.\" 4. Neither the name of The NetBSD Foundation nor the names of its
-.\"    contributors may be used to endorse or promote products derived
-.\"    from this software without specific prior written permission.
 .\"
 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd November 11, 2007
+.\" $FreeBSD: head/share/man/man4/uchcom.4 227750 2011-11-20 12:18:21Z miwi $
+.\"
+.Dd November 20, 2011
 .Dt UCHCOM 4
 .Os
 .Sh NAME
 .Nm uchcom
-.Nd USB support for WinChipHead CH341/CH340 serial adapters driver
+.Nd WinChipHead CH341/CH340 serial adapter driver
 .Sh SYNOPSIS
 To compile this driver into the kernel,
 place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device uchcom"
+.Cd "device usb"
 .Cd "device ucom"
+.Cd "device uchcom"
 .Ed
 .Pp
 Alternatively, to load the driver as a
@@ -66,6 +61,15 @@ The device is accessed through the
 .Xr ucom 4
 driver which makes it behave like a
 .Xr tty 4 .
+.Sh HARDWARE
+The
+.Nm
+driver supports the following adapters:
+.Pp
+.Bl -bullet -compact
+.It
+HL USB-RS232
+.El
 .Sh SEE ALSO
 .Xr tty 4 ,
 .Xr ucom 4 ,
@@ -73,11 +77,14 @@ driver which makes it behave like a
 .Sh HISTORY
 The
 .Nm
-driver
-appeared in
-.Nx
-5.0 and was imported into
+driver first appeared in
+.Nx 5.0
+and was imported into
 .Dx 1.11 .
+The first
+.Fx
+release to include it was
+.Fx 8.0 .
 .Sh BUGS
 Actually, this chip seems unable to drive other than 8 data bits and
 1 stop bit line.
index 316896b..6da168e 100644 (file)
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
-.\" 3. All advertising materials mentioning features or use of this software
-.\"    must display the following acknowledgement:
-.\"        This product includes software developed by the NetBSD
-.\"        Foundation, Inc. and its contributors.
-.\" 4. Neither the name of The NetBSD Foundation nor the names of its
-.\"    contributors may be used to endorse or promote products derived
-.\"    from this software without specific prior written permission.
 .\"
 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/uftdi.4,v 1.1.2.1 2002/11/21 01:28:16 ticso Exp $
-.\" $DragonFly: src/share/man/man4/uftdi.4,v 1.5 2007/11/07 09:57:07 hasso Exp $
+.\" $FreeBSD: head/share/man/man4/uftdi.4 227750 2011-11-20 12:18:21Z miwi $
 .\"
-.Dd November 11, 2007
+.Dd November 20, 2011
 .Dt UFTDI 4
 .Os
 .Sh NAME
 .Nm uftdi
-.Nd USB support for serial devices based on the FTDI chips
+.Nd USB support for serial adapters based on the FT8U100AX and FT8U232AM chips
 .Sh SYNOPSIS
 To compile this driver into the kernel,
 place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device uftdi"
+.Cd "device usb"
 .Cd "device ucom"
+.Cd "device uftdi"
 .Ed
 .Pp
 Alternatively, to load the driver as a
@@ -61,40 +54,43 @@ uftdi_load="YES"
 .Sh DESCRIPTION
 The
 .Nm
-driver provides support for RS-232 (and possibly RS-485) virtual COM
-port functionality in various FTDI chips:
+driver provides support for various serial adapters based on the FTDI
+FT2232C, FT8U100AX and FT8U232AM chips.
+.Pp
+The device is accessed through the
+.Xr ucom 4
+driver which makes it behave like a
+.Xr tty 4 .
+.Sh HARDWARE
+The
+.Nm
+driver supports the following adapters:
 .Pp
-.Bl -dash -compact -offset indent
+.Bl -bullet -compact
+.It
+B&B Electronics USB->RS422/485 adapter
 .It
-FT8U100AX multi-function hub controller chip
+Elexol USB MOD1 and USB MOD3
 .It
-FT8U232AM USB UART chip
+HP USB-Serial adapter shipped with some HP laptops
 .It
-FT232 series USB UART chips
+Inland UAS111
 .It
-FT2232 series dual USB UART/FIFO chips
+QVS USC-1000
+.It
+Buffalo PC-OP-RS / Kurouto-shikou KURO-RS universal remote
+.It
+Prologix GPIB-USB Controller
 .El
-.Pp
-The
-.Nm
-driver doesn't support any other serial protocol supported by these chips.
-These protocols might be supported by libftdi userspace library.
-.Pp
-The device is accessed through the
-.Xr ucom 4
-driver which makes it behave like a
-.Xr tty 4 .
 .Sh SEE ALSO
 .Xr tty 4 ,
 .Xr ucom 4 ,
 .Xr usb 4
-.Rs
-.%T libftdi
-.%O http://www.intra2net.com/de/produkte/opensource/ftdi/
-.Re
 .Sh HISTORY
 The
 .Nm
 driver
 appeared in
+.Fx 4.8
+from
 .Nx 1.5 .
index 3dec491..cba1e49 100644 (file)
@@ -1,5 +1,4 @@
 .\" $NetBSD: ulpt.4,v 1.6 2002/02/05 00:37:48 augustss Exp $
-.\" $FreeBSD: src/share/man/man4/ulpt.4,v 1.2.2.2 2002/08/07 02:49:56 trhodes Exp $
 .\"
 .\" Copyright (c) 1999 The NetBSD Foundation, Inc.
 .\" All rights reserved.
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
-.\" 3. All advertising materials mentioning features or use of this software
-.\"    must display the following acknowledgment:
-.\"        This product includes software developed by the NetBSD
-.\"        Foundation, Inc. and its contributors.
-.\" 4. Neither the name of The NetBSD Foundation nor the names of its
-.\"    contributors may be used to endorse or promote products derived
-.\"    from this software without specific prior written permission.
 .\"
 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd July 12, 1998
+.\" $FreeBSD: head/share/man/man4/ulpt.4 235326 2012-05-12 07:01:21Z joel $
+.\"
+.Dd November 22, 2006
 .Dt ULPT 4
 .Os
 .Sh NAME
 .Nm ulpt
 .Nd USB printer support
 .Sh SYNOPSIS
+To compile this driver into the kernel,
+place the following line in your
+kernel configuration file:
+.Bd -ragged -offset indent
 .Cd "device ulpt"
+.Ed
+.Pp
+Alternatively, to load the driver as a
+module at boot time, place the following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+ulpt_load="YES"
+.Ed
 .Sh DESCRIPTION
 The
 .Nm
 driver provides support for USB printers that follow the printer
 bi- or uni-directional protocol.
 The bits in the minor number select various features of the driver.
-.Bl -column "Minor Bit" "Function" -offset indent
-.It Sy "Minor Bit" Ta Sy "Function"
-.It 64 Ta "Do not initialize (reset) the device on the port."
+.Bl -column "Minor Bit" "Functionxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -offset indent
+.It Em "Minor Bit" Ta Em "Function"
+.It "64" Ta "Do not initialize (reset) the device on the port."
 .El
 .Pp
 Some printers cannot handle the reset on open; in case of problems try the
 .Pa unlpt
 device.
+.Sh HARDWARE
+The
+.Nm
+driver provides support for USB printers and parallel printer
+conversion cables, including the following:
+.Pp
+.Bl -bullet -compact
+.It
+ATen parallel printer adapter
+.It
+Belkin F5U002 parallel printer adapter
+.It
+Canon BJ F850, S600
+.It
+Canon LBP-1310, 350
+.It
+Entrega USB-to-parallel printer adapter
+.It
+Hewlett-Packard HP Deskjet 3420 (P/N: C8947A #ABJ)
+.It
+Oki Data MICROLINE ML660PS
+.It
+Seiko Epson PM-900C, 880C, 820C, 730C
+.El
 .Sh FILES
 .Bl -tag -width ".Pa /dev/unlpt?" -compact
 .It Pa /dev/ulpt?
index 2964cc1..4c23091 100644 (file)
@@ -23,9 +23,9 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/umct.4,v 1.7 2006/11/22 21:30:02 brueffer Exp $
+.\" $FreeBSD: head/share/man/man4/umct.4 227750 2011-11-20 12:18:21Z miwi $
 .\"
-.Dd December 14, 2006
+.Dd November 20, 2011
 .Dt UMCT 4
 .Os
 .Sh NAME
@@ -36,8 +36,9 @@ To compile this driver into the kernel,
 place the following lines in your
 kernel configuration file:
 .Bd -ragged -offset indent
-.Cd "device umct"
+.Cd "device usb"
 .Cd "device ucom"
+.Cd "device umct"
 .Ed
 .Pp
 Alternatively, to load the driver as a
index 615d324..5a00969 100644 (file)
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
-.\" 3. All advertising materials mentioning features or use of this software
-.\"    must display the following acknowledgment:
-.\"        This product includes software developed by the NetBSD
-.\"        Foundation, Inc. and its contributors.
-.\" 4. Neither the name of The NetBSD Foundation nor the names of its
-.\"    contributors may be used to endorse or promote products derived
-.\"    from this software without specific prior written permission.
 .\"
 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.\" $FreeBSD: src/share/man/man4/umodem.4,v 1.2 2002/05/30 12:59:52 ru Exp $
+.\" $FreeBSD: head/share/man/man4/umodem.4 239090 2012-08-06 08:59:39Z glebius $
 .\"
-.Dd November 20, 2006
+.Dd August 6, 2012
 .Dt UMODEM 4
 .Os
 .Sh NAME
 .Nm umodem
 .Nd USB modem support
 .Sh SYNOPSIS
-.Cd "device umodem"
+To compile this driver into the kernel,
+place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
+.Cd "device usb"
 .Cd "device ucom"
+.Cd "device umodem"
+.Ed
+.Pp
+Alternatively, to load the driver as a
+module at boot time, place the following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+umodem_load="YES"
+.Ed
 .Sh DESCRIPTION
 The
 .Nm
@@ -62,6 +68,33 @@ The device is accessed through the
 .Xr ucom 4
 driver which makes it behave like a
 .Xr tty 4 .
+.Sh HARDWARE
+Devices supported by the
+.Nm
+driver include:
+.Pp
+.Bl -bullet -compact
+.It
+3Com 5605
+.It
+Curitel PC5740 Wireless Modem
+.It
+Kyocera AH-K3001V Mobile Phone(WILLCOM)
+.It
+Kyocera WX320K Mobile Phone(WILLCOM)
+.It
+Metricom Ricochet GS USB wireless modem
+.It
+Sierra MC5720 Wireless Modem
+.It
+Yamaha Broadband Wireless Router RTW65b
+.It
+ELSA MicroLink 56k USB modem
+.It
+Sony Ericsson W810i phone
+.It
+Sonim XP5300 Force
+.El
 .Sh SEE ALSO
 .Xr tty 4 ,
 .Xr ucom 4 ,