vcs.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>2008-03-31</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 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.
  47                 </para>
  48                 <para>
  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.
  51                 </para>
  52                 <para>
  53                         Thanks for your interest in Conky.
  54                 </para>
  55         </refsect1>
  56
  57         <refsect1>
  58                 <title>Compiling</title>
  59                 <para>
  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).
  64                 </para>
  65                 <para>
  66                         Conky has (for some time) been available in the repositories of most popular distributions.
  67                         Here are some installation instructions for a few:
  68                 </para>
  69                 <para>
  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.
  72                 </para>
  73                 <para>
  74                         Debian, etc. users -- Conky should be in your repositories, and can be installed by doing
  75                         "aptitude install conky".
  76                 </para>
  77                 <para>
  78                         Example to compile and run Conky with all optional components (note that some configure options may differ for your system):
  79                 </para>
  80                 <variablelist>
  81                         <varlistentry>
  82                                 <term>
  83                                         <command><option>sh autogen.sh</option></command> <option># Only required if building from SVN</option>
  84                                 </term>
  85                         </varlistentry>
  86                         <varlistentry>
  87                                 <term>
  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>
  89                                 </term>
  90                         </varlistentry>
  91                         <varlistentry>
  92                                 <term>
  93                                         <command><option>make</option></command>
  94                                 </term>
  95                         </varlistentry>
  96                         <varlistentry>
  97                                 <term>
  98                                         <command><option>make install</option></command> <option># Optional</option>
  99                                 </term>
 100                         </varlistentry>
 101                         <varlistentry>
 102                                 <term>
 103                                         <command><option>src/conky</option></command>
 104                                 </term>
 105                         </varlistentry>
 106                 </variablelist>
 107                 <para>
 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.
 110                 </para>
 111                 <para>
 112
 113                 </para>
 114         </refsect1>
 115
 116
 117
 118         <refsect1>
 119                 <title>You Should Know</title>
 120                 <para>
 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.
 123                 </para>
 124                 <para>
 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.
 127                 </para>
 128         </refsect1>
 129
 130         <refsect1>
 131                 <title>Options</title>
 132
 133                 <para>Command line options override configurations defined in configuration file.</para>
 134
 135                 &command_options;
 136
 137         </refsect1>
 138
 139         <refsect1>
 140                 <title>Configuration Settings</title>
 141
 142                 <para>
 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).
 146                 </para>
 147                 <para>
 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/
 150                 </para>
 151
 152                 &config_settings;
 153         </refsect1>
 154
 155         <refsect1>
 156                 <title>Variables</title>
 157
 158                 <para>
 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).
 163                 </para>
 164
 165                 &variables;
 166         </refsect1>
 167
 168         <refsect1>
 169                 <title>Examples</title>
 170                 <variablelist>
 171
 172                         <varlistentry>
 173                                 <term><varname>conky </varname><option>-t &apos;${time %D %H:%M}&apos; -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>
 175                         </varlistentry>
 176
 177                         <varlistentry>
 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>
 180                         </varlistentry>
 181
 182                 </variablelist>
 183         </refsect1>
 184
 185         <refsect1>
 186                 <title>Files</title>
 187                 <filename>~/.conkyrc</filename> default configuration file
 188         </refsect1>
 189
 190         <refsect1>
 191                 <title>Bugs</title>
 192                 <para>
 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.
 202                 </para>
 203         </refsect1>
 204
 205         <refsect1>
 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>
 211                 <para>
 212                         #conky on irc.freenode.net
 213                 </para>
 214         </refsect1>
 215
 216         <refsect1>
 217                 <title>Copying</title>
 218                 <para>
 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).
 222                 </para>
 223         </refsect1>
 224         <refsect1>
 225                 <title>Authors</title>
 226                 <para>
 227                         The Conky dev team (see AUTHORS for a full list of contributors).
 228                 </para>
 229         </refsect1>
 230 </refentry>