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 Border stippling (dashing) in pixels
396 Total number of times for Conky to update before quitting. Zero
397 makes Conky run forever
401 Update interval in seconds
405 Boolean value, if true, text is rendered in upper case
409 Adds spaces around certain objects to stop them from moving oth-
410 er things around. Arguments are left, right, and none (default).
411 The old true/false values are deprecated and default to
412 right/none respectively. Note that this only helps if you are
413 using a mono font, such as Bitstream Vera Sans Mono.
417 Use Xft (anti-aliased font and stuff)
421 Alpha of Xft font. Must be a value at or between 1 and 0.
428 TEXT After this begins text to be formatted on screen
432 Colors are parsed using XParsecolor(), there might be a list of them:
433 /usr/share/X11/rgb.txt. Also, <http://sedition.com/perl/rgb.html>.
434 Color can be also in #rrggbb format (hex).
437 IP address for an interface
441 IP addresses for an interface (if one - works like addr). Linux
446 ACPI ac adapter state.
454 ACPI temperature in C.
458 ACPI temperature in F.
462 CPU temperature from therm_adt746x
466 Fan speed from therm_adt746x
470 Right-justify text, with space of N
478 Display APM AC adapter status (FreeBSD only)
482 Display APM battery life in percent (FreeBSD only)
486 Display remaining APM battery life in hh:mm:ss or "unknown" if
487 AC adapterstatus is on-line or charging (FreeBSD only)
490 audacious_bar (height),(width)
495 Bitrate of current tune
499 Number of audio channels of current tune
503 Full path and filename of current tune
507 Sampling frequency of current tune
511 Total length of current tune as MM:SS
514 audacious_length_seconds
515 Total length of current tune in seconds
518 audacious_playlist_position
519 Playlist position of current tune
522 audacious_playlist_length
523 Number of tunes in playlist
527 Position of current tune (MM:SS)
530 audacious_position_seconds
531 Position of current tune in seconds
535 Player status (Playing/Paused/Stopped/Not running)
538 audacious_title (max length)
539 Title of current tune with optional maximum length specifier
543 Battery status and remaining percentage capacity of ACPI or APM
544 battery. ACPI battery number can be given as argument (default
548 battery_bar (height),(width) (num)
549 Battery percentage remaining of ACPI battery in a bar. ACPI bat-
550 tery number can be given as argument (default is BAT0).
553 battery_percent (num)
554 Battery percentage remaining for ACPI battery. ACPI battery num-
555 ber can be given as argument (default is BAT0).
559 Battery charge/discharge time remaining of ACPI battery. ACPI
560 battery number can be given as argument (default is BAT0).
564 Artist in current BMPx track
568 Album in current BMPx track
572 Title of the current BMPx track
576 Track number of the current BMPx track
580 Bitrate of the current BMPx track
584 URI of the current BMPx track
588 Amount of memory buffered
591 cached Amount of memory cached
595 Change drawing color to color
598 color0 Change drawing color to color0 configuration option
601 color1 Change drawing color to color1 configuration option
604 color2 Change drawing color to color2 configuration option
607 color3 Change drawing color to color3 configuration option
610 color4 Change drawing color to color4 configuration option
613 color5 Change drawing color to color5 configuration option
616 color6 Change drawing color to color6 configuration option
619 color7 Change drawing color to color7 configuration option
622 color8 Change drawing color to color8 configuration option
625 color9 Change drawing color to color9 configuration option
637 CPU architecture Conky was built for
641 CPU usage in percents. For SMP machines, the CPU number can be
642 provided as an argument. ${cpu cpu0} is the total usage, and
643 ${cpu cpuX} (X >= 1) are individual CPUs.
646 cpubar (cpu number) (height),(width)
647 Bar that shows CPU usage, height is bar's height in pixels. See
648 $cpu for more info on SMP.
651 cpugraph (cpu number) (height),(width) (gradient colour 1) (gradient
653 CPU usage graph, with optional colours in hex, minus the #. See
654 $cpu for more info on SMP.
658 Displays current disk IO. Device is optional, and takes the form
659 of sda for /dev/sda. Individual partitions are allowed.
662 diskiograph (device) (height),(width) (gradient colour 1) (gradient
664 Disk IO graph, colours defined in hex, minus the #. If scale is
665 non-zero, it becomes the scale for the graph.
669 Displays current disk IO for reads. Device as in diskio.
672 diskiograph_read (device) (height),(width) (gradient colour 1) (gradi-
673 ent colour 2) (scale)
674 Disk IO graph for reads, colours defined in hex, minus the #. If
675 scale is non-zero, it becomes the scale for the graph. Device as
679 diskio_write (device)
680 Displays current disk IO for writes. Device as in diskio.
683 diskiograph_write (device) (height),(width) (gradient colour 1) (gradi-
684 ent colour 2) (scale)
685 Disk IO graph for writes, colours defined in hex, minus the #.
686 If scale is non-zero, it becomes the scale for the graph. Device
691 Disk protection status, if supported (needs kernel-patch).
692 Prints either "frozen" or "free " (note the padding).
696 Download speed in kilobytes
700 Download speed in kilobytes with one decimal
703 downspeedgraph net (height),(width) (gradient colour 1) (gradient
705 Download speed graph, colours defined in hex, minus the #. If
706 scale is non-zero, it becomes the scale for the graph.
709 else Text to show if any of the above are not true
713 Current entropy available for crypto freaks
716 entropy_bar (height),(width)
717 Normalized bar of available entropy for crypto freaks
721 Total size of system entropy pool for crypto freaks
725 Executes a shell command and displays the output in conky. warn-
726 ing: this takes a lot more resources than other variables. I'd
727 recommend coding wanted behaviour in C and posting a patch.
731 Same as exec, except if the first value return is a value be-
732 tween 0-100, it will use that number for a bar. The size for the
733 bar is currently fixed, but that may change in the future.
737 Same as execbar, but graphs values.
740 execi interval command
741 Same as exec but with specific interval. Interval can't be less
742 than update_interval in configuration. See also $texeci
745 execibar interval command
746 Same as execbar, except with an interval
749 execigraph interval command
750 Same as execgraph, but takes an interval arg graphs values
754 Executes a shell command and displays the output in conky. warn-
755 ing: this takes a lot more resources than other variables. I'd
756 recommend coding wanted behaviour in C and posting a patch. This
757 differs from $exec in that it parses the output of the command,
758 so you can insert things like ${color red}hi!${color} in your
759 script and have it correctly parsed by Conky. Caveats: Conky
760 parses and evaluates the output of $execp every time Conky
761 loops, and then destroys all the objects. If you try to use any-
762 thing like $execi within an $execp statement, it will function-
763 ally run at the same interval that the $execp statement runs, as
764 it is created and destroyed at every interval.
767 execpi interval command
768 Same as execp but with specific interval. Interval can't be less
769 than update_interval in configuration. Note that the output from
770 the $execpi command is still parsed and evaluated at every in-
775 Specify a different font. This new font will apply to the cur-
776 rent line and everything following. You can use a $font with no
777 arguments to change back to the default font (much like with
782 Returns CPU #n's frequency in MHz. CPUs are counted from 1. If
783 omitted, the parameter defaults to 1.
787 Returns CPU #n's frequency in GHz. CPUs are counted from 1. If
788 omitted, the parameter defaults to 1.
792 Returns CPU frequency in MHz, but is calculated by counting to
793 clock cycles to complete an instruction. Only available for
798 Returns CPU frequency in GHz, but is calculated by counting to
799 clock cycles to complete an instruction. Only available for
803 fs_bar (height),(width) fs
804 Bar that shows how much space is used on a file system. height
805 is the height in pixels. fs is any file on that file system.
809 Free space on a file system available for users.
813 Free percentage of space on a file system available for users.
825 File system used space
828 goto x The next element will be printed at position 'x'.
832 Displays the default route's interface or "multiple"/"none" ac-
836 gw_ip Displays the default gateway's IP or "multiple"/"none" accord-
840 hddtemp dev, (host,(port))
841 Displays temperature of a selected hard disk drive as reported
842 by the hddtemp daemon running on host:port. Default host is
843 127.0.0.1, default port is 7634.
846 head logfile lines (interval)
847 Displays first N lines of supplied text text file. If interval
848 is not supplied, Conky assumes 2x Conky's interval. Max of 30
849 lines can be displayed, or until the text buffer is filled.
853 Horizontal line, height is the height in pixels
857 Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omit-
858 ted if you have only one hwmon device. Parameter type is either
859 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Cel-
860 sius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n
861 is number of the sensor. See /sys/class/hwmon/ on your local
865 iconv_start codeset_from codeset_to
866 Convert text from one codeset to another using GNU iconv. Needs
867 to be stopped with iconv_stop.
871 Stop iconv codeset conversion.
875 I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted
876 if you have only one I2C device. Parameter type is either 'in'
877 or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Celsius) or
878 'tempf' (Fahrenheit) meaning temperature. Parameter n is number
879 of the sensor. See /sys/bus/i2c/devices/ on your local computer.
883 If running the i8k kernel driver for Inspiron laptops, displays
884 whether ac power is on, as listed in /proc/i8k (translated to
885 human-readable). Beware that this is by default not enabled by
890 If running the i8k kernel driver for Inspiron laptops, displays
891 the bios version as listed in /proc/i8k.
895 If running the i8k kernel driver for Inspiron laptops, displays
896 the volume buttons status as listed in /proc/i8k.
900 If running the i8k kernel driver for Inspiron laptops, displays
901 the cpu temperature in Celsius, as reported by /proc/i8k.
905 If running the i8k kernel driver for Inspiron laptops, displays
906 the cpu temperature in Fahrenheit, as reported by /proc/i8k.
910 If running the i8k kernel driver for Inspiron laptops, displays
911 the left fan's rate of rotation, in revolutions per minute as
912 listed in /proc/i8k. Beware, some laptops i8k reports these fans
917 If running the i8k kernel driver for Inspiron laptops, displays
918 the left fan status as listed in /proc/i8k (translated to human-
919 readable). Beware, some laptops i8k reports these fans in re-
924 If running the i8k kernel driver for Inspiron laptops, displays
925 the right fan's rate of rotation, in revolutions per minute as
926 listed in /proc/i8k. Beware, some laptops i8k reports these fans
931 If running the i8k kernel driver for Inspiron laptops, displays
932 the right fan status as listed in /proc/i8k (translated to hu-
933 man-readable). Beware, some laptops i8k reports these fans in
938 If running the i8k kernel driver for Inspiron laptops, displays
939 your laptop serial number as listed in /proc/i8k.
943 If running the i8k kernel driver for Inspiron laptops, displays
944 the version formatting of /proc/i8k.
948 If running the IBM ACPI, displays the fan speed.
952 If running the IBM ACPI, displays the temperatures from the IBM
953 temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
958 If running the IBM ACPI, displays the "master" volume, con-
959 trolled by the volume keys (0-14).
963 If running the IBM ACPI, displays the brigtness of the laptops's
968 if conky variable VAR is empty, display everything between
969 $if_empty and the matching $endif
972 if_gw if there is at least one default gateway, display everything be-
973 tween $if_gw and the matching $endif
977 if PROCESS is running, display everything $if_running and the
981 if_existing file (string)
982 if FILE exists, display everything between if_existing and the
983 matching $endif. The optional second paramater checks for FILE
984 containing the specified string and prints everything between
985 $if_existing and the matching $endif.
988 if_mounted (mountpoint)
989 if MOUNTPOINT is mounted, display everything between $if_mounted
990 and the matching $endif
993 if_smapi_bat_installed (INDEX)
994 when using smapi, if the battery with index INDEX is installed,
995 display everything between $if_smapi_bat_installed and the
1000 if INTERFACE exists and is up, display everything between $if_up
1001 and the matching $endif
1004 imap_messages (args)
1005 Displays the number of messages in your global IMAP inbox by de-
1006 fault. You can define individual IMAP inboxes seperately by
1007 passing arguments to this object. Arguments are: "host user pass
1008 [-i interval] [-p port] [-e command]". Default port is 143, de-
1009 fault interval is 5 minutes. If the password is supplied as '*',
1010 you will be prompted to enter the password when Conky starts.
1014 Displays the number of unseen messages in your global IMAP inbox
1015 by default. You can define individual IMAP inboxes seperately by
1016 passing arguments to this object. Arguments are: "host user pass
1017 [-i interval] [-p port] [-e command]". Default port is 143, de-
1018 fault interval is 5 minutes. If the password is supplied as '*',
1019 you will be prompted to enter the password when Conky starts.
1023 Prints the current ioscheduler used for the given disk name
1024 (i.e. e.g. "hda" or "sdb")
1027 kernel Kernel version
1031 The value of /proc/sys/vm/laptop_mode
1035 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
1036 5 minutes and 3 for past 15 minutes.
1040 Machine, i686 for example
1043 mails (mailbox) (interval)
1044 Mail count in the specified mailbox or your mail spool if not.
1045 Both mbox and maildir type mailboxes are supported. You can use
1046 a program like fetchmail to get mails from some server using
1047 your favourite protocol. See also new_mails.
1050 mboxscan (-n number of messages to print) (-fw from width) (-sw subject
1052 Print a summary of recent messages in an mbox format mailbox.
1053 mbox parameter is the filename of the mailbox (can be encapsu-
1054 lated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
1057 mem Amount of memory in use
1060 membar (height),(width)
1061 Bar that shows amount of memory in use
1064 memmax Total amount of memory
1068 Percentage of memory in use
1072 Artist in current MPD song must be enabled at compile
1076 Album in current MPD song
1079 mpd_bar (height),(width)
1080 Bar of mpd's progress
1084 Bitrate of current song
1088 Playing, stopped, et cetera.
1091 mpd_title (max length)
1092 Title of current MPD song
1108 Percent of song's progress
1112 Random status (On/Off)
1116 Repeat status (On/Off)
1120 Prints the MPD track field
1124 Prints the MPD name field
1128 Prints the file name of the current MPD song
1132 Prints the song name in either the form "artist - title" or file
1133 name, depending on whats available
1137 Print a nameserver from /etc/resolv.conf. Index starts at and
1141 new_mails (mailbox) (interval)
1142 Unread mail count in the specified mailbox or mail spool if not.
1143 Both mbox and maildir type mailboxes are supported.
1150 outlinecolor (color)
1151 Change outline color
1155 If running on Apple powerbook/ibook, display information on bat-
1156 tery status. The item parameter specifies, what information to
1157 display. Exactly one item must be specified. Valid items are:
1159 status: Display if battery is fully charged, charging, discharg-
1160 ing or absent (running on AC)
1161 percent: Display charge of battery in percent, if charging or
1162 discharging. Nothing will be displayed, if battery is fully
1164 time: Display the time remaining until the battery will be fully
1165 charged or discharged at current rate. Nothing is displayed, if
1166 battery is absent or if it's present but fully charged and not
1170 platform (dev) type n
1171 Platform sensor from sysfs (Linux 2.6). Parameter dev may be
1172 omitted if you have only one platform device. Platform type is
1173 either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp'
1174 (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter
1175 n is number of the sensor. See /sys/bus/platform/devices/ on
1176 your local computer.
1180 Displays the number of unseen messages in your global POP3 inbox
1181 by default. You can define individual POP3 inboxes seperately by
1182 passing arguments to this object. Arguments are: "host user pass
1183 [-i interval] [-p port] [-e command]". Default port is 110, de-
1184 fault interval is 5 minutes. If the password is supplied as '*',
1185 you will be prompted to enter the password when Conky starts.
1189 Displays the amount of space (in MiB, 2^20) used in your global
1190 POP3 inbox by default. You can define individual POP3 inboxes
1191 seperately by passing arguments to this object. Arguments are:
1192 "host user pass [-i interval] [-p port] [-e command]". Default
1193 port is 110, default interval is 5 minutes. If the password is
1194 supplied as '*', you will be prompted to enter the password when
1198 pre_exec shell command
1199 Executes a shell command one time before conky displays anything
1200 and puts output as text.
1204 Total processes (sleeping and running)
1208 Running processes (not sleeping), requires Linux 2.6
1212 Change shading color
1216 when using smapi, display contents of the /sys/devices/plat-
1217 form/smapi directory. ARGS are either '(FILENAME)' or 'bat (IN-
1218 DEX) (FILENAME)' to display the corresponding files' content.
1219 This is a very raw method of accessing the smapi values. When
1220 available, better use one of the smapi_* variables instead.
1223 smapi_bat_perc (INDEX)
1224 when using smapi, display the remaining capacity in percent of
1225 the battery with index INDEX. This is a separate variable be-
1226 cause it supports the 'use_spacer' configuration option.
1229 smapi_bat_bar (INDEX),(height),(width)
1230 when using smapi, display the remaining capacity of the battery
1231 with index INDEX as a bar.
1235 Stippled (dashed) horizontal line
1238 swapbar (height),(width)
1239 Bar that shows amount of swap in use
1242 swap Amount of swap in use
1246 Total amount of swap
1250 Percentage of swap in use
1254 System name, Linux for example
1257 tcp_portmon port_begin port_end item (index) (ip4 only at present)
1258 TCP port monitor for specified local ports. Port numbers must be
1259 in the range 1 to 65535. Valid items are:
1261 count - total number of connections in the range
1262 rip - remote ip address
1263 rhost - remote host name
1264 rport - remote port number
1265 rservice - remote service name from /etc/services
1266 lip - local ip address
1267 lhost - local host name
1268 lport - local port number
1269 lservice - local service name from /etc/services
1271 The connection index provides you with access to each connection
1272 in the port monitor. The monitor will return information for in-
1273 dex values from 0 to n-1 connections. Values higher than n-1 are
1274 simply ignored. For the "count" item, the connection index must
1275 be omitted. It is required for all other items.
1278 ${tcp_portmon 6881 6999 count} - displays the number of connec-
1279 tions in the bittorrent port range
1280 ${tcp_portmon 22 22 rip 0} - displays the remote host ip of the
1281 first sshd connection
1282 ${tcp_portmon 22 22 rip 9} - displays the remote host ip of the
1283 tenth sshd connection
1284 ${tcp_portmon 1 1024 rhost 0} - displays the remote host name of
1285 the first connection on a privileged port
1286 ${tcp_portmon 1 1024 rport 4} - displays the remote host port of
1287 the fifth connection on a privileged port
1288 ${tcp_portmon 1 65535 lservice 14} - displays the local service
1289 name of the fifteenth connection in the range of all ports
1291 Note that port monitor variables which share the same port range
1292 actually refer to the same monitor, so many references to a sin-
1293 gle port range for different items and different indexes all use
1294 the same monitor internally. In other words, the program avoids
1295 creating redundant monitors.
1297 texeci interval command
1298 Runs a command at an interval inside a thread and displays the
1299 output. Same as $execi, except the command is run inside a
1300 thread. Use this if you have a slow script to keep Conky updat-
1301 ing. You should make the interval slightly longer then the time
1302 it takes your script to execute. For example, if you have a
1303 script that take 5 seconds to execute, you should make the in-
1304 terval at least 6 seconds. See also $execi.
1308 Move text over by N pixels. See also $voffset.
1311 rss url delay_in_minutes action item_num
1312 Download and parse RSS feeds. Action may be one of the follow-
1313 ing: feed_title, item_title (with num par), item_desc (with num
1314 par) and item_titles.
1317 tab (width, (start))
1318 Puts a tab of the specified width, starting from column 'start'.
1321 tail logfile lines (interval)
1322 Displays last N lines of supplied text text file. If interval is
1323 not supplied, Conky assumes 2x Conky's interval. Max of 30 lines
1324 can be displayed, or until the text buffer is filled.
1328 Local time, see man strftime to get more information about for-
1333 Display time in UTC (universal coordinate time).
1336 tztime (timezone) (format)
1337 Local time for specified timezone, see man strftime to get more
1338 information about format. The timezone argument is specified in
1339 similar fashion as TZ environment variable. For hints, look in
1340 /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
1344 Total download, overflows at 4 GB on Linux with 32-bit arch and
1345 there doesn't seem to be a way to know how many times it has al-
1346 ready done that before conky has started.
1350 This takes arguments in the form:top (name) (number) Basically,
1351 processes are ranked from highest to lowest in terms of cpu us-
1352 age, which is what (num) represents. The types are: "name",
1353 "pid", "cpu", "mem", "mem_res", "mem_vsize", and "time". There
1354 can be a max of 10 processes listed.
1358 Same as top, except sorted by mem usage instead of cpu
1362 Total upload, this one too, may overflow
1365 updates Number of updates
1370 Upload speed in kilobytes
1374 Upload speed in kilobytes with one decimal
1377 upspeedgraph net (height),(width) (gradient colour 1) (gradient colour
1379 Upload speed graph, colours defined in hex, minus the #. If
1380 scale is non-zero, it becomes the scale for the graph.
1387 Uptime in a shorter format
1391 Number of users logged in
1395 Lists the names of the users logged in
1399 Lists the consoles in use
1403 Lists how long users have been logged in for
1407 Change vertical offset by N pixels. Negative values will cause
1408 text to overlap. See also $offset.
1412 Returns CPU #n's voltage in mV. CPUs are counted from 1. If
1413 omitted, the parameter defaults to 1.
1417 Returns CPU #n's voltage in V. CPUs are counted from 1. If omit-
1418 ted, the parameter defaults to 1.
1422 Wireless access point ESSID (Linux only)
1426 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1429 wireless_bitrate net
1430 Wireless bitrate (ie 11 Mb/s) (Linux only)
1434 Wireless access point MAC address (Linux only)
1437 wireless_link_qual net
1438 Wireless link quality (Linux only)
1441 wireless_link_qual_max net
1442 Wireless link quality maximum value (Linux only)
1445 wireless_link_qual_perc net
1446 Wireless link quality in percents (Linux only)
1449 wireless_link_bar (height), (width) net
1450 Wireless link quality bar (Linux only)
1454 Artist in current XMMS2 song
1458 Album in current XMMS2 song
1462 Title in current XMMS2 song
1466 Genre in current XMMS2 song
1470 Comment in current XMMS2 song
1478 Transport plugin used
1482 Full path to current song
1486 Track number in current XMMS2 song
1490 Bitrate of current song
1494 XMMS2 id of current song
1498 Duration of current song
1506 Size of current song
1510 Percent of song's progress
1514 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1517 xmms2_bar (height),(width)
1518 Bar of XMMS2's progress
1522 Prints the song name in either the form "artist - title" or file
1523 name, depending on whats available
1527 conky -t '${time %D %H:%M}' -o -u 30
1528 Start Conky in its own window with date and clock as text and 30
1529 sec update interval.
1531 conky -a top_left -x 5 -y 500 -d
1532 Start Conky to background at coordinates (5, 500).
1535 ~/.conkyrc default configuration file
1538 Drawing to root or some other desktop window directly doesn't work with
1539 all window managers. Especially doesn't work well with Gnome and it has
1540 been reported that it doesn't work with KDE either. Nautilus can be
1541 disabled from drawing to desktop with program gconf-editor. Uncheck
1542 show_desktop in /apps/nautilus/preferences/. There is -w switch in
1543 Conky to set some specific window id. You might find xwininfo -tree
1544 useful to find the window to draw to. You can also use -o argument
1545 which makes Conky to create its own window. If you do try running Conky
1546 in its own window, be sure to read up on the own_window_type settings
1550 <http://conky.sourceforge.net/>
1552 <http://www.sourceforge.net/projects/conky>
1554 #conky on irc.freenode.net
1557 Copyright (c) 2005-2008 Brenden Matthews, Philip Kovacs, et. al. Any
1558 original torsmo code is licensed under the BSD license (see LICENSE.BSD
1559 for a copy). All code written since the fork of torsmo is licensed un-
1560 der the GPL (see LICENSE.GPL for a copy), except where noted different-
1561 ly (such as in portmon code, timed thread code, and audacious code
1562 which are LGPL, and prss which is an MIT-style license).
1565 The Conky dev team (see AUTHORS for a full list of contributors).