Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-11-18 11:05:18 +00:00
Code Issues Releases Activity
3322b2a9a9
conky/doc/lua.xml

151 lines
5.0 KiB
XML
Raw Normal View History

A whole bunch of changes, mostly Lua related. Improved Lua API (lua_read_parse has been removed in favour of the conky_parse() Lua API call). The docs have been improved to reflect the recent Lua API stuff as well. Introduced new Lua Cairo and Imlib2 bindings, which require the tolua++ tool. Fixed some other miscellaneous doc related things.
2009-07-08 08:09:06 +00:00
<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_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>
Refactor some of the new weather code, fix docs. I moved the weather stuff into its own thread, and also fixed up some abuse of <simplelist> formatting throughout the docs. Hopefully we can keep things a little more uniform from now on.
2009-07-13 05:31:57 +00:00
<option>Window's drawable (Xlib
A whole bunch of changes, mostly Lua related. Improved Lua API (lua_read_parse has been removed in favour of the conky_parse() Lua API call). The docs have been improved to reflect the recent Lua API stuff as well. Introduced new Lua Cairo and Imlib2 bindings, which require the tolua++ tool. Fixed some other miscellaneous doc related things.
2009-07-08 08:09:06 +00:00
Drawable)</option>
</member>
<member>
<command>visual</command>
Refactor some of the new weather code, fix docs. I moved the weather stuff into its own thread, and also fixed up some abuse of <simplelist> formatting throughout the docs. Hopefully we can keep things a little more uniform from now on.
2009-07-13 05:31:57 +00:00
<option>Window's visual (Xlib Visual)</option>
A whole bunch of changes, mostly Lua related. Improved Lua API (lua_read_parse has been removed in favour of the conky_parse() Lua API call). The docs have been improved to reflect the recent Lua API stuff as well. Introduced new Lua Cairo and Imlib2 bindings, which require the tolua++ tool. Fixed some other miscellaneous doc related things.
2009-07-08 08:09:06 +00:00
</member>
<member>
<command>display</command>
Refactor some of the new weather code, fix docs. I moved the weather stuff into its own thread, and also fixed up some abuse of <simplelist> formatting throughout the docs. Hopefully we can keep things a little more uniform from now on.
2009-07-13 05:31:57 +00:00
<option>Window's display (Xlib
A whole bunch of changes, mostly Lua related. Improved Lua API (lua_read_parse has been removed in favour of the conky_parse() Lua API call). The docs have been improved to reflect the recent Lua API stuff as well. Introduced new Lua Cairo and Imlib2 bindings, which require the tolua++ tool. Fixed some other miscellaneous doc related things.
2009-07-08 08:09:06 +00:00
Display)</option>
</member>
<member>
<command>width</command>
Refactor some of the new weather code, fix docs. I moved the weather stuff into its own thread, and also fixed up some abuse of <simplelist> formatting throughout the docs. Hopefully we can keep things a little more uniform from now on.
2009-07-13 05:31:57 +00:00
<option>Window width (in pixels)</option>
A whole bunch of changes, mostly Lua related. Improved Lua API (lua_read_parse has been removed in favour of the conky_parse() Lua API call). The docs have been improved to reflect the recent Lua API stuff as well. Introduced new Lua Cairo and Imlib2 bindings, which require the tolua++ tool. Fixed some other miscellaneous doc related things.
2009-07-08 08:09:06 +00:00
</member>
<member>
<command>height</command>
Refactor some of the new weather code, fix docs. I moved the weather stuff into its own thread, and also fixed up some abuse of <simplelist> formatting throughout the docs. Hopefully we can keep things a little more uniform from now on.
2009-07-13 05:31:57 +00:00
<option>Window height (in pixels)</option>
A whole bunch of changes, mostly Lua related. Improved Lua API (lua_read_parse has been removed in favour of the conky_parse() Lua API call). The docs have been improved to reflect the recent Lua API stuff as well. Introduced new Lua Cairo and Imlib2 bindings, which require the tolua++ tool. Fixed some other miscellaneous doc related things.
2009-07-08 08:09:06 +00:00
</member>
<member>
<command>border_inner_margin</command>
Refactor some of the new weather code, fix docs. I moved the weather stuff into its own thread, and also fixed up some abuse of <simplelist> formatting throughout the docs. Hopefully we can keep things a little more uniform from now on.
2009-07-13 05:31:57 +00:00
<option>Window's inner border margin (in
A whole bunch of changes, mostly Lua related. Improved Lua API (lua_read_parse has been removed in favour of the conky_parse() Lua API call). The docs have been improved to reflect the recent Lua API stuff as well. Introduced new Lua Cairo and Imlib2 bindings, which require the tolua++ tool. Fixed some other miscellaneous doc related things.
2009-07-08 08:09:06 +00:00
pixels)</option>
</member>
<member>
<command>border_outer_margin</command>
Refactor some of the new weather code, fix docs. I moved the weather stuff into its own thread, and also fixed up some abuse of <simplelist> formatting throughout the docs. Hopefully we can keep things a little more uniform from now on.
2009-07-13 05:31:57 +00:00
<option>Window's outer border margin (in
A whole bunch of changes, mostly Lua related. Improved Lua API (lua_read_parse has been removed in favour of the conky_parse() Lua API call). The docs have been improved to reflect the recent Lua API stuff as well. Introduced new Lua Cairo and Imlib2 bindings, which require the tolua++ tool. Fixed some other miscellaneous doc related things.
2009-07-08 08:09:06 +00:00
pixels)</option>
</member>
<member>
<command>border_width</command>
Refactor some of the new weather code, fix docs. I moved the weather stuff into its own thread, and also fixed up some abuse of <simplelist> formatting throughout the docs. Hopefully we can keep things a little more uniform from now on.
2009-07-13 05:31:57 +00:00
<option>Window's border width (in
A whole bunch of changes, mostly Lua related. Improved Lua API (lua_read_parse has been removed in favour of the conky_parse() Lua API call). The docs have been improved to reflect the recent Lua API stuff as well. Introduced new Lua Cairo and Imlib2 bindings, which require the tolua++ tool. Fixed some other miscellaneous doc related things.
2009-07-08 08:09:06 +00:00
pixels)</option>
</member>
<member>
<command>text_start_x</command>
Refactor some of the new weather code, fix docs. I moved the weather stuff into its own thread, and also fixed up some abuse of <simplelist> formatting throughout the docs. Hopefully we can keep things a little more uniform from now on.
2009-07-13 05:31:57 +00:00
<option>The x component of the starting
A whole bunch of changes, mostly Lua related. Improved Lua API (lua_read_parse has been removed in favour of the conky_parse() Lua API call). The docs have been improved to reflect the recent Lua API stuff as well. Introduced new Lua Cairo and Imlib2 bindings, which require the tolua++ tool. Fixed some other miscellaneous doc related things.
2009-07-08 08:09:06 +00:00
coordinate of text drawing</option>
</member>
<member>
<command>text_start_y</command>
Refactor some of the new weather code, fix docs. I moved the weather stuff into its own thread, and also fixed up some abuse of <simplelist> formatting throughout the docs. Hopefully we can keep things a little more uniform from now on.
2009-07-13 05:31:57 +00:00
<option>The y component of the starting
A whole bunch of changes, mostly Lua related. Improved Lua API (lua_read_parse has been removed in favour of the conky_parse() Lua API call). The docs have been improved to reflect the recent Lua API stuff as well. Introduced new Lua Cairo and Imlib2 bindings, which require the tolua++ tool. Fixed some other miscellaneous doc related things.
2009-07-08 08:09:06 +00:00
coordinate of text drawing</option>
</member>
<member>
<command>text_width</command>
Refactor some of the new weather code, fix docs. I moved the weather stuff into its own thread, and also fixed up some abuse of <simplelist> formatting throughout the docs. Hopefully we can keep things a little more uniform from now on.
2009-07-13 05:31:57 +00:00
<option>The width of the text drawing
A whole bunch of changes, mostly Lua related. Improved Lua API (lua_read_parse has been removed in favour of the conky_parse() Lua API call). The docs have been improved to reflect the recent Lua API stuff as well. Introduced new Lua Cairo and Imlib2 bindings, which require the tolua++ tool. Fixed some other miscellaneous doc related things.
2009-07-08 08:09:06 +00:00
region</option>
</member>
<member>
<command>text_height</command>
Refactor some of the new weather code, fix docs. I moved the weather stuff into its own thread, and also fixed up some abuse of <simplelist> formatting throughout the docs. Hopefully we can keep things a little more uniform from now on.
2009-07-13 05:31:57 +00:00
<option>The height of the text drawing
A whole bunch of changes, mostly Lua related. Improved Lua API (lua_read_parse has been removed in favour of the conky_parse() Lua API call). The docs have been improved to reflect the recent Lua API stuff as well. Introduced new Lua Cairo and Imlib2 bindings, which require the tolua++ tool. Fixed some other miscellaneous doc related things.
2009-07-08 08:09:06 +00:00
region</option>
</member>
</simplelist>
<para>NOTE: This table is only defined when X support
is enabled.</para>
</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>
Multiline alignment support, some other misc stuff. Added support for X alignment across multi-lined objects (i.e., using $alignr with $exec). This may be a bit buggy. Disabled OpenMP code until GCC's implementation stabilizes (it's causing too many problems). A couple Lua API changes.
2009-07-18 19:46:36 +00:00
<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>
A whole bunch of changes, mostly Lua related. Improved Lua API (lua_read_parse has been removed in favour of the conky_parse() Lua API call). The docs have been improved to reflect the recent Lua API stuff as well. Introduced new Lua Cairo and Imlib2 bindings, which require the tolua++ tool. Fixed some other miscellaneous doc related things.
2009-07-08 08:09:06 +00:00
<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>
Copy Permalink