5 <option>acpiacadapter</option>
8 <listitem>ACPI ac adapter state.
14 <option>acpifan</option>
17 <listitem>ACPI fan state
23 <option>acpitemp</option>
26 <listitem>ACPI temperature in C.
34 <option>(interface)</option>
36 <listitem>IP address for an interface, or "No Address" if
37 no address is assigned.
43 <option>addrs</option>
45 <option>(interface)</option>
47 <listitem>IP addresses for an interface (if one - works
48 like addr). Linux only.
54 <option>adt746xcpu</option>
57 <listitem>CPU temperature from therm_adt746x
63 <option>adt746xfan</option>
66 <listitem>Fan speed from therm_adt746x
72 <option>alignc</option>
74 <option>(num)</option>
76 <listitem>Align text to centre
82 <option>alignr</option>
84 <option>(num)</option>
86 <listitem>Right-justify text, with space of N
92 <option>apcupsd</option>
97 <listitem>Sets up the connection to apcupsd daemon. Prints
98 nothing, defaults to localhost:3551
104 <option>apcupsd_cable</option>
107 <listitem>Prints the UPS connection type.
113 <option>apcupsd_charge</option>
116 <listitem>Current battery capacity in percent.
122 <option>apcupsd_lastxfer</option>
125 <listitem>Reason for last transfer from line to battery.
131 <option>apcupsd_linev</option>
134 <listitem>Nominal input voltage.
140 <option>apcupsd_load</option>
143 <listitem>Current load in percent.
149 <option>apcupsd_loadbar</option>
152 <listitem>Bar showing current load.
158 <option>apcupsd_loadgauge</option>
160 <option>(height),(width)</option>
162 <listitem>Gauge that shows current load.
168 <option>apcupsd_loadgraph</option>
170 <option>(height),(width) (gradient colour 1) (gradient
171 colour 2) (scale) (-t) (-l)</option>
173 <listitem>History graph of current load.
179 <option>apcupsd_model</option>
182 <listitem>Prints the model of the UPS.
188 <option>apcupsd_name</option>
191 <listitem>Prints the UPS user-defined name.
197 <option>apcupsd_status</option>
200 <listitem>Prints current status (on-line, on-battery).
206 <option>apcupsd_temp</option>
209 <listitem>Current internal temperature.
215 <option>apcupsd_timeleft</option>
218 <listitem>Time left to run on battery.
224 <option>apcupsd_upsmode</option>
227 <listitem>Prints the UPS mode (e.g. standalone).
233 <option>apm_adapter</option>
236 <listitem>Display APM AC adapter status (FreeBSD only)
242 <option>apm_battery_life</option>
245 <listitem>Display APM battery life in percent (FreeBSD
252 <option>apm_battery_time</option>
255 <listitem>Display remaining APM battery life in hh:mm:ss or
256 "unknown" if AC adapterstatus is on-line or charging
263 <option>audacious_bar</option>
265 <option>(height),(width)</option>
267 <listitem>Progress bar
273 <option>audacious_bitrate</option>
276 <listitem>Bitrate of current tune
282 <option>audacious_channels</option>
285 <listitem>Number of audio channels of current tune
291 <option>audacious_filename</option>
294 <listitem>Full path and filename of current tune
300 <option>audacious_frequency</option>
303 <listitem>Sampling frequency of current tune
309 <option>audacious_length</option>
312 <listitem>Total length of current tune as MM:SS
318 <option>audacious_length_seconds</option>
321 <listitem>Total length of current tune in seconds
327 <option>audacious_main_volume</option>
330 <listitem>The current volume fetched from Audacious
336 <option>audacious_playlist_length</option>
339 <listitem>Number of tunes in playlist
345 <option>audacious_playlist_position</option>
348 <listitem>Playlist position of current tune
354 <option>audacious_position</option>
357 <listitem>Position of current tune (MM:SS)
363 <option>audacious_position_seconds</option>
366 <listitem>Position of current tune in seconds
372 <option>audacious_status</option>
375 <listitem>Player status (Playing/Paused/Stopped/Not
382 <option>audacious_title</option>
384 <option>(max length)</option>
386 <listitem>Title of current tune with optional maximum
393 <option>battery</option>
395 <option>(num)</option>
397 <listitem>Battery status and remaining percentage capacity
398 of ACPI or APM battery. ACPI battery number can be given as
399 argument (default is BAT0).
405 <option>battery_bar</option>
407 <option>(height),(width) (num)</option>
409 <listitem>Battery percentage remaining of ACPI battery in a
410 bar. ACPI battery number can be given as argument (default
417 <option>battery_percent</option>
419 <option>(num)</option>
421 <listitem>Battery percentage remaining for ACPI battery.
422 ACPI battery number can be given as argument (default is
429 <option>battery_short</option>
431 <option>(num)</option>
433 <listitem>Battery status and remaining percentage capacity
434 of ACPI or APM battery. ACPI battery number can be given as
435 argument (default is BAT0). This mode display a short
436 status, which means that C is displayed instead of
437 charging, D for discharging, F for full, N for not present,
438 E for empty and U for unknown.
444 <option>battery_time</option>
446 <option>(num)</option>
448 <listitem>Battery charge/discharge time remaining of ACPI
449 battery. ACPI battery number can be given as argument
456 <option>blink</option>
458 <option>text_and_other_conky_vars</option>
460 <listitem>Let 'text_and_other_conky_vars' blink on and off.
467 <option>bmpx_album</option>
470 <listitem>Album in current BMPx track
476 <option>bmpx_artist</option>
479 <listitem>Artist in current BMPx track
485 <option>bmpx_bitrate</option>
488 <listitem>Bitrate of the current BMPx track
494 <option>bmpx_title</option>
497 <listitem>Title of the current BMPx track
503 <option>bmpx_track</option>
506 <listitem>Track number of the current BMPx track
512 <option>bmpx_uri</option>
515 <listitem>URI of the current BMPx track
521 <option>buffers</option>
524 <listitem>Amount of memory buffered
530 <option>cached</option>
533 <listitem>Amount of memory cached
539 <option>cmdline_to_pid</option>
541 <option>string</option>
543 <listitem>PID of the first process that has string in it's
550 <option>color</option>
552 <option>(color)</option>
554 <listitem>Change drawing color to 'color' which is a name of
555 a color or a hexcode preceded with # (for example #0A1B2C ).
556 If you use ncurses only the following colors are supported:
557 red,green,yellow,blue,magenta,cyan,black,white.
563 <option>colorN</option>
566 <listitem>Change drawing color to colorN configuration
567 option, where N is a digit between 0 and 9, inclusively.
573 <option>combine</option>
575 <option>var1 var2</option>
577 <listitem>Places the lines of var2 to the right of the
578 lines of var1 separated by the chars that are put between
579 var1 and var2. For example: ${combine ${head /proc/cpuinfo
580 2} - ${head /proc/meminfo 1}} gives as output
581 "cpuinfo_line1 - meminfo_line1" on line 1 and
582 "cpuinfo_line2 -" on line 2. $combine vars can also be
583 nested to place more vars next to each other.
589 <option>conky_build_arch</option>
592 <listitem>CPU architecture Conky was built for
598 <option>conky_build_date</option>
601 <listitem>Date Conky was built
607 <option>conky_version</option>
610 <listitem>Conky version
618 <option>(cpuN)</option>
620 <listitem>CPU usage in percents. For SMP machines, the CPU
621 number can be provided as an argument. ${cpu cpu0} is the
622 total usage, and ${cpu cpuX} (X >= 1) are individual
629 <option>cpubar</option>
631 <option>(cpuN) (height),(width)</option>
633 <listitem>Bar that shows CPU usage, height is bar's height
634 in pixels. See $cpu for more info on SMP.
640 <option>cpugauge</option>
642 <option>(cpuN) (height),(width)</option>
644 <listitem>Elliptical gauge that shows CPU usage, height and
645 width are gauge's vertical and horizontal axis
646 respectively. See $cpu for more info on SMP.
652 <option>cpugraph</option>
654 <option>(cpuN) (height),(width) (gradient colour 1)
655 (gradient colour 2) (scale) (-t) (-l)</option>
657 <listitem>CPU usage graph, with optional colours in hex,
658 minus the #. See $cpu for more info on SMP. Uses a
659 logarithmic scale (to see small numbers) when you use the
660 -l switch. Takes the switch '-t' to use a temperature
661 gradient, which makes the gradient values change depending
662 on the amplitude of a particular graph value (try it and
669 <option>curl</option>
671 <option>url (interval_in_minutes)</option>
674 <para>Download data from URI using Curl at the
675 specified interval. The interval may be a floating
676 point value greater than 0, otherwise defaults to 15
677 minutes. Most useful when used in conjunction with Lua
678 and the Lua API. This object is threaded, and once a
679 thread is created it can't be explicitly destroyed.
680 One thread will run for each URI specified. You can use
681 any protocol that Curl supports.</para>
687 <option>desktop</option>
690 <listitem>Number of the desktop on which conky is running
691 or the message "Not running in X" if this is the case.
697 <option>desktop_name</option>
700 <listitem>Name of the desktop on which conky is running or
701 the message "Not running in X" if this is the case.
707 <option>desktop_number</option>
710 <listitem>Number of desktops or the message "Not running in
711 X" if this is the case.
717 <option>disk_protect</option>
719 <option>device</option>
721 <listitem>Disk protection status, if supported (needs
722 kernel-patch). Prints either "frozen" or "free " (note the
729 <option>diskio</option>
731 <option>(device)</option>
733 <listitem>Displays current disk IO. Device is optional, and
734 takes the form of sda for /dev/sda. Individual partitions
741 <option>diskio_read</option>
743 <option>(device)</option>
745 <listitem>Displays current disk IO for reads. Device as in
752 <option>diskio_write</option>
754 <option>(device)</option>
756 <listitem>Displays current disk IO for writes. Device as in
763 <option>diskiograph</option>
765 <option>(device) (height),(width) (gradient colour 1)
766 (gradient colour 2) (scale) (-t) (-l)</option>
768 <listitem>Disk IO graph, colours defined in hex, minus the
769 #. If scale is non-zero, it becomes the scale for the
770 graph. Uses a logarithmic scale (to see small numbers) when
771 you use -l switch. Takes the switch '-t' to use a
772 temperature gradient, which makes the gradient values
773 change depending on the amplitude of a particular graph
774 value (try it and see).
780 <option>diskiograph_read</option>
782 <option>(device) (height),(width) (gradient colour 1)
783 (gradient colour 2) (scale) (-t) (-l)</option>
785 <listitem>Disk IO graph for reads, colours defined in hex,
786 minus the #. If scale is non-zero, it becomes the scale for
787 the graph. Device as in diskio. Uses a logarithmic scale
788 (to see small numbers) when you use -l switch. Takes the
789 switch '-t' to use a temperature gradient, which makes the
790 gradient values change depending on the amplitude of a
791 particular graph value (try it and see).
797 <option>diskiograph_write</option>
799 <option>(device) (height),(width) (gradient colour 1)
800 (gradient colour 2) (scale) (-t) (-l)</option>
802 <listitem>Disk IO graph for writes, colours defined in hex,
803 minus the #. If scale is non-zero, it becomes the scale for
804 the graph. Device as in diskio. Uses a logarithmic scale
805 (to see small numbers) when you use -l switch. Takes the
806 switch '-t' to use a temperature gradient, which makes the
807 gradient values change depending on the amplitude of a
808 particular graph value (try it and see).
814 <option>downspeed</option>
816 <option>(net)</option>
818 <listitem>Download speed in suitable IEC units
824 <option>downspeedf</option>
826 <option>(net)</option>
828 <listitem>Download speed in KiB with one decimal
834 <option>downspeedgraph</option>
836 <option>(netdev) (height),(width) (gradient colour 1)
837 (gradient colour 2) (scale) (-t) (-l)</option>
839 <listitem>Download speed graph, colours defined in hex,
840 minus the #. If scale is non-zero, it becomes the scale for
841 the graph. Uses a logarithmic scale (to see small numbers)
842 when you use -l switch. Takes the switch '-t' to use a
843 temperature gradient, which makes the gradient values
844 change depending on the amplitude of a particular graph
845 value (try it and see).
851 <option>draft_mails</option>
853 <option>(maildir)</option>
854 <option>(interval)</option>
856 <listitem>Number of mails marked as draft in the specified
857 mailbox or mail spool if not. Only maildir type mailboxes
858 are supported, mbox type will return -1.
864 <option>else</option>
867 <listitem>Text to show if any of the above are not true
873 <option>endif</option>
877 <listitem>Ends an $if block.
883 <option>entropy_avail</option>
886 <listitem>Current entropy available for crypto freaks
892 <option>entropy_bar</option>
894 <option>(height),(width)</option>
896 <listitem>Normalized bar of available entropy for crypto
903 <option>entropy_perc</option>
906 <listitem>Percentage of entropy available in comparison to
913 <option>entropy_poolsize</option>
916 <listitem>Total size of system entropy pool for crypto
923 <option>eval</option>
925 <option>string</option>
927 <listitem>Evaluates given string according to the rules of
928 TEXT interpretation, i.e. parsing any contained text object
929 specifications into their output, any occuring '$$' into a
930 single '$' and so on. The output is then being parsed
939 <option>api_userid api_key character_id</option>
941 <listitem>Fetches your currently training skill from the
942 Eve Online API servers (http://www.eve-online.com/) and
943 displays the skill along with the remaining training time.
949 <option>exec</option>
951 <option>command</option>
953 <listitem>Executes a shell command and displays the output
954 in conky. warning: this takes a lot more resources than
955 other variables. I'd recommend coding wanted behaviour in C
962 <option>execbar</option>
964 <option>command</option>
966 <listitem>Same as exec, except if the first value return is
967 a value between 0-100, it will use that number for a bar.
968 The size for bars can be controlled via the
969 default_bar_size config setting.
975 <option>execgauge</option>
977 <option>command</option>
979 <listitem>Same as exec, except if the first value returned
980 is a value between 0-100, it will use that number for a
981 gauge. The size for gauges can be controlled via the
982 default_gauge_size config setting.
988 <option>execgraph</option>
990 <option>(-t) (-l) command</option>
992 <listitem>Same as execbar, but graphs values. Uses a
993 logaritmic scale when the log option (-l switch) is given
994 (to see small numbers). Values still have to be between 0
995 and 100. The size for graphs can be controlled via the
996 default_graph_size config setting. Takes the switch '-t' to
997 use a temperature gradient, which makes the gradient values
998 change depending on the amplitude of a particular graph
999 value (try it and see). If -t or -l is your first argument,
1000 you may need to preceed it by a space (' ').
1006 <option>execi</option>
1008 <option>interval command</option>
1010 <listitem>Same as exec but with specific interval. Interval
1011 can't be less than update_interval in configuration. See
1018 <option>execibar</option>
1020 <option>interval command</option>
1022 <listitem>Same as execbar, except with an interval
1028 <option>execigauge</option>
1030 <option>interval command</option>
1032 <listitem>Same as execgauge, but takes an interval arg and
1039 <option>execigraph</option>
1041 <option>interval (-t) (-l) command</option>
1043 <listitem>Same as execgraph, but takes an interval arg and
1044 graphs values. If -t or -l is your first argument, you may
1045 need to preceed it by a space (' ').
1051 <option>execp</option>
1053 <option>command</option>
1055 <listitem>Executes a shell command and displays the output
1056 in conky. warning: this takes a lot more resources than
1057 other variables. I'd recommend coding wanted behaviour in C
1058 and posting a patch. This differs from $exec in that it
1059 parses the output of the command, so you can insert things
1060 like ${color red}hi!${color} in your script and have it
1061 correctly parsed by Conky. Caveats: Conky parses and
1062 evaluates the output of $execp every time Conky loops, and
1063 then destroys all the objects. If you try to use anything
1064 like $execi within an $execp statement, it will
1065 functionally run at the same interval that the $execp
1066 statement runs, as it is created and destroyed at every
1073 <option>execpi</option>
1075 <option>interval command</option>
1077 <listitem>Same as execp but with specific interval.
1078 Interval can't be less than update_interval in
1079 configuration. Note that the output from the $execpi
1080 command is still parsed and evaluated at every interval.
1086 <option>flagged_mails</option>
1088 <option>(maildir)</option>
1089 <option>(interval)</option>
1091 <listitem>Number of mails marked as flagged in the
1092 specified mailbox or mail spool if not. Only maildir type
1093 mailboxes are supported, mbox type will return -1.
1099 <option>font</option>
1101 <option>(font)</option>
1103 <listitem>Specify a different font. This new font will
1104 apply to the current line and everything following. You can
1105 use a $font with no arguments to change back to the default
1106 font (much like with $color)
1112 <option>format_time</option>
1114 <option>seconds format</option>
1116 <listitem>Format time given in seconds. This var only works when
1117 the times_in_seconds configuration setting is on. Format is a string
1118 that should start and end with a "-char. The "-chars are not
1119 part of the output, \w,\d,\h,\m,\s,\(,\) and \\ are replaced by
1120 weeks,days,hours,minutes,seconds,(,) and \. If you leave out a unit,
1121 it's value will be expressed in the highest unite lower then the
1122 one left out. Text between ()-chars will not be visible if a
1123 replaced unit in this text is 0. If seconds is a decimal number
1124 then you can see the numbers behind the point by using \S
1125 followed by a number that specifies the amount of
1126 digits behind the point that you want to see (maximum 9).
1127 You can also place a 'x' behind \S so you have all digits behind
1128 the point and no trailing zero's. (also maximum 9)
1134 <option>forwarded_mails</option>
1136 <option>(maildir)</option>
1137 <option>(interval)</option>
1139 <listitem>Number of mails marked as forwarded in the
1140 specified mailbox or mail spool if not. Only maildir type
1141 mailboxes are supported, mbox type will return -1.
1147 <option>freq</option>
1149 <option>(n)</option>
1151 <listitem>Returns CPU #n's frequency in MHz. CPUs are
1152 counted from 1. If omitted, the parameter defaults to 1.
1158 <option>freq_g</option>
1160 <option>(n)</option>
1162 <listitem>Returns CPU #n's frequency in GHz. CPUs are
1163 counted from 1. If omitted, the parameter defaults to 1.
1169 <option>fs_bar</option>
1171 <option>(height),(width) fs</option>
1173 <listitem>Bar that shows how much space is used on a file
1174 system. height is the height in pixels. fs is any file on
1181 <option>fs_bar_free</option>
1183 <option>(height),(width) fs</option>
1185 <listitem>Bar that shows how much space is free on a file
1186 system. height is the height in pixels. fs is any file on
1193 <option>fs_free</option>
1195 <option>(fs)</option>
1197 <listitem>Free space on a file system available for users.
1203 <option>fs_free_perc</option>
1205 <option>(fs)</option>
1207 <listitem>Free percentage of space on a file system
1208 available for users.
1214 <option>fs_size</option>
1216 <option>(fs)</option>
1218 <listitem>File system size.
1224 <option>fs_type</option>
1226 <option>(fs)</option>
1228 <listitem>File system type.
1234 <option>fs_used</option>
1236 <option>(fs)</option>
1238 <listitem>File system used space.
1244 <option>fs_used_perc</option>
1246 <option>(fs)</option>
1248 <listitem>Percent of file system used space.
1254 <option>goto</option>
1258 <listitem>The next element will be printed at position 'x'.
1265 <option>gw_iface</option>
1268 <listitem>Displays the default route's interface or
1269 "multiple"/"none" accordingly.
1275 <option>gw_ip</option>
1278 <listitem>Displays the default gateway's IP or
1279 "multiple"/"none" accordingly.
1285 <option>hddtemp</option>
1287 <option>(dev)</option>
1289 <listitem>Displays temperature of a selected hard disk
1290 drive as reported by the hddtemp daemon. Use hddtemp_host
1291 and hddtemp_port to specify a host and port for all hddtemp
1292 objects. If no dev parameter is given, the first disk returned
1293 by the hddtemp daemon is used.
1299 <option>head</option>
1301 <option>logfile lines (next_check)</option>
1303 <listitem>Displays first N lines of supplied text file. The
1304 file is checked every 'next_check' update. If next_check is
1305 not supplied, Conky defaults to 2. Max of 30 lines can be
1306 displayed, or until the text buffer is filled.
1314 <option>(height)</option>
1316 <listitem>Horizontal line, height is the height in pixels
1322 <option>hwmon</option>
1324 <option>(dev) type n (factor offset)</option>
1326 <listitem>Hwmon sensor from sysfs (Linux 2.6). Parameter
1327 dev may be omitted if you have only one hwmon device.
1328 Parameter type is either 'in' or 'vol' meaning voltage;
1329 'fan' meaning fan; 'temp' meaning temperature. Parameter n
1330 is number of the sensor. See /sys/class/hwmon/ on your
1331 local computer. The optional arguments 'factor' and
1332 'offset' allow precalculation of the raw input, which is
1333 being modified as follows: 'input = input * factor +
1334 offset'. Note that they have to be given as decimal values
1335 (i.e. contain at least one decimal place).
1341 <option>i2c</option>
1343 <option>(dev) type n (factor offset)</option>
1345 <listitem>I2C sensor from sysfs (Linux 2.6). Parameter dev
1346 may be omitted if you have only one I2C device. Parameter
1347 type is either 'in' or 'vol' meaning voltage; 'fan' meaning
1348 fan; 'temp' meaning temperature. Parameter n is number of
1349 the sensor. See /sys/bus/i2c/devices/ on your local
1350 computer. The optional arguments 'factor' and 'offset'
1351 allow precalculation of the raw input, which is being
1352 modified as follows: 'input = input * factor + offset'.
1353 Note that they have to be given as decimal values (i.e.
1354 contain at least one decimal place).
1360 <option>i8k_ac_status</option>
1364 <listitem>If running the i8k kernel driver for Inspiron
1365 laptops, displays whether ac power is on, as listed in
1366 /proc/i8k (translated to human-readable). Beware that this
1367 is by default not enabled by i8k itself.
1373 <option>i8k_bios</option>
1377 <listitem>If running the i8k kernel driver for Inspiron
1378 laptops, displays the bios version as listed in /proc/i8k.
1384 <option>i8k_buttons_status</option>
1388 <listitem>If running the i8k kernel driver for Inspiron
1389 laptops, displays the volume buttons status as listed in
1396 <option>i8k_cpu_temp</option>
1400 <listitem>If running the i8k kernel driver for Inspiron
1401 laptops, displays the cpu temperature in Celsius, as
1402 reported by /proc/i8k.
1408 <option>i8k_left_fan_rpm</option>
1412 <listitem>If running the i8k kernel driver for Inspiron
1413 laptops, displays the left fan's rate of rotation, in
1414 revolutions per minute as listed in /proc/i8k. Beware, some
1415 laptops i8k reports these fans in reverse order.
1421 <option>i8k_left_fan_status</option>
1425 <listitem>If running the i8k kernel driver for Inspiron
1426 laptops, displays the left fan status as listed in
1427 /proc/i8k (translated to human-readable). Beware, some
1428 laptops i8k reports these fans in reverse order.
1434 <option>i8k_right_fan_rpm</option>
1438 <listitem>If running the i8k kernel driver for Inspiron
1439 laptops, displays the right fan's rate of rotation, in
1440 revolutions per minute as listed in /proc/i8k. Beware, some
1441 laptops i8k reports these fans in reverse order.
1447 <option>i8k_right_fan_status</option>
1451 <listitem>If running the i8k kernel driver for Inspiron
1452 laptops, displays the right fan status as listed in
1453 /proc/i8k (translated to human-readable). Beware, some
1454 laptops i8k reports these fans in reverse order.
1460 <option>i8k_serial</option>
1464 <listitem>If running the i8k kernel driver for Inspiron
1465 laptops, displays your laptop serial number as listed in
1472 <option>i8k_version</option>
1476 <listitem>If running the i8k kernel driver for Inspiron
1477 laptops, displays the version formatting of /proc/i8k.
1483 <option>ibm_brightness</option>
1486 <listitem>If running the IBM ACPI, displays the brigtness
1487 of the laptops's LCD (0-7).
1493 <option>ibm_fan</option>
1496 <listitem>If running the IBM ACPI, displays the fan speed.
1502 <option>ibm_temps</option>
1506 <listitem>If running the IBM ACPI, displays the
1507 temperatures from the IBM temperature sensors (N=0..7)
1508 Sensor 0 is on the CPU, 3 is on the GPU.
1514 <option>ibm_volume</option>
1517 <listitem>If running the IBM ACPI, displays the "master"
1518 volume, controlled by the volume keys (0-14).
1524 <option>iconv_start</option>
1526 <option>codeset_from codeset_to</option>
1528 <listitem>Convert text from one codeset to another using
1529 GNU iconv. Needs to be stopped with iconv_stop.
1535 <option>iconv_stop</option>
1539 <listitem>Stop iconv codeset conversion.
1545 <option>if_empty</option>
1547 <option>(var)</option>
1549 <listitem>if conky variable VAR is empty, display
1550 everything between $if_empty and the matching $endif
1556 <option>if_existing</option>
1558 <option>file (string)</option>
1560 <listitem>if FILE exists, display everything between
1561 if_existing and the matching $endif. The optional second
1562 paramater checks for FILE containing the specified string
1563 and prints everything between $if_existing and the matching
1570 <option>if_gw</option>
1573 <listitem>if there is at least one default gateway, display
1574 everything between $if_gw and the matching $endif
1580 <option>if_match</option>
1582 <option>expression</option>
1584 <listitem>Evaluates the given boolean expression, printing
1585 everything between $if_match and the matching $endif
1586 depending on whether the evaluation returns true or not.
1587 Valid expressions consist of a left side, an operator and a
1588 right side. Left and right sides are being parsed for
1589 contained text objects before evaluation. Recognised left
1590 and right side types are:
1593 <command>double</command>Argument consists of only
1594 digits and a single dot.</member>
1596 <command>long</command>Argument consists of only
1599 <command>string</command>Argument is enclosed in
1600 quotation mark or the checks for double and long failed
1602 </simplelist>Valid operands are: '>', '<', '>=',
1603 '<=', '==', '!='.
1609 <option>if_mixer_mute</option>
1611 <option>(mixer)</option>
1613 <listitem>If mixer exists, display everything between
1614 $if_mixer_mute and the matching $endif. If no mixer is
1615 specified, "Master" is used.
1621 <option>if_mounted</option>
1623 <option>(mountpoint)</option>
1625 <listitem>if MOUNTPOINT is mounted, display everything
1626 between $if_mounted and the matching $endif
1632 <option>if_mpd_playing</option>
1635 <listitem>if mpd is playing or paused, display everything
1636 between $if_mpd_playing and the matching $endif
1642 <option>if_running</option>
1644 <option>(process)</option>
1646 <listitem>if PROCESS is running, display everything
1647 $if_running and the matching $endif. This uses the
1648 ``pidof'' command, so the -x switch is also supported.
1654 <option>if_smapi_bat_installed</option>
1656 <option>(INDEX)</option>
1658 <listitem>when using smapi, if the battery with index INDEX
1659 is installed, display everything between
1660 $if_smapi_bat_installed and the matching $endif
1666 <option>if_up</option>
1668 <option>(interface)</option>
1670 <listitem>if INTERFACE exists and is up, display everything
1671 between $if_up and the matching $endif
1677 <option>if_updatenr</option>
1679 <option>(updatenr)</option>
1681 <listitem>If it's the UPDATENR-th time that conky updates,
1682 display everything between $if_updatenr and the matching
1683 $endif. The counter resets when the highest UPDATENR is
1684 reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr
1685 2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the
1686 time followed by bar 25% of the time followed by nothing
1687 the other half of the time.
1693 <option>if_xmms2_connected</option>
1696 <listitem>Display everything between $if_xmms2_connected
1697 and the matching $endif if xmms2 is running.
1703 <option>image</option>
1705 <option><path to image> (-p x,y) (-s WxH) (-n)
1706 (-f interval)</option>
1708 <listitem>Renders an image from the path specified using
1709 Imlib2. Takes 4 optional arguments: a position, a size, a
1710 no-cache switch, and a cache flush interval. Changing the
1711 x,y position will move the position of the image, and
1712 changing the WxH will scale the image. If you specify the
1713 no-cache flag (-n), the image will not be cached.
1714 Alternately, you can specify the -f int switch to specify a
1715 cache flust interval for a particular image. Example:
1716 ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200}
1717 will render 'cheeseburger.jpg' at (20,20) scaled to 200x200
1718 pixels. Conky does not make any attempt to adjust the
1719 position (or any other formatting) of images, they are just
1720 rendered as per the arguments passed. The only reason
1721 $image is part of the TEXT section, is to allow for runtime
1722 modifications, through $execp $lua_parse, or some other
1729 <option>imap_messages</option>
1731 <option>(args)</option>
1733 <listitem>Displays the number of messages in your global
1734 IMAP inbox by default. You can define individual IMAP
1735 inboxes separately by passing arguments to this object.
1736 Arguments are: "host user pass [-i interval (in seconds)]
1737 [-f 'folder'] [-p port] [-e 'command'] [-r retries]". Default
1738 port is 143, default folder is 'INBOX', default interval is
1739 5 minutes, and default number of retries before giving up
1740 is 5. If the password is supplied as '*', you will be
1741 prompted to enter the password when Conky starts.
1747 <option>imap_unseen</option>
1749 <option>(args)</option>
1751 <listitem>Displays the number of unseen messages in your
1752 global IMAP inbox by default. You can define individual
1753 IMAP inboxes separately by passing arguments to this
1754 object. Arguments are: "host user pass [-i interval (in
1755 seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r retries]".
1756 Default port is 143, default folder is 'INBOX', default
1757 interval is 5 minutes, and default number of retries before
1758 giving up is 5. If the password is supplied as '*', you
1759 will be prompted to enter the password when Conky starts.
1765 <option>include</option>
1767 <option>path</option>
1770 <para>Loads the configfile at path, places the
1771 configsettings behind the configsettings in the orginal
1772 config and places the vars where the includevar
1779 <option>ioscheduler</option>
1781 <option>disk</option>
1783 <listitem>Prints the current ioscheduler used for the given
1784 disk name (i.e. e.g. "hda" or "sdb")
1790 <option>kernel</option>
1793 <listitem>Kernel version
1799 <option>laptop_mode</option>
1802 <listitem>The value of /proc/sys/vm/laptop_mode
1808 <option>lines</option>
1810 <option>textfile</option>
1812 <listitem>Displays the number of lines in the given file
1818 <option>loadavg</option>
1820 <option>(1|2|3)</option>
1822 <listitem>System load average, 1 is for past 1 minute, 2
1823 for past 5 minutes and 3 for past 15 minutes. Without argument, prints
1824 all three values separated by whitespace.
1830 <option>loadgraph</option>
1832 <option>(height),(width) (gradient colour 1)
1833 (gradient colour 2) (scale) (-t) (-l)</option>
1835 <listitem>Load1 average graph, similar to xload, with
1836 optional colours in hex, minus the #. Uses a logarithmic
1837 scale (to see small numbers) when you use the -l switch.
1838 Takes the switch '-t' to use a temperature gradient, which
1839 makes the gradient values change depending on the amplitude
1840 of a particular graph value (try it and see).
1846 <option>lua</option>
1848 <option>function_name (function parameters)</option>
1850 <listitem>Executes a Lua function with given parameters,
1851 then prints the returned string. See also 'lua_load' on how
1852 to load scripts. Conky puts 'conky_' in front of
1853 function_name to prevent accidental calls to the wrong
1854 function unless you put you place 'conky_' in front of it
1861 <option>lua_bar</option>
1863 <option>(height, width) function_name (function
1864 parameters)</option>
1866 <listitem>Executes a Lua function with given parameters and
1867 draws a bar. Expects result value to be an integer between
1868 0 and 100. See also 'lua_load' on how to load scripts.
1869 Conky puts 'conky_' in front of function_name to prevent
1870 accidental calls to the wrong function unless you put you
1871 place 'conky_' in front of it yourself.
1877 <option>lua_gauge</option>
1879 <option>(height, width) function_name (function
1880 parameters)</option>
1882 <listitem>Executes a Lua function with given parameters and
1883 draws a gauge. Expects result value to be an integer
1884 between 0 and 100. See also 'lua_load' on how to load
1885 scripts. Conky puts 'conky_' in front of function_name to
1886 prevent accidental calls to the wrong function unless you
1887 put you place 'conky_' in front of it yourself.
1893 <option>lua_graph</option>
1895 <option>function_name (height),(width) (gradient colour
1896 1) (gradient colour 2) (scale) (-t) (-l)</option>
1898 <listitem>Executes a Lua function with and draws a graph.
1899 Expects result value to be any number, and by default will
1900 scale to show the full range. See also 'lua_load' on how to
1901 load scripts. Takes the switch '-t' to use a temperature
1902 gradient, which makes the gradient values change depending
1903 on the amplitude of a particular graph value (try it and
1904 see). Conky puts 'conky_' in front of function_name to
1905 prevent accidental calls to the wrong function unless you
1906 put you place 'conky_' in front of it yourself.
1912 <option>lua_parse</option>
1914 <option>function_name (function parameters)</option>
1916 <listitem>Executes a Lua function with given parameters as
1917 per $lua, then parses and prints the result value as per
1918 the syntax for Conky's TEXT section. See also 'lua_load' on
1919 how to load scripts. Conky puts 'conky_' in front of
1920 function_name to prevent accidental calls to the wrong
1921 function unless you put you place 'conky_' in front of it
1928 <option>machine</option>
1931 <listitem>Machine, i686 for example
1937 <option>mails</option>
1939 <option>(mailbox)</option>
1940 <option>(interval)</option>
1942 <listitem>Mail count in the specified mailbox or your mail
1943 spool if not. Both mbox and maildir type mailboxes are
1944 supported. You can use a program like fetchmail to get
1945 mails from some server using your favourite protocol. See
1952 <option>mboxscan</option>
1954 <option>(-n number of messages to print) (-fw from
1955 width) (-sw subject width) mbox</option>
1957 <listitem>Print a summary of recent messages in an mbox
1958 format mailbox. mbox parameter is the filename of the
1959 mailbox (can be encapsulated using '"', ie. ${mboxscan -n
1960 10 "/home/brenden/some box"}
1966 <option>mem</option>
1969 <listitem>Amount of memory in use
1975 <option>membar</option>
1977 <option>(height),(width)</option>
1979 <listitem>Bar that shows amount of memory in use
1985 <option>memeasyfree</option>
1988 <listitem>Amount of free memory including the memory that
1989 is very easily freed (buffers/cache)
1995 <option>memfree</option>
1998 <listitem>Amount of free memory
2004 <option>memgauge</option>
2006 <option>(height),(width)</option>
2008 <listitem>Gauge that shows amount of memory in use (see
2015 <option>memgraph</option>
2017 <option>(height),(width) (gradient colour 1) (gradient
2018 colour 2) (scale) (-t) (-l)</option>
2020 <listitem>Memory usage graph. Uses a logarithmic scale (to
2021 see small numbers) when you use the -l switch. Takes the
2022 switch '-t' to use a temperature gradient, which makes the
2023 gradient values change depending on the amplitude of a
2024 particular graph value (try it and see).
2030 <option>memmax</option>
2033 <listitem>Total amount of memory
2039 <option>memperc</option>
2042 <listitem>Percentage of memory in use
2048 <option>mixer</option>
2050 <option>(device)</option>
2052 <listitem>Prints the mixer value as reported by the OS.
2053 Default mixer is "vol", but you can specify one of the
2054 following optional arguments: "vol", "bass", "treble",
2055 "synth", "pcm", "speaker", "line", "mic", "cd", "mix",
2056 "pcm2", "rec", "igain", "ogain", "line1", "line2", "line3",
2057 "dig1", "dig2", "dig3", "phin", "phout", "video", "radio",
2058 "monitor". Refer to the definition of SOUND_DEVICE_NAMES in
2059 <linux/soundcard.h> (on Linux), <soundcard.h>
2060 (on OpenBSD), or <sys/soundcard.h> to find the exact
2061 options available on your system.
2067 <option>mixerbar</option>
2069 <option>(device)</option>
2071 <listitem>Displays mixer value in a bar as reported by the
2072 OS. See docs for $mixer for details on arguments.
2078 <option>mixerl</option>
2080 <option>(device)</option>
2082 <listitem>Prints the left channel mixer value as reported
2083 by the OS. See docs for $mixer for details on arguments.
2089 <option>mixerlbar</option>
2091 <option>(device)</option>
2093 <listitem>Displays the left channel mixer value in a bar as
2094 reported by the OS. See docs for $mixer for details on
2101 <option>mixerr</option>
2103 <option>(device)</option>
2105 <listitem>Prints the right channel mixer value as reported
2106 by the OS. See docs for $mixer for details on arguments.
2112 <option>mixerrbar</option>
2114 <option>(device)</option>
2116 <listitem>Displays the right channel mixer value in a bar
2117 as reported by the OS. See docs for $mixer for details on
2124 <option>moc_album</option>
2127 <listitem>Album of the current MOC song
2133 <option>moc_artist</option>
2136 <listitem>Artist of the current MOC song
2142 <option>moc_bitrate</option>
2145 <listitem>Bitrate in the current MOC song
2151 <option>moc_curtime</option>
2154 <listitem>Current time of the current MOC song
2160 <option>moc_file</option>
2163 <listitem>File name of the current MOC song
2169 <option>moc_rate</option>
2172 <listitem>Rate of the current MOC song
2178 <option>moc_song</option>
2181 <listitem>The current song name being played in MOC.
2187 <option>moc_state</option>
2190 <listitem>Current state of MOC; playing, stopped etc.
2196 <option>moc_timeleft</option>
2199 <listitem>Time left in the current MOC song
2205 <option>moc_title</option>
2208 <listitem>Title of the current MOC song
2214 <option>moc_totaltime</option>
2217 <listitem>Total length of the current MOC song
2223 <option>monitor</option>
2226 <listitem>Number of the monitor on which conky is running
2227 or the message "Not running in X" if this is the case.
2233 <option>monitor_number</option>
2236 <listitem>Number of monitors or the message "Not running in
2237 X" if this is the case.
2243 <option>mpd_album</option>
2246 <listitem>Album in current MPD song
2252 <option>mpd_artist</option>
2255 <listitem>Artist in current MPD song must be enabled at
2262 <option>mpd_bar</option>
2264 <option>(height),(width)</option>
2266 <listitem>Bar of mpd's progress
2272 <option>mpd_bitrate</option>
2275 <listitem>Bitrate of current song
2281 <option>mpd_elapsed</option>
2284 <listitem>Song's elapsed time
2290 <option>mpd_file</option>
2293 <listitem>Prints the file name of the current MPD song
2299 <option>mpd_length</option>
2302 <listitem>Song's length
2308 <option>mpd_name</option>
2311 <listitem>Prints the MPD name field
2317 <option>mpd_percent</option>
2320 <listitem>Percent of song's progress
2326 <option>mpd_random</option>
2329 <listitem>Random status (On/Off)
2335 <option>mpd_repeat</option>
2338 <listitem>Repeat status (On/Off)
2344 <option>mpd_smart</option>
2346 <option>(max length)</option>
2348 <listitem>Prints the song name in either the form "artist -
2349 title" or file name, depending on whats available
2355 <option>mpd_status</option>
2358 <listitem>Playing, stopped, et cetera.
2364 <option>mpd_title</option>
2366 <option>(max length)</option>
2368 <listitem>Title of current MPD song
2374 <option>mpd_track</option>
2377 <listitem>Prints the MPD track field
2383 <option>mpd_vol</option>
2386 <listitem>MPD's volume
2392 <option>nameserver</option>
2394 <option>(index)</option>
2396 <listitem>Print a nameserver from /etc/resolv.conf. Index
2397 starts at and defaults to 0.
2403 <option>new_mails</option>
2405 <option>(mailbox)</option>
2406 <option>(interval)</option>
2408 <listitem>Unread mail count in the specified mailbox or
2409 mail spool if not. Both mbox and maildir type mailboxes are
2416 <option>nodename</option>
2425 <option>nvidia</option>
2427 <option>threshold</option>
2428 <option>temp</option>
2429 <option>ambient</option>
2430 <option>gpufreq</option>
2431 <option>memfreq</option>
2432 <option>imagequality</option>
2434 <listitem>Nvidia graficcard support for the XNVCtrl
2435 library. Each option can be shortened to the least
2436 significant part. Temperatures are printed as float, all
2437 other values as integer.
2440 <command>threshold</command>
2441 <option>The thresholdtemperature at
2442 which the gpu slows down</option>
2445 <command>temp</command>
2446 <option>Gives the gpu current
2447 temperature</option>
2450 <command>ambient</command>
2451 <option>Gives current air temperature near GPU
2455 <command>gpufreq</command>
2456 <option>Gives the current gpu frequency</option>
2459 <command>memfreq</command>
2460 <option>Gives the current mem frequency</option>
2463 <command>imagequality</command>
2464 <option>Which imagequality should be chosen by
2465 OpenGL applications</option>
2473 <option>offset</option>
2475 <option>(pixels)</option>
2477 <listitem>Move text over by N pixels. See also $voffset.
2483 <option>outlinecolor</option>
2485 <option>(color)</option>
2487 <listitem>Change outline color
2493 <option>pb_battery</option>
2495 <option>item</option>
2497 <listitem>If running on Apple powerbook/ibook, display
2498 information on battery status. The item parameter
2499 specifies, what information to display. Exactly one item
2500 must be specified. Valid items are:
2503 <command>status</command>
2504 <option>Display if battery is fully charged,
2505 charging, discharging or absent (running on
2509 <command>percent</command>
2510 <option>Display charge of battery in percent, if
2511 charging or discharging. Nothing will be displayed,
2512 if battery is fully charged or absent.</option>
2515 <command>time</command>
2516 <option>Display the time remaining until the
2517 battery will be fully charged or discharged at
2518 current rate. Nothing is displayed, if battery is
2519 absent or if it's present but fully charged and not
2520 discharging.</option>
2528 <option>pid_chroot</option>
2530 <option>pid</option>
2532 <listitem>Directory used as rootdirectory by the process
2533 (this will be "/" unless the process did a chroot syscall)
2539 <option>pid_cmdline</option>
2541 <option>pid</option>
2543 <listitem>Command line this process was invoked with
2549 <option>pid_cwd</option>
2551 <option>pid</option>
2553 <listitem>Current working directory of the process
2559 <option>pid_environ</option>
2561 <option>pid varname</option>
2563 <listitem>Contents of a environment-var of the process
2569 <option>pid_environ_list</option>
2571 <option>pid</option>
2573 <listitem>List of environment-vars that the process can see
2579 <option>pid_exe</option>
2581 <option>pid</option>
2583 <listitem>Path to executed command that started the process
2589 <option>pid_nice</option>
2591 <option>pid</option>
2593 <listitem>The nice value of the process
2599 <option>pid_openfiles</option>
2601 <option>pid</option>
2603 <listitem>List of files that the process has open
2609 <option>pid_parent</option>
2611 <option>pid</option>
2613 <listitem>The pid of the parent of the process
2619 <option>pid_priority</option>
2621 <option>pid</option>
2623 <listitem>The priority of the process (see 'priority' in "man 5 proc")
2629 <option>pid_read</option>
2631 <option>pid</option>
2633 <listitem>Total number of bytes read by the process
2639 <option>pid_state</option>
2641 <option>pid</option>
2643 <listitem>State of the process
2649 <option>pid_state_short</option>
2651 <option>pid</option>
2653 <listitem>One of the chars in "RSDZTW" representing the state
2654 of the process where R is running, S is sleeping in an
2655 interruptible wait, D is waiting in uninterruptible disk sleep,
2656 Z is zombie, T is traced or stopped (on a signal), and W is paging
2662 <option>pid_stderr</option>
2664 <option>pid</option>
2666 <listitem>Filedescriptor binded to the STDERR of the process
2672 <option>pid_stdin</option>
2674 <option>pid</option>
2676 <listitem>Filedescriptor binded to the STDIN of the process
2682 <option>pid_stdout</option>
2684 <option>pid</option>
2686 <listitem>Filedescriptor binded to the STDOUT of the process
2692 <option>pid_threads</option>
2694 <option>pid</option>
2696 <listitem>Number of threads in process containing this thread
2702 <option>pid_thread_list</option>
2704 <option>pid</option>
2706 <listitem>List with pid's from threads from this process
2712 <option>pid_time_kernelmode</option>
2714 <option>pid</option>
2716 <listitem>Amount of time that the process has been scheduled in kernel mode in seconds
2722 <option>pid_time_usermode</option>
2724 <option>pid</option>
2726 <listitem>Amount of time that the process has been scheduled in user mode in seconds
2732 <option>pid_time</option>
2734 <option>pid</option>
2736 <listitem>Sum of $pid_time_kernelmode and $pid_time_usermode
2742 <option>pid_uid</option>
2744 <option>pid</option>
2746 <listitem>The real uid of the process
2752 <option>pid_euid</option>
2754 <option>pid</option>
2756 <listitem>The effective uid of the process
2762 <option>pid_suid</option>
2764 <option>pid</option>
2766 <listitem>The saved set uid of the process
2772 <option>pid_fsuid</option>
2774 <option>pid</option>
2776 <listitem>The file system uid of the process
2782 <option>pid_gid</option>
2784 <option>pid</option>
2786 <listitem>The real gid of the process
2792 <option>pid_egid</option>
2794 <option>pid</option>
2796 <listitem>The effective gid of the process
2802 <option>pid_sgid</option>
2804 <option>pid</option>
2806 <listitem>The saved set gid of the process
2812 <option>pid_fsgid</option>
2814 <option>pid</option>
2816 <listitem>The file system gid of the process
2822 <option>pid_vmpeak</option>
2824 <option>pid</option>
2826 <listitem>Peak virtual memory size of the process
2832 <option>pid_vmsize</option>
2834 <option>pid</option>
2836 <listitem>Virtual memory size of the process
2842 <option>pid_vmlck</option>
2844 <option>pid</option>
2846 <listitem>Locked memory size of the process
2852 <option>pid_vmhwm</option>
2854 <option>pid</option>
2856 <listitem>Peak resident set size ("high water mark") of the process
2862 <option>pid_vmrss</option>
2864 <option>pid</option>
2866 <listitem>Resident set size of the process
2872 <option>pid_vmdata</option>
2874 <option>pid</option>
2876 <listitem>Data segment size of the process
2882 <option>pid_vmstk</option>
2884 <option>pid</option>
2886 <listitem>Stack segment size of the process
2892 <option>pid_vmexe</option>
2894 <option>pid</option>
2896 <listitem>Text segment size of the process
2902 <option>pid_vmlib</option>
2904 <option>pid</option>
2906 <listitem>Shared library code size of the process
2912 <option>pid_vmpte</option>
2914 <option>pid</option>
2916 <listitem>Page table entries size of the process
2922 <option>pid_write</option>
2924 <option>pid</option>
2926 <listitem>Total number of bytes written by the process
2932 <option>platform</option>
2934 <option>(dev) type n (factor offset)</option>
2936 <listitem>Platform sensor from sysfs (Linux 2.6). Parameter
2937 dev may be omitted if you have only one platform device.
2938 Platform type is either 'in' or 'vol' meaning voltage;
2939 'fan' meaning fan; 'temp' meaning temperature. Parameter n
2940 is number of the sensor. See /sys/bus/platform/devices/ on
2941 your local computer. The optional arguments 'factor' and
2942 'offset' allow precalculation of the raw input, which is
2943 being modified as follows: 'input = input * factor +
2944 offset'. Note that they have to be given as decimal values
2945 (i.e. contain at least one decimal place).
2951 <option>pop3_unseen</option>
2953 <option>(args)</option>
2955 <listitem>Displays the number of unseen messages in your
2956 global POP3 inbox by default. You can define individual
2957 POP3 inboxes separately by passing arguments to this
2958 object. Arguments are: "host user pass [-i interval (in
2959 seconds)] [-p port] [-e 'command'] [-r retries]". Default
2960 port is 110, default interval is 5 minutes, and default
2961 number of retries before giving up is 5. If the password is
2962 supplied as '*', you will be prompted to enter the password
2969 <option>pop3_used</option>
2971 <option>(args)</option>
2973 <listitem>Displays the amount of space (in MiB, 2^20) used
2974 in your global POP3 inbox by default. You can define
2975 individual POP3 inboxes separately by passing arguments to
2976 this object. Arguments are: "host user pass [-i interval
2977 (in seconds)] [-p port] [-e 'command'] [-r retries]". Default
2978 port is 110, default interval is 5 minutes, and default
2979 number of retries before giving up is 5. If the password is
2980 supplied as '*', you will be prompted to enter the password
2987 <option>pre_exec</option>
2989 <option>shell command</option>
2991 <listitem>Executes a shell command one time before conky
2992 displays anything and puts output as text.
2998 <option>processes</option>
3001 <listitem>Total processes (sleeping and running)
3007 <option>read_tcp</option>
3009 <option>(host) port</option>
3011 <listitem>Connects to a tcp port on a host (default is
3012 localhost), reads every char available at the moment and
3019 <option>replied_mails</option>
3021 <option>(maildir)</option>
3022 <option>(interval)</option>
3024 <listitem>Number of mails marked as replied in the
3025 specified mailbox or mail spool if not. Only maildir type
3026 mailboxes are supported, mbox type will return -1.
3032 <option>rss</option>
3034 <option>uri interval_in_minutes action (num_par
3035 (spaces_in_front))</option>
3038 <para>Download and parse RSS feeds. The interval may be
3039 a floating point value greater than 0, otherwise
3040 defaults to 15 minutes. Action may be one of the
3041 following: feed_title, item_title (with num par),
3042 item_desc (with num par) and item_titles (when using
3043 this action and spaces_in_front is given conky places
3044 that many spaces in front of each item). This object is
3045 threaded, and once a thread is created it can't be
3046 explicitly destroyed. One thread will run for each URI
3047 specified. You can use any protocol that Curl
3054 <option>running_processes</option>
3057 <listitem>Running processes (not sleeping), requires Linux
3064 <option>running_threads</option>
3067 <listitem>Number of running (runnable) threads. Linux only.
3073 <option>scroll</option>
3075 <option>length (step) text</option>
3077 <listitem>Scroll 'text' by 'step' characters showing
3078 'length' number of characters at the same time. The text
3079 may also contain variables. 'step' is optional and defaults
3080 to 1 if not set. If a var creates output on multiple lines
3081 then the lines are placed behind each other separated with
3082 a '|'-sign. If you change the textcolor inside $scroll it
3083 will automatically have it's old value back at the end of
3084 $scroll. The end and the start of text will be separated by
3085 'length' number of spaces.
3091 <option>seen_mails</option>
3093 <option>(maildir)</option>
3094 <option>(interval)</option>
3096 <listitem>Number of mails marked as seen in the specified
3097 mailbox or mail spool if not. Only maildir type mailboxes
3098 are supported, mbox type will return -1.
3104 <option>shadecolor</option>
3106 <option>(color)</option>
3108 <listitem>Change shading color
3114 <option>smapi</option>
3116 <option>(ARGS)</option>
3118 <listitem>when using smapi, display contents of the
3119 /sys/devices/platform/smapi directory. ARGS are either
3120 '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the
3121 corresponding files' content. This is a very raw method of
3122 accessing the smapi values. When available, better use one
3123 of the smapi_* variables instead.
3129 <option>smapi_bat_bar</option>
3131 <option>(INDEX),(height),(width)</option>
3133 <listitem>when using smapi, display the remaining capacity
3134 of the battery with index INDEX as a bar.
3140 <option>smapi_bat_perc</option>
3142 <option>(INDEX)</option>
3144 <listitem>when using smapi, display the remaining capacity
3145 in percent of the battery with index INDEX. This is a
3146 separate variable because it supports the 'use_spacer'
3147 configuration option.
3153 <option>smapi_bat_power</option>
3155 <option>INDEX</option>
3157 <listitem>when using smapi, display the current power of
3158 the battery with index INDEX in watt. This is a separate
3159 variable because the original read out value is being
3160 converted from mW. The sign of the output reflects charging
3161 (positive) or discharging (negative) state.
3167 <option>smapi_bat_temp</option>
3169 <option>INDEX</option>
3171 <listitem>when using smapi, display the current temperature
3172 of the battery with index INDEX in degree Celsius. This is
3173 a separate variable because the original read out value is
3174 being converted from milli degree Celsius.
3180 <option>sony_fanspeed</option>
3183 <listitem>Displays the Sony VAIO fanspeed information if
3184 sony-laptop kernel support is enabled. Linux only.
3190 <option>stippled_hr</option>
3192 <option>(space)</option>
3194 <listitem>Stippled (dashed) horizontal line
3200 <option>swap</option>
3203 <listitem>Amount of swap in use
3209 <option>swapbar</option>
3211 <option>(height),(width)</option>
3213 <listitem>Bar that shows amount of swap in use
3219 <option>swapfree</option>
3222 <listitem>Amount of free swap
3228 <option>swapmax</option>
3231 <listitem>Total amount of swap
3237 <option>swapperc</option>
3240 <listitem>Percentage of swap in use
3246 <option>sysname</option>
3249 <listitem>System name, Linux for example
3255 <option>tab</option>
3257 <option>(width, (start))</option>
3259 <listitem>Puts a tab of the specified width, starting from
3260 column 'start'. The unit is pixels for both arguments.
3266 <option>tail</option>
3268 <option>logfile lines (next_check)</option>
3270 <listitem>Displays last N lines of supplied text file. The
3271 file is checked every 'next_check' update. If next_check is
3272 not supplied, Conky defaults to 2. Max of 30 lines can be
3273 displayed, or until the text buffer is filled.
3279 <option>tcp_portmon</option>
3281 <option>port_begin port_end item (index)</option>
3284 <para>TCP port (both IPv6 and IPv4) monitor for
3285 specified local ports. Port numbers must be in
3286 the range 1 to 65535. Valid items are:</para>
3289 <command>count</command>
3290 <option>Total number of connections in the
3294 <command>rip</command>
3295 <option>Remote ip address</option>
3298 <command>rhost</command>
3299 <option>Remote host name</option>
3302 <command>rport</command>
3303 <option>Remote port number</option>
3306 <command>rservice</command>
3307 <option>Remote service name from
3308 /etc/services</option>
3311 <command>lip</command>
3312 <option>Local ip address</option>
3315 <command>lhost</command>
3316 <option>Local host name</option>
3319 <command>lport</command>
3320 <option>Local port number</option>
3323 <command>lservice</command>
3324 <option>Local service name from
3325 /etc/services</option>
3328 <para>The connection index provides you with access to
3329 each connection in the port monitor. The monitor will
3330 return information for index values from 0 to n-1
3331 connections. Values higher than n-1 are simply ignored.
3332 For the "count" item, the connection index must be
3333 omitted. It is required for all other items.</para>
3334 <para>Examples:</para>
3337 <command>${tcp_portmon 6881 6999
3339 <option>Displays the number of connections in
3340 the bittorrent port range</option>
3343 <command>${tcp_portmon 22 22 rip 0}</command>
3344 <option>Displays the remote host ip of the
3345 first sshd connection</option>
3348 <command>${tcp_portmon 22 22 rip 9}</command>
3349 <option>Displays the remote host ip of the
3350 tenth sshd connection</option>
3353 <command>${tcp_portmon 1 1024 rhost
3355 <option>Displays the remote host name of the
3356 first connection on a privileged port</option>
3359 <command>${tcp_portmon 1 1024 rport
3361 <option>Displays the remote host port of the
3362 fifth connection on a privileged port</option>
3365 <command>${tcp_portmon 1 65535 lservice
3367 <option>Displays the local service name of the
3368 fifteenth connection in the range of all
3372 <para>Note that port monitor variables which share the
3373 same port range actually refer to the same monitor, so
3374 many references to a single port range for different
3375 items and different indexes all use the same monitor
3376 internally. In other words, the program avoids creating
3377 redundant monitors.</para>
3383 <option>templateN</option>
3385 <option>(arg1)</option>
3386 <option>(arg2)</option>
3387 <option>(arg3 ...)</option>
3390 <para>Evaluate the content of the templateN
3391 configuration variable (where N is a value between 0
3392 and 9, inclusively), applying substitutions as
3393 described in the documentation of the corresponding
3394 configuration variable. The number of arguments is
3395 optional, but must match the highest referred index in
3396 the template. You can use the same special sequences in
3397 each argument as the ones valid for a template
3398 definition, e.g. to allow an argument to contain a
3399 whitespace. Also simple nesting of templates is
3400 possible this way.</para>
3401 <para>Here are some examples of template
3404 <member>template0 $\1\2</member>
3405 <member>template1 \1: ${fs_used \2} / ${fs_size
3407 <member>template2 \1 \2</member>
3409 <para>The following list shows sample usage of the
3410 templates defined above, with the equivalent syntax
3411 when not using any template at all:</para>
3416 <entry>using template</entry>
3417 <entry>same without template</entry>
3422 <entry>${template0 node name}</entry>
3423 <entry>$nodename</entry>
3426 <entry>${template1 root /}</entry>
3427 <entry>root: ${fs_free /} / ${fs_size
3433 ${template2\ disk\ root}
3438 ${fs_free /} / ${fs_size
3450 <option>texeci</option>
3452 <option>interval command</option>
3454 <listitem>Runs a command at an interval inside a thread and
3455 displays the output. Same as $execi, except the command is
3456 run inside a thread. Use this if you have a slow script to
3457 keep Conky updating. You should make the interval slightly
3458 longer then the time it takes your script to execute. For
3459 example, if you have a script that take 5 seconds to
3460 execute, you should make the interval at least 6 seconds.
3461 See also $execi. This object will clean up the thread when
3462 it is destroyed, so it can safely be used in a nested
3463 fashion, though it may not produce the desired behaviour if
3470 <option>threads</option>
3473 <listitem>Total threads
3479 <option>time</option>
3481 <option>(format)</option>
3483 <listitem>Local time, see man strftime to get more
3484 information about format
3490 <option>to_bytes</option>
3492 <option>size</option>
3494 <listitem>If 'size' is a number followed by a size-unit
3495 (kilobyte,mb,GiB,...) then it converts the size to bytes
3496 and shows it without unit, otherwise it just shows 'size'.
3502 <option>top</option>
3504 <option>type num</option>
3506 <listitem>This takes arguments in the form:top (name)
3507 (number) Basically, processes are ranked from highest to
3508 lowest in terms of cpu usage, which is what (num)
3509 represents. The types are: "name", "pid", "cpu", "mem",
3510 "mem_res", "mem_vsize", "time", "io_perc", "io_read" and
3511 "io_write". There can be a max of 10 processes listed.
3517 <option>top_io</option>
3519 <option>type num</option>
3521 <listitem>Same as top, except sorted by the amount of I/O
3522 the process has done during the update interval
3528 <option>top_mem</option>
3530 <option>type num</option>
3532 <listitem>Same as top, except sorted by mem usage instead
3539 <option>top_time</option>
3541 <option>type num</option>
3543 <listitem>Same as top, except sorted by total CPU time
3544 instead of current CPU usage
3550 <option>totaldown</option>
3552 <option>(net)</option>
3554 <listitem>Total download, overflows at 4 GB on Linux with
3555 32-bit arch and there doesn't seem to be a way to know how
3556 many times it has already done that before conky has
3563 <option>totalup</option>
3565 <option>(net)</option>
3567 <listitem>Total upload, this one too, may overflow
3573 <option>trashed_mails</option>
3575 <option>(maildir)</option>
3576 <option>(interval)</option>
3578 <listitem>Number of mails marked as trashed in the
3579 specified mailbox or mail spool if not. Only maildir type
3580 mailboxes are supported, mbox type will return -1.
3586 <option>tztime</option>
3588 <option>(timezone (format))</option>
3590 <listitem>Local time for specified timezone, see man
3591 strftime to get more information about format. The timezone
3592 argument is specified in similar fashion as TZ environment
3593 variable. For hints, look in /usr/share/zoneinfo. e.g.
3594 US/Pacific, Europe/Zurich, etc.
3600 <option>gid_name</option>
3602 <option>gid</option>
3604 <listitem>Name of group with this gid
3610 <option>uid_name</option>
3612 <option>uid</option>
3614 <listitem>Username of user with this uid
3620 <option>unflagged_mails</option>
3622 <option>(maildir)</option>
3623 <option>(interval)</option>
3625 <listitem>Number of mails not marked as flagged in the
3626 specified mailbox or mail spool if not. Only maildir type
3627 mailboxes are supported, mbox type will return -1.
3633 <option>unforwarded_mails</option>
3635 <option>(maildir)</option>
3636 <option>(interval)</option>
3638 <listitem>Number of mails not marked as forwarded in the
3639 specified mailbox or mail spool if not. Only maildir type
3640 mailboxes are supported, mbox type will return -1.
3646 <option>unreplied_mails</option>
3648 <option>(maildir)</option>
3649 <option>(interval)</option>
3651 <listitem>Number of mails not marked as replied in the
3652 specified mailbox or mail spool if not. Only maildir type
3653 mailboxes are supported, mbox type will return -1.
3659 <option>unseen_mails</option>
3661 <option>(maildir)</option>
3662 <option>(interval)</option>
3664 <listitem>Number of new or unseen mails in the specified
3665 mailbox or mail spool if not. Only maildir type mailboxes
3666 are supported, mbox type will return -1.
3672 <option>updates</option>
3674 <option>Number of updates</option>
3676 <listitem>for debugging
3682 <option>upspeed</option>
3684 <option>(net)</option>
3686 <listitem>Upload speed in suitable IEC units
3692 <option>upspeedf</option>
3694 <option>(net)</option>
3696 <listitem>Upload speed in KiB with one decimal
3702 <option>upspeedgraph</option>
3704 <option>(netdev) (height),(width) (gradient colour 1)
3705 (gradient colour 2) (scale) (-t) (-l)</option>
3707 <listitem>Upload speed graph, colours defined in hex, minus
3708 the #. If scale is non-zero, it becomes the scale for the
3709 graph. Uses a logarithmic scale (to see small numbers) when
3710 you use the -l switch. Takes the switch '-t' to use a
3711 temperature gradient, which makes the gradient values
3712 change depending on the amplitude of a particular graph
3713 value (try it and see).
3719 <option>uptime</option>
3728 <option>uptime_short</option>
3731 <listitem>Uptime in a shorter format
3737 <option>user_names</option>
3740 <listitem>Lists the names of the users logged in
3746 <option>user_number</option>
3749 <listitem>Number of users logged in
3755 <option>user_terms</option>
3758 <listitem>Lists the consoles in use
3764 <option>user_times</option>
3767 <listitem>Lists how long users have been logged in for
3773 <option>user_time</option>
3775 <option>console</option>
3777 <listitem>Lists how long the user for the given console has been
3784 <option>utime</option>
3786 <option>(format)</option>
3788 <listitem>Display time in UTC (universal coordinate time).
3794 <option>voffset</option>
3796 <option>(pixels)</option>
3798 <listitem>Change vertical offset by N pixels. Negative
3799 values will cause text to overlap. See also $offset.
3805 <option>voltage_mv</option>
3807 <option>(n)</option>
3809 <listitem>Returns CPU #n's voltage in mV. CPUs are counted
3810 from 1. If omitted, the parameter defaults to 1.
3816 <option>voltage_v</option>
3818 <option>(n)</option>
3820 <listitem>Returns CPU #n's voltage in V. CPUs are counted
3821 from 1. If omitted, the parameter defaults to 1.
3827 <option>weather</option>
3829 <option>URI locID data_type
3830 (interval_in_minutes)</option>
3833 <para>Download, parse and display METAR data.</para>
3834 <para>For the 'URI', there are two
3835 possibilities:</para>
3838 http://weather.noaa.gov/pub/data/observations/metar/stations/</member>
3840 http://xoap.weather.com/weather/local/</member>
3842 <para>The first one is free to use but the second
3843 requires you to register and obtain your partner ID and
3844 license key. These two must be written, separated by a
3845 space, into a file called .xoaprc which needs to be
3846 placed into your home directory.</para>
3847 <para>'locID' must be a valid location identifier for
3848 the required uri. For the NOAA site this must be a
3849 valid ICAO (see for instance
3850 https://pilotweb.nas.faa.gov/qryhtml/icao/). For the
3851 weather.com site this must be a valid location ID (see
3853 http://aspnetresources.com/tools/locid.aspx).</para>
3854 <para>'data_type' must be one of the following:</para>
3857 <command>last_update</command>
3858 <para>The date and time stamp of the data.
3859 The result depends on the URI used. For the
3860 NOAA site it is date (yyyy/mm/dd) and UTC time.
3861 For the weather.com one it is date
3862 ([m]m/[d]d/yy) and Local Time of the
3866 <command>temperature</command>
3867 <para>Air temperature (you can use the
3868 'temperature_unit' config setting to change
3872 <command>cloud_cover</command>
3873 <para>The highest cloud cover status</para>
3876 <command>pressure</command>
3877 <para>Air pressure in millibar</para>
3880 <command>wind_speed</command>
3881 <para>Wind speed in km/h</para>
3884 <command>wind_dir</command>
3885 <para>Wind direction</para>
3888 <command>wind_dir_DEG</command>
3889 <para>Compass wind direction</para>
3892 <command>humidity</command>
3893 <para>Relative humidity in %</para>
3896 <command>weather</command>
3897 <para>Any relevant weather event (rain, snow,
3898 etc.). This is not used if you are querying the
3899 weather.com site since this data is aggregated
3900 into the cloud_cover one</para>
3903 <command>icon</command>
3904 <para>Weather icon (only for
3905 www.weather.com). Can be used together with the
3906 icon kit provided upon registering to their
3910 <para>'delay_in_minutes' (optional, default 30) cannot
3911 be less than 30 minutes.</para>
3912 <para>This object is threaded, and once a thread is
3913 created it can't be explicitly destroyed. One thread
3914 will run for each URI specified.</para>
3915 <para>Note that these variables are still EXPERIMENTAL
3916 and can be subject to many future changes.</para>
3922 <option>weather_forecast</option>
3924 <option>URI locID day data_type
3925 (interval_in_minutes)</option>
3928 <para>Download, parse and display weather forecast data
3929 for a given day (daytime only).</para>
3930 <para>For the 'URI', for the time being only
3931 http://xoap.weather.com/weather/local/ is
3932 supported. See 'weather' above for details of usage</para>
3933 <para>'locID', see 'weather' above.</para>
3934 <para>'day' is a number from 0 (today) to 4 (3 days
3935 after tomorrow).</para>
3936 <para>'data_type' must be one of the following:</para>
3939 <command>day</command>
3940 <option>Day of the week</option>
3943 <command>date</command>
3944 <option>Date, in the form MMM DD (ie. Jul 14)</option>
3947 <command>low</command>
3948 <option>Minimun temperature (you can use the
3949 'temperature_unit' config setting to change
3953 <command>hi</command>
3954 <option>Maximum temperature (you can use the
3955 'temperature_unit' config setting to change
3959 <command>icon</command>
3960 <option>Weather icon. Can be used together with the
3961 icon kit provided upon registering to the weather.com
3965 <command>forecast</command>
3966 <option>Weather forecast (sunny, rainy, etc.)</option>
3969 <command>wind_speed</command>
3970 <option>Wind speed in km/h</option>
3973 <command>wind_dir</command>
3974 <option>Wind direction</option>
3977 <command>wind_dir_DEG</command>
3978 <option>Compass wind direction</option>
3981 <command>humidity</command>
3982 <option>Relative humidity in %</option>
3985 <command>precipitation</command>
3986 <option>Probability of having a
3987 precipitation (in %)</option>
3990 <para>'delay_in_minutes' (optional, default 210) cannot
3991 be lower than 210 min.</para>
3992 <para>This object is threaded, and once a thread is
3993 created it can't be explicitly destroyed. One thread
3994 will run for each URI specified. You can use any
3995 protocol that Curl supports.</para>
3996 <para>Note that these variables are still EXPERIMENTAL
3997 and can be subject to many future changes.</para>
4003 <option>wireless_ap</option>
4005 <option>(net)</option>
4007 <listitem>Wireless access point MAC address (Linux only)
4013 <option>wireless_bitrate</option>
4015 <option>(net)</option>
4017 <listitem>Wireless bitrate (ie 11 Mb/s) (Linux only)
4023 <option>wireless_essid</option>
4025 <option>(net)</option>
4027 <listitem>Wireless access point ESSID (Linux only)
4033 <option>wireless_link_bar</option>
4035 <option>(height),(width) (net)</option>
4037 <listitem>Wireless link quality bar (Linux only)
4043 <option>wireless_link_qual</option>
4045 <option>(net)</option>
4047 <listitem>Wireless link quality (Linux only)
4053 <option>wireless_link_qual_max</option>
4055 <option>(net)</option>
4057 <listitem>Wireless link quality maximum value (Linux only)
4063 <option>wireless_link_qual_perc</option>
4065 <option>(net)</option>
4067 <listitem>Wireless link quality in percents (Linux only)
4073 <option>wireless_mode</option>
4075 <option>(net)</option>
4077 <listitem>Wireless mode (Managed/Ad-Hoc/Master) (Linux
4084 <option>words</option>
4086 <option>textfile</option>
4088 <listitem>Displays the number of words in the given file
4094 <option>xmms2_album</option>
4097 <listitem>Album in current XMMS2 song
4103 <option>xmms2_artist</option>
4106 <listitem>Artist in current XMMS2 song
4112 <option>xmms2_bar</option>
4114 <option>(height),(width)</option>
4116 <listitem>Bar of XMMS2's progress
4122 <option>xmms2_bitrate</option>
4125 <listitem>Bitrate of current song
4131 <option>xmms2_comment</option>
4134 <listitem>Comment in current XMMS2 song
4140 <option>xmms2_date</option>
4143 <listitem>Returns song's date.
4149 <option>xmms2_duration</option>
4152 <listitem>Duration of current song
4158 <option>xmms2_elapsed</option>
4161 <listitem>Song's elapsed time
4167 <option>xmms2_genre</option>
4170 <listitem>Genre in current XMMS2 song
4176 <option>xmms2_id</option>
4179 <listitem>XMMS2 id of current song
4185 <option>xmms2_percent</option>
4188 <listitem>Percent of song's progress
4194 <option>xmms2_playlist</option>
4197 <listitem>Returns the XMMS2 playlist.
4203 <option>xmms2_size</option>
4206 <listitem>Size of current song
4212 <option>xmms2_smart</option>
4215 <listitem>Prints the song name in either the form "artist -
4216 title" or file name, depending on whats available
4222 <option>xmms2_status</option>
4225 <listitem>XMMS2 status (Playing, Paused, Stopped, or
4232 <option>xmms2_timesplayed</option>
4235 <listitem>Number of times a song was played (presumably).
4241 <option>xmms2_title</option>
4244 <listitem>Title in current XMMS2 song
4250 <option>xmms2_tracknr</option>
4253 <listitem>Track number in current XMMS2 song
4259 <option>xmms2_url</option>
4262 <listitem>Full path to current song
projects / monky / blob