1fd3368029a7c3745717c90c1a806fd1c70c8b43
[dragonfly.git] / share / man / man4 / uvisor.4
1 .\" $NetBSD: uvisor.4,v 1.3 2001/01/23 21:31:10 augustss Exp $
2 .\" $FreeBSD: src/share/man/man4/uvisor.4,v 1.2.2.2 2002/08/22 15:13:11 trhodes Exp $
3 .\"
4 .\" Copyright (c) 2000 The NetBSD Foundation, Inc.
5 .\" All rights reserved.
6 .\"
7 .\" This code is derived from software contributed to The NetBSD Foundation
8 .\" by Lennart Augustsson.
9 .\"
10 .\" Redistribution and use in source and binary forms, with or without
11 .\" modification, are permitted provided that the following conditions
12 .\" are met:
13 .\" 1. Redistributions of source code must retain the above copyright
14 .\"    notice, this list of conditions and the following disclaimer.
15 .\" 2. Redistributions in binary form must reproduce the above copyright
16 .\"    notice, this list of conditions and the following disclaimer in the
17 .\"    documentation and/or other materials provided with the distribution.
18 .\" 3. All advertising materials mentioning features or use of this software
19 .\"    must display the following acknowledgment:
20 .\"        This product includes software developed by the NetBSD
21 .\"        Foundation, Inc. and its contributors.
22 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
23 .\"    contributors may be used to endorse or promote products derived
24 .\"    from this software without specific prior written permission.
25 .\"
26 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36 .\" POSSIBILITY OF SUCH DAMAGE.
37 .\"
38 .Dd March 10, 2000
39 .Dt UVISOR 4
40 .Os
41 .Sh NAME
42 .Nm uvisor
43 .Nd USB support for the Handspring Visor, a Palmpilot compatible PDA
44 .Sh SYNOPSIS
45 To compile this driver into the kernel,
46 place the following lines in your
47 kernel configuration file:
48 .Bd -ragged -offset indent
49 .Cd "device uvisor"
50 .Cd "device ucom"
51 .Ed
52 .Pp
53 Alternatively, to load the driver as a
54 module at boot time, place the following line in
55 .Xr loader.conf 5 :
56 .Bd -literal -offset indent
57 uvisor_load="YES"
58 .Ed
59 .Sh DESCRIPTION
60 The
61 .Nm
62 driver provides support for the Handspring Visor, a Palmpilot compatible PDA.
63 .Pp
64 The device is accessed through the
65 .Xr ucom 4
66 driver which makes it behave like a
67 .Xr tty 4 .
68 The device has several ports for different purposes, each of them gets its
69 own
70 .Xr ucom 4
71 device.
72 The attach message describes the purpose of each port.
73 .Pp
74 The usual Pilot tools can be used to access the Visor on the HotSync port.
75 .Sh SEE ALSO
76 .Xr tty 4 ,
77 .Xr ucom 4 ,
78 .Xr usb 4
79 .Sh HISTORY
80 The
81 .Nm
82 driver was adopted from
83 .Nx 1.5
84 in August 2002.  This manual page was adopted from
85 .Nx
86 by
87 .An Tom Rhodes Aq Mt trhodes@FreeBSD.org
88 at that time.
89 .Sh BUGS
90 The code to provide multiple ucom instances has not yet been ported
91 from
92 .Nx .
93 It's unclear whether this driver works in its current state.