b2848e4ce35b50101f1277c352239aef882083ad
[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>(dev) type n</option>
806   </term>
807   <listitem>
808     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.
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).  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.
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>loadavg</option></command>
1065         </term>
1066         <listitem>
1067                 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
1068         <para></para></listitem>
1069 </varlistentry>
1070
1071 <varlistentry>
1072         <term>
1073                 <command><option>machine</option></command>
1074         </term>
1075         <listitem>
1076                 Machine, i686 for example
1077         <para></para></listitem>
1078 </varlistentry>
1079
1080 <varlistentry>
1081         <term>
1082                 <command><option>mails</option></command>
1083         </term>
1084         <listitem>
1085                 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.
1086         <para></para></listitem>
1087 </varlistentry>
1088
1089 <varlistentry>
1090         <term>
1091                 <command><option>mboxscan</option></command>
1092                 <option>(-n number of messages to print) (-fw from width) (-sw subject width) mbox</option>
1093         </term>
1094         <listitem>
1095                 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"}
1096         <para></para></listitem>
1097 </varlistentry>
1098
1099 <varlistentry>
1100         <term>
1101                 <command><option>mem</option></command>
1102         </term>
1103         <listitem>
1104                 Amount of memory in use
1105         <para></para></listitem>
1106 </varlistentry>
1107
1108 <varlistentry>
1109         <term>
1110                 <command><option>membar</option></command>
1111         <option>(height),(width)</option>
1112         </term>
1113         <listitem>
1114                 Bar that shows amount of memory in use
1115         <para></para></listitem>
1116 </varlistentry>
1117
1118 <varlistentry>
1119         <term>
1120                 <command><option>memmax</option></command>
1121         </term>
1122         <listitem>
1123                 Total amount of memory
1124         <para></para></listitem>
1125 </varlistentry>
1126
1127 <varlistentry>
1128         <term>
1129                 <command><option>memperc</option></command>
1130         </term>
1131         <listitem>
1132                 Percentage of memory in use
1133         <para></para></listitem>
1134 </varlistentry>
1135
1136 <varlistentry>
1137         <term>
1138                 <command><option>mpd_artist</option></command>
1139         </term>
1140         <listitem>
1141                 Artist in current MPD song must be enabled at compile
1142         <para></para></listitem>
1143 </varlistentry>
1144
1145 <varlistentry>
1146         <term>
1147                 <command><option>mpd_album</option></command>
1148         </term>
1149         <listitem>
1150                 Album in current MPD song
1151         <para></para></listitem>
1152 </varlistentry>
1153
1154 <varlistentry>
1155         <term>
1156                 <command><option>mpd_bar</option></command>
1157         <option>(height),(width)</option>
1158         </term>
1159         <listitem>
1160                 Bar of mpd's progress
1161         <para></para></listitem>
1162 </varlistentry>
1163
1164 <varlistentry>
1165         <term>
1166                 <command><option>mpd_bitrate</option></command>
1167         </term>
1168         <listitem>
1169                 Bitrate of current song
1170         <para></para></listitem>
1171 </varlistentry>
1172
1173 <varlistentry>
1174         <term>
1175                 <command><option>mpd_status</option></command>
1176         </term>
1177         <listitem>
1178                 Playing, stopped, et cetera.
1179         <para></para></listitem>
1180 </varlistentry>
1181
1182 <varlistentry>
1183         <term>
1184                 <command><option>mpd_title</option></command>
1185         <option>(max length)</option>
1186         </term>
1187         <listitem>
1188                 Title of current MPD song
1189         <para></para></listitem>
1190 </varlistentry>
1191
1192 <varlistentry>
1193         <term>
1194                 <command><option>mpd_vol</option></command>
1195         </term>
1196         <listitem>
1197                 MPD's volume
1198         <para></para></listitem>
1199 </varlistentry>
1200
1201 <varlistentry>
1202         <term>
1203                 <command><option>mpd_elapsed</option></command>
1204         </term>
1205         <listitem>
1206                 Song's elapsed time
1207         <para></para></listitem>
1208 </varlistentry>
1209
1210 <varlistentry>
1211         <term>
1212                 <command><option>mpd_length</option></command>
1213         </term>
1214         <listitem>
1215                 Song's length
1216         <para></para></listitem>
1217 </varlistentry>
1218
1219 <varlistentry>
1220         <term>
1221                 <command><option>mpd_percent</option></command>
1222         </term>
1223         <listitem>
1224                 Percent of song's progress
1225         <para></para></listitem>
1226 </varlistentry>
1227
1228 <varlistentry>
1229         <term>
1230                 <command><option>mpd_random</option></command>
1231         </term>
1232         <listitem>
1233                 Random status (On/Off)
1234         <para></para></listitem>
1235 </varlistentry>
1236
1237 <varlistentry>
1238         <term>
1239                 <command><option>mpd_repeat</option></command>
1240         </term>
1241         <listitem>
1242                 Repeat status (On/Off)
1243         <para></para></listitem>
1244 </varlistentry>
1245
1246 <varlistentry>
1247         <term>
1248                 <command><option>mpd_track</option></command>
1249         </term>
1250         <listitem>
1251                 Prints the MPD track field
1252         <para></para></listitem>
1253 </varlistentry>
1254
1255 <varlistentry>
1256         <term>
1257                 <command><option>mpd_name</option></command>
1258         </term>
1259         <listitem>
1260                 Prints the MPD name field
1261         <para></para></listitem>
1262 </varlistentry>
1263
1264 <varlistentry>
1265         <term>
1266                 <command><option>mpd_file</option></command>
1267         </term>
1268         <listitem>
1269                 Prints the file name of the current MPD song
1270         <para></para></listitem>
1271 </varlistentry>
1272
1273 <varlistentry>
1274         <term>
1275                 <command><option>mpd_smart</option></command>
1276         </term>
1277         <listitem>
1278                 Prints the song name in either the form "artist - title" or file name, depending on whats available
1279         <para></para></listitem>
1280 </varlistentry>
1281
1282 <varlistentry>
1283         <term>
1284                 <command><option>new_mails</option></command>
1285         </term>
1286         <listitem>
1287                 Unread mail count in mail spool.
1288         <para></para></listitem>
1289 </varlistentry>
1290
1291 <varlistentry>
1292         <term>
1293                 <command><option>nodename</option></command>
1294         </term>
1295         <listitem>
1296                 Hostname
1297         <para></para></listitem>
1298 </varlistentry>
1299
1300 <varlistentry>
1301         <term>
1302                 <command><option>outlinecolor</option></command>
1303         <option>(color)</option>
1304         </term>
1305         <listitem>
1306                 Change outline color
1307         <para></para></listitem>
1308 </varlistentry>
1309
1310 <varlistentry>
1311         <term>
1312                 <command><option>pb_battery</option></command>
1313                 <option>item</option>
1314         </term>
1315         <listitem>
1316                 If running on Apple powerbook/ibook, display
1317                 information on battery status. The item parameter
1318                 specifies, what information to display. Exactly one item
1319                 must be specified. Valid items are:
1320                 <simplelist>
1321                         <member><command>status</command>:
1322                                 Display if battery is fully charged, charging,
1323                                 discharging or absent (running on AC)
1324                         </member>
1325                         <member><command>percent</command>:
1326                                 Display charge of battery in percent, if
1327                                 charging or discharging. Nothing will be
1328                                 displayed, if battery is fully charged
1329                                 or absent.
1330                         </member>
1331                         <member><command>time</command>:
1332                                 Display the time remaining until the battery
1333                                 will be fully charged or discharged at current
1334                                 rate.  Nothing is displayed, if battery is
1335                                 absent or if it's present but fully charged
1336                                 and not discharging.
1337                         </member>
1338                 </simplelist>
1339         <para></para></listitem>
1340 </varlistentry>
1341
1342 <varlistentry>
1343   <term>
1344     <command><option>platform</option></command>
1345   <option>(dev) type n</option>
1346   </term>
1347   <listitem>
1348     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.
1349   <para></para></listitem>
1350 </varlistentry>
1351
1352 <varlistentry>
1353         <term>
1354                 <command><option>pop3_unseen</option></command>
1355         <option>(args)</option>
1356         </term>
1357         <listitem>
1358                 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.
1359
1360                 <para></para></listitem>
1361 </varlistentry>
1362
1363 <varlistentry>
1364         <term>
1365                 <command><option>pop3_used</option></command>
1366         <option>(args)</option>
1367         </term>
1368         <listitem>
1369                 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.
1370
1371                 <para></para></listitem>
1372 </varlistentry>
1373
1374 <varlistentry>
1375         <term>
1376                 <command><option>pre_exec</option></command>
1377         <option>shell command</option>
1378         </term>
1379         <listitem>
1380                 Executes a shell command one time before conky displays anything and puts output as text.
1381         <para></para></listitem>
1382 </varlistentry>
1383
1384 <varlistentry>
1385         <term>
1386                 <command><option>processes</option></command>
1387         </term>
1388         <listitem>
1389                 Total processes (sleeping and running)
1390         <para></para></listitem>
1391 </varlistentry>
1392
1393 <varlistentry>
1394         <term>
1395                 <command><option>running_processes</option></command>
1396         </term>
1397         <listitem>
1398                 Running processes (not sleeping), requires Linux 2.6
1399         <para></para></listitem>
1400 </varlistentry>
1401
1402 <varlistentry>
1403         <term>
1404                 <command><option>shadecolor</option></command>
1405         <option>(color)</option>
1406         </term>
1407         <listitem>
1408                 Change shading color
1409         <para></para></listitem>
1410 </varlistentry>
1411
1412 <varlistentry>
1413         <term>
1414                 <command><option>stippled_hr</option></command>
1415         <option>(space)</option>
1416         </term>
1417         <listitem>
1418                 Stippled (dashed) horizontal line
1419         <para></para></listitem>
1420 </varlistentry>
1421
1422 <varlistentry>
1423         <term>
1424                 <command><option>swapbar</option></command>
1425         <option>(height),(width)</option>
1426         </term>
1427         <listitem>
1428                 Bar that shows amount of swap in use
1429         <para></para></listitem>
1430 </varlistentry>
1431
1432 <varlistentry>
1433         <term>
1434                 <command><option>swap</option></command>
1435         </term>
1436         <listitem>
1437                 Amount of swap in use
1438         <para></para></listitem>
1439 </varlistentry>
1440
1441 <varlistentry>
1442         <term>
1443                 <command><option>swapmax</option></command>
1444         </term>
1445         <listitem>
1446                 Total amount of swap
1447         <para></para></listitem>
1448 </varlistentry>
1449
1450 <varlistentry>
1451         <term>
1452                 <command><option>swapperc</option></command>
1453         </term>
1454         <listitem>
1455                 Percentage of swap in use
1456         <para></para></listitem>
1457 </varlistentry>
1458
1459 <varlistentry>
1460         <term>
1461                 <command><option>sysname</option></command>
1462         </term>
1463         <listitem>
1464                 System name, Linux for example
1465         <para></para></listitem>
1466 </varlistentry>
1467
1468 <varlistentry>
1469         <term>
1470                 <command><option>tcp_portmon</option></command>
1471                 <option>port_begin port_end item (index)</option>
1472                 <emphasis>(ip4 only at present)</emphasis>
1473         </term>
1474         <listitem>
1475                 TCP port monitor for specified local ports.  Port numbers must be in the range 1 to 65535. Valid items are:
1476                 <simplelist>
1477                         <member><command>count</command> - total number of connections in the range
1478                                 </member>
1479                         <member><command>rip</command> - remote ip address
1480                                 </member>
1481                         <member><command>rhost</command> - remote host name 
1482                                 </member>
1483                         <member><command>rport</command> - remote port number
1484                                 </member>
1485                         <member><command>rservice</command> - remote service name from /etc/services
1486                                 </member>
1487                         <member><command>lip</command> - local ip address
1488                                 </member>
1489                         <member><command>lhost</command> - local host name
1490                                 </member>
1491                         <member><command>lport</command> - local port number
1492                                 </member>
1493                         <member><command>lservice</command> - local service name from /etc/services
1494                                 </member>
1495                 </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.
1496                 <simplelist>
1497                         <member>Examples:</member>
1498                         <member><command>${tcp_portmon 6881 6999 count}</command> -
1499                                 displays the number of connections in the bittorrent port range</member>
1500                         <member><command>${tcp_portmon 22 22 rip 0}</command> -
1501                                 displays the remote host ip of the first sshd connection</member>
1502                         <member><command>${tcp_portmon 22 22 rip 9}</command> -
1503                                 displays the remote host ip of the tenth sshd connection</member>
1504                         <member><command>${tcp_portmon 1 1024 rhost 0}</command> -
1505                                 displays the remote host name of the first connection on a privileged port</member>
1506                         <member><command>${tcp_portmon 1 1024 rport 4}</command> -
1507                                 displays the remote host port of the fifth connection on a privileged port</member>
1508                         <member><command>${tcp_portmon 1 65535 lservice 14}</command> -
1509                                 displays the local service name of the fifteenth connection in the range of all ports</member>
1510                 </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. 
1511         </listitem>
1512 </varlistentry>
1513
1514 <varlistentry>
1515         <term>
1516                 <command><option>texeci</option></command>
1517                 <option>interval command</option>
1518         </term>
1519         <listitem>
1520                 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.
1521                 <para></para></listitem>
1522 </varlistentry>
1523
1524 <varlistentry>
1525         <term>
1526                 <command><option>offset</option></command>
1527                 <option>(pixels)</option>
1528         </term>
1529         <listitem>
1530                 Move text over by N pixels.  See also $voffset.
1531                 <para></para></listitem>
1532 </varlistentry>
1533
1534 <varlistentry>
1535         <term>
1536                 <command><option>rss</option></command>
1537                 <option>url delay_in_minutes action item_num</option>
1538         </term>
1539         <listitem>
1540                 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.
1541         <para></para></listitem>
1542 </varlistentry>
1543
1544 <varlistentry>
1545         <term>
1546                 <command><option>tab</option></command>
1547                 <option>(width, (start))</option>
1548         </term>
1549         <listitem>
1550         Puts a tab of the specified width, starting from column 'start'.
1551         <para></para></listitem>
1552 </varlistentry>
1553
1554 <varlistentry>
1555         <term>
1556                 <command><option>tail</option></command>
1557                 <option>logfile lines (interval)</option>
1558         </term>
1559         <listitem>
1560                 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.
1561         <para></para></listitem>
1562 </varlistentry>
1563
1564 <varlistentry>
1565         <term>
1566                 <command><option>time</option></command>
1567         <option>(format)</option>
1568         </term>
1569         <listitem>
1570                 Local time, see man strftime to get more information about format
1571         <para></para></listitem>
1572 </varlistentry>
1573
1574 <varlistentry>
1575         <term>
1576                 <command><option>utime</option></command>
1577         <option>(format)</option>
1578         </term>
1579         <listitem>
1580                 Display time in UTC (universal coordinate time).
1581         <para></para></listitem>
1582 </varlistentry>
1583
1584 <varlistentry>
1585         <term>
1586                 <command><option>tztime</option></command>
1587         <option>(timezone) (format)</option>
1588         </term>
1589         <listitem>
1590                 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.
1591         <para></para></listitem>
1592 </varlistentry>
1593
1594 <varlistentry>
1595         <term>
1596                 <command><option>totaldown</option></command>
1597         <option>net</option>
1598         </term>
1599         <listitem>
1600                 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.
1601         <para></para></listitem>
1602 </varlistentry>
1603
1604 <varlistentry>
1605         <term>
1606                 <command><option>top</option></command>
1607         <option>type, num</option>
1608         </term>
1609         <listitem>
1610                 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.
1611         <para></para></listitem>
1612 </varlistentry>
1613
1614 <varlistentry>
1615         <term>
1616                 <command><option>top_mem</option></command>
1617         <option>type, num</option>
1618         </term>
1619         <listitem>
1620                 Same as top, except sorted by mem usage instead of cpu
1621         <para></para></listitem>
1622 </varlistentry>
1623
1624 <varlistentry>
1625         <term>
1626                 <command><option>totalup</option></command>
1627         <option>net</option>
1628         </term>
1629         <listitem>
1630                 Total upload, this one too, may overflow
1631         <para></para></listitem>
1632 </varlistentry>
1633
1634 <varlistentry>
1635         <term>
1636                 <command><option>updates</option></command>
1637         <option>Number of updates</option>
1638         </term>
1639         <listitem>
1640                 for debugging
1641         <para></para></listitem>
1642 </varlistentry>
1643
1644 <varlistentry>
1645         <term>
1646                 <command><option>upspeed</option></command>
1647         <option>net</option>
1648         </term>
1649         <listitem>
1650                 Upload speed in kilobytes
1651         <para></para></listitem>
1652 </varlistentry>
1653
1654 <varlistentry>
1655         <term>
1656                 <command><option>upspeedf</option></command>
1657         <option>net</option>
1658         </term>
1659         <listitem>
1660                 Upload speed in kilobytes with one decimal
1661         <para></para></listitem>
1662 </varlistentry>
1663
1664 <varlistentry>
1665         <term>
1666                 <command><option>upspeedgraph</option></command>
1667                 <option>net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
1668         </term>
1669         <listitem>
1670                 Upload speed graph, colours defined in hex, minus the #.  If scale is non-zero, it becomes the scale for the graph.
1671         <para></para></listitem>
1672 </varlistentry>
1673
1674 <varlistentry>
1675         <term>
1676                 <command><option>uptime</option></command>
1677         </term>
1678         <listitem>
1679                 Uptime
1680         <para></para></listitem>
1681 </varlistentry>
1682
1683 <varlistentry>
1684         <term>
1685                 <command><option>uptime_short</option></command>
1686         </term>
1687         <listitem>
1688                 Uptime in a shorter format
1689         <para></para></listitem>
1690 </varlistentry>
1691
1692 <varlistentry>
1693         <term>
1694                 <command><option>voffset</option></command>
1695                 <option>(pixels)</option>
1696         </term>
1697         <listitem>
1698                 Change vertical offset by N pixels.  Negative values will cause text to overlap.  See also $offset.
1699                 <para></para></listitem>
1700 </varlistentry>
1701
1702 <varlistentry>
1703         <term>
1704                 <command><option>voltage_mv</option></command>
1705                 <option>(n)</option>
1706         </term>
1707         <listitem>
1708                 Returns CPU #n's voltage in mV. CPUs are
1709                 counted from 1. If omitted, the parameter
1710                 defaults to 1. 
1711                 <para></para></listitem>
1712 </varlistentry>
1713
1714 <varlistentry>
1715         <term>
1716                 <command><option>voltage_v</option></command>
1717                 <option>(n)</option>
1718         </term>
1719         <listitem>
1720                 Returns CPU #n's voltage in V. CPUs are
1721                 counted from 1. If omitted, the parameter
1722                 defaults to 1.
1723                 <para></para></listitem>
1724 </varlistentry>
1725
1726 <varlistentry>
1727         <term>
1728                 <command><option>wireless_essid</option></command>
1729                 <option>net</option>
1730         </term>
1731         <listitem>
1732                 Wireless access point ESSID (Linux only)
1733         <para></para></listitem>
1734 </varlistentry>
1735
1736 <varlistentry>
1737         <term>
1738                 <command><option>wireless_mode</option></command>
1739                 <option>net</option>
1740         </term>
1741         <listitem>
1742                 Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
1743         <para></para></listitem>
1744 </varlistentry>
1745
1746 <varlistentry>
1747         <term>
1748                 <command><option>wireless_bitrate</option></command>
1749                 <option>net</option>
1750         </term>
1751         <listitem>
1752                 Wireless bitrate (ie 11 Mb/s) (Linux only)
1753         <para></para></listitem>
1754 </varlistentry>
1755
1756 <varlistentry>
1757         <term>
1758                 <command><option>wireless_ap</option></command>
1759                 <option>net</option>
1760         </term>
1761         <listitem>
1762                 Wireless access point MAC address (Linux only)
1763         <para></para></listitem>
1764 </varlistentry>
1765
1766 <varlistentry>
1767         <term>
1768                 <command><option>wireless_link_qual</option></command>
1769                 <option>net</option>
1770         </term>
1771         <listitem>
1772                 Wireless link quality (Linux only)
1773         <para></para></listitem>
1774 </varlistentry>
1775
1776 <varlistentry>
1777         <term>
1778                 <command><option>wireless_link_qual_max</option></command>
1779                 <option>net</option>
1780         </term>
1781         <listitem>
1782                 Wireless link quality maximum value (Linux only)
1783         <para></para></listitem>
1784 </varlistentry>
1785
1786 <varlistentry>
1787         <term>
1788                 <command><option>wireless_link_qual_perc</option></command>
1789                 <option>net</option>
1790         </term>
1791         <listitem>
1792                 Wireless link quality in percents (Linux only)
1793         <para></para></listitem>
1794 </varlistentry>
1795
1796 <varlistentry>
1797         <term>
1798                 <command><option>wireless_link_bar</option></command>
1799                 <option>(height), (width) net</option>
1800         </term>
1801         <listitem>
1802                 Wireless link quality bar (Linux only)
1803         <para></para></listitem>
1804 </varlistentry>
1805
1806 <varlistentry>
1807         <term>
1808                 <command><option>xmms2_artist</option></command>
1809         </term>
1810         <listitem>
1811                 Artist in current XMMS2 song
1812         <para></para></listitem>
1813 </varlistentry>
1814
1815 <varlistentry>
1816         <term>
1817                 <command><option>xmms2_album</option></command>
1818         </term>
1819         <listitem>
1820                 Album in current XMMS2 song
1821         <para></para></listitem>
1822 </varlistentry>
1823
1824 <varlistentry>
1825         <term>
1826                 <command><option>xmms2_title</option></command>
1827         </term>
1828         <listitem>
1829                 Title in current XMMS2 song
1830         <para></para></listitem>
1831 </varlistentry>
1832
1833 <varlistentry>
1834         <term>
1835                 <command><option>xmms2_genre</option></command>
1836         </term>
1837         <listitem>
1838                 Genre in current XMMS2 song
1839         <para></para></listitem>
1840 </varlistentry>
1841
1842 <varlistentry>
1843         <term>
1844                 <command><option>xmms2_comment</option></command>
1845         </term>
1846         <listitem>
1847                 Comment in current XMMS2 song
1848         <para></para></listitem>
1849 </varlistentry>
1850
1851 <varlistentry>
1852         <term>
1853                 <command><option>xmms2_decoder</option></command>
1854         </term>
1855         <listitem>
1856                 Decoder plugin used
1857         <para></para></listitem>
1858 </varlistentry>
1859
1860 <varlistentry>
1861         <term>
1862                 <command><option>xmms2_transport</option></command>
1863         </term>
1864         <listitem>
1865                 Transport plugin used
1866         <para></para></listitem>
1867 </varlistentry>
1868
1869 <varlistentry>
1870         <term>
1871                 <command><option>xmms2_url</option></command>
1872         </term>
1873         <listitem>
1874                 Full path to current song
1875 <para></para></listitem>
1876 </varlistentry>
1877
1878 <varlistentry>
1879         <term>
1880                 <command><option>xmms2_tracknr</option></command>
1881         </term>
1882         <listitem>
1883                 Track number in current XMMS2 song
1884 <para></para></listitem>
1885 </varlistentry>
1886
1887 <varlistentry>
1888         <term>
1889                 <command><option>xmms2_bitrate</option></command>
1890         </term>
1891         <listitem>
1892         Bitrate of current song
1893         <para></para></listitem>
1894 </varlistentry>
1895
1896 <varlistentry>
1897         <term>
1898                 <command><option>xmms2_id</option></command>
1899         </term>
1900         <listitem>
1901                 XMMS2 id of current song
1902         <para></para></listitem>
1903 </varlistentry>
1904
1905 <varlistentry>
1906         <term>
1907                 <command><option>xmms2_duration</option></command>
1908         </term>
1909         <listitem>
1910                 Duration of current song
1911         <para></para></listitem>
1912 </varlistentry>
1913
1914 <varlistentry>
1915         <term>
1916                 <command><option>xmms2_elapsed</option></command>
1917         </term>
1918         <listitem>
1919                 Song's elapsed time
1920         <para></para></listitem>
1921 </varlistentry>
1922
1923 <varlistentry>
1924         <term>
1925                 <command><option>xmms2_size</option></command>
1926         </term>
1927         <listitem>
1928         Size of current song
1929         <para></para></listitem>
1930 </varlistentry>
1931
1932 <varlistentry>
1933         <term>
1934                 <command><option>xmms2_percent</option></command>
1935         </term>
1936         <listitem>
1937                 Percent of song's progress
1938         <para></para></listitem>
1939 </varlistentry>
1940
1941 <varlistentry>
1942         <term>
1943                 <command><option>xmms2_status</option></command>
1944         </term>
1945         <listitem>
1946                 XMMS2 status (Playing, Paused, Stopped, or Disconnected)
1947         <para></para></listitem>
1948 </varlistentry>
1949
1950 <varlistentry>
1951         <term>
1952                 <command><option>xmms2_bar</option></command>
1953         <option>(height),(width)</option>
1954         </term>
1955         <listitem>
1956                 Bar of XMMS2's progress
1957         <para></para></listitem>
1958 </varlistentry>
1959
1960 <varlistentry>
1961         <term>
1962                 <command><option>xmms2_smart</option></command>
1963         </term>
1964         <listitem>
1965                 Prints the song name in either the form "artist - title" or file name, depending on whats available
1966         <para></para></listitem>
1967 </varlistentry>
1968
1969 </variablelist>