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\-seti \-\-enable\-double\-buffer \-\-enable\-own\-window \-\-enable\-proc\-uptime \-\-enable\-mpd \-\-enable\-mldonkey \-\-enable\-x11 \-\-enable\-portmon \-\-enable\-xmms \-\-enable\-bmp \-\-enable\-audacious \-\-enable\-infopipe \-\-enable\-bmpx \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<\fBon_bottom\fR\*(T>\fR
148 Set Conky on the bottom of all other applications
151 \fB\*(T<\fBborder_margin\fR\*(T>\fR
152 Border margin in pixels
155 \fB\*(T<\fBborder_width\fR\*(T>\fR
156 Border width in pixels
159 \fB\*(T<\fBcpu_avg_samples\fR\*(T>\fR
160 The number of samples to average for CPU monitoring
163 \fB\*(T<\fBdefault_color\fR\*(T>\fR
164 Default color and border color
167 \fB\*(T<\fBdefault_shade_color\fR\*(T>\fR
168 Default shading color and border's shading color
171 \fB\*(T<\fBdefault_outline_color\fR\*(T>\fR
172 Default outline color
175 \fB\*(T<\fBdouble_buffer\fR\*(T>\fR
176 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.
179 \fB\*(T<\fBdraw_borders\fR\*(T>\fR
180 Draw borders around text?
183 \fB\*(T<\fBdraw_graph_borders\fR\*(T>\fR
184 Draw borders around graphs?
187 \fB\*(T<\fBdraw_shades\fR\*(T>\fR
191 \fB\*(T<\fBdraw_outline\fR\*(T>\fR
195 \fB\*(T<\fBfont\fR\*(T>\fR
196 Font name in X, xfontsel can be used to get a nice font
199 \fB\*(T<\fBgap_x\fR\*(T>\fR
200 Gap between right or left border of screen, same as passing -x at command line
203 \fB\*(T<\fBgap_y\fR\*(T>\fR
204 Gap between top or bottom border of screen, same as passing -y at command line
207 \fB\*(T<\fBimap\fR\*(T>\fR
208 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.
211 \fB\*(T<\fBno_buffers\fR\*(T>\fR
212 Substract (file system) buffers from used memory?
215 \fB\*(T<\fBmail_spool\fR\*(T>\fR
216 Mail spool for mail checking
219 \fB\*(T<\fBmaximum_width\fR\*(T>\fR \*(T<\fBpixels\fR\*(T>
220 Maximum width of window
223 \fB\*(T<\fBminimum_size\fR\*(T>\fR \*(T<\fBwidth (height)\fR\*(T>
224 Minimum size of window
227 \fB\*(T<\fBmin_port_monitors\fR\*(T>\fR
228 Allow for the creation of at least this number of port monitors (if 0 or not set, default is 16)
231 \fB\*(T<\fBmin_port_monitor_connections\fR\*(T>\fR
232 Allow each port monitor to track at least this many connections (if 0 or not set, default is 256)
235 \fB\*(T<\fBmldonkey_hostname\fR\*(T>\fR
236 Hostname for mldonkey stuff, defaults to localhost
239 \fB\*(T<\fBmldonkey_port\fR\*(T>\fR
240 Mldonkey port, 4001 default
243 \fB\*(T<\fBmldonkey_login\fR\*(T>\fR
244 Mldonkey login, default none
247 \fB\*(T<\fBmldonkey_password\fR\*(T>\fR
248 Mldonkey password, default none
251 \fB\*(T<\fBmpd_host\fR\*(T>\fR
255 \fB\*(T<\fBmpd_port\fR\*(T>\fR
259 \fB\*(T<\fBmpd_password\fR\*(T>\fR
263 \fB\*(T<\fBnet_avg_samples\fR\*(T>\fR
264 The number of samples to average for net data
267 \fB\*(T<\fBoverride_utf8_locale\fR\*(T>\fR
268 Force UTF8? requires XFT
271 \fB\*(T<\fBown_window\fR\*(T>\fR
272 Boolean, create own window to draw?
275 \fB\*(T<\fBown_window_transparent\fR\*(T>\fR
276 Boolean, set pseudo-transparency?
279 \fB\*(T<\fBown_window_type\fR\*(T>\fR
280 if own_window is yes, you may specify type normal, desktop or override (default: normal).
281 Desktop windows are special windows that have no window decorations; are always visible
282 on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
283 Override windows are not under the control of the window manager. Hints are ignored. This type
284 of window can be useful for certain situations.
287 \fB\*(T<\fBown_window_colour\fR\*(T>\fR \*(T<\fBcolour\fR\*(T>
288 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)
291 \fB\*(T<\fBown_window_hints\fR\*(T>\fR \*(T<\fBundecorated,below,above,sticky,skip_taskbar,skip_pager\fR\*(T>
292 If own_window is yes, you may use these window manager hints to affect the way Conky displays.
293 Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
294 If you use own_window_type override, window manager hints have no meaning and are ignored.
297 \fB\*(T<\fBout_to_console\fR\*(T>\fR
298 Print text to stdout.
301 \fB\*(T<\fBpad_percents\fR\*(T>\fR
302 Pad percentages to this many decimals (0 = no padding)
305 \fB\*(T<\fBpop3\fR\*(T>\fR
306 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.
309 \fB\*(T<\fBstippled_borders\fR\*(T>\fR
310 Border stippling (dashing) in pixels
313 \fB\*(T<\fBtotal_run_times\fR\*(T>\fR
314 Total number of times for Conky to update before quitting. Zero makes Conky run forever
317 \fB\*(T<\fBupdate_interval\fR\*(T>\fR
318 Update interval in seconds
321 \fB\*(T<\fBuppercase\fR\*(T>\fR
322 Boolean value, if true, text is rendered in upper case
325 \fB\*(T<\fBuse_spacer\fR\*(T>\fR
326 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.
329 \fB\*(T<\fBuse_xft\fR\*(T>\fR
330 Use Xft (anti-aliased font and stuff)
333 \fB\*(T<\fBwm_class_name\fR\*(T>\fR
334 Manually set the WM_CLASS name. Defaults to "conky".
337 \fB\*(T<\fBxftalpha\fR\*(T>\fR
338 Alpha of Xft font. Must be a value at or between 1 and 0.
341 \fB\*(T<\fBxftfont\fR\*(T>\fR
345 \fB\*(T<\fBxmms_player\fR\*(T>\fR
346 Use specified player/plugin for the xmms status variables. Valid items are: none, xmms, bmp, audacious and infopipe. (default is none). Note that bmpx is currently handled separately.
349 \fB\*(T<\fBTEXT\fR\*(T>\fR
350 After this begins text to be formatted on screen
353 Colors are parsed using XParsecolor(), there might be a list of them:
354 /usr/X11R6/lib/X11/rgb.txt. Also, \(lahttp://sedition.com/perl/rgb.html\(ra.
355 Color can be also in #rrggbb format (hex).
356 Note that when displaying bytes, power is 1024 and not 1000 so 1M really
357 means 1024*1024 bytes and not 1000*1000.
359 \fB\*(T<\fBaddr\fR\*(T>\fR \*(T<\fBinterface\fR\*(T>
360 IP address for an interface
363 \fB\*(T<\fBacpiacadapter\fR\*(T>\fR
364 ACPI ac adapter state.
367 \fB\*(T<\fBacpifan\fR\*(T>\fR
371 \fB\*(T<\fBacpitemp\fR\*(T>\fR
372 ACPI temperature in C.
375 \fB\*(T<\fBacpitempf\fR\*(T>\fR
376 ACPI temperature in F.
379 \fB\*(T<\fBadt746xcpu\fR\*(T>\fR
380 CPU temperature from therm_adt746x
383 \fB\*(T<\fBadt746xfan\fR\*(T>\fR
384 Fan speed from therm_adt746x
387 \fB\*(T<\fBalignr\fR\*(T>\fR \*(T<\fB(num)\fR\*(T>
388 Right-justify text, with space of N
391 \fB\*(T<\fBalignc\fR\*(T>\fR \*(T<\fB(num)\fR\*(T>
395 \fB\*(T<\fBapm_adapter\fR\*(T>\fR
396 Display APM AC adapter status (FreeBSD only)
399 \fB\*(T<\fBapm_battery_life\fR\*(T>\fR
400 Display APM battery life in percent (FreeBSD only)
403 \fB\*(T<\fBapm_battery_time\fR\*(T>\fR
404 Display remaining APM battery life in hh:mm:ss or "unknown" if
405 AC adapterstatus is on-line or charging (FreeBSD only)
408 \fB\*(T<\fBbattery\fR\*(T>\fR \*(T<\fB(num)\fR\*(T>
409 Remaining capacity in ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
412 \fB\*(T<\fBbmpx_artist\fR\*(T>\fR
413 Artist in current BMPx track
416 \fB\*(T<\fBbmpx_album\fR\*(T>\fR
417 Album in current BMPx track
420 \fB\*(T<\fBbmpx_title\fR\*(T>\fR
421 Title of the current BMPx track
424 \fB\*(T<\fBbmpx_track\fR\*(T>\fR
425 Track number of the current BMPx track
428 \fB\*(T<\fBbmpx_bitrate\fR\*(T>\fR
429 Bitrate of the current BMPx track
432 \fB\*(T<\fBbmpx_uri\fR\*(T>\fR
433 URI of the current BMPx track
436 \fB\*(T<\fBbuffers\fR\*(T>\fR
437 Amount of memory buffered
440 \fB\*(T<\fBcached\fR\*(T>\fR
441 Amount of memory cached
444 \fB\*(T<\fBcolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T>
445 Change drawing color to color
448 \fB\*(T<\fBcpu\fR\*(T>\fR \*(T<\fB(cpuN)\fR\*(T>
449 CPU usage in percents. For SMP machines, the CPU number can be provided as an argument. cpu0 is the total usage, and >=cpu1 are individual CPUs.
452 \fB\*(T<\fBcpubar\fR\*(T>\fR \*(T<\fB(cpu number) (height),(width)\fR\*(T>
453 Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
456 \fB\*(T<\fBcpugraph\fR\*(T>\fR \*(T<\fB(cpu number) (height),(width) (gradient colour 1) (gradient colour 2)\fR\*(T>
457 CPU usage graph, with optional colours in hex, minus the #. See $cpu for more info on SMP.
460 \fB\*(T<\fBdiskio\fR\*(T>\fR
461 Displays current disk IO.
464 \fB\*(T<\fBdiskiograph\fR\*(T>\fR \*(T<\fB(height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
465 Disk IO graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
468 \fB\*(T<\fBdownspeed\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
469 Download speed in kilobytes
472 \fB\*(T<\fBdownspeedf\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
473 Download speed in kilobytes with one decimal
476 \fB\*(T<\fBdownspeedgraph\fR\*(T>\fR \*(T<\fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
477 Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
480 \fB\*(T<\fBelse\fR\*(T>\fR
481 Text to show if any of the above are not true
484 \fB\*(T<\fBexec\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>
485 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.
488 \fB\*(T<\fBexecbar\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>
489 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.
492 \fB\*(T<\fBexecgraph\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>
493 Same as execbar, but graphs values.
496 \fB\*(T<\fBexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
497 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
500 \fB\*(T<\fBexecibar\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
501 Same as execbar, except with an interval
504 \fB\*(T<\fBexecigraph\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
505 Same as execigraph, but takes an interval arg graphs values
508 \fB\*(T<\fBfont\fR\*(T>\fR \*(T<\fB(font)\fR\*(T>
509 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)
512 \fB\*(T<\fBfreq\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
513 Returns CPU #n's frequency in MHz. CPUs are
514 counted from 1. If omitted, the parameter
518 \fB\*(T<\fBfreq_g\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
519 Returns CPU #n's frequency in GHz. CPUs are
520 counted from 1. If omitted, the parameter
524 \fB\*(T<\fBfreq_dyn\fR\*(T>\fR
525 Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
528 \fB\*(T<\fBfreq_dyn_g\fR\*(T>\fR
529 Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
532 \fB\*(T<\fBfs_bar\fR\*(T>\fR \*(T<\fB(height),(width) fs\fR\*(T>
533 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.
536 \fB\*(T<\fBfs_free\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
537 Free space on a file system available for users.
540 \fB\*(T<\fBfs_free_perc\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
541 Free percentage of space on a file system available for users.
544 \fB\*(T<\fBfs_size\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
548 \fB\*(T<\fBfs_used\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
549 File system used space
552 \fB\*(T<\fBgoto\fR\*(T>\fR \*(T<\fBx\fR\*(T>
553 The next element will be printed at position 'x'.
556 \fB\*(T<\fBhddtemp\fR\*(T>\fR \*(T<\fBdev, (host,(port))\fR\*(T>
557 Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
558 Default host is 127.0.0.1, default port is 7634.
561 \fB\*(T<\fBhead\fR\*(T>\fR \*(T<\fBlogfile lines (interval)\fR\*(T>
562 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.
565 \fB\*(T<\fBhr\fR\*(T>\fR \*(T<\fB(height)\fR\*(T>
566 Horizontal line, height is the height in pixels
569 \fB\*(T<\fBiconv_start\fR\*(T>\fR \*(T<\fBcodeset_from codeset_to\fR\*(T>
570 Convert text from one codeset to another using GNU iconv. Needs to be stopped with iconv_stop.
573 \fB\*(T<\fBiconv_stop\fR\*(T>\fR
574 Stop iconv codeset conversion.
577 \fB\*(T<\fBi2c\fR\*(T>\fR \*(T<\fB(dev) type n\fR\*(T>
578 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.
581 \fB\*(T<\fBi8k_ac_status\fR\*(T>\fR
582 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.
585 \fB\*(T<\fBi8k_bios\fR\*(T>\fR
586 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
589 \fB\*(T<\fBi8k_buttons_status\fR\*(T>\fR
590 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
593 \fB\*(T<\fBi8k_cpu_temp\fR\*(T>\fR
594 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
597 \fB\*(T<\fBi8k_cpu_tempf\fR\*(T>\fR
598 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Farenheit, as reported by /proc/i8k.
601 \fB\*(T<\fBi8k_left_fan_rpm\fR\*(T>\fR
602 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.
605 \fB\*(T<\fBi8k_left_fan_status\fR\*(T>\fR
606 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.
609 \fB\*(T<\fBi8k_right_fan_rpm\fR\*(T>\fR
610 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.
613 \fB\*(T<\fBi8k_right_fan_status\fR\*(T>\fR
614 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.
617 \fB\*(T<\fBi8k_serial\fR\*(T>\fR
618 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
621 \fB\*(T<\fBi8k_version\fR\*(T>\fR
622 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
625 \fB\*(T<\fBibm_fan\fR\*(T>\fR
626 If running the IBM ACPI, displays the fan speed.
629 \fB\*(T<\fBibm_temps\fR\*(T>\fR \*(T<\fBN\fR\*(T>
630 If running the IBM ACPI, displays the temperatures
631 from the IBM temperature sensors (N=0..7) Sensor 0 is
632 on the CPU, 3 is on the GPU.
635 \fB\*(T<\fBibm_volume\fR\*(T>\fR
636 If running the IBM ACPI, displays the "master" volume,
637 controlled by the volume keys (0-14).
640 \fB\*(T<\fBibm_brightness\fR\*(T>\fR
641 If running the IBM ACPI, displays the brigtness of the
645 \fB\*(T<\fBif_running\fR\*(T>\fR \*(T<\fB(process)\fR\*(T>
646 if PROCESS is running, display everything if_running and the matching $endif
649 \fB\*(T<\fBif_existing\fR\*(T>\fR \*(T<\fB(file)\fR\*(T>
650 if FILE exists, display everything between if_existing and the matching $endif
653 \fB\*(T<\fBif_mounted\fR\*(T>\fR \*(T<\fB(mountpoint)\fR\*(T>
654 if MOUNTPOINT is mounted, display everything between if_mounted and the matching $endif
657 \fB\*(T<\fBimap_messages\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
658 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 110, default interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
661 \fB\*(T<\fBimap_unseen\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
662 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 110, default interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
665 \fB\*(T<\fBkernel\fR\*(T>\fR
669 \fB\*(T<\fBlinkstatus\fR\*(T>\fR \*(T<\fBinterface\fR\*(T>
670 Get the link status for wireless connections
673 \fB\*(T<\fBloadavg\fR\*(T>\fR
674 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
677 \fB\*(T<\fBmachine\fR\*(T>\fR
678 Machine, i686 for example
681 \fB\*(T<\fBmails\fR\*(T>\fR
682 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.
685 \fB\*(T<\fBmem\fR\*(T>\fR
686 Amount of memory in use
689 \fB\*(T<\fBmembar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
690 Bar that shows amount of memory in use
693 \fB\*(T<\fBmemmax\fR\*(T>\fR
694 Total amount of memory
697 \fB\*(T<\fBmemperc\fR\*(T>\fR
698 Percentage of memory in use
701 \fB\*(T<\fBmpd_artist\fR\*(T>\fR
702 Artist in current MPD song must be enabled at compile
705 \fB\*(T<\fBmpd_album\fR\*(T>\fR
706 Album in current MPD song
709 \fB\*(T<\fBmpd_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
710 Bar of mpd's progress
713 \fB\*(T<\fBmpd_bitrate\fR\*(T>\fR
714 Bitrate of current song
717 \fB\*(T<\fBmpd_status\fR\*(T>\fR
718 Playing, stopped, et cetera.
721 \fB\*(T<\fBmpd_title\fR\*(T>\fR
722 Title of current MPD song
725 \fB\*(T<\fBmpd_vol\fR\*(T>\fR
729 \fB\*(T<\fBmpd_elapsed\fR\*(T>\fR
733 \fB\*(T<\fBmpd_length\fR\*(T>\fR
737 \fB\*(T<\fBmpd_percent\fR\*(T>\fR
738 Percent of song's progress
741 \fB\*(T<\fBmpd_random\fR\*(T>\fR
742 Random status (On/Off)
745 \fB\*(T<\fBmpd_repeat\fR\*(T>\fR
746 Repeat status (On/Off)
749 \fB\*(T<\fBmpd_track\fR\*(T>\fR
750 Prints the MPD track field
753 \fB\*(T<\fBmpd_name\fR\*(T>\fR
754 Prints the MPD name field
757 \fB\*(T<\fBmpd_file\fR\*(T>\fR
758 Prints the file name of the current MPD song
761 \fB\*(T<\fBmpd_smart\fR\*(T>\fR
762 Prints the song name in either the form "artist - title" or file name, depending on whats available
765 \fB\*(T<\fBnew_mails\fR\*(T>\fR
766 Unread mail count in mail spool.
769 \fB\*(T<\fBnodename\fR\*(T>\fR
773 \fB\*(T<\fBoutlinecolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T>
777 \fB\*(T<\fBpb_battery\fR\*(T>\fR \*(T<\fBitem\fR\*(T>
778 If running on Apple powerbook/ibook, display
779 information on battery status. The item parameter
780 specifies, what information to display. Exactly one item
781 must be specified. Valid items are:
784 Display if battery is fully charged, charging,
785 discharging or absent (running on AC)
788 Display charge of battery in percent, if
789 charging or discharging. Nothing will be
790 displayed, if battery is fully charged
794 Display the time remaining until the battery
795 will be fully charged or discharged at current
796 rate. Nothing is displayed, if battery is
797 absent or if it's present but fully charged
801 \fB\*(T<\fBpop3_unseen\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
802 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.
805 \fB\*(T<\fBpop3_used\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
806 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.
809 \fB\*(T<\fBpre_exec\fR\*(T>\fR \*(T<\fBshell command\fR\*(T>
810 Executes a shell command one time before conky displays anything and puts output as text.
813 \fB\*(T<\fBprocesses\fR\*(T>\fR
814 Total processes (sleeping and running)
817 \fB\*(T<\fBrunning_processes\fR\*(T>\fR
818 Running processes (not sleeping), requires Linux 2.6
821 \fB\*(T<\fBshadecolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T>
825 \fB\*(T<\fBstippled_hr\fR\*(T>\fR \*(T<\fB(space)\fR\*(T>
826 Stippled (dashed) horizontal line
829 \fB\*(T<\fBswapbar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
830 Bar that shows amount of swap in use
833 \fB\*(T<\fBswap\fR\*(T>\fR
834 Amount of swap in use
837 \fB\*(T<\fBswapmax\fR\*(T>\fR
841 \fB\*(T<\fBswapperc\fR\*(T>\fR
842 Percentage of swap in use
845 \fB\*(T<\fBsysname\fR\*(T>\fR
846 System name, Linux for example
849 \fB\*(T<\fBtcp_portmon\fR\*(T>\fR \*(T<\fBport_begin port_end item (index)\fR\*(T> \fI(ip4 only at present)\fR
850 TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
852 \fBcount\fR - total number of connections in the range
854 \fBrip\fR - remote ip address
856 \fBrhost\fR - remote host name
858 \fBrport\fR - remote port number
860 \fBrservice\fR - remote service name from /etc/services
862 \fBlip\fR - local ip address
864 \fBlhost\fR - local host name
866 \fBlport\fR - local port number
868 \fBlservice\fR - local service name from /etc/services
870 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.
874 \fB${tcp_portmon 6881 6999 count}\fR -
875 displays the number of connections in the bittorrent port range
877 \fB${tcp_portmon 22 22 rip 0}\fR -
878 displays the remote host ip of the first sshd connection
880 \fB${tcp_portmon 22 22 rip 9}\fR -
881 displays the remote host ip of the tenth sshd connection
883 \fB${tcp_portmon 1 1024 rhost 0}\fR -
884 displays the remote host name of the first connection on a privileged port
886 \fB${tcp_portmon 1 1024 rport 4}\fR -
887 displays the remote host port of the fifth connection on a privileged port
889 \fB${tcp_portmon 1 65535 lservice 14}\fR -
890 displays the local service name of the fifteenth connection in the range of all ports
892 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.
894 \fB\*(T<\fBtexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
895 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.
898 \fB\*(T<\fBoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T>
899 Move text over by N pixels. See also $voffset.
902 \fB\*(T<\fBtab\fR\*(T>\fR \*(T<\fB(width, (start))\fR\*(T>
903 Puts a tab of the specified width, starting from column 'start'.
906 \fB\*(T<\fBtail\fR\*(T>\fR \*(T<\fBlogfile lines (interval)\fR\*(T>
907 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.
910 \fB\*(T<\fBtime\fR\*(T>\fR \*(T<\fB(format)\fR\*(T>
911 Local time, see man strftime to get more information about format
914 \fB\*(T<\fButime\fR\*(T>\fR \*(T<\fB(format)\fR\*(T>
915 Display time in UTC (universal coordinate time).
918 \fB\*(T<\fBtztime\fR\*(T>\fR \*(T<\fB(timezone) (format)\fR\*(T>
919 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.
922 \fB\*(T<\fBtotaldown\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
923 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.
926 \fB\*(T<\fBtop\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T>
927 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.
930 \fB\*(T<\fBtop_mem\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T>
931 Same as top, except sorted by mem usage instead of cpu
934 \fB\*(T<\fBtotalup\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
935 Total upload, this one too, may overflow
938 \fB\*(T<\fBupdates\fR\*(T>\fR \*(T<\fBNumber of updates\fR\*(T>
942 \fB\*(T<\fBupspeed\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
943 Upload speed in kilobytes
946 \fB\*(T<\fBupspeedf\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
947 Upload speed in kilobytes with one decimal
950 \fB\*(T<\fBupspeedgraph\fR\*(T>\fR \*(T<\fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
951 Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
954 \fB\*(T<\fBuptime\fR\*(T>\fR
958 \fB\*(T<\fBuptime_short\fR\*(T>\fR
959 Uptime in a shorter format
962 \fB\*(T<\fBseti_prog\fR\*(T>\fR
963 Seti@home current progress
966 \fB\*(T<\fBseti_progbar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
967 Seti@home current progress bar
970 \fB\*(T<\fBseti_credit\fR\*(T>\fR
971 Seti@home total user credit
974 \fB\*(T<\fBvoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T>
975 Change vertical offset by N pixels. Negative values will cause text to overlap. See also $offset.
978 \fB\*(T<\fBvoltage_mv\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
979 Returns CPU #n's voltage in mV. CPUs are
980 counted from 1. If omitted, the parameter
984 \fB\*(T<\fBvoltage_v\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
985 Returns CPU #n's voltage in V. CPUs are
986 counted from 1. If omitted, the parameter
990 \fB\*(T<\fBxmms_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
991 xmms / bmp / audacious / infopipe: progress bar
994 \fB\*(T<\fBxmms_bitrate\fR\*(T>\fR
995 xmms / bmp / audacious / infopipe: bitrate of current tune
998 \fB\*(T<\fBxmms_channels\fR\*(T>\fR
999 xmms / bmp / audacious / infopipe: number of audio channels of current tune
1002 \fB\*(T<\fBxmms_filename\fR\*(T>\fR
1003 xmms / bmp / audacious / infopipe: full path and filename of current tune
1006 \fB\*(T<\fBxmms_frequency\fR\*(T>\fR
1007 xmms / bmp / audacious / infopipe: sampling frequency of current tune
1010 \fB\*(T<\fBxmms_length\fR\*(T>\fR
1011 xmms / bmp / audacious / infopipe: total length of current tune as MM:SS
1014 \fB\*(T<\fBxmms_length_seconds\fR\*(T>\fR
1015 xmms / bmp / audacious / infopipe: total length of current tune in seconds
1018 \fB\*(T<\fBxmms_playlist_position\fR\*(T>\fR
1019 xmms / bmp / audacious / infopipe: playlist position of current tune
1022 \fB\*(T<\fBxmms_playlist_length\fR\*(T>\fR
1023 xmms / bmp / audacious / infopipe: number of tunes in playlist
1026 \fB\*(T<\fBxmms_position\fR\*(T>\fR
1027 xmms / bmp / audacious / infopipe: MM:SS position of current tune
1030 \fB\*(T<\fBxmms_position_seconds\fR\*(T>\fR
1031 xmms / bmp / audacious / infopipe: position of current tune in seconds
1034 \fB\*(T<\fBxmms_status\fR\*(T>\fR
1035 xmms / bmp / audacious / infopipe: player status (Playing/Paused/Stopped/Not running)
1038 \fB\*(T<\fBxmms_title\fR\*(T>\fR
1039 xmms / bmp / audacious / infopipe: title of current tune
1043 \*(T<conky \*(T>\*(T<\fB\-t '${time %D %H:%m}' \-o \-u 30\fR\*(T>
1044 Start Conky in its own window with date and clock as text and 30 sec update interval.
1046 \*(T<conky \*(T>\*(T<\fB\-a top_left \-x 5 \-y 500 \-d\fR\*(T>
1047 Start Conky to background at coordinates (5, 500).
1049 \*(T<\fI~/.conkyrc\fR\*(T> default configuration file
1051 Drawing to root or some other desktop window directly doesn't work with
1052 all window managers. Especially doesn't work well with Gnome and it has
1053 been reported that it doesn't work with KDE either. Nautilus can be
1054 disabled from drawing to desktop with program gconf-editor. Uncheck
1055 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky
1056 to set some specific window id. You might find xwininfo -tree useful to
1057 find the window to draw to. You can also use -o argument which makes
1058 Conky to create its own window.
1060 \(lahttp://conky.sourceforge.net\(ra
1062 \(lahttp://www.sourceforge.net/projects/conky\(ra
1064 #conky on irc.freenode.net
1066 The Conky dev team. What's up now!