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-10-17</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 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                 For users compiling from source, make sure you have the X development libraries installed.
  61                 This should be a package along the lines of "libx11-dev or xorg-x11-dev".
  62                 </para>
  63                 <para>
  64                 Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-admin/conky" for installation.
  65                 There is also usually an up-to-date ebuild within Conky's package or in CVS.
  66                 </para>
  67                 <para>
  68                 Debian,etc. users -- Conky will be in Debian's repositories soon (by mid-September, hopefully), and then
  69                 Ubuntu shortly thereafter. Until then, "dpkg -i" the .deb package to install.
  70                 </para>
  71                 <para>
  72                 To compile and run Conky with all optional components:
  73                 </para>
  74                 <variablelist>
  75                         <varlistentry>
  76                                 <term>
  77                                         <command><option>sh autogen.sh</option></command> <option># Only required if building from CVS</option>
  78                                 </term>
  79                         </varlistentry>
  80                         <varlistentry>
  81                                 <term>
  82                                 <command><option>./configure </option></command><option>
  83                                 --prefix=/usr --mandir=/usr/share/man --infodir=/usr/share/info
  84                                 --datadir=/usr/share --sysconfdir=/etc --localstatedir=/var/lib
  85                                 --enable-double-buffer --enable-own-window --enable-proc-uptime
  86                                 --enable-mpd --enable-xft --enable-seti</option>
  87                                 </term>
  88                         </varlistentry>
  89                         <varlistentry>
  90                                 <term>
  91                                         <command><option>make</option></command>
  92                                 </term>
  93                         </varlistentry>
  94                         <varlistentry>
  95                                 <term>
  96                                         <command><option>make install</option></command> <option># Optional</option>
  97                                 </term>
  98                         </varlistentry>
  99                         <varlistentry>
 100                                 <term>
 101                                         <command><option>src/conky</option></command>
 102                                 </term>
 103                         </varlistentry>
 104                 </variablelist>
 105                 <para>
 106                         Conky probably doesn't compile with compilers other than gcc and icc.
 107                         It doesn't compile with C89 compiler and not even with pure C99.
 108                         It uses a few   things that might not exist: strdup(), strcasecmp(), strncasecmp(),
 109                         optarg variable with getopt() and long long (not in C89). Crashes in file system
 110                         statistics stuff when compiled with icc, I don't know exactly why.
 111                 </para>
 112                 <para>
 113                         You can disable 'drawing to own window' feature in case you don't need it       by passing
 114                         --disable-own-window to configure -script.
 115                 </para>
 116                 <para>
 117
 118                 </para>
 119         </refsect1>
 120
 121
 122
 123   <refsect1>
 124     <title>You Should Know</title>
 125     <para>
 126                 Conky is generally very good on resources.  However, certain objects in
 127                 Conky are harder on resources then others.  In particular, the $tail,
 128                 $top, $font, and $graph objects are quite costly in comparison to the rest of Conky.
 129                 </para>
 130                 <para>
 131                 If you do use them, please do not complain about memory or CPU usage,
 132                 unless you think something's seriously wrong (mem leak, etc.).
 133                 </para>
 134                 <para>
 135                 An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1 conky".
 136                 Saves you the trouble of having to kill and then restart.
 137                 </para>
 138                 <para>
 139                 IMPORTANT: For previous Conky users, Conky 1.3 no longer supports the metar stuff.
 140                 mdsplib was causing way too many problems. Hopefully there'll be a better solution in Conky 2.x...
 141                 </para>
 142   </refsect1>
 143
 144   <refsect1>
 145     <title>Options</title>
 146
 147     <para>Command line options override configurations defined in configuration file.</para>
 148
 149                 &command_options;
 150
 151   </refsect1>
 152
 153         <refsect1>
 154                 <title>Configuration Settings</title>
 155
 156                 <para>
 157                 Default configuration file is $HOME/.conkyrc (can be changed from
 158                 conky.c among other things). See conkyrc.sample. If installing from Debian package,
 159                 this should be in /usr/share/doc/conky/examples ("gunzip conkyrc.sample.gz" to get conkyrc.sample).
 160                 </para>
 161                 <para>
 162                 You might want to copy it to $HOME/.conkyrc and then start modifying it.
 163                 Other configs can be found at http://conky.sf.net
 164                 </para>
 165
 166                 &config_settings;
 167         </refsect1>
 168
 169         <refsect1>
 170                 <title>Variables</title>
 171
 172                 <para>
 173                 Colors are parsed using XParsecolor(), there might be a list of them:
 174                 /usr/X11R6/lib/X11/rgb.txt. Also, <ulink url="http://sedition.com/perl/rgb.html">
 175                                                                                                                                                          http://sedition.com/perl/rgb.html</ulink>.
 176                 Color can be also in #rrggbb format (hex).
 177
 178                 Note that when displaying bytes, power is 1024 and not 1000 so 1M really
 179                 means 1024*1024 bytes and not 1000*1000.
 180                 </para>
 181
 182                 &variables;
 183         </refsect1>
 184
 185         <refsect1>
 186                 <title>Examples</title>
 187                 <variablelist>
 188
 189                         <varlistentry>
 190                                 <term><varname>conky </varname><option>-t &apos;${time %D %H:%m}&apos; -o -u 30</option></term>
 191                                 <listitem>Start Conky in its own window with date and clock as text and 30 sec update interval.</listitem>
 192                         </varlistentry>
 193
 194                         <varlistentry>
 195                                 <term><varname>conky </varname><option>-a top_left -x 5 -y 500 -d</option></term>
 196                                 <listitem>Start Conky to background at coordinates (5, 500).</listitem>
 197                         </varlistentry>
 198
 199                 </variablelist>
 200         </refsect1>
 201
 202         <refsect1>
 203                 <title>Files</title>
 204                 <filename>~/.conkyrc</filename> default configuration file
 205         </refsect1>
 206
 207         <refsect1>
 208                 <title>Bugs</title>
 209                 <para>
 210                 Drawing to root or some other desktop window directly doesn't work with
 211                 all window managers. Especially doesn't work well with Gnome and it has
 212                 been reported that it doesn't work with KDE either. Nautilus can be
 213                 disabled from drawing to desktop with program gconf-editor. Uncheck
 214                 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky
 215                 to set some specific window id. You might find xwininfo -tree useful to
 216                 find the window to draw to. You can also use -o argument which makes
 217                 Conky to create its own window.
 218                 </para>
 219         </refsect1>
 220
 221   <refsect1>
 222     <title>See Also</title>
 223     <para><ulink url="http://conky.sourceforge.net">
 224     http://conky.sourceforge.net</ulink></para>
 225     <para><ulink url="http://www.sourceforge.net/projects/conky">
 226     http://www.sourceforge.net/projects/conky</ulink></para>
 227                 <para>
 228                         #conky on irc.freenode.net
 229                 </para>
 230   </refsect1>
 231
 232         <refsect1>
 233                 <title>Authors</title>
 234                 <para>
 235                         The Conky dev team. What's up now!
 236                 </para>
 237         </refsect1>
 238
 239 </refentry>