Update pwmconfig manual page.

git-svn-id: http://lm-sensors.org/svn/lm-sensors/branches/lm-sensors-3.0.0@5344 7894878c-1315-0410-8ee3-d5d059ff63e0
This commit is contained in:
Jean Delvare committed 2008-09-28 08:18:29 +00:00
1 parent f7ccb96a7c
commit 66130a9630
2 files changed
+38 -12

No files matched your search

+1
View File
@@ -14,6 +14,7 @@ SVN-HEAD
Skip MINSTOP and MINSTART tests if fan can't stop
Change default for MINTEMP from 0 to 20 degrees C
Add support for attributes in the hwmon class device (#2260)
Update manual page
sensors-detect: Add Intel SCH (bus) support
Add SMSC EMC6D103 support
Improve MAX6657, MAX6658, MAX6659 detection
+37 -12
View File
@@ -1,30 +1,55 @@
.TH PWMCONFIG 8 "January 27, 2005" "lm-sensors 3"
.TH PWMCONFIG 8 "September 28, 2008" "lm-sensors 3"
.SH NAME
pwmconfig \- tests the PWM outputs of sensors and configures fancontrol
.SH SYNOPSIS
.B pwmconfig
.SH WARNING
\fBpwmconfig\fR will attempt to stop your fans, one at a time, for
approximately 5 seconds each. This may cause your processor
temperature to rise. Verify that all fans are running at normal speed
after this program has exited.
\fBpwmconfig\fR does its best to check that the fans are spinning when
they are supposed to, but due to the diversity of available
motherboards and fans, it shouldn't be blindly trusted. Always verify
by yourself.
It is strongly recommended to run \fBpwmconfig\fR at a time when there
is no significant system load, to minimize the risk of overheating.
.SH DESCRIPTION
.B pwmconfig
searches your sensors for pulse width modulation (PWM)
controls, and test each one to see if it controls a fan on
controls, and tests each one to see if it controls a fan on
your motherboard. Note that many motherboards do not have PWM
circuitry installed, even if your sensor chip supports PWM.
It attempts to briefly stop each fan using the PWM controls. It then
attempts to restore each fan to full speed after testing. However, it
is \fBvery important\fP that you physically verify that the fans have
been returned to full speed after the program has completed.
When a connection is established between a PWM control and a fan,
\fBpwmconfig\fR can generate a detailed correlation, to show how a
given fan is responding to various PWM duty cycles.
.SH WARNING
This program will stop your fans, one at a time, for approximately 5 seconds each.
This may cause your processor temperature to rise. Verify that all fans are running
at normal speed after this program has exited.
Lastly, \fBpwmconfig\fR will enter in \fBfancontrol\fR configuration
mode (unless you decide to skip that part.) In this mode, you are
invited to enter several parameters which will determine how the
\fBfancontrol\fR daemon regulates the speed of one or more fans in
your system based on temperature measurements. In particular, you will
have the opportunity to establish mappings between fans and
temperature inputs, define the temperature range over which the speed
of the fan should be adjusted dynamically, the minimum speed at which
the fan should spin, etc. See fancontrol(8) for additional
information.
.SH BUGS
The term "PWM" is used because most fan control systems in computers
are based on pulse width modulation. Some motherboards however use DC
variation instead. So, the term "PWM" should be seen as a generic term
for "fan speed control", regardless of the actual method used.
.SH SEE ALSO
fancontrol(8), sensors(1).
.SH AUTHOR
.SH AUTHORS
.PP
Marius Reiner <marius.reiner@hdev.de>
Marius Reiner <marius.reiner@hdev.de>,
Jean Delvare <khali@linux-fr.org>