docs
[monky] / doc / conky.1
index c98a9c0..a0fe1fd 100644 (file)
@@ -1,5 +1,5 @@
 .\" -*- 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
@@ -263,10 +263,24 @@ Boolean, create own window to draw?
 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.
 
@@ -532,11 +546,11 @@ If running the i8k kernel driver for Inspiron laptops, displays the volume butto
 
 .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
@@ -671,6 +685,10 @@ Prints the MPD name field
 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.
 
@@ -833,7 +851,7 @@ Seti@home total user credit
 
 .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