Conky

From Gentoo Wiki
Jump to:navigation Jump to:search
This article is a stub. Please help out by expanding it - how to get started.

Conky is an advanced and highly configurable system monitor for the Xorg window system, which "can display arbitrary information (such as the date, CPU temperature from I2C, MPD info, and anything else you desire) to the root window in X. Conky normally does this by drawing to the root window, however Conky can also be run in windowed mode (though this is not how Conky was meant to be used)."[1]

Installation

USE flags

USE flags for app-admin/conky An advanced, highly configurable system monitor for X

X Add support for X11
apcupsd Enable support for sys-power/apcupsd
bundled-toluapp Enable support for bundled toluapp. This only makes sense in combination with the lua-* flags
cmus Enable monitoring of music played by media-sound/cmus
curl Add support for client-side URL transfer library
doc Add extra documentation (API, Javadoc, etc). It is recommended to enable per package instead of globally
extras Enable syntax highlighting for app-editors/nanoand app-editors/vim
hddtemp Enable monitoring of hdd temperature (app-admin/hddtemp)
ical Enable support for events from iCalendar (RFC 5545) files using dev-libs/libical
iconv Enable support for the iconv character set conversion library
imlib Add support for imlib, an image loading and rendering library
intel-backlight Enable support for Intel backlight
iostats Enable support for per-task I/O statistics
irc Enable support for displaying everything from an irc channel using net-libs/libircclient
lua-cairo Enable if you want Lua Cairo bindings
lua-imlib Enable if you want Lua Imlib2 bindings
lua-rsvg Enable if you want Lua RSVG bindings
math Enable support for glibc's libm math library
moc Enable monitoring of music played by media-sound/moc
mpd Enable monitoring of music controlled by media-sound/mpd
mysql Add mySQL Database support
ncurses Add ncurses support (console display library)
nvidia Enable reading of nvidia card temperature sensors via x11-drivers/nvidia-drivers
portmon Enable support for tcp (ip4) port monitoring
pulseaudio Add sound server support via media-libs/libpulse (may be PulseAudio or PipeWire)
rss Enable support for RSS feeds
systemd Enable use of systemd-specific libraries and features like socket activation or session tracking
test Enable dependencies and/or preparations necessary to run tests (usually controlled by FEATURES=test but can be toggled independently)
thinkpad Enable support for IBM/Lenovo notebooks
truetype Add support for FreeType and/or FreeType2 fonts
wayland Enable dev-libs/wayland backend
webserver Enable support to act as a webserver serving conkys output using net-libs/libmicrohttpd
wifi Enable wireless network functions
xinerama Add support for querying multi-monitor screen geometry through the Xinerama API
xmms2 Enable monitoring of music played by media-sound/xmms2

Emerge

Install app-admin/conky:

root #emerge --ask app-admin/conky

Configuration

After installing Conky, create a default configuration as a starting point:

user $mkdir -p ~/.config/conky && conky -C > ~/.config/conky/conky.conf

Open the configuration file with a text editor of choice and edit away. Enabling lua syntax highlighting may help.

Users of modern composited desktop environments will probably want to use conky in own window mode with true transparency:

FILE ~/.config/conky/conky.conf
own_window = true,
own_window_class = 'conky',
own_window_argb_visual = true,
own_window_argb_value = 80,
own_window_hints = 'undecorated,below,sticky,skip_taskbar,skip_pager',
own_window_colour = '101010',
own_window_type = 'desktop'

See also

  • Conky/Guide — describes how to install and configure the system monitor known as Conky.

External resources

References