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