Fix crash when using $desktop_name with out_to_x no
[monky] / doc / variables.xml
index e660bef..bc5c36c 100644 (file)
@@ -4,8 +4,11 @@
             <command>
                 <option>acpiacadapter</option>
             </command>
             <command>
                 <option>acpiacadapter</option>
             </command>
+            <option>(adapter)</option>
         </term>
         </term>
-        <listitem>ACPI ac adapter state. 
+        <listitem>ACPI ac adapter state. On linux, the adapter option specifies the
+        subfolder of /sys/class/power_supply containing the state information (defaults
+        to "AC"). Other systems ignore it.
         <para /></listitem>
     </varlistentry>
     <varlistentry>
         <para /></listitem>
     </varlistentry>
     <varlistentry>
             <option>var1 var2</option>
         </term>
         <listitem>Places the lines of var2 to the right of the
             <option>var1 var2</option>
         </term>
         <listitem>Places the lines of var2 to the right of the
-        lines of var1 seperated by the chars that are put between
+        lines of var1 separated by the chars that are put between
         var1 and var2. For example: ${combine ${head /proc/cpuinfo
         2} - ${head /proc/meminfo 1}} gives as output
         "cpuinfo_line1 - meminfo_line1" on line 1 and
         var1 and var2. For example: ${combine ${head /proc/cpuinfo
         2} - ${head /proc/meminfo 1}} gives as output
         "cpuinfo_line1 - meminfo_line1" on line 1 and
             point value greater than 0, otherwise defaults to 15
             minutes. Most useful when used in conjunction with Lua
             and the Lua API. This object is threaded, and once a
             point value greater than 0, otherwise defaults to 15
             minutes. Most useful when used in conjunction with Lua
             and the Lua API. This object is threaded, and once a
-            thread is created it can't be explicitely destroyed.
+            thread is created it can't be explicitly destroyed.
             One thread will run for each URI specified. You can use
             any protocol that Curl supports.</para>
         </listitem>
             One thread will run for each URI specified. You can use
             any protocol that Curl supports.</para>
         </listitem>
             </command>
             <option>seconds format</option>
         </term>
             </command>
             <option>seconds format</option>
         </term>
-        <listitem>Format time given in seconds. Format is a string
+        <listitem>Format time given in seconds. This var only works when
+       the times_in_seconds configuration setting is on. Format is a string
        that should start and end with a "-char. The "-chars are not
        that should start and end with a "-char. The "-chars are not
-       part of the output, \w,\d,\h,\m,\s and \\ are replaced by
-       weeks,days,hours,minutes,seconds and \. If you leave out a unit,
+       part of the output, \w,\d,\h,\m,\s,\(,\) and \\ are replaced by
+       weeks,days,hours,minutes,seconds,(,) and \. If you leave out a unit,
        it's value will be expressed in the highest unite lower then the
        one left out. Text between ()-chars will not be visible if a
        replaced unit in this text is 0. If seconds is a decimal number
        then you can see the numbers behind the point by using \S
        followed by a number that specifies the amount of
        digits behind the point that you want to see (maximum 9).
        it's value will be expressed in the highest unite lower then the
        one left out. Text between ()-chars will not be visible if a
        replaced unit in this text is 0. If seconds is a decimal number
        then you can see the numbers behind the point by using \S
        followed by a number that specifies the amount of
        digits behind the point that you want to see (maximum 9).
+       You can also place a 'x' behind \S so you have all digits behind
+       the point and no trailing zero's. (also maximum 9)
         <para /></listitem>
     </varlistentry>
     <varlistentry>
         <para /></listitem>
     </varlistentry>
     <varlistentry>
             digits.</member>
             <member>
             <command>string</command>Argument is enclosed in
             digits.</member>
             <member>
             <command>string</command>Argument is enclosed in
-            quotation mark or the checks for double and long failed
-            before.</member>
+            quotation marks (")</member>
         </simplelist>Valid operands are: '&gt;', '&lt;', '&gt;=',
         '&lt;=', '==', '!='. 
         <para /></listitem>
         </simplelist>Valid operands are: '&gt;', '&lt;', '&gt;=',
         '&lt;=', '==', '!='. 
         <para /></listitem>
         </term>
         <listitem>Displays the number of messages in your global
         IMAP inbox by default. You can define individual IMAP
         </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.
+        inboxes separately by passing arguments to this object.
         Arguments are: "host user pass [-i interval (in seconds)]
         [-f 'folder'] [-p port] [-e 'command'] [-r retries]". Default
         port is 143, default folder is 'INBOX', default interval is
         Arguments are: "host user pass [-i interval (in seconds)]
         [-f 'folder'] [-p port] [-e 'command'] [-r retries]". Default
         port is 143, default folder is 'INBOX', default interval is
         </term>
         <listitem>Displays the number of unseen messages in your
         global IMAP inbox by default. You can define individual
         </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
+        IMAP inboxes separately by passing arguments to this
         object. Arguments are: "host user pass [-i interval (in
         seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r retries]".
         Default port is 143, default folder is 'INBOX', default
         object. Arguments are: "host user pass [-i interval (in
         seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r retries]".
         Default port is 143, default folder is 'INBOX', default
             </member>
             <member>
                 <command>imagequality</command>
             </member>
             <member>
                 <command>imagequality</command>
