be consistent when parsing args of cpu objects
[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>conky_version</option></command>
387                 </term>
388                 <listitem>
389                         Conky version
390                         <para></para></listitem>
391         </varlistentry>
392
393         <varlistentry>
394                 <term>
395                         <command><option>conky_build_date</option></command>
396                 </term>
397                 <listitem>
398                         Date Conky was built
399                         <para></para></listitem>
400         </varlistentry>
401
402         <varlistentry>
403                 <term>
404                         <command><option>conky_build_arch</option></command>
405                 </term>
406                 <listitem>
407                         CPU architecture Conky was built for
408                         <para></para></listitem>
409         </varlistentry>
410
411         <varlistentry>
412                 <term>
413                         <command><option>cpu</option></command>
414                         <option>(cpuN)</option>
415                 </term>
416                 <listitem>
417                         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.
418                         <para></para></listitem>
419         </varlistentry>
420
421         <varlistentry>
422                 <term>
423                         <command><option>cpubar</option></command>
424                         <option>(cpuN) (height),(width)</option>
425                 </term>
426                 <listitem>
427                         Bar that shows CPU usage, height is bar's height in pixels.  See $cpu for more info on SMP.
428                         <para></para></listitem>
429         </varlistentry>
430
431         <varlistentry>
432                 <term>
433                         <command><option>cpugauge</option></command>
434                         <option>(cpuN) (height),(width)</option>
435                 </term>
436                 <listitem>
437                         Elliptical gauge that shows CPU usage, height and width are gauge's vertical and horizontal axis respectively.  See $cpu for more info on SMP.
438                         <para></para></listitem>
439         </varlistentry>
440
441         <varlistentry>
442                 <term>
443                         <command><option>cpugraph</option></command>
444                         <option>(cpuN) ("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
445                 </term>
446                 <listitem>
447                         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".
448                         <para></para></listitem>
449         </varlistentry>
450
451         <varlistentry>
452                 <term>
453                         <command><option>diskio</option></command>
454                         <option>(device)</option>
455                 </term>
456                 <listitem>
457                         Displays current disk IO.  Device is optional, and takes the form of sda for /dev/sda.  Individual partitions are allowed.
458                         <para></para></listitem>
459         </varlistentry>
460
461         <varlistentry>
462                 <term>
463                         <command><option>diskiograph</option></command>
464                         <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)</option>
465                 </term>
466                 <listitem>
467                         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".
468                         <para></para></listitem>
469         </varlistentry>
470
471         <varlistentry>
472                 <term>
473                         <command><option>diskio_read</option></command>
474                         <option>(device)</option>
475                 </term>
476                 <listitem>
477                         Displays current disk IO for reads.  Device as in diskio.
478                         <para></para></listitem>
479         </varlistentry>
480
481         <varlistentry>
482                 <term>
483                         <command><option>diskiograph_read</option></command>
484                         <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)</option>
485                 </term>
486                 <listitem>
487                         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".
488                         <para></para></listitem>
489         </varlistentry>
490
491         <varlistentry>
492                 <term>
493                         <command><option>diskio_write</option></command>
494                         <option>(device)</option>
495                 </term>
496                 <listitem>
497                         Displays current disk IO for writes.  Device as in diskio.
498                         <para></para></listitem>
499         </varlistentry>
500
501         <varlistentry>
502                 <term>
503                         <command><option>diskiograph_write</option></command>
504                         <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (device)</option>
505                 </term>
506                 <listitem>
507                         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".
508                         <para></para></listitem>
509         </varlistentry>
510
511         <varlistentry>
512                 <term>
513                         <command><option>disk_protect</option></command>
514                         <option>device</option>
515                 </term>
516                 <listitem>
517                         Disk protection status, if supported (needs kernel-patch). Prints either "frozen" or "free  " (note the padding).
518                         <para></para></listitem>
519         </varlistentry>
520
521         <varlistentry>
522                 <term>
523                         <command><option>downspeed</option></command>
524                         <option>net</option>
525                 </term>
526                 <listitem>
527                         Download speed in KiB
528                         <para></para></listitem>
529         </varlistentry>
530
531         <varlistentry>
532                 <term>
533                         <command><option>downspeedf</option></command>
534                         <option>net</option>
535                 </term>
536                 <listitem>
537                         Download speed in KiB with one decimal
538                         <para></para></listitem>
539         </varlistentry>
540
541         <varlistentry>
542                 <term>
543                         <command><option>downspeedgraph</option></command>
544                         <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (net)</option>
545                 </term>
546                 <listitem>
547                         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".
548                         <para></para></listitem>
549         </varlistentry>
550
551         <varlistentry>
552                 <term>
553                         <command><option>else</option></command>
554                 </term>
555                 <listitem>
556                         Text to show if any of the above are not true
557                         <para></para></listitem>
558         </varlistentry>
559
560         <varlistentry>
561                 <term>
562                         <command><option>entropy_avail</option></command>
563                 </term>
564                 <listitem>
565                         Current entropy available for crypto freaks
566                         <para></para></listitem>
567         </varlistentry>
568
569         <varlistentry>
570                 <term>
571                         <command><option>entropy_bar</option></command>
572                         <option>(height),(width)</option>
573                 </term>
574                 <listitem>
575                         Normalized bar of available entropy for crypto freaks
576                         <para></para></listitem>
577         </varlistentry>
578
579         <varlistentry>
580                 <term>
581                         <command><option>entropy_poolsize</option></command>
582                 </term>
583                 <listitem>
584                         Total size of system entropy pool for crypto freaks
585                         <para></para></listitem>
586         </varlistentry>
587
588         <varlistentry>
589                 <term>
590                         <command><option>eval</option></command>
591                         <option>string</option>
592                 </term>
593                 <listitem>
594                         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.
595                         <para></para></listitem>
596         </varlistentry>
597
598         <varlistentry>
599                 <term>
600                         <command><option>exec</option></command>
601                         <option>command</option>
602                 </term>
603                 <listitem>
604                         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.
605                         <para></para></listitem>
606         </varlistentry>
607
608         <varlistentry>
609                 <term>
610                         <command><option>execbar</option></command>
611                         <option>command</option>
612                 </term>
613                 <listitem>
614                         Same as exec, except if the first value return is a value between 0-100, it will use that number for a bar. The size for the bar is currently fixed, but that may change in the future.
615                         <para></para></listitem>
616         </varlistentry>
617
618         <varlistentry>
619                 <term>
620                         <command><option>execgauge</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 gauge. The size for the gauge is currently fixed, but you may change that for the future conky release.
625                         <para></para></listitem>
626         </varlistentry>
627
628         <varlistentry>
629                 <term>
630                         <command><option>execgraph</option></command>
631                         <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) command</option>
632                 </term>
633                 <listitem>
634                         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.
635                         <para></para></listitem>
636         </varlistentry>
637
638         <varlistentry>
639                 <term>
640                         <command><option>execi</option></command>
641                         <option>interval command</option>
642                 </term>
643                 <listitem>
644                         Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
645                         <para></para></listitem>
646         </varlistentry>
647
648         <varlistentry>
649                 <term>
650                         <command><option>execibar</option></command>
651                         <option>interval command</option>
652                 </term>
653                 <listitem>
654                         Same as execbar, except with an interval
655                         <para></para></listitem>
656         </varlistentry>
657
658         <varlistentry>
659                 <term>
660                         <command><option>execigraph</option></command>
661                         <option>interval command</option>
662                 </term>
663                 <listitem>
664                         Same as execgraph, but takes an interval arg graphs values
665                         <para></para></listitem>
666         </varlistentry>
667
668         <varlistentry>
669                 <term>
670                         <command><option>execp</option></command>
671                         <option>command</option>
672                 </term>
673                 <listitem>
674                         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.
675                         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.
676                         <para></para></listitem>
677         </varlistentry>
678
679         <varlistentry>
680                 <term>
681                         <command><option>execpi</option></command>
682                         <option>interval command</option>
683                 </term>
684                 <listitem>
685                         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.
686                         <para></para></listitem>
687         </varlistentry>
688
689         <varlistentry>
690                 <term>
691                         <command><option>font</option></command>
692                         <option>(font)</option>
693                 </term>
694                 <listitem>
695                         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)
696                         <para></para></listitem>
697         </varlistentry>
698
699         <varlistentry>
700                 <term>
701                         <command><option>freq</option></command>
702                         <option>(n)</option>
703                 </term>
704                 <listitem>
705                         Returns CPU #n's frequency in MHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
706                         <para></para></listitem>
707         </varlistentry>
708         <varlistentry>
709                 <term>
710                         <command><option>freq_g</option></command>
711                         <option>(n)</option>
712                 </term>
713                 <listitem>
714                         Returns CPU #n's frequency in GHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
715                         <para></para></listitem>
716         </varlistentry>
717
718         <varlistentry>
719                 <term>
720                         <command><option>freq_dyn</option></command>
721                         <option>(n)</option>
722                 </term>
723                 <listitem>
724                         Returns CPU #n's frequency in MHz (defaults to 1), but is calculated by counting to clock cycles to complete an instruction.  Only available for x86/amd64.
725                         <para></para></listitem>
726         </varlistentry>
727
728         <varlistentry>
729                 <term>
730                         <command><option>freq_dyn_g</option></command>
731                         <option>(n)</option>
732                 </term>
733                 <listitem>
734                         Returns CPU #n's frequency in GHz (defaults to 1), but is calculated by counting to clock cycles to complete an instruction.  Only available for x86/amd64.
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_free</option></command>
751                         <option>(fs)</option>
752                 </term>
753                 <listitem>
754                         Free space on a file system available for users.
755                         <para></para></listitem>
756         </varlistentry>
757
758         <varlistentry>
759                 <term>
760                         <command><option>fs_free_perc</option></command>
761                         <option>(fs)</option>
762                 </term>
763                 <listitem>
764                         Free percentage of space on a file system available for users.
765                         <para></para></listitem>
766         </varlistentry>
767
768         <varlistentry>
769                 <term>
770                         <command><option>fs_size</option></command>
771                         <option>(fs)</option>
772                 </term>
773                 <listitem>
774                         File system size
775                         <para></para></listitem>
776         </varlistentry>
777
778         <varlistentry>
779                 <term>
780                         <command><option>fs_type</option></command>
781                         <option>(fs)</option>
782                 </term>
783                 <listitem>
784                         File system type
785                         <para></para></listitem>
786         </varlistentry>
787
788         <varlistentry>
789                 <term>
790                         <command><option>fs_used</option></command>
791                         <option>(fs)</option>
792                 </term>
793                 <listitem>
794                         File system used space
795                         <para></para></listitem>
796         </varlistentry>
797
798         <varlistentry>
799                 <term>
800                         <command><option>goto</option></command>
801                         <option>x</option>
802                 </term>
803                 <listitem>
804                         The next element will be printed at position 'x'.
805                         <para></para></listitem>
806         </varlistentry>
807
808         <varlistentry>
809                 <term>
810                         <command><option>gw_iface</option></command>
811                 </term>
812                 <listitem>
813                         Displays the default route's interface or "multiple"/"none" accordingly.
814                         <para></para></listitem>
815         </varlistentry>
816
817         <varlistentry>
818                 <term>
819                         <command><option>gw_ip</option></command>
820                 </term>
821                 <listitem>
822                         Displays the default gateway's IP or "multiple"/"none" accordingly.
823                         <para></para></listitem>
824         </varlistentry>
825
826         <varlistentry>
827                 <term>
828                         <command><option>hddtemp</option></command>
829                         <option>dev, (host,(port))</option>
830                 </term>
831                 <listitem>
832                         Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
833                         Default host is 127.0.0.1, default port is 7634.
834                         <para></para></listitem>
835         </varlistentry>
836
837         <varlistentry>
838                 <term>
839                         <command><option>head</option></command>
840                         <option>logfile lines (interval)</option>
841                 </term>
842                 <listitem>
843                         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.
844                         <para></para></listitem>
845         </varlistentry>
846
847         <varlistentry>
848                 <term>
849                         <command><option>hr</option></command>
850                         <option>(height)</option>
851                 </term>
852                 <listitem>
853                         Horizontal line, height is the height in pixels
854                         <para></para></listitem>
855         </varlistentry>
856
857         <varlistentry>
858                 <term>
859                         <command><option>hwmon</option></command>
860                         <option>(dev) type n</option>
861                 </term>
862                 <listitem>
863                         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.
864                         <para></para></listitem>
865         </varlistentry>
866
867         <varlistentry>
868                 <term>
869                         <command><option>iconv_start</option></command>
870                         <option>codeset_from codeset_to</option>
871                 </term>
872                 <listitem>
873                         Convert text from one codeset to another using GNU iconv.  Needs to be stopped with iconv_stop.
874                         <para></para></listitem>
875         </varlistentry>
876
877         <varlistentry>
878                 <term>
879                         <command><option>iconv_stop</option></command>
880                         <option></option>
881                 </term>
882                 <listitem>
883                         Stop iconv codeset conversion.
884                         <para></para></listitem>
885         </varlistentry>
886
887         <varlistentry>
888                 <term>
889                         <command><option>i2c</option></command>
890                         <option>(dev) type n</option>
891                 </term>
892                 <listitem>
893                         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.
894                         <para></para></listitem>
895         </varlistentry>
896
897         <varlistentry>
898                 <term>
899                         <command><option>i8k_ac_status</option></command>
900                         <option></option>
901                 </term>
902                 <listitem>
903                         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.
904                         <para></para></listitem>
905         </varlistentry>
906
907         <varlistentry>
908                 <term>
909                         <command><option>i8k_bios</option></command>
910                         <option></option>
911                 </term>
912                 <listitem>
913                         If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
914                         <para></para></listitem>
915         </varlistentry>
916
917         <varlistentry>
918                 <term>
919                         <command><option>i8k_buttons_status</option></command>
920                         <option></option>
921                 </term>
922                 <listitem>
923                         If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
924                         <para></para></listitem>
925         </varlistentry>
926
927         <varlistentry>
928                 <term>
929                         <command><option>i8k_cpu_temp</option></command>
930                         <option></option>
931                 </term>
932                 <listitem>
933                         If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
934                         <para></para></listitem>
935         </varlistentry>
936
937         <varlistentry>
938                 <term>
939                         <command><option>i8k_left_fan_rpm</option></command>
940                         <option></option>
941                 </term>
942                 <listitem>
943                         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.
944                         <para></para></listitem>
945         </varlistentry>
946
947         <varlistentry>
948                 <term>
949                         <command><option>i8k_left_fan_status</option></command>
950                         <option></option>
951                 </term>
952                 <listitem>
953                         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.
954                         <para></para></listitem>
955         </varlistentry>
956
957         <varlistentry>
958                 <term>
959                         <command><option>i8k_right_fan_rpm</option></command>
960                         <option></option>
961                 </term>
962                 <listitem>
963                         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.
964                         <para></para></listitem>
965         </varlistentry>
966
967         <varlistentry>
968                 <term>
969                         <command><option>i8k_right_fan_status</option></command>
970                         <option></option>
971                 </term>
972                 <listitem>
973                         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.
974                         <para></para></listitem>
975         </varlistentry>
976
977         <varlistentry>
978                 <term>
979                         <command><option>i8k_serial</option></command>
980                         <option></option>
981                 </term>
982                 <listitem>
983                         If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
984                         <para></para></listitem>
985         </varlistentry>
986
987         <varlistentry>
988                 <term>
989                         <command><option>i8k_version</option></command>
990                         <option></option>
991                 </term>
992                 <listitem>
993                         If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
994                         <para></para></listitem>
995         </varlistentry>
996
997         <varlistentry>
998                 <term>
999                         <command><option>ibm_fan</option></command>
1000                 </term>
1001                 <listitem>
1002                         If running the IBM ACPI, displays the fan speed.
1003                         <para></para></listitem>
1004         </varlistentry>
1005
1006         <varlistentry>
1007                 <term>
1008                         <command><option>ibm_temps</option></command>
1009                         <option>N</option>
1010                 </term>
1011                 <listitem>
1012                         If running the IBM ACPI, displays the temperatures
1013                         from the IBM temperature sensors (N=0..7) Sensor 0 is
1014                         on the CPU, 3 is on the GPU.
1015                         <para></para></listitem>
1016         </varlistentry>
1017
1018         <varlistentry>
1019                 <term>
1020                         <command><option>ibm_volume</option></command>
1021                 </term>
1022                 <listitem>
1023                         If running the IBM ACPI, displays the "master" volume,
1024                         controlled by the volume keys (0-14).
1025                         <para></para></listitem>
1026         </varlistentry>
1027
1028         <varlistentry>
1029                 <term>
1030                         <command><option>ibm_brightness</option></command>
1031                 </term>
1032                 <listitem>
1033                         If running the IBM ACPI, displays the brigtness of the
1034                         laptops's LCD (0-7).
1035                         <para></para></listitem>
1036         </varlistentry>
1037
1038         <varlistentry>
1039                 <term>
1040                         <command><option>if_empty</option></command>
1041                         <option>(var)</option>
1042                 </term>
1043                 <listitem>
1044                         if conky variable VAR is empty, display everything
1045                         between $if_empty and the matching $endif
1046                         <para></para></listitem>
1047         </varlistentry>
1048
1049         <varlistentry>
1050                 <term>
1051                         <command><option>if_existing</option></command>
1052                         <option>file (string)</option>
1053                 </term>
1054                 <listitem>
1055                         if FILE exists, display everything between if_existing
1056                         and the matching $endif.  The optional second paramater
1057                         checks for FILE containing the specified string and
1058                         prints everything between $if_existing and the matching
1059                         $endif.
1060                         <para></para></listitem>
1061         </varlistentry>
1062
1063         <varlistentry>
1064                 <term>
1065                         <command><option>if_gw</option></command>
1066                 </term>
1067                 <listitem>
1068                         if there is at least one default gateway, display
1069                         everything between $if_gw and the matching $endif
1070                         <para></para></listitem>
1071         </varlistentry>
1072
1073         <varlistentry>
1074                 <term>
1075                         <command><option>if_match</option></command>
1076                         <option>expression</option>
1077                 </term>
1078                 <listitem>
1079                         Evaluates the given boolean expression, printing
1080                         everything between $if_match and the matching $endif
1081                         depending on whether the evaluation returns true or not.
1082                         Valid expressions consist of a left side, an operator
1083                         and a right side. Left and right sides are being parsed
1084                         for contained text objects before evaluation. Recognised
1085                         left and right side types are:
1086                         <simplelist>
1087                                 <member><command>double</command>:
1088                                         argument consists of only digits and a
1089                                         single dot.
1090                                 </member>
1091                                 <member><command>long</command>:
1092                                         argument consists of only digits.
1093                                 </member>
1094                                 <member><command>string</command>:
1095                                         argument is enclosed in quotation mark
1096                                         or the checks for double and long failed
1097                                         before.
1098                                 </member>
1099                         </simplelist>
1100                         Valid operands are:
1101                         '&gt;', '&lt;', '&gt;=', '&lt;=', '==', '!='.
1102                         <para></para></listitem>
1103         </varlistentry>
1104
1105         <varlistentry>
1106                 <term>
1107                         <command><option>if_running</option></command>
1108                         <option>(process)</option>
1109                 </term>
1110                 <listitem>
1111                         if PROCESS is running, display everything $if_running
1112                         and the matching $endif.  This uses the ``pidof'' command, so the
1113                         -x switch is also supported.
1114                         <para></para></listitem>
1115         </varlistentry>
1116
1117         <varlistentry>
1118                 <term>
1119                         <command><option>if_mounted</option></command>
1120                         <option>(mountpoint)</option>
1121                 </term>
1122                 <listitem>
1123                         if MOUNTPOINT is mounted, display everything between
1124                         $if_mounted and the matching $endif
1125                         <para></para></listitem>
1126         </varlistentry>
1127
1128         <varlistentry>
1129                 <term>
1130                         <command><option>if_smapi_bat_installed</option></command>
1131                         <option>(INDEX)</option>
1132                 </term>
1133                 <listitem>
1134                         when using smapi, if the battery with index INDEX is
1135                         installed, display everything between
1136                         $if_smapi_bat_installed and the matching $endif
1137                         <para></para></listitem>
1138         </varlistentry>
1139
1140         <varlistentry>
1141                 <term>
1142                         <command><option>if_up</option></command>
1143                         <option>(interface)</option>
1144                 </term>
1145                 <listitem>
1146                         if INTERFACE exists and is up, display everything between $if_up and the matching $endif
1147                         <para></para></listitem>
1148         </varlistentry>
1149
1150         <varlistentry>
1151                 <term>
1152                         <command><option>if_updatenr</option></command>
1153                         <option>(updatenr)</option>
1154                 </term>
1155                 <listitem>
1156                         If it's the UPDATENR-th time that conky updates, 
1157                         display everything between $if_updatenr and the matching $endif.
1158                         The counter resets when the highest UPDATENR is reached.
1159                         Example : "{$if_updatenr 1}foo$endif{$if_updatenr 2}bar$endif{$if_updatenr 4}$endif"
1160                         shows foo 25% of the time followed by bar 25% of the time followed by nothing the other half of the time.
1161                         <para></para></listitem>
1162         </varlistentry>
1163
1164         <varlistentry>
1165                 <term>
1166                         <command><option>imap_messages</option></command>
1167                         <option>(args)</option>
1168                 </term>
1169                 <listitem>
1170                         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.
1171                         <para></para></listitem>
1172         </varlistentry>
1173
1174         <varlistentry>
1175                 <term>
1176                         <command><option>imap_unseen</option></command>
1177                         <option>(args)</option>
1178                 </term>
1179                 <listitem>
1180                         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.
1181                         <para></para></listitem>
1182         </varlistentry>
1183
1184         <varlistentry>
1185                 <term>
1186                         <command><option>ioscheduler</option></command>
1187                         <option>disk</option>
1188                 </term>
1189                 <listitem>
1190                         Prints the current ioscheduler used for the given disk name (i.e. e.g. "hda" or "sdb")
1191                         <para></para></listitem>
1192         </varlistentry>
1193
1194         <varlistentry>
1195                 <term>
1196                         <command><option>kernel</option></command>
1197                 </term>
1198                 <listitem>
1199                         Kernel version
1200                         <para></para></listitem>
1201         </varlistentry>
1202
1203         <varlistentry>
1204                 <term>
1205                         <command><option>laptop_mode</option></command>
1206                 </term>
1207                 <listitem>
1208                         The value of /proc/sys/vm/laptop_mode
1209                         <para></para></listitem>
1210         </varlistentry>
1211
1212         <varlistentry>
1213                 <term>
1214                         <command><option>loadavg</option></command>
1215                 </term>
1216                 <listitem>
1217                         (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
1218                         <para></para></listitem>
1219         </varlistentry>
1220
1221         <varlistentry>
1222                 <term>
1223                         <command><option>loadgraph</option></command>
1224                         <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
1225                 </term>
1226                 <listitem>
1227                         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".
1228                         <para></para></listitem>
1229         </varlistentry>
1230
1231         <varlistentry>
1232                 <term>
1233                         <command><option>lines</option></command>
1234                         <option>textfile</option>
1235                 </term>
1236                 <listitem>
1237                         Displays the number of lines in the given file
1238                         <para></para></listitem>
1239         </varlistentry>
1240
1241         <varlistentry>
1242                 <term>
1243                         <command><option>machine</option></command>
1244                 </term>
1245                 <listitem>
1246                         Machine, i686 for example
1247                         <para></para></listitem>
1248         </varlistentry>
1249
1250         <varlistentry>
1251                 <term>
1252                         <command><option>mails</option></command>
1253                         <option>(mailbox)</option>
1254                         <option>(interval)</option>
1255                 </term>
1256                 <listitem>
1257                         Mail count in the specified mailbox or your mail spool if not.
1258                         Both mbox and maildir type mailboxes are supported. You can
1259                         use a program like fetchmail to get mails from some server
1260                         using your favourite protocol. See also new_mails.
1261                         <para></para></listitem>
1262         </varlistentry>
1263
1264         <varlistentry>
1265                 <term>
1266                         <command><option>new_mails</option></command>
1267                         <option>(mailbox)</option>
1268                         <option>(interval)</option>
1269                 </term>
1270                 <listitem>
1271                         Unread mail count in the specified mailbox or mail spool if
1272                         not. Both mbox and maildir type mailboxes are supported.
1273                         <para></para></listitem>
1274         </varlistentry>
1275
1276         <varlistentry>
1277                 <term>
1278                         <command><option>seen_mails</option></command>
1279                         <option>(maildir)</option>
1280                         <option>(interval)</option>
1281                 </term>
1282                 <listitem>
1283                         Number of mails marked as seen in the specified mailbox or mail spool if
1284                         not. Only maildir type mailboxes are supported, mbox type will return -1.
1285                         <para></para></listitem>
1286         </varlistentry>
1287
1288         <varlistentry>
1289                 <term>
1290                         <command><option>unseen_mails</option></command>
1291                         <option>(maildir)</option>
1292                         <option>(interval)</option>
1293                 </term>
1294                 <listitem>
1295                         Number of new or unseen mails in the specified mailbox or mail spool if
1296                         not. Only maildir type mailboxes are supported, mbox type will return -1.
1297                         <para></para></listitem>
1298         </varlistentry>
1299
1300         <varlistentry>
1301                 <term>
1302                         <command><option>flagged_mails</option></command>
1303                         <option>(maildir)</option>
1304                         <option>(interval)</option>
1305                 </term>
1306                 <listitem>
1307                         Number of mails marked as flagged in the specified mailbox or mail spool if
1308                         not. Only maildir type mailboxes are supported, mbox type will return -1.
1309                         <para></para></listitem>
1310         </varlistentry>
1311
1312         <varlistentry>
1313                 <term>
1314                         <command><option>unflagged_mails</option></command>
1315                         <option>(maildir)</option>
1316                         <option>(interval)</option>
1317                 </term>
1318                 <listitem>
1319                         Number of mails not marked as flagged in the specified mailbox or mail spool if
1320                         not. Only maildir type mailboxes are supported, mbox type will return -1.
1321                         <para></para></listitem>
1322         </varlistentry>
1323
1324         <varlistentry>
1325                 <term>
1326                         <command><option>forwarded_mails</option></command>
1327                         <option>(maildir)</option>
1328                         <option>(interval)</option>
1329                 </term>
1330                 <listitem>
1331                         Number of mails marked as forwarded in the specified mailbox or mail spool if
1332                         not. Only maildir type mailboxes are supported, mbox type will return -1.
1333                         <para></para></listitem>
1334         </varlistentry>
1335
1336         <varlistentry>
1337                 <term>
1338                         <command><option>unforwarded_mails</option></command>
1339                         <option>(maildir)</option>
1340                         <option>(interval)</option>
1341                 </term>
1342                 <listitem>
1343                         Number of mails not marked as forwarded in the specified mailbox or mail spool if
1344                         not. Only maildir type mailboxes are supported, mbox type will return -1.
1345                         <para></para></listitem>
1346         </varlistentry>
1347
1348         <varlistentry>
1349                 <term>
1350                         <command><option>replied_mails</option></command>
1351                         <option>(maildir)</option>
1352                         <option>(interval)</option>
1353                 </term>
1354                 <listitem>
1355                         Number of mails marked as replied in the specified mailbox or mail spool if
1356                         not. Only maildir type mailboxes are supported, mbox type will return -1.
1357                         <para></para></listitem>
1358         </varlistentry>
1359
1360         <varlistentry>
1361                 <term>
1362                         <command><option>unreplied_mails</option></command>
1363                         <option>(maildir)</option>
1364                         <option>(interval)</option>
1365                 </term>
1366                 <listitem>
1367                         Number of mails not marked as replied in the specified mailbox or mail spool if
1368                         not. Only maildir type mailboxes are supported, mbox type will return -1.
1369                         <para></para></listitem>
1370         </varlistentry>
1371
1372         <varlistentry>
1373                 <term>
1374                         <command><option>draft_mails</option></command>
1375                         <option>(maildir)</option>
1376                         <option>(interval)</option>
1377                 </term>
1378                 <listitem>
1379                         Number of mails marked as draft in the specified mailbox or mail spool if
1380                         not. Only maildir type mailboxes are supported, mbox type will return -1.
1381                         <para></para></listitem>
1382         </varlistentry>
1383
1384         <varlistentry>
1385                 <term>
1386                         <command><option>trashed_mails</option></command>
1387                         <option>(maildir)</option>
1388                         <option>(interval)</option>
1389                 </term>
1390                 <listitem>
1391                         Number of mails marked as trashed in the specified mailbox or mail spool if
1392                         not. Only maildir type mailboxes are supported, mbox type will return -1.
1393                         <para></para></listitem>
1394         </varlistentry>
1395
1396         <varlistentry>
1397                 <term>
1398                         <command><option>mboxscan</option></command>
1399                         <option>(-n number of messages to print) (-fw from width) (-sw subject width) mbox</option>
1400                 </term>
1401                 <listitem>
1402                         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"}
1403                         <para></para></listitem>
1404         </varlistentry>
1405
1406         <varlistentry>
1407                 <term>
1408                         <command><option>mem</option></command>
1409                 </term>
1410                 <listitem>
1411                         Amount of memory in use
1412                         <para></para></listitem>
1413         </varlistentry>
1414
1415         <varlistentry>
1416                 <term>
1417                         <command><option>membar</option></command>
1418                         <option>(height),(width)</option>
1419                 </term>
1420                 <listitem>
1421                         Bar that shows amount of memory in use
1422                         <para></para></listitem>
1423         </varlistentry>
1424
1425         <varlistentry>
1426                 <term>
1427                         <command><option>memgauge</option></command>
1428                         <option>(height),(width)</option>
1429                 </term>
1430                 <listitem>
1431                         Gauge that shows amount of memory in use (see cpugauge)
1432                         <para></para></listitem>
1433         </varlistentry>
1434
1435         <varlistentry>
1436                 <term>
1437                         <command><option>memgraph</option></command>
1438                         <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
1439                 </term>
1440                 <listitem>
1441                         Memory usage graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
1442                         <para></para></listitem>
1443         </varlistentry>
1444
1445         <varlistentry>
1446                 <term>
1447                         <command><option>memeasyfree</option></command>
1448                 </term>
1449                 <listitem>
1450                         Amount of free memory including the memory that is very easily freed (buffers/cache)
1451                         <para></para></listitem>
1452         </varlistentry>
1453
1454         <varlistentry>
1455                 <term>
1456                         <command><option>memfree</option></command>
1457                 </term>
1458                 <listitem>
1459                         Amount of free memory
1460                         <para></para></listitem>
1461         </varlistentry>
1462
1463         <varlistentry>
1464                 <term>
1465                         <command><option>memmax</option></command>
1466                 </term>
1467                 <listitem>
1468                         Total amount of memory
1469                         <para></para></listitem>
1470         </varlistentry>
1471
1472         <varlistentry>
1473                 <term>
1474                         <command><option>memperc</option></command>
1475                 </term>
1476                 <listitem>
1477                         Percentage of memory in use
1478                         <para></para></listitem>
1479         </varlistentry>
1480
1481         <varlistentry>
1482                 <term>
1483                         <command><option>mixer</option></command>
1484                         <option>(device)</option>
1485                 </term>
1486                 <listitem>
1487                         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.
1488                         <para></para></listitem>
1489         </varlistentry>
1490
1491         <varlistentry>
1492                 <term>
1493                         <command><option>mixerbar</option></command>
1494                         <option>(device)</option>
1495                 </term>
1496                 <listitem>
1497                         Displays mixer value in a bar as reported by the OS.  See docs for $mixer for details on arguments.
1498                         <para></para></listitem>
1499         </varlistentry>
1500
1501         <varlistentry>
1502                 <term>
1503                         <command><option>mixerr</option></command>
1504                         <option>(device)</option>
1505                 </term>
1506                 <listitem>
1507                         Prints the right channel mixer value as reported by the OS.  See docs for $mixer for details on arguments.
1508                         <para></para></listitem>
1509         </varlistentry>
1510
1511         <varlistentry>
1512                 <term>
1513                         <command><option>mixerrbar</option></command>
1514                         <option>(device)</option>
1515                 </term>
1516                 <listitem>
1517                         Displays the right channel mixer value in a bar as reported by the OS.  See docs for $mixer for details on arguments.
1518                         <para></para></listitem>
1519         </varlistentry>
1520
1521         <varlistentry>
1522                 <term>
1523                         <command><option>mixerl</option></command>
1524                         <option>(device)</option>
1525                 </term>
1526                 <listitem>
1527                         Prints the left channel mixer value as reported by the OS.  See docs for $mixer for details on arguments.
1528                         <para></para></listitem>
1529         </varlistentry>
1530
1531         <varlistentry>
1532                 <term>
1533                         <command><option>mixerlbar</option></command>
1534                         <option>(device)</option>
1535                 </term>
1536                 <listitem>
1537                         Displays the left channel mixer value in a bar as reported by the OS.  See docs for $mixer for details on arguments.
1538                         <para></para></listitem>
1539         </varlistentry>
1540
1541         <varlistentry>
1542                 <term>
1543                         <command><option>moc_state</option></command>
1544                 </term>
1545                 <listitem>
1546                         Current state of MOC; playing, stopped etc.
1547                         <para></para></listitem>
1548         </varlistentry>
1549
1550         <varlistentry>
1551                 <term>
1552                         <command><option>moc_file</option></command>
1553                 </term>
1554                 <listitem>
1555                         File name of the current MOC song
1556                         <para></para></listitem>
1557         </varlistentry>
1558
1559         <varlistentry>
1560                 <term>
1561                         <command><option>moc_title</option></command>
1562                 </term>
1563                 <listitem>
1564                         Title of the current MOC song
1565                         <para></para></listitem>
1566         </varlistentry>
1567
1568         <varlistentry>
1569                 <term>
1570                         <command><option>moc_artist</option></command>
1571                 </term>
1572                 <listitem>
1573                         Artist of the current MOC song
1574                         <para></para></listitem>
1575         </varlistentry>
1576
1577         <varlistentry>
1578                 <term>
1579                         <command><option>moc_song</option></command>
1580                 </term>
1581                 <listitem>
1582                         The current song name being played in MOC.
1583                         <para></para></listitem>
1584         </varlistentry>
1585
1586         <varlistentry>
1587                 <term>
1588                         <command><option>moc_album</option></command>
1589                 </term>
1590                 <listitem>
1591                         Album of the current MOC song
1592                         <para></para></listitem>
1593         </varlistentry>
1594
1595         <varlistentry>
1596                 <term>
1597                         <command><option>moc_totaltime</option></command>
1598                 </term>
1599                 <listitem>
1600                         Total length of the current MOC song
1601                         <para></para></listitem>
1602         </varlistentry>
1603
1604         <varlistentry>
1605                 <term>
1606                         <command><option>moc_timeleft</option></command>
1607                 </term>
1608                 <listitem>
1609                         Time left in the current MOC song
1610                         <para></para></listitem>
1611         </varlistentry>
1612
1613         <varlistentry>
1614                 <term>
1615                         <command><option>moc_curtime</option></command>
1616                 </term>
1617                 <listitem>
1618                         Current time of the current MOC song
1619                         <para></para></listitem>
1620         </varlistentry>
1621
1622         <varlistentry>
1623                 <term>
1624                         <command><option>moc_bitrate</option></command>
1625                 </term>
1626                 <listitem>
1627                         Bitrate in the current MOC song
1628                         <para></para></listitem>
1629         </varlistentry>
1630
1631         <varlistentry>
1632                 <term>
1633                         <command><option>moc_rate</option></command>
1634                 </term>
1635                 <listitem>
1636                         Rate of the current MOC song
1637                         <para></para></listitem>
1638         </varlistentry>
1639
1640         <varlistentry>
1641                 <term>
1642                         <command><option>monitor</option></command>
1643                 </term>
1644                 <listitem>
1645                         Number of the monitor on which conky is running
1646                         <para></para></listitem>
1647         </varlistentry>
1648
1649         <varlistentry>
1650                 <term>
1651                         <command><option>monitor_number</option></command>
1652                 </term>
1653                 <listitem>
1654                         Number of monitors
1655                         <para></para></listitem>
1656         </varlistentry>
1657
1658         <varlistentry>
1659                 <term>
1660                         <command><option>mpd_artist</option></command>
1661                 </term>
1662                 <listitem>
1663                         Artist in current MPD song must be enabled at compile
1664                         <para></para></listitem>
1665         </varlistentry>
1666
1667         <varlistentry>
1668                 <term>
1669                         <command><option>mpd_album</option></command>
1670                 </term>
1671                 <listitem>
1672                         Album in current MPD song
1673                         <para></para></listitem>
1674         </varlistentry>
1675
1676         <varlistentry>
1677                 <term>
1678                         <command><option>mpd_bar</option></command>
1679                         <option>(height),(width)</option>
1680                 </term>
1681                 <listitem>
1682                         Bar of mpd's progress
1683                         <para></para></listitem>
1684         </varlistentry>
1685
1686         <varlistentry>
1687                 <term>
1688                         <command><option>mpd_bitrate</option></command>
1689                 </term>
1690                 <listitem>
1691                         Bitrate of current song
1692                         <para></para></listitem>
1693         </varlistentry>
1694
1695         <varlistentry>
1696                 <term>
1697                         <command><option>mpd_status</option></command>
1698                 </term>
1699                 <listitem>
1700                         Playing, stopped, et cetera.
1701                         <para></para></listitem>
1702         </varlistentry>
1703
1704         <varlistentry>
1705                 <term>
1706                         <command><option>mpd_title</option></command>
1707                         <option>(max length)</option>
1708                 </term>
1709                 <listitem>
1710                         Title of current MPD song
1711                         <para></para></listitem>
1712         </varlistentry>
1713
1714         <varlistentry>
1715                 <term>
1716                         <command><option>mpd_vol</option></command>
1717                 </term>
1718                 <listitem>
1719                         MPD's volume
1720                         <para></para></listitem>
1721         </varlistentry>
1722
1723         <varlistentry>
1724                 <term>
1725                         <command><option>mpd_elapsed</option></command>
1726                 </term>
1727                 <listitem>
1728                         Song's elapsed time
1729                         <para></para></listitem>
1730         </varlistentry>
1731
1732         <varlistentry>
1733                 <term>
1734                         <command><option>mpd_length</option></command>
1735                 </term>
1736                 <listitem>
1737                         Song's length
1738                         <para></para></listitem>
1739         </varlistentry>
1740
1741         <varlistentry>
1742                 <term>
1743                         <command><option>mpd_percent</option></command>
1744                 </term>
1745                 <listitem>
1746                         Percent of song's progress
1747                         <para></para></listitem>
1748         </varlistentry>
1749
1750         <varlistentry>
1751                 <term>
1752                         <command><option>mpd_random</option></command>
1753                 </term>
1754                 <listitem>
1755                         Random status (On/Off)
1756                         <para></para></listitem>
1757         </varlistentry>
1758
1759         <varlistentry>
1760                 <term>
1761                         <command><option>mpd_repeat</option></command>
1762                 </term>
1763                 <listitem>
1764                         Repeat status (On/Off)
1765                         <para></para></listitem>
1766         </varlistentry>
1767
1768         <varlistentry>
1769                 <term>
1770                         <command><option>mpd_track</option></command>
1771                 </term>
1772                 <listitem>
1773                         Prints the MPD track field
1774                         <para></para></listitem>
1775         </varlistentry>
1776
1777         <varlistentry>
1778                 <term>
1779                         <command><option>mpd_name</option></command>
1780                 </term>
1781                 <listitem>
1782                         Prints the MPD name field
1783                         <para></para></listitem>
1784         </varlistentry>
1785
1786         <varlistentry>
1787                 <term>
1788                         <command><option>mpd_file</option></command>
1789                 </term>
1790                 <listitem>
1791                         Prints the file name of the current MPD song
1792                         <para></para></listitem>
1793         </varlistentry>
1794
1795         <varlistentry>
1796                 <term>
1797                         <command><option>mpd_smart</option></command>
1798                         <option>(max length)</option>
1799                 </term>
1800                 <listitem>
1801                         Prints the song name in either the form "artist - title" or file name, depending on whats available
1802                         <para></para></listitem>
1803         </varlistentry>
1804
1805         <varlistentry>
1806                 <term>
1807                         <command><option>if_mpd_playing</option></command>
1808                 </term>
1809                 <listitem>
1810                         if mpd is playing or paused, display everything between $if_mpd_playing and the matching $endif
1811                         <para></para></listitem>
1812         </varlistentry>
1813
1814         <varlistentry>
1815                 <term>
1816                         <command><option>nameserver</option></command>
1817                         <option>(index)</option>
1818                 </term>
1819                 <listitem>
1820                         Print a nameserver from /etc/resolv.conf. Index starts at and defaults to 0.
1821                         <para></para></listitem>
1822         </varlistentry>
1823
1824         <varlistentry>
1825                 <term>
1826                         <command><option>nodename</option></command>
1827                 </term>
1828                 <listitem>
1829                         Hostname
1830                         <para></para></listitem>
1831         </varlistentry>
1832
1833         <varlistentry>
1834                 <term>
1835                         <command><option>nvidia</option></command>
1836                         <option>threshold</option>
1837                         <option>temp</option>
1838                         <option>ambient</option>
1839                         <option>gpufreq</option>
1840                         <option>memfreq</option>
1841                         <option>imagequality</option>
1842                 </term>
1843                 <listitem>
1844                         Nvidia graficcard support for the XNVCtrl library.
1845                         Each option can be shortened to the least significant part.
1846                         Temperatures are printed as float, all other values as integer.
1847                         <simplelist>
1848                                 <member><command>threshold</command>:
1849                                         the thresholdtemperature at which the gpu slows down
1850                                 </member>
1851                                 <member><command>temp</command>:
1852                                         gives the gpu current temperature
1853                                 </member>
1854                                 <member><command>ambient</command>:
1855                                         gives current air temperature near GPU case
1856                                 </member>
1857                                 <member><command>gpufreq</command>:
1858                                         gives the current gpu frequency
1859                                 </member>
1860                                 <member><command>memfreq</command>:
1861                                         gives the current mem frequency
1862                                 </member>
1863                                 <member><command>imagequality</command>:
1864                                         which imagequality should be choosen by OpenGL applications
1865                                 </member>
1866                         </simplelist>
1867                         <para></para>
1868                 </listitem>
1869         </varlistentry>
1870
1871         <varlistentry>
1872                 <term>
1873                         <command><option>outlinecolor</option></command>
1874                         <option>(color)</option>
1875                 </term>
1876                 <listitem>
1877                         Change outline color
1878                         <para></para></listitem>
1879         </varlistentry>
1880
1881         <varlistentry>
1882                 <term>
1883                         <command><option>pb_battery</option></command>
1884                         <option>item</option>
1885                 </term>
1886                 <listitem>
1887                         If running on Apple powerbook/ibook, display
1888                         information on battery status. The item parameter
1889                         specifies, what information to display. Exactly one item
1890                         must be specified. Valid items are:
1891                         <simplelist>
1892                                 <member><command>status</command>:
1893                                         Display if battery is fully charged, charging,
1894                                         discharging or absent (running on AC)
1895                                 </member>
1896                                 <member><command>percent</command>:
1897                                         Display charge of battery in percent, if
1898                                         charging or discharging. Nothing will be
1899                                         displayed, if battery is fully charged
1900                                         or absent.
1901                                 </member>
1902                                 <member><command>time</command>:
1903                                         Display the time remaining until the battery
1904                                         will be fully charged or discharged at current
1905                                         rate.  Nothing is displayed, if battery is
1906                                         absent or if it's present but fully charged
1907                                         and not discharging.
1908                                 </member>
1909                         </simplelist>
1910                         <para></para></listitem>
1911         </varlistentry>
1912
1913         <varlistentry>
1914                 <term>
1915                         <command><option>platform</option></command>
1916                         <option>(dev) type n</option>
1917                 </term>
1918                 <listitem>
1919                         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.
1920                         <para></para></listitem>
1921         </varlistentry>
1922
1923         <varlistentry>
1924                 <term>
1925                         <command><option>pop3_unseen</option></command>
1926                         <option>(args)</option>
1927                 </term>
1928                 <listitem>
1929                         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.
1930
1931                         <para></para></listitem>
1932         </varlistentry>
1933
1934         <varlistentry>
1935                 <term>
1936                         <command><option>pop3_used</option></command>
1937                         <option>(args)</option>
1938                 </term>
1939                 <listitem>
1940                         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.
1941
1942                         <para></para></listitem>
1943         </varlistentry>
1944
1945         <varlistentry>
1946                 <term>
1947                         <command><option>pre_exec</option></command>
1948                         <option>shell command</option>
1949                 </term>
1950                 <listitem>
1951                         Executes a shell command one time before conky displays anything and puts output as text.
1952                         <para></para></listitem>
1953         </varlistentry>
1954
1955         <varlistentry>
1956                 <term>
1957                         <command><option>processes</option></command>
1958                 </term>
1959                 <listitem>
1960                         Total processes (sleeping and running)
1961                         <para></para></listitem>
1962         </varlistentry>
1963
1964         <varlistentry>
1965                 <term>
1966                         <command><option>running_processes</option></command>
1967                 </term>
1968                 <listitem>
1969                         Running processes (not sleeping), requires Linux 2.6
1970                         <para></para></listitem>
1971         </varlistentry>
1972
1973         <varlistentry>
1974                 <term>
1975                         <command><option>scroll</option></command>
1976                         <option>length (step) text</option>
1977                 </term>
1978                 <listitem>
1979                         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").
1980                         <para></para></listitem>
1981         </varlistentry>
1982
1983         <varlistentry>
1984                 <term>
1985                         <command><option>shadecolor</option></command>
1986                         <option>(color)</option>
1987                 </term>
1988                 <listitem>
1989                         Change shading color
1990                         <para></para></listitem>
1991         </varlistentry>
1992
1993         <varlistentry>
1994                 <term>
1995                         <command><option>smapi</option></command>
1996                         <option>(ARGS)</option>
1997                 </term>
1998                 <listitem>
1999                         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.
2000                         <para></para></listitem>
2001         </varlistentry>
2002
2003         <varlistentry>
2004                 <term>
2005                         <command><option>smapi_bat_bar</option></command>
2006                         <option>(INDEX),(height),(width)</option>
2007                 </term>
2008                 <listitem>
2009                         when using smapi, display the remaining capacity of the battery with index INDEX as a bar.
2010                         <para></para></listitem>
2011         </varlistentry>
2012
2013         <varlistentry>
2014                 <term>
2015                         <command><option>smapi_bat_perc</option></command>
2016                         <option>(INDEX)</option>
2017                 </term>
2018                 <listitem>
2019                         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.
2020                         <para></para></listitem>
2021         </varlistentry>
2022
2023         <varlistentry>
2024                 <term>
2025                         <command><option>smapi_bat_power</option></command>
2026                         <option>INDEX</option>
2027                 </term>
2028                 <listitem>
2029                         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.
2030                         <para></para></listitem>
2031         </varlistentry>
2032
2033         <varlistentry>
2034                 <term>
2035                         <command><option>smapi_bat_temp</option></command>
2036                         <option>INDEX</option>
2037                 </term>
2038                 <listitem>
2039                         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.
2040                         <para></para></listitem>
2041         </varlistentry>
2042
2043         <varlistentry>
2044                 <term>
2045                         <command><option>stippled_hr</option></command>
2046                         <option>(space)</option>
2047                 </term>
2048                 <listitem>
2049                         Stippled (dashed) horizontal line
2050                         <para></para></listitem>
2051         </varlistentry>
2052
2053         <varlistentry>
2054                 <term>
2055                         <command><option>swapbar</option></command>
2056                         <option>(height),(width)</option>
2057                 </term>
2058                 <listitem>
2059                         Bar that shows amount of swap in use
2060                         <para></para></listitem>
2061         </varlistentry>
2062
2063         <varlistentry>
2064                 <term>
2065                         <command><option>swap</option></command>
2066                 </term>
2067                 <listitem>
2068                         Amount of swap in use
2069                         <para></para></listitem>
2070         </varlistentry>
2071
2072         <varlistentry>
2073                 <term>
2074                         <command><option>swapmax</option></command>
2075                 </term>
2076                 <listitem>
2077                         Total amount of swap
2078                         <para></para></listitem>
2079         </varlistentry>
2080
2081         <varlistentry>
2082                 <term>
2083                         <command><option>swapperc</option></command>
2084                 </term>
2085                 <listitem>
2086                         Percentage of swap in use
2087                         <para></para></listitem>
2088         </varlistentry>
2089
2090         <varlistentry>
2091                 <term>
2092                         <command><option>sysname</option></command>
2093                 </term>
2094                 <listitem>
2095                         System name, Linux for example
2096                         <para></para></listitem>
2097         </varlistentry>
2098
2099         <varlistentry>
2100                 <term>
2101                         <command><option>tcp_portmon</option></command>
2102                         <option>port_begin port_end item (index)</option>
2103                         <emphasis>(ip4 only at present)</emphasis>
2104                 </term>
2105                 <listitem>
2106                         TCP port monitor for specified local ports.  Port numbers must be in the range 1 to 65535. Valid items are:
2107                         <simplelist>
2108                                 <member><command>count</command> - total number of connections in the range
2109                                 </member>
2110                                 <member><command>rip</command> - remote ip address
2111                                 </member>
2112                                 <member><command>rhost</command> - remote host name
2113                                 </member>
2114                                 <member><command>rport</command> - remote port number
2115                                 </member>
2116                                 <member><command>rservice</command> - remote service name from /etc/services
2117                                 </member>
2118                                 <member><command>lip</command> - local ip address
2119                                 </member>
2120                                 <member><command>lhost</command> - local host name
2121                                 </member>
2122                                 <member><command>lport</command> - local port number
2123                                 </member>
2124                                 <member><command>lservice</command> - local service name from /etc/services
2125                                 </member>
2126                         </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.
2127                         <simplelist>
2128                                 <member>Examples:</member>
2129                                 <member><command>${tcp_portmon 6881 6999 count}</command> -
2130                                         displays the number of connections in the bittorrent port range</member>
2131                                 <member><command>${tcp_portmon 22 22 rip 0}</command> -
2132                                         displays the remote host ip of the first sshd connection</member>
2133                                 <member><command>${tcp_portmon 22 22 rip 9}</command> -
2134                                         displays the remote host ip of the tenth sshd connection</member>
2135                                 <member><command>${tcp_portmon 1 1024 rhost 0}</command> -
2136                                         displays the remote host name of the first connection on a privileged port</member>
2137                                 <member><command>${tcp_portmon 1 1024 rport 4}</command> -
2138                                         displays the remote host port of the fifth connection on a privileged port</member>
2139                                 <member><command>${tcp_portmon 1 65535 lservice 14}</command> -
2140                                         displays the local service name of the fifteenth connection in the range of all ports</member>
2141                         </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.
2142                 </listitem>
2143         </varlistentry>
2144
2145         <varlistentry>
2146                 <term>
2147                         <command><option>texeci</option></command>
2148                         <option>interval command</option>
2149                 </term>
2150                 <listitem>
2151                         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.
2152                         <para></para></listitem>
2153         </varlistentry>
2154
2155         <varlistentry>
2156                 <term>
2157                         <command><option>offset</option></command>
2158                         <option>(pixels)</option>
2159                 </term>
2160                 <listitem>
2161                         Move text over by N pixels.  See also $voffset.
2162                         <para></para></listitem>
2163         </varlistentry>
2164
2165         <varlistentry>
2166                 <term>
2167                         <command><option>rss</option></command>
2168                         <option>url delay_in_minutes action item_num</option>
2169                 </term>
2170                 <listitem>
2171                         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.
2172                         <para></para></listitem>
2173         </varlistentry>
2174
2175         <varlistentry>
2176                 <term>
2177                         <command><option>tab</option></command>
2178                         <option>(width, (start))</option>
2179                 </term>
2180                 <listitem>
2181                         Puts a tab of the specified width, starting from column 'start'.
2182                         <para></para></listitem>
2183         </varlistentry>
2184
2185         <varlistentry>
2186                 <term>
2187                         <command><option>tail</option></command>
2188                         <option>logfile lines (interval)</option>
2189                 </term>
2190                 <listitem>
2191                         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.
2192                         <para></para></listitem>
2193         </varlistentry>
2194
2195         <varlistentry>
2196                 <term>
2197                         <command><option>templateN</option></command>
2198                         <option>(arg1)</option>
2199                         <option>(arg2)</option>
2200                         <option>(arg3 ...)</option>
2201                 </term>
2202                 <listitem>
2203                         Evaluate the content of the templateN configuration variable (where N is a value between 0 and 9, inclusively),
2204                         applying substitutions as described in the documentation of the corresponding configuration variable.
2205                         The number of arguments is optional, but must match the highest referred index in the template. You can use the
2206                         same special sequences in each argument as the ones valid for a template definition, e.g. to allow an argument
2207                         to contain a whitespace. Also simple nesting of templates is possible this way.
2208                         <para></para></listitem>
2209                 <listitem>
2210                         Here are some examples of template definitions:
2211                         <simplelist>
2212                                 <member>template0 $\1\2</member>
2213                                 <member>template1 \1: ${fs_used \2} / ${fs_size \2}</member>
2214                                 <member>template2 \1 \2</member>
2215                         </simplelist>
2216                         The following list shows sample usage of the templates defined above,
2217                         with the equivalent syntax when not using any template at all:
2218                         <table>
2219                                 <tgroup cols="2">
2220                                         <thead>
2221                                                 <row rowsep="1"><entry>using template</entry><entry>same without template</entry></row>
2222                                         </thead>
2223                                         <tbody>
2224                                                 <row><entry>${template0 node name}</entry><entry>$nodename</entry></row>
2225                                                 <row><entry>${template1 root /}</entry><entry>root: ${fs_free /} / ${fs_size /}</entry></row>
2226                                                 <row>
2227                                                         <entry><programlisting>${template1 ${template2\ disk\ root} /}</programlisting></entry>
2228                                                         <entry><programlisting>disk root: ${fs_free /} / ${fs_size /}</programlisting></entry>
2229                                                 </row>
2230                                         </tbody>
2231                                 </tgroup>
2232                         </table>
2233                         <para></para></listitem>
2234         </varlistentry>
2235
2236         <varlistentry>
2237                 <term>
2238                         <command><option>time</option></command>
2239                         <option>(format)</option>
2240                 </term>
2241                 <listitem>
2242                         Local time, see man strftime to get more information about format
2243                         <para></para></listitem>
2244         </varlistentry>
2245
2246         <varlistentry>
2247                 <term>
2248                         <command><option>utime</option></command>
2249                         <option>(format)</option>
2250                 </term>
2251                 <listitem>
2252                         Display time in UTC (universal coordinate time).
2253                         <para></para></listitem>
2254         </varlistentry>
2255
2256         <varlistentry>
2257                 <term>
2258                         <command><option>tztime</option></command>
2259                         <option>(timezone) (format)</option>
2260                 </term>
2261                 <listitem>
2262                         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.
2263                         <para></para></listitem>
2264         </varlistentry>
2265
2266         <varlistentry>
2267                 <term>
2268                         <command><option>totaldown</option></command>
2269                         <option>net</option>
2270                 </term>
2271                 <listitem>
2272                         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.
2273                         <para></para></listitem>
2274         </varlistentry>
2275
2276         <varlistentry>
2277                 <term>
2278                         <command><option>top</option></command>
2279                         <option>type, num</option>
2280                 </term>
2281                 <listitem>
2282                         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.
2283                         <para></para></listitem>
2284         </varlistentry>
2285
2286         <varlistentry>
2287                 <term>
2288                         <command><option>top_mem</option></command>
2289                         <option>type, num</option>
2290                 </term>
2291                 <listitem>
2292                         Same as top, except sorted by mem usage instead of cpu
2293                         <para></para></listitem>
2294         </varlistentry>
2295
2296         <varlistentry>
2297                 <term>
2298                         <command><option>top_time</option></command>
2299                         <option>type, num</option>
2300                 </term>
2301                 <listitem>
2302                         Same as top, except sorted by total CPU time instead of current CPU usage
2303                         <para></para></listitem>
2304         </varlistentry>
2305
2306         <varlistentry>
2307                 <term>
2308                         <command><option>totalup</option></command>
2309                         <option>net</option>
2310                 </term>
2311                 <listitem>
2312                         Total upload, this one too, may overflow
2313                         <para></para></listitem>
2314         </varlistentry>
2315
2316         <varlistentry>
2317                 <term>
2318                         <command><option>updates</option></command>
2319                         <option>Number of updates</option>
2320                 </term>
2321                 <listitem>
2322                         for debugging
2323                         <para></para></listitem>
2324         </varlistentry>
2325
2326         <varlistentry>
2327                 <term>
2328                         <command><option>upspeed</option></command>
2329                         <option>net</option>
2330                 </term>
2331                 <listitem>
2332                         Upload speed in KiB
2333                         <para></para></listitem>
2334         </varlistentry>
2335
2336         <varlistentry>
2337                 <term>
2338                         <command><option>upspeedf</option></command>
2339                         <option>net</option>
2340                 </term>
2341                 <listitem>
2342                         Upload speed in KiB with one decimal
2343                         <para></para></listitem>
2344         </varlistentry>
2345
2346         <varlistentry>
2347                 <term>
2348                         <command><option>upspeedgraph</option></command>
2349                         <option>("normal"|"log") (height),(width) (gradient colour 1) (gradient colour 2) (scale) (net)</option>
2350                 </term>
2351                 <listitem>
2352                         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".
2353                         <para></para></listitem>
2354         </varlistentry>
2355
2356         <varlistentry>
2357                 <term>
2358                         <command><option>uptime</option></command>
2359                 </term>
2360                 <listitem>
2361                         Uptime
2362                         <para></para></listitem>
2363         </varlistentry>
2364
2365         <varlistentry>
2366                 <term>
2367                         <command><option>uptime_short</option></command>
2368                 </term>
2369                 <listitem>
2370                         Uptime in a shorter format
2371                         <para></para></listitem>
2372         </varlistentry>
2373
2374         <varlistentry>
2375                 <term>
2376                         <command><option>user_number</option></command>
2377                 </term>
2378                 <listitem>
2379                         Number of users logged in
2380                         <para></para></listitem>
2381         </varlistentry>
2382
2383         <varlistentry>
2384                 <term>
2385                         <command><option>user_names</option></command>
2386                 </term>
2387                 <listitem>
2388                         Lists the names of the users logged in
2389                         <para></para></listitem>
2390         </varlistentry>
2391
2392         <varlistentry>
2393                 <term>
2394                         <command><option>user_terms</option></command>
2395                 </term>
2396                 <listitem>
2397                         Lists the consoles in use
2398                         <para></para></listitem>
2399         </varlistentry>
2400
2401         <varlistentry>
2402                 <term>
2403                         <command><option>user_times</option></command>
2404                 </term>
2405                 <listitem>
2406                         Lists how long users have been logged in for
2407                         <para></para></listitem>
2408         </varlistentry>
2409
2410         <varlistentry>
2411                 <term>
2412                         <command><option>voffset</option></command>
2413                         <option>(pixels)</option>
2414                 </term>
2415                 <listitem>
2416                         Change vertical offset by N pixels.  Negative values will cause text to overlap.  See also $offset.
2417                         <para></para></listitem>
2418         </varlistentry>
2419
2420         <varlistentry>
2421                 <term>
2422                         <command><option>voltage_mv</option></command>
2423                         <option>(n)</option>
2424                 </term>
2425                 <listitem>
2426                         Returns CPU #n's voltage in mV. CPUs are
2427                         counted from 1. If omitted, the parameter
2428                         defaults to 1.
2429                         <para></para></listitem>
2430         </varlistentry>
2431
2432         <varlistentry>
2433                 <term>
2434                         <command><option>voltage_v</option></command>
2435                         <option>(n)</option>
2436                 </term>
2437                 <listitem>
2438                         Returns CPU #n's voltage in V. CPUs are
2439                         counted from 1. If omitted, the parameter
2440                         defaults to 1.
2441                         <para></para></listitem>
2442         </varlistentry>
2443
2444         <varlistentry>
2445                 <term>
2446                         <command><option>wireless_essid</option></command>
2447                         <option>net</option>
2448                 </term>
2449                 <listitem>
2450                         Wireless access point ESSID (Linux only)
2451                         <para></para></listitem>
2452         </varlistentry>
2453
2454         <varlistentry>
2455                 <term>
2456                         <command><option>wireless_mode</option></command>
2457                         <option>net</option>
2458                 </term>
2459                 <listitem>
2460                         Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
2461                         <para></para></listitem>
2462         </varlistentry>
2463
2464         <varlistentry>
2465                 <term>
2466                         <command><option>wireless_bitrate</option></command>
2467                         <option>net</option>
2468                 </term>
2469                 <listitem>
2470                         Wireless bitrate (ie 11 Mb/s) (Linux only)
2471                         <para></para></listitem>
2472         </varlistentry>
2473
2474         <varlistentry>
2475                 <term>
2476                         <command><option>wireless_ap</option></command>
2477                         <option>net</option>
2478                 </term>
2479                 <listitem>
2480                         Wireless access point MAC address (Linux only)
2481                         <para></para></listitem>
2482         </varlistentry>
2483
2484         <varlistentry>
2485                 <term>
2486                         <command><option>wireless_link_qual</option></command>
2487                         <option>net</option>
2488                 </term>
2489                 <listitem>
2490                         Wireless link quality (Linux only)
2491                         <para></para></listitem>
2492         </varlistentry>
2493
2494         <varlistentry>
2495                 <term>
2496                         <command><option>wireless_link_qual_max</option></command>
2497                         <option>net</option>
2498                 </term>
2499                 <listitem>
2500                         Wireless link quality maximum value (Linux only)
2501                         <para></para></listitem>
2502         </varlistentry>
2503
2504         <varlistentry>
2505                 <term>
2506                         <command><option>wireless_link_qual_perc</option></command>
2507                         <option>net</option>
2508                 </term>
2509                 <listitem>
2510                         Wireless link quality in percents (Linux only)
2511                         <para></para></listitem>
2512         </varlistentry>
2513
2514         <varlistentry>
2515                 <term>
2516                         <command><option>wireless_link_bar</option></command>
2517                         <option>(height), (width) net</option>
2518                 </term>
2519                 <listitem>
2520                         Wireless link quality bar (Linux only)
2521                         <para></para></listitem>
2522         </varlistentry>
2523
2524         <varlistentry>
2525                 <term>
2526                         <command><option>words</option></command>
2527                         <option>textfile</option>
2528                 </term>
2529                 <listitem>
2530                         Displays the number of words in the given file
2531                         <para></para></listitem>
2532         </varlistentry>
2533
2534         <varlistentry>
2535                 <term>
2536                         <command><option>xmms2_artist</option></command>
2537                 </term>
2538                 <listitem>
2539                         Artist in current XMMS2 song
2540                         <para></para></listitem>
2541         </varlistentry>
2542
2543         <varlistentry>
2544                 <term>
2545                         <command><option>xmms2_album</option></command>
2546                 </term>
2547                 <listitem>
2548                         Album in current XMMS2 song
2549                         <para></para></listitem>
2550         </varlistentry>
2551
2552         <varlistentry>
2553                 <term>
2554                         <command><option>xmms2_title</option></command>
2555                 </term>
2556                 <listitem>
2557                         Title in current XMMS2 song
2558                         <para></para></listitem>
2559         </varlistentry>
2560
2561         <varlistentry>
2562                 <term>
2563                         <command><option>xmms2_genre</option></command>
2564                 </term>
2565                 <listitem>
2566                         Genre in current XMMS2 song
2567                         <para></para></listitem>
2568         </varlistentry>
2569
2570         <varlistentry>
2571                 <term>
2572                         <command><option>xmms2_comment</option></command>
2573                 </term>
2574                 <listitem>
2575                         Comment in current XMMS2 song
2576                         <para></para></listitem>
2577         </varlistentry>
2578
2579         <varlistentry>
2580                 <term>
2581                         <command><option>xmms2_decoder</option></command>
2582                 </term>
2583                 <listitem>
2584                         Decoder plugin used
2585                         <para></para></listitem>
2586         </varlistentry>
2587
2588         <varlistentry>
2589                 <term>
2590                         <command><option>xmms2_transport</option></command>
2591                 </term>
2592                 <listitem>
2593                         Transport plugin used
2594                         <para></para></listitem>
2595         </varlistentry>
2596
2597         <varlistentry>
2598                 <term>
2599                         <command><option>xmms2_url</option></command>
2600                 </term>
2601                 <listitem>
2602                         Full path to current song
2603                         <para></para></listitem>
2604         </varlistentry>
2605
2606         <varlistentry>
2607                 <term>
2608                         <command><option>xmms2_tracknr</option></command>
2609                 </term>
2610                 <listitem>
2611                         Track number in current XMMS2 song
2612                         <para></para></listitem>
2613         </varlistentry>
2614
2615         <varlistentry>
2616                 <term>
2617                         <command><option>xmms2_bitrate</option></command>
2618                 </term>
2619                 <listitem>
2620                         Bitrate of current song
2621                         <para></para></listitem>
2622         </varlistentry>
2623
2624         <varlistentry>
2625                 <term>
2626                         <command><option>xmms2_id</option></command>
2627                 </term>
2628                 <listitem>
2629                         XMMS2 id of current song
2630                         <para></para></listitem>
2631         </varlistentry>
2632
2633         <varlistentry>
2634                 <term>
2635                         <command><option>xmms2_duration</option></command>
2636                 </term>
2637                 <listitem>
2638                         Duration of current song
2639                         <para></para></listitem>
2640         </varlistentry>
2641
2642         <varlistentry>
2643                 <term>
2644                         <command><option>xmms2_elapsed</option></command>
2645                 </term>
2646                 <listitem>
2647                         Song's elapsed time
2648                         <para></para></listitem>
2649         </varlistentry>
2650
2651         <varlistentry>
2652                 <term>
2653                         <command><option>xmms2_size</option></command>
2654                 </term>
2655                 <listitem>
2656                         Size of current song
2657                         <para></para></listitem>
2658         </varlistentry>
2659
2660         <varlistentry>
2661                 <term>
2662                         <command><option>xmms2_percent</option></command>
2663                 </term>
2664                 <listitem>
2665                         Percent of song's progress
2666                         <para></para></listitem>
2667         </varlistentry>
2668
2669         <varlistentry>
2670                 <term>
2671                         <command><option>xmms2_status</option></command>
2672                 </term>
2673                 <listitem>
2674                         XMMS2 status (Playing, Paused, Stopped, or Disconnected)
2675                         <para></para></listitem>
2676         </varlistentry>
2677
2678         <varlistentry>
2679                 <term>
2680                         <command><option>xmms2_bar</option></command>
2681                         <option>(height),(width)</option>
2682                 </term>
2683                 <listitem>
2684                         Bar of XMMS2's progress
2685                         <para></para></listitem>
2686         </varlistentry>
2687
2688         <varlistentry>
2689                 <term>
2690                         <command><option>xmms2_smart</option></command>
2691                 </term>
2692                 <listitem>
2693                         Prints the song name in either the form "artist - title" or file name, depending on whats available
2694                         <para></para></listitem>
2695         </varlistentry>
2696         <varlistentry>
2697                 <term>
2698                         <command><option>if_xmms2_connected</option></command>
2699                 </term>
2700                 <listitem>
2701                         Display everything between $if_xmms2_connected and the matching $endif if xmms2 is running.
2702                         <para></para></listitem>
2703         </varlistentry>
2704
2705         <varlistentry>
2706                 <term>
2707                         <command><option>eve</option></command>
2708                         <option>api_userid api_key character_id</option>
2709                 </term>
2710                 <listitem>
2711                         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.
2712                         <para></para></listitem>
2713         </varlistentry>
2714
2715 </variablelist>