Fix for segfault in top_name stuff.

[monky] / doc / lua.xml

diff --git a/doc/lua.xml b/doc/lua.xml
index cb7f8f1..e55e159 100644 (file)
--- a/doc/lua.xml
+++ b/doc/lua.xml
@@ -15,6 +15,18 @@
     <varlistentry>
         <term>
             <command>
+                <option>conky_set_update_interval(number)</option>
+            </command>
+            <option>function</option>
+        </term>
+        <listitem>
+            <para>Sets Conky's update interval (in seconds) to
+            'number'.</para>
+        </listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
                 <option>conky_window</option>
             </command>
             <option>table</option>
@@ -26,60 +38,63 @@
             <simplelist>
                 <member>
                     <command>drawable</command>
-                    <option>Window's drawable (Xlib
-                    Drawable)</option>
+                    <option>Window's drawable (Xlib Drawable),
+                    requires Lua extras enabled at compile
+                    time.</option>
                 </member>
                 <member>
                     <command>visual</command>
-                    <option>Window's visual (Xlib Visual)</option>
+                    <option>Window's visual (Xlib Visual), requires
+                    Lua extras enabled at compile time.</option>
                 </member>
                 <member>
                     <command>display</command>
-                    <option>Window's display (Xlib
-                    Display)</option>
+                    <option>Window's display (Xlib Display),
+                    requires Lua extras enabled at compile
+                    time.</option>
                 </member>
                 <member>
                     <command>width</command>
-                    <option>Window width (in pixels)</option>
+                    <option>Window width (in pixels).</option>
                 </member>
                 <member>
                     <command>height</command>
-                    <option>Window height (in pixels)</option>
+                    <option>Window height (in pixels).</option>
                 </member>
                 <member>
                     <command>border_inner_margin</command>
                     <option>Window's inner border margin (in
-                    pixels)</option>
+                    pixels).</option>
                 </member>
                 <member>
                     <command>border_outer_margin</command>
                     <option>Window's outer border margin (in
-                    pixels)</option>
+                    pixels).</option>
                 </member>
                 <member>
                     <command>border_width</command>
                     <option>Window's border width (in
-                    pixels)</option>
+                    pixels).</option>
                 </member>
                 <member>
                     <command>text_start_x</command>
                     <option>The x component of the starting
-                    coordinate of text drawing</option>
+                    coordinate of text drawing.</option>
                 </member>
                 <member>
                     <command>text_start_y</command>
                     <option>The y component of the starting
-                    coordinate of text drawing</option>
+                    coordinate of text drawing.</option>
                 </member>
                 <member>
                     <command>text_width</command>
                     <option>The width of the text drawing
-                    region</option>
+                    region.</option>
                 </member>
                 <member>
                     <command>text_height</command>
                     <option>The height of the text drawing
-                    region</option>
+                    region.</option>
                 </member>
             </simplelist>
             <para>NOTE: This table is only defined when X support
@@ -89,6 +104,30 @@
     <varlistentry>
         <term>
             <command>
+                <option>conky_info</option>
+            </command>
+            <option>table</option>
+        </term>
+        <listitem>
+            <para>This table contains some information about
+            Conky's internal data. The following table describes
+            the values contained:</para>
+            <simplelist>
+                <member>
+                    <command>update_interval</command>
+                    <option>Conky's update interval (in
+                    seconds).</option>
+                </member>
+                <member>
+                    <command>uptime</command>
+                    <option>System uptime, in seconds.</option>
+                </member>
+            </simplelist>
+        </listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
                 <option>conky_build_info</option>
             </command>
             <option>string</option>
@@ -147,4 +186,43 @@
             configuration file.</para>
         </listitem>
     </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>cairo_text_extents_t:create()</option>
+            </command>
+            <option>function</option>
+        </term>
+        <listitem>
+                       <para>
+                               Call this function to return a new cairo_text_extents_t structure.  A creation function for this structure is not provided by the cairo API.  After calling this, you should use tolua.takeownership() on the return value to ensure ownership is passed properly.
+                       </para>
+        </listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>cairo_font_extents_t:create()</option>
+            </command>
+            <option>function</option>
+        </term>
+        <listitem>
+                       <para>
+                               Call this function to return a new cairo_font_extents_t structure.  A creation function for this structure is not provided by the cairo API.  After calling this, you should use tolua.takeownership() on the return value to ensure ownership is passed properly.
+                       </para>
+        </listitem>
+    </varlistentry>
+    <varlistentry>
+        <term>
+            <command>
+                <option>cairo_matrix_t:create()</option>
+            </command>
+            <option>function</option>
+        </term>
+        <listitem>
+                       <para>
+                               Call this function to return a new cairo_matrix_t structure.  A creation function for this structure is not provided by the cairo API.  After calling this, you should use tolua.takeownership() on the return value to ensure ownership is passed properly.
+                       </para>
+        </listitem>
+    </varlistentry>
 </variablelist>