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_user_time</option>
599 <listitem>List how long the user that launched
600 conky has been logged in for.
606 <option>conky_version</option>
609 <listitem>Conky version
617 <option>(cpuN)</option>
619 <listitem>CPU usage in percents. For SMP machines, the CPU
620 number can be provided as an argument. ${cpu cpu0} is the
621 total usage, and ${cpu cpuX} (X >= 1) are individual
628 <option>cpubar</option>
630 <option>(cpuN) (height),(width)</option>
632 <listitem>Bar that shows CPU usage, height is bar's height
633 in pixels. See $cpu for more info on SMP.
639 <option>cpugauge</option>
641 <option>(cpuN) (height),(width)</option>
643 <listitem>Elliptical gauge that shows CPU usage, height and
644 width are gauge's vertical and horizontal axis
645 respectively. See $cpu for more info on SMP.
651 <option>cpugraph</option>
653 <option>(cpuN) (height),(width) (gradient colour 1)
654 (gradient colour 2) (scale) (-t) (-l)</option>
656 <listitem>CPU usage graph, with optional colours in hex,
657 minus the #. See $cpu for more info on SMP. Uses a
658 logarithmic scale (to see small numbers) when you use the
659 -l switch. Takes the switch '-t' to use a temperature
660 gradient, which makes the gradient values change depending
661 on the amplitude of a particular graph value (try it and
668 <option>curl</option>
670 <option>url (interval_in_minutes)</option>
673 <para>Download data from URI using Curl at the
674 specified interval. The interval may be a floating
675 point value greater than 0, otherwise defaults to 15
676 minutes. Most useful when used in conjunction with Lua
677 and the Lua API. This object is threaded, and once a
678 thread is created it can't be explicitely destroyed.
679 One thread will run for each URI specified. You can use
680 any protocol that Curl supports.</para>
686 <option>desktop</option>
689 <listitem>Number of the desktop on which conky is running
690 or the message "Not running in X" if this is the case.
696 <option>desktop_name</option>
699 <listitem>Name of the desktop on which conky is running or
700 the message "Not running in X" if this is the case.
706 <option>desktop_number</option>
709 <listitem>Number of desktops or the message "Not running in
710 X" if this is the case.
716 <option>disk_protect</option>
718 <option>device</option>
720 <listitem>Disk protection status, if supported (needs
721 kernel-patch). Prints either "frozen" or "free " (note the
728 <option>diskio</option>
730 <option>(device)</option>
732 <listitem>Displays current disk IO. Device is optional, and
733 takes the form of sda for /dev/sda. Individual partitions
740 <option>diskio_read</option>
742 <option>(device)</option>
744 <listitem>Displays current disk IO for reads. Device as in
751 <option>diskio_write</option>
753 <option>(device)</option>
755 <listitem>Displays current disk IO for writes. Device as in
762 <option>diskiograph</option>
764 <option>(device) (height),(width) (gradient colour 1)
765 (gradient colour 2) (scale) (-t) (-l)</option>
767 <listitem>Disk IO graph, colours defined in hex, minus the
768 #. If scale is non-zero, it becomes the scale for the
769 graph. Uses a logarithmic scale (to see small numbers) when
770 you use -l switch. Takes the switch '-t' to use a
771 temperature gradient, which makes the gradient values
772 change depending on the amplitude of a particular graph
773 value (try it and see).
779 <option>diskiograph_read</option>
781 <option>(device) (height),(width) (gradient colour 1)
782 (gradient colour 2) (scale) (-t) (-l)</option>
784 <listitem>Disk IO graph for reads, colours defined in hex,
785 minus the #. If scale is non-zero, it becomes the scale for
786 the graph. Device as in diskio. Uses a logarithmic scale
787 (to see small numbers) when you use -l switch. Takes the
788 switch '-t' to use a temperature gradient, which makes the
789 gradient values change depending on the amplitude of a
790 particular graph value (try it and see).
796 <option>diskiograph_write</option>
798 <option>(device) (height),(width) (gradient colour 1)
799 (gradient colour 2) (scale) (-t) (-l)</option>
801 <listitem>Disk IO graph for writes, colours defined in hex,
802 minus the #. If scale is non-zero, it becomes the scale for
803 the graph. Device as in diskio. Uses a logarithmic scale
804 (to see small numbers) when you use -l switch. Takes the
805 switch '-t' to use a temperature gradient, which makes the
806 gradient values change depending on the amplitude of a
807 particular graph value (try it and see).
813 <option>downspeed</option>
815 <option>(net)</option>
817 <listitem>Download speed in suitable IEC units
823 <option>downspeedf</option>
825 <option>(net)</option>
827 <listitem>Download speed in KiB with one decimal
833 <option>downspeedgraph</option>
835 <option>(netdev) (height),(width) (gradient colour 1)
836 (gradient colour 2) (scale) (-t) (-l)</option>
838 <listitem>Download speed graph, colours defined in hex,
839 minus the #. If scale is non-zero, it becomes the scale for
840 the graph. Uses a logarithmic scale (to see small numbers)
841 when you use -l switch. Takes the switch '-t' to use a
842 temperature gradient, which makes the gradient values
843 change depending on the amplitude of a particular graph
844 value (try it and see).
850 <option>draft_mails</option>
852 <option>(maildir)</option>
853 <option>(interval)</option>
855 <listitem>Number of mails marked as draft in the specified
856 mailbox or mail spool if not. Only maildir type mailboxes
857 are supported, mbox type will return -1.
863 <option>else</option>
866 <listitem>Text to show if any of the above are not true
872 <option>endif</option>
876 <listitem>Ends an $if block.
882 <option>entropy_avail</option>
885 <listitem>Current entropy available for crypto freaks
891 <option>entropy_bar</option>
893 <option>(height),(width)</option>
895 <listitem>Normalized bar of available entropy for crypto
902 <option>entropy_perc</option>
905 <listitem>Percentage of entropy available in comparison to
912 <option>entropy_poolsize</option>
915 <listitem>Total size of system entropy pool for crypto
922 <option>eval</option>
924 <option>string</option>
926 <listitem>Evaluates given string according to the rules of
927 TEXT interpretation, i.e. parsing any contained text object
928 specifications into their output, any occuring '$$' into a
929 single '$' and so on. The output is then being parsed
938 <option>api_userid api_key character_id</option>
940 <listitem>Fetches your currently training skill from the
941 Eve Online API servers (http://www.eve-online.com/) and
942 displays the skill along with the remaining training time.
948 <option>exec</option>
950 <option>command</option>
952 <listitem>Executes a shell command and displays the output
953 in conky. warning: this takes a lot more resources than
954 other variables. I'd recommend coding wanted behaviour in C
961 <option>execbar</option>
963 <option>command</option>
965 <listitem>Same as exec, except if the first value return is
966 a value between 0-100, it will use that number for a bar.
967 The size for bars can be controlled via the
968 default_bar_size config setting.
974 <option>execgauge</option>
976 <option>command</option>
978 <listitem>Same as exec, except if the first value returned
979 is a value between 0-100, it will use that number for a
980 gauge. The size for gauges can be controlled via the
981 default_gauge_size config setting.
987 <option>execgraph</option>
989 <option>(-t) (-l) command</option>
991 <listitem>Same as execbar, but graphs values. Uses a
992 logaritmic scale when the log option (-l switch) is given
993 (to see small numbers). Values still have to be between 0
994 and 100. The size for graphs can be controlled via the
995 default_graph_size config setting. Takes the switch '-t' to
996 use a temperature gradient, which makes the gradient values
997 change depending on the amplitude of a particular graph
998 value (try it and see). If -t or -l is your first argument,
999 you may need to preceed it by a space (' ').
1005 <option>execi</option>
1007 <option>interval command</option>
1009 <listitem>Same as exec but with specific interval. Interval
1010 can't be less than update_interval in configuration. See
1017 <option>execibar</option>
1019 <option>interval command</option>
1021 <listitem>Same as execbar, except with an interval
1027 <option>execigauge</option>
1029 <option>interval command</option>
1031 <listitem>Same as execgauge, but takes an interval arg and
1038 <option>execigraph</option>
1040 <option>interval (-t) (-l) command</option>
1042 <listitem>Same as execgraph, but takes an interval arg and
1043 graphs values. If -t or -l is your first argument, you may
1044 need to preceed it by a space (' ').
1050 <option>execp</option>
1052 <option>command</option>
1054 <listitem>Executes a shell command and displays the output
1055 in conky. warning: this takes a lot more resources than
1056 other variables. I'd recommend coding wanted behaviour in C
1057 and posting a patch. This differs from $exec in that it
1058 parses the output of the command, so you can insert things
1059 like ${color red}hi!${color} in your script and have it
1060 correctly parsed by Conky. Caveats: Conky parses and
1061 evaluates the output of $execp every time Conky loops, and
1062 then destroys all the objects. If you try to use anything
1063 like $execi within an $execp statement, it will
1064 functionally run at the same interval that the $execp
1065 statement runs, as it is created and destroyed at every
1072 <option>execpi</option>
1074 <option>interval command</option>
1076 <listitem>Same as execp but with specific interval.
1077 Interval can't be less than update_interval in
1078 configuration. Note that the output from the $execpi
1079 command is still parsed and evaluated at every interval.
1085 <option>flagged_mails</option>
1087 <option>(maildir)</option>
1088 <option>(interval)</option>
1090 <listitem>Number of mails marked as flagged in the
1091 specified mailbox or mail spool if not. Only maildir type
1092 mailboxes are supported, mbox type will return -1.
1098 <option>font</option>
1100 <option>(font)</option>
1102 <listitem>Specify a different font. This new font will
1103 apply to the current line and everything following. You can
1104 use a $font with no arguments to change back to the default
1105 font (much like with $color)
1111 <option>forwarded_mails</option>
1113 <option>(maildir)</option>
1114 <option>(interval)</option>
1116 <listitem>Number of mails marked as forwarded in the
1117 specified mailbox or mail spool if not. Only maildir type
1118 mailboxes are supported, mbox type will return -1.
1124 <option>freq</option>
1126 <option>(n)</option>
1128 <listitem>Returns CPU #n's frequency in MHz. CPUs are
1129 counted from 1. If omitted, the parameter defaults to 1.
1135 <option>freq_g</option>
1137 <option>(n)</option>
1139 <listitem>Returns CPU #n's frequency in GHz. CPUs are
1140 counted from 1. If omitted, the parameter defaults to 1.
1146 <option>fs_bar</option>
1148 <option>(height),(width) fs</option>
1150 <listitem>Bar that shows how much space is used on a file
1151 system. height is the height in pixels. fs is any file on
1158 <option>fs_bar_free</option>
1160 <option>(height),(width) fs</option>
1162 <listitem>Bar that shows how much space is free on a file
1163 system. height is the height in pixels. fs is any file on
1170 <option>fs_free</option>
1172 <option>(fs)</option>
1174 <listitem>Free space on a file system available for users.
1180 <option>fs_free_perc</option>
1182 <option>(fs)</option>
1184 <listitem>Free percentage of space on a file system
1185 available for users.
1191 <option>fs_size</option>
1193 <option>(fs)</option>
1195 <listitem>File system size.
1201 <option>fs_type</option>
1203 <option>(fs)</option>
1205 <listitem>File system type.
1211 <option>fs_used</option>
1213 <option>(fs)</option>
1215 <listitem>File system used space.
1221 <option>fs_used_perc</option>
1223 <option>(fs)</option>
1225 <listitem>Percent of file system used space.
1231 <option>goto</option>
1235 <listitem>The next element will be printed at position 'x'.
1242 <option>gw_iface</option>
1245 <listitem>Displays the default route's interface or
1246 "multiple"/"none" accordingly.
1252 <option>gw_ip</option>
1255 <listitem>Displays the default gateway's IP or
1256 "multiple"/"none" accordingly.
1262 <option>hddtemp</option>
1264 <option>(dev)</option>
1266 <listitem>Displays temperature of a selected hard disk
1267 drive as reported by the hddtemp daemon. Use hddtemp_host
1268 and hddtemp_port to specify a host and port for all hddtemp
1269 objects. If no dev parameter is given, the first disk returned
1270 by the hddtemp daemon is used.
1276 <option>head</option>
1278 <option>logfile lines (next_check)</option>
1280 <listitem>Displays first N lines of supplied text file. The
1281 file is checked every 'next_check' update. If next_check is
1282 not supplied, Conky defaults to 2. Max of 30 lines can be
1283 displayed, or until the text buffer is filled.
1291 <option>(height)</option>
1293 <listitem>Horizontal line, height is the height in pixels
1299 <option>hwmon</option>
1301 <option>(dev) type n (factor offset)</option>
1303 <listitem>Hwmon sensor from sysfs (Linux 2.6). Parameter
1304 dev may be omitted if you have only one hwmon device.
1305 Parameter type is either 'in' or 'vol' meaning voltage;
1306 'fan' meaning fan; 'temp' meaning temperature. Parameter n
1307 is number of the sensor. See /sys/class/hwmon/ on your
1308 local computer. The optional arguments 'factor' and
1309 'offset' allow precalculation of the raw input, which is
1310 being modified as follows: 'input = input * factor +
1311 offset'. Note that they have to be given as decimal values
1312 (i.e. contain at least one decimal place).
1318 <option>i2c</option>
1320 <option>(dev) type n (factor offset)</option>
1322 <listitem>I2C sensor from sysfs (Linux 2.6). Parameter dev
1323 may be omitted if you have only one I2C device. Parameter
1324 type is either 'in' or 'vol' meaning voltage; 'fan' meaning
1325 fan; 'temp' meaning temperature. Parameter n is number of
1326 the sensor. See /sys/bus/i2c/devices/ on your local
1327 computer. The optional arguments 'factor' and 'offset'
1328 allow precalculation of the raw input, which is being
1329 modified as follows: 'input = input * factor + offset'.
1330 Note that they have to be given as decimal values (i.e.
1331 contain at least one decimal place).
1337 <option>i8k_ac_status</option>
1341 <listitem>If running the i8k kernel driver for Inspiron
1342 laptops, displays whether ac power is on, as listed in
1343 /proc/i8k (translated to human-readable). Beware that this
1344 is by default not enabled by i8k itself.
1350 <option>i8k_bios</option>
1354 <listitem>If running the i8k kernel driver for Inspiron
1355 laptops, displays the bios version as listed in /proc/i8k.
1361 <option>i8k_buttons_status</option>
1365 <listitem>If running the i8k kernel driver for Inspiron
1366 laptops, displays the volume buttons status as listed in
1373 <option>i8k_cpu_temp</option>
1377 <listitem>If running the i8k kernel driver for Inspiron
1378 laptops, displays the cpu temperature in Celsius, as
1379 reported by /proc/i8k.
1385 <option>i8k_left_fan_rpm</option>
1389 <listitem>If running the i8k kernel driver for Inspiron
1390 laptops, displays the left fan's rate of rotation, in
1391 revolutions per minute as listed in /proc/i8k. Beware, some
1392 laptops i8k reports these fans in reverse order.
1398 <option>i8k_left_fan_status</option>
1402 <listitem>If running the i8k kernel driver for Inspiron
1403 laptops, displays the left fan status as listed in
1404 /proc/i8k (translated to human-readable). Beware, some
1405 laptops i8k reports these fans in reverse order.
1411 <option>i8k_right_fan_rpm</option>
1415 <listitem>If running the i8k kernel driver for Inspiron
1416 laptops, displays the right fan's rate of rotation, in
1417 revolutions per minute as listed in /proc/i8k. Beware, some
1418 laptops i8k reports these fans in reverse order.
1424 <option>i8k_right_fan_status</option>
1428 <listitem>If running the i8k kernel driver for Inspiron
1429 laptops, displays the right fan status as listed in
1430 /proc/i8k (translated to human-readable). Beware, some
1431 laptops i8k reports these fans in reverse order.
1437 <option>i8k_serial</option>
1441 <listitem>If running the i8k kernel driver for Inspiron
1442 laptops, displays your laptop serial number as listed in
1449 <option>i8k_version</option>
1453 <listitem>If running the i8k kernel driver for Inspiron
1454 laptops, displays the version formatting of /proc/i8k.
1460 <option>ibm_brightness</option>
1463 <listitem>If running the IBM ACPI, displays the brigtness
1464 of the laptops's LCD (0-7).
1470 <option>ibm_fan</option>
1473 <listitem>If running the IBM ACPI, displays the fan speed.
1479 <option>ibm_temps</option>
1483 <listitem>If running the IBM ACPI, displays the
1484 temperatures from the IBM temperature sensors (N=0..7)
1485 Sensor 0 is on the CPU, 3 is on the GPU.
1491 <option>ibm_volume</option>
1494 <listitem>If running the IBM ACPI, displays the "master"
1495 volume, controlled by the volume keys (0-14).
1501 <option>iconv_start</option>
1503 <option>codeset_from codeset_to</option>
1505 <listitem>Convert text from one codeset to another using
1506 GNU iconv. Needs to be stopped with iconv_stop.
1512 <option>iconv_stop</option>
1516 <listitem>Stop iconv codeset conversion.
1522 <option>if_empty</option>
1524 <option>(var)</option>
1526 <listitem>if conky variable VAR is empty, display
1527 everything between $if_empty and the matching $endif
1533 <option>if_existing</option>
1535 <option>file (string)</option>
1537 <listitem>if FILE exists, display everything between
1538 if_existing and the matching $endif. The optional second
1539 paramater checks for FILE containing the specified string
1540 and prints everything between $if_existing and the matching
1547 <option>if_gw</option>
1550 <listitem>if there is at least one default gateway, display
1551 everything between $if_gw and the matching $endif
1557 <option>if_match</option>
1559 <option>expression</option>
1561 <listitem>Evaluates the given boolean expression, printing
1562 everything between $if_match and the matching $endif
1563 depending on whether the evaluation returns true or not.
1564 Valid expressions consist of a left side, an operator and a
1565 right side. Left and right sides are being parsed for
1566 contained text objects before evaluation. Recognised left
1567 and right side types are:
1570 <command>double</command>Argument consists of only
1571 digits and a single dot.</member>
1573 <command>long</command>Argument consists of only
1576 <command>string</command>Argument is enclosed in
1577 quotation mark or the checks for double and long failed
1579 </simplelist>Valid operands are: '>', '<', '>=',
1580 '<=', '==', '!='.
1586 <option>if_mixer_mute</option>
1588 <option>(mixer)</option>
1590 <listitem>If mixer exists, display everything between
1591 $if_mixer_mute and the matching $endif. If no mixer is
1592 specified, "Master" is used.
1598 <option>if_mounted</option>
1600 <option>(mountpoint)</option>
1602 <listitem>if MOUNTPOINT is mounted, display everything
1603 between $if_mounted and the matching $endif
1609 <option>if_mpd_playing</option>
1612 <listitem>if mpd is playing or paused, display everything
1613 between $if_mpd_playing and the matching $endif
1619 <option>if_running</option>
1621 <option>(process)</option>
1623 <listitem>if PROCESS is running, display everything
1624 $if_running and the matching $endif. This uses the
1625 ``pidof'' command, so the -x switch is also supported.
1631 <option>if_smapi_bat_installed</option>
1633 <option>(INDEX)</option>
1635 <listitem>when using smapi, if the battery with index INDEX
1636 is installed, display everything between
1637 $if_smapi_bat_installed and the matching $endif
1643 <option>if_up</option>
1645 <option>(interface)</option>
1647 <listitem>if INTERFACE exists and is up, display everything
1648 between $if_up and the matching $endif
1654 <option>if_updatenr</option>
1656 <option>(updatenr)</option>
1658 <listitem>If it's the UPDATENR-th time that conky updates,
1659 display everything between $if_updatenr and the matching
1660 $endif. The counter resets when the highest UPDATENR is
1661 reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr
1662 2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the
1663 time followed by bar 25% of the time followed by nothing
1664 the other half of the time.
1670 <option>if_xmms2_connected</option>
1673 <listitem>Display everything between $if_xmms2_connected
1674 and the matching $endif if xmms2 is running.
1680 <option>image</option>
1682 <option><path to image> (-p x,y) (-s WxH) (-n)
1683 (-f interval)</option>
1685 <listitem>Renders an image from the path specified using
1686 Imlib2. Takes 4 optional arguments: a position, a size, a
1687 no-cache switch, and a cache flush interval. Changing the
1688 x,y position will move the position of the image, and
1689 changing the WxH will scale the image. If you specify the
1690 no-cache flag (-n), the image will not be cached.
1691 Alternately, you can specify the -f int switch to specify a
1692 cache flust interval for a particular image. Example:
1693 ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200}
1694 will render 'cheeseburger.jpg' at (20,20) scaled to 200x200
1695 pixels. Conky does not make any attempt to adjust the
1696 position (or any other formatting) of images, they are just
1697 rendered as per the arguments passed. The only reason
1698 $image is part of the TEXT section, is to allow for runtime
1699 modifications, through $execp $lua_parse, or some other
1706 <option>imap_messages</option>
1708 <option>(args)</option>
1710 <listitem>Displays the number of messages in your global
1711 IMAP inbox by default. You can define individual IMAP
1712 inboxes seperately by passing arguments to this object.
1713 Arguments are: "host user pass [-i interval (in seconds)]
1714 [-f 'folder'] [-p port] [-e 'command'] [-r retries]". Default
1715 port is 143, default folder is 'INBOX', default interval is
1716 5 minutes, and default number of retries before giving up
1717 is 5. If the password is supplied as '*', you will be
1718 prompted to enter the password when Conky starts.
1724 <option>imap_unseen</option>
1726 <option>(args)</option>
1728 <listitem>Displays the number of unseen messages in your
1729 global IMAP inbox by default. You can define individual
1730 IMAP inboxes seperately by passing arguments to this
1731 object. Arguments are: "host user pass [-i interval (in
1732 seconds)] [-f 'folder'] [-p port] [-e 'command'] [-r retries]".
1733 Default port is 143, default folder is 'INBOX', default
1734 interval is 5 minutes, and default number of retries before
1735 giving up is 5. If the password is supplied as '*', you
1736 will be prompted to enter the password when Conky starts.
1742 <option>include</option>
1744 <option>path</option>
1747 <para>Loads the configfile at path, places the
1748 configsettings behind the configsettings in the orginal
1749 config and places the vars where the includevar
1756 <option>ioscheduler</option>
1758 <option>disk</option>
1760 <listitem>Prints the current ioscheduler used for the given
1761 disk name (i.e. e.g. "hda" or "sdb")
1767 <option>kernel</option>
1770 <listitem>Kernel version
1776 <option>laptop_mode</option>
1779 <listitem>The value of /proc/sys/vm/laptop_mode
1785 <option>lines</option>
1787 <option>textfile</option>
1789 <listitem>Displays the number of lines in the given file
1795 <option>loadavg</option>
1797 <option>(1|2|3)</option>
1799 <listitem>System load average, 1 is for past 1 minute, 2
1800 for past 5 minutes and 3 for past 15 minutes. Without argument, prints
1801 all three values separated by whitespace.
1807 <option>loadgraph</option>
1809 <option>(height),(width) (gradient colour 1)
1810 (gradient colour 2) (scale) (-t) (-l)</option>
1812 <listitem>Load1 average graph, similar to xload, with
1813 optional colours in hex, minus the #. Uses a logarithmic
1814 scale (to see small numbers) when you use the -l switch.
1815 Takes the switch '-t' to use a temperature gradient, which
1816 makes the gradient values change depending on the amplitude
1817 of a particular graph value (try it and see).
1823 <option>lua</option>
1825 <option>function_name (function parameters)</option>
1827 <listitem>Executes a Lua function with given parameters,
1828 then prints the returned string. See also 'lua_load' on how
1829 to load scripts. Conky puts 'conky_' in front of
1830 function_name to prevent accidental calls to the wrong
1831 function unless you put you place 'conky_' in front of it
1838 <option>lua_bar</option>
1840 <option>(height, width) function_name (function
1841 parameters)</option>
1843 <listitem>Executes a Lua function with given parameters and
1844 draws a bar. Expects result value to be an integer between
1845 0 and 100. See also 'lua_load' on how to load scripts.
1846 Conky puts 'conky_' in front of function_name to prevent
1847 accidental calls to the wrong function unless you put you
1848 place 'conky_' in front of it yourself.
1854 <option>lua_gauge</option>
1856 <option>(height, width) function_name (function
1857 parameters)</option>
1859 <listitem>Executes a Lua function with given parameters and
1860 draws a gauge. Expects result value to be an integer
1861 between 0 and 100. See also 'lua_load' on how to load
1862 scripts. Conky puts 'conky_' in front of function_name to
1863 prevent accidental calls to the wrong function unless you
1864 put you place 'conky_' in front of it yourself.
1870 <option>lua_graph</option>
1872 <option>function_name (height),(width) (gradient colour
1873 1) (gradient colour 2) (scale) (-t) (-l)</option>
1875 <listitem>Executes a Lua function with and draws a graph.
1876 Expects result value to be any number, and by default will
1877 scale to show the full range. See also 'lua_load' on how to
1878 load scripts. Takes the switch '-t' to use a temperature
1879 gradient, which makes the gradient values change depending
1880 on the amplitude of a particular graph value (try it and
1881 see). Conky puts 'conky_' in front of function_name to
1882 prevent accidental calls to the wrong function unless you
1883 put you place 'conky_' in front of it yourself.
1889 <option>lua_parse</option>
1891 <option>function_name (function parameters)</option>
1893 <listitem>Executes a Lua function with given parameters as
1894 per $lua, then parses and prints the result value as per
1895 the syntax for Conky's TEXT section. See also 'lua_load' on
1896 how to load scripts. Conky puts 'conky_' in front of
1897 function_name to prevent accidental calls to the wrong
1898 function unless you put you place 'conky_' in front of it
1905 <option>machine</option>
1908 <listitem>Machine, i686 for example
1914 <option>mails</option>
1916 <option>(mailbox)</option>
1917 <option>(interval)</option>
1919 <listitem>Mail count in the specified mailbox or your mail
1920 spool if not. Both mbox and maildir type mailboxes are
1921 supported. You can use a program like fetchmail to get
1922 mails from some server using your favourite protocol. See
1929 <option>mboxscan</option>
1931 <option>(-n number of messages to print) (-fw from
1932 width) (-sw subject width) mbox</option>
1934 <listitem>Print a summary of recent messages in an mbox
1935 format mailbox. mbox parameter is the filename of the
1936 mailbox (can be encapsulated using '"', ie. ${mboxscan -n
1937 10 "/home/brenden/some box"}
1943 <option>mem</option>
1946 <listitem>Amount of memory in use
1952 <option>membar</option>
1954 <option>(height),(width)</option>
1956 <listitem>Bar that shows amount of memory in use
1962 <option>memeasyfree</option>
1965 <listitem>Amount of free memory including the memory that
1966 is very easily freed (buffers/cache)
1972 <option>memfree</option>
1975 <listitem>Amount of free memory
1981 <option>memgauge</option>
1983 <option>(height),(width)</option>
1985 <listitem>Gauge that shows amount of memory in use (see
1992 <option>memgraph</option>
1994 <option>(height),(width) (gradient colour 1) (gradient
1995 colour 2) (scale) (-t) (-l)</option>
1997 <listitem>Memory usage graph. Uses a logarithmic scale (to
1998 see small numbers) when you use the -l switch. Takes the
1999 switch '-t' to use a temperature gradient, which makes the
2000 gradient values change depending on the amplitude of a
2001 particular graph value (try it and see).
2007 <option>memmax</option>
2010 <listitem>Total amount of memory
2016 <option>memperc</option>
2019 <listitem>Percentage of memory in use
2025 <option>mixer</option>
2027 <option>(device)</option>
2029 <listitem>Prints the mixer value as reported by the OS.
2030 Default mixer is "vol", but you can specify one of the
2031 following optional arguments: "vol", "bass", "treble",
2032 "synth", "pcm", "speaker", "line", "mic", "cd", "mix",
2033 "pcm2", "rec", "igain", "ogain", "line1", "line2", "line3",
2034 "dig1", "dig2", "dig3", "phin", "phout", "video", "radio",
2035 "monitor". Refer to the definition of SOUND_DEVICE_NAMES in
2036 <linux/soundcard.h> (on Linux), <soundcard.h>
2037 (on OpenBSD), or <sys/soundcard.h> to find the exact
2038 options available on your system.
2044 <option>mixerbar</option>
2046 <option>(device)</option>
2048 <listitem>Displays mixer value in a bar as reported by the
2049 OS. See docs for $mixer for details on arguments.
2055 <option>mixerl</option>
2057 <option>(device)</option>
2059 <listitem>Prints the left channel mixer value as reported
2060 by the OS. See docs for $mixer for details on arguments.
2066 <option>mixerlbar</option>
2068 <option>(device)</option>
2070 <listitem>Displays the left channel mixer value in a bar as
2071 reported by the OS. See docs for $mixer for details on
2078 <option>mixerr</option>
2080 <option>(device)</option>
2082 <listitem>Prints the right channel mixer value as reported
2083 by the OS. See docs for $mixer for details on arguments.
2089 <option>mixerrbar</option>
2091 <option>(device)</option>
2093 <listitem>Displays the right channel mixer value in a bar
2094 as reported by the OS. See docs for $mixer for details on
2101 <option>moc_album</option>
2104 <listitem>Album of the current MOC song
2110 <option>moc_artist</option>
2113 <listitem>Artist of the current MOC song
2119 <option>moc_bitrate</option>
2122 <listitem>Bitrate in the current MOC song
2128 <option>moc_curtime</option>
2131 <listitem>Current time of the current MOC song
2137 <option>moc_file</option>
2140 <listitem>File name of the current MOC song
2146 <option>moc_rate</option>
2149 <listitem>Rate of the current MOC song
2155 <option>moc_song</option>
2158 <listitem>The current song name being played in MOC.
2164 <option>moc_state</option>
2167 <listitem>Current state of MOC; playing, stopped etc.
2173 <option>moc_timeleft</option>
2176 <listitem>Time left in the current MOC song
2182 <option>moc_title</option>
2185 <listitem>Title of the current MOC song
2191 <option>moc_totaltime</option>
2194 <listitem>Total length of the current MOC song
2200 <option>monitor</option>
2203 <listitem>Number of the monitor on which conky is running
2204 or the message "Not running in X" if this is the case.
2210 <option>monitor_number</option>
2213 <listitem>Number of monitors or the message "Not running in
2214 X" if this is the case.
2220 <option>mpd_album</option>
2223 <listitem>Album in current MPD song
2229 <option>mpd_artist</option>
2232 <listitem>Artist in current MPD song must be enabled at
2239 <option>mpd_bar</option>
2241 <option>(height),(width)</option>
2243 <listitem>Bar of mpd's progress
2249 <option>mpd_bitrate</option>
2252 <listitem>Bitrate of current song
2258 <option>mpd_elapsed</option>
2261 <listitem>Song's elapsed time
2267 <option>mpd_file</option>
2270 <listitem>Prints the file name of the current MPD song
2276 <option>mpd_length</option>
2279 <listitem>Song's length
2285 <option>mpd_name</option>
2288 <listitem>Prints the MPD name field
2294 <option>mpd_percent</option>
2297 <listitem>Percent of song's progress
2303 <option>mpd_random</option>
2306 <listitem>Random status (On/Off)
2312 <option>mpd_repeat</option>
2315 <listitem>Repeat status (On/Off)
2321 <option>mpd_smart</option>
2323 <option>(max length)</option>
2325 <listitem>Prints the song name in either the form "artist -
2326 title" or file name, depending on whats available
2332 <option>mpd_status</option>
2335 <listitem>Playing, stopped, et cetera.
2341 <option>mpd_title</option>
2343 <option>(max length)</option>
2345 <listitem>Title of current MPD song
2351 <option>mpd_track</option>
2354 <listitem>Prints the MPD track field
2360 <option>mpd_vol</option>
2363 <listitem>MPD's volume
2369 <option>nameserver</option>
2371 <option>(index)</option>
2373 <listitem>Print a nameserver from /etc/resolv.conf. Index
2374 starts at and defaults to 0.
2380 <option>new_mails</option>
2382 <option>(mailbox)</option>
2383 <option>(interval)</option>
2385 <listitem>Unread mail count in the specified mailbox or
2386 mail spool if not. Both mbox and maildir type mailboxes are
2393 <option>nodename</option>
2402 <option>nvidia</option>
2404 <option>threshold</option>
2405 <option>temp</option>
2406 <option>ambient</option>
2407 <option>gpufreq</option>
2408 <option>memfreq</option>
2409 <option>imagequality</option>
2411 <listitem>Nvidia graficcard support for the XNVCtrl
2412 library. Each option can be shortened to the least
2413 significant part. Temperatures are printed as float, all
2414 other values as integer.
2417 <command>threshold</command>
2418 <option>The thresholdtemperature at
2419 which the gpu slows down</option>
2422 <command>temp</command>
2423 <option>Gives the gpu current
2424 temperature</option>
2427 <command>ambient</command>
2428 <option>Gives current air temperature near GPU
2432 <command>gpufreq</command>
2433 <option>Gives the current gpu frequency</option>
2436 <command>memfreq</command>
2437 <option>Gives the current mem frequency</option>
2440 <command>imagequality</command>
2441 <option>Which imagequality should be choosen by
2442 OpenGL applications</option>
2450 <option>offset</option>
2452 <option>(pixels)</option>
2454 <listitem>Move text over by N pixels. See also $voffset.
2460 <option>outlinecolor</option>
2462 <option>(color)</option>
2464 <listitem>Change outline color
2470 <option>pb_battery</option>
2472 <option>item</option>
2474 <listitem>If running on Apple powerbook/ibook, display
2475 information on battery status. The item parameter
2476 specifies, what information to display. Exactly one item
2477 must be specified. Valid items are:
2480 <command>status</command>
2481 <option>Display if battery is fully charged,
2482 charging, discharging or absent (running on
2486 <command>percent</command>
2487 <option>Display charge of battery in percent, if
2488 charging or discharging. Nothing will be displayed,
2489 if battery is fully charged or absent.</option>
2492 <command>time</command>
2493 <option>Display the time remaining until the
2494 battery will be fully charged or discharged at
2495 current rate. Nothing is displayed, if battery is
2496 absent or if it's present but fully charged and not
2497 discharging.</option>
2505 <option>pid_chroot</option>
2507 <option>pid</option>
2509 <listitem>Directory used as rootdirectory by the process
2510 (this will be "/" unless the process did a chroot syscall)
2516 <option>pid_cmdline</option>
2518 <option>pid</option>
2520 <listitem>Command line this process was invoked with
2526 <option>pid_cwd</option>
2528 <option>pid</option>
2530 <listitem>Current working directory of the process
2536 <option>pid_environ</option>
2538 <option>pid varname</option>
2540 <listitem>Contents of a environment-var of the process
2546 <option>pid_environ_list</option>
2548 <option>pid</option>
2550 <listitem>List of environment-vars that the process can see
2556 <option>pid_exe</option>
2558 <option>pid</option>
2560 <listitem>Path to executed command that started the process
2566 <option>pid_openfiles</option>
2568 <option>pid</option>
2570 <listitem>List of files that the process has open
2576 <option>pid_stdin</option>
2578 <option>pid</option>
2580 <listitem>Filedescriptor binded to the STDIN of the process
2586 <option>pid_stdout</option>
2588 <option>pid</option>
2590 <listitem>Filedescriptor binded to the STDOUT of the process
2596 <option>pid_stderr</option>
2598 <option>pid</option>
2600 <listitem>Filedescriptor binded to the STDERR of the process
2606 <option>platform</option>
2608 <option>(dev) type n (factor offset)</option>
2610 <listitem>Platform sensor from sysfs (Linux 2.6). Parameter
2611 dev may be omitted if you have only one platform device.
2612 Platform type is either 'in' or 'vol' meaning voltage;
2613 'fan' meaning fan; 'temp' meaning temperature. Parameter n
2614 is number of the sensor. See /sys/bus/platform/devices/ on
2615 your local computer. The optional arguments 'factor' and
2616 'offset' allow precalculation of the raw input, which is
2617 being modified as follows: 'input = input * factor +
2618 offset'. Note that they have to be given as decimal values
2619 (i.e. contain at least one decimal place).
2625 <option>pop3_unseen</option>
2627 <option>(args)</option>
2629 <listitem>Displays the number of unseen messages in your
2630 global POP3 inbox by default. You can define individual
2631 POP3 inboxes seperately by passing arguments to this
2632 object. Arguments are: "host user pass [-i interval (in
2633 seconds)] [-p port] [-e 'command'] [-r retries]". Default
2634 port is 110, default interval is 5 minutes, and default
2635 number of retries before giving up is 5. If the password is
2636 supplied as '*', you will be prompted to enter the password
2643 <option>pop3_used</option>
2645 <option>(args)</option>
2647 <listitem>Displays the amount of space (in MiB, 2^20) used
2648 in your global POP3 inbox by default. You can define
2649 individual POP3 inboxes seperately by passing arguments to
2650 this object. Arguments are: "host user pass [-i interval
2651 (in seconds)] [-p port] [-e 'command'] [-r retries]". Default
2652 port is 110, default interval is 5 minutes, and default
2653 number of retries before giving up is 5. If the password is
2654 supplied as '*', you will be prompted to enter the password
2661 <option>pre_exec</option>
2663 <option>shell command</option>
2665 <listitem>Executes a shell command one time before conky
2666 displays anything and puts output as text.
2672 <option>processes</option>
2675 <listitem>Total processes (sleeping and running)
2681 <option>read_tcp</option>
2683 <option>(host) port</option>
2685 <listitem>Connects to a tcp port on a host (default is
2686 localhost), reads every char available at the moment and
2693 <option>replied_mails</option>
2695 <option>(maildir)</option>
2696 <option>(interval)</option>
2698 <listitem>Number of mails marked as replied in the
2699 specified mailbox or mail spool if not. Only maildir type
2700 mailboxes are supported, mbox type will return -1.
2706 <option>rss</option>
2708 <option>uri interval_in_minutes action (num_par
2709 (spaces_in_front))</option>
2712 <para>Download and parse RSS feeds. The interval may be
2713 a floating point value greater than 0, otherwise
2714 defaults to 15 minutes. Action may be one of the
2715 following: feed_title, item_title (with num par),
2716 item_desc (with num par) and item_titles (when using
2717 this action and spaces_in_front is given conky places
2718 that many spaces in front of each item). This object is
2719 threaded, and once a thread is created it can't be
2720 explicitely destroyed. One thread will run for each URI
2721 specified. You can use any protocol that Curl
2728 <option>running_processes</option>
2731 <listitem>Running processes (not sleeping), requires Linux
2738 <option>scroll</option>
2740 <option>length (step) text</option>
2742 <listitem>Scroll 'text' by 'step' characters showing
2743 'length' number of characters at the same time. The text
2744 may also contain variables. 'step' is optional and defaults
2745 to 1 if not set. If a var creates output on multiple lines
2746 then the lines are placed behind each other separated with
2747 a '|'-sign. If you change the textcolor inside $scroll it
2748 will automatically have it's old value back at the end of
2749 $scroll. The end and the start of text will be seperated by
2750 'length' number of spaces.
2756 <option>seen_mails</option>
2758 <option>(maildir)</option>
2759 <option>(interval)</option>
2761 <listitem>Number of mails marked as seen in the specified
2762 mailbox or mail spool if not. Only maildir type mailboxes
2763 are supported, mbox type will return -1.
2769 <option>shadecolor</option>
2771 <option>(color)</option>
2773 <listitem>Change shading color
2779 <option>smapi</option>
2781 <option>(ARGS)</option>
2783 <listitem>when using smapi, display contents of the
2784 /sys/devices/platform/smapi directory. ARGS are either
2785 '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the
2786 corresponding files' content. This is a very raw method of
2787 accessing the smapi values. When available, better use one
2788 of the smapi_* variables instead.
2794 <option>smapi_bat_bar</option>
2796 <option>(INDEX),(height),(width)</option>
2798 <listitem>when using smapi, display the remaining capacity
2799 of the battery with index INDEX as a bar.
2805 <option>smapi_bat_perc</option>
2807 <option>(INDEX)</option>
2809 <listitem>when using smapi, display the remaining capacity
2810 in percent of the battery with index INDEX. This is a
2811 separate variable because it supports the 'use_spacer'
2812 configuration option.
2818 <option>smapi_bat_power</option>
2820 <option>INDEX</option>
2822 <listitem>when using smapi, display the current power of
2823 the battery with index INDEX in watt. This is a separate
2824 variable because the original read out value is being
2825 converted from mW. The sign of the output reflects charging
2826 (positive) or discharging (negative) state.
2832 <option>smapi_bat_temp</option>
2834 <option>INDEX</option>
2836 <listitem>when using smapi, display the current temperature
2837 of the battery with index INDEX in degree Celsius. This is
2838 a separate variable because the original read out value is
2839 being converted from milli degree Celsius.
2845 <option>sony_fanspeed</option>
2848 <listitem>Displays the Sony VAIO fanspeed information if
2849 sony-laptop kernel support is enabled. Linux only.
2855 <option>stippled_hr</option>
2857 <option>(space)</option>
2859 <listitem>Stippled (dashed) horizontal line
2865 <option>swap</option>
2868 <listitem>Amount of swap in use
2874 <option>swapbar</option>
2876 <option>(height),(width)</option>
2878 <listitem>Bar that shows amount of swap in use
2884 <option>swapfree</option>
2887 <listitem>Amount of free swap
2893 <option>swapmax</option>
2896 <listitem>Total amount of swap
2902 <option>swapperc</option>
2905 <listitem>Percentage of swap in use
2911 <option>sysname</option>
2914 <listitem>System name, Linux for example
2920 <option>tab</option>
2922 <option>(width, (start))</option>
2924 <listitem>Puts a tab of the specified width, starting from
2925 column 'start'. The unit is pixels for both arguments.
2931 <option>tail</option>
2933 <option>logfile lines (next_check)</option>
2935 <listitem>Displays last N lines of supplied text file. The
2936 file is checked every 'next_check' update. If next_check is
2937 not supplied, Conky defaults to 2. Max of 30 lines can be
2938 displayed, or until the text buffer is filled.
2944 <option>tcp_portmon</option>
2946 <option>port_begin port_end item (index)</option>
2947 <emphasis>(ip4 only at present)</emphasis>
2950 <para>TCP port monitor for specified local ports. Port
2951 numbers must be in the range 1 to 65535. Valid items
2955 <command>count</command>
2956 <option>Total number of connections in the
2960 <command>rip</command>
2961 <option>Remote ip address</option>
2964 <command>rhost</command>
2965 <option>Remote host name</option>
2968 <command>rport</command>
2969 <option>Remote port number</option>
2972 <command>rservice</command>
2973 <option>Remote service name from
2974 /etc/services</option>
2977 <command>lip</command>
2978 <option>Local ip address</option>
2981 <command>lhost</command>
2982 <option>Local host name</option>
2985 <command>lport</command>
2986 <option>Local port number</option>
2989 <command>lservice</command>
2990 <option>Local service name from
2991 /etc/services</option>
2994 <para>The connection index provides you with access to
2995 each connection in the port monitor. The monitor will
2996 return information for index values from 0 to n-1
2997 connections. Values higher than n-1 are simply ignored.
2998 For the "count" item, the connection index must be
2999 omitted. It is required for all other items.</para>
3000 <para>Examples:</para>
3003 <command>${tcp_portmon 6881 6999
3005 <option>Displays the number of connections in
3006 the bittorrent port range</option>
3009 <command>${tcp_portmon 22 22 rip 0}</command>
3010 <option>Displays the remote host ip of the
3011 first sshd connection</option>
3014 <command>${tcp_portmon 22 22 rip 9}</command>
3015 <option>Displays the remote host ip of the
3016 tenth sshd connection</option>
3019 <command>${tcp_portmon 1 1024 rhost
3021 <option>Displays the remote host name of the
3022 first connection on a privileged port</option>
3025 <command>${tcp_portmon 1 1024 rport
3027 <option>Displays the remote host port of the
3028 fifth connection on a privileged port</option>
3031 <command>${tcp_portmon 1 65535 lservice
3033 <option>Displays the local service name of the
3034 fifteenth connection in the range of all
3038 <para>Note that port monitor variables which share the
3039 same port range actually refer to the same monitor, so
3040 many references to a single port range for different
3041 items and different indexes all use the same monitor
3042 internally. In other words, the program avoids creating
3043 redundant monitors.</para>
3049 <option>templateN</option>
3051 <option>(arg1)</option>
3052 <option>(arg2)</option>
3053 <option>(arg3 ...)</option>
3056 <para>Evaluate the content of the templateN
3057 configuration variable (where N is a value between 0
3058 and 9, inclusively), applying substitutions as
3059 described in the documentation of the corresponding
3060 configuration variable. The number of arguments is
3061 optional, but must match the highest referred index in
3062 the template. You can use the same special sequences in
3063 each argument as the ones valid for a template
3064 definition, e.g. to allow an argument to contain a
3065 whitespace. Also simple nesting of templates is
3066 possible this way.</para>
3067 <para>Here are some examples of template
3070 <member>template0 $\1\2</member>
3071 <member>template1 \1: ${fs_used \2} / ${fs_size
3073 <member>template2 \1 \2</member>
3075 <para>The following list shows sample usage of the
3076 templates defined above, with the equivalent syntax
3077 when not using any template at all:</para>
3082 <entry>using template</entry>
3083 <entry>same without template</entry>
3088 <entry>${template0 node name}</entry>
3089 <entry>$nodename</entry>
3092 <entry>${template1 root /}</entry>
3093 <entry>root: ${fs_free /} / ${fs_size
3098 <programlisting>${template1
3099 ${template2\ disk\ root}
3103 <programlisting>disk root:
3104 ${fs_free /} / ${fs_size
3116 <option>texeci</option>
3118 <option>interval command</option>
3120 <listitem>Runs a command at an interval inside a thread and
3121 displays the output. Same as $execi, except the command is
3122 run inside a thread. Use this if you have a slow script to
3123 keep Conky updating. You should make the interval slightly
3124 longer then the time it takes your script to execute. For
3125 example, if you have a script that take 5 seconds to
3126 execute, you should make the interval at least 6 seconds.
3127 See also $execi. This object will clean up the thread when
3128 it is destroyed, so it can safely be used in a nested
3129 fashion, though it may not produce the desired behaviour if
3136 <option>threads</option>
3139 <listitem>Total threads
3145 <option>time</option>
3147 <option>(format)</option>
3149 <listitem>Local time, see man strftime to get more
3150 information about format
3156 <option>to_bytes</option>
3158 <option>size</option>
3160 <listitem>If 'size' is a number followed by a size-unit
3161 (kilobyte,mb,GiB,...) then it converts the size to bytes
3162 and shows it without unit, otherwise it just shows 'size'.
3168 <option>top</option>
3170 <option>type num</option>
3172 <listitem>This takes arguments in the form:top (name)
3173 (number) Basically, processes are ranked from highest to
3174 lowest in terms of cpu usage, which is what (num)
3175 represents. The types are: "name", "pid", "cpu", "mem",
3176 "mem_res", "mem_vsize", "time", "io_perc", "io_read" and
3177 "io_write". There can be a max of 10 processes listed.
3183 <option>top_io</option>
3185 <option>type num</option>
3187 <listitem>Same as top, except sorted by the amount of I/O
3188 the process has done during the update interval
3194 <option>top_mem</option>
3196 <option>type num</option>
3198 <listitem>Same as top, except sorted by mem usage instead
3205 <option>top_time</option>
3207 <option>type num</option>
3209 <listitem>Same as top, except sorted by total CPU time
3210 instead of current CPU usage
3216 <option>totaldown</option>
3218 <option>(net)</option>
3220 <listitem>Total download, overflows at 4 GB on Linux with
3221 32-bit arch and there doesn't seem to be a way to know how
3222 many times it has already done that before conky has
3229 <option>totalup</option>
3231 <option>(net)</option>
3233 <listitem>Total upload, this one too, may overflow
3239 <option>trashed_mails</option>
3241 <option>(maildir)</option>
3242 <option>(interval)</option>
3244 <listitem>Number of mails marked as trashed in the
3245 specified mailbox or mail spool if not. Only maildir type
3246 mailboxes are supported, mbox type will return -1.
3252 <option>tztime</option>
3254 <option>(timezone (format))</option>
3256 <listitem>Local time for specified timezone, see man
3257 strftime to get more information about format. The timezone
3258 argument is specified in similar fashion as TZ environment
3259 variable. For hints, look in /usr/share/zoneinfo. e.g.
3260 US/Pacific, Europe/Zurich, etc.
3266 <option>unflagged_mails</option>
3268 <option>(maildir)</option>
3269 <option>(interval)</option>
3271 <listitem>Number of mails not marked as flagged in the
3272 specified mailbox or mail spool if not. Only maildir type
3273 mailboxes are supported, mbox type will return -1.
3279 <option>unforwarded_mails</option>
3281 <option>(maildir)</option>
3282 <option>(interval)</option>
3284 <listitem>Number of mails not marked as forwarded in the
3285 specified mailbox or mail spool if not. Only maildir type
3286 mailboxes are supported, mbox type will return -1.
3292 <option>unreplied_mails</option>
3294 <option>(maildir)</option>
3295 <option>(interval)</option>
3297 <listitem>Number of mails not marked as replied in the
3298 specified mailbox or mail spool if not. Only maildir type
3299 mailboxes are supported, mbox type will return -1.
3305 <option>unseen_mails</option>
3307 <option>(maildir)</option>
3308 <option>(interval)</option>
3310 <listitem>Number of new or unseen mails in the specified
3311 mailbox or mail spool if not. Only maildir type mailboxes
3312 are supported, mbox type will return -1.
3318 <option>updates</option>
3320 <option>Number of updates</option>
3322 <listitem>for debugging
3328 <option>upspeed</option>
3330 <option>(net)</option>
3332 <listitem>Upload speed in suitable IEC units
3338 <option>upspeedf</option>
3340 <option>(net)</option>
3342 <listitem>Upload speed in KiB with one decimal
3348 <option>upspeedgraph</option>
3350 <option>(netdev) (height),(width) (gradient colour 1)
3351 (gradient colour 2) (scale) (-t) (-l)</option>
3353 <listitem>Upload speed graph, colours defined in hex, minus
3354 the #. If scale is non-zero, it becomes the scale for the
3355 graph. Uses a logarithmic scale (to see small numbers) when
3356 you use the -l switch. Takes the switch '-t' to use a
3357 temperature gradient, which makes the gradient values
3358 change depending on the amplitude of a particular graph
3359 value (try it and see).
3365 <option>uptime</option>
3374 <option>uptime_short</option>
3377 <listitem>Uptime in a shorter format
3383 <option>user_names</option>
3386 <listitem>Lists the names of the users logged in
3392 <option>user_number</option>
3395 <listitem>Number of users logged in
3401 <option>user_terms</option>
3404 <listitem>Lists the consoles in use
3410 <option>user_times</option>
3413 <listitem>Lists how long users have been logged in for
3419 <option>utime</option>
3421 <option>(format)</option>
3423 <listitem>Display time in UTC (universal coordinate time).
3429 <option>voffset</option>
3431 <option>(pixels)</option>
3433 <listitem>Change vertical offset by N pixels. Negative
3434 values will cause text to overlap. See also $offset.
3440 <option>voltage_mv</option>
3442 <option>(n)</option>
3444 <listitem>Returns CPU #n's voltage in mV. CPUs are counted
3445 from 1. If omitted, the parameter defaults to 1.
3451 <option>voltage_v</option>
3453 <option>(n)</option>
3455 <listitem>Returns CPU #n's voltage in V. CPUs are counted
3456 from 1. If omitted, the parameter defaults to 1.
3462 <option>weather</option>
3464 <option>URI locID data_type
3465 (interval_in_minutes)</option>
3468 <para>Download, parse and display METAR data.</para>
3469 <para>For the 'URI', there are two
3470 possibilities:</para>
3473 http://weather.noaa.gov/pub/data/observations/metar/stations/</member>
3475 http://xoap.weather.com/weather/local/</member>
3477 <para>The first one is free to use but the second
3478 requires you to register and obtain your partner ID and
3479 license key. These two must be written, separated by a
3480 space, into a file called .xoaprc which needs to be
3481 placed into your home directory.</para>
3482 <para>'locID' must be a valid location identifier for
3483 the required uri. For the NOAA site this must be a
3484 valid ICAO (see for instance
3485 https://pilotweb.nas.faa.gov/qryhtml/icao/). For the
3486 weather.com site this must be a valid location ID (see
3488 http://aspnetresources.com/tools/locid.aspx).</para>
3489 <para>'data_type' must be one of the following:</para>
3492 <command>last_update</command>
3493 <para>The date and time stamp of the data.
3494 The result depends on the URI used. For the
3495 NOAA site it is date (yyyy/mm/dd) and UTC time.
3496 For the weather.com one it is date
3497 ([m]m/[d]d/yy) and Local Time of the
3501 <command>temperature</command>
3502 <para>Air temperature (you can use the
3503 'temperature_unit' config setting to change
3507 <command>cloud_cover</command>
3508 <para>The highest cloud cover status</para>
3511 <command>pressure</command>
3512 <para>Air pressure in millibar</para>
3515 <command>wind_speed</command>
3516 <para>Wind speed in km/h</para>
3519 <command>wind_dir</command>
3520 <para>Wind direction</para>
3523 <command>wind_dir_DEG</command>
3524 <para>Compass wind direction</para>
3527 <command>humidity</command>
3528 <para>Relative humidity in %</para>
3531 <command>weather</command>
3532 <para>Any relevant weather event (rain, snow,
3533 etc.). This is not used if you are querying the
3534 weather.com site since this data is aggregated
3535 into the cloud_cover one</para>
3538 <command>icon</command>
3539 <para>Weather icon (only for
3540 www.weather.com). Can be used together with the
3541 icon kit provided upon registering to their
3545 <para>'delay_in_minutes' (optional, default 30) cannot
3546 be less than 30 minutes.</para>
3547 <para>This object is threaded, and once a thread is
3548 created it can't be explicitely destroyed. One thread
3549 will run for each URI specified.</para>
3550 <para>Note that these variables are still EXPERIMENTAL
3551 and can be subject to many future changes.</para>
3557 <option>weather_forecast</option>
3559 <option>URI locID day data_type
3560 (interval_in_minutes)</option>
3563 <para>Download, parse and display weather forecast data
3564 for a given day (daytime only).</para>
3565 <para>For the 'URI', for the time being only
3566 http://xoap.weather.com/weather/local/ is
3567 supported. See 'weather' above for details of usage</para>
3568 <para>'locID', see 'weather' above.</para>
3569 <para>'day' is a number from 0 (today) to 4 (3 days
3570 after tomorrow).</para>
3571 <para>'data_type' must be one of the following:</para>
3574 <command>day</command>
3575 <option>Day of the week</option>
3578 <command>date</command>
3579 <option>Date, in the form MMM DD (ie. Jul 14)</option>
3582 <command>low</command>
3583 <option>Minimun temperature (you can use the
3584 'temperature_unit' config setting to change
3588 <command>hi</command>
3589 <option>Maximum temperature (you can use the
3590 'temperature_unit' config setting to change
3594 <command>icon</command>
3595 <option>Weather icon. Can be used together with the
3596 icon kit provided upon registering to the weather.com
3600 <command>forecast</command>
3601 <option>Weather forecast (sunny, rainy, etc.)</option>
3604 <command>wind_speed</command>
3605 <option>Wind speed in km/h</option>
3608 <command>wind_dir</command>
3609 <option>Wind direction</option>
3612 <command>wind_dir_DEG</command>
3613 <option>Compass wind direction</option>
3616 <command>humidity</command>
3617 <option>Relative humidity in %</option>
3620 <command>precipitation</command>
3621 <option>Probability of having a
3622 precipitation (in %)</option>
3625 <para>'delay_in_minutes' (optional, default 210) cannot
3626 be lower than 210 min.</para>
3627 <para>This object is threaded, and once a thread is
3628 created it can't be explicitely destroyed. One thread
3629 will run for each URI specified. You can use any
3630 protocol that Curl supports.</para>
3631 <para>Note that these variables are still EXPERIMENTAL
3632 and can be subject to many future changes.</para>
3638 <option>wireless_ap</option>
3640 <option>(net)</option>
3642 <listitem>Wireless access point MAC address (Linux only)
3648 <option>wireless_bitrate</option>
3650 <option>(net)</option>
3652 <listitem>Wireless bitrate (ie 11 Mb/s) (Linux only)
3658 <option>wireless_essid</option>
3660 <option>(net)</option>
3662 <listitem>Wireless access point ESSID (Linux only)
3668 <option>wireless_link_bar</option>
3670 <option>(height),(width) (net)</option>
3672 <listitem>Wireless link quality bar (Linux only)
3678 <option>wireless_link_qual</option>
3680 <option>(net)</option>
3682 <listitem>Wireless link quality (Linux only)
3688 <option>wireless_link_qual_max</option>
3690 <option>(net)</option>
3692 <listitem>Wireless link quality maximum value (Linux only)
3698 <option>wireless_link_qual_perc</option>
3700 <option>(net)</option>
3702 <listitem>Wireless link quality in percents (Linux only)
3708 <option>wireless_mode</option>
3710 <option>(net)</option>
3712 <listitem>Wireless mode (Managed/Ad-Hoc/Master) (Linux
3719 <option>words</option>
3721 <option>textfile</option>
3723 <listitem>Displays the number of words in the given file
3729 <option>xmms2_album</option>
3732 <listitem>Album in current XMMS2 song
3738 <option>xmms2_artist</option>
3741 <listitem>Artist in current XMMS2 song
3747 <option>xmms2_bar</option>
3749 <option>(height),(width)</option>
3751 <listitem>Bar of XMMS2's progress
3757 <option>xmms2_bitrate</option>
3760 <listitem>Bitrate of current song
3766 <option>xmms2_comment</option>
3769 <listitem>Comment in current XMMS2 song
3775 <option>xmms2_date</option>
3778 <listitem>Returns song's date.
3784 <option>xmms2_duration</option>
3787 <listitem>Duration of current song
3793 <option>xmms2_elapsed</option>
3796 <listitem>Song's elapsed time
3802 <option>xmms2_genre</option>
3805 <listitem>Genre in current XMMS2 song
3811 <option>xmms2_id</option>
3814 <listitem>XMMS2 id of current song
3820 <option>xmms2_percent</option>
3823 <listitem>Percent of song's progress
3829 <option>xmms2_playlist</option>
3832 <listitem>Returns the XMMS2 playlist.
3838 <option>xmms2_size</option>
3841 <listitem>Size of current song
3847 <option>xmms2_smart</option>
3850 <listitem>Prints the song name in either the form "artist -
3851 title" or file name, depending on whats available
3857 <option>xmms2_status</option>
3860 <listitem>XMMS2 status (Playing, Paused, Stopped, or
3867 <option>xmms2_timesplayed</option>
3870 <listitem>Number of times a song was played (presumably).
3876 <option>xmms2_title</option>
3879 <listitem>Title in current XMMS2 song
3885 <option>xmms2_tracknr</option>
3888 <listitem>Track number in current XMMS2 song
3894 <option>xmms2_url</option>
3897 <listitem>Full path to current song
projects / monky / blob