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 \e[1mconky
\e[22m[
\e[4moptions
\e[24m]
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 \e[1msh autogen.sh # Only required if building from the git repo
\e[0m
59 \e[1m./configure --prefix=/usr --mandir=/usr/share/man --in‐
\e[0m
60 \e[1mfodir=/usr/share/info --datadir=/usr/share --sysconfdir=/etc --local‐
\e[0m
61 \e[1mstatedir=/var/lib --disable-own-window --enable-audacious[=yes|no|lega‐
\e[0m
62 \e[1mcy] --enable-bmpx --disable-hddtemp --disable-mpd --enable-xmms2 --dis‐
\e[0m
63 \e[1mable-portmon --disable-network --enable-debug --disable-x11 --dis‐
\e[0m
64 \e[1mable-double-buffer --disable-xdamage --disable-xft
\e[0m
68 \e[1mmake install # Optional
\e[0m
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
76 \e[1mYOU SHOULD KNOW
\e[0m
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 \e[1m-v | -V | --version
\e[0m
89 Prints version and exits
92 \e[1m-q | --quiet
\e[0m
93 Run Conky in 'quiet mode' (ie. no output)
96 \e[1m-a | --alignment=ALIGNMENT
\e[0m
97 Text alignment on screen, {top,bottom,middle}_{left,right,mid‐
101 \e[1m-b | --double-buffer
\e[0m
102 Use double buffering (eliminates "flicker")
105 \e[1m-c | --config=FILE
\e[0m
106 Config file to load instead of $HOME/.conkyrc
109 \e[1m-d | --daemonize
\e[0m
110 Daemonize Conky, aka fork to background
113 \e[1m-f | --font=FONT
\e[0m
117 \e[1m-h | --help
\e[0m
118 Prints command line help and exits
121 \e[1m-o | --own-window
\e[0m
122 Create own window to draw
125 \e[1m-t | --text=TEXT
\e[0m
126 Text to render, remember single quotes, like -t ' $uptime '
129 \e[1m-u | --interval=SECONDS
\e[0m
133 \e[1m-w | --window-id=WIN_ID
\e[0m
137 \e[1m-x X_COORDINATE
\e[0m
141 \e[1m-y Y_COORDINATE
\e[0m
146 Number of times to update Conky (and quit)
149 \e[1mCONFIGURATION SETTINGS
\e[0m
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 \e[1malias
\e[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
179 \e[1mborder_margin
\e[0m
180 Border margin in pixels.
183 \e[1mborder_width
\e[0m
184 Border width in pixels.
187 \e[1mcolorN
\e[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 (#).
192 \e[1mcpu_avg_samples
\e[0m
193 The number of samples to average for CPU monitoring.
196 \e[1mdiskio_avg_samples
\e[0m
197 The number of samples to average for disk I/O monitoring.
200 \e[1mtop_name_width
\e[0m
201 Width for $top name value (defaults to 15 characters).
204 \e[1mtop_cpu_separate
\e[0m
205 If true, cpu in top will show usage of one processor's power. If
206 false, cpu in top will show the usage of all processors' power
210 \e[1mdefault_bar_size
\e[0m
211 Specify a default width and height for bars. Example: 'de‐
212 fault_bar_size 0 6'. This is particularly useful for execbar and
213 execibar as they do not take size arguments.
216 \e[1mdefault_graph_size
\e[0m
217 Specify a default width and height for graphs. Example: 'de‐
218 fault_graph_size 0 25'. This is particularly useful for exec‐
219 graph and execigraph as they do not take size arguments
222 \e[1mdefault_gauge_size
\e[0m
223 Specify a default width and height for gauges. Example: 'de‐
224 fault_gauge_size 25 25'. This is particularly useful for exec‐
225 gauge and execigauge as they do not take size arguments
228 \e[1mdefault_color
\e[0m
229 Default color and border color
232 \e[1mdefault_outline_color
\e[0m
233 Default outline color
236 \e[1mdefault_shade_color
\e[0m
237 Default shading color and border's shading color
240 \e[1mdouble_buffer
\e[0m
241 Use the Xdbe extension? (eliminates flicker) It is highly recom‐
242 mended to use own window with this one so double buffer won't be
246 \e[1mdraw_borders
\e[0m
247 Draw borders around text?
250 \e[1mdraw_graph_borders
\e[0m
251 Draw borders around graphs?
254 \e[1mdraw_outline
\e[0m
258 \e[1mdraw_shades
\e[0m
262 \e[1mfont
\e[22mFont name in X, xfontsel can be used to get a nice font
265 \e[1mgap_x
\e[22mGap, in pixels, between right or left border of screen, same as
266 passing -x at command line, e.g. gap_x 10
269 \e[1mgap_y
\e[22mGap, in pixels, between top or bottom border of screen, same as
270 passing -y at command line, e.g. gap_y 10.
273 \e[1mif_up_strictness
\e[0m
274 How strict should if_up be when testing an interface for being
275 up? The value is one of up, link or address, to check for the
276 interface being solely up, being up and having link or being up,
277 having link and an assigned IP address.
280 \e[1mimap
\e[22mDefault global IMAP server. Arguments are: "host user pass [-i
281 interval (in seconds)] [-f folder] [-p port] [-e command] [-r
282 retries]". Default port is 143, default folder is 'INBOX', de‐
283 fault interval is 5 minutes, and default number of retries be‐
284 fore giving up is 5. If the password is supplied as '*', you
285 will be prompted to enter the password when Conky starts.
289 Mail spool for mail checking
292 \e[1mmax_port_monitor_connections
\e[0m
293 Allow each port monitor to track at most this many connections
294 (if 0 or not set, default is 256)
297 \e[1mmax_specials
\e[0m
298 Maximum number of special things, e.g. fonts, offsets, aligns,
299 etc. (default is 512)
302 \e[1mmax_user_text bytes
\e[0m
303 Maximum size of user text buffer, i.e. layout below TEXT line in
304 config file (default is 16384 bytes)
307 \e[1mtext_buffer_size bytes
\e[0m
308 Size of the standard text buffer (default is 256 bytes). This
309 buffer is used for intermediary text, such as individual lines,
310 output from $exec vars, and various other variables. Increasing
311 the size of this buffer can drastically reduce Conky's perfor‐
312 mance, but will allow for more text display per variable. The
313 size of this buffer cannot be smaller than the default value of
317 \e[1mmaximum_width pixels
\e[0m
318 Maximum width of window
321 \e[1mminimum_size width (height)
\e[0m
322 Minimum size of window
333 \e[1mmpd_password
\e[0m
337 \e[1mmusic_player_interval
\e[0m
338 Music player thread update interval (defaults to Conky's update
342 \e[1mnet_avg_samples
\e[0m
343 The number of samples to average for net data
347 Substract (file system) buffers from used memory?
350 \e[1moverride_utf8_locale
\e[0m
351 Force UTF8? requires XFT
355 Boolean, create own window to draw?
358 \e[1mown_window_class
\e[0m
359 Manually set the WM_CLASS name. Defaults to "Conky".
362 \e[1mown_window_colour colour
\e[0m
363 If own_window_transparent no, set a specified background colour
364 (defaults to black). Takes either a hex value (#ffffff) or a
365 valid RGB name (see /usr/lib/X11/rgb.txt)
368 \e[1mown_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager
\e[0m
369 If own_window is yes, you may use these window manager hints to
370 affect the way Conky displays. Notes: Use own_window_type desk‐
371 top as another way to implement many of these hints implicitly.
372 If you use own_window_type override, window manager hints have
373 no meaning and are ignored.
376 \e[1mown_window_title
\e[0m
377 Manually set the window name. Defaults to "<hostname> - conky".
380 \e[1mown_window_transparent
\e[0m
381 Boolean, set pseudo-transparency?
384 \e[1mown_window_type
\e[0m
385 if own_window is yes, you may specify type normal, desktop, dock
386 or override (default: normal). Desktop windows are special win‐
387 dows that have no window decorations; are always visible on your
388 desktop; do not appear in your pager or taskbar; and are sticky
389 across all workspaces. Override windows are not under the con‐
390 trol of the window manager. Hints are ignored. This type of win‐
391 dow can be useful for certain situations.
394 \e[1mout_to_console
\e[0m
395 Print text to stdout.
398 \e[1mout_to_stderr
\e[0m
399 Print text to stderr.
403 When set to no, there will be no output in X (useful when you
404 also use things like out_to_console). If you set it to no, make
405 sure that it's placed before all other X-related setting (take
406 the first line of your configfile to be sure). Default value is
410 \e[1moverwrite_file
\e[0m
411 Overwrite the file given as argument.
414 \e[1mappend_file
\e[0m
415 Append the file given as argument.
418 \e[1mpad_percents
\e[0m
419 Pad percentages to this many decimals (0 = no padding)
422 \e[1mpop3
\e[22mDefault global POP3 server. Arguments are: "host user pass [-i
423 interval (in seconds)] [-p port] [-e command] [-r retries]". De‐
424 fault port is 110, default interval is 5 minutes, and default
425 number of retries before giving up is 5. If the password is sup‐
426 plied as '*', you will be prompted to enter the password when
430 \e[1mshort_units
\e[0m
431 Shortens units to a single character (kiB->k, GiB->G, etc.). De‐
435 \e[1mshow_graph_scale
\e[0m
436 Shows the maximum value in scaled graphs.
439 \e[1mshow_graph_range
\e[0m
440 Shows the time range covered by a graph.
443 \e[1mstippled_borders
\e[0m
444 Border stippling (dashing) in pixels
447 \e[1mtemperature_unit
\e[0m
448 Desired output unit of all objects displaying a temperature.
449 Parameters are either "fahrenheit" or "celsius". The default
450 unit is degree Celsius.
454 Define a template for later use inside TEXT segments. Substitute
455 N by a digit between 0 and 9, inclusively. The value of the
456 variable is being inserted into the stuff below TEXT at the cor‐
457 responding position, but before some substitutions are applied:
462 '\N' -> template argument N
465 \e[1mtotal_run_times
\e[0m
466 Total number of times for Conky to update before quitting. Zero
467 makes Conky run forever
470 \e[1mupdate_interval
\e[0m
471 Update interval in seconds
475 Boolean value, if true, text is rendered in upper case
479 Adds spaces around certain objects to stop them from moving oth‐
480 er things around. Arguments are left, right, and none (default).
481 The old true/false values are deprecated and default to
482 right/none respectively. Note that this only helps if you are
483 using a mono font, such as Bitstream Vera Sans Mono.
487 Use Xft (anti-aliased font and stuff)
491 Alpha of Xft font. Must be a value at or between 1 and 0.
498 \e[1mTEXT
\e[22mAfter this begins text to be formatted on screen. Backslash (\)
499 escapes newlines in the text section. This can be useful for
500 cleaning up config files where conky is used to pipe input to
505 Colors are parsed using XParsecolor(), there might be a list of them:
506 /usr/share/X11/rgb.txt. Also, ⟨http://sedition.com/perl/rgb.html⟩.
507 Color can be also in #rrggbb format (hex).
509 \e[1maddr interface
\e[0m
510 IP address for an interface, or "No Address" if no address is
514 \e[1maddrs interface
\e[0m
515 IP addresses for an interface (if one - works like addr). Linux
519 \e[1macpiacadapter
\e[0m
520 ACPI ac adapter state.
528 ACPI temperature in C.
532 CPU temperature from therm_adt746x
536 Fan speed from therm_adt746x
539 \e[1malignr (num)
\e[0m
540 Right-justify text, with space of N
543 \e[1malignc (num)
\e[0m
547 \e[1mapm_adapter
\e[0m
548 Display APM AC adapter status (FreeBSD only)
551 \e[1mapm_battery_life
\e[0m
552 Display APM battery life in percent (FreeBSD only)
555 \e[1mapm_battery_time
\e[0m
556 Display remaining APM battery life in hh:mm:ss or "unknown" if
557 AC adapterstatus is on-line or charging (FreeBSD only)
560 \e[1maudacious_bar (height),(width)
\e[0m
564 \e[1maudacious_bitrate
\e[0m
565 Bitrate of current tune
568 \e[1maudacious_channels
\e[0m
569 Number of audio channels of current tune
572 \e[1maudacious_filename
\e[0m
573 Full path and filename of current tune
576 \e[1maudacious_frequency
\e[0m
577 Sampling frequency of current tune
580 \e[1maudacious_length
\e[0m
581 Total length of current tune as MM:SS
584 \e[1maudacious_length_seconds
\e[0m
585 Total length of current tune in seconds
588 \e[1maudacious_playlist_position
\e[0m
589 Playlist position of current tune
592 \e[1maudacious_playlist_length
\e[0m
593 Number of tunes in playlist
596 \e[1maudacious_position
\e[0m
597 Position of current tune (MM:SS)
600 \e[1maudacious_position_seconds
\e[0m
601 Position of current tune in seconds
604 \e[1maudacious_status
\e[0m
605 Player status (Playing/Paused/Stopped/Not running)
608 \e[1maudacious_title (max length)
\e[0m
609 Title of current tune with optional maximum length specifier
612 \e[1maudacious_main_volume
\e[0m
613 The current volume fetched from Audacious
616 \e[1mbattery (num)
\e[0m
617 Battery status and remaining percentage capacity of ACPI or APM
618 battery. ACPI battery number can be given as argument (default
622 \e[1mbattery_short (num)
\e[0m
623 Battery status and remaining percentage capacity of ACPI or APM
624 battery. ACPI battery number can be given as argument (default
625 is BAT0). This mode display a short status, which means that C
626 is displayed instead of charging and D is displayed instead of
630 \e[1mbattery_bar (height),(width) (num)
\e[0m
631 Battery percentage remaining of ACPI battery in a bar. ACPI bat‐
632 tery number can be given as argument (default is BAT0).
635 \e[1mbattery_percent (num)
\e[0m
636 Battery percentage remaining for ACPI battery. ACPI battery num‐
637 ber can be given as argument (default is BAT0).
640 \e[1mbattery_time (num)
\e[0m
641 Battery charge/discharge time remaining of ACPI battery. ACPI
642 battery number can be given as argument (default is BAT0).
645 \e[1mbmpx_artist
\e[0m
646 Artist in current BMPx track
650 Album in current BMPx track
654 Title of the current BMPx track
658 Track number of the current BMPx track
661 \e[1mbmpx_bitrate
\e[0m
662 Bitrate of the current BMPx track
666 URI of the current BMPx track
670 Amount of memory buffered
673 \e[1mcached
\e[22mAmount of memory cached
676 \e[1mcolor (color)
\e[0m
677 Change drawing color to color
680 \e[1mcolorN
\e[22mChange drawing color to colorN configuration option, where N is
681 a digit between 0 and 9, inclusively.
684 \e[1mcombine var1 var2
\e[0m
685 Places the lines of var2 to the right of the lines of var1
686 seperated by the chars that are put between var1 and var2. For
687 example: ${combine ${head /proc/cpuinfo 2} - ${head /proc/memin‐
688 fo 1}} gives as output "cpuinfo_line1 - meminfo_line1" on line 1
689 and "cpuinfo_line2 -" on line 2. $combine vars can also be nest‐
690 ed to place more vars next to each other.
693 \e[1mconky_version
\e[0m
697 \e[1mconky_build_date
\e[0m
701 \e[1mconky_build_arch
\e[0m
702 CPU architecture Conky was built for
706 CPU usage in percents. For SMP machines, the CPU number can be
707 provided as an argument. ${cpu cpu0} is the total usage, and
708 ${cpu cpuX} (X >= 1) are individual CPUs.
711 \e[1mcpubar (cpuN) (height),(width)
\e[0m
712 Bar that shows CPU usage, height is bar's height in pixels. See
713 $cpu for more info on SMP.
716 \e[1mcpugauge (cpuN) (height),(width)
\e[0m
717 Elliptical gauge that shows CPU usage, height and width are
718 gauge's vertical and horizontal axis respectively. See $cpu for
722 \e[1mcpugraph (cpuN) ("normal"|"log") (height),(width) (gradient colour 1)
\e[0m
723 \e[1m(gradient colour 2) (scale)
\e[0m
724 CPU usage graph, with optional colours in hex, minus the #. See
725 $cpu for more info on SMP. Uses a logarithmic scale (to see
726 small numbers) when you use "log" instead of "normal".
729 \e[1mdiskio (device)
\e[0m
730 Displays current disk IO. Device is optional, and takes the form
731 of sda for /dev/sda. Individual partitions are allowed.
734 \e[1mdiskiograph ("normal"|"log") (height),(width) (gradient colour 1) (gra‐
\e[0m
735 \e[1mdient colour 2) (scale) (device)
\e[0m
736 Disk IO graph, colours defined in hex, minus the #. If scale is
737 non-zero, it becomes the scale for the graph. Uses a logarithmic
738 scale (to see small numbers) when you use "log" instead of "nor‐
742 \e[1mdiskio_read (device)
\e[0m
743 Displays current disk IO for reads. Device as in diskio.
746 \e[1mdiskiograph_read ("normal"|"log") (height),(width) (gradient colour 1)
\e[0m
747 \e[1m(gradient colour 2) (scale) (device)
\e[0m
748 Disk IO graph for reads, colours defined in hex, minus the #. If
749 scale is non-zero, it becomes the scale for the graph. Device as
750 in diskio. Uses a logarithmic scale (to see small numbers) when
751 you use "log" instead of "normal".
754 \e[1mdiskio_write (device)
\e[0m
755 Displays current disk IO for writes. Device as in diskio.
758 \e[1mdiskiograph_write ("normal"|"log") (height),(width) (gradient colour 1)
\e[0m
759 \e[1m(gradient colour 2) (scale) (device)
\e[0m
760 Disk IO graph for writes, colours defined in hex, minus the #.
761 If scale is non-zero, it becomes the scale for the graph. Device
762 as in diskio. Uses a logarithmic scale (to see small numbers)
763 when you use "log" instead of "normal".
766 \e[1mdisk_protect device
\e[0m
767 Disk protection status, if supported (needs kernel-patch).
768 Prints either "frozen" or "free " (note the padding).
771 \e[1mdownspeed net
\e[0m
772 Download speed in KiB
775 \e[1mdownspeedf net
\e[0m
776 Download speed in KiB with one decimal
779 \e[1mdownspeedgraph ("normal"|"log") (height),(width) (gradient colour 1)
\e[0m
780 \e[1m(gradient colour 2) (scale) (net)
\e[0m
781 Download speed graph, colours defined in hex, minus the #. If
782 scale is non-zero, it becomes the scale for the graph. Uses a
783 logarithmic scale (to see small numbers) when you use "log" in‐
787 \e[1melse
\e[22mText to show if any of the above are not true
790 \e[1mentropy_avail
\e[0m
791 Current entropy available for crypto freaks
794 \e[1mentropy_bar (height),(width)
\e[0m
795 Normalized bar of available entropy for crypto freaks
798 \e[1mentropy_poolsize
\e[0m
799 Total size of system entropy pool for crypto freaks
802 \e[1meval string
\e[0m
803 Evalutates given string according to the rules of TEXT interpre‐
804 tation, i.e. parsing any contained text object specifications
805 into their output, any occuring '$$' into a single '$' and so
806 on. The output is then being parsed again.
809 \e[1mexec command
\e[0m
810 Executes a shell command and displays the output in conky. warn‐
811 ing: this takes a lot more resources than other variables. I'd
812 recommend coding wanted behaviour in C and posting a patch.
815 \e[1mexecbar command
\e[0m
816 Same as exec, except if the first value return is a value be‐
817 tween 0-100, it will use that number for a bar. The size for
818 bars can be controlled via the default_bar_size config setting.
821 \e[1mexecgauge command
\e[0m
822 Same as exec, except if the first value returned is a value be‐
823 tween 0-100, it will use that number for a gauge. The size for
824 gauges can be controlled via the default_gauge_size config set‐
828 \e[1mexecgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐
\e[0m
829 \e[1ment colour 2) (scale) command
\e[0m
830 Same as execbar, but graphs values. Uses a logaritmic scale when
831 the log option is given (to see small numbers). Values still
832 have to be between 0 and 100. The size for graphs can be con‐
833 trolled via the default_graph_size config setting.
836 \e[1mexeci interval command
\e[0m
837 Same as exec but with specific interval. Interval can't be less
838 than update_interval in configuration. See also $texeci
841 \e[1mexecibar interval command
\e[0m
842 Same as execbar, except with an interval
845 \e[1mexecigraph interval command
\e[0m
846 Same as execgraph, but takes an interval arg and graphs values.
849 \e[1mexecigauge interval command
\e[0m
850 Same as execgauge, but takes an interval arg and gauges values.
853 \e[1mexecp command
\e[0m
854 Executes a shell command and displays the output in conky. warn‐
855 ing: this takes a lot more resources than other variables. I'd
856 recommend coding wanted behaviour in C and posting a patch. This
857 differs from $exec in that it parses the output of the command,
858 so you can insert things like ${color red}hi!${color} in your
859 script and have it correctly parsed by Conky. Caveats: Conky
860 parses and evaluates the output of $execp every time Conky
861 loops, and then destroys all the objects. If you try to use any‐
862 thing like $execi within an $execp statement, it will function‐
863 ally run at the same interval that the $execp statement runs, as
864 it is created and destroyed at every interval.
867 \e[1mexecpi interval command
\e[0m
868 Same as execp but with specific interval. Interval can't be less
869 than update_interval in configuration. Note that the output from
870 the $execpi command is still parsed and evaluated at every in‐
874 \e[1mfont (font)
\e[0m
875 Specify a different font. This new font will apply to the cur‐
876 rent line and everything following. You can use a $font with no
877 arguments to change back to the default font (much like with
882 Returns CPU #n's frequency in MHz. CPUs are counted from 1. If
883 omitted, the parameter defaults to 1.
887 Returns CPU #n's frequency in GHz. CPUs are counted from 1. If
888 omitted, the parameter defaults to 1.
891 \e[1mfs_bar (height),(width) fs
\e[0m
892 Bar that shows how much space is used on a file system. height
893 is the height in pixels. fs is any file on that file system.
896 \e[1mfs_bar_free (height),(width) fs
\e[0m
897 Bar that shows how much space is free on a file system. height
898 is the height in pixels. fs is any file on that file system.
901 \e[1mfs_free (fs)
\e[0m
902 Free space on a file system available for users.
905 \e[1mfs_free_perc (fs)
\e[0m
906 Free percentage of space on a file system available for users.
909 \e[1mfs_size (fs)
\e[0m
913 \e[1mfs_type (fs)
\e[0m
917 \e[1mfs_used (fs)
\e[0m
918 File system used space.
921 \e[1mfs_used_perc (fs)
\e[0m
922 Percent of file system used space.
925 \e[1mgoto x
\e[22mThe next element will be printed at position 'x'.
929 Displays the default route's interface or "multiple"/"none" ac‐
933 \e[1mgw_ip
\e[22mDisplays the default gateway's IP or "multiple"/"none" accord‐
937 \e[1mhddtemp dev, (host,(port))
\e[0m
938 Displays temperature of a selected hard disk drive as reported
939 by the hddtemp daemon running on host:port. Default host is
940 127.0.0.1, default port is 7634.
943 \e[1mhead logfile lines (interval)
\e[0m
944 Displays first N lines of supplied text text file. If interval
945 is not supplied, Conky assumes 2x Conky's interval. Max of 30
946 lines can be displayed, or until the text buffer is filled.
949 \e[1mhr (height)
\e[0m
950 Horizontal line, height is the height in pixels
953 \e[1mhwmon (dev) type n
\e[0m
954 Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omit‐
955 ted if you have only one hwmon device. Parameter type is either
956 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning
957 temperature. Parameter n is number of the sensor. See
958 /sys/class/hwmon/ on your local computer.
961 \e[1miconv_start codeset_from codeset_to
\e[0m
962 Convert text from one codeset to another using GNU iconv. Needs
963 to be stopped with iconv_stop.
967 Stop iconv codeset conversion.
970 \e[1mi2c (dev) type n
\e[0m
971 I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted
972 if you have only one I2C device. Parameter type is either 'in'
973 or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning tem‐
974 perature. Parameter n is number of the sensor. See
975 /sys/bus/i2c/devices/ on your local computer.
978 \e[1mi8k_ac_status
\e[0m
979 If running the i8k kernel driver for Inspiron laptops, displays
980 whether ac power is on, as listed in /proc/i8k (translated to
981 human-readable). Beware that this is by default not enabled by
986 If running the i8k kernel driver for Inspiron laptops, displays
987 the bios version as listed in /proc/i8k.
990 \e[1mi8k_buttons_status
\e[0m
991 If running the i8k kernel driver for Inspiron laptops, displays
992 the volume buttons status as listed in /proc/i8k.
995 \e[1mi8k_cpu_temp
\e[0m
996 If running the i8k kernel driver for Inspiron laptops, displays
997 the cpu temperature in Celsius, as reported by /proc/i8k.
1000 \e[1mi8k_left_fan_rpm
\e[0m
1001 If running the i8k kernel driver for Inspiron laptops, displays
1002 the left fan's rate of rotation, in revolutions per minute as
1003 listed in /proc/i8k. Beware, some laptops i8k reports these fans
1007 \e[1mi8k_left_fan_status
\e[0m
1008 If running the i8k kernel driver for Inspiron laptops, displays
1009 the left fan status as listed in /proc/i8k (translated to human-
1010 readable). Beware, some laptops i8k reports these fans in re‐
1014 \e[1mi8k_right_fan_rpm
\e[0m
1015 If running the i8k kernel driver for Inspiron laptops, displays
1016 the right fan's rate of rotation, in revolutions per minute as
1017 listed in /proc/i8k. Beware, some laptops i8k reports these fans
1021 \e[1mi8k_right_fan_status
\e[0m
1022 If running the i8k kernel driver for Inspiron laptops, displays
1023 the right fan status as listed in /proc/i8k (translated to hu‐
1024 man-readable). Beware, some laptops i8k reports these fans in
1028 \e[1mi8k_serial
\e[0m
1029 If running the i8k kernel driver for Inspiron laptops, displays
1030 your laptop serial number as listed in /proc/i8k.
1033 \e[1mi8k_version
\e[0m
1034 If running the i8k kernel driver for Inspiron laptops, displays
1035 the version formatting of /proc/i8k.
1039 If running the IBM ACPI, displays the fan speed.
1042 \e[1mibm_temps N
\e[0m
1043 If running the IBM ACPI, displays the temperatures from the IBM
1044 temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
1048 \e[1mibm_volume
\e[0m
1049 If running the IBM ACPI, displays the "master" volume, con‐
1050 trolled by the volume keys (0-14).
1053 \e[1mibm_brightness
\e[0m
1054 If running the IBM ACPI, displays the brigtness of the laptops's
1058 \e[1mif_empty (var)
\e[0m
1059 if conky variable VAR is empty, display everything between
1060 $if_empty and the matching $endif
1063 \e[1mif_existing file (string)
\e[0m
1064 if FILE exists, display everything between if_existing and the
1065 matching $endif. The optional second paramater checks for FILE
1066 containing the specified string and prints everything between
1067 $if_existing and the matching $endif.
1070 \e[1mif_gw
\e[22mif there is at least one default gateway, display everything be‐
1071 tween $if_gw and the matching $endif
1074 \e[1mif_match expression
\e[0m
1075 Evaluates the given boolean expression, printing everything be‐
1076 tween $if_match and the matching $endif depending on whether the
1077 evaluation returns true or not. Valid expressions consist of a
1078 left side, an operator and a right side. Left and right sides
1079 are being parsed for contained text objects before evaluation.
1080 Recognised left and right side types are:
1082 \e[1mdouble
\e[22m: argument consists of only digits and a single dot.
1083 \e[1mlong
\e[22m: argument consists of only digits.
1084 \e[1mstring
\e[22m: argument is enclosed in quotation mark or the checks for
1085 double and long failed before.
1087 Valid operands are: '>', '<', '>=', '<=', '==', '!='.
1090 \e[1mif_mixer_mute (mixer)
\e[0m
1091 If mixer exists, display everything between $if_mixer_mute and
1092 the matching $endif. If no mixer is specified, "Master" is used.
1095 \e[1mif_running (process)
\e[0m
1096 if PROCESS is running, display everything $if_running and the
1097 matching $endif. This uses the ``pidof'' command, so the -x
1098 switch is also supported.
1101 \e[1mif_mounted (mountpoint)
\e[0m
1102 if MOUNTPOINT is mounted, display everything between $if_mounted
1103 and the matching $endif
1106 \e[1mif_smapi_bat_installed (INDEX)
\e[0m
1107 when using smapi, if the battery with index INDEX is installed,
1108 display everything between $if_smapi_bat_installed and the
1112 \e[1mif_up (interface)
\e[0m
1113 if INTERFACE exists and is up, display everything between $if_up
1114 and the matching $endif
1117 \e[1mif_updatenr (updatenr)
\e[0m
1118 If it's the UPDATENR-th time that conky updates, display every‐
1119 thing between $if_updatenr and the matching $endif. The counter
1120 resets when the highest UPDATENR is reached. Example :
1121 "{$if_updatenr 1}foo$endif{$if_updatenr 2}bar$endif{$if_updatenr
1122 4}$endif" shows foo 25% of the time followed by bar 25% of the
1123 time followed by nothing the other half of the time.
1126 \e[1mimap_messages (args)
\e[0m
1127 Displays the number of messages in your global IMAP inbox by de‐
1128 fault. You can define individual IMAP inboxes seperately by
1129 passing arguments to this object. Arguments are: "host user pass
1130 [-i interval (in seconds)] [-f folder] [-p port] [-e command]
1131 [-r retries]". Default port is 143, default folder is 'INBOX',
1132 default interval is 5 minutes, and default number of retries be‐
1133 fore giving up is 5. If the password is supplied as '*', you
1134 will be prompted to enter the password when Conky starts.
1137 \e[1mimap_unseen (args)
\e[0m
1138 Displays the number of unseen messages in your global IMAP inbox
1139 by default. You can define individual IMAP inboxes seperately by
1140 passing arguments to this object. Arguments are: "host user pass
1141 [-i interval (in seconds)] [-f folder] [-p port] [-e command]
1142 [-r retries]". Default port is 143, default folder is 'INBOX',
1143 default interval is 5 minutes, and default number of retries be‐
1144 fore giving up is 5. If the password is supplied as '*', you
1145 will be prompted to enter the password when Conky starts.
1148 \e[1mioscheduler disk
\e[0m
1149 Prints the current ioscheduler used for the given disk name
1150 (i.e. e.g. "hda" or "sdb")
1153 \e[1mkernel
\e[22mKernel version
1156 \e[1mlaptop_mode
\e[0m
1157 The value of /proc/sys/vm/laptop_mode
1161 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
1162 5 minutes and 3 for past 15 minutes.
1165 \e[1mloadgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐
\e[0m
1166 \e[1ment colour 2) (scale)
\e[0m
1167 Load1 average graph, similar to xload, with optional colours in
1168 hex, minus the #. Uses a logarithmic scale (to see small num‐
1169 bers) when you use "log" instead of "normal".
1172 \e[1mlines textfile
\e[0m
1173 Displays the number of lines in the given file
1177 Machine, i686 for example
1180 \e[1mmails (mailbox) (interval)
\e[0m
1181 Mail count in the specified mailbox or your mail spool if not.
1182 Both mbox and maildir type mailboxes are supported. You can use
1183 a program like fetchmail to get mails from some server using
1184 your favourite protocol. See also new_mails.
1187 \e[1mnew_mails (mailbox) (interval)
\e[0m
1188 Unread mail count in the specified mailbox or mail spool if not.
1189 Both mbox and maildir type mailboxes are supported.
1192 \e[1mseen_mails (maildir) (interval)
\e[0m
1193 Number of mails marked as seen in the specified mailbox or mail
1194 spool if not. Only maildir type mailboxes are supported, mbox
1195 type will return -1.
1198 \e[1munseen_mails (maildir) (interval)
\e[0m
1199 Number of new or unseen mails in the specified mailbox or mail
1200 spool if not. Only maildir type mailboxes are supported, mbox
1201 type will return -1.
1204 \e[1mflagged_mails (maildir) (interval)
\e[0m
1205 Number of mails marked as flagged in the specified mailbox or
1206 mail spool if not. Only maildir type mailboxes are supported,
1207 mbox type will return -1.
1210 \e[1munflagged_mails (maildir) (interval)
\e[0m
1211 Number of mails not marked as flagged in the specified mailbox
1212 or mail spool if not. Only maildir type mailboxes are supported,
1213 mbox type will return -1.
1216 \e[1mforwarded_mails (maildir) (interval)
\e[0m
1217 Number of mails marked as forwarded in the specified mailbox or
1218 mail spool if not. Only maildir type mailboxes are supported,
1219 mbox type will return -1.
1222 \e[1munforwarded_mails (maildir) (interval)
\e[0m
1223 Number of mails not marked as forwarded in the specified mailbox
1224 or mail spool if not. Only maildir type mailboxes are supported,
1225 mbox type will return -1.
1228 \e[1mreplied_mails (maildir) (interval)
\e[0m
1229 Number of mails marked as replied in the specified mailbox or
1230 mail spool if not. Only maildir type mailboxes are supported,
1231 mbox type will return -1.
1234 \e[1munreplied_mails (maildir) (interval)
\e[0m
1235 Number of mails not marked as replied in the specified mailbox
1236 or mail spool if not. Only maildir type mailboxes are supported,
1237 mbox type will return -1.
1240 \e[1mdraft_mails (maildir) (interval)
\e[0m
1241 Number of mails marked as draft in the specified mailbox or mail
1242 spool if not. Only maildir type mailboxes are supported, mbox
1243 type will return -1.
1246 \e[1mtrashed_mails (maildir) (interval)
\e[0m
1247 Number of mails marked as trashed in the specified mailbox or
1248 mail spool if not. Only maildir type mailboxes are supported,
1249 mbox type will return -1.
1252 \e[1mmboxscan (-n number of messages to print) (-fw from width) (-sw subject
\e[0m
1253 \e[1mwidth) mbox
\e[0m
1254 Print a summary of recent messages in an mbox format mailbox.
1255 mbox parameter is the filename of the mailbox (can be encapsu‐
1256 lated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
1259 \e[1mmem
\e[22mAmount of memory in use
1262 \e[1mmembar (height),(width)
\e[0m
1263 Bar that shows amount of memory in use
1266 \e[1mmemgauge (height),(width)
\e[0m
1267 Gauge that shows amount of memory in use (see cpugauge)
1270 \e[1mmemgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐
\e[0m
1271 \e[1ment colour 2) (scale)
\e[0m
1272 Memory usage graph. Uses a logarithmic scale (to see small num‐
1273 bers) when you use "log" instead of "normal".
1276 \e[1mmemeasyfree
\e[0m
1277 Amount of free memory including the memory that is very easily
1278 freed (buffers/cache)
1282 Amount of free memory
1285 \e[1mmemmax
\e[22mTotal amount of memory
1289 Percentage of memory in use
1292 \e[1mmixer (device)
\e[0m
1293 Prints the mixer value as reported by the OS. Default mixer is
1294 "vol", but you can specify one of the following optional argu‐
1295 ments: "vol", "bass", "treble", "synth", "pcm", "speaker",
1296 "line", "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain",
1297 "line1", "line2", "line3", "dig1", "dig2", "dig3", "phin",
1298 "phout", "video", "radio", "monitor". Refer to the definition of
1299 SOUND_DEVICE_NAMES in <linux/soundcard.h> (on Linux), <sound‐
1300 card.h> (on OpenBSD), or <sys/soundcard.h> to find the exact op‐
1301 tions available on your system.
1304 \e[1mmixerbar (device)
\e[0m
1305 Displays mixer value in a bar as reported by the OS. See docs
1306 for $mixer for details on arguments.
1309 \e[1mmixerr (device)
\e[0m
1310 Prints the right channel mixer value as reported by the OS. See
1311 docs for $mixer for details on arguments.
1314 \e[1mmixerrbar (device)
\e[0m
1315 Displays the right channel mixer value in a bar as reported by
1316 the OS. See docs for $mixer for details on arguments.
1319 \e[1mmixerl (device)
\e[0m
1320 Prints the left channel mixer value as reported by the OS. See
1321 docs for $mixer for details on arguments.
1324 \e[1mmixerlbar (device)
\e[0m
1325 Displays the left channel mixer value in a bar as reported by
1326 the OS. See docs for $mixer for details on arguments.
1330 Current state of MOC; playing, stopped etc.
1334 File name of the current MOC song
1338 Title of the current MOC song
1341 \e[1mmoc_artist
\e[0m
1342 Artist of the current MOC song
1346 The current song name being played in MOC.
1350 Album of the current MOC song
1353 \e[1mmoc_totaltime
\e[0m
1354 Total length of the current MOC song
1357 \e[1mmoc_timeleft
\e[0m
1358 Time left in the current MOC song
1361 \e[1mmoc_curtime
\e[0m
1362 Current time of the current MOC song
1365 \e[1mmoc_bitrate
\e[0m
1366 Bitrate in the current MOC song
1370 Rate of the current MOC song
1374 Number of the monitor on which conky is running
1377 \e[1mmonitor_number
\e[0m
1381 \e[1mmpd_artist
\e[0m
1382 Artist in current MPD song must be enabled at compile
1386 Album in current MPD song
1389 \e[1mmpd_bar (height),(width)
\e[0m
1390 Bar of mpd's progress
1393 \e[1mmpd_bitrate
\e[0m
1394 Bitrate of current song
1397 \e[1mmpd_status
\e[0m
1398 Playing, stopped, et cetera.
1401 \e[1mmpd_title (max length)
\e[0m
1402 Title of current MPD song
1409 \e[1mmpd_elapsed
\e[0m
1413 \e[1mmpd_length
\e[0m
1417 \e[1mmpd_percent
\e[0m
1418 Percent of song's progress
1421 \e[1mmpd_random
\e[0m
1422 Random status (On/Off)
1425 \e[1mmpd_repeat
\e[0m
1426 Repeat status (On/Off)
1430 Prints the MPD track field
1434 Prints the MPD name field
1438 Prints the file name of the current MPD song
1441 \e[1mmpd_smart (max length)
\e[0m
1442 Prints the song name in either the form "artist - title" or file
1443 name, depending on whats available
1446 \e[1mif_mpd_playing
\e[0m
1447 if mpd is playing or paused, display everything between
1448 $if_mpd_playing and the matching $endif
1451 \e[1mnameserver (index)
\e[0m
1452 Print a nameserver from /etc/resolv.conf. Index starts at and
1460 \e[1mnvidia threshold temp ambient gpufreq memfreq imagequality
\e[0m
1461 Nvidia graficcard support for the XNVCtrl library. Each option
1462 can be shortened to the least significant part. Temperatures
1463 are printed as float, all other values as integer.
1465 \e[1mthreshold
\e[22m: the thresholdtemperature at which the gpu slows down
1466 \e[1mtemp
\e[22m: gives the gpu current temperature
1467 \e[1mambient
\e[22m: gives current air temperature near GPU case
1468 \e[1mgpufreq
\e[22m: gives the current gpu frequency
1469 \e[1mmemfreq
\e[22m: gives the current mem frequency
1470 \e[1mimagequality
\e[22m: which imagequality should be choosen by OpenGL ap‐
1474 \e[1moutlinecolor (color)
\e[0m
1475 Change outline color
1478 \e[1mpb_battery item
\e[0m
1479 If running on Apple powerbook/ibook, display information on bat‐
1480 tery status. The item parameter specifies, what information to
1481 display. Exactly one item must be specified. Valid items are:
1483 \e[1mstatus
\e[22m: Display if battery is fully charged, charging, discharg‐
1484 ing or absent (running on AC)
1485 \e[1mpercent
\e[22m: Display charge of battery in percent, if charging or
1486 discharging. Nothing will be displayed, if battery is fully
1488 \e[1mtime
\e[22m: Display the time remaining until the battery will be fully
1489 charged or discharged at current rate. Nothing is displayed, if
1490 battery is absent or if it's present but fully charged and not
1494 \e[1mplatform (dev) type n
\e[0m
1495 Platform sensor from sysfs (Linux 2.6). Parameter dev may be
1496 omitted if you have only one platform device. Platform type is
1497 either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp'
1498 meaning temperature. Parameter n is number of the sensor. See
1499 /sys/bus/platform/devices/ on your local computer.
1502 \e[1mpop3_unseen (args)
\e[0m
1503 Displays the number of unseen messages in your global POP3 inbox
1504 by default. You can define individual POP3 inboxes seperately by
1505 passing arguments to this object. Arguments are: "host user pass
1506 [-i interval (in seconds)] [-p port] [-e command] [-r retries]".
1507 Default port is 110, default interval is 5 minutes, and default
1508 number of retries before giving up is 5. If the password is sup‐
1509 plied as '*', you will be prompted to enter the password when
1513 \e[1mpop3_used (args)
\e[0m
1514 Displays the amount of space (in MiB, 2^20) used in your global
1515 POP3 inbox by default. You can define individual POP3 inboxes
1516 seperately by passing arguments to this object. Arguments are:
1517 "host user pass [-i interval (in seconds)] [-p port] [-e com‐
1518 mand] [-r retries]". Default port is 110, default interval is 5
1519 minutes, and default number of retries before giving up is 5. If
1520 the password is supplied as '*', you will be prompted to enter
1521 the password when Conky starts.
1524 \e[1mpre_exec shell command
\e[0m
1525 Executes a shell command one time before conky displays anything
1526 and puts output as text.
1530 Total processes (sleeping and running)
1533 \e[1mrunning_processes
\e[0m
1534 Running processes (not sleeping), requires Linux 2.6
1537 \e[1mscroll length (step) text
\e[0m
1538 Scroll 'text' by 'step' characters showing 'length' number of
1539 characters at the same time. The text may also contain vari‐
1540 ables. 'step' is optional and defaults to 1 if not set. If a var
1541 creates output on multiple lines then the lines are placed be‐
1542 hind each other separated with a '|'-sign. Do NOT use vars that
1543 change colors or otherwise affect the design inside a scrolling
1544 text. If you want spaces between the start and the end of
1545 'text', place them at the end of 'text' not at the front ("foo‐
1546 bar" and " foobar" can both generate "barfoo" but "foobar " will
1547 keep the spaces like this "bar foo").
1550 \e[1mshadecolor (color)
\e[0m
1551 Change shading color
1554 \e[1msmapi (ARGS)
\e[0m
1555 when using smapi, display contents of the /sys/devices/plat‐
1556 form/smapi directory. ARGS are either '(FILENAME)' or 'bat (IN‐
1557 DEX) (FILENAME)' to display the corresponding files' content.
1558 This is a very raw method of accessing the smapi values. When
1559 available, better use one of the smapi_* variables instead.
1562 \e[1msmapi_bat_bar (INDEX),(height),(width)
\e[0m
1563 when using smapi, display the remaining capacity of the battery
1564 with index INDEX as a bar.
1567 \e[1msmapi_bat_perc (INDEX)
\e[0m
1568 when using smapi, display the remaining capacity in percent of
1569 the battery with index INDEX. This is a separate variable be‐
1570 cause it supports the 'use_spacer' configuration option.
1573 \e[1msmapi_bat_power INDEX
\e[0m
1574 when using smapi, display the current power of the battery with
1575 index INDEX in watt. This is a separate variable because the
1576 original read out value is being converted from mW. The sign of
1577 the output reflects charging (positive) or discharging (nega‐
1581 \e[1msmapi_bat_temp INDEX
\e[0m
1582 when using smapi, display the current temperature of the battery
1583 with index INDEX in degree Celsius. This is a separate variable
1584 because the original read out value is being converted from mil‐
1588 \e[1mstippled_hr (space)
\e[0m
1589 Stippled (dashed) horizontal line
1592 \e[1mswapbar (height),(width)
\e[0m
1593 Bar that shows amount of swap in use
1596 \e[1mswap
\e[22mAmount of swap in use
1600 Total amount of swap
1604 Percentage of swap in use
1608 System name, Linux for example
1611 \e[1mtcp_portmon port_begin port_end item (index)
\e[4m
\e[22m(ip4
\e[24m
\e[4monly
\e[24m
\e[4mat
\e[24m
\e[4mpresent)
\e[0m
1612 TCP port monitor for specified local ports. Port numbers must be
1613 in the range 1 to 65535. Valid items are:
1615 \e[1mcount
\e[22m- total number of connections in the range
1616 \e[1mrip
\e[22m- remote ip address
1617 \e[1mrhost
\e[22m- remote host name
1618 \e[1mrport
\e[22m- remote port number
1619 \e[1mrservice
\e[22m- remote service name from /etc/services
1620 \e[1mlip
\e[22m- local ip address
1621 \e[1mlhost
\e[22m- local host name
1622 \e[1mlport
\e[22m- local port number
1623 \e[1mlservice
\e[22m- local service name from /etc/services
1625 The connection index provides you with access to each connection
1626 in the port monitor. The monitor will return information for in‐
1627 dex values from 0 to n-1 connections. Values higher than n-1 are
1628 simply ignored. For the "count" item, the connection index must
1629 be omitted. It is required for all other items.
1632 \e[1m${tcp_portmon 6881 6999 count}
\e[22m- displays the number of connec‐
1633 tions in the bittorrent port range
1634 \e[1m${tcp_portmon 22 22 rip 0}
\e[22m- displays the remote host ip of the
1635 first sshd connection
1636 \e[1m${tcp_portmon 22 22 rip 9}
\e[22m- displays the remote host ip of the
1637 tenth sshd connection
1638 \e[1m${tcp_portmon 1 1024 rhost 0}
\e[22m- displays the remote host name of
1639 the first connection on a privileged port
1640 \e[1m${tcp_portmon 1 1024 rport 4}
\e[22m- displays the remote host port of
1641 the fifth connection on a privileged port
1642 \e[1m${tcp_portmon 1 65535 lservice 14}
\e[22m- displays the local service
1643 name of the fifteenth connection in the range of all ports
1645 Note that port monitor variables which share the same port range
1646 actually refer to the same monitor, so many references to a sin‐
1647 gle port range for different items and different indexes all use
1648 the same monitor internally. In other words, the program avoids
1649 creating redundant monitors.
1651 \e[1mtexeci interval command
\e[0m
1652 Runs a command at an interval inside a thread and displays the
1653 output. Same as $execi, except the command is run inside a
1654 thread. Use this if you have a slow script to keep Conky updat‐
1655 ing. You should make the interval slightly longer then the time
1656 it takes your script to execute. For example, if you have a
1657 script that take 5 seconds to execute, you should make the in‐
1658 terval at least 6 seconds. See also $execi.
1661 \e[1moffset (pixels)
\e[0m
1662 Move text over by N pixels. See also $voffset.
1665 \e[1mrss url delay_in_minutes action (num_par (spaces_in_front))
\e[0m
1666 Download and parse RSS feeds. Action may be one of the follow‐
1667 ing: feed_title, item_title (with num par), item_desc (with num
1668 par) and item_titles (when using this action and spaces_in_front
1669 is given conky places that many spaces in front of each item).
1672 \e[1mtab (width, (start))
\e[0m
1673 Puts a tab of the specified width, starting from column 'start'.
1674 The unit is pixels for both arguments.
1677 \e[1mtail logfile lines (interval)
\e[0m
1678 Displays last N lines of supplied text text file. If interval is
1679 not supplied, Conky assumes 2x Conky's interval. Max of 30 lines
1680 can be displayed, or until the text buffer is filled.
1683 \e[1mtemplateN (arg1) (arg2) (arg3 ...)
\e[0m
1684 Evaluate the content of the templateN configuration variable
1685 (where N is a value between 0 and 9, inclusively), applying sub‐
1686 stitutions as described in the documentation of the correspond‐
1687 ing configuration variable. The number of arguments is option‐
1688 al, but must match the highest referred index in the template.
1689 You can use the same special sequences in each argument as the
1690 ones valid for a template definition, e.g. to allow an argument
1691 to contain a whitespace. Also simple nesting of templates is
1694 Here are some examples of template definitions:
1697 template1 \1: ${fs_used \2} / ${fs_size \2}
1700 The following list shows sample usage of the templates defined
1701 above, with the equivalent syntax when not using any template at
1704 using template same without template
1705 ─────────────────────────────────────────────────────────────────────────────────
1706 ${template0 node name} $nodename
1707 ${template1 root /} root: ${fs_free /} /
1709 ${template1 ${template2\ disk\ root} /} disk root: ${fs_free /} / ${fs_size /}
1712 \e[1mtime (format)
\e[0m
1713 Local time, see man strftime to get more information about for‐
1717 \e[1mutime (format)
\e[0m
1718 Display time in UTC (universal coordinate time).
1721 \e[1mtztime (timezone) (format)
\e[0m
1722 Local time for specified timezone, see man strftime to get more
1723 information about format. The timezone argument is specified in
1724 similar fashion as TZ environment variable. For hints, look in
1725 /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
1728 \e[1mtotaldown net
\e[0m
1729 Total download, overflows at 4 GB on Linux with 32-bit arch and
1730 there doesn't seem to be a way to know how many times it has al‐
1731 ready done that before conky has started.
1734 \e[1mtop type, num
\e[0m
1735 This takes arguments in the form:top (name) (number) Basically,
1736 processes are ranked from highest to lowest in terms of cpu us‐
1737 age, which is what (num) represents. The types are: "name",
1738 "pid", "cpu", "mem", "mem_res", "mem_vsize", and "time". There
1739 can be a max of 10 processes listed.
1742 \e[1mtop_mem type, num
\e[0m
1743 Same as top, except sorted by mem usage instead of cpu
1746 \e[1mtop_time type, num
\e[0m
1747 Same as top, except sorted by total CPU time instead of current
1751 \e[1mtotalup net
\e[0m
1752 Total upload, this one too, may overflow
1755 \e[1mupdates Number of updates
\e[0m
1759 \e[1mupspeed net
\e[0m
1763 \e[1mupspeedf net
\e[0m
1764 Upload speed in KiB with one decimal
1767 \e[1mupspeedgraph ("normal"|"log") (height),(width) (gradient colour 1)
\e[0m
1768 \e[1m(gradient colour 2) (scale) (net)
\e[0m
1769 Upload speed graph, colours defined in hex, minus the #. If
1770 scale is non-zero, it becomes the scale for the graph. Uses a
1771 logarithmic scale (to see small numbers) when you use "log" in‐
1775 \e[1muptime
\e[22mUptime
1778 \e[1muptime_short
\e[0m
1779 Uptime in a shorter format
1782 \e[1muser_number
\e[0m
1783 Number of users logged in
1786 \e[1muser_names
\e[0m
1787 Lists the names of the users logged in
1790 \e[1muser_terms
\e[0m
1791 Lists the consoles in use
1794 \e[1muser_times
\e[0m
1795 Lists how long users have been logged in for
1798 \e[1mvoffset (pixels)
\e[0m
1799 Change vertical offset by N pixels. Negative values will cause
1800 text to overlap. See also $offset.
1803 \e[1mvoltage_mv (n)
\e[0m
1804 Returns CPU #n's voltage in mV. CPUs are counted from 1. If
1805 omitted, the parameter defaults to 1.
1808 \e[1mvoltage_v (n)
\e[0m
1809 Returns CPU #n's voltage in V. CPUs are counted from 1. If omit‐
1810 ted, the parameter defaults to 1.
1813 \e[1mwireless_essid net
\e[0m
1814 Wireless access point ESSID (Linux only)
1817 \e[1mwireless_mode net
\e[0m
1818 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1821 \e[1mwireless_bitrate net
\e[0m
1822 Wireless bitrate (ie 11 Mb/s) (Linux only)
1825 \e[1mwireless_ap net
\e[0m
1826 Wireless access point MAC address (Linux only)
1829 \e[1mwireless_link_qual net
\e[0m
1830 Wireless link quality (Linux only)
1833 \e[1mwireless_link_qual_max net
\e[0m
1834 Wireless link quality maximum value (Linux only)
1837 \e[1mwireless_link_qual_perc net
\e[0m
1838 Wireless link quality in percents (Linux only)
1841 \e[1mwireless_link_bar (height), (width) net
\e[0m
1842 Wireless link quality bar (Linux only)
1845 \e[1mwords textfile
\e[0m
1846 Displays the number of words in the given file
1849 \e[1mxmms2_artist
\e[0m
1850 Artist in current XMMS2 song
1853 \e[1mxmms2_album
\e[0m
1854 Album in current XMMS2 song
1857 \e[1mxmms2_title
\e[0m
1858 Title in current XMMS2 song
1861 \e[1mxmms2_genre
\e[0m
1862 Genre in current XMMS2 song
1865 \e[1mxmms2_comment
\e[0m
1866 Comment in current XMMS2 song
1870 Full path to current song
1873 \e[1mxmms2_tracknr
\e[0m
1874 Track number in current XMMS2 song
1877 \e[1mxmms2_bitrate
\e[0m
1878 Bitrate of current song
1882 XMMS2 id of current song
1885 \e[1mxmms2_duration
\e[0m
1886 Duration of current song
1889 \e[1mxmms2_elapsed
\e[0m
1893 \e[1mxmms2_size
\e[0m
1894 Size of current song
1897 \e[1mxmms2_percent
\e[0m
1898 Percent of song's progress
1901 \e[1mxmms2_date
\e[0m
1902 Returns song's date.
1905 \e[1mxmms2_playlist
\e[0m
1906 Returns the XMMS2 playlist.
1909 \e[1mxmms2_timesplayed
\e[0m
1910 Number of times a song was played (presumably).
1913 \e[1mxmms2_status
\e[0m
1914 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1917 \e[1mxmms2_bar (height),(width)
\e[0m
1918 Bar of XMMS2's progress
1921 \e[1mxmms2_smart
\e[0m
1922 Prints the song name in either the form "artist - title" or file
1923 name, depending on whats available
1926 \e[1mif_xmms2_connected
\e[0m
1927 Display everything between $if_xmms2_connected and the matching
1928 $endif if xmms2 is running.
1931 \e[1msony_fanspeed
\e[0m
1932 Displays the Sony VAIO fanspeed information if sony-laptop ker‐
1933 nel support is enabled. Linux only.
1936 \e[1meve api_userid api_key character_id
\e[0m
1937 Fetches your currently training skill from the Eve Online API
1938 servers (http://www.eve-online.com/) and displays the skill
1939 along with the remaining training time.
1942 \e[1mendif
\e[22mEnds an $if block.
1946 conky
\e[1m-t '${time %D %H:%M}' -o -u 30
\e[0m
1947 Start Conky in its own window with date and clock as text and 30
1948 sec update interval.
1950 conky
\e[1m-a top_left -x 5 -y 500 -d
\e[0m
1951 Start Conky to background at coordinates (5, 500).
1954 \e[4m~/.conkyrc
\e[24m default configuration file
1957 Drawing to root or some other desktop window directly doesn't work with
1958 all window managers. Especially doesn't work well with Gnome and it has
1959 been reported that it doesn't work with KDE either. Nautilus can be
1960 disabled from drawing to desktop with program gconf-editor. Uncheck
1961 show_desktop in /apps/nautilus/preferences/. There is -w switch in
1962 Conky to set some specific window id. You might find xwininfo -tree
1963 useful to find the window to draw to. You can also use -o argument
1964 which makes Conky to create its own window. If you do try running Conky
1965 in its own window, be sure to read up on the own_window_type settings
1969 ⟨http://conky.sourceforge.net/⟩
1971 ⟨http://www.sourceforge.net/projects/conky⟩
1973 #conky on irc.freenode.net
1976 Copyright (c) 2005-2009 Brenden Matthews, Philip Kovacs, et. al. Any
1977 original torsmo code is licensed under the BSD license (see LICENSE.BSD
1978 for a copy). All code written since the fork of torsmo is licensed un‐
1979 der the GPL (see LICENSE.GPL for a copy), except where noted different‐
1980 ly (such as in portmon code, timed thread code, and audacious code
1981 which are LGPL, and prss which is an MIT-style license).
1984 The Conky dev team (see AUTHORS for a full list of contributors).