s/substract/subtract/
[monky] / doc / config_settings.xml
index 054157f..0467ec1 100644 (file)
@@ -19,9 +19,9 @@
         </term>
         <listitem>Aligned position on screen, may be top_left,
         top_right, top_middle, bottom_left, bottom_right,
-        bottom_middle, middle_left, middle_right, or none (also can
-        be abreviated as tl, tr, tm, bl, br, bm, ml, mr). See also
-        gap_x and gap_y. 
+        bottom_middle, middle_left, middle_middle, middle_right, or
+        none (also can be abreviated as tl, tr, tm, bl, br, bm, ml,
+        mm, mr). See also gap_x and gap_y.
         <para /></listitem>
     </varlistentry>
     <varlistentry>
     <varlistentry>
         <term>
             <command>
+                <option>disable_auto_reload</option>
+            </command>
+        </term>
+               <listitem>Enable to disable the inotify-based auto config reload feature.
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
                 <option>diskio_avg_samples</option>
             </command>
         </term>
     <varlistentry>
         <term>
             <command>
+                <option>hddtemp_host</option>
+            </command>
+        </term>
+       <listitem>Hostname to connect to for hddtemp objects. Defaults
+               to "127.0.0.1".
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>hddtemp_port</option>
+            </command>
+        </term>
+       <listitem>Port to use for hddtemp connections. Defaults to
+               7634.
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
                 <option>if_up_strictness</option>
             </command>
         </term>
             </command>
         </term>
         <listitem>Default global IMAP server. Arguments are: "host
-        user pass [-i interval (in seconds)] [-f folder] [-p port]
-        [-e command] [-r retries]". Default port is 143, default
+        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 5 minutes, and
         default number of retries before giving up is 5. If the
         password is supplied as '*', you will be prompted to enter
             </command>
         </term>
         <listitem>
-            <para>Imlib2 image cache size, in bytes. Defaults to
+            Imlib2 image cache size, in bytes. Defaults to
             4MiB. Increase this value if you use $image lots. Set
-            to 0 to disable the image cache.</para>
+            to 0 to disable the image cache.<para/>
         </listitem>
     </varlistentry>
     <varlistentry>
             <option>function_name [function arguments]</option>
         </term>
         <listitem>
-            <para>This function, if defined, will be called by
+            This function, if defined, will be called by
             Conky through each iteration after drawing to the
             window. Requires X support. Takes any number of
             optional arguments. Use this hook for drawing things on
             top of what Conky draws. Conky puts 'conky_' in front
             of function_name to prevent accidental calls to the
-            wrong function unless you place 'conky_' in front of
-            it yourself.</para>
+            wrong function unless you place 'conky_' in front of it
+            yourself.<para/>
         </listitem>
     </varlistentry>
     <varlistentry>
             <option>function_name [function arguments]</option>
         </term>
         <listitem>
-            <para>This function, if defined, will be called by
+            This function, if defined, will be called by
             Conky through each iteration before drawing to the
             window. Requires X support. Takes any number of
             optional arguments. Use this hook for drawing things on
             top of what Conky draws. Conky puts 'conky_' in front
             of function_name to prevent accidental calls to the
-            wrong function unless you place 'conky_' in front of
-            it yourself.</para>
+            wrong function unless you place 'conky_' in front of it
+            yourself.<para/>
         </listitem>
     </varlistentry>
     <varlistentry>
     <varlistentry>
         <term>
             <command>
+                <option>lua_shutdown_hook</option>
+            </command>
+            <option>function_name [function arguments]</option>
+        </term>
+        <listitem>
+            This function, if defined, will be called by
+            Conky at shutdown or when the configuration is
+            reloaded. Use this hook to clean up after yourself,
+            such as freeing memory which has been allocated by
+            external libraries via Lua. Conky puts 'conky_' in
+            front of function_name to prevent accidental calls to
+            the wrong function unless you place 'conky_' in
+            front of it yourself.<para/>
+        </listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>lua_startup_hook</option>
+            </command>
+            <option>function_name [function arguments]</option>
+        </term>
+        <listitem>
+            This function, if defined, will be called by
+            Conky at startup or when the configuration is reloaded.
+            Use this hook to initialize values, or for any run-once
+            applications. Conky puts 'conky_' in front of
+            function_name to prevent accidental calls to the wrong
+            function unless you place 'conky_' in front of
+            it yourself.<para/>
+        </listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
                 <option>mail_spool</option>
             </command>
         </term>
     <varlistentry>
         <term>
             <command>
+                <option>max_text_width</option>
+            </command>
+            <option>width</option>
+        </term>
+        <listitem>When a line in the output contains 'width'
+       chars and the end isn't reached, the next char will start
+       on a new line. If you want to make sure that lines don't
+       get broken, set 'width' to 0
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
                 <option>max_user_text</option>
             </command>
             <option>bytes</option>
                 <option>no_buffers</option>
             </command>
         </term>
-        <listitem>Substract (file system) buffers from used memory?
+        <listitem>Subtract (file system) buffers from used memory?
         
         <para /></listitem>
     </varlistentry>
         </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) 
+        value (e.g. ffffff, note the lack of '#') or a valid RGB
+        name (see /usr/lib/X11/rgb.txt)
         <para /></listitem>
     </varlistentry>
     <varlistentry>
     <varlistentry>
         <term>
             <command>
+                <option>own_window_argb_visual</option>
+            </command>
+        </term>
+               <listitem>Boolean, use ARGB visual? ARGB can be used for real
+                       transparency, note that a composite manager is required for real
+                       transparency.  This option will not work as desired (in most cases)
+                       in conjunction with 'own_window_type override'.
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>own_window_argb_value</option>
+            </command>
+        </term>
+               <listitem>When ARGB visuals are enabled, this use this to modify the alpha value used.  Valid range is 0-255, where 0 is 0% opacity, and 255 is 100% opacity.  Note that if own_window_transparent is enabled, this value has no effect.
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
                 <option>own_window_transparent</option>
             </command>
         </term>
-        <listitem>Boolean, set pseudo-transparency? 
+               <listitem>Boolean, set transparency? If ARGB visual is enabled, sets
+                       background opacity to 0%.
         <para /></listitem>
     </varlistentry>
     <varlistentry>
             </command>
         </term>
         <listitem>Default global POP3 server. Arguments are: "host
-        user pass [-i interval (in seconds)] [-p port] [-e command]
+        user pass [-i interval (in seconds)] [-p port] [-e 'command']
         [-r retries]". Default port is 110, default interval is 5
         minutes, and default number of retries before giving up is
         5. If the password is supplied as '*', you will be prompted
     <varlistentry>
         <term>
             <command>
+                <option>times_in_seconds</option>
+            </command>
+        </term>
+        <listitem>If true, variables that output times output a number
+       that represents seconds. This doesn't affect $time, $tztime and
+       $utime
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
                 <option>top_cpu_separate</option>
             </command>
         </term>