Add weather_forecast object

[monky] / doc / config_settings.xml

diff --git a/doc/config_settings.xml b/doc/config_settings.xml
index 49ea372..5414211 100644 (file)
--- a/doc/config_settings.xml
+++ b/doc/config_settings.xml
@@ -14,22 +14,6 @@
     <varlistentry>
         <term>
             <command>
-                <option>alias</option>
-            </command>
-        </term>
-        <listitem>Use this to create aliases of variables. The
-        first argument is the new name, the second the old name,
-        and the other arguments are passed on to the variable.
-        Example: If you want to use $alpha instead of ${beta gamma
-        delta} then you have to write the following: alias alpha
-        beta gamma delta . PS: Instead of creating an alias in the
-        config you can also use environment variables. Example:
-        Start conky like this: alpha="beta gamma delta" conky 
-        <para /></listitem>
-    </varlistentry>
-    <varlistentry>
-        <term>
-            <command>
                 <option>alignment</option>
             </command>
         </term>
@@ -335,10 +319,11 @@
                 <option>imlib_cache_size</option>
             </command>
         </term>
-        <listitem>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 /></listitem>
+        <listitem>
+            <para>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>
+        </listitem>
     </varlistentry>
     <varlistentry>
         <term>
@@ -352,7 +337,10 @@
             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.</para>
+            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>
         </listitem>
     </varlistentry>
     <varlistentry>
@@ -367,7 +355,10 @@
             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.</para>
+            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>
         </listitem>
     </varlistentry>
     <varlistentry>
@@ -382,6 +373,41 @@
     <varlistentry>
         <term>
             <command>
+                <option>lua_shutdown_hook</option>
+            </command>
+            <option>function_name [function arguments]</option>
+        </term>
+        <listitem>
+            <para>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>
+            <para>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>
@@ -507,6 +533,17 @@
     <varlistentry>
         <term>
             <command>
+                <option>out_to_ncurses</option>
+            </command>
+        </term>
+        <listitem>Print text in the console, but use ncurses so
+        that conky can print the text of a new update over the old
+        text. (In the future this will provide more useful things) 
+        <para /></listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
                 <option>out_to_stderr</option>
             </command>
         </term>
@@ -775,7 +812,7 @@
             </command>
             <option>seconds</option>
         </term>
-        <listitem>Update interval
+        <listitem>Update interval 
         <para /></listitem>
     </varlistentry>
     <varlistentry>
@@ -785,7 +822,7 @@
             </command>
             <option>seconds</option>
         </term>
-        <listitem>Update interval when running on batterypower
+        <listitem>Update interval when running on batterypower 
         <para /></listitem>
     </varlistentry>
     <varlistentry>