Improve handling of ARGB visuals a bit.
[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_middle, middle_right, or
23         none (also can be abreviated as tl, tr, tm, bl, br, bm, ml,
24         mm, mr). See also 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>hddtemp_host</option>
283             </command>
284         </term>
285         <listitem>Hostname to connect to for hddtemp objects. Defaults
286                 to "127.0.0.1".
287         <para /></listitem>
288     </varlistentry>
289     <varlistentry>
290         <term>
291             <command>
292                 <option>hddtemp_port</option>
293             </command>
294         </term>
295         <listitem>Port to use for hddtemp connections. Defaults to
296                 7634.
297         <para /></listitem>
298     </varlistentry>
299     <varlistentry>
300         <term>
301             <command>
302                 <option>if_up_strictness</option>
303             </command>
304         </term>
305         <listitem>How strict should if_up be when testing an
306         interface for being up? The value is one of up, link or
307         address, to check for the interface being solely up, being
308         up and having link or being up, having link and an assigned
309         IP address. 
310         <para /></listitem>
311     </varlistentry>
312     <varlistentry>
313         <term>
314             <command>
315                 <option>imap</option>
316             </command>
317         </term>
318         <listitem>Default global IMAP server. Arguments are: "host
319         user pass [-i interval (in seconds)] [-f 'folder'] [-p port]
320         [-e 'command'] [-r retries]". Default port is 143, default
321         folder is 'INBOX', default interval is 5 minutes, and
322         default number of retries before giving up is 5. If the
323         password is supplied as '*', you will be prompted to enter
324         the password when Conky starts. 
325         <para /></listitem>
326     </varlistentry>
327     <varlistentry>
328         <term>
329             <command>
330                 <option>imlib_cache_flush_interval</option>
331             </command>
332         </term>
333         <listitem>Interval (in seconds) to flush Imlib2 cache. 
334         <para /></listitem>
335     </varlistentry>
336     <varlistentry>
337         <term>
338             <command>
339                 <option>imlib_cache_size</option>
340             </command>
341         </term>
342         <listitem>
343             Imlib2 image cache size, in bytes. Defaults to
344             4MiB. Increase this value if you use $image lots. Set
345             to 0 to disable the image cache.<para/>
346         </listitem>
347     </varlistentry>
348     <varlistentry>
349         <term>
350             <command>
351                 <option>lua_draw_hook_post</option>
352             </command>
353             <option>function_name [function arguments]</option>
354         </term>
355         <listitem>
356             This function, if defined, will be called by
357             Conky through each iteration after drawing to the
358             window. Requires X support. Takes any number of
359             optional arguments. Use this hook for drawing things on
360             top of what Conky draws. Conky puts 'conky_' in front
361             of function_name to prevent accidental calls to the
362             wrong function unless you place 'conky_' in front of it
363             yourself.<para/>
364         </listitem>
365     </varlistentry>
366     <varlistentry>
367         <term>
368             <command>
369                 <option>lua_draw_hook_pre</option>
370             </command>
371             <option>function_name [function arguments]</option>
372         </term>
373         <listitem>
374             This function, if defined, will be called by
375             Conky through each iteration before drawing to the
376             window. Requires X support. Takes any number of
377             optional arguments. Use this hook for drawing things on
378             top of what Conky draws. Conky puts 'conky_' in front
379             of function_name to prevent accidental calls to the
380             wrong function unless you place 'conky_' in front of it
381             yourself.<para/>
382         </listitem>
383     </varlistentry>
384     <varlistentry>
385         <term>
386             <command>
387                 <option>lua_load</option>
388             </command>
389         </term>
390         <listitem>Loads the Lua scripts separated by spaces. 
391         <para /></listitem>
392     </varlistentry>
393     <varlistentry>
394         <term>
395             <command>
396                 <option>lua_shutdown_hook</option>
397             </command>
398             <option>function_name [function arguments]</option>
399         </term>
400         <listitem>
401             This function, if defined, will be called by
402             Conky at shutdown or when the configuration is
403             reloaded. Use this hook to clean up after yourself,
404             such as freeing memory which has been allocated by
405             external libraries via Lua. Conky puts 'conky_' in
406             front of function_name to prevent accidental calls to
407             the wrong function unless you place 'conky_' in
408             front of it yourself.<para/>
409         </listitem>
410     </varlistentry>
411     <varlistentry>
412         <term>
413             <command>
414                 <option>lua_startup_hook</option>
415             </command>
416             <option>function_name [function arguments]</option>
417         </term>
418         <listitem>
419             This function, if defined, will be called by
420             Conky at startup or when the configuration is reloaded.
421             Use this hook to initialize values, or for any run-once
422             applications. Conky puts 'conky_' in front of
423             function_name to prevent accidental calls to the wrong
424             function unless you place 'conky_' in front of
425             it yourself.<para/>
426         </listitem>
427     </varlistentry>
428     <varlistentry>
429         <term>
430             <command>
431                 <option>mail_spool</option>
432             </command>
433         </term>
434         <listitem>Mail spool for mail checking 
435         <para /></listitem>
436     </varlistentry>
437     <varlistentry>
438         <term>
439             <command>
440                 <option>max_port_monitor_connections</option>
441             </command>
442         </term>
443         <listitem>Allow each port monitor to track at most this
444         many connections (if 0 or not set, default is 256) 
445         <para /></listitem>
446     </varlistentry>
447     <varlistentry>
448         <term>
449             <command>
450                 <option>max_specials</option>
451             </command>
452         </term>
453         <listitem>Maximum number of special things, e.g. fonts,
454         offsets, aligns, etc. (default is 512) 
455         <para /></listitem>
456     </varlistentry>
457     <varlistentry>
458         <term>
459             <command>
460                 <option>max_text_width</option>
461             </command>
462             <option>width</option>
463         </term>
464         <listitem>When a line in the output contains 'width'
465         chars and the end isn't reached, the next char will start
466         on a new line. If you want to make sure that lines don't
467         get broken, set 'width' to 0
468         <para /></listitem>
469     </varlistentry>
470     <varlistentry>
471         <term>
472             <command>
473                 <option>max_user_text</option>
474             </command>
475             <option>bytes</option>
476         </term>
477         <listitem>Maximum size of user text buffer, i.e. layout
478         below TEXT line in config file (default is 16384 bytes) 
479         <para /></listitem>
480     </varlistentry>
481     <varlistentry>
482         <term>
483             <command>
484                 <option>maximum_width</option>
485             </command>
486             <option>pixels</option>
487         </term>
488         <listitem>Maximum width of window 
489         <para /></listitem>
490     </varlistentry>
491     <varlistentry>
492         <term>
493             <command>
494                 <option>minimum_size</option>
495             </command>
496             <option>width (height)</option>
497         </term>
498         <listitem>Minimum size of window 
499         <para /></listitem>
500     </varlistentry>
501     <varlistentry>
502         <term>
503             <command>
504                 <option>mpd_host</option>
505             </command>
506         </term>
507         <listitem>Host of MPD server 
508         <para /></listitem>
509     </varlistentry>
510     <varlistentry>
511         <term>
512             <command>
513                 <option>mpd_password</option>
514             </command>
515         </term>
516         <listitem>MPD server password 
517         <para /></listitem>
518     </varlistentry>
519     <varlistentry>
520         <term>
521             <command>
522                 <option>mpd_port</option>
523             </command>
524         </term>
525         <listitem>Port of MPD server 
526         <para /></listitem>
527     </varlistentry>
528     <varlistentry>
529         <term>
530             <command>
531                 <option>music_player_interval</option>
532             </command>
533         </term>
534         <listitem>Music player thread update interval (defaults to
535         Conky's update interval) 
536         <para /></listitem>
537     </varlistentry>
538     <varlistentry>
539         <term>
540             <command>
541                 <option>net_avg_samples</option>
542             </command>
543         </term>
544         <listitem>The number of samples to average for net data 
545         <para /></listitem>
546     </varlistentry>
547     <varlistentry>
548         <term>
549             <command>
550                 <option>no_buffers</option>
551             </command>
552         </term>
553         <listitem>Substract (file system) buffers from used memory?
554         
555         <para /></listitem>
556     </varlistentry>
557     <varlistentry>
558         <term>
559             <command>
560                 <option>out_to_console</option>
561             </command>
562         </term>
563         <listitem>Print text to stdout. 
564         <para /></listitem>
565     </varlistentry>
566     <varlistentry>
567         <term>
568             <command>
569                 <option>out_to_ncurses</option>
570             </command>
571         </term>
572         <listitem>Print text in the console, but use ncurses so
573         that conky can print the text of a new update over the old
574         text. (In the future this will provide more useful things) 
575         <para /></listitem>
576     </varlistentry>
577     <varlistentry>
578         <term>
579             <command>
580                 <option>out_to_stderr</option>
581             </command>
582         </term>
583         <listitem>Print text to stderr. 
584         <para /></listitem>
585     </varlistentry>
586     <varlistentry>
587         <term>
588             <command>
589                 <option>out_to_x</option>
590             </command>
591         </term>
592         <listitem>When set to no, there will be no output in X
593         (useful when you also use things like out_to_console). If
594         you set it to no, make sure that it's placed before all
595         other X-related setting (take the first line of your
596         configfile to be sure). Default value is yes 
597         <para /></listitem>
598     </varlistentry>
599     <varlistentry>
600         <term>
601             <command>
602                 <option>override_utf8_locale</option>
603             </command>
604         </term>
605         <listitem>Force UTF8? requires XFT 
606         <para /></listitem>
607     </varlistentry>
608     <varlistentry>
609         <term>
610             <command>
611                 <option>overwrite_file</option>
612             </command>
613         </term>
614         <listitem>Overwrite the file given as argument. 
615         <para /></listitem>
616     </varlistentry>
617     <varlistentry>
618         <term>
619             <command>
620                 <option>own_window</option>
621             </command>
622         </term>
623         <listitem>Boolean, create own window to draw? 
624         <para /></listitem>
625     </varlistentry>
626     <varlistentry>
627         <term>
628             <command>
629                 <option>own_window_class</option>
630             </command>
631         </term>
632         <listitem>Manually set the WM_CLASS name. Defaults to
633         "Conky". 
634         <para /></listitem>
635     </varlistentry>
636     <varlistentry>
637         <term>
638             <command>
639                 <option>own_window_colour</option>
640             </command>
641             <option>colour</option>
642         </term>
643         <listitem>If own_window_transparent no, set a specified
644         background colour (defaults to black). Takes either a hex
645         value (e.g. ffffff, note the lack of '#') or a valid RGB
646         name (see /usr/lib/X11/rgb.txt)
647         <para /></listitem>
648     </varlistentry>
649     <varlistentry>
650         <term>
651             <command>
652                 <option>own_window_hints</option>
653             </command>
654             <option>
655             undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
656         </term>
657         <listitem>If own_window is yes, you may use these window
658         manager hints to affect the way Conky displays. Notes: Use
659         own_window_type desktop as another way to implement many of
660         these hints implicitly. If you use own_window_type
661         override, window manager hints have no meaning and are
662         ignored. 
663         <para /></listitem>
664     </varlistentry>
665     <varlistentry>
666         <term>
667             <command>
668                 <option>own_window_title</option>
669             </command>
670         </term>
671         <listitem>Manually set the window name. Defaults to
672         "&lt;hostname&gt; - conky". 
673         <para /></listitem>
674     </varlistentry>
675     <varlistentry>
676         <term>
677             <command>
678                 <option>own_window_argb_visual</option>
679             </command>
680         </term>
681                 <listitem>Boolean, use ARGB visual? ARGB can be used for real
682                         transparency, note that a composite manager is required for real
683                         transparency.  This option will not work as desired (in most cases)
684                         in conjunction with 'own_window_type override'.
685         <para /></listitem>
686     </varlistentry>
687     <varlistentry>
688         <term>
689             <command>
690                 <option>own_window_argb_value</option>
691             </command>
692         </term>
693                 <listitem>When ARGB visuals are enabled, this use this to modify the alpha value used.  Valid range is 0-255, where 0 is 0% opacity, and 255 is 100% opacity.  Note that if own_window_transparent is enabled, this value has no effect.
694         <para /></listitem>
695     </varlistentry>
696     <varlistentry>
697         <term>
698             <command>
699                 <option>own_window_transparent</option>
700             </command>
701         </term>
702                 <listitem>Boolean, set transparency? If ARGB visual is enabled, sets
703                         background opacity to 0%.
704         <para /></listitem>
705     </varlistentry>
706     <varlistentry>
707         <term>
708             <command>
709                 <option>own_window_type</option>
710             </command>
711         </term>
712         <listitem>if own_window is yes, you may specify type
713         normal, desktop, dock, panel or override (default: normal).
714         Desktop windows are special windows that have no window
715         decorations; are always visible on your desktop; do not
716         appear in your pager or taskbar; and are sticky across all
717         workspaces. Panel windows reserve space along a desktop
718         edge, just like panels and taskbars, preventing maximized
719         windows from overlapping them. The edge is chosen based on
720         the alignment option. Override windows are not under the
721         control of the window manager. Hints are ignored. This type
722         of window can be useful for certain situations. 
723         <para /></listitem>
724     </varlistentry>
725     <varlistentry>
726         <term>
727             <command>
728                 <option>pad_percents</option>
729             </command>
730         </term>
731         <listitem>Pad percentages to this many decimals (0 = no
732         padding) 
733         <para /></listitem>
734     </varlistentry>
735     <varlistentry>
736         <term>
737             <command>
738                 <option>pop3</option>
739             </command>
740         </term>
741         <listitem>Default global POP3 server. Arguments are: "host
742         user pass [-i interval (in seconds)] [-p port] [-e 'command']
743         [-r retries]". Default port is 110, default interval is 5
744         minutes, and default number of retries before giving up is
745         5. If the password is supplied as '*', you will be prompted
746         to enter the password when Conky starts. 
747         <para /></listitem>
748     </varlistentry>
749     <varlistentry>
750         <term>
751             <command>
752                 <option>short_units</option>
753             </command>
754         </term>
755         <listitem>Shortens units to a single character (kiB-&gt;k,
756         GiB-&gt;G, etc.). Default is off. 
757         <para /></listitem>
758     </varlistentry>
759     <varlistentry>
760         <term>
761             <command>
762                 <option>show_graph_range</option>
763             </command>
764         </term>
765         <listitem>Shows the time range covered by a graph. 
766         <para /></listitem>
767     </varlistentry>
768     <varlistentry>
769         <term>
770             <command>
771                 <option>show_graph_scale</option>
772             </command>
773         </term>
774         <listitem>Shows the maximum value in scaled graphs. 
775         <para /></listitem>
776     </varlistentry>
777     <varlistentry>
778         <term>
779             <command>
780                 <option>stippled_borders</option>
781             </command>
782         </term>
783         <listitem>Border stippling (dashing) in pixels 
784         <para /></listitem>
785     </varlistentry>
786     <varlistentry>
787         <term>
788             <command>
789                 <option>temperature_unit</option>
790             </command>
791         </term>
792         <listitem>Desired output unit of all objects displaying a
793         temperature. Parameters are either "fahrenheit" or
794         "celsius". The default unit is degree Celsius. 
795         <para /></listitem>
796     </varlistentry>
797     <varlistentry>
798         <term>
799             <command>
800                 <option>templateN</option>
801             </command>
802         </term>
803         <listitem>Define a template for later use inside TEXT
804         segments. Substitute N by a digit between 0 and 9,
805         inclusively. The value of the variable is being inserted
806         into the stuff below TEXT at the corresponding position,
807         but before some substitutions are applied: 
808         <simplelist>
809             <member>'\n' -&gt; newline</member>
810             <member>'\\' -&gt; backslash</member>
811             <member>'\ ' -&gt; space</member>
812             <member>'\N' -&gt; template argument N</member>
813         </simplelist>
814         <para /></listitem>
815     </varlistentry>
816     <varlistentry>
817         <term>
818             <command>
819                 <option>text_buffer_size</option>
820             </command>
821             <option>bytes</option>
822         </term>
823         <listitem>Size of the standard text buffer (default is 256
824         bytes). This buffer is used for intermediary text, such as
825         individual lines, output from $exec vars, and various other
826         variables. Increasing the size of this buffer can
827         drastically reduce Conky's performance, but will allow for
828         more text display per variable. The size of this buffer
829         cannot be smaller than the default value of 256 bytes. 
830         <para /></listitem>
831     </varlistentry>
832     <varlistentry>
833         <term>
834             <command>
835                 <option>times_in_seconds</option>
836             </command>
837         </term>
838         <listitem>If true, variables that output times output a number
839         that represents seconds. This doesn't affect $time, $tztime and
840         $utime
841         <para /></listitem>
842     </varlistentry>
843     <varlistentry>
844         <term>
845             <command>
846                 <option>top_cpu_separate</option>
847             </command>
848         </term>
849         <listitem>If true, cpu in top will show usage of one
850         processor's power. If false, cpu in top will show the usage
851         of all processors' power combined. 
852         <para /></listitem>
853     </varlistentry>
854     <varlistentry>
855         <term>
856             <command>
857                 <option>top_name_width</option>
858             </command>
859         </term>
860         <listitem>Width for $top name value (defaults to 15
861         characters). 
862         <para /></listitem>
863     </varlistentry>
864     <varlistentry>
865         <term>
866             <command>
867                 <option>total_run_times</option>
868             </command>
869         </term>
870         <listitem>Total number of times for Conky to update before
871         quitting. Zero makes Conky run forever 
872         <para /></listitem>
873     </varlistentry>
874     <varlistentry>
875         <term>
876             <command>
877                 <option>update_interval</option>
878             </command>
879             <option>seconds</option>
880         </term>
881         <listitem>Update interval 
882         <para /></listitem>
883     </varlistentry>
884     <varlistentry>
885         <term>
886             <command>
887                 <option>update_interval_on_battery</option>
888             </command>
889             <option>seconds</option>
890         </term>
891         <listitem>Update interval when running on batterypower 
892         <para /></listitem>
893     </varlistentry>
894     <varlistentry>
895         <term>
896             <command>
897                 <option>uppercase</option>
898             </command>
899         </term>
900         <listitem>Boolean value, if true, text is rendered in upper
901         case 
902         <para /></listitem>
903     </varlistentry>
904     <varlistentry>
905         <term>
906             <command>
907                 <option>use_spacer</option>
908             </command>
909         </term>
910         <listitem>Adds spaces around certain objects to stop them
911         from moving other things around. Arguments are left, right,
912         and none (default). The old true/false values are
913         deprecated and default to right/none respectively. Note
914         that this only helps if you are using a mono font, such as
915         Bitstream Vera Sans Mono. 
916         <para /></listitem>
917     </varlistentry>
918     <varlistentry>
919         <term>
920             <command>
921                 <option>use_xft</option>
922             </command>
923         </term>
924         <listitem>Use Xft (anti-aliased font and stuff) 
925         <para /></listitem>
926     </varlistentry>
927     <varlistentry>
928         <term>
929             <command>
930                 <option>xftalpha</option>
931             </command>
932         </term>
933         <listitem>Alpha of Xft font. Must be a value at or between
934         1 and 0. 
935         <para /></listitem>
936     </varlistentry>
937     <varlistentry>
938         <term>
939             <command>
940                 <option>xftfont</option>
941             </command>
942         </term>
943         <listitem>Xft font to use. 
944         <para /></listitem>
945     </varlistentry>
946 </variablelist>