+ <refsect1>
+ <title>Lua API</title>
+ <para>Conky features a Lua Programming API, and also ships with Lua
+ bindings for some useful libraries. Conky defines certain global
+ functions and variables which can be accessed from Lua code running
+ in Conky.
+ </para>
+ <para>To use Lua Conky, you first need to make sure you have a version of Conky
+ with Lua support enabled (``conky -v'' will report this). Scripts
+ must first be loaded using the lua_load configuration option. You
+ then call functions in Lua via Conky's $lua, $lua_read, and Lua
+ hooks.
+ </para>
+ <para>
+ Be careful when creating threaded objects through the Lua API. You
+ could wind up with a whole bunch of threads running if a thread is
+ created with each iteration.
+ </para>
+ <para>
+ At this time, the Lua API should not be considered stable and may
+ change drastically from one release to another as it matures.
+ </para>
+ <para>
+ NOTE: In order to accommodate certain features in the cairo
+ library's API, Conky will export a few additional functions for the
+ creation of certain structures. These are documented below.
+ </para>
+ &lua;
+ </refsect1>