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   <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>2005-08-24</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.</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 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.
  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                 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 conky" for installation.
  62                 There is also usually an up-to-date ebuild within Conky's package or in CVS.
  63                 </para>
  64                 <para>
  65                 To compile and run Conky with all optional components:
  66                 </para>
  67                 <variablelist>
  68                         <varlistentry>
  69                                 <term>
  70                                         <command><option>sh autogen.sh</option></command> <option># Only required if building from CVS</option>
  71                                 </term>
  72                         </varlistentry>
  73                         <varlistentry>
  74                                 <term>
  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>
  80                                 </term>
  81                         </varlistentry>
  82                         <varlistentry>
  83                                 <term>
  84                                         <command><option>make</option></command>
  85                                 </term>
  86                         </varlistentry>
  87                         <varlistentry>
  88                                 <term>
  89                                         <command><option>make install</option></command> <option># Optional</option>
  90                                 </term>
  91                         </varlistentry>
  92                         <varlistentry>
  93                                 <term>
  94                                         <command><option>./conky</option></command>
  95                                 </term>
  96                         </varlistentry>
  97                 </variablelist>
  98                 <para>
  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.
 104                 </para>
 105                 <para>
 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.
 108                 </para>
 109                 <para>
 110
 111                 </para>
 112         </refsect1>
 113
 114
 115
 116   <refsect1>
 117     <title>You Should Know</title>
 118     <para>
 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.
 122                 </para>
 123                 <para>
 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).
 126                 </para>
 127   </refsect1>
 128
 129   <refsect1>
 130     <title>Options</title>
 131
 132     <para>Command line options override configurations defined in configuration file.</para>
 133
 134                 &command_options;
 135
 136   </refsect1>
 137
 138         <refsect1>
 139                 <title>Configuration Settings</title>
 140
 141                 <para>
 142                 Default configuration file is $HOME/.conkyrc (can be changed from
 143                 conky.c among other things). See conkyrc.sample. You might want to copy
 144                 it to $HOME/.conkyrc and then start modifying it.
 145                 </para>
 146
 147                 &config_settings;
 148         </refsect1>
 149
 150         <refsect1>
 151                 <title>Variables</title>
 152
 153                 <para>
 154                 Colors are parsed using XParsecolor(), there might be a list of them:
 155                 /usr/X11R6/lib/X11/rgb.txt. Also, <ulink url="http://sedition.com/perl/rgb.html">
 156                                                                                                                                                          http://sedition.com/perl/rgb.html</ulink>
 157                 Color can be also in #rrggbb format (hex).
 158
 159                 Note that when displaying bytes, power is 1024 and not 1000 so 1M really
 160                 means 1024*1024 bytes and not 1000*1000.
 161                 </para>
 162
 163                 &variables;
 164         </refsect1>
 165
 166         <refsect1>
 167                 <title>Examples</title>
 168                 <variablelist>
 169
 170                         <varlistentry>
 171                                 <term><varname>conky </varname><option>-t &apos;${time %D %H:%m}&apos; -o -u 30</option></term>
 172                                 <listitem>Start Conky in its own window with date and clock as text and 30 sec update interval.</listitem>
 173                         </varlistentry>
 174
 175                         <varlistentry>
 176                                 <term><varname>conky </varname><option>-a top_left -x 5 -y 500 -d</option></term>
 177                                 <listitem>Start Conky to background at coordinates (5, 500).</listitem>
 178                         </varlistentry>
 179
 180                 </variablelist>
 181         </refsect1>
 182
 183         <refsect1>
 184                 <title>Files</title>
 185                 <filename>~/.conkyrc</filename> default configuration file
 186         </refsect1>
 187
 188         <refsect1>
 189                 <title>Bugs</title>
 190                 <para>
 191                 Drawing to root or some other desktop window directly doesn't work with
 192                 all window managers. Especially doesn't work well with Gnome and it has
 193                 been reported that it doesn't work with KDE either. Nautilus can be
 194                 disabled from drawing to desktop with program gconf-editor. Uncheck
 195                 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky
 196                 to set some specific window id. You might find xwininfo -tree useful to
 197                 find the window to draw to. You can also use -o argument which makes
 198                 Conky to create its own window.
 199                 </para>
 200         </refsect1>
 201
 202   <refsect1>
 203     <title>See Also</title>
 204     <para><ulink url="http://conky.sourceforge.net">
 205     http://conky.sourceforge.net</ulink></para>
 206     <para><ulink url="http://www.sourceforge.net/projects/conky">
 207     http://www.sourceforge.net/projects/conky</ulink></para>
 208                 <para>
 209                         #conky on irc.freenode.net
 210                 </para>
 211   </refsect1>
 212
 213         <refsect1>
 214                 <title>Authors</title>
 215                 <para>
 216                         The Conky dev team. What's up now??!
 217                 </para>
 218         </refsect1>
 219
 220 </refentry>