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