Important: You are required to change your passwords used for Gentoo services and set an email address for your Wiki account if you haven't done so. See the full announcement and Wiki email policy change for more information.

Conky/HOWTO

From Gentoo Wiki
< Conky
Revision as of 01:06, 3 December 2013 by Briangortney (Talk | contribs)

Jump to: navigation, search

This document describes how to install and configure the system monitor known as Conky.

Background

Introduction to Conky

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.

What it does

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 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.

Installing Conky

Base install

Gentoo provides an ebuild to quickly and easily install Conky. Pay particular attention to the USE flags. You'll most likely want X11 support ( X ), and make sure you select the USE flags for any music players (other than MPD) which you want, such as Audacious ( audacious ). If you want to use the TCP port monitor, be SURE to disable the ipv6 use flag, as the port monitor is for ipv4 systems only.

In addition, the truetype USE flag compiles support for TrueType fonts with the use of Xft. Most users will want this as well.

You can add syntax highlighting for Conky's configuration file with the vim-syntax and nano-syntax USE flags, depending on your preferred editor.

root # echo app-admin/conky truetype audacious -ipv6 >> /etc/portage/package.use

Once you have your USE flags correctly set up, it's time to install Conky!

root # emerge --ask conky

You can test Conky to see how it will look by running the command conky 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.

user $ conky
Note
Conky needs Double Buffer Extension (DBE) support from X server to prevent flickering, because it can't update window fast enough without it. It can be enabled in /etc/X11/xorg.conf with Load "dbe" line in Section "Module" .

Once you have an idea of how Conky looks, you can now move on to configuring it!

Configuring Conky

By default, Conky will look for a configuration file in the user's home directory located at ~/.conkyrc . 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 /etc/conky/conky.conf .

user $ cp /etc/conky/conky.conf ~/.conkyrc

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 update_interval , 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 ( $uptime ), cpu usage ( $cpu ) 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 TEXT . Comments in the file start with # , 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.

Lists of all the available configuration options and variables are kept at http://conky.sourceforge.net/config_settings.html and http://conky.sourceforge.net/variables.html . Besides, there are a few great screenshots along with sample configurations and scripts at http://conky.sourceforge.net/screenshots.html .

Extending Conky

Beyond the built-in variables

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! $exec Will run a command every time Conky updates, $execi will run a command at a specified interval and $texeci will run a command in its own thread at a specified interval.

CodeScripting examples

${exec grep 'sudo' /var/log/messages | tail -n 4}
${execi 30 ~/scripts/emerge-status.sh}
${texeci 600 ~/scripts/gmail.pl}


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 tail -f which keep running will not work properly.

Acknowledgements

We would like to thank the following authors and editors for their contributions to this guide:

  • Bill Woodford
  • Brenden Matthews
  • nightmorph