move conky.1
[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
9         <para></para></listitem>
10 </varlistentry>
11
12 <varlistentry>
13         <term>
14                 <command><option>acpiacadapter</option></command>
15         </term>
16         <listitem>
17                 ACPI ac adapter state.
18         <para></para></listitem>
19 </varlistentry>
20
21 <varlistentry>
22         <term>
23                 <command><option>acpifan</option></command>
24         </term>
25         <listitem>
26                 ACPI fan state
27         <para></para></listitem>
28 </varlistentry>
29
30 <varlistentry>
31         <term>
32                 <command><option>acpitemp</option></command>
33         </term>
34         <listitem>
35                 ACPI temperature in C.
36                 <para></para></listitem>
37 </varlistentry>
38
39 <varlistentry>
40         <term>
41                 <command><option>acpitempf</option></command>
42         </term>
43         <listitem>
44                 ACPI temperature in F.
45                 <para></para></listitem>
46 </varlistentry>
47
48 <varlistentry>
49         <term>
50                 <command><option>adt746xcpu</option></command>
51         </term>
52         <listitem>
53                 CPU temperature from therm_adt746x
54         <para></para></listitem>
55 </varlistentry>
56
57 <varlistentry>
58         <term>
59                 <command><option>adt746xfan</option></command>
60         </term>
61         <listitem>
62                 Fan speed from therm_adt746x
63         <para></para></listitem>
64 </varlistentry>
65
66 <varlistentry>
67         <term>
68                 <command><option>alignr</option></command>
69         <option>(num)</option>
70         </term>
71         <listitem>
72                 Right-justify text, with space of N
73         <para></para></listitem>
74 </varlistentry>
75
76 <varlistentry>
77         <term>
78                 <command><option>alignc</option></command>
79         <option>(num)</option>
80         </term>
81         <listitem>
82                 Align text to centre
83         <para></para></listitem>
84 </varlistentry>
85
86 <varlistentry>
87         <term>
88                 <command><option>battery</option></command>
89         <option>(num)</option>
90         </term>
91         <listitem>
92                 Remaining capacity in ACPI or APM battery. ACPI battery number can be given as argument (default is BAT0).
93         <para></para></listitem>
94 </varlistentry>
95
96 <varlistentry>
97         <term>
98                 <command><option>buffers</option></command>
99         </term>
100         <listitem>
101                 Amount of memory buffered
102         <para></para></listitem>
103 </varlistentry>
104
105 <varlistentry>
106         <term>
107                 <command><option>cached</option></command>
108         </term>
109         <listitem>
110                 Amount of memory cached
111         <para></para></listitem>
112 </varlistentry>
113
114 <varlistentry>
115         <term>
116                 <command><option>color</option></command>
117         <option>(color)</option>
118         </term>
119         <listitem>
120                 Change drawing color to color
121         <para></para></listitem>
122 </varlistentry>
123
124 <varlistentry>
125         <term>
126                 <command><option>cpu</option></command>
127         </term>
128         <listitem>
129                 CPU usage in percents
130         <para></para></listitem>
131 </varlistentry>
132
133 <varlistentry>
134         <term>
135                 <command><option>cpubar</option></command>
136         <option>(height),(width)</option>
137         </term>
138         <listitem>
139                 Bar that shows CPU usage, height is bar's height in pixels
140         <para></para></listitem>
141 </varlistentry>
142
143 <varlistentry>
144         <term>
145                 <command><option>cpugraph</option></command>
146         <option>(height),(width) (gradient colour 1) (gradient colour 2)</option>
147         </term>
148         <listitem>
149                 CPU usage graph, with optional colours in hex, minus the #.
150         <para></para></listitem>
151 </varlistentry>
152
153 <varlistentry>
154         <term>
155                 <command><option>downspeed</option></command>
156         <option>net</option>
157         </term>
158         <listitem>
159                 Download speed in kilobytes
160         <para></para></listitem>
161 </varlistentry>
162
163 <varlistentry>
164         <term>
165                 <command><option>downspeedf</option></command>
166         <option>net</option>
167         </term>
168         <listitem>
169                 Download speed in kilobytes with one decimal
170         <para></para></listitem>
171 </varlistentry>
172
173 <varlistentry>
174         <term>
175                 <command><option>downspeedgraph</option></command>
176                 <option>net, (height),(width) (gradient colour 1) (gradient colour 2)</option>
177         </term>
178         <listitem>
179                 Download speed graph, colours defined in hex, minus the #.
180         <para></para></listitem>
181 </varlistentry>
182
183 <varlistentry>
184         <term>
185                 <command><option>else</option></command>
186         </term>
187         <listitem>
188                 Text to show if any of the above are not true
189         <para></para></listitem>
190 </varlistentry>
191
192 <varlistentry>
193         <term>
194                 <command><option>exec</option></command>
195         <option>shell command</option>
196         </term>
197         <listitem>
198                 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.
199         <para></para></listitem>
200 </varlistentry>
201
202 <varlistentry>
203         <term>
204                 <command><option>execbar</option></command>
205         <option>shell command</option>
206         </term>
207         <listitem>
208                 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.
209         <para></para></listitem>
210 </varlistentry>
211
212 <varlistentry>
213         <term>
214                 <command><option>execgraph</option></command>
215         <option>shell command</option>
216         </term>
217         <listitem>
218                 Same as execbar, but graphs values
219         <para></para></listitem>
220 </varlistentry>
221
222 <varlistentry>
223         <term>
224                 <command><option>execi</option></command>
225         <option>interval, shell command</option>
226         </term>
227         <listitem>
228                 Same as exec but with specific interval. Interval can't be less than update_interval in configuration.
229         <para></para></listitem>
230 </varlistentry>
231
232 <varlistentry>
233         <term>
234                 <command><option>font</option></command>
235         <option>font</option>
236         </term>
237         <listitem>
238                 Specify a different font. Only applies to one line.
239         <para></para></listitem>
240 </varlistentry>
241
242         
243         <varlistentry>
244                 <term>
245                         <command><option>freq</option></command>
246                 </term>
247                 <listitem>
248                         Returns CPU frequency in MHz
249                         <para></para></listitem>
250         </varlistentry>
251         <varlistentry>
252                 <term>
253                         <command><option>freq_g</option></command>
254                 </term>
255                 <listitem>
256                         Returns CPU frequency in GHz
257                         <para></para></listitem>
258         </varlistentry>
259         
260         <varlistentry>
261         <term>
262                 <command><option>fs_bar</option></command>
263         <option>(height),(width) fs</option>
264         </term>
265         <listitem>
266                 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.
267         <para></para></listitem>
268 </varlistentry>
269
270 <varlistentry>
271         <term>
272                 <command><option>fs_free</option></command>
273         <option>(fs)</option>
274         </term>
275         <listitem>
276                 Free space on a file system available for users.
277         <para></para></listitem>
278 </varlistentry>
279
280 <varlistentry>
281         <term>
282                 <command><option>fs_free_perc</option></command>
283         <option>(fs)</option>
284         </term>
285         <listitem>
286                 Free percentage of space on a file system available for users.
287         <para></para></listitem>
288 </varlistentry>
289
290 <varlistentry>
291         <term>
292                 <command><option>fs_size</option></command>
293         <option>(fs)</option>
294         </term>
295         <listitem>
296                 File system size
297         <para></para></listitem>
298 </varlistentry>
299
300 <varlistentry>
301         <term>
302                 <command><option>fs_used</option></command>
303         <option>(fs)</option>
304         </term>
305         <listitem>
306                 File system used space
307         <para></para></listitem>
308 </varlistentry>
309
310 <varlistentry>
311         <term>
312                 <command><option>hr</option></command>
313         <option>(height)</option>
314         </term>
315         <listitem>
316                 Horizontal line, height is the height in pixels
317         <para></para></listitem>
318 </varlistentry>
319
320 <varlistentry>
321         <term>
322                 <command><option>i2c</option></command>
323         <option>(dev), type, n</option>
324         </term>
325         <listitem>
326                 I2C sensor from sysfs (Linux 2.6). dev may be omitted if you have only one I2C device. type is either in (or vol) meaning voltage, fan meaning fan or temp/tempf (first in C, second in F) meaning temperature. n is number of the sensor. See /sys/bus/i2c/devices/ on your local computer.
327         <para></para></listitem>
328 </varlistentry>
329
330 <varlistentry>
331         <term>
332                 <command><option>if_running</option></command>
333         <option>(process)</option>
334         </term>
335         <listitem>
336                 if PROCESS is running, display everything if_running and the matching $endif
337         <para></para></listitem>
338 </varlistentry>
339
340 <varlistentry>
341         <term>
342                 <command><option>if_existing</option></command>
343         <option>(file)</option>
344         </term>
345         <listitem>
346                 if FILE exists, display everything between if_existing and the matching $endif
347         <para></para></listitem>
348 </varlistentry>
349
350 <varlistentry>
351         <term>
352                 <command><option>if_mounted</option></command>
353         <option>(mountpoint)</option>
354         </term>
355         <listitem>
356                 if MOUNTPOINT is mounted, display everything between if_mounted and the matching $endif
357         <para></para></listitem>
358 </varlistentry>
359
360 <varlistentry>
361         <term>
362                 <command><option>kernel</option></command>
363         </term>
364         <listitem>
365                 Kernel version
366         <para></para></listitem>
367 </varlistentry>
368
369 <varlistentry>
370         <term>
371                 <command><option>linkstatus</option></command>
372         <option>(interface)</option>
373         </term>
374         <listitem>
375                 Get the link status for wireless connections
376         <para></para></listitem>
377 </varlistentry>
378
379 <varlistentry>
380         <term>
381                 <command><option>loadavg</option></command>
382         </term>
383         <listitem>
384                 (1,2,3)> System load average, 1 is for past 1 minute, 2 for past 5 minutes and 3 for past 15 minutes.
385         <para></para></listitem>
386 </varlistentry>
387
388 <varlistentry>
389         <term>
390                 <command><option>machine</option></command>
391         </term>
392         <listitem>
393                 Machine, i686 for example
394         <para></para></listitem>
395 </varlistentry>
396
397 <varlistentry>
398         <term>
399                 <command><option>mails</option></command>
400         </term>
401         <listitem>
402                 Mail count in mail spool. You can use program like fetchmail to get mails from some server using your favourite protocol. See also new_mails.
403         <para></para></listitem>
404 </varlistentry>
405
406 <varlistentry>
407         <term>
408                 <command><option>mem</option></command>
409         </term>
410         <listitem>
411                 Amount of memory in use
412         <para></para></listitem>
413 </varlistentry>
414
415 <varlistentry>
416         <term>
417                 <command><option>membar</option></command>
418         <option>(height),(width)</option>
419         </term>
420         <listitem>
421                 Bar that shows amount of memory in use
422         <para></para></listitem>
423 </varlistentry>
424
425 <varlistentry>
426         <term>
427                 <command><option>memmax</option></command>
428         </term>
429         <listitem>
430                 Total amount of memory
431         <para></para></listitem>
432 </varlistentry>
433
434 <varlistentry>
435         <term>
436                 <command><option>memperc</option></command>
437         </term>
438         <listitem>
439                 Percentage of memory in use
440         <para></para></listitem>
441 </varlistentry>
442
443 <varlistentry>
444         <term>
445                 <command><option>ml_upload_counter</option></command>
446         </term>
447         <listitem>
448                 total session upload in mb
449         <para></para></listitem>
450 </varlistentry>
451
452 <varlistentry>
453         <term>
454                 <command><option>ml_download_counter</option></command>
455         </term>
456         <listitem>
457                 total session download in mb
458         <para></para></listitem>
459 </varlistentry>
460
461 <varlistentry>
462         <term>
463                 <command><option>ml_nshared_files</option></command>
464         </term>
465         <listitem>
466                 number of shared files
467         <para></para></listitem>
468 </varlistentry>
469
470 <varlistentry>
471         <term>
472                 <command><option>ml_shared_counter</option></command>
473         </term>
474         <listitem>
475                 total session shared in mb, buggy in some mldonkey versions
476         <para></para></listitem>
477 </varlistentry>
478
479 <varlistentry>
480         <term>
481                 <command><option>ml_tcp_upload_rate</option></command>
482         </term>
483         <listitem>
484                 tcp upload rate in kb/s
485         <para></para></listitem>
486 </varlistentry>
487
488 <varlistentry>
489         <term>
490                 <command><option>ml_tcp_download_rate</option></command>
491         </term>
492         <listitem>
493                 tcp download rate in kb/s
494         <para></para></listitem>
495 </varlistentry>
496
497 <varlistentry>
498         <term>
499                 <command><option>ml_udp_upload_rate</option></command>
500         </term>
501         <listitem>
502                 udp upload rate in kb/s
503         <para></para></listitem>
504 </varlistentry>
505
506 <varlistentry>
507         <term>
508                 <command><option>ml_udp_download_rate</option></command>
509         </term>
510         <listitem>
511                 udp download rate in kb/s
512         <para></para></listitem>
513 </varlistentry>
514
515 <varlistentry>
516         <term>
517                 <command><option>ml_ndownloaded_files</option></command>
518         </term>
519         <listitem>
520                 number of completed files
521         <para></para></listitem>
522 </varlistentry>
523
524 <varlistentry>
525         <term>
526                 <command><option>ml_ndownloading_files</option></command>
527         </term>
528         <listitem>
529                 number of downloading files
530         <para></para></listitem>
531 </varlistentry>
532
533 <varlistentry>
534         <term>
535                 <command><option>mpd_artist</option></command>
536         </term>
537         <listitem>
538                 Artist in current MPD song must be enabled at compile
539         <para></para></listitem>
540 </varlistentry>
541
542 <varlistentry>
543         <term>
544                 <command><option>mpd_album</option></command>
545         </term>
546         <listitem>
547                 Album in current MPD song
548         <para></para></listitem>
549 </varlistentry>
550
551 <varlistentry>
552         <term>
553                 <command><option>mpd_bar</option></command>
554         <option>(height),(width)</option>
555         </term>
556         <listitem>
557                 Bar of mpd's progress
558         <para></para></listitem>
559 </varlistentry>
560
561 <varlistentry>
562         <term>
563                 <command><option>mpd_bitrate</option></command>
564         </term>
565         <listitem>
566                 Bitrate of current song
567         <para></para></listitem>
568 </varlistentry>
569
570 <varlistentry>
571         <term>
572                 <command><option>mpd_status</option></command>
573         </term>
574         <listitem>
575                 Playing, stopped, et cetera.
576         <para></para></listitem>
577 </varlistentry>
578
579 <varlistentry>
580         <term>
581                 <command><option>mpd_title</option></command>
582         </term>
583         <listitem>
584                 Title of current MPD song
585         <para></para></listitem>
586 </varlistentry>
587
588 <varlistentry>
589         <term>
590                 <command><option>mpd_vol</option></command>
591         </term>
592         <listitem>
593                 MPD's volume
594         <para></para></listitem>
595 </varlistentry>
596
597 <varlistentry>
598         <term>
599                 <command><option>mpd_elapsed</option></command>
600         </term>
601         <listitem>
602                 Song's elapsed time
603         <para></para></listitem>
604 </varlistentry>
605
606 <varlistentry>
607         <term>
608                 <command><option>mpd_length</option></command>
609         </term>
610         <listitem>
611                 Song's length
612         <para></para></listitem>
613 </varlistentry>
614
615 <varlistentry>
616         <term>
617                 <command><option>mpd_percent</option></command>
618         </term>
619         <listitem>
620                 Percent of song's progress
621         <para></para></listitem>
622 </varlistentry>
623
624 <varlistentry>
625         <term>
626                 <command><option>new_mails</option></command>
627         </term>
628         <listitem>
629                 Unread mail count in mail spool.
630         <para></para></listitem>
631 </varlistentry>
632
633 <varlistentry>
634         <term>
635                 <command><option>nodename</option></command>
636         </term>
637         <listitem>
638                 Hostname
639         <para></para></listitem>
640 </varlistentry>
641
642 <varlistentry>
643         <term>
644                 <command><option>outlinecolor</option></command>
645         <option>(color)</option>
646         </term>
647         <listitem>
648                 Change outline color
649         <para></para></listitem>
650 </varlistentry>
651
652 <varlistentry>
653         <term>
654                 <command><option>pre_exec</option></command>
655         <option>shell command</option>
656         </term>
657         <listitem>
658                 Executes a shell command one time before conky displays anything and puts output as text.
659         <para></para></listitem>
660 </varlistentry>
661
662 <varlistentry>
663         <term>
664                 <command><option>processes</option></command>
665         </term>
666         <listitem>
667                 Total processes (sleeping and running)
668         <para></para></listitem>
669 </varlistentry>
670
671 <varlistentry>
672         <term>
673                 <command><option>running_processes</option></command>
674         </term>
675         <listitem>
676                 Running processes (not sleeping), requires Linux 2.6
677         <para></para></listitem>
678 </varlistentry>
679
680 <varlistentry>
681         <term>
682                 <command><option>shadecolor</option></command>
683         <option>(color)</option>
684         </term>
685         <listitem>
686                 Change shading color
687         <para></para></listitem>
688 </varlistentry>
689
690 <varlistentry>
691         <term>
692                 <command><option>stippled_hr</option></command>
693         <option>(space)</option>
694         </term>
695         <listitem>
696                 Stippled (dashed) horizontal line
697         <para></para></listitem>
698 </varlistentry>
699
700 <varlistentry>
701         <term>
702                 <command><option>swapbar</option></command>
703         <option>(height),(width)</option>
704         </term>
705         <listitem>
706                 Bar that shows amount of swap in use
707         <para></para></listitem>
708 </varlistentry>
709
710 <varlistentry>
711         <term>
712                 <command><option>swap</option></command>
713         </term>
714         <listitem>
715                 Amount of swap in use
716         <para></para></listitem>
717 </varlistentry>
718
719 <varlistentry>
720         <term>
721                 <command><option>swapmax</option></command>
722         </term>
723         <listitem>
724                 Total amount of swap
725         <para></para></listitem>
726 </varlistentry>
727
728 <varlistentry>
729         <term>
730                 <command><option>swapperc</option></command>
731         </term>
732         <listitem>
733                 Percentage of swap in use
734         <para></para></listitem>
735 </varlistentry>
736
737 <varlistentry>
738         <term>
739                 <command><option>sysname</option></command>
740         </term>
741         <listitem>
742                 System name, Linux for example
743         <para></para></listitem>
744 </varlistentry>
745
746 <varlistentry>
747         <term>
748                 <command><option>offset</option></command>
749                 <option>(pixels)</option>
750         </term>
751         <listitem>
752                 Move text over by N pixels.  See also $voffset.
753                 <para></para></listitem>
754 </varlistentry>
755
756 <varlistentry>
757         <term>
758                 <command><option>tail</option></command>
759         </term>
760         <listitem>
761                 logfile, lines interval> Displays last N lines of supplied text text file. If interval is not supplied, Conky assumes 2x Conky's interval. Max of 30 lines. Max of 30 lines can be displayed.
762         <para></para></listitem>
763 </varlistentry>
764
765 <varlistentry>
766         <term>
767                 <command><option>time</option></command>
768         <option>(format)</option>
769         </term>
770         <listitem>
771                 Local time, see man strftime to get more information about format
772         <para></para></listitem>
773 </varlistentry>
774
775 <varlistentry>
776         <term>
777                 <command><option>totaldown</option></command>
778         <option>net</option>
779         </term>
780         <listitem>
781                 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.
782         <para></para></listitem>
783 </varlistentry>
784
785 <varlistentry>
786         <term>
787                 <command><option>top</option></command>
788         <option>type, num</option>
789         </term>
790         <listitem>
791                 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", and mem". There can be a max of 10 processes listed.
792         <para></para></listitem>
793 </varlistentry>
794
795 <varlistentry>
796         <term>
797                 <command><option>top_mem</option></command>
798         <option>type, num</option>
799         </term>
800         <listitem>
801                 Same as top, except sorted by mem usage instead of cpu
802         <para></para></listitem>
803 </varlistentry>
804
805 <varlistentry>
806         <term>
807                 <command><option>totalup</option></command>
808         <option>net</option>
809         </term>
810         <listitem>
811                 Total upload, this one too, may overflow
812         <para></para></listitem>
813 </varlistentry>
814
815 <varlistentry>
816         <term>
817                 <command><option>updates</option></command>
818         <option>Number of updates</option>
819         </term>
820         <listitem>
821                 for debugging
822         <para></para></listitem>
823 </varlistentry>
824
825 <varlistentry>
826         <term>
827                 <command><option>upspeed</option></command>
828         <option>net</option>
829         </term>
830         <listitem>
831                 Upload speed in kilobytes
832         <para></para></listitem>
833 </varlistentry>
834
835 <varlistentry>
836         <term>
837                 <command><option>upspeedf</option></command>
838         <option>net</option>
839         </term>
840         <listitem>
841                 Upload speed in kilobytes with one decimal
842         <para></para></listitem>
843 </varlistentry>
844
845 <varlistentry>
846         <term>
847                 <command><option>upspeedgraph</option></command>
848                 <option>net, (height),(width) (gradient colour 1) (gradient colour 2)</option>
849         </term>
850         <listitem>
851                 Upload speed graph, colours defined in hex, minus the #.
852         <para></para></listitem>
853 </varlistentry>
854
855 <varlistentry>
856         <term>
857                 <command><option>uptime</option></command>
858         </term>
859         <listitem>
860                 Uptime
861         <para></para></listitem>
862 </varlistentry>
863
864 <varlistentry>
865         <term>
866                 <command><option>uptime_short</option></command>
867         </term>
868         <listitem>
869                 Uptime in a shorter format
870         <para></para></listitem>
871 </varlistentry>
872
873 <varlistentry>
874         <term>
875                 <command><option>seti_prog</option></command>
876         </term>
877         <listitem>
878                 Seti@home current progress
879         <para></para></listitem>
880 </varlistentry>
881
882 <varlistentry>
883         <term>
884                 <command><option>seti_progbar</option></command>
885         <option>(height),(width)</option>
886         </term>
887         <listitem>
888                 Seti@home current progress bar
889         <para></para></listitem>
890 </varlistentry>
891
892 <varlistentry>
893         <term>
894                 <command><option>seti_credit</option></command>
895         </term>
896         <listitem>
897                 Seti@home total user credit
898         <para></para></listitem>
899 </varlistentry>
900 <varlistentry>
901         <term>
902                 <command><option>voffset</option></command>
903                 <option>(pixels)</option>
904         </term>
905         <listitem>
906                 Change verticle offset by N pixels.  Negative values will cause text to overlap.  See also $offset.
907                 <para></para></listitem>
908 </varlistentry>
909
910
911 </variablelist>