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 (' '). You may also use
1004 double-quotes around the exec argument should you need to execute a
1005 command with spaces. For example, ${execgraph "date +'%S'"} to execute
1006 `date +'%S'` and graph the result. Without quotes, it would simply
1007 print the result of `date`.
1013 <option>execi</option>
1015 <option>interval command</option>
1017 <listitem>Same as exec but with specific interval. Interval
1018 can't be less than update_interval in configuration. See
1025 <option>execibar</option>
1027 <option>interval command</option>
1029 <listitem>Same as execbar, except with an interval
1035 <option>execigauge</option>
1037 <option>interval command</option>
1039 <listitem>Same as execgauge, but takes an interval arg and
1046 <option>execigraph</option>
1048 <option>interval (-t) (-l) command</option>
1050 <listitem>Same as execgraph, but takes an interval arg and
1051 graphs values. If -t or -l is your first argument, you may
1052 need to preceed it by a space (' ').
1058 <option>execp</option>
1060 <option>command</option>
1062 <listitem>Executes a shell command and displays the output
1063 in conky. warning: this takes a lot more resources than
1064 other variables. I'd recommend coding wanted behaviour in C
1065 and posting a patch. This differs from $exec in that it
1066 parses the output of the command, so you can insert things
1067 like ${color red}hi!${color} in your script and have it
1068 correctly parsed by Conky. Caveats: Conky parses and
1069 evaluates the output of $execp every time Conky loops, and
1070 then destroys all the objects. If you try to use anything
1071 like $execi within an $execp statement, it will
1072 functionally run at the same interval that the $execp
1073 statement runs, as it is created and destroyed at every
1080 <option>execpi</option>
1082 <option>interval command</option>
1084 <listitem>Same as execp but with specific interval.
1085 Interval can't be less than update_interval in
1086 configuration. Note that the output from the $execpi
1087 command is still parsed and evaluated at every interval.
1093 <option>flagged_mails</option>
1095 <option>(maildir)</option>
1096 <option>(interval)</option>
1098 <listitem>Number of mails marked as flagged in the
1099 specified mailbox or mail spool if not. Only maildir type
1100 mailboxes are supported, mbox type will return -1.
1106 <option>font</option>
1108 <option>(font)</option>
1110 <listitem>Specify a different font. This new font will
1111 apply to the current line and everything following. You can
1112 use a $font with no arguments to change back to the default
1113 font (much like with $color)
1119 <option>format_time</option>
1121 <option>seconds format</option>
1123 <listitem>Format time given in seconds. This var only works when
1124 the times_in_seconds configuration setting is on. Format is a string
1125 that should start and end with a "-char. The "-chars are not
1126 part of the output, \w,\d,\h,\m,\s,\(,\) and \\ are replaced by
1127 weeks,days,hours,minutes,seconds,(,) and \. If you leave out a unit,
1128 it's value will be expressed in the highest unite lower then the
1129 one left out. Text between ()-chars will not be visible if a
1130 replaced unit in this text is 0. If seconds is a decimal number
1131 then you can see the numbers behind the point by using \S
1132 followed by a number that specifies the amount of
1133 digits behind the point that you want to see (maximum 9).
1134 You can also place a 'x' behind \S so you have all digits behind
1135 the point and no trailing zero's. (also maximum 9)
1141 <option>forwarded_mails</option>
1143 <option>(maildir)</option>
1144 <option>(interval)</option>
1146 <listitem>Number of mails marked as forwarded in the
1147 specified mailbox or mail spool if not. Only maildir type
1148 mailboxes are supported, mbox type will return -1.
1154 <option>freq</option>
1156 <option>(n)</option>
1158 <listitem>Returns CPU #n's frequency in MHz. CPUs are
1159 counted from 1. If omitted, the parameter defaults to 1.
1165 <option>freq_g</option>
1167 <option>(n)</option>
1169 <listitem>Returns CPU #n's frequency in GHz. CPUs are
1170 counted from 1. If omitted, the parameter defaults to 1.
1176 <option>fs_bar</option>
1178 <option>(height),(width) fs</option>
1180 <listitem>Bar that shows how much space is used on a file
1181 system. height is the height in pixels. fs is any file on
1188 <option>fs_bar_free</option>
1190 <option>(height),(width) fs</option>
1192 <listitem>Bar that shows how much space is free on a file
1193 system. height is the height in pixels. fs is any file on
1200 <option>fs_free</option>
1202 <option>(fs)</option>
1204 <listitem>Free space on a file system available for users.
1210 <option>fs_free_perc</option>
1212 <option>(fs)</option>
1214 <listitem>Free percentage of space on a file system
1215 available for users.
1221 <option>fs_size</option>
1223 <option>(fs)</option>
1225 <listitem>File system size.
1231 <option>fs_type</option>
1233 <option>(fs)</option>
1235 <listitem>File system type.
1241 <option>fs_used</option>
1243 <option>(fs)</option>
1245 <listitem>File system used space.
1251 <option>fs_used_perc</option>
1253 <option>(fs)</option>
1255 <listitem>Percent of file system used space.
1261 <option>goto</option>
1265 <listitem>The next element will be printed at position 'x'.
1272 <option>gw_iface</option>
1275 <listitem>Displays the default route's interface or
1276 "multiple"/"none" accordingly.
1282 <option>gw_ip</option>
1285 <listitem>Displays the default gateway's IP or
1286 "multiple"/"none" accordingly.
1292 <option>hddtemp</option>
1294 <option>(dev)</option>
1296 <listitem>Displays temperature of a selected hard disk
1297 drive as reported by the hddtemp daemon. Use hddtemp_host
1298 and hddtemp_port to specify a host and port for all hddtemp
1299 objects. If no dev parameter is given, the first disk returned
1300 by the hddtemp daemon is used.
1306 <option>head</option>
1308 <option>logfile lines (next_check)</option>
1310 <listitem>Displays first N lines of supplied text file. The
1311 file is checked every 'next_check' update. If next_check is
1312 not supplied, Conky defaults to 2. Max of 30 lines can be
1313 displayed, or until the text buffer is filled.
1321 <option>(height)</option>
1323 <listitem>Horizontal line, height is the height in pixels
1329 <option>hwmon</option>
1331 <option>(dev) type n (factor offset)</option>
1333 <listitem>Hwmon sensor from sysfs (Linux 2.6). Parameter
1334 dev may be omitted if you have only one hwmon device.
1335 Parameter type is either 'in' or 'vol' meaning voltage;
1336 'fan' meaning fan; 'temp' meaning temperature. Parameter n
1337 is number of the sensor. See /sys/class/hwmon/ on your
1338 local computer. The optional arguments 'factor' and
1339 'offset' allow precalculation of the raw input, which is
1340 being modified as follows: 'input = input * factor +
1341 offset'. Note that they have to be given as decimal values
1342 (i.e. contain at least one decimal place).
1348 <option>i2c</option>
1350 <option>(dev) type n (factor offset)</option>
1352 <listitem>I2C sensor from sysfs (Linux 2.6). Parameter dev
1353 may be omitted if you have only one I2C device. Parameter
1354 type is either 'in' or 'vol' meaning voltage; 'fan' meaning
1355 fan; 'temp' meaning temperature. Parameter n is number of
1356 the sensor. See /sys/bus/i2c/devices/ on your local
1357 computer. The optional arguments 'factor' and 'offset'
1358 allow precalculation of the raw input, which is being
1359 modified as follows: 'input = input * factor + offset'.
1360 Note that they have to be given as decimal values (i.e.
1361 contain at least one decimal place).
1367 <option>i8k_ac_status</option>
1371 <listitem>If running the i8k kernel driver for Inspiron
1372 laptops, displays whether ac power is on, as listed in
1373 /proc/i8k (translated to human-readable). Beware that this
1374 is by default not enabled by i8k itself.
1380 <option>i8k_bios</option>
1384 <listitem>If running the i8k kernel driver for Inspiron
1385 laptops, displays the bios version as listed in /proc/i8k.
1391 <option>i8k_buttons_status</option>
1395 <listitem>If running the i8k kernel driver for Inspiron
1396 laptops, displays the volume buttons status as listed in
1403 <option>i8k_cpu_temp</option>
1407 <listitem>If running the i8k kernel driver for Inspiron
1408 laptops, displays the cpu temperature in Celsius, as
1409 reported by /proc/i8k.
1415 <option>i8k_left_fan_rpm</option>
1419 <listitem>If running the i8k kernel driver for Inspiron
1420 laptops, displays the left fan's rate of rotation, in
1421 revolutions per minute as listed in /proc/i8k. Beware, some
1422 laptops i8k reports these fans in reverse order.
1428 <option>i8k_left_fan_status</option>
1432 <listitem>If running the i8k kernel driver for Inspiron
1433 laptops, displays the left fan status as listed in
1434 /proc/i8k (translated to human-readable). Beware, some
1435 laptops i8k reports these fans in reverse order.
1441 <option>i8k_right_fan_rpm</option>
1445 <listitem>If running the i8k kernel driver for Inspiron
1446 laptops, displays the right fan's rate of rotation, in
1447 revolutions per minute as listed in /proc/i8k. Beware, some
1448 laptops i8k reports these fans in reverse order.
1454 <option>i8k_right_fan_status</option>
1458 <listitem>If running the i8k kernel driver for Inspiron
1459 laptops, displays the right fan status as listed in
1460 /proc/i8k (translated to human-readable). Beware, some
1461 laptops i8k reports these fans in reverse order.
1467 <option>i8k_serial</option>
1471 <listitem>If running the i8k kernel driver for Inspiron
1472 laptops, displays your laptop serial number as listed in
1479 <option>i8k_version</option>
1483 <listitem>If running the i8k kernel driver for Inspiron
1484 laptops, displays the version formatting of /proc/i8k.
1490 <option>ibm_brightness</option>
1493 <listitem>If running the IBM ACPI, displays the brigtness
1494 of the laptops's LCD (0-7).
1500 <option>ibm_fan</option>
1503 <listitem>If running the IBM ACPI, displays the fan speed.
1509 <option>ibm_temps</option>
1513 <listitem>If running the IBM ACPI, displays the
1514 temperatures from the IBM temperature sensors (N=0..7)
1515 Sensor 0 is on the CPU, 3 is on the GPU.
1521 <option>ibm_volume</option>
1524 <listitem>If running the IBM ACPI, displays the "master"
1525 volume, controlled by the volume keys (0-14).
1531 <option>iconv_start</option>
1533 <option>codeset_from codeset_to</option>
1535 <listitem>Convert text from one codeset to another using
1536 GNU iconv. Needs to be stopped with iconv_stop.
1542 <option>iconv_stop</option>
1546 <listitem>Stop iconv codeset conversion.
1552 <option>if_empty</option>
1554 <option>(var)</option>
1556 <listitem>if conky variable VAR is empty, display
1557 everything between $if_empty and the matching $endif
1563 <option>if_existing</option>
1565 <option>file (string)</option>
1567 <listitem>if FILE exists, display everything between
1568 if_existing and the matching $endif. The optional second
1569 paramater checks for FILE containing the specified string
1570 and prints everything between $if_existing and the matching
1577 <option>if_gw</option>
1580 <listitem>if there is at least one default gateway, display
1581 everything between $if_gw and the matching $endif
1587 <option>if_match</option>
1589 <option>expression</option>
1591 <listitem>Evaluates the given boolean expression, printing
1592 everything between $if_match and the matching $endif
1593 depending on whether the evaluation returns true or not.
1594 Valid expressions consist of a left side, an operator and a
1595 right side. Left and right sides are being parsed for
1596 contained text objects before evaluation. Recognised left
1597 and right side types are:
1600 <command>double</command>Argument consists of only
1601 digits and a single dot.</member>
1603 <command>long</command>Argument consists of only
1606 <command>string</command>Argument is enclosed in
1607 quotation marks (")</member>
1608 </simplelist>Valid operands are: '>', '<', '>=',
1609 '<=', '==', '!='.
1615 <option>if_mixer_mute</option>
1617 <option>(mixer)</option>
1619 <listitem>If mixer exists, display everything between
1620 $if_mixer_mute and the matching $endif. If no mixer is
1621 specified, "Master" is used.
1627 <option>if_mounted</option>
1629 <option>(mountpoint)</option>
1631 <listitem>if MOUNTPOINT is mounted, display everything
1632 between $if_mounted and the matching $endif
1638 <option>if_mpd_playing</option>
1641 <listitem>if mpd is playing or paused, display everything
1642 between $if_mpd_playing and the matching $endif
1648 <option>if_running</option>
1650 <option>(process)</option>
1652 <listitem>if PROCESS is running, display everything
1653 $if_running and the matching $endif. This uses the
1654 ``pidof'' command, so the -x switch is also supported.
1660 <option>if_smapi_bat_installed</option>
1662 <option>(INDEX)</option>
1664 <listitem>when using smapi, if the battery with index INDEX
1665 is installed, display everything between
1666 $if_smapi_bat_installed and the matching $endif
1672 <option>if_up</option>
1674 <option>(interface)</option>
1676 <listitem>if INTERFACE exists and is up, display everything
1677 between $if_up and the matching $endif
1683 <option>if_updatenr</option>
1685 <option>(updatenr)</option>
1687 <listitem>If it's the UPDATENR-th time that conky updates,
1688 display everything between $if_updatenr and the matching
1689 $endif. The counter resets when the highest UPDATENR is
1690 reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr
1691 2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the
1692 time followed by bar 25% of the time followed by nothing
1693 the other half of the time.
1699 <option>if_xmms2_connected</option>
1702 <listitem>Display everything between $if_xmms2_connected
1703 and the matching $endif if xmms2 is running.
1709 <option>image</option>
1711 <option><path to image> (-p x,y) (-s WxH) (-n)
1712 (-f interval)</option>
1714 <listitem>Renders an image from the path specified using
1715 Imlib2. Takes 4 optional arguments: a position, a size, a
1716 no-cache switch, and a cache flush interval. Changing the
1717 x,y position will move the position of the image, and
1718 changing the WxH will scale the image. If you specify the
1719 no-cache flag (-n), the image will not be cached.
1720 Alternately, you can specify the -f int switch to specify a
1721 cache flust interval for a particular image. Example:
1722 ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200}
1723 will render 'cheeseburger.jpg' at (20,20) scaled to 200x200
1724 pixels. Conky does not make any attempt to adjust the
1725 position (or any other formatting) of images, they are just
1726 rendered as per the arguments passed. The only reason
1727 $image is part of the TEXT section, is to allow for runtime
1728 modifications, through $execp $lua_parse, or some other
1735 <option>imap_messages</option>
1737 <option>(args)</option>
1739 <listitem>Displays the number of messages in your global
1740 IMAP inbox by default. You can define individual IMAP
1741 inboxes separately by passing arguments to this object.
1742 Arguments are: "host user pass [-i interval (in seconds)]
1743 [-f 'folder'] [-p port] [-e 'command'] [-r retries]". Default
1744 port is 143, default folder is 'INBOX', default interval is
1745 5 minutes, and default number of retries before giving up
1746 is 5. If the password is supplied as '*', you will be
1747 prompted to enter the password when Conky starts.
1753 <option>imap_unseen</option>
1755 <option>(args)</option>
1757 <listitem>Displays the number of unseen messages in your
1758 global IMAP inbox by default. You can define individual
1759 IMAP inboxes separately by passing arguments to this
1760 object. Arguments are: "host user pass [-i interval (in
1761 seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r retries]".
1762 Default port is 143, default folder is 'INBOX', default
1763 interval is 5 minutes, and default number of retries before
1764 giving up is 5. If the password is supplied as '*', you
1765 will be prompted to enter the password when Conky starts.
1771 <option>include</option>
1773 <option>path</option>
1776 <para>Loads the configfile at path, places the
1777 configsettings behind the configsettings in the orginal
1778 config and places the vars where the includevar
1785 <option>ioscheduler</option>
1787 <option>disk</option>
1789 <listitem>Prints the current ioscheduler used for the given
1790 disk name (i.e. e.g. "hda" or "sdb")
1796 <option>kernel</option>
1799 <listitem>Kernel version
1805 <option>laptop_mode</option>
1808 <listitem>The value of /proc/sys/vm/laptop_mode
1814 <option>lines</option>
1816 <option>textfile</option>
1818 <listitem>Displays the number of lines in the given file
1824 <option>loadavg</option>
1826 <option>(1|2|3)</option>
1828 <listitem>System load average, 1 is for past 1 minute, 2
1829 for past 5 minutes and 3 for past 15 minutes. Without argument, prints
1830 all three values separated by whitespace.
1836 <option>loadgraph</option>
1838 <option>(height),(width) (gradient colour 1)
1839 (gradient colour 2) (scale) (-t) (-l)</option>
1841 <listitem>Load1 average graph, similar to xload, with
1842 optional colours in hex, minus the #. Uses a logarithmic
1843 scale (to see small numbers) when you use the -l switch.
1844 Takes the switch '-t' to use a temperature gradient, which
1845 makes the gradient values change depending on the amplitude
1846 of a particular graph value (try it and see).
1852 <option>lua</option>
1854 <option>function_name (function parameters)</option>
1856 <listitem>Executes a Lua function with given parameters,
1857 then prints the returned string. See also 'lua_load' on how
1858 to load scripts. Conky puts 'conky_' in front of
1859 function_name to prevent accidental calls to the wrong
1860 function unless you put you place 'conky_' in front of it
1867 <option>lua_bar</option>
1869 <option>(height, width) function_name (function
1870 parameters)</option>
1872 <listitem>Executes a Lua function with given parameters and
1873 draws a bar. Expects result value to be an integer between
1874 0 and 100. See also 'lua_load' on how to load scripts.
1875 Conky puts 'conky_' in front of function_name to prevent
1876 accidental calls to the wrong function unless you put you
1877 place 'conky_' in front of it yourself.
1883 <option>lua_gauge</option>
1885 <option>(height, width) function_name (function
1886 parameters)</option>
1888 <listitem>Executes a Lua function with given parameters and
1889 draws a gauge. Expects result value to be an integer
1890 between 0 and 100. See also 'lua_load' on how to load
1891 scripts. Conky puts 'conky_' in front of function_name to
1892 prevent accidental calls to the wrong function unless you
1893 put you place 'conky_' in front of it yourself.
1899 <option>lua_graph</option>
1901 <option>function_name (height),(width) (gradient colour
1902 1) (gradient colour 2) (scale) (-t) (-l)</option>
1904 <listitem>Executes a Lua function with and draws a graph.
1905 Expects result value to be any number, and by default will
1906 scale to show the full range. See also 'lua_load' on how to
1907 load scripts. Takes the switch '-t' to use a temperature
1908 gradient, which makes the gradient values change depending
1909 on the amplitude of a particular graph value (try it and
1910 see). Conky puts 'conky_' in front of function_name to
1911 prevent accidental calls to the wrong function unless you
1912 put you place 'conky_' in front of it yourself.
1918 <option>lua_parse</option>
1920 <option>function_name (function parameters)</option>
1922 <listitem>Executes a Lua function with given parameters as
1923 per $lua, then parses and prints the result value as per
1924 the syntax for Conky's TEXT section. See also 'lua_load' on
1925 how to load scripts. Conky puts 'conky_' in front of
1926 function_name to prevent accidental calls to the wrong
1927 function unless you put you place 'conky_' in front of it
1934 <option>machine</option>
1937 <listitem>Machine, i686 for example
1943 <option>mails</option>
1945 <option>(mailbox)</option>
1946 <option>(interval)</option>
1948 <listitem>Mail count in the specified mailbox or your mail
1949 spool if not. Both mbox and maildir type mailboxes are
1950 supported. You can use a program like fetchmail to get
1951 mails from some server using your favourite protocol. See
1958 <option>mboxscan</option>
1960 <option>(-n number of messages to print) (-fw from
1961 width) (-sw subject width) mbox</option>
1963 <listitem>Print a summary of recent messages in an mbox
1964 format mailbox. mbox parameter is the filename of the
1965 mailbox (can be encapsulated using '"', ie. ${mboxscan -n
1966 10 "/home/brenden/some box"}
1972 <option>mem</option>
1975 <listitem>Amount of memory in use
1981 <option>membar</option>
1983 <option>(height),(width)</option>
1985 <listitem>Bar that shows amount of memory in use
1991 <option>memeasyfree</option>
1994 <listitem>Amount of free memory including the memory that
1995 is very easily freed (buffers/cache)
2001 <option>memfree</option>
2004 <listitem>Amount of free memory
2010 <option>memgauge</option>
2012 <option>(height),(width)</option>
2014 <listitem>Gauge that shows amount of memory in use (see
2021 <option>memgraph</option>
2023 <option>(height),(width) (gradient colour 1) (gradient
2024 colour 2) (scale) (-t) (-l)</option>
2026 <listitem>Memory usage graph. Uses a logarithmic scale (to
2027 see small numbers) when you use the -l switch. Takes the
2028 switch '-t' to use a temperature gradient, which makes the
2029 gradient values change depending on the amplitude of a
2030 particular graph value (try it and see).
2036 <option>memmax</option>
2039 <listitem>Total amount of memory
2045 <option>memperc</option>
2048 <listitem>Percentage of memory in use
2054 <option>mixer</option>
2056 <option>(device)</option>
2058 <listitem>Prints the mixer value as reported by the OS.
2059 Default mixer is "Master", but you can specify one of the
2060 available ALSA Simple mixer controls.
2061 You can find the list of those available on your system
2068 <option>mixerbar</option>
2070 <option>(device)</option>
2072 <listitem>Displays mixer value in a bar as reported by the
2073 OS. See docs for $mixer for details on arguments.
2079 <option>mixerl</option>
2081 <option>(device)</option>
2083 <listitem>Prints the left channel mixer value as reported
2084 by the OS. See docs for $mixer for details on arguments.
2090 <option>mixerlbar</option>
2092 <option>(device)</option>
2094 <listitem>Displays the left channel mixer value in a bar as
2095 reported by the OS. See docs for $mixer for details on
2102 <option>mixerr</option>
2104 <option>(device)</option>
2106 <listitem>Prints the right channel mixer value as reported
2107 by the OS. See docs for $mixer for details on arguments.
2113 <option>mixerrbar</option>
2115 <option>(device)</option>
2117 <listitem>Displays the right channel mixer value in a bar
2118 as reported by the OS. See docs for $mixer for details on
2125 <option>moc_album</option>
2128 <listitem>Album of the current MOC song
2134 <option>moc_artist</option>
2137 <listitem>Artist of the current MOC song
2143 <option>moc_bitrate</option>
2146 <listitem>Bitrate in the current MOC song
2152 <option>moc_curtime</option>
2155 <listitem>Current time of the current MOC song
2161 <option>moc_file</option>
2164 <listitem>File name of the current MOC song
2170 <option>moc_rate</option>
2173 <listitem>Rate of the current MOC song
2179 <option>moc_song</option>
2182 <listitem>The current song name being played in MOC.
2188 <option>moc_state</option>
2191 <listitem>Current state of MOC; playing, stopped etc.
2197 <option>moc_timeleft</option>
2200 <listitem>Time left in the current MOC song
2206 <option>moc_title</option>
2209 <listitem>Title of the current MOC song
2215 <option>moc_totaltime</option>
2218 <listitem>Total length of the current MOC song
2224 <option>monitor</option>
2227 <listitem>Number of the monitor on which conky is running
2228 or the message "Not running in X" if this is the case.
2234 <option>monitor_number</option>
2237 <listitem>Number of monitors or the message "Not running in
2238 X" if this is the case.
2244 <option>mpd_album</option>
2247 <listitem>Album in current MPD song
2253 <option>mpd_artist</option>
2256 <listitem>Artist in current MPD song must be enabled at
2263 <option>mpd_bar</option>
2265 <option>(height),(width)</option>
2267 <listitem>Bar of mpd's progress
2273 <option>mpd_bitrate</option>
2276 <listitem>Bitrate of current song
2282 <option>mpd_elapsed</option>
2285 <listitem>Song's elapsed time
2291 <option>mpd_file</option>
2294 <listitem>Prints the file name of the current MPD song
2300 <option>mpd_length</option>
2303 <listitem>Song's length
2309 <option>mpd_name</option>
2312 <listitem>Prints the MPD name field
2318 <option>mpd_percent</option>
2321 <listitem>Percent of song's progress
2327 <option>mpd_random</option>
2330 <listitem>Random status (On/Off)
2336 <option>mpd_repeat</option>
2339 <listitem>Repeat status (On/Off)
2345 <option>mpd_smart</option>
2347 <option>(max length)</option>
2349 <listitem>Prints the song name in either the form "artist -
2350 title" or file name, depending on whats available
2356 <option>mpd_status</option>
2359 <listitem>Playing, stopped, et cetera.
2365 <option>mpd_title</option>
2367 <option>(max length)</option>
2369 <listitem>Title of current MPD song
2375 <option>mpd_track</option>
2378 <listitem>Prints the MPD track field
2384 <option>mpd_vol</option>
2387 <listitem>MPD's volume
2393 <option>nameserver</option>
2395 <option>(index)</option>
2397 <listitem>Print a nameserver from /etc/resolv.conf. Index
2398 starts at and defaults to 0.
2404 <option>new_mails</option>
2406 <option>(mailbox)</option>
2407 <option>(interval)</option>
2409 <listitem>Unread mail count in the specified mailbox or
2410 mail spool if not. Both mbox and maildir type mailboxes are
2417 <option>nodename</option>
2426 <option>nodename_short</option>
2429 <listitem>Short hostname (same as 'hostname -s' shell command).
2435 <option>nvidia</option>
2437 <option>threshold</option>
2438 <option>temp</option>
2439 <option>ambient</option>
2440 <option>gpufreq</option>
2441 <option>memfreq</option>
2442 <option>imagequality</option>
2444 <listitem>Nvidia graficcard support for the XNVCtrl
2445 library. Each option can be shortened to the least
2446 significant part. Temperatures are printed as float, all
2447 other values as integer.
2450 <command>threshold</command>
2451 <option>The thresholdtemperature at
2452 which the gpu slows down</option>
2455 <command>temp</command>
2456 <option>Gives the gpu current
2457 temperature</option>
2460 <command>ambient</command>
2461 <option>Gives current air temperature near GPU
2465 <command>gpufreq</command>
2466 <option>Gives the current gpu frequency</option>
2469 <command>memfreq</command>
2470 <option>Gives the current mem frequency</option>
2473 <command>imagequality</command>
2474 <option>Which imagequality should be chosen by
2475 OpenGL applications</option>
2483 <option>offset</option>
2485 <option>(pixels)</option>
2487 <listitem>Move text over by N pixels. See also $voffset.
2493 <option>outlinecolor</option>
2495 <option>(color)</option>
2497 <listitem>Change outline color
2503 <option>pb_battery</option>
2505 <option>item</option>
2507 <listitem>If running on Apple powerbook/ibook, display
2508 information on battery status. The item parameter
2509 specifies, what information to display. Exactly one item
2510 must be specified. Valid items are:
2513 <command>status</command>
2514 <option>Display if battery is fully charged,
2515 charging, discharging or absent (running on
2519 <command>percent</command>
2520 <option>Display charge of battery in percent, if
2521 charging or discharging. Nothing will be displayed,
2522 if battery is fully charged or absent.</option>
2525 <command>time</command>
2526 <option>Display the time remaining until the
2527 battery will be fully charged or discharged at
2528 current rate. Nothing is displayed, if battery is
2529 absent or if it's present but fully charged and not
2530 discharging.</option>
2538 <option>pid_chroot</option>
2540 <option>pid</option>
2542 <listitem>Directory used as rootdirectory by the process
2543 (this will be "/" unless the process did a chroot syscall)
2549 <option>pid_cmdline</option>
2551 <option>pid</option>
2553 <listitem>Command line this process was invoked with
2559 <option>pid_cwd</option>
2561 <option>pid</option>
2563 <listitem>Current working directory of the process
2569 <option>pid_environ</option>
2571 <option>pid varname</option>
2573 <listitem>Contents of a environment-var of the process
2579 <option>pid_environ_list</option>
2581 <option>pid</option>
2583 <listitem>List of environment-vars that the process can see
2589 <option>pid_exe</option>
2591 <option>pid</option>
2593 <listitem>Path to executed command that started the process
2599 <option>pid_nice</option>
2601 <option>pid</option>
2603 <listitem>The nice value of the process
2609 <option>pid_openfiles</option>
2611 <option>pid</option>
2613 <listitem>List of files that the process has open
2619 <option>pid_parent</option>
2621 <option>pid</option>
2623 <listitem>The pid of the parent of the process
2629 <option>pid_priority</option>
2631 <option>pid</option>
2633 <listitem>The priority of the process (see 'priority' in "man 5 proc")
2639 <option>pid_read</option>
2641 <option>pid</option>
2643 <listitem>Total number of bytes read by the process
2649 <option>pid_state</option>
2651 <option>pid</option>
2653 <listitem>State of the process
2659 <option>pid_state_short</option>
2661 <option>pid</option>
2663 <listitem>One of the chars in "RSDZTW" representing the state
2664 of the process where R is running, S is sleeping in an
2665 interruptible wait, D is waiting in uninterruptible disk sleep,
2666 Z is zombie, T is traced or stopped (on a signal), and W is paging
2672 <option>pid_stderr</option>
2674 <option>pid</option>
2676 <listitem>Filedescriptor binded to the STDERR of the process
2682 <option>pid_stdin</option>
2684 <option>pid</option>
2686 <listitem>Filedescriptor binded to the STDIN of the process
2692 <option>pid_stdout</option>
2694 <option>pid</option>
2696 <listitem>Filedescriptor binded to the STDOUT of the process
2702 <option>pid_threads</option>
2704 <option>pid</option>
2706 <listitem>Number of threads in process containing this thread
2712 <option>pid_thread_list</option>
2714 <option>pid</option>
2716 <listitem>List with pid's from threads from this process
2722 <option>pid_time_kernelmode</option>
2724 <option>pid</option>
2726 <listitem>Amount of time that the process has been scheduled in kernel mode in seconds
2732 <option>pid_time_usermode</option>
2734 <option>pid</option>
2736 <listitem>Amount of time that the process has been scheduled in user mode in seconds
2742 <option>pid_time</option>
2744 <option>pid</option>
2746 <listitem>Sum of $pid_time_kernelmode and $pid_time_usermode
2752 <option>pid_uid</option>
2754 <option>pid</option>
2756 <listitem>The real uid of the process
2762 <option>pid_euid</option>
2764 <option>pid</option>
2766 <listitem>The effective uid of the process
2772 <option>pid_suid</option>
2774 <option>pid</option>
2776 <listitem>The saved set uid of the process
2782 <option>pid_fsuid</option>
2784 <option>pid</option>
2786 <listitem>The file system uid of the process
2792 <option>pid_gid</option>
2794 <option>pid</option>
2796 <listitem>The real gid of the process
2802 <option>pid_egid</option>
2804 <option>pid</option>
2806 <listitem>The effective gid of the process
2812 <option>pid_sgid</option>
2814 <option>pid</option>
2816 <listitem>The saved set gid of the process
2822 <option>pid_fsgid</option>
2824 <option>pid</option>
2826 <listitem>The file system gid of the process
2832 <option>pid_vmpeak</option>
2834 <option>pid</option>
2836 <listitem>Peak virtual memory size of the process
2842 <option>pid_vmsize</option>
2844 <option>pid</option>
2846 <listitem>Virtual memory size of the process
2852 <option>pid_vmlck</option>
2854 <option>pid</option>
2856 <listitem>Locked memory size of the process
2862 <option>pid_vmhwm</option>
2864 <option>pid</option>
2866 <listitem>Peak resident set size ("high water mark") of the process
2872 <option>pid_vmrss</option>
2874 <option>pid</option>
2876 <listitem>Resident set size of the process
2882 <option>pid_vmdata</option>
2884 <option>pid</option>
2886 <listitem>Data segment size of the process
2892 <option>pid_vmstk</option>
2894 <option>pid</option>
2896 <listitem>Stack segment size of the process
2902 <option>pid_vmexe</option>
2904 <option>pid</option>
2906 <listitem>Text segment size of the process
2912 <option>pid_vmlib</option>
2914 <option>pid</option>
2916 <listitem>Shared library code size of the process
2922 <option>pid_vmpte</option>
2924 <option>pid</option>
2926 <listitem>Page table entries size of the process
2932 <option>pid_write</option>
2934 <option>pid</option>
2936 <listitem>Total number of bytes written by the process
2942 <option>platform</option>
2944 <option>(dev) type n (factor offset)</option>
2946 <listitem>Platform sensor from sysfs (Linux 2.6). Parameter
2947 dev may be omitted if you have only one platform device.
2948 Platform type is either 'in' or 'vol' meaning voltage;
2949 'fan' meaning fan; 'temp' meaning temperature. Parameter n
2950 is number of the sensor. See /sys/bus/platform/devices/ on
2951 your local computer. The optional arguments 'factor' and
2952 'offset' allow precalculation of the raw input, which is
2953 being modified as follows: 'input = input * factor +
2954 offset'. Note that they have to be given as decimal values
2955 (i.e. contain at least one decimal place).
2961 <option>pop3_unseen</option>
2963 <option>(args)</option>
2965 <listitem>Displays the number of unseen messages in your
2966 global POP3 inbox by default. You can define individual
2967 POP3 inboxes separately by passing arguments to this
2968 object. Arguments are: "host user pass [-i interval (in
2969 seconds)] [-p port] [-e 'command'] [-r retries]". Default
2970 port is 110, default interval is 5 minutes, and default
2971 number of retries before giving up is 5. If the password is
2972 supplied as '*', you will be prompted to enter the password
2979 <option>pop3_used</option>
2981 <option>(args)</option>
2983 <listitem>Displays the amount of space (in MiB, 2^20) used
2984 in your global POP3 inbox by default. You can define
2985 individual POP3 inboxes separately by passing arguments to
2986 this object. Arguments are: "host user pass [-i interval
2987 (in seconds)] [-p port] [-e 'command'] [-r retries]". Default
2988 port is 110, default interval is 5 minutes, and default
2989 number of retries before giving up is 5. If the password is
2990 supplied as '*', you will be prompted to enter the password
2997 <option>pre_exec</option>
2999 <option>shell command</option>
3001 <listitem>Executes a shell command one time before conky
3002 displays anything and puts output as text.
3008 <option>processes</option>
3011 <listitem>Total processes (sleeping and running)
3017 <option>read_tcp</option>
3019 <option>(host) port</option>
3021 <listitem>Connects to a tcp port on a host (default is
3022 localhost), reads every char available at the moment and
3029 <option>replied_mails</option>
3031 <option>(maildir)</option>
3032 <option>(interval)</option>
3034 <listitem>Number of mails marked as replied in the
3035 specified mailbox or mail spool if not. Only maildir type
3036 mailboxes are supported, mbox type will return -1.
3042 <option>rss</option>
3044 <option>uri interval_in_minutes action (num_par
3045 (spaces_in_front))</option>
3048 <para>Download and parse RSS feeds. The interval may be
3049 a floating point value greater than 0, otherwise
3050 defaults to 15 minutes. Action may be one of the
3051 following: feed_title, item_title (with num par),
3052 item_desc (with num par) and item_titles (when using
3053 this action and spaces_in_front is given conky places
3054 that many spaces in front of each item). This object is
3055 threaded, and once a thread is created it can't be
3056 explicitly destroyed. One thread will run for each URI
3057 specified. You can use any protocol that Curl
3064 <option>running_processes</option>
3067 <listitem>Running processes (not sleeping), requires Linux
3074 <option>running_threads</option>
3077 <listitem>Number of running (runnable) threads. Linux only.
3083 <option>scroll</option>
3085 <option>length (step) text</option>
3087 <listitem>Scroll 'text' by 'step' characters showing
3088 'length' number of characters at the same time. The text
3089 may also contain variables. 'step' is optional and defaults
3090 to 1 if not set. If a var creates output on multiple lines
3091 then the lines are placed behind each other separated with
3092 a '|'-sign. If you change the textcolor inside $scroll it
3093 will automatically have it's old value back at the end of
3094 $scroll. The end and the start of text will be separated by
3095 'length' number of spaces.
3101 <option>seen_mails</option>
3103 <option>(maildir)</option>
3104 <option>(interval)</option>
3106 <listitem>Number of mails marked as seen in the specified
3107 mailbox or mail spool if not. Only maildir type mailboxes
3108 are supported, mbox type will return -1.
3114 <option>shadecolor</option>
3116 <option>(color)</option>
3118 <listitem>Change shading color
3124 <option>smapi</option>
3126 <option>(ARGS)</option>
3128 <listitem>when using smapi, display contents of the
3129 /sys/devices/platform/smapi directory. ARGS are either
3130 '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the
3131 corresponding files' content. This is a very raw method of
3132 accessing the smapi values. When available, better use one
3133 of the smapi_* variables instead.
3139 <option>smapi_bat_bar</option>
3141 <option>(INDEX),(height),(width)</option>
3143 <listitem>when using smapi, display the remaining capacity
3144 of the battery with index INDEX as a bar.
3150 <option>smapi_bat_perc</option>
3152 <option>(INDEX)</option>
3154 <listitem>when using smapi, display the remaining capacity
3155 in percent of the battery with index INDEX. This is a
3156 separate variable because it supports the 'use_spacer'
3157 configuration option.
3163 <option>smapi_bat_power</option>
3165 <option>INDEX</option>
3167 <listitem>when using smapi, display the current power of
3168 the battery with index INDEX in watt. This is a separate
3169 variable because the original read out value is being
3170 converted from mW. The sign of the output reflects charging
3171 (positive) or discharging (negative) state.
3177 <option>smapi_bat_temp</option>
3179 <option>INDEX</option>
3181 <listitem>when using smapi, display the current temperature
3182 of the battery with index INDEX in degree Celsius. This is
3183 a separate variable because the original read out value is
3184 being converted from milli degree Celsius.
3190 <option>sony_fanspeed</option>
3193 <listitem>Displays the Sony VAIO fanspeed information if
3194 sony-laptop kernel support is enabled. Linux only.
3200 <option>stippled_hr</option>
3202 <option>(space)</option>
3204 <listitem>Stippled (dashed) horizontal line
3210 <option>swap</option>
3213 <listitem>Amount of swap in use
3219 <option>swapbar</option>
3221 <option>(height),(width)</option>
3223 <listitem>Bar that shows amount of swap in use
3229 <option>swapfree</option>
3232 <listitem>Amount of free swap
3238 <option>swapmax</option>
3241 <listitem>Total amount of swap
3247 <option>swapperc</option>
3250 <listitem>Percentage of swap in use
3256 <option>sysname</option>
3259 <listitem>System name, Linux for example
3265 <option>tab</option>
3267 <option>(width, (start))</option>
3269 <listitem>Puts a tab of the specified width, starting from
3270 column 'start'. The unit is pixels for both arguments.
3276 <option>tail</option>
3278 <option>logfile lines (next_check)</option>
3280 <listitem>Displays last N lines of supplied text file. The
3281 file is checked every 'next_check' update. If next_check is
3282 not supplied, Conky defaults to 2. Max of 30 lines can be
3283 displayed, or until the text buffer is filled.
3289 <option>tcp_portmon</option>
3291 <option>port_begin port_end item (index)</option>
3294 <para>TCP port (both IPv6 and IPv4) monitor for
3295 specified local ports. Port numbers must be in
3296 the range 1 to 65535. Valid items are:</para>
3299 <command>count</command>
3300 <option>Total number of connections in the
3304 <command>rip</command>
3305 <option>Remote ip address</option>
3308 <command>rhost</command>
3309 <option>Remote host name</option>
3312 <command>rport</command>
3313 <option>Remote port number</option>
3316 <command>rservice</command>
3317 <option>Remote service name from
3318 /etc/services</option>
3321 <command>lip</command>
3322 <option>Local ip address</option>
3325 <command>lhost</command>
3326 <option>Local host name</option>
3329 <command>lport</command>
3330 <option>Local port number</option>
3333 <command>lservice</command>
3334 <option>Local service name from
3335 /etc/services</option>
3338 <para>The connection index provides you with access to
3339 each connection in the port monitor. The monitor will
3340 return information for index values from 0 to n-1
3341 connections. Values higher than n-1 are simply ignored.
3342 For the "count" item, the connection index must be
3343 omitted. It is required for all other items.</para>
3344 <para>Examples:</para>
3347 <command>${tcp_portmon 6881 6999
3349 <option>Displays the number of connections in
3350 the bittorrent port range</option>
3353 <command>${tcp_portmon 22 22 rip 0}</command>
3354 <option>Displays the remote host ip of the
3355 first sshd connection</option>
3358 <command>${tcp_portmon 22 22 rip 9}</command>
3359 <option>Displays the remote host ip of the
3360 tenth sshd connection</option>
3363 <command>${tcp_portmon 1 1024 rhost
3365 <option>Displays the remote host name of the
3366 first connection on a privileged port</option>
3369 <command>${tcp_portmon 1 1024 rport
3371 <option>Displays the remote host port of the
3372 fifth connection on a privileged port</option>
3375 <command>${tcp_portmon 1 65535 lservice
3377 <option>Displays the local service name of the
3378 fifteenth connection in the range of all
3382 <para>Note that port monitor variables which share the
3383 same port range actually refer to the same monitor, so
3384 many references to a single port range for different
3385 items and different indexes all use the same monitor
3386 internally. In other words, the program avoids creating
3387 redundant monitors.</para>
3393 <option>templateN</option>
3395 <option>(arg1)</option>
3396 <option>(arg2)</option>
3397 <option>(arg3 ...)</option>
3400 <para>Evaluate the content of the templateN
3401 configuration variable (where N is a value between 0
3402 and 9, inclusively), applying substitutions as
3403 described in the documentation of the corresponding
3404 configuration variable. The number of arguments is
3405 optional, but must match the highest referred index in
3406 the template. You can use the same special sequences in
3407 each argument as the ones valid for a template
3408 definition, e.g. to allow an argument to contain a
3409 whitespace. Also simple nesting of templates is
3410 possible this way.</para>
3411 <para>Here are some examples of template
3414 <member>template0 $\1\2</member>
3415 <member>template1 \1: ${fs_used \2} / ${fs_size
3417 <member>template2 \1 \2</member>
3419 <para>The following list shows sample usage of the
3420 templates defined above, with the equivalent syntax
3421 when not using any template at all:</para>
3426 <entry>using template</entry>
3427 <entry>same without template</entry>
3432 <entry>${template0 node name}</entry>
3433 <entry>$nodename</entry>
3436 <entry>${template1 root /}</entry>
3437 <entry>root: ${fs_free /} / ${fs_size
3443 ${template2\ disk\ root}
3448 ${fs_free /} / ${fs_size
3460 <option>texeci</option>
3462 <option>interval command</option>
3464 <listitem>Runs a command at an interval inside a thread and
3465 displays the output. Same as $execi, except the command is
3466 run inside a thread. Use this if you have a slow script to
3467 keep Conky updating. You should make the interval slightly
3468 longer then the time it takes your script to execute. For
3469 example, if you have a script that take 5 seconds to
3470 execute, you should make the interval at least 6 seconds.
3471 See also $execi. This object will clean up the thread when
3472 it is destroyed, so it can safely be used in a nested
3473 fashion, though it may not produce the desired behaviour if
3480 <option>threads</option>
3483 <listitem>Total threads
3489 <option>time</option>
3491 <option>(format)</option>
3493 <listitem>Local time, see man strftime to get more
3494 information about format
3500 <option>to_bytes</option>
3502 <option>size</option>
3504 <listitem>If 'size' is a number followed by a size-unit
3505 (kilobyte,mb,GiB,...) then it converts the size to bytes
3506 and shows it without unit, otherwise it just shows 'size'.
3512 <option>top</option>
3514 <option>type num</option>
3516 <listitem>This takes arguments in the form:top (name)
3517 (number) Basically, processes are ranked from highest to
3518 lowest in terms of cpu usage, which is what (num)
3519 represents. The types are: "name", "pid", "cpu", "mem",
3520 "mem_res", "mem_vsize", "time", "io_perc", "io_read" and
3521 "io_write". There can be a max of 10 processes listed.
3527 <option>top_io</option>
3529 <option>type num</option>
3531 <listitem>Same as top, except sorted by the amount of I/O
3532 the process has done during the update interval
3538 <option>top_mem</option>
3540 <option>type num</option>
3542 <listitem>Same as top, except sorted by mem usage instead
3549 <option>top_time</option>
3551 <option>type num</option>
3553 <listitem>Same as top, except sorted by total CPU time
3554 instead of current CPU usage
3560 <option>totaldown</option>
3562 <option>(net)</option>
3564 <listitem>Total download, overflows at 4 GB on Linux with
3565 32-bit arch and there doesn't seem to be a way to know how
3566 many times it has already done that before conky has
3573 <option>totalup</option>
3575 <option>(net)</option>
3577 <listitem>Total upload, this one too, may overflow
3583 <option>trashed_mails</option>
3585 <option>(maildir)</option>
3586 <option>(interval)</option>
3588 <listitem>Number of mails marked as trashed in the
3589 specified mailbox or mail spool if not. Only maildir type
3590 mailboxes are supported, mbox type will return -1.
3596 <option>tztime</option>
3598 <option>(timezone (format))</option>
3600 <listitem>Local time for specified timezone, see man
3601 strftime to get more information about format. The timezone
3602 argument is specified in similar fashion as TZ environment
3603 variable. For hints, look in /usr/share/zoneinfo. e.g.
3604 US/Pacific, Europe/Zurich, etc.
3610 <option>gid_name</option>
3612 <option>gid</option>
3614 <listitem>Name of group with this gid
3620 <option>uid_name</option>
3622 <option>uid</option>
3624 <listitem>Username of user with this uid
3630 <option>unflagged_mails</option>
3632 <option>(maildir)</option>
3633 <option>(interval)</option>
3635 <listitem>Number of mails not marked as flagged in the
3636 specified mailbox or mail spool if not. Only maildir type
3637 mailboxes are supported, mbox type will return -1.
3643 <option>unforwarded_mails</option>
3645 <option>(maildir)</option>
3646 <option>(interval)</option>
3648 <listitem>Number of mails not marked as forwarded in the
3649 specified mailbox or mail spool if not. Only maildir type
3650 mailboxes are supported, mbox type will return -1.
3656 <option>unreplied_mails</option>
3658 <option>(maildir)</option>
3659 <option>(interval)</option>
3661 <listitem>Number of mails not marked as replied in the
3662 specified mailbox or mail spool if not. Only maildir type
3663 mailboxes are supported, mbox type will return -1.
3669 <option>unseen_mails</option>
3671 <option>(maildir)</option>
3672 <option>(interval)</option>
3674 <listitem>Number of new or unseen mails in the specified
3675 mailbox or mail spool if not. Only maildir type mailboxes
3676 are supported, mbox type will return -1.
3682 <option>updates</option>
3684 <option>Number of updates</option>
3686 <listitem>for debugging
3692 <option>upspeed</option>
3694 <option>(net)</option>
3696 <listitem>Upload speed in suitable IEC units
3702 <option>upspeedf</option>
3704 <option>(net)</option>
3706 <listitem>Upload speed in KiB with one decimal
3712 <option>upspeedgraph</option>
3714 <option>(netdev) (height),(width) (gradient colour 1)
3715 (gradient colour 2) (scale) (-t) (-l)</option>
3717 <listitem>Upload speed graph, colours defined in hex, minus
3718 the #. If scale is non-zero, it becomes the scale for the
3719 graph. Uses a logarithmic scale (to see small numbers) when
3720 you use the -l switch. Takes the switch '-t' to use a
3721 temperature gradient, which makes the gradient values
3722 change depending on the amplitude of a particular graph
3723 value (try it and see).
3729 <option>uptime</option>
3738 <option>uptime_short</option>
3741 <listitem>Uptime in a shorter format
3747 <option>user_names</option>
3750 <listitem>Lists the names of the users logged in
3756 <option>user_number</option>
3759 <listitem>Number of users logged in
3765 <option>user_terms</option>
3768 <listitem>Lists the consoles in use
3774 <option>user_times</option>
3777 <listitem>Lists how long users have been logged in for
3783 <option>user_time</option>
3785 <option>console</option>
3787 <listitem>Lists how long the user for the given console has been
3794 <option>utime</option>
3796 <option>(format)</option>
3798 <listitem>Display time in UTC (universal coordinate time).
3804 <option>voffset</option>
3806 <option>(pixels)</option>
3808 <listitem>Change vertical offset by N pixels. Negative
3809 values will cause text to overlap. See also $offset.
3815 <option>voltage_mv</option>
3817 <option>(n)</option>
3819 <listitem>Returns CPU #n's voltage in mV. CPUs are counted
3820 from 1. If omitted, the parameter defaults to 1.
3826 <option>voltage_v</option>
3828 <option>(n)</option>
3830 <listitem>Returns CPU #n's voltage in V. CPUs are counted
3831 from 1. If omitted, the parameter defaults to 1.
3837 <option>weather</option>
3839 <option>URI locID data_type
3840 (interval_in_minutes)</option>
3843 <para>Download, parse and display METAR data.</para>
3844 <para>For the 'URI', there are two
3845 possibilities:</para>
3848 http://weather.noaa.gov/pub/data/observations/metar/stations/</member>
3850 http://xoap.weather.com/weather/local/</member>
3852 <para>The first one is free to use but the second
3853 requires you to register and obtain your partner ID and
3854 license key. These two must be written, separated by a
3855 space, into a file called .xoaprc which needs to be
3856 placed into your home directory.</para>
3857 <para>'locID' must be a valid location identifier for
3858 the required uri. For the NOAA site this must be a
3859 valid ICAO (see for instance
3860 https://pilotweb.nas.faa.gov/qryhtml/icao/). For the
3861 weather.com site this must be a valid location ID (see
3863 http://aspnetresources.com/tools/locid.aspx).</para>
3864 <para>'data_type' must be one of the following:</para>
3867 <command>last_update</command>
3868 <para>The date and time stamp of the data.
3869 The result depends on the URI used. For the
3870 NOAA site it is date (yyyy/mm/dd) and UTC time.
3871 For the weather.com one it is date
3872 ([m]m/[d]d/yy) and Local Time of the
3876 <command>temperature</command>
3877 <para>Air temperature (you can use the
3878 'temperature_unit' config setting to change
3882 <command>cloud_cover</command>
3883 <para>The highest cloud cover status</para>
3886 <command>pressure</command>
3887 <para>Air pressure in millibar</para>
3890 <command>wind_speed</command>
3891 <para>Wind speed in km/h</para>
3894 <command>wind_dir</command>
3895 <para>Wind direction</para>
3898 <command>wind_dir_DEG</command>
3899 <para>Compass wind direction</para>
3902 <command>humidity</command>
3903 <para>Relative humidity in %</para>
3906 <command>weather</command>
3907 <para>Any relevant weather event (rain, snow,
3908 etc.). This is not used if you are querying the
3909 weather.com site since this data is aggregated
3910 into the cloud_cover one</para>
3913 <command>icon</command>
3914 <para>Weather icon (only for
3915 www.weather.com). Can be used together with the
3916 icon kit provided upon registering to their
3920 <para>'delay_in_minutes' (optional, default 30) cannot
3921 be less than 30 minutes.</para>
3922 <para>This object is threaded, and once a thread is
3923 created it can't be explicitly destroyed. One thread
3924 will run for each URI specified.</para>
3925 <para>Note that these variables are still EXPERIMENTAL
3926 and can be subject to many future changes.</para>
3932 <option>weather_forecast</option>
3934 <option>URI locID day data_type
3935 (interval_in_minutes)</option>
3938 <para>Download, parse and display weather forecast data
3939 for a given day (daytime only).</para>
3940 <para>For the 'URI', for the time being only
3941 http://xoap.weather.com/weather/local/ is
3942 supported. See 'weather' above for details of usage</para>
3943 <para>'locID', see 'weather' above.</para>
3944 <para>'day' is a number from 0 (today) to 4 (3 days
3945 after tomorrow).</para>
3946 <para>'data_type' must be one of the following:</para>
3949 <command>day</command>
3950 <option>Day of the week</option>
3953 <command>date</command>
3954 <option>Date, in the form MMM DD (ie. Jul 14)</option>
3957 <command>low</command>
3958 <option>Minimun temperature (you can use the
3959 'temperature_unit' config setting to change
3963 <command>hi</command>
3964 <option>Maximum temperature (you can use the
3965 'temperature_unit' config setting to change
3969 <command>icon</command>
3970 <option>Weather icon. Can be used together with the
3971 icon kit provided upon registering to the weather.com
3975 <command>forecast</command>
3976 <option>Weather forecast (sunny, rainy, etc.)</option>
3979 <command>wind_speed</command>
3980 <option>Wind speed in km/h</option>
3983 <command>wind_dir</command>
3984 <option>Wind direction</option>
3987 <command>wind_dir_DEG</command>
3988 <option>Compass wind direction</option>
3991 <command>humidity</command>
3992 <option>Relative humidity in %</option>
3995 <command>precipitation</command>
3996 <option>Probability of having a
3997 precipitation (in %)</option>
4000 <para>'delay_in_minutes' (optional, default 210) cannot
4001 be lower than 210 min.</para>
4002 <para>This object is threaded, and once a thread is
4003 created it can't be explicitly destroyed. One thread
4004 will run for each URI specified. You can use any
4005 protocol that Curl supports.</para>
4006 <para>Note that these variables are still EXPERIMENTAL
4007 and can be subject to many future changes.</para>
4013 <option>wireless_ap</option>
4015 <option>(net)</option>
4017 <listitem>Wireless access point MAC address (Linux only)
4023 <option>wireless_bitrate</option>
4025 <option>(net)</option>
4027 <listitem>Wireless bitrate (ie 11 Mb/s) (Linux only)
4033 <option>wireless_essid</option>
4035 <option>(net)</option>
4037 <listitem>Wireless access point ESSID (Linux only)
4043 <option>wireless_link_bar</option>
4045 <option>(height),(width) (net)</option>
4047 <listitem>Wireless link quality bar (Linux only)
4053 <option>wireless_link_qual</option>
4055 <option>(net)</option>
4057 <listitem>Wireless link quality (Linux only)
4063 <option>wireless_link_qual_max</option>
4065 <option>(net)</option>
4067 <listitem>Wireless link quality maximum value (Linux only)
4073 <option>wireless_link_qual_perc</option>
4075 <option>(net)</option>
4077 <listitem>Wireless link quality in percents (Linux only)
4083 <option>wireless_mode</option>
4085 <option>(net)</option>
4087 <listitem>Wireless mode (Managed/Ad-Hoc/Master) (Linux
4094 <option>words</option>
4096 <option>textfile</option>
4098 <listitem>Displays the number of words in the given file
4104 <option>xmms2_album</option>
4107 <listitem>Album in current XMMS2 song
4113 <option>xmms2_artist</option>
4116 <listitem>Artist in current XMMS2 song
4122 <option>xmms2_bar</option>
4124 <option>(height),(width)</option>
4126 <listitem>Bar of XMMS2's progress
4132 <option>xmms2_bitrate</option>
4135 <listitem>Bitrate of current song
4141 <option>xmms2_comment</option>
4144 <listitem>Comment in current XMMS2 song
4150 <option>xmms2_date</option>
4153 <listitem>Returns song's date.
4159 <option>xmms2_duration</option>
4162 <listitem>Duration of current song
4168 <option>xmms2_elapsed</option>
4171 <listitem>Song's elapsed time
4177 <option>xmms2_genre</option>
4180 <listitem>Genre in current XMMS2 song
4186 <option>xmms2_id</option>
4189 <listitem>XMMS2 id of current song
4195 <option>xmms2_percent</option>
4198 <listitem>Percent of song's progress
4204 <option>xmms2_playlist</option>
4207 <listitem>Returns the XMMS2 playlist.
4213 <option>xmms2_size</option>
4216 <listitem>Size of current song
4222 <option>xmms2_smart</option>
4225 <listitem>Prints the song name in either the form "artist -
4226 title" or file name, depending on whats available
4232 <option>xmms2_status</option>
4235 <listitem>XMMS2 status (Playing, Paused, Stopped, or
4242 <option>xmms2_timesplayed</option>
4245 <listitem>Number of times a song was played (presumably).
4251 <option>xmms2_title</option>
4254 <listitem>Title in current XMMS2 song
4260 <option>xmms2_tracknr</option>
4263 <listitem>Track number in current XMMS2 song
4269 <option>xmms2_url</option>
4272 <listitem>Full path to current song
projects / monky / blob