6 conky - A system monitor for X originally based on the torsmo code, but
7 more kickass. It just keeps on given'er. Yeah.
13 Conky is a system monitor for X originally based on the torsmo code.
14 Since it's original conception, Conky has changed a fair bit from it's
15 predecessor. Conky can display just about anything, either on your
16 root desktop or in it's own window. Conky has many built-in objects,
17 as well as the ability to execute programs and scripts, then display
18 the output from stdout.
20 We are always looking for help, and anyone interested in becoming a de-
21 veloper is welcome. Please use the facilities at SourceForge to make
22 bug reports, feature requests, and submit patches.
24 Thanks for your interest in Conky.
27 For users compiling from source, make sure you have the X development
28 libraries installed. This should be a package along the lines of
29 "libx11-dev or xorg-x11-dev".
31 Gentoo users -- Conky is in Gentoo's Portage... simply use "emerge app-
32 admin/conky" for installation. There is also usually an up-to-date
33 ebuild within Conky's package or in Svn.
35 Debian,etc. users -- Conky will be in Debian's repositories soon (by
36 mid-September, hopefully), and then Ubuntu shortly thereafter. Until
37 then, "dpkg -i" the .deb package to install.
39 Example to compile and run Conky with all optional components (note
40 that some configure options may differ for your system):
42 sh autogen.sh # Only required if building from SVN
44 ./configure --prefix=/usr --mandir=/usr/share/man --in-
45 fodir=/usr/share/info --datadir=/usr/share --sysconfdir=/etc --local-
46 statedir=/var/lib --disable-own-window --enable-audacious[=yes|no|lega-
47 cy] --enable-bmpx --disable-hddtemp --disable-mpd --enable-xmms2 --dis-
48 able-portmon --disable-network --enable-debug --disable-x11 --dis-
49 able-double-buffer --disable-xdamage --disable-xft
53 make install # Optional
57 Conky probably doesn't compile with compilers other than gcc and icc.
58 It doesn't compile with C89 compiler and not even with pure C99. It
59 uses a few things that might not exist: strdup(), strcasecmp(), strn-
60 casecmp(), optarg variable with getopt() and long long (not in C89).
61 Crashes in file system statistics stuff when compiled with icc, I don't
64 You can disable 'drawing to own window' feature in case you don't need
65 it by passing --disable-own-window to configure -script.
69 Conky is generally very good on resources. However, certain objects in
70 Conky are harder on resources then others. In particular, the $tail,
71 $top, $font, and $graph objects are quite costly in comparison to the
74 If you do use them, please do not complain about memory or CPU usage,
75 unless you think something's seriously wrong (mem leak, etc.).
77 An easy way to force Conky to reload your ~/.conkyrc: "killall -SIGUSR1
78 conky". Saves you the trouble of having to kill and then restart. You
79 can now also do the same with SIGHUP.
81 IMPORTANT: For previous Conky users, Conky 1.3 no longer supports the
82 metar stuff. mdsplib was causing way too many problems. Hopefully
83 there'll be a better solution in Conky 2.x...
86 Command line options override configurations defined in configuration
90 Prints version and exits
93 -a | --alignment=ALIGNMENT
94 Text alignment on screen, {top,bottom}_{left,right} or none
98 Use double buffering (eliminates "flicker")
102 Config file to load instead of $HOME/.conkyrc
106 Daemonize Conky, aka fork to background
114 Prints command line help and exits
118 Create own window to draw
122 Text to render, remember single quotes, like -t ' $uptime '
125 -u | --interval=SECONDS
129 -w | --window-id=WIN_ID
141 CONFIGURATION SETTINGS
142 Default configuration file is $HOME/.conkyrc (can be changed from
143 conky.c among other things). See conkyrc.sample. If installing from De-
144 bian package, this should be in /usr/share/doc/conky/examples ("gunzip
145 conkyrc.sample.gz" to get conkyrc.sample).
147 You might want to copy it to $HOME/.conkyrc and then start modifying
148 it. Other configs can be found at http://conky.sf.net
151 Aligned position on screen, may be top_left, top_right, top_mid-
152 dle, bottom_left, bottom_right, bottom_middle, middle_left, mid-
153 dle_right, or none (also can be abreviated as tl, tr, tm, bl,
158 Boolean value, if true, Conky will be forked to background when
163 Border margin in pixels
167 Border width in pixels
170 color0 A color variable for use inside TEXT segments
173 color1 A color variable for use inside TEXT segments
176 color2 A color variable for use inside TEXT segments
179 color3 A color variable for use inside TEXT segments
182 color4 A color variable for use inside TEXT segments
185 color5 A color variable for use inside TEXT segments
188 color6 A color variable for use inside TEXT segments
191 color7 A color variable for use inside TEXT segments
194 color8 A color variable for use inside TEXT segments
197 color9 A color variable for use inside TEXT segments
201 The number of samples to average for CPU monitoring
205 If true, cpu in top will show usage of one processor's power. If
206 false, cpu in top will show the usage of all processors' power
211 Default color and border color
214 default_outline_color
215 Default outline color
219 Default shading color and border's shading color
223 Use the Xdbe extension? (eliminates flicker) It is highly recom-
224 mended to use own window with this one so double buffer won't be
229 Draw borders around text?
233 Draw borders around graphs?
244 font Font name in X, xfontsel can be used to get a nice font
247 gap_x Gap, in pixels, between right or left border of screen, same as
248 passing -x at command line, e.g. gap_x 10
251 gap_y Gap, in pixels, between top or bottom border of screen, same as
252 passing -y at command line, e.g. gap_y 10.
255 imap Default global IMAP server. Arguments are: "host user pass [-i
256 interval] [-f folder] [-p port] [-e command]". Default port is
257 143, default folder is 'INBOX', default interval is 5 minutes.
258 If the password is supplied as '*', you will be prompted to en-
259 ter the password when Conky starts.
263 Mail spool for mail checking
266 max_port_monitor_connections
267 Allow each port monitor to track at most this many connections
268 (if 0 or not set, default is 256)
272 Maximum number of special things, e.g. fonts, offsets, aligns,
273 etc. (default is 512)
277 Maximum size of user text buffer, i.e. layout below TEXT line in
278 config file (default is 16384 bytes)
281 text_buffer_size bytes
282 Size of the standard text buffer (default is 128 bytes). This
283 buffer is used for intermediary text, such as individual lines,
284 output from $exec vars, and various other variables. Increasing
285 the size of this buffer can drastically reduce Conky's perfor-
286 mance, but will allow for more text display per variable. The
287 size of this buffer cannot be smaller than the default value of
292 Maximum width of window
295 minimum_size width (height)
296 Minimum size of window
311 music_player_interval
312 Music player thread update interval (defaults to Conky's update
317 The number of samples to average for net data
321 Substract (file system) buffers from used memory?
325 Force UTF8? requires XFT
329 Boolean, create own window to draw?
333 Manually set the WM_CLASS name. Defaults to "Conky".
336 own_window_colour colour
337 If own_window_transparent no, set a specified background colour
338 (defaults to black). Takes either a hex value (#ffffff) or a
339 valid RGB name (see /usr/lib/X11/rgb.txt)
342 own_window_hints undecorated,below,above,sticky,skip_taskbar,skip_pager
343 If own_window is yes, you may use these window manager hints to
344 affect the way Conky displays. Notes: Use own_window_type desk-
345 top as another way to implement many of these hints implicitly.
346 If you use own_window_type override, window manager hints have
347 no meaning and are ignored.
351 Manually set the window name. Defaults to "<hostname> - conky".
354 own_window_transparent
355 Boolean, set pseudo-transparency?
359 if own_window is yes, you may specify type normal, desktop or
360 override (default: normal). Desktop windows are special windows
361 that have no window decorations; are always visible on your
362 desktop; do not appear in your pager or taskbar; and are sticky
363 across all workspaces. Override windows are not under the con-
364 trol of the window manager. Hints are ignored. This type of win-
365 dow can be useful for certain situations.
369 Print text to stdout.
373 Pad percentages to this many decimals (0 = no padding)
376 pop3 Default global POP3 server. Arguments are: "host user pass [-i
377 interval] [-p port] [-e command]". Default port is 110, default
378 interval is 5 minutes. If the password is supplied as '*', you
379 will be prompted to enter the password when Conky starts.
383 Shortens units to a single character (kiB->k, GiB->G, etc.). De-
388 Border stippling (dashing) in pixels
392 Total number of times for Conky to update before quitting. Zero
393 makes Conky run forever
397 Update interval in seconds
401 Boolean value, if true, text is rendered in upper case
405 Adds spaces around certain objects to stop them from moving oth-
406 er things around. Arguments are left, right, and none (default).
407 The old true/false values are deprecated and default to
408 right/none respectively. Note that this only helps if you are
409 using a mono font, such as Bitstream Vera Sans Mono.
413 Use Xft (anti-aliased font and stuff)
417 Alpha of Xft font. Must be a value at or between 1 and 0.
424 TEXT After this begins text to be formatted on screen
428 Colors are parsed using XParsecolor(), there might be a list of them:
429 /usr/X11R6/lib/X11/rgb.txt. Also, <http://sedition.com/perl/rgb.html>.
430 Color can be also in #rrggbb format (hex). Note that when displaying
431 bytes, power is 1024 and not 1000 so 1M really means 1024*1024 bytes
435 IP address for an interface
439 IP addresses for an interface (if one - works like addr). Linux
444 ACPI ac adapter state.
452 ACPI temperature in C.
456 ACPI temperature in F.
460 CPU temperature from therm_adt746x
464 Fan speed from therm_adt746x
468 Right-justify text, with space of N
476 Display APM AC adapter status (FreeBSD only)
480 Display APM battery life in percent (FreeBSD only)
484 Display remaining APM battery life in hh:mm:ss or "unknown" if
485 AC adapterstatus is on-line or charging (FreeBSD only)
488 audacious_bar (height),(width)
493 Bitrate of current tune
497 Number of audio channels of current tune
501 Full path and filename of current tune
505 Sampling frequency of current tune
509 Total length of current tune as MM:SS
512 audacious_length_seconds
513 Total length of current tune in seconds
516 audacious_playlist_position
517 Playlist position of current tune
520 audacious_playlist_length
521 Number of tunes in playlist
525 Position of current tune (MM:SS)
528 audacious_position_seconds
529 Position of current tune in seconds
533 Player status (Playing/Paused/Stopped/Not running)
536 audacious_title (max length)
537 Title of current tune with optional maximum length specifier
541 Battery status and remaining percentage capacity of ACPI or APM
542 battery. ACPI battery number can be given as argument (default
546 battery_bar (height),(width) (num)
547 Battery percentage remaining of ACPI battery in a bar. ACPI bat-
548 tery number can be given as argument (default is BAT0).
551 battery_percent (num)
552 Battery percentage remaining for ACPI battery. ACPI battery num-
553 ber can be given as argument (default is BAT0).
557 Battery charge/discharge time remaining of ACPI battery. ACPI
558 battery number can be given as argument (default is BAT0).
562 Artist in current BMPx track
566 Album in current BMPx track
570 Title of the current BMPx track
574 Track number of the current BMPx track
578 Bitrate of the current BMPx track
582 URI of the current BMPx track
586 Amount of memory buffered
589 cached Amount of memory cached
593 Change drawing color to color
596 color0 Change drawing color to color0 configuration option
599 color1 Change drawing color to color1 configuration option
602 color2 Change drawing color to color2 configuration option
605 color3 Change drawing color to color3 configuration option
608 color4 Change drawing color to color4 configuration option
611 color5 Change drawing color to color5 configuration option
614 color6 Change drawing color to color6 configuration option
617 color7 Change drawing color to color7 configuration option
620 color8 Change drawing color to color8 configuration option
623 color9 Change drawing color to color9 configuration option
635 CPU architecture Conky was built for
639 CPU usage in percents. For SMP machines, the CPU number can be
640 provided as an argument. ${cpu cpu0} is the total usage, and
641 ${cpu cpuX} (X >= 1) are individual CPUs.
644 cpubar (cpu number) (height),(width)
645 Bar that shows CPU usage, height is bar's height in pixels. See
646 $cpu for more info on SMP.
649 cpugraph (cpu number) (height),(width) (gradient colour 1) (gradient
651 CPU usage graph, with optional colours in hex, minus the #. See
652 $cpu for more info on SMP.
656 Displays current disk IO. Device is optional, and takes the form
657 of sda for /dev/sda. Individual partitions are allowed.
660 diskiograph (device) (height),(width) (gradient colour 1) (gradient
662 Disk IO graph, colours defined in hex, minus the #. If scale is
663 non-zero, it becomes the scale for the graph.
667 Displays current disk IO for reads. Device as in diskio.
670 diskiograph_read (device) (height),(width) (gradient colour 1) (gradi-
671 ent colour 2) (scale)
672 Disk IO graph for reads, colours defined in hex, minus the #. If
673 scale is non-zero, it becomes the scale for the graph. Device as
677 diskio_write (device)
678 Displays current disk IO for writes. Device as in diskio.
681 diskiograph_write (device) (height),(width) (gradient colour 1) (gradi-
682 ent colour 2) (scale)
683 Disk IO graph for writes, colours defined in hex, minus the #.
684 If scale is non-zero, it becomes the scale for the graph. Device
689 Download speed in kilobytes
693 Download speed in kilobytes with one decimal
696 downspeedgraph net (height),(width) (gradient colour 1) (gradient
698 Download speed graph, colours defined in hex, minus the #. If
699 scale is non-zero, it becomes the scale for the graph.
702 else Text to show if any of the above are not true
706 Current entropy available for crypto freaks
709 entropy_bar (height),(width)
710 Normalized bar of available entropy for crypto freaks
714 Total size of system entropy pool for crypto freaks
718 Executes a shell command and displays the output in conky. warn-
719 ing: this takes a lot more resources than other variables. I'd
720 recommend coding wanted behaviour in C and posting a patch.
724 Same as exec, except if the first value return is a value be-
725 tween 0-100, it will use that number for a bar. The size for the
726 bar is currently fixed, but that may change in the future.
730 Same as execbar, but graphs values.
733 execi interval command
734 Same as exec but with specific interval. Interval can't be less
735 than update_interval in configuration. See also $texeci
738 execibar interval command
739 Same as execbar, except with an interval
742 execigraph interval command
743 Same as execigraph, but takes an interval arg graphs values
747 Executes a shell command and displays the output in conky. warn-
748 ing: this takes a lot more resources than other variables. I'd
749 recommend coding wanted behaviour in C and posting a patch. This
750 differs from $exec in that it parses the output of the command,
751 so you can insert things like ${color red}hi!${color} in your
752 script and have it correctly parsed by Conky. Caveats: Conky
753 parses and evaluates the output of $execp every time Conky
754 loops, and then destroys all the objects. If you try to use any-
755 thing like $execi within an $execp statement, it will function-
756 ally run at the same interval that the $execp statement runs, as
757 it is created and destroyed at every interval.
760 execpi interval command
761 Same as execp but with specific interval. Interval can't be less
762 than update_interval in configuration. Note that the output from
763 the $execpi command is still parsed and evaluated at every in-
768 Specify a different font. This new font will apply to the cur-
769 rent line and everything following. You can use a $font with no
770 arguments to change back to the default font (much like with
775 Returns CPU #n's frequency in MHz. CPUs are counted from 1. If
776 omitted, the parameter defaults to 1.
780 Returns CPU #n's frequency in GHz. CPUs are counted from 1. If
781 omitted, the parameter defaults to 1.
785 Returns CPU frequency in MHz, but is calculated by counting to
786 clock cycles to complete an instruction. Only available for
791 Returns CPU frequency in GHz, but is calculated by counting to
792 clock cycles to complete an instruction. Only available for
796 fs_bar (height),(width) fs
797 Bar that shows how much space is used on a file system. height
798 is the height in pixels. fs is any file on that file system.
802 Free space on a file system available for users.
806 Free percentage of space on a file system available for users.
818 File system used space
821 goto x The next element will be printed at position 'x'.
825 Displays the default route's interface or "multiple"/"none" ac-
829 gw_ip Displays the default gateway's IP or "multiple"/"none" accord-
833 hddtemp dev, (host,(port))
834 Displays temperature of a selected hard disk drive as reported
835 by the hddtemp daemon running on host:port. Default host is
836 127.0.0.1, default port is 7634.
839 head logfile lines (interval)
840 Displays first N lines of supplied text text file. If interval
841 is not supplied, Conky assumes 2x Conky's interval. Max of 30
842 lines can be displayed, or until the text buffer is filled.
846 Horizontal line, height is the height in pixels
850 Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omit-
851 ted if you have only one hwmon device. Parameter type is either
852 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Cel-
853 sius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n
854 is number of the sensor. See /sys/class/hwmon/ on your local
858 iconv_start codeset_from codeset_to
859 Convert text from one codeset to another using GNU iconv. Needs
860 to be stopped with iconv_stop.
864 Stop iconv codeset conversion.
868 I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted
869 if you have only one I2C device. Parameter type is either 'in'
870 or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Celsius) or
871 'tempf' (Fahrenheit) meaning temperature. Parameter n is number
872 of the sensor. See /sys/bus/i2c/devices/ on your local computer.
876 If running the i8k kernel driver for Inspiron laptops, displays
877 whether ac power is on, as listed in /proc/i8k (translated to
878 human-readable). Beware that this is by default not enabled by
883 If running the i8k kernel driver for Inspiron laptops, displays
884 the bios version as listed in /proc/i8k.
888 If running the i8k kernel driver for Inspiron laptops, displays
889 the volume buttons status as listed in /proc/i8k.
893 If running the i8k kernel driver for Inspiron laptops, displays
894 the cpu temperature in Celsius, as reported by /proc/i8k.
898 If running the i8k kernel driver for Inspiron laptops, displays
899 the cpu temperature in Fahrenheit, as reported by /proc/i8k.
903 If running the i8k kernel driver for Inspiron laptops, displays
904 the left fan's rate of rotation, in revolutions per minute as
905 listed in /proc/i8k. Beware, some laptops i8k reports these fans
910 If running the i8k kernel driver for Inspiron laptops, displays
911 the left fan status as listed in /proc/i8k (translated to human-
912 readable). Beware, some laptops i8k reports these fans in re-
917 If running the i8k kernel driver for Inspiron laptops, displays
918 the right fan's rate of rotation, in revolutions per minute as
919 listed in /proc/i8k. Beware, some laptops i8k reports these fans
924 If running the i8k kernel driver for Inspiron laptops, displays
925 the right fan status as listed in /proc/i8k (translated to hu-
926 man-readable). Beware, some laptops i8k reports these fans in
931 If running the i8k kernel driver for Inspiron laptops, displays
932 your laptop serial number as listed in /proc/i8k.
936 If running the i8k kernel driver for Inspiron laptops, displays
937 the version formatting of /proc/i8k.
941 If running the IBM ACPI, displays the fan speed.
945 If running the IBM ACPI, displays the temperatures from the IBM
946 temperature sensors (N=0..7) Sensor 0 is on the CPU, 3 is on the
951 If running the IBM ACPI, displays the "master" volume, con-
952 trolled by the volume keys (0-14).
956 If running the IBM ACPI, displays the brigtness of the laptops's
961 if conky variable VAR is empty, display everything between
962 $if_empty and the matching $endif
965 if_gw if there is at least one default gateway, display everything be-
966 tween $if_gw and the matching $endif
970 if PROCESS is running, display everything $if_running and the
974 if_existing file (string)
975 if FILE exists, display everything between if_existing and the
976 matching $endif. The optional second paramater checks for FILE
977 containing the specified string and prints everything between
978 $if_existing and the matching $endif.
981 if_mounted (mountpoint)
982 if MOUNTPOINT is mounted, display everything between $if_mounted
983 and the matching $endif
986 if_smapi_bat_installed (INDEX)
987 when using smapi, if the battery with index INDEX is installed,
988 display everything between $if_smapi_bat_installed and the
993 if INTERFACE exists and is up, display everything between $if_up
994 and the matching $endif
998 Displays the number of messages in your global IMAP inbox by de-
999 fault. You can define individual IMAP inboxes seperately by
1000 passing arguments to this object. Arguments are: "host user pass
1001 [-i interval] [-p port] [-e command]". Default port is 143, de-
1002 fault interval is 5 minutes. If the password is supplied as '*',
1003 you will be prompted to enter the password when Conky starts.
1007 Displays the number of unseen messages in your global IMAP inbox
1008 by default. You can define individual IMAP inboxes seperately by
1009 passing arguments to this object. Arguments are: "host user pass
1010 [-i interval] [-p port] [-e command]". Default port is 143, de-
1011 fault interval is 5 minutes. If the password is supplied as '*',
1012 you will be prompted to enter the password when Conky starts.
1016 Prints the current ioscheduler used for the given disk name
1017 (i.e. e.g. "hda" or "sdb")
1020 kernel Kernel version
1024 The value of /proc/sys/vm/laptop_mode
1028 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past
1029 5 minutes and 3 for past 15 minutes.
1033 Machine, i686 for example
1036 mails (mailbox) (interval)
1037 Mail count in the specified mailbox or your mail spool if not.
1038 Both mbox and maildir type mailboxes are supported. You can use
1039 a program like fetchmail to get mails from some server using
1040 your favourite protocol. See also new_mails.
1043 mboxscan (-n number of messages to print) (-fw from width) (-sw subject
1045 Print a summary of recent messages in an mbox format mailbox.
1046 mbox parameter is the filename of the mailbox (can be encapsu-
1047 lated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
1050 mem Amount of memory in use
1053 membar (height),(width)
1054 Bar that shows amount of memory in use
1057 memmax Total amount of memory
1061 Percentage of memory in use
1065 Artist in current MPD song must be enabled at compile
1069 Album in current MPD song
1072 mpd_bar (height),(width)
1073 Bar of mpd's progress
1077 Bitrate of current song
1081 Playing, stopped, et cetera.
1084 mpd_title (max length)
1085 Title of current MPD song
1101 Percent of song's progress
1105 Random status (On/Off)
1109 Repeat status (On/Off)
1113 Prints the MPD track field
1117 Prints the MPD name field
1121 Prints the file name of the current MPD song
1125 Prints the song name in either the form "artist - title" or file
1126 name, depending on whats available
1130 Print a nameserver from /etc/resolv.conf. Index starts at and
1134 new_mails (mailbox) (interval)
1135 Unread mail count in the specified mailbox or mail spool if not.
1136 Both mbox and maildir type mailboxes are supported.
1143 outlinecolor (color)
1144 Change outline color
1148 If running on Apple powerbook/ibook, display information on bat-
1149 tery status. The item parameter specifies, what information to
1150 display. Exactly one item must be specified. Valid items are:
1152 status: Display if battery is fully charged, charging, discharg-
1153 ing or absent (running on AC)
1154 percent: Display charge of battery in percent, if charging or
1155 discharging. Nothing will be displayed, if battery is fully
1157 time: Display the time remaining until the battery will be fully
1158 charged or discharged at current rate. Nothing is displayed, if
1159 battery is absent or if it's present but fully charged and not
1163 platform (dev) type n
1164 Platform sensor from sysfs (Linux 2.6). Parameter dev may be
1165 omitted if you have only one platform device. Platform type is
1166 either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp'
1167 (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter
1168 n is number of the sensor. See /sys/bus/platform/devices/ on
1169 your local computer.
1173 Displays the number of unseen messages in your global POP3 inbox
1174 by default. You can define individual POP3 inboxes seperately by
1175 passing arguments to this object. Arguments are: "host user pass
1176 [-i interval] [-p port] [-e command]". Default port is 110, de-
1177 fault interval is 5 minutes. If the password is supplied as '*',
1178 you will be prompted to enter the password when Conky starts.
1182 Displays the amount of space (in MiB, 2^20) used in your global
1183 POP3 inbox by default. You can define individual POP3 inboxes
1184 seperately by passing arguments to this object. Arguments are:
1185 "host user pass [-i interval] [-p port] [-e command]". Default
1186 port is 110, default interval is 5 minutes. If the password is
1187 supplied as '*', you will be prompted to enter the password when
1191 pre_exec shell command
1192 Executes a shell command one time before conky displays anything
1193 and puts output as text.
1197 Total processes (sleeping and running)
1201 Running processes (not sleeping), requires Linux 2.6
1205 Change shading color
1209 when using smapi, display contents of the /sys/devices/plat-
1210 form/smapi directory. ARGS are either '(FILENAME)' or 'bat (IN-
1211 DEX) (FILENAME)' to display the corresponding files' content.
1212 This is a very raw method of accessing the smapi values. When
1213 available, better use one of the smapi_* variables instead.
1216 smapi_bat_perc (INDEX)
1217 when using smapi, display the remaining capacity in percent of
1218 the battery with index INDEX. This is a separate variable be-
1219 cause it supports the 'use_spacer' configuration option.
1222 smapi_bat_bar (INDEX),(height),(width)
1223 when using smapi, display the remaining capacity of the battery
1224 with index INDEX as a bar.
1228 Stippled (dashed) horizontal line
1231 swapbar (height),(width)
1232 Bar that shows amount of swap in use
1235 swap Amount of swap in use
1239 Total amount of swap
1243 Percentage of swap in use
1247 System name, Linux for example
1250 tcp_portmon port_begin port_end item (index) (ip4 only at present)
1251 TCP port monitor for specified local ports. Port numbers must be
1252 in the range 1 to 65535. Valid items are:
1254 count - total number of connections in the range
1255 rip - remote ip address
1256 rhost - remote host name
1257 rport - remote port number
1258 rservice - remote service name from /etc/services
1259 lip - local ip address
1260 lhost - local host name
1261 lport - local port number
1262 lservice - local service name from /etc/services
1264 The connection index provides you with access to each connection
1265 in the port monitor. The monitor will return information for in-
1266 dex values from 0 to n-1 connections. Values higher than n-1 are
1267 simply ignored. For the "count" item, the connection index must
1268 be omitted. It is required for all other items.
1271 ${tcp_portmon 6881 6999 count} - displays the number of connec-
1272 tions in the bittorrent port range
1273 ${tcp_portmon 22 22 rip 0} - displays the remote host ip of the
1274 first sshd connection
1275 ${tcp_portmon 22 22 rip 9} - displays the remote host ip of the
1276 tenth sshd connection
1277 ${tcp_portmon 1 1024 rhost 0} - displays the remote host name of
1278 the first connection on a privileged port
1279 ${tcp_portmon 1 1024 rport 4} - displays the remote host port of
1280 the fifth connection on a privileged port
1281 ${tcp_portmon 1 65535 lservice 14} - displays the local service
1282 name of the fifteenth connection in the range of all ports
1284 Note that port monitor variables which share the same port range
1285 actually refer to the same monitor, so many references to a sin-
1286 gle port range for different items and different indexes all use
1287 the same monitor internally. In other words, the program avoids
1288 creating redundant monitors.
1290 texeci interval command
1291 Runs a command at an interval inside a thread and displays the
1292 output. Same as $execi, except the command is run inside a
1293 thread. Use this if you have a slow script to keep Conky updat-
1294 ing. You should make the interval slightly longer then the time
1295 it takes your script to execute. For example, if you have a
1296 script that take 5 seconds to execute, you should make the in-
1297 terval at least 6 seconds. See also $execi.
1301 Move text over by N pixels. See also $voffset.
1304 rss url delay_in_minutes action item_num
1305 Download and parse RSS feeds. Action may be one of the follow-
1306 ing: feed_title, item_title (with num par), item_desc (with num
1307 par) and item_titles.
1310 tab (width, (start))
1311 Puts a tab of the specified width, starting from column 'start'.
1314 tail logfile lines (interval)
1315 Displays last N lines of supplied text text file. If interval is
1316 not supplied, Conky assumes 2x Conky's interval. Max of 30 lines
1317 can be displayed, or until the text buffer is filled.
1321 Local time, see man strftime to get more information about for-
1326 Display time in UTC (universal coordinate time).
1329 tztime (timezone) (format)
1330 Local time for specified timezone, see man strftime to get more
1331 information about format. The timezone argument is specified in
1332 similar fashion as TZ environment variable. For hints, look in
1333 /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
1337 Total download, overflows at 4 GB on Linux with 32-bit arch and
1338 there doesn't seem to be a way to know how many times it has al-
1339 ready done that before conky has started.
1343 This takes arguments in the form:top (name) (number) Basically,
1344 processes are ranked from highest to lowest in terms of cpu us-
1345 age, which is what (num) represents. The types are: "name",
1346 "pid", "cpu", "mem", and "time". There can be a max of 10 pro-
1351 Same as top, except sorted by mem usage instead of cpu
1355 Total upload, this one too, may overflow
1358 updates Number of updates
1363 Upload speed in kilobytes
1367 Upload speed in kilobytes with one decimal
1370 upspeedgraph net (height),(width) (gradient colour 1) (gradient colour
1372 Upload speed graph, colours defined in hex, minus the #. If
1373 scale is non-zero, it becomes the scale for the graph.
1380 Uptime in a shorter format
1384 Number of users logged in
1388 Lists the names of the users logged in
1392 Lists the consoles in use
1396 Lists how long users have been logged in for
1400 Change vertical offset by N pixels. Negative values will cause
1401 text to overlap. See also $offset.
1405 Returns CPU #n's voltage in mV. CPUs are counted from 1. If
1406 omitted, the parameter defaults to 1.
1410 Returns CPU #n's voltage in V. CPUs are counted from 1. If omit-
1411 ted, the parameter defaults to 1.
1415 Wireless access point ESSID (Linux only)
1419 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1422 wireless_bitrate net
1423 Wireless bitrate (ie 11 Mb/s) (Linux only)
1427 Wireless access point MAC address (Linux only)
1430 wireless_link_qual net
1431 Wireless link quality (Linux only)
1434 wireless_link_qual_max net
1435 Wireless link quality maximum value (Linux only)
1438 wireless_link_qual_perc net
1439 Wireless link quality in percents (Linux only)
1442 wireless_link_bar (height), (width) net
1443 Wireless link quality bar (Linux only)
1447 Artist in current XMMS2 song
1451 Album in current XMMS2 song
1455 Title in current XMMS2 song
1459 Genre in current XMMS2 song
1463 Comment in current XMMS2 song
1471 Transport plugin used
1475 Full path to current song
1479 Track number in current XMMS2 song
1483 Bitrate of current song
1487 XMMS2 id of current song
1491 Duration of current song
1499 Size of current song
1503 Percent of song's progress
1507 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1510 xmms2_bar (height),(width)
1511 Bar of XMMS2's progress
1515 Prints the song name in either the form "artist - title" or file
1516 name, depending on whats available
1520 conky -t '${time %D %H:%M}' -o -u 30
1521 Start Conky in its own window with date and clock as text and 30
1522 sec update interval.
1524 conky -a top_left -x 5 -y 500 -d
1525 Start Conky to background at coordinates (5, 500).
1528 ~/.conkyrc default configuration file
1531 Drawing to root or some other desktop window directly doesn't work with
1532 all window managers. Especially doesn't work well with Gnome and it has
1533 been reported that it doesn't work with KDE either. Nautilus can be
1534 disabled from drawing to desktop with program gconf-editor. Uncheck
1535 show_desktop in /apps/nautilus/preferences/. There is -w switch in
1536 Conky to set some specific window id. You might find xwininfo -tree
1537 useful to find the window to draw to. You can also use -o argument
1538 which makes Conky to create its own window.
1541 <http://conky.sourceforge.net>
1543 <http://www.sourceforge.net/projects/conky>
1545 #conky on irc.freenode.net
1548 The Conky dev team. What's up now!
projects / monky / blob