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>text_buffer_size</option></command>
 233                         <option>bytes</option>
 234                 </term>
 235                 <listitem>
 236                         Size of the standard text buffer (default is 256 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 256 bytes.
 237                         <para></para></listitem>
 238         </varlistentry>
 239
 240         <varlistentry>
 241                 <term><command><option>maximum_width</option></command>
 242                         <option>pixels</option>
 243                 </term>
 244                 <listitem>
 245                         Maximum width of window
 246                         <para></para></listitem>
 247         </varlistentry>
 248
 249         <varlistentry>
 250                 <term><command><option>minimum_size</option></command>
 251                         <option>width (height)</option>
 252                 </term>
 253                 <listitem>
 254                         Minimum size of window
 255                         <para></para></listitem>
 256         </varlistentry>
 257
 258         <varlistentry>
 259                 <term><command><option>mpd_host</option></command></term>
 260                 <listitem>
 261                         Host of MPD server
 262                         <para></para></listitem>
 263         </varlistentry>
 264
 265         <varlistentry>
 266                 <term><command><option>mpd_port</option></command></term>
 267                 <listitem>
 268                         Port of MPD server
 269                         <para></para></listitem>
 270         </varlistentry>
 271
 272         <varlistentry>
 273                 <term><command><option>mpd_password</option></command></term>
 274                 <listitem>
 275                         MPD server password
 276                         <para></para></listitem>
 277         </varlistentry>
 278
 279         <varlistentry>
 280                 <term><command><option>music_player_interval</option></command></term>
 281                 <listitem>
 282                         Music player thread update interval (defaults to Conky's update interval)
 283                         <para></para></listitem>
 284         </varlistentry>
 285
 286         <varlistentry>
 287                 <term><command><option>net_avg_samples</option></command></term>
 288                 <listitem>
 289                         The number of samples to average for net data
 290                         <para></para></listitem>
 291         </varlistentry>
 292
 293         <varlistentry>
 294                 <term><command><option>no_buffers</option></command></term>
 295                 <listitem>
 296                         Substract (file system) buffers from used memory?
 297                         <para></para></listitem>
 298         </varlistentry>
 299
 300         <varlistentry>
 301                 <term><command><option>override_utf8_locale</option></command></term>
 302                 <listitem>
 303                         Force UTF8? requires XFT
 304                         <para></para></listitem>
 305         </varlistentry>
 306
 307         <varlistentry>
 308                 <term><command><option>own_window</option></command></term>
 309                 <listitem>
 310                         Boolean, create own window to draw?
 311                         <para></para></listitem>
 312         </varlistentry>
 313
 314         <varlistentry>
 315                 <term><command><option>own_window_class</option></command></term>
 316                 <listitem>
 317                         Manually set the WM_CLASS name.  Defaults to "Conky".
 318                         <para></para></listitem>
 319         </varlistentry>
 320
 321         <varlistentry>
 322                 <term><command><option>own_window_colour</option></command>
 323                         <option>colour</option>
 324                 </term>
 325                 <listitem>
 326                         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)
 327                         <para></para></listitem>
 328         </varlistentry>
 329
 330         <varlistentry>
 331                 <term><command><option>own_window_hints</option></command>
 332                         <option>undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
 333                 </term>
 334                 <listitem>
 335                         If own_window is yes, you may use these window manager hints to affect the way Conky displays.
 336                         Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
 337                         If you use own_window_type override, window manager hints have no meaning and are ignored.
 338                         <para></para></listitem>
 339         </varlistentry>
 340
 341         <varlistentry>
 342                 <term><command><option>own_window_title</option></command></term>
 343                 <listitem>
 344                         Manually set the window name.  Defaults to "&lt;hostname&gt; - conky".
 345                         <para></para></listitem>
 346         </varlistentry>
 347
 348         <varlistentry>
 349                 <term><command><option>own_window_transparent</option></command></term>
 350                 <listitem>
 351                         Boolean, set pseudo-transparency?
 352                         <para></para></listitem>
 353         </varlistentry>
 354
 355         <varlistentry>
 356                 <term><command><option>own_window_type</option></command></term>
 357                 <listitem>
 358                         if own_window is yes, you may specify type normal, desktop or override (default: normal).
 359                         Desktop windows are special windows that have no window decorations; are always visible
 360                         on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
 361                         Override windows are not under the control of the window manager.  Hints are ignored. This type
 362                         of window can be useful for certain situations.
 363                         <para></para></listitem>
 364         </varlistentry>
 365
 366         <varlistentry>
 367                 <term><command><option>out_to_console</option></command>
 368                 </term>
 369                 <listitem>
 370                         Print text to stdout.
 371                         <para></para></listitem>
 372         </varlistentry>
 373
 374         <varlistentry>
 375                 <term><command><option>pad_percents</option></command></term>
 376                 <listitem>
 377                         Pad percentages to this many decimals (0 = no padding)
 378                         <para></para></listitem>
 379         </varlistentry>
 380
 381         <varlistentry>
 382                 <term><command><option>pop3</option></command></term>
 383                 <listitem>
 384                         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.
 385                         <para></para></listitem>
 386         </varlistentry>
 387
 388         <varlistentry>
 389                 <term><command><option>short_units</option></command></term>
 390                 <listitem>
 391                         Shortens units to a single character (kiB->k, GiB->G, etc.).  Default is off.
 392                         <para></para></listitem>
 393         </varlistentry>
 394
 395         <varlistentry>
 396                 <term><command><option>show_graph_scale</option></command></term>
 397                 <listitem>
 398                         Shows the maximum value in scaled graphs.
 399                         <para></para></listitem>
 400         </varlistentry>
 401
 402         <varlistentry>
 403                 <term><command><option>stippled_borders</option></command></term>
 404                 <listitem>
 405                         Border stippling (dashing) in pixels
 406                         <para></para></listitem>
 407         </varlistentry>
 408
 409         <varlistentry>
 410                 <term><command><option>total_run_times</option></command></term>
 411                 <listitem>
 412                         Total number of times for Conky to update before quitting. Zero makes Conky run forever
 413                         <para></para></listitem>
 414         </varlistentry>
 415
 416         <varlistentry>
 417                 <term><command><option>update_interval</option></command></term>
 418                 <listitem>
 419                         Update interval in seconds
 420                         <para></para></listitem>
 421         </varlistentry>
 422
 423         <varlistentry>
 424                 <term><command><option>uppercase</option></command></term>
 425                 <listitem>
 426                         Boolean value, if true, text is rendered in upper case
 427                         <para></para></listitem>
 428         </varlistentry>
 429
 430         <varlistentry>
 431                 <term><command><option>use_spacer</option></command></term>
 432                 <listitem>
 433                         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.
 434                         <para></para></listitem>
 435         </varlistentry>
 436
 437         <varlistentry>
 438                 <term><command><option>use_xft</option></command></term>
 439                 <listitem>
 440                         Use Xft (anti-aliased font and stuff)
 441                         <para></para></listitem>
 442         </varlistentry>
 443
 444         <varlistentry>
 445                 <term><command><option>xftalpha</option></command></term>
 446                 <listitem>
 447                         Alpha of Xft font.  Must be a value at or between 1 and 0.
 448                         <para></para></listitem>
 449         </varlistentry>
 450
 451         <varlistentry>
 452                 <term><command><option>xftfont</option></command></term>
 453                 <listitem>
 454                         Xft font to use.
 455                         <para></para></listitem>
 456         </varlistentry>
 457
 458         <varlistentry>
 459                 <term><command><option>TEXT</option></command></term>
 460                 <listitem>
 461                         After this begins text to be formatted on screen
 462                         <para></para></listitem>
 463         </varlistentry>
 464
 465 </variablelist>