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 between right or left border of screen, same as passing -x at command line
199 \fB\*(T<\fBgap_y\fR\*(T>\fR
200 Gap between top or bottom border of screen, same as passing -y at command line
203 \fB\*(T<\fBimap\fR\*(T>\fR
204 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.
207 \fB\*(T<\fBmail_spool\fR\*(T>\fR
208 Mail spool for mail checking
211 \fB\*(T<\fBmax_user_text\fR\*(T>\fR \*(T<\fBbytes\fR\*(T>
212 Maximum size of user text buffer, i.e. layout below TEXT line in config file
213 (default is 16384 bytes)
216 \fB\*(T<\fBmaximum_width\fR\*(T>\fR \*(T<\fBpixels\fR\*(T>
217 Maximum width of window
220 \fB\*(T<\fBminimum_size\fR\*(T>\fR \*(T<\fBwidth (height)\fR\*(T>
221 Minimum size of window
224 \fB\*(T<\fBmin_port_monitors\fR\*(T>\fR
225 Allow for the creation of at least this number of port monitors (if 0 or not set, default is 16)
228 \fB\*(T<\fBmin_port_monitor_connections\fR\*(T>\fR
229 Allow each port monitor to track at least this many connections (if 0 or not set, default is 256)
232 \fB\*(T<\fBmpd_host\fR\*(T>\fR
236 \fB\*(T<\fBmpd_port\fR\*(T>\fR
240 \fB\*(T<\fBmpd_password\fR\*(T>\fR
244 \fB\*(T<\fBnet_avg_samples\fR\*(T>\fR
245 The number of samples to average for net data
248 \fB\*(T<\fBno_buffers\fR\*(T>\fR
249 Substract (file system) buffers from used memory?
252 \fB\*(T<\fBoverride_utf8_locale\fR\*(T>\fR
253 Force UTF8? requires XFT
256 \fB\*(T<\fBown_window\fR\*(T>\fR
257 Boolean, create own window to draw?
260 \fB\*(T<\fBown_window_transparent\fR\*(T>\fR
261 Boolean, set pseudo-transparency?
264 \fB\*(T<\fBown_window_type\fR\*(T>\fR
265 if own_window is yes, you may specify type normal, desktop or override (default: normal).
266 Desktop windows are special windows that have no window decorations; are always visible
267 on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
268 Override windows are not under the control of the window manager. Hints are ignored. This type
269 of window can be useful for certain situations.
272 \fB\*(T<\fBown_window_colour\fR\*(T>\fR \*(T<\fBcolour\fR\*(T>
273 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)
276 \fB\*(T<\fBown_window_hints\fR\*(T>\fR \*(T<\fBundecorated,below,above,sticky,skip_taskbar,skip_pager\fR\*(T>
277 If own_window is yes, you may use these window manager hints to affect the way Conky displays.
278 Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
279 If you use own_window_type override, window manager hints have no meaning and are ignored.
282 \fB\*(T<\fBout_to_console\fR\*(T>\fR
283 Print text to stdout.
286 \fB\*(T<\fBpad_percents\fR\*(T>\fR
287 Pad percentages to this many decimals (0 = no padding)
290 \fB\*(T<\fBpop3\fR\*(T>\fR
291 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.
294 \fB\*(T<\fBstippled_borders\fR\*(T>\fR
295 Border stippling (dashing) in pixels
298 \fB\*(T<\fBtotal_run_times\fR\*(T>\fR
299 Total number of times for Conky to update before quitting. Zero makes Conky run forever
302 \fB\*(T<\fBupdate_interval\fR\*(T>\fR
303 Update interval in seconds
306 \fB\*(T<\fBuppercase\fR\*(T>\fR
307 Boolean value, if true, text is rendered in upper case
310 \fB\*(T<\fBuse_spacer\fR\*(T>\fR
311 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.
314 \fB\*(T<\fBuse_xft\fR\*(T>\fR
315 Use Xft (anti-aliased font and stuff)
318 \fB\*(T<\fBwm_class_name\fR\*(T>\fR
319 Manually set the WM_CLASS name. Defaults to "conky".
322 \fB\*(T<\fBxftalpha\fR\*(T>\fR
323 Alpha of Xft font. Must be a value at or between 1 and 0.
326 \fB\*(T<\fBxftfont\fR\*(T>\fR
330 \fB\*(T<\fBTEXT\fR\*(T>\fR
331 After this begins text to be formatted on screen
334 Colors are parsed using XParsecolor(), there might be a list of them:
335 /usr/X11R6/lib/X11/rgb.txt. Also, \(lahttp://sedition.com/perl/rgb.html\(ra.
336 Color can be also in #rrggbb format (hex).
337 Note that when displaying bytes, power is 1024 and not 1000 so 1M really
338 means 1024*1024 bytes and not 1000*1000.
340 \fB\*(T<\fBaddr\fR\*(T>\fR \*(T<\fBinterface\fR\*(T>
341 IP address for an interface
344 \fB\*(T<\fBacpiacadapter\fR\*(T>\fR
345 ACPI ac adapter state.
348 \fB\*(T<\fBacpifan\fR\*(T>\fR
352 \fB\*(T<\fBacpitemp\fR\*(T>\fR
353 ACPI temperature in C.
356 \fB\*(T<\fBacpitempf\fR\*(T>\fR
357 ACPI temperature in F.
360 \fB\*(T<\fBadt746xcpu\fR\*(T>\fR
361 CPU temperature from therm_adt746x
364 \fB\*(T<\fBadt746xfan\fR\*(T>\fR
365 Fan speed from therm_adt746x
368 \fB\*(T<\fBalignr\fR\*(T>\fR \*(T<\fB(num)\fR\*(T>
369 Right-justify text, with space of N
372 \fB\*(T<\fBalignc\fR\*(T>\fR \*(T<\fB(num)\fR\*(T>
376 \fB\*(T<\fBapm_adapter\fR\*(T>\fR
377 Display APM AC adapter status (FreeBSD only)
380 \fB\*(T<\fBapm_battery_life\fR\*(T>\fR
381 Display APM battery life in percent (FreeBSD only)
384 \fB\*(T<\fBapm_battery_time\fR\*(T>\fR
385 Display remaining APM battery life in hh:mm:ss or "unknown" if
386 AC adapterstatus is on-line or charging (FreeBSD only)
389 \fB\*(T<\fBaudacious_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
393 \fB\*(T<\fBaudacious_bitrate\fR\*(T>\fR
394 Bitrate of current tune
397 \fB\*(T<\fBaudacious_channels\fR\*(T>\fR
398 Number of audio channels of current tune
401 \fB\*(T<\fBaudacious_filename\fR\*(T>\fR
402 Full path and filename of current tune
405 \fB\*(T<\fBaudacious_frequency\fR\*(T>\fR
406 Sampling frequency of current tune
409 \fB\*(T<\fBaudacious_length\fR\*(T>\fR
410 Total length of current tune as MM:SS
413 \fB\*(T<\fBaudacious_length_seconds\fR\*(T>\fR
414 Total length of current tune in seconds
417 \fB\*(T<\fBaudacious_playlist_position\fR\*(T>\fR
418 Playlist position of current tune
421 \fB\*(T<\fBaudacious_playlist_length\fR\*(T>\fR
422 Number of tunes in playlist
425 \fB\*(T<\fBaudacious_position\fR\*(T>\fR
426 Position of current tune (MM:SS)
429 \fB\*(T<\fBaudacious_position_seconds\fR\*(T>\fR
430 Position of current tune in seconds
433 \fB\*(T<\fBaudacious_status\fR\*(T>\fR
434 Player status (Playing/Paused/Stopped/Not running)
437 \fB\*(T<\fBaudacious_title\fR\*(T>\fR
438 Title of current tune
441 \fB\*(T<\fBbattery\fR\*(T>\fR \*(T<\fB(num)\fR\*(T>
442 Remaining capacity in ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
445 \fB\*(T<\fBbmpx_artist\fR\*(T>\fR
446 Artist in current BMPx track
449 \fB\*(T<\fBbmpx_album\fR\*(T>\fR
450 Album in current BMPx track
453 \fB\*(T<\fBbmpx_title\fR\*(T>\fR
454 Title of the current BMPx track
457 \fB\*(T<\fBbmpx_track\fR\*(T>\fR
458 Track number of the current BMPx track
461 \fB\*(T<\fBbmpx_bitrate\fR\*(T>\fR
462 Bitrate of the current BMPx track
465 \fB\*(T<\fBbmpx_uri\fR\*(T>\fR
466 URI of the current BMPx track
469 \fB\*(T<\fBbuffers\fR\*(T>\fR
470 Amount of memory buffered
473 \fB\*(T<\fBcached\fR\*(T>\fR
474 Amount of memory cached
477 \fB\*(T<\fBcolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T>
478 Change drawing color to color
481 \fB\*(T<\fBcpu\fR\*(T>\fR \*(T<\fB(cpuN)\fR\*(T>
482 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.
485 \fB\*(T<\fBcpubar\fR\*(T>\fR \*(T<\fB(cpu number) (height),(width)\fR\*(T>
486 Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
489 \fB\*(T<\fBcpugraph\fR\*(T>\fR \*(T<\fB(cpu number) (height),(width) (gradient colour 1) (gradient colour 2)\fR\*(T>
490 CPU usage graph, with optional colours in hex, minus the #. See $cpu for more info on SMP.
493 \fB\*(T<\fBdiskio\fR\*(T>\fR
494 Displays current disk IO.
497 \fB\*(T<\fBdiskiograph\fR\*(T>\fR \*(T<\fB(height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
498 Disk IO graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
501 \fB\*(T<\fBdownspeed\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
502 Download speed in kilobytes
505 \fB\*(T<\fBdownspeedf\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
506 Download speed in kilobytes with one decimal
509 \fB\*(T<\fBdownspeedgraph\fR\*(T>\fR \*(T<\fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
510 Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
513 \fB\*(T<\fBelse\fR\*(T>\fR
514 Text to show if any of the above are not true
517 \fB\*(T<\fBexec\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>
518 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.
521 \fB\*(T<\fBexecbar\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>
522 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.
525 \fB\*(T<\fBexecgraph\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>
526 Same as execbar, but graphs values.
529 \fB\*(T<\fBexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
530 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
533 \fB\*(T<\fBexecibar\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
534 Same as execbar, except with an interval
537 \fB\*(T<\fBexecigraph\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
538 Same as execigraph, but takes an interval arg graphs values
541 \fB\*(T<\fBfont\fR\*(T>\fR \*(T<\fB(font)\fR\*(T>
542 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)
545 \fB\*(T<\fBfreq\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
546 Returns CPU #n's frequency in MHz. CPUs are
547 counted from 1. If omitted, the parameter
551 \fB\*(T<\fBfreq_g\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
552 Returns CPU #n's frequency in GHz. CPUs are
553 counted from 1. If omitted, the parameter
557 \fB\*(T<\fBfreq_dyn\fR\*(T>\fR
558 Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
561 \fB\*(T<\fBfreq_dyn_g\fR\*(T>\fR
562 Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
565 \fB\*(T<\fBfs_bar\fR\*(T>\fR \*(T<\fB(height),(width) fs\fR\*(T>
566 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.
569 \fB\*(T<\fBfs_free\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
570 Free space on a file system available for users.
573 \fB\*(T<\fBfs_free_perc\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
574 Free percentage of space on a file system available for users.
577 \fB\*(T<\fBfs_size\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
581 \fB\*(T<\fBfs_used\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
582 File system used space
585 \fB\*(T<\fBgoto\fR\*(T>\fR \*(T<\fBx\fR\*(T>
586 The next element will be printed at position 'x'.
589 \fB\*(T<\fBhddtemp\fR\*(T>\fR \*(T<\fBdev, (host,(port))\fR\*(T>
590 Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
591 Default host is 127.0.0.1, default port is 7634.
594 \fB\*(T<\fBhead\fR\*(T>\fR \*(T<\fBlogfile lines (interval)\fR\*(T>
595 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.
598 \fB\*(T<\fBhr\fR\*(T>\fR \*(T<\fB(height)\fR\*(T>
599 Horizontal line, height is the height in pixels
602 \fB\*(T<\fBiconv_start\fR\*(T>\fR \*(T<\fBcodeset_from codeset_to\fR\*(T>
603 Convert text from one codeset to another using GNU iconv. Needs to be stopped with iconv_stop.
606 \fB\*(T<\fBiconv_stop\fR\*(T>\fR
607 Stop iconv codeset conversion.
610 \fB\*(T<\fBi2c\fR\*(T>\fR \*(T<\fB(dev) type n\fR\*(T>
611 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.
614 \fB\*(T<\fBi8k_ac_status\fR\*(T>\fR
615 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.
618 \fB\*(T<\fBi8k_bios\fR\*(T>\fR
619 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
622 \fB\*(T<\fBi8k_buttons_status\fR\*(T>\fR
623 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
626 \fB\*(T<\fBi8k_cpu_temp\fR\*(T>\fR
627 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
630 \fB\*(T<\fBi8k_cpu_tempf\fR\*(T>\fR
631 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Farenheit, as reported by /proc/i8k.
634 \fB\*(T<\fBi8k_left_fan_rpm\fR\*(T>\fR
635 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.
638 \fB\*(T<\fBi8k_left_fan_status\fR\*(T>\fR
639 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.
642 \fB\*(T<\fBi8k_right_fan_rpm\fR\*(T>\fR
643 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.
646 \fB\*(T<\fBi8k_right_fan_status\fR\*(T>\fR
647 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.
650 \fB\*(T<\fBi8k_serial\fR\*(T>\fR
651 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
654 \fB\*(T<\fBi8k_version\fR\*(T>\fR
655 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
658 \fB\*(T<\fBibm_fan\fR\*(T>\fR
659 If running the IBM ACPI, displays the fan speed.
662 \fB\*(T<\fBibm_temps\fR\*(T>\fR \*(T<\fBN\fR\*(T>
663 If running the IBM ACPI, displays the temperatures
664 from the IBM temperature sensors (N=0..7) Sensor 0 is
665 on the CPU, 3 is on the GPU.
668 \fB\*(T<\fBibm_volume\fR\*(T>\fR
669 If running the IBM ACPI, displays the "master" volume,
670 controlled by the volume keys (0-14).
673 \fB\*(T<\fBibm_brightness\fR\*(T>\fR
674 If running the IBM ACPI, displays the brigtness of the
678 \fB\*(T<\fBif_running\fR\*(T>\fR \*(T<\fB(process)\fR\*(T>
679 if PROCESS is running, display everything if_running and the matching $endif
682 \fB\*(T<\fBif_existing\fR\*(T>\fR \*(T<\fB(file)\fR\*(T>
683 if FILE exists, display everything between if_existing and the matching $endif
686 \fB\*(T<\fBif_mounted\fR\*(T>\fR \*(T<\fB(mountpoint)\fR\*(T>
687 if MOUNTPOINT is mounted, display everything between if_mounted and the matching $endif
690 \fB\*(T<\fBimap_messages\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
691 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.
694 \fB\*(T<\fBimap_unseen\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
695 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.
698 \fB\*(T<\fBkernel\fR\*(T>\fR
702 \fB\*(T<\fBlinkstatus\fR\*(T>\fR \*(T<\fBinterface\fR\*(T>
703 Get the link status for wireless connections
706 \fB\*(T<\fBloadavg\fR\*(T>\fR
707 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
710 \fB\*(T<\fBmachine\fR\*(T>\fR
711 Machine, i686 for example
714 \fB\*(T<\fBmails\fR\*(T>\fR
715 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.
718 \fB\*(T<\fBmem\fR\*(T>\fR
719 Amount of memory in use
722 \fB\*(T<\fBmembar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
723 Bar that shows amount of memory in use
726 \fB\*(T<\fBmemmax\fR\*(T>\fR
727 Total amount of memory
730 \fB\*(T<\fBmemperc\fR\*(T>\fR
731 Percentage of memory in use
734 \fB\*(T<\fBmpd_artist\fR\*(T>\fR
735 Artist in current MPD song must be enabled at compile
738 \fB\*(T<\fBmpd_album\fR\*(T>\fR
739 Album in current MPD song
742 \fB\*(T<\fBmpd_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
743 Bar of mpd's progress
746 \fB\*(T<\fBmpd_bitrate\fR\*(T>\fR
747 Bitrate of current song
750 \fB\*(T<\fBmpd_status\fR\*(T>\fR
751 Playing, stopped, et cetera.
754 \fB\*(T<\fBmpd_title\fR\*(T>\fR
755 Title of current MPD song
758 \fB\*(T<\fBmpd_vol\fR\*(T>\fR
762 \fB\*(T<\fBmpd_elapsed\fR\*(T>\fR
766 \fB\*(T<\fBmpd_length\fR\*(T>\fR
770 \fB\*(T<\fBmpd_percent\fR\*(T>\fR
771 Percent of song's progress
774 \fB\*(T<\fBmpd_random\fR\*(T>\fR
775 Random status (On/Off)
778 \fB\*(T<\fBmpd_repeat\fR\*(T>\fR
779 Repeat status (On/Off)
782 \fB\*(T<\fBmpd_track\fR\*(T>\fR
783 Prints the MPD track field
786 \fB\*(T<\fBmpd_name\fR\*(T>\fR
787 Prints the MPD name field
790 \fB\*(T<\fBmpd_file\fR\*(T>\fR
791 Prints the file name of the current MPD song
794 \fB\*(T<\fBmpd_smart\fR\*(T>\fR
795 Prints the song name in either the form "artist - title" or file name, depending on whats available
798 \fB\*(T<\fBnew_mails\fR\*(T>\fR
799 Unread mail count in mail spool.
802 \fB\*(T<\fBnodename\fR\*(T>\fR
806 \fB\*(T<\fBoutlinecolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T>
810 \fB\*(T<\fBpb_battery\fR\*(T>\fR \*(T<\fBitem\fR\*(T>
811 If running on Apple powerbook/ibook, display
812 information on battery status. The item parameter
813 specifies, what information to display. Exactly one item
814 must be specified. Valid items are:
817 Display if battery is fully charged, charging,
818 discharging or absent (running on AC)
821 Display charge of battery in percent, if
822 charging or discharging. Nothing will be
823 displayed, if battery is fully charged
827 Display the time remaining until the battery
828 will be fully charged or discharged at current
829 rate. Nothing is displayed, if battery is
830 absent or if it's present but fully charged
834 \fB\*(T<\fBpop3_unseen\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
835 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.
838 \fB\*(T<\fBpop3_used\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
839 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.
842 \fB\*(T<\fBpre_exec\fR\*(T>\fR \*(T<\fBshell command\fR\*(T>
843 Executes a shell command one time before conky displays anything and puts output as text.
846 \fB\*(T<\fBprocesses\fR\*(T>\fR
847 Total processes (sleeping and running)
850 \fB\*(T<\fBrunning_processes\fR\*(T>\fR
851 Running processes (not sleeping), requires Linux 2.6
854 \fB\*(T<\fBshadecolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T>
858 \fB\*(T<\fBstippled_hr\fR\*(T>\fR \*(T<\fB(space)\fR\*(T>
859 Stippled (dashed) horizontal line
862 \fB\*(T<\fBswapbar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
863 Bar that shows amount of swap in use
866 \fB\*(T<\fBswap\fR\*(T>\fR
867 Amount of swap in use
870 \fB\*(T<\fBswapmax\fR\*(T>\fR
874 \fB\*(T<\fBswapperc\fR\*(T>\fR
875 Percentage of swap in use
878 \fB\*(T<\fBsysname\fR\*(T>\fR
879 System name, Linux for example
882 \fB\*(T<\fBtcp_portmon\fR\*(T>\fR \*(T<\fBport_begin port_end item (index)\fR\*(T> \fI(ip4 only at present)\fR
883 TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
885 \fBcount\fR - total number of connections in the range
887 \fBrip\fR - remote ip address
889 \fBrhost\fR - remote host name
891 \fBrport\fR - remote port number
893 \fBrservice\fR - remote service name from /etc/services
895 \fBlip\fR - local ip address
897 \fBlhost\fR - local host name
899 \fBlport\fR - local port number
901 \fBlservice\fR - local service name from /etc/services
903 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.
907 \fB${tcp_portmon 6881 6999 count}\fR -
908 displays the number of connections in the bittorrent port range
910 \fB${tcp_portmon 22 22 rip 0}\fR -
911 displays the remote host ip of the first sshd connection
913 \fB${tcp_portmon 22 22 rip 9}\fR -
914 displays the remote host ip of the tenth sshd connection
916 \fB${tcp_portmon 1 1024 rhost 0}\fR -
917 displays the remote host name of the first connection on a privileged port
919 \fB${tcp_portmon 1 1024 rport 4}\fR -
920 displays the remote host port of the fifth connection on a privileged port
922 \fB${tcp_portmon 1 65535 lservice 14}\fR -
923 displays the local service name of the fifteenth connection in the range of all ports
925 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.
927 \fB\*(T<\fBtexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
928 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.
931 \fB\*(T<\fBoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T>
932 Move text over by N pixels. See also $voffset.
935 \fB\*(T<\fBtab\fR\*(T>\fR \*(T<\fB(width, (start))\fR\*(T>
936 Puts a tab of the specified width, starting from column 'start'.
939 \fB\*(T<\fBtail\fR\*(T>\fR \*(T<\fBlogfile lines (interval)\fR\*(T>
940 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.
943 \fB\*(T<\fBtime\fR\*(T>\fR \*(T<\fB(format)\fR\*(T>
944 Local time, see man strftime to get more information about format
947 \fB\*(T<\fButime\fR\*(T>\fR \*(T<\fB(format)\fR\*(T>
948 Display time in UTC (universal coordinate time).
951 \fB\*(T<\fBtztime\fR\*(T>\fR \*(T<\fB(timezone) (format)\fR\*(T>
952 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.
955 \fB\*(T<\fBtotaldown\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
956 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.
959 \fB\*(T<\fBtop\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T>
960 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.
963 \fB\*(T<\fBtop_mem\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T>
964 Same as top, except sorted by mem usage instead of cpu
967 \fB\*(T<\fBtotalup\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
968 Total upload, this one too, may overflow
971 \fB\*(T<\fBupdates\fR\*(T>\fR \*(T<\fBNumber of updates\fR\*(T>
975 \fB\*(T<\fBupspeed\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
976 Upload speed in kilobytes
979 \fB\*(T<\fBupspeedf\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
980 Upload speed in kilobytes with one decimal
983 \fB\*(T<\fBupspeedgraph\fR\*(T>\fR \*(T<\fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
984 Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
987 \fB\*(T<\fBuptime\fR\*(T>\fR
991 \fB\*(T<\fBuptime_short\fR\*(T>\fR
992 Uptime in a shorter format
995 \fB\*(T<\fBvoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T>
996 Change vertical offset by N pixels. Negative values will cause text to overlap. See also $offset.
999 \fB\*(T<\fBvoltage_mv\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
1000 Returns CPU #n's voltage in mV. CPUs are
1001 counted from 1. If omitted, the parameter
1005 \fB\*(T<\fBvoltage_v\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
1006 Returns CPU #n's voltage in V. CPUs are
1007 counted from 1. If omitted, the parameter
1012 \*(T<conky \*(T>\*(T<\fB\-t '${time %D %H:%m}' \-o \-u 30\fR\*(T>
1013 Start Conky in its own window with date and clock as text and 30 sec update interval.
1015 \*(T<conky \*(T>\*(T<\fB\-a top_left \-x 5 \-y 500 \-d\fR\*(T>
1016 Start Conky to background at coordinates (5, 500).
1018 \*(T<\fI~/.conkyrc\fR\*(T> default configuration file
1020 Drawing to root or some other desktop window directly doesn't work with
1021 all window managers. Especially doesn't work well with Gnome and it has
1022 been reported that it doesn't work with KDE either. Nautilus can be
1023 disabled from drawing to desktop with program gconf-editor. Uncheck
1024 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky
1025 to set some specific window id. You might find xwininfo -tree useful to
1026 find the window to draw to. You can also use -o argument which makes
1027 Conky to create its own window.
1029 \(lahttp://conky.sourceforge.net\(ra
1031 \(lahttp://www.sourceforge.net/projects/conky\(ra
1033 #conky on irc.freenode.net
1035 The Conky dev team. What's up now!