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>forwarded_mails</option>
1114 <option>(maildir)</option>
1115 <option>(interval)</option>
1117 <listitem>Number of mails marked as forwarded in the
1118 specified mailbox or mail spool if not. Only maildir type
1119 mailboxes are supported, mbox type will return -1.
1125 <option>freq</option>
1127 <option>(n)</option>
1129 <listitem>Returns CPU #n's frequency in MHz. CPUs are
1130 counted from 1. If omitted, the parameter defaults to 1.
1136 <option>freq_g</option>
1138 <option>(n)</option>
1140 <listitem>Returns CPU #n's frequency in GHz. CPUs are
1141 counted from 1. If omitted, the parameter defaults to 1.
1147 <option>fs_bar</option>
1149 <option>(height),(width) fs</option>
1151 <listitem>Bar that shows how much space is used on a file
1152 system. height is the height in pixels. fs is any file on
1159 <option>fs_bar_free</option>
1161 <option>(height),(width) fs</option>
1163 <listitem>Bar that shows how much space is free on a file
1164 system. height is the height in pixels. fs is any file on
1171 <option>fs_free</option>
1173 <option>(fs)</option>
1175 <listitem>Free space on a file system available for users.
1181 <option>fs_free_perc</option>
1183 <option>(fs)</option>
1185 <listitem>Free percentage of space on a file system
1186 available for users.
1192 <option>fs_size</option>
1194 <option>(fs)</option>
1196 <listitem>File system size.
1202 <option>fs_type</option>
1204 <option>(fs)</option>
1206 <listitem>File system type.
1212 <option>fs_used</option>
1214 <option>(fs)</option>
1216 <listitem>File system used space.
1222 <option>fs_used_perc</option>
1224 <option>(fs)</option>
1226 <listitem>Percent of file system used space.
1232 <option>goto</option>
1236 <listitem>The next element will be printed at position 'x'.
1243 <option>gw_iface</option>
1246 <listitem>Displays the default route's interface or
1247 "multiple"/"none" accordingly.
1253 <option>gw_ip</option>
1256 <listitem>Displays the default gateway's IP or
1257 "multiple"/"none" accordingly.
1263 <option>hddtemp</option>
1265 <option>(dev)</option>
1267 <listitem>Displays temperature of a selected hard disk
1268 drive as reported by the hddtemp daemon. Use hddtemp_host
1269 and hddtemp_port to specify a host and port for all hddtemp
1270 objects. If no dev parameter is given, the first disk returned
1271 by the hddtemp daemon is used.
1277 <option>head</option>
1279 <option>logfile lines (next_check)</option>
1281 <listitem>Displays first N lines of supplied text file. The
1282 file is checked every 'next_check' update. If next_check is
1283 not supplied, Conky defaults to 2. Max of 30 lines can be
1284 displayed, or until the text buffer is filled.
1292 <option>(height)</option>
1294 <listitem>Horizontal line, height is the height in pixels
1300 <option>hwmon</option>
1302 <option>(dev) type n (factor offset)</option>
1304 <listitem>Hwmon sensor from sysfs (Linux 2.6). Parameter
1305 dev may be omitted if you have only one hwmon device.
1306 Parameter type is either 'in' or 'vol' meaning voltage;
1307 'fan' meaning fan; 'temp' meaning temperature. Parameter n
1308 is number of the sensor. See /sys/class/hwmon/ on your
1309 local computer. The optional arguments 'factor' and
1310 'offset' allow precalculation of the raw input, which is
1311 being modified as follows: 'input = input * factor +
1312 offset'. Note that they have to be given as decimal values
1313 (i.e. contain at least one decimal place).
1319 <option>i2c</option>
1321 <option>(dev) type n (factor offset)</option>
1323 <listitem>I2C sensor from sysfs (Linux 2.6). Parameter dev
1324 may be omitted if you have only one I2C device. Parameter
1325 type is either 'in' or 'vol' meaning voltage; 'fan' meaning
1326 fan; 'temp' meaning temperature. Parameter n is number of
1327 the sensor. See /sys/bus/i2c/devices/ on your local
1328 computer. The optional arguments 'factor' and 'offset'
1329 allow precalculation of the raw input, which is being
1330 modified as follows: 'input = input * factor + offset'.
1331 Note that they have to be given as decimal values (i.e.
1332 contain at least one decimal place).
1338 <option>i8k_ac_status</option>
1342 <listitem>If running the i8k kernel driver for Inspiron
1343 laptops, displays whether ac power is on, as listed in
1344 /proc/i8k (translated to human-readable). Beware that this
1345 is by default not enabled by i8k itself.
1351 <option>i8k_bios</option>
1355 <listitem>If running the i8k kernel driver for Inspiron
1356 laptops, displays the bios version as listed in /proc/i8k.
1362 <option>i8k_buttons_status</option>
1366 <listitem>If running the i8k kernel driver for Inspiron
1367 laptops, displays the volume buttons status as listed in
1374 <option>i8k_cpu_temp</option>
1378 <listitem>If running the i8k kernel driver for Inspiron
1379 laptops, displays the cpu temperature in Celsius, as
1380 reported by /proc/i8k.
1386 <option>i8k_left_fan_rpm</option>
1390 <listitem>If running the i8k kernel driver for Inspiron
1391 laptops, displays the left fan's rate of rotation, in
1392 revolutions per minute as listed in /proc/i8k. Beware, some
1393 laptops i8k reports these fans in reverse order.
1399 <option>i8k_left_fan_status</option>
1403 <listitem>If running the i8k kernel driver for Inspiron
1404 laptops, displays the left fan status as listed in
1405 /proc/i8k (translated to human-readable). Beware, some
1406 laptops i8k reports these fans in reverse order.
1412 <option>i8k_right_fan_rpm</option>
1416 <listitem>If running the i8k kernel driver for Inspiron
1417 laptops, displays the right fan's rate of rotation, in
1418 revolutions per minute as listed in /proc/i8k. Beware, some
1419 laptops i8k reports these fans in reverse order.
1425 <option>i8k_right_fan_status</option>
1429 <listitem>If running the i8k kernel driver for Inspiron
1430 laptops, displays the right fan status as listed in
1431 /proc/i8k (translated to human-readable). Beware, some
1432 laptops i8k reports these fans in reverse order.
1438 <option>i8k_serial</option>
1442 <listitem>If running the i8k kernel driver for Inspiron
1443 laptops, displays your laptop serial number as listed in
1450 <option>i8k_version</option>
1454 <listitem>If running the i8k kernel driver for Inspiron
1455 laptops, displays the version formatting of /proc/i8k.
1461 <option>ibm_brightness</option>
1464 <listitem>If running the IBM ACPI, displays the brigtness
1465 of the laptops's LCD (0-7).
1471 <option>ibm_fan</option>
1474 <listitem>If running the IBM ACPI, displays the fan speed.
1480 <option>ibm_temps</option>
1484 <listitem>If running the IBM ACPI, displays the
1485 temperatures from the IBM temperature sensors (N=0..7)
1486 Sensor 0 is on the CPU, 3 is on the GPU.
1492 <option>ibm_volume</option>
1495 <listitem>If running the IBM ACPI, displays the "master"
1496 volume, controlled by the volume keys (0-14).
1502 <option>iconv_start</option>
1504 <option>codeset_from codeset_to</option>
1506 <listitem>Convert text from one codeset to another using
1507 GNU iconv. Needs to be stopped with iconv_stop.
1513 <option>iconv_stop</option>
1517 <listitem>Stop iconv codeset conversion.
1523 <option>if_empty</option>
1525 <option>(var)</option>
1527 <listitem>if conky variable VAR is empty, display
1528 everything between $if_empty and the matching $endif
1534 <option>if_existing</option>
1536 <option>file (string)</option>
1538 <listitem>if FILE exists, display everything between
1539 if_existing and the matching $endif. The optional second
1540 paramater checks for FILE containing the specified string
1541 and prints everything between $if_existing and the matching
1548 <option>if_gw</option>
1551 <listitem>if there is at least one default gateway, display
1552 everything between $if_gw and the matching $endif
1558 <option>if_match</option>
1560 <option>expression</option>
1562 <listitem>Evaluates the given boolean expression, printing
1563 everything between $if_match and the matching $endif
1564 depending on whether the evaluation returns true or not.
1565 Valid expressions consist of a left side, an operator and a
1566 right side. Left and right sides are being parsed for
1567 contained text objects before evaluation. Recognised left
1568 and right side types are:
1571 <command>double</command>Argument consists of only
1572 digits and a single dot.</member>
1574 <command>long</command>Argument consists of only
1577 <command>string</command>Argument is enclosed in
1578 quotation mark or the checks for double and long failed
1580 </simplelist>Valid operands are: '>', '<', '>=',
1581 '<=', '==', '!='.
1587 <option>if_mixer_mute</option>
1589 <option>(mixer)</option>
1591 <listitem>If mixer exists, display everything between
1592 $if_mixer_mute and the matching $endif. If no mixer is
1593 specified, "Master" is used.
1599 <option>if_mounted</option>
1601 <option>(mountpoint)</option>
1603 <listitem>if MOUNTPOINT is mounted, display everything
1604 between $if_mounted and the matching $endif
1610 <option>if_mpd_playing</option>
1613 <listitem>if mpd is playing or paused, display everything
1614 between $if_mpd_playing and the matching $endif
1620 <option>if_running</option>
1622 <option>(process)</option>
1624 <listitem>if PROCESS is running, display everything
1625 $if_running and the matching $endif. This uses the
1626 ``pidof'' command, so the -x switch is also supported.
1632 <option>if_smapi_bat_installed</option>
1634 <option>(INDEX)</option>
1636 <listitem>when using smapi, if the battery with index INDEX
1637 is installed, display everything between
1638 $if_smapi_bat_installed and the matching $endif
1644 <option>if_up</option>
1646 <option>(interface)</option>
1648 <listitem>if INTERFACE exists and is up, display everything
1649 between $if_up and the matching $endif
1655 <option>if_updatenr</option>
1657 <option>(updatenr)</option>
1659 <listitem>If it's the UPDATENR-th time that conky updates,
1660 display everything between $if_updatenr and the matching
1661 $endif. The counter resets when the highest UPDATENR is
1662 reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr
1663 2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the
1664 time followed by bar 25% of the time followed by nothing
1665 the other half of the time.
1671 <option>if_xmms2_connected</option>
1674 <listitem>Display everything between $if_xmms2_connected
1675 and the matching $endif if xmms2 is running.
1681 <option>image</option>
1683 <option><path to image> (-p x,y) (-s WxH) (-n)
1684 (-f interval)</option>
1686 <listitem>Renders an image from the path specified using
1687 Imlib2. Takes 4 optional arguments: a position, a size, a
1688 no-cache switch, and a cache flush interval. Changing the
1689 x,y position will move the position of the image, and
1690 changing the WxH will scale the image. If you specify the
1691 no-cache flag (-n), the image will not be cached.
1692 Alternately, you can specify the -f int switch to specify a
1693 cache flust interval for a particular image. Example:
1694 ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200}
1695 will render 'cheeseburger.jpg' at (20,20) scaled to 200x200
1696 pixels. Conky does not make any attempt to adjust the
1697 position (or any other formatting) of images, they are just
1698 rendered as per the arguments passed. The only reason
1699 $image is part of the TEXT section, is to allow for runtime
1700 modifications, through $execp $lua_parse, or some other
1707 <option>imap_messages</option>
1709 <option>(args)</option>
1711 <listitem>Displays the number of messages in your global
1712 IMAP inbox by default. You can define individual IMAP
1713 inboxes seperately by passing arguments to this object.
1714 Arguments are: "host user pass [-i interval (in seconds)]
1715 [-f 'folder'] [-p port] [-e 'command'] [-r retries]". Default
1716 port is 143, default folder is 'INBOX', default interval is
1717 5 minutes, and default number of retries before giving up
1718 is 5. If the password is supplied as '*', you will be
1719 prompted to enter the password when Conky starts.
1725 <option>imap_unseen</option>
1727 <option>(args)</option>
1729 <listitem>Displays the number of unseen messages in your
1730 global IMAP inbox by default. You can define individual
1731 IMAP inboxes seperately by passing arguments to this
1732 object. Arguments are: "host user pass [-i interval (in
1733 seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r retries]".
1734 Default port is 143, default folder is 'INBOX', default
1735 interval is 5 minutes, and default number of retries before
1736 giving up is 5. If the password is supplied as '*', you
1737 will be prompted to enter the password when Conky starts.
1743 <option>include</option>
1745 <option>path</option>
1748 <para>Loads the configfile at path, places the
1749 configsettings behind the configsettings in the orginal
1750 config and places the vars where the includevar
1757 <option>ioscheduler</option>
1759 <option>disk</option>
1761 <listitem>Prints the current ioscheduler used for the given
1762 disk name (i.e. e.g. "hda" or "sdb")
1768 <option>kernel</option>
1771 <listitem>Kernel version
1777 <option>laptop_mode</option>
1780 <listitem>The value of /proc/sys/vm/laptop_mode
1786 <option>lines</option>
1788 <option>textfile</option>
1790 <listitem>Displays the number of lines in the given file
1796 <option>loadavg</option>
1798 <option>(1|2|3)</option>
1800 <listitem>System load average, 1 is for past 1 minute, 2
1801 for past 5 minutes and 3 for past 15 minutes. Without argument, prints
1802 all three values separated by whitespace.
1808 <option>loadgraph</option>
1810 <option>(height),(width) (gradient colour 1)
1811 (gradient colour 2) (scale) (-t) (-l)</option>
1813 <listitem>Load1 average graph, similar to xload, with
1814 optional colours in hex, minus the #. Uses a logarithmic
1815 scale (to see small numbers) when you use the -l switch.
1816 Takes the switch '-t' to use a temperature gradient, which
1817 makes the gradient values change depending on the amplitude
1818 of a particular graph value (try it and see).
1824 <option>lua</option>
1826 <option>function_name (function parameters)</option>
1828 <listitem>Executes a Lua function with given parameters,
1829 then prints the returned string. See also 'lua_load' on how
1830 to load scripts. Conky puts 'conky_' in front of
1831 function_name to prevent accidental calls to the wrong
1832 function unless you put you place 'conky_' in front of it
1839 <option>lua_bar</option>
1841 <option>(height, width) function_name (function
1842 parameters)</option>
1844 <listitem>Executes a Lua function with given parameters and
1845 draws a bar. Expects result value to be an integer between
1846 0 and 100. See also 'lua_load' on how to load scripts.
1847 Conky puts 'conky_' in front of function_name to prevent
1848 accidental calls to the wrong function unless you put you
1849 place 'conky_' in front of it yourself.
1855 <option>lua_gauge</option>
1857 <option>(height, width) function_name (function
1858 parameters)</option>
1860 <listitem>Executes a Lua function with given parameters and
1861 draws a gauge. Expects result value to be an integer
1862 between 0 and 100. See also 'lua_load' on how to load
1863 scripts. Conky puts 'conky_' in front of function_name to
1864 prevent accidental calls to the wrong function unless you
1865 put you place 'conky_' in front of it yourself.
1871 <option>lua_graph</option>
1873 <option>function_name (height),(width) (gradient colour
1874 1) (gradient colour 2) (scale) (-t) (-l)</option>
1876 <listitem>Executes a Lua function with and draws a graph.
1877 Expects result value to be any number, and by default will
1878 scale to show the full range. See also 'lua_load' on how to
1879 load scripts. Takes the switch '-t' to use a temperature
1880 gradient, which makes the gradient values change depending
1881 on the amplitude of a particular graph value (try it and
1882 see). 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_parse</option>
1892 <option>function_name (function parameters)</option>
1894 <listitem>Executes a Lua function with given parameters as
1895 per $lua, then parses and prints the result value as per
1896 the syntax for Conky's TEXT section. See also 'lua_load' on
1897 how to load scripts. Conky puts 'conky_' in front of
1898 function_name to prevent accidental calls to the wrong
1899 function unless you put you place 'conky_' in front of it
1906 <option>machine</option>
1909 <listitem>Machine, i686 for example
1915 <option>mails</option>
1917 <option>(mailbox)</option>
1918 <option>(interval)</option>
1920 <listitem>Mail count in the specified mailbox or your mail
1921 spool if not. Both mbox and maildir type mailboxes are
1922 supported. You can use a program like fetchmail to get
1923 mails from some server using your favourite protocol. See
1930 <option>mboxscan</option>
1932 <option>(-n number of messages to print) (-fw from
1933 width) (-sw subject width) mbox</option>
1935 <listitem>Print a summary of recent messages in an mbox
1936 format mailbox. mbox parameter is the filename of the
1937 mailbox (can be encapsulated using '"', ie. ${mboxscan -n
1938 10 "/home/brenden/some box"}
1944 <option>mem</option>
1947 <listitem>Amount of memory in use
1953 <option>membar</option>
1955 <option>(height),(width)</option>
1957 <listitem>Bar that shows amount of memory in use
1963 <option>memeasyfree</option>
1966 <listitem>Amount of free memory including the memory that
1967 is very easily freed (buffers/cache)
1973 <option>memfree</option>
1976 <listitem>Amount of free memory
1982 <option>memgauge</option>
1984 <option>(height),(width)</option>
1986 <listitem>Gauge that shows amount of memory in use (see
1993 <option>memgraph</option>
1995 <option>(height),(width) (gradient colour 1) (gradient
1996 colour 2) (scale) (-t) (-l)</option>
1998 <listitem>Memory usage graph. Uses a logarithmic scale (to
1999 see small numbers) when you use the -l switch. Takes the
2000 switch '-t' to use a temperature gradient, which makes the
2001 gradient values change depending on the amplitude of a
2002 particular graph value (try it and see).
2008 <option>memmax</option>
2011 <listitem>Total amount of memory
2017 <option>memperc</option>
2020 <listitem>Percentage of memory in use
2026 <option>mixer</option>
2028 <option>(device)</option>
2030 <listitem>Prints the mixer value as reported by the OS.
2031 Default mixer is "vol", but you can specify one of the
2032 following optional arguments: "vol", "bass", "treble",
2033 "synth", "pcm", "speaker", "line", "mic", "cd", "mix",
2034 "pcm2", "rec", "igain", "ogain", "line1", "line2", "line3",
2035 "dig1", "dig2", "dig3", "phin", "phout", "video", "radio",
2036 "monitor". Refer to the definition of SOUND_DEVICE_NAMES in
2037 <linux/soundcard.h> (on Linux), <soundcard.h>
2038 (on OpenBSD), or <sys/soundcard.h> to find the exact
2039 options available on your system.
2045 <option>mixerbar</option>
2047 <option>(device)</option>
2049 <listitem>Displays mixer value in a bar as reported by the
2050 OS. See docs for $mixer for details on arguments.
2056 <option>mixerl</option>
2058 <option>(device)</option>
2060 <listitem>Prints the left channel mixer value as reported
2061 by the OS. See docs for $mixer for details on arguments.
2067 <option>mixerlbar</option>
2069 <option>(device)</option>
2071 <listitem>Displays the left channel mixer value in a bar as
2072 reported by the OS. See docs for $mixer for details on
2079 <option>mixerr</option>
2081 <option>(device)</option>
2083 <listitem>Prints the right channel mixer value as reported
2084 by the OS. See docs for $mixer for details on arguments.
2090 <option>mixerrbar</option>
2092 <option>(device)</option>
2094 <listitem>Displays the right channel mixer value in a bar
2095 as reported by the OS. See docs for $mixer for details on
2102 <option>moc_album</option>
2105 <listitem>Album of the current MOC song
2111 <option>moc_artist</option>
2114 <listitem>Artist of the current MOC song
2120 <option>moc_bitrate</option>
2123 <listitem>Bitrate in the current MOC song
2129 <option>moc_curtime</option>
2132 <listitem>Current time of the current MOC song
2138 <option>moc_file</option>
2141 <listitem>File name of the current MOC song
2147 <option>moc_rate</option>
2150 <listitem>Rate of the current MOC song
2156 <option>moc_song</option>
2159 <listitem>The current song name being played in MOC.
2165 <option>moc_state</option>
2168 <listitem>Current state of MOC; playing, stopped etc.
2174 <option>moc_timeleft</option>
2177 <listitem>Time left in the current MOC song
2183 <option>moc_title</option>
2186 <listitem>Title of the current MOC song
2192 <option>moc_totaltime</option>
2195 <listitem>Total length of the current MOC song
2201 <option>monitor</option>
2204 <listitem>Number of the monitor on which conky is running
2205 or the message "Not running in X" if this is the case.
2211 <option>monitor_number</option>
2214 <listitem>Number of monitors or the message "Not running in
2215 X" if this is the case.
2221 <option>mpd_album</option>
2224 <listitem>Album in current MPD song
2230 <option>mpd_artist</option>
2233 <listitem>Artist in current MPD song must be enabled at
2240 <option>mpd_bar</option>
2242 <option>(height),(width)</option>
2244 <listitem>Bar of mpd's progress
2250 <option>mpd_bitrate</option>
2253 <listitem>Bitrate of current song
2259 <option>mpd_elapsed</option>
2262 <listitem>Song's elapsed time
2268 <option>mpd_file</option>
2271 <listitem>Prints the file name of the current MPD song
2277 <option>mpd_length</option>
2280 <listitem>Song's length
2286 <option>mpd_name</option>
2289 <listitem>Prints the MPD name field
2295 <option>mpd_percent</option>
2298 <listitem>Percent of song's progress
2304 <option>mpd_random</option>
2307 <listitem>Random status (On/Off)
2313 <option>mpd_repeat</option>
2316 <listitem>Repeat status (On/Off)
2322 <option>mpd_smart</option>
2324 <option>(max length)</option>
2326 <listitem>Prints the song name in either the form "artist -
2327 title" or file name, depending on whats available
2333 <option>mpd_status</option>
2336 <listitem>Playing, stopped, et cetera.
2342 <option>mpd_title</option>
2344 <option>(max length)</option>
2346 <listitem>Title of current MPD song
2352 <option>mpd_track</option>
2355 <listitem>Prints the MPD track field
2361 <option>mpd_vol</option>
2364 <listitem>MPD's volume
2370 <option>nameserver</option>
2372 <option>(index)</option>
2374 <listitem>Print a nameserver from /etc/resolv.conf. Index
2375 starts at and defaults to 0.
2381 <option>new_mails</option>
2383 <option>(mailbox)</option>
2384 <option>(interval)</option>
2386 <listitem>Unread mail count in the specified mailbox or
2387 mail spool if not. Both mbox and maildir type mailboxes are
2394 <option>nodename</option>
2403 <option>nvidia</option>
2405 <option>threshold</option>
2406 <option>temp</option>
2407 <option>ambient</option>
2408 <option>gpufreq</option>
2409 <option>memfreq</option>
2410 <option>imagequality</option>
2412 <listitem>Nvidia graficcard support for the XNVCtrl
2413 library. Each option can be shortened to the least
2414 significant part. Temperatures are printed as float, all
2415 other values as integer.
2418 <command>threshold</command>
2419 <option>The thresholdtemperature at
2420 which the gpu slows down</option>
2423 <command>temp</command>
2424 <option>Gives the gpu current
2425 temperature</option>
2428 <command>ambient</command>
2429 <option>Gives current air temperature near GPU
2433 <command>gpufreq</command>
2434 <option>Gives the current gpu frequency</option>
2437 <command>memfreq</command>
2438 <option>Gives the current mem frequency</option>
2441 <command>imagequality</command>
2442 <option>Which imagequality should be choosen by
2443 OpenGL applications</option>
2451 <option>offset</option>
2453 <option>(pixels)</option>
2455 <listitem>Move text over by N pixels. See also $voffset.
2461 <option>outlinecolor</option>
2463 <option>(color)</option>
2465 <listitem>Change outline color
2471 <option>pb_battery</option>
2473 <option>item</option>
2475 <listitem>If running on Apple powerbook/ibook, display
2476 information on battery status. The item parameter
2477 specifies, what information to display. Exactly one item
2478 must be specified. Valid items are:
2481 <command>status</command>
2482 <option>Display if battery is fully charged,
2483 charging, discharging or absent (running on
2487 <command>percent</command>
2488 <option>Display charge of battery in percent, if
2489 charging or discharging. Nothing will be displayed,
2490 if battery is fully charged or absent.</option>
2493 <command>time</command>
2494 <option>Display the time remaining until the
2495 battery will be fully charged or discharged at
2496 current rate. Nothing is displayed, if battery is
2497 absent or if it's present but fully charged and not
2498 discharging.</option>
2506 <option>pid_chroot</option>
2508 <option>pid</option>
2510 <listitem>Directory used as rootdirectory by the process
2511 (this will be "/" unless the process did a chroot syscall)
2517 <option>pid_cmdline</option>
2519 <option>pid</option>
2521 <listitem>Command line this process was invoked with
2527 <option>pid_cwd</option>
2529 <option>pid</option>
2531 <listitem>Current working directory of the process
2537 <option>pid_environ</option>
2539 <option>pid varname</option>
2541 <listitem>Contents of a environment-var of the process
2547 <option>pid_environ_list</option>
2549 <option>pid</option>
2551 <listitem>List of environment-vars that the process can see
2557 <option>pid_exe</option>
2559 <option>pid</option>
2561 <listitem>Path to executed command that started the process
2567 <option>pid_nice</option>
2569 <option>pid</option>
2571 <listitem>The nice value of the process
2577 <option>pid_openfiles</option>
2579 <option>pid</option>
2581 <listitem>List of files that the process has open
2587 <option>pid_parent</option>
2589 <option>pid</option>
2591 <listitem>The pid of the parent of the process
2597 <option>pid_priority</option>
2599 <option>pid</option>
2601 <listitem>The priority of the process (see 'priority' in "man 5 proc")
2607 <option>pid_state</option>
2609 <option>pid</option>
2611 <listitem>State of the process
2617 <option>pid_state_short</option>
2619 <option>pid</option>
2621 <listitem>One of the chars in "RSDZTW" representing the state
2622 of the process where R is running, S is sleeping in an
2623 interruptible wait, D is waiting in uninterruptible disk sleep,
2624 Z is zombie, T is traced or stopped (on a signal), and W is paging
2630 <option>pid_stderr</option>
2632 <option>pid</option>
2634 <listitem>Filedescriptor binded to the STDERR of the process
2640 <option>pid_stdin</option>
2642 <option>pid</option>
2644 <listitem>Filedescriptor binded to the STDIN of the process
2650 <option>pid_stdout</option>
2652 <option>pid</option>
2654 <listitem>Filedescriptor binded to the STDOUT of the process
2660 <option>pid_threads</option>
2662 <option>pid</option>
2664 <listitem>Number of threads in process containing this thread
2670 <option>pid_thread_list</option>
2672 <option>pid</option>
2674 <listitem>List with pid's from threads from this process
2680 <option>pid_time_kernelmode</option>
2682 <option>pid</option>
2684 <listitem>Amount of time that the process has been scheduled in kernel mode in seconds
2690 <option>pid_time_usermode</option>
2692 <option>pid</option>
2694 <listitem>Amount of time that the process has been scheduled in user mode in seconds
2700 <option>pid_time</option>
2702 <option>pid</option>
2704 <listitem>Sum of $pid_time_kernelmode and $pid_time_usermode
2710 <option>pid_uid</option>
2712 <option>pid</option>
2714 <listitem>The real uid of the process
2720 <option>pid_euid</option>
2722 <option>pid</option>
2724 <listitem>The effective uid of the process
2730 <option>pid_suid</option>
2732 <option>pid</option>
2734 <listitem>The saved set uid of the process
2740 <option>pid_fsuid</option>
2742 <option>pid</option>
2744 <listitem>The file system uid of the process
2750 <option>pid_gid</option>
2752 <option>pid</option>
2754 <listitem>The real gid of the process
2760 <option>pid_egid</option>
2762 <option>pid</option>
2764 <listitem>The effective gid of the process
2770 <option>pid_sgid</option>
2772 <option>pid</option>
2774 <listitem>The saved set gid of the process
2780 <option>pid_fsgid</option>
2782 <option>pid</option>
2784 <listitem>The file system gid of the process
2790 <option>pid_vmpeak</option>
2792 <option>pid</option>
2794 <listitem>Peak virtual memory size of the process
2800 <option>pid_vmsize</option>
2802 <option>pid</option>
2804 <listitem>Virtual memory size of the process
2810 <option>pid_vmlck</option>
2812 <option>pid</option>
2814 <listitem>Locked memory size of the process
2820 <option>pid_vmhwm</option>
2822 <option>pid</option>
2824 <listitem>Peak resident set size ("high water mark") of the process
2830 <option>pid_vmrss</option>
2832 <option>pid</option>
2834 <listitem>Resident set size of the process
2840 <option>pid_vmdata</option>
2842 <option>pid</option>
2844 <listitem>Data segment size of the process
2850 <option>pid_vmstk</option>
2852 <option>pid</option>
2854 <listitem>Stack segment size of the process
2860 <option>pid_vmexe</option>
2862 <option>pid</option>
2864 <listitem>Text segment size of the process
2870 <option>pid_vmlib</option>
2872 <option>pid</option>
2874 <listitem>Shared library code size of the process
2880 <option>pid_vmpte</option>
2882 <option>pid</option>
2884 <listitem>Page table entries size of the process
2890 <option>platform</option>
2892 <option>(dev) type n (factor offset)</option>
2894 <listitem>Platform sensor from sysfs (Linux 2.6). Parameter
2895 dev may be omitted if you have only one platform device.
2896 Platform type is either 'in' or 'vol' meaning voltage;
2897 'fan' meaning fan; 'temp' meaning temperature. Parameter n
2898 is number of the sensor. See /sys/bus/platform/devices/ on
2899 your local computer. The optional arguments 'factor' and
2900 'offset' allow precalculation of the raw input, which is
2901 being modified as follows: 'input = input * factor +
2902 offset'. Note that they have to be given as decimal values
2903 (i.e. contain at least one decimal place).
2909 <option>pop3_unseen</option>
2911 <option>(args)</option>
2913 <listitem>Displays the number of unseen messages in your
2914 global POP3 inbox by default. You can define individual
2915 POP3 inboxes seperately by passing arguments to this
2916 object. Arguments are: "host user pass [-i interval (in
2917 seconds)] [-p port] [-e 'command'] [-r retries]". Default
2918 port is 110, default interval is 5 minutes, and default
2919 number of retries before giving up is 5. If the password is
2920 supplied as '*', you will be prompted to enter the password
2927 <option>pop3_used</option>
2929 <option>(args)</option>
2931 <listitem>Displays the amount of space (in MiB, 2^20) used
2932 in your global POP3 inbox by default. You can define
2933 individual POP3 inboxes seperately by passing arguments to
2934 this object. Arguments are: "host user pass [-i interval
2935 (in seconds)] [-p port] [-e 'command'] [-r retries]". Default
2936 port is 110, default interval is 5 minutes, and default
2937 number of retries before giving up is 5. If the password is
2938 supplied as '*', you will be prompted to enter the password
2945 <option>pre_exec</option>
2947 <option>shell command</option>
2949 <listitem>Executes a shell command one time before conky
2950 displays anything and puts output as text.
2956 <option>processes</option>
2959 <listitem>Total processes (sleeping and running)
2965 <option>read_tcp</option>
2967 <option>(host) port</option>
2969 <listitem>Connects to a tcp port on a host (default is
2970 localhost), reads every char available at the moment and
2977 <option>replied_mails</option>
2979 <option>(maildir)</option>
2980 <option>(interval)</option>
2982 <listitem>Number of mails marked as replied in the
2983 specified mailbox or mail spool if not. Only maildir type
2984 mailboxes are supported, mbox type will return -1.
2990 <option>rss</option>
2992 <option>uri interval_in_minutes action (num_par
2993 (spaces_in_front))</option>
2996 <para>Download and parse RSS feeds. The interval may be
2997 a floating point value greater than 0, otherwise
2998 defaults to 15 minutes. Action may be one of the
2999 following: feed_title, item_title (with num par),
3000 item_desc (with num par) and item_titles (when using
3001 this action and spaces_in_front is given conky places
3002 that many spaces in front of each item). This object is
3003 threaded, and once a thread is created it can't be
3004 explicitely destroyed. One thread will run for each URI
3005 specified. You can use any protocol that Curl
3012 <option>running_processes</option>
3015 <listitem>Running processes (not sleeping), requires Linux
3022 <option>running_threads</option>
3025 <listitem>Number of running (runnable) threads. Linux only.
3031 <option>scroll</option>
3033 <option>length (step) text</option>
3035 <listitem>Scroll 'text' by 'step' characters showing
3036 'length' number of characters at the same time. The text
3037 may also contain variables. 'step' is optional and defaults
3038 to 1 if not set. If a var creates output on multiple lines
3039 then the lines are placed behind each other separated with
3040 a '|'-sign. If you change the textcolor inside $scroll it
3041 will automatically have it's old value back at the end of
3042 $scroll. The end and the start of text will be seperated by
3043 'length' number of spaces.
3049 <option>seen_mails</option>
3051 <option>(maildir)</option>
3052 <option>(interval)</option>
3054 <listitem>Number of mails marked as seen in the specified
3055 mailbox or mail spool if not. Only maildir type mailboxes
3056 are supported, mbox type will return -1.
3062 <option>shadecolor</option>
3064 <option>(color)</option>
3066 <listitem>Change shading color
3072 <option>smapi</option>
3074 <option>(ARGS)</option>
3076 <listitem>when using smapi, display contents of the
3077 /sys/devices/platform/smapi directory. ARGS are either
3078 '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the
3079 corresponding files' content. This is a very raw method of
3080 accessing the smapi values. When available, better use one
3081 of the smapi_* variables instead.
3087 <option>smapi_bat_bar</option>
3089 <option>(INDEX),(height),(width)</option>
3091 <listitem>when using smapi, display the remaining capacity
3092 of the battery with index INDEX as a bar.
3098 <option>smapi_bat_perc</option>
3100 <option>(INDEX)</option>
3102 <listitem>when using smapi, display the remaining capacity
3103 in percent of the battery with index INDEX. This is a
3104 separate variable because it supports the 'use_spacer'
3105 configuration option.
3111 <option>smapi_bat_power</option>
3113 <option>INDEX</option>
3115 <listitem>when using smapi, display the current power of
3116 the battery with index INDEX in watt. This is a separate
3117 variable because the original read out value is being
3118 converted from mW. The sign of the output reflects charging
3119 (positive) or discharging (negative) state.
3125 <option>smapi_bat_temp</option>
3127 <option>INDEX</option>
3129 <listitem>when using smapi, display the current temperature
3130 of the battery with index INDEX in degree Celsius. This is
3131 a separate variable because the original read out value is
3132 being converted from milli degree Celsius.
3138 <option>sony_fanspeed</option>
3141 <listitem>Displays the Sony VAIO fanspeed information if
3142 sony-laptop kernel support is enabled. Linux only.
3148 <option>stippled_hr</option>
3150 <option>(space)</option>
3152 <listitem>Stippled (dashed) horizontal line
3158 <option>swap</option>
3161 <listitem>Amount of swap in use
3167 <option>swapbar</option>
3169 <option>(height),(width)</option>
3171 <listitem>Bar that shows amount of swap in use
3177 <option>swapfree</option>
3180 <listitem>Amount of free swap
3186 <option>swapmax</option>
3189 <listitem>Total amount of swap
3195 <option>swapperc</option>
3198 <listitem>Percentage of swap in use
3204 <option>sysname</option>
3207 <listitem>System name, Linux for example
3213 <option>tab</option>
3215 <option>(width, (start))</option>
3217 <listitem>Puts a tab of the specified width, starting from
3218 column 'start'. The unit is pixels for both arguments.
3224 <option>tail</option>
3226 <option>logfile lines (next_check)</option>
3228 <listitem>Displays last N lines of supplied text file. The
3229 file is checked every 'next_check' update. If next_check is
3230 not supplied, Conky defaults to 2. Max of 30 lines can be
3231 displayed, or until the text buffer is filled.
3237 <option>tcp_portmon</option>
3239 <option>port_begin port_end item (index)</option>
3242 <para>TCP port (both IPv6 and IPv4) monitor for
3243 specified local ports. Port numbers must be in
3244 the range 1 to 65535. Valid items are:</para>
3247 <command>count</command>
3248 <option>Total number of connections in the
3252 <command>rip</command>
3253 <option>Remote ip address</option>
3256 <command>rhost</command>
3257 <option>Remote host name</option>
3260 <command>rport</command>
3261 <option>Remote port number</option>
3264 <command>rservice</command>
3265 <option>Remote service name from
3266 /etc/services</option>
3269 <command>lip</command>
3270 <option>Local ip address</option>
3273 <command>lhost</command>
3274 <option>Local host name</option>
3277 <command>lport</command>
3278 <option>Local port number</option>
3281 <command>lservice</command>
3282 <option>Local service name from
3283 /etc/services</option>
3286 <para>The connection index provides you with access to
3287 each connection in the port monitor. The monitor will
3288 return information for index values from 0 to n-1
3289 connections. Values higher than n-1 are simply ignored.
3290 For the "count" item, the connection index must be
3291 omitted. It is required for all other items.</para>
3292 <para>Examples:</para>
3295 <command>${tcp_portmon 6881 6999
3297 <option>Displays the number of connections in
3298 the bittorrent port range</option>
3301 <command>${tcp_portmon 22 22 rip 0}</command>
3302 <option>Displays the remote host ip of the
3303 first sshd connection</option>
3306 <command>${tcp_portmon 22 22 rip 9}</command>
3307 <option>Displays the remote host ip of the
3308 tenth sshd connection</option>
3311 <command>${tcp_portmon 1 1024 rhost
3313 <option>Displays the remote host name of the
3314 first connection on a privileged port</option>
3317 <command>${tcp_portmon 1 1024 rport
3319 <option>Displays the remote host port of the
3320 fifth connection on a privileged port</option>
3323 <command>${tcp_portmon 1 65535 lservice
3325 <option>Displays the local service name of the
3326 fifteenth connection in the range of all
3330 <para>Note that port monitor variables which share the
3331 same port range actually refer to the same monitor, so
3332 many references to a single port range for different
3333 items and different indexes all use the same monitor
3334 internally. In other words, the program avoids creating
3335 redundant monitors.</para>
3341 <option>templateN</option>
3343 <option>(arg1)</option>
3344 <option>(arg2)</option>
3345 <option>(arg3 ...)</option>
3348 <para>Evaluate the content of the templateN
3349 configuration variable (where N is a value between 0
3350 and 9, inclusively), applying substitutions as
3351 described in the documentation of the corresponding
3352 configuration variable. The number of arguments is
3353 optional, but must match the highest referred index in
3354 the template. You can use the same special sequences in
3355 each argument as the ones valid for a template
3356 definition, e.g. to allow an argument to contain a
3357 whitespace. Also simple nesting of templates is
3358 possible this way.</para>
3359 <para>Here are some examples of template
3362 <member>template0 $\1\2</member>
3363 <member>template1 \1: ${fs_used \2} / ${fs_size
3365 <member>template2 \1 \2</member>
3367 <para>The following list shows sample usage of the
3368 templates defined above, with the equivalent syntax
3369 when not using any template at all:</para>
3374 <entry>using template</entry>
3375 <entry>same without template</entry>
3380 <entry>${template0 node name}</entry>
3381 <entry>$nodename</entry>
3384 <entry>${template1 root /}</entry>
3385 <entry>root: ${fs_free /} / ${fs_size
3390 <programlisting>${template1
3391 ${template2\ disk\ root}
3395 <programlisting>disk root:
3396 ${fs_free /} / ${fs_size
3408 <option>texeci</option>
3410 <option>interval command</option>
3412 <listitem>Runs a command at an interval inside a thread and
3413 displays the output. Same as $execi, except the command is
3414 run inside a thread. Use this if you have a slow script to
3415 keep Conky updating. You should make the interval slightly
3416 longer then the time it takes your script to execute. For
3417 example, if you have a script that take 5 seconds to
3418 execute, you should make the interval at least 6 seconds.
3419 See also $execi. This object will clean up the thread when
3420 it is destroyed, so it can safely be used in a nested
3421 fashion, though it may not produce the desired behaviour if
3428 <option>threads</option>
3431 <listitem>Total threads
3437 <option>time</option>
3439 <option>(format)</option>
3441 <listitem>Local time, see man strftime to get more
3442 information about format
3448 <option>to_bytes</option>
3450 <option>size</option>
3452 <listitem>If 'size' is a number followed by a size-unit
3453 (kilobyte,mb,GiB,...) then it converts the size to bytes
3454 and shows it without unit, otherwise it just shows 'size'.
3460 <option>top</option>
3462 <option>type num</option>
3464 <listitem>This takes arguments in the form:top (name)
3465 (number) Basically, processes are ranked from highest to
3466 lowest in terms of cpu usage, which is what (num)
3467 represents. The types are: "name", "pid", "cpu", "mem",
3468 "mem_res", "mem_vsize", "time", "io_perc", "io_read" and
3469 "io_write". There can be a max of 10 processes listed.
3475 <option>top_io</option>
3477 <option>type num</option>
3479 <listitem>Same as top, except sorted by the amount of I/O
3480 the process has done during the update interval
3486 <option>top_mem</option>
3488 <option>type num</option>
3490 <listitem>Same as top, except sorted by mem usage instead
3497 <option>top_time</option>
3499 <option>type num</option>
3501 <listitem>Same as top, except sorted by total CPU time
3502 instead of current CPU usage
3508 <option>totaldown</option>
3510 <option>(net)</option>
3512 <listitem>Total download, overflows at 4 GB on Linux with
3513 32-bit arch and there doesn't seem to be a way to know how
3514 many times it has already done that before conky has
3521 <option>totalup</option>
3523 <option>(net)</option>
3525 <listitem>Total upload, this one too, may overflow
3531 <option>trashed_mails</option>
3533 <option>(maildir)</option>
3534 <option>(interval)</option>
3536 <listitem>Number of mails marked as trashed in the
3537 specified mailbox or mail spool if not. Only maildir type
3538 mailboxes are supported, mbox type will return -1.
3544 <option>tztime</option>
3546 <option>(timezone (format))</option>
3548 <listitem>Local time for specified timezone, see man
3549 strftime to get more information about format. The timezone
3550 argument is specified in similar fashion as TZ environment
3551 variable. For hints, look in /usr/share/zoneinfo. e.g.
3552 US/Pacific, Europe/Zurich, etc.
3558 <option>gid_name</option>
3560 <option>gid</option>
3562 <listitem>Name of group with this gid
3568 <option>uid_name</option>
3570 <option>uid</option>
3572 <listitem>Username of user with this uid
3578 <option>unflagged_mails</option>
3580 <option>(maildir)</option>
3581 <option>(interval)</option>
3583 <listitem>Number of mails not marked as flagged in the
3584 specified mailbox or mail spool if not. Only maildir type
3585 mailboxes are supported, mbox type will return -1.
3591 <option>unforwarded_mails</option>
3593 <option>(maildir)</option>
3594 <option>(interval)</option>
3596 <listitem>Number of mails not marked as forwarded in the
3597 specified mailbox or mail spool if not. Only maildir type
3598 mailboxes are supported, mbox type will return -1.
3604 <option>unreplied_mails</option>
3606 <option>(maildir)</option>
3607 <option>(interval)</option>
3609 <listitem>Number of mails not marked as replied in the
3610 specified mailbox or mail spool if not. Only maildir type
3611 mailboxes are supported, mbox type will return -1.
3617 <option>unseen_mails</option>
3619 <option>(maildir)</option>
3620 <option>(interval)</option>
3622 <listitem>Number of new or unseen mails in the specified
3623 mailbox or mail spool if not. Only maildir type mailboxes
3624 are supported, mbox type will return -1.
3630 <option>updates</option>
3632 <option>Number of updates</option>
3634 <listitem>for debugging
3640 <option>upspeed</option>
3642 <option>(net)</option>
3644 <listitem>Upload speed in suitable IEC units
3650 <option>upspeedf</option>
3652 <option>(net)</option>
3654 <listitem>Upload speed in KiB with one decimal
3660 <option>upspeedgraph</option>
3662 <option>(netdev) (height),(width) (gradient colour 1)
3663 (gradient colour 2) (scale) (-t) (-l)</option>
3665 <listitem>Upload speed graph, colours defined in hex, minus
3666 the #. If scale is non-zero, it becomes the scale for the
3667 graph. Uses a logarithmic scale (to see small numbers) when
3668 you use the -l switch. Takes the switch '-t' to use a
3669 temperature gradient, which makes the gradient values
3670 change depending on the amplitude of a particular graph
3671 value (try it and see).
3677 <option>uptime</option>
3686 <option>uptime_short</option>
3689 <listitem>Uptime in a shorter format
3695 <option>user_names</option>
3698 <listitem>Lists the names of the users logged in
3704 <option>user_number</option>
3707 <listitem>Number of users logged in
3713 <option>user_terms</option>
3716 <listitem>Lists the consoles in use
3722 <option>user_times</option>
3725 <listitem>Lists how long users have been logged in for
3731 <option>user_time</option>
3733 <option>console</option>
3735 <listitem>Lists how long the user for the given console has been
3742 <option>utime</option>
3744 <option>(format)</option>
3746 <listitem>Display time in UTC (universal coordinate time).
3752 <option>voffset</option>
3754 <option>(pixels)</option>
3756 <listitem>Change vertical offset by N pixels. Negative
3757 values will cause text to overlap. See also $offset.
3763 <option>voltage_mv</option>
3765 <option>(n)</option>
3767 <listitem>Returns CPU #n's voltage in mV. CPUs are counted
3768 from 1. If omitted, the parameter defaults to 1.
3774 <option>voltage_v</option>
3776 <option>(n)</option>
3778 <listitem>Returns CPU #n's voltage in V. CPUs are counted
3779 from 1. If omitted, the parameter defaults to 1.
3785 <option>weather</option>
3787 <option>URI locID data_type
3788 (interval_in_minutes)</option>
3791 <para>Download, parse and display METAR data.</para>
3792 <para>For the 'URI', there are two
3793 possibilities:</para>
3796 http://weather.noaa.gov/pub/data/observations/metar/stations/</member>
3798 http://xoap.weather.com/weather/local/</member>
3800 <para>The first one is free to use but the second
3801 requires you to register and obtain your partner ID and
3802 license key. These two must be written, separated by a
3803 space, into a file called .xoaprc which needs to be
3804 placed into your home directory.</para>
3805 <para>'locID' must be a valid location identifier for
3806 the required uri. For the NOAA site this must be a
3807 valid ICAO (see for instance
3808 https://pilotweb.nas.faa.gov/qryhtml/icao/). For the
3809 weather.com site this must be a valid location ID (see
3811 http://aspnetresources.com/tools/locid.aspx).</para>
3812 <para>'data_type' must be one of the following:</para>
3815 <command>last_update</command>
3816 <para>The date and time stamp of the data.
3817 The result depends on the URI used. For the
3818 NOAA site it is date (yyyy/mm/dd) and UTC time.
3819 For the weather.com one it is date
3820 ([m]m/[d]d/yy) and Local Time of the
3824 <command>temperature</command>
3825 <para>Air temperature (you can use the
3826 'temperature_unit' config setting to change
3830 <command>cloud_cover</command>
3831 <para>The highest cloud cover status</para>
3834 <command>pressure</command>
3835 <para>Air pressure in millibar</para>
3838 <command>wind_speed</command>
3839 <para>Wind speed in km/h</para>
3842 <command>wind_dir</command>
3843 <para>Wind direction</para>
3846 <command>wind_dir_DEG</command>
3847 <para>Compass wind direction</para>
3850 <command>humidity</command>
3851 <para>Relative humidity in %</para>
3854 <command>weather</command>
3855 <para>Any relevant weather event (rain, snow,
3856 etc.). This is not used if you are querying the
3857 weather.com site since this data is aggregated
3858 into the cloud_cover one</para>
3861 <command>icon</command>
3862 <para>Weather icon (only for
3863 www.weather.com). Can be used together with the
3864 icon kit provided upon registering to their
3868 <para>'delay_in_minutes' (optional, default 30) cannot
3869 be less than 30 minutes.</para>
3870 <para>This object is threaded, and once a thread is
3871 created it can't be explicitely destroyed. One thread
3872 will run for each URI specified.</para>
3873 <para>Note that these variables are still EXPERIMENTAL
3874 and can be subject to many future changes.</para>
3880 <option>weather_forecast</option>
3882 <option>URI locID day data_type
3883 (interval_in_minutes)</option>
3886 <para>Download, parse and display weather forecast data
3887 for a given day (daytime only).</para>
3888 <para>For the 'URI', for the time being only
3889 http://xoap.weather.com/weather/local/ is
3890 supported. See 'weather' above for details of usage</para>
3891 <para>'locID', see 'weather' above.</para>
3892 <para>'day' is a number from 0 (today) to 4 (3 days
3893 after tomorrow).</para>
3894 <para>'data_type' must be one of the following:</para>
3897 <command>day</command>
3898 <option>Day of the week</option>
3901 <command>date</command>
3902 <option>Date, in the form MMM DD (ie. Jul 14)</option>
3905 <command>low</command>
3906 <option>Minimun temperature (you can use the
3907 'temperature_unit' config setting to change
3911 <command>hi</command>
3912 <option>Maximum temperature (you can use the
3913 'temperature_unit' config setting to change
3917 <command>icon</command>
3918 <option>Weather icon. Can be used together with the
3919 icon kit provided upon registering to the weather.com
3923 <command>forecast</command>
3924 <option>Weather forecast (sunny, rainy, etc.)</option>
3927 <command>wind_speed</command>
3928 <option>Wind speed in km/h</option>
3931 <command>wind_dir</command>
3932 <option>Wind direction</option>
3935 <command>wind_dir_DEG</command>
3936 <option>Compass wind direction</option>
3939 <command>humidity</command>
3940 <option>Relative humidity in %</option>
3943 <command>precipitation</command>
3944 <option>Probability of having a
3945 precipitation (in %)</option>
3948 <para>'delay_in_minutes' (optional, default 210) cannot
3949 be lower than 210 min.</para>
3950 <para>This object is threaded, and once a thread is
3951 created it can't be explicitely destroyed. One thread
3952 will run for each URI specified. You can use any
3953 protocol that Curl supports.</para>
3954 <para>Note that these variables are still EXPERIMENTAL
3955 and can be subject to many future changes.</para>
3961 <option>wireless_ap</option>
3963 <option>(net)</option>
3965 <listitem>Wireless access point MAC address (Linux only)
3971 <option>wireless_bitrate</option>
3973 <option>(net)</option>
3975 <listitem>Wireless bitrate (ie 11 Mb/s) (Linux only)
3981 <option>wireless_essid</option>
3983 <option>(net)</option>
3985 <listitem>Wireless access point ESSID (Linux only)
3991 <option>wireless_link_bar</option>
3993 <option>(height),(width) (net)</option>
3995 <listitem>Wireless link quality bar (Linux only)
4001 <option>wireless_link_qual</option>
4003 <option>(net)</option>
4005 <listitem>Wireless link quality (Linux only)
4011 <option>wireless_link_qual_max</option>
4013 <option>(net)</option>
4015 <listitem>Wireless link quality maximum value (Linux only)
4021 <option>wireless_link_qual_perc</option>
4023 <option>(net)</option>
4025 <listitem>Wireless link quality in percents (Linux only)
4031 <option>wireless_mode</option>
4033 <option>(net)</option>
4035 <listitem>Wireless mode (Managed/Ad-Hoc/Master) (Linux
4042 <option>words</option>
4044 <option>textfile</option>
4046 <listitem>Displays the number of words in the given file
4052 <option>xmms2_album</option>
4055 <listitem>Album in current XMMS2 song
4061 <option>xmms2_artist</option>
4064 <listitem>Artist in current XMMS2 song
4070 <option>xmms2_bar</option>
4072 <option>(height),(width)</option>
4074 <listitem>Bar of XMMS2's progress
4080 <option>xmms2_bitrate</option>
4083 <listitem>Bitrate of current song
4089 <option>xmms2_comment</option>
4092 <listitem>Comment in current XMMS2 song
4098 <option>xmms2_date</option>
4101 <listitem>Returns song's date.
4107 <option>xmms2_duration</option>
4110 <listitem>Duration of current song
4116 <option>xmms2_elapsed</option>
4119 <listitem>Song's elapsed time
4125 <option>xmms2_genre</option>
4128 <listitem>Genre in current XMMS2 song
4134 <option>xmms2_id</option>
4137 <listitem>XMMS2 id of current song
4143 <option>xmms2_percent</option>
4146 <listitem>Percent of song's progress
4152 <option>xmms2_playlist</option>
4155 <listitem>Returns the XMMS2 playlist.
4161 <option>xmms2_size</option>
4164 <listitem>Size of current song
4170 <option>xmms2_smart</option>
4173 <listitem>Prints the song name in either the form "artist -
4174 title" or file name, depending on whats available
4180 <option>xmms2_status</option>
4183 <listitem>XMMS2 status (Playing, Paused, Stopped, or
4190 <option>xmms2_timesplayed</option>
4193 <listitem>Number of times a song was played (presumably).
4199 <option>xmms2_title</option>
4202 <listitem>Title in current XMMS2 song
4208 <option>xmms2_tracknr</option>
4211 <listitem>Track number in current XMMS2 song
4217 <option>xmms2_url</option>
4220 <listitem>Full path to current song
projects / monky / blob