wmgtemp/wmgtemp.1

   1 .\" Hey, Emacs!  This is an -*- nroff -*- source file.
   2 .TH "wmgtemp" 1 "February 2001" ""
   3 .SH NAME
   4 wmgtemp \- Temperature sensor dock app for Window Maker
   5 .SH SYNOPSIS
   6 .B wmgtemp
   7 .I "[options]"
   8 .SH "DESCRIPTION"
   9 wmgtemp is a dock-app for Window Maker that graphically displays the CPU and
  10 System temperatures using the lm_sensors package. It displays the CPU and
  11 System temperature values, a scaling graph of temperature history,
  12 high-temperature warning lights and temperatures in degrees Celsius,
  13 Fahrenheit or Kelvin.
  14 .PP
  15 The temperature graph is auto scaling, meaning that if the max or min temperature boundary is crossed the graph will be scaled to display the temperature. A red line marks the upper boundary whereas a blue line indicates the lower boundary. When all the temperatures being displayed are within the boundaries the graph will be scaled back to the preset values for min/max and the boundary indicator lines will be removed.
  16 .PP
  17 The high temperature warning lights located on the left of the temperature type indicators show amber or red when the warning or high temperatures are reached respectively. Normal operating temperature is indicated by no light.
  18 .SH "OPTIONS"
  19 .TP
  20 .B \-h, \-\-help
  21 display the usage information
  22 .TP
  23 .B \-s, \-\-scale=SCALE
  24 show temperatures using SCALE temperature scale. SCALE=celcius, fahrenheit or kelvin.
  25 .br
  26 \fBDefault\fP: celcius
  27 .TP
  28 .B \-S, \-\-sensorconf=PATH
  29 specify the PATH to the lm_sensors config
  30 .br
  31 \fBDefault\fP: /etc/sensors.conf
  32 .TP
  33 .B \-g, \-\-graph=STYLE
  34 display graph as STYLE. STYLE=line or block.
  35 .br
  36 \fBDefault\fP: line
  37 .TP
  38
  39 .B \-H, \-\-high=TEMP
  40 display red warning light at TEMP degrees celcius.
  41 .br
  42 \fBDefault\fP: 50
  43 .TP
  44
  45 .B \-w, \-\-warn=TEMP
  46 display amber warning light at TEMP degrees celcius.
  47 .br
  48 \fBDefault\fP: 45
  49
  50 .TP
  51 .B \-u, \-\-update=SEC
  52 update the display every SEC seconds.
  53 .br
  54 \fBDefault\fP: 1
  55
  56 .TP
  57 .B \-m, \-\-min=TEMP
  58 set the lower bound of the graph to TEMP degrees celcius.
  59 .br
  60 \fBDefault\fP: 20
  61
  62 .TP
  63 .B \-M, \-\-max=TEMP
  64 set the upper bound of the graph to TEMP degrees celcius.
  65 .br
  66 \fBDefault\fP: 35
  67
  68 .TP
  69 .B \-1, \-\-feature1=F1
  70 set the feature for CPU
  71 .br
  72 \fBDefault\fP: temp1
  73
  74 .TP
  75 .B \-2, \-\-feature2=F2
  76 set the feature for SYS
  77 .br
  78 \fBDefault\fP: temp2
  79
  80 .TP
  81 .B \-c, \-\-chip=CHIP
  82 specify the chip sensor to use
  83 .br
  84 \fBDefault\fP: auto
  85
  86 .TP
  87 .B \-a, \-\-execat=TEMP
  88 execute a command at TEMP degrees celcius.
  89 .br
  90 \fBDefault\fP: none
  91
  92 .TP
  93 .B \-e, \-\-exec=COMMAND
  94 execute COMMAND when the 'execat' temperature is reached.
  95 .br
  96 \fBDefault\fP: none
  97
  98 .TP
  99 .B \-t, \-\-swap
 100 swap/transpose temperature values
 101
 102 .TP
 103 .B \-q, \-\-quiet
 104 Don't display any messages
 105
 106 .PP
 107 .SH FILES
 108 ~/.wmgtemprc    User configuration.
 109 .PP
 110 The format of this file is:
 111 .nf
 112 .IP
 113 # wmgtemp example config
 114 scale:celcius
 115 graph:line
 116 high:50
 117 warn:45
 118 update:1
 119 min:25
 120 max:35
 121 execat:80
 122 exec:shutdown \-h 10
 123 swap:n
 124 quiet:y
 125 feature1:temp1
 126 feature2:temp2
 127 .PP
 128 .SH USAGE
 129 .SS Graph
 130 You can cycle through the graph types by clicking on the graph display area.
 131 .PP
 132 .SS High Temperature Toggle
 133 You can toggle the displaying of high temperatures by click on the temperature for the corrosponding temperature. The viewing of high temperatures is indicated by an amber arrow to the left of the temperature. The current temperatures will continue to be displayed on the graph.
 134 .PP
 135 .SH
 136 .SS Temperature display TOGGLE
 137 You may toggle the displaying of a temperature on the graph by clicking on the corrosponding type. e.g To toggle the display of the CPU temperature click on CPU. The type indicator (CPU or SYS) will disappear and the temperature will not be displayed on the graph, although the temperature value will continue to be displayed.
 138 .PP
 139 .SH
 140 .SS Temperature Scale Cycling
 141 You may change the scale the temperatures are displayed in by clicking on either of the CPU or SYS scale indicators. The cycle order is \fBC\fP -> \fBK\fP -> \fBF\fP
 142 .PP
 143 .SH BUGS
 144 Blank lines in the config file cause a Segmentation Fault.
 145 .PP
 146 .SH SEE ALSO
 147 .BR sensors.conf (5),
 148 .BR libsensors (3),
 149 .BR wmaker (1x)
 150 .SH AUTHOR
 151 wmgtemp was written by Roger Dunce <kronos@fluxcode.net>
 152
 153