6 conky - a system monitor for X originally based on the torsmo code, but
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 To compile and run Conky with all optional components (If you run Gen
28 too, see the "Ebuild" Section below):
30 ./configure --prefix=/usr --mandir=/usr/share/man
31 --infodir=/usr/share/info --datadir=/usr/ share --sysconfdir=/etc
32 --localstatedir=/var/lib --enable-double-buffer --enable-own-window
33 --enable-proc-uptime --enable-mpd --enable-xft --enable-metar
40 Conky doesnt probably compile with other compilers than gcc and icc.
41 It doesnt compile with C89 compiler and not even with pure C99. It
42 uses few things that might not exist: strdup(), strcasecmp(), strn
43 casecmp(), optarg variable with getopt() and long long (not in C89).
44 Crashes in file system statistics stuff when compiled with icc, I dont
47 You can disable drawing to own window feature in case you dont need
48 it by passing --disable-own-window to configure -script.
50 Conky is in Gentoos Portage. Simply use "emerge conky" to install
51 conky. There is also usually an up-to-date ebuild within Conkys pack
55 Conky is generally very good on resources. However, certain objects in
56 Conky are harder on resources then others. In particular, the $tail,
57 $top, $font, and $graph objects are quite costly in comparison to the
60 If you do use them, please do not complain about memory or CPU usage,
61 unless you think something is going seriously wrong (mem leak, et
65 Command line options override configurations defined in configuration
68 -V Prints version and exits
72 Text alignment on screen, {top,bottom}_{left,right}
75 -b Use double buffering (eliminates flicker)
79 Config file to load instead of $HOME/.conkyrc
82 -d Daemonize, fork to background
89 -h Prints command line help and exits
92 -o Create own window to draw
96 Text to render, remember single quotes, like -t $uptime
115 CONFIGURATION SETTINGS
116 Default configuration file is $HOME/.conkyrc (can be changed from
117 conky.c among other things). See conkyrc.sample. You might want to copy
118 it to $HOME/.conkyrc and then start modifying it.
121 Aligned position on screen, may be top_left, top_right, bot
122 tom_left, bottom_right
126 Boolean value, if true, Conky will be forked to background when
131 Set conky on the bottom of all other applications
135 Border margin in pixels
139 Border width in pixels
143 The number of samples to average for CPU monitoring
147 Default color and border color
151 Default shading color and borders shading color
154 default_outline_color
155 Default outline color
159 Use the Xdbe extension? (eliminates flicker) It is highly recom
160 mended to use own window with this one so double buffer wont be
165 Draw borders around text?
176 font Font name in X, xfontsel can be used to get a nice font
179 gap_x Gap between right or left border of screen, same as passing -x
183 gap_y Gap between top or bottom border of screen, same as passing -y
188 Substract (file system) buffers from used memory?
192 Mail spool for mail checking
196 METAR station code for weather, see http://www.wrh.noaa.gov/ if
197 you need to find your code.
201 Define a custom METAR ftp server
205 Path on server to use
209 Minimum size of window
213 Hostname for mldonkey stuff, defaults to localhost
217 Mldonkey port, 4001 default
221 Mldonkey login, default none
225 Mldonkey password, default none
241 The number of samples to average for net data
245 Force UTF8? requires XFT
249 Boolean, create own window to draw?
253 Pad percentages to this many decimals (0 = no padding)
257 Border stippling (dashing) in pixels
261 Total number of times for Conky to update before quitting. Zero
262 makes Conky run forever
266 Update interval in seconds
270 Boolean value, if true, text is rendered in upper case
274 Adds spaces after certain objects to stop them from moving other
275 things around. Note that this only helps if you are using a mono
276 font, such as Bitstream Vera Sans Mono.
280 Use Xft (anti-aliased font and stuff)
283 text After this begins text to be formatted on screen
287 Colors are parsed using XParsecolor(), there might be a list of them:
288 /usr/X11R6/lib/X11/rgb.txt. Also, http://sedition.com/perl/rgb.html
289 Color can be also in #rrggbb format (hex). Note that when displaying
290 bytes, power is 1024 and not 1000 so 1M really means 1024*1024 bytes
294 IP address for an interface
298 ACPI ac adapter state.
310 CPU temperature from therm_adt746x
314 Fan speed from therm_adt746x
318 Right-justify text, with space of N
326 Remaining capacity in ACPI or APM battery. ACPI battery number
327 can be given as argument (default is BAT0).
331 Amount of memory buffered
334 cached Amount of memory cached
338 Change drawing color to color
341 cpu CPU usage in percents
345 Bar that shows CPU usage, height is bars height in pixels
348 cpugraph (height, width, gradient colour 1, gradient colour 2)
349 CPU usage graph, with optional colours in hex, minus the #.
353 Download speed in kilobytes
357 Download speed in kilobytes with one decimal
360 downspeedgraph net, (height, width, gradient colour 1, gradient colour
362 Download speed graph, colours defined in hex, minus the #.
365 else Text to show if any of the above are not true
369 Executes a shell command and displays the output in conky. warn
370 ing: this takes a lot more resources than other variables. Id
371 recommend coding wanted behaviour in C and posting a patch.
374 execbar shell command
375 Same as exec, except if the first value return is a value
376 between 0-100, it will use that number for a bar. The size for
377 the bar is currently fixed, but that may change in the future.
380 execgraph shell command
381 Same as execbar, but graphs values
384 execi interval, shell command
385 Same as exec but with specific interval. Interval cant be less
386 than update_interval in configuration.
390 Specify a different font. Only applies to one line.
394 Bar that shows how much space is used on a file system. height
395 is the height in pixels. fs is any file on that file system.
399 Free space on a file system available for users.
403 Free percentage of space on a file system available for users.
411 File system used space
415 Horizontal line, height is the height in pixels
419 I2C sensor from sysfs (Linux 2.6). dev may be omitted if you
420 have only one I2C device. type is either in (or vol) meaning
421 voltage, fan meaning fan or temp/tempf (first in C, second in F)
422 meaning temperature. n is number of the sensor. See
423 /sys/bus/i2c/devices/ on your local computer.
427 if PROCESS is running, display everything if_running and the
432 if FILE exists, display everything between if_existing and the
436 if_mounted (mountpoint)
437 if MOUNTPOINT is mounted, display everything between if_mounted
438 and the matching $endif
441 kernel Kernel version
444 linkstatus (interface)
445 Get the link status for wireless connections
449 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
450 5 minutes and 3 for past 15 minutes.
454 Machine, i686 for example
457 mails Mail count in mail spool. You can use program like fetchmail to
458 get mails from some server using your favourite protocol. See
462 mem Amount of memory in use
466 Bar that shows amount of memory in use
469 memmax Total amount of memory
473 Percentage of memory in use
521 total session upload in mb
525 total session download in mb
529 number of shared files
533 total session shared in mb, buggy in some mldonkey versions
537 tcp upload rate in kb/s
541 tcp download rate in kb/s
545 udp upload rate in kb/s
549 udp download rate in kb/s
553 number of completed files
556 ml_ndownloading_files
557 number of downloading files
561 Artist in current MPD song must be enabled at compile
565 Album in current MPD song
573 Bitrate of current song
577 Playing, stopped, et cetera.
581 Title of current MPD song
597 Percent of songs progress
601 Unread mail count in mail spool.
612 pre_exec shell command
613 Executes a shell command one time before conky displays anything
614 and puts output as text.
618 Total processes (sleeping and running)
622 Running processes (not sleeping), requires Linux 2.6
630 Stippled (dashed) horizontal line
634 Bar that shows amount of swap in use
637 swap Amount of swap in use
645 Percentage of swap in use
649 System name, Linux for example
653 Move text over by N pixels
656 tail logfile, lines interval> Displays last N lines of supplied text
657 text file. If interval is not supplied, Conky assumes 2x Conkys
658 interval. Max of 30 lines. Max of 30 lines can be displayed.
662 Local time, see man strftime to get more information about for
667 Total download, overflows at 4 GB on Linux with 32-bit arch and
668 there doesnt seem to be a way to know how many times it has
669 already done that before conky has started.
673 This takes arguments in the form:top (name) (number) Basically,
674 processes are ranked from highest to lowest in terms of cpu
675 usage, which is what (num) represents. The types are: "name",
676 "pid", "cpu", and mem". There can be a max of 10 processes
681 Same as top, except sorted by mem usage instead of cpu
685 Total upload, this one too, may overflow
688 updates Number of updates
693 Upload speed in kilobytes
697 Upload speed in kilobytes with one decimal
700 upspeedgraph net, (height, width, gradient colour 1, gradient colour 2)
701 Upload speed graph, colours defined in hex, minus the #.
708 Uptime in a shorter format
712 Seti@home current progress
715 seti_progbar (height)
716 Seti@home current progress bar
720 Seti@home total user credit
724 conky -t${time %D %H:%m}-o -u 30
725 Start Conky in its own window with date and clock as text and 30
728 conky -a top_left -x 5 -y 500 -d
729 Start Conky to background at coordinates (5, 500).
732 ~/.conkyrc default configuration file
735 Drawing to root or some other desktop window directly doesnt work with
736 all window managers. Especially doesnt work well with Gnome and it has
737 been reported that it doesnt work with KDE either. Nautilus can be
738 disabled from drawing to desktop with program gconf-editor. Uncheck
739 show_desktop in /apps/nautilus/preferences/. There is -w switch in
740 Conky to set some specific window id. You might find xwininfo -tree
741 useful to find the window to draw to. You can also use -o argument
742 which makes Conky to create its own window.
745 http://conky.sourceforge.net
747 http://www.sourceforge.net/projects/conky
749 #conky on irc.freenode.net
752 The Conky dev team. Whats up now??!