4 <command><option>addr</option></command>
5 <option>interface</option>
8 IP address for an interface, or "No Address" if no address is assigned.
9 <para></para></listitem>
14 <command><option>addrs</option></command>
15 <option>interface</option>
18 IP addresses for an interface (if one - works like addr). Linux only.
19 <para></para></listitem>
25 <command><option>acpiacadapter</option></command>
28 ACPI ac adapter state.
29 <para></para></listitem>
34 <command><option>acpifan</option></command>
38 <para></para></listitem>
43 <command><option>acpitemp</option></command>
46 ACPI temperature in C.
47 <para></para></listitem>
52 <command><option>adt746xcpu</option></command>
55 CPU temperature from therm_adt746x
56 <para></para></listitem>
61 <command><option>adt746xfan</option></command>
64 Fan speed from therm_adt746x
65 <para></para></listitem>
70 <command><option>alignr</option></command>
71 <option>(num)</option>
74 Right-justify text, with space of N
75 <para></para></listitem>
80 <command><option>alignc</option></command>
81 <option>(num)</option>
85 <para></para></listitem>
90 <command><option>apm_adapter</option></command>
93 Display APM AC adapter status (FreeBSD only)
94 <para></para></listitem>
99 <command><option>apm_battery_life</option></command>
102 Display APM battery life in percent (FreeBSD only)
103 <para></para></listitem>
108 <command><option>apm_battery_time</option></command>
111 Display remaining APM battery life in hh:mm:ss or "unknown" if
112 AC adapterstatus is on-line or charging (FreeBSD only)
113 <para></para></listitem>
118 <command><option>audacious_bar</option></command>
119 <option>(height),(width)</option>
123 <para></para></listitem>
128 <command><option>audacious_bitrate</option></command>
131 Bitrate of current tune
132 <para></para></listitem>
137 <command><option>audacious_channels</option></command>
140 Number of audio channels of current tune
141 <para></para></listitem>
146 <command><option>audacious_filename</option></command>
149 Full path and filename of current tune
150 <para></para></listitem>
155 <command><option>audacious_frequency</option></command>
158 Sampling frequency of current tune
159 <para></para></listitem>
164 <command><option>audacious_length</option></command>
167 Total length of current tune as MM:SS
168 <para></para></listitem>
173 <command><option>audacious_length_seconds</option></command>
176 Total length of current tune in seconds
177 <para></para></listitem>
182 <command><option>audacious_playlist_position</option></command>
185 Playlist position of current tune
186 <para></para></listitem>
191 <command><option>audacious_playlist_length</option></command>
194 Number of tunes in playlist
195 <para></para></listitem>
200 <command><option>audacious_position</option></command>
203 Position of current tune (MM:SS)
204 <para></para></listitem>
209 <command><option>audacious_position_seconds</option></command>
212 Position of current tune in seconds
213 <para></para></listitem>
218 <command><option>audacious_status</option></command>
221 Player status (Playing/Paused/Stopped/Not running)
222 <para></para></listitem>
227 <command><option>audacious_title</option></command>
228 <option>(max length)</option>
231 Title of current tune with optional maximum length specifier
232 <para></para></listitem>
237 <command><option>audacious_main_volume</option></command>
240 The current volume fetched from Audacious
241 <para></para></listitem>
246 <command><option>battery</option></command>
247 <option>(num)</option>
250 Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
251 <para></para></listitem>
256 <command><option>battery_bar</option></command>
257 <option>(height),(width) (num)</option>
260 Battery percentage remaining of ACPI battery in a bar. ACPI battery number can be given as argument (default is BAT0).
261 <para></para></listitem>
266 <command><option>battery_percent</option></command>
267 <option>(num)</option>
270 Battery percentage remaining for ACPI battery. ACPI battery number can be given as argument (default is BAT0).
271 <para></para></listitem>
276 <command><option>battery_time</option></command>
277 <option>(num)</option>
280 Battery charge/discharge time remaining of ACPI battery. ACPI battery number can be given as argument (default is BAT0).
281 <para></para></listitem>
286 <command><option>bmpx_artist</option></command>
289 Artist in current BMPx track
290 <para></para></listitem>
295 <command><option>bmpx_album</option></command>
298 Album in current BMPx track
299 <para></para></listitem>
304 <command><option>bmpx_title</option></command>
307 Title of the current BMPx track
308 <para></para></listitem>
313 <command><option>bmpx_track</option></command>
316 Track number of the current BMPx track
317 <para></para></listitem>
322 <command><option>bmpx_bitrate</option></command>
325 Bitrate of the current BMPx track
326 <para></para></listitem>
331 <command><option>bmpx_uri</option></command>
334 URI of the current BMPx track
335 <para></para></listitem>
340 <command><option>buffers</option></command>
343 Amount of memory buffered
344 <para></para></listitem>
349 <command><option>cached</option></command>
352 Amount of memory cached
353 <para></para></listitem>
358 <command><option>color</option></command>
359 <option>(color)</option>
362 Change drawing color to color
363 <para></para></listitem>
367 <term><command><option>colorN</option></command></term>
369 Change drawing color to colorN configuration option, where N is a digit between 0 and 9, inclusively.
370 <para></para></listitem>
375 <command><option>conky_version</option></command>
379 <para></para></listitem>
384 <command><option>conky_build_date</option></command>
388 <para></para></listitem>
393 <command><option>conky_build_arch</option></command>
396 CPU architecture Conky was built for
397 <para></para></listitem>
402 <command><option>cpu</option></command>
403 <option>(cpuN)</option>
406 CPU usage in percents. For SMP machines, the CPU number can be provided as an argument. ${cpu cpu0} is the total usage, and ${cpu cpuX} (X >= 1) are individual CPUs.
407 <para></para></listitem>
412 <command><option>cpubar</option></command>
413 <option>(cpu number) (height),(width)</option>
416 Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
417 <para></para></listitem>
422 <command><option>cpugraph</option></command>
423 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (cpu number)</option>
426 CPU usage graph, with optional colours in hex, minus the #. See $cpu for more info on SMP. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
427 <para></para></listitem>
432 <command><option>diskio</option></command>
433 <option>(device)</option>
436 Displays current disk IO. Device is optional, and takes the form of sda for /dev/sda. Individual partitions are allowed.
437 <para></para></listitem>
442 <command><option>diskiograph</option></command>
443 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)</option>
446 Disk IO graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
447 <para></para></listitem>
452 <command><option>diskio_read</option></command>
453 <option>(device)</option>
456 Displays current disk IO for reads. Device as in diskio.
457 <para></para></listitem>
462 <command><option>diskiograph_read</option></command>
463 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)</option>
466 Disk IO graph for reads, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Device as in diskio. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
467 <para></para></listitem>
472 <command><option>diskio_write</option></command>
473 <option>(device)</option>
476 Displays current disk IO for writes. Device as in diskio.
477 <para></para></listitem>
482 <command><option>diskiograph_write</option></command>
483 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)</option>
486 Disk IO graph for writes, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Device as in diskio. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
487 <para></para></listitem>
492 <command><option>disk_protect</option></command>
493 <option>device</option>
496 Disk protection status, if supported (needs kernel-patch). Prints either "frozen" or "free " (note the padding).
497 <para></para></listitem>
502 <command><option>downspeed</option></command>
506 Download speed in KiB
507 <para></para></listitem>
512 <command><option>downspeedf</option></command>
516 Download speed in KiB with one decimal
517 <para></para></listitem>
522 <command><option>downspeedgraph</option></command>
523 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (net)</option>
526 Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
527 <para></para></listitem>
532 <command><option>else</option></command>
535 Text to show if any of the above are not true
536 <para></para></listitem>
541 <command><option>entropy_avail</option></command>
544 Current entropy available for crypto freaks
545 <para></para></listitem>
550 <command><option>entropy_bar</option></command>
551 <option>(height),(width)</option>
554 Normalized bar of available entropy for crypto freaks
555 <para></para></listitem>
560 <command><option>entropy_poolsize</option></command>
563 Total size of system entropy pool for crypto freaks
564 <para></para></listitem>
569 <command><option>exec</option></command>
570 <option>command</option>
573 Executes a shell command and displays the output in conky. warning: this takes a lot more resources than other variables. I'd recommend coding wanted behaviour in C and posting a patch.
574 <para></para></listitem>
579 <command><option>execbar</option></command>
580 <option>command</option>
583 Same as exec, except if the first value return is a value between 0-100, it will use that number for a bar. The size for the bar is currently fixed, but that may change in the future.
584 <para></para></listitem>
589 <command><option>execgraph</option></command>
590 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) command</option>
593 Same as execbar, but graphs values. Uses a logaritmic scale when the log option is given (to see small numbers). Values still have to be between 0 and 100.
594 <para></para></listitem>
599 <command><option>execi</option></command>
600 <option>interval command</option>
603 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
604 <para></para></listitem>
609 <command><option>execibar</option></command>
610 <option>interval command</option>
613 Same as execbar, except with an interval
614 <para></para></listitem>
619 <command><option>execigraph</option></command>
620 <option>interval command</option>
623 Same as execgraph, but takes an interval arg graphs values
624 <para></para></listitem>
629 <command><option>execp</option></command>
630 <option>command</option>
633 Executes a shell command and displays the output in conky. warning: this takes a lot more resources than other variables. I'd recommend coding wanted behaviour in C and posting a patch. This differs from $exec in that it parses the output of the command, so you can insert things like ${color red}hi!${color} in your script and have it correctly parsed by Conky.
634 Caveats: Conky parses and evaluates the output of $execp every time Conky loops, and then destroys all the objects. If you try to use anything like $execi within an $execp statement, it will functionally run at the same interval that the $execp statement runs, as it is created and destroyed at every interval.
635 <para></para></listitem>
640 <command><option>execpi</option></command>
641 <option>interval command</option>
644 Same as execp but with specific interval. Interval can't be less than update_interval in configuration. Note that the output from the $execpi command is still parsed and evaluated at every interval.
645 <para></para></listitem>
650 <command><option>font</option></command>
651 <option>(font)</option>
654 Specify a different font. This new font will apply to the current line and everything following. You can use a $font with no arguments to change back to the default font (much like with $color)
655 <para></para></listitem>
660 <command><option>freq</option></command>
664 Returns CPU #n's frequency in MHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
665 <para></para></listitem>
669 <command><option>freq_g</option></command>
673 Returns CPU #n's frequency in GHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
674 <para></para></listitem>
679 <command><option>freq_dyn</option></command>
683 Returns CPU #n's frequency in MHz (defaults to 1), but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
684 <para></para></listitem>
689 <command><option>freq_dyn_g</option></command>
693 Returns CPU #n's frequency in GHz (defaults to 1), but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
694 <para></para></listitem>
699 <command><option>fs_bar</option></command>
700 <option>(height),(width) fs</option>
703 Bar that shows how much space is used on a file system. height is the height in pixels. fs is any file on that file system.
704 <para></para></listitem>
709 <command><option>fs_free</option></command>
710 <option>(fs)</option>
713 Free space on a file system available for users.
714 <para></para></listitem>
719 <command><option>fs_free_perc</option></command>
720 <option>(fs)</option>
723 Free percentage of space on a file system available for users.
724 <para></para></listitem>
729 <command><option>fs_size</option></command>
730 <option>(fs)</option>
734 <para></para></listitem>
739 <command><option>fs_type</option></command>
740 <option>(fs)</option>
744 <para></para></listitem>
749 <command><option>fs_used</option></command>
750 <option>(fs)</option>
753 File system used space
754 <para></para></listitem>
759 <command><option>goto</option></command>
763 The next element will be printed at position 'x'.
764 <para></para></listitem>
769 <command><option>gw_iface</option></command>
772 Displays the default route's interface or "multiple"/"none" accordingly.
773 <para></para></listitem>
778 <command><option>gw_ip</option></command>
781 Displays the default gateway's IP or "multiple"/"none" accordingly.
782 <para></para></listitem>
787 <command><option>hddtemp</option></command>
788 <option>dev, (host,(port))</option>
791 Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
792 Default host is 127.0.0.1, default port is 7634.
793 <para></para></listitem>
798 <command><option>head</option></command>
799 <option>logfile lines (interval)</option>
802 Displays first N lines of supplied text text file. If interval is not supplied, Conky assumes 2x Conky's interval. Max of 30 lines can be displayed, or until the text buffer is filled.
803 <para></para></listitem>
808 <command><option>hr</option></command>
809 <option>(height)</option>
812 Horizontal line, height is the height in pixels
813 <para></para></listitem>
818 <command><option>hwmon</option></command>
819 <option>(dev) type n</option>
822 Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omitted if you have only one hwmon device. Parameter type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning temperature. Parameter n is number of the sensor. See /sys/class/hwmon/ on your local computer.
823 <para></para></listitem>
828 <command><option>iconv_start</option></command>
829 <option>codeset_from codeset_to</option>
832 Convert text from one codeset to another using GNU iconv. Needs to be stopped with iconv_stop.
833 <para></para></listitem>
838 <command><option>iconv_stop</option></command>
842 Stop iconv codeset conversion.
843 <para></para></listitem>
848 <command><option>i2c</option></command>
849 <option>(dev) type n</option>
852 I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted if you have only one I2C device. Parameter type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning temperature. Parameter n is number of the sensor. See /sys/bus/i2c/devices/ on your local computer.
853 <para></para></listitem>
858 <command><option>i8k_ac_status</option></command>
862 If running the i8k kernel driver for Inspiron laptops, displays whether ac power is on, as listed in /proc/i8k (translated to human-readable). Beware that this is by default not enabled by i8k itself.
863 <para></para></listitem>
868 <command><option>i8k_bios</option></command>
872 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
873 <para></para></listitem>
878 <command><option>i8k_buttons_status</option></command>
882 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
883 <para></para></listitem>
888 <command><option>i8k_cpu_temp</option></command>
892 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
893 <para></para></listitem>
898 <command><option>i8k_left_fan_rpm</option></command>
902 If running the i8k kernel driver for Inspiron laptops, displays the left fan's rate of rotation, in revolutions per minute as listed in /proc/i8k. Beware, some laptops i8k reports these fans in reverse order.
903 <para></para></listitem>
908 <command><option>i8k_left_fan_status</option></command>
912 If running the i8k kernel driver for Inspiron laptops, displays the left fan status as listed in /proc/i8k (translated to human-readable). Beware, some laptops i8k reports these fans in reverse order.
913 <para></para></listitem>
918 <command><option>i8k_right_fan_rpm</option></command>
922 If running the i8k kernel driver for Inspiron laptops, displays the right fan's rate of rotation, in revolutions per minute as listed in /proc/i8k. Beware, some laptops i8k reports these fans in reverse order.
923 <para></para></listitem>
928 <command><option>i8k_right_fan_status</option></command>
932 If running the i8k kernel driver for Inspiron laptops, displays the right fan status as listed in /proc/i8k (translated to human-readable). Beware, some laptops i8k reports these fans in reverse order.
933 <para></para></listitem>
938 <command><option>i8k_serial</option></command>
942 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
943 <para></para></listitem>
948 <command><option>i8k_version</option></command>
952 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
953 <para></para></listitem>
958 <command><option>ibm_fan</option></command>
961 If running the IBM ACPI, displays the fan speed.
962 <para></para></listitem>
967 <command><option>ibm_temps</option></command>
971 If running the IBM ACPI, displays the temperatures
972 from the IBM temperature sensors (N=0..7) Sensor 0 is
973 on the CPU, 3 is on the GPU.
974 <para></para></listitem>
979 <command><option>ibm_volume</option></command>
982 If running the IBM ACPI, displays the "master" volume,
983 controlled by the volume keys (0-14).
984 <para></para></listitem>
989 <command><option>ibm_brightness</option></command>
992 If running the IBM ACPI, displays the brigtness of the
994 <para></para></listitem>
999 <command><option>if_empty</option></command>
1000 <option>(var)</option>
1003 if conky variable VAR is empty, display everything
1004 between $if_empty and the matching $endif
1005 <para></para></listitem>
1010 <command><option>if_existing</option></command>
1011 <option>file (string)</option>
1014 if FILE exists, display everything between if_existing
1015 and the matching $endif. The optional second paramater
1016 checks for FILE containing the specified string and
1017 prints everything between $if_existing and the matching
1019 <para></para></listitem>
1024 <command><option>if_gw</option></command>
1027 if there is at least one default gateway, display
1028 everything between $if_gw and the matching $endif
1029 <para></para></listitem>
1034 <command><option>if_match</option></command>
1035 <option>expression</option>
1038 Evaluates the given boolean expression, printing
1039 everything between $if_match and the matching $endif
1040 depending on whether the evaluation returns true or not.
1041 Valid expressions consist of a left side, an operator
1042 and a right side. Left and right sides are being parsed
1043 for contained text objects before evaluation. Recognised
1044 left and right side types are:
1046 <member><command>double</command>:
1047 argument consists of only digits and a
1050 <member><command>long</command>:
1051 argument consists of only digits.
1053 <member><command>string</command>:
1054 argument is enclosed in quotation mark
1055 or the checks for double and long failed
1060 '>', '<', '>=', '<=', '==', '!='.
1061 <para></para></listitem>
1066 <command><option>if_running</option></command>
1067 <option>(process)</option>
1070 if PROCESS is running, display everything $if_running
1071 and the matching $endif
1072 <para></para></listitem>
1077 <command><option>if_mounted</option></command>
1078 <option>(mountpoint)</option>
1081 if MOUNTPOINT is mounted, display everything between
1082 $if_mounted and the matching $endif
1083 <para></para></listitem>
1088 <command><option>if_smapi_bat_installed</option></command>
1089 <option>(INDEX)</option>
1092 when using smapi, if the battery with index INDEX is
1093 installed, display everything between
1094 $if_smapi_bat_installed and the matching $endif
1095 <para></para></listitem>
1100 <command><option>if_up</option></command>
1101 <option>(interface)</option>
1104 if INTERFACE exists and is up, display everything between $if_up and the matching $endif
1105 <para></para></listitem>
1110 <command><option>imap_messages</option></command>
1111 <option>(args)</option>
1114 Displays the number of messages in your global IMAP inbox by default. You can define individual IMAP inboxes seperately by passing arguments to this object. Arguments are: "host user pass [-i interval] [-p port] [-e command] [-r retries]". Default port is 143, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1115 <para></para></listitem>
1120 <command><option>imap_unseen</option></command>
1121 <option>(args)</option>
1124 Displays the number of unseen messages in your global IMAP inbox by default. You can define individual IMAP inboxes seperately by passing arguments to this object. Arguments are: "host user pass [-i interval] [-p port] [-e command] [-r retries]". Default port is 143, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1125 <para></para></listitem>
1130 <command><option>ioscheduler</option></command>
1131 <option>disk</option>
1134 Prints the current ioscheduler used for the given disk name (i.e. e.g. "hda" or "sdb")
1135 <para></para></listitem>
1140 <command><option>kernel</option></command>
1144 <para></para></listitem>
1149 <command><option>laptop_mode</option></command>
1152 The value of /proc/sys/vm/laptop_mode
1153 <para></para></listitem>
1158 <command><option>loadavg</option></command>
1161 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
1162 <para></para></listitem>
1167 <command><option>loadgraph</option></command>
1168 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
1171 Load1 average graph, similar to xload, with optional colours in hex, minus the #. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
1172 <para></para></listitem>
1177 <command><option>lines</option></command>
1178 <option>textfile</option>
1181 Displays the number of lines in the given file
1182 <para></para></listitem>
1187 <command><option>machine</option></command>
1190 Machine, i686 for example
1191 <para></para></listitem>
1196 <command><option>mails</option></command>
1197 <option>(mailbox)</option>
1198 <option>(interval)</option>
1201 Mail count in the specified mailbox or your mail spool if not.
1202 Both mbox and maildir type mailboxes are supported. You can
1203 use a program like fetchmail to get mails from some server
1204 using your favourite protocol. See also new_mails.
1205 <para></para></listitem>
1210 <command><option>mboxscan</option></command>
1211 <option>(-n number of messages to print) (-fw from width) (-sw subject width) mbox</option>
1214 Print a summary of recent messages in an mbox format mailbox. mbox parameter is the filename of the mailbox (can be encapsulated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
1215 <para></para></listitem>
1220 <command><option>mem</option></command>
1223 Amount of memory in use
1224 <para></para></listitem>
1229 <command><option>membar</option></command>
1230 <option>(height),(width)</option>
1233 Bar that shows amount of memory in use
1234 <para></para></listitem>
1239 <command><option>memgraph</option></command>
1240 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
1243 Memory usage graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
1244 <para></para></listitem>
1249 <command><option>memeasyfree</option></command>
1252 Amount of free memory including the memory that is very easily freed (buffers/cache)
1253 <para></para></listitem>
1258 <command><option>memfree</option></command>
1261 Amount of free memory
1262 <para></para></listitem>
1267 <command><option>memmax</option></command>
1270 Total amount of memory
1271 <para></para></listitem>
1276 <command><option>memperc</option></command>
1279 Percentage of memory in use
1280 <para></para></listitem>
1285 <command><option>mixer</option></command>
1286 <option>(device)</option>
1289 Prints the mixer value as reported by the OS. Default mixer is "vol", but you can specify one of the following optional arguments: "vol", "bass", "treble", "synth", "pcm", "speaker", "line", "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain", "line1", "line2", "line3", "dig1", "dig2", "dig3", "phin", "phout", "video", "radio", "monitor". Refer to the definition of SOUND_DEVICE_NAMES in <linux/soundcard.h> (on Linux), <soundcard.h> (on OpenBSD), or <sys/soundcard.h> to find the exact options available on your system.
1290 <para></para></listitem>
1295 <command><option>mixerbar</option></command>
1296 <option>(device)</option>
1299 Displays mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
1300 <para></para></listitem>
1305 <command><option>mixerr</option></command>
1306 <option>(device)</option>
1309 Prints the right channel mixer value as reported by the OS. See docs for $mixer for details on arguments.
1310 <para></para></listitem>
1315 <command><option>mixerrbar</option></command>
1316 <option>(device)</option>
1319 Displays the right channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
1320 <para></para></listitem>
1325 <command><option>mixerl</option></command>
1326 <option>(device)</option>
1329 Prints the left channel mixer value as reported by the OS. See docs for $mixer for details on arguments.
1330 <para></para></listitem>
1335 <command><option>mixerlbar</option></command>
1336 <option>(device)</option>
1339 Displays the left channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
1340 <para></para></listitem>
1345 <command><option>moc_state</option></command>
1348 Current state of MOC; playing, stopped etc.
1349 <para></para></listitem>
1354 <command><option>moc_file</option></command>
1357 File name of the current MOC song
1358 <para></para></listitem>
1363 <command><option>moc_title</option></command>
1366 Title of the current MOC song
1367 <para></para></listitem>
1372 <command><option>moc_artist</option></command>
1375 Artist of the current MOC song
1376 <para></para></listitem>
1381 <command><option>moc_song</option></command>
1384 The current song name being played in MOC.
1385 <para></para></listitem>
1390 <command><option>moc_album</option></command>
1393 Album of the current MOC song
1394 <para></para></listitem>
1399 <command><option>moc_totaltime</option></command>
1402 Total length of the current MOC song
1403 <para></para></listitem>
1408 <command><option>moc_timeleft</option></command>
1411 Time left in the current MOC song
1412 <para></para></listitem>
1417 <command><option>moc_curtime</option></command>
1420 Current time of the current MOC song
1421 <para></para></listitem>
1426 <command><option>moc_bitrate</option></command>
1429 Bitrate in the current MOC song
1430 <para></para></listitem>
1435 <command><option>moc_rate</option></command>
1438 Rate of the current MOC song
1439 <para></para></listitem>
1444 <command><option>monitor</option></command>
1447 Number of the monitor on which conky is running
1448 <para></para></listitem>
1453 <command><option>monitor_number</option></command>
1457 <para></para></listitem>
1462 <command><option>mpd_artist</option></command>
1465 Artist in current MPD song must be enabled at compile
1466 <para></para></listitem>
1471 <command><option>mpd_album</option></command>
1474 Album in current MPD song
1475 <para></para></listitem>
1480 <command><option>mpd_bar</option></command>
1481 <option>(height),(width)</option>
1484 Bar of mpd's progress
1485 <para></para></listitem>
1490 <command><option>mpd_bitrate</option></command>
1493 Bitrate of current song
1494 <para></para></listitem>
1499 <command><option>mpd_status</option></command>
1502 Playing, stopped, et cetera.
1503 <para></para></listitem>
1508 <command><option>mpd_title</option></command>
1509 <option>(max length)</option>
1512 Title of current MPD song
1513 <para></para></listitem>
1518 <command><option>mpd_vol</option></command>
1522 <para></para></listitem>
1527 <command><option>mpd_elapsed</option></command>
1531 <para></para></listitem>
1536 <command><option>mpd_length</option></command>
1540 <para></para></listitem>
1545 <command><option>mpd_percent</option></command>
1548 Percent of song's progress
1549 <para></para></listitem>
1554 <command><option>mpd_random</option></command>
1557 Random status (On/Off)
1558 <para></para></listitem>
1563 <command><option>mpd_repeat</option></command>
1566 Repeat status (On/Off)
1567 <para></para></listitem>
1572 <command><option>mpd_track</option></command>
1575 Prints the MPD track field
1576 <para></para></listitem>
1581 <command><option>mpd_name</option></command>
1584 Prints the MPD name field
1585 <para></para></listitem>
1590 <command><option>mpd_file</option></command>
1593 Prints the file name of the current MPD song
1594 <para></para></listitem>
1599 <command><option>mpd_smart</option></command>
1600 <option>(max length)</option>
1603 Prints the song name in either the form "artist - title" or file name, depending on whats available
1604 <para></para></listitem>
1609 <command><option>if_mpd_playing</option></command>
1612 if mpd is playing or paused, display everything between $if_mpd_playing and the matching $endif
1613 <para></para></listitem>
1618 <command><option>nameserver</option></command>
1619 <option>(index)</option>
1622 Print a nameserver from /etc/resolv.conf. Index starts at and defaults to 0.
1623 <para></para></listitem>
1628 <command><option>new_mails</option></command>
1629 <option>(mailbox)</option>
1630 <option>(interval)</option>
1633 Unread mail count in the specified mailbox or mail spool if
1634 not. Both mbox and maildir type mailboxes are supported.
1635 <para></para></listitem>
1640 <command><option>nodename</option></command>
1644 <para></para></listitem>
1649 <command><option>nvidia</option></command>
1650 <option>threshold</option>
1651 <option>temp</option>
1652 <option>gpufreq</option>
1653 <option>memfreq</option>
1654 <option>imagequality</option>
1657 Nvidia graficcard support for the XNVCtrl library.
1658 Each option can be shortened to the least significant part.
1659 Temperatures are printed as float, all other values as integer.
1661 <member><command>threshold</command>:
1662 the thresholdtemperature at which the gpu slows down
1664 <member><command>temp</command>:
1665 gives the gpu current temperature
1667 <member><command>gpufreq</command>:
1668 gives the current gpu frequency
1670 <member><command>memfreq</command>:
1671 gives the current mem frequency
1673 <member><command>imagequality</command>:
1674 which imagequality should be choosen by OpenGL applications
1683 <command><option>outlinecolor</option></command>
1684 <option>(color)</option>
1687 Change outline color
1688 <para></para></listitem>
1693 <command><option>pb_battery</option></command>
1694 <option>item</option>
1697 If running on Apple powerbook/ibook, display
1698 information on battery status. The item parameter
1699 specifies, what information to display. Exactly one item
1700 must be specified. Valid items are:
1702 <member><command>status</command>:
1703 Display if battery is fully charged, charging,
1704 discharging or absent (running on AC)
1706 <member><command>percent</command>:
1707 Display charge of battery in percent, if
1708 charging or discharging. Nothing will be
1709 displayed, if battery is fully charged
1712 <member><command>time</command>:
1713 Display the time remaining until the battery
1714 will be fully charged or discharged at current
1715 rate. Nothing is displayed, if battery is
1716 absent or if it's present but fully charged
1717 and not discharging.
1720 <para></para></listitem>
1725 <command><option>platform</option></command>
1726 <option>(dev) type n</option>
1729 Platform sensor from sysfs (Linux 2.6). Parameter dev may be omitted if you have only one platform device. Platform type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning temperature. Parameter n is number of the sensor. See /sys/bus/platform/devices/ on your local computer.
1730 <para></para></listitem>
1735 <command><option>pop3_unseen</option></command>
1736 <option>(args)</option>
1739 Displays the number of unseen messages in your global POP3 inbox by default. You can define individual POP3 inboxes seperately by passing arguments to this object. Arguments are: "host user pass [-i interval] [-p port] [-e command] [-r retries]". Default port is 110, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1741 <para></para></listitem>
1746 <command><option>pop3_used</option></command>
1747 <option>(args)</option>
1750 Displays the amount of space (in MiB, 2^20) used in your global POP3 inbox by default. You can define individual POP3 inboxes seperately by passing arguments to this object. Arguments are: "host user pass [-i interval] [-p port] [-e command] [-r retries]". Default port is 110, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1752 <para></para></listitem>
1757 <command><option>pre_exec</option></command>
1758 <option>shell command</option>
1761 Executes a shell command one time before conky displays anything and puts output as text.
1762 <para></para></listitem>
1767 <command><option>processes</option></command>
1770 Total processes (sleeping and running)
1771 <para></para></listitem>
1776 <command><option>running_processes</option></command>
1779 Running processes (not sleeping), requires Linux 2.6
1780 <para></para></listitem>
1785 <command><option>scroll</option></command>
1786 <option>length (step) text</option>
1789 Scroll 'text' by 'step' characters showing 'length' number of characters at the same time. The text may also contain variables. 'step' is optional and defaults to 1 if not set. If a var creates output on multiple lines then the lines are placed behind each other separated with a '|'-sign. Do NOT use vars that change colors or otherwise affect the design inside a scrolling text. If you want spaces between the start and the end of 'text', place them at the end of 'text' not at the front ("foobar" and " foobar" can both generate "barfoo" but "foobar " will keep the spaces like this "bar foo").
1790 <para></para></listitem>
1795 <command><option>shadecolor</option></command>
1796 <option>(color)</option>
1799 Change shading color
1800 <para></para></listitem>
1805 <command><option>smapi</option></command>
1806 <option>(ARGS)</option>
1809 when using smapi, display contents of the /sys/devices/platform/smapi directory. ARGS are either '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the corresponding files' content. This is a very raw method of accessing the smapi values. When available, better use one of the smapi_* variables instead.
1810 <para></para></listitem>
1815 <command><option>smapi_bat_bar</option></command>
1816 <option>(INDEX),(height),(width)</option>
1819 when using smapi, display the remaining capacity of the battery with index INDEX as a bar.
1820 <para></para></listitem>
1825 <command><option>smapi_bat_perc</option></command>
1826 <option>(INDEX)</option>
1829 when using smapi, display the remaining capacity in percent of the battery with index INDEX. This is a separate variable because it supports the 'use_spacer' configuration option.
1830 <para></para></listitem>
1835 <command><option>smapi_bat_power</option></command>
1836 <option>INDEX</option>
1839 when using smapi, display the current power of the battery with index INDEX in watt. This is a separate variable because the original read out value is being converted from mW. The sign of the output reflects charging (positive) or discharging (negative) state.
1840 <para></para></listitem>
1845 <command><option>smapi_bat_temp</option></command>
1846 <option>INDEX</option>
1849 when using smapi, display the current temperature of the battery with index INDEX in degree Celsius. This is a separate variable because the original read out value is being converted from milli degree Celsius.
1850 <para></para></listitem>
1855 <command><option>stippled_hr</option></command>
1856 <option>(space)</option>
1859 Stippled (dashed) horizontal line
1860 <para></para></listitem>
1865 <command><option>swapbar</option></command>
1866 <option>(height),(width)</option>
1869 Bar that shows amount of swap in use
1870 <para></para></listitem>
1875 <command><option>swap</option></command>
1878 Amount of swap in use
1879 <para></para></listitem>
1884 <command><option>swapmax</option></command>
1887 Total amount of swap
1888 <para></para></listitem>
1893 <command><option>swapperc</option></command>
1896 Percentage of swap in use
1897 <para></para></listitem>
1902 <command><option>sysname</option></command>
1905 System name, Linux for example
1906 <para></para></listitem>
1911 <command><option>tcp_portmon</option></command>
1912 <option>port_begin port_end item (index)</option>
1913 <emphasis>(ip4 only at present)</emphasis>
1916 TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
1918 <member><command>count</command> - total number of connections in the range
1920 <member><command>rip</command> - remote ip address
1922 <member><command>rhost</command> - remote host name
1924 <member><command>rport</command> - remote port number
1926 <member><command>rservice</command> - remote service name from /etc/services
1928 <member><command>lip</command> - local ip address
1930 <member><command>lhost</command> - local host name
1932 <member><command>lport</command> - local port number
1934 <member><command>lservice</command> - local service name from /etc/services
1936 </simplelist>The connection index provides you with access to each connection in the port monitor. The monitor will return information for index values from 0 to n-1 connections. Values higher than n-1 are simply ignored. For the "count" item, the connection index must be omitted. It is required for all other items.
1938 <member>Examples:</member>
1939 <member><command>${tcp_portmon 6881 6999 count}</command> -
1940 displays the number of connections in the bittorrent port range</member>
1941 <member><command>${tcp_portmon 22 22 rip 0}</command> -
1942 displays the remote host ip of the first sshd connection</member>
1943 <member><command>${tcp_portmon 22 22 rip 9}</command> -
1944 displays the remote host ip of the tenth sshd connection</member>
1945 <member><command>${tcp_portmon 1 1024 rhost 0}</command> -
1946 displays the remote host name of the first connection on a privileged port</member>
1947 <member><command>${tcp_portmon 1 1024 rport 4}</command> -
1948 displays the remote host port of the fifth connection on a privileged port</member>
1949 <member><command>${tcp_portmon 1 65535 lservice 14}</command> -
1950 displays the local service name of the fifteenth connection in the range of all ports</member>
1951 </simplelist>Note that port monitor variables which share the same port range actually refer to the same monitor, so many references to a single port range for different items and different indexes all use the same monitor internally. In other words, the program avoids creating redundant monitors.
1957 <command><option>texeci</option></command>
1958 <option>interval command</option>
1961 Runs a command at an interval inside a thread and displays the output. Same as $execi, except the command is run inside a thread. Use this if you have a slow script to keep Conky updating. You should make the interval slightly longer then the time it takes your script to execute. For example, if you have a script that take 5 seconds to execute, you should make the interval at least 6 seconds. See also $execi.
1962 <para></para></listitem>
1967 <command><option>offset</option></command>
1968 <option>(pixels)</option>
1971 Move text over by N pixels. See also $voffset.
1972 <para></para></listitem>
1977 <command><option>rss</option></command>
1978 <option>url delay_in_minutes action item_num</option>
1981 Download and parse RSS feeds. Action may be one of the following: feed_title, item_title (with num par), item_desc (with num par) and item_titles.
1982 <para></para></listitem>
1987 <command><option>tab</option></command>
1988 <option>(width, (start))</option>
1991 Puts a tab of the specified width, starting from column 'start'.
1992 <para></para></listitem>
1997 <command><option>tail</option></command>
1998 <option>logfile lines (interval)</option>
2001 Displays last N lines of supplied text text file. If interval is not supplied, Conky assumes 2x Conky's interval. Max of 30 lines can be displayed, or until the text buffer is filled.
2002 <para></para></listitem>
2007 <command><option>templateN</option></command>
2008 <option>(arg1)</option>
2009 <option>(arg2)</option>
2010 <option>(arg3 ...)</option>
2013 Evaluate the content of the templateN configuration variable (where N is a value between 0 and 9, inclusively),
2014 applying substitutions as described in the documentation of the corresponding configuration variable.
2015 The number of arguments is optional, but must match the highest referred index in the template. You can use the
2016 same special sequences in each argument as the ones valid for a template definition, e.g. to allow an argument
2017 to contain a whitespace. Also simple nesting of templates is possible this way.
2018 <para></para></listitem>
2020 Here are some examples of template definitions:
2022 <member>template0 $\1\2</member>
2023 <member>template1 \1: ${fs_used \2} / ${fs_size \2}</member>
2024 <member>template2 \1 \2</member>
2026 The following list shows sample usage of the templates defined above,
2027 with the equivalent syntax when not using any template at all:
2031 <row rowsep="1"><entry>using template</entry><entry>same without template</entry></row>
2034 <row><entry>${template0 node name}</entry><entry>$nodename</entry></row>
2035 <row><entry>${template1 root /}</entry><entry>root: ${fs_free /} / ${fs_size /}</entry></row>
2037 <entry><programlisting>${template1 ${template2\ disk\ root} /}</programlisting></entry>
2038 <entry><programlisting>disk root: ${fs_free /} / ${fs_size /}</programlisting></entry>
2043 <para></para></listitem>
2048 <command><option>time</option></command>
2049 <option>(format)</option>
2052 Local time, see man strftime to get more information about format
2053 <para></para></listitem>
2058 <command><option>utime</option></command>
2059 <option>(format)</option>
2062 Display time in UTC (universal coordinate time).
2063 <para></para></listitem>
2068 <command><option>tztime</option></command>
2069 <option>(timezone) (format)</option>
2072 Local time for specified timezone, see man strftime to get more information about format. The timezone argument is specified in similar fashion as TZ environment variable. For hints, look in /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
2073 <para></para></listitem>
2078 <command><option>totaldown</option></command>
2079 <option>net</option>
2082 Total download, overflows at 4 GB on Linux with 32-bit arch and there doesn't seem to be a way to know how many times it has already done that before conky has started.
2083 <para></para></listitem>
2088 <command><option>top</option></command>
2089 <option>type, num</option>
2092 This takes arguments in the form:top (name) (number) Basically, processes are ranked from highest to lowest in terms of cpu usage, which is what (num) represents. The types are: "name", "pid", "cpu", "mem", "mem_res", "mem_vsize", and "time". There can be a max of 10 processes listed.
2093 <para></para></listitem>
2098 <command><option>top_mem</option></command>
2099 <option>type, num</option>
2102 Same as top, except sorted by mem usage instead of cpu
2103 <para></para></listitem>
2108 <command><option>top_time</option></command>
2109 <option>type, num</option>
2112 Same as top, except sorted by total CPU time instead of current CPU usage
2113 <para></para></listitem>
2118 <command><option>totalup</option></command>
2119 <option>net</option>
2122 Total upload, this one too, may overflow
2123 <para></para></listitem>
2128 <command><option>updates</option></command>
2129 <option>Number of updates</option>
2133 <para></para></listitem>
2138 <command><option>upspeed</option></command>
2139 <option>net</option>
2143 <para></para></listitem>
2148 <command><option>upspeedf</option></command>
2149 <option>net</option>
2152 Upload speed in KiB with one decimal
2153 <para></para></listitem>
2158 <command><option>upspeedgraph</option></command>
2159 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (net)</option>
2162 Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
2163 <para></para></listitem>
2168 <command><option>uptime</option></command>
2172 <para></para></listitem>
2177 <command><option>uptime_short</option></command>
2180 Uptime in a shorter format
2181 <para></para></listitem>
2186 <command><option>user_number</option></command>
2189 Number of users logged in
2190 <para></para></listitem>
2195 <command><option>user_names</option></command>
2198 Lists the names of the users logged in
2199 <para></para></listitem>
2204 <command><option>user_terms</option></command>
2207 Lists the consoles in use
2208 <para></para></listitem>
2213 <command><option>user_times</option></command>
2216 Lists how long users have been logged in for
2217 <para></para></listitem>
2222 <command><option>voffset</option></command>
2223 <option>(pixels)</option>
2226 Change vertical offset by N pixels. Negative values will cause text to overlap. See also $offset.
2227 <para></para></listitem>
2232 <command><option>voltage_mv</option></command>
2233 <option>(n)</option>
2236 Returns CPU #n's voltage in mV. CPUs are
2237 counted from 1. If omitted, the parameter
2239 <para></para></listitem>
2244 <command><option>voltage_v</option></command>
2245 <option>(n)</option>
2248 Returns CPU #n's voltage in V. CPUs are
2249 counted from 1. If omitted, the parameter
2251 <para></para></listitem>
2256 <command><option>wireless_essid</option></command>
2257 <option>net</option>
2260 Wireless access point ESSID (Linux only)
2261 <para></para></listitem>
2266 <command><option>wireless_mode</option></command>
2267 <option>net</option>
2270 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
2271 <para></para></listitem>
2276 <command><option>wireless_bitrate</option></command>
2277 <option>net</option>
2280 Wireless bitrate (ie 11 Mb/s) (Linux only)
2281 <para></para></listitem>
2286 <command><option>wireless_ap</option></command>
2287 <option>net</option>
2290 Wireless access point MAC address (Linux only)
2291 <para></para></listitem>
2296 <command><option>wireless_link_qual</option></command>
2297 <option>net</option>
2300 Wireless link quality (Linux only)
2301 <para></para></listitem>
2306 <command><option>wireless_link_qual_max</option></command>
2307 <option>net</option>
2310 Wireless link quality maximum value (Linux only)
2311 <para></para></listitem>
2316 <command><option>wireless_link_qual_perc</option></command>
2317 <option>net</option>
2320 Wireless link quality in percents (Linux only)
2321 <para></para></listitem>
2326 <command><option>wireless_link_bar</option></command>
2327 <option>(height), (width) net</option>
2330 Wireless link quality bar (Linux only)
2331 <para></para></listitem>
2336 <command><option>words</option></command>
2337 <option>textfile</option>
2340 Displays the number of words in the given file
2341 <para></para></listitem>
2346 <command><option>xmms2_artist</option></command>
2349 Artist in current XMMS2 song
2350 <para></para></listitem>
2355 <command><option>xmms2_album</option></command>
2358 Album in current XMMS2 song
2359 <para></para></listitem>
2364 <command><option>xmms2_title</option></command>
2367 Title in current XMMS2 song
2368 <para></para></listitem>
2373 <command><option>xmms2_genre</option></command>
2376 Genre in current XMMS2 song
2377 <para></para></listitem>
2382 <command><option>xmms2_comment</option></command>
2385 Comment in current XMMS2 song
2386 <para></para></listitem>
2391 <command><option>xmms2_decoder</option></command>
2395 <para></para></listitem>
2400 <command><option>xmms2_transport</option></command>
2403 Transport plugin used
2404 <para></para></listitem>
2409 <command><option>xmms2_url</option></command>
2412 Full path to current song
2413 <para></para></listitem>
2418 <command><option>xmms2_tracknr</option></command>
2421 Track number in current XMMS2 song
2422 <para></para></listitem>
2427 <command><option>xmms2_bitrate</option></command>
2430 Bitrate of current song
2431 <para></para></listitem>
2436 <command><option>xmms2_id</option></command>
2439 XMMS2 id of current song
2440 <para></para></listitem>
2445 <command><option>xmms2_duration</option></command>
2448 Duration of current song
2449 <para></para></listitem>
2454 <command><option>xmms2_elapsed</option></command>
2458 <para></para></listitem>
2463 <command><option>xmms2_size</option></command>
2466 Size of current song
2467 <para></para></listitem>
2472 <command><option>xmms2_percent</option></command>
2475 Percent of song's progress
2476 <para></para></listitem>
2481 <command><option>xmms2_status</option></command>
2484 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
2485 <para></para></listitem>
2490 <command><option>xmms2_bar</option></command>
2491 <option>(height),(width)</option>
2494 Bar of XMMS2's progress
2495 <para></para></listitem>
2500 <command><option>xmms2_smart</option></command>
2503 Prints the song name in either the form "artist - title" or file name, depending on whats available
2504 <para></para></listitem>
2508 <command><option>if_xmms2_connected</option></command>
2511 Display everything between $if_xmms2_connected and the matching $endif if xmms2 is running.
2512 <para></para></listitem>
2517 <command><option>eve</option></command>
2518 <option>api_userid api_key character_id</option>
2521 Fetches your currently training skill from the Eve Online API servers (http://www.eve-online.com/) and displays the skill along with the remaining training time.
2522 <para></para></listitem>
projects / monky / blob