6 conky - A system monitor for X originally based on the torsmo code, but
7 more kickass. It just keeps on givener. Yeah.
13 Conky is a system monitor for X originally based on the torsmo code.
14 Since its original conception, Conky has changed a fair bit from its
15 predecessor. Conky can display just about anything, either on your
16 root desktop or in its own window. Conky has many built-in objects,
17 as well as the ability to execute programs and scripts, then display
18 the output from stdout.
20 We are always looking for help, and anyone interested in becoming a
21 developer is welcome. Please use the facilities at SourceForge to make
22 bug reports, feature requests, and submit patches.
24 Thanks for your interest in Conky.
27 First, make sure you have the X development libraries installed, this
28 should be a package along the lines of "libx11-dev or xorg-x11-dev".
29 Gentoo users, Conky is in Gentoos Portage. Simply use "emerge
30 app-admin/conky" for installation. There is also usually an up-to-date
31 ebuild within Conkys package or in CVS.
33 To compile and run Conky with all optional components:
35 sh autogen.sh # Only required if building from CVS
37 ./configure --prefix=/usr --mandir=/usr/share/man
38 --infodir=/usr/share/info --datadir=/usr/share --sysconfdir=/etc
39 --localstatedir=/var/lib --enable-double-buffer --enable-own-window
40 --enable-proc-uptime --enable-mpd --enable-xft --enable-seti
44 make install # Optional
48 Conky doesnt probably compile with other compilers than gcc and icc.
49 It doesnt compile with C89 compiler and not even with pure C99. It
50 uses few things that might not exist: strdup(), strcasecmp(), strn
51 casecmp(), optarg variable with getopt() and long long (not in C89).
52 Crashes in file system statistics stuff when compiled with icc, I dont
55 You can disable drawing to own window feature in case you dont need
56 it by passing --disable-own-window to configure -script.
60 Conky is generally very good on resources. However, certain objects in
61 Conky are harder on resources then others. In particular, the $tail,
62 $top, $font, and $graph objects are quite costly in comparison to the
65 If you do use them, please do not complain about memory or CPU usage,
66 unless you think something is going seriously wrong (mem leak, et
69 Easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1
70 conky". Saves you the trouble of having to stop and then restart.
72 IMPORTANT: For previous Conky users, Conky 1.3 no longer supports the
73 metar stuff. mdsplib was causing way too many problems. hopefully
74 therell be a better solution in Conky 2.x...
77 Command line options override configurations defined in configuration
80 -V Prints version and exits
84 Text alignment on screen, {top,bottom}_{left,right} or none
87 -b Use double buffering (eliminates "flicker")
91 Config file to load instead of $HOME/.conkyrc
94 -d Daemonize Conky, aka fork to background
101 -h Prints command line help and exits
104 -o Create own window to draw
108 Text to render, remember single quotes, like -t $uptime
127 CONFIGURATION SETTINGS
128 Default configuration file is $HOME/.conkyrc (can be changed from
129 conky.c among other things). See conkyrc.sample. You might want to copy
130 it to $HOME/.conkyrc and then start modifying it.
133 Aligned position on screen, may be top_left, top_right, bot
134 tom_left, bottom_right, or none
138 Boolean value, if true, Conky will be forked to background when
143 Set conky on the bottom of all other applications
147 Border margin in pixels
151 Border width in pixels
155 The number of samples to average for CPU monitoring
159 Default color and border color
163 Default shading color and borders shading color
166 default_outline_color
167 Default outline color
171 Use the Xdbe extension? (eliminates flicker) It is highly recom
172 mended to use own window with this one so double buffer wont be
177 Draw borders around text?
188 font Font name in X, xfontsel can be used to get a nice font
191 gap_x Gap between right or left border of screen, same as passing -x
195 gap_y Gap between top or bottom border of screen, same as passing -y
200 Substract (file system) buffers from used memory?
204 Mail spool for mail checking
208 Maximum width of window
211 minimum_size width (height)
212 Minimum size of window
216 Hostname for mldonkey stuff, defaults to localhost
220 Mldonkey port, 4001 default
224 Mldonkey login, default none
228 Mldonkey password, default none
244 The number of samples to average for net data
248 Force UTF8? requires XFT
252 Boolean, create own window to draw?
255 own_window_transparent
256 Boolean, set pseudo-transparency?
259 own_window_colour colour
260 If own_window_transparent no, set a specified background colour
261 (defaults to black). Takes either a hex value (#ffffff) or a
262 valid RGB name (see /usr/lib/X11/rgb.txt)
266 Pad percentages to this many decimals (0 = no padding)
270 Border stippling (dashing) in pixels
274 Total number of times for Conky to update before quitting. Zero
275 makes Conky run forever
279 Update interval in seconds
283 Boolean value, if true, text is rendered in upper case
287 Adds spaces after certain objects to stop them from moving other
288 things around. Note that this only helps if you are using a mono
289 font, such as Bitstream Vera Sans Mono.
293 Use Xft (anti-aliased font and stuff)
296 text After this begins text to be formatted on screen
300 Colors are parsed using XParsecolor(), there might be a list of them:
301 /usr/X11R6/lib/X11/rgb.txt. Also, http://sedition.com/perl/rgb.html
302 Color can be also in #rrggbb format (hex). Note that when displaying
303 bytes, power is 1024 and not 1000 so 1M really means 1024*1024 bytes
307 IP address for an interface
311 ACPI ac adapter state.
319 ACPI temperature in C.
323 ACPI temperature in F.
327 CPU temperature from therm_adt746x
331 Fan speed from therm_adt746x
335 Right-justify text, with space of N
343 Remaining capacity in ACPI or APM battery. ACPI battery number
344 can be given as argument (default is BAT0).
348 Amount of memory buffered
351 cached Amount of memory cached
355 Change drawing color to color
359 CPU usage in percents. For SMP machines, the CPU number can be
360 provided as an argument. cpu0 is the total usage, and >=cpu1 are
361 individual CPUs. See $cpu for more info on SMP.
364 cpubar (cpu number) (height),(width)
365 Bar that shows CPU usage, height is bars height in pixels
368 cpugraph (cpu number) (height),(width) (gradient colour 1) (gradient
370 CPU usage graph, with optional colours in hex, minus the #. See
371 $cpu for more info on SMP.
374 diskio Displays current disk IO.
377 diskiograph (height),(width) (gradient colour 1) (gradient colour 2)
379 Disk IO graph, colours defined in hex, minus the #. If scale is
380 non-zero, it becomes the scale for the graph.
384 Download speed in kilobytes
388 Download speed in kilobytes with one decimal
391 downspeedgraph net (height),(width) (gradient colour 1) (gradient
393 Download speed graph, colours defined in hex, minus the #. If
394 scale is non-zero, it becomes the scale for the graph.
397 else Text to show if any of the above are not true
401 Executes a shell command and displays the output in conky. warn
402 ing: this takes a lot more resources than other variables. Id
403 recommend coding wanted behaviour in C and posting a patch.
407 Same as exec, except if the first value return is a value
408 between 0-100, it will use that number for a bar. The size for
409 the bar is currently fixed, but that may change in the future.
413 Same as execbar, but graphs values.
416 execi interval command
417 Same as exec but with specific interval. Interval cant be less
418 than update_interval in configuration.
421 execibar interval command
422 Same as execbar, except with an interval
425 execigraph interval command
426 Same as execigraph, but takes an interval arg graphs values
430 Specify a different font. Only applies to one line.
433 freq Returns CPU frequency in MHz
436 freq_g Returns CPU frequency in GHz
440 Returns CPU frequency in MHz, but is calculated by counting to
441 clock cycles to complete an instruction. Only available for
446 Returns CPU frequency in GHz, but is calculated by counting to
447 clock cycles to complete an instruction. Only available for
451 fs_bar (height),(width) fs
452 Bar that shows how much space is used on a file system. height
453 is the height in pixels. fs is any file on that file system.
457 Free space on a file system available for users.
461 Free percentage of space on a file system available for users.
469 File system used space
472 head logfile lines (interval)
473 Displays first N lines of supplied text text file. If interval
474 is not supplied, Conky assumes 2x Conkys interval. Max of 30
475 lines can be displayed, or until the text buffer is filled.
479 Horizontal line, height is the height in pixels
483 I2C sensor from sysfs (Linux 2.6). dev may be omitted if you
484 have only one I2C device. type is either in (or vol) meaning
485 voltage, fan meaning fan or temp/tempf (first in C, second in F)
486 meaning temperature. n is number of the sensor. See
487 /sys/bus/i2c/devices/ on your local computer.
491 If running the i8k kernel driver for Inspiron laptops, displays
492 whether ac power is on, as listed in /proc/i8k (translated to
493 human-readable). Beware that this is by default not enabled by
498 If running the i8k kernel driver for Inspiron laptops, displays
499 the bios version as listed in /proc/i8k.
503 If running the i8k kernel driver for Inspiron laptops, displays
504 the volume buttons status as listed in /proc/i8k.
508 If running the i8k kernel driver for Inspiron laptops, displays
509 the cpu temperature in celsius, as reported by /proc/i8k.
513 If running the i8k kernel driver for Inspiron laptops, displays
514 the cpu temperature in farenheit, as reported by /proc/i8k.
518 If running the i8k kernel driver for Inspiron laptops, displays
519 the left fans rate of rotation, in revolutions per minute as
520 listed in /proc/i8k. Beware, some laptops i8k reports these fans
525 If running the i8k kernel driver for Inspiron laptops, displays
526 the left fan status as listed in /proc/i8k (translated to
527 human-readable). Beware, some laptops i8k reports these fans in
532 If running the i8k kernel driver for Inspiron laptops, displays
533 the right fans rate of rotation, in revolutions per minute as
534 listed in /proc/i8k. Beware, some laptops i8k reports these fans
539 If running the i8k kernel driver for Inspiron laptops, displays
540 the right fan status as listed in /proc/i8k (translated to
541 human-readable). Beware, some laptops i8k reports these fans in
546 If running the i8k kernel driver for Inspiron laptops, displays
547 your laptop serial number as listed in /proc/i8k.
551 If running the i8k kernel driver for Inspiron laptops, displays
552 the version formatting of /proc/i8k.
556 if PROCESS is running, display everything if_running and the
561 if FILE exists, display everything between if_existing and the
565 if_mounted (mountpoint)
566 if MOUNTPOINT is mounted, display everything between if_mounted
567 and the matching $endif
570 kernel Kernel version
574 Get the link status for wireless connections
578 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
579 5 minutes and 3 for past 15 minutes.
583 Machine, i686 for example
586 mails Mail count in mail spool. You can use program like fetchmail to
587 get mails from some server using your favourite protocol. See
591 mem Amount of memory in use
594 membar (height),(width)
595 Bar that shows amount of memory in use
598 memmax Total amount of memory
602 Percentage of memory in use
606 total session upload in mb
610 total session download in mb
614 number of shared files
618 total session shared in mb, buggy in some mldonkey versions
622 tcp upload rate in kb/s
626 tcp download rate in kb/s
630 udp upload rate in kb/s
634 udp download rate in kb/s
638 number of completed files
641 ml_ndownloading_files
642 number of downloading files
646 Artist in current MPD song must be enabled at compile
650 Album in current MPD song
653 mpd_bar (height),(width)
658 Bitrate of current song
662 Playing, stopped, et cetera.
666 Title of current MPD song
682 Percent of songs progress
686 Unread mail count in mail spool.
697 pre_exec shell command
698 Executes a shell command one time before conky displays anything
699 and puts output as text.
703 Total processes (sleeping and running)
707 Running processes (not sleeping), requires Linux 2.6
715 Stippled (dashed) horizontal line
718 swapbar (height),(width)
719 Bar that shows amount of swap in use
722 swap Amount of swap in use
730 Percentage of swap in use
734 System name, Linux for example
738 Move text over by N pixels. See also $voffset.
741 tail logfile lines (interval)
742 Displays last N lines of supplied text text file. If interval is
743 not supplied, Conky assumes 2x Conkys interval. Max of 30 lines
744 can be displayed, or until the text buffer is filled.
748 Local time, see man strftime to get more information about for
753 Total download, overflows at 4 GB on Linux with 32-bit arch and
754 there doesnt seem to be a way to know how many times it has
755 already done that before conky has started.
759 This takes arguments in the form:top (name) (number) Basically,
760 processes are ranked from highest to lowest in terms of cpu
761 usage, which is what (num) represents. The types are: "name",
762 "pid", "cpu", and mem". There can be a max of 10 processes
767 Same as top, except sorted by mem usage instead of cpu
771 Total upload, this one too, may overflow
774 updates Number of updates
779 Upload speed in kilobytes
783 Upload speed in kilobytes with one decimal
786 upspeedgraph net (height),(width) (gradient colour 1) (gradient colour
788 Upload speed graph, colours defined in hex, minus the #. If
789 scale is non-zero, it becomes the scale for the graph.
796 Uptime in a shorter format
800 Seti@home current progress
803 seti_progbar (height),(width)
804 Seti@home current progress bar
808 Seti@home total user credit
812 Change verticle offset by N pixels. Negative values will cause
813 text to overlap. See also $offset.
817 conky -t${time %D %H:%m}-o -u 30
818 Start Conky in its own window with date and clock as text and 30
821 conky -a top_left -x 5 -y 500 -d
822 Start Conky to background at coordinates (5, 500).
825 ~/.conkyrc default configuration file
828 Drawing to root or some other desktop window directly doesnt work with
829 all window managers. Especially doesnt work well with Gnome and it has
830 been reported that it doesnt 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
833 Conky to set some specific window id. You might find xwininfo -tree
834 useful to find the window to draw to. You can also use -o argument
835 which makes Conky to create its own window.
838 http://conky.sourceforge.net
840 http://www.sourceforge.net/projects/conky
842 #conky on irc.freenode.net
845 The Conky dev team. Whats up now!