<variablelist>
- <varlistentry>
- <term>
- <command>
- <option>conky_parse(string)</option>
- </command>
- <option>function</option>
- </term>
- <listitem>
- <para>This function takes a string that is evaluated as
- per Conky's TEXT section, and then returns a string
- with the result.</para>
- </listitem>
- </varlistentry>
- <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>
- </term>
- <listitem>
- <para>This table contains some information about
- Conky's window. The following table describes the
- values contained:</para>
- <simplelist>
- <member>
- <command>drawable</command>
- <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), requires Lua extras enabled at compile time.</option>
- </member>
- <member>
- <command>display</command>
- <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>
- </member>
- <member>
- <command>height</command>
- <option>Window height (in pixels).</option>
- </member>
- <member>
- <command>border_inner_margin</command>
- <option>Window's inner border margin (in
- pixels).</option>
- </member>
- <member>
- <command>border_outer_margin</command>
- <option>Window's outer border margin (in
- pixels).</option>
- </member>
- <member>
- <command>border_width</command>
- <option>Window's border width (in
- pixels).</option>
- </member>
- <member>
- <command>text_start_x</command>
- <option>The x component of the starting
- coordinate of text drawing.</option>
- </member>
- <member>
- <command>text_start_y</command>
- <option>The y component of the starting
- coordinate of text drawing.</option>
- </member>
- <member>
- <command>text_width</command>
- <option>The width of the text drawing
- region.</option>
- </member>
- <member>
- <command>text_height</command>
- <option>The height of the text drawing
- region.</option>
- </member>
- </simplelist>
- <para>NOTE: This table is only defined when X support
- is enabled.</para>
- </listitem>
- </varlistentry>
- <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>
- </term>
- <listitem>
- <para>A string containing the build info for this
- particular instance of Conky, including the version,
- build date, and architecture.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <command>
- <option>conky_build_date</option>
- </command>
- <option>string</option>
- </term>
- <listitem>
- <para>A string containing the build date for this
- particular instance of Conky.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <command>
- <option>conky_build_arch</option>
- </command>
- <option>string</option>
- </term>
- <listitem>
- <para>A string containing the build architecture for
- this particular instance of Conky.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <command>
- <option>conky_version</option>
- </command>
- <option>string</option>
- </term>
- <listitem>
- <para>A string containing the version of the current
- instance of Conky.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <command>
- <option>conky_config</option>
- </command>
- <option>string</option>
- </term>
- <listitem>
- <para>A string containing the path of the current Conky
- configuration file.</para>
- </listitem>
- </varlistentry>
+ <varlistentry>
+ <term>
+ <command>
+ <option>conky_parse(string)</option>
+ </command>
+ <option>function</option>
+ </term>
+ <listitem>
+ <para>This function takes a string that is evaluated as
+ per Conky's TEXT section, and then returns a string
+ with the result.</para>
+ </listitem>
+ </varlistentry>
+ <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>
+ </term>
+ <listitem>
+ <para>This table contains some information about
+ Conky's window. The following table describes the
+ values contained:</para>
+ <simplelist>
+ <member>
+ <command>drawable</command>
+ <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), requires
+ Lua extras enabled at compile time.</option>
+ </member>
+ <member>
+ <command>display</command>
+ <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>
+ </member>
+ <member>
+ <command>height</command>
+ <option>Window height (in pixels).</option>
+ </member>
+ <member>
+ <command>border_inner_margin</command>
+ <option>Window's inner border margin (in
+ pixels).</option>
+ </member>
+ <member>
+ <command>border_outer_margin</command>
+ <option>Window's outer border margin (in
+ pixels).</option>
+ </member>
+ <member>
+ <command>border_width</command>
+ <option>Window's border width (in
+ pixels).</option>
+ </member>
+ <member>
+ <command>text_start_x</command>
+ <option>The x component of the starting
+ coordinate of text drawing.</option>
+ </member>
+ <member>
+ <command>text_start_y</command>
+ <option>The y component of the starting
+ coordinate of text drawing.</option>
+ </member>
+ <member>
+ <command>text_width</command>
+ <option>The width of the text drawing
+ region.</option>
+ </member>
+ <member>
+ <command>text_height</command>
+ <option>The height of the text drawing
+ region.</option>
+ </member>
+ </simplelist>
+ <para>NOTE: This table is only defined when X support
+ is enabled.</para>
+ </listitem>
+ </varlistentry>
+ <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>
+ </term>
+ <listitem>
+ <para>A string containing the build info for this
+ particular instance of Conky, including the version,
+ build date, and architecture.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <command>
+ <option>conky_build_date</option>
+ </command>
+ <option>string</option>
+ </term>
+ <listitem>
+ <para>A string containing the build date for this
+ particular instance of Conky.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <command>
+ <option>conky_build_arch</option>
+ </command>
+ <option>string</option>
+ </term>
+ <listitem>
+ <para>A string containing the build architecture for
+ this particular instance of Conky.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <command>
+ <option>conky_version</option>
+ </command>
+ <option>string</option>
+ </term>
+ <listitem>
+ <para>A string containing the version of the current
+ instance of Conky.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <command>
+ <option>conky_config</option>
+ </command>
+ <option>string</option>
+ </term>
+ <listitem>
+ <para>A string containing the path of the current Conky
+ configuration file.</para>
+ </listitem>
+ </varlistentry>
</variablelist>
<option>logfile lines (next_check)</option>
</term>
<listitem>Displays first N lines of supplied text file. The
- file is checked every 'next_check' update. If next_check
- is not supplied, Conky defaults to 2. Max of 30 lines can be
- displayed, or until the text buffer is filled.
+ file is checked every 'next_check' update. If next_check is
+ not supplied, Conky defaults to 2. Max of 30 lines can be
+ displayed, or until the text buffer is filled.
<para /></listitem>
</varlistentry>
<varlistentry>
</term>
<listitem>Executes a Lua function with given parameters,
then prints the returned string. See also 'lua_load' on how
- to load scripts. Conky puts 'conky_' in front of function_name
- to prevent accidental calls to the wrong function unless you
- put you place 'conky_' in front of it yourself.
+ to load scripts. Conky puts 'conky_' in front of
+ function_name to prevent accidental calls to the wrong
+ function unless you put you place 'conky_' in front of it
+ yourself.
<para /></listitem>
</varlistentry>
<varlistentry>
</term>
<listitem>Executes a Lua function with given parameters and
draws a bar. Expects result value to be an integer between
- 0 and 100. See also 'lua_load' on how to load scripts.
+ 0 and 100. See also 'lua_load' on how to load scripts.
Conky puts 'conky_' in front of function_name to prevent
- accidental calls to the wrong function unless you
- put you place 'conky_' in front of it yourself.
+ accidental calls to the wrong function unless you put you
+ place 'conky_' in front of it yourself.
<para /></listitem>
</varlistentry>
<varlistentry>
<listitem>Executes a Lua function with given parameters and
draws a gauge. Expects result value to be an integer
between 0 and 100. See also 'lua_load' on how to load
- scripts. Conky puts 'conky_' in front of function_name
- to prevent accidental calls to the wrong function unless you
- put you place 'conky_' in front of it yourself.
+ scripts. Conky puts 'conky_' in front of function_name to
+ prevent accidental calls to the wrong function unless you
+ put you place 'conky_' in front of it yourself.
<para /></listitem>
</varlistentry>
<varlistentry>
load scripts. Takes the switch '-t' to use a temperature
gradient, which makes the gradient values change depending
on the amplitude of a particular graph value (try it and
- see). Conky puts 'conky_' in front of function_name
- to prevent accidental calls to the wrong function unless you
- put you place 'conky_' in front of it yourself.
+ see). Conky puts 'conky_' in front of function_name to
+ prevent accidental calls to the wrong function unless you
+ put you place 'conky_' in front of it yourself.
<para /></listitem>
</varlistentry>
<varlistentry>
<listitem>Executes a Lua function with given parameters as
per $lua, then parses and prints the result value as per
the syntax for Conky's TEXT section. See also 'lua_load' on
- how to load scripts. Conky puts 'conky_' in front of function_name
- to prevent accidental calls to the wrong function unless you
- put you place 'conky_' in front of it yourself.
- <para /></listitem>
- </varlistentry>
- <varlistentry>
- <term>
- <command>
- <option>lua_read_parse</option>
- </command>
- <option />
- </term>
- <listitem>This function is deprecated. Please use the
- conky_parse() Lua function instead.
+ how to load scripts. Conky puts 'conky_' in front of
+ function_name to prevent accidental calls to the wrong
+ function unless you put you place 'conky_' in front of it
+ yourself.
<para /></listitem>
</varlistentry>
<varlistentry>
<option>logfile lines (next_check)</option>
</term>
<listitem>Displays last N lines of supplied text file. The
- file is checked every 'next_check' update. If next_check
- is not supplied, Conky defaults to 2. Max of 30 lines can be
- displayed, or until the text buffer is filled.
+ file is checked every 'next_check' update. If next_check is
+ not supplied, Conky defaults to 2. Max of 30 lines can be
+ displayed, or until the text buffer is filled.
<para /></listitem>
</varlistentry>
<varlistentry>