xref: /freebsd/share/man/man4/hms.4 (revision 2e3f49888ec8851bafb22011533217487764fdb0)
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.Dd September 12, 2020
27.Dt HMS 4
28.Os
29.Sh NAME
30.Nm hms
31.Nd HID mouse driver
32.Sh SYNOPSIS
33To compile this driver into the kernel,
34place the following lines in your
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device hms"
38.Cd "device hidbus"
39.Cd "device hid"
40.Cd "device evdev"
41.Ed
42.Pp
43Alternatively, to load the driver as a
44module at boot time, place the following line in
45.Xr loader.conf 5 :
46.Bd -literal -offset indent
47hms_load="YES"
48.Ed
49.Sh DESCRIPTION
50The
51.Nm
52driver provides support for HID mice that attach to the HID transport
53backend.
54See
55.Xr iichid 4
56or
57.Xr usbhid 4 .
58Supported are
59mice with any number of buttons, mice with a wheel and absolute mice.
60.Pp
61The
62.Pa /dev/input/eventX
63device presents the mouse as a
64.Ar evdev
65type device.
66.Sh SYSCTL VARIABLES
67The following variable is available as both
68.Xr sysctl 8
69variable and
70.Xr loader 8
71tunable:
72.Bl -tag -width indent
73.It Va dev.hms.X.debug
74Debug output level, where 0 is debugging disabled and larger values increase
75debug message verbosity.
76Default is 0.
77.El
78.Pp
79It default value is derived from
80.Xr loader 8
81tunable:
82.Bl -tag -width indent
83.It Va hw.hid.hms.debug
84.El
85.Sh FILES
86.Bl -tag -width /dev/input/eventX -compact
87.It Pa /dev/input/eventX
88input event device node.
89.El
90.Sh SEE ALSO
91.Xr iichid 4 ,
92.Xr usbhid 4 ,
93.Xr xorg.conf 5 Pq Pa ports/x11/xorg
94.\".Xr moused 8
95.Sh BUGS
96.Nm
97cannot act like
98.Xr sysmouse 4
99.Sh AUTHORS
100.An -nosplit
101The
102.Nm
103driver was written by
104.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
105.Pp
106This manual page was originally written by
107.An Nick Hibma Aq Mt n_hibma@FreeBSD.org
108for
109.Xr umt 4
110driver and was adopted for
111.Nm
112by
113.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
114