SENSORS

The cpu sensor measures the current CPU load. Multiple processors are supported.

interval - The update interval in milliseconds. The first specified interval parameter will be used for subsequent CPUs, although each CPU may still have it's own interval parameter.
default: interval=1000

cpu - The index of the CPU. The is only useful if you have more than one processor.
cpu=0 - The first CPU.
cpu=1 - The second CPU.
...
cpu=all - The load of all processors.
default: cpu=all

format - The specification of the displayed text. Possible values are:
%v - The CPU load.
%load - Same as %v.
%user - The user load.
%system - The system load.
%nice - The nice load.
%idle - The idle load.
default: format="%v"
example: format="CPU load: %v"

Gives information about mounted disks. Network file systems are supported.

interval - The update interval in milliseconds. The first specified interval parameter will be used for subsequent disk sensors, although each sensor may still have it's own interval parameter.
default: interval=5000

format - The specification of the displayed text. Possible values are:
%f - Free disk space in megabytes.
%fp - The percentage of free space.
%u - Used disk space in megabytes.
%up - The percentage of used space.
%t - Total disk space in megabytes.
default: format="%u"
example: format="Free space: %f MB"
example: format="Used space: %up %"

mountpoint - The mounted directory to monitor.
default: mountpoint="/"
example: mountpoint="/mnt/cdrom"

Measures memory and swap values.

interval - The update interval in milliseconds. The first specified interval parameter will be used for subsequent memory sensors, although each sensor may still have it's own interval parameter.
default: interval=3000

format - The specification of the displayed text. Possible values are:
%fm - Free memory in megabytes.
%fmb - Free memory in megabytes (cache and buffers excluded).
%um - Used memory in megabytes.
%umb - Used memory in megabytes (cache and buffers excluded).
%tm - Total memory in megabytes.
%fs - Free swap in megabytes.
%us - Used swap in megabytes.
%ts - Total swap in megabytes.
default: format="%um"
example: format="Free memory: %fm MB"

Gives information about the network traffic on a device.

interval - The update interval in milliseconds. The first specified interval parameter will be used for subsequent network sensors, although each sensor may still have it's own interval parameter.
default: interval=2500

device - The network device to use.
default: device="eth0"
example: device="ppp0"

format - The specification of the displayed text. Possible values are:
%in - Inbound network traffic in kilobytes per second.
%out - Outbound network traffic in kilobytes per second.
default: format="%in"
example: format="Incoming trafic: %in kB/s"

decimals - The number of decimals when measuring network traffic.
default: decimals=0

Get information from a possible running Noatun process.

interval - The update interval in milliseconds. The first specified interval parameter will be used for subsequent noatun sensors, although each sensor may still have it's own interval parameter.
default: interval=1000

format - The specification of the displayed text. Possible values are:
%id - The noatun dcop name. Can be useful when connecting to a clickarea (refer to the first example for usage of this).
%title - Title of the current song
%time - Time of the current song
%remain - Remaining time of the current song
%length - Length of the current song
%full - Sensor returns MAX if Noatun is started, else 0. %full is useful when connecting the sensor to a bar, the image will be shown only if Noatun is running.
default: format="%title %time / %total"
example: onclick="dcop %v Noatun play" sensor=noatun format="%id"

Used to run a program and connect the output to a meter.

interval - The update interval in milliseconds. The first specified interval parameter will be used for subsequent program sensors with an identical program parameter (including parameters), although each sensor may still have it's own interval parameter.
default: interval=3600000

program - The program that you want to run.
example: program="ftpwho -v"

encoding - This parameter will let you display text with, for example., Russian characters. The parameter value is the name of the encoding. A list of encodings can be found here: QTextCodec Class Reference. The first specified encoding parameter will be used for subsequent program sensors with an identical program parameter (including parameters), although each sensor may still have it's own encoding parameter.
default: encoding="" - Your locale is used.
example: encoding="KOI8-R"
example: encoding="ISO8859-6"

line - Use line if you only want a single line of the file.
line=1 - The first line of the file.
line=2 - The second line of the file.
...
line=-1 - The last line of the file.
line=-2 - The second last line of the file.
...

The sensor sensor uses the "sensors" program to measure CPU temperature, fan speeds, voltages, and more. The "sensors" program is required to get this sensor to work.

interval - The update interval in milliseconds. The first specified interval parameter will be used for subsequent time sensors, although each sensor may still have it's own interval parameter.
default: interval=30000

