as well as the ability to execute programs and scripts, then display
the output from stdout.
- We are always looking for help, and anyone interested in becoming a
- developer is welcome. Please use the facilities at SourceForge to make
+ We are always looking for help, and anyone interested in becoming a de-
+ veloper is welcome. Please use the facilities at SourceForge to make
bug reports, feature requests, and submit patches.
Thanks for your interest in Conky.
sh autogen.sh # Only required if building from Svn
- ./configure --prefix=/usr --mandir=/usr/share/man
- --infodir=/usr/share/info --datadir=/usr/share --sysconfdir=/etc
- --localstatedir=/var/lib --enable-xft --enable-seti --enable-dou-
- ble-buffer --enable-own-window --enable-proc-uptime --enable-mpd
- --enable-mldonkey --enable-x11 --enable-portmon --enable-xmms
- --enable-bmp --enable-audacious --enable-infopipe --enable-bmpx
+ ./configure --prefix=/usr --mandir=/usr/share/man --in-
+ fodir=/usr/share/info --datadir=/usr/share --sysconfdir=/etc --local-
+ statedir=/var/lib --disable-own-window --enable-audacious --enable-bmpx
+ --disable-hddtemp --disable-mpd --enable-xmms2 --disable-portmon --dis-
+ able-network --enable-debug --disable-x11 --disable-double-buffer
+ --disable-xdamage --disable-xft
make
CONFIGURATION SETTINGS
Default configuration file is $HOME/.conkyrc (can be changed from
- conky.c among other things). See conkyrc.sample. If installing from
- Debian package, this should be in /usr/share/doc/conky/examples ("gun-
- zip conkyrc.sample.gz" to get conkyrc.sample).
+ conky.c among other things). See conkyrc.sample. If installing from De-
+ bian package, this should be in /usr/share/doc/conky/examples ("gunzip
+ conkyrc.sample.gz" to get conkyrc.sample).
You might want to copy it to $HOME/.conkyrc and then start modifying
it. Other configs can be found at http://conky.sf.net
started
- on_bottom
- Set Conky on the bottom of all other applications
-
-
border_margin
Border margin in pixels
Default color and border color
+ default_outline_color
+ Default outline color
+
+
default_shade_color
Default shading color and border's shading color
- default_outline_color
- Default outline color
+ dexter_client
+ Act as client and connect to libdexter server for remote moni-
+ toring?
+
+
+ dexter_config
+ Full path to libdexter configuration file (default search order:
+ $HOME/.dexterrc; /etc/libdexter/dexter.conf)
+
+
+ dexter_server
+ Act as server for libdexter services?
double_buffer
Draw borders around graphs?
- draw_shades
- Draw shades?
-
-
draw_outline
Draw outlines?
+ draw_shades
+ Draw shades?
+
+
font Font name in X, xfontsel can be used to get a nice font
- gap_x Gap between right or left border of screen, same as passing -x
- at command line
+ gap_x Gap, in pixels, between right or left border of screen, same as
+ passing -x at command line, e.g. gap_x 10
- gap_y Gap between top or bottom border of screen, same as passing -y
- at command line
+ gap_y Gap, in pixels, between top or bottom border of screen, same as
+ passing -y at command line, e.g. gap_y 10.
imap Default global IMAP server. Arguments are: "host user pass [-i
interval] [-f folder] [-p port] [-e command]". Default port is
143, default folder is 'INBOX', default interval is 5 minutes.
- If the password is supplied as '*', you will be prompted to
- enter the password when Conky starts.
-
-
- no_buffers
- Substract (file system) buffers from used memory?
+ If the password is supplied as '*', you will be prompted to en-
+ ter the password when Conky starts.
mail_spool
Mail spool for mail checking
- maximum_width pixels
- Maximum width of window
-
-
- minimum_size width (height)
- Minimum size of window
-
-
- min_port_monitors
- Allow for the creation of at least this number of port monitors
- (if 0 or not set, default is 16)
-
-
- min_port_monitor_connections
- Allow each port monitor to track at least this many connections
+ max_port_monitor_connections
+ Allow each port monitor to track at most this many connections
(if 0 or not set, default is 256)
- mldonkey_hostname
- Hostname for mldonkey stuff, defaults to localhost
+ max_specials
+ Maximum number of special things, e.g. fonts, offsets, aligns,
+ etc. (default is 512)
- mldonkey_port
- Mldonkey port, 4001 default
+ max_user_text bytes
+ Maximum size of user text buffer, i.e. layout below TEXT line in
+ config file (default is 16384 bytes)
- mldonkey_login
- Mldonkey login, default none
+ maximum_width pixels
+ Maximum width of window
- mldonkey_password
- Mldonkey password, default none
+ minimum_size width (height)
+ Minimum size of window
mpd_host
The number of samples to average for net data
+ no_buffers
+ Substract (file system) buffers from used memory?
+
+
override_utf8_locale
Force UTF8? requires XFT
Boolean, create own window to draw?
+ own_window_class
+ Manually set the WM_CLASS name. Defaults to "Conky".
+
+
+ own_window_colour colour
+ If own_window_transparent no, set a specified background colour
+ (defaults to black). Takes either a hex value (#ffffff) or a
+ valid RGB name (see /usr/lib/X11/rgb.txt)
+
+
+ own_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager
+ If own_window is yes, you may use these window manager hints to
+ affect the way Conky displays. Notes: Use own_window_type desk-
+ top as another way to implement many of these hints implicitly.
+ If you use own_window_type override, window manager hints have
+ no meaning and are ignored.
+
+
+ own_window_title
+ Manually set the window name. Defaults to "<hostname> - conky".
+
+
own_window_transparent
Boolean, set pseudo-transparency?
dow can be useful for certain situations.
- own_window_colour colour
- If own_window_transparent no, set a specified background colour
- (defaults to black). Takes either a hex value (#ffffff) or a
- valid RGB name (see /usr/lib/X11/rgb.txt)
-
-
- own_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager
- If own_window is yes, you may use these window manager hints to
- affect the way Conky displays. Notes: Use own_window_type desk-
- top as another way to implement many of these hints implicitly.
- If you use own_window_type override, window manager hints have
- no meaning and are ignored.
-
-
out_to_console
Print text to stdout.
Use Xft (anti-aliased font and stuff)
- wm_class_name
- Manually set the WM_CLASS name. Defaults to "conky".
-
-
xftalpha
Alpha of Xft font. Must be a value at or between 1 and 0.
Xft font to use.
- xmms_player
- Use specified player/plugin for the xmms status variables. Valid
- items are: none, xmms, bmp, audacious and infopipe. (default is
- none). Note that bmpx is currently handled separately.
-
-
TEXT After this begins text to be formatted on screen
VARIABLES
Colors are parsed using XParsecolor(), there might be a list of them:
- /usr/X11R6/lib/X11/rgb.txt. Also, http://sedition.com/perl/rgb.html
- [http://sedition.com/perl/rgb.html]. Color can be also in #rrggbb for-
- mat (hex). Note that when displaying bytes, power is 1024 and not 1000
- so 1M really means 1024*1024 bytes and not 1000*1000.
+ /usr/X11R6/lib/X11/rgb.txt. Also, <http://sedition.com/perl/rgb.html>.
+ Color can be also in #rrggbb format (hex). Note that when displaying
+ bytes, power is 1024 and not 1000 so 1M really means 1024*1024 bytes
+ and not 1000*1000.
addr interface
IP address for an interface
AC adapterstatus is on-line or charging (FreeBSD only)
+ audacious_bar (height),(width)
+ Progress bar
+
+
+ audacious_bitrate
+ Bitrate of current tune
+
+
+ audacious_channels
+ Number of audio channels of current tune
+
+
+ audacious_filename
+ Full path and filename of current tune
+
+
+ audacious_frequency
+ Sampling frequency of current tune
+
+
+ audacious_length
+ Total length of current tune as MM:SS
+
+
+ audacious_length_seconds
+ Total length of current tune in seconds
+
+
+ audacious_playlist_position
+ Playlist position of current tune
+
+
+ audacious_playlist_length
+ Number of tunes in playlist
+
+
+ audacious_position
+ Position of current tune (MM:SS)
+
+
+ audacious_position_seconds
+ Position of current tune in seconds
+
+
+ audacious_status
+ Player status (Playing/Paused/Stopped/Not running)
+
+
+ audacious_title (max length)
+ Title of current tune with optional maximum length specifier
+
+
battery (num)
- Remaining capacity in ACPI or APM battery. ACPI battery number
- can be given as argument (default is BAT0).
+ Battery status and remaining percentage capacity of ACPI or APM
+ battery. ACPI battery number can be given as argument (default
+ is BAT0).
+
+
+ battery_time (num)
+ Battery charge/discharge time remaining of ACPI battery. ACPI
+ battery number can be given as argument (default is BAT0).
bmpx_artist
cpu (cpuN)
CPU usage in percents. For SMP machines, the CPU number can be
- provided as an argument. cpu0 is the total usage, and >=cpu1 are
- individual CPUs.
+ provided as an argument. ${cpu 0} is the total usage, and ${cpu
+ X} (X >= 1) are individual CPUs.
cpubar (cpu number) (height),(width)
else Text to show if any of the above are not true
+ entropy_avail
+ Current entropy available for crypto freaks
+
+
+ entropy_bar (height),(width)
+ Normalized bar of available entropy for crypto freaks
+
+
+ entropy_poolsize
+ Total size of system entropy pool for crypto freaks
+
+
exec command
Executes a shell command and displays the output in conky. warn-
ing: this takes a lot more resources than other variables. I'd
execbar command
- Same as exec, except if the first value return is a value
- between 0-100, it will use that number for a bar. The size for
- the bar is currently fixed, but that may change in the future.
+ Same as exec, except if the first value return is a value be-
+ tween 0-100, it will use that number for a bar. The size for the
+ bar is currently fixed, but that may change in the future.
execgraph command
Same as execigraph, but takes an interval arg graphs values
- font font
- Specify a different font. Only applies to one line.
+ font (font)
+ Specify a different font. This new font will apply to the cur-
+ rent line and everything following. You can use a $font with no
+ arguments to change back to the default font (much like with
+ $color)
- freq Returns CPU frequency in MHz
+ freq (n)
+ Returns CPU #n's frequency in MHz. CPUs are counted from 1. If
+ omitted, the parameter defaults to 1.
- freq_g Returns CPU frequency in GHz
+ freq_g (n)
+ Returns CPU #n's frequency in GHz. CPUs are counted from 1. If
+ omitted, the parameter defaults to 1.
freq_dyn
- Returns CPU frequency in MHz, but is calculated by counting to
- clock cycles to complete an instruction. Only available for
+ Returns CPU frequency in MHz, but is calculated by counting to
+ clock cycles to complete an instruction. Only available for
x86/amd64.
freq_dyn_g
- Returns CPU frequency in GHz, but is calculated by counting to
- clock cycles to complete an instruction. Only available for
+ Returns CPU frequency in GHz, but is calculated by counting to
+ clock cycles to complete an instruction. Only available for
x86/amd64.
fs_bar (height),(width) fs
- Bar that shows how much space is used on a file system. height
+ Bar that shows how much space is used on a file system. height
is the height in pixels. fs is any file on that file system.
File system used space
+ goto x The next element will be printed at position 'x'.
+
+
+ hddtemp dev, (host,(port))
+ Displays temperature of a selected hard disk drive as reported
+ by the hddtemp daemon running on host:port. Default host is
+ 127.0.0.1, default port is 7634.
+
+
head logfile lines (interval)
- Displays first N lines of supplied text text file. If interval
- is not supplied, Conky assumes 2x Conky's interval. Max of 30
+ Displays first N lines of supplied text text file. If interval
+ is not supplied, Conky assumes 2x Conky's interval. Max of 30
lines can be displayed, or until the text buffer is filled.
Horizontal line, height is the height in pixels
+ iconv_start codeset_from codeset_to
+ Convert text from one codeset to another using GNU iconv. Needs
+ to be stopped with iconv_stop.
+
+
+ iconv_stop
+ Stop iconv codeset conversion.
+
+
i2c (dev) type n
I2C sensor from sysfs (Linux 2.6). dev may be omitted if you
have only one I2C device. type is either in (or vol) meaning
i8k_cpu_tempf
If running the i8k kernel driver for Inspiron laptops, displays
- the cpu temperature in Farenheit, as reported by /proc/i8k.
+ the cpu temperature in Fahrenheit, as reported by /proc/i8k.
i8k_left_fan_rpm
i8k_left_fan_status
If running the i8k kernel driver for Inspiron laptops, displays
the left fan status as listed in /proc/i8k (translated to human-
- readable). Beware, some laptops i8k reports these fans in
- reverse order.
+ readable). Beware, some laptops i8k reports these fans in re-
+ verse order.
i8k_right_fan_rpm
i8k_right_fan_status
If running the i8k kernel driver for Inspiron laptops, displays
- the right fan status as listed in /proc/i8k (translated to
- human-readable). Beware, some laptops i8k reports these fans in
+ the right fan status as listed in /proc/i8k (translated to hu-
+ man-readable). Beware, some laptops i8k reports these fans in
reverse order.
the version formatting of /proc/i8k.
+ ibm_fan
+ If running the IBM ACPI, displays the fan speed.
+
+
+ ibm_temps N
+ If running the IBM ACPI, displays the temperatures from the IBM
+ temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
+ GPU.
+
+
+ ibm_volume
+ If running the IBM ACPI, displays the "master" volume, con-
+ trolled by the volume keys (0-14).
+
+
+ ibm_brightness
+ If running the IBM ACPI, displays the brigtness of the laptops's
+ LCD (0-7).
+
+
if_running (process)
if PROCESS is running, display everything if_running and the
matching $endif
imap_messages (args)
- Displays the number of messages in your global IMAP inbox by
- default. You can define individual IMAP inboxes seperately by
+ Displays the number of messages in your global IMAP inbox by de-
+ fault. You can define individual IMAP inboxes seperately by
passing arguments to this object. Arguments are: "host user pass
- [-i interval] [-p port] [-e command]". Default port is 110,
- default interval is 5 minutes. If the password is supplied as
- '*', you will be prompted to enter the password when Conky
- starts.
+ [-i interval] [-p port] [-e command]". Default port is 143, de-
+ fault interval is 5 minutes. If the password is supplied as '*',
+ you will be prompted to enter the password when Conky starts.
imap_unseen (args)
Displays the number of unseen messages in your global IMAP inbox
by default. You can define individual IMAP inboxes seperately by
passing arguments to this object. Arguments are: "host user pass
- [-i interval] [-p port] [-e command]". Default port is 110,
- default interval is 5 minutes. If the password is supplied as
- '*', you will be prompted to enter the password when Conky
- starts.
+ [-i interval] [-p port] [-e command]". Default port is 143, de-
+ fault interval is 5 minutes. If the password is supplied as '*',
+ you will be prompted to enter the password when Conky starts.
kernel Kernel version
status: Display if battery is fully charged, charging, discharg-
ing or absent (running on AC)
-
percent: Display charge of battery in percent, if charging or
discharging. Nothing will be displayed, if battery is fully
charged or absent.
-
time: Display the time remaining until the battery will be fully
charged or discharged at current rate. Nothing is displayed, if
battery is absent or if it's present but fully charged and not
Displays the number of unseen messages in your global POP3 inbox
by default. You can define individual POP3 inboxes seperately by
passing arguments to this object. Arguments are: "host user pass
- [-i interval] [-p port] [-e command]". Default port is 110,
- default interval is 5 minutes. If the password is supplied as
- '*', you will be prompted to enter the password when Conky
- starts.
+ [-i interval] [-p port] [-e command]". Default port is 110, de-
+ fault interval is 5 minutes. If the password is supplied as '*',
+ you will be prompted to enter the password when Conky starts.
pop3_used (args)
- Displays the amount of space (in MiB, 2^20) used in your global
- POP3 inbox by default. You can define individual POP3 inboxes
- seperately by passing arguments to this object. Arguments are:
- "host user pass [-i interval] [-p port] [-e command]". Default
- port is 110, default interval is 5 minutes. If the password is
+ Displays the amount of space (in MiB, 2^20) used in your global
+ POP3 inbox by default. You can define individual POP3 inboxes
+ seperately by passing arguments to this object. Arguments are:
+ "host user pass [-i interval] [-p port] [-e command]". Default
+ port is 110, default interval is 5 minutes. If the password is
supplied as '*', you will be prompted to enter the password when
Conky starts.
in the range 1 to 65535. Valid items are:
count - total number of connections in the range
-
rip - remote ip address
-
rhost - remote host name
-
rport - remote port number
-
rservice - remote service name from /etc/services
-
lip - local ip address
-
lhost - local host name
-
lport - local port number
-
lservice - local service name from /etc/services
The connection index provides you with access to each connection
- in the port monitor. The monitor will return information for
- index values from 0 to n-1 connections. Values higher than n-1
- are simply ignored. For the "count" item, the connection index
- must be omitted. It is required for all other items.
+ in the port monitor. The monitor will return information for in-
+ dex values from 0 to n-1 connections. Values higher than n-1 are
+ simply ignored. For the "count" item, the connection index must
+ be omitted. It is required for all other items.
Examples:
-
- ${tcp_portmon 6881 6999 count} - displays the number of connec-
+ ${tcp_portmon 6881 6999 count} - displays the number of connec-
tions in the bittorrent port range
-
- ${tcp_portmon 22 22 rip 0} - displays the remote host ip of the
+ ${tcp_portmon 22 22 rip 0} - displays the remote host ip of the
first sshd connection
-
- ${tcp_portmon 22 22 rip 9} - displays the remote host ip of the
+ ${tcp_portmon 22 22 rip 9} - displays the remote host ip of the
tenth sshd connection
-
${tcp_portmon 1 1024 rhost 0} - displays the remote host name of
the first connection on a privileged port
-
${tcp_portmon 1 1024 rport 4} - displays the remote host port of
the fifth connection on a privileged port
-
- ${tcp_portmon 1 65535 lservice 14} - displays the local service
+ ${tcp_portmon 1 65535 lservice 14} - displays the local service
name of the fifteenth connection in the range of all ports
Note that port monitor variables which share the same port range
actually refer to the same monitor, so many references to a sin-
gle port range for different items and different indexes all use
- the same monitor internally. In other words, the program avoids
+ the same monitor internally. In other words, the program avoids
creating redundant monitors.
texeci interval command
- Runs a command at an interval inside a thread and displays the
- output. Same as $execi, except the command is run inside a
- thread. Use this if you have a slow script to keep Conky updat-
- ing. You should make the interval slightly longer then the time
- it takes your script to execute. For example, if you have a
- script that take 5 seconds to execute, you should make the
- interval at least 6 seconds. See also $execi.
+ Runs a command at an interval inside a thread and displays the
+ output. Same as $execi, except the command is run inside a
+ thread. Use this if you have a slow script to keep Conky updat-
+ ing. You should make the interval slightly longer then the time
+ it takes your script to execute. For example, if you have a
+ script that take 5 seconds to execute, you should make the in-
+ terval at least 6 seconds. See also $execi.
offset (pixels)
Move text over by N pixels. See also $voffset.
+ tab (width, (start))
+ Puts a tab of the specified width, starting from column 'start'.
+
+
tail logfile lines (interval)
Displays last N lines of supplied text text file. If interval is
not supplied, Conky assumes 2x Conky's interval. Max of 30 lines
mat
+ utime (format)
+ Display time in UTC (universal coordinate time).
+
+
+ tztime (timezone) (format)
+ Local time for specified timezone, see man strftime to get more
+ information about format. The timezone argument is specified in
+ similar fashion as TZ environment variable. For hints, look in
+ /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
+
+
totaldown net
- Total download, overflows at 4 GB on Linux with 32-bit arch and
- there doesn't seem to be a way to know how many times it has
- already done that before conky has started.
+ Total download, overflows at 4 GB on Linux with 32-bit arch and
+ there doesn't seem to be a way to know how many times it has al-
+ ready done that before conky has started.
top type, num
- This takes arguments in the form:top (name) (number) Basically,
- processes are ranked from highest to lowest in terms of cpu
- usage, which is what (num) represents. The types are: "name",
- "pid", "cpu", and mem". There can be a max of 10 processes
+ This takes arguments in the form:top (name) (number) Basically,
+ processes are ranked from highest to lowest in terms of cpu us-
+ age, which is what (num) represents. The types are: "name",
+ "pid", "cpu", and "mem". There can be a max of 10 processes
listed.
Upload speed in kilobytes with one decimal
- upspeedgraph net (height),(width) (gradient colour 1) (gradient colour
+ upspeedgraph net (height),(width) (gradient colour 1) (gradient colour
2) (scale)
- Upload speed graph, colours defined in hex, minus the #. If
+ Upload speed graph, colours defined in hex, minus the #. If
scale is non-zero, it becomes the scale for the graph.
Uptime in a shorter format
- seti_prog
- Seti@home current progress
-
-
- seti_progbar (height),(width)
- Seti@home current progress bar
-
-
- seti_credit
- Seti@home total user credit
-
-
voffset (pixels)
- Change vertical offset by N pixels. Negative values will cause
+ Change vertical offset by N pixels. Negative values will cause
text to overlap. See also $offset.
- xmms_bar (height),(width)
- xmms / bmp / audacious / infopipe: progress bar
-
-
- xmms_bitrate
- xmms / bmp / audacious / infopipe: bitrate of current tune
-
-
- xmms_channels
- xmms / bmp / audacious / infopipe: number of audio channels of
- current tune
-
-
- xmms_filename
- xmms / bmp / audacious / infopipe: full path and filename of
- current tune
-
-
- xmms_frequency
- xmms / bmp / audacious / infopipe: sampling frequency of current
- tune
-
-
- xmms_length
- xmms / bmp / audacious / infopipe: total length of current tune
- as MM:SS
-
-
- xmms_length_seconds
- xmms / bmp / audacious / infopipe: total length of current tune
- in seconds
-
-
- xmms_playlist_position
- xmms / bmp / audacious / infopipe: playlist position of current
- tune
-
-
- xmms_playlist_length
- xmms / bmp / audacious / infopipe: number of tunes in playlist
+ voltage_mv (n)
+ Returns CPU #n's voltage in mV. CPUs are counted from 1. If
+ omitted, the parameter defaults to 1.
- xmms_position
- xmms / bmp / audacious / infopipe: MM:SS position of current
- tune
-
-
- xmms_position_seconds
- xmms / bmp / audacious / infopipe: position of current tune in
- seconds
-
-
- xmms_status
- xmms / bmp / audacious / infopipe: player status (Play-
- ing/Paused/Stopped/Not running)
-
-
- xmms_title
- xmms / bmp / audacious / infopipe: title of current tune
-
-
- ibm_fan
- If running the IBM ACPI, displays the fan speed.
-
-
- ibm_temps N
- If running the IBM ACPI, displays the temperatures from the IBM
- temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
- GPU.
-
-
- ibm_volume
- If running the IBM ACPI, displays the "master" volume, con-
- trolled by the volume keys (0-14).
-
-
- ibm_brightness
- If running the IBM ACPI, displays the brigtness of the laptops's
- LCD (0-7).
+ voltage_v (n)
+ Returns CPU #n's voltage in V. CPUs are counted from 1. If omit-
+ ted, the parameter defaults to 1.
EXAMPLES
which makes Conky to create its own window.
SEE ALSO
- http://conky.sourceforge.net [http://conky.sourceforge.net]
+ <http://conky.sourceforge.net>
- http://www.sourceforge.net/projects/conky [http://www.source-
- forge.net/projects/conky]
+ <http://www.sourceforge.net/projects/conky>
#conky on irc.freenode.net
- 2006-04-23 conky(1)
+ 2006-05-13 conky(1)
projects / monky / blobdiff