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_cpu_separate
\e[0m
201 If true, cpu in top will show usage of one processor's power. If
202 false, cpu in top will show the usage of all processors' power
206 \e[1mdefault_bar_size
\e[0m
207 Specify a default width and height for bars. Example: 'de‐
208 fault_bar_size 0 6'. This is particularly useful for execbar and
209 execibar as they do not take size arguments.
212 \e[1mdefault_graph_size
\e[0m
213 Specify a default width and height for graphs. Example: 'de‐
214 fault_graph_size 0 25'. This is particularly useful for exec‐
215 graph and execigraph as they do not take size arguments
218 \e[1mdefault_gauge_size
\e[0m
219 Specify a default width and height for gauges. Example: 'de‐
220 fault_gauge_size 25 25'. This is particularly useful for exec‐
221 gauge and execigauge as they do not take size arguments
224 \e[1mdefault_color
\e[0m
225 Default color and border color
228 \e[1mdefault_outline_color
\e[0m
229 Default outline color
232 \e[1mdefault_shade_color
\e[0m
233 Default shading color and border's shading color
236 \e[1mdouble_buffer
\e[0m
237 Use the Xdbe extension? (eliminates flicker) It is highly recom‐
238 mended to use own window with this one so double buffer won't be
242 \e[1mdraw_borders
\e[0m
243 Draw borders around text?
246 \e[1mdraw_graph_borders
\e[0m
247 Draw borders around graphs?
250 \e[1mdraw_outline
\e[0m
254 \e[1mdraw_shades
\e[0m
258 \e[1mfont
\e[22mFont name in X, xfontsel can be used to get a nice font
261 \e[1mgap_x
\e[22mGap, in pixels, between right or left border of screen, same as
262 passing -x at command line, e.g. gap_x 10
265 \e[1mgap_y
\e[22mGap, in pixels, between top or bottom border of screen, same as
266 passing -y at command line, e.g. gap_y 10.
269 \e[1mif_up_strictness
\e[0m
270 How strict should if_up be when testing an interface for being
271 up? The value is one of up, link or address, to check for the
272 interface being solely up, being up and having link or being up,
273 having link and an assigned IP address.
276 \e[1mimap
\e[22mDefault global IMAP server. Arguments are: "host user pass [-i
277 interval] [-f folder] [-p port] [-e command] [-r retries]". De‐
278 fault port is 143, default folder is 'INBOX', default interval
279 is 5 minutes, and default number of retries before giving up is
280 5. If the password is supplied as '*', you will be prompted to
281 enter the password when Conky starts.
285 Mail spool for mail checking
288 \e[1mmax_port_monitor_connections
\e[0m
289 Allow each port monitor to track at most this many connections
290 (if 0 or not set, default is 256)
293 \e[1mmax_specials
\e[0m
294 Maximum number of special things, e.g. fonts, offsets, aligns,
295 etc. (default is 512)
298 \e[1mmax_user_text bytes
\e[0m
299 Maximum size of user text buffer, i.e. layout below TEXT line in
300 config file (default is 16384 bytes)
303 \e[1mtext_buffer_size bytes
\e[0m
304 Size of the standard text buffer (default is 256 bytes). This
305 buffer is used for intermediary text, such as individual lines,
306 output from $exec vars, and various other variables. Increasing
307 the size of this buffer can drastically reduce Conky's perfor‐
308 mance, but will allow for more text display per variable. The
309 size of this buffer cannot be smaller than the default value of
313 \e[1mmaximum_width pixels
\e[0m
314 Maximum width of window
317 \e[1mminimum_size width (height)
\e[0m
318 Minimum size of window
329 \e[1mmpd_password
\e[0m
333 \e[1mmusic_player_interval
\e[0m
334 Music player thread update interval (defaults to Conky's update
338 \e[1mnet_avg_samples
\e[0m
339 The number of samples to average for net data
343 Substract (file system) buffers from used memory?
346 \e[1moverride_utf8_locale
\e[0m
347 Force UTF8? requires XFT
351 Boolean, create own window to draw?
354 \e[1mown_window_class
\e[0m
355 Manually set the WM_CLASS name. Defaults to "Conky".
358 \e[1mown_window_colour colour
\e[0m
359 If own_window_transparent no, set a specified background colour
360 (defaults to black). Takes either a hex value (#ffffff) or a
361 valid RGB name (see /usr/lib/X11/rgb.txt)
364 \e[1mown_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager
\e[0m
365 If own_window is yes, you may use these window manager hints to
366 affect the way Conky displays. Notes: Use own_window_type desk‐
367 top as another way to implement many of these hints implicitly.
368 If you use own_window_type override, window manager hints have
369 no meaning and are ignored.
372 \e[1mown_window_title
\e[0m
373 Manually set the window name. Defaults to "<hostname> - conky".
376 \e[1mown_window_transparent
\e[0m
377 Boolean, set pseudo-transparency?
380 \e[1mown_window_type
\e[0m
381 if own_window is yes, you may specify type normal, desktop, dock
382 or override (default: normal). Desktop windows are special win‐
383 dows that have no window decorations; are always visible on your
384 desktop; do not appear in your pager or taskbar; and are sticky
385 across all workspaces. Override windows are not under the con‐
386 trol of the window manager. Hints are ignored. This type of win‐
387 dow can be useful for certain situations.
390 \e[1mout_to_console
\e[0m
391 Print text to stdout.
394 \e[1mout_to_stderr
\e[0m
395 Print text to stderr.
399 When set to no, there will be no output in X (useful when you
400 also use things like out_to_console). If you set it to no, make
401 sure that it's placed before all other X-related setting (take
402 the first line of your configfile to be sure). Default value is
406 \e[1moverwrite_file
\e[0m
407 Overwrite the file given as argument.
410 \e[1mappend_file
\e[0m
411 Append the file given as argument.
414 \e[1mpad_percents
\e[0m
415 Pad percentages to this many decimals (0 = no padding)
418 \e[1mpop3
\e[22mDefault global POP3 server. Arguments are: "host user pass [-i
419 interval] [-p port] [-e command] [-r retries]". Default port is
420 110, default interval is 5 minutes, and default number of re‐
421 tries before giving up is 5. If the password is supplied as '*',
422 you will be prompted to enter the password when Conky starts.
425 \e[1mshort_units
\e[0m
426 Shortens units to a single character (kiB->k, GiB->G, etc.). De‐
430 \e[1mshow_graph_scale
\e[0m
431 Shows the maximum value in scaled graphs.
434 \e[1mshow_graph_range
\e[0m
435 Shows the time range covered by a graph.
438 \e[1mstippled_borders
\e[0m
439 Border stippling (dashing) in pixels
442 \e[1mtemperature_unit
\e[0m
443 Desired output unit of all objects displaying a temperature.
444 Parameters are either "fahrenheit" or "celsius". The default
445 unit is degree Celsius.
449 Define a template for later use inside TEXT segments. Substitute
450 N by a digit between 0 and 9, inclusively. The value of the
451 variable is being inserted into the stuff below TEXT at the cor‐
452 responding position, but before some substitutions are applied:
457 '\N' -> template argument N
460 \e[1mtotal_run_times
\e[0m
461 Total number of times for Conky to update before quitting. Zero
462 makes Conky run forever
465 \e[1mupdate_interval
\e[0m
466 Update interval in seconds
470 Boolean value, if true, text is rendered in upper case
474 Adds spaces around certain objects to stop them from moving oth‐
475 er things around. Arguments are left, right, and none (default).
476 The old true/false values are deprecated and default to
477 right/none respectively. Note that this only helps if you are
478 using a mono font, such as Bitstream Vera Sans Mono.
482 Use Xft (anti-aliased font and stuff)
486 Alpha of Xft font. Must be a value at or between 1 and 0.
493 \e[1mTEXT
\e[22mAfter this begins text to be formatted on screen. Backslash (\)
494 escapes newlines in the text section. This can be useful for
495 cleaning up config files where conky is used to pipe input to
500 Colors are parsed using XParsecolor(), there might be a list of them:
501 /usr/share/X11/rgb.txt. Also, ⟨http://sedition.com/perl/rgb.html⟩.
502 Color can be also in #rrggbb format (hex).
504 \e[1maddr interface
\e[0m
505 IP address for an interface, or "No Address" if no address is
509 \e[1maddrs interface
\e[0m
510 IP addresses for an interface (if one - works like addr). Linux
514 \e[1macpiacadapter
\e[0m
515 ACPI ac adapter state.
523 ACPI temperature in C.
527 CPU temperature from therm_adt746x
531 Fan speed from therm_adt746x
534 \e[1malignr (num)
\e[0m
535 Right-justify text, with space of N
538 \e[1malignc (num)
\e[0m
542 \e[1mapm_adapter
\e[0m
543 Display APM AC adapter status (FreeBSD only)
546 \e[1mapm_battery_life
\e[0m
547 Display APM battery life in percent (FreeBSD only)
550 \e[1mapm_battery_time
\e[0m
551 Display remaining APM battery life in hh:mm:ss or "unknown" if
552 AC adapterstatus is on-line or charging (FreeBSD only)
555 \e[1maudacious_bar (height),(width)
\e[0m
559 \e[1maudacious_bitrate
\e[0m
560 Bitrate of current tune
563 \e[1maudacious_channels
\e[0m
564 Number of audio channels of current tune
567 \e[1maudacious_filename
\e[0m
568 Full path and filename of current tune
571 \e[1maudacious_frequency
\e[0m
572 Sampling frequency of current tune
575 \e[1maudacious_length
\e[0m
576 Total length of current tune as MM:SS
579 \e[1maudacious_length_seconds
\e[0m
580 Total length of current tune in seconds
583 \e[1maudacious_playlist_position
\e[0m
584 Playlist position of current tune
587 \e[1maudacious_playlist_length
\e[0m
588 Number of tunes in playlist
591 \e[1maudacious_position
\e[0m
592 Position of current tune (MM:SS)
595 \e[1maudacious_position_seconds
\e[0m
596 Position of current tune in seconds
599 \e[1maudacious_status
\e[0m
600 Player status (Playing/Paused/Stopped/Not running)
603 \e[1maudacious_title (max length)
\e[0m
604 Title of current tune with optional maximum length specifier
607 \e[1maudacious_main_volume
\e[0m
608 The current volume fetched from Audacious
611 \e[1mbattery (num)
\e[0m
612 Battery status and remaining percentage capacity of ACPI or APM
613 battery. ACPI battery number can be given as argument (default
617 \e[1mbattery_short (num)
\e[0m
618 Battery status and remaining percentage capacity of ACPI or APM
619 battery. ACPI battery number can be given as argument (default
620 is BAT0). This mode display a short status, which means that C
621 is displayed instead of charging and D is displayed instead of
625 \e[1mbattery_bar (height),(width) (num)
\e[0m
626 Battery percentage remaining of ACPI battery in a bar. ACPI bat‐
627 tery number can be given as argument (default is BAT0).
630 \e[1mbattery_percent (num)
\e[0m
631 Battery percentage remaining for ACPI battery. ACPI battery num‐
632 ber can be given as argument (default is BAT0).
635 \e[1mbattery_time (num)
\e[0m
636 Battery charge/discharge time remaining of ACPI battery. ACPI
637 battery number can be given as argument (default is BAT0).
640 \e[1mbmpx_artist
\e[0m
641 Artist in current BMPx track
645 Album in current BMPx track
649 Title of the current BMPx track
653 Track number of the current BMPx track
656 \e[1mbmpx_bitrate
\e[0m
657 Bitrate of the current BMPx track
661 URI of the current BMPx track
665 Amount of memory buffered
668 \e[1mcached
\e[22mAmount of memory cached
671 \e[1mcolor (color)
\e[0m
672 Change drawing color to color
675 \e[1mcolorN
\e[22mChange drawing color to colorN configuration option, where N is
676 a digit between 0 and 9, inclusively.
679 \e[1mcombine var1 var2
\e[0m
680 Places the lines of var2 to the right of the lines of var1
681 seperated by the chars that are put between var1 and var2. For
682 example: ${combine ${head /proc/cpuinfo 2} - ${head /proc/memin‐
683 fo 1}} gives as output "cpuinfo_line1 - meminfo_line1" on line 1
684 and "cpuinfo_line2 -" on line 2. $combine vars can also be nest‐
685 ed to place more vars next to each other.
688 \e[1mconky_version
\e[0m
692 \e[1mconky_build_date
\e[0m
696 \e[1mconky_build_arch
\e[0m
697 CPU architecture Conky was built for
701 CPU usage in percents. For SMP machines, the CPU number can be
702 provided as an argument. ${cpu cpu0} is the total usage, and
703 ${cpu cpuX} (X >= 1) are individual CPUs.
706 \e[1mcpubar (cpuN) (height),(width)
\e[0m
707 Bar that shows CPU usage, height is bar's height in pixels. See
708 $cpu for more info on SMP.
711 \e[1mcpugauge (cpuN) (height),(width)
\e[0m
712 Elliptical gauge that shows CPU usage, height and width are
713 gauge's vertical and horizontal axis respectively. See $cpu for
717 \e[1mcpugraph (cpuN) ("normal"|"log") (height),(width) (gradient colour 1)
\e[0m
718 \e[1m(gradient colour 2) (scale)
\e[0m
719 CPU usage graph, with optional colours in hex, minus the #. See
720 $cpu for more info on SMP. Uses a logarithmic scale (to see
721 small numbers) when you use "log" instead of "normal".
724 \e[1mdiskio (device)
\e[0m
725 Displays current disk IO. Device is optional, and takes the form
726 of sda for /dev/sda. Individual partitions are allowed.
729 \e[1mdiskiograph ("normal"|"log") (height),(width) (gradient colour 1) (gra‐
\e[0m
730 \e[1mdient colour 2) (scale) (device)
\e[0m
731 Disk IO graph, colours defined in hex, minus the #. If scale is
732 non-zero, it becomes the scale for the graph. Uses a logarithmic
733 scale (to see small numbers) when you use "log" instead of "nor‐
737 \e[1mdiskio_read (device)
\e[0m
738 Displays current disk IO for reads. Device as in diskio.
741 \e[1mdiskiograph_read ("normal"|"log") (height),(width) (gradient colour 1)
\e[0m
742 \e[1m(gradient colour 2) (scale) (device)
\e[0m
743 Disk IO graph for reads, colours defined in hex, minus the #. If
744 scale is non-zero, it becomes the scale for the graph. Device as
745 in diskio. Uses a logarithmic scale (to see small numbers) when
746 you use "log" instead of "normal".
749 \e[1mdiskio_write (device)
\e[0m
750 Displays current disk IO for writes. Device as in diskio.
753 \e[1mdiskiograph_write ("normal"|"log") (height),(width) (gradient colour 1)
\e[0m
754 \e[1m(gradient colour 2) (scale) (device)
\e[0m
755 Disk IO graph for writes, colours defined in hex, minus the #.
756 If scale is non-zero, it becomes the scale for the graph. Device
757 as in diskio. Uses a logarithmic scale (to see small numbers)
758 when you use "log" instead of "normal".
761 \e[1mdisk_protect device
\e[0m
762 Disk protection status, if supported (needs kernel-patch).
763 Prints either "frozen" or "free " (note the padding).
766 \e[1mdownspeed net
\e[0m
767 Download speed in KiB
770 \e[1mdownspeedf net
\e[0m
771 Download speed in KiB with one decimal
774 \e[1mdownspeedgraph ("normal"|"log") (height),(width) (gradient colour 1)
\e[0m
775 \e[1m(gradient colour 2) (scale) (net)
\e[0m
776 Download speed graph, colours defined in hex, minus the #. If
777 scale is non-zero, it becomes the scale for the graph. Uses a
778 logarithmic scale (to see small numbers) when you use "log" in‐
782 \e[1melse
\e[22mText to show if any of the above are not true
785 \e[1mentropy_avail
\e[0m
786 Current entropy available for crypto freaks
789 \e[1mentropy_bar (height),(width)
\e[0m
790 Normalized bar of available entropy for crypto freaks
793 \e[1mentropy_poolsize
\e[0m
794 Total size of system entropy pool for crypto freaks
797 \e[1meval string
\e[0m
798 Evalutates given string according to the rules of TEXT interpre‐
799 tation, i.e. parsing any contained text object specifications
800 into their output, any occuring '$$' into a single '$' and so
801 on. The output is then being parsed again.
804 \e[1mexec command
\e[0m
805 Executes a shell command and displays the output in conky. warn‐
806 ing: this takes a lot more resources than other variables. I'd
807 recommend coding wanted behaviour in C and posting a patch.
810 \e[1mexecbar command
\e[0m
811 Same as exec, except if the first value return is a value be‐
812 tween 0-100, it will use that number for a bar. The size for
813 bars can be controlled via the default_bar_size config setting.
816 \e[1mexecgauge command
\e[0m
817 Same as exec, except if the first value returned is a value be‐
818 tween 0-100, it will use that number for a gauge. The size for
819 gauges can be controlled via the default_gauge_size config set‐
823 \e[1mexecgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐
\e[0m
824 \e[1ment colour 2) (scale) command
\e[0m
825 Same as execbar, but graphs values. Uses a logaritmic scale when
826 the log option is given (to see small numbers). Values still
827 have to be between 0 and 100. The size for graphs can be con‐
828 trolled via the default_graph_size config setting.
831 \e[1mexeci interval command
\e[0m
832 Same as exec but with specific interval. Interval can't be less
833 than update_interval in configuration. See also $texeci
836 \e[1mexecibar interval command
\e[0m
837 Same as execbar, except with an interval
840 \e[1mexecigraph interval command
\e[0m
841 Same as execgraph, but takes an interval arg and graphs values.
844 \e[1mexecigauge interval command
\e[0m
845 Same as execgauge, but takes an interval arg and gauges values.
848 \e[1mexecp command
\e[0m
849 Executes a shell command and displays the output in conky. warn‐
850 ing: this takes a lot more resources than other variables. I'd
851 recommend coding wanted behaviour in C and posting a patch. This
852 differs from $exec in that it parses the output of the command,
853 so you can insert things like ${color red}hi!${color} in your
854 script and have it correctly parsed by Conky. Caveats: Conky
855 parses and evaluates the output of $execp every time Conky
856 loops, and then destroys all the objects. If you try to use any‐
857 thing like $execi within an $execp statement, it will function‐
858 ally run at the same interval that the $execp statement runs, as
859 it is created and destroyed at every interval.
862 \e[1mexecpi interval command
\e[0m
863 Same as execp but with specific interval. Interval can't be less
864 than update_interval in configuration. Note that the output from
865 the $execpi command is still parsed and evaluated at every in‐
869 \e[1mfont (font)
\e[0m
870 Specify a different font. This new font will apply to the cur‐
871 rent line and everything following. You can use a $font with no
872 arguments to change back to the default font (much like with
877 Returns CPU #n's frequency in MHz. CPUs are counted from 1. If
878 omitted, the parameter defaults to 1.
882 Returns CPU #n's frequency in GHz. CPUs are counted from 1. If
883 omitted, the parameter defaults to 1.
886 \e[1mfs_bar (height),(width) fs
\e[0m
887 Bar that shows how much space is used on a file system. height
888 is the height in pixels. fs is any file on that file system.
891 \e[1mfs_bar_free (height),(width) fs
\e[0m
892 Bar that shows how much space is free on a file system. height
893 is the height in pixels. fs is any file on that file system.
896 \e[1mfs_free (fs)
\e[0m
897 Free space on a file system available for users.
900 \e[1mfs_free_perc (fs)
\e[0m
901 Free percentage of space on a file system available for users.
904 \e[1mfs_size (fs)
\e[0m
908 \e[1mfs_type (fs)
\e[0m
912 \e[1mfs_used (fs)
\e[0m
913 File system used space.
916 \e[1mfs_used_perc (fs)
\e[0m
917 Percent of file system used space.
920 \e[1mgoto x
\e[22mThe next element will be printed at position 'x'.
924 Displays the default route's interface or "multiple"/"none" ac‐
928 \e[1mgw_ip
\e[22mDisplays the default gateway's IP or "multiple"/"none" accord‐
932 \e[1mhddtemp dev, (host,(port))
\e[0m
933 Displays temperature of a selected hard disk drive as reported
934 by the hddtemp daemon running on host:port. Default host is
935 127.0.0.1, default port is 7634.
938 \e[1mhead logfile lines (interval)
\e[0m
939 Displays first N lines of supplied text text file. If interval
940 is not supplied, Conky assumes 2x Conky's interval. Max of 30
941 lines can be displayed, or until the text buffer is filled.
944 \e[1mhr (height)
\e[0m
945 Horizontal line, height is the height in pixels
948 \e[1mhwmon (dev) type n
\e[0m
949 Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omit‐
950 ted if you have only one hwmon device. Parameter type is either
951 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning
952 temperature. Parameter n is number of the sensor. See
953 /sys/class/hwmon/ on your local computer.
956 \e[1miconv_start codeset_from codeset_to
\e[0m
957 Convert text from one codeset to another using GNU iconv. Needs
958 to be stopped with iconv_stop.
962 Stop iconv codeset conversion.
965 \e[1mi2c (dev) type n
\e[0m
966 I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted
967 if you have only one I2C device. Parameter type is either 'in'
968 or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning tem‐
969 perature. Parameter n is number of the sensor. See
970 /sys/bus/i2c/devices/ on your local computer.
973 \e[1mi8k_ac_status
\e[0m
974 If running the i8k kernel driver for Inspiron laptops, displays
975 whether ac power is on, as listed in /proc/i8k (translated to
976 human-readable). Beware that this is by default not enabled by
981 If running the i8k kernel driver for Inspiron laptops, displays
982 the bios version as listed in /proc/i8k.
985 \e[1mi8k_buttons_status
\e[0m
986 If running the i8k kernel driver for Inspiron laptops, displays
987 the volume buttons status as listed in /proc/i8k.
990 \e[1mi8k_cpu_temp
\e[0m
991 If running the i8k kernel driver for Inspiron laptops, displays
992 the cpu temperature in Celsius, as reported by /proc/i8k.
995 \e[1mi8k_left_fan_rpm
\e[0m
996 If running the i8k kernel driver for Inspiron laptops, displays
997 the left fan's rate of rotation, in revolutions per minute as
998 listed in /proc/i8k. Beware, some laptops i8k reports these fans
1002 \e[1mi8k_left_fan_status
\e[0m
1003 If running the i8k kernel driver for Inspiron laptops, displays
1004 the left fan status as listed in /proc/i8k (translated to human-
1005 readable). Beware, some laptops i8k reports these fans in re‐
1009 \e[1mi8k_right_fan_rpm
\e[0m
1010 If running the i8k kernel driver for Inspiron laptops, displays
1011 the right fan's rate of rotation, in revolutions per minute as
1012 listed in /proc/i8k. Beware, some laptops i8k reports these fans
1016 \e[1mi8k_right_fan_status
\e[0m
1017 If running the i8k kernel driver for Inspiron laptops, displays
1018 the right fan status as listed in /proc/i8k (translated to hu‐
1019 man-readable). Beware, some laptops i8k reports these fans in
1023 \e[1mi8k_serial
\e[0m
1024 If running the i8k kernel driver for Inspiron laptops, displays
1025 your laptop serial number as listed in /proc/i8k.
1028 \e[1mi8k_version
\e[0m
1029 If running the i8k kernel driver for Inspiron laptops, displays
1030 the version formatting of /proc/i8k.
1034 If running the IBM ACPI, displays the fan speed.
1037 \e[1mibm_temps N
\e[0m
1038 If running the IBM ACPI, displays the temperatures from the IBM
1039 temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
1043 \e[1mibm_volume
\e[0m
1044 If running the IBM ACPI, displays the "master" volume, con‐
1045 trolled by the volume keys (0-14).
1048 \e[1mibm_brightness
\e[0m
1049 If running the IBM ACPI, displays the brigtness of the laptops's
1053 \e[1mif_empty (var)
\e[0m
1054 if conky variable VAR is empty, display everything between
1055 $if_empty and the matching $endif
1058 \e[1mif_existing file (string)
\e[0m
1059 if FILE exists, display everything between if_existing and the
1060 matching $endif. The optional second paramater checks for FILE
1061 containing the specified string and prints everything between
1062 $if_existing and the matching $endif.
1065 \e[1mif_gw
\e[22mif there is at least one default gateway, display everything be‐
1066 tween $if_gw and the matching $endif
1069 \e[1mif_match expression
\e[0m
1070 Evaluates the given boolean expression, printing everything be‐
1071 tween $if_match and the matching $endif depending on whether the
1072 evaluation returns true or not. Valid expressions consist of a
1073 left side, an operator and a right side. Left and right sides
1074 are being parsed for contained text objects before evaluation.
1075 Recognised left and right side types are:
1077 \e[1mdouble
\e[22m: argument consists of only digits and a single dot.
1078 \e[1mlong
\e[22m: argument consists of only digits.
1079 \e[1mstring
\e[22m: argument is enclosed in quotation mark or the checks for
1080 double and long failed before.
1082 Valid operands are: '>', '<', '>=', '<=', '==', '!='.
1085 \e[1mif_mixer_mute (mixer)
\e[0m
1086 If mixer exists, display everything between $if_mixer_mute and
1087 the matching $endif. If no mixer is specified, "Master" is used.
1090 \e[1mif_running (process)
\e[0m
1091 if PROCESS is running, display everything $if_running and the
1092 matching $endif. This uses the ``pidof'' command, so the -x
1093 switch is also supported.
1096 \e[1mif_mounted (mountpoint)
\e[0m
1097 if MOUNTPOINT is mounted, display everything between $if_mounted
1098 and the matching $endif
1101 \e[1mif_smapi_bat_installed (INDEX)
\e[0m
1102 when using smapi, if the battery with index INDEX is installed,
1103 display everything between $if_smapi_bat_installed and the
1107 \e[1mif_up (interface)
\e[0m
1108 if INTERFACE exists and is up, display everything between $if_up
1109 and the matching $endif
1112 \e[1mif_updatenr (updatenr)
\e[0m
1113 If it's the UPDATENR-th time that conky updates, display every‐
1114 thing between $if_updatenr and the matching $endif. The counter
1115 resets when the highest UPDATENR is reached. Example :
1116 "{$if_updatenr 1}foo$endif{$if_updatenr 2}bar$endif{$if_updatenr
1117 4}$endif" shows foo 25% of the time followed by bar 25% of the
1118 time followed by nothing the other half of the time.
1121 \e[1mimap_messages (args)
\e[0m
1122 Displays the number of messages in your global IMAP inbox by de‐
1123 fault. You can define individual IMAP inboxes seperately by
1124 passing arguments to this object. Arguments are: "host user pass
1125 [-i interval] [-f folder] [-p port] [-e command] [-r retries]".
1126 Default port is 143, default folder is 'INBOX', default interval
1127 is 5 minutes, and default number of retries before giving up is
1128 5. If the password is supplied as '*', you will be prompted to
1129 enter the password when Conky starts.
1132 \e[1mimap_unseen (args)
\e[0m
1133 Displays the number of unseen messages in your global IMAP inbox
1134 by default. You can define individual IMAP inboxes seperately by
1135 passing arguments to this object. Arguments are: "host user pass
1136 [-i interval] [-f folder] [-p port] [-e command] [-r retries]".
1137 Default port is 143, default folder is 'INBOX', default interval
1138 is 5 minutes, and default number of retries before giving up is
1139 5. If the password is supplied as '*', you will be prompted to
1140 enter the password when Conky starts.
1143 \e[1mioscheduler disk
\e[0m
1144 Prints the current ioscheduler used for the given disk name
1145 (i.e. e.g. "hda" or "sdb")
1148 \e[1mkernel
\e[22mKernel version
1151 \e[1mlaptop_mode
\e[0m
1152 The value of /proc/sys/vm/laptop_mode
1156 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
1157 5 minutes and 3 for past 15 minutes.
1160 \e[1mloadgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐
\e[0m
1161 \e[1ment colour 2) (scale)
\e[0m
1162 Load1 average graph, similar to xload, with optional colours in
1163 hex, minus the #. Uses a logarithmic scale (to see small num‐
1164 bers) when you use "log" instead of "normal".
1167 \e[1mlines textfile
\e[0m
1168 Displays the number of lines in the given file
1172 Machine, i686 for example
1175 \e[1mmails (mailbox) (interval)
\e[0m
1176 Mail count in the specified mailbox or your mail spool if not.
1177 Both mbox and maildir type mailboxes are supported. You can use
1178 a program like fetchmail to get mails from some server using
1179 your favourite protocol. See also new_mails.
1182 \e[1mnew_mails (mailbox) (interval)
\e[0m
1183 Unread mail count in the specified mailbox or mail spool if not.
1184 Both mbox and maildir type mailboxes are supported.
1187 \e[1mseen_mails (maildir) (interval)
\e[0m
1188 Number of mails marked as seen in the specified mailbox or mail
1189 spool if not. Only maildir type mailboxes are supported, mbox
1190 type will return -1.
1193 \e[1munseen_mails (maildir) (interval)
\e[0m
1194 Number of new or unseen mails in the specified mailbox or mail
1195 spool if not. Only maildir type mailboxes are supported, mbox
1196 type will return -1.
1199 \e[1mflagged_mails (maildir) (interval)
\e[0m
1200 Number of mails marked as flagged in the specified mailbox or
1201 mail spool if not. Only maildir type mailboxes are supported,
1202 mbox type will return -1.
1205 \e[1munflagged_mails (maildir) (interval)
\e[0m
1206 Number of mails not marked as flagged in the specified mailbox
1207 or mail spool if not. Only maildir type mailboxes are supported,
1208 mbox type will return -1.
1211 \e[1mforwarded_mails (maildir) (interval)
\e[0m
1212 Number of mails marked as forwarded in the specified mailbox or
1213 mail spool if not. Only maildir type mailboxes are supported,
1214 mbox type will return -1.
1217 \e[1munforwarded_mails (maildir) (interval)
\e[0m
1218 Number of mails not marked as forwarded in the specified mailbox
1219 or mail spool if not. Only maildir type mailboxes are supported,
1220 mbox type will return -1.
1223 \e[1mreplied_mails (maildir) (interval)
\e[0m
1224 Number of mails marked as replied in the specified mailbox or
1225 mail spool if not. Only maildir type mailboxes are supported,
1226 mbox type will return -1.
1229 \e[1munreplied_mails (maildir) (interval)
\e[0m
1230 Number of mails not marked as replied in the specified mailbox
1231 or mail spool if not. Only maildir type mailboxes are supported,
1232 mbox type will return -1.
1235 \e[1mdraft_mails (maildir) (interval)
\e[0m
1236 Number of mails marked as draft in the specified mailbox or mail
1237 spool if not. Only maildir type mailboxes are supported, mbox
1238 type will return -1.
1241 \e[1mtrashed_mails (maildir) (interval)
\e[0m
1242 Number of mails marked as trashed in the specified mailbox or
1243 mail spool if not. Only maildir type mailboxes are supported,
1244 mbox type will return -1.
1247 \e[1mmboxscan (-n number of messages to print) (-fw from width) (-sw subject
\e[0m
1248 \e[1mwidth) mbox
\e[0m
1249 Print a summary of recent messages in an mbox format mailbox.
1250 mbox parameter is the filename of the mailbox (can be encapsu‐
1251 lated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
1254 \e[1mmem
\e[22mAmount of memory in use
1257 \e[1mmembar (height),(width)
\e[0m
1258 Bar that shows amount of memory in use
1261 \e[1mmemgauge (height),(width)
\e[0m
1262 Gauge that shows amount of memory in use (see cpugauge)
1265 \e[1mmemgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐
\e[0m
1266 \e[1ment colour 2) (scale)
\e[0m
1267 Memory usage graph. Uses a logarithmic scale (to see small num‐
1268 bers) when you use "log" instead of "normal".
1271 \e[1mmemeasyfree
\e[0m
1272 Amount of free memory including the memory that is very easily
1273 freed (buffers/cache)
1277 Amount of free memory
1280 \e[1mmemmax
\e[22mTotal amount of memory
1284 Percentage of memory in use
1287 \e[1mmixer (device)
\e[0m
1288 Prints the mixer value as reported by the OS. Default mixer is
1289 "vol", but you can specify one of the following optional argu‐
1290 ments: "vol", "bass", "treble", "synth", "pcm", "speaker",
1291 "line", "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain",
1292 "line1", "line2", "line3", "dig1", "dig2", "dig3", "phin",
1293 "phout", "video", "radio", "monitor". Refer to the definition of
1294 SOUND_DEVICE_NAMES in <linux/soundcard.h> (on Linux), <sound‐
1295 card.h> (on OpenBSD), or <sys/soundcard.h> to find the exact op‐
1296 tions available on your system.
1299 \e[1mmixerbar (device)
\e[0m
1300 Displays mixer value in a bar as reported by the OS. See docs
1301 for $mixer for details on arguments.
1304 \e[1mmixerr (device)
\e[0m
1305 Prints the right channel mixer value as reported by the OS. See
1306 docs for $mixer for details on arguments.
1309 \e[1mmixerrbar (device)
\e[0m
1310 Displays the right channel mixer value in a bar as reported by
1311 the OS. See docs for $mixer for details on arguments.
1314 \e[1mmixerl (device)
\e[0m
1315 Prints the left channel mixer value as reported by the OS. See
1316 docs for $mixer for details on arguments.
1319 \e[1mmixerlbar (device)
\e[0m
1320 Displays the left channel mixer value in a bar as reported by
1321 the OS. See docs for $mixer for details on arguments.
1325 Current state of MOC; playing, stopped etc.
1329 File name of the current MOC song
1333 Title of the current MOC song
1336 \e[1mmoc_artist
\e[0m
1337 Artist of the current MOC song
1341 The current song name being played in MOC.
1345 Album of the current MOC song
1348 \e[1mmoc_totaltime
\e[0m
1349 Total length of the current MOC song
1352 \e[1mmoc_timeleft
\e[0m
1353 Time left in the current MOC song
1356 \e[1mmoc_curtime
\e[0m
1357 Current time of the current MOC song
1360 \e[1mmoc_bitrate
\e[0m
1361 Bitrate in the current MOC song
1365 Rate of the current MOC song
1369 Number of the monitor on which conky is running
1372 \e[1mmonitor_number
\e[0m
1376 \e[1mmpd_artist
\e[0m
1377 Artist in current MPD song must be enabled at compile
1381 Album in current MPD song
1384 \e[1mmpd_bar (height),(width)
\e[0m
1385 Bar of mpd's progress
1388 \e[1mmpd_bitrate
\e[0m
1389 Bitrate of current song
1392 \e[1mmpd_status
\e[0m
1393 Playing, stopped, et cetera.
1396 \e[1mmpd_title (max length)
\e[0m
1397 Title of current MPD song
1404 \e[1mmpd_elapsed
\e[0m
1408 \e[1mmpd_length
\e[0m
1412 \e[1mmpd_percent
\e[0m
1413 Percent of song's progress
1416 \e[1mmpd_random
\e[0m
1417 Random status (On/Off)
1420 \e[1mmpd_repeat
\e[0m
1421 Repeat status (On/Off)
1425 Prints the MPD track field
1429 Prints the MPD name field
1433 Prints the file name of the current MPD song
1436 \e[1mmpd_smart (max length)
\e[0m
1437 Prints the song name in either the form "artist - title" or file
1438 name, depending on whats available
1441 \e[1mif_mpd_playing
\e[0m
1442 if mpd is playing or paused, display everything between
1443 $if_mpd_playing and the matching $endif
1446 \e[1mnameserver (index)
\e[0m
1447 Print a nameserver from /etc/resolv.conf. Index starts at and
1455 \e[1mnvidia threshold temp ambient gpufreq memfreq imagequality
\e[0m
1456 Nvidia graficcard support for the XNVCtrl library. Each option
1457 can be shortened to the least significant part. Temperatures
1458 are printed as float, all other values as integer.
1460 \e[1mthreshold
\e[22m: the thresholdtemperature at which the gpu slows down
1461 \e[1mtemp
\e[22m: gives the gpu current temperature
1462 \e[1mambient
\e[22m: gives current air temperature near GPU case
1463 \e[1mgpufreq
\e[22m: gives the current gpu frequency
1464 \e[1mmemfreq
\e[22m: gives the current mem frequency
1465 \e[1mimagequality
\e[22m: which imagequality should be choosen by OpenGL ap‐
1469 \e[1moutlinecolor (color)
\e[0m
1470 Change outline color
1473 \e[1mpb_battery item
\e[0m
1474 If running on Apple powerbook/ibook, display information on bat‐
1475 tery status. The item parameter specifies, what information to
1476 display. Exactly one item must be specified. Valid items are:
1478 \e[1mstatus
\e[22m: Display if battery is fully charged, charging, discharg‐
1479 ing or absent (running on AC)
1480 \e[1mpercent
\e[22m: Display charge of battery in percent, if charging or
1481 discharging. Nothing will be displayed, if battery is fully
1483 \e[1mtime
\e[22m: Display the time remaining until the battery will be fully
1484 charged or discharged at current rate. Nothing is displayed, if
1485 battery is absent or if it's present but fully charged and not
1489 \e[1mplatform (dev) type n
\e[0m
1490 Platform sensor from sysfs (Linux 2.6). Parameter dev may be
1491 omitted if you have only one platform device. Platform type is
1492 either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp'
1493 meaning temperature. Parameter n is number of the sensor. See
1494 /sys/bus/platform/devices/ on your local computer.
1497 \e[1mpop3_unseen (args)
\e[0m
1498 Displays the number of unseen messages in your global POP3 inbox
1499 by default. You can define individual POP3 inboxes seperately by
1500 passing arguments to this object. Arguments are: "host user pass
1501 [-i interval] [-p port] [-e command] [-r retries]". Default port
1502 is 110, default interval is 5 minutes, and default number of re‐
1503 tries before giving up is 5. If the password is supplied as '*',
1504 you will be prompted to enter the password when Conky starts.
1507 \e[1mpop3_used (args)
\e[0m
1508 Displays the amount of space (in MiB, 2^20) used in your global
1509 POP3 inbox by default. You can define individual POP3 inboxes
1510 seperately by passing arguments to this object. Arguments are:
1511 "host user pass [-i interval] [-p port] [-e command] [-r re‐
1512 tries]". Default port is 110, default interval is 5 minutes, and
1513 default number of retries before giving up is 5. If the password
1514 is supplied as '*', you will be prompted to enter the password
1518 \e[1mpre_exec shell command
\e[0m
1519 Executes a shell command one time before conky displays anything
1520 and puts output as text.
1524 Total processes (sleeping and running)
1527 \e[1mrunning_processes
\e[0m
1528 Running processes (not sleeping), requires Linux 2.6
1531 \e[1mscroll length (step) text
\e[0m
1532 Scroll 'text' by 'step' characters showing 'length' number of
1533 characters at the same time. The text may also contain vari‐
1534 ables. 'step' is optional and defaults to 1 if not set. If a var
1535 creates output on multiple lines then the lines are placed be‐
1536 hind each other separated with a '|'-sign. Do NOT use vars that
1537 change colors or otherwise affect the design inside a scrolling
1538 text. If you want spaces between the start and the end of
1539 'text', place them at the end of 'text' not at the front ("foo‐
1540 bar" and " foobar" can both generate "barfoo" but "foobar " will
1541 keep the spaces like this "bar foo").
1544 \e[1mshadecolor (color)
\e[0m
1545 Change shading color
1548 \e[1msmapi (ARGS)
\e[0m
1549 when using smapi, display contents of the /sys/devices/plat‐
1550 form/smapi directory. ARGS are either '(FILENAME)' or 'bat (IN‐
1551 DEX) (FILENAME)' to display the corresponding files' content.
1552 This is a very raw method of accessing the smapi values. When
1553 available, better use one of the smapi_* variables instead.
1556 \e[1msmapi_bat_bar (INDEX),(height),(width)
\e[0m
1557 when using smapi, display the remaining capacity of the battery
1558 with index INDEX as a bar.
1561 \e[1msmapi_bat_perc (INDEX)
\e[0m
1562 when using smapi, display the remaining capacity in percent of
1563 the battery with index INDEX. This is a separate variable be‐
1564 cause it supports the 'use_spacer' configuration option.
1567 \e[1msmapi_bat_power INDEX
\e[0m
1568 when using smapi, display the current power of the battery with
1569 index INDEX in watt. This is a separate variable because the
1570 original read out value is being converted from mW. The sign of
1571 the output reflects charging (positive) or discharging (nega‐
1575 \e[1msmapi_bat_temp INDEX
\e[0m
1576 when using smapi, display the current temperature of the battery
1577 with index INDEX in degree Celsius. This is a separate variable
1578 because the original read out value is being converted from mil‐
1582 \e[1mstippled_hr (space)
\e[0m
1583 Stippled (dashed) horizontal line
1586 \e[1mswapbar (height),(width)
\e[0m
1587 Bar that shows amount of swap in use
1590 \e[1mswap
\e[22mAmount of swap in use
1594 Total amount of swap
1598 Percentage of swap in use
1602 System name, Linux for example
1605 \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
1606 TCP port monitor for specified local ports. Port numbers must be
1607 in the range 1 to 65535. Valid items are:
1609 \e[1mcount
\e[22m- total number of connections in the range
1610 \e[1mrip
\e[22m- remote ip address
1611 \e[1mrhost
\e[22m- remote host name
1612 \e[1mrport
\e[22m- remote port number
1613 \e[1mrservice
\e[22m- remote service name from /etc/services
1614 \e[1mlip
\e[22m- local ip address
1615 \e[1mlhost
\e[22m- local host name
1616 \e[1mlport
\e[22m- local port number
1617 \e[1mlservice
\e[22m- local service name from /etc/services
1619 The connection index provides you with access to each connection
1620 in the port monitor. The monitor will return information for in‐
1621 dex values from 0 to n-1 connections. Values higher than n-1 are
1622 simply ignored. For the "count" item, the connection index must
1623 be omitted. It is required for all other items.
1626 \e[1m${tcp_portmon 6881 6999 count}
\e[22m- displays the number of connec‐
1627 tions in the bittorrent port range
1628 \e[1m${tcp_portmon 22 22 rip 0}
\e[22m- displays the remote host ip of the
1629 first sshd connection
1630 \e[1m${tcp_portmon 22 22 rip 9}
\e[22m- displays the remote host ip of the
1631 tenth sshd connection
1632 \e[1m${tcp_portmon 1 1024 rhost 0}
\e[22m- displays the remote host name of
1633 the first connection on a privileged port
1634 \e[1m${tcp_portmon 1 1024 rport 4}
\e[22m- displays the remote host port of
1635 the fifth connection on a privileged port
1636 \e[1m${tcp_portmon 1 65535 lservice 14}
\e[22m- displays the local service
1637 name of the fifteenth connection in the range of all ports
1639 Note that port monitor variables which share the same port range
1640 actually refer to the same monitor, so many references to a sin‐
1641 gle port range for different items and different indexes all use
1642 the same monitor internally. In other words, the program avoids
1643 creating redundant monitors.
1645 \e[1mtexeci interval command
\e[0m
1646 Runs a command at an interval inside a thread and displays the
1647 output. Same as $execi, except the command is run inside a
1648 thread. Use this if you have a slow script to keep Conky updat‐
1649 ing. You should make the interval slightly longer then the time
1650 it takes your script to execute. For example, if you have a
1651 script that take 5 seconds to execute, you should make the in‐
1652 terval at least 6 seconds. See also $execi.
1655 \e[1moffset (pixels)
\e[0m
1656 Move text over by N pixels. See also $voffset.
1659 \e[1mrss url delay_in_minutes action (num_par (spaces_in_front))
\e[0m
1660 Download and parse RSS feeds. Action may be one of the follow‐
1661 ing: feed_title, item_title (with num par), item_desc (with num
1662 par) and item_titles (when using this action and spaces_in_front
1663 is given conky places that many spaces in front of each item).
1666 \e[1mtab (width, (start))
\e[0m
1667 Puts a tab of the specified width, starting from column 'start'.
1668 The unit is pixels for both arguments.
1671 \e[1mtail logfile lines (interval)
\e[0m
1672 Displays last N lines of supplied text text file. If interval is
1673 not supplied, Conky assumes 2x Conky's interval. Max of 30 lines
1674 can be displayed, or until the text buffer is filled.
1677 \e[1mtemplateN (arg1) (arg2) (arg3 ...)
\e[0m
1678 Evaluate the content of the templateN configuration variable
1679 (where N is a value between 0 and 9, inclusively), applying sub‐
1680 stitutions as described in the documentation of the correspond‐
1681 ing configuration variable. The number of arguments is option‐
1682 al, but must match the highest referred index in the template.
1683 You can use the same special sequences in each argument as the
1684 ones valid for a template definition, e.g. to allow an argument
1685 to contain a whitespace. Also simple nesting of templates is
1688 Here are some examples of template definitions:
1691 template1 \1: ${fs_used \2} / ${fs_size \2}
1694 The following list shows sample usage of the templates defined
1695 above, with the equivalent syntax when not using any template at
1698 using template same without template
1699 ─────────────────────────────────────────────────────────────────────────────────
1700 ${template0 node name} $nodename
1701 ${template1 root /} root: ${fs_free /} /
1703 ${template1 ${template2\ disk\ root} /} disk root: ${fs_free /} / ${fs_size /}
1706 \e[1mtime (format)
\e[0m
1707 Local time, see man strftime to get more information about for‐
1711 \e[1mutime (format)
\e[0m
1712 Display time in UTC (universal coordinate time).
1715 \e[1mtztime (timezone) (format)
\e[0m
1716 Local time for specified timezone, see man strftime to get more
1717 information about format. The timezone argument is specified in
1718 similar fashion as TZ environment variable. For hints, look in
1719 /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
1722 \e[1mtotaldown net
\e[0m
1723 Total download, overflows at 4 GB on Linux with 32-bit arch and
1724 there doesn't seem to be a way to know how many times it has al‐
1725 ready done that before conky has started.
1728 \e[1mtop type, num
\e[0m
1729 This takes arguments in the form:top (name) (number) Basically,
1730 processes are ranked from highest to lowest in terms of cpu us‐
1731 age, which is what (num) represents. The types are: "name",
1732 "pid", "cpu", "mem", "mem_res", "mem_vsize", and "time". There
1733 can be a max of 10 processes listed.
1736 \e[1mtop_mem type, num
\e[0m
1737 Same as top, except sorted by mem usage instead of cpu
1740 \e[1mtop_time type, num
\e[0m
1741 Same as top, except sorted by total CPU time instead of current
1745 \e[1mtotalup net
\e[0m
1746 Total upload, this one too, may overflow
1749 \e[1mupdates Number of updates
\e[0m
1753 \e[1mupspeed net
\e[0m
1757 \e[1mupspeedf net
\e[0m
1758 Upload speed in KiB with one decimal
1761 \e[1mupspeedgraph ("normal"|"log") (height),(width) (gradient colour 1)
\e[0m
1762 \e[1m(gradient colour 2) (scale) (net)
\e[0m
1763 Upload speed graph, colours defined in hex, minus the #. If
1764 scale is non-zero, it becomes the scale for the graph. Uses a
1765 logarithmic scale (to see small numbers) when you use "log" in‐
1769 \e[1muptime
\e[22mUptime
1772 \e[1muptime_short
\e[0m
1773 Uptime in a shorter format
1776 \e[1muser_number
\e[0m
1777 Number of users logged in
1780 \e[1muser_names
\e[0m
1781 Lists the names of the users logged in
1784 \e[1muser_terms
\e[0m
1785 Lists the consoles in use
1788 \e[1muser_times
\e[0m
1789 Lists how long users have been logged in for
1792 \e[1mvoffset (pixels)
\e[0m
1793 Change vertical offset by N pixels. Negative values will cause
1794 text to overlap. See also $offset.
1797 \e[1mvoltage_mv (n)
\e[0m
1798 Returns CPU #n's voltage in mV. CPUs are counted from 1. If
1799 omitted, the parameter defaults to 1.
1802 \e[1mvoltage_v (n)
\e[0m
1803 Returns CPU #n's voltage in V. CPUs are counted from 1. If omit‐
1804 ted, the parameter defaults to 1.
1807 \e[1mwireless_essid net
\e[0m
1808 Wireless access point ESSID (Linux only)
1811 \e[1mwireless_mode net
\e[0m
1812 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1815 \e[1mwireless_bitrate net
\e[0m
1816 Wireless bitrate (ie 11 Mb/s) (Linux only)
1819 \e[1mwireless_ap net
\e[0m
1820 Wireless access point MAC address (Linux only)
1823 \e[1mwireless_link_qual net
\e[0m
1824 Wireless link quality (Linux only)
1827 \e[1mwireless_link_qual_max net
\e[0m
1828 Wireless link quality maximum value (Linux only)
1831 \e[1mwireless_link_qual_perc net
\e[0m
1832 Wireless link quality in percents (Linux only)
1835 \e[1mwireless_link_bar (height), (width) net
\e[0m
1836 Wireless link quality bar (Linux only)
1839 \e[1mwords textfile
\e[0m
1840 Displays the number of words in the given file
1843 \e[1mxmms2_artist
\e[0m
1844 Artist in current XMMS2 song
1847 \e[1mxmms2_album
\e[0m
1848 Album in current XMMS2 song
1851 \e[1mxmms2_title
\e[0m
1852 Title in current XMMS2 song
1855 \e[1mxmms2_genre
\e[0m
1856 Genre in current XMMS2 song
1859 \e[1mxmms2_comment
\e[0m
1860 Comment in current XMMS2 song
1864 Full path to current song
1867 \e[1mxmms2_tracknr
\e[0m
1868 Track number in current XMMS2 song
1871 \e[1mxmms2_bitrate
\e[0m
1872 Bitrate of current song
1876 XMMS2 id of current song
1879 \e[1mxmms2_duration
\e[0m
1880 Duration of current song
1883 \e[1mxmms2_elapsed
\e[0m
1887 \e[1mxmms2_size
\e[0m
1888 Size of current song
1891 \e[1mxmms2_percent
\e[0m
1892 Percent of song's progress
1895 \e[1mxmms2_date
\e[0m
1896 Returns song's date.
1899 \e[1mxmms2_playlist
\e[0m
1900 Returns the XMMS2 playlist.
1903 \e[1mxmms2_timesplayed
\e[0m
1904 Number of times a song was played (presumably).
1907 \e[1mxmms2_status
\e[0m
1908 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1911 \e[1mxmms2_bar (height),(width)
\e[0m
1912 Bar of XMMS2's progress
1915 \e[1mxmms2_smart
\e[0m
1916 Prints the song name in either the form "artist - title" or file
1917 name, depending on whats available
1920 \e[1mif_xmms2_connected
\e[0m
1921 Display everything between $if_xmms2_connected and the matching
1922 $endif if xmms2 is running.
1925 \e[1msony_fanspeed
\e[0m
1926 Displays the Sony VAIO fanspeed information if sony-laptop ker‐
1927 nel support is enabled. Linux only.
1930 \e[1meve api_userid api_key character_id
\e[0m
1931 Fetches your currently training skill from the Eve Online API
1932 servers (http://www.eve-online.com/) and displays the skill
1933 along with the remaining training time.
1936 \e[1mendif
\e[22mEnds an $if block.
1940 conky
\e[1m-t '${time %D %H:%M}' -o -u 30
\e[0m
1941 Start Conky in its own window with date and clock as text and 30
1942 sec update interval.
1944 conky
\e[1m-a top_left -x 5 -y 500 -d
\e[0m
1945 Start Conky to background at coordinates (5, 500).
1948 \e[4m~/.conkyrc
\e[24m default configuration file
1951 Drawing to root or some other desktop window directly doesn't work with
1952 all window managers. Especially doesn't work well with Gnome and it has
1953 been reported that it doesn't work with KDE either. Nautilus can be
1954 disabled from drawing to desktop with program gconf-editor. Uncheck
1955 show_desktop in /apps/nautilus/preferences/. There is -w switch in
1956 Conky to set some specific window id. You might find xwininfo -tree
1957 useful to find the window to draw to. You can also use -o argument
1958 which makes Conky to create its own window. If you do try running Conky
1959 in its own window, be sure to read up on the own_window_type settings
1963 ⟨http://conky.sourceforge.net/⟩
1965 ⟨http://www.sourceforge.net/projects/conky⟩
1967 #conky on irc.freenode.net
1970 Copyright (c) 2005-2009 Brenden Matthews, Philip Kovacs, et. al. Any
1971 original torsmo code is licensed under the BSD license (see LICENSE.BSD
1972 for a copy). All code written since the fork of torsmo is licensed un‐
1973 der the GPL (see LICENSE.GPL for a copy), except where noted different‐
1974 ly (such as in portmon code, timed thread code, and audacious code
1975 which are LGPL, and prss which is an MIT-style license).
1978 The Conky dev team (see AUTHORS for a full list of contributors).