acpi*.4: Update manual pages for the recent ACPI update.
[dragonfly.git] / share / man / man4 / acpi_asus.4
CommitLineData
bf334cef
SW
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: src/share/man/man4/acpi_asus.4,v 1.3 2008/08/21 00:40:55 rpaulo Exp $
27.\"
28.Dd August 20, 2008
2f5aa587 29.Dt ACPI_ASUS 4
bf334cef
SW
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.
60.Pp
61Currently, the following Asus laptops are fully supported:
62.Pp
63.Bl -item -offset indent -compact
64.It
65xxN
66.It
67A1x
68.It
69A2x
70.It
71A3N
72.It
73A4D
74.It
75A6VM
76.It
77D1x
78.It
79J1x
80.It
81L2B
82.It
83L2D
84.It
85L2E
86.It
87L3C
88.It
89L3D
90.It
91L3H
92.It
93L4E
94.It
95L4R
96.It
97L5x
98.It
99L8x
100.It
101M1A
102.It
103M2E
104.It
105M6N
106.It
107M6R
108.It
109S1x
110.It
111S2x
112.It
113V6V
114.It
115W5A
116.It
117Eee PC
118.El
119.Pp
120Additionally,
121.Nm
122also supports the Asus-compatible
123.Em ATK0100
124interface found in
125.Em Samsung P30/P35
126laptops.
127.Sh SYSCTL VARIABLES
128The following sysctls are currently implemented:
129.Bl -tag -width indent
130.It Va hw.acpi.asus.lcd_brightness
131Makes the LCD backlight brighter or dimmer (higher values are brighter).
132.It Va hw.acpi.asus.lcd_backlight
133Turns the LCD backlight on or off.
134.It Va hw.acpi.asus.video_output
135Sets the active display to use according to a bitwise OR of the following:
136.Pp
137.Bl -tag -width indent -compact
138.It Li 0
139No display
140.It Li 1
141LCD
142.It Li 2
143CRT
144.It Li 4
145TV-Out
146.El
147.Pp
148Some models also support video switching via the generic
149.Xr acpi_video 4
150driver.
151Most models do not, however.
152.El
153.Pp
154Defaults for these variables can be set in
155.Xr sysctl.conf 5 ,
156which is parsed at boot-time.
157.Sh SEE ALSO
158.Xr acpi 4 ,
159.Xr acpi_video 4 ,
160.Xr sysctl.conf 5 ,
161.Xr sysctl 8
162.Rs
163.%T The acpi4asus Project
164.%O http://sourceforge.net/projects/acpi4asus/
165.Re
166.Sh HISTORY
167The
168.Nm
169driver first appeared in
170.Fx 5.3 .
171.Sh AUTHORS
172.An -nosplit
173The
174.Nm
175driver and this manual page were written by
176.An Philip Paeps Aq philip@FreeBSD.org .
177.Pp
178Inspiration came from the
179.Em acpi4asus project
180started by
181.An Julien Lerouge
182which maintains a driver implementing this
183functionality in the
184.Tn Linux
185kernel.