git.maemo.org Git - monky/blob - doc/lua.xml

   1 <variablelist>
   2     <varlistentry>
   3         <term>
   4             <command>
   5                 <option>conky_parse(string)</option>
   6             </command>
   7             <option>function</option>
   8         </term>
   9         <listitem>
  10             <para>This function takes a string that is evaluated as
  11             per Conky's TEXT section, and then returns a string
  12             with the result.</para>
  13         </listitem>
  14     </varlistentry>
  15     <varlistentry>
  16         <term>
  17             <command>
  18                 <option>conky_set_update_interval(number)</option>
  19             </command>
  20             <option>function</option>
  21         </term>
  22         <listitem>
  23             <para>Sets Conky's update interval (in seconds) to
  24             'number'.</para>
  25         </listitem>
  26     </varlistentry>
  27     <varlistentry>
  28         <term>
  29             <command>
  30                 <option>conky_window</option>
  31             </command>
  32             <option>table</option>
  33         </term>
  34         <listitem>
  35             <para>This table contains some information about
  36             Conky's window. The following table describes the
  37             values contained:</para>
  38             <simplelist>
  39                 <member>
  40                     <command>drawable</command>
  41                     <option>Window's drawable (Xlib Drawable),
  42                     requires Lua extras enabled at compile
  43                     time.</option>
  44                 </member>
  45                 <member>
  46                     <command>visual</command>
  47                     <option>Window's visual (Xlib Visual), requires
  48                     Lua extras enabled at compile time.</option>
  49                 </member>
  50                 <member>
  51                     <command>display</command>
  52                     <option>Window's display (Xlib Display),
  53                     requires Lua extras enabled at compile
  54                     time.</option>
  55                 </member>
  56                 <member>
  57                     <command>width</command>
  58                     <option>Window width (in pixels).</option>
  59                 </member>
  60                 <member>
  61                     <command>height</command>
  62                     <option>Window height (in pixels).</option>
  63                 </member>
  64                 <member>
  65                     <command>border_inner_margin</command>
  66                     <option>Window's inner border margin (in
  67                     pixels).</option>
  68                 </member>
  69                 <member>
  70                     <command>border_outer_margin</command>
  71                     <option>Window's outer border margin (in
  72                     pixels).</option>
  73                 </member>
  74                 <member>
  75                     <command>border_width</command>
  76                     <option>Window's border width (in
  77                     pixels).</option>
  78                 </member>
  79                 <member>
  80                     <command>text_start_x</command>
  81                     <option>The x component of the starting
  82                     coordinate of text drawing.</option>
  83                 </member>
  84                 <member>
  85                     <command>text_start_y</command>
  86                     <option>The y component of the starting
  87                     coordinate of text drawing.</option>
  88                 </member>
  89                 <member>
  90                     <command>text_width</command>
  91                     <option>The width of the text drawing
  92                     region.</option>
  93                 </member>
  94                 <member>
  95                     <command>text_height</command>
  96                     <option>The height of the text drawing
  97                     region.</option>
  98                 </member>
  99             </simplelist>
 100             <para>NOTE: This table is only defined when X support
 101             is enabled.</para>
 102         </listitem>
 103     </varlistentry>
 104     <varlistentry>
 105         <term>
 106             <command>
 107                 <option>conky_info</option>
 108             </command>
 109             <option>table</option>
 110         </term>
 111         <listitem>
 112             <para>This table contains some information about
 113             Conky's internal data. The following table describes
 114             the values contained:</para>
 115             <simplelist>
 116                 <member>
 117                     <command>update_interval</command>
 118                     <option>Conky's update interval (in
 119                     seconds).</option>
 120                 </member>
 121                 <member>
 122                     <command>uptime</command>
 123                     <option>System uptime, in seconds.</option>
 124                 </member>
 125             </simplelist>
 126         </listitem>
 127     </varlistentry>
 128     <varlistentry>
 129         <term>
 130             <command>
 131                 <option>conky_build_info</option>
 132             </command>
 133             <option>string</option>
 134         </term>
 135         <listitem>
 136             <para>A string containing the build info for this
 137             particular instance of Conky, including the version,
 138             build date, and architecture.</para>
 139         </listitem>
 140     </varlistentry>
 141     <varlistentry>
 142         <term>
 143             <command>
 144                 <option>conky_build_date</option>
 145             </command>
 146             <option>string</option>
 147         </term>
 148         <listitem>
 149             <para>A string containing the build date for this
 150             particular instance of Conky.</para>
 151         </listitem>
 152     </varlistentry>
 153     <varlistentry>
 154         <term>
 155             <command>
 156                 <option>conky_build_arch</option>
 157             </command>
 158             <option>string</option>
 159         </term>
 160         <listitem>
 161             <para>A string containing the build architecture for
 162             this particular instance of Conky.</para>
 163         </listitem>
 164     </varlistentry>
 165     <varlistentry>
 166         <term>
 167             <command>
 168                 <option>conky_version</option>
 169             </command>
 170             <option>string</option>
 171         </term>
 172         <listitem>
 173             <para>A string containing the version of the current
 174             instance of Conky.</para>
 175         </listitem>
 176     </varlistentry>
 177     <varlistentry>
 178         <term>
 179             <command>
 180                 <option>conky_config</option>
 181             </command>
 182             <option>string</option>
 183         </term>
 184         <listitem>
 185             <para>A string containing the path of the current Conky
 186             configuration file.</para>
 187         </listitem>
 188     </varlistentry>
 189     <varlistentry>
 190         <term>
 191             <command>
 192                 <option>cairo_text_extents_t:create()</option>
 193             </command>
 194             <option>function</option>
 195         </term>
 196         <listitem>
 197                         <para>
 198                                 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.
 199                         </para>
 200         </listitem>
 201     </varlistentry>
 202     <varlistentry>
 203         <term>
 204             <command>
 205                 <option>cairo_font_extents_t:create()</option>
 206             </command>
 207             <option>function</option>
 208         </term>
 209         <listitem>
 210                         <para>
 211                                 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.
 212                         </para>
 213         </listitem>
 214     </varlistentry>
 215     <varlistentry>
 216         <term>
 217             <command>
 218                 <option>cairo_matrix_t:create()</option>
 219             </command>
 220             <option>function</option>
 221         </term>
 222         <listitem>
 223                         <para>
 224                                 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.
 225                         </para>
 226         </listitem>
 227     </varlistentry>
 228 </variablelist>