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
664 <option>desktop_name</option>
667 <listitem>Name of the desktop on which conky is running
673 <option>desktop_number</option>
676 <listitem>Number of desktops
682 <option>disk_protect</option>
684 <option>device</option>
686 <listitem>Disk protection status, if supported (needs
687 kernel-patch). Prints either "frozen" or "free " (note the
694 <option>diskio</option>
696 <option>(device)</option>
698 <listitem>Displays current disk IO. Device is optional, and
699 takes the form of sda for /dev/sda. Individual partitions
706 <option>diskio_read</option>
708 <option>(device)</option>
710 <listitem>Displays current disk IO for reads. Device as in
717 <option>diskio_write</option>
719 <option>(device)</option>
721 <listitem>Displays current disk IO for writes. Device as in
728 <option>diskiograph</option>
730 <option>(device) (height),(width) (gradient colour 1)
731 (gradient colour 2) (scale) (-t) (-l)</option>
733 <listitem>Disk IO graph, colours defined in hex, minus the
734 #. If scale is non-zero, it becomes the scale for the
735 graph. Uses a logarithmic scale (to see small numbers) when
736 you use -l switch. Takes the switch '-t' to use a
737 temperature gradient, which makes the gradient values
738 change depending on the amplitude of a particular graph
739 value (try it and see).
745 <option>diskiograph_read</option>
747 <option>(device) (height),(width) (gradient colour 1)
748 (gradient colour 2) (scale) (-t) (-l)</option>
750 <listitem>Disk IO graph for reads, colours defined in hex,
751 minus the #. If scale is non-zero, it becomes the scale for
752 the graph. Device as in diskio. Uses a logarithmic scale
753 (to see small numbers) when you use -l switch. Takes the
754 switch '-t' to use a temperature gradient, which makes the
755 gradient values change depending on the amplitude of a
756 particular graph value (try it and see).
762 <option>diskiograph_write</option>
764 <option>(device) (height),(width) (gradient colour 1)
765 (gradient colour 2) (scale) (-t) (-l)</option>
767 <listitem>Disk IO graph for writes, colours defined in hex,
768 minus the #. If scale is non-zero, it becomes the scale for
769 the graph. Device as in diskio. Uses a logarithmic scale
770 (to see small numbers) when you use -l switch. Takes the
771 switch '-t' to use a temperature gradient, which makes the
772 gradient values change depending on the amplitude of a
773 particular graph value (try it and see).
779 <option>downspeed</option>
781 <option>(net)</option>
783 <listitem>Download speed in suitable IEC units
789 <option>downspeedf</option>
791 <option>(net)</option>
793 <listitem>Download speed in KiB with one decimal
799 <option>downspeedgraph</option>
801 <option>(netdev) (height),(width) (gradient colour 1)
802 (gradient colour 2) (scale) (-t) (-l)</option>
804 <listitem>Download speed graph, colours defined in hex,
805 minus the #. If scale is non-zero, it becomes the scale for
806 the graph. Uses a logarithmic scale (to see small numbers)
807 when you use -l switch. Takes the switch '-t' to use a
808 temperature gradient, which makes the gradient values
809 change depending on the amplitude of a particular graph
810 value (try it and see).
816 <option>draft_mails</option>
818 <option>(maildir)</option>
819 <option>(interval)</option>
821 <listitem>Number of mails marked as draft in the specified
822 mailbox or mail spool if not. Only maildir type mailboxes
823 are supported, mbox type will return -1.
829 <option>else</option>
832 <listitem>Text to show if any of the above are not true
838 <option>endif</option>
842 <listitem>Ends an $if block.
848 <option>entropy_avail</option>
851 <listitem>Current entropy available for crypto freaks
857 <option>entropy_bar</option>
859 <option>(height),(width)</option>
861 <listitem>Normalized bar of available entropy for crypto
868 <option>entropy_perc</option>
871 <listitem>Percentage of entropy available in comparison to
878 <option>entropy_poolsize</option>
881 <listitem>Total size of system entropy pool for crypto
888 <option>eval</option>
890 <option>string</option>
892 <listitem>Evalutates given string according to the rules of
893 TEXT interpretation, i.e. parsing any contained text object
894 specifications into their output, any occuring '$$' into a
895 single '$' and so on. The output is then being parsed
904 <option>api_userid api_key character_id</option>
906 <listitem>Fetches your currently training skill from the
907 Eve Online API servers (http://www.eve-online.com/) and
908 displays the skill along with the remaining training time.
914 <option>exec</option>
916 <option>command</option>
918 <listitem>Executes a shell command and displays the output
919 in conky. warning: this takes a lot more resources than
920 other variables. I'd recommend coding wanted behaviour in C
927 <option>execbar</option>
929 <option>command</option>
931 <listitem>Same as exec, except if the first value return is
932 a value between 0-100, it will use that number for a bar.
933 The size for bars can be controlled via the
934 default_bar_size config setting.
940 <option>execgauge</option>
942 <option>command</option>
944 <listitem>Same as exec, except if the first value returned
945 is a value between 0-100, it will use that number for a
946 gauge. The size for gauges can be controlled via the
947 default_gauge_size config setting.
953 <option>execgraph</option>
955 <option>(-t) (-l) command</option>
957 <listitem>Same as execbar, but graphs values. Uses a
958 logaritmic scale when the log option (-l switch) is given
959 (to see small numbers). Values still have to be between 0
960 and 100. The size for graphs can be controlled via the
961 default_graph_size config setting. Takes the switch '-t' to
962 use a temperature gradient, which makes the gradient values
963 change depending on the amplitude of a particular graph
964 value (try it and see). If -t or -l is your first argument,
965 you may need to preceed it by a space (' ').
971 <option>execi</option>
973 <option>interval command</option>
975 <listitem>Same as exec but with specific interval. Interval
976 can't be less than update_interval in configuration. See
983 <option>execibar</option>
985 <option>interval command</option>
987 <listitem>Same as execbar, except with an interval
993 <option>execigauge</option>
995 <option>interval command</option>
997 <listitem>Same as execgauge, but takes an interval arg and
1004 <option>execigraph</option>
1006 <option>interval (-t) (-l) command</option>
1008 <listitem>Same as execgraph, but takes an interval arg and
1009 graphs values. If -t or -l is your first argument, you may
1010 need to preceed it by a space (' ').
1016 <option>execp</option>
1018 <option>command</option>
1020 <listitem>Executes a shell command and displays the output
1021 in conky. warning: this takes a lot more resources than
1022 other variables. I'd recommend coding wanted behaviour in C
1023 and posting a patch. This differs from $exec in that it
1024 parses the output of the command, so you can insert things
1025 like ${color red}hi!${color} in your script and have it
1026 correctly parsed by Conky. Caveats: Conky parses and
1027 evaluates the output of $execp every time Conky loops, and
1028 then destroys all the objects. If you try to use anything
1029 like $execi within an $execp statement, it will
1030 functionally run at the same interval that the $execp
1031 statement runs, as it is created and destroyed at every
1038 <option>execpi</option>
1040 <option>interval command</option>
1042 <listitem>Same as execp but with specific interval.
1043 Interval can't be less than update_interval in
1044 configuration. Note that the output from the $execpi
1045 command is still parsed and evaluated at every interval.
1051 <option>flagged_mails</option>
1053 <option>(maildir)</option>
1054 <option>(interval)</option>
1056 <listitem>Number of mails marked as flagged in the
1057 specified mailbox or mail spool if not. Only maildir type
1058 mailboxes are supported, mbox type will return -1.
1064 <option>font</option>
1066 <option>(font)</option>
1068 <listitem>Specify a different font. This new font will
1069 apply to the current line and everything following. You can
1070 use a $font with no arguments to change back to the default
1071 font (much like with $color)
1077 <option>forwarded_mails</option>
1079 <option>(maildir)</option>
1080 <option>(interval)</option>
1082 <listitem>Number of mails marked as forwarded in the
1083 specified mailbox or mail spool if not. Only maildir type
1084 mailboxes are supported, mbox type will return -1.
1090 <option>freq</option>
1092 <option>(n)</option>
1094 <listitem>Returns CPU #n's frequency in MHz. CPUs are
1095 counted from 1. If omitted, the parameter defaults to 1.
1101 <option>freq_g</option>
1103 <option>(n)</option>
1105 <listitem>Returns CPU #n's frequency in GHz. CPUs are
1106 counted from 1. If omitted, the parameter defaults to 1.
1112 <option>fs_bar</option>
1114 <option>(height),(width) fs</option>
1116 <listitem>Bar that shows how much space is used on a file
1117 system. height is the height in pixels. fs is any file on
1124 <option>fs_bar_free</option>
1126 <option>(height),(width) fs</option>
1128 <listitem>Bar that shows how much space is free on a file
1129 system. height is the height in pixels. fs is any file on
1136 <option>fs_free</option>
1138 <option>(fs)</option>
1140 <listitem>Free space on a file system available for users.
1146 <option>fs_free_perc</option>
1148 <option>(fs)</option>
1150 <listitem>Free percentage of space on a file system
1151 available for users.
1157 <option>fs_size</option>
1159 <option>(fs)</option>
1161 <listitem>File system size.
1167 <option>fs_type</option>
1169 <option>(fs)</option>
1171 <listitem>File system type.
1177 <option>fs_used</option>
1179 <option>(fs)</option>
1181 <listitem>File system used space.
1187 <option>fs_used_perc</option>
1189 <option>(fs)</option>
1191 <listitem>Percent of file system used space.
1197 <option>goto</option>
1201 <listitem>The next element will be printed at position 'x'.
1208 <option>gw_iface</option>
1211 <listitem>Displays the default route's interface or
1212 "multiple"/"none" accordingly.
1218 <option>gw_ip</option>
1221 <listitem>Displays the default gateway's IP or
1222 "multiple"/"none" accordingly.
1228 <option>hddtemp</option>
1230 <option>dev, (host,(port))</option>
1232 <listitem>Displays temperature of a selected hard disk
1233 drive as reported by the hddtemp daemon running on
1234 host:port. Default host is 127.0.0.1, default port is 7634.
1241 <option>head</option>
1243 <option>logfile lines (interval)</option>
1245 <listitem>Displays first N lines of supplied text text
1246 file. If interval is not supplied, Conky assumes 2x Conky's
1247 interval. Max of 30 lines can be displayed, or until the
1248 text buffer is filled.
1256 <option>(height)</option>
1258 <listitem>Horizontal line, height is the height in pixels
1264 <option>hwmon</option>
1266 <option>(dev) type n (factor offset)</option>
1268 <listitem>Hwmon sensor from sysfs (Linux 2.6). Parameter
1269 dev may be omitted if you have only one hwmon device.
1270 Parameter type is either 'in' or 'vol' meaning voltage;
1271 'fan' meaning fan; 'temp' meaning temperature. Parameter n
1272 is number of the sensor. See /sys/class/hwmon/ on your
1273 local computer. The optional arguments 'factor' and
1274 'offset' allow precalculation of the raw input, which is
1275 being modified as follows: 'input = input * factor +
1276 offset'. Note that they have to be given as decimal values
1277 (i.e. contain at least one decimal place).
1283 <option>i2c</option>
1285 <option>(dev) type n (factor offset)</option>
1287 <listitem>I2C sensor from sysfs (Linux 2.6). Parameter dev
1288 may be omitted if you have only one I2C device. Parameter
1289 type is either 'in' or 'vol' meaning voltage; 'fan' meaning
1290 fan; 'temp' meaning temperature. Parameter n is number of
1291 the sensor. See /sys/bus/i2c/devices/ on your local
1292 computer. The optional arguments 'factor' and 'offset'
1293 allow precalculation of the raw input, which is being
1294 modified as follows: 'input = input * factor + offset'.
1295 Note that they have to be given as decimal values (i.e.
1296 contain at least one decimal place).
1302 <option>i8k_ac_status</option>
1306 <listitem>If running the i8k kernel driver for Inspiron
1307 laptops, displays whether ac power is on, as listed in
1308 /proc/i8k (translated to human-readable). Beware that this
1309 is by default not enabled by i8k itself.
1315 <option>i8k_bios</option>
1319 <listitem>If running the i8k kernel driver for Inspiron
1320 laptops, displays the bios version as listed in /proc/i8k.
1326 <option>i8k_buttons_status</option>
1330 <listitem>If running the i8k kernel driver for Inspiron
1331 laptops, displays the volume buttons status as listed in
1338 <option>i8k_cpu_temp</option>
1342 <listitem>If running the i8k kernel driver for Inspiron
1343 laptops, displays the cpu temperature in Celsius, as
1344 reported by /proc/i8k.
1350 <option>i8k_left_fan_rpm</option>
1354 <listitem>If running the i8k kernel driver for Inspiron
1355 laptops, displays the left fan's rate of rotation, in
1356 revolutions per minute as listed in /proc/i8k. Beware, some
1357 laptops i8k reports these fans in reverse order.
1363 <option>i8k_left_fan_status</option>
1367 <listitem>If running the i8k kernel driver for Inspiron
1368 laptops, displays the left fan status as listed in
1369 /proc/i8k (translated to human-readable). Beware, some
1370 laptops i8k reports these fans in reverse order.
1376 <option>i8k_right_fan_rpm</option>
1380 <listitem>If running the i8k kernel driver for Inspiron
1381 laptops, displays the right fan's rate of rotation, in
1382 revolutions per minute as listed in /proc/i8k. Beware, some
1383 laptops i8k reports these fans in reverse order.
1389 <option>i8k_right_fan_status</option>
1393 <listitem>If running the i8k kernel driver for Inspiron
1394 laptops, displays the right fan status as listed in
1395 /proc/i8k (translated to human-readable). Beware, some
1396 laptops i8k reports these fans in reverse order.
1402 <option>i8k_serial</option>
1406 <listitem>If running the i8k kernel driver for Inspiron
1407 laptops, displays your laptop serial number as listed in
1414 <option>i8k_version</option>
1418 <listitem>If running the i8k kernel driver for Inspiron
1419 laptops, displays the version formatting of /proc/i8k.
1425 <option>ibm_brightness</option>
1428 <listitem>If running the IBM ACPI, displays the brigtness
1429 of the laptops's LCD (0-7).
1435 <option>ibm_fan</option>
1438 <listitem>If running the IBM ACPI, displays the fan speed.
1444 <option>ibm_temps</option>
1448 <listitem>If running the IBM ACPI, displays the
1449 temperatures from the IBM temperature sensors (N=0..7)
1450 Sensor 0 is on the CPU, 3 is on the GPU.
1456 <option>ibm_volume</option>
1459 <listitem>If running the IBM ACPI, displays the "master"
1460 volume, controlled by the volume keys (0-14).
1466 <option>iconv_start</option>
1468 <option>codeset_from codeset_to</option>
1470 <listitem>Convert text from one codeset to another using
1471 GNU iconv. Needs to be stopped with iconv_stop.
1477 <option>iconv_stop</option>
1481 <listitem>Stop iconv codeset conversion.
1487 <option>if_empty</option>
1489 <option>(var)</option>
1491 <listitem>if conky variable VAR is empty, display
1492 everything between $if_empty and the matching $endif
1498 <option>if_existing</option>
1500 <option>file (string)</option>
1502 <listitem>if FILE exists, display everything between
1503 if_existing and the matching $endif. The optional second
1504 paramater checks for FILE containing the specified string
1505 and prints everything between $if_existing and the matching
1512 <option>if_gw</option>
1515 <listitem>if there is at least one default gateway, display
1516 everything between $if_gw and the matching $endif
1522 <option>if_match</option>
1524 <option>expression</option>
1526 <listitem>Evaluates the given boolean expression, printing
1527 everything between $if_match and the matching $endif
1528 depending on whether the evaluation returns true or not.
1529 Valid expressions consist of a left side, an operator and a
1530 right side. Left and right sides are being parsed for
1531 contained text objects before evaluation. Recognised left
1532 and right side types are:
1535 <command>double</command>Argument consists of only
1536 digits and a single dot.</member>
1538 <command>long</command>Argument consists of only
1541 <command>string</command>Argument is enclosed in
1542 quotation mark or the checks for double and long failed
1544 </simplelist>Valid operands are: '>', '<', '>=',
1545 '<=', '==', '!='.
1551 <option>if_mixer_mute</option>
1553 <option>(mixer)</option>
1555 <listitem>If mixer exists, display everything between
1556 $if_mixer_mute and the matching $endif. If no mixer is
1557 specified, "Master" is used.
1563 <option>if_mounted</option>
1565 <option>(mountpoint)</option>
1567 <listitem>if MOUNTPOINT is mounted, display everything
1568 between $if_mounted and the matching $endif
1574 <option>if_mpd_playing</option>
1577 <listitem>if mpd is playing or paused, display everything
1578 between $if_mpd_playing and the matching $endif
1584 <option>if_running</option>
1586 <option>(process)</option>
1588 <listitem>if PROCESS is running, display everything
1589 $if_running and the matching $endif. This uses the
1590 ``pidof'' command, so the -x switch is also supported.
1596 <option>if_smapi_bat_installed</option>
1598 <option>(INDEX)</option>
1600 <listitem>when using smapi, if the battery with index INDEX
1601 is installed, display everything between
1602 $if_smapi_bat_installed and the matching $endif
1608 <option>if_up</option>
1610 <option>(interface)</option>
1612 <listitem>if INTERFACE exists and is up, display everything
1613 between $if_up and the matching $endif
1619 <option>if_updatenr</option>
1621 <option>(updatenr)</option>
1623 <listitem>If it's the UPDATENR-th time that conky updates,
1624 display everything between $if_updatenr and the matching
1625 $endif. The counter resets when the highest UPDATENR is
1626 reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr
1627 2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the
1628 time followed by bar 25% of the time followed by nothing
1629 the other half of the time.
1635 <option>if_xmms2_connected</option>
1638 <listitem>Display everything between $if_xmms2_connected
1639 and the matching $endif if xmms2 is running.
1645 <option>image</option>
1647 <option><path to image> (-p x,y) (-s WxH) (-n)
1648 (-f interval)</option>
1650 <listitem>Renders an image from the path specified using
1651 Imlib2. Takes 4 optional arguments: a position, a size, a
1652 no-cache switch, and a cache flush interval. Changing the
1653 x,y position will move the position of the image, and
1654 changing the WxH will scale the image. If you specify the
1655 no-cache flag (-n), the image will not be cached.
1656 Alternately, you can specify the -f int switch to specify a
1657 cache flust interval for a particular image. Example:
1658 ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200}
1659 will render 'cheeseburger.jpg' at (20,20) scaled to 200x200
1660 pixels. Conky does not make any attempt to adjust the
1661 position (or any other formatting) of images, they are just
1662 rendered as per the arguments passed. The only reason
1663 $image is part of the TEXT section, is to allow for runtime
1664 modifications, through $execp $lua_parse, or some other
1671 <option>imap_messages</option>
1673 <option>(args)</option>
1675 <listitem>Displays the number of messages in your global
1676 IMAP inbox by default. You can define individual IMAP
1677 inboxes seperately by passing arguments to this object.
1678 Arguments are: "host user pass [-i interval (in seconds)]
1679 [-f folder] [-p port] [-e command] [-r retries]". Default
1680 port is 143, default folder is 'INBOX', default interval is
1681 5 minutes, and default number of retries before giving up
1682 is 5. If the password is supplied as '*', you will be
1683 prompted to enter the password when Conky starts.
1689 <option>imap_unseen</option>
1691 <option>(args)</option>
1693 <listitem>Displays the number of unseen messages in your
1694 global IMAP inbox by default. You can define individual
1695 IMAP inboxes seperately by passing arguments to this
1696 object. Arguments are: "host user pass [-i interval (in
1697 seconds)] [-f folder] [-p port] [-e command] [-r retries]".
1698 Default port is 143, default folder is 'INBOX', default
1699 interval is 5 minutes, and default number of retries before
1700 giving up is 5. If the password is supplied as '*', you
1701 will be prompted to enter the password when Conky starts.
1707 <option>ioscheduler</option>
1709 <option>disk</option>
1711 <listitem>Prints the current ioscheduler used for the given
1712 disk name (i.e. e.g. "hda" or "sdb")
1718 <option>kernel</option>
1721 <listitem>Kernel version
1727 <option>laptop_mode</option>
1730 <listitem>The value of /proc/sys/vm/laptop_mode
1736 <option>lines</option>
1738 <option>textfile</option>
1740 <listitem>Displays the number of lines in the given file
1746 <option>loadavg</option>
1748 <option>(1|2|3)</option>
1750 <listitem>System load average, 1 is for past 1 minute, 2
1751 for past 5 minutes and 3 for past 15 minutes.
1757 <option>loadgraph</option>
1759 <option>(1|2|3) (height),(width) (gradient colour 1)
1760 (gradient colour 2) (scale) (-t) (-l)</option>
1762 <listitem>Load1 average graph, similar to xload, with
1763 optional colours in hex, minus the #. Uses a logarithmic
1764 scale (to see small numbers) when you use the -l switch.
1765 Takes the switch '-t' to use a temperature gradient, which
1766 makes the gradient values change depending on the amplitude
1767 of a particular graph value (try it and see).
1773 <option>lua</option>
1775 <option>function_name (function parameters)</option>
1777 <listitem>Executes a Lua function with given parameters,
1778 then prints the returned string. See also 'lua_load' on how
1785 <option>lua_bar</option>
1787 <option>(height, width) function_name (function
1788 parameters)</option>
1790 <listitem>Executes a Lua function with given parameters and
1791 draws a bar. Expects result value to be an integer between
1792 0 and 100. See also 'lua_load' on how to load scripts.
1798 <option>lua_gauge</option>
1800 <option>(height, width) function_name (function
1801 parameters)</option>
1803 <listitem>Executes a Lua function with given parameters and
1804 draws a gauge. Expects result value to be an integer
1805 between 0 and 100. See also 'lua_load' on how to load
1812 <option>lua_graph</option>
1814 <option>function_name (height),(width) (gradient colour
1815 1) (gradient colour 2) (scale) (-t) (-l)</option>
1817 <listitem>Executes a Lua function with and draws a graph.
1818 Expects result value to be any number, and by default will
1819 scale to show the full range. See also 'lua_load' on how to
1820 load scripts. Takes the switch '-t' to use a temperature
1821 gradient, which makes the gradient values change depending
1822 on the amplitude of a particular graph value (try it and
1829 <option>lua_parse</option>
1831 <option>function_name (function parameters)</option>
1833 <listitem>Executes a Lua function with given parameters as
1834 per $lua, then parses and prints the result value as per
1835 the syntax for Conky's TEXT section. See also 'lua_load' on
1836 how to load scripts.
1842 <option>lua_read_parse</option>
1846 <listitem>This function is deprecated. Please use the
1847 conky_parse() Lua function instead.
1853 <option>machine</option>
1856 <listitem>Machine, i686 for example
1862 <option>mails</option>
1864 <option>(mailbox)</option>
1865 <option>(interval)</option>
1867 <listitem>Mail count in the specified mailbox or your mail
1868 spool if not. Both mbox and maildir type mailboxes are
1869 supported. You can use a program like fetchmail to get
1870 mails from some server using your favourite protocol. See
1877 <option>mboxscan</option>
1879 <option>(-n number of messages to print) (-fw from
1880 width) (-sw subject width) mbox</option>
1882 <listitem>Print a summary of recent messages in an mbox
1883 format mailbox. mbox parameter is the filename of the
1884 mailbox (can be encapsulated using '"', ie. ${mboxscan -n
1885 10 "/home/brenden/some box"}
1891 <option>mem</option>
1894 <listitem>Amount of memory in use
1900 <option>membar</option>
1902 <option>(height),(width)</option>
1904 <listitem>Bar that shows amount of memory in use
1910 <option>memeasyfree</option>
1913 <listitem>Amount of free memory including the memory that
1914 is very easily freed (buffers/cache)
1920 <option>memfree</option>
1923 <listitem>Amount of free memory
1929 <option>memgauge</option>
1931 <option>(height),(width)</option>
1933 <listitem>Gauge that shows amount of memory in use (see
1940 <option>memgraph</option>
1942 <option>(height),(width) (gradient colour 1) (gradient
1943 colour 2) (scale) (-t) (-l)</option>
1945 <listitem>Memory usage graph. Uses a logarithmic scale (to
1946 see small numbers) when you use the -l switch. Takes the
1947 switch '-t' to use a temperature gradient, which makes the
1948 gradient values change depending on the amplitude of a
1949 particular graph value (try it and see).
1955 <option>memmax</option>
1958 <listitem>Total amount of memory
1964 <option>memperc</option>
1967 <listitem>Percentage of memory in use
1973 <option>mixer</option>
1975 <option>(device)</option>
1977 <listitem>Prints the mixer value as reported by the OS.
1978 Default mixer is "vol", but you can specify one of the
1979 following optional arguments: "vol", "bass", "treble",
1980 "synth", "pcm", "speaker", "line", "mic", "cd", "mix",
1981 "pcm2", "rec", "igain", "ogain", "line1", "line2", "line3",
1982 "dig1", "dig2", "dig3", "phin", "phout", "video", "radio",
1983 "monitor". Refer to the definition of SOUND_DEVICE_NAMES in
1984 <linux/soundcard.h> (on Linux), <soundcard.h>
1985 (on OpenBSD), or <sys/soundcard.h> to find the exact
1986 options available on your system.
1992 <option>mixerbar</option>
1994 <option>(device)</option>
1996 <listitem>Displays mixer value in a bar as reported by the
1997 OS. See docs for $mixer for details on arguments.
2003 <option>mixerl</option>
2005 <option>(device)</option>
2007 <listitem>Prints the left channel mixer value as reported
2008 by the OS. See docs for $mixer for details on arguments.
2014 <option>mixerlbar</option>
2016 <option>(device)</option>
2018 <listitem>Displays the left channel mixer value in a bar as
2019 reported by the OS. See docs for $mixer for details on
2026 <option>mixerr</option>
2028 <option>(device)</option>
2030 <listitem>Prints the right channel mixer value as reported
2031 by the OS. See docs for $mixer for details on arguments.
2037 <option>mixerrbar</option>
2039 <option>(device)</option>
2041 <listitem>Displays the right channel mixer value in a bar
2042 as reported by the OS. See docs for $mixer for details on
2049 <option>moc_album</option>
2052 <listitem>Album of the current MOC song
2058 <option>moc_artist</option>
2061 <listitem>Artist of the current MOC song
2067 <option>moc_bitrate</option>
2070 <listitem>Bitrate in the current MOC song
2076 <option>moc_curtime</option>
2079 <listitem>Current time of the current MOC song
2085 <option>moc_file</option>
2088 <listitem>File name of the current MOC song
2094 <option>moc_rate</option>
2097 <listitem>Rate of the current MOC song
2103 <option>moc_song</option>
2106 <listitem>The current song name being played in MOC.
2112 <option>moc_state</option>
2115 <listitem>Current state of MOC; playing, stopped etc.
2121 <option>moc_timeleft</option>
2124 <listitem>Time left in the current MOC song
2130 <option>moc_title</option>
2133 <listitem>Title of the current MOC song
2139 <option>moc_totaltime</option>
2142 <listitem>Total length of the current MOC song
2148 <option>monitor</option>
2151 <listitem>Number of the monitor on which conky is running
2157 <option>monitor_number</option>
2160 <listitem>Number of monitors
2166 <option>mpd_album</option>
2169 <listitem>Album in current MPD song
2175 <option>mpd_artist</option>
2178 <listitem>Artist in current MPD song must be enabled at
2185 <option>mpd_bar</option>
2187 <option>(height),(width)</option>
2189 <listitem>Bar of mpd's progress
2195 <option>mpd_bitrate</option>
2198 <listitem>Bitrate of current song
2204 <option>mpd_elapsed</option>
2207 <listitem>Song's elapsed time
2213 <option>mpd_file</option>
2216 <listitem>Prints the file name of the current MPD song
2222 <option>mpd_length</option>
2225 <listitem>Song's length
2231 <option>mpd_name</option>
2234 <listitem>Prints the MPD name field
2240 <option>mpd_percent</option>
2243 <listitem>Percent of song's progress
2249 <option>mpd_random</option>
2252 <listitem>Random status (On/Off)
2258 <option>mpd_repeat</option>
2261 <listitem>Repeat status (On/Off)
2267 <option>mpd_smart</option>
2269 <option>(max length)</option>
2271 <listitem>Prints the song name in either the form "artist -
2272 title" or file name, depending on whats available
2278 <option>mpd_status</option>
2281 <listitem>Playing, stopped, et cetera.
2287 <option>mpd_title</option>
2289 <option>(max length)</option>
2291 <listitem>Title of current MPD song
2297 <option>mpd_track</option>
2300 <listitem>Prints the MPD track field
2306 <option>mpd_vol</option>
2309 <listitem>MPD's volume
2315 <option>nameserver</option>
2317 <option>(index)</option>
2319 <listitem>Print a nameserver from /etc/resolv.conf. Index
2320 starts at and defaults to 0.
2326 <option>new_mails</option>
2328 <option>(mailbox)</option>
2329 <option>(interval)</option>
2331 <listitem>Unread mail count in the specified mailbox or
2332 mail spool if not. Both mbox and maildir type mailboxes are
2339 <option>nodename</option>
2348 <option>nvidia</option>
2350 <option>threshold</option>
2351 <option>temp</option>
2352 <option>ambient</option>
2353 <option>gpufreq</option>
2354 <option>memfreq</option>
2355 <option>imagequality</option>
2357 <listitem>Nvidia graficcard support for the XNVCtrl
2358 library. Each option can be shortened to the least
2359 significant part. Temperatures are printed as float, all
2360 other values as integer.
2363 <command>threshold</command>The thresholdtemperature at
2364 which the gpu slows down</member>
2366 <command>temp</command>Tives the gpu current
2367 temperature</member>
2369 <command>ambient</command>
2370 <option>Gives current air temperature near GPU
2374 <command>gpufreq</command>
2375 <option>Gives the current gpu frequency</option>
2378 <command>memfreq</command>
2379 <option>Gives the current mem frequency</option>
2382 <command>imagequality</command>
2383 <option>Which imagequality should be choosen by
2384 OpenGL applications</option>
2392 <option>offset</option>
2394 <option>(pixels)</option>
2396 <listitem>Move text over by N pixels. See also $voffset.
2402 <option>outlinecolor</option>
2404 <option>(color)</option>
2406 <listitem>Change outline color
2412 <option>pb_battery</option>
2414 <option>item</option>
2416 <listitem>If running on Apple powerbook/ibook, display
2417 information on battery status. The item parameter
2418 specifies, what information to display. Exactly one item
2419 must be specified. Valid items are:
2422 <command>status</command>
2423 <option>Display if battery is fully charged,
2424 charging, discharging or absent (running on
2428 <command>percent</command>
2429 <option>Display charge of battery in percent, if
2430 charging or discharging. Nothing will be displayed,
2431 if battery is fully charged or absent.</option>
2434 <command>time</command>
2435 <option>Display the time remaining until the
2436 battery will be fully charged or discharged at
2437 current rate. Nothing is displayed, if battery is
2438 absent or if it's present but fully charged and not
2439 discharging.</option>
2447 <option>platform</option>
2449 <option>(dev) type n (factor offset)</option>
2451 <listitem>Platform sensor from sysfs (Linux 2.6). Parameter
2452 dev may be omitted if you have only one platform device.
2453 Platform type is either 'in' or 'vol' meaning voltage;
2454 'fan' meaning fan; 'temp' meaning temperature. Parameter n
2455 is number of the sensor. See /sys/bus/platform/devices/ on
2456 your local computer. The optional arguments 'factor' and
2457 'offset' allow precalculation of the raw input, which is
2458 being modified as follows: 'input = input * factor +
2459 offset'. Note that they have to be given as decimal values
2460 (i.e. contain at least one decimal place).
2466 <option>pop3_unseen</option>
2468 <option>(args)</option>
2470 <listitem>Displays the number of unseen messages in your
2471 global POP3 inbox by default. You can define individual
2472 POP3 inboxes seperately by passing arguments to this
2473 object. Arguments are: "host user pass [-i interval (in
2474 seconds)] [-p port] [-e command] [-r retries]". Default
2475 port is 110, default interval is 5 minutes, and default
2476 number of retries before giving up is 5. If the password is
2477 supplied as '*', you will be prompted to enter the password
2484 <option>pop3_used</option>
2486 <option>(args)</option>
2488 <listitem>Displays the amount of space (in MiB, 2^20) used
2489 in your global POP3 inbox by default. You can define
2490 individual POP3 inboxes seperately by passing arguments to
2491 this object. Arguments are: "host user pass [-i interval
2492 (in seconds)] [-p port] [-e command] [-r retries]". Default
2493 port is 110, default interval is 5 minutes, and default
2494 number of retries before giving up is 5. If the password is
2495 supplied as '*', you will be prompted to enter the password
2502 <option>pre_exec</option>
2504 <option>shell command</option>
2506 <listitem>Executes a shell command one time before conky
2507 displays anything and puts output as text.
2513 <option>processes</option>
2516 <listitem>Total processes (sleeping and running)
2522 <option>read_tcp</option>
2524 <option>(host) port</option>
2526 <listitem>Connects to a tcp port on a host (default is
2527 localhost), reads every char available at the moment and
2534 <option>replied_mails</option>
2536 <option>(maildir)</option>
2537 <option>(interval)</option>
2539 <listitem>Number of mails marked as replied in the
2540 specified mailbox or mail spool if not. Only maildir type
2541 mailboxes are supported, mbox type will return -1.
2547 <option>rss</option>
2549 <option>url delay_in_minutes action (num_par
2550 (spaces_in_front))</option>
2552 <listitem>Download and parse RSS feeds. Action may be one
2553 of the following: feed_title, item_title (with num par),
2554 item_desc (with num par) and item_titles (when using this
2555 action and spaces_in_front is given conky places that many
2556 spaces in front of each item).
2562 <option>running_processes</option>
2565 <listitem>Running processes (not sleeping), requires Linux
2572 <option>scroll</option>
2574 <option>length (step) text</option>
2576 <listitem>Scroll 'text' by 'step' characters showing
2577 'length' number of characters at the same time. The text
2578 may also contain variables. 'step' is optional and defaults
2579 to 1 if not set. If a var creates output on multiple lines
2580 then the lines are placed behind each other separated with
2581 a '|'-sign. Do NOT use vars that change colors or otherwise
2582 affect the design inside a scrolling text. If you want
2583 spaces between the start and the end of 'text', place them
2584 at the end of 'text' not at the front ("foobar" and "
2585 foobar" can both generate "barfoo" but "foobar " will keep
2586 the spaces like this "bar foo").
2592 <option>seen_mails</option>
2594 <option>(maildir)</option>
2595 <option>(interval)</option>
2597 <listitem>Number of mails marked as seen in the specified
2598 mailbox or mail spool if not. Only maildir type mailboxes
2599 are supported, mbox type will return -1.
2605 <option>shadecolor</option>
2607 <option>(color)</option>
2609 <listitem>Change shading color
2615 <option>smapi</option>
2617 <option>(ARGS)</option>
2619 <listitem>when using smapi, display contents of the
2620 /sys/devices/platform/smapi directory. ARGS are either
2621 '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the
2622 corresponding files' content. This is a very raw method of
2623 accessing the smapi values. When available, better use one
2624 of the smapi_* variables instead.
2630 <option>smapi_bat_bar</option>
2632 <option>(INDEX),(height),(width)</option>
2634 <listitem>when using smapi, display the remaining capacity
2635 of the battery with index INDEX as a bar.
2641 <option>smapi_bat_perc</option>
2643 <option>(INDEX)</option>
2645 <listitem>when using smapi, display the remaining capacity
2646 in percent of the battery with index INDEX. This is a
2647 separate variable because it supports the 'use_spacer'
2648 configuration option.
2654 <option>smapi_bat_power</option>
2656 <option>INDEX</option>
2658 <listitem>when using smapi, display the current power of
2659 the battery with index INDEX in watt. This is a separate
2660 variable because the original read out value is being
2661 converted from mW. The sign of the output reflects charging
2662 (positive) or discharging (negative) state.
2668 <option>smapi_bat_temp</option>
2670 <option>INDEX</option>
2672 <listitem>when using smapi, display the current temperature
2673 of the battery with index INDEX in degree Celsius. This is
2674 a separate variable because the original read out value is
2675 being converted from milli degree Celsius.
2681 <option>sony_fanspeed</option>
2684 <listitem>Displays the Sony VAIO fanspeed information if
2685 sony-laptop kernel support is enabled. Linux only.
2691 <option>stippled_hr</option>
2693 <option>(space)</option>
2695 <listitem>Stippled (dashed) horizontal line
2701 <option>swap</option>
2704 <listitem>Amount of swap in use
2710 <option>swapbar</option>
2712 <option>(height),(width)</option>
2714 <listitem>Bar that shows amount of swap in use
2720 <option>swapfree</option>
2723 <listitem>Amount of free swap
2729 <option>swapmax</option>
2732 <listitem>Total amount of swap
2738 <option>swapperc</option>
2741 <listitem>Percentage of swap in use
2747 <option>sysname</option>
2750 <listitem>System name, Linux for example
2756 <option>tab</option>
2758 <option>(width, (start))</option>
2760 <listitem>Puts a tab of the specified width, starting from
2761 column 'start'. The unit is pixels for both arguments.
2767 <option>tail</option>
2769 <option>logfile lines (interval)</option>
2771 <listitem>Displays last N lines of supplied text text file.
2772 If interval is not supplied, Conky assumes 2x Conky's
2773 interval. Max of 30 lines can be displayed, or until the
2774 text buffer is filled.
2780 <option>tcp_portmon</option>
2782 <option>port_begin port_end item (index)</option>
2783 <emphasis>(ip4 only at present)</emphasis>
2786 <para>TCP port monitor for specified local ports. Port
2787 numbers must be in the range 1 to 65535. Valid items
2791 <command>count</command>
2792 <option>Total number of connections in the
2796 <command>rip</command>
2797 <option>Remote ip address</option>
2800 <command>rhost</command>
2801 <option>Remote host name</option>
2804 <command>rport</command>
2805 <option>Remote port number</option>
2808 <command>rservice</command>
2809 <option>Remote service name from
2810 /etc/services</option>
2813 <command>lip</command>
2814 <option>Local ip address</option>
2817 <command>lhost</command>
2818 <option>Local host name</option>
2821 <command>lport</command>
2822 <option>Local port number</option>
2825 <command>lservice</command>
2826 <option>Local service name from
2827 /etc/services</option>
2830 <para>The connection index provides you with access to
2831 each connection in the port monitor. The monitor will
2832 return information for index values from 0 to n-1
2833 connections. Values higher than n-1 are simply ignored.
2834 For the "count" item, the connection index must be
2835 omitted. It is required for all other items.</para>
2836 <para>Examples:</para>
2839 <command>${tcp_portmon 6881 6999
2841 <option>Displays the number of connections in
2842 the bittorrent port range</option>
2845 <command>${tcp_portmon 22 22 rip 0}</command>
2846 <option>Displays the remote host ip of the
2847 first sshd connection</option>
2850 <command>${tcp_portmon 22 22 rip 9}</command>
2851 <option>Displays the remote host ip of the
2852 tenth sshd connection</option>
2855 <command>${tcp_portmon 1 1024 rhost
2857 <option>Displays the remote host name of the
2858 first connection on a privileged port</option>
2861 <command>${tcp_portmon 1 1024 rport
2863 <option>Displays the remote host port of the
2864 fifth connection on a privileged port</option>
2867 <command>${tcp_portmon 1 65535 lservice
2869 <option>Displays the local service name of the
2870 fifteenth connection in the range of all
2874 <para>Note that port monitor variables which share the
2875 same port range actually refer to the same monitor, so
2876 many references to a single port range for different
2877 items and different indexes all use the same monitor
2878 internally. In other words, the program avoids creating
2879 redundant monitors.</para>
2885 <option>templateN</option>
2887 <option>(arg1)</option>
2888 <option>(arg2)</option>
2889 <option>(arg3 ...)</option>
2892 <para>Evaluate the content of the templateN
2893 configuration variable (where N is a value between 0
2894 and 9, inclusively), applying substitutions as
2895 described in the documentation of the corresponding
2896 configuration variable. The number of arguments is
2897 optional, but must match the highest referred index in
2898 the template. You can use the same special sequences in
2899 each argument as the ones valid for a template
2900 definition, e.g. to allow an argument to contain a
2901 whitespace. Also simple nesting of templates is
2902 possible this way.</para>
2903 <para>Here are some examples of template
2906 <member>template0 $\1\2</member>
2907 <member>template1 \1: ${fs_used \2} / ${fs_size
2909 <member>template2 \1 \2</member>
2911 <para>The following list shows sample usage of the
2912 templates defined above, with the equivalent syntax
2913 when not using any template at all:</para>
2918 <entry>using template</entry>
2919 <entry>same without template</entry>
2924 <entry>${template0 node name}</entry>
2925 <entry>$nodename</entry>
2928 <entry>${template1 root /}</entry>
2929 <entry>root: ${fs_free /} / ${fs_size
2934 <programlisting>${template1
2935 ${template2\ disk\ root}
2939 <programlisting>disk root:
2940 ${fs_free /} / ${fs_size
2952 <option>texeci</option>
2954 <option>interval command</option>
2956 <listitem>Runs a command at an interval inside a thread and
2957 displays the output. Same as $execi, except the command is
2958 run inside a thread. Use this if you have a slow script to
2959 keep Conky updating. You should make the interval slightly
2960 longer then the time it takes your script to execute. For
2961 example, if you have a script that take 5 seconds to
2962 execute, you should make the interval at least 6 seconds.
2969 <option>time</option>
2971 <option>(format)</option>
2973 <listitem>Local time, see man strftime to get more
2974 information about format
2980 <option>to_bytes</option>
2982 <option>size</option>
2984 <listitem>If 'size' is a number followed by a size-unit
2985 (kilobyte,mb,GiB,...) then it converts the size to bytes
2986 and shows it without unit, otherwise it just shows 'size'.
2992 <option>top</option>
2994 <option>type, num</option>
2996 <listitem>This takes arguments in the form:top (name)
2997 (number) Basically, processes are ranked from highest to
2998 lowest in terms of cpu usage, which is what (num)
2999 represents. The types are: "name", "pid", "cpu", "mem",
3000 "mem_res", "mem_vsize", "time", "io_perc", "io_read" and
3001 "io_write". There can be a max of 10 processes listed.
3007 <option>top_io</option>
3009 <option>type, num</option>
3011 <listitem>Same as top, except sorted by the amount of I/O
3012 the process has done during the update interval
3018 <option>top_mem</option>
3020 <option>type, num</option>
3022 <listitem>Same as top, except sorted by mem usage instead
3029 <option>top_time</option>
3031 <option>type, num</option>
3033 <listitem>Same as top, except sorted by total CPU time
3034 instead of current CPU usage
3040 <option>totaldown</option>
3042 <option>(net)</option>
3044 <listitem>Total download, overflows at 4 GB on Linux with
3045 32-bit arch and there doesn't seem to be a way to know how
3046 many times it has already done that before conky has
3053 <option>totalup</option>
3055 <option>(net)</option>
3057 <listitem>Total upload, this one too, may overflow
3063 <option>trashed_mails</option>
3065 <option>(maildir)</option>
3066 <option>(interval)</option>
3068 <listitem>Number of mails marked as trashed in the
3069 specified mailbox or mail spool if not. Only maildir type
3070 mailboxes are supported, mbox type will return -1.
3076 <option>tztime</option>
3078 <option>(timezone) (format)</option>
3080 <listitem>Local time for specified timezone, see man
3081 strftime to get more information about format. The timezone
3082 argument is specified in similar fashion as TZ environment
3083 variable. For hints, look in /usr/share/zoneinfo. e.g.
3084 US/Pacific, Europe/Zurich, etc.
3090 <option>unflagged_mails</option>
3092 <option>(maildir)</option>
3093 <option>(interval)</option>
3095 <listitem>Number of mails not marked as flagged in the
3096 specified mailbox or mail spool if not. Only maildir type
3097 mailboxes are supported, mbox type will return -1.
3103 <option>unforwarded_mails</option>
3105 <option>(maildir)</option>
3106 <option>(interval)</option>
3108 <listitem>Number of mails not marked as forwarded in the
3109 specified mailbox or mail spool if not. Only maildir type
3110 mailboxes are supported, mbox type will return -1.
3116 <option>unreplied_mails</option>
3118 <option>(maildir)</option>
3119 <option>(interval)</option>
3121 <listitem>Number of mails not marked as replied in the
3122 specified mailbox or mail spool if not. Only maildir type
3123 mailboxes are supported, mbox type will return -1.
3129 <option>unseen_mails</option>
3131 <option>(maildir)</option>
3132 <option>(interval)</option>
3134 <listitem>Number of new or unseen mails in the specified
3135 mailbox or mail spool if not. Only maildir type mailboxes
3136 are supported, mbox type will return -1.
3142 <option>updates</option>
3144 <option>Number of updates</option>
3146 <listitem>for debugging
3152 <option>upspeed</option>
3154 <option>(net)</option>
3156 <listitem>Upload speed in suitable IEC units
3162 <option>upspeedf</option>
3164 <option>(net)</option>
3166 <listitem>Upload speed in KiB with one decimal
3172 <option>upspeedgraph</option>
3174 <option>(netdev) (height),(width) (gradient colour 1)
3175 (gradient colour 2) (scale) (-t) (-l)</option>
3177 <listitem>Upload speed graph, colours defined in hex, minus
3178 the #. If scale is non-zero, it becomes the scale for the
3179 graph. Uses a logarithmic scale (to see small numbers) when
3180 you use the -l switch. Takes the switch '-t' to use a
3181 temperature gradient, which makes the gradient values
3182 change depending on the amplitude of a particular graph
3183 value (try it and see).
3189 <option>uptime</option>
3198 <option>uptime_short</option>
3201 <listitem>Uptime in a shorter format
3207 <option>user_names</option>
3210 <listitem>Lists the names of the users logged in
3216 <option>user_number</option>
3219 <listitem>Number of users logged in
3225 <option>user_terms</option>
3228 <listitem>Lists the consoles in use
3234 <option>user_times</option>
3237 <listitem>Lists how long users have been logged in for
3243 <option>utime</option>
3245 <option>(format)</option>
3247 <listitem>Display time in UTC (universal coordinate time).
3253 <option>voffset</option>
3255 <option>(pixels)</option>
3257 <listitem>Change vertical offset by N pixels. Negative
3258 values will cause text to overlap. See also $offset.
3264 <option>voltage_mv</option>
3266 <option>(n)</option>
3268 <listitem>Returns CPU #n's voltage in mV. CPUs are counted
3269 from 1. If omitted, the parameter defaults to 1.
3275 <option>voltage_v</option>
3277 <option>(n)</option>
3279 <listitem>Returns CPU #n's voltage in V. CPUs are counted
3280 from 1. If omitted, the parameter defaults to 1.
3286 <option>weather</option>
3288 <option>URI icao data_type (delay_in_minutes)</option>
3291 <para>Download, parse and display METAR data.</para>
3292 <para>For the URI, you can use any METAR source, but
3294 http://weather.noaa.gov/pub/data/observations/metar/stations/
3295 (from the US NOAA).</para>
3296 icao must be a valid icao for the required location
3297 (see for instance https://pilotweb.nas.faa.gov/qryhtml/icao/).
3298 <para>'data_type' must be one of the following:</para>
3301 <command>last_update</command>
3302 <option>The date (yyyy/mm/dd) and time (UTC) of
3303 the last update</option>
3306 <command>temperature</command>
3307 <option>Air temperature (you can use the
3308 'temperature_unit' config setting to change
3312 <command>cloud_cover</command>
3313 <option>The highest cloud cover status</option>
3316 <command>pressurer</command>
3317 <option>Air pressure in millibar</option>
3320 <command>wind_speed</command>
3321 <option>Wind speed in km/h</option>
3324 <command>wind_dir</command>
3325 <option>Wind direction</option>
3328 <command>wind_dir_DEG</command>
3329 <option>Compass wind direction</option>
3332 <command>humidity</command>
3333 <option>Relative humidity in %</option>
3336 <command>weather</command>
3337 <option>Any relevant weather event (rain, snow,
3341 <para>delay_in_minutes (optional, default 30) cannot be
3342 lower than 30 min.</para>
3343 <para>Note that this feature is still EXPERIMENTAL.</para>
3349 <option>wireless_ap</option>
3351 <option>(net)</option>
3353 <listitem>Wireless access point MAC address (Linux only)
3359 <option>wireless_bitrate</option>
3361 <option>(net)</option>
3363 <listitem>Wireless bitrate (ie 11 Mb/s) (Linux only)
3369 <option>wireless_essid</option>
3371 <option>(net)</option>
3373 <listitem>Wireless access point ESSID (Linux only)
3379 <option>wireless_link_bar</option>
3381 <option>(height),(width) (net)</option>
3383 <listitem>Wireless link quality bar (Linux only)
3389 <option>wireless_link_qual</option>
3391 <option>(net)</option>
3393 <listitem>Wireless link quality (Linux only)
3399 <option>wireless_link_qual_max</option>
3401 <option>(net)</option>
3403 <listitem>Wireless link quality maximum value (Linux only)
3409 <option>wireless_link_qual_perc</option>
3411 <option>(net)</option>
3413 <listitem>Wireless link quality in percents (Linux only)
3419 <option>wireless_mode</option>
3421 <option>(net)</option>
3423 <listitem>Wireless mode (Managed/Ad-Hoc/Master) (Linux
3430 <option>words</option>
3432 <option>textfile</option>
3434 <listitem>Displays the number of words in the given file
3440 <option>xmms2_album</option>
3443 <listitem>Album in current XMMS2 song
3449 <option>xmms2_artist</option>
3452 <listitem>Artist in current XMMS2 song
3458 <option>xmms2_bar</option>
3460 <option>(height),(width)</option>
3462 <listitem>Bar of XMMS2's progress
3468 <option>xmms2_bitrate</option>
3471 <listitem>Bitrate of current song
3477 <option>xmms2_comment</option>
3480 <listitem>Comment in current XMMS2 song
3486 <option>xmms2_date</option>
3489 <listitem>Returns song's date.
3495 <option>xmms2_duration</option>
3498 <listitem>Duration of current song
3504 <option>xmms2_elapsed</option>
3507 <listitem>Song's elapsed time
3513 <option>xmms2_genre</option>
3516 <listitem>Genre in current XMMS2 song
3522 <option>xmms2_id</option>
3525 <listitem>XMMS2 id of current song
3531 <option>xmms2_percent</option>
3534 <listitem>Percent of song's progress
3540 <option>xmms2_playlist</option>
3543 <listitem>Returns the XMMS2 playlist.
3549 <option>xmms2_size</option>
3552 <listitem>Size of current song
3558 <option>xmms2_smart</option>
3561 <listitem>Prints the song name in either the form "artist -
3562 title" or file name, depending on whats available
3568 <option>xmms2_status</option>
3571 <listitem>XMMS2 status (Playing, Paused, Stopped, or
3578 <option>xmms2_timesplayed</option>
3581 <listitem>Number of times a song was played (presumably).
3587 <option>xmms2_title</option>
3590 <listitem>Title in current XMMS2 song
3596 <option>xmms2_tracknr</option>
3599 <listitem>Track number in current XMMS2 song
3605 <option>xmms2_url</option>
3608 <listitem>Full path to current song
projects / monky / blob