1 <?xml version="1.0" encoding="UTF-8" ?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4 <!ENTITY testtable SYSTEM "test.xml">
5 <!ENTITY command_options SYSTEM "command_options.xml">
6 <!ENTITY config_settings SYSTEM "config_settings.xml">
7 <!ENTITY variables SYSTEM "variables.xml">
13 <email>brenden1@users.sourceforge.net</email>
16 <firstname>Brenden</firstname>
17 <surname>Matthews</surname>
19 <date>2008-03-31</date>
23 <refentrytitle>conky</refentrytitle>
24 <manvolnum>1</manvolnum>
28 <refname>conky</refname>
29 <refpurpose>A system monitor for X originally based on the torsmo code, but more kickass. It just keeps on given'er. Yeah.</refpurpose>
34 <command>conky</command>
35 <arg><replaceable>options</replaceable></arg>
40 <title>Description</title>
42 Conky is a system monitor for X originally based on torsmo.
43 Since it's conception, Conky has changed significantly from it's predecessor.
44 Conky can display just about anything, either on your root desktop or in it's own window.
45 Conky has many built-in objects, as well as the ability to execute programs and scripts,
46 then display the output from stdout.
49 We are always looking for help, and anyone interested in becoming a developer is welcome.
50 Please use the facilities at SourceForge to make bug reports, feature requests, and submit patches.
53 Thanks for your interest in Conky.
58 <title>Compiling</title>
60 For users compiling from source on a binary distro, make sure you have the X development
61 libraries installed. This should be a package along the lines of "libx11-dev" or
62 "xorg-x11-dev" for X11 libs, and similar "-dev" format for the other libs required (depending
63 on your configure options).
66 Conky has (for some time) been available in the repositories of most popular distributions.
67 Here are some installation instructions for a few:
70 Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-admin/conky" for installation.
71 There is also usually an up-to-date ebuild within Conky's package or in SVN.
74 Debian, etc. users -- Conky should be in your repositories, and can be installed by doing
75 "aptitude install conky".
78 Example to compile and run Conky with all optional components (note that some configure options may differ for your system):
83 <command><option>sh autogen.sh</option></command> <option># Only required if building from SVN</option>
88 <command><option>./configure </option></command><option>--prefix=/usr --mandir=/usr/share/man --infodir=/usr/share/info --datadir=/usr/share --sysconfdir=/etc --localstatedir=/var/lib --disable-own-window --enable-audacious[=yes|no|legacy] --enable-bmpx --disable-hddtemp --disable-mpd --enable-xmms2 --disable-portmon --disable-network --enable-debug --disable-x11 --disable-double-buffer --disable-xdamage --disable-xft</option>
93 <command><option>make</option></command>
98 <command><option>make install</option></command> <option># Optional</option>
103 <command><option>src/conky</option></command>
108 Conky has been tested to be compatible with C99 C, however it has not been tested
109 with anything other than gcc, and is not guaranteed to work with other compilers.
119 <title>You Should Know</title>
121 Conky is generally very good on resources. That said, the more you try to make Conky
122 do, the more resources it is going to consume.
125 An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1 conky".
126 Saves you the trouble of having to kill and then restart. You can now also do the same with SIGHUP.
131 <title>Options</title>
133 <para>Command line options override configurations defined in configuration file.</para>
140 <title>Configuration Settings</title>
143 Default configuration file location is $HOME/.conkyrc or
144 ${sysconfdir}/conky/conky.conf. On most systems, sysconfdir is /etc,
145 and you can find the sample config file there (/etc/conky/conky.conf).
148 You might want to copy it to $HOME/.conkyrc and then start modifying it.
149 Other configs can be found at http://conky.sf.net/
156 <title>Variables</title>
159 Colors are parsed using XParsecolor(), there might be a list of them:
160 /usr/share/X11/rgb.txt. Also, <ulink url="http://sedition.com/perl/rgb.html">
161 http://sedition.com/perl/rgb.html</ulink>.
162 Color can be also in #rrggbb format (hex).
169 <title>Examples</title>
173 <term><varname>conky </varname><option>-t '${time %D %H:%M}' -o -u 30</option></term>
174 <listitem>Start Conky in its own window with date and clock as text and 30 sec update interval.</listitem>
178 <term><varname>conky </varname><option>-a top_left -x 5 -y 500 -d</option></term>
179 <listitem>Start Conky to background at coordinates (5, 500).</listitem>
187 <filename>~/.conkyrc</filename> default configuration file
193 Drawing to root or some other desktop window directly doesn't work with
194 all window managers. Especially doesn't work well with Gnome and it has
195 been reported that it doesn't work with KDE either. Nautilus can be
196 disabled from drawing to desktop with program gconf-editor. Uncheck
197 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky
198 to set some specific window id. You might find xwininfo -tree useful to
199 find the window to draw to. You can also use -o argument which makes
200 Conky to create its own window. If you do try running Conky in its own
201 window, be sure to read up on the own_window_type settings and experiment.
206 <title>See Also</title>
207 <para><ulink url="http://conky.sourceforge.net/">
208 http://conky.sourceforge.net/</ulink></para>
209 <para><ulink url="http://www.sourceforge.net/projects/conky">
210 http://www.sourceforge.net/projects/conky</ulink></para>
212 #conky on irc.freenode.net
217 <title>Copying</title>
219 Copyright (c) 2005-2008 Brenden Matthews, Philip Kovacs, et. al.
220 Any original torsmo code is licensed under the BSD license (see LICENSE.BSD for a copy).
221 All code written since the fork of torsmo is licensed under the GPL (see LICENSE.GPL for a copy), except where noted differently (such as in portmon code, timed thread code, and audacious code which are LGPL, and prss which is an MIT-style license).
225 <title>Authors</title>
227 The Conky dev team (see AUTHORS for a full list of contributors).