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