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
94 Run Conky in 'quiet mode' (ie. no output)
97 -a | --alignment=ALIGNMENT
98 Text alignment on screen, {top,bottom,middle}_{left,right,mid-
103 Use double buffering (eliminates "flicker")
107 Config file to load instead of $HOME/.conkyrc
111 Daemonize Conky, aka fork to background
119 Prints command line help and exits
123 Create own window to draw
127 Text to render, remember single quotes, like -t ' $uptime '
130 -u | --interval=SECONDS
134 -w | --window-id=WIN_ID
147 Number of times to update Conky (and quit)
150 CONFIGURATION SETTINGS
151 Default configuration file location is $HOME/.conkyrc or
152 ${sysconfdir}/conky/conky.conf. On most systems, sysconfdir is /etc,
153 and you can find the sample config file there (/etc/conky/conky.conf).
155 You might want to copy it to $HOME/.conkyrc and then start modifying
156 it. Other configs can be found at http://conky.sf.net/
159 Aligned position on screen, may be top_left, top_right, top_mid-
160 dle, bottom_left, bottom_right, bottom_middle, middle_left, mid-
161 dle_right, or none (also can be abreviated as tl, tr, tm, bl,
166 Boolean value, if true, Conky will be forked to background when
171 Border margin in pixels
175 Border width in pixels
178 colorN Predefine a color for use inside TEXT segments. Substitute N by
179 a digit between 0 and 9, inclusively. When specifying the color
180 value in hex, omit the leading hash (#).
184 The number of samples to average for CPU monitoring
188 If true, cpu in top will show usage of one processor's power. If
189 false, cpu in top will show the usage of all processors' power
194 Default color and border color
197 default_outline_color
198 Default outline color
202 Default shading color and border's shading color
206 Use the Xdbe extension? (eliminates flicker) It is highly recom-
207 mended to use own window with this one so double buffer won't be
212 Draw borders around text?
216 Draw borders around graphs?
227 font Font name in X, xfontsel can be used to get a nice font
230 gap_x Gap, in pixels, between right or left border of screen, same as
231 passing -x at command line, e.g. gap_x 10
234 gap_y Gap, in pixels, between top or bottom border of screen, same as
235 passing -y at command line, e.g. gap_y 10.
239 How strict should if_up be when testing an interface for being
240 up? The value is one of up, link or address, to check for the
241 interface being solely up, being up and having link or being up,
242 having link and an assigned IP address.
245 imap Default global IMAP server. Arguments are: "host user pass [-i
246 interval] [-f folder] [-p port] [-e command]". Default port is
247 143, default folder is 'INBOX', default interval is 5 minutes.
248 If the password is supplied as '*', you will be prompted to en-
249 ter the password when Conky starts.
253 Mail spool for mail checking
256 max_port_monitor_connections
257 Allow each port monitor to track at most this many connections
258 (if 0 or not set, default is 256)
262 Maximum number of special things, e.g. fonts, offsets, aligns,
263 etc. (default is 512)
267 Maximum size of user text buffer, i.e. layout below TEXT line in
268 config file (default is 16384 bytes)
271 text_buffer_size bytes
272 Size of the standard text buffer (default is 256 bytes). This
273 buffer is used for intermediary text, such as individual lines,
274 output from $exec vars, and various other variables. Increasing
275 the size of this buffer can drastically reduce Conky's perfor-
276 mance, but will allow for more text display per variable. The
277 size of this buffer cannot be smaller than the default value of
282 Maximum width of window
285 minimum_size width (height)
286 Minimum size of window
301 music_player_interval
302 Music player thread update interval (defaults to Conky's update
307 The number of samples to average for net data
311 Substract (file system) buffers from used memory?
315 Force UTF8? requires XFT
319 Boolean, create own window to draw?
323 Manually set the WM_CLASS name. Defaults to "Conky".
326 own_window_colour colour
327 If own_window_transparent no, set a specified background colour
328 (defaults to black). Takes either a hex value (#ffffff) or a
329 valid RGB name (see /usr/lib/X11/rgb.txt)
332 own_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager
333 If own_window is yes, you may use these window manager hints to
334 affect the way Conky displays. Notes: Use own_window_type desk-
335 top as another way to implement many of these hints implicitly.
336 If you use own_window_type override, window manager hints have
337 no meaning and are ignored.
341 Manually set the window name. Defaults to "<hostname> - conky".
344 own_window_transparent
345 Boolean, set pseudo-transparency?
349 if own_window is yes, you may specify type normal, desktop, dock
350 or override (default: normal). Desktop windows are special win-
351 dows that have no window decorations; are always visible on your
352 desktop; do not appear in your pager or taskbar; and are sticky
353 across all workspaces. Override windows are not under the con-
354 trol of the window manager. Hints are ignored. This type of win-
355 dow can be useful for certain situations.
359 Print text to stdout.
363 Pad percentages to this many decimals (0 = no padding)
366 pop3 Default global POP3 server. Arguments are: "host user pass [-i
367 interval] [-p port] [-e command]". Default port is 110, default
368 interval is 5 minutes. If the password is supplied as '*', you
369 will be prompted to enter the password when Conky starts.
373 Shortens units to a single character (kiB->k, GiB->G, etc.). De-
378 Shows the maximum value in scaled graphs.
382 Border stippling (dashing) in pixels
386 Total number of times for Conky to update before quitting. Zero
387 makes Conky run forever
391 Update interval in seconds
395 Boolean value, if true, text is rendered in upper case
399 Adds spaces around certain objects to stop them from moving oth-
400 er things around. Arguments are left, right, and none (default).
401 The old true/false values are deprecated and default to
402 right/none respectively. Note that this only helps if you are
403 using a mono font, such as Bitstream Vera Sans Mono.
407 Use Xft (anti-aliased font and stuff)
411 Alpha of Xft font. Must be a value at or between 1 and 0.
418 TEXT After this begins text to be formatted on screen
422 Colors are parsed using XParsecolor(), there might be a list of them:
423 /usr/share/X11/rgb.txt. Also, <http://sedition.com/perl/rgb.html>.
424 Color can be also in #rrggbb format (hex).
427 IP address for an interface
431 IP addresses for an interface (if one - works like addr). Linux
436 ACPI ac adapter state.
444 ACPI temperature in C.
448 ACPI temperature in F.
452 CPU temperature from therm_adt746x
456 Fan speed from therm_adt746x
460 Right-justify text, with space of N
468 Display APM AC adapter status (FreeBSD only)
472 Display APM battery life in percent (FreeBSD only)
476 Display remaining APM battery life in hh:mm:ss or "unknown" if
477 AC adapterstatus is on-line or charging (FreeBSD only)
480 audacious_bar (height),(width)
485 Bitrate of current tune
489 Number of audio channels of current tune
493 Full path and filename of current tune
497 Sampling frequency of current tune
501 Total length of current tune as MM:SS
504 audacious_length_seconds
505 Total length of current tune in seconds
508 audacious_playlist_position
509 Playlist position of current tune
512 audacious_playlist_length
513 Number of tunes in playlist
517 Position of current tune (MM:SS)
520 audacious_position_seconds
521 Position of current tune in seconds
525 Player status (Playing/Paused/Stopped/Not running)
528 audacious_title (max length)
529 Title of current tune with optional maximum length specifier
533 Battery status and remaining percentage capacity of ACPI or APM
534 battery. ACPI battery number can be given as argument (default
538 battery_bar (height),(width) (num)
539 Battery percentage remaining of ACPI battery in a bar. ACPI bat-
540 tery number can be given as argument (default is BAT0).
543 battery_percent (num)
544 Battery percentage remaining for ACPI battery. ACPI battery num-
545 ber can be given as argument (default is BAT0).
549 Battery charge/discharge time remaining of ACPI battery. ACPI
550 battery number can be given as argument (default is BAT0).
554 Artist in current BMPx track
558 Album in current BMPx track
562 Title of the current BMPx track
566 Track number of the current BMPx track
570 Bitrate of the current BMPx track
574 URI of the current BMPx track
578 Amount of memory buffered
581 cached Amount of memory cached
585 Change drawing color to color
588 colorN Change drawing color to colorN configuration option, where N is
589 a digit between 0 and 9, inclusively.
601 CPU architecture Conky was built for
605 CPU usage in percents. For SMP machines, the CPU number can be
606 provided as an argument. ${cpu cpu0} is the total usage, and
607 ${cpu cpuX} (X >= 1) are individual CPUs.
610 cpubar (cpu number) (height),(width)
611 Bar that shows CPU usage, height is bar's height in pixels. See
612 $cpu for more info on SMP.
615 cpugraph (cpu number) (height),(width) (gradient colour 1) (gradient
617 CPU usage graph, with optional colours in hex, minus the #. See
618 $cpu for more info on SMP.
622 Displays current disk IO. Device is optional, and takes the form
623 of sda for /dev/sda. Individual partitions are allowed.
626 diskiograph (device) (height),(width) (gradient colour 1) (gradient
628 Disk IO graph, colours defined in hex, minus the #. If scale is
629 non-zero, it becomes the scale for the graph.
633 Displays current disk IO for reads. Device as in diskio.
636 diskiograph_read (device) (height),(width) (gradient colour 1) (gradi-
637 ent colour 2) (scale)
638 Disk IO graph for reads, colours defined in hex, minus the #. If
639 scale is non-zero, it becomes the scale for the graph. Device as
643 diskio_write (device)
644 Displays current disk IO for writes. Device as in diskio.
647 diskiograph_write (device) (height),(width) (gradient colour 1) (gradi-
648 ent colour 2) (scale)
649 Disk IO graph for writes, colours defined in hex, minus the #.
650 If scale is non-zero, it becomes the scale for the graph. Device
655 Disk protection status, if supported (needs kernel-patch).
656 Prints either "frozen" or "free " (note the padding).
660 Download speed in KiB
664 Download speed in KiB with one decimal
667 downspeedgraph net (height),(width) (gradient colour 1) (gradient
669 Download speed graph, colours defined in hex, minus the #. If
670 scale is non-zero, it becomes the scale for the graph.
673 else Text to show if any of the above are not true
677 Current entropy available for crypto freaks
680 entropy_bar (height),(width)
681 Normalized bar of available entropy for crypto freaks
685 Total size of system entropy pool for crypto freaks
689 Executes a shell command and displays the output in conky. warn-
690 ing: this takes a lot more resources than other variables. I'd
691 recommend coding wanted behaviour in C and posting a patch.
695 Same as exec, except if the first value return is a value be-
696 tween 0-100, it will use that number for a bar. The size for the
697 bar is currently fixed, but that may change in the future.
701 Same as execbar, but graphs values.
704 execi interval command
705 Same as exec but with specific interval. Interval can't be less
706 than update_interval in configuration. See also $texeci
709 execibar interval command
710 Same as execbar, except with an interval
713 execigraph interval command
714 Same as execgraph, but takes an interval arg graphs values
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. This
721 differs from $exec in that it parses the output of the command,
722 so you can insert things like ${color red}hi!${color} in your
723 script and have it correctly parsed by Conky. Caveats: Conky
724 parses and evaluates the output of $execp every time Conky
725 loops, and then destroys all the objects. If you try to use any-
726 thing like $execi within an $execp statement, it will function-
727 ally run at the same interval that the $execp statement runs, as
728 it is created and destroyed at every interval.
731 execpi interval command
732 Same as execp but with specific interval. Interval can't be less
733 than update_interval in configuration. Note that the output from
734 the $execpi command is still parsed and evaluated at every in-
739 Specify a different font. This new font will apply to the cur-
740 rent line and everything following. You can use a $font with no
741 arguments to change back to the default font (much like with
746 Returns CPU #n's frequency in MHz. CPUs are counted from 1. If
747 omitted, the parameter defaults to 1.
751 Returns CPU #n's frequency in GHz. CPUs are counted from 1. If
752 omitted, the parameter defaults to 1.
756 Returns CPU frequency in MHz, but is calculated by counting to
757 clock cycles to complete an instruction. Only available for
762 Returns CPU frequency in GHz, but is calculated by counting to
763 clock cycles to complete an instruction. Only available for
767 fs_bar (height),(width) fs
768 Bar that shows how much space is used on a file system. height
769 is the height in pixels. fs is any file on that file system.
773 Free space on a file system available for users.
777 Free percentage of space on a file system available for users.
789 File system used space
792 goto x The next element will be printed at position 'x'.
796 Displays the default route's interface or "multiple"/"none" ac-
800 gw_ip Displays the default gateway's IP or "multiple"/"none" accord-
804 hddtemp dev, (host,(port))
805 Displays temperature of a selected hard disk drive as reported
806 by the hddtemp daemon running on host:port. Default host is
807 127.0.0.1, default port is 7634.
810 head logfile lines (interval)
811 Displays first N lines of supplied text text file. If interval
812 is not supplied, Conky assumes 2x Conky's interval. Max of 30
813 lines can be displayed, or until the text buffer is filled.
817 Horizontal line, height is the height in pixels
821 Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omit-
822 ted if you have only one hwmon device. Parameter type is either
823 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Cel-
824 sius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n
825 is number of the sensor. See /sys/class/hwmon/ on your local
829 iconv_start codeset_from codeset_to
830 Convert text from one codeset to another using GNU iconv. Needs
831 to be stopped with iconv_stop.
835 Stop iconv codeset conversion.
839 I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted
840 if you have only one I2C device. Parameter type is either 'in'
841 or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Celsius) or
842 'tempf' (Fahrenheit) meaning temperature. Parameter n is number
843 of the sensor. See /sys/bus/i2c/devices/ on your local computer.
847 If running the i8k kernel driver for Inspiron laptops, displays
848 whether ac power is on, as listed in /proc/i8k (translated to
849 human-readable). Beware that this is by default not enabled by
854 If running the i8k kernel driver for Inspiron laptops, displays
855 the bios version as listed in /proc/i8k.
859 If running the i8k kernel driver for Inspiron laptops, displays
860 the volume buttons status as listed in /proc/i8k.
864 If running the i8k kernel driver for Inspiron laptops, displays
865 the cpu temperature in Celsius, as reported by /proc/i8k.
869 If running the i8k kernel driver for Inspiron laptops, displays
870 the cpu temperature in Fahrenheit, as reported by /proc/i8k.
874 If running the i8k kernel driver for Inspiron laptops, displays
875 the left fan's rate of rotation, in revolutions per minute as
876 listed in /proc/i8k. Beware, some laptops i8k reports these fans
881 If running the i8k kernel driver for Inspiron laptops, displays
882 the left fan status as listed in /proc/i8k (translated to human-
883 readable). Beware, some laptops i8k reports these fans in re-
888 If running the i8k kernel driver for Inspiron laptops, displays
889 the right fan's rate of rotation, in revolutions per minute as
890 listed in /proc/i8k. Beware, some laptops i8k reports these fans
895 If running the i8k kernel driver for Inspiron laptops, displays
896 the right fan status as listed in /proc/i8k (translated to hu-
897 man-readable). Beware, some laptops i8k reports these fans in
902 If running the i8k kernel driver for Inspiron laptops, displays
903 your laptop serial number as listed in /proc/i8k.
907 If running the i8k kernel driver for Inspiron laptops, displays
908 the version formatting of /proc/i8k.
912 If running the IBM ACPI, displays the fan speed.
916 If running the IBM ACPI, displays the temperatures from the IBM
917 temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
922 If running the IBM ACPI, displays the "master" volume, con-
923 trolled by the volume keys (0-14).
927 If running the IBM ACPI, displays the brigtness of the laptops's
932 if conky variable VAR is empty, display everything between
933 $if_empty and the matching $endif
936 if_gw if there is at least one default gateway, display everything be-
937 tween $if_gw and the matching $endif
941 if PROCESS is running, display everything $if_running and the
945 if_existing file (string)
946 if FILE exists, display everything between if_existing and the
947 matching $endif. The optional second paramater checks for FILE
948 containing the specified string and prints everything between
949 $if_existing and the matching $endif.
952 if_mounted (mountpoint)
953 if MOUNTPOINT is mounted, display everything between $if_mounted
954 and the matching $endif
957 if_smapi_bat_installed (INDEX)
958 when using smapi, if the battery with index INDEX is installed,
959 display everything between $if_smapi_bat_installed and the
964 if INTERFACE exists and is up, display everything between $if_up
965 and the matching $endif
969 Displays the number of messages in your global IMAP inbox by de-
970 fault. You can define individual IMAP inboxes seperately by
971 passing arguments to this object. Arguments are: "host user pass
972 [-i interval] [-p port] [-e command]". Default port is 143, de-
973 fault interval is 5 minutes. If the password is supplied as '*',
974 you will be prompted to enter the password when Conky starts.
978 Displays the number of unseen messages in your global IMAP inbox
979 by default. 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 Prints the current ioscheduler used for the given disk name
988 (i.e. e.g. "hda" or "sdb")
991 kernel Kernel version
995 The value of /proc/sys/vm/laptop_mode
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.
1003 loadgraph (height),(width) (gradient colour 1) (gradient colour 2)
1004 Load1 average graph, similar to xload, with optional colours in
1009 Machine, i686 for example
1012 mails (mailbox) (interval)
1013 Mail count in the specified mailbox or your mail spool if not.
1014 Both mbox and maildir type mailboxes are supported. You can use
1015 a program like fetchmail to get mails from some server using
1016 your favourite protocol. See also new_mails.
1019 mboxscan (-n number of messages to print) (-fw from width) (-sw subject
1021 Print a summary of recent messages in an mbox format mailbox.
1022 mbox parameter is the filename of the mailbox (can be encapsu-
1023 lated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
1026 mem Amount of memory in use
1029 membar (height),(width)
1030 Bar that shows amount of memory in use
1033 memmax Total amount of memory
1037 Percentage of memory in use
1041 Artist in current MPD song must be enabled at compile
1045 Album in current MPD song
1048 mpd_bar (height),(width)
1049 Bar of mpd's progress
1053 Bitrate of current song
1057 Playing, stopped, et cetera.
1060 mpd_title (max length)
1061 Title of current MPD song
1077 Percent of song's progress
1081 Random status (On/Off)
1085 Repeat status (On/Off)
1089 Prints the MPD track field
1093 Prints the MPD name field
1097 Prints the file name of the current MPD song
1101 Prints the song name in either the form "artist - title" or file
1102 name, depending on whats available
1106 Print a nameserver from /etc/resolv.conf. Index starts at and
1110 new_mails (mailbox) (interval)
1111 Unread mail count in the specified mailbox or mail spool if not.
1112 Both mbox and maildir type mailboxes are supported.
1119 nvidia threshold temp gpufreq memfreq imagequality
1120 Nvidia graficcard support for the XNVCtrl library. Each option
1121 gives back one integer value: (threshold): the thresholdtempera-
1122 ture at which the gpu slows down (temp): gives the gpu current
1123 temperature (gpufreq): gives the current gpu frequency (mem-
1124 freq): gives the current mem frequency (imagequality): which im-
1125 agequality should be choosen by OpenGL applications
1128 outlinecolor (color)
1129 Change outline color
1133 If running on Apple powerbook/ibook, display information on bat-
1134 tery status. The item parameter specifies, what information to
1135 display. Exactly one item must be specified. Valid items are:
1137 status: Display if battery is fully charged, charging, discharg-
1138 ing or absent (running on AC)
1139 percent: Display charge of battery in percent, if charging or
1140 discharging. Nothing will be displayed, if battery is fully
1142 time: Display the time remaining until the battery will be fully
1143 charged or discharged at current rate. Nothing is displayed, if
1144 battery is absent or if it's present but fully charged and not
1148 platform (dev) type n
1149 Platform sensor from sysfs (Linux 2.6). Parameter dev may be
1150 omitted if you have only one platform device. Platform type is
1151 either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp'
1152 (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter
1153 n is number of the sensor. See /sys/bus/platform/devices/ on
1154 your local computer.
1158 Displays the number of unseen messages in your global POP3 inbox
1159 by default. You can define individual POP3 inboxes seperately by
1160 passing arguments to this object. Arguments are: "host user pass
1161 [-i interval] [-p port] [-e command]". Default port is 110, de-
1162 fault interval is 5 minutes. If the password is supplied as '*',
1163 you will be prompted to enter the password when Conky starts.
1167 Displays the amount of space (in MiB, 2^20) used in your global
1168 POP3 inbox by default. You can define individual POP3 inboxes
1169 seperately by passing arguments to this object. Arguments are:
1170 "host user pass [-i interval] [-p port] [-e command]". Default
1171 port is 110, default interval is 5 minutes. If the password is
1172 supplied as '*', you will be prompted to enter the password when
1176 pre_exec shell command
1177 Executes a shell command one time before conky displays anything
1178 and puts output as text.
1182 Total processes (sleeping and running)
1186 Running processes (not sleeping), requires Linux 2.6
1190 Change shading color
1194 when using smapi, display contents of the /sys/devices/plat-
1195 form/smapi directory. ARGS are either '(FILENAME)' or 'bat (IN-
1196 DEX) (FILENAME)' to display the corresponding files' content.
1197 This is a very raw method of accessing the smapi values. When
1198 available, better use one of the smapi_* variables instead.
1201 smapi_bat_perc (INDEX)
1202 when using smapi, display the remaining capacity in percent of
1203 the battery with index INDEX. This is a separate variable be-
1204 cause it supports the 'use_spacer' configuration option.
1207 smapi_bat_bar (INDEX),(height),(width)
1208 when using smapi, display the remaining capacity of the battery
1209 with index INDEX as a bar.
1213 Stippled (dashed) horizontal line
1216 swapbar (height),(width)
1217 Bar that shows amount of swap in use
1220 swap Amount of swap in use
1224 Total amount of swap
1228 Percentage of swap in use
1232 System name, Linux for example
1235 tcp_portmon port_begin port_end item (index) (ip4 only at present)
1236 TCP port monitor for specified local ports. Port numbers must be
1237 in the range 1 to 65535. Valid items are:
1239 count - total number of connections in the range
1240 rip - remote ip address
1241 rhost - remote host name
1242 rport - remote port number
1243 rservice - remote service name from /etc/services
1244 lip - local ip address
1245 lhost - local host name
1246 lport - local port number
1247 lservice - local service name from /etc/services
1249 The connection index provides you with access to each connection
1250 in the port monitor. The monitor will return information for in-
1251 dex values from 0 to n-1 connections. Values higher than n-1 are
1252 simply ignored. For the "count" item, the connection index must
1253 be omitted. It is required for all other items.
1256 ${tcp_portmon 6881 6999 count} - displays the number of connec-
1257 tions in the bittorrent port range
1258 ${tcp_portmon 22 22 rip 0} - displays the remote host ip of the
1259 first sshd connection
1260 ${tcp_portmon 22 22 rip 9} - displays the remote host ip of the
1261 tenth sshd connection
1262 ${tcp_portmon 1 1024 rhost 0} - displays the remote host name of
1263 the first connection on a privileged port
1264 ${tcp_portmon 1 1024 rport 4} - displays the remote host port of
1265 the fifth connection on a privileged port
1266 ${tcp_portmon 1 65535 lservice 14} - displays the local service
1267 name of the fifteenth connection in the range of all ports
1269 Note that port monitor variables which share the same port range
1270 actually refer to the same monitor, so many references to a sin-
1271 gle port range for different items and different indexes all use
1272 the same monitor internally. In other words, the program avoids
1273 creating redundant monitors.
1275 texeci interval command
1276 Runs a command at an interval inside a thread and displays the
1277 output. Same as $execi, except the command is run inside a
1278 thread. Use this if you have a slow script to keep Conky updat-
1279 ing. You should make the interval slightly longer then the time
1280 it takes your script to execute. For example, if you have a
1281 script that take 5 seconds to execute, you should make the in-
1282 terval at least 6 seconds. See also $execi.
1286 Move text over by N pixels. See also $voffset.
1289 rss url delay_in_minutes action item_num
1290 Download and parse RSS feeds. Action may be one of the follow-
1291 ing: feed_title, item_title (with num par), item_desc (with num
1292 par) and item_titles.
1295 tab (width, (start))
1296 Puts a tab of the specified width, starting from column 'start'.
1299 tail logfile lines (interval)
1300 Displays last N lines of supplied text text file. If interval is
1301 not supplied, Conky assumes 2x Conky's interval. Max of 30 lines
1302 can be displayed, or until the text buffer is filled.
1306 Local time, see man strftime to get more information about for-
1311 Display time in UTC (universal coordinate time).
1314 tztime (timezone) (format)
1315 Local time for specified timezone, see man strftime to get more
1316 information about format. The timezone argument is specified in
1317 similar fashion as TZ environment variable. For hints, look in
1318 /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
1322 Total download, overflows at 4 GB on Linux with 32-bit arch and
1323 there doesn't seem to be a way to know how many times it has al-
1324 ready done that before conky has started.
1328 This takes arguments in the form:top (name) (number) Basically,
1329 processes are ranked from highest to lowest in terms of cpu us-
1330 age, which is what (num) represents. The types are: "name",
1331 "pid", "cpu", "mem", "mem_res", "mem_vsize", and "time". There
1332 can be a max of 10 processes listed.
1336 Same as top, except sorted by mem usage instead of cpu
1340 Total upload, this one too, may overflow
1343 updates Number of updates
1352 Upload speed in KiB with one decimal
1355 upspeedgraph net (height),(width) (gradient colour 1) (gradient colour
1357 Upload speed graph, colours defined in hex, minus the #. If
1358 scale is non-zero, it becomes the scale for the graph.
1365 Uptime in a shorter format
1369 Number of users logged in
1373 Lists the names of the users logged in
1377 Lists the consoles in use
1381 Lists how long users have been logged in for
1385 Change vertical offset by N pixels. Negative values will cause
1386 text to overlap. See also $offset.
1390 Returns CPU #n's voltage in mV. CPUs are counted from 1. If
1391 omitted, the parameter defaults to 1.
1395 Returns CPU #n's voltage in V. CPUs are counted from 1. If omit-
1396 ted, the parameter defaults to 1.
1400 Wireless access point ESSID (Linux only)
1404 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1407 wireless_bitrate net
1408 Wireless bitrate (ie 11 Mb/s) (Linux only)
1412 Wireless access point MAC address (Linux only)
1415 wireless_link_qual net
1416 Wireless link quality (Linux only)
1419 wireless_link_qual_max net
1420 Wireless link quality maximum value (Linux only)
1423 wireless_link_qual_perc net
1424 Wireless link quality in percents (Linux only)
1427 wireless_link_bar (height), (width) net
1428 Wireless link quality bar (Linux only)
1432 Artist in current XMMS2 song
1436 Album in current XMMS2 song
1440 Title in current XMMS2 song
1444 Genre in current XMMS2 song
1448 Comment in current XMMS2 song
1456 Transport plugin used
1460 Full path to current song
1464 Track number in current XMMS2 song
1468 Bitrate of current song
1472 XMMS2 id of current song
1476 Duration of current song
1484 Size of current song
1488 Percent of song's progress
1492 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1495 xmms2_bar (height),(width)
1496 Bar of XMMS2's progress
1500 Prints the song name in either the form "artist - title" or file
1501 name, depending on whats available
1505 conky -t '${time %D %H:%M}' -o -u 30
1506 Start Conky in its own window with date and clock as text and 30
1507 sec update interval.
1509 conky -a top_left -x 5 -y 500 -d
1510 Start Conky to background at coordinates (5, 500).
1513 ~/.conkyrc default configuration file
1516 Drawing to root or some other desktop window directly doesn't work with
1517 all window managers. Especially doesn't work well with Gnome and it has
1518 been reported that it doesn't work with KDE either. Nautilus can be
1519 disabled from drawing to desktop with program gconf-editor. Uncheck
1520 show_desktop in /apps/nautilus/preferences/. There is -w switch in
1521 Conky to set some specific window id. You might find xwininfo -tree
1522 useful to find the window to draw to. You can also use -o argument
1523 which makes Conky to create its own window. If you do try running Conky
1524 in its own window, be sure to read up on the own_window_type settings
1528 <http://conky.sourceforge.net/>
1530 <http://www.sourceforge.net/projects/conky>
1532 #conky on irc.freenode.net
1535 Copyright (c) 2005-2008 Brenden Matthews, Philip Kovacs, et. al. Any
1536 original torsmo code is licensed under the BSD license (see LICENSE.BSD
1537 for a copy). All code written since the fork of torsmo is licensed un-
1538 der the GPL (see LICENSE.GPL for a copy), except where noted different-
1539 ly (such as in portmon code, timed thread code, and audacious code
1540 which are LGPL, and prss which is an MIT-style license).
1543 The Conky dev team (see AUTHORS for a full list of contributors).