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