1gkrellm(1) User's Manual gkrellm(1)
2
6 gkrellm - The GNU Krell Monitors
7
10 gkrellm [ --help ] [ -t | --theme dir ] [ -g | --geometry +x+y ] [ -wm
11 ] [ -w | --withdrawn ] [ -c | --config suffix ] [ -nc ] [ -f |
12 --force-host-config ] [ -demo ] [ -p | --plugin plugin.so ] [ -s |
13 --server hostname ] [ -P | --port server_port ]
14
17 With a single process, gkrellm manages multiple stacked monitors and
18 supports applying themes to match the monitors appearance to your win‐
19 dow manager, Gtk, or any other theme.
20 FEATURES
23 · SMP CPU, Disk, Proc, and active net interface monitors with LEDs.
24 · Internet monitor that displays current and charts historical port
26 hits.
27 · Memory and swap space usage meters and a system uptime monitor.
29 · File system meters show capacity/free space and can mount/umount.
31 · A mbox/maildir/MH/POP3/IMAP mail monitor which can launch a mail
33 reader or remote mail fetch program.
34 · Clock/calendar and hostname display.
36 · Laptop Battery monitor.
38 · CPU/motherboard temperature/fan/voltages display with warnings and
40 alarms. Linux requires a sensor configured sysfs, lm_sensors mod‐
41 ules or a running mbmon daemon. FreeBSD can also read the mbmon
42 daemon. Windows requires MBM.
43 · Disk temperatures if there's a running hddtemp daemon.
45 · Multiple monitors managed by a single process to reduce system
47 load.
48 · A timer button that can execute PPP or ISDN logon/logoff scripts.
50 · Charts are autoscaling with configurable grid line resolution, or
52 · can be set to a fixed scale mode.
54 · Separate colors for "in" and "out" data. The in color is used for
56 CPU user time, disk read, forks, and net receive data. The out
57 color is used for CPU sys time, disk write, load, and net transmit
58 data.
59 · Commands can be configured to run when monitor labels are clicked.
61 · Data can be collected from a gkrellmd server running on a remote
63 machine.
64 · gkrellm is plugin capable so special interest monitors can be cre‐
66 ated.
67 · Many themes are available.
69 USER INTERFACE
72 · Top frame
73 Btn 1 Press and drag to move gkrellm window.
75 Btn 3 Popup main menu.
77 · Side frames
79 Btn 2 Slide gkrellm window shut (Btn1 if -m2 option).
81 Btn 3 Popup main menu.
83 · All charts
85 Btn 1 Toggle draw of extra info on the chart.
87 Btn 3 Brings up a chart configuration window.
89 · Inet charts
91 Btn 2 Toggle between port hits per minute and hour.
93 · Most panels
95 Btn 3 Opens the configuration window directly to a monitor's
97 configuration page.
98 · File System meter panels
100 Btn 1,2
102 Toggle display of label and fs capacity scrolling dis‐
103 play. The mount button runs mount/umount commands. If
104 ejectable, left click the eject button to open tray,
105 right click to close.
106 · Mem and Swap meter panels
108 Btn 1,2
110 Toggle display of label and memory or swap capacity
111 scrolling display.
112 · Mailbox monitor message count button
114 Btn 1 Launch a mail reader program. If options permit, also
116 stop animations and reset remote message counts.
117 Btn 2 Toggle mail check mute mode which inhibits the sound
119 notify program, and optionally inhibits all mail check‐
120 ing.
121 · Mailbox monitor envelope decal
123 Btn 1 Force a mail check regardless of mute or timeout state.
125 · Battery monitor panel
127 Btn 1 On the charging state decal toggles battery minutes left,
129 percent level, and charge rate display.
130 Btn 2 Anywhere on the panel also toggles the display.
132 · Keyboard shortcuts
134 F1 popup the user config window.
136 F2 popup the main menu.
138 Page_Up
140 previous theme or theme alternative.
141 Page_Down
143 next theme or theme alternative.
144 <Ctl>Page_Up
146 previous theme, skipping any theme alternatives.
147 <Ctl>Page_Down
149 next theme, skipping any theme alternatives.
150 If a command has been configured to be launched for a monitor, then a
152 button will appear when the mouse enters the panel of that monitor.
153 Clicking the button will launch the command.
154 A right button mouse click on the side or top frames of the gkrellm
156 window will pop up a user configuration window where you can configure
157 all the builtin and plugin monitors. Chart appearance may be config‐
158 ured by right clicking on a chart, and right clicking on many panels
159 will open the configuration window directly to the corresponding moni‐
160 tor's configuration page.
161
164 --help Displays this manual page.
165 -t, --theme dir
167 gkrellm will load all theme image files it finds in dir and
168 parse the gkrellmrc file if one exists. This option overrides
169 the loading of the last theme you configured to be loaded in the
170 Themes configuration window. Theme changes are not saved when
171 gkrellm is run with this option.
172 -g, --geometry +x+y
174 Makes gkrellm move to an (x,y) position on the screen at
175 startup. Standard X window geometry position (not size) formats
176 are parsed, ie +x+y -x+y +x-y -x-y. Except, negative geometry
177 positions are not recognized (ie +-x--y ).
178 -wm Forces gkrellm to start up with window manager decorations. The
180 default is no decorations because there are themed borders.
181 -w, --withdrawn
183 gkrellm starts up in withdrawn mode so it can go into the Black‐
184 box slit (and maybe WindowMaker dock).
185 -c, --config suffix
187 Use alternate config files generated by appending suffix to con‐
188 fig file names. This overrides any previous host config which
189 may have been setup with the below option.
190 -f, --force-host-config
192 If gkrellm is run once with this option and then the configura‐
193 tion or theme is changed, the config files that are written will
194 have a -hostname appended to them. Subsequent runs will detect
195 the user-config-hostname and gkrellm_theme.cfg-hostname files
196 and use them instead of the normal configuration files (unless
197 the --config option is specified). This is a convenience for
198 allowing remote gkrellm independent config files in a shared
199 home directory, and for the hostname to show up in the X title
200 for window management. This option has no effect in client
201 mode.
202 -s, --server hostname
204 Run in client mode by connecting to and collecting data from a
205 gkrellmd server on hostname
206 -P, --port server_port
208 Use server_port for the gkrellmd server connection.
209 -nc No config mode. The config menu is blocked so no config changes
211 can be made. Useful in certain environments, or maybe for run‐
212 ning on a xdm(1) login screen or during a screensaver mode?
213 -demo Force enabling of many monitors so themers can see everything.
215 All config saving is inhibited.
216 -p, --plugin plugin.so
218 For plugin development, load the command line specified plugin
219 so you can avoid repeated install steps in the development
220 cycle.
221
224 Charts
225 The default for most charts is to automatically adjust the number of
226 grid lines drawn and the resolution per grid so drawn data will be
227 nicely visible. You may change this to fixed grids of 1-5 and/or fixed
228 grid resolutions in the chart configuration windows. However, some
229 combination of the auto scaling modes may give best results.
230 Auto grid resolution has the following behavior.
232 Auto mode sticks at peak value is not set:
234 1) If using auto number of grids, set the resolution per grid
236 and the number of grids to optimize the visibility of data drawn
237 on the chart. Try to keep the number of grids between 1 and 7.
238 2) If using a fixed number of grids, set the resolution per grid
240 to the smallest value that draws data without clipping.
241 Auto mode sticks at peak value is set:
243 1) If using auto number of grids, set the resolution per grid
245 such that drawing the peak value encountered would require at
246 least 5 grids.
247 2) If using a fixed number of grids, set the resolution per grid
249 such that the peak value encountered could be drawn without
250 clipping. This means the resolution per grid never decreases.
251 All resolution per grid values are constrained to a set of values in
253 either a 1, 2, 5 sequence or a 1, 1.5, 2, 3, 5, 7 sequence. If you set
254 Auto mode sticks at peak value a manual Auto mode recalibrate may occa‐
255 sionally be required if the chart data has a wide dynamic range.
256 CPU Monitor
260 Data is plotted as a percentage. In auto number of grids mode, resolu‐
261 tion is a fixed 20% per grid. In fixed number of grids mode, grid res‐
262 olution is 100% divided by the number of grids.
263 Proc Monitor
266 The krell shows process forks with a full scale value of 10 forks. The
267 chart has a resolution of 10 forks/sec per grid in auto number of grids
268 mode and 50 forks/second maximum on the chart in fixed number of grids
269 mode. The process load resolution per grid is best left at 1.0 for
270 auto number of grids, but can be set as high as 5 if you configure the
271 chart to have only 1 or 2 fixed grids.
272 Net Monitor
275 gkrellm is designed to display a chart for net interfaces which are up,
276 which means they are listed in the routing table (however, it is possi‐
277 ble in some cases to monitor unrouted interfaces). One net interface
278 may be linked to a timer button which can be used to connect and dis‐
279 connect from an ISP.
280 The timer button shows an off, standby, or on state by a distinctive
282 (color or shape) icon.
283 ppp Standby state is while the modem phone line is locked while ppp
285 is connecting, and the on state is the ppp link connected. The
286 phone line lock is determined by the existence of the modem lock
287 file /var/lock/LCK..modem, which assumes pppd is using
288 /dev/modem. However, if your pppd setup does not use
289 /dev/modem, then you can configure an alternative with:
290 ln -s /var/lock/LCK..ttySx ~/.gkrellm2/LCK..modem
292 where ttySx is the tty device your modem does use. The ppp on
294 state is detected by the existence of /var/run/pppX.pid and the
295 time stamp of this file is the base for the on line time.
296 ippp The timer button standby state is not applicable to ISDN inter‐
298 faces that are always routed. The on state is ISDN on line while
299 the ippp interface is routed. The on line timer is reset at
300 transitions from ISDN hangup state to on line state.
301 For both ppp and ippp timer button links, the panel area of the inter‐
303 face is always shown and the chart appears when the interface is routed
304 with the phone link connected or on line.
305 If the timer button is not linked to a net interface, then it can be
307 used as a push on / push off timer
308 Net monitors can have a label so that the interface can be associated
310 with the identity of the other end of the connection. This is useful
311 if you have several net connections or run multiple remote gkrellm pro‐
312 grams. It can be easier to keep track of who is connected to who.
313 Mem and Swap Monitor
316 Here you are reading a ratio of total used to total available. The
317 amount of memory used indicated by the memory monitor is actually a
318 calculated "used" memory. If you enter the "free" command, you will
319 see that most of your memory is almost always used because the kernel
320 uses large amounts for buffers and cache. Since the kernel can free a
321 lot of this memory as user process demand for memory goes up, a more
322 realistic reading of memory in use is obtained by subtracting the buf‐
323 fers and cached memory from the kernel reported used. This is shown in
324 the free command output in the "-/+ buffers/cache" line where a calcu‐
325 lated used amount has buffers and cached memory subtracted from the
326 kernel reported used memory, and a calculated free amount has the buf‐
327 fers and cached memory added in.
328 While the memory meter always shows the calculated "used" memory, the
330 raw memory values total, shared, buffered, and cached may be optionally
331 displayed in the memory panel by entering an appropriate format display
332 string in the config.
333 Units: All memory values have units of binary megabytes (MiB). Memory
335 sizes have historically been reported in these units because memory
336 arrays on silicon have always increased in size by multiples of 2. Add
337 an address line to a memory chip and you double or quadruple (a multi‐
338 plexed address) the memory size. A binary megabyte is 2^20 or 1048576.
339 Contrast this with units for other stats such as disk capacities or net
340 transfer rates where the proper units are decimal megabytes or kilo‐
341 bytes. Disk drive capacities do not increase by powers of 2 and manu‐
342 facturers do not use binary units when reporting their sizes. However,
343 some of you may prefer to see a binary disk drive capacity reported, so
344 it is available as an option.
345 Internet Monitor
348 Displays TCP port connections and records historical port hits on a
349 minute or hourly chart. Middle button click on an inet chart to toggle
350 between the minute and hourly displays. There is a strip below the
351 minute or hour charts where marks are drawn for port hits in second
352 intervals. Each inet krell also shows port hits with a full scale
353 range of 5 hits. The left button toggle of extra info displays current
354 port connections.
355 For each internet monitor you can specify two labeled datasets with one
357 or two ports for each dataset. There are two ports because some inter‐
358 net ports are related and you might want to group them - for example,
359 the standard HTTP port is 80, but there is also a www web caching ser‐
360 vice on port 8080. So it makes sense to have a HTTP monitor which com‐
361 bines data from both ports. A possible common configuration would be
362 to create one inet monitor that monitors HTTP hits plotted in one color
363 and FTP hits in another. To do this, setup in the Internet configura‐
364 tion tab:
365 HTTP 80 8080 FTP 21
367 Or you could create separate monitors for HTTP and FTP. Other monitors
369 might be SMTP on port 25 or NNTP on port 119.
370 If you check the "Port0 - Port1 is a range" button, then all of the
372 ports between the two entries will be monitored. Clicking the small
373 button on the Inet panels will pop up a window listing the currently
374 connected port numbers and the host that is connected to it.
375 gkrellm samples TCP port activity once per second, so it is possible
377 for port hits lasting less than a second to be missed.
378 File System Monitor
381 File system mount points can be selected to be monitored with a meter
382 that shows the ratio of blocks used to total blocks available. Mount‐
383 ing commands can be enabled for mount points in one of two ways:
384 If a mount point is in your /etc/fstab and you have mount permission
386 then mount(8) and umount(8) commands can be enabled and executed for
387 that mount point simply by checking the "Enable /etc/fstab mounting"
388 option. Mount table entries in /etc/fstab must have the "user" or
389 "owner" option set to grant this permission unless gkrellm is run as
390 root. For example, if you run gkrellm as a normal user and you want to
391 be able to mount your floppy, your /etc/fstab could have either of:
392 /dev/fd0 /mnt/floppy ext2 user,noauto,rw,exec 0 0
394 /dev/fd0 /mnt/floppy ext2 user,defaults 0 0
395 If gkrellm is run as root or if you have sudo(1) permission to run the
397 mount(8) commands, then a custom mount command can be entered into the
398 "mount command" entry box. A umount(8) command must also be entered if
399 you choose this method. Example mount and umount entries using sudo:
400 sudo /bin/mount -t msdos /dev/fd0 /mnt/A
402 sudo /bin/umount /mnt/A
403 Notes: the mount point specified in a custom mount command (/mnt/A in
405 this example) must be the same as entered in the "Mount Point" entry.
406 Also, you should have the NOPASSWD option set in /etc/sudoers for this.
407 File system monitors can be created as primary (always visible) or sec‐
409 ondary which can be hidden and then shown when they are of interest.
410 For example, you might make primary file system monitors for root,
411 home, or user so they will be always visible, but make secondary moni‐
412 tors for less frequently used mount points such as floppy, zip, backup
413 partitions, foreign file system types, etc. Secondary FS monitors can
414 also be configured to always be visible if they are mounted by checking
415 the "Show if mounted" option. Using this feature you can show the
416 secondary group, mount a file system, and have that FS monitor remain
417 visible even when the secondary group is hidden. A standard cdrom
418 mount will show as 100% full but a monitor for it could be created with
419 mounting enabled just to have the mount/umount convenience.
420 When the "Ejectable" option is selected for a file system, an eject
422 button will appear when the mouse enters the file system panel. If you
423 are not using /etc/fstab mounting, a device file to eject will also
424 need to be entered. Systems may have varying levels of support for
425 this feature ranging from none or basic using an ioctl() to full sup‐
426 port using an eject command to eject all its supported devices. Linux
427 and NetBSD use the "eject" command while FreeBSD uses the "cdcontrol"
428 command, so be sure these commands are installed. Most eject commands
429 will also support closing a CDROM tray. If they do, you will be able
430 to access this function by right clicking the eject button.
431 Mail Monitor
434 Checks your mailboxes for unread mail. A mail reading program (MUA) can
435 be executed with a left mouse click on the mail monitor panel button,
436 and a mail notify (play a sound) program such as esdplay or artsplay
437 can be executed whenever the new mail count increases. The mail panel
438 envelope decal may also be clicked to force an immediate mail check at
439 any time.
440 gkrellm is capable of checking mail from local mailbox types mbox, MH,
442 and maildir, and from remote mailbox types POP3 and IMAP.
443 POP3 and IMAP checking can use non-standard port numbers and password
445 authentication protocols APOP (for POP3 only) or CRAM-MD5. If sup‐
446 ported by the mail server, emote checking may be done over an SSL con‐
447 nection if the "Use SSL" option is selected.
448 Before internal POP3 and IMAP checking was added, an external mail
450 fetch/check program could be set up to be executed periodically to
451 download or check remote POP3 or IMAP mail. This method is still
452 available and must be used if you want gkrellm to be able to download
453 remote mail to local mailboxes because the builtin checking functions
454 cannot download.
455 Battery Monitor
458 This meter will be available if a battery exists and will show battery
459 percentage life remaining. A decal indicates if AC line is connected
460 or if the battery is in use. If the data is available, time remaining
461 may be displayed as well as the percentage battery level. If the time
462 remaining is not available or is inaccurate, the Estimate Time option
463 may be selected to display a battery time to run or time to charge
464 which is calculated based on the current battery percent level, user
465 supplied typical battery times, and a default linear extrapolation
466 model. For charging, an exponential charge model may be selected.
467 A battery low level warning and alarm alert may be set. If battery
469 time is not available from the OS and the estimate time mode is not
470 set, the alert units will be battery percent level. Otherwise the
471 alert units will be battery time left in minutes. If OS battery time
472 is not available and the estimate time mode is set when the alert is
473 created, the alert will have units of time left in minutes and the
474 alert will automatically be destroyed if the estimate time option is
475 subsequently turned off.
476 If the OS reports multiple batteries, the alert will be a master alert
478 which is duplicated for each battery.
479 CPU/Motherboard Sensors - Temperature, Voltages, and Fan RPM
482 Linux:
483 Sensor monitoring on Linux requires that either lm_sensors modules are
484 installed in your running kernel, that you run a kernel >= 2.6 with
485 sysfs sensors configured, or, for i386 architectures, that you have the
486 mbmon daemon running when gkrellm is started. If the mbmon daemon is
487 used, it must be started before gkrellm like so:
488 mbmon -r -P port-number
490 where the given "port-number" must be configured to match in the
492 gkrellm Sensors->Options config. Sensor temperatures can also be read
493 from /proc/acpi/thermal_zone, /proc/acpi/thermal, /proc/acpi/ibm, the
494 PowerMac Windfarm /sysfs interface, and PowerMac PMU /sysfs based sen‐
495 sors.
496 When using lm_sensors, libsensors will be used if available, but if
498 libsensors is not linked into the program, the sensor data will be read
499 directly from the /sysfs or /proc file systems. If running a newer
500 Linux kernel sensor module not yet supported by libsensors and libsen‐
501 sors is linked, there will also be an automaitc fallback to using
502 /sysfs as long as libsensors doesn't detect any sensors. But if it
503 does detect some sensors which does not include the new sensors you
504 need, you can force getting /sysfs sensor data either by running:
505 gkrellm --without-libsensors
507 or by rebuilding with:
509 make without-libsensors=yes
511 Disk temperatures may also be monitored if you have the hddtemp daemon
513 running when gkrellm is started. gkrellm uses the default hddtemp port
514 of 7634. Both hddtemp and mbmon are best started in a boot rc script
515 to guarantee they will be running when gkrellm is started.
516 Nvidia graphics card GPU temperatures may also be monitored if you have
518 the nvidia-settings command installed and your Nvidia card supports the
519 temperature reporting.
520 Windows:
522 Requires a MBM install: http://mbm.livewiredev.com/.
523 FreeBSD:
525 Builtin sensor reporting is available for some sensor chips. FreeBSD
526 systems can also read sensor data from the mbmon daemon as described in
527 the Linux section above.
528 NetBSD:
530 Builtin sensor reporting is available for some sensor chips. NetBSD
531 uses the envsys(4) interface and sensors reading is automatically
532 enabled if you have either a lm(4) or viaenv(4) chip configured in your
533 kernel.
534 General Setup:
536 Temperature and fan sensor displays may be optionally located on the
537 CPU or Proc panels to save some vertical space while voltages are
538 always displayed on their own panel. If you set up to monitor both a
539 temperature and a fan on a single CPU or Proc panel, they can be dis‐
540 played optionally as an alternating single display or as separate dis‐
541 plays. If separate, the fan display will replace the panel label. The
542 configuration for this is under the CPU and Proc config pages.
543 If not using libsensors, in the Setup page for the Sensors config enter
545 any correction factors and offsets for each of the sensors you are mon‐
546 itoring (see below and lm_sensor documentation). For Linux, default
547 values are automatically provided for many sensor chips.
548 But if using libsenors, it is not possible to enter correction factors
550 and offsets on the Sensors config page because libsensors configuration
551 is done in the /etc/sensors.conf file. To get sensor debug output and
552 to find out the sensor data source, run:
553 gkrellm -d 0x80
555 Note for NetBSD users:
557 The current implementation of the sensor reading under NetBSD
558 opens /dev/sysmon and never closes it. Since that device does
559 not support concurrent accesses, you won't be able to run other
560 apps such as envstat(8) while GKrellM is running. This might
561 change if this happens to be an issue.
562 The reasons for this choice are a) efficiency (though it might
564 be possible to open/close /dev/sysmon each time a reading is
565 needed without major performance issue) and b) as of October
566 2001, there's a bug in the envsys(4) driver which sometimes
567 causes deadlocks when processes try to access simultaneously
568 /dev/sysmon (see NetBSD PR#14368). A (quick and dirty) work‐
569 around for this is to monopolize the driver :)
570 CPU/Motherboard Temperatures
573 Most modern motherboards will not require setting temperature correc‐
574 tion factors and offsets other than the defaults. However, for lm_sen‐
575 sors it is necessary to have a correct "set sensor" line in /etc/sen‐
576 sors.conf if the temperature sensor type is other than the default
577 thermistor. If using Linux sysfs sensors, this sensor type would be
578 set by writing to a sysfs file. For example, you might at boot set a
579 sysfs temperature sensor type with:
580 echo "2" > /sys/bus/i2c/devices/0-0290/sensor2
582 On the other hand, some older motherboards may need temperature cali‐
584 bration by setting a correction factor and offset for each temperature
585 sensor because of factors such as variations in physical thermistor
586 contact with the CPU. Unfortunately, this calibration may not be prac‐
587 tical or physically possible because it requires that somehow you can
588 get a real CPU temperature reading. So, the calibration discussion
589 which follows should probably be considered an academic exercise that
590 might give you some good (or bad) ideas. If you have a recent mother‐
591 board, skip the following.
592 Anyway, to do this calibration, take two real CPU temperature readings
594 corresponding to two sensor reported readings. To get the real read‐
595 ings, you can trust that your motherboard manufacturer has done this
596 calibration and is reporting accurate temperatures in the bios, or you
597 can put a temperature probe directly on your CPU case (and this is
598 where things get impractical).
599 Here is a hypothetical CPU calibration procedure. Make sure gkrellm is
601 configured with default factors of 1.0 and offsets of 0 and is report‐
602 ing temperatures in centigrade:
603 1 · Power on the machine and read a real temperature T1 from the
605 bios or a temperature probe. If reading from the bios, proceed
606 with booting the OS. Now record a sensor temperature S1 as
607 reported by gkrellm.
608 2 · Change the room temperature environment (turn off your AC or
610 change computer fan exhaust speed). Now repeat step 1, this
611 time recording a real temperature T2 and gkrellm reported sensor
612 temperature S2.
613 3 · Now you can calculate the correction factor and offset you need
615 to enter into the Sensor configuration tab:
616 From:
618 s - S1 t - T1
620 ------ = ------
621 S2 - S1 T2 - T1
622 T2 - T1 S2*T1 - S1*T2
624 t = s * ------- + -------------
625 S2 - S1 S2 - S1
626 So:
628 T2 - T1 S2*T1 - S1*T2
630 factor = ------- offset = -------------
631 S2 - S1 S2 - S1
632 Voltage Sensor Corrections
636 You need to read this section only if you think the default voltage
637 correction factors and offsets are incorrect. For Linux and lm_sensors
638 and sysfs sensors
639 this would be if gkrellm does not know about your particular sensor
640 chip. For MBM with Windows, the default values should be correct.
641 Motherboard voltage measurements are made by a variety of sensor chips
643 which are capable of measuring a small positive voltage. GKrellM can
644 display these voltage values and can apply a correction factor, offset,
645 and for the negative voltages of some chips (lm80), a level shifting
646 reference voltage to the displayed voltage. There are four cases to
647 consider:
648 1 · Low valued positive voltages may be directly connected to the
650 input pins of the sensor chip and therefore need no correction.
651 For these, the correction factor should be 1.0 and the offset
652 should be 0.
653 2 · Higher valued positive voltages will be connected to the input
655 pins of the sensor chip through a 2 resistor attenuation cir‐
656 cuit. For these, the correction factor will be a ratio of the
657 resistor values and the offset will be 0.
658 3 · Negative voltages will be connected to the input pins of the
660 sensor through a 2 resistor attenuation circuit with one of the
661 resistors connected to a positive voltage to effect a voltage
662 level shift. For these (lm80), the correction factor and offset
663 will be ratios of the resistor values, and a reference voltage
664 must be used.
665 4 · Some sensor chips (w83782, lm78) are designed to handle negative
667 inputs without requiring an input resistor connected to a volt‐
668 age reference. For these, there will be a correction factor and
669 a possible offset.
670 For cases 2 and 3, the sensor chip input network looks like:
672 Vs o----/\/\/---o-------------o Vin
674 R1 |
675 o--/\/\/--o Vref
676 R2
677 where,
679 Vs is the motherboard voltage under measurement
681 Vin is the voltage at the input pin of the sensor chip and
683 therefore is the voltage reading that will need correc‐
684 tion.
685 Vref is a level shifting voltage reference. For case 2, Vref
687 is ground or zero. For case 3, Vref will be one of the
688 positive motherboard voltages.
689 The problem then is to compute correction factors and offsets as a
691 function of R1 and R2 so that GKrellM can display a computed mother‐
692 board voltage Vs as a function of a measured voltage Vin.
693 Since sensor chip input pins are high impedance, current into the pins
695 may be assumed to be zero. In that case, the current through R1 equals
696 current through R2, and we have:
697 (Vs - Vin)/R1 = (Vin - Vref)/R2
699 Solving for Vs as a function of Vin:
701 Vs = Vin * (1 + R1/R2) - (R1/R2) * Vref
703 So, the correction factor is: 1 + R1/R2
705 the correction offset is: - (R1/R2)
706 Vref is specified in the config separately from
707 the offset (for chips that need it).
708 Fortunately there seems to be a standard set of resistor values used
711 for the various sensor chips which are documented in the lm_sensor doc‐
712 umentation. The GKrellM sensor corrections are similar to the compute
713 lines you find with lm_sensors, with the difference that lm_sensors has
714 an expression evaluator which does not require that compute lines be
715 simplified to the single factor and offset required by GKrellM. But
716 you can easily calculate the factor and offset. For example, this
717 lm_sensor compute line for a case 2 voltage:
718 compute in3 ((6.8/10)+1)*@ , @/((6.8/10)+1)
720 yields a correction factor of ((6.8/10)+1) = 1.68 and an offset of
723 zero.
724 Note that the second compute line expression is not relevant in GKrellM
726 because there is never any need to invert the voltage reading calcula‐
727 tion. Also, the compute line '@' symbol represents the Vin voltage.
728 A more complicated compute line for a case 3 voltage:
730 compute in5 (160/35.7)*(@ - in0) + @, ...
732 can be rewritten:
734 compute in5 (1 + 160/35.7)*@ - (160/35.7)*in0, ...
736 so the correction factor is (1 + 160/35.7) = 5.48
738 and the correction offset is -(160/35.7) = -4.48
739 and the voltage reference Vref is in0
740 Here is a table of correction factors and offsets based on some typical
742 compute line entries from /etc/sensors.conf:
743 Compute line Factor Offset Vref
745 -------------------------------------------------
746 lm80 in0 (24/14.7 + 1) * @ 2.633 0 -
747 in2 (22.1/30 + 1) * @ 1.737 0 -
748 in3 (2.8/1.9) * @ 1.474 0 -
749 in4 (160/30.1 + 1) * @ 6.316 0 -
750 in5 (160/35.7)*(@-in0) + @ 5.482 -4.482 in0
751 in6 (36/16.2)*(@-in0) + @ 3.222 -2.222 in0
752 LM78 in3 ((6.8/10)+1)*@ 1.68 0 -
754 in4 ((28/10)+1)*@ 3.8 0 -
755 in5 -(210/60.4)*@ -3.477 0 -
756 in6 -(90.9/60.4)*@ -1.505 0 -
757 w83782 in5 (5.14 * @) - 14.91 5.14 -14.91 -
759 in6 (3.14 * @) - 7.71 3.14 -7.71 -
760 Command launching
764 Many monitors can be set up to launch a command when you click on the
765 monitor label. When a command is configured for a monitor, its label
766 is converted into a button which becomes visible when the mouse enters
767 the panel or meter area of the label. If the command is a console com‐
768 mand (doesn't have a graphical user interface), then the command must
769 be run in a terminal window such as xterm, eterm, or Gnome terminal.
770 For example running the "top" command would take:
771 xterm -e top
773 You can use the command launching feature to run commands related to
775 monitoring functions, or you may use it to have a convenient launch for
776 any command. Since gkrellm is usually made sticky, you can have easy
777 access to several frequently used commands from any desktop. This is
778 intended to be a convenience and a way to maximize utilization of
779 screen real estate and not a replacement for more full featured command
780 launching from desktops such as Gnome or KDE or others. Some launch
781 ideas for some monitors could be:
782 calendar:
784 gnomecal, evolution, or ical
785 CPU: xterm -e top or gps or gtop
787 inet: gftp or xterm -e ftpwho
789 net: mozilla, galeon, skipstone, or xterm -e slrn -C-
791 And so on... Tooltips can be set up for these commands.
793 Alerts
796 Most monitors can have alerts configured to give warnings and alarms
797 for data readings which range outside of configurable limits. Where
798 useful, a delay of the alert trigger can be configured. A warning or
799 alarm consists of an attention grabbing decal appearing and an optional
800 command being executed. For most monitors the command may contain the
801 same substitution variables which are available for display in the
802 chart or panel label format strings and are documented on configuration
803 Info pages. Additionally, the hostname may be embedded in the command
804 with the $H substitution variable.
805 If you have festival installed, either a warn or alarm command could be
807 configured to speak something. For example a CPU temperature alert
808 warn command could just speak the current temperature with:
809 sh -c "echo warning C P U is at $s degrees | esddsp festival --tts"
811 Assuming you have esd running.
813
816 A theme is a directory containing image files and a gkrellmrc configu‐
817 ration file. The theme directory may be installed in several loca‐
818 tions:
819 ~/.gkrellm2/themes
821 /usr/local/share/gkrellm2/themes
822 /usr/share/gkrellm2/themes
823 For compatibility with Gtk themes, a gkrellm theme may also be
825 installed as:
826 ~/.themes/THEME_NAME/gkrellm2
828 /usr/share/themes/THEME_NAME/gkrellm2
829 Finally, a theme you simply want to check out can be untarred anywhere
831 and used by running:
832 gkrellm -t path_to_theme
834 If you are interested in writing a theme, go to the Themes page at
836 http://www.gkrellm.net and there you will find a Theme making refer‐
837 ence.
838
842 gkrellm tries to load all plugins (shared object files ending in .so)
843 it finds in your plugin directory ~/.gkrellm2/plugins. The directories
844 /usr/local/lib64/gkrellm2/plugins and /usr/lib64/gkrellm2/plugins are
845 also searched for plugins to install.
846 Some plugins may be available only as source files and they will have
848 to be compiled before installation. There should be instructions for
849 doing this with each plugin that comes in source form.
850 If you are interested in writing a plugin, go to the Plugins page at
852 http://www.gkrellm.net and there you will find a Plugin programmers
853 reference.
854
858 When a local gkrellm runs in client mode and connects to a remote
859 gkrellmd server all builtin monitors collect their data from the
860 server. However, the client gkrellm process is running on the local
861 machine, so any enabled plugins will run in the local context (Flynn is
862 an exception to this since it derives its data from the builtin CPU
863 monitor). Also, any command launching will run commands on the local
864 machine.
865
868 ~/.gkrellm2
869 User gkrellm directory where are located configuration files,
870 user's plugins and user's themes.
871 ~/.gkrellm2/plugins
873 User plugin directory.
874 /usr/lib64/gkrellm2/plugins
876 System wide plugin directory.
877 /usr/local/lib64/gkrellm2/plugins
879 Local plugin directory.
880 ~/.gkrellm2/themes
882 User theme directory.
883 ~/.themes/THEME_NAME/gkrellm2
885 User theme packaged as part of a user Gtk theme.
886 /usr/share/gkrellm2/themes
888 System wide theme directory.
889 /usr/local/share/gkrellm2/themes
891 Local theme directory.
892 /usr/share/themes/THEME_NAME/gkrellm2
894 System wide theme packaged as part of a system wide Gtk theme.
895
898 Bill Wilson <billw@gkrellm.net>. http://www.gkrellm.net/
899
902 fstab(5), sudo(1), mount(8), pppd(8), umount(8)
903GNU/Linux Oct 24, 2006 gkrellm(1)