format - The specification of the displayed text. Possible values are:
%v - The value of the sensor.
default: format="%v"
example: format="Fanspeed: %v"

type - Which meter in the "sensors" program to monitor. Run the "sensors" program to list the available meters.
default: type="temp2"
example: type="fan1"

Reads a text file repeatedly.

interval - The update interval in milliseconds. The first specified interval parameter will be used for subsequent textfile sensors with an identical path parameter, although each sensor may still have it's own interval parameter.
default: interval=60000

path - The path to the textfile
example: path="/home/user/file.txt"

encoding - Using this parameter will let you display text with, for example., Russian characters. The parameter value is the name of the encoding. A list of encodings can be found here: QTextCodec Class Reference. The first specified encoding parameter will be used for subsequent textfile sensors with an identical path parameter, although each sensor may still have it's own encoding parameter.
default: encoding="" - Your locale is used.
example: encoding="KOI8-R"
example: encoding="ISO8859-6"

line - Use line if you only want a single line of the file.
line=1 - The first line of the file.
line=2 - The second line of the file.
...
line=-1 - The last line of the file.
line=-2 - The second last line of the file.
...

rdf - Set rdf=true if the texfile is a RDF/RSS file.
default: rdf=false

Returns the current time and/or date.

interval - The update interval in milliseconds. The first specified interval parameter will be used for subsequent time sensors, although each sensor may still have it's own interval parameter.
default: interval=60000

format - The specification of the displayed text. Possible values are:
d - the day as number without a leading zero (1-31).
dd - the day as number with a leading zero (01-31).
ddd - the abbreviated localized day name (e.g. 'Mon'..'Sun').
dddd - the long localized day name (e.g. 'Monday'..'Sunday').
M - the month as number without a leading zero (1-12).
MM - the month as number with a leading zero (01-12).
MMM - the abbreviated localized month name (e.g. 'Jan'..'Dec').
MMMM - the long localized month name (e.g. 'January'..'December').
yy - the year as two digit number (00-99).
yyyy - the year as four digit number (1752-8000).
h - the hour without a leading zero (0..23 or 1..12 if AM/PM display).
hh - the hour with a leading zero (00..23 or 01..12 if AM/PM display).
m - the minute without a leading zero (0..59).
mm - the minute with a leading zero (00..59).
s - the second without a leading zero (0..59).
ss - the second with a leading zero (00..59).
z - the milliseconds without leading zeroes (0..999).
zzz - the milliseconds with leading zeroes (000..999).
AP - use AM/PM display. AP will be replaced by either "AM" or "PM".
ap - use am/pm display. ap will be replaced by either "am" or "pm".
Example format strings (assumed that the QDateTime is 21 May 2001 14:13:09):
format="dd.MM.yyyy" -> 21.05.2001
format="ddd MMMM d yy" -> Tue May 21 01
format="hh:mm:ss.zzz" -> 14:13:09.042
format="h:m:s ap" -> 2:13:9 pm

Returns the current time and/or date.

interval - The update interval in milliseconds. The first specified interval parameter will be used for subsequent time sensors, although each sensor may still have it's own interval parameter.
default: interval=60000

format - The specification of the displayed text. Possible values are:
%d - Days.
%h - Hours.
%m - Minutes.
%s - Seconds.
%H - Hours with possible leading zero.
%M - Minutes with possible leading zero.
%S - Seconds with possible leading zero.
default: format="%dd %h:%M"

Get information from a possible running XMMS process.

interval - The update interval in milliseconds. The first specified interval parameter will be used for subsequent xmms sensors, although each sensor may still have it's own interval parameter.
default: interval=1000

encoding - This parameter will let you display text with, for example., Russian characters. The parameter value is the name of the encoding. A list of encodings can be found here: QTextCodec Class Reference. The first specified encoding parameter will be used for subsequent xmms sensors, although each sensor may still have it's own encoding parameter.
default: encoding="" - Your locale is used.
example: encoding="KOI8-R"
example: encoding="ISO8859-6"

format - The specification of the displayed text. Possible values are:
%title - Title of the current song.
%time - Time of the current song.
%remain - Remaining time of the current song.
%length - Length of the current song.
%full - Sensor returns MAX if XMMS is started, else 0. %full is useful when connecting the sensor to a bar, the image will be shown only if XMMS is running..
default: format="%title %time / %total"