1 .\" -*- coding: us-ascii -*-
3 .if \n(.g .ds T> \\F[\n[.fam]]
7 .if \n(.g .mso www.tmac
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 the torsmo code.
24 Since it's original conception, Conky has changed a fair bit from it's predecessor.
25 Conky can display just about anything, either on your root desktop or in it's own window.
26 Conky has many built-in objects, as well as the ability to execute programs and scripts,
27 then display the output from stdout.
29 We are always looking for help, and anyone interested in becoming a developer is welcome.
30 Please use the facilities at SourceForge to make bug reports, feature requests, and submit patches.
32 Thanks for your interest in Conky.
34 For users compiling from source, make sure you have the X development libraries installed.
35 This should be a package along the lines of "libx11-dev or xorg-x11-dev".
37 Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-admin/conky" for installation.
38 There is also usually an up-to-date ebuild within Conky's package or in Svn.
40 Debian,etc. users -- Conky will be in Debian's repositories soon (by mid-September, hopefully), and then
41 Ubuntu shortly thereafter. Until then, "dpkg -i" the .deb package to install.
43 Example to compile and run Conky with all optional components (note that some configure options may differ for your system):
45 \fB\*(T<\fBsh autogen.sh\fR\*(T>\fR \*(T<\fB# Only required if building from Svn\fR\*(T>
47 \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 \-\-enable\-xft \-\-enable\-own\-window \-\-enable\-proc\-uptime \-\-enable\-audacious \-\-enable\-bmpx \-\-enable\-hddtemp \-\-enable\-mpd \-\-enable\-xmms2 \-\-enable\-imlib2 \-\-enable\-portmon \-\-enable\-debug \-\-enable\-double\-buffer \-\-enable\-xdamage \-\-enable\-x11\fR\*(T>
49 \fB\*(T<\fBmake\fR\*(T>\fR
51 \fB\*(T<\fBmake install\fR\*(T>\fR \*(T<\fB# Optional\fR\*(T>
53 \fB\*(T<\fBsrc/conky\fR\*(T>\fR
55 Conky probably doesn't compile with compilers other than gcc and icc.
56 It doesn't compile with C89 compiler and not even with pure C99.
57 It uses a few things that might not exist: strdup(), strcasecmp(), strncasecmp(),
58 optarg variable with getopt() and long long (not in C89). Crashes in file system
59 statistics stuff when compiled with icc, I don't know exactly why.
61 You can disable 'drawing to own window' feature in case you don't need it by passing
62 --disable-own-window to configure -script.
65 Conky is generally very good on resources. However, certain objects in
66 Conky are harder on resources then others. In particular, the $tail,
67 $top, $font, and $graph objects are quite costly in comparison to the rest of Conky.
69 If you do use them, please do not complain about memory or CPU usage,
70 unless you think something's seriously wrong (mem leak, etc.).
72 An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1 conky".
73 Saves you the trouble of having to kill and then restart.
75 IMPORTANT: For previous Conky users, Conky 1.3 no longer supports the metar stuff.
76 mdsplib was causing way too many problems. Hopefully there'll be a better solution in Conky 2.x...
78 Command line options override configurations defined in configuration file.
80 \fB\*(T<\fB\-v | \-V\fR\*(T>\fR
81 Prints version and exits
84 \fB\*(T<\fB\-a \fR\*(T>\fR\*(T<\fBALIGNMENT\fR\*(T>
85 Text alignment on screen, {top,bottom}_{left,right} or none
88 \fB\*(T<\fB\-b\fR\*(T>\fR
89 Use double buffering (eliminates "flicker")
92 \fB\*(T<\fB\-c \fR\*(T>\fR\*(T<\fBFILE\fR\*(T>
93 Config file to load instead of $HOME/.conkyrc
96 \fB\*(T<\fB\-d\fR\*(T>\fR
97 Daemonize Conky, aka fork to background
100 \fB\*(T<\fB\-f \fR\*(T>\fR\*(T<\fBFONT\fR\*(T>
104 \fB\*(T<\fB\-h\fR\*(T>\fR
105 Prints command line help and exits
108 \fB\*(T<\fB\-o\fR\*(T>\fR
109 Create own window to draw
112 \fB\*(T<\fB\-t \fR\*(T>\fR\*(T<\fBTEXT\fR\*(T>
113 Text to render, remember single quotes, like -t ' $uptime '
116 \fB\*(T<\fB\-u \fR\*(T>\fR\*(T<\fBSECONDS\fR\*(T>
120 \fB\*(T<\fB\-w \fR\*(T>\fR\*(T<\fBWIN_ID\fR\*(T>
124 \fB\*(T<\fB\-x \fR\*(T>\fR\*(T<\fBX_COORDINATE\fR\*(T>
128 \fB\*(T<\fB\-y \fR\*(T>\fR\*(T<\fBY_COORDINATE\fR\*(T>
131 .SH "CONFIGURATION SETTINGS"
132 Default configuration file is $HOME/.conkyrc (can be changed from
133 conky.c among other things). See conkyrc.sample. If installing from Debian package,
134 this should be in /usr/share/doc/conky/examples ("gunzip conkyrc.sample.gz" to get conkyrc.sample).
136 You might want to copy it to $HOME/.conkyrc and then start modifying it.
137 Other configs can be found at http://conky.sf.net
139 \fB\*(T<\fBalignment\fR\*(T>\fR
140 Aligned position on screen, may be top_left, top_right, bottom_left, bottom_right, or none
143 \fB\*(T<\fBbackground\fR\*(T>\fR
144 Boolean value, if true, Conky will be forked to background when started
147 \fB\*(T<\fBborder_margin\fR\*(T>\fR
148 Border margin in pixels
151 \fB\*(T<\fBborder_width\fR\*(T>\fR
152 Border width in pixels
155 \fB\*(T<\fBcpu_avg_samples\fR\*(T>\fR
156 The number of samples to average for CPU monitoring
159 \fB\*(T<\fBdefault_color\fR\*(T>\fR
160 Default color and border color
163 \fB\*(T<\fBdefault_outline_color\fR\*(T>\fR
164 Default outline color
167 \fB\*(T<\fBdefault_shade_color\fR\*(T>\fR
168 Default shading color and border's shading color
171 \fB\*(T<\fBdouble_buffer\fR\*(T>\fR
172 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.
175 \fB\*(T<\fBdraw_borders\fR\*(T>\fR
176 Draw borders around text?
179 \fB\*(T<\fBdraw_graph_borders\fR\*(T>\fR
180 Draw borders around graphs?
183 \fB\*(T<\fBdraw_outline\fR\*(T>\fR
187 \fB\*(T<\fBdraw_shades\fR\*(T>\fR
191 \fB\*(T<\fBfont\fR\*(T>\fR
192 Font name in X, xfontsel can be used to get a nice font
195 \fB\*(T<\fBgap_x\fR\*(T>\fR
196 Gap, in pixels, between right or left border of screen, same as passing -x at command line,
200 \fB\*(T<\fBgap_y\fR\*(T>\fR
201 Gap, in pixels, between top or bottom border of screen, same as passing -y at command line,
205 \fB\*(T<\fBimap\fR\*(T>\fR
206 Default global IMAP server. Arguments are: "host user pass [-i interval] [-f folder] [-p port] [-e command]". Default port is 143, default folder is 'INBOX', default interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
209 \fB\*(T<\fBmail_spool\fR\*(T>\fR
210 Mail spool for mail checking
213 \fB\*(T<\fBmax_port_monitor_connections\fR\*(T>\fR
214 Allow each port monitor to track at most this many connections (if 0 or not set, default is 256)
217 \fB\*(T<\fBmax_specials\fR\*(T>\fR
218 Maximum number of special things, e.g. fonts, offsets, aligns, etc. (default is 512)
221 \fB\*(T<\fBmax_user_text\fR\*(T>\fR \*(T<\fBbytes\fR\*(T>
222 Maximum size of user text buffer, i.e. layout below TEXT line in config file
223 (default is 16384 bytes)
226 \fB\*(T<\fBmaximum_width\fR\*(T>\fR \*(T<\fBpixels\fR\*(T>
227 Maximum width of window
230 \fB\*(T<\fBminimum_size\fR\*(T>\fR \*(T<\fBwidth (height)\fR\*(T>
231 Minimum size of window
234 \fB\*(T<\fBmpd_host\fR\*(T>\fR
238 \fB\*(T<\fBmpd_port\fR\*(T>\fR
242 \fB\*(T<\fBmpd_password\fR\*(T>\fR
246 \fB\*(T<\fBnet_avg_samples\fR\*(T>\fR
247 The number of samples to average for net data
250 \fB\*(T<\fBno_buffers\fR\*(T>\fR
251 Substract (file system) buffers from used memory?
254 \fB\*(T<\fBoverride_utf8_locale\fR\*(T>\fR
255 Force UTF8? requires XFT
258 \fB\*(T<\fBown_window\fR\*(T>\fR
259 Boolean, create own window to draw?
262 \fB\*(T<\fBown_window_transparent\fR\*(T>\fR
263 Boolean, set pseudo-transparency?
266 \fB\*(T<\fBown_window_type\fR\*(T>\fR
267 if own_window is yes, you may specify type normal, desktop or override (default: normal).
268 Desktop windows are special windows that have no window decorations; are always visible
269 on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
270 Override windows are not under the control of the window manager. Hints are ignored. This type
271 of window can be useful for certain situations.
274 \fB\*(T<\fBown_window_colour\fR\*(T>\fR \*(T<\fBcolour\fR\*(T>
275 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)
278 \fB\*(T<\fBown_window_hints\fR\*(T>\fR \*(T<\fBundecorated,below,above,sticky,skip_taskbar,skip_pager\fR\*(T>
279 If own_window is yes, you may use these window manager hints to affect the way Conky displays.
280 Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
281 If you use own_window_type override, window manager hints have no meaning and are ignored.
284 \fB\*(T<\fBout_to_console\fR\*(T>\fR
285 Print text to stdout.
288 \fB\*(T<\fBpad_percents\fR\*(T>\fR
289 Pad percentages to this many decimals (0 = no padding)
292 \fB\*(T<\fBpop3\fR\*(T>\fR
293 Default global POP3 server. Arguments are: "host user pass [-i interval] [-p port] [-e command]". Default port is 110, default interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
296 \fB\*(T<\fBstippled_borders\fR\*(T>\fR
297 Border stippling (dashing) in pixels
300 \fB\*(T<\fBtotal_run_times\fR\*(T>\fR
301 Total number of times for Conky to update before quitting. Zero makes Conky run forever
304 \fB\*(T<\fBupdate_interval\fR\*(T>\fR
305 Update interval in seconds
308 \fB\*(T<\fBuppercase\fR\*(T>\fR
309 Boolean value, if true, text is rendered in upper case
312 \fB\*(T<\fBuse_spacer\fR\*(T>\fR
313 Adds spaces after certain objects to stop them from moving other things around. Note that this only helps if you are using a mono font, such as Bitstream Vera Sans Mono.
316 \fB\*(T<\fBuse_xft\fR\*(T>\fR
317 Use Xft (anti-aliased font and stuff)
320 \fB\*(T<\fBwm_class_name\fR\*(T>\fR
321 Manually set the WM_CLASS name. Defaults to "conky".
324 \fB\*(T<\fBxftalpha\fR\*(T>\fR
325 Alpha of Xft font. Must be a value at or between 1 and 0.
328 \fB\*(T<\fBxftfont\fR\*(T>\fR
332 \fB\*(T<\fBTEXT\fR\*(T>\fR
333 After this begins text to be formatted on screen
336 Colors are parsed using XParsecolor(), there might be a list of them:
337 /usr/X11R6/lib/X11/rgb.txt. Also, \(lahttp://sedition.com/perl/rgb.html\(ra.
338 Color can be also in #rrggbb format (hex).
339 Note that when displaying bytes, power is 1024 and not 1000 so 1M really
340 means 1024*1024 bytes and not 1000*1000.
342 \fB\*(T<\fBaddr\fR\*(T>\fR \*(T<\fBinterface\fR\*(T>
343 IP address for an interface
346 \fB\*(T<\fBacpiacadapter\fR\*(T>\fR
347 ACPI ac adapter state.
350 \fB\*(T<\fBacpifan\fR\*(T>\fR
354 \fB\*(T<\fBacpitemp\fR\*(T>\fR
355 ACPI temperature in C.
358 \fB\*(T<\fBacpitempf\fR\*(T>\fR
359 ACPI temperature in F.
362 \fB\*(T<\fBadt746xcpu\fR\*(T>\fR
363 CPU temperature from therm_adt746x
366 \fB\*(T<\fBadt746xfan\fR\*(T>\fR
367 Fan speed from therm_adt746x
370 \fB\*(T<\fBalignr\fR\*(T>\fR \*(T<\fB(num)\fR\*(T>
371 Right-justify text, with space of N
374 \fB\*(T<\fBalignc\fR\*(T>\fR \*(T<\fB(num)\fR\*(T>
378 \fB\*(T<\fBapm_adapter\fR\*(T>\fR
379 Display APM AC adapter status (FreeBSD only)
382 \fB\*(T<\fBapm_battery_life\fR\*(T>\fR
383 Display APM battery life in percent (FreeBSD only)
386 \fB\*(T<\fBapm_battery_time\fR\*(T>\fR
387 Display remaining APM battery life in hh:mm:ss or "unknown" if
388 AC adapterstatus is on-line or charging (FreeBSD only)
391 \fB\*(T<\fBaudacious_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
395 \fB\*(T<\fBaudacious_bitrate\fR\*(T>\fR
396 Bitrate of current tune
399 \fB\*(T<\fBaudacious_channels\fR\*(T>\fR
400 Number of audio channels of current tune
403 \fB\*(T<\fBaudacious_filename\fR\*(T>\fR
404 Full path and filename of current tune
407 \fB\*(T<\fBaudacious_frequency\fR\*(T>\fR
408 Sampling frequency of current tune
411 \fB\*(T<\fBaudacious_length\fR\*(T>\fR
412 Total length of current tune as MM:SS
415 \fB\*(T<\fBaudacious_length_seconds\fR\*(T>\fR
416 Total length of current tune in seconds
419 \fB\*(T<\fBaudacious_playlist_position\fR\*(T>\fR
420 Playlist position of current tune
423 \fB\*(T<\fBaudacious_playlist_length\fR\*(T>\fR
424 Number of tunes in playlist
427 \fB\*(T<\fBaudacious_position\fR\*(T>\fR
428 Position of current tune (MM:SS)
431 \fB\*(T<\fBaudacious_position_seconds\fR\*(T>\fR
432 Position of current tune in seconds
435 \fB\*(T<\fBaudacious_status\fR\*(T>\fR
436 Player status (Playing/Paused/Stopped/Not running)
439 \fB\*(T<\fBaudacious_title\fR\*(T>\fR \*(T<\fB(max length)\fR\*(T>
440 Title of current tune with optional maximum length specifier
443 \fB\*(T<\fBbattery\fR\*(T>\fR \*(T<\fB(num)\fR\*(T>
444 Remaining capacity in ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
447 \fB\*(T<\fBbmpx_artist\fR\*(T>\fR
448 Artist in current BMPx track
451 \fB\*(T<\fBbmpx_album\fR\*(T>\fR
452 Album in current BMPx track
455 \fB\*(T<\fBbmpx_title\fR\*(T>\fR
456 Title of the current BMPx track
459 \fB\*(T<\fBbmpx_track\fR\*(T>\fR
460 Track number of the current BMPx track
463 \fB\*(T<\fBbmpx_bitrate\fR\*(T>\fR
464 Bitrate of the current BMPx track
467 \fB\*(T<\fBbmpx_uri\fR\*(T>\fR
468 URI of the current BMPx track
471 \fB\*(T<\fBbuffers\fR\*(T>\fR
472 Amount of memory buffered
475 \fB\*(T<\fBcached\fR\*(T>\fR
476 Amount of memory cached
479 \fB\*(T<\fBcolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T>
480 Change drawing color to color
483 \fB\*(T<\fBcpu\fR\*(T>\fR \*(T<\fB(cpuN)\fR\*(T>
484 CPU usage in percents. For SMP machines, the CPU number can be provided as an argument. ${cpu 0} is the total usage, and ${cpu X} (X >= 1) are individual CPUs.
487 \fB\*(T<\fBcpubar\fR\*(T>\fR \*(T<\fB(cpu number) (height),(width)\fR\*(T>
488 Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
491 \fB\*(T<\fBcpugraph\fR\*(T>\fR \*(T<\fB(cpu number) (height),(width) (gradient colour 1) (gradient colour 2)\fR\*(T>
492 CPU usage graph, with optional colours in hex, minus the #. See $cpu for more info on SMP.
495 \fB\*(T<\fBdiskio\fR\*(T>\fR
496 Displays current disk IO.
499 \fB\*(T<\fBdiskiograph\fR\*(T>\fR \*(T<\fB(height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
500 Disk IO graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
503 \fB\*(T<\fBdownspeed\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
504 Download speed in kilobytes
507 \fB\*(T<\fBdownspeedf\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
508 Download speed in kilobytes with one decimal
511 \fB\*(T<\fBdownspeedgraph\fR\*(T>\fR \*(T<\fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
512 Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
515 \fB\*(T<\fBelse\fR\*(T>\fR
516 Text to show if any of the above are not true
519 \fB\*(T<\fBentropy_avail\fR\*(T>\fR
520 Current entropy available for crypto freaks
523 \fB\*(T<\fBentropy_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
524 Normalized bar of available entropy for crypto freaks
527 \fB\*(T<\fBentropy_poolsize\fR\*(T>\fR
528 Total size of system entropy pool for crypto freaks
531 \fB\*(T<\fBexec\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>
532 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.
535 \fB\*(T<\fBexecbar\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>
536 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.
539 \fB\*(T<\fBexecgraph\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>
540 Same as execbar, but graphs values.
543 \fB\*(T<\fBexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
544 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
547 \fB\*(T<\fBexecibar\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
548 Same as execbar, except with an interval
551 \fB\*(T<\fBexecigraph\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
552 Same as execigraph, but takes an interval arg graphs values
555 \fB\*(T<\fBfont\fR\*(T>\fR \*(T<\fB(font)\fR\*(T>
556 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)
559 \fB\*(T<\fBfreq\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
560 Returns CPU #n's frequency in MHz. CPUs are
561 counted from 1. If omitted, the parameter
565 \fB\*(T<\fBfreq_g\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
566 Returns CPU #n's frequency in GHz. CPUs are
567 counted from 1. If omitted, the parameter
571 \fB\*(T<\fBfreq_dyn\fR\*(T>\fR
572 Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
575 \fB\*(T<\fBfreq_dyn_g\fR\*(T>\fR
576 Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
579 \fB\*(T<\fBfs_bar\fR\*(T>\fR \*(T<\fB(height),(width) fs\fR\*(T>
580 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.
583 \fB\*(T<\fBfs_free\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
584 Free space on a file system available for users.
587 \fB\*(T<\fBfs_free_perc\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
588 Free percentage of space on a file system available for users.
591 \fB\*(T<\fBfs_size\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
595 \fB\*(T<\fBfs_used\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
596 File system used space
599 \fB\*(T<\fBgoto\fR\*(T>\fR \*(T<\fBx\fR\*(T>
600 The next element will be printed at position 'x'.
603 \fB\*(T<\fBhddtemp\fR\*(T>\fR \*(T<\fBdev, (host,(port))\fR\*(T>
604 Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
605 Default host is 127.0.0.1, default port is 7634.
608 \fB\*(T<\fBhead\fR\*(T>\fR \*(T<\fBlogfile lines (interval)\fR\*(T>
609 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.
612 \fB\*(T<\fBhr\fR\*(T>\fR \*(T<\fB(height)\fR\*(T>
613 Horizontal line, height is the height in pixels
616 \fB\*(T<\fBiconv_start\fR\*(T>\fR \*(T<\fBcodeset_from codeset_to\fR\*(T>
617 Convert text from one codeset to another using GNU iconv. Needs to be stopped with iconv_stop.
620 \fB\*(T<\fBiconv_stop\fR\*(T>\fR
621 Stop iconv codeset conversion.
624 \fB\*(T<\fBi2c\fR\*(T>\fR \*(T<\fB(dev) type n\fR\*(T>
625 I2C sensor from sysfs (Linux 2.6). dev may be omitted if you have only one I2C device. type is either in (or vol) meaning voltage, fan meaning fan or temp/tempf (first in C, second in F) meaning temperature. n is number of the sensor. See /sys/bus/i2c/devices/ on your local computer.
628 \fB\*(T<\fBi8k_ac_status\fR\*(T>\fR
629 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.
632 \fB\*(T<\fBi8k_bios\fR\*(T>\fR
633 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
636 \fB\*(T<\fBi8k_buttons_status\fR\*(T>\fR
637 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
640 \fB\*(T<\fBi8k_cpu_temp\fR\*(T>\fR
641 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
644 \fB\*(T<\fBi8k_cpu_tempf\fR\*(T>\fR
645 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Fahrenheit, as reported by /proc/i8k.
648 \fB\*(T<\fBi8k_left_fan_rpm\fR\*(T>\fR
649 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.
652 \fB\*(T<\fBi8k_left_fan_status\fR\*(T>\fR
653 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.
656 \fB\*(T<\fBi8k_right_fan_rpm\fR\*(T>\fR
657 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.
660 \fB\*(T<\fBi8k_right_fan_status\fR\*(T>\fR
661 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.
664 \fB\*(T<\fBi8k_serial\fR\*(T>\fR
665 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
668 \fB\*(T<\fBi8k_version\fR\*(T>\fR
669 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
672 \fB\*(T<\fBibm_fan\fR\*(T>\fR
673 If running the IBM ACPI, displays the fan speed.
676 \fB\*(T<\fBibm_temps\fR\*(T>\fR \*(T<\fBN\fR\*(T>
677 If running the IBM ACPI, displays the temperatures
678 from the IBM temperature sensors (N=0..7) Sensor 0 is
679 on the CPU, 3 is on the GPU.
682 \fB\*(T<\fBibm_volume\fR\*(T>\fR
683 If running the IBM ACPI, displays the "master" volume,
684 controlled by the volume keys (0-14).
687 \fB\*(T<\fBibm_brightness\fR\*(T>\fR
688 If running the IBM ACPI, displays the brigtness of the
692 \fB\*(T<\fBif_running\fR\*(T>\fR \*(T<\fB(process)\fR\*(T>
693 if PROCESS is running, display everything if_running and the matching $endif
696 \fB\*(T<\fBif_existing\fR\*(T>\fR \*(T<\fB(file)\fR\*(T>
697 if FILE exists, display everything between if_existing and the matching $endif
700 \fB\*(T<\fBif_mounted\fR\*(T>\fR \*(T<\fB(mountpoint)\fR\*(T>
701 if MOUNTPOINT is mounted, display everything between if_mounted and the matching $endif
704 \fB\*(T<\fBimap_messages\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
705 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]". Default port is 143, default interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
708 \fB\*(T<\fBimap_unseen\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
709 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]". Default port is 143, default interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
712 \fB\*(T<\fBkernel\fR\*(T>\fR
716 \fB\*(T<\fBlinkstatus\fR\*(T>\fR \*(T<\fBinterface\fR\*(T>
717 Get the link status for wireless connections
720 \fB\*(T<\fBloadavg\fR\*(T>\fR
721 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
724 \fB\*(T<\fBmachine\fR\*(T>\fR
725 Machine, i686 for example
728 \fB\*(T<\fBmails\fR\*(T>\fR
729 Mail count in mail spool. You can use program like fetchmail to get mails from some server using your favourite protocol. See also new_mails.
732 \fB\*(T<\fBmem\fR\*(T>\fR
733 Amount of memory in use
736 \fB\*(T<\fBmembar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
737 Bar that shows amount of memory in use
740 \fB\*(T<\fBmemmax\fR\*(T>\fR
741 Total amount of memory
744 \fB\*(T<\fBmemperc\fR\*(T>\fR
745 Percentage of memory in use
748 \fB\*(T<\fBmpd_artist\fR\*(T>\fR
749 Artist in current MPD song must be enabled at compile
752 \fB\*(T<\fBmpd_album\fR\*(T>\fR
753 Album in current MPD song
756 \fB\*(T<\fBmpd_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
757 Bar of mpd's progress
760 \fB\*(T<\fBmpd_bitrate\fR\*(T>\fR
761 Bitrate of current song
764 \fB\*(T<\fBmpd_status\fR\*(T>\fR
765 Playing, stopped, et cetera.
768 \fB\*(T<\fBmpd_title\fR\*(T>\fR
769 Title of current MPD song
772 \fB\*(T<\fBmpd_vol\fR\*(T>\fR
776 \fB\*(T<\fBmpd_elapsed\fR\*(T>\fR
780 \fB\*(T<\fBmpd_length\fR\*(T>\fR
784 \fB\*(T<\fBmpd_percent\fR\*(T>\fR
785 Percent of song's progress
788 \fB\*(T<\fBmpd_random\fR\*(T>\fR
789 Random status (On/Off)
792 \fB\*(T<\fBmpd_repeat\fR\*(T>\fR
793 Repeat status (On/Off)
796 \fB\*(T<\fBmpd_track\fR\*(T>\fR
797 Prints the MPD track field
800 \fB\*(T<\fBmpd_name\fR\*(T>\fR
801 Prints the MPD name field
804 \fB\*(T<\fBmpd_file\fR\*(T>\fR
805 Prints the file name of the current MPD song
808 \fB\*(T<\fBmpd_smart\fR\*(T>\fR
809 Prints the song name in either the form "artist - title" or file name, depending on whats available
812 \fB\*(T<\fBnew_mails\fR\*(T>\fR
813 Unread mail count in mail spool.
816 \fB\*(T<\fBnodename\fR\*(T>\fR
820 \fB\*(T<\fBoutlinecolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T>
824 \fB\*(T<\fBpb_battery\fR\*(T>\fR \*(T<\fBitem\fR\*(T>
825 If running on Apple powerbook/ibook, display
826 information on battery status. The item parameter
827 specifies, what information to display. Exactly one item
828 must be specified. Valid items are:
831 Display if battery is fully charged, charging,
832 discharging or absent (running on AC)
835 Display charge of battery in percent, if
836 charging or discharging. Nothing will be
837 displayed, if battery is fully charged
841 Display the time remaining until the battery
842 will be fully charged or discharged at current
843 rate. Nothing is displayed, if battery is
844 absent or if it's present but fully charged
848 \fB\*(T<\fBpop3_unseen\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
849 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]". Default port is 110, default interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
852 \fB\*(T<\fBpop3_used\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
853 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]". Default port is 110, default interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
856 \fB\*(T<\fBpre_exec\fR\*(T>\fR \*(T<\fBshell command\fR\*(T>
857 Executes a shell command one time before conky displays anything and puts output as text.
860 \fB\*(T<\fBprocesses\fR\*(T>\fR
861 Total processes (sleeping and running)
864 \fB\*(T<\fBrunning_processes\fR\*(T>\fR
865 Running processes (not sleeping), requires Linux 2.6
868 \fB\*(T<\fBshadecolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T>
872 \fB\*(T<\fBstippled_hr\fR\*(T>\fR \*(T<\fB(space)\fR\*(T>
873 Stippled (dashed) horizontal line
876 \fB\*(T<\fBswapbar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
877 Bar that shows amount of swap in use
880 \fB\*(T<\fBswap\fR\*(T>\fR
881 Amount of swap in use
884 \fB\*(T<\fBswapmax\fR\*(T>\fR
888 \fB\*(T<\fBswapperc\fR\*(T>\fR
889 Percentage of swap in use
892 \fB\*(T<\fBsysname\fR\*(T>\fR
893 System name, Linux for example
896 \fB\*(T<\fBtcp_portmon\fR\*(T>\fR \*(T<\fBport_begin port_end item (index)\fR\*(T> \fI(ip4 only at present)\fR
897 TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
899 \fBcount\fR - total number of connections in the range
901 \fBrip\fR - remote ip address
903 \fBrhost\fR - remote host name
905 \fBrport\fR - remote port number
907 \fBrservice\fR - remote service name from /etc/services
909 \fBlip\fR - local ip address
911 \fBlhost\fR - local host name
913 \fBlport\fR - local port number
915 \fBlservice\fR - local service name from /etc/services
917 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.
921 \fB${tcp_portmon 6881 6999 count}\fR -
922 displays the number of connections in the bittorrent port range
924 \fB${tcp_portmon 22 22 rip 0}\fR -
925 displays the remote host ip of the first sshd connection
927 \fB${tcp_portmon 22 22 rip 9}\fR -
928 displays the remote host ip of the tenth sshd connection
930 \fB${tcp_portmon 1 1024 rhost 0}\fR -
931 displays the remote host name of the first connection on a privileged port
933 \fB${tcp_portmon 1 1024 rport 4}\fR -
934 displays the remote host port of the fifth connection on a privileged port
936 \fB${tcp_portmon 1 65535 lservice 14}\fR -
937 displays the local service name of the fifteenth connection in the range of all ports
939 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.
941 \fB\*(T<\fBtexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
942 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.
945 \fB\*(T<\fBoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T>
946 Move text over by N pixels. See also $voffset.
949 \fB\*(T<\fBtab\fR\*(T>\fR \*(T<\fB(width, (start))\fR\*(T>
950 Puts a tab of the specified width, starting from column 'start'.
953 \fB\*(T<\fBtail\fR\*(T>\fR \*(T<\fBlogfile lines (interval)\fR\*(T>
954 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.
957 \fB\*(T<\fBtime\fR\*(T>\fR \*(T<\fB(format)\fR\*(T>
958 Local time, see man strftime to get more information about format
961 \fB\*(T<\fButime\fR\*(T>\fR \*(T<\fB(format)\fR\*(T>
962 Display time in UTC (universal coordinate time).
965 \fB\*(T<\fBtztime\fR\*(T>\fR \*(T<\fB(timezone) (format)\fR\*(T>
966 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.
969 \fB\*(T<\fBtotaldown\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
970 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.
973 \fB\*(T<\fBtop\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T>
974 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", and "mem". There can be a max of 10 processes listed.
977 \fB\*(T<\fBtop_mem\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T>
978 Same as top, except sorted by mem usage instead of cpu
981 \fB\*(T<\fBtotalup\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
982 Total upload, this one too, may overflow
985 \fB\*(T<\fBupdates\fR\*(T>\fR \*(T<\fBNumber of updates\fR\*(T>
989 \fB\*(T<\fBupspeed\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
990 Upload speed in kilobytes
993 \fB\*(T<\fBupspeedf\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
994 Upload speed in kilobytes with one decimal
997 \fB\*(T<\fBupspeedgraph\fR\*(T>\fR \*(T<\fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
998 Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
1001 \fB\*(T<\fBuptime\fR\*(T>\fR
1005 \fB\*(T<\fBuptime_short\fR\*(T>\fR
1006 Uptime in a shorter format
1009 \fB\*(T<\fBvoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T>
1010 Change vertical offset by N pixels. Negative values will cause text to overlap. See also $offset.
1013 \fB\*(T<\fBvoltage_mv\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
1014 Returns CPU #n's voltage in mV. CPUs are
1015 counted from 1. If omitted, the parameter
1019 \fB\*(T<\fBvoltage_v\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
1020 Returns CPU #n's voltage in V. CPUs are
1021 counted from 1. If omitted, the parameter
1026 \*(T<conky \*(T>\*(T<\fB\-t '${time %D %H:%m}' \-o \-u 30\fR\*(T>
1027 Start Conky in its own window with date and clock as text and 30 sec update interval.
1029 \*(T<conky \*(T>\*(T<\fB\-a top_left \-x 5 \-y 500 \-d\fR\*(T>
1030 Start Conky to background at coordinates (5, 500).
1032 \*(T<\fI~/.conkyrc\fR\*(T> default configuration file
1034 Drawing to root or some other desktop window directly doesn't work with
1035 all window managers. Especially doesn't work well with Gnome and it has
1036 been reported that it doesn't work with KDE either. Nautilus can be
1037 disabled from drawing to desktop with program gconf-editor. Uncheck
1038 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky
1039 to set some specific window id. You might find xwininfo -tree useful to
1040 find the window to draw to. You can also use -o argument which makes
1041 Conky to create its own window.
1043 \(lahttp://conky.sourceforge.net\(ra
1045 \(lahttp://www.sourceforge.net/projects/conky\(ra
1047 #conky on irc.freenode.net
1049 The Conky dev team. What's up now!