Make a description of ${cpu} variable not so confusing.
[monky] / doc / config_settings.xml
index aed6fce..b122ab9 100644 (file)
@@ -16,7 +16,7 @@
 <varlistentry>
        <term><command><option>on_bottom</option></command></term>
        <listitem>
-               Set conky on the bottom of all other applications
+               Set Conky on the bottom of all other applications
        <para></para></listitem>
 </varlistentry>
 
 </varlistentry>
 
 <varlistentry>
+       <term><command><option>draw_graph_borders</option></command></term>
+       <listitem>
+               Draw borders around graphs?
+       <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
        <term><command><option>draw_shades</option></command></term>
        <listitem>
                Draw shades?
 </varlistentry>
 
 <varlistentry>
+       <term><command><option>imap</option></command></term>
+       <listitem>
+               Default global IMAP server.  Arguments are: "host user pass [-i interval] [-f folder] [-p port] [-e command]".  Default port is 143, default folder is 'INBOX', default interval is 5 minutes.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
+       <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
        <term><command><option>no_buffers</option></command></term>
        <listitem>
                Substract (file system) buffers from used memory?
 </varlistentry>
 
 <varlistentry>
-       <term><command><option>metar_station</option></command></term>
+       <term><command><option>maximum_width</option></command>
+               <option>pixels</option>
+       </term>
        <listitem>
-               METAR station code for weather, see http://www.wrh.noaa.gov/ if you need to find your code.
-       <para></para></listitem>
+               Maximum width of window
+               <para></para></listitem>
 </varlistentry>
 
 <varlistentry>
-       <term><command><option>metar_server</option></command></term>
+       <term><command><option>minimum_size</option></command>
+       <option>width (height)</option>
+       </term>
        <listitem>
-               Define a custom METAR ftp server
+               Minimum size of window
        <para></para></listitem>
 </varlistentry>
 
 <varlistentry>
-       <term><command><option>metar_path</option></command></term>
+       <term><command><option>min_port_monitors</option></command></term>
        <listitem>
-               Path on server to use
+               Allow for the creation of at least this number of port monitors (if 0 or not set, default is 16) 
        <para></para></listitem>
 </varlistentry>
 
 <varlistentry>
-       <term><command><option>minimum_size</option></command></term>
+       <term><command><option>min_port_monitor_connections</option></command></term>
        <listitem>
-               Minimum size of window
+               Allow each port monitor to track at least this many connections (if 0 or not set, default is 256)
        <para></para></listitem>
 </varlistentry>
 
 </varlistentry>
 
 <varlistentry>
-       <term><command><option>mpd_post</option></command></term>
+       <term><command><option>mpd_port</option></command></term>
        <listitem>
                Port of MPD server
        <para></para></listitem>
 </varlistentry>
 
 <varlistentry>
+       <term><command><option>own_window_transparent</option></command></term>
+       <listitem>
+               Boolean, set pseudo-transparency?
+               <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term><command><option>own_window_type</option></command></term>
+       <listitem>
+               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.
+               <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term><command><option>own_window_colour</option></command>
+               <option>colour</option>
+       </term>
+       <listitem>
+               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)
+               <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+        <term><command><option>own_window_hints</option></command>
+                <option>undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
+       </term>
+       <listitem>
+               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.
+       <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term><command><option>out_to_console</option></command>
+       </term>
+       <listitem>
+               Print text to stdout.
+               <para></para></listitem>
+</varlistentry>
+<varlistentry>
        <term><command><option>pad_percents</option></command></term>
        <listitem>
                Pad percentages to this many decimals (0 = no padding)
 </varlistentry>
 
 <varlistentry>
+       <term><command><option>pop3</option></command></term>
+       <listitem>
+               Default global POP3 server.  Arguments are: "host user pass [-i interval] [-p port] [-e command]".  Default port is 110, default interval is 5 minutes.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
+       <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
        <term><command><option>stippled_borders</option></command></term>
        <listitem>
                Border stippling (dashing) in pixels
 </varlistentry>
 
 <varlistentry>
-       <term><command><option>text</option></command></term>
+       <term><command><option>wm_class_name</option></command></term>
+       <listitem>
+               Manually set the WM_CLASS name.  Defaults to "conky".
+       <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term><command><option>xftalpha</option></command></term>
+       <listitem>
+               Alpha of Xft font.  Must be a value at or between 1 and 0.
+       <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term><command><option>xftfont</option></command></term>
+       <listitem>
+               Xft font to use.
+       <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term><command><option>xmms_player</option></command></term>
+       <listitem>
+               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.
+       <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term><command><option>TEXT</option></command></term>
        <listitem>
                After this begins text to be formatted on screen
        <para></para></listitem>
 </varlistentry>
 
-</variablelist>
\ No newline at end of file
+</variablelist>