6 conky - A system monitor for X originally based on the torsmo code, but
7 more kickass. It just keeps on given'er. Yeah.
13 Conky is a system monitor for X originally based on torsmo. Since its
14 inception, Conky has changed significantly from its predecessor, while
15 maintaining simplicity and configurability. Conky can display just
16 about anything, either on your root desktop or in its own window. Not
17 only does Conky have many built-in objects, it can also display just
18 about any piece of information by using scripts and other external pro-
21 Conky has more than 250 built in objects, including support for a
22 plethora of OS stats (uname, uptime, CPU usage, mem usage, disk usage,
23 "top" like process stats, and network monitoring, just to name a few),
24 built in IMAP and POP3 support, built in support for many popular music
25 players (MPD, XMMS2, BMPx, Audacious), and much much more. Conky can
26 display this info either as text, or using simple progress bars and
27 graph widgets, with different fonts and colours.
29 We are always looking for help, whether its reporting bugs, writing
30 patches, or writing docs. Please use the facilities at SourceForge to
31 make bug reports, feature requests, and submit patches, or stop by
32 #conky on irc.freenode.net if you have questions or want to contribute.
34 Thanks for your interest in Conky.
37 For users compiling from source on a binary distro, make sure you have
38 the X development libraries installed. This should be a package along
39 the lines of "libx11-dev" or "xorg-x11-dev" for X11 libs, and similar
40 "-dev" format for the other libs required (depending on your configure
43 Conky has (for some time) been available in the repositories of most
44 popular distributions. Here are some installation instructions for a
47 Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-
48 admin/conky" for installation. There is also usually an up-to-date
49 ebuild within Conky's package or in SVN.
51 Debian, etc. users -- Conky should be in your repositories, and can be
52 installed by doing "aptitude install conky".
54 Example to compile and run Conky with all optional components (note
55 that some configure options may differ for your system):
57 sh autogen.sh # Only required if building from SVN
59 ./configure --prefix=/usr --mandir=/usr/share/man --in-
60 fodir=/usr/share/info --datadir=/usr/share --sysconfdir=/etc --local-
61 statedir=/var/lib --disable-own-window --enable-audacious[=yes|no|lega-
62 cy] --enable-bmpx --disable-hddtemp --disable-mpd --enable-xmms2 --dis-
63 able-portmon --disable-network --enable-debug --disable-x11 --dis-
64 able-double-buffer --disable-xdamage --disable-xft
68 make install # Optional
72 Conky has been tested to be compatible with C99 C, however it has not
73 been tested with anything other than gcc, and is not guaranteed to work
78 Conky is generally very good on resources. That said, the more you try
79 to make Conky do, the more resources it is going to consume.
81 An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1
82 conky". Saves you the trouble of having to kill and then restart. You
83 can now also do the same with SIGHUP.
86 Command line options override configurations defined in configuration
90 Prints version and exits
93 -a | --alignment=ALIGNMENT
94 Text alignment on screen, {top,bottom,middle}_{left,right,mid-
99 Use double buffering (eliminates "flicker")
103 Config file to load instead of $HOME/.conkyrc
107 Daemonize Conky, aka fork to background
115 Prints command line help and exits
119 Create own window to draw
123 Text to render, remember single quotes, like -t ' $uptime '
126 -u | --interval=SECONDS
130 -w | --window-id=WIN_ID
143 Number of times to update Conky (and quit)
146 CONFIGURATION SETTINGS
147 Default configuration file location is $HOME/.conkyrc or
148 ${sysconfdir}/conky/conky.conf. On most systems, sysconfdir is /etc,
149 and you can find the sample config file there (/etc/conky/conky.conf).
151 You might want to copy it to $HOME/.conkyrc and then start modifying
152 it. Other configs can be found at http://conky.sf.net/
155 Aligned position on screen, may be top_left, top_right, top_mid-
156 dle, bottom_left, bottom_right, bottom_middle, middle_left, mid-
157 dle_right, or none (also can be abreviated as tl, tr, tm, bl,
162 Boolean value, if true, Conky will be forked to background when
167 Border margin in pixels
171 Border width in pixels
174 color0 A color variable for use inside TEXT segments
177 color1 A color variable for use inside TEXT segments
180 color2 A color variable for use inside TEXT segments
183 color3 A color variable for use inside TEXT segments
186 color4 A color variable for use inside TEXT segments
189 color5 A color variable for use inside TEXT segments
192 color6 A color variable for use inside TEXT segments
195 color7 A color variable for use inside TEXT segments
198 color8 A color variable for use inside TEXT segments
201 color9 A color variable for use inside TEXT segments
205 The number of samples to average for CPU monitoring
209 If true, cpu in top will show usage of one processor's power. If
210 false, cpu in top will show the usage of all processors' power
215 Default color and border color
218 default_outline_color
219 Default outline color
223 Default shading color and border's shading color
227 Use the Xdbe extension? (eliminates flicker) It is highly recom-
228 mended to use own window with this one so double buffer won't be
233 Draw borders around text?
237 Draw borders around graphs?
248 font Font name in X, xfontsel can be used to get a nice font
251 gap_x Gap, in pixels, between right or left border of screen, same as
252 passing -x at command line, e.g. gap_x 10
255 gap_y Gap, in pixels, between top or bottom border of screen, same as
256 passing -y at command line, e.g. gap_y 10.
259 imap Default global IMAP server. Arguments are: "host user pass [-i
260 interval] [-f folder] [-p port] [-e command]". Default port is
261 143, default folder is 'INBOX', default interval is 5 minutes.
262 If the password is supplied as '*', you will be prompted to en-
263 ter the password when Conky starts.
267 Mail spool for mail checking
270 max_port_monitor_connections
271 Allow each port monitor to track at most this many connections
272 (if 0 or not set, default is 256)
276 Maximum number of special things, e.g. fonts, offsets, aligns,
277 etc. (default is 512)
281 Maximum size of user text buffer, i.e. layout below TEXT line in
282 config file (default is 16384 bytes)
285 text_buffer_size bytes
286 Size of the standard text buffer (default is 256 bytes). This
287 buffer is used for intermediary text, such as individual lines,
288 output from $exec vars, and various other variables. Increasing
289 the size of this buffer can drastically reduce Conky's perfor-
290 mance, but will allow for more text display per variable. The
291 size of this buffer cannot be smaller than the default value of
296 Maximum width of window
299 minimum_size width (height)
300 Minimum size of window
315 music_player_interval
316 Music player thread update interval (defaults to Conky's update
321 The number of samples to average for net data
325 Substract (file system) buffers from used memory?
329 Force UTF8? requires XFT
333 Boolean, create own window to draw?
337 Manually set the WM_CLASS name. Defaults to "Conky".
340 own_window_colour colour
341 If own_window_transparent no, set a specified background colour
342 (defaults to black). Takes either a hex value (#ffffff) or a
343 valid RGB name (see /usr/lib/X11/rgb.txt)
346 own_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager
347 If own_window is yes, you may use these window manager hints to
348 affect the way Conky displays. Notes: Use own_window_type desk-
349 top as another way to implement many of these hints implicitly.
350 If you use own_window_type override, window manager hints have
351 no meaning and are ignored.
355 Manually set the window name. Defaults to "<hostname> - conky".
358 own_window_transparent
359 Boolean, set pseudo-transparency?
363 if own_window is yes, you may specify type normal, desktop or
364 override (default: normal). Desktop windows are special windows
365 that have no window decorations; are always visible on your
366 desktop; do not appear in your pager or taskbar; and are sticky
367 across all workspaces. Override windows are not under the con-
368 trol of the window manager. Hints are ignored. This type of win-
369 dow can be useful for certain situations.
373 Print text to stdout.
377 Pad percentages to this many decimals (0 = no padding)
380 pop3 Default global POP3 server. Arguments are: "host user pass [-i
381 interval] [-p port] [-e command]". Default port is 110, default
382 interval is 5 minutes. If the password is supplied as '*', you
383 will be prompted to enter the password when Conky starts.
387 Shortens units to a single character (kiB->k, GiB->G, etc.). De-
392 Shows the maximum value in scaled graphs.
396 Border stippling (dashing) in pixels
400 Total number of times for Conky to update before quitting. Zero
401 makes Conky run forever
405 Update interval in seconds
409 Boolean value, if true, text is rendered in upper case
413 Adds spaces around certain objects to stop them from moving oth-
414 er things around. Arguments are left, right, and none (default).
415 The old true/false values are deprecated and default to
416 right/none respectively. Note that this only helps if you are
417 using a mono font, such as Bitstream Vera Sans Mono.
421 Use Xft (anti-aliased font and stuff)
425 Alpha of Xft font. Must be a value at or between 1 and 0.
432 TEXT After this begins text to be formatted on screen
436 Colors are parsed using XParsecolor(), there might be a list of them:
437 /usr/share/X11/rgb.txt. Also, <http://sedition.com/perl/rgb.html>.
438 Color can be also in #rrggbb format (hex).
441 IP address for an interface
445 IP addresses for an interface (if one - works like addr). Linux
450 ACPI ac adapter state.
458 ACPI temperature in C.
462 ACPI temperature in F.
466 CPU temperature from therm_adt746x
470 Fan speed from therm_adt746x
474 Right-justify text, with space of N
482 Display APM AC adapter status (FreeBSD only)
486 Display APM battery life in percent (FreeBSD only)
490 Display remaining APM battery life in hh:mm:ss or "unknown" if
491 AC adapterstatus is on-line or charging (FreeBSD only)
494 audacious_bar (height),(width)
499 Bitrate of current tune
503 Number of audio channels of current tune
507 Full path and filename of current tune
511 Sampling frequency of current tune
515 Total length of current tune as MM:SS
518 audacious_length_seconds
519 Total length of current tune in seconds
522 audacious_playlist_position
523 Playlist position of current tune
526 audacious_playlist_length
527 Number of tunes in playlist
531 Position of current tune (MM:SS)
534 audacious_position_seconds
535 Position of current tune in seconds
539 Player status (Playing/Paused/Stopped/Not running)
542 audacious_title (max length)
543 Title of current tune with optional maximum length specifier
547 Battery status and remaining percentage capacity of ACPI or APM
548 battery. ACPI battery number can be given as argument (default
552 battery_bar (height),(width) (num)
553 Battery percentage remaining of ACPI battery in a bar. ACPI bat-
554 tery number can be given as argument (default is BAT0).
557 battery_percent (num)
558 Battery percentage remaining for ACPI battery. ACPI battery num-
559 ber can be given as argument (default is BAT0).
563 Battery charge/discharge time remaining of ACPI battery. ACPI
564 battery number can be given as argument (default is BAT0).
568 Artist in current BMPx track
572 Album in current BMPx track
576 Title of the current BMPx track
580 Track number of the current BMPx track
584 Bitrate of the current BMPx track
588 URI of the current BMPx track
592 Amount of memory buffered
595 cached Amount of memory cached
599 Change drawing color to color
602 color0 Change drawing color to color0 configuration option
605 color1 Change drawing color to color1 configuration option
608 color2 Change drawing color to color2 configuration option
611 color3 Change drawing color to color3 configuration option
614 color4 Change drawing color to color4 configuration option
617 color5 Change drawing color to color5 configuration option
620 color6 Change drawing color to color6 configuration option
623 color7 Change drawing color to color7 configuration option
626 color8 Change drawing color to color8 configuration option
629 color9 Change drawing color to color9 configuration option
641 CPU architecture Conky was built for
645 CPU usage in percents. For SMP machines, the CPU number can be
646 provided as an argument. ${cpu cpu0} is the total usage, and
647 ${cpu cpuX} (X >= 1) are individual CPUs.
650 cpubar (cpu number) (height),(width)
651 Bar that shows CPU usage, height is bar's height in pixels. See
652 $cpu for more info on SMP.
655 cpugraph (cpu number) (height),(width) (gradient colour 1) (gradient
657 CPU usage graph, with optional colours in hex, minus the #. See
658 $cpu for more info on SMP.
662 Displays current disk IO. Device is optional, and takes the form
663 of sda for /dev/sda. Individual partitions are allowed.
666 diskiograph (device) (height),(width) (gradient colour 1) (gradient
668 Disk IO graph, colours defined in hex, minus the #. If scale is
669 non-zero, it becomes the scale for the graph.
673 Displays current disk IO for reads. Device as in diskio.
676 diskiograph_read (device) (height),(width) (gradient colour 1) (gradi-
677 ent colour 2) (scale)
678 Disk IO graph for reads, colours defined in hex, minus the #. If
679 scale is non-zero, it becomes the scale for the graph. Device as
683 diskio_write (device)
684 Displays current disk IO for writes. Device as in diskio.
687 diskiograph_write (device) (height),(width) (gradient colour 1) (gradi-
688 ent colour 2) (scale)
689 Disk IO graph for writes, colours defined in hex, minus the #.
690 If scale is non-zero, it becomes the scale for the graph. Device
695 Disk protection status, if supported (needs kernel-patch).
696 Prints either "frozen" or "free " (note the padding).
700 Download speed in kilobytes
704 Download speed in kilobytes with one decimal
707 downspeedgraph net (height),(width) (gradient colour 1) (gradient
709 Download speed graph, colours defined in hex, minus the #. If
710 scale is non-zero, it becomes the scale for the graph.
713 else Text to show if any of the above are not true
717 Current entropy available for crypto freaks
720 entropy_bar (height),(width)
721 Normalized bar of available entropy for crypto freaks
725 Total size of system entropy pool for crypto freaks
729 Executes a shell command and displays the output in conky. warn-
730 ing: this takes a lot more resources than other variables. I'd
731 recommend coding wanted behaviour in C and posting a patch.
735 Same as exec, except if the first value return is a value be-
736 tween 0-100, it will use that number for a bar. The size for the
737 bar is currently fixed, but that may change in the future.
741 Same as execbar, but graphs values.
744 execi interval command
745 Same as exec but with specific interval. Interval can't be less
746 than update_interval in configuration. See also $texeci
749 execibar interval command
750 Same as execbar, except with an interval
753 execigraph interval command
754 Same as execgraph, but takes an interval arg graphs values
758 Executes a shell command and displays the output in conky. warn-
759 ing: this takes a lot more resources than other variables. I'd
760 recommend coding wanted behaviour in C and posting a patch. This
761 differs from $exec in that it parses the output of the command,
762 so you can insert things like ${color red}hi!${color} in your
763 script and have it correctly parsed by Conky. Caveats: Conky
764 parses and evaluates the output of $execp every time Conky
765 loops, and then destroys all the objects. If you try to use any-
766 thing like $execi within an $execp statement, it will function-
767 ally run at the same interval that the $execp statement runs, as
768 it is created and destroyed at every interval.
771 execpi interval command
772 Same as execp but with specific interval. Interval can't be less
773 than update_interval in configuration. Note that the output from
774 the $execpi command is still parsed and evaluated at every in-
779 Specify a different font. This new font will apply to the cur-
780 rent line and everything following. You can use a $font with no
781 arguments to change back to the default font (much like with
786 Returns CPU #n's frequency in MHz. CPUs are counted from 1. If
787 omitted, the parameter defaults to 1.
791 Returns CPU #n's frequency in GHz. CPUs are counted from 1. If
792 omitted, the parameter defaults to 1.
796 Returns CPU frequency in MHz, but is calculated by counting to
797 clock cycles to complete an instruction. Only available for
802 Returns CPU frequency in GHz, but is calculated by counting to
803 clock cycles to complete an instruction. Only available for
807 fs_bar (height),(width) fs
808 Bar that shows how much space is used on a file system. height
809 is the height in pixels. fs is any file on that file system.
813 Free space on a file system available for users.
817 Free percentage of space on a file system available for users.
829 File system used space
832 goto x The next element will be printed at position 'x'.
836 Displays the default route's interface or "multiple"/"none" ac-
840 gw_ip Displays the default gateway's IP or "multiple"/"none" accord-
844 hddtemp dev, (host,(port))
845 Displays temperature of a selected hard disk drive as reported
846 by the hddtemp daemon running on host:port. Default host is
847 127.0.0.1, default port is 7634.
850 head logfile lines (interval)
851 Displays first N lines of supplied text text file. If interval
852 is not supplied, Conky assumes 2x Conky's interval. Max of 30
853 lines can be displayed, or until the text buffer is filled.
857 Horizontal line, height is the height in pixels
861 Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omit-
862 ted if you have only one hwmon device. Parameter type is either
863 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Cel-
864 sius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n
865 is number of the sensor. See /sys/class/hwmon/ on your local
869 iconv_start codeset_from codeset_to
870 Convert text from one codeset to another using GNU iconv. Needs
871 to be stopped with iconv_stop.
875 Stop iconv codeset conversion.
879 I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted
880 if you have only one I2C device. Parameter type is either 'in'
881 or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Celsius) or
882 'tempf' (Fahrenheit) meaning temperature. Parameter n is number
883 of the sensor. See /sys/bus/i2c/devices/ on your local computer.
887 If running the i8k kernel driver for Inspiron laptops, displays
888 whether ac power is on, as listed in /proc/i8k (translated to
889 human-readable). Beware that this is by default not enabled by
894 If running the i8k kernel driver for Inspiron laptops, displays
895 the bios version as listed in /proc/i8k.
899 If running the i8k kernel driver for Inspiron laptops, displays
900 the volume buttons status as listed in /proc/i8k.
904 If running the i8k kernel driver for Inspiron laptops, displays
905 the cpu temperature in Celsius, as reported by /proc/i8k.
909 If running the i8k kernel driver for Inspiron laptops, displays
910 the cpu temperature in Fahrenheit, as reported by /proc/i8k.
914 If running the i8k kernel driver for Inspiron laptops, displays
915 the left fan's rate of rotation, in revolutions per minute as
916 listed in /proc/i8k. Beware, some laptops i8k reports these fans
921 If running the i8k kernel driver for Inspiron laptops, displays
922 the left fan status as listed in /proc/i8k (translated to human-
923 readable). Beware, some laptops i8k reports these fans in re-
928 If running the i8k kernel driver for Inspiron laptops, displays
929 the right fan's rate of rotation, in revolutions per minute as
930 listed in /proc/i8k. Beware, some laptops i8k reports these fans
935 If running the i8k kernel driver for Inspiron laptops, displays
936 the right fan status as listed in /proc/i8k (translated to hu-
937 man-readable). Beware, some laptops i8k reports these fans in
942 If running the i8k kernel driver for Inspiron laptops, displays
943 your laptop serial number as listed in /proc/i8k.
947 If running the i8k kernel driver for Inspiron laptops, displays
948 the version formatting of /proc/i8k.
952 If running the IBM ACPI, displays the fan speed.
956 If running the IBM ACPI, displays the temperatures from the IBM
957 temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
962 If running the IBM ACPI, displays the "master" volume, con-
963 trolled by the volume keys (0-14).
967 If running the IBM ACPI, displays the brigtness of the laptops's
972 if conky variable VAR is empty, display everything between
973 $if_empty and the matching $endif
976 if_gw if there is at least one default gateway, display everything be-
977 tween $if_gw and the matching $endif
981 if PROCESS is running, display everything $if_running and the
985 if_existing file (string)
986 if FILE exists, display everything between if_existing and the
987 matching $endif. The optional second paramater checks for FILE
988 containing the specified string and prints everything between
989 $if_existing and the matching $endif.
992 if_mounted (mountpoint)
993 if MOUNTPOINT is mounted, display everything between $if_mounted
994 and the matching $endif
997 if_smapi_bat_installed (INDEX)
998 when using smapi, if the battery with index INDEX is installed,
999 display everything between $if_smapi_bat_installed and the
1004 if INTERFACE exists and is up, display everything between $if_up
1005 and the matching $endif
1008 imap_messages (args)
1009 Displays the number of messages in your global IMAP inbox by de-
1010 fault. You can define individual IMAP inboxes seperately by
1011 passing arguments to this object. Arguments are: "host user pass
1012 [-i interval] [-p port] [-e command]". Default port is 143, de-
1013 fault interval is 5 minutes. If the password is supplied as '*',
1014 you will be prompted to enter the password when Conky starts.
1018 Displays the number of unseen messages in your global IMAP inbox
1019 by default. You can define individual IMAP inboxes seperately by
1020 passing arguments to this object. Arguments are: "host user pass
1021 [-i interval] [-p port] [-e command]". Default port is 143, de-
1022 fault interval is 5 minutes. If the password is supplied as '*',
1023 you will be prompted to enter the password when Conky starts.
1027 Prints the current ioscheduler used for the given disk name
1028 (i.e. e.g. "hda" or "sdb")
1031 kernel Kernel version
1035 The value of /proc/sys/vm/laptop_mode
1039 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
1040 5 minutes and 3 for past 15 minutes.
1043 loadgraph (height),(width) (gradient colour 1) (gradient colour 2)
1044 Load1 average graph, similar to xload, with optional colours in
1049 Machine, i686 for example
1052 mails (mailbox) (interval)
1053 Mail count in the specified mailbox or your mail spool if not.
1054 Both mbox and maildir type mailboxes are supported. You can use
1055 a program like fetchmail to get mails from some server using
1056 your favourite protocol. See also new_mails.
1059 mboxscan (-n number of messages to print) (-fw from width) (-sw subject
1061 Print a summary of recent messages in an mbox format mailbox.
1062 mbox parameter is the filename of the mailbox (can be encapsu-
1063 lated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
1066 mem Amount of memory in use
1069 membar (height),(width)
1070 Bar that shows amount of memory in use
1073 memmax Total amount of memory
1077 Percentage of memory in use
1081 Artist in current MPD song must be enabled at compile
1085 Album in current MPD song
1088 mpd_bar (height),(width)
1089 Bar of mpd's progress
1093 Bitrate of current song
1097 Playing, stopped, et cetera.
1100 mpd_title (max length)
1101 Title of current MPD song
1117 Percent of song's progress
1121 Random status (On/Off)
1125 Repeat status (On/Off)
1129 Prints the MPD track field
1133 Prints the MPD name field
1137 Prints the file name of the current MPD song
1141 Prints the song name in either the form "artist - title" or file
1142 name, depending on whats available
1146 Print a nameserver from /etc/resolv.conf. Index starts at and
1150 new_mails (mailbox) (interval)
1151 Unread mail count in the specified mailbox or mail spool if not.
1152 Both mbox and maildir type mailboxes are supported.
1159 outlinecolor (color)
1160 Change outline color
1164 If running on Apple powerbook/ibook, display information on bat-
1165 tery status. The item parameter specifies, what information to
1166 display. Exactly one item must be specified. Valid items are:
1168 status: Display if battery is fully charged, charging, discharg-
1169 ing or absent (running on AC)
1170 percent: Display charge of battery in percent, if charging or
1171 discharging. Nothing will be displayed, if battery is fully
1173 time: Display the time remaining until the battery will be fully
1174 charged or discharged at current rate. Nothing is displayed, if
1175 battery is absent or if it's present but fully charged and not
1179 platform (dev) type n
1180 Platform sensor from sysfs (Linux 2.6). Parameter dev may be
1181 omitted if you have only one platform device. Platform type is
1182 either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp'
1183 (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter
1184 n is number of the sensor. See /sys/bus/platform/devices/ on
1185 your local computer.
1189 Displays the number of unseen messages in your global POP3 inbox
1190 by default. You can define individual POP3 inboxes seperately by
1191 passing arguments to this object. Arguments are: "host user pass
1192 [-i interval] [-p port] [-e command]". Default port is 110, de-
1193 fault interval is 5 minutes. If the password is supplied as '*',
1194 you will be prompted to enter the password when Conky starts.
1198 Displays the amount of space (in MiB, 2^20) used in your global
1199 POP3 inbox by default. You can define individual POP3 inboxes
1200 seperately by passing arguments to this object. Arguments are:
1201 "host user pass [-i interval] [-p port] [-e command]". Default
1202 port is 110, default interval is 5 minutes. If the password is
1203 supplied as '*', you will be prompted to enter the password when
1207 pre_exec shell command
1208 Executes a shell command one time before conky displays anything
1209 and puts output as text.
1213 Total processes (sleeping and running)
1217 Running processes (not sleeping), requires Linux 2.6
1221 Change shading color
1225 when using smapi, display contents of the /sys/devices/plat-
1226 form/smapi directory. ARGS are either '(FILENAME)' or 'bat (IN-
1227 DEX) (FILENAME)' to display the corresponding files' content.
1228 This is a very raw method of accessing the smapi values. When
1229 available, better use one of the smapi_* variables instead.
1232 smapi_bat_perc (INDEX)
1233 when using smapi, display the remaining capacity in percent of
1234 the battery with index INDEX. This is a separate variable be-
1235 cause it supports the 'use_spacer' configuration option.
1238 smapi_bat_bar (INDEX),(height),(width)
1239 when using smapi, display the remaining capacity of the battery
1240 with index INDEX as a bar.
1244 Stippled (dashed) horizontal line
1247 swapbar (height),(width)
1248 Bar that shows amount of swap in use
1251 swap Amount of swap in use
1255 Total amount of swap
1259 Percentage of swap in use
1263 System name, Linux for example
1266 tcp_portmon port_begin port_end item (index) (ip4 only at present)
1267 TCP port monitor for specified local ports. Port numbers must be
1268 in the range 1 to 65535. Valid items are:
1270 count - total number of connections in the range
1271 rip - remote ip address
1272 rhost - remote host name
1273 rport - remote port number
1274 rservice - remote service name from /etc/services
1275 lip - local ip address
1276 lhost - local host name
1277 lport - local port number
1278 lservice - local service name from /etc/services
1280 The connection index provides you with access to each connection
1281 in the port monitor. The monitor will return information for in-
1282 dex values from 0 to n-1 connections. Values higher than n-1 are
1283 simply ignored. For the "count" item, the connection index must
1284 be omitted. It is required for all other items.
1287 ${tcp_portmon 6881 6999 count} - displays the number of connec-
1288 tions in the bittorrent port range
1289 ${tcp_portmon 22 22 rip 0} - displays the remote host ip of the
1290 first sshd connection
1291 ${tcp_portmon 22 22 rip 9} - displays the remote host ip of the
1292 tenth sshd connection
1293 ${tcp_portmon 1 1024 rhost 0} - displays the remote host name of
1294 the first connection on a privileged port
1295 ${tcp_portmon 1 1024 rport 4} - displays the remote host port of
1296 the fifth connection on a privileged port
1297 ${tcp_portmon 1 65535 lservice 14} - displays the local service
1298 name of the fifteenth connection in the range of all ports
1300 Note that port monitor variables which share the same port range
1301 actually refer to the same monitor, so many references to a sin-
1302 gle port range for different items and different indexes all use
1303 the same monitor internally. In other words, the program avoids
1304 creating redundant monitors.
1306 texeci interval command
1307 Runs a command at an interval inside a thread and displays the
1308 output. Same as $execi, except the command is run inside a
1309 thread. Use this if you have a slow script to keep Conky updat-
1310 ing. You should make the interval slightly longer then the time
1311 it takes your script to execute. For example, if you have a
1312 script that take 5 seconds to execute, you should make the in-
1313 terval at least 6 seconds. See also $execi.
1317 Move text over by N pixels. See also $voffset.
1320 rss url delay_in_minutes action item_num
1321 Download and parse RSS feeds. Action may be one of the follow-
1322 ing: feed_title, item_title (with num par), item_desc (with num
1323 par) and item_titles.
1326 tab (width, (start))
1327 Puts a tab of the specified width, starting from column 'start'.
1330 tail logfile lines (interval)
1331 Displays last N lines of supplied text text file. If interval is
1332 not supplied, Conky assumes 2x Conky's interval. Max of 30 lines
1333 can be displayed, or until the text buffer is filled.
1337 Local time, see man strftime to get more information about for-
1342 Display time in UTC (universal coordinate time).
1345 tztime (timezone) (format)
1346 Local time for specified timezone, see man strftime to get more
1347 information about format. The timezone argument is specified in
1348 similar fashion as TZ environment variable. For hints, look in
1349 /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
1353 Total download, overflows at 4 GB on Linux with 32-bit arch and
1354 there doesn't seem to be a way to know how many times it has al-
1355 ready done that before conky has started.
1359 This takes arguments in the form:top (name) (number) Basically,
1360 processes are ranked from highest to lowest in terms of cpu us-
1361 age, which is what (num) represents. The types are: "name",
1362 "pid", "cpu", "mem", "mem_res", "mem_vsize", and "time". There
1363 can be a max of 10 processes listed.
1367 Same as top, except sorted by mem usage instead of cpu
1371 Total upload, this one too, may overflow
1374 updates Number of updates
1379 Upload speed in kilobytes
1383 Upload speed in kilobytes with one decimal
1386 upspeedgraph net (height),(width) (gradient colour 1) (gradient colour
1388 Upload speed graph, colours defined in hex, minus the #. If
1389 scale is non-zero, it becomes the scale for the graph.
1396 Uptime in a shorter format
1400 Number of users logged in
1404 Lists the names of the users logged in
1408 Lists the consoles in use
1412 Lists how long users have been logged in for
1416 Change vertical offset by N pixels. Negative values will cause
1417 text to overlap. See also $offset.
1421 Returns CPU #n's voltage in mV. CPUs are counted from 1. If
1422 omitted, the parameter defaults to 1.
1426 Returns CPU #n's voltage in V. CPUs are counted from 1. If omit-
1427 ted, the parameter defaults to 1.
1431 Wireless access point ESSID (Linux only)
1435 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1438 wireless_bitrate net
1439 Wireless bitrate (ie 11 Mb/s) (Linux only)
1443 Wireless access point MAC address (Linux only)
1446 wireless_link_qual net
1447 Wireless link quality (Linux only)
1450 wireless_link_qual_max net
1451 Wireless link quality maximum value (Linux only)
1454 wireless_link_qual_perc net
1455 Wireless link quality in percents (Linux only)
1458 wireless_link_bar (height), (width) net
1459 Wireless link quality bar (Linux only)
1463 Artist in current XMMS2 song
1467 Album in current XMMS2 song
1471 Title in current XMMS2 song
1475 Genre in current XMMS2 song
1479 Comment in current XMMS2 song
1487 Transport plugin used
1491 Full path to current song
1495 Track number in current XMMS2 song
1499 Bitrate of current song
1503 XMMS2 id of current song
1507 Duration of current song
1515 Size of current song
1519 Percent of song's progress
1523 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1526 xmms2_bar (height),(width)
1527 Bar of XMMS2's progress
1531 Prints the song name in either the form "artist - title" or file
1532 name, depending on whats available
1536 conky -t '${time %D %H:%M}' -o -u 30
1537 Start Conky in its own window with date and clock as text and 30
1538 sec update interval.
1540 conky -a top_left -x 5 -y 500 -d
1541 Start Conky to background at coordinates (5, 500).
1544 ~/.conkyrc default configuration file
1547 Drawing to root or some other desktop window directly doesn't work with
1548 all window managers. Especially doesn't work well with Gnome and it has
1549 been reported that it doesn't work with KDE either. Nautilus can be
1550 disabled from drawing to desktop with program gconf-editor. Uncheck
1551 show_desktop in /apps/nautilus/preferences/. There is -w switch in
1552 Conky to set some specific window id. You might find xwininfo -tree
1553 useful to find the window to draw to. You can also use -o argument
1554 which makes Conky to create its own window. If you do try running Conky
1555 in its own window, be sure to read up on the own_window_type settings
1559 <http://conky.sourceforge.net/>
1561 <http://www.sourceforge.net/projects/conky>
1563 #conky on irc.freenode.net
1566 Copyright (c) 2005-2008 Brenden Matthews, Philip Kovacs, et. al. Any
1567 original torsmo code is licensed under the BSD license (see LICENSE.BSD
1568 for a copy). All code written since the fork of torsmo is licensed un-
1569 der the GPL (see LICENSE.GPL for a copy), except where noted different-
1570 ly (such as in portmon code, timed thread code, and audacious code
1571 which are LGPL, and prss which is an MIT-style license).
1574 The Conky dev team (see AUTHORS for a full list of contributors).