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_short</option></command>
257 <option>(num)</option>
260 Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
261 This mode display a short status, which means that C is displayed instead of charging and D is displayed instead of discharging.
262 <para></para></listitem>
267 <command><option>battery_bar</option></command>
268 <option>(height),(width) (num)</option>
271 Battery percentage remaining of ACPI battery in a bar. ACPI battery number can be given as argument (default is BAT0).
272 <para></para></listitem>
277 <command><option>battery_percent</option></command>
278 <option>(num)</option>
281 Battery percentage remaining for ACPI battery. ACPI battery number can be given as argument (default is BAT0).
282 <para></para></listitem>
287 <command><option>battery_time</option></command>
288 <option>(num)</option>
291 Battery charge/discharge time remaining of ACPI battery. ACPI battery number can be given as argument (default is BAT0).
292 <para></para></listitem>
297 <command><option>bmpx_artist</option></command>
300 Artist in current BMPx track
301 <para></para></listitem>
306 <command><option>bmpx_album</option></command>
309 Album in current BMPx track
310 <para></para></listitem>
315 <command><option>bmpx_title</option></command>
318 Title of the current BMPx track
319 <para></para></listitem>
324 <command><option>bmpx_track</option></command>
327 Track number of the current BMPx track
328 <para></para></listitem>
333 <command><option>bmpx_bitrate</option></command>
336 Bitrate of the current BMPx track
337 <para></para></listitem>
342 <command><option>bmpx_uri</option></command>
345 URI of the current BMPx track
346 <para></para></listitem>
351 <command><option>buffers</option></command>
354 Amount of memory buffered
355 <para></para></listitem>
360 <command><option>cached</option></command>
363 Amount of memory cached
364 <para></para></listitem>
369 <command><option>color</option></command>
370 <option>(color)</option>
373 Change drawing color to color
374 <para></para></listitem>
378 <term><command><option>colorN</option></command></term>
380 Change drawing color to colorN configuration option, where N is a digit between 0 and 9, inclusively.
381 <para></para></listitem>
386 <command><option>conky_version</option></command>
390 <para></para></listitem>
395 <command><option>conky_build_date</option></command>
399 <para></para></listitem>
404 <command><option>conky_build_arch</option></command>
407 CPU architecture Conky was built for
408 <para></para></listitem>
413 <command><option>cpu</option></command>
414 <option>(cpuN)</option>
417 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.
418 <para></para></listitem>
423 <command><option>cpubar</option></command>
424 <option>(cpu number) (height),(width)</option>
427 Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
428 <para></para></listitem>
433 <command><option>cpugraph</option></command>
434 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (cpu number)</option>
437 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".
438 <para></para></listitem>
443 <command><option>diskio</option></command>
444 <option>(device)</option>
447 Displays current disk IO. Device is optional, and takes the form of sda for /dev/sda. Individual partitions are allowed.
448 <para></para></listitem>
453 <command><option>diskiograph</option></command>
454 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)</option>
457 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".
458 <para></para></listitem>
463 <command><option>diskio_read</option></command>
464 <option>(device)</option>
467 Displays current disk IO for reads. Device as in diskio.
468 <para></para></listitem>
473 <command><option>diskiograph_read</option></command>
474 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)</option>
477 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".
478 <para></para></listitem>
483 <command><option>diskio_write</option></command>
484 <option>(device)</option>
487 Displays current disk IO for writes. Device as in diskio.
488 <para></para></listitem>
493 <command><option>diskiograph_write</option></command>
494 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)</option>
497 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".
498 <para></para></listitem>
503 <command><option>disk_protect</option></command>
504 <option>device</option>
507 Disk protection status, if supported (needs kernel-patch). Prints either "frozen" or "free " (note the padding).
508 <para></para></listitem>
513 <command><option>downspeed</option></command>
517 Download speed in KiB
518 <para></para></listitem>
523 <command><option>downspeedf</option></command>
527 Download speed in KiB with one decimal
528 <para></para></listitem>
533 <command><option>downspeedgraph</option></command>
534 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (net)</option>
537 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".
538 <para></para></listitem>
543 <command><option>else</option></command>
546 Text to show if any of the above are not true
547 <para></para></listitem>
552 <command><option>entropy_avail</option></command>
555 Current entropy available for crypto freaks
556 <para></para></listitem>
561 <command><option>entropy_bar</option></command>
562 <option>(height),(width)</option>
565 Normalized bar of available entropy for crypto freaks
566 <para></para></listitem>
571 <command><option>entropy_poolsize</option></command>
574 Total size of system entropy pool for crypto freaks
575 <para></para></listitem>
580 <command><option>exec</option></command>
581 <option>command</option>
584 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.
585 <para></para></listitem>
590 <command><option>execbar</option></command>
591 <option>command</option>
594 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.
595 <para></para></listitem>
600 <command><option>execgraph</option></command>
601 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) command</option>
604 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.
605 <para></para></listitem>
610 <command><option>execi</option></command>
611 <option>interval command</option>
614 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
615 <para></para></listitem>
620 <command><option>execibar</option></command>
621 <option>interval command</option>
624 Same as execbar, except with an interval
625 <para></para></listitem>
630 <command><option>execigraph</option></command>
631 <option>interval command</option>
634 Same as execgraph, but takes an interval arg graphs values
635 <para></para></listitem>
640 <command><option>execp</option></command>
641 <option>command</option>
644 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.
645 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.
646 <para></para></listitem>
651 <command><option>execpi</option></command>
652 <option>interval command</option>
655 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.
656 <para></para></listitem>
661 <command><option>font</option></command>
662 <option>(font)</option>
665 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)
666 <para></para></listitem>
671 <command><option>freq</option></command>
675 Returns CPU #n's frequency in MHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
676 <para></para></listitem>
680 <command><option>freq_g</option></command>
684 Returns CPU #n's frequency in GHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
685 <para></para></listitem>
690 <command><option>freq_dyn</option></command>
694 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.
695 <para></para></listitem>
700 <command><option>freq_dyn_g</option></command>
704 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.
705 <para></para></listitem>
710 <command><option>fs_bar</option></command>
711 <option>(height),(width) fs</option>
714 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.
715 <para></para></listitem>
720 <command><option>fs_free</option></command>
721 <option>(fs)</option>
724 Free space on a file system available for users.
725 <para></para></listitem>
730 <command><option>fs_free_perc</option></command>
731 <option>(fs)</option>
734 Free percentage of space on a file system available for users.
735 <para></para></listitem>
740 <command><option>fs_size</option></command>
741 <option>(fs)</option>
745 <para></para></listitem>
750 <command><option>fs_type</option></command>
751 <option>(fs)</option>
755 <para></para></listitem>
760 <command><option>fs_used</option></command>
761 <option>(fs)</option>
764 File system used space
765 <para></para></listitem>
770 <command><option>goto</option></command>
774 The next element will be printed at position 'x'.
775 <para></para></listitem>
780 <command><option>gw_iface</option></command>
783 Displays the default route's interface or "multiple"/"none" accordingly.
784 <para></para></listitem>
789 <command><option>gw_ip</option></command>
792 Displays the default gateway's IP or "multiple"/"none" accordingly.
793 <para></para></listitem>
798 <command><option>hddtemp</option></command>
799 <option>dev, (host,(port))</option>
802 Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
803 Default host is 127.0.0.1, default port is 7634.
804 <para></para></listitem>
809 <command><option>head</option></command>
810 <option>logfile lines (interval)</option>
813 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.
814 <para></para></listitem>
819 <command><option>hr</option></command>
820 <option>(height)</option>
823 Horizontal line, height is the height in pixels
824 <para></para></listitem>
829 <command><option>hwmon</option></command>
830 <option>(dev) type n</option>
833 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.
834 <para></para></listitem>
839 <command><option>iconv_start</option></command>
840 <option>codeset_from codeset_to</option>
843 Convert text from one codeset to another using GNU iconv. Needs to be stopped with iconv_stop.
844 <para></para></listitem>
849 <command><option>iconv_stop</option></command>
853 Stop iconv codeset conversion.
854 <para></para></listitem>
859 <command><option>i2c</option></command>
860 <option>(dev) type n</option>
863 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.
864 <para></para></listitem>
869 <command><option>i8k_ac_status</option></command>
873 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.
874 <para></para></listitem>
879 <command><option>i8k_bios</option></command>
883 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
884 <para></para></listitem>
889 <command><option>i8k_buttons_status</option></command>
893 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
894 <para></para></listitem>
899 <command><option>i8k_cpu_temp</option></command>
903 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
904 <para></para></listitem>
909 <command><option>i8k_left_fan_rpm</option></command>
913 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.
914 <para></para></listitem>
919 <command><option>i8k_left_fan_status</option></command>
923 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.
924 <para></para></listitem>
929 <command><option>i8k_right_fan_rpm</option></command>
933 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.
934 <para></para></listitem>
939 <command><option>i8k_right_fan_status</option></command>
943 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.
944 <para></para></listitem>
949 <command><option>i8k_serial</option></command>
953 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
954 <para></para></listitem>
959 <command><option>i8k_version</option></command>
963 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
964 <para></para></listitem>
969 <command><option>ibm_fan</option></command>
972 If running the IBM ACPI, displays the fan speed.
973 <para></para></listitem>
978 <command><option>ibm_temps</option></command>
982 If running the IBM ACPI, displays the temperatures
983 from the IBM temperature sensors (N=0..7) Sensor 0 is
984 on the CPU, 3 is on the GPU.
985 <para></para></listitem>
990 <command><option>ibm_volume</option></command>
993 If running the IBM ACPI, displays the "master" volume,
994 controlled by the volume keys (0-14).
995 <para></para></listitem>
1000 <command><option>ibm_brightness</option></command>
1003 If running the IBM ACPI, displays the brigtness of the
1004 laptops's LCD (0-7).
1005 <para></para></listitem>
1010 <command><option>if_empty</option></command>
1011 <option>(var)</option>
1014 if conky variable VAR is empty, display everything
1015 between $if_empty and the matching $endif
1016 <para></para></listitem>
1021 <command><option>if_existing</option></command>
1022 <option>file (string)</option>
1025 if FILE exists, display everything between if_existing
1026 and the matching $endif. The optional second paramater
1027 checks for FILE containing the specified string and
1028 prints everything between $if_existing and the matching
1030 <para></para></listitem>
1035 <command><option>if_gw</option></command>
1038 if there is at least one default gateway, display
1039 everything between $if_gw and the matching $endif
1040 <para></para></listitem>
1045 <command><option>if_match</option></command>
1046 <option>expression</option>
1049 Evaluates the given boolean expression, printing
1050 everything between $if_match and the matching $endif
1051 depending on whether the evaluation returns true or not.
1052 Valid expressions consist of a left side, an operator
1053 and a right side. Left and right sides are being parsed
1054 for contained text objects before evaluation. Recognised
1055 left and right side types are:
1057 <member><command>double</command>:
1058 argument consists of only digits and a
1061 <member><command>long</command>:
1062 argument consists of only digits.
1064 <member><command>string</command>:
1065 argument is enclosed in quotation mark
1066 or the checks for double and long failed
1071 '>', '<', '>=', '<=', '==', '!='.
1072 <para></para></listitem>
1077 <command><option>if_running</option></command>
1078 <option>(process)</option>
1081 if PROCESS is running, display everything $if_running
1082 and the matching $endif
1083 <para></para></listitem>
1088 <command><option>if_mounted</option></command>
1089 <option>(mountpoint)</option>
1092 if MOUNTPOINT is mounted, display everything between
1093 $if_mounted and the matching $endif
1094 <para></para></listitem>
1099 <command><option>if_smapi_bat_installed</option></command>
1100 <option>(INDEX)</option>
1103 when using smapi, if the battery with index INDEX is
1104 installed, display everything between
1105 $if_smapi_bat_installed and the matching $endif
1106 <para></para></listitem>
1111 <command><option>if_up</option></command>
1112 <option>(interface)</option>
1115 if INTERFACE exists and is up, display everything between $if_up and the matching $endif
1116 <para></para></listitem>
1121 <command><option>imap_messages</option></command>
1122 <option>(args)</option>
1125 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.
1126 <para></para></listitem>
1131 <command><option>imap_unseen</option></command>
1132 <option>(args)</option>
1135 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.
1136 <para></para></listitem>
1141 <command><option>ioscheduler</option></command>
1142 <option>disk</option>
1145 Prints the current ioscheduler used for the given disk name (i.e. e.g. "hda" or "sdb")
1146 <para></para></listitem>
1151 <command><option>kernel</option></command>
1155 <para></para></listitem>
1160 <command><option>laptop_mode</option></command>
1163 The value of /proc/sys/vm/laptop_mode
1164 <para></para></listitem>
1169 <command><option>loadavg</option></command>
1172 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
1173 <para></para></listitem>
1178 <command><option>loadgraph</option></command>
1179 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
1182 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".
1183 <para></para></listitem>
1188 <command><option>lines</option></command>
1189 <option>textfile</option>
1192 Displays the number of lines in the given file
1193 <para></para></listitem>
1198 <command><option>machine</option></command>
1201 Machine, i686 for example
1202 <para></para></listitem>
1207 <command><option>mails</option></command>
1208 <option>(mailbox)</option>
1209 <option>(interval)</option>
1212 Mail count in the specified mailbox or your mail spool if not.
1213 Both mbox and maildir type mailboxes are supported. You can
1214 use a program like fetchmail to get mails from some server
1215 using your favourite protocol. See also new_mails.
1216 <para></para></listitem>
1221 <command><option>mboxscan</option></command>
1222 <option>(-n number of messages to print) (-fw from width) (-sw subject width) mbox</option>
1225 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"}
1226 <para></para></listitem>
1231 <command><option>mem</option></command>
1234 Amount of memory in use
1235 <para></para></listitem>
1240 <command><option>membar</option></command>
1241 <option>(height),(width)</option>
1244 Bar that shows amount of memory in use
1245 <para></para></listitem>
1250 <command><option>memgraph</option></command>
1251 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
1254 Memory usage graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
1255 <para></para></listitem>
1260 <command><option>memeasyfree</option></command>
1263 Amount of free memory including the memory that is very easily freed (buffers/cache)
1264 <para></para></listitem>
1269 <command><option>memfree</option></command>
1272 Amount of free memory
1273 <para></para></listitem>
1278 <command><option>memmax</option></command>
1281 Total amount of memory
1282 <para></para></listitem>
1287 <command><option>memperc</option></command>
1290 Percentage of memory in use
1291 <para></para></listitem>
1296 <command><option>mixer</option></command>
1297 <option>(device)</option>
1300 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.
1301 <para></para></listitem>
1306 <command><option>mixerbar</option></command>
1307 <option>(device)</option>
1310 Displays mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
1311 <para></para></listitem>
1316 <command><option>mixerr</option></command>
1317 <option>(device)</option>
1320 Prints the right channel mixer value as reported by the OS. See docs for $mixer for details on arguments.
1321 <para></para></listitem>
1326 <command><option>mixerrbar</option></command>
1327 <option>(device)</option>
1330 Displays the right channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
1331 <para></para></listitem>
1336 <command><option>mixerl</option></command>
1337 <option>(device)</option>
1340 Prints the left channel mixer value as reported by the OS. See docs for $mixer for details on arguments.
1341 <para></para></listitem>
1346 <command><option>mixerlbar</option></command>
1347 <option>(device)</option>
1350 Displays the left channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
1351 <para></para></listitem>
1356 <command><option>moc_state</option></command>
1359 Current state of MOC; playing, stopped etc.
1360 <para></para></listitem>
1365 <command><option>moc_file</option></command>
1368 File name of the current MOC song
1369 <para></para></listitem>
1374 <command><option>moc_title</option></command>
1377 Title of the current MOC song
1378 <para></para></listitem>
1383 <command><option>moc_artist</option></command>
1386 Artist of the current MOC song
1387 <para></para></listitem>
1392 <command><option>moc_song</option></command>
1395 The current song name being played in MOC.
1396 <para></para></listitem>
1401 <command><option>moc_album</option></command>
1404 Album of the current MOC song
1405 <para></para></listitem>
1410 <command><option>moc_totaltime</option></command>
1413 Total length of the current MOC song
1414 <para></para></listitem>
1419 <command><option>moc_timeleft</option></command>
1422 Time left in the current MOC song
1423 <para></para></listitem>
1428 <command><option>moc_curtime</option></command>
1431 Current time of the current MOC song
1432 <para></para></listitem>
1437 <command><option>moc_bitrate</option></command>
1440 Bitrate in the current MOC song
1441 <para></para></listitem>
1446 <command><option>moc_rate</option></command>
1449 Rate of the current MOC song
1450 <para></para></listitem>
1455 <command><option>monitor</option></command>
1458 Number of the monitor on which conky is running
1459 <para></para></listitem>
1464 <command><option>monitor_number</option></command>
1468 <para></para></listitem>
1473 <command><option>mpd_artist</option></command>
1476 Artist in current MPD song must be enabled at compile
1477 <para></para></listitem>
1482 <command><option>mpd_album</option></command>
1485 Album in current MPD song
1486 <para></para></listitem>
1491 <command><option>mpd_bar</option></command>
1492 <option>(height),(width)</option>
1495 Bar of mpd's progress
1496 <para></para></listitem>
1501 <command><option>mpd_bitrate</option></command>
1504 Bitrate of current song
1505 <para></para></listitem>
1510 <command><option>mpd_status</option></command>
1513 Playing, stopped, et cetera.
1514 <para></para></listitem>
1519 <command><option>mpd_title</option></command>
1520 <option>(max length)</option>
1523 Title of current MPD song
1524 <para></para></listitem>
1529 <command><option>mpd_vol</option></command>
1533 <para></para></listitem>
1538 <command><option>mpd_elapsed</option></command>
1542 <para></para></listitem>
1547 <command><option>mpd_length</option></command>
1551 <para></para></listitem>
1556 <command><option>mpd_percent</option></command>
1559 Percent of song's progress
1560 <para></para></listitem>
1565 <command><option>mpd_random</option></command>
1568 Random status (On/Off)
1569 <para></para></listitem>
1574 <command><option>mpd_repeat</option></command>
1577 Repeat status (On/Off)
1578 <para></para></listitem>
1583 <command><option>mpd_track</option></command>
1586 Prints the MPD track field
1587 <para></para></listitem>
1592 <command><option>mpd_name</option></command>
1595 Prints the MPD name field
1596 <para></para></listitem>
1601 <command><option>mpd_file</option></command>
1604 Prints the file name of the current MPD song
1605 <para></para></listitem>
1610 <command><option>mpd_smart</option></command>
1611 <option>(max length)</option>
1614 Prints the song name in either the form "artist - title" or file name, depending on whats available
1615 <para></para></listitem>
1620 <command><option>if_mpd_playing</option></command>
1623 if mpd is playing or paused, display everything between $if_mpd_playing and the matching $endif
1624 <para></para></listitem>
1629 <command><option>nameserver</option></command>
1630 <option>(index)</option>
1633 Print a nameserver from /etc/resolv.conf. Index starts at and defaults to 0.
1634 <para></para></listitem>
1639 <command><option>new_mails</option></command>
1640 <option>(mailbox)</option>
1641 <option>(interval)</option>
1644 Unread mail count in the specified mailbox or mail spool if
1645 not. Both mbox and maildir type mailboxes are supported.
1646 <para></para></listitem>
1651 <command><option>nodename</option></command>
1655 <para></para></listitem>
1660 <command><option>nvidia</option></command>
1661 <option>threshold</option>
1662 <option>temp</option>
1663 <option>ambient</option>
1664 <option>gpufreq</option>
1665 <option>memfreq</option>
1666 <option>imagequality</option>
1669 Nvidia graficcard support for the XNVCtrl library.
1670 Each option can be shortened to the least significant part.
1671 Temperatures are printed as float, all other values as integer.
1673 <member><command>threshold</command>:
1674 the thresholdtemperature at which the gpu slows down
1676 <member><command>temp</command>:
1677 gives the gpu current temperature
1679 <member><command>ambient</command>:
1680 gives current air temperature near GPU case
1682 <member><command>gpufreq</command>:
1683 gives the current gpu frequency
1685 <member><command>memfreq</command>:
1686 gives the current mem frequency
1688 <member><command>imagequality</command>:
1689 which imagequality should be choosen by OpenGL applications
1698 <command><option>outlinecolor</option></command>
1699 <option>(color)</option>
1702 Change outline color
1703 <para></para></listitem>
1708 <command><option>pb_battery</option></command>
1709 <option>item</option>
1712 If running on Apple powerbook/ibook, display
1713 information on battery status. The item parameter
1714 specifies, what information to display. Exactly one item
1715 must be specified. Valid items are:
1717 <member><command>status</command>:
1718 Display if battery is fully charged, charging,
1719 discharging or absent (running on AC)
1721 <member><command>percent</command>:
1722 Display charge of battery in percent, if
1723 charging or discharging. Nothing will be
1724 displayed, if battery is fully charged
1727 <member><command>time</command>:
1728 Display the time remaining until the battery
1729 will be fully charged or discharged at current
1730 rate. Nothing is displayed, if battery is
1731 absent or if it's present but fully charged
1732 and not discharging.
1735 <para></para></listitem>
1740 <command><option>platform</option></command>
1741 <option>(dev) type n</option>
1744 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.
1745 <para></para></listitem>
1750 <command><option>pop3_unseen</option></command>
1751 <option>(args)</option>
1754 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.
1756 <para></para></listitem>
1761 <command><option>pop3_used</option></command>
1762 <option>(args)</option>
1765 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.
1767 <para></para></listitem>
1772 <command><option>pre_exec</option></command>
1773 <option>shell command</option>
1776 Executes a shell command one time before conky displays anything and puts output as text.
1777 <para></para></listitem>
1782 <command><option>processes</option></command>
1785 Total processes (sleeping and running)
1786 <para></para></listitem>
1791 <command><option>running_processes</option></command>
1794 Running processes (not sleeping), requires Linux 2.6
1795 <para></para></listitem>
1800 <command><option>scroll</option></command>
1801 <option>length (step) text</option>
1804 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").
1805 <para></para></listitem>
1810 <command><option>shadecolor</option></command>
1811 <option>(color)</option>
1814 Change shading color
1815 <para></para></listitem>
1820 <command><option>smapi</option></command>
1821 <option>(ARGS)</option>
1824 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.
1825 <para></para></listitem>
1830 <command><option>smapi_bat_bar</option></command>
1831 <option>(INDEX),(height),(width)</option>
1834 when using smapi, display the remaining capacity of the battery with index INDEX as a bar.
1835 <para></para></listitem>
1840 <command><option>smapi_bat_perc</option></command>
1841 <option>(INDEX)</option>
1844 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.
1845 <para></para></listitem>
1850 <command><option>smapi_bat_power</option></command>
1851 <option>INDEX</option>
1854 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.
1855 <para></para></listitem>
1860 <command><option>smapi_bat_temp</option></command>
1861 <option>INDEX</option>
1864 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.
1865 <para></para></listitem>
1870 <command><option>stippled_hr</option></command>
1871 <option>(space)</option>
1874 Stippled (dashed) horizontal line
1875 <para></para></listitem>
1880 <command><option>swapbar</option></command>
1881 <option>(height),(width)</option>
1884 Bar that shows amount of swap in use
1885 <para></para></listitem>
1890 <command><option>swap</option></command>
1893 Amount of swap in use
1894 <para></para></listitem>
1899 <command><option>swapmax</option></command>
1902 Total amount of swap
1903 <para></para></listitem>
1908 <command><option>swapperc</option></command>
1911 Percentage of swap in use
1912 <para></para></listitem>
1917 <command><option>sysname</option></command>
1920 System name, Linux for example
1921 <para></para></listitem>
1926 <command><option>tcp_portmon</option></command>
1927 <option>port_begin port_end item (index)</option>
1928 <emphasis>(ip4 only at present)</emphasis>
1931 TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
1933 <member><command>count</command> - total number of connections in the range
1935 <member><command>rip</command> - remote ip address
1937 <member><command>rhost</command> - remote host name
1939 <member><command>rport</command> - remote port number
1941 <member><command>rservice</command> - remote service name from /etc/services
1943 <member><command>lip</command> - local ip address
1945 <member><command>lhost</command> - local host name
1947 <member><command>lport</command> - local port number
1949 <member><command>lservice</command> - local service name from /etc/services
1951 </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.
1953 <member>Examples:</member>
1954 <member><command>${tcp_portmon 6881 6999 count}</command> -
1955 displays the number of connections in the bittorrent port range</member>
1956 <member><command>${tcp_portmon 22 22 rip 0}</command> -
1957 displays the remote host ip of the first sshd connection</member>
1958 <member><command>${tcp_portmon 22 22 rip 9}</command> -
1959 displays the remote host ip of the tenth sshd connection</member>
1960 <member><command>${tcp_portmon 1 1024 rhost 0}</command> -
1961 displays the remote host name of the first connection on a privileged port</member>
1962 <member><command>${tcp_portmon 1 1024 rport 4}</command> -
1963 displays the remote host port of the fifth connection on a privileged port</member>
1964 <member><command>${tcp_portmon 1 65535 lservice 14}</command> -
1965 displays the local service name of the fifteenth connection in the range of all ports</member>
1966 </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.
1972 <command><option>texeci</option></command>
1973 <option>interval command</option>
1976 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.
1977 <para></para></listitem>
1982 <command><option>offset</option></command>
1983 <option>(pixels)</option>
1986 Move text over by N pixels. See also $voffset.
1987 <para></para></listitem>
1992 <command><option>rss</option></command>
1993 <option>url delay_in_minutes action item_num</option>
1996 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.
1997 <para></para></listitem>
2002 <command><option>tab</option></command>
2003 <option>(width, (start))</option>
2006 Puts a tab of the specified width, starting from column 'start'.
2007 <para></para></listitem>
2012 <command><option>tail</option></command>
2013 <option>logfile lines (interval)</option>
2016 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.
2017 <para></para></listitem>
2022 <command><option>templateN</option></command>
2023 <option>(arg1)</option>
2024 <option>(arg2)</option>
2025 <option>(arg3 ...)</option>
2028 Evaluate the content of the templateN configuration variable (where N is a value between 0 and 9, inclusively),
2029 applying substitutions as described in the documentation of the corresponding configuration variable.
2030 The number of arguments is optional, but must match the highest referred index in the template. You can use the
2031 same special sequences in each argument as the ones valid for a template definition, e.g. to allow an argument
2032 to contain a whitespace. Also simple nesting of templates is possible this way.
2033 <para></para></listitem>
2035 Here are some examples of template definitions:
2037 <member>template0 $\1\2</member>
2038 <member>template1 \1: ${fs_used \2} / ${fs_size \2}</member>
2039 <member>template2 \1 \2</member>
2041 The following list shows sample usage of the templates defined above,
2042 with the equivalent syntax when not using any template at all:
2046 <row rowsep="1"><entry>using template</entry><entry>same without template</entry></row>
2049 <row><entry>${template0 node name}</entry><entry>$nodename</entry></row>
2050 <row><entry>${template1 root /}</entry><entry>root: ${fs_free /} / ${fs_size /}</entry></row>
2052 <entry><programlisting>${template1 ${template2\ disk\ root} /}</programlisting></entry>
2053 <entry><programlisting>disk root: ${fs_free /} / ${fs_size /}</programlisting></entry>
2058 <para></para></listitem>
2063 <command><option>time</option></command>
2064 <option>(format)</option>
2067 Local time, see man strftime to get more information about format
2068 <para></para></listitem>
2073 <command><option>utime</option></command>
2074 <option>(format)</option>
2077 Display time in UTC (universal coordinate time).
2078 <para></para></listitem>
2083 <command><option>tztime</option></command>
2084 <option>(timezone) (format)</option>
2087 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.
2088 <para></para></listitem>
2093 <command><option>totaldown</option></command>
2094 <option>net</option>
2097 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.
2098 <para></para></listitem>
2103 <command><option>top</option></command>
2104 <option>type, num</option>
2107 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.
2108 <para></para></listitem>
2113 <command><option>top_mem</option></command>
2114 <option>type, num</option>
2117 Same as top, except sorted by mem usage instead of cpu
2118 <para></para></listitem>
2123 <command><option>top_time</option></command>
2124 <option>type, num</option>
2127 Same as top, except sorted by total CPU time instead of current CPU usage
2128 <para></para></listitem>
2133 <command><option>totalup</option></command>
2134 <option>net</option>
2137 Total upload, this one too, may overflow
2138 <para></para></listitem>
2143 <command><option>updates</option></command>
2144 <option>Number of updates</option>
2148 <para></para></listitem>
2153 <command><option>upspeed</option></command>
2154 <option>net</option>
2158 <para></para></listitem>
2163 <command><option>upspeedf</option></command>
2164 <option>net</option>
2167 Upload speed in KiB with one decimal
2168 <para></para></listitem>
2173 <command><option>upspeedgraph</option></command>
2174 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (net)</option>
2177 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".
2178 <para></para></listitem>
2183 <command><option>uptime</option></command>
2187 <para></para></listitem>
2192 <command><option>uptime_short</option></command>
2195 Uptime in a shorter format
2196 <para></para></listitem>
2201 <command><option>user_number</option></command>
2204 Number of users logged in
2205 <para></para></listitem>
2210 <command><option>user_names</option></command>
2213 Lists the names of the users logged in
2214 <para></para></listitem>
2219 <command><option>user_terms</option></command>
2222 Lists the consoles in use
2223 <para></para></listitem>
2228 <command><option>user_times</option></command>
2231 Lists how long users have been logged in for
2232 <para></para></listitem>
2237 <command><option>voffset</option></command>
2238 <option>(pixels)</option>
2241 Change vertical offset by N pixels. Negative values will cause text to overlap. See also $offset.
2242 <para></para></listitem>
2247 <command><option>voltage_mv</option></command>
2248 <option>(n)</option>
2251 Returns CPU #n's voltage in mV. CPUs are
2252 counted from 1. If omitted, the parameter
2254 <para></para></listitem>
2259 <command><option>voltage_v</option></command>
2260 <option>(n)</option>
2263 Returns CPU #n's voltage in V. CPUs are
2264 counted from 1. If omitted, the parameter
2266 <para></para></listitem>
2271 <command><option>wireless_essid</option></command>
2272 <option>net</option>
2275 Wireless access point ESSID (Linux only)
2276 <para></para></listitem>
2281 <command><option>wireless_mode</option></command>
2282 <option>net</option>
2285 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
2286 <para></para></listitem>
2291 <command><option>wireless_bitrate</option></command>
2292 <option>net</option>
2295 Wireless bitrate (ie 11 Mb/s) (Linux only)
2296 <para></para></listitem>
2301 <command><option>wireless_ap</option></command>
2302 <option>net</option>
2305 Wireless access point MAC address (Linux only)
2306 <para></para></listitem>
2311 <command><option>wireless_link_qual</option></command>
2312 <option>net</option>
2315 Wireless link quality (Linux only)
2316 <para></para></listitem>
2321 <command><option>wireless_link_qual_max</option></command>
2322 <option>net</option>
2325 Wireless link quality maximum value (Linux only)
2326 <para></para></listitem>
2331 <command><option>wireless_link_qual_perc</option></command>
2332 <option>net</option>
2335 Wireless link quality in percents (Linux only)
2336 <para></para></listitem>
2341 <command><option>wireless_link_bar</option></command>
2342 <option>(height), (width) net</option>
2345 Wireless link quality bar (Linux only)
2346 <para></para></listitem>
2351 <command><option>words</option></command>
2352 <option>textfile</option>
2355 Displays the number of words in the given file
2356 <para></para></listitem>
2361 <command><option>xmms2_artist</option></command>
2364 Artist in current XMMS2 song
2365 <para></para></listitem>
2370 <command><option>xmms2_album</option></command>
2373 Album in current XMMS2 song
2374 <para></para></listitem>
2379 <command><option>xmms2_title</option></command>
2382 Title in current XMMS2 song
2383 <para></para></listitem>
2388 <command><option>xmms2_genre</option></command>
2391 Genre in current XMMS2 song
2392 <para></para></listitem>
2397 <command><option>xmms2_comment</option></command>
2400 Comment in current XMMS2 song
2401 <para></para></listitem>
2406 <command><option>xmms2_decoder</option></command>
2410 <para></para></listitem>
2415 <command><option>xmms2_transport</option></command>
2418 Transport plugin used
2419 <para></para></listitem>
2424 <command><option>xmms2_url</option></command>
2427 Full path to current song
2428 <para></para></listitem>
2433 <command><option>xmms2_tracknr</option></command>
2436 Track number in current XMMS2 song
2437 <para></para></listitem>
2442 <command><option>xmms2_bitrate</option></command>
2445 Bitrate of current song
2446 <para></para></listitem>
2451 <command><option>xmms2_id</option></command>
2454 XMMS2 id of current song
2455 <para></para></listitem>
2460 <command><option>xmms2_duration</option></command>
2463 Duration of current song
2464 <para></para></listitem>
2469 <command><option>xmms2_elapsed</option></command>
2473 <para></para></listitem>
2478 <command><option>xmms2_size</option></command>
2481 Size of current song
2482 <para></para></listitem>
2487 <command><option>xmms2_percent</option></command>
2490 Percent of song's progress
2491 <para></para></listitem>
2496 <command><option>xmms2_status</option></command>
2499 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
2500 <para></para></listitem>
2505 <command><option>xmms2_bar</option></command>
2506 <option>(height),(width)</option>
2509 Bar of XMMS2's progress
2510 <para></para></listitem>
2515 <command><option>xmms2_smart</option></command>
2518 Prints the song name in either the form "artist - title" or file name, depending on whats available
2519 <para></para></listitem>
2523 <command><option>if_xmms2_connected</option></command>
2526 Display everything between $if_xmms2_connected and the matching $endif if xmms2 is running.
2527 <para></para></listitem>
2532 <command><option>eve</option></command>
2533 <option>api_userid api_key character_id</option>
2536 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.
2537 <para></para></listitem>
projects / monky / blob