Merge branch 'master' of git.omp.am:/home/omp/git/conky
[monky] / doc / config_settings.xml
1 <variablelist>
2     <varlistentry>
3         <term>
4             <command>
5                 <option>TEXT</option>
6             </command>
7         </term>
8         <listitem>After this begins text to be formatted on screen.
9         Backslash (\) escapes newlines in the text section. This
10         can be useful for cleaning up config files where conky is
11         used to pipe input to dzen2. 
12         <para /></listitem>
13     </varlistentry>
14     <varlistentry>
15         <term>
16             <command>
17                 <option>alignment</option>
18             </command>
19         </term>
20         <listitem>Aligned position on screen, may be top_left,
21         top_right, top_middle, bottom_left, bottom_right,
22         bottom_middle, middle_left, middle_right, or none (also can
23         be abreviated as tl, tr, tm, bl, br, bm, ml, mr). See also
24         gap_x and gap_y. 
25         <para /></listitem>
26     </varlistentry>
27     <varlistentry>
28         <term>
29             <command>
30                 <option>append_file</option>
31             </command>
32         </term>
33         <listitem>Append the file given as argument. 
34         <para /></listitem>
35     </varlistentry>
36     <varlistentry>
37         <term>
38             <command>
39                 <option>background</option>
40             </command>
41         </term>
42         <listitem>Boolean value, if true, Conky will be forked to
43         background when started. 
44         <para /></listitem>
45     </varlistentry>
46     <varlistentry>
47         <term>
48             <command>
49                 <option>border_inner_margin</option>
50             </command>
51         </term>
52         <listitem>Inner border margin in pixels (the margin between
53         the border and text). 
54         <para /></listitem>
55     </varlistentry>
56     <varlistentry>
57         <term>
58             <command>
59                 <option>border_outer_margin</option>
60             </command>
61         </term>
62         <listitem>Outer border margin in pixels (the margin between
63         the border and the edge of the window). 
64         <para /></listitem>
65     </varlistentry>
66     <varlistentry>
67         <term>
68             <command>
69                 <option>border_width</option>
70             </command>
71         </term>
72         <listitem>Border width in pixels. 
73         <para /></listitem>
74     </varlistentry>
75     <varlistentry>
76         <term>
77             <command>
78                 <option>colorN</option>
79             </command>
80         </term>
81         <listitem>Predefine a color for use inside TEXT segments.
82         Substitute N by a digit between 0 and 9, inclusively. When
83         specifying the color value in hex, omit the leading hash
84         (#). 
85         <para /></listitem>
86     </varlistentry>
87     <varlistentry>
88         <term>
89             <command>
90                 <option>cpu_avg_samples</option>
91             </command>
92         </term>
93         <listitem>The number of samples to average for CPU
94         monitoring. 
95         <para /></listitem>
96     </varlistentry>
97     <varlistentry>
98         <term>
99             <command>
100                 <option>default_bar_size</option>
101             </command>
102         </term>
103         <listitem>Specify a default width and height for bars.
104         Example: 'default_bar_size 0 6'. This is particularly
105         useful for execbar and execibar as they do not take size
106         arguments. 
107         <para /></listitem>
108     </varlistentry>
109     <varlistentry>
110         <term>
111             <command>
112                 <option>default_color</option>
113             </command>
114         </term>
115         <listitem>Default color and border color 
116         <para /></listitem>
117     </varlistentry>
118     <varlistentry>
119         <term>
120             <command>
121                 <option>default_gauge_size</option>
122             </command>
123         </term>
124         <listitem>Specify a default width and height for gauges.
125         Example: 'default_gauge_size 25 25'. This is particularly
126         useful for execgauge and execigauge as they do not take
127         size arguments 
128         <para /></listitem>
129     </varlistentry>
130     <varlistentry>
131         <term>
132             <command>
133                 <option>default_graph_size</option>
134             </command>
135         </term>
136         <listitem>Specify a default width and height for graphs.
137         Example: 'default_graph_size 0 25'. This is particularly
138         useful for execgraph and execigraph as they do not take
139         size arguments 
140         <para /></listitem>
141     </varlistentry>
142     <varlistentry>
143         <term>
144             <command>
145                 <option>default_outline_color</option>
146             </command>
147         </term>
148         <listitem>Default outline color 
149         <para /></listitem>
150     </varlistentry>
151     <varlistentry>
152         <term>
153             <command>
154                 <option>default_shade_color</option>
155             </command>
156         </term>
157         <listitem>Default shading color and border's shading color 
158         <para /></listitem>
159     </varlistentry>
160     <varlistentry>
161         <term>
162             <command>
163                 <option>diskio_avg_samples</option>
164             </command>
165         </term>
166         <listitem>The number of samples to average for disk I/O
167         monitoring. 
168         <para /></listitem>
169     </varlistentry>
170     <varlistentry>
171         <term>
172             <command>
173                 <option>display</option>
174             </command>
175         </term>
176         <listitem>Specify an X display to connect to. 
177         <para /></listitem>
178     </varlistentry>
179     <varlistentry>
180         <term>
181             <command>
182                 <option>double_buffer</option>
183             </command>
184         </term>
185         <listitem>Use the Xdbe extension? (eliminates flicker) It
186         is highly recommended to use own window with this one so
187         double buffer won't be so big. 
188         <para /></listitem>
189     </varlistentry>
190     <varlistentry>
191         <term>
192             <command>
193                 <option>draw_borders</option>
194             </command>
195         </term>
196         <listitem>Draw borders around text? 
197         <para /></listitem>
198     </varlistentry>
199     <varlistentry>
200         <term>
201             <command>
202                 <option>draw_graph_borders</option>
203             </command>
204         </term>
205         <listitem>Draw borders around graphs? 
206         <para /></listitem>
207     </varlistentry>
208     <varlistentry>
209         <term>
210             <command>
211                 <option>draw_outline</option>
212             </command>
213         </term>
214         <listitem>Draw outlines? 
215         <para /></listitem>
216     </varlistentry>
217     <varlistentry>
218         <term>
219             <command>
220                 <option>draw_shades</option>
221             </command>
222         </term>
223         <listitem>Draw shades? 
224         <para /></listitem>
225     </varlistentry>
226     <varlistentry>
227         <term>
228             <command>
229                 <option>extra_newline</option>
230             </command>
231         </term>
232         <listitem>Put an extra newline at the end when writing to
233         stdout, useful for writing to awesome's wiboxes. 
234         <para /></listitem>
235     </varlistentry>
236     <varlistentry>
237         <term>
238             <command>
239                 <option>font</option>
240             </command>
241         </term>
242         <listitem>Font name in X, xfontsel can be used to get a
243         nice font 
244         <para /></listitem>
245     </varlistentry>
246     <varlistentry>
247         <term>
248             <command>
249                 <option>format_human_readable</option>
250             </command>
251         </term>
252         <listitem>If enabled, values which are in bytes will be
253         printed in human readable format (i.e., KiB, MiB, etc). If
254         disabled, the number of bytes is printed instead. 
255         <para /></listitem>
256     </varlistentry>
257     <varlistentry>
258         <term>
259             <command>
260                 <option>gap_x</option>
261             </command>
262         </term>
263         <listitem>Gap, in pixels, between right or left border of
264         screen, same as passing -x at command line, e.g. gap_x 10.
265         For other position related stuff, see 'alignment'. 
266         <para /></listitem>
267     </varlistentry>
268     <varlistentry>
269         <term>
270             <command>
271                 <option>gap_y</option>
272             </command>
273         </term>
274         <listitem>Gap, in pixels, between top or bottom border of
275         screen, same as passing -y at command line, e.g. gap_y 10.
276         For other position related stuff, see 'alignment'. 
277         <para /></listitem>
278     </varlistentry>
279     <varlistentry>
280         <term>
281             <command>
282                 <option>if_up_strictness</option>
283             </command>
284         </term>
285         <listitem>How strict should if_up be when testing an
286         interface for being up? The value is one of up, link or
287         address, to check for the interface being solely up, being
288         up and having link or being up, having link and an assigned
289         IP address. 
290         <para /></listitem>
291     </varlistentry>
292     <varlistentry>
293         <term>
294             <command>
295                 <option>imap</option>
296             </command>
297         </term>
298         <listitem>Default global IMAP server. Arguments are: "host
299         user pass [-i interval (in seconds)] [-f folder] [-p port]
300         [-e command] [-r retries]". Default port is 143, default
301         folder is 'INBOX', default interval is 5 minutes, and
302         default number of retries before giving up is 5. If the
303         password is supplied as '*', you will be prompted to enter
304         the password when Conky starts. 
305         <para /></listitem>
306     </varlistentry>
307     <varlistentry>
308         <term>
309             <command>
310                 <option>imlib_cache_flush_interval</option>
311             </command>
312         </term>
313         <listitem>Interval (in seconds) to flush Imlib2 cache. 
314         <para /></listitem>
315     </varlistentry>
316     <varlistentry>
317         <term>
318             <command>
319                 <option>imlib_cache_size</option>
320             </command>
321         </term>
322         <listitem>
323             <para>Imlib2 image cache size, in bytes. Defaults to
324             4MiB. Increase this value if you use $image lots. Set
325             to 0 to disable the image cache.</para>
326         </listitem>
327     </varlistentry>
328     <varlistentry>
329         <term>
330             <command>
331                 <option>lua_draw_hook_post</option>
332             </command>
333             <option>function_name [function arguments]</option>
334         </term>
335         <listitem>
336             <para>This function, if defined, will be called by
337             Conky through each iteration after drawing to the
338             window. Requires X support. Takes any number of
339             optional arguments. Use this hook for drawing things on
340             top of what Conky draws. Conky puts 'conky_' in front
341             of function_name to prevent accidental calls to the
342             wrong function unless you place 'conky_' in front of
343             it yourself.</para>
344         </listitem>
345     </varlistentry>
346     <varlistentry>
347         <term>
348             <command>
349                 <option>lua_draw_hook_pre</option>
350             </command>
351             <option>function_name [function arguments]</option>
352         </term>
353         <listitem>
354             <para>This function, if defined, will be called by
355             Conky through each iteration before drawing to the
356             window. Requires X support. Takes any number of
357             optional arguments. Use this hook for drawing things on
358             top of what Conky draws. Conky puts 'conky_' in front
359             of function_name to prevent accidental calls to the
360             wrong function unless you place 'conky_' in front of
361             it yourself.</para>
362         </listitem>
363     </varlistentry>
364     <varlistentry>
365         <term>
366             <command>
367                 <option>lua_load</option>
368             </command>
369         </term>
370         <listitem>Loads the Lua scripts separated by spaces. 
371         <para /></listitem>
372     </varlistentry>
373     <varlistentry>
374         <term>
375             <command>
376                 <option>lua_shutdown_hook</option>
377             </command>
378             <option>function_name [function arguments]</option>
379         </term>
380         <listitem>
381             <para>This function, if defined, will be called by
382             Conky at shutdown or when the configuration is
383             reloaded. Use this hook to clean up after yourself,
384             such as freeing memory which has been allocated by
385             external libraries via Lua. Conky puts 'conky_' in
386             front of function_name to prevent accidental calls to
387             the wrong function unless you put you place 'conky_' in
388             front of it yourself.</para>
389         </listitem>
390     </varlistentry>
391     <varlistentry>
392         <term>
393             <command>
394                 <option>mail_spool</option>
395             </command>
396         </term>
397         <listitem>Mail spool for mail checking 
398         <para /></listitem>
399     </varlistentry>
400     <varlistentry>
401         <term>
402             <command>
403                 <option>max_port_monitor_connections</option>
404             </command>
405         </term>
406         <listitem>Allow each port monitor to track at most this
407         many connections (if 0 or not set, default is 256) 
408         <para /></listitem>
409     </varlistentry>
410     <varlistentry>
411         <term>
412             <command>
413                 <option>max_specials</option>
414             </command>
415         </term>
416         <listitem>Maximum number of special things, e.g. fonts,
417         offsets, aligns, etc. (default is 512) 
418         <para /></listitem>
419     </varlistentry>
420     <varlistentry>
421         <term>
422             <command>
423                 <option>max_user_text</option>
424             </command>
425             <option>bytes</option>
426         </term>
427         <listitem>Maximum size of user text buffer, i.e. layout
428         below TEXT line in config file (default is 16384 bytes) 
429         <para /></listitem>
430     </varlistentry>
431     <varlistentry>
432         <term>
433             <command>
434                 <option>maximum_width</option>
435             </command>
436             <option>pixels</option>
437         </term>
438         <listitem>Maximum width of window 
439         <para /></listitem>
440     </varlistentry>
441     <varlistentry>
442         <term>
443             <command>
444                 <option>minimum_size</option>
445             </command>
446             <option>width (height)</option>
447         </term>
448         <listitem>Minimum size of window 
449         <para /></listitem>
450     </varlistentry>
451     <varlistentry>
452         <term>
453             <command>
454                 <option>mpd_host</option>
455             </command>
456         </term>
457         <listitem>Host of MPD server 
458         <para /></listitem>
459     </varlistentry>
460     <varlistentry>
461         <term>
462             <command>
463                 <option>mpd_password</option>
464             </command>
465         </term>
466         <listitem>MPD server password 
467         <para /></listitem>
468     </varlistentry>
469     <varlistentry>
470         <term>
471             <command>
472                 <option>mpd_port</option>
473             </command>
474         </term>
475         <listitem>Port of MPD server 
476         <para /></listitem>
477     </varlistentry>
478     <varlistentry>
479         <term>
480             <command>
481                 <option>music_player_interval</option>
482             </command>
483         </term>
484         <listitem>Music player thread update interval (defaults to
485         Conky's update interval) 
486         <para /></listitem>
487     </varlistentry>
488     <varlistentry>
489         <term>
490             <command>
491                 <option>net_avg_samples</option>
492             </command>
493         </term>
494         <listitem>The number of samples to average for net data 
495         <para /></listitem>
496     </varlistentry>
497     <varlistentry>
498         <term>
499             <command>
500                 <option>no_buffers</option>
501             </command>
502         </term>
503         <listitem>Substract (file system) buffers from used memory?
504         
505         <para /></listitem>
506     </varlistentry>
507     <varlistentry>
508         <term>
509             <command>
510                 <option>out_to_console</option>
511             </command>
512         </term>
513         <listitem>Print text to stdout. 
514         <para /></listitem>
515     </varlistentry>
516     <varlistentry>
517         <term>
518             <command>
519                 <option>out_to_ncurses</option>
520             </command>
521         </term>
522         <listitem>Print text in the console, but use ncurses so
523         that conky can print the text of a new update over the old
524         text. (In the future this will provide more useful things) 
525         <para /></listitem>
526     </varlistentry>
527     <varlistentry>
528         <term>
529             <command>
530                 <option>out_to_stderr</option>
531             </command>
532         </term>
533         <listitem>Print text to stderr. 
534         <para /></listitem>
535     </varlistentry>
536     <varlistentry>
537         <term>
538             <command>
539                 <option>out_to_x</option>
540             </command>
541         </term>
542         <listitem>When set to no, there will be no output in X
543         (useful when you also use things like out_to_console). If
544         you set it to no, make sure that it's placed before all
545         other X-related setting (take the first line of your
546         configfile to be sure). Default value is yes 
547         <para /></listitem>
548     </varlistentry>
549     <varlistentry>
550         <term>
551             <command>
552                 <option>override_utf8_locale</option>
553             </command>
554         </term>
555         <listitem>Force UTF8? requires XFT 
556         <para /></listitem>
557     </varlistentry>
558     <varlistentry>
559         <term>
560             <command>
561                 <option>overwrite_file</option>
562             </command>
563         </term>
564         <listitem>Overwrite the file given as argument. 
565         <para /></listitem>
566     </varlistentry>
567     <varlistentry>
568         <term>
569             <command>
570                 <option>own_window</option>
571             </command>
572         </term>
573         <listitem>Boolean, create own window to draw? 
574         <para /></listitem>
575     </varlistentry>
576     <varlistentry>
577         <term>
578             <command>
579                 <option>own_window_class</option>
580             </command>
581         </term>
582         <listitem>Manually set the WM_CLASS name. Defaults to
583         "Conky". 
584         <para /></listitem>
585     </varlistentry>
586     <varlistentry>
587         <term>
588             <command>
589                 <option>own_window_colour</option>
590             </command>
591             <option>colour</option>
592         </term>
593         <listitem>If own_window_transparent no, set a specified
594         background colour (defaults to black). Takes either a hex
595         value (#ffffff) or a valid RGB name (see
596         /usr/lib/X11/rgb.txt) 
597         <para /></listitem>
598     </varlistentry>
599     <varlistentry>
600         <term>
601             <command>
602                 <option>own_window_hints</option>
603             </command>
604             <option>
605             undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
606         </term>
607         <listitem>If own_window is yes, you may use these window
608         manager hints to affect the way Conky displays. Notes: Use
609         own_window_type desktop as another way to implement many of
610         these hints implicitly. If you use own_window_type
611         override, window manager hints have no meaning and are
612         ignored. 
613         <para /></listitem>
614     </varlistentry>
615     <varlistentry>
616         <term>
617             <command>
618                 <option>own_window_title</option>
619             </command>
620         </term>
621         <listitem>Manually set the window name. Defaults to
622         "&lt;hostname&gt; - conky". 
623         <para /></listitem>
624     </varlistentry>
625     <varlistentry>
626         <term>
627             <command>
628                 <option>own_window_transparent</option>
629             </command>
630         </term>
631         <listitem>Boolean, set pseudo-transparency? 
632         <para /></listitem>
633     </varlistentry>
634     <varlistentry>
635         <term>
636             <command>
637                 <option>own_window_type</option>
638             </command>
639         </term>
640         <listitem>if own_window is yes, you may specify type
641         normal, desktop, dock, panel or override (default: normal).
642         Desktop windows are special windows that have no window
643         decorations; are always visible on your desktop; do not
644         appear in your pager or taskbar; and are sticky across all
645         workspaces. Panel windows reserve space along a desktop
646         edge, just like panels and taskbars, preventing maximized
647         windows from overlapping them. The edge is chosen based on
648         the alignment option. Override windows are not under the
649         control of the window manager. Hints are ignored. This type
650         of window can be useful for certain situations. 
651         <para /></listitem>
652     </varlistentry>
653     <varlistentry>
654         <term>
655             <command>
656                 <option>pad_percents</option>
657             </command>
658         </term>
659         <listitem>Pad percentages to this many decimals (0 = no
660         padding) 
661         <para /></listitem>
662     </varlistentry>
663     <varlistentry>
664         <term>
665             <command>
666                 <option>pop3</option>
667             </command>
668         </term>
669         <listitem>Default global POP3 server. Arguments are: "host
670         user pass [-i interval (in seconds)] [-p port] [-e command]
671         [-r retries]". Default port is 110, default interval is 5
672         minutes, and default number of retries before giving up is
673         5. If the password is supplied as '*', you will be prompted
674         to enter the password when Conky starts. 
675         <para /></listitem>
676     </varlistentry>
677     <varlistentry>
678         <term>
679             <command>
680                 <option>short_units</option>
681             </command>
682         </term>
683         <listitem>Shortens units to a single character (kiB-&gt;k,
684         GiB-&gt;G, etc.). Default is off. 
685         <para /></listitem>
686     </varlistentry>
687     <varlistentry>
688         <term>
689             <command>
690                 <option>show_graph_range</option>
691             </command>
692         </term>
693         <listitem>Shows the time range covered by a graph. 
694         <para /></listitem>
695     </varlistentry>
696     <varlistentry>
697         <term>
698             <command>
699                 <option>show_graph_scale</option>
700             </command>
701         </term>
702         <listitem>Shows the maximum value in scaled graphs. 
703         <para /></listitem>
704     </varlistentry>
705     <varlistentry>
706         <term>
707             <command>
708                 <option>stippled_borders</option>
709             </command>
710         </term>
711         <listitem>Border stippling (dashing) in pixels 
712         <para /></listitem>
713     </varlistentry>
714     <varlistentry>
715         <term>
716             <command>
717                 <option>temperature_unit</option>
718             </command>
719         </term>
720         <listitem>Desired output unit of all objects displaying a
721         temperature. Parameters are either "fahrenheit" or
722         "celsius". The default unit is degree Celsius. 
723         <para /></listitem>
724     </varlistentry>
725     <varlistentry>
726         <term>
727             <command>
728                 <option>templateN</option>
729             </command>
730         </term>
731         <listitem>Define a template for later use inside TEXT
732         segments. Substitute N by a digit between 0 and 9,
733         inclusively. The value of the variable is being inserted
734         into the stuff below TEXT at the corresponding position,
735         but before some substitutions are applied: 
736         <simplelist>
737             <member>'\n' -&gt; newline</member>
738             <member>'\\' -&gt; backslash</member>
739             <member>'\ ' -&gt; space</member>
740             <member>'\N' -&gt; template argument N</member>
741         </simplelist>
742         <para /></listitem>
743     </varlistentry>
744     <varlistentry>
745         <term>
746             <command>
747                 <option>text_buffer_size</option>
748             </command>
749             <option>bytes</option>
750         </term>
751         <listitem>Size of the standard text buffer (default is 256
752         bytes). This buffer is used for intermediary text, such as
753         individual lines, output from $exec vars, and various other
754         variables. Increasing the size of this buffer can
755         drastically reduce Conky's performance, but will allow for
756         more text display per variable. The size of this buffer
757         cannot be smaller than the default value of 256 bytes. 
758         <para /></listitem>
759     </varlistentry>
760     <varlistentry>
761         <term>
762             <command>
763                 <option>top_cpu_separate</option>
764             </command>
765         </term>
766         <listitem>If true, cpu in top will show usage of one
767         processor's power. If false, cpu in top will show the usage
768         of all processors' power combined. 
769         <para /></listitem>
770     </varlistentry>
771     <varlistentry>
772         <term>
773             <command>
774                 <option>top_name_width</option>
775             </command>
776         </term>
777         <listitem>Width for $top name value (defaults to 15
778         characters). 
779         <para /></listitem>
780     </varlistentry>
781     <varlistentry>
782         <term>
783             <command>
784                 <option>total_run_times</option>
785             </command>
786         </term>
787         <listitem>Total number of times for Conky to update before
788         quitting. Zero makes Conky run forever 
789         <para /></listitem>
790     </varlistentry>
791     <varlistentry>
792         <term>
793             <command>
794                 <option>update_interval</option>
795             </command>
796             <option>seconds</option>
797         </term>
798         <listitem>Update interval 
799         <para /></listitem>
800     </varlistentry>
801     <varlistentry>
802         <term>
803             <command>
804                 <option>update_interval_on_battery</option>
805             </command>
806             <option>seconds</option>
807         </term>
808         <listitem>Update interval when running on batterypower 
809         <para /></listitem>
810     </varlistentry>
811     <varlistentry>
812         <term>
813             <command>
814                 <option>uppercase</option>
815             </command>
816         </term>
817         <listitem>Boolean value, if true, text is rendered in upper
818         case 
819         <para /></listitem>
820     </varlistentry>
821     <varlistentry>
822         <term>
823             <command>
824                 <option>use_spacer</option>
825             </command>
826         </term>
827         <listitem>Adds spaces around certain objects to stop them
828         from moving other things around. Arguments are left, right,
829         and none (default). The old true/false values are
830         deprecated and default to right/none respectively. Note
831         that this only helps if you are using a mono font, such as
832         Bitstream Vera Sans Mono. 
833         <para /></listitem>
834     </varlistentry>
835     <varlistentry>
836         <term>
837             <command>
838                 <option>use_xft</option>
839             </command>
840         </term>
841         <listitem>Use Xft (anti-aliased font and stuff) 
842         <para /></listitem>
843     </varlistentry>
844     <varlistentry>
845         <term>
846             <command>
847                 <option>xftalpha</option>
848             </command>
849         </term>
850         <listitem>Alpha of Xft font. Must be a value at or between
851         1 and 0. 
852         <para /></listitem>
853     </varlistentry>
854     <varlistentry>
855         <term>
856             <command>
857                 <option>xftfont</option>
858             </command>
859         </term>
860         <listitem>Xft font to use. 
861         <para /></listitem>
862     </varlistentry>
863 </variablelist>