xref: /freebsd/share/man/man4/hms.4 (revision afd590d9e56686e179cbbf626ec567aeaaa49199)
1*afd590d9SVladimir Kondratyev.\" Copyright (c)
2*afd590d9SVladimir Kondratyev.\"	1999 Nick Hibma <n_hibma@FreeBSD.org>. All rights reserved.
3*afd590d9SVladimir Kondratyev.\"	2020 Vladimir Kondratyev <wulf@FreeBSD.org>.
4*afd590d9SVladimir Kondratyev.\"
5*afd590d9SVladimir Kondratyev.\" Redistribution and use in source and binary forms, with or without
6*afd590d9SVladimir Kondratyev.\" modification, are permitted provided that the following conditions
7*afd590d9SVladimir Kondratyev.\" are met:
8*afd590d9SVladimir Kondratyev.\" 1. Redistributions of source code must retain the above copyright
9*afd590d9SVladimir Kondratyev.\"    notice, this list of conditions and the following disclaimer.
10*afd590d9SVladimir Kondratyev.\" 2. Redistributions in binary form must reproduce the above copyright
11*afd590d9SVladimir Kondratyev.\"    notice, this list of conditions and the following disclaimer in the
12*afd590d9SVladimir Kondratyev.\"    documentation and/or other materials provided with the distribution.
13*afd590d9SVladimir Kondratyev.\"
14*afd590d9SVladimir Kondratyev.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15*afd590d9SVladimir Kondratyev.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16*afd590d9SVladimir Kondratyev.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17*afd590d9SVladimir Kondratyev.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18*afd590d9SVladimir Kondratyev.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19*afd590d9SVladimir Kondratyev.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20*afd590d9SVladimir Kondratyev.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21*afd590d9SVladimir Kondratyev.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22*afd590d9SVladimir Kondratyev.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23*afd590d9SVladimir Kondratyev.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24*afd590d9SVladimir Kondratyev.\" SUCH DAMAGE.
25*afd590d9SVladimir Kondratyev.\"
26*afd590d9SVladimir Kondratyev.\" $FreeBSD$
27*afd590d9SVladimir Kondratyev.\"
28*afd590d9SVladimir Kondratyev.Dd September 12, 2020
29*afd590d9SVladimir Kondratyev.Dt HMS 4
30*afd590d9SVladimir Kondratyev.Os
31*afd590d9SVladimir Kondratyev.Sh NAME
32*afd590d9SVladimir Kondratyev.Nm hms
33*afd590d9SVladimir Kondratyev.Nd HID mouse driver
34*afd590d9SVladimir Kondratyev.Sh SYNOPSIS
35*afd590d9SVladimir KondratyevTo compile this driver into the kernel,
36*afd590d9SVladimir Kondratyevplace the following lines in your
37*afd590d9SVladimir Kondratyevkernel configuration file:
38*afd590d9SVladimir Kondratyev.Bd -ragged -offset indent
39*afd590d9SVladimir Kondratyev.Cd "device hms"
40*afd590d9SVladimir Kondratyev.Cd "device hidbus"
41*afd590d9SVladimir Kondratyev.Cd "device hid"
42*afd590d9SVladimir Kondratyev.Cd "device evdev"
43*afd590d9SVladimir Kondratyev.Ed
44*afd590d9SVladimir Kondratyev.Pp
45*afd590d9SVladimir KondratyevAlternatively, to load the driver as a
46*afd590d9SVladimir Kondratyevmodule at boot time, place the following line in
47*afd590d9SVladimir Kondratyev.Xr loader.conf 5 :
48*afd590d9SVladimir Kondratyev.Bd -literal -offset indent
49*afd590d9SVladimir Kondratyevhms_load="YES"
50*afd590d9SVladimir Kondratyev.Ed
51*afd590d9SVladimir Kondratyev.Sh DESCRIPTION
52*afd590d9SVladimir KondratyevThe
53*afd590d9SVladimir Kondratyev.Nm
54*afd590d9SVladimir Kondratyevdriver provides support for HID mice that attach to the HID transport
55*afd590d9SVladimir Kondratyevbackend.
56*afd590d9SVladimir KondratyevSee
57*afd590d9SVladimir Kondratyev.Xr iichid 4
58*afd590d9SVladimir Kondratyevor
59*afd590d9SVladimir Kondratyev.Xr usbhid 4 .
60*afd590d9SVladimir KondratyevSupported are
61*afd590d9SVladimir Kondratyevmice with any number of buttons, mice with a wheel and absolute mice.
62*afd590d9SVladimir Kondratyev.Pp
63*afd590d9SVladimir KondratyevThe
64*afd590d9SVladimir Kondratyev.Pa /dev/input/eventX
65*afd590d9SVladimir Kondratyevdevice presents the mouse as a
66*afd590d9SVladimir Kondratyev.Ar evdev
67*afd590d9SVladimir Kondratyevtype device.
68*afd590d9SVladimir Kondratyev.Sh SYSCTL VARIABLES
69*afd590d9SVladimir KondratyevThe following variable is available as both
70*afd590d9SVladimir Kondratyev.Xr sysctl 8
71*afd590d9SVladimir Kondratyevvariable and
72*afd590d9SVladimir Kondratyev.Xr loader 8
73*afd590d9SVladimir Kondratyevtunable:
74*afd590d9SVladimir Kondratyev.Bl -tag -width indent
75*afd590d9SVladimir Kondratyev.It Va dev.hms.X.debug
76*afd590d9SVladimir KondratyevDebug output level, where 0 is debugging disabled and larger values increase
77*afd590d9SVladimir Kondratyevdebug message verbosity.
78*afd590d9SVladimir KondratyevDefault is 0.
79*afd590d9SVladimir Kondratyev.El
80*afd590d9SVladimir Kondratyev.Pp
81*afd590d9SVladimir KondratyevIt default value is derived from
82*afd590d9SVladimir Kondratyev.Xr loader 8
83*afd590d9SVladimir Kondratyevtunable:
84*afd590d9SVladimir Kondratyev.Bl -tag -width indent
85*afd590d9SVladimir Kondratyev.It Va hw.hid.hms.debug
86*afd590d9SVladimir Kondratyev.El
87*afd590d9SVladimir Kondratyev.Sh FILES
88*afd590d9SVladimir Kondratyev.Bl -tag -width /dev/input/eventX -compact
89*afd590d9SVladimir Kondratyev.It Pa /dev/input/eventX
90*afd590d9SVladimir Kondratyevinput event device node.
91*afd590d9SVladimir Kondratyev.El
92*afd590d9SVladimir Kondratyev.Sh SEE ALSO
93*afd590d9SVladimir Kondratyev.Xr iichid 4 ,
94*afd590d9SVladimir Kondratyev.Xr usbhid 4 ,
95*afd590d9SVladimir Kondratyev.Xr xorg.conf 5 Pq Pa ports/x11/xorg
96*afd590d9SVladimir Kondratyev.\.Xr moused 8
97*afd590d9SVladimir Kondratyev.Sh BUGS
98*afd590d9SVladimir Kondratyev.Nm
99*afd590d9SVladimir Kondratyevcannot act like
100*afd590d9SVladimir Kondratyev.Xr sysmouse 4
101*afd590d9SVladimir Kondratyev.Sh AUTHORS
102*afd590d9SVladimir Kondratyev.An -nosplit
103*afd590d9SVladimir KondratyevThe
104*afd590d9SVladimir Kondratyev.Nm
105*afd590d9SVladimir Kondratyevdriver was written by
106*afd590d9SVladimir Kondratyev.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
107*afd590d9SVladimir Kondratyev.Pp
108*afd590d9SVladimir KondratyevThis manual page was originally written by
109*afd590d9SVladimir Kondratyev.An Nick Hibma Aq Mt n_hibma@FreeBSD.org
110*afd590d9SVladimir Kondratyevfor
111*afd590d9SVladimir Kondratyev.Xr umt 4
112*afd590d9SVladimir Kondratyevdriver and was adopted for
113*afd590d9SVladimir Kondratyev.Nm
114*afd590d9SVladimir Kondratyevby
115*afd590d9SVladimir Kondratyev.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
116