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