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.
466 <option>bmpx_album</option>
469 <listitem>Album in current BMPx track
475 <option>bmpx_artist</option>
478 <listitem>Artist in current BMPx track
484 <option>bmpx_bitrate</option>
487 <listitem>Bitrate of the current BMPx track
493 <option>bmpx_title</option>
496 <listitem>Title of the current BMPx track
502 <option>bmpx_track</option>
505 <listitem>Track number of the current BMPx track
511 <option>bmpx_uri</option>
514 <listitem>URI of the current BMPx track
520 <option>buffers</option>
523 <listitem>Amount of memory buffered
529 <option>cached</option>
532 <listitem>Amount of memory cached
538 <option>color</option>
540 <option>(color)</option>
542 <listitem>Change drawing color to color
548 <option>colorN</option>
551 <listitem>Change drawing color to colorN configuration
552 option, where N is a digit between 0 and 9, inclusively.
558 <option>combine</option>
560 <option>var1 var2</option>
562 <listitem>Places the lines of var2 to the right of the
563 lines of var1 seperated by the chars that are put between
564 var1 and var2. For example: ${combine ${head /proc/cpuinfo
565 2} - ${head /proc/meminfo 1}} gives as output
566 "cpuinfo_line1 - meminfo_line1" on line 1 and
567 "cpuinfo_line2 -" on line 2. $combine vars can also be
568 nested to place more vars next to each other.
574 <option>conky_build_arch</option>
577 <listitem>CPU architecture Conky was built for
583 <option>conky_build_date</option>
586 <listitem>Date Conky was built
592 <option>conky_version</option>
595 <listitem>Conky version
603 <option>(cpuN)</option>
605 <listitem>CPU usage in percents. For SMP machines, the CPU
606 number can be provided as an argument. ${cpu cpu0} is the
607 total usage, and ${cpu cpuX} (X >= 1) are individual
614 <option>cpubar</option>
616 <option>(cpuN) (height),(width)</option>
618 <listitem>Bar that shows CPU usage, height is bar's height
619 in pixels. See $cpu for more info on SMP.
625 <option>cpugauge</option>
627 <option>(cpuN) (height),(width)</option>
629 <listitem>Elliptical gauge that shows CPU usage, height and
630 width are gauge's vertical and horizontal axis
631 respectively. See $cpu for more info on SMP.
637 <option>cpugraph</option>
639 <option>(cpuN) ("normal"|"log") (height),(width)
640 (gradient colour 1) (gradient colour 2) (scale)
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 "log"
646 instead of "normal". Takes the switch '-t' to use a
647 temperature gradient, which makes the gradient values
648 change depending on the amplitude of a particular graph
649 value (try it and see).
655 <option>disk_protect</option>
657 <option>device</option>
659 <listitem>Disk protection status, if supported (needs
660 kernel-patch). Prints either "frozen" or "free " (note the
667 <option>diskio</option>
669 <option>(device)</option>
671 <listitem>Displays current disk IO. Device is optional, and
672 takes the form of sda for /dev/sda. Individual partitions
679 <option>diskio_read</option>
681 <option>(device)</option>
683 <listitem>Displays current disk IO for reads. Device as in
690 <option>diskio_write</option>
692 <option>(device)</option>
694 <listitem>Displays current disk IO for writes. Device as in
701 <option>diskiograph</option>
703 <option>(device) ("normal"|"log") (height),(width)
704 (gradient colour 1) (gradient colour 2) (scale)
707 <listitem>Disk IO graph, colours defined in hex, minus the
708 #. If scale is non-zero, it becomes the scale for the
709 graph. Uses a logarithmic scale (to see small numbers) when
710 you use "log" instead of "normal". Takes the switch '-t' to
711 use a temperature gradient, which makes the gradient values
712 change depending on the amplitude of a particular graph
713 value (try it and see).
719 <option>diskiograph_read</option>
721 <option>(device) ("normal"|"log") (height),(width)
722 (gradient colour 1) (gradient colour 2) (scale)
725 <listitem>Disk IO graph for reads, colours defined in hex,
726 minus the #. If scale is non-zero, it becomes the scale for
727 the graph. Device as in diskio. Uses a logarithmic scale
728 (to see small numbers) when you use "log" instead of
729 "normal". Takes the switch '-t' to use a temperature
730 gradient, which makes the gradient values change depending
731 on the amplitude of a particular graph value (try it and
738 <option>diskiograph_write</option>
740 <option>(device) ("normal"|"log") (height),(width)
741 (gradient colour 1) (gradient colour 2) (scale)
744 <listitem>Disk IO graph for writes, colours defined in hex,
745 minus the #. If scale is non-zero, it becomes the scale for
746 the graph. Device as in diskio. Uses a logarithmic scale
747 (to see small numbers) when you use "log" instead of
748 "normal". Takes the switch '-t' to use a temperature
749 gradient, which makes the gradient values change depending
750 on the amplitude of a particular graph value (try it and
757 <option>downspeed</option>
759 <option>(net)</option>
761 <listitem>Download speed in KiB
767 <option>downspeedf</option>
769 <option>(net)</option>
771 <listitem>Download speed in KiB with one decimal
777 <option>downspeedgraph</option>
779 <option>(netdev) ("normal"|"log") (height),(width)
780 (gradient colour 1) (gradient colour 2) (scale)
783 <listitem>Download speed graph, colours defined in hex,
784 minus the #. If scale is non-zero, it becomes the scale for
785 the graph. Uses a logarithmic scale (to see small numbers)
786 when you use "log" instead of "normal". Takes the switch
787 '-t' to use a temperature gradient, which makes the
788 gradient values change depending on the amplitude of a
789 particular graph value (try it and see).
795 <option>draft_mails</option>
797 <option>(maildir)</option>
798 <option>(interval)</option>
800 <listitem>Number of mails marked as draft in the specified
801 mailbox or mail spool if not. Only maildir type mailboxes
802 are supported, mbox type will return -1.
808 <option>else</option>
811 <listitem>Text to show if any of the above are not true
817 <option>endif</option>
821 <listitem>Ends an $if block.
827 <option>entropy_avail</option>
830 <listitem>Current entropy available for crypto freaks
836 <option>entropy_bar</option>
838 <option>(height),(width)</option>
840 <listitem>Normalized bar of available entropy for crypto
847 <option>entropy_perc</option>
850 <listitem>Percentage of entropy available in comparison to
857 <option>entropy_poolsize</option>
860 <listitem>Total size of system entropy pool for crypto
867 <option>eval</option>
869 <option>string</option>
871 <listitem>Evalutates given string according to the rules of
872 TEXT interpretation, i.e. parsing any contained text object
873 specifications into their output, any occuring '$$' into a
874 single '$' and so on. The output is then being parsed
883 <option>api_userid api_key character_id</option>
885 <listitem>Fetches your currently training skill from the
886 Eve Online API servers (http://www.eve-online.com/) and
887 displays the skill along with the remaining training time.
893 <option>exec</option>
895 <option>command</option>
897 <listitem>Executes a shell command and displays the output
898 in conky. warning: this takes a lot more resources than
899 other variables. I'd recommend coding wanted behaviour in C
906 <option>execbar</option>
908 <option>command</option>
910 <listitem>Same as exec, except if the first value return is
911 a value between 0-100, it will use that number for a bar.
912 The size for bars can be controlled via the
913 default_bar_size config setting.
919 <option>execgauge</option>
921 <option>command</option>
923 <listitem>Same as exec, except if the first value returned
924 is a value between 0-100, it will use that number for a
925 gauge. The size for gauges can be controlled via the
926 default_gauge_size config setting.
932 <option>execgraph</option>
934 <option>("normal"|"log") (-t) command</option>
936 <listitem>Same as execbar, but graphs values. Uses a
937 logaritmic scale when the log option is given (to see small
938 numbers). Values still have to be between 0 and 100. The
939 size for graphs can be controlled via the
940 default_graph_size config setting. Takes the switch '-t' to
941 use a temperature gradient, which makes the gradient values
942 change depending on the amplitude of a particular graph
943 value (try it and see).
949 <option>execi</option>
951 <option>interval command</option>
953 <listitem>Same as exec but with specific interval. Interval
954 can't be less than update_interval in configuration. See
961 <option>execibar</option>
963 <option>interval command</option>
965 <listitem>Same as execbar, except with an interval
971 <option>execigauge</option>
973 <option>interval command</option>
975 <listitem>Same as execgauge, but takes an interval arg and
982 <option>execigraph</option>
984 <option>interval ("normal"|"log") (-t) command</option>
986 <listitem>Same as execgraph, but takes an interval arg and
993 <option>execp</option>
995 <option>command</option>
997 <listitem>Executes a shell command and displays the output
998 in conky. warning: this takes a lot more resources than
999 other variables. I'd recommend coding wanted behaviour in C
1000 and posting a patch. This differs from $exec in that it
1001 parses the output of the command, so you can insert things
1002 like ${color red}hi!${color} in your script and have it
1003 correctly parsed by Conky. Caveats: Conky parses and
1004 evaluates the output of $execp every time Conky loops, and
1005 then destroys all the objects. If you try to use anything
1006 like $execi within an $execp statement, it will
1007 functionally run at the same interval that the $execp
1008 statement runs, as it is created and destroyed at every
1015 <option>execpi</option>
1017 <option>interval command</option>
1019 <listitem>Same as execp but with specific interval.
1020 Interval can't be less than update_interval in
1021 configuration. Note that the output from the $execpi
1022 command is still parsed and evaluated at every interval.
1028 <option>flagged_mails</option>
1030 <option>(maildir)</option>
1031 <option>(interval)</option>
1033 <listitem>Number of mails marked as flagged in the
1034 specified mailbox or mail spool if not. Only maildir type
1035 mailboxes are supported, mbox type will return -1.
1041 <option>font</option>
1043 <option>(font)</option>
1045 <listitem>Specify a different font. This new font will
1046 apply to the current line and everything following. You can
1047 use a $font with no arguments to change back to the default
1048 font (much like with $color)
1054 <option>forwarded_mails</option>
1056 <option>(maildir)</option>
1057 <option>(interval)</option>
1059 <listitem>Number of mails marked as forwarded in the
1060 specified mailbox or mail spool if not. Only maildir type
1061 mailboxes are supported, mbox type will return -1.
1067 <option>freq</option>
1069 <option>(n)</option>
1071 <listitem>Returns CPU #n's frequency in MHz. CPUs are
1072 counted from 1. If omitted, the parameter defaults to 1.
1078 <option>freq_g</option>
1080 <option>(n)</option>
1082 <listitem>Returns CPU #n's frequency in GHz. CPUs are
1083 counted from 1. If omitted, the parameter defaults to 1.
1089 <option>fs_bar</option>
1091 <option>(height),(width) fs</option>
1093 <listitem>Bar that shows how much space is used on a file
1094 system. height is the height in pixels. fs is any file on
1101 <option>fs_bar_free</option>
1103 <option>(height),(width) fs</option>
1105 <listitem>Bar that shows how much space is free on a file
1106 system. height is the height in pixels. fs is any file on
1113 <option>fs_free</option>
1115 <option>(fs)</option>
1117 <listitem>Free space on a file system available for users.
1123 <option>fs_free_perc</option>
1125 <option>(fs)</option>
1127 <listitem>Free percentage of space on a file system
1128 available for users.
1134 <option>fs_size</option>
1136 <option>(fs)</option>
1138 <listitem>File system size.
1144 <option>fs_type</option>
1146 <option>(fs)</option>
1148 <listitem>File system type.
1154 <option>fs_used</option>
1156 <option>(fs)</option>
1158 <listitem>File system used space.
1164 <option>fs_used_perc</option>
1166 <option>(fs)</option>
1168 <listitem>Percent of file system used space.
1174 <option>goto</option>
1178 <listitem>The next element will be printed at position 'x'.
1185 <option>gw_iface</option>
1188 <listitem>Displays the default route's interface or
1189 "multiple"/"none" accordingly.
1195 <option>gw_ip</option>
1198 <listitem>Displays the default gateway's IP or
1199 "multiple"/"none" accordingly.
1205 <option>hddtemp</option>
1207 <option>dev, (host,(port))</option>
1209 <listitem>Displays temperature of a selected hard disk
1210 drive as reported by the hddtemp daemon running on
1211 host:port. Default host is 127.0.0.1, default port is 7634.
1218 <option>head</option>
1220 <option>logfile lines (interval)</option>
1222 <listitem>Displays first N lines of supplied text text
1223 file. If interval is not supplied, Conky assumes 2x Conky's
1224 interval. Max of 30 lines can be displayed, or until the
1225 text buffer is filled.
1233 <option>(height)</option>
1235 <listitem>Horizontal line, height is the height in pixels
1241 <option>hwmon</option>
1243 <option>(dev) type n (factor offset)</option>
1245 <listitem>Hwmon sensor from sysfs (Linux 2.6). Parameter
1246 dev may be omitted if you have only one hwmon device.
1247 Parameter type is either 'in' or 'vol' meaning voltage;
1248 'fan' meaning fan; 'temp' meaning temperature. Parameter n
1249 is number of the sensor. See /sys/class/hwmon/ on your
1250 local computer. The optional arguments 'factor' and
1251 'offset' allow precalculation of the raw input, which is
1252 being modified as follows: 'input = input * factor +
1253 offset'. Note that they have to be given as decimal values
1254 (i.e. contain at least one decimal place).
1260 <option>i2c</option>
1262 <option>(dev) type n (factor offset)</option>
1264 <listitem>I2C sensor from sysfs (Linux 2.6). Parameter dev
1265 may be omitted if you have only one I2C device. Parameter
1266 type is either 'in' or 'vol' meaning voltage; 'fan' meaning
1267 fan; 'temp' meaning temperature. Parameter n is number of
1268 the sensor. See /sys/bus/i2c/devices/ on your local
1269 computer. The optional arguments 'factor' and 'offset'
1270 allow precalculation of the raw input, which is being
1271 modified as follows: 'input = input * factor + offset'.
1272 Note that they have to be given as decimal values (i.e.
1273 contain at least one decimal place).
1279 <option>i8k_ac_status</option>
1283 <listitem>If running the i8k kernel driver for Inspiron
1284 laptops, displays whether ac power is on, as listed in
1285 /proc/i8k (translated to human-readable). Beware that this
1286 is by default not enabled by i8k itself.
1292 <option>i8k_bios</option>
1296 <listitem>If running the i8k kernel driver for Inspiron
1297 laptops, displays the bios version as listed in /proc/i8k.
1303 <option>i8k_buttons_status</option>
1307 <listitem>If running the i8k kernel driver for Inspiron
1308 laptops, displays the volume buttons status as listed in
1315 <option>i8k_cpu_temp</option>
1319 <listitem>If running the i8k kernel driver for Inspiron
1320 laptops, displays the cpu temperature in Celsius, as
1321 reported by /proc/i8k.
1327 <option>i8k_left_fan_rpm</option>
1331 <listitem>If running the i8k kernel driver for Inspiron
1332 laptops, displays the left fan's rate of rotation, in
1333 revolutions per minute as listed in /proc/i8k. Beware, some
1334 laptops i8k reports these fans in reverse order.
1340 <option>i8k_left_fan_status</option>
1344 <listitem>If running the i8k kernel driver for Inspiron
1345 laptops, displays the left fan status as listed in
1346 /proc/i8k (translated to human-readable). Beware, some
1347 laptops i8k reports these fans in reverse order.
1353 <option>i8k_right_fan_rpm</option>
1357 <listitem>If running the i8k kernel driver for Inspiron
1358 laptops, displays the right fan's rate of rotation, in
1359 revolutions per minute as listed in /proc/i8k. Beware, some
1360 laptops i8k reports these fans in reverse order.
1366 <option>i8k_right_fan_status</option>
1370 <listitem>If running the i8k kernel driver for Inspiron
1371 laptops, displays the right fan status as listed in
1372 /proc/i8k (translated to human-readable). Beware, some
1373 laptops i8k reports these fans in reverse order.
1379 <option>i8k_serial</option>
1383 <listitem>If running the i8k kernel driver for Inspiron
1384 laptops, displays your laptop serial number as listed in
1391 <option>i8k_version</option>
1395 <listitem>If running the i8k kernel driver for Inspiron
1396 laptops, displays the version formatting of /proc/i8k.
1402 <option>ibm_brightness</option>
1405 <listitem>If running the IBM ACPI, displays the brigtness
1406 of the laptops's LCD (0-7).
1412 <option>ibm_fan</option>
1415 <listitem>If running the IBM ACPI, displays the fan speed.
1421 <option>ibm_temps</option>
1425 <listitem>If running the IBM ACPI, displays the
1426 temperatures from the IBM temperature sensors (N=0..7)
1427 Sensor 0 is on the CPU, 3 is on the GPU.
1433 <option>ibm_volume</option>
1436 <listitem>If running the IBM ACPI, displays the "master"
1437 volume, controlled by the volume keys (0-14).
1443 <option>iconv_start</option>
1445 <option>codeset_from codeset_to</option>
1447 <listitem>Convert text from one codeset to another using
1448 GNU iconv. Needs to be stopped with iconv_stop.
1454 <option>iconv_stop</option>
1458 <listitem>Stop iconv codeset conversion.
1464 <option>if_empty</option>
1466 <option>(var)</option>
1468 <listitem>if conky variable VAR is empty, display
1469 everything between $if_empty and the matching $endif
1475 <option>if_existing</option>
1477 <option>file (string)</option>
1479 <listitem>if FILE exists, display everything between
1480 if_existing and the matching $endif. The optional second
1481 paramater checks for FILE containing the specified string
1482 and prints everything between $if_existing and the matching
1489 <option>if_gw</option>
1492 <listitem>if there is at least one default gateway, display
1493 everything between $if_gw and the matching $endif
1499 <option>if_match</option>
1501 <option>expression</option>
1503 <listitem>Evaluates the given boolean expression, printing
1504 everything between $if_match and the matching $endif
1505 depending on whether the evaluation returns true or not.
1506 Valid expressions consist of a left side, an operator and a
1507 right side. Left and right sides are being parsed for
1508 contained text objects before evaluation. Recognised left
1509 and right side types are:
1512 <command>double</command>: argument consists of only
1513 digits and a single dot.</member>
1515 <command>long</command>: argument consists of only
1518 <command>string</command>: argument is enclosed in
1519 quotation mark or the checks for double and long failed
1521 </simplelist>Valid operands are: '>', '<', '>=',
1522 '<=', '==', '!='.
1528 <option>if_mixer_mute</option>
1530 <option>(mixer)</option>
1532 <listitem>If mixer exists, display everything between
1533 $if_mixer_mute and the matching $endif. If no mixer is
1534 specified, "Master" is used.
1540 <option>if_mounted</option>
1542 <option>(mountpoint)</option>
1544 <listitem>if MOUNTPOINT is mounted, display everything
1545 between $if_mounted and the matching $endif
1551 <option>if_mpd_playing</option>
1554 <listitem>if mpd is playing or paused, display everything
1555 between $if_mpd_playing and the matching $endif
1561 <option>if_running</option>
1563 <option>(process)</option>
1565 <listitem>if PROCESS is running, display everything
1566 $if_running and the matching $endif. This uses the
1567 ``pidof'' command, so the -x switch is also supported.
1573 <option>if_smapi_bat_installed</option>
1575 <option>(INDEX)</option>
1577 <listitem>when using smapi, if the battery with index INDEX
1578 is installed, display everything between
1579 $if_smapi_bat_installed and the matching $endif
1585 <option>if_up</option>
1587 <option>(interface)</option>
1589 <listitem>if INTERFACE exists and is up, display everything
1590 between $if_up and the matching $endif
1596 <option>if_updatenr</option>
1598 <option>(updatenr)</option>
1600 <listitem>If it's the UPDATENR-th time that conky updates,
1601 display everything between $if_updatenr and the matching
1602 $endif. The counter resets when the highest UPDATENR is
1603 reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr
1604 2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the
1605 time followed by bar 25% of the time followed by nothing
1606 the other half of the time.
1612 <option>if_xmms2_connected</option>
1615 <listitem>Display everything between $if_xmms2_connected
1616 and the matching $endif if xmms2 is running.
1622 <option>image</option>
1624 <option><path to image> (-p x,y) (-s WxH) (-n)
1625 (-f interval)</option>
1627 <listitem>Renders an image from the path specified using
1628 Imlib2. Takes 4 optional arguments: a position, a size, a
1629 no-cache switch, and a cache flush interval. Changing the
1630 x,y position will move the position of the image, and
1631 changing the WxH will scale the image. If you specify the
1632 no-cache flag (-n), the image will not be cached.
1633 Alternately, you can specify the -f int switch to specify a
1634 cache flust interval for a particular image. Example:
1635 ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200}
1636 will render 'cheeseburger.jpg' at (20,20) scaled to 200x200
1637 pixels. Conky does not make any attempt to adjust the
1638 position (or any other formatting) of images, they are just
1639 rendered as per the arguments passed. The only reason
1640 $image is part of the TEXT section, is to allow for runtime
1641 modifications, through $execp $lua_parse, $lua_read_parse,
1642 or some other method.
1648 <option>imap_messages</option>
1650 <option>(args)</option>
1652 <listitem>Displays the number of messages in your global
1653 IMAP inbox by default. You can define individual IMAP
1654 inboxes seperately by passing arguments to this object.
1655 Arguments are: "host user pass [-i interval (in seconds)]
1656 [-f folder] [-p port] [-e command] [-r retries]". Default
1657 port is 143, default folder is 'INBOX', default interval is
1658 5 minutes, and default number of retries before giving up
1659 is 5. If the password is supplied as '*', you will be
1660 prompted to enter the password when Conky starts.
1666 <option>imap_unseen</option>
1668 <option>(args)</option>
1670 <listitem>Displays the number of unseen messages in your
1671 global IMAP inbox by default. You can define individual
1672 IMAP inboxes seperately by passing arguments to this
1673 object. Arguments are: "host user pass [-i interval (in
1674 seconds)] [-f folder] [-p port] [-e command] [-r retries]".
1675 Default port is 143, default folder is 'INBOX', default
1676 interval is 5 minutes, and default number of retries before
1677 giving up is 5. If the password is supplied as '*', you
1678 will be prompted to enter the password when Conky starts.
1684 <option>ioscheduler</option>
1686 <option>disk</option>
1688 <listitem>Prints the current ioscheduler used for the given
1689 disk name (i.e. e.g. "hda" or "sdb")
1695 <option>kernel</option>
1698 <listitem>Kernel version
1704 <option>laptop_mode</option>
1707 <listitem>The value of /proc/sys/vm/laptop_mode
1713 <option>lines</option>
1715 <option>textfile</option>
1717 <listitem>Displays the number of lines in the given file
1723 <option>loadavg</option>
1726 <listitem>(1,2,3)> System load average, 1 is for past 1
1727 minute, 2 for past 5 minutes and 3 for past 15 minutes.
1733 <option>loadgraph</option>
1735 <option>("normal"|"log") (height),(width) (gradient
1736 colour 1) (gradient colour 2) (scale) (-t)</option>
1738 <listitem>Load1 average graph, similar to xload, with
1739 optional colours in hex, minus the #. Uses a logarithmic
1740 scale (to see small numbers) when you use "log" instead of
1741 "normal". Takes the switch '-t' to use a temperature
1742 gradient, which makes the gradient values change depending
1743 on the amplitude of a particular graph value (try it and
1750 <option>lua</option>
1752 <option>function_name (function parameters)</option>
1754 <listitem>Executes a Lua function with given parameters,
1755 then prints the returned string. See also 'lua_load' on how
1762 <option>lua_bar</option>
1764 <option>(height, width) function_name (function
1765 parameters)</option>
1767 <listitem>Executes a Lua function with given parameters and
1768 draws a bar. Expects result value to be an integer between
1769 0 and 100. See also 'lua_load' on how to load scripts.
1775 <option>lua_gauge</option>
1777 <option>(height, width) function_name (function
1778 parameters)</option>
1780 <listitem>Executes a Lua function with given parameters and
1781 draws a gauge. Expects result value to be an integer
1782 between 0 and 100. See also 'lua_load' on how to load
1789 <option>lua_graph</option>
1791 <option>function_name (function parameters)
1792 ("normal"|"log") (height),(width) (gradient colour 1)
1793 (gradient colour 2) (scale) (-t)</option>
1795 <listitem>Executes a Lua function with given parameters and
1796 draws a graph. Expects result value to be any number, and
1797 by default will scale to show the full range. See also
1798 'lua_load' on how to load scripts. Takes the switch '-t' to
1799 use a temperature gradient, which makes the gradient values
1800 change depending on the amplitude of a particular graph
1801 value (try it and see).
1807 <option>lua_parse</option>
1809 <option>function_name (function parameters)</option>
1811 <listitem>Executes a Lua function with given parameters as
1812 per $lua, then parses and prints the result value as per
1813 the syntax for Conky's TEXT section. See also 'lua_load' on
1814 how to load scripts.
1820 <option>lua_read_parse</option>
1822 <option>function_name (conky text)</option>
1824 <listitem>Executes a Lua function per $lua, except takes a
1825 2nd argument which is first evaluated as per Conky's TEXT
1826 section and passed to the function first. The return value
1827 is then parsed and prints the result value as per the
1828 syntax for Conky's TEXT section. See also 'lua_load' on how
1835 <option>machine</option>
1838 <listitem>Machine, i686 for example
1844 <option>mails</option>
1846 <option>(mailbox)</option>
1847 <option>(interval)</option>
1849 <listitem>Mail count in the specified mailbox or your mail
1850 spool if not. Both mbox and maildir type mailboxes are
1851 supported. You can use a program like fetchmail to get
1852 mails from some server using your favourite protocol. See
1859 <option>mboxscan</option>
1861 <option>(-n number of messages to print) (-fw from
1862 width) (-sw subject width) mbox</option>
1864 <listitem>Print a summary of recent messages in an mbox
1865 format mailbox. mbox parameter is the filename of the
1866 mailbox (can be encapsulated using '"', ie. ${mboxscan -n
1867 10 "/home/brenden/some box"}
1873 <option>mem</option>
1876 <listitem>Amount of memory in use
1882 <option>membar</option>
1884 <option>(height),(width)</option>
1886 <listitem>Bar that shows amount of memory in use
1892 <option>memeasyfree</option>
1895 <listitem>Amount of free memory including the memory that
1896 is very easily freed (buffers/cache)
1902 <option>memfree</option>
1905 <listitem>Amount of free memory
1911 <option>memgauge</option>
1913 <option>(height),(width)</option>
1915 <listitem>Gauge that shows amount of memory in use (see
1922 <option>memgraph</option>
1924 <option>("normal"|"log") (height),(width) (gradient
1925 colour 1) (gradient colour 2) (scale) (-t)</option>
1927 <listitem>Memory usage graph. Uses a logarithmic scale (to
1928 see small numbers) when you use "log" instead of "normal".
1929 Takes the switch '-t' to use a temperature gradient, which
1930 makes the gradient values change depending on the amplitude
1931 of a particular graph value (try it and see).
1937 <option>memmax</option>
1940 <listitem>Total amount of memory
1946 <option>memperc</option>
1949 <listitem>Percentage of memory in use
1955 <option>mixer</option>
1957 <option>(device)</option>
1959 <listitem>Prints the mixer value as reported by the OS.
1960 Default mixer is "vol", but you can specify one of the
1961 following optional arguments: "vol", "bass", "treble",
1962 "synth", "pcm", "speaker", "line", "mic", "cd", "mix",
1963 "pcm2", "rec", "igain", "ogain", "line1", "line2", "line3",
1964 "dig1", "dig2", "dig3", "phin", "phout", "video", "radio",
1965 "monitor". Refer to the definition of SOUND_DEVICE_NAMES in
1966 <linux/soundcard.h> (on Linux), <soundcard.h>
1967 (on OpenBSD), or <sys/soundcard.h> to find the exact
1968 options available on your system.
1974 <option>mixerbar</option>
1976 <option>(device)</option>
1978 <listitem>Displays mixer value in a bar as reported by the
1979 OS. See docs for $mixer for details on arguments.
1985 <option>mixerl</option>
1987 <option>(device)</option>
1989 <listitem>Prints the left channel mixer value as reported
1990 by the OS. See docs for $mixer for details on arguments.
1996 <option>mixerlbar</option>
1998 <option>(device)</option>
2000 <listitem>Displays the left channel mixer value in a bar as
2001 reported by the OS. See docs for $mixer for details on
2008 <option>mixerr</option>
2010 <option>(device)</option>
2012 <listitem>Prints the right channel mixer value as reported
2013 by the OS. See docs for $mixer for details on arguments.
2019 <option>mixerrbar</option>
2021 <option>(device)</option>
2023 <listitem>Displays the right channel mixer value in a bar
2024 as reported by the OS. See docs for $mixer for details on
2031 <option>moc_album</option>
2034 <listitem>Album of the current MOC song
2040 <option>moc_artist</option>
2043 <listitem>Artist of the current MOC song
2049 <option>moc_bitrate</option>
2052 <listitem>Bitrate in the current MOC song
2058 <option>moc_curtime</option>
2061 <listitem>Current time of the current MOC song
2067 <option>moc_file</option>
2070 <listitem>File name of the current MOC song
2076 <option>moc_rate</option>
2079 <listitem>Rate of the current MOC song
2085 <option>moc_song</option>
2088 <listitem>The current song name being played in MOC.
2094 <option>moc_state</option>
2097 <listitem>Current state of MOC; playing, stopped etc.
2103 <option>moc_timeleft</option>
2106 <listitem>Time left in the current MOC song
2112 <option>moc_title</option>
2115 <listitem>Title of the current MOC song
2121 <option>moc_totaltime</option>
2124 <listitem>Total length of the current MOC song
2130 <option>monitor</option>
2133 <listitem>Number of the monitor on which conky is running
2139 <option>monitor_number</option>
2142 <listitem>Number of monitors
2148 <option>mpd_album</option>
2151 <listitem>Album in current MPD song
2157 <option>mpd_artist</option>
2160 <listitem>Artist in current MPD song must be enabled at
2167 <option>mpd_bar</option>
2169 <option>(height),(width)</option>
2171 <listitem>Bar of mpd's progress
2177 <option>mpd_bitrate</option>
2180 <listitem>Bitrate of current song
2186 <option>mpd_elapsed</option>
2189 <listitem>Song's elapsed time
2195 <option>mpd_file</option>
2198 <listitem>Prints the file name of the current MPD song
2204 <option>mpd_length</option>
2207 <listitem>Song's length
2213 <option>mpd_name</option>
2216 <listitem>Prints the MPD name field
2222 <option>mpd_percent</option>
2225 <listitem>Percent of song's progress
2231 <option>mpd_random</option>
2234 <listitem>Random status (On/Off)
2240 <option>mpd_repeat</option>
2243 <listitem>Repeat status (On/Off)
2249 <option>mpd_smart</option>
2251 <option>(max length)</option>
2253 <listitem>Prints the song name in either the form "artist -
2254 title" or file name, depending on whats available
2260 <option>mpd_status</option>
2263 <listitem>Playing, stopped, et cetera.
2269 <option>mpd_title</option>
2271 <option>(max length)</option>
2273 <listitem>Title of current MPD song
2279 <option>mpd_track</option>
2282 <listitem>Prints the MPD track field
2288 <option>mpd_vol</option>
2291 <listitem>MPD's volume
2297 <option>nameserver</option>
2299 <option>(index)</option>
2301 <listitem>Print a nameserver from /etc/resolv.conf. Index
2302 starts at and defaults to 0.
2308 <option>new_mails</option>
2310 <option>(mailbox)</option>
2311 <option>(interval)</option>
2313 <listitem>Unread mail count in the specified mailbox or
2314 mail spool if not. Both mbox and maildir type mailboxes are
2321 <option>nodename</option>
2330 <option>nvidia</option>
2332 <option>threshold</option>
2333 <option>temp</option>
2334 <option>ambient</option>
2335 <option>gpufreq</option>
2336 <option>memfreq</option>
2337 <option>imagequality</option>
2339 <listitem>Nvidia graficcard support for the XNVCtrl
2340 library. Each option can be shortened to the least
2341 significant part. Temperatures are printed as float, all
2342 other values as integer.
2345 <command>threshold</command>: the thresholdtemperature
2346 at which the gpu slows down</member>
2348 <command>temp</command>: gives the gpu current
2349 temperature</member>
2351 <command>ambient</command>: gives current air
2352 temperature near GPU case</member>
2354 <command>gpufreq</command>: gives the current gpu
2357 <command>memfreq</command>: gives the current mem
2360 <command>imagequality</command>: which imagequality
2361 should be choosen by OpenGL applications</member>
2368 <option>offset</option>
2370 <option>(pixels)</option>
2372 <listitem>Move text over by N pixels. See also $voffset.
2378 <option>outlinecolor</option>
2380 <option>(color)</option>
2382 <listitem>Change outline color
2388 <option>pb_battery</option>
2390 <option>item</option>
2392 <listitem>If running on Apple powerbook/ibook, display
2393 information on battery status. The item parameter
2394 specifies, what information to display. Exactly one item
2395 must be specified. Valid items are:
2398 <command>status</command>: Display if battery is fully
2399 charged, charging, discharging or absent (running on
2402 <command>percent</command>: Display charge of battery
2403 in percent, if charging or discharging. Nothing will be
2404 displayed, if battery is fully charged or
2407 <command>time</command>: Display the time remaining
2408 until the battery will be fully charged or discharged
2409 at current rate. Nothing is displayed, if battery is
2410 absent or if it's present but fully charged and not
2411 discharging.</member>
2418 <option>platform</option>
2420 <option>(dev) type n (factor offset)</option>
2422 <listitem>Platform sensor from sysfs (Linux 2.6). Parameter
2423 dev may be omitted if you have only one platform device.
2424 Platform type is either 'in' or 'vol' meaning voltage;
2425 'fan' meaning fan; 'temp' meaning temperature. Parameter n
2426 is number of the sensor. See /sys/bus/platform/devices/ on
2427 your local computer. The optional arguments 'factor' and
2428 'offset' allow precalculation of the raw input, which is
2429 being modified as follows: 'input = input * factor +
2430 offset'. Note that they have to be given as decimal values
2431 (i.e. contain at least one decimal place).
2437 <option>pop3_unseen</option>
2439 <option>(args)</option>
2441 <listitem>Displays the number of unseen messages in your
2442 global POP3 inbox by default. You can define individual
2443 POP3 inboxes seperately by passing arguments to this
2444 object. Arguments are: "host user pass [-i interval (in
2445 seconds)] [-p port] [-e command] [-r retries]". Default
2446 port is 110, default interval is 5 minutes, and default
2447 number of retries before giving up is 5. If the password is
2448 supplied as '*', you will be prompted to enter the password
2455 <option>pop3_used</option>
2457 <option>(args)</option>
2459 <listitem>Displays the amount of space (in MiB, 2^20) used
2460 in your global POP3 inbox by default. You can define
2461 individual POP3 inboxes seperately by passing arguments to
2462 this object. Arguments are: "host user pass [-i interval
2463 (in seconds)] [-p port] [-e command] [-r retries]". Default
2464 port is 110, default interval is 5 minutes, and default
2465 number of retries before giving up is 5. If the password is
2466 supplied as '*', you will be prompted to enter the password
2473 <option>pre_exec</option>
2475 <option>shell command</option>
2477 <listitem>Executes a shell command one time before conky
2478 displays anything and puts output as text.
2484 <option>processes</option>
2487 <listitem>Total processes (sleeping and running)
2493 <option>read_tcp</option>
2495 <option>(host) port</option>
2497 <listitem>Connects to a tcp port on a host (default is
2498 localhost), reads every char available at the moment and
2505 <option>replied_mails</option>
2507 <option>(maildir)</option>
2508 <option>(interval)</option>
2510 <listitem>Number of mails marked as replied in the
2511 specified mailbox or mail spool if not. Only maildir type
2512 mailboxes are supported, mbox type will return -1.
2518 <option>rss</option>
2520 <option>url delay_in_minutes action (num_par
2521 (spaces_in_front))</option>
2523 <listitem>Download and parse RSS feeds. Action may be one
2524 of the following: feed_title, item_title (with num par),
2525 item_desc (with num par) and item_titles (when using this
2526 action and spaces_in_front is given conky places that many
2527 spaces in front of each item).
2533 <option>running_processes</option>
2536 <listitem>Running processes (not sleeping), requires Linux
2543 <option>scroll</option>
2545 <option>length (step) text</option>
2547 <listitem>Scroll 'text' by 'step' characters showing
2548 'length' number of characters at the same time. The text
2549 may also contain variables. 'step' is optional and defaults
2550 to 1 if not set. If a var creates output on multiple lines
2551 then the lines are placed behind each other separated with
2552 a '|'-sign. Do NOT use vars that change colors or otherwise
2553 affect the design inside a scrolling text. If you want
2554 spaces between the start and the end of 'text', place them
2555 at the end of 'text' not at the front ("foobar" and "
2556 foobar" can both generate "barfoo" but "foobar " will keep
2557 the spaces like this "bar foo").
2563 <option>seen_mails</option>
2565 <option>(maildir)</option>
2566 <option>(interval)</option>
2568 <listitem>Number of mails marked as seen in the specified
2569 mailbox or mail spool if not. Only maildir type mailboxes
2570 are supported, mbox type will return -1.
2576 <option>shadecolor</option>
2578 <option>(color)</option>
2580 <listitem>Change shading color
2586 <option>smapi</option>
2588 <option>(ARGS)</option>
2590 <listitem>when using smapi, display contents of the
2591 /sys/devices/platform/smapi directory. ARGS are either
2592 '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the
2593 corresponding files' content. This is a very raw method of
2594 accessing the smapi values. When available, better use one
2595 of the smapi_* variables instead.
2601 <option>smapi_bat_bar</option>
2603 <option>(INDEX),(height),(width)</option>
2605 <listitem>when using smapi, display the remaining capacity
2606 of the battery with index INDEX as a bar.
2612 <option>smapi_bat_perc</option>
2614 <option>(INDEX)</option>
2616 <listitem>when using smapi, display the remaining capacity
2617 in percent of the battery with index INDEX. This is a
2618 separate variable because it supports the 'use_spacer'
2619 configuration option.
2625 <option>smapi_bat_power</option>
2627 <option>INDEX</option>
2629 <listitem>when using smapi, display the current power of
2630 the battery with index INDEX in watt. This is a separate
2631 variable because the original read out value is being
2632 converted from mW. The sign of the output reflects charging
2633 (positive) or discharging (negative) state.
2639 <option>smapi_bat_temp</option>
2641 <option>INDEX</option>
2643 <listitem>when using smapi, display the current temperature
2644 of the battery with index INDEX in degree Celsius. This is
2645 a separate variable because the original read out value is
2646 being converted from milli degree Celsius.
2652 <option>sony_fanspeed</option>
2655 <listitem>Displays the Sony VAIO fanspeed information if
2656 sony-laptop kernel support is enabled. Linux only.
2662 <option>stippled_hr</option>
2664 <option>(space)</option>
2666 <listitem>Stippled (dashed) horizontal line
2672 <option>swap</option>
2675 <listitem>Amount of swap in use
2681 <option>swapbar</option>
2683 <option>(height),(width)</option>
2685 <listitem>Bar that shows amount of swap in use
2691 <option>swapmax</option>
2694 <listitem>Total amount of swap
2700 <option>swapperc</option>
2703 <listitem>Percentage of swap in use
2709 <option>sysname</option>
2712 <listitem>System name, Linux for example
2718 <option>tab</option>
2720 <option>(width, (start))</option>
2722 <listitem>Puts a tab of the specified width, starting from
2723 column 'start'. The unit is pixels for both arguments.
2729 <option>tail</option>
2731 <option>logfile lines (interval)</option>
2733 <listitem>Displays last N lines of supplied text text file.
2734 If interval is not supplied, Conky assumes 2x Conky's
2735 interval. Max of 30 lines can be displayed, or until the
2736 text buffer is filled.
2742 <option>tcp_portmon</option>
2744 <option>port_begin port_end item (index)</option>
2745 <emphasis>(ip4 only at present)</emphasis>
2747 <listitem>TCP port monitor for specified local ports. Port
2748 numbers must be in the range 1 to 65535. Valid items are:
2751 <command>count</command>- total number of connections
2752 in the range</member>
2754 <command>rip</command>- remote ip address</member>
2756 <command>rhost</command>- remote host name</member>
2758 <command>rport</command>- remote port number</member>
2760 <command>rservice</command>- remote service name from
2761 /etc/services</member>
2763 <command>lip</command>- local ip address</member>
2765 <command>lhost</command>- local host name</member>
2767 <command>lport</command>- local port number</member>
2769 <command>lservice</command>- local service name from
2770 /etc/services</member>
2771 </simplelist>The connection index provides you with access
2772 to each connection in the port monitor. The monitor will
2773 return information for index values from 0 to n-1
2774 connections. Values higher than n-1 are simply ignored. For
2775 the "count" item, the connection index must be omitted. It
2776 is required for all other items.
2778 <member>Examples:</member>
2780 <command>${tcp_portmon 6881 6999 count}</command>-
2781 displays the number of connections in the bittorrent
2784 <command>${tcp_portmon 22 22 rip 0}</command>- displays
2785 the remote host ip of the first sshd
2788 <command>${tcp_portmon 22 22 rip 9}</command>- displays
2789 the remote host ip of the tenth sshd
2792 <command>${tcp_portmon 1 1024 rhost 0}</command>-
2793 displays the remote host name of the first connection
2794 on a privileged port</member>
2796 <command>${tcp_portmon 1 1024 rport 4}</command>-
2797 displays the remote host port of the fifth connection
2798 on a privileged port</member>
2800 <command>${tcp_portmon 1 65535 lservice 14}</command>-
2801 displays the local service name of the fifteenth
2802 connection in the range of all ports</member>
2803 </simplelist>Note that port monitor variables which share
2804 the same port range actually refer to the same monitor, so
2805 many references to a single port range for different items
2806 and different indexes all use the same monitor internally.
2807 In other words, the program avoids creating redundant
2808 monitors.</listitem>
2813 <option>templateN</option>
2815 <option>(arg1)</option>
2816 <option>(arg2)</option>
2817 <option>(arg3 ...)</option>
2819 <listitem>Evaluate the content of the templateN
2820 configuration variable (where N is a value between 0 and 9,
2821 inclusively), applying substitutions as described in the
2822 documentation of the corresponding configuration variable.
2823 The number of arguments is optional, but must match the
2824 highest referred index in the template. You can use the
2825 same special sequences in each argument as the ones valid
2826 for a template definition, e.g. to allow an argument to
2827 contain a whitespace. Also simple nesting of templates is
2830 <listitem>Here are some examples of template definitions:
2832 <member>template0 $\1\2</member>
2833 <member>template1 \1: ${fs_used \2} / ${fs_size
2835 <member>template2 \1 \2</member>
2836 </simplelist>The following list shows sample usage of the
2837 templates defined above, with the equivalent syntax when
2838 not using any template at all:
2843 <entry>using template</entry>
2844 <entry>same without template</entry>
2849 <entry>${template0 node name}</entry>
2850 <entry>$nodename</entry>
2853 <entry>${template1 root /}</entry>
2854 <entry>root: ${fs_free /} / ${fs_size
2859 <programlisting>${template1
2860 ${template2\ disk\ root}
2864 <programlisting>disk root: ${fs_free /}
2865 / ${fs_size /}</programlisting>
2876 <option>texeci</option>
2878 <option>interval command</option>
2880 <listitem>Runs a command at an interval inside a thread and
2881 displays the output. Same as $execi, except the command is
2882 run inside a thread. Use this if you have a slow script to
2883 keep Conky updating. You should make the interval slightly
2884 longer then the time it takes your script to execute. For
2885 example, if you have a script that take 5 seconds to
2886 execute, you should make the interval at least 6 seconds.
2893 <option>time</option>
2895 <option>(format)</option>
2897 <listitem>Local time, see man strftime to get more
2898 information about format
2904 <option>to_bytes</option>
2906 <option>size</option>
2908 <listitem>If 'size' is a number followed by a size-unit
2909 (kilobyte,mb,GiB,...) then it converts the size to bytes
2910 and shows it without unit, otherwise it just shows 'size'.
2916 <option>top</option>
2918 <option>type, num</option>
2920 <listitem>This takes arguments in the form:top (name)
2921 (number) Basically, processes are ranked from highest to
2922 lowest in terms of cpu usage, which is what (num)
2923 represents. The types are: "name", "pid", "cpu", "mem",
2924 "mem_res", "mem_vsize", "time", "io_perc", "io_read" and
2925 "io_write". There can be a max of 10 processes listed.
2931 <option>top_io</option>
2933 <option>type, num</option>
2935 <listitem>Same as top, except sorted by the amount of I/O
2936 the process has done during the update interval
2942 <option>top_mem</option>
2944 <option>type, num</option>
2946 <listitem>Same as top, except sorted by mem usage instead
2953 <option>top_time</option>
2955 <option>type, num</option>
2957 <listitem>Same as top, except sorted by total CPU time
2958 instead of current CPU usage
2964 <option>totaldown</option>
2966 <option>(net)</option>
2968 <listitem>Total download, overflows at 4 GB on Linux with
2969 32-bit arch and there doesn't seem to be a way to know how
2970 many times it has already done that before conky has
2977 <option>totalup</option>
2979 <option>(net)</option>
2981 <listitem>Total upload, this one too, may overflow
2987 <option>trashed_mails</option>
2989 <option>(maildir)</option>
2990 <option>(interval)</option>
2992 <listitem>Number of mails marked as trashed in the
2993 specified mailbox or mail spool if not. Only maildir type
2994 mailboxes are supported, mbox type will return -1.
3000 <option>tztime</option>
3002 <option>(timezone) (format)</option>
3004 <listitem>Local time for specified timezone, see man
3005 strftime to get more information about format. The timezone
3006 argument is specified in similar fashion as TZ environment
3007 variable. For hints, look in /usr/share/zoneinfo. e.g.
3008 US/Pacific, Europe/Zurich, etc.
3014 <option>unflagged_mails</option>
3016 <option>(maildir)</option>
3017 <option>(interval)</option>
3019 <listitem>Number of mails not marked as flagged in the
3020 specified mailbox or mail spool if not. Only maildir type
3021 mailboxes are supported, mbox type will return -1.
3027 <option>unforwarded_mails</option>
3029 <option>(maildir)</option>
3030 <option>(interval)</option>
3032 <listitem>Number of mails not marked as forwarded in the
3033 specified mailbox or mail spool if not. Only maildir type
3034 mailboxes are supported, mbox type will return -1.
3040 <option>unreplied_mails</option>
3042 <option>(maildir)</option>
3043 <option>(interval)</option>
3045 <listitem>Number of mails not marked as replied in the
3046 specified mailbox or mail spool if not. Only maildir type
3047 mailboxes are supported, mbox type will return -1.
3053 <option>unseen_mails</option>
3055 <option>(maildir)</option>
3056 <option>(interval)</option>
3058 <listitem>Number of new or unseen mails in the specified
3059 mailbox or mail spool if not. Only maildir type mailboxes
3060 are supported, mbox type will return -1.
3066 <option>updates</option>
3068 <option>Number of updates</option>
3070 <listitem>for debugging
3076 <option>upspeed</option>
3078 <option>(net)</option>
3080 <listitem>Upload speed in KiB
3086 <option>upspeedf</option>
3088 <option>(net)</option>
3090 <listitem>Upload speed in KiB with one decimal
3096 <option>upspeedgraph</option>
3098 <option>(netdev) ("normal"|"log") (height),(width)
3099 (gradient colour 1) (gradient colour 2) (scale)
3102 <listitem>Upload speed graph, colours defined in hex, minus
3103 the #. If scale is non-zero, it becomes the scale for the
3104 graph. Uses a logarithmic scale (to see small numbers) when
3105 you use "log" instead of "normal". Takes the switch '-t' to
3106 use a temperature gradient, which makes the gradient values
3107 change depending on the amplitude of a particular graph
3108 value (try it and see).
3114 <option>uptime</option>
3123 <option>uptime_short</option>
3126 <listitem>Uptime in a shorter format
3132 <option>user_names</option>
3135 <listitem>Lists the names of the users logged in
3141 <option>user_number</option>
3144 <listitem>Number of users logged in
3150 <option>user_terms</option>
3153 <listitem>Lists the consoles in use
3159 <option>user_times</option>
3162 <listitem>Lists how long users have been logged in for
3168 <option>utime</option>
3170 <option>(format)</option>
3172 <listitem>Display time in UTC (universal coordinate time).
3178 <option>voffset</option>
3180 <option>(pixels)</option>
3182 <listitem>Change vertical offset by N pixels. Negative
3183 values will cause text to overlap. See also $offset.
3189 <option>voltage_mv</option>
3191 <option>(n)</option>
3193 <listitem>Returns CPU #n's voltage in mV. CPUs are counted
3194 from 1. If omitted, the parameter defaults to 1.
3200 <option>voltage_v</option>
3202 <option>(n)</option>
3204 <listitem>Returns CPU #n's voltage in V. CPUs are counted
3205 from 1. If omitted, the parameter defaults to 1.
3211 <option>wireless_ap</option>
3213 <option>(net)</option>
3215 <listitem>Wireless access point MAC address (Linux only)
3221 <option>wireless_bitrate</option>
3223 <option>(net)</option>
3225 <listitem>Wireless bitrate (ie 11 Mb/s) (Linux only)
3231 <option>wireless_essid</option>
3233 <option>(net)</option>
3235 <listitem>Wireless access point ESSID (Linux only)
3241 <option>wireless_link_bar</option>
3243 <option>(height),(width) (net)</option>
3245 <listitem>Wireless link quality bar (Linux only)
3251 <option>wireless_link_qual</option>
3253 <option>(net)</option>
3255 <listitem>Wireless link quality (Linux only)
3261 <option>wireless_link_qual_max</option>
3263 <option>(net)</option>
3265 <listitem>Wireless link quality maximum value (Linux only)
3271 <option>wireless_link_qual_perc</option>
3273 <option>(net)</option>
3275 <listitem>Wireless link quality in percents (Linux only)
3281 <option>wireless_mode</option>
3283 <option>(net)</option>
3285 <listitem>Wireless mode (Managed/Ad-Hoc/Master) (Linux
3292 <option>words</option>
3294 <option>textfile</option>
3296 <listitem>Displays the number of words in the given file
3302 <option>xmms2_album</option>
3305 <listitem>Album in current XMMS2 song
3311 <option>xmms2_artist</option>
3314 <listitem>Artist in current XMMS2 song
3320 <option>xmms2_bar</option>
3322 <option>(height),(width)</option>
3324 <listitem>Bar of XMMS2's progress
3330 <option>xmms2_bitrate</option>
3333 <listitem>Bitrate of current song
3339 <option>xmms2_comment</option>
3342 <listitem>Comment in current XMMS2 song
3348 <option>xmms2_date</option>
3351 <listitem>Returns song's date.
3357 <option>xmms2_duration</option>
3360 <listitem>Duration of current song
3366 <option>xmms2_elapsed</option>
3369 <listitem>Song's elapsed time
3375 <option>xmms2_genre</option>
3378 <listitem>Genre in current XMMS2 song
3384 <option>xmms2_id</option>
3387 <listitem>XMMS2 id of current song
3393 <option>xmms2_percent</option>
3396 <listitem>Percent of song's progress
3402 <option>xmms2_playlist</option>
3405 <listitem>Returns the XMMS2 playlist.
3411 <option>xmms2_size</option>
3414 <listitem>Size of current song
3420 <option>xmms2_smart</option>
3423 <listitem>Prints the song name in either the form "artist -
3424 title" or file name, depending on whats available
3430 <option>xmms2_status</option>
3433 <listitem>XMMS2 status (Playing, Paused, Stopped, or
3440 <option>xmms2_timesplayed</option>
3443 <listitem>Number of times a song was played (presumably).
3449 <option>xmms2_title</option>
3452 <listitem>Title in current XMMS2 song
3458 <option>xmms2_tracknr</option>
3461 <listitem>Track number in current XMMS2 song
3467 <option>xmms2_url</option>
3470 <listitem>Full path to current song
projects / monky / blob