Sync usage with man page.
[netbsd-mini2440.git] / share / man / man4 / aiboost.4
blob4e7b3e4b3b83f428cb6a3226cf1e4016e90e7a0d
1 .\"     $NetBSD: aiboost.4,v 1.1 2007/03/14 00:43:51 xtraeme Exp $
2 .\"
3 .\" Copyright (c) 2007 Juan Romero Pardines
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 .\"
26 .Dd March 14, 2007
27 .Dt AIBOOST 4
28 .Os
29 .Sh NAME
30 .Nm aiboost
31 .Nd ASUS AI Booster hardware monitor
32 .Sh SYNOPSIS
33 .Cd "aiboost* at acpi?"
34 .Sh DESCRIPTION
35 The
36 .Nm
37 driver provides support for monitoring the hardware sensors in recent
38 .Tn ASUS
39 motherboards.
40 The driver uses ACPI as the backend to fetch sensor values and
41 descriptions and provides its data via the
42 .Xr envsys 4
43 interface.
44 .Pp
45 The
46 .Nm
47 driver typically has 7 sensors, depending on the motherboard and
48 chipset:
49 .Bl -column "Sensor" "Units" "Typical" -offset indent
50 .It Sy "Sensor" Ta Sy "Units" Ta Sy "Typical Use"
51 .It Li "CPU" Ta "uK" Ta "CPU Temperature"
52 .It Li "MB" Ta "uK" Ta "MB Temperature"
53 .It Li "VCC" Ta "uV DC" Ta "Core Voltage"
54 .It Li "+3.3V" Ta "uV DC" Ta "+3.3 Voltage"
55 .It Li "+5V" Ta "uV DC" Ta "+5 Voltage"
56 .It Li "+12V" Ta "uV DC" Ta "+12 Voltage"
57 .It Li "CPU" Ta "RPM" Ta "CPU Fan"
58 .El
59 .Sh SEE ALSO
60 .Xr envsys 4 ,
61 .Xr envstat 8
62 .Sh HISTORY
63 The
64 .Nm
65 driver first appeared in
66 .Fx
67 and then it was ported to
68 .Nx 5.0 .
69 .Sh AUTHORS
70 .An -nosplit
71 The
72 .Nm
73 driver was written by
74 .An Takanori Watanabe
75 and
76 .An Juan Romero Pardines ,
77 who adapted the code for
78 .Nx .
79 .Sh BUGS
80 It's possible to modify voltages via the ACPI methods in the DSDT,
81 but for now the driver only reports the sensors' values.
82 CPU Q-Fan is another thing that is typically specified in the ACPI
83 namespace, and in the future we should handle this feature (to
84 enable or disable automatic/manual fan mode).