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 .\"
  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 .\"
  30 .\" $FreeBSD: head/share/man/man4/ucom.4 222696 2011-06-04 20:40:24Z hselasky $
  31 .\"
  32 .Dd March 14, 2014
  33 .Dt UCOM 4
  34 .Os
  35 .Sh NAME
  36 .Nm ucom
  37 .Nd USB tty support
  38 .Sh SYNOPSIS
  39 To compile this driver into the kernel,
  40 place the following line in your
  41 kernel configuration file:
  42 .Bd -ragged -offset indent
  43 .Cd "device ucom"
  44 .Ed
  45 .Pp
  46 Alternatively, to load the driver as a
  47 module at boot time, place the following line in
  48 .Xr loader.conf 5 :
  49 .Bd -literal -offset indent
  50 ucom_load="YES"
  51 .Ed
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 driver attaches to USB modems, serial ports, and other devices that need
  56 to look like a tty.
  57 The
  58 .Nm
  59 driver shows a behavior like a
  60 .Xr tty 4 .
  61 This means that normal programs such as
  62 .Xr tip 1
  63 or
  64 .Xr ppp 8
  65 can be used to access the device.
  66 .Pp
  67 The
  68 .Va portno
  69 locater can be used to decide which port to use for devices that have
  70 multiple external ports.
  71 .Sh FILES
  72 .Bl -tag -width ".Pa /dev/cuaU?"
  73 .It Pa /dev/cuaU?
  74 .It Pa /dev/ttyU?
  75 .El
  76 .Sh SEE ALSO
  77 .Xr tty 4 ,
  78 .Xr u3g 4 ,
  79 .Xr uark 4 ,
  80 .Xr ubsa 4 ,
  81 .Xr ubser 4 ,
  82 .Xr uchcom 4 ,
  83 .Xr ucycom 4 ,
  84 .Xr ufoma 4 ,
  85 .Xr uftdi 4 ,
  86 .Xr ugensa 4 ,
  87 .Xr uipaq 4 ,
  88 .Xr umcs 4 ,
  89 .Xr umct 4 ,
  90 .Xr umodem 4 ,
  91 .Xr umoscom 4 ,
  92 .Xr uplcom 4 ,
  93 .Xr usb 4 ,
  94 .Xr uslcom 4 ,
  95 .Xr uvisor 4 ,
  96 .Xr uvscom 4
  97 .Sh HISTORY
  98 The
  99 .Nm
 100 driver was adopted from
 101 .Nx
 102 in March of 2002.
 103 This manual page was adopted from
 104 .Nx
 105 by
 106 .An Tom Rhodes Aq Mt trhodes@FreeBSD.org
 107 in April 2002.
 108 .Sh CAVEATS
 109 Up to
 110 .Dx 3.6
 111 .Nm
 112 created
 113 .Pa /dev/ucom?
 114 rather than the uniform device names created today.
 115 Old scripts must be adjusted accordingly.