1 '\" t -*- coding: us-ascii -*-
3 .if \n(.g .ds T> \\F[\n[.fam]]
7 .if \n(.g .mso www.tmac
8 .TH conky 1 2008-12-07 "" ""
10 conky \- A system monitor for X originally based on the torsmo code, but more kickass. It just keeps on given'er. Yeah.
16 .if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
23 Conky is a system monitor for X originally based on torsmo.
24 Since its inception, Conky has changed significantly from its predecessor, while maintaining
25 simplicity and configurability. Conky can display just about anything, either
26 on your root desktop or in its own window. Not only does Conky have many
27 built-in objects, it can also display just about any piece of information by
28 using scripts and other external programs.
30 Conky has more than 250 built in objects, including support for
31 a plethora of OS stats (uname, uptime, CPU usage, mem usage, disk
32 usage, "top" like process stats, and network monitoring, just to name a few),
33 built in IMAP and POP3 support, built in support for many popular
34 music players (MPD, XMMS2, BMPx, Audacious), and much much more.
35 Conky can display this info either as text, or using simple progress
36 bars and graph widgets, with different fonts and colours.
38 We are always looking for help, whether its reporting bugs, writing patches, or writing docs.
39 Please use the facilities at SourceForge to make bug reports, feature requests, and submit patches,
40 or stop by #conky on irc.freenode.net if you have questions or want to contribute.
42 Thanks for your interest in Conky.
44 For users compiling from source on a binary distro, make sure you have the X development
45 libraries installed. This should be a package along the lines of "libx11-dev" or
46 "xorg-x11-dev" for X11 libs, and similar "-dev" format for the other libs required (depending
47 on your configure options).
49 Conky has (for some time) been available in the repositories of most popular distributions.
50 Here are some installation instructions for a few:
52 Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-admin/conky" for installation.
53 There is also usually an up-to-date ebuild within Conky's package or in the git repo.
55 Debian, etc. users -- Conky should be in your repositories, and can be installed by doing
56 "aptitude install conky".
58 Example to compile and run Conky with all optional components (note that some configure options may differ for your system):
60 \fB\*(T<\fBsh autogen.sh\fR\*(T>\fR \*(T<\fB# Only required if building from the git repo\fR\*(T>
62 \fB\*(T<\fB\&./configure \fR\*(T>\fR\*(T<\fB\-\-prefix=/usr \-\-mandir=/usr/share/man \-\-infodir=/usr/share/info \-\-datadir=/usr/share \-\-sysconfdir=/etc \-\-localstatedir=/var/lib \-\-disable\-own\-window \-\-enable\-audacious[=yes|no|legacy] \-\-enable\-bmpx \-\-disable\-hddtemp \-\-disable\-mpd \-\-enable\-xmms2 \-\-disable\-portmon \-\-disable\-network \-\-enable\-debug \-\-disable\-x11 \-\-disable\-double\-buffer \-\-disable\-xdamage \-\-disable\-xft\fR\*(T>
64 \fB\*(T<\fBmake\fR\*(T>\fR
66 \fB\*(T<\fBmake install\fR\*(T>\fR \*(T<\fB# Optional\fR\*(T>
68 \fB\*(T<\fBsrc/conky\fR\*(T>\fR
70 Conky has been tested to be compatible with C99 C, however it has not been tested
71 with anything other than gcc, and is not guaranteed to work with other compilers.
74 Conky is generally very good on resources. That said, the more you try to make Conky
75 do, the more resources it is going to consume.
77 An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1 conky".
78 Saves you the trouble of having to kill and then restart. You can now also do the same with SIGHUP.
80 Command line options override configurations defined in configuration file.
82 \fB\*(T<\fB\-v | \-V | \-\-version\fR\*(T>\fR
83 Prints version and exits
86 \fB\*(T<\fB\-q | \-\-quiet\fR\*(T>\fR
87 Run Conky in 'quiet mode' (ie. no output)
90 \fB\*(T<\fB\-a | \-\-alignment=\fR\*(T>\fR\*(T<\fBALIGNMENT\fR\*(T>
91 Text alignment on screen, {top,bottom,middle}_{left,right,middle} or none
94 \fB\*(T<\fB\-b | \-\-double\-buffer\fR\*(T>\fR
95 Use double buffering (eliminates "flicker")
98 \fB\*(T<\fB\-c | \-\-config=\fR\*(T>\fR\*(T<\fBFILE\fR\*(T>
99 Config file to load instead of $HOME/.conkyrc
102 \fB\*(T<\fB\-d | \-\-daemonize\fR\*(T>\fR
103 Daemonize Conky, aka fork to background
106 \fB\*(T<\fB\-f | \-\-font=\fR\*(T>\fR\*(T<\fBFONT\fR\*(T>
110 \fB\*(T<\fB\-h | \-\-help\fR\*(T>\fR
111 Prints command line help and exits
114 \fB\*(T<\fB\-o | \-\-own\-window\fR\*(T>\fR
115 Create own window to draw
118 \fB\*(T<\fB\-t | \-\-text=\fR\*(T>\fR\*(T<\fBTEXT\fR\*(T>
119 Text to render, remember single quotes, like -t ' $uptime '
122 \fB\*(T<\fB\-u | \-\-interval=\fR\*(T>\fR\*(T<\fBSECONDS\fR\*(T>
126 \fB\*(T<\fB\-w | \-\-window\-id=\fR\*(T>\fR\*(T<\fBWIN_ID\fR\*(T>
130 \fB\*(T<\fB\-x \fR\*(T>\fR\*(T<\fBX_COORDINATE\fR\*(T>
134 \fB\*(T<\fB\-y \fR\*(T>\fR\*(T<\fBY_COORDINATE\fR\*(T>
138 \fB\*(T<\fB\-i \fR\*(T>\fR\*(T<\fBCOUNT\fR\*(T>
139 Number of times to update Conky (and quit)
141 .SH "CONFIGURATION SETTINGS"
142 Default configuration file location is $HOME/.conkyrc or
143 ${sysconfdir}/conky/conky.conf. On most systems, sysconfdir is /etc,
144 and you can find the sample config file there (/etc/conky/conky.conf).
146 You might want to copy it to $HOME/.conkyrc and then start modifying it.
147 Other configs can be found at http://conky.sf.net/
149 \fB\*(T<\fBalignment\fR\*(T>\fR
150 Aligned position on screen, may be top_left, top_right, top_middle, bottom_left, bottom_right, bottom_middle, middle_left, middle_right, or none (also can be abreviated as tl, tr, tm, bl, br, bm, ml, mr)
153 \fB\*(T<\fBbackground\fR\*(T>\fR
154 Boolean value, if true, Conky will be forked to background when started
157 \fB\*(T<\fBborder_margin\fR\*(T>\fR
158 Border margin in pixels
161 \fB\*(T<\fBborder_width\fR\*(T>\fR
162 Border width in pixels
165 \fB\*(T<\fBcolorN\fR\*(T>\fR
166 Predefine a color for use inside TEXT segments. Substitute N by a digit between 0 and 9, inclusively. When specifying the color value in hex, omit the leading hash (#).
169 \fB\*(T<\fBcpu_avg_samples\fR\*(T>\fR
170 The number of samples to average for CPU monitoring
173 \fB\*(T<\fBtop_cpu_separate\fR\*(T>\fR
174 If true, cpu in top will show usage of one processor's power. If false, cpu in top will show the usage of all processors' power combined.
177 \fB\*(T<\fBdefault_color\fR\*(T>\fR
178 Default color and border color
181 \fB\*(T<\fBdefault_outline_color\fR\*(T>\fR
182 Default outline color
185 \fB\*(T<\fBdefault_shade_color\fR\*(T>\fR
186 Default shading color and border's shading color
189 \fB\*(T<\fBdouble_buffer\fR\*(T>\fR
190 Use the Xdbe extension? (eliminates flicker) It is highly recommended to use own window with this one so double buffer won't be so big.
193 \fB\*(T<\fBdraw_borders\fR\*(T>\fR
194 Draw borders around text?
197 \fB\*(T<\fBdraw_graph_borders\fR\*(T>\fR
198 Draw borders around graphs?
201 \fB\*(T<\fBdraw_outline\fR\*(T>\fR
205 \fB\*(T<\fBdraw_shades\fR\*(T>\fR
209 \fB\*(T<\fBfont\fR\*(T>\fR
210 Font name in X, xfontsel can be used to get a nice font
213 \fB\*(T<\fBgap_x\fR\*(T>\fR
214 Gap, in pixels, between right or left border of screen, same as passing -x at command line,
218 \fB\*(T<\fBgap_y\fR\*(T>\fR
219 Gap, in pixels, between top or bottom border of screen, same as passing -y at command line,
223 \fB\*(T<\fBif_up_strictness\fR\*(T>\fR
224 How strict should if_up be when testing an interface for being up? The value is one of up, link or address, to check for the interface being solely up, being up and having link or being up, having link and an assigned IP address.
227 \fB\*(T<\fBimap\fR\*(T>\fR
228 Default global IMAP server. Arguments are: "host user pass [-i interval] [-f folder] [-p port] [-e command] [-r retries]". Default port is 143, default folder is 'INBOX', default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
231 \fB\*(T<\fBmail_spool\fR\*(T>\fR
232 Mail spool for mail checking
235 \fB\*(T<\fBmax_port_monitor_connections\fR\*(T>\fR
236 Allow each port monitor to track at most this many connections (if 0 or not set, default is 256)
239 \fB\*(T<\fBmax_specials\fR\*(T>\fR
240 Maximum number of special things, e.g. fonts, offsets, aligns, etc. (default is 512)
243 \fB\*(T<\fBmax_user_text\fR\*(T>\fR \*(T<\fBbytes\fR\*(T>
244 Maximum size of user text buffer, i.e. layout below TEXT line in config file
245 (default is 16384 bytes)
248 \fB\*(T<\fBtext_buffer_size\fR\*(T>\fR \*(T<\fBbytes\fR\*(T>
249 Size of the standard text buffer (default is 256 bytes). This buffer is used for intermediary text, such as individual lines, output from $exec vars, and various other variables. Increasing the size of this buffer can drastically reduce Conky's performance, but will allow for more text display per variable. The size of this buffer cannot be smaller than the default value of 256 bytes.
252 \fB\*(T<\fBmaximum_width\fR\*(T>\fR \*(T<\fBpixels\fR\*(T>
253 Maximum width of window
256 \fB\*(T<\fBminimum_size\fR\*(T>\fR \*(T<\fBwidth (height)\fR\*(T>
257 Minimum size of window
260 \fB\*(T<\fBmpd_host\fR\*(T>\fR
264 \fB\*(T<\fBmpd_port\fR\*(T>\fR
268 \fB\*(T<\fBmpd_password\fR\*(T>\fR
272 \fB\*(T<\fBmusic_player_interval\fR\*(T>\fR
273 Music player thread update interval (defaults to Conky's update interval)
276 \fB\*(T<\fBnet_avg_samples\fR\*(T>\fR
277 The number of samples to average for net data
280 \fB\*(T<\fBno_buffers\fR\*(T>\fR
281 Substract (file system) buffers from used memory?
284 \fB\*(T<\fBoverride_utf8_locale\fR\*(T>\fR
285 Force UTF8? requires XFT
288 \fB\*(T<\fBown_window\fR\*(T>\fR
289 Boolean, create own window to draw?
292 \fB\*(T<\fBown_window_class\fR\*(T>\fR
293 Manually set the WM_CLASS name. Defaults to "Conky".
296 \fB\*(T<\fBown_window_colour\fR\*(T>\fR \*(T<\fBcolour\fR\*(T>
297 If own_window_transparent no, set a specified background colour (defaults to black). Takes either a hex value (#ffffff) or a valid RGB name (see /usr/lib/X11/rgb.txt)
300 \fB\*(T<\fBown_window_hints\fR\*(T>\fR \*(T<\fBundecorated,below,above,sticky,skip_taskbar,skip_pager\fR\*(T>
301 If own_window is yes, you may use these window manager hints to affect the way Conky displays.
302 Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
303 If you use own_window_type override, window manager hints have no meaning and are ignored.
306 \fB\*(T<\fBown_window_title\fR\*(T>\fR
307 Manually set the window name. Defaults to "<hostname> - conky".
310 \fB\*(T<\fBown_window_transparent\fR\*(T>\fR
311 Boolean, set pseudo-transparency?
314 \fB\*(T<\fBown_window_type\fR\*(T>\fR
315 if own_window is yes, you may specify type normal, desktop, dock or override (default: normal).
316 Desktop windows are special windows that have no window decorations; are always visible
317 on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
318 Override windows are not under the control of the window manager. Hints are ignored. This type
319 of window can be useful for certain situations.
322 \fB\*(T<\fBout_to_console\fR\*(T>\fR
323 Print text to stdout.
326 \fB\*(T<\fBout_to_stderr\fR\*(T>\fR
327 Print text to stderr.
330 \fB\*(T<\fBpad_percents\fR\*(T>\fR
331 Pad percentages to this many decimals (0 = no padding)
334 \fB\*(T<\fBpop3\fR\*(T>\fR
335 Default global POP3 server. Arguments are: "host user pass [-i interval] [-p port] [-e command] [-r retries]". Default port is 110, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
338 \fB\*(T<\fBshort_units\fR\*(T>\fR
339 Shortens units to a single character (kiB->k, GiB->G, etc.). Default is off.
342 \fB\*(T<\fBshow_graph_scale\fR\*(T>\fR
343 Shows the maximum value in scaled graphs.
346 \fB\*(T<\fBshow_graph_range\fR\*(T>\fR
347 Shows the time range covered by a graph.
350 \fB\*(T<\fBstippled_borders\fR\*(T>\fR
351 Border stippling (dashing) in pixels
354 \fB\*(T<\fBtemperature_unit\fR\*(T>\fR
355 Desired output unit of all objects displaying a temperature.
356 Parameters are either "fahrenheit" or "celsius". The default
357 unit is degree Celsius.
360 \fB\*(T<\fBtemplateN\fR\*(T>\fR
361 Define a template for later use inside TEXT segments. Substitute N by a digit between 0 and 9, inclusively.
362 The value of the variable is being inserted into the stuff below TEXT at the corresponding position,
363 but before some substitutions are applied:
367 \&'\e\e' -> backslash
371 \&'\eN' -> template argument N
374 \fB\*(T<\fBtotal_run_times\fR\*(T>\fR
375 Total number of times for Conky to update before quitting. Zero makes Conky run forever
378 \fB\*(T<\fBupdate_interval\fR\*(T>\fR
379 Update interval in seconds
382 \fB\*(T<\fBuppercase\fR\*(T>\fR
383 Boolean value, if true, text is rendered in upper case
386 \fB\*(T<\fBuse_spacer\fR\*(T>\fR
387 Adds spaces around certain objects to stop them from moving other things around. Arguments are left, right, and none (default). The old true/false values are deprecated and default to right/none respectively. Note that this only helps if you are using a mono font, such as Bitstream Vera Sans Mono.
390 \fB\*(T<\fBuse_xft\fR\*(T>\fR
391 Use Xft (anti-aliased font and stuff)
394 \fB\*(T<\fBxftalpha\fR\*(T>\fR
395 Alpha of Xft font. Must be a value at or between 1 and 0.
398 \fB\*(T<\fBxftfont\fR\*(T>\fR
402 \fB\*(T<\fBTEXT\fR\*(T>\fR
403 After this begins text to be formatted on screen. Backslash (\e) escapes newlines in the text section. This can be useful for cleaning up config files where conky is used to pipe input to dzen2.
406 Colors are parsed using XParsecolor(), there might be a list of them:
407 /usr/share/X11/rgb.txt. Also, \(lahttp://sedition.com/perl/rgb.html\(ra.
408 Color can be also in #rrggbb format (hex).
410 \fB\*(T<\fBaddr\fR\*(T>\fR \*(T<\fBinterface\fR\*(T>
411 IP address for an interface, or "No Address" if no address is assigned.
414 \fB\*(T<\fBaddrs\fR\*(T>\fR \*(T<\fBinterface\fR\*(T>
415 IP addresses for an interface (if one - works like addr). Linux only.
418 \fB\*(T<\fBacpiacadapter\fR\*(T>\fR
419 ACPI ac adapter state.
422 \fB\*(T<\fBacpifan\fR\*(T>\fR
426 \fB\*(T<\fBacpitemp\fR\*(T>\fR
427 ACPI temperature in C.
430 \fB\*(T<\fBadt746xcpu\fR\*(T>\fR
431 CPU temperature from therm_adt746x
434 \fB\*(T<\fBadt746xfan\fR\*(T>\fR
435 Fan speed from therm_adt746x
438 \fB\*(T<\fBalignr\fR\*(T>\fR \*(T<\fB(num)\fR\*(T>
439 Right-justify text, with space of N
442 \fB\*(T<\fBalignc\fR\*(T>\fR \*(T<\fB(num)\fR\*(T>
446 \fB\*(T<\fBapm_adapter\fR\*(T>\fR
447 Display APM AC adapter status (FreeBSD only)
450 \fB\*(T<\fBapm_battery_life\fR\*(T>\fR
451 Display APM battery life in percent (FreeBSD only)
454 \fB\*(T<\fBapm_battery_time\fR\*(T>\fR
455 Display remaining APM battery life in hh:mm:ss or "unknown" if
456 AC adapterstatus is on-line or charging (FreeBSD only)
459 \fB\*(T<\fBaudacious_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
463 \fB\*(T<\fBaudacious_bitrate\fR\*(T>\fR
464 Bitrate of current tune
467 \fB\*(T<\fBaudacious_channels\fR\*(T>\fR
468 Number of audio channels of current tune
471 \fB\*(T<\fBaudacious_filename\fR\*(T>\fR
472 Full path and filename of current tune
475 \fB\*(T<\fBaudacious_frequency\fR\*(T>\fR
476 Sampling frequency of current tune
479 \fB\*(T<\fBaudacious_length\fR\*(T>\fR
480 Total length of current tune as MM:SS
483 \fB\*(T<\fBaudacious_length_seconds\fR\*(T>\fR
484 Total length of current tune in seconds
487 \fB\*(T<\fBaudacious_playlist_position\fR\*(T>\fR
488 Playlist position of current tune
491 \fB\*(T<\fBaudacious_playlist_length\fR\*(T>\fR
492 Number of tunes in playlist
495 \fB\*(T<\fBaudacious_position\fR\*(T>\fR
496 Position of current tune (MM:SS)
499 \fB\*(T<\fBaudacious_position_seconds\fR\*(T>\fR
500 Position of current tune in seconds
503 \fB\*(T<\fBaudacious_status\fR\*(T>\fR
504 Player status (Playing/Paused/Stopped/Not running)
507 \fB\*(T<\fBaudacious_title\fR\*(T>\fR \*(T<\fB(max length)\fR\*(T>
508 Title of current tune with optional maximum length specifier
511 \fB\*(T<\fBaudacious_main_volume\fR\*(T>\fR
512 The current volume fetched from Audacious
515 \fB\*(T<\fBbattery\fR\*(T>\fR \*(T<\fB(num)\fR\*(T>
516 Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
519 \fB\*(T<\fBbattery_bar\fR\*(T>\fR \*(T<\fB(height),(width) (num)\fR\*(T>
520 Battery percentage remaining of ACPI battery in a bar. ACPI battery number can be given as argument (default is BAT0).
523 \fB\*(T<\fBbattery_percent\fR\*(T>\fR \*(T<\fB(num)\fR\*(T>
524 Battery percentage remaining for ACPI battery. ACPI battery number can be given as argument (default is BAT0).
527 \fB\*(T<\fBbattery_time\fR\*(T>\fR \*(T<\fB(num)\fR\*(T>
528 Battery charge/discharge time remaining of ACPI battery. ACPI battery number can be given as argument (default is BAT0).
531 \fB\*(T<\fBbmpx_artist\fR\*(T>\fR
532 Artist in current BMPx track
535 \fB\*(T<\fBbmpx_album\fR\*(T>\fR
536 Album in current BMPx track
539 \fB\*(T<\fBbmpx_title\fR\*(T>\fR
540 Title of the current BMPx track
543 \fB\*(T<\fBbmpx_track\fR\*(T>\fR
544 Track number of the current BMPx track
547 \fB\*(T<\fBbmpx_bitrate\fR\*(T>\fR
548 Bitrate of the current BMPx track
551 \fB\*(T<\fBbmpx_uri\fR\*(T>\fR
552 URI of the current BMPx track
555 \fB\*(T<\fBbuffers\fR\*(T>\fR
556 Amount of memory buffered
559 \fB\*(T<\fBcached\fR\*(T>\fR
560 Amount of memory cached
563 \fB\*(T<\fBcolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T>
564 Change drawing color to color
567 \fB\*(T<\fBcolorN\fR\*(T>\fR
568 Change drawing color to colorN configuration option, where N is a digit between 0 and 9, inclusively.
571 \fB\*(T<\fBconky_version\fR\*(T>\fR
575 \fB\*(T<\fBconky_build_date\fR\*(T>\fR
579 \fB\*(T<\fBconky_build_arch\fR\*(T>\fR
580 CPU architecture Conky was built for
583 \fB\*(T<\fBcpu\fR\*(T>\fR \*(T<\fB(cpuN)\fR\*(T>
584 CPU usage in percents. For SMP machines, the CPU number can be provided as an argument. ${cpu cpu0} is the total usage, and ${cpu cpuX} (X >= 1) are individual CPUs.
587 \fB\*(T<\fBcpubar\fR\*(T>\fR \*(T<\fB(cpu number) (height),(width)\fR\*(T>
588 Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
591 \fB\*(T<\fBcpugraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (cpu number)\fR\*(T>
592 CPU usage graph, with optional colours in hex, minus the #. See $cpu for more info on SMP. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
595 \fB\*(T<\fBdiskio\fR\*(T>\fR \*(T<\fB(device)\fR\*(T>
596 Displays current disk IO. Device is optional, and takes the form of sda for /dev/sda. Individual partitions are allowed.
599 \fB\*(T<\fBdiskiograph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)\fR\*(T>
600 Disk IO graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
603 \fB\*(T<\fBdiskio_read\fR\*(T>\fR \*(T<\fB(device)\fR\*(T>
604 Displays current disk IO for reads. Device as in diskio.
607 \fB\*(T<\fBdiskiograph_read\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)\fR\*(T>
608 Disk IO graph for reads, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Device as in diskio. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
611 \fB\*(T<\fBdiskio_write\fR\*(T>\fR \*(T<\fB(device)\fR\*(T>
612 Displays current disk IO for writes. Device as in diskio.
615 \fB\*(T<\fBdiskiograph_write\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)\fR\*(T>
616 Disk IO graph for writes, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Device as in diskio. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
619 \fB\*(T<\fBdisk_protect\fR\*(T>\fR \*(T<\fBdevice\fR\*(T>
620 Disk protection status, if supported (needs kernel-patch). Prints either "frozen" or "free " (note the padding).
623 \fB\*(T<\fBdownspeed\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
624 Download speed in KiB
627 \fB\*(T<\fBdownspeedf\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
628 Download speed in KiB with one decimal
631 \fB\*(T<\fBdownspeedgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (net)\fR\*(T>
632 Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
635 \fB\*(T<\fBelse\fR\*(T>\fR
636 Text to show if any of the above are not true
639 \fB\*(T<\fBentropy_avail\fR\*(T>\fR
640 Current entropy available for crypto freaks
643 \fB\*(T<\fBentropy_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
644 Normalized bar of available entropy for crypto freaks
647 \fB\*(T<\fBentropy_poolsize\fR\*(T>\fR
648 Total size of system entropy pool for crypto freaks
651 \fB\*(T<\fBexec\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>
652 Executes a shell command and displays the output in conky. warning: this takes a lot more resources than other variables. I'd recommend coding wanted behaviour in C and posting a patch.
655 \fB\*(T<\fBexecbar\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>
656 Same as exec, except if the first value return is a value between 0-100, it will use that number for a bar. The size for the bar is currently fixed, but that may change in the future.
659 \fB\*(T<\fBexecgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) command\fR\*(T>
660 Same as execbar, but graphs values. Uses a logaritmic scale when the log option is given (to see small numbers). Values still have to be between 0 and 100.
663 \fB\*(T<\fBexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
664 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
667 \fB\*(T<\fBexecibar\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
668 Same as execbar, except with an interval
671 \fB\*(T<\fBexecigraph\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
672 Same as execgraph, but takes an interval arg graphs values
675 \fB\*(T<\fBexecp\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>
676 Executes a shell command and displays the output in conky. warning: this takes a lot more resources than other variables. I'd recommend coding wanted behaviour in C and posting a patch. This differs from $exec in that it parses the output of the command, so you can insert things like ${color red}hi!${color} in your script and have it correctly parsed by Conky.
677 Caveats: Conky parses and evaluates the output of $execp every time Conky loops, and then destroys all the objects. If you try to use anything like $execi within an $execp statement, it will functionally run at the same interval that the $execp statement runs, as it is created and destroyed at every interval.
680 \fB\*(T<\fBexecpi\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
681 Same as execp but with specific interval. Interval can't be less than update_interval in configuration. Note that the output from the $execpi command is still parsed and evaluated at every interval.
684 \fB\*(T<\fBfont\fR\*(T>\fR \*(T<\fB(font)\fR\*(T>
685 Specify a different font. This new font will apply to the current line and everything following. You can use a $font with no arguments to change back to the default font (much like with $color)
688 \fB\*(T<\fBfreq\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
689 Returns CPU #n's frequency in MHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
692 \fB\*(T<\fBfreq_g\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
693 Returns CPU #n's frequency in GHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
696 \fB\*(T<\fBfreq_dyn\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
697 Returns CPU #n's frequency in MHz (defaults to 1), but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
700 \fB\*(T<\fBfreq_dyn_g\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
701 Returns CPU #n's frequency in GHz (defaults to 1), but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
704 \fB\*(T<\fBfs_bar\fR\*(T>\fR \*(T<\fB(height),(width) fs\fR\*(T>
705 Bar that shows how much space is used on a file system. height is the height in pixels. fs is any file on that file system.
708 \fB\*(T<\fBfs_free\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
709 Free space on a file system available for users.
712 \fB\*(T<\fBfs_free_perc\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
713 Free percentage of space on a file system available for users.
716 \fB\*(T<\fBfs_size\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
720 \fB\*(T<\fBfs_type\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
724 \fB\*(T<\fBfs_used\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
725 File system used space
728 \fB\*(T<\fBgoto\fR\*(T>\fR \*(T<\fBx\fR\*(T>
729 The next element will be printed at position 'x'.
732 \fB\*(T<\fBgw_iface\fR\*(T>\fR
733 Displays the default route's interface or "multiple"/"none" accordingly.
736 \fB\*(T<\fBgw_ip\fR\*(T>\fR
737 Displays the default gateway's IP or "multiple"/"none" accordingly.
740 \fB\*(T<\fBhddtemp\fR\*(T>\fR \*(T<\fBdev, (host,(port))\fR\*(T>
741 Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
742 Default host is 127.0.0.1, default port is 7634.
745 \fB\*(T<\fBhead\fR\*(T>\fR \*(T<\fBlogfile lines (interval)\fR\*(T>
746 Displays first N lines of supplied text text file. If interval is not supplied, Conky assumes 2x Conky's interval. Max of 30 lines can be displayed, or until the text buffer is filled.
749 \fB\*(T<\fBhr\fR\*(T>\fR \*(T<\fB(height)\fR\*(T>
750 Horizontal line, height is the height in pixels
753 \fB\*(T<\fBhwmon\fR\*(T>\fR \*(T<\fB(dev) type n\fR\*(T>
754 Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omitted if you have only one hwmon device. Parameter type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning temperature. Parameter n is number of the sensor. See /sys/class/hwmon/ on your local computer.
757 \fB\*(T<\fBiconv_start\fR\*(T>\fR \*(T<\fBcodeset_from codeset_to\fR\*(T>
758 Convert text from one codeset to another using GNU iconv. Needs to be stopped with iconv_stop.
761 \fB\*(T<\fBiconv_stop\fR\*(T>\fR
762 Stop iconv codeset conversion.
765 \fB\*(T<\fBi2c\fR\*(T>\fR \*(T<\fB(dev) type n\fR\*(T>
766 I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted if you have only one I2C device. Parameter type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning temperature. Parameter n is number of the sensor. See /sys/bus/i2c/devices/ on your local computer.
769 \fB\*(T<\fBi8k_ac_status\fR\*(T>\fR
770 If running the i8k kernel driver for Inspiron laptops, displays whether ac power is on, as listed in /proc/i8k (translated to human-readable). Beware that this is by default not enabled by i8k itself.
773 \fB\*(T<\fBi8k_bios\fR\*(T>\fR
774 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
777 \fB\*(T<\fBi8k_buttons_status\fR\*(T>\fR
778 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
781 \fB\*(T<\fBi8k_cpu_temp\fR\*(T>\fR
782 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
785 \fB\*(T<\fBi8k_left_fan_rpm\fR\*(T>\fR
786 If running the i8k kernel driver for Inspiron laptops, displays the left fan's rate of rotation, in revolutions per minute as listed in /proc/i8k. Beware, some laptops i8k reports these fans in reverse order.
789 \fB\*(T<\fBi8k_left_fan_status\fR\*(T>\fR
790 If running the i8k kernel driver for Inspiron laptops, displays the left fan status as listed in /proc/i8k (translated to human-readable). Beware, some laptops i8k reports these fans in reverse order.
793 \fB\*(T<\fBi8k_right_fan_rpm\fR\*(T>\fR
794 If running the i8k kernel driver for Inspiron laptops, displays the right fan's rate of rotation, in revolutions per minute as listed in /proc/i8k. Beware, some laptops i8k reports these fans in reverse order.
797 \fB\*(T<\fBi8k_right_fan_status\fR\*(T>\fR
798 If running the i8k kernel driver for Inspiron laptops, displays the right fan status as listed in /proc/i8k (translated to human-readable). Beware, some laptops i8k reports these fans in reverse order.
801 \fB\*(T<\fBi8k_serial\fR\*(T>\fR
802 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
805 \fB\*(T<\fBi8k_version\fR\*(T>\fR
806 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
809 \fB\*(T<\fBibm_fan\fR\*(T>\fR
810 If running the IBM ACPI, displays the fan speed.
813 \fB\*(T<\fBibm_temps\fR\*(T>\fR \*(T<\fBN\fR\*(T>
814 If running the IBM ACPI, displays the temperatures
815 from the IBM temperature sensors (N=0..7) Sensor 0 is
816 on the CPU, 3 is on the GPU.
819 \fB\*(T<\fBibm_volume\fR\*(T>\fR
820 If running the IBM ACPI, displays the "master" volume,
821 controlled by the volume keys (0-14).
824 \fB\*(T<\fBibm_brightness\fR\*(T>\fR
825 If running the IBM ACPI, displays the brigtness of the
829 \fB\*(T<\fBif_empty\fR\*(T>\fR \*(T<\fB(var)\fR\*(T>
830 if conky variable VAR is empty, display everything
831 between $if_empty and the matching $endif
834 \fB\*(T<\fBif_existing\fR\*(T>\fR \*(T<\fBfile (string)\fR\*(T>
835 if FILE exists, display everything between if_existing
836 and the matching $endif. The optional second paramater
837 checks for FILE containing the specified string and
838 prints everything between $if_existing and the matching
842 \fB\*(T<\fBif_gw\fR\*(T>\fR
843 if there is at least one default gateway, display
844 everything between $if_gw and the matching $endif
847 \fB\*(T<\fBif_match\fR\*(T>\fR \*(T<\fBexpression\fR\*(T>
848 Evaluates the given boolean expression, printing
849 everything between $if_match and the matching $endif
850 depending on whether the evaluation returns true or not.
851 Valid expressions consist of a left side, an operator
852 and a right side. Left and right sides are being parsed
853 for contained text objects before evaluation. Recognised
854 left and right side types are:
857 argument consists of only digits and a
861 argument consists of only digits.
864 argument is enclosed in quotation mark
865 or the checks for double and long failed
869 \&'>', '<', '>=', '<=', '==', '!='.
872 \fB\*(T<\fBif_running\fR\*(T>\fR \*(T<\fB(process)\fR\*(T>
873 if PROCESS is running, display everything $if_running
874 and the matching $endif
877 \fB\*(T<\fBif_mounted\fR\*(T>\fR \*(T<\fB(mountpoint)\fR\*(T>
878 if MOUNTPOINT is mounted, display everything between
879 $if_mounted and the matching $endif
882 \fB\*(T<\fBif_smapi_bat_installed\fR\*(T>\fR \*(T<\fB(INDEX)\fR\*(T>
883 when using smapi, if the battery with index INDEX is
884 installed, display everything between
885 $if_smapi_bat_installed and the matching $endif
888 \fB\*(T<\fBif_up\fR\*(T>\fR \*(T<\fB(interface)\fR\*(T>
889 if INTERFACE exists and is up, display everything between $if_up and the matching $endif
892 \fB\*(T<\fBimap_messages\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
893 Displays the number of messages in your global IMAP inbox by default. You can define individual IMAP inboxes seperately by passing arguments to this object. Arguments are: "host user pass [-i interval] [-p port] [-e command] [-r retries]". Default port is 143, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
896 \fB\*(T<\fBimap_unseen\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
897 Displays the number of unseen messages in your global IMAP inbox by default. You can define individual IMAP inboxes seperately by passing arguments to this object. Arguments are: "host user pass [-i interval] [-p port] [-e command] [-r retries]". Default port is 143, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
900 \fB\*(T<\fBioscheduler\fR\*(T>\fR \*(T<\fBdisk\fR\*(T>
901 Prints the current ioscheduler used for the given disk name (i.e. e.g. "hda" or "sdb")
904 \fB\*(T<\fBkernel\fR\*(T>\fR
908 \fB\*(T<\fBlaptop_mode\fR\*(T>\fR
909 The value of /proc/sys/vm/laptop_mode
912 \fB\*(T<\fBloadavg\fR\*(T>\fR
913 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
916 \fB\*(T<\fBloadgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
917 Load1 average graph, similar to xload, with optional colours in hex, minus the #. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
920 \fB\*(T<\fBlines\fR\*(T>\fR \*(T<\fBtextfile\fR\*(T>
921 Displays the number of lines in the given file
924 \fB\*(T<\fBmachine\fR\*(T>\fR
925 Machine, i686 for example
928 \fB\*(T<\fBmails\fR\*(T>\fR \*(T<\fB(mailbox)\fR\*(T> \*(T<\fB(interval)\fR\*(T>
929 Mail count in the specified mailbox or your mail spool if not.
930 Both mbox and maildir type mailboxes are supported. You can
931 use a program like fetchmail to get mails from some server
932 using your favourite protocol. See also new_mails.
935 \fB\*(T<\fBmboxscan\fR\*(T>\fR \*(T<\fB(\-n number of messages to print) (\-fw from width) (\-sw subject width) mbox\fR\*(T>
936 Print a summary of recent messages in an mbox format mailbox. mbox parameter is the filename of the mailbox (can be encapsulated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
939 \fB\*(T<\fBmem\fR\*(T>\fR
940 Amount of memory in use
943 \fB\*(T<\fBmembar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
944 Bar that shows amount of memory in use
947 \fB\*(T<\fBmemgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
948 Memory usage graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
951 \fB\*(T<\fBmemeasyfree\fR\*(T>\fR
952 Amount of free memory including the memory that is very easily freed (buffers/cache)
955 \fB\*(T<\fBmemfree\fR\*(T>\fR
956 Amount of free memory
959 \fB\*(T<\fBmemmax\fR\*(T>\fR
960 Total amount of memory
963 \fB\*(T<\fBmemperc\fR\*(T>\fR
964 Percentage of memory in use
967 \fB\*(T<\fBmixer\fR\*(T>\fR \*(T<\fB(device)\fR\*(T>
968 Prints the mixer value as reported by the OS. Default mixer is "vol", but you can specify one of the following optional arguments: "vol", "bass", "treble", "synth", "pcm", "speaker", "line", "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain", "line1", "line2", "line3", "dig1", "dig2", "dig3", "phin", "phout", "video", "radio", "monitor". Refer to the definition of SOUND_DEVICE_NAMES in <linux/soundcard.h> (on Linux), <soundcard.h> (on OpenBSD), or <sys/soundcard.h> to find the exact options available on your system.
971 \fB\*(T<\fBmixerbar\fR\*(T>\fR \*(T<\fB(device)\fR\*(T>
972 Displays mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
975 \fB\*(T<\fBmixerr\fR\*(T>\fR \*(T<\fB(device)\fR\*(T>
976 Prints the right channel mixer value as reported by the OS. See docs for $mixer for details on arguments.
979 \fB\*(T<\fBmixerrbar\fR\*(T>\fR \*(T<\fB(device)\fR\*(T>
980 Displays the right channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
983 \fB\*(T<\fBmixerl\fR\*(T>\fR \*(T<\fB(device)\fR\*(T>
984 Prints the left channel mixer value as reported by the OS. See docs for $mixer for details on arguments.
987 \fB\*(T<\fBmixerlbar\fR\*(T>\fR \*(T<\fB(device)\fR\*(T>
988 Displays the left channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
991 \fB\*(T<\fBmoc_state\fR\*(T>\fR
992 Current state of MOC; playing, stopped etc.
995 \fB\*(T<\fBmoc_file\fR\*(T>\fR
996 File name of the current MOC song
999 \fB\*(T<\fBmoc_title\fR\*(T>\fR
1000 Title of the current MOC song
1003 \fB\*(T<\fBmoc_artist\fR\*(T>\fR
1004 Artist of the current MOC song
1007 \fB\*(T<\fBmoc_song\fR\*(T>\fR
1008 The current song name being played in MOC.
1011 \fB\*(T<\fBmoc_album\fR\*(T>\fR
1012 Album of the current MOC song
1015 \fB\*(T<\fBmoc_totaltime\fR\*(T>\fR
1016 Total length of the current MOC song
1019 \fB\*(T<\fBmoc_timeleft\fR\*(T>\fR
1020 Time left in the current MOC song
1023 \fB\*(T<\fBmoc_curtime\fR\*(T>\fR
1024 Current time of the current MOC song
1027 \fB\*(T<\fBmoc_bitrate\fR\*(T>\fR
1028 Bitrate in the current MOC song
1031 \fB\*(T<\fBmoc_rate\fR\*(T>\fR
1032 Rate of the current MOC song
1035 \fB\*(T<\fBmonitor\fR\*(T>\fR
1036 Number of the monitor on which conky is running
1039 \fB\*(T<\fBmonitor_number\fR\*(T>\fR
1043 \fB\*(T<\fBmpd_artist\fR\*(T>\fR
1044 Artist in current MPD song must be enabled at compile
1047 \fB\*(T<\fBmpd_album\fR\*(T>\fR
1048 Album in current MPD song
1051 \fB\*(T<\fBmpd_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
1052 Bar of mpd's progress
1055 \fB\*(T<\fBmpd_bitrate\fR\*(T>\fR
1056 Bitrate of current song
1059 \fB\*(T<\fBmpd_status\fR\*(T>\fR
1060 Playing, stopped, et cetera.
1063 \fB\*(T<\fBmpd_title\fR\*(T>\fR \*(T<\fB(max length)\fR\*(T>
1064 Title of current MPD song
1067 \fB\*(T<\fBmpd_vol\fR\*(T>\fR
1071 \fB\*(T<\fBmpd_elapsed\fR\*(T>\fR
1075 \fB\*(T<\fBmpd_length\fR\*(T>\fR
1079 \fB\*(T<\fBmpd_percent\fR\*(T>\fR
1080 Percent of song's progress
1083 \fB\*(T<\fBmpd_random\fR\*(T>\fR
1084 Random status (On/Off)
1087 \fB\*(T<\fBmpd_repeat\fR\*(T>\fR
1088 Repeat status (On/Off)
1091 \fB\*(T<\fBmpd_track\fR\*(T>\fR
1092 Prints the MPD track field
1095 \fB\*(T<\fBmpd_name\fR\*(T>\fR
1096 Prints the MPD name field
1099 \fB\*(T<\fBmpd_file\fR\*(T>\fR
1100 Prints the file name of the current MPD song
1103 \fB\*(T<\fBmpd_smart\fR\*(T>\fR \*(T<\fB(max length)\fR\*(T>
1104 Prints the song name in either the form "artist - title" or file name, depending on whats available
1107 \fB\*(T<\fBif_mpd_playing\fR\*(T>\fR
1108 if mpd is playing or paused, display everything between $if_mpd_playing and the matching $endif
1111 \fB\*(T<\fBnameserver\fR\*(T>\fR \*(T<\fB(index)\fR\*(T>
1112 Print a nameserver from /etc/resolv.conf. Index starts at and defaults to 0.
1115 \fB\*(T<\fBnew_mails\fR\*(T>\fR \*(T<\fB(mailbox)\fR\*(T> \*(T<\fB(interval)\fR\*(T>
1116 Unread mail count in the specified mailbox or mail spool if
1117 not. Both mbox and maildir type mailboxes are supported.
1120 \fB\*(T<\fBnodename\fR\*(T>\fR
1124 \fB\*(T<\fBnvidia\fR\*(T>\fR \*(T<\fBthreshold\fR\*(T> \*(T<\fBtemp\fR\*(T> \*(T<\fBgpufreq\fR\*(T> \*(T<\fBmemfreq\fR\*(T> \*(T<\fBimagequality\fR\*(T>
1125 Nvidia graficcard support for the XNVCtrl library.
1126 Each option can be shortened to the least significant part.
1127 Temperatures are printed as float, all other values as integer.
1130 the thresholdtemperature at which the gpu slows down
1133 gives the gpu current temperature
1136 gives the current gpu frequency
1139 gives the current mem frequency
1142 which imagequality should be choosen by OpenGL applications
1145 \fB\*(T<\fBoutlinecolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T>
1146 Change outline color
1149 \fB\*(T<\fBpb_battery\fR\*(T>\fR \*(T<\fBitem\fR\*(T>
1150 If running on Apple powerbook/ibook, display
1151 information on battery status. The item parameter
1152 specifies, what information to display. Exactly one item
1153 must be specified. Valid items are:
1156 Display if battery is fully charged, charging,
1157 discharging or absent (running on AC)
1160 Display charge of battery in percent, if
1161 charging or discharging. Nothing will be
1162 displayed, if battery is fully charged
1166 Display the time remaining until the battery
1167 will be fully charged or discharged at current
1168 rate. Nothing is displayed, if battery is
1169 absent or if it's present but fully charged
1170 and not discharging.
1173 \fB\*(T<\fBplatform\fR\*(T>\fR \*(T<\fB(dev) type n\fR\*(T>
1174 Platform sensor from sysfs (Linux 2.6). Parameter dev may be omitted if you have only one platform device. Platform type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning temperature. Parameter n is number of the sensor. See /sys/bus/platform/devices/ on your local computer.
1177 \fB\*(T<\fBpop3_unseen\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
1178 Displays the number of unseen messages in your global POP3 inbox by default. You can define individual POP3 inboxes seperately by passing arguments to this object. Arguments are: "host user pass [-i interval] [-p port] [-e command] [-r retries]". Default port is 110, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1181 \fB\*(T<\fBpop3_used\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
1182 Displays the amount of space (in MiB, 2^20) used in your global POP3 inbox by default. You can define individual POP3 inboxes seperately by passing arguments to this object. Arguments are: "host user pass [-i interval] [-p port] [-e command] [-r retries]". Default port is 110, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1185 \fB\*(T<\fBpre_exec\fR\*(T>\fR \*(T<\fBshell command\fR\*(T>
1186 Executes a shell command one time before conky displays anything and puts output as text.
1189 \fB\*(T<\fBprocesses\fR\*(T>\fR
1190 Total processes (sleeping and running)
1193 \fB\*(T<\fBrunning_processes\fR\*(T>\fR
1194 Running processes (not sleeping), requires Linux 2.6
1197 \fB\*(T<\fBscroll\fR\*(T>\fR \*(T<\fBlength (step) text\fR\*(T>
1198 Scroll 'text' by 'step' characters showing 'length' number of characters at the same time. The text may also contain variables. 'step' is optional and defaults to 1 if not set. If a var creates output on multiple lines then the lines are placed behind each other separated with a '|'-sign. Do NOT use vars that change colors or otherwise affect the design inside a scrolling text. If you want spaces between the start and the end of 'text', place them at the end of 'text' not at the front ("foobar" and " foobar" can both generate "barfoo" but "foobar " will keep the spaces like this "bar foo").
1201 \fB\*(T<\fBshadecolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T>
1202 Change shading color
1205 \fB\*(T<\fBsmapi\fR\*(T>\fR \*(T<\fB(ARGS)\fR\*(T>
1206 when using smapi, display contents of the /sys/devices/platform/smapi directory. ARGS are either '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the corresponding files' content. This is a very raw method of accessing the smapi values. When available, better use one of the smapi_* variables instead.
1209 \fB\*(T<\fBsmapi_bat_bar\fR\*(T>\fR \*(T<\fB(INDEX),(height),(width)\fR\*(T>
1210 when using smapi, display the remaining capacity of the battery with index INDEX as a bar.
1213 \fB\*(T<\fBsmapi_bat_perc\fR\*(T>\fR \*(T<\fB(INDEX)\fR\*(T>
1214 when using smapi, display the remaining capacity in percent of the battery with index INDEX. This is a separate variable because it supports the 'use_spacer' configuration option.
1217 \fB\*(T<\fBsmapi_bat_power\fR\*(T>\fR \*(T<\fBINDEX\fR\*(T>
1218 when using smapi, display the current power of the battery with index INDEX in watt. This is a separate variable because the original read out value is being converted from mW. The sign of the output reflects charging (positive) or discharging (negative) state.
1221 \fB\*(T<\fBsmapi_bat_temp\fR\*(T>\fR \*(T<\fBINDEX\fR\*(T>
1222 when using smapi, display the current temperature of the battery with index INDEX in degree Celsius. This is a separate variable because the original read out value is being converted from milli degree Celsius.
1225 \fB\*(T<\fBstippled_hr\fR\*(T>\fR \*(T<\fB(space)\fR\*(T>
1226 Stippled (dashed) horizontal line
1229 \fB\*(T<\fBswapbar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
1230 Bar that shows amount of swap in use
1233 \fB\*(T<\fBswap\fR\*(T>\fR
1234 Amount of swap in use
1237 \fB\*(T<\fBswapmax\fR\*(T>\fR
1238 Total amount of swap
1241 \fB\*(T<\fBswapperc\fR\*(T>\fR
1242 Percentage of swap in use
1245 \fB\*(T<\fBsysname\fR\*(T>\fR
1246 System name, Linux for example
1249 \fB\*(T<\fBtcp_portmon\fR\*(T>\fR \*(T<\fBport_begin port_end item (index)\fR\*(T> \fI(ip4 only at present)\fR
1250 TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
1252 \fBcount\fR - total number of connections in the range
1254 \fBrip\fR - remote ip address
1256 \fBrhost\fR - remote host name
1258 \fBrport\fR - remote port number
1260 \fBrservice\fR - remote service name from /etc/services
1262 \fBlip\fR - local ip address
1264 \fBlhost\fR - local host name
1266 \fBlport\fR - local port number
1268 \fBlservice\fR - local service name from /etc/services
1270 The connection index provides you with access to each connection in the port monitor. The monitor will return information for index values from 0 to n-1 connections. Values higher than n-1 are simply ignored. For the "count" item, the connection index must be omitted. It is required for all other items.
1274 \fB${tcp_portmon 6881 6999 count}\fR -
1275 displays the number of connections in the bittorrent port range
1277 \fB${tcp_portmon 22 22 rip 0}\fR -
1278 displays the remote host ip of the first sshd connection
1280 \fB${tcp_portmon 22 22 rip 9}\fR -
1281 displays the remote host ip of the tenth sshd connection
1283 \fB${tcp_portmon 1 1024 rhost 0}\fR -
1284 displays the remote host name of the first connection on a privileged port
1286 \fB${tcp_portmon 1 1024 rport 4}\fR -
1287 displays the remote host port of the fifth connection on a privileged port
1289 \fB${tcp_portmon 1 65535 lservice 14}\fR -
1290 displays the local service name of the fifteenth connection in the range of all ports
1292 Note that port monitor variables which share the same port range actually refer to the same monitor, so many references to a single port range for different items and different indexes all use the same monitor internally. In other words, the program avoids creating redundant monitors.
1294 \fB\*(T<\fBtexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
1295 Runs a command at an interval inside a thread and displays the output. Same as $execi, except the command is run inside a thread. Use this if you have a slow script to keep Conky updating. You should make the interval slightly longer then the time it takes your script to execute. For example, if you have a script that take 5 seconds to execute, you should make the interval at least 6 seconds. See also $execi.
1298 \fB\*(T<\fBoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T>
1299 Move text over by N pixels. See also $voffset.
1302 \fB\*(T<\fBrss\fR\*(T>\fR \*(T<\fBurl delay_in_minutes action item_num\fR\*(T>
1303 Download and parse RSS feeds. Action may be one of the following: feed_title, item_title (with num par), item_desc (with num par) and item_titles.
1306 \fB\*(T<\fBtab\fR\*(T>\fR \*(T<\fB(width, (start))\fR\*(T>
1307 Puts a tab of the specified width, starting from column 'start'.
1310 \fB\*(T<\fBtail\fR\*(T>\fR \*(T<\fBlogfile lines (interval)\fR\*(T>
1311 Displays last N lines of supplied text text file. If interval is not supplied, Conky assumes 2x Conky's interval. Max of 30 lines can be displayed, or until the text buffer is filled.
1314 \fB\*(T<\fBtemplateN\fR\*(T>\fR \*(T<\fB(arg1)\fR\*(T> \*(T<\fB(arg2)\fR\*(T> \*(T<\fB(arg3 ...)\fR\*(T>
1315 Evaluate the content of the templateN configuration variable (where N is a value between 0 and 9, inclusively),
1316 applying substitutions as described in the documentation of the corresponding configuration variable.
1317 The number of arguments is optional, but must match the highest referred index in the template. You can use the
1318 same special sequences in each argument as the ones valid for a template definition, e.g. to allow an argument
1319 to contain a whitespace. Also simple nesting of templates is possible this way.
1321 Here are some examples of template definitions:
1325 template1 \e1: ${fs_used \e2} / ${fs_size \e2}
1329 The following list shows sample usage of the templates defined above,
1330 with the equivalent syntax when not using any template at all:
1336 same without template
1344 ${template0 node name}
1351 root: ${fs_free /} / ${fs_size /}
1355 \*(T<${template1 ${template2\e disk\e root} /}\*(T>
1359 \*(T<disk root: ${fs_free /} / ${fs_size /}\*(T>
1365 \fB\*(T<\fBtime\fR\*(T>\fR \*(T<\fB(format)\fR\*(T>
1366 Local time, see man strftime to get more information about format
1369 \fB\*(T<\fButime\fR\*(T>\fR \*(T<\fB(format)\fR\*(T>
1370 Display time in UTC (universal coordinate time).
1373 \fB\*(T<\fBtztime\fR\*(T>\fR \*(T<\fB(timezone) (format)\fR\*(T>
1374 Local time for specified timezone, see man strftime to get more information about format. The timezone argument is specified in similar fashion as TZ environment variable. For hints, look in /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
1377 \fB\*(T<\fBtotaldown\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
1378 Total download, overflows at 4 GB on Linux with 32-bit arch and there doesn't seem to be a way to know how many times it has already done that before conky has started.
1381 \fB\*(T<\fBtop\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T>
1382 This takes arguments in the form:top (name) (number) Basically, processes are ranked from highest to lowest in terms of cpu usage, which is what (num) represents. The types are: "name", "pid", "cpu", "mem", "mem_res", "mem_vsize", and "time". There can be a max of 10 processes listed.
1385 \fB\*(T<\fBtop_mem\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T>
1386 Same as top, except sorted by mem usage instead of cpu
1389 \fB\*(T<\fBtop_time\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T>
1390 Same as top, except sorted by total CPU time instead of current CPU usage
1393 \fB\*(T<\fBtotalup\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
1394 Total upload, this one too, may overflow
1397 \fB\*(T<\fBupdates\fR\*(T>\fR \*(T<\fBNumber of updates\fR\*(T>
1401 \fB\*(T<\fBupspeed\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
1405 \fB\*(T<\fBupspeedf\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
1406 Upload speed in KiB with one decimal
1409 \fB\*(T<\fBupspeedgraph\fR\*(T>\fR \*(T<\fB("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (net)\fR\*(T>
1410 Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
1413 \fB\*(T<\fBuptime\fR\*(T>\fR
1417 \fB\*(T<\fBuptime_short\fR\*(T>\fR
1418 Uptime in a shorter format
1421 \fB\*(T<\fBuser_number\fR\*(T>\fR
1422 Number of users logged in
1425 \fB\*(T<\fBuser_names\fR\*(T>\fR
1426 Lists the names of the users logged in
1429 \fB\*(T<\fBuser_terms\fR\*(T>\fR
1430 Lists the consoles in use
1433 \fB\*(T<\fBuser_times\fR\*(T>\fR
1434 Lists how long users have been logged in for
1437 \fB\*(T<\fBvoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T>
1438 Change vertical offset by N pixels. Negative values will cause text to overlap. See also $offset.
1441 \fB\*(T<\fBvoltage_mv\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
1442 Returns CPU #n's voltage in mV. CPUs are
1443 counted from 1. If omitted, the parameter
1447 \fB\*(T<\fBvoltage_v\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
1448 Returns CPU #n's voltage in V. CPUs are
1449 counted from 1. If omitted, the parameter
1453 \fB\*(T<\fBwireless_essid\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
1454 Wireless access point ESSID (Linux only)
1457 \fB\*(T<\fBwireless_mode\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
1458 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1461 \fB\*(T<\fBwireless_bitrate\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
1462 Wireless bitrate (ie 11 Mb/s) (Linux only)
1465 \fB\*(T<\fBwireless_ap\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
1466 Wireless access point MAC address (Linux only)
1469 \fB\*(T<\fBwireless_link_qual\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
1470 Wireless link quality (Linux only)
1473 \fB\*(T<\fBwireless_link_qual_max\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
1474 Wireless link quality maximum value (Linux only)
1477 \fB\*(T<\fBwireless_link_qual_perc\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
1478 Wireless link quality in percents (Linux only)
1481 \fB\*(T<\fBwireless_link_bar\fR\*(T>\fR \*(T<\fB(height), (width) net\fR\*(T>
1482 Wireless link quality bar (Linux only)
1485 \fB\*(T<\fBwords\fR\*(T>\fR \*(T<\fBtextfile\fR\*(T>
1486 Displays the number of words in the given file
1489 \fB\*(T<\fBxmms2_artist\fR\*(T>\fR
1490 Artist in current XMMS2 song
1493 \fB\*(T<\fBxmms2_album\fR\*(T>\fR
1494 Album in current XMMS2 song
1497 \fB\*(T<\fBxmms2_title\fR\*(T>\fR
1498 Title in current XMMS2 song
1501 \fB\*(T<\fBxmms2_genre\fR\*(T>\fR
1502 Genre in current XMMS2 song
1505 \fB\*(T<\fBxmms2_comment\fR\*(T>\fR
1506 Comment in current XMMS2 song
1509 \fB\*(T<\fBxmms2_decoder\fR\*(T>\fR
1513 \fB\*(T<\fBxmms2_transport\fR\*(T>\fR
1514 Transport plugin used
1517 \fB\*(T<\fBxmms2_url\fR\*(T>\fR
1518 Full path to current song
1521 \fB\*(T<\fBxmms2_tracknr\fR\*(T>\fR
1522 Track number in current XMMS2 song
1525 \fB\*(T<\fBxmms2_bitrate\fR\*(T>\fR
1526 Bitrate of current song
1529 \fB\*(T<\fBxmms2_id\fR\*(T>\fR
1530 XMMS2 id of current song
1533 \fB\*(T<\fBxmms2_duration\fR\*(T>\fR
1534 Duration of current song
1537 \fB\*(T<\fBxmms2_elapsed\fR\*(T>\fR
1541 \fB\*(T<\fBxmms2_size\fR\*(T>\fR
1542 Size of current song
1545 \fB\*(T<\fBxmms2_percent\fR\*(T>\fR
1546 Percent of song's progress
1549 \fB\*(T<\fBxmms2_status\fR\*(T>\fR
1550 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1553 \fB\*(T<\fBxmms2_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
1554 Bar of XMMS2's progress
1557 \fB\*(T<\fBxmms2_smart\fR\*(T>\fR
1558 Prints the song name in either the form "artist - title" or file name, depending on whats available
1561 \fB\*(T<\fBif_xmms2_connected\fR\*(T>\fR
1562 Display everything between $if_xmms2_connected and the matching $endif if xmms2 is running.
1565 \fB\*(T<\fBeve\fR\*(T>\fR \*(T<\fBapi_userid api_key character_id\fR\*(T>
1566 Fetches your currently training skill from the Eve Online API servers (http://www.eve-online.com/) and displays the skill along with the remaining training time.
1570 \*(T<conky \*(T>\*(T<\fB\-t '${time %D %H:%M}' \-o \-u 30\fR\*(T>
1571 Start Conky in its own window with date and clock as text and 30 sec update interval.
1573 \*(T<conky \*(T>\*(T<\fB\-a top_left \-x 5 \-y 500 \-d\fR\*(T>
1574 Start Conky to background at coordinates (5, 500).
1576 \*(T<\fI~/.conkyrc\fR\*(T> default configuration file
1578 Drawing to root or some other desktop window directly doesn't work with
1579 all window managers. Especially doesn't work well with Gnome and it has
1580 been reported that it doesn't work with KDE either. Nautilus can be
1581 disabled from drawing to desktop with program gconf-editor. Uncheck
1582 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky
1583 to set some specific window id. You might find xwininfo -tree useful to
1584 find the window to draw to. You can also use -o argument which makes
1585 Conky to create its own window. If you do try running Conky in its own
1586 window, be sure to read up on the own_window_type settings and experiment.
1588 \(lahttp://conky.sourceforge.net/\(ra
1590 \(lahttp://www.sourceforge.net/projects/conky\(ra
1592 #conky on irc.freenode.net
1594 Copyright (c) 2005-2008 Brenden Matthews, Philip Kovacs, et. al.
1595 Any original torsmo code is licensed under the BSD license (see LICENSE.BSD for a copy).
1596 All code written since the fork of torsmo is licensed under the GPL (see LICENSE.GPL for a copy), except where noted differently (such as in portmon code, timed thread code, and audacious code which are LGPL, and prss which is an MIT-style license).
1598 The Conky dev team (see AUTHORS for a full list of contributors).