5 <option>acpiacadapter</option>
8 <listitem>ACPI ac adapter state.
14 <option>acpifan</option>
17 <listitem>ACPI fan state
23 <option>acpitemp</option>
26 <listitem>ACPI temperature in C.
34 <option>(interface)</option>
36 <listitem>IP address for an interface, or "No Address" if
37 no address is assigned.
43 <option>addrs</option>
45 <option>(interface)</option>
47 <listitem>IP addresses for an interface (if one - works
48 like addr). Linux only.
54 <option>adt746xcpu</option>
57 <listitem>CPU temperature from therm_adt746x
63 <option>adt746xfan</option>
66 <listitem>Fan speed from therm_adt746x
72 <option>alignc</option>
74 <option>(num)</option>
76 <listitem>Align text to centre
82 <option>alignr</option>
84 <option>(num)</option>
86 <listitem>Right-justify text, with space of N
92 <option>apcupsd</option>
97 <listitem>Sets up the connection to apcupsd daemon. Prints
98 nothing, defaults to localhost:3551
104 <option>apcupsd_cable</option>
107 <listitem>Prints the UPS connection type.
113 <option>apcupsd_charge</option>
116 <listitem>Current battery capacity in percent.
122 <option>apcupsd_lastxfer</option>
125 <listitem>Reason for last transfer from line to battery.
131 <option>apcupsd_linev</option>
134 <listitem>Nominal input voltage.
140 <option>apcupsd_load</option>
143 <listitem>Current load in percent.
149 <option>apcupsd_loadbar</option>
152 <listitem>Bar showing current load.
158 <option>apcupsd_loadgauge</option>
160 <option>(height),(width)</option>
162 <listitem>Gauge that shows current load.
168 <option>apcupsd_loadgraph</option>
170 <option>(height),(width) (gradient colour 1) (gradient
171 colour 2) (scale) (-t) (-l)</option>
173 <listitem>History graph of current load.
179 <option>apcupsd_model</option>
182 <listitem>Prints the model of the UPS.
188 <option>apcupsd_name</option>
191 <listitem>Prints the UPS user-defined name.
197 <option>apcupsd_status</option>
200 <listitem>Prints current status (on-line, on-battery).
206 <option>apcupsd_temp</option>
209 <listitem>Current internal temperature.
215 <option>apcupsd_timeleft</option>
218 <listitem>Time left to run on battery.
224 <option>apcupsd_upsmode</option>
227 <listitem>Prints the UPS mode (e.g. standalone).
233 <option>apm_adapter</option>
236 <listitem>Display APM AC adapter status (FreeBSD only)
242 <option>apm_battery_life</option>
245 <listitem>Display APM battery life in percent (FreeBSD
252 <option>apm_battery_time</option>
255 <listitem>Display remaining APM battery life in hh:mm:ss or
256 "unknown" if AC adapterstatus is on-line or charging
263 <option>audacious_bar</option>
265 <option>(height),(width)</option>
267 <listitem>Progress bar
273 <option>audacious_bitrate</option>
276 <listitem>Bitrate of current tune
282 <option>audacious_channels</option>
285 <listitem>Number of audio channels of current tune
291 <option>audacious_filename</option>
294 <listitem>Full path and filename of current tune
300 <option>audacious_frequency</option>
303 <listitem>Sampling frequency of current tune
309 <option>audacious_length</option>
312 <listitem>Total length of current tune as MM:SS
318 <option>audacious_length_seconds</option>
321 <listitem>Total length of current tune in seconds
327 <option>audacious_main_volume</option>
330 <listitem>The current volume fetched from Audacious
336 <option>audacious_playlist_length</option>
339 <listitem>Number of tunes in playlist
345 <option>audacious_playlist_position</option>
348 <listitem>Playlist position of current tune
354 <option>audacious_position</option>
357 <listitem>Position of current tune (MM:SS)
363 <option>audacious_position_seconds</option>
366 <listitem>Position of current tune in seconds
372 <option>audacious_status</option>
375 <listitem>Player status (Playing/Paused/Stopped/Not
382 <option>audacious_title</option>
384 <option>(max length)</option>
386 <listitem>Title of current tune with optional maximum
393 <option>battery</option>
395 <option>(num)</option>
397 <listitem>Battery status and remaining percentage capacity
398 of ACPI or APM battery. ACPI battery number can be given as
399 argument (default is BAT0).
405 <option>battery_bar</option>
407 <option>(height),(width) (num)</option>
409 <listitem>Battery percentage remaining of ACPI battery in a
410 bar. ACPI battery number can be given as argument (default
417 <option>battery_percent</option>
419 <option>(num)</option>
421 <listitem>Battery percentage remaining for ACPI battery.
422 ACPI battery number can be given as argument (default is
429 <option>battery_short</option>
431 <option>(num)</option>
433 <listitem>Battery status and remaining percentage capacity
434 of ACPI or APM battery. ACPI battery number can be given as
435 argument (default is BAT0). This mode display a short
436 status, which means that C is displayed instead of
437 charging, D for discharging, F for full, N for not present,
438 E for empty and U for unknown.
444 <option>battery_time</option>
446 <option>(num)</option>
448 <listitem>Battery charge/discharge time remaining of ACPI
449 battery. ACPI battery number can be given as argument
456 <option>blink</option>
458 <option>text_and_other_conky_vars</option>
460 <listitem>Let 'text_and_other_conky_vars' blink on and off.
467 <option>bmpx_album</option>
470 <listitem>Album in current BMPx track
476 <option>bmpx_artist</option>
479 <listitem>Artist in current BMPx track
485 <option>bmpx_bitrate</option>
488 <listitem>Bitrate of the current BMPx track
494 <option>bmpx_title</option>
497 <listitem>Title of the current BMPx track
503 <option>bmpx_track</option>
506 <listitem>Track number of the current BMPx track
512 <option>bmpx_uri</option>
515 <listitem>URI of the current BMPx track
521 <option>buffers</option>
524 <listitem>Amount of memory buffered
530 <option>cached</option>
533 <listitem>Amount of memory cached
539 <option>color</option>
541 <option>(color)</option>
543 <listitem>Change drawing color to color
549 <option>colorN</option>
552 <listitem>Change drawing color to colorN configuration
553 option, where N is a digit between 0 and 9, inclusively.
559 <option>combine</option>
561 <option>var1 var2</option>
563 <listitem>Places the lines of var2 to the right of the
564 lines of var1 seperated by the chars that are put between
565 var1 and var2. For example: ${combine ${head /proc/cpuinfo
566 2} - ${head /proc/meminfo 1}} gives as output
567 "cpuinfo_line1 - meminfo_line1" on line 1 and
568 "cpuinfo_line2 -" on line 2. $combine vars can also be
569 nested to place more vars next to each other.
575 <option>conky_build_arch</option>
578 <listitem>CPU architecture Conky was built for
584 <option>conky_build_date</option>
587 <listitem>Date Conky was built
593 <option>conky_version</option>
596 <listitem>Conky version
604 <option>(cpuN)</option>
606 <listitem>CPU usage in percents. For SMP machines, the CPU
607 number can be provided as an argument. ${cpu cpu0} is the
608 total usage, and ${cpu cpuX} (X >= 1) are individual
615 <option>cpubar</option>
617 <option>(cpuN) (height),(width)</option>
619 <listitem>Bar that shows CPU usage, height is bar's height
620 in pixels. See $cpu for more info on SMP.
626 <option>cpugauge</option>
628 <option>(cpuN) (height),(width)</option>
630 <listitem>Elliptical gauge that shows CPU usage, height and
631 width are gauge's vertical and horizontal axis
632 respectively. See $cpu for more info on SMP.
638 <option>cpugraph</option>
640 <option>(cpuN) (height),(width) (gradient colour 1)
641 (gradient colour 2) (scale) (-t) (-l)</option>
643 <listitem>CPU usage graph, with optional colours in hex,
644 minus the #. See $cpu for more info on SMP. Uses a
645 logarithmic scale (to see small numbers) when you use the
646 -l switch. Takes the switch '-t' to use a temperature
647 gradient, which makes the gradient values change depending
648 on the amplitude of a particular graph value (try it and
655 <option>curl</option>
657 <option>url interval_in_minutes</option>
660 <para>Download data from URI using Curl at the
661 specified interval. The interval may be a floating
662 point value greater than 0, otherwise defaults to 15
663 minutes. Most useful when used in conjunction with Lua
664 and the Lua API. This object is threaded, and once a
665 thread is created it can't be explicitely destroyed.
666 One thread will run for each URI specified. You can use
667 any protocol that Curl supports.</para>
673 <option>desktop</option>
676 <listitem>Number of the desktop on which conky is running
677 or the message "Not running in X" if this is the case.
683 <option>desktop_name</option>
686 <listitem>Name of the desktop on which conky is running or
687 the message "Not running in X" if this is the case.
693 <option>desktop_number</option>
696 <listitem>Number of desktops or the message "Not running in
697 X" if this is the case.
703 <option>disk_protect</option>
705 <option>device</option>
707 <listitem>Disk protection status, if supported (needs
708 kernel-patch). Prints either "frozen" or "free " (note the
715 <option>diskio</option>
717 <option>(device)</option>
719 <listitem>Displays current disk IO. Device is optional, and
720 takes the form of sda for /dev/sda. Individual partitions
727 <option>diskio_read</option>
729 <option>(device)</option>
731 <listitem>Displays current disk IO for reads. Device as in
738 <option>diskio_write</option>
740 <option>(device)</option>
742 <listitem>Displays current disk IO for writes. Device as in
749 <option>diskiograph</option>
751 <option>(device) (height),(width) (gradient colour 1)
752 (gradient colour 2) (scale) (-t) (-l)</option>
754 <listitem>Disk IO graph, colours defined in hex, minus the
755 #. If scale is non-zero, it becomes the scale for the
756 graph. Uses a logarithmic scale (to see small numbers) when
757 you use -l switch. Takes the switch '-t' to use a
758 temperature gradient, which makes the gradient values
759 change depending on the amplitude of a particular graph
760 value (try it and see).
766 <option>diskiograph_read</option>
768 <option>(device) (height),(width) (gradient colour 1)
769 (gradient colour 2) (scale) (-t) (-l)</option>
771 <listitem>Disk IO graph for reads, colours defined in hex,
772 minus the #. If scale is non-zero, it becomes the scale for
773 the graph. Device as in diskio. Uses a logarithmic scale
774 (to see small numbers) when you use -l switch. Takes the
775 switch '-t' to use a temperature gradient, which makes the
776 gradient values change depending on the amplitude of a
777 particular graph value (try it and see).
783 <option>diskiograph_write</option>
785 <option>(device) (height),(width) (gradient colour 1)
786 (gradient colour 2) (scale) (-t) (-l)</option>
788 <listitem>Disk IO graph for writes, colours defined in hex,
789 minus the #. If scale is non-zero, it becomes the scale for
790 the graph. Device as in diskio. Uses a logarithmic scale
791 (to see small numbers) when you use -l switch. Takes the
792 switch '-t' to use a temperature gradient, which makes the
793 gradient values change depending on the amplitude of a
794 particular graph value (try it and see).
800 <option>downspeed</option>
802 <option>(net)</option>
804 <listitem>Download speed in suitable IEC units
810 <option>downspeedf</option>
812 <option>(net)</option>
814 <listitem>Download speed in KiB with one decimal
820 <option>downspeedgraph</option>
822 <option>(netdev) (height),(width) (gradient colour 1)
823 (gradient colour 2) (scale) (-t) (-l)</option>
825 <listitem>Download speed graph, colours defined in hex,
826 minus the #. If scale is non-zero, it becomes the scale for
827 the graph. Uses a logarithmic scale (to see small numbers)
828 when you use -l switch. Takes the switch '-t' to use a
829 temperature gradient, which makes the gradient values
830 change depending on the amplitude of a particular graph
831 value (try it and see).
837 <option>draft_mails</option>
839 <option>(maildir)</option>
840 <option>(interval)</option>
842 <listitem>Number of mails marked as draft in the specified
843 mailbox or mail spool if not. Only maildir type mailboxes
844 are supported, mbox type will return -1.
850 <option>else</option>
853 <listitem>Text to show if any of the above are not true
859 <option>endif</option>
863 <listitem>Ends an $if block.
869 <option>entropy_avail</option>
872 <listitem>Current entropy available for crypto freaks
878 <option>entropy_bar</option>
880 <option>(height),(width)</option>
882 <listitem>Normalized bar of available entropy for crypto
889 <option>entropy_perc</option>
892 <listitem>Percentage of entropy available in comparison to
899 <option>entropy_poolsize</option>
902 <listitem>Total size of system entropy pool for crypto
909 <option>eval</option>
911 <option>string</option>
913 <listitem>Evalutates given string according to the rules of
914 TEXT interpretation, i.e. parsing any contained text object
915 specifications into their output, any occuring '$$' into a
916 single '$' and so on. The output is then being parsed
925 <option>api_userid api_key character_id</option>
927 <listitem>Fetches your currently training skill from the
928 Eve Online API servers (http://www.eve-online.com/) and
929 displays the skill along with the remaining training time.
935 <option>exec</option>
937 <option>command</option>
939 <listitem>Executes a shell command and displays the output
940 in conky. warning: this takes a lot more resources than
941 other variables. I'd recommend coding wanted behaviour in C
948 <option>execbar</option>
950 <option>command</option>
952 <listitem>Same as exec, except if the first value return is
953 a value between 0-100, it will use that number for a bar.
954 The size for bars can be controlled via the
955 default_bar_size config setting.
961 <option>execgauge</option>
963 <option>command</option>
965 <listitem>Same as exec, except if the first value returned
966 is a value between 0-100, it will use that number for a
967 gauge. The size for gauges can be controlled via the
968 default_gauge_size config setting.
974 <option>execgraph</option>
976 <option>(-t) (-l) command</option>
978 <listitem>Same as execbar, but graphs values. Uses a
979 logaritmic scale when the log option (-l switch) is given
980 (to see small numbers). Values still have to be between 0
981 and 100. The size for graphs can be controlled via the
982 default_graph_size config setting. Takes the switch '-t' to
983 use a temperature gradient, which makes the gradient values
984 change depending on the amplitude of a particular graph
985 value (try it and see). If -t or -l is your first argument,
986 you may need to preceed it by a space (' ').
992 <option>execi</option>
994 <option>interval command</option>
996 <listitem>Same as exec but with specific interval. Interval
997 can't be less than update_interval in configuration. See
1004 <option>execibar</option>
1006 <option>interval command</option>
1008 <listitem>Same as execbar, except with an interval
1014 <option>execigauge</option>
1016 <option>interval command</option>
1018 <listitem>Same as execgauge, but takes an interval arg and
1025 <option>execigraph</option>
1027 <option>interval (-t) (-l) command</option>
1029 <listitem>Same as execgraph, but takes an interval arg and
1030 graphs values. If -t or -l is your first argument, you may
1031 need to preceed it by a space (' ').
1037 <option>execp</option>
1039 <option>command</option>
1041 <listitem>Executes a shell command and displays the output
1042 in conky. warning: this takes a lot more resources than
1043 other variables. I'd recommend coding wanted behaviour in C
1044 and posting a patch. This differs from $exec in that it
1045 parses the output of the command, so you can insert things
1046 like ${color red}hi!${color} in your script and have it
1047 correctly parsed by Conky. Caveats: Conky parses and
1048 evaluates the output of $execp every time Conky loops, and
1049 then destroys all the objects. If you try to use anything
1050 like $execi within an $execp statement, it will
1051 functionally run at the same interval that the $execp
1052 statement runs, as it is created and destroyed at every
1059 <option>execpi</option>
1061 <option>interval command</option>
1063 <listitem>Same as execp but with specific interval.
1064 Interval can't be less than update_interval in
1065 configuration. Note that the output from the $execpi
1066 command is still parsed and evaluated at every interval.
1072 <option>flagged_mails</option>
1074 <option>(maildir)</option>
1075 <option>(interval)</option>
1077 <listitem>Number of mails marked as flagged in the
1078 specified mailbox or mail spool if not. Only maildir type
1079 mailboxes are supported, mbox type will return -1.
1085 <option>font</option>
1087 <option>(font)</option>
1089 <listitem>Specify a different font. This new font will
1090 apply to the current line and everything following. You can
1091 use a $font with no arguments to change back to the default
1092 font (much like with $color)
1098 <option>forwarded_mails</option>
1100 <option>(maildir)</option>
1101 <option>(interval)</option>
1103 <listitem>Number of mails marked as forwarded in the
1104 specified mailbox or mail spool if not. Only maildir type
1105 mailboxes are supported, mbox type will return -1.
1111 <option>freq</option>
1113 <option>(n)</option>
1115 <listitem>Returns CPU #n's frequency in MHz. CPUs are
1116 counted from 1. If omitted, the parameter defaults to 1.
1122 <option>freq_g</option>
1124 <option>(n)</option>
1126 <listitem>Returns CPU #n's frequency in GHz. CPUs are
1127 counted from 1. If omitted, the parameter defaults to 1.
1133 <option>fs_bar</option>
1135 <option>(height),(width) fs</option>
1137 <listitem>Bar that shows how much space is used on a file
1138 system. height is the height in pixels. fs is any file on
1145 <option>fs_bar_free</option>
1147 <option>(height),(width) fs</option>
1149 <listitem>Bar that shows how much space is free on a file
1150 system. height is the height in pixels. fs is any file on
1157 <option>fs_free</option>
1159 <option>(fs)</option>
1161 <listitem>Free space on a file system available for users.
1167 <option>fs_free_perc</option>
1169 <option>(fs)</option>
1171 <listitem>Free percentage of space on a file system
1172 available for users.
1178 <option>fs_size</option>
1180 <option>(fs)</option>
1182 <listitem>File system size.
1188 <option>fs_type</option>
1190 <option>(fs)</option>
1192 <listitem>File system type.
1198 <option>fs_used</option>
1200 <option>(fs)</option>
1202 <listitem>File system used space.
1208 <option>fs_used_perc</option>
1210 <option>(fs)</option>
1212 <listitem>Percent of file system used space.
1218 <option>goto</option>
1222 <listitem>The next element will be printed at position 'x'.
1229 <option>gw_iface</option>
1232 <listitem>Displays the default route's interface or
1233 "multiple"/"none" accordingly.
1239 <option>gw_ip</option>
1242 <listitem>Displays the default gateway's IP or
1243 "multiple"/"none" accordingly.
1249 <option>hddtemp</option>
1251 <option>dev, (host,(port))</option>
1253 <listitem>Displays temperature of a selected hard disk
1254 drive as reported by the hddtemp daemon running on
1255 host:port. Default host is 127.0.0.1, default port is 7634.
1262 <option>head</option>
1264 <option>logfile lines (next_check)</option>
1266 <listitem>Displays first N lines of supplied text file. The
1267 file is checked every 'next_check' update. If next_check is
1268 not supplied, Conky defaults to 2. Max of 30 lines can be
1269 displayed, or until the text buffer is filled.
1277 <option>(height)</option>
1279 <listitem>Horizontal line, height is the height in pixels
1285 <option>hwmon</option>
1287 <option>(dev) type n (factor offset)</option>
1289 <listitem>Hwmon sensor from sysfs (Linux 2.6). Parameter
1290 dev may be omitted if you have only one hwmon device.
1291 Parameter type is either 'in' or 'vol' meaning voltage;
1292 'fan' meaning fan; 'temp' meaning temperature. Parameter n
1293 is number of the sensor. See /sys/class/hwmon/ on your
1294 local computer. The optional arguments 'factor' and
1295 'offset' allow precalculation of the raw input, which is
1296 being modified as follows: 'input = input * factor +
1297 offset'. Note that they have to be given as decimal values
1298 (i.e. contain at least one decimal place).
1304 <option>i2c</option>
1306 <option>(dev) type n (factor offset)</option>
1308 <listitem>I2C sensor from sysfs (Linux 2.6). Parameter dev
1309 may be omitted if you have only one I2C device. Parameter
1310 type is either 'in' or 'vol' meaning voltage; 'fan' meaning
1311 fan; 'temp' meaning temperature. Parameter n is number of
1312 the sensor. See /sys/bus/i2c/devices/ on your local
1313 computer. The optional arguments 'factor' and 'offset'
1314 allow precalculation of the raw input, which is being
1315 modified as follows: 'input = input * factor + offset'.
1316 Note that they have to be given as decimal values (i.e.
1317 contain at least one decimal place).
1323 <option>i8k_ac_status</option>
1327 <listitem>If running the i8k kernel driver for Inspiron
1328 laptops, displays whether ac power is on, as listed in
1329 /proc/i8k (translated to human-readable). Beware that this
1330 is by default not enabled by i8k itself.
1336 <option>i8k_bios</option>
1340 <listitem>If running the i8k kernel driver for Inspiron
1341 laptops, displays the bios version as listed in /proc/i8k.
1347 <option>i8k_buttons_status</option>
1351 <listitem>If running the i8k kernel driver for Inspiron
1352 laptops, displays the volume buttons status as listed in
1359 <option>i8k_cpu_temp</option>
1363 <listitem>If running the i8k kernel driver for Inspiron
1364 laptops, displays the cpu temperature in Celsius, as
1365 reported by /proc/i8k.
1371 <option>i8k_left_fan_rpm</option>
1375 <listitem>If running the i8k kernel driver for Inspiron
1376 laptops, displays the left fan's rate of rotation, in
1377 revolutions per minute as listed in /proc/i8k. Beware, some
1378 laptops i8k reports these fans in reverse order.
1384 <option>i8k_left_fan_status</option>
1388 <listitem>If running the i8k kernel driver for Inspiron
1389 laptops, displays the left fan status as listed in
1390 /proc/i8k (translated to human-readable). Beware, some
1391 laptops i8k reports these fans in reverse order.
1397 <option>i8k_right_fan_rpm</option>
1401 <listitem>If running the i8k kernel driver for Inspiron
1402 laptops, displays the right fan's rate of rotation, in
1403 revolutions per minute as listed in /proc/i8k. Beware, some
1404 laptops i8k reports these fans in reverse order.
1410 <option>i8k_right_fan_status</option>
1414 <listitem>If running the i8k kernel driver for Inspiron
1415 laptops, displays the right fan status as listed in
1416 /proc/i8k (translated to human-readable). Beware, some
1417 laptops i8k reports these fans in reverse order.
1423 <option>i8k_serial</option>
1427 <listitem>If running the i8k kernel driver for Inspiron
1428 laptops, displays your laptop serial number as listed in
1435 <option>i8k_version</option>
1439 <listitem>If running the i8k kernel driver for Inspiron
1440 laptops, displays the version formatting of /proc/i8k.
1446 <option>ibm_brightness</option>
1449 <listitem>If running the IBM ACPI, displays the brigtness
1450 of the laptops's LCD (0-7).
1456 <option>ibm_fan</option>
1459 <listitem>If running the IBM ACPI, displays the fan speed.
1465 <option>ibm_temps</option>
1469 <listitem>If running the IBM ACPI, displays the
1470 temperatures from the IBM temperature sensors (N=0..7)
1471 Sensor 0 is on the CPU, 3 is on the GPU.
1477 <option>ibm_volume</option>
1480 <listitem>If running the IBM ACPI, displays the "master"
1481 volume, controlled by the volume keys (0-14).
1487 <option>iconv_start</option>
1489 <option>codeset_from codeset_to</option>
1491 <listitem>Convert text from one codeset to another using
1492 GNU iconv. Needs to be stopped with iconv_stop.
1498 <option>iconv_stop</option>
1502 <listitem>Stop iconv codeset conversion.
1508 <option>if_empty</option>
1510 <option>(var)</option>
1512 <listitem>if conky variable VAR is empty, display
1513 everything between $if_empty and the matching $endif
1519 <option>if_existing</option>
1521 <option>file (string)</option>
1523 <listitem>if FILE exists, display everything between
1524 if_existing and the matching $endif. The optional second
1525 paramater checks for FILE containing the specified string
1526 and prints everything between $if_existing and the matching
1533 <option>if_gw</option>
1536 <listitem>if there is at least one default gateway, display
1537 everything between $if_gw and the matching $endif
1543 <option>if_match</option>
1545 <option>expression</option>
1547 <listitem>Evaluates the given boolean expression, printing
1548 everything between $if_match and the matching $endif
1549 depending on whether the evaluation returns true or not.
1550 Valid expressions consist of a left side, an operator and a
1551 right side. Left and right sides are being parsed for
1552 contained text objects before evaluation. Recognised left
1553 and right side types are:
1556 <command>double</command>Argument consists of only
1557 digits and a single dot.</member>
1559 <command>long</command>Argument consists of only
1562 <command>string</command>Argument is enclosed in
1563 quotation mark or the checks for double and long failed
1565 </simplelist>Valid operands are: '>', '<', '>=',
1566 '<=', '==', '!='.
1572 <option>if_mixer_mute</option>
1574 <option>(mixer)</option>
1576 <listitem>If mixer exists, display everything between
1577 $if_mixer_mute and the matching $endif. If no mixer is
1578 specified, "Master" is used.
1584 <option>if_mounted</option>
1586 <option>(mountpoint)</option>
1588 <listitem>if MOUNTPOINT is mounted, display everything
1589 between $if_mounted and the matching $endif
1595 <option>if_mpd_playing</option>
1598 <listitem>if mpd is playing or paused, display everything
1599 between $if_mpd_playing and the matching $endif
1605 <option>if_running</option>
1607 <option>(process)</option>
1609 <listitem>if PROCESS is running, display everything
1610 $if_running and the matching $endif. This uses the
1611 ``pidof'' command, so the -x switch is also supported.
1617 <option>if_smapi_bat_installed</option>
1619 <option>(INDEX)</option>
1621 <listitem>when using smapi, if the battery with index INDEX
1622 is installed, display everything between
1623 $if_smapi_bat_installed and the matching $endif
1629 <option>if_up</option>
1631 <option>(interface)</option>
1633 <listitem>if INTERFACE exists and is up, display everything
1634 between $if_up and the matching $endif
1640 <option>if_updatenr</option>
1642 <option>(updatenr)</option>
1644 <listitem>If it's the UPDATENR-th time that conky updates,
1645 display everything between $if_updatenr and the matching
1646 $endif. The counter resets when the highest UPDATENR is
1647 reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr
1648 2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the
1649 time followed by bar 25% of the time followed by nothing
1650 the other half of the time.
1656 <option>if_xmms2_connected</option>
1659 <listitem>Display everything between $if_xmms2_connected
1660 and the matching $endif if xmms2 is running.
1666 <option>image</option>
1668 <option><path to image> (-p x,y) (-s WxH) (-n)
1669 (-f interval)</option>
1671 <listitem>Renders an image from the path specified using
1672 Imlib2. Takes 4 optional arguments: a position, a size, a
1673 no-cache switch, and a cache flush interval. Changing the
1674 x,y position will move the position of the image, and
1675 changing the WxH will scale the image. If you specify the
1676 no-cache flag (-n), the image will not be cached.
1677 Alternately, you can specify the -f int switch to specify a
1678 cache flust interval for a particular image. Example:
1679 ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200}
1680 will render 'cheeseburger.jpg' at (20,20) scaled to 200x200
1681 pixels. Conky does not make any attempt to adjust the
1682 position (or any other formatting) of images, they are just
1683 rendered as per the arguments passed. The only reason
1684 $image is part of the TEXT section, is to allow for runtime
1685 modifications, through $execp $lua_parse, or some other
1692 <option>imap_messages</option>
1694 <option>(args)</option>
1696 <listitem>Displays the number of messages in your global
1697 IMAP inbox by default. You can define individual IMAP
1698 inboxes seperately by passing arguments to this object.
1699 Arguments are: "host user pass [-i interval (in seconds)]
1700 [-f folder] [-p port] [-e command] [-r retries]". Default
1701 port is 143, default folder is 'INBOX', default interval is
1702 5 minutes, and default number of retries before giving up
1703 is 5. If the password is supplied as '*', you will be
1704 prompted to enter the password when Conky starts.
1710 <option>imap_unseen</option>
1712 <option>(args)</option>
1714 <listitem>Displays the number of unseen messages in your
1715 global IMAP inbox by default. You can define individual
1716 IMAP inboxes seperately by passing arguments to this
1717 object. Arguments are: "host user pass [-i interval (in
1718 seconds)] [-f folder] [-p port] [-e command] [-r retries]".
1719 Default port is 143, default folder is 'INBOX', default
1720 interval is 5 minutes, and default number of retries before
1721 giving up is 5. If the password is supplied as '*', you
1722 will be prompted to enter the password when Conky starts.
1728 <option>ioscheduler</option>
1730 <option>disk</option>
1732 <listitem>Prints the current ioscheduler used for the given
1733 disk name (i.e. e.g. "hda" or "sdb")
1739 <option>kernel</option>
1742 <listitem>Kernel version
1748 <option>laptop_mode</option>
1751 <listitem>The value of /proc/sys/vm/laptop_mode
1757 <option>lines</option>
1759 <option>textfile</option>
1761 <listitem>Displays the number of lines in the given file
1767 <option>loadavg</option>
1769 <option>(1|2|3)</option>
1771 <listitem>System load average, 1 is for past 1 minute, 2
1772 for past 5 minutes and 3 for past 15 minutes.
1778 <option>loadgraph</option>
1780 <option>(1|2|3) (height),(width) (gradient colour 1)
1781 (gradient colour 2) (scale) (-t) (-l)</option>
1783 <listitem>Load1 average graph, similar to xload, with
1784 optional colours in hex, minus the #. Uses a logarithmic
1785 scale (to see small numbers) when you use the -l switch.
1786 Takes the switch '-t' to use a temperature gradient, which
1787 makes the gradient values change depending on the amplitude
1788 of a particular graph value (try it and see).
1794 <option>lua</option>
1796 <option>function_name (function parameters)</option>
1798 <listitem>Executes a Lua function with given parameters,
1799 then prints the returned string. See also 'lua_load' on how
1800 to load scripts. Conky puts 'conky_' in front of
1801 function_name to prevent accidental calls to the wrong
1802 function unless you put you place 'conky_' in front of it
1809 <option>lua_bar</option>
1811 <option>(height, width) function_name (function
1812 parameters)</option>
1814 <listitem>Executes a Lua function with given parameters and
1815 draws a bar. Expects result value to be an integer between
1816 0 and 100. See also 'lua_load' on how to load scripts.
1817 Conky puts 'conky_' in front of function_name to prevent
1818 accidental calls to the wrong function unless you put you
1819 place 'conky_' in front of it yourself.
1825 <option>lua_gauge</option>
1827 <option>(height, width) function_name (function
1828 parameters)</option>
1830 <listitem>Executes a Lua function with given parameters and
1831 draws a gauge. Expects result value to be an integer
1832 between 0 and 100. See also 'lua_load' on how to load
1833 scripts. Conky puts 'conky_' in front of function_name to
1834 prevent accidental calls to the wrong function unless you
1835 put you place 'conky_' in front of it yourself.
1841 <option>lua_graph</option>
1843 <option>function_name (height),(width) (gradient colour
1844 1) (gradient colour 2) (scale) (-t) (-l)</option>
1846 <listitem>Executes a Lua function with and draws a graph.
1847 Expects result value to be any number, and by default will
1848 scale to show the full range. See also 'lua_load' on how to
1849 load scripts. Takes the switch '-t' to use a temperature
1850 gradient, which makes the gradient values change depending
1851 on the amplitude of a particular graph value (try it and
1852 see). Conky puts 'conky_' in front of function_name to
1853 prevent accidental calls to the wrong function unless you
1854 put you place 'conky_' in front of it yourself.
1860 <option>lua_parse</option>
1862 <option>function_name (function parameters)</option>
1864 <listitem>Executes a Lua function with given parameters as
1865 per $lua, then parses and prints the result value as per
1866 the syntax for Conky's TEXT section. See also 'lua_load' on
1867 how to load scripts. Conky puts 'conky_' in front of
1868 function_name to prevent accidental calls to the wrong
1869 function unless you put you place 'conky_' in front of it
1876 <option>machine</option>
1879 <listitem>Machine, i686 for example
1885 <option>mails</option>
1887 <option>(mailbox)</option>
1888 <option>(interval)</option>
1890 <listitem>Mail count in the specified mailbox or your mail
1891 spool if not. Both mbox and maildir type mailboxes are
1892 supported. You can use a program like fetchmail to get
1893 mails from some server using your favourite protocol. See
1900 <option>mboxscan</option>
1902 <option>(-n number of messages to print) (-fw from
1903 width) (-sw subject width) mbox</option>
1905 <listitem>Print a summary of recent messages in an mbox
1906 format mailbox. mbox parameter is the filename of the
1907 mailbox (can be encapsulated using '"', ie. ${mboxscan -n
1908 10 "/home/brenden/some box"}
1914 <option>mem</option>
1917 <listitem>Amount of memory in use
1923 <option>membar</option>
1925 <option>(height),(width)</option>
1927 <listitem>Bar that shows amount of memory in use
1933 <option>memeasyfree</option>
1936 <listitem>Amount of free memory including the memory that
1937 is very easily freed (buffers/cache)
1943 <option>memfree</option>
1946 <listitem>Amount of free memory
1952 <option>memgauge</option>
1954 <option>(height),(width)</option>
1956 <listitem>Gauge that shows amount of memory in use (see
1963 <option>memgraph</option>
1965 <option>(height),(width) (gradient colour 1) (gradient
1966 colour 2) (scale) (-t) (-l)</option>
1968 <listitem>Memory usage graph. Uses a logarithmic scale (to
1969 see small numbers) when you use the -l switch. Takes the
1970 switch '-t' to use a temperature gradient, which makes the
1971 gradient values change depending on the amplitude of a
1972 particular graph value (try it and see).
1978 <option>memmax</option>
1981 <listitem>Total amount of memory
1987 <option>memperc</option>
1990 <listitem>Percentage of memory in use
1996 <option>mixer</option>
1998 <option>(device)</option>
2000 <listitem>Prints the mixer value as reported by the OS.
2001 Default mixer is "vol", but you can specify one of the
2002 following optional arguments: "vol", "bass", "treble",
2003 "synth", "pcm", "speaker", "line", "mic", "cd", "mix",
2004 "pcm2", "rec", "igain", "ogain", "line1", "line2", "line3",
2005 "dig1", "dig2", "dig3", "phin", "phout", "video", "radio",
2006 "monitor". Refer to the definition of SOUND_DEVICE_NAMES in
2007 <linux/soundcard.h> (on Linux), <soundcard.h>
2008 (on OpenBSD), or <sys/soundcard.h> to find the exact
2009 options available on your system.
2015 <option>mixerbar</option>
2017 <option>(device)</option>
2019 <listitem>Displays mixer value in a bar as reported by the
2020 OS. See docs for $mixer for details on arguments.
2026 <option>mixerl</option>
2028 <option>(device)</option>
2030 <listitem>Prints the left channel mixer value as reported
2031 by the OS. See docs for $mixer for details on arguments.
2037 <option>mixerlbar</option>
2039 <option>(device)</option>
2041 <listitem>Displays the left channel mixer value in a bar as
2042 reported by the OS. See docs for $mixer for details on
2049 <option>mixerr</option>
2051 <option>(device)</option>
2053 <listitem>Prints the right channel mixer value as reported
2054 by the OS. See docs for $mixer for details on arguments.
2060 <option>mixerrbar</option>
2062 <option>(device)</option>
2064 <listitem>Displays the right channel mixer value in a bar
2065 as reported by the OS. See docs for $mixer for details on
2072 <option>moc_album</option>
2075 <listitem>Album of the current MOC song
2081 <option>moc_artist</option>
2084 <listitem>Artist of the current MOC song
2090 <option>moc_bitrate</option>
2093 <listitem>Bitrate in the current MOC song
2099 <option>moc_curtime</option>
2102 <listitem>Current time of the current MOC song
2108 <option>moc_file</option>
2111 <listitem>File name of the current MOC song
2117 <option>moc_rate</option>
2120 <listitem>Rate of the current MOC song
2126 <option>moc_song</option>
2129 <listitem>The current song name being played in MOC.
2135 <option>moc_state</option>
2138 <listitem>Current state of MOC; playing, stopped etc.
2144 <option>moc_timeleft</option>
2147 <listitem>Time left in the current MOC song
2153 <option>moc_title</option>
2156 <listitem>Title of the current MOC song
2162 <option>moc_totaltime</option>
2165 <listitem>Total length of the current MOC song
2171 <option>monitor</option>
2174 <listitem>Number of the monitor on which conky is running
2175 or the message "Not running in X" if this is the case.
2181 <option>monitor_number</option>
2184 <listitem>Number of monitors or the message "Not running in
2185 X" if this is the case.
2191 <option>mpd_album</option>
2194 <listitem>Album in current MPD song
2200 <option>mpd_artist</option>
2203 <listitem>Artist in current MPD song must be enabled at
2210 <option>mpd_bar</option>
2212 <option>(height),(width)</option>
2214 <listitem>Bar of mpd's progress
2220 <option>mpd_bitrate</option>
2223 <listitem>Bitrate of current song
2229 <option>mpd_elapsed</option>
2232 <listitem>Song's elapsed time
2238 <option>mpd_file</option>
2241 <listitem>Prints the file name of the current MPD song
2247 <option>mpd_length</option>
2250 <listitem>Song's length
2256 <option>mpd_name</option>
2259 <listitem>Prints the MPD name field
2265 <option>mpd_percent</option>
2268 <listitem>Percent of song's progress
2274 <option>mpd_random</option>
2277 <listitem>Random status (On/Off)
2283 <option>mpd_repeat</option>
2286 <listitem>Repeat status (On/Off)
2292 <option>mpd_smart</option>
2294 <option>(max length)</option>
2296 <listitem>Prints the song name in either the form "artist -
2297 title" or file name, depending on whats available
2303 <option>mpd_status</option>
2306 <listitem>Playing, stopped, et cetera.
2312 <option>mpd_title</option>
2314 <option>(max length)</option>
2316 <listitem>Title of current MPD song
2322 <option>mpd_track</option>
2325 <listitem>Prints the MPD track field
2331 <option>mpd_vol</option>
2334 <listitem>MPD's volume
2340 <option>nameserver</option>
2342 <option>(index)</option>
2344 <listitem>Print a nameserver from /etc/resolv.conf. Index
2345 starts at and defaults to 0.
2351 <option>new_mails</option>
2353 <option>(mailbox)</option>
2354 <option>(interval)</option>
2356 <listitem>Unread mail count in the specified mailbox or
2357 mail spool if not. Both mbox and maildir type mailboxes are
2364 <option>nodename</option>
2373 <option>nvidia</option>
2375 <option>threshold</option>
2376 <option>temp</option>
2377 <option>ambient</option>
2378 <option>gpufreq</option>
2379 <option>memfreq</option>
2380 <option>imagequality</option>
2382 <listitem>Nvidia graficcard support for the XNVCtrl
2383 library. Each option can be shortened to the least
2384 significant part. Temperatures are printed as float, all
2385 other values as integer.
2388 <command>threshold</command>The thresholdtemperature at
2389 which the gpu slows down</member>
2391 <command>temp</command>Tives the gpu current
2392 temperature</member>
2394 <command>ambient</command>
2395 <option>Gives current air temperature near GPU
2399 <command>gpufreq</command>
2400 <option>Gives the current gpu frequency</option>
2403 <command>memfreq</command>
2404 <option>Gives the current mem frequency</option>
2407 <command>imagequality</command>
2408 <option>Which imagequality should be choosen by
2409 OpenGL applications</option>
2417 <option>offset</option>
2419 <option>(pixels)</option>
2421 <listitem>Move text over by N pixels. See also $voffset.
2427 <option>outlinecolor</option>
2429 <option>(color)</option>
2431 <listitem>Change outline color
2437 <option>pb_battery</option>
2439 <option>item</option>
2441 <listitem>If running on Apple powerbook/ibook, display
2442 information on battery status. The item parameter
2443 specifies, what information to display. Exactly one item
2444 must be specified. Valid items are:
2447 <command>status</command>
2448 <option>Display if battery is fully charged,
2449 charging, discharging or absent (running on
2453 <command>percent</command>
2454 <option>Display charge of battery in percent, if
2455 charging or discharging. Nothing will be displayed,
2456 if battery is fully charged or absent.</option>
2459 <command>time</command>
2460 <option>Display the time remaining until the
2461 battery will be fully charged or discharged at
2462 current rate. Nothing is displayed, if battery is
2463 absent or if it's present but fully charged and not
2464 discharging.</option>
2472 <option>platform</option>
2474 <option>(dev) type n (factor offset)</option>
2476 <listitem>Platform sensor from sysfs (Linux 2.6). Parameter
2477 dev may be omitted if you have only one platform device.
2478 Platform type is either 'in' or 'vol' meaning voltage;
2479 'fan' meaning fan; 'temp' meaning temperature. Parameter n
2480 is number of the sensor. See /sys/bus/platform/devices/ on
2481 your local computer. The optional arguments 'factor' and
2482 'offset' allow precalculation of the raw input, which is
2483 being modified as follows: 'input = input * factor +
2484 offset'. Note that they have to be given as decimal values
2485 (i.e. contain at least one decimal place).
2491 <option>pop3_unseen</option>
2493 <option>(args)</option>
2495 <listitem>Displays the number of unseen messages in your
2496 global POP3 inbox by default. You can define individual
2497 POP3 inboxes seperately by passing arguments to this
2498 object. Arguments are: "host user pass [-i interval (in
2499 seconds)] [-p port] [-e command] [-r retries]". Default
2500 port is 110, default interval is 5 minutes, and default
2501 number of retries before giving up is 5. If the password is
2502 supplied as '*', you will be prompted to enter the password
2509 <option>pop3_used</option>
2511 <option>(args)</option>
2513 <listitem>Displays the amount of space (in MiB, 2^20) used
2514 in your global POP3 inbox by default. You can define
2515 individual POP3 inboxes seperately by passing arguments to
2516 this object. Arguments are: "host user pass [-i interval
2517 (in seconds)] [-p port] [-e command] [-r retries]". Default
2518 port is 110, default interval is 5 minutes, and default
2519 number of retries before giving up is 5. If the password is
2520 supplied as '*', you will be prompted to enter the password
2527 <option>pre_exec</option>
2529 <option>shell command</option>
2531 <listitem>Executes a shell command one time before conky
2532 displays anything and puts output as text.
2538 <option>processes</option>
2541 <listitem>Total processes (sleeping and running)
2547 <option>read_tcp</option>
2549 <option>(host) port</option>
2551 <listitem>Connects to a tcp port on a host (default is
2552 localhost), reads every char available at the moment and
2559 <option>replied_mails</option>
2561 <option>(maildir)</option>
2562 <option>(interval)</option>
2564 <listitem>Number of mails marked as replied in the
2565 specified mailbox or mail spool if not. Only maildir type
2566 mailboxes are supported, mbox type will return -1.
2572 <option>rss</option>
2574 <option>uri interval_in_minutes action (num_par
2575 (spaces_in_front))</option>
2578 <para>Download and parse RSS feeds. The interval may be
2579 a floating point value greater than 0, otherwise
2580 defaults to 15 minutes. Action may be one of the
2581 following: feed_title, item_title (with num par),
2582 item_desc (with num par) and item_titles (when using
2583 this action and spaces_in_front is given conky places
2584 that many spaces in front of each item). This object is
2585 threaded, and once a thread is created it can't be
2586 explicitely destroyed. One thread will run for each URI
2587 specified. You can use any protocol that Curl
2594 <option>running_processes</option>
2597 <listitem>Running processes (not sleeping), requires Linux
2604 <option>scroll</option>
2606 <option>length (step) text</option>
2608 <listitem>Scroll 'text' by 'step' characters showing
2609 'length' number of characters at the same time. The text
2610 may also contain variables. 'step' is optional and defaults
2611 to 1 if not set. If a var creates output on multiple lines
2612 then the lines are placed behind each other separated with
2613 a '|'-sign. If you change the textcolor inside $scroll it
2614 will automatically have it's old value back at the end of
2615 $scroll. The end and the start of text will be seperated by
2616 'length' number of spaces.
2622 <option>seen_mails</option>
2624 <option>(maildir)</option>
2625 <option>(interval)</option>
2627 <listitem>Number of mails marked as seen in the specified
2628 mailbox or mail spool if not. Only maildir type mailboxes
2629 are supported, mbox type will return -1.
2635 <option>shadecolor</option>
2637 <option>(color)</option>
2639 <listitem>Change shading color
2645 <option>smapi</option>
2647 <option>(ARGS)</option>
2649 <listitem>when using smapi, display contents of the
2650 /sys/devices/platform/smapi directory. ARGS are either
2651 '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the
2652 corresponding files' content. This is a very raw method of
2653 accessing the smapi values. When available, better use one
2654 of the smapi_* variables instead.
2660 <option>smapi_bat_bar</option>
2662 <option>(INDEX),(height),(width)</option>
2664 <listitem>when using smapi, display the remaining capacity
2665 of the battery with index INDEX as a bar.
2671 <option>smapi_bat_perc</option>
2673 <option>(INDEX)</option>
2675 <listitem>when using smapi, display the remaining capacity
2676 in percent of the battery with index INDEX. This is a
2677 separate variable because it supports the 'use_spacer'
2678 configuration option.
2684 <option>smapi_bat_power</option>
2686 <option>INDEX</option>
2688 <listitem>when using smapi, display the current power of
2689 the battery with index INDEX in watt. This is a separate
2690 variable because the original read out value is being
2691 converted from mW. The sign of the output reflects charging
2692 (positive) or discharging (negative) state.
2698 <option>smapi_bat_temp</option>
2700 <option>INDEX</option>
2702 <listitem>when using smapi, display the current temperature
2703 of the battery with index INDEX in degree Celsius. This is
2704 a separate variable because the original read out value is
2705 being converted from milli degree Celsius.
2711 <option>sony_fanspeed</option>
2714 <listitem>Displays the Sony VAIO fanspeed information if
2715 sony-laptop kernel support is enabled. Linux only.
2721 <option>stippled_hr</option>
2723 <option>(space)</option>
2725 <listitem>Stippled (dashed) horizontal line
2731 <option>swap</option>
2734 <listitem>Amount of swap in use
2740 <option>swapbar</option>
2742 <option>(height),(width)</option>
2744 <listitem>Bar that shows amount of swap in use
2750 <option>swapfree</option>
2753 <listitem>Amount of free swap
2759 <option>swapmax</option>
2762 <listitem>Total amount of swap
2768 <option>swapperc</option>
2771 <listitem>Percentage of swap in use
2777 <option>sysname</option>
2780 <listitem>System name, Linux for example
2786 <option>tab</option>
2788 <option>(width, (start))</option>
2790 <listitem>Puts a tab of the specified width, starting from
2791 column 'start'. The unit is pixels for both arguments.
2797 <option>tail</option>
2799 <option>logfile lines (next_check)</option>
2801 <listitem>Displays last N lines of supplied text file. The
2802 file is checked every 'next_check' update. If next_check is
2803 not supplied, Conky defaults to 2. Max of 30 lines can be
2804 displayed, or until the text buffer is filled.
2810 <option>tcp_portmon</option>
2812 <option>port_begin port_end item (index)</option>
2813 <emphasis>(ip4 only at present)</emphasis>
2816 <para>TCP port monitor for specified local ports. Port
2817 numbers must be in the range 1 to 65535. Valid items
2821 <command>count</command>
2822 <option>Total number of connections in the
2826 <command>rip</command>
2827 <option>Remote ip address</option>
2830 <command>rhost</command>
2831 <option>Remote host name</option>
2834 <command>rport</command>
2835 <option>Remote port number</option>
2838 <command>rservice</command>
2839 <option>Remote service name from
2840 /etc/services</option>
2843 <command>lip</command>
2844 <option>Local ip address</option>
2847 <command>lhost</command>
2848 <option>Local host name</option>
2851 <command>lport</command>
2852 <option>Local port number</option>
2855 <command>lservice</command>
2856 <option>Local service name from
2857 /etc/services</option>
2860 <para>The connection index provides you with access to
2861 each connection in the port monitor. The monitor will
2862 return information for index values from 0 to n-1
2863 connections. Values higher than n-1 are simply ignored.
2864 For the "count" item, the connection index must be
2865 omitted. It is required for all other items.</para>
2866 <para>Examples:</para>
2869 <command>${tcp_portmon 6881 6999
2871 <option>Displays the number of connections in
2872 the bittorrent port range</option>
2875 <command>${tcp_portmon 22 22 rip 0}</command>
2876 <option>Displays the remote host ip of the
2877 first sshd connection</option>
2880 <command>${tcp_portmon 22 22 rip 9}</command>
2881 <option>Displays the remote host ip of the
2882 tenth sshd connection</option>
2885 <command>${tcp_portmon 1 1024 rhost
2887 <option>Displays the remote host name of the
2888 first connection on a privileged port</option>
2891 <command>${tcp_portmon 1 1024 rport
2893 <option>Displays the remote host port of the
2894 fifth connection on a privileged port</option>
2897 <command>${tcp_portmon 1 65535 lservice
2899 <option>Displays the local service name of the
2900 fifteenth connection in the range of all
2904 <para>Note that port monitor variables which share the
2905 same port range actually refer to the same monitor, so
2906 many references to a single port range for different
2907 items and different indexes all use the same monitor
2908 internally. In other words, the program avoids creating
2909 redundant monitors.</para>
2915 <option>templateN</option>
2917 <option>(arg1)</option>
2918 <option>(arg2)</option>
2919 <option>(arg3 ...)</option>
2922 <para>Evaluate the content of the templateN
2923 configuration variable (where N is a value between 0
2924 and 9, inclusively), applying substitutions as
2925 described in the documentation of the corresponding
2926 configuration variable. The number of arguments is
2927 optional, but must match the highest referred index in
2928 the template. You can use the same special sequences in
2929 each argument as the ones valid for a template
2930 definition, e.g. to allow an argument to contain a
2931 whitespace. Also simple nesting of templates is
2932 possible this way.</para>
2933 <para>Here are some examples of template
2936 <member>template0 $\1\2</member>
2937 <member>template1 \1: ${fs_used \2} / ${fs_size
2939 <member>template2 \1 \2</member>
2941 <para>The following list shows sample usage of the
2942 templates defined above, with the equivalent syntax
2943 when not using any template at all:</para>
2948 <entry>using template</entry>
2949 <entry>same without template</entry>
2954 <entry>${template0 node name}</entry>
2955 <entry>$nodename</entry>
2958 <entry>${template1 root /}</entry>
2959 <entry>root: ${fs_free /} / ${fs_size
2964 <programlisting>${template1
2965 ${template2\ disk\ root}
2969 <programlisting>disk root:
2970 ${fs_free /} / ${fs_size
2982 <option>texeci</option>
2984 <option>interval command</option>
2986 <listitem>Runs a command at an interval inside a thread and
2987 displays the output. Same as $execi, except the command is
2988 run inside a thread. Use this if you have a slow script to
2989 keep Conky updating. You should make the interval slightly
2990 longer then the time it takes your script to execute. For
2991 example, if you have a script that take 5 seconds to
2992 execute, you should make the interval at least 6 seconds.
2993 See also $execi. This object will clean up the thread when
2994 it is destroyed, so it can safely be used in a nested
2995 fashion, though it may not produce the desired behaviour if
3002 <option>time</option>
3004 <option>(format)</option>
3006 <listitem>Local time, see man strftime to get more
3007 information about format
3013 <option>to_bytes</option>
3015 <option>size</option>
3017 <listitem>If 'size' is a number followed by a size-unit
3018 (kilobyte,mb,GiB,...) then it converts the size to bytes
3019 and shows it without unit, otherwise it just shows 'size'.
3025 <option>top</option>
3027 <option>type, num</option>
3029 <listitem>This takes arguments in the form:top (name)
3030 (number) Basically, processes are ranked from highest to
3031 lowest in terms of cpu usage, which is what (num)
3032 represents. The types are: "name", "pid", "cpu", "mem",
3033 "mem_res", "mem_vsize", "time", "io_perc", "io_read" and
3034 "io_write". There can be a max of 10 processes listed.
3040 <option>top_io</option>
3042 <option>type, num</option>
3044 <listitem>Same as top, except sorted by the amount of I/O
3045 the process has done during the update interval
3051 <option>top_mem</option>
3053 <option>type, num</option>
3055 <listitem>Same as top, except sorted by mem usage instead
3062 <option>top_time</option>
3064 <option>type, num</option>
3066 <listitem>Same as top, except sorted by total CPU time
3067 instead of current CPU usage
3073 <option>totaldown</option>
3075 <option>(net)</option>
3077 <listitem>Total download, overflows at 4 GB on Linux with
3078 32-bit arch and there doesn't seem to be a way to know how
3079 many times it has already done that before conky has
3086 <option>totalup</option>
3088 <option>(net)</option>
3090 <listitem>Total upload, this one too, may overflow
3096 <option>trashed_mails</option>
3098 <option>(maildir)</option>
3099 <option>(interval)</option>
3101 <listitem>Number of mails marked as trashed in the
3102 specified mailbox or mail spool if not. Only maildir type
3103 mailboxes are supported, mbox type will return -1.
3109 <option>tztime</option>
3111 <option>(timezone) (format)</option>
3113 <listitem>Local time for specified timezone, see man
3114 strftime to get more information about format. The timezone
3115 argument is specified in similar fashion as TZ environment
3116 variable. For hints, look in /usr/share/zoneinfo. e.g.
3117 US/Pacific, Europe/Zurich, etc.
3123 <option>unflagged_mails</option>
3125 <option>(maildir)</option>
3126 <option>(interval)</option>
3128 <listitem>Number of mails not marked as flagged in the
3129 specified mailbox or mail spool if not. Only maildir type
3130 mailboxes are supported, mbox type will return -1.
3136 <option>unforwarded_mails</option>
3138 <option>(maildir)</option>
3139 <option>(interval)</option>
3141 <listitem>Number of mails not marked as forwarded in the
3142 specified mailbox or mail spool if not. Only maildir type
3143 mailboxes are supported, mbox type will return -1.
3149 <option>unreplied_mails</option>
3151 <option>(maildir)</option>
3152 <option>(interval)</option>
3154 <listitem>Number of mails not marked as replied in the
3155 specified mailbox or mail spool if not. Only maildir type
3156 mailboxes are supported, mbox type will return -1.
3162 <option>unseen_mails</option>
3164 <option>(maildir)</option>
3165 <option>(interval)</option>
3167 <listitem>Number of new or unseen mails in the specified
3168 mailbox or mail spool if not. Only maildir type mailboxes
3169 are supported, mbox type will return -1.
3175 <option>updates</option>
3177 <option>Number of updates</option>
3179 <listitem>for debugging
3185 <option>upspeed</option>
3187 <option>(net)</option>
3189 <listitem>Upload speed in suitable IEC units
3195 <option>upspeedf</option>
3197 <option>(net)</option>
3199 <listitem>Upload speed in KiB with one decimal
3205 <option>upspeedgraph</option>
3207 <option>(netdev) (height),(width) (gradient colour 1)
3208 (gradient colour 2) (scale) (-t) (-l)</option>
3210 <listitem>Upload speed graph, colours defined in hex, minus
3211 the #. If scale is non-zero, it becomes the scale for the
3212 graph. Uses a logarithmic scale (to see small numbers) when
3213 you use the -l switch. Takes the switch '-t' to use a
3214 temperature gradient, which makes the gradient values
3215 change depending on the amplitude of a particular graph
3216 value (try it and see).
3222 <option>uptime</option>
3231 <option>uptime_short</option>
3234 <listitem>Uptime in a shorter format
3240 <option>user_names</option>
3243 <listitem>Lists the names of the users logged in
3249 <option>user_number</option>
3252 <listitem>Number of users logged in
3258 <option>user_terms</option>
3261 <listitem>Lists the consoles in use
3267 <option>user_times</option>
3270 <listitem>Lists how long users have been logged in for
3276 <option>utime</option>
3278 <option>(format)</option>
3280 <listitem>Display time in UTC (universal coordinate time).
3286 <option>voffset</option>
3288 <option>(pixels)</option>
3290 <listitem>Change vertical offset by N pixels. Negative
3291 values will cause text to overlap. See also $offset.
3297 <option>voltage_mv</option>
3299 <option>(n)</option>
3301 <listitem>Returns CPU #n's voltage in mV. CPUs are counted
3302 from 1. If omitted, the parameter defaults to 1.
3308 <option>voltage_v</option>
3310 <option>(n)</option>
3312 <listitem>Returns CPU #n's voltage in V. CPUs are counted
3313 from 1. If omitted, the parameter defaults to 1.
3319 <option>weather</option>
3321 <option>URI locID data_type
3322 (interval_in_minutes)</option>
3325 <para>Download, parse and display METAR data.</para>
3326 <para>For the 'URI', there are two
3327 possibilities:</para>
3330 http://weather.noaa.gov/pub/data/observations/metar/stations/</member>
3332 http://xoap.weather.com/weather/local/</member>
3334 <para>The first one is free to use but the second
3335 requires you to register and obtain your partner ID and
3336 license key. These two must be written, separated by a
3337 space, into a file called .xoaprc which needs to be
3338 placed into your home directory.</para>
3339 <para>'locID' must be a valid location identifier for
3340 the required uri. For the NOAA site this must be a
3341 valid ICAO (see for instance
3342 https://pilotweb.nas.faa.gov/qryhtml/icao/). For the
3343 weather.com site this must be a valid location ID (see
3345 http://aspnetresources.com/tools/locid.aspx).</para>
3346 <para>'data_type' must be one of the following:</para>
3349 <command>last_update</command>
3350 <option>The date and time stamp of the data.
3351 The result depends on the URI used. For the
3352 NOAA site it is date (yyyy/mm/dd) and UTC time.
3353 For the weather.com one it is date
3354 ([m]m/[d]d/yy) and Local Time of the
3358 <command>temperature</command>
3359 <option>Air temperature (you can use the
3360 'temperature_unit' config setting to change
3364 <command>cloud_cover</command>
3365 <option>The highest cloud cover status</option>
3368 <command>pressure</command>
3369 <option>Air pressure in millibar</option>
3372 <command>wind_speed</command>
3373 <option>Wind speed in km/h</option>
3376 <command>wind_dir</command>
3377 <option>Wind direction</option>
3380 <command>wind_dir_DEG</command>
3381 <option>Compass wind direction</option>
3384 <command>humidity</command>
3385 <option>Relative humidity in %</option>
3388 <command>weather</command>
3389 <option>Any relevant weather event (rain, snow,
3390 etc.). This is not used if you are querying the
3391 weather.com site since this data is aggregated
3392 into the cloud_cover one</option>
3395 <command>icon</command>
3396 <option>Weather icon (only for
3397 www.weather.com). Can be used together with the
3398 icon kit provided upon registering to their
3402 <para>'delay_in_minutes' (optional, default 30) cannot
3403 be lower than 30 min.</para>
3404 <para>This object is threaded, and once a thread is
3405 created it can't be explicitely destroyed. One thread
3406 will run for each URI specified. You can use any
3407 protocol that Curl supports.</para>
3408 <para>Note that these variables are still EXPERIMENTAL
3409 and can be subject to many future changes.</para>
3415 <option>wireless_ap</option>
3417 <option>(net)</option>
3419 <listitem>Wireless access point MAC address (Linux only)
3425 <option>wireless_bitrate</option>
3427 <option>(net)</option>
3429 <listitem>Wireless bitrate (ie 11 Mb/s) (Linux only)
3435 <option>wireless_essid</option>
3437 <option>(net)</option>
3439 <listitem>Wireless access point ESSID (Linux only)
3445 <option>wireless_link_bar</option>
3447 <option>(height),(width) (net)</option>
3449 <listitem>Wireless link quality bar (Linux only)
3455 <option>wireless_link_qual</option>
3457 <option>(net)</option>
3459 <listitem>Wireless link quality (Linux only)
3465 <option>wireless_link_qual_max</option>
3467 <option>(net)</option>
3469 <listitem>Wireless link quality maximum value (Linux only)
3475 <option>wireless_link_qual_perc</option>
3477 <option>(net)</option>
3479 <listitem>Wireless link quality in percents (Linux only)
3485 <option>wireless_mode</option>
3487 <option>(net)</option>
3489 <listitem>Wireless mode (Managed/Ad-Hoc/Master) (Linux
3496 <option>words</option>
3498 <option>textfile</option>
3500 <listitem>Displays the number of words in the given file
3506 <option>xmms2_album</option>
3509 <listitem>Album in current XMMS2 song
3515 <option>xmms2_artist</option>
3518 <listitem>Artist in current XMMS2 song
3524 <option>xmms2_bar</option>
3526 <option>(height),(width)</option>
3528 <listitem>Bar of XMMS2's progress
3534 <option>xmms2_bitrate</option>
3537 <listitem>Bitrate of current song
3543 <option>xmms2_comment</option>
3546 <listitem>Comment in current XMMS2 song
3552 <option>xmms2_date</option>
3555 <listitem>Returns song's date.
3561 <option>xmms2_duration</option>
3564 <listitem>Duration of current song
3570 <option>xmms2_elapsed</option>
3573 <listitem>Song's elapsed time
3579 <option>xmms2_genre</option>
3582 <listitem>Genre in current XMMS2 song
3588 <option>xmms2_id</option>
3591 <listitem>XMMS2 id of current song
3597 <option>xmms2_percent</option>
3600 <listitem>Percent of song's progress
3606 <option>xmms2_playlist</option>
3609 <listitem>Returns the XMMS2 playlist.
3615 <option>xmms2_size</option>
3618 <listitem>Size of current song
3624 <option>xmms2_smart</option>
3627 <listitem>Prints the song name in either the form "artist -
3628 title" or file name, depending on whats available
3634 <option>xmms2_status</option>
3637 <listitem>XMMS2 status (Playing, Paused, Stopped, or
3644 <option>xmms2_timesplayed</option>
3647 <listitem>Number of times a song was played (presumably).
3653 <option>xmms2_title</option>
3656 <listitem>Title in current XMMS2 song
3662 <option>xmms2_tracknr</option>
3665 <listitem>Track number in current XMMS2 song
3671 <option>xmms2_url</option>
3674 <listitem>Full path to current song
projects / monky / blob