git.maemo.org Git - monky/blob - 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 it
 343             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 it
 361             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>lua_startup_hook</option>
 395             </command>
 396             <option>function_name [function arguments]</option>
 397         </term>
 398         <listitem>
 399             <para>This function, if defined, will be called by
 400             Conky at startup or when the configuration is reloaded.
 401             Use this hook to initialize values, or for any run-once
 402             applications. Conky puts 'conky_' in front of
 403             function_name to prevent accidental calls to the wrong
 404             function unless you put you place 'conky_' in front of
 405             it yourself.</para>
 406         </listitem>
 407     </varlistentry>
 408     <varlistentry>
 409         <term>
 410             <command>
 411                 <option>mail_spool</option>
 412             </command>
 413         </term>
 414         <listitem>Mail spool for mail checking
 415         <para /></listitem>
 416     </varlistentry>
 417     <varlistentry>
 418         <term>
 419             <command>
 420                 <option>max_port_monitor_connections</option>
 421             </command>
 422         </term>
 423         <listitem>Allow each port monitor to track at most this
 424         many connections (if 0 or not set, default is 256)
 425         <para /></listitem>
 426     </varlistentry>
 427     <varlistentry>
 428         <term>
 429             <command>
 430                 <option>max_specials</option>
 431             </command>
 432         </term>
 433         <listitem>Maximum number of special things, e.g. fonts,
 434         offsets, aligns, etc. (default is 512)
 435         <para /></listitem>
 436     </varlistentry>
 437     <varlistentry>
 438         <term>
 439             <command>
 440                 <option>max_user_text</option>
 441             </command>
 442             <option>bytes</option>
 443         </term>
 444         <listitem>Maximum size of user text buffer, i.e. layout
 445         below TEXT line in config file (default is 16384 bytes)
 446         <para /></listitem>
 447     </varlistentry>
 448     <varlistentry>
 449         <term>
 450             <command>
 451                 <option>maximum_width</option>
 452             </command>
 453             <option>pixels</option>
 454         </term>
 455         <listitem>Maximum width of window
 456         <para /></listitem>
 457     </varlistentry>
 458     <varlistentry>
 459         <term>
 460             <command>
 461                 <option>minimum_size</option>
 462             </command>
 463             <option>width (height)</option>
 464         </term>
 465         <listitem>Minimum size of window
 466         <para /></listitem>
 467     </varlistentry>
 468     <varlistentry>
 469         <term>
 470             <command>
 471                 <option>mpd_host</option>
 472             </command>
 473         </term>
 474         <listitem>Host of MPD server
 475         <para /></listitem>
 476     </varlistentry>
 477     <varlistentry>
 478         <term>
 479             <command>
 480                 <option>mpd_password</option>
 481             </command>
 482         </term>
 483         <listitem>MPD server password
 484         <para /></listitem>
 485     </varlistentry>
 486     <varlistentry>
 487         <term>
 488             <command>
 489                 <option>mpd_port</option>
 490             </command>
 491         </term>
 492         <listitem>Port of MPD server
 493         <para /></listitem>
 494     </varlistentry>
 495     <varlistentry>
 496         <term>
 497             <command>
 498                 <option>music_player_interval</option>
 499             </command>
 500         </term>
 501         <listitem>Music player thread update interval (defaults to
 502         Conky's update interval)
 503         <para /></listitem>
 504     </varlistentry>
 505     <varlistentry>
 506         <term>
 507             <command>
 508                 <option>net_avg_samples</option>
 509             </command>
 510         </term>
 511         <listitem>The number of samples to average for net data
 512         <para /></listitem>
 513     </varlistentry>
 514     <varlistentry>
 515         <term>
 516             <command>
 517                 <option>no_buffers</option>
 518             </command>
 519         </term>
 520         <listitem>Substract (file system) buffers from used memory?
 521
 522         <para /></listitem>
 523     </varlistentry>
 524     <varlistentry>
 525         <term>
 526             <command>
 527                 <option>out_to_console</option>
 528             </command>
 529         </term>
 530         <listitem>Print text to stdout.
 531         <para /></listitem>
 532     </varlistentry>
 533     <varlistentry>
 534         <term>
 535             <command>
 536                 <option>out_to_ncurses</option>
 537             </command>
 538         </term>
 539         <listitem>Print text in the console, but use ncurses so
 540         that conky can print the text of a new update over the old
 541         text. (In the future this will provide more useful things)
 542         <para /></listitem>
 543     </varlistentry>
 544     <varlistentry>
 545         <term>
 546             <command>
 547                 <option>out_to_stderr</option>
 548             </command>
 549         </term>
 550         <listitem>Print text to stderr.
 551         <para /></listitem>
 552     </varlistentry>
 553     <varlistentry>
 554         <term>
 555             <command>
 556                 <option>out_to_x</option>
 557             </command>
 558         </term>
 559         <listitem>When set to no, there will be no output in X
 560         (useful when you also use things like out_to_console). If
 561         you set it to no, make sure that it's placed before all
 562         other X-related setting (take the first line of your
 563         configfile to be sure). Default value is yes
 564         <para /></listitem>
 565     </varlistentry>
 566     <varlistentry>
 567         <term>
 568             <command>
 569                 <option>override_utf8_locale</option>
 570             </command>
 571         </term>
 572         <listitem>Force UTF8? requires XFT
 573         <para /></listitem>
 574     </varlistentry>
 575     <varlistentry>
 576         <term>
 577             <command>
 578                 <option>overwrite_file</option>
 579             </command>
 580         </term>
 581         <listitem>Overwrite the file given as argument.
 582         <para /></listitem>
 583     </varlistentry>
 584     <varlistentry>
 585         <term>
 586             <command>
 587                 <option>own_window</option>
 588             </command>
 589         </term>
 590         <listitem>Boolean, create own window to draw?
 591         <para /></listitem>
 592     </varlistentry>
 593     <varlistentry>
 594         <term>
 595             <command>
 596                 <option>own_window_class</option>
 597             </command>
 598         </term>
 599         <listitem>Manually set the WM_CLASS name. Defaults to
 600         "Conky".
 601         <para /></listitem>
 602     </varlistentry>
 603     <varlistentry>
 604         <term>
 605             <command>
 606                 <option>own_window_colour</option>
 607             </command>
 608             <option>colour</option>
 609         </term>
 610         <listitem>If own_window_transparent no, set a specified
 611         background colour (defaults to black). Takes either a hex
 612         value (#ffffff) or a valid RGB name (see
 613         /usr/lib/X11/rgb.txt)
 614         <para /></listitem>
 615     </varlistentry>
 616     <varlistentry>
 617         <term>
 618             <command>
 619                 <option>own_window_hints</option>
 620             </command>
 621             <option>
 622             undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
 623         </term>
 624         <listitem>If own_window is yes, you may use these window
 625         manager hints to affect the way Conky displays. Notes: Use
 626         own_window_type desktop as another way to implement many of
 627         these hints implicitly. If you use own_window_type
 628         override, window manager hints have no meaning and are
 629         ignored.
 630         <para /></listitem>
 631     </varlistentry>
 632     <varlistentry>
 633         <term>
 634             <command>
 635                 <option>own_window_title</option>
 636             </command>
 637         </term>
 638         <listitem>Manually set the window name. Defaults to
 639         "&lt;hostname&gt; - conky".
 640         <para /></listitem>
 641     </varlistentry>
 642     <varlistentry>
 643         <term>
 644             <command>
 645                 <option>own_window_transparent</option>
 646             </command>
 647         </term>
 648         <listitem>Boolean, set pseudo-transparency?
 649         <para /></listitem>
 650     </varlistentry>
 651     <varlistentry>
 652         <term>
 653             <command>
 654                 <option>own_window_type</option>
 655             </command>
 656         </term>
 657         <listitem>if own_window is yes, you may specify type
 658         normal, desktop, dock, panel or override (default: normal).
 659         Desktop windows are special windows that have no window
 660         decorations; are always visible on your desktop; do not
 661         appear in your pager or taskbar; and are sticky across all
 662         workspaces. Panel windows reserve space along a desktop
 663         edge, just like panels and taskbars, preventing maximized
 664         windows from overlapping them. The edge is chosen based on
 665         the alignment option. Override windows are not under the
 666         control of the window manager. Hints are ignored. This type
 667         of window can be useful for certain situations.
 668         <para /></listitem>
 669     </varlistentry>
 670     <varlistentry>
 671         <term>
 672             <command>
 673                 <option>pad_percents</option>
 674             </command>
 675         </term>
 676         <listitem>Pad percentages to this many decimals (0 = no
 677         padding)
 678         <para /></listitem>
 679     </varlistentry>
 680     <varlistentry>
 681         <term>
 682             <command>
 683                 <option>pop3</option>
 684             </command>
 685         </term>
 686         <listitem>Default global POP3 server. Arguments are: "host
 687         user pass [-i interval (in seconds)] [-p port] [-e command]
 688         [-r retries]". Default port is 110, default interval is 5
 689         minutes, and default number of retries before giving up is
 690         5. If the password is supplied as '*', you will be prompted
 691         to enter the password when Conky starts.
 692         <para /></listitem>
 693     </varlistentry>
 694     <varlistentry>
 695         <term>
 696             <command>
 697                 <option>short_units</option>
 698             </command>
 699         </term>
 700         <listitem>Shortens units to a single character (kiB-&gt;k,
 701         GiB-&gt;G, etc.). Default is off.
 702         <para /></listitem>
 703     </varlistentry>
 704     <varlistentry>
 705         <term>
 706             <command>
 707                 <option>show_graph_range</option>
 708             </command>
 709         </term>
 710         <listitem>Shows the time range covered by a graph.
 711         <para /></listitem>
 712     </varlistentry>
 713     <varlistentry>
 714         <term>
 715             <command>
 716                 <option>show_graph_scale</option>
 717             </command>
 718         </term>
 719         <listitem>Shows the maximum value in scaled graphs.
 720         <para /></listitem>
 721     </varlistentry>
 722     <varlistentry>
 723         <term>
 724             <command>
 725                 <option>stippled_borders</option>
 726             </command>
 727         </term>
 728         <listitem>Border stippling (dashing) in pixels
 729         <para /></listitem>
 730     </varlistentry>
 731     <varlistentry>
 732         <term>
 733             <command>
 734                 <option>temperature_unit</option>
 735             </command>
 736         </term>
 737         <listitem>Desired output unit of all objects displaying a
 738         temperature. Parameters are either "fahrenheit" or
 739         "celsius". The default unit is degree Celsius.
 740         <para /></listitem>
 741     </varlistentry>
 742     <varlistentry>
 743         <term>
 744             <command>
 745                 <option>templateN</option>
 746             </command>
 747         </term>
 748         <listitem>Define a template for later use inside TEXT
 749         segments. Substitute N by a digit between 0 and 9,
 750         inclusively. The value of the variable is being inserted
 751         into the stuff below TEXT at the corresponding position,
 752         but before some substitutions are applied:
 753         <simplelist>
 754             <member>'\n' -&gt; newline</member>
 755             <member>'\\' -&gt; backslash</member>
 756             <member>'\ ' -&gt; space</member>
 757             <member>'\N' -&gt; template argument N</member>
 758         </simplelist>
 759         <para /></listitem>
 760     </varlistentry>
 761     <varlistentry>
 762         <term>
 763             <command>
 764                 <option>text_buffer_size</option>
 765             </command>
 766             <option>bytes</option>
 767         </term>
 768         <listitem>Size of the standard text buffer (default is 256
 769         bytes). This buffer is used for intermediary text, such as
 770         individual lines, output from $exec vars, and various other
 771         variables. Increasing the size of this buffer can
 772         drastically reduce Conky's performance, but will allow for
 773         more text display per variable. The size of this buffer
 774         cannot be smaller than the default value of 256 bytes.
 775         <para /></listitem>
 776     </varlistentry>
 777     <varlistentry>
 778         <term>
 779             <command>
 780                 <option>top_cpu_separate</option>
 781             </command>
 782         </term>
 783         <listitem>If true, cpu in top will show usage of one
 784         processor's power. If false, cpu in top will show the usage
 785         of all processors' power combined.
 786         <para /></listitem>
 787     </varlistentry>
 788     <varlistentry>
 789         <term>
 790             <command>
 791                 <option>top_name_width</option>
 792             </command>
 793         </term>
 794         <listitem>Width for $top name value (defaults to 15
 795         characters).
 796         <para /></listitem>
 797     </varlistentry>
 798     <varlistentry>
 799         <term>
 800             <command>
 801                 <option>total_run_times</option>
 802             </command>
 803         </term>
 804         <listitem>Total number of times for Conky to update before
 805         quitting. Zero makes Conky run forever
 806         <para /></listitem>
 807     </varlistentry>
 808     <varlistentry>
 809         <term>
 810             <command>
 811                 <option>update_interval</option>
 812             </command>
 813             <option>seconds</option>
 814         </term>
 815         <listitem>Update interval
 816         <para /></listitem>
 817     </varlistentry>
 818     <varlistentry>
 819         <term>
 820             <command>
 821                 <option>update_interval_on_battery</option>
 822             </command>
 823             <option>seconds</option>
 824         </term>
 825         <listitem>Update interval when running on batterypower
 826         <para /></listitem>
 827     </varlistentry>
 828     <varlistentry>
 829         <term>
 830             <command>
 831                 <option>uppercase</option>
 832             </command>
 833         </term>
 834         <listitem>Boolean value, if true, text is rendered in upper
 835         case
 836         <para /></listitem>
 837     </varlistentry>
 838     <varlistentry>
 839         <term>
 840             <command>
 841                 <option>use_spacer</option>
 842             </command>
 843         </term>
 844         <listitem>Adds spaces around certain objects to stop them
 845         from moving other things around. Arguments are left, right,
 846         and none (default). The old true/false values are
 847         deprecated and default to right/none respectively. Note
 848         that this only helps if you are using a mono font, such as
 849         Bitstream Vera Sans Mono.
 850         <para /></listitem>
 851     </varlistentry>
 852     <varlistentry>
 853         <term>
 854             <command>
 855                 <option>use_xft</option>
 856             </command>
 857         </term>
 858         <listitem>Use Xft (anti-aliased font and stuff)
 859         <para /></listitem>
 860     </varlistentry>
 861     <varlistentry>
 862         <term>
 863             <command>
 864                 <option>xftalpha</option>
 865             </command>
 866         </term>
 867         <listitem>Alpha of Xft font. Must be a value at or between
 868         1 and 0.
 869         <para /></listitem>
 870     </varlistentry>
 871     <varlistentry>
 872         <term>
 873             <command>
 874                 <option>xftfont</option>
 875             </command>
 876         </term>
 877         <listitem>Xft font to use.
 878         <para /></listitem>
 879     </varlistentry>
 880 </variablelist>