.\" -*- coding: us-ascii -*-
-.TH conky 1 2006-01-01
+.TH conky 1 2006-02-12
.SH NAME
conky \- A system monitor for X originally based on the torsmo code, but more kickass. It just keeps on given'er. Yeah.
.SH SYNOPSIS
.TP
\fBsh autogen.sh\fR \fB# Only required if building from CVS\fR
.TP
-\fB\&./configure \fR\fB\-\-prefix=/usr \-\-mandir=/usr/share/man \-\-infodir=/usr/share/info \-\-datadir=/usr/share \-\-sysconfdir=/etc \-\-localstatedir=/var/lib \-\-enable\-xft \-\-enable\-seti \-\-enable\-double\-buffer \-\-enable\-own\-window \-\-enable\-proc\-uptime \-\-enable\-mpd \-\-enable\-mldonkey \-\-enable\-x11 \-\-enable\-portmon \-\-enable\-bmpx \-\-enable\-infopipe\fR
+\fB\&./configure \fR\fB\-\-prefix=/usr \-\-mandir=/usr/share/man \-\-infodir=/usr/share/info \-\-datadir=/usr/share \-\-sysconfdir=/etc \-\-localstatedir=/var/lib \-\-enable\-xft \-\-enable\-seti \-\-enable\-double\-buffer \-\-enable\-own\-window \-\-enable\-proc\-uptime \-\-enable\-mpd \-\-enable\-mldonkey \-\-enable\-x11 \-\-enable\-portmon \-\-enable\-xmms \-\-enable\-bmp \-\-enable\-audacious \-\-enable\-infopipe \-\-enable\-bmpx \fR
.TP
\fBmake\fR
.TP
Minimum size of window
.TP
+\fBmin_port_monitors\fR
+Allow for the creation of at least this number of port monitors (if 0 or not set, default is 16)
+
+.TP
+\fBmin_port_monitor_connections\fR
+Allow each port monitor to track at least this many connections (if 0 or not set, default is 256)
+
+.TP
\fBmldonkey_hostname\fR
Hostname for mldonkey stuff, defaults to localhost
Boolean, set pseudo-transparency?
.TP
+\fBown_window_type\fR
+if own_window is yes, you may specify type normal, desktop or override (default: normal).
+Desktop windows are special windows that have no window decorations; are always visible
+on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
+Override windows are not under the control of the window manager. Hints are ignored. This type
+of window can be useful for certain situations.
+
+.TP
\fBown_window_colour\fR \fBcolour\fR
If own_window_transparent no, set a specified background colour (defaults to black). Takes either a hex value (#ffffff) or a valid RGB name (see /usr/lib/X11/rgb.txt)
.TP
+\fBown_window_hints\fR \fBundecorated,below,above,sticky,skip_taskbar,skip_pager\fR
+If own_window is yes, you may use these window manager hints to affect the way conky displays.
+Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
+If you use own_window_type override, window manager hints have no meaning and are ignored.
+
+.TP
\fBout_to_console\fR
Print text to stdout.
Use Xft (anti-aliased font and stuff)
.TP
-\fBmin_port_monitors\fR
-Allow for the creation of at least this number of port monitors (if 0 or not set, default is 16)
+\fBwm_class_name\fR
+Manually set the WM_CLASS name. Defaults to "conky".
.TP
-\fBmin_port_monitor_connections\fR
-Allow each port monitor to track at least this many connections (if 0 or not set, default is 256)
+\fBxmms_player\fR
+Use specified player/plugin for the xmms status variables. Valid items are: none, xmms, bmp, audacious and infopipe. (default is none). Note that bmpx is currently handled separately.
.TP
\fBTEXT\fR
Horizontal line, height is the height in pixels
.TP
-\fBi2c\fR \fB(dev), type, n\fR
+\fBi2c\fR \fB(dev) type n\fR
I2C sensor from sysfs (Linux 2.6). dev may be omitted if you have only one I2C device. type is either in (or vol) meaning voltage, fan meaning fan or temp/tempf (first in C, second in F) meaning temperature. n is number of the sensor. See /sys/bus/i2c/devices/ on your local computer.
.TP
.TP
\fBi8k_cpu_temp\fR \fB\fR
-If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in celsius, as reported by /proc/i8k.
+If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
.TP
\fBi8k_cpu_tempf\fR \fB\fR
-If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in farenheit, as reported by /proc/i8k.
+If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Farenheit, as reported by /proc/i8k.
.TP
\fBi8k_left_fan_rpm\fR \fB\fR
if MOUNTPOINT is mounted, display everything between if_mounted and the matching $endif
.TP
-\fBinfopipe_bar\fR \fB(height),(width)\fR
-XMMS/BMP InfoPipe progress bar
-
-.TP
-\fBinfopipe_bitrate\fR
-XMMS/BMP InfoPipe bitrate of current tune
-
-.TP
-\fBinfopipe_channels\fR
-XMMS/BMP InfoPipe number of audio channels of current tune
-
-.TP
-\fBinfopipe_file\fR
-XMMS/BMP InfoPipe full path and file name of current tune
-
-.TP
-\fBinfopipe_frequency\fR
-XMMS/BMP InfoPipe sampling frequency of current tune
-
-.TP
-\fBinfopipe_playlist_currtune\fR
-XMMS/BMP InfoPipe playlist index number of current tune
-
-.TP
-\fBinfopipe_playlist_tunes\fR
-XMMS/BMP InfoPipe number of tunes in the playlist
-
-.TP
-\fBinfopipe_position\fR
-XMMS/BMP InfoPipe play position (MM:SS) of current tune
-
-.TP
-\fBinfopipe_protocol\fR
-XMMS/BMP InfoPipe protocol
-
-.TP
-\fBinfopipe_status\fR
-XMMS/BMP InfoPipe status (Playing/Paused/Stopped/Not running)
-
-.TP
-\fBinfopipe_time\fR
-XMMS/BMP InfoPipe total time length (MM:SS) of current tune
-
-.TP
-\fBinfopipe_title\fR
-XMMS/BMP InfoPipe title of current tune
-
-.TP
-\fBinfopipe_usec_position\fR
-XMMS/BMP InfoPipe uSec position of current tune
-
-.TP
-\fBinfopipe_usec_time\fR
-XMMS/BMP InfoPipe uSec total time length of current tune
-
-.TP
-\fBinfopipe_version\fR
-XMMS/BMP InfoPipe plugin version
-
-.TP
\fBkernel\fR
Kernel version
Prints the MPD track field
.TP
+\fBmpd_name\fR
+Prints the MPD name field
+
+.TP
+\fBmpd_file\fR
+Prints the file name of the current MPD song
+
+.TP
+\fBmpd_smart\fR
+Prints the song name in either the form "artist - title" or file name, depending on whats available
+
+.TP
\fBnew_mails\fR
Unread mail count in mail spool.
.TP
\fBvoffset\fR \fB(pixels)\fR
-Change verticle offset by N pixels. Negative values will cause text to overlap. See also $offset.
+Change vertical offset by N pixels. Negative values will cause text to overlap. See also $offset.
+
+.TP
+\fBxmms_bar\fR \fB(height),(width)\fR
+xmms / bmp / audacious / infopipe: progress bar
+
+.TP
+\fBxmms_bitrate\fR
+xmms / bmp / audacious / infopipe: bitrate of current tune
+
+.TP
+\fBxmms_channels\fR
+xmms / bmp / audacious / infopipe: number of audio channels of current tune
+
+.TP
+\fBxmms_filename\fR
+xmms / bmp / audacious / infopipe: full path and filename of current tune
+
+.TP
+\fBxmms_frequency\fR
+xmms / bmp / audacious / infopipe: sampling frequency of current tune
+
+.TP
+\fBxmms_length\fR
+xmms / bmp / audacious / infopipe: total length of current tune as MM:SS
+
+.TP
+\fBxmms_length_seconds\fR
+xmms / bmp / audacious / infopipe: total length of current tune in seconds
+
+.TP
+\fBxmms_playlist_position\fR
+xmms / bmp / audacious / infopipe: playlist position of current tune
+
+.TP
+\fBxmms_playlist_length\fR
+xmms / bmp / audacious / infopipe: number of tunes in playlist
+
+.TP
+\fBxmms_position\fR
+xmms / bmp / audacious / infopipe: MM:SS position of current tune
+
+.TP
+\fBxmms_position_seconds\fR
+xmms / bmp / audacious / infopipe: position of current tune in seconds
+
+.TP
+\fBxmms_status\fR
+xmms / bmp / audacious / infopipe: player status (Playing/Paused/Stopped/Not running)
+
+.TP
+\fBxmms_title\fR
+xmms / bmp / audacious / infopipe: title of current tune
.SH EXAMPLES
.TP
projects / monky / blobdiff