Fix parsing of XOAP xml.
[monky] / doc / variables.xml
index 1d8be43..b695418 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>
     <varlistentry>
         <term>
             <command>
+                <option>include</option>
+            </command>
+            <option>path</option>
+        </term>
+        <listitem>
+            <para>Loads the configfile at path, places the
+            configsettings behind the configsettings in the orginal
+            config and places the vars where the includevar
+            stood.</para>
+        </listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
                 <option>ioscheduler</option>
             </command>
             <option>disk</option>
             <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>
+                    <para>Weather icon (only for
+                    www.weather.com). Can be used together with the
+                    icon kit provided upon registering to their
+                    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>low</command>
+                                       <option>Minimun temperature (you can use the
+                    'temperature_unit' config setting to change
+                    units)</option>
+               </member>
+                <member>
+                    <command>high</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 150) cannot
+            be lower than 150 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>