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_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 Visual)</option>
  35                 </member>
  36                 <member>
  37                     <command>display</command>
  38                     <option>Window's display (Xlib
  39                     Display)</option>
  40                 </member>
  41                 <member>
  42                     <command>width</command>
  43                     <option>Window width (in pixels)</option>
  44                 </member>
  45                 <member>
  46                     <command>height</command>
  47                     <option>Window height (in pixels)</option>
  48                 </member>
  49                 <member>
  50                     <command>border_inner_margin</command>
  51                     <option>Window's inner border margin (in
  52                     pixels)</option>
  53                 </member>
  54                 <member>
  55                     <command>border_outer_margin</command>
  56                     <option>Window's outer border margin (in
  57                     pixels)</option>
  58                 </member>
  59                 <member>
  60                     <command>border_width</command>
  61                     <option>Window's border width (in
  62                     pixels)</option>
  63                 </member>
  64                 <member>
  65                     <command>text_start_x</command>
  66                     <option>The x component of the starting
  67                     coordinate of text drawing</option>
  68                 </member>
  69                 <member>
  70                     <command>text_start_y</command>
  71                     <option>The y component of the starting
  72                     coordinate of text drawing</option>
  73                 </member>
  74                 <member>
  75                     <command>text_width</command>
  76                     <option>The width of the text drawing
  77                     region</option>
  78                 </member>
  79                 <member>
  80                     <command>text_height</command>
  81                     <option>The height of the text drawing
  82                     region</option>
  83                 </member>
  84             </simplelist>
  85             <para>NOTE: This table is only defined when X support
  86             is enabled.</para>
  87         </listitem>
  88     </varlistentry>
  89     <varlistentry>
  90         <term>
  91             <command>
  92                 <option>conky_build_info</option>
  93             </command>
  94             <option>string</option>
  95         </term>
  96         <listitem>
  97             <para>A string containing the build info for this
  98             particular instance of Conky, including the version,
  99             build date, and architecture.</para>
 100         </listitem>
 101     </varlistentry>
 102     <varlistentry>
 103         <term>
 104             <command>
 105                 <option>conky_build_date</option>
 106             </command>
 107             <option>string</option>
 108         </term>
 109         <listitem>
 110             <para>A string containing the build date for this
 111             particular instance of Conky.</para>
 112         </listitem>
 113     </varlistentry>
 114     <varlistentry>
 115         <term>
 116             <command>
 117                 <option>conky_build_arch</option>
 118             </command>
 119             <option>string</option>
 120         </term>
 121         <listitem>
 122             <para>A string containing the build architecture for
 123             this particular instance of Conky.</para>
 124         </listitem>
 125     </varlistentry>
 126     <varlistentry>
 127         <term>
 128             <command>
 129                 <option>conky_version</option>
 130             </command>
 131             <option>string</option>
 132         </term>
 133         <listitem>
 134             <para>A string containing the version of the current
 135             instance of Conky.</para>
 136         </listitem>
 137     </varlistentry>
 138     <varlistentry>
 139         <term>
 140             <command>
 141                 <option>conky_config</option>
 142             </command>
 143             <option>string</option>
 144         </term>
 145         <listitem>
 146             <para>A string containing the path of the current Conky
 147             configuration file.</para>
 148         </listitem>
 149     </varlistentry>
 150 </variablelist>