share/man/man4/hgame.4

   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 .\" $FreeBSD$
  25 .\"
  26 .Dd September 14, 2020
  27 .Dt HGAME 4
  28 .Os
  29 .Sh NAME
  30 .Nm hgame
  31 .Nd Generic HID game controller (joystick/gamepad) driver
  32 .Sh SYNOPSIS
  33 To compile this driver into the kernel,
  34 place the following lines in your
  35 kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "device hgame"
  38 .Cd "device hid"
  39 .Cd "device hidbus"
  40 .Cd "device hidmap"
  41 .Cd "device evdev"
  42 .Ed
  43 .Pp
  44 Alternatively, to load the driver as a
  45 module at boot time, place the following line in
  46 .Xr loader.conf 5 :
  47 .Bd -literal -offset indent
  48 hgame_load="YES"
  49 .Ed
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 driver provides support for generic game controllers (joysticks/gamepads)
  54 that attach to the HID transport backend.
  55 See
  56 .Xr iichid 4
  57 or
  58 .Xr usbhid 4 .
  59 .Pp
  60 The
  61 .Pa /dev/input/event*
  62 device presents the game controller as a
  63 .Ar evdev
  64 type device.
  65 .Sh SYSCTL VARIABLES
  66 The following variable is available as both
  67 .Xr sysctl 8
  68 variable and
  69 .Xr loader 8
  70 tunable:
  71 .Bl -tag -width indent
  72 .It Va dev.hgame.X.debug
  73 Debug output level, where 0 is debugging disabled and larger values increase
  74 debug message verbosity.
  75 Default is 0.
  76 .El
  77 .Pp
  78 It's default value is set with
  79 .Xr loader 8
  80 tunable:
  81 .Bl -tag -width indent
  82 .It Va hw.hid.hgame.debug
  83 .El
  84 .Sh FILES
  85 .Bl -tag -width /dev/input/event* -compact
  86 .It Pa /dev/input/event*
  87 input event device node.
  88 .El
  89 .Sh SEE ALSO
  90 .Xr iichid 4 ,
  91 .Xr usbhid 4
  92 .Sh HISTORY
  93 The
  94 .Nm
  95 driver first appeared in
  96 .Fx 13.0.
  97 .Sh AUTHORS
  98 .An -nosplit
  99 The
 100 .Nm
 101 driver was written by
 102 .An Greg V Aq Mt greg@unrelenting.technology .
 103 .Pp
 104 This manual page was written by
 105 .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .