xref: /freebsd/share/man/man4/ucom.4 (revision 4fd2d3b6927878771635a3628ae1623daf810d39)
1.\" $NetBSD: ucom.4,v 1.9 2002/03/22 00:39:40 augustss Exp $
2.\"
3.\" Copyright (c) 1999 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Lennart Augustsson.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgment:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.\" $FreeBSD$
38.\"
39.Dd March 1, 2008
40.Dt UCOM 4
41.Os
42.Sh NAME
43.Nm ucom
44.Nd USB tty support
45.Sh SYNOPSIS
46To compile this driver into the kernel,
47place the following line in your
48kernel configuration file:
49.Bd -ragged -offset indent
50.Cd "device ucom"
51.Ed
52.Pp
53Alternatively, to load the driver as a
54module at boot time, place the following line in
55.Xr loader.conf 5 :
56.Bd -literal -offset indent
57ucom_load="YES"
58.Ed
59.Sh DESCRIPTION
60The
61.Nm
62driver attaches to USB modems, serial ports, and other devices that need
63to look like a tty.
64The
65.Nm
66driver shows a behavior like a
67.Xr tty 4 .
68This means that normal programs such as
69.Xr tip 1
70or
71.Xr pppd 8
72can be used to access the device.
73.Pp
74The
75.Va portno
76locater can be used to decide which port to use for devices that have
77multiple external ports.
78.Sh BUGS
79Prior to
80.Fx 6.0
81.Nm
82created
83.Pa /dev/ucom?
84rather than the uniform device names created today.
85Old scripts must be adjusted accordingly.
86.Sh FILES
87.Bl -tag -width ".Pa /dev/cuaU?"
88.It Pa /dev/cuaU?
89.It Pa /dev/ttyU?
90.El
91.Sh SEE ALSO
92.Xr tty 4 ,
93.Xr uark 4 ,
94.Xr uchcom 4 ,
95.Xr uftdi 4 ,
96.Xr umct 4 ,
97.Xr umodem 4 ,
98.Xr uplcom 4 ,
99.Xr usb 4 ,
100.Xr uvisor 4 ,
101.Xr uvscom 4
102.Sh HISTORY
103The
104.Nm
105driver was adopted from
106.Nx
107in March of 2002.
108This manual page was adopted from
109.Nx
110by
111.An Tom Rhodes Aq trhodes@FreeBSD.org
112in April 2002.
113