Added
[monky] / doc / variables.xml
1 <variablelist>
2     <varlistentry>
3         <term>
4             <command>
5                 <option>acpiacadapter</option>
6             </command>
7         </term>
8         <listitem>ACPI ac adapter state. 
9         <para /></listitem>
10     </varlistentry>
11     <varlistentry>
12         <term>
13             <command>
14                 <option>acpifan</option>
15             </command>
16         </term>
17         <listitem>ACPI fan state 
18         <para /></listitem>
19     </varlistentry>
20     <varlistentry>
21         <term>
22             <command>
23                 <option>acpitemp</option>
24             </command>
25         </term>
26         <listitem>ACPI temperature in C. 
27         <para /></listitem>
28     </varlistentry>
29     <varlistentry>
30         <term>
31             <command>
32                 <option>addr</option>
33             </command>
34             <option>(interface)</option>
35         </term>
36         <listitem>IP address for an interface, or "No Address" if
37         no address is assigned. 
38         <para /></listitem>
39     </varlistentry>
40     <varlistentry>
41         <term>
42             <command>
43                 <option>addrs</option>
44             </command>
45             <option>(interface)</option>
46         </term>
47         <listitem>IP addresses for an interface (if one - works
48         like addr). Linux only. 
49         <para /></listitem>
50     </varlistentry>
51     <varlistentry>
52         <term>
53             <command>
54                 <option>adt746xcpu</option>
55             </command>
56         </term>
57         <listitem>CPU temperature from therm_adt746x 
58         <para /></listitem>
59     </varlistentry>
60     <varlistentry>
61         <term>
62             <command>
63                 <option>adt746xfan</option>
64             </command>
65         </term>
66         <listitem>Fan speed from therm_adt746x 
67         <para /></listitem>
68     </varlistentry>
69     <varlistentry>
70         <term>
71             <command>
72                 <option>alignc</option>
73             </command>
74             <option>(num)</option>
75         </term>
76         <listitem>Align text to centre 
77         <para /></listitem>
78     </varlistentry>
79     <varlistentry>
80         <term>
81             <command>
82                 <option>alignr</option>
83             </command>
84             <option>(num)</option>
85         </term>
86         <listitem>Right-justify text, with space of N 
87         <para /></listitem>
88     </varlistentry>
89     <varlistentry>
90         <term>
91             <command>
92                 <option>apcupsd</option>
93             </command>
94             <option>host</option>
95             <option>port</option>
96         </term>
97         <listitem>Sets up the connection to apcupsd daemon. Prints
98         nothing, defaults to localhost:3551 
99         <para /></listitem>
100     </varlistentry>
101     <varlistentry>
102         <term>
103             <command>
104                 <option>apcupsd_cable</option>
105             </command>
106         </term>
107         <listitem>Prints the UPS connection type. 
108         <para /></listitem>
109     </varlistentry>
110     <varlistentry>
111         <term>
112             <command>
113                 <option>apcupsd_charge</option>
114             </command>
115         </term>
116         <listitem>Current battery capacity in percent. 
117         <para /></listitem>
118     </varlistentry>
119     <varlistentry>
120         <term>
121             <command>
122                 <option>apcupsd_lastxfer</option>
123             </command>
124         </term>
125         <listitem>Reason for last transfer from line to battery. 
126         <para /></listitem>
127     </varlistentry>
128     <varlistentry>
129         <term>
130             <command>
131                 <option>apcupsd_linev</option>
132             </command>
133         </term>
134         <listitem>Nominal input voltage. 
135         <para /></listitem>
136     </varlistentry>
137     <varlistentry>
138         <term>
139             <command>
140                 <option>apcupsd_load</option>
141             </command>
142         </term>
143         <listitem>Current load in percent. 
144         <para /></listitem>
145     </varlistentry>
146     <varlistentry>
147         <term>
148             <command>
149                 <option>apcupsd_loadbar</option>
150             </command>
151         </term>
152         <listitem>Bar showing current load. 
153         <para /></listitem>
154     </varlistentry>
155     <varlistentry>
156         <term>
157             <command>
158                 <option>apcupsd_loadgauge</option>
159             </command>
160             <option>(height),(width)</option>
161         </term>
162         <listitem>Gauge that shows current load. 
163         <para /></listitem>
164     </varlistentry>
165     <varlistentry>
166         <term>
167             <command>
168                 <option>apcupsd_loadgraph</option>
169             </command>
170             <option>("normal"|"log") (height),(width) (gradient
171             colour 1) (gradient colour 2) (scale) (-t)</option>
172         </term>
173         <listitem>History graph of current load. 
174         <para /></listitem>
175     </varlistentry>
176     <varlistentry>
177         <term>
178             <command>
179                 <option>apcupsd_model</option>
180             </command>
181         </term>
182         <listitem>Prints the model of the UPS. 
183         <para /></listitem>
184     </varlistentry>
185     <varlistentry>
186         <term>
187             <command>
188                 <option>apcupsd_name</option>
189             </command>
190         </term>
191         <listitem>Prints the UPS user-defined name. 
192         <para /></listitem>
193     </varlistentry>
194     <varlistentry>
195         <term>
196             <command>
197                 <option>apcupsd_status</option>
198             </command>
199         </term>
200         <listitem>Prints current status (on-line, on-battery). 
201         <para /></listitem>
202     </varlistentry>
203     <varlistentry>
204         <term>
205             <command>
206                 <option>apcupsd_temp</option>
207             </command>
208         </term>
209         <listitem>Current internal temperature. 
210         <para /></listitem>
211     </varlistentry>
212     <varlistentry>
213         <term>
214             <command>
215                 <option>apcupsd_timeleft</option>
216             </command>
217         </term>
218         <listitem>Time left to run on battery. 
219         <para /></listitem>
220     </varlistentry>
221     <varlistentry>
222         <term>
223             <command>
224                 <option>apcupsd_upsmode</option>
225             </command>
226         </term>
227         <listitem>Prints the UPS mode (e.g. standalone). 
228         <para /></listitem>
229     </varlistentry>
230     <varlistentry>
231         <term>
232             <command>
233                 <option>apm_adapter</option>
234             </command>
235         </term>
236         <listitem>Display APM AC adapter status (FreeBSD only) 
237         <para /></listitem>
238     </varlistentry>
239     <varlistentry>
240         <term>
241             <command>
242                 <option>apm_battery_life</option>
243             </command>
244         </term>
245         <listitem>Display APM battery life in percent (FreeBSD
246         only) 
247         <para /></listitem>
248     </varlistentry>
249     <varlistentry>
250         <term>
251             <command>
252                 <option>apm_battery_time</option>
253             </command>
254         </term>
255         <listitem>Display remaining APM battery life in hh:mm:ss or
256         "unknown" if AC adapterstatus is on-line or charging
257         (FreeBSD only) 
258         <para /></listitem>
259     </varlistentry>
260     <varlistentry>
261         <term>
262             <command>
263                 <option>audacious_bar</option>
264             </command>
265             <option>(height),(width)</option>
266         </term>
267         <listitem>Progress bar 
268         <para /></listitem>
269     </varlistentry>
270     <varlistentry>
271         <term>
272             <command>
273                 <option>audacious_bitrate</option>
274             </command>
275         </term>
276         <listitem>Bitrate of current tune 
277         <para /></listitem>
278     </varlistentry>
279     <varlistentry>
280         <term>
281             <command>
282                 <option>audacious_channels</option>
283             </command>
284         </term>
285         <listitem>Number of audio channels of current tune 
286         <para /></listitem>
287     </varlistentry>
288     <varlistentry>
289         <term>
290             <command>
291                 <option>audacious_filename</option>
292             </command>
293         </term>
294         <listitem>Full path and filename of current tune 
295         <para /></listitem>
296     </varlistentry>
297     <varlistentry>
298         <term>
299             <command>
300                 <option>audacious_frequency</option>
301             </command>
302         </term>
303         <listitem>Sampling frequency of current tune 
304         <para /></listitem>
305     </varlistentry>
306     <varlistentry>
307         <term>
308             <command>
309                 <option>audacious_length</option>
310             </command>
311         </term>
312         <listitem>Total length of current tune as MM:SS 
313         <para /></listitem>
314     </varlistentry>
315     <varlistentry>
316         <term>
317             <command>
318                 <option>audacious_length_seconds</option>
319             </command>
320         </term>
321         <listitem>Total length of current tune in seconds 
322         <para /></listitem>
323     </varlistentry>
324     <varlistentry>
325         <term>
326             <command>
327                 <option>audacious_main_volume</option>
328             </command>
329         </term>
330         <listitem>The current volume fetched from Audacious 
331         <para /></listitem>
332     </varlistentry>
333     <varlistentry>
334         <term>
335             <command>
336                 <option>audacious_playlist_length</option>
337             </command>
338         </term>
339         <listitem>Number of tunes in playlist 
340         <para /></listitem>
341     </varlistentry>
342     <varlistentry>
343         <term>
344             <command>
345                 <option>audacious_playlist_position</option>
346             </command>
347         </term>
348         <listitem>Playlist position of current tune 
349         <para /></listitem>
350     </varlistentry>
351     <varlistentry>
352         <term>
353             <command>
354                 <option>audacious_position</option>
355             </command>
356         </term>
357         <listitem>Position of current tune (MM:SS) 
358         <para /></listitem>
359     </varlistentry>
360     <varlistentry>
361         <term>
362             <command>
363                 <option>audacious_position_seconds</option>
364             </command>
365         </term>
366         <listitem>Position of current tune in seconds 
367         <para /></listitem>
368     </varlistentry>
369     <varlistentry>
370         <term>
371             <command>
372                 <option>audacious_status</option>
373             </command>
374         </term>
375         <listitem>Player status (Playing/Paused/Stopped/Not
376         running) 
377         <para /></listitem>
378     </varlistentry>
379     <varlistentry>
380         <term>
381             <command>
382                 <option>audacious_title</option>
383             </command>
384             <option>(max length)</option>
385         </term>
386         <listitem>Title of current tune with optional maximum
387         length specifier 
388         <para /></listitem>
389     </varlistentry>
390     <varlistentry>
391         <term>
392             <command>
393                 <option>battery</option>
394             </command>
395             <option>(num)</option>
396         </term>
397         <listitem>Battery status and remaining percentage capacity
398         of ACPI or APM battery. ACPI battery number can be given as
399         argument (default is BAT0). 
400         <para /></listitem>
401     </varlistentry>
402     <varlistentry>
403         <term>
404             <command>
405                 <option>battery_bar</option>
406             </command>
407             <option>(height),(width) (num)</option>
408         </term>
409         <listitem>Battery percentage remaining of ACPI battery in a
410         bar. ACPI battery number can be given as argument (default
411         is BAT0). 
412         <para /></listitem>
413     </varlistentry>
414     <varlistentry>
415         <term>
416             <command>
417                 <option>battery_percent</option>
418             </command>
419             <option>(num)</option>
420         </term>
421         <listitem>Battery percentage remaining for ACPI battery.
422         ACPI battery number can be given as argument (default is
423         BAT0). 
424         <para /></listitem>
425     </varlistentry>
426     <varlistentry>
427         <term>
428             <command>
429                 <option>battery_short</option>
430             </command>
431             <option>(num)</option>
432         </term>
433         <listitem>Battery status and remaining percentage capacity
434         of ACPI or APM battery. ACPI battery number can be given as
435         argument (default is BAT0). This mode display a short
436         status, which means that C is displayed instead of
437         charging, D for discharging, F for full, N for not present,
438         E for empty and U for unknown. 
439         <para /></listitem>
440     </varlistentry>
441     <varlistentry>
442         <term>
443             <command>
444                 <option>battery_time</option>
445             </command>
446             <option>(num)</option>
447         </term>
448         <listitem>Battery charge/discharge time remaining of ACPI
449         battery. ACPI battery number can be given as argument
450         (default is BAT0). 
451         <para /></listitem>
452     </varlistentry>
453     <varlistentry>
454         <term>
455             <command>
456                 <option>bmpx_album</option>
457             </command>
458         </term>
459         <listitem>Album in current BMPx track 
460         <para /></listitem>
461     </varlistentry>
462     <varlistentry>
463         <term>
464             <command>
465                 <option>bmpx_artist</option>
466             </command>
467         </term>
468         <listitem>Artist in current BMPx track 
469         <para /></listitem>
470     </varlistentry>
471     <varlistentry>
472         <term>
473             <command>
474                 <option>bmpx_bitrate</option>
475             </command>
476         </term>
477         <listitem>Bitrate of the current BMPx track 
478         <para /></listitem>
479     </varlistentry>
480     <varlistentry>
481         <term>
482             <command>
483                 <option>bmpx_title</option>
484             </command>
485         </term>
486         <listitem>Title of the current BMPx track 
487         <para /></listitem>
488     </varlistentry>
489     <varlistentry>
490         <term>
491             <command>
492                 <option>bmpx_track</option>
493             </command>
494         </term>
495         <listitem>Track number of the current BMPx track 
496         <para /></listitem>
497     </varlistentry>
498     <varlistentry>
499         <term>
500             <command>
501                 <option>bmpx_uri</option>
502             </command>
503         </term>
504         <listitem>URI of the current BMPx track 
505         <para /></listitem>
506     </varlistentry>
507     <varlistentry>
508         <term>
509             <command>
510                 <option>buffers</option>
511             </command>
512         </term>
513         <listitem>Amount of memory buffered 
514         <para /></listitem>
515     </varlistentry>
516     <varlistentry>
517         <term>
518             <command>
519                 <option>cached</option>
520             </command>
521         </term>
522         <listitem>Amount of memory cached 
523         <para /></listitem>
524     </varlistentry>
525     <varlistentry>
526         <term>
527             <command>
528                 <option>color</option>
529             </command>
530             <option>(color)</option>
531         </term>
532         <listitem>Change drawing color to color 
533         <para /></listitem>
534     </varlistentry>
535     <varlistentry>
536         <term>
537             <command>
538                 <option>colorN</option>
539             </command>
540         </term>
541         <listitem>Change drawing color to colorN configuration
542         option, where N is a digit between 0 and 9, inclusively. 
543         <para /></listitem>
544     </varlistentry>
545     <varlistentry>
546         <term>
547             <command>
548                 <option>combine</option>
549             </command>
550             <option>var1 var2</option>
551         </term>
552         <listitem>Places the lines of var2 to the right of the
553         lines of var1 seperated by the chars that are put between
554         var1 and var2. For example: ${combine ${head /proc/cpuinfo
555         2} - ${head /proc/meminfo 1}} gives as output
556         "cpuinfo_line1 - meminfo_line1" on line 1 and
557         "cpuinfo_line2 -" on line 2. $combine vars can also be
558         nested to place more vars next to each other. 
559         <para /></listitem>
560     </varlistentry>
561     <varlistentry>
562         <term>
563             <command>
564                 <option>conky_build_arch</option>
565             </command>
566         </term>
567         <listitem>CPU architecture Conky was built for 
568         <para /></listitem>
569     </varlistentry>
570     <varlistentry>
571         <term>
572             <command>
573                 <option>conky_build_date</option>
574             </command>
575         </term>
576         <listitem>Date Conky was built 
577         <para /></listitem>
578     </varlistentry>
579     <varlistentry>
580         <term>
581             <command>
582                 <option>conky_version</option>
583             </command>
584         </term>
585         <listitem>Conky version 
586         <para /></listitem>
587     </varlistentry>
588     <varlistentry>
589         <term>
590             <command>
591                 <option>cpu</option>
592             </command>
593             <option>(cpuN)</option>
594         </term>
595         <listitem>CPU usage in percents. For SMP machines, the CPU
596         number can be provided as an argument. ${cpu cpu0} is the
597         total usage, and ${cpu cpuX} (X &gt;= 1) are individual
598         CPUs. 
599         <para /></listitem>
600     </varlistentry>
601     <varlistentry>
602         <term>
603             <command>
604                 <option>cpubar</option>
605             </command>
606             <option>(cpuN) (height),(width)</option>
607         </term>
608         <listitem>Bar that shows CPU usage, height is bar's height
609         in pixels. See $cpu for more info on SMP. 
610         <para /></listitem>
611     </varlistentry>
612     <varlistentry>
613         <term>
614             <command>
615                 <option>cpugauge</option>
616             </command>
617             <option>(cpuN) (height),(width)</option>
618         </term>
619         <listitem>Elliptical gauge that shows CPU usage, height and
620         width are gauge's vertical and horizontal axis
621         respectively. See $cpu for more info on SMP. 
622         <para /></listitem>
623     </varlistentry>
624     <varlistentry>
625         <term>
626             <command>
627                 <option>cpugraph</option>
628             </command>
629             <option>(cpuN) ("normal"|"log") (height),(width)
630             (gradient colour 1) (gradient colour 2) (scale)
631             (-t)</option>
632         </term>
633         <listitem>CPU usage graph, with optional colours in hex,
634         minus the #. See $cpu for more info on SMP. Uses a
635         logarithmic scale (to see small numbers) when you use "log"
636         instead of "normal". Takes the switch '-t' to use a
637         temperature gradient, which makes the gradient values
638         change depending on the amplitude of a particular graph
639         value (try it and see). 
640         <para /></listitem>
641     </varlistentry>
642     <varlistentry>
643         <term>
644             <command>
645                 <option>disk_protect</option>
646             </command>
647             <option>device</option>
648         </term>
649         <listitem>Disk protection status, if supported (needs
650         kernel-patch). Prints either "frozen" or "free " (note the
651         padding). 
652         <para /></listitem>
653     </varlistentry>
654     <varlistentry>
655         <term>
656             <command>
657                 <option>diskio</option>
658             </command>
659             <option>(device)</option>
660         </term>
661         <listitem>Displays current disk IO. Device is optional, and
662         takes the form of sda for /dev/sda. Individual partitions
663         are allowed. 
664         <para /></listitem>
665     </varlistentry>
666     <varlistentry>
667         <term>
668             <command>
669                 <option>diskio_read</option>
670             </command>
671             <option>(device)</option>
672         </term>
673         <listitem>Displays current disk IO for reads. Device as in
674         diskio. 
675         <para /></listitem>
676     </varlistentry>
677     <varlistentry>
678         <term>
679             <command>
680                 <option>diskio_write</option>
681             </command>
682             <option>(device)</option>
683         </term>
684         <listitem>Displays current disk IO for writes. Device as in
685         diskio. 
686         <para /></listitem>
687     </varlistentry>
688     <varlistentry>
689         <term>
690             <command>
691                 <option>diskiograph</option>
692             </command>
693             <option>(device) ("normal"|"log") (height),(width)
694             (gradient colour 1) (gradient colour 2) (scale)
695             (-t)</option>
696         </term>
697         <listitem>Disk IO graph, colours defined in hex, minus the
698         #. If scale is non-zero, it becomes the scale for the
699         graph. Uses a logarithmic scale (to see small numbers) when
700         you use "log" instead of "normal". Takes the switch '-t' to
701         use a temperature gradient, which makes the gradient values
702         change depending on the amplitude of a particular graph
703         value (try it and see). 
704         <para /></listitem>
705     </varlistentry>
706     <varlistentry>
707         <term>
708             <command>
709                 <option>diskiograph_read</option>
710             </command>
711             <option>(device) ("normal"|"log") (height),(width)
712             (gradient colour 1) (gradient colour 2) (scale)
713             (-t)</option>
714         </term>
715         <listitem>Disk IO graph for reads, colours defined in hex,
716         minus the #. If scale is non-zero, it becomes the scale for
717         the graph. Device as in diskio. Uses a logarithmic scale
718         (to see small numbers) when you use "log" instead of
719         "normal". Takes the switch '-t' to use a temperature
720         gradient, which makes the gradient values change depending
721         on the amplitude of a particular graph value (try it and
722         see). 
723         <para /></listitem>
724     </varlistentry>
725     <varlistentry>
726         <term>
727             <command>
728                 <option>diskiograph_write</option>
729             </command>
730             <option>(device) ("normal"|"log") (height),(width)
731             (gradient colour 1) (gradient colour 2) (scale)
732             (-t)</option>
733         </term>
734         <listitem>Disk IO graph for writes, colours defined in hex,
735         minus the #. If scale is non-zero, it becomes the scale for
736         the graph. Device as in diskio. Uses a logarithmic scale
737         (to see small numbers) when you use "log" instead of
738         "normal". Takes the switch '-t' to use a temperature
739         gradient, which makes the gradient values change depending
740         on the amplitude of a particular graph value (try it and
741         see). 
742         <para /></listitem>
743     </varlistentry>
744     <varlistentry>
745         <term>
746             <command>
747                 <option>downspeed</option>
748             </command>
749             <option>(net)</option>
750         </term>
751         <listitem>Download speed in KiB 
752         <para /></listitem>
753     </varlistentry>
754     <varlistentry>
755         <term>
756             <command>
757                 <option>downspeedf</option>
758             </command>
759             <option>(net)</option>
760         </term>
761         <listitem>Download speed in KiB with one decimal 
762         <para /></listitem>
763     </varlistentry>
764     <varlistentry>
765         <term>
766             <command>
767                 <option>downspeedgraph</option>
768             </command>
769             <option>(netdev) ("normal"|"log") (height),(width)
770             (gradient colour 1) (gradient colour 2) (scale)
771             (-t)</option>
772         </term>
773         <listitem>Download speed graph, colours defined in hex,
774         minus the #. If scale is non-zero, it becomes the scale for
775         the graph. Uses a logarithmic scale (to see small numbers)
776         when you use "log" instead of "normal". Takes the switch
777         '-t' to use a temperature gradient, which makes the
778         gradient values change depending on the amplitude of a
779         particular graph value (try it and see). 
780         <para /></listitem>
781     </varlistentry>
782     <varlistentry>
783         <term>
784             <command>
785                 <option>draft_mails</option>
786             </command>
787             <option>(maildir)</option>
788             <option>(interval)</option>
789         </term>
790         <listitem>Number of mails marked as draft in the specified
791         mailbox or mail spool if not. Only maildir type mailboxes
792         are supported, mbox type will return -1. 
793         <para /></listitem>
794     </varlistentry>
795     <varlistentry>
796         <term>
797             <command>
798                 <option>else</option>
799             </command>
800         </term>
801         <listitem>Text to show if any of the above are not true 
802         <para /></listitem>
803     </varlistentry>
804     <varlistentry>
805         <term>
806             <command>
807                 <option>endif</option>
808             </command>
809             <option />
810         </term>
811         <listitem>Ends an $if block. 
812         <para /></listitem>
813     </varlistentry>
814     <varlistentry>
815         <term>
816             <command>
817                 <option>entropy_avail</option>
818             </command>
819         </term>
820         <listitem>Current entropy available for crypto freaks 
821         <para /></listitem>
822     </varlistentry>
823     <varlistentry>
824         <term>
825             <command>
826                 <option>entropy_bar</option>
827             </command>
828             <option>(height),(width)</option>
829         </term>
830         <listitem>Normalized bar of available entropy for crypto
831         freaks 
832         <para /></listitem>
833     </varlistentry>
834     <varlistentry>
835         <term>
836             <command>
837                 <option>entropy_perc</option>
838             </command>
839         </term>
840         <listitem>Percentage of entropy available in comparison to
841         the poolsize 
842         <para /></listitem>
843     </varlistentry>
844     <varlistentry>
845         <term>
846             <command>
847                 <option>entropy_poolsize</option>
848             </command>
849         </term>
850         <listitem>Total size of system entropy pool for crypto
851         freaks 
852         <para /></listitem>
853     </varlistentry>
854     <varlistentry>
855         <term>
856             <command>
857                 <option>eval</option>
858             </command>
859             <option>string</option>
860         </term>
861         <listitem>Evalutates given string according to the rules of
862         TEXT interpretation, i.e. parsing any contained text object
863         specifications into their output, any occuring '$$' into a
864         single '$' and so on. The output is then being parsed
865         again. 
866         <para /></listitem>
867     </varlistentry>
868     <varlistentry>
869         <term>
870             <command>
871                 <option>eve</option>
872             </command>
873             <option>api_userid api_key character_id</option>
874         </term>
875         <listitem>Fetches your currently training skill from the
876         Eve Online API servers (http://www.eve-online.com/) and
877         displays the skill along with the remaining training time. 
878         <para /></listitem>
879     </varlistentry>
880     <varlistentry>
881         <term>
882             <command>
883                 <option>exec</option>
884             </command>
885             <option>command</option>
886         </term>
887         <listitem>Executes a shell command and displays the output
888         in conky. warning: this takes a lot more resources than
889         other variables. I'd recommend coding wanted behaviour in C
890         and posting a patch. 
891         <para /></listitem>
892     </varlistentry>
893     <varlistentry>
894         <term>
895             <command>
896                 <option>execbar</option>
897             </command>
898             <option>command</option>
899         </term>
900         <listitem>Same as exec, except if the first value return is
901         a value between 0-100, it will use that number for a bar.
902         The size for bars can be controlled via the
903         default_bar_size config setting. 
904         <para /></listitem>
905     </varlistentry>
906     <varlistentry>
907         <term>
908             <command>
909                 <option>execgauge</option>
910             </command>
911             <option>command</option>
912         </term>
913         <listitem>Same as exec, except if the first value returned
914         is a value between 0-100, it will use that number for a
915         gauge. The size for gauges can be controlled via the
916         default_gauge_size config setting. 
917         <para /></listitem>
918     </varlistentry>
919     <varlistentry>
920         <term>
921             <command>
922                 <option>execgraph</option>
923             </command>
924             <option>("normal"|"log") (-t) command</option>
925         </term>
926         <listitem>Same as execbar, but graphs values. Uses a
927         logaritmic scale when the log option is given (to see small
928         numbers). Values still have to be between 0 and 100. The
929         size for graphs can be controlled via the
930         default_graph_size config setting. Takes the switch '-t' to
931         use a temperature gradient, which makes the gradient values
932         change depending on the amplitude of a particular graph
933         value (try it and see). 
934         <para /></listitem>
935     </varlistentry>
936     <varlistentry>
937         <term>
938             <command>
939                 <option>execi</option>
940             </command>
941             <option>interval command</option>
942         </term>
943         <listitem>Same as exec but with specific interval. Interval
944         can't be less than update_interval in configuration. See
945         also $texeci 
946         <para /></listitem>
947     </varlistentry>
948     <varlistentry>
949         <term>
950             <command>
951                 <option>execibar</option>
952             </command>
953             <option>interval command</option>
954         </term>
955         <listitem>Same as execbar, except with an interval 
956         <para /></listitem>
957     </varlistentry>
958     <varlistentry>
959         <term>
960             <command>
961                 <option>execigauge</option>
962             </command>
963             <option>interval command</option>
964         </term>
965         <listitem>Same as execgauge, but takes an interval arg and
966         gauges values. 
967         <para /></listitem>
968     </varlistentry>
969     <varlistentry>
970         <term>
971             <command>
972                 <option>execigraph</option>
973             </command>
974             <option>interval ("normal"|"log") (-t) command</option>
975         </term>
976         <listitem>Same as execgraph, but takes an interval arg and
977         graphs values. 
978         <para /></listitem>
979     </varlistentry>
980     <varlistentry>
981         <term>
982             <command>
983                 <option>execp</option>
984             </command>
985             <option>command</option>
986         </term>
987         <listitem>Executes a shell command and displays the output
988         in conky. warning: this takes a lot more resources than
989         other variables. I'd recommend coding wanted behaviour in C
990         and posting a patch. This differs from $exec in that it
991         parses the output of the command, so you can insert things
992         like ${color red}hi!${color} in your script and have it
993         correctly parsed by Conky. Caveats: Conky parses and
994         evaluates the output of $execp every time Conky loops, and
995         then destroys all the objects. If you try to use anything
996         like $execi within an $execp statement, it will
997         functionally run at the same interval that the $execp
998         statement runs, as it is created and destroyed at every
999         interval. 
1000         <para /></listitem>
1001     </varlistentry>
1002     <varlistentry>
1003         <term>
1004             <command>
1005                 <option>execpi</option>
1006             </command>
1007             <option>interval command</option>
1008         </term>
1009         <listitem>Same as execp but with specific interval.
1010         Interval can't be less than update_interval in
1011         configuration. Note that the output from the $execpi
1012         command is still parsed and evaluated at every interval. 
1013         <para /></listitem>
1014     </varlistentry>
1015     <varlistentry>
1016         <term>
1017             <command>
1018                 <option>flagged_mails</option>
1019             </command>
1020             <option>(maildir)</option>
1021             <option>(interval)</option>
1022         </term>
1023         <listitem>Number of mails marked as flagged in the
1024         specified mailbox or mail spool if not. Only maildir type
1025         mailboxes are supported, mbox type will return -1. 
1026         <para /></listitem>
1027     </varlistentry>
1028     <varlistentry>
1029         <term>
1030             <command>
1031                 <option>font</option>
1032             </command>
1033             <option>(font)</option>
1034         </term>
1035         <listitem>Specify a different font. This new font will
1036         apply to the current line and everything following. You can
1037         use a $font with no arguments to change back to the default
1038         font (much like with $color) 
1039         <para /></listitem>
1040     </varlistentry>
1041     <varlistentry>
1042         <term>
1043             <command>
1044                 <option>forwarded_mails</option>
1045             </command>
1046             <option>(maildir)</option>
1047             <option>(interval)</option>
1048         </term>
1049         <listitem>Number of mails marked as forwarded in the
1050         specified mailbox or mail spool if not. Only maildir type
1051         mailboxes are supported, mbox type will return -1. 
1052         <para /></listitem>
1053     </varlistentry>
1054     <varlistentry>
1055         <term>
1056             <command>
1057                 <option>freq</option>
1058             </command>
1059             <option>(n)</option>
1060         </term>
1061         <listitem>Returns CPU #n's frequency in MHz. CPUs are
1062         counted from 1. If omitted, the parameter defaults to 1. 
1063         <para /></listitem>
1064     </varlistentry>
1065     <varlistentry>
1066         <term>
1067             <command>
1068                 <option>freq_g</option>
1069             </command>
1070             <option>(n)</option>
1071         </term>
1072         <listitem>Returns CPU #n's frequency in GHz. CPUs are
1073         counted from 1. If omitted, the parameter defaults to 1. 
1074         <para /></listitem>
1075     </varlistentry>
1076     <varlistentry>
1077         <term>
1078             <command>
1079                 <option>fs_bar</option>
1080             </command>
1081             <option>(height),(width) fs</option>
1082         </term>
1083         <listitem>Bar that shows how much space is used on a file
1084         system. height is the height in pixels. fs is any file on
1085         that file system. 
1086         <para /></listitem>
1087     </varlistentry>
1088     <varlistentry>
1089         <term>
1090             <command>
1091                 <option>fs_bar_free</option>
1092             </command>
1093             <option>(height),(width) fs</option>
1094         </term>
1095         <listitem>Bar that shows how much space is free on a file
1096         system. height is the height in pixels. fs is any file on
1097         that file system. 
1098         <para /></listitem>
1099     </varlistentry>
1100     <varlistentry>
1101         <term>
1102             <command>
1103                 <option>fs_free</option>
1104             </command>
1105             <option>(fs)</option>
1106         </term>
1107         <listitem>Free space on a file system available for users. 
1108         <para /></listitem>
1109     </varlistentry>
1110     <varlistentry>
1111         <term>
1112             <command>
1113                 <option>fs_free_perc</option>
1114             </command>
1115             <option>(fs)</option>
1116         </term>
1117         <listitem>Free percentage of space on a file system
1118         available for users. 
1119         <para /></listitem>
1120     </varlistentry>
1121     <varlistentry>
1122         <term>
1123             <command>
1124                 <option>fs_size</option>
1125             </command>
1126             <option>(fs)</option>
1127         </term>
1128         <listitem>File system size. 
1129         <para /></listitem>
1130     </varlistentry>
1131     <varlistentry>
1132         <term>
1133             <command>
1134                 <option>fs_type</option>
1135             </command>
1136             <option>(fs)</option>
1137         </term>
1138         <listitem>File system type. 
1139         <para /></listitem>
1140     </varlistentry>
1141     <varlistentry>
1142         <term>
1143             <command>
1144                 <option>fs_used</option>
1145             </command>
1146             <option>(fs)</option>
1147         </term>
1148         <listitem>File system used space. 
1149         <para /></listitem>
1150     </varlistentry>
1151     <varlistentry>
1152         <term>
1153             <command>
1154                 <option>fs_used_perc</option>
1155             </command>
1156             <option>(fs)</option>
1157         </term>
1158         <listitem>Percent of file system used space. 
1159         <para /></listitem>
1160     </varlistentry>
1161     <varlistentry>
1162         <term>
1163             <command>
1164                 <option>goto</option>
1165             </command>
1166             <option>x</option>
1167         </term>
1168         <listitem>The next element will be printed at position 'x'.
1169         
1170         <para /></listitem>
1171     </varlistentry>
1172     <varlistentry>
1173         <term>
1174             <command>
1175                 <option>gw_iface</option>
1176             </command>
1177         </term>
1178         <listitem>Displays the default route's interface or
1179         "multiple"/"none" accordingly. 
1180         <para /></listitem>
1181     </varlistentry>
1182     <varlistentry>
1183         <term>
1184             <command>
1185                 <option>gw_ip</option>
1186             </command>
1187         </term>
1188         <listitem>Displays the default gateway's IP or
1189         "multiple"/"none" accordingly. 
1190         <para /></listitem>
1191     </varlistentry>
1192     <varlistentry>
1193         <term>
1194             <command>
1195                 <option>hddtemp</option>
1196             </command>
1197             <option>dev, (host,(port))</option>
1198         </term>
1199         <listitem>Displays temperature of a selected hard disk
1200         drive as reported by the hddtemp daemon running on
1201         host:port. Default host is 127.0.0.1, default port is 7634.
1202         
1203         <para /></listitem>
1204     </varlistentry>
1205     <varlistentry>
1206         <term>
1207             <command>
1208                 <option>head</option>
1209             </command>
1210             <option>logfile lines (interval)</option>
1211         </term>
1212         <listitem>Displays first N lines of supplied text text
1213         file. If interval is not supplied, Conky assumes 2x Conky's
1214         interval. Max of 30 lines can be displayed, or until the
1215         text buffer is filled. 
1216         <para /></listitem>
1217     </varlistentry>
1218     <varlistentry>
1219         <term>
1220             <command>
1221                 <option>hr</option>
1222             </command>
1223             <option>(height)</option>
1224         </term>
1225         <listitem>Horizontal line, height is the height in pixels 
1226         <para /></listitem>
1227     </varlistentry>
1228     <varlistentry>
1229         <term>
1230             <command>
1231                 <option>hwmon</option>
1232             </command>
1233             <option>(dev) type n (factor offset)</option>
1234         </term>
1235         <listitem>Hwmon sensor from sysfs (Linux 2.6). Parameter
1236         dev may be omitted if you have only one hwmon device.
1237         Parameter type is either 'in' or 'vol' meaning voltage;
1238         'fan' meaning fan; 'temp' meaning temperature. Parameter n
1239         is number of the sensor. See /sys/class/hwmon/ on your
1240         local computer. The optional arguments 'factor' and
1241         'offset' allow precalculation of the raw input, which is
1242         being modified as follows: 'input = input * factor +
1243         offset'. Note that they have to be given as decimal values
1244         (i.e. contain at least one decimal place). 
1245         <para /></listitem>
1246     </varlistentry>
1247     <varlistentry>
1248         <term>
1249             <command>
1250                 <option>i2c</option>
1251             </command>
1252             <option>(dev) type n (factor offset)</option>
1253         </term>
1254         <listitem>I2C sensor from sysfs (Linux 2.6). Parameter dev
1255         may be omitted if you have only one I2C device. Parameter
1256         type is either 'in' or 'vol' meaning voltage; 'fan' meaning
1257         fan; 'temp' meaning temperature. Parameter n is number of
1258         the sensor. See /sys/bus/i2c/devices/ on your local
1259         computer. The optional arguments 'factor' and 'offset'
1260         allow precalculation of the raw input, which is being
1261         modified as follows: 'input = input * factor + offset'.
1262         Note that they have to be given as decimal values (i.e.
1263         contain at least one decimal place). 
1264         <para /></listitem>
1265     </varlistentry>
1266     <varlistentry>
1267         <term>
1268             <command>
1269                 <option>i8k_ac_status</option>
1270             </command>
1271             <option />
1272         </term>
1273         <listitem>If running the i8k kernel driver for Inspiron
1274         laptops, displays whether ac power is on, as listed in
1275         /proc/i8k (translated to human-readable). Beware that this
1276         is by default not enabled by i8k itself. 
1277         <para /></listitem>
1278     </varlistentry>
1279     <varlistentry>
1280         <term>
1281             <command>
1282                 <option>i8k_bios</option>
1283             </command>
1284             <option />
1285         </term>
1286         <listitem>If running the i8k kernel driver for Inspiron
1287         laptops, displays the bios version as listed in /proc/i8k. 
1288         <para /></listitem>
1289     </varlistentry>
1290     <varlistentry>
1291         <term>
1292             <command>
1293                 <option>i8k_buttons_status</option>
1294             </command>
1295             <option />
1296         </term>
1297         <listitem>If running the i8k kernel driver for Inspiron
1298         laptops, displays the volume buttons status as listed in
1299         /proc/i8k. 
1300         <para /></listitem>
1301     </varlistentry>
1302     <varlistentry>
1303         <term>
1304             <command>
1305                 <option>i8k_cpu_temp</option>
1306             </command>
1307             <option />
1308         </term>
1309         <listitem>If running the i8k kernel driver for Inspiron
1310         laptops, displays the cpu temperature in Celsius, as
1311         reported by /proc/i8k. 
1312         <para /></listitem>
1313     </varlistentry>
1314     <varlistentry>
1315         <term>
1316             <command>
1317                 <option>i8k_left_fan_rpm</option>
1318             </command>
1319             <option />
1320         </term>
1321         <listitem>If running the i8k kernel driver for Inspiron
1322         laptops, displays the left fan's rate of rotation, in
1323         revolutions per minute as listed in /proc/i8k. Beware, some
1324         laptops i8k reports these fans in reverse order. 
1325         <para /></listitem>
1326     </varlistentry>
1327     <varlistentry>
1328         <term>
1329             <command>
1330                 <option>i8k_left_fan_status</option>
1331             </command>
1332             <option />
1333         </term>
1334         <listitem>If running the i8k kernel driver for Inspiron
1335         laptops, displays the left fan status as listed in
1336         /proc/i8k (translated to human-readable). Beware, some
1337         laptops i8k reports these fans in reverse order. 
1338         <para /></listitem>
1339     </varlistentry>
1340     <varlistentry>
1341         <term>
1342             <command>
1343                 <option>i8k_right_fan_rpm</option>
1344             </command>
1345             <option />
1346         </term>
1347         <listitem>If running the i8k kernel driver for Inspiron
1348         laptops, displays the right fan's rate of rotation, in
1349         revolutions per minute as listed in /proc/i8k. Beware, some
1350         laptops i8k reports these fans in reverse order. 
1351         <para /></listitem>
1352     </varlistentry>
1353     <varlistentry>
1354         <term>
1355             <command>
1356                 <option>i8k_right_fan_status</option>
1357             </command>
1358             <option />
1359         </term>
1360         <listitem>If running the i8k kernel driver for Inspiron
1361         laptops, displays the right fan status as listed in
1362         /proc/i8k (translated to human-readable). Beware, some
1363         laptops i8k reports these fans in reverse order. 
1364         <para /></listitem>
1365     </varlistentry>
1366     <varlistentry>
1367         <term>
1368             <command>
1369                 <option>i8k_serial</option>
1370             </command>
1371             <option />
1372         </term>
1373         <listitem>If running the i8k kernel driver for Inspiron
1374         laptops, displays your laptop serial number as listed in
1375         /proc/i8k. 
1376         <para /></listitem>
1377     </varlistentry>
1378     <varlistentry>
1379         <term>
1380             <command>
1381                 <option>i8k_version</option>
1382             </command>
1383             <option />
1384         </term>
1385         <listitem>If running the i8k kernel driver for Inspiron
1386         laptops, displays the version formatting of /proc/i8k. 
1387         <para /></listitem>
1388     </varlistentry>
1389     <varlistentry>
1390         <term>
1391             <command>
1392                 <option>ibm_brightness</option>
1393             </command>
1394         </term>
1395         <listitem>If running the IBM ACPI, displays the brigtness
1396         of the laptops's LCD (0-7). 
1397         <para /></listitem>
1398     </varlistentry>
1399     <varlistentry>
1400         <term>
1401             <command>
1402                 <option>ibm_fan</option>
1403             </command>
1404         </term>
1405         <listitem>If running the IBM ACPI, displays the fan speed. 
1406         <para /></listitem>
1407     </varlistentry>
1408     <varlistentry>
1409         <term>
1410             <command>
1411                 <option>ibm_temps</option>
1412             </command>
1413             <option>N</option>
1414         </term>
1415         <listitem>If running the IBM ACPI, displays the
1416         temperatures from the IBM temperature sensors (N=0..7)
1417         Sensor 0 is on the CPU, 3 is on the GPU. 
1418         <para /></listitem>
1419     </varlistentry>
1420     <varlistentry>
1421         <term>
1422             <command>
1423                 <option>ibm_volume</option>
1424             </command>
1425         </term>
1426         <listitem>If running the IBM ACPI, displays the "master"
1427         volume, controlled by the volume keys (0-14). 
1428         <para /></listitem>
1429     </varlistentry>
1430     <varlistentry>
1431         <term>
1432             <command>
1433                 <option>iconv_start</option>
1434             </command>
1435             <option>codeset_from codeset_to</option>
1436         </term>
1437         <listitem>Convert text from one codeset to another using
1438         GNU iconv. Needs to be stopped with iconv_stop. 
1439         <para /></listitem>
1440     </varlistentry>
1441     <varlistentry>
1442         <term>
1443             <command>
1444                 <option>iconv_stop</option>
1445             </command>
1446             <option />
1447         </term>
1448         <listitem>Stop iconv codeset conversion. 
1449         <para /></listitem>
1450     </varlistentry>
1451     <varlistentry>
1452         <term>
1453             <command>
1454                 <option>if_empty</option>
1455             </command>
1456             <option>(var)</option>
1457         </term>
1458         <listitem>if conky variable VAR is empty, display
1459         everything between $if_empty and the matching $endif 
1460         <para /></listitem>
1461     </varlistentry>
1462     <varlistentry>
1463         <term>
1464             <command>
1465                 <option>if_existing</option>
1466             </command>
1467             <option>file (string)</option>
1468         </term>
1469         <listitem>if FILE exists, display everything between
1470         if_existing and the matching $endif. The optional second
1471         paramater checks for FILE containing the specified string
1472         and prints everything between $if_existing and the matching
1473         $endif. 
1474         <para /></listitem>
1475     </varlistentry>
1476     <varlistentry>
1477         <term>
1478             <command>
1479                 <option>if_gw</option>
1480             </command>
1481         </term>
1482         <listitem>if there is at least one default gateway, display
1483         everything between $if_gw and the matching $endif 
1484         <para /></listitem>
1485     </varlistentry>
1486     <varlistentry>
1487         <term>
1488             <command>
1489                 <option>if_match</option>
1490             </command>
1491             <option>expression</option>
1492         </term>
1493         <listitem>Evaluates the given boolean expression, printing
1494         everything between $if_match and the matching $endif
1495         depending on whether the evaluation returns true or not.
1496         Valid expressions consist of a left side, an operator and a
1497         right side. Left and right sides are being parsed for
1498         contained text objects before evaluation. Recognised left
1499         and right side types are: 
1500         <simplelist>
1501             <member>
1502             <command>double</command>: argument consists of only
1503             digits and a single dot.</member>
1504             <member>
1505             <command>long</command>: argument consists of only
1506             digits.</member>
1507             <member>
1508             <command>string</command>: argument is enclosed in
1509             quotation mark or the checks for double and long failed
1510             before.</member>
1511         </simplelist>Valid operands are: '&gt;', '&lt;', '&gt;=',
1512         '&lt;=', '==', '!='. 
1513         <para /></listitem>
1514     </varlistentry>
1515     <varlistentry>
1516         <term>
1517             <command>
1518                 <option>if_mixer_mute</option>
1519             </command>
1520             <option>(mixer)</option>
1521         </term>
1522         <listitem>If mixer exists, display everything between
1523         $if_mixer_mute and the matching $endif. If no mixer is
1524         specified, "Master" is used. 
1525         <para /></listitem>
1526     </varlistentry>
1527     <varlistentry>
1528         <term>
1529             <command>
1530                 <option>if_mounted</option>
1531             </command>
1532             <option>(mountpoint)</option>
1533         </term>
1534         <listitem>if MOUNTPOINT is mounted, display everything
1535         between $if_mounted and the matching $endif 
1536         <para /></listitem>
1537     </varlistentry>
1538     <varlistentry>
1539         <term>
1540             <command>
1541                 <option>if_mpd_playing</option>
1542             </command>
1543         </term>
1544         <listitem>if mpd is playing or paused, display everything
1545         between $if_mpd_playing and the matching $endif 
1546         <para /></listitem>
1547     </varlistentry>
1548     <varlistentry>
1549         <term>
1550             <command>
1551                 <option>if_running</option>
1552             </command>
1553             <option>(process)</option>
1554         </term>
1555         <listitem>if PROCESS is running, display everything
1556         $if_running and the matching $endif. This uses the
1557         ``pidof'' command, so the -x switch is also supported. 
1558         <para /></listitem>
1559     </varlistentry>
1560     <varlistentry>
1561         <term>
1562             <command>
1563                 <option>if_smapi_bat_installed</option>
1564             </command>
1565             <option>(INDEX)</option>
1566         </term>
1567         <listitem>when using smapi, if the battery with index INDEX
1568         is installed, display everything between
1569         $if_smapi_bat_installed and the matching $endif 
1570         <para /></listitem>
1571     </varlistentry>
1572     <varlistentry>
1573         <term>
1574             <command>
1575                 <option>if_up</option>
1576             </command>
1577             <option>(interface)</option>
1578         </term>
1579         <listitem>if INTERFACE exists and is up, display everything
1580         between $if_up and the matching $endif 
1581         <para /></listitem>
1582     </varlistentry>
1583     <varlistentry>
1584         <term>
1585             <command>
1586                 <option>if_updatenr</option>
1587             </command>
1588             <option>(updatenr)</option>
1589         </term>
1590         <listitem>If it's the UPDATENR-th time that conky updates,
1591         display everything between $if_updatenr and the matching
1592         $endif. The counter resets when the highest UPDATENR is
1593         reached. Example : "{$if_updatenr 1}foo$endif{$if_updatenr
1594         2}bar$endif{$if_updatenr 4}$endif" shows foo 25% of the
1595         time followed by bar 25% of the time followed by nothing
1596         the other half of the time. 
1597         <para /></listitem>
1598     </varlistentry>
1599     <varlistentry>
1600         <term>
1601             <command>
1602                 <option>if_xmms2_connected</option>
1603             </command>
1604         </term>
1605         <listitem>Display everything between $if_xmms2_connected
1606         and the matching $endif if xmms2 is running. 
1607         <para /></listitem>
1608     </varlistentry>
1609     <varlistentry>
1610         <term>
1611             <command>
1612                 <option>image</option>
1613             </command>
1614             <option>&lt;path to image&gt; (-p x,y) (-s WxH) (-n)
1615             (-f interval)</option>
1616         </term>
1617         <listitem>Renders an image from the path specified using
1618         Imlib2. Takes 4 optional arguments: a position, a size, a
1619         no-cache switch, and a cache flush interval. Changing the
1620         x,y position will move the position of the image, and
1621         changing the WxH will scale the image. If you specify the
1622         no-cache flag (-n), the image will not be cached.
1623         Alternately, you can specify the -f int switch to specify a
1624         cache flust interval for a particular image. Example:
1625         ${image /home/brenden/cheeseburger.jpg -p 20,20 -s 200x200}
1626         will render 'cheeseburger.jpg' at (20,20) scaled to 200x200
1627         pixels. Conky does not make any attempt to adjust the
1628         position (or any other formatting) of images, they are just
1629         rendered as per the arguments passed. The only reason
1630         $image is part of the TEXT section, is to allow for runtime
1631         modifications, through $execp $lua_parse, $lua_read_parse,
1632         or some other method. 
1633         <para /></listitem>
1634     </varlistentry>
1635     <varlistentry>
1636         <term>
1637             <command>
1638                 <option>imap_messages</option>
1639             </command>
1640             <option>(args)</option>
1641         </term>
1642         <listitem>Displays the number of messages in your global
1643         IMAP inbox by default. You can define individual IMAP
1644         inboxes seperately by passing arguments to this object.
1645         Arguments are: "host user pass [-i interval (in seconds)]
1646         [-f folder] [-p port] [-e command] [-r retries]". Default
1647         port is 143, default folder is 'INBOX', default interval is
1648         5 minutes, and default number of retries before giving up
1649         is 5. If the password is supplied as '*', you will be
1650         prompted to enter the password when Conky starts. 
1651         <para /></listitem>
1652     </varlistentry>
1653     <varlistentry>
1654         <term>
1655             <command>
1656                 <option>imap_unseen</option>
1657             </command>
1658             <option>(args)</option>
1659         </term>
1660         <listitem>Displays the number of unseen messages in your
1661         global IMAP inbox by default. You can define individual
1662         IMAP inboxes seperately by passing arguments to this
1663         object. Arguments are: "host user pass [-i interval (in
1664         seconds)] [-f folder] [-p port] [-e command] [-r retries]".
1665         Default port is 143, default folder is 'INBOX', default
1666         interval is 5 minutes, and default number of retries before
1667         giving up is 5. If the password is supplied as '*', you
1668         will be prompted to enter the password when Conky starts. 
1669         <para /></listitem>
1670     </varlistentry>
1671     <varlistentry>
1672         <term>
1673             <command>
1674                 <option>ioscheduler</option>
1675             </command>
1676             <option>disk</option>
1677         </term>
1678         <listitem>Prints the current ioscheduler used for the given
1679         disk name (i.e. e.g. "hda" or "sdb") 
1680         <para /></listitem>
1681     </varlistentry>
1682     <varlistentry>
1683         <term>
1684             <command>
1685                 <option>kernel</option>
1686             </command>
1687         </term>
1688         <listitem>Kernel version 
1689         <para /></listitem>
1690     </varlistentry>
1691     <varlistentry>
1692         <term>
1693             <command>
1694                 <option>laptop_mode</option>
1695             </command>
1696         </term>
1697         <listitem>The value of /proc/sys/vm/laptop_mode 
1698         <para /></listitem>
1699     </varlistentry>
1700     <varlistentry>
1701         <term>
1702             <command>
1703                 <option>lines</option>
1704             </command>
1705             <option>textfile</option>
1706         </term>
1707         <listitem>Displays the number of lines in the given file 
1708         <para /></listitem>
1709     </varlistentry>
1710     <varlistentry>
1711         <term>
1712             <command>
1713                 <option>loadavg</option>
1714             </command>
1715         </term>
1716         <listitem>(1,2,3)&gt; System load average, 1 is for past 1
1717         minute, 2 for past 5 minutes and 3 for past 15 minutes. 
1718         <para /></listitem>
1719     </varlistentry>
1720     <varlistentry>
1721         <term>
1722             <command>
1723                 <option>loadgraph</option>
1724             </command>
1725             <option>("normal"|"log") (height),(width) (gradient
1726             colour 1) (gradient colour 2) (scale) (-t)</option>
1727         </term>
1728         <listitem>Load1 average graph, similar to xload, with
1729         optional colours in hex, minus the #. Uses a logarithmic
1730         scale (to see small numbers) when you use "log" instead of
1731         "normal". Takes the switch '-t' to use a temperature
1732         gradient, which makes the gradient values change depending
1733         on the amplitude of a particular graph value (try it and
1734         see). 
1735         <para /></listitem>
1736     </varlistentry>
1737     <varlistentry>
1738         <term>
1739             <command>
1740                 <option>lua</option>
1741             </command>
1742             <option>function_name (function parameters)</option>
1743         </term>
1744         <listitem>Executes a Lua function with given parameters,
1745         then prints the returned string. See also 'lua_load' on how
1746         to load scripts. 
1747         <para /></listitem>
1748     </varlistentry>
1749     <varlistentry>
1750         <term>
1751             <command>
1752                 <option>lua_bar</option>
1753             </command>
1754             <option>(height, width) function_name (function
1755             parameters)</option>
1756         </term>
1757         <listitem>Executes a Lua function with given parameters and
1758         draws a bar. Expects result value to be an integer between
1759         0 and 100. See also 'lua_load' on how to load scripts. 
1760         <para /></listitem>
1761     </varlistentry>
1762     <varlistentry>
1763         <term>
1764             <command>
1765                 <option>lua_gauge</option>
1766             </command>
1767             <option>(height, width) function_name (function
1768             parameters)</option>
1769         </term>
1770         <listitem>Executes a Lua function with given parameters and
1771         draws a gauge. Expects result value to be an integer
1772         between 0 and 100. See also 'lua_load' on how to load
1773         scripts. 
1774         <para /></listitem>
1775     </varlistentry>
1776     <varlistentry>
1777         <term>
1778             <command>
1779                 <option>lua_graph</option>
1780             </command>
1781             <option>function_name (function parameters)
1782             ("normal"|"log") (height),(width) (gradient colour 1)
1783             (gradient colour 2) (scale) (-t)</option>
1784         </term>
1785         <listitem>Executes a Lua function with given parameters and
1786         draws a graph. Expects result value to be any number, and
1787         by default will scale to show the full range. See also
1788         'lua_load' on how to load scripts. Takes the switch '-t' to
1789         use a temperature gradient, which makes the gradient values
1790         change depending on the amplitude of a particular graph
1791         value (try it and see). 
1792         <para /></listitem>
1793     </varlistentry>
1794     <varlistentry>
1795         <term>
1796             <command>
1797                 <option>lua_parse</option>
1798             </command>
1799             <option>function_name (function parameters)</option>
1800         </term>
1801         <listitem>Executes a Lua function with given parameters as
1802         per $lua, then parses and prints the result value as per
1803         the syntax for Conky's TEXT section. See also 'lua_load' on
1804         how to load scripts. 
1805         <para /></listitem>
1806     </varlistentry>
1807     <varlistentry>
1808         <term>
1809             <command>
1810                 <option>lua_read_parse</option>
1811             </command>
1812             <option>function_name (conky text)</option>
1813         </term>
1814         <listitem>Executes a Lua function per $lua, except takes a
1815         2nd argument which is first evaluated as per Conky's TEXT
1816         section and passed to the function first. The return value
1817         is then parsed and prints the result value as per the
1818         syntax for Conky's TEXT section. See also 'lua_load' on how
1819         to load scripts. 
1820         <para /></listitem>
1821     </varlistentry>
1822     <varlistentry>
1823         <term>
1824             <command>
1825                 <option>machine</option>
1826             </command>
1827         </term>
1828         <listitem>Machine, i686 for example 
1829         <para /></listitem>
1830     </varlistentry>
1831     <varlistentry>
1832         <term>
1833             <command>
1834                 <option>mails</option>
1835             </command>
1836             <option>(mailbox)</option>
1837             <option>(interval)</option>
1838         </term>
1839         <listitem>Mail count in the specified mailbox or your mail
1840         spool if not. Both mbox and maildir type mailboxes are
1841         supported. You can use a program like fetchmail to get
1842         mails from some server using your favourite protocol. See
1843         also new_mails. 
1844         <para /></listitem>
1845     </varlistentry>
1846     <varlistentry>
1847         <term>
1848             <command>
1849                 <option>mboxscan</option>
1850             </command>
1851             <option>(-n number of messages to print) (-fw from
1852             width) (-sw subject width) mbox</option>
1853         </term>
1854         <listitem>Print a summary of recent messages in an mbox
1855         format mailbox. mbox parameter is the filename of the
1856         mailbox (can be encapsulated using '"', ie. ${mboxscan -n
1857         10 "/home/brenden/some box"} 
1858         <para /></listitem>
1859     </varlistentry>
1860     <varlistentry>
1861         <term>
1862             <command>
1863                 <option>mem</option>
1864             </command>
1865         </term>
1866         <listitem>Amount of memory in use 
1867         <para /></listitem>
1868     </varlistentry>
1869     <varlistentry>
1870         <term>
1871             <command>
1872                 <option>membar</option>
1873             </command>
1874             <option>(height),(width)</option>
1875         </term>
1876         <listitem>Bar that shows amount of memory in use 
1877         <para /></listitem>
1878     </varlistentry>
1879     <varlistentry>
1880         <term>
1881             <command>
1882                 <option>memeasyfree</option>
1883             </command>
1884         </term>
1885         <listitem>Amount of free memory including the memory that
1886         is very easily freed (buffers/cache) 
1887         <para /></listitem>
1888     </varlistentry>
1889     <varlistentry>
1890         <term>
1891             <command>
1892                 <option>memfree</option>
1893             </command>
1894         </term>
1895         <listitem>Amount of free memory 
1896         <para /></listitem>
1897     </varlistentry>
1898     <varlistentry>
1899         <term>
1900             <command>
1901                 <option>memgauge</option>
1902             </command>
1903             <option>(height),(width)</option>
1904         </term>
1905         <listitem>Gauge that shows amount of memory in use (see
1906         cpugauge) 
1907         <para /></listitem>
1908     </varlistentry>
1909     <varlistentry>
1910         <term>
1911             <command>
1912                 <option>memgraph</option>
1913             </command>
1914             <option>("normal"|"log") (height),(width) (gradient
1915             colour 1) (gradient colour 2) (scale) (-t)</option>
1916         </term>
1917         <listitem>Memory usage graph. Uses a logarithmic scale (to
1918         see small numbers) when you use "log" instead of "normal".
1919         Takes the switch '-t' to use a temperature gradient, which
1920         makes the gradient values change depending on the amplitude
1921         of a particular graph value (try it and see). 
1922         <para /></listitem>
1923     </varlistentry>
1924     <varlistentry>
1925         <term>
1926             <command>
1927                 <option>memmax</option>
1928             </command>
1929         </term>
1930         <listitem>Total amount of memory 
1931         <para /></listitem>
1932     </varlistentry>
1933     <varlistentry>
1934         <term>
1935             <command>
1936                 <option>memperc</option>
1937             </command>
1938         </term>
1939         <listitem>Percentage of memory in use 
1940         <para /></listitem>
1941     </varlistentry>
1942     <varlistentry>
1943         <term>
1944             <command>
1945                 <option>mixer</option>
1946             </command>
1947             <option>(device)</option>
1948         </term>
1949         <listitem>Prints the mixer value as reported by the OS.
1950         Default mixer is "vol", but you can specify one of the
1951         following optional arguments: "vol", "bass", "treble",
1952         "synth", "pcm", "speaker", "line", "mic", "cd", "mix",
1953         "pcm2", "rec", "igain", "ogain", "line1", "line2", "line3",
1954         "dig1", "dig2", "dig3", "phin", "phout", "video", "radio",
1955         "monitor". Refer to the definition of SOUND_DEVICE_NAMES in
1956         &lt;linux/soundcard.h&gt; (on Linux), &lt;soundcard.h&gt;
1957         (on OpenBSD), or &lt;sys/soundcard.h&gt; to find the exact
1958         options available on your system. 
1959         <para /></listitem>
1960     </varlistentry>
1961     <varlistentry>
1962         <term>
1963             <command>
1964                 <option>mixerbar</option>
1965             </command>
1966             <option>(device)</option>
1967         </term>
1968         <listitem>Displays mixer value in a bar as reported by the
1969         OS. See docs for $mixer for details on arguments. 
1970         <para /></listitem>
1971     </varlistentry>
1972     <varlistentry>
1973         <term>
1974             <command>
1975                 <option>mixerl</option>
1976             </command>
1977             <option>(device)</option>
1978         </term>
1979         <listitem>Prints the left channel mixer value as reported
1980         by the OS. See docs for $mixer for details on arguments. 
1981         <para /></listitem>
1982     </varlistentry>
1983     <varlistentry>
1984         <term>
1985             <command>
1986                 <option>mixerlbar</option>
1987             </command>
1988             <option>(device)</option>
1989         </term>
1990         <listitem>Displays the left channel mixer value in a bar as
1991         reported by the OS. See docs for $mixer for details on
1992         arguments. 
1993         <para /></listitem>
1994     </varlistentry>
1995     <varlistentry>
1996         <term>
1997             <command>
1998                 <option>mixerr</option>
1999             </command>
2000             <option>(device)</option>
2001         </term>
2002         <listitem>Prints the right channel mixer value as reported
2003         by the OS. See docs for $mixer for details on arguments. 
2004         <para /></listitem>
2005     </varlistentry>
2006     <varlistentry>
2007         <term>
2008             <command>
2009                 <option>mixerrbar</option>
2010             </command>
2011             <option>(device)</option>
2012         </term>
2013         <listitem>Displays the right channel mixer value in a bar
2014         as reported by the OS. See docs for $mixer for details on
2015         arguments. 
2016         <para /></listitem>
2017     </varlistentry>
2018     <varlistentry>
2019         <term>
2020             <command>
2021                 <option>moc_album</option>
2022             </command>
2023         </term>
2024         <listitem>Album of the current MOC song 
2025         <para /></listitem>
2026     </varlistentry>
2027     <varlistentry>
2028         <term>
2029             <command>
2030                 <option>moc_artist</option>
2031             </command>
2032         </term>
2033         <listitem>Artist of the current MOC song 
2034         <para /></listitem>
2035     </varlistentry>
2036     <varlistentry>
2037         <term>
2038             <command>
2039                 <option>moc_bitrate</option>
2040             </command>
2041         </term>
2042         <listitem>Bitrate in the current MOC song 
2043         <para /></listitem>
2044     </varlistentry>
2045     <varlistentry>
2046         <term>
2047             <command>
2048                 <option>moc_curtime</option>
2049             </command>
2050         </term>
2051         <listitem>Current time of the current MOC song 
2052         <para /></listitem>
2053     </varlistentry>
2054     <varlistentry>
2055         <term>
2056             <command>
2057                 <option>moc_file</option>
2058             </command>
2059         </term>
2060         <listitem>File name of the current MOC song 
2061         <para /></listitem>
2062     </varlistentry>
2063     <varlistentry>
2064         <term>
2065             <command>
2066                 <option>moc_rate</option>
2067             </command>
2068         </term>
2069         <listitem>Rate of the current MOC song 
2070         <para /></listitem>
2071     </varlistentry>
2072     <varlistentry>
2073         <term>
2074             <command>
2075                 <option>moc_song</option>
2076             </command>
2077         </term>
2078         <listitem>The current song name being played in MOC. 
2079         <para /></listitem>
2080     </varlistentry>
2081     <varlistentry>
2082         <term>
2083             <command>
2084                 <option>moc_state</option>
2085             </command>
2086         </term>
2087         <listitem>Current state of MOC; playing, stopped etc. 
2088         <para /></listitem>
2089     </varlistentry>
2090     <varlistentry>
2091         <term>
2092             <command>
2093                 <option>moc_timeleft</option>
2094             </command>
2095         </term>
2096         <listitem>Time left in the current MOC song 
2097         <para /></listitem>
2098     </varlistentry>
2099     <varlistentry>
2100         <term>
2101             <command>
2102                 <option>moc_title</option>
2103             </command>
2104         </term>
2105         <listitem>Title of the current MOC song 
2106         <para /></listitem>
2107     </varlistentry>
2108     <varlistentry>
2109         <term>
2110             <command>
2111                 <option>moc_totaltime</option>
2112             </command>
2113         </term>
2114         <listitem>Total length of the current MOC song 
2115         <para /></listitem>
2116     </varlistentry>
2117     <varlistentry>
2118         <term>
2119             <command>
2120                 <option>monitor</option>
2121             </command>
2122         </term>
2123         <listitem>Number of the monitor on which conky is running 
2124         <para /></listitem>
2125     </varlistentry>
2126     <varlistentry>
2127         <term>
2128             <command>
2129                 <option>monitor_number</option>
2130             </command>
2131         </term>
2132         <listitem>Number of monitors 
2133         <para /></listitem>
2134     </varlistentry>
2135     <varlistentry>
2136         <term>
2137             <command>
2138                 <option>mpd_album</option>
2139             </command>
2140         </term>
2141         <listitem>Album in current MPD song 
2142         <para /></listitem>
2143     </varlistentry>
2144     <varlistentry>
2145         <term>
2146             <command>
2147                 <option>mpd_artist</option>
2148             </command>
2149         </term>
2150         <listitem>Artist in current MPD song must be enabled at
2151         compile 
2152         <para /></listitem>
2153     </varlistentry>
2154     <varlistentry>
2155         <term>
2156             <command>
2157                 <option>mpd_bar</option>
2158             </command>
2159             <option>(height),(width)</option>
2160         </term>
2161         <listitem>Bar of mpd's progress 
2162         <para /></listitem>
2163     </varlistentry>
2164     <varlistentry>
2165         <term>
2166             <command>
2167                 <option>mpd_bitrate</option>
2168             </command>
2169         </term>
2170         <listitem>Bitrate of current song 
2171         <para /></listitem>
2172     </varlistentry>
2173     <varlistentry>
2174         <term>
2175             <command>
2176                 <option>mpd_elapsed</option>
2177             </command>
2178         </term>
2179         <listitem>Song's elapsed time 
2180         <para /></listitem>
2181     </varlistentry>
2182     <varlistentry>
2183         <term>
2184             <command>
2185                 <option>mpd_file</option>
2186             </command>
2187         </term>
2188         <listitem>Prints the file name of the current MPD song 
2189         <para /></listitem>
2190     </varlistentry>
2191     <varlistentry>
2192         <term>
2193             <command>
2194                 <option>mpd_length</option>
2195             </command>
2196         </term>
2197         <listitem>Song's length 
2198         <para /></listitem>
2199     </varlistentry>
2200     <varlistentry>
2201         <term>
2202             <command>
2203                 <option>mpd_name</option>
2204             </command>
2205         </term>
2206         <listitem>Prints the MPD name field 
2207         <para /></listitem>
2208     </varlistentry>
2209     <varlistentry>
2210         <term>
2211             <command>
2212                 <option>mpd_percent</option>
2213             </command>
2214         </term>
2215         <listitem>Percent of song's progress 
2216         <para /></listitem>
2217     </varlistentry>
2218     <varlistentry>
2219         <term>
2220             <command>
2221                 <option>mpd_random</option>
2222             </command>
2223         </term>
2224         <listitem>Random status (On/Off) 
2225         <para /></listitem>
2226     </varlistentry>
2227     <varlistentry>
2228         <term>
2229             <command>
2230                 <option>mpd_repeat</option>
2231             </command>
2232         </term>
2233         <listitem>Repeat status (On/Off) 
2234         <para /></listitem>
2235     </varlistentry>
2236     <varlistentry>
2237         <term>
2238             <command>
2239                 <option>mpd_smart</option>
2240             </command>
2241             <option>(max length)</option>
2242         </term>
2243         <listitem>Prints the song name in either the form "artist -
2244         title" or file name, depending on whats available 
2245         <para /></listitem>
2246     </varlistentry>
2247     <varlistentry>
2248         <term>
2249             <command>
2250                 <option>mpd_status</option>
2251             </command>
2252         </term>
2253         <listitem>Playing, stopped, et cetera. 
2254         <para /></listitem>
2255     </varlistentry>
2256     <varlistentry>
2257         <term>
2258             <command>
2259                 <option>mpd_title</option>
2260             </command>
2261             <option>(max length)</option>
2262         </term>
2263         <listitem>Title of current MPD song 
2264         <para /></listitem>
2265     </varlistentry>
2266     <varlistentry>
2267         <term>
2268             <command>
2269                 <option>mpd_track</option>
2270             </command>
2271         </term>
2272         <listitem>Prints the MPD track field 
2273         <para /></listitem>
2274     </varlistentry>
2275     <varlistentry>
2276         <term>
2277             <command>
2278                 <option>mpd_vol</option>
2279             </command>
2280         </term>
2281         <listitem>MPD's volume 
2282         <para /></listitem>
2283     </varlistentry>
2284     <varlistentry>
2285         <term>
2286             <command>
2287                 <option>nameserver</option>
2288             </command>
2289             <option>(index)</option>
2290         </term>
2291         <listitem>Print a nameserver from /etc/resolv.conf. Index
2292         starts at and defaults to 0. 
2293         <para /></listitem>
2294     </varlistentry>
2295     <varlistentry>
2296         <term>
2297             <command>
2298                 <option>new_mails</option>
2299             </command>
2300             <option>(mailbox)</option>
2301             <option>(interval)</option>
2302         </term>
2303         <listitem>Unread mail count in the specified mailbox or
2304         mail spool if not. Both mbox and maildir type mailboxes are
2305         supported. 
2306         <para /></listitem>
2307     </varlistentry>
2308     <varlistentry>
2309         <term>
2310             <command>
2311                 <option>nodename</option>
2312             </command>
2313         </term>
2314         <listitem>Hostname 
2315         <para /></listitem>
2316     </varlistentry>
2317     <varlistentry>
2318         <term>
2319             <command>
2320                 <option>nvidia</option>
2321             </command>
2322             <option>threshold</option>
2323             <option>temp</option>
2324             <option>ambient</option>
2325             <option>gpufreq</option>
2326             <option>memfreq</option>
2327             <option>imagequality</option>
2328         </term>
2329         <listitem>Nvidia graficcard support for the XNVCtrl
2330         library. Each option can be shortened to the least
2331         significant part. Temperatures are printed as float, all
2332         other values as integer. 
2333         <simplelist>
2334             <member>
2335             <command>threshold</command>: the thresholdtemperature
2336             at which the gpu slows down</member>
2337             <member>
2338             <command>temp</command>: gives the gpu current
2339             temperature</member>
2340             <member>
2341             <command>ambient</command>: gives current air
2342             temperature near GPU case</member>
2343             <member>
2344             <command>gpufreq</command>: gives the current gpu
2345             frequency</member>
2346             <member>
2347             <command>memfreq</command>: gives the current mem
2348             frequency</member>
2349             <member>
2350             <command>imagequality</command>: which imagequality
2351             should be choosen by OpenGL applications</member>
2352         </simplelist>
2353         <para /></listitem>
2354     </varlistentry>
2355     <varlistentry>
2356         <term>
2357             <command>
2358                 <option>offset</option>
2359             </command>
2360             <option>(pixels)</option>
2361         </term>
2362         <listitem>Move text over by N pixels. See also $voffset. 
2363         <para /></listitem>
2364     </varlistentry>
2365     <varlistentry>
2366         <term>
2367             <command>
2368                 <option>outlinecolor</option>
2369             </command>
2370             <option>(color)</option>
2371         </term>
2372         <listitem>Change outline color 
2373         <para /></listitem>
2374     </varlistentry>
2375     <varlistentry>
2376         <term>
2377             <command>
2378                 <option>pb_battery</option>
2379             </command>
2380             <option>item</option>
2381         </term>
2382         <listitem>If running on Apple powerbook/ibook, display
2383         information on battery status. The item parameter
2384         specifies, what information to display. Exactly one item
2385         must be specified. Valid items are: 
2386         <simplelist>
2387             <member>
2388             <command>status</command>: Display if battery is fully
2389             charged, charging, discharging or absent (running on
2390             AC)</member>
2391             <member>
2392             <command>percent</command>: Display charge of battery
2393             in percent, if charging or discharging. Nothing will be
2394             displayed, if battery is fully charged or
2395             absent.</member>
2396             <member>
2397             <command>time</command>: Display the time remaining
2398             until the battery will be fully charged or discharged
2399             at current rate. Nothing is displayed, if battery is
2400             absent or if it's present but fully charged and not
2401             discharging.</member>
2402         </simplelist>
2403         <para /></listitem>
2404     </varlistentry>
2405     <varlistentry>
2406         <term>
2407             <command>
2408                 <option>platform</option>
2409             </command>
2410             <option>(dev) type n (factor offset)</option>
2411         </term>
2412         <listitem>Platform sensor from sysfs (Linux 2.6). Parameter
2413         dev may be omitted if you have only one platform device.
2414         Platform type is either 'in' or 'vol' meaning voltage;
2415         'fan' meaning fan; 'temp' meaning temperature. Parameter n
2416         is number of the sensor. See /sys/bus/platform/devices/ on
2417         your local computer. The optional arguments 'factor' and
2418         'offset' allow precalculation of the raw input, which is
2419         being modified as follows: 'input = input * factor +
2420         offset'. Note that they have to be given as decimal values
2421         (i.e. contain at least one decimal place). 
2422         <para /></listitem>
2423     </varlistentry>
2424     <varlistentry>
2425         <term>
2426             <command>
2427                 <option>pop3_unseen</option>
2428             </command>
2429             <option>(args)</option>
2430         </term>
2431         <listitem>Displays the number of unseen messages in your
2432         global POP3 inbox by default. You can define individual
2433         POP3 inboxes seperately by passing arguments to this
2434         object. Arguments are: "host user pass [-i interval (in
2435         seconds)] [-p port] [-e command] [-r retries]". Default
2436         port is 110, default interval is 5 minutes, and default
2437         number of retries before giving up is 5. If the password is
2438         supplied as '*', you will be prompted to enter the password
2439         when Conky starts. 
2440         <para /></listitem>
2441     </varlistentry>
2442     <varlistentry>
2443         <term>
2444             <command>
2445                 <option>pop3_used</option>
2446             </command>
2447             <option>(args)</option>
2448         </term>
2449         <listitem>Displays the amount of space (in MiB, 2^20) used
2450         in your global POP3 inbox by default. You can define
2451         individual POP3 inboxes seperately by passing arguments to
2452         this object. Arguments are: "host user pass [-i interval
2453         (in seconds)] [-p port] [-e command] [-r retries]". Default
2454         port is 110, default interval is 5 minutes, and default
2455         number of retries before giving up is 5. If the password is
2456         supplied as '*', you will be prompted to enter the password
2457         when Conky starts. 
2458         <para /></listitem>
2459     </varlistentry>
2460     <varlistentry>
2461         <term>
2462             <command>
2463                 <option>pre_exec</option>
2464             </command>
2465             <option>shell command</option>
2466         </term>
2467         <listitem>Executes a shell command one time before conky
2468         displays anything and puts output as text. 
2469         <para /></listitem>
2470     </varlistentry>
2471     <varlistentry>
2472         <term>
2473             <command>
2474                 <option>processes</option>
2475             </command>
2476         </term>
2477         <listitem>Total processes (sleeping and running) 
2478         <para /></listitem>
2479     </varlistentry>
2480     <varlistentry>
2481         <term>
2482             <command>
2483                 <option>read_tcp</option>
2484             </command>
2485             <option>(host) port</option>
2486         </term>
2487         <listitem>Connects to a tcp port on a host (default is
2488         localhost), reads every char available at the moment and
2489         shows them. 
2490         <para /></listitem>
2491     </varlistentry>
2492     <varlistentry>
2493         <term>
2494             <command>
2495                 <option>replied_mails</option>
2496             </command>
2497             <option>(maildir)</option>
2498             <option>(interval)</option>
2499         </term>
2500         <listitem>Number of mails marked as replied in the
2501         specified mailbox or mail spool if not. Only maildir type
2502         mailboxes are supported, mbox type will return -1. 
2503         <para /></listitem>
2504     </varlistentry>
2505     <varlistentry>
2506         <term>
2507             <command>
2508                 <option>rss</option>
2509             </command>
2510             <option>url delay_in_minutes action (num_par
2511             (spaces_in_front))</option>
2512         </term>
2513         <listitem>Download and parse RSS feeds. Action may be one
2514         of the following: feed_title, item_title (with num par),
2515         item_desc (with num par) and item_titles (when using this
2516         action and spaces_in_front is given conky places that many
2517         spaces in front of each item). 
2518         <para /></listitem>
2519     </varlistentry>
2520     <varlistentry>
2521         <term>
2522             <command>
2523                 <option>running_processes</option>
2524             </command>
2525         </term>
2526         <listitem>Running processes (not sleeping), requires Linux
2527         2.6 
2528         <para /></listitem>
2529     </varlistentry>
2530     <varlistentry>
2531         <term>
2532             <command>
2533                 <option>scroll</option>
2534             </command>
2535             <option>length (step) text</option>
2536         </term>
2537         <listitem>Scroll 'text' by 'step' characters showing
2538         'length' number of characters at the same time. The text
2539         may also contain variables. 'step' is optional and defaults
2540         to 1 if not set. If a var creates output on multiple lines
2541         then the lines are placed behind each other separated with
2542         a '|'-sign. Do NOT use vars that change colors or otherwise
2543         affect the design inside a scrolling text. If you want
2544         spaces between the start and the end of 'text', place them
2545         at the end of 'text' not at the front ("foobar" and "
2546         foobar" can both generate "barfoo" but "foobar " will keep
2547         the spaces like this "bar foo"). 
2548         <para /></listitem>
2549     </varlistentry>
2550     <varlistentry>
2551         <term>
2552             <command>
2553                 <option>seen_mails</option>
2554             </command>
2555             <option>(maildir)</option>
2556             <option>(interval)</option>
2557         </term>
2558         <listitem>Number of mails marked as seen in the specified
2559         mailbox or mail spool if not. Only maildir type mailboxes
2560         are supported, mbox type will return -1. 
2561         <para /></listitem>
2562     </varlistentry>
2563     <varlistentry>
2564         <term>
2565             <command>
2566                 <option>shadecolor</option>
2567             </command>
2568             <option>(color)</option>
2569         </term>
2570         <listitem>Change shading color 
2571         <para /></listitem>
2572     </varlistentry>
2573     <varlistentry>
2574         <term>
2575             <command>
2576                 <option>smapi</option>
2577             </command>
2578             <option>(ARGS)</option>
2579         </term>
2580         <listitem>when using smapi, display contents of the
2581         /sys/devices/platform/smapi directory. ARGS are either
2582         '(FILENAME)' or 'bat (INDEX) (FILENAME)' to display the
2583         corresponding files' content. This is a very raw method of
2584         accessing the smapi values. When available, better use one
2585         of the smapi_* variables instead. 
2586         <para /></listitem>
2587     </varlistentry>
2588     <varlistentry>
2589         <term>
2590             <command>
2591                 <option>smapi_bat_bar</option>
2592             </command>
2593             <option>(INDEX),(height),(width)</option>
2594         </term>
2595         <listitem>when using smapi, display the remaining capacity
2596         of the battery with index INDEX as a bar. 
2597         <para /></listitem>
2598     </varlistentry>
2599     <varlistentry>
2600         <term>
2601             <command>
2602                 <option>smapi_bat_perc</option>
2603             </command>
2604             <option>(INDEX)</option>
2605         </term>
2606         <listitem>when using smapi, display the remaining capacity
2607         in percent of the battery with index INDEX. This is a
2608         separate variable because it supports the 'use_spacer'
2609         configuration option. 
2610         <para /></listitem>
2611     </varlistentry>
2612     <varlistentry>
2613         <term>
2614             <command>
2615                 <option>smapi_bat_power</option>
2616             </command>
2617             <option>INDEX</option>
2618         </term>
2619         <listitem>when using smapi, display the current power of
2620         the battery with index INDEX in watt. This is a separate
2621         variable because the original read out value is being
2622         converted from mW. The sign of the output reflects charging
2623         (positive) or discharging (negative) state. 
2624         <para /></listitem>
2625     </varlistentry>
2626     <varlistentry>
2627         <term>
2628             <command>
2629                 <option>smapi_bat_temp</option>
2630             </command>
2631             <option>INDEX</option>
2632         </term>
2633         <listitem>when using smapi, display the current temperature
2634         of the battery with index INDEX in degree Celsius. This is
2635         a separate variable because the original read out value is
2636         being converted from milli degree Celsius. 
2637         <para /></listitem>
2638     </varlistentry>
2639     <varlistentry>
2640         <term>
2641             <command>
2642                 <option>sony_fanspeed</option>
2643             </command>
2644         </term>
2645         <listitem>Displays the Sony VAIO fanspeed information if
2646         sony-laptop kernel support is enabled. Linux only. 
2647         <para /></listitem>
2648     </varlistentry>
2649     <varlistentry>
2650         <term>
2651             <command>
2652                 <option>stippled_hr</option>
2653             </command>
2654             <option>(space)</option>
2655         </term>
2656         <listitem>Stippled (dashed) horizontal line 
2657         <para /></listitem>
2658     </varlistentry>
2659     <varlistentry>
2660         <term>
2661             <command>
2662                 <option>swap</option>
2663             </command>
2664         </term>
2665         <listitem>Amount of swap in use 
2666         <para /></listitem>
2667     </varlistentry>
2668     <varlistentry>
2669         <term>
2670             <command>
2671                 <option>swapbar</option>
2672             </command>
2673             <option>(height),(width)</option>
2674         </term>
2675         <listitem>Bar that shows amount of swap in use 
2676         <para /></listitem>
2677     </varlistentry>
2678     <varlistentry>
2679         <term>
2680             <command>
2681                 <option>swapmax</option>
2682             </command>
2683         </term>
2684         <listitem>Total amount of swap 
2685         <para /></listitem>
2686     </varlistentry>
2687     <varlistentry>
2688         <term>
2689             <command>
2690                 <option>swapperc</option>
2691             </command>
2692         </term>
2693         <listitem>Percentage of swap in use 
2694         <para /></listitem>
2695     </varlistentry>
2696     <varlistentry>
2697         <term>
2698             <command>
2699                 <option>sysname</option>
2700             </command>
2701         </term>
2702         <listitem>System name, Linux for example 
2703         <para /></listitem>
2704     </varlistentry>
2705     <varlistentry>
2706         <term>
2707             <command>
2708                 <option>tab</option>
2709             </command>
2710             <option>(width, (start))</option>
2711         </term>
2712         <listitem>Puts a tab of the specified width, starting from
2713         column 'start'. The unit is pixels for both arguments. 
2714         <para /></listitem>
2715     </varlistentry>
2716     <varlistentry>
2717         <term>
2718             <command>
2719                 <option>tail</option>
2720             </command>
2721             <option>logfile lines (interval)</option>
2722         </term>
2723         <listitem>Displays last N lines of supplied text text file.
2724         If interval is not supplied, Conky assumes 2x Conky's
2725         interval. Max of 30 lines can be displayed, or until the
2726         text buffer is filled. 
2727         <para /></listitem>
2728     </varlistentry>
2729     <varlistentry>
2730         <term>
2731             <command>
2732                 <option>tcp_portmon</option>
2733             </command>
2734             <option>port_begin port_end item (index)</option>
2735             <emphasis>(ip4 only at present)</emphasis>
2736         </term>
2737         <listitem>TCP port monitor for specified local ports. Port
2738         numbers must be in the range 1 to 65535. Valid items are: 
2739         <simplelist>
2740             <member>
2741             <command>count</command>- total number of connections
2742             in the range</member>
2743             <member>
2744             <command>rip</command>- remote ip address</member>
2745             <member>
2746             <command>rhost</command>- remote host name</member>
2747             <member>
2748             <command>rport</command>- remote port number</member>
2749             <member>
2750             <command>rservice</command>- remote service name from
2751             /etc/services</member>
2752             <member>
2753             <command>lip</command>- local ip address</member>
2754             <member>
2755             <command>lhost</command>- local host name</member>
2756             <member>
2757             <command>lport</command>- local port number</member>
2758             <member>
2759             <command>lservice</command>- local service name from
2760             /etc/services</member>
2761         </simplelist>The connection index provides you with access
2762         to each connection in the port monitor. The monitor will
2763         return information for index values from 0 to n-1
2764         connections. Values higher than n-1 are simply ignored. For
2765         the "count" item, the connection index must be omitted. It
2766         is required for all other items. 
2767         <simplelist>
2768             <member>Examples:</member>
2769             <member>
2770             <command>${tcp_portmon 6881 6999 count}</command>-
2771             displays the number of connections in the bittorrent
2772             port range</member>
2773             <member>
2774             <command>${tcp_portmon 22 22 rip 0}</command>- displays
2775             the remote host ip of the first sshd
2776             connection</member>
2777             <member>
2778             <command>${tcp_portmon 22 22 rip 9}</command>- displays
2779             the remote host ip of the tenth sshd
2780             connection</member>
2781             <member>
2782             <command>${tcp_portmon 1 1024 rhost 0}</command>-
2783             displays the remote host name of the first connection
2784             on a privileged port</member>
2785             <member>
2786             <command>${tcp_portmon 1 1024 rport 4}</command>-
2787             displays the remote host port of the fifth connection
2788             on a privileged port</member>
2789             <member>
2790             <command>${tcp_portmon 1 65535 lservice 14}</command>-
2791             displays the local service name of the fifteenth
2792             connection in the range of all ports</member>
2793         </simplelist>Note that port monitor variables which share
2794         the same port range actually refer to the same monitor, so
2795         many references to a single port range for different items
2796         and different indexes all use the same monitor internally.
2797         In other words, the program avoids creating redundant
2798         monitors.</listitem>
2799     </varlistentry>
2800     <varlistentry>
2801         <term>
2802             <command>
2803                 <option>templateN</option>
2804             </command>
2805             <option>(arg1)</option>
2806             <option>(arg2)</option>
2807             <option>(arg3 ...)</option>
2808         </term>
2809         <listitem>Evaluate the content of the templateN
2810         configuration variable (where N is a value between 0 and 9,
2811         inclusively), applying substitutions as described in the
2812         documentation of the corresponding configuration variable.
2813         The number of arguments is optional, but must match the
2814         highest referred index in the template. You can use the
2815         same special sequences in each argument as the ones valid
2816         for a template definition, e.g. to allow an argument to
2817         contain a whitespace. Also simple nesting of templates is
2818         possible this way. 
2819         <para /></listitem>
2820         <listitem>Here are some examples of template definitions: 
2821         <simplelist>
2822             <member>template0 $\1\2</member>
2823             <member>template1 \1: ${fs_used \2} / ${fs_size
2824             \2}</member>
2825             <member>template2 \1 \2</member>
2826         </simplelist>The following list shows sample usage of the
2827         templates defined above, with the equivalent syntax when
2828         not using any template at all: 
2829         <table>
2830             <tgroup cols="2">
2831                 <thead>
2832                     <row rowsep="1">
2833                         <entry>using template</entry>
2834                         <entry>same without template</entry>
2835                     </row>
2836                 </thead>
2837                 <tbody>
2838                     <row>
2839                         <entry>${template0 node name}</entry>
2840                         <entry>$nodename</entry>
2841                     </row>
2842                     <row>
2843                         <entry>${template1 root /}</entry>
2844                         <entry>root: ${fs_free /} / ${fs_size
2845                         /}</entry>
2846                     </row>
2847                     <row>
2848                         <entry>
2849                             <programlisting>${template1
2850                             ${template2\ disk\ root}
2851                             /}</programlisting>
2852                         </entry>
2853                         <entry>
2854                             <programlisting>disk root: ${fs_free /}
2855                             / ${fs_size /}</programlisting>
2856                         </entry>
2857                     </row>
2858                 </tbody>
2859             </tgroup>
2860         </table>
2861         <para /></listitem>
2862     </varlistentry>
2863     <varlistentry>
2864         <term>
2865             <command>
2866                 <option>texeci</option>
2867             </command>
2868             <option>interval command</option>
2869         </term>
2870         <listitem>Runs a command at an interval inside a thread and
2871         displays the output. Same as $execi, except the command is
2872         run inside a thread. Use this if you have a slow script to
2873         keep Conky updating. You should make the interval slightly
2874         longer then the time it takes your script to execute. For
2875         example, if you have a script that take 5 seconds to
2876         execute, you should make the interval at least 6 seconds.
2877         See also $execi. 
2878         <para /></listitem>
2879     </varlistentry>
2880     <varlistentry>
2881         <term>
2882             <command>
2883                 <option>time</option>
2884             </command>
2885             <option>(format)</option>
2886         </term>
2887         <listitem>Local time, see man strftime to get more
2888         information about format 
2889         <para /></listitem>
2890     </varlistentry>
2891     <varlistentry>
2892         <term>
2893             <command>
2894                 <option>top</option>
2895             </command>
2896             <option>type, num</option>
2897         </term>
2898         <listitem>This takes arguments in the form:top (name)
2899         (number) Basically, processes are ranked from highest to
2900         lowest in terms of cpu usage, which is what (num)
2901         represents. The types are: "name", "pid", "cpu", "mem",
2902         "mem_res", "mem_vsize", "time", "io_perc", "io_read" and
2903         "io_write".  There can be a max of 10 processes listed. 
2904         <para /></listitem>
2905     </varlistentry>
2906     <varlistentry>
2907         <term>
2908             <command>
2909                 <option>top_mem</option>
2910             </command>
2911             <option>type, num</option>
2912         </term>
2913         <listitem>Same as top, except sorted by mem usage instead
2914         of cpu 
2915         <para /></listitem>
2916     </varlistentry>
2917     <varlistentry>
2918         <term>
2919             <command>
2920                 <option>top_time</option>
2921             </command>
2922             <option>type, num</option>
2923         </term>
2924         <listitem>Same as top, except sorted by total CPU time
2925         instead of current CPU usage 
2926         <para /></listitem>
2927     </varlistentry>
2928     <varlistentry>
2929         <term>
2930             <command>
2931                 <option>top_io</option>
2932             </command>
2933             <option>type, num</option>
2934         </term>
2935         <listitem>Same as top, except sorted by the amount of I/O the
2936             process has done during the update interval
2937         <para /></listitem>
2938     </varlistentry>
2939     <varlistentry>
2940         <term>
2941             <command>
2942                 <option>totaldown</option>
2943             </command>
2944             <option>(net)</option>
2945         </term>
2946         <listitem>Total download, overflows at 4 GB on Linux with
2947         32-bit arch and there doesn't seem to be a way to know how
2948         many times it has already done that before conky has
2949         started. 
2950         <para /></listitem>
2951     </varlistentry>
2952     <varlistentry>
2953         <term>
2954             <command>
2955                 <option>totalup</option>
2956             </command>
2957             <option>(net)</option>
2958         </term>
2959         <listitem>Total upload, this one too, may overflow 
2960         <para /></listitem>
2961     </varlistentry>
2962     <varlistentry>
2963         <term>
2964             <command>
2965                 <option>trashed_mails</option>
2966             </command>
2967             <option>(maildir)</option>
2968             <option>(interval)</option>
2969         </term>
2970         <listitem>Number of mails marked as trashed in the
2971         specified mailbox or mail spool if not. Only maildir type
2972         mailboxes are supported, mbox type will return -1. 
2973         <para /></listitem>
2974     </varlistentry>
2975     <varlistentry>
2976         <term>
2977             <command>
2978                 <option>to_bytes</option>
2979             </command>
2980             <option>size</option>
2981         </term>
2982         <listitem>If 'size' is a number followed by a size-unit
2983         (kilobyte,mb,GiB,...) then it converts the size to bytes
2984         and shows it without unit, otherwise it just shows
2985         'size'.
2986         <para /></listitem>
2987     </varlistentry>
2988     <varlistentry>
2989         <term>
2990             <command>
2991                 <option>tztime</option>
2992             </command>
2993             <option>(timezone) (format)</option>
2994         </term>
2995         <listitem>Local time for specified timezone, see man
2996         strftime to get more information about format. The timezone
2997         argument is specified in similar fashion as TZ environment
2998         variable. For hints, look in /usr/share/zoneinfo. e.g.
2999         US/Pacific, Europe/Zurich, etc. 
3000         <para /></listitem>
3001     </varlistentry>
3002     <varlistentry>
3003         <term>
3004             <command>
3005                 <option>unflagged_mails</option>
3006             </command>
3007             <option>(maildir)</option>
3008             <option>(interval)</option>
3009         </term>
3010         <listitem>Number of mails not marked as flagged in the
3011         specified mailbox or mail spool if not. Only maildir type
3012         mailboxes are supported, mbox type will return -1. 
3013         <para /></listitem>
3014     </varlistentry>
3015     <varlistentry>
3016         <term>
3017             <command>
3018                 <option>unforwarded_mails</option>
3019             </command>
3020             <option>(maildir)</option>
3021             <option>(interval)</option>
3022         </term>
3023         <listitem>Number of mails not marked as forwarded in the
3024         specified mailbox or mail spool if not. Only maildir type
3025         mailboxes are supported, mbox type will return -1. 
3026         <para /></listitem>
3027     </varlistentry>
3028     <varlistentry>
3029         <term>
3030             <command>
3031                 <option>unreplied_mails</option>
3032             </command>
3033             <option>(maildir)</option>
3034             <option>(interval)</option>
3035         </term>
3036         <listitem>Number of mails not marked as replied in the
3037         specified mailbox or mail spool if not. Only maildir type
3038         mailboxes are supported, mbox type will return -1. 
3039         <para /></listitem>
3040     </varlistentry>
3041     <varlistentry>
3042         <term>
3043             <command>
3044                 <option>unseen_mails</option>
3045             </command>
3046             <option>(maildir)</option>
3047             <option>(interval)</option>
3048         </term>
3049         <listitem>Number of new or unseen mails in the specified
3050         mailbox or mail spool if not. Only maildir type mailboxes
3051         are supported, mbox type will return -1. 
3052         <para /></listitem>
3053     </varlistentry>
3054     <varlistentry>
3055         <term>
3056             <command>
3057                 <option>updates</option>
3058             </command>
3059             <option>Number of updates</option>
3060         </term>
3061         <listitem>for debugging 
3062         <para /></listitem>
3063     </varlistentry>
3064     <varlistentry>
3065         <term>
3066             <command>
3067                 <option>upspeed</option>
3068             </command>
3069             <option>(net)</option>
3070         </term>
3071         <listitem>Upload speed in KiB 
3072         <para /></listitem>
3073     </varlistentry>
3074     <varlistentry>
3075         <term>
3076             <command>
3077                 <option>upspeedf</option>
3078             </command>
3079             <option>(net)</option>
3080         </term>
3081         <listitem>Upload speed in KiB with one decimal 
3082         <para /></listitem>
3083     </varlistentry>
3084     <varlistentry>
3085         <term>
3086             <command>
3087                 <option>upspeedgraph</option>
3088             </command>
3089             <option>(netdev) ("normal"|"log") (height),(width)
3090             (gradient colour 1) (gradient colour 2) (scale)
3091             (-t)</option>
3092         </term>
3093         <listitem>Upload speed graph, colours defined in hex, minus
3094         the #. If scale is non-zero, it becomes the scale for the
3095         graph. Uses a logarithmic scale (to see small numbers) when
3096         you use "log" instead of "normal". Takes the switch '-t' to
3097         use a temperature gradient, which makes the gradient values
3098         change depending on the amplitude of a particular graph
3099         value (try it and see). 
3100         <para /></listitem>
3101     </varlistentry>
3102     <varlistentry>
3103         <term>
3104             <command>
3105                 <option>uptime</option>
3106             </command>
3107         </term>
3108         <listitem>Uptime 
3109         <para /></listitem>
3110     </varlistentry>
3111     <varlistentry>
3112         <term>
3113             <command>
3114                 <option>uptime_short</option>
3115             </command>
3116         </term>
3117         <listitem>Uptime in a shorter format 
3118         <para /></listitem>
3119     </varlistentry>
3120     <varlistentry>
3121         <term>
3122             <command>
3123                 <option>user_names</option>
3124             </command>
3125         </term>
3126         <listitem>Lists the names of the users logged in 
3127         <para /></listitem>
3128     </varlistentry>
3129     <varlistentry>
3130         <term>
3131             <command>
3132                 <option>user_number</option>
3133             </command>
3134         </term>
3135         <listitem>Number of users logged in 
3136         <para /></listitem>
3137     </varlistentry>
3138     <varlistentry>
3139         <term>
3140             <command>
3141                 <option>user_terms</option>
3142             </command>
3143         </term>
3144         <listitem>Lists the consoles in use 
3145         <para /></listitem>
3146     </varlistentry>
3147     <varlistentry>
3148         <term>
3149             <command>
3150                 <option>user_times</option>
3151             </command>
3152         </term>
3153         <listitem>Lists how long users have been logged in for 
3154         <para /></listitem>
3155     </varlistentry>
3156     <varlistentry>
3157         <term>
3158             <command>
3159                 <option>utime</option>
3160             </command>
3161             <option>(format)</option>
3162         </term>
3163         <listitem>Display time in UTC (universal coordinate time). 
3164         <para /></listitem>
3165     </varlistentry>
3166     <varlistentry>
3167         <term>
3168             <command>
3169                 <option>voffset</option>
3170             </command>
3171             <option>(pixels)</option>
3172         </term>
3173         <listitem>Change vertical offset by N pixels. Negative
3174         values will cause text to overlap. See also $offset. 
3175         <para /></listitem>
3176     </varlistentry>
3177     <varlistentry>
3178         <term>
3179             <command>
3180                 <option>voltage_mv</option>
3181             </command>
3182             <option>(n)</option>
3183         </term>
3184         <listitem>Returns CPU #n's voltage in mV. CPUs are counted
3185         from 1. If omitted, the parameter defaults to 1. 
3186         <para /></listitem>
3187     </varlistentry>
3188     <varlistentry>
3189         <term>
3190             <command>
3191                 <option>voltage_v</option>
3192             </command>
3193             <option>(n)</option>
3194         </term>
3195         <listitem>Returns CPU #n's voltage in V. CPUs are counted
3196         from 1. If omitted, the parameter defaults to 1. 
3197         <para /></listitem>
3198     </varlistentry>
3199     <varlistentry>
3200         <term>
3201             <command>
3202                 <option>wireless_ap</option>
3203             </command>
3204             <option>(net)</option>
3205         </term>
3206         <listitem>Wireless access point MAC address (Linux only) 
3207         <para /></listitem>
3208     </varlistentry>
3209     <varlistentry>
3210         <term>
3211             <command>
3212                 <option>wireless_bitrate</option>
3213             </command>
3214             <option>(net)</option>
3215         </term>
3216         <listitem>Wireless bitrate (ie 11 Mb/s) (Linux only) 
3217         <para /></listitem>
3218     </varlistentry>
3219     <varlistentry>
3220         <term>
3221             <command>
3222                 <option>wireless_essid</option>
3223             </command>
3224             <option>(net)</option>
3225         </term>
3226         <listitem>Wireless access point ESSID (Linux only) 
3227         <para /></listitem>
3228     </varlistentry>
3229     <varlistentry>
3230         <term>
3231             <command>
3232                 <option>wireless_link_bar</option>
3233             </command>
3234             <option>(height),(width) (net)</option>
3235         </term>
3236         <listitem>Wireless link quality bar (Linux only) 
3237         <para /></listitem>
3238     </varlistentry>
3239     <varlistentry>
3240         <term>
3241             <command>
3242                 <option>wireless_link_qual</option>
3243             </command>
3244             <option>(net)</option>
3245         </term>
3246         <listitem>Wireless link quality (Linux only) 
3247         <para /></listitem>
3248     </varlistentry>
3249     <varlistentry>
3250         <term>
3251             <command>
3252                 <option>wireless_link_qual_max</option>
3253             </command>
3254             <option>(net)</option>
3255         </term>
3256         <listitem>Wireless link quality maximum value (Linux only) 
3257         <para /></listitem>
3258     </varlistentry>
3259     <varlistentry>
3260         <term>
3261             <command>
3262                 <option>wireless_link_qual_perc</option>
3263             </command>
3264             <option>(net)</option>
3265         </term>
3266         <listitem>Wireless link quality in percents (Linux only) 
3267         <para /></listitem>
3268     </varlistentry>
3269     <varlistentry>
3270         <term>
3271             <command>
3272                 <option>wireless_mode</option>
3273             </command>
3274             <option>(net)</option>
3275         </term>
3276         <listitem>Wireless mode (Managed/Ad-Hoc/Master) (Linux
3277         only) 
3278         <para /></listitem>
3279     </varlistentry>
3280     <varlistentry>
3281         <term>
3282             <command>
3283                 <option>words</option>
3284             </command>
3285             <option>textfile</option>
3286         </term>
3287         <listitem>Displays the number of words in the given file 
3288         <para /></listitem>
3289     </varlistentry>
3290     <varlistentry>
3291         <term>
3292             <command>
3293                 <option>xmms2_album</option>
3294             </command>
3295         </term>
3296         <listitem>Album in current XMMS2 song 
3297         <para /></listitem>
3298     </varlistentry>
3299     <varlistentry>
3300         <term>
3301             <command>
3302                 <option>xmms2_artist</option>
3303             </command>
3304         </term>
3305         <listitem>Artist in current XMMS2 song 
3306         <para /></listitem>
3307     </varlistentry>
3308     <varlistentry>
3309         <term>
3310             <command>
3311                 <option>xmms2_bar</option>
3312             </command>
3313             <option>(height),(width)</option>
3314         </term>
3315         <listitem>Bar of XMMS2's progress 
3316         <para /></listitem>
3317     </varlistentry>
3318     <varlistentry>
3319         <term>
3320             <command>
3321                 <option>xmms2_bitrate</option>
3322             </command>
3323         </term>
3324         <listitem>Bitrate of current song 
3325         <para /></listitem>
3326     </varlistentry>
3327     <varlistentry>
3328         <term>
3329             <command>
3330                 <option>xmms2_comment</option>
3331             </command>
3332         </term>
3333         <listitem>Comment in current XMMS2 song 
3334         <para /></listitem>
3335     </varlistentry>
3336     <varlistentry>
3337         <term>
3338             <command>
3339                 <option>xmms2_date</option>
3340             </command>
3341         </term>
3342         <listitem>Returns song's date. 
3343         <para /></listitem>
3344     </varlistentry>
3345     <varlistentry>
3346         <term>
3347             <command>
3348                 <option>xmms2_duration</option>
3349             </command>
3350         </term>
3351         <listitem>Duration of current song 
3352         <para /></listitem>
3353     </varlistentry>
3354     <varlistentry>
3355         <term>
3356             <command>
3357                 <option>xmms2_elapsed</option>
3358             </command>
3359         </term>
3360         <listitem>Song's elapsed time 
3361         <para /></listitem>
3362     </varlistentry>
3363     <varlistentry>
3364         <term>
3365             <command>
3366                 <option>xmms2_genre</option>
3367             </command>
3368         </term>
3369         <listitem>Genre in current XMMS2 song 
3370         <para /></listitem>
3371     </varlistentry>
3372     <varlistentry>
3373         <term>
3374             <command>
3375                 <option>xmms2_id</option>
3376             </command>
3377         </term>
3378         <listitem>XMMS2 id of current song 
3379         <para /></listitem>
3380     </varlistentry>
3381     <varlistentry>
3382         <term>
3383             <command>
3384                 <option>xmms2_percent</option>
3385             </command>
3386         </term>
3387         <listitem>Percent of song's progress 
3388         <para /></listitem>
3389     </varlistentry>
3390     <varlistentry>
3391         <term>
3392             <command>
3393                 <option>xmms2_playlist</option>
3394             </command>
3395         </term>
3396         <listitem>Returns the XMMS2 playlist. 
3397         <para /></listitem>
3398     </varlistentry>
3399     <varlistentry>
3400         <term>
3401             <command>
3402                 <option>xmms2_size</option>
3403             </command>
3404         </term>
3405         <listitem>Size of current song 
3406         <para /></listitem>
3407     </varlistentry>
3408     <varlistentry>
3409         <term>
3410             <command>
3411                 <option>xmms2_smart</option>
3412             </command>
3413         </term>
3414         <listitem>Prints the song name in either the form "artist -
3415         title" or file name, depending on whats available 
3416         <para /></listitem>
3417     </varlistentry>
3418     <varlistentry>
3419         <term>
3420             <command>
3421                 <option>xmms2_status</option>
3422             </command>
3423         </term>
3424         <listitem>XMMS2 status (Playing, Paused, Stopped, or
3425         Disconnected) 
3426         <para /></listitem>
3427     </varlistentry>
3428     <varlistentry>
3429         <term>
3430             <command>
3431                 <option>xmms2_timesplayed</option>
3432             </command>
3433         </term>
3434         <listitem>Number of times a song was played (presumably). 
3435         <para /></listitem>
3436     </varlistentry>
3437     <varlistentry>
3438         <term>
3439             <command>
3440                 <option>xmms2_title</option>
3441             </command>
3442         </term>
3443         <listitem>Title in current XMMS2 song 
3444         <para /></listitem>
3445     </varlistentry>
3446     <varlistentry>
3447         <term>
3448             <command>
3449                 <option>xmms2_tracknr</option>
3450             </command>
3451         </term>
3452         <listitem>Track number in current XMMS2 song 
3453         <para /></listitem>
3454     </varlistentry>
3455     <varlistentry>
3456         <term>
3457             <command>
3458                 <option>xmms2_url</option>
3459             </command>
3460         </term>
3461         <listitem>Full path to current song 
3462         <para /></listitem>
3463     </varlistentry>
3464 </variablelist>