| 1 |
neysx 06/03/11 21:25:49 |
| 2 |
|
| 3 |
Modified: metadoc.xml |
| 4 |
Added: conky-howto.xml |
| 5 |
Log: |
| 6 |
#125662 Added conky-howto |
| 7 |
|
| 8 |
Revision Changes Path |
| 9 |
1.145 xml/htdocs/doc/en/metadoc.xml |
| 10 |
|
| 11 |
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 |
| 12 |
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/metadoc.xml?rev=1.145&content-type=text/plain&cvsroot=gentoo |
| 13 |
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/metadoc.xml.diff?r1=1.144&r2=1.145&cvsroot=gentoo |
| 14 |
|
| 15 |
Index: metadoc.xml |
| 16 |
=================================================================== |
| 17 |
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v |
| 18 |
retrieving revision 1.144 |
| 19 |
retrieving revision 1.145 |
| 20 |
diff -u -r1.144 -r1.145 |
| 21 |
--- metadoc.xml 10 Mar 2006 22:36:46 -0000 1.144 |
| 22 |
+++ metadoc.xml 11 Mar 2006 21:25:49 -0000 1.145 |
| 23 |
@@ -1,9 +1,9 @@ |
| 24 |
<?xml version='1.0' encoding="UTF-8"?> |
| 25 |
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v 1.144 2006/03/10 22:36:46 neysx Exp $ --> |
| 26 |
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v 1.145 2006/03/11 21:25:49 neysx Exp $ --> |
| 27 |
<!DOCTYPE metadoc SYSTEM "/dtd/metadoc.dtd"> |
| 28 |
|
| 29 |
<metadoc lang="en"> |
| 30 |
-<version>1.72</version> |
| 31 |
+<version>1.73</version> |
| 32 |
<members> |
| 33 |
<lead>neysx</lead> |
| 34 |
<member>fox2mike</member> |
| 35 |
@@ -387,6 +387,7 @@ |
| 36 |
<file id="x86-at-faq">/proj/en/base/x86/arch-testers-faq.xml</file> |
| 37 |
<file id="php-upgrade">/proj/en/php/php-upgrading.xml</file> |
| 38 |
<file id="jffnms">/doc/en/jffnms.xml</file> |
| 39 |
+ <file id="conky">/doc/en/conky-howto.xml</file> |
| 40 |
</files> |
| 41 |
<docs> |
| 42 |
<doc id="name-logo"> |
| 43 |
@@ -1244,5 +1245,9 @@ |
| 44 |
<memberof>sysadmin_specific</memberof> |
| 45 |
<fileid>jffnms</fileid> |
| 46 |
</doc> |
| 47 |
+ <doc id="conky"> |
| 48 |
+ <memberof>desktop_config</memberof> |
| 49 |
+ <fileid>conky</fileid> |
| 50 |
+ </doc> |
| 51 |
</docs> |
| 52 |
</metadoc> |
| 53 |
|
| 54 |
|
| 55 |
|
| 56 |
1.1 xml/htdocs/doc/en/conky-howto.xml |
| 57 |
|
| 58 |
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 |
| 59 |
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 |
| 60 |
|
| 61 |
Index: conky-howto.xml |
| 62 |
=================================================================== |
| 63 |
<?xml version='1.0' encoding='UTF-8'?> |
| 64 |
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> |
| 65 |
|
| 66 |
<guide link="/doc/en/conky-howto.xml"> |
| 67 |
<title>Gentoo Linux Conky Howto</title> |
| 68 |
|
| 69 |
<author title="Author"> |
| 70 |
<mail link="admin@×××××××.us">Bill Woodford</mail> |
| 71 |
</author> |
| 72 |
<author title="Editor"> |
| 73 |
<mail link="brenden@×××.ca">Brenden Matthews</mail> |
| 74 |
</author> |
| 75 |
|
| 76 |
<abstract> |
| 77 |
This document describes how to install and configure the system monitor known |
| 78 |
as Conky. |
| 79 |
</abstract> |
| 80 |
|
| 81 |
<!-- The content of this document is licensed under the CC-BY-SA license --> |
| 82 |
<!-- See http://creativecommons.org/licenses/by-sa/2.5 --> |
| 83 |
<license/> |
| 84 |
|
| 85 |
<version>1.0</version> |
| 86 |
<date>2006-03-11</date> |
| 87 |
|
| 88 |
<chapter> |
| 89 |
<title>Background</title> |
| 90 |
<section> |
| 91 |
<title>Introduction to Conky</title> |
| 92 |
<body> |
| 93 |
|
| 94 |
<p> |
| 95 |
So you have a Gentoo machine, and have already learned 30 different commands to |
| 96 |
monitor different aspects of what your computer is doing at the current moment. |
| 97 |
What do you do from here? Isn't there an easier way to monitor system |
| 98 |
performance and see what it's doing, as well as the resources it's using to |
| 99 |
perform all those tasks? This is what a system monitor, such as Conky, |
| 100 |
provides. |
| 101 |
</p> |
| 102 |
|
| 103 |
</body> |
| 104 |
</section> |
| 105 |
<section> |
| 106 |
<title>What it does</title> |
| 107 |
<body> |
| 108 |
|
| 109 |
<p> |
| 110 |
Unlike other system monitors such as top, Conky can run as a window in an X |
| 111 |
session, or by drawing to the root window (there is also an option to have |
| 112 |
Conky display information to stdout, but we won't discuss that here). It |
| 113 |
displays the information it has gathered through the use of both text, |
| 114 |
progress bars, and graphs. Also, unlike top, the way it is formatted is |
| 115 |
completely user-configurable. In addition to monitoring the system itself, |
| 116 |
Conky can also give you information about several music players (such as XMMS, |
| 117 |
BMPx, Music Player Daemon, and Audacious Media Player), tell you how many new |
| 118 |
messages are in your mail spool, and plenty more. If the functionality you |
| 119 |
require isn't in Conky yet, it is a simple matter of writing a script to get |
| 120 |
the information you would like - some examples of this, which have already been |
| 121 |
done are RSS feeds, POP3 e-mail message count, local weather, boinc status, and |
| 122 |
even the status of portage. |
| 123 |
</p> |
| 124 |
|
| 125 |
</body> |
| 126 |
</section> |
| 127 |
</chapter> |
| 128 |
|
| 129 |
<chapter> |
| 130 |
<title>Installing Conky</title> |
| 131 |
<section> |
| 132 |
<title>Base install</title> |
| 133 |
<body> |
| 134 |
|
| 135 |
<p> |
| 136 |
Gentoo provides an ebuild to quickly and easily install Conky. Pay particular |
| 137 |
attention to the the USE flags. You'll most likely want X11 support |
| 138 |
(<c>X</c>), and make sure you select the USE flags for any music players (other |
| 139 |
than MPD) which you want. XMMS (<c>xmms</c>), Audacious (<c>audacious</c>), or |
| 140 |
XMMS support via the xmms-infopipe plugin (<c>infopipe</c>). If you want to |
| 141 |
use the TCP port monitor, be SURE to disable the <c>ipv6</c> use flag, as the |
| 142 |
port monitor is for ipv4 systems only. |
| 143 |
</p> |
| 144 |
|
| 145 |
<p> |
| 146 |
In addition, the <c>truetype</c> USE flag compiles support for TrueType fonts |
| 147 |
with the use of Xft. Most users will want this as well. |
| 148 |
</p> |
| 149 |
|
| 150 |
<pre caption="/etc/portage/package.use"> |
| 151 |
<comment>(Use the following as an example)</comment> |
| 152 |
# <i>echo app-admin/conky truetype audacious -xmms -infopipe -ipv6 >> /etc/portage/package.use</i> |
| 153 |
</pre> |
| 154 |
|
| 155 |
<p> |
| 156 |
Once you have your USE flags correctly set up, it's time to install Conky! |
| 157 |
</p> |
| 158 |
|
| 159 |
<pre caption="Installing Conky"> |
| 160 |
# <i>emerge -av conky</i> |
| 161 |
</pre> |
| 162 |
|
| 163 |
<p> |
| 164 |
You can test Conky to see how it will look by running the command <c>conky</c> |
| 165 |
in a terminal. This will likely give you a good reference to how it will look |
| 166 |
and what you want to change, add or even remove. |
| 167 |
</p> |
| 168 |
|
| 169 |
<pre caption="Running Conky for the first time"> |
| 170 |
$ <i>conky</i> |
| 171 |
</pre> |
| 172 |
|
| 173 |
<p> |
| 174 |
Once you have an idea of how Conky looks, you can now move on to configuring |
| 175 |
it! |
| 176 |
</p> |
| 177 |
|
| 178 |
</body> |
| 179 |
</section> |
| 180 |
<section> |
| 181 |
<title>Configuring Conky</title> |
| 182 |
<body> |
| 183 |
|
| 184 |
<p> |
| 185 |
By default, Conky will look for a configuration file in the user's home |
| 186 |
directory located at <path>~/.conkyrc</path> This file contains all the |
| 187 |
configuration options, and the static text, colors and other variables which |
| 188 |
control what data is shown to the user. Conky also provides a great sample |
| 189 |
configuration, located at |
| 190 |
<path>/usr/share/doc/<conky-version>/Conkyrc.sample.gz</path> Make sure |
| 191 |
to replace <conky-version> with the specific version of Conky you have |
| 192 |
installed. |
| 193 |
</p> |
| 194 |
|
| 195 |
<pre caption="Copying the sample configuration to your home directory"> |
| 196 |
<comment>(Replace <b>1.4.0-r1</b> with the version number of Conky)</comment> |
| 197 |
$ <i>zcat /usr/share/doc/conky-1.4.0-r1/conkyrc.sample.gz >> ~/.conkyrc</i> |
| 198 |
</pre> |
| 199 |
|
| 200 |
<p> |
| 201 |
Now, open up the sample configuration in the text editor of your choice. You |
| 202 |
may notice that there are two separate sections of the configuration file. The |
| 203 |
first section of the file, contains the program configuration options and |
| 204 |
controls how it acts. This includes things such as the |
| 205 |
<c>update_interval</c>, or how often Conky will update the information on the |
| 206 |
screen. The second section contains the actual text, graphs, and variables |
| 207 |
which are rendered on the screen. This includes things such as the system |
| 208 |
uptime (<c>$uptime</c>), cpu usage (<c>$cpu</c>) and anything else you want to |
| 209 |
be shown. The first section of the file starts right from the beginning, the |
| 210 |
second section consists of everything after the line which says <c>TEXT</c>. |
| 211 |
Comments in the file start with <c>#</c>, but keep in mind that even if a line |
| 212 |
is commented out in the second section of the file, the text will still be |
| 213 |
rendered to the screen. |
| 214 |
</p> |
| 215 |
|
| 216 |
<p> |
| 217 |
Lists of all the available configuration options and variables are kept at |
| 218 |
<uri>http://conky.sourceforge.net/config_settings.html</uri> and |
| 219 |
<uri>http://conky.sourceforge.net/variables.html</uri>. Besides, there are a |
| 220 |
few great screenshots along with sample configurations and scripts at |
| 221 |
<uri>http://conky.sourceforge.net/screenshots.html</uri>. |
| 222 |
</p> |
| 223 |
|
| 224 |
</body> |
| 225 |
</section> |
| 226 |
</chapter> |
| 227 |
|
| 228 |
<chapter> |
| 229 |
<title>Extending Conky</title> |
| 230 |
<section> |
| 231 |
<title>Beyond the built-in variables</title> |
| 232 |
<body> |
| 233 |
|
| 234 |
<p> |
| 235 |
So you've gotten this far, and have scoured the Conky documentation for that |
| 236 |
extra variable which Conky just doesn't seem to have... You're in luck! Conky |
| 237 |
provides several variables for just this reason! <c>$exec</c> Will run a |
| 238 |
command every time Conky updates, <c>$execi</c> will run a command at a |
| 239 |
specified interval and <c>$texeci</c> will run a command in its own thread at a |
| 240 |
specified interval. |
| 241 |
</p> |
| 242 |
|
| 243 |
<pre caption="Scripting examples"> |
| 244 |
<i>${exec grep 'sudo' /var/log/messages | tail -n 4}</i> |
| 245 |
<i>${execi 30 ~/scripts/emerge-status.sh</i> |
| 246 |
<i>${texeci 600 ~/scripts/gmail.pl}</i> |
| 247 |
</pre> |
| 248 |
|
| 249 |
<note> |
| 250 |
While any command which works in a command shell will work in any of these |
| 251 |
variables, it is important to keep in mind that the commands must exit. This |
| 252 |
means that commands like <c>tail -f</c> which keep running will <e>not</e> work |
| 253 |
properly. |
| 254 |
</note> |
| 255 |
|
| 256 |
</body> |
| 257 |
</section> |
| 258 |
</chapter> |
| 259 |
</guide> |
| 260 |
|
| 261 |
|
| 262 |
|
| 263 |
-- |
| 264 |
gentoo-doc-cvs@g.o mailing list |
Archives