81c5e8818e2c59107dcf9fa9feb6490b2455d882
[monky] / doc / variables.xml
1 <variablelist>
2 <varlistentry>
3         <term>
4                 <command><option>addr</option></command>
5         <option>interface</option>
6         </term>
7         <listitem>
8                 IP address for an interface
9         <para></para></listitem>
10 </varlistentry>
11
12 <varlistentry>
13         <term>
14                 <command><option>acpiacadapter</option></command>
15         </term>
16         <listitem>
17                 ACPI ac adapter state.
18         <para></para></listitem>
19 </varlistentry>
20
21 <varlistentry>
22         <term>
23                 <command><option>acpifan</option></command>
24         </term>
25         <listitem>
26                 ACPI fan state
27         <para></para></listitem>
28 </varlistentry>
29
30 <varlistentry>
31         <term>
32                 <command><option>acpitemp</option></command>
33         </term>
34         <listitem>
35                 ACPI temperature in C.
36                 <para></para></listitem>
37 </varlistentry>
38
39 <varlistentry>
40         <term>
41                 <command><option>acpitempf</option></command>
42         </term>
43         <listitem>
44                 ACPI temperature in F.
45                 <para></para></listitem>
46 </varlistentry>
47
48 <varlistentry>
49         <term>
50                 <command><option>adt746xcpu</option></command>
51         </term>
52         <listitem>
53                 CPU temperature from therm_adt746x
54         <para></para></listitem>
55 </varlistentry>
56
57 <varlistentry>
58         <term>
59                 <command><option>adt746xfan</option></command>
60         </term>
61         <listitem>
62                 Fan speed from therm_adt746x
63         <para></para></listitem>
64 </varlistentry>
65
66 <varlistentry>
67         <term>
68                 <command><option>alignr</option></command>
69         <option>(num)</option>
70         </term>
71         <listitem>
72                 Right-justify text, with space of N
73         <para></para></listitem>
74 </varlistentry>
75
76 <varlistentry>
77         <term>
78                 <command><option>alignc</option></command>
79         <option>(num)</option>
80         </term>
81         <listitem>
82                 Align text to centre
83         <para></para></listitem>
84 </varlistentry>
85
86 <varlistentry>
87         <term>
88                 <command><option>apm_adapter</option></command>
89         </term>
90         <listitem>
91                 Display APM AC adapter status (FreeBSD only)
92         <para></para></listitem>
93 </varlistentry>
94
95 <varlistentry>
96         <term>
97                 <command><option>apm_battery_life</option></command>
98         </term>
99         <listitem>
100                 Display APM battery life in percent (FreeBSD only)
101         <para></para></listitem>
102 </varlistentry>
103
104 <varlistentry>
105         <term>
106                 <command><option>apm_battery_time</option></command>
107         </term>
108         <listitem>
109                 Display remaining APM battery life in hh:mm:ss or "unknown" if
110                 AC adapterstatus is on-line or charging (FreeBSD only)
111         <para></para></listitem>
112 </varlistentry>
113
114 <varlistentry>
115         <term>
116                 <command><option>audacious_bar</option></command>
117                 <option>(height),(width)</option>
118         </term>
119         <listitem>
120                 Progress bar
121         <para></para></listitem>
122 </varlistentry>
123
124 <varlistentry>
125         <term>
126                 <command><option>audacious_bitrate</option></command>
127         </term>
128         <listitem>
129                 Bitrate of current tune
130         <para></para></listitem>
131 </varlistentry>
132
133 <varlistentry>
134         <term>
135                 <command><option>audacious_channels</option></command>
136         </term>
137         <listitem>
138                 Number of audio channels of current tune
139         <para></para></listitem>
140 </varlistentry>
141
142 <varlistentry>
143         <term>
144                 <command><option>audacious_filename</option></command>
145         </term>
146         <listitem>
147                 Full path and filename of current tune
148         <para></para></listitem>
149 </varlistentry>
150
151 <varlistentry>
152         <term>
153                 <command><option>audacious_frequency</option></command>
154         </term>
155         <listitem>
156                 Sampling frequency of current tune
157         <para></para></listitem>
158 </varlistentry>
159
160 <varlistentry>
161         <term>
162                 <command><option>audacious_length</option></command>
163         </term>
164         <listitem>
165                 Total length of current tune as MM:SS
166         <para></para></listitem>
167 </varlistentry>
168
169 <varlistentry>
170         <term>
171                 <command><option>audacious_length_seconds</option></command>
172         </term>
173         <listitem>
174                 Total length of current tune in seconds
175         <para></para></listitem>
176 </varlistentry>
177
178 <varlistentry>
179         <term>
180                 <command><option>audacious_playlist_position</option></command>
181         </term>
182         <listitem>
183                 Playlist position of current tune
184         <para></para></listitem>
185 </varlistentry>
186
187 <varlistentry>
188         <term>
189                 <command><option>audacious_playlist_length</option></command>
190         </term>
191         <listitem>
192                 Number of tunes in playlist
193         <para></para></listitem>
194 </varlistentry>
195
196 <varlistentry>
197         <term>
198                 <command><option>audacious_position</option></command>
199         </term>
200         <listitem>
201                 Position of current tune (MM:SS)
202         <para></para></listitem>
203 </varlistentry>
204
205 <varlistentry>
206         <term>
207                 <command><option>audacious_position_seconds</option></command>
208         </term>
209         <listitem>
210                 Position of current tune in seconds
211         <para></para></listitem>
212 </varlistentry>
213
214 <varlistentry>
215         <term>
216                 <command><option>audacious_status</option></command>
217         </term>
218         <listitem>
219                 Player status (Playing/Paused/Stopped/Not running)
220         <para></para></listitem>
221 </varlistentry>
222
223 <varlistentry>
224         <term>
225                 <command><option>audacious_title</option></command>
226                 <option>(max length)</option>
227         </term>
228         <listitem>
229                 Title of current tune with optional maximum length specifier
230         <para></para></listitem>
231 </varlistentry>
232
233 <varlistentry>
234         <term>
235                 <command><option>battery</option></command>
236         <option>(num)</option>
237         </term>
238         <listitem>
239                 Battery status and remaining percentage capacity of ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
240         <para></para></listitem>
241 </varlistentry>
242
243 <varlistentry>
244         <term>
245                 <command><option>battery_bar</option></command>
246         <option>(height),(width) (num)</option>
247         </term>
248         <listitem>
249                 Battery percentage remaining of ACPI battery in a bar.  ACPI battery number can be given as argument (default is BAT0).
250         <para></para></listitem>
251 </varlistentry>
252
253 <varlistentry>
254         <term>
255                 <command><option>battery_percent</option></command>
256         <option>(num)</option>
257         </term>
258         <listitem>
259                 Battery percentage remaining for ACPI battery.  ACPI battery number can be given as argument (default is BAT0).
260         <para></para></listitem>
261 </varlistentry>
262
263 <varlistentry>
264         <term>
265                 <command><option>battery_time</option></command>
266         <option>(num)</option>
267         </term>
268         <listitem>
269                 Battery charge/discharge time remaining of ACPI battery.  ACPI battery number can be given as argument (default is BAT0).
270         <para></para></listitem>
271 </varlistentry>
272
273 <varlistentry>  
274         <term>          
275                 <command><option>bmpx_artist</option></command>
276         </term>
277         <listitem>
278                 Artist in current BMPx track
279         <para></para></listitem>
280 </varlistentry>
281
282 <varlistentry>  
283         <term>
284                 <command><option>bmpx_album</option></command>
285         </term>         
286         <listitem>
287                 Album in current BMPx track
288         <para></para></listitem>
289 </varlistentry>
290
291 <varlistentry>
292         <term>
293                 <command><option>bmpx_title</option></command>
294         </term>
295         <listitem>
296                 Title of the current BMPx track
297         <para></para></listitem>
298 </varlistentry>
299
300 <varlistentry>
301         <term>
302                 <command><option>bmpx_track</option></command>
303         </term>
304         <listitem>
305                 Track number of the current BMPx track
306         <para></para></listitem>
307 </varlistentry>
308
309 <varlistentry>
310         <term>
311                 <command><option>bmpx_bitrate</option></command>
312         </term>
313         <listitem>
314                 Bitrate of the current BMPx track
315         <para></para></listitem>
316 </varlistentry>
317
318 <varlistentry>
319         <term>
320                 <command><option>bmpx_uri</option></command>
321         </term>
322         <listitem>
323                 URI of the current BMPx track
324         <para></para></listitem>
325 </varlistentry>
326
327 <varlistentry>
328         <term>
329                 <command><option>buffers</option></command>
330         </term>
331         <listitem>
332                 Amount of memory buffered
333         <para></para></listitem>
334 </varlistentry>
335
336 <varlistentry>
337         <term>
338                 <command><option>cached</option></command>
339         </term>
340         <listitem>
341                 Amount of memory cached
342         <para></para></listitem>
343 </varlistentry>
344
345 <varlistentry>
346         <term>
347                 <command><option>color</option></command>
348         <option>(color)</option>
349         </term>
350         <listitem>
351                 Change drawing color to color
352         <para></para></listitem>
353 </varlistentry>
354
355 <varlistentry>
356         <term>
357                 <command><option>color0</option></command>
358         </term>
359         <listitem>
360                 Change drawing color to color0 configuration option
361         <para></para></listitem>
362 </varlistentry>
363
364 <varlistentry>
365         <term>
366                 <command><option>color1</option></command>
367         </term>
368         <listitem>
369                 Change drawing color to color1 configuration option
370         <para></para></listitem>
371 </varlistentry>
372
373 <varlistentry>
374         <term>
375                 <command><option>color2</option></command>
376         </term>
377         <listitem>
378                 Change drawing color to color2 configuration option
379         <para></para></listitem>
380 </varlistentry>
381
382 <varlistentry>
383         <term>
384                 <command><option>color3</option></command>
385         </term>
386         <listitem>
387                 Change drawing color to color3 configuration option
388         <para></para></listitem>
389 </varlistentry>
390
391 <varlistentry>
392         <term>
393                 <command><option>color4</option></command>
394         </term>
395         <listitem>
396                 Change drawing color to color4 configuration option
397         <para></para></listitem>
398 </varlistentry>
399
400 <varlistentry>
401         <term>
402                 <command><option>color5</option></command>
403         </term>
404         <listitem>
405                 Change drawing color to color5 configuration option
406         <para></para></listitem>
407 </varlistentry>
408
409 <varlistentry>
410         <term>
411                 <command><option>color6</option></command>
412         </term>
413         <listitem>
414                 Change drawing color to color6 configuration option
415         <para></para></listitem>
416 </varlistentry>
417
418 <varlistentry>
419         <term>
420                 <command><option>color7</option></command>
421         </term>
422         <listitem>
423                 Change drawing color to color7 configuration option
424         <para></para></listitem>
425 </varlistentry>
426
427 <varlistentry>
428         <term>
429                 <command><option>color8</option></command>
430         </term>
431         <listitem>
432                 Change drawing color to color8 configuration option
433         <para></para></listitem>
434 </varlistentry>
435
436 <varlistentry>
437         <term>
438                 <command><option>color9</option></command>
439         </term>
440         <listitem>
441                 Change drawing color to color9 configuration option
442         <para></para></listitem>
443 </varlistentry>
444
445 <varlistentry>
446         <term>
447                 <command><option>cpu</option></command>
448                 <option>(cpuN)</option>
449         </term>
450         <listitem>
451                 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.
452         <para></para></listitem>
453 </varlistentry>
454
455 <varlistentry>
456         <term>
457                 <command><option>cpubar</option></command>
458                 <option>(cpu number) (height),(width)</option>
459         </term>
460         <listitem>
461                 Bar that shows CPU usage, height is bar's height in pixels.  See $cpu for more info on SMP.
462         <para></para></listitem>
463 </varlistentry>
464
465 <varlistentry>
466         <term>
467                 <command><option>cpugraph</option></command>
468         <option>(cpu number) (height),(width) (gradient colour 1) (gradient colour 2)</option>
469         </term>
470         <listitem>
471                 CPU usage graph, with optional colours in hex, minus the #.  See $cpu for more info on SMP.
472         <para></para></listitem>
473 </varlistentry>
474
475 <varlistentry>
476         <term>
477                 <command><option>diskio</option></command>
478         </term>
479         <listitem>
480                 Displays current disk IO.
481                 <para></para></listitem>
482 </varlistentry>
483
484 <varlistentry>
485         <term>
486                 <command><option>diskiograph</option></command>
487                 <option>(height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
488         </term>
489         <listitem>
490                 Disk IO graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
491                 <para></para></listitem>
492 </varlistentry>
493
494 <varlistentry>
495         <term>
496                 <command><option>diskio_read</option></command>
497         </term>
498         <listitem>
499                 Displays current disk IO for reads.
500                 <para></para></listitem>
501 </varlistentry>
502
503 <varlistentry>
504         <term>
505                 <command><option>diskio_readgraph</option></command>
506                 <option>(height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
507         </term>
508         <listitem>
509                 Disk IO graph for reads, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
510                 <para></para></listitem>
511 </varlistentry>
512
513 <varlistentry>
514         <term>
515                 <command><option>diskio_write</option></command>
516         </term>
517         <listitem>
518                 Displays current disk IO for writes.
519                 <para></para></listitem>
520 </varlistentry>
521
522 <varlistentry>
523         <term>
524                 <command><option>diskio_writegraph</option></command>
525                 <option>(height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
526         </term>
527         <listitem>
528                 Disk IO graph for writes, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
529                 <para></para></listitem>
530 </varlistentry>
531
532 <varlistentry>
533         <term>
534                 <command><option>downspeed</option></command>
535         <option>net</option>
536         </term>
537         <listitem>
538                 Download speed in kilobytes
539         <para></para></listitem>
540 </varlistentry>
541
542 <varlistentry>
543         <term>
544                 <command><option>downspeedf</option></command>
545         <option>net</option>
546         </term>
547         <listitem>
548                 Download speed in kilobytes with one decimal
549         <para></para></listitem>
550 </varlistentry>
551
552 <varlistentry>
553         <term>
554                 <command><option>downspeedgraph</option></command>
555                 <option>net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
556         </term>
557         <listitem>
558                 Download speed graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
559         <para></para></listitem>
560 </varlistentry>
561
562 <varlistentry>
563         <term>
564                 <command><option>else</option></command>
565         </term>
566         <listitem>
567                 Text to show if any of the above are not true
568         <para></para></listitem>
569 </varlistentry>
570
571 <varlistentry>
572         <term>
573                 <command><option>entropy_avail</option></command>
574         </term>
575         <listitem>
576                 Current entropy available for crypto freaks
577         <para></para></listitem>
578 </varlistentry>
579
580 <varlistentry>
581         <term>
582                 <command><option>entropy_bar</option></command>
583                 <option>(height),(width)</option>
584         </term>
585         <listitem>
586                 Normalized bar of available entropy for crypto freaks
587         <para></para></listitem>
588 </varlistentry>
589
590 <varlistentry>
591         <term>
592                 <command><option>entropy_poolsize</option></command>
593         </term>
594         <listitem>
595                 Total size of system entropy pool for crypto freaks
596         <para></para></listitem>
597 </varlistentry>
598
599
600 <varlistentry>
601         <term>
602                 <command><option>exec</option></command>
603         <option>command</option>
604         </term>
605         <listitem>
606                 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.
607         <para></para></listitem>
608 </varlistentry>
609
610 <varlistentry>
611         <term>
612                 <command><option>execbar</option></command>
613         <option>command</option>
614         </term>
615         <listitem>
616                 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.
617         <para></para></listitem>
618 </varlistentry>
619
620 <varlistentry>
621         <term>
622                 <command><option>execgraph</option></command>
623         <option>command</option>
624         </term>
625         <listitem>
626                 Same as execbar, but graphs values.
627         <para></para></listitem>
628 </varlistentry>
629
630 <varlistentry>
631         <term>
632                 <command><option>execi</option></command>
633                 <option>interval command</option>
634         </term>
635         <listitem>
636                 Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
637                 <para></para></listitem>
638 </varlistentry>
639
640 <varlistentry>
641         <term>
642                 <command><option>execibar</option></command>
643                 <option>interval command</option>
644         </term>
645         <listitem>
646                 Same as execbar, except with an interval
647                 <para></para></listitem>
648 </varlistentry>
649
650 <varlistentry>
651         <term>
652                 <command><option>execigraph</option></command>
653                 <option>interval command</option>
654         </term>
655         <listitem>
656                 Same as execigraph, but takes an interval arg graphs values
657                 <para></para></listitem>
658 </varlistentry>
659
660 <varlistentry>
661         <term>
662                 <command><option>font</option></command>
663         <option>(font)</option>
664         </term>
665         <listitem>
666                 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)
667         <para></para></listitem>
668 </varlistentry>
669
670 <varlistentry>
671         <term>
672                 <command><option>freq</option></command>
673                 <option>(n)</option>
674         </term>
675         <listitem>
676                 Returns CPU #n's frequency in MHz. CPUs are
677                 counted from 1. If omitted, the parameter
678                 defaults to 1.
679                 <para></para></listitem>
680 </varlistentry>
681 <varlistentry>
682         <term>
683                 <command><option>freq_g</option></command>
684                 <option>(n)</option>
685         </term>
686         <listitem>
687                 Returns CPU #n's frequency in GHz. CPUs are
688                 counted from 1. If omitted, the parameter
689                 defaults to 1.
690                 <para></para></listitem>
691 </varlistentry>
692         
693 <varlistentry>
694         <term>
695                 <command><option>freq_dyn</option></command>
696         </term>
697         <listitem>
698                         Returns CPU frequency in MHz, but is calculated by counting to clock cycles to complete an instruction.  Only available for x86/amd64.
699                         <para></para></listitem>
700 </varlistentry>
701
702 <varlistentry>
703         <term>
704                 <command><option>freq_dyn_g</option></command>
705         </term>
706         <listitem>
707                 Returns CPU frequency in GHz, but is calculated by counting to clock cycles to complete an instruction.  Only available for x86/amd64.
708         <para></para></listitem>
709 </varlistentry>
710         
711 <varlistentry>
712         <term>
713                 <command><option>fs_bar</option></command>
714         <option>(height),(width) fs</option>
715         </term>
716         <listitem>
717                 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.
718         <para></para></listitem>
719 </varlistentry>
720
721 <varlistentry>
722         <term>
723                 <command><option>fs_free</option></command>
724         <option>(fs)</option>
725         </term>
726         <listitem>
727                 Free space on a file system available for users.
728         <para></para></listitem>
729 </varlistentry>
730
731 <varlistentry>
732         <term>
733                 <command><option>fs_free_perc</option></command>
734         <option>(fs)</option>
735         </term>
736         <listitem>
737                 Free percentage of space on a file system available for users.
738         <para></para></listitem>
739 </varlistentry>
740
741 <varlistentry>
742         <term>
743                 <command><option>fs_size</option></command>
744         <option>(fs)</option>
745         </term>
746         <listitem>
747                 File system size
748         <para></para></listitem>
749 </varlistentry>
750
751 <varlistentry>
752         <term>
753                 <command><option>fs_used</option></command>
754         <option>(fs)</option>
755         </term>
756         <listitem>
757                 File system used space
758         <para></para></listitem>
759 </varlistentry>
760
761 <varlistentry>
762         <term>
763                 <command><option>goto</option></command>
764                 <option>x</option>
765         </term>
766         <listitem>
767         The next element will be printed at position 'x'.
768                 <para></para></listitem>
769 </varlistentry>
770
771 <varlistentry>
772         <term>
773                 <command><option>hddtemp</option></command>
774                 <option>dev, (host,(port))</option>
775         </term>
776         <listitem>
777                 Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
778                 Default host is 127.0.0.1, default port is 7634.
779                 <para></para></listitem>
780 </varlistentry>
781
782 <varlistentry>
783         <term>
784                 <command><option>head</option></command>
785                 <option>logfile lines (interval)</option>
786         </term>
787         <listitem>
788                 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.
789                 <para></para></listitem>
790 </varlistentry>
791
792 <varlistentry>
793         <term>
794                 <command><option>hr</option></command>
795         <option>(height)</option>
796         </term>
797         <listitem>
798                 Horizontal line, height is the height in pixels
799         <para></para></listitem>
800 </varlistentry>
801
802 <varlistentry>
803         <term>
804                 <command><option>hwmon</option></command>
805         <option>N sensor number input</option>
806         </term>
807         <listitem>
808                 This has the ability to display the contents of hwmon files located under "/sys/class/hwmon/hwmonX/device/N".  For example, use ${hwmon 0 temp 1 input} to read the temperature of the CPU (in Â°C) from "/sys/class/hwmon/hwmon0/device/temp1_input".  If the sensor name equals "temp", then the value read will be divided by 1000, otherwise the number will be used unchanged.  The factor 1000 is just for the Abit uGuru sensor.
809         <para></para></listitem>
810 </varlistentry>
811
812 <varlistentry>
813         <term>
814                 <command><option>iconv_start</option></command>
815         <option>codeset_from codeset_to</option>
816         </term>
817         <listitem>
818                 Convert text from one codeset to another using GNU iconv.  Needs to be stopped with iconv_stop.
819         <para></para></listitem>
820 </varlistentry>
821
822 <varlistentry>
823         <term>
824                 <command><option>iconv_stop</option></command>
825         <option></option>
826         </term>
827         <listitem>
828                 Stop iconv codeset conversion.
829         <para></para></listitem>
830 </varlistentry>
831
832 <varlistentry>
833         <term>
834                 <command><option>i2c</option></command>
835         <option>(dev) type n</option>
836         </term>
837         <listitem>
838                 I2C sensor from sysfs (Linux 2.6). dev may be omitted if you have only one I2C device. type is either in (or vol) meaning voltage, fan meaning fan or temp/tempf (first in C, second in F) meaning temperature. n is number of the sensor. See /sys/bus/i2c/devices/ on your local computer.
839         <para></para></listitem>
840 </varlistentry>
841
842 <varlistentry>
843         <term>
844                 <command><option>i8k_ac_status</option></command>
845         <option></option>
846         </term>
847         <listitem>
848                 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.
849         <para></para></listitem>
850 </varlistentry>
851
852 <varlistentry>
853         <term>
854                 <command><option>i8k_bios</option></command>
855         <option></option>
856         </term>
857         <listitem>
858                 If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
859         <para></para></listitem>
860 </varlistentry>
861
862 <varlistentry>
863         <term>
864                 <command><option>i8k_buttons_status</option></command>
865         <option></option>
866         </term>
867         <listitem>
868                 If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
869         <para></para></listitem>
870 </varlistentry>
871
872 <varlistentry>
873         <term>
874                 <command><option>i8k_cpu_temp</option></command>
875         <option></option>
876         </term>
877         <listitem>
878                 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
879         <para></para></listitem>
880 </varlistentry>
881
882 <varlistentry>
883         <term>
884                 <command><option>i8k_cpu_tempf</option></command>
885         <option></option>
886         </term>
887         <listitem>
888                 If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Fahrenheit, as reported by /proc/i8k.
889         <para></para></listitem>
890 </varlistentry>
891
892 <varlistentry>
893         <term>
894                 <command><option>i8k_left_fan_rpm</option></command>
895         <option></option>
896         </term>
897         <listitem>
898                 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.
899         <para></para></listitem>
900 </varlistentry>
901
902 <varlistentry>
903         <term>
904                 <command><option>i8k_left_fan_status</option></command>
905         <option></option>
906         </term>
907         <listitem>
908                 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.
909         <para></para></listitem>
910 </varlistentry>
911
912 <varlistentry>
913         <term>
914                 <command><option>i8k_right_fan_rpm</option></command>
915         <option></option>
916         </term>
917         <listitem>
918                 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.
919         <para></para></listitem>
920 </varlistentry>
921
922 <varlistentry>
923         <term>
924                 <command><option>i8k_right_fan_status</option></command>
925         <option></option>
926         </term>
927         <listitem>
928                 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.
929         <para></para></listitem>
930 </varlistentry>
931
932 <varlistentry>
933         <term>
934                 <command><option>i8k_serial</option></command>
935         <option></option>
936         </term>
937         <listitem>
938                 If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
939         <para></para></listitem>
940 </varlistentry>
941
942 <varlistentry>
943         <term>
944                 <command><option>i8k_version</option></command>
945         <option></option>
946         </term>
947         <listitem>
948                 If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
949         <para></para></listitem>
950 </varlistentry>
951
952 <varlistentry>
953         <term>
954                 <command><option>ibm_fan</option></command>
955         </term>
956         <listitem>
957                 If running the IBM ACPI, displays the fan speed.
958         <para></para></listitem>
959 </varlistentry>
960
961 <varlistentry>
962         <term>
963                 <command><option>ibm_temps</option></command>
964                 <option>N</option>
965         </term>
966         <listitem>
967                 If running the IBM ACPI, displays the temperatures
968                 from the IBM temperature sensors (N=0..7) Sensor 0 is
969                 on the CPU, 3 is on the GPU.
970         <para></para></listitem>
971 </varlistentry>
972
973 <varlistentry>
974         <term>
975                 <command><option>ibm_volume</option></command>
976         </term>
977         <listitem>
978                 If running the IBM ACPI, displays the "master" volume,
979         controlled by the volume keys (0-14).
980         <para></para></listitem>
981 </varlistentry>
982
983 <varlistentry>
984         <term>
985                 <command><option>ibm_brightness</option></command>
986         </term>
987         <listitem>
988                 If running the IBM ACPI, displays the brigtness of the
989         laptops's LCD (0-7).
990         <para></para></listitem>
991 </varlistentry>
992
993 <varlistentry>
994         <term>
995                 <command><option>if_empty</option></command>
996         <option>(var)</option>
997         </term>
998         <listitem>
999                 if conky variable VAR is empty, display everything between $if_empty and the matching $endif
1000         <para></para></listitem>
1001 </varlistentry>
1002
1003 <varlistentry>
1004         <term>
1005                 <command><option>if_running</option></command>
1006         <option>(process)</option>
1007         </term>
1008         <listitem>
1009                 if PROCESS is running, display everything $if_running and the matching $endif
1010         <para></para></listitem>
1011 </varlistentry>
1012
1013 <varlistentry>
1014         <term>
1015                 <command><option>if_existing</option></command>
1016         <option>file (string)</option>
1017         </term>
1018         <listitem>
1019                 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.
1020         <para></para></listitem>
1021 </varlistentry>
1022
1023 <varlistentry>
1024         <term>
1025                 <command><option>if_mounted</option></command>
1026         <option>(mountpoint)</option>
1027         </term>
1028         <listitem>
1029                 if MOUNTPOINT is mounted, display everything between $if_mounted and the matching $endif
1030         <para></para></listitem>
1031 </varlistentry>
1032
1033 <varlistentry>
1034         <term>
1035                 <command><option>imap_messages</option></command>
1036         <option>(args)</option>
1037         </term>
1038         <listitem>
1039                 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.
1040         <para></para></listitem>
1041 </varlistentry>
1042
1043 <varlistentry>
1044         <term>
1045                 <command><option>imap_unseen</option></command>
1046         <option>(args)</option>
1047         </term>
1048         <listitem>
1049                 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.
1050         <para></para></listitem>
1051 </varlistentry>
1052
1053 <varlistentry>
1054         <term>
1055                 <command><option>kernel</option></command>
1056         </term>
1057         <listitem>
1058                 Kernel version
1059         <para></para></listitem>
1060 </varlistentry>
1061
1062 <varlistentry>
1063         <term>
1064                 <command><option>linkstatus</option></command>
1065         <option>interface</option>
1066         </term>
1067         <listitem>
1068                 Get the link status for wireless connections
1069         <para></para></listitem>
1070 </varlistentry>
1071
1072 <varlistentry>
1073         <term>
1074                 <command><option>loadavg</option></command>
1075         </term>
1076         <listitem>
1077                 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
1078         <para></para></listitem>
1079 </varlistentry>
1080
1081 <varlistentry>
1082         <term>
1083                 <command><option>machine</option></command>
1084         </term>
1085         <listitem>
1086                 Machine, i686 for example
1087         <para></para></listitem>
1088 </varlistentry>
1089
1090 <varlistentry>
1091         <term>
1092                 <command><option>mails</option></command>
1093         </term>
1094         <listitem>
1095                 Mail count in mail spool. You can use program like fetchmail to get mails from some server using your favourite protocol. See also new_mails.
1096         <para></para></listitem>
1097 </varlistentry>
1098
1099 <varlistentry>
1100         <term>
1101                 <command><option>mboxscan</option></command>
1102                 <option>(-n number of messages to print) (-fw from width) (-sw subject width) mbox</option>
1103         </term>
1104         <listitem>
1105                 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"}
1106         <para></para></listitem>
1107 </varlistentry>
1108
1109 <varlistentry>
1110         <term>
1111                 <command><option>mem</option></command>
1112         </term>
1113         <listitem>
1114                 Amount of memory in use
1115         <para></para></listitem>
1116 </varlistentry>
1117
1118 <varlistentry>
1119         <term>
1120                 <command><option>membar</option></command>
1121         <option>(height),(width)</option>
1122         </term>
1123         <listitem>
1124                 Bar that shows amount of memory in use
1125         <para></para></listitem>
1126 </varlistentry>
1127
1128 <varlistentry>
1129         <term>
1130                 <command><option>memmax</option></command>
1131         </term>
1132         <listitem>
1133                 Total amount of memory
1134         <para></para></listitem>
1135 </varlistentry>
1136
1137 <varlistentry>
1138         <term>
1139                 <command><option>memperc</option></command>
1140         </term>
1141         <listitem>
1142                 Percentage of memory in use
1143         <para></para></listitem>
1144 </varlistentry>
1145
1146 <varlistentry>
1147         <term>
1148                 <command><option>mpd_artist</option></command>
1149         </term>
1150         <listitem>
1151                 Artist in current MPD song must be enabled at compile
1152         <para></para></listitem>
1153 </varlistentry>
1154
1155 <varlistentry>
1156         <term>
1157                 <command><option>mpd_album</option></command>
1158         </term>
1159         <listitem>
1160                 Album in current MPD song
1161         <para></para></listitem>
1162 </varlistentry>
1163
1164 <varlistentry>
1165         <term>
1166                 <command><option>mpd_bar</option></command>
1167         <option>(height),(width)</option>
1168         </term>
1169         <listitem>
1170                 Bar of mpd's progress
1171         <para></para></listitem>
1172 </varlistentry>
1173
1174 <varlistentry>
1175         <term>
1176                 <command><option>mpd_bitrate</option></command>
1177         </term>
1178         <listitem>
1179                 Bitrate of current song
1180         <para></para></listitem>
1181 </varlistentry>
1182
1183 <varlistentry>
1184         <term>
1185                 <command><option>mpd_status</option></command>
1186         </term>
1187         <listitem>
1188                 Playing, stopped, et cetera.
1189         <para></para></listitem>
1190 </varlistentry>
1191
1192 <varlistentry>
1193         <term>
1194                 <command><option>mpd_title</option></command>
1195         </term>
1196         <listitem>
1197                 Title of current MPD song
1198         <para></para></listitem>
1199 </varlistentry>
1200
1201 <varlistentry>
1202         <term>
1203                 <command><option>mpd_vol</option></command>
1204         </term>
1205         <listitem>
1206                 MPD's volume
1207         <para></para></listitem>
1208 </varlistentry>
1209
1210 <varlistentry>
1211         <term>
1212                 <command><option>mpd_elapsed</option></command>
1213         </term>
1214         <listitem>
1215                 Song's elapsed time
1216         <para></para></listitem>
1217 </varlistentry>
1218
1219 <varlistentry>
1220         <term>
1221                 <command><option>mpd_length</option></command>
1222         </term>
1223         <listitem>
1224                 Song's length
1225         <para></para></listitem>
1226 </varlistentry>
1227
1228 <varlistentry>
1229         <term>
1230                 <command><option>mpd_percent</option></command>
1231         </term>
1232         <listitem>
1233                 Percent of song's progress
1234         <para></para></listitem>
1235 </varlistentry>
1236
1237 <varlistentry>
1238         <term>
1239                 <command><option>mpd_random</option></command>
1240         </term>
1241         <listitem>
1242                 Random status (On/Off)
1243         <para></para></listitem>
1244 </varlistentry>
1245
1246 <varlistentry>
1247         <term>
1248                 <command><option>mpd_repeat</option></command>
1249         </term>
1250         <listitem>
1251                 Repeat status (On/Off)
1252         <para></para></listitem>
1253 </varlistentry>
1254
1255 <varlistentry>
1256         <term>
1257                 <command><option>mpd_track</option></command>
1258         </term>
1259         <listitem>
1260                 Prints the MPD track field
1261         <para></para></listitem>
1262 </varlistentry>
1263
1264 <varlistentry>
1265         <term>
1266                 <command><option>mpd_name</option></command>
1267         </term>
1268         <listitem>
1269                 Prints the MPD name field
1270         <para></para></listitem>
1271 </varlistentry>
1272
1273 <varlistentry>
1274         <term>
1275                 <command><option>mpd_file</option></command>
1276         </term>
1277         <listitem>
1278                 Prints the file name of the current MPD song
1279         <para></para></listitem>
1280 </varlistentry>
1281
1282 <varlistentry>
1283         <term>
1284                 <command><option>mpd_smart</option></command>
1285         </term>
1286         <listitem>
1287                 Prints the song name in either the form "artist - title" or file name, depending on whats available
1288         <para></para></listitem>
1289 </varlistentry>
1290
1291 <varlistentry>
1292         <term>
1293                 <command><option>new_mails</option></command>
1294         </term>
1295         <listitem>
1296                 Unread mail count in mail spool.
1297         <para></para></listitem>
1298 </varlistentry>
1299
1300 <varlistentry>
1301         <term>
1302                 <command><option>nodename</option></command>
1303         </term>
1304         <listitem>
1305                 Hostname
1306         <para></para></listitem>
1307 </varlistentry>
1308
1309 <varlistentry>
1310         <term>
1311                 <command><option>outlinecolor</option></command>
1312         <option>(color)</option>
1313         </term>
1314         <listitem>
1315                 Change outline color
1316         <para></para></listitem>
1317 </varlistentry>
1318
1319 <varlistentry>
1320         <term>
1321                 <command><option>pb_battery</option></command>
1322                 <option>item</option>
1323         </term>
1324         <listitem>
1325                 If running on Apple powerbook/ibook, display
1326                 information on battery status. The item parameter
1327                 specifies, what information to display. Exactly one item
1328                 must be specified. Valid items are:
1329                 <simplelist>
1330                         <member><command>status</command>:
1331                                 Display if battery is fully charged, charging,
1332                                 discharging or absent (running on AC)
1333                         </member>
1334                         <member><command>percent</command>:
1335                                 Display charge of battery in percent, if
1336                                 charging or discharging. Nothing will be
1337                                 displayed, if battery is fully charged
1338                                 or absent.
1339                         </member>
1340                         <member><command>time</command>:
1341                                 Display the time remaining until the battery
1342                                 will be fully charged or discharged at current
1343                                 rate.  Nothing is displayed, if battery is
1344                                 absent or if it's present but fully charged
1345                                 and not discharging.
1346                         </member>
1347                 </simplelist>
1348         <para></para></listitem>
1349 </varlistentry>
1350
1351 <varlistentry>
1352         <term>
1353                 <command><option>pop3_unseen</option></command>
1354         <option>(args)</option>
1355         </term>
1356         <listitem>
1357                 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.
1358
1359                 <para></para></listitem>
1360 </varlistentry>
1361
1362 <varlistentry>
1363         <term>
1364                 <command><option>pop3_used</option></command>
1365         <option>(args)</option>
1366         </term>
1367         <listitem>
1368                 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.
1369
1370                 <para></para></listitem>
1371 </varlistentry>
1372
1373 <varlistentry>
1374         <term>
1375                 <command><option>pre_exec</option></command>
1376         <option>shell command</option>
1377         </term>
1378         <listitem>
1379                 Executes a shell command one time before conky displays anything and puts output as text.
1380         <para></para></listitem>
1381 </varlistentry>
1382
1383 <varlistentry>
1384         <term>
1385                 <command><option>processes</option></command>
1386         </term>
1387         <listitem>
1388                 Total processes (sleeping and running)
1389         <para></para></listitem>
1390 </varlistentry>
1391
1392 <varlistentry>
1393         <term>
1394                 <command><option>running_processes</option></command>
1395         </term>
1396         <listitem>
1397                 Running processes (not sleeping), requires Linux 2.6
1398         <para></para></listitem>
1399 </varlistentry>
1400
1401 <varlistentry>
1402         <term>
1403                 <command><option>shadecolor</option></command>
1404         <option>(color)</option>
1405         </term>
1406         <listitem>
1407                 Change shading color
1408         <para></para></listitem>
1409 </varlistentry>
1410
1411 <varlistentry>
1412         <term>
1413                 <command><option>stippled_hr</option></command>
1414         <option>(space)</option>
1415         </term>
1416         <listitem>
1417                 Stippled (dashed) horizontal line
1418         <para></para></listitem>
1419 </varlistentry>
1420
1421 <varlistentry>
1422         <term>
1423                 <command><option>swapbar</option></command>
1424         <option>(height),(width)</option>
1425         </term>
1426         <listitem>
1427                 Bar that shows amount of swap in use
1428         <para></para></listitem>
1429 </varlistentry>
1430
1431 <varlistentry>
1432         <term>
1433                 <command><option>swap</option></command>
1434         </term>
1435         <listitem>
1436                 Amount of swap in use
1437         <para></para></listitem>
1438 </varlistentry>
1439
1440 <varlistentry>
1441         <term>
1442                 <command><option>swapmax</option></command>
1443         </term>
1444         <listitem>
1445                 Total amount of swap
1446         <para></para></listitem>
1447 </varlistentry>
1448
1449 <varlistentry>
1450         <term>
1451                 <command><option>swapperc</option></command>
1452         </term>
1453         <listitem>
1454                 Percentage of swap in use
1455         <para></para></listitem>
1456 </varlistentry>
1457
1458 <varlistentry>
1459         <term>
1460                 <command><option>sysname</option></command>
1461         </term>
1462         <listitem>
1463                 System name, Linux for example
1464         <para></para></listitem>
1465 </varlistentry>
1466
1467 <varlistentry>
1468         <term>
1469                 <command><option>tcp_portmon</option></command>
1470                 <option>port_begin port_end item (index)</option>
1471                 <emphasis>(ip4 only at present)</emphasis>
1472         </term>
1473         <listitem>
1474                 TCP port monitor for specified local ports.  Port numbers must be in the range 1 to 65535. Valid items are:
1475                 <simplelist>
1476                         <member><command>count</command> - total number of connections in the range
1477                                 </member>
1478                         <member><command>rip</command> - remote ip address
1479                                 </member>
1480                         <member><command>rhost</command> - remote host name 
1481                                 </member>
1482                         <member><command>rport</command> - remote port number
1483                                 </member>
1484                         <member><command>rservice</command> - remote service name from /etc/services
1485                                 </member>
1486                         <member><command>lip</command> - local ip address
1487                                 </member>
1488                         <member><command>lhost</command> - local host name
1489                                 </member>
1490                         <member><command>lport</command> - local port number
1491                                 </member>
1492                         <member><command>lservice</command> - local service name from /etc/services
1493                                 </member>
1494                 </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.
1495                 <simplelist>
1496                         <member>Examples:</member>
1497                         <member><command>${tcp_portmon 6881 6999 count}</command> -
1498                                 displays the number of connections in the bittorrent port range</member>
1499                         <member><command>${tcp_portmon 22 22 rip 0}</command> -
1500                                 displays the remote host ip of the first sshd connection</member>
1501                         <member><command>${tcp_portmon 22 22 rip 9}</command> -
1502                                 displays the remote host ip of the tenth sshd connection</member>
1503                         <member><command>${tcp_portmon 1 1024 rhost 0}</command> -
1504                                 displays the remote host name of the first connection on a privileged port</member>
1505                         <member><command>${tcp_portmon 1 1024 rport 4}</command> -
1506                                 displays the remote host port of the fifth connection on a privileged port</member>
1507                         <member><command>${tcp_portmon 1 65535 lservice 14}</command> -
1508                                 displays the local service name of the fifteenth connection in the range of all ports</member>
1509                 </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. 
1510         </listitem>
1511 </varlistentry>
1512
1513 <varlistentry>
1514         <term>
1515                 <command><option>texeci</option></command>
1516                 <option>interval command</option>
1517         </term>
1518         <listitem>
1519                 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.
1520                 <para></para></listitem>
1521 </varlistentry>
1522
1523 <varlistentry>
1524         <term>
1525                 <command><option>offset</option></command>
1526                 <option>(pixels)</option>
1527         </term>
1528         <listitem>
1529                 Move text over by N pixels.  See also $voffset.
1530                 <para></para></listitem>
1531 </varlistentry>
1532
1533 <varlistentry>
1534         <term>
1535                 <command><option>tab</option></command>
1536                 <option>(width, (start))</option>
1537         </term>
1538         <listitem>
1539         Puts a tab of the specified width, starting from column 'start'.
1540         <para></para></listitem>
1541 </varlistentry>
1542
1543 <varlistentry>
1544         <term>
1545                 <command><option>tail</option></command>
1546                 <option>logfile lines (interval)</option>
1547         </term>
1548         <listitem>
1549                 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.
1550         <para></para></listitem>
1551 </varlistentry>
1552
1553 <varlistentry>
1554         <term>
1555                 <command><option>time</option></command>
1556         <option>(format)</option>
1557         </term>
1558         <listitem>
1559                 Local time, see man strftime to get more information about format
1560         <para></para></listitem>
1561 </varlistentry>
1562
1563 <varlistentry>
1564         <term>
1565                 <command><option>utime</option></command>
1566         <option>(format)</option>
1567         </term>
1568         <listitem>
1569                 Display time in UTC (universal coordinate time).
1570         <para></para></listitem>
1571 </varlistentry>
1572
1573 <varlistentry>
1574         <term>
1575                 <command><option>tztime</option></command>
1576         <option>(timezone) (format)</option>
1577         </term>
1578         <listitem>
1579                 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.
1580         <para></para></listitem>
1581 </varlistentry>
1582
1583 <varlistentry>
1584         <term>
1585                 <command><option>totaldown</option></command>
1586         <option>net</option>
1587         </term>
1588         <listitem>
1589                 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.
1590         <para></para></listitem>
1591 </varlistentry>
1592
1593 <varlistentry>
1594         <term>
1595                 <command><option>top</option></command>
1596         <option>type, num</option>
1597         </term>
1598         <listitem>
1599                 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", and "mem". There can be a max of 10 processes listed.
1600         <para></para></listitem>
1601 </varlistentry>
1602
1603 <varlistentry>
1604         <term>
1605                 <command><option>top_mem</option></command>
1606         <option>type, num</option>
1607         </term>
1608         <listitem>
1609                 Same as top, except sorted by mem usage instead of cpu
1610         <para></para></listitem>
1611 </varlistentry>
1612
1613 <varlistentry>
1614         <term>
1615                 <command><option>totalup</option></command>
1616         <option>net</option>
1617         </term>
1618         <listitem>
1619                 Total upload, this one too, may overflow
1620         <para></para></listitem>
1621 </varlistentry>
1622
1623 <varlistentry>
1624         <term>
1625                 <command><option>updates</option></command>
1626         <option>Number of updates</option>
1627         </term>
1628         <listitem>
1629                 for debugging
1630         <para></para></listitem>
1631 </varlistentry>
1632
1633 <varlistentry>
1634         <term>
1635                 <command><option>upspeed</option></command>
1636         <option>net</option>
1637         </term>
1638         <listitem>
1639                 Upload speed in kilobytes
1640         <para></para></listitem>
1641 </varlistentry>
1642
1643 <varlistentry>
1644         <term>
1645                 <command><option>upspeedf</option></command>
1646         <option>net</option>
1647         </term>
1648         <listitem>
1649                 Upload speed in kilobytes with one decimal
1650         <para></para></listitem>
1651 </varlistentry>
1652
1653 <varlistentry>
1654         <term>
1655                 <command><option>upspeedgraph</option></command>
1656                 <option>net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
1657         </term>
1658         <listitem>
1659                 Upload speed graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
1660         <para></para></listitem>
1661 </varlistentry>
1662
1663 <varlistentry>
1664         <term>
1665                 <command><option>uptime</option></command>
1666         </term>
1667         <listitem>
1668                 Uptime
1669         <para></para></listitem>
1670 </varlistentry>
1671
1672 <varlistentry>
1673         <term>
1674                 <command><option>uptime_short</option></command>
1675         </term>
1676         <listitem>
1677                 Uptime in a shorter format
1678         <para></para></listitem>
1679 </varlistentry>
1680
1681 <varlistentry>
1682         <term>
1683                 <command><option>voffset</option></command>
1684                 <option>(pixels)</option>
1685         </term>
1686         <listitem>
1687                 Change vertical offset by N pixels.  Negative values will cause text to overlap.  See also $offset.
1688                 <para></para></listitem>
1689 </varlistentry>
1690
1691 <varlistentry>
1692         <term>
1693                 <command><option>voltage_mv</option></command>
1694                 <option>(n)</option>
1695         </term>
1696         <listitem>
1697                 Returns CPU #n's voltage in mV. CPUs are
1698                 counted from 1. If omitted, the parameter
1699                 defaults to 1. 
1700                 <para></para></listitem>
1701 </varlistentry>
1702
1703 <varlistentry>
1704         <term>
1705                 <command><option>voltage_v</option></command>
1706                 <option>(n)</option>
1707         </term>
1708         <listitem>
1709                 Returns CPU #n's voltage in V. CPUs are
1710                 counted from 1. If omitted, the parameter
1711                 defaults to 1.
1712                 <para></para></listitem>
1713 </varlistentry>
1714
1715 <varlistentry>
1716         <term>
1717                 <command><option>xmms2_artist</option></command>
1718         </term>
1719         <listitem>
1720                 Artist in current XMMS2 song
1721         <para></para></listitem>
1722 </varlistentry>
1723
1724 <varlistentry>
1725         <term>
1726                 <command><option>xmms2_album</option></command>
1727         </term>
1728         <listitem>
1729                 Album in current XMMS2 song
1730         <para></para></listitem>
1731 </varlistentry>
1732
1733 <varlistentry>
1734         <term>
1735                 <command><option>xmms2_title</option></command>
1736         </term>
1737         <listitem>
1738                 Title in current XMMS2 song
1739         <para></para></listitem>
1740 </varlistentry>
1741
1742 <varlistentry>
1743         <term>
1744                 <command><option>xmms2_genre</option></command>
1745         </term>
1746         <listitem>
1747                 Genre in current XMMS2 song
1748         <para></para></listitem>
1749 </varlistentry>
1750
1751 <varlistentry>
1752         <term>
1753                 <command><option>xmms2_comment</option></command>
1754         </term>
1755         <listitem>
1756                 Comment in current XMMS2 song
1757         <para></para></listitem>
1758 </varlistentry>
1759
1760 <varlistentry>
1761         <term>
1762                 <command><option>xmms2_decoder</option></command>
1763         </term>
1764         <listitem>
1765                 Decoder plugin used
1766         <para></para></listitem>
1767 </varlistentry>
1768
1769 <varlistentry>
1770         <term>
1771                 <command><option>xmms2_transport</option></command>
1772         </term>
1773         <listitem>
1774                 Transport plugin used
1775         <para></para></listitem>
1776 </varlistentry>
1777
1778 <varlistentry>
1779         <term>
1780                 <command><option>xmms2_url</option></command>
1781         </term>
1782         <listitem>
1783                 Full path to current song
1784 <para></para></listitem>
1785 </varlistentry>
1786
1787 <varlistentry>
1788         <term>
1789                 <command><option>xmms2_tracknr</option></command>
1790         </term>
1791         <listitem>
1792                 Track number in current XMMS2 song
1793 <para></para></listitem>
1794 </varlistentry>
1795
1796 <varlistentry>
1797         <term>
1798                 <command><option>xmms2_bitrate</option></command>
1799         </term>
1800         <listitem>
1801         Bitrate of current song
1802         <para></para></listitem>
1803 </varlistentry>
1804
1805 <varlistentry>
1806         <term>
1807                 <command><option>xmms2_id</option></command>
1808         </term>
1809         <listitem>
1810                 XMMS2 id of current song
1811         <para></para></listitem>
1812 </varlistentry>
1813
1814 <varlistentry>
1815         <term>
1816                 <command><option>xmms2_duration</option></command>
1817         </term>
1818         <listitem>
1819                 Duration of current song
1820         <para></para></listitem>
1821 </varlistentry>
1822
1823 <varlistentry>
1824         <term>
1825                 <command><option>xmms2_elapsed</option></command>
1826         </term>
1827         <listitem>
1828                 Song's elapsed time
1829         <para></para></listitem>
1830 </varlistentry>
1831
1832 <varlistentry>
1833         <term>
1834                 <command><option>xmms2_size</option></command>
1835         </term>
1836         <listitem>
1837         Size of current song
1838         <para></para></listitem>
1839 </varlistentry>
1840
1841 <varlistentry>
1842         <term>
1843                 <command><option>xmms2_percent</option></command>
1844         </term>
1845         <listitem>
1846                 Percent of song's progress
1847         <para></para></listitem>
1848 </varlistentry>
1849
1850 <varlistentry>
1851         <term>
1852                 <command><option>xmms2_status</option></command>
1853         </term>
1854         <listitem>
1855                 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1856         <para></para></listitem>
1857 </varlistentry>
1858
1859 <varlistentry>
1860         <term>
1861                 <command><option>xmms2_bar</option></command>
1862         <option>(height),(width)</option>
1863         </term>
1864         <listitem>
1865                 Bar of XMMS2's progress
1866         <para></para></listitem>
1867 </varlistentry>
1868
1869 <varlistentry>
1870         <term>
1871                 <command><option>xmms2_smart</option></command>
1872         </term>
1873         <listitem>
1874                 Prints the song name in either the form "artist - title" or file name, depending on whats available
1875         <para></para></listitem>
1876 </varlistentry>
1877
1878 </variablelist>