* [gentoo-doc-cvs] cvs commit: conky-howto.xml metadoc.xml
@ 2006-03-11 21:25 Xavier Neys
0 siblings, 0 replies; only message in thread
From: Xavier Neys @ 2006-03-11 21:25 UTC (permalink / raw
To: gentoo-doc-cvs
neysx 06/03/11 21:25:49
Modified: metadoc.xml
Added: conky-howto.xml
Log:
#125662 Added conky-howto
Revision Changes Path
1.145 xml/htdocs/doc/en/metadoc.xml
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/metadoc.xml?rev=1.145&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/metadoc.xml?rev=1.145&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/metadoc.xml.diff?r1=1.144&r2=1.145&cvsroot=gentoo
Index: metadoc.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v
retrieving revision 1.144
retrieving revision 1.145
diff -u -r1.144 -r1.145
--- metadoc.xml 10 Mar 2006 22:36:46 -0000 1.144
+++ metadoc.xml 11 Mar 2006 21:25:49 -0000 1.145
@@ -1,9 +1,9 @@
<?xml version='1.0' encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v 1.144 2006/03/10 22:36:46 neysx Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v 1.145 2006/03/11 21:25:49 neysx Exp $ -->
<!DOCTYPE metadoc SYSTEM "/dtd/metadoc.dtd">
<metadoc lang="en">
-<version>1.72</version>
+<version>1.73</version>
<members>
<lead>neysx</lead>
<member>fox2mike</member>
@@ -387,6 +387,7 @@
<file id="x86-at-faq">/proj/en/base/x86/arch-testers-faq.xml</file>
<file id="php-upgrade">/proj/en/php/php-upgrading.xml</file>
<file id="jffnms">/doc/en/jffnms.xml</file>
+ <file id="conky">/doc/en/conky-howto.xml</file>
</files>
<docs>
<doc id="name-logo">
@@ -1244,5 +1245,9 @@
<memberof>sysadmin_specific</memberof>
<fileid>jffnms</fileid>
</doc>
+ <doc id="conky">
+ <memberof>desktop_config</memberof>
+ <fileid>conky</fileid>
+ </doc>
</docs>
</metadoc>
1.1 xml/htdocs/doc/en/conky-howto.xml
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/conky-howto.xml?rev=1.1&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/conky-howto.xml?rev=1.1&content-type=text/plain&cvsroot=gentoo
Index: conky-howto.xml
===================================================================
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="/doc/en/conky-howto.xml">
<title>Gentoo Linux Conky Howto</title>
<author title="Author">
<mail link="admin@sdesign.us">Bill Woodford</mail>
</author>
<author title="Editor">
<mail link="brenden@rty.ca">Brenden Matthews</mail>
</author>
<abstract>
This document describes how to install and configure the system monitor known
as Conky.
</abstract>
<!-- The content of this document is licensed under the CC-BY-SA license -->
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>
<version>1.0</version>
<date>2006-03-11</date>
<chapter>
<title>Background</title>
<section>
<title>Introduction to Conky</title>
<body>
<p>
So you have a Gentoo machine, and have already learned 30 different commands to
monitor different aspects of what your computer is doing at the current moment.
What do you do from here? Isn't there an easier way to monitor system
performance and see what it's doing, as well as the resources it's using to
perform all those tasks? This is what a system monitor, such as Conky,
provides.
</p>
</body>
</section>
<section>
<title>What it does</title>
<body>
<p>
Unlike other system monitors such as top, Conky can run as a window in an X
session, or by drawing to the root window (there is also an option to have
Conky display information to stdout, but we won't discuss that here). It
displays the information it has gathered through the use of both text,
progress bars, and graphs. Also, unlike top, the way it is formatted is
completely user-configurable. In addition to monitoring the system itself,
Conky can also give you information about several music players (such as XMMS,
BMPx, Music Player Daemon, and Audacious Media Player), tell you how many new
messages are in your mail spool, and plenty more. If the functionality you
require isn't in Conky yet, it is a simple matter of writing a script to get
the information you would like - some examples of this, which have already been
done are RSS feeds, POP3 e-mail message count, local weather, boinc status, and
even the status of portage.
</p>
</body>
</section>
</chapter>
<chapter>
<title>Installing Conky</title>
<section>
<title>Base install</title>
<body>
<p>
Gentoo provides an ebuild to quickly and easily install Conky. Pay particular
attention to the the USE flags. You'll most likely want X11 support
(<c>X</c>), and make sure you select the USE flags for any music players (other
than MPD) which you want. XMMS (<c>xmms</c>), Audacious (<c>audacious</c>), or
XMMS support via the xmms-infopipe plugin (<c>infopipe</c>). If you want to
use the TCP port monitor, be SURE to disable the <c>ipv6</c> use flag, as the
port monitor is for ipv4 systems only.
</p>
<p>
In addition, the <c>truetype</c> USE flag compiles support for TrueType fonts
with the use of Xft. Most users will want this as well.
</p>
<pre caption="/etc/portage/package.use">
<comment>(Use the following as an example)</comment>
# <i>echo app-admin/conky truetype audacious -xmms -infopipe -ipv6 >> /etc/portage/package.use</i>
</pre>
<p>
Once you have your USE flags correctly set up, it's time to install Conky!
</p>
<pre caption="Installing Conky">
# <i>emerge -av conky</i>
</pre>
<p>
You can test Conky to see how it will look by running the command <c>conky</c>
in a terminal. This will likely give you a good reference to how it will look
and what you want to change, add or even remove.
</p>
<pre caption="Running Conky for the first time">
$ <i>conky</i>
</pre>
<p>
Once you have an idea of how Conky looks, you can now move on to configuring
it!
</p>
</body>
</section>
<section>
<title>Configuring Conky</title>
<body>
<p>
By default, Conky will look for a configuration file in the user's home
directory located at <path>~/.conkyrc</path> This file contains all the
configuration options, and the static text, colors and other variables which
control what data is shown to the user. Conky also provides a great sample
configuration, located at
<path>/usr/share/doc/<conky-version>/Conkyrc.sample.gz</path> Make sure
to replace <conky-version> with the specific version of Conky you have
installed.
</p>
<pre caption="Copying the sample configuration to your home directory">
<comment>(Replace <b>1.4.0-r1</b> with the version number of Conky)</comment>
$ <i>zcat /usr/share/doc/conky-1.4.0-r1/conkyrc.sample.gz >> ~/.conkyrc</i>
</pre>
<p>
Now, open up the sample configuration in the text editor of your choice. You
may notice that there are two separate sections of the configuration file. The
first section of the file, contains the program configuration options and
controls how it acts. This includes things such as the
<c>update_interval</c>, or how often Conky will update the information on the
screen. The second section contains the actual text, graphs, and variables
which are rendered on the screen. This includes things such as the system
uptime (<c>$uptime</c>), cpu usage (<c>$cpu</c>) and anything else you want to
be shown. The first section of the file starts right from the beginning, the
second section consists of everything after the line which says <c>TEXT</c>.
Comments in the file start with <c>#</c>, but keep in mind that even if a line
is commented out in the second section of the file, the text will still be
rendered to the screen.
</p>
<p>
Lists of all the available configuration options and variables are kept at
<uri>http://conky.sourceforge.net/config_settings.html</uri> and
<uri>http://conky.sourceforge.net/variables.html</uri>. Besides, there are a
few great screenshots along with sample configurations and scripts at
<uri>http://conky.sourceforge.net/screenshots.html</uri>.
</p>
</body>
</section>
</chapter>
<chapter>
<title>Extending Conky</title>
<section>
<title>Beyond the built-in variables</title>
<body>
<p>
So you've gotten this far, and have scoured the Conky documentation for that
extra variable which Conky just doesn't seem to have... You're in luck! Conky
provides several variables for just this reason! <c>$exec</c> Will run a
command every time Conky updates, <c>$execi</c> will run a command at a
specified interval and <c>$texeci</c> will run a command in its own thread at a
specified interval.
</p>
<pre caption="Scripting examples">
<i>${exec grep 'sudo' /var/log/messages | tail -n 4}</i>
<i>${execi 30 ~/scripts/emerge-status.sh</i>
<i>${texeci 600 ~/scripts/gmail.pl}</i>
</pre>
<note>
While any command which works in a command shell will work in any of these
variables, it is important to keep in mind that the commands must exit. This
means that commands like <c>tail -f</c> which keep running will <e>not</e> work
properly.
</note>
</body>
</section>
</chapter>
</guide>
--
gentoo-doc-cvs@gentoo.org mailing list
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2006-03-11 21:25 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2006-03-11 21:25 [gentoo-doc-cvs] cvs commit: conky-howto.xml metadoc.xml Xavier Neys
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox