5 <option>acpiacadapter</option>
8 <listitem>ACPI ac adapter state.
14 <option>acpifan</option>
17 <listitem>ACPI fan state
23 <option>acpitemp</option>
26 <listitem>ACPI temperature in C.
34 <option>(interface)</option>
36 <listitem>IP address for an interface, or "No Address" if
37 no address is assigned.
43 <option>addrs</option>
45 <option>(interface)</option>
47 <listitem>IP addresses for an interface (if one - works
48 like addr). Linux only.
54 <option>adt746xcpu</option>
57 <listitem>CPU temperature from therm_adt746x
63 <option>adt746xfan</option>
66 <listitem>Fan speed from therm_adt746x
72 <option>alignc</option>
74 <option>(num)</option>
76 <listitem>Align text to centre
82 <option>alignr</option>
84 <option>(num)</option>
86 <listitem>Right-justify text, with space of N
92 <option>apcupsd</option>
97 <listitem>Sets up the connection to apcupsd daemon. Prints
98 nothing, defaults to localhost:3551
104 <option>apcupsd_cable</option>
107 <listitem>Prints the UPS connection type.
113 <option>apcupsd_charge</option>
116 <listitem>Current battery capacity in percent.
122 <option>apcupsd_lastxfer</option>
125 <listitem>Reason for last transfer from line to battery.
131 <option>apcupsd_linev</option>
134 <listitem>Nominal input voltage.
140 <option>apcupsd_load</option>
143 <listitem>Current load in percent.
149 <option>apcupsd_loadbar</option>
152 <listitem>Bar showing current load.
158 <option>apcupsd_loadgauge</option>
160 <option>(height),(width)</option>
162 <listitem>Gauge that shows current load.
168 <option>apcupsd_loadgraph</option>
170 <option>(height),(width) (gradient colour 1) (gradient
171 colour 2) (scale) (-t) (-l)</option>
173 <listitem>History graph of current load.
179 <option>apcupsd_model</option>
182 <listitem>Prints the model of the UPS.
188 <option>apcupsd_name</option>
191 <listitem>Prints the UPS user-defined name.
197 <option>apcupsd_status</option>
200 <listitem>Prints current status (on-line, on-battery).
206 <option>apcupsd_temp</option>
209 <listitem>Current internal temperature.
215 <option>apcupsd_timeleft</option>
218 <listitem>Time left to run on battery.
224 <option>apcupsd_upsmode</option>
227 <listitem>Prints the UPS mode (e.g. standalone).
233 <option>apm_adapter</option>
236 <listitem>Display APM AC adapter status (FreeBSD only)
242 <option>apm_battery_life</option>
245 <listitem>Display APM battery life in percent (FreeBSD
252 <option>apm_battery_time</option>
255 <listitem>Display remaining APM battery life in hh:mm:ss or
256 "unknown" if AC adapterstatus is on-line or charging
263 <option>audacious_bar</option>
265 <option>(height),(width)</option>
267 <listitem>Progress bar
273 <option>audacious_bitrate</option>
276 <listitem>Bitrate of current tune
282 <option>audacious_channels</option>
285 <listitem>Number of audio channels of current tune
291 <option>audacious_filename</option>
294 <listitem>Full path and filename of current tune
300 <option>audacious_frequency</option>
303 <listitem>Sampling frequency of current tune
309 <option>audacious_length</option>
312 <listitem>Total length of current tune as MM:SS
318 <option>audacious_length_seconds</option>
321 <listitem>Total length of current tune in seconds
327 <option>audacious_main_volume</option>
330 <listitem>The current volume fetched from Audacious
336 <option>audacious_playlist_length</option>
339 <listitem>Number of tunes in playlist
345 <option>audacious_playlist_position</option>
348 <listitem>Playlist position of current tune
354 <option>audacious_position</option>
357 <listitem>Position of current tune (MM:SS)
363 <option>audacious_position_seconds</option>
366 <listitem>Position of current tune in seconds
372 <option>audacious_status</option>
375 <listitem>Player status (Playing/Paused/Stopped/Not
382 <option>audacious_title</option>
384 <option>(max length)</option>
386 <listitem>Title of current tune with optional maximum
393 <option>battery</option>
395 <option>(num)</option>
397 <listitem>Battery status and remaining percentage capacity
398 of ACPI or APM battery. ACPI battery number can be given as
399 argument (default is BAT0).
405 <option>battery_bar</option>
407 <option>(height),(width) (num)</option>
409 <listitem>Battery percentage remaining of ACPI battery in a
410 bar. ACPI battery number can be given as argument (default
417 <option>battery_percent</option>
419 <option>(num)</option>
421 <listitem>Battery percentage remaining for ACPI battery.
422 ACPI battery number can be given as argument (default is
429 <option>battery_short</option>
431 <option>(num)</option>
433 <listitem>Battery status and remaining percentage capacity
434 of ACPI or APM battery. ACPI battery number can be given as
435 argument (default is BAT0). This mode display a short
436 status, which means that C is displayed instead of
437 charging, D for discharging, F for full, N for not present,
438 E for empty and U for unknown.
444 <option>battery_time</option>
446 <option>(num)</option>
448 <listitem>Battery charge/discharge time remaining of ACPI
449 battery. ACPI battery number can be given as argument
456 <option>blink</option>
458 <option>text_and_other_conky_vars</option>
460 <listitem>Let 'text_and_other_conky_vars' blink on and off.
467 <option>bmpx_album</option>
470 <listitem>Album in current BMPx track
476 <option>bmpx_artist</option>
479 <listitem>Artist in current BMPx track
485 <option>bmpx_bitrate</option>
488 <listitem>Bitrate of the current BMPx track
494 <option>bmpx_title</option>
497 <listitem>Title of the current BMPx track
503 <option>bmpx_track</option>
506 <listitem>Track number of the current BMPx track
512 <option>bmpx_uri</option>
515 <listitem>URI of the current BMPx track
521 <option>buffers</option>
524 <listitem>Amount of memory buffered
530 <option>cached</option>
533 <listitem>Amount of memory cached
539 <option>color</option>
541 <option>(color)</option>
543 <listitem>Change drawing color to 'color' which is a name of
544 a color or a hexcode preceded with # (for example #0A1B2C ).
545 If you use ncurses only the following colors are supported:
546 red,green,yellow,blue,magenta,cyan,black,white.
552 <option>colorN</option>
555 <listitem>Change drawing color to colorN configuration
556 option, where N is a digit between 0 and 9, inclusively.
562 <option>combine</option>
564 <option>var1 var2</option>
566 <listitem>Places the lines of var2 to the right of the
567 lines of var1 seperated by the chars that are put between
568 var1 and var2. For example: ${combine ${head /proc/cpuinfo
569 2} - ${head /proc/meminfo 1}} gives as output
570 "cpuinfo_line1 - meminfo_line1" on line 1 and
571 "cpuinfo_line2 -" on line 2. $combine vars can also be
572 nested to place more vars next to each other.
578 <option>conky_build_arch</option>
581 <listitem>CPU architecture Conky was built for
587 <option>conky_build_date</option>
590 <listitem>Date Conky was built
596 <option>conky_version</option>
599 <listitem>Conky version
607 <option>(cpuN)</option>
609 <listitem>CPU usage in percents. For SMP machines, the CPU
610 number can be provided as an argument. ${cpu cpu0} is the
611 total usage, and ${cpu cpuX} (X >= 1) are individual
618 <option>cpubar</option>
620 <option>(cpuN) (height),(width)</option>
622 <listitem>Bar that shows CPU usage, height is bar's height
623 in pixels. See $cpu for more info on SMP.
629 <option>cpugauge</option>
631 <option>(cpuN) (height),(width)</option>
633 <listitem>Elliptical gauge that shows CPU usage, height and
634 width are gauge's vertical and horizontal axis
635 respectively. See $cpu for more info on SMP.
641 <option>cpugraph</option>
643 <option>(cpuN) (height),(width) (gradient colour 1)
644 (gradient colour 2) (scale) (-t) (-l)</option>
646 <listitem>CPU usage graph, with optional colours in hex,
647 minus the #. See $cpu for more info on SMP. Uses a
648 logarithmic scale (to see small numbers) when you use the
649 -l switch. Takes the switch '-t' to use a temperature
650 gradient, which makes the gradient values change depending
651 on the amplitude of a particular graph value (try it and
658 <option>curl</option>
660 <option>url (interval_in_minutes)</option>
663 <para>Download data from URI using Curl at the
664 specified interval. The interval may be a floating
665 point value greater than 0, otherwise defaults to 15
666 minutes. Most useful when used in conjunction with Lua
667 and the Lua API. This object is threaded, and once a
668 thread is created it can't be explicitely destroyed.
669 One thread will run for each URI specified. You can use
670 any protocol that Curl supports.</para>
676 <option>desktop</option>
679 <listitem>Number of the desktop on which conky is running
680 or the message "Not running in X" if this is the case.
686 <option>desktop_name</option>
689 <listitem>Name of the desktop on which conky is running or
690 the message "Not running in X" if this is the case.
696 <option>desktop_number</option>
699 <listitem>Number of desktops or the message "Not running in
700 X" if this is the case.
706 <option>disk_protect</option>
708 <option>device</option>
710 <listitem>Disk protection status, if supported (needs
711 kernel-patch). Prints either "frozen" or "free " (note the
718 <option>diskio</option>
720 <option>(device)</option>
722 <listitem>Displays current disk IO. Device is optional, and
723 takes the form of sda for /dev/sda. Individual partitions
730 <option>diskio_read</option>
732 <option>(device)</option>
734 <listitem>Displays current disk IO for reads. Device as in
741 <option>diskio_write</option>
743 <option>(device)</option>
745 <listitem>Displays current disk IO for writes. Device as in
752 <option>diskiograph</option>
754 <option>(device) (height),(width) (gradient colour 1)
755 (gradient colour 2) (scale) (-t) (-l)</option>
757 <listitem>Disk IO graph, colours defined in hex, minus the
758 #. If scale is non-zero, it becomes the scale for the
759 graph. Uses a logarithmic scale (to see small numbers) when
760 you use -l switch. Takes the switch '-t' to use a
761 temperature gradient, which makes the gradient values
762 change depending on the amplitude of a particular graph
763 value (try it and see).
769 <option>diskiograph_read</option>
771 <option>(device) (height),(width) (gradient colour 1)
772 (gradient colour 2) (scale) (-t) (-l)</option>
774 <listitem>Disk IO graph for reads, colours defined in hex,
775 minus the #. If scale is non-zero, it becomes the scale for
776 the graph. Device as in diskio. Uses a logarithmic scale
777 (to see small numbers) when you use -l switch. Takes the
778 switch '-t' to use a temperature gradient, which makes the
779 gradient values change depending on the amplitude of a
780 particular graph value (try it and see).
786 <option>diskiograph_write</option>
788 <option>(device) (height),(width) (gradient colour 1)
789 (gradient colour 2) (scale) (-t) (-l)</option>
791 <listitem>Disk IO graph for writes, colours defined in hex,
792 minus the #. If scale is non-zero, it becomes the scale for
793 the graph. Device as in diskio. Uses a logarithmic scale
794 (to see small numbers) when you use -l switch. Takes the
795 switch '-t' to use a temperature gradient, which makes the
796 gradient values change depending on the amplitude of a
797 particular graph value (try it and see).
803 <option>downspeed</option>
805 <option>(net)</option>
807 <listitem>Download speed in suitable IEC units
813 <option>downspeedf</option>
815 <option>(net)</option>
817 <listitem>Download speed in KiB with one decimal
823 <option>downspeedgraph</option>
825 <option>(netdev) (height),(width) (gradient colour 1)
826 (gradient colour 2) (scale) (-t) (-l)</option>
828 <listitem>Download speed graph, colours defined in hex,
829 minus the #. If scale is non-zero, it becomes the scale for
830 the graph. Uses a logarithmic scale (to see small numbers)
831 when you use -l switch. Takes the switch '-t' to use a
832 temperature gradient, which makes the gradient values
833 change depending on the amplitude of a particular graph
834 value (try it and see).
840 <option>draft_mails</option>
842 <option>(maildir)</option>
843 <option>(interval)</option>
845 <listitem>Number of mails marked as draft in the specified
846 mailbox or mail spool if not. Only maildir type mailboxes
847 are supported, mbox type will return -1.
853 <option>else</option>
856 <listitem>Text to show if any of the above are not true
862 <option>endif</option>
866 <listitem>Ends an $if block.
872 <option>entropy_avail</option>
875 <listitem>Current entropy available for crypto freaks
881 <option>entropy_bar</option>
883 <option>(height),(width)</option>
885 <listitem>Normalized bar of available entropy for crypto
892 <option>entropy_perc</option>
895 <listitem>Percentage of entropy available in comparison to
902 <option>entropy_poolsize</option>
905 <listitem>Total size of system entropy pool for crypto
912 <option>eval</option>
914 <option>string</option>
916 <listitem>Evalutates given string according to the rules of
917 TEXT interpretation, i.e. parsing any contained text object
918 specifications into their output, any occuring '$$' into a
919 single '$' and so on. The output is then being parsed
928 <option>api_userid api_key character_id</option>
930 <listitem>Fetches your currently training skill from the
931 Eve Online API servers (http://www.eve-online.com/) and
932 displays the skill along with the remaining training time.
938 <option>exec</option>
940 <option>command</option>
942 <listitem>Executes a shell command and displays the output
943 in conky. warning: this takes a lot more resources than
944 other variables. I'd recommend coding wanted behaviour in C
951 <option>execbar</option>
953 <option>command</option>
955 <listitem>Same as exec, except if the first value return is
956 a value between 0-100, it will use that number for a bar.
957 The size for bars can be controlled via the
958 default_bar_size config setting.
964 <option>execgauge</option>
966 <option>command</option>
968 <listitem>Same as exec, except if the first value returned
969 is a value between 0-100, it will use that number for a
970 gauge. The size for gauges can be controlled via the
971 default_gauge_size config setting.
977 <option>execgraph</option>
979 <option>(-t) (-l) command</option>
981 <listitem>Same as execbar, but graphs values. Uses a
982 logaritmic scale when the log option (-l switch) is given
983 (to see small numbers). Values still have to be between 0
984 and 100. The size for graphs can be controlled via the
985 default_graph_size config setting. Takes the switch '-t' to
986 use a temperature gradient, which makes the gradient values
987 change depending on the amplitude of a particular graph
988 value (try it and see). If -t or -l is your first argument,
989 you may need to preceed it by a space (' ').
995 <option>execi</option>
997 <option>interval command</option>
999 <listitem>Same as exec but with specific interval. Interval
1000 can't be less than update_interval in configuration. See
1007 <option>execibar</option>
1009 <option>interval command</option>
1011 <listitem>Same as execbar, except with an interval
1017 <option>execigauge</option>
1019 <option>interval command</option>
1021 <listitem>Same as execgauge, but takes an interval arg and
1028 <option>execigraph</option>
1030 <option>interval (-t) (-l) command</option>
1032 <listitem>Same as execgraph, but takes an interval arg and
1033 graphs values. If -t or -l is your first argument, you may
1034 need to preceed it by a space (' ').
1040 <option>execp</option>
1042 <option>command</option>
1044 <listitem>Executes a shell command and displays the output
1045 in conky. warning: this takes a lot more resources than
1046 other variables. I'd recommend coding wanted behaviour in C
1047 and posting a patch. This differs from $exec in that it
1048 parses the output of the command, so you can insert things
1049 like ${color red}hi!${color} in your script and have it
1050 correctly parsed by Conky. Caveats: Conky parses and
1051 evaluates the output of $execp every time Conky loops, and
1052 then destroys all the objects. If you try to use anything
1053 like $execi within an $execp statement, it will
1054 functionally run at the same interval that the $execp
1055 statement runs, as it is created and destroyed at every
1062 <option>execpi</option>
1064 <option>interval command</option>
1066 <listitem>Same as execp but with specific interval.
1067 Interval can't be less than update_interval in
1068 configuration. Note that the output from the $execpi
1069 command is still parsed and evaluated at every interval.
1075 <option>flagged_mails</option>
1077 <option>(maildir)</option>
1078 <option>(interval)</option>
1080 <listitem>Number of mails marked as flagged in the
1081 specified mailbox or mail spool if not. Only maildir type
1082 mailboxes are supported, mbox type will return -1.
1088 <option>font</option>
1090 <option>(font)</option>
1092 <listitem>Specify a different font. This new font will
1093 apply to the current line and everything following. You can
1094 use a $font with no arguments to change back to the default
1095 font (much like with $color)
1101 <option>forwarded_mails</option>
1103 <option>(maildir)</option>
1104 <option>(interval)</option>
1106 <listitem>Number of mails marked as forwarded in the
1107 specified mailbox or mail spool if not. Only maildir type
1108 mailboxes are supported, mbox type will return -1.
1114 <option>freq</option>
1116 <option>(n)</option>
1118 <listitem>Returns CPU #n's frequency in MHz. CPUs are
1119 counted from 1. If omitted, the parameter defaults to 1.
1125 <option>freq_g</option>
1127 <option>(n)</option>
1129 <listitem>Returns CPU #n's frequency in GHz. CPUs are
1130 counted from 1. If omitted, the parameter defaults to 1.
1136 <option>fs_bar</option>
1138 <option>(height),(width) fs</option>
1140 <listitem>Bar that shows how much space is used on a file
1141 system. height is the height in pixels. fs is any file on
1148 <option>fs_bar_free</option>
1150 <option>(height),(width) fs</option>
1152 <listitem>Bar that shows how much space is free on a file
1153 system. height is the height in pixels. fs is any file on
1160 <option>fs_free</option>
1162 <option>(fs)</option>
1164 <listitem>Free space on a file system available for users.
1170 <option>fs_free_perc</option>
1172 <option>(fs)</option>
1174 <listitem>Free percentage of space on a file system
1175 available for users.
1181 <option>fs_size</option>
1183 <option>(fs)</option>
1185 <listitem>File system size.
1191 <option>fs_type</option>
1193 <option>(fs)</option>
1195 <listitem>File system type.
1201 <option>fs_used</option>
1203 <option>(fs)</option>
1205 <listitem>File system used space.
1211 <option>fs_used_perc</option>
1213 <option>(fs)</option>
1215 <listitem>Percent of file system used space.
1221 <option>goto</option>
1225 <listitem>The next element will be printed at position 'x'.
1232 <option>gw_iface</option>
1235 <listitem>Displays the default route's interface or
1236 "multiple"/"none" accordingly.
1242 <option>gw_ip</option>
1245 <listitem>Displays the default gateway's IP or
1246 "multiple"/"none" accordingly.
1252 <option>hddtemp</option>
1254 <option>(dev)</option>
1256 <listitem>Displays temperature of a selected hard disk
1257 drive as reported by the hddtemp daemon. Use hddtemp_host
1258 and hddtemp_port to specify a host and port for all hddtemp
1259 objects. If no dev parameter is given, the first disk returned
1260 by the hddtemp daemon is used.
1266 <option>head</option>
1268 <option>logfile lines (next_check)</option>
1270 <listitem>Displays first N lines of supplied text file. The
1271 file is checked every 'next_check' update. If next_check is
1272 not supplied, Conky defaults to 2. Max of 30 lines can be
1273 displayed, or until the text buffer is filled.
1281 <option>(height)</option>
1283 <listitem>Horizontal line, height is the height in pixels
1289 <option>hwmon</option>
1291 <option>(dev) type n (factor offset)</option>
1293 <listitem>Hwmon sensor from sysfs (Linux 2.6). Parameter
1294 dev may be omitted if you have only one hwmon device.
1295 Parameter type is either 'in' or 'vol' meaning voltage;
1296 'fan' meaning fan; 'temp' meaning temperature. Parameter n
1297 is number of the sensor. See /sys/class/hwmon/ on your
1298 local computer. The optional arguments 'factor' and
1299 'offset' allow precalculation of the raw input, which is
1300 being modified as follows: 'input = input * factor +
1301 offset'. Note that they have to be given as decimal values
1302 (i.e. contain at least one decimal place).
1308 <option>i2c</option>
1310 <option>(dev) type n (factor offset)</option>
1312 <listitem>I2C sensor from sysfs (Linux 2.6). Parameter dev
1313 may be omitted if you have only one I2C device. Parameter
1314 type is either 'in' or 'vol' meaning voltage; 'fan' meaning
1315 fan; 'temp' meaning temperature. Parameter n is number of
1316 the sensor. See /sys/bus/i2c/devices/ on your local
1317 computer. The optional arguments 'factor' and 'offset'
1318 allow precalculation of the raw input, which is being
1319 modified as follows: 'input = input * factor + offset'.
1320 Note that they have to be given as decimal values (i.e.
1321 contain at least one decimal place).
1327 <option>i8k_ac_status</option>
1331 <listitem>If running the i8k kernel driver for Inspiron
1332 laptops, displays whether ac power is on, as listed in
1333 /proc/i8k (translated to human-readable). Beware that this
1334 is by default not enabled by i8k itself.
1340 <option>i8k_bios</option>
1344 <listitem>If running the i8k kernel driver for Inspiron
1345 laptops, displays the bios version as listed in /proc/i8k.
1351 <option>i8k_buttons_status</option>
1355 <listitem>If running the i8k kernel driver for Inspiron
1356 laptops, displays the volume buttons status as listed in
1363 <option>i8k_cpu_temp</option>
1367 <listitem>If running the i8k kernel driver for Inspiron
1368 laptops, displays the cpu temperature in Celsius, as
1369 reported by /proc/i8k.
1375 <option>i8k_left_fan_rpm</option>
1379 <listitem>If running the i8k kernel driver for Inspiron
1380 laptops, displays the left fan's rate of rotation, in
1381 revolutions per minute as listed in /proc/i8k. Beware, some
1382 laptops i8k reports these fans in reverse order.
1388 <option>i8k_left_fan_status</option>
1392 <listitem>If running the i8k kernel driver for Inspiron
1393 laptops, displays the left fan status as listed in
1394 /proc/i8k (translated to human-readable). Beware, some
1395 laptops i8k reports these fans in reverse order.
1401 <option>i8k_right_fan_rpm</option>
1405 <listitem>If running the i8k kernel driver for Inspiron
1406 laptops, displays the right fan's rate of rotation, in
1407 revolutions per minute as listed in /proc/i8k. Beware, some
1408 laptops i8k reports these fans in reverse order.
1414 <option>i8k_right_fan_status</option>
1418 <listitem>If running the i8k kernel driver for Inspiron
1419 laptops, displays the right fan status as listed in
1420 /proc/i8k (translated to human-readable). Beware, some
1421 laptops i8k reports these fans in reverse order.
1427 <option>i8k_serial</option>
1431 <listitem>If running the i8k kernel driver for Inspiron
1432 laptops, displays your laptop serial number as listed in
1439 <option>i8k_version</option>
1443 <listitem>If running the i8k kernel driver for Inspiron
1444 laptops, displays the version formatting of /proc/i8k.
1450 <option>ibm_brightness</option>
1453 <listitem>If running the IBM ACPI, displays the brigtness
1454 of the laptops's LCD (0-7).
1460 <option>ibm_fan</option>
1463 <listitem>If running the IBM ACPI, displays the fan speed.
1469 <option>ibm_temps</option>
1473 <listitem>If running the IBM ACPI, displays the
1474 temperatures from the IBM temperature sensors (N=0..7)
1475 Sensor 0 is on the CPU, 3 is on the GPU.
1481 <option>ibm_volume</option>
1484 <listitem>If running the IBM ACPI, displays the "master"
1485 volume, controlled by the volume keys (0-14).
1491 <option>iconv_start</option>
1493 <option>codeset_from codeset_to</option>
1495 <listitem>Convert text from one codeset to another using
1496 GNU iconv. Needs to be stopped with iconv_stop.
1502 <option>iconv_stop</option>
1506 <listitem>Stop iconv codeset conversion.
1512 <option>if_empty</option>
1514 <option>(var)</option>
1516 <listitem>if conky variable VAR is empty, display
1517 everything between $if_empty and the matching $endif
1523 <option>if_existing</option>
1525 <option>file (string)</option>
1527 <listitem>if FILE exists, display everything between
1528 if_existing and the matching $endif. The optional second
1529 paramater checks for FILE containing the specified string
1530 and prints everything between $if_existing and the matching
1537 <option>if_gw</option>
1540 <listitem>if there is at least one default gateway, display
1541 everything between $if_gw and the matching $endif
1547 <option>if_match</option>
1549 <option>expression</option>
1551 <listitem>Evaluates the given boolean expression, printing
1552 everything between $if_match and the matching $endif
1553 depending on whether the evaluation returns true or not.
1554 Valid expressions consist of a left side, an operator and a
1555 right side. Left and right sides are being parsed for
1556 contained text objects before evaluation. Recognised left
1557 and right side types are:
1560 <command>double</command>Argument consists of only
1561 digits and a single dot.</member>
1563 <command>long</command>Argument consists of only
1566 <command>string</command>Argument is enclosed in
1567 quotation mark or the checks for double and long failed
1569 </simplelist>Valid operands are: '>', '<', '>=',
1570 '<=', '==', '!='.
1576 <option>if_mixer_mute</option>
1578 <option>(mixer)</option>
1580 <listitem>If mixer exists, display everything between
1581 $if_mixer_mute and the matching $endif. If no mixer is
1582 specified, "Master" is used.
1588 <option>if_mounted</option>
1590 <option>(mountpoint)</option>
1592 <listitem>if MOUNTPOINT is mounted, display everything
1593 between $if_mounted and the matching $endif
1599 <option>if_mpd_playing</option>
1602 <listitem>if mpd is playing or paused, display everything
1603 between $if_mpd_playing and the matching $endif
1609 <option>if_running</option>
1611 <option>(process)</option>
1613 <listitem>if PROCESS is running, display everything
1614 $if_running and the matching $endif. This uses the
1615 ``pidof'' command, so the -x switch is also supported.
1621 <option>if_smapi_bat_installed</option>
1623 <option>(INDEX)</option>
1625 <listitem>when using smapi, if the battery with index INDEX
1626 is installed, display everything between
1627 $if_smapi_bat_installed and the matching $endif
1633 <option>if_up</option>
1635 <option>(interface)</option>
1637 <listitem>if INTERFACE exists and is up, display everything
1638 between $if_up and the matching $endif
1644 <option>if_updatenr</option>
1646 <option>(updatenr)</option>
1648 <listitem>If it's the UPDATENR-th time that conky updates,
1649 display everything between $if_updatenr and the matching
1650 $endif. The counter resets when the highest UPDATENR is
1651 reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr
1652 2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the
1653 time followed by bar 25% of the time followed by nothing
1654 the other half of the time.
1660 <option>if_xmms2_connected</option>
1663 <listitem>Display everything between $if_xmms2_connected
1664 and the matching $endif if xmms2 is running.
1670 <option>image</option>
1672 <option><path to image> (-p x,y) (-s WxH) (-n)
1673 (-f interval)</option>
1675 <listitem>Renders an image from the path specified using
1676 Imlib2. Takes 4 optional arguments: a position, a size, a
1677 no-cache switch, and a cache flush interval. Changing the
1678 x,y position will move the position of the image, and
1679 changing the WxH will scale the image. If you specify the
1680 no-cache flag (-n), the image will not be cached.
1681 Alternately, you can specify the -f int switch to specify a
1682 cache flust interval for a particular image. Example:
1683 ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200}
1684 will render 'cheeseburger.jpg' at (20,20) scaled to 200x200
1685 pixels. Conky does not make any attempt to adjust the
1686 position (or any other formatting) of images, they are just
1687 rendered as per the arguments passed. The only reason
1688 $image is part of the TEXT section, is to allow for runtime
1689 modifications, through $execp $lua_parse, or some other
1696 <option>imap_messages</option>
1698 <option>(args)</option>
1700 <listitem>Displays the number of messages in your global
1701 IMAP inbox by default. You can define individual IMAP
1702 inboxes seperately by passing arguments to this object.
1703 Arguments are: "host user pass [-i interval (in seconds)]
1704 [-f 'folder'] [-p port] [-e 'command'] [-r retries]". Default
1705 port is 143, default folder is 'INBOX', default interval is
1706 5 minutes, and default number of retries before giving up
1707 is 5. If the password is supplied as '*', you will be
1708 prompted to enter the password when Conky starts.
1714 <option>imap_unseen</option>
1716 <option>(args)</option>
1718 <listitem>Displays the number of unseen messages in your
1719 global IMAP inbox by default. You can define individual
1720 IMAP inboxes seperately by passing arguments to this
1721 object. Arguments are: "host user pass [-i interval (in
1722 seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r retries]".
1723 Default port is 143, default folder is 'INBOX', default
1724 interval is 5 minutes, and default number of retries before
1725 giving up is 5. If the password is supplied as '*', you
1726 will be prompted to enter the password when Conky starts.
1732 <option>include</option>
1734 <option>path</option>
1737 <para>Loads the configfile at path, places the
1738 configsettings behind the configsettings in the orginal
1739 config and places the vars where the includevar
1746 <option>ioscheduler</option>
1748 <option>disk</option>
1750 <listitem>Prints the current ioscheduler used for the given
1751 disk name (i.e. e.g. "hda" or "sdb")
1757 <option>kernel</option>
1760 <listitem>Kernel version
1766 <option>laptop_mode</option>
1769 <listitem>The value of /proc/sys/vm/laptop_mode
1775 <option>lines</option>
1777 <option>textfile</option>
1779 <listitem>Displays the number of lines in the given file
1785 <option>loadavg</option>
1787 <option>(1|2|3)</option>
1789 <listitem>System load average, 1 is for past 1 minute, 2
1790 for past 5 minutes and 3 for past 15 minutes.
1796 <option>loadgraph</option>
1798 <option>(1|2|3) (height),(width) (gradient colour 1)
1799 (gradient colour 2) (scale) (-t) (-l)</option>
1801 <listitem>Load1 average graph, similar to xload, with
1802 optional colours in hex, minus the #. Uses a logarithmic
1803 scale (to see small numbers) when you use the -l switch.
1804 Takes the switch '-t' to use a temperature gradient, which
1805 makes the gradient values change depending on the amplitude
1806 of a particular graph value (try it and see).
1812 <option>lua</option>
1814 <option>function_name (function parameters)</option>
1816 <listitem>Executes a Lua function with given parameters,
1817 then prints the returned string. See also 'lua_load' on how
1818 to load scripts. Conky puts 'conky_' in front of
1819 function_name to prevent accidental calls to the wrong
1820 function unless you put you place 'conky_' in front of it
1827 <option>lua_bar</option>
1829 <option>(height, width) function_name (function
1830 parameters)</option>
1832 <listitem>Executes a Lua function with given parameters and
1833 draws a bar. Expects result value to be an integer between
1834 0 and 100. See also 'lua_load' on how to load scripts.
1835 Conky puts 'conky_' in front of function_name to prevent
1836 accidental calls to the wrong function unless you put you
1837 place 'conky_' in front of it yourself.
1843 <option>lua_gauge</option>
1845 <option>(height, width) function_name (function
1846 parameters)</option>
1848 <listitem>Executes a Lua function with given parameters and
1849 draws a gauge. Expects result value to be an integer
1850 between 0 and 100. See also 'lua_load' on how to load
1851 scripts. Conky puts 'conky_' in front of function_name to
1852 prevent accidental calls to the wrong function unless you
1853 put you place 'conky_' in front of it yourself.
1859 <option>lua_graph</option>
1861 <option>function_name (height),(width) (gradient colour
1862 1) (gradient colour 2) (scale) (-t) (-l)</option>
1864 <listitem>Executes a Lua function with and draws a graph.
1865 Expects result value to be any number, and by default will
1866 scale to show the full range. See also 'lua_load' on how to
1867 load scripts. Takes the switch '-t' to use a temperature
1868 gradient, which makes the gradient values change depending
1869 on the amplitude of a particular graph value (try it and
1870 see). Conky puts 'conky_' in front of function_name to
1871 prevent accidental calls to the wrong function unless you
1872 put you place 'conky_' in front of it yourself.
1878 <option>lua_parse</option>
1880 <option>function_name (function parameters)</option>
1882 <listitem>Executes a Lua function with given parameters as
1883 per $lua, then parses and prints the result value as per
1884 the syntax for Conky's TEXT section. See also 'lua_load' on
1885 how to load scripts. Conky puts 'conky_' in front of
1886 function_name to prevent accidental calls to the wrong
1887 function unless you put you place 'conky_' in front of it
1894 <option>machine</option>
1897 <listitem>Machine, i686 for example
1903 <option>mails</option>
1905 <option>(mailbox)</option>
1906 <option>(interval)</option>
1908 <listitem>Mail count in the specified mailbox or your mail
1909 spool if not. Both mbox and maildir type mailboxes are
1910 supported. You can use a program like fetchmail to get
1911 mails from some server using your favourite protocol. See
1918 <option>mboxscan</option>
1920 <option>(-n number of messages to print) (-fw from
1921 width) (-sw subject width) mbox</option>
1923 <listitem>Print a summary of recent messages in an mbox
1924 format mailbox. mbox parameter is the filename of the
1925 mailbox (can be encapsulated using '"', ie. ${mboxscan -n
1926 10 "/home/brenden/some box"}
1932 <option>mem</option>
1935 <listitem>Amount of memory in use
1941 <option>membar</option>
1943 <option>(height),(width)</option>
1945 <listitem>Bar that shows amount of memory in use
1951 <option>memeasyfree</option>
1954 <listitem>Amount of free memory including the memory that
1955 is very easily freed (buffers/cache)
1961 <option>memfree</option>
1964 <listitem>Amount of free memory
1970 <option>memgauge</option>
1972 <option>(height),(width)</option>
1974 <listitem>Gauge that shows amount of memory in use (see
1981 <option>memgraph</option>
1983 <option>(height),(width) (gradient colour 1) (gradient
1984 colour 2) (scale) (-t) (-l)</option>
1986 <listitem>Memory usage graph. Uses a logarithmic scale (to
1987 see small numbers) when you use the -l switch. Takes the
1988 switch '-t' to use a temperature gradient, which makes the
1989 gradient values change depending on the amplitude of a
1990 particular graph value (try it and see).
1996 <option>memmax</option>
1999 <listitem>Total amount of memory
2005 <option>memperc</option>
2008 <listitem>Percentage of memory in use
2014 <option>mixer</option>
2016 <option>(device)</option>
2018 <listitem>Prints the mixer value as reported by the OS.
2019 Default mixer is "vol", but you can specify one of the
2020 following optional arguments: "vol", "bass", "treble",
2021 "synth", "pcm", "speaker", "line", "mic", "cd", "mix",
2022 "pcm2", "rec", "igain", "ogain", "line1", "line2", "line3",
2023 "dig1", "dig2", "dig3", "phin", "phout", "video", "radio",
2024 "monitor". Refer to the definition of SOUND_DEVICE_NAMES in
2025 <linux/soundcard.h> (on Linux), <soundcard.h>
2026 (on OpenBSD), or <sys/soundcard.h> to find the exact
2027 options available on your system.
2033 <option>mixerbar</option>
2035 <option>(device)</option>
2037 <listitem>Displays mixer value in a bar as reported by the
2038 OS. See docs for $mixer for details on arguments.
2044 <option>mixerl</option>
2046 <option>(device)</option>
2048 <listitem>Prints the left channel mixer value as reported
2049 by the OS. See docs for $mixer for details on arguments.
2055 <option>mixerlbar</option>
2057 <option>(device)</option>
2059 <listitem>Displays the left channel mixer value in a bar as
2060 reported by the OS. See docs for $mixer for details on
2067 <option>mixerr</option>
2069 <option>(device)</option>
2071 <listitem>Prints the right channel mixer value as reported
2072 by the OS. See docs for $mixer for details on arguments.
2078 <option>mixerrbar</option>
2080 <option>(device)</option>
2082 <listitem>Displays the right channel mixer value in a bar
2083 as reported by the OS. See docs for $mixer for details on
2090 <option>moc_album</option>
2093 <listitem>Album of the current MOC song
2099 <option>moc_artist</option>
2102 <listitem>Artist of the current MOC song
2108 <option>moc_bitrate</option>
2111 <listitem>Bitrate in the current MOC song
2117 <option>moc_curtime</option>
2120 <listitem>Current time of the current MOC song
2126 <option>moc_file</option>
2129 <listitem>File name of the current MOC song
2135 <option>moc_rate</option>
2138 <listitem>Rate of the current MOC song
2144 <option>moc_song</option>
2147 <listitem>The current song name being played in MOC.
2153 <option>moc_state</option>
2156 <listitem>Current state of MOC; playing, stopped etc.
2162 <option>moc_timeleft</option>
2165 <listitem>Time left in the current MOC song
2171 <option>moc_title</option>
2174 <listitem>Title of the current MOC song
2180 <option>moc_totaltime</option>
2183 <listitem>Total length of the current MOC song
2189 <option>monitor</option>
2192 <listitem>Number of the monitor on which conky is running
2193 or the message "Not running in X" if this is the case.
2199 <option>monitor_number</option>
2202 <listitem>Number of monitors or the message "Not running in
2203 X" if this is the case.
2209 <option>mpd_album</option>
2212 <listitem>Album in current MPD song
2218 <option>mpd_artist</option>
2221 <listitem>Artist in current MPD song must be enabled at
2228 <option>mpd_bar</option>
2230 <option>(height),(width)</option>
2232 <listitem>Bar of mpd's progress
2238 <option>mpd_bitrate</option>
2241 <listitem>Bitrate of current song
2247 <option>mpd_elapsed</option>
2250 <listitem>Song's elapsed time
2256 <option>mpd_file</option>
2259 <listitem>Prints the file name of the current MPD song
2265 <option>mpd_length</option>
2268 <listitem>Song's length
2274 <option>mpd_name</option>
2277 <listitem>Prints the MPD name field
2283 <option>mpd_percent</option>
2286 <listitem>Percent of song's progress
2292 <option>mpd_random</option>
2295 <listitem>Random status (On/Off)
2301 <option>mpd_repeat</option>
2304 <listitem>Repeat status (On/Off)
2310 <option>mpd_smart</option>
2312 <option>(max length)</option>
2314 <listitem>Prints the song name in either the form "artist -
2315 title" or file name, depending on whats available
2321 <option>mpd_status</option>
2324 <listitem>Playing, stopped, et cetera.
2330 <option>mpd_title</option>
2332 <option>(max length)</option>
2334 <listitem>Title of current MPD song
2340 <option>mpd_track</option>
2343 <listitem>Prints the MPD track field
2349 <option>mpd_vol</option>
2352 <listitem>MPD's volume
2358 <option>nameserver</option>
2360 <option>(index)</option>
2362 <listitem>Print a nameserver from /etc/resolv.conf. Index
2363 starts at and defaults to 0.
2369 <option>new_mails</option>
2371 <option>(mailbox)</option>
2372 <option>(interval)</option>
2374 <listitem>Unread mail count in the specified mailbox or
2375 mail spool if not. Both mbox and maildir type mailboxes are
2382 <option>nodename</option>
2391 <option>nvidia</option>
2393 <option>threshold</option>
2394 <option>temp</option>
2395 <option>ambient</option>
2396 <option>gpufreq</option>
2397 <option>memfreq</option>
2398 <option>imagequality</option>
2400 <listitem>Nvidia graficcard support for the XNVCtrl
2401 library. Each option can be shortened to the least
2402 significant part. Temperatures are printed as float, all
2403 other values as integer.
2406 <command>threshold</command>The thresholdtemperature at
2407 which the gpu slows down</member>
2409 <command>temp</command>Tives the gpu current
2410 temperature</member>
2412 <command>ambient</command>
2413 <option>Gives current air temperature near GPU
2417 <command>gpufreq</command>
2418 <option>Gives the current gpu frequency</option>
2421 <command>memfreq</command>
2422 <option>Gives the current mem frequency</option>
2425 <command>imagequality</command>
2426 <option>Which imagequality should be choosen by
2427 OpenGL applications</option>
2435 <option>offset</option>
2437 <option>(pixels)</option>
2439 <listitem>Move text over by N pixels. See also $voffset.
2445 <option>outlinecolor</option>
2447 <option>(color)</option>
2449 <listitem>Change outline color
2455 <option>pb_battery</option>
2457 <option>item</option>
2459 <listitem>If running on Apple powerbook/ibook, display
2460 information on battery status. The item parameter
2461 specifies, what information to display. Exactly one item
2462 must be specified. Valid items are:
2465 <command>status</command>
2466 <option>Display if battery is fully charged,
2467 charging, discharging or absent (running on
2471 <command>percent</command>
2472 <option>Display charge of battery in percent, if
2473 charging or discharging. Nothing will be displayed,
2474 if battery is fully charged or absent.</option>
2477 <command>time</command>
2478 <option>Display the time remaining until the
2479 battery will be fully charged or discharged at
2480 current rate. Nothing is displayed, if battery is
2481 absent or if it's present but fully charged and not
2482 discharging.</option>
2490 <option>platform</option>
2492 <option>(dev) type n (factor offset)</option>
2494 <listitem>Platform sensor from sysfs (Linux 2.6). Parameter
2495 dev may be omitted if you have only one platform device.
2496 Platform type is either 'in' or 'vol' meaning voltage;
2497 'fan' meaning fan; 'temp' meaning temperature. Parameter n
2498 is number of the sensor. See /sys/bus/platform/devices/ on
2499 your local computer. The optional arguments 'factor' and
2500 'offset' allow precalculation of the raw input, which is
2501 being modified as follows: 'input = input * factor +
2502 offset'. Note that they have to be given as decimal values
2503 (i.e. contain at least one decimal place).
2509 <option>pop3_unseen</option>
2511 <option>(args)</option>
2513 <listitem>Displays the number of unseen messages in your
2514 global POP3 inbox by default. You can define individual
2515 POP3 inboxes seperately by passing arguments to this
2516 object. Arguments are: "host user pass [-i interval (in
2517 seconds)] [-p port] [-e 'command'] [-r retries]". Default
2518 port is 110, default interval is 5 minutes, and default
2519 number of retries before giving up is 5. If the password is
2520 supplied as '*', you will be prompted to enter the password
2527 <option>pop3_used</option>
2529 <option>(args)</option>
2531 <listitem>Displays the amount of space (in MiB, 2^20) used
2532 in your global POP3 inbox by default. You can define
2533 individual POP3 inboxes seperately by passing arguments to
2534 this object. Arguments are: "host user pass [-i interval
2535 (in seconds)] [-p port] [-e 'command'] [-r retries]". Default
2536 port is 110, default interval is 5 minutes, and default
2537 number of retries before giving up is 5. If the password is
2538 supplied as '*', you will be prompted to enter the password
2545 <option>pre_exec</option>
2547 <option>shell command</option>
2549 <listitem>Executes a shell command one time before conky
2550 displays anything and puts output as text.
2556 <option>processes</option>
2559 <listitem>Total processes (sleeping and running)
2565 <option>read_tcp</option>
2567 <option>(host) port</option>
2569 <listitem>Connects to a tcp port on a host (default is
2570 localhost), reads every char available at the moment and
2577 <option>replied_mails</option>
2579 <option>(maildir)</option>
2580 <option>(interval)</option>
2582 <listitem>Number of mails marked as replied in the
2583 specified mailbox or mail spool if not. Only maildir type
2584 mailboxes are supported, mbox type will return -1.
2590 <option>rss</option>
2592 <option>uri interval_in_minutes action (num_par
2593 (spaces_in_front))</option>
2596 <para>Download and parse RSS feeds. The interval may be
2597 a floating point value greater than 0, otherwise
2598 defaults to 15 minutes. Action may be one of the
2599 following: feed_title, item_title (with num par),
2600 item_desc (with num par) and item_titles (when using
2601 this action and spaces_in_front is given conky places
2602 that many spaces in front of each item). This object is
2603 threaded, and once a thread is created it can't be
2604 explicitely destroyed. One thread will run for each URI
2605 specified. You can use any protocol that Curl
2612 <option>running_processes</option>
2615 <listitem>Running processes (not sleeping), requires Linux
2622 <option>scroll</option>
2624 <option>length (step) text</option>
2626 <listitem>Scroll 'text' by 'step' characters showing
2627 'length' number of characters at the same time. The text
2628 may also contain variables. 'step' is optional and defaults
2629 to 1 if not set. If a var creates output on multiple lines
2630 then the lines are placed behind each other separated with
2631 a '|'-sign. If you change the textcolor inside $scroll it
2632 will automatically have it's old value back at the end of
2633 $scroll. The end and the start of text will be seperated by
2634 'length' number of spaces.
2640 <option>seen_mails</option>
2642 <option>(maildir)</option>
2643 <option>(interval)</option>
2645 <listitem>Number of mails marked as seen in the specified
2646 mailbox or mail spool if not. Only maildir type mailboxes
2647 are supported, mbox type will return -1.
2653 <option>shadecolor</option>
2655 <option>(color)</option>
2657 <listitem>Change shading color
2663 <option>smapi</option>
2665 <option>(ARGS)</option>
2667 <listitem>when using smapi, display contents of the
2668 /sys/devices/platform/smapi directory. ARGS are either
2669 '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the
2670 corresponding files' content. This is a very raw method of
2671 accessing the smapi values. When available, better use one
2672 of the smapi_* variables instead.
2678 <option>smapi_bat_bar</option>
2680 <option>(INDEX),(height),(width)</option>
2682 <listitem>when using smapi, display the remaining capacity
2683 of the battery with index INDEX as a bar.
2689 <option>smapi_bat_perc</option>
2691 <option>(INDEX)</option>
2693 <listitem>when using smapi, display the remaining capacity
2694 in percent of the battery with index INDEX. This is a
2695 separate variable because it supports the 'use_spacer'
2696 configuration option.
2702 <option>smapi_bat_power</option>
2704 <option>INDEX</option>
2706 <listitem>when using smapi, display the current power of
2707 the battery with index INDEX in watt. This is a separate
2708 variable because the original read out value is being
2709 converted from mW. The sign of the output reflects charging
2710 (positive) or discharging (negative) state.
2716 <option>smapi_bat_temp</option>
2718 <option>INDEX</option>
2720 <listitem>when using smapi, display the current temperature
2721 of the battery with index INDEX in degree Celsius. This is
2722 a separate variable because the original read out value is
2723 being converted from milli degree Celsius.
2729 <option>sony_fanspeed</option>
2732 <listitem>Displays the Sony VAIO fanspeed information if
2733 sony-laptop kernel support is enabled. Linux only.
2739 <option>stippled_hr</option>
2741 <option>(space)</option>
2743 <listitem>Stippled (dashed) horizontal line
2749 <option>swap</option>
2752 <listitem>Amount of swap in use
2758 <option>swapbar</option>
2760 <option>(height),(width)</option>
2762 <listitem>Bar that shows amount of swap in use
2768 <option>swapfree</option>
2771 <listitem>Amount of free swap
2777 <option>swapmax</option>
2780 <listitem>Total amount of swap
2786 <option>swapperc</option>
2789 <listitem>Percentage of swap in use
2795 <option>sysname</option>
2798 <listitem>System name, Linux for example
2804 <option>tab</option>
2806 <option>(width, (start))</option>
2808 <listitem>Puts a tab of the specified width, starting from
2809 column 'start'. The unit is pixels for both arguments.
2815 <option>tail</option>
2817 <option>logfile lines (next_check)</option>
2819 <listitem>Displays last N lines of supplied text file. The
2820 file is checked every 'next_check' update. If next_check is
2821 not supplied, Conky defaults to 2. Max of 30 lines can be
2822 displayed, or until the text buffer is filled.
2828 <option>tcp_portmon</option>
2830 <option>port_begin port_end item (index)</option>
2831 <emphasis>(ip4 only at present)</emphasis>
2834 <para>TCP port monitor for specified local ports. Port
2835 numbers must be in the range 1 to 65535. Valid items
2839 <command>count</command>
2840 <option>Total number of connections in the
2844 <command>rip</command>
2845 <option>Remote ip address</option>
2848 <command>rhost</command>
2849 <option>Remote host name</option>
2852 <command>rport</command>
2853 <option>Remote port number</option>
2856 <command>rservice</command>
2857 <option>Remote service name from
2858 /etc/services</option>
2861 <command>lip</command>
2862 <option>Local ip address</option>
2865 <command>lhost</command>
2866 <option>Local host name</option>
2869 <command>lport</command>
2870 <option>Local port number</option>
2873 <command>lservice</command>
2874 <option>Local service name from
2875 /etc/services</option>
2878 <para>The connection index provides you with access to
2879 each connection in the port monitor. The monitor will
2880 return information for index values from 0 to n-1
2881 connections. Values higher than n-1 are simply ignored.
2882 For the "count" item, the connection index must be
2883 omitted. It is required for all other items.</para>
2884 <para>Examples:</para>
2887 <command>${tcp_portmon 6881 6999
2889 <option>Displays the number of connections in
2890 the bittorrent port range</option>
2893 <command>${tcp_portmon 22 22 rip 0}</command>
2894 <option>Displays the remote host ip of the
2895 first sshd connection</option>
2898 <command>${tcp_portmon 22 22 rip 9}</command>
2899 <option>Displays the remote host ip of the
2900 tenth sshd connection</option>
2903 <command>${tcp_portmon 1 1024 rhost
2905 <option>Displays the remote host name of the
2906 first connection on a privileged port</option>
2909 <command>${tcp_portmon 1 1024 rport
2911 <option>Displays the remote host port of the
2912 fifth connection on a privileged port</option>
2915 <command>${tcp_portmon 1 65535 lservice
2917 <option>Displays the local service name of the
2918 fifteenth connection in the range of all
2922 <para>Note that port monitor variables which share the
2923 same port range actually refer to the same monitor, so
2924 many references to a single port range for different
2925 items and different indexes all use the same monitor
2926 internally. In other words, the program avoids creating
2927 redundant monitors.</para>
2933 <option>templateN</option>
2935 <option>(arg1)</option>
2936 <option>(arg2)</option>
2937 <option>(arg3 ...)</option>
2940 <para>Evaluate the content of the templateN
2941 configuration variable (where N is a value between 0
2942 and 9, inclusively), applying substitutions as
2943 described in the documentation of the corresponding
2944 configuration variable. The number of arguments is
2945 optional, but must match the highest referred index in
2946 the template. You can use the same special sequences in
2947 each argument as the ones valid for a template
2948 definition, e.g. to allow an argument to contain a
2949 whitespace. Also simple nesting of templates is
2950 possible this way.</para>
2951 <para>Here are some examples of template
2954 <member>template0 $\1\2</member>
2955 <member>template1 \1: ${fs_used \2} / ${fs_size
2957 <member>template2 \1 \2</member>
2959 <para>The following list shows sample usage of the
2960 templates defined above, with the equivalent syntax
2961 when not using any template at all:</para>
2966 <entry>using template</entry>
2967 <entry>same without template</entry>
2972 <entry>${template0 node name}</entry>
2973 <entry>$nodename</entry>
2976 <entry>${template1 root /}</entry>
2977 <entry>root: ${fs_free /} / ${fs_size
2982 <programlisting>${template1
2983 ${template2\ disk\ root}
2987 <programlisting>disk root:
2988 ${fs_free /} / ${fs_size
3000 <option>texeci</option>
3002 <option>interval command</option>
3004 <listitem>Runs a command at an interval inside a thread and
3005 displays the output. Same as $execi, except the command is
3006 run inside a thread. Use this if you have a slow script to
3007 keep Conky updating. You should make the interval slightly
3008 longer then the time it takes your script to execute. For
3009 example, if you have a script that take 5 seconds to
3010 execute, you should make the interval at least 6 seconds.
3011 See also $execi. This object will clean up the thread when
3012 it is destroyed, so it can safely be used in a nested
3013 fashion, though it may not produce the desired behaviour if
3020 <option>time</option>
3022 <option>(format)</option>
3024 <listitem>Local time, see man strftime to get more
3025 information about format
3031 <option>to_bytes</option>
3033 <option>size</option>
3035 <listitem>If 'size' is a number followed by a size-unit
3036 (kilobyte,mb,GiB,...) then it converts the size to bytes
3037 and shows it without unit, otherwise it just shows 'size'.
3043 <option>top</option>
3045 <option>type, num</option>
3047 <listitem>This takes arguments in the form:top (name)
3048 (number) Basically, processes are ranked from highest to
3049 lowest in terms of cpu usage, which is what (num)
3050 represents. The types are: "name", "pid", "cpu", "mem",
3051 "mem_res", "mem_vsize", "time", "io_perc", "io_read" and
3052 "io_write". There can be a max of 10 processes listed.
3058 <option>top_io</option>
3060 <option>type, num</option>
3062 <listitem>Same as top, except sorted by the amount of I/O
3063 the process has done during the update interval
3069 <option>top_mem</option>
3071 <option>type, num</option>
3073 <listitem>Same as top, except sorted by mem usage instead
3080 <option>top_time</option>
3082 <option>type, num</option>
3084 <listitem>Same as top, except sorted by total CPU time
3085 instead of current CPU usage
3091 <option>totaldown</option>
3093 <option>(net)</option>
3095 <listitem>Total download, overflows at 4 GB on Linux with
3096 32-bit arch and there doesn't seem to be a way to know how
3097 many times it has already done that before conky has
3104 <option>totalup</option>
3106 <option>(net)</option>
3108 <listitem>Total upload, this one too, may overflow
3114 <option>trashed_mails</option>
3116 <option>(maildir)</option>
3117 <option>(interval)</option>
3119 <listitem>Number of mails marked as trashed in the
3120 specified mailbox or mail spool if not. Only maildir type
3121 mailboxes are supported, mbox type will return -1.
3127 <option>tztime</option>
3129 <option>(timezone (format))</option>
3131 <listitem>Local time for specified timezone, see man
3132 strftime to get more information about format. The timezone
3133 argument is specified in similar fashion as TZ environment
3134 variable. For hints, look in /usr/share/zoneinfo. e.g.
3135 US/Pacific, Europe/Zurich, etc.
3141 <option>unflagged_mails</option>
3143 <option>(maildir)</option>
3144 <option>(interval)</option>
3146 <listitem>Number of mails not marked as flagged in the
3147 specified mailbox or mail spool if not. Only maildir type
3148 mailboxes are supported, mbox type will return -1.
3154 <option>unforwarded_mails</option>
3156 <option>(maildir)</option>
3157 <option>(interval)</option>
3159 <listitem>Number of mails not marked as forwarded in the
3160 specified mailbox or mail spool if not. Only maildir type
3161 mailboxes are supported, mbox type will return -1.
3167 <option>unreplied_mails</option>
3169 <option>(maildir)</option>
3170 <option>(interval)</option>
3172 <listitem>Number of mails not marked as replied in the
3173 specified mailbox or mail spool if not. Only maildir type
3174 mailboxes are supported, mbox type will return -1.
3180 <option>unseen_mails</option>
3182 <option>(maildir)</option>
3183 <option>(interval)</option>
3185 <listitem>Number of new or unseen mails in the specified
3186 mailbox or mail spool if not. Only maildir type mailboxes
3187 are supported, mbox type will return -1.
3193 <option>updates</option>
3195 <option>Number of updates</option>
3197 <listitem>for debugging
3203 <option>upspeed</option>
3205 <option>(net)</option>
3207 <listitem>Upload speed in suitable IEC units
3213 <option>upspeedf</option>
3215 <option>(net)</option>
3217 <listitem>Upload speed in KiB with one decimal
3223 <option>upspeedgraph</option>
3225 <option>(netdev) (height),(width) (gradient colour 1)
3226 (gradient colour 2) (scale) (-t) (-l)</option>
3228 <listitem>Upload speed graph, colours defined in hex, minus
3229 the #. If scale is non-zero, it becomes the scale for the
3230 graph. Uses a logarithmic scale (to see small numbers) when
3231 you use the -l switch. Takes the switch '-t' to use a
3232 temperature gradient, which makes the gradient values
3233 change depending on the amplitude of a particular graph
3234 value (try it and see).
3240 <option>uptime</option>
3249 <option>uptime_short</option>
3252 <listitem>Uptime in a shorter format
3258 <option>user_names</option>
3261 <listitem>Lists the names of the users logged in
3267 <option>user_number</option>
3270 <listitem>Number of users logged in
3276 <option>user_terms</option>
3279 <listitem>Lists the consoles in use
3285 <option>user_times</option>
3288 <listitem>Lists how long users have been logged in for
3294 <option>utime</option>
3296 <option>(format)</option>
3298 <listitem>Display time in UTC (universal coordinate time).
3304 <option>voffset</option>
3306 <option>(pixels)</option>
3308 <listitem>Change vertical offset by N pixels. Negative
3309 values will cause text to overlap. See also $offset.
3315 <option>voltage_mv</option>
3317 <option>(n)</option>
3319 <listitem>Returns CPU #n's voltage in mV. CPUs are counted
3320 from 1. If omitted, the parameter defaults to 1.
3326 <option>voltage_v</option>
3328 <option>(n)</option>
3330 <listitem>Returns CPU #n's voltage in V. CPUs are counted
3331 from 1. If omitted, the parameter defaults to 1.
3337 <option>weather</option>
3339 <option>URI locID data_type
3340 (interval_in_minutes)</option>
3343 <para>Download, parse and display METAR data.</para>
3344 <para>For the 'URI', there are two
3345 possibilities:</para>
3348 http://weather.noaa.gov/pub/data/observations/metar/stations/</member>
3350 http://xoap.weather.com/weather/local/</member>
3352 <para>The first one is free to use but the second
3353 requires you to register and obtain your partner ID and
3354 license key. These two must be written, separated by a
3355 space, into a file called .xoaprc which needs to be
3356 placed into your home directory.</para>
3357 <para>'locID' must be a valid location identifier for
3358 the required uri. For the NOAA site this must be a
3359 valid ICAO (see for instance
3360 https://pilotweb.nas.faa.gov/qryhtml/icao/). For the
3361 weather.com site this must be a valid location ID (see
3363 http://aspnetresources.com/tools/locid.aspx).</para>
3364 <para>'data_type' must be one of the following:</para>
3367 <command>last_update</command>
3368 <para>The date and time stamp of the data.
3369 The result depends on the URI used. For the
3370 NOAA site it is date (yyyy/mm/dd) and UTC time.
3371 For the weather.com one it is date
3372 ([m]m/[d]d/yy) and Local Time of the
3376 <command>temperature</command>
3377 <para>Air temperature (you can use the
3378 'temperature_unit' config setting to change
3382 <command>cloud_cover</command>
3383 <para>The highest cloud cover status</para>
3386 <command>pressure</command>
3387 <para>Air pressure in millibar</para>
3390 <command>wind_speed</command>
3391 <para>Wind speed in km/h</para>
3394 <command>wind_dir</command>
3395 <para>Wind direction</para>
3398 <command>wind_dir_DEG</command>
3399 <para>Compass wind direction</para>
3402 <command>humidity</command>
3403 <para>Relative humidity in %</para>
3406 <command>weather</command>
3407 <para>Any relevant weather event (rain, snow,
3408 etc.). This is not used if you are querying the
3409 weather.com site since this data is aggregated
3410 into the cloud_cover one</para>
3413 <command>icon</command>
3414 <para>Weather icon (only for
3415 www.weather.com). Can be used together with the
3416 icon kit provided upon registering to their
3420 <para>'delay_in_minutes' (optional, default 30) cannot
3421 be less than 30 minutes.</para>
3422 <para>This object is threaded, and once a thread is
3423 created it can't be explicitely destroyed. One thread
3424 will run for each URI specified.</para>
3425 <para>Note that these variables are still EXPERIMENTAL
3426 and can be subject to many future changes.</para>
3432 <option>weather_forecast</option>
3434 <option>URI locID day data_type
3435 (interval_in_minutes)</option>
3438 <para>Download, parse and display weather forecast data
3439 for a given day (daytime only).</para>
3440 <para>For the 'URI', for the time being only
3441 http://xoap.weather.com/weather/local/ is
3442 supported. See 'weather' above for details of usage</para>
3443 <para>'locID', see 'weather' above.</para>
3444 <para>'day' is a number from 0 (today) to 4 (3 days
3445 after tomorrow).</para>
3446 <para>'data_type' must be one of the following:</para>
3449 <command>day</command>
3450 <option>Day of the week</option>
3453 <command>date</command>
3454 <option>Date, in the form MMM DD (ie. Jul 14)</option>
3457 <command>low</command>
3458 <option>Minimun temperature (you can use the
3459 'temperature_unit' config setting to change
3463 <command>hi</command>
3464 <option>Maximum temperature (you can use the
3465 'temperature_unit' config setting to change
3469 <command>icon</command>
3470 <option>Weather icon. Can be used together with the
3471 icon kit provided upon registering to the weather.com
3475 <command>forecast</command>
3476 <option>Weather forecast (sunny, rainy, etc.)</option>
3479 <command>wind_speed</command>
3480 <option>Wind speed in km/h</option>
3483 <command>wind_dir</command>
3484 <option>Wind direction</option>
3487 <command>wind_dir_DEG</command>
3488 <option>Compass wind direction</option>
3491 <command>humidity</command>
3492 <option>Relative humidity in %</option>
3495 <command>precipitation</command>
3496 <option>Probability of having a
3497 precipitation (in %)</option>
3500 <para>'delay_in_minutes' (optional, default 210) cannot
3501 be lower than 210 min.</para>
3502 <para>This object is threaded, and once a thread is
3503 created it can't be explicitely destroyed. One thread
3504 will run for each URI specified. You can use any
3505 protocol that Curl supports.</para>
3506 <para>Note that these variables are still EXPERIMENTAL
3507 and can be subject to many future changes.</para>
3513 <option>wireless_ap</option>
3515 <option>(net)</option>
3517 <listitem>Wireless access point MAC address (Linux only)
3523 <option>wireless_bitrate</option>
3525 <option>(net)</option>
3527 <listitem>Wireless bitrate (ie 11 Mb/s) (Linux only)
3533 <option>wireless_essid</option>
3535 <option>(net)</option>
3537 <listitem>Wireless access point ESSID (Linux only)
3543 <option>wireless_link_bar</option>
3545 <option>(height),(width) (net)</option>
3547 <listitem>Wireless link quality bar (Linux only)
3553 <option>wireless_link_qual</option>
3555 <option>(net)</option>
3557 <listitem>Wireless link quality (Linux only)
3563 <option>wireless_link_qual_max</option>
3565 <option>(net)</option>
3567 <listitem>Wireless link quality maximum value (Linux only)
3573 <option>wireless_link_qual_perc</option>
3575 <option>(net)</option>
3577 <listitem>Wireless link quality in percents (Linux only)
3583 <option>wireless_mode</option>
3585 <option>(net)</option>
3587 <listitem>Wireless mode (Managed/Ad-Hoc/Master) (Linux
3594 <option>words</option>
3596 <option>textfile</option>
3598 <listitem>Displays the number of words in the given file
3604 <option>xmms2_album</option>
3607 <listitem>Album in current XMMS2 song
3613 <option>xmms2_artist</option>
3616 <listitem>Artist in current XMMS2 song
3622 <option>xmms2_bar</option>
3624 <option>(height),(width)</option>
3626 <listitem>Bar of XMMS2's progress
3632 <option>xmms2_bitrate</option>
3635 <listitem>Bitrate of current song
3641 <option>xmms2_comment</option>
3644 <listitem>Comment in current XMMS2 song
3650 <option>xmms2_date</option>
3653 <listitem>Returns song's date.
3659 <option>xmms2_duration</option>
3662 <listitem>Duration of current song
3668 <option>xmms2_elapsed</option>
3671 <listitem>Song's elapsed time
3677 <option>xmms2_genre</option>
3680 <listitem>Genre in current XMMS2 song
3686 <option>xmms2_id</option>
3689 <listitem>XMMS2 id of current song
3695 <option>xmms2_percent</option>
3698 <listitem>Percent of song's progress
3704 <option>xmms2_playlist</option>
3707 <listitem>Returns the XMMS2 playlist.
3713 <option>xmms2_size</option>
3716 <listitem>Size of current song
3722 <option>xmms2_smart</option>
3725 <listitem>Prints the song name in either the form "artist -
3726 title" or file name, depending on whats available
3732 <option>xmms2_status</option>
3735 <listitem>XMMS2 status (Playing, Paused, Stopped, or
3742 <option>xmms2_timesplayed</option>
3745 <listitem>Number of times a song was played (presumably).
3751 <option>xmms2_title</option>
3754 <listitem>Title in current XMMS2 song
3760 <option>xmms2_tracknr</option>
3763 <listitem>Track number in current XMMS2 song
3769 <option>xmms2_url</option>
3772 <listitem>Full path to current song
projects / monky / blob