Llewellyn/conky
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-11-05 21:07:52 +00:00
Code Issues Releases Activity
20b2d2f464
conky/README
Phil a89bef1b0e update README and manpage 
git-svn-id: https://conky.svn.sourceforge.net/svnroot/conky/trunk/conky1@1272 7f574dfc-610e-0410-a909-a81674777703
2008-11-29 13:03:50 +00:00

1768 lines
53 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

conky(1) conky(1)
1mNAME0m
conky - A system monitor for X originally based on the torsmo code, but
more kickass. It just keeps on given’er. Yeah.
1mSYNOPSIS0m
1mconky 22m[4moptions24m]
1mDESCRIPTION0m
Conky is a system monitor for X originally based on torsmo. Since its
inception, Conky has changed significantly from its predecessor, while
maintaining simplicity and configurability. Conky can display just
about anything, either on your root desktop or in its own window. Not
only does Conky have many built-in objects, it can also display just
about any piece of information by using scripts and other external pro‐
grams.
Conky has more than 250 built in objects, including support for a
plethora of OS stats (uname, uptime, CPU usage, mem usage, disk usage,
"top" like process stats, and network monitoring, just to name a few),
built in IMAP and POP3 support, built in support for many popular music
players (MPD, XMMS2, BMPx, Audacious), and much much more. Conky can
display this info either as text, or using simple progress bars and
graph widgets, with different fonts and colours.
We are always looking for help, whether its reporting bugs, writing
patches, or writing docs. Please use the facilities at SourceForge to
make bug reports, feature requests, and submit patches, or stop by
#conky on irc.freenode.net if you have questions or want to contribute.
Thanks for your interest in Conky.
1mCOMPILING0m
For users compiling from source on a binary distro, make sure you have
the X development libraries installed. This should be a package along
the lines of "libx11-dev" or "xorg-x11-dev" for X11 libs, and similar
"-dev" format for the other libs required (depending on your configure
options).
Conky has (for some time) been available in the repositories of most
popular distributions. Here are some installation instructions for a
few:
Gentoo users -- Conky is in Gentoo’s Portage... simply use "emerge app-
admin/conky" for installation. There is also usually an up-to-date
ebuild within Conky’s package or in SVN.
Debian, etc. users -- Conky should be in your repositories, and can be
installed by doing "aptitude install conky".
Example to compile and run Conky with all optional components (note
that some configure options may differ for your system):
1msh autogen.sh # Only required if building from SVN0m
1m./configure --prefix=/usr --mandir=/usr/share/man --in‐0m
1mfodir=/usr/share/info --datadir=/usr/share --sysconfdir=/etc --local‐0m
1mstatedir=/var/lib --disable-own-window --enable-audacious[=yes|no|lega‐0m
1mcy] --enable-bmpx --disable-hddtemp --disable-mpd --enable-xmms2 --dis‐0m
1mable-portmon --disable-network --enable-debug --disable-x11 --dis‐0m
1mable-double-buffer --disable-xdamage --disable-xft0m
1mmake0m
1mmake install # Optional0m
1msrc/conky0m
Conky has been tested to be compatible with C99 C, however it has not
been tested with anything other than gcc, and is not guaranteed to work
with other compilers.
1mYOU SHOULD KNOW0m
Conky is generally very good on resources. That said, the more you try
to make Conky do, the more resources it is going to consume.
An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1
conky". Saves you the trouble of having to kill and then restart. You
can now also do the same with SIGHUP.
1mOPTIONS0m
Command line options override configurations defined in configuration
file.
1m-v | -V | --version0m
Prints version and exits
1m-q | --quiet0m
Run Conky in ’quiet mode’ (ie. no output)
1m-a | --alignment=ALIGNMENT0m
Text alignment on screen, {top,bottom,middle}_{left,right,mid‐
dle} or none
1m-b | --double-buffer0m
Use double buffering (eliminates "flicker")
1m-c | --config=FILE0m
Config file to load instead of $HOME/.conkyrc
1m-d | --daemonize0m
Daemonize Conky, aka fork to background
1m-f | --font=FONT0m
Font to use
1m-h | --help0m
Prints command line help and exits
1m-o | --own-window0m
Create own window to draw
1m-t | --text=TEXT0m
Text to render, remember single quotes, like -t ’ $uptime ’
1m-u | --interval=SECONDS0m
Update interval
1m-w | --window-id=WIN_ID0m
Window id to draw
1m-x X_COORDINATE0m
X position
1m-y Y_COORDINATE0m
Y position
1m-i COUNT0m
Number of times to update Conky (and quit)
1mCONFIGURATION SETTINGS0m
Default configuration file location is $HOME/.conkyrc or
${sysconfdir}/conky/conky.conf. On most systems, sysconfdir is /etc,
and you can find the sample config file there (/etc/conky/conky.conf).
You might want to copy it to $HOME/.conkyrc and then start modifying
it. Other configs can be found at http://conky.sf.net/
1malignment0m
Aligned position on screen, may be top_left, top_right, top_mid‐
dle, bottom_left, bottom_right, bottom_middle, middle_left, mid‐
dle_right, or none (also can be abreviated as tl, tr, tm, bl,
br, bm, ml, mr)
1mbackground0m
Boolean value, if true, Conky will be forked to background when
started
1mborder_margin0m
Border margin in pixels
1mborder_width0m
Border width in pixels
1mcolorN 22mPredefine a color for use inside TEXT segments. Substitute N by
a digit between 0 and 9, inclusively. When specifying the color
value in hex, omit the leading hash (#).
1mcpu_avg_samples0m
The number of samples to average for CPU monitoring
1mtop_cpu_separate0m
If true, cpu in top will show usage of one processor’s power. If
false, cpu in top will show the usage of all processors’ power
combined.
1mdefault_color0m
Default color and border color
1mdefault_outline_color0m
Default outline color
1mdefault_shade_color0m
Default shading color and border’s shading color
1mdouble_buffer0m
Use the Xdbe extension? (eliminates flicker) It is highly recom‐
mended to use own window with this one so double buffer won’t be
so big.
1mdraw_borders0m
Draw borders around text?
1mdraw_graph_borders0m
Draw borders around graphs?
1mdraw_outline0m
Draw outlines?
1mdraw_shades0m
Draw shades?
1mfont 22mFont name in X, xfontsel can be used to get a nice font
1mgap_x 22mGap, in pixels, between right or left border of screen, same as
passing -x at command line, e.g. gap_x 10
1mgap_y 22mGap, in pixels, between top or bottom border of screen, same as
passing -y at command line, e.g. gap_y 10.
1mif_up_strictness0m
How strict should if_up be when testing an interface for being
up? The value is one of up, link or address, to check for the
interface being solely up, being up and having link or being up,
having link and an assigned IP address.
1mimap 22mDefault global IMAP server. Arguments are: "host user pass [-i
interval] [-f folder] [-p port] [-e command] [-r retries]". De‐
fault port is 143, default folder is ’INBOX’, default interval
is 5 minutes, and default number of retries before giving up is
5. If the password is supplied as ’*’, you will be prompted to
enter the password when Conky starts.
1mmail_spool0m
Mail spool for mail checking
1mmax_port_monitor_connections0m
Allow each port monitor to track at most this many connections
(if 0 or not set, default is 256)
1mmax_specials0m
Maximum number of special things, e.g. fonts, offsets, aligns,
etc. (default is 512)
1mmax_user_text bytes0m
Maximum size of user text buffer, i.e. layout below TEXT line in
config file (default is 16384 bytes)
1mtext_buffer_size bytes0m
Size of the standard text buffer (default is 256 bytes). This
buffer is used for intermediary text, such as individual lines,
output from $exec vars, and various other variables. Increasing
the size of this buffer can drastically reduce Conky’s perfor‐
mance, but will allow for more text display per variable. The
size of this buffer cannot be smaller than the default value of
256 bytes.
1mmaximum_width pixels0m
Maximum width of window
1mminimum_size width (height)0m
Minimum size of window
1mmpd_host0m
Host of MPD server
1mmpd_port0m
Port of MPD server
1mmpd_password0m
MPD server password
1mmusic_player_interval0m
Music player thread update interval (defaults to Conky’s update
interval)
1mnet_avg_samples0m
The number of samples to average for net data
1mno_buffers0m
Substract (file system) buffers from used memory?
1moverride_utf8_locale0m
Force UTF8? requires XFT
1mown_window0m
Boolean, create own window to draw?
1mown_window_class0m
Manually set the WM_CLASS name. Defaults to "Conky".
1mown_window_colour colour0m
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)
1mown_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager0m
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.
1mown_window_title0m
Manually set the window name. Defaults to "<hostname> - conky".
1mown_window_transparent0m
Boolean, set pseudo-transparency?
1mown_window_type0m
if own_window is yes, you may specify type normal, desktop, dock
or override (default: normal). Desktop windows are special win‐
dows that have no window decorations; are always visible on your
desktop; do not appear in your pager or taskbar; and are sticky
across all workspaces. Override windows are not under the con‐
trol of the window manager. Hints are ignored. This type of win‐
dow can be useful for certain situations.
1mout_to_console0m
Print text to stdout.
1mpad_percents0m
Pad percentages to this many decimals (0 = no padding)
1mpop3 22mDefault global POP3 server. Arguments are: "host user pass [-i
interval] [-p port] [-e command] [-r retries]". Default port is
110, default interval is 5 minutes, and default number of re‐
tries before giving up is 5. If the password is supplied as ’*’,
you will be prompted to enter the password when Conky starts.
1mshort_units0m
Shortens units to a single character (kiB->k, GiB->G, etc.). De‐
fault is off.
1mshow_graph_scale0m
Shows the maximum value in scaled graphs.
1mshow_graph_range0m
Shows the time range covered by a graph.
1mstippled_borders0m
Border stippling (dashing) in pixels
1mtemplateN0m
Define a template for later use inside TEXT segments. Substitute
N by a digit between 0 and 9, inclusively. The value of the
variable is being inserted into the stuff below TEXT at the cor‐
responding position, but before some substitutions are applied:
’\n’ -> newline
’\\’ -> backslash
’\ ’ -> space
’\N’ -> template argument N
1mtotal_run_times0m
Total number of times for Conky to update before quitting. Zero
makes Conky run forever
1mupdate_interval0m
Update interval in seconds
1muppercase0m
Boolean value, if true, text is rendered in upper case
1muse_spacer0m
Adds spaces around certain objects to stop them from moving oth‐
er things around. Arguments are left, right, and none (default).
The old true/false values are deprecated and default to
right/none respectively. Note that this only helps if you are
using a mono font, such as Bitstream Vera Sans Mono.
1muse_xft0m
Use Xft (anti-aliased font and stuff)
1mxftalpha0m
Alpha of Xft font. Must be a value at or between 1 and 0.
1mxftfont0m
Xft font to use.
1mTEXT 22mAfter this begins text to be formatted on screen
1mVARIABLES0m
Colors are parsed using XParsecolor(), there might be a list of them:
/usr/share/X11/rgb.txt. Also, ⟨http://sedition.com/perl/rgb.html⟩.
Color can be also in #rrggbb format (hex).
1maddr interface0m
IP address for an interface, or "No Address" if no address is
assigned.
1maddrs interface0m
IP addresses for an interface (if one - works like addr). Linux
only.
1macpiacadapter0m
ACPI ac adapter state.
1macpifan0m
ACPI fan state
1macpitemp0m
ACPI temperature in C.
1macpitempf0m
ACPI temperature in F.
1madt746xcpu0m
CPU temperature from therm_adt746x
1madt746xfan0m
Fan speed from therm_adt746x
1malignr (num)0m
Right-justify text, with space of N
1malignc (num)0m
Align text to centre
1mapm_adapter0m
Display APM AC adapter status (FreeBSD only)
1mapm_battery_life0m
Display APM battery life in percent (FreeBSD only)
1mapm_battery_time0m
Display remaining APM battery life in hh:mm:ss or "unknown" if
AC adapterstatus is on-line or charging (FreeBSD only)
1maudacious_bar (height),(width)0m
Progress bar
1maudacious_bitrate0m
Bitrate of current tune
1maudacious_channels0m
Number of audio channels of current tune
1maudacious_filename0m
Full path and filename of current tune
1maudacious_frequency0m
Sampling frequency of current tune
1maudacious_length0m
Total length of current tune as MM:SS
1maudacious_length_seconds0m
Total length of current tune in seconds
1maudacious_playlist_position0m
Playlist position of current tune
1maudacious_playlist_length0m
Number of tunes in playlist
1maudacious_position0m
Position of current tune (MM:SS)
1maudacious_position_seconds0m
Position of current tune in seconds
1maudacious_status0m
Player status (Playing/Paused/Stopped/Not running)
1maudacious_title (max length)0m
Title of current tune with optional maximum length specifier
1mbattery (num)0m
Battery status and remaining percentage capacity of ACPI or APM
battery. ACPI battery number can be given as argument (default
is BAT0).
1mbattery_bar (height),(width) (num)0m
Battery percentage remaining of ACPI battery in a bar. ACPI bat‐
tery number can be given as argument (default is BAT0).
1mbattery_percent (num)0m
Battery percentage remaining for ACPI battery. ACPI battery num‐
ber can be given as argument (default is BAT0).
1mbattery_time (num)0m
Battery charge/discharge time remaining of ACPI battery. ACPI
battery number can be given as argument (default is BAT0).
1mbmpx_artist0m
Artist in current BMPx track
1mbmpx_album0m
Album in current BMPx track
1mbmpx_title0m
Title of the current BMPx track
1mbmpx_track0m
Track number of the current BMPx track
1mbmpx_bitrate0m
Bitrate of the current BMPx track
1mbmpx_uri0m
URI of the current BMPx track
1mbuffers0m
Amount of memory buffered
1mcached 22mAmount of memory cached
1mcolor (color)0m
Change drawing color to color
1mcolorN 22mChange drawing color to colorN configuration option, where N is
a digit between 0 and 9, inclusively.
1mconky_version0m
Conky version
1mconky_build_date0m
Date Conky was built
1mconky_build_arch0m
CPU architecture Conky was built for
1mcpu (cpuN)0m
CPU usage in percents. For SMP machines, the CPU number can be
provided as an argument. ${cpu cpu0} is the total usage, and
${cpu cpuX} (X >= 1) are individual CPUs.
1mcpubar (cpu number) (height),(width)0m
Bar that shows CPU usage, height is bar’s height in pixels. See
$cpu for more info on SMP.
1mcpugraph normal|log (cpu number) (height),(width) (gradient colour 1)0m
1m(gradient colour 2)0m
CPU usage graph, with optional colours in hex, minus the #. See
$cpu for more info on SMP. Uses a logarithmic scale (to see
small numbers) when you use "log" instead of "normal".
1mdiskio (device)0m
Displays current disk IO. Device is optional, and takes the form
of sda for /dev/sda. Individual partitions are allowed.
1mdiskiograph normal|log (device) (height),(width) (gradient colour 1)0m
1m(gradient colour 2) (scale)0m
Disk IO graph, colours defined in hex, minus the #. If scale is
non-zero, it becomes the scale for the graph. Uses a logarithmic
scale (to see small numbers) when you use "log" instead of "nor‐
mal".
1mdiskio_read (device)0m
Displays current disk IO for reads. Device as in diskio.
1mdiskiograph_read normal|log (device) (height),(width) (gradient colour0m
1m1) (gradient colour 2) (scale)0m
Disk IO graph for reads, colours defined in hex, minus the #. If
scale is non-zero, it becomes the scale for the graph. Device as
in diskio. Uses a logarithmic scale (to see small numbers) when
you use "log" instead of "normal".
1mdiskio_write (device)0m
Displays current disk IO for writes. Device as in diskio.
1mdiskiograph_write normal|log (device) (height),(width) (gradient colour0m
1m1) (gradient colour 2) (scale)0m
Disk IO graph for writes, colours defined in hex, minus the #.
If scale is non-zero, it becomes the scale for the graph. Device
as in diskio. Uses a logarithmic scale (to see small numbers)
when you use "log" instead of "normal".
1mdisk_protect device0m
Disk protection status, if supported (needs kernel-patch).
Prints either "frozen" or "free " (note the padding).
1mdownspeed net0m
Download speed in KiB
1mdownspeedf net0m
Download speed in KiB with one decimal
1mdownspeedgraph normal|log net (height),(width) (gradient colour 1)0m
1m(gradient colour 2) (scale)0m
Download speed graph, colours defined in hex, minus the #. If
scale is non-zero, it becomes the scale for the graph. Uses a
logarithmic scale (to see small numbers) when you use "log" in‐
stead of "normal".
1melse 22mText to show if any of the above are not true
1mentropy_avail0m
Current entropy available for crypto freaks
1mentropy_bar (height),(width)0m
Normalized bar of available entropy for crypto freaks
1mentropy_poolsize0m
Total size of system entropy pool for crypto freaks
1mexec command0m
Executes a shell command and displays the output in conky. warn‐
ing: this takes a lot more resources than other variables. I’d
recommend coding wanted behaviour in C and posting a patch.
1mexecbar command0m
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.
1mexecgraph (normal|log) command0m
Same as execbar, but graphs values. Uses a logaritmic scale when
the log option is given (to see small numbers). Values still
have to be between 0 and 100.
1mexeci interval command0m
Same as exec but with specific interval. Interval can’t be less
than update_interval in configuration. See also $texeci
1mexecibar interval command0m
Same as execbar, except with an interval
1mexecigraph interval command0m
Same as execgraph, but takes an interval arg graphs values
1mexecp command0m
Executes a shell command and displays the output in conky. warn‐
ing: this takes a lot more resources than other variables. I’d
recommend coding wanted behaviour in C and posting a patch. This
differs from $exec in that it parses the output of the command,
so you can insert things like ${color red}hi!${color} in your
script and have it correctly parsed by Conky. Caveats: Conky
parses and evaluates the output of $execp every time Conky
loops, and then destroys all the objects. If you try to use any‐
thing like $execi within an $execp statement, it will function‐
ally run at the same interval that the $execp statement runs, as
it is created and destroyed at every interval.
1mexecpi interval command0m
Same as execp but with specific interval. Interval can’t be less
than update_interval in configuration. Note that the output from
the $execpi command is still parsed and evaluated at every in‐
terval.
1mfont (font)0m
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)
1mfreq (n)0m
Returns CPU #n’s frequency in MHz. CPUs are counted from 1. If
omitted, the parameter defaults to 1.
1mfreq_g (n)0m
Returns CPU #n’s frequency in GHz. CPUs are counted from 1. If
omitted, the parameter defaults to 1.
1mfreq_dyn (n)0m
Returns CPU #n’s frequency in MHz (defaults to 1), but is calcu‐
lated by counting to clock cycles to complete an instruction.
Only available for x86/amd64.
1mfreq_dyn_g (n)0m
Returns CPU #n’s frequency in GHz (defaults to 1), but is calcu‐
lated by counting to clock cycles to complete an instruction.
Only available for x86/amd64.
1mfs_bar (height),(width) fs0m
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.
1mfs_free (fs)0m
Free space on a file system available for users.
1mfs_free_perc (fs)0m
Free percentage of space on a file system available for users.
1mfs_size (fs)0m
File system size
1mfs_type (fs)0m
File system type
1mfs_used (fs)0m
File system used space
1mgoto x 22mThe next element will be printed at position ’x’.
1mgw_iface0m
Displays the default route’s interface or "multiple"/"none" ac‐
cordingly.
1mgw_ip 22mDisplays the default gateway’s IP or "multiple"/"none" accord‐
ingly.
1mhddtemp dev, (host,(port))0m
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.
1mhead logfile lines (interval)0m
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.
1mhr (height)0m
Horizontal line, height is the height in pixels
1mhwmon (dev) type n0m
Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omit‐
ted if you have only one hwmon device. Parameter type is either
’in’ or ’vol’ meaning voltage; ’fan’ meaning fan; ’temp’ (Cel‐
sius) or ’tempf’ (Fahrenheit) meaning temperature. Parameter n
is number of the sensor. See /sys/class/hwmon/ on your local
computer.
1miconv_start codeset_from codeset_to0m
Convert text from one codeset to another using GNU iconv. Needs
to be stopped with iconv_stop.
1miconv_stop0m
Stop iconv codeset conversion.
1mi2c (dev) type n0m
I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted
if you have only one I2C device. Parameter type is either ’in’
or ’vol’ meaning voltage; ’fan’ meaning fan; ’temp’ (Celsius) or
’tempf’ (Fahrenheit) meaning temperature. Parameter n is number
of the sensor. See /sys/bus/i2c/devices/ on your local computer.
1mi8k_ac_status0m
If running the i8k kernel driver for Inspiron laptops, displays
whether ac power is on, as listed in /proc/i8k (translated to
human-readable). Beware that this is by default not enabled by
i8k itself.
1mi8k_bios0m
If running the i8k kernel driver for Inspiron laptops, displays
the bios version as listed in /proc/i8k.
1mi8k_buttons_status0m
If running the i8k kernel driver for Inspiron laptops, displays
the volume buttons status as listed in /proc/i8k.
1mi8k_cpu_temp0m
If running the i8k kernel driver for Inspiron laptops, displays
the cpu temperature in Celsius, as reported by /proc/i8k.
1mi8k_cpu_tempf0m
If running the i8k kernel driver for Inspiron laptops, displays
the cpu temperature in Fahrenheit, as reported by /proc/i8k.
1mi8k_left_fan_rpm0m
If running the i8k kernel driver for Inspiron laptops, displays
the left fan’s rate of rotation, in revolutions per minute as
listed in /proc/i8k. Beware, some laptops i8k reports these fans
in reverse order.
1mi8k_left_fan_status0m
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 re‐
verse order.
1mi8k_right_fan_rpm0m
If running the i8k kernel driver for Inspiron laptops, displays
the right fan’s rate of rotation, in revolutions per minute as
listed in /proc/i8k. Beware, some laptops i8k reports these fans
in reverse order.
1mi8k_right_fan_status0m
If running the i8k kernel driver for Inspiron laptops, displays
the right fan status as listed in /proc/i8k (translated to hu‐
man-readable). Beware, some laptops i8k reports these fans in
reverse order.
1mi8k_serial0m
If running the i8k kernel driver for Inspiron laptops, displays
your laptop serial number as listed in /proc/i8k.
1mi8k_version0m
If running the i8k kernel driver for Inspiron laptops, displays
the version formatting of /proc/i8k.
1mibm_fan0m
If running the IBM ACPI, displays the fan speed.
1mibm_temps N0m
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.
1mibm_volume0m
If running the IBM ACPI, displays the "master" volume, con‐
trolled by the volume keys (0-14).
1mibm_brightness0m
If running the IBM ACPI, displays the brigtness of the laptops’s
LCD (0-7).
1mif_empty (var)0m
if conky variable VAR is empty, display everything between
$if_empty and the matching $endif
1mif_gw 22mif there is at least one default gateway, display everything be‐
tween $if_gw and the matching $endif
1mif_running (process)0m
if PROCESS is running, display everything $if_running and the
matching $endif
1mif_existing file (string)0m
if FILE exists, display everything between if_existing and the
matching $endif. The optional second paramater checks for FILE
containing the specified string and prints everything between
$if_existing and the matching $endif.
1mif_mounted (mountpoint)0m
if MOUNTPOINT is mounted, display everything between $if_mounted
and the matching $endif
1mif_smapi_bat_installed (INDEX)0m
when using smapi, if the battery with index INDEX is installed,
display everything between $if_smapi_bat_installed and the
matching $endif
1mif_up (interface)0m
if INTERFACE exists and is up, display everything between $if_up
and the matching $endif
1mimap_messages (args)0m
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] [-r retries]". Default port
is 143, default interval is 5 minutes, and default number of re‐
tries before giving up is 5. If the password is supplied as ’*’,
you will be prompted to enter the password when Conky starts.
1mimap_unseen (args)0m
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] [-r retries]". Default port
is 143, default interval is 5 minutes, and default number of re‐
tries before giving up is 5. If the password is supplied as ’*’,
you will be prompted to enter the password when Conky starts.
1mioscheduler disk0m
Prints the current ioscheduler used for the given disk name
(i.e. e.g. "hda" or "sdb")
1mkernel 22mKernel version
1mlaptop_mode0m
The value of /proc/sys/vm/laptop_mode
1mloadavg0m
(1,2,3)> System load average, 1 is for past 1 minute, 2 for past
5 minutes and 3 for past 15 minutes.
1mloadgraph normal|log (height),(width) (gradient colour 1) (gradient0m
1mcolour 2)0m
Load1 average graph, similar to xload, with optional colours in
hex, minus the #. Uses a logarithmic scale (to see small num‐
bers) when you use "log" instead of "normal".
1mlines textfile0m
Displays the number of lines in the given file
1mmachine0m
Machine, i686 for example
1mmails (mailbox) (interval)0m
Mail count in the specified mailbox or your mail spool if not.
Both mbox and maildir type mailboxes are supported. You can use
a program like fetchmail to get mails from some server using
your favourite protocol. See also new_mails.
1mmboxscan (-n number of messages to print) (-fw from width) (-sw subject0m
1mwidth) mbox0m
Print a summary of recent messages in an mbox format mailbox.
mbox parameter is the filename of the mailbox (can be encapsu‐
lated using ’"’, ie. ${mboxscan -n 10 "/home/brenden/some box"}
1mmem 22mAmount of memory in use
1mmembar (height),(width)0m
Bar that shows amount of memory in use
1mmemgraph normal|log (height),(width) (gradient colour 1) (gradient0m
1mcolour 2)0m
Memory usage graph. Uses a logarithmic scale (to see small num‐
bers) when you use "log" instead of "normal".
1mmemeasyfree0m
Amount of free memory including the memory that is very easily
freed (buffers/cache)
1mmemfree0m
Amount of free memory
1mmemmax 22mTotal amount of memory
1mmemperc0m
Percentage of memory in use
1mmixer (device)0m
Prints the mixer value as reported by the OS. Default mixer is
"vol", but you can specify one of the following optional argu‐
ments: "vol", "bass", "treble", "synth", "pcm", "speaker",
"line", "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain",
"line1", "line2", "line3", "dig1", "dig2", "dig3", "phin",
"phout", "video", "radio", "monitor". Refer to the definition of
SOUND_DEVICE_NAMES in <linux/soundcard.h> (on Linux), <sound‐
card.h> (on OpenBSD), or <sys/soundcard.h> to find the exact op‐
tions available on your system.
1mmixerbar (device)0m
Displays mixer value in a bar as reported by the OS. See docs
for $mixer for details on arguments.
1mmixerr (device)0m
Prints the right channel mixer value as reported by the OS. See
docs for $mixer for details on arguments.
1mmixerrbar (device)0m
Displays the right channel mixer value in a bar as reported by
the OS. See docs for $mixer for details on arguments.
1mmixerl (device)0m
Prints the left channel mixer value as reported by the OS. See
docs for $mixer for details on arguments.
1mmixerlbar (device)0m
Displays the left channel mixer value in a bar as reported by
the OS. See docs for $mixer for details on arguments.
1mmoc_state0m
Current state of MOC; playing, stopped etc.
1mmoc_file0m
File name of the current MOC song
1mmoc_title0m
Title of the current MOC song
1mmoc_artist0m
Artist of the current MOC song
1mmoc_song0m
The current song name being played in MOC.
1mmoc_album0m
Album of the current MOC song
1mmoc_totaltime0m
Total length of the current MOC song
1mmoc_timeleft0m
Time left in the current MOC song
1mmoc_curtime0m
Current time of the current MOC song
1mmoc_bitrate0m
Bitrate in the current MOC song
1mmoc_rate0m
Rate of the current MOC song
1mmonitor0m
Number of the monitor on which conky is running
1mmonitor_number0m
Number of monitors
1mmpd_artist0m
Artist in current MPD song must be enabled at compile
1mmpd_album0m
Album in current MPD song
1mmpd_bar (height),(width)0m
Bar of mpd’s progress
1mmpd_bitrate0m
Bitrate of current song
1mmpd_status0m
Playing, stopped, et cetera.
1mmpd_title (max length)0m
Title of current MPD song
1mmpd_vol0m
MPD’s volume
1mmpd_elapsed0m
Song’s elapsed time
1mmpd_length0m
Song’s length
1mmpd_percent0m
Percent of song’s progress
1mmpd_random0m
Random status (On/Off)
1mmpd_repeat0m
Repeat status (On/Off)
1mmpd_track0m
Prints the MPD track field
1mmpd_name0m
Prints the MPD name field
1mmpd_file0m
Prints the file name of the current MPD song
1mmpd_smart (max length)0m
Prints the song name in either the form "artist - title" or file
name, depending on whats available
1mif_mpd_playing0m
if mpd is playing or paused, display everything between
$if_mpd_playing and the matching $endif
1mnameserver (index)0m
Print a nameserver from /etc/resolv.conf. Index starts at and
defaults to 0.
1mnew_mails (mailbox) (interval)0m
Unread mail count in the specified mailbox or mail spool if not.
Both mbox and maildir type mailboxes are supported.
1mnodename0m
Hostname
1mnvidia threshold temp gpufreq memfreq imagequality0m
Nvidia graficcard support for the XNVCtrl library. Each option
can be shortened to the least significant part. Temperatures
are printed as float, all other values as integer.
1mthreshold22m: the thresholdtemperature at which the gpu slows down
1mtemp22m: gives the gpu current temperature
1mgpufreq22m: gives the current gpu frequency
1mmemfreq22m: gives the current mem frequency
1mimagequality22m: which imagequality should be choosen by OpenGL ap‐
plications
1moutlinecolor (color)0m
Change outline color
1mpb_battery item0m
If running on Apple powerbook/ibook, display information on bat‐
tery status. The item parameter specifies, what information to
display. Exactly one item must be specified. Valid items are:
1mstatus22m: Display if battery is fully charged, charging, discharg‐
ing or absent (running on AC)
1mpercent22m: Display charge of battery in percent, if charging or
discharging. Nothing will be displayed, if battery is fully
charged or absent.
1mtime22m: 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
discharging.
1mplatform (dev) type n0m
Platform sensor from sysfs (Linux 2.6). Parameter dev may be
omitted if you have only one platform device. Platform type is
either ’in’ or ’vol’ meaning voltage; ’fan’ meaning fan; ’temp’
(Celsius) or ’tempf’ (Fahrenheit) meaning temperature. Parameter
n is number of the sensor. See /sys/bus/platform/devices/ on
your local computer.
1mpop3_unseen (args)0m
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] [-r retries]". Default port
is 110, default interval is 5 minutes, and default number of re‐
tries before giving up is 5. If the password is supplied as ’*’,
you will be prompted to enter the password when Conky starts.
1mpop3_used (args)0m
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] [-r re‐
tries]". Default port is 110, default interval is 5 minutes, and
default number of retries before giving up is 5. If the password
is supplied as ’*’, you will be prompted to enter the password
when Conky starts.
1mpre_exec shell command0m
Executes a shell command one time before conky displays anything
and puts output as text.
1mprocesses0m
Total processes (sleeping and running)
1mrunning_processes0m
Running processes (not sleeping), requires Linux 2.6
1mscroll length (step) text0m
Scroll ’text’ by ’step’ characters showing ’length’ number of
characters at the same time. The text may also contain vari‐
ables. ’step’ is optional and defaults to 1 if not set. If a var
creates output on multiple lines then the lines are placed be‐
hind each other separated with a ’|’-sign. Do NOT use vars that
change colors or otherwise affect the design inside a scrolling
text. If you want spaces between the start and the end of
’text’, place them at the end of ’text’ not at the front ("foo‐
bar" and " foobar" can both generate "barfoo" but "foobar " will
keep the spaces like this "bar foo").
1mshadecolor (color)0m
Change shading color
1msmapi (ARGS)0m
when using smapi, display contents of the /sys/devices/plat‐
form/smapi directory. ARGS are either ’(FILENAME)’ or ’bat (IN‐
DEX) (FILENAME)’ to display the corresponding files’ content.
This is a very raw method of accessing the smapi values. When
available, better use one of the smapi_* variables instead.
1msmapi_bat_bar (INDEX),(height),(width)0m
when using smapi, display the remaining capacity of the battery
with index INDEX as a bar.
1msmapi_bat_perc (INDEX)0m
when using smapi, display the remaining capacity in percent of
the battery with index INDEX. This is a separate variable be‐
cause it supports the ’use_spacer’ configuration option.
1msmapi_bat_power INDEX0m
when using smapi, display the current power of the battery with
index INDEX in watt. This is a separate variable because the
original read out value is being converted from mW. The sign of
the output reflects charging (positive) or discharging (nega‐
tive) state.
1msmapi_bat_temp INDEX0m
when using smapi, display the current temperature of the battery
with index INDEX in degree Celsius. This is a separate variable
because the original read out value is being converted from mil‐
li degree Celsius.
1mstippled_hr (space)0m
Stippled (dashed) horizontal line
1mswapbar (height),(width)0m
Bar that shows amount of swap in use
1mswap 22mAmount of swap in use
1mswapmax0m
Total amount of swap
1mswapperc0m
Percentage of swap in use
1msysname0m
System name, Linux for example
1mtcp_portmon port_begin port_end item (index) 4m22m(ip424m 4monly24m 4mat24m 4mpresent)0m
TCP port monitor for specified local ports. Port numbers must be
in the range 1 to 65535. Valid items are:
1mcount 22m- total number of connections in the range
1mrip 22m- remote ip address
1mrhost 22m- remote host name
1mrport 22m- remote port number
1mrservice 22m- remote service name from /etc/services
1mlip 22m- local ip address
1mlhost 22m- local host name
1mlport 22m- local port number
1mlservice 22m- 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 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:
1m${tcp_portmon 6881 6999 count} 22m- displays the number of connec‐
tions in the bittorrent port range
1m${tcp_portmon 22 22 rip 0} 22m- displays the remote host ip of the
first sshd connection
1m${tcp_portmon 22 22 rip 9} 22m- displays the remote host ip of the
tenth sshd connection
1m${tcp_portmon 1 1024 rhost 0} 22m- displays the remote host name of
the first connection on a privileged port
1m${tcp_portmon 1 1024 rport 4} 22m- displays the remote host port of
the fifth connection on a privileged port
1m${tcp_portmon 1 65535 lservice 14} 22m- 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
creating redundant monitors.
1mtexeci interval command0m
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.
1moffset (pixels)0m
Move text over by N pixels. See also $voffset.
1mrss url delay_in_minutes action item_num0m
Download and parse RSS feeds. Action may be one of the follow‐
ing: feed_title, item_title (with num par), item_desc (with num
par) and item_titles.
1mtab (width, (start))0m
Puts a tab of the specified width, starting from column ’start’.
1mtail logfile lines (interval)0m
Displays last 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.
1mtemplateN (arg1) (arg2) (arg3 ...)0m
Evaluate the content of the templateN configuration variable
(where N is a value between 0 and 9, inclusively), applying sub‐
stitutions as described in the documentation of the correspond‐
ing configuration variable. The number of arguments is option‐
al, but must match the highest referred index in the template.
You can use the same special sequences in each argument as the
ones valid for a template definition, e.g. to allow an argument
to contain a whitespace. Also simple nesting of templates is
possible this way.
Here are some examples of template definitions:
template0 $\1\2
template1 \1: ${fs_used \2} / ${fs_size \2}
template2 \1 \2
The following list shows sample usage of the templates defined
above, with the equivalent syntax when not using any template at
all:
using template same without template
─────────────────────────────────────────────────────────────────────────────────
${template0 node name} $nodename
${template1 root /} root: ${fs_free /} /
${fs_size /}
${template1 ${template2\ disk\ root} /} disk root: ${fs_free /} / ${fs_size /}
1mtime (format)0m
Local time, see man strftime to get more information about for‐
mat
1mutime (format)0m
Display time in UTC (universal coordinate time).
1mtztime (timezone) (format)0m
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.
1mtotaldown net0m
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.
1mtop type, num0m
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", "mem", "mem_res", "mem_vsize", and "time". There
can be a max of 10 processes listed.
1mtop_mem type, num0m
Same as top, except sorted by mem usage instead of cpu
1mtotalup net0m
Total upload, this one too, may overflow
1mupdates Number of updates0m
for debugging
1mupspeed net0m
Upload speed in KiB
1mupspeedf net0m
Upload speed in KiB with one decimal
1mupspeedgraph normal|log net (height),(width) (gradient colour 1) (gra‐0m
1mdient colour 2) (scale)0m
Upload speed graph, colours defined in hex, minus the #. If
scale is non-zero, it becomes the scale for the graph. Uses a
logarithmic scale (to see small numbers) when you use "log" in‐
stead of "normal".
1muptime 22mUptime
1muptime_short0m
Uptime in a shorter format
1muser_number0m
Number of users logged in
1muser_names0m
Lists the names of the users logged in
1muser_terms0m
Lists the consoles in use
1muser_times0m
Lists how long users have been logged in for
1mvoffset (pixels)0m
Change vertical offset by N pixels. Negative values will cause
text to overlap. See also $offset.
1mvoltage_mv (n)0m
Returns CPU #n’s voltage in mV. CPUs are counted from 1. If
omitted, the parameter defaults to 1.
1mvoltage_v (n)0m
Returns CPU #n’s voltage in V. CPUs are counted from 1. If omit‐
ted, the parameter defaults to 1.
1mwireless_essid net0m
Wireless access point ESSID (Linux only)
1mwireless_mode net0m
Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1mwireless_bitrate net0m
Wireless bitrate (ie 11 Mb/s) (Linux only)
1mwireless_ap net0m
Wireless access point MAC address (Linux only)
1mwireless_link_qual net0m
Wireless link quality (Linux only)
1mwireless_link_qual_max net0m
Wireless link quality maximum value (Linux only)
1mwireless_link_qual_perc net0m
Wireless link quality in percents (Linux only)
1mwireless_link_bar (height), (width) net0m
Wireless link quality bar (Linux only)
1mwords textfile0m
Displays the number of words in the given file
1mxmms2_artist0m
Artist in current XMMS2 song
1mxmms2_album0m
Album in current XMMS2 song
1mxmms2_title0m
Title in current XMMS2 song
1mxmms2_genre0m
Genre in current XMMS2 song
1mxmms2_comment0m
Comment in current XMMS2 song
1mxmms2_decoder0m
Decoder plugin used
1mxmms2_transport0m
Transport plugin used
1mxmms2_url0m
Full path to current song
1mxmms2_tracknr0m
Track number in current XMMS2 song
1mxmms2_bitrate0m
Bitrate of current song
1mxmms2_id0m
XMMS2 id of current song
1mxmms2_duration0m
Duration of current song
1mxmms2_elapsed0m
Song’s elapsed time
1mxmms2_size0m
Size of current song
1mxmms2_percent0m
Percent of song’s progress
1mxmms2_status0m
XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1mxmms2_bar (height),(width)0m
Bar of XMMS2’s progress
1mxmms2_smart0m
Prints the song name in either the form "artist - title" or file
name, depending on whats available
1meve api_userid api_key character_id0m
Fetches your currently training skill from the Eve Online API
servers (http://www.eve-online.com/) and displays the skill
along with the remaining training time.
1mEXAMPLES0m
conky 1m-t ’${time %D %H:%M}’ -o -u 300m
Start Conky in its own window with date and clock as text and 30
sec update interval.
conky 1m-a top_left -x 5 -y 500 -d0m
Start Conky to background at coordinates (5, 500).
1mFILES0m
4m~/.conkyrc24m default configuration file
1mBUGS0m
Drawing to root or some other desktop window directly doesn’t work with
all window managers. Especially doesn’t work well with Gnome and it has
been reported that it doesn’t work with KDE either. Nautilus can be
disabled from drawing to desktop with program gconf-editor. Uncheck
show_desktop in /apps/nautilus/preferences/. There is -w switch in
Conky to set some specific window id. You might find xwininfo -tree
useful to find the window to draw to. You can also use -o argument
which makes Conky to create its own window. If you do try running Conky
in its own window, be sure to read up on the own_window_type settings
and experiment.
1mSEE ALSO0m
⟨http://conky.sourceforge.net/⟩
⟨http://www.sourceforge.net/projects/conky⟩
#conky on irc.freenode.net
1mCOPYING0m
Copyright (c) 2005-2008 Brenden Matthews, Philip Kovacs, et. al. Any
original torsmo code is licensed under the BSD license (see LICENSE.BSD
for a copy). All code written since the fork of torsmo is licensed un‐
der the GPL (see LICENSE.GPL for a copy), except where noted different‐
ly (such as in portmon code, timed thread code, and audacious code
which are LGPL, and prss which is an MIT-style license).
1mAUTHORS0m
The Conky dev team (see AUTHORS for a full list of contributors).
2008-10-08 conky(1)
View Git Blame Copy Permalink