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 (tries "AC"
11 and "ADP1" if there is no argument given). Non-linux 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 marks (")</member>
1604 </simplelist>Valid operands are: '>', '<', '>=',
1605 '<=', '==', '!='.
1611 <option>if_mixer_mute</option>
1613 <option>(mixer)</option>
1615 <listitem>If mixer exists, display everything between
1616 $if_mixer_mute and the matching $endif. If no mixer is
1617 specified, "Master" is used.
1623 <option>if_mounted</option>
1625 <option>(mountpoint)</option>
1627 <listitem>if MOUNTPOINT is mounted, display everything
1628 between $if_mounted and the matching $endif
1634 <option>if_mpd_playing</option>
1637 <listitem>if mpd is playing or paused, display everything
1638 between $if_mpd_playing and the matching $endif
1644 <option>if_running</option>
1646 <option>(process)</option>
1648 <listitem>if PROCESS is running, display everything
1649 $if_running and the matching $endif. This uses the
1650 ``pidof'' command, so the -x switch is also supported.
1656 <option>if_smapi_bat_installed</option>
1658 <option>(INDEX)</option>
1660 <listitem>when using smapi, if the battery with index INDEX
1661 is installed, display everything between
1662 $if_smapi_bat_installed and the matching $endif
1668 <option>if_up</option>
1670 <option>(interface)</option>
1672 <listitem>if INTERFACE exists and is up, display everything
1673 between $if_up and the matching $endif
1679 <option>if_updatenr</option>
1681 <option>(updatenr)</option>
1683 <listitem>If it's the UPDATENR-th time that conky updates,
1684 display everything between $if_updatenr and the matching
1685 $endif. The counter resets when the highest UPDATENR is
1686 reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr
1687 2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the
1688 time followed by bar 25% of the time followed by nothing
1689 the other half of the time.
1695 <option>if_xmms2_connected</option>
1698 <listitem>Display everything between $if_xmms2_connected
1699 and the matching $endif if xmms2 is running.
1705 <option>image</option>
1707 <option><path to image> (-p x,y) (-s WxH) (-n)
1708 (-f interval)</option>
1710 <listitem>Renders an image from the path specified using
1711 Imlib2. Takes 4 optional arguments: a position, a size, a
1712 no-cache switch, and a cache flush interval. Changing the
1713 x,y position will move the position of the image, and
1714 changing the WxH will scale the image. If you specify the
1715 no-cache flag (-n), the image will not be cached.
1716 Alternately, you can specify the -f int switch to specify a
1717 cache flust interval for a particular image. Example:
1718 ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200}
1719 will render 'cheeseburger.jpg' at (20,20) scaled to 200x200
1720 pixels. Conky does not make any attempt to adjust the
1721 position (or any other formatting) of images, they are just
1722 rendered as per the arguments passed. The only reason
1723 $image is part of the TEXT section, is to allow for runtime
1724 modifications, through $execp $lua_parse, or some other
1731 <option>imap_messages</option>
1733 <option>(args)</option>
1735 <listitem>Displays the number of messages in your global
1736 IMAP inbox by default. You can define individual IMAP
1737 inboxes separately by passing arguments to this object.
1738 Arguments are: "host user pass [-i interval (in seconds)]
1739 [-f 'folder'] [-p port] [-e 'command'] [-r retries]". Default
1740 port is 143, default folder is 'INBOX', default interval is
1741 5 minutes, and default number of retries before giving up
1742 is 5. If the password is supplied as '*', you will be
1743 prompted to enter the password when Conky starts.
1749 <option>imap_unseen</option>
1751 <option>(args)</option>
1753 <listitem>Displays the number of unseen messages in your
1754 global IMAP inbox by default. You can define individual
1755 IMAP inboxes separately by passing arguments to this
1756 object. Arguments are: "host user pass [-i interval (in
1757 seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r retries]".
1758 Default port is 143, default folder is 'INBOX', default
1759 interval is 5 minutes, and default number of retries before
1760 giving up is 5. If the password is supplied as '*', you
1761 will be prompted to enter the password when Conky starts.
1767 <option>include</option>
1769 <option>path</option>
1772 <para>Loads the configfile at path, places the
1773 configsettings behind the configsettings in the orginal
1774 config and places the vars where the includevar
1781 <option>ioscheduler</option>
1783 <option>disk</option>
1785 <listitem>Prints the current ioscheduler used for the given
1786 disk name (i.e. e.g. "hda" or "sdb")
1792 <option>kernel</option>
1795 <listitem>Kernel version
1801 <option>laptop_mode</option>
1804 <listitem>The value of /proc/sys/vm/laptop_mode
1810 <option>lines</option>
1812 <option>textfile</option>
1814 <listitem>Displays the number of lines in the given file
1820 <option>loadavg</option>
1822 <option>(1|2|3)</option>
1824 <listitem>System load average, 1 is for past 1 minute, 2
1825 for past 5 minutes and 3 for past 15 minutes. Without argument, prints
1826 all three values separated by whitespace.
1832 <option>loadgraph</option>
1834 <option>(height),(width) (gradient colour 1)
1835 (gradient colour 2) (scale) (-t) (-l)</option>
1837 <listitem>Load1 average graph, similar to xload, with
1838 optional colours in hex, minus the #. Uses a logarithmic
1839 scale (to see small numbers) when you use the -l switch.
1840 Takes the switch '-t' to use a temperature gradient, which
1841 makes the gradient values change depending on the amplitude
1842 of a particular graph value (try it and see).
1848 <option>lua</option>
1850 <option>function_name (function parameters)</option>
1852 <listitem>Executes a Lua function with given parameters,
1853 then prints the returned string. See also 'lua_load' on how
1854 to load scripts. Conky puts 'conky_' in front of
1855 function_name to prevent accidental calls to the wrong
1856 function unless you put you place 'conky_' in front of it
1863 <option>lua_bar</option>
1865 <option>(height, width) function_name (function
1866 parameters)</option>
1868 <listitem>Executes a Lua function with given parameters and
1869 draws a bar. Expects result value to be an integer between
1870 0 and 100. See also 'lua_load' on how to load scripts.
1871 Conky puts 'conky_' in front of function_name to prevent
1872 accidental calls to the wrong function unless you put you
1873 place 'conky_' in front of it yourself.
1879 <option>lua_gauge</option>
1881 <option>(height, width) function_name (function
1882 parameters)</option>
1884 <listitem>Executes a Lua function with given parameters and
1885 draws a gauge. Expects result value to be an integer
1886 between 0 and 100. See also 'lua_load' on how to load
1887 scripts. Conky puts 'conky_' in front of function_name to
1888 prevent accidental calls to the wrong function unless you
1889 put you place 'conky_' in front of it yourself.
1895 <option>lua_graph</option>
1897 <option>function_name (height),(width) (gradient colour
1898 1) (gradient colour 2) (scale) (-t) (-l)</option>
1900 <listitem>Executes a Lua function with and draws a graph.
1901 Expects result value to be any number, and by default will
1902 scale to show the full range. See also 'lua_load' on how to
1903 load scripts. Takes the switch '-t' to use a temperature
1904 gradient, which makes the gradient values change depending
1905 on the amplitude of a particular graph value (try it and
1906 see). Conky puts 'conky_' in front of function_name to
1907 prevent accidental calls to the wrong function unless you
1908 put you place 'conky_' in front of it yourself.
1914 <option>lua_parse</option>
1916 <option>function_name (function parameters)</option>
1918 <listitem>Executes a Lua function with given parameters as
1919 per $lua, then parses and prints the result value as per
1920 the syntax for Conky's TEXT section. See also 'lua_load' on
1921 how to load scripts. Conky puts 'conky_' in front of
1922 function_name to prevent accidental calls to the wrong
1923 function unless you put you place 'conky_' in front of it
1930 <option>machine</option>
1933 <listitem>Machine, i686 for example
1939 <option>mails</option>
1941 <option>(mailbox)</option>
1942 <option>(interval)</option>
1944 <listitem>Mail count in the specified mailbox or your mail
1945 spool if not. Both mbox and maildir type mailboxes are
1946 supported. You can use a program like fetchmail to get
1947 mails from some server using your favourite protocol. See
1954 <option>mboxscan</option>
1956 <option>(-n number of messages to print) (-fw from
1957 width) (-sw subject width) mbox</option>
1959 <listitem>Print a summary of recent messages in an mbox
1960 format mailbox. mbox parameter is the filename of the
1961 mailbox (can be encapsulated using '"', ie. ${mboxscan -n
1962 10 "/home/brenden/some box"}
1968 <option>mem</option>
1971 <listitem>Amount of memory in use
1977 <option>membar</option>
1979 <option>(height),(width)</option>
1981 <listitem>Bar that shows amount of memory in use
1987 <option>memeasyfree</option>
1990 <listitem>Amount of free memory including the memory that
1991 is very easily freed (buffers/cache)
1997 <option>memfree</option>
2000 <listitem>Amount of free memory
2006 <option>memgauge</option>
2008 <option>(height),(width)</option>
2010 <listitem>Gauge that shows amount of memory in use (see
2017 <option>memgraph</option>
2019 <option>(height),(width) (gradient colour 1) (gradient
2020 colour 2) (scale) (-t) (-l)</option>
2022 <listitem>Memory usage graph. Uses a logarithmic scale (to
2023 see small numbers) when you use the -l switch. Takes the
2024 switch '-t' to use a temperature gradient, which makes the
2025 gradient values change depending on the amplitude of a
2026 particular graph value (try it and see).
2032 <option>memmax</option>
2035 <listitem>Total amount of memory
2041 <option>memperc</option>
2044 <listitem>Percentage of memory in use
2050 <option>mixer</option>
2052 <option>(device)</option>
2054 <listitem>Prints the mixer value as reported by the OS.
2055 Default mixer is "Master", but you can specify one of the
2056 available ALSA Simple mixer controls.
2057 You can find the list of those available on your system
2064 <option>mixerbar</option>
2066 <option>(device)</option>
2068 <listitem>Displays mixer value in a bar as reported by the
2069 OS. See docs for $mixer for details on arguments.
2075 <option>mixerl</option>
2077 <option>(device)</option>
2079 <listitem>Prints the left channel mixer value as reported
2080 by the OS. See docs for $mixer for details on arguments.
2086 <option>mixerlbar</option>
2088 <option>(device)</option>
2090 <listitem>Displays the left channel mixer value in a bar as
2091 reported by the OS. See docs for $mixer for details on
2098 <option>mixerr</option>
2100 <option>(device)</option>
2102 <listitem>Prints the right channel mixer value as reported
2103 by the OS. See docs for $mixer for details on arguments.
2109 <option>mixerrbar</option>
2111 <option>(device)</option>
2113 <listitem>Displays the right channel mixer value in a bar
2114 as reported by the OS. See docs for $mixer for details on
2121 <option>moc_album</option>
2124 <listitem>Album of the current MOC song
2130 <option>moc_artist</option>
2133 <listitem>Artist of the current MOC song
2139 <option>moc_bitrate</option>
2142 <listitem>Bitrate in the current MOC song
2148 <option>moc_curtime</option>
2151 <listitem>Current time of the current MOC song
2157 <option>moc_file</option>
2160 <listitem>File name of the current MOC song
2166 <option>moc_rate</option>
2169 <listitem>Rate of the current MOC song
2175 <option>moc_song</option>
2178 <listitem>The current song name being played in MOC.
2184 <option>moc_state</option>
2187 <listitem>Current state of MOC; playing, stopped etc.
2193 <option>moc_timeleft</option>
2196 <listitem>Time left in the current MOC song
2202 <option>moc_title</option>
2205 <listitem>Title of the current MOC song
2211 <option>moc_totaltime</option>
2214 <listitem>Total length of the current MOC song
2220 <option>monitor</option>
2223 <listitem>Number of the monitor on which conky is running
2224 or the message "Not running in X" if this is the case.
2230 <option>monitor_number</option>
2233 <listitem>Number of monitors or the message "Not running in
2234 X" if this is the case.
2240 <option>mpd_album</option>
2243 <listitem>Album in current MPD song
2249 <option>mpd_artist</option>
2252 <listitem>Artist in current MPD song must be enabled at
2259 <option>mpd_bar</option>
2261 <option>(height),(width)</option>
2263 <listitem>Bar of mpd's progress
2269 <option>mpd_bitrate</option>
2272 <listitem>Bitrate of current song
2278 <option>mpd_elapsed</option>
2281 <listitem>Song's elapsed time
2287 <option>mpd_file</option>
2290 <listitem>Prints the file name of the current MPD song
2296 <option>mpd_length</option>
2299 <listitem>Song's length
2305 <option>mpd_name</option>
2308 <listitem>Prints the MPD name field
2314 <option>mpd_percent</option>
2317 <listitem>Percent of song's progress
2323 <option>mpd_random</option>
2326 <listitem>Random status (On/Off)
2332 <option>mpd_repeat</option>
2335 <listitem>Repeat status (On/Off)
2341 <option>mpd_smart</option>
2343 <option>(max length)</option>
2345 <listitem>Prints the song name in either the form "artist -
2346 title" or file name, depending on whats available
2352 <option>mpd_status</option>
2355 <listitem>Playing, stopped, et cetera.
2361 <option>mpd_title</option>
2363 <option>(max length)</option>
2365 <listitem>Title of current MPD song
2371 <option>mpd_track</option>
2374 <listitem>Prints the MPD track field
2380 <option>mpd_vol</option>
2383 <listitem>MPD's volume
2389 <option>nameserver</option>
2391 <option>(index)</option>
2393 <listitem>Print a nameserver from /etc/resolv.conf. Index
2394 starts at and defaults to 0.
2400 <option>new_mails</option>
2402 <option>(mailbox)</option>
2403 <option>(interval)</option>
2405 <listitem>Unread mail count in the specified mailbox or
2406 mail spool if not. Both mbox and maildir type mailboxes are
2413 <option>nodename</option>
2422 <option>nvidia</option>
2424 <option>threshold</option>
2425 <option>temp</option>
2426 <option>ambient</option>
2427 <option>gpufreq</option>
2428 <option>memfreq</option>
2429 <option>imagequality</option>
2431 <listitem>Nvidia graficcard support for the XNVCtrl
2432 library. Each option can be shortened to the least
2433 significant part. Temperatures are printed as float, all
2434 other values as integer.
2437 <command>threshold</command>
2438 <option>The thresholdtemperature at
2439 which the gpu slows down</option>
2442 <command>temp</command>
2443 <option>Gives the gpu current
2444 temperature</option>
2447 <command>ambient</command>
2448 <option>Gives current air temperature near GPU
2452 <command>gpufreq</command>
2453 <option>Gives the current gpu frequency</option>
2456 <command>memfreq</command>
2457 <option>Gives the current mem frequency</option>
2460 <command>imagequality</command>
2461 <option>Which imagequality should be chosen by
2462 OpenGL applications</option>
2470 <option>offset</option>
2472 <option>(pixels)</option>
2474 <listitem>Move text over by N pixels. See also $voffset.
2480 <option>outlinecolor</option>
2482 <option>(color)</option>
2484 <listitem>Change outline color
2490 <option>pb_battery</option>
2492 <option>item</option>
2494 <listitem>If running on Apple powerbook/ibook, display
2495 information on battery status. The item parameter
2496 specifies, what information to display. Exactly one item
2497 must be specified. Valid items are:
2500 <command>status</command>
2501 <option>Display if battery is fully charged,
2502 charging, discharging or absent (running on
2506 <command>percent</command>
2507 <option>Display charge of battery in percent, if
2508 charging or discharging. Nothing will be displayed,
2509 if battery is fully charged or absent.</option>
2512 <command>time</command>
2513 <option>Display the time remaining until the
2514 battery will be fully charged or discharged at
2515 current rate. Nothing is displayed, if battery is
2516 absent or if it's present but fully charged and not
2517 discharging.</option>
2525 <option>pid_chroot</option>
2527 <option>pid</option>
2529 <listitem>Directory used as rootdirectory by the process
2530 (this will be "/" unless the process did a chroot syscall)
2536 <option>pid_cmdline</option>
2538 <option>pid</option>
2540 <listitem>Command line this process was invoked with
2546 <option>pid_cwd</option>
2548 <option>pid</option>
2550 <listitem>Current working directory of the process
2556 <option>pid_environ</option>
2558 <option>pid varname</option>
2560 <listitem>Contents of a environment-var of the process
2566 <option>pid_environ_list</option>
2568 <option>pid</option>
2570 <listitem>List of environment-vars that the process can see
2576 <option>pid_exe</option>
2578 <option>pid</option>
2580 <listitem>Path to executed command that started the process
2586 <option>pid_nice</option>
2588 <option>pid</option>
2590 <listitem>The nice value of the process
2596 <option>pid_openfiles</option>
2598 <option>pid</option>
2600 <listitem>List of files that the process has open
2606 <option>pid_parent</option>
2608 <option>pid</option>
2610 <listitem>The pid of the parent of the process
2616 <option>pid_priority</option>
2618 <option>pid</option>
2620 <listitem>The priority of the process (see 'priority' in "man 5 proc")
2626 <option>pid_read</option>
2628 <option>pid</option>
2630 <listitem>Total number of bytes read by the process
2636 <option>pid_state</option>
2638 <option>pid</option>
2640 <listitem>State of the process
2646 <option>pid_state_short</option>
2648 <option>pid</option>
2650 <listitem>One of the chars in "RSDZTW" representing the state
2651 of the process where R is running, S is sleeping in an
2652 interruptible wait, D is waiting in uninterruptible disk sleep,
2653 Z is zombie, T is traced or stopped (on a signal), and W is paging
2659 <option>pid_stderr</option>
2661 <option>pid</option>
2663 <listitem>Filedescriptor binded to the STDERR of the process
2669 <option>pid_stdin</option>
2671 <option>pid</option>
2673 <listitem>Filedescriptor binded to the STDIN of the process
2679 <option>pid_stdout</option>
2681 <option>pid</option>
2683 <listitem>Filedescriptor binded to the STDOUT of the process
2689 <option>pid_threads</option>
2691 <option>pid</option>
2693 <listitem>Number of threads in process containing this thread
2699 <option>pid_thread_list</option>
2701 <option>pid</option>
2703 <listitem>List with pid's from threads from this process
2709 <option>pid_time_kernelmode</option>
2711 <option>pid</option>
2713 <listitem>Amount of time that the process has been scheduled in kernel mode in seconds
2719 <option>pid_time_usermode</option>
2721 <option>pid</option>
2723 <listitem>Amount of time that the process has been scheduled in user mode in seconds
2729 <option>pid_time</option>
2731 <option>pid</option>
2733 <listitem>Sum of $pid_time_kernelmode and $pid_time_usermode
2739 <option>pid_uid</option>
2741 <option>pid</option>
2743 <listitem>The real uid of the process
2749 <option>pid_euid</option>
2751 <option>pid</option>
2753 <listitem>The effective uid of the process
2759 <option>pid_suid</option>
2761 <option>pid</option>
2763 <listitem>The saved set uid of the process
2769 <option>pid_fsuid</option>
2771 <option>pid</option>
2773 <listitem>The file system uid of the process
2779 <option>pid_gid</option>
2781 <option>pid</option>
2783 <listitem>The real gid of the process
2789 <option>pid_egid</option>
2791 <option>pid</option>
2793 <listitem>The effective gid of the process
2799 <option>pid_sgid</option>
2801 <option>pid</option>
2803 <listitem>The saved set gid of the process
2809 <option>pid_fsgid</option>
2811 <option>pid</option>
2813 <listitem>The file system gid of the process
2819 <option>pid_vmpeak</option>
2821 <option>pid</option>
2823 <listitem>Peak virtual memory size of the process
2829 <option>pid_vmsize</option>
2831 <option>pid</option>
2833 <listitem>Virtual memory size of the process
2839 <option>pid_vmlck</option>
2841 <option>pid</option>
2843 <listitem>Locked memory size of the process
2849 <option>pid_vmhwm</option>
2851 <option>pid</option>
2853 <listitem>Peak resident set size ("high water mark") of the process
2859 <option>pid_vmrss</option>
2861 <option>pid</option>
2863 <listitem>Resident set size of the process
2869 <option>pid_vmdata</option>
2871 <option>pid</option>
2873 <listitem>Data segment size of the process
2879 <option>pid_vmstk</option>
2881 <option>pid</option>
2883 <listitem>Stack segment size of the process
2889 <option>pid_vmexe</option>
2891 <option>pid</option>
2893 <listitem>Text segment size of the process
2899 <option>pid_vmlib</option>
2901 <option>pid</option>
2903 <listitem>Shared library code size of the process
2909 <option>pid_vmpte</option>
2911 <option>pid</option>
2913 <listitem>Page table entries size of the process
2919 <option>pid_write</option>
2921 <option>pid</option>
2923 <listitem>Total number of bytes written by the process
2929 <option>platform</option>
2931 <option>(dev) type n (factor offset)</option>
2933 <listitem>Platform sensor from sysfs (Linux 2.6). Parameter
2934 dev may be omitted if you have only one platform device.
2935 Platform type is either 'in' or 'vol' meaning voltage;
2936 'fan' meaning fan; 'temp' meaning temperature. Parameter n
2937 is number of the sensor. See /sys/bus/platform/devices/ on
2938 your local computer. The optional arguments 'factor' and
2939 'offset' allow precalculation of the raw input, which is
2940 being modified as follows: 'input = input * factor +
2941 offset'. Note that they have to be given as decimal values
2942 (i.e. contain at least one decimal place).
2948 <option>pop3_unseen</option>
2950 <option>(args)</option>
2952 <listitem>Displays the number of unseen messages in your
2953 global POP3 inbox by default. You can define individual
2954 POP3 inboxes separately by passing arguments to this
2955 object. Arguments are: "host user pass [-i interval (in
2956 seconds)] [-p port] [-e 'command'] [-r retries]". Default
2957 port is 110, default interval is 5 minutes, and default
2958 number of retries before giving up is 5. If the password is
2959 supplied as '*', you will be prompted to enter the password
2966 <option>pop3_used</option>
2968 <option>(args)</option>
2970 <listitem>Displays the amount of space (in MiB, 2^20) used
2971 in your global POP3 inbox by default. You can define
2972 individual POP3 inboxes separately by passing arguments to
2973 this object. Arguments are: "host user pass [-i interval
2974 (in seconds)] [-p port] [-e 'command'] [-r retries]". Default
2975 port is 110, default interval is 5 minutes, and default
2976 number of retries before giving up is 5. If the password is
2977 supplied as '*', you will be prompted to enter the password
2984 <option>pre_exec</option>
2986 <option>shell command</option>
2988 <listitem>Executes a shell command one time before conky
2989 displays anything and puts output as text.
2995 <option>processes</option>
2998 <listitem>Total processes (sleeping and running)
3004 <option>read_tcp</option>
3006 <option>(host) port</option>
3008 <listitem>Connects to a tcp port on a host (default is
3009 localhost), reads every char available at the moment and
3016 <option>replied_mails</option>
3018 <option>(maildir)</option>
3019 <option>(interval)</option>
3021 <listitem>Number of mails marked as replied in the
3022 specified mailbox or mail spool if not. Only maildir type
3023 mailboxes are supported, mbox type will return -1.
3029 <option>rss</option>
3031 <option>uri interval_in_minutes action (num_par
3032 (spaces_in_front))</option>
3035 <para>Download and parse RSS feeds. The interval may be
3036 a floating point value greater than 0, otherwise
3037 defaults to 15 minutes. Action may be one of the
3038 following: feed_title, item_title (with num par),
3039 item_desc (with num par) and item_titles (when using
3040 this action and spaces_in_front is given conky places
3041 that many spaces in front of each item). This object is
3042 threaded, and once a thread is created it can't be
3043 explicitly destroyed. One thread will run for each URI
3044 specified. You can use any protocol that Curl
3051 <option>running_processes</option>
3054 <listitem>Running processes (not sleeping), requires Linux
3061 <option>running_threads</option>
3064 <listitem>Number of running (runnable) threads. Linux only.
3070 <option>scroll</option>
3072 <option>length (step) text</option>
3074 <listitem>Scroll 'text' by 'step' characters showing
3075 'length' number of characters at the same time. The text
3076 may also contain variables. 'step' is optional and defaults
3077 to 1 if not set. If a var creates output on multiple lines
3078 then the lines are placed behind each other separated with
3079 a '|'-sign. If you change the textcolor inside $scroll it
3080 will automatically have it's old value back at the end of
3081 $scroll. The end and the start of text will be separated by
3082 'length' number of spaces.
3088 <option>seen_mails</option>
3090 <option>(maildir)</option>
3091 <option>(interval)</option>
3093 <listitem>Number of mails marked as seen in the specified
3094 mailbox or mail spool if not. Only maildir type mailboxes
3095 are supported, mbox type will return -1.
3101 <option>shadecolor</option>
3103 <option>(color)</option>
3105 <listitem>Change shading color
3111 <option>smapi</option>
3113 <option>(ARGS)</option>
3115 <listitem>when using smapi, display contents of the
3116 /sys/devices/platform/smapi directory. ARGS are either
3117 '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the
3118 corresponding files' content. This is a very raw method of
3119 accessing the smapi values. When available, better use one
3120 of the smapi_* variables instead.
3126 <option>smapi_bat_bar</option>
3128 <option>(INDEX),(height),(width)</option>
3130 <listitem>when using smapi, display the remaining capacity
3131 of the battery with index INDEX as a bar.
3137 <option>smapi_bat_perc</option>
3139 <option>(INDEX)</option>
3141 <listitem>when using smapi, display the remaining capacity
3142 in percent of the battery with index INDEX. This is a
3143 separate variable because it supports the 'use_spacer'
3144 configuration option.
3150 <option>smapi_bat_power</option>
3152 <option>INDEX</option>
3154 <listitem>when using smapi, display the current power of
3155 the battery with index INDEX in watt. This is a separate
3156 variable because the original read out value is being
3157 converted from mW. The sign of the output reflects charging
3158 (positive) or discharging (negative) state.
3164 <option>smapi_bat_temp</option>
3166 <option>INDEX</option>
3168 <listitem>when using smapi, display the current temperature
3169 of the battery with index INDEX in degree Celsius. This is
3170 a separate variable because the original read out value is
3171 being converted from milli degree Celsius.
3177 <option>sony_fanspeed</option>
3180 <listitem>Displays the Sony VAIO fanspeed information if
3181 sony-laptop kernel support is enabled. Linux only.
3187 <option>stippled_hr</option>
3189 <option>(space)</option>
3191 <listitem>Stippled (dashed) horizontal line
3197 <option>swap</option>
3200 <listitem>Amount of swap in use
3206 <option>swapbar</option>
3208 <option>(height),(width)</option>
3210 <listitem>Bar that shows amount of swap in use
3216 <option>swapfree</option>
3219 <listitem>Amount of free swap
3225 <option>swapmax</option>
3228 <listitem>Total amount of swap
3234 <option>swapperc</option>
3237 <listitem>Percentage of swap in use
3243 <option>sysname</option>
3246 <listitem>System name, Linux for example
3252 <option>tab</option>
3254 <option>(width, (start))</option>
3256 <listitem>Puts a tab of the specified width, starting from
3257 column 'start'. The unit is pixels for both arguments.
3263 <option>tail</option>
3265 <option>logfile lines (next_check)</option>
3267 <listitem>Displays last N lines of supplied text file. The
3268 file is checked every 'next_check' update. If next_check is
3269 not supplied, Conky defaults to 2. Max of 30 lines can be
3270 displayed, or until the text buffer is filled.
3276 <option>tcp_portmon</option>
3278 <option>port_begin port_end item (index)</option>
3281 <para>TCP port (both IPv6 and IPv4) monitor for
3282 specified local ports. Port numbers must be in
3283 the range 1 to 65535. Valid items are:</para>
3286 <command>count</command>
3287 <option>Total number of connections in the
3291 <command>rip</command>
3292 <option>Remote ip address</option>
3295 <command>rhost</command>
3296 <option>Remote host name</option>
3299 <command>rport</command>
3300 <option>Remote port number</option>
3303 <command>rservice</command>
3304 <option>Remote service name from
3305 /etc/services</option>
3308 <command>lip</command>
3309 <option>Local ip address</option>
3312 <command>lhost</command>
3313 <option>Local host name</option>
3316 <command>lport</command>
3317 <option>Local port number</option>
3320 <command>lservice</command>
3321 <option>Local service name from
3322 /etc/services</option>
3325 <para>The connection index provides you with access to
3326 each connection in the port monitor. The monitor will
3327 return information for index values from 0 to n-1
3328 connections. Values higher than n-1 are simply ignored.
3329 For the "count" item, the connection index must be
3330 omitted. It is required for all other items.</para>
3331 <para>Examples:</para>
3334 <command>${tcp_portmon 6881 6999
3336 <option>Displays the number of connections in
3337 the bittorrent port range</option>
3340 <command>${tcp_portmon 22 22 rip 0}</command>
3341 <option>Displays the remote host ip of the
3342 first sshd connection</option>
3345 <command>${tcp_portmon 22 22 rip 9}</command>
3346 <option>Displays the remote host ip of the
3347 tenth sshd connection</option>
3350 <command>${tcp_portmon 1 1024 rhost
3352 <option>Displays the remote host name of the
3353 first connection on a privileged port</option>
3356 <command>${tcp_portmon 1 1024 rport
3358 <option>Displays the remote host port of the
3359 fifth connection on a privileged port</option>
3362 <command>${tcp_portmon 1 65535 lservice
3364 <option>Displays the local service name of the
3365 fifteenth connection in the range of all
3369 <para>Note that port monitor variables which share the
3370 same port range actually refer to the same monitor, so
3371 many references to a single port range for different
3372 items and different indexes all use the same monitor
3373 internally. In other words, the program avoids creating
3374 redundant monitors.</para>
3380 <option>templateN</option>
3382 <option>(arg1)</option>
3383 <option>(arg2)</option>
3384 <option>(arg3 ...)</option>
3387 <para>Evaluate the content of the templateN
3388 configuration variable (where N is a value between 0
3389 and 9, inclusively), applying substitutions as
3390 described in the documentation of the corresponding
3391 configuration variable. The number of arguments is
3392 optional, but must match the highest referred index in
3393 the template. You can use the same special sequences in
3394 each argument as the ones valid for a template
3395 definition, e.g. to allow an argument to contain a
3396 whitespace. Also simple nesting of templates is
3397 possible this way.</para>
3398 <para>Here are some examples of template
3401 <member>template0 $\1\2</member>
3402 <member>template1 \1: ${fs_used \2} / ${fs_size
3404 <member>template2 \1 \2</member>
3406 <para>The following list shows sample usage of the
3407 templates defined above, with the equivalent syntax
3408 when not using any template at all:</para>
3413 <entry>using template</entry>
3414 <entry>same without template</entry>
3419 <entry>${template0 node name}</entry>
3420 <entry>$nodename</entry>
3423 <entry>${template1 root /}</entry>
3424 <entry>root: ${fs_free /} / ${fs_size
3430 ${template2\ disk\ root}
3435 ${fs_free /} / ${fs_size
3447 <option>texeci</option>
3449 <option>interval command</option>
3451 <listitem>Runs a command at an interval inside a thread and
3452 displays the output. Same as $execi, except the command is
3453 run inside a thread. Use this if you have a slow script to
3454 keep Conky updating. You should make the interval slightly
3455 longer then the time it takes your script to execute. For
3456 example, if you have a script that take 5 seconds to
3457 execute, you should make the interval at least 6 seconds.
3458 See also $execi. This object will clean up the thread when
3459 it is destroyed, so it can safely be used in a nested
3460 fashion, though it may not produce the desired behaviour if
3467 <option>threads</option>
3470 <listitem>Total threads
3476 <option>time</option>
3478 <option>(format)</option>
3480 <listitem>Local time, see man strftime to get more
3481 information about format
3487 <option>to_bytes</option>
3489 <option>size</option>
3491 <listitem>If 'size' is a number followed by a size-unit
3492 (kilobyte,mb,GiB,...) then it converts the size to bytes
3493 and shows it without unit, otherwise it just shows 'size'.
3499 <option>top</option>
3501 <option>type num</option>
3503 <listitem>This takes arguments in the form:top (name)
3504 (number) Basically, processes are ranked from highest to
3505 lowest in terms of cpu usage, which is what (num)
3506 represents. The types are: "name", "pid", "cpu", "mem",
3507 "mem_res", "mem_vsize", "time", "io_perc", "io_read" and
3508 "io_write". There can be a max of 10 processes listed.
3514 <option>top_io</option>
3516 <option>type num</option>
3518 <listitem>Same as top, except sorted by the amount of I/O
3519 the process has done during the update interval
3525 <option>top_mem</option>
3527 <option>type num</option>
3529 <listitem>Same as top, except sorted by mem usage instead
3536 <option>top_time</option>
3538 <option>type num</option>
3540 <listitem>Same as top, except sorted by total CPU time
3541 instead of current CPU usage
3547 <option>totaldown</option>
3549 <option>(net)</option>
3551 <listitem>Total download, overflows at 4 GB on Linux with
3552 32-bit arch and there doesn't seem to be a way to know how
3553 many times it has already done that before conky has
3560 <option>totalup</option>
3562 <option>(net)</option>
3564 <listitem>Total upload, this one too, may overflow
3570 <option>trashed_mails</option>
3572 <option>(maildir)</option>
3573 <option>(interval)</option>
3575 <listitem>Number of mails marked as trashed in the
3576 specified mailbox or mail spool if not. Only maildir type
3577 mailboxes are supported, mbox type will return -1.
3583 <option>tztime</option>
3585 <option>(timezone (format))</option>
3587 <listitem>Local time for specified timezone, see man
3588 strftime to get more information about format. The timezone
3589 argument is specified in similar fashion as TZ environment
3590 variable. For hints, look in /usr/share/zoneinfo. e.g.
3591 US/Pacific, Europe/Zurich, etc.
3597 <option>gid_name</option>
3599 <option>gid</option>
3601 <listitem>Name of group with this gid
3607 <option>uid_name</option>
3609 <option>uid</option>
3611 <listitem>Username of user with this uid
3617 <option>unflagged_mails</option>
3619 <option>(maildir)</option>
3620 <option>(interval)</option>
3622 <listitem>Number of mails not marked as flagged in the
3623 specified mailbox or mail spool if not. Only maildir type
3624 mailboxes are supported, mbox type will return -1.
3630 <option>unforwarded_mails</option>
3632 <option>(maildir)</option>
3633 <option>(interval)</option>
3635 <listitem>Number of mails not marked as forwarded in the
3636 specified mailbox or mail spool if not. Only maildir type
3637 mailboxes are supported, mbox type will return -1.
3643 <option>unreplied_mails</option>
3645 <option>(maildir)</option>
3646 <option>(interval)</option>
3648 <listitem>Number of mails not marked as replied in the
3649 specified mailbox or mail spool if not. Only maildir type
3650 mailboxes are supported, mbox type will return -1.
3656 <option>unseen_mails</option>
3658 <option>(maildir)</option>
3659 <option>(interval)</option>
3661 <listitem>Number of new or unseen mails in the specified
3662 mailbox or mail spool if not. Only maildir type mailboxes
3663 are supported, mbox type will return -1.
3669 <option>updates</option>
3671 <option>Number of updates</option>
3673 <listitem>for debugging
3679 <option>upspeed</option>
3681 <option>(net)</option>
3683 <listitem>Upload speed in suitable IEC units
3689 <option>upspeedf</option>
3691 <option>(net)</option>
3693 <listitem>Upload speed in KiB with one decimal
3699 <option>upspeedgraph</option>
3701 <option>(netdev) (height),(width) (gradient colour 1)
3702 (gradient colour 2) (scale) (-t) (-l)</option>
3704 <listitem>Upload speed graph, colours defined in hex, minus
3705 the #. If scale is non-zero, it becomes the scale for the
3706 graph. Uses a logarithmic scale (to see small numbers) when
3707 you use the -l switch. Takes the switch '-t' to use a
3708 temperature gradient, which makes the gradient values
3709 change depending on the amplitude of a particular graph
3710 value (try it and see).
3716 <option>uptime</option>
3725 <option>uptime_short</option>
3728 <listitem>Uptime in a shorter format
3734 <option>user_names</option>
3737 <listitem>Lists the names of the users logged in
3743 <option>user_number</option>
3746 <listitem>Number of users logged in
3752 <option>user_terms</option>
3755 <listitem>Lists the consoles in use
3761 <option>user_times</option>
3764 <listitem>Lists how long users have been logged in for
3770 <option>user_time</option>
3772 <option>console</option>
3774 <listitem>Lists how long the user for the given console has been
3781 <option>utime</option>
3783 <option>(format)</option>
3785 <listitem>Display time in UTC (universal coordinate time).
3791 <option>voffset</option>
3793 <option>(pixels)</option>
3795 <listitem>Change vertical offset by N pixels. Negative
3796 values will cause text to overlap. See also $offset.
3802 <option>voltage_mv</option>
3804 <option>(n)</option>
3806 <listitem>Returns CPU #n's voltage in mV. CPUs are counted
3807 from 1. If omitted, the parameter defaults to 1.
3813 <option>voltage_v</option>
3815 <option>(n)</option>
3817 <listitem>Returns CPU #n's voltage in V. CPUs are counted
3818 from 1. If omitted, the parameter defaults to 1.
3824 <option>weather</option>
3826 <option>URI locID data_type
3827 (interval_in_minutes)</option>
3830 <para>Download, parse and display METAR data.</para>
3831 <para>For the 'URI', there are two
3832 possibilities:</para>
3835 http://weather.noaa.gov/pub/data/observations/metar/stations/</member>
3837 http://xoap.weather.com/weather/local/</member>
3839 <para>The first one is free to use but the second
3840 requires you to register and obtain your partner ID and
3841 license key. These two must be written, separated by a
3842 space, into a file called .xoaprc which needs to be
3843 placed into your home directory.</para>
3844 <para>'locID' must be a valid location identifier for
3845 the required uri. For the NOAA site this must be a
3846 valid ICAO (see for instance
3847 https://pilotweb.nas.faa.gov/qryhtml/icao/). For the
3848 weather.com site this must be a valid location ID (see
3850 http://aspnetresources.com/tools/locid.aspx).</para>
3851 <para>'data_type' must be one of the following:</para>
3854 <command>last_update</command>
3855 <para>The date and time stamp of the data.
3856 The result depends on the URI used. For the
3857 NOAA site it is date (yyyy/mm/dd) and UTC time.
3858 For the weather.com one it is date
3859 ([m]m/[d]d/yy) and Local Time of the
3863 <command>temperature</command>
3864 <para>Air temperature (you can use the
3865 'temperature_unit' config setting to change
3869 <command>cloud_cover</command>
3870 <para>The highest cloud cover status</para>
3873 <command>pressure</command>
3874 <para>Air pressure in millibar</para>
3877 <command>wind_speed</command>
3878 <para>Wind speed in km/h</para>
3881 <command>wind_dir</command>
3882 <para>Wind direction</para>
3885 <command>wind_dir_DEG</command>
3886 <para>Compass wind direction</para>
3889 <command>humidity</command>
3890 <para>Relative humidity in %</para>
3893 <command>weather</command>
3894 <para>Any relevant weather event (rain, snow,
3895 etc.). This is not used if you are querying the
3896 weather.com site since this data is aggregated
3897 into the cloud_cover one</para>
3900 <command>icon</command>
3901 <para>Weather icon (only for
3902 www.weather.com). Can be used together with the
3903 icon kit provided upon registering to their
3907 <para>'delay_in_minutes' (optional, default 30) cannot
3908 be less than 30 minutes.</para>
3909 <para>This object is threaded, and once a thread is
3910 created it can't be explicitly destroyed. One thread
3911 will run for each URI specified.</para>
3912 <para>Note that these variables are still EXPERIMENTAL
3913 and can be subject to many future changes.</para>
3919 <option>weather_forecast</option>
3921 <option>URI locID day data_type
3922 (interval_in_minutes)</option>
3925 <para>Download, parse and display weather forecast data
3926 for a given day (daytime only).</para>
3927 <para>For the 'URI', for the time being only
3928 http://xoap.weather.com/weather/local/ is
3929 supported. See 'weather' above for details of usage</para>
3930 <para>'locID', see 'weather' above.</para>
3931 <para>'day' is a number from 0 (today) to 4 (3 days
3932 after tomorrow).</para>
3933 <para>'data_type' must be one of the following:</para>
3936 <command>day</command>
3937 <option>Day of the week</option>
3940 <command>date</command>
3941 <option>Date, in the form MMM DD (ie. Jul 14)</option>
3944 <command>low</command>
3945 <option>Minimun temperature (you can use the
3946 'temperature_unit' config setting to change
3950 <command>hi</command>
3951 <option>Maximum temperature (you can use the
3952 'temperature_unit' config setting to change
3956 <command>icon</command>
3957 <option>Weather icon. Can be used together with the
3958 icon kit provided upon registering to the weather.com
3962 <command>forecast</command>
3963 <option>Weather forecast (sunny, rainy, etc.)</option>
3966 <command>wind_speed</command>
3967 <option>Wind speed in km/h</option>
3970 <command>wind_dir</command>
3971 <option>Wind direction</option>
3974 <command>wind_dir_DEG</command>
3975 <option>Compass wind direction</option>
3978 <command>humidity</command>
3979 <option>Relative humidity in %</option>
3982 <command>precipitation</command>
3983 <option>Probability of having a
3984 precipitation (in %)</option>
3987 <para>'delay_in_minutes' (optional, default 210) cannot
3988 be lower than 210 min.</para>
3989 <para>This object is threaded, and once a thread is
3990 created it can't be explicitly destroyed. One thread
3991 will run for each URI specified. You can use any
3992 protocol that Curl supports.</para>
3993 <para>Note that these variables are still EXPERIMENTAL
3994 and can be subject to many future changes.</para>
4000 <option>wireless_ap</option>
4002 <option>(net)</option>
4004 <listitem>Wireless access point MAC address (Linux only)
4010 <option>wireless_bitrate</option>
4012 <option>(net)</option>
4014 <listitem>Wireless bitrate (ie 11 Mb/s) (Linux only)
4020 <option>wireless_essid</option>
4022 <option>(net)</option>
4024 <listitem>Wireless access point ESSID (Linux only)
4030 <option>wireless_link_bar</option>
4032 <option>(height),(width) (net)</option>
4034 <listitem>Wireless link quality bar (Linux only)
4040 <option>wireless_link_qual</option>
4042 <option>(net)</option>
4044 <listitem>Wireless link quality (Linux only)
4050 <option>wireless_link_qual_max</option>
4052 <option>(net)</option>
4054 <listitem>Wireless link quality maximum value (Linux only)
4060 <option>wireless_link_qual_perc</option>
4062 <option>(net)</option>
4064 <listitem>Wireless link quality in percents (Linux only)
4070 <option>wireless_mode</option>
4072 <option>(net)</option>
4074 <listitem>Wireless mode (Managed/Ad-Hoc/Master) (Linux
4081 <option>words</option>
4083 <option>textfile</option>
4085 <listitem>Displays the number of words in the given file
4091 <option>xmms2_album</option>
4094 <listitem>Album in current XMMS2 song
4100 <option>xmms2_artist</option>
4103 <listitem>Artist in current XMMS2 song
4109 <option>xmms2_bar</option>
4111 <option>(height),(width)</option>
4113 <listitem>Bar of XMMS2's progress
4119 <option>xmms2_bitrate</option>
4122 <listitem>Bitrate of current song
4128 <option>xmms2_comment</option>
4131 <listitem>Comment in current XMMS2 song
4137 <option>xmms2_date</option>
4140 <listitem>Returns song's date.
4146 <option>xmms2_duration</option>
4149 <listitem>Duration of current song
4155 <option>xmms2_elapsed</option>
4158 <listitem>Song's elapsed time
4164 <option>xmms2_genre</option>
4167 <listitem>Genre in current XMMS2 song
4173 <option>xmms2_id</option>
4176 <listitem>XMMS2 id of current song
4182 <option>xmms2_percent</option>
4185 <listitem>Percent of song's progress
4191 <option>xmms2_playlist</option>
4194 <listitem>Returns the XMMS2 playlist.
4200 <option>xmms2_size</option>
4203 <listitem>Size of current song
4209 <option>xmms2_smart</option>
4212 <listitem>Prints the song name in either the form "artist -
4213 title" or file name, depending on whats available
4219 <option>xmms2_status</option>
4222 <listitem>XMMS2 status (Playing, Paused, Stopped, or
4229 <option>xmms2_timesplayed</option>
4232 <listitem>Number of times a song was played (presumably).
4238 <option>xmms2_title</option>
4241 <listitem>Title in current XMMS2 song
4247 <option>xmms2_tracknr</option>
4250 <listitem>Track number in current XMMS2 song
4256 <option>xmms2_url</option>
4259 <listitem>Full path to current song
projects / monky / blob