share/man/man4/acpi_asus_wmi.4

   1 .\"
   2 .\" Copyright (c) 2012 Alexander Motin <mav@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd July 2, 2012
  29 .Dt ACPI_ASUS_WMI 4
  30 .Os
  31 .Sh NAME
  32 .Nm acpi_asus_wmi
  33 .Nd Asus Laptop WMI Extras
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 place the following line in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device acpi_asus_wmi"
  40 .Ed
  41 .Pp
  42 Alternatively, to load the driver as a
  43 module at boot time, place the following line in
  44 .Xr loader.conf 5 :
  45 .Bd -literal -offset indent
  46 acpi_asus_wmi_load="YES"
  47 .Ed
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 driver provides support for the extra WMI-controlled gadgets, such as hotkeys
  52 and leds, found on Asus laptops.
  53 It allows one to use the
  54 .Xr sysctl 8
  55 interface to manipulate the brightness of the LCD panel and keyboard backlight,
  56 power on/off different internal components, such as WiFi, Bluetooth, camera,
  57 cardreader, etc, read some sensors.
  58 Hotkey events are passed to
  59 .Xr devd 8
  60 for easy handling in userspace with the default configuration in
  61 .Pa /etc/devd/asus.conf .
  62 Some hotkey events, such as keyboard backlight and touchpad control, are
  63 handled inside the driver.
  64 .Sh SYSCTL VARIABLES
  65 The following sysctls are currently implemented:
  66 .Bl -tag -width indent
  67 .It Va dev.acpi_asus_wmi.0.handle_keys
  68 Specifies whether driver should handle some harwdare keys, such as keyboard
  69 backlight, internally.
  70 .El
  71 .Pp
  72 Number of other variables under the same sysctl branch are model-specific.
  73 .Pp
  74 Defaults for these variables can be set in
  75 .Xr sysctl.conf 5 ,
  76 which is parsed at boot-time.
  77 .Sh SEE ALSO
  78 .Xr acpi 4 ,
  79 .Xr acpi_asus 4 ,
  80 .Xr acpi_video 4 ,
  81 .Xr sysctl.conf 5 ,
  82 .Xr devd 8 ,
  83 .Xr sysctl 8
  84 .Sh HISTORY
  85 The
  86 .Nm
  87 driver first appeared in
  88 .Fx 10.0 .
  89 .Sh AUTHORS
  90 .An Alexander Motin Aq mav@FreeBSD.org .