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