Difference between revisions of "Conky"

From ArchWiki
Jump to: navigation, search
(simplification and beautification of wikilinks (interactive))
(Tag: wiki-scripts)
 
(153 intermediate revisions by 54 users not shown)
Line 1: Line 1:
 
[[Category:Status monitoring and notification]]
 
[[Category:Status monitoring and notification]]
 +
[[de:Conky]]
 
[[es:Conky]]
 
[[es:Conky]]
 +
[[fa:Conky]]
 
[[fr:Conky]]
 
[[fr:Conky]]
 
[[it:Conky]]
 
[[it:Conky]]
 +
[[ja:Conky]]
 
[[ru:Conky]]
 
[[ru:Conky]]
[[tr:Conky]]
+
[[zh-hans:Conky]]
[[zh-CN:Conky]]
 
Conky is a system monitor software for the X Window System. It is available for GNU/Linux and FreeBSD. It is free software released under the terms of the GPL license. Conky is able to monitor many system variables including CPU, memory, swap, disk space, temperature, top, upload, download, system messages, and much more. It is extremely configurable, however, the configuration can be a little hard to understand. Conky is a fork of torsmo.
 
  
==Installation and configuration==
+
{{Related articles start}}
*[[pacman|Install]] the {{Pkg|conky}} package which is available in the [[Official Repositories|official repositories]].
+
{{Related|Conky/Tips_and_tricks}}
*Edit the {{ic|~/.conkyrc}} config file using an example configuration file from [http://conky.sourceforge.net/screenshots.html homeproject-screenshot]
+
{{Related|Lm_sensors}}
When editing your config file, you will see immediately the effect of any change as soon as you save it. There is no need to log out/log in your X session. So best is to test all kind of options, one by one, save the configuration file and see the change on your conky window, and correct if your change is unappropriated.
+
{{Related|Hddtemp}}
*Alternatively, you can use the default config at {{ic|/etc/conky/conky.conf}}:
+
{{Related articles end}}
$ cp /etc/conky/conky.conf ~/.conkyrc
 
Best is to use a local {{ic|~/.conkyrc}} config.
 
As many apps, conky will first try to look for a local {{ic|.conkyrc}} file. If this one doesn't exist, then it will read the default one in {{ic|/etc/conky}}.
 
  
In case you store your configuration locally, e.g. in your home directory, you will not be able to read any log files unless you do some changes. One of the nice features of conky is to pipe to your desktop some {{ic|/var/log/}} files to read all kinds of log messages. Most of these files can only be read by {{ic|root}}, and you will thus need to {{ic|sudo}} conky. Starting conky as {{ic|root}} is not recommended, so you will need to make this following changes:
+
{{Style|Lots of useless config dumps and unneeded complexity}}
$ usermod -aG log username
+
''Conky'' is a system monitor software for the X Window System. It is available for GNU/Linux and FreeBSD. It is free software released under the terms of the GPL license. Conky is able to monitor many system variables including CPU, memory, swap, disk space, temperature, top, upload, download, system messages, and much more. It is extremely configurable, however, the configuration can be a little hard to understand. ''Conky'' is a fork of torsmo.
You add {{ic|username}} to the {{ic|log group}}. Now {{ic|username}} can read log files, and you will be able to redirect log messages with conky on your desktop.
 
  
* If conky does not accept changes -- e.g. minimum_size -- you made to {{ic|~/.conkyrc}} make sure you cleared {{ic|/etc/conky/conky.conf}} or commented out the relevant section.Best is to remove files in {{ic|/etc/conky/}}, as conky will keep reading them and this can give you some Xorg error messages.
+
== Installation ==
  
==AUR packages==
+
[[Install]] the {{Pkg|conky}} package. There are also alternative packages you can install from [[AUR]] with extra compile options enabled:
  
In addition to the basic {{Pkg|conky}} package in the [[Official Repositories|official repositories]], there are various [[Arch User Repository|AUR]] packages available with extra compile options enabled.
+
* {{AUR|conky-cli}} - conky without X11 dependencies
 +
* {{AUR|conky-lua}} - with Lua support
 +
* {{AUR|conky-lua-nv}} - with both Lua and Nvidia support
 +
* {{AUR|conky-nvidia}} - with Nvidia support
  
*Install {{AUR|conky-cli}} for conky without X11 dependencies
+
Some built in variables in conky require additional packages to be installed in order to be utilized, for example [[Hddtemp]] for hard drive tempurature and [[mpd]] for music.
*Install {{AUR|conky-nvidia}} for nvidia support.
 
*Install {{AUR|conky-lua}} for lua support.
 
*Install {{AUR|conky-lua-nv}} for both lua and nvidia support.
 
  
==Tips and tricks==
+
== Configuration ==
===Enable real transparency in KDE4 and XFCE4===
 
Since version 1.8.0, Conky suppports real transparency. To enable it add this line to {{ic|~/.conkyrc}}:
 
own_window_transparent yes
 
  
The above option is not desired with the {{ic|OWN_WINDOW_ARGB_VISUAL yes}} option.
+
By default conky uses a configuration file located at {{ic|~/.conkyrc}}. You can print out an example configuration with:
This replaces the {{Pkg|feh}} method described below.
 
  
===Autostart with xfce4===
+
  $ conky -C
In {{ic|.conkyrc}} file:
 
  background yes
 
  
This variable will fork Conky to your background.
+
If you do not want to have a dotfile in home, you can create a file elsewhere and tell conky to use it using arguments.
If you want to make your window always visible on your desktop, sticky across all workspaces and not showing in your taskbar, add these arguments:
 
own_window yes
 
own_window_type override
 
The override option makes your window out of control of your window manager.
 
  
Add a {{ic|~/.config/autostart/conky.desktop}}:
+
For example to tell conky to use a file located in the user's configuration directory:
[Desktop Entry]
+
$ conky -c ~/.config/conky/conky.conf
Encoding=UTF-8
 
Version=0.9.4
 
Type=Application
 
Name=conky
 
Comment=
 
Exec=conky -d
 
StartupNotify=false
 
Terminal=false
 
Hidden=false
 
  
===Prevent flickering===
+
Additional example configuration files are available at [https://github.com/brndnmtthws/conky/wiki/User-Configs this page].
Conky needs Double Buffer Extension (DBE) support from the X server to prevent flickering because it cannot update the window fast enough without it. It can be enabled in {{ic|/etc/X11/xorg.conf}} with {{ic|Load "dbe"}} line in {{ic|Section "Module"}}. The xorg.conf file has been replaced (1.8.x patch upwards) by {{ic|/etc/X11/xorg.conf.d}} which contains the particular configuration files. ''DBE'' is loaded automatically.
 
  
To verify:
+
When editing your config file while conky is running, conky will update with the new changes every time you write to the file.
$ grep dbe /var/log/Xorg.0.log
 
  
Output (should be similar):
+
=== Dual screen ===
[  3286.101] (II) LoadModule: "dbe"
 
[  3286.101] (II) Loading /usr/lib/xorg/modules/extensions/libdbe.so
 
[  3286.111] (II) Module dbe: vendor="X.Org Foundation"
 
  
To enable double-buffer check to have in {{ic|~/.conkyrc}}:
+
When using a dual screen configuration, you will need to play with a few options to place your ''conky'' window where you want it on the desktop.  
# Place below the other options, not below TEXT or XY
 
double_buffer yes
 
  
===Custom colors===
+
By adjusting {{ic|gap_x}}, let's say you are running a 1680x1050 pixels resolution and you want the window on middle top of your left monitor, you will use:
Aside the classic preset colors (white, black, yellow...), you can set your own custom color using the color name code. To determine the code of a color, use a color selector app. The basic {{pkg|gcolor2}} package in the [[Official Repositories|official repositories]] will give you the color name. It is made of a series of letters and numbers.
+
alignment = 'top_left',
Add this line in your configuration file for a custom color:
+
gap_X = 840,
color1    Colorname1
+
The {{ic|alignment}} option is self-explanatory, the {{ic|gap_X}} is the distance, in pixels, from the left border of your screen.
color2    Colorname2
 
Then, when editing the TEXT section, use custom color number previously defined.
 
  
===Dual Screen===
+
{{ic|xinerama_head}} is an alternative useful option, the following will place the ''conky'' window at the top right of the second screen:  
When using a dual screen configuration, you will need to play with two options to place your conky window.
+
  alignment = 'top_right',
Let's say you are running a 1680X1050 pixels resolution, and you want the window on middle top of your left monitor, you will use this:
+
  xinerama_head = 2,
  alignment top_left
 
  gap_X 840
 
The alignment option is trivial, and gap_X option is the distance, in pixels, from the left border of your screen.
 
  
===Do not minimize on Show Desktop (Compiz)===
 
If the 'Show Desktop' button or key-binding minimizes Conky along with all other windows, start the Compiz configuration settings manager, go to "General Options" and uncheck the "Hide Skip Taskbar Windows" option.
 
  
===Integrate with Gnome 3+===
+
=== Config file syntax changed ===
Some have experienced problems with Conky showing up under Gnome 3.
 
*Add these lines to {{ic|~/.conkyrc}}:
 
own_window yes
 
own_window_type conky
 
own_window_transparent yes
 
own_window_hints undecorated,below,sticky,skip_taskbar,skip_pager
 
  
===Integrate with KDesktop===
+
Since Conky 1.10, configuration files have been written with a new Lua syntax, like so:
Conky with screenshot configuration generate problems with icons visualization. So there are some steps to follow.
 
*Add these lines to {{ic|~/.conkyrc}}:
 
own_window yes
 
own_window_type normal
 
own_window_transparent yes
 
own_window_hints undecorated,below,sticky,skip_taskbar,skip_pager
 
*If this setting is on, comment it out or delete the line:
 
minimum_size
 
*To automatically start Conky, create this symlink:
 
$ ln -s /usr/bin/conky ~/.kde/share/autostart/conkylink
 
For KDE4 users:
 
$ ln -s /usr/bin/conky ~/.kde4/Autostart/conkylink
 
*[[pacman|Install]] the {{Pkg|feh}} package which is available in the [[Official Repositories|official repositories]].
 
*Make a script to allow transparency with the desktop
 
For KDE3 users
 
$ nano -w ~/.kde/share/autostart/fehconky
 
  
#!/bin/bash
+
  conky.config = {
feh --bg-scale `dcop kdesktop KBackgroundIface currentWallpaper 1`
+
    -- Comments start with a double dash
For KDE4 users
+
    bool_value = true,
$ nano -w ~/.kde4/Autostart/fehconky
+
    string_value = 'foo',
 +
    int_value = 42,
 +
  }
 +
  conky.text = [[
 +
  $variable
 +
  ${evaluated variable}
 +
  ]]
  
#!/bin/bash
+
Some examples below may still use the old syntax, which looks like this:
feh --bg-scale "`grep 'wallpaper=' ~/.kde4/share/config/plasma-desktop-appletsrc | tail --lines=1 | sed 's/wallpaper=//'`"
 
use {{ic|--bg-center}} if you use a centered wallpaper.
 
*Make it executable
 
$ chmod +x ~/.kde/share/autostart/fehconky
 
KDE4
 
$ chmod +x ~/.kde4/Autostart/fehconky
 
*Instead of using a script, you can add the corresponding line to the bottom of {{ic|~/.conkyrc}}
 
For KDE3
 
${exec feh --bg-scale `dcop kdesktop KBackgroundIface currentWallpaper 1`}
 
For KDE4
 
${exec feh --bg-scale "`grep 'wallpaper=' ~/.kde4/share/config/plasma-desktop-appletsrc | tail --lines=1 | sed 's/wallpaper=//'`"}
 
  
===Integrate with Razor-qt===
+
  bool_value yes
With Conky's default configuration, its window might disappear from the desktop when you click on the latter.
+
  string_value 'foo'
Here's how to configure Conky to stick on your Razor-qt desktop:
+
  int_value 42
*Add these lines to:
 
{{hc|~/.conkyrc|own_window yes
 
own_window_class Conky
 
own_window_type normal
 
own_window_hints undecorated,below,sticky,skip_taskbar,skip_pager
 
own_window_transparent yes
 
}}
 
  
===Display package update information===
+
A Lua script is available to convert from the old syntax to the new Lua syntax [https://github.com/brndnmtthws/conky/blob/master/extras/convert.lua here].
*[https://bbs.archlinux.org/viewtopic.php?id=68104 Paconky] - Displays package update information in a user-defined format. The output of this program can be included in Conky with the {{ic|<nowiki>${execpi}</nowiki>}} command.
 
*[https://bbs.archlinux.org/viewtopic.php?id=53761 Scrolling Notifications] - Prints scrolling update notifications. From the author of Paconky.
 
*[https://bbs.archlinux.org/viewtopic.php?id=57291 Perl Script] - Simpler and earlier script from the author of Paconky. Prints only the number of packages needing an update.
 
*[https://bbs.archlinux.org/viewtopic.php?id=37284 Python Script] - Fairly configurable update notification program in [[Python]].
 
*[https://bbs.archlinux.org/viewtopic.php?pid=483742#p483742 Bash Script] - [[Bash]] script for users that have enabled ShowSize.
 
  
===Display weather forecast===
+
== Fonts ==
See [https://bbs.archlinux.org/viewtopic.php?id=37381 this thread].
 
  
===Display RSS feeds===
+
For displaying Unicode pictures and emoji with conky you will need a [[Fonts#Emoji_and_symbols|font]] that supports this and then configure conky to use the font with the Unicode you want to display. For example:
Conky has the ability to display RSS feeds natively without the need for an outside script to run and output into Conky. For example, to display the titles of the ten most recent Planet Arch updates and refresh the feed every minute, you would put this into your {{ic|~/.conkyrc}} in the TEXT section:
 
  
${rss https://planet.archlinux.org/rss20.xml 1 item_titles 10 }
+
  ${font Symbola:size=48}${font}  
If you want to display Arch Forum rss feed, add this line:
 
${rss https://bbs.archlinux.org/extern.php?action=feed&type=rss 1 item_titles 4}
 
where 1 is in minutes the refresh interval (15 mn is default),4 the number of items you wish to show.
 
  
===Display Distrowatch Arch Linux ranking===
+
=== Symbolic Fonts ===
See [https://bbs.archlinux.org/viewtopic.php?id=88779 this thread].
 
  
===Display rTorrent stats===
+
Symbolic fonts are also very commonly used in more decorated conky configurations, some of the more popular ones include;
See [https://bbs.archlinux.org/viewtopic.php?id=67304 this thread].
 
  
===Display number of new emails (Gmail)===
+
* {{AUR|ttf-pizzadude-bullets}} - PizzaDude Bullet's font
Create a file named {{ic|gmail.py}} in a convenient location (this example uses {{ic|~/.scripts/}}) with the following [[Python]] code:
+
* {{AUR|otf-font-awesome-5-free}} - Font awesome icon from from http://fontawesome.com/
#!/usr/bin/env python
+
* {{AUR|ttf-weather-icons}} - Erik flowers weather icon font with 222 glyphs
 
from urllib.request import FancyURLopener
 
 
username = 'username'
 
password  = 'superlongandhardpassword'
 
 
url = 'https://%s:%s@mail.google.com/mail/feed/atom' % (username, password)
 
 
opener = FancyURLopener()
 
page = opener.open(url)
 
 
contents = page.read().decode('utf-8')
 
 
 
ifrom = contents.index('<fullcount>') + 11
 
ito  = contents.index('</fullcount>')
 
 
unread = contents[ifrom:ito]
 
 
print(unread)
 
  
as suggested [https://bbs.archlinux.org/viewtopic.php?id=130608 here]. A similar change can be made if using a Google App mail account (below).
+
== Autostart ==
  
You can also use Python's urllib as follows.
+
Conky can be started automatically several different ways, as outlined in "[[Autostarting]]". Choose the one that works best for your window manager/desktop environment.
import urllib.request
 
from xml.etree import ElementTree as etree
 
 
# Enter your username and password below within quotes below, in place of ****.
 
# Set up authentication for gmail
 
auth_handler = urllib.request.HTTPBasicAuthHandler()
 
auth_handler.add_password(realm='New mail feed',
 
                          uri='https://mail.google.com/',
 
                          user= '****',
 
                          passwd= '****')
 
opener = urllib.request.build_opener(auth_handler)
 
# ...and install it globally so it can be used with urlopen.
 
urllib.request.install_opener(opener)
 
 
gmail = 'https://mail.google.com/gmail/feed/atom'
 
NS = '{http://purl.org/atom/ns#}'
 
with urllib.request.urlopen(gmail) as source:
 
    tree = etree.parse(source)
 
fullcount = tree.find(NS + 'fullcount').text
 
print(fullcount + ' new')
 
  
Add the following string to your {{ic|~/.conkyrc}} in order the check your Gmail account for new email every five minutes (300 seconds) and display:
+
Conky has a configuration setting which will tell it to fork to the background. This may be desirable for some autostarting setups.
${execpi 300 python ~/.scripts/gmail.py}
 
  
====Other Methods====
+
In {{ic|conky.conf}}:
The same way, but with using {{ic|grep}} and {{ic|sed}} for filtering output of {{ic|wget}}:
+
  conky.config = {
+
    background = true,
$ wget -q -O - https://mail.google.com/a/'''domain'''/feed/atom \
 
>                                --http-user='''login'''@'''domain''' \
 
>                                --http-password='''password''' \
 
>                                --no-check-certificate | \
 
> grep fullcount | sed 's/<[^0-9]*>//g'
 
 
 
instead of words '''login, domain, password''' you must type yours data.
 
 
Alternatively, you can use [http://www.stunnel.org/ stunnel] which is provided by the {{Pkg|stunnel}} package.
 
 
 
The following configuration is taken from [http://conky.sourceforge.net/faq.html Conky's FAQ]
 
 
 
Modify {{ic|/etc/stunnel/stunnel.conf}} as follows, and then start the {{ic|stunnel}} [[Daemon|daemon]]:
 
  # Service-level configuration for TLS server
 
[imap]
 
client = yes
 
accept  = 143
 
connect = imap.gmail.com:143
 
protocol = imap
 
sslVersion = TLSv1
 
# Service-level configuration for SSL server
 
[imaps]
 
client = yes
 
accept  = 993
 
connect = imap.gmail.com:993
 
 
 
The only thing left is our {{ic|~/.conkyrc}}:
 
imap localhost username * -i 120 -p 993
 
TEXT
 
Inbox: ${imap_unseen}/${imap_messages}
 
 
 
Here I used * as the password for Conky to ask for it at start, but you do not ''have'' to do it.
 
 
 
====Google Apps====
 
The above Python script did not work for me and my Google Apps account. I modified the script below to work with a Google App mail account [[Python]] code:
 
import os
 
 
 
#Enter your domain, username and password below within double quotes
 
# eg. domain="yourdomain.com", username="username" and password="password"
 
domain="yourdomain.com"
 
username="username"
 
password="password"
 
com="wget -q -O - https://mail.google.com/a/"+domain+"/feed/atom --http-user="+username+"@"+domain+" --http-password="+password+" --no-check-certificate"
 
temp=os.popen(com)
 
msg=temp.read()
 
index=msg.find("<fullcount>")
 
index2=msg.find("</fullcount>")
 
fc=int(msg[index+11:index2])
 
print(str(fc)+" new")
 
 
 
===Display new emails (IMAP + SSL)===
 
Conky has built in support for IMAP accounts but does not support SSL. This can be provided using this script from [http://www.unix.com/shell-programming-scripting/115322-perl-conky-gmail-imap-unread-message-count.html this forum post]. This requires the Perl/CPAN Modules Mail::IMAPClient and IO::Socket::SSL which are in the {{AUR|perl-mail-imapclient}} and {{Pkg|perl-io-socket-ssl}} packages
 
 
 
Create a file named {{ic|imap.pl}} in a location to be read by Conky. In this file, add (with the appropriate changes):
 
#!/usr/bin/perl
 
 
# gimap.pl by gxmsgx
 
# description: get the count of unread messages on imap
 
 
use strict;
 
use Mail::IMAPClient;
 
use IO::Socket::SSL;
 
 
my $username = 'example.username';
 
my $password = 'password123';
 
 
my $socket = IO::Socket::SSL->new(
 
  PeerAddr => 'imap.server',
 
  PeerPort => 993
 
  )
 
  or die "socket(): $@";
 
 
my $client = Mail::IMAPClient->new(
 
  Socket  => $socket,
 
  User    => $username,
 
  Password => $password,
 
  )
 
  or die "new(): $@";
 
 
if ($client->IsAuthenticated()) {
 
    my $msgct;
 
 
    $client->select("INBOX");
 
    $msgct = $client->unseen_count||'0';
 
    print "$msgct\n";
 
 
  }
 
  }
 
$client->logout();
 
 
Add to {{ic|~/.conkyrc}}:
 
${execpi 300 ~/.conky/imap.pl}
 
or wherever you saved the file.
 
 
Alternatively, you can use stunnel as shown above: [[Conky#How to display the number of new emails (Gmail) in Conky]]
 
 
== User-contributed configuration examples ==
 
=== Graysky ===
 
[[http://img9.imageshack.us/img9/3153/imageffj.jpg Screen shot]]
 
 
[[https://github.com/graysky2/configs/raw/master/dotfiles/.conkyrc Here]] it is - modify to fit your system. Optimized for a quad core chip w/ several hdds (although one of them is not connected for this screenshot) and an nvidia graphics card. You can easily modify this to a dual or single core system with one or whatever number of hdds.
 
 
==A sample rings script with nvidia support:==
 
 
{{bc|1=
 
# -- Conky settings -- #
 
background no
 
update_interval 1
 
 
cpu_avg_samples 2
 
net_avg_samples 2
 
 
override_utf8_locale yes
 
  
double_buffer yes
+
If you use a graphical desktop environment and wish to use a {{ic|conky.desktop}} file for autostarting, use the following:
no_buffers yes
 
  
text_buffer_size 2048
+
{{hc|~/.config/autostart/conky.desktop|2=
imlib_cache_size 0
+
[Desktop Entry]
 +
Type=Application
 +
Name=conky
 +
Exec=conky --daemonize --pause=5
 +
StartupNotify=false
 +
Terminal=false}}
  
# -- Window specifications -- #
+
The {{ic|1=pause=5}} parameter delays ''conky'''s drawing for 5 seconds at startup to make sure that the desktop had time to load and is up.
  
own_window yes
+
== Trouble Shooting ==
own_window_type normal
 
own_window_transparent yes
 
own_window_hints undecorate,sticky,skip_taskbar,skip_pager,below
 
  
border_inner_margin 0
+
These are known issues people have with conky and their solutions.
border_outer_margin 0
 
  
minimum_size 320 800
+
=== Conky starts and doesn't display anything on the screen ===
maximum_width 320
 
  
alignment bottom_right
+
First check for syntax errors in your configuration file's text variable. Then double check that your user has permission to run every command inside your configuration file and that all needed packages are installed.
gap_x 0
 
gap_y 0
 
  
# -- Graphics settings -- #
+
=== Transparency ===
draw_shades no
 
draw_outline no
 
draw_borders no
 
draw_graph_borders yes
 
  
# -- Text settings -- #
+
Conky supports two different types of transparency. Pseudo-transparency and real transparency that requires a [[composite manager]] to be installed and running. If you enable real transparency and don't have a composite manager running your conky will not be alpha transparent with transparency enabled for fonts and images as well as the background.
use_xft yes
 
xftfont MaiandraGD:size=24
 
xftalpha 0.4
 
  
uppercase no
+
==== Pseudo-transparency ====
  
default_color 888888
+
Pseudo-transparency is enabled by default in conky. Pseudo-transparency works by copying the background image from the root window and using the relevant section as the background for conky. Some window managers set the background wallpaper to a level above the root window which can cause conky to have a grey background. To fix this issue you need to set it manually with feh.
  
# -- Lua Load -- #
+
In {{ic|~/.xinitrc}}:
lua_load ~/conky/lua/lua.lua
 
lua_draw_hook_pre ring_stats
 
  
TEXT
+
  sleep 1 && feh --bg-center ~/background.png &
${alignr}${voffset 53}${goto 90}${font MaiandraGD:size=11}${time %A, %d %B %Y}
 
  
 +
==== Enable real transparency ====
  
${voffset 5}${goto 164}${font MaiandraGD:size=16}${time %H:%M}
+
To enable real transparency, you must have a [[composite manager]] running and the following lines added to {{ic|.conkyrc}} inside the conky.config array:
  
 +
  conky.config = {
 +
    own_window = true,
 +
    own_window_transparent = true,
 +
    own_window_argb_visual = true,
 +
    own_window_type = desktop,
 +
  }
  
 +
If window type "desktop" does not work try changing it to {{ic|normal}}. If that does not work try the other options: {{ic|dock}}, {{ic|panel}}, or {{ic|override}} instead.
  
${voffset -40}${goto 100}${font MaiandraGD:size=9}Kernel:${offset 70}Uptime:
+
{{Note|1=[[Xfce]] requires enabled compositing, see [https://forum.xfce.org/viewtopic.php?pid=25939].}}
${goto 90}${font MaiandraGD:size=9}$kernel${offset 40}$uptime
 
${voffset 57}${goto 117}${font snap:size=8}${cpu cpu0}%
 
${goto 117}${cpu cpu1}%
 
${goto 117}CPU
 
${voffset 19}${goto 145}${memperc}%
 
${goto 145}$swapperc%
 
${goto 145}MEM
 
${voffset 25}${goto 170}${nvidia gpufreq}
 
${goto 170}${nvidia memfreq}
 
${goto 170}GPU
 
${voffset 27}${goto 198}${totaldown ppp0}
 
${goto 198}${totalup ppp0}
 
${goto 205}NET
 
${voffset 21}
 
${goto 222}${fs_used /home}
 
${goto 230}DISK
 
}}
 
  
*And the required lua.lua script:
+
=== Do not minimize on Show Desktop ===
  
{{bc|1=
+
'''Using Compiz:''' If the 'Show Desktop' button or key-binding minimizes Conky along with all other windows, start the Compiz configuration settings manager, go to "General Options" and uncheck the "Hide Skip Taskbar Windows" option.
--[[
 
Ring Meters by londonali1010 (2009)
 
 
 
This script draws percentage meters as rings. It is fully customisable; all options are described in the script.
 
 
 
IMPORTANT: if you are using the 'cpu' function, it will cause a segmentation fault if it tries to draw a ring straight away. The if statement on line 145 uses a delay to make sure that this does not happen. It calculates the length of the delay by the number of updates since Conky started. Generally, a value of 5s is long enough, so if you update Conky every 1s, use update_num > 5 in that if statement (the default). If you only update Conky every 2s, you should change it to update_num > 3; conversely if you update Conky every 0.5s, you should use update_num > 10. ALSO, if you change your Conky, is it best to use "killall conky; conky" to update it, otherwise the update_num will not be reset and you will get an error.
 
 
 
To call this script in Conky, use the following (assuming that you save this script to ~/scripts/rings.lua):
 
        lua_load ~/scripts/rings-v1.2.1.lua
 
        lua_draw_hook_pre ring_stats
 
 
 
Changelog:
 
+ v1.2.1 -- Fixed minor bug that caused script to crash if conky_parse() returns a nil value (20.10.2009)
 
+ v1.2 -- Added option for the ending angle of the rings (07.10.2009)
 
+ v1.1 -- Added options for the starting angle of the rings, and added the "max" variable, to allow for variables that output a numerical value rather than a percentage (29.09.2009)
 
+ v1.0 -- Original release (28.09.2009)
 
]]
 
 
settings_table = {
 
        {
 
                -- Edit this table to customise your rings.
 
                -- You can create more rings simply by adding more elements to settings_table.
 
                -- "name" is the type of stat to display; you can choose from 'cpu', 'memperc', 'fs_used_perc', 'battery_used_perc'.
 
                name='time',
 
                -- "arg" is the argument to the stat type, e.g. if in Conky you would write ${cpu cpu0}, 'cpu0' would be the argument. If you would not use an argument in the Conky variable, use ''.
 
                arg='%I.%M',
 
                -- "max" is the maximum value of the ring. If the Conky variable outputs a percentage, use 100.
 
                max=12,
 
                -- "bg_colour" is the colour of the base ring.
 
                bg_colour=0x888888,
 
                -- "bg_alpha" is the alpha value of the base ring.
 
                bg_alpha=0.3,
 
                -- "fg_colour" is the colour of the indicator part of the ring.
 
                fg_colour=0x888888,
 
                -- "fg_alpha" is the alpha value of the indicator part of the ring.
 
                fg_alpha=0.5,
 
                -- "x" and "y" are the x and y coordinates of the centre of the ring, relative to the top left corner of the Conky window.
 
                x=191, y=145,
 
                -- "radius" is the radius of the ring.
 
                radius=32,
 
                -- "thickness" is the thickness of the ring, centred around the radius.
 
                thickness=4,
 
                -- "start_angle" is the starting angle of the ring, in degrees, clockwise from top. Value can be either positive or negative.
 
                start_angle=0,
 
                -- "end_angle" is the ending angle of the ring, in degrees, clockwise from top. Value can be either positive or negative, but must be larger (e.g. more clockwise) than start_angle.
 
                end_angle=360
 
        },
 
        {
 
                name='time',
 
                arg='%M.%S',
 
                max=60,
 
                bg_colour=0x888888,
 
                bg_alpha=0.3,
 
                fg_colour=0x888888,
 
                fg_alpha=0.5,
 
                x=191, y=145,
 
                radius=37,
 
                thickness=4,
 
                start_angle=0,
 
                end_angle=360
 
        },
 
        {
 
                name='time',
 
                arg='%S',
 
                max=60,
 
                bg_colour=0x888888,
 
                bg_alpha=0.3,
 
                fg_colour=0x888888,
 
                fg_alpha=0.5,
 
                x=191, y=145,
 
                radius=42,
 
                thickness=4,
 
                start_angle=0,
 
                end_angle=360
 
        },
 
        {
 
                name='cpu',
 
                arg='cpu0',
 
                max=100,
 
                bg_colour=0x888888,
 
                bg_alpha=0.3,
 
                fg_colour=0x888888,
 
                fg_alpha=0.5,
 
                x=140, y=300,
 
                radius=26,
 
                thickness=5,
 
                start_angle=-90,
 
                end_angle=180
 
        },
 
        {
 
                name='cpu',
 
                arg='cpu1',
 
                max=100,
 
                bg_colour=0x888888,
 
                bg_alpha=0.3,
 
                fg_colour=0x888888,
 
                fg_alpha=0.5,
 
                x=140, y=300,
 
                radius=20,
 
                thickness=5,
 
                start_angle=-90,
 
                end_angle=180
 
        },
 
        {
 
                name='memperc',
 
                arg='',
 
                max=100,
 
                bg_colour=0x888888,
 
                bg_alpha=0.3,
 
                fg_colour=0x888888,
 
                fg_alpha=0.5,
 
                x=170, y=350,
 
                radius=26,
 
                thickness=5,
 
                start_angle=-90,
 
                end_angle=180
 
        },
 
        {
 
                name='swapperc',
 
                arg='',
 
                max=100,
 
                bg_colour=0x888888,
 
                bg_alpha=0.3,
 
                fg_colour=0x888888,
 
                fg_alpha=0.5,
 
                x=170, y=350,
 
                radius=20,
 
                thickness=5,
 
                start_angle=-90,
 
                end_angle=180
 
        },
 
        {
 
                name='time',
 
                arg='%d',
 
                max=31,
 
                bg_colour=0x888888,
 
                bg_alpha=0.3,
 
                fg_colour=0x888888,
 
                fg_alpha=0.5,
 
                x=191, y=145,
 
                radius=50,
 
                thickness=5,
 
                start_angle=-140,
 
                end_angle=-30
 
        },
 
        {
 
                name='time',
 
                arg='%m',
 
                max=12,
 
                bg_colour=0x888888,
 
                bg_alpha=0.3,
 
                fg_colour=0x888888,
 
                fg_alpha=0.5,
 
                x=191, y=145,
 
                radius=50,
 
                thickness=5,
 
                start_angle=30,
 
                end_angle=140
 
        },
 
--      {
 
--              name='fs_used_perc',
 
--              arg='/',
 
--              max=100,
 
--              bg_colour=0x888888,
 
--              bg_alpha=0.3,
 
--              fg_colour=0x888888,
 
--              fg_alpha=0.5,
 
--              x=260, y=503,
 
--              radius=26,
 
--              thickness=5,
 
--              start_angle=-90,
 
--              end_angle=180
 
--      },
 
        {
 
                name='fs_used_perc',
 
                arg='/home',
 
                max=100,
 
                bg_colour=0x888888,
 
                bg_alpha=0.3,
 
                fg_colour=0x888888,
 
                fg_alpha=0.5,
 
                x=260, y=503,
 
                radius=20,
 
                thickness=5,
 
                start_angle=-90,
 
                end_angle=180
 
        },
 
        {
 
                name='totalup',
 
                arg='ppp0',
 
                max=2,
 
                bg_colour=0x888888,
 
                bg_alpha=0.3,
 
                fg_colour=0x888888,
 
                fg_alpha=0.5,
 
                x=230, y=452,
 
                radius=20,
 
                thickness=5,
 
                start_angle=-90,
 
                end_angle=180
 
        },
 
        {
 
                name='totaldown',
 
                arg='ppp0',
 
                max=2,
 
                bg_colour=0x888888,
 
                bg_alpha=0.3,
 
                fg_colour=0x888888,
 
                fg_alpha=0.5,
 
                x=230, y=452,
 
                radius=26,
 
                thickness=5,
 
                start_angle=-90,
 
                end_angle=180
 
        },
 
        {
 
                name='nvidia',
 
                arg='gpufreq',
 
                max=475,
 
                bg_colour=0x888888,
 
                bg_alpha=0.3,
 
                fg_colour=0x888888,
 
                fg_alpha=0.5,
 
                x=200, y=401,
 
                radius=26,
 
                thickness=5,
 
                start_angle=-90,
 
                end_angle=180
 
        },
 
{
 
                name='nvidia',
 
                arg='memfreq',
 
                max=700,
 
                bg_colour=0x888888,
 
                bg_alpha=0.3,
 
                fg_colour=0x888888,
 
                fg_alpha=0.5,
 
                x=200, y=401,
 
                radius=20,
 
                thickness=5,
 
                start_angle=-90,
 
                end_angle=180
 
        },
 
}
 
 
require 'cairo'
 
 
function rgb_to_r_g_b(colour,alpha)
 
        return ((colour / 0x10000) % 0x100) / 255., ((colour / 0x100) % 0x100) / 255., (colour % 0x100) / 255., alpha
 
end
 
 
function draw_ring(cr,t,pt)
 
        local w,h=conky_window.width,conky_window.height
 
 
        local xc,yc,ring_r,ring_w,sa,ea=pt['x'],pt['y'],pt['radius'],pt['thickness'],pt['start_angle'],pt['end_angle']
 
        local bgc, bga, fgc, fga=pt['bg_colour'], pt['bg_alpha'], pt['fg_colour'], pt['fg_alpha']
 
 
        local angle_0=sa*(2*math.pi/360)-math.pi/2
 
        local angle_f=ea*(2*math.pi/360)-math.pi/2
 
        local t_arc=t*(angle_f-angle_0)
 
 
        -- Draw background ring
 
 
        cairo_arc(cr,xc,yc,ring_r,angle_0,angle_f)
 
        cairo_set_source_rgba(cr,rgb_to_r_g_b(bgc,bga))
 
        cairo_set_line_width(cr,ring_w)
 
        cairo_stroke(cr)
 
 
        -- Draw indicator ring
 
 
        cairo_arc(cr,xc,yc,ring_r,angle_0,angle_0+t_arc)
 
        cairo_set_source_rgba(cr,rgb_to_r_g_b(fgc,fga))
 
        cairo_stroke(cr)
 
end
 
 
function conky_ring_stats()
 
        local function setup_rings(cr,pt)
 
                local str=''
 
                local value=0
 
 
                str=string.format('${%s %s}',pt['name'],pt['arg'])
 
                str=conky_parse(str)
 
 
                value=tonumber(str)
 
                if value == nil then value = 0 end
 
                pct=value/pt['max']
 
 
                draw_ring(cr,pct,p<nowiki><nowiki>Insert non-formatted text here</nowiki>'''Bold text'''</nowiki>t)
 
        end
 
 
        if conky_window==nil then return end
 
        local cs=cairo_xlib_surface_create(conky_window.display,conky_window.drawable,conky_window.visual, conky_window.width,conky_w    indow.height)
 
 
        local cr=cairo_create(cs)
 
 
        local updates=conky_parse('${updates}')
 
        update_num=tonumber(updates)
 
 
        if update_num>5 then
 
                for i in pairs(settings_table) do
 
                        setup_rings(cr,settings_table[i])
 
                end
 
        end
 
end           
 
}}
 
  
== A note about symbolic fonts ==
+
If you do not use Compiz, try editing {{ic|conky.conf}} and adding/changing the following line:
  
Many of the more decorated .conkyrc's use the fonts PizzaDude Bullets and Pie Charts for Maps. They are available from the AUR as 'ttf-pizzadude-bullets' and 'ttf-piechartsformaps' respectively, or they can be found and downloaded with a quick search and manually installed using the instructions in [[Fonts]].
+
own_window_type = 'override',
  
== Fonts appear smaller than they should ==
+
or
If you notice that your conky fonts appear smaller than they should, or they don't align properly, it could be caused by a default setting in the infinality freetype2 patch.  This setting can cause some programs to display fonts at 72 DPI instead of 96 even if the rest of your system is set to 96. If you notice a problem open {{ic|/etc/fonts/infinality/infinality.conf}}  search for the section on DPI and change 72 to 96.
 
  
== Universal method to enable true transparency ==
+
own_window_type = 'desktop',
  
Transparency is a strange beast in Conky, but there is a way to universally apply true transparency with any environment or window manager by using xcompmgr and transset-df. Install xcompmgr from [extra] and transset-df from [community] with {{ic|pacman -S xcompmgr transset-df}}. These packages both have the same 3 dependencies, so this is the lightest method for composition available, for those of you using standalone window managers in order to achieve the leanest setup you can manage (or whatever reason you have :D)
+
Refer to ''conky''s man page for the exact differences. But the latter option enables you to snap windows to ''conky''s border using resize key-binds in e.g. Openbox, which the first one does not.
  
NOTE: This may conflict with any other compositing manager you are already using.
+
=== Integrate with GNOME Shell ===
  
Check xcompmgr documentation to help you decide which compositing options you would like to enable. The following is a common standard command.
+
Some have experienced problems with ''conky'' showing up under [[GNOME]].
  
{{bc|
+
Add these lines to {{ic|conky.conf}}:
xcompmgr -c -t-5 -l-5 -r4.2 -o.55 &
+
own_window = true,
}}
+
own_window_type = 'desktop',
  
Make sure conky is running with {{ic|conky &}}. Use transset-df to enable transparency on the Conky window. Set '.5' to any value in the range 0 - 1.
+
=== Fix scrolling with UTF-8 multibyte characters ===
  
{{bc|
+
The current version of ''conky'' (1.9.0) suffers from a [https://github.com/brndnmtthws/conky/issues/129 bug] where scrolling text increments by byte, not by character, resulting in text containing multibyte characters to disappear and reappear while scrolling.  A package with a patch fixing this bug can be found in the AUR: {{AUR|conky-utfscroll}}
transset-df .5 -n Conky
 
}}
 
  
This should give your conky window true transparency. If you get an error like,
+
=== Prevent flickering ===
{{hc|$ transset-df .5 -n Conky|No Window matching Conky exists!}}
+
{{Expansion|Explain the steps to follow if there is no dbe module, probably in [[xorg]] rather than here with a link}}
Verify that conky is running, and use xprop and click on the conky window to find the name you should pass to {{ic|transset-df}}.
+
''Conky'' needs Double Buffer Extension ''(DBE)'' support from the X server to prevent flickering because it cannot update the window fast enough without it. It can be enabled with [[Xorg]] in {{ic|/etc/X11/xorg.conf}} with {{ic|Load "dbe"}} line in {{ic|"Module"}} section. The {{ic|xorg.conf}} file has been replaced (1.8.x patch upwards) by {{ic|/etc/X11/xorg.conf.d}} which contains the particular configuration files. ''DBE'' is loaded automatically as long as it is present within {{ic|/usr/lib/xorg/modules}}. The list of loaded modules can be checked with {{ic|grep LoadModule /var/log/Xorg.0.log}}.
{{hc|$ xprop &#124; grep WM_NAME|2=WM_NAME(STRING) = "Conky (ArchitectLinux)"}}
 
  
In this case, "Conky" is right, but for you it may be different, so be sure to use your output instead. If ~/.conkyrc has {{ic|own_window_type panel}} then this xprop invocation may show now output. Try using any of the following options instead. {{ic|<nowiki>own_window_type {dock,normal,override,desktop}</nowiki>}}
+
To enable double buffering, add the {{ic|double_buffer}} option to {{ic|conky.conf}}:
  
Use this in ~/.xinitrc to have transparent conky run when you {{ic|startx}}.
+
  conky.config = {
 +
      double_buffer = true,
 +
  }
  
{{bc|
+
== See also ==
xcompmgr -c -t-5 -l-5 -r4.2 -o.55 &
 
conky -d; sleep 1 && transset-df .5 -n Conky
 
}}
 
  
== External links ==
+
* [https://github.com/brndnmtthws/conky Official website]
*[https://bbs.archlinux.org/viewtopic.php?id=39906 Conky Configs on arch forums]
+
* [http://conky.sourceforge.net/config_settings.html Official Conky variables for configuration]
*[http://conky.sourceforge.net/ Official website]
+
* [http://conky.sourceforge.net/variables.html Official Conky objects]
*[http://freshmeat.net/projects/conky/ Conky] on [[wikipedia:Freshmeat|Freshmeat]]
+
* [https://bbs.archlinux.org/viewtopic.php?id=39906 Conky Configs on arch forums]
*[http://sourceforge.net/projects/conky/ Conky] on [[wikipedia:sourceforge.net|SourceForge]]
+
* [http://freecode.com/projects/conky/ Conky] on [[wikipedia:Freecode|Freecode]]
*[irc://chat.freenode.org/conky #conky] IRC chat channel on [[wikipedia:Freenode|freenode]]
+
* [irc://chat.freenode.org/conky #conky] IRC chat channel on [[wikipedia:Freenode|freenode]]
*[http://novel.evilcoder.org/wiki/index.php?title=ConkyFAQ&oldid=12463 FAQ]
+
* [http://novel.evilcoder.org/wiki/index.php?title=ConkyFAQ&oldid=12463 FAQ]

Latest revision as of 13:32, 24 March 2018


Tango-edit-clear.pngThis article or section needs language, wiki syntax or style improvements.Tango-edit-clear.png

Reason: Lots of useless config dumps and unneeded complexity (Discuss in Talk:Conky#)

Conky is a system monitor software for the X Window System. It is available for GNU/Linux and FreeBSD. It is free software released under the terms of the GPL license. Conky is able to monitor many system variables including CPU, memory, swap, disk space, temperature, top, upload, download, system messages, and much more. It is extremely configurable, however, the configuration can be a little hard to understand. Conky is a fork of torsmo.

Installation

Install the conky package. There are also alternative packages you can install from AUR with extra compile options enabled:

Some built in variables in conky require additional packages to be installed in order to be utilized, for example Hddtemp for hard drive tempurature and mpd for music.

Configuration

By default conky uses a configuration file located at ~/.conkyrc. You can print out an example configuration with:

$ conky -C

If you do not want to have a dotfile in home, you can create a file elsewhere and tell conky to use it using arguments.

For example to tell conky to use a file located in the user's configuration directory:

$ conky -c ~/.config/conky/conky.conf

Additional example configuration files are available at this page.

When editing your config file while conky is running, conky will update with the new changes every time you write to the file.

Dual screen

When using a dual screen configuration, you will need to play with a few options to place your conky window where you want it on the desktop.

By adjusting gap_x, let's say you are running a 1680x1050 pixels resolution and you want the window on middle top of your left monitor, you will use:

alignment = 'top_left',
gap_X = 840,

The alignment option is self-explanatory, the gap_X is the distance, in pixels, from the left border of your screen.

xinerama_head is an alternative useful option, the following will place the conky window at the top right of the second screen:

alignment = 'top_right',
xinerama_head = 2,


Config file syntax changed

Since Conky 1.10, configuration files have been written with a new Lua syntax, like so:

 conky.config = {
   -- Comments start with a double dash
   bool_value = true,
   string_value = 'foo',
   int_value = 42,
 }
 conky.text = [[
 $variable
 ${evaluated variable}
 ]]

Some examples below may still use the old syntax, which looks like this:

 bool_value yes
 string_value 'foo'
 int_value 42

A Lua script is available to convert from the old syntax to the new Lua syntax here.

Fonts

For displaying Unicode pictures and emoji with conky you will need a font that supports this and then configure conky to use the font with the Unicode you want to display. For example:

 ${font Symbola:size=48}☺${font} 

Symbolic Fonts

Symbolic fonts are also very commonly used in more decorated conky configurations, some of the more popular ones include;

Autostart

Conky can be started automatically several different ways, as outlined in "Autostarting". Choose the one that works best for your window manager/desktop environment.

Conky has a configuration setting which will tell it to fork to the background. This may be desirable for some autostarting setups.

In conky.conf:

conky.config = {
    background = true,
}

If you use a graphical desktop environment and wish to use a conky.desktop file for autostarting, use the following:

~/.config/autostart/conky.desktop
[Desktop Entry]
Type=Application
Name=conky
Exec=conky --daemonize --pause=5
StartupNotify=false
Terminal=false

The pause=5 parameter delays conky's drawing for 5 seconds at startup to make sure that the desktop had time to load and is up.

Trouble Shooting

These are known issues people have with conky and their solutions.

Conky starts and doesn't display anything on the screen

First check for syntax errors in your configuration file's text variable. Then double check that your user has permission to run every command inside your configuration file and that all needed packages are installed.

Transparency

Conky supports two different types of transparency. Pseudo-transparency and real transparency that requires a composite manager to be installed and running. If you enable real transparency and don't have a composite manager running your conky will not be alpha transparent with transparency enabled for fonts and images as well as the background.

Pseudo-transparency

Pseudo-transparency is enabled by default in conky. Pseudo-transparency works by copying the background image from the root window and using the relevant section as the background for conky. Some window managers set the background wallpaper to a level above the root window which can cause conky to have a grey background. To fix this issue you need to set it manually with feh.

In ~/.xinitrc:

 sleep 1 && feh --bg-center ~/background.png &

Enable real transparency

To enable real transparency, you must have a composite manager running and the following lines added to .conkyrc inside the conky.config array:

 conky.config = {
    own_window = true,
    own_window_transparent = true,
    own_window_argb_visual = true,
    own_window_type = desktop,
 }

If window type "desktop" does not work try changing it to normal. If that does not work try the other options: dock, panel, or override instead.

Note: Xfce requires enabled compositing, see [1].

Do not minimize on Show Desktop

Using Compiz: If the 'Show Desktop' button or key-binding minimizes Conky along with all other windows, start the Compiz configuration settings manager, go to "General Options" and uncheck the "Hide Skip Taskbar Windows" option.

If you do not use Compiz, try editing conky.conf and adding/changing the following line:

own_window_type = 'override',

or

own_window_type = 'desktop',

Refer to conkys man page for the exact differences. But the latter option enables you to snap windows to conkys border using resize key-binds in e.g. Openbox, which the first one does not.

Integrate with GNOME Shell

Some have experienced problems with conky showing up under GNOME.

Add these lines to conky.conf:

own_window = true,
own_window_type = 'desktop',

Fix scrolling with UTF-8 multibyte characters

The current version of conky (1.9.0) suffers from a bug where scrolling text increments by byte, not by character, resulting in text containing multibyte characters to disappear and reappear while scrolling. A package with a patch fixing this bug can be found in the AUR: conky-utfscrollAUR

Prevent flickering

Tango-view-fullscreen.pngThis article or section needs expansion.Tango-view-fullscreen.png

Reason: Explain the steps to follow if there is no dbe module, probably in xorg rather than here with a link (Discuss in Talk:Conky#)

Conky needs Double Buffer Extension (DBE) support from the X server to prevent flickering because it cannot update the window fast enough without it. It can be enabled with Xorg in /etc/X11/xorg.conf with Load "dbe" line in "Module" section. The xorg.conf file has been replaced (1.8.x patch upwards) by /etc/X11/xorg.conf.d which contains the particular configuration files. DBE is loaded automatically as long as it is present within /usr/lib/xorg/modules. The list of loaded modules can be checked with grep LoadModule /var/log/Xorg.0.log.

To enable double buffering, add the double_buffer option to conky.conf:

 conky.config = {
     double_buffer = true,
 }

See also