5 <option>acpiacadapter</option>
8 <listitem>ACPI ac adapter state.
14 <option>acpifan</option>
17 <listitem>ACPI fan state
23 <option>acpitemp</option>
26 <listitem>ACPI temperature in C.
34 <option>(interface)</option>
36 <listitem>IP address for an interface, or "No Address" if
37 no address is assigned.
43 <option>addrs</option>
45 <option>(interface)</option>
47 <listitem>IP addresses for an interface (if one - works
48 like addr). Linux only.
54 <option>adt746xcpu</option>
57 <listitem>CPU temperature from therm_adt746x
63 <option>adt746xfan</option>
66 <listitem>Fan speed from therm_adt746x
72 <option>alignc</option>
74 <option>(num)</option>
76 <listitem>Align text to centre
82 <option>alignr</option>
84 <option>(num)</option>
86 <listitem>Right-justify text, with space of N
92 <option>apcupsd</option>
97 <listitem>Sets up the connection to apcupsd daemon. Prints
98 nothing, defaults to localhost:3551
104 <option>apcupsd_cable</option>
107 <listitem>Prints the UPS connection type.
113 <option>apcupsd_charge</option>
116 <listitem>Current battery capacity in percent.
122 <option>apcupsd_lastxfer</option>
125 <listitem>Reason for last transfer from line to battery.
131 <option>apcupsd_linev</option>
134 <listitem>Nominal input voltage.
140 <option>apcupsd_load</option>
143 <listitem>Current load in percent.
149 <option>apcupsd_loadbar</option>
152 <listitem>Bar showing current load.
158 <option>apcupsd_loadgauge</option>
160 <option>(height),(width)</option>
162 <listitem>Gauge that shows current load.
168 <option>apcupsd_loadgraph</option>
170 <option>(height),(width) (gradient colour 1) (gradient
171 colour 2) (scale) (-t) (-l)</option>
173 <listitem>History graph of current load.
179 <option>apcupsd_model</option>
182 <listitem>Prints the model of the UPS.
188 <option>apcupsd_name</option>
191 <listitem>Prints the UPS user-defined name.
197 <option>apcupsd_status</option>
200 <listitem>Prints current status (on-line, on-battery).
206 <option>apcupsd_temp</option>
209 <listitem>Current internal temperature.
215 <option>apcupsd_timeleft</option>
218 <listitem>Time left to run on battery.
224 <option>apcupsd_upsmode</option>
227 <listitem>Prints the UPS mode (e.g. standalone).
233 <option>apm_adapter</option>
236 <listitem>Display APM AC adapter status (FreeBSD only)
242 <option>apm_battery_life</option>
245 <listitem>Display APM battery life in percent (FreeBSD
252 <option>apm_battery_time</option>
255 <listitem>Display remaining APM battery life in hh:mm:ss or
256 "unknown" if AC adapterstatus is on-line or charging
263 <option>audacious_bar</option>
265 <option>(height),(width)</option>
267 <listitem>Progress bar
273 <option>audacious_bitrate</option>
276 <listitem>Bitrate of current tune
282 <option>audacious_channels</option>
285 <listitem>Number of audio channels of current tune
291 <option>audacious_filename</option>
294 <listitem>Full path and filename of current tune
300 <option>audacious_frequency</option>
303 <listitem>Sampling frequency of current tune
309 <option>audacious_length</option>
312 <listitem>Total length of current tune as MM:SS
318 <option>audacious_length_seconds</option>
321 <listitem>Total length of current tune in seconds
327 <option>audacious_main_volume</option>
330 <listitem>The current volume fetched from Audacious
336 <option>audacious_playlist_length</option>
339 <listitem>Number of tunes in playlist
345 <option>audacious_playlist_position</option>
348 <listitem>Playlist position of current tune
354 <option>audacious_position</option>
357 <listitem>Position of current tune (MM:SS)
363 <option>audacious_position_seconds</option>
366 <listitem>Position of current tune in seconds
372 <option>audacious_status</option>
375 <listitem>Player status (Playing/Paused/Stopped/Not
382 <option>audacious_title</option>
384 <option>(max length)</option>
386 <listitem>Title of current tune with optional maximum
393 <option>battery</option>
395 <option>(num)</option>
397 <listitem>Battery status and remaining percentage capacity
398 of ACPI or APM battery. ACPI battery number can be given as
399 argument (default is BAT0).
405 <option>battery_bar</option>
407 <option>(height),(width) (num)</option>
409 <listitem>Battery percentage remaining of ACPI battery in a
410 bar. ACPI battery number can be given as argument (default
417 <option>battery_percent</option>
419 <option>(num)</option>
421 <listitem>Battery percentage remaining for ACPI battery.
422 ACPI battery number can be given as argument (default is
429 <option>battery_short</option>
431 <option>(num)</option>
433 <listitem>Battery status and remaining percentage capacity
434 of ACPI or APM battery. ACPI battery number can be given as
435 argument (default is BAT0). This mode display a short
436 status, which means that C is displayed instead of
437 charging, D for discharging, F for full, N for not present,
438 E for empty and U for unknown.
444 <option>battery_time</option>
446 <option>(num)</option>
448 <listitem>Battery charge/discharge time remaining of ACPI
449 battery. ACPI battery number can be given as argument
456 <option>blink</option>
458 <option>text_and_other_conky_vars</option>
460 <listitem>Let 'text_and_other_conky_vars' blink on and off.
467 <option>bmpx_album</option>
470 <listitem>Album in current BMPx track
476 <option>bmpx_artist</option>
479 <listitem>Artist in current BMPx track
485 <option>bmpx_bitrate</option>
488 <listitem>Bitrate of the current BMPx track
494 <option>bmpx_title</option>
497 <listitem>Title of the current BMPx track
503 <option>bmpx_track</option>
506 <listitem>Track number of the current BMPx track
512 <option>bmpx_uri</option>
515 <listitem>URI of the current BMPx track
521 <option>buffers</option>
524 <listitem>Amount of memory buffered
530 <option>cached</option>
533 <listitem>Amount of memory cached
539 <option>color</option>
541 <option>(color)</option>
543 <listitem>Change drawing color to color
549 <option>colorN</option>
552 <listitem>Change drawing color to colorN configuration
553 option, where N is a digit between 0 and 9, inclusively.
559 <option>combine</option>
561 <option>var1 var2</option>
563 <listitem>Places the lines of var2 to the right of the
564 lines of var1 seperated by the chars that are put between
565 var1 and var2. For example: ${combine ${head /proc/cpuinfo
566 2} - ${head /proc/meminfo 1}} gives as output
567 "cpuinfo_line1 - meminfo_line1" on line 1 and
568 "cpuinfo_line2 -" on line 2. $combine vars can also be
569 nested to place more vars next to each other.
575 <option>conky_build_arch</option>
578 <listitem>CPU architecture Conky was built for
584 <option>conky_build_date</option>
587 <listitem>Date Conky was built
593 <option>conky_version</option>
596 <listitem>Conky version
604 <option>(cpuN)</option>
606 <listitem>CPU usage in percents. For SMP machines, the CPU
607 number can be provided as an argument. ${cpu cpu0} is the
608 total usage, and ${cpu cpuX} (X >= 1) are individual
615 <option>cpubar</option>
617 <option>(cpuN) (height),(width)</option>
619 <listitem>Bar that shows CPU usage, height is bar's height
620 in pixels. See $cpu for more info on SMP.
626 <option>cpugauge</option>
628 <option>(cpuN) (height),(width)</option>
630 <listitem>Elliptical gauge that shows CPU usage, height and
631 width are gauge's vertical and horizontal axis
632 respectively. See $cpu for more info on SMP.
638 <option>cpugraph</option>
640 <option>(cpuN) (height),(width) (gradient colour 1)
641 (gradient colour 2) (scale) (-t) (-l)</option>
643 <listitem>CPU usage graph, with optional colours in hex,
644 minus the #. See $cpu for more info on SMP. Uses a
645 logarithmic scale (to see small numbers) when you use the
646 -l switch. Takes the switch '-t' to use a temperature
647 gradient, which makes the gradient values change depending
648 on the amplitude of a particular graph value (try it and
655 <option>desktop</option>
658 <listitem>Number of the desktop on which conky is running
659 or the message "Not running in X" if this is the case.
665 <option>desktop_name</option>
668 <listitem>Name of the desktop on which conky is running
669 or the message "Not running in X" if this is the case.
675 <option>desktop_number</option>
678 <listitem>Number of desktops or the message "Not running
679 in X" if this is the case.
685 <option>disk_protect</option>
687 <option>device</option>
689 <listitem>Disk protection status, if supported (needs
690 kernel-patch). Prints either "frozen" or "free " (note the
697 <option>diskio</option>
699 <option>(device)</option>
701 <listitem>Displays current disk IO. Device is optional, and
702 takes the form of sda for /dev/sda. Individual partitions
709 <option>diskio_read</option>
711 <option>(device)</option>
713 <listitem>Displays current disk IO for reads. Device as in
720 <option>diskio_write</option>
722 <option>(device)</option>
724 <listitem>Displays current disk IO for writes. Device as in
731 <option>diskiograph</option>
733 <option>(device) (height),(width) (gradient colour 1)
734 (gradient colour 2) (scale) (-t) (-l)</option>
736 <listitem>Disk IO graph, colours defined in hex, minus the
737 #. If scale is non-zero, it becomes the scale for the
738 graph. Uses a logarithmic scale (to see small numbers) when
739 you use -l switch. Takes the switch '-t' to use a
740 temperature gradient, which makes the gradient values
741 change depending on the amplitude of a particular graph
742 value (try it and see).
748 <option>diskiograph_read</option>
750 <option>(device) (height),(width) (gradient colour 1)
751 (gradient colour 2) (scale) (-t) (-l)</option>
753 <listitem>Disk IO graph for reads, colours defined in hex,
754 minus the #. If scale is non-zero, it becomes the scale for
755 the graph. Device as in diskio. Uses a logarithmic scale
756 (to see small numbers) when you use -l switch. Takes the
757 switch '-t' to use a temperature gradient, which makes the
758 gradient values change depending on the amplitude of a
759 particular graph value (try it and see).
765 <option>diskiograph_write</option>
767 <option>(device) (height),(width) (gradient colour 1)
768 (gradient colour 2) (scale) (-t) (-l)</option>
770 <listitem>Disk IO graph for writes, colours defined in hex,
771 minus the #. If scale is non-zero, it becomes the scale for
772 the graph. Device as in diskio. Uses a logarithmic scale
773 (to see small numbers) when you use -l switch. Takes the
774 switch '-t' to use a temperature gradient, which makes the
775 gradient values change depending on the amplitude of a
776 particular graph value (try it and see).
782 <option>downspeed</option>
784 <option>(net)</option>
786 <listitem>Download speed in suitable IEC units
792 <option>downspeedf</option>
794 <option>(net)</option>
796 <listitem>Download speed in KiB with one decimal
802 <option>downspeedgraph</option>
804 <option>(netdev) (height),(width) (gradient colour 1)
805 (gradient colour 2) (scale) (-t) (-l)</option>
807 <listitem>Download speed graph, colours defined in hex,
808 minus the #. If scale is non-zero, it becomes the scale for
809 the graph. Uses a logarithmic scale (to see small numbers)
810 when you use -l switch. Takes the switch '-t' to use a
811 temperature gradient, which makes the gradient values
812 change depending on the amplitude of a particular graph
813 value (try it and see).
819 <option>draft_mails</option>
821 <option>(maildir)</option>
822 <option>(interval)</option>
824 <listitem>Number of mails marked as draft in the specified
825 mailbox or mail spool if not. Only maildir type mailboxes
826 are supported, mbox type will return -1.
832 <option>else</option>
835 <listitem>Text to show if any of the above are not true
841 <option>endif</option>
845 <listitem>Ends an $if block.
851 <option>entropy_avail</option>
854 <listitem>Current entropy available for crypto freaks
860 <option>entropy_bar</option>
862 <option>(height),(width)</option>
864 <listitem>Normalized bar of available entropy for crypto
871 <option>entropy_perc</option>
874 <listitem>Percentage of entropy available in comparison to
881 <option>entropy_poolsize</option>
884 <listitem>Total size of system entropy pool for crypto
891 <option>eval</option>
893 <option>string</option>
895 <listitem>Evalutates given string according to the rules of
896 TEXT interpretation, i.e. parsing any contained text object
897 specifications into their output, any occuring '$$' into a
898 single '$' and so on. The output is then being parsed
907 <option>api_userid api_key character_id</option>
909 <listitem>Fetches your currently training skill from the
910 Eve Online API servers (http://www.eve-online.com/) and
911 displays the skill along with the remaining training time.
917 <option>exec</option>
919 <option>command</option>
921 <listitem>Executes a shell command and displays the output
922 in conky. warning: this takes a lot more resources than
923 other variables. I'd recommend coding wanted behaviour in C
930 <option>execbar</option>
932 <option>command</option>
934 <listitem>Same as exec, except if the first value return is
935 a value between 0-100, it will use that number for a bar.
936 The size for bars can be controlled via the
937 default_bar_size config setting.
943 <option>execgauge</option>
945 <option>command</option>
947 <listitem>Same as exec, except if the first value returned
948 is a value between 0-100, it will use that number for a
949 gauge. The size for gauges can be controlled via the
950 default_gauge_size config setting.
956 <option>execgraph</option>
958 <option>(-t) (-l) command</option>
960 <listitem>Same as execbar, but graphs values. Uses a
961 logaritmic scale when the log option (-l switch) is given
962 (to see small numbers). Values still have to be between 0
963 and 100. The size for graphs can be controlled via the
964 default_graph_size config setting. Takes the switch '-t' to
965 use a temperature gradient, which makes the gradient values
966 change depending on the amplitude of a particular graph
967 value (try it and see). If -t or -l is your first argument,
968 you may need to preceed it by a space (' ').
974 <option>execi</option>
976 <option>interval command</option>
978 <listitem>Same as exec but with specific interval. Interval
979 can't be less than update_interval in configuration. See
986 <option>execibar</option>
988 <option>interval command</option>
990 <listitem>Same as execbar, except with an interval
996 <option>execigauge</option>
998 <option>interval command</option>
1000 <listitem>Same as execgauge, but takes an interval arg and
1007 <option>execigraph</option>
1009 <option>interval (-t) (-l) command</option>
1011 <listitem>Same as execgraph, but takes an interval arg and
1012 graphs values. If -t or -l is your first argument, you may
1013 need to preceed it by a space (' ').
1019 <option>execp</option>
1021 <option>command</option>
1023 <listitem>Executes a shell command and displays the output
1024 in conky. warning: this takes a lot more resources than
1025 other variables. I'd recommend coding wanted behaviour in C
1026 and posting a patch. This differs from $exec in that it
1027 parses the output of the command, so you can insert things
1028 like ${color red}hi!${color} in your script and have it
1029 correctly parsed by Conky. Caveats: Conky parses and
1030 evaluates the output of $execp every time Conky loops, and
1031 then destroys all the objects. If you try to use anything
1032 like $execi within an $execp statement, it will
1033 functionally run at the same interval that the $execp
1034 statement runs, as it is created and destroyed at every
1041 <option>execpi</option>
1043 <option>interval command</option>
1045 <listitem>Same as execp but with specific interval.
1046 Interval can't be less than update_interval in
1047 configuration. Note that the output from the $execpi
1048 command is still parsed and evaluated at every interval.
1054 <option>flagged_mails</option>
1056 <option>(maildir)</option>
1057 <option>(interval)</option>
1059 <listitem>Number of mails marked as flagged in the
1060 specified mailbox or mail spool if not. Only maildir type
1061 mailboxes are supported, mbox type will return -1.
1067 <option>font</option>
1069 <option>(font)</option>
1071 <listitem>Specify a different font. This new font will
1072 apply to the current line and everything following. You can
1073 use a $font with no arguments to change back to the default
1074 font (much like with $color)
1080 <option>forwarded_mails</option>
1082 <option>(maildir)</option>
1083 <option>(interval)</option>
1085 <listitem>Number of mails marked as forwarded in the
1086 specified mailbox or mail spool if not. Only maildir type
1087 mailboxes are supported, mbox type will return -1.
1093 <option>freq</option>
1095 <option>(n)</option>
1097 <listitem>Returns CPU #n's frequency in MHz. CPUs are
1098 counted from 1. If omitted, the parameter defaults to 1.
1104 <option>freq_g</option>
1106 <option>(n)</option>
1108 <listitem>Returns CPU #n's frequency in GHz. CPUs are
1109 counted from 1. If omitted, the parameter defaults to 1.
1115 <option>fs_bar</option>
1117 <option>(height),(width) fs</option>
1119 <listitem>Bar that shows how much space is used on a file
1120 system. height is the height in pixels. fs is any file on
1127 <option>fs_bar_free</option>
1129 <option>(height),(width) fs</option>
1131 <listitem>Bar that shows how much space is free on a file
1132 system. height is the height in pixels. fs is any file on
1139 <option>fs_free</option>
1141 <option>(fs)</option>
1143 <listitem>Free space on a file system available for users.
1149 <option>fs_free_perc</option>
1151 <option>(fs)</option>
1153 <listitem>Free percentage of space on a file system
1154 available for users.
1160 <option>fs_size</option>
1162 <option>(fs)</option>
1164 <listitem>File system size.
1170 <option>fs_type</option>
1172 <option>(fs)</option>
1174 <listitem>File system type.
1180 <option>fs_used</option>
1182 <option>(fs)</option>
1184 <listitem>File system used space.
1190 <option>fs_used_perc</option>
1192 <option>(fs)</option>
1194 <listitem>Percent of file system used space.
1200 <option>goto</option>
1204 <listitem>The next element will be printed at position 'x'.
1211 <option>gw_iface</option>
1214 <listitem>Displays the default route's interface or
1215 "multiple"/"none" accordingly.
1221 <option>gw_ip</option>
1224 <listitem>Displays the default gateway's IP or
1225 "multiple"/"none" accordingly.
1231 <option>hddtemp</option>
1233 <option>dev, (host,(port))</option>
1235 <listitem>Displays temperature of a selected hard disk
1236 drive as reported by the hddtemp daemon running on
1237 host:port. Default host is 127.0.0.1, default port is 7634.
1244 <option>head</option>
1246 <option>logfile lines (interval)</option>
1248 <listitem>Displays first N lines of supplied text text
1249 file. If interval is not supplied, Conky assumes 2x Conky's
1250 interval. Max of 30 lines can be displayed, or until the
1251 text buffer is filled.
1259 <option>(height)</option>
1261 <listitem>Horizontal line, height is the height in pixels
1267 <option>hwmon</option>
1269 <option>(dev) type n (factor offset)</option>
1271 <listitem>Hwmon sensor from sysfs (Linux 2.6). Parameter
1272 dev may be omitted if you have only one hwmon device.
1273 Parameter type is either 'in' or 'vol' meaning voltage;
1274 'fan' meaning fan; 'temp' meaning temperature. Parameter n
1275 is number of the sensor. See /sys/class/hwmon/ on your
1276 local computer. The optional arguments 'factor' and
1277 'offset' allow precalculation of the raw input, which is
1278 being modified as follows: 'input = input * factor +
1279 offset'. Note that they have to be given as decimal values
1280 (i.e. contain at least one decimal place).
1286 <option>i2c</option>
1288 <option>(dev) type n (factor offset)</option>
1290 <listitem>I2C sensor from sysfs (Linux 2.6). Parameter dev
1291 may be omitted if you have only one I2C device. Parameter
1292 type is either 'in' or 'vol' meaning voltage; 'fan' meaning
1293 fan; 'temp' meaning temperature. Parameter n is number of
1294 the sensor. See /sys/bus/i2c/devices/ on your local
1295 computer. The optional arguments 'factor' and 'offset'
1296 allow precalculation of the raw input, which is being
1297 modified as follows: 'input = input * factor + offset'.
1298 Note that they have to be given as decimal values (i.e.
1299 contain at least one decimal place).
1305 <option>i8k_ac_status</option>
1309 <listitem>If running the i8k kernel driver for Inspiron
1310 laptops, displays whether ac power is on, as listed in
1311 /proc/i8k (translated to human-readable). Beware that this
1312 is by default not enabled by i8k itself.
1318 <option>i8k_bios</option>
1322 <listitem>If running the i8k kernel driver for Inspiron
1323 laptops, displays the bios version as listed in /proc/i8k.
1329 <option>i8k_buttons_status</option>
1333 <listitem>If running the i8k kernel driver for Inspiron
1334 laptops, displays the volume buttons status as listed in
1341 <option>i8k_cpu_temp</option>
1345 <listitem>If running the i8k kernel driver for Inspiron
1346 laptops, displays the cpu temperature in Celsius, as
1347 reported by /proc/i8k.
1353 <option>i8k_left_fan_rpm</option>
1357 <listitem>If running the i8k kernel driver for Inspiron
1358 laptops, displays the left fan's rate of rotation, in
1359 revolutions per minute as listed in /proc/i8k. Beware, some
1360 laptops i8k reports these fans in reverse order.
1366 <option>i8k_left_fan_status</option>
1370 <listitem>If running the i8k kernel driver for Inspiron
1371 laptops, displays the left fan status as listed in
1372 /proc/i8k (translated to human-readable). Beware, some
1373 laptops i8k reports these fans in reverse order.
1379 <option>i8k_right_fan_rpm</option>
1383 <listitem>If running the i8k kernel driver for Inspiron
1384 laptops, displays the right fan's rate of rotation, in
1385 revolutions per minute as listed in /proc/i8k. Beware, some
1386 laptops i8k reports these fans in reverse order.
1392 <option>i8k_right_fan_status</option>
1396 <listitem>If running the i8k kernel driver for Inspiron
1397 laptops, displays the right fan status as listed in
1398 /proc/i8k (translated to human-readable). Beware, some
1399 laptops i8k reports these fans in reverse order.
1405 <option>i8k_serial</option>
1409 <listitem>If running the i8k kernel driver for Inspiron
1410 laptops, displays your laptop serial number as listed in
1417 <option>i8k_version</option>
1421 <listitem>If running the i8k kernel driver for Inspiron
1422 laptops, displays the version formatting of /proc/i8k.
1428 <option>ibm_brightness</option>
1431 <listitem>If running the IBM ACPI, displays the brigtness
1432 of the laptops's LCD (0-7).
1438 <option>ibm_fan</option>
1441 <listitem>If running the IBM ACPI, displays the fan speed.
1447 <option>ibm_temps</option>
1451 <listitem>If running the IBM ACPI, displays the
1452 temperatures from the IBM temperature sensors (N=0..7)
1453 Sensor 0 is on the CPU, 3 is on the GPU.
1459 <option>ibm_volume</option>
1462 <listitem>If running the IBM ACPI, displays the "master"
1463 volume, controlled by the volume keys (0-14).
1469 <option>iconv_start</option>
1471 <option>codeset_from codeset_to</option>
1473 <listitem>Convert text from one codeset to another using
1474 GNU iconv. Needs to be stopped with iconv_stop.
1480 <option>iconv_stop</option>
1484 <listitem>Stop iconv codeset conversion.
1490 <option>if_empty</option>
1492 <option>(var)</option>
1494 <listitem>if conky variable VAR is empty, display
1495 everything between $if_empty and the matching $endif
1501 <option>if_existing</option>
1503 <option>file (string)</option>
1505 <listitem>if FILE exists, display everything between
1506 if_existing and the matching $endif. The optional second
1507 paramater checks for FILE containing the specified string
1508 and prints everything between $if_existing and the matching
1515 <option>if_gw</option>
1518 <listitem>if there is at least one default gateway, display
1519 everything between $if_gw and the matching $endif
1525 <option>if_match</option>
1527 <option>expression</option>
1529 <listitem>Evaluates the given boolean expression, printing
1530 everything between $if_match and the matching $endif
1531 depending on whether the evaluation returns true or not.
1532 Valid expressions consist of a left side, an operator and a
1533 right side. Left and right sides are being parsed for
1534 contained text objects before evaluation. Recognised left
1535 and right side types are:
1538 <command>double</command>Argument consists of only
1539 digits and a single dot.</member>
1541 <command>long</command>Argument consists of only
1544 <command>string</command>Argument is enclosed in
1545 quotation mark or the checks for double and long failed
1547 </simplelist>Valid operands are: '>', '<', '>=',
1548 '<=', '==', '!='.
1554 <option>if_mixer_mute</option>
1556 <option>(mixer)</option>
1558 <listitem>If mixer exists, display everything between
1559 $if_mixer_mute and the matching $endif. If no mixer is
1560 specified, "Master" is used.
1566 <option>if_mounted</option>
1568 <option>(mountpoint)</option>
1570 <listitem>if MOUNTPOINT is mounted, display everything
1571 between $if_mounted and the matching $endif
1577 <option>if_mpd_playing</option>
1580 <listitem>if mpd is playing or paused, display everything
1581 between $if_mpd_playing and the matching $endif
1587 <option>if_running</option>
1589 <option>(process)</option>
1591 <listitem>if PROCESS is running, display everything
1592 $if_running and the matching $endif. This uses the
1593 ``pidof'' command, so the -x switch is also supported.
1599 <option>if_smapi_bat_installed</option>
1601 <option>(INDEX)</option>
1603 <listitem>when using smapi, if the battery with index INDEX
1604 is installed, display everything between
1605 $if_smapi_bat_installed and the matching $endif
1611 <option>if_up</option>
1613 <option>(interface)</option>
1615 <listitem>if INTERFACE exists and is up, display everything
1616 between $if_up and the matching $endif
1622 <option>if_updatenr</option>
1624 <option>(updatenr)</option>
1626 <listitem>If it's the UPDATENR-th time that conky updates,
1627 display everything between $if_updatenr and the matching
1628 $endif. The counter resets when the highest UPDATENR is
1629 reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr
1630 2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the
1631 time followed by bar 25% of the time followed by nothing
1632 the other half of the time.
1638 <option>if_xmms2_connected</option>
1641 <listitem>Display everything between $if_xmms2_connected
1642 and the matching $endif if xmms2 is running.
1648 <option>image</option>
1650 <option><path to image> (-p x,y) (-s WxH) (-n)
1651 (-f interval)</option>
1653 <listitem>Renders an image from the path specified using
1654 Imlib2. Takes 4 optional arguments: a position, a size, a
1655 no-cache switch, and a cache flush interval. Changing the
1656 x,y position will move the position of the image, and
1657 changing the WxH will scale the image. If you specify the
1658 no-cache flag (-n), the image will not be cached.
1659 Alternately, you can specify the -f int switch to specify a
1660 cache flust interval for a particular image. Example:
1661 ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200}
1662 will render 'cheeseburger.jpg' at (20,20) scaled to 200x200
1663 pixels. Conky does not make any attempt to adjust the
1664 position (or any other formatting) of images, they are just
1665 rendered as per the arguments passed. The only reason
1666 $image is part of the TEXT section, is to allow for runtime
1667 modifications, through $execp $lua_parse, or some other
1674 <option>imap_messages</option>
1676 <option>(args)</option>
1678 <listitem>Displays the number of messages in your global
1679 IMAP inbox by default. You can define individual IMAP
1680 inboxes seperately by passing arguments to this object.
1681 Arguments are: "host user pass [-i interval (in seconds)]
1682 [-f folder] [-p port] [-e command] [-r retries]". Default
1683 port is 143, default folder is 'INBOX', default interval is
1684 5 minutes, and default number of retries before giving up
1685 is 5. If the password is supplied as '*', you will be
1686 prompted to enter the password when Conky starts.
1692 <option>imap_unseen</option>
1694 <option>(args)</option>
1696 <listitem>Displays the number of unseen messages in your
1697 global IMAP inbox by default. You can define individual
1698 IMAP inboxes seperately by passing arguments to this
1699 object. Arguments are: "host user pass [-i interval (in
1700 seconds)] [-f folder] [-p port] [-e command] [-r retries]".
1701 Default port is 143, default folder is 'INBOX', default
1702 interval is 5 minutes, and default number of retries before
1703 giving up is 5. If the password is supplied as '*', you
1704 will be prompted to enter the password when Conky starts.
1710 <option>ioscheduler</option>
1712 <option>disk</option>
1714 <listitem>Prints the current ioscheduler used for the given
1715 disk name (i.e. e.g. "hda" or "sdb")
1721 <option>kernel</option>
1724 <listitem>Kernel version
1730 <option>laptop_mode</option>
1733 <listitem>The value of /proc/sys/vm/laptop_mode
1739 <option>lines</option>
1741 <option>textfile</option>
1743 <listitem>Displays the number of lines in the given file
1749 <option>loadavg</option>
1751 <option>(1|2|3)</option>
1753 <listitem>System load average, 1 is for past 1 minute, 2
1754 for past 5 minutes and 3 for past 15 minutes.
1760 <option>loadgraph</option>
1762 <option>(1|2|3) (height),(width) (gradient colour 1)
1763 (gradient colour 2) (scale) (-t) (-l)</option>
1765 <listitem>Load1 average graph, similar to xload, with
1766 optional colours in hex, minus the #. Uses a logarithmic
1767 scale (to see small numbers) when you use the -l switch.
1768 Takes the switch '-t' to use a temperature gradient, which
1769 makes the gradient values change depending on the amplitude
1770 of a particular graph value (try it and see).
1776 <option>lua</option>
1778 <option>function_name (function parameters)</option>
1780 <listitem>Executes a Lua function with given parameters,
1781 then prints the returned string. See also 'lua_load' on how
1788 <option>lua_bar</option>
1790 <option>(height, width) function_name (function
1791 parameters)</option>
1793 <listitem>Executes a Lua function with given parameters and
1794 draws a bar. Expects result value to be an integer between
1795 0 and 100. See also 'lua_load' on how to load scripts.
1801 <option>lua_gauge</option>
1803 <option>(height, width) function_name (function
1804 parameters)</option>
1806 <listitem>Executes a Lua function with given parameters and
1807 draws a gauge. Expects result value to be an integer
1808 between 0 and 100. See also 'lua_load' on how to load
1815 <option>lua_graph</option>
1817 <option>function_name (height),(width) (gradient colour
1818 1) (gradient colour 2) (scale) (-t) (-l)</option>
1820 <listitem>Executes a Lua function with and draws a graph.
1821 Expects result value to be any number, and by default will
1822 scale to show the full range. See also 'lua_load' on how to
1823 load scripts. Takes the switch '-t' to use a temperature
1824 gradient, which makes the gradient values change depending
1825 on the amplitude of a particular graph value (try it and
1832 <option>lua_parse</option>
1834 <option>function_name (function parameters)</option>
1836 <listitem>Executes a Lua function with given parameters as
1837 per $lua, then parses and prints the result value as per
1838 the syntax for Conky's TEXT section. See also 'lua_load' on
1839 how to load scripts.
1845 <option>lua_read_parse</option>
1849 <listitem>This function is deprecated. Please use the
1850 conky_parse() Lua function instead.
1856 <option>machine</option>
1859 <listitem>Machine, i686 for example
1865 <option>mails</option>
1867 <option>(mailbox)</option>
1868 <option>(interval)</option>
1870 <listitem>Mail count in the specified mailbox or your mail
1871 spool if not. Both mbox and maildir type mailboxes are
1872 supported. You can use a program like fetchmail to get
1873 mails from some server using your favourite protocol. See
1880 <option>mboxscan</option>
1882 <option>(-n number of messages to print) (-fw from
1883 width) (-sw subject width) mbox</option>
1885 <listitem>Print a summary of recent messages in an mbox
1886 format mailbox. mbox parameter is the filename of the
1887 mailbox (can be encapsulated using '"', ie. ${mboxscan -n
1888 10 "/home/brenden/some box"}
1894 <option>mem</option>
1897 <listitem>Amount of memory in use
1903 <option>membar</option>
1905 <option>(height),(width)</option>
1907 <listitem>Bar that shows amount of memory in use
1913 <option>memeasyfree</option>
1916 <listitem>Amount of free memory including the memory that
1917 is very easily freed (buffers/cache)
1923 <option>memfree</option>
1926 <listitem>Amount of free memory
1932 <option>memgauge</option>
1934 <option>(height),(width)</option>
1936 <listitem>Gauge that shows amount of memory in use (see
1943 <option>memgraph</option>
1945 <option>(height),(width) (gradient colour 1) (gradient
1946 colour 2) (scale) (-t) (-l)</option>
1948 <listitem>Memory usage graph. Uses a logarithmic scale (to
1949 see small numbers) when you use the -l switch. Takes the
1950 switch '-t' to use a temperature gradient, which makes the
1951 gradient values change depending on the amplitude of a
1952 particular graph value (try it and see).
1958 <option>memmax</option>
1961 <listitem>Total amount of memory
1967 <option>memperc</option>
1970 <listitem>Percentage of memory in use
1976 <option>mixer</option>
1978 <option>(device)</option>
1980 <listitem>Prints the mixer value as reported by the OS.
1981 Default mixer is "vol", but you can specify one of the
1982 following optional arguments: "vol", "bass", "treble",
1983 "synth", "pcm", "speaker", "line", "mic", "cd", "mix",
1984 "pcm2", "rec", "igain", "ogain", "line1", "line2", "line3",
1985 "dig1", "dig2", "dig3", "phin", "phout", "video", "radio",
1986 "monitor". Refer to the definition of SOUND_DEVICE_NAMES in
1987 <linux/soundcard.h> (on Linux), <soundcard.h>
1988 (on OpenBSD), or <sys/soundcard.h> to find the exact
1989 options available on your system.
1995 <option>mixerbar</option>
1997 <option>(device)</option>
1999 <listitem>Displays mixer value in a bar as reported by the
2000 OS. See docs for $mixer for details on arguments.
2006 <option>mixerl</option>
2008 <option>(device)</option>
2010 <listitem>Prints the left channel mixer value as reported
2011 by the OS. See docs for $mixer for details on arguments.
2017 <option>mixerlbar</option>
2019 <option>(device)</option>
2021 <listitem>Displays the left channel mixer value in a bar as
2022 reported by the OS. See docs for $mixer for details on
2029 <option>mixerr</option>
2031 <option>(device)</option>
2033 <listitem>Prints the right channel mixer value as reported
2034 by the OS. See docs for $mixer for details on arguments.
2040 <option>mixerrbar</option>
2042 <option>(device)</option>
2044 <listitem>Displays the right channel mixer value in a bar
2045 as reported by the OS. See docs for $mixer for details on
2052 <option>moc_album</option>
2055 <listitem>Album of the current MOC song
2061 <option>moc_artist</option>
2064 <listitem>Artist of the current MOC song
2070 <option>moc_bitrate</option>
2073 <listitem>Bitrate in the current MOC song
2079 <option>moc_curtime</option>
2082 <listitem>Current time of the current MOC song
2088 <option>moc_file</option>
2091 <listitem>File name of the current MOC song
2097 <option>moc_rate</option>
2100 <listitem>Rate of the current MOC song
2106 <option>moc_song</option>
2109 <listitem>The current song name being played in MOC.
2115 <option>moc_state</option>
2118 <listitem>Current state of MOC; playing, stopped etc.
2124 <option>moc_timeleft</option>
2127 <listitem>Time left in the current MOC song
2133 <option>moc_title</option>
2136 <listitem>Title of the current MOC song
2142 <option>moc_totaltime</option>
2145 <listitem>Total length of the current MOC song
2151 <option>monitor</option>
2154 <listitem>Number of the monitor on which conky is running
2155 or the message "Not running in X" if this is the case.
2161 <option>monitor_number</option>
2164 <listitem>Number of monitors or the message "Not running
2165 in X" if this is the case.
2171 <option>mpd_album</option>
2174 <listitem>Album in current MPD song
2180 <option>mpd_artist</option>
2183 <listitem>Artist in current MPD song must be enabled at
2190 <option>mpd_bar</option>
2192 <option>(height),(width)</option>
2194 <listitem>Bar of mpd's progress
2200 <option>mpd_bitrate</option>
2203 <listitem>Bitrate of current song
2209 <option>mpd_elapsed</option>
2212 <listitem>Song's elapsed time
2218 <option>mpd_file</option>
2221 <listitem>Prints the file name of the current MPD song
2227 <option>mpd_length</option>
2230 <listitem>Song's length
2236 <option>mpd_name</option>
2239 <listitem>Prints the MPD name field
2245 <option>mpd_percent</option>
2248 <listitem>Percent of song's progress
2254 <option>mpd_random</option>
2257 <listitem>Random status (On/Off)
2263 <option>mpd_repeat</option>
2266 <listitem>Repeat status (On/Off)
2272 <option>mpd_smart</option>
2274 <option>(max length)</option>
2276 <listitem>Prints the song name in either the form "artist -
2277 title" or file name, depending on whats available
2283 <option>mpd_status</option>
2286 <listitem>Playing, stopped, et cetera.
2292 <option>mpd_title</option>
2294 <option>(max length)</option>
2296 <listitem>Title of current MPD song
2302 <option>mpd_track</option>
2305 <listitem>Prints the MPD track field
2311 <option>mpd_vol</option>
2314 <listitem>MPD's volume
2320 <option>nameserver</option>
2322 <option>(index)</option>
2324 <listitem>Print a nameserver from /etc/resolv.conf. Index
2325 starts at and defaults to 0.
2331 <option>new_mails</option>
2333 <option>(mailbox)</option>
2334 <option>(interval)</option>
2336 <listitem>Unread mail count in the specified mailbox or
2337 mail spool if not. Both mbox and maildir type mailboxes are
2344 <option>nodename</option>
2353 <option>nvidia</option>
2355 <option>threshold</option>
2356 <option>temp</option>
2357 <option>ambient</option>
2358 <option>gpufreq</option>
2359 <option>memfreq</option>
2360 <option>imagequality</option>
2362 <listitem>Nvidia graficcard support for the XNVCtrl
2363 library. Each option can be shortened to the least
2364 significant part. Temperatures are printed as float, all
2365 other values as integer.
2368 <command>threshold</command>The thresholdtemperature at
2369 which the gpu slows down</member>
2371 <command>temp</command>Tives the gpu current
2372 temperature</member>
2374 <command>ambient</command>
2375 <option>Gives current air temperature near GPU
2379 <command>gpufreq</command>
2380 <option>Gives the current gpu frequency</option>
2383 <command>memfreq</command>
2384 <option>Gives the current mem frequency</option>
2387 <command>imagequality</command>
2388 <option>Which imagequality should be choosen by
2389 OpenGL applications</option>
2397 <option>offset</option>
2399 <option>(pixels)</option>
2401 <listitem>Move text over by N pixels. See also $voffset.
2407 <option>outlinecolor</option>
2409 <option>(color)</option>
2411 <listitem>Change outline color
2417 <option>pb_battery</option>
2419 <option>item</option>
2421 <listitem>If running on Apple powerbook/ibook, display
2422 information on battery status. The item parameter
2423 specifies, what information to display. Exactly one item
2424 must be specified. Valid items are:
2427 <command>status</command>
2428 <option>Display if battery is fully charged,
2429 charging, discharging or absent (running on
2433 <command>percent</command>
2434 <option>Display charge of battery in percent, if
2435 charging or discharging. Nothing will be displayed,
2436 if battery is fully charged or absent.</option>
2439 <command>time</command>
2440 <option>Display the time remaining until the
2441 battery will be fully charged or discharged at
2442 current rate. Nothing is displayed, if battery is
2443 absent or if it's present but fully charged and not
2444 discharging.</option>
2452 <option>platform</option>
2454 <option>(dev) type n (factor offset)</option>
2456 <listitem>Platform sensor from sysfs (Linux 2.6). Parameter
2457 dev may be omitted if you have only one platform device.
2458 Platform type is either 'in' or 'vol' meaning voltage;
2459 'fan' meaning fan; 'temp' meaning temperature. Parameter n
2460 is number of the sensor. See /sys/bus/platform/devices/ on
2461 your local computer. The optional arguments 'factor' and
2462 'offset' allow precalculation of the raw input, which is
2463 being modified as follows: 'input = input * factor +
2464 offset'. Note that they have to be given as decimal values
2465 (i.e. contain at least one decimal place).
2471 <option>pop3_unseen</option>
2473 <option>(args)</option>
2475 <listitem>Displays the number of unseen messages in your
2476 global POP3 inbox by default. You can define individual
2477 POP3 inboxes seperately by passing arguments to this
2478 object. Arguments are: "host user pass [-i interval (in
2479 seconds)] [-p port] [-e command] [-r retries]". Default
2480 port is 110, default interval is 5 minutes, and default
2481 number of retries before giving up is 5. If the password is
2482 supplied as '*', you will be prompted to enter the password
2489 <option>pop3_used</option>
2491 <option>(args)</option>
2493 <listitem>Displays the amount of space (in MiB, 2^20) used
2494 in your global POP3 inbox by default. You can define
2495 individual POP3 inboxes seperately by passing arguments to
2496 this object. Arguments are: "host user pass [-i interval
2497 (in seconds)] [-p port] [-e command] [-r retries]". Default
2498 port is 110, default interval is 5 minutes, and default
2499 number of retries before giving up is 5. If the password is
2500 supplied as '*', you will be prompted to enter the password
2507 <option>pre_exec</option>
2509 <option>shell command</option>
2511 <listitem>Executes a shell command one time before conky
2512 displays anything and puts output as text.
2518 <option>processes</option>
2521 <listitem>Total processes (sleeping and running)
2527 <option>read_tcp</option>
2529 <option>(host) port</option>
2531 <listitem>Connects to a tcp port on a host (default is
2532 localhost), reads every char available at the moment and
2539 <option>replied_mails</option>
2541 <option>(maildir)</option>
2542 <option>(interval)</option>
2544 <listitem>Number of mails marked as replied in the
2545 specified mailbox or mail spool if not. Only maildir type
2546 mailboxes are supported, mbox type will return -1.
2552 <option>rss</option>
2554 <option>url delay_in_minutes action (num_par
2555 (spaces_in_front))</option>
2557 <listitem>Download and parse RSS feeds. Action may be one
2558 of the following: feed_title, item_title (with num par),
2559 item_desc (with num par) and item_titles (when using this
2560 action and spaces_in_front is given conky places that many
2561 spaces in front of each item).
2567 <option>running_processes</option>
2570 <listitem>Running processes (not sleeping), requires Linux
2577 <option>scroll</option>
2579 <option>length (step) text</option>
2581 <listitem>Scroll 'text' by 'step' characters showing
2582 'length' number of characters at the same time. The text
2583 may also contain variables. 'step' is optional and defaults
2584 to 1 if not set. If a var creates output on multiple lines
2585 then the lines are placed behind each other separated with
2586 a '|'-sign. Do NOT use vars that change colors or otherwise
2587 affect the design inside a scrolling text. If you want
2588 spaces between the start and the end of 'text', place them
2589 at the end of 'text' not at the front ("foobar" and "
2590 foobar" can both generate "barfoo" but "foobar " will keep
2591 the spaces like this "bar foo").
2597 <option>seen_mails</option>
2599 <option>(maildir)</option>
2600 <option>(interval)</option>
2602 <listitem>Number of mails marked as seen in the specified
2603 mailbox or mail spool if not. Only maildir type mailboxes
2604 are supported, mbox type will return -1.
2610 <option>shadecolor</option>
2612 <option>(color)</option>
2614 <listitem>Change shading color
2620 <option>smapi</option>
2622 <option>(ARGS)</option>
2624 <listitem>when using smapi, display contents of the
2625 /sys/devices/platform/smapi directory. ARGS are either
2626 '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the
2627 corresponding files' content. This is a very raw method of
2628 accessing the smapi values. When available, better use one
2629 of the smapi_* variables instead.
2635 <option>smapi_bat_bar</option>
2637 <option>(INDEX),(height),(width)</option>
2639 <listitem>when using smapi, display the remaining capacity
2640 of the battery with index INDEX as a bar.
2646 <option>smapi_bat_perc</option>
2648 <option>(INDEX)</option>
2650 <listitem>when using smapi, display the remaining capacity
2651 in percent of the battery with index INDEX. This is a
2652 separate variable because it supports the 'use_spacer'
2653 configuration option.
2659 <option>smapi_bat_power</option>
2661 <option>INDEX</option>
2663 <listitem>when using smapi, display the current power of
2664 the battery with index INDEX in watt. This is a separate
2665 variable because the original read out value is being
2666 converted from mW. The sign of the output reflects charging
2667 (positive) or discharging (negative) state.
2673 <option>smapi_bat_temp</option>
2675 <option>INDEX</option>
2677 <listitem>when using smapi, display the current temperature
2678 of the battery with index INDEX in degree Celsius. This is
2679 a separate variable because the original read out value is
2680 being converted from milli degree Celsius.
2686 <option>sony_fanspeed</option>
2689 <listitem>Displays the Sony VAIO fanspeed information if
2690 sony-laptop kernel support is enabled. Linux only.
2696 <option>stippled_hr</option>
2698 <option>(space)</option>
2700 <listitem>Stippled (dashed) horizontal line
2706 <option>swap</option>
2709 <listitem>Amount of swap in use
2715 <option>swapbar</option>
2717 <option>(height),(width)</option>
2719 <listitem>Bar that shows amount of swap in use
2725 <option>swapfree</option>
2728 <listitem>Amount of free swap
2734 <option>swapmax</option>
2737 <listitem>Total amount of swap
2743 <option>swapperc</option>
2746 <listitem>Percentage of swap in use
2752 <option>sysname</option>
2755 <listitem>System name, Linux for example
2761 <option>tab</option>
2763 <option>(width, (start))</option>
2765 <listitem>Puts a tab of the specified width, starting from
2766 column 'start'. The unit is pixels for both arguments.
2772 <option>tail</option>
2774 <option>logfile lines (interval)</option>
2776 <listitem>Displays last N lines of supplied text text file.
2777 If interval is not supplied, Conky assumes 2x Conky's
2778 interval. Max of 30 lines can be displayed, or until the
2779 text buffer is filled.
2785 <option>tcp_portmon</option>
2787 <option>port_begin port_end item (index)</option>
2788 <emphasis>(ip4 only at present)</emphasis>
2791 <para>TCP port monitor for specified local ports. Port
2792 numbers must be in the range 1 to 65535. Valid items
2796 <command>count</command>
2797 <option>Total number of connections in the
2801 <command>rip</command>
2802 <option>Remote ip address</option>
2805 <command>rhost</command>
2806 <option>Remote host name</option>
2809 <command>rport</command>
2810 <option>Remote port number</option>
2813 <command>rservice</command>
2814 <option>Remote service name from
2815 /etc/services</option>
2818 <command>lip</command>
2819 <option>Local ip address</option>
2822 <command>lhost</command>
2823 <option>Local host name</option>
2826 <command>lport</command>
2827 <option>Local port number</option>
2830 <command>lservice</command>
2831 <option>Local service name from
2832 /etc/services</option>
2835 <para>The connection index provides you with access to
2836 each connection in the port monitor. The monitor will
2837 return information for index values from 0 to n-1
2838 connections. Values higher than n-1 are simply ignored.
2839 For the "count" item, the connection index must be
2840 omitted. It is required for all other items.</para>
2841 <para>Examples:</para>
2844 <command>${tcp_portmon 6881 6999
2846 <option>Displays the number of connections in
2847 the bittorrent port range</option>
2850 <command>${tcp_portmon 22 22 rip 0}</command>
2851 <option>Displays the remote host ip of the
2852 first sshd connection</option>
2855 <command>${tcp_portmon 22 22 rip 9}</command>
2856 <option>Displays the remote host ip of the
2857 tenth sshd connection</option>
2860 <command>${tcp_portmon 1 1024 rhost
2862 <option>Displays the remote host name of the
2863 first connection on a privileged port</option>
2866 <command>${tcp_portmon 1 1024 rport
2868 <option>Displays the remote host port of the
2869 fifth connection on a privileged port</option>
2872 <command>${tcp_portmon 1 65535 lservice
2874 <option>Displays the local service name of the
2875 fifteenth connection in the range of all
2879 <para>Note that port monitor variables which share the
2880 same port range actually refer to the same monitor, so
2881 many references to a single port range for different
2882 items and different indexes all use the same monitor
2883 internally. In other words, the program avoids creating
2884 redundant monitors.</para>
2890 <option>templateN</option>
2892 <option>(arg1)</option>
2893 <option>(arg2)</option>
2894 <option>(arg3 ...)</option>
2897 <para>Evaluate the content of the templateN
2898 configuration variable (where N is a value between 0
2899 and 9, inclusively), applying substitutions as
2900 described in the documentation of the corresponding
2901 configuration variable. The number of arguments is
2902 optional, but must match the highest referred index in
2903 the template. You can use the same special sequences in
2904 each argument as the ones valid for a template
2905 definition, e.g. to allow an argument to contain a
2906 whitespace. Also simple nesting of templates is
2907 possible this way.</para>
2908 <para>Here are some examples of template
2911 <member>template0 $\1\2</member>
2912 <member>template1 \1: ${fs_used \2} / ${fs_size
2914 <member>template2 \1 \2</member>
2916 <para>The following list shows sample usage of the
2917 templates defined above, with the equivalent syntax
2918 when not using any template at all:</para>
2923 <entry>using template</entry>
2924 <entry>same without template</entry>
2929 <entry>${template0 node name}</entry>
2930 <entry>$nodename</entry>
2933 <entry>${template1 root /}</entry>
2934 <entry>root: ${fs_free /} / ${fs_size
2939 <programlisting>${template1
2940 ${template2\ disk\ root}
2944 <programlisting>disk root:
2945 ${fs_free /} / ${fs_size
2957 <option>texeci</option>
2959 <option>interval command</option>
2961 <listitem>Runs a command at an interval inside a thread and
2962 displays the output. Same as $execi, except the command is
2963 run inside a thread. Use this if you have a slow script to
2964 keep Conky updating. You should make the interval slightly
2965 longer then the time it takes your script to execute. For
2966 example, if you have a script that take 5 seconds to
2967 execute, you should make the interval at least 6 seconds.
2974 <option>time</option>
2976 <option>(format)</option>
2978 <listitem>Local time, see man strftime to get more
2979 information about format
2985 <option>to_bytes</option>
2987 <option>size</option>
2989 <listitem>If 'size' is a number followed by a size-unit
2990 (kilobyte,mb,GiB,...) then it converts the size to bytes
2991 and shows it without unit, otherwise it just shows 'size'.
2997 <option>top</option>
2999 <option>type, num</option>
3001 <listitem>This takes arguments in the form:top (name)
3002 (number) Basically, processes are ranked from highest to
3003 lowest in terms of cpu usage, which is what (num)
3004 represents. The types are: "name", "pid", "cpu", "mem",
3005 "mem_res", "mem_vsize", "time", "io_perc", "io_read" and
3006 "io_write". There can be a max of 10 processes listed.
3012 <option>top_io</option>
3014 <option>type, num</option>
3016 <listitem>Same as top, except sorted by the amount of I/O
3017 the process has done during the update interval
3023 <option>top_mem</option>
3025 <option>type, num</option>
3027 <listitem>Same as top, except sorted by mem usage instead
3034 <option>top_time</option>
3036 <option>type, num</option>
3038 <listitem>Same as top, except sorted by total CPU time
3039 instead of current CPU usage
3045 <option>totaldown</option>
3047 <option>(net)</option>
3049 <listitem>Total download, overflows at 4 GB on Linux with
3050 32-bit arch and there doesn't seem to be a way to know how
3051 many times it has already done that before conky has
3058 <option>totalup</option>
3060 <option>(net)</option>
3062 <listitem>Total upload, this one too, may overflow
3068 <option>trashed_mails</option>
3070 <option>(maildir)</option>
3071 <option>(interval)</option>
3073 <listitem>Number of mails marked as trashed in the
3074 specified mailbox or mail spool if not. Only maildir type
3075 mailboxes are supported, mbox type will return -1.
3081 <option>tztime</option>
3083 <option>(timezone) (format)</option>
3085 <listitem>Local time for specified timezone, see man
3086 strftime to get more information about format. The timezone
3087 argument is specified in similar fashion as TZ environment
3088 variable. For hints, look in /usr/share/zoneinfo. e.g.
3089 US/Pacific, Europe/Zurich, etc.
3095 <option>unflagged_mails</option>
3097 <option>(maildir)</option>
3098 <option>(interval)</option>
3100 <listitem>Number of mails not marked as flagged in the
3101 specified mailbox or mail spool if not. Only maildir type
3102 mailboxes are supported, mbox type will return -1.
3108 <option>unforwarded_mails</option>
3110 <option>(maildir)</option>
3111 <option>(interval)</option>
3113 <listitem>Number of mails not marked as forwarded in the
3114 specified mailbox or mail spool if not. Only maildir type
3115 mailboxes are supported, mbox type will return -1.
3121 <option>unreplied_mails</option>
3123 <option>(maildir)</option>
3124 <option>(interval)</option>
3126 <listitem>Number of mails not marked as replied in the
3127 specified mailbox or mail spool if not. Only maildir type
3128 mailboxes are supported, mbox type will return -1.
3134 <option>unseen_mails</option>
3136 <option>(maildir)</option>
3137 <option>(interval)</option>
3139 <listitem>Number of new or unseen mails in the specified
3140 mailbox or mail spool if not. Only maildir type mailboxes
3141 are supported, mbox type will return -1.
3147 <option>updates</option>
3149 <option>Number of updates</option>
3151 <listitem>for debugging
3157 <option>upspeed</option>
3159 <option>(net)</option>
3161 <listitem>Upload speed in suitable IEC units
3167 <option>upspeedf</option>
3169 <option>(net)</option>
3171 <listitem>Upload speed in KiB with one decimal
3177 <option>upspeedgraph</option>
3179 <option>(netdev) (height),(width) (gradient colour 1)
3180 (gradient colour 2) (scale) (-t) (-l)</option>
3182 <listitem>Upload speed graph, colours defined in hex, minus
3183 the #. If scale is non-zero, it becomes the scale for the
3184 graph. Uses a logarithmic scale (to see small numbers) when
3185 you use the -l switch. Takes the switch '-t' to use a
3186 temperature gradient, which makes the gradient values
3187 change depending on the amplitude of a particular graph
3188 value (try it and see).
3194 <option>uptime</option>
3203 <option>uptime_short</option>
3206 <listitem>Uptime in a shorter format
3212 <option>user_names</option>
3215 <listitem>Lists the names of the users logged in
3221 <option>user_number</option>
3224 <listitem>Number of users logged in
3230 <option>user_terms</option>
3233 <listitem>Lists the consoles in use
3239 <option>user_times</option>
3242 <listitem>Lists how long users have been logged in for
3248 <option>utime</option>
3250 <option>(format)</option>
3252 <listitem>Display time in UTC (universal coordinate time).
3258 <option>voffset</option>
3260 <option>(pixels)</option>
3262 <listitem>Change vertical offset by N pixels. Negative
3263 values will cause text to overlap. See also $offset.
3269 <option>voltage_mv</option>
3271 <option>(n)</option>
3273 <listitem>Returns CPU #n's voltage in mV. CPUs are counted
3274 from 1. If omitted, the parameter defaults to 1.
3280 <option>voltage_v</option>
3282 <option>(n)</option>
3284 <listitem>Returns CPU #n's voltage in V. CPUs are counted
3285 from 1. If omitted, the parameter defaults to 1.
3291 <option>weather</option>
3293 <option>URI locID data_type (delay_in_minutes)</option>
3296 <para>Download, parse and display METAR data.</para>
3297 <para>For the 'URI', there are two possibilities:</para>
3300 http://weather.noaa.gov/pub/data/observations/metar/stations/
3303 http://xoap.weather.com/weather/local/
3306 <para>The first one is free to use but the second requires you to
3307 register and obtain your partner ID and license key.
3308 These two must be written, separated by a space, into a file
3309 called .xoaprc which needs to be placed into your home directory.
3311 <para>'locID' must be a valid location identifier for the required
3312 uri. For the NOAA site this must be a valid ICAO
3313 (see for instance https://pilotweb.nas.faa.gov/qryhtml/icao/).
3314 For the weather.com site this must be a valid location ID
3315 (see for instance http://aspnetresources.com/tools/locid.aspx).
3317 <para>'data_type' must be one of the following:</para>
3320 <command>last_update</command>
3321 <option>The date and time stamp of the data.
3322 The result depends on the URI used. For the NOAA site
3323 it is date (yyyy/mm/dd) and UTC time. For the
3324 weather.com one it is date ([m]m/[d]d/yy) and Local Time
3329 <command>temperature</command>
3330 <option>Air temperature (you can use the
3331 'temperature_unit' config setting to change
3335 <command>cloud_cover</command>
3336 <option>The highest cloud cover status</option>
3339 <command>pressure</command>
3340 <option>Air pressure in millibar</option>
3343 <command>wind_speed</command>
3344 <option>Wind speed in km/h</option>
3347 <command>wind_dir</command>
3348 <option>Wind direction</option>
3351 <command>wind_dir_DEG</command>
3352 <option>Compass wind direction</option>
3355 <command>humidity</command>
3356 <option>Relative humidity in %</option>
3359 <command>weather</command>
3360 <option>Any relevant weather event (rain, snow,
3361 etc.). This is not used if you are querying the
3362 weather.com site since this data is aggregated
3363 into the cloud_cover one</option>
3366 <para>'delay_in_minutes' (optional, default 30) cannot be
3367 lower than 30 min.</para>
3368 <para>Note that these variables are still EXPERIMENTAL and
3369 can be subject to many future changes.</para>
3375 <option>wireless_ap</option>
3377 <option>(net)</option>
3379 <listitem>Wireless access point MAC address (Linux only)
3385 <option>wireless_bitrate</option>
3387 <option>(net)</option>
3389 <listitem>Wireless bitrate (ie 11 Mb/s) (Linux only)
3395 <option>wireless_essid</option>
3397 <option>(net)</option>
3399 <listitem>Wireless access point ESSID (Linux only)
3405 <option>wireless_link_bar</option>
3407 <option>(height),(width) (net)</option>
3409 <listitem>Wireless link quality bar (Linux only)
3415 <option>wireless_link_qual</option>
3417 <option>(net)</option>
3419 <listitem>Wireless link quality (Linux only)
3425 <option>wireless_link_qual_max</option>
3427 <option>(net)</option>
3429 <listitem>Wireless link quality maximum value (Linux only)
3435 <option>wireless_link_qual_perc</option>
3437 <option>(net)</option>
3439 <listitem>Wireless link quality in percents (Linux only)
3445 <option>wireless_mode</option>
3447 <option>(net)</option>
3449 <listitem>Wireless mode (Managed/Ad-Hoc/Master) (Linux
3456 <option>words</option>
3458 <option>textfile</option>
3460 <listitem>Displays the number of words in the given file
3466 <option>xmms2_album</option>
3469 <listitem>Album in current XMMS2 song
3475 <option>xmms2_artist</option>
3478 <listitem>Artist in current XMMS2 song
3484 <option>xmms2_bar</option>
3486 <option>(height),(width)</option>
3488 <listitem>Bar of XMMS2's progress
3494 <option>xmms2_bitrate</option>
3497 <listitem>Bitrate of current song
3503 <option>xmms2_comment</option>
3506 <listitem>Comment in current XMMS2 song
3512 <option>xmms2_date</option>
3515 <listitem>Returns song's date.
3521 <option>xmms2_duration</option>
3524 <listitem>Duration of current song
3530 <option>xmms2_elapsed</option>
3533 <listitem>Song's elapsed time
3539 <option>xmms2_genre</option>
3542 <listitem>Genre in current XMMS2 song
3548 <option>xmms2_id</option>
3551 <listitem>XMMS2 id of current song
3557 <option>xmms2_percent</option>
3560 <listitem>Percent of song's progress
3566 <option>xmms2_playlist</option>
3569 <listitem>Returns the XMMS2 playlist.
3575 <option>xmms2_size</option>
3578 <listitem>Size of current song
3584 <option>xmms2_smart</option>
3587 <listitem>Prints the song name in either the form "artist -
3588 title" or file name, depending on whats available
3594 <option>xmms2_status</option>
3597 <listitem>XMMS2 status (Playing, Paused, Stopped, or
3604 <option>xmms2_timesplayed</option>
3607 <listitem>Number of times a song was played (presumably).
3613 <option>xmms2_title</option>
3616 <listitem>Title in current XMMS2 song
3622 <option>xmms2_tracknr</option>
3625 <listitem>Track number in current XMMS2 song
3631 <option>xmms2_url</option>
3634 <listitem>Full path to current song
projects / monky / blob