4 <command><option>addr</option></command>
5 <option>interface</option>
8 IP address for an interface, or "No Address" if no address is assigned.
9 <para></para></listitem>
14 <command><option>addrs</option></command>
15 <option>interface</option>
18 IP addresses for an interface (if one - works like addr). Linux only.
19 <para></para></listitem>
25 <command><option>acpiacadapter</option></command>
28 ACPI ac adapter state.
29 <para></para></listitem>
34 <command><option>acpifan</option></command>
38 <para></para></listitem>
43 <command><option>acpitemp</option></command>
46 ACPI temperature in C.
47 <para></para></listitem>
52 <command><option>adt746xcpu</option></command>
55 CPU temperature from therm_adt746x
56 <para></para></listitem>
61 <command><option>adt746xfan</option></command>
64 Fan speed from therm_adt746x
65 <para></para></listitem>
70 <command><option>alignr</option></command>
71 <option>(num)</option>
74 Right-justify text, with space of N
75 <para></para></listitem>
80 <command><option>alignc</option></command>
81 <option>(num)</option>
85 <para></para></listitem>
90 <command><option>apcupsd</option></command>
95 Sets up the connection to apcupsd daemon. Prints nothing, defaults to localhost:3551
96 <para></para></listitem>
101 <command><option>apcupsd_name</option></command>
104 Prints the UPS user-defined name.
105 <para></para></listitem>
110 <command><option>apcupsd_model</option></command>
113 Prints the model of the UPS.
114 <para></para></listitem>
119 <command><option>apcupsd_upsmode</option></command>
122 Prints the UPS mode (e.g. standalone).
123 <para></para></listitem>
128 <command><option>apcupsd_cable</option></command>
131 Prints the UPS connection type.
132 <para></para></listitem>
137 <command><option>apcupsd_status</option></command>
140 Prints current status (on-line, on-battery).
141 <para></para></listitem>
146 <command><option>apcupsd_linev</option></command>
149 Nominal input voltage.
150 <para></para></listitem>
155 <command><option>apcupsd_load</option></command>
158 Current load in percent.
159 <para></para></listitem>
164 <command><option>apcupsd_loadbar</option></command>
167 Bar showing current load.
168 <para></para></listitem>
173 <command><option>apcupsd_loadgraph</option></command>
174 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t)</option>
177 History graph of current load.
178 <para></para></listitem>
183 <command><option>apcupsd_loadgauge</option></command>
184 <option>(height),(width)</option>
187 Gauge that shows current load.
188 <para></para></listitem>
193 <command><option>apcupsd_charge</option></command>
196 Current battery capacity in percent.
197 <para></para></listitem>
202 <command><option>apcupsd_timeleft</option></command>
205 Time left to run on battery.
206 <para></para></listitem>
211 <command><option>apcupsd_temp</option></command>
214 Current internal temperature.
215 <para></para></listitem>
220 <command><option>apcupsd_lastxfer</option></command>
223 Reason for last transfer from line to battery.
224 <para></para></listitem>
229 <command><option>apm_adapter</option></command>
232 Display APM AC adapter status (FreeBSD only)
233 <para></para></listitem>
238 <command><option>apm_battery_life</option></command>
241 Display APM battery life in percent (FreeBSD only)
242 <para></para></listitem>
247 <command><option>apm_battery_time</option></command>
250 Display remaining APM battery life in hh:mm:ss or "unknown" if
251 AC adapterstatus is on-line or charging (FreeBSD only)
252 <para></para></listitem>
257 <command><option>audacious_bar</option></command>
258 <option>(height),(width)</option>
262 <para></para></listitem>
267 <command><option>audacious_bitrate</option></command>
270 Bitrate of current tune
271 <para></para></listitem>
276 <command><option>audacious_channels</option></command>
279 Number of audio channels of current tune
280 <para></para></listitem>
285 <command><option>audacious_filename</option></command>
288 Full path and filename of current tune
289 <para></para></listitem>
294 <command><option>audacious_frequency</option></command>
297 Sampling frequency of current tune
298 <para></para></listitem>
303 <command><option>audacious_length</option></command>
306 Total length of current tune as MM:SS
307 <para></para></listitem>
312 <command><option>audacious_length_seconds</option></command>
315 Total length of current tune in seconds
316 <para></para></listitem>
321 <command><option>audacious_playlist_position</option></command>
324 Playlist position of current tune
325 <para></para></listitem>
330 <command><option>audacious_playlist_length</option></command>
333 Number of tunes in playlist
334 <para></para></listitem>
339 <command><option>audacious_position</option></command>
342 Position of current tune (MM:SS)
343 <para></para></listitem>
348 <command><option>audacious_position_seconds</option></command>
351 Position of current tune in seconds
352 <para></para></listitem>
357 <command><option>audacious_status</option></command>
360 Player status (Playing/Paused/Stopped/Not running)
361 <para></para></listitem>
366 <command><option>audacious_title</option></command>
367 <option>(max length)</option>
370 Title of current tune with optional maximum length specifier
371 <para></para></listitem>
376 <command><option>audacious_main_volume</option></command>
379 The current volume fetched from Audacious
380 <para></para></listitem>
385 <command><option>battery</option></command>
386 <option>(num)</option>
389 Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
390 <para></para></listitem>
395 <command><option>battery_short</option></command>
396 <option>(num)</option>
399 Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
400 This mode display a short status, which means that C is displayed instead of charging and D is displayed instead of discharging.
401 <para></para></listitem>
406 <command><option>battery_bar</option></command>
407 <option>(height),(width) (num)</option>
410 Battery percentage remaining of ACPI battery in a bar. ACPI battery number can be given as argument (default is BAT0).
411 <para></para></listitem>
416 <command><option>battery_percent</option></command>
417 <option>(num)</option>
420 Battery percentage remaining for ACPI battery. ACPI battery number can be given as argument (default is BAT0).
421 <para></para></listitem>
426 <command><option>battery_time</option></command>
427 <option>(num)</option>
430 Battery charge/discharge time remaining of ACPI battery. ACPI battery number can be given as argument (default is BAT0).
431 <para></para></listitem>
436 <command><option>bmpx_artist</option></command>
439 Artist in current BMPx track
440 <para></para></listitem>
445 <command><option>bmpx_album</option></command>
448 Album in current BMPx track
449 <para></para></listitem>
454 <command><option>bmpx_title</option></command>
457 Title of the current BMPx track
458 <para></para></listitem>
463 <command><option>bmpx_track</option></command>
466 Track number of the current BMPx track
467 <para></para></listitem>
472 <command><option>bmpx_bitrate</option></command>
475 Bitrate of the current BMPx track
476 <para></para></listitem>
481 <command><option>bmpx_uri</option></command>
484 URI of the current BMPx track
485 <para></para></listitem>
490 <command><option>buffers</option></command>
493 Amount of memory buffered
494 <para></para></listitem>
499 <command><option>cached</option></command>
502 Amount of memory cached
503 <para></para></listitem>
508 <command><option>color</option></command>
509 <option>(color)</option>
512 Change drawing color to color
513 <para></para></listitem>
517 <term><command><option>colorN</option></command></term>
519 Change drawing color to colorN configuration option, where N is a digit between 0 and 9, inclusively.
520 <para></para></listitem>
525 <command><option>combine</option></command>
526 <option>var1 var2</option>
529 Places the lines of var2 to the right of the lines of var1 seperated by the chars that are put between var1 and var2. For example: ${combine ${head /proc/cpuinfo 2} - ${head /proc/meminfo 1}} gives as output "cpuinfo_line1 - meminfo_line1" on line 1 and "cpuinfo_line2 -" on line 2. $combine vars can also be nested to place more vars next to each other.
530 <para></para></listitem>
535 <command><option>conky_version</option></command>
539 <para></para></listitem>
544 <command><option>conky_build_date</option></command>
548 <para></para></listitem>
553 <command><option>conky_build_arch</option></command>
556 CPU architecture Conky was built for
557 <para></para></listitem>
562 <command><option>cpu</option></command>
563 <option>(cpuN)</option>
566 CPU usage in percents. For SMP machines, the CPU number can be provided as an argument. ${cpu cpu0} is the total usage, and ${cpu cpuX} (X >= 1) are individual CPUs.
567 <para></para></listitem>
572 <command><option>cpubar</option></command>
573 <option>(cpuN) (height),(width)</option>
576 Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
577 <para></para></listitem>
582 <command><option>cpugauge</option></command>
583 <option>(cpuN) (height),(width)</option>
586 Elliptical gauge that shows CPU usage, height and width are gauge's vertical and horizontal axis respectively. See $cpu for more info on SMP.
587 <para></para></listitem>
592 <command><option>cpugraph</option></command>
593 <option>(cpuN) ("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t)</option>
596 CPU usage graph, with optional colours in hex, minus the #. See $cpu for more info on SMP. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal". Takes the switch '-t' to use a temperature gradient, which makes the gradient values change depending on the amplitude of a particular graph value (try it and see).
597 <para></para></listitem>
602 <command><option>diskio</option></command>
603 <option>(device)</option>
606 Displays current disk IO. Device is optional, and takes the form of sda for /dev/sda. Individual partitions are allowed.
607 <para></para></listitem>
612 <command><option>diskiograph</option></command>
613 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t) (device)</option>
616 Disk IO graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal". Takes the switch '-t' to use a temperature gradient, which makes the gradient values change depending on the amplitude of a particular graph value (try it and see).
617 <para></para></listitem>
622 <command><option>diskio_read</option></command>
623 <option>(device)</option>
626 Displays current disk IO for reads. Device as in diskio.
627 <para></para></listitem>
632 <command><option>diskiograph_read</option></command>
633 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t) (device)</option>
636 Disk IO graph for reads, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Device as in diskio. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal". Takes the switch '-t' to use a temperature gradient, which makes the gradient values change depending on the amplitude of a particular graph value (try it and see).
637 <para></para></listitem>
642 <command><option>diskio_write</option></command>
643 <option>(device)</option>
646 Displays current disk IO for writes. Device as in diskio.
647 <para></para></listitem>
652 <command><option>diskiograph_write</option></command>
653 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t) (device)</option>
656 Disk IO graph for writes, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Device as in diskio. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal". Takes the switch '-t' to use a temperature gradient, which makes the gradient values change depending on the amplitude of a particular graph value (try it and see).
657 <para></para></listitem>
662 <command><option>disk_protect</option></command>
663 <option>device</option>
666 Disk protection status, if supported (needs kernel-patch). Prints either "frozen" or "free " (note the padding).
667 <para></para></listitem>
672 <command><option>downspeed</option></command>
676 Download speed in KiB
677 <para></para></listitem>
682 <command><option>downspeedf</option></command>
686 Download speed in KiB with one decimal
687 <para></para></listitem>
692 <command><option>downspeedgraph</option></command>
693 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t) (net)</option>
696 Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal". Takes the switch '-t' to use a temperature gradient, which makes the gradient values change depending on the amplitude of a particular graph value (try it and see).
697 <para></para></listitem>
702 <command><option>else</option></command>
705 Text to show if any of the above are not true
706 <para></para></listitem>
711 <command><option>entropy_avail</option></command>
714 Current entropy available for crypto freaks
715 <para></para></listitem>
720 <command><option>entropy_bar</option></command>
721 <option>(height),(width)</option>
724 Normalized bar of available entropy for crypto freaks
725 <para></para></listitem>
730 <command><option>entropy_poolsize</option></command>
733 Total size of system entropy pool for crypto freaks
734 <para></para></listitem>
739 <command><option>eval</option></command>
740 <option>string</option>
743 Evalutates given string according to the rules of TEXT interpretation, i.e. parsing any contained text object specifications into their output, any occuring '$$' into a single '$' and so on. The output is then being parsed again.
744 <para></para></listitem>
749 <command><option>exec</option></command>
750 <option>command</option>
753 Executes a shell command and displays the output in conky. warning: this takes a lot more resources than other variables. I'd recommend coding wanted behaviour in C and posting a patch.
754 <para></para></listitem>
759 <command><option>execbar</option></command>
760 <option>command</option>
763 Same as exec, except if the first value return is a value between 0-100, it will use that number for a bar. The size for bars can be controlled via the default_bar_size config setting.
764 <para></para></listitem>
769 <command><option>execgauge</option></command>
770 <option>command</option>
773 Same as exec, except if the first value returned is a value between 0-100, it will use that number for a gauge. The size for gauges can be controlled via the default_gauge_size config setting.
774 <para></para></listitem>
779 <command><option>execgraph</option></command>
780 <option>("normal"|"log") (-t) command</option>
783 Same as execbar, but graphs values. Uses a logaritmic scale when the log option is given (to see small numbers). Values still have to be between 0 and 100. The size for graphs can be controlled via the default_graph_size config setting. Takes the switch '-t' to use a temperature gradient, which makes the gradient values change depending on the amplitude of a particular graph value (try it and see).
784 <para></para></listitem>
789 <command><option>execi</option></command>
790 <option>interval command</option>
793 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
794 <para></para></listitem>
799 <command><option>execibar</option></command>
800 <option>interval command</option>
803 Same as execbar, except with an interval
804 <para></para></listitem>
809 <command><option>execigraph</option></command>
810 <option>interval ("normal"|"log") (-t) command</option>
813 Same as execgraph, but takes an interval arg and graphs values.
814 <para></para></listitem>
819 <command><option>execigauge</option></command>
820 <option>interval command</option>
823 Same as execgauge, but takes an interval arg and gauges values.
824 <para></para></listitem>
829 <command><option>execp</option></command>
830 <option>command</option>
833 Executes a shell command and displays the output in conky. warning: this takes a lot more resources than other variables. I'd recommend coding wanted behaviour in C and posting a patch. This differs from $exec in that it parses the output of the command, so you can insert things like ${color red}hi!${color} in your script and have it correctly parsed by Conky.
834 Caveats: Conky parses and evaluates the output of $execp every time Conky loops, and then destroys all the objects. If you try to use anything like $execi within an $execp statement, it will functionally run at the same interval that the $execp statement runs, as it is created and destroyed at every interval.
835 <para></para></listitem>
840 <command><option>execpi</option></command>
841 <option>interval command</option>
844 Same as execp but with specific interval. Interval can't be less than update_interval in configuration. Note that the output from the $execpi command is still parsed and evaluated at every interval.
845 <para></para></listitem>
850 <command><option>font</option></command>
851 <option>(font)</option>
854 Specify a different font. This new font will apply to the current line and everything following. You can use a $font with no arguments to change back to the default font (much like with $color)
855 <para></para></listitem>
860 <command><option>freq</option></command>
864 Returns CPU #n's frequency in MHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
865 <para></para></listitem>
869 <command><option>freq_g</option></command>
873 Returns CPU #n's frequency in GHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
874 <para></para></listitem>
879 <command><option>fs_bar</option></command>
880 <option>(height),(width) fs</option>
883 Bar that shows how much space is used on a file system. height is the height in pixels. fs is any file on that file system.
884 <para></para></listitem>
889 <command><option>fs_bar_free</option></command>
890 <option>(height),(width) fs</option>
893 Bar that shows how much space is free on a file system. height is the height in pixels. fs is any file on that file system.
894 <para></para></listitem>
899 <command><option>fs_free</option></command>
900 <option>(fs)</option>
903 Free space on a file system available for users.
904 <para></para></listitem>
909 <command><option>fs_free_perc</option></command>
910 <option>(fs)</option>
913 Free percentage of space on a file system available for users.
914 <para></para></listitem>
919 <command><option>fs_size</option></command>
920 <option>(fs)</option>
924 <para></para></listitem>
929 <command><option>fs_type</option></command>
930 <option>(fs)</option>
934 <para></para></listitem>
939 <command><option>fs_used</option></command>
940 <option>(fs)</option>
943 File system used space.
944 <para></para></listitem>
949 <command><option>fs_used_perc</option></command>
950 <option>(fs)</option>
953 Percent of file system used space.
954 <para></para></listitem>
959 <command><option>goto</option></command>
963 The next element will be printed at position 'x'.
964 <para></para></listitem>
969 <command><option>gw_iface</option></command>
972 Displays the default route's interface or "multiple"/"none" accordingly.
973 <para></para></listitem>
978 <command><option>gw_ip</option></command>
981 Displays the default gateway's IP or "multiple"/"none" accordingly.
982 <para></para></listitem>
987 <command><option>hddtemp</option></command>
988 <option>dev, (host,(port))</option>
991 Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
992 Default host is 127.0.0.1, default port is 7634.
993 <para></para></listitem>
998 <command><option>head</option></command>
999 <option>logfile lines (interval)</option>
1002 Displays first N lines of supplied text text file. If interval is not supplied, Conky assumes 2x Conky's interval. Max of 30 lines can be displayed, or until the text buffer is filled.
1003 <para></para></listitem>
1008 <command><option>hr</option></command>
1009 <option>(height)</option>
1012 Horizontal line, height is the height in pixels
1013 <para></para></listitem>
1018 <command><option>hwmon</option></command>
1019 <option>(dev) type n (factor offset)</option>
1022 Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omitted if you have only one hwmon device. Parameter type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning temperature. Parameter n is number of the sensor. See /sys/class/hwmon/ on your local computer. The optional arguments 'factor' and 'offset' allow precalculation of the raw input, which is being modified as follows: 'input = input * factor + offset'. Note that they have to be given as decimal values (i.e. contain at least one decimal place).
1023 <para></para></listitem>
1028 <command><option>iconv_start</option></command>
1029 <option>codeset_from codeset_to</option>
1032 Convert text from one codeset to another using GNU iconv. Needs to be stopped with iconv_stop.
1033 <para></para></listitem>
1038 <command><option>iconv_stop</option></command>
1042 Stop iconv codeset conversion.
1043 <para></para></listitem>
1048 <command><option>image</option></command>
1049 <option><path to image> (-p x,y) (-s WxH) (-n) (-f interval)</option>
1052 Renders an image from the path specified using Imlib2. Takes 4 optional arguments: a position, a size, a no-cache switch, and a cache flush interval. Changing the x,y position will move the position of the image, and changing the WxH will scale the image. If you specify the no-cache flag (-n), the image will not be cached. Alternately, you can specify the -f int switch to specify a cache flust interval for a particular image. Example: ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200} will render 'cheeseburger.jpg' at (20,20) scaled to 200x200 pixels. Conky does not make any attempt to adjust the position (or any other formatting) of images, they are just rendered as per the arguments passed. The only reason $image is part of the TEXT section, is to allow for runtime modifications, through $execp $lua_parse, $lua_read_parse, or some other method.
1053 <para></para></listitem>
1058 <command><option>i2c</option></command>
1059 <option>(dev) type n (factor offset)</option>
1062 I2C sensor from sysfs (Linux 2.6). Parameter dev may be omitted if you have only one I2C device. Parameter type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning temperature. Parameter n is number of the sensor. See /sys/bus/i2c/devices/ on your local computer. The optional arguments 'factor' and 'offset' allow precalculation of the raw input, which is being modified as follows: 'input = input * factor + offset'. Note that they have to be given as decimal values (i.e. contain at least one decimal place).
1063 <para></para></listitem>
1068 <command><option>i8k_ac_status</option></command>
1072 If running the i8k kernel driver for Inspiron laptops, displays whether ac power is on, as listed in /proc/i8k (translated to human-readable). Beware that this is by default not enabled by i8k itself.
1073 <para></para></listitem>
1078 <command><option>i8k_bios</option></command>
1082 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
1083 <para></para></listitem>
1088 <command><option>i8k_buttons_status</option></command>
1092 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
1093 <para></para></listitem>
1098 <command><option>i8k_cpu_temp</option></command>
1102 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
1103 <para></para></listitem>
1108 <command><option>i8k_left_fan_rpm</option></command>
1112 If running the i8k kernel driver for Inspiron laptops, displays the left fan's rate of rotation, in revolutions per minute as listed in /proc/i8k. Beware, some laptops i8k reports these fans in reverse order.
1113 <para></para></listitem>
1118 <command><option>i8k_left_fan_status</option></command>
1122 If running the i8k kernel driver for Inspiron laptops, displays the left fan status as listed in /proc/i8k (translated to human-readable). Beware, some laptops i8k reports these fans in reverse order.
1123 <para></para></listitem>
1128 <command><option>i8k_right_fan_rpm</option></command>
1132 If running the i8k kernel driver for Inspiron laptops, displays the right fan's rate of rotation, in revolutions per minute as listed in /proc/i8k. Beware, some laptops i8k reports these fans in reverse order.
1133 <para></para></listitem>
1138 <command><option>i8k_right_fan_status</option></command>
1142 If running the i8k kernel driver for Inspiron laptops, displays the right fan status as listed in /proc/i8k (translated to human-readable). Beware, some laptops i8k reports these fans in reverse order.
1143 <para></para></listitem>
1148 <command><option>i8k_serial</option></command>
1152 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
1153 <para></para></listitem>
1158 <command><option>i8k_version</option></command>
1162 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
1163 <para></para></listitem>
1168 <command><option>ibm_fan</option></command>
1171 If running the IBM ACPI, displays the fan speed.
1172 <para></para></listitem>
1177 <command><option>ibm_temps</option></command>
1181 If running the IBM ACPI, displays the temperatures
1182 from the IBM temperature sensors (N=0..7) Sensor 0 is
1183 on the CPU, 3 is on the GPU.
1184 <para></para></listitem>
1189 <command><option>ibm_volume</option></command>
1192 If running the IBM ACPI, displays the "master" volume,
1193 controlled by the volume keys (0-14).
1194 <para></para></listitem>
1199 <command><option>ibm_brightness</option></command>
1202 If running the IBM ACPI, displays the brigtness of the
1203 laptops's LCD (0-7).
1204 <para></para></listitem>
1209 <command><option>if_empty</option></command>
1210 <option>(var)</option>
1213 if conky variable VAR is empty, display everything
1214 between $if_empty and the matching $endif
1215 <para></para></listitem>
1220 <command><option>if_existing</option></command>
1221 <option>file (string)</option>
1224 if FILE exists, display everything between if_existing
1225 and the matching $endif. The optional second paramater
1226 checks for FILE containing the specified string and
1227 prints everything between $if_existing and the matching
1229 <para></para></listitem>
1234 <command><option>if_gw</option></command>
1237 if there is at least one default gateway, display
1238 everything between $if_gw and the matching $endif
1239 <para></para></listitem>
1244 <command><option>if_match</option></command>
1245 <option>expression</option>
1248 Evaluates the given boolean expression, printing
1249 everything between $if_match and the matching $endif
1250 depending on whether the evaluation returns true or not.
1251 Valid expressions consist of a left side, an operator
1252 and a right side. Left and right sides are being parsed
1253 for contained text objects before evaluation. Recognised
1254 left and right side types are:
1256 <member><command>double</command>:
1257 argument consists of only digits and a
1260 <member><command>long</command>:
1261 argument consists of only digits.
1263 <member><command>string</command>:
1264 argument is enclosed in quotation mark
1265 or the checks for double and long failed
1270 '>', '<', '>=', '<=', '==', '!='.
1271 <para></para></listitem>
1276 <command><option>if_mixer_mute</option></command>
1277 <option>(mixer)</option>
1280 If mixer exists, display everything between $if_mixer_mute and the
1281 matching $endif. If no mixer is specified, "Master" is used.
1282 <para></para></listitem>
1287 <command><option>if_running</option></command>
1288 <option>(process)</option>
1291 if PROCESS is running, display everything $if_running
1292 and the matching $endif. This uses the ``pidof'' command, so the
1293 -x switch is also supported.
1294 <para></para></listitem>
1299 <command><option>if_mounted</option></command>
1300 <option>(mountpoint)</option>
1303 if MOUNTPOINT is mounted, display everything between
1304 $if_mounted and the matching $endif
1305 <para></para></listitem>
1310 <command><option>if_smapi_bat_installed</option></command>
1311 <option>(INDEX)</option>
1314 when using smapi, if the battery with index INDEX is
1315 installed, display everything between
1316 $if_smapi_bat_installed and the matching $endif
1317 <para></para></listitem>
1322 <command><option>if_up</option></command>
1323 <option>(interface)</option>
1326 if INTERFACE exists and is up, display everything between $if_up and the matching $endif
1327 <para></para></listitem>
1332 <command><option>if_updatenr</option></command>
1333 <option>(updatenr)</option>
1336 If it's the UPDATENR-th time that conky updates,
1337 display everything between $if_updatenr and the matching $endif.
1338 The counter resets when the highest UPDATENR is reached.
1339 Example : "{$if_updatenr 1}foo$endif{$if_updatenr 2}bar$endif{$if_updatenr 4}$endif"
1340 shows foo 25% of the time followed by bar 25% of the time followed by nothing the other half of the time.
1341 <para></para></listitem>
1346 <command><option>imap_messages</option></command>
1347 <option>(args)</option>
1350 Displays the number of messages in your global IMAP inbox by default. You can define individual IMAP inboxes seperately by passing arguments to this object. Arguments are: "host user pass [-i interval (in seconds)] [-f folder] [-p port] [-e command] [-r retries]". Default port is 143, default folder is 'INBOX', default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1351 <para></para></listitem>
1356 <command><option>imap_unseen</option></command>
1357 <option>(args)</option>
1360 Displays the number of unseen messages in your global IMAP inbox by default. You can define individual IMAP inboxes seperately by passing arguments to this object. Arguments are: "host user pass [-i interval (in seconds)] [-f folder] [-p port] [-e command] [-r retries]". Default port is 143, default folder is 'INBOX', default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1361 <para></para></listitem>
1366 <command><option>ioscheduler</option></command>
1367 <option>disk</option>
1370 Prints the current ioscheduler used for the given disk name (i.e. e.g. "hda" or "sdb")
1371 <para></para></listitem>
1376 <command><option>kernel</option></command>
1380 <para></para></listitem>
1385 <command><option>laptop_mode</option></command>
1388 The value of /proc/sys/vm/laptop_mode
1389 <para></para></listitem>
1394 <command><option>loadavg</option></command>
1397 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
1398 <para></para></listitem>
1403 <command><option>loadgraph</option></command>
1404 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t)</option>
1407 Load1 average graph, similar to xload, with optional colours in hex, minus the #. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal". Takes the switch '-t' to use a temperature gradient, which makes the gradient values change depending on the amplitude of a particular graph value (try it and see).
1408 <para></para></listitem>
1413 <command><option>lines</option></command>
1414 <option>textfile</option>
1417 Displays the number of lines in the given file
1418 <para></para></listitem>
1423 <command><option>machine</option></command>
1426 Machine, i686 for example
1427 <para></para></listitem>
1432 <command><option>mails</option></command>
1433 <option>(mailbox)</option>
1434 <option>(interval)</option>
1437 Mail count in the specified mailbox or your mail spool if not.
1438 Both mbox and maildir type mailboxes are supported. You can
1439 use a program like fetchmail to get mails from some server
1440 using your favourite protocol. See also new_mails.
1441 <para></para></listitem>
1446 <command><option>new_mails</option></command>
1447 <option>(mailbox)</option>
1448 <option>(interval)</option>
1451 Unread mail count in the specified mailbox or mail spool if
1452 not. Both mbox and maildir type mailboxes are supported.
1453 <para></para></listitem>
1458 <command><option>seen_mails</option></command>
1459 <option>(maildir)</option>
1460 <option>(interval)</option>
1463 Number of mails marked as seen in the specified mailbox or mail spool if
1464 not. Only maildir type mailboxes are supported, mbox type will return -1.
1465 <para></para></listitem>
1470 <command><option>unseen_mails</option></command>
1471 <option>(maildir)</option>
1472 <option>(interval)</option>
1475 Number of new or unseen mails in the specified mailbox or mail spool if
1476 not. Only maildir type mailboxes are supported, mbox type will return -1.
1477 <para></para></listitem>
1482 <command><option>flagged_mails</option></command>
1483 <option>(maildir)</option>
1484 <option>(interval)</option>
1487 Number of mails marked as flagged in the specified mailbox or mail spool if
1488 not. Only maildir type mailboxes are supported, mbox type will return -1.
1489 <para></para></listitem>
1494 <command><option>unflagged_mails</option></command>
1495 <option>(maildir)</option>
1496 <option>(interval)</option>
1499 Number of mails not marked as flagged in the specified mailbox or mail spool if
1500 not. Only maildir type mailboxes are supported, mbox type will return -1.
1501 <para></para></listitem>
1506 <command><option>forwarded_mails</option></command>
1507 <option>(maildir)</option>
1508 <option>(interval)</option>
1511 Number of mails marked as forwarded in the specified mailbox or mail spool if
1512 not. Only maildir type mailboxes are supported, mbox type will return -1.
1513 <para></para></listitem>
1518 <command><option>unforwarded_mails</option></command>
1519 <option>(maildir)</option>
1520 <option>(interval)</option>
1523 Number of mails not marked as forwarded in the specified mailbox or mail spool if
1524 not. Only maildir type mailboxes are supported, mbox type will return -1.
1525 <para></para></listitem>
1530 <command><option>replied_mails</option></command>
1531 <option>(maildir)</option>
1532 <option>(interval)</option>
1535 Number of mails marked as replied in the specified mailbox or mail spool if
1536 not. Only maildir type mailboxes are supported, mbox type will return -1.
1537 <para></para></listitem>
1542 <command><option>unreplied_mails</option></command>
1543 <option>(maildir)</option>
1544 <option>(interval)</option>
1547 Number of mails not marked as replied in the specified mailbox or mail spool if
1548 not. Only maildir type mailboxes are supported, mbox type will return -1.
1549 <para></para></listitem>
1554 <command><option>draft_mails</option></command>
1555 <option>(maildir)</option>
1556 <option>(interval)</option>
1559 Number of mails marked as draft in the specified mailbox or mail spool if
1560 not. Only maildir type mailboxes are supported, mbox type will return -1.
1561 <para></para></listitem>
1566 <command><option>trashed_mails</option></command>
1567 <option>(maildir)</option>
1568 <option>(interval)</option>
1571 Number of mails marked as trashed in the specified mailbox or mail spool if
1572 not. Only maildir type mailboxes are supported, mbox type will return -1.
1573 <para></para></listitem>
1578 <command><option>mboxscan</option></command>
1579 <option>(-n number of messages to print) (-fw from width) (-sw subject width) mbox</option>
1582 Print a summary of recent messages in an mbox format mailbox. mbox parameter is the filename of the mailbox (can be encapsulated using '"', ie. ${mboxscan -n 10 "/home/brenden/some box"}
1583 <para></para></listitem>
1588 <command><option>mem</option></command>
1591 Amount of memory in use
1592 <para></para></listitem>
1597 <command><option>membar</option></command>
1598 <option>(height),(width)</option>
1601 Bar that shows amount of memory in use
1602 <para></para></listitem>
1607 <command><option>memgauge</option></command>
1608 <option>(height),(width)</option>
1611 Gauge that shows amount of memory in use (see cpugauge)
1612 <para></para></listitem>
1617 <command><option>memgraph</option></command>
1618 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t)</option>
1621 Memory usage graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal". Takes the switch '-t' to use a temperature gradient, which makes the gradient values change depending on the amplitude of a particular graph value (try it and see).
1622 <para></para></listitem>
1627 <command><option>memeasyfree</option></command>
1630 Amount of free memory including the memory that is very easily freed (buffers/cache)
1631 <para></para></listitem>
1636 <command><option>memfree</option></command>
1639 Amount of free memory
1640 <para></para></listitem>
1645 <command><option>memmax</option></command>
1648 Total amount of memory
1649 <para></para></listitem>
1654 <command><option>memperc</option></command>
1657 Percentage of memory in use
1658 <para></para></listitem>
1663 <command><option>mixer</option></command>
1664 <option>(device)</option>
1667 Prints the mixer value as reported by the OS. Default mixer is "vol", but you can specify one of the following optional arguments: "vol", "bass", "treble", "synth", "pcm", "speaker", "line", "mic", "cd", "mix", "pcm2", "rec", "igain", "ogain", "line1", "line2", "line3", "dig1", "dig2", "dig3", "phin", "phout", "video", "radio", "monitor". Refer to the definition of SOUND_DEVICE_NAMES in <linux/soundcard.h> (on Linux), <soundcard.h> (on OpenBSD), or <sys/soundcard.h> to find the exact options available on your system.
1668 <para></para></listitem>
1673 <command><option>mixerbar</option></command>
1674 <option>(device)</option>
1677 Displays mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
1678 <para></para></listitem>
1683 <command><option>mixerr</option></command>
1684 <option>(device)</option>
1687 Prints the right channel mixer value as reported by the OS. See docs for $mixer for details on arguments.
1688 <para></para></listitem>
1693 <command><option>mixerrbar</option></command>
1694 <option>(device)</option>
1697 Displays the right channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
1698 <para></para></listitem>
1703 <command><option>mixerl</option></command>
1704 <option>(device)</option>
1707 Prints the left channel mixer value as reported by the OS. See docs for $mixer for details on arguments.
1708 <para></para></listitem>
1713 <command><option>mixerlbar</option></command>
1714 <option>(device)</option>
1717 Displays the left channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
1718 <para></para></listitem>
1723 <command><option>moc_state</option></command>
1726 Current state of MOC; playing, stopped etc.
1727 <para></para></listitem>
1732 <command><option>moc_file</option></command>
1735 File name of the current MOC song
1736 <para></para></listitem>
1741 <command><option>moc_title</option></command>
1744 Title of the current MOC song
1745 <para></para></listitem>
1750 <command><option>moc_artist</option></command>
1753 Artist of the current MOC song
1754 <para></para></listitem>
1759 <command><option>moc_song</option></command>
1762 The current song name being played in MOC.
1763 <para></para></listitem>
1768 <command><option>moc_album</option></command>
1771 Album of the current MOC song
1772 <para></para></listitem>
1777 <command><option>moc_totaltime</option></command>
1780 Total length of the current MOC song
1781 <para></para></listitem>
1786 <command><option>moc_timeleft</option></command>
1789 Time left in the current MOC song
1790 <para></para></listitem>
1795 <command><option>moc_curtime</option></command>
1798 Current time of the current MOC song
1799 <para></para></listitem>
1804 <command><option>moc_bitrate</option></command>
1807 Bitrate in the current MOC song
1808 <para></para></listitem>
1813 <command><option>moc_rate</option></command>
1816 Rate of the current MOC song
1817 <para></para></listitem>
1822 <command><option>monitor</option></command>
1825 Number of the monitor on which conky is running
1826 <para></para></listitem>
1831 <command><option>monitor_number</option></command>
1835 <para></para></listitem>
1840 <command><option>mpd_artist</option></command>
1843 Artist in current MPD song must be enabled at compile
1844 <para></para></listitem>
1849 <command><option>mpd_album</option></command>
1852 Album in current MPD song
1853 <para></para></listitem>
1858 <command><option>mpd_bar</option></command>
1859 <option>(height),(width)</option>
1862 Bar of mpd's progress
1863 <para></para></listitem>
1868 <command><option>mpd_bitrate</option></command>
1871 Bitrate of current song
1872 <para></para></listitem>
1877 <command><option>mpd_status</option></command>
1880 Playing, stopped, et cetera.
1881 <para></para></listitem>
1886 <command><option>mpd_title</option></command>
1887 <option>(max length)</option>
1890 Title of current MPD song
1891 <para></para></listitem>
1896 <command><option>mpd_vol</option></command>
1900 <para></para></listitem>
1905 <command><option>mpd_elapsed</option></command>
1909 <para></para></listitem>
1914 <command><option>mpd_length</option></command>
1918 <para></para></listitem>
1923 <command><option>mpd_percent</option></command>
1926 Percent of song's progress
1927 <para></para></listitem>
1932 <command><option>mpd_random</option></command>
1935 Random status (On/Off)
1936 <para></para></listitem>
1941 <command><option>mpd_repeat</option></command>
1944 Repeat status (On/Off)
1945 <para></para></listitem>
1950 <command><option>mpd_track</option></command>
1953 Prints the MPD track field
1954 <para></para></listitem>
1959 <command><option>mpd_name</option></command>
1962 Prints the MPD name field
1963 <para></para></listitem>
1968 <command><option>mpd_file</option></command>
1971 Prints the file name of the current MPD song
1972 <para></para></listitem>
1977 <command><option>mpd_smart</option></command>
1978 <option>(max length)</option>
1981 Prints the song name in either the form "artist - title" or file name, depending on whats available
1982 <para></para></listitem>
1987 <command><option>if_mpd_playing</option></command>
1990 if mpd is playing or paused, display everything between $if_mpd_playing and the matching $endif
1991 <para></para></listitem>
1996 <command><option>nameserver</option></command>
1997 <option>(index)</option>
2000 Print a nameserver from /etc/resolv.conf. Index starts at and defaults to 0.
2001 <para></para></listitem>
2006 <command><option>nodename</option></command>
2010 <para></para></listitem>
2015 <command><option>nvidia</option></command>
2016 <option>threshold</option>
2017 <option>temp</option>
2018 <option>ambient</option>
2019 <option>gpufreq</option>
2020 <option>memfreq</option>
2021 <option>imagequality</option>
2024 Nvidia graficcard support for the XNVCtrl library.
2025 Each option can be shortened to the least significant part.
2026 Temperatures are printed as float, all other values as integer.
2028 <member><command>threshold</command>:
2029 the thresholdtemperature at which the gpu slows down
2031 <member><command>temp</command>:
2032 gives the gpu current temperature
2034 <member><command>ambient</command>:
2035 gives current air temperature near GPU case
2037 <member><command>gpufreq</command>:
2038 gives the current gpu frequency
2040 <member><command>memfreq</command>:
2041 gives the current mem frequency
2043 <member><command>imagequality</command>:
2044 which imagequality should be choosen by OpenGL applications
2053 <command><option>outlinecolor</option></command>
2054 <option>(color)</option>
2057 Change outline color
2058 <para></para></listitem>
2063 <command><option>pb_battery</option></command>
2064 <option>item</option>
2067 If running on Apple powerbook/ibook, display
2068 information on battery status. The item parameter
2069 specifies, what information to display. Exactly one item
2070 must be specified. Valid items are:
2072 <member><command>status</command>:
2073 Display if battery is fully charged, charging,
2074 discharging or absent (running on AC)
2076 <member><command>percent</command>:
2077 Display charge of battery in percent, if
2078 charging or discharging. Nothing will be
2079 displayed, if battery is fully charged
2082 <member><command>time</command>:
2083 Display the time remaining until the battery
2084 will be fully charged or discharged at current
2085 rate. Nothing is displayed, if battery is
2086 absent or if it's present but fully charged
2087 and not discharging.
2090 <para></para></listitem>
2095 <command><option>platform</option></command>
2096 <option>(dev) type n (factor offset)</option>
2099 Platform sensor from sysfs (Linux 2.6). Parameter dev may be omitted if you have only one platform device. Platform type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' meaning temperature. Parameter n is number of the sensor. See /sys/bus/platform/devices/ on your local computer. The optional arguments 'factor' and 'offset' allow precalculation of the raw input, which is being modified as follows: 'input = input * factor + offset'. Note that they have to be given as decimal values (i.e. contain at least one decimal place).
2100 <para></para></listitem>
2105 <command><option>pop3_unseen</option></command>
2106 <option>(args)</option>
2109 Displays the number of unseen messages in your global POP3 inbox by default. You can define individual POP3 inboxes seperately by passing arguments to this object. Arguments are: "host user pass [-i interval (in seconds)] [-p port] [-e command] [-r retries]". Default port is 110, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
2111 <para></para></listitem>
2116 <command><option>pop3_used</option></command>
2117 <option>(args)</option>
2120 Displays the amount of space (in MiB, 2^20) used in your global POP3 inbox by default. You can define individual POP3 inboxes seperately by passing arguments to this object. Arguments are: "host user pass [-i interval (in seconds)] [-p port] [-e command] [-r retries]". Default port is 110, default interval is 5 minutes, and default number of retries before giving up is 5. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
2122 <para></para></listitem>
2127 <command><option>pre_exec</option></command>
2128 <option>shell command</option>
2131 Executes a shell command one time before conky displays anything and puts output as text.
2132 <para></para></listitem>
2137 <command><option>processes</option></command>
2140 Total processes (sleeping and running)
2141 <para></para></listitem>
2146 <command><option>running_processes</option></command>
2149 Running processes (not sleeping), requires Linux 2.6
2150 <para></para></listitem>
2155 <command><option>scroll</option></command>
2156 <option>length (step) text</option>
2159 Scroll 'text' by 'step' characters showing 'length' number of characters at the same time. The text may also contain variables. 'step' is optional and defaults to 1 if not set. If a var creates output on multiple lines then the lines are placed behind each other separated with a '|'-sign. Do NOT use vars that change colors or otherwise affect the design inside a scrolling text. If you want spaces between the start and the end of 'text', place them at the end of 'text' not at the front ("foobar" and " foobar" can both generate "barfoo" but "foobar " will keep the spaces like this "bar foo").
2160 <para></para></listitem>
2165 <command><option>shadecolor</option></command>
2166 <option>(color)</option>
2169 Change shading color
2170 <para></para></listitem>
2175 <command><option>smapi</option></command>
2176 <option>(ARGS)</option>
2179 when using smapi, display contents of the /sys/devices/platform/smapi directory. ARGS are either '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the corresponding files' content. This is a very raw method of accessing the smapi values. When available, better use one of the smapi_* variables instead.
2180 <para></para></listitem>
2185 <command><option>smapi_bat_bar</option></command>
2186 <option>(INDEX),(height),(width)</option>
2189 when using smapi, display the remaining capacity of the battery with index INDEX as a bar.
2190 <para></para></listitem>
2195 <command><option>smapi_bat_perc</option></command>
2196 <option>(INDEX)</option>
2199 when using smapi, display the remaining capacity in percent of the battery with index INDEX. This is a separate variable because it supports the 'use_spacer' configuration option.
2200 <para></para></listitem>
2205 <command><option>smapi_bat_power</option></command>
2206 <option>INDEX</option>
2209 when using smapi, display the current power of the battery with index INDEX in watt. This is a separate variable because the original read out value is being converted from mW. The sign of the output reflects charging (positive) or discharging (negative) state.
2210 <para></para></listitem>
2215 <command><option>smapi_bat_temp</option></command>
2216 <option>INDEX</option>
2219 when using smapi, display the current temperature of the battery with index INDEX in degree Celsius. This is a separate variable because the original read out value is being converted from milli degree Celsius.
2220 <para></para></listitem>
2225 <command><option>stippled_hr</option></command>
2226 <option>(space)</option>
2229 Stippled (dashed) horizontal line
2230 <para></para></listitem>
2235 <command><option>swapbar</option></command>
2236 <option>(height),(width)</option>
2239 Bar that shows amount of swap in use
2240 <para></para></listitem>
2245 <command><option>swap</option></command>
2248 Amount of swap in use
2249 <para></para></listitem>
2254 <command><option>swapmax</option></command>
2257 Total amount of swap
2258 <para></para></listitem>
2263 <command><option>swapperc</option></command>
2266 Percentage of swap in use
2267 <para></para></listitem>
2272 <command><option>sysname</option></command>
2275 System name, Linux for example
2276 <para></para></listitem>
2281 <command><option>tcp_portmon</option></command>
2282 <option>port_begin port_end item (index)</option>
2283 <emphasis>(ip4 only at present)</emphasis>
2286 TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
2288 <member><command>count</command> - total number of connections in the range
2290 <member><command>rip</command> - remote ip address
2292 <member><command>rhost</command> - remote host name
2294 <member><command>rport</command> - remote port number
2296 <member><command>rservice</command> - remote service name from /etc/services
2298 <member><command>lip</command> - local ip address
2300 <member><command>lhost</command> - local host name
2302 <member><command>lport</command> - local port number
2304 <member><command>lservice</command> - local service name from /etc/services
2306 </simplelist>The connection index provides you with access to each connection in the port monitor. The monitor will return information for index values from 0 to n-1 connections. Values higher than n-1 are simply ignored. For the "count" item, the connection index must be omitted. It is required for all other items.
2308 <member>Examples:</member>
2309 <member><command>${tcp_portmon 6881 6999 count}</command> -
2310 displays the number of connections in the bittorrent port range</member>
2311 <member><command>${tcp_portmon 22 22 rip 0}</command> -
2312 displays the remote host ip of the first sshd connection</member>
2313 <member><command>${tcp_portmon 22 22 rip 9}</command> -
2314 displays the remote host ip of the tenth sshd connection</member>
2315 <member><command>${tcp_portmon 1 1024 rhost 0}</command> -
2316 displays the remote host name of the first connection on a privileged port</member>
2317 <member><command>${tcp_portmon 1 1024 rport 4}</command> -
2318 displays the remote host port of the fifth connection on a privileged port</member>
2319 <member><command>${tcp_portmon 1 65535 lservice 14}</command> -
2320 displays the local service name of the fifteenth connection in the range of all ports</member>
2321 </simplelist>Note that port monitor variables which share the same port range actually refer to the same monitor, so many references to a single port range for different items and different indexes all use the same monitor internally. In other words, the program avoids creating redundant monitors.
2327 <command><option>texeci</option></command>
2328 <option>interval command</option>
2331 Runs a command at an interval inside a thread and displays the output. Same as $execi, except the command is run inside a thread. Use this if you have a slow script to keep Conky updating. You should make the interval slightly longer then the time it takes your script to execute. For example, if you have a script that take 5 seconds to execute, you should make the interval at least 6 seconds. See also $execi.
2332 <para></para></listitem>
2337 <command><option>offset</option></command>
2338 <option>(pixels)</option>
2341 Move text over by N pixels. See also $voffset.
2342 <para></para></listitem>
2347 <command><option>rss</option></command>
2348 <option>url delay_in_minutes action (num_par (spaces_in_front))</option>
2351 Download and parse RSS feeds. Action may be one of the following: feed_title, item_title (with num par), item_desc (with num par) and item_titles (when using this action and spaces_in_front is given conky places that many spaces in front of each item).
2352 <para></para></listitem>
2357 <command><option>lua</option></command>
2358 <option>function_name (function parameters)</option>
2361 Executes a Lua function with given parameters, then prints the returned string. See also 'lua_load' on how to load scripts.
2362 <para></para></listitem>
2367 <command><option>lua_parse</option></command>
2368 <option>function_name (function parameters)</option>
2371 Executes a Lua function with given parameters as per $lua, then parses and prints the result value as per the syntax for Conky's TEXT section. See also 'lua_load' on how to load scripts.
2372 <para></para></listitem>
2377 <command><option>lua_read_parse</option></command>
2378 <option>function_name (conky text)</option>
2381 Executes a Lua function per $lua, except takes a 2nd argument which is first evaluated as per Conky's TEXT section and passed to the function first. The return value is then parsed and prints the result value as per the syntax for Conky's TEXT section. See also 'lua_load' on how to load scripts.
2382 <para></para></listitem>
2387 <command><option>lua_bar</option></command>
2388 <option>(height, width) function_name (function parameters)</option>
2391 Executes a Lua function with given parameters and draws a bar. Expects result value to be an integer between 0 and 100. See also 'lua_load' on how to load scripts.
2392 <para></para></listitem>
2397 <command><option>lua_graph</option></command>
2398 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t) function_name (function parameters)</option>
2401 Executes a Lua function with given parameters and draws a graph. Expects result value to be an integer between 0 and 100. See also 'lua_load' on how to load scripts. Takes the switch '-t' to use a temperature gradient, which makes the gradient values change depending on the amplitude of a particular graph value (try it and see).
2402 <para></para></listitem>
2407 <command><option>lua_gauge</option></command>
2408 <option>(height, width) function_name (function parameters)</option>
2411 Executes a Lua function with given parameters and draws a gauge. Expects result value to be an integer between 0 and 100. See also 'lua_load' on how to load scripts.
2412 <para></para></listitem>
2417 <command><option>tab</option></command>
2418 <option>(width, (start))</option>
2421 Puts a tab of the specified width, starting from column 'start'. The unit is pixels for both arguments.
2422 <para></para></listitem>
2427 <command><option>tail</option></command>
2428 <option>logfile lines (interval)</option>
2431 Displays last N lines of supplied text text file. If interval is not supplied, Conky assumes 2x Conky's interval. Max of 30 lines can be displayed, or until the text buffer is filled.
2432 <para></para></listitem>
2437 <command><option>templateN</option></command>
2438 <option>(arg1)</option>
2439 <option>(arg2)</option>
2440 <option>(arg3 ...)</option>
2443 Evaluate the content of the templateN configuration variable (where N is a value between 0 and 9, inclusively),
2444 applying substitutions as described in the documentation of the corresponding configuration variable.
2445 The number of arguments is optional, but must match the highest referred index in the template. You can use the
2446 same special sequences in each argument as the ones valid for a template definition, e.g. to allow an argument
2447 to contain a whitespace. Also simple nesting of templates is possible this way.
2448 <para></para></listitem>
2450 Here are some examples of template definitions:
2452 <member>template0 $\1\2</member>
2453 <member>template1 \1: ${fs_used \2} / ${fs_size \2}</member>
2454 <member>template2 \1 \2</member>
2456 The following list shows sample usage of the templates defined above,
2457 with the equivalent syntax when not using any template at all:
2461 <row rowsep="1"><entry>using template</entry><entry>same without template</entry></row>
2464 <row><entry>${template0 node name}</entry><entry>$nodename</entry></row>
2465 <row><entry>${template1 root /}</entry><entry>root: ${fs_free /} / ${fs_size /}</entry></row>
2467 <entry><programlisting>${template1 ${template2\ disk\ root} /}</programlisting></entry>
2468 <entry><programlisting>disk root: ${fs_free /} / ${fs_size /}</programlisting></entry>
2473 <para></para></listitem>
2478 <command><option>time</option></command>
2479 <option>(format)</option>
2482 Local time, see man strftime to get more information about format
2483 <para></para></listitem>
2488 <command><option>utime</option></command>
2489 <option>(format)</option>
2492 Display time in UTC (universal coordinate time).
2493 <para></para></listitem>
2498 <command><option>tztime</option></command>
2499 <option>(timezone) (format)</option>
2502 Local time for specified timezone, see man strftime to get more information about format. The timezone argument is specified in similar fashion as TZ environment variable. For hints, look in /usr/share/zoneinfo. e.g. US/Pacific, Europe/Zurich, etc.
2503 <para></para></listitem>
2508 <command><option>totaldown</option></command>
2509 <option>net</option>
2512 Total download, overflows at 4 GB on Linux with 32-bit arch and there doesn't seem to be a way to know how many times it has already done that before conky has started.
2513 <para></para></listitem>
2518 <command><option>top</option></command>
2519 <option>type, num</option>
2522 This takes arguments in the form:top (name) (number) Basically, processes are ranked from highest to lowest in terms of cpu usage, which is what (num) represents. The types are: "name", "pid", "cpu", "mem", "mem_res", "mem_vsize", and "time". There can be a max of 10 processes listed.
2523 <para></para></listitem>
2528 <command><option>top_mem</option></command>
2529 <option>type, num</option>
2532 Same as top, except sorted by mem usage instead of cpu
2533 <para></para></listitem>
2538 <command><option>top_time</option></command>
2539 <option>type, num</option>
2542 Same as top, except sorted by total CPU time instead of current CPU usage
2543 <para></para></listitem>
2548 <command><option>totalup</option></command>
2549 <option>net</option>
2552 Total upload, this one too, may overflow
2553 <para></para></listitem>
2558 <command><option>updates</option></command>
2559 <option>Number of updates</option>
2563 <para></para></listitem>
2568 <command><option>upspeed</option></command>
2569 <option>net</option>
2573 <para></para></listitem>
2578 <command><option>upspeedf</option></command>
2579 <option>net</option>
2582 Upload speed in KiB with one decimal
2583 <para></para></listitem>
2588 <command><option>upspeedgraph</option></command>
2589 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (-t) (net)</option>
2592 Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal". Takes the switch '-t' to use a temperature gradient, which makes the gradient values change depending on the amplitude of a particular graph value (try it and see).
2593 <para></para></listitem>
2598 <command><option>uptime</option></command>
2602 <para></para></listitem>
2607 <command><option>uptime_short</option></command>
2610 Uptime in a shorter format
2611 <para></para></listitem>
2616 <command><option>user_number</option></command>
2619 Number of users logged in
2620 <para></para></listitem>
2625 <command><option>user_names</option></command>
2628 Lists the names of the users logged in
2629 <para></para></listitem>
2634 <command><option>user_terms</option></command>
2637 Lists the consoles in use
2638 <para></para></listitem>
2643 <command><option>user_times</option></command>
2646 Lists how long users have been logged in for
2647 <para></para></listitem>
2652 <command><option>voffset</option></command>
2653 <option>(pixels)</option>
2656 Change vertical offset by N pixels. Negative values will cause text to overlap. See also $offset.
2657 <para></para></listitem>
2662 <command><option>voltage_mv</option></command>
2663 <option>(n)</option>
2666 Returns CPU #n's voltage in mV. CPUs are
2667 counted from 1. If omitted, the parameter
2669 <para></para></listitem>
2674 <command><option>voltage_v</option></command>
2675 <option>(n)</option>
2678 Returns CPU #n's voltage in V. CPUs are
2679 counted from 1. If omitted, the parameter
2681 <para></para></listitem>
2686 <command><option>wireless_essid</option></command>
2687 <option>net</option>
2690 Wireless access point ESSID (Linux only)
2691 <para></para></listitem>
2696 <command><option>wireless_mode</option></command>
2697 <option>net</option>
2700 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
2701 <para></para></listitem>
2706 <command><option>wireless_bitrate</option></command>
2707 <option>net</option>
2710 Wireless bitrate (ie 11 Mb/s) (Linux only)
2711 <para></para></listitem>
2716 <command><option>wireless_ap</option></command>
2717 <option>net</option>
2720 Wireless access point MAC address (Linux only)
2721 <para></para></listitem>
2726 <command><option>wireless_link_qual</option></command>
2727 <option>net</option>
2730 Wireless link quality (Linux only)
2731 <para></para></listitem>
2736 <command><option>wireless_link_qual_max</option></command>
2737 <option>net</option>
2740 Wireless link quality maximum value (Linux only)
2741 <para></para></listitem>
2746 <command><option>wireless_link_qual_perc</option></command>
2747 <option>net</option>
2750 Wireless link quality in percents (Linux only)
2751 <para></para></listitem>
2756 <command><option>wireless_link_bar</option></command>
2757 <option>(height), (width) net</option>
2760 Wireless link quality bar (Linux only)
2761 <para></para></listitem>
2766 <command><option>words</option></command>
2767 <option>textfile</option>
2770 Displays the number of words in the given file
2771 <para></para></listitem>
2776 <command><option>xmms2_artist</option></command>
2779 Artist in current XMMS2 song
2780 <para></para></listitem>
2785 <command><option>xmms2_album</option></command>
2788 Album in current XMMS2 song
2789 <para></para></listitem>
2794 <command><option>xmms2_title</option></command>
2797 Title in current XMMS2 song
2798 <para></para></listitem>
2803 <command><option>xmms2_genre</option></command>
2806 Genre in current XMMS2 song
2807 <para></para></listitem>
2812 <command><option>xmms2_comment</option></command>
2815 Comment in current XMMS2 song
2816 <para></para></listitem>
2821 <command><option>xmms2_url</option></command>
2824 Full path to current song
2825 <para></para></listitem>
2830 <command><option>xmms2_tracknr</option></command>
2833 Track number in current XMMS2 song
2834 <para></para></listitem>
2839 <command><option>xmms2_bitrate</option></command>
2842 Bitrate of current song
2843 <para></para></listitem>
2848 <command><option>xmms2_id</option></command>
2851 XMMS2 id of current song
2852 <para></para></listitem>
2857 <command><option>xmms2_duration</option></command>
2860 Duration of current song
2861 <para></para></listitem>
2866 <command><option>xmms2_elapsed</option></command>
2870 <para></para></listitem>
2875 <command><option>xmms2_size</option></command>
2878 Size of current song
2879 <para></para></listitem>
2884 <command><option>xmms2_percent</option></command>
2887 Percent of song's progress
2888 <para></para></listitem>
2893 <command><option>xmms2_date</option></command>
2896 Returns song's date.
2897 <para></para></listitem>
2902 <command><option>xmms2_playlist</option></command>
2905 Returns the XMMS2 playlist.
2906 <para></para></listitem>
2911 <command><option>xmms2_timesplayed</option></command>
2914 Number of times a song was played (presumably).
2915 <para></para></listitem>
2920 <command><option>xmms2_status</option></command>
2923 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
2924 <para></para></listitem>
2929 <command><option>xmms2_bar</option></command>
2930 <option>(height),(width)</option>
2933 Bar of XMMS2's progress
2934 <para></para></listitem>
2939 <command><option>xmms2_smart</option></command>
2942 Prints the song name in either the form "artist - title" or file name, depending on whats available
2943 <para></para></listitem>
2948 <command><option>if_xmms2_connected</option></command>
2951 Display everything between $if_xmms2_connected and the matching $endif if xmms2 is running.
2952 <para></para></listitem>
2957 <command><option>sony_fanspeed</option></command>
2960 Displays the Sony VAIO fanspeed information if sony-laptop kernel support is enabled. Linux only.
2961 <para></para></listitem>
2966 <command><option>eve</option></command>
2967 <option>api_userid api_key character_id</option>
2970 Fetches your currently training skill from the Eve Online API servers (http://www.eve-online.com/) and displays the skill along with the remaining training time.
2971 <para></para></listitem>
2976 <command><option>endif</option></command>
2981 <para></para></listitem>
2986 <command><option>read_tcp</option></command>
2987 <option>(host) port</option>
2990 Connects to a tcp port on a host (default is localhost), reads every char available at the moment and shows them.
2991 <para></para></listitem>
projects / monky / blob