1 .\" -*- coding: us-ascii -*-
4 conky \- A system monitor for X originally based on the torsmo code, but more kickass. It just keeps on given'er. Yeah.
8 .if (\nxu > (\n(.lu / 2)) .nr x (\n(.lu / 5)
14 Conky is a system monitor for X originally based on the torsmo code.
15 Since it's original conception, Conky has changed a fair bit from it's predecessor.
16 Conky can display just about anything, either on your root desktop or in it's own window.
17 Conky has many built-in objects, as well as the ability to execute programs and scripts,
18 then display the output from stdout.
20 We are always looking for help, and anyone interested in becoming a developer is welcome.
21 Please use the facilities at SourceForge to make bug reports, feature requests, and submit patches.
23 Thanks for your interest in Conky.
25 For users compiling from source, make sure you have the X development libraries installed.
26 This should be a package along the lines of "libx11-dev or xorg-x11-dev".
28 Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-admin/conky" for installation.
29 There is also usually an up-to-date ebuild within Conky's package or in CVS.
31 Debian,etc. users -- Conky will be in Debian's repositories soon (by mid-September, hopefully), and then
32 Ubuntu shortly thereafter. Until then, "dpkg -i" the .deb package to install.
34 Example to compile and run Conky with all optional components (note that some configure options may differ for your system):
36 \fBsh autogen.sh\fR \fB# Only required if building from CVS\fR
38 \fB\&./configure \fR\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\fR
42 \fBmake install\fR \fB# Optional\fR
46 Conky probably doesn't compile with compilers other than gcc and icc.
47 It doesn't compile with C89 compiler and not even with pure C99.
48 It uses a few things that might not exist: strdup(), strcasecmp(), strncasecmp(),
49 optarg variable with getopt() and long long (not in C89). Crashes in file system
50 statistics stuff when compiled with icc, I don't know exactly why.
52 You can disable 'drawing to own window' feature in case you don't need it by passing
53 --disable-own-window to configure -script.
56 Conky is generally very good on resources. However, certain objects in
57 Conky are harder on resources then others. In particular, the $tail,
58 $top, $font, and $graph objects are quite costly in comparison to the rest of Conky.
60 If you do use them, please do not complain about memory or CPU usage,
61 unless you think something's seriously wrong (mem leak, etc.).
63 An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1 conky".
64 Saves you the trouble of having to kill and then restart.
66 IMPORTANT: For previous Conky users, Conky 1.3 no longer supports the metar stuff.
67 mdsplib was causing way too many problems. Hopefully there'll be a better solution in Conky 2.x...
69 Command line options override configurations defined in configuration file.
72 Prints version and exits
75 \fB\-a \fR\fBALIGNMENT\fR
76 Text alignment on screen, {top,bottom}_{left,right} or none
80 Use double buffering (eliminates "flicker")
84 Config file to load instead of $HOME/.conkyrc
88 Daemonize Conky, aka fork to background
96 Prints command line help and exits
100 Create own window to draw
104 Text to render, remember single quotes, like -t ' $uptime '
107 \fB\-u \fR\fBSECONDS\fR
111 \fB\-w \fR\fBWIN_ID\fR
115 \fB\-x \fR\fBX_COORDINATE\fR
119 \fB\-y \fR\fBY_COORDINATE\fR
122 .SH "CONFIGURATION SETTINGS"
123 Default configuration file is $HOME/.conkyrc (can be changed from
124 conky.c among other things). See conkyrc.sample. If installing from Debian package,
125 this should be in /usr/share/doc/conky/examples ("gunzip conkyrc.sample.gz" to get conkyrc.sample).
127 You might want to copy it to $HOME/.conkyrc and then start modifying it.
128 Other configs can be found at http://conky.sf.net
131 Aligned position on screen, may be top_left, top_right, bottom_left, bottom_right, or none
135 Boolean value, if true, Conky will be forked to background when started
139 Set conky on the bottom of all other applications
143 Border margin in pixels
147 Border width in pixels
150 \fBcpu_avg_samples\fR
151 The number of samples to average for CPU monitoring
155 Default color and border color
158 \fBdefault_shade_color\fR
159 Default shading color and border's shading color
162 \fBdefault_outline_color\fR
163 Default outline color
167 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.
171 Draw borders around text?
183 Font name in X, xfontsel can be used to get a nice font
187 Gap between right or left border of screen, same as passing -x at command line
191 Gap between top or bottom border of screen, same as passing -y at command line
195 Substract (file system) buffers from used memory?
199 Mail spool for mail checking
202 \fBmaximum_width\fR \fBpixels\fR
203 Maximum width of window
206 \fBminimum_size\fR \fBwidth (height)\fR
207 Minimum size of window
210 \fBmldonkey_hostname\fR
211 Hostname for mldonkey stuff, defaults to localhost
215 Mldonkey port, 4001 default
219 Mldonkey login, default none
222 \fBmldonkey_password\fR
223 Mldonkey password, default none
238 \fBnet_avg_samples\fR
239 The number of samples to average for net data
242 \fBoverride_utf8_locale\fR
243 Force UTF8? requires XFT
247 Boolean, create own window to draw?
250 \fBown_window_transparent\fR
251 Boolean, set pseudo-transparency?
254 \fBown_window_colour\fR \fBcolour\fR
255 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)
259 Print text to stdout.
263 Pad percentages to this many decimals (0 = no padding)
266 \fBstippled_borders\fR
267 Border stippling (dashing) in pixels
270 \fBtotal_run_times\fR
271 Total number of times for Conky to update before quitting. Zero makes Conky run forever
274 \fBupdate_interval\fR
275 Update interval in seconds
279 Boolean value, if true, text is rendered in upper case
283 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.
287 Use Xft (anti-aliased font and stuff)
290 \fBmin_port_monitors\fR
291 Allow for the creation of at least this number of port monitors (if 0 or not set, default is 16)
294 \fBmin_port_monitor_connections\fR
295 Allow each port monitor to track at least this many connections (if 0 or not set, default is 256)
299 After this begins text to be formatted on screen
302 Colors are parsed using XParsecolor(), there might be a list of them:
303 /usr/X11R6/lib/X11/rgb.txt. Also,
304 http://sedition.com/perl/rgb.html [http://sedition.com/perl/rgb.html].
305 Color can be also in #rrggbb format (hex).
306 Note that when displaying bytes, power is 1024 and not 1000 so 1M really
307 means 1024*1024 bytes and not 1000*1000.
309 \fBaddr\fR \fBinterface\fR
310 IP address for an interface
314 ACPI ac adapter state.
322 ACPI temperature in C.
326 ACPI temperature in F.
330 CPU temperature from therm_adt746x
334 Fan speed from therm_adt746x
337 \fBalignr\fR \fB(num)\fR
338 Right-justify text, with space of N
341 \fBalignc\fR \fB(num)\fR
346 Display APM AC adapter status (FreeBSD only)
349 \fBapm_battery_life\fR
350 Display APM battery life in percent (FreeBSD only)
353 \fBapm_battery_time\fR
354 Display remaining APM battery life in hh:mm:ss or "unknown" if
355 AC adapterstatus is on-line or charging (FreeBSD only)
358 \fBbattery\fR \fB(num)\fR
359 Remaining capacity in ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
363 Artist in current BMPx track
367 Album in current BMPx track
371 Title of the current BMPx track
375 Track number of the current BMPx track
379 Bitrate of the current BMPx track
383 URI of the current BMPx track
387 Amount of memory buffered
391 Amount of memory cached
394 \fBcolor\fR \fB(color)\fR
395 Change drawing color to color
398 \fBcpu\fR \fB(cpuN)\fR
399 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.
402 \fBcpubar\fR \fB(cpu number) (height),(width)\fR
403 Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
406 \fBcpugraph\fR \fB(cpu number) (height),(width) (gradient colour 1) (gradient colour 2)\fR
407 CPU usage graph, with optional colours in hex, minus the #. See $cpu for more info on SMP.
411 Displays current disk IO.
414 \fBdiskiograph\fR \fB(height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR
415 Disk IO graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
418 \fBdownspeed\fR \fBnet\fR
419 Download speed in kilobytes
422 \fBdownspeedf\fR \fBnet\fR
423 Download speed in kilobytes with one decimal
426 \fBdownspeedgraph\fR \fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR
427 Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
431 Text to show if any of the above are not true
434 \fBexec\fR \fBcommand\fR
435 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.
438 \fBexecbar\fR \fBcommand\fR
439 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.
442 \fBexecgraph\fR \fBcommand\fR
443 Same as execbar, but graphs values.
446 \fBexeci\fR \fBinterval command\fR
447 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
450 \fBexecibar\fR \fBinterval command\fR
451 Same as execbar, except with an interval
454 \fBexecigraph\fR \fBinterval command\fR
455 Same as execigraph, but takes an interval arg graphs values
458 \fBfont\fR \fBfont\fR
459 Specify a different font. Only applies to one line.
463 Returns CPU frequency in MHz
467 Returns CPU frequency in GHz
471 Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
475 Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
478 \fBfs_bar\fR \fB(height),(width) fs\fR
479 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.
482 \fBfs_free\fR \fB(fs)\fR
483 Free space on a file system available for users.
486 \fBfs_free_perc\fR \fB(fs)\fR
487 Free percentage of space on a file system available for users.
490 \fBfs_size\fR \fB(fs)\fR
494 \fBfs_used\fR \fB(fs)\fR
495 File system used space
498 \fBhead\fR \fBlogfile lines (interval)\fR
499 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.
502 \fBhr\fR \fB(height)\fR
503 Horizontal line, height is the height in pixels
506 \fBi2c\fR \fB(dev), type, n\fR
507 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.
510 \fBi8k_ac_status\fR \fB\fR
511 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.
514 \fBi8k_bios\fR \fB\fR
515 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
518 \fBi8k_buttons_status\fR \fB\fR
519 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
522 \fBi8k_cpu_temp\fR \fB\fR
523 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in celsius, as reported by /proc/i8k.
526 \fBi8k_cpu_tempf\fR \fB\fR
527 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in farenheit, as reported by /proc/i8k.
530 \fBi8k_left_fan_rpm\fR \fB\fR
531 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.
534 \fBi8k_left_fan_status\fR \fB\fR
535 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.
538 \fBi8k_right_fan_rpm\fR \fB\fR
539 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.
542 \fBi8k_right_fan_status\fR \fB\fR
543 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.
546 \fBi8k_serial\fR \fB\fR
547 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
550 \fBi8k_version\fR \fB\fR
551 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
554 \fBif_running\fR \fB(process)\fR
555 if PROCESS is running, display everything if_running and the matching $endif
558 \fBif_existing\fR \fB(file)\fR
559 if FILE exists, display everything between if_existing and the matching $endif
562 \fBif_mounted\fR \fB(mountpoint)\fR
563 if MOUNTPOINT is mounted, display everything between if_mounted and the matching $endif
570 \fBlinkstatus\fR \fBinterface\fR
571 Get the link status for wireless connections
575 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
579 Machine, i686 for example
583 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.
587 Amount of memory in use
590 \fBmembar\fR \fB(height),(width)\fR
591 Bar that shows amount of memory in use
595 Total amount of memory
599 Percentage of memory in use
603 Artist in current MPD song must be enabled at compile
607 Album in current MPD song
610 \fBmpd_bar\fR \fB(height),(width)\fR
611 Bar of mpd's progress
615 Bitrate of current song
619 Playing, stopped, et cetera.
623 Title of current MPD song
639 Percent of song's progress
643 Random status (On/Off)
647 Repeat status (On/Off)
651 Prints the MPD track field
655 Unread mail count in mail spool.
662 \fBoutlinecolor\fR \fB(color)\fR
666 \fBpre_exec\fR \fBshell command\fR
667 Executes a shell command one time before conky displays anything and puts output as text.
671 Total processes (sleeping and running)
674 \fBrunning_processes\fR
675 Running processes (not sleeping), requires Linux 2.6
678 \fBshadecolor\fR \fB(color)\fR
682 \fBstippled_hr\fR \fB(space)\fR
683 Stippled (dashed) horizontal line
686 \fBswapbar\fR \fB(height),(width)\fR
687 Bar that shows amount of swap in use
691 Amount of swap in use
699 Percentage of swap in use
703 System name, Linux for example
706 \fBtcp_portmon\fR \fBport_begin port_end item (index)\fR \fI(ip4 only at present)\fR
707 TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
709 count - total number of connections in the range
711 rip - remote ip address
713 rhost - remote host name
715 rport - remote port number
717 lip - local ip address
719 lhost - local host name
721 lservice - local service name from /etc/services
723 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.
727 ${tcp_portmon 6881 6999 count} -
728 displays the number of connections in the bittorrent port range
730 ${tcp_portmon 22 22 rip 0} -
731 displays the remote host ip of the first sshd connection
733 ${tcp_portmon 22 22 rip 9} -
734 displays the remote host ip of the tenth sshd connection
736 ${tcp_portmon 1 1024 rhost 0} -
737 displays the remote host name of the first connection on a privileged port
739 ${tcp_portmon 1 1024 rport 4} -
740 displays the remote host port of the fifth connection on a privileged port
742 ${tcp_portmon 1 65535 lservice 14} -
743 displays the local service name of the fifteenth connection in the range of all ports
745 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.
747 \fBtexeci\fR \fBinterval command\fR
748 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.
751 \fBoffset\fR \fB(pixels)\fR
752 Move text over by N pixels. See also $voffset.
755 \fBtail\fR \fBlogfile lines (interval)\fR
756 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.
759 \fBtime\fR \fB(format)\fR
760 Local time, see man strftime to get more information about format
763 \fBtotaldown\fR \fBnet\fR
764 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.
767 \fBtop\fR \fBtype, num\fR
768 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.
771 \fBtop_mem\fR \fBtype, num\fR
772 Same as top, except sorted by mem usage instead of cpu
775 \fBtotalup\fR \fBnet\fR
776 Total upload, this one too, may overflow
779 \fBupdates\fR \fBNumber of updates\fR
783 \fBupspeed\fR \fBnet\fR
784 Upload speed in kilobytes
787 \fBupspeedf\fR \fBnet\fR
788 Upload speed in kilobytes with one decimal
791 \fBupspeedgraph\fR \fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR
792 Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
800 Uptime in a shorter format
804 Seti@home current progress
807 \fBseti_progbar\fR \fB(height),(width)\fR
808 Seti@home current progress bar
812 Seti@home total user credit
815 \fBvoffset\fR \fB(pixels)\fR
816 Change verticle offset by N pixels. Negative values will cause text to overlap. See also $offset.
820 conky \fB\-t '${time %D %H:%m}' \-o \-u 30\fR
821 Start Conky in its own window with date and clock as text and 30 sec update interval.
823 conky \fB\-a top_left \-x 5 \-y 500 \-d\fR
824 Start Conky to background at coordinates (5, 500).
826 \fB~/.conkyrc\fR default configuration file
828 Drawing to root or some other desktop window directly doesn't work with
829 all window managers. Especially doesn't work well with Gnome and it has
830 been reported that it doesn't work with KDE either. Nautilus can be
831 disabled from drawing to desktop with program gconf-editor. Uncheck
832 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky
833 to set some specific window id. You might find xwininfo -tree useful to
834 find the window to draw to. You can also use -o argument which makes
835 Conky to create its own window.
837 http://conky.sourceforge.net [http://conky.sourceforge.net]
839 http://www.sourceforge.net/projects/conky [http://www.sourceforge.net/projects/conky]
841 #conky on irc.freenode.net
843 The Conky dev team. What's up now!