Make a description of ${cpu} variable not so confusing.
[monky] / doc / variables.xml
index 8703f16..8b2dc7f 100644 (file)
                <option>(cpuN)</option>
        </term>
        <listitem>
-               CPU usage in percents.  For SMP machines, the CPU number can be provided as an argument.  cpu0 is the total usage, and >=cpu1 are individual CPUs. 
+               CPU usage in percents.  For SMP machines, the CPU number can be provided as an argument.  ${cpu 0} is the total usage, and ${cpu X} (X >= 1) are individual CPUs. 
        <para></para></listitem>
 </varlistentry>
 
 <varlistentry>
        <term>
                <command><option>font</option></command>
-       <option>font</option>
+       <option>(font)</option>
        </term>
        <listitem>
-               Specify a different font. Only applies to one line.
+               Specify a different font. This new font will apply to the current line and everything following.  You can use a $font with no arguments to change back to the default font (much like with $color)
        <para></para></listitem>
 </varlistentry>
 
+<varlistentry>
+       <term>
+               <command><option>freq</option></command>
+               <option>(n)</option>
+       </term>
+       <listitem>
+               Returns CPU #n's frequency in MHz. CPUs are
+               counted from 1. If omitted, the parameter
+               defaults to 1.
+               <para></para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>
+               <command><option>freq_g</option></command>
+               <option>(n)</option>
+       </term>
+       <listitem>
+               Returns CPU #n's frequency in GHz. CPUs are
+               counted from 1. If omitted, the parameter
+               defaults to 1.
+               <para></para></listitem>
+</varlistentry>
        
-       <varlistentry>
-               <term>
-                       <command><option>freq</option></command>
-               </term>
-               <listitem>
-                       Returns CPU frequency in MHz
-                       <para></para></listitem>
-       </varlistentry>
-       <varlistentry>
-               <term>
-                       <command><option>freq_g</option></command>
-               </term>
-               <listitem>
-                       Returns CPU frequency in GHz
-                       <para></para></listitem>
-       </varlistentry>
-       
-       <varlistentry>
-               <term>
-                       <command><option>freq_dyn</option></command>
-               </term>
-               <listitem>
+<varlistentry>
+       <term>
+               <command><option>freq_dyn</option></command>
+       </term>
+       <listitem>
                        Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction.  Only available for x86/amd64.
                        <para></para></listitem>
-       </varlistentry>
-       <varlistentry>
-               <term>
-                       <command><option>freq_dyn_g</option></command>
-               </term>
-               <listitem>
-                       Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction.  Only available for x86/amd64.
-                       <para></para></listitem>
-       </varlistentry>
+</varlistentry>
+
+<varlistentry>
+       <term>
+               <command><option>freq_dyn_g</option></command>
+       </term>
+       <listitem>
+               Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction.  Only available for x86/amd64.
+       <para></para></listitem>
+</varlistentry>
        
-       <varlistentry>
+<varlistentry>
        <term>
                <command><option>fs_bar</option></command>
        <option>(height),(width) fs</option>
 
 <varlistentry>
        <term>
+               <command><option>goto</option></command>
+               <option>x</option>
+       </term>
+       <listitem>
+        The next element will be printed at position 'x'.
+               <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term>
+               <command><option>hddtemp</option></command>
+               <option>dev, (host,(port))</option>
+       </term>
+       <listitem>
+               Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
+               Default host is 127.0.0.1, default port is 7634.
+               <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term>
                <command><option>head</option></command>
                <option>logfile lines (interval)</option>
        </term>
 
 <varlistentry>
        <term>
+               <command><option>iconv_start</option></command>
+       <option>codeset_from codeset_to</option>
+       </term>
+       <listitem>
+               Convert text from one codeset to another using GNU iconv.  Needs to be stopped with iconv_stop.
+       <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term>
+               <command><option>iconv_stop</option></command>
+       <option></option>
+       </term>
+       <listitem>
+               Stop iconv codeset conversion.
+       <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term>
                <command><option>i2c</option></command>
        <option>(dev) type n</option>
        </term>
        <para></para></listitem>
 </varlistentry>
 
+<varlistentry>
+       <term>
+               <command><option>ibm_fan</option></command>
+       </term>
+       <listitem>
+               If running the IBM ACPI, displays the fan speed.
+       <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term>
+               <command><option>ibm_temps</option></command>
+               <option>N</option>
+       </term>
+       <listitem>
+               If running the IBM ACPI, displays the temperatures
+               from the IBM temperature sensors (N=0..7) Sensor 0 is
+               on the CPU, 3 is on the GPU.
+       <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term>
+               <command><option>ibm_volume</option></command>
+       </term>
+       <listitem>
+               If running the IBM ACPI, displays the "master" volume,
+       controlled by the volume keys (0-14).
+       <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term>
+               <command><option>ibm_brightness</option></command>
+       </term>
+       <listitem>
+               If running the IBM ACPI, displays the brigtness of the
+       laptops's LCD (0-7).
+       <para></para></listitem>
+</varlistentry>
+
 
 <varlistentry>
        <term>
 
 <varlistentry>
        <term>
