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