Merge branch 'vendor/GCC44' into gcc442
[dragonfly.git] / share / man / man4 / acpi_toshiba.4
1 .\"
2 .\" Copyright (c) 2003 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/man4.i386/acpi_toshiba.4,v 1.5 2004/04/14 00:23:58 njl Exp $
27 .\" $DragonFly: src/share/man/man4/acpi_toshiba.4,v 1.1 2008/08/28 09:47:04 hasso Exp $
28 .\"
29 .Dd February 19, 2004
30 .Dt ACPI_TOSHIBA 4 i386
31 .Os
32 .Sh NAME
33 .Nm acpi_toshiba
34 .Nd Toshiba HCI interface
35 .Sh SYNOPSIS
36 .Cd "device acpi_toshiba"
37 .Sh DESCRIPTION
38 HCI is Toshiba's
39 .Em "Hardware Control Interface"
40 which is somewhat uniform across their models.
41 The
42 .Nm
43 driver allows the user to manipulate HCI-controlled hardware using a number of
44 .Xr sysctl 8
45 variables.
46 .Sh SYSCTLS
47 The following sysctls are currently implemented:
48 .Bl -tag -width indent
49 .It Va hw.acpi.toshiba.force_fan
50 Causes active cooling to be forcibly enabled
51 .Pq Ql 1
52 or disabled
53 .Pq Ql 0
54 regardless of the current temperature.
55 .It Va hw.acpi.toshiba.video_output
56 Sets the active display to use according to a bitwise OR of the following:
57 .Pp
58 .Bl -tag -width indent -compact
59 .It Li 0
60 No display
61 .It Li 1
62 LCD
63 .It Li 2
64 CRT
65 .It Li 4
66 TV-Out
67 .El
68 .Pp
69 Only some systems (i.e., the Libretto L5) support video switching via
70 this hardware-specific driver.
71 Use the
72 .Xr acpi_video 4
73 driver for generic video output support.
74 .It Va hw.acpi.toshiba.lcd_brightness
75 Makes the LCD backlight brighter or dimmer (higher values are brighter).
76 .It Va hw.acpi.toshiba.lcd_backlight
77 Turns the LCD backlight on and off.
78 .It Va hw.acpi.toshiba.cpu_speed
79 Sets the CPU speed to the specified speed.
80 This provides functionality similar to the
81 .Va hw.acpi.cpu.throttle_state
82 variable.
83 Higher sysctl values mean lower CPU speeds.
84 .El
85 .Pp
86 Defaults for these variables can be set in
87 .Xr sysctl.conf 5 ,
88 which is parsed at boot-time.
89 .Sh TUNABLES
90 The
91 .Va hw.acpi.toshiba.enable_fn_keys
92 tunable enables or disables the function keys on the keyboard.
93 Function keys are enabled by default.
94 .Pp
95 This behaviour can be changed at the
96 .Xr loader 8
97 prompt or in
98 .Xr loader.conf 5 .
99 .Sh SEE ALSO
100 .Xr acpi 4 ,
101 .Xr acpi_video 4 ,
102 .Xr loader.conf 5 ,
103 .Xr sysctl.conf 5 ,
104 .Xr sysctl 8
105 .Sh HISTORY
106 The
107 .Nm
108 driver first appeared in
109 .Fx 5.1 .
110 .Sh AUTHORS
111 .An -nosplit
112 The
113 .Nm
114 driver was written by
115 .An Hiroyuki Aizu Aq aizu@navi.org .
116 This manual page was written by
117 .An Philip Paeps Aq philip@FreeBSD.org .