Merge branch 'vendor/LIBARCHIVE'
[dragonfly.git] / share / man / man4 / ucom.4
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: src/share/man/man4/ucom.4,v 1.2.2.2 2002/08/12 20:32:05 joe Exp $
38 .\" $DragonFly: src/share/man/man4/ucom.4,v 1.10 2008/02/11 19:57:30 swildner Exp $
39 .\"
40 .Dd November 25, 1999
41 .Dt UCOM 4
42 .Os
43 .Sh NAME
44 .Nm ucom
45 .Nd USB tty support
46 .Sh SYNOPSIS
47 To compile this driver into the kernel,
48 place the following lines in your
49 kernel configuration file:
50 .Bd -ragged -offset indent
51 .Cd "device ucom"
52 .Ed
53 .Pp
54 Alternatively, to load the driver as a
55 module at boot time, place the following line in
56 .Xr loader.conf 5 :
57 .Bd -literal -offset indent
58 ucom_load="YES"
59 .Ed
60 .Sh DESCRIPTION
61 The
62 .Nm
63 driver attaches to USB modems, serial ports, and other devices that need
64 to look like a tty.
65 The
66 .Nm
67 driver shows a behavior like a
68 .Xr tty 4 .
69 This means that normal programs such as
70 .Xr tip 1
71 or
72 .Xr pppd 8
73 can be used to access the device.
74 .Sh FILES
75 .Bl -tag -width ".Pa /dev/ucom?"
76 .It Pa /dev/ucom?
77 .El
78 .Sh SEE ALSO
79 .Xr moscom 4 ,
80 .Xr tty 4 ,
81 .Xr uark 4 ,
82 .Xr ubsa 4 ,
83 .Xr uchcom 4 ,
84 .Xr uftdi 4 ,
85 .Xr ugensa 4 ,
86 .Xr umct 4 ,
87 .Xr umodem 4 ,
88 .Xr uplcom 4 ,
89 .Xr usb 4 ,
90 .Xr uslcom 4 ,
91 .Xr uticom 4 ,
92 .Xr uvisor 4 ,
93 .Xr uvscom 4
94 .Sh HISTORY
95 The
96 .Nm
97 driver was adopted from
98 .Nx
99 in March of 2002.
100 This manual page was adopted from
101 .Nx
102 by
103 .An Tom Rhodes Aq trhodes@FreeBSD.org
104 in April 2002.