-                <option>Which imagequality should be choosen by
+                <option>Which imagequality should be chosen by
                 OpenGL applications</option>
             </member>
         </simplelist>
                 OpenGL applications</option>
             </member>
         </simplelist>
     <varlistentry>
         <term>
             <command>
     <varlistentry>
         <term>
             <command>
+                <option>pid_read</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Total number of bytes read by the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
                 <option>pid_state</option>
             </command>
             <option>pid</option>
                 <option>pid_state</option>
             </command>
             <option>pid</option>
     <varlistentry>
         <term>
             <command>
     <varlistentry>
         <term>
             <command>
+                <option>pid_write</option>
+            </command>
+            <option>pid</option>
+        </term>
+        <listitem>Total number of bytes written by the process
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
                 <option>platform</option>
             </command>
             <option>(dev) type n (factor offset)</option>
                 <option>platform</option>
             </command>
             <option>(dev) type n (factor offset)</option>
         </term>
         <listitem>Displays the number of unseen messages in your
         global POP3 inbox by default. You can define individual
         </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
+        POP3 inboxes separately by passing arguments to this
         object. Arguments are: "host user pass [-i interval (in
         seconds)] [-p port] [-e 'command'] [-r retries]". Default
         port is 110, default interval is 5 minutes, and default
         object. Arguments are: "host user pass [-i interval (in
         seconds)] [-p port] [-e 'command'] [-r retries]". Default
         port is 110, default interval is 5 minutes, and default
         </term>
         <listitem>Displays the amount of space (in MiB, 2^20) used
         in your global POP3 inbox by default. You can define
         </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
+        individual POP3 inboxes separately by passing arguments to
         this object. Arguments are: "host user pass [-i interval
         (in seconds)] [-p port] [-e 'command'] [-r retries]". Default
         port is 110, default interval is 5 minutes, and default
         this object. Arguments are: "host user pass [-i interval
         (in seconds)] [-p port] [-e 'command'] [-r retries]". Default
         port is 110, default interval is 5 minutes, and default
             this action and spaces_in_front is given conky places
             that many spaces in front of each item). This object is
             threaded, and once a thread is created it can't be
             this action and spaces_in_front is given conky places
             that many spaces in front of each item). This object is
             threaded, and once a thread is created it can't be
-            explicitely destroyed. One thread will run for each URI
+            explicitly destroyed. One thread will run for each URI
             specified. You can use any protocol that Curl
             supports.</para>
         </listitem>
             specified. You can use any protocol that Curl
             supports.</para>
         </listitem>
         then the lines are placed behind each other separated with
         a '|'-sign. If you change the textcolor inside $scroll it
         will automatically have it's old value back at the end of
         then the lines are placed behind each other separated with
         a '|'-sign. If you change the textcolor inside $scroll it
         will automatically have it's old value back at the end of
-        $scroll. The end and the start of text will be seperated by
+        $scroll. The end and the start of text will be separated by
         'length' number of spaces. 
         <para /></listitem>
     </varlistentry>
         'length' number of spaces. 
         <para /></listitem>
     </varlistentry>
                         </row>
                         <row>
                             <entry>
                         </row>
                         <row>
                             <entry>
-                                <programlisting>${template1
+                                ${template1
                                 ${template2\ disk\ root}
                                 ${template2\ disk\ root}
-                                /}</programlisting>
+                                /}
                             </entry>
                             <entry>
                             </entry>
                             <entry>
-                                <programlisting>disk root:
+                                disk root:
                                 ${fs_free /} / ${fs_size
                                 ${fs_free /} / ${fs_size
-                                /}</programlisting>
+                                /}
                             </entry>
                         </row>
                     </tbody>
                             </entry>
                         </row>
                     </tbody>
             <para>'delay_in_minutes' (optional, default 30) cannot
             be less than 30 minutes.</para>
             <para>This object is threaded, and once a thread is
             <para>'delay_in_minutes' (optional, default 30) cannot
             be less than 30 minutes.</para>
             <para>This object is threaded, and once a thread is
-            created it can't be explicitely destroyed. One thread
+            created it can't be explicitly destroyed. One thread
             will run for each URI specified.</para>
             <para>Note that these variables are still EXPERIMENTAL
             and can be subject to many future changes.</para>
             will run for each URI specified.</para>
             <para>Note that these variables are still EXPERIMENTAL
             and can be subject to many future changes.</para>
             <para>'delay_in_minutes' (optional, default 210) cannot
             be lower than 210 min.</para>
             <para>This object is threaded, and once a thread is
             <para>'delay_in_minutes' (optional, default 210) cannot
             be lower than 210 min.</para>
             <para>This object is threaded, and once a thread is
-            created it can't be explicitely destroyed. One thread
+            created it can't be explicitly destroyed. One thread
             will run for each URI specified. You can use any
             protocol that Curl supports.</para>
             <para>Note that these variables are still EXPERIMENTAL
             will run for each URI specified. You can use any
             protocol that Curl supports.</para>
             <para>Note that these variables are still EXPERIMENTAL