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                 To compile and run Conky with all optional components (If you run Gentoo, see the "Ebuild" Section below):
  62                 </para>
  63                 <variablelist>
  64                         <varlistentry>
  65                                 <term>
  66                                         <command><option>./configure </option></command><option>
  67                                         --prefix=/usr --mandir=/usr/share/man --infodir=/usr/share/info
  68                                         --datadir=/usr/ share --sysconfdir=/etc --localstatedir=/var/lib
  69                                         --enable-double-buffer --enable-own-window --enable-proc-uptime
  70                                         --enable-mpd --enable-xft --enable-seti</option>
  71                                 </term>
  72                         </varlistentry>
  73                         <varlistentry>
  74                                 <term>
  75                                         <command><option>make</option></command>
  76                                 </term>
  77                         </varlistentry>
  78                         <varlistentry>
  79                                 <term>
  80                                         <command><option>./conky</option></command>
  81                                 </term>
  82                         </varlistentry>
  83                 </variablelist>
  84                 <para>
  85                         Conky doesn't probably compile with other compilers than gcc and icc.
  86                         It doesn't compile with C89 compiler and not even with pure C99.
  87                         It uses few     things that might not exist: strdup(), strcasecmp(), strncasecmp(),
  88                         optarg variable with getopt() and long long (not in C89). Crashes in file system
  89                         statistics stuff when compiled with icc, I don't know exactly why.
  90                 </para>
  91                 <para>
  92                         You can disable 'drawing to own window' feature in case you don't need it       by passing
  93                         --disable-own-window to configure -script.
  94                 </para>
  95                 <para>
  96                         Conky is in Gentoo's Portage.  Simply use "emerge conky" to install conky.
  97                         There is also usually an up-to-date ebuild within Conky's package or in CVS.
  98                 </para>
  99         </refsect1>
 100
 101
 102
 103   <refsect1>
 104     <title>You Should Know</title>
 105     <para>
 106                 Conky is generally very good on resources.  However, certain objects in
 107                 Conky are harder on resources then others.  In particular, the $tail,
 108                 $top, $font, and $graph objects are quite costly in comparison to the rest of Conky.
 109                 </para>
 110                 <para>
 111                 If you do use them, please do not complain about memory or CPU usage,
 112                 unless you think something is going seriously wrong (mem leak, et cetera).
 113                 </para>
 114   </refsect1>
 115
 116   <refsect1>
 117     <title>Options</title>
 118
 119     <para>Command line options override configurations defined in configuration file.</para>
 120
 121                 &command_options;
 122
 123   </refsect1>
 124
 125         <refsect1>
 126                 <title>Configuration Settings</title>
 127
 128                 <para>
 129                 Default configuration file is $HOME/.conkyrc (can be changed from
 130                 conky.c among other things). See conkyrc.sample. You might want to copy
 131                 it to $HOME/.conkyrc and then start modifying it.
 132                 </para>
 133
 134                 &config_settings;
 135         </refsect1>
 136
 137         <refsect1>
 138                 <title>Variables</title>
 139
 140                 <para>
 141                 Colors are parsed using XParsecolor(), there might be a list of them:
 142                 /usr/X11R6/lib/X11/rgb.txt. Also, <ulink url="http://sedition.com/perl/rgb.html">
 143                                                                                                                                                          http://sedition.com/perl/rgb.html</ulink>
 144                 Color can be also in #rrggbb format (hex).
 145
 146                 Note that when displaying bytes, power is 1024 and not 1000 so 1M really
 147                 means 1024*1024 bytes and not 1000*1000.
 148                 </para>
 149
 150                 &variables;
 151         </refsect1>
 152
 153         <refsect1>
 154                 <title>Examples</title>
 155                 <variablelist>
 156
 157                         <varlistentry>
 158                                 <term><varname>conky </varname><option>-t &apos;${time %D %H:%m}&apos; -o -u 30</option></term>
 159                                 <listitem>Start Conky in its own window with date and clock as text and 30 sec update interval.</listitem>
 160                         </varlistentry>
 161
 162                         <varlistentry>
 163                                 <term><varname>conky </varname><option>-a top_left -x 5 -y 500 -d</option></term>
 164                                 <listitem>Start Conky to background at coordinates (5, 500).</listitem>
 165                         </varlistentry>
 166
 167                 </variablelist>
 168         </refsect1>
 169
 170         <refsect1>
 171                 <title>Files</title>
 172                 <filename>~/.conkyrc</filename> default configuration file
 173         </refsect1>
 174
 175         <refsect1>
 176                 <title>Bugs</title>
 177                 <para>
 178                 Drawing to root or some other desktop window directly doesn't work with
 179                 all window managers. Especially doesn't work well with Gnome and it has
 180                 been reported that it doesn't work with KDE either. Nautilus can be
 181                 disabled from drawing to desktop with program gconf-editor. Uncheck
 182                 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky
 183                 to set some specific window id. You might find xwininfo -tree useful to
 184                 find the window to draw to. You can also use -o argument which makes
 185                 Conky to create its own window.
 186                 </para>
 187         </refsect1>
 188
 189   <refsect1>
 190     <title>See Also</title>
 191     <para><ulink url="http://conky.sourceforge.net">
 192     http://conky.sourceforge.net</ulink></para>
 193     <para><ulink url="http://www.sourceforge.net/projects/conky">
 194     http://www.sourceforge.net/projects/conky</ulink></para>
 195                 <para>
 196                         #conky on irc.freenode.net
 197                 </para>
 198   </refsect1>
 199
 200         <refsect1>
 201                 <title>Authors</title>
 202                 <para>
 203                         The Conky dev team. What's up now??!
 204                 </para>
 205         </refsect1>
 206
 207 </refentry>