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

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