fixed up some stuff in the docs

[monky] / doc / docs.xml

diff --git a/doc/docs.xml b/doc/docs.xml
index 8290adf..c169b76 100644 (file)
--- a/doc/docs.xml
+++ b/doc/docs.xml
@@ -57,11 +57,18 @@
        <refsect1>
                <title>Compiling</title>
                <para>
        <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 app-admin/conky" for installation.
+               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>
+               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 CVS.
                </para>
                <para>
                There is also usually an up-to-date ebuild within Conky's package or in CVS.
                </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>

                To compile and run Conky with all optional components:
                </para>
                <variablelist>
                To compile and run Conky with all optional components:
                </para>
                <variablelist>

@@ -73,10 +80,10 @@
                        <varlistentry>
                                <term>
                                <command><option>./configure </option></command><option>
                        <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>
+                               --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>

                                </term>
                        </varlistentry>
                        <varlistentry>
                                </term>
                        </varlistentry>
                        <varlistentry>

@@ -91,14 +98,14 @@
                        </varlistentry>
                        <varlistentry>
                                <term>
                        </varlistentry>
                        <varlistentry>
                                <term>

-                                       <command><option>./conky</option></command>     
+                                       <command><option>src/conky</option></command>   

                                </term>
                        </varlistentry>
                </variablelist>
                <para>
                                </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 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>
                        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>

@@ -122,15 +129,15 @@
                </para>
                <para>
                If you do use them, please do not complain about memory or CPU usage, 
                </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>
                </para>
                <para>

-               Easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1 conky".
-               Saves you the trouble of having to stop and then restart.
+               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. 
                </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...
+               mdsplib was causing way too many problems. Hopefully there'll be a better solution in Conky 2.x...

                </para>
   </refsect1>  
   
                </para>
   </refsect1>  
   

@@ -148,8 +155,12 @@
                
                <para>
                Default configuration file is $HOME/.conkyrc (can be changed from
                
                <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>
                
                &config_settings;

@@ -161,7 +172,7 @@
                <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">
                <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
                Color can be also in #rrggbb format (hex).
                
                Note that when displaying bytes, power is 1024 and not 1000 so 1M really