6 conky - A system monitor for X originally based on the torsmo code, but
7 more kickass. It just keeps on given’er. Yeah.
10 1mconky 22m[4moptions24m]
13 Conky is a system monitor for X originally based on torsmo. Since its
14 inception, Conky has changed significantly from its predecessor, while
15 maintaining simplicity and configurability. Conky can display just
16 about anything, either on your root desktop or in its own window. Not
17 only does Conky have many built-in objects, it can also display just
18 about any piece of information by using scripts and other external pro‐
21 Conky has more than 250 built in objects, including support for a
22 plethora of OS stats (uname, uptime, CPU usage, mem usage, disk usage,
23 "top" like process stats, and network monitoring, just to name a few),
24 built in IMAP and POP3 support, built in support for many popular music
25 players (MPD, XMMS2, BMPx, Audacious), and much much more. Conky can
26 display this info either as text, or using simple progress bars and
27 graph widgets, with different fonts and colours.
29 We are always looking for help, whether its reporting bugs, writing
30 patches, or writing docs. Please use the facilities at SourceForge to
31 make bug reports, feature requests, and submit patches, or stop by
32 #conky on irc.freenode.net if you have questions or want to contribute.
34 Thanks for your interest in Conky.
37 For users compiling from source on a binary distro, make sure you have
38 the X development libraries installed. This should be a package along
39 the lines of "libx11-dev" or "xorg-x11-dev" for X11 libs, and similar
40 "-dev" format for the other libs required (depending on your configure
43 Conky has (for some time) been available in the repositories of most
44 popular distributions. Here are some installation instructions for a
47 Gentoo users -- Conky is in Gentoo’s Portage... simply use "emerge app-
48 admin/conky" for installation. There is also usually an up-to-date
49 ebuild within Conky’s package or in SVN.
51 Debian, etc. users -- Conky should be in your repositories, and can be
52 installed by doing "aptitude install conky".
54 Example to compile and run Conky with all optional components (note
55 that some configure options may differ for your system):
57 1msh autogen.sh # Only required if building from SVN0m
59 1m./configure --prefix=/usr --mandir=/usr/share/man --in‐0m
60 1mfodir=/usr/share/info --datadir=/usr/share --sysconfdir=/etc --local‐0m
61 1mstatedir=/var/lib --disable-own-window --enable-audacious[=yes|no|lega‐0m
62 1mcy] --enable-bmpx --disable-hddtemp --disable-mpd --enable-xmms2 --dis‐0m
63 1mable-portmon --disable-network --enable-debug --disable-x11 --dis‐0m
64 1mable-double-buffer --disable-xdamage --disable-xft0m
68 1mmake install # Optional0m
72 Conky has been tested to be compatible with C99 C, however it has not
73 been tested with anything other than gcc, and is not guaranteed to work
78 Conky is generally very good on resources. That said, the more you try
79 to make Conky do, the more resources it is going to consume.
81 An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1
82 conky". Saves you the trouble of having to kill and then restart. You
83 can now also do the same with SIGHUP.
86 Command line options override configurations defined in configuration
89 1m-v | -V | --version0m
90 Prints version and exits
94 Run Conky in ’quiet mode’ (ie. no output)
97 1m-a | --alignment=ALIGNMENT0m
98 Text alignment on screen, {top,bottom,middle}_{left,right,mid‐
102 1m-b | --double-buffer0m
103 Use double buffering (eliminates "flicker")
106 1m-c | --config=FILE0m
107 Config file to load instead of $HOME/.conkyrc
111 Daemonize Conky, aka fork to background
119 Prints command line help and exits
122 1m-o | --own-window0m
123 Create own window to draw
127 Text to render, remember single quotes, like -t ’ $uptime ’
130 1m-u | --interval=SECONDS0m
134 1m-w | --window-id=WIN_ID0m
147 Number of times to update Conky (and quit)
150 1mCONFIGURATION SETTINGS0m
151 Default configuration file location is $HOME/.conkyrc or
152 ${sysconfdir}/conky/conky.conf. On most systems, sysconfdir is /etc,
153 and you can find the sample config file there (/etc/conky/conky.conf).
155 You might want to copy it to $HOME/.conkyrc and then start modifying
156 it. Other configs can be found at http://conky.sf.net/
159 Aligned position on screen, may be top_left, top_right, top_mid‐
160 dle, bottom_left, bottom_right, bottom_middle, middle_left, mid‐
161 dle_right, or none (also can be abreviated as tl, tr, tm, bl,
166 Boolean value, if true, Conky will be forked to background when
171 Border margin in pixels
175 Border width in pixels
178 1mcolorN 22mPredefine a color for use inside TEXT segments. Substitute N by
179 a digit between 0 and 9, inclusively. When specifying the color
180 value in hex, omit the leading hash (#).
184 The number of samples to average for CPU monitoring
188 If true, cpu in top will show usage of one processor’s power. If
189 false, cpu in top will show the usage of all processors’ power
194 Default color and border color
197 1mdefault_outline_color0m
198 Default outline color
201 1mdefault_shade_color0m
202 Default shading color and border’s shading color
206 Use the Xdbe extension? (eliminates flicker) It is highly recom‐
207 mended to use own window with this one so double buffer won’t be
212 Draw borders around text?
215 1mdraw_graph_borders0m
216 Draw borders around graphs?
227 1mfont 22mFont name in X, xfontsel can be used to get a nice font
230 1mgap_x 22mGap, in pixels, between right or left border of screen, same as
231 passing -x at command line, e.g. gap_x 10
234 1mgap_y 22mGap, in pixels, between top or bottom border of screen, same as
235 passing -y at command line, e.g. gap_y 10.
239 How strict should if_up be when testing an interface for being
240 up? The value is one of up, link or address, to check for the
241 interface being solely up, being up and having link or being up,
242 having link and an assigned IP address.
245 1mimap 22mDefault global IMAP server. Arguments are: "host user pass [-i
246 interval] [-f folder] [-p port] [-e command] [-r retries]". De‐
247 fault port is 143, default folder is ’INBOX’, default interval
248 is 5 minutes, and default number of retries before giving up is
249 5. If the password is supplied as ’*’, you will be prompted to
250 enter the password when Conky starts.
254 Mail spool for mail checking
257 1mmax_port_monitor_connections0m
258 Allow each port monitor to track at most this many connections
259 (if 0 or not set, default is 256)
263 Maximum number of special things, e.g. fonts, offsets, aligns,
264 etc. (default is 512)
267 1mmax_user_text bytes0m
268 Maximum size of user text buffer, i.e. layout below TEXT line in
269 config file (default is 16384 bytes)
272 1mtext_buffer_size bytes0m
273 Size of the standard text buffer (default is 256 bytes). This
274 buffer is used for intermediary text, such as individual lines,
275 output from $exec vars, and various other variables. Increasing
276 the size of this buffer can drastically reduce Conky’s perfor‐
277 mance, but will allow for more text display per variable. The
278 size of this buffer cannot be smaller than the default value of
282 1mmaximum_width pixels0m
283 Maximum width of window
286 1mminimum_size width (height)0m
287 Minimum size of window
302 1mmusic_player_interval0m
303 Music player thread update interval (defaults to Conky’s update
308 The number of samples to average for net data
312 Substract (file system) buffers from used memory?
315 1moverride_utf8_locale0m
316 Force UTF8? requires XFT
320 Boolean, create own window to draw?
324 Manually set the WM_CLASS name. Defaults to "Conky".
327 1mown_window_colour colour0m
328 If own_window_transparent no, set a specified background colour
329 (defaults to black). Takes either a hex value (#ffffff) or a
330 valid RGB name (see /usr/lib/X11/rgb.txt)
333 1mown_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager0m
334 If own_window is yes, you may use these window manager hints to
335 affect the way Conky displays. Notes: Use own_window_type desk‐
336 top as another way to implement many of these hints implicitly.
337 If you use own_window_type override, window manager hints have
338 no meaning and are ignored.
342 Manually set the window name. Defaults to "<hostname> - conky".
345 1mown_window_transparent0m
346 Boolean, set pseudo-transparency?
350 if own_window is yes, you may specify type normal, desktop, dock
351 or override (default: normal). Desktop windows are special win‐
352 dows that have no window decorations; are always visible on your
353 desktop; do not appear in your pager or taskbar; and are sticky
354 across all workspaces. Override windows are not under the con‐
355 trol of the window manager. Hints are ignored. This type of win‐
356 dow can be useful for certain situations.
360 Print text to stdout.
364 Pad percentages to this many decimals (0 = no padding)
367 1mpop3 22mDefault global POP3 server. Arguments are: "host user pass [-i
368 interval] [-p port] [-e command] [-r retries]". Default port is
369 110, default interval is 5 minutes, and default number of re‐
370 tries before giving up is 5. If the password is supplied as ’*’,
371 you will be prompted to enter the password when Conky starts.
375 Shortens units to a single character (kiB->k, GiB->G, etc.). De‐
380 Shows the maximum value in scaled graphs.
384 Shows the time range covered by a graph.
388 Border stippling (dashing) in pixels
392 Define a template for later use inside TEXT segments. Substitute
393 N by a digit between 0 and 9, inclusively. The value of the
394 variable is being inserted into the stuff below TEXT at the cor‐
395 responding position, but before some substitutions are applied:
400 ’\N’ -> template argument N
404 Total number of times for Conky to update before quitting. Zero
405 makes Conky run forever
409 Update interval in seconds
413 Boolean value, if true, text is rendered in upper case
417 Adds spaces around certain objects to stop them from moving oth‐
418 er things around. Arguments are left, right, and none (default).
419 The old true/false values are deprecated and default to
420 right/none respectively. Note that this only helps if you are
421 using a mono font, such as Bitstream Vera Sans Mono.
425 Use Xft (anti-aliased font and stuff)
429 Alpha of Xft font. Must be a value at or between 1 and 0.
436 1mTEXT 22mAfter this begins text to be formatted on screen
440 Colors are parsed using XParsecolor(), there might be a list of them:
441 /usr/share/X11/rgb.txt. Also, ⟨http://sedition.com/perl/rgb.html⟩.
442 Color can be also in #rrggbb format (hex).
445 IP address for an interface, or "No Address" if no address is
450 IP addresses for an interface (if one - works like addr). Linux
455 ACPI ac adapter state.
463 ACPI temperature in C.
467 ACPI temperature in F.
471 CPU temperature from therm_adt746x
475 Fan speed from therm_adt746x
479 Right-justify text, with space of N
487 Display APM AC adapter status (FreeBSD only)
491 Display APM battery life in percent (FreeBSD only)
495 Display remaining APM battery life in hh:mm:ss or "unknown" if
496 AC adapterstatus is on-line or charging (FreeBSD only)
499 1maudacious_bar (height),(width)0m
503 1maudacious_bitrate0m
504 Bitrate of current tune
507 1maudacious_channels0m
508 Number of audio channels of current tune
511 1maudacious_filename0m
512 Full path and filename of current tune
515 1maudacious_frequency0m
516 Sampling frequency of current tune
520 Total length of current tune as MM:SS
523 1maudacious_length_seconds0m
524 Total length of current tune in seconds
527 1maudacious_playlist_position0m
528 Playlist position of current tune
531 1maudacious_playlist_length0m
532 Number of tunes in playlist
535 1maudacious_position0m
536 Position of current tune (MM:SS)
539 1maudacious_position_seconds0m
540 Position of current tune in seconds
544 Player status (Playing/Paused/Stopped/Not running)
547 1maudacious_title (max length)0m
548 Title of current tune with optional maximum length specifier
551 1maudacious_main_volume0m
552 The current volume fetched from Audacious
556 Battery status and remaining percentage capacity of ACPI or APM
557 battery. ACPI battery number can be given as argument (default
561 1mbattery_bar (height),(width) (num)0m
562 Battery percentage remaining of ACPI battery in a bar. ACPI bat‐
563 tery number can be given as argument (default is BAT0).
566 1mbattery_percent (num)0m
567 Battery percentage remaining for ACPI battery. ACPI battery num‐
568 ber can be given as argument (default is BAT0).
571 1mbattery_time (num)0m
572 Battery charge/discharge time remaining of ACPI battery. ACPI
573 battery number can be given as argument (default is BAT0).
577 Artist in current BMPx track
581 Album in current BMPx track
585 Title of the current BMPx track
589 Track number of the current BMPx track
593 Bitrate of the current BMPx track
597 URI of the current BMPx track
601 Amount of memory buffered
604 1mcached 22mAmount of memory cached
608 Change drawing color to color
611 1mcolorN 22mChange drawing color to colorN configuration option, where N is
612 a digit between 0 and 9, inclusively.
624 CPU architecture Conky was built for
628 CPU usage in percents. For SMP machines, the CPU number can be
629 provided as an argument. ${cpu cpu0} is the total usage, and
630 ${cpu cpuX} (X >= 1) are individual CPUs.
633 1mcpubar (cpu number) (height),(width)0m
634 Bar that shows CPU usage, height is bar’s height in pixels. See
635 $cpu for more info on SMP.
638 1mcpugraph normal|log (cpu number) (height),(width) (gradient colour 1)0m
639 1m(gradient colour 2)0m
640 CPU usage graph, with optional colours in hex, minus the #. See
641 $cpu for more info on SMP. Uses a logarithmic scale (to see
642 small numbers) when you use "log" instead of "normal".
646 Displays current disk IO. Device is optional, and takes the form
647 of sda for /dev/sda. Individual partitions are allowed.
650 1mdiskiograph normal|log (device) (height),(width) (gradient colour 1)0m
651 1m(gradient colour 2) (scale)0m
652 Disk IO graph, colours defined in hex, minus the #. If scale is
653 non-zero, it becomes the scale for the graph. Uses a logarithmic
654 scale (to see small numbers) when you use "log" instead of "nor‐
658 1mdiskio_read (device)0m
659 Displays current disk IO for reads. Device as in diskio.
662 1mdiskiograph_read normal|log (device) (height),(width) (gradient colour0m
663 1m1) (gradient colour 2) (scale)0m
664 Disk IO graph for reads, colours defined in hex, minus the #. If
665 scale is non-zero, it becomes the scale for the graph. Device as
666 in diskio. Uses a logarithmic scale (to see small numbers) when
667 you use "log" instead of "normal".
670 1mdiskio_write (device)0m
671 Displays current disk IO for writes. Device as in diskio.
674 1mdiskiograph_write normal|log (device) (height),(width) (gradient colour0m
675 1m1) (gradient colour 2) (scale)0m
676 Disk IO graph for writes, colours defined in hex, minus the #.
677 If scale is non-zero, it becomes the scale for the graph. Device
678 as in diskio. Uses a logarithmic scale (to see small numbers)
679 when you use "log" instead of "normal".
682 1mdisk_protect device0m
683 Disk protection status, if supported (needs kernel-patch).
684 Prints either "frozen" or "free " (note the padding).
688 Download speed in KiB
692 Download speed in KiB with one decimal
695 1mdownspeedgraph normal|log net (height),(width) (gradient colour 1)0m
696 1m(gradient colour 2) (scale)0m
697 Download speed graph, colours defined in hex, minus the #. If
698 scale is non-zero, it becomes the scale for the graph. Uses a
699 logarithmic scale (to see small numbers) when you use "log" in‐
703 1melse 22mText to show if any of the above are not true
707 Current entropy available for crypto freaks
710 1mentropy_bar (height),(width)0m
711 Normalized bar of available entropy for crypto freaks
715 Total size of system entropy pool for crypto freaks
719 Executes a shell command and displays the output in conky. warn‐
720 ing: this takes a lot more resources than other variables. I’d
721 recommend coding wanted behaviour in C and posting a patch.
725 Same as exec, except if the first value return is a value be‐
726 tween 0-100, it will use that number for a bar. The size for the
727 bar is currently fixed, but that may change in the future.
730 1mexecgraph (normal|log) command0m
731 Same as execbar, but graphs values. Uses a logaritmic scale when
732 the log option is given (to see small numbers). Values still
733 have to be between 0 and 100.
736 1mexeci interval command0m
737 Same as exec but with specific interval. Interval can’t be less
738 than update_interval in configuration. See also $texeci
741 1mexecibar interval command0m
742 Same as execbar, except with an interval
745 1mexecigraph interval command0m
746 Same as execgraph, but takes an interval arg graphs values
750 Executes a shell command and displays the output in conky. warn‐
751 ing: this takes a lot more resources than other variables. I’d
752 recommend coding wanted behaviour in C and posting a patch. This
753 differs from $exec in that it parses the output of the command,
754 so you can insert things like ${color red}hi!${color} in your
755 script and have it correctly parsed by Conky. Caveats: Conky
756 parses and evaluates the output of $execp every time Conky
757 loops, and then destroys all the objects. If you try to use any‐
758 thing like $execi within an $execp statement, it will function‐
759 ally run at the same interval that the $execp statement runs, as
760 it is created and destroyed at every interval.
763 1mexecpi interval command0m
764 Same as execp but with specific interval. Interval can’t be less
765 than update_interval in configuration. Note that the output from
766 the $execpi command is still parsed and evaluated at every in‐
771 Specify a different font. This new font will apply to the cur‐
772 rent line and everything following. You can use a $font with no
773 arguments to change back to the default font (much like with
778 Returns CPU #n’s frequency in MHz. CPUs are counted from 1. If
779 omitted, the parameter defaults to 1.
783 Returns CPU #n’s frequency in GHz. CPUs are counted from 1. If
784 omitted, the parameter defaults to 1.
788 Returns CPU #n’s frequency in MHz (defaults to 1), but is calcu‐
789 lated by counting to clock cycles to complete an instruction.
790 Only available for x86/amd64.
794 Returns CPU #n’s frequency in GHz (defaults to 1), but is calcu‐
795 lated by counting to clock cycles to complete an instruction.
796 Only available for x86/amd64.
799 1mfs_bar (height),(width) fs0m
800 Bar that shows how much space is used on a file system. height
801 is the height in pixels. fs is any file on that file system.
805 Free space on a file system available for users.
808 1mfs_free_perc (fs)0m
809 Free percentage of space on a file system available for users.
821 File system used space
824 1mgoto x 22mThe next element will be printed at position ’x’.
828 Displays the default route’s interface or "multiple"/"none" ac‐
832 1mgw_ip 22mDisplays the default gateway’s IP or "multiple"/"none" accord‐
836 1mhddtemp dev, (host,(port))0m
837 Displays temperature of a selected hard disk drive as reported
838 by the hddtemp daemon running on host:port. Default host is
839 127.0.0.1, default port is 7634.
842 1mhead logfile lines (interval)0m
843 Displays first N lines of supplied text text file. If interval
844 is not supplied, Conky assumes 2x Conky’s interval. Max of 30
845 lines can be displayed, or until the text buffer is filled.
849 Horizontal line, height is the height in pixels
852 1mhwmon (dev) type n0m
853 Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omit‐
854 ted if you have only one hwmon device. Parameter type is either
855 ’in’ or ’vol’ meaning voltage; ’fan’ meaning fan; ’temp’ (Cel‐
856 sius) or ’tempf’ (Fahrenheit) meaning temperature. Parameter n
857 is number of the sensor. See /sys/class/hwmon/ on your local
861 1miconv_start codeset_from codeset_to0m
862 Convert text from one codeset to another using GNU iconv. Needs
863 to be stopped with iconv_stop.
867 Stop iconv codeset conversion.
871 I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted
872 if you have only one I2C device. Parameter type is either ’in’
873 or ’vol’ meaning voltage; ’fan’ meaning fan; ’temp’ (Celsius) or
874 ’tempf’ (Fahrenheit) meaning temperature. Parameter n is number
875 of the sensor. See /sys/bus/i2c/devices/ on your local computer.
879 If running the i8k kernel driver for Inspiron laptops, displays
880 whether ac power is on, as listed in /proc/i8k (translated to
881 human-readable). Beware that this is by default not enabled by
886 If running the i8k kernel driver for Inspiron laptops, displays
887 the bios version as listed in /proc/i8k.
890 1mi8k_buttons_status0m
891 If running the i8k kernel driver for Inspiron laptops, displays
892 the volume buttons status as listed in /proc/i8k.
896 If running the i8k kernel driver for Inspiron laptops, displays
897 the cpu temperature in Celsius, as reported by /proc/i8k.
901 If running the i8k kernel driver for Inspiron laptops, displays
902 the cpu temperature in Fahrenheit, as reported by /proc/i8k.
906 If running the i8k kernel driver for Inspiron laptops, displays
907 the left fan’s rate of rotation, in revolutions per minute as
908 listed in /proc/i8k. Beware, some laptops i8k reports these fans
912 1mi8k_left_fan_status0m
913 If running the i8k kernel driver for Inspiron laptops, displays
914 the left fan status as listed in /proc/i8k (translated to human-
915 readable). Beware, some laptops i8k reports these fans in re‐
919 1mi8k_right_fan_rpm0m
920 If running the i8k kernel driver for Inspiron laptops, displays
921 the right fan’s rate of rotation, in revolutions per minute as
922 listed in /proc/i8k. Beware, some laptops i8k reports these fans
926 1mi8k_right_fan_status0m
927 If running the i8k kernel driver for Inspiron laptops, displays
928 the right fan status as listed in /proc/i8k (translated to hu‐
929 man-readable). Beware, some laptops i8k reports these fans in
934 If running the i8k kernel driver for Inspiron laptops, displays
935 your laptop serial number as listed in /proc/i8k.
939 If running the i8k kernel driver for Inspiron laptops, displays
940 the version formatting of /proc/i8k.
944 If running the IBM ACPI, displays the fan speed.
948 If running the IBM ACPI, displays the temperatures from the IBM
949 temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
954 If running the IBM ACPI, displays the "master" volume, con‐
955 trolled by the volume keys (0-14).
959 If running the IBM ACPI, displays the brigtness of the laptops’s
964 if conky variable VAR is empty, display everything between
965 $if_empty and the matching $endif
968 1mif_gw 22mif there is at least one default gateway, display everything be‐
969 tween $if_gw and the matching $endif
972 1mif_running (process)0m
973 if PROCESS is running, display everything $if_running and the
977 1mif_existing file (string)0m
978 if FILE exists, display everything between if_existing and the
979 matching $endif. The optional second paramater checks for FILE
980 containing the specified string and prints everything between
981 $if_existing and the matching $endif.
984 1mif_mounted (mountpoint)0m
985 if MOUNTPOINT is mounted, display everything between $if_mounted
986 and the matching $endif
989 1mif_smapi_bat_installed (INDEX)0m
990 when using smapi, if the battery with index INDEX is installed,
991 display everything between $if_smapi_bat_installed and the
995 1mif_up (interface)0m
996 if INTERFACE exists and is up, display everything between $if_up
997 and the matching $endif
1000 1mimap_messages (args)0m
1001 Displays the number of messages in your global IMAP inbox by de‐
1002 fault. You can define individual IMAP inboxes seperately by
1003 passing arguments to this object. Arguments are: "host user pass
1004 [-i interval] [-p port] [-e command] [-r retries]". Default port
1005 is 143, default interval is 5 minutes, and default number of re‐
1006 tries before giving up is 5. If the password is supplied as ’*’,
1007 you will be prompted to enter the password when Conky starts.
1010 1mimap_unseen (args)0m
1011 Displays the number of unseen messages in your global IMAP inbox
1012 by default. You can define individual IMAP inboxes seperately by
1013 passing arguments to this object. Arguments are: "host user pass
1014 [-i interval] [-p port] [-e command] [-r retries]". Default port
1015 is 143, default interval is 5 minutes, and default number of re‐
1016 tries before giving up is 5. If the password is supplied as ’*’,
1017 you will be prompted to enter the password when Conky starts.
1020 1mioscheduler disk0m
1021 Prints the current ioscheduler used for the given disk name
1022 (i.e. e.g. "hda" or "sdb")
1025 1mkernel 22mKernel version
1029 The value of /proc/sys/vm/laptop_mode
1033 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
1034 5 minutes and 3 for past 15 minutes.
1037 1mloadgraph normal|log (height),(width) (gradient colour 1) (gradient0m
1039 Load1 average graph, similar to xload, with optional colours in
1040 hex, minus the #. Uses a logarithmic scale (to see small num‐
1041 bers) when you use "log" instead of "normal".
1045 Displays the number of lines in the given file
1049 Machine, i686 for example
1052 1mmails (mailbox) (interval)0m
1053 Mail count in the specified mailbox or your mail spool if not.
1054 Both mbox and maildir type mailboxes are supported. You can use
1055 a program like fetchmail to get mails from some server using
1056 your favourite protocol. See also new_mails.
1059 1mmboxscan (-n number of messages to print) (-fw from width) (-sw subject0m
1061 Print a summary of recent messages in an mbox format mailbox.
1062 mbox parameter is the filename of the mailbox (can be encapsu‐
1063 lated using ’"’, ie. ${mboxscan -n 10 "/home/brenden/some box"}
1066 1mmem 22mAmount of memory in use
1069 1mmembar (height),(width)0m
1070 Bar that shows amount of memory in use
1073 1mmemgraph normal|log (height),(width) (gradient colour 1) (gradient0m
1075 Memory usage graph. Uses a logarithmic scale (to see small num‐
1076 bers) when you use "log" instead of "normal".
1080 Amount of free memory including the memory that is very easily
1081 freed (buffers/cache)
1085 Amount of free memory
1088 1mmemmax 22mTotal amount of memory
1092 Percentage of memory in use
1096 Prints the mixer value as reported by the OS. Default mixer is
1097 "vol", but you can specify one of the following optional argu‐
1098 ments: "vol", "bass", "treble", "synth", "pcm", "speaker",
1099 "line", "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain",
1100 "line1", "line2", "line3", "dig1", "dig2", "dig3", "phin",
1101 "phout", "video", "radio", "monitor". Refer to the definition of
1102 SOUND_DEVICE_NAMES in <linux/soundcard.h> (on Linux), <sound‐
1103 card.h> (on OpenBSD), or <sys/soundcard.h> to find the exact op‐
1104 tions available on your system.
1107 1mmixerbar (device)0m
1108 Displays mixer value in a bar as reported by the OS. See docs
1109 for $mixer for details on arguments.
1113 Prints the right channel mixer value as reported by the OS. See
1114 docs for $mixer for details on arguments.
1117 1mmixerrbar (device)0m
1118 Displays the right channel mixer value in a bar as reported by
1119 the OS. See docs for $mixer for details on arguments.
1123 Prints the left channel mixer value as reported by the OS. See
1124 docs for $mixer for details on arguments.
1127 1mmixerlbar (device)0m
1128 Displays the left channel mixer value in a bar as reported by
1129 the OS. See docs for $mixer for details on arguments.
1133 Current state of MOC; playing, stopped etc.
1137 File name of the current MOC song
1141 Title of the current MOC song
1145 Artist of the current MOC song
1149 The current song name being played in MOC.
1153 Album of the current MOC song
1157 Total length of the current MOC song
1161 Time left in the current MOC song
1165 Current time of the current MOC song
1169 Bitrate in the current MOC song
1173 Rate of the current MOC song
1177 Number of the monitor on which conky is running
1185 Artist in current MPD song must be enabled at compile
1189 Album in current MPD song
1192 1mmpd_bar (height),(width)0m
1193 Bar of mpd’s progress
1197 Bitrate of current song
1201 Playing, stopped, et cetera.
1204 1mmpd_title (max length)0m
1205 Title of current MPD song
1221 Percent of song’s progress
1225 Random status (On/Off)
1229 Repeat status (On/Off)
1233 Prints the MPD track field
1237 Prints the MPD name field
1241 Prints the file name of the current MPD song
1244 1mmpd_smart (max length)0m
1245 Prints the song name in either the form "artist - title" or file
1246 name, depending on whats available
1250 if mpd is playing or paused, display everything between
1251 $if_mpd_playing and the matching $endif
1254 1mnameserver (index)0m
1255 Print a nameserver from /etc/resolv.conf. Index starts at and
1259 1mnew_mails (mailbox) (interval)0m
1260 Unread mail count in the specified mailbox or mail spool if not.
1261 Both mbox and maildir type mailboxes are supported.
1268 1mnvidia threshold temp gpufreq memfreq imagequality0m
1269 Nvidia graficcard support for the XNVCtrl library. Each option
1270 can be shortened to the least significant part. Temperatures
1271 are printed as float, all other values as integer.
1273 1mthreshold22m: the thresholdtemperature at which the gpu slows down
1274 1mtemp22m: gives the gpu current temperature
1275 1mgpufreq22m: gives the current gpu frequency
1276 1mmemfreq22m: gives the current mem frequency
1277 1mimagequality22m: which imagequality should be choosen by OpenGL ap‐
1281 1moutlinecolor (color)0m
1282 Change outline color
1286 If running on Apple powerbook/ibook, display information on bat‐
1287 tery status. The item parameter specifies, what information to
1288 display. Exactly one item must be specified. Valid items are:
1290 1mstatus22m: Display if battery is fully charged, charging, discharg‐
1291 ing or absent (running on AC)
1292 1mpercent22m: Display charge of battery in percent, if charging or
1293 discharging. Nothing will be displayed, if battery is fully
1295 1mtime22m: Display the time remaining until the battery will be fully
1296 charged or discharged at current rate. Nothing is displayed, if
1297 battery is absent or if it’s present but fully charged and not
1301 1mplatform (dev) type n0m
1302 Platform sensor from sysfs (Linux 2.6). Parameter dev may be
1303 omitted if you have only one platform device. Platform type is
1304 either ’in’ or ’vol’ meaning voltage; ’fan’ meaning fan; ’temp’
1305 (Celsius) or ’tempf’ (Fahrenheit) meaning temperature. Parameter
1306 n is number of the sensor. See /sys/bus/platform/devices/ on
1307 your local computer.
1310 1mpop3_unseen (args)0m
1311 Displays the number of unseen messages in your global POP3 inbox
1312 by default. You can define individual POP3 inboxes seperately by
1313 passing arguments to this object. Arguments are: "host user pass
1314 [-i interval] [-p port] [-e command] [-r retries]". Default port
1315 is 110, default interval is 5 minutes, and default number of re‐
1316 tries before giving up is 5. If the password is supplied as ’*’,
1317 you will be prompted to enter the password when Conky starts.
1320 1mpop3_used (args)0m
1321 Displays the amount of space (in MiB, 2^20) used in your global
1322 POP3 inbox by default. You can define individual POP3 inboxes
1323 seperately by passing arguments to this object. Arguments are:
1324 "host user pass [-i interval] [-p port] [-e command] [-r re‐
1325 tries]". Default port is 110, default interval is 5 minutes, and
1326 default number of retries before giving up is 5. If the password
1327 is supplied as ’*’, you will be prompted to enter the password
1331 1mpre_exec shell command0m
1332 Executes a shell command one time before conky displays anything
1333 and puts output as text.
1337 Total processes (sleeping and running)
1340 1mrunning_processes0m
1341 Running processes (not sleeping), requires Linux 2.6
1344 1mscroll length (step) text0m
1345 Scroll ’text’ by ’step’ characters showing ’length’ number of
1346 characters at the same time. The text may also contain vari‐
1347 ables. ’step’ is optional and defaults to 1 if not set. If a var
1348 creates output on multiple lines then the lines are placed be‐
1349 hind each other separated with a ’|’-sign. Do NOT use vars that
1350 change colors or otherwise affect the design inside a scrolling
1351 text. If you want spaces between the start and the end of
1352 ’text’, place them at the end of ’text’ not at the front ("foo‐
1353 bar" and " foobar" can both generate "barfoo" but "foobar " will
1354 keep the spaces like this "bar foo").
1357 1mshadecolor (color)0m
1358 Change shading color
1362 when using smapi, display contents of the /sys/devices/plat‐
1363 form/smapi directory. ARGS are either ’(FILENAME)’ or ’bat (IN‐
1364 DEX) (FILENAME)’ to display the corresponding files’ content.
1365 This is a very raw method of accessing the smapi values. When
1366 available, better use one of the smapi_* variables instead.
1369 1msmapi_bat_bar (INDEX),(height),(width)0m
1370 when using smapi, display the remaining capacity of the battery
1371 with index INDEX as a bar.
1374 1msmapi_bat_perc (INDEX)0m
1375 when using smapi, display the remaining capacity in percent of
1376 the battery with index INDEX. This is a separate variable be‐
1377 cause it supports the ’use_spacer’ configuration option.
1380 1msmapi_bat_power INDEX0m
1381 when using smapi, display the current power of the battery with
1382 index INDEX in watt. This is a separate variable because the
1383 original read out value is being converted from mW. The sign of
1384 the output reflects charging (positive) or discharging (nega‐
1388 1msmapi_bat_temp INDEX0m
1389 when using smapi, display the current temperature of the battery
1390 with index INDEX in degree Celsius. This is a separate variable
1391 because the original read out value is being converted from mil‐
1395 1mstippled_hr (space)0m
1396 Stippled (dashed) horizontal line
1399 1mswapbar (height),(width)0m
1400 Bar that shows amount of swap in use
1403 1mswap 22mAmount of swap in use
1407 Total amount of swap
1411 Percentage of swap in use
1415 System name, Linux for example
1418 1mtcp_portmon port_begin port_end item (index) 4m22m(ip424m 4monly24m 4mat24m 4mpresent)0m
1419 TCP port monitor for specified local ports. Port numbers must be
1420 in the range 1 to 65535. Valid items are:
1422 1mcount 22m- total number of connections in the range
1423 1mrip 22m- remote ip address
1424 1mrhost 22m- remote host name
1425 1mrport 22m- remote port number
1426 1mrservice 22m- remote service name from /etc/services
1427 1mlip 22m- local ip address
1428 1mlhost 22m- local host name
1429 1mlport 22m- local port number
1430 1mlservice 22m- local service name from /etc/services
1432 The connection index provides you with access to each connection
1433 in the port monitor. The monitor will return information for in‐
1434 dex values from 0 to n-1 connections. Values higher than n-1 are
1435 simply ignored. For the "count" item, the connection index must
1436 be omitted. It is required for all other items.
1439 1m${tcp_portmon 6881 6999 count} 22m- displays the number of connec‐
1440 tions in the bittorrent port range
1441 1m${tcp_portmon 22 22 rip 0} 22m- displays the remote host ip of the
1442 first sshd connection
1443 1m${tcp_portmon 22 22 rip 9} 22m- displays the remote host ip of the
1444 tenth sshd connection
1445 1m${tcp_portmon 1 1024 rhost 0} 22m- displays the remote host name of
1446 the first connection on a privileged port
1447 1m${tcp_portmon 1 1024 rport 4} 22m- displays the remote host port of
1448 the fifth connection on a privileged port
1449 1m${tcp_portmon 1 65535 lservice 14} 22m- displays the local service
1450 name of the fifteenth connection in the range of all ports
1452 Note that port monitor variables which share the same port range
1453 actually refer to the same monitor, so many references to a sin‐
1454 gle port range for different items and different indexes all use
1455 the same monitor internally. In other words, the program avoids
1456 creating redundant monitors.
1458 1mtexeci interval command0m
1459 Runs a command at an interval inside a thread and displays the
1460 output. Same as $execi, except the command is run inside a
1461 thread. Use this if you have a slow script to keep Conky updat‐
1462 ing. You should make the interval slightly longer then the time
1463 it takes your script to execute. For example, if you have a
1464 script that take 5 seconds to execute, you should make the in‐
1465 terval at least 6 seconds. See also $execi.
1469 Move text over by N pixels. See also $voffset.
1472 1mrss url delay_in_minutes action item_num0m
1473 Download and parse RSS feeds. Action may be one of the follow‐
1474 ing: feed_title, item_title (with num par), item_desc (with num
1475 par) and item_titles.
1478 1mtab (width, (start))0m
1479 Puts a tab of the specified width, starting from column ’start’.
1482 1mtail logfile lines (interval)0m
1483 Displays last N lines of supplied text text file. If interval is
1484 not supplied, Conky assumes 2x Conky’s interval. Max of 30 lines
1485 can be displayed, or until the text buffer is filled.
1488 1mtemplateN (arg1) (arg2) (arg3 ...)0m
1489 Evaluate the content of the templateN configuration variable
1490 (where N is a value between 0 and 9, inclusively), applying sub‐
1491 stitutions as described in the documentation of the correspond‐
1492 ing configuration variable. The number of arguments is option‐
1493 al, but must match the highest referred index in the template.
1494 You can use the same special sequences in each argument as the
1495 ones valid for a template definition, e.g. to allow an argument
1496 to contain a whitespace. Also simple nesting of templates is
1499 Here are some examples of template definitions:
1502 template1 \1: ${fs_used \2} / ${fs_size \2}
1505 The following list shows sample usage of the templates defined
1506 above, with the equivalent syntax when not using any template at
1509 using template same without template
1510 ─────────────────────────────────────────────────────────────────────────────────
1511 ${template0 node name} $nodename
1512 ${template1 root /} root: ${fs_free /} /
1514 ${template1 ${template2\ disk\ root} /} disk root: ${fs_free /} / ${fs_size /}
1518 Local time, see man strftime to get more information about for‐
1523 Display time in UTC (universal coordinate time).
1526 1mtztime (timezone) (format)0m
1527 Local time for specified timezone, see man strftime to get more
1528 information about format. The timezone argument is specified in
1529 similar fashion as TZ environment variable. For hints, look in
1530 /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
1534 Total download, overflows at 4 GB on Linux with 32-bit arch and
1535 there doesn’t seem to be a way to know how many times it has al‐
1536 ready done that before conky has started.
1540 This takes arguments in the form:top (name) (number) Basically,
1541 processes are ranked from highest to lowest in terms of cpu us‐
1542 age, which is what (num) represents. The types are: "name",
1543 "pid", "cpu", "mem", "mem_res", "mem_vsize", and "time". There
1544 can be a max of 10 processes listed.
1547 1mtop_mem type, num0m
1548 Same as top, except sorted by mem usage instead of cpu
1552 Total upload, this one too, may overflow
1555 1mupdates Number of updates0m
1564 Upload speed in KiB with one decimal
1567 1mupspeedgraph normal|log net (height),(width) (gradient colour 1) (gra‐0m
1568 1mdient colour 2) (scale)0m
1569 Upload speed graph, colours defined in hex, minus the #. If
1570 scale is non-zero, it becomes the scale for the graph. Uses a
1571 logarithmic scale (to see small numbers) when you use "log" in‐
1579 Uptime in a shorter format
1583 Number of users logged in
1587 Lists the names of the users logged in
1591 Lists the consoles in use
1595 Lists how long users have been logged in for
1598 1mvoffset (pixels)0m
1599 Change vertical offset by N pixels. Negative values will cause
1600 text to overlap. See also $offset.
1604 Returns CPU #n’s voltage in mV. CPUs are counted from 1. If
1605 omitted, the parameter defaults to 1.
1609 Returns CPU #n’s voltage in V. CPUs are counted from 1. If omit‐
1610 ted, the parameter defaults to 1.
1613 1mwireless_essid net0m
1614 Wireless access point ESSID (Linux only)
1617 1mwireless_mode net0m
1618 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1621 1mwireless_bitrate net0m
1622 Wireless bitrate (ie 11 Mb/s) (Linux only)
1626 Wireless access point MAC address (Linux only)
1629 1mwireless_link_qual net0m
1630 Wireless link quality (Linux only)
1633 1mwireless_link_qual_max net0m
1634 Wireless link quality maximum value (Linux only)
1637 1mwireless_link_qual_perc net0m
1638 Wireless link quality in percents (Linux only)
1641 1mwireless_link_bar (height), (width) net0m
1642 Wireless link quality bar (Linux only)
1646 Displays the number of words in the given file
1650 Artist in current XMMS2 song
1654 Album in current XMMS2 song
1658 Title in current XMMS2 song
1662 Genre in current XMMS2 song
1666 Comment in current XMMS2 song
1674 Transport plugin used
1678 Full path to current song
1682 Track number in current XMMS2 song
1686 Bitrate of current song
1690 XMMS2 id of current song
1694 Duration of current song
1702 Size of current song
1706 Percent of song’s progress
1710 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1713 1mxmms2_bar (height),(width)0m
1714 Bar of XMMS2’s progress
1718 Prints the song name in either the form "artist - title" or file
1719 name, depending on whats available
1722 1mif_xmms2_connected0m
1723 Display everything between $if_xmms2_connected and the matching
1724 $endif if xmms2 is running.
1727 1meve api_userid api_key character_id0m
1728 Fetches your currently training skill from the Eve Online API
1729 servers (http://www.eve-online.com/) and displays the skill
1730 along with the remaining training time.
1734 conky 1m-t ’${time %D %H:%M}’ -o -u 300m
1735 Start Conky in its own window with date and clock as text and 30
1736 sec update interval.
1738 conky 1m-a top_left -x 5 -y 500 -d0m
1739 Start Conky to background at coordinates (5, 500).
1742 4m~/.conkyrc24m default configuration file
1745 Drawing to root or some other desktop window directly doesn’t work with
1746 all window managers. Especially doesn’t work well with Gnome and it has
1747 been reported that it doesn’t work with KDE either. Nautilus can be
1748 disabled from drawing to desktop with program gconf-editor. Uncheck
1749 show_desktop in /apps/nautilus/preferences/. There is -w switch in
1750 Conky to set some specific window id. You might find xwininfo -tree
1751 useful to find the window to draw to. You can also use -o argument
1752 which makes Conky to create its own window. If you do try running Conky
1753 in its own window, be sure to read up on the own_window_type settings
1757 ⟨http://conky.sourceforge.net/⟩
1759 ⟨http://www.sourceforge.net/projects/conky⟩
1761 #conky on irc.freenode.net
1764 Copyright (c) 2005-2008 Brenden Matthews, Philip Kovacs, et. al. Any
1765 original torsmo code is licensed under the BSD license (see LICENSE.BSD
1766 for a copy). All code written since the fork of torsmo is licensed un‐
1767 der the GPL (see LICENSE.GPL for a copy), except where noted different‐
1768 ly (such as in portmon code, timed thread code, and audacious code
1769 which are LGPL, and prss which is an MIT-style license).
1772 The Conky dev team (see AUTHORS for a full list of contributors).