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 the git repo.
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 the git repo0m
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
77 Conky is generally very good on resources. That said, the more you try
78 to make Conky do, the more resources it is going to consume.
80 An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1
81 conky". Saves you the trouble of having to kill and then restart. You
82 can now also do the same with SIGHUP.
85 Command line options override configurations defined in configuration
88 1m-v | -V | --version0m
89 Prints version and exits
93 Run Conky in 'quiet mode' (ie. no output)
96 1m-a | --alignment=ALIGNMENT0m
97 Text alignment on screen, {top,bottom,middle}_{left,right,mid‐
101 1m-b | --double-buffer0m
102 Use double buffering (eliminates "flicker")
105 1m-c | --config=FILE0m
106 Config file to load instead of $HOME/.conkyrc
110 Daemonize Conky, aka fork to background
118 Prints command line help and exits
121 1m-o | --own-window0m
122 Create own window to draw
126 Text to render, remember single quotes, like -t ' $uptime '
129 1m-u | --interval=SECONDS0m
133 1m-w | --window-id=WIN_ID0m
146 Number of times to update Conky (and quit)
149 1mCONFIGURATION SETTINGS0m
150 Default configuration file location is $HOME/.conkyrc or
151 ${sysconfdir}/conky/conky.conf. On most systems, sysconfdir is /etc,
152 and you can find the sample config file there (/etc/conky/conky.conf).
154 You might want to copy it to $HOME/.conkyrc and then start modifying
155 it. Other configs can be found at http://conky.sf.net/
157 1malias 22mUse this to create aliases of variables. The first argument is
158 the new name, the second the old name, and the other arguments
159 are passed on to the variable. Example: If you want to use $al‐
160 pha instead of ${beta gamma delta} then you have to write the
161 following: alias alpha beta gamma delta . PS: Instead of creat‐
162 ing an alias in the config you can also use environment vari‐
163 ables. Example: Start conky like this: alpha="beta gamma delta"
168 Aligned position on screen, may be top_left, top_right, top_mid‐
169 dle, bottom_left, bottom_right, bottom_middle, middle_left, mid‐
170 dle_right, or none (also can be abreviated as tl, tr, tm, bl,
175 Boolean value, if true, Conky will be forked to background when
180 Border margin in pixels
184 Border width in pixels
187 1mcolorN 22mPredefine a color for use inside TEXT segments. Substitute N by
188 a digit between 0 and 9, inclusively. When specifying the color
189 value in hex, omit the leading hash (#).
193 The number of samples to average for CPU monitoring
197 If true, cpu in top will show usage of one processor's power. If
198 false, cpu in top will show the usage of all processors' power
203 Default color and border color
206 1mdefault_outline_color0m
207 Default outline color
210 1mdefault_shade_color0m
211 Default shading color and border's shading color
215 Use the Xdbe extension? (eliminates flicker) It is highly recom‐
216 mended to use own window with this one so double buffer won't be
221 Draw borders around text?
224 1mdraw_graph_borders0m
225 Draw borders around graphs?
236 1mfont 22mFont name in X, xfontsel can be used to get a nice font
239 1mgap_x 22mGap, in pixels, between right or left border of screen, same as
240 passing -x at command line, e.g. gap_x 10
243 1mgap_y 22mGap, in pixels, between top or bottom border of screen, same as
244 passing -y at command line, e.g. gap_y 10.
248 How strict should if_up be when testing an interface for being
249 up? The value is one of up, link or address, to check for the
250 interface being solely up, being up and having link or being up,
251 having link and an assigned IP address.
254 1mimap 22mDefault global IMAP server. Arguments are: "host user pass [-i
255 interval] [-f folder] [-p port] [-e command] [-r retries]". De‐
256 fault port is 143, default folder is 'INBOX', default interval
257 is 5 minutes, and default number of retries before giving up is
258 5. If the password is supplied as '*', you will be prompted to
259 enter the password when Conky starts.
263 Mail spool for mail checking
266 1mmax_port_monitor_connections0m
267 Allow each port monitor to track at most this many connections
268 (if 0 or not set, default is 256)
272 Maximum number of special things, e.g. fonts, offsets, aligns,
273 etc. (default is 512)
276 1mmax_user_text bytes0m
277 Maximum size of user text buffer, i.e. layout below TEXT line in
278 config file (default is 16384 bytes)
281 1mtext_buffer_size bytes0m
282 Size of the standard text buffer (default is 256 bytes). This
283 buffer is used for intermediary text, such as individual lines,
284 output from $exec vars, and various other variables. Increasing
285 the size of this buffer can drastically reduce Conky's perfor‐
286 mance, but will allow for more text display per variable. The
287 size of this buffer cannot be smaller than the default value of
291 1mmaximum_width pixels0m
292 Maximum width of window
295 1mminimum_size width (height)0m
296 Minimum size of window
311 1mmusic_player_interval0m
312 Music player thread update interval (defaults to Conky's update
317 The number of samples to average for net data
321 Substract (file system) buffers from used memory?
324 1moverride_utf8_locale0m
325 Force UTF8? requires XFT
329 Boolean, create own window to draw?
333 Manually set the WM_CLASS name. Defaults to "Conky".
336 1mown_window_colour colour0m
337 If own_window_transparent no, set a specified background colour
338 (defaults to black). Takes either a hex value (#ffffff) or a
339 valid RGB name (see /usr/lib/X11/rgb.txt)
342 1mown_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager0m
343 If own_window is yes, you may use these window manager hints to
344 affect the way Conky displays. Notes: Use own_window_type desk‐
345 top as another way to implement many of these hints implicitly.
346 If you use own_window_type override, window manager hints have
347 no meaning and are ignored.
351 Manually set the window name. Defaults to "<hostname> - conky".
354 1mown_window_transparent0m
355 Boolean, set pseudo-transparency?
359 if own_window is yes, you may specify type normal, desktop, dock
360 or override (default: normal). Desktop windows are special win‐
361 dows that have no window decorations; are always visible on your
362 desktop; do not appear in your pager or taskbar; and are sticky
363 across all workspaces. Override windows are not under the con‐
364 trol of the window manager. Hints are ignored. This type of win‐
365 dow can be useful for certain situations.
369 Print text to stdout.
373 Print text to stderr.
377 When set to no, there will be no output in X (useful when you
378 also use things like out_to_console). If you set it to no, make
379 sure that it's placed before all other X-related setting (take
380 the first line of your configfile to be sure). Default value is
385 Overwrite the file given as argument.
389 Append the file given as argument.
393 Pad percentages to this many decimals (0 = no padding)
396 1mpop3 22mDefault global POP3 server. Arguments are: "host user pass [-i
397 interval] [-p port] [-e command] [-r retries]". Default port is
398 110, default interval is 5 minutes, and default number of re‐
399 tries before giving up is 5. If the password is supplied as '*',
400 you will be prompted to enter the password when Conky starts.
404 Shortens units to a single character (kiB->k, GiB->G, etc.). De‐
409 Shows the maximum value in scaled graphs.
413 Shows the time range covered by a graph.
417 Border stippling (dashing) in pixels
421 Desired output unit of all objects displaying a temperature.
422 Parameters are either "fahrenheit" or "celsius". The default
423 unit is degree Celsius.
427 Define a template for later use inside TEXT segments. Substitute
428 N by a digit between 0 and 9, inclusively. The value of the
429 variable is being inserted into the stuff below TEXT at the cor‐
430 responding position, but before some substitutions are applied:
435 '\N' -> template argument N
439 Total number of times for Conky to update before quitting. Zero
440 makes Conky run forever
444 Update interval in seconds
448 Boolean value, if true, text is rendered in upper case
452 Adds spaces around certain objects to stop them from moving oth‐
453 er things around. Arguments are left, right, and none (default).
454 The old true/false values are deprecated and default to
455 right/none respectively. Note that this only helps if you are
456 using a mono font, such as Bitstream Vera Sans Mono.
460 Use Xft (anti-aliased font and stuff)
464 Alpha of Xft font. Must be a value at or between 1 and 0.
471 1mTEXT 22mAfter this begins text to be formatted on screen. Backslash (\)
472 escapes newlines in the text section. This can be useful for
473 cleaning up config files where conky is used to pipe input to
478 Colors are parsed using XParsecolor(), there might be a list of them:
479 /usr/share/X11/rgb.txt. Also, ⟨http://sedition.com/perl/rgb.html⟩.
480 Color can be also in #rrggbb format (hex).
483 IP address for an interface, or "No Address" if no address is
488 IP addresses for an interface (if one - works like addr). Linux
493 ACPI ac adapter state.
501 ACPI temperature in C.
505 CPU temperature from therm_adt746x
509 Fan speed from therm_adt746x
513 Right-justify text, with space of N
521 Display APM AC adapter status (FreeBSD only)
525 Display APM battery life in percent (FreeBSD only)
529 Display remaining APM battery life in hh:mm:ss or "unknown" if
530 AC adapterstatus is on-line or charging (FreeBSD only)
533 1maudacious_bar (height),(width)0m
537 1maudacious_bitrate0m
538 Bitrate of current tune
541 1maudacious_channels0m
542 Number of audio channels of current tune
545 1maudacious_filename0m
546 Full path and filename of current tune
549 1maudacious_frequency0m
550 Sampling frequency of current tune
554 Total length of current tune as MM:SS
557 1maudacious_length_seconds0m
558 Total length of current tune in seconds
561 1maudacious_playlist_position0m
562 Playlist position of current tune
565 1maudacious_playlist_length0m
566 Number of tunes in playlist
569 1maudacious_position0m
570 Position of current tune (MM:SS)
573 1maudacious_position_seconds0m
574 Position of current tune in seconds
578 Player status (Playing/Paused/Stopped/Not running)
581 1maudacious_title (max length)0m
582 Title of current tune with optional maximum length specifier
585 1maudacious_main_volume0m
586 The current volume fetched from Audacious
590 Battery status and remaining percentage capacity of ACPI or APM
591 battery. ACPI battery number can be given as argument (default
595 1mbattery_short (num)0m
596 Battery status and remaining percentage capacity of ACPI or APM
597 battery. ACPI battery number can be given as argument (default
598 is BAT0). This mode display a short status, which means that C
599 is displayed instead of charging and D is displayed instead of
603 1mbattery_bar (height),(width) (num)0m
604 Battery percentage remaining of ACPI battery in a bar. ACPI bat‐
605 tery number can be given as argument (default is BAT0).
608 1mbattery_percent (num)0m
609 Battery percentage remaining for ACPI battery. ACPI battery num‐
610 ber can be given as argument (default is BAT0).
613 1mbattery_time (num)0m
614 Battery charge/discharge time remaining of ACPI battery. ACPI
615 battery number can be given as argument (default is BAT0).
619 Artist in current BMPx track
623 Album in current BMPx track
627 Title of the current BMPx track
631 Track number of the current BMPx track
635 Bitrate of the current BMPx track
639 URI of the current BMPx track
643 Amount of memory buffered
646 1mcached 22mAmount of memory cached
650 Change drawing color to color
653 1mcolorN 22mChange drawing color to colorN configuration option, where N is
654 a digit between 0 and 9, inclusively.
666 CPU architecture Conky was built for
670 CPU usage in percents. For SMP machines, the CPU number can be
671 provided as an argument. ${cpu cpu0} is the total usage, and
672 ${cpu cpuX} (X >= 1) are individual CPUs.
675 1mcpubar (cpu number) (height),(width)0m
676 Bar that shows CPU usage, height is bar's height in pixels. See
677 $cpu for more info on SMP.
680 1mcpugauge (cpu number) (height),(width)0m
681 Elliptical gauge that shows CPU usage, height and width are
682 gauge's vertical and horizontal axis respectively. See $cpu for
686 1mcpugraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐0m
687 1ment colour 2) (scale) (cpu number)0m
688 CPU usage graph, with optional colours in hex, minus the #. See
689 $cpu for more info on SMP. Uses a logarithmic scale (to see
690 small numbers) when you use "log" instead of "normal".
694 Displays current disk IO. Device is optional, and takes the form
695 of sda for /dev/sda. Individual partitions are allowed.
698 1mdiskiograph ("normal"|"log") (height),(width) (gradient colour 1) (gra‐0m
699 1mdient colour 2) (scale) (device)0m
700 Disk IO graph, colours defined in hex, minus the #. If scale is
701 non-zero, it becomes the scale for the graph. Uses a logarithmic
702 scale (to see small numbers) when you use "log" instead of "nor‐
706 1mdiskio_read (device)0m
707 Displays current disk IO for reads. Device as in diskio.
710 1mdiskiograph_read ("normal"|"log") (height),(width) (gradient colour 1)0m
711 1m(gradient colour 2) (scale) (device)0m
712 Disk IO graph for reads, colours defined in hex, minus the #. If
713 scale is non-zero, it becomes the scale for the graph. Device as
714 in diskio. Uses a logarithmic scale (to see small numbers) when
715 you use "log" instead of "normal".
718 1mdiskio_write (device)0m
719 Displays current disk IO for writes. Device as in diskio.
722 1mdiskiograph_write ("normal"|"log") (height),(width) (gradient colour 1)0m
723 1m(gradient colour 2) (scale) (device)0m
724 Disk IO graph for writes, colours defined in hex, minus the #.
725 If scale is non-zero, it becomes the scale for the graph. Device
726 as in diskio. Uses a logarithmic scale (to see small numbers)
727 when you use "log" instead of "normal".
730 1mdisk_protect device0m
731 Disk protection status, if supported (needs kernel-patch).
732 Prints either "frozen" or "free " (note the padding).
736 Download speed in KiB
740 Download speed in KiB with one decimal
743 1mdownspeedgraph ("normal"|"log") (height),(width) (gradient colour 1)0m
744 1m(gradient colour 2) (scale) (net)0m
745 Download speed graph, colours defined in hex, minus the #. If
746 scale is non-zero, it becomes the scale for the graph. Uses a
747 logarithmic scale (to see small numbers) when you use "log" in‐
751 1melse 22mText to show if any of the above are not true
755 Current entropy available for crypto freaks
758 1mentropy_bar (height),(width)0m
759 Normalized bar of available entropy for crypto freaks
763 Total size of system entropy pool for crypto freaks
767 Executes a shell command and displays the output in conky. warn‐
768 ing: this takes a lot more resources than other variables. I'd
769 recommend coding wanted behaviour in C and posting a patch.
773 Same as exec, except if the first value return is a value be‐
774 tween 0-100, it will use that number for a bar. The size for the
775 bar is currently fixed, but that may change in the future.
778 1mexecgauge command0m
779 Same as exec, except if the first value return is a value be‐
780 tween 0-100, it will use that number for a gauge. The size for
781 the gauge is currently fixed, but you may change that for the
782 future conky release.
785 1mexecgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐0m
786 1ment colour 2) (scale) command0m
787 Same as execbar, but graphs values. Uses a logaritmic scale when
788 the log option is given (to see small numbers). Values still
789 have to be between 0 and 100.
792 1mexeci interval command0m
793 Same as exec but with specific interval. Interval can't be less
794 than update_interval in configuration. See also $texeci
797 1mexecibar interval command0m
798 Same as execbar, except with an interval
801 1mexecigraph interval command0m
802 Same as execgraph, but takes an interval arg graphs values
806 Executes a shell command and displays the output in conky. warn‐
807 ing: this takes a lot more resources than other variables. I'd
808 recommend coding wanted behaviour in C and posting a patch. This
809 differs from $exec in that it parses the output of the command,
810 so you can insert things like ${color red}hi!${color} in your
811 script and have it correctly parsed by Conky. Caveats: Conky
812 parses and evaluates the output of $execp every time Conky
813 loops, and then destroys all the objects. If you try to use any‐
814 thing like $execi within an $execp statement, it will function‐
815 ally run at the same interval that the $execp statement runs, as
816 it is created and destroyed at every interval.
819 1mexecpi interval command0m
820 Same as execp but with specific interval. Interval can't be less
821 than update_interval in configuration. Note that the output from
822 the $execpi command is still parsed and evaluated at every in‐
827 Specify a different font. This new font will apply to the cur‐
828 rent line and everything following. You can use a $font with no
829 arguments to change back to the default font (much like with
834 Returns CPU #n's frequency in MHz. CPUs are counted from 1. If
835 omitted, the parameter defaults to 1.
839 Returns CPU #n's frequency in GHz. CPUs are counted from 1. If
840 omitted, the parameter defaults to 1.
844 Returns CPU #n's frequency in MHz (defaults to 1), but is calcu‐
845 lated by counting to clock cycles to complete an instruction.
846 Only available for x86/amd64.
850 Returns CPU #n's frequency in GHz (defaults to 1), but is calcu‐
851 lated by counting to clock cycles to complete an instruction.
852 Only available for x86/amd64.
855 1mfs_bar (height),(width) fs0m
856 Bar that shows how much space is used on a file system. height
857 is the height in pixels. fs is any file on that file system.
861 Free space on a file system available for users.
864 1mfs_free_perc (fs)0m
865 Free percentage of space on a file system available for users.
877 File system used space
880 1mgoto x 22mThe next element will be printed at position 'x'.
884 Displays the default route's interface or "multiple"/"none" ac‐
888 1mgw_ip 22mDisplays the default gateway's IP or "multiple"/"none" accord‐
892 1mhddtemp dev, (host,(port))0m
893 Displays temperature of a selected hard disk drive as reported
894 by the hddtemp daemon running on host:port. Default host is
895 127.0.0.1, default port is 7634.
898 1mhead logfile lines (interval)0m
899 Displays first N lines of supplied text text file. If interval
900 is not supplied, Conky assumes 2x Conky's interval. Max of 30
901 lines can be displayed, or until the text buffer is filled.
905 Horizontal line, height is the height in pixels
908 1mhwmon (dev) type n0m
909 Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omit‐
910 ted if you have only one hwmon device. Parameter type is either
911 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning
912 temperature. Parameter n is number of the sensor. See
913 /sys/class/hwmon/ on your local computer.
916 1miconv_start codeset_from codeset_to0m
917 Convert text from one codeset to another using GNU iconv. Needs
918 to be stopped with iconv_stop.
922 Stop iconv codeset conversion.
926 I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted
927 if you have only one I2C device. Parameter type is either 'in'
928 or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning tem‐
929 perature. Parameter n is number of the sensor. See
930 /sys/bus/i2c/devices/ on your local computer.
934 If running the i8k kernel driver for Inspiron laptops, displays
935 whether ac power is on, as listed in /proc/i8k (translated to
936 human-readable). Beware that this is by default not enabled by
941 If running the i8k kernel driver for Inspiron laptops, displays
942 the bios version as listed in /proc/i8k.
945 1mi8k_buttons_status0m
946 If running the i8k kernel driver for Inspiron laptops, displays
947 the volume buttons status as listed in /proc/i8k.
951 If running the i8k kernel driver for Inspiron laptops, displays
952 the cpu temperature in Celsius, as reported by /proc/i8k.
956 If running the i8k kernel driver for Inspiron laptops, displays
957 the left fan's rate of rotation, in revolutions per minute as
958 listed in /proc/i8k. Beware, some laptops i8k reports these fans
962 1mi8k_left_fan_status0m
963 If running the i8k kernel driver for Inspiron laptops, displays
964 the left fan status as listed in /proc/i8k (translated to human-
965 readable). Beware, some laptops i8k reports these fans in re‐
969 1mi8k_right_fan_rpm0m
970 If running the i8k kernel driver for Inspiron laptops, displays
971 the right fan's rate of rotation, in revolutions per minute as
972 listed in /proc/i8k. Beware, some laptops i8k reports these fans
976 1mi8k_right_fan_status0m
977 If running the i8k kernel driver for Inspiron laptops, displays
978 the right fan status as listed in /proc/i8k (translated to hu‐
979 man-readable). Beware, some laptops i8k reports these fans in
984 If running the i8k kernel driver for Inspiron laptops, displays
985 your laptop serial number as listed in /proc/i8k.
989 If running the i8k kernel driver for Inspiron laptops, displays
990 the version formatting of /proc/i8k.
994 If running the IBM ACPI, displays the fan speed.
998 If running the IBM ACPI, displays the temperatures from the IBM
999 temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
1004 If running the IBM ACPI, displays the "master" volume, con‐
1005 trolled by the volume keys (0-14).
1009 If running the IBM ACPI, displays the brigtness of the laptops's
1014 if conky variable VAR is empty, display everything between
1015 $if_empty and the matching $endif
1018 1mif_existing file (string)0m
1019 if FILE exists, display everything between if_existing and the
1020 matching $endif. The optional second paramater checks for FILE
1021 containing the specified string and prints everything between
1022 $if_existing and the matching $endif.
1025 1mif_gw 22mif there is at least one default gateway, display everything be‐
1026 tween $if_gw and the matching $endif
1029 1mif_match expression0m
1030 Evaluates the given boolean expression, printing everything be‐
1031 tween $if_match and the matching $endif depending on whether the
1032 evaluation returns true or not. Valid expressions consist of a
1033 left side, an operator and a right side. Left and right sides
1034 are being parsed for contained text objects before evaluation.
1035 Recognised left and right side types are:
1037 1mdouble22m: argument consists of only digits and a single dot.
1038 1mlong22m: argument consists of only digits.
1039 1mstring22m: argument is enclosed in quotation mark or the checks for
1040 double and long failed before.
1042 Valid operands are: '>', '<', '>=', '<=', '==', '!='.
1045 1mif_running (process)0m
1046 if PROCESS is running, display everything $if_running and the
1047 matching $endif. This uses the ``pidof'' command, so the -x
1048 switch is also supported.
1051 1mif_mounted (mountpoint)0m
1052 if MOUNTPOINT is mounted, display everything between $if_mounted
1053 and the matching $endif
1056 1mif_smapi_bat_installed (INDEX)0m
1057 when using smapi, if the battery with index INDEX is installed,
1058 display everything between $if_smapi_bat_installed and the
1062 1mif_up (interface)0m
1063 if INTERFACE exists and is up, display everything between $if_up
1064 and the matching $endif
1067 1mif_updatenr (updatenr)0m
1068 If it's the UPDATENR-th time that conky updates, display every‐
1069 thing between $if_updatenr and the matching $endif. The counter
1070 resets when the highest UPDATENR is reached. Example :
1071 "{$if_updatenr 1}foo$endif{$if_updatenr 2}bar$endif{$if_updatenr
1072 4}$endif" shows foo 25% of the time followed by bar 25% of the
1073 time followed by nothing the other half of the time.
1076 1mimap_messages (args)0m
1077 Displays the number of messages in your global IMAP inbox by de‐
1078 fault. You can define individual IMAP inboxes seperately by
1079 passing arguments to this object. Arguments are: "host user pass
1080 [-i interval] [-p port] [-e command] [-r retries]". Default port
1081 is 143, default interval is 5 minutes, and default number of re‐
1082 tries before giving up is 5. If the password is supplied as '*',
1083 you will be prompted to enter the password when Conky starts.
1086 1mimap_unseen (args)0m
1087 Displays the number of unseen messages in your global IMAP inbox
1088 by default. You can define individual IMAP inboxes seperately by
1089 passing arguments to this object. Arguments are: "host user pass
1090 [-i interval] [-p port] [-e command] [-r retries]". Default port
1091 is 143, default interval is 5 minutes, and default number of re‐
1092 tries before giving up is 5. If the password is supplied as '*',
1093 you will be prompted to enter the password when Conky starts.
1096 1mioscheduler disk0m
1097 Prints the current ioscheduler used for the given disk name
1098 (i.e. e.g. "hda" or "sdb")
1101 1mkernel 22mKernel version
1105 The value of /proc/sys/vm/laptop_mode
1109 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
1110 5 minutes and 3 for past 15 minutes.
1113 1mloadgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐0m
1114 1ment colour 2) (scale)0m
1115 Load1 average graph, similar to xload, with optional colours in
1116 hex, minus the #. Uses a logarithmic scale (to see small num‐
1117 bers) when you use "log" instead of "normal".
1121 Displays the number of lines in the given file
1125 Machine, i686 for example
1128 1mmails (mailbox) (interval)0m
1129 Mail count in the specified mailbox or your mail spool if not.
1130 Both mbox and maildir type mailboxes are supported. You can use
1131 a program like fetchmail to get mails from some server using
1132 your favourite protocol. See also new_mails.
1135 1mnew_mails (mailbox) (interval)0m
1136 Unread mail count in the specified mailbox or mail spool if not.
1137 Both mbox and maildir type mailboxes are supported.
1140 1mseen_mails (maildir) (interval)0m
1141 Number of mails marked as seen in the specified mailbox or mail
1142 spool if not. Only maildir type mailboxes are supported, mbox
1143 type will return -1.
1146 1munseen_mails (maildir) (interval)0m
1147 Number of new or unseen mails in the specified mailbox or mail
1148 spool if not. Only maildir type mailboxes are supported, mbox
1149 type will return -1.
1152 1mflagged_mails (maildir) (interval)0m
1153 Number of mails marked as flagged in the specified mailbox or
1154 mail spool if not. Only maildir type mailboxes are supported,
1155 mbox type will return -1.
1158 1munflagged_mails (maildir) (interval)0m
1159 Number of mails not marked as flagged in the specified mailbox
1160 or mail spool if not. Only maildir type mailboxes are supported,
1161 mbox type will return -1.
1164 1mforwarded_mails (maildir) (interval)0m
1165 Number of mails marked as forwarded in the specified mailbox or
1166 mail spool if not. Only maildir type mailboxes are supported,
1167 mbox type will return -1.
1170 1munforwarded_mails (maildir) (interval)0m
1171 Number of mails not marked as forwarded in the specified mailbox
1172 or mail spool if not. Only maildir type mailboxes are supported,
1173 mbox type will return -1.
1176 1mreplied_mails (maildir) (interval)0m
1177 Number of mails marked as replied in the specified mailbox or
1178 mail spool if not. Only maildir type mailboxes are supported,
1179 mbox type will return -1.
1182 1munreplied_mails (maildir) (interval)0m
1183 Number of mails not marked as replied in the specified mailbox
1184 or mail spool if not. Only maildir type mailboxes are supported,
1185 mbox type will return -1.
1188 1mdraft_mails (maildir) (interval)0m
1189 Number of mails marked as draft in the specified mailbox or mail
1190 spool if not. Only maildir type mailboxes are supported, mbox
1191 type will return -1.
1194 1mtrashed_mails (maildir) (interval)0m
1195 Number of mails marked as trashed in the specified mailbox or
1196 mail spool if not. Only maildir type mailboxes are supported,
1197 mbox type will return -1.
1200 1mmboxscan (-n number of messages to print) (-fw from width) (-sw subject0m
1202 Print a summary of recent messages in an mbox format mailbox.
1203 mbox parameter is the filename of the mailbox (can be encapsu‐
1204 lated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
1207 1mmem 22mAmount of memory in use
1210 1mmembar (height),(width)0m
1211 Bar that shows amount of memory in use
1214 1mmemgauge (height),(width)0m
1215 Gauge that shows amount of memory in use (see cpugauge)
1218 1mmemgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐0m
1219 1ment colour 2) (scale)0m
1220 Memory usage graph. Uses a logarithmic scale (to see small num‐
1221 bers) when you use "log" instead of "normal".
1225 Amount of free memory including the memory that is very easily
1226 freed (buffers/cache)
1230 Amount of free memory
1233 1mmemmax 22mTotal amount of memory
1237 Percentage of memory in use
1241 Prints the mixer value as reported by the OS. Default mixer is
1242 "vol", but you can specify one of the following optional argu‐
1243 ments: "vol", "bass", "treble", "synth", "pcm", "speaker",
1244 "line", "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain",
1245 "line1", "line2", "line3", "dig1", "dig2", "dig3", "phin",
1246 "phout", "video", "radio", "monitor". Refer to the definition of
1247 SOUND_DEVICE_NAMES in <linux/soundcard.h> (on Linux), <sound‐
1248 card.h> (on OpenBSD), or <sys/soundcard.h> to find the exact op‐
1249 tions available on your system.
1252 1mmixerbar (device)0m
1253 Displays mixer value in a bar as reported by the OS. See docs
1254 for $mixer for details on arguments.
1258 Prints the right channel mixer value as reported by the OS. See
1259 docs for $mixer for details on arguments.
1262 1mmixerrbar (device)0m
1263 Displays the right channel mixer value in a bar as reported by
1264 the OS. See docs for $mixer for details on arguments.
1268 Prints the left channel mixer value as reported by the OS. See
1269 docs for $mixer for details on arguments.
1272 1mmixerlbar (device)0m
1273 Displays the left channel mixer value in a bar as reported by
1274 the OS. See docs for $mixer for details on arguments.
1278 Current state of MOC; playing, stopped etc.
1282 File name of the current MOC song
1286 Title of the current MOC song
1290 Artist of the current MOC song
1294 The current song name being played in MOC.
1298 Album of the current MOC song
1302 Total length of the current MOC song
1306 Time left in the current MOC song
1310 Current time of the current MOC song
1314 Bitrate in the current MOC song
1318 Rate of the current MOC song
1322 Number of the monitor on which conky is running
1330 Artist in current MPD song must be enabled at compile
1334 Album in current MPD song
1337 1mmpd_bar (height),(width)0m
1338 Bar of mpd's progress
1342 Bitrate of current song
1346 Playing, stopped, et cetera.
1349 1mmpd_title (max length)0m
1350 Title of current MPD song
1366 Percent of song's progress
1370 Random status (On/Off)
1374 Repeat status (On/Off)
1378 Prints the MPD track field
1382 Prints the MPD name field
1386 Prints the file name of the current MPD song
1389 1mmpd_smart (max length)0m
1390 Prints the song name in either the form "artist - title" or file
1391 name, depending on whats available
1395 if mpd is playing or paused, display everything between
1396 $if_mpd_playing and the matching $endif
1399 1mnameserver (index)0m
1400 Print a nameserver from /etc/resolv.conf. Index starts at and
1408 1mnvidia threshold temp ambient gpufreq memfreq imagequality0m
1409 Nvidia graficcard support for the XNVCtrl library. Each option
1410 can be shortened to the least significant part. Temperatures
1411 are printed as float, all other values as integer.
1413 1mthreshold22m: the thresholdtemperature at which the gpu slows down
1414 1mtemp22m: gives the gpu current temperature
1415 1mambient22m: gives current air temperature near GPU case
1416 1mgpufreq22m: gives the current gpu frequency
1417 1mmemfreq22m: gives the current mem frequency
1418 1mimagequality22m: which imagequality should be choosen by OpenGL ap‐
1422 1moutlinecolor (color)0m
1423 Change outline color
1427 If running on Apple powerbook/ibook, display information on bat‐
1428 tery status. The item parameter specifies, what information to
1429 display. Exactly one item must be specified. Valid items are:
1431 1mstatus22m: Display if battery is fully charged, charging, discharg‐
1432 ing or absent (running on AC)
1433 1mpercent22m: Display charge of battery in percent, if charging or
1434 discharging. Nothing will be displayed, if battery is fully
1436 1mtime22m: Display the time remaining until the battery will be fully
1437 charged or discharged at current rate. Nothing is displayed, if
1438 battery is absent or if it's present but fully charged and not
1442 1mplatform (dev) type n0m
1443 Platform sensor from sysfs (Linux 2.6). Parameter dev may be
1444 omitted if you have only one platform device. Platform type is
1445 either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp'
1446 meaning temperature. Parameter n is number of the sensor. See
1447 /sys/bus/platform/devices/ on your local computer.
1450 1mpop3_unseen (args)0m
1451 Displays the number of unseen messages in your global POP3 inbox
1452 by default. You can define individual POP3 inboxes seperately by
1453 passing arguments to this object. Arguments are: "host user pass
1454 [-i interval] [-p port] [-e command] [-r retries]". Default port
1455 is 110, default interval is 5 minutes, and default number of re‐
1456 tries before giving up is 5. If the password is supplied as '*',
1457 you will be prompted to enter the password when Conky starts.
1460 1mpop3_used (args)0m
1461 Displays the amount of space (in MiB, 2^20) used in your global
1462 POP3 inbox by default. You can define individual POP3 inboxes
1463 seperately by passing arguments to this object. Arguments are:
1464 "host user pass [-i interval] [-p port] [-e command] [-r re‐
1465 tries]". Default port is 110, default interval is 5 minutes, and
1466 default number of retries before giving up is 5. If the password
1467 is supplied as '*', you will be prompted to enter the password
1471 1mpre_exec shell command0m
1472 Executes a shell command one time before conky displays anything
1473 and puts output as text.
1477 Total processes (sleeping and running)
1480 1mrunning_processes0m
1481 Running processes (not sleeping), requires Linux 2.6
1484 1mscroll length (step) text0m
1485 Scroll 'text' by 'step' characters showing 'length' number of
1486 characters at the same time. The text may also contain vari‐
1487 ables. 'step' is optional and defaults to 1 if not set. If a var
1488 creates output on multiple lines then the lines are placed be‐
1489 hind each other separated with a '|'-sign. Do NOT use vars that
1490 change colors or otherwise affect the design inside a scrolling
1491 text. If you want spaces between the start and the end of
1492 'text', place them at the end of 'text' not at the front ("foo‐
1493 bar" and " foobar" can both generate "barfoo" but "foobar " will
1494 keep the spaces like this "bar foo").
1497 1mshadecolor (color)0m
1498 Change shading color
1502 when using smapi, display contents of the /sys/devices/plat‐
1503 form/smapi directory. ARGS are either '(FILENAME)' or 'bat (IN‐
1504 DEX) (FILENAME)' to display the corresponding files' content.
1505 This is a very raw method of accessing the smapi values. When
1506 available, better use one of the smapi_* variables instead.
1509 1msmapi_bat_bar (INDEX),(height),(width)0m
1510 when using smapi, display the remaining capacity of the battery
1511 with index INDEX as a bar.
1514 1msmapi_bat_perc (INDEX)0m
1515 when using smapi, display the remaining capacity in percent of
1516 the battery with index INDEX. This is a separate variable be‐
1517 cause it supports the 'use_spacer' configuration option.
1520 1msmapi_bat_power INDEX0m
1521 when using smapi, display the current power of the battery with
1522 index INDEX in watt. This is a separate variable because the
1523 original read out value is being converted from mW. The sign of
1524 the output reflects charging (positive) or discharging (nega‐
1528 1msmapi_bat_temp INDEX0m
1529 when using smapi, display the current temperature of the battery
1530 with index INDEX in degree Celsius. This is a separate variable
1531 because the original read out value is being converted from mil‐
1535 1mstippled_hr (space)0m
1536 Stippled (dashed) horizontal line
1539 1mswapbar (height),(width)0m
1540 Bar that shows amount of swap in use
1543 1mswap 22mAmount of swap in use
1547 Total amount of swap
1551 Percentage of swap in use
1555 System name, Linux for example
1558 1mtcp_portmon port_begin port_end item (index) 4m22m(ip424m 4monly24m 4mat24m 4mpresent)0m
1559 TCP port monitor for specified local ports. Port numbers must be
1560 in the range 1 to 65535. Valid items are:
1562 1mcount 22m- total number of connections in the range
1563 1mrip 22m- remote ip address
1564 1mrhost 22m- remote host name
1565 1mrport 22m- remote port number
1566 1mrservice 22m- remote service name from /etc/services
1567 1mlip 22m- local ip address
1568 1mlhost 22m- local host name
1569 1mlport 22m- local port number
1570 1mlservice 22m- local service name from /etc/services
1572 The connection index provides you with access to each connection
1573 in the port monitor. The monitor will return information for in‐
1574 dex values from 0 to n-1 connections. Values higher than n-1 are
1575 simply ignored. For the "count" item, the connection index must
1576 be omitted. It is required for all other items.
1579 1m${tcp_portmon 6881 6999 count} 22m- displays the number of connec‐
1580 tions in the bittorrent port range
1581 1m${tcp_portmon 22 22 rip 0} 22m- displays the remote host ip of the
1582 first sshd connection
1583 1m${tcp_portmon 22 22 rip 9} 22m- displays the remote host ip of the
1584 tenth sshd connection
1585 1m${tcp_portmon 1 1024 rhost 0} 22m- displays the remote host name of
1586 the first connection on a privileged port
1587 1m${tcp_portmon 1 1024 rport 4} 22m- displays the remote host port of
1588 the fifth connection on a privileged port
1589 1m${tcp_portmon 1 65535 lservice 14} 22m- displays the local service
1590 name of the fifteenth connection in the range of all ports
1592 Note that port monitor variables which share the same port range
1593 actually refer to the same monitor, so many references to a sin‐
1594 gle port range for different items and different indexes all use
1595 the same monitor internally. In other words, the program avoids
1596 creating redundant monitors.
1598 1mtexeci interval command0m
1599 Runs a command at an interval inside a thread and displays the
1600 output. Same as $execi, except the command is run inside a
1601 thread. Use this if you have a slow script to keep Conky updat‐
1602 ing. You should make the interval slightly longer then the time
1603 it takes your script to execute. For example, if you have a
1604 script that take 5 seconds to execute, you should make the in‐
1605 terval at least 6 seconds. See also $execi.
1609 Move text over by N pixels. See also $voffset.
1612 1mrss url delay_in_minutes action item_num0m
1613 Download and parse RSS feeds. Action may be one of the follow‐
1614 ing: feed_title, item_title (with num par), item_desc (with num
1615 par) and item_titles.
1618 1mtab (width, (start))0m
1619 Puts a tab of the specified width, starting from column 'start'.
1622 1mtail logfile lines (interval)0m
1623 Displays last N lines of supplied text text file. If interval is
1624 not supplied, Conky assumes 2x Conky's interval. Max of 30 lines
1625 can be displayed, or until the text buffer is filled.
1628 1mtemplateN (arg1) (arg2) (arg3 ...)0m
1629 Evaluate the content of the templateN configuration variable
1630 (where N is a value between 0 and 9, inclusively), applying sub‐
1631 stitutions as described in the documentation of the correspond‐
1632 ing configuration variable. The number of arguments is option‐
1633 al, but must match the highest referred index in the template.
1634 You can use the same special sequences in each argument as the
1635 ones valid for a template definition, e.g. to allow an argument
1636 to contain a whitespace. Also simple nesting of templates is
1639 Here are some examples of template definitions:
1642 template1 \1: ${fs_used \2} / ${fs_size \2}
1645 The following list shows sample usage of the templates defined
1646 above, with the equivalent syntax when not using any template at
1649 using template same without template
1650 ─────────────────────────────────────────────────────────────────────────────────
1651 ${template0 node name} $nodename
1652 ${template1 root /} root: ${fs_free /} /
1654 ${template1 ${template2\ disk\ root} /} disk root: ${fs_free /} / ${fs_size /}
1658 Local time, see man strftime to get more information about for‐
1663 Display time in UTC (universal coordinate time).
1666 1mtztime (timezone) (format)0m
1667 Local time for specified timezone, see man strftime to get more
1668 information about format. The timezone argument is specified in
1669 similar fashion as TZ environment variable. For hints, look in
1670 /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
1674 Total download, overflows at 4 GB on Linux with 32-bit arch and
1675 there doesn't seem to be a way to know how many times it has al‐
1676 ready done that before conky has started.
1680 This takes arguments in the form:top (name) (number) Basically,
1681 processes are ranked from highest to lowest in terms of cpu us‐
1682 age, which is what (num) represents. The types are: "name",
1683 "pid", "cpu", "mem", "mem_res", "mem_vsize", and "time". There
1684 can be a max of 10 processes listed.
1687 1mtop_mem type, num0m
1688 Same as top, except sorted by mem usage instead of cpu
1691 1mtop_time type, num0m
1692 Same as top, except sorted by total CPU time instead of current
1697 Total upload, this one too, may overflow
1700 1mupdates Number of updates0m
1709 Upload speed in KiB with one decimal
1712 1mupspeedgraph ("normal"|"log") (height),(width) (gradient colour 1)0m
1713 1m(gradient colour 2) (scale) (net)0m
1714 Upload speed graph, colours defined in hex, minus the #. If
1715 scale is non-zero, it becomes the scale for the graph. Uses a
1716 logarithmic scale (to see small numbers) when you use "log" in‐
1724 Uptime in a shorter format
1728 Number of users logged in
1732 Lists the names of the users logged in
1736 Lists the consoles in use
1740 Lists how long users have been logged in for
1743 1mvoffset (pixels)0m
1744 Change vertical offset by N pixels. Negative values will cause
1745 text to overlap. See also $offset.
1749 Returns CPU #n's voltage in mV. CPUs are counted from 1. If
1750 omitted, the parameter defaults to 1.
1754 Returns CPU #n's voltage in V. CPUs are counted from 1. If omit‐
1755 ted, the parameter defaults to 1.
1758 1mwireless_essid net0m
1759 Wireless access point ESSID (Linux only)
1762 1mwireless_mode net0m
1763 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1766 1mwireless_bitrate net0m
1767 Wireless bitrate (ie 11 Mb/s) (Linux only)
1771 Wireless access point MAC address (Linux only)
1774 1mwireless_link_qual net0m
1775 Wireless link quality (Linux only)
1778 1mwireless_link_qual_max net0m
1779 Wireless link quality maximum value (Linux only)
1782 1mwireless_link_qual_perc net0m
1783 Wireless link quality in percents (Linux only)
1786 1mwireless_link_bar (height), (width) net0m
1787 Wireless link quality bar (Linux only)
1791 Displays the number of words in the given file
1795 Artist in current XMMS2 song
1799 Album in current XMMS2 song
1803 Title in current XMMS2 song
1807 Genre in current XMMS2 song
1811 Comment in current XMMS2 song
1819 Transport plugin used
1823 Full path to current song
1827 Track number in current XMMS2 song
1831 Bitrate of current song
1835 XMMS2 id of current song
1839 Duration of current song
1847 Size of current song
1851 Percent of song's progress
1855 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1858 1mxmms2_bar (height),(width)0m
1859 Bar of XMMS2's progress
1863 Prints the song name in either the form "artist - title" or file
1864 name, depending on whats available
1867 1mif_xmms2_connected0m
1868 Display everything between $if_xmms2_connected and the matching
1869 $endif if xmms2 is running.
1872 1meve api_userid api_key character_id0m
1873 Fetches your currently training skill from the Eve Online API
1874 servers (http://www.eve-online.com/) and displays the skill
1875 along with the remaining training time.
1879 conky 1m-t '${time %D %H:%M}' -o -u 300m
1880 Start Conky in its own window with date and clock as text and 30
1881 sec update interval.
1883 conky 1m-a top_left -x 5 -y 500 -d0m
1884 Start Conky to background at coordinates (5, 500).
1887 4m~/.conkyrc24m default configuration file
1890 Drawing to root or some other desktop window directly doesn't work with
1891 all window managers. Especially doesn't work well with Gnome and it has
1892 been reported that it doesn't work with KDE either. Nautilus can be
1893 disabled from drawing to desktop with program gconf-editor. Uncheck
1894 show_desktop in /apps/nautilus/preferences/. There is -w switch in
1895 Conky to set some specific window id. You might find xwininfo -tree
1896 useful to find the window to draw to. You can also use -o argument
1897 which makes Conky to create its own window. If you do try running Conky
1898 in its own window, be sure to read up on the own_window_type settings
1902 ⟨http://conky.sourceforge.net/⟩
1904 ⟨http://www.sourceforge.net/projects/conky⟩
1906 #conky on irc.freenode.net
1909 Copyright (c) 2005-2008 Brenden Matthews, Philip Kovacs, et. al. Any
1910 original torsmo code is licensed under the BSD license (see LICENSE.BSD
1911 for a copy). All code written since the fork of torsmo is licensed un‐
1912 der the GPL (see LICENSE.GPL for a copy), except where noted different‐
1913 ly (such as in portmon code, timed thread code, and audacious code
1914 which are LGPL, and prss which is an MIT-style license).
1917 The Conky dev team (see AUTHORS for a full list of contributors).