5 <option>acpiacadapter</option>
7 <option>(adapter)</option>
9 <listitem>ACPI ac adapter state. On linux, the adapter option specifies the
10 subfolder of /sys/class/power_supply containing the state information (defaults
11 to "AC"). Other systems ignore it.
17 <option>acpifan</option>
20 <listitem>ACPI fan state
26 <option>acpitemp</option>
29 <listitem>ACPI temperature in C.
37 <option>(interface)</option>
39 <listitem>IP address for an interface, or "No Address" if
40 no address is assigned.
46 <option>addrs</option>
48 <option>(interface)</option>
50 <listitem>IP addresses for an interface (if one - works
51 like addr). Linux only.
57 <option>adt746xcpu</option>
60 <listitem>CPU temperature from therm_adt746x
66 <option>adt746xfan</option>
69 <listitem>Fan speed from therm_adt746x
75 <option>alignc</option>
77 <option>(num)</option>
79 <listitem>Align text to centre
85 <option>alignr</option>
87 <option>(num)</option>
89 <listitem>Right-justify text, with space of N
95 <option>apcupsd</option>
100 <listitem>Sets up the connection to apcupsd daemon. Prints
101 nothing, defaults to localhost:3551
107 <option>apcupsd_cable</option>
110 <listitem>Prints the UPS connection type.
116 <option>apcupsd_charge</option>
119 <listitem>Current battery capacity in percent.
125 <option>apcupsd_lastxfer</option>
128 <listitem>Reason for last transfer from line to battery.
134 <option>apcupsd_linev</option>
137 <listitem>Nominal input voltage.
143 <option>apcupsd_load</option>
146 <listitem>Current load in percent.
152 <option>apcupsd_loadbar</option>
155 <listitem>Bar showing current load.
161 <option>apcupsd_loadgauge</option>
163 <option>(height),(width)</option>
165 <listitem>Gauge that shows current load.
171 <option>apcupsd_loadgraph</option>
173 <option>(height),(width) (gradient colour 1) (gradient
174 colour 2) (scale) (-t) (-l)</option>
176 <listitem>History graph of current load.
182 <option>apcupsd_model</option>
185 <listitem>Prints the model of the UPS.
191 <option>apcupsd_name</option>
194 <listitem>Prints the UPS user-defined name.
200 <option>apcupsd_status</option>
203 <listitem>Prints current status (on-line, on-battery).
209 <option>apcupsd_temp</option>
212 <listitem>Current internal temperature.
218 <option>apcupsd_timeleft</option>
221 <listitem>Time left to run on battery.
227 <option>apcupsd_upsmode</option>
230 <listitem>Prints the UPS mode (e.g. standalone).
236 <option>apm_adapter</option>
239 <listitem>Display APM AC adapter status (FreeBSD only)
245 <option>apm_battery_life</option>
248 <listitem>Display APM battery life in percent (FreeBSD
255 <option>apm_battery_time</option>
258 <listitem>Display remaining APM battery life in hh:mm:ss or
259 "unknown" if AC adapterstatus is on-line or charging
266 <option>audacious_bar</option>
268 <option>(height),(width)</option>
270 <listitem>Progress bar
276 <option>audacious_bitrate</option>
279 <listitem>Bitrate of current tune
285 <option>audacious_channels</option>
288 <listitem>Number of audio channels of current tune
294 <option>audacious_filename</option>
297 <listitem>Full path and filename of current tune
303 <option>audacious_frequency</option>
306 <listitem>Sampling frequency of current tune
312 <option>audacious_length</option>
315 <listitem>Total length of current tune as MM:SS
321 <option>audacious_length_seconds</option>
324 <listitem>Total length of current tune in seconds
330 <option>audacious_main_volume</option>
333 <listitem>The current volume fetched from Audacious
339 <option>audacious_playlist_length</option>
342 <listitem>Number of tunes in playlist
348 <option>audacious_playlist_position</option>
351 <listitem>Playlist position of current tune
357 <option>audacious_position</option>
360 <listitem>Position of current tune (MM:SS)
366 <option>audacious_position_seconds</option>
369 <listitem>Position of current tune in seconds
375 <option>audacious_status</option>
378 <listitem>Player status (Playing/Paused/Stopped/Not
385 <option>audacious_title</option>
387 <option>(max length)</option>
389 <listitem>Title of current tune with optional maximum
396 <option>battery</option>
398 <option>(num)</option>
400 <listitem>Battery status and remaining percentage capacity
401 of ACPI or APM battery. ACPI battery number can be given as
402 argument (default is BAT0).
408 <option>battery_bar</option>
410 <option>(height),(width) (num)</option>
412 <listitem>Battery percentage remaining of ACPI battery in a
413 bar. ACPI battery number can be given as argument (default
420 <option>battery_percent</option>
422 <option>(num)</option>
424 <listitem>Battery percentage remaining for ACPI battery.
425 ACPI battery number can be given as argument (default is
432 <option>battery_short</option>
434 <option>(num)</option>
436 <listitem>Battery status and remaining percentage capacity
437 of ACPI or APM battery. ACPI battery number can be given as
438 argument (default is BAT0). This mode display a short
439 status, which means that C is displayed instead of
440 charging, D for discharging, F for full, N for not present,
441 E for empty and U for unknown.
447 <option>battery_time</option>
449 <option>(num)</option>
451 <listitem>Battery charge/discharge time remaining of ACPI
452 battery. ACPI battery number can be given as argument
459 <option>blink</option>
461 <option>text_and_other_conky_vars</option>
463 <listitem>Let 'text_and_other_conky_vars' blink on and off.
470 <option>bmpx_album</option>
473 <listitem>Album in current BMPx track
479 <option>bmpx_artist</option>
482 <listitem>Artist in current BMPx track
488 <option>bmpx_bitrate</option>
491 <listitem>Bitrate of the current BMPx track
497 <option>bmpx_title</option>
500 <listitem>Title of the current BMPx track
506 <option>bmpx_track</option>
509 <listitem>Track number of the current BMPx track
515 <option>bmpx_uri</option>
518 <listitem>URI of the current BMPx track
524 <option>buffers</option>
527 <listitem>Amount of memory buffered
533 <option>cached</option>
536 <listitem>Amount of memory cached
542 <option>cmdline_to_pid</option>
544 <option>string</option>
546 <listitem>PID of the first process that has string in it's
553 <option>color</option>
555 <option>(color)</option>
557 <listitem>Change drawing color to 'color' which is a name of
558 a color or a hexcode preceded with # (for example #0A1B2C ).
559 If you use ncurses only the following colors are supported:
560 red,green,yellow,blue,magenta,cyan,black,white.
566 <option>colorN</option>
569 <listitem>Change drawing color to colorN configuration
570 option, where N is a digit between 0 and 9, inclusively.
576 <option>combine</option>
578 <option>var1 var2</option>
580 <listitem>Places the lines of var2 to the right of the
581 lines of var1 separated by the chars that are put between
582 var1 and var2. For example: ${combine ${head /proc/cpuinfo
583 2} - ${head /proc/meminfo 1}} gives as output
584 "cpuinfo_line1 - meminfo_line1" on line 1 and
585 "cpuinfo_line2 -" on line 2. $combine vars can also be
586 nested to place more vars next to each other.
592 <option>conky_build_arch</option>
595 <listitem>CPU architecture Conky was built for
601 <option>conky_build_date</option>
604 <listitem>Date Conky was built
610 <option>conky_version</option>
613 <listitem>Conky version
621 <option>(cpuN)</option>
623 <listitem>CPU usage in percents. For SMP machines, the CPU
624 number can be provided as an argument. ${cpu cpu0} is the
625 total usage, and ${cpu cpuX} (X >= 1) are individual
632 <option>cpubar</option>
634 <option>(cpuN) (height),(width)</option>
636 <listitem>Bar that shows CPU usage, height is bar's height
637 in pixels. See $cpu for more info on SMP.
643 <option>cpugauge</option>
645 <option>(cpuN) (height),(width)</option>
647 <listitem>Elliptical gauge that shows CPU usage, height and
648 width are gauge's vertical and horizontal axis
649 respectively. See $cpu for more info on SMP.
655 <option>cpugraph</option>
657 <option>(cpuN) (height),(width) (gradient colour 1)
658 (gradient colour 2) (scale) (-t) (-l)</option>
660 <listitem>CPU usage graph, with optional colours in hex,
661 minus the #. See $cpu for more info on SMP. Uses a
662 logarithmic scale (to see small numbers) when you use the
663 -l switch. Takes the switch '-t' to use a temperature
664 gradient, which makes the gradient values change depending
665 on the amplitude of a particular graph value (try it and
672 <option>curl</option>
674 <option>url (interval_in_minutes)</option>
677 <para>Download data from URI using Curl at the
678 specified interval. The interval may be a floating
679 point value greater than 0, otherwise defaults to 15
680 minutes. Most useful when used in conjunction with Lua
681 and the Lua API. This object is threaded, and once a
682 thread is created it can't be explicitly destroyed.
683 One thread will run for each URI specified. You can use
684 any protocol that Curl supports.</para>
690 <option>desktop</option>
693 <listitem>Number of the desktop on which conky is running
694 or the message "Not running in X" if this is the case.
700 <option>desktop_name</option>
703 <listitem>Name of the desktop on which conky is running or
704 the message "Not running in X" if this is the case.
710 <option>desktop_number</option>
713 <listitem>Number of desktops or the message "Not running in
714 X" if this is the case.
720 <option>disk_protect</option>
722 <option>device</option>
724 <listitem>Disk protection status, if supported (needs
725 kernel-patch). Prints either "frozen" or "free " (note the
732 <option>diskio</option>
734 <option>(device)</option>
736 <listitem>Displays current disk IO. Device is optional, and
737 takes the form of sda for /dev/sda. Individual partitions
744 <option>diskio_read</option>
746 <option>(device)</option>
748 <listitem>Displays current disk IO for reads. Device as in
755 <option>diskio_write</option>
757 <option>(device)</option>
759 <listitem>Displays current disk IO for writes. Device as in
766 <option>diskiograph</option>
768 <option>(device) (height),(width) (gradient colour 1)
769 (gradient colour 2) (scale) (-t) (-l)</option>
771 <listitem>Disk IO graph, colours defined in hex, minus the
772 #. If scale is non-zero, it becomes the scale for the
773 graph. Uses a logarithmic scale (to see small numbers) when
774 you use -l switch. Takes the switch '-t' to use a
775 temperature gradient, which makes the gradient values
776 change depending on the amplitude of a particular graph
777 value (try it and see).
783 <option>diskiograph_read</option>
785 <option>(device) (height),(width) (gradient colour 1)
786 (gradient colour 2) (scale) (-t) (-l)</option>
788 <listitem>Disk IO graph for reads, colours defined in hex,
789 minus the #. If scale is non-zero, it becomes the scale for
790 the graph. Device as in diskio. Uses a logarithmic scale
791 (to see small numbers) when you use -l switch. Takes the
792 switch '-t' to use a temperature gradient, which makes the
793 gradient values change depending on the amplitude of a
794 particular graph value (try it and see).
800 <option>diskiograph_write</option>
802 <option>(device) (height),(width) (gradient colour 1)
803 (gradient colour 2) (scale) (-t) (-l)</option>
805 <listitem>Disk IO graph for writes, colours defined in hex,
806 minus the #. If scale is non-zero, it becomes the scale for
807 the graph. Device as in diskio. Uses a logarithmic scale
808 (to see small numbers) when you use -l switch. Takes the
809 switch '-t' to use a temperature gradient, which makes the
810 gradient values change depending on the amplitude of a
811 particular graph value (try it and see).
817 <option>downspeed</option>
819 <option>(net)</option>
821 <listitem>Download speed in suitable IEC units
827 <option>downspeedf</option>
829 <option>(net)</option>
831 <listitem>Download speed in KiB with one decimal
837 <option>downspeedgraph</option>
839 <option>(netdev) (height),(width) (gradient colour 1)
840 (gradient colour 2) (scale) (-t) (-l)</option>
842 <listitem>Download speed graph, colours defined in hex,
843 minus the #. If scale is non-zero, it becomes the scale for
844 the graph. Uses a logarithmic scale (to see small numbers)
845 when you use -l switch. Takes the switch '-t' to use a
846 temperature gradient, which makes the gradient values
847 change depending on the amplitude of a particular graph
848 value (try it and see).
854 <option>draft_mails</option>
856 <option>(maildir)</option>
857 <option>(interval)</option>
859 <listitem>Number of mails marked as draft in the specified
860 mailbox or mail spool if not. Only maildir type mailboxes
861 are supported, mbox type will return -1.
867 <option>else</option>
870 <listitem>Text to show if any of the above are not true
876 <option>endif</option>
880 <listitem>Ends an $if block.
886 <option>entropy_avail</option>
889 <listitem>Current entropy available for crypto freaks
895 <option>entropy_bar</option>
897 <option>(height),(width)</option>
899 <listitem>Normalized bar of available entropy for crypto
906 <option>entropy_perc</option>
909 <listitem>Percentage of entropy available in comparison to
916 <option>entropy_poolsize</option>
919 <listitem>Total size of system entropy pool for crypto
926 <option>eval</option>
928 <option>string</option>
930 <listitem>Evaluates given string according to the rules of
931 TEXT interpretation, i.e. parsing any contained text object
932 specifications into their output, any occuring '$$' into a
933 single '$' and so on. The output is then being parsed
942 <option>api_userid api_key character_id</option>
944 <listitem>Fetches your currently training skill from the
945 Eve Online API servers (http://www.eve-online.com/) and
946 displays the skill along with the remaining training time.
952 <option>exec</option>
954 <option>command</option>
956 <listitem>Executes a shell command and displays the output
957 in conky. warning: this takes a lot more resources than
958 other variables. I'd recommend coding wanted behaviour in C
965 <option>execbar</option>
967 <option>command</option>
969 <listitem>Same as exec, except if the first value return is
970 a value between 0-100, it will use that number for a bar.
971 The size for bars can be controlled via the
972 default_bar_size config setting.
978 <option>execgauge</option>
980 <option>command</option>
982 <listitem>Same as exec, except if the first value returned
983 is a value between 0-100, it will use that number for a
984 gauge. The size for gauges can be controlled via the
985 default_gauge_size config setting.
991 <option>execgraph</option>
993 <option>(-t) (-l) command</option>
995 <listitem>Same as execbar, but graphs values. Uses a
996 logaritmic scale when the log option (-l switch) is given
997 (to see small numbers). Values still have to be between 0
998 and 100. The size for graphs can be controlled via the
999 default_graph_size config setting. Takes the switch '-t' to
1000 use a temperature gradient, which makes the gradient values
1001 change depending on the amplitude of a particular graph
1002 value (try it and see). If -t or -l is your first argument,
1003 you may need to preceed it by a space (' ').
1009 <option>execi</option>
1011 <option>interval command</option>
1013 <listitem>Same as exec but with specific interval. Interval
1014 can't be less than update_interval in configuration. See
1021 <option>execibar</option>
1023 <option>interval command</option>
1025 <listitem>Same as execbar, except with an interval
1031 <option>execigauge</option>
1033 <option>interval command</option>
1035 <listitem>Same as execgauge, but takes an interval arg and
1042 <option>execigraph</option>
1044 <option>interval (-t) (-l) command</option>
1046 <listitem>Same as execgraph, but takes an interval arg and
1047 graphs values. If -t or -l is your first argument, you may
1048 need to preceed it by a space (' ').
1054 <option>execp</option>
1056 <option>command</option>
1058 <listitem>Executes a shell command and displays the output
1059 in conky. warning: this takes a lot more resources than
1060 other variables. I'd recommend coding wanted behaviour in C
1061 and posting a patch. This differs from $exec in that it
1062 parses the output of the command, so you can insert things
1063 like ${color red}hi!${color} in your script and have it
1064 correctly parsed by Conky. Caveats: Conky parses and
1065 evaluates the output of $execp every time Conky loops, and
1066 then destroys all the objects. If you try to use anything
1067 like $execi within an $execp statement, it will
1068 functionally run at the same interval that the $execp
1069 statement runs, as it is created and destroyed at every
1076 <option>execpi</option>
1078 <option>interval command</option>
1080 <listitem>Same as execp but with specific interval.
1081 Interval can't be less than update_interval in
1082 configuration. Note that the output from the $execpi
1083 command is still parsed and evaluated at every interval.
1089 <option>flagged_mails</option>
1091 <option>(maildir)</option>
1092 <option>(interval)</option>
1094 <listitem>Number of mails marked as flagged in the
1095 specified mailbox or mail spool if not. Only maildir type
1096 mailboxes are supported, mbox type will return -1.
1102 <option>font</option>
1104 <option>(font)</option>
1106 <listitem>Specify a different font. This new font will
1107 apply to the current line and everything following. You can
1108 use a $font with no arguments to change back to the default
1109 font (much like with $color)
1115 <option>format_time</option>
1117 <option>seconds format</option>
1119 <listitem>Format time given in seconds. This var only works when
1120 the times_in_seconds configuration setting is on. Format is a string
1121 that should start and end with a "-char. The "-chars are not
1122 part of the output, \w,\d,\h,\m,\s,\(,\) and \\ are replaced by
1123 weeks,days,hours,minutes,seconds,(,) and \. If you leave out a unit,
1124 it's value will be expressed in the highest unite lower then the
1125 one left out. Text between ()-chars will not be visible if a
1126 replaced unit in this text is 0. If seconds is a decimal number
1127 then you can see the numbers behind the point by using \S
1128 followed by a number that specifies the amount of
1129 digits behind the point that you want to see (maximum 9).
1130 You can also place a 'x' behind \S so you have all digits behind
1131 the point and no trailing zero's. (also maximum 9)
1137 <option>forwarded_mails</option>
1139 <option>(maildir)</option>
1140 <option>(interval)</option>
1142 <listitem>Number of mails marked as forwarded in the
1143 specified mailbox or mail spool if not. Only maildir type
1144 mailboxes are supported, mbox type will return -1.
1150 <option>freq</option>
1152 <option>(n)</option>
1154 <listitem>Returns CPU #n's frequency in MHz. CPUs are
1155 counted from 1. If omitted, the parameter defaults to 1.
1161 <option>freq_g</option>
1163 <option>(n)</option>
1165 <listitem>Returns CPU #n's frequency in GHz. CPUs are
1166 counted from 1. If omitted, the parameter defaults to 1.
1172 <option>fs_bar</option>
1174 <option>(height),(width) fs</option>
1176 <listitem>Bar that shows how much space is used on a file
1177 system. height is the height in pixels. fs is any file on
1184 <option>fs_bar_free</option>
1186 <option>(height),(width) fs</option>
1188 <listitem>Bar that shows how much space is free on a file
1189 system. height is the height in pixels. fs is any file on
1196 <option>fs_free</option>
1198 <option>(fs)</option>
1200 <listitem>Free space on a file system available for users.
1206 <option>fs_free_perc</option>
1208 <option>(fs)</option>
1210 <listitem>Free percentage of space on a file system
1211 available for users.
1217 <option>fs_size</option>
1219 <option>(fs)</option>
1221 <listitem>File system size.
1227 <option>fs_type</option>
1229 <option>(fs)</option>
1231 <listitem>File system type.
1237 <option>fs_used</option>
1239 <option>(fs)</option>
1241 <listitem>File system used space.
1247 <option>fs_used_perc</option>
1249 <option>(fs)</option>
1251 <listitem>Percent of file system used space.
1257 <option>goto</option>
1261 <listitem>The next element will be printed at position 'x'.
1268 <option>gw_iface</option>
1271 <listitem>Displays the default route's interface or
1272 "multiple"/"none" accordingly.
1278 <option>gw_ip</option>
1281 <listitem>Displays the default gateway's IP or
1282 "multiple"/"none" accordingly.
1288 <option>hddtemp</option>
1290 <option>(dev)</option>
1292 <listitem>Displays temperature of a selected hard disk
1293 drive as reported by the hddtemp daemon. Use hddtemp_host
1294 and hddtemp_port to specify a host and port for all hddtemp
1295 objects. If no dev parameter is given, the first disk returned
1296 by the hddtemp daemon is used.
1302 <option>head</option>
1304 <option>logfile lines (next_check)</option>
1306 <listitem>Displays first N lines of supplied text file. The
1307 file is checked every 'next_check' update. If next_check is
1308 not supplied, Conky defaults to 2. Max of 30 lines can be
1309 displayed, or until the text buffer is filled.
1317 <option>(height)</option>
1319 <listitem>Horizontal line, height is the height in pixels
1325 <option>hwmon</option>
1327 <option>(dev) type n (factor offset)</option>
1329 <listitem>Hwmon sensor from sysfs (Linux 2.6). Parameter
1330 dev may be omitted if you have only one hwmon device.
1331 Parameter type is either 'in' or 'vol' meaning voltage;
1332 'fan' meaning fan; 'temp' meaning temperature. Parameter n
1333 is number of the sensor. See /sys/class/hwmon/ on your
1334 local computer. The optional arguments 'factor' and
1335 'offset' allow precalculation of the raw input, which is
1336 being modified as follows: 'input = input * factor +
1337 offset'. Note that they have to be given as decimal values
1338 (i.e. contain at least one decimal place).
1344 <option>i2c</option>
1346 <option>(dev) type n (factor offset)</option>
1348 <listitem>I2C sensor from sysfs (Linux 2.6). Parameter dev
1349 may be omitted if you have only one I2C device. Parameter
1350 type is either 'in' or 'vol' meaning voltage; 'fan' meaning
1351 fan; 'temp' meaning temperature. Parameter n is number of
1352 the sensor. See /sys/bus/i2c/devices/ on your local
1353 computer. The optional arguments 'factor' and 'offset'
1354 allow precalculation of the raw input, which is being
1355 modified as follows: 'input = input * factor + offset'.
1356 Note that they have to be given as decimal values (i.e.
1357 contain at least one decimal place).
1363 <option>i8k_ac_status</option>
1367 <listitem>If running the i8k kernel driver for Inspiron
1368 laptops, displays whether ac power is on, as listed in
1369 /proc/i8k (translated to human-readable). Beware that this
1370 is by default not enabled by i8k itself.
1376 <option>i8k_bios</option>
1380 <listitem>If running the i8k kernel driver for Inspiron
1381 laptops, displays the bios version as listed in /proc/i8k.
1387 <option>i8k_buttons_status</option>
1391 <listitem>If running the i8k kernel driver for Inspiron
1392 laptops, displays the volume buttons status as listed in
1399 <option>i8k_cpu_temp</option>
1403 <listitem>If running the i8k kernel driver for Inspiron
1404 laptops, displays the cpu temperature in Celsius, as
1405 reported by /proc/i8k.
1411 <option>i8k_left_fan_rpm</option>
1415 <listitem>If running the i8k kernel driver for Inspiron
1416 laptops, displays the left fan's rate of rotation, in
1417 revolutions per minute as listed in /proc/i8k. Beware, some
1418 laptops i8k reports these fans in reverse order.
1424 <option>i8k_left_fan_status</option>
1428 <listitem>If running the i8k kernel driver for Inspiron
1429 laptops, displays the left fan status as listed in
1430 /proc/i8k (translated to human-readable). Beware, some
1431 laptops i8k reports these fans in reverse order.
1437 <option>i8k_right_fan_rpm</option>
1441 <listitem>If running the i8k kernel driver for Inspiron
1442 laptops, displays the right fan's rate of rotation, in
1443 revolutions per minute as listed in /proc/i8k. Beware, some
1444 laptops i8k reports these fans in reverse order.
1450 <option>i8k_right_fan_status</option>
1454 <listitem>If running the i8k kernel driver for Inspiron
1455 laptops, displays the right fan status as listed in
1456 /proc/i8k (translated to human-readable). Beware, some
1457 laptops i8k reports these fans in reverse order.
1463 <option>i8k_serial</option>
1467 <listitem>If running the i8k kernel driver for Inspiron
1468 laptops, displays your laptop serial number as listed in
1475 <option>i8k_version</option>
1479 <listitem>If running the i8k kernel driver for Inspiron
1480 laptops, displays the version formatting of /proc/i8k.
1486 <option>ibm_brightness</option>
1489 <listitem>If running the IBM ACPI, displays the brigtness
1490 of the laptops's LCD (0-7).
1496 <option>ibm_fan</option>
1499 <listitem>If running the IBM ACPI, displays the fan speed.
1505 <option>ibm_temps</option>
1509 <listitem>If running the IBM ACPI, displays the
1510 temperatures from the IBM temperature sensors (N=0..7)
1511 Sensor 0 is on the CPU, 3 is on the GPU.
1517 <option>ibm_volume</option>
1520 <listitem>If running the IBM ACPI, displays the "master"
1521 volume, controlled by the volume keys (0-14).
1527 <option>iconv_start</option>
1529 <option>codeset_from codeset_to</option>
1531 <listitem>Convert text from one codeset to another using
1532 GNU iconv. Needs to be stopped with iconv_stop.
1538 <option>iconv_stop</option>
1542 <listitem>Stop iconv codeset conversion.
1548 <option>if_empty</option>
1550 <option>(var)</option>
1552 <listitem>if conky variable VAR is empty, display
1553 everything between $if_empty and the matching $endif
1559 <option>if_existing</option>
1561 <option>file (string)</option>
1563 <listitem>if FILE exists, display everything between
1564 if_existing and the matching $endif. The optional second
1565 paramater checks for FILE containing the specified string
1566 and prints everything between $if_existing and the matching
1573 <option>if_gw</option>
1576 <listitem>if there is at least one default gateway, display
1577 everything between $if_gw and the matching $endif
1583 <option>if_match</option>
1585 <option>expression</option>
1587 <listitem>Evaluates the given boolean expression, printing
1588 everything between $if_match and the matching $endif
1589 depending on whether the evaluation returns true or not.
1590 Valid expressions consist of a left side, an operator and a
1591 right side. Left and right sides are being parsed for
1592 contained text objects before evaluation. Recognised left
1593 and right side types are:
1596 <command>double</command>Argument consists of only
1597 digits and a single dot.</member>
1599 <command>long</command>Argument consists of only
1602 <command>string</command>Argument is enclosed in
1603 quotation mark or the checks for double and long failed
1605 </simplelist>Valid operands are: '>', '<', '>=',
1606 '<=', '==', '!='.
1612 <option>if_mixer_mute</option>
1614 <option>(mixer)</option>
1616 <listitem>If mixer exists, display everything between
1617 $if_mixer_mute and the matching $endif. If no mixer is
1618 specified, "Master" is used.
1624 <option>if_mounted</option>
1626 <option>(mountpoint)</option>
1628 <listitem>if MOUNTPOINT is mounted, display everything
1629 between $if_mounted and the matching $endif
1635 <option>if_mpd_playing</option>
1638 <listitem>if mpd is playing or paused, display everything
1639 between $if_mpd_playing and the matching $endif
1645 <option>if_running</option>
1647 <option>(process)</option>
1649 <listitem>if PROCESS is running, display everything
1650 $if_running and the matching $endif. This uses the
1651 ``pidof'' command, so the -x switch is also supported.
1657 <option>if_smapi_bat_installed</option>
1659 <option>(INDEX)</option>
1661 <listitem>when using smapi, if the battery with index INDEX
1662 is installed, display everything between
1663 $if_smapi_bat_installed and the matching $endif
1669 <option>if_up</option>
1671 <option>(interface)</option>
1673 <listitem>if INTERFACE exists and is up, display everything
1674 between $if_up and the matching $endif
1680 <option>if_updatenr</option>
1682 <option>(updatenr)</option>
1684 <listitem>If it's the UPDATENR-th time that conky updates,
1685 display everything between $if_updatenr and the matching
1686 $endif. The counter resets when the highest UPDATENR is
1687 reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr
1688 2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the
1689 time followed by bar 25% of the time followed by nothing
1690 the other half of the time.
1696 <option>if_xmms2_connected</option>
1699 <listitem>Display everything between $if_xmms2_connected
1700 and the matching $endif if xmms2 is running.
1706 <option>image</option>
1708 <option><path to image> (-p x,y) (-s WxH) (-n)
1709 (-f interval)</option>
1711 <listitem>Renders an image from the path specified using
1712 Imlib2. Takes 4 optional arguments: a position, a size, a
1713 no-cache switch, and a cache flush interval. Changing the
1714 x,y position will move the position of the image, and
1715 changing the WxH will scale the image. If you specify the
1716 no-cache flag (-n), the image will not be cached.
1717 Alternately, you can specify the -f int switch to specify a
1718 cache flust interval for a particular image. Example:
1719 ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200}
1720 will render 'cheeseburger.jpg' at (20,20) scaled to 200x200
1721 pixels. Conky does not make any attempt to adjust the
1722 position (or any other formatting) of images, they are just
1723 rendered as per the arguments passed. The only reason
1724 $image is part of the TEXT section, is to allow for runtime
1725 modifications, through $execp $lua_parse, or some other
1732 <option>imap_messages</option>
1734 <option>(args)</option>
1736 <listitem>Displays the number of messages in your global
1737 IMAP inbox by default. You can define individual IMAP
1738 inboxes separately by passing arguments to this object.
1739 Arguments are: "host user pass [-i interval (in seconds)]
1740 [-f 'folder'] [-p port] [-e 'command'] [-r retries]". Default
1741 port is 143, default folder is 'INBOX', default interval is
1742 5 minutes, and default number of retries before giving up
1743 is 5. If the password is supplied as '*', you will be
1744 prompted to enter the password when Conky starts.
1750 <option>imap_unseen</option>
1752 <option>(args)</option>
1754 <listitem>Displays the number of unseen messages in your
1755 global IMAP inbox by default. You can define individual
1756 IMAP inboxes separately by passing arguments to this
1757 object. Arguments are: "host user pass [-i interval (in
1758 seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r retries]".
1759 Default port is 143, default folder is 'INBOX', default
1760 interval is 5 minutes, and default number of retries before
1761 giving up is 5. If the password is supplied as '*', you
1762 will be prompted to enter the password when Conky starts.
1768 <option>include</option>
1770 <option>path</option>
1773 <para>Loads the configfile at path, places the
1774 configsettings behind the configsettings in the orginal
1775 config and places the vars where the includevar
1782 <option>ioscheduler</option>
1784 <option>disk</option>
1786 <listitem>Prints the current ioscheduler used for the given
1787 disk name (i.e. e.g. "hda" or "sdb")
1793 <option>kernel</option>
1796 <listitem>Kernel version
1802 <option>laptop_mode</option>
1805 <listitem>The value of /proc/sys/vm/laptop_mode
1811 <option>lines</option>
1813 <option>textfile</option>
1815 <listitem>Displays the number of lines in the given file
1821 <option>loadavg</option>
1823 <option>(1|2|3)</option>
1825 <listitem>System load average, 1 is for past 1 minute, 2
1826 for past 5 minutes and 3 for past 15 minutes. Without argument, prints
1827 all three values separated by whitespace.
1833 <option>loadgraph</option>
1835 <option>(height),(width) (gradient colour 1)
1836 (gradient colour 2) (scale) (-t) (-l)</option>
1838 <listitem>Load1 average graph, similar to xload, with
1839 optional colours in hex, minus the #. Uses a logarithmic
1840 scale (to see small numbers) when you use the -l switch.
1841 Takes the switch '-t' to use a temperature gradient, which
1842 makes the gradient values change depending on the amplitude
1843 of a particular graph value (try it and see).
1849 <option>lua</option>
1851 <option>function_name (function parameters)</option>
1853 <listitem>Executes a Lua function with given parameters,
1854 then prints the returned string. See also 'lua_load' on how
1855 to load scripts. Conky puts 'conky_' in front of
1856 function_name to prevent accidental calls to the wrong
1857 function unless you put you place 'conky_' in front of it
1864 <option>lua_bar</option>
1866 <option>(height, width) function_name (function
1867 parameters)</option>
1869 <listitem>Executes a Lua function with given parameters and
1870 draws a bar. Expects result value to be an integer between
1871 0 and 100. See also 'lua_load' on how to load scripts.
1872 Conky puts 'conky_' in front of function_name to prevent
1873 accidental calls to the wrong function unless you put you
1874 place 'conky_' in front of it yourself.
1880 <option>lua_gauge</option>
1882 <option>(height, width) function_name (function
1883 parameters)</option>
1885 <listitem>Executes a Lua function with given parameters and
1886 draws a gauge. Expects result value to be an integer
1887 between 0 and 100. See also 'lua_load' on how to load
1888 scripts. Conky puts 'conky_' in front of function_name to
1889 prevent accidental calls to the wrong function unless you
1890 put you place 'conky_' in front of it yourself.
1896 <option>lua_graph</option>
1898 <option>function_name (height),(width) (gradient colour
1899 1) (gradient colour 2) (scale) (-t) (-l)</option>
1901 <listitem>Executes a Lua function with and draws a graph.
1902 Expects result value to be any number, and by default will
1903 scale to show the full range. See also 'lua_load' on how to
1904 load scripts. Takes the switch '-t' to use a temperature
1905 gradient, which makes the gradient values change depending
1906 on the amplitude of a particular graph value (try it and
1907 see). Conky puts 'conky_' in front of function_name to
1908 prevent accidental calls to the wrong function unless you
1909 put you place 'conky_' in front of it yourself.
1915 <option>lua_parse</option>
1917 <option>function_name (function parameters)</option>
1919 <listitem>Executes a Lua function with given parameters as
1920 per $lua, then parses and prints the result value as per
1921 the syntax for Conky's TEXT section. See also 'lua_load' on
1922 how to load scripts. Conky puts 'conky_' in front of
1923 function_name to prevent accidental calls to the wrong
1924 function unless you put you place 'conky_' in front of it
1931 <option>machine</option>
1934 <listitem>Machine, i686 for example
1940 <option>mails</option>
1942 <option>(mailbox)</option>
1943 <option>(interval)</option>
1945 <listitem>Mail count in the specified mailbox or your mail
1946 spool if not. Both mbox and maildir type mailboxes are
1947 supported. You can use a program like fetchmail to get
1948 mails from some server using your favourite protocol. See
1955 <option>mboxscan</option>
1957 <option>(-n number of messages to print) (-fw from
1958 width) (-sw subject width) mbox</option>
1960 <listitem>Print a summary of recent messages in an mbox
1961 format mailbox. mbox parameter is the filename of the
1962 mailbox (can be encapsulated using '"', ie. ${mboxscan -n
1963 10 "/home/brenden/some box"}
1969 <option>mem</option>
1972 <listitem>Amount of memory in use
1978 <option>membar</option>
1980 <option>(height),(width)</option>
1982 <listitem>Bar that shows amount of memory in use
1988 <option>memeasyfree</option>
1991 <listitem>Amount of free memory including the memory that
1992 is very easily freed (buffers/cache)
1998 <option>memfree</option>
2001 <listitem>Amount of free memory
2007 <option>memgauge</option>
2009 <option>(height),(width)</option>
2011 <listitem>Gauge that shows amount of memory in use (see
2018 <option>memgraph</option>
2020 <option>(height),(width) (gradient colour 1) (gradient
2021 colour 2) (scale) (-t) (-l)</option>
2023 <listitem>Memory usage graph. Uses a logarithmic scale (to
2024 see small numbers) when you use the -l switch. Takes the
2025 switch '-t' to use a temperature gradient, which makes the
2026 gradient values change depending on the amplitude of a
2027 particular graph value (try it and see).
2033 <option>memmax</option>
2036 <listitem>Total amount of memory
2042 <option>memperc</option>
2045 <listitem>Percentage of memory in use
2051 <option>mixer</option>
2053 <option>(device)</option>
2055 <listitem>Prints the mixer value as reported by the OS.
2056 Default mixer is "vol", but you can specify one of the
2057 following optional arguments: "vol", "bass", "treble",
2058 "synth", "pcm", "speaker", "line", "mic", "cd", "mix",
2059 "pcm2", "rec", "igain", "ogain", "line1", "line2", "line3",
2060 "dig1", "dig2", "dig3", "phin", "phout", "video", "radio",
2061 "monitor". Refer to the definition of SOUND_DEVICE_NAMES in
2062 <linux/soundcard.h> (on Linux), <soundcard.h>
2063 (on OpenBSD), or <sys/soundcard.h> to find the exact
2064 options available on your system.
2070 <option>mixerbar</option>
2072 <option>(device)</option>
2074 <listitem>Displays mixer value in a bar as reported by the
2075 OS. See docs for $mixer for details on arguments.
2081 <option>mixerl</option>
2083 <option>(device)</option>
2085 <listitem>Prints the left channel mixer value as reported
2086 by the OS. See docs for $mixer for details on arguments.
2092 <option>mixerlbar</option>
2094 <option>(device)</option>
2096 <listitem>Displays the left channel mixer value in a bar as
2097 reported by the OS. See docs for $mixer for details on
2104 <option>mixerr</option>
2106 <option>(device)</option>
2108 <listitem>Prints the right channel mixer value as reported
2109 by the OS. See docs for $mixer for details on arguments.
2115 <option>mixerrbar</option>
2117 <option>(device)</option>
2119 <listitem>Displays the right channel mixer value in a bar
2120 as reported by the OS. See docs for $mixer for details on
2127 <option>moc_album</option>
2130 <listitem>Album of the current MOC song
2136 <option>moc_artist</option>
2139 <listitem>Artist of the current MOC song
2145 <option>moc_bitrate</option>
2148 <listitem>Bitrate in the current MOC song
2154 <option>moc_curtime</option>
2157 <listitem>Current time of the current MOC song
2163 <option>moc_file</option>
2166 <listitem>File name of the current MOC song
2172 <option>moc_rate</option>
2175 <listitem>Rate of the current MOC song
2181 <option>moc_song</option>
2184 <listitem>The current song name being played in MOC.
2190 <option>moc_state</option>
2193 <listitem>Current state of MOC; playing, stopped etc.
2199 <option>moc_timeleft</option>
2202 <listitem>Time left in the current MOC song
2208 <option>moc_title</option>
2211 <listitem>Title of the current MOC song
2217 <option>moc_totaltime</option>
2220 <listitem>Total length of the current MOC song
2226 <option>monitor</option>
2229 <listitem>Number of the monitor on which conky is running
2230 or the message "Not running in X" if this is the case.
2236 <option>monitor_number</option>
2239 <listitem>Number of monitors or the message "Not running in
2240 X" if this is the case.
2246 <option>mpd_album</option>
2249 <listitem>Album in current MPD song
2255 <option>mpd_artist</option>
2258 <listitem>Artist in current MPD song must be enabled at
2265 <option>mpd_bar</option>
2267 <option>(height),(width)</option>
2269 <listitem>Bar of mpd's progress
2275 <option>mpd_bitrate</option>
2278 <listitem>Bitrate of current song
2284 <option>mpd_elapsed</option>
2287 <listitem>Song's elapsed time
2293 <option>mpd_file</option>
2296 <listitem>Prints the file name of the current MPD song
2302 <option>mpd_length</option>
2305 <listitem>Song's length
2311 <option>mpd_name</option>
2314 <listitem>Prints the MPD name field
2320 <option>mpd_percent</option>
2323 <listitem>Percent of song's progress
2329 <option>mpd_random</option>
2332 <listitem>Random status (On/Off)
2338 <option>mpd_repeat</option>
2341 <listitem>Repeat status (On/Off)
2347 <option>mpd_smart</option>
2349 <option>(max length)</option>
2351 <listitem>Prints the song name in either the form "artist -
2352 title" or file name, depending on whats available
2358 <option>mpd_status</option>
2361 <listitem>Playing, stopped, et cetera.
2367 <option>mpd_title</option>
2369 <option>(max length)</option>
2371 <listitem>Title of current MPD song
2377 <option>mpd_track</option>
2380 <listitem>Prints the MPD track field
2386 <option>mpd_vol</option>
2389 <listitem>MPD's volume
2395 <option>nameserver</option>
2397 <option>(index)</option>
2399 <listitem>Print a nameserver from /etc/resolv.conf. Index
2400 starts at and defaults to 0.
2406 <option>new_mails</option>
2408 <option>(mailbox)</option>
2409 <option>(interval)</option>
2411 <listitem>Unread mail count in the specified mailbox or
2412 mail spool if not. Both mbox and maildir type mailboxes are
2419 <option>nodename</option>
2428 <option>nvidia</option>
2430 <option>threshold</option>
2431 <option>temp</option>
2432 <option>ambient</option>
2433 <option>gpufreq</option>
2434 <option>memfreq</option>
2435 <option>imagequality</option>
2437 <listitem>Nvidia graficcard support for the XNVCtrl
2438 library. Each option can be shortened to the least
2439 significant part. Temperatures are printed as float, all
2440 other values as integer.
2443 <command>threshold</command>
2444 <option>The thresholdtemperature at
2445 which the gpu slows down</option>
2448 <command>temp</command>
2449 <option>Gives the gpu current
2450 temperature</option>
2453 <command>ambient</command>
2454 <option>Gives current air temperature near GPU
2458 <command>gpufreq</command>
2459 <option>Gives the current gpu frequency</option>
2462 <command>memfreq</command>
2463 <option>Gives the current mem frequency</option>
2466 <command>imagequality</command>
2467 <option>Which imagequality should be chosen by
2468 OpenGL applications</option>
2476 <option>offset</option>
2478 <option>(pixels)</option>
2480 <listitem>Move text over by N pixels. See also $voffset.
2486 <option>outlinecolor</option>
2488 <option>(color)</option>
2490 <listitem>Change outline color
2496 <option>pb_battery</option>
2498 <option>item</option>
2500 <listitem>If running on Apple powerbook/ibook, display
2501 information on battery status. The item parameter
2502 specifies, what information to display. Exactly one item
2503 must be specified. Valid items are:
2506 <command>status</command>
2507 <option>Display if battery is fully charged,
2508 charging, discharging or absent (running on
2512 <command>percent</command>
2513 <option>Display charge of battery in percent, if
2514 charging or discharging. Nothing will be displayed,
2515 if battery is fully charged or absent.</option>
2518 <command>time</command>
2519 <option>Display the time remaining until the
2520 battery will be fully charged or discharged at
2521 current rate. Nothing is displayed, if battery is
2522 absent or if it's present but fully charged and not
2523 discharging.</option>
2531 <option>pid_chroot</option>
2533 <option>pid</option>
2535 <listitem>Directory used as rootdirectory by the process
2536 (this will be "/" unless the process did a chroot syscall)
2542 <option>pid_cmdline</option>
2544 <option>pid</option>
2546 <listitem>Command line this process was invoked with
2552 <option>pid_cwd</option>
2554 <option>pid</option>
2556 <listitem>Current working directory of the process
2562 <option>pid_environ</option>
2564 <option>pid varname</option>
2566 <listitem>Contents of a environment-var of the process
2572 <option>pid_environ_list</option>
2574 <option>pid</option>
2576 <listitem>List of environment-vars that the process can see
2582 <option>pid_exe</option>
2584 <option>pid</option>
2586 <listitem>Path to executed command that started the process
2592 <option>pid_nice</option>
2594 <option>pid</option>
2596 <listitem>The nice value of the process
2602 <option>pid_openfiles</option>
2604 <option>pid</option>
2606 <listitem>List of files that the process has open
2612 <option>pid_parent</option>
2614 <option>pid</option>
2616 <listitem>The pid of the parent of the process
2622 <option>pid_priority</option>
2624 <option>pid</option>
2626 <listitem>The priority of the process (see 'priority' in "man 5 proc")
2632 <option>pid_read</option>
2634 <option>pid</option>
2636 <listitem>Total number of bytes read by the process
2642 <option>pid_state</option>
2644 <option>pid</option>
2646 <listitem>State of the process
2652 <option>pid_state_short</option>
2654 <option>pid</option>
2656 <listitem>One of the chars in "RSDZTW" representing the state
2657 of the process where R is running, S is sleeping in an
2658 interruptible wait, D is waiting in uninterruptible disk sleep,
2659 Z is zombie, T is traced or stopped (on a signal), and W is paging
2665 <option>pid_stderr</option>
2667 <option>pid</option>
2669 <listitem>Filedescriptor binded to the STDERR of the process
2675 <option>pid_stdin</option>
2677 <option>pid</option>
2679 <listitem>Filedescriptor binded to the STDIN of the process
2685 <option>pid_stdout</option>
2687 <option>pid</option>
2689 <listitem>Filedescriptor binded to the STDOUT of the process
2695 <option>pid_threads</option>
2697 <option>pid</option>
2699 <listitem>Number of threads in process containing this thread
2705 <option>pid_thread_list</option>
2707 <option>pid</option>
2709 <listitem>List with pid's from threads from this process
2715 <option>pid_time_kernelmode</option>
2717 <option>pid</option>
2719 <listitem>Amount of time that the process has been scheduled in kernel mode in seconds
2725 <option>pid_time_usermode</option>
2727 <option>pid</option>
2729 <listitem>Amount of time that the process has been scheduled in user mode in seconds
2735 <option>pid_time</option>
2737 <option>pid</option>
2739 <listitem>Sum of $pid_time_kernelmode and $pid_time_usermode
2745 <option>pid_uid</option>
2747 <option>pid</option>
2749 <listitem>The real uid of the process
2755 <option>pid_euid</option>
2757 <option>pid</option>
2759 <listitem>The effective uid of the process
2765 <option>pid_suid</option>
2767 <option>pid</option>
2769 <listitem>The saved set uid of the process
2775 <option>pid_fsuid</option>
2777 <option>pid</option>
2779 <listitem>The file system uid of the process
2785 <option>pid_gid</option>
2787 <option>pid</option>
2789 <listitem>The real gid of the process
2795 <option>pid_egid</option>
2797 <option>pid</option>
2799 <listitem>The effective gid of the process
2805 <option>pid_sgid</option>
2807 <option>pid</option>
2809 <listitem>The saved set gid of the process
2815 <option>pid_fsgid</option>
2817 <option>pid</option>
2819 <listitem>The file system gid of the process
2825 <option>pid_vmpeak</option>
2827 <option>pid</option>
2829 <listitem>Peak virtual memory size of the process
2835 <option>pid_vmsize</option>
2837 <option>pid</option>
2839 <listitem>Virtual memory size of the process
2845 <option>pid_vmlck</option>
2847 <option>pid</option>
2849 <listitem>Locked memory size of the process
2855 <option>pid_vmhwm</option>
2857 <option>pid</option>
2859 <listitem>Peak resident set size ("high water mark") of the process
2865 <option>pid_vmrss</option>
2867 <option>pid</option>
2869 <listitem>Resident set size of the process
2875 <option>pid_vmdata</option>
2877 <option>pid</option>
2879 <listitem>Data segment size of the process
2885 <option>pid_vmstk</option>
2887 <option>pid</option>
2889 <listitem>Stack segment size of the process
2895 <option>pid_vmexe</option>
2897 <option>pid</option>
2899 <listitem>Text segment size of the process
2905 <option>pid_vmlib</option>
2907 <option>pid</option>
2909 <listitem>Shared library code size of the process
2915 <option>pid_vmpte</option>
2917 <option>pid</option>
2919 <listitem>Page table entries size of the process
2925 <option>pid_write</option>
2927 <option>pid</option>
2929 <listitem>Total number of bytes written by the process
2935 <option>platform</option>
2937 <option>(dev) type n (factor offset)</option>
2939 <listitem>Platform sensor from sysfs (Linux 2.6). Parameter
2940 dev may be omitted if you have only one platform device.
2941 Platform type is either 'in' or 'vol' meaning voltage;
2942 'fan' meaning fan; 'temp' meaning temperature. Parameter n
2943 is number of the sensor. See /sys/bus/platform/devices/ on
2944 your local computer. The optional arguments 'factor' and
2945 'offset' allow precalculation of the raw input, which is
2946 being modified as follows: 'input = input * factor +
2947 offset'. Note that they have to be given as decimal values
2948 (i.e. contain at least one decimal place).
2954 <option>pop3_unseen</option>
2956 <option>(args)</option>
2958 <listitem>Displays the number of unseen messages in your
2959 global POP3 inbox by default. You can define individual
2960 POP3 inboxes separately by passing arguments to this
2961 object. Arguments are: "host user pass [-i interval (in
2962 seconds)] [-p port] [-e 'command'] [-r retries]". Default
2963 port is 110, default interval is 5 minutes, and default
2964 number of retries before giving up is 5. If the password is
2965 supplied as '*', you will be prompted to enter the password
2972 <option>pop3_used</option>
2974 <option>(args)</option>
2976 <listitem>Displays the amount of space (in MiB, 2^20) used
2977 in your global POP3 inbox by default. You can define
2978 individual POP3 inboxes separately by passing arguments to
2979 this object. Arguments are: "host user pass [-i interval
2980 (in seconds)] [-p port] [-e 'command'] [-r retries]". Default
2981 port is 110, default interval is 5 minutes, and default
2982 number of retries before giving up is 5. If the password is
2983 supplied as '*', you will be prompted to enter the password
2990 <option>pre_exec</option>
2992 <option>shell command</option>
2994 <listitem>Executes a shell command one time before conky
2995 displays anything and puts output as text.
3001 <option>processes</option>
3004 <listitem>Total processes (sleeping and running)
3010 <option>read_tcp</option>
3012 <option>(host) port</option>
3014 <listitem>Connects to a tcp port on a host (default is
3015 localhost), reads every char available at the moment and
3022 <option>replied_mails</option>
3024 <option>(maildir)</option>
3025 <option>(interval)</option>
3027 <listitem>Number of mails marked as replied in the
3028 specified mailbox or mail spool if not. Only maildir type
3029 mailboxes are supported, mbox type will return -1.
3035 <option>rss</option>
3037 <option>uri interval_in_minutes action (num_par
3038 (spaces_in_front))</option>
3041 <para>Download and parse RSS feeds. The interval may be
3042 a floating point value greater than 0, otherwise
3043 defaults to 15 minutes. Action may be one of the
3044 following: feed_title, item_title (with num par),
3045 item_desc (with num par) and item_titles (when using
3046 this action and spaces_in_front is given conky places
3047 that many spaces in front of each item). This object is
3048 threaded, and once a thread is created it can't be
3049 explicitly destroyed. One thread will run for each URI
3050 specified. You can use any protocol that Curl
3057 <option>running_processes</option>
3060 <listitem>Running processes (not sleeping), requires Linux
3067 <option>running_threads</option>
3070 <listitem>Number of running (runnable) threads. Linux only.
3076 <option>scroll</option>
3078 <option>length (step) text</option>
3080 <listitem>Scroll 'text' by 'step' characters showing
3081 'length' number of characters at the same time. The text
3082 may also contain variables. 'step' is optional and defaults
3083 to 1 if not set. If a var creates output on multiple lines
3084 then the lines are placed behind each other separated with
3085 a '|'-sign. If you change the textcolor inside $scroll it
3086 will automatically have it's old value back at the end of
3087 $scroll. The end and the start of text will be separated by
3088 'length' number of spaces.
3094 <option>seen_mails</option>
3096 <option>(maildir)</option>
3097 <option>(interval)</option>
3099 <listitem>Number of mails marked as seen in the specified
3100 mailbox or mail spool if not. Only maildir type mailboxes
3101 are supported, mbox type will return -1.
3107 <option>shadecolor</option>
3109 <option>(color)</option>
3111 <listitem>Change shading color
3117 <option>smapi</option>
3119 <option>(ARGS)</option>
3121 <listitem>when using smapi, display contents of the
3122 /sys/devices/platform/smapi directory. ARGS are either
3123 '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the
3124 corresponding files' content. This is a very raw method of
3125 accessing the smapi values. When available, better use one
3126 of the smapi_* variables instead.
3132 <option>smapi_bat_bar</option>
3134 <option>(INDEX),(height),(width)</option>
3136 <listitem>when using smapi, display the remaining capacity
3137 of the battery with index INDEX as a bar.
3143 <option>smapi_bat_perc</option>
3145 <option>(INDEX)</option>
3147 <listitem>when using smapi, display the remaining capacity
3148 in percent of the battery with index INDEX. This is a
3149 separate variable because it supports the 'use_spacer'
3150 configuration option.
3156 <option>smapi_bat_power</option>
3158 <option>INDEX</option>
3160 <listitem>when using smapi, display the current power of
3161 the battery with index INDEX in watt. This is a separate
3162 variable because the original read out value is being
3163 converted from mW. The sign of the output reflects charging
3164 (positive) or discharging (negative) state.
3170 <option>smapi_bat_temp</option>
3172 <option>INDEX</option>
3174 <listitem>when using smapi, display the current temperature
3175 of the battery with index INDEX in degree Celsius. This is
3176 a separate variable because the original read out value is
3177 being converted from milli degree Celsius.
3183 <option>sony_fanspeed</option>
3186 <listitem>Displays the Sony VAIO fanspeed information if
3187 sony-laptop kernel support is enabled. Linux only.
3193 <option>stippled_hr</option>
3195 <option>(space)</option>
3197 <listitem>Stippled (dashed) horizontal line
3203 <option>swap</option>
3206 <listitem>Amount of swap in use
3212 <option>swapbar</option>
3214 <option>(height),(width)</option>
3216 <listitem>Bar that shows amount of swap in use
3222 <option>swapfree</option>
3225 <listitem>Amount of free swap
3231 <option>swapmax</option>
3234 <listitem>Total amount of swap
3240 <option>swapperc</option>
3243 <listitem>Percentage of swap in use
3249 <option>sysname</option>
3252 <listitem>System name, Linux for example
3258 <option>tab</option>
3260 <option>(width, (start))</option>
3262 <listitem>Puts a tab of the specified width, starting from
3263 column 'start'. The unit is pixels for both arguments.
3269 <option>tail</option>
3271 <option>logfile lines (next_check)</option>
3273 <listitem>Displays last N lines of supplied text file. The
3274 file is checked every 'next_check' update. If next_check is
3275 not supplied, Conky defaults to 2. Max of 30 lines can be
3276 displayed, or until the text buffer is filled.
3282 <option>tcp_portmon</option>
3284 <option>port_begin port_end item (index)</option>
3287 <para>TCP port (both IPv6 and IPv4) monitor for
3288 specified local ports. Port numbers must be in
3289 the range 1 to 65535. Valid items are:</para>
3292 <command>count</command>
3293 <option>Total number of connections in the
3297 <command>rip</command>
3298 <option>Remote ip address</option>
3301 <command>rhost</command>
3302 <option>Remote host name</option>
3305 <command>rport</command>
3306 <option>Remote port number</option>
3309 <command>rservice</command>
3310 <option>Remote service name from
3311 /etc/services</option>
3314 <command>lip</command>
3315 <option>Local ip address</option>
3318 <command>lhost</command>
3319 <option>Local host name</option>
3322 <command>lport</command>
3323 <option>Local port number</option>
3326 <command>lservice</command>
3327 <option>Local service name from
3328 /etc/services</option>
3331 <para>The connection index provides you with access to
3332 each connection in the port monitor. The monitor will
3333 return information for index values from 0 to n-1
3334 connections. Values higher than n-1 are simply ignored.
3335 For the "count" item, the connection index must be
3336 omitted. It is required for all other items.</para>
3337 <para>Examples:</para>
3340 <command>${tcp_portmon 6881 6999
3342 <option>Displays the number of connections in
3343 the bittorrent port range</option>
3346 <command>${tcp_portmon 22 22 rip 0}</command>
3347 <option>Displays the remote host ip of the
3348 first sshd connection</option>
3351 <command>${tcp_portmon 22 22 rip 9}</command>
3352 <option>Displays the remote host ip of the
3353 tenth sshd connection</option>
3356 <command>${tcp_portmon 1 1024 rhost
3358 <option>Displays the remote host name of the
3359 first connection on a privileged port</option>
3362 <command>${tcp_portmon 1 1024 rport
3364 <option>Displays the remote host port of the
3365 fifth connection on a privileged port</option>
3368 <command>${tcp_portmon 1 65535 lservice
3370 <option>Displays the local service name of the
3371 fifteenth connection in the range of all
3375 <para>Note that port monitor variables which share the
3376 same port range actually refer to the same monitor, so
3377 many references to a single port range for different
3378 items and different indexes all use the same monitor
3379 internally. In other words, the program avoids creating
3380 redundant monitors.</para>
3386 <option>templateN</option>
3388 <option>(arg1)</option>
3389 <option>(arg2)</option>
3390 <option>(arg3 ...)</option>
3393 <para>Evaluate the content of the templateN
3394 configuration variable (where N is a value between 0
3395 and 9, inclusively), applying substitutions as
3396 described in the documentation of the corresponding
3397 configuration variable. The number of arguments is
3398 optional, but must match the highest referred index in
3399 the template. You can use the same special sequences in
3400 each argument as the ones valid for a template
3401 definition, e.g. to allow an argument to contain a
3402 whitespace. Also simple nesting of templates is
3403 possible this way.</para>
3404 <para>Here are some examples of template
3407 <member>template0 $\1\2</member>
3408 <member>template1 \1: ${fs_used \2} / ${fs_size
3410 <member>template2 \1 \2</member>
3412 <para>The following list shows sample usage of the
3413 templates defined above, with the equivalent syntax
3414 when not using any template at all:</para>
3419 <entry>using template</entry>
3420 <entry>same without template</entry>
3425 <entry>${template0 node name}</entry>
3426 <entry>$nodename</entry>
3429 <entry>${template1 root /}</entry>
3430 <entry>root: ${fs_free /} / ${fs_size
3436 ${template2\ disk\ root}
3441 ${fs_free /} / ${fs_size
3453 <option>texeci</option>
3455 <option>interval command</option>
3457 <listitem>Runs a command at an interval inside a thread and
3458 displays the output. Same as $execi, except the command is
3459 run inside a thread. Use this if you have a slow script to
3460 keep Conky updating. You should make the interval slightly
3461 longer then the time it takes your script to execute. For
3462 example, if you have a script that take 5 seconds to
3463 execute, you should make the interval at least 6 seconds.
3464 See also $execi. This object will clean up the thread when
3465 it is destroyed, so it can safely be used in a nested
3466 fashion, though it may not produce the desired behaviour if
3473 <option>threads</option>
3476 <listitem>Total threads
3482 <option>time</option>
3484 <option>(format)</option>
3486 <listitem>Local time, see man strftime to get more
3487 information about format
3493 <option>to_bytes</option>
3495 <option>size</option>
3497 <listitem>If 'size' is a number followed by a size-unit
3498 (kilobyte,mb,GiB,...) then it converts the size to bytes
3499 and shows it without unit, otherwise it just shows 'size'.
3505 <option>top</option>
3507 <option>type num</option>
3509 <listitem>This takes arguments in the form:top (name)
3510 (number) Basically, processes are ranked from highest to
3511 lowest in terms of cpu usage, which is what (num)
3512 represents. The types are: "name", "pid", "cpu", "mem",
3513 "mem_res", "mem_vsize", "time", "io_perc", "io_read" and
3514 "io_write". There can be a max of 10 processes listed.
3520 <option>top_io</option>
3522 <option>type num</option>
3524 <listitem>Same as top, except sorted by the amount of I/O
3525 the process has done during the update interval
3531 <option>top_mem</option>
3533 <option>type num</option>
3535 <listitem>Same as top, except sorted by mem usage instead
3542 <option>top_time</option>
3544 <option>type num</option>
3546 <listitem>Same as top, except sorted by total CPU time
3547 instead of current CPU usage
3553 <option>totaldown</option>
3555 <option>(net)</option>
3557 <listitem>Total download, overflows at 4 GB on Linux with
3558 32-bit arch and there doesn't seem to be a way to know how
3559 many times it has already done that before conky has
3566 <option>totalup</option>
3568 <option>(net)</option>
3570 <listitem>Total upload, this one too, may overflow
3576 <option>trashed_mails</option>
3578 <option>(maildir)</option>
3579 <option>(interval)</option>
3581 <listitem>Number of mails marked as trashed in the
3582 specified mailbox or mail spool if not. Only maildir type
3583 mailboxes are supported, mbox type will return -1.
3589 <option>tztime</option>
3591 <option>(timezone (format))</option>
3593 <listitem>Local time for specified timezone, see man
3594 strftime to get more information about format. The timezone
3595 argument is specified in similar fashion as TZ environment
3596 variable. For hints, look in /usr/share/zoneinfo. e.g.
3597 US/Pacific, Europe/Zurich, etc.
3603 <option>gid_name</option>
3605 <option>gid</option>
3607 <listitem>Name of group with this gid
3613 <option>uid_name</option>
3615 <option>uid</option>
3617 <listitem>Username of user with this uid
3623 <option>unflagged_mails</option>
3625 <option>(maildir)</option>
3626 <option>(interval)</option>
3628 <listitem>Number of mails not marked as flagged in the
3629 specified mailbox or mail spool if not. Only maildir type
3630 mailboxes are supported, mbox type will return -1.
3636 <option>unforwarded_mails</option>
3638 <option>(maildir)</option>
3639 <option>(interval)</option>
3641 <listitem>Number of mails not marked as forwarded in the
3642 specified mailbox or mail spool if not. Only maildir type
3643 mailboxes are supported, mbox type will return -1.
3649 <option>unreplied_mails</option>
3651 <option>(maildir)</option>
3652 <option>(interval)</option>
3654 <listitem>Number of mails not marked as replied in the
3655 specified mailbox or mail spool if not. Only maildir type
3656 mailboxes are supported, mbox type will return -1.
3662 <option>unseen_mails</option>
3664 <option>(maildir)</option>
3665 <option>(interval)</option>
3667 <listitem>Number of new or unseen mails in the specified
3668 mailbox or mail spool if not. Only maildir type mailboxes
3669 are supported, mbox type will return -1.
3675 <option>updates</option>
3677 <option>Number of updates</option>
3679 <listitem>for debugging
3685 <option>upspeed</option>
3687 <option>(net)</option>
3689 <listitem>Upload speed in suitable IEC units
3695 <option>upspeedf</option>
3697 <option>(net)</option>
3699 <listitem>Upload speed in KiB with one decimal
3705 <option>upspeedgraph</option>
3707 <option>(netdev) (height),(width) (gradient colour 1)
3708 (gradient colour 2) (scale) (-t) (-l)</option>
3710 <listitem>Upload speed graph, colours defined in hex, minus
3711 the #. If scale is non-zero, it becomes the scale for the
3712 graph. Uses a logarithmic scale (to see small numbers) when
3713 you use the -l switch. Takes the switch '-t' to use a
3714 temperature gradient, which makes the gradient values
3715 change depending on the amplitude of a particular graph
3716 value (try it and see).
3722 <option>uptime</option>
3731 <option>uptime_short</option>
3734 <listitem>Uptime in a shorter format
3740 <option>user_names</option>
3743 <listitem>Lists the names of the users logged in
3749 <option>user_number</option>
3752 <listitem>Number of users logged in
3758 <option>user_terms</option>
3761 <listitem>Lists the consoles in use
3767 <option>user_times</option>
3770 <listitem>Lists how long users have been logged in for
3776 <option>user_time</option>
3778 <option>console</option>
3780 <listitem>Lists how long the user for the given console has been
3787 <option>utime</option>
3789 <option>(format)</option>
3791 <listitem>Display time in UTC (universal coordinate time).
3797 <option>voffset</option>
3799 <option>(pixels)</option>
3801 <listitem>Change vertical offset by N pixels. Negative
3802 values will cause text to overlap. See also $offset.
3808 <option>voltage_mv</option>
3810 <option>(n)</option>
3812 <listitem>Returns CPU #n's voltage in mV. CPUs are counted
3813 from 1. If omitted, the parameter defaults to 1.
3819 <option>voltage_v</option>
3821 <option>(n)</option>
3823 <listitem>Returns CPU #n's voltage in V. CPUs are counted
3824 from 1. If omitted, the parameter defaults to 1.
3830 <option>weather</option>
3832 <option>URI locID data_type
3833 (interval_in_minutes)</option>
3836 <para>Download, parse and display METAR data.</para>
3837 <para>For the 'URI', there are two
3838 possibilities:</para>
3841 http://weather.noaa.gov/pub/data/observations/metar/stations/</member>
3843 http://xoap.weather.com/weather/local/</member>
3845 <para>The first one is free to use but the second
3846 requires you to register and obtain your partner ID and
3847 license key. These two must be written, separated by a
3848 space, into a file called .xoaprc which needs to be
3849 placed into your home directory.</para>
3850 <para>'locID' must be a valid location identifier for
3851 the required uri. For the NOAA site this must be a
3852 valid ICAO (see for instance
3853 https://pilotweb.nas.faa.gov/qryhtml/icao/). For the
3854 weather.com site this must be a valid location ID (see
3856 http://aspnetresources.com/tools/locid.aspx).</para>
3857 <para>'data_type' must be one of the following:</para>
3860 <command>last_update</command>
3861 <para>The date and time stamp of the data.
3862 The result depends on the URI used. For the
3863 NOAA site it is date (yyyy/mm/dd) and UTC time.
3864 For the weather.com one it is date
3865 ([m]m/[d]d/yy) and Local Time of the
3869 <command>temperature</command>
3870 <para>Air temperature (you can use the
3871 'temperature_unit' config setting to change
3875 <command>cloud_cover</command>
3876 <para>The highest cloud cover status</para>
3879 <command>pressure</command>
3880 <para>Air pressure in millibar</para>
3883 <command>wind_speed</command>
3884 <para>Wind speed in km/h</para>
3887 <command>wind_dir</command>
3888 <para>Wind direction</para>
3891 <command>wind_dir_DEG</command>
3892 <para>Compass wind direction</para>
3895 <command>humidity</command>
3896 <para>Relative humidity in %</para>
3899 <command>weather</command>
3900 <para>Any relevant weather event (rain, snow,
3901 etc.). This is not used if you are querying the
3902 weather.com site since this data is aggregated
3903 into the cloud_cover one</para>
3906 <command>icon</command>
3907 <para>Weather icon (only for
3908 www.weather.com). Can be used together with the
3909 icon kit provided upon registering to their
3913 <para>'delay_in_minutes' (optional, default 30) cannot
3914 be less than 30 minutes.</para>
3915 <para>This object is threaded, and once a thread is
3916 created it can't be explicitly destroyed. One thread
3917 will run for each URI specified.</para>
3918 <para>Note that these variables are still EXPERIMENTAL
3919 and can be subject to many future changes.</para>
3925 <option>weather_forecast</option>
3927 <option>URI locID day data_type
3928 (interval_in_minutes)</option>
3931 <para>Download, parse and display weather forecast data
3932 for a given day (daytime only).</para>
3933 <para>For the 'URI', for the time being only
3934 http://xoap.weather.com/weather/local/ is
3935 supported. See 'weather' above for details of usage</para>
3936 <para>'locID', see 'weather' above.</para>
3937 <para>'day' is a number from 0 (today) to 4 (3 days
3938 after tomorrow).</para>
3939 <para>'data_type' must be one of the following:</para>
3942 <command>day</command>
3943 <option>Day of the week</option>
3946 <command>date</command>
3947 <option>Date, in the form MMM DD (ie. Jul 14)</option>
3950 <command>low</command>
3951 <option>Minimun temperature (you can use the
3952 'temperature_unit' config setting to change
3956 <command>hi</command>
3957 <option>Maximum temperature (you can use the
3958 'temperature_unit' config setting to change
3962 <command>icon</command>
3963 <option>Weather icon. Can be used together with the
3964 icon kit provided upon registering to the weather.com
3968 <command>forecast</command>
3969 <option>Weather forecast (sunny, rainy, etc.)</option>
3972 <command>wind_speed</command>
3973 <option>Wind speed in km/h</option>
3976 <command>wind_dir</command>
3977 <option>Wind direction</option>
3980 <command>wind_dir_DEG</command>
3981 <option>Compass wind direction</option>
3984 <command>humidity</command>
3985 <option>Relative humidity in %</option>
3988 <command>precipitation</command>
3989 <option>Probability of having a
3990 precipitation (in %)</option>
3993 <para>'delay_in_minutes' (optional, default 210) cannot
3994 be lower than 210 min.</para>
3995 <para>This object is threaded, and once a thread is
3996 created it can't be explicitly destroyed. One thread
3997 will run for each URI specified. You can use any
3998 protocol that Curl supports.</para>
3999 <para>Note that these variables are still EXPERIMENTAL
4000 and can be subject to many future changes.</para>
4006 <option>wireless_ap</option>
4008 <option>(net)</option>
4010 <listitem>Wireless access point MAC address (Linux only)
4016 <option>wireless_bitrate</option>
4018 <option>(net)</option>
4020 <listitem>Wireless bitrate (ie 11 Mb/s) (Linux only)
4026 <option>wireless_essid</option>
4028 <option>(net)</option>
4030 <listitem>Wireless access point ESSID (Linux only)
4036 <option>wireless_link_bar</option>
4038 <option>(height),(width) (net)</option>
4040 <listitem>Wireless link quality bar (Linux only)
4046 <option>wireless_link_qual</option>
4048 <option>(net)</option>
4050 <listitem>Wireless link quality (Linux only)
4056 <option>wireless_link_qual_max</option>
4058 <option>(net)</option>
4060 <listitem>Wireless link quality maximum value (Linux only)
4066 <option>wireless_link_qual_perc</option>
4068 <option>(net)</option>
4070 <listitem>Wireless link quality in percents (Linux only)
4076 <option>wireless_mode</option>
4078 <option>(net)</option>
4080 <listitem>Wireless mode (Managed/Ad-Hoc/Master) (Linux
4087 <option>words</option>
4089 <option>textfile</option>
4091 <listitem>Displays the number of words in the given file
4097 <option>xmms2_album</option>
4100 <listitem>Album in current XMMS2 song
4106 <option>xmms2_artist</option>
4109 <listitem>Artist in current XMMS2 song
4115 <option>xmms2_bar</option>
4117 <option>(height),(width)</option>
4119 <listitem>Bar of XMMS2's progress
4125 <option>xmms2_bitrate</option>
4128 <listitem>Bitrate of current song
4134 <option>xmms2_comment</option>
4137 <listitem>Comment in current XMMS2 song
4143 <option>xmms2_date</option>
4146 <listitem>Returns song's date.
4152 <option>xmms2_duration</option>
4155 <listitem>Duration of current song
4161 <option>xmms2_elapsed</option>
4164 <listitem>Song's elapsed time
4170 <option>xmms2_genre</option>
4173 <listitem>Genre in current XMMS2 song
4179 <option>xmms2_id</option>
4182 <listitem>XMMS2 id of current song
4188 <option>xmms2_percent</option>
4191 <listitem>Percent of song's progress
4197 <option>xmms2_playlist</option>
4200 <listitem>Returns the XMMS2 playlist.
4206 <option>xmms2_size</option>
4209 <listitem>Size of current song
4215 <option>xmms2_smart</option>
4218 <listitem>Prints the song name in either the form "artist -
4219 title" or file name, depending on whats available
4225 <option>xmms2_status</option>
4228 <listitem>XMMS2 status (Playing, Paused, Stopped, or
4235 <option>xmms2_timesplayed</option>
4238 <listitem>Number of times a song was played (presumably).
4244 <option>xmms2_title</option>
4247 <listitem>Title in current XMMS2 song
4253 <option>xmms2_tracknr</option>
4256 <listitem>Track number in current XMMS2 song
4262 <option>xmms2_url</option>
4265 <listitem>Full path to current song