5 <option>acpiacadapter</option>
8 <listitem>ACPI ac adapter state.
14 <option>acpifan</option>
17 <listitem>ACPI fan state
23 <option>acpitemp</option>
26 <listitem>ACPI temperature in C.
34 <option>(interface)</option>
36 <listitem>IP address for an interface, or "No Address" if
37 no address is assigned.
43 <option>addrs</option>
45 <option>(interface)</option>
47 <listitem>IP addresses for an interface (if one - works
48 like addr). Linux only.
54 <option>adt746xcpu</option>
57 <listitem>CPU temperature from therm_adt746x
63 <option>adt746xfan</option>
66 <listitem>Fan speed from therm_adt746x
72 <option>alignc</option>
74 <option>(num)</option>
76 <listitem>Align text to centre
82 <option>alignr</option>
84 <option>(num)</option>
86 <listitem>Right-justify text, with space of N
92 <option>apcupsd</option>
97 <listitem>Sets up the connection to apcupsd daemon. Prints
98 nothing, defaults to localhost:3551
104 <option>apcupsd_cable</option>
107 <listitem>Prints the UPS connection type.
113 <option>apcupsd_charge</option>
116 <listitem>Current battery capacity in percent.
122 <option>apcupsd_lastxfer</option>
125 <listitem>Reason for last transfer from line to battery.
131 <option>apcupsd_linev</option>
134 <listitem>Nominal input voltage.
140 <option>apcupsd_load</option>
143 <listitem>Current load in percent.
149 <option>apcupsd_loadbar</option>
152 <listitem>Bar showing current load.
158 <option>apcupsd_loadgauge</option>
160 <option>(height),(width)</option>
162 <listitem>Gauge that shows current load.
168 <option>apcupsd_loadgraph</option>
170 <option>(height),(width) (gradient colour 1) (gradient
171 colour 2) (scale) (-t) (-l)</option>
173 <listitem>History graph of current load.
179 <option>apcupsd_model</option>
182 <listitem>Prints the model of the UPS.
188 <option>apcupsd_name</option>
191 <listitem>Prints the UPS user-defined name.
197 <option>apcupsd_status</option>
200 <listitem>Prints current status (on-line, on-battery).
206 <option>apcupsd_temp</option>
209 <listitem>Current internal temperature.
215 <option>apcupsd_timeleft</option>
218 <listitem>Time left to run on battery.
224 <option>apcupsd_upsmode</option>
227 <listitem>Prints the UPS mode (e.g. standalone).
233 <option>apm_adapter</option>
236 <listitem>Display APM AC adapter status (FreeBSD only)
242 <option>apm_battery_life</option>
245 <listitem>Display APM battery life in percent (FreeBSD
252 <option>apm_battery_time</option>
255 <listitem>Display remaining APM battery life in hh:mm:ss or
256 "unknown" if AC adapterstatus is on-line or charging
263 <option>audacious_bar</option>
265 <option>(height),(width)</option>
267 <listitem>Progress bar
273 <option>audacious_bitrate</option>
276 <listitem>Bitrate of current tune
282 <option>audacious_channels</option>
285 <listitem>Number of audio channels of current tune
291 <option>audacious_filename</option>
294 <listitem>Full path and filename of current tune
300 <option>audacious_frequency</option>
303 <listitem>Sampling frequency of current tune
309 <option>audacious_length</option>
312 <listitem>Total length of current tune as MM:SS
318 <option>audacious_length_seconds</option>
321 <listitem>Total length of current tune in seconds
327 <option>audacious_main_volume</option>
330 <listitem>The current volume fetched from Audacious
336 <option>audacious_playlist_length</option>
339 <listitem>Number of tunes in playlist
345 <option>audacious_playlist_position</option>
348 <listitem>Playlist position of current tune
354 <option>audacious_position</option>
357 <listitem>Position of current tune (MM:SS)
363 <option>audacious_position_seconds</option>
366 <listitem>Position of current tune in seconds
372 <option>audacious_status</option>
375 <listitem>Player status (Playing/Paused/Stopped/Not
382 <option>audacious_title</option>
384 <option>(max length)</option>
386 <listitem>Title of current tune with optional maximum
393 <option>battery</option>
395 <option>(num)</option>
397 <listitem>Battery status and remaining percentage capacity
398 of ACPI or APM battery. ACPI battery number can be given as
399 argument (default is BAT0).
405 <option>battery_bar</option>
407 <option>(height),(width) (num)</option>
409 <listitem>Battery percentage remaining of ACPI battery in a
410 bar. ACPI battery number can be given as argument (default
417 <option>battery_percent</option>
419 <option>(num)</option>
421 <listitem>Battery percentage remaining for ACPI battery.
422 ACPI battery number can be given as argument (default is
429 <option>battery_short</option>
431 <option>(num)</option>
433 <listitem>Battery status and remaining percentage capacity
434 of ACPI or APM battery. ACPI battery number can be given as
435 argument (default is BAT0). This mode display a short
436 status, which means that C is displayed instead of
437 charging, D for discharging, F for full, N for not present,
438 E for empty and U for unknown.
444 <option>battery_time</option>
446 <option>(num)</option>
448 <listitem>Battery charge/discharge time remaining of ACPI
449 battery. ACPI battery number can be given as argument
456 <option>blink</option>
458 <option>text_and_other_conky_vars</option>
460 <listitem>Let 'text_and_other_conky_vars' blink on and off.
467 <option>bmpx_album</option>
470 <listitem>Album in current BMPx track
476 <option>bmpx_artist</option>
479 <listitem>Artist in current BMPx track
485 <option>bmpx_bitrate</option>
488 <listitem>Bitrate of the current BMPx track
494 <option>bmpx_title</option>
497 <listitem>Title of the current BMPx track
503 <option>bmpx_track</option>
506 <listitem>Track number of the current BMPx track
512 <option>bmpx_uri</option>
515 <listitem>URI of the current BMPx track
521 <option>buffers</option>
524 <listitem>Amount of memory buffered
530 <option>cached</option>
533 <listitem>Amount of memory cached
539 <option>color</option>
541 <option>(color)</option>
543 <listitem>Change drawing color to color
549 <option>colorN</option>
552 <listitem>Change drawing color to colorN configuration
553 option, where N is a digit between 0 and 9, inclusively.
559 <option>combine</option>
561 <option>var1 var2</option>
563 <listitem>Places the lines of var2 to the right of the
564 lines of var1 seperated by the chars that are put between
565 var1 and var2. For example: ${combine ${head /proc/cpuinfo
566 2} - ${head /proc/meminfo 1}} gives as output
567 "cpuinfo_line1 - meminfo_line1" on line 1 and
568 "cpuinfo_line2 -" on line 2. $combine vars can also be
569 nested to place more vars next to each other.
575 <option>conky_build_arch</option>
578 <listitem>CPU architecture Conky was built for
584 <option>conky_build_date</option>
587 <listitem>Date Conky was built
593 <option>conky_version</option>
596 <listitem>Conky version
604 <option>(cpuN)</option>
606 <listitem>CPU usage in percents. For SMP machines, the CPU
607 number can be provided as an argument. ${cpu cpu0} is the
608 total usage, and ${cpu cpuX} (X >= 1) are individual
615 <option>cpubar</option>
617 <option>(cpuN) (height),(width)</option>
619 <listitem>Bar that shows CPU usage, height is bar's height
620 in pixels. See $cpu for more info on SMP.
626 <option>cpugauge</option>
628 <option>(cpuN) (height),(width)</option>
630 <listitem>Elliptical gauge that shows CPU usage, height and
631 width are gauge's vertical and horizontal axis
632 respectively. See $cpu for more info on SMP.
638 <option>cpugraph</option>
640 <option>(cpuN) (height),(width) (gradient colour 1)
641 (gradient colour 2) (scale) (-t) (-l)</option>
643 <listitem>CPU usage graph, with optional colours in hex,
644 minus the #. See $cpu for more info on SMP. Uses a
645 logarithmic scale (to see small numbers) when you use the
646 -l switch. Takes the switch '-t' to use a temperature
647 gradient, which makes the gradient values change depending
648 on the amplitude of a particular graph value (try it and
655 <option>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) (height),(width) (gradient colour 1)
704 (gradient colour 2) (scale) (-t) (-l)</option>
706 <listitem>Disk IO graph, colours defined in hex, minus the
707 #. If scale is non-zero, it becomes the scale for the
708 graph. Uses a logarithmic scale (to see small numbers) when
709 you use -l switch. Takes the switch '-t' to use a
710 temperature gradient, which makes the gradient values
711 change depending on the amplitude of a particular graph
712 value (try it and see).
718 <option>diskiograph_read</option>
720 <option>(device) (height),(width) (gradient colour 1)
721 (gradient colour 2) (scale) (-t) (-l)</option>
723 <listitem>Disk IO graph for reads, colours defined in hex,
724 minus the #. If scale is non-zero, it becomes the scale for
725 the graph. Device as in diskio. Uses a logarithmic scale
726 (to see small numbers) when you use -l switch. Takes the
727 switch '-t' to use a temperature gradient, which makes the
728 gradient values change depending on the amplitude of a
729 particular graph value (try it and see).
735 <option>diskiograph_write</option>
737 <option>(device) (height),(width) (gradient colour 1)
738 (gradient colour 2) (scale) (-t) (-l)</option>
740 <listitem>Disk IO graph for writes, colours defined in hex,
741 minus the #. If scale is non-zero, it becomes the scale for
742 the graph. Device as in diskio. Uses a logarithmic scale
743 (to see small numbers) when you use -l switch. Takes the
744 switch '-t' to use a temperature gradient, which makes the
745 gradient values change depending on the amplitude of a
746 particular graph value (try it and see).
752 <option>downspeed</option>
754 <option>(net)</option>
756 <listitem>Download speed in suitable IEC units
762 <option>downspeedf</option>
764 <option>(net)</option>
766 <listitem>Download speed in KiB with one decimal
772 <option>downspeedgraph</option>
774 <option>(netdev) (height),(width) (gradient colour 1)
775 (gradient colour 2) (scale) (-t) (-l)</option>
777 <listitem>Download speed graph, colours defined in hex,
778 minus the #. If scale is non-zero, it becomes the scale for
779 the graph. Uses a logarithmic scale (to see small numbers)
780 when you use -l switch. Takes the switch '-t' to use a
781 temperature gradient, which makes the gradient values
782 change depending on the amplitude of a particular graph
783 value (try it and see).
789 <option>draft_mails</option>
791 <option>(maildir)</option>
792 <option>(interval)</option>
794 <listitem>Number of mails marked as draft in the specified
795 mailbox or mail spool if not. Only maildir type mailboxes
796 are supported, mbox type will return -1.
802 <option>else</option>
805 <listitem>Text to show if any of the above are not true
811 <option>endif</option>
815 <listitem>Ends an $if block.
821 <option>entropy_avail</option>
824 <listitem>Current entropy available for crypto freaks
830 <option>entropy_bar</option>
832 <option>(height),(width)</option>
834 <listitem>Normalized bar of available entropy for crypto
841 <option>entropy_perc</option>
844 <listitem>Percentage of entropy available in comparison to
851 <option>entropy_poolsize</option>
854 <listitem>Total size of system entropy pool for crypto
861 <option>eval</option>
863 <option>string</option>
865 <listitem>Evalutates given string according to the rules of
866 TEXT interpretation, i.e. parsing any contained text object
867 specifications into their output, any occuring '$$' into a
868 single '$' and so on. The output is then being parsed
877 <option>api_userid api_key character_id</option>
879 <listitem>Fetches your currently training skill from the
880 Eve Online API servers (http://www.eve-online.com/) and
881 displays the skill along with the remaining training time.
887 <option>exec</option>
889 <option>command</option>
891 <listitem>Executes a shell command and displays the output
892 in conky. warning: this takes a lot more resources than
893 other variables. I'd recommend coding wanted behaviour in C
900 <option>execbar</option>
902 <option>command</option>
904 <listitem>Same as exec, except if the first value return is
905 a value between 0-100, it will use that number for a bar.
906 The size for bars can be controlled via the
907 default_bar_size config setting.
913 <option>execgauge</option>
915 <option>command</option>
917 <listitem>Same as exec, except if the first value returned
918 is a value between 0-100, it will use that number for a
919 gauge. The size for gauges can be controlled via the
920 default_gauge_size config setting.
926 <option>execgraph</option>
928 <option>(-t) (-l) command</option>
930 <listitem>Same as execbar, but graphs values. Uses a
931 logaritmic scale when the log option (-l switch) is given
932 (to see small numbers). Values still have to be between 0
933 and 100. The size for graphs can be controlled via the
934 default_graph_size config setting. Takes the switch '-t' to
935 use a temperature gradient, which makes the gradient values
936 change depending on the amplitude of a particular graph
937 value (try it and see).
943 <option>execi</option>
945 <option>interval command</option>
947 <listitem>Same as exec but with specific interval. Interval
948 can't be less than update_interval in configuration. See
955 <option>execibar</option>
957 <option>interval command</option>
959 <listitem>Same as execbar, except with an interval
965 <option>execigauge</option>
967 <option>interval command</option>
969 <listitem>Same as execgauge, but takes an interval arg and
976 <option>execigraph</option>
978 <option>interval (-t) (-l) command</option>
980 <listitem>Same as execgraph, but takes an interval arg and
987 <option>execp</option>
989 <option>command</option>
991 <listitem>Executes a shell command and displays the output
992 in conky. warning: this takes a lot more resources than
993 other variables. I'd recommend coding wanted behaviour in C
994 and posting a patch. This differs from $exec in that it
995 parses the output of the command, so you can insert things
996 like ${color red}hi!${color} in your script and have it
997 correctly parsed by Conky. Caveats: Conky parses and
998 evaluates the output of $execp every time Conky loops, and
999 then destroys all the objects. If you try to use anything
1000 like $execi within an $execp statement, it will
1001 functionally run at the same interval that the $execp
1002 statement runs, as it is created and destroyed at every
1009 <option>execpi</option>
1011 <option>interval command</option>
1013 <listitem>Same as execp but with specific interval.
1014 Interval can't be less than update_interval in
1015 configuration. Note that the output from the $execpi
1016 command is still parsed and evaluated at every interval.
1022 <option>flagged_mails</option>
1024 <option>(maildir)</option>
1025 <option>(interval)</option>
1027 <listitem>Number of mails marked as flagged in the
1028 specified mailbox or mail spool if not. Only maildir type
1029 mailboxes are supported, mbox type will return -1.
1035 <option>font</option>
1037 <option>(font)</option>
1039 <listitem>Specify a different font. This new font will
1040 apply to the current line and everything following. You can
1041 use a $font with no arguments to change back to the default
1042 font (much like with $color)
1048 <option>forwarded_mails</option>
1050 <option>(maildir)</option>
1051 <option>(interval)</option>
1053 <listitem>Number of mails marked as forwarded in the
1054 specified mailbox or mail spool if not. Only maildir type
1055 mailboxes are supported, mbox type will return -1.
1061 <option>freq</option>
1063 <option>(n)</option>
1065 <listitem>Returns CPU #n's frequency in MHz. CPUs are
1066 counted from 1. If omitted, the parameter defaults to 1.
1072 <option>freq_g</option>
1074 <option>(n)</option>
1076 <listitem>Returns CPU #n's frequency in GHz. CPUs are
1077 counted from 1. If omitted, the parameter defaults to 1.
1083 <option>fs_bar</option>
1085 <option>(height),(width) fs</option>
1087 <listitem>Bar that shows how much space is used on a file
1088 system. height is the height in pixels. fs is any file on
1095 <option>fs_bar_free</option>
1097 <option>(height),(width) fs</option>
1099 <listitem>Bar that shows how much space is free on a file
1100 system. height is the height in pixels. fs is any file on
1107 <option>fs_free</option>
1109 <option>(fs)</option>
1111 <listitem>Free space on a file system available for users.
1117 <option>fs_free_perc</option>
1119 <option>(fs)</option>
1121 <listitem>Free percentage of space on a file system
1122 available for users.
1128 <option>fs_size</option>
1130 <option>(fs)</option>
1132 <listitem>File system size.
1138 <option>fs_type</option>
1140 <option>(fs)</option>
1142 <listitem>File system type.
1148 <option>fs_used</option>
1150 <option>(fs)</option>
1152 <listitem>File system used space.
1158 <option>fs_used_perc</option>
1160 <option>(fs)</option>
1162 <listitem>Percent of file system used space.
1168 <option>goto</option>
1172 <listitem>The next element will be printed at position 'x'.
1179 <option>gw_iface</option>
1182 <listitem>Displays the default route's interface or
1183 "multiple"/"none" accordingly.
1189 <option>gw_ip</option>
1192 <listitem>Displays the default gateway's IP or
1193 "multiple"/"none" accordingly.
1199 <option>hddtemp</option>
1201 <option>dev, (host,(port))</option>
1203 <listitem>Displays temperature of a selected hard disk
1204 drive as reported by the hddtemp daemon running on
1205 host:port. Default host is 127.0.0.1, default port is 7634.
1212 <option>head</option>
1214 <option>logfile lines (interval)</option>
1216 <listitem>Displays first N lines of supplied text text
1217 file. If interval is not supplied, Conky assumes 2x Conky's
1218 interval. Max of 30 lines can be displayed, or until the
1219 text buffer is filled.
1227 <option>(height)</option>
1229 <listitem>Horizontal line, height is the height in pixels
1235 <option>hwmon</option>
1237 <option>(dev) type n (factor offset)</option>
1239 <listitem>Hwmon sensor from sysfs (Linux 2.6). Parameter
1240 dev may be omitted if you have only one hwmon device.
1241 Parameter type is either 'in' or 'vol' meaning voltage;
1242 'fan' meaning fan; 'temp' meaning temperature. Parameter n
1243 is number of the sensor. See /sys/class/hwmon/ on your
1244 local computer. The optional arguments 'factor' and
1245 'offset' allow precalculation of the raw input, which is
1246 being modified as follows: 'input = input * factor +
1247 offset'. Note that they have to be given as decimal values
1248 (i.e. contain at least one decimal place).
1254 <option>i2c</option>
1256 <option>(dev) type n (factor offset)</option>
1258 <listitem>I2C sensor from sysfs (Linux 2.6). Parameter dev
1259 may be omitted if you have only one I2C device. Parameter
1260 type is either 'in' or 'vol' meaning voltage; 'fan' meaning
1261 fan; 'temp' meaning temperature. Parameter n is number of
1262 the sensor. See /sys/bus/i2c/devices/ on your local
1263 computer. The optional arguments 'factor' and 'offset'
1264 allow precalculation of the raw input, which is being
1265 modified as follows: 'input = input * factor + offset'.
1266 Note that they have to be given as decimal values (i.e.
1267 contain at least one decimal place).
1273 <option>i8k_ac_status</option>
1277 <listitem>If running the i8k kernel driver for Inspiron
1278 laptops, displays whether ac power is on, as listed in
1279 /proc/i8k (translated to human-readable). Beware that this
1280 is by default not enabled by i8k itself.
1286 <option>i8k_bios</option>
1290 <listitem>If running the i8k kernel driver for Inspiron
1291 laptops, displays the bios version as listed in /proc/i8k.
1297 <option>i8k_buttons_status</option>
1301 <listitem>If running the i8k kernel driver for Inspiron
1302 laptops, displays the volume buttons status as listed in
1309 <option>i8k_cpu_temp</option>
1313 <listitem>If running the i8k kernel driver for Inspiron
1314 laptops, displays the cpu temperature in Celsius, as
1315 reported by /proc/i8k.
1321 <option>i8k_left_fan_rpm</option>
1325 <listitem>If running the i8k kernel driver for Inspiron
1326 laptops, displays the left fan's rate of rotation, in
1327 revolutions per minute as listed in /proc/i8k. Beware, some
1328 laptops i8k reports these fans in reverse order.
1334 <option>i8k_left_fan_status</option>
1338 <listitem>If running the i8k kernel driver for Inspiron
1339 laptops, displays the left fan status as listed in
1340 /proc/i8k (translated to human-readable). Beware, some
1341 laptops i8k reports these fans in reverse order.
1347 <option>i8k_right_fan_rpm</option>
1351 <listitem>If running the i8k kernel driver for Inspiron
1352 laptops, displays the right fan's rate of rotation, in
1353 revolutions per minute as listed in /proc/i8k. Beware, some
1354 laptops i8k reports these fans in reverse order.
1360 <option>i8k_right_fan_status</option>
1364 <listitem>If running the i8k kernel driver for Inspiron
1365 laptops, displays the right fan status as listed in
1366 /proc/i8k (translated to human-readable). Beware, some
1367 laptops i8k reports these fans in reverse order.
1373 <option>i8k_serial</option>
1377 <listitem>If running the i8k kernel driver for Inspiron
1378 laptops, displays your laptop serial number as listed in
1385 <option>i8k_version</option>
1389 <listitem>If running the i8k kernel driver for Inspiron
1390 laptops, displays the version formatting of /proc/i8k.
1396 <option>ibm_brightness</option>
1399 <listitem>If running the IBM ACPI, displays the brigtness
1400 of the laptops's LCD (0-7).
1406 <option>ibm_fan</option>
1409 <listitem>If running the IBM ACPI, displays the fan speed.
1415 <option>ibm_temps</option>
1419 <listitem>If running the IBM ACPI, displays the
1420 temperatures from the IBM temperature sensors (N=0..7)
1421 Sensor 0 is on the CPU, 3 is on the GPU.
1427 <option>ibm_volume</option>
1430 <listitem>If running the IBM ACPI, displays the "master"
1431 volume, controlled by the volume keys (0-14).
1437 <option>iconv_start</option>
1439 <option>codeset_from codeset_to</option>
1441 <listitem>Convert text from one codeset to another using
1442 GNU iconv. Needs to be stopped with iconv_stop.
1448 <option>iconv_stop</option>
1452 <listitem>Stop iconv codeset conversion.
1458 <option>if_empty</option>
1460 <option>(var)</option>
1462 <listitem>if conky variable VAR is empty, display
1463 everything between $if_empty and the matching $endif
1469 <option>if_existing</option>
1471 <option>file (string)</option>
1473 <listitem>if FILE exists, display everything between
1474 if_existing and the matching $endif. The optional second
1475 paramater checks for FILE containing the specified string
1476 and prints everything between $if_existing and the matching
1483 <option>if_gw</option>
1486 <listitem>if there is at least one default gateway, display
1487 everything between $if_gw and the matching $endif
1493 <option>if_match</option>
1495 <option>expression</option>
1497 <listitem>Evaluates the given boolean expression, printing
1498 everything between $if_match and the matching $endif
1499 depending on whether the evaluation returns true or not.
1500 Valid expressions consist of a left side, an operator and a
1501 right side. Left and right sides are being parsed for
1502 contained text objects before evaluation. Recognised left
1503 and right side types are:
1506 <command>double</command>: argument consists of only
1507 digits and a single dot.</member>
1509 <command>long</command>: argument consists of only
1512 <command>string</command>: argument is enclosed in
1513 quotation mark or the checks for double and long failed
1515 </simplelist>Valid operands are: '>', '<', '>=',
1516 '<=', '==', '!='.
1522 <option>if_mixer_mute</option>
1524 <option>(mixer)</option>
1526 <listitem>If mixer exists, display everything between
1527 $if_mixer_mute and the matching $endif. If no mixer is
1528 specified, "Master" is used.
1534 <option>if_mounted</option>
1536 <option>(mountpoint)</option>
1538 <listitem>if MOUNTPOINT is mounted, display everything
1539 between $if_mounted and the matching $endif
1545 <option>if_mpd_playing</option>
1548 <listitem>if mpd is playing or paused, display everything
1549 between $if_mpd_playing and the matching $endif
1555 <option>if_running</option>
1557 <option>(process)</option>
1559 <listitem>if PROCESS is running, display everything
1560 $if_running and the matching $endif. This uses the
1561 ``pidof'' command, so the -x switch is also supported.
1567 <option>if_smapi_bat_installed</option>
1569 <option>(INDEX)</option>
1571 <listitem>when using smapi, if the battery with index INDEX
1572 is installed, display everything between
1573 $if_smapi_bat_installed and the matching $endif
1579 <option>if_up</option>
1581 <option>(interface)</option>
1583 <listitem>if INTERFACE exists and is up, display everything
1584 between $if_up and the matching $endif
1590 <option>if_updatenr</option>
1592 <option>(updatenr)</option>
1594 <listitem>If it's the UPDATENR-th time that conky updates,
1595 display everything between $if_updatenr and the matching
1596 $endif. The counter resets when the highest UPDATENR is
1597 reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr
1598 2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the
1599 time followed by bar 25% of the time followed by nothing
1600 the other half of the time.
1606 <option>if_xmms2_connected</option>
1609 <listitem>Display everything between $if_xmms2_connected
1610 and the matching $endif if xmms2 is running.
1616 <option>image</option>
1618 <option><path to image> (-p x,y) (-s WxH) (-n)
1619 (-f interval)</option>
1621 <listitem>Renders an image from the path specified using
1622 Imlib2. Takes 4 optional arguments: a position, a size, a
1623 no-cache switch, and a cache flush interval. Changing the
1624 x,y position will move the position of the image, and
1625 changing the WxH will scale the image. If you specify the
1626 no-cache flag (-n), the image will not be cached.
1627 Alternately, you can specify the -f int switch to specify a
1628 cache flust interval for a particular image. Example:
1629 ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200}
1630 will render 'cheeseburger.jpg' at (20,20) scaled to 200x200
1631 pixels. Conky does not make any attempt to adjust the
1632 position (or any other formatting) of images, they are just
1633 rendered as per the arguments passed. The only reason
1634 $image is part of the TEXT section, is to allow for runtime
1635 modifications, through $execp $lua_parse, $lua_read_parse,
1636 or some other method.
1642 <option>imap_messages</option>
1644 <option>(args)</option>
1646 <listitem>Displays the number of messages in your global
1647 IMAP inbox by default. You can define individual IMAP
1648 inboxes seperately by passing arguments to this object.
1649 Arguments are: "host user pass [-i interval (in seconds)]
1650 [-f folder] [-p port] [-e command] [-r retries]". Default
1651 port is 143, default folder is 'INBOX', default interval is
1652 5 minutes, and default number of retries before giving up
1653 is 5. If the password is supplied as '*', you will be
1654 prompted to enter the password when Conky starts.
1660 <option>imap_unseen</option>
1662 <option>(args)</option>
1664 <listitem>Displays the number of unseen messages in your
1665 global IMAP inbox by default. You can define individual
1666 IMAP inboxes seperately by passing arguments to this
1667 object. Arguments are: "host user pass [-i interval (in
1668 seconds)] [-f folder] [-p port] [-e command] [-r retries]".
1669 Default port is 143, default folder is 'INBOX', default
1670 interval is 5 minutes, and default number of retries before
1671 giving up is 5. If the password is supplied as '*', you
1672 will be prompted to enter the password when Conky starts.
1678 <option>ioscheduler</option>
1680 <option>disk</option>
1682 <listitem>Prints the current ioscheduler used for the given
1683 disk name (i.e. e.g. "hda" or "sdb")
1689 <option>kernel</option>
1692 <listitem>Kernel version
1698 <option>laptop_mode</option>
1701 <listitem>The value of /proc/sys/vm/laptop_mode
1707 <option>lines</option>
1709 <option>textfile</option>
1711 <listitem>Displays the number of lines in the given file
1717 <option>loadavg</option>
1720 <listitem>(1,2,3)> System load average, 1 is for past 1
1721 minute, 2 for past 5 minutes and 3 for past 15 minutes.
1727 <option>loadgraph</option>
1729 <option>(height),(width) (gradient colour 1) (gradient
1730 colour 2) (scale) (-t) (-l)</option>
1732 <listitem>Load1 average graph, similar to xload, with
1733 optional colours in hex, minus the #. Uses a logarithmic
1734 scale (to see small numbers) when you use the -l switch.
1735 Takes the switch '-t' to use a temperature gradient, which
1736 makes the gradient values change depending on the amplitude
1737 of a particular graph value (try it and see).
1743 <option>lua</option>
1745 <option>function_name (function parameters)</option>
1747 <listitem>Executes a Lua function with given parameters,
1748 then prints the returned string. See also 'lua_load' on how
1755 <option>lua_bar</option>
1757 <option>(height, width) function_name (function
1758 parameters)</option>
1760 <listitem>Executes a Lua function with given parameters and
1761 draws a bar. Expects result value to be an integer between
1762 0 and 100. See also 'lua_load' on how to load scripts.
1768 <option>lua_gauge</option>
1770 <option>(height, width) function_name (function
1771 parameters)</option>
1773 <listitem>Executes a Lua function with given parameters and
1774 draws a gauge. Expects result value to be an integer
1775 between 0 and 100. See also 'lua_load' on how to load
1782 <option>lua_graph</option>
1784 <option>function_name (height),(width) (gradient colour
1785 1) (gradient colour 2) (scale) (-t) (-l)</option>
1787 <listitem>Executes a Lua function with and draws a graph.
1788 Expects result value to be any number, and by default will
1789 scale to show the full range. See also 'lua_load' on how to
1790 load scripts. Takes the switch '-t' to use a temperature
1791 gradient, which makes the gradient values change depending
1792 on the amplitude of a particular graph value (try it and
1799 <option>lua_parse</option>
1801 <option>function_name (function parameters)</option>
1803 <listitem>Executes a Lua function with given parameters as
1804 per $lua, then parses and prints the result value as per
1805 the syntax for Conky's TEXT section. See also 'lua_load' on
1806 how to load scripts.
1812 <option>lua_read_parse</option>
1814 <option>function_name (conky text)</option>
1816 <listitem>Executes a Lua function per $lua, except takes a
1817 2nd argument which is first evaluated as per Conky's TEXT
1818 section and passed to the function first. The return value
1819 is then parsed and prints the result value as per the
1820 syntax for Conky's TEXT section. See also 'lua_load' on how
1827 <option>machine</option>
1830 <listitem>Machine, i686 for example
1836 <option>mails</option>
1838 <option>(mailbox)</option>
1839 <option>(interval)</option>
1841 <listitem>Mail count in the specified mailbox or your mail
1842 spool if not. Both mbox and maildir type mailboxes are
1843 supported. You can use a program like fetchmail to get
1844 mails from some server using your favourite protocol. See
1851 <option>mboxscan</option>
1853 <option>(-n number of messages to print) (-fw from
1854 width) (-sw subject width) mbox</option>
1856 <listitem>Print a summary of recent messages in an mbox
1857 format mailbox. mbox parameter is the filename of the
1858 mailbox (can be encapsulated using '"', ie. ${mboxscan -n
1859 10 "/home/brenden/some box"}
1865 <option>mem</option>
1868 <listitem>Amount of memory in use
1874 <option>membar</option>
1876 <option>(height),(width)</option>
1878 <listitem>Bar that shows amount of memory in use
1884 <option>memeasyfree</option>
1887 <listitem>Amount of free memory including the memory that
1888 is very easily freed (buffers/cache)
1894 <option>memfree</option>
1897 <listitem>Amount of free memory
1903 <option>memgauge</option>
1905 <option>(height),(width)</option>
1907 <listitem>Gauge that shows amount of memory in use (see
1914 <option>memgraph</option>
1916 <option>(height),(width) (gradient colour 1) (gradient
1917 colour 2) (scale) (-t) (-l)</option>
1919 <listitem>Memory usage graph. Uses a logarithmic scale (to
1920 see small numbers) when you use the -l switch. Takes the
1921 switch '-t' to use a temperature gradient, which makes the
1922 gradient values change depending on the amplitude of a
1923 particular graph value (try it and see).
1929 <option>memmax</option>
1932 <listitem>Total amount of memory
1938 <option>memperc</option>
1941 <listitem>Percentage of memory in use
1947 <option>mixer</option>
1949 <option>(device)</option>
1951 <listitem>Prints the mixer value as reported by the OS.
1952 Default mixer is "vol", but you can specify one of the
1953 following optional arguments: "vol", "bass", "treble",
1954 "synth", "pcm", "speaker", "line", "mic", "cd", "mix",
1955 "pcm2", "rec", "igain", "ogain", "line1", "line2", "line3",
1956 "dig1", "dig2", "dig3", "phin", "phout", "video", "radio",
1957 "monitor". Refer to the definition of SOUND_DEVICE_NAMES in
1958 <linux/soundcard.h> (on Linux), <soundcard.h>
1959 (on OpenBSD), or <sys/soundcard.h> to find the exact
1960 options available on your system.
1966 <option>mixerbar</option>
1968 <option>(device)</option>
1970 <listitem>Displays mixer value in a bar as reported by the
1971 OS. See docs for $mixer for details on arguments.
1977 <option>mixerl</option>
1979 <option>(device)</option>
1981 <listitem>Prints the left channel mixer value as reported
1982 by the OS. See docs for $mixer for details on arguments.
1988 <option>mixerlbar</option>
1990 <option>(device)</option>
1992 <listitem>Displays the left channel mixer value in a bar as
1993 reported by the OS. See docs for $mixer for details on
2000 <option>mixerr</option>
2002 <option>(device)</option>
2004 <listitem>Prints the right channel mixer value as reported
2005 by the OS. See docs for $mixer for details on arguments.
2011 <option>mixerrbar</option>
2013 <option>(device)</option>
2015 <listitem>Displays the right channel mixer value in a bar
2016 as reported by the OS. See docs for $mixer for details on
2023 <option>moc_album</option>
2026 <listitem>Album of the current MOC song
2032 <option>moc_artist</option>
2035 <listitem>Artist of the current MOC song
2041 <option>moc_bitrate</option>
2044 <listitem>Bitrate in the current MOC song
2050 <option>moc_curtime</option>
2053 <listitem>Current time of the current MOC song
2059 <option>moc_file</option>
2062 <listitem>File name of the current MOC song
2068 <option>moc_rate</option>
2071 <listitem>Rate of the current MOC song
2077 <option>moc_song</option>
2080 <listitem>The current song name being played in MOC.
2086 <option>moc_state</option>
2089 <listitem>Current state of MOC; playing, stopped etc.
2095 <option>moc_timeleft</option>
2098 <listitem>Time left in the current MOC song
2104 <option>moc_title</option>
2107 <listitem>Title of the current MOC song
2113 <option>moc_totaltime</option>
2116 <listitem>Total length of the current MOC song
2122 <option>monitor</option>
2125 <listitem>Number of the monitor on which conky is running
2131 <option>monitor_number</option>
2134 <listitem>Number of monitors
2140 <option>mpd_album</option>
2143 <listitem>Album in current MPD song
2149 <option>mpd_artist</option>
2152 <listitem>Artist in current MPD song must be enabled at
2159 <option>mpd_bar</option>
2161 <option>(height),(width)</option>
2163 <listitem>Bar of mpd's progress
2169 <option>mpd_bitrate</option>
2172 <listitem>Bitrate of current song
2178 <option>mpd_elapsed</option>
2181 <listitem>Song's elapsed time
2187 <option>mpd_file</option>
2190 <listitem>Prints the file name of the current MPD song
2196 <option>mpd_length</option>
2199 <listitem>Song's length
2205 <option>mpd_name</option>
2208 <listitem>Prints the MPD name field
2214 <option>mpd_percent</option>
2217 <listitem>Percent of song's progress
2223 <option>mpd_random</option>
2226 <listitem>Random status (On/Off)
2232 <option>mpd_repeat</option>
2235 <listitem>Repeat status (On/Off)
2241 <option>mpd_smart</option>
2243 <option>(max length)</option>
2245 <listitem>Prints the song name in either the form "artist -
2246 title" or file name, depending on whats available
2252 <option>mpd_status</option>
2255 <listitem>Playing, stopped, et cetera.
2261 <option>mpd_title</option>
2263 <option>(max length)</option>
2265 <listitem>Title of current MPD song
2271 <option>mpd_track</option>
2274 <listitem>Prints the MPD track field
2280 <option>mpd_vol</option>
2283 <listitem>MPD's volume
2289 <option>nameserver</option>
2291 <option>(index)</option>
2293 <listitem>Print a nameserver from /etc/resolv.conf. Index
2294 starts at and defaults to 0.
2300 <option>new_mails</option>
2302 <option>(mailbox)</option>
2303 <option>(interval)</option>
2305 <listitem>Unread mail count in the specified mailbox or
2306 mail spool if not. Both mbox and maildir type mailboxes are
2313 <option>nodename</option>
2322 <option>nvidia</option>
2324 <option>threshold</option>
2325 <option>temp</option>
2326 <option>ambient</option>
2327 <option>gpufreq</option>
2328 <option>memfreq</option>
2329 <option>imagequality</option>
2331 <listitem>Nvidia graficcard support for the XNVCtrl
2332 library. Each option can be shortened to the least
2333 significant part. Temperatures are printed as float, all
2334 other values as integer.
2337 <command>threshold</command>: the thresholdtemperature
2338 at which the gpu slows down</member>
2340 <command>temp</command>: gives the gpu current
2341 temperature</member>
2343 <command>ambient</command>: gives current air
2344 temperature near GPU case</member>
2346 <command>gpufreq</command>: gives the current gpu
2349 <command>memfreq</command>: gives the current mem
2352 <command>imagequality</command>: which imagequality
2353 should be choosen by OpenGL applications</member>
2360 <option>offset</option>
2362 <option>(pixels)</option>
2364 <listitem>Move text over by N pixels. See also $voffset.
2370 <option>outlinecolor</option>
2372 <option>(color)</option>
2374 <listitem>Change outline color
2380 <option>pb_battery</option>
2382 <option>item</option>
2384 <listitem>If running on Apple powerbook/ibook, display
2385 information on battery status. The item parameter
2386 specifies, what information to display. Exactly one item
2387 must be specified. Valid items are:
2390 <command>status</command>: Display if battery is fully
2391 charged, charging, discharging or absent (running on
2394 <command>percent</command>: Display charge of battery
2395 in percent, if charging or discharging. Nothing will be
2396 displayed, if battery is fully charged or
2399 <command>time</command>: Display the time remaining
2400 until the battery will be fully charged or discharged
2401 at current rate. Nothing is displayed, if battery is
2402 absent or if it's present but fully charged and not
2403 discharging.</member>
2410 <option>platform</option>
2412 <option>(dev) type n (factor offset)</option>
2414 <listitem>Platform sensor from sysfs (Linux 2.6). Parameter
2415 dev may be omitted if you have only one platform device.
2416 Platform type is either 'in' or 'vol' meaning voltage;
2417 'fan' meaning fan; 'temp' meaning temperature. Parameter n
2418 is number of the sensor. See /sys/bus/platform/devices/ on
2419 your local computer. The optional arguments 'factor' and
2420 'offset' allow precalculation of the raw input, which is
2421 being modified as follows: 'input = input * factor +
2422 offset'. Note that they have to be given as decimal values
2423 (i.e. contain at least one decimal place).
2429 <option>pop3_unseen</option>
2431 <option>(args)</option>
2433 <listitem>Displays the number of unseen messages in your
2434 global POP3 inbox by default. You can define individual
2435 POP3 inboxes seperately by passing arguments to this
2436 object. Arguments are: "host user pass [-i interval (in
2437 seconds)] [-p port] [-e command] [-r retries]". Default
2438 port is 110, default interval is 5 minutes, and default
2439 number of retries before giving up is 5. If the password is
2440 supplied as '*', you will be prompted to enter the password
2447 <option>pop3_used</option>
2449 <option>(args)</option>
2451 <listitem>Displays the amount of space (in MiB, 2^20) used
2452 in your global POP3 inbox by default. You can define
2453 individual POP3 inboxes seperately by passing arguments to
2454 this object. Arguments are: "host user pass [-i interval
2455 (in seconds)] [-p port] [-e command] [-r retries]". Default
2456 port is 110, default interval is 5 minutes, and default
2457 number of retries before giving up is 5. If the password is
2458 supplied as '*', you will be prompted to enter the password
2465 <option>pre_exec</option>
2467 <option>shell command</option>
2469 <listitem>Executes a shell command one time before conky
2470 displays anything and puts output as text.
2476 <option>processes</option>
2479 <listitem>Total processes (sleeping and running)
2485 <option>read_tcp</option>
2487 <option>(host) port</option>
2489 <listitem>Connects to a tcp port on a host (default is
2490 localhost), reads every char available at the moment and
2497 <option>replied_mails</option>
2499 <option>(maildir)</option>
2500 <option>(interval)</option>
2502 <listitem>Number of mails marked as replied in the
2503 specified mailbox or mail spool if not. Only maildir type
2504 mailboxes are supported, mbox type will return -1.
2510 <option>rss</option>
2512 <option>url delay_in_minutes action (num_par
2513 (spaces_in_front))</option>
2515 <listitem>Download and parse RSS feeds. Action may be one
2516 of the following: feed_title, item_title (with num par),
2517 item_desc (with num par) and item_titles (when using this
2518 action and spaces_in_front is given conky places that many
2519 spaces in front of each item).
2525 <option>running_processes</option>
2528 <listitem>Running processes (not sleeping), requires Linux
2535 <option>scroll</option>
2537 <option>length (step) text</option>
2539 <listitem>Scroll 'text' by 'step' characters showing
2540 'length' number of characters at the same time. The text
2541 may also contain variables. 'step' is optional and defaults
2542 to 1 if not set. If a var creates output on multiple lines
2543 then the lines are placed behind each other separated with
2544 a '|'-sign. Do NOT use vars that change colors or otherwise
2545 affect the design inside a scrolling text. If you want
2546 spaces between the start and the end of 'text', place them
2547 at the end of 'text' not at the front ("foobar" and "
2548 foobar" can both generate "barfoo" but "foobar " will keep
2549 the spaces like this "bar foo").
2555 <option>seen_mails</option>
2557 <option>(maildir)</option>
2558 <option>(interval)</option>
2560 <listitem>Number of mails marked as seen in the specified
2561 mailbox or mail spool if not. Only maildir type mailboxes
2562 are supported, mbox type will return -1.
2568 <option>shadecolor</option>
2570 <option>(color)</option>
2572 <listitem>Change shading color
2578 <option>smapi</option>
2580 <option>(ARGS)</option>
2582 <listitem>when using smapi, display contents of the
2583 /sys/devices/platform/smapi directory. ARGS are either
2584 '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the
2585 corresponding files' content. This is a very raw method of
2586 accessing the smapi values. When available, better use one
2587 of the smapi_* variables instead.
2593 <option>smapi_bat_bar</option>
2595 <option>(INDEX),(height),(width)</option>
2597 <listitem>when using smapi, display the remaining capacity
2598 of the battery with index INDEX as a bar.
2604 <option>smapi_bat_perc</option>
2606 <option>(INDEX)</option>
2608 <listitem>when using smapi, display the remaining capacity
2609 in percent of the battery with index INDEX. This is a
2610 separate variable because it supports the 'use_spacer'
2611 configuration option.
2617 <option>smapi_bat_power</option>
2619 <option>INDEX</option>
2621 <listitem>when using smapi, display the current power of
2622 the battery with index INDEX in watt. This is a separate
2623 variable because the original read out value is being
2624 converted from mW. The sign of the output reflects charging
2625 (positive) or discharging (negative) state.
2631 <option>smapi_bat_temp</option>
2633 <option>INDEX</option>
2635 <listitem>when using smapi, display the current temperature
2636 of the battery with index INDEX in degree Celsius. This is
2637 a separate variable because the original read out value is
2638 being converted from milli degree Celsius.
2644 <option>sony_fanspeed</option>
2647 <listitem>Displays the Sony VAIO fanspeed information if
2648 sony-laptop kernel support is enabled. Linux only.
2654 <option>stippled_hr</option>
2656 <option>(space)</option>
2658 <listitem>Stippled (dashed) horizontal line
2664 <option>swap</option>
2667 <listitem>Amount of swap in use
2673 <option>swapbar</option>
2675 <option>(height),(width)</option>
2677 <listitem>Bar that shows amount of swap in use
2683 <option>swapmax</option>
2686 <listitem>Total amount of swap
2692 <option>swapperc</option>
2695 <listitem>Percentage of swap in use
2701 <option>sysname</option>
2704 <listitem>System name, Linux for example
2710 <option>tab</option>
2712 <option>(width, (start))</option>
2714 <listitem>Puts a tab of the specified width, starting from
2715 column 'start'. The unit is pixels for both arguments.
2721 <option>tail</option>
2723 <option>logfile lines (interval)</option>
2725 <listitem>Displays last N lines of supplied text text file.
2726 If interval is not supplied, Conky assumes 2x Conky's
2727 interval. Max of 30 lines can be displayed, or until the
2728 text buffer is filled.
2734 <option>tcp_portmon</option>
2736 <option>port_begin port_end item (index)</option>
2737 <emphasis>(ip4 only at present)</emphasis>
2739 <listitem>TCP port monitor for specified local ports. Port
2740 numbers must be in the range 1 to 65535. Valid items are:
2743 <command>count</command>- total number of connections
2744 in the range</member>
2746 <command>rip</command>- remote ip address</member>
2748 <command>rhost</command>- remote host name</member>
2750 <command>rport</command>- remote port number</member>
2752 <command>rservice</command>- remote service name from
2753 /etc/services</member>
2755 <command>lip</command>- local ip address</member>
2757 <command>lhost</command>- local host name</member>
2759 <command>lport</command>- local port number</member>
2761 <command>lservice</command>- local service name from
2762 /etc/services</member>
2763 </simplelist>The connection index provides you with access
2764 to each connection in the port monitor. The monitor will
2765 return information for index values from 0 to n-1
2766 connections. Values higher than n-1 are simply ignored. For
2767 the "count" item, the connection index must be omitted. It
2768 is required for all other items.
2770 <member>Examples:</member>
2772 <command>${tcp_portmon 6881 6999 count}</command>-
2773 displays the number of connections in the bittorrent
2776 <command>${tcp_portmon 22 22 rip 0}</command>- displays
2777 the remote host ip of the first sshd
2780 <command>${tcp_portmon 22 22 rip 9}</command>- displays
2781 the remote host ip of the tenth sshd
2784 <command>${tcp_portmon 1 1024 rhost 0}</command>-
2785 displays the remote host name of the first connection
2786 on a privileged port</member>
2788 <command>${tcp_portmon 1 1024 rport 4}</command>-
2789 displays the remote host port of the fifth connection
2790 on a privileged port</member>
2792 <command>${tcp_portmon 1 65535 lservice 14}</command>-
2793 displays the local service name of the fifteenth
2794 connection in the range of all ports</member>
2795 </simplelist>Note that port monitor variables which share
2796 the same port range actually refer to the same monitor, so
2797 many references to a single port range for different items
2798 and different indexes all use the same monitor internally.
2799 In other words, the program avoids creating redundant
2800 monitors.</listitem>
2805 <option>templateN</option>
2807 <option>(arg1)</option>
2808 <option>(arg2)</option>
2809 <option>(arg3 ...)</option>
2811 <listitem>Evaluate the content of the templateN
2812 configuration variable (where N is a value between 0 and 9,
2813 inclusively), applying substitutions as described in the
2814 documentation of the corresponding configuration variable.
2815 The number of arguments is optional, but must match the
2816 highest referred index in the template. You can use the
2817 same special sequences in each argument as the ones valid
2818 for a template definition, e.g. to allow an argument to
2819 contain a whitespace. Also simple nesting of templates is
2822 <listitem>Here are some examples of template definitions:
2824 <member>template0 $\1\2</member>
2825 <member>template1 \1: ${fs_used \2} / ${fs_size
2827 <member>template2 \1 \2</member>
2828 </simplelist>The following list shows sample usage of the
2829 templates defined above, with the equivalent syntax when
2830 not using any template at all:
2835 <entry>using template</entry>
2836 <entry>same without template</entry>
2841 <entry>${template0 node name}</entry>
2842 <entry>$nodename</entry>
2845 <entry>${template1 root /}</entry>
2846 <entry>root: ${fs_free /} / ${fs_size
2851 <programlisting>${template1
2852 ${template2\ disk\ root}
2856 <programlisting>disk root: ${fs_free /}
2857 / ${fs_size /}</programlisting>
2868 <option>texeci</option>
2870 <option>interval command</option>
2872 <listitem>Runs a command at an interval inside a thread and
2873 displays the output. Same as $execi, except the command is
2874 run inside a thread. Use this if you have a slow script to
2875 keep Conky updating. You should make the interval slightly
2876 longer then the time it takes your script to execute. For
2877 example, if you have a script that take 5 seconds to
2878 execute, you should make the interval at least 6 seconds.
2885 <option>time</option>
2887 <option>(format)</option>
2889 <listitem>Local time, see man strftime to get more
2890 information about format
2896 <option>to_bytes</option>
2898 <option>size</option>
2900 <listitem>If 'size' is a number followed by a size-unit
2901 (kilobyte,mb,GiB,...) then it converts the size to bytes
2902 and shows it without unit, otherwise it just shows 'size'.
2908 <option>top</option>
2910 <option>type, num</option>
2912 <listitem>This takes arguments in the form:top (name)
2913 (number) Basically, processes are ranked from highest to
2914 lowest in terms of cpu usage, which is what (num)
2915 represents. The types are: "name", "pid", "cpu", "mem",
2916 "mem_res", "mem_vsize", "time", "io_perc", "io_read" and
2917 "io_write". There can be a max of 10 processes listed.
2923 <option>top_io</option>
2925 <option>type, num</option>
2927 <listitem>Same as top, except sorted by the amount of I/O
2928 the process has done during the update interval
2934 <option>top_mem</option>
2936 <option>type, num</option>
2938 <listitem>Same as top, except sorted by mem usage instead
2945 <option>top_time</option>
2947 <option>type, num</option>
2949 <listitem>Same as top, except sorted by total CPU time
2950 instead of current CPU usage
2956 <option>totaldown</option>
2958 <option>(net)</option>
2960 <listitem>Total download, overflows at 4 GB on Linux with
2961 32-bit arch and there doesn't seem to be a way to know how
2962 many times it has already done that before conky has
2969 <option>totalup</option>
2971 <option>(net)</option>
2973 <listitem>Total upload, this one too, may overflow
2979 <option>trashed_mails</option>
2981 <option>(maildir)</option>
2982 <option>(interval)</option>
2984 <listitem>Number of mails marked as trashed in the
2985 specified mailbox or mail spool if not. Only maildir type
2986 mailboxes are supported, mbox type will return -1.
2992 <option>tztime</option>
2994 <option>(timezone) (format)</option>
2996 <listitem>Local time for specified timezone, see man
2997 strftime to get more information about format. The timezone
2998 argument is specified in similar fashion as TZ environment
2999 variable. For hints, look in /usr/share/zoneinfo. e.g.
3000 US/Pacific, Europe/Zurich, etc.
3006 <option>unflagged_mails</option>
3008 <option>(maildir)</option>
3009 <option>(interval)</option>
3011 <listitem>Number of mails not marked as flagged in the
3012 specified mailbox or mail spool if not. Only maildir type
3013 mailboxes are supported, mbox type will return -1.
3019 <option>unforwarded_mails</option>
3021 <option>(maildir)</option>
3022 <option>(interval)</option>
3024 <listitem>Number of mails not marked as forwarded in the
3025 specified mailbox or mail spool if not. Only maildir type
3026 mailboxes are supported, mbox type will return -1.
3032 <option>unreplied_mails</option>
3034 <option>(maildir)</option>
3035 <option>(interval)</option>
3037 <listitem>Number of mails not marked as replied in the
3038 specified mailbox or mail spool if not. Only maildir type
3039 mailboxes are supported, mbox type will return -1.
3045 <option>unseen_mails</option>
3047 <option>(maildir)</option>
3048 <option>(interval)</option>
3050 <listitem>Number of new or unseen mails in the specified
3051 mailbox or mail spool if not. Only maildir type mailboxes
3052 are supported, mbox type will return -1.
3058 <option>updates</option>
3060 <option>Number of updates</option>
3062 <listitem>for debugging
3068 <option>upspeed</option>
3070 <option>(net)</option>
3072 <listitem>Upload speed in suitable IEC units
3078 <option>upspeedf</option>
3080 <option>(net)</option>
3082 <listitem>Upload speed in KiB with one decimal
3088 <option>upspeedgraph</option>
3090 <option>(netdev) (height),(width) (gradient colour 1)
3091 (gradient colour 2) (scale) (-t) (-l)</option>
3093 <listitem>Upload speed graph, colours defined in hex, minus
3094 the #. If scale is non-zero, it becomes the scale for the
3095 graph. Uses a logarithmic scale (to see small numbers) when
3096 you use the -l switch. Takes the switch '-t' to use a
3097 temperature gradient, which makes the gradient values
3098 change depending on the amplitude of a particular graph
3099 value (try it and see).
3105 <option>uptime</option>
3114 <option>uptime_short</option>
3117 <listitem>Uptime in a shorter format
3123 <option>user_names</option>
3126 <listitem>Lists the names of the users logged in
3132 <option>user_number</option>
3135 <listitem>Number of users logged in
3141 <option>user_terms</option>
3144 <listitem>Lists the consoles in use
3150 <option>user_times</option>
3153 <listitem>Lists how long users have been logged in for
3159 <option>utime</option>
3161 <option>(format)</option>
3163 <listitem>Display time in UTC (universal coordinate time).
3169 <option>voffset</option>
3171 <option>(pixels)</option>
3173 <listitem>Change vertical offset by N pixels. Negative
3174 values will cause text to overlap. See also $offset.
3180 <option>voltage_mv</option>
3182 <option>(n)</option>
3184 <listitem>Returns CPU #n's voltage in mV. CPUs are counted
3185 from 1. If omitted, the parameter defaults to 1.
3191 <option>voltage_v</option>
3193 <option>(n)</option>
3195 <listitem>Returns CPU #n's voltage in V. CPUs are counted
3196 from 1. If omitted, the parameter defaults to 1.
3202 <option>wireless_ap</option>
3204 <option>(net)</option>
3206 <listitem>Wireless access point MAC address (Linux only)
3212 <option>wireless_bitrate</option>
3214 <option>(net)</option>
3216 <listitem>Wireless bitrate (ie 11 Mb/s) (Linux only)
3222 <option>wireless_essid</option>
3224 <option>(net)</option>
3226 <listitem>Wireless access point ESSID (Linux only)
3232 <option>wireless_link_bar</option>
3234 <option>(height),(width) (net)</option>
3236 <listitem>Wireless link quality bar (Linux only)
3242 <option>wireless_link_qual</option>
3244 <option>(net)</option>
3246 <listitem>Wireless link quality (Linux only)
3252 <option>wireless_link_qual_max</option>
3254 <option>(net)</option>
3256 <listitem>Wireless link quality maximum value (Linux only)
3262 <option>wireless_link_qual_perc</option>
3264 <option>(net)</option>
3266 <listitem>Wireless link quality in percents (Linux only)
3272 <option>wireless_mode</option>
3274 <option>(net)</option>
3276 <listitem>Wireless mode (Managed/Ad-Hoc/Master) (Linux
3283 <option>words</option>
3285 <option>textfile</option>
3287 <listitem>Displays the number of words in the given file
3293 <option>xmms2_album</option>
3296 <listitem>Album in current XMMS2 song
3302 <option>xmms2_artist</option>
3305 <listitem>Artist in current XMMS2 song
3311 <option>xmms2_bar</option>
3313 <option>(height),(width)</option>
3315 <listitem>Bar of XMMS2's progress
3321 <option>xmms2_bitrate</option>
3324 <listitem>Bitrate of current song
3330 <option>xmms2_comment</option>
3333 <listitem>Comment in current XMMS2 song
3339 <option>xmms2_date</option>
3342 <listitem>Returns song's date.
3348 <option>xmms2_duration</option>
3351 <listitem>Duration of current song
3357 <option>xmms2_elapsed</option>
3360 <listitem>Song's elapsed time
3366 <option>xmms2_genre</option>
3369 <listitem>Genre in current XMMS2 song
3375 <option>xmms2_id</option>
3378 <listitem>XMMS2 id of current song
3384 <option>xmms2_percent</option>
3387 <listitem>Percent of song's progress
3393 <option>xmms2_playlist</option>
3396 <listitem>Returns the XMMS2 playlist.
3402 <option>xmms2_size</option>
3405 <listitem>Size of current song
3411 <option>xmms2_smart</option>
3414 <listitem>Prints the song name in either the form "artist -
3415 title" or file name, depending on whats available
3421 <option>xmms2_status</option>
3424 <listitem>XMMS2 status (Playing, Paused, Stopped, or
3431 <option>xmms2_timesplayed</option>
3434 <listitem>Number of times a song was played (presumably).
3440 <option>xmms2_title</option>
3443 <listitem>Title in current XMMS2 song
3449 <option>xmms2_tracknr</option>
3452 <listitem>Track number in current XMMS2 song
3458 <option>xmms2_url</option>
3461 <listitem>Full path to current song
projects / monky / blob