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 \-\-disable\-own\-window \-\-enable\-audacious \-\-enable\-bmpx \-\-disable\-hddtemp \-\-disable\-mpd \-\-enable\-xmms2 \-\-disable\-portmon \-\-disable\-network \-\-enable\-debug \-\-disable\-x11 \-\-disable\-double\-buffer \-\-disable\-xdamage \-\-disable\-xft\fR\*(T>
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<\fBdexter_client\fR\*(T>\fR
172 Act as client and connect to libdexter server for remote monitoring?
175 \fB\*(T<\fBdexter_config\fR\*(T>\fR
176 Full path to libdexter configuration file (default search order: $HOME/.dexterrc; /etc/libdexter/dexter.conf)
179 \fB\*(T<\fBdexter_server\fR\*(T>\fR
180 Act as server for libdexter services?
183 \fB\*(T<\fBdouble_buffer\fR\*(T>\fR
184 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.
187 \fB\*(T<\fBdraw_borders\fR\*(T>\fR
188 Draw borders around text?
191 \fB\*(T<\fBdraw_graph_borders\fR\*(T>\fR
192 Draw borders around graphs?
195 \fB\*(T<\fBdraw_outline\fR\*(T>\fR
199 \fB\*(T<\fBdraw_shades\fR\*(T>\fR
203 \fB\*(T<\fBfont\fR\*(T>\fR
204 Font name in X, xfontsel can be used to get a nice font
207 \fB\*(T<\fBgap_x\fR\*(T>\fR
208 Gap, in pixels, between right or left border of screen, same as passing -x at command line,
212 \fB\*(T<\fBgap_y\fR\*(T>\fR
213 Gap, in pixels, between top or bottom border of screen, same as passing -y at command line,
217 \fB\*(T<\fBimap\fR\*(T>\fR
218 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.
221 \fB\*(T<\fBmail_spool\fR\*(T>\fR
222 Mail spool for mail checking
225 \fB\*(T<\fBmax_port_monitor_connections\fR\*(T>\fR
226 Allow each port monitor to track at most this many connections (if 0 or not set, default is 256)
229 \fB\*(T<\fBmax_specials\fR\*(T>\fR
230 Maximum number of special things, e.g. fonts, offsets, aligns, etc. (default is 512)
233 \fB\*(T<\fBmax_user_text\fR\*(T>\fR \*(T<\fBbytes\fR\*(T>
234 Maximum size of user text buffer, i.e. layout below TEXT line in config file
235 (default is 16384 bytes)
238 \fB\*(T<\fBtext_buffer_size\fR\*(T>\fR \*(T<\fBbytes\fR\*(T>
239 Size of the standard text buffer (default is 1280 bytes).
242 \fB\*(T<\fBmaximum_width\fR\*(T>\fR \*(T<\fBpixels\fR\*(T>
243 Maximum width of window
246 \fB\*(T<\fBminimum_size\fR\*(T>\fR \*(T<\fBwidth (height)\fR\*(T>
247 Minimum size of window
250 \fB\*(T<\fBmpd_host\fR\*(T>\fR
254 \fB\*(T<\fBmpd_port\fR\*(T>\fR
258 \fB\*(T<\fBmpd_password\fR\*(T>\fR
262 \fB\*(T<\fBnet_avg_samples\fR\*(T>\fR
263 The number of samples to average for net data
266 \fB\*(T<\fBno_buffers\fR\*(T>\fR
267 Substract (file system) buffers from used memory?
270 \fB\*(T<\fBoverride_utf8_locale\fR\*(T>\fR
271 Force UTF8? requires XFT
274 \fB\*(T<\fBown_window\fR\*(T>\fR
275 Boolean, create own window to draw?
278 \fB\*(T<\fBown_window_class\fR\*(T>\fR
279 Manually set the WM_CLASS name. Defaults to "Conky".
282 \fB\*(T<\fBown_window_colour\fR\*(T>\fR \*(T<\fBcolour\fR\*(T>
283 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)
286 \fB\*(T<\fBown_window_hints\fR\*(T>\fR \*(T<\fBundecorated,below,above,sticky,skip_taskbar,skip_pager\fR\*(T>
287 If own_window is yes, you may use these window manager hints to affect the way Conky displays.
288 Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
289 If you use own_window_type override, window manager hints have no meaning and are ignored.
292 \fB\*(T<\fBown_window_title\fR\*(T>\fR
293 Manually set the window name. Defaults to "<hostname> - conky".
296 \fB\*(T<\fBown_window_transparent\fR\*(T>\fR
297 Boolean, set pseudo-transparency?
300 \fB\*(T<\fBown_window_type\fR\*(T>\fR
301 if own_window is yes, you may specify type normal, desktop or override (default: normal).
302 Desktop windows are special windows that have no window decorations; are always visible
303 on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
304 Override windows are not under the control of the window manager. Hints are ignored. This type
305 of window can be useful for certain situations.
308 \fB\*(T<\fBout_to_console\fR\*(T>\fR
309 Print text to stdout.
312 \fB\*(T<\fBpad_percents\fR\*(T>\fR
313 Pad percentages to this many decimals (0 = no padding)
316 \fB\*(T<\fBpop3\fR\*(T>\fR
317 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.
320 \fB\*(T<\fBstippled_borders\fR\*(T>\fR
321 Border stippling (dashing) in pixels
324 \fB\*(T<\fBtotal_run_times\fR\*(T>\fR
325 Total number of times for Conky to update before quitting. Zero makes Conky run forever
328 \fB\*(T<\fBupdate_interval\fR\*(T>\fR
329 Update interval in seconds
332 \fB\*(T<\fBuppercase\fR\*(T>\fR
333 Boolean value, if true, text is rendered in upper case
336 \fB\*(T<\fBuse_spacer\fR\*(T>\fR
337 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.
340 \fB\*(T<\fBuse_xft\fR\*(T>\fR
341 Use Xft (anti-aliased font and stuff)
344 \fB\*(T<\fBxftalpha\fR\*(T>\fR
345 Alpha of Xft font. Must be a value at or between 1 and 0.
348 \fB\*(T<\fBxftfont\fR\*(T>\fR
352 \fB\*(T<\fBTEXT\fR\*(T>\fR
353 After this begins text to be formatted on screen
356 Colors are parsed using XParsecolor(), there might be a list of them:
357 /usr/X11R6/lib/X11/rgb.txt. Also, \(lahttp://sedition.com/perl/rgb.html\(ra.
358 Color can be also in #rrggbb format (hex).
359 Note that when displaying bytes, power is 1024 and not 1000 so 1M really
360 means 1024*1024 bytes and not 1000*1000.
362 \fB\*(T<\fBaddr\fR\*(T>\fR \*(T<\fBinterface\fR\*(T>
363 IP address for an interface
366 \fB\*(T<\fBacpiacadapter\fR\*(T>\fR
367 ACPI ac adapter state.
370 \fB\*(T<\fBacpifan\fR\*(T>\fR
374 \fB\*(T<\fBacpitemp\fR\*(T>\fR
375 ACPI temperature in C.
378 \fB\*(T<\fBacpitempf\fR\*(T>\fR
379 ACPI temperature in F.
382 \fB\*(T<\fBadt746xcpu\fR\*(T>\fR
383 CPU temperature from therm_adt746x
386 \fB\*(T<\fBadt746xfan\fR\*(T>\fR
387 Fan speed from therm_adt746x
390 \fB\*(T<\fBalignr\fR\*(T>\fR \*(T<\fB(num)\fR\*(T>
391 Right-justify text, with space of N
394 \fB\*(T<\fBalignc\fR\*(T>\fR \*(T<\fB(num)\fR\*(T>
398 \fB\*(T<\fBapm_adapter\fR\*(T>\fR
399 Display APM AC adapter status (FreeBSD only)
402 \fB\*(T<\fBapm_battery_life\fR\*(T>\fR
403 Display APM battery life in percent (FreeBSD only)
406 \fB\*(T<\fBapm_battery_time\fR\*(T>\fR
407 Display remaining APM battery life in hh:mm:ss or "unknown" if
408 AC adapterstatus is on-line or charging (FreeBSD only)
411 \fB\*(T<\fBaudacious_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
415 \fB\*(T<\fBaudacious_bitrate\fR\*(T>\fR
416 Bitrate of current tune
419 \fB\*(T<\fBaudacious_channels\fR\*(T>\fR
420 Number of audio channels of current tune
423 \fB\*(T<\fBaudacious_filename\fR\*(T>\fR
424 Full path and filename of current tune
427 \fB\*(T<\fBaudacious_frequency\fR\*(T>\fR
428 Sampling frequency of current tune
431 \fB\*(T<\fBaudacious_length\fR\*(T>\fR
432 Total length of current tune as MM:SS
435 \fB\*(T<\fBaudacious_length_seconds\fR\*(T>\fR
436 Total length of current tune in seconds
439 \fB\*(T<\fBaudacious_playlist_position\fR\*(T>\fR
440 Playlist position of current tune
443 \fB\*(T<\fBaudacious_playlist_length\fR\*(T>\fR
444 Number of tunes in playlist
447 \fB\*(T<\fBaudacious_position\fR\*(T>\fR
448 Position of current tune (MM:SS)
451 \fB\*(T<\fBaudacious_position_seconds\fR\*(T>\fR
452 Position of current tune in seconds
455 \fB\*(T<\fBaudacious_status\fR\*(T>\fR
456 Player status (Playing/Paused/Stopped/Not running)
459 \fB\*(T<\fBaudacious_title\fR\*(T>\fR \*(T<\fB(max length)\fR\*(T>
460 Title of current tune with optional maximum length specifier
463 \fB\*(T<\fBbattery\fR\*(T>\fR \*(T<\fB(num)\fR\*(T>
464 Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
467 \fB\*(T<\fBbattery_time\fR\*(T>\fR \*(T<\fB(num)\fR\*(T>
468 Battery charge/discharge time remaining of ACPI battery. ACPI battery number can be given as argument (default is BAT0).
471 \fB\*(T<\fBbmpx_artist\fR\*(T>\fR
472 Artist in current BMPx track
475 \fB\*(T<\fBbmpx_album\fR\*(T>\fR
476 Album in current BMPx track
479 \fB\*(T<\fBbmpx_title\fR\*(T>\fR
480 Title of the current BMPx track
483 \fB\*(T<\fBbmpx_track\fR\*(T>\fR
484 Track number of the current BMPx track
487 \fB\*(T<\fBbmpx_bitrate\fR\*(T>\fR
488 Bitrate of the current BMPx track
491 \fB\*(T<\fBbmpx_uri\fR\*(T>\fR
492 URI of the current BMPx track
495 \fB\*(T<\fBbuffers\fR\*(T>\fR
496 Amount of memory buffered
499 \fB\*(T<\fBcached\fR\*(T>\fR
500 Amount of memory cached
503 \fB\*(T<\fBcolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T>
504 Change drawing color to color
507 \fB\*(T<\fBcpu\fR\*(T>\fR \*(T<\fB(cpuN)\fR\*(T>
508 CPU usage in percents. For SMP machines, the CPU number can be provided as an argument. ${cpu cpu0} is the total usage, and ${cpu cpuX} (X >= 1) are individual CPUs.
511 \fB\*(T<\fBcpubar\fR\*(T>\fR \*(T<\fB(cpu number) (height),(width)\fR\*(T>
512 Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
515 \fB\*(T<\fBcpugraph\fR\*(T>\fR \*(T<\fB(cpu number) (height),(width) (gradient colour 1) (gradient colour 2)\fR\*(T>
516 CPU usage graph, with optional colours in hex, minus the #. See $cpu for more info on SMP.
519 \fB\*(T<\fBdiskio\fR\*(T>\fR
520 Displays current disk IO.
523 \fB\*(T<\fBdiskiograph\fR\*(T>\fR \*(T<\fB(height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
524 Disk IO graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
527 \fB\*(T<\fBdiskio_read\fR\*(T>\fR
528 Displays current disk IO for reads.
531 \fB\*(T<\fBdiskio_readgraph\fR\*(T>\fR \*(T<\fB(height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
532 Disk IO graph for reads, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
535 \fB\*(T<\fBdiskio_write\fR\*(T>\fR
536 Displays current disk IO for writes.
539 \fB\*(T<\fBdiskio_writegraph\fR\*(T>\fR \*(T<\fB(height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
540 Disk IO graph for writes, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
543 \fB\*(T<\fBdownspeed\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
544 Download speed in kilobytes
547 \fB\*(T<\fBdownspeedf\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
548 Download speed in kilobytes with one decimal
551 \fB\*(T<\fBdownspeedgraph\fR\*(T>\fR \*(T<\fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
552 Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
555 \fB\*(T<\fBelse\fR\*(T>\fR
556 Text to show if any of the above are not true
559 \fB\*(T<\fBentropy_avail\fR\*(T>\fR
560 Current entropy available for crypto freaks
563 \fB\*(T<\fBentropy_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
564 Normalized bar of available entropy for crypto freaks
567 \fB\*(T<\fBentropy_poolsize\fR\*(T>\fR
568 Total size of system entropy pool for crypto freaks
571 \fB\*(T<\fBexec\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>
572 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.
575 \fB\*(T<\fBexecbar\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>
576 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.
579 \fB\*(T<\fBexecgraph\fR\*(T>\fR \*(T<\fBcommand\fR\*(T>
580 Same as execbar, but graphs values.
583 \fB\*(T<\fBexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
584 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
587 \fB\*(T<\fBexecibar\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
588 Same as execbar, except with an interval
591 \fB\*(T<\fBexecigraph\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
592 Same as execigraph, but takes an interval arg graphs values
595 \fB\*(T<\fBfont\fR\*(T>\fR \*(T<\fB(font)\fR\*(T>
596 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)
599 \fB\*(T<\fBfreq\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
600 Returns CPU #n's frequency in MHz. CPUs are
601 counted from 1. If omitted, the parameter
605 \fB\*(T<\fBfreq_g\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
606 Returns CPU #n's frequency in GHz. CPUs are
607 counted from 1. If omitted, the parameter
611 \fB\*(T<\fBfreq_dyn\fR\*(T>\fR
612 Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
615 \fB\*(T<\fBfreq_dyn_g\fR\*(T>\fR
616 Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
619 \fB\*(T<\fBfs_bar\fR\*(T>\fR \*(T<\fB(height),(width) fs\fR\*(T>
620 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.
623 \fB\*(T<\fBfs_free\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
624 Free space on a file system available for users.
627 \fB\*(T<\fBfs_free_perc\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
628 Free percentage of space on a file system available for users.
631 \fB\*(T<\fBfs_size\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
635 \fB\*(T<\fBfs_used\fR\*(T>\fR \*(T<\fB(fs)\fR\*(T>
636 File system used space
639 \fB\*(T<\fBgoto\fR\*(T>\fR \*(T<\fBx\fR\*(T>
640 The next element will be printed at position 'x'.
643 \fB\*(T<\fBhddtemp\fR\*(T>\fR \*(T<\fBdev, (host,(port))\fR\*(T>
644 Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
645 Default host is 127.0.0.1, default port is 7634.
648 \fB\*(T<\fBhead\fR\*(T>\fR \*(T<\fBlogfile lines (interval)\fR\*(T>
649 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.
652 \fB\*(T<\fBhr\fR\*(T>\fR \*(T<\fB(height)\fR\*(T>
653 Horizontal line, height is the height in pixels
656 \fB\*(T<\fBiconv_start\fR\*(T>\fR \*(T<\fBcodeset_from codeset_to\fR\*(T>
657 Convert text from one codeset to another using GNU iconv. Needs to be stopped with iconv_stop.
660 \fB\*(T<\fBiconv_stop\fR\*(T>\fR
661 Stop iconv codeset conversion.
664 \fB\*(T<\fBi2c\fR\*(T>\fR \*(T<\fB(dev) type n\fR\*(T>
665 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.
668 \fB\*(T<\fBi8k_ac_status\fR\*(T>\fR
669 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.
672 \fB\*(T<\fBi8k_bios\fR\*(T>\fR
673 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
676 \fB\*(T<\fBi8k_buttons_status\fR\*(T>\fR
677 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
680 \fB\*(T<\fBi8k_cpu_temp\fR\*(T>\fR
681 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
684 \fB\*(T<\fBi8k_cpu_tempf\fR\*(T>\fR
685 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Fahrenheit, as reported by /proc/i8k.
688 \fB\*(T<\fBi8k_left_fan_rpm\fR\*(T>\fR
689 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.
692 \fB\*(T<\fBi8k_left_fan_status\fR\*(T>\fR
693 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.
696 \fB\*(T<\fBi8k_right_fan_rpm\fR\*(T>\fR
697 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.
700 \fB\*(T<\fBi8k_right_fan_status\fR\*(T>\fR
701 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.
704 \fB\*(T<\fBi8k_serial\fR\*(T>\fR
705 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
708 \fB\*(T<\fBi8k_version\fR\*(T>\fR
709 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
712 \fB\*(T<\fBibm_fan\fR\*(T>\fR
713 If running the IBM ACPI, displays the fan speed.
716 \fB\*(T<\fBibm_temps\fR\*(T>\fR \*(T<\fBN\fR\*(T>
717 If running the IBM ACPI, displays the temperatures
718 from the IBM temperature sensors (N=0..7) Sensor 0 is
719 on the CPU, 3 is on the GPU.
722 \fB\*(T<\fBibm_volume\fR\*(T>\fR
723 If running the IBM ACPI, displays the "master" volume,
724 controlled by the volume keys (0-14).
727 \fB\*(T<\fBibm_brightness\fR\*(T>\fR
728 If running the IBM ACPI, displays the brigtness of the
732 \fB\*(T<\fBif_running\fR\*(T>\fR \*(T<\fB(process)\fR\*(T>
733 if PROCESS is running, display everything if_running and the matching $endif
736 \fB\*(T<\fBif_existing\fR\*(T>\fR \*(T<\fB(file)\fR\*(T>
737 if FILE exists, display everything between if_existing and the matching $endif
740 \fB\*(T<\fBif_mounted\fR\*(T>\fR \*(T<\fB(mountpoint)\fR\*(T>
741 if MOUNTPOINT is mounted, display everything between if_mounted and the matching $endif
744 \fB\*(T<\fBimap_messages\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
745 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.
748 \fB\*(T<\fBimap_unseen\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
749 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.
752 \fB\*(T<\fBkernel\fR\*(T>\fR
756 \fB\*(T<\fBlinkstatus\fR\*(T>\fR \*(T<\fBinterface\fR\*(T>
757 Get the link status for wireless connections
760 \fB\*(T<\fBloadavg\fR\*(T>\fR
761 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
764 \fB\*(T<\fBmachine\fR\*(T>\fR
765 Machine, i686 for example
768 \fB\*(T<\fBmails\fR\*(T>\fR
769 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.
772 \fB\*(T<\fBmboxscan\fR\*(T>\fR \*(T<\fB(\-n number of messages to print) (\-fw from width) (\-sw subject width) mbox\fR\*(T>
773 Print a summary of recent messages in an mbox format mailbox. mbox parameter is the filename of the mailbox (can be encapsulated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
776 \fB\*(T<\fBmem\fR\*(T>\fR
777 Amount of memory in use
780 \fB\*(T<\fBmembar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
781 Bar that shows amount of memory in use
784 \fB\*(T<\fBmemmax\fR\*(T>\fR
785 Total amount of memory
788 \fB\*(T<\fBmemperc\fR\*(T>\fR
789 Percentage of memory in use
792 \fB\*(T<\fBmpd_artist\fR\*(T>\fR
793 Artist in current MPD song must be enabled at compile
796 \fB\*(T<\fBmpd_album\fR\*(T>\fR
797 Album in current MPD song
800 \fB\*(T<\fBmpd_bar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
801 Bar of mpd's progress
804 \fB\*(T<\fBmpd_bitrate\fR\*(T>\fR
805 Bitrate of current song
808 \fB\*(T<\fBmpd_status\fR\*(T>\fR
809 Playing, stopped, et cetera.
812 \fB\*(T<\fBmpd_title\fR\*(T>\fR
813 Title of current MPD song
816 \fB\*(T<\fBmpd_vol\fR\*(T>\fR
820 \fB\*(T<\fBmpd_elapsed\fR\*(T>\fR
824 \fB\*(T<\fBmpd_length\fR\*(T>\fR
828 \fB\*(T<\fBmpd_percent\fR\*(T>\fR
829 Percent of song's progress
832 \fB\*(T<\fBmpd_random\fR\*(T>\fR
833 Random status (On/Off)
836 \fB\*(T<\fBmpd_repeat\fR\*(T>\fR
837 Repeat status (On/Off)
840 \fB\*(T<\fBmpd_track\fR\*(T>\fR
841 Prints the MPD track field
844 \fB\*(T<\fBmpd_name\fR\*(T>\fR
845 Prints the MPD name field
848 \fB\*(T<\fBmpd_file\fR\*(T>\fR
849 Prints the file name of the current MPD song
852 \fB\*(T<\fBmpd_smart\fR\*(T>\fR
853 Prints the song name in either the form "artist - title" or file name, depending on whats available
856 \fB\*(T<\fBnew_mails\fR\*(T>\fR
857 Unread mail count in mail spool.
860 \fB\*(T<\fBnodename\fR\*(T>\fR
864 \fB\*(T<\fBoutlinecolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T>
868 \fB\*(T<\fBpb_battery\fR\*(T>\fR \*(T<\fBitem\fR\*(T>
869 If running on Apple powerbook/ibook, display
870 information on battery status. The item parameter
871 specifies, what information to display. Exactly one item
872 must be specified. Valid items are:
875 Display if battery is fully charged, charging,
876 discharging or absent (running on AC)
879 Display charge of battery in percent, if
880 charging or discharging. Nothing will be
881 displayed, if battery is fully charged
885 Display the time remaining until the battery
886 will be fully charged or discharged at current
887 rate. Nothing is displayed, if battery is
888 absent or if it's present but fully charged
892 \fB\*(T<\fBpop3_unseen\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
893 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.
896 \fB\*(T<\fBpop3_used\fR\*(T>\fR \*(T<\fB(args)\fR\*(T>
897 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.
900 \fB\*(T<\fBpre_exec\fR\*(T>\fR \*(T<\fBshell command\fR\*(T>
901 Executes a shell command one time before conky displays anything and puts output as text.
904 \fB\*(T<\fBprocesses\fR\*(T>\fR
905 Total processes (sleeping and running)
908 \fB\*(T<\fBrunning_processes\fR\*(T>\fR
909 Running processes (not sleeping), requires Linux 2.6
912 \fB\*(T<\fBshadecolor\fR\*(T>\fR \*(T<\fB(color)\fR\*(T>
916 \fB\*(T<\fBstippled_hr\fR\*(T>\fR \*(T<\fB(space)\fR\*(T>
917 Stippled (dashed) horizontal line
920 \fB\*(T<\fBswapbar\fR\*(T>\fR \*(T<\fB(height),(width)\fR\*(T>
921 Bar that shows amount of swap in use
924 \fB\*(T<\fBswap\fR\*(T>\fR
925 Amount of swap in use
928 \fB\*(T<\fBswapmax\fR\*(T>\fR
932 \fB\*(T<\fBswapperc\fR\*(T>\fR
933 Percentage of swap in use
936 \fB\*(T<\fBsysname\fR\*(T>\fR
937 System name, Linux for example
940 \fB\*(T<\fBtcp_portmon\fR\*(T>\fR \*(T<\fBport_begin port_end item (index)\fR\*(T> \fI(ip4 only at present)\fR
941 TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
943 \fBcount\fR - total number of connections in the range
945 \fBrip\fR - remote ip address
947 \fBrhost\fR - remote host name
949 \fBrport\fR - remote port number
951 \fBrservice\fR - remote service name from /etc/services
953 \fBlip\fR - local ip address
955 \fBlhost\fR - local host name
957 \fBlport\fR - local port number
959 \fBlservice\fR - local service name from /etc/services
961 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.
965 \fB${tcp_portmon 6881 6999 count}\fR -
966 displays the number of connections in the bittorrent port range
968 \fB${tcp_portmon 22 22 rip 0}\fR -
969 displays the remote host ip of the first sshd connection
971 \fB${tcp_portmon 22 22 rip 9}\fR -
972 displays the remote host ip of the tenth sshd connection
974 \fB${tcp_portmon 1 1024 rhost 0}\fR -
975 displays the remote host name of the first connection on a privileged port
977 \fB${tcp_portmon 1 1024 rport 4}\fR -
978 displays the remote host port of the fifth connection on a privileged port
980 \fB${tcp_portmon 1 65535 lservice 14}\fR -
981 displays the local service name of the fifteenth connection in the range of all ports
983 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.
985 \fB\*(T<\fBtexeci\fR\*(T>\fR \*(T<\fBinterval command\fR\*(T>
986 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.
989 \fB\*(T<\fBoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T>
990 Move text over by N pixels. See also $voffset.
993 \fB\*(T<\fBtab\fR\*(T>\fR \*(T<\fB(width, (start))\fR\*(T>
994 Puts a tab of the specified width, starting from column 'start'.
997 \fB\*(T<\fBtail\fR\*(T>\fR \*(T<\fBlogfile lines (interval)\fR\*(T>
998 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.
1001 \fB\*(T<\fBtime\fR\*(T>\fR \*(T<\fB(format)\fR\*(T>
1002 Local time, see man strftime to get more information about format
1005 \fB\*(T<\fButime\fR\*(T>\fR \*(T<\fB(format)\fR\*(T>
1006 Display time in UTC (universal coordinate time).
1009 \fB\*(T<\fBtztime\fR\*(T>\fR \*(T<\fB(timezone) (format)\fR\*(T>
1010 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.
1013 \fB\*(T<\fBtotaldown\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
1014 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.
1017 \fB\*(T<\fBtop\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T>
1018 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.
1021 \fB\*(T<\fBtop_mem\fR\*(T>\fR \*(T<\fBtype, num\fR\*(T>
1022 Same as top, except sorted by mem usage instead of cpu
1025 \fB\*(T<\fBtotalup\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
1026 Total upload, this one too, may overflow
1029 \fB\*(T<\fBupdates\fR\*(T>\fR \*(T<\fBNumber of updates\fR\*(T>
1033 \fB\*(T<\fBupspeed\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
1034 Upload speed in kilobytes
1037 \fB\*(T<\fBupspeedf\fR\*(T>\fR \*(T<\fBnet\fR\*(T>
1038 Upload speed in kilobytes with one decimal
1041 \fB\*(T<\fBupspeedgraph\fR\*(T>\fR \*(T<\fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR\*(T>
1042 Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
1045 \fB\*(T<\fBuptime\fR\*(T>\fR
1049 \fB\*(T<\fBuptime_short\fR\*(T>\fR
1050 Uptime in a shorter format
1053 \fB\*(T<\fBvoffset\fR\*(T>\fR \*(T<\fB(pixels)\fR\*(T>
1054 Change vertical offset by N pixels. Negative values will cause text to overlap. See also $offset.
1057 \fB\*(T<\fBvoltage_mv\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
1058 Returns CPU #n's voltage in mV. CPUs are
1059 counted from 1. If omitted, the parameter
1063 \fB\*(T<\fBvoltage_v\fR\*(T>\fR \*(T<\fB(n)\fR\*(T>
1064 Returns CPU #n's voltage in V. CPUs are
1065 counted from 1. If omitted, the parameter
1070 \*(T<conky \*(T>\*(T<\fB\-t '${time %D %H:%m}' \-o \-u 30\fR\*(T>
1071 Start Conky in its own window with date and clock as text and 30 sec update interval.
1073 \*(T<conky \*(T>\*(T<\fB\-a top_left \-x 5 \-y 500 \-d\fR\*(T>
1074 Start Conky to background at coordinates (5, 500).
1076 \*(T<\fI~/.conkyrc\fR\*(T> default configuration file
1078 Drawing to root or some other desktop window directly doesn't work with
1079 all window managers. Especially doesn't work well with Gnome and it has
1080 been reported that it doesn't work with KDE either. Nautilus can be
1081 disabled from drawing to desktop with program gconf-editor. Uncheck
1082 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky
1083 to set some specific window id. You might find xwininfo -tree useful to
1084 find the window to draw to. You can also use -o argument which makes
1085 Conky to create its own window.
1087 \(lahttp://conky.sourceforge.net\(ra
1089 \(lahttp://www.sourceforge.net/projects/conky\(ra
1091 #conky on irc.freenode.net
1093 The Conky dev team. What's up now!