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