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