4 <command><option>addr</option></command>
5 <option>interface</option>
8 IP address for an interface
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>acpitempf</option></command>
55 ACPI temperature in F.
56 <para></para></listitem>
61 <command><option>adt746xcpu</option></command>
64 CPU temperature from therm_adt746x
65 <para></para></listitem>
70 <command><option>adt746xfan</option></command>
73 Fan speed from therm_adt746x
74 <para></para></listitem>
79 <command><option>alignr</option></command>
80 <option>(num)</option>
83 Right-justify text, with space of N
84 <para></para></listitem>
89 <command><option>alignc</option></command>
90 <option>(num)</option>
94 <para></para></listitem>
99 <command><option>apm_adapter</option></command>
102 Display APM AC adapter status (FreeBSD only)
103 <para></para></listitem>
108 <command><option>apm_battery_life</option></command>
111 Display APM battery life in percent (FreeBSD only)
112 <para></para></listitem>
117 <command><option>apm_battery_time</option></command>
120 Display remaining APM battery life in hh:mm:ss or "unknown" if
121 AC adapterstatus is on-line or charging (FreeBSD only)
122 <para></para></listitem>
127 <command><option>audacious_bar</option></command>
128 <option>(height),(width)</option>
132 <para></para></listitem>
137 <command><option>audacious_bitrate</option></command>
140 Bitrate of current tune
141 <para></para></listitem>
146 <command><option>audacious_channels</option></command>
149 Number of audio channels of current tune
150 <para></para></listitem>
155 <command><option>audacious_filename</option></command>
158 Full path and filename of current tune
159 <para></para></listitem>
164 <command><option>audacious_frequency</option></command>
167 Sampling frequency of current tune
168 <para></para></listitem>
173 <command><option>audacious_length</option></command>
176 Total length of current tune as MM:SS
177 <para></para></listitem>
182 <command><option>audacious_length_seconds</option></command>
185 Total length of current tune in seconds
186 <para></para></listitem>
191 <command><option>audacious_playlist_position</option></command>
194 Playlist position of current tune
195 <para></para></listitem>
200 <command><option>audacious_playlist_length</option></command>
203 Number of tunes in playlist
204 <para></para></listitem>
209 <command><option>audacious_position</option></command>
212 Position of current tune (MM:SS)
213 <para></para></listitem>
218 <command><option>audacious_position_seconds</option></command>
221 Position of current tune in seconds
222 <para></para></listitem>
227 <command><option>audacious_status</option></command>
230 Player status (Playing/Paused/Stopped/Not running)
231 <para></para></listitem>
236 <command><option>audacious_title</option></command>
237 <option>(max length)</option>
240 Title of current tune with optional maximum length specifier
241 <para></para></listitem>
246 <command><option>battery</option></command>
247 <option>(num)</option>
250 Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
251 <para></para></listitem>
256 <command><option>battery_bar</option></command>
257 <option>(height),(width) (num)</option>
260 Battery percentage remaining of ACPI battery in a bar. ACPI battery number can be given as argument (default is BAT0).
261 <para></para></listitem>
266 <command><option>battery_percent</option></command>
267 <option>(num)</option>
270 Battery percentage remaining for ACPI battery. ACPI battery number can be given as argument (default is BAT0).
271 <para></para></listitem>
276 <command><option>battery_time</option></command>
277 <option>(num)</option>
280 Battery charge/discharge time remaining of ACPI battery. ACPI battery number can be given as argument (default is BAT0).
281 <para></para></listitem>
286 <command><option>bmpx_artist</option></command>
289 Artist in current BMPx track
290 <para></para></listitem>
295 <command><option>bmpx_album</option></command>
298 Album in current BMPx track
299 <para></para></listitem>
304 <command><option>bmpx_title</option></command>
307 Title of the current BMPx track
308 <para></para></listitem>
313 <command><option>bmpx_track</option></command>
316 Track number of the current BMPx track
317 <para></para></listitem>
322 <command><option>bmpx_bitrate</option></command>
325 Bitrate of the current BMPx track
326 <para></para></listitem>
331 <command><option>bmpx_uri</option></command>
334 URI of the current BMPx track
335 <para></para></listitem>
340 <command><option>buffers</option></command>
343 Amount of memory buffered
344 <para></para></listitem>
349 <command><option>cached</option></command>
352 Amount of memory cached
353 <para></para></listitem>
358 <command><option>color</option></command>
359 <option>(color)</option>
362 Change drawing color to color
363 <para></para></listitem>
367 <term><command><option>colorN</option></command></term>
369 Change drawing color to colorN configuration option, where N is a digit between 0 and 9, inclusively.
370 <para></para></listitem>
375 <command><option>conky_version</option></command>
379 <para></para></listitem>
384 <command><option>conky_build_date</option></command>
388 <para></para></listitem>
393 <command><option>conky_bulid_arch</option></command>
396 CPU architecture Conky was built for
397 <para></para></listitem>
402 <command><option>cpu</option></command>
403 <option>(cpuN)</option>
406 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.
407 <para></para></listitem>
412 <command><option>cpubar</option></command>
413 <option>(cpu number) (height),(width)</option>
416 Bar that shows CPU usage, height is bar's height in pixels. See $cpu for more info on SMP.
417 <para></para></listitem>
422 <command><option>cpugraph</option></command>
423 <option>(cpu number) (height),(width) (gradient colour 1) (gradient colour 2)</option>
426 CPU usage graph, with optional colours in hex, minus the #. See $cpu for more info on SMP.
427 <para></para></listitem>
432 <command><option>diskio</option></command>
433 <option>(device)</option>
436 Displays current disk IO. Device is optional, and takes the form of sda for /dev/sda. Individual partitions are allowed.
437 <para></para></listitem>
442 <command><option>diskiograph</option></command>
443 <option>(device) (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
446 Disk IO graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
447 <para></para></listitem>
452 <command><option>diskio_read</option></command>
453 <option>(device)</option>
456 Displays current disk IO for reads. Device as in diskio.
457 <para></para></listitem>
462 <command><option>diskiograph_read</option></command>
463 <option>(device) (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
466 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.
467 <para></para></listitem>
472 <command><option>diskio_write</option></command>
473 <option>(device)</option>
476 Displays current disk IO for writes. Device as in diskio.
477 <para></para></listitem>
482 <command><option>diskiograph_write</option></command>
483 <option>(device) (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
486 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.
487 <para></para></listitem>
492 <command><option>disk_protect</option></command>
493 <option>device</option>
496 Disk protection status, if supported (needs kernel-patch). Prints either "frozen" or "free " (note the padding).
497 <para></para></listitem>
502 <command><option>downspeed</option></command>
506 Download speed in KiB
507 <para></para></listitem>
512 <command><option>downspeedf</option></command>
516 Download speed in KiB with one decimal
517 <para></para></listitem>
522 <command><option>downspeedgraph</option></command>
523 <option>net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
526 Download speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
527 <para></para></listitem>
532 <command><option>else</option></command>
535 Text to show if any of the above are not true
536 <para></para></listitem>
541 <command><option>entropy_avail</option></command>
544 Current entropy available for crypto freaks
545 <para></para></listitem>
550 <command><option>entropy_bar</option></command>
551 <option>(height),(width)</option>
554 Normalized bar of available entropy for crypto freaks
555 <para></para></listitem>
560 <command><option>entropy_poolsize</option></command>
563 Total size of system entropy pool for crypto freaks
564 <para></para></listitem>
569 <command><option>exec</option></command>
570 <option>command</option>
573 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.
574 <para></para></listitem>
579 <command><option>execbar</option></command>
580 <option>command</option>
583 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 the bar is currently fixed, but that may change in the future.
584 <para></para></listitem>
589 <command><option>execgraph</option></command>
590 <option>command</option>
593 Same as execbar, but graphs values.
594 <para></para></listitem>
599 <command><option>execi</option></command>
600 <option>interval command</option>
603 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
604 <para></para></listitem>
609 <command><option>execibar</option></command>
610 <option>interval command</option>
613 Same as execbar, except with an interval
614 <para></para></listitem>
619 <command><option>execigraph</option></command>
620 <option>interval command</option>
623 Same as execgraph, but takes an interval arg graphs values
624 <para></para></listitem>
629 <command><option>execp</option></command>
630 <option>command</option>
633 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.
634 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.
635 <para></para></listitem>
640 <command><option>execpi</option></command>
641 <option>interval command</option>
644 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.
645 <para></para></listitem>
650 <command><option>font</option></command>
651 <option>(font)</option>
654 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)
655 <para></para></listitem>
660 <command><option>freq</option></command>
664 Returns CPU #n's frequency in MHz. CPUs are
665 counted from 1. If omitted, the parameter
667 <para></para></listitem>
671 <command><option>freq_g</option></command>
675 Returns CPU #n's frequency in GHz. CPUs are
676 counted from 1. If omitted, the parameter
678 <para></para></listitem>
683 <command><option>freq_dyn</option></command>
686 Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
687 <para></para></listitem>
692 <command><option>freq_dyn_g</option></command>
695 Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction. Only available for x86/amd64.
696 <para></para></listitem>
701 <command><option>fs_bar</option></command>
702 <option>(height),(width) fs</option>
705 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.
706 <para></para></listitem>
711 <command><option>fs_free</option></command>
712 <option>(fs)</option>
715 Free space on a file system available for users.
716 <para></para></listitem>
721 <command><option>fs_free_perc</option></command>
722 <option>(fs)</option>
725 Free percentage of space on a file system available for users.
726 <para></para></listitem>
731 <command><option>fs_size</option></command>
732 <option>(fs)</option>
736 <para></para></listitem>
741 <command><option>fs_type</option></command>
742 <option>(fs)</option>
746 <para></para></listitem>
751 <command><option>fs_used</option></command>
752 <option>(fs)</option>
755 File system used space
756 <para></para></listitem>
761 <command><option>goto</option></command>
765 The next element will be printed at position 'x'.
766 <para></para></listitem>
771 <command><option>gw_iface</option></command>
774 Displays the default route's interface or "multiple"/"none" accordingly.
775 <para></para></listitem>
780 <command><option>gw_ip</option></command>
783 Displays the default gateway's IP or "multiple"/"none" accordingly.
784 <para></para></listitem>
789 <command><option>hddtemp</option></command>
790 <option>dev, (host,(port))</option>
793 Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
794 Default host is 127.0.0.1, default port is 7634.
795 <para></para></listitem>
800 <command><option>head</option></command>
801 <option>logfile lines (interval)</option>
804 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.
805 <para></para></listitem>
810 <command><option>hr</option></command>
811 <option>(height)</option>
814 Horizontal line, height is the height in pixels
815 <para></para></listitem>
820 <command><option>hwmon</option></command>
821 <option>(dev) type n</option>
824 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' (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n is number of the sensor. See /sys/class/hwmon/ on your local computer.
825 <para></para></listitem>
830 <command><option>iconv_start</option></command>
831 <option>codeset_from codeset_to</option>
834 Convert text from one codeset to another using GNU iconv. Needs to be stopped with iconv_stop.
835 <para></para></listitem>
840 <command><option>iconv_stop</option></command>
844 Stop iconv codeset conversion.
845 <para></para></listitem>
850 <command><option>i2c</option></command>
851 <option>(dev) type n</option>
854 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' (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n is number of the sensor. See /sys/bus/i2c/devices/ on your local computer.
855 <para></para></listitem>
860 <command><option>i8k_ac_status</option></command>
864 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.
865 <para></para></listitem>
870 <command><option>i8k_bios</option></command>
874 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
875 <para></para></listitem>
880 <command><option>i8k_buttons_status</option></command>
884 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
885 <para></para></listitem>
890 <command><option>i8k_cpu_temp</option></command>
894 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
895 <para></para></listitem>
900 <command><option>i8k_cpu_tempf</option></command>
904 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Fahrenheit, as reported by /proc/i8k.
905 <para></para></listitem>
910 <command><option>i8k_left_fan_rpm</option></command>
914 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.
915 <para></para></listitem>
920 <command><option>i8k_left_fan_status</option></command>
924 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.
925 <para></para></listitem>
930 <command><option>i8k_right_fan_rpm</option></command>
934 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.
935 <para></para></listitem>
940 <command><option>i8k_right_fan_status</option></command>
944 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.
945 <para></para></listitem>
950 <command><option>i8k_serial</option></command>
954 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
955 <para></para></listitem>
960 <command><option>i8k_version</option></command>
964 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
965 <para></para></listitem>
970 <command><option>ibm_fan</option></command>
973 If running the IBM ACPI, displays the fan speed.
974 <para></para></listitem>
979 <command><option>ibm_temps</option></command>
983 If running the IBM ACPI, displays the temperatures
984 from the IBM temperature sensors (N=0..7) Sensor 0 is
985 on the CPU, 3 is on the GPU.
986 <para></para></listitem>
991 <command><option>ibm_volume</option></command>
994 If running the IBM ACPI, displays the "master" volume,
995 controlled by the volume keys (0-14).
996 <para></para></listitem>
1001 <command><option>ibm_brightness</option></command>
1004 If running the IBM ACPI, displays the brigtness of the
1005 laptops's LCD (0-7).
1006 <para></para></listitem>
1011 <command><option>if_empty</option></command>
1012 <option>(var)</option>
1015 if conky variable VAR is empty, display everything between $if_empty and the matching $endif
1016 <para></para></listitem>
1021 <command><option>if_gw</option></command>
1024 if there is at least one default gateway, display everything between $if_gw and the matching $endif
1025 <para></para></listitem>
1030 <command><option>if_running</option></command>
1031 <option>(process)</option>
1034 if PROCESS is running, display everything $if_running and the matching $endif
1035 <para></para></listitem>
1040 <command><option>if_existing</option></command>
1041 <option>file (string)</option>
1044 if FILE exists, display everything between if_existing and the matching $endif. The optional second paramater checks for FILE containing the specified string and prints everything between $if_existing and the matching $endif.
1045 <para></para></listitem>
1050 <command><option>if_mounted</option></command>
1051 <option>(mountpoint)</option>
1054 if MOUNTPOINT is mounted, display everything between $if_mounted and the matching $endif
1055 <para></para></listitem>
1060 <command><option>if_smapi_bat_installed</option></command>
1061 <option>(INDEX)</option>
1064 when using smapi, if the battery with index INDEX is installed, display everything between $if_smapi_bat_installed and the matching $endif
1065 <para></para></listitem>
1070 <command><option>if_up</option></command>
1071 <option>(interface)</option>
1074 if INTERFACE exists and is up, display everything between $if_up and the matching $endif
1075 <para></para></listitem>
1080 <command><option>imap_messages</option></command>
1081 <option>(args)</option>
1084 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] [-p port] [-e command]". Default port is 143, default interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1085 <para></para></listitem>
1090 <command><option>imap_unseen</option></command>
1091 <option>(args)</option>
1094 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] [-p port] [-e command]". Default port is 143, default interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1095 <para></para></listitem>
1100 <command><option>ioscheduler</option></command>
1101 <option>disk</option>
1104 Prints the current ioscheduler used for the given disk name (i.e. e.g. "hda" or "sdb")
1105 <para></para></listitem>
1110 <command><option>kernel</option></command>
1114 <para></para></listitem>
1119 <command><option>laptop_mode</option></command>
1122 The value of /proc/sys/vm/laptop_mode
1123 <para></para></listitem>
1128 <command><option>loadavg</option></command>
1131 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
1132 <para></para></listitem>
1137 <command><option>loadgraph</option></command>
1138 <option>(height),(width) (gradient colour 1) (gradient colour 2)</option>
1141 Load1 average graph, similar to xload, with optional colours in hex, minus the #.
1142 <para></para></listitem>
1147 <command><option>machine</option></command>
1150 Machine, i686 for example
1151 <para></para></listitem>
1156 <command><option>mails</option></command>
1157 <option>(mailbox)</option>
1158 <option>(interval)</option>
1161 Mail count in the specified mailbox or your mail spool if not.
1162 Both mbox and maildir type mailboxes are supported. You can
1163 use a program like fetchmail to get mails from some server
1164 using your favourite protocol. See also new_mails.
1165 <para></para></listitem>
1170 <command><option>mboxscan</option></command>
1171 <option>(-n number of messages to print) (-fw from width) (-sw subject width) mbox</option>
1174 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"}
1175 <para></para></listitem>
1180 <command><option>mem</option></command>
1183 Amount of memory in use
1184 <para></para></listitem>
1189 <command><option>membar</option></command>
1190 <option>(height),(width)</option>
1193 Bar that shows amount of memory in use
1194 <para></para></listitem>
1199 <command><option>memgraph</option></command>
1200 <option>(height),(width) (gradient colour 1) (gradient colour 2)</option>
1204 <para></para></listitem>
1209 <command><option>memmax</option></command>
1212 Total amount of memory
1213 <para></para></listitem>
1218 <command><option>memperc</option></command>
1221 Percentage of memory in use
1222 <para></para></listitem>
1227 <command><option>mpd_artist</option></command>
1230 Artist in current MPD song must be enabled at compile
1231 <para></para></listitem>
1236 <command><option>mpd_album</option></command>
1239 Album in current MPD song
1240 <para></para></listitem>
1245 <command><option>mpd_bar</option></command>
1246 <option>(height),(width)</option>
1249 Bar of mpd's progress
1250 <para></para></listitem>
1255 <command><option>mpd_bitrate</option></command>
1258 Bitrate of current song
1259 <para></para></listitem>
1264 <command><option>mpd_status</option></command>
1267 Playing, stopped, et cetera.
1268 <para></para></listitem>
1273 <command><option>mpd_title</option></command>
1274 <option>(max length)</option>
1277 Title of current MPD song
1278 <para></para></listitem>
1283 <command><option>mpd_vol</option></command>
1287 <para></para></listitem>
1292 <command><option>mpd_elapsed</option></command>
1296 <para></para></listitem>
1301 <command><option>mpd_length</option></command>
1305 <para></para></listitem>
1310 <command><option>mpd_percent</option></command>
1313 Percent of song's progress
1314 <para></para></listitem>
1319 <command><option>mpd_random</option></command>
1322 Random status (On/Off)
1323 <para></para></listitem>
1328 <command><option>mpd_repeat</option></command>
1331 Repeat status (On/Off)
1332 <para></para></listitem>
1337 <command><option>mpd_track</option></command>
1340 Prints the MPD track field
1341 <para></para></listitem>
1346 <command><option>mpd_name</option></command>
1349 Prints the MPD name field
1350 <para></para></listitem>
1355 <command><option>mpd_file</option></command>
1358 Prints the file name of the current MPD song
1359 <para></para></listitem>
1364 <command><option>mpd_smart</option></command>
1367 Prints the song name in either the form "artist - title" or file name, depending on whats available
1368 <para></para></listitem>
1373 <command><option>nameserver</option></command>
1374 <option>(index)</option>
1377 Print a nameserver from /etc/resolv.conf. Index starts at and defaults to 0.
1378 <para></para></listitem>
1383 <command><option>new_mails</option></command>
1384 <option>(mailbox)</option>
1385 <option>(interval)</option>
1388 Unread mail count in the specified mailbox or mail spool if
1389 not. Both mbox and maildir type mailboxes are supported.
1390 <para></para></listitem>
1395 <command><option>nodename</option></command>
1399 <para></para></listitem>
1404 <command><option>nvidia</option></command>
1405 <option>threshold</option>
1406 <option>temp</option>
1407 <option>gpufreq</option>
1408 <option>memfreq</option>
1409 <option>imagequality</option>
1412 Nvidia graficcard support for the XNVCtrl library.
1413 Each option gives back one integer value:
1414 (threshold): the thresholdtemperature at which the gpu slows down
1415 (temp): gives the gpu current temperature
1416 (gpufreq): gives the current gpu frequency
1417 (memfreq): gives the current mem frequency
1418 (imagequality): which imagequality should be choosen by OpenGL applications
1425 <command><option>outlinecolor</option></command>
1426 <option>(color)</option>
1429 Change outline color
1430 <para></para></listitem>
1435 <command><option>pb_battery</option></command>
1436 <option>item</option>
1439 If running on Apple powerbook/ibook, display
1440 information on battery status. The item parameter
1441 specifies, what information to display. Exactly one item
1442 must be specified. Valid items are:
1444 <member><command>status</command>:
1445 Display if battery is fully charged, charging,
1446 discharging or absent (running on AC)
1448 <member><command>percent</command>:
1449 Display charge of battery in percent, if
1450 charging or discharging. Nothing will be
1451 displayed, if battery is fully charged
1454 <member><command>time</command>:
1455 Display the time remaining until the battery
1456 will be fully charged or discharged at current
1457 rate. Nothing is displayed, if battery is
1458 absent or if it's present but fully charged
1459 and not discharging.
1462 <para></para></listitem>
1467 <command><option>platform</option></command>
1468 <option>(dev) type n</option>
1471 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' (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n is number of the sensor. See /sys/bus/platform/devices/ on your local computer.
1472 <para></para></listitem>
1477 <command><option>pop3_unseen</option></command>
1478 <option>(args)</option>
1481 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] [-p port] [-e command]". Default port is 110, default interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1483 <para></para></listitem>
1488 <command><option>pop3_used</option></command>
1489 <option>(args)</option>
1492 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] [-p port] [-e command]". Default port is 110, default interval is 5 minutes. If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1494 <para></para></listitem>
1499 <command><option>pre_exec</option></command>
1500 <option>shell command</option>
1503 Executes a shell command one time before conky displays anything and puts output as text.
1504 <para></para></listitem>
1509 <command><option>processes</option></command>
1512 Total processes (sleeping and running)
1513 <para></para></listitem>
1518 <command><option>running_processes</option></command>
1521 Running processes (not sleeping), requires Linux 2.6
1522 <para></para></listitem>
1527 <command><option>shadecolor</option></command>
1528 <option>(color)</option>
1531 Change shading color
1532 <para></para></listitem>
1537 <command><option>smapi</option></command>
1538 <option>(ARGS)</option>
1541 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.
1542 <para></para></listitem>
1547 <command><option>smapi_bat_perc</option></command>
1548 <option>(INDEX)</option>
1551 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.
1552 <para></para></listitem>
1557 <command><option>smapi_bat_bar</option></command>
1558 <option>(INDEX),(height),(width)</option>
1561 when using smapi, display the remaining capacity of the battery with index INDEX as a bar.
1562 <para></para></listitem>
1567 <command><option>stippled_hr</option></command>
1568 <option>(space)</option>
1571 Stippled (dashed) horizontal line
1572 <para></para></listitem>
1577 <command><option>swapbar</option></command>
1578 <option>(height),(width)</option>
1581 Bar that shows amount of swap in use
1582 <para></para></listitem>
1587 <command><option>swap</option></command>
1590 Amount of swap in use
1591 <para></para></listitem>
1596 <command><option>swapmax</option></command>
1599 Total amount of swap
1600 <para></para></listitem>
1605 <command><option>swapperc</option></command>
1608 Percentage of swap in use
1609 <para></para></listitem>
1614 <command><option>sysname</option></command>
1617 System name, Linux for example
1618 <para></para></listitem>
1623 <command><option>tcp_portmon</option></command>
1624 <option>port_begin port_end item (index)</option>
1625 <emphasis>(ip4 only at present)</emphasis>
1628 TCP port monitor for specified local ports. Port numbers must be in the range 1 to 65535. Valid items are:
1630 <member><command>count</command> - total number of connections in the range
1632 <member><command>rip</command> - remote ip address
1634 <member><command>rhost</command> - remote host name
1636 <member><command>rport</command> - remote port number
1638 <member><command>rservice</command> - remote service name from /etc/services
1640 <member><command>lip</command> - local ip address
1642 <member><command>lhost</command> - local host name
1644 <member><command>lport</command> - local port number
1646 <member><command>lservice</command> - local service name from /etc/services
1648 </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.
1650 <member>Examples:</member>
1651 <member><command>${tcp_portmon 6881 6999 count}</command> -
1652 displays the number of connections in the bittorrent port range</member>
1653 <member><command>${tcp_portmon 22 22 rip 0}</command> -
1654 displays the remote host ip of the first sshd connection</member>
1655 <member><command>${tcp_portmon 22 22 rip 9}</command> -
1656 displays the remote host ip of the tenth sshd connection</member>
1657 <member><command>${tcp_portmon 1 1024 rhost 0}</command> -
1658 displays the remote host name of the first connection on a privileged port</member>
1659 <member><command>${tcp_portmon 1 1024 rport 4}</command> -
1660 displays the remote host port of the fifth connection on a privileged port</member>
1661 <member><command>${tcp_portmon 1 65535 lservice 14}</command> -
1662 displays the local service name of the fifteenth connection in the range of all ports</member>
1663 </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.
1669 <command><option>texeci</option></command>
1670 <option>interval command</option>
1673 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.
1674 <para></para></listitem>
1679 <command><option>offset</option></command>
1680 <option>(pixels)</option>
1683 Move text over by N pixels. See also $voffset.
1684 <para></para></listitem>
1689 <command><option>rss</option></command>
1690 <option>url delay_in_minutes action item_num</option>
1693 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.
1694 <para></para></listitem>
1699 <command><option>tab</option></command>
1700 <option>(width, (start))</option>
1703 Puts a tab of the specified width, starting from column 'start'.
1704 <para></para></listitem>
1709 <command><option>tail</option></command>
1710 <option>logfile lines (interval)</option>
1713 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.
1714 <para></para></listitem>
1719 <command><option>time</option></command>
1720 <option>(format)</option>
1723 Local time, see man strftime to get more information about format
1724 <para></para></listitem>
1729 <command><option>utime</option></command>
1730 <option>(format)</option>
1733 Display time in UTC (universal coordinate time).
1734 <para></para></listitem>
1739 <command><option>tztime</option></command>
1740 <option>(timezone) (format)</option>
1743 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.
1744 <para></para></listitem>
1749 <command><option>totaldown</option></command>
1750 <option>net</option>
1753 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.
1754 <para></para></listitem>
1759 <command><option>top</option></command>
1760 <option>type, num</option>
1763 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.
1764 <para></para></listitem>
1769 <command><option>top_mem</option></command>
1770 <option>type, num</option>
1773 Same as top, except sorted by mem usage instead of cpu
1774 <para></para></listitem>
1779 <command><option>totalup</option></command>
1780 <option>net</option>
1783 Total upload, this one too, may overflow
1784 <para></para></listitem>
1789 <command><option>updates</option></command>
1790 <option>Number of updates</option>
1794 <para></para></listitem>
1799 <command><option>upspeed</option></command>
1800 <option>net</option>
1804 <para></para></listitem>
1809 <command><option>upspeedf</option></command>
1810 <option>net</option>
1813 Upload speed in KiB with one decimal
1814 <para></para></listitem>
1819 <command><option>upspeedgraph</option></command>
1820 <option>net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
1823 Upload speed graph, colours defined in hex, minus the #. If scale is non-zero, it becomes the scale for the graph.
1824 <para></para></listitem>
1829 <command><option>uptime</option></command>
1833 <para></para></listitem>
1838 <command><option>uptime_short</option></command>
1841 Uptime in a shorter format
1842 <para></para></listitem>
1847 <command><option>user_number</option></command>
1850 Number of users logged in
1851 <para></para></listitem>
1856 <command><option>user_names</option></command>
1859 Lists the names of the users logged in
1860 <para></para></listitem>
1865 <command><option>user_terms</option></command>
1868 Lists the consoles in use
1869 <para></para></listitem>
1874 <command><option>user_times</option></command>
1877 Lists how long users have been logged in for
1878 <para></para></listitem>
1883 <command><option>voffset</option></command>
1884 <option>(pixels)</option>
1887 Change vertical offset by N pixels. Negative values will cause text to overlap. See also $offset.
1888 <para></para></listitem>
1893 <command><option>voltage_mv</option></command>
1894 <option>(n)</option>
1897 Returns CPU #n's voltage in mV. CPUs are
1898 counted from 1. If omitted, the parameter
1900 <para></para></listitem>
1905 <command><option>voltage_v</option></command>
1906 <option>(n)</option>
1909 Returns CPU #n's voltage in V. CPUs are
1910 counted from 1. If omitted, the parameter
1912 <para></para></listitem>
1917 <command><option>wireless_essid</option></command>
1918 <option>net</option>
1921 Wireless access point ESSID (Linux only)
1922 <para></para></listitem>
1927 <command><option>wireless_mode</option></command>
1928 <option>net</option>
1931 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1932 <para></para></listitem>
1937 <command><option>wireless_bitrate</option></command>
1938 <option>net</option>
1941 Wireless bitrate (ie 11 Mb/s) (Linux only)
1942 <para></para></listitem>
1947 <command><option>wireless_ap</option></command>
1948 <option>net</option>
1951 Wireless access point MAC address (Linux only)
1952 <para></para></listitem>
1957 <command><option>wireless_link_qual</option></command>
1958 <option>net</option>
1961 Wireless link quality (Linux only)
1962 <para></para></listitem>
1967 <command><option>wireless_link_qual_max</option></command>
1968 <option>net</option>
1971 Wireless link quality maximum value (Linux only)
1972 <para></para></listitem>
1977 <command><option>wireless_link_qual_perc</option></command>
1978 <option>net</option>
1981 Wireless link quality in percents (Linux only)
1982 <para></para></listitem>
1987 <command><option>wireless_link_bar</option></command>
1988 <option>(height), (width) net</option>
1991 Wireless link quality bar (Linux only)
1992 <para></para></listitem>
1997 <command><option>xmms2_artist</option></command>
2000 Artist in current XMMS2 song
2001 <para></para></listitem>
2006 <command><option>xmms2_album</option></command>
2009 Album in current XMMS2 song
2010 <para></para></listitem>
2015 <command><option>xmms2_title</option></command>
2018 Title in current XMMS2 song
2019 <para></para></listitem>
2024 <command><option>xmms2_genre</option></command>
2027 Genre in current XMMS2 song
2028 <para></para></listitem>
2033 <command><option>xmms2_comment</option></command>
2036 Comment in current XMMS2 song
2037 <para></para></listitem>
2042 <command><option>xmms2_decoder</option></command>
2046 <para></para></listitem>
2051 <command><option>xmms2_transport</option></command>
2054 Transport plugin used
2055 <para></para></listitem>
2060 <command><option>xmms2_url</option></command>
2063 Full path to current song
2064 <para></para></listitem>
2069 <command><option>xmms2_tracknr</option></command>
2072 Track number in current XMMS2 song
2073 <para></para></listitem>
2078 <command><option>xmms2_bitrate</option></command>
2081 Bitrate of current song
2082 <para></para></listitem>
2087 <command><option>xmms2_id</option></command>
2090 XMMS2 id of current song
2091 <para></para></listitem>
2096 <command><option>xmms2_duration</option></command>
2099 Duration of current song
2100 <para></para></listitem>
2105 <command><option>xmms2_elapsed</option></command>
2109 <para></para></listitem>
2114 <command><option>xmms2_size</option></command>
2117 Size of current song
2118 <para></para></listitem>
2123 <command><option>xmms2_percent</option></command>
2126 Percent of song's progress
2127 <para></para></listitem>
2132 <command><option>xmms2_status</option></command>
2135 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
2136 <para></para></listitem>
2141 <command><option>xmms2_bar</option></command>
2142 <option>(height),(width)</option>
2145 Bar of XMMS2's progress
2146 <para></para></listitem>
2151 <command><option>xmms2_smart</option></command>
2154 Prints the song name in either the form "artist - title" or file name, depending on whats available
2155 <para></para></listitem>