git.maemo.org Git - monky/blob - doc/docs.xml

   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">
   8 ]>
   9
  10 <refentry>
  11         <refentryinfo>
  12                 <address>
  13                         <email>brenden1@users.sourceforge.net</email>
  14                 </address>
  15                 <author>
  16                         <firstname>Brenden</firstname>
  17                         <surname>Matthews</surname>
  18                 </author>
  19                 <date>2009-03-15</date>
  20         </refentryinfo>
  21
  22         <refmeta>
  23                 <refentrytitle>conky</refentrytitle>
  24                 <manvolnum>1</manvolnum>
  25         </refmeta>
  26
  27         <refnamediv>
  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>
  30         </refnamediv>
  31
  32         <refsynopsisdiv>
  33                 <cmdsynopsis>
  34                         <command>conky</command>
  35                         <arg><replaceable>options</replaceable></arg>
  36                 </cmdsynopsis>
  37         </refsynopsisdiv>
  38
  39         <refsect1>
  40                 <title>Description</title>
  41                 <para>
  42                         Conky is a system monitor for X originally based on torsmo.
  43                         Since its inception, Conky has changed significantly from its predecessor, while maintaining
  44                         simplicity and configurability.  Conky can display just about anything, either
  45                         on your root desktop or in its own window.  Not only does Conky have many
  46                         built-in objects, it can also display just about any piece of information by
  47                         using scripts and other external programs.
  48                 </para>
  49                 <para>
  50                         Conky has more than 250 built in objects, including support for
  51                         a plethora of OS stats (uname, uptime, CPU usage, mem usage, disk
  52                         usage, "top" like process stats, and network monitoring, just to name a few),
  53                         built in IMAP and POP3 support, built in support for many popular
  54                         music players (MPD, XMMS2, BMPx, Audacious), and much much more.
  55                         Conky can display this info either as text,     or using simple progress
  56                         bars and graph widgets, with different fonts and colours.
  57                 </para>
  58                 <para>
  59                         We are always looking for help, whether its reporting bugs, writing patches, or writing docs.
  60                         Please use the facilities at SourceForge to make bug reports, feature requests, and submit patches,
  61                         or stop by #conky on irc.freenode.net if you have questions or want to contribute.
  62                 </para>
  63                 <para>
  64                         Thanks for your interest in Conky.
  65                 </para>
  66         </refsect1>
  67
  68         <refsect1>
  69                 <title>Compiling</title>
  70                 <para>
  71                         For users compiling from source on a binary distro, make sure you have the X development
  72                         libraries installed.  This should be a package along the lines of "libx11-dev" or
  73                         "xorg-x11-dev" for X11 libs, and similar "-dev" format for the other libs required (depending
  74                         on your configure options).
  75                 </para>
  76                 <para>
  77                         Conky has (for some time) been available in the repositories of most popular distributions.
  78                         Here are some installation instructions for a few:
  79                 </para>
  80                 <para>
  81                         Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-admin/conky" for installation.
  82                         There is also usually an up-to-date ebuild within Conky's package or in the git repo.
  83                 </para>
  84                 <para>
  85                         Debian, etc. users -- Conky should be in your repositories, and can be installed by doing
  86                         "aptitude install conky".
  87                 </para>
  88                 <para>
  89                         Example to compile and run Conky with all optional components (note that some configure options may differ for your system):
  90                 </para>
  91                 <variablelist>
  92                         <varlistentry>
  93                                 <term>
  94                                         <command><option>sh autogen.sh</option></command> <option># Only required if building from the git repo</option>
  95                                 </term>
  96                         </varlistentry>
  97                         <varlistentry>
  98                                 <term>
  99                                         <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>
 100                                 </term>
 101                         </varlistentry>
 102                         <varlistentry>
 103                                 <term>
 104                                         <command><option>make</option></command>
 105                                 </term>
 106                         </varlistentry>
 107                         <varlistentry>
 108                                 <term>
 109                                         <command><option>make install</option></command> <option># Optional</option>
 110                                 </term>
 111                         </varlistentry>
 112                         <varlistentry>
 113                                 <term>
 114                                         <command><option>src/conky</option></command>
 115                                 </term>
 116                         </varlistentry>
 117                 </variablelist>
 118                 <para>
 119                         Conky has been tested to be compatible with C99 C, however it has not been tested
 120                         with anything other than gcc, and is not guaranteed to work with other compilers.
 121                 </para>
 122                 <para>
 123
 124                 </para>
 125         </refsect1>
 126
 127
 128
 129         <refsect1>
 130                 <title>You Should Know</title>
 131                 <para>
 132                         Conky is generally very good on resources.  That said, the more you try to make Conky
 133                         do, the more resources it is going to consume.
 134                 </para>
 135                 <para>
 136                         An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1 conky".
 137                         Saves you the trouble of having to kill and then restart.  You can now also do the same with SIGHUP.
 138                 </para>
 139         </refsect1>
 140
 141         <refsect1>
 142                 <title>Options</title>
 143
 144                 <para>Command line options override configurations defined in configuration file.</para>
 145
 146                 &command_options;
 147
 148         </refsect1>
 149
 150         <refsect1>
 151                 <title>Configuration Settings</title>
 152
 153                 <para>
 154                         Default configuration file location is $HOME/.conkyrc or
 155                         ${sysconfdir}/conky/conky.conf.  On most systems, sysconfdir is /etc,
 156                         and you can find the sample config file there (/etc/conky/conky.conf).
 157                 </para>
 158                 <para>
 159                         You might want to copy it to $HOME/.conkyrc and then start modifying it.
 160                         Other configs can be found at http://conky.sf.net/
 161                 </para>
 162
 163                 &config_settings;
 164         </refsect1>
 165
 166         <refsect1>
 167                 <title>Variables</title>
 168
 169                 <para>
 170                         Colors are parsed using XParsecolor(), there might be a list of them:
 171                         /usr/share/X11/rgb.txt. Also, <ulink url="http://sedition.com/perl/rgb.html">
 172                                 http://sedition.com/perl/rgb.html</ulink>.
 173                         Color can be also in #rrggbb format (hex).
 174                 </para>
 175
 176                 &variables;
 177         </refsect1>
 178
 179         <refsect1>
 180                 <title>Examples</title>
 181                 <variablelist>
 182
 183                         <varlistentry>
 184                                 <term><varname>conky </varname><option>-t &apos;${time %D %H:%M}&apos; -o -u 30</option></term>
 185                                 <listitem>Start Conky in its own window with date and clock as text and 30 sec update interval.</listitem>
 186                         </varlistentry>
 187
 188                         <varlistentry>
 189                                 <term><varname>conky </varname><option>-a top_left -x 5 -y 500 -d</option></term>
 190                                 <listitem>Start Conky to background at coordinates (5, 500).</listitem>
 191                         </varlistentry>
 192
 193                 </variablelist>
 194         </refsect1>
 195
 196         <refsect1>
 197                 <title>Files</title>
 198                 <filename>~/.conkyrc</filename> default configuration file
 199         </refsect1>
 200
 201         <refsect1>
 202                 <title>Bugs</title>
 203                 <para>
 204                         Drawing to root or some other desktop window directly doesn't work with
 205                         all window managers. Especially doesn't work well with Gnome and it has
 206                         been reported that it doesn't work with KDE either. Nautilus can be
 207                         disabled from drawing to desktop with program gconf-editor. Uncheck
 208                         show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky
 209                         to set some specific window id. You might find xwininfo -tree useful to
 210                         find the window to draw to. You can also use -o argument which makes
 211                         Conky to create its own window.  If you do try running Conky in its own
 212                         window, be sure to read up on the own_window_type settings and experiment.
 213                 </para>
 214         </refsect1>
 215
 216         <refsect1>
 217                 <title>See Also</title>
 218                 <para><ulink url="http://conky.sourceforge.net/">
 219                                 http://conky.sourceforge.net/</ulink></para>
 220                 <para><ulink url="http://www.sourceforge.net/projects/conky">
 221                                 http://www.sourceforge.net/projects/conky</ulink></para>
 222                 <para>
 223                         #conky on irc.freenode.net
 224                 </para>
 225         </refsect1>
 226
 227         <refsect1>
 228                 <title>Copying</title>
 229                 <para>
 230                         Copyright (c) 2005-2009 Brenden Matthews, Philip Kovacs, et. al.
 231                         Any original torsmo code is licensed under the BSD license (see LICENSE.BSD for a copy).
 232                         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).
 233                 </para>
 234         </refsect1>
 235         <refsect1>
 236                 <title>Authors</title>
 237                 <para>
 238                         The Conky dev team (see AUTHORS for a full list of contributors).
 239                 </para>
 240         </refsect1>
 241 </refentry>