vcs.maemo.org Git - monky/blob - doc/config_settings.xml

   1 <variablelist>
   2 <varlistentry>
   3         <term><command><option>alignment</option></command></term>
   4         <listitem>
   5                 Aligned position on screen, may be top_left, top_right, top_middle, bottom_left, bottom_right, bottom_middle, middle_left, middle_right, or none (also can be abreviated as tl, tr, tm, bl, br, bm, ml, mr)
   6         <para></para></listitem>
   7 </varlistentry>
   8
   9 <varlistentry>
  10         <term><command><option>background</option></command></term>
  11         <listitem>
  12                 Boolean value, if true, Conky will be forked to background when started
  13         <para></para></listitem>
  14 </varlistentry>
  15
  16 <varlistentry>
  17         <term><command><option>border_margin</option></command></term>
  18         <listitem>
  19                 Border margin in pixels
  20         <para></para></listitem>
  21 </varlistentry>
  22
  23 <varlistentry>
  24         <term><command><option>border_width</option></command></term>
  25         <listitem>
  26                 Border width in pixels
  27         <para></para></listitem>
  28 </varlistentry>
  29
  30 <varlistentry>
  31         <term><command><option>color0</option></command></term>
  32         <listitem>
  33                 A color variable for use inside TEXT segments
  34         <para></para></listitem>
  35 </varlistentry>
  36
  37 <varlistentry>
  38         <term><command><option>color1</option></command></term>
  39         <listitem>
  40                 A color variable for use inside TEXT segments
  41         <para></para></listitem>
  42 </varlistentry>
  43
  44 <varlistentry>
  45         <term><command><option>color2</option></command></term>
  46         <listitem>
  47                 A color variable for use inside TEXT segments
  48         <para></para></listitem>
  49 </varlistentry>
  50
  51 <varlistentry>
  52         <term><command><option>color3</option></command></term>
  53         <listitem>
  54                 A color variable for use inside TEXT segments
  55         <para></para></listitem>
  56 </varlistentry>
  57
  58 <varlistentry>
  59         <term><command><option>color4</option></command></term>
  60         <listitem>
  61                 A color variable for use inside TEXT segments
  62         <para></para></listitem>
  63 </varlistentry>
  64
  65 <varlistentry>
  66         <term><command><option>color5</option></command></term>
  67         <listitem>
  68                 A color variable for use inside TEXT segments
  69         <para></para></listitem>
  70 </varlistentry>
  71
  72 <varlistentry>
  73         <term><command><option>color6</option></command></term>
  74         <listitem>
  75                 A color variable for use inside TEXT segments
  76         <para></para></listitem>
  77 </varlistentry>
  78
  79 <varlistentry>
  80         <term><command><option>color7</option></command></term>
  81         <listitem>
  82                 A color variable for use inside TEXT segments
  83         <para></para></listitem>
  84 </varlistentry>
  85
  86 <varlistentry>
  87         <term><command><option>color8</option></command></term>
  88         <listitem>
  89                 A color variable for use inside TEXT segments
  90         <para></para></listitem>
  91 </varlistentry>
  92
  93 <varlistentry>
  94         <term><command><option>color9</option></command></term>
  95         <listitem>
  96                 A color variable for use inside TEXT segments
  97         <para></para></listitem>
  98 </varlistentry>
  99
 100 <varlistentry>
 101         <term><command><option>cpu_avg_samples</option></command></term>
 102         <listitem>
 103                 The number of samples to average for CPU monitoring
 104         <para></para></listitem>
 105 </varlistentry>
 106
 107 <varlistentry>
 108         <term><command><option>top_cpu_separate</option></command></term>
 109         <listitem>
 110                 If true, cpu in top will show usage of one processor's power.  If false, cpu in top will show the usage of all processors' power combined.
 111         <para></para></listitem>
 112 </varlistentry>
 113
 114 <varlistentry>
 115         <term><command><option>default_color</option></command></term>
 116         <listitem>
 117                 Default color and border color
 118         <para></para></listitem>
 119 </varlistentry>
 120
 121 <varlistentry>
 122         <term><command><option>default_outline_color</option></command></term>
 123         <listitem>
 124                 Default outline color
 125         <para></para></listitem>
 126 </varlistentry>
 127
 128 <varlistentry>
 129         <term><command><option>default_shade_color</option></command></term>
 130         <listitem>
 131                 Default shading color and border's shading color
 132         <para></para></listitem>
 133 </varlistentry>
 134
 135 <varlistentry>
 136         <term><command><option>double_buffer</option></command></term>
 137         <listitem>
 138                 Use the Xdbe extension? (eliminates flicker) It is highly recommended to use own window with this one so double buffer won't be so big.
 139         <para></para></listitem>
 140 </varlistentry>
 141
 142 <varlistentry>
 143         <term><command><option>draw_borders</option></command></term>
 144         <listitem>
 145                 Draw borders around text?
 146         <para></para></listitem>
 147 </varlistentry>
 148
 149 <varlistentry>
 150         <term><command><option>draw_graph_borders</option></command></term>
 151         <listitem>
 152                 Draw borders around graphs?
 153         <para></para></listitem>
 154 </varlistentry>
 155
 156 <varlistentry>
 157         <term><command><option>draw_outline</option></command></term>
 158         <listitem>
 159                 Draw outlines?
 160         <para></para></listitem>
 161 </varlistentry>
 162
 163 <varlistentry>
 164         <term><command><option>draw_shades</option></command></term>
 165         <listitem>
 166                 Draw shades?
 167         <para></para></listitem>
 168 </varlistentry>
 169
 170 <varlistentry>
 171         <term><command><option>font</option></command></term>
 172         <listitem>
 173                 Font name in X, xfontsel can be used to get a nice font
 174         <para></para></listitem>
 175 </varlistentry>
 176
 177 <varlistentry>
 178         <term><command><option>gap_x</option></command></term>
 179         <listitem>
 180                 Gap, in pixels, between right or left border of screen, same as passing -x at command line,
 181                 e.g. gap_x 10
 182         <para></para></listitem>
 183 </varlistentry>
 184
 185 <varlistentry>
 186         <term><command><option>gap_y</option></command></term>
 187         <listitem>
 188                 Gap, in pixels, between top or bottom border of screen, same as passing -y at command line,
 189                 e.g. gap_y 10.
 190         <para></para></listitem>
 191 </varlistentry>
 192
 193 <varlistentry>
 194         <term><command><option>imap</option></command></term>
 195         <listitem>
 196                 Default global IMAP server.  Arguments are: "host user pass [-i interval] [-f folder] [-p port] [-e command]".  Default port is 143, default folder is 'INBOX', default interval is 5 minutes.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
 197         <para></para></listitem>
 198 </varlistentry>
 199
 200 <varlistentry>
 201         <term><command><option>mail_spool</option></command></term>
 202         <listitem>
 203                 Mail spool for mail checking
 204         <para></para></listitem>
 205 </varlistentry>
 206
 207 <varlistentry>
 208         <term><command><option>max_port_monitor_connections</option></command></term>
 209         <listitem>
 210                 Allow each port monitor to track at most this many connections (if 0 or not set, default is 256)
 211         <para></para></listitem>
 212 </varlistentry>
 213
 214 <varlistentry>
 215         <term><command><option>max_specials</option></command></term>
 216         <listitem>
 217                 Maximum number of special things, e.g. fonts, offsets, aligns, etc. (default is 512)
 218                 <para></para></listitem>
 219 </varlistentry>
 220
 221 <varlistentry>
 222         <term><command><option>max_user_text</option></command>
 223                 <option>bytes</option>
 224         </term>
 225         <listitem>
 226                 Maximum size of user text buffer, i.e. layout below TEXT line in config file
 227                 (default is 16384 bytes)
 228                 <para></para></listitem>
 229 </varlistentry>
 230
 231 <varlistentry>
 232         <term><command><option>large_text_buffer_size</option></command>
 233                 <option>bytes</option>
 234         </term>
 235         <listitem>
 236                 Size of the standard large text buffer (default is 1024 bytes).  This buffer is used for the entirety of Conky's text.  Increasing the buffer's size will decrease performance and increase the memory footprint of Conky, but it will allow for more text to be displayed in Conky.
 237                 <para></para></listitem>
 238 </varlistentry>
 239
 240 <varlistentry>
 241         <term><command><option>small_text_buffer_size</option></command>
 242                 <option>bytes</option>
 243         </term>
 244         <listitem>
 245                 Size of the standard small text buffer (default is 128 bytes).  This buffer is used for intermediary text, such as individual lines, output from $exec vars, and various other variables.  Increasing the size of this buffer can drastically reduce Conky's performance, but will allow for more text display per variable.  The size of this buffer cannot be smaller than the default value of 128 bytes.
 246                 <para></para></listitem>
 247 </varlistentry>
 248
 249 <varlistentry>
 250         <term><command><option>maximum_width</option></command>
 251                 <option>pixels</option>
 252         </term>
 253         <listitem>
 254                 Maximum width of window
 255                 <para></para></listitem>
 256 </varlistentry>
 257
 258 <varlistentry>
 259         <term><command><option>minimum_size</option></command>
 260         <option>width (height)</option>
 261         </term>
 262         <listitem>
 263                 Minimum size of window
 264         <para></para></listitem>
 265 </varlistentry>
 266
 267 <varlistentry>
 268         <term><command><option>mpd_host</option></command></term>
 269         <listitem>
 270                 Host of MPD server
 271         <para></para></listitem>
 272 </varlistentry>
 273
 274 <varlistentry>
 275         <term><command><option>mpd_port</option></command></term>
 276         <listitem>
 277                 Port of MPD server
 278         <para></para></listitem>
 279 </varlistentry>
 280
 281 <varlistentry>
 282         <term><command><option>mpd_password</option></command></term>
 283         <listitem>
 284                 MPD server password
 285         <para></para></listitem>
 286 </varlistentry>
 287
 288 <varlistentry>
 289         <term><command><option>music_player_interval</option></command></term>
 290         <listitem>
 291                 Music player thread update interval (defaults to Conky's update interval)
 292         <para></para></listitem>
 293 </varlistentry>
 294
 295 <varlistentry>
 296         <term><command><option>net_avg_samples</option></command></term>
 297         <listitem>
 298                 The number of samples to average for net data
 299         <para></para></listitem>
 300 </varlistentry>
 301
 302 <varlistentry>
 303         <term><command><option>no_buffers</option></command></term>
 304         <listitem>
 305                 Substract (file system) buffers from used memory?
 306         <para></para></listitem>
 307 </varlistentry>
 308
 309 <varlistentry>
 310         <term><command><option>override_utf8_locale</option></command></term>
 311         <listitem>
 312                 Force UTF8? requires XFT
 313         <para></para></listitem>
 314 </varlistentry>
 315
 316 <varlistentry>
 317         <term><command><option>own_window</option></command></term>
 318         <listitem>
 319                 Boolean, create own window to draw?
 320         <para></para></listitem>
 321 </varlistentry>
 322
 323 <varlistentry>
 324         <term><command><option>own_window_class</option></command></term>
 325         <listitem>
 326                 Manually set the WM_CLASS name.  Defaults to "Conky".
 327         <para></para></listitem>
 328 </varlistentry>
 329
 330 <varlistentry>
 331         <term><command><option>own_window_colour</option></command>
 332                 <option>colour</option>
 333         </term>
 334         <listitem>
 335                 If own_window_transparent no, set a specified background colour (defaults to black).  Takes either a hex value (#ffffff) or a valid RGB name (see /usr/lib/X11/rgb.txt)
 336                 <para></para></listitem>
 337 </varlistentry>
 338
 339 <varlistentry>
 340         <term><command><option>own_window_hints</option></command>
 341                 <option>undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
 342         </term>
 343         <listitem>
 344                 If own_window is yes, you may use these window manager hints to affect the way Conky displays.
 345                 Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
 346                 If you use own_window_type override, window manager hints have no meaning and are ignored.
 347         <para></para></listitem>
 348 </varlistentry>
 349
 350 <varlistentry>
 351         <term><command><option>own_window_title</option></command></term>
 352         <listitem>
 353                 Manually set the window name.  Defaults to "&lt;hostname&gt; - conky".
 354         <para></para></listitem>
 355 </varlistentry>
 356
 357 <varlistentry>
 358         <term><command><option>own_window_transparent</option></command></term>
 359         <listitem>
 360                 Boolean, set pseudo-transparency?
 361                 <para></para></listitem>
 362 </varlistentry>
 363
 364 <varlistentry>
 365         <term><command><option>own_window_type</option></command></term>
 366         <listitem>
 367                 if own_window is yes, you may specify type normal, desktop or override (default: normal).
 368                 Desktop windows are special windows that have no window decorations; are always visible
 369                 on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
 370                 Override windows are not under the control of the window manager.  Hints are ignored. This type
 371                 of window can be useful for certain situations.
 372                 <para></para></listitem>
 373 </varlistentry>
 374
 375 <varlistentry>
 376         <term><command><option>out_to_console</option></command>
 377         </term>
 378         <listitem>
 379                 Print text to stdout.
 380                 <para></para></listitem>
 381 </varlistentry>
 382
 383 <varlistentry>
 384         <term><command><option>pad_percents</option></command></term>
 385         <listitem>
 386                 Pad percentages to this many decimals (0 = no padding)
 387         <para></para></listitem>
 388 </varlistentry>
 389
 390 <varlistentry>
 391         <term><command><option>pop3</option></command></term>
 392         <listitem>
 393                 Default global POP3 server.  Arguments are: "host user pass [-i interval] [-p port] [-e command]".  Default port is 110, default interval is 5 minutes.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
 394         <para></para></listitem>
 395 </varlistentry>
 396
 397 <varlistentry>
 398         <term><command><option>short_units</option></command></term>
 399         <listitem>
 400                 Shortens units to a single character (kiB->k, GiB->G, etc.).  Default is off.
 401         <para></para></listitem>
 402 </varlistentry>
 403
 404 <varlistentry>
 405         <term><command><option>stippled_borders</option></command></term>
 406         <listitem>
 407                 Border stippling (dashing) in pixels
 408         <para></para></listitem>
 409 </varlistentry>
 410
 411 <varlistentry>
 412         <term><command><option>total_run_times</option></command></term>
 413         <listitem>
 414                 Total number of times for Conky to update before quitting. Zero makes Conky run forever
 415         <para></para></listitem>
 416 </varlistentry>
 417
 418 <varlistentry>
 419         <term><command><option>update_interval</option></command></term>
 420         <listitem>
 421                 Update interval in seconds
 422         <para></para></listitem>
 423 </varlistentry>
 424
 425 <varlistentry>
 426         <term><command><option>uppercase</option></command></term>
 427         <listitem>
 428                 Boolean value, if true, text is rendered in upper case
 429         <para></para></listitem>
 430 </varlistentry>
 431
 432 <varlistentry>
 433         <term><command><option>use_spacer</option></command></term>
 434         <listitem>
 435                 Adds spaces around certain objects to stop them from moving other things around. Arguments are left, right, and none (default).  The old true/false values are deprecated and default to right/none respectively. Note that this only helps if you are using a mono font, such as Bitstream Vera Sans Mono.
 436         <para></para></listitem>
 437 </varlistentry>
 438
 439 <varlistentry>
 440         <term><command><option>use_xft</option></command></term>
 441         <listitem>
 442                 Use Xft (anti-aliased font and stuff)
 443         <para></para></listitem>
 444 </varlistentry>
 445
 446 <varlistentry>
 447         <term><command><option>xftalpha</option></command></term>
 448         <listitem>
 449                 Alpha of Xft font.  Must be a value at or between 1 and 0.
 450         <para></para></listitem>
 451 </varlistentry>
 452
 453 <varlistentry>
 454         <term><command><option>xftfont</option></command></term>
 455         <listitem>
 456                 Xft font to use.
 457         <para></para></listitem>
 458 </varlistentry>
 459
 460 <varlistentry>
 461         <term><command><option>TEXT</option></command></term>
 462         <listitem>
 463                 After this begins text to be formatted on screen
 464         <para></para></listitem>
 465 </varlistentry>
 466
 467 </variablelist>