+               <command><option>imap_messages</option></command>
+       <option>(args)</option>
+       </term>
+       <listitem>
+               Displays the number of messages in your global IMAP inbox by default.  You can define individual IMAP inboxes seperately by passing arguments to this object.  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>imap_unseen</option></command>
+       <option>(args)</option>
+       </term>
+       <listitem>
+               Displays the number of unseen messages in your global IMAP inbox by default.  You can define individual IMAP inboxes seperately by passing arguments to this object.  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>kernel</option></command>
        </term>
        <listitem>
 
 <varlistentry>
        <term>
-               <command><option>mpd_smart<option></command>
+               <command><option>mpd_smart</option></command>
        </term>
        <listitem>
                Prints the song name in either the form "artist - title" or file name, depending on whats available
 
 <varlistentry>
        <term>
+               <command><option>pb_battery</option></command>
+               <option>item</option>
+       </term>
+       <listitem>
+                If running on Apple powerbook/ibook, display
+                information on battery status. The item parameter
+                specifies, what information to display. Exactly one item
+                must be specified. Valid items are:
+               <simplelist>
+                        <member><command>status</command>:
+                                Display if battery is fully charged, charging,
+                                discharging or absent (running on AC)
+                        </member>
+                        <member><command>percent</command>:
+                                Display charge of battery in percent, if
+                                charging or discharging. Nothing will be
+                                displayed, if battery is fully charged
+                                or absent.
+                        </member>
+                        <member><command>time</command>:
+                                Display the time remaining until the battery
+                                will be fully charged or discharged at current
+                                rate.  Nothing is displayed, if battery is
+                                absent or if it's present but fully charged
+                                and not discharging.
+                        </member>
+                </simplelist>
+       <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term>
+               <command><option>pop3_unseen</option></command>
+       <option>(args)</option>
+       </term>
+       <listitem>
+               Displays the number of unseen messages in your global POP3 inbox by default.  You can define individual POP3 inboxes seperately by passing arguments to this object.  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>pop3_used</option></command>
+       <option>(args)</option>
+       </term>
+       <listitem>
+               Displays the amount of space (in MiB, 2^20) used in your global POP3 inbox by default.  You can define individual POP3 inboxes seperately by passing arguments to this object.  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>pre_exec</option></command>
        <option>shell command</option>
        </term>
                                </member>
                        <member><command>rport</command> - remote port number
                                </member>
+                       <member><command>rservice</command> - remote service name from /etc/services
+                               </member>
                        <member><command>lip</command> - local ip address
                                </member>
                        <member><command>lhost</command> - local host name
                                </member>
+                       <member><command>lport</command> - local port number
+                               </member>
                        <member><command>lservice</command> - local service name from /etc/services
                                </member>
                </simplelist>The connection index provides you with access to each connection in the port monitor.  The monitor will return information for index values from 0 to n-1 connections.  Values higher than n-1 are simply ignored.  For the "count" item, the connection index must be omitted.  It is required for all other items.
 
 <varlistentry>
        <term>
+               <command><option>tab</option></command>
+               <option>(width, (start))</option>
+       </term>
+       <listitem>
+        Puts a tab of the specified width, starting from column 'start'.
+       <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term>
                <command><option>tail</option></command>
                <option>logfile lines (interval)</option>
        </term>
 
 <varlistentry>
        <term>
+               <command><option>utime</option></command>
+       <option>(format)</option>
+       </term>
+       <listitem>
+               Display time in UTC (universal coordinate time).
+       <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term>
+               <command><option>tztime</option></command>
+       <option>(timezone) (format)</option>
+       </term>
+       <listitem>
+               Local time for specified timezone, see man strftime to get more information about format. The timezone argument is  specified in similar fashion as TZ environment variable. For hints, look in /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
+       <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term>
                <command><option>totaldown</option></command>
        <option>net</option>
        </term>
        <option>type, num</option>
        </term>
        <listitem>
-               This takes arguments in the form:top (name) (number) Basically, processes are ranked from highest to lowest in terms of cpu usage, which is what (num) represents. The types are: "name", "pid", "cpu", and mem". There can be a max of 10 processes listed.
+               This takes arguments in the form:top (name) (number) Basically, processes are ranked from highest to lowest in terms of cpu usage, which is what (num) represents. The types are: "name", "pid", "cpu", and "mem". There can be a max of 10 processes listed.
        <para></para></listitem>
 </varlistentry>
 
                Seti@home total user credit
        <para></para></listitem>
 </varlistentry>
+
 <varlistentry>
        <term>
                <command><option>voffset</option></command>
 
 <varlistentry>
        <term>
+               <command><option>voltage_mv</option></command>
+               <option>(n)</option>
+       </term>
+       <listitem>
+               Returns CPU #n's voltage in mV. CPUs are
+               counted from 1. If omitted, the parameter
+               defaults to 1. 
+               <para></para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term>
+               <command><option>voltage_v</option></command>
+               <option>(n)</option>
+       </term>
+       <listitem>
+               Returns CPU #n's voltage in V. CPUs are
+               counted from 1. If omitted, the parameter
+               defaults to 1.
+               <para></para></listitem>
+</varlistentry>
+               
+<varlistentry>
+       <term>
                <command><option>xmms_bar</option></command>
                 <option>(height),(width)</option>
        </term>
        <para></para></listitem>
 </varlistentry>
 
-
 </variablelist>