git.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, bottom_left, bottom_right, or none
   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>default_color</option></command></term>
 109         <listitem>
 110                 Default color and border color
 111         <para></para></listitem>
 112 </varlistentry>
 113
 114 <varlistentry>
 115         <term><command><option>default_outline_color</option></command></term>
 116         <listitem>
 117                 Default outline color
 118         <para></para></listitem>
 119 </varlistentry>
 120
 121 <varlistentry>
 122         <term><command><option>default_shade_color</option></command></term>
 123         <listitem>
 124                 Default shading color and border's shading color
 125         <para></para></listitem>
 126 </varlistentry>
 127
 128 <varlistentry>
 129         <term><command><option>double_buffer</option></command></term>
 130         <listitem>
 131                 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.
 132         <para></para></listitem>
 133 </varlistentry>
 134
 135 <varlistentry>
 136         <term><command><option>draw_borders</option></command></term>
 137         <listitem>
 138                 Draw borders around text?
 139         <para></para></listitem>
 140 </varlistentry>
 141
 142 <varlistentry>
 143         <term><command><option>draw_graph_borders</option></command></term>
 144         <listitem>
 145                 Draw borders around graphs?
 146         <para></para></listitem>
 147 </varlistentry>
 148
 149 <varlistentry>
 150         <term><command><option>draw_outline</option></command></term>
 151         <listitem>
 152                 Draw outlines?
 153         <para></para></listitem>
 154 </varlistentry>
 155
 156 <varlistentry>
 157         <term><command><option>draw_shades</option></command></term>
 158         <listitem>
 159                 Draw shades?
 160         <para></para></listitem>
 161 </varlistentry>
 162
 163 <varlistentry>
 164         <term><command><option>font</option></command></term>
 165         <listitem>
 166                 Font name in X, xfontsel can be used to get a nice font
 167         <para></para></listitem>
 168 </varlistentry>
 169
 170 <varlistentry>
 171         <term><command><option>gap_x</option></command></term>
 172         <listitem>
 173                 Gap, in pixels, between right or left border of screen, same as passing -x at command line,
 174                 e.g. gap_x 10
 175         <para></para></listitem>
 176 </varlistentry>
 177
 178 <varlistentry>
 179         <term><command><option>gap_y</option></command></term>
 180         <listitem>
 181                 Gap, in pixels, between top or bottom border of screen, same as passing -y at command line,
 182                 e.g. gap_y 10.
 183         <para></para></listitem>
 184 </varlistentry>
 185
 186 <varlistentry>
 187         <term><command><option>imap</option></command></term>
 188         <listitem>
 189                 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.
 190         <para></para></listitem>
 191 </varlistentry>
 192
 193 <varlistentry>
 194         <term><command><option>mail_spool</option></command></term>
 195         <listitem>
 196                 Mail spool for mail checking
 197         <para></para></listitem>
 198 </varlistentry>
 199
 200 <varlistentry>
 201         <term><command><option>max_port_monitor_connections</option></command></term>
 202         <listitem>
 203                 Allow each port monitor to track at most this many connections (if 0 or not set, default is 256)
 204         <para></para></listitem>
 205 </varlistentry>
 206
 207 <varlistentry>
 208         <term><command><option>max_specials</option></command></term>
 209         <listitem>
 210                 Maximum number of special things, e.g. fonts, offsets, aligns, etc. (default is 512)
 211                 <para></para></listitem>
 212 </varlistentry>
 213
 214 <varlistentry>
 215         <term><command><option>max_user_text</option></command>
 216                 <option>bytes</option>
 217         </term>
 218         <listitem>
 219                 Maximum size of user text buffer, i.e. layout below TEXT line in config file
 220                 (default is 16384 bytes)
 221                 <para></para></listitem>
 222 </varlistentry>
 223
 224 <varlistentry>
 225         <term><command><option>text_buffer_size</option></command>
 226                 <option>bytes</option>
 227         </term>
 228         <listitem>
 229                 Size of the standard text buffer (default is 1280 bytes).
 230                 <para></para></listitem>
 231 </varlistentry>
 232
 233 <varlistentry>
 234         <term><command><option>maximum_width</option></command>
 235                 <option>pixels</option>
 236         </term>
 237         <listitem>
 238                 Maximum width of window
 239                 <para></para></listitem>
 240 </varlistentry>
 241
 242 <varlistentry>
 243         <term><command><option>minimum_size</option></command>
 244         <option>width (height)</option>
 245         </term>
 246         <listitem>
 247                 Minimum size of window
 248         <para></para></listitem>
 249 </varlistentry>
 250
 251 <varlistentry>
 252         <term><command><option>mpd_host</option></command></term>
 253         <listitem>
 254                 Host of MPD server
 255         <para></para></listitem>
 256 </varlistentry>
 257
 258 <varlistentry>
 259         <term><command><option>mpd_port</option></command></term>
 260         <listitem>
 261                 Port of MPD server
 262         <para></para></listitem>
 263 </varlistentry>
 264
 265 <varlistentry>
 266         <term><command><option>mpd_password</option></command></term>
 267         <listitem>
 268                 MPD server password
 269         <para></para></listitem>
 270 </varlistentry>
 271
 272 <varlistentry>
 273         <term><command><option>mpd_interval</option></command></term>
 274         <listitem>
 275                 MPD thread update interval (defaults to Conky's update interval)
 276         <para></para></listitem>
 277 </varlistentry>
 278
 279 <varlistentry>
 280         <term><command><option>net_avg_samples</option></command></term>
 281         <listitem>
 282                 The number of samples to average for net data
 283         <para></para></listitem>
 284 </varlistentry>
 285
 286 <varlistentry>
 287         <term><command><option>no_buffers</option></command></term>
 288         <listitem>
 289                 Substract (file system) buffers from used memory?
 290         <para></para></listitem>
 291 </varlistentry>
 292
 293 <varlistentry>
 294         <term><command><option>override_utf8_locale</option></command></term>
 295         <listitem>
 296                 Force UTF8? requires XFT
 297         <para></para></listitem>
 298 </varlistentry>
 299
 300 <varlistentry>
 301         <term><command><option>own_window</option></command></term>
 302         <listitem>
 303                 Boolean, create own window to draw?
 304         <para></para></listitem>
 305 </varlistentry>
 306
 307 <varlistentry>
 308         <term><command><option>own_window_class</option></command></term>
 309         <listitem>
 310                 Manually set the WM_CLASS name.  Defaults to "Conky".
 311         <para></para></listitem>
 312 </varlistentry>
 313
 314 <varlistentry>
 315         <term><command><option>own_window_colour</option></command>
 316                 <option>colour</option>
 317         </term>
 318         <listitem>
 319                 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)
 320                 <para></para></listitem>
 321 </varlistentry>
 322
 323 <varlistentry>
 324         <term><command><option>own_window_hints</option></command>
 325                 <option>undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
 326         </term>
 327         <listitem>
 328                 If own_window is yes, you may use these window manager hints to affect the way Conky displays.
 329                 Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
 330                 If you use own_window_type override, window manager hints have no meaning and are ignored.
 331         <para></para></listitem>
 332 </varlistentry>
 333
 334 <varlistentry>
 335         <term><command><option>own_window_title</option></command></term>
 336         <listitem>
 337                 Manually set the window name.  Defaults to "&lt;hostname&gt; - conky".
 338         <para></para></listitem>
 339 </varlistentry>
 340
 341 <varlistentry>
 342         <term><command><option>own_window_transparent</option></command></term>
 343         <listitem>
 344                 Boolean, set pseudo-transparency?
 345                 <para></para></listitem>
 346 </varlistentry>
 347
 348 <varlistentry>
 349         <term><command><option>own_window_type</option></command></term>
 350         <listitem>
 351                 if own_window is yes, you may specify type normal, desktop or override (default: normal).
 352                 Desktop windows are special windows that have no window decorations; are always visible
 353                 on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
 354                 Override windows are not under the control of the window manager.  Hints are ignored. This type
 355                 of window can be useful for certain situations.
 356                 <para></para></listitem>
 357 </varlistentry>
 358
 359 <varlistentry>
 360         <term><command><option>out_to_console</option></command>
 361         </term>
 362         <listitem>
 363                 Print text to stdout.
 364                 <para></para></listitem>
 365 </varlistentry>
 366
 367 <varlistentry>
 368         <term><command><option>pad_percents</option></command></term>
 369         <listitem>
 370                 Pad percentages to this many decimals (0 = no padding)
 371         <para></para></listitem>
 372 </varlistentry>
 373
 374 <varlistentry>
 375         <term><command><option>pop3</option></command></term>
 376         <listitem>
 377                 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.
 378         <para></para></listitem>
 379 </varlistentry>
 380
 381 <varlistentry>
 382         <term><command><option>stippled_borders</option></command></term>
 383         <listitem>
 384                 Border stippling (dashing) in pixels
 385         <para></para></listitem>
 386 </varlistentry>
 387
 388 <varlistentry>
 389         <term><command><option>total_run_times</option></command></term>
 390         <listitem>
 391                 Total number of times for Conky to update before quitting. Zero makes Conky run forever
 392         <para></para></listitem>
 393 </varlistentry>
 394
 395 <varlistentry>
 396         <term><command><option>update_interval</option></command></term>
 397         <listitem>
 398                 Update interval in seconds
 399         <para></para></listitem>
 400 </varlistentry>
 401
 402 <varlistentry>
 403         <term><command><option>uppercase</option></command></term>
 404         <listitem>
 405                 Boolean value, if true, text is rendered in upper case
 406         <para></para></listitem>
 407 </varlistentry>
 408
 409 <varlistentry>
 410         <term><command><option>use_spacer</option></command></term>
 411         <listitem>
 412                 Adds spaces after certain objects to stop them from moving other things around. Note that this only helps if you are using a mono font, such as Bitstream Vera Sans Mono.
 413         <para></para></listitem>
 414 </varlistentry>
 415
 416 <varlistentry>
 417         <term><command><option>use_xft</option></command></term>
 418         <listitem>
 419                 Use Xft (anti-aliased font and stuff)
 420         <para></para></listitem>
 421 </varlistentry>
 422
 423 <varlistentry>
 424         <term><command><option>xftalpha</option></command></term>
 425         <listitem>
 426                 Alpha of Xft font.  Must be a value at or between 1 and 0.
 427         <para></para></listitem>
 428 </varlistentry>
 429
 430 <varlistentry>
 431         <term><command><option>xftfont</option></command></term>
 432         <listitem>
 433                 Xft font to use.
 434         <para></para></listitem>
 435 </varlistentry>
 436
 437 <varlistentry>
 438         <term><command><option>TEXT</option></command></term>
 439         <listitem>
 440                 After this begins text to be formatted on screen
 441         <para></para></listitem>
 442 </varlistentry>
 443
 444 </variablelist>