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>colorN</option></command></term>
  32                 <listitem>
  33                         Predefine a color for use inside TEXT segments. Substitute N by a digit between 0 and 9, inclusively. When specifying the color value in hex, omit the leading hash (#).
  34                         <para></para></listitem>
  35         </varlistentry>
  36
  37         <varlistentry>
  38                 <term><command><option>cpu_avg_samples</option></command></term>
  39                 <listitem>
  40                         The number of samples to average for CPU monitoring
  41                         <para></para></listitem>
  42         </varlistentry>
  43
  44         <varlistentry>
  45                 <term><command><option>top_cpu_separate</option></command></term>
  46                 <listitem>
  47                         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.
  48                         <para></para></listitem>
  49         </varlistentry>
  50
  51         <varlistentry>
  52                 <term><command><option>default_color</option></command></term>
  53                 <listitem>
  54                         Default color and border color
  55                         <para></para></listitem>
  56         </varlistentry>
  57
  58         <varlistentry>
  59                 <term><command><option>default_outline_color</option></command></term>
  60                 <listitem>
  61                         Default outline color
  62                         <para></para></listitem>
  63         </varlistentry>
  64
  65         <varlistentry>
  66                 <term><command><option>default_shade_color</option></command></term>
  67                 <listitem>
  68                         Default shading color and border's shading color
  69                         <para></para></listitem>
  70         </varlistentry>
  71
  72         <varlistentry>
  73                 <term><command><option>double_buffer</option></command></term>
  74                 <listitem>
  75                         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.
  76                         <para></para></listitem>
  77         </varlistentry>
  78
  79         <varlistentry>
  80                 <term><command><option>draw_borders</option></command></term>
  81                 <listitem>
  82                         Draw borders around text?
  83                         <para></para></listitem>
  84         </varlistentry>
  85
  86         <varlistentry>
  87                 <term><command><option>draw_graph_borders</option></command></term>
  88                 <listitem>
  89                         Draw borders around graphs?
  90                         <para></para></listitem>
  91         </varlistentry>
  92
  93         <varlistentry>
  94                 <term><command><option>draw_outline</option></command></term>
  95                 <listitem>
  96                         Draw outlines?
  97                         <para></para></listitem>
  98         </varlistentry>
  99
 100         <varlistentry>
 101                 <term><command><option>draw_shades</option></command></term>
 102                 <listitem>
 103                         Draw shades?
 104                         <para></para></listitem>
 105         </varlistentry>
 106
 107         <varlistentry>
 108                 <term><command><option>font</option></command></term>
 109                 <listitem>
 110                         Font name in X, xfontsel can be used to get a nice font
 111                         <para></para></listitem>
 112         </varlistentry>
 113
 114         <varlistentry>
 115                 <term><command><option>gap_x</option></command></term>
 116                 <listitem>
 117                         Gap, in pixels, between right or left border of screen, same as passing -x at command line,
 118                         e.g. gap_x 10
 119                         <para></para></listitem>
 120         </varlistentry>
 121
 122         <varlistentry>
 123                 <term><command><option>gap_y</option></command></term>
 124                 <listitem>
 125                         Gap, in pixels, between top or bottom border of screen, same as passing -y at command line,
 126                         e.g. gap_y 10.
 127                         <para></para></listitem>
 128         </varlistentry>
 129
 130         <varlistentry>
 131                 <term><command><option>if_up_strictness</option></command></term>
 132                 <listitem>
 133                         How strict should if_up be when testing an interface for being up? The value is one of up, link or address, to check for the interface being solely up, being up and having link or being up, having link and an assigned IP address.
 134                         <para></para></listitem>
 135         </varlistentry>
 136
 137         <varlistentry>
 138                 <term><command><option>imap</option></command></term>
 139                 <listitem>
 140                         Default global IMAP server.  Arguments are: "host user pass [-i interval] [-f folder] [-p port] [-e command] [-r retries]".  Default port is 143, default folder is 'INBOX', default interval is 5 minutes, and default number of retries before giving up is 5.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
 141                         <para></para></listitem>
 142         </varlistentry>
 143
 144         <varlistentry>
 145                 <term><command><option>mail_spool</option></command></term>
 146                 <listitem>
 147                         Mail spool for mail checking
 148                         <para></para></listitem>
 149         </varlistentry>
 150
 151         <varlistentry>
 152                 <term><command><option>max_port_monitor_connections</option></command></term>
 153                 <listitem>
 154                         Allow each port monitor to track at most this many connections (if 0 or not set, default is 256)
 155                         <para></para></listitem>
 156         </varlistentry>
 157
 158         <varlistentry>
 159                 <term><command><option>max_specials</option></command></term>
 160                 <listitem>
 161                         Maximum number of special things, e.g. fonts, offsets, aligns, etc. (default is 512)
 162                         <para></para></listitem>
 163         </varlistentry>
 164
 165         <varlistentry>
 166                 <term><command><option>max_user_text</option></command>
 167                         <option>bytes</option>
 168                 </term>
 169                 <listitem>
 170                         Maximum size of user text buffer, i.e. layout below TEXT line in config file
 171                         (default is 16384 bytes)
 172                         <para></para></listitem>
 173         </varlistentry>
 174
 175         <varlistentry>
 176                 <term><command><option>text_buffer_size</option></command>
 177                         <option>bytes</option>
 178                 </term>
 179                 <listitem>
 180                         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.
 181                         <para></para></listitem>
 182         </varlistentry>
 183
 184         <varlistentry>
 185                 <term><command><option>maximum_width</option></command>
 186                         <option>pixels</option>
 187                 </term>
 188                 <listitem>
 189                         Maximum width of window
 190                         <para></para></listitem>
 191         </varlistentry>
 192
 193         <varlistentry>
 194                 <term><command><option>minimum_size</option></command>
 195                         <option>width (height)</option>
 196                 </term>
 197                 <listitem>
 198                         Minimum size of window
 199                         <para></para></listitem>
 200         </varlistentry>
 201
 202         <varlistentry>
 203                 <term><command><option>mpd_host</option></command></term>
 204                 <listitem>
 205                         Host of MPD server
 206                         <para></para></listitem>
 207         </varlistentry>
 208
 209         <varlistentry>
 210                 <term><command><option>mpd_port</option></command></term>
 211                 <listitem>
 212                         Port of MPD server
 213                         <para></para></listitem>
 214         </varlistentry>
 215
 216         <varlistentry>
 217                 <term><command><option>mpd_password</option></command></term>
 218                 <listitem>
 219                         MPD server password
 220                         <para></para></listitem>
 221         </varlistentry>
 222
 223         <varlistentry>
 224                 <term><command><option>music_player_interval</option></command></term>
 225                 <listitem>
 226                         Music player thread update interval (defaults to Conky's update interval)
 227                         <para></para></listitem>
 228         </varlistentry>
 229
 230         <varlistentry>
 231                 <term><command><option>net_avg_samples</option></command></term>
 232                 <listitem>
 233                         The number of samples to average for net data
 234                         <para></para></listitem>
 235         </varlistentry>
 236
 237         <varlistentry>
 238                 <term><command><option>no_buffers</option></command></term>
 239                 <listitem>
 240                         Substract (file system) buffers from used memory?
 241                         <para></para></listitem>
 242         </varlistentry>
 243
 244         <varlistentry>
 245                 <term><command><option>override_utf8_locale</option></command></term>
 246                 <listitem>
 247                         Force UTF8? requires XFT
 248                         <para></para></listitem>
 249         </varlistentry>
 250
 251         <varlistentry>
 252                 <term><command><option>own_window</option></command></term>
 253                 <listitem>
 254                         Boolean, create own window to draw?
 255                         <para></para></listitem>
 256         </varlistentry>
 257
 258         <varlistentry>
 259                 <term><command><option>own_window_class</option></command></term>
 260                 <listitem>
 261                         Manually set the WM_CLASS name.  Defaults to "Conky".
 262                         <para></para></listitem>
 263         </varlistentry>
 264
 265         <varlistentry>
 266                 <term><command><option>own_window_colour</option></command>
 267                         <option>colour</option>
 268                 </term>
 269                 <listitem>
 270                         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)
 271                         <para></para></listitem>
 272         </varlistentry>
 273
 274         <varlistentry>
 275                 <term><command><option>own_window_hints</option></command>
 276                         <option>undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
 277                 </term>
 278                 <listitem>
 279                         If own_window is yes, you may use these window manager hints to affect the way Conky displays.
 280                         Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
 281                         If you use own_window_type override, window manager hints have no meaning and are ignored.
 282                         <para></para></listitem>
 283         </varlistentry>
 284
 285         <varlistentry>
 286                 <term><command><option>own_window_title</option></command></term>
 287                 <listitem>
 288                         Manually set the window name.  Defaults to "&lt;hostname&gt; - conky".
 289                         <para></para></listitem>
 290         </varlistentry>
 291
 292         <varlistentry>
 293                 <term><command><option>own_window_transparent</option></command></term>
 294                 <listitem>
 295                         Boolean, set pseudo-transparency?
 296                         <para></para></listitem>
 297         </varlistentry>
 298
 299         <varlistentry>
 300                 <term><command><option>own_window_type</option></command></term>
 301                 <listitem>
 302                         if own_window is yes, you may specify type normal, desktop, dock or override (default: normal).
 303                         Desktop windows are special windows that have no window decorations; are always visible
 304                         on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
 305                         Override windows are not under the control of the window manager.  Hints are ignored. This type
 306                         of window can be useful for certain situations.
 307                         <para></para></listitem>
 308         </varlistentry>
 309
 310         <varlistentry>
 311                 <term><command><option>out_to_console</option></command>
 312                 </term>
 313                 <listitem>
 314                         Print text to stdout.
 315                         <para></para></listitem>
 316         </varlistentry>
 317
 318         <varlistentry>
 319                 <term><command><option>out_to_stderr</option></command>
 320                 </term>
 321                 <listitem>
 322                         Print text to stderr.
 323                         <para></para></listitem>
 324         </varlistentry>
 325
 326         <varlistentry>
 327                 <term><command><option>out_to_x</option></command>
 328                 </term>
 329                 <listitem>
 330                         When set to no, there will be no output in X (useful when you also use things like out_to_console).
 331                         If you set it to no, make sure that it's placed before all other X-related setting (take the first
 332                         line of your configfile to be sure). Default value is yes
 333                         <para></para></listitem>
 334         </varlistentry>
 335
 336         <varlistentry>
 337                 <term><command><option>overwrite_file</option></command>
 338                 </term>
 339                 <listitem>
 340                         Overwrite the file given as argument.
 341                         <para></para></listitem>
 342         </varlistentry>
 343
 344         <varlistentry>
 345                 <term><command><option>append_file</option></command>
 346                 </term>
 347                 <listitem>
 348                         Append the file given as argument.
 349                         <para></para></listitem>
 350         </varlistentry>
 351
 352         <varlistentry>
 353                 <term><command><option>pad_percents</option></command></term>
 354                 <listitem>
 355                         Pad percentages to this many decimals (0 = no padding)
 356                         <para></para></listitem>
 357         </varlistentry>
 358
 359         <varlistentry>
 360                 <term><command><option>pop3</option></command></term>
 361                 <listitem>
 362                         Default global POP3 server.  Arguments are: "host user pass [-i interval] [-p port] [-e command] [-r retries]".  Default port is 110, default interval is 5 minutes, and default number of retries before giving up is 5.  If the password is supplied as '*', you will be prompted to enter the password when Conky starts.
 363                         <para></para></listitem>
 364         </varlistentry>
 365
 366         <varlistentry>
 367                 <term><command><option>short_units</option></command></term>
 368                 <listitem>
 369                         Shortens units to a single character (kiB->k, GiB->G, etc.).  Default is off.
 370                         <para></para></listitem>
 371         </varlistentry>
 372
 373         <varlistentry>
 374                 <term><command><option>show_graph_scale</option></command></term>
 375                 <listitem>
 376                         Shows the maximum value in scaled graphs.
 377                         <para></para></listitem>
 378         </varlistentry>
 379
 380         <varlistentry>
 381                 <term><command><option>show_graph_range</option></command></term>
 382                 <listitem>
 383                         Shows the time range covered by a graph.
 384                         <para></para></listitem>
 385         </varlistentry>
 386
 387         <varlistentry>
 388                 <term><command><option>stippled_borders</option></command></term>
 389                 <listitem>
 390                         Border stippling (dashing) in pixels
 391                         <para></para></listitem>
 392         </varlistentry>
 393
 394         <varlistentry>
 395                 <term><command><option>temperature_unit</option></command></term>
 396                 <listitem>
 397                         Desired output unit of all objects displaying a temperature.
 398                         Parameters are either "fahrenheit" or "celsius". The default
 399                         unit is degree Celsius.
 400                         <para></para></listitem>
 401         </varlistentry>
 402
 403         <varlistentry>
 404                 <term><command><option>templateN</option></command></term>
 405                 <listitem>
 406                         Define a template for later use inside TEXT segments. Substitute N by a digit between 0 and 9, inclusively.
 407                         The value of the variable is being inserted into the stuff below TEXT at the corresponding position,
 408                         but before some substitutions are applied:
 409                         <simplelist>
 410                                 <member>'\n' -> newline</member>
 411                                 <member>'\\' -> backslash</member>
 412                                 <member>'\ ' -> space</member>
 413                                 <member>'\N' -> template argument N</member>
 414                         </simplelist>
 415                         <para></para></listitem>
 416         </varlistentry>
 417
 418         <varlistentry>
 419                 <term><command><option>total_run_times</option></command></term>
 420                 <listitem>
 421                         Total number of times for Conky to update before quitting. Zero makes Conky run forever
 422                         <para></para></listitem>
 423         </varlistentry>
 424
 425         <varlistentry>
 426                 <term><command><option>update_interval</option></command></term>
 427                 <listitem>
 428                         Update interval in seconds
 429                         <para></para></listitem>
 430         </varlistentry>
 431
 432         <varlistentry>
 433                 <term><command><option>uppercase</option></command></term>
 434                 <listitem>
 435                         Boolean value, if true, text is rendered in upper case
 436                         <para></para></listitem>
 437         </varlistentry>
 438
 439         <varlistentry>
 440                 <term><command><option>use_spacer</option></command></term>
 441                 <listitem>
 442                         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.
 443                         <para></para></listitem>
 444         </varlistentry>
 445
 446         <varlistentry>
 447                 <term><command><option>use_xft</option></command></term>
 448                 <listitem>
 449                         Use Xft (anti-aliased font and stuff)
 450                         <para></para></listitem>
 451         </varlistentry>
 452
 453         <varlistentry>
 454                 <term><command><option>xftalpha</option></command></term>
 455                 <listitem>
 456                         Alpha of Xft font.  Must be a value at or between 1 and 0.
 457                         <para></para></listitem>
 458         </varlistentry>
 459
 460         <varlistentry>
 461                 <term><command><option>xftfont</option></command></term>
 462                 <listitem>
 463                         Xft font to use.
 464                         <para></para></listitem>
 465         </varlistentry>
 466
 467         <varlistentry>
 468                 <term><command><option>TEXT</option></command></term>
 469                 <listitem>
 470                         After this begins text to be formatted on screen.  Backslash (\) escapes newlines in the text section.  This can be useful for cleaning up config files where conky is used to pipe input to dzen2.
 471                         <para></para></listitem>
 472         </varlistentry>
 473
 474 </variablelist>