1 <?xml version="1.0" encoding="UTF-8" ?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
3 "http://www.oasis-open.org/docbook/xml/4.3/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>2005-08-27</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 the torsmo code.
43 Since it's original conception, Conky has changed a fair bit 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 First, make sure you have the X development libraries installed, this should be a package along the lines
61 of "libx11-dev or xorg-x11-dev". Gentoo users, Conky is in Gentoo's Portage. Simply use "emerge app-admin/conky" for installation.
62 There is also usually an up-to-date ebuild within Conky's package or in CVS.
65 To compile and run Conky with all optional components:
70 <command><option>sh autogen.sh</option></command> <option># Only required if building from CVS</option>
75 <command><option>./configure </option></command><option>
76 --prefix=/usr --mandir=/usr/share/man --infodir=/usr/share/info
77 --datadir=/usr/share --sysconfdir=/etc --localstatedir=/var/lib
78 --enable-double-buffer --enable-own-window --enable-proc-uptime
79 --enable-mpd --enable-xft --enable-seti</option>
84 <command><option>make</option></command>
89 <command><option>make install</option></command> <option># Optional</option>
94 <command><option>./conky</option></command>
99 Conky doesn't probably compile with other compilers than gcc and icc.
100 It doesn't compile with C89 compiler and not even with pure C99.
101 It uses few things that might not exist: strdup(), strcasecmp(), strncasecmp(),
102 optarg variable with getopt() and long long (not in C89). Crashes in file system
103 statistics stuff when compiled with icc, I don't know exactly why.
106 You can disable 'drawing to own window' feature in case you don't need it by passing
107 --disable-own-window to configure -script.
117 <title>You Should Know</title>
119 Conky is generally very good on resources. However, certain objects in
120 Conky are harder on resources then others. In particular, the $tail,
121 $top, $font, and $graph objects are quite costly in comparison to the rest of Conky.
124 If you do use them, please do not complain about memory or CPU usage,
125 unless you think something is going seriously wrong (mem leak, et cetera).
128 Easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1 conky".
129 Saves you the trouble of having to stop and then restart.
132 IMPORTANT: For previous Conky users, Conky 1.3 no longer supports the metar stuff.
133 mdsplib was causing way too many problems. hopefully there'll be a better solution in Conky 2.x...
138 <title>Options</title>
140 <para>Command line options override configurations defined in configuration file.</para>
147 <title>Configuration Settings</title>
150 Default configuration file is $HOME/.conkyrc (can be changed from
151 conky.c among other things). See conkyrc.sample. You might want to copy
152 it to $HOME/.conkyrc and then start modifying it.
159 <title>Variables</title>
162 Colors are parsed using XParsecolor(), there might be a list of them:
163 /usr/X11R6/lib/X11/rgb.txt. Also, <ulink url="http://sedition.com/perl/rgb.html">
164 http://sedition.com/perl/rgb.html</ulink>
165 Color can be also in #rrggbb format (hex).
167 Note that when displaying bytes, power is 1024 and not 1000 so 1M really
168 means 1024*1024 bytes and not 1000*1000.
175 <title>Examples</title>
179 <term><varname>conky </varname><option>-t '${time %D %H:%m}' -o -u 30</option></term>
180 <listitem>Start Conky in its own window with date and clock as text and 30 sec update interval.</listitem>
184 <term><varname>conky </varname><option>-a top_left -x 5 -y 500 -d</option></term>
185 <listitem>Start Conky to background at coordinates (5, 500).</listitem>
193 <filename>~/.conkyrc</filename> default configuration file
199 Drawing to root or some other desktop window directly doesn't work with
200 all window managers. Especially doesn't work well with Gnome and it has
201 been reported that it doesn't work with KDE either. Nautilus can be
202 disabled from drawing to desktop with program gconf-editor. Uncheck
203 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky
204 to set some specific window id. You might find xwininfo -tree useful to
205 find the window to draw to. You can also use -o argument which makes
206 Conky to create its own window.
211 <title>See Also</title>
212 <para><ulink url="http://conky.sourceforge.net">
213 http://conky.sourceforge.net</ulink></para>
214 <para><ulink url="http://www.sourceforge.net/projects/conky">
215 http://www.sourceforge.net/projects/conky</ulink></para>
217 #conky on irc.freenode.net
222 <title>Authors</title>
224 The Conky dev team. What's up now!