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 it's
14 conception, Conky has changed significantly from it's predecessor.
15 Conky can display just about anything, either on your root desktop or
16 in it's own window. Conky has many built-in objects, as well as the
17 ability to execute programs and scripts, then display the output from
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 on a binary distro, make sure you have
28 the X development libraries installed. This should be a package along
29 the lines of "libx11-dev" or "xorg-x11-dev" for X11 libs, and similar
30 "-dev" format for the other libs required (depending on your configure
33 Conky has (for some time) been available in the repositories of most
34 popular distributions. Here are some installation instructions for a
37 Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-
38 admin/conky" for installation. There is also usually an up-to-date
39 ebuild within Conky's package or in SVN.
41 Debian, etc. users -- Conky should be in your repositories, and can be
42 installed by doing "aptitude install conky".
44 Example to compile and run Conky with all optional components (note
45 that some configure options may differ for your system):
47 sh autogen.sh # Only required if building from SVN
49 ./configure --prefix=/usr --mandir=/usr/share/man --in-
50 fodir=/usr/share/info --datadir=/usr/share --sysconfdir=/etc --local-
51 statedir=/var/lib --disable-own-window --enable-audacious[=yes|no|lega-
52 cy] --enable-bmpx --disable-hddtemp --disable-mpd --enable-xmms2 --dis-
53 able-portmon --disable-network --enable-debug --disable-x11 --dis-
54 able-double-buffer --disable-xdamage --disable-xft
58 make install # Optional
62 Conky has been tested to be compatible with C99 C, however it has not
63 been tested with anything other than gcc, and is not guaranteed to work
68 Conky is generally very good on resources. That said, the more you try
69 to make Conky do, the more resources it is going to consume.
71 An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1
72 conky". Saves you the trouble of having to kill and then restart. You
73 can now also do the same with SIGHUP.
76 Command line options override configurations defined in configuration
80 Prints version and exits
83 -a | --alignment=ALIGNMENT
84 Text alignment on screen, {top,bottom}_{left,right} or none
88 Use double buffering (eliminates "flicker")
92 Config file to load instead of $HOME/.conkyrc
96 Daemonize Conky, aka fork to background
104 Prints command line help and exits
108 Create own window to draw
112 Text to render, remember single quotes, like -t ' $uptime '
115 -u | --interval=SECONDS
119 -w | --window-id=WIN_ID
131 CONFIGURATION SETTINGS
132 Default configuration file location is $HOME/.conkyrc or
133 ${sysconfdir}/conky/conky.conf. On most systems, sysconfdir is /etc,
134 and you can find the sample config file there (/etc/conky/conky.conf).
136 You might want to copy it to $HOME/.conkyrc and then start modifying
137 it. Other configs can be found at http://conky.sf.net/
140 Aligned position on screen, may be top_left, top_right, top_mid-
141 dle, bottom_left, bottom_right, bottom_middle, middle_left, mid-
142 dle_right, or none (also can be abreviated as tl, tr, tm, bl,
147 Boolean value, if true, Conky will be forked to background when
152 Border margin in pixels
156 Border width in pixels
159 color0 A color variable for use inside TEXT segments
162 color1 A color variable for use inside TEXT segments
165 color2 A color variable for use inside TEXT segments
168 color3 A color variable for use inside TEXT segments
171 color4 A color variable for use inside TEXT segments
174 color5 A color variable for use inside TEXT segments
177 color6 A color variable for use inside TEXT segments
180 color7 A color variable for use inside TEXT segments
183 color8 A color variable for use inside TEXT segments
186 color9 A color variable for use inside TEXT segments
190 The number of samples to average for CPU monitoring
194 If true, cpu in top will show usage of one processor's power. If
195 false, cpu in top will show the usage of all processors' power
200 Default color and border color
203 default_outline_color
204 Default outline color
208 Default shading color and border's shading color
212 Use the Xdbe extension? (eliminates flicker) It is highly recom-
213 mended to use own window with this one so double buffer won't be
218 Draw borders around text?
222 Draw borders around graphs?
233 font Font name in X, xfontsel can be used to get a nice font
236 gap_x Gap, in pixels, between right or left border of screen, same as
237 passing -x at command line, e.g. gap_x 10
240 gap_y Gap, in pixels, between top or bottom border of screen, same as
241 passing -y at command line, e.g. gap_y 10.
244 imap Default global IMAP server. Arguments are: "host user pass [-i
245 interval] [-f folder] [-p port] [-e command]". Default port is
246 143, default folder is 'INBOX', default interval is 5 minutes.
247 If the password is supplied as '*', you will be prompted to en-
248 ter the password when Conky starts.
252 Mail spool for mail checking
255 max_port_monitor_connections
256 Allow each port monitor to track at most this many connections
257 (if 0 or not set, default is 256)
261 Maximum number of special things, e.g. fonts, offsets, aligns,
262 etc. (default is 512)
266 Maximum size of user text buffer, i.e. layout below TEXT line in
267 config file (default is 16384 bytes)
270 text_buffer_size bytes
271 Size of the standard text buffer (default is 128 bytes). This
272 buffer is used for intermediary text, such as individual lines,
273 output from $exec vars, and various other variables. Increasing
274 the size of this buffer can drastically reduce Conky's perfor-
275 mance, but will allow for more text display per variable. The
276 size of this buffer cannot be smaller than the default value of
281 Maximum width of window
284 minimum_size width (height)
285 Minimum size of window
300 music_player_interval
301 Music player thread update interval (defaults to Conky's update
306 The number of samples to average for net data
310 Substract (file system) buffers from used memory?
314 Force UTF8? requires XFT
318 Boolean, create own window to draw?
322 Manually set the WM_CLASS name. Defaults to "Conky".
325 own_window_colour colour
326 If own_window_transparent no, set a specified background colour
327 (defaults to black). Takes either a hex value (#ffffff) or a
328 valid RGB name (see /usr/lib/X11/rgb.txt)
331 own_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager
332 If own_window is yes, you may use these window manager hints to
333 affect the way Conky displays. Notes: Use own_window_type desk-
334 top as another way to implement many of these hints implicitly.
335 If you use own_window_type override, window manager hints have
336 no meaning and are ignored.
340 Manually set the window name. Defaults to "<hostname> - conky".
343 own_window_transparent
344 Boolean, set pseudo-transparency?
348 if own_window is yes, you may specify type normal, desktop or
349 override (default: normal). Desktop windows are special windows
350 that have no window decorations; are always visible on your
351 desktop; do not appear in your pager or taskbar; and are sticky
352 across all workspaces. Override windows are not under the con-
353 trol of the window manager. Hints are ignored. This type of win-
354 dow can be useful for certain situations.
358 Print text to stdout.
362 Pad percentages to this many decimals (0 = no padding)
365 pop3 Default global POP3 server. Arguments are: "host user pass [-i
366 interval] [-p port] [-e command]". Default port is 110, default
367 interval is 5 minutes. If the password is supplied as '*', you
368 will be prompted to enter the password when Conky starts.
372 Shortens units to a single character (kiB->k, GiB->G, etc.). De-
377 Border stippling (dashing) in pixels
381 Total number of times for Conky to update before quitting. Zero
382 makes Conky run forever
386 Update interval in seconds
390 Boolean value, if true, text is rendered in upper case
394 Adds spaces around certain objects to stop them from moving oth-
395 er things around. Arguments are left, right, and none (default).
396 The old true/false values are deprecated and default to
397 right/none respectively. Note that this only helps if you are
398 using a mono font, such as Bitstream Vera Sans Mono.
402 Use Xft (anti-aliased font and stuff)
406 Alpha of Xft font. Must be a value at or between 1 and 0.
413 TEXT After this begins text to be formatted on screen
417 Colors are parsed using XParsecolor(), there might be a list of them:
418 /usr/share/X11/rgb.txt. Also, <http://sedition.com/perl/rgb.html>.
419 Color can be also in #rrggbb format (hex).
422 IP address for an interface
426 IP addresses for an interface (if one - works like addr). Linux
431 ACPI ac adapter state.
439 ACPI temperature in C.
443 ACPI temperature in F.
447 CPU temperature from therm_adt746x
451 Fan speed from therm_adt746x
455 Right-justify text, with space of N
463 Display APM AC adapter status (FreeBSD only)
467 Display APM battery life in percent (FreeBSD only)
471 Display remaining APM battery life in hh:mm:ss or "unknown" if
472 AC adapterstatus is on-line or charging (FreeBSD only)
475 audacious_bar (height),(width)
480 Bitrate of current tune
484 Number of audio channels of current tune
488 Full path and filename of current tune
492 Sampling frequency of current tune
496 Total length of current tune as MM:SS
499 audacious_length_seconds
500 Total length of current tune in seconds
503 audacious_playlist_position
504 Playlist position of current tune
507 audacious_playlist_length
508 Number of tunes in playlist
512 Position of current tune (MM:SS)
515 audacious_position_seconds
516 Position of current tune in seconds
520 Player status (Playing/Paused/Stopped/Not running)
523 audacious_title (max length)
524 Title of current tune with optional maximum length specifier
528 Battery status and remaining percentage capacity of ACPI or APM
529 battery. ACPI battery number can be given as argument (default
533 battery_bar (height),(width) (num)
534 Battery percentage remaining of ACPI battery in a bar. ACPI bat-
535 tery number can be given as argument (default is BAT0).
538 battery_percent (num)
539 Battery percentage remaining for ACPI battery. ACPI battery num-
540 ber can be given as argument (default is BAT0).
544 Battery charge/discharge time remaining of ACPI battery. ACPI
545 battery number can be given as argument (default is BAT0).
549 Artist in current BMPx track
553 Album in current BMPx track
557 Title of the current BMPx track
561 Track number of the current BMPx track
565 Bitrate of the current BMPx track
569 URI of the current BMPx track
573 Amount of memory buffered
576 cached Amount of memory cached
580 Change drawing color to color
583 color0 Change drawing color to color0 configuration option
586 color1 Change drawing color to color1 configuration option
589 color2 Change drawing color to color2 configuration option
592 color3 Change drawing color to color3 configuration option
595 color4 Change drawing color to color4 configuration option
598 color5 Change drawing color to color5 configuration option
601 color6 Change drawing color to color6 configuration option
604 color7 Change drawing color to color7 configuration option
607 color8 Change drawing color to color8 configuration option
610 color9 Change drawing color to color9 configuration option
622 CPU architecture Conky was built for
626 CPU usage in percents. For SMP machines, the CPU number can be
627 provided as an argument. ${cpu cpu0} is the total usage, and
628 ${cpu cpuX} (X >= 1) are individual CPUs.
631 cpubar (cpu number) (height),(width)
632 Bar that shows CPU usage, height is bar's height in pixels. See
633 $cpu for more info on SMP.
636 cpugraph (cpu number) (height),(width) (gradient colour 1) (gradient
638 CPU usage graph, with optional colours in hex, minus the #. See
639 $cpu for more info on SMP.
643 Displays current disk IO. Device is optional, and takes the form
644 of sda for /dev/sda. Individual partitions are allowed.
647 diskiograph (device) (height),(width) (gradient colour 1) (gradient
649 Disk IO graph, colours defined in hex, minus the #. If scale is
650 non-zero, it becomes the scale for the graph.
654 Displays current disk IO for reads. Device as in diskio.
657 diskiograph_read (device) (height),(width) (gradient colour 1) (gradi-
658 ent colour 2) (scale)
659 Disk IO graph for reads, colours defined in hex, minus the #. If
660 scale is non-zero, it becomes the scale for the graph. Device as
664 diskio_write (device)
665 Displays current disk IO for writes. Device as in diskio.
668 diskiograph_write (device) (height),(width) (gradient colour 1) (gradi-
669 ent colour 2) (scale)
670 Disk IO graph for writes, colours defined in hex, minus the #.
671 If scale is non-zero, it becomes the scale for the graph. Device
676 Disk protection status, if supported (needs kernel-patch).
677 Prints either "frozen" or "free " (note the padding).
681 Download speed in kilobytes
685 Download speed in kilobytes with one decimal
688 downspeedgraph net (height),(width) (gradient colour 1) (gradient
690 Download speed graph, colours defined in hex, minus the #. If
691 scale is non-zero, it becomes the scale for the graph.
694 else Text to show if any of the above are not true
698 Current entropy available for crypto freaks
701 entropy_bar (height),(width)
702 Normalized bar of available entropy for crypto freaks
706 Total size of system entropy pool for crypto freaks
710 Executes a shell command and displays the output in conky. warn-
711 ing: this takes a lot more resources than other variables. I'd
712 recommend coding wanted behaviour in C and posting a patch.
716 Same as exec, except if the first value return is a value be-
717 tween 0-100, it will use that number for a bar. The size for the
718 bar is currently fixed, but that may change in the future.
722 Same as execbar, but graphs values.
725 execi interval command
726 Same as exec but with specific interval. Interval can't be less
727 than update_interval in configuration. See also $texeci
730 execibar interval command
731 Same as execbar, except with an interval
734 execigraph interval command
735 Same as execgraph, but takes an interval arg graphs values
739 Executes a shell command and displays the output in conky. warn-
740 ing: this takes a lot more resources than other variables. I'd
741 recommend coding wanted behaviour in C and posting a patch. This
742 differs from $exec in that it parses the output of the command,
743 so you can insert things like ${color red}hi!${color} in your
744 script and have it correctly parsed by Conky. Caveats: Conky
745 parses and evaluates the output of $execp every time Conky
746 loops, and then destroys all the objects. If you try to use any-
747 thing like $execi within an $execp statement, it will function-
748 ally run at the same interval that the $execp statement runs, as
749 it is created and destroyed at every interval.
752 execpi interval command
753 Same as execp but with specific interval. Interval can't be less
754 than update_interval in configuration. Note that the output from
755 the $execpi command is still parsed and evaluated at every in-
760 Specify a different font. This new font will apply to the cur-
761 rent line and everything following. You can use a $font with no
762 arguments to change back to the default font (much like with
767 Returns CPU #n's frequency in MHz. CPUs are counted from 1. If
768 omitted, the parameter defaults to 1.
772 Returns CPU #n's frequency in GHz. CPUs are counted from 1. If
773 omitted, the parameter defaults to 1.
777 Returns CPU frequency in MHz, but is calculated by counting to
778 clock cycles to complete an instruction. Only available for
783 Returns CPU frequency in GHz, but is calculated by counting to
784 clock cycles to complete an instruction. Only available for
788 fs_bar (height),(width) fs
789 Bar that shows how much space is used on a file system. height
790 is the height in pixels. fs is any file on that file system.
794 Free space on a file system available for users.
798 Free percentage of space on a file system available for users.
810 File system used space
813 goto x The next element will be printed at position 'x'.
817 Displays the default route's interface or "multiple"/"none" ac-
821 gw_ip Displays the default gateway's IP or "multiple"/"none" accord-
825 hddtemp dev, (host,(port))
826 Displays temperature of a selected hard disk drive as reported
827 by the hddtemp daemon running on host:port. Default host is
828 127.0.0.1, default port is 7634.
831 head logfile lines (interval)
832 Displays first N lines of supplied text text file. If interval
833 is not supplied, Conky assumes 2x Conky's interval. Max of 30
834 lines can be displayed, or until the text buffer is filled.
838 Horizontal line, height is the height in pixels
842 Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omit-
843 ted if you have only one hwmon device. Parameter type is either
844 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Cel-
845 sius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n
846 is number of the sensor. See /sys/class/hwmon/ on your local
850 iconv_start codeset_from codeset_to
851 Convert text from one codeset to another using GNU iconv. Needs
852 to be stopped with iconv_stop.
856 Stop iconv codeset conversion.
860 I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted
861 if you have only one I2C device. Parameter type is either 'in'
862 or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Celsius) or
863 'tempf' (Fahrenheit) meaning temperature. Parameter n is number
864 of the sensor. See /sys/bus/i2c/devices/ on your local computer.
868 If running the i8k kernel driver for Inspiron laptops, displays
869 whether ac power is on, as listed in /proc/i8k (translated to
870 human-readable). Beware that this is by default not enabled by
875 If running the i8k kernel driver for Inspiron laptops, displays
876 the bios version as listed in /proc/i8k.
880 If running the i8k kernel driver for Inspiron laptops, displays
881 the volume buttons status as listed in /proc/i8k.
885 If running the i8k kernel driver for Inspiron laptops, displays
886 the cpu temperature in Celsius, as reported by /proc/i8k.
890 If running the i8k kernel driver for Inspiron laptops, displays
891 the cpu temperature in Fahrenheit, as reported by /proc/i8k.
895 If running the i8k kernel driver for Inspiron laptops, displays
896 the left fan's rate of rotation, in revolutions per minute as
897 listed in /proc/i8k. Beware, some laptops i8k reports these fans
902 If running the i8k kernel driver for Inspiron laptops, displays
903 the left fan status as listed in /proc/i8k (translated to human-
904 readable). Beware, some laptops i8k reports these fans in re-
909 If running the i8k kernel driver for Inspiron laptops, displays
910 the right fan's rate of rotation, in revolutions per minute as
911 listed in /proc/i8k. Beware, some laptops i8k reports these fans
916 If running the i8k kernel driver for Inspiron laptops, displays
917 the right fan status as listed in /proc/i8k (translated to hu-
918 man-readable). Beware, some laptops i8k reports these fans in
923 If running the i8k kernel driver for Inspiron laptops, displays
924 your laptop serial number as listed in /proc/i8k.
928 If running the i8k kernel driver for Inspiron laptops, displays
929 the version formatting of /proc/i8k.
933 If running the IBM ACPI, displays the fan speed.
937 If running the IBM ACPI, displays the temperatures from the IBM
938 temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
943 If running the IBM ACPI, displays the "master" volume, con-
944 trolled by the volume keys (0-14).
948 If running the IBM ACPI, displays the brigtness of the laptops's
953 if conky variable VAR is empty, display everything between
954 $if_empty and the matching $endif
957 if_gw if there is at least one default gateway, display everything be-
958 tween $if_gw and the matching $endif
962 if PROCESS is running, display everything $if_running and the
966 if_existing file (string)
967 if FILE exists, display everything between if_existing and the
968 matching $endif. The optional second paramater checks for FILE
969 containing the specified string and prints everything between
970 $if_existing and the matching $endif.
973 if_mounted (mountpoint)
974 if MOUNTPOINT is mounted, display everything between $if_mounted
975 and the matching $endif
978 if_smapi_bat_installed (INDEX)
979 when using smapi, if the battery with index INDEX is installed,
980 display everything between $if_smapi_bat_installed and the
985 if INTERFACE exists and is up, display everything between $if_up
986 and the matching $endif
990 Displays the number of messages in your global IMAP inbox by de-
991 fault. You can define individual IMAP inboxes seperately by
992 passing arguments to this object. Arguments are: "host user pass
993 [-i interval] [-p port] [-e command]". Default port is 143, de-
994 fault interval is 5 minutes. If the password is supplied as '*',
995 you will be prompted to enter the password when Conky starts.
999 Displays the number of unseen messages in your global IMAP inbox
1000 by default. You can define individual IMAP inboxes seperately by
1001 passing arguments to this object. Arguments are: "host user pass
1002 [-i interval] [-p port] [-e command]". Default port is 143, de-
1003 fault interval is 5 minutes. If the password is supplied as '*',
1004 you will be prompted to enter the password when Conky starts.
1008 Prints the current ioscheduler used for the given disk name
1009 (i.e. e.g. "hda" or "sdb")
1012 kernel Kernel version
1016 The value of /proc/sys/vm/laptop_mode
1020 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
1021 5 minutes and 3 for past 15 minutes.
1025 Machine, i686 for example
1028 mails (mailbox) (interval)
1029 Mail count in the specified mailbox or your mail spool if not.
1030 Both mbox and maildir type mailboxes are supported. You can use
1031 a program like fetchmail to get mails from some server using
1032 your favourite protocol. See also new_mails.
1035 mboxscan (-n number of messages to print) (-fw from width) (-sw subject
1037 Print a summary of recent messages in an mbox format mailbox.
1038 mbox parameter is the filename of the mailbox (can be encapsu-
1039 lated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
1042 mem Amount of memory in use
1045 membar (height),(width)
1046 Bar that shows amount of memory in use
1049 memmax Total amount of memory
1053 Percentage of memory in use
1057 Artist in current MPD song must be enabled at compile
1061 Album in current MPD song
1064 mpd_bar (height),(width)
1065 Bar of mpd's progress
1069 Bitrate of current song
1073 Playing, stopped, et cetera.
1076 mpd_title (max length)
1077 Title of current MPD song
1093 Percent of song's progress
1097 Random status (On/Off)
1101 Repeat status (On/Off)
1105 Prints the MPD track field
1109 Prints the MPD name field
1113 Prints the file name of the current MPD song
1117 Prints the song name in either the form "artist - title" or file
1118 name, depending on whats available
1122 Print a nameserver from /etc/resolv.conf. Index starts at and
1126 new_mails (mailbox) (interval)
1127 Unread mail count in the specified mailbox or mail spool if not.
1128 Both mbox and maildir type mailboxes are supported.
1135 outlinecolor (color)
1136 Change outline color
1140 If running on Apple powerbook/ibook, display information on bat-
1141 tery status. The item parameter specifies, what information to
1142 display. Exactly one item must be specified. Valid items are:
1144 status: Display if battery is fully charged, charging, discharg-
1145 ing or absent (running on AC)
1146 percent: Display charge of battery in percent, if charging or
1147 discharging. Nothing will be displayed, if battery is fully
1149 time: Display the time remaining until the battery will be fully
1150 charged or discharged at current rate. Nothing is displayed, if
1151 battery is absent or if it's present but fully charged and not
1155 platform (dev) type n
1156 Platform sensor from sysfs (Linux 2.6). Parameter dev may be
1157 omitted if you have only one platform device. Platform type is
1158 either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp'
1159 (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter
1160 n is number of the sensor. See /sys/bus/platform/devices/ on
1161 your local computer.
1165 Displays the number of unseen messages in your global POP3 inbox
1166 by default. You can define individual POP3 inboxes seperately by
1167 passing arguments to this object. Arguments are: "host user pass
1168 [-i interval] [-p port] [-e command]". Default port is 110, de-
1169 fault interval is 5 minutes. If the password is supplied as '*',
1170 you will be prompted to enter the password when Conky starts.
1174 Displays the amount of space (in MiB, 2^20) used in your global
1175 POP3 inbox by default. You can define individual POP3 inboxes
1176 seperately by passing arguments to this object. Arguments are:
1177 "host user pass [-i interval] [-p port] [-e command]". Default
1178 port is 110, default interval is 5 minutes. If the password is
1179 supplied as '*', you will be prompted to enter the password when
1183 pre_exec shell command
1184 Executes a shell command one time before conky displays anything
1185 and puts output as text.
1189 Total processes (sleeping and running)
1193 Running processes (not sleeping), requires Linux 2.6
1197 Change shading color
1201 when using smapi, display contents of the /sys/devices/plat-
1202 form/smapi directory. ARGS are either '(FILENAME)' or 'bat (IN-
1203 DEX) (FILENAME)' to display the corresponding files' content.
1204 This is a very raw method of accessing the smapi values. When
1205 available, better use one of the smapi_* variables instead.
1208 smapi_bat_perc (INDEX)
1209 when using smapi, display the remaining capacity in percent of
1210 the battery with index INDEX. This is a separate variable be-
1211 cause it supports the 'use_spacer' configuration option.
1214 smapi_bat_bar (INDEX),(height),(width)
1215 when using smapi, display the remaining capacity of the battery
1216 with index INDEX as a bar.
1220 Stippled (dashed) horizontal line
1223 swapbar (height),(width)
1224 Bar that shows amount of swap in use
1227 swap Amount of swap in use
1231 Total amount of swap
1235 Percentage of swap in use
1239 System name, Linux for example
1242 tcp_portmon port_begin port_end item (index) (ip4 only at present)
1243 TCP port monitor for specified local ports. Port numbers must be
1244 in the range 1 to 65535. Valid items are:
1246 count - total number of connections in the range
1247 rip - remote ip address
1248 rhost - remote host name
1249 rport - remote port number
1250 rservice - remote service name from /etc/services
1251 lip - local ip address
1252 lhost - local host name
1253 lport - local port number
1254 lservice - local service name from /etc/services
1256 The connection index provides you with access to each connection
1257 in the port monitor. The monitor will return information for in-
1258 dex values from 0 to n-1 connections. Values higher than n-1 are
1259 simply ignored. For the "count" item, the connection index must
1260 be omitted. It is required for all other items.
1263 ${tcp_portmon 6881 6999 count} - displays the number of connec-
1264 tions in the bittorrent port range
1265 ${tcp_portmon 22 22 rip 0} - displays the remote host ip of the
1266 first sshd connection
1267 ${tcp_portmon 22 22 rip 9} - displays the remote host ip of the
1268 tenth sshd connection
1269 ${tcp_portmon 1 1024 rhost 0} - displays the remote host name of
1270 the first connection on a privileged port
1271 ${tcp_portmon 1 1024 rport 4} - displays the remote host port of
1272 the fifth connection on a privileged port
1273 ${tcp_portmon 1 65535 lservice 14} - displays the local service
1274 name of the fifteenth connection in the range of all ports
1276 Note that port monitor variables which share the same port range
1277 actually refer to the same monitor, so many references to a sin-
1278 gle port range for different items and different indexes all use
1279 the same monitor internally. In other words, the program avoids
1280 creating redundant monitors.
1282 texeci interval command
1283 Runs a command at an interval inside a thread and displays the
1284 output. Same as $execi, except the command is run inside a
1285 thread. Use this if you have a slow script to keep Conky updat-
1286 ing. You should make the interval slightly longer then the time
1287 it takes your script to execute. For example, if you have a
1288 script that take 5 seconds to execute, you should make the in-
1289 terval at least 6 seconds. See also $execi.
1293 Move text over by N pixels. See also $voffset.
1296 rss url delay_in_minutes action item_num
1297 Download and parse RSS feeds. Action may be one of the follow-
1298 ing: feed_title, item_title (with num par), item_desc (with num
1299 par) and item_titles.
1302 tab (width, (start))
1303 Puts a tab of the specified width, starting from column 'start'.
1306 tail logfile lines (interval)
1307 Displays last N lines of supplied text text file. If interval is
1308 not supplied, Conky assumes 2x Conky's interval. Max of 30 lines
1309 can be displayed, or until the text buffer is filled.
1313 Local time, see man strftime to get more information about for-
1318 Display time in UTC (universal coordinate time).
1321 tztime (timezone) (format)
1322 Local time for specified timezone, see man strftime to get more
1323 information about format. The timezone argument is specified in
1324 similar fashion as TZ environment variable. For hints, look in
1325 /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
1329 Total download, overflows at 4 GB on Linux with 32-bit arch and
1330 there doesn't seem to be a way to know how many times it has al-
1331 ready done that before conky has started.
1335 This takes arguments in the form:top (name) (number) Basically,
1336 processes are ranked from highest to lowest in terms of cpu us-
1337 age, which is what (num) represents. The types are: "name",
1338 "pid", "cpu", "mem", "mem_res", "mem_vsize", and "time". There
1339 can be a max of 10 processes listed.
1343 Same as top, except sorted by mem usage instead of cpu
1347 Total upload, this one too, may overflow
1350 updates Number of updates
1355 Upload speed in kilobytes
1359 Upload speed in kilobytes with one decimal
1362 upspeedgraph net (height),(width) (gradient colour 1) (gradient colour
1364 Upload speed graph, colours defined in hex, minus the #. If
1365 scale is non-zero, it becomes the scale for the graph.
1372 Uptime in a shorter format
1376 Number of users logged in
1380 Lists the names of the users logged in
1384 Lists the consoles in use
1388 Lists how long users have been logged in for
1392 Change vertical offset by N pixels. Negative values will cause
1393 text to overlap. See also $offset.
1397 Returns CPU #n's voltage in mV. CPUs are counted from 1. If
1398 omitted, the parameter defaults to 1.
1402 Returns CPU #n's voltage in V. CPUs are counted from 1. If omit-
1403 ted, the parameter defaults to 1.
1407 Wireless access point ESSID (Linux only)
1411 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1414 wireless_bitrate net
1415 Wireless bitrate (ie 11 Mb/s) (Linux only)
1419 Wireless access point MAC address (Linux only)
1422 wireless_link_qual net
1423 Wireless link quality (Linux only)
1426 wireless_link_qual_max net
1427 Wireless link quality maximum value (Linux only)
1430 wireless_link_qual_perc net
1431 Wireless link quality in percents (Linux only)
1434 wireless_link_bar (height), (width) net
1435 Wireless link quality bar (Linux only)
1439 Artist in current XMMS2 song
1443 Album in current XMMS2 song
1447 Title in current XMMS2 song
1451 Genre in current XMMS2 song
1455 Comment in current XMMS2 song
1463 Transport plugin used
1467 Full path to current song
1471 Track number in current XMMS2 song
1475 Bitrate of current song
1479 XMMS2 id of current song
1483 Duration of current song
1491 Size of current song
1495 Percent of song's progress
1499 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1502 xmms2_bar (height),(width)
1503 Bar of XMMS2's progress
1507 Prints the song name in either the form "artist - title" or file
1508 name, depending on whats available
1512 conky -t '${time %D %H:%M}' -o -u 30
1513 Start Conky in its own window with date and clock as text and 30
1514 sec update interval.
1516 conky -a top_left -x 5 -y 500 -d
1517 Start Conky to background at coordinates (5, 500).
1520 ~/.conkyrc default configuration file
1523 Drawing to root or some other desktop window directly doesn't work with
1524 all window managers. Especially doesn't work well with Gnome and it has
1525 been reported that it doesn't work with KDE either. Nautilus can be
1526 disabled from drawing to desktop with program gconf-editor. Uncheck
1527 show_desktop in /apps/nautilus/preferences/. There is -w switch in
1528 Conky to set some specific window id. You might find xwininfo -tree
1529 useful to find the window to draw to. You can also use -o argument
1530 which makes Conky to create its own window. If you do try running Conky
1531 in its own window, be sure to read up on the own_window_type settings
1535 <http://conky.sourceforge.net/>
1537 <http://www.sourceforge.net/projects/conky>
1539 #conky on irc.freenode.net
1542 Copyright (c) 2005-2008 Brenden Matthews, Philip Kovacs, et. al. Any
1543 original torsmo code is licensed under the BSD license (see LICENSE.BSD
1544 for a copy). All code written since the fork of torsmo is licensed un-
1545 der the GPL (see LICENSE.GPL for a copy), except where noted different-
1546 ly (such as in portmon code, timed thread code, and audacious code
1547 which are LGPL, and prss which is an MIT-style license).
1550 The Conky dev team (see AUTHORS for a full list of contributors).
projects / monky / blob