<firstname>Brenden</firstname>
<surname>Matthews</surname>
</author>
- <date>2009-07-09</date>
+ <date>2010-10-05</date>
</refentryinfo>
<refmeta>
- <refentrytitle>conky – Manual</refentrytitle>
+ <refentrytitle>conky</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
the other libs required (depending on your configure
options). You should be able to see which extra packages
you need to install by reading errors that you get from
- './configure'.
+ './configure'. You can enable/disable stuff by giving
+ options to configure, but be careful with disabling. For
+ example: with --disable-math you won't get errors but
+ logarithmic graphs will be normal graphs and gauges
+ will miss their line.
</para>
<para>Conky has (for some time) been available in the
repositories of most popular distributions. Here are some
&config_settings;
</refsect1>
<refsect1>
- <title>Variables</title>
+ <title>Objects/Variables</title>
<para>Colours are parsed using XParsecolor(), there might be a
list of them: /usr/share/X11/rgb.txt.
Colour can be also in
#rrggbb format (hex).
</para>
+ <para>
+ Some objects may create threads, and sometimes these threads will
+ not be destroyed until Conky terminates. There is no way to
+ destroy or clean up threads while Conky is running. For example,
+ if you use an MPD variable, the MPD thread will keep running until
+ Conky dies. Some threaded objects will use one of the parameters
+ as a 'key', so that you only have 1 relevant thread running (for
+ example, the $curl, $rss and $weather objects launch one thread per
+ URI).
+ </para>
&variables;
</refsect1>
<refsect1>
<title>Lua API</title>
- <para>Conky features a Lua Programming API, and also ships with
- some Lua bindings for some useful libraries. Conky defines
- certain global functions and variables which can be accessed
- from Lua code running in Conky.
+ <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
hooks.
</para>
<para>
- At this time, the Lua API should not be considered stabe and may
+ 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>
<refsect1>
</refsect1>
<refsect1>
<title>Copying</title>
- <para>Copyright (c) 2005-2009 Brenden Matthews, Philip
+ <para>Copyright (c) 2005-2010 Brenden Matthews, Philip
Kovacs, et. al. Any original torsmo code is licensed under
the BSD license (see LICENSE.BSD for a copy). All code
written since the fork of torsmo is licensed under the GPL