nvidia: fix syntax in variables.xml
[monky] / doc / variables.xml
index b797373..18dc481 100644 (file)
             </command>
             <option>(color)</option>
         </term>
-        <listitem>Change drawing color to color 
+        <listitem>Change drawing color to 'color' which is a name of
+        a color or a hexcode preceded with # (for example #0A1B2C ).
+        If you use ncurses only the following colors are supported:
+       red,green,yellow,blue,magenta,cyan,black,white.
         <para /></listitem>
     </varlistentry>
     <varlistentry>
             <command>
                 <option>curl</option>
             </command>
-            <option>url interval_in_minutes</option>
+            <option>url (interval_in_minutes)</option>
         </term>
         <listitem>
             <para>Download data from URI using Curl at the
             <command>
                 <option>hddtemp</option>
             </command>
-            <option>dev, (host,(port))</option>
+            <option>(dev)</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.
-        
+               drive as reported by the hddtemp daemon. Use hddtemp_host
+               and hddtemp_port to specify a host and port for all hddtemp
+               objects. If no dev parameter is given, the first disk returned
+               by the hddtemp daemon is used.
         <para /></listitem>
     </varlistentry>
     <varlistentry>
         IMAP inbox by default. You can define individual IMAP
         inboxes seperately by passing arguments to this object.
         Arguments are: "host user pass [-i interval (in seconds)]
-        [-f folder] [-p port] [-e command] [-r retries]". Default
+        [-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
         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 (in
-        seconds)] [-f folder] [-p port] [-e command] [-r retries]".
+        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
         other values as integer. 
         <simplelist>
             <member>
-            <command>threshold</command>The thresholdtemperature at
-            which the gpu slows down</member>
+               <command>threshold</command>
+               <option>The thresholdtemperature at
+                       which the gpu slows down</option>
+            </member>
             <member>
-            <command>temp</command>Tives the gpu current
-            temperature</member>
+               <command>temp</command>
+               <option>Gives the gpu current
+                       temperature</option>
+            </member>
             <member>
                 <command>ambient</command>
                 <option>Gives current air temperature near GPU
         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 (in
-        seconds)] [-p port] [-e command] [-r retries]". Default
+        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 to enter the password
         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
-        (in seconds)] [-p port] [-e command] [-r retries]". Default
+        (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 to enter the password
             <command>
                 <option>tztime</option>
             </command>
-            <option>(timezone) (format)</option>
+            <option>(timezone (format))</option>
         </term>
         <listitem>Local time for specified timezone, see man
         strftime to get more information about format. The timezone
             <simplelist>
                 <member>
                     <command>last_update</command>
-                    <option>The date and time stamp of the data.
+                    <para>The date and time stamp of the data.
                     The result depends on the URI used. For the
                     NOAA site it is date (yyyy/mm/dd) and UTC time.
                     For the weather.com one it is date
                     ([m]m/[d]d/yy) and Local Time of the
-                    station.</option>
+                    station.</para>
                 </member>
                 <member>
                     <command>temperature</command>
-                    <option>Air temperature (you can use the
+                                       <para>Air temperature (you can use the
                     'temperature_unit' config setting to change
-                    units)</option>
+                                       units)</para>
                 </member>
                 <member>
                     <command>cloud_cover</command>
-                    <option>The highest cloud cover status</option>
+                    <para>The highest cloud cover status</para>
                 </member>
                 <member>
                     <command>pressure</command>
-                    <option>Air pressure in millibar</option>
+                    <para>Air pressure in millibar</para>
                 </member>
                 <member>
                     <command>wind_speed</command>
-                    <option>Wind speed in km/h</option>
+                    <para>Wind speed in km/h</para>
                 </member>
                 <member>
                     <command>wind_dir</command>
-                    <option>Wind direction</option>
+                    <para>Wind direction</para>
                 </member>
                 <member>
                     <command>wind_dir_DEG</command>
-                    <option>Compass wind direction</option>
+                    <para>Compass wind direction</para>
                 </member>
                 <member>
                     <command>humidity</command>
-                    <option>Relative humidity in %</option>
+                    <para>Relative humidity in %</para>
                 </member>
                 <member>
                     <command>weather</command>
-                    <option>Any relevant weather event (rain, snow,
+                    <para>Any relevant weather event (rain, snow,
                     etc.). This is not used if you are querying the
                     weather.com site since this data is aggregated
-                    into the cloud_cover one</option>
+                    into the cloud_cover one</para>
                 </member>
                 <member>
                     <command>icon</command>
-                    <option>Weather icon (only for
+                    <para>Weather icon (only for
                     www.weather.com). Can be used together with the
                     icon kit provided upon registering to their
-                    service.</option>
+                    service.</para>
                 </member>
             </simplelist>
             <para>'delay_in_minutes' (optional, default 30) cannot
-            be lower than 30 min.</para>
+            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
+            will run for each URI specified.</para>
+            <para>Note that these variables are still EXPERIMENTAL
+            and can be subject to many future changes.</para>
+        </listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>weather_forecast</option>
+            </command>
+            <option>URI locID day data_type
+            (interval_in_minutes)</option>
+        </term>
+        <listitem>
+            <para>Download, parse and display weather forecast data
+           for a given day (daytime only).</para>
+            <para>For the 'URI', for the time being only
+            http://xoap.weather.com/weather/local/ is
+           supported. See 'weather' above for details of usage</para>
+            <para>'locID', see 'weather' above.</para>
+            <para>'day' is a number from 0 (today) to 4 (3 days
+            after tomorrow).</para>
+            <para>'data_type' must be one of the following:</para>
+            <simplelist>
+                <member>
+                    <command>day</command>
+                                       <option>Day of the week</option>
+                               </member>
+                <member>
+                    <command>date</command>
+                                       <option>Date, in the form MMM DD (ie. Jul 14)</option>
+                               </member>
+                <member>
+                    <command>low</command>
+                                       <option>Minimun temperature (you can use the
+                    'temperature_unit' config setting to change
+                    units)</option>
+                               </member>
+                <member>
+                    <command>hi</command>
+                                       <option>Maximum temperature (you can use the
+                    'temperature_unit' config setting to change
+                    units)</option>
+                               </member>
+                <member>
+                    <command>icon</command>
+                    <option>Weather icon. Can be used together with the
+                    icon kit provided upon registering to the weather.com
+                    service</option>
+                               </member>
+                <member>
+                    <command>forecast</command>
+                    <option>Weather forecast (sunny, rainy, etc.)</option>
+                               </member>
+                <member>
+                    <command>wind_speed</command>
+                    <option>Wind speed in km/h</option>
+                </member>
+                <member>
+                    <command>wind_dir</command>
+                    <option>Wind direction</option>
+                </member>
+                <member>
+                    <command>wind_dir_DEG</command>
+                    <option>Compass wind direction</option>
+                </member>
+                <member>
+                    <command>humidity</command>
+                    <option>Relative humidity in %</option>
+                </member>
+                <member>
+                    <command>precipitation</command>
+                    <option>Probability of having a
+                                       precipitation (in %)</option>
+                </member>
+            </simplelist>
+            <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
             will run for each URI specified. You can use any
             protocol that Curl supports.</para>
             <para>Note that these variables are still EXPERIMENTAL
             and can be subject to many future changes.</para>
-        </listitem>
+       </listitem>
     </varlistentry>
     <varlistentry>
         <term>