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