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>cmdline_to_pid</option>
541 <option>string</option>
543 <listitem>PID of the first process that has string in it's
550 <option>color</option>
552 <option>(color)</option>
554 <listitem>Change drawing color to 'color' which is a name of
555 a color or a hexcode preceded with # (for example #0A1B2C ).
556 If you use ncurses only the following colors are supported:
557 red,green,yellow,blue,magenta,cyan,black,white.
563 <option>colorN</option>
566 <listitem>Change drawing color to colorN configuration
567 option, where N is a digit between 0 and 9, inclusively.
573 <option>combine</option>
575 <option>var1 var2</option>
577 <listitem>Places the lines of var2 to the right of the
578 lines of var1 seperated by the chars that are put between
579 var1 and var2. For example: ${combine ${head /proc/cpuinfo
580 2} - ${head /proc/meminfo 1}} gives as output
581 "cpuinfo_line1 - meminfo_line1" on line 1 and
582 "cpuinfo_line2 -" on line 2. $combine vars can also be
583 nested to place more vars next to each other.
589 <option>conky_build_arch</option>
592 <listitem>CPU architecture Conky was built for
598 <option>conky_build_date</option>
601 <listitem>Date Conky was built
607 <option>conky_version</option>
610 <listitem>Conky version
618 <option>(cpuN)</option>
620 <listitem>CPU usage in percents. For SMP machines, the CPU
621 number can be provided as an argument. ${cpu cpu0} is the
622 total usage, and ${cpu cpuX} (X >= 1) are individual
629 <option>cpubar</option>
631 <option>(cpuN) (height),(width)</option>
633 <listitem>Bar that shows CPU usage, height is bar's height
634 in pixels. See $cpu for more info on SMP.
640 <option>cpugauge</option>
642 <option>(cpuN) (height),(width)</option>
644 <listitem>Elliptical gauge that shows CPU usage, height and
645 width are gauge's vertical and horizontal axis
646 respectively. See $cpu for more info on SMP.
652 <option>cpugraph</option>
654 <option>(cpuN) (height),(width) (gradient colour 1)
655 (gradient colour 2) (scale) (-t) (-l)</option>
657 <listitem>CPU usage graph, with optional colours in hex,
658 minus the #. See $cpu for more info on SMP. Uses a
659 logarithmic scale (to see small numbers) when you use the
660 -l switch. Takes the switch '-t' to use a temperature
661 gradient, which makes the gradient values change depending
662 on the amplitude of a particular graph value (try it and
669 <option>curl</option>
671 <option>url (interval_in_minutes)</option>
674 <para>Download data from URI using Curl at the
675 specified interval. The interval may be a floating
676 point value greater than 0, otherwise defaults to 15
677 minutes. Most useful when used in conjunction with Lua
678 and the Lua API. This object is threaded, and once a
679 thread is created it can't be explicitely destroyed.
680 One thread will run for each URI specified. You can use
681 any protocol that Curl supports.</para>
687 <option>desktop</option>
690 <listitem>Number of the desktop on which conky is running
691 or the message "Not running in X" if this is the case.
697 <option>desktop_name</option>
700 <listitem>Name of the desktop on which conky is running or
701 the message "Not running in X" if this is the case.
707 <option>desktop_number</option>
710 <listitem>Number of desktops or the message "Not running in
711 X" if this is the case.
717 <option>disk_protect</option>
719 <option>device</option>
721 <listitem>Disk protection status, if supported (needs
722 kernel-patch). Prints either "frozen" or "free " (note the
729 <option>diskio</option>
731 <option>(device)</option>
733 <listitem>Displays current disk IO. Device is optional, and
734 takes the form of sda for /dev/sda. Individual partitions
741 <option>diskio_read</option>
743 <option>(device)</option>
745 <listitem>Displays current disk IO for reads. Device as in
752 <option>diskio_write</option>
754 <option>(device)</option>
756 <listitem>Displays current disk IO for writes. Device as in
763 <option>diskiograph</option>
765 <option>(device) (height),(width) (gradient colour 1)
766 (gradient colour 2) (scale) (-t) (-l)</option>
768 <listitem>Disk IO graph, colours defined in hex, minus the
769 #. If scale is non-zero, it becomes the scale for the
770 graph. Uses a logarithmic scale (to see small numbers) when
771 you use -l switch. Takes the switch '-t' to use a
772 temperature gradient, which makes the gradient values
773 change depending on the amplitude of a particular graph
774 value (try it and see).
780 <option>diskiograph_read</option>
782 <option>(device) (height),(width) (gradient colour 1)
783 (gradient colour 2) (scale) (-t) (-l)</option>
785 <listitem>Disk IO graph for reads, colours defined in hex,
786 minus the #. If scale is non-zero, it becomes the scale for
787 the graph. Device as in diskio. Uses a logarithmic scale
788 (to see small numbers) when you use -l switch. Takes the
789 switch '-t' to use a temperature gradient, which makes the
790 gradient values change depending on the amplitude of a
791 particular graph value (try it and see).
797 <option>diskiograph_write</option>
799 <option>(device) (height),(width) (gradient colour 1)
800 (gradient colour 2) (scale) (-t) (-l)</option>
802 <listitem>Disk IO graph for writes, colours defined in hex,
803 minus the #. If scale is non-zero, it becomes the scale for
804 the graph. Device as in diskio. Uses a logarithmic scale
805 (to see small numbers) when you use -l switch. Takes the
806 switch '-t' to use a temperature gradient, which makes the
807 gradient values change depending on the amplitude of a
808 particular graph value (try it and see).
814 <option>downspeed</option>
816 <option>(net)</option>
818 <listitem>Download speed in suitable IEC units
824 <option>downspeedf</option>
826 <option>(net)</option>
828 <listitem>Download speed in KiB with one decimal
834 <option>downspeedgraph</option>
836 <option>(netdev) (height),(width) (gradient colour 1)
837 (gradient colour 2) (scale) (-t) (-l)</option>
839 <listitem>Download speed graph, colours defined in hex,
840 minus the #. If scale is non-zero, it becomes the scale for
841 the graph. Uses a logarithmic scale (to see small numbers)
842 when you use -l switch. Takes the switch '-t' to use a
843 temperature gradient, which makes the gradient values
844 change depending on the amplitude of a particular graph
845 value (try it and see).
851 <option>draft_mails</option>
853 <option>(maildir)</option>
854 <option>(interval)</option>
856 <listitem>Number of mails marked as draft in the specified
857 mailbox or mail spool if not. Only maildir type mailboxes
858 are supported, mbox type will return -1.
864 <option>else</option>
867 <listitem>Text to show if any of the above are not true
873 <option>endif</option>
877 <listitem>Ends an $if block.
883 <option>entropy_avail</option>
886 <listitem>Current entropy available for crypto freaks
892 <option>entropy_bar</option>
894 <option>(height),(width)</option>
896 <listitem>Normalized bar of available entropy for crypto
903 <option>entropy_perc</option>
906 <listitem>Percentage of entropy available in comparison to
913 <option>entropy_poolsize</option>
916 <listitem>Total size of system entropy pool for crypto
923 <option>eval</option>
925 <option>string</option>
927 <listitem>Evaluates given string according to the rules of
928 TEXT interpretation, i.e. parsing any contained text object
929 specifications into their output, any occuring '$$' into a
930 single '$' and so on. The output is then being parsed
939 <option>api_userid api_key character_id</option>
941 <listitem>Fetches your currently training skill from the
942 Eve Online API servers (http://www.eve-online.com/) and
943 displays the skill along with the remaining training time.
949 <option>exec</option>
951 <option>command</option>
953 <listitem>Executes a shell command and displays the output
954 in conky. warning: this takes a lot more resources than
955 other variables. I'd recommend coding wanted behaviour in C
962 <option>execbar</option>
964 <option>command</option>
966 <listitem>Same as exec, except if the first value return is
967 a value between 0-100, it will use that number for a bar.
968 The size for bars can be controlled via the
969 default_bar_size config setting.
975 <option>execgauge</option>
977 <option>command</option>
979 <listitem>Same as exec, except if the first value returned
980 is a value between 0-100, it will use that number for a
981 gauge. The size for gauges can be controlled via the
982 default_gauge_size config setting.
988 <option>execgraph</option>
990 <option>(-t) (-l) command</option>
992 <listitem>Same as execbar, but graphs values. Uses a
993 logaritmic scale when the log option (-l switch) is given
994 (to see small numbers). Values still have to be between 0
995 and 100. The size for graphs can be controlled via the
996 default_graph_size config setting. Takes the switch '-t' to
997 use a temperature gradient, which makes the gradient values
998 change depending on the amplitude of a particular graph
999 value (try it and see). If -t or -l is your first argument,
1000 you may need to preceed it by a space (' ').
1006 <option>execi</option>
1008 <option>interval command</option>
1010 <listitem>Same as exec but with specific interval. Interval
1011 can't be less than update_interval in configuration. See
1018 <option>execibar</option>
1020 <option>interval command</option>
1022 <listitem>Same as execbar, except with an interval
1028 <option>execigauge</option>
1030 <option>interval command</option>
1032 <listitem>Same as execgauge, but takes an interval arg and
1039 <option>execigraph</option>
1041 <option>interval (-t) (-l) command</option>
1043 <listitem>Same as execgraph, but takes an interval arg and
1044 graphs values. If -t or -l is your first argument, you may
1045 need to preceed it by a space (' ').
1051 <option>execp</option>
1053 <option>command</option>
1055 <listitem>Executes a shell command and displays the output
1056 in conky. warning: this takes a lot more resources than
1057 other variables. I'd recommend coding wanted behaviour in C
1058 and posting a patch. This differs from $exec in that it
1059 parses the output of the command, so you can insert things
1060 like ${color red}hi!${color} in your script and have it
1061 correctly parsed by Conky. Caveats: Conky parses and
1062 evaluates the output of $execp every time Conky loops, and
1063 then destroys all the objects. If you try to use anything
1064 like $execi within an $execp statement, it will
1065 functionally run at the same interval that the $execp
1066 statement runs, as it is created and destroyed at every
1073 <option>execpi</option>
1075 <option>interval command</option>
1077 <listitem>Same as execp but with specific interval.
1078 Interval can't be less than update_interval in
1079 configuration. Note that the output from the $execpi
1080 command is still parsed and evaluated at every interval.
1086 <option>flagged_mails</option>
1088 <option>(maildir)</option>
1089 <option>(interval)</option>
1091 <listitem>Number of mails marked as flagged in the
1092 specified mailbox or mail spool if not. Only maildir type
1093 mailboxes are supported, mbox type will return -1.
1099 <option>font</option>
1101 <option>(font)</option>
1103 <listitem>Specify a different font. This new font will
1104 apply to the current line and everything following. You can
1105 use a $font with no arguments to change back to the default
1106 font (much like with $color)
1112 <option>format_time</option>
1114 <option>seconds format</option>
1116 <listitem>Format time given in seconds. Format is a string
1117 that should start and end with a "-char. The "-chars are not
1118 part of the output, \w,\d,\h,\m,\s and \\ are replaced by
1119 weeks,days,hours,minutes,seconds and \. If you leave out a unit,
1120 it's value will be expressed in the highest unite lower then the
1121 one left out. Text between ()-chars will not be visible if a
1122 replaced unit in this text is 0. If seconds is a decimal number
1123 then you can see the numbers behind the point by using \S
1124 followed by a number that specifies the amount of
1125 digits behind the point that you want to see (maximum 9).
1131 <option>forwarded_mails</option>
1133 <option>(maildir)</option>
1134 <option>(interval)</option>
1136 <listitem>Number of mails marked as forwarded in the
1137 specified mailbox or mail spool if not. Only maildir type
1138 mailboxes are supported, mbox type will return -1.
1144 <option>freq</option>
1146 <option>(n)</option>
1148 <listitem>Returns CPU #n's frequency in MHz. CPUs are
1149 counted from 1. If omitted, the parameter defaults to 1.
1155 <option>freq_g</option>
1157 <option>(n)</option>
1159 <listitem>Returns CPU #n's frequency in GHz. CPUs are
1160 counted from 1. If omitted, the parameter defaults to 1.
1166 <option>fs_bar</option>
1168 <option>(height),(width) fs</option>
1170 <listitem>Bar that shows how much space is used on a file
1171 system. height is the height in pixels. fs is any file on
1178 <option>fs_bar_free</option>
1180 <option>(height),(width) fs</option>
1182 <listitem>Bar that shows how much space is free on a file
1183 system. height is the height in pixels. fs is any file on
1190 <option>fs_free</option>
1192 <option>(fs)</option>
1194 <listitem>Free space on a file system available for users.
1200 <option>fs_free_perc</option>
1202 <option>(fs)</option>
1204 <listitem>Free percentage of space on a file system
1205 available for users.
1211 <option>fs_size</option>
1213 <option>(fs)</option>
1215 <listitem>File system size.
1221 <option>fs_type</option>
1223 <option>(fs)</option>
1225 <listitem>File system type.
1231 <option>fs_used</option>
1233 <option>(fs)</option>
1235 <listitem>File system used space.
1241 <option>fs_used_perc</option>
1243 <option>(fs)</option>
1245 <listitem>Percent of file system used space.
1251 <option>goto</option>
1255 <listitem>The next element will be printed at position 'x'.
1262 <option>gw_iface</option>
1265 <listitem>Displays the default route's interface or
1266 "multiple"/"none" accordingly.
1272 <option>gw_ip</option>
1275 <listitem>Displays the default gateway's IP or
1276 "multiple"/"none" accordingly.
1282 <option>hddtemp</option>
1284 <option>(dev)</option>
1286 <listitem>Displays temperature of a selected hard disk
1287 drive as reported by the hddtemp daemon. Use hddtemp_host
1288 and hddtemp_port to specify a host and port for all hddtemp
1289 objects. If no dev parameter is given, the first disk returned
1290 by the hddtemp daemon is used.
1296 <option>head</option>
1298 <option>logfile lines (next_check)</option>
1300 <listitem>Displays first N lines of supplied text file. The
1301 file is checked every 'next_check' update. If next_check is
1302 not supplied, Conky defaults to 2. Max of 30 lines can be
1303 displayed, or until the text buffer is filled.
1311 <option>(height)</option>
1313 <listitem>Horizontal line, height is the height in pixels
1319 <option>hwmon</option>
1321 <option>(dev) type n (factor offset)</option>
1323 <listitem>Hwmon sensor from sysfs (Linux 2.6). Parameter
1324 dev may be omitted if you have only one hwmon device.
1325 Parameter type is either 'in' or 'vol' meaning voltage;
1326 'fan' meaning fan; 'temp' meaning temperature. Parameter n
1327 is number of the sensor. See /sys/class/hwmon/ on your
1328 local computer. The optional arguments 'factor' and
1329 'offset' allow precalculation of the raw input, which is
1330 being modified as follows: 'input = input * factor +
1331 offset'. Note that they have to be given as decimal values
1332 (i.e. contain at least one decimal place).
1338 <option>i2c</option>
1340 <option>(dev) type n (factor offset)</option>
1342 <listitem>I2C sensor from sysfs (Linux 2.6). Parameter dev
1343 may be omitted if you have only one I2C device. Parameter
1344 type is either 'in' or 'vol' meaning voltage; 'fan' meaning
1345 fan; 'temp' meaning temperature. Parameter n is number of
1346 the sensor. See /sys/bus/i2c/devices/ on your local
1347 computer. The optional arguments 'factor' and 'offset'
1348 allow precalculation of the raw input, which is being
1349 modified as follows: 'input = input * factor + offset'.
1350 Note that they have to be given as decimal values (i.e.
1351 contain at least one decimal place).
1357 <option>i8k_ac_status</option>
1361 <listitem>If running the i8k kernel driver for Inspiron
1362 laptops, displays whether ac power is on, as listed in
1363 /proc/i8k (translated to human-readable). Beware that this
1364 is by default not enabled by i8k itself.
1370 <option>i8k_bios</option>
1374 <listitem>If running the i8k kernel driver for Inspiron
1375 laptops, displays the bios version as listed in /proc/i8k.
1381 <option>i8k_buttons_status</option>
1385 <listitem>If running the i8k kernel driver for Inspiron
1386 laptops, displays the volume buttons status as listed in
1393 <option>i8k_cpu_temp</option>
1397 <listitem>If running the i8k kernel driver for Inspiron
1398 laptops, displays the cpu temperature in Celsius, as
1399 reported by /proc/i8k.
1405 <option>i8k_left_fan_rpm</option>
1409 <listitem>If running the i8k kernel driver for Inspiron
1410 laptops, displays the left fan's rate of rotation, in
1411 revolutions per minute as listed in /proc/i8k. Beware, some
1412 laptops i8k reports these fans in reverse order.
1418 <option>i8k_left_fan_status</option>
1422 <listitem>If running the i8k kernel driver for Inspiron
1423 laptops, displays the left fan status as listed in
1424 /proc/i8k (translated to human-readable). Beware, some
1425 laptops i8k reports these fans in reverse order.
1431 <option>i8k_right_fan_rpm</option>
1435 <listitem>If running the i8k kernel driver for Inspiron
1436 laptops, displays the right fan's rate of rotation, in
1437 revolutions per minute as listed in /proc/i8k. Beware, some
1438 laptops i8k reports these fans in reverse order.
1444 <option>i8k_right_fan_status</option>
1448 <listitem>If running the i8k kernel driver for Inspiron
1449 laptops, displays the right fan status as listed in
1450 /proc/i8k (translated to human-readable). Beware, some
1451 laptops i8k reports these fans in reverse order.
1457 <option>i8k_serial</option>
1461 <listitem>If running the i8k kernel driver for Inspiron
1462 laptops, displays your laptop serial number as listed in
1469 <option>i8k_version</option>
1473 <listitem>If running the i8k kernel driver for Inspiron
1474 laptops, displays the version formatting of /proc/i8k.
1480 <option>ibm_brightness</option>
1483 <listitem>If running the IBM ACPI, displays the brigtness
1484 of the laptops's LCD (0-7).
1490 <option>ibm_fan</option>
1493 <listitem>If running the IBM ACPI, displays the fan speed.
1499 <option>ibm_temps</option>
1503 <listitem>If running the IBM ACPI, displays the
1504 temperatures from the IBM temperature sensors (N=0..7)
1505 Sensor 0 is on the CPU, 3 is on the GPU.
1511 <option>ibm_volume</option>
1514 <listitem>If running the IBM ACPI, displays the "master"
1515 volume, controlled by the volume keys (0-14).
1521 <option>iconv_start</option>
1523 <option>codeset_from codeset_to</option>
1525 <listitem>Convert text from one codeset to another using
1526 GNU iconv. Needs to be stopped with iconv_stop.
1532 <option>iconv_stop</option>
1536 <listitem>Stop iconv codeset conversion.
1542 <option>if_empty</option>
1544 <option>(var)</option>
1546 <listitem>if conky variable VAR is empty, display
1547 everything between $if_empty and the matching $endif
1553 <option>if_existing</option>
1555 <option>file (string)</option>
1557 <listitem>if FILE exists, display everything between
1558 if_existing and the matching $endif. The optional second
1559 paramater checks for FILE containing the specified string
1560 and prints everything between $if_existing and the matching
1567 <option>if_gw</option>
1570 <listitem>if there is at least one default gateway, display
1571 everything between $if_gw and the matching $endif
1577 <option>if_match</option>
1579 <option>expression</option>
1581 <listitem>Evaluates the given boolean expression, printing
1582 everything between $if_match and the matching $endif
1583 depending on whether the evaluation returns true or not.
1584 Valid expressions consist of a left side, an operator and a
1585 right side. Left and right sides are being parsed for
1586 contained text objects before evaluation. Recognised left
1587 and right side types are:
1590 <command>double</command>Argument consists of only
1591 digits and a single dot.</member>
1593 <command>long</command>Argument consists of only
1596 <command>string</command>Argument is enclosed in
1597 quotation mark or the checks for double and long failed
1599 </simplelist>Valid operands are: '>', '<', '>=',
1600 '<=', '==', '!='.
1606 <option>if_mixer_mute</option>
1608 <option>(mixer)</option>
1610 <listitem>If mixer exists, display everything between
1611 $if_mixer_mute and the matching $endif. If no mixer is
1612 specified, "Master" is used.
1618 <option>if_mounted</option>
1620 <option>(mountpoint)</option>
1622 <listitem>if MOUNTPOINT is mounted, display everything
1623 between $if_mounted and the matching $endif
1629 <option>if_mpd_playing</option>
1632 <listitem>if mpd is playing or paused, display everything
1633 between $if_mpd_playing and the matching $endif
1639 <option>if_running</option>
1641 <option>(process)</option>
1643 <listitem>if PROCESS is running, display everything
1644 $if_running and the matching $endif. This uses the
1645 ``pidof'' command, so the -x switch is also supported.
1651 <option>if_smapi_bat_installed</option>
1653 <option>(INDEX)</option>
1655 <listitem>when using smapi, if the battery with index INDEX
1656 is installed, display everything between
1657 $if_smapi_bat_installed and the matching $endif
1663 <option>if_up</option>
1665 <option>(interface)</option>
1667 <listitem>if INTERFACE exists and is up, display everything
1668 between $if_up and the matching $endif
1674 <option>if_updatenr</option>
1676 <option>(updatenr)</option>
1678 <listitem>If it's the UPDATENR-th time that conky updates,
1679 display everything between $if_updatenr and the matching
1680 $endif. The counter resets when the highest UPDATENR is
1681 reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr
1682 2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the
1683 time followed by bar 25% of the time followed by nothing
1684 the other half of the time.
1690 <option>if_xmms2_connected</option>
1693 <listitem>Display everything between $if_xmms2_connected
1694 and the matching $endif if xmms2 is running.
1700 <option>image</option>
1702 <option><path to image> (-p x,y) (-s WxH) (-n)
1703 (-f interval)</option>
1705 <listitem>Renders an image from the path specified using
1706 Imlib2. Takes 4 optional arguments: a position, a size, a
1707 no-cache switch, and a cache flush interval. Changing the
1708 x,y position will move the position of the image, and
1709 changing the WxH will scale the image. If you specify the
1710 no-cache flag (-n), the image will not be cached.
1711 Alternately, you can specify the -f int switch to specify a
1712 cache flust interval for a particular image. Example:
1713 ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200}
1714 will render 'cheeseburger.jpg' at (20,20) scaled to 200x200
1715 pixels. Conky does not make any attempt to adjust the
1716 position (or any other formatting) of images, they are just
1717 rendered as per the arguments passed. The only reason
1718 $image is part of the TEXT section, is to allow for runtime
1719 modifications, through $execp $lua_parse, or some other
1726 <option>imap_messages</option>
1728 <option>(args)</option>
1730 <listitem>Displays the number of messages in your global
1731 IMAP inbox by default. You can define individual IMAP
1732 inboxes seperately by passing arguments to this object.
1733 Arguments are: "host user pass [-i interval (in seconds)]
1734 [-f 'folder'] [-p port] [-e 'command'] [-r retries]". Default
1735 port is 143, default folder is 'INBOX', default interval is
1736 5 minutes, and default number of retries before giving up
1737 is 5. If the password is supplied as '*', you will be
1738 prompted to enter the password when Conky starts.
1744 <option>imap_unseen</option>
1746 <option>(args)</option>
1748 <listitem>Displays the number of unseen messages in your
1749 global IMAP inbox by default. You can define individual
1750 IMAP inboxes seperately by passing arguments to this
1751 object. Arguments are: "host user pass [-i interval (in
1752 seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r retries]".
1753 Default port is 143, default folder is 'INBOX', default
1754 interval is 5 minutes, and default number of retries before
1755 giving up is 5. If the password is supplied as '*', you
1756 will be prompted to enter the password when Conky starts.
1762 <option>include</option>
1764 <option>path</option>
1767 <para>Loads the configfile at path, places the
1768 configsettings behind the configsettings in the orginal
1769 config and places the vars where the includevar
1776 <option>ioscheduler</option>
1778 <option>disk</option>
1780 <listitem>Prints the current ioscheduler used for the given
1781 disk name (i.e. e.g. "hda" or "sdb")
1787 <option>kernel</option>
1790 <listitem>Kernel version
1796 <option>laptop_mode</option>
1799 <listitem>The value of /proc/sys/vm/laptop_mode
1805 <option>lines</option>
1807 <option>textfile</option>
1809 <listitem>Displays the number of lines in the given file
1815 <option>loadavg</option>
1817 <option>(1|2|3)</option>
1819 <listitem>System load average, 1 is for past 1 minute, 2
1820 for past 5 minutes and 3 for past 15 minutes. Without argument, prints
1821 all three values separated by whitespace.
1827 <option>loadgraph</option>
1829 <option>(height),(width) (gradient colour 1)
1830 (gradient colour 2) (scale) (-t) (-l)</option>
1832 <listitem>Load1 average graph, similar to xload, with
1833 optional colours in hex, minus the #. Uses a logarithmic
1834 scale (to see small numbers) when you use the -l switch.
1835 Takes the switch '-t' to use a temperature gradient, which
1836 makes the gradient values change depending on the amplitude
1837 of a particular graph value (try it and see).
1843 <option>lua</option>
1845 <option>function_name (function parameters)</option>
1847 <listitem>Executes a Lua function with given parameters,
1848 then prints the returned string. See also 'lua_load' on how
1849 to load scripts. Conky puts 'conky_' in front of
1850 function_name to prevent accidental calls to the wrong
1851 function unless you put you place 'conky_' in front of it
1858 <option>lua_bar</option>
1860 <option>(height, width) function_name (function
1861 parameters)</option>
1863 <listitem>Executes a Lua function with given parameters and
1864 draws a bar. Expects result value to be an integer between
1865 0 and 100. See also 'lua_load' on how to load scripts.
1866 Conky puts 'conky_' in front of function_name to prevent
1867 accidental calls to the wrong function unless you put you
1868 place 'conky_' in front of it yourself.
1874 <option>lua_gauge</option>
1876 <option>(height, width) function_name (function
1877 parameters)</option>
1879 <listitem>Executes a Lua function with given parameters and
1880 draws a gauge. Expects result value to be an integer
1881 between 0 and 100. See also 'lua_load' on how to load
1882 scripts. Conky puts 'conky_' in front of function_name to
1883 prevent accidental calls to the wrong function unless you
1884 put you place 'conky_' in front of it yourself.
1890 <option>lua_graph</option>
1892 <option>function_name (height),(width) (gradient colour
1893 1) (gradient colour 2) (scale) (-t) (-l)</option>
1895 <listitem>Executes a Lua function with and draws a graph.
1896 Expects result value to be any number, and by default will
1897 scale to show the full range. See also 'lua_load' on how to
1898 load scripts. Takes the switch '-t' to use a temperature
1899 gradient, which makes the gradient values change depending
1900 on the amplitude of a particular graph value (try it and
1901 see). Conky puts 'conky_' in front of function_name to
1902 prevent accidental calls to the wrong function unless you
1903 put you place 'conky_' in front of it yourself.
1909 <option>lua_parse</option>
1911 <option>function_name (function parameters)</option>
1913 <listitem>Executes a Lua function with given parameters as
1914 per $lua, then parses and prints the result value as per
1915 the syntax for Conky's TEXT section. See also 'lua_load' on
1916 how to load scripts. Conky puts 'conky_' in front of
1917 function_name to prevent accidental calls to the wrong
1918 function unless you put you place 'conky_' in front of it
1925 <option>machine</option>
1928 <listitem>Machine, i686 for example
1934 <option>mails</option>
1936 <option>(mailbox)</option>
1937 <option>(interval)</option>
1939 <listitem>Mail count in the specified mailbox or your mail
1940 spool if not. Both mbox and maildir type mailboxes are
1941 supported. You can use a program like fetchmail to get
1942 mails from some server using your favourite protocol. See
1949 <option>mboxscan</option>
1951 <option>(-n number of messages to print) (-fw from
1952 width) (-sw subject width) mbox</option>
1954 <listitem>Print a summary of recent messages in an mbox
1955 format mailbox. mbox parameter is the filename of the
1956 mailbox (can be encapsulated using '"', ie. ${mboxscan -n
1957 10 "/home/brenden/some box"}
1963 <option>mem</option>
1966 <listitem>Amount of memory in use
1972 <option>membar</option>
1974 <option>(height),(width)</option>
1976 <listitem>Bar that shows amount of memory in use
1982 <option>memeasyfree</option>
1985 <listitem>Amount of free memory including the memory that
1986 is very easily freed (buffers/cache)
1992 <option>memfree</option>
1995 <listitem>Amount of free memory
2001 <option>memgauge</option>
2003 <option>(height),(width)</option>
2005 <listitem>Gauge that shows amount of memory in use (see
2012 <option>memgraph</option>
2014 <option>(height),(width) (gradient colour 1) (gradient
2015 colour 2) (scale) (-t) (-l)</option>
2017 <listitem>Memory usage graph. Uses a logarithmic scale (to
2018 see small numbers) when you use the -l switch. Takes the
2019 switch '-t' to use a temperature gradient, which makes the
2020 gradient values change depending on the amplitude of a
2021 particular graph value (try it and see).
2027 <option>memmax</option>
2030 <listitem>Total amount of memory
2036 <option>memperc</option>
2039 <listitem>Percentage of memory in use
2045 <option>mixer</option>
2047 <option>(device)</option>
2049 <listitem>Prints the mixer value as reported by the OS.
2050 Default mixer is "vol", but you can specify one of the
2051 following optional arguments: "vol", "bass", "treble",
2052 "synth", "pcm", "speaker", "line", "mic", "cd", "mix",
2053 "pcm2", "rec", "igain", "ogain", "line1", "line2", "line3",
2054 "dig1", "dig2", "dig3", "phin", "phout", "video", "radio",
2055 "monitor". Refer to the definition of SOUND_DEVICE_NAMES in
2056 <linux/soundcard.h> (on Linux), <soundcard.h>
2057 (on OpenBSD), or <sys/soundcard.h> to find the exact
2058 options available on your system.
2064 <option>mixerbar</option>
2066 <option>(device)</option>
2068 <listitem>Displays mixer value in a bar as reported by the
2069 OS. See docs for $mixer for details on arguments.
2075 <option>mixerl</option>
2077 <option>(device)</option>
2079 <listitem>Prints the left channel mixer value as reported
2080 by the OS. See docs for $mixer for details on arguments.
2086 <option>mixerlbar</option>
2088 <option>(device)</option>
2090 <listitem>Displays the left channel mixer value in a bar as
2091 reported by the OS. See docs for $mixer for details on
2098 <option>mixerr</option>
2100 <option>(device)</option>
2102 <listitem>Prints the right channel mixer value as reported
2103 by the OS. See docs for $mixer for details on arguments.
2109 <option>mixerrbar</option>
2111 <option>(device)</option>
2113 <listitem>Displays the right channel mixer value in a bar
2114 as reported by the OS. See docs for $mixer for details on
2121 <option>moc_album</option>
2124 <listitem>Album of the current MOC song
2130 <option>moc_artist</option>
2133 <listitem>Artist of the current MOC song
2139 <option>moc_bitrate</option>
2142 <listitem>Bitrate in the current MOC song
2148 <option>moc_curtime</option>
2151 <listitem>Current time of the current MOC song
2157 <option>moc_file</option>
2160 <listitem>File name of the current MOC song
2166 <option>moc_rate</option>
2169 <listitem>Rate of the current MOC song
2175 <option>moc_song</option>
2178 <listitem>The current song name being played in MOC.
2184 <option>moc_state</option>
2187 <listitem>Current state of MOC; playing, stopped etc.
2193 <option>moc_timeleft</option>
2196 <listitem>Time left in the current MOC song
2202 <option>moc_title</option>
2205 <listitem>Title of the current MOC song
2211 <option>moc_totaltime</option>
2214 <listitem>Total length of the current MOC song
2220 <option>monitor</option>
2223 <listitem>Number of the monitor on which conky is running
2224 or the message "Not running in X" if this is the case.
2230 <option>monitor_number</option>
2233 <listitem>Number of monitors or the message "Not running in
2234 X" if this is the case.
2240 <option>mpd_album</option>
2243 <listitem>Album in current MPD song
2249 <option>mpd_artist</option>
2252 <listitem>Artist in current MPD song must be enabled at
2259 <option>mpd_bar</option>
2261 <option>(height),(width)</option>
2263 <listitem>Bar of mpd's progress
2269 <option>mpd_bitrate</option>
2272 <listitem>Bitrate of current song
2278 <option>mpd_elapsed</option>
2281 <listitem>Song's elapsed time
2287 <option>mpd_file</option>
2290 <listitem>Prints the file name of the current MPD song
2296 <option>mpd_length</option>
2299 <listitem>Song's length
2305 <option>mpd_name</option>
2308 <listitem>Prints the MPD name field
2314 <option>mpd_percent</option>
2317 <listitem>Percent of song's progress
2323 <option>mpd_random</option>
2326 <listitem>Random status (On/Off)
2332 <option>mpd_repeat</option>
2335 <listitem>Repeat status (On/Off)
2341 <option>mpd_smart</option>
2343 <option>(max length)</option>
2345 <listitem>Prints the song name in either the form "artist -
2346 title" or file name, depending on whats available
2352 <option>mpd_status</option>
2355 <listitem>Playing, stopped, et cetera.
2361 <option>mpd_title</option>
2363 <option>(max length)</option>
2365 <listitem>Title of current MPD song
2371 <option>mpd_track</option>
2374 <listitem>Prints the MPD track field
2380 <option>mpd_vol</option>
2383 <listitem>MPD's volume
2389 <option>nameserver</option>
2391 <option>(index)</option>
2393 <listitem>Print a nameserver from /etc/resolv.conf. Index
2394 starts at and defaults to 0.
2400 <option>new_mails</option>
2402 <option>(mailbox)</option>
2403 <option>(interval)</option>
2405 <listitem>Unread mail count in the specified mailbox or
2406 mail spool if not. Both mbox and maildir type mailboxes are
2413 <option>nodename</option>
2422 <option>nvidia</option>
2424 <option>threshold</option>
2425 <option>temp</option>
2426 <option>ambient</option>
2427 <option>gpufreq</option>
2428 <option>memfreq</option>
2429 <option>imagequality</option>
2431 <listitem>Nvidia graficcard support for the XNVCtrl
2432 library. Each option can be shortened to the least
2433 significant part. Temperatures are printed as float, all
2434 other values as integer.
2437 <command>threshold</command>
2438 <option>The thresholdtemperature at
2439 which the gpu slows down</option>
2442 <command>temp</command>
2443 <option>Gives the gpu current
2444 temperature</option>
2447 <command>ambient</command>
2448 <option>Gives current air temperature near GPU
2452 <command>gpufreq</command>
2453 <option>Gives the current gpu frequency</option>
2456 <command>memfreq</command>
2457 <option>Gives the current mem frequency</option>
2460 <command>imagequality</command>
2461 <option>Which imagequality should be choosen by
2462 OpenGL applications</option>
2470 <option>offset</option>
2472 <option>(pixels)</option>
2474 <listitem>Move text over by N pixels. See also $voffset.
2480 <option>outlinecolor</option>
2482 <option>(color)</option>
2484 <listitem>Change outline color
2490 <option>pb_battery</option>
2492 <option>item</option>
2494 <listitem>If running on Apple powerbook/ibook, display
2495 information on battery status. The item parameter
2496 specifies, what information to display. Exactly one item
2497 must be specified. Valid items are:
2500 <command>status</command>
2501 <option>Display if battery is fully charged,
2502 charging, discharging or absent (running on
2506 <command>percent</command>
2507 <option>Display charge of battery in percent, if
2508 charging or discharging. Nothing will be displayed,
2509 if battery is fully charged or absent.</option>
2512 <command>time</command>
2513 <option>Display the time remaining until the
2514 battery will be fully charged or discharged at
2515 current rate. Nothing is displayed, if battery is
2516 absent or if it's present but fully charged and not
2517 discharging.</option>
2525 <option>pid_chroot</option>
2527 <option>pid</option>
2529 <listitem>Directory used as rootdirectory by the process
2530 (this will be "/" unless the process did a chroot syscall)
2536 <option>pid_cmdline</option>
2538 <option>pid</option>
2540 <listitem>Command line this process was invoked with
2546 <option>pid_cwd</option>
2548 <option>pid</option>
2550 <listitem>Current working directory of the process
2556 <option>pid_environ</option>
2558 <option>pid varname</option>
2560 <listitem>Contents of a environment-var of the process
2566 <option>pid_environ_list</option>
2568 <option>pid</option>
2570 <listitem>List of environment-vars that the process can see
2576 <option>pid_exe</option>
2578 <option>pid</option>
2580 <listitem>Path to executed command that started the process
2586 <option>pid_nice</option>
2588 <option>pid</option>
2590 <listitem>The nice value of the process
2596 <option>pid_openfiles</option>
2598 <option>pid</option>
2600 <listitem>List of files that the process has open
2606 <option>pid_parent</option>
2608 <option>pid</option>
2610 <listitem>The pid of the parent of the process
2616 <option>pid_priority</option>
2618 <option>pid</option>
2620 <listitem>The priority of the process (see 'priority' in "man 5 proc")
2626 <option>pid_state</option>
2628 <option>pid</option>
2630 <listitem>State of the process
2636 <option>pid_state_short</option>
2638 <option>pid</option>
2640 <listitem>One of the chars in "RSDZTW" representing the state
2641 of the process where R is running, S is sleeping in an
2642 interruptible wait, D is waiting in uninterruptible disk sleep,
2643 Z is zombie, T is traced or stopped (on a signal), and W is paging
2649 <option>pid_stderr</option>
2651 <option>pid</option>
2653 <listitem>Filedescriptor binded to the STDERR of the process
2659 <option>pid_stdin</option>
2661 <option>pid</option>
2663 <listitem>Filedescriptor binded to the STDIN of the process
2669 <option>pid_stdout</option>
2671 <option>pid</option>
2673 <listitem>Filedescriptor binded to the STDOUT of the process
2679 <option>pid_threads</option>
2681 <option>pid</option>
2683 <listitem>Number of threads in process containing this thread
2689 <option>pid_thread_list</option>
2691 <option>pid</option>
2693 <listitem>List with pid's from threads from this process
2699 <option>pid_time_kernelmode</option>
2701 <option>pid</option>
2703 <listitem>Amount of time that the process has been scheduled in kernel mode in seconds
2709 <option>pid_time_usermode</option>
2711 <option>pid</option>
2713 <listitem>Amount of time that the process has been scheduled in user mode in seconds
2719 <option>pid_time</option>
2721 <option>pid</option>
2723 <listitem>Sum of $pid_time_kernelmode and $pid_time_usermode
2729 <option>pid_uid</option>
2731 <option>pid</option>
2733 <listitem>The real uid of the process
2739 <option>pid_euid</option>
2741 <option>pid</option>
2743 <listitem>The effective uid of the process
2749 <option>pid_suid</option>
2751 <option>pid</option>
2753 <listitem>The saved set uid of the process
2759 <option>pid_fsuid</option>
2761 <option>pid</option>
2763 <listitem>The file system uid of the process
2769 <option>pid_gid</option>
2771 <option>pid</option>
2773 <listitem>The real gid of the process
2779 <option>pid_egid</option>
2781 <option>pid</option>
2783 <listitem>The effective gid of the process
2789 <option>pid_sgid</option>
2791 <option>pid</option>
2793 <listitem>The saved set gid of the process
2799 <option>pid_fsgid</option>
2801 <option>pid</option>
2803 <listitem>The file system gid of the process
2809 <option>pid_vmpeak</option>
2811 <option>pid</option>
2813 <listitem>Peak virtual memory size of the process
2819 <option>pid_vmsize</option>
2821 <option>pid</option>
2823 <listitem>Virtual memory size of the process
2829 <option>pid_vmlck</option>
2831 <option>pid</option>
2833 <listitem>Locked memory size of the process
2839 <option>pid_vmhwm</option>
2841 <option>pid</option>
2843 <listitem>Peak resident set size ("high water mark") of the process
2849 <option>pid_vmrss</option>
2851 <option>pid</option>
2853 <listitem>Resident set size of the process
2859 <option>pid_vmdata</option>
2861 <option>pid</option>
2863 <listitem>Data segment size of the process
2869 <option>pid_vmstk</option>
2871 <option>pid</option>
2873 <listitem>Stack segment size of the process
2879 <option>pid_vmexe</option>
2881 <option>pid</option>
2883 <listitem>Text segment size of the process
2889 <option>pid_vmlib</option>
2891 <option>pid</option>
2893 <listitem>Shared library code size of the process
2899 <option>pid_vmpte</option>
2901 <option>pid</option>
2903 <listitem>Page table entries size of the process
2909 <option>platform</option>
2911 <option>(dev) type n (factor offset)</option>
2913 <listitem>Platform sensor from sysfs (Linux 2.6). Parameter
2914 dev may be omitted if you have only one platform device.
2915 Platform type is either 'in' or 'vol' meaning voltage;
2916 'fan' meaning fan; 'temp' meaning temperature. Parameter n
2917 is number of the sensor. See /sys/bus/platform/devices/ on
2918 your local computer. The optional arguments 'factor' and
2919 'offset' allow precalculation of the raw input, which is
2920 being modified as follows: 'input = input * factor +
2921 offset'. Note that they have to be given as decimal values
2922 (i.e. contain at least one decimal place).
2928 <option>pop3_unseen</option>
2930 <option>(args)</option>
2932 <listitem>Displays the number of unseen messages in your
2933 global POP3 inbox by default. You can define individual
2934 POP3 inboxes seperately by passing arguments to this
2935 object. Arguments are: "host user pass [-i interval (in
2936 seconds)] [-p port] [-e 'command'] [-r retries]". Default
2937 port is 110, default interval is 5 minutes, and default
2938 number of retries before giving up is 5. If the password is
2939 supplied as '*', you will be prompted to enter the password
2946 <option>pop3_used</option>
2948 <option>(args)</option>
2950 <listitem>Displays the amount of space (in MiB, 2^20) used
2951 in your global POP3 inbox by default. You can define
2952 individual POP3 inboxes seperately by passing arguments to
2953 this object. Arguments are: "host user pass [-i interval
2954 (in seconds)] [-p port] [-e 'command'] [-r retries]". Default
2955 port is 110, default interval is 5 minutes, and default
2956 number of retries before giving up is 5. If the password is
2957 supplied as '*', you will be prompted to enter the password
2964 <option>pre_exec</option>
2966 <option>shell command</option>
2968 <listitem>Executes a shell command one time before conky
2969 displays anything and puts output as text.
2975 <option>processes</option>
2978 <listitem>Total processes (sleeping and running)
2984 <option>read_tcp</option>
2986 <option>(host) port</option>
2988 <listitem>Connects to a tcp port on a host (default is
2989 localhost), reads every char available at the moment and
2996 <option>replied_mails</option>
2998 <option>(maildir)</option>
2999 <option>(interval)</option>
3001 <listitem>Number of mails marked as replied in the
3002 specified mailbox or mail spool if not. Only maildir type
3003 mailboxes are supported, mbox type will return -1.
3009 <option>rss</option>
3011 <option>uri interval_in_minutes action (num_par
3012 (spaces_in_front))</option>
3015 <para>Download and parse RSS feeds. The interval may be
3016 a floating point value greater than 0, otherwise
3017 defaults to 15 minutes. Action may be one of the
3018 following: feed_title, item_title (with num par),
3019 item_desc (with num par) and item_titles (when using
3020 this action and spaces_in_front is given conky places
3021 that many spaces in front of each item). This object is
3022 threaded, and once a thread is created it can't be
3023 explicitely destroyed. One thread will run for each URI
3024 specified. You can use any protocol that Curl
3031 <option>running_processes</option>
3034 <listitem>Running processes (not sleeping), requires Linux
3041 <option>running_threads</option>
3044 <listitem>Number of running (runnable) threads. Linux only.
3050 <option>scroll</option>
3052 <option>length (step) text</option>
3054 <listitem>Scroll 'text' by 'step' characters showing
3055 'length' number of characters at the same time. The text
3056 may also contain variables. 'step' is optional and defaults
3057 to 1 if not set. If a var creates output on multiple lines
3058 then the lines are placed behind each other separated with
3059 a '|'-sign. If you change the textcolor inside $scroll it
3060 will automatically have it's old value back at the end of
3061 $scroll. The end and the start of text will be seperated by
3062 'length' number of spaces.
3068 <option>seen_mails</option>
3070 <option>(maildir)</option>
3071 <option>(interval)</option>
3073 <listitem>Number of mails marked as seen in the specified
3074 mailbox or mail spool if not. Only maildir type mailboxes
3075 are supported, mbox type will return -1.
3081 <option>shadecolor</option>
3083 <option>(color)</option>
3085 <listitem>Change shading color
3091 <option>smapi</option>
3093 <option>(ARGS)</option>
3095 <listitem>when using smapi, display contents of the
3096 /sys/devices/platform/smapi directory. ARGS are either
3097 '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the
3098 corresponding files' content. This is a very raw method of
3099 accessing the smapi values. When available, better use one
3100 of the smapi_* variables instead.
3106 <option>smapi_bat_bar</option>
3108 <option>(INDEX),(height),(width)</option>
3110 <listitem>when using smapi, display the remaining capacity
3111 of the battery with index INDEX as a bar.
3117 <option>smapi_bat_perc</option>
3119 <option>(INDEX)</option>
3121 <listitem>when using smapi, display the remaining capacity
3122 in percent of the battery with index INDEX. This is a
3123 separate variable because it supports the 'use_spacer'
3124 configuration option.
3130 <option>smapi_bat_power</option>
3132 <option>INDEX</option>
3134 <listitem>when using smapi, display the current power of
3135 the battery with index INDEX in watt. This is a separate
3136 variable because the original read out value is being
3137 converted from mW. The sign of the output reflects charging
3138 (positive) or discharging (negative) state.
3144 <option>smapi_bat_temp</option>
3146 <option>INDEX</option>
3148 <listitem>when using smapi, display the current temperature
3149 of the battery with index INDEX in degree Celsius. This is
3150 a separate variable because the original read out value is
3151 being converted from milli degree Celsius.
3157 <option>sony_fanspeed</option>
3160 <listitem>Displays the Sony VAIO fanspeed information if
3161 sony-laptop kernel support is enabled. Linux only.
3167 <option>stippled_hr</option>
3169 <option>(space)</option>
3171 <listitem>Stippled (dashed) horizontal line
3177 <option>swap</option>
3180 <listitem>Amount of swap in use
3186 <option>swapbar</option>
3188 <option>(height),(width)</option>
3190 <listitem>Bar that shows amount of swap in use
3196 <option>swapfree</option>
3199 <listitem>Amount of free swap
3205 <option>swapmax</option>
3208 <listitem>Total amount of swap
3214 <option>swapperc</option>
3217 <listitem>Percentage of swap in use
3223 <option>sysname</option>
3226 <listitem>System name, Linux for example
3232 <option>tab</option>
3234 <option>(width, (start))</option>
3236 <listitem>Puts a tab of the specified width, starting from
3237 column 'start'. The unit is pixels for both arguments.
3243 <option>tail</option>
3245 <option>logfile lines (next_check)</option>
3247 <listitem>Displays last N lines of supplied text file. The
3248 file is checked every 'next_check' update. If next_check is
3249 not supplied, Conky defaults to 2. Max of 30 lines can be
3250 displayed, or until the text buffer is filled.
3256 <option>tcp_portmon</option>
3258 <option>port_begin port_end item (index)</option>
3261 <para>TCP port (both IPv6 and IPv4) monitor for
3262 specified local ports. Port numbers must be in
3263 the range 1 to 65535. Valid items are:</para>
3266 <command>count</command>
3267 <option>Total number of connections in the
3271 <command>rip</command>
3272 <option>Remote ip address</option>
3275 <command>rhost</command>
3276 <option>Remote host name</option>
3279 <command>rport</command>
3280 <option>Remote port number</option>
3283 <command>rservice</command>
3284 <option>Remote service name from
3285 /etc/services</option>
3288 <command>lip</command>
3289 <option>Local ip address</option>
3292 <command>lhost</command>
3293 <option>Local host name</option>
3296 <command>lport</command>
3297 <option>Local port number</option>
3300 <command>lservice</command>
3301 <option>Local service name from
3302 /etc/services</option>
3305 <para>The connection index provides you with access to
3306 each connection in the port monitor. The monitor will
3307 return information for index values from 0 to n-1
3308 connections. Values higher than n-1 are simply ignored.
3309 For the "count" item, the connection index must be
3310 omitted. It is required for all other items.</para>
3311 <para>Examples:</para>
3314 <command>${tcp_portmon 6881 6999
3316 <option>Displays the number of connections in
3317 the bittorrent port range</option>
3320 <command>${tcp_portmon 22 22 rip 0}</command>
3321 <option>Displays the remote host ip of the
3322 first sshd connection</option>
3325 <command>${tcp_portmon 22 22 rip 9}</command>
3326 <option>Displays the remote host ip of the
3327 tenth sshd connection</option>
3330 <command>${tcp_portmon 1 1024 rhost
3332 <option>Displays the remote host name of the
3333 first connection on a privileged port</option>
3336 <command>${tcp_portmon 1 1024 rport
3338 <option>Displays the remote host port of the
3339 fifth connection on a privileged port</option>
3342 <command>${tcp_portmon 1 65535 lservice
3344 <option>Displays the local service name of the
3345 fifteenth connection in the range of all
3349 <para>Note that port monitor variables which share the
3350 same port range actually refer to the same monitor, so
3351 many references to a single port range for different
3352 items and different indexes all use the same monitor
3353 internally. In other words, the program avoids creating
3354 redundant monitors.</para>
3360 <option>templateN</option>
3362 <option>(arg1)</option>
3363 <option>(arg2)</option>
3364 <option>(arg3 ...)</option>
3367 <para>Evaluate the content of the templateN
3368 configuration variable (where N is a value between 0
3369 and 9, inclusively), applying substitutions as
3370 described in the documentation of the corresponding
3371 configuration variable. The number of arguments is
3372 optional, but must match the highest referred index in
3373 the template. You can use the same special sequences in
3374 each argument as the ones valid for a template
3375 definition, e.g. to allow an argument to contain a
3376 whitespace. Also simple nesting of templates is
3377 possible this way.</para>
3378 <para>Here are some examples of template
3381 <member>template0 $\1\2</member>
3382 <member>template1 \1: ${fs_used \2} / ${fs_size
3384 <member>template2 \1 \2</member>
3386 <para>The following list shows sample usage of the
3387 templates defined above, with the equivalent syntax
3388 when not using any template at all:</para>
3393 <entry>using template</entry>
3394 <entry>same without template</entry>
3399 <entry>${template0 node name}</entry>
3400 <entry>$nodename</entry>
3403 <entry>${template1 root /}</entry>
3404 <entry>root: ${fs_free /} / ${fs_size
3409 <programlisting>${template1
3410 ${template2\ disk\ root}
3414 <programlisting>disk root:
3415 ${fs_free /} / ${fs_size
3427 <option>texeci</option>
3429 <option>interval command</option>
3431 <listitem>Runs a command at an interval inside a thread and
3432 displays the output. Same as $execi, except the command is
3433 run inside a thread. Use this if you have a slow script to
3434 keep Conky updating. You should make the interval slightly
3435 longer then the time it takes your script to execute. For
3436 example, if you have a script that take 5 seconds to
3437 execute, you should make the interval at least 6 seconds.
3438 See also $execi. This object will clean up the thread when
3439 it is destroyed, so it can safely be used in a nested
3440 fashion, though it may not produce the desired behaviour if
3447 <option>threads</option>
3450 <listitem>Total threads
3456 <option>time</option>
3458 <option>(format)</option>
3460 <listitem>Local time, see man strftime to get more
3461 information about format
3467 <option>to_bytes</option>
3469 <option>size</option>
3471 <listitem>If 'size' is a number followed by a size-unit
3472 (kilobyte,mb,GiB,...) then it converts the size to bytes
3473 and shows it without unit, otherwise it just shows 'size'.
3479 <option>top</option>
3481 <option>type num</option>
3483 <listitem>This takes arguments in the form:top (name)
3484 (number) Basically, processes are ranked from highest to
3485 lowest in terms of cpu usage, which is what (num)
3486 represents. The types are: "name", "pid", "cpu", "mem",
3487 "mem_res", "mem_vsize", "time", "io_perc", "io_read" and
3488 "io_write". There can be a max of 10 processes listed.
3494 <option>top_io</option>
3496 <option>type num</option>
3498 <listitem>Same as top, except sorted by the amount of I/O
3499 the process has done during the update interval
3505 <option>top_mem</option>
3507 <option>type num</option>
3509 <listitem>Same as top, except sorted by mem usage instead
3516 <option>top_time</option>
3518 <option>type num</option>
3520 <listitem>Same as top, except sorted by total CPU time
3521 instead of current CPU usage
3527 <option>totaldown</option>
3529 <option>(net)</option>
3531 <listitem>Total download, overflows at 4 GB on Linux with
3532 32-bit arch and there doesn't seem to be a way to know how
3533 many times it has already done that before conky has
3540 <option>totalup</option>
3542 <option>(net)</option>
3544 <listitem>Total upload, this one too, may overflow
3550 <option>trashed_mails</option>
3552 <option>(maildir)</option>
3553 <option>(interval)</option>
3555 <listitem>Number of mails marked as trashed in the
3556 specified mailbox or mail spool if not. Only maildir type
3557 mailboxes are supported, mbox type will return -1.
3563 <option>tztime</option>
3565 <option>(timezone (format))</option>
3567 <listitem>Local time for specified timezone, see man
3568 strftime to get more information about format. The timezone
3569 argument is specified in similar fashion as TZ environment
3570 variable. For hints, look in /usr/share/zoneinfo. e.g.
3571 US/Pacific, Europe/Zurich, etc.
3577 <option>gid_name</option>
3579 <option>gid</option>
3581 <listitem>Name of group with this gid
3587 <option>uid_name</option>
3589 <option>uid</option>
3591 <listitem>Username of user with this uid
3597 <option>unflagged_mails</option>
3599 <option>(maildir)</option>
3600 <option>(interval)</option>
3602 <listitem>Number of mails not marked as flagged in the
3603 specified mailbox or mail spool if not. Only maildir type
3604 mailboxes are supported, mbox type will return -1.
3610 <option>unforwarded_mails</option>
3612 <option>(maildir)</option>
3613 <option>(interval)</option>
3615 <listitem>Number of mails not marked as forwarded in the
3616 specified mailbox or mail spool if not. Only maildir type
3617 mailboxes are supported, mbox type will return -1.
3623 <option>unreplied_mails</option>
3625 <option>(maildir)</option>
3626 <option>(interval)</option>
3628 <listitem>Number of mails not marked as replied in the
3629 specified mailbox or mail spool if not. Only maildir type
3630 mailboxes are supported, mbox type will return -1.
3636 <option>unseen_mails</option>
3638 <option>(maildir)</option>
3639 <option>(interval)</option>
3641 <listitem>Number of new or unseen mails in the specified
3642 mailbox or mail spool if not. Only maildir type mailboxes
3643 are supported, mbox type will return -1.
3649 <option>updates</option>
3651 <option>Number of updates</option>
3653 <listitem>for debugging
3659 <option>upspeed</option>
3661 <option>(net)</option>
3663 <listitem>Upload speed in suitable IEC units
3669 <option>upspeedf</option>
3671 <option>(net)</option>
3673 <listitem>Upload speed in KiB with one decimal
3679 <option>upspeedgraph</option>
3681 <option>(netdev) (height),(width) (gradient colour 1)
3682 (gradient colour 2) (scale) (-t) (-l)</option>
3684 <listitem>Upload speed graph, colours defined in hex, minus
3685 the #. If scale is non-zero, it becomes the scale for the
3686 graph. Uses a logarithmic scale (to see small numbers) when
3687 you use the -l switch. Takes the switch '-t' to use a
3688 temperature gradient, which makes the gradient values
3689 change depending on the amplitude of a particular graph
3690 value (try it and see).
3696 <option>uptime</option>
3705 <option>uptime_short</option>
3708 <listitem>Uptime in a shorter format
3714 <option>user_names</option>
3717 <listitem>Lists the names of the users logged in
3723 <option>user_number</option>
3726 <listitem>Number of users logged in
3732 <option>user_terms</option>
3735 <listitem>Lists the consoles in use
3741 <option>user_times</option>
3744 <listitem>Lists how long users have been logged in for
3750 <option>user_time</option>
3752 <option>console</option>
3754 <listitem>Lists how long the user for the given console has been
3761 <option>utime</option>
3763 <option>(format)</option>
3765 <listitem>Display time in UTC (universal coordinate time).
3771 <option>voffset</option>
3773 <option>(pixels)</option>
3775 <listitem>Change vertical offset by N pixels. Negative
3776 values will cause text to overlap. See also $offset.
3782 <option>voltage_mv</option>
3784 <option>(n)</option>
3786 <listitem>Returns CPU #n's voltage in mV. CPUs are counted
3787 from 1. If omitted, the parameter defaults to 1.
3793 <option>voltage_v</option>
3795 <option>(n)</option>
3797 <listitem>Returns CPU #n's voltage in V. CPUs are counted
3798 from 1. If omitted, the parameter defaults to 1.
3804 <option>weather</option>
3806 <option>URI locID data_type
3807 (interval_in_minutes)</option>
3810 <para>Download, parse and display METAR data.</para>
3811 <para>For the 'URI', there are two
3812 possibilities:</para>
3815 http://weather.noaa.gov/pub/data/observations/metar/stations/</member>
3817 http://xoap.weather.com/weather/local/</member>
3819 <para>The first one is free to use but the second
3820 requires you to register and obtain your partner ID and
3821 license key. These two must be written, separated by a
3822 space, into a file called .xoaprc which needs to be
3823 placed into your home directory.</para>
3824 <para>'locID' must be a valid location identifier for
3825 the required uri. For the NOAA site this must be a
3826 valid ICAO (see for instance
3827 https://pilotweb.nas.faa.gov/qryhtml/icao/). For the
3828 weather.com site this must be a valid location ID (see
3830 http://aspnetresources.com/tools/locid.aspx).</para>
3831 <para>'data_type' must be one of the following:</para>
3834 <command>last_update</command>
3835 <para>The date and time stamp of the data.
3836 The result depends on the URI used. For the
3837 NOAA site it is date (yyyy/mm/dd) and UTC time.
3838 For the weather.com one it is date
3839 ([m]m/[d]d/yy) and Local Time of the
3843 <command>temperature</command>
3844 <para>Air temperature (you can use the
3845 'temperature_unit' config setting to change
3849 <command>cloud_cover</command>
3850 <para>The highest cloud cover status</para>
3853 <command>pressure</command>
3854 <para>Air pressure in millibar</para>
3857 <command>wind_speed</command>
3858 <para>Wind speed in km/h</para>
3861 <command>wind_dir</command>
3862 <para>Wind direction</para>
3865 <command>wind_dir_DEG</command>
3866 <para>Compass wind direction</para>
3869 <command>humidity</command>
3870 <para>Relative humidity in %</para>
3873 <command>weather</command>
3874 <para>Any relevant weather event (rain, snow,
3875 etc.). This is not used if you are querying the
3876 weather.com site since this data is aggregated
3877 into the cloud_cover one</para>
3880 <command>icon</command>
3881 <para>Weather icon (only for
3882 www.weather.com). Can be used together with the
3883 icon kit provided upon registering to their
3887 <para>'delay_in_minutes' (optional, default 30) cannot
3888 be less than 30 minutes.</para>
3889 <para>This object is threaded, and once a thread is
3890 created it can't be explicitely destroyed. One thread
3891 will run for each URI specified.</para>
3892 <para>Note that these variables are still EXPERIMENTAL
3893 and can be subject to many future changes.</para>
3899 <option>weather_forecast</option>
3901 <option>URI locID day data_type
3902 (interval_in_minutes)</option>
3905 <para>Download, parse and display weather forecast data
3906 for a given day (daytime only).</para>
3907 <para>For the 'URI', for the time being only
3908 http://xoap.weather.com/weather/local/ is
3909 supported. See 'weather' above for details of usage</para>
3910 <para>'locID', see 'weather' above.</para>
3911 <para>'day' is a number from 0 (today) to 4 (3 days
3912 after tomorrow).</para>
3913 <para>'data_type' must be one of the following:</para>
3916 <command>day</command>
3917 <option>Day of the week</option>
3920 <command>date</command>
3921 <option>Date, in the form MMM DD (ie. Jul 14)</option>
3924 <command>low</command>
3925 <option>Minimun temperature (you can use the
3926 'temperature_unit' config setting to change
3930 <command>hi</command>
3931 <option>Maximum temperature (you can use the
3932 'temperature_unit' config setting to change
3936 <command>icon</command>
3937 <option>Weather icon. Can be used together with the
3938 icon kit provided upon registering to the weather.com
3942 <command>forecast</command>
3943 <option>Weather forecast (sunny, rainy, etc.)</option>
3946 <command>wind_speed</command>
3947 <option>Wind speed in km/h</option>
3950 <command>wind_dir</command>
3951 <option>Wind direction</option>
3954 <command>wind_dir_DEG</command>
3955 <option>Compass wind direction</option>
3958 <command>humidity</command>
3959 <option>Relative humidity in %</option>
3962 <command>precipitation</command>
3963 <option>Probability of having a
3964 precipitation (in %)</option>
3967 <para>'delay_in_minutes' (optional, default 210) cannot
3968 be lower than 210 min.</para>
3969 <para>This object is threaded, and once a thread is
3970 created it can't be explicitely destroyed. One thread
3971 will run for each URI specified. You can use any
3972 protocol that Curl supports.</para>
3973 <para>Note that these variables are still EXPERIMENTAL
3974 and can be subject to many future changes.</para>
3980 <option>wireless_ap</option>
3982 <option>(net)</option>
3984 <listitem>Wireless access point MAC address (Linux only)
3990 <option>wireless_bitrate</option>
3992 <option>(net)</option>
3994 <listitem>Wireless bitrate (ie 11 Mb/s) (Linux only)
4000 <option>wireless_essid</option>
4002 <option>(net)</option>
4004 <listitem>Wireless access point ESSID (Linux only)
4010 <option>wireless_link_bar</option>
4012 <option>(height),(width) (net)</option>
4014 <listitem>Wireless link quality bar (Linux only)
4020 <option>wireless_link_qual</option>
4022 <option>(net)</option>
4024 <listitem>Wireless link quality (Linux only)
4030 <option>wireless_link_qual_max</option>
4032 <option>(net)</option>
4034 <listitem>Wireless link quality maximum value (Linux only)
4040 <option>wireless_link_qual_perc</option>
4042 <option>(net)</option>
4044 <listitem>Wireless link quality in percents (Linux only)
4050 <option>wireless_mode</option>
4052 <option>(net)</option>
4054 <listitem>Wireless mode (Managed/Ad-Hoc/Master) (Linux
4061 <option>words</option>
4063 <option>textfile</option>
4065 <listitem>Displays the number of words in the given file
4071 <option>xmms2_album</option>
4074 <listitem>Album in current XMMS2 song
4080 <option>xmms2_artist</option>
4083 <listitem>Artist in current XMMS2 song
4089 <option>xmms2_bar</option>
4091 <option>(height),(width)</option>
4093 <listitem>Bar of XMMS2's progress
4099 <option>xmms2_bitrate</option>
4102 <listitem>Bitrate of current song
4108 <option>xmms2_comment</option>
4111 <listitem>Comment in current XMMS2 song
4117 <option>xmms2_date</option>
4120 <listitem>Returns song's date.
4126 <option>xmms2_duration</option>
4129 <listitem>Duration of current song
4135 <option>xmms2_elapsed</option>
4138 <listitem>Song's elapsed time
4144 <option>xmms2_genre</option>
4147 <listitem>Genre in current XMMS2 song
4153 <option>xmms2_id</option>
4156 <listitem>XMMS2 id of current song
4162 <option>xmms2_percent</option>
4165 <listitem>Percent of song's progress
4171 <option>xmms2_playlist</option>
4174 <listitem>Returns the XMMS2 playlist.
4180 <option>xmms2_size</option>
4183 <listitem>Size of current song
4189 <option>xmms2_smart</option>
4192 <listitem>Prints the song name in either the form "artist -
4193 title" or file name, depending on whats available
4199 <option>xmms2_status</option>
4202 <listitem>XMMS2 status (Playing, Paused, Stopped, or
4209 <option>xmms2_timesplayed</option>
4212 <listitem>Number of times a song was played (presumably).
4218 <option>xmms2_title</option>
4221 <listitem>Title in current XMMS2 song
4227 <option>xmms2_tracknr</option>
4230 <listitem>Track number in current XMMS2 song
4236 <option>xmms2_url</option>
4239 <listitem>Full path to current song
projects / monky / blob