Show
Ignore:
Timestamp:
09/28/08 10:18:29 (6 years ago)
Author:
khali
Message:

Update pwmconfig manual page.

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • lm-sensors/branches/lm-sensors-3.0.0/prog/pwm/pwmconfig.8

    r5330 r5344  
    1 .TH PWMCONFIG 8 "January 27, 2005" "lm-sensors 3" 
     1.TH PWMCONFIG 8 "September 28, 2008" "lm-sensors 3" 
    22.SH NAME 
    33pwmconfig \- tests the PWM outputs of sensors and configures fancontrol 
     
    66.B pwmconfig 
    77 
     8.SH WARNING 
     9\fBpwmconfig\fR will attempt to stop your fans, one at a time, for 
     10approximately 5 seconds each. This may cause your processor 
     11temperature to rise. Verify that all fans are running at normal speed 
     12after this program has exited. 
     13\fBpwmconfig\fR does its best to check that the fans are spinning when 
     14they are supposed to, but due to the diversity of available 
     15motherboards and fans, it shouldn't be blindly trusted. Always verify 
     16by yourself. 
     17 
     18It is strongly recommended to run \fBpwmconfig\fR at a time when there 
     19is no significant system load, to minimize the risk of overheating. 
     20 
    821.SH DESCRIPTION 
    922.B pwmconfig 
    1023searches your sensors for pulse width modulation (PWM) 
    11 controls, and test each one to see if it controls a fan on 
     24controls, and tests each one to see if it controls a fan on 
    1225your motherboard. Note that many motherboards do not have PWM 
    1326circuitry installed, even if your sensor chip supports PWM. 
    1427 
    15 It attempts to briefly stop each fan using the PWM controls. It then 
    16 attempts to restore each fan to full speed after testing. However, it 
    17 is \fBvery important\fP that you physically verify that the fans have 
    18 been returned to full speed after the program has completed. 
     28When a connection is established between a PWM control and a fan, 
     29\fBpwmconfig\fR can generate a detailed correlation, to show how a 
     30given fan is responding to various PWM duty cycles. 
    1931 
    20 .SH WARNING 
    21 This program will stop your fans, one at a time, for approximately 5 seconds each. 
    22 This may cause your processor temperature to rise. Verify that all fans are running 
    23 at normal speed after this program has exited. 
     32Lastly, \fBpwmconfig\fR will enter in \fBfancontrol\fR configuration 
     33mode (unless you decide to skip that part.) In this mode, you are 
     34invited to enter several parameters which will determine how the 
     35\fBfancontrol\fR daemon regulates the speed of one or more fans in 
     36your system based on temperature measurements. In particular, you will 
     37have the opportunity to establish mappings between fans and 
     38temperature inputs, define the temperature range over which the speed 
     39of the fan should be adjusted dynamically, the minimum speed at which 
     40the fan should spin, etc. See fancontrol(8) for additional 
     41information. 
     42 
     43.SH BUGS 
     44The term "PWM" is used because most fan control systems in computers 
     45are based on pulse width modulation. Some motherboards however use DC 
     46variation instead. So, the term "PWM" should be seen as a generic term 
     47for "fan speed control", regardless of the actual method used. 
    2448 
    2549.SH SEE ALSO 
    2650fancontrol(8), sensors(1). 
    2751 
    28 .SH AUTHOR 
     52.SH AUTHORS 
    2953.PP 
    30 Marius Reiner <marius.reiner@hdev.de> 
     54Marius Reiner <marius.reiner@hdev.de>, 
     55Jean Delvare <khali@linux-fr.org>