vcs.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>
  24                                 Sets Conky's update interval (in seconds) to 'number'.
  25                         </para>
  26                 </listitem>
  27         </varlistentry>
  28         <varlistentry>
  29                 <term>
  30                         <command>
  31                                 <option>conky_window</option>
  32                         </command>
  33                         <option>table</option>
  34                 </term>
  35                 <listitem>
  36                         <para>This table contains some information about
  37                                 Conky's window. The following table describes the
  38                                 values contained:</para>
  39                         <simplelist>
  40                                 <member>
  41                                         <command>drawable</command>
  42                                         <option>Window's drawable (Xlib
  43                                                 Drawable), requires Lua extras enabled at compile time.</option>
  44                                 </member>
  45                                 <member>
  46                                         <command>visual</command>
  47                                         <option>Window's visual (Xlib Visual), requires Lua extras enabled at compile time.</option>
  48                                 </member>
  49                                 <member>
  50                                         <command>display</command>
  51                                         <option>Window's display (Xlib
  52                                                 Display), requires Lua extras enabled at compile time.</option>
  53                                 </member>
  54                                 <member>
  55                                         <command>width</command>
  56                                         <option>Window width (in pixels).</option>
  57                                 </member>
  58                                 <member>
  59                                         <command>height</command>
  60                                         <option>Window height (in pixels).</option>
  61                                 </member>
  62                                 <member>
  63                                         <command>border_inner_margin</command>
  64                                         <option>Window's inner border margin (in
  65                                                 pixels).</option>
  66                                 </member>
  67                                 <member>
  68                                         <command>border_outer_margin</command>
  69                                         <option>Window's outer border margin (in
  70                                                 pixels).</option>
  71                                 </member>
  72                                 <member>
  73                                         <command>border_width</command>
  74                                         <option>Window's border width (in
  75                                                 pixels).</option>
  76                                 </member>
  77                                 <member>
  78                                         <command>text_start_x</command>
  79                                         <option>The x component of the starting
  80                                                 coordinate of text drawing.</option>
  81                                 </member>
  82                                 <member>
  83                                         <command>text_start_y</command>
  84                                         <option>The y component of the starting
  85                                                 coordinate of text drawing.</option>
  86                                 </member>
  87                                 <member>
  88                                         <command>text_width</command>
  89                                         <option>The width of the text drawing
  90                                                 region.</option>
  91                                 </member>
  92                                 <member>
  93                                         <command>text_height</command>
  94                                         <option>The height of the text drawing
  95                                                 region.</option>
  96                                 </member>
  97                         </simplelist>
  98                         <para>NOTE: This table is only defined when X support
  99                                 is enabled.</para>
 100                 </listitem>
 101         </varlistentry>
 102         <varlistentry>
 103                 <term>
 104                         <command>
 105                                 <option>conky_info</option>
 106                         </command>
 107                         <option>table</option>
 108                 </term>
 109                 <listitem>
 110                         <para>This table contains some information about
 111                                 Conky's internal data. The following table describes the
 112                                 values contained:</para>
 113                         <simplelist>
 114                                 <member>
 115                                         <command>update_interval</command>
 116                                         <option>Conky's update interval (in seconds).
 117                                         </option>
 118                                 </member>
 119                                 <member>
 120                                         <command>uptime</command>
 121                                         <option>System uptime, in seconds.
 122                                         </option>
 123                                 </member>
 124                         </simplelist>
 125                 </listitem>
 126         </varlistentry>
 127         <varlistentry>
 128                 <term>
 129                         <command>
 130                                 <option>conky_build_info</option>
 131                         </command>
 132                         <option>string</option>
 133                 </term>
 134                 <listitem>
 135                         <para>A string containing the build info for this
 136                                 particular instance of Conky, including the version,
 137                                 build date, and architecture.</para>
 138                 </listitem>
 139         </varlistentry>
 140         <varlistentry>
 141                 <term>
 142                         <command>
 143                                 <option>conky_build_date</option>
 144                         </command>
 145                         <option>string</option>
 146                 </term>
 147                 <listitem>
 148                         <para>A string containing the build date for this
 149                                 particular instance of Conky.</para>
 150                 </listitem>
 151         </varlistentry>
 152         <varlistentry>
 153                 <term>
 154                         <command>
 155                                 <option>conky_build_arch</option>
 156                         </command>
 157                         <option>string</option>
 158                 </term>
 159                 <listitem>
 160                         <para>A string containing the build architecture for
 161                                 this particular instance of Conky.</para>
 162                 </listitem>
 163         </varlistentry>
 164         <varlistentry>
 165                 <term>
 166                         <command>
 167                                 <option>conky_version</option>
 168                         </command>
 169                         <option>string</option>
 170                 </term>
 171                 <listitem>
 172                         <para>A string containing the version of the current
 173                                 instance of Conky.</para>
 174                 </listitem>
 175         </varlistentry>
 176         <varlistentry>
 177                 <term>
 178                         <command>
 179                                 <option>conky_config</option>
 180                         </command>
 181                         <option>string</option>
 182                 </term>
 183                 <listitem>
 184                         <para>A string containing the path of the current Conky
 185                                 configuration file.</para>
 186                 </listitem>
 187         </varlistentry>
 188 </variablelist>