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>("normal"|"log") (height),(width) (gradient
171 colour 1) (gradient colour 2) (scale) (-t)</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) ("normal"|"log") (height),(width)
641 (gradient colour 1) (gradient colour 2) (scale)
644 <listitem>CPU usage graph, with optional colours in hex,
645 minus the #. See $cpu for more info on SMP. Uses a
646 logarithmic scale (to see small numbers) when you use "log"
647 instead of "normal". Takes the switch '-t' to use a
648 temperature gradient, which makes the gradient values
649 change depending on the amplitude of a particular graph
650 value (try it and see).
656 <option>disk_protect</option>
658 <option>device</option>
660 <listitem>Disk protection status, if supported (needs
661 kernel-patch). Prints either "frozen" or "free " (note the
668 <option>diskio</option>
670 <option>(device)</option>
672 <listitem>Displays current disk IO. Device is optional, and
673 takes the form of sda for /dev/sda. Individual partitions
680 <option>diskio_read</option>
682 <option>(device)</option>
684 <listitem>Displays current disk IO for reads. Device as in
691 <option>diskio_write</option>
693 <option>(device)</option>
695 <listitem>Displays current disk IO for writes. Device as in
702 <option>diskiograph</option>
704 <option>(device) ("normal"|"log") (height),(width)
705 (gradient colour 1) (gradient colour 2) (scale)
708 <listitem>Disk IO graph, colours defined in hex, minus the
709 #. If scale is non-zero, it becomes the scale for the
710 graph. Uses a logarithmic scale (to see small numbers) when
711 you use "log" instead of "normal". Takes the switch '-t' to
712 use a temperature gradient, which makes the gradient values
713 change depending on the amplitude of a particular graph
714 value (try it and see).
720 <option>diskiograph_read</option>
722 <option>(device) ("normal"|"log") (height),(width)
723 (gradient colour 1) (gradient colour 2) (scale)
726 <listitem>Disk IO graph for reads, colours defined in hex,
727 minus the #. If scale is non-zero, it becomes the scale for
728 the graph. Device as in diskio. Uses a logarithmic scale
729 (to see small numbers) when you use "log" instead of
730 "normal". Takes the switch '-t' to use a temperature
731 gradient, which makes the gradient values change depending
732 on the amplitude of a particular graph value (try it and
739 <option>diskiograph_write</option>
741 <option>(device) ("normal"|"log") (height),(width)
742 (gradient colour 1) (gradient colour 2) (scale)
745 <listitem>Disk IO graph for writes, colours defined in hex,
746 minus the #. If scale is non-zero, it becomes the scale for
747 the graph. Device as in diskio. Uses a logarithmic scale
748 (to see small numbers) when you use "log" instead of
749 "normal". Takes the switch '-t' to use a temperature
750 gradient, which makes the gradient values change depending
751 on the amplitude of a particular graph value (try it and
758 <option>downspeed</option>
760 <option>(net)</option>
762 <listitem>Download speed in suitable IEC units
768 <option>downspeedf</option>
770 <option>(net)</option>
772 <listitem>Download speed in KiB with one decimal
778 <option>downspeedgraph</option>
780 <option>(netdev) ("normal"|"log") (height),(width)
781 (gradient colour 1) (gradient colour 2) (scale)
784 <listitem>Download speed graph, colours defined in hex,
785 minus the #. If scale is non-zero, it becomes the scale for
786 the graph. Uses a logarithmic scale (to see small numbers)
787 when you use "log" instead of "normal". Takes the switch
788 '-t' to use a temperature gradient, which makes the
789 gradient values change depending on the amplitude of a
790 particular graph value (try it and see).
796 <option>draft_mails</option>
798 <option>(maildir)</option>
799 <option>(interval)</option>
801 <listitem>Number of mails marked as draft in the specified
802 mailbox or mail spool if not. Only maildir type mailboxes
803 are supported, mbox type will return -1.
809 <option>else</option>
812 <listitem>Text to show if any of the above are not true
818 <option>endif</option>
822 <listitem>Ends an $if block.
828 <option>entropy_avail</option>
831 <listitem>Current entropy available for crypto freaks
837 <option>entropy_bar</option>
839 <option>(height),(width)</option>
841 <listitem>Normalized bar of available entropy for crypto
848 <option>entropy_perc</option>
851 <listitem>Percentage of entropy available in comparison to
858 <option>entropy_poolsize</option>
861 <listitem>Total size of system entropy pool for crypto
868 <option>eval</option>
870 <option>string</option>
872 <listitem>Evalutates given string according to the rules of
873 TEXT interpretation, i.e. parsing any contained text object
874 specifications into their output, any occuring '$$' into a
875 single '$' and so on. The output is then being parsed
884 <option>api_userid api_key character_id</option>
886 <listitem>Fetches your currently training skill from the
887 Eve Online API servers (http://www.eve-online.com/) and
888 displays the skill along with the remaining training time.
894 <option>exec</option>
896 <option>command</option>
898 <listitem>Executes a shell command and displays the output
899 in conky. warning: this takes a lot more resources than
900 other variables. I'd recommend coding wanted behaviour in C
907 <option>execbar</option>
909 <option>command</option>
911 <listitem>Same as exec, except if the first value return is
912 a value between 0-100, it will use that number for a bar.
913 The size for bars can be controlled via the
914 default_bar_size config setting.
920 <option>execgauge</option>
922 <option>command</option>
924 <listitem>Same as exec, except if the first value returned
925 is a value between 0-100, it will use that number for a
926 gauge. The size for gauges can be controlled via the
927 default_gauge_size config setting.
933 <option>execgraph</option>
935 <option>("normal"|"log") (-t) command</option>
937 <listitem>Same as execbar, but graphs values. Uses a
938 logaritmic scale when the log option is given (to see small
939 numbers). Values still have to be between 0 and 100. The
940 size for graphs can be controlled via the
941 default_graph_size config setting. Takes the switch '-t' to
942 use a temperature gradient, which makes the gradient values
943 change depending on the amplitude of a particular graph
944 value (try it and see).
950 <option>execi</option>
952 <option>interval command</option>
954 <listitem>Same as exec but with specific interval. Interval
955 can't be less than update_interval in configuration. See
962 <option>execibar</option>
964 <option>interval command</option>
966 <listitem>Same as execbar, except with an interval
972 <option>execigauge</option>
974 <option>interval command</option>
976 <listitem>Same as execgauge, but takes an interval arg and
983 <option>execigraph</option>
985 <option>interval ("normal"|"log") (-t) command</option>
987 <listitem>Same as execgraph, but takes an interval arg and
994 <option>execp</option>
996 <option>command</option>
998 <listitem>Executes a shell command and displays the output
999 in conky. warning: this takes a lot more resources than
1000 other variables. I'd recommend coding wanted behaviour in C
1001 and posting a patch. This differs from $exec in that it
1002 parses the output of the command, so you can insert things
1003 like ${color red}hi!${color} in your script and have it
1004 correctly parsed by Conky. Caveats: Conky parses and
1005 evaluates the output of $execp every time Conky loops, and
1006 then destroys all the objects. If you try to use anything
1007 like $execi within an $execp statement, it will
1008 functionally run at the same interval that the $execp
1009 statement runs, as it is created and destroyed at every
1016 <option>execpi</option>
1018 <option>interval command</option>
1020 <listitem>Same as execp but with specific interval.
1021 Interval can't be less than update_interval in
1022 configuration. Note that the output from the $execpi
1023 command is still parsed and evaluated at every interval.
1029 <option>flagged_mails</option>
1031 <option>(maildir)</option>
1032 <option>(interval)</option>
1034 <listitem>Number of mails marked as flagged in the
1035 specified mailbox or mail spool if not. Only maildir type
1036 mailboxes are supported, mbox type will return -1.
1042 <option>font</option>
1044 <option>(font)</option>
1046 <listitem>Specify a different font. This new font will
1047 apply to the current line and everything following. You can
1048 use a $font with no arguments to change back to the default
1049 font (much like with $color)
1055 <option>forwarded_mails</option>
1057 <option>(maildir)</option>
1058 <option>(interval)</option>
1060 <listitem>Number of mails marked as forwarded in the
1061 specified mailbox or mail spool if not. Only maildir type
1062 mailboxes are supported, mbox type will return -1.
1068 <option>freq</option>
1070 <option>(n)</option>
1072 <listitem>Returns CPU #n's frequency in MHz. CPUs are
1073 counted from 1. If omitted, the parameter defaults to 1.
1079 <option>freq_g</option>
1081 <option>(n)</option>
1083 <listitem>Returns CPU #n's frequency in GHz. CPUs are
1084 counted from 1. If omitted, the parameter defaults to 1.
1090 <option>fs_bar</option>
1092 <option>(height),(width) fs</option>
1094 <listitem>Bar that shows how much space is used on a file
1095 system. height is the height in pixels. fs is any file on
1102 <option>fs_bar_free</option>
1104 <option>(height),(width) fs</option>
1106 <listitem>Bar that shows how much space is free on a file
1107 system. height is the height in pixels. fs is any file on
1114 <option>fs_free</option>
1116 <option>(fs)</option>
1118 <listitem>Free space on a file system available for users.
1124 <option>fs_free_perc</option>
1126 <option>(fs)</option>
1128 <listitem>Free percentage of space on a file system
1129 available for users.
1135 <option>fs_size</option>
1137 <option>(fs)</option>
1139 <listitem>File system size.
1145 <option>fs_type</option>
1147 <option>(fs)</option>
1149 <listitem>File system type.
1155 <option>fs_used</option>
1157 <option>(fs)</option>
1159 <listitem>File system used space.
1165 <option>fs_used_perc</option>
1167 <option>(fs)</option>
1169 <listitem>Percent of file system used space.
1175 <option>goto</option>
1179 <listitem>The next element will be printed at position 'x'.
1186 <option>gw_iface</option>
1189 <listitem>Displays the default route's interface or
1190 "multiple"/"none" accordingly.
1196 <option>gw_ip</option>
1199 <listitem>Displays the default gateway's IP or
1200 "multiple"/"none" accordingly.
1206 <option>hddtemp</option>
1208 <option>dev, (host,(port))</option>
1210 <listitem>Displays temperature of a selected hard disk
1211 drive as reported by the hddtemp daemon running on
1212 host:port. Default host is 127.0.0.1, default port is 7634.
1219 <option>head</option>
1221 <option>logfile lines (interval)</option>
1223 <listitem>Displays first N lines of supplied text text
1224 file. If interval is not supplied, Conky assumes 2x Conky's
1225 interval. Max of 30 lines can be displayed, or until the
1226 text buffer is filled.
1234 <option>(height)</option>
1236 <listitem>Horizontal line, height is the height in pixels
1242 <option>hwmon</option>
1244 <option>(dev) type n (factor offset)</option>
1246 <listitem>Hwmon sensor from sysfs (Linux 2.6). Parameter
1247 dev may be omitted if you have only one hwmon device.
1248 Parameter type is either 'in' or 'vol' meaning voltage;
1249 'fan' meaning fan; 'temp' meaning temperature. Parameter n
1250 is number of the sensor. See /sys/class/hwmon/ on your
1251 local computer. The optional arguments 'factor' and
1252 'offset' allow precalculation of the raw input, which is
1253 being modified as follows: 'input = input * factor +
1254 offset'. Note that they have to be given as decimal values
1255 (i.e. contain at least one decimal place).
1261 <option>i2c</option>
1263 <option>(dev) type n (factor offset)</option>
1265 <listitem>I2C sensor from sysfs (Linux 2.6). Parameter dev
1266 may be omitted if you have only one I2C device. Parameter
1267 type is either 'in' or 'vol' meaning voltage; 'fan' meaning
1268 fan; 'temp' meaning temperature. Parameter n is number of
1269 the sensor. See /sys/bus/i2c/devices/ on your local
1270 computer. The optional arguments 'factor' and 'offset'
1271 allow precalculation of the raw input, which is being
1272 modified as follows: 'input = input * factor + offset'.
1273 Note that they have to be given as decimal values (i.e.
1274 contain at least one decimal place).
1280 <option>i8k_ac_status</option>
1284 <listitem>If running the i8k kernel driver for Inspiron
1285 laptops, displays whether ac power is on, as listed in
1286 /proc/i8k (translated to human-readable). Beware that this
1287 is by default not enabled by i8k itself.
1293 <option>i8k_bios</option>
1297 <listitem>If running the i8k kernel driver for Inspiron
1298 laptops, displays the bios version as listed in /proc/i8k.
1304 <option>i8k_buttons_status</option>
1308 <listitem>If running the i8k kernel driver for Inspiron
1309 laptops, displays the volume buttons status as listed in
1316 <option>i8k_cpu_temp</option>
1320 <listitem>If running the i8k kernel driver for Inspiron
1321 laptops, displays the cpu temperature in Celsius, as
1322 reported by /proc/i8k.
1328 <option>i8k_left_fan_rpm</option>
1332 <listitem>If running the i8k kernel driver for Inspiron
1333 laptops, displays the left fan's rate of rotation, in
1334 revolutions per minute as listed in /proc/i8k. Beware, some
1335 laptops i8k reports these fans in reverse order.
1341 <option>i8k_left_fan_status</option>
1345 <listitem>If running the i8k kernel driver for Inspiron
1346 laptops, displays the left fan status as listed in
1347 /proc/i8k (translated to human-readable). Beware, some
1348 laptops i8k reports these fans in reverse order.
1354 <option>i8k_right_fan_rpm</option>
1358 <listitem>If running the i8k kernel driver for Inspiron
1359 laptops, displays the right fan's rate of rotation, in
1360 revolutions per minute as listed in /proc/i8k. Beware, some
1361 laptops i8k reports these fans in reverse order.
1367 <option>i8k_right_fan_status</option>
1371 <listitem>If running the i8k kernel driver for Inspiron
1372 laptops, displays the right fan status as listed in
1373 /proc/i8k (translated to human-readable). Beware, some
1374 laptops i8k reports these fans in reverse order.
1380 <option>i8k_serial</option>
1384 <listitem>If running the i8k kernel driver for Inspiron
1385 laptops, displays your laptop serial number as listed in
1392 <option>i8k_version</option>
1396 <listitem>If running the i8k kernel driver for Inspiron
1397 laptops, displays the version formatting of /proc/i8k.
1403 <option>ibm_brightness</option>
1406 <listitem>If running the IBM ACPI, displays the brigtness
1407 of the laptops's LCD (0-7).
1413 <option>ibm_fan</option>
1416 <listitem>If running the IBM ACPI, displays the fan speed.
1422 <option>ibm_temps</option>
1426 <listitem>If running the IBM ACPI, displays the
1427 temperatures from the IBM temperature sensors (N=0..7)
1428 Sensor 0 is on the CPU, 3 is on the GPU.
1434 <option>ibm_volume</option>
1437 <listitem>If running the IBM ACPI, displays the "master"
1438 volume, controlled by the volume keys (0-14).
1444 <option>iconv_start</option>
1446 <option>codeset_from codeset_to</option>
1448 <listitem>Convert text from one codeset to another using
1449 GNU iconv. Needs to be stopped with iconv_stop.
1455 <option>iconv_stop</option>
1459 <listitem>Stop iconv codeset conversion.
1465 <option>if_empty</option>
1467 <option>(var)</option>
1469 <listitem>if conky variable VAR is empty, display
1470 everything between $if_empty and the matching $endif
1476 <option>if_existing</option>
1478 <option>file (string)</option>
1480 <listitem>if FILE exists, display everything between
1481 if_existing and the matching $endif. The optional second
1482 paramater checks for FILE containing the specified string
1483 and prints everything between $if_existing and the matching
1490 <option>if_gw</option>
1493 <listitem>if there is at least one default gateway, display
1494 everything between $if_gw and the matching $endif
1500 <option>if_match</option>
1502 <option>expression</option>
1504 <listitem>Evaluates the given boolean expression, printing
1505 everything between $if_match and the matching $endif
1506 depending on whether the evaluation returns true or not.
1507 Valid expressions consist of a left side, an operator and a
1508 right side. Left and right sides are being parsed for
1509 contained text objects before evaluation. Recognised left
1510 and right side types are:
1513 <command>double</command>: argument consists of only
1514 digits and a single dot.</member>
1516 <command>long</command>: argument consists of only
1519 <command>string</command>: argument is enclosed in
1520 quotation mark or the checks for double and long failed
1522 </simplelist>Valid operands are: '>', '<', '>=',
1523 '<=', '==', '!='.
1529 <option>if_mixer_mute</option>
1531 <option>(mixer)</option>
1533 <listitem>If mixer exists, display everything between
1534 $if_mixer_mute and the matching $endif. If no mixer is
1535 specified, "Master" is used.
1541 <option>if_mounted</option>
1543 <option>(mountpoint)</option>
1545 <listitem>if MOUNTPOINT is mounted, display everything
1546 between $if_mounted and the matching $endif
1552 <option>if_mpd_playing</option>
1555 <listitem>if mpd is playing or paused, display everything
1556 between $if_mpd_playing and the matching $endif
1562 <option>if_running</option>
1564 <option>(process)</option>
1566 <listitem>if PROCESS is running, display everything
1567 $if_running and the matching $endif. This uses the
1568 ``pidof'' command, so the -x switch is also supported.
1574 <option>if_smapi_bat_installed</option>
1576 <option>(INDEX)</option>
1578 <listitem>when using smapi, if the battery with index INDEX
1579 is installed, display everything between
1580 $if_smapi_bat_installed and the matching $endif
1586 <option>if_up</option>
1588 <option>(interface)</option>
1590 <listitem>if INTERFACE exists and is up, display everything
1591 between $if_up and the matching $endif
1597 <option>if_updatenr</option>
1599 <option>(updatenr)</option>
1601 <listitem>If it's the UPDATENR-th time that conky updates,
1602 display everything between $if_updatenr and the matching
1603 $endif. The counter resets when the highest UPDATENR is
1604 reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr
1605 2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the
1606 time followed by bar 25% of the time followed by nothing
1607 the other half of the time.
1613 <option>if_xmms2_connected</option>
1616 <listitem>Display everything between $if_xmms2_connected
1617 and the matching $endif if xmms2 is running.
1623 <option>image</option>
1625 <option><path to image> (-p x,y) (-s WxH) (-n)
1626 (-f interval)</option>
1628 <listitem>Renders an image from the path specified using
1629 Imlib2. Takes 4 optional arguments: a position, a size, a
1630 no-cache switch, and a cache flush interval. Changing the
1631 x,y position will move the position of the image, and
1632 changing the WxH will scale the image. If you specify the
1633 no-cache flag (-n), the image will not be cached.
1634 Alternately, you can specify the -f int switch to specify a
1635 cache flust interval for a particular image. Example:
1636 ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200}
1637 will render 'cheeseburger.jpg' at (20,20) scaled to 200x200
1638 pixels. Conky does not make any attempt to adjust the
1639 position (or any other formatting) of images, they are just
1640 rendered as per the arguments passed. The only reason
1641 $image is part of the TEXT section, is to allow for runtime
1642 modifications, through $execp $lua_parse, $lua_read_parse,
1643 or some other method.
1649 <option>imap_messages</option>
1651 <option>(args)</option>
1653 <listitem>Displays the number of messages in your global
1654 IMAP inbox by default. You can define individual IMAP
1655 inboxes seperately by passing arguments to this object.
1656 Arguments are: "host user pass [-i interval (in seconds)]
1657 [-f folder] [-p port] [-e command] [-r retries]". Default
1658 port is 143, default folder is 'INBOX', default interval is
1659 5 minutes, and default number of retries before giving up
1660 is 5. If the password is supplied as '*', you will be
1661 prompted to enter the password when Conky starts.
1667 <option>imap_unseen</option>
1669 <option>(args)</option>
1671 <listitem>Displays the number of unseen messages in your
1672 global IMAP inbox by default. You can define individual
1673 IMAP inboxes seperately by passing arguments to this
1674 object. Arguments are: "host user pass [-i interval (in
1675 seconds)] [-f folder] [-p port] [-e command] [-r retries]".
1676 Default port is 143, default folder is 'INBOX', default
1677 interval is 5 minutes, and default number of retries before
1678 giving up is 5. If the password is supplied as '*', you
1679 will be prompted to enter the password when Conky starts.
1685 <option>ioscheduler</option>
1687 <option>disk</option>
1689 <listitem>Prints the current ioscheduler used for the given
1690 disk name (i.e. e.g. "hda" or "sdb")
1696 <option>kernel</option>
1699 <listitem>Kernel version
1705 <option>laptop_mode</option>
1708 <listitem>The value of /proc/sys/vm/laptop_mode
1714 <option>lines</option>
1716 <option>textfile</option>
1718 <listitem>Displays the number of lines in the given file
1724 <option>loadavg</option>
1727 <listitem>(1,2,3)> System load average, 1 is for past 1
1728 minute, 2 for past 5 minutes and 3 for past 15 minutes.
1734 <option>loadgraph</option>
1736 <option>("normal"|"log") (height),(width) (gradient
1737 colour 1) (gradient colour 2) (scale) (-t)</option>
1739 <listitem>Load1 average graph, similar to xload, with
1740 optional colours in hex, minus the #. Uses a logarithmic
1741 scale (to see small numbers) when you use "log" instead of
1742 "normal". Takes the switch '-t' to use a temperature
1743 gradient, which makes the gradient values change depending
1744 on the amplitude of a particular graph value (try it and
1751 <option>lua</option>
1753 <option>function_name (function parameters)</option>
1755 <listitem>Executes a Lua function with given parameters,
1756 then prints the returned string. See also 'lua_load' on how
1763 <option>lua_bar</option>
1765 <option>(height, width) function_name (function
1766 parameters)</option>
1768 <listitem>Executes a Lua function with given parameters and
1769 draws a bar. Expects result value to be an integer between
1770 0 and 100. See also 'lua_load' on how to load scripts.
1776 <option>lua_gauge</option>
1778 <option>(height, width) function_name (function
1779 parameters)</option>
1781 <listitem>Executes a Lua function with given parameters and
1782 draws a gauge. Expects result value to be an integer
1783 between 0 and 100. See also 'lua_load' on how to load
1790 <option>lua_graph</option>
1792 <option>function_name (function parameters)
1793 ("normal"|"log") (height),(width) (gradient colour 1)
1794 (gradient colour 2) (scale) (-t)</option>
1796 <listitem>Executes a Lua function with given parameters and
1797 draws a graph. Expects result value to be any number, and
1798 by default will scale to show the full range. See also
1799 'lua_load' on how to load scripts. Takes the switch '-t' to
1800 use a temperature gradient, which makes the gradient values
1801 change depending on the amplitude of a particular graph
1802 value (try it and see).
1808 <option>lua_parse</option>
1810 <option>function_name (function parameters)</option>
1812 <listitem>Executes a Lua function with given parameters as
1813 per $lua, then parses and prints the result value as per
1814 the syntax for Conky's TEXT section. See also 'lua_load' on
1815 how to load scripts.
1821 <option>lua_read_parse</option>
1823 <option>function_name (conky text)</option>
1825 <listitem>Executes a Lua function per $lua, except takes a
1826 2nd argument which is first evaluated as per Conky's TEXT
1827 section and passed to the function first. The return value
1828 is then parsed and prints the result value as per the
1829 syntax for Conky's TEXT section. See also 'lua_load' on how
1836 <option>machine</option>
1839 <listitem>Machine, i686 for example
1845 <option>mails</option>
1847 <option>(mailbox)</option>
1848 <option>(interval)</option>
1850 <listitem>Mail count in the specified mailbox or your mail
1851 spool if not. Both mbox and maildir type mailboxes are
1852 supported. You can use a program like fetchmail to get
1853 mails from some server using your favourite protocol. See
1860 <option>mboxscan</option>
1862 <option>(-n number of messages to print) (-fw from
1863 width) (-sw subject width) mbox</option>
1865 <listitem>Print a summary of recent messages in an mbox
1866 format mailbox. mbox parameter is the filename of the
1867 mailbox (can be encapsulated using '"', ie. ${mboxscan -n
1868 10 "/home/brenden/some box"}
1874 <option>mem</option>
1877 <listitem>Amount of memory in use
1883 <option>membar</option>
1885 <option>(height),(width)</option>
1887 <listitem>Bar that shows amount of memory in use
1893 <option>memeasyfree</option>
1896 <listitem>Amount of free memory including the memory that
1897 is very easily freed (buffers/cache)
1903 <option>memfree</option>
1906 <listitem>Amount of free memory
1912 <option>memgauge</option>
1914 <option>(height),(width)</option>
1916 <listitem>Gauge that shows amount of memory in use (see
1923 <option>memgraph</option>
1925 <option>("normal"|"log") (height),(width) (gradient
1926 colour 1) (gradient colour 2) (scale) (-t)</option>
1928 <listitem>Memory usage graph. Uses a logarithmic scale (to
1929 see small numbers) when you use "log" instead of "normal".
1930 Takes the switch '-t' to use a temperature gradient, which
1931 makes the gradient values change depending on the amplitude
1932 of a particular graph value (try it and see).
1938 <option>memmax</option>
1941 <listitem>Total amount of memory
1947 <option>memperc</option>
1950 <listitem>Percentage of memory in use
1956 <option>mixer</option>
1958 <option>(device)</option>
1960 <listitem>Prints the mixer value as reported by the OS.
1961 Default mixer is "vol", but you can specify one of the
1962 following optional arguments: "vol", "bass", "treble",
1963 "synth", "pcm", "speaker", "line", "mic", "cd", "mix",
1964 "pcm2", "rec", "igain", "ogain", "line1", "line2", "line3",
1965 "dig1", "dig2", "dig3", "phin", "phout", "video", "radio",
1966 "monitor". Refer to the definition of SOUND_DEVICE_NAMES in
1967 <linux/soundcard.h> (on Linux), <soundcard.h>
1968 (on OpenBSD), or <sys/soundcard.h> to find the exact
1969 options available on your system.
1975 <option>mixerbar</option>
1977 <option>(device)</option>
1979 <listitem>Displays mixer value in a bar as reported by the
1980 OS. See docs for $mixer for details on arguments.
1986 <option>mixerl</option>
1988 <option>(device)</option>
1990 <listitem>Prints the left channel mixer value as reported
1991 by the OS. See docs for $mixer for details on arguments.
1997 <option>mixerlbar</option>
1999 <option>(device)</option>
2001 <listitem>Displays the left channel mixer value in a bar as
2002 reported by the OS. See docs for $mixer for details on
2009 <option>mixerr</option>
2011 <option>(device)</option>
2013 <listitem>Prints the right channel mixer value as reported
2014 by the OS. See docs for $mixer for details on arguments.
2020 <option>mixerrbar</option>
2022 <option>(device)</option>
2024 <listitem>Displays the right channel mixer value in a bar
2025 as reported by the OS. See docs for $mixer for details on
2032 <option>moc_album</option>
2035 <listitem>Album of the current MOC song
2041 <option>moc_artist</option>
2044 <listitem>Artist of the current MOC song
2050 <option>moc_bitrate</option>
2053 <listitem>Bitrate in the current MOC song
2059 <option>moc_curtime</option>
2062 <listitem>Current time of the current MOC song
2068 <option>moc_file</option>
2071 <listitem>File name of the current MOC song
2077 <option>moc_rate</option>
2080 <listitem>Rate of the current MOC song
2086 <option>moc_song</option>
2089 <listitem>The current song name being played in MOC.
2095 <option>moc_state</option>
2098 <listitem>Current state of MOC; playing, stopped etc.
2104 <option>moc_timeleft</option>
2107 <listitem>Time left in the current MOC song
2113 <option>moc_title</option>
2116 <listitem>Title of the current MOC song
2122 <option>moc_totaltime</option>
2125 <listitem>Total length of the current MOC song
2131 <option>monitor</option>
2134 <listitem>Number of the monitor on which conky is running
2140 <option>monitor_number</option>
2143 <listitem>Number of monitors
2149 <option>mpd_album</option>
2152 <listitem>Album in current MPD song
2158 <option>mpd_artist</option>
2161 <listitem>Artist in current MPD song must be enabled at
2168 <option>mpd_bar</option>
2170 <option>(height),(width)</option>
2172 <listitem>Bar of mpd's progress
2178 <option>mpd_bitrate</option>
2181 <listitem>Bitrate of current song
2187 <option>mpd_elapsed</option>
2190 <listitem>Song's elapsed time
2196 <option>mpd_file</option>
2199 <listitem>Prints the file name of the current MPD song
2205 <option>mpd_length</option>
2208 <listitem>Song's length
2214 <option>mpd_name</option>
2217 <listitem>Prints the MPD name field
2223 <option>mpd_percent</option>
2226 <listitem>Percent of song's progress
2232 <option>mpd_random</option>
2235 <listitem>Random status (On/Off)
2241 <option>mpd_repeat</option>
2244 <listitem>Repeat status (On/Off)
2250 <option>mpd_smart</option>
2252 <option>(max length)</option>
2254 <listitem>Prints the song name in either the form "artist -
2255 title" or file name, depending on whats available
2261 <option>mpd_status</option>
2264 <listitem>Playing, stopped, et cetera.
2270 <option>mpd_title</option>
2272 <option>(max length)</option>
2274 <listitem>Title of current MPD song
2280 <option>mpd_track</option>
2283 <listitem>Prints the MPD track field
2289 <option>mpd_vol</option>
2292 <listitem>MPD's volume
2298 <option>nameserver</option>
2300 <option>(index)</option>
2302 <listitem>Print a nameserver from /etc/resolv.conf. Index
2303 starts at and defaults to 0.
2309 <option>new_mails</option>
2311 <option>(mailbox)</option>
2312 <option>(interval)</option>
2314 <listitem>Unread mail count in the specified mailbox or
2315 mail spool if not. Both mbox and maildir type mailboxes are
2322 <option>nodename</option>
2331 <option>nvidia</option>
2333 <option>threshold</option>
2334 <option>temp</option>
2335 <option>ambient</option>
2336 <option>gpufreq</option>
2337 <option>memfreq</option>
2338 <option>imagequality</option>
2340 <listitem>Nvidia graficcard support for the XNVCtrl
2341 library. Each option can be shortened to the least
2342 significant part. Temperatures are printed as float, all
2343 other values as integer.
2346 <command>threshold</command>: the thresholdtemperature
2347 at which the gpu slows down</member>
2349 <command>temp</command>: gives the gpu current
2350 temperature</member>
2352 <command>ambient</command>: gives current air
2353 temperature near GPU case</member>
2355 <command>gpufreq</command>: gives the current gpu
2358 <command>memfreq</command>: gives the current mem
2361 <command>imagequality</command>: which imagequality
2362 should be choosen by OpenGL applications</member>
2369 <option>offset</option>
2371 <option>(pixels)</option>
2373 <listitem>Move text over by N pixels. See also $voffset.
2379 <option>outlinecolor</option>
2381 <option>(color)</option>
2383 <listitem>Change outline color
2389 <option>pb_battery</option>
2391 <option>item</option>
2393 <listitem>If running on Apple powerbook/ibook, display
2394 information on battery status. The item parameter
2395 specifies, what information to display. Exactly one item
2396 must be specified. Valid items are:
2399 <command>status</command>: Display if battery is fully
2400 charged, charging, discharging or absent (running on
2403 <command>percent</command>: Display charge of battery
2404 in percent, if charging or discharging. Nothing will be
2405 displayed, if battery is fully charged or
2408 <command>time</command>: Display the time remaining
2409 until the battery will be fully charged or discharged
2410 at current rate. Nothing is displayed, if battery is
2411 absent or if it's present but fully charged and not
2412 discharging.</member>
2419 <option>platform</option>
2421 <option>(dev) type n (factor offset)</option>
2423 <listitem>Platform sensor from sysfs (Linux 2.6). Parameter
2424 dev may be omitted if you have only one platform device.
2425 Platform type is either 'in' or 'vol' meaning voltage;
2426 'fan' meaning fan; 'temp' meaning temperature. Parameter n
2427 is number of the sensor. See /sys/bus/platform/devices/ on
2428 your local computer. The optional arguments 'factor' and
2429 'offset' allow precalculation of the raw input, which is
2430 being modified as follows: 'input = input * factor +
2431 offset'. Note that they have to be given as decimal values
2432 (i.e. contain at least one decimal place).
2438 <option>pop3_unseen</option>
2440 <option>(args)</option>
2442 <listitem>Displays the number of unseen messages in your
2443 global POP3 inbox by default. You can define individual
2444 POP3 inboxes seperately by passing arguments to this
2445 object. Arguments are: "host user pass [-i interval (in
2446 seconds)] [-p port] [-e command] [-r retries]". Default
2447 port is 110, default interval is 5 minutes, and default
2448 number of retries before giving up is 5. If the password is
2449 supplied as '*', you will be prompted to enter the password
2456 <option>pop3_used</option>
2458 <option>(args)</option>
2460 <listitem>Displays the amount of space (in MiB, 2^20) used
2461 in your global POP3 inbox by default. You can define
2462 individual POP3 inboxes seperately by passing arguments to
2463 this object. Arguments are: "host user pass [-i interval
2464 (in seconds)] [-p port] [-e command] [-r retries]". Default
2465 port is 110, default interval is 5 minutes, and default
2466 number of retries before giving up is 5. If the password is
2467 supplied as '*', you will be prompted to enter the password
2474 <option>pre_exec</option>
2476 <option>shell command</option>
2478 <listitem>Executes a shell command one time before conky
2479 displays anything and puts output as text.
2485 <option>processes</option>
2488 <listitem>Total processes (sleeping and running)
2494 <option>read_tcp</option>
2496 <option>(host) port</option>
2498 <listitem>Connects to a tcp port on a host (default is
2499 localhost), reads every char available at the moment and
2506 <option>replied_mails</option>
2508 <option>(maildir)</option>
2509 <option>(interval)</option>
2511 <listitem>Number of mails marked as replied in the
2512 specified mailbox or mail spool if not. Only maildir type
2513 mailboxes are supported, mbox type will return -1.
2519 <option>rss</option>
2521 <option>url delay_in_minutes action (num_par
2522 (spaces_in_front))</option>
2524 <listitem>Download and parse RSS feeds. Action may be one
2525 of the following: feed_title, item_title (with num par),
2526 item_desc (with num par) and item_titles (when using this
2527 action and spaces_in_front is given conky places that many
2528 spaces in front of each item).
2534 <option>running_processes</option>
2537 <listitem>Running processes (not sleeping), requires Linux
2544 <option>scroll</option>
2546 <option>length (step) text</option>
2548 <listitem>Scroll 'text' by 'step' characters showing
2549 'length' number of characters at the same time. The text
2550 may also contain variables. 'step' is optional and defaults
2551 to 1 if not set. If a var creates output on multiple lines
2552 then the lines are placed behind each other separated with
2553 a '|'-sign. Do NOT use vars that change colors or otherwise
2554 affect the design inside a scrolling text. If you want
2555 spaces between the start and the end of 'text', place them
2556 at the end of 'text' not at the front ("foobar" and "
2557 foobar" can both generate "barfoo" but "foobar " will keep
2558 the spaces like this "bar foo").
2564 <option>seen_mails</option>
2566 <option>(maildir)</option>
2567 <option>(interval)</option>
2569 <listitem>Number of mails marked as seen in the specified
2570 mailbox or mail spool if not. Only maildir type mailboxes
2571 are supported, mbox type will return -1.
2577 <option>shadecolor</option>
2579 <option>(color)</option>
2581 <listitem>Change shading color
2587 <option>smapi</option>
2589 <option>(ARGS)</option>
2591 <listitem>when using smapi, display contents of the
2592 /sys/devices/platform/smapi directory. ARGS are either
2593 '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the
2594 corresponding files' content. This is a very raw method of
2595 accessing the smapi values. When available, better use one
2596 of the smapi_* variables instead.
2602 <option>smapi_bat_bar</option>
2604 <option>(INDEX),(height),(width)</option>
2606 <listitem>when using smapi, display the remaining capacity
2607 of the battery with index INDEX as a bar.
2613 <option>smapi_bat_perc</option>
2615 <option>(INDEX)</option>
2617 <listitem>when using smapi, display the remaining capacity
2618 in percent of the battery with index INDEX. This is a
2619 separate variable because it supports the 'use_spacer'
2620 configuration option.
2626 <option>smapi_bat_power</option>
2628 <option>INDEX</option>
2630 <listitem>when using smapi, display the current power of
2631 the battery with index INDEX in watt. This is a separate
2632 variable because the original read out value is being
2633 converted from mW. The sign of the output reflects charging
2634 (positive) or discharging (negative) state.
2640 <option>smapi_bat_temp</option>
2642 <option>INDEX</option>
2644 <listitem>when using smapi, display the current temperature
2645 of the battery with index INDEX in degree Celsius. This is
2646 a separate variable because the original read out value is
2647 being converted from milli degree Celsius.
2653 <option>sony_fanspeed</option>
2656 <listitem>Displays the Sony VAIO fanspeed information if
2657 sony-laptop kernel support is enabled. Linux only.
2663 <option>stippled_hr</option>
2665 <option>(space)</option>
2667 <listitem>Stippled (dashed) horizontal line
2673 <option>swap</option>
2676 <listitem>Amount of swap in use
2682 <option>swapbar</option>
2684 <option>(height),(width)</option>
2686 <listitem>Bar that shows amount of swap in use
2692 <option>swapmax</option>
2695 <listitem>Total amount of swap
2701 <option>swapperc</option>
2704 <listitem>Percentage of swap in use
2710 <option>sysname</option>
2713 <listitem>System name, Linux for example
2719 <option>tab</option>
2721 <option>(width, (start))</option>
2723 <listitem>Puts a tab of the specified width, starting from
2724 column 'start'. The unit is pixels for both arguments.
2730 <option>tail</option>
2732 <option>logfile lines (interval)</option>
2734 <listitem>Displays last N lines of supplied text text file.
2735 If interval is not supplied, Conky assumes 2x Conky's
2736 interval. Max of 30 lines can be displayed, or until the
2737 text buffer is filled.
2743 <option>tcp_portmon</option>
2745 <option>port_begin port_end item (index)</option>
2746 <emphasis>(ip4 only at present)</emphasis>
2748 <listitem>TCP port monitor for specified local ports. Port
2749 numbers must be in the range 1 to 65535. Valid items are:
2752 <command>count</command>- total number of connections
2753 in the range</member>
2755 <command>rip</command>- remote ip address</member>
2757 <command>rhost</command>- remote host name</member>
2759 <command>rport</command>- remote port number</member>
2761 <command>rservice</command>- remote service name from
2762 /etc/services</member>
2764 <command>lip</command>- local ip address</member>
2766 <command>lhost</command>- local host name</member>
2768 <command>lport</command>- local port number</member>
2770 <command>lservice</command>- local service name from
2771 /etc/services</member>
2772 </simplelist>The connection index provides you with access
2773 to each connection in the port monitor. The monitor will
2774 return information for index values from 0 to n-1
2775 connections. Values higher than n-1 are simply ignored. For
2776 the "count" item, the connection index must be omitted. It
2777 is required for all other items.
2779 <member>Examples:</member>
2781 <command>${tcp_portmon 6881 6999 count}</command>-
2782 displays the number of connections in the bittorrent
2785 <command>${tcp_portmon 22 22 rip 0}</command>- displays
2786 the remote host ip of the first sshd
2789 <command>${tcp_portmon 22 22 rip 9}</command>- displays
2790 the remote host ip of the tenth sshd
2793 <command>${tcp_portmon 1 1024 rhost 0}</command>-
2794 displays the remote host name of the first connection
2795 on a privileged port</member>
2797 <command>${tcp_portmon 1 1024 rport 4}</command>-
2798 displays the remote host port of the fifth connection
2799 on a privileged port</member>
2801 <command>${tcp_portmon 1 65535 lservice 14}</command>-
2802 displays the local service name of the fifteenth
2803 connection in the range of all ports</member>
2804 </simplelist>Note that port monitor variables which share
2805 the same port range actually refer to the same monitor, so
2806 many references to a single port range for different items
2807 and different indexes all use the same monitor internally.
2808 In other words, the program avoids creating redundant
2809 monitors.</listitem>
2814 <option>templateN</option>
2816 <option>(arg1)</option>
2817 <option>(arg2)</option>
2818 <option>(arg3 ...)</option>
2820 <listitem>Evaluate the content of the templateN
2821 configuration variable (where N is a value between 0 and 9,
2822 inclusively), applying substitutions as described in the
2823 documentation of the corresponding configuration variable.
2824 The number of arguments is optional, but must match the
2825 highest referred index in the template. You can use the
2826 same special sequences in each argument as the ones valid
2827 for a template definition, e.g. to allow an argument to
2828 contain a whitespace. Also simple nesting of templates is
2831 <listitem>Here are some examples of template definitions:
2833 <member>template0 $\1\2</member>
2834 <member>template1 \1: ${fs_used \2} / ${fs_size
2836 <member>template2 \1 \2</member>
2837 </simplelist>The following list shows sample usage of the
2838 templates defined above, with the equivalent syntax when
2839 not using any template at all:
2844 <entry>using template</entry>
2845 <entry>same without template</entry>
2850 <entry>${template0 node name}</entry>
2851 <entry>$nodename</entry>
2854 <entry>${template1 root /}</entry>
2855 <entry>root: ${fs_free /} / ${fs_size
2860 <programlisting>${template1
2861 ${template2\ disk\ root}
2865 <programlisting>disk root: ${fs_free /}
2866 / ${fs_size /}</programlisting>
2877 <option>texeci</option>
2879 <option>interval command</option>
2881 <listitem>Runs a command at an interval inside a thread and
2882 displays the output. Same as $execi, except the command is
2883 run inside a thread. Use this if you have a slow script to
2884 keep Conky updating. You should make the interval slightly
2885 longer then the time it takes your script to execute. For
2886 example, if you have a script that take 5 seconds to
2887 execute, you should make the interval at least 6 seconds.
2894 <option>time</option>
2896 <option>(format)</option>
2898 <listitem>Local time, see man strftime to get more
2899 information about format
2905 <option>to_bytes</option>
2907 <option>size</option>
2909 <listitem>If 'size' is a number followed by a size-unit
2910 (kilobyte,mb,GiB,...) then it converts the size to bytes
2911 and shows it without unit, otherwise it just shows 'size'.
2917 <option>top</option>
2919 <option>type, num</option>
2921 <listitem>This takes arguments in the form:top (name)
2922 (number) Basically, processes are ranked from highest to
2923 lowest in terms of cpu usage, which is what (num)
2924 represents. The types are: "name", "pid", "cpu", "mem",
2925 "mem_res", "mem_vsize", "time", "io_perc", "io_read" and
2926 "io_write". There can be a max of 10 processes listed.
2932 <option>top_io</option>
2934 <option>type, num</option>
2936 <listitem>Same as top, except sorted by the amount of I/O
2937 the process has done during the update interval
2943 <option>top_mem</option>
2945 <option>type, num</option>
2947 <listitem>Same as top, except sorted by mem usage instead
2954 <option>top_time</option>
2956 <option>type, num</option>
2958 <listitem>Same as top, except sorted by total CPU time
2959 instead of current CPU usage
2965 <option>totaldown</option>
2967 <option>(net)</option>
2969 <listitem>Total download, overflows at 4 GB on Linux with
2970 32-bit arch and there doesn't seem to be a way to know how
2971 many times it has already done that before conky has
2978 <option>totalup</option>
2980 <option>(net)</option>
2982 <listitem>Total upload, this one too, may overflow
2988 <option>trashed_mails</option>
2990 <option>(maildir)</option>
2991 <option>(interval)</option>
2993 <listitem>Number of mails marked as trashed in the
2994 specified mailbox or mail spool if not. Only maildir type
2995 mailboxes are supported, mbox type will return -1.
3001 <option>tztime</option>
3003 <option>(timezone) (format)</option>
3005 <listitem>Local time for specified timezone, see man
3006 strftime to get more information about format. The timezone
3007 argument is specified in similar fashion as TZ environment
3008 variable. For hints, look in /usr/share/zoneinfo. e.g.
3009 US/Pacific, Europe/Zurich, etc.
3015 <option>unflagged_mails</option>
3017 <option>(maildir)</option>
3018 <option>(interval)</option>
3020 <listitem>Number of mails not marked as flagged in the
3021 specified mailbox or mail spool if not. Only maildir type
3022 mailboxes are supported, mbox type will return -1.
3028 <option>unforwarded_mails</option>
3030 <option>(maildir)</option>
3031 <option>(interval)</option>
3033 <listitem>Number of mails not marked as forwarded in the
3034 specified mailbox or mail spool if not. Only maildir type
3035 mailboxes are supported, mbox type will return -1.
3041 <option>unreplied_mails</option>
3043 <option>(maildir)</option>
3044 <option>(interval)</option>
3046 <listitem>Number of mails not marked as replied in the
3047 specified mailbox or mail spool if not. Only maildir type
3048 mailboxes are supported, mbox type will return -1.
3054 <option>unseen_mails</option>
3056 <option>(maildir)</option>
3057 <option>(interval)</option>
3059 <listitem>Number of new or unseen mails in the specified
3060 mailbox or mail spool if not. Only maildir type mailboxes
3061 are supported, mbox type will return -1.
3067 <option>updates</option>
3069 <option>Number of updates</option>
3071 <listitem>for debugging
3077 <option>upspeed</option>
3079 <option>(net)</option>
3081 <listitem>Upload speed in suitable IEC units
3087 <option>upspeedf</option>
3089 <option>(net)</option>
3091 <listitem>Upload speed in KiB with one decimal
3097 <option>upspeedgraph</option>
3099 <option>(netdev) ("normal"|"log") (height),(width)
3100 (gradient colour 1) (gradient colour 2) (scale)
3103 <listitem>Upload speed graph, colours defined in hex, minus
3104 the #. If scale is non-zero, it becomes the scale for the
3105 graph. Uses a logarithmic scale (to see small numbers) when
3106 you use "log" instead of "normal". Takes the switch '-t' to
3107 use a temperature gradient, which makes the gradient values
3108 change depending on the amplitude of a particular graph
3109 value (try it and see).
3115 <option>uptime</option>
3124 <option>uptime_short</option>
3127 <listitem>Uptime in a shorter format
3133 <option>user_names</option>
3136 <listitem>Lists the names of the users logged in
3142 <option>user_number</option>
3145 <listitem>Number of users logged in
3151 <option>user_terms</option>
3154 <listitem>Lists the consoles in use
3160 <option>user_times</option>
3163 <listitem>Lists how long users have been logged in for
3169 <option>utime</option>
3171 <option>(format)</option>
3173 <listitem>Display time in UTC (universal coordinate time).
3179 <option>voffset</option>
3181 <option>(pixels)</option>
3183 <listitem>Change vertical offset by N pixels. Negative
3184 values will cause text to overlap. See also $offset.
3190 <option>voltage_mv</option>
3192 <option>(n)</option>
3194 <listitem>Returns CPU #n's voltage in mV. CPUs are counted
3195 from 1. If omitted, the parameter defaults to 1.
3201 <option>voltage_v</option>
3203 <option>(n)</option>
3205 <listitem>Returns CPU #n's voltage in V. CPUs are counted
3206 from 1. If omitted, the parameter defaults to 1.
3212 <option>wireless_ap</option>
3214 <option>(net)</option>
3216 <listitem>Wireless access point MAC address (Linux only)
3222 <option>wireless_bitrate</option>
3224 <option>(net)</option>
3226 <listitem>Wireless bitrate (ie 11 Mb/s) (Linux only)
3232 <option>wireless_essid</option>
3234 <option>(net)</option>
3236 <listitem>Wireless access point ESSID (Linux only)
3242 <option>wireless_link_bar</option>
3244 <option>(height),(width) (net)</option>
3246 <listitem>Wireless link quality bar (Linux only)
3252 <option>wireless_link_qual</option>
3254 <option>(net)</option>
3256 <listitem>Wireless link quality (Linux only)
3262 <option>wireless_link_qual_max</option>
3264 <option>(net)</option>
3266 <listitem>Wireless link quality maximum value (Linux only)
3272 <option>wireless_link_qual_perc</option>
3274 <option>(net)</option>
3276 <listitem>Wireless link quality in percents (Linux only)
3282 <option>wireless_mode</option>
3284 <option>(net)</option>
3286 <listitem>Wireless mode (Managed/Ad-Hoc/Master) (Linux
3293 <option>words</option>
3295 <option>textfile</option>
3297 <listitem>Displays the number of words in the given file
3303 <option>xmms2_album</option>
3306 <listitem>Album in current XMMS2 song
3312 <option>xmms2_artist</option>
3315 <listitem>Artist in current XMMS2 song
3321 <option>xmms2_bar</option>
3323 <option>(height),(width)</option>
3325 <listitem>Bar of XMMS2's progress
3331 <option>xmms2_bitrate</option>
3334 <listitem>Bitrate of current song
3340 <option>xmms2_comment</option>
3343 <listitem>Comment in current XMMS2 song
3349 <option>xmms2_date</option>
3352 <listitem>Returns song's date.
3358 <option>xmms2_duration</option>
3361 <listitem>Duration of current song
3367 <option>xmms2_elapsed</option>
3370 <listitem>Song's elapsed time
3376 <option>xmms2_genre</option>
3379 <listitem>Genre in current XMMS2 song
3385 <option>xmms2_id</option>
3388 <listitem>XMMS2 id of current song
3394 <option>xmms2_percent</option>
3397 <listitem>Percent of song's progress
3403 <option>xmms2_playlist</option>
3406 <listitem>Returns the XMMS2 playlist.
3412 <option>xmms2_size</option>
3415 <listitem>Size of current song
3421 <option>xmms2_smart</option>
3424 <listitem>Prints the song name in either the form "artist -
3425 title" or file name, depending on whats available
3431 <option>xmms2_status</option>
3434 <listitem>XMMS2 status (Playing, Paused, Stopped, or
3441 <option>xmms2_timesplayed</option>
3444 <listitem>Number of times a song was played (presumably).
3450 <option>xmms2_title</option>
3453 <listitem>Title in current XMMS2 song
3459 <option>xmms2_tracknr</option>
3462 <listitem>Track number in current XMMS2 song
3468 <option>xmms2_url</option>
3471 <listitem>Full path to current song
projects / monky / blob