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