Sync ucom.4, uplcom.4 and uslcom.4 with FreeBSD.
[dragonfly.git] / share / man / man4 / ucom.4
CommitLineData
984263bc
MD
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.
984263bc
MD
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
6895167d 30.\" $FreeBSD: head/share/man/man4/ucom.4 222696 2011-06-04 20:40:24Z hselasky $
984263bc 31.\"
6895167d 32.Dd March 14, 2014
984263bc
MD
33.Dt UCOM 4
34.Os
35.Sh NAME
36.Nm ucom
37.Nd USB tty support
38.Sh SYNOPSIS
f5fc7b9c 39To compile this driver into the kernel,
6895167d 40place the following line in your
f5fc7b9c
HT
41kernel configuration file:
42.Bd -ragged -offset indent
43.Cd "device ucom"
44.Ed
45.Pp
46Alternatively, to load the driver as a
47module at boot time, place the following line in
48.Xr loader.conf 5 :
49.Bd -literal -offset indent
50ucom_load="YES"
51.Ed
984263bc
MD
52.Sh DESCRIPTION
53The
54.Nm
55driver attaches to USB modems, serial ports, and other devices that need
56to look like a tty.
57The
58.Nm
59driver shows a behavior like a
60.Xr tty 4 .
61This means that normal programs such as
62.Xr tip 1
63or
6895167d 64.Xr ppp 8
984263bc 65can be used to access the device.
6895167d
SW
66.Pp
67The
68.Va portno
69locater can be used to decide which port to use for devices that have
70multiple external ports.
984263bc 71.Sh FILES
6895167d
SW
72.Bl -tag -width ".Pa /dev/cuaU?"
73.It Pa /dev/cuaU?
74.It Pa /dev/ttyU?
984263bc
MD
75.El
76.Sh SEE ALSO
77.Xr tty 4 ,
6895167d 78.Xr u3g 4 ,
404f1930 79.Xr uark 4 ,
f5fc7b9c 80.Xr ubsa 4 ,
6895167d 81.Xr ubser 4 ,
474e48cc 82.Xr uchcom 4 ,
6895167d
SW
83.Xr ucycom 4 ,
84.Xr ufoma 4 ,
9a2bf651 85.Xr uftdi 4 ,
86906a69 86.Xr ugensa 4 ,
6895167d
SW
87.Xr uipaq 4 ,
88.Xr umcs 4 ,
9a2bf651 89.Xr umct 4 ,
ab08ccbf 90.Xr umodem 4 ,
6895167d 91.Xr umoscom 4 ,
984263bc
MD
92.Xr uplcom 4 ,
93.Xr usb 4 ,
f5fc7b9c 94.Xr uslcom 4 ,
984263bc
MD
95.Xr uvisor 4 ,
96.Xr uvscom 4
97.Sh HISTORY
98The
99.Nm
100driver was adopted from
101.Nx
102in March of 2002.
103This manual page was adopted from
104.Nx
105by
e18a87e3 106.An Tom Rhodes Aq Mt trhodes@FreeBSD.org
984263bc 107in April 2002.
6895167d
SW
108.Sh CAVEATS
109Up to
110.Dx 3.6
111.Nm
112created
113.Pa /dev/ucom?
114rather than the uniform device names created today.
115Old scripts must be adjusted accordingly.