PageRenderTime 20ms CodeModel.GetById 10ms app.highlight 4ms RepoModel.GetById 1ms app.codeStats 1ms

/share/man/man4/acpi_asus.4

https://bitbucket.org/freebsd/freebsd-head/
Forth | 187 lines | 187 code | 0 blank | 0 comment | 3 complexity | cc8ffc4c764426ac41f8aaa2ba9adaf0 MD5 | raw file
  1.\"
  2.\" Copyright (c) 2004 Philip Paeps <philip@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 February 8, 2010
 29.Dt ACPI_ASUS 4
 30.Os
 31.Sh NAME
 32.Nm acpi_asus
 33.Nd Asus Laptop Extras
 34.Sh SYNOPSIS
 35To compile this driver into the kernel,
 36place the following line in your
 37kernel configuration file:
 38.Bd -ragged -offset indent
 39.Cd "device acpi_asus"
 40.Ed
 41.Pp
 42Alternatively, to load the driver as a
 43module at boot time, place the following line in
 44.Xr loader.conf 5 :
 45.Bd -literal -offset indent
 46acpi_asus_load="YES"
 47.Ed
 48.Sh DESCRIPTION
 49The
 50.Nm
 51driver provides support for the extra ACPI-controlled gadgets, such as hotkeys
 52and leds, found on recent Asus (and Medion) laptops.
 53It allows one to use the
 54.Xr sysctl 8
 55interface to manipulate the brightness of the LCD panel and the display output
 56state.
 57Hotkey events are passed to
 58.Xr devd 8
 59for easy handling in userspace with the default configuration in
 60.Pa /etc/devd/asus.conf .
 61.Pp
 62Currently, the following Asus laptops are fully supported:
 63.Pp
 64.Bl -item -offset indent -compact
 65.It
 66xxN
 67.It
 68A1x
 69.It
 70A2x
 71.It
 72A3N
 73.It
 74A4D
 75.It
 76A6VM
 77.It
 78D1x
 79.It
 80J1x
 81.It
 82L2B
 83.It
 84L2D
 85.It
 86L2E
 87.It
 88L3C
 89.It
 90L3D
 91.It
 92L3H
 93.It
 94L4E
 95.It
 96L4R
 97.It
 98L5x
 99.It
100L8x
101.It
102M1A
103.It
104M2E
105.It
106M6N
107.It
108M6R
109.It
110S1x
111.It
112S2x
113.It
114V6V
115.It
116W5A
117.It
118Eee PC
119.El
120.Pp
121Additionally,
122.Nm
123also supports the Asus-compatible
124.Em ATK0100
125interface found in
126.Em Samsung P30/P35
127laptops.
128.Sh SYSCTL VARIABLES
129The following sysctls are currently implemented:
130.Bl -tag -width indent
131.It Va hw.acpi.asus.lcd_brightness
132Makes the LCD backlight brighter or dimmer (higher values are brighter).
133.It Va hw.acpi.asus.lcd_backlight
134Turns the LCD backlight on or off.
135.It Va hw.acpi.asus.video_output
136Sets the active display to use according to a bitwise OR of the following:
137.Pp
138.Bl -tag -width indent -compact
139.It Li 0
140No display
141.It Li 1
142LCD
143.It Li 2
144CRT
145.It Li 4
146TV-Out
147.El
148.Pp
149Some models also support video switching via the generic
150.Xr acpi_video 4
151driver.
152Most models do not, however.
153.El
154.Pp
155Defaults for these variables can be set in
156.Xr sysctl.conf 5 ,
157which is parsed at boot-time.
158.Sh SEE ALSO
159.Xr acpi 4 ,
160.Xr acpi_asus_wmi 4 ,
161.Xr acpi_video 4 ,
162.Xr sysctl.conf 5 ,
163.Xr sysctl 8
164.Rs
165.%T The acpi4asus Project
166.%U http://sourceforge.net/projects/acpi4asus/
167.Re
168.Sh HISTORY
169The
170.Nm
171driver first appeared in
172.Fx 5.3 .
173.Sh AUTHORS
174.An -nosplit
175The
176.Nm
177driver and this manual page were written by
178.An Philip Paeps Aq philip@FreeBSD.org .
179.Pp
180Inspiration came from the
181.Em acpi4asus project
182started by
183.An Julien Lerouge
184which maintains a driver implementing this
185functionality in the
186.Tn Linux
187kernel.