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.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">
   8                ]>
   9
  10 <refentry>
  11
  12         <title>Conky</title>
  13   <refentryinfo>
  14     <address>
  15       <email>brenden1@users.sourceforge.net</email>
  16     </address>
  17     <author>
  18       <firstname>Brenden</firstname>
  19       <surname>Matthews</surname>
  20     </author>
  21     <date>2005-08-18</date>
  22   </refentryinfo>
  23
  24   <refmeta>
  25     <refentrytitle>conky</refentrytitle>
  26     <manvolnum>1</manvolnum>
  27   </refmeta>
  28
  29   <refnamediv>
  30     <refname>conky</refname>
  31     <refpurpose>a system monitor for X originally based on the torsmo code, but more kickass.</refpurpose>
  32   </refnamediv>
  33
  34   <refsynopsisdiv>
  35     <cmdsynopsis>
  36       <command>conky</command>
  37       <arg><replaceable>options</replaceable></arg>
  38     </cmdsynopsis>
  39   </refsynopsisdiv>
  40
  41   <refsect1>
  42     <title>Description</title>
  43     <para>
  44     Conky is a system monitor for X originally based on the torsmo code.
  45     Since it's original conception, Conky has changed a fair bit from it's predecessor.
  46     Conky can display just about anything, either on your root desktop or in it's own window.
  47     Conky has many built-in objects, as well as the ability to execute programs and scripts,
  48     then display the output from stdout.
  49                 </para>
  50                 <para>
  51                 We are always looking for help, and anyone interested in becoming a developer is welcome.
  52                 Please use the facilities at SourceForge to make bug reports, feature requests, and submit patches.
  53                 </para>
  54                 <para>
  55                 Thanks for your interest in Conky.
  56                 </para>
  57   </refsect1>
  58
  59         <refsect1>
  60                 <title>Compiling</title>
  61                 <para>
  62                 First, make sure you have the X development libraries installed, this should be a package along the lines
  63                 of "libx11-dev or xorg-x11-dev". Gentoo users, Conky is in Gentoo's Portage.  Simply use "emerge conky" for installation.
  64                 There is also usually an up-to-date ebuild within Conky's package or in CVS.
  65                 </para>
  66                 <para>
  67                 To compile and run Conky with all optional components:
  68                 </para>
  69                 <variablelist>
  70                         <varlistentry>
  71                                 <term>
  72                                         <command><option>sh autogen.sh</option></command> <option># Only required if building from CVS</option>
  73                                 </term>
  74                         </varlistentry>
  75                         <varlistentry>
  76                                 <term>
  77                                 <command><option>./configure </option></command><option>
  78 --prefix=/usr --mandir=/usr/share/man --infodir=/usr/share/info
  79 --datadir=/usr/ share --sysconfdir=/etc --localstatedir=/var/lib
  80 --enable-double-buffer --enable-own-window --enable-proc-uptime
  81 --enable-mpd --enable-xft --enable-seti</option>
  82                                 </term>
  83                         </varlistentry>
  84                         <varlistentry>
  85                                 <term>
  86                                         <command><option>make</option></command>
  87                                 </term>
  88                         </varlistentry>
  89                         <varlistentry>
  90                                 <term>
  91                                         <command><option>./conky</option></command>
  92                                 </term>
  93                         </varlistentry>
  94                 </variablelist>
  95                 <para>
  96                         Conky doesn't probably compile with other compilers than gcc and icc.
  97                         It doesn't compile with C89 compiler and not even with pure C99.
  98                         It uses few     things that might not exist: strdup(), strcasecmp(), strncasecmp(),
  99                         optarg variable with getopt() and long long (not in C89). Crashes in file system
 100                         statistics stuff when compiled with icc, I don't know exactly why.
 101                 </para>
 102                 <para>
 103                         You can disable 'drawing to own window' feature in case you don't need it       by passing
 104                         --disable-own-window to configure -script.
 105                 </para>
 106                 <para>
 107
 108                 </para>
 109         </refsect1>
 110
 111
 112
 113   <refsect1>
 114     <title>You Should Know</title>
 115     <para>
 116                 Conky is generally very good on resources.  However, certain objects in
 117                 Conky are harder on resources then others.  In particular, the $tail,
 118                 $top, $font, and $graph objects are quite costly in comparison to the rest of Conky.
 119                 </para>
 120                 <para>
 121                 If you do use them, please do not complain about memory or CPU usage,
 122                 unless you think something is going seriously wrong (mem leak, et cetera).
 123                 </para>
 124   </refsect1>
 125
 126   <refsect1>
 127     <title>Options</title>
 128
 129     <para>Command line options override configurations defined in configuration file.</para>
 130
 131                 &command_options;
 132
 133   </refsect1>
 134
 135         <refsect1>
 136                 <title>Configuration Settings</title>
 137
 138                 <para>
 139                 Default configuration file is $HOME/.conkyrc (can be changed from
 140                 conky.c among other things). See conkyrc.sample. You might want to copy
 141                 it to $HOME/.conkyrc and then start modifying it.
 142                 </para>
 143
 144                 &config_settings;
 145         </refsect1>
 146
 147         <refsect1>
 148                 <title>Variables</title>
 149
 150                 <para>
 151                 Colors are parsed using XParsecolor(), there might be a list of them:
 152                 /usr/X11R6/lib/X11/rgb.txt. Also, <ulink url="http://sedition.com/perl/rgb.html">
 153                                                                                                                                                          http://sedition.com/perl/rgb.html</ulink>
 154                 Color can be also in #rrggbb format (hex).
 155
 156                 Note that when displaying bytes, power is 1024 and not 1000 so 1M really
 157                 means 1024*1024 bytes and not 1000*1000.
 158                 </para>
 159
 160                 &variables;
 161         </refsect1>
 162
 163         <refsect1>
 164                 <title>Examples</title>
 165                 <variablelist>
 166
 167                         <varlistentry>
 168                                 <term><varname>conky </varname><option>-t &apos;${time %D %H:%m}&apos; -o -u 30</option></term>
 169                                 <listitem>Start Conky in its own window with date and clock as text and 30 sec update interval.</listitem>
 170                         </varlistentry>
 171
 172                         <varlistentry>
 173                                 <term><varname>conky </varname><option>-a top_left -x 5 -y 500 -d</option></term>
 174                                 <listitem>Start Conky to background at coordinates (5, 500).</listitem>
 175                         </varlistentry>
 176
 177                 </variablelist>
 178         </refsect1>
 179
 180         <refsect1>
 181                 <title>Files</title>
 182                 <filename>~/.conkyrc</filename> default configuration file
 183         </refsect1>
 184
 185         <refsect1>
 186                 <title>Bugs</title>
 187                 <para>
 188                 Drawing to root or some other desktop window directly doesn't work with
 189                 all window managers. Especially doesn't work well with Gnome and it has
 190                 been reported that it doesn't work with KDE either. Nautilus can be
 191                 disabled from drawing to desktop with program gconf-editor. Uncheck
 192                 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky
 193                 to set some specific window id. You might find xwininfo -tree useful to
 194                 find the window to draw to. You can also use -o argument which makes
 195                 Conky to create its own window.
 196                 </para>
 197         </refsect1>
 198
 199   <refsect1>
 200     <title>See Also</title>
 201     <para><ulink url="http://conky.sourceforge.net">
 202     http://conky.sourceforge.net</ulink></para>
 203     <para><ulink url="http://www.sourceforge.net/projects/conky">
 204     http://www.sourceforge.net/projects/conky</ulink></para>
 205                 <para>
 206                         #conky on irc.freenode.net
 207                 </para>
 208   </refsect1>
 209
 210         <refsect1>
 211                 <title>Authors</title>
 212                 <para>
 213                         The Conky dev team. What's up now??!
 214                 </para>
 215         </refsect1>
 216
 217 </refentry>