make unit of all temperatures selectable
[monky] / doc / config_settings.xml
index 256e7f6..760c3fe 100644 (file)
        </varlistentry>
 
        <varlistentry>
-               <term><command><option>color0</option></command></term>
+               <term><command><option>colorN</option></command></term>
                <listitem>
-                       A color variable for use inside TEXT segments
-                       <para></para></listitem>
-       </varlistentry>
-
-       <varlistentry>
-               <term><command><option>color1</option></command></term>
-               <listitem>
-                       A color variable for use inside TEXT segments
-                       <para></para></listitem>
-       </varlistentry>
-
-       <varlistentry>
-               <term><command><option>color2</option></command></term>
-               <listitem>
-                       A color variable for use inside TEXT segments
-                       <para></para></listitem>
-       </varlistentry>
-
-       <varlistentry>
-               <term><command><option>color3</option></command></term>
-               <listitem>
-                       A color variable for use inside TEXT segments
-                       <para></para></listitem>
-       </varlistentry>
-
-       <varlistentry>
-               <term><command><option>color4</option></command></term>
-               <listitem>
-                       A color variable for use inside TEXT segments
-                       <para></para></listitem>
-       </varlistentry>
-
-       <varlistentry>
-               <term><command><option>color5</option></command></term>
-               <listitem>
-                       A color variable for use inside TEXT segments
-                       <para></para></listitem>
-       </varlistentry>
-
-       <varlistentry>
-               <term><command><option>color6</option></command></term>
-               <listitem>
-                       A color variable for use inside TEXT segments
-                       <para></para></listitem>
-       </varlistentry>
-
-       <varlistentry>
-               <term><command><option>color7</option></command></term>
-               <listitem>
-                       A color variable for use inside TEXT segments
-                       <para></para></listitem>
-       </varlistentry>
-
-       <varlistentry>
-               <term><command><option>color8</option></command></term>
-               <listitem>
-                       A color variable for use inside TEXT segments
-                       <para></para></listitem>
-       </varlistentry>
-
-       <varlistentry>
-               <term><command><option>color9</option></command></term>
-               <listitem>
-                       A color variable for use inside TEXT segments
+                       Predefine a color for use inside TEXT segments. Substitute N by a digit between 0 and 9, inclusively. When specifying the color value in hex, omit the leading hash (#).
                        <para></para></listitem>
        </varlistentry>
 
        </varlistentry>
 
        <varlistentry>
+               <term><command><option>if_up_strictness</option></command></term>
+               <listitem>
+                       How strict should if_up be when testing an interface for being up? The value is one of up, link or address, to check for the interface being solely up, being up and having link or being up, having link and an assigned IP address.
+                       <para></para></listitem>
+       </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.
+                       Default global IMAP server.  Arguments are: "host user pass [-i interval] [-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 the password when Conky starts.
                        <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).
+                       if own_window is yes, you may specify type normal, desktop, dock 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
        <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.
+                       Default global POP3 server.  Arguments are: "host user pass [-i interval] [-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 to enter the password when Conky starts.
                        <para></para></listitem>
        </varlistentry>
 
        </varlistentry>
 
        <varlistentry>
+               <term><command><option>show_graph_scale</option></command></term>
+               <listitem>
+                       Shows the maximum value in scaled graphs.
+                       <para></para></listitem>
+       </varlistentry>
+
+       <varlistentry>
+               <term><command><option>show_graph_range</option></command></term>
+               <listitem>
+                       Shows the time range covered by a graph.
+                       <para></para></listitem>
+       </varlistentry>
+
+       <varlistentry>
                <term><command><option>stippled_borders</option></command></term>
                <listitem>
                        Border stippling (dashing) in pixels
        </varlistentry>
 
        <varlistentry>
+               <term><command><option>temperature_unit</option></command></term>
+               <listitem>
+                       Desired output unit of all objects displaying a temperature.
+                       Parameters are either "fahrenheit" or "celsius". The default
+                       unit is degree Celsius.
+                       <para></para></listitem>
+       </varlistentry>
+
+       <varlistentry>
+               <term><command><option>templateN</option></command></term>
+               <listitem>
+                       Define a template for later use inside TEXT segments. Substitute N by a digit between 0 and 9, inclusively.
+                       The value of the variable is being inserted into the stuff below TEXT at the corresponding position,
+                       but before some substitutions are applied:
+                       <simplelist>
+                               <member>'\n' -> newline</member>
+                               <member>'\\' -> backslash</member>
+                               <member>'\ ' -> space</member>
+                               <member>'\N' -> template argument N</member>
+                       </simplelist>
+                       <para></para></listitem>
+       </varlistentry>
+
+       <varlistentry>
                <term><command><option>total_run_times</option></command></term>
                <listitem>
                        Total number of times for Conky to update before quitting. Zero makes Conky run forever