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[1mtop_cpu_separate
\e[0m
197 If true, cpu in top will show usage of one processor's power. If
198 false, cpu in top will show the usage of all processors' power
202 \e[1mdefault_color
\e[0m
203 Default color and border color
206 \e[1mdefault_outline_color
\e[0m
207 Default outline color
210 \e[1mdefault_shade_color
\e[0m
211 Default shading color and border's shading color
214 \e[1mdouble_buffer
\e[0m
215 Use the Xdbe extension? (eliminates flicker) It is highly recom‐
216 mended to use own window with this one so double buffer won't be
220 \e[1mdraw_borders
\e[0m
221 Draw borders around text?
224 \e[1mdraw_graph_borders
\e[0m
225 Draw borders around graphs?
228 \e[1mdraw_outline
\e[0m
232 \e[1mdraw_shades
\e[0m
236 \e[1mfont
\e[22mFont name in X, xfontsel can be used to get a nice font
239 \e[1mgap_x
\e[22mGap, in pixels, between right or left border of screen, same as
240 passing -x at command line, e.g. gap_x 10
243 \e[1mgap_y
\e[22mGap, in pixels, between top or bottom border of screen, same as
244 passing -y at command line, e.g. gap_y 10.
247 \e[1mif_up_strictness
\e[0m
248 How strict should if_up be when testing an interface for being
249 up? The value is one of up, link or address, to check for the
250 interface being solely up, being up and having link or being up,
251 having link and an assigned IP address.
254 \e[1mimap
\e[22mDefault global IMAP server. Arguments are: "host user pass [-i
255 interval] [-f folder] [-p port] [-e command] [-r retries]". De‐
256 fault port is 143, default folder is 'INBOX', default interval
257 is 5 minutes, and default number of retries before giving up is
258 5. If the password is supplied as '*', you will be prompted to
259 enter the password when Conky starts.
263 Mail spool for mail checking
266 \e[1mmax_port_monitor_connections
\e[0m
267 Allow each port monitor to track at most this many connections
268 (if 0 or not set, default is 256)
271 \e[1mmax_specials
\e[0m
272 Maximum number of special things, e.g. fonts, offsets, aligns,
273 etc. (default is 512)
276 \e[1mmax_user_text bytes
\e[0m
277 Maximum size of user text buffer, i.e. layout below TEXT line in
278 config file (default is 16384 bytes)
281 \e[1mtext_buffer_size bytes
\e[0m
282 Size of the standard text buffer (default is 256 bytes). This
283 buffer is used for intermediary text, such as individual lines,
284 output from $exec vars, and various other variables. Increasing
285 the size of this buffer can drastically reduce Conky's perfor‐
286 mance, but will allow for more text display per variable. The
287 size of this buffer cannot be smaller than the default value of
291 \e[1mmaximum_width pixels
\e[0m
292 Maximum width of window
295 \e[1mminimum_size width (height)
\e[0m
296 Minimum size of window
307 \e[1mmpd_password
\e[0m
311 \e[1mmusic_player_interval
\e[0m
312 Music player thread update interval (defaults to Conky's update
316 \e[1mnet_avg_samples
\e[0m
317 The number of samples to average for net data
321 Substract (file system) buffers from used memory?
324 \e[1moverride_utf8_locale
\e[0m
325 Force UTF8? requires XFT
329 Boolean, create own window to draw?
332 \e[1mown_window_class
\e[0m
333 Manually set the WM_CLASS name. Defaults to "Conky".
336 \e[1mown_window_colour colour
\e[0m
337 If own_window_transparent no, set a specified background colour
338 (defaults to black). Takes either a hex value (#ffffff) or a
339 valid RGB name (see /usr/lib/X11/rgb.txt)
342 \e[1mown_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager
\e[0m
343 If own_window is yes, you may use these window manager hints to
344 affect the way Conky displays. Notes: Use own_window_type desk‐
345 top as another way to implement many of these hints implicitly.
346 If you use own_window_type override, window manager hints have
347 no meaning and are ignored.
350 \e[1mown_window_title
\e[0m
351 Manually set the window name. Defaults to "<hostname> - conky".
354 \e[1mown_window_transparent
\e[0m
355 Boolean, set pseudo-transparency?
358 \e[1mown_window_type
\e[0m
359 if own_window is yes, you may specify type normal, desktop, dock
360 or override (default: normal). Desktop windows are special win‐
361 dows that have no window decorations; are always visible on your
362 desktop; do not appear in your pager or taskbar; and are sticky
363 across all workspaces. Override windows are not under the con‐
364 trol of the window manager. Hints are ignored. This type of win‐
365 dow can be useful for certain situations.
368 \e[1mout_to_console
\e[0m
369 Print text to stdout.
372 \e[1mout_to_stderr
\e[0m
373 Print text to stderr.
377 When set to no, there will be no output in X (useful when you
378 also use things like out_to_console). If you set it to no, make
379 sure that it's placed before all other X-related setting (take
380 the first line of your configfile to be sure). Default value is
384 \e[1moverwrite_file
\e[0m
385 Overwrite the file given as argument.
388 \e[1mappend_file
\e[0m
389 Append the file given as argument.
392 \e[1mpad_percents
\e[0m
393 Pad percentages to this many decimals (0 = no padding)
396 \e[1mpop3
\e[22mDefault global POP3 server. Arguments are: "host user pass [-i
397 interval] [-p port] [-e command] [-r retries]". Default port is
398 110, default interval is 5 minutes, and default number of re‐
399 tries before giving up is 5. If the password is supplied as '*',
400 you will be prompted to enter the password when Conky starts.
403 \e[1mshort_units
\e[0m
404 Shortens units to a single character (kiB->k, GiB->G, etc.). De‐
408 \e[1mshow_graph_scale
\e[0m
409 Shows the maximum value in scaled graphs.
412 \e[1mshow_graph_range
\e[0m
413 Shows the time range covered by a graph.
416 \e[1mstippled_borders
\e[0m
417 Border stippling (dashing) in pixels
420 \e[1mtemperature_unit
\e[0m
421 Desired output unit of all objects displaying a temperature.
422 Parameters are either "fahrenheit" or "celsius". The default
423 unit is degree Celsius.
427 Define a template for later use inside TEXT segments. Substitute
428 N by a digit between 0 and 9, inclusively. The value of the
429 variable is being inserted into the stuff below TEXT at the cor‐
430 responding position, but before some substitutions are applied:
435 '\N' -> template argument N
438 \e[1mtotal_run_times
\e[0m
439 Total number of times for Conky to update before quitting. Zero
440 makes Conky run forever
443 \e[1mupdate_interval
\e[0m
444 Update interval in seconds
448 Boolean value, if true, text is rendered in upper case
452 Adds spaces around certain objects to stop them from moving oth‐
453 er things around. Arguments are left, right, and none (default).
454 The old true/false values are deprecated and default to
455 right/none respectively. Note that this only helps if you are
456 using a mono font, such as Bitstream Vera Sans Mono.
460 Use Xft (anti-aliased font and stuff)
464 Alpha of Xft font. Must be a value at or between 1 and 0.
471 \e[1mTEXT
\e[22mAfter this begins text to be formatted on screen. Backslash (\)
472 escapes newlines in the text section. This can be useful for
473 cleaning up config files where conky is used to pipe input to
478 Colors are parsed using XParsecolor(), there might be a list of them:
479 /usr/share/X11/rgb.txt. Also, ⟨http://sedition.com/perl/rgb.html⟩.
480 Color can be also in #rrggbb format (hex).
482 \e[1maddr interface
\e[0m
483 IP address for an interface, or "No Address" if no address is
487 \e[1maddrs interface
\e[0m
488 IP addresses for an interface (if one - works like addr). Linux
492 \e[1macpiacadapter
\e[0m
493 ACPI ac adapter state.
501 ACPI temperature in C.
505 CPU temperature from therm_adt746x
509 Fan speed from therm_adt746x
512 \e[1malignr (num)
\e[0m
513 Right-justify text, with space of N
516 \e[1malignc (num)
\e[0m
520 \e[1mapm_adapter
\e[0m
521 Display APM AC adapter status (FreeBSD only)
524 \e[1mapm_battery_life
\e[0m
525 Display APM battery life in percent (FreeBSD only)
528 \e[1mapm_battery_time
\e[0m
529 Display remaining APM battery life in hh:mm:ss or "unknown" if
530 AC adapterstatus is on-line or charging (FreeBSD only)
533 \e[1maudacious_bar (height),(width)
\e[0m
537 \e[1maudacious_bitrate
\e[0m
538 Bitrate of current tune
541 \e[1maudacious_channels
\e[0m
542 Number of audio channels of current tune
545 \e[1maudacious_filename
\e[0m
546 Full path and filename of current tune
549 \e[1maudacious_frequency
\e[0m
550 Sampling frequency of current tune
553 \e[1maudacious_length
\e[0m
554 Total length of current tune as MM:SS
557 \e[1maudacious_length_seconds
\e[0m
558 Total length of current tune in seconds
561 \e[1maudacious_playlist_position
\e[0m
562 Playlist position of current tune
565 \e[1maudacious_playlist_length
\e[0m
566 Number of tunes in playlist
569 \e[1maudacious_position
\e[0m
570 Position of current tune (MM:SS)
573 \e[1maudacious_position_seconds
\e[0m
574 Position of current tune in seconds
577 \e[1maudacious_status
\e[0m
578 Player status (Playing/Paused/Stopped/Not running)
581 \e[1maudacious_title (max length)
\e[0m
582 Title of current tune with optional maximum length specifier
585 \e[1maudacious_main_volume
\e[0m
586 The current volume fetched from Audacious
589 \e[1mbattery (num)
\e[0m
590 Battery status and remaining percentage capacity of ACPI or APM
591 battery. ACPI battery number can be given as argument (default
595 \e[1mbattery_short (num)
\e[0m
596 Battery status and remaining percentage capacity of ACPI or APM
597 battery. ACPI battery number can be given as argument (default
598 is BAT0). This mode display a short status, which means that C
599 is displayed instead of charging and D is displayed instead of
603 \e[1mbattery_bar (height),(width) (num)
\e[0m
604 Battery percentage remaining of ACPI battery in a bar. ACPI bat‐
605 tery number can be given as argument (default is BAT0).
608 \e[1mbattery_percent (num)
\e[0m
609 Battery percentage remaining for ACPI battery. ACPI battery num‐
610 ber can be given as argument (default is BAT0).
613 \e[1mbattery_time (num)
\e[0m
614 Battery charge/discharge time remaining of ACPI battery. ACPI
615 battery number can be given as argument (default is BAT0).
618 \e[1mbmpx_artist
\e[0m
619 Artist in current BMPx track
623 Album in current BMPx track
627 Title of the current BMPx track
631 Track number of the current BMPx track
634 \e[1mbmpx_bitrate
\e[0m
635 Bitrate of the current BMPx track
639 URI of the current BMPx track
643 Amount of memory buffered
646 \e[1mcached
\e[22mAmount of memory cached
649 \e[1mcolor (color)
\e[0m
650 Change drawing color to color
653 \e[1mcolorN
\e[22mChange drawing color to colorN configuration option, where N is
654 a digit between 0 and 9, inclusively.
657 \e[1mconky_version
\e[0m
661 \e[1mconky_build_date
\e[0m
665 \e[1mconky_build_arch
\e[0m
666 CPU architecture Conky was built for
670 CPU usage in percents. For SMP machines, the CPU number can be
671 provided as an argument. ${cpu cpu0} is the total usage, and
672 ${cpu cpuX} (X >= 1) are individual CPUs.
675 \e[1mcpubar (cpuN) (height),(width)
\e[0m
676 Bar that shows CPU usage, height is bar's height in pixels. See
677 $cpu for more info on SMP.
680 \e[1mcpugauge (cpuN) (height),(width)
\e[0m
681 Elliptical gauge that shows CPU usage, height and width are
682 gauge's vertical and horizontal axis respectively. See $cpu for
686 \e[1mcpugraph (cpuN) ("normal"|"log") (height),(width) (gradient colour 1)
\e[0m
687 \e[1m(gradient colour 2) (scale)
\e[0m
688 CPU usage graph, with optional colours in hex, minus the #. See
689 $cpu for more info on SMP. Uses a logarithmic scale (to see
690 small numbers) when you use "log" instead of "normal".
693 \e[1mdiskio (device)
\e[0m
694 Displays current disk IO. Device is optional, and takes the form
695 of sda for /dev/sda. Individual partitions are allowed.
698 \e[1mdiskiograph ("normal"|"log") (height),(width) (gradient colour 1) (gra‐
\e[0m
699 \e[1mdient colour 2) (scale) (device)
\e[0m
700 Disk IO graph, colours defined in hex, minus the #. If scale is
701 non-zero, it becomes the scale for the graph. Uses a logarithmic
702 scale (to see small numbers) when you use "log" instead of "nor‐
706 \e[1mdiskio_read (device)
\e[0m
707 Displays current disk IO for reads. Device as in diskio.
710 \e[1mdiskiograph_read ("normal"|"log") (height),(width) (gradient colour 1)
\e[0m
711 \e[1m(gradient colour 2) (scale) (device)
\e[0m
712 Disk IO graph for reads, colours defined in hex, minus the #. If
713 scale is non-zero, it becomes the scale for the graph. Device as
714 in diskio. Uses a logarithmic scale (to see small numbers) when
715 you use "log" instead of "normal".
718 \e[1mdiskio_write (device)
\e[0m
719 Displays current disk IO for writes. Device as in diskio.
722 \e[1mdiskiograph_write ("normal"|"log") (height),(width) (gradient colour 1)
\e[0m
723 \e[1m(gradient colour 2) (scale) (device)
\e[0m
724 Disk IO graph for writes, colours defined in hex, minus the #.
725 If scale is non-zero, it becomes the scale for the graph. Device
726 as in diskio. Uses a logarithmic scale (to see small numbers)
727 when you use "log" instead of "normal".
730 \e[1mdisk_protect device
\e[0m
731 Disk protection status, if supported (needs kernel-patch).
732 Prints either "frozen" or "free " (note the padding).
735 \e[1mdownspeed net
\e[0m
736 Download speed in KiB
739 \e[1mdownspeedf net
\e[0m
740 Download speed in KiB with one decimal
743 \e[1mdownspeedgraph ("normal"|"log") (height),(width) (gradient colour 1)
\e[0m
744 \e[1m(gradient colour 2) (scale) (net)
\e[0m
745 Download speed graph, colours defined in hex, minus the #. If
746 scale is non-zero, it becomes the scale for the graph. Uses a
747 logarithmic scale (to see small numbers) when you use "log" in‐
751 \e[1melse
\e[22mText to show if any of the above are not true
754 \e[1mentropy_avail
\e[0m
755 Current entropy available for crypto freaks
758 \e[1mentropy_bar (height),(width)
\e[0m
759 Normalized bar of available entropy for crypto freaks
762 \e[1mentropy_poolsize
\e[0m
763 Total size of system entropy pool for crypto freaks
766 \e[1meval string
\e[0m
767 Evalutates given string according to the rules of TEXT interpre‐
768 tation, i.e. parsing any contained text object specifications
769 into their output, any occuring '$$' into a single '$' and so
770 on. The output is then being parsed again.
773 \e[1mexec command
\e[0m
774 Executes a shell command and displays the output in conky. warn‐
775 ing: this takes a lot more resources than other variables. I'd
776 recommend coding wanted behaviour in C and posting a patch.
779 \e[1mexecbar command
\e[0m
780 Same as exec, except if the first value return is a value be‐
781 tween 0-100, it will use that number for a bar. The size for the
782 bar is currently fixed, but that may change in the future.
785 \e[1mexecgauge command
\e[0m
786 Same as exec, except if the first value return is a value be‐
787 tween 0-100, it will use that number for a gauge. The size for
788 the gauge is currently fixed, but you may change that for the
789 future conky release.
792 \e[1mexecgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐
\e[0m
793 \e[1ment colour 2) (scale) command
\e[0m
794 Same as execbar, but graphs values. Uses a logaritmic scale when
795 the log option is given (to see small numbers). Values still
796 have to be between 0 and 100.
799 \e[1mexeci interval command
\e[0m
800 Same as exec but with specific interval. Interval can't be less
801 than update_interval in configuration. See also $texeci
804 \e[1mexecibar interval command
\e[0m
805 Same as execbar, except with an interval
808 \e[1mexecigraph interval command
\e[0m
809 Same as execgraph, but takes an interval arg graphs values
812 \e[1mexecp command
\e[0m
813 Executes a shell command and displays the output in conky. warn‐
814 ing: this takes a lot more resources than other variables. I'd
815 recommend coding wanted behaviour in C and posting a patch. This
816 differs from $exec in that it parses the output of the command,
817 so you can insert things like ${color red}hi!${color} in your
818 script and have it correctly parsed by Conky. Caveats: Conky
819 parses and evaluates the output of $execp every time Conky
820 loops, and then destroys all the objects. If you try to use any‐
821 thing like $execi within an $execp statement, it will function‐
822 ally run at the same interval that the $execp statement runs, as
823 it is created and destroyed at every interval.
826 \e[1mexecpi interval command
\e[0m
827 Same as execp but with specific interval. Interval can't be less
828 than update_interval in configuration. Note that the output from
829 the $execpi command is still parsed and evaluated at every in‐
833 \e[1mfont (font)
\e[0m
834 Specify a different font. This new font will apply to the cur‐
835 rent line and everything following. You can use a $font with no
836 arguments to change back to the default font (much like with
841 Returns CPU #n's frequency in MHz. CPUs are counted from 1. If
842 omitted, the parameter defaults to 1.
846 Returns CPU #n's frequency in GHz. CPUs are counted from 1. If
847 omitted, the parameter defaults to 1.
850 \e[1mfreq_dyn (n)
\e[0m
851 Returns CPU #n's frequency in MHz (defaults to 1), but is calcu‐
852 lated by counting to clock cycles to complete an instruction.
853 Only available for x86/amd64.
856 \e[1mfreq_dyn_g (n)
\e[0m
857 Returns CPU #n's frequency in GHz (defaults to 1), but is calcu‐
858 lated by counting to clock cycles to complete an instruction.
859 Only available for x86/amd64.
862 \e[1mfs_bar (height),(width) fs
\e[0m
863 Bar that shows how much space is used on a file system. height
864 is the height in pixels. fs is any file on that file system.
867 \e[1mfs_free (fs)
\e[0m
868 Free space on a file system available for users.
871 \e[1mfs_free_perc (fs)
\e[0m
872 Free percentage of space on a file system available for users.
875 \e[1mfs_size (fs)
\e[0m
879 \e[1mfs_type (fs)
\e[0m
883 \e[1mfs_used (fs)
\e[0m
884 File system used space
887 \e[1mgoto x
\e[22mThe next element will be printed at position 'x'.
891 Displays the default route's interface or "multiple"/"none" ac‐
895 \e[1mgw_ip
\e[22mDisplays the default gateway's IP or "multiple"/"none" accord‐
899 \e[1mhddtemp dev, (host,(port))
\e[0m
900 Displays temperature of a selected hard disk drive as reported
901 by the hddtemp daemon running on host:port. Default host is
902 127.0.0.1, default port is 7634.
905 \e[1mhead logfile lines (interval)
\e[0m
906 Displays first N lines of supplied text text file. If interval
907 is not supplied, Conky assumes 2x Conky's interval. Max of 30
908 lines can be displayed, or until the text buffer is filled.
911 \e[1mhr (height)
\e[0m
912 Horizontal line, height is the height in pixels
915 \e[1mhwmon (dev) type n
\e[0m
916 Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omit‐
917 ted if you have only one hwmon device. Parameter type is either
918 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning
919 temperature. Parameter n is number of the sensor. See
920 /sys/class/hwmon/ on your local computer.
923 \e[1miconv_start codeset_from codeset_to
\e[0m
924 Convert text from one codeset to another using GNU iconv. Needs
925 to be stopped with iconv_stop.
929 Stop iconv codeset conversion.
932 \e[1mi2c (dev) type n
\e[0m
933 I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted
934 if you have only one I2C device. Parameter type is either 'in'
935 or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning tem‐
936 perature. Parameter n is number of the sensor. See
937 /sys/bus/i2c/devices/ on your local computer.
940 \e[1mi8k_ac_status
\e[0m
941 If running the i8k kernel driver for Inspiron laptops, displays
942 whether ac power is on, as listed in /proc/i8k (translated to
943 human-readable). Beware that this is by default not enabled by
948 If running the i8k kernel driver for Inspiron laptops, displays
949 the bios version as listed in /proc/i8k.
952 \e[1mi8k_buttons_status
\e[0m
953 If running the i8k kernel driver for Inspiron laptops, displays
954 the volume buttons status as listed in /proc/i8k.
957 \e[1mi8k_cpu_temp
\e[0m
958 If running the i8k kernel driver for Inspiron laptops, displays
959 the cpu temperature in Celsius, as reported by /proc/i8k.
962 \e[1mi8k_left_fan_rpm
\e[0m
963 If running the i8k kernel driver for Inspiron laptops, displays
964 the left fan's rate of rotation, in revolutions per minute as
965 listed in /proc/i8k. Beware, some laptops i8k reports these fans
969 \e[1mi8k_left_fan_status
\e[0m
970 If running the i8k kernel driver for Inspiron laptops, displays
971 the left fan status as listed in /proc/i8k (translated to human-
972 readable). Beware, some laptops i8k reports these fans in re‐
976 \e[1mi8k_right_fan_rpm
\e[0m
977 If running the i8k kernel driver for Inspiron laptops, displays
978 the right fan's rate of rotation, in revolutions per minute as
979 listed in /proc/i8k. Beware, some laptops i8k reports these fans
983 \e[1mi8k_right_fan_status
\e[0m
984 If running the i8k kernel driver for Inspiron laptops, displays
985 the right fan status as listed in /proc/i8k (translated to hu‐
986 man-readable). Beware, some laptops i8k reports these fans in
991 If running the i8k kernel driver for Inspiron laptops, displays
992 your laptop serial number as listed in /proc/i8k.
995 \e[1mi8k_version
\e[0m
996 If running the i8k kernel driver for Inspiron laptops, displays
997 the version formatting of /proc/i8k.
1001 If running the IBM ACPI, displays the fan speed.
1004 \e[1mibm_temps N
\e[0m
1005 If running the IBM ACPI, displays the temperatures from the IBM
1006 temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
1010 \e[1mibm_volume
\e[0m
1011 If running the IBM ACPI, displays the "master" volume, con‐
1012 trolled by the volume keys (0-14).
1015 \e[1mibm_brightness
\e[0m
1016 If running the IBM ACPI, displays the brigtness of the laptops's
1020 \e[1mif_empty (var)
\e[0m
1021 if conky variable VAR is empty, display everything between
1022 $if_empty and the matching $endif
1025 \e[1mif_existing file (string)
\e[0m
1026 if FILE exists, display everything between if_existing and the
1027 matching $endif. The optional second paramater checks for FILE
1028 containing the specified string and prints everything between
1029 $if_existing and the matching $endif.
1032 \e[1mif_gw
\e[22mif there is at least one default gateway, display everything be‐
1033 tween $if_gw and the matching $endif
1036 \e[1mif_match expression
\e[0m
1037 Evaluates the given boolean expression, printing everything be‐
1038 tween $if_match and the matching $endif depending on whether the
1039 evaluation returns true or not. Valid expressions consist of a
1040 left side, an operator and a right side. Left and right sides
1041 are being parsed for contained text objects before evaluation.
1042 Recognised left and right side types are:
1044 \e[1mdouble
\e[22m: argument consists of only digits and a single dot.
1045 \e[1mlong
\e[22m: argument consists of only digits.
1046 \e[1mstring
\e[22m: argument is enclosed in quotation mark or the checks for
1047 double and long failed before.
1049 Valid operands are: '>', '<', '>=', '<=', '==', '!='.
1052 \e[1mif_running (process)
\e[0m
1053 if PROCESS is running, display everything $if_running and the
1054 matching $endif. This uses the ``pidof'' command, so the -x
1055 switch is also supported.
1058 \e[1mif_mounted (mountpoint)
\e[0m
1059 if MOUNTPOINT is mounted, display everything between $if_mounted
1060 and the matching $endif
1063 \e[1mif_smapi_bat_installed (INDEX)
\e[0m
1064 when using smapi, if the battery with index INDEX is installed,
1065 display everything between $if_smapi_bat_installed and the
1069 \e[1mif_up (interface)
\e[0m
1070 if INTERFACE exists and is up, display everything between $if_up
1071 and the matching $endif
1074 \e[1mif_updatenr (updatenr)
\e[0m
1075 If it's the UPDATENR-th time that conky updates, display every‐
1076 thing between $if_updatenr and the matching $endif. The counter
1077 resets when the highest UPDATENR is reached. Example :
1078 "{$if_updatenr 1}foo$endif{$if_updatenr 2}bar$endif{$if_updatenr
1079 4}$endif" shows foo 25% of the time followed by bar 25% of the
1080 time followed by nothing the other half of the time.
1083 \e[1mimap_messages (args)
\e[0m
1084 Displays the number of messages in your global IMAP inbox by de‐
1085 fault. You can define individual IMAP inboxes seperately by
1086 passing arguments to this object. Arguments are: "host user pass
1087 [-i interval] [-p port] [-e command] [-r retries]". Default port
1088 is 143, default interval is 5 minutes, and default number of re‐
1089 tries before giving up is 5. If the password is supplied as '*',
1090 you will be prompted to enter the password when Conky starts.
1093 \e[1mimap_unseen (args)
\e[0m
1094 Displays the number of unseen messages in your global IMAP inbox
1095 by default. You can define individual IMAP inboxes seperately by
1096 passing arguments to this object. Arguments are: "host user pass
1097 [-i interval] [-p port] [-e command] [-r retries]". Default port
1098 is 143, default interval is 5 minutes, and default number of re‐
1099 tries before giving up is 5. If the password is supplied as '*',
1100 you will be prompted to enter the password when Conky starts.
1103 \e[1mioscheduler disk
\e[0m
1104 Prints the current ioscheduler used for the given disk name
1105 (i.e. e.g. "hda" or "sdb")
1108 \e[1mkernel
\e[22mKernel version
1111 \e[1mlaptop_mode
\e[0m
1112 The value of /proc/sys/vm/laptop_mode
1116 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
1117 5 minutes and 3 for past 15 minutes.
1120 \e[1mloadgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐
\e[0m
1121 \e[1ment colour 2) (scale)
\e[0m
1122 Load1 average graph, similar to xload, with optional colours in
1123 hex, minus the #. Uses a logarithmic scale (to see small num‐
1124 bers) when you use "log" instead of "normal".
1127 \e[1mlines textfile
\e[0m
1128 Displays the number of lines in the given file
1132 Machine, i686 for example
1135 \e[1mmails (mailbox) (interval)
\e[0m
1136 Mail count in the specified mailbox or your mail spool if not.
1137 Both mbox and maildir type mailboxes are supported. You can use
1138 a program like fetchmail to get mails from some server using
1139 your favourite protocol. See also new_mails.
1142 \e[1mnew_mails (mailbox) (interval)
\e[0m
1143 Unread mail count in the specified mailbox or mail spool if not.
1144 Both mbox and maildir type mailboxes are supported.
1147 \e[1mseen_mails (maildir) (interval)
\e[0m
1148 Number of mails marked as seen in the specified mailbox or mail
1149 spool if not. Only maildir type mailboxes are supported, mbox
1150 type will return -1.
1153 \e[1munseen_mails (maildir) (interval)
\e[0m
1154 Number of new or unseen mails in the specified mailbox or mail
1155 spool if not. Only maildir type mailboxes are supported, mbox
1156 type will return -1.
1159 \e[1mflagged_mails (maildir) (interval)
\e[0m
1160 Number of mails marked as flagged in the specified mailbox or
1161 mail spool if not. Only maildir type mailboxes are supported,
1162 mbox type will return -1.
1165 \e[1munflagged_mails (maildir) (interval)
\e[0m
1166 Number of mails not marked as flagged in the specified mailbox
1167 or mail spool if not. Only maildir type mailboxes are supported,
1168 mbox type will return -1.
1171 \e[1mforwarded_mails (maildir) (interval)
\e[0m
1172 Number of mails marked as forwarded in the specified mailbox or
1173 mail spool if not. Only maildir type mailboxes are supported,
1174 mbox type will return -1.
1177 \e[1munforwarded_mails (maildir) (interval)
\e[0m
1178 Number of mails not marked as forwarded in the specified mailbox
1179 or mail spool if not. Only maildir type mailboxes are supported,
1180 mbox type will return -1.
1183 \e[1mreplied_mails (maildir) (interval)
\e[0m
1184 Number of mails marked as replied in the specified mailbox or
1185 mail spool if not. Only maildir type mailboxes are supported,
1186 mbox type will return -1.
1189 \e[1munreplied_mails (maildir) (interval)
\e[0m
1190 Number of mails not marked as replied in the specified mailbox
1191 or mail spool if not. Only maildir type mailboxes are supported,
1192 mbox type will return -1.
1195 \e[1mdraft_mails (maildir) (interval)
\e[0m
1196 Number of mails marked as draft in the specified mailbox or mail
1197 spool if not. Only maildir type mailboxes are supported, mbox
1198 type will return -1.
1201 \e[1mtrashed_mails (maildir) (interval)
\e[0m
1202 Number of mails marked as trashed in the specified mailbox or
1203 mail spool if not. Only maildir type mailboxes are supported,
1204 mbox type will return -1.
1207 \e[1mmboxscan (-n number of messages to print) (-fw from width) (-sw subject
\e[0m
1208 \e[1mwidth) mbox
\e[0m
1209 Print a summary of recent messages in an mbox format mailbox.
1210 mbox parameter is the filename of the mailbox (can be encapsu‐
1211 lated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
1214 \e[1mmem
\e[22mAmount of memory in use
1217 \e[1mmembar (height),(width)
\e[0m
1218 Bar that shows amount of memory in use
1221 \e[1mmemgauge (height),(width)
\e[0m
1222 Gauge that shows amount of memory in use (see cpugauge)
1225 \e[1mmemgraph ("normal"|"log") (height),(width) (gradient colour 1) (gradi‐
\e[0m
1226 \e[1ment colour 2) (scale)
\e[0m
1227 Memory usage graph. Uses a logarithmic scale (to see small num‐
1228 bers) when you use "log" instead of "normal".
1231 \e[1mmemeasyfree
\e[0m
1232 Amount of free memory including the memory that is very easily
1233 freed (buffers/cache)
1237 Amount of free memory
1240 \e[1mmemmax
\e[22mTotal amount of memory
1244 Percentage of memory in use
1247 \e[1mmixer (device)
\e[0m
1248 Prints the mixer value as reported by the OS. Default mixer is
1249 "vol", but you can specify one of the following optional argu‐
1250 ments: "vol", "bass", "treble", "synth", "pcm", "speaker",
1251 "line", "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain",
1252 "line1", "line2", "line3", "dig1", "dig2", "dig3", "phin",
1253 "phout", "video", "radio", "monitor". Refer to the definition of
1254 SOUND_DEVICE_NAMES in <linux/soundcard.h> (on Linux), <sound‐
1255 card.h> (on OpenBSD), or <sys/soundcard.h> to find the exact op‐
1256 tions available on your system.
1259 \e[1mmixerbar (device)
\e[0m
1260 Displays mixer value in a bar as reported by the OS. See docs
1261 for $mixer for details on arguments.
1264 \e[1mmixerr (device)
\e[0m
1265 Prints the right channel mixer value as reported by the OS. See
1266 docs for $mixer for details on arguments.
1269 \e[1mmixerrbar (device)
\e[0m
1270 Displays the right channel mixer value in a bar as reported by
1271 the OS. See docs for $mixer for details on arguments.
1274 \e[1mmixerl (device)
\e[0m
1275 Prints the left channel mixer value as reported by the OS. See
1276 docs for $mixer for details on arguments.
1279 \e[1mmixerlbar (device)
\e[0m
1280 Displays the left channel mixer value in a bar as reported by
1281 the OS. See docs for $mixer for details on arguments.
1285 Current state of MOC; playing, stopped etc.
1289 File name of the current MOC song
1293 Title of the current MOC song
1296 \e[1mmoc_artist
\e[0m
1297 Artist of the current MOC song
1301 The current song name being played in MOC.
1305 Album of the current MOC song
1308 \e[1mmoc_totaltime
\e[0m
1309 Total length of the current MOC song
1312 \e[1mmoc_timeleft
\e[0m
1313 Time left in the current MOC song
1316 \e[1mmoc_curtime
\e[0m
1317 Current time of the current MOC song
1320 \e[1mmoc_bitrate
\e[0m
1321 Bitrate in the current MOC song
1325 Rate of the current MOC song
1329 Number of the monitor on which conky is running
1332 \e[1mmonitor_number
\e[0m
1336 \e[1mmpd_artist
\e[0m
1337 Artist in current MPD song must be enabled at compile
1341 Album in current MPD song
1344 \e[1mmpd_bar (height),(width)
\e[0m
1345 Bar of mpd's progress
1348 \e[1mmpd_bitrate
\e[0m
1349 Bitrate of current song
1352 \e[1mmpd_status
\e[0m
1353 Playing, stopped, et cetera.
1356 \e[1mmpd_title (max length)
\e[0m
1357 Title of current MPD song
1364 \e[1mmpd_elapsed
\e[0m
1368 \e[1mmpd_length
\e[0m
1372 \e[1mmpd_percent
\e[0m
1373 Percent of song's progress
1376 \e[1mmpd_random
\e[0m
1377 Random status (On/Off)
1380 \e[1mmpd_repeat
\e[0m
1381 Repeat status (On/Off)
1385 Prints the MPD track field
1389 Prints the MPD name field
1393 Prints the file name of the current MPD song
1396 \e[1mmpd_smart (max length)
\e[0m
1397 Prints the song name in either the form "artist - title" or file
1398 name, depending on whats available
1401 \e[1mif_mpd_playing
\e[0m
1402 if mpd is playing or paused, display everything between
1403 $if_mpd_playing and the matching $endif
1406 \e[1mnameserver (index)
\e[0m
1407 Print a nameserver from /etc/resolv.conf. Index starts at and
1415 \e[1mnvidia threshold temp ambient gpufreq memfreq imagequality
\e[0m
1416 Nvidia graficcard support for the XNVCtrl library. Each option
1417 can be shortened to the least significant part. Temperatures
1418 are printed as float, all other values as integer.
1420 \e[1mthreshold
\e[22m: the thresholdtemperature at which the gpu slows down
1421 \e[1mtemp
\e[22m: gives the gpu current temperature
1422 \e[1mambient
\e[22m: gives current air temperature near GPU case
1423 \e[1mgpufreq
\e[22m: gives the current gpu frequency
1424 \e[1mmemfreq
\e[22m: gives the current mem frequency
1425 \e[1mimagequality
\e[22m: which imagequality should be choosen by OpenGL ap‐
1429 \e[1moutlinecolor (color)
\e[0m
1430 Change outline color
1433 \e[1mpb_battery item
\e[0m
1434 If running on Apple powerbook/ibook, display information on bat‐
1435 tery status. The item parameter specifies, what information to
1436 display. Exactly one item must be specified. Valid items are:
1438 \e[1mstatus
\e[22m: Display if battery is fully charged, charging, discharg‐
1439 ing or absent (running on AC)
1440 \e[1mpercent
\e[22m: Display charge of battery in percent, if charging or
1441 discharging. Nothing will be displayed, if battery is fully
1443 \e[1mtime
\e[22m: Display the time remaining until the battery will be fully
1444 charged or discharged at current rate. Nothing is displayed, if
1445 battery is absent or if it's present but fully charged and not
1449 \e[1mplatform (dev) type n
\e[0m
1450 Platform sensor from sysfs (Linux 2.6). Parameter dev may be
1451 omitted if you have only one platform device. Platform type is
1452 either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp'
1453 meaning temperature. Parameter n is number of the sensor. See
1454 /sys/bus/platform/devices/ on your local computer.
1457 \e[1mpop3_unseen (args)
\e[0m
1458 Displays the number of unseen messages in your global POP3 inbox
1459 by default. You can define individual POP3 inboxes seperately by
1460 passing arguments to this object. Arguments are: "host user pass
1461 [-i interval] [-p port] [-e command] [-r retries]". Default port
1462 is 110, default interval is 5 minutes, and default number of re‐
1463 tries before giving up is 5. If the password is supplied as '*',
1464 you will be prompted to enter the password when Conky starts.
1467 \e[1mpop3_used (args)
\e[0m
1468 Displays the amount of space (in MiB, 2^20) used in your global
1469 POP3 inbox by default. You can define individual POP3 inboxes
1470 seperately by passing arguments to this object. Arguments are:
1471 "host user pass [-i interval] [-p port] [-e command] [-r re‐
1472 tries]". Default port is 110, default interval is 5 minutes, and
1473 default number of retries before giving up is 5. If the password
1474 is supplied as '*', you will be prompted to enter the password
1478 \e[1mpre_exec shell command
\e[0m
1479 Executes a shell command one time before conky displays anything
1480 and puts output as text.
1484 Total processes (sleeping and running)
1487 \e[1mrunning_processes
\e[0m
1488 Running processes (not sleeping), requires Linux 2.6
1491 \e[1mscroll length (step) text
\e[0m
1492 Scroll 'text' by 'step' characters showing 'length' number of
1493 characters at the same time. The text may also contain vari‐
1494 ables. 'step' is optional and defaults to 1 if not set. If a var
1495 creates output on multiple lines then the lines are placed be‐
1496 hind each other separated with a '|'-sign. Do NOT use vars that
1497 change colors or otherwise affect the design inside a scrolling
1498 text. If you want spaces between the start and the end of
1499 'text', place them at the end of 'text' not at the front ("foo‐
1500 bar" and " foobar" can both generate "barfoo" but "foobar " will
1501 keep the spaces like this "bar foo").
1504 \e[1mshadecolor (color)
\e[0m
1505 Change shading color
1508 \e[1msmapi (ARGS)
\e[0m
1509 when using smapi, display contents of the /sys/devices/plat‐
1510 form/smapi directory. ARGS are either '(FILENAME)' or 'bat (IN‐
1511 DEX) (FILENAME)' to display the corresponding files' content.
1512 This is a very raw method of accessing the smapi values. When
1513 available, better use one of the smapi_* variables instead.
1516 \e[1msmapi_bat_bar (INDEX),(height),(width)
\e[0m
1517 when using smapi, display the remaining capacity of the battery
1518 with index INDEX as a bar.
1521 \e[1msmapi_bat_perc (INDEX)
\e[0m
1522 when using smapi, display the remaining capacity in percent of
1523 the battery with index INDEX. This is a separate variable be‐
1524 cause it supports the 'use_spacer' configuration option.
1527 \e[1msmapi_bat_power INDEX
\e[0m
1528 when using smapi, display the current power of the battery with
1529 index INDEX in watt. This is a separate variable because the
1530 original read out value is being converted from mW. The sign of
1531 the output reflects charging (positive) or discharging (nega‐
1535 \e[1msmapi_bat_temp INDEX
\e[0m
1536 when using smapi, display the current temperature of the battery
1537 with index INDEX in degree Celsius. This is a separate variable
1538 because the original read out value is being converted from mil‐
1542 \e[1mstippled_hr (space)
\e[0m
1543 Stippled (dashed) horizontal line
1546 \e[1mswapbar (height),(width)
\e[0m
1547 Bar that shows amount of swap in use
1550 \e[1mswap
\e[22mAmount of swap in use
1554 Total amount of swap
1558 Percentage of swap in use
1562 System name, Linux for example
1565 \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
1566 TCP port monitor for specified local ports. Port numbers must be
1567 in the range 1 to 65535. Valid items are:
1569 \e[1mcount
\e[22m- total number of connections in the range
1570 \e[1mrip
\e[22m- remote ip address
1571 \e[1mrhost
\e[22m- remote host name
1572 \e[1mrport
\e[22m- remote port number
1573 \e[1mrservice
\e[22m- remote service name from /etc/services
1574 \e[1mlip
\e[22m- local ip address
1575 \e[1mlhost
\e[22m- local host name
1576 \e[1mlport
\e[22m- local port number
1577 \e[1mlservice
\e[22m- local service name from /etc/services
1579 The connection index provides you with access to each connection
1580 in the port monitor. The monitor will return information for in‐
1581 dex values from 0 to n-1 connections. Values higher than n-1 are
1582 simply ignored. For the "count" item, the connection index must
1583 be omitted. It is required for all other items.
1586 \e[1m${tcp_portmon 6881 6999 count}
\e[22m- displays the number of connec‐
1587 tions in the bittorrent port range
1588 \e[1m${tcp_portmon 22 22 rip 0}
\e[22m- displays the remote host ip of the
1589 first sshd connection
1590 \e[1m${tcp_portmon 22 22 rip 9}
\e[22m- displays the remote host ip of the
1591 tenth sshd connection
1592 \e[1m${tcp_portmon 1 1024 rhost 0}
\e[22m- displays the remote host name of
1593 the first connection on a privileged port
1594 \e[1m${tcp_portmon 1 1024 rport 4}
\e[22m- displays the remote host port of
1595 the fifth connection on a privileged port
1596 \e[1m${tcp_portmon 1 65535 lservice 14}
\e[22m- displays the local service
1597 name of the fifteenth connection in the range of all ports
1599 Note that port monitor variables which share the same port range
1600 actually refer to the same monitor, so many references to a sin‐
1601 gle port range for different items and different indexes all use
1602 the same monitor internally. In other words, the program avoids
1603 creating redundant monitors.
1605 \e[1mtexeci interval command
\e[0m
1606 Runs a command at an interval inside a thread and displays the
1607 output. Same as $execi, except the command is run inside a
1608 thread. Use this if you have a slow script to keep Conky updat‐
1609 ing. You should make the interval slightly longer then the time
1610 it takes your script to execute. For example, if you have a
1611 script that take 5 seconds to execute, you should make the in‐
1612 terval at least 6 seconds. See also $execi.
1615 \e[1moffset (pixels)
\e[0m
1616 Move text over by N pixels. See also $voffset.
1619 \e[1mrss url delay_in_minutes action item_num
\e[0m
1620 Download and parse RSS feeds. Action may be one of the follow‐
1621 ing: feed_title, item_title (with num par), item_desc (with num
1622 par) and item_titles.
1625 \e[1mtab (width, (start))
\e[0m
1626 Puts a tab of the specified width, starting from column 'start'.
1629 \e[1mtail logfile lines (interval)
\e[0m
1630 Displays last N lines of supplied text text file. If interval is
1631 not supplied, Conky assumes 2x Conky's interval. Max of 30 lines
1632 can be displayed, or until the text buffer is filled.
1635 \e[1mtemplateN (arg1) (arg2) (arg3 ...)
\e[0m
1636 Evaluate the content of the templateN configuration variable
1637 (where N is a value between 0 and 9, inclusively), applying sub‐
1638 stitutions as described in the documentation of the correspond‐
1639 ing configuration variable. The number of arguments is option‐
1640 al, but must match the highest referred index in the template.
1641 You can use the same special sequences in each argument as the
1642 ones valid for a template definition, e.g. to allow an argument
1643 to contain a whitespace. Also simple nesting of templates is
1646 Here are some examples of template definitions:
1649 template1 \1: ${fs_used \2} / ${fs_size \2}
1652 The following list shows sample usage of the templates defined
1653 above, with the equivalent syntax when not using any template at
1656 using template same without template
1657 ─────────────────────────────────────────────────────────────────────────────────
1658 ${template0 node name} $nodename
1659 ${template1 root /} root: ${fs_free /} /
1661 ${template1 ${template2\ disk\ root} /} disk root: ${fs_free /} / ${fs_size /}
1664 \e[1mtime (format)
\e[0m
1665 Local time, see man strftime to get more information about for‐
1669 \e[1mutime (format)
\e[0m
1670 Display time in UTC (universal coordinate time).
1673 \e[1mtztime (timezone) (format)
\e[0m
1674 Local time for specified timezone, see man strftime to get more
1675 information about format. The timezone argument is specified in
1676 similar fashion as TZ environment variable. For hints, look in
1677 /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
1680 \e[1mtotaldown net
\e[0m
1681 Total download, overflows at 4 GB on Linux with 32-bit arch and
1682 there doesn't seem to be a way to know how many times it has al‐
1683 ready done that before conky has started.
1686 \e[1mtop type, num
\e[0m
1687 This takes arguments in the form:top (name) (number) Basically,
1688 processes are ranked from highest to lowest in terms of cpu us‐
1689 age, which is what (num) represents. The types are: "name",
1690 "pid", "cpu", "mem", "mem_res", "mem_vsize", and "time". There
1691 can be a max of 10 processes listed.
1694 \e[1mtop_mem type, num
\e[0m
1695 Same as top, except sorted by mem usage instead of cpu
1698 \e[1mtop_time type, num
\e[0m
1699 Same as top, except sorted by total CPU time instead of current
1703 \e[1mtotalup net
\e[0m
1704 Total upload, this one too, may overflow
1707 \e[1mupdates Number of updates
\e[0m
1711 \e[1mupspeed net
\e[0m
1715 \e[1mupspeedf net
\e[0m
1716 Upload speed in KiB with one decimal
1719 \e[1mupspeedgraph ("normal"|"log") (height),(width) (gradient colour 1)
\e[0m
1720 \e[1m(gradient colour 2) (scale) (net)
\e[0m
1721 Upload speed graph, colours defined in hex, minus the #. If
1722 scale is non-zero, it becomes the scale for the graph. Uses a
1723 logarithmic scale (to see small numbers) when you use "log" in‐
1727 \e[1muptime
\e[22mUptime
1730 \e[1muptime_short
\e[0m
1731 Uptime in a shorter format
1734 \e[1muser_number
\e[0m
1735 Number of users logged in
1738 \e[1muser_names
\e[0m
1739 Lists the names of the users logged in
1742 \e[1muser_terms
\e[0m
1743 Lists the consoles in use
1746 \e[1muser_times
\e[0m
1747 Lists how long users have been logged in for
1750 \e[1mvoffset (pixels)
\e[0m
1751 Change vertical offset by N pixels. Negative values will cause
1752 text to overlap. See also $offset.
1755 \e[1mvoltage_mv (n)
\e[0m
1756 Returns CPU #n's voltage in mV. CPUs are counted from 1. If
1757 omitted, the parameter defaults to 1.
1760 \e[1mvoltage_v (n)
\e[0m
1761 Returns CPU #n's voltage in V. CPUs are counted from 1. If omit‐
1762 ted, the parameter defaults to 1.
1765 \e[1mwireless_essid net
\e[0m
1766 Wireless access point ESSID (Linux only)
1769 \e[1mwireless_mode net
\e[0m
1770 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1773 \e[1mwireless_bitrate net
\e[0m
1774 Wireless bitrate (ie 11 Mb/s) (Linux only)
1777 \e[1mwireless_ap net
\e[0m
1778 Wireless access point MAC address (Linux only)
1781 \e[1mwireless_link_qual net
\e[0m
1782 Wireless link quality (Linux only)
1785 \e[1mwireless_link_qual_max net
\e[0m
1786 Wireless link quality maximum value (Linux only)
1789 \e[1mwireless_link_qual_perc net
\e[0m
1790 Wireless link quality in percents (Linux only)
1793 \e[1mwireless_link_bar (height), (width) net
\e[0m
1794 Wireless link quality bar (Linux only)
1797 \e[1mwords textfile
\e[0m
1798 Displays the number of words in the given file
1801 \e[1mxmms2_artist
\e[0m
1802 Artist in current XMMS2 song
1805 \e[1mxmms2_album
\e[0m
1806 Album in current XMMS2 song
1809 \e[1mxmms2_title
\e[0m
1810 Title in current XMMS2 song
1813 \e[1mxmms2_genre
\e[0m
1814 Genre in current XMMS2 song
1817 \e[1mxmms2_comment
\e[0m
1818 Comment in current XMMS2 song
1821 \e[1mxmms2_decoder
\e[0m
1825 \e[1mxmms2_transport
\e[0m
1826 Transport plugin used
1830 Full path to current song
1833 \e[1mxmms2_tracknr
\e[0m
1834 Track number in current XMMS2 song
1837 \e[1mxmms2_bitrate
\e[0m
1838 Bitrate of current song
1842 XMMS2 id of current song
1845 \e[1mxmms2_duration
\e[0m
1846 Duration of current song
1849 \e[1mxmms2_elapsed
\e[0m
1853 \e[1mxmms2_size
\e[0m
1854 Size of current song
1857 \e[1mxmms2_percent
\e[0m
1858 Percent of song's progress
1861 \e[1mxmms2_status
\e[0m
1862 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1865 \e[1mxmms2_bar (height),(width)
\e[0m
1866 Bar of XMMS2's progress
1869 \e[1mxmms2_smart
\e[0m
1870 Prints the song name in either the form "artist - title" or file
1871 name, depending on whats available
1874 \e[1mif_xmms2_connected
\e[0m
1875 Display everything between $if_xmms2_connected and the matching
1876 $endif if xmms2 is running.
1879 \e[1meve api_userid api_key character_id
\e[0m
1880 Fetches your currently training skill from the Eve Online API
1881 servers (http://www.eve-online.com/) and displays the skill
1882 along with the remaining training time.
1886 conky
\e[1m-t '${time %D %H:%M}' -o -u 30
\e[0m
1887 Start Conky in its own window with date and clock as text and 30
1888 sec update interval.
1890 conky
\e[1m-a top_left -x 5 -y 500 -d
\e[0m
1891 Start Conky to background at coordinates (5, 500).
1894 \e[4m~/.conkyrc
\e[24m default configuration file
1897 Drawing to root or some other desktop window directly doesn't work with
1898 all window managers. Especially doesn't work well with Gnome and it has
1899 been reported that it doesn't work with KDE either. Nautilus can be
1900 disabled from drawing to desktop with program gconf-editor. Uncheck
1901 show_desktop in /apps/nautilus/preferences/. There is -w switch in
1902 Conky to set some specific window id. You might find xwininfo -tree
1903 useful to find the window to draw to. You can also use -o argument
1904 which makes Conky to create its own window. If you do try running Conky
1905 in its own window, be sure to read up on the own_window_type settings
1909 ⟨http://conky.sourceforge.net/⟩
1911 ⟨http://www.sourceforge.net/projects/conky⟩
1913 #conky on irc.freenode.net
1916 Copyright (c) 2005-2009 Brenden Matthews, Philip Kovacs, et. al. Any
1917 original torsmo code is licensed under the BSD license (see LICENSE.BSD
1918 for a copy). All code written since the fork of torsmo is licensed un‐
1919 der the GPL (see LICENSE.GPL for a copy), except where noted different‐
1920 ly (such as in portmon code, timed thread code, and audacious code
1921 which are LGPL, and prss which is an MIT-style license).
1924 The Conky dev team (see AUTHORS for a full list of contributors).