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 Svn.
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 Svn\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 \-\-enable\-xmms \-\-enable\-bmp \-\-enable\-audacious \-\-enable\-infopipe \-\-enable\-bmpx \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?
174 \fBdraw_graph_borders\fR
175 Draw borders around graphs?
187 Font name in X, xfontsel can be used to get a nice font
191 Gap between right or left border of screen, same as passing -x at command line
195 Gap between top or bottom border of screen, same as passing -y at command line
199 Substract (file system) buffers from used memory?
203 Mail spool for mail checking
206 \fBmaximum_width\fR \fBpixels\fR
207 Maximum width of window
210 \fBminimum_size\fR \fBwidth (height)\fR
211 Minimum size of window
214 \fBmin_port_monitors\fR
215 Allow for the creation of at least this number of port monitors (if 0 or not set, default is 16)
218 \fBmin_port_monitor_connections\fR
219 Allow each port monitor to track at least this many connections (if 0 or not set, default is 256)
222 \fBmldonkey_hostname\fR
223 Hostname for mldonkey stuff, defaults to localhost
227 Mldonkey port, 4001 default
231 Mldonkey login, default none
234 \fBmldonkey_password\fR
235 Mldonkey password, default none
250 \fBnet_avg_samples\fR
251 The number of samples to average for net data
254 \fBoverride_utf8_locale\fR
255 Force UTF8? requires XFT
259 Boolean, create own window to draw?
262 \fBown_window_transparent\fR
263 Boolean, set pseudo-transparency?
266 \fBown_window_type\fR
267 if own_window is yes, you may specify type normal, desktop or override (default: normal).
268 Desktop windows are special windows that have no window decorations; are always visible
269 on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
270 Override windows are not under the control of the window manager. Hints are ignored. This type
271 of window can be useful for certain situations.
274 \fBown_window_colour\fR \fBcolour\fR
275 If own_window_transparent no, set a specified background colour (defaults to black). Takes either a hex value (#ffffff) or a valid RGB name (see /usr/lib/X11/rgb.txt)
278 \fBown_window_hints\fR \fBundecorated,below,above,sticky,skip_taskbar,skip_pager\fR
279 If own_window is yes, you may use these window manager hints to affect the way conky displays.
280 Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
281 If you use own_window_type override, window manager hints have no meaning and are ignored.
285 Print text to stdout.
289 Pad percentages to this many decimals (0 = no padding)
292 \fBstippled_borders\fR
293 Border stippling (dashing) in pixels
296 \fBtotal_run_times\fR
297 Total number of times for Conky to update before quitting. Zero makes Conky run forever
300 \fBupdate_interval\fR
301 Update interval in seconds
305 Boolean value, if true, text is rendered in upper case
309 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.
313 Use Xft (anti-aliased font and stuff)
317 Manually set the WM_CLASS name. Defaults to "conky".
321 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.
325 After this begins text to be formatted on screen
328 Colors are parsed using XParsecolor(), there might be a list of them:
329 /usr/X11R6/lib/X11/rgb.txt. Also,
330 http://sedition.com/perl/rgb.html [http://sedition.com/perl/rgb.html].
331 Color can be also in #rrggbb format (hex).
332 Note that when displaying bytes, power is 1024 and not 1000 so 1M really
333 means 1024*1024 bytes and not 1000*1000.
335 \fBaddr\fR \fBinterface\fR
336 IP address for an interface
340 ACPI ac adapter state.
348 ACPI temperature in C.
352 ACPI temperature in F.
356 CPU temperature from therm_adt746x
360 Fan speed from therm_adt746x
363 \fBalignr\fR \fB(num)\fR
364 Right-justify text, with space of N
367 \fBalignc\fR \fB(num)\fR
372 Display APM AC adapter status (FreeBSD only)
375 \fBapm_battery_life\fR
376 Display APM battery life in percent (FreeBSD only)
379 \fBapm_battery_time\fR
380 Display remaining APM battery life in hh:mm:ss or "unknown" if
381 AC adapterstatus is on-line or charging (FreeBSD only)
384 \fBbattery\fR \fB(num)\fR
385 Remaining capacity in ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
389 Artist in current BMPx track
393 Album in current BMPx track
397 Title of the current BMPx track
401 Track number of the current BMPx track
405 Bitrate of the current BMPx track
409 URI of the current BMPx track
413 Amount of memory buffered
417 Amount of memory cached
420 \fBcolor\fR \fB(color)\fR
421 Change drawing color to color
424 \fBcpu\fR \fB(cpuN)\fR
425 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.
428 \fBcpubar\fR \fB(cpu number) (height),(width)\fR
429 Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
432 \fBcpugraph\fR \fB(cpu number) (height),(width) (gradient colour 1) (gradient colour 2)\fR
433 CPU usage graph, with optional colours in hex, minus the #. See $cpu for more info on SMP.
437 Displays current disk IO.
440 \fBdiskiograph\fR \fB(height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR
441 Disk IO graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
444 \fBdownspeed\fR \fBnet\fR
445 Download speed in kilobytes
448 \fBdownspeedf\fR \fBnet\fR
449 Download speed in kilobytes with one decimal
452 \fBdownspeedgraph\fR \fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR
453 Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
457 Text to show if any of the above are not true
460 \fBexec\fR \fBcommand\fR
461 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.
464 \fBexecbar\fR \fBcommand\fR
465 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.
468 \fBexecgraph\fR \fBcommand\fR
469 Same as execbar, but graphs values.
472 \fBexeci\fR \fBinterval command\fR
473 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
476 \fBexecibar\fR \fBinterval command\fR
477 Same as execbar, except with an interval
480 \fBexecigraph\fR \fBinterval command\fR
481 Same as execigraph, but takes an interval arg graphs values
484 \fBfont\fR \fBfont\fR
485 Specify a different font. Only applies to one line.
489 Returns CPU frequency in MHz
493 Returns CPU frequency in GHz
497 Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
501 Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
504 \fBfs_bar\fR \fB(height),(width) fs\fR
505 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.
508 \fBfs_free\fR \fB(fs)\fR
509 Free space on a file system available for users.
512 \fBfs_free_perc\fR \fB(fs)\fR
513 Free percentage of space on a file system available for users.
516 \fBfs_size\fR \fB(fs)\fR
520 \fBfs_used\fR \fB(fs)\fR
521 File system used space
524 \fBhead\fR \fBlogfile lines (interval)\fR
525 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.
528 \fBhr\fR \fB(height)\fR
529 Horizontal line, height is the height in pixels
532 \fBi2c\fR \fB(dev) type n\fR
533 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.
536 \fBi8k_ac_status\fR \fB\fR
537 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.
540 \fBi8k_bios\fR \fB\fR
541 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
544 \fBi8k_buttons_status\fR \fB\fR
545 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
548 \fBi8k_cpu_temp\fR \fB\fR
549 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
552 \fBi8k_cpu_tempf\fR \fB\fR
553 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Farenheit, as reported by /proc/i8k.
556 \fBi8k_left_fan_rpm\fR \fB\fR
557 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.
560 \fBi8k_left_fan_status\fR \fB\fR
561 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.
564 \fBi8k_right_fan_rpm\fR \fB\fR
565 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.
568 \fBi8k_right_fan_status\fR \fB\fR
569 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.
572 \fBi8k_serial\fR \fB\fR
573 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
576 \fBi8k_version\fR \fB\fR
577 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
580 \fBif_running\fR \fB(process)\fR
581 if PROCESS is running, display everything if_running and the matching $endif
584 \fBif_existing\fR \fB(file)\fR
585 if FILE exists, display everything between if_existing and the matching $endif
588 \fBif_mounted\fR \fB(mountpoint)\fR
589 if MOUNTPOINT is mounted, display everything between if_mounted and the matching $endif
596 \fBlinkstatus\fR \fBinterface\fR
597 Get the link status for wireless connections
601 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
605 Machine, i686 for example
609 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.
613 Amount of memory in use
616 \fBmembar\fR \fB(height),(width)\fR
617 Bar that shows amount of memory in use
621 Total amount of memory
625 Percentage of memory in use
629 Artist in current MPD song must be enabled at compile
633 Album in current MPD song
636 \fBmpd_bar\fR \fB(height),(width)\fR
637 Bar of mpd's progress
641 Bitrate of current song
645 Playing, stopped, et cetera.
649 Title of current MPD song
665 Percent of song's progress
669 Random status (On/Off)
673 Repeat status (On/Off)
677 Prints the MPD track field
681 Prints the MPD name field
685 Prints the file name of the current MPD song
689 Prints the song name in either the form "artist - title" or file name, depending on whats available
693 Unread mail count in mail spool.
700 \fBoutlinecolor\fR \fB(color)\fR
704 \fBpre_exec\fR \fBshell command\fR
705 Executes a shell command one time before conky displays anything and puts output as text.
709 Total processes (sleeping and running)
712 \fBrunning_processes\fR
713 Running processes (not sleeping), requires Linux 2.6
716 \fBshadecolor\fR \fB(color)\fR
720 \fBstippled_hr\fR \fB(space)\fR
721 Stippled (dashed) horizontal line
724 \fBswapbar\fR \fB(height),(width)\fR
725 Bar that shows amount of swap in use
729 Amount of swap in use
737 Percentage of swap in use
741 System name, Linux for example
744 \fBtcp_portmon\fR \fBport_begin port_end item (index)\fR \fI(ip4 only at present)\fR
745 TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
747 count - total number of connections in the range
749 rip - remote ip address
751 rhost - remote host name
753 rport - remote port number
755 rservice - remote service name from /etc/services
757 lip - local ip address
759 lhost - local host name
761 lport - local port number
763 lservice - local service name from /etc/services
765 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.
769 ${tcp_portmon 6881 6999 count} -
770 displays the number of connections in the bittorrent port range
772 ${tcp_portmon 22 22 rip 0} -
773 displays the remote host ip of the first sshd connection
775 ${tcp_portmon 22 22 rip 9} -
776 displays the remote host ip of the tenth sshd connection
778 ${tcp_portmon 1 1024 rhost 0} -
779 displays the remote host name of the first connection on a privileged port
781 ${tcp_portmon 1 1024 rport 4} -
782 displays the remote host port of the fifth connection on a privileged port
784 ${tcp_portmon 1 65535 lservice 14} -
785 displays the local service name of the fifteenth connection in the range of all ports
787 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.
789 \fBtexeci\fR \fBinterval command\fR
790 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.
793 \fBoffset\fR \fB(pixels)\fR
794 Move text over by N pixels. See also $voffset.
797 \fBtail\fR \fBlogfile lines (interval)\fR
798 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.
801 \fBtime\fR \fB(format)\fR
802 Local time, see man strftime to get more information about format
805 \fBtotaldown\fR \fBnet\fR
806 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.
809 \fBtop\fR \fBtype, num\fR
810 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.
813 \fBtop_mem\fR \fBtype, num\fR
814 Same as top, except sorted by mem usage instead of cpu
817 \fBtotalup\fR \fBnet\fR
818 Total upload, this one too, may overflow
821 \fBupdates\fR \fBNumber of updates\fR
825 \fBupspeed\fR \fBnet\fR
826 Upload speed in kilobytes
829 \fBupspeedf\fR \fBnet\fR
830 Upload speed in kilobytes with one decimal
833 \fBupspeedgraph\fR \fBnet (height),(width) (gradient colour 1) (gradient colour 2) (scale)\fR
834 Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
842 Uptime in a shorter format
846 Seti@home current progress
849 \fBseti_progbar\fR \fB(height),(width)\fR
850 Seti@home current progress bar
854 Seti@home total user credit
857 \fBvoffset\fR \fB(pixels)\fR
858 Change vertical offset by N pixels. Negative values will cause text to overlap. See also $offset.
861 \fBxmms_bar\fR \fB(height),(width)\fR
862 xmms / bmp / audacious / infopipe: progress bar
866 xmms / bmp / audacious / infopipe: bitrate of current tune
870 xmms / bmp / audacious / infopipe: number of audio channels of current tune
874 xmms / bmp / audacious / infopipe: full path and filename of current tune
878 xmms / bmp / audacious / infopipe: sampling frequency of current tune
882 xmms / bmp / audacious / infopipe: total length of current tune as MM:SS
885 \fBxmms_length_seconds\fR
886 xmms / bmp / audacious / infopipe: total length of current tune in seconds
889 \fBxmms_playlist_position\fR
890 xmms / bmp / audacious / infopipe: playlist position of current tune
893 \fBxmms_playlist_length\fR
894 xmms / bmp / audacious / infopipe: number of tunes in playlist
898 xmms / bmp / audacious / infopipe: MM:SS position of current tune
901 \fBxmms_position_seconds\fR
902 xmms / bmp / audacious / infopipe: position of current tune in seconds
906 xmms / bmp / audacious / infopipe: player status (Playing/Paused/Stopped/Not running)
910 xmms / bmp / audacious / infopipe: title of current tune
914 conky \fB\-t '${time %D %H:%m}' \-o \-u 30\fR
915 Start Conky in its own window with date and clock as text and 30 sec update interval.
917 conky \fB\-a top_left \-x 5 \-y 500 \-d\fR
918 Start Conky to background at coordinates (5, 500).
920 \fB~/.conkyrc\fR default configuration file
922 Drawing to root or some other desktop window directly doesn't work with
923 all window managers. Especially doesn't work well with Gnome and it has
924 been reported that it doesn't work with KDE either. Nautilus can be
925 disabled from drawing to desktop with program gconf-editor. Uncheck
926 show_desktop in /apps/nautilus/preferences/. There is -w switch in Conky
927 to set some specific window id. You might find xwininfo -tree useful to
928 find the window to draw to. You can also use -o argument which makes
929 Conky to create its own window.
931 http://conky.sourceforge.net [http://conky.sourceforge.net]
933 http://www.sourceforge.net/projects/conky [http://www.sourceforge.net/projects/conky]
935 #conky on irc.freenode.net
937 The Conky dev team. What's up now!