106 lines
2.9 KiB
Groff
106 lines
2.9 KiB
Groff
.\" Copyright (c) 2020 Vladimir Kondratyev <wulf@FreeBSD.org>
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd September 14, 2020
|
|
.Dt HGAME 4
|
|
.Os
|
|
.Sh NAME
|
|
.Nm hgame
|
|
.Nd Generic HID game controller (joystick/gamepad) driver
|
|
.Sh SYNOPSIS
|
|
To compile this driver into the kernel,
|
|
place the following lines in your
|
|
kernel configuration file:
|
|
.Bd -ragged -offset indent
|
|
.Cd "device hgame"
|
|
.Cd "device hid"
|
|
.Cd "device hidbus"
|
|
.Cd "device hidmap"
|
|
.Cd "device evdev"
|
|
.Ed
|
|
.Pp
|
|
Alternatively, to load the driver as a
|
|
module at boot time, place the following line in
|
|
.Xr loader.conf 5 :
|
|
.Bd -literal -offset indent
|
|
hgame_load="YES"
|
|
.Ed
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
driver provides support for generic game controllers (joysticks/gamepads)
|
|
that attach to the HID transport backend.
|
|
See
|
|
.Xr iichid 4
|
|
or
|
|
.Xr usbhid 4 .
|
|
.Pp
|
|
The
|
|
.Pa /dev/input/event*
|
|
device presents the game controller as a
|
|
.Ar evdev
|
|
type device.
|
|
.Sh SYSCTL VARIABLES
|
|
The following variable is available as both
|
|
.Xr sysctl 8
|
|
variable and
|
|
.Xr loader 8
|
|
tunable:
|
|
.Bl -tag -width indent
|
|
.It Va dev.hgame.X.debug
|
|
Debug output level, where 0 is debugging disabled and larger values increase
|
|
debug message verbosity.
|
|
Default is 0.
|
|
.El
|
|
.Pp
|
|
It's default value is set with
|
|
.Xr loader 8
|
|
tunable:
|
|
.Bl -tag -width indent
|
|
.It Va hw.hid.hgame.debug
|
|
.El
|
|
.Sh FILES
|
|
.Bl -tag -width /dev/input/event* -compact
|
|
.It Pa /dev/input/event*
|
|
input event device node.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr iichid 4 ,
|
|
.Xr usbhid 4
|
|
.Sh HISTORY
|
|
The
|
|
.Nm
|
|
driver first appeared in
|
|
.Fx 13.0.
|
|
.Sh AUTHORS
|
|
.An -nosplit
|
|
The
|
|
.Nm
|
|
driver was written by
|
|
.An Val Packett Aq Mt val@packett.cool .
|
|
.Pp
|
|
This manual page was written by
|
|
.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
|