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_window</option>
  19             </command>
  20             <option>table</option>
  21         </term>
  22         <listitem>
  23             <para>This table contains some information about
  24             Conky's window. The following table describes the
  25             values contained:</para>
  26             <simplelist>
  27                 <member>
  28                     <command>drawable</command>
  29                     <option>- Window's drawable (Xlib
  30                     Drawable)</option>
  31                 </member>
  32                 <member>
  33                     <command>visual</command>
  34                     <option>- Window's visual (Xlib
  35                     Visual)</option>
  36                 </member>
  37                 <member>
  38                     <command>display</command>
  39                     <option>- Window's display (Xlib
  40                     Display)</option>
  41                 </member>
  42                 <member>
  43                     <command>width</command>
  44                     <option>- Window width (in pixels)</option>
  45                 </member>
  46                 <member>
  47                     <command>height</command>
  48                     <option>- Window height (in pixels)</option>
  49                 </member>
  50                 <member>
  51                     <command>border_inner_margin</command>
  52                     <option>- Window's inner border margin (in
  53                     pixels)</option>
  54                 </member>
  55                 <member>
  56                     <command>border_outer_margin</command>
  57                     <option>- Window's outer border margin (in
  58                     pixels)</option>
  59                 </member>
  60                 <member>
  61                     <command>border_width</command>
  62                     <option>- Window's border width (in
  63                     pixels)</option>
  64                 </member>
  65                 <member>
  66                     <command>text_start_x</command>
  67                     <option>- The x component of the starting
  68                     coordinate of text drawing</option>
  69                 </member>
  70                 <member>
  71                     <command>text_start_y</command>
  72                     <option>- The y component of the starting
  73                     coordinate of text drawing</option>
  74                 </member>
  75                 <member>
  76                     <command>text_width</command>
  77                     <option>- The width of the text drawing
  78                     region</option>
  79                 </member>
  80                 <member>
  81                     <command>text_height</command>
  82                     <option>- The height of the text drawing
  83                     region</option>
  84                 </member>
  85             </simplelist>
  86             <para>NOTE: This table is only defined when X support
  87             is enabled.</para>
  88         </listitem>
  89     </varlistentry>
  90     <varlistentry>
  91         <term>
  92             <command>
  93                 <option>conky_build_info</option>
  94             </command>
  95             <option>string</option>
  96         </term>
  97         <listitem>
  98             <para>A string containing the build info for this
  99             particular instance of Conky, including the version,
 100             build date, and architecture.</para>
 101         </listitem>
 102     </varlistentry>
 103     <varlistentry>
 104         <term>
 105             <command>
 106                 <option>conky_version</option>
 107             </command>
 108             <option>string</option>
 109         </term>
 110         <listitem>
 111             <para>A string containing the version of the current
 112             instance of Conky.</para>
 113         </listitem>
 114     </varlistentry>
 115     <varlistentry>
 116         <term>
 117             <command>
 118                 <option>conky_config</option>
 119             </command>
 120             <option>string</option>
 121         </term>
 122         <listitem>
 123             <para>A string containing the path of the current Conky
 124             configuration file.</para>
 125         </listitem>
 126     </varlistentry>
 127 </variablelist>