Show
Ignore:
Timestamp:
12/07/08 14:14:39 (4 years ago)
Author:
khali
Message:

Move the help section of sensors.conf.eg to sensors.conf.5, so that
we have only one document to maintain. This change also speeds up
sensors by 2.5% when using the default configuration file.

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • lm-sensors/branches/lm-sensors-3.0.0/etc/sensors.conf.eg

    r5531 r5534  
    1 # Sensors configuration file used by 'libsensors' 
    2 #------------------------------------------------ 
    3 # 
    4 ########################################################################## 
    5 #                                                                        # 
    6 #    PLEASE READ THIS HELPFUL HINT!!!                                    # 
    7 #                                                                        # 
    8 #       The 'set' lines (generally for min and max values)               # 
    9 #       do not take effect until you run 'sensors -s' as root !!!        # 
    10 #       We suggest you put 'sensors -s' in a /etc/rc.d/... file          # 
    11 #       to be run at boot time after the modules are inserted !!!        # 
    12 #                                                                        # 
    13 ########################################################################## 
    14 # 
    15 # 
    16 # OVERVIEW 
    17 # -------- 
    18 # This configuration file will be used by all userspace applications 
    19 # linked to libsensors. It is NOT used by the lm_sensors drivers directly. 
    20 # 
    21 # This config file consists of two parts: the heavily commented LM78 
    22 # example, and the real parts. Search for '####' if you want to skip 
    23 # to the real stuff. 
    24 # 
    25 # Hash marks introduce comments, which continue until the end of a line. 
    26 # 
    27 # Identifiers consisting of only digits and letters can be used 
    28 # unquoted; other identifiers must be quoted. Escape characters within 
    29 # quotes operate like those in C. 
    30 # 
    31 # 
    32 # CHIP LINES 
    33 # ---------- 
    34 # A 'chip' line specifies what the following 'label', 'compute', 'set' and 
    35 # 'ignore' lines refer to. In this case, until the 
    36 # next 'chip' line, everything refers to all lm78 and lm79 
    37 # chips. Other examples are *-isa-* for everything on the ISA bus, and 
    38 # lm78-i2c-*-4e for all lm78 chips on address 0x4e of any I2C bus. 
    39 # 
    40 # If more chip statements match a specific chip, they are all considered. 
    41 # Later lines overrule earlier lines, so if you set the in0 label for 
    42 # lm78-* to "This", and later on the in0 label for lm78-isa-* to "That", 
    43 # "That" is used for LM78 chips on the ISA bus, and "This" for LM78 
    44 # chips on a non-ISA bus. 
    45 # 
    46 #       chip "lm78-*" "lm79-*" 
    47 # 
    48 # 
    49 # FEATURE NAMES 
    50 # ------------- 
    51 # Feature names are used in 'label', 'compute', 'set', and 'ignore' lines. 
    52 # Example feature names are 'in0', 'temp2', 'in3_min', and 'temp3_max'. 
    53 # 
    54 # Undefined features will be silently ignored in 'label' and 'compute' lines. 
    55 # Undefined features in 'set' lines will result in 'Unknown feature name' 
    56 # when running 'sensors -s'. 
    57 # 
    58 # 
    59 # LABEL LINES 
    60 # ----------- 
    61 # A label line describes what a certain feature stands for on your 
    62 # mainboard. Programs can retrieve these names and display them. 
    63 # If no label is specified for a certain feature, the default name 
    64 # (ie. 'fan1' for fan1) is used. 
    65 # 
    66 # These are as advised in the LM78 and LM79 data sheets, and used on most 
    67 # boards we have seen. 
    68 # 
    69 #       label in0 "VCore 1" 
    70 #       label in1 "VCore 2" 
    71 #       label in2 "+3.3V" 
    72 #       label in3 "+5V" 
    73 #       label in4 "+12V" 
    74 #       label in5 "-12V" 
    75 #       label in6 "-5V" 
    76 # 
    77 # 
    78 # COMPUTE LINES 
    79 # ------------- 
    80 # A compute line describes how to scale a certain feature. There are 
    81 # two expressions in it: the first describes how the driver value must 
    82 # be translated to a user value, the second how a user value must be 
    83 # translated to a driver value. '@' is the value to operate on. You may 
    84 # refer to other readable features (like 'cpu0_vid * 1.05'). 
    85 # 
    86 # The following operators are valid: + - * / ( ) ^ ` 
    87 # ^ is e**x and ` is ln(x) 
    88 # 
    89 # Where it makes sense, compute lines are inherited by subfeatures. 
    90 # For example, the compute line for 'in0' is automatically applied to 
    91 # 'in0_min' and 'in0_max' as well. 
    92 # 
    93 # 
    94 # VOLTAGE COMPUTATION DETAILS 
    95 # --------------------------- 
    96 # Most voltage sensors in sensor chips have a range of 0 to 4.096 Volts. 
    97 # This is generally sufficient for the 3.3 and CPU (2.5V, for example) 
    98 # supply voltages, so the sensor chip reading is the actual voltage. 
    99 # 
    100 # Other supply voltages must be scaled with an external resistor network. 
    101 # The chip driver generally reports the 'raw' value 0 - 4.09 V, and the 
    102 # userspace application must convert this raw value to an actual voltage. 
    103 # The 'compute' lines provide this facility. 
    104 # 
    105 # Unfortunately the resistor values vary among motherboard types. 
    106 # Therefore you may have to adjust the computations in this file 
    107 # to match your motherboard. 
    108 # 
    109 # For positive voltages (in3, in4), two resistors are used, with the following 
    110 # formula (R1,R2: resistor values, Vs: read voltage, Vin: pin voltage) 
    111 #       R1 = R2 * (Vs/Vin - 1) 
    112 # For negative voltages (in5, in6) two resistors are used, with the following 
    113 # formula (Rin,Rf: resistor values, Vs: read voltage, Vin: pin voltage) 
    114 #       Rin = (Vs * Rf) / Vin 
    115 # 
    116 # Note: Some chips use a different formula, see it87 section for example. 
    117 # 
    118 # Here are the official LM78 and LM79 data sheet values. 
    119 #             Vs     R1,Rin   R2,Rf    Vin 
    120 #       in3   +5.0      6.8    10     +2.98 
    121 #       in4  +12.0     30      10     +3.00 
    122 #       in5  -12.0    240      60     +3.00 
    123 #       in6   -5.0    100      60     +3.00 
    124 # 
    125 # These would lead to these declarations: 
    126 #       compute in3 ((6.8/10)+1)*@ ,  @/((6.8/10)+1) 
    127 #       compute in4 ((30/10)+1)*@  ,  @/((30/10)+1) 
    128 #       compute in5 -(240/60)*@    ,  -@/(240/60) 
    129 #       compute in6 -(100/60)*@    ,  -@/(100/60) 
    130 # 
    131 # On almost any mainboard we have seen, the Winbond compute values lead to 
    132 # much better results, though. 
    133 # 
    134 #             Vs     R1,Rin   R2,Rf    Vin 
    135 #       in4  +12.0     28      10     +3.15 
    136 #       in5  -12.0    210      60.4   +3.45 
    137 #       in6   -5.0     90.9    60.4   +3.33 
    138 # 
    139 # These leads to these declarations: 
    140 #       compute in3 ((6.8/10)+1)*@ ,  @/((6.8/10)+1) 
    141 #       compute in4 ((28/10)+1)*@  ,  @/((28/10)+1) 
    142 #       compute in5 -(210/60.4)*@  ,  -@/(210/60.4) 
    143 #       compute in6 -(90.9/60.4)*@ ,  -@/(90.9/60.4) 
    144 # 
    145 # NOTE: On many motherboards, the -5V and -12V sensors are not connected. 
    146 # Add ignore lines so these readings will not be displayed. For example: 
    147 #       ignore in5 
    148 #       ignore in6 
    149 # 
    150 # 
    151 # TEMPERATURE COMPUTATION EXAMPLES 
    152 # -------------------------------- 
    153 # There are two common ways to adjust temperature readings. 
    154 # One is to adjust by a constant. The other is to change the 
    155 # temperature sensor type. 
    156 # 
    157 # Add 5 degrees to temperature sensor 1: 
    158 #       compute temp1 @+5,@-5 
    159 # 
    160 # Sensor type adjustments (certain chips only): 
    161 #       set temp1_type 1    # PII/Celeron Diode 
    162 #       set temp1_type 2    # 3904 transistor 
    163 #       set temp1_type 3    # thermal diode 
    164 #       set temp1_type 4    # thermistor 
    165 #       set temp1_type 5    # AMD AMDSI 
    166 #       set temp1_type 6    # Intel PECI 
    167 # 
    168 # Often, a temperature sensor is disconnected; disable it with an ignore line: 
    169 #       ignore temp3 
    170 # 
    171 # 
    172 # SET LINES 
    173 # --------- 
    174 # Set statements set things like limits. Complete expressions can be 
    175 # used. Not everything can sensibly be set: setting 'in0', for example, 
    176 # is impossible! These settings are put through the compute translations; 
    177 # so if we specify '12.8' for in6, '3.2' will actually be written! 
    178 # 
    179 # Important note: In the 'sensors' program, these only take effect 
    180 # after running 'sensors -s'!!! 
    181 # 
    182 # Here are some examples: 
    183 # 
    184 #       set in0_max cpu0_vid*1.05 
    185 #       set in0_min cpu0_vid*0.95 
    186 #       set temp1_max 40 
    187 #       set temp1_max_hyst 37 
    188 # 
    189 # Think of tempx_max as 'alarm set' and tempx_max_hyst as 'alarm clear' 
    190 # thresholds. In most cases the 'max' value should be higher than 
    191 # the 'max_hyst' value by several degrees. Obviously, having them equal 
    192 # disables the hysteresis mechanism. 
    193 # 
     1# libsensors configuration file 
     2# ----------------------------- 
     3# NOTE: 
    1944# All the set statements from this file are commented out by default. 
    1955# The reason is that the proper limits are highly system-dependent, 
    1966# and writing improper limits may have all sorts of weird effects, 
    1977# from beeping to CPU throttling to instant reboot. If you want to 
    198 # actually set the limits, remove the comment marks. 
    199 # 
    200 # 
    201 # IGNORE LINES 
    202 # ------------ 
    203 # Ignore statements tell certain features are not wanted. As with compute 
    204 # statements, 'ignore in0' would also invalidate 'in0_max' and 'in0_min'. 
    205 # 'ignore' does not disable anything in the actual sensor chip; it 
    206 # simply prevents the user program from accessing that data. 
    207 # 
    208 #       ignore in0 
    209 # 
    210 # 
    211 # STATEMENT ORDER 
    212 # --------------- 
    213 # Statements can go in any order, EXCEPT that some statements depend 
    214 # on others. Dependencies could be either in the library or the driver. 
    215 # A 'compute' statement must go before a 'set' statement 
    216 # for the same feature or else the 'set' won't be computed correctly. 
    217 # This is a library dependency. 
    218 # A 'set fan1_div' statement must go before a 'set fan1_min' statement, 
    219 # because the driver uses the divisor in calculating the minimum. 
    220 # 
    221 # 
    222 # BUS LINES 
    223 # --------- 
    224 # There is one other feature: the 'bus' statement. An example is below. 
    225 # 
    226 #       bus "i2c-0" "SMBus PIIX4 adapter at e800" 
    227 # 
    228 # If we refer from now on to 'i2c-0' in 'chip' lines, this will run-time 
    229 # be matched to this bus. So even if the PIIX4 is called 'i2c-5' at that 
    230 # moment, because five other adapters were detected first, 'i2c-0' in 
    231 # the config file would always only match this physical bus. In the above 
    232 # config file, this feature is not needed; but the next lines would 
    233 # only affect the LM75 chips on the PIIX4 adapter: 
    234 # 
    235 #       chip "lm75-i2c-0-*" 
    236 # 
    237 # You can use "sensors --bus-list" to generate bus lines for your system. 
    238 # 
    239 # 
    240 # BEEPS 
    241 # ----- 
    242 # Some chips support alarms with beep warnings. When an alarm is triggered 
    243 # you can be warned by a beeping signal through your computer speaker. It 
    244 # is possible to enable beeps for all alarms on a chip using the following 
    245 # line: 
    246 # 
    247 #       set beep_enable 1 
    248 # 
    249 # or disable them using: 
    250 # 
    251 #       set beep_enable 0 
    252 # 
    253 # 
    254 ########################################################################## 
    255 #### Here begins the real configuration file 
    256  
     8# actually set the limits, remove the comment marks, then run "sensors -s". 
    2579 
    25810chip "lm78-*" "lm79-*" "w83781d-*"