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