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 the torsmo code.
14 Since it's original conception, Conky has changed a fair bit from it's
15 predecessor. Conky can display just about anything, either on your
16 root desktop or in it's 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 de-
21 veloper 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 For users compiling from source, make sure you have the X development
28 libraries installed. This should be a package along the lines of
29 "libx11-dev or xorg-x11-dev".
31 Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-
32 admin/conky" for installation. There is also usually an up-to-date
33 ebuild within Conky's package or in Svn.
35 Debian,etc. users -- Conky will be in Debian's repositories soon (by
36 mid-September, hopefully), and then Ubuntu shortly thereafter. Until
37 then, "dpkg -i" the .deb package to install.
39 Example to compile and run Conky with all optional components (note
40 that some configure options may differ for your system):
42 sh autogen.sh # Only required if building from SVN
44 ./configure --prefix=/usr --mandir=/usr/share/man --in-
45 fodir=/usr/share/info --datadir=/usr/share --sysconfdir=/etc --local-
46 statedir=/var/lib --disable-own-window --enable-audacious[=yes|no|lega-
47 cy] --enable-bmpx --disable-hddtemp --disable-mpd --enable-xmms2 --dis-
48 able-portmon --disable-network --enable-debug --disable-x11 --dis-
49 able-double-buffer --disable-xdamage --disable-xft
53 make install # Optional
57 Conky probably doesn't compile with compilers other than gcc and icc.
58 It doesn't compile with C89 compiler and not even with pure C99. It
59 uses a few things that might not exist: strdup(), strcasecmp(), strn-
60 casecmp(), optarg variable with getopt() and long long (not in C89).
61 Crashes in file system statistics stuff when compiled with icc, I don't
64 You can disable 'drawing to own window' feature in case you don't need
65 it by passing --disable-own-window to configure -script.
69 Conky is generally very good on resources. However, certain objects in
70 Conky are harder on resources then others. In particular, the $tail,
71 $top, $font, and $graph objects are quite costly in comparison to the
74 If you do use them, please do not complain about memory or CPU usage,
75 unless you think something's seriously wrong (mem leak, etc.).
77 An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1
78 conky". Saves you the trouble of having to kill and then restart. You
79 can now also do the same with SIGHUP.
81 IMPORTANT: For previous Conky users, Conky 1.3 no longer supports the
82 metar stuff. mdsplib was causing way too many problems. Hopefully
83 there'll be a better solution in Conky 2.x...
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}_{left,right} or none
98 Use double buffering (eliminates "flicker")
102 Config file to load instead of $HOME/.conkyrc
106 Daemonize Conky, aka fork to background
114 Prints command line help and exits
118 Create own window to draw
122 Text to render, remember single quotes, like -t ' $uptime '
125 -u | --interval=SECONDS
129 -w | --window-id=WIN_ID
141 CONFIGURATION SETTINGS
142 Default configuration file is $HOME/.conkyrc (can be changed from
143 conky.c among other things). See conkyrc.sample. If installing from De-
144 bian package, this should be in /usr/share/doc/conky/examples ("gunzip
145 conkyrc.sample.gz" to get conkyrc.sample).
147 You might want to copy it to $HOME/.conkyrc and then start modifying
148 it. Other configs can be found at http://conky.sf.net
151 Aligned position on screen, may be top_left, top_right, top_mid-
152 dle, bottom_left, bottom_right, bottom_middle, middle_left, mid-
153 dle_right, or none (also can be abreviated as tl, tr, tm, bl,
158 Boolean value, if true, Conky will be forked to background when
163 Border margin in pixels
167 Border width in pixels
170 color0 A color variable for use inside TEXT segments
173 color1 A color variable for use inside TEXT segments
176 color2 A color variable for use inside TEXT segments
179 color3 A color variable for use inside TEXT segments
182 color4 A color variable for use inside TEXT segments
185 color5 A color variable for use inside TEXT segments
188 color6 A color variable for use inside TEXT segments
191 color7 A color variable for use inside TEXT segments
194 color8 A color variable for use inside TEXT segments
197 color9 A color variable for use inside TEXT segments
201 The number of samples to average for CPU monitoring
205 If true, cpu in top will show usage of one processor's power. If
206 false, cpu in top will show the usage of all processors' power
211 Default color and border color
214 default_outline_color
215 Default outline color
219 Default shading color and border's shading color
223 Use the Xdbe extension? (eliminates flicker) It is highly recom-
224 mended to use own window with this one so double buffer won't be
229 Draw borders around text?
233 Draw borders around graphs?
244 font Font name in X, xfontsel can be used to get a nice font
247 gap_x Gap, in pixels, between right or left border of screen, same as
248 passing -x at command line, e.g. gap_x 10
251 gap_y Gap, in pixels, between top or bottom border of screen, same as
252 passing -y at command line, e.g. gap_y 10.
255 imap Default global IMAP server. Arguments are: "host user pass [-i
256 interval] [-f folder] [-p port] [-e command]". Default port is
257 143, default folder is 'INBOX', default interval is 5 minutes.
258 If the password is supplied as '*', you will be prompted to en-
259 ter the password when Conky starts.
263 Mail spool for mail checking
266 max_port_monitor_connections
267 Allow each port monitor to track at most this many connections
268 (if 0 or not set, default is 256)
272 Maximum number of special things, e.g. fonts, offsets, aligns,
273 etc. (default is 512)
277 Maximum size of user text buffer, i.e. layout below TEXT line in
278 config file (default is 16384 bytes)
281 text_buffer_size bytes
282 Size of the standard text buffer (default is 128 bytes). This
283 buffer is used for intermediary text, such as individual lines,
284 output from $exec vars, and various other variables. Increasing
285 the size of this buffer can drastically reduce Conky's perfor-
286 mance, but will allow for more text display per variable. The
287 size of this buffer cannot be smaller than the default value of
292 Maximum width of window
295 minimum_size width (height)
296 Minimum size of window
311 music_player_interval
312 Music player thread update interval (defaults to Conky's update
317 The number of samples to average for net data
321 Substract (file system) buffers from used memory?
325 Force UTF8? requires XFT
329 Boolean, create own window to draw?
333 Manually set the WM_CLASS name. Defaults to "Conky".
336 own_window_colour colour
337 If own_window_transparent no, set a specified background colour
338 (defaults to black). Takes either a hex value (#ffffff) or a
339 valid RGB name (see /usr/lib/X11/rgb.txt)
342 own_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager
343 If own_window is yes, you may use these window manager hints to
344 affect the way Conky displays. Notes: Use own_window_type desk-
345 top as another way to implement many of these hints implicitly.
346 If you use own_window_type override, window manager hints have
347 no meaning and are ignored.
351 Manually set the window name. Defaults to "<hostname> - conky".
354 own_window_transparent
355 Boolean, set pseudo-transparency?
359 if own_window is yes, you may specify type normal, desktop or
360 override (default: normal). Desktop windows are special windows
361 that have no window decorations; are always visible on your
362 desktop; do not appear in your pager or taskbar; and are sticky
363 across all workspaces. Override windows are not under the con-
364 trol of the window manager. Hints are ignored. This type of win-
365 dow can be useful for certain situations.
369 Print text to stdout.
373 Pad percentages to this many decimals (0 = no padding)
376 pop3 Default global POP3 server. Arguments are: "host user pass [-i
377 interval] [-p port] [-e command]". Default port is 110, default
378 interval is 5 minutes. If the password is supplied as '*', you
379 will be prompted to enter the password when Conky starts.
383 Shortens units to a single character (kiB->k, GiB->G, etc.). De-
388 Border stippling (dashing) in pixels
392 Total number of times for Conky to update before quitting. Zero
393 makes Conky run forever
397 Update interval in seconds
401 Boolean value, if true, text is rendered in upper case
405 Adds spaces around certain objects to stop them from moving oth-
406 er things around. Arguments are left, right, and none (default).
407 The old true/false values are deprecated and default to
408 right/none respectively. Note that this only helps if you are
409 using a mono font, such as Bitstream Vera Sans Mono.
413 Use Xft (anti-aliased font and stuff)
417 Alpha of Xft font. Must be a value at or between 1 and 0.
424 TEXT After this begins text to be formatted on screen
428 Colors are parsed using XParsecolor(), there might be a list of them:
429 /usr/X11R6/lib/X11/rgb.txt. Also, <http://sedition.com/perl/rgb.html>.
430 Color can be also in #rrggbb format (hex). Note that when displaying
431 bytes, power is 1024 and not 1000 so 1M really means 1024*1024 bytes
435 IP address for an interface
439 IP addresses for an interface (if one - works like addr). Linux
444 ACPI ac adapter state.
452 ACPI temperature in C.
456 ACPI temperature in F.
460 CPU temperature from therm_adt746x
464 Fan speed from therm_adt746x
468 Right-justify text, with space of N
476 Display APM AC adapter status (FreeBSD only)
480 Display APM battery life in percent (FreeBSD only)
484 Display remaining APM battery life in hh:mm:ss or "unknown" if
485 AC adapterstatus is on-line or charging (FreeBSD only)
488 audacious_bar (height),(width)
493 Bitrate of current tune
497 Number of audio channels of current tune
501 Full path and filename of current tune
505 Sampling frequency of current tune
509 Total length of current tune as MM:SS
512 audacious_length_seconds
513 Total length of current tune in seconds
516 audacious_playlist_position
517 Playlist position of current tune
520 audacious_playlist_length
521 Number of tunes in playlist
525 Position of current tune (MM:SS)
528 audacious_position_seconds
529 Position of current tune in seconds
533 Player status (Playing/Paused/Stopped/Not running)
536 audacious_title (max length)
537 Title of current tune with optional maximum length specifier
541 Battery status and remaining percentage capacity of ACPI or APM
542 battery. ACPI battery number can be given as argument (default
546 battery_bar (height),(width) (num)
547 Battery percentage remaining of ACPI battery in a bar. ACPI bat-
548 tery number can be given as argument (default is BAT0).
551 battery_percent (num)
552 Battery percentage remaining for ACPI battery. ACPI battery num-
553 ber can be given as argument (default is BAT0).
557 Battery charge/discharge time remaining of ACPI battery. ACPI
558 battery number can be given as argument (default is BAT0).
562 Artist in current BMPx track
566 Album in current BMPx track
570 Title of the current BMPx track
574 Track number of the current BMPx track
578 Bitrate of the current BMPx track
582 URI of the current BMPx track
586 Amount of memory buffered
589 cached Amount of memory cached
593 Change drawing color to color
596 color0 Change drawing color to color0 configuration option
599 color1 Change drawing color to color1 configuration option
602 color2 Change drawing color to color2 configuration option
605 color3 Change drawing color to color3 configuration option
608 color4 Change drawing color to color4 configuration option
611 color5 Change drawing color to color5 configuration option
614 color6 Change drawing color to color6 configuration option
617 color7 Change drawing color to color7 configuration option
620 color8 Change drawing color to color8 configuration option
623 color9 Change drawing color to color9 configuration option
635 CPU architecture Conky was built for
639 CPU usage in percents. For SMP machines, the CPU number can be
640 provided as an argument. ${cpu cpu0} is the total usage, and
641 ${cpu cpuX} (X >= 1) are individual CPUs.
644 cpubar (cpu number) (height),(width)
645 Bar that shows CPU usage, height is bar's height in pixels. See
646 $cpu for more info on SMP.
649 cpugraph (cpu number) (height),(width) (gradient colour 1) (gradient
651 CPU usage graph, with optional colours in hex, minus the #. See
652 $cpu for more info on SMP.
656 Displays current disk IO. Device is optional, and takes the form
657 of sda for /dev/sda. Individual partitions are allowed.
660 diskiograph (device) (height),(width) (gradient colour 1) (gradient
662 Disk IO graph, colours defined in hex, minus the #. If scale is
663 non-zero, it becomes the scale for the graph.
667 Displays current disk IO for reads. Device as in diskio.
670 diskiograph_read (device) (height),(width) (gradient colour 1) (gradi-
671 ent colour 2) (scale)
672 Disk IO graph for reads, colours defined in hex, minus the #. If
673 scale is non-zero, it becomes the scale for the graph. Device as
677 diskio_write (device)
678 Displays current disk IO for writes. Device as in diskio.
681 diskiograph_write (device) (height),(width) (gradient colour 1) (gradi-
682 ent colour 2) (scale)
683 Disk IO graph for writes, colours defined in hex, minus the #.
684 If scale is non-zero, it becomes the scale for the graph. Device
689 Download speed in kilobytes
693 Download speed in kilobytes with one decimal
696 downspeedgraph net (height),(width) (gradient colour 1) (gradient
698 Download speed graph, colours defined in hex, minus the #. If
699 scale is non-zero, it becomes the scale for the graph.
702 else Text to show if any of the above are not true
706 Current entropy available for crypto freaks
709 entropy_bar (height),(width)
710 Normalized bar of available entropy for crypto freaks
714 Total size of system entropy pool for crypto freaks
718 Executes a shell command and displays the output in conky. warn-
719 ing: this takes a lot more resources than other variables. I'd
720 recommend coding wanted behaviour in C and posting a patch.
724 Executes a shell command and displays the output in conky. warn-
725 ing: this takes a lot more resources than other variables. I'd
726 recommend coding wanted behaviour in C and posting a patch. This
727 differs from $exec in that it parses the output of the command,
728 so you can insert things like ${color red}hi!${color} in your
729 script and have it correctly parsed by Conky. Caveats: Conky
730 parses and evaluates the output of $execp every time Conky
731 loops, and then destroys all the objects. If you try to use any-
732 thing like $execi within an $execp statement, it will function-
733 ally run at the same interval that the $execp statement runs, as
734 it is created and destroyed at every interval.
738 Same as exec, except if the first value return is a value be-
739 tween 0-100, it will use that number for a bar. The size for the
740 bar is currently fixed, but that may change in the future.
744 Same as execbar, but graphs values.
747 execi interval command
748 Same as exec but with specific interval. Interval can't be less
749 than update_interval in configuration. See also $texeci
752 execibar interval command
753 Same as execbar, except with an interval
756 execigraph interval command
757 Same as execigraph, but takes an interval arg graphs values
761 Specify a different font. This new font will apply to the cur-
762 rent line and everything following. You can use a $font with no
763 arguments to change back to the default font (much like with
768 Returns CPU #n's frequency in MHz. CPUs are counted from 1. If
769 omitted, the parameter defaults to 1.
773 Returns CPU #n's frequency in GHz. CPUs are counted from 1. If
774 omitted, the parameter defaults to 1.
778 Returns CPU frequency in MHz, but is calculated by counting to
779 clock cycles to complete an instruction. Only available for
784 Returns CPU frequency in GHz, but is calculated by counting to
785 clock cycles to complete an instruction. Only available for
789 fs_bar (height),(width) fs
790 Bar that shows how much space is used on a file system. height
791 is the height in pixels. fs is any file on that file system.
795 Free space on a file system available for users.
799 Free percentage of space on a file system available for users.
811 File system used space
814 goto x The next element will be printed at position 'x'.
817 hddtemp dev, (host,(port))
818 Displays temperature of a selected hard disk drive as reported
819 by the hddtemp daemon running on host:port. Default host is
820 127.0.0.1, default port is 7634.
823 head logfile lines (interval)
824 Displays first N lines of supplied text text file. If interval
825 is not supplied, Conky assumes 2x Conky's interval. Max of 30
826 lines can be displayed, or until the text buffer is filled.
830 Horizontal line, height is the height in pixels
834 Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omit-
835 ted if you have only one hwmon device. Parameter type is either
836 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Cel-
837 sius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n
838 is number of the sensor. See /sys/class/hwmon/ on your local
842 iconv_start codeset_from codeset_to
843 Convert text from one codeset to another using GNU iconv. Needs
844 to be stopped with iconv_stop.
848 Stop iconv codeset conversion.
852 I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted
853 if you have only one I2C device. Parameter type is either 'in'
854 or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Celsius) or
855 'tempf' (Fahrenheit) meaning temperature. Parameter n is number
856 of the sensor. See /sys/bus/i2c/devices/ on your local computer.
860 If running the i8k kernel driver for Inspiron laptops, displays
861 whether ac power is on, as listed in /proc/i8k (translated to
862 human-readable). Beware that this is by default not enabled by
867 If running the i8k kernel driver for Inspiron laptops, displays
868 the bios version as listed in /proc/i8k.
872 If running the i8k kernel driver for Inspiron laptops, displays
873 the volume buttons status as listed in /proc/i8k.
877 If running the i8k kernel driver for Inspiron laptops, displays
878 the cpu temperature in Celsius, as reported by /proc/i8k.
882 If running the i8k kernel driver for Inspiron laptops, displays
883 the cpu temperature in Fahrenheit, as reported by /proc/i8k.
887 If running the i8k kernel driver for Inspiron laptops, displays
888 the left fan's rate of rotation, in revolutions per minute as
889 listed in /proc/i8k. Beware, some laptops i8k reports these fans
894 If running the i8k kernel driver for Inspiron laptops, displays
895 the left fan status as listed in /proc/i8k (translated to human-
896 readable). Beware, some laptops i8k reports these fans in re-
901 If running the i8k kernel driver for Inspiron laptops, displays
902 the right fan's rate of rotation, in revolutions per minute as
903 listed in /proc/i8k. Beware, some laptops i8k reports these fans
908 If running the i8k kernel driver for Inspiron laptops, displays
909 the right fan status as listed in /proc/i8k (translated to hu-
910 man-readable). Beware, some laptops i8k reports these fans in
915 If running the i8k kernel driver for Inspiron laptops, displays
916 your laptop serial number as listed in /proc/i8k.
920 If running the i8k kernel driver for Inspiron laptops, displays
921 the version formatting of /proc/i8k.
925 If running the IBM ACPI, displays the fan speed.
929 If running the IBM ACPI, displays the temperatures from the IBM
930 temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
935 If running the IBM ACPI, displays the "master" volume, con-
936 trolled by the volume keys (0-14).
940 If running the IBM ACPI, displays the brigtness of the laptops's
945 if conky variable VAR is empty, display everything between
946 $if_empty and the matching $endif
950 if PROCESS is running, display everything $if_running and the
954 if_existing file (string)
955 if FILE exists, display everything between if_existing and the
956 matching $endif. The optional second paramater checks for FILE
957 containing the specified string and prints everything between
958 $if_existing and the matching $endif.
961 if_mounted (mountpoint)
962 if MOUNTPOINT is mounted, display everything between $if_mounted
963 and the matching $endif
966 if_smapi_bat_installed (INDEX)
967 when using smapi, if the battery with index INDEX is installed,
968 display everything between $if_smapi_bat_installed and the
973 if INTERFACE exists and is up, display everything between $if_up
974 and the matching $endif
978 Displays the number of messages in your global IMAP inbox by de-
979 fault. You can define individual IMAP inboxes seperately by
980 passing arguments to this object. Arguments are: "host user pass
981 [-i interval] [-p port] [-e command]". Default port is 143, de-
982 fault interval is 5 minutes. If the password is supplied as '*',
983 you will be prompted to enter the password when Conky starts.
987 Displays the number of unseen messages in your global IMAP inbox
988 by default. You can define individual IMAP inboxes seperately by
989 passing arguments to this object. Arguments are: "host user pass
990 [-i interval] [-p port] [-e command]". Default port is 143, de-
991 fault interval is 5 minutes. If the password is supplied as '*',
992 you will be prompted to enter the password when Conky starts.
995 kernel Kernel version
999 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
1000 5 minutes and 3 for past 15 minutes.
1004 Machine, i686 for example
1007 mails (mailbox) (interval)
1008 Mail count in the specified mailbox or your mail spool if not.
1009 Both mbox and maildir type mailboxes are supported. You can use
1010 a program like fetchmail to get mails from some server using
1011 your favourite protocol. See also new_mails.
1014 mboxscan (-n number of messages to print) (-fw from width) (-sw subject
1016 Print a summary of recent messages in an mbox format mailbox.
1017 mbox parameter is the filename of the mailbox (can be encapsu-
1018 lated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
1021 mem Amount of memory in use
1024 membar (height),(width)
1025 Bar that shows amount of memory in use
1028 memmax Total amount of memory
1032 Percentage of memory in use
1036 Artist in current MPD song must be enabled at compile
1040 Album in current MPD song
1043 mpd_bar (height),(width)
1044 Bar of mpd's progress
1048 Bitrate of current song
1052 Playing, stopped, et cetera.
1055 mpd_title (max length)
1056 Title of current MPD song
1072 Percent of song's progress
1076 Random status (On/Off)
1080 Repeat status (On/Off)
1084 Prints the MPD track field
1088 Prints the MPD name field
1092 Prints the file name of the current MPD song
1096 Prints the song name in either the form "artist - title" or file
1097 name, depending on whats available
1100 new_mails (mailbox) (interval)
1101 Unread mail count in the specified mailbox or mail spool if not.
1102 Both mbox and maildir type mailboxes are supported.
1109 outlinecolor (color)
1110 Change outline color
1114 If running on Apple powerbook/ibook, display information on bat-
1115 tery status. The item parameter specifies, what information to
1116 display. Exactly one item must be specified. Valid items are:
1118 status: Display if battery is fully charged, charging, discharg-
1119 ing or absent (running on AC)
1120 percent: Display charge of battery in percent, if charging or
1121 discharging. Nothing will be displayed, if battery is fully
1123 time: Display the time remaining until the battery will be fully
1124 charged or discharged at current rate. Nothing is displayed, if
1125 battery is absent or if it's present but fully charged and not
1129 platform (dev) type n
1130 Platform sensor from sysfs (Linux 2.6). Parameter dev may be
1131 omitted if you have only one platform device. Platform type is
1132 either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp'
1133 (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter
1134 n is number of the sensor. See /sys/bus/platform/devices/ on
1135 your local computer.
1139 Displays the number of unseen messages in your global POP3 inbox
1140 by default. You can define individual POP3 inboxes seperately by
1141 passing arguments to this object. Arguments are: "host user pass
1142 [-i interval] [-p port] [-e command]". Default port is 110, de-
1143 fault interval is 5 minutes. If the password is supplied as '*',
1144 you will be prompted to enter the password when Conky starts.
1148 Displays the amount of space (in MiB, 2^20) used in your global
1149 POP3 inbox by default. You can define individual POP3 inboxes
1150 seperately by passing arguments to this object. Arguments are:
1151 "host user pass [-i interval] [-p port] [-e command]". Default
1152 port is 110, default interval is 5 minutes. If the password is
1153 supplied as '*', you will be prompted to enter the password when
1157 pre_exec shell command
1158 Executes a shell command one time before conky displays anything
1159 and puts output as text.
1163 Total processes (sleeping and running)
1167 Running processes (not sleeping), requires Linux 2.6
1171 Change shading color
1175 when using smapi, display contents of the /sys/devices/plat-
1176 form/smapi directory. ARGS are either '(FILENAME)' or 'bat (IN-
1177 DEX) (FILENAME)' to display the corresponding files' content.
1178 This is a very raw method of accessing the smapi values. When
1179 available, better use one of the smapi_* variables instead.
1182 smapi_bat_perc (INDEX)
1183 when using smapi, display the remaining capacity in percent of
1184 the battery with index INDEX. This is a separate variable be-
1185 cause it supports the 'use_spacer' configuration option.
1188 smapi_bat_bar (INDEX),(height),(width)
1189 when using smapi, display the remaining capacity of the battery
1190 with index INDEX as a bar.
1194 Stippled (dashed) horizontal line
1197 swapbar (height),(width)
1198 Bar that shows amount of swap in use
1201 swap Amount of swap in use
1205 Total amount of swap
1209 Percentage of swap in use
1213 System name, Linux for example
1216 tcp_portmon port_begin port_end item (index) (ip4 only at present)
1217 TCP port monitor for specified local ports. Port numbers must be
1218 in the range 1 to 65535. Valid items are:
1220 count - total number of connections in the range
1221 rip - remote ip address
1222 rhost - remote host name
1223 rport - remote port number
1224 rservice - remote service name from /etc/services
1225 lip - local ip address
1226 lhost - local host name
1227 lport - local port number
1228 lservice - local service name from /etc/services
1230 The connection index provides you with access to each connection
1231 in the port monitor. The monitor will return information for in-
1232 dex values from 0 to n-1 connections. Values higher than n-1 are
1233 simply ignored. For the "count" item, the connection index must
1234 be omitted. It is required for all other items.
1237 ${tcp_portmon 6881 6999 count} - displays the number of connec-
1238 tions in the bittorrent port range
1239 ${tcp_portmon 22 22 rip 0} - displays the remote host ip of the
1240 first sshd connection
1241 ${tcp_portmon 22 22 rip 9} - displays the remote host ip of the
1242 tenth sshd connection
1243 ${tcp_portmon 1 1024 rhost 0} - displays the remote host name of
1244 the first connection on a privileged port
1245 ${tcp_portmon 1 1024 rport 4} - displays the remote host port of
1246 the fifth connection on a privileged port
1247 ${tcp_portmon 1 65535 lservice 14} - displays the local service
1248 name of the fifteenth connection in the range of all ports
1250 Note that port monitor variables which share the same port range
1251 actually refer to the same monitor, so many references to a sin-
1252 gle port range for different items and different indexes all use
1253 the same monitor internally. In other words, the program avoids
1254 creating redundant monitors.
1256 texeci interval command
1257 Runs a command at an interval inside a thread and displays the
1258 output. Same as $execi, except the command is run inside a
1259 thread. Use this if you have a slow script to keep Conky updat-
1260 ing. You should make the interval slightly longer then the time
1261 it takes your script to execute. For example, if you have a
1262 script that take 5 seconds to execute, you should make the in-
1263 terval at least 6 seconds. See also $execi.
1267 Move text over by N pixels. See also $voffset.
1270 rss url delay_in_minutes action item_num
1271 Download and parse RSS feeds. Action may be one of the follow-
1272 ing: feed_title, item_title (with num par), item_desc (with num
1273 par) and item_titles.
1276 tab (width, (start))
1277 Puts a tab of the specified width, starting from column 'start'.
1280 tail logfile lines (interval)
1281 Displays last N lines of supplied text text file. If interval is
1282 not supplied, Conky assumes 2x Conky's interval. Max of 30 lines
1283 can be displayed, or until the text buffer is filled.
1287 Local time, see man strftime to get more information about for-
1292 Display time in UTC (universal coordinate time).
1295 tztime (timezone) (format)
1296 Local time for specified timezone, see man strftime to get more
1297 information about format. The timezone argument is specified in
1298 similar fashion as TZ environment variable. For hints, look in
1299 /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
1303 Total download, overflows at 4 GB on Linux with 32-bit arch and
1304 there doesn't seem to be a way to know how many times it has al-
1305 ready done that before conky has started.
1309 This takes arguments in the form:top (name) (number) Basically,
1310 processes are ranked from highest to lowest in terms of cpu us-
1311 age, which is what (num) represents. The types are: "name",
1312 "pid", "cpu", "mem", and "time". There can be a max of 10 pro-
1317 Same as top, except sorted by mem usage instead of cpu
1321 Total upload, this one too, may overflow
1324 updates Number of updates
1329 Upload speed in kilobytes
1333 Upload speed in kilobytes with one decimal
1336 upspeedgraph net (height),(width) (gradient colour 1) (gradient colour
1338 Upload speed graph, colours defined in hex, minus the #. If
1339 scale is non-zero, it becomes the scale for the graph.
1346 Uptime in a shorter format
1350 Number of users logged in
1354 Lists the names of the users logged in
1358 Lists the consoles in use
1362 Lists how long users have been logged in for
1366 Change vertical offset by N pixels. Negative values will cause
1367 text to overlap. See also $offset.
1371 Returns CPU #n's voltage in mV. CPUs are counted from 1. If
1372 omitted, the parameter defaults to 1.
1376 Returns CPU #n's voltage in V. CPUs are counted from 1. If omit-
1377 ted, the parameter defaults to 1.
1381 Wireless access point ESSID (Linux only)
1385 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1388 wireless_bitrate net
1389 Wireless bitrate (ie 11 Mb/s) (Linux only)
1393 Wireless access point MAC address (Linux only)
1396 wireless_link_qual net
1397 Wireless link quality (Linux only)
1400 wireless_link_qual_max net
1401 Wireless link quality maximum value (Linux only)
1404 wireless_link_qual_perc net
1405 Wireless link quality in percents (Linux only)
1408 wireless_link_bar (height), (width) net
1409 Wireless link quality bar (Linux only)
1413 Artist in current XMMS2 song
1417 Album in current XMMS2 song
1421 Title in current XMMS2 song
1425 Genre in current XMMS2 song
1429 Comment in current XMMS2 song
1437 Transport plugin used
1441 Full path to current song
1445 Track number in current XMMS2 song
1449 Bitrate of current song
1453 XMMS2 id of current song
1457 Duration of current song
1465 Size of current song
1469 Percent of song's progress
1473 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1476 xmms2_bar (height),(width)
1477 Bar of XMMS2's progress
1481 Prints the song name in either the form "artist - title" or file
1482 name, depending on whats available
1486 conky -t '${time %D %H:%M}' -o -u 30
1487 Start Conky in its own window with date and clock as text and 30
1488 sec update interval.
1490 conky -a top_left -x 5 -y 500 -d
1491 Start Conky to background at coordinates (5, 500).
1494 ~/.conkyrc default configuration file
1497 Drawing to root or some other desktop window directly doesn't work with
1498 all window managers. Especially doesn't work well with Gnome and it has
1499 been reported that it doesn't work with KDE either. Nautilus can be
1500 disabled from drawing to desktop with program gconf-editor. Uncheck
1501 show_desktop in /apps/nautilus/preferences/. There is -w switch in
1502 Conky to set some specific window id. You might find xwininfo -tree
1503 useful to find the window to draw to. You can also use -o argument
1504 which makes Conky to create its own window.
1507 <http://conky.sourceforge.net>
1509 <http://www.sourceforge.net/projects/conky>
1511 #conky on irc.freenode.net
1514 The Conky dev team. What's up now!