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