Make a description of ${cpu} variable not so confusing.
[monky] / doc / docs.xml
index f777984..5f44e42 100644 (file)
@@ -16,7 +16,7 @@
       <firstname>Brenden</firstname>
       <surname>Matthews</surname>
     </author>
-    <date>2005-08-24</date>
+    <date>2006-05-13</date>
   </refentryinfo>
 
   <refmeta>
@@ -26,7 +26,7 @@
 
   <refnamediv>
     <refname>conky</refname>
-    <refpurpose>a system monitor for X originally based on the torsmo code, but more kickass.</refpurpose>
+    <refpurpose>A system monitor for X originally based on the torsmo code, but more kickass.  It just keeps on given'er. Yeah.</refpurpose>
   </refnamediv>
 
   <refsynopsisdiv>
        <refsect1>
                <title>Compiling</title>
                <para>
-               First, make sure you have the X development libraries installed, this should be a package along the lines 
-               of "libx11-dev or xorg-x11-dev". Gentoo users, Conky is in Gentoo's Portage.  Simply use "emerge conky" for installation.
-               There is also usually an up-to-date ebuild within Conky's package or in CVS.
+               For users compiling from source, make sure you have the X development libraries installed. 
+               This should be a package along the lines of "libx11-dev or xorg-x11-dev". 
                </para>
                <para>
-               To compile and run Conky with all optional components:
+               Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-admin/conky" for installation.
+               There is also usually an up-to-date ebuild within Conky's package or in Svn.
+               </para>
+               <para>
+               Debian,etc. users -- Conky will be in Debian's repositories soon (by mid-September, hopefully), and then 
+               Ubuntu shortly thereafter. Until then, "dpkg -i" the .deb package to install. 
+               </para>
+               <para>
+               Example to compile and run Conky with all optional components (note that some configure options may differ for your system):
                </para>
                <variablelist>
                        <varlistentry>
                                <term>
-                                       <command><option>sh autogen.sh</option></command> <option># Only required if building from CVS</option>
+                                       <command><option>sh autogen.sh</option></command> <option># Only required if building from Svn</option>
                                </term>
                        </varlistentry>
                        <varlistentry>
                                <term>
-                               <command><option>./configure </option></command><option>
---prefix=/usr --mandir=/usr/share/man --infodir=/usr/share/info
---datadir=/usr/share --sysconfdir=/etc --localstatedir=/var/lib 
---enable-double-buffer --enable-own-window --enable-proc-uptime 
---enable-mpd --enable-xft --enable-seti</option>
+                                       <command><option>./configure </option></command><option>--prefix=/usr --mandir=/usr/share/man --infodir=/usr/share/info --datadir=/usr/share --sysconfdir=/etc --localstatedir=/var/lib --enable-xft --enable-seti --enable-double-buffer --enable-own-window --enable-proc-uptime --enable-mpd --enable-mldonkey --enable-x11 --enable-portmon --enable-xmms --enable-bmp --enable-audacious --enable-infopipe --enable-bmpx </option>
                                </term>
                        </varlistentry>
                        <varlistentry>
                        </varlistentry>
                        <varlistentry>
                                <term>
-                                       <command><option>./conky</option></command>     
+                                       <command><option>src/conky</option></command>   
                                </term>
                        </varlistentry>
                </variablelist>
                <para>
-                       Conky doesn't probably compile with other compilers than gcc and icc. 
+                       Conky probably doesn't compile with compilers other than gcc and icc. 
                        It doesn't compile with C89 compiler and not even with pure C99.
-                       It uses few     things that might not exist: strdup(), strcasecmp(), strncasecmp(), 
+                       It uses a few   things that might not exist: strdup(), strcasecmp(), strncasecmp(), 
                        optarg variable with getopt() and long long (not in C89). Crashes in file system
                        statistics stuff when compiled with icc, I don't know exactly why.
                </para>
                </para>
                <para>
                If you do use them, please do not complain about memory or CPU usage, 
-               unless you think something is going seriously wrong (mem leak, et cetera).
+               unless you think something's seriously wrong (mem leak, etc.).
+               </para>
+               <para>
+               An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1 conky".
+               Saves you the trouble of having to kill and then restart.
+               </para>
+               <para>
+               IMPORTANT: For previous Conky users, Conky 1.3 no longer supports the metar stuff. 
+               mdsplib was causing way too many problems. Hopefully there'll be a better solution in Conky 2.x...
                </para>
   </refsect1>  
   
                
                <para>
                Default configuration file is $HOME/.conkyrc (can be changed from
-               conky.c among other things). See conkyrc.sample. You might want to copy
-               it to $HOME/.conkyrc and then start modifying it.
+               conky.c among other things). See conkyrc.sample. If installing from Debian package, 
+               this should be in /usr/share/doc/conky/examples ("gunzip conkyrc.sample.gz" to get conkyrc.sample).
+               </para>
+               <para>
+               You might want to copy it to $HOME/.conkyrc and then start modifying it.
+               Other configs can be found at http://conky.sf.net
                </para>
                
                &config_settings;
                <para>
                Colors are parsed using XParsecolor(), there might be a list of them:
                /usr/X11R6/lib/X11/rgb.txt. Also, <ulink url="http://sedition.com/perl/rgb.html">
-                                                                                                                                                        http://sedition.com/perl/rgb.html</ulink>
+                                                                                                                                                        http://sedition.com/perl/rgb.html</ulink>.
                Color can be also in #rrggbb format (hex).
                
                Note that when displaying bytes, power is 1024 and not 1000 so 1M really
        <refsect1>
                <title>Authors</title>
                <para>
-                       The Conky dev team. What's up now??!
+                       The Conky dev team. What's up now!
                </para>
        </refsect1>