Added support for EVE-Online skill monitoring (thanks Asbjørn); fixed up/downspeedgra...
[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>acpitempf</option></command>
53                 </term>
54                 <listitem>
55                         ACPI temperature in F.
56                         <para></para></listitem>
57         </varlistentry>
58
59         <varlistentry>
60                 <term>
61                         <command><option>adt746xcpu</option></command>
62                 </term>
63                 <listitem>
64                         CPU temperature from therm_adt746x
65                         <para></para></listitem>
66         </varlistentry>
67
68         <varlistentry>
69                 <term>
70                         <command><option>adt746xfan</option></command>
71                 </term>
72                 <listitem>
73                         Fan speed from therm_adt746x
74                         <para></para></listitem>
75         </varlistentry>
76
77         <varlistentry>
78                 <term>
79                         <command><option>alignr</option></command>
80                         <option>(num)</option>
81                 </term>
82                 <listitem>
83                         Right-justify text, with space of N
84                         <para></para></listitem>
85         </varlistentry>
86
87         <varlistentry>
88                 <term>
89                         <command><option>alignc</option></command>
90                         <option>(num)</option>
91                 </term>
92                 <listitem>
93                         Align text to centre
94                         <para></para></listitem>
95         </varlistentry>
96
97         <varlistentry>
98                 <term>
99                         <command><option>apm_adapter</option></command>
100                 </term>
101                 <listitem>
102                         Display APM AC adapter status (FreeBSD only)
103                         <para></para></listitem>
104         </varlistentry>
105
106         <varlistentry>
107                 <term>
108                         <command><option>apm_battery_life</option></command>
109                 </term>
110                 <listitem>
111                         Display APM battery life in percent (FreeBSD only)
112                         <para></para></listitem>
113         </varlistentry>
114
115         <varlistentry>
116                 <term>
117                         <command><option>apm_battery_time</option></command>
118                 </term>
119                 <listitem>
120                         Display remaining APM battery life in hh:mm:ss or "unknown" if
121                         AC adapterstatus is on-line or charging (FreeBSD only)
122                         <para></para></listitem>
123         </varlistentry>
124
125         <varlistentry>
126                 <term>
127                         <command><option>audacious_bar</option></command>
128                         <option>(height),(width)</option>
129                 </term>
130                 <listitem>
131                         Progress bar
132                         <para></para></listitem>
133         </varlistentry>
134
135         <varlistentry>
136                 <term>
137                         <command><option>audacious_bitrate</option></command>
138                 </term>
139                 <listitem>
140                         Bitrate of current tune
141                         <para></para></listitem>
142         </varlistentry>
143
144         <varlistentry>
145                 <term>
146                         <command><option>audacious_channels</option></command>
147                 </term>
148                 <listitem>
149                         Number of audio channels of current tune
150                         <para></para></listitem>
151         </varlistentry>
152
153         <varlistentry>
154                 <term>
155                         <command><option>audacious_filename</option></command>
156                 </term>
157                 <listitem>
158                         Full path and filename of current tune
159                         <para></para></listitem>
160         </varlistentry>
161
162         <varlistentry>
163                 <term>
164                         <command><option>audacious_frequency</option></command>
165                 </term>
166                 <listitem>
167                         Sampling frequency of current tune
168                         <para></para></listitem>
169         </varlistentry>
170
171         <varlistentry>
172                 <term>
173                         <command><option>audacious_length</option></command>
174                 </term>
175                 <listitem>
176                         Total length of current tune as MM:SS
177                         <para></para></listitem>
178         </varlistentry>
179
180         <varlistentry>
181                 <term>
182                         <command><option>audacious_length_seconds</option></command>
183                 </term>
184                 <listitem>
185                         Total length of current tune in seconds
186                         <para></para></listitem>
187         </varlistentry>
188
189         <varlistentry>
190                 <term>
191                         <command><option>audacious_playlist_position</option></command>
192                 </term>
193                 <listitem>
194                         Playlist position of current tune
195                         <para></para></listitem>
196         </varlistentry>
197
198         <varlistentry>
199                 <term>
200                         <command><option>audacious_playlist_length</option></command>
201                 </term>
202                 <listitem>
203                         Number of tunes in playlist
204                         <para></para></listitem>
205         </varlistentry>
206
207         <varlistentry>
208                 <term>
209                         <command><option>audacious_position</option></command>
210                 </term>
211                 <listitem>
212                         Position of current tune (MM:SS)
213                         <para></para></listitem>
214         </varlistentry>
215
216         <varlistentry>
217                 <term>
218                         <command><option>audacious_position_seconds</option></command>
219                 </term>
220                 <listitem>
221                         Position of current tune in seconds
222                         <para></para></listitem>
223         </varlistentry>
224
225         <varlistentry>
226                 <term>
227                         <command><option>audacious_status</option></command>
228                 </term>
229                 <listitem>
230                         Player status (Playing/Paused/Stopped/Not running)
231                         <para></para></listitem>
232         </varlistentry>
233
234         <varlistentry>
235                 <term>
236                         <command><option>audacious_title</option></command>
237                         <option>(max length)</option>
238                 </term>
239                 <listitem>
240                         Title of current tune with optional maximum length specifier
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_bar</option></command>
257                         <option>(height),(width) (num)</option>
258                 </term>
259                 <listitem>
260                         Battery percentage remaining of ACPI battery in a bar.  ACPI battery number can be given as argument (default is BAT0).
261                         <para></para></listitem>
262         </varlistentry>
263
264         <varlistentry>
265                 <term>
266                         <command><option>battery_percent</option></command>
267                         <option>(num)</option>
268                 </term>
269                 <listitem>
270                         Battery percentage remaining for ACPI battery.  ACPI battery number can be given as argument (default is BAT0).
271                         <para></para></listitem>
272         </varlistentry>
273
274         <varlistentry>
275                 <term>
276                         <command><option>battery_time</option></command>
277                         <option>(num)</option>
278                 </term>
279                 <listitem>
280                         Battery charge/discharge time remaining of ACPI battery.  ACPI battery number can be given as argument (default is BAT0).
281                         <para></para></listitem>
282         </varlistentry>
283
284         <varlistentry>
285                 <term>
286                         <command><option>bmpx_artist</option></command>
287                 </term>
288                 <listitem>
289                         Artist in current BMPx track
290                         <para></para></listitem>
291         </varlistentry>
292
293         <varlistentry>
294                 <term>
295                         <command><option>bmpx_album</option></command>
296                 </term>
297                 <listitem>
298                         Album in current BMPx track
299                         <para></para></listitem>
300         </varlistentry>
301
302         <varlistentry>
303                 <term>
304                         <command><option>bmpx_title</option></command>
305                 </term>
306                 <listitem>
307                         Title of the current BMPx track
308                         <para></para></listitem>
309         </varlistentry>
310
311         <varlistentry>
312                 <term>
313                         <command><option>bmpx_track</option></command>
314                 </term>
315                 <listitem>
316                         Track number of the current BMPx track
317                         <para></para></listitem>
318         </varlistentry>
319
320         <varlistentry>
321                 <term>
322                         <command><option>bmpx_bitrate</option></command>
323                 </term>
324                 <listitem>
325                         Bitrate of the current BMPx track
326                         <para></para></listitem>
327         </varlistentry>
328
329         <varlistentry>
330                 <term>
331                         <command><option>bmpx_uri</option></command>
332                 </term>
333                 <listitem>
334                         URI of the current BMPx track
335                         <para></para></listitem>
336         </varlistentry>
337
338         <varlistentry>
339                 <term>
340                         <command><option>buffers</option></command>
341                 </term>
342                 <listitem>
343                         Amount of memory buffered
344                         <para></para></listitem>
345         </varlistentry>
346
347         <varlistentry>
348                 <term>
349                         <command><option>cached</option></command>
350                 </term>
351                 <listitem>
352                         Amount of memory cached
353                         <para></para></listitem>
354         </varlistentry>
355
356         <varlistentry>
357                 <term>
358                         <command><option>color</option></command>
359                         <option>(color)</option>
360                 </term>
361                 <listitem>
362                         Change drawing color to color
363                         <para></para></listitem>
364         </varlistentry>
365
366         <varlistentry>
367                 <term><command><option>colorN</option></command></term>
368                 <listitem>
369                         Change drawing color to colorN configuration option, where N is a digit between 0 and 9, inclusively.
370                         <para></para></listitem>
371         </varlistentry>
372
373         <varlistentry>
374                 <term>
375                         <command><option>conky_version</option></command>
376                 </term>
377                 <listitem>
378                         Conky version
379                         <para></para></listitem>
380         </varlistentry>
381
382         <varlistentry>
383                 <term>
384                         <command><option>conky_build_date</option></command>
385                 </term>
386                 <listitem>
387                         Date Conky was built
388                         <para></para></listitem>
389         </varlistentry>
390
391         <varlistentry>
392                 <term>
393                         <command><option>conky_bulid_arch</option></command>
394                 </term>
395                 <listitem>
396                         CPU architecture Conky was built for
397                         <para></para></listitem>
398         </varlistentry>
399
400         <varlistentry>
401                 <term>
402                         <command><option>cpu</option></command>
403                         <option>(cpuN)</option>
404                 </term>
405                 <listitem>
406                         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.
407                         <para></para></listitem>
408         </varlistentry>
409
410         <varlistentry>
411                 <term>
412                         <command><option>cpubar</option></command>
413                         <option>(cpu number) (height),(width)</option>
414                 </term>
415                 <listitem>
416                         Bar that shows CPU usage, height is bar's height in pixels.  See $cpu for more info on SMP.
417                         <para></para></listitem>
418         </varlistentry>
419
420         <varlistentry>
421                 <term>
422                         <command><option>cpugraph</option></command>
423                         <option>normal|log (cpu number) (height),(width) (gradient colour 1) (gradient colour 2)</option>
424                 </term>
425                 <listitem>
426                         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".
427                         <para></para></listitem>
428         </varlistentry>
429
430         <varlistentry>
431                 <term>
432                         <command><option>diskio</option></command>
433                         <option>(device)</option>
434                 </term>
435                 <listitem>
436                         Displays current disk IO.  Device is optional, and takes the form of sda for /dev/sda.  Individual partitions are allowed.
437                         <para></para></listitem>
438         </varlistentry>
439
440         <varlistentry>
441                 <term>
442                         <command><option>diskiograph</option></command>
443                         <option>normal|log (device) (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
444                 </term>
445                 <listitem>
446                         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".
447                         <para></para></listitem>
448         </varlistentry>
449
450         <varlistentry>
451                 <term>
452                         <command><option>diskio_read</option></command>
453                         <option>(device)</option>
454                 </term>
455                 <listitem>
456                         Displays current disk IO for reads.  Device as in diskio.
457                         <para></para></listitem>
458         </varlistentry>
459
460         <varlistentry>
461                 <term>
462                         <command><option>diskiograph_read</option></command>
463                         <option>normal|log (device) (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
464                 </term>
465                 <listitem>
466                         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".
467                         <para></para></listitem>
468         </varlistentry>
469
470         <varlistentry>
471                 <term>
472                         <command><option>diskio_write</option></command>
473                         <option>(device)</option>
474                 </term>
475                 <listitem>
476                         Displays current disk IO for writes.  Device as in diskio.
477                         <para></para></listitem>
478         </varlistentry>
479
480         <varlistentry>
481                 <term>
482                         <command><option>diskiograph_write</option></command>
483                         <option>normal|log (device) (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
484                 </term>
485                 <listitem>
486                         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".
487                         <para></para></listitem>
488         </varlistentry>
489
490         <varlistentry>
491                 <term>
492                         <command><option>disk_protect</option></command>
493                         <option>device</option>
494                 </term>
495                 <listitem>
496                         Disk protection status, if supported (needs kernel-patch). Prints either "frozen" or "free  " (note the padding).
497                         <para></para></listitem>
498         </varlistentry>
499
500         <varlistentry>
501                 <term>
502                         <command><option>downspeed</option></command>
503                         <option>net</option>
504                 </term>
505                 <listitem>
506                         Download speed in KiB
507                         <para></para></listitem>
508         </varlistentry>
509
510         <varlistentry>
511                 <term>
512                         <command><option>downspeedf</option></command>
513                         <option>net</option>
514                 </term>
515                 <listitem>
516                         Download speed in KiB with one decimal
517                         <para></para></listitem>
518         </varlistentry>
519
520         <varlistentry>
521                 <term>
522                         <command><option>downspeedgraph</option></command>
523                         <option>normal|log net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
524                 </term>
525                 <listitem>
526                         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".
527                         <para></para></listitem>
528         </varlistentry>
529
530         <varlistentry>
531                 <term>
532                         <command><option>else</option></command>
533                 </term>
534                 <listitem>
535                         Text to show if any of the above are not true
536                         <para></para></listitem>
537         </varlistentry>
538
539         <varlistentry>
540                 <term>
541                         <command><option>entropy_avail</option></command>
542                 </term>
543                 <listitem>
544                         Current entropy available for crypto freaks
545                         <para></para></listitem>
546         </varlistentry>
547
548         <varlistentry>
549                 <term>
550                         <command><option>entropy_bar</option></command>
551                         <option>(height),(width)</option>
552                 </term>
553                 <listitem>
554                         Normalized bar of available entropy for crypto freaks
555                         <para></para></listitem>
556         </varlistentry>
557
558         <varlistentry>
559                 <term>
560                         <command><option>entropy_poolsize</option></command>
561                 </term>
562                 <listitem>
563                         Total size of system entropy pool for crypto freaks
564                         <para></para></listitem>
565         </varlistentry>
566
567         <varlistentry>
568                 <term>
569                         <command><option>exec</option></command>
570                         <option>command</option>
571                 </term>
572                 <listitem>
573                         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.
574                         <para></para></listitem>
575         </varlistentry>
576
577         <varlistentry>
578                 <term>
579                         <command><option>execbar</option></command>
580                         <option>command</option>
581                 </term>
582                 <listitem>
583                         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.
584                         <para></para></listitem>
585         </varlistentry>
586
587         <varlistentry>
588                 <term>
589                         <command><option>execgraph</option></command>
590                         <option>(normal|log) command</option>
591                 </term>
592                 <listitem>
593                         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.
594                         <para></para></listitem>
595         </varlistentry>
596
597         <varlistentry>
598                 <term>
599                         <command><option>execi</option></command>
600                         <option>interval command</option>
601                 </term>
602                 <listitem>
603                         Same as exec but with specific interval. Interval can't be less than update_interval in configuration. See also $texeci
604                         <para></para></listitem>
605         </varlistentry>
606
607         <varlistentry>
608                 <term>
609                         <command><option>execibar</option></command>
610                         <option>interval command</option>
611                 </term>
612                 <listitem>
613                         Same as execbar, except with an interval
614                         <para></para></listitem>
615         </varlistentry>
616
617         <varlistentry>
618                 <term>
619                         <command><option>execigraph</option></command>
620                         <option>interval command</option>
621                 </term>
622                 <listitem>
623                         Same as execgraph, but takes an interval arg graphs values
624                         <para></para></listitem>
625         </varlistentry>
626
627         <varlistentry>
628                 <term>
629                         <command><option>execp</option></command>
630                         <option>command</option>
631                 </term>
632                 <listitem>
633                         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.
634                         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.
635                         <para></para></listitem>
636         </varlistentry>
637
638         <varlistentry>
639                 <term>
640                         <command><option>execpi</option></command>
641                         <option>interval command</option>
642                 </term>
643                 <listitem>
644                         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.
645                         <para></para></listitem>
646         </varlistentry>
647
648         <varlistentry>
649                 <term>
650                         <command><option>font</option></command>
651                         <option>(font)</option>
652                 </term>
653                 <listitem>
654                         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)
655                         <para></para></listitem>
656         </varlistentry>
657
658         <varlistentry>
659                 <term>
660                         <command><option>freq</option></command>
661                         <option>(n)</option>
662                 </term>
663                 <listitem>
664                         Returns CPU #n's frequency in MHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
665                         <para></para></listitem>
666         </varlistentry>
667         <varlistentry>
668                 <term>
669                         <command><option>freq_g</option></command>
670                         <option>(n)</option>
671                 </term>
672                 <listitem>
673                         Returns CPU #n's frequency in GHz. CPUs are counted from 1. If omitted, the parameter defaults to 1.
674                         <para></para></listitem>
675         </varlistentry>
676
677         <varlistentry>
678                 <term>
679                         <command><option>freq_dyn</option></command>
680                         <option>(n)</option>
681                 </term>
682                 <listitem>
683                         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.
684                         <para></para></listitem>
685         </varlistentry>
686
687         <varlistentry>
688                 <term>
689                         <command><option>freq_dyn_g</option></command>
690                         <option>(n)</option>
691                 </term>
692                 <listitem>
693                         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.
694                         <para></para></listitem>
695         </varlistentry>
696
697         <varlistentry>
698                 <term>
699                         <command><option>fs_bar</option></command>
700                         <option>(height),(width) fs</option>
701                 </term>
702                 <listitem>
703                         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.
704                         <para></para></listitem>
705         </varlistentry>
706
707         <varlistentry>
708                 <term>
709                         <command><option>fs_free</option></command>
710                         <option>(fs)</option>
711                 </term>
712                 <listitem>
713                         Free space on a file system available for users.
714                         <para></para></listitem>
715         </varlistentry>
716
717         <varlistentry>
718                 <term>
719                         <command><option>fs_free_perc</option></command>
720                         <option>(fs)</option>
721                 </term>
722                 <listitem>
723                         Free percentage of space on a file system available for users.
724                         <para></para></listitem>
725         </varlistentry>
726
727         <varlistentry>
728                 <term>
729                         <command><option>fs_size</option></command>
730                         <option>(fs)</option>
731                 </term>
732                 <listitem>
733                         File system size
734                         <para></para></listitem>
735         </varlistentry>
736
737         <varlistentry>
738                 <term>
739                         <command><option>fs_type</option></command>
740                         <option>(fs)</option>
741                 </term>
742                 <listitem>
743                         File system type
744                         <para></para></listitem>
745         </varlistentry>
746
747         <varlistentry>
748                 <term>
749                         <command><option>fs_used</option></command>
750                         <option>(fs)</option>
751                 </term>
752                 <listitem>
753                         File system used space
754                         <para></para></listitem>
755         </varlistentry>
756
757         <varlistentry>
758                 <term>
759                         <command><option>goto</option></command>
760                         <option>x</option>
761                 </term>
762                 <listitem>
763                         The next element will be printed at position 'x'.
764                         <para></para></listitem>
765         </varlistentry>
766
767         <varlistentry>
768                 <term>
769                         <command><option>gw_iface</option></command>
770                 </term>
771                 <listitem>
772                         Displays the default route's interface or "multiple"/"none" accordingly.
773                         <para></para></listitem>
774         </varlistentry>
775
776         <varlistentry>
777                 <term>
778                         <command><option>gw_ip</option></command>
779                 </term>
780                 <listitem>
781                         Displays the default gateway's IP or "multiple"/"none" accordingly.
782                         <para></para></listitem>
783         </varlistentry>
784
785         <varlistentry>
786                 <term>
787                         <command><option>hddtemp</option></command>
788                         <option>dev, (host,(port))</option>
789                 </term>
790                 <listitem>
791                         Displays temperature of a selected hard disk drive as reported by the hddtemp daemon running on host:port.
792                         Default host is 127.0.0.1, default port is 7634.
793                         <para></para></listitem>
794         </varlistentry>
795
796         <varlistentry>
797                 <term>
798                         <command><option>head</option></command>
799                         <option>logfile lines (interval)</option>
800                 </term>
801                 <listitem>
802                         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.
803                         <para></para></listitem>
804         </varlistentry>
805
806         <varlistentry>
807                 <term>
808                         <command><option>hr</option></command>
809                         <option>(height)</option>
810                 </term>
811                 <listitem>
812                         Horizontal line, height is the height in pixels
813                         <para></para></listitem>
814         </varlistentry>
815
816         <varlistentry>
817                 <term>
818                         <command><option>hwmon</option></command>
819                         <option>(dev) type n</option>
820                 </term>
821                 <listitem>
822                         Hwmon sensor from sysfs (Linux 2.6). Parameter dev may be omitted if you have only one hwmon device. Parameter type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n is number of the sensor. See /sys/class/hwmon/ on your local computer.
823                         <para></para></listitem>
824         </varlistentry>
825
826         <varlistentry>
827                 <term>
828                         <command><option>iconv_start</option></command>
829                         <option>codeset_from codeset_to</option>
830                 </term>
831                 <listitem>
832                         Convert text from one codeset to another using GNU iconv.  Needs to be stopped with iconv_stop.
833                         <para></para></listitem>
834         </varlistentry>
835
836         <varlistentry>
837                 <term>
838                         <command><option>iconv_stop</option></command>
839                         <option></option>
840                 </term>
841                 <listitem>
842                         Stop iconv codeset conversion.
843                         <para></para></listitem>
844         </varlistentry>
845
846         <varlistentry>
847                 <term>
848                         <command><option>i2c</option></command>
849                         <option>(dev) type n</option>
850                 </term>
851                 <listitem>
852                         I2C sensor from sysfs (Linux 2.6).  Parameter dev may be omitted if you have only one I2C device.  Parameter type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Celsius) or 'tempf' (Fahrenheit) meaning temperature.  Parameter n is number of the sensor. See /sys/bus/i2c/devices/ on your local computer.
853                         <para></para></listitem>
854         </varlistentry>
855
856         <varlistentry>
857                 <term>
858                         <command><option>i8k_ac_status</option></command>
859                         <option></option>
860                 </term>
861                 <listitem>
862                         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.
863                         <para></para></listitem>
864         </varlistentry>
865
866         <varlistentry>
867                 <term>
868                         <command><option>i8k_bios</option></command>
869                         <option></option>
870                 </term>
871                 <listitem>
872                         If running the i8k kernel driver for Inspiron laptops, displays the bios version as listed in /proc/i8k.
873                         <para></para></listitem>
874         </varlistentry>
875
876         <varlistentry>
877                 <term>
878                         <command><option>i8k_buttons_status</option></command>
879                         <option></option>
880                 </term>
881                 <listitem>
882                         If running the i8k kernel driver for Inspiron laptops, displays the volume buttons status as listed in /proc/i8k.
883                         <para></para></listitem>
884         </varlistentry>
885
886         <varlistentry>
887                 <term>
888                         <command><option>i8k_cpu_temp</option></command>
889                         <option></option>
890                 </term>
891                 <listitem>
892                         If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Celsius, as reported by /proc/i8k.
893                         <para></para></listitem>
894         </varlistentry>
895
896         <varlistentry>
897                 <term>
898                         <command><option>i8k_cpu_tempf</option></command>
899                         <option></option>
900                 </term>
901                 <listitem>
902                         If running the i8k kernel driver for Inspiron laptops, displays the cpu temperature in Fahrenheit, as reported by /proc/i8k.
903                         <para></para></listitem>
904         </varlistentry>
905
906         <varlistentry>
907                 <term>
908                         <command><option>i8k_left_fan_rpm</option></command>
909                         <option></option>
910                 </term>
911                 <listitem>
912                         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.
913                         <para></para></listitem>
914         </varlistentry>
915
916         <varlistentry>
917                 <term>
918                         <command><option>i8k_left_fan_status</option></command>
919                         <option></option>
920                 </term>
921                 <listitem>
922                         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.
923                         <para></para></listitem>
924         </varlistentry>
925
926         <varlistentry>
927                 <term>
928                         <command><option>i8k_right_fan_rpm</option></command>
929                         <option></option>
930                 </term>
931                 <listitem>
932                         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.
933                         <para></para></listitem>
934         </varlistentry>
935
936         <varlistentry>
937                 <term>
938                         <command><option>i8k_right_fan_status</option></command>
939                         <option></option>
940                 </term>
941                 <listitem>
942                         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.
943                         <para></para></listitem>
944         </varlistentry>
945
946         <varlistentry>
947                 <term>
948                         <command><option>i8k_serial</option></command>
949                         <option></option>
950                 </term>
951                 <listitem>
952                         If running the i8k kernel driver for Inspiron laptops, displays your laptop serial number as listed in /proc/i8k.
953                         <para></para></listitem>
954         </varlistentry>
955
956         <varlistentry>
957                 <term>
958                         <command><option>i8k_version</option></command>
959                         <option></option>
960                 </term>
961                 <listitem>
962                         If running the i8k kernel driver for Inspiron laptops, displays the version formatting of /proc/i8k.
963                         <para></para></listitem>
964         </varlistentry>
965
966         <varlistentry>
967                 <term>
968                         <command><option>ibm_fan</option></command>
969                 </term>
970                 <listitem>
971                         If running the IBM ACPI, displays the fan speed.
972                         <para></para></listitem>
973         </varlistentry>
974
975         <varlistentry>
976                 <term>
977                         <command><option>ibm_temps</option></command>
978                         <option>N</option>
979                 </term>
980                 <listitem>
981                         If running the IBM ACPI, displays the temperatures
982                         from the IBM temperature sensors (N=0..7) Sensor 0 is
983                         on the CPU, 3 is on the GPU.
984                         <para></para></listitem>
985         </varlistentry>
986
987         <varlistentry>
988                 <term>
989                         <command><option>ibm_volume</option></command>
990                 </term>
991                 <listitem>
992                         If running the IBM ACPI, displays the "master" volume,
993                         controlled by the volume keys (0-14).
994                         <para></para></listitem>
995         </varlistentry>
996
997         <varlistentry>
998                 <term>
999                         <command><option>ibm_brightness</option></command>
1000                 </term>
1001                 <listitem>
1002                         If running the IBM ACPI, displays the brigtness of the
1003                         laptops's LCD (0-7).
1004                         <para></para></listitem>
1005         </varlistentry>
1006
1007         <varlistentry>
1008                 <term>
1009                         <command><option>if_empty</option></command>
1010                         <option>(var)</option>
1011                 </term>
1012                 <listitem>
1013                         if conky variable VAR is empty, display everything between $if_empty and the matching $endif
1014                         <para></para></listitem>
1015         </varlistentry>
1016
1017         <varlistentry>
1018                 <term>
1019                         <command><option>if_gw</option></command>
1020                 </term>
1021                 <listitem>
1022                         if there is at least one default gateway, display everything between $if_gw and the matching $endif
1023                         <para></para></listitem>
1024         </varlistentry>
1025
1026         <varlistentry>
1027                 <term>
1028                         <command><option>if_running</option></command>
1029                         <option>(process)</option>
1030                 </term>
1031                 <listitem>
1032                         if PROCESS is running, display everything $if_running and the matching $endif
1033                         <para></para></listitem>
1034         </varlistentry>
1035
1036         <varlistentry>
1037                 <term>
1038                         <command><option>if_existing</option></command>
1039                         <option>file (string)</option>
1040                 </term>
1041                 <listitem>
1042                         if FILE exists, display everything between if_existing and the matching $endif.  The optional second paramater checks for FILE containing the specified string and prints everything between $if_existing and the matching $endif.
1043                         <para></para></listitem>
1044         </varlistentry>
1045
1046         <varlistentry>
1047                 <term>
1048                         <command><option>if_mounted</option></command>
1049                         <option>(mountpoint)</option>
1050                 </term>
1051                 <listitem>
1052                         if MOUNTPOINT is mounted, display everything between $if_mounted and the matching $endif
1053                         <para></para></listitem>
1054         </varlistentry>
1055
1056         <varlistentry>
1057                 <term>
1058                         <command><option>if_smapi_bat_installed</option></command>
1059                         <option>(INDEX)</option>
1060                 </term>
1061                 <listitem>
1062                         when using smapi, if the battery with index INDEX is installed, display everything between $if_smapi_bat_installed and the matching $endif
1063                         <para></para></listitem>
1064         </varlistentry>
1065
1066         <varlistentry>
1067                 <term>
1068                         <command><option>if_up</option></command>
1069                         <option>(interface)</option>
1070                 </term>
1071                 <listitem>
1072                         if INTERFACE exists and is up, display everything between $if_up and the matching $endif
1073                         <para></para></listitem>
1074         </varlistentry>
1075
1076         <varlistentry>
1077                 <term>
1078                         <command><option>imap_messages</option></command>
1079                         <option>(args)</option>
1080                 </term>
1081                 <listitem>
1082                         Displays the number of messages in your global IMAP inbox by default.  You can define individual IMAP inboxes seperately by passing arguments to this object.  Arguments are: "host user pass [-i interval] [-p port] [-e command]".  Default port is 143, default interval is 5 minutes.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1083                         <para></para></listitem>
1084         </varlistentry>
1085
1086         <varlistentry>
1087                 <term>
1088                         <command><option>imap_unseen</option></command>
1089                         <option>(args)</option>
1090                 </term>
1091                 <listitem>
1092                         Displays the number of unseen messages in your global IMAP inbox by default.  You can define individual IMAP inboxes seperately by passing arguments to this object.  Arguments are: "host user pass [-i interval] [-p port] [-e command]".  Default port is 143, default interval is 5 minutes.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1093                         <para></para></listitem>
1094         </varlistentry>
1095
1096         <varlistentry>
1097                 <term>
1098                         <command><option>ioscheduler</option></command>
1099                         <option>disk</option>
1100                 </term>
1101                 <listitem>
1102                         Prints the current ioscheduler used for the given disk name (i.e. e.g. "hda" or "sdb")
1103                         <para></para></listitem>
1104         </varlistentry>
1105
1106         <varlistentry>
1107                 <term>
1108                         <command><option>kernel</option></command>
1109                 </term>
1110                 <listitem>
1111                         Kernel version
1112                         <para></para></listitem>
1113         </varlistentry>
1114
1115         <varlistentry>
1116                 <term>
1117                         <command><option>laptop_mode</option></command>
1118                 </term>
1119                 <listitem>
1120                         The value of /proc/sys/vm/laptop_mode
1121                         <para></para></listitem>
1122         </varlistentry>
1123
1124         <varlistentry>
1125                 <term>
1126                         <command><option>loadavg</option></command>
1127                 </term>
1128                 <listitem>
1129                         (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
1130                         <para></para></listitem>
1131         </varlistentry>
1132
1133         <varlistentry>
1134                 <term>
1135                         <command><option>loadgraph</option></command>
1136                         <option>normal|log (height),(width) (gradient colour 1) (gradient colour 2)</option>
1137                 </term>
1138                 <listitem>
1139                         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".
1140                         <para></para></listitem>
1141         </varlistentry>
1142
1143         <varlistentry>
1144                 <term>
1145                         <command><option>lines</option></command>
1146                         <option>textfile</option>
1147                 </term>
1148                 <listitem>
1149                         Displays the number of lines in the given file
1150                         <para></para></listitem>
1151         </varlistentry>
1152
1153         <varlistentry>
1154                 <term>
1155                         <command><option>machine</option></command>
1156                 </term>
1157                 <listitem>
1158                         Machine, i686 for example
1159                         <para></para></listitem>
1160         </varlistentry>
1161
1162         <varlistentry>
1163                 <term>
1164                         <command><option>mails</option></command>
1165                         <option>(mailbox)</option>
1166                         <option>(interval)</option>
1167                 </term>
1168                 <listitem>
1169                         Mail count in the specified mailbox or your mail spool if not.
1170                         Both mbox and maildir type mailboxes are supported. You can
1171                         use a program like fetchmail to get mails from some server
1172                         using your favourite protocol. See also new_mails.
1173                         <para></para></listitem>
1174         </varlistentry>
1175
1176         <varlistentry>
1177                 <term>
1178                         <command><option>mboxscan</option></command>
1179                         <option>(-n number of messages to print) (-fw from width) (-sw subject width) mbox</option>
1180                 </term>
1181                 <listitem>
1182                         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"}
1183                         <para></para></listitem>
1184         </varlistentry>
1185
1186         <varlistentry>
1187                 <term>
1188                         <command><option>mem</option></command>
1189                 </term>
1190                 <listitem>
1191                         Amount of memory in use
1192                         <para></para></listitem>
1193         </varlistentry>
1194
1195         <varlistentry>
1196                 <term>
1197                         <command><option>membar</option></command>
1198                         <option>(height),(width)</option>
1199                 </term>
1200                 <listitem>
1201                         Bar that shows amount of memory in use
1202                         <para></para></listitem>
1203         </varlistentry>
1204
1205         <varlistentry>
1206                 <term>
1207                         <command><option>memgraph</option></command>
1208                         <option>normal|log (height),(width) (gradient colour 1) (gradient colour 2)</option>
1209                 </term>
1210                 <listitem>
1211                         Memory usage graph. Uses a logarithmic scale (to see small numbers) when you use "log" instead of "normal".
1212                         <para></para></listitem>
1213         </varlistentry>
1214
1215         <varlistentry>
1216                 <term>
1217                         <command><option>memeasyfree</option></command>
1218                 </term>
1219                 <listitem>
1220                         Amount of free memory including the memory that is very easily freed (buffers/cache)
1221                         <para></para></listitem>
1222         </varlistentry>
1223
1224         <varlistentry>
1225                 <term>
1226                         <command><option>memfree</option></command>
1227                 </term>
1228                 <listitem>
1229                         Amount of free memory
1230                         <para></para></listitem>
1231         </varlistentry>
1232
1233         <varlistentry>
1234                 <term>
1235                         <command><option>memmax</option></command>
1236                 </term>
1237                 <listitem>
1238                         Total amount of memory
1239                         <para></para></listitem>
1240         </varlistentry>
1241
1242         <varlistentry>
1243                 <term>
1244                         <command><option>memperc</option></command>
1245                 </term>
1246                 <listitem>
1247                         Percentage of memory in use
1248                         <para></para></listitem>
1249         </varlistentry>
1250
1251         <varlistentry>
1252                 <term>
1253                         <command><option>monitor</option></command>
1254                 </term>
1255                 <listitem>
1256                         Number of the monitor on which conky is running
1257                         <para></para></listitem>
1258         </varlistentry>
1259
1260         <varlistentry>
1261                 <term>
1262                         <command><option>monitor_number</option></command>
1263                 </term>
1264                 <listitem>
1265                         Number of monitors
1266                         <para></para></listitem>
1267         </varlistentry>
1268
1269         <varlistentry>
1270                 <term>
1271                         <command><option>mpd_artist</option></command>
1272                 </term>
1273                 <listitem>
1274                         Artist in current MPD song must be enabled at compile
1275                         <para></para></listitem>
1276         </varlistentry>
1277
1278         <varlistentry>
1279                 <term>
1280                         <command><option>mpd_album</option></command>
1281                 </term>
1282                 <listitem>
1283                         Album in current MPD song
1284                         <para></para></listitem>
1285         </varlistentry>
1286
1287         <varlistentry>
1288                 <term>
1289                         <command><option>mpd_bar</option></command>
1290                         <option>(height),(width)</option>
1291                 </term>
1292                 <listitem>
1293                         Bar of mpd's progress
1294                         <para></para></listitem>
1295         </varlistentry>
1296
1297         <varlistentry>
1298                 <term>
1299                         <command><option>mpd_bitrate</option></command>
1300                 </term>
1301                 <listitem>
1302                         Bitrate of current song
1303                         <para></para></listitem>
1304         </varlistentry>
1305
1306         <varlistentry>
1307                 <term>
1308                         <command><option>mpd_status</option></command>
1309                 </term>
1310                 <listitem>
1311                         Playing, stopped, et cetera.
1312                         <para></para></listitem>
1313         </varlistentry>
1314
1315         <varlistentry>
1316                 <term>
1317                         <command><option>mpd_title</option></command>
1318                         <option>(max length)</option>
1319                 </term>
1320                 <listitem>
1321                         Title of current MPD song
1322                         <para></para></listitem>
1323         </varlistentry>
1324
1325         <varlistentry>
1326                 <term>
1327                         <command><option>mpd_vol</option></command>
1328                 </term>
1329                 <listitem>
1330                         MPD's volume
1331                         <para></para></listitem>
1332         </varlistentry>
1333
1334         <varlistentry>
1335                 <term>
1336                         <command><option>mpd_elapsed</option></command>
1337                 </term>
1338                 <listitem>
1339                         Song's elapsed time
1340                         <para></para></listitem>
1341         </varlistentry>
1342
1343         <varlistentry>
1344                 <term>
1345                         <command><option>mpd_length</option></command>
1346                 </term>
1347                 <listitem>
1348                         Song's length
1349                         <para></para></listitem>
1350         </varlistentry>
1351
1352         <varlistentry>
1353                 <term>
1354                         <command><option>mpd_percent</option></command>
1355                 </term>
1356                 <listitem>
1357                         Percent of song's progress
1358                         <para></para></listitem>
1359         </varlistentry>
1360
1361         <varlistentry>
1362                 <term>
1363                         <command><option>mpd_random</option></command>
1364                 </term>
1365                 <listitem>
1366                         Random status (On/Off)
1367                         <para></para></listitem>
1368         </varlistentry>
1369
1370         <varlistentry>
1371                 <term>
1372                         <command><option>mpd_repeat</option></command>
1373                 </term>
1374                 <listitem>
1375                         Repeat status (On/Off)
1376                         <para></para></listitem>
1377         </varlistentry>
1378
1379         <varlistentry>
1380                 <term>
1381                         <command><option>mpd_track</option></command>
1382                 </term>
1383                 <listitem>
1384                         Prints the MPD track field
1385                         <para></para></listitem>
1386         </varlistentry>
1387
1388         <varlistentry>
1389                 <term>
1390                         <command><option>mpd_name</option></command>
1391                 </term>
1392                 <listitem>
1393                         Prints the MPD name field
1394                         <para></para></listitem>
1395         </varlistentry>
1396
1397         <varlistentry>
1398                 <term>
1399                         <command><option>mpd_file</option></command>
1400                 </term>
1401                 <listitem>
1402                         Prints the file name of the current MPD song
1403                         <para></para></listitem>
1404         </varlistentry>
1405
1406         <varlistentry>
1407                 <term>
1408                         <command><option>mpd_smart</option></command>
1409                 </term>
1410                 <listitem>
1411                         Prints the song name in either the form "artist - title" or file name, depending on whats available
1412                         <para></para></listitem>
1413         </varlistentry>
1414
1415         <varlistentry>
1416                 <term>
1417                         <command><option>nameserver</option></command>
1418                         <option>(index)</option>
1419                 </term>
1420                 <listitem>
1421                         Print a nameserver from /etc/resolv.conf. Index starts at and defaults to 0.
1422                         <para></para></listitem>
1423         </varlistentry>
1424
1425         <varlistentry>
1426                 <term>
1427                         <command><option>new_mails</option></command>
1428                         <option>(mailbox)</option>
1429                         <option>(interval)</option>
1430                 </term>
1431                 <listitem>
1432                         Unread mail count in the specified mailbox or mail spool if
1433                         not. Both mbox and maildir type mailboxes are supported.
1434                         <para></para></listitem>
1435         </varlistentry>
1436
1437         <varlistentry>
1438                 <term>
1439                         <command><option>nodename</option></command>
1440                 </term>
1441                 <listitem>
1442                         Hostname
1443                         <para></para></listitem>
1444         </varlistentry>
1445
1446         <varlistentry>
1447                 <term>
1448                         <command><option>nvidia</option></command>
1449                         <option>threshold</option>
1450                         <option>temp</option>
1451                         <option>gpufreq</option>
1452                         <option>memfreq</option>
1453                         <option>imagequality</option>
1454                 </term>
1455                 <listitem>
1456                         Nvidia graficcard support for the XNVCtrl library.
1457                         Each option gives back one integer value:
1458                         (threshold): the thresholdtemperature at which the gpu slows down
1459                         (temp): gives the gpu current temperature
1460                         (gpufreq): gives the current gpu frequency
1461                         (memfreq): gives the current mem frequency
1462                         (imagequality): which imagequality should be choosen by OpenGL applications
1463                         <para></para>
1464                 </listitem>
1465         </varlistentry>
1466
1467         <varlistentry>
1468                 <term>
1469                         <command><option>outlinecolor</option></command>
1470                         <option>(color)</option>
1471                 </term>
1472                 <listitem>
1473                         Change outline color
1474                         <para></para></listitem>
1475         </varlistentry>
1476
1477         <varlistentry>
1478                 <term>
1479                         <command><option>pb_battery</option></command>
1480                         <option>item</option>
1481                 </term>
1482                 <listitem>
1483                         If running on Apple powerbook/ibook, display
1484                         information on battery status. The item parameter
1485                         specifies, what information to display. Exactly one item
1486                         must be specified. Valid items are:
1487                         <simplelist>
1488                                 <member><command>status</command>:
1489                                         Display if battery is fully charged, charging,
1490                                         discharging or absent (running on AC)
1491                                 </member>
1492                                 <member><command>percent</command>:
1493                                         Display charge of battery in percent, if
1494                                         charging or discharging. Nothing will be
1495                                         displayed, if battery is fully charged
1496                                         or absent.
1497                                 </member>
1498                                 <member><command>time</command>:
1499                                         Display the time remaining until the battery
1500                                         will be fully charged or discharged at current
1501                                         rate.  Nothing is displayed, if battery is
1502                                         absent or if it's present but fully charged
1503                                         and not discharging.
1504                                 </member>
1505                         </simplelist>
1506                         <para></para></listitem>
1507         </varlistentry>
1508
1509         <varlistentry>
1510                 <term>
1511                         <command><option>platform</option></command>
1512                         <option>(dev) type n</option>
1513                 </term>
1514                 <listitem>
1515                         Platform sensor from sysfs (Linux 2.6). Parameter dev may be omitted if you have only one platform device. Platform type is either 'in' or 'vol' meaning voltage; 'fan' meaning fan; 'temp' (Celsius) or 'tempf' (Fahrenheit) meaning temperature. Parameter n is number of the sensor. See /sys/bus/platform/devices/ on your local computer.
1516                         <para></para></listitem>
1517         </varlistentry>
1518
1519         <varlistentry>
1520                 <term>
1521                         <command><option>pop3_unseen</option></command>
1522                         <option>(args)</option>
1523                 </term>
1524                 <listitem>
1525                         Displays the number of unseen messages in your global POP3 inbox by default.  You can define individual POP3 inboxes seperately by passing arguments to this object.  Arguments are: "host user pass [-i interval] [-p port] [-e command]".  Default port is 110, default interval is 5 minutes.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1526
1527                         <para></para></listitem>
1528         </varlistentry>
1529
1530         <varlistentry>
1531                 <term>
1532                         <command><option>pop3_used</option></command>
1533                         <option>(args)</option>
1534                 </term>
1535                 <listitem>
1536                         Displays the amount of space (in MiB, 2^20) used in your global POP3 inbox by default.  You can define individual POP3 inboxes seperately by passing arguments to this object.  Arguments are: "host user pass [-i interval] [-p port] [-e command]".  Default port is 110, default interval is 5 minutes.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
1537
1538                         <para></para></listitem>
1539         </varlistentry>
1540
1541         <varlistentry>
1542                 <term>
1543                         <command><option>pre_exec</option></command>
1544                         <option>shell command</option>
1545                 </term>
1546                 <listitem>
1547                         Executes a shell command one time before conky displays anything and puts output as text.
1548                         <para></para></listitem>
1549         </varlistentry>
1550
1551         <varlistentry>
1552                 <term>
1553                         <command><option>processes</option></command>
1554                 </term>
1555                 <listitem>
1556                         Total processes (sleeping and running)
1557                         <para></para></listitem>
1558         </varlistentry>
1559
1560         <varlistentry>
1561                 <term>
1562                         <command><option>running_processes</option></command>
1563                 </term>
1564                 <listitem>
1565                         Running processes (not sleeping), requires Linux 2.6
1566                         <para></para></listitem>
1567         </varlistentry>
1568
1569         <varlistentry>
1570                 <term>
1571                         <command><option>scroll</option></command>
1572                         <option>length text</option>
1573                 </term>
1574                 <listitem>
1575                         Scroll 'text' showing 'length' number of characters at the same time. The text may also contain variables. 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").
1576                         <para></para></listitem>
1577         </varlistentry>
1578
1579         <varlistentry>
1580                 <term>
1581                         <command><option>shadecolor</option></command>
1582                         <option>(color)</option>
1583                 </term>
1584                 <listitem>
1585                         Change shading color
1586                         <para></para></listitem>
1587         </varlistentry>
1588
1589         <varlistentry>
1590                 <term>
1591                         <command><option>smapi</option></command>
1592                         <option>(ARGS)</option>
1593                 </term>
1594                 <listitem>
1595                         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.
1596                         <para></para></listitem>
1597         </varlistentry>
1598
1599         <varlistentry>
1600                 <term>
1601                         <command><option>smapi_bat_bar</option></command>
1602                         <option>(INDEX),(height),(width)</option>
1603                 </term>
1604                 <listitem>
1605                         when using smapi, display the remaining capacity of the battery with index INDEX as a bar.
1606                         <para></para></listitem>
1607         </varlistentry>
1608
1609         <varlistentry>
1610                 <term>
1611                         <command><option>smapi_bat_perc</option></command>
1612                         <option>(INDEX)</option>
1613                 </term>
1614                 <listitem>
1615                         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.
1616                         <para></para></listitem>
1617         </varlistentry>
1618
1619         <varlistentry>
1620                 <term>
1621                         <command><option>smapi_bat_power</option></command>
1622                         <option>INDEX</option>
1623                 </term>
1624                 <listitem>
1625                         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.
1626                         <para></para></listitem>
1627         </varlistentry>
1628
1629         <varlistentry>
1630                 <term>
1631                         <command><option>smapi_bat_temp</option></command>
1632                         <option>INDEX</option>
1633                 </term>
1634                 <listitem>
1635                         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.
1636                         <para></para></listitem>
1637         </varlistentry>
1638
1639         <varlistentry>
1640                 <term>
1641                         <command><option>stippled_hr</option></command>
1642                         <option>(space)</option>
1643                 </term>
1644                 <listitem>
1645                         Stippled (dashed) horizontal line
1646                         <para></para></listitem>
1647         </varlistentry>
1648
1649         <varlistentry>
1650                 <term>
1651                         <command><option>swapbar</option></command>
1652                         <option>(height),(width)</option>
1653                 </term>
1654                 <listitem>
1655                         Bar that shows amount of swap in use
1656                         <para></para></listitem>
1657         </varlistentry>
1658
1659         <varlistentry>
1660                 <term>
1661                         <command><option>swap</option></command>
1662                 </term>
1663                 <listitem>
1664                         Amount of swap in use
1665                         <para></para></listitem>
1666         </varlistentry>
1667
1668         <varlistentry>
1669                 <term>
1670                         <command><option>swapmax</option></command>
1671                 </term>
1672                 <listitem>
1673                         Total amount of swap
1674                         <para></para></listitem>
1675         </varlistentry>
1676
1677         <varlistentry>
1678                 <term>
1679                         <command><option>swapperc</option></command>
1680                 </term>
1681                 <listitem>
1682                         Percentage of swap in use
1683                         <para></para></listitem>
1684         </varlistentry>
1685
1686         <varlistentry>
1687                 <term>
1688                         <command><option>sysname</option></command>
1689                 </term>
1690                 <listitem>
1691                         System name, Linux for example
1692                         <para></para></listitem>
1693         </varlistentry>
1694
1695         <varlistentry>
1696                 <term>
1697                         <command><option>tcp_portmon</option></command>
1698                         <option>port_begin port_end item (index)</option>
1699                         <emphasis>(ip4 only at present)</emphasis>
1700                 </term>
1701                 <listitem>
1702                         TCP port monitor for specified local ports.  Port numbers must be in the range 1 to 65535. Valid items are:
1703                         <simplelist>
1704                                 <member><command>count</command> - total number of connections in the range
1705                                 </member>
1706                                 <member><command>rip</command> - remote ip address
1707                                 </member>
1708                                 <member><command>rhost</command> - remote host name
1709                                 </member>
1710                                 <member><command>rport</command> - remote port number
1711                                 </member>
1712                                 <member><command>rservice</command> - remote service name from /etc/services
1713                                 </member>
1714                                 <member><command>lip</command> - local ip address
1715                                 </member>
1716                                 <member><command>lhost</command> - local host name
1717                                 </member>
1718                                 <member><command>lport</command> - local port number
1719                                 </member>
1720                                 <member><command>lservice</command> - local service name from /etc/services
1721                                 </member>
1722                         </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.
1723                         <simplelist>
1724                                 <member>Examples:</member>
1725                                 <member><command>${tcp_portmon 6881 6999 count}</command> -
1726                                         displays the number of connections in the bittorrent port range</member>
1727                                 <member><command>${tcp_portmon 22 22 rip 0}</command> -
1728                                         displays the remote host ip of the first sshd connection</member>
1729                                 <member><command>${tcp_portmon 22 22 rip 9}</command> -
1730                                         displays the remote host ip of the tenth sshd connection</member>
1731                                 <member><command>${tcp_portmon 1 1024 rhost 0}</command> -
1732                                         displays the remote host name of the first connection on a privileged port</member>
1733                                 <member><command>${tcp_portmon 1 1024 rport 4}</command> -
1734                                         displays the remote host port of the fifth connection on a privileged port</member>
1735                                 <member><command>${tcp_portmon 1 65535 lservice 14}</command> -
1736                                         displays the local service name of the fifteenth connection in the range of all ports</member>
1737                         </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.
1738                 </listitem>
1739         </varlistentry>
1740
1741         <varlistentry>
1742                 <term>
1743                         <command><option>texeci</option></command>
1744                         <option>interval command</option>
1745                 </term>
1746                 <listitem>
1747                         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.
1748                         <para></para></listitem>
1749         </varlistentry>
1750
1751         <varlistentry>
1752                 <term>
1753                         <command><option>offset</option></command>
1754                         <option>(pixels)</option>
1755                 </term>
1756                 <listitem>
1757                         Move text over by N pixels.  See also $voffset.
1758                         <para></para></listitem>
1759         </varlistentry>
1760
1761         <varlistentry>
1762                 <term>
1763                         <command><option>rss</option></command>
1764                         <option>url delay_in_minutes action item_num</option>
1765                 </term>
1766                 <listitem>
1767                         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.
1768                         <para></para></listitem>
1769         </varlistentry>
1770
1771         <varlistentry>
1772                 <term>
1773                         <command><option>tab</option></command>
1774                         <option>(width, (start))</option>
1775                 </term>
1776                 <listitem>
1777                         Puts a tab of the specified width, starting from column 'start'.
1778                         <para></para></listitem>
1779         </varlistentry>
1780
1781         <varlistentry>
1782                 <term>
1783                         <command><option>tail</option></command>
1784                         <option>logfile lines (interval)</option>
1785                 </term>
1786                 <listitem>
1787                         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.
1788                         <para></para></listitem>
1789         </varlistentry>
1790
1791         <varlistentry>
1792                 <term>
1793                         <command><option>time</option></command>
1794                         <option>(format)</option>
1795                 </term>
1796                 <listitem>
1797                         Local time, see man strftime to get more information about format
1798                         <para></para></listitem>
1799         </varlistentry>
1800
1801         <varlistentry>
1802                 <term>
1803                         <command><option>utime</option></command>
1804                         <option>(format)</option>
1805                 </term>
1806                 <listitem>
1807                         Display time in UTC (universal coordinate time).
1808                         <para></para></listitem>
1809         </varlistentry>
1810
1811         <varlistentry>
1812                 <term>
1813                         <command><option>tztime</option></command>
1814                         <option>(timezone) (format)</option>
1815                 </term>
1816                 <listitem>
1817                         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.
1818                         <para></para></listitem>
1819         </varlistentry>
1820
1821         <varlistentry>
1822                 <term>
1823                         <command><option>totaldown</option></command>
1824                         <option>net</option>
1825                 </term>
1826                 <listitem>
1827                         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.
1828                         <para></para></listitem>
1829         </varlistentry>
1830
1831         <varlistentry>
1832                 <term>
1833                         <command><option>top</option></command>
1834                         <option>type, num</option>
1835                 </term>
1836                 <listitem>
1837                         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.
1838                         <para></para></listitem>
1839         </varlistentry>
1840
1841         <varlistentry>
1842                 <term>
1843                         <command><option>top_mem</option></command>
1844                         <option>type, num</option>
1845                 </term>
1846                 <listitem>
1847                         Same as top, except sorted by mem usage instead of cpu
1848                         <para></para></listitem>
1849         </varlistentry>
1850
1851         <varlistentry>
1852                 <term>
1853                         <command><option>totalup</option></command>
1854                         <option>net</option>
1855                 </term>
1856                 <listitem>
1857                         Total upload, this one too, may overflow
1858                         <para></para></listitem>
1859         </varlistentry>
1860
1861         <varlistentry>
1862                 <term>
1863                         <command><option>updates</option></command>
1864                         <option>Number of updates</option>
1865                 </term>
1866                 <listitem>
1867                         for debugging
1868                         <para></para></listitem>
1869         </varlistentry>
1870
1871         <varlistentry>
1872                 <term>
1873                         <command><option>upspeed</option></command>
1874                         <option>net</option>
1875                 </term>
1876                 <listitem>
1877                         Upload speed in KiB
1878                         <para></para></listitem>
1879         </varlistentry>
1880
1881         <varlistentry>
1882                 <term>
1883                         <command><option>upspeedf</option></command>
1884                         <option>net</option>
1885                 </term>
1886                 <listitem>
1887                         Upload speed in KiB with one decimal
1888                         <para></para></listitem>
1889         </varlistentry>
1890
1891         <varlistentry>
1892                 <term>
1893                         <command><option>upspeedgraph</option></command>
1894                         <option>normal|log net (height),(width) (gradient colour 1) (gradient colour 2) (scale)</option>
1895                 </term>
1896                 <listitem>
1897                         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".
1898                         <para></para></listitem>
1899         </varlistentry>
1900
1901         <varlistentry>
1902                 <term>
1903                         <command><option>uptime</option></command>
1904                 </term>
1905                 <listitem>
1906                         Uptime
1907                         <para></para></listitem>
1908         </varlistentry>
1909
1910         <varlistentry>
1911                 <term>
1912                         <command><option>uptime_short</option></command>
1913                 </term>
1914                 <listitem>
1915                         Uptime in a shorter format
1916                         <para></para></listitem>
1917         </varlistentry>
1918
1919         <varlistentry>
1920                 <term>
1921                         <command><option>user_number</option></command>
1922                 </term>
1923                 <listitem>
1924                         Number of users logged in
1925                         <para></para></listitem>
1926         </varlistentry>
1927
1928         <varlistentry>
1929                 <term>
1930                         <command><option>user_names</option></command>
1931                 </term>
1932                 <listitem>
1933                         Lists the names of the users logged in
1934                         <para></para></listitem>
1935         </varlistentry>
1936
1937         <varlistentry>
1938                 <term>
1939                         <command><option>user_terms</option></command>
1940                 </term>
1941                 <listitem>
1942                         Lists the consoles in use
1943                         <para></para></listitem>
1944         </varlistentry>
1945
1946         <varlistentry>
1947                 <term>
1948                         <command><option>user_times</option></command>
1949                 </term>
1950                 <listitem>
1951                         Lists how long users have been logged in for
1952                         <para></para></listitem>
1953         </varlistentry>
1954
1955         <varlistentry>
1956                 <term>
1957                         <command><option>voffset</option></command>
1958                         <option>(pixels)</option>
1959                 </term>
1960                 <listitem>
1961                         Change vertical offset by N pixels.  Negative values will cause text to overlap.  See also $offset.
1962                         <para></para></listitem>
1963         </varlistentry>
1964
1965         <varlistentry>
1966                 <term>
1967                         <command><option>voltage_mv</option></command>
1968                         <option>(n)</option>
1969                 </term>
1970                 <listitem>
1971                         Returns CPU #n's voltage in mV. CPUs are
1972                         counted from 1. If omitted, the parameter
1973                         defaults to 1.
1974                         <para></para></listitem>
1975         </varlistentry>
1976
1977         <varlistentry>
1978                 <term>
1979                         <command><option>voltage_v</option></command>
1980                         <option>(n)</option>
1981                 </term>
1982                 <listitem>
1983                         Returns CPU #n's voltage in V. CPUs are
1984                         counted from 1. If omitted, the parameter
1985                         defaults to 1.
1986                         <para></para></listitem>
1987         </varlistentry>
1988
1989         <varlistentry>
1990                 <term>
1991                         <command><option>wireless_essid</option></command>
1992                         <option>net</option>
1993                 </term>
1994                 <listitem>
1995                         Wireless access point ESSID (Linux only)
1996                         <para></para></listitem>
1997         </varlistentry>
1998
1999         <varlistentry>
2000                 <term>
2001                         <command><option>wireless_mode</option></command>
2002                         <option>net</option>
2003                 </term>
2004                 <listitem>
2005                         Wireless mode (Managed/Ad-Hoc/Master) (Linux only)
2006                         <para></para></listitem>
2007         </varlistentry>
2008
2009         <varlistentry>
2010                 <term>
2011                         <command><option>wireless_bitrate</option></command>
2012                         <option>net</option>
2013                 </term>
2014                 <listitem>
2015                         Wireless bitrate (ie 11 Mb/s) (Linux only)
2016                         <para></para></listitem>
2017         </varlistentry>
2018
2019         <varlistentry>
2020                 <term>
2021                         <command><option>wireless_ap</option></command>
2022                         <option>net</option>
2023                 </term>
2024                 <listitem>
2025                         Wireless access point MAC address (Linux only)
2026                         <para></para></listitem>
2027         </varlistentry>
2028
2029         <varlistentry>
2030                 <term>
2031                         <command><option>wireless_link_qual</option></command>
2032                         <option>net</option>
2033                 </term>
2034                 <listitem>
2035                         Wireless link quality (Linux only)
2036                         <para></para></listitem>
2037         </varlistentry>
2038
2039         <varlistentry>
2040                 <term>
2041                         <command><option>wireless_link_qual_max</option></command>
2042                         <option>net</option>
2043                 </term>
2044                 <listitem>
2045                         Wireless link quality maximum value (Linux only)
2046                         <para></para></listitem>
2047         </varlistentry>
2048
2049         <varlistentry>
2050                 <term>
2051                         <command><option>wireless_link_qual_perc</option></command>
2052                         <option>net</option>
2053                 </term>
2054                 <listitem>
2055                         Wireless link quality in percents (Linux only)
2056                         <para></para></listitem>
2057         </varlistentry>
2058
2059         <varlistentry>
2060                 <term>
2061                         <command><option>wireless_link_bar</option></command>
2062                         <option>(height), (width) net</option>
2063                 </term>
2064                 <listitem>
2065                         Wireless link quality bar (Linux only)
2066                         <para></para></listitem>
2067         </varlistentry>
2068
2069         <varlistentry>
2070                 <term>
2071                         <command><option>words</option></command>
2072                         <option>textfile</option>
2073                 </term>
2074                 <listitem>
2075                         Displays the number of words in the given file
2076                         <para></para></listitem>
2077         </varlistentry>
2078
2079         <varlistentry>
2080                 <term>
2081                         <command><option>xmms2_artist</option></command>
2082                 </term>
2083                 <listitem>
2084                         Artist in current XMMS2 song
2085                         <para></para></listitem>
2086         </varlistentry>
2087
2088         <varlistentry>
2089                 <term>
2090                         <command><option>xmms2_album</option></command>
2091                 </term>
2092                 <listitem>
2093                         Album in current XMMS2 song
2094                         <para></para></listitem>
2095         </varlistentry>
2096
2097         <varlistentry>
2098                 <term>
2099                         <command><option>xmms2_title</option></command>
2100                 </term>
2101                 <listitem>
2102                         Title in current XMMS2 song
2103                         <para></para></listitem>
2104         </varlistentry>
2105
2106         <varlistentry>
2107                 <term>
2108                         <command><option>xmms2_genre</option></command>
2109                 </term>
2110                 <listitem>
2111                         Genre in current XMMS2 song
2112                         <para></para></listitem>
2113         </varlistentry>
2114
2115         <varlistentry>
2116                 <term>
2117                         <command><option>xmms2_comment</option></command>
2118                 </term>
2119                 <listitem>
2120                         Comment in current XMMS2 song
2121                         <para></para></listitem>
2122         </varlistentry>
2123
2124         <varlistentry>
2125                 <term>
2126                         <command><option>xmms2_decoder</option></command>
2127                 </term>
2128                 <listitem>
2129                         Decoder plugin used
2130                         <para></para></listitem>
2131         </varlistentry>
2132
2133         <varlistentry>
2134                 <term>
2135                         <command><option>xmms2_transport</option></command>
2136                 </term>
2137                 <listitem>
2138                         Transport plugin used
2139                         <para></para></listitem>
2140         </varlistentry>
2141
2142         <varlistentry>
2143                 <term>
2144                         <command><option>xmms2_url</option></command>
2145                 </term>
2146                 <listitem>
2147                         Full path to current song
2148                         <para></para></listitem>
2149         </varlistentry>
2150
2151         <varlistentry>
2152                 <term>
2153                         <command><option>xmms2_tracknr</option></command>
2154                 </term>
2155                 <listitem>
2156                         Track number in current XMMS2 song
2157                         <para></para></listitem>
2158         </varlistentry>
2159
2160         <varlistentry>
2161                 <term>
2162                         <command><option>xmms2_bitrate</option></command>
2163                 </term>
2164                 <listitem>
2165                         Bitrate of current song
2166                         <para></para></listitem>
2167         </varlistentry>
2168
2169         <varlistentry>
2170                 <term>
2171                         <command><option>xmms2_id</option></command>
2172                 </term>
2173                 <listitem>
2174                         XMMS2 id of current song
2175                         <para></para></listitem>
2176         </varlistentry>
2177
2178         <varlistentry>
2179                 <term>
2180                         <command><option>xmms2_duration</option></command>
2181                 </term>
2182                 <listitem>
2183                         Duration of current song
2184                         <para></para></listitem>
2185         </varlistentry>
2186
2187         <varlistentry>
2188                 <term>
2189                         <command><option>xmms2_elapsed</option></command>
2190                 </term>
2191                 <listitem>
2192                         Song's elapsed time
2193                         <para></para></listitem>
2194         </varlistentry>
2195
2196         <varlistentry>
2197                 <term>
2198                         <command><option>xmms2_size</option></command>
2199                 </term>
2200                 <listitem>
2201                         Size of current song
2202                         <para></para></listitem>
2203         </varlistentry>
2204
2205         <varlistentry>
2206                 <term>
2207                         <command><option>xmms2_percent</option></command>
2208                 </term>
2209                 <listitem>
2210                         Percent of song's progress
2211                         <para></para></listitem>
2212         </varlistentry>
2213
2214         <varlistentry>
2215                 <term>
2216                         <command><option>xmms2_status</option></command>
2217                 </term>
2218                 <listitem>
2219                         XMMS2 status (Playing, Paused, Stopped, or Disconnected)
2220                         <para></para></listitem>
2221         </varlistentry>
2222
2223         <varlistentry>
2224                 <term>
2225                         <command><option>xmms2_bar</option></command>
2226                         <option>(height),(width)</option>
2227                 </term>
2228                 <listitem>
2229                         Bar of XMMS2's progress
2230                         <para></para></listitem>
2231         </varlistentry>
2232
2233         <varlistentry>
2234                 <term>
2235                         <command><option>xmms2_smart</option></command>
2236                 </term>
2237                 <listitem>
2238                         Prints the song name in either the form "artist - title" or file name, depending on whats available
2239                         <para></para></listitem>
2240         </varlistentry>
2241
2242         <varlistentry>
2243                 <term>
2244                         <command><option>eve</option></command>
2245                         <option>api_userid api_key character_id</option>
2246                 </term>
2247                 <listitem>
2248          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.
2249                         <para></para></listitem>
2250         </varlistentry>
2251
2252 </variablelist>