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>
176 History graph of current load.
177 <para></para></listitem>
182 <command><option>apcupsd_loadgauge</option></command>
183 <option>(height),(width)</option>
186 Gauge that shows current load.
187 <para></para></listitem>
192 <command><option>apcupsd_charge</option></command>
195 Current battery capacity in percent.
196 <para></para></listitem>
201 <command><option>apcupsd_timeleft</option></command>
204 Time left to run on battery.
205 <para></para></listitem>
210 <command><option>apcupsd_temp</option></command>
213 Current internal temperature.
214 <para></para></listitem>
219 <command><option>apcupsd_lastxfer</option></command>
222 Reason for last transfer from line to battery.
223 <para></para></listitem>
228 <command><option>apm_adapter</option></command>
231 Display APM AC adapter status (FreeBSD only)
232 <para></para></listitem>
237 <command><option>apm_battery_life</option></command>
240 Display APM battery life in percent (FreeBSD only)
241 <para></para></listitem>
246 <command><option>apm_battery_time</option></command>
249 Display remaining APM battery life in hh:mm:ss or "unknown" if
250 AC adapterstatus is on-line or charging (FreeBSD only)
251 <para></para></listitem>
256 <command><option>audacious_bar</option></command>
257 <option>(height),(width)</option>
261 <para></para></listitem>
266 <command><option>audacious_bitrate</option></command>
269 Bitrate of current tune
270 <para></para></listitem>
275 <command><option>audacious_channels</option></command>
278 Number of audio channels of current tune
279 <para></para></listitem>
284 <command><option>audacious_filename</option></command>
287 Full path and filename of current tune
288 <para></para></listitem>
293 <command><option>audacious_frequency</option></command>
296 Sampling frequency of current tune
297 <para></para></listitem>
302 <command><option>audacious_length</option></command>
305 Total length of current tune as MM:SS
306 <para></para></listitem>
311 <command><option>audacious_length_seconds</option></command>
314 Total length of current tune in seconds
315 <para></para></listitem>
320 <command><option>audacious_playlist_position</option></command>
323 Playlist position of current tune
324 <para></para></listitem>
329 <command><option>audacious_playlist_length</option></command>
332 Number of tunes in playlist
333 <para></para></listitem>
338 <command><option>audacious_position</option></command>
341 Position of current tune (MM:SS)
342 <para></para></listitem>
347 <command><option>audacious_position_seconds</option></command>
350 Position of current tune in seconds
351 <para></para></listitem>
356 <command><option>audacious_status</option></command>
359 Player status (Playing/Paused/Stopped/Not running)
360 <para></para></listitem>
365 <command><option>audacious_title</option></command>
366 <option>(max length)</option>
369 Title of current tune with optional maximum length specifier
370 <para></para></listitem>
375 <command><option>audacious_main_volume</option></command>
378 The current volume fetched from Audacious
379 <para></para></listitem>
384 <command><option>battery</option></command>
385 <option>(num)</option>
388 Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
389 <para></para></listitem>
394 <command><option>battery_short</option></command>
395 <option>(num)</option>
398 Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
399 This mode display a short status, which means that C is displayed instead of charging and D is displayed instead of discharging.
400 <para></para></listitem>
405 <command><option>battery_bar</option></command>
406 <option>(height),(width) (num)</option>
409 Battery percentage remaining of ACPI battery in a bar. ACPI battery number can be given as argument (default is BAT0).
410 <para></para></listitem>
415 <command><option>battery_percent</option></command>
416 <option>(num)</option>
419 Battery percentage remaining for ACPI battery. ACPI battery number can be given as argument (default is BAT0).
420 <para></para></listitem>
425 <command><option>battery_time</option></command>
426 <option>(num)</option>
429 Battery charge/discharge time remaining of ACPI battery. ACPI battery number can be given as argument (default is BAT0).
430 <para></para></listitem>
435 <command><option>bmpx_artist</option></command>
438 Artist in current BMPx track
439 <para></para></listitem>
444 <command><option>bmpx_album</option></command>
447 Album in current BMPx track
448 <para></para></listitem>
453 <command><option>bmpx_title</option></command>
456 Title of the current BMPx track
457 <para></para></listitem>
462 <command><option>bmpx_track</option></command>
465 Track number of the current BMPx track
466 <para></para></listitem>
471 <command><option>bmpx_bitrate</option></command>
474 Bitrate of the current BMPx track
475 <para></para></listitem>
480 <command><option>bmpx_uri</option></command>
483 URI of the current BMPx track
484 <para></para></listitem>
489 <command><option>buffers</option></command>
492 Amount of memory buffered
493 <para></para></listitem>
498 <command><option>cached</option></command>
501 Amount of memory cached
502 <para></para></listitem>
507 <command><option>color</option></command>
508 <option>(color)</option>
511 Change drawing color to color
512 <para></para></listitem>
516 <term><command><option>colorN</option></command></term>
518 Change drawing color to colorN configuration option, where N is a digit between 0 and 9, inclusively.
519 <para></para></listitem>
524 <command><option>combine</option></command>
525 <option>var1 var2</option>
528 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.
529 <para></para></listitem>
534 <command><option>conky_version</option></command>
538 <para></para></listitem>
543 <command><option>conky_build_date</option></command>
547 <para></para></listitem>
552 <command><option>conky_build_arch</option></command>
555 CPU architecture Conky was built for
556 <para></para></listitem>
561 <command><option>cpu</option></command>
562 <option>(cpuN)</option>
565 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.
566 <para></para></listitem>
571 <command><option>cpubar</option></command>
572 <option>(cpuN) (height),(width)</option>
575 Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
576 <para></para></listitem>
581 <command><option>cpugauge</option></command>
582 <option>(cpuN) (height),(width)</option>
585 Elliptical gauge that shows CPU usage, height and width are gauge's vertical and horizontal axis respectively. See $cpu for more info on SMP.
586 <para></para></listitem>
591 <command><option>cpugraph</option></command>
592 <option>(cpuN) ("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
595 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".
596 <para></para></listitem>
601 <command><option>diskio</option></command>
602 <option>(device)</option>
605 Displays current disk IO. Device is optional, and takes the form of sda for /dev/sda. Individual partitions are allowed.
606 <para></para></listitem>
611 <command><option>diskiograph</option></command>
612 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)</option>
615 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".
616 <para></para></listitem>
621 <command><option>diskio_read</option></command>
622 <option>(device)</option>
625 Displays current disk IO for reads. Device as in diskio.
626 <para></para></listitem>
631 <command><option>diskiograph_read</option></command>
632 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)</option>
635 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".
636 <para></para></listitem>
641 <command><option>diskio_write</option></command>
642 <option>(device)</option>
645 Displays current disk IO for writes. Device as in diskio.
646 <para></para></listitem>
651 <command><option>diskiograph_write</option></command>
652 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)</option>
655 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".
656 <para></para></listitem>
661 <command><option>disk_protect</option></command>
662 <option>device</option>
665 Disk protection status, if supported (needs kernel-patch). Prints either "frozen" or "free " (note the padding).
666 <para></para></listitem>
671 <command><option>downspeed</option></command>
675 Download speed in KiB
676 <para></para></listitem>
681 <command><option>downspeedf</option></command>
685 Download speed in KiB with one decimal
686 <para></para></listitem>
691 <command><option>downspeedgraph</option></command>
692 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (net)</option>
695 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".
696 <para></para></listitem>
701 <command><option>else</option></command>
704 Text to show if any of the above are not true
705 <para></para></listitem>
710 <command><option>entropy_avail</option></command>
713 Current entropy available for crypto freaks
714 <para></para></listitem>
719 <command><option>entropy_bar</option></command>
720 <option>(height),(width)</option>
723 Normalized bar of available entropy for crypto freaks
724 <para></para></listitem>
729 <command><option>entropy_poolsize</option></command>
732 Total size of system entropy pool for crypto freaks
733 <para></para></listitem>
738 <command><option>eval</option></command>
739 <option>string</option>
742 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.
743 <para></para></listitem>
748 <command><option>exec</option></command>
749 <option>command</option>
752 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.
753 <para></para></listitem>
758 <command><option>execbar</option></command>
759 <option>command</option>
762 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.
763 <para></para></listitem>
768 <command><option>execgauge</option></command>
769 <option>command</option>
772 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.
773 <para></para></listitem>
778 <command><option>execgraph</option></command>
779 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) command</option>
782 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.
783 <para></para></listitem>
788 <command><option>execi</option></command>
789 <option>interval command</option>
792 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
793 <para></para></listitem>
798 <command><option>execibar</option></command>
799 <option>interval command</option>
802 Same as execbar, except with an interval
803 <para></para></listitem>
808 <command><option>execigraph</option></command>
809 <option>interval command</option>
812 Same as execgraph, but takes an interval arg and graphs values.
813 <para></para></listitem>
818 <command><option>execigauge</option></command>
819 <option>interval command</option>
822 Same as execgauge, but takes an interval arg and gauges values.
823 <para></para></listitem>
828 <command><option>execp</option></command>
829 <option>command</option>
832 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.
833 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.
834 <para></para></listitem>
839 <command><option>execpi</option></command>
840 <option>interval command</option>
843 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.
844 <para></para></listitem>
849 <command><option>font</option></command>
850 <option>(font)</option>
853 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)
854 <para></para></listitem>
859 <command><option>freq</option></command>
863 Returns CPU #n's frequency in MHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
864 <para></para></listitem>
868 <command><option>freq_g</option></command>
872 Returns CPU #n's frequency in GHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
873 <para></para></listitem>
878 <command><option>fs_bar</option></command>
879 <option>(height),(width) fs</option>
882 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.
883 <para></para></listitem>
888 <command><option>fs_bar_free</option></command>
889 <option>(height),(width) fs</option>
892 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.
893 <para></para></listitem>
898 <command><option>fs_free</option></command>
899 <option>(fs)</option>
902 Free space on a file system available for users.
903 <para></para></listitem>
908 <command><option>fs_free_perc</option></command>
909 <option>(fs)</option>
912 Free percentage of space on a file system available for users.
913 <para></para></listitem>
918 <command><option>fs_size</option></command>
919 <option>(fs)</option>
923 <para></para></listitem>
928 <command><option>fs_type</option></command>
929 <option>(fs)</option>
933 <para></para></listitem>
938 <command><option>fs_used</option></command>
939 <option>(fs)</option>
942 File system used space.
943 <para></para></listitem>
948 <command><option>fs_used_perc</option></command>
949 <option>(fs)</option>
952 Percent of file system used space.
953 <para></para></listitem>
958 <command><option>goto</option></command>
962 The next element will be printed at position 'x'.
963 <para></para></listitem>
968 <command><option>gw_iface</option></command>
971 Displays the default route's interface or "multiple"/"none" accordingly.
972 <para></para></listitem>
977 <command><option>gw_ip</option></command>
980 Displays the default gateway's IP or "multiple"/"none" accordingly.
981 <para></para></listitem>
986 <command><option>hddtemp</option></command>
987 <option>dev, (host,(port))</option>
990 Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
991 Default host is 127.0.0.1, default port is 7634.
992 <para></para></listitem>
997 <command><option>head</option></command>
998 <option>logfile lines (interval)</option>
1001 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.
1002 <para></para></listitem>
1007 <command><option>hr</option></command>
1008 <option>(height)</option>
1011 Horizontal line, height is the height in pixels
1012 <para></para></listitem>
1017 <command><option>hwmon</option></command>
1018 <option>(dev) type n (factor offset)</option>
1021 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).
1022 <para></para></listitem>
1027 <command><option>iconv_start</option></command>
1028 <option>codeset_from codeset_to</option>
1031 Convert text from one codeset to another using GNU iconv. Needs to be stopped with iconv_stop.
1032 <para></para></listitem>
1037 <command><option>iconv_stop</option></command>
1041 Stop iconv codeset conversion.
1042 <para></para></listitem>
1047 <command><option>image</option></command>
1048 <option><path to image> (-p x,y) (-s WxH)</option>
1051 Renders an image from the path specified using IMLIB2. Takes 2 optional arguments, one being a position, the other an size. Changing the x,y position will move the position of the image, and changing the WxH will scale the 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.
1052 <para></para></listitem>
1057 <command><option>i2c</option></command>
1058 <option>(dev) type n (factor offset)</option>
1061 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).
1062 <para></para></listitem>
1067 <command><option>i8k_ac_status</option></command>
1071 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.
1072 <para></para></listitem>
1077 <command><option>i8k_bios</option></command>
1081 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
1082 <para></para></listitem>
1087 <command><option>i8k_buttons_status</option></command>
1091 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
1092 <para></para></listitem>
1097 <command><option>i8k_cpu_temp</option></command>
1101 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
1102 <para></para></listitem>
1107 <command><option>i8k_left_fan_rpm</option></command>
1111 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.
1112 <para></para></listitem>
1117 <command><option>i8k_left_fan_status</option></command>
1121 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.
1122 <para></para></listitem>
1127 <command><option>i8k_right_fan_rpm</option></command>
1131 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.
1132 <para></para></listitem>
1137 <command><option>i8k_right_fan_status</option></command>
1141 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.
1142 <para></para></listitem>
1147 <command><option>i8k_serial</option></command>
1151 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
1152 <para></para></listitem>
1157 <command><option>i8k_version</option></command>
1161 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
1162 <para></para></listitem>
1167 <command><option>ibm_fan</option></command>
1170 If running the IBM ACPI, displays the fan speed.
1171 <para></para></listitem>
1176 <command><option>ibm_temps</option></command>
1180 If running the IBM ACPI, displays the temperatures
1181 from the IBM temperature sensors (N=0..7) Sensor 0 is
1182 on the CPU, 3 is on the GPU.
1183 <para></para></listitem>
1188 <command><option>ibm_volume</option></command>
1191 If running the IBM ACPI, displays the "master" volume,
1192 controlled by the volume keys (0-14).
1193 <para></para></listitem>
1198 <command><option>ibm_brightness</option></command>
1201 If running the IBM ACPI, displays the brigtness of the
1202 laptops's LCD (0-7).
1203 <para></para></listitem>
1208 <command><option>if_empty</option></command>
1209 <option>(var)</option>
1212 if conky variable VAR is empty, display everything
1213 between $if_empty and the matching $endif
1214 <para></para></listitem>
1219 <command><option>if_existing</option></command>
1220 <option>file (string)</option>
1223 if FILE exists, display everything between if_existing
1224 and the matching $endif. The optional second paramater
1225 checks for FILE containing the specified string and
1226 prints everything between $if_existing and the matching
1228 <para></para></listitem>
1233 <command><option>if_gw</option></command>
1236 if there is at least one default gateway, display
1237 everything between $if_gw and the matching $endif
1238 <para></para></listitem>
1243 <command><option>if_match</option></command>
1244 <option>expression</option>
1247 Evaluates the given boolean expression, printing
1248 everything between $if_match and the matching $endif
1249 depending on whether the evaluation returns true or not.
1250 Valid expressions consist of a left side, an operator
1251 and a right side. Left and right sides are being parsed
1252 for contained text objects before evaluation. Recognised
1253 left and right side types are:
1255 <member><command>double</command>:
1256 argument consists of only digits and a
1259 <member><command>long</command>:
1260 argument consists of only digits.
1262 <member><command>string</command>:
1263 argument is enclosed in quotation mark
1264 or the checks for double and long failed
1269 '>', '<', '>=', '<=', '==', '!='.
1270 <para></para></listitem>
1275 <command><option>if_mixer_mute</option></command>
1276 <option>(mixer)</option>
1279 If mixer exists, display everything between $if_mixer_mute and the
1280 matching $endif. If no mixer is specified, "Master" is used.
1281 <para></para></listitem>
1286 <command><option>if_running</option></command>
1287 <option>(process)</option>
1290 if PROCESS is running, display everything $if_running
1291 and the matching $endif. This uses the ``pidof'' command, so the
1292 -x switch is also supported.
1293 <para></para></listitem>
1298 <command><option>if_mounted</option></command>
1299 <option>(mountpoint)</option>
1302 if MOUNTPOINT is mounted, display everything between
1303 $if_mounted and the matching $endif
1304 <para></para></listitem>
1309 <command><option>if_smapi_bat_installed</option></command>
1310 <option>(INDEX)</option>
1313 when using smapi, if the battery with index INDEX is
1314 installed, display everything between
1315 $if_smapi_bat_installed and the matching $endif
1316 <para></para></listitem>
1321 <command><option>if_up</option></command>
1322 <option>(interface)</option>
1325 if INTERFACE exists and is up, display everything between $if_up and the matching $endif
1326 <para></para></listitem>
1331 <command><option>if_updatenr</option></command>
1332 <option>(updatenr)</option>
1335 If it's the UPDATENR-th time that conky updates,
1336 display everything between $if_updatenr and the matching $endif.
1337 The counter resets when the highest UPDATENR is reached.
1338 Example : "{$if_updatenr 1}foo$endif{$if_updatenr 2}bar$endif{$if_updatenr 4}$endif"
1339 shows foo 25% of the time followed by bar 25% of the time followed by nothing the other half of the time.
1340 <para></para></listitem>
1345 <command><option>imap_messages</option></command>
1346 <option>(args)</option>
1349 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.
1350 <para></para></listitem>
1355 <command><option>imap_unseen</option></command>
1356 <option>(args)</option>
1359 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.
1360 <para></para></listitem>
1365 <command><option>ioscheduler</option></command>
1366 <option>disk</option>
1369 Prints the current ioscheduler used for the given disk name (i.e. e.g. "hda" or "sdb")
1370 <para></para></listitem>
1375 <command><option>kernel</option></command>
1379 <para></para></listitem>
1384 <command><option>laptop_mode</option></command>
1387 The value of /proc/sys/vm/laptop_mode
1388 <para></para></listitem>
1393 <command><option>loadavg</option></command>
1396 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
1397 <para></para></listitem>
1402 <command><option>loadgraph</option></command>
1403 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
1406 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".
1407 <para></para></listitem>
1412 <command><option>lines</option></command>
1413 <option>textfile</option>
1416 Displays the number of lines in the given file
1417 <para></para></listitem>
1422 <command><option>machine</option></command>
1425 Machine, i686 for example
1426 <para></para></listitem>
1431 <command><option>mails</option></command>
1432 <option>(mailbox)</option>
1433 <option>(interval)</option>
1436 Mail count in the specified mailbox or your mail spool if not.
1437 Both mbox and maildir type mailboxes are supported. You can
1438 use a program like fetchmail to get mails from some server
1439 using your favourite protocol. See also new_mails.
1440 <para></para></listitem>
1445 <command><option>new_mails</option></command>
1446 <option>(mailbox)</option>
1447 <option>(interval)</option>
1450 Unread mail count in the specified mailbox or mail spool if
1451 not. Both mbox and maildir type mailboxes are supported.
1452 <para></para></listitem>
1457 <command><option>seen_mails</option></command>
1458 <option>(maildir)</option>
1459 <option>(interval)</option>
1462 Number of mails marked as seen in the specified mailbox or mail spool if
1463 not. Only maildir type mailboxes are supported, mbox type will return -1.
1464 <para></para></listitem>
1469 <command><option>unseen_mails</option></command>
1470 <option>(maildir)</option>
1471 <option>(interval)</option>
1474 Number of new or unseen mails in the specified mailbox or mail spool if
1475 not. Only maildir type mailboxes are supported, mbox type will return -1.
1476 <para></para></listitem>
1481 <command><option>flagged_mails</option></command>
1482 <option>(maildir)</option>
1483 <option>(interval)</option>
1486 Number of mails marked as flagged in the specified mailbox or mail spool if
1487 not. Only maildir type mailboxes are supported, mbox type will return -1.
1488 <para></para></listitem>
1493 <command><option>unflagged_mails</option></command>
1494 <option>(maildir)</option>
1495 <option>(interval)</option>
1498 Number of mails not marked as flagged in the specified mailbox or mail spool if
1499 not. Only maildir type mailboxes are supported, mbox type will return -1.
1500 <para></para></listitem>
1505 <command><option>forwarded_mails</option></command>
1506 <option>(maildir)</option>
1507 <option>(interval)</option>
1510 Number of mails marked as forwarded in the specified mailbox or mail spool if
1511 not. Only maildir type mailboxes are supported, mbox type will return -1.
1512 <para></para></listitem>
1517 <command><option>unforwarded_mails</option></command>
1518 <option>(maildir)</option>
1519 <option>(interval)</option>
1522 Number of mails not marked as forwarded in the specified mailbox or mail spool if
1523 not. Only maildir type mailboxes are supported, mbox type will return -1.
1524 <para></para></listitem>
1529 <command><option>replied_mails</option></command>
1530 <option>(maildir)</option>
1531 <option>(interval)</option>
1534 Number of mails marked as replied in the specified mailbox or mail spool if
1535 not. Only maildir type mailboxes are supported, mbox type will return -1.
1536 <para></para></listitem>
1541 <command><option>unreplied_mails</option></command>
1542 <option>(maildir)</option>
1543 <option>(interval)</option>
1546 Number of mails not marked as replied in the specified mailbox or mail spool if
1547 not. Only maildir type mailboxes are supported, mbox type will return -1.
1548 <para></para></listitem>
1553 <command><option>draft_mails</option></command>
1554 <option>(maildir)</option>
1555 <option>(interval)</option>
1558 Number of mails marked as draft in the specified mailbox or mail spool if
1559 not. Only maildir type mailboxes are supported, mbox type will return -1.
1560 <para></para></listitem>
1565 <command><option>trashed_mails</option></command>
1566 <option>(maildir)</option>
1567 <option>(interval)</option>
1570 Number of mails marked as trashed in the specified mailbox or mail spool if
1571 not. Only maildir type mailboxes are supported, mbox type will return -1.
1572 <para></para></listitem>
1577 <command><option>mboxscan</option></command>
1578 <option>(-n number of messages to print) (-fw from width) (-sw subject width) mbox</option>
1581 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"}
1582 <para></para></listitem>
1587 <command><option>mem</option></command>
1590 Amount of memory in use
1591 <para></para></listitem>
1596 <command><option>membar</option></command>
1597 <option>(height),(width)</option>
1600 Bar that shows amount of memory in use
1601 <para></para></listitem>
1606 <command><option>memgauge</option></command>
1607 <option>(height),(width)</option>
1610 Gauge that shows amount of memory in use (see cpugauge)
1611 <para></para></listitem>
1616 <command><option>memgraph</option></command>
1617 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
1620 Memory usage graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
1621 <para></para></listitem>
1626 <command><option>memeasyfree</option></command>
1629 Amount of free memory including the memory that is very easily freed (buffers/cache)
1630 <para></para></listitem>
1635 <command><option>memfree</option></command>
1638 Amount of free memory
1639 <para></para></listitem>
1644 <command><option>memmax</option></command>
1647 Total amount of memory
1648 <para></para></listitem>
1653 <command><option>memperc</option></command>
1656 Percentage of memory in use
1657 <para></para></listitem>
1662 <command><option>mixer</option></command>
1663 <option>(device)</option>
1666 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.
1667 <para></para></listitem>
1672 <command><option>mixerbar</option></command>
1673 <option>(device)</option>
1676 Displays mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
1677 <para></para></listitem>
1682 <command><option>mixerr</option></command>
1683 <option>(device)</option>
1686 Prints the right channel mixer value as reported by the OS. See docs for $mixer for details on arguments.
1687 <para></para></listitem>
1692 <command><option>mixerrbar</option></command>
1693 <option>(device)</option>
1696 Displays the right channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
1697 <para></para></listitem>
1702 <command><option>mixerl</option></command>
1703 <option>(device)</option>
1706 Prints the left channel mixer value as reported by the OS. See docs for $mixer for details on arguments.
1707 <para></para></listitem>
1712 <command><option>mixerlbar</option></command>
1713 <option>(device)</option>
1716 Displays the left channel mixer value in a bar as reported by the OS. See docs for $mixer for details on arguments.
1717 <para></para></listitem>
1722 <command><option>moc_state</option></command>
1725 Current state of MOC; playing, stopped etc.
1726 <para></para></listitem>
1731 <command><option>moc_file</option></command>
1734 File name of the current MOC song
1735 <para></para></listitem>
1740 <command><option>moc_title</option></command>
1743 Title of the current MOC song
1744 <para></para></listitem>
1749 <command><option>moc_artist</option></command>
1752 Artist of the current MOC song
1753 <para></para></listitem>
1758 <command><option>moc_song</option></command>
1761 The current song name being played in MOC.
1762 <para></para></listitem>
1767 <command><option>moc_album</option></command>
1770 Album of the current MOC song
1771 <para></para></listitem>
1776 <command><option>moc_totaltime</option></command>
1779 Total length of the current MOC song
1780 <para></para></listitem>
1785 <command><option>moc_timeleft</option></command>
1788 Time left in the current MOC song
1789 <para></para></listitem>
1794 <command><option>moc_curtime</option></command>
1797 Current time of the current MOC song
1798 <para></para></listitem>
1803 <command><option>moc_bitrate</option></command>
1806 Bitrate in the current MOC song
1807 <para></para></listitem>
1812 <command><option>moc_rate</option></command>
1815 Rate of the current MOC song
1816 <para></para></listitem>
1821 <command><option>monitor</option></command>
1824 Number of the monitor on which conky is running
1825 <para></para></listitem>
1830 <command><option>monitor_number</option></command>
1834 <para></para></listitem>
1839 <command><option>mpd_artist</option></command>
1842 Artist in current MPD song must be enabled at compile
1843 <para></para></listitem>
1848 <command><option>mpd_album</option></command>
1851 Album in current MPD song
1852 <para></para></listitem>
1857 <command><option>mpd_bar</option></command>
1858 <option>(height),(width)</option>
1861 Bar of mpd's progress
1862 <para></para></listitem>
1867 <command><option>mpd_bitrate</option></command>
1870 Bitrate of current song
1871 <para></para></listitem>
1876 <command><option>mpd_status</option></command>
1879 Playing, stopped, et cetera.
1880 <para></para></listitem>
1885 <command><option>mpd_title</option></command>
1886 <option>(max length)</option>
1889 Title of current MPD song
1890 <para></para></listitem>
1895 <command><option>mpd_vol</option></command>
1899 <para></para></listitem>
1904 <command><option>mpd_elapsed</option></command>
1908 <para></para></listitem>
1913 <command><option>mpd_length</option></command>
1917 <para></para></listitem>
1922 <command><option>mpd_percent</option></command>
1925 Percent of song's progress
1926 <para></para></listitem>
1931 <command><option>mpd_random</option></command>
1934 Random status (On/Off)
1935 <para></para></listitem>
1940 <command><option>mpd_repeat</option></command>
1943 Repeat status (On/Off)
1944 <para></para></listitem>
1949 <command><option>mpd_track</option></command>
1952 Prints the MPD track field
1953 <para></para></listitem>
1958 <command><option>mpd_name</option></command>
1961 Prints the MPD name field
1962 <para></para></listitem>
1967 <command><option>mpd_file</option></command>
1970 Prints the file name of the current MPD song
1971 <para></para></listitem>
1976 <command><option>mpd_smart</option></command>
1977 <option>(max length)</option>
1980 Prints the song name in either the form "artist - title" or file name, depending on whats available
1981 <para></para></listitem>
1986 <command><option>if_mpd_playing</option></command>
1989 if mpd is playing or paused, display everything between $if_mpd_playing and the matching $endif
1990 <para></para></listitem>
1995 <command><option>nameserver</option></command>
1996 <option>(index)</option>
1999 Print a nameserver from /etc/resolv.conf. Index starts at and defaults to 0.
2000 <para></para></listitem>
2005 <command><option>nodename</option></command>
2009 <para></para></listitem>
2014 <command><option>nvidia</option></command>
2015 <option>threshold</option>
2016 <option>temp</option>
2017 <option>ambient</option>
2018 <option>gpufreq</option>
2019 <option>memfreq</option>
2020 <option>imagequality</option>
2023 Nvidia graficcard support for the XNVCtrl library.
2024 Each option can be shortened to the least significant part.
2025 Temperatures are printed as float, all other values as integer.
2027 <member><command>threshold</command>:
2028 the thresholdtemperature at which the gpu slows down
2030 <member><command>temp</command>:
2031 gives the gpu current temperature
2033 <member><command>ambient</command>:
2034 gives current air temperature near GPU case
2036 <member><command>gpufreq</command>:
2037 gives the current gpu frequency
2039 <member><command>memfreq</command>:
2040 gives the current mem frequency
2042 <member><command>imagequality</command>:
2043 which imagequality should be choosen by OpenGL applications
2052 <command><option>outlinecolor</option></command>
2053 <option>(color)</option>
2056 Change outline color
2057 <para></para></listitem>
2062 <command><option>pb_battery</option></command>
2063 <option>item</option>
2066 If running on Apple powerbook/ibook, display
2067 information on battery status. The item parameter
2068 specifies, what information to display. Exactly one item
2069 must be specified. Valid items are:
2071 <member><command>status</command>:
2072 Display if battery is fully charged, charging,
2073 discharging or absent (running on AC)
2075 <member><command>percent</command>:
2076 Display charge of battery in percent, if
2077 charging or discharging. Nothing will be
2078 displayed, if battery is fully charged
2081 <member><command>time</command>:
2082 Display the time remaining until the battery
2083 will be fully charged or discharged at current
2084 rate. Nothing is displayed, if battery is
2085 absent or if it's present but fully charged
2086 and not discharging.
2089 <para></para></listitem>
2094 <command><option>platform</option></command>
2095 <option>(dev) type n (factor offset)</option>
2098 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).
2099 <para></para></listitem>
2104 <command><option>pop3_unseen</option></command>
2105 <option>(args)</option>
2108 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.
2110 <para></para></listitem>
2115 <command><option>pop3_used</option></command>
2116 <option>(args)</option>
2119 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.
2121 <para></para></listitem>
2126 <command><option>pre_exec</option></command>
2127 <option>shell command</option>
2130 Executes a shell command one time before conky displays anything and puts output as text.
2131 <para></para></listitem>
2136 <command><option>processes</option></command>
2139 Total processes (sleeping and running)
2140 <para></para></listitem>
2145 <command><option>running_processes</option></command>
2148 Running processes (not sleeping), requires Linux 2.6
2149 <para></para></listitem>
2154 <command><option>scroll</option></command>
2155 <option>length (step) text</option>
2158 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").
2159 <para></para></listitem>
2164 <command><option>shadecolor</option></command>
2165 <option>(color)</option>
2168 Change shading color
2169 <para></para></listitem>
2174 <command><option>smapi</option></command>
2175 <option>(ARGS)</option>
2178 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.
2179 <para></para></listitem>
2184 <command><option>smapi_bat_bar</option></command>
2185 <option>(INDEX),(height),(width)</option>
2188 when using smapi, display the remaining capacity of the battery with index INDEX as a bar.
2189 <para></para></listitem>
2194 <command><option>smapi_bat_perc</option></command>
2195 <option>(INDEX)</option>
2198 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.
2199 <para></para></listitem>
2204 <command><option>smapi_bat_power</option></command>
2205 <option>INDEX</option>
2208 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.
2209 <para></para></listitem>
2214 <command><option>smapi_bat_temp</option></command>
2215 <option>INDEX</option>
2218 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.
2219 <para></para></listitem>
2224 <command><option>stippled_hr</option></command>
2225 <option>(space)</option>
2228 Stippled (dashed) horizontal line
2229 <para></para></listitem>
2234 <command><option>swapbar</option></command>
2235 <option>(height),(width)</option>
2238 Bar that shows amount of swap in use
2239 <para></para></listitem>
2244 <command><option>swap</option></command>
2247 Amount of swap in use
2248 <para></para></listitem>
2253 <command><option>swapmax</option></command>
2256 Total amount of swap
2257 <para></para></listitem>
2262 <command><option>swapperc</option></command>
2265 Percentage of swap in use
2266 <para></para></listitem>
2271 <command><option>sysname</option></command>
2274 System name, Linux for example
2275 <para></para></listitem>
2280 <command><option>tcp_portmon</option></command>
2281 <option>port_begin port_end item (index)</option>
2282 <emphasis>(ip4 only at present)</emphasis>
2285 TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
2287 <member><command>count</command> - total number of connections in the range
2289 <member><command>rip</command> - remote ip address
2291 <member><command>rhost</command> - remote host name
2293 <member><command>rport</command> - remote port number
2295 <member><command>rservice</command> - remote service name from /etc/services
2297 <member><command>lip</command> - local ip address
2299 <member><command>lhost</command> - local host name
2301 <member><command>lport</command> - local port number
2303 <member><command>lservice</command> - local service name from /etc/services
2305 </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.
2307 <member>Examples:</member>
2308 <member><command>${tcp_portmon 6881 6999 count}</command> -
2309 displays the number of connections in the bittorrent port range</member>
2310 <member><command>${tcp_portmon 22 22 rip 0}</command> -
2311 displays the remote host ip of the first sshd connection</member>
2312 <member><command>${tcp_portmon 22 22 rip 9}</command> -
2313 displays the remote host ip of the tenth sshd connection</member>
2314 <member><command>${tcp_portmon 1 1024 rhost 0}</command> -
2315 displays the remote host name of the first connection on a privileged port</member>
2316 <member><command>${tcp_portmon 1 1024 rport 4}</command> -
2317 displays the remote host port of the fifth connection on a privileged port</member>
2318 <member><command>${tcp_portmon 1 65535 lservice 14}</command> -
2319 displays the local service name of the fifteenth connection in the range of all ports</member>
2320 </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.
2326 <command><option>texeci</option></command>
2327 <option>interval command</option>
2330 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.
2331 <para></para></listitem>
2336 <command><option>offset</option></command>
2337 <option>(pixels)</option>
2340 Move text over by N pixels. See also $voffset.
2341 <para></para></listitem>
2346 <command><option>rss</option></command>
2347 <option>url delay_in_minutes action (num_par (spaces_in_front))</option>
2350 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).
2351 <para></para></listitem>
2356 <command><option>lua</option></command>
2357 <option>function_name (function parameters)</option>
2360 Executes a Lua function with given parameters, then prints the returned string. See also 'lua_load' on how to load scripts.
2361 <para></para></listitem>
2366 <command><option>lua_parse</option></command>
2367 <option>function_name (function parameters)</option>
2370 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.
2371 <para></para></listitem>
2376 <command><option>lua_read_parse</option></command>
2377 <option>function_name (conky text)</option>
2380 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.
2381 <para></para></listitem>
2386 <command><option>lua_bar</option></command>
2387 <option>(height, width) function_name (function parameters)</option>
2390 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.
2391 <para></para></listitem>
2396 <command><option>lua_graph</option></command>
2397 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) function_name (function parameters)</option>
2400 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.
2401 <para></para></listitem>
2406 <command><option>lua_gauge</option></command>
2407 <option>(height, width) function_name (function parameters)</option>
2410 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.
2411 <para></para></listitem>
2416 <command><option>tab</option></command>
2417 <option>(width, (start))</option>
2420 Puts a tab of the specified width, starting from column 'start'. The unit is pixels for both arguments.
2421 <para></para></listitem>
2426 <command><option>tail</option></command>
2427 <option>logfile lines (interval)</option>
2430 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.
2431 <para></para></listitem>
2436 <command><option>templateN</option></command>
2437 <option>(arg1)</option>
2438 <option>(arg2)</option>
2439 <option>(arg3 ...)</option>
2442 Evaluate the content of the templateN configuration variable (where N is a value between 0 and 9, inclusively),
2443 applying substitutions as described in the documentation of the corresponding configuration variable.
2444 The number of arguments is optional, but must match the highest referred index in the template. You can use the
2445 same special sequences in each argument as the ones valid for a template definition, e.g. to allow an argument
2446 to contain a whitespace. Also simple nesting of templates is possible this way.
2447 <para></para></listitem>
2449 Here are some examples of template definitions:
2451 <member>template0 $\1\2</member>
2452 <member>template1 \1: ${fs_used \2} / ${fs_size \2}</member>
2453 <member>template2 \1 \2</member>
2455 The following list shows sample usage of the templates defined above,
2456 with the equivalent syntax when not using any template at all:
2460 <row rowsep="1"><entry>using template</entry><entry>same without template</entry></row>
2463 <row><entry>${template0 node name}</entry><entry>$nodename</entry></row>
2464 <row><entry>${template1 root /}</entry><entry>root: ${fs_free /} / ${fs_size /}</entry></row>
2466 <entry><programlisting>${template1 ${template2\ disk\ root} /}</programlisting></entry>
2467 <entry><programlisting>disk root: ${fs_free /} / ${fs_size /}</programlisting></entry>
2472 <para></para></listitem>
2477 <command><option>time</option></command>
2478 <option>(format)</option>
2481 Local time, see man strftime to get more information about format
2482 <para></para></listitem>
2487 <command><option>utime</option></command>
2488 <option>(format)</option>
2491 Display time in UTC (universal coordinate time).
2492 <para></para></listitem>
2497 <command><option>tztime</option></command>
2498 <option>(timezone) (format)</option>
2501 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.
2502 <para></para></listitem>
2507 <command><option>totaldown</option></command>
2508 <option>net</option>
2511 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.
2512 <para></para></listitem>
2517 <command><option>top</option></command>
2518 <option>type, num</option>
2521 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.
2522 <para></para></listitem>
2527 <command><option>top_mem</option></command>
2528 <option>type, num</option>
2531 Same as top, except sorted by mem usage instead of cpu
2532 <para></para></listitem>
2537 <command><option>top_time</option></command>
2538 <option>type, num</option>
2541 Same as top, except sorted by total CPU time instead of current CPU usage
2542 <para></para></listitem>
2547 <command><option>totalup</option></command>
2548 <option>net</option>
2551 Total upload, this one too, may overflow
2552 <para></para></listitem>
2557 <command><option>updates</option></command>
2558 <option>Number of updates</option>
2562 <para></para></listitem>
2567 <command><option>upspeed</option></command>
2568 <option>net</option>
2572 <para></para></listitem>
2577 <command><option>upspeedf</option></command>
2578 <option>net</option>
2581 Upload speed in KiB with one decimal
2582 <para></para></listitem>
2587 <command><option>upspeedgraph</option></command>
2588 <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (net)</option>
2591 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".
2592 <para></para></listitem>
2597 <command><option>uptime</option></command>
2601 <para></para></listitem>
2606 <command><option>uptime_short</option></command>
2609 Uptime in a shorter format
2610 <para></para></listitem>
2615 <command><option>user_number</option></command>
2618 Number of users logged in
2619 <para></para></listitem>
2624 <command><option>user_names</option></command>
2627 Lists the names of the users logged in
2628 <para></para></listitem>
2633 <command><option>user_terms</option></command>
2636 Lists the consoles in use
2637 <para></para></listitem>
2642 <command><option>user_times</option></command>
2645 Lists how long users have been logged in for
2646 <para></para></listitem>
2651 <command><option>voffset</option></command>
2652 <option>(pixels)</option>
2655 Change vertical offset by N pixels. Negative values will cause text to overlap. See also $offset.
2656 <para></para></listitem>
2661 <command><option>voltage_mv</option></command>
2662 <option>(n)</option>
2665 Returns CPU #n's voltage in mV. CPUs are
2666 counted from 1. If omitted, the parameter
2668 <para></para></listitem>
2673 <command><option>voltage_v</option></command>
2674 <option>(n)</option>
2677 Returns CPU #n's voltage in V. CPUs are
2678 counted from 1. If omitted, the parameter
2680 <para></para></listitem>
2685 <command><option>wireless_essid</option></command>
2686 <option>net</option>
2689 Wireless access point ESSID (Linux only)
2690 <para></para></listitem>
2695 <command><option>wireless_mode</option></command>
2696 <option>net</option>
2699 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
2700 <para></para></listitem>
2705 <command><option>wireless_bitrate</option></command>
2706 <option>net</option>
2709 Wireless bitrate (ie 11 Mb/s) (Linux only)
2710 <para></para></listitem>
2715 <command><option>wireless_ap</option></command>
2716 <option>net</option>
2719 Wireless access point MAC address (Linux only)
2720 <para></para></listitem>
2725 <command><option>wireless_link_qual</option></command>
2726 <option>net</option>
2729 Wireless link quality (Linux only)
2730 <para></para></listitem>
2735 <command><option>wireless_link_qual_max</option></command>
2736 <option>net</option>
2739 Wireless link quality maximum value (Linux only)
2740 <para></para></listitem>
2745 <command><option>wireless_link_qual_perc</option></command>
2746 <option>net</option>
2749 Wireless link quality in percents (Linux only)
2750 <para></para></listitem>
2755 <command><option>wireless_link_bar</option></command>
2756 <option>(height), (width) net</option>
2759 Wireless link quality bar (Linux only)
2760 <para></para></listitem>
2765 <command><option>words</option></command>
2766 <option>textfile</option>
2769 Displays the number of words in the given file
2770 <para></para></listitem>
2775 <command><option>xmms2_artist</option></command>
2778 Artist in current XMMS2 song
2779 <para></para></listitem>
2784 <command><option>xmms2_album</option></command>
2787 Album in current XMMS2 song
2788 <para></para></listitem>
2793 <command><option>xmms2_title</option></command>
2796 Title in current XMMS2 song
2797 <para></para></listitem>
2802 <command><option>xmms2_genre</option></command>
2805 Genre in current XMMS2 song
2806 <para></para></listitem>
2811 <command><option>xmms2_comment</option></command>
2814 Comment in current XMMS2 song
2815 <para></para></listitem>
2820 <command><option>xmms2_url</option></command>
2823 Full path to current song
2824 <para></para></listitem>
2829 <command><option>xmms2_tracknr</option></command>
2832 Track number in current XMMS2 song
2833 <para></para></listitem>
2838 <command><option>xmms2_bitrate</option></command>
2841 Bitrate of current song
2842 <para></para></listitem>
2847 <command><option>xmms2_id</option></command>
2850 XMMS2 id of current song
2851 <para></para></listitem>
2856 <command><option>xmms2_duration</option></command>
2859 Duration of current song
2860 <para></para></listitem>
2865 <command><option>xmms2_elapsed</option></command>
2869 <para></para></listitem>
2874 <command><option>xmms2_size</option></command>
2877 Size of current song
2878 <para></para></listitem>
2883 <command><option>xmms2_percent</option></command>
2886 Percent of song's progress
2887 <para></para></listitem>
2892 <command><option>xmms2_date</option></command>
2895 Returns song's date.
2896 <para></para></listitem>
2901 <command><option>xmms2_playlist</option></command>
2904 Returns the XMMS2 playlist.
2905 <para></para></listitem>
2910 <command><option>xmms2_timesplayed</option></command>
2913 Number of times a song was played (presumably).
2914 <para></para></listitem>
2919 <command><option>xmms2_status</option></command>
2922 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
2923 <para></para></listitem>
2928 <command><option>xmms2_bar</option></command>
2929 <option>(height),(width)</option>
2932 Bar of XMMS2's progress
2933 <para></para></listitem>
2938 <command><option>xmms2_smart</option></command>
2941 Prints the song name in either the form "artist - title" or file name, depending on whats available
2942 <para></para></listitem>
2947 <command><option>if_xmms2_connected</option></command>
2950 Display everything between $if_xmms2_connected and the matching $endif if xmms2 is running.
2951 <para></para></listitem>
2956 <command><option>sony_fanspeed</option></command>
2959 Displays the Sony VAIO fanspeed information if sony-laptop kernel support is enabled. Linux only.
2960 <para></para></listitem>
2965 <command><option>eve</option></command>
2966 <option>api_userid api_key character_id</option>
2969 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.
2970 <para></para></listitem>
2975 <command><option>endif</option></command>
2980 <para></para></listitem>
projects / monky / blob