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, bottom_left, bottom_right, or none
   6         <para></para></listitem>
   7 </varlistentry>
   8
   9 <varlistentry>
  10         <term><command><option>background</option></command></term>
  11         <listitem>
  12                 Boolean value, if true, Conky will be forked to background when started
  13         <para></para></listitem>
  14 </varlistentry>
  15
  16 <varlistentry>
  17         <term><command><option>on_bottom</option></command></term>
  18         <listitem>
  19                 Set conky on the bottom of all other applications
  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>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>default_color</option></command></term>
  46         <listitem>
  47                 Default color and border color
  48         <para></para></listitem>
  49 </varlistentry>
  50
  51 <varlistentry>
  52         <term><command><option>default_shade_color</option></command></term>
  53         <listitem>
  54                 Default shading color and border's shading 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>double_buffer</option></command></term>
  67         <listitem>
  68                 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.
  69         <para></para></listitem>
  70 </varlistentry>
  71
  72 <varlistentry>
  73         <term><command><option>draw_borders</option></command></term>
  74         <listitem>
  75                 Draw borders around text?
  76         <para></para></listitem>
  77 </varlistentry>
  78
  79 <varlistentry>
  80         <term><command><option>draw_graph_borders</option></command></term>
  81         <listitem>
  82                 Draw borders around graphs?
  83         <para></para></listitem>
  84 </varlistentry>
  85
  86 <varlistentry>
  87         <term><command><option>draw_shades</option></command></term>
  88         <listitem>
  89                 Draw shades?
  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>font</option></command></term>
 102         <listitem>
 103                 Font name in X, xfontsel can be used to get a nice font
 104         <para></para></listitem>
 105 </varlistentry>
 106
 107 <varlistentry>
 108         <term><command><option>gap_x</option></command></term>
 109         <listitem>
 110                 Gap between right or left border of screen, same as passing -x at command line
 111         <para></para></listitem>
 112 </varlistentry>
 113
 114 <varlistentry>
 115         <term><command><option>gap_y</option></command></term>
 116         <listitem>
 117                 Gap between top or bottom border of screen, same as passing -y at command line
 118         <para></para></listitem>
 119 </varlistentry>
 120
 121 <varlistentry>
 122         <term><command><option>no_buffers</option></command></term>
 123         <listitem>
 124                 Substract (file system) buffers from used memory?
 125         <para></para></listitem>
 126 </varlistentry>
 127
 128 <varlistentry>
 129         <term><command><option>mail_spool</option></command></term>
 130         <listitem>
 131                 Mail spool for mail checking
 132         <para></para></listitem>
 133 </varlistentry>
 134
 135 <varlistentry>
 136         <term><command><option>maximum_width</option></command>
 137                 <option>pixels</option>
 138         </term>
 139         <listitem>
 140                 Maximum width of window
 141                 <para></para></listitem>
 142 </varlistentry>
 143
 144 <varlistentry>
 145         <term><command><option>minimum_size</option></command>
 146         <option>width (height)</option>
 147         </term>
 148         <listitem>
 149                 Minimum size of window
 150         <para></para></listitem>
 151 </varlistentry>
 152
 153 <varlistentry>
 154         <term><command><option>min_port_monitors</option></command></term>
 155         <listitem>
 156                 Allow for the creation of at least this number of port monitors (if 0 or not set, default is 16)
 157         <para></para></listitem>
 158 </varlistentry>
 159
 160 <varlistentry>
 161         <term><command><option>min_port_monitor_connections</option></command></term>
 162         <listitem>
 163                 Allow each port monitor to track at least this many connections (if 0 or not set, default is 256)
 164         <para></para></listitem>
 165 </varlistentry>
 166
 167 <varlistentry>
 168         <term><command><option>mldonkey_hostname</option></command></term>
 169         <listitem>
 170                 Hostname for mldonkey stuff, defaults to localhost
 171         <para></para></listitem>
 172 </varlistentry>
 173
 174 <varlistentry>
 175         <term><command><option>mldonkey_port</option></command></term>
 176         <listitem>
 177                 Mldonkey port, 4001 default
 178         <para></para></listitem>
 179 </varlistentry>
 180
 181 <varlistentry>
 182         <term><command><option>mldonkey_login</option></command></term>
 183         <listitem>
 184                 Mldonkey login, default none
 185         <para></para></listitem>
 186 </varlistentry>
 187
 188 <varlistentry>
 189         <term><command><option>mldonkey_password</option></command></term>
 190         <listitem>
 191                 Mldonkey password, default none
 192         <para></para></listitem>
 193 </varlistentry>
 194
 195 <varlistentry>
 196         <term><command><option>mpd_host</option></command></term>
 197         <listitem>
 198                 Host of MPD server
 199         <para></para></listitem>
 200 </varlistentry>
 201
 202 <varlistentry>
 203         <term><command><option>mpd_port</option></command></term>
 204         <listitem>
 205                 Port of MPD server
 206         <para></para></listitem>
 207 </varlistentry>
 208
 209 <varlistentry>
 210         <term><command><option>mpd_password</option></command></term>
 211         <listitem>
 212                 MPD server password
 213         <para></para></listitem>
 214 </varlistentry>
 215
 216 <varlistentry>
 217         <term><command><option>net_avg_samples</option></command></term>
 218         <listitem>
 219                 The number of samples to average for net data
 220         <para></para></listitem>
 221 </varlistentry>
 222
 223 <varlistentry>
 224         <term><command><option>override_utf8_locale</option></command></term>
 225         <listitem>
 226                 Force UTF8? requires XFT
 227         <para></para></listitem>
 228 </varlistentry>
 229
 230 <varlistentry>
 231         <term><command><option>own_window</option></command></term>
 232         <listitem>
 233                 Boolean, create own window to draw?
 234         <para></para></listitem>
 235 </varlistentry>
 236
 237 <varlistentry>
 238         <term><command><option>own_window_transparent</option></command></term>
 239         <listitem>
 240                 Boolean, set pseudo-transparency?
 241                 <para></para></listitem>
 242 </varlistentry>
 243
 244 <varlistentry>
 245         <term><command><option>own_window_type</option></command></term>
 246         <listitem>
 247                 if own_window is yes, you may specify type normal, desktop or override (default: normal).
 248                 Desktop windows are special windows that have no window decorations; are always visible
 249                 on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
 250                 Override windows are not under the control of the window manager.  This type can be useful
 251                 for certain situations.
 252                 <para></para></listitem>
 253 </varlistentry>
 254
 255 <varlistentry>
 256         <term><command><option>own_window_colour</option></command>
 257                 <option>colour</option>
 258         </term>
 259         <listitem>
 260                 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)
 261                 <para></para></listitem>
 262 </varlistentry>
 263
 264 <varlistentry>
 265         <term><command><option>own_window_hints</option></command>
 266                 <option>undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
 267         </term>
 268         <listitem>
 269                 If own_window is yes, you may use these window manager hints to affect the way conky displays.
 270                 Note: own_window_type desktop is another way to implement many of these hints.
 271         <para></para></listitem>
 272 </varlistentry>
 273
 274 <varlistentry>
 275         <term><command><option>out_to_console</option></command>
 276         </term>
 277         <listitem>
 278                 Print text to stdout.
 279                 <para></para></listitem>
 280 </varlistentry>
 281 <varlistentry>
 282         <term><command><option>pad_percents</option></command></term>
 283         <listitem>
 284                 Pad percentages to this many decimals (0 = no padding)
 285         <para></para></listitem>
 286 </varlistentry>
 287
 288 <varlistentry>
 289         <term><command><option>stippled_borders</option></command></term>
 290         <listitem>
 291                 Border stippling (dashing) in pixels
 292         <para></para></listitem>
 293 </varlistentry>
 294
 295 <varlistentry>
 296         <term><command><option>total_run_times</option></command></term>
 297         <listitem>
 298                 Total number of times for Conky to update before quitting. Zero makes Conky run forever
 299         <para></para></listitem>
 300 </varlistentry>
 301
 302 <varlistentry>
 303         <term><command><option>update_interval</option></command></term>
 304         <listitem>
 305                 Update interval in seconds
 306         <para></para></listitem>
 307 </varlistentry>
 308
 309 <varlistentry>
 310         <term><command><option>uppercase</option></command></term>
 311         <listitem>
 312                 Boolean value, if true, text is rendered in upper case
 313         <para></para></listitem>
 314 </varlistentry>
 315
 316 <varlistentry>
 317         <term><command><option>use_spacer</option></command></term>
 318         <listitem>
 319                 Adds spaces after certain objects to stop them from moving other things around. Note that this only helps if you are using a mono font, such as Bitstream Vera Sans Mono.
 320         <para></para></listitem>
 321 </varlistentry>
 322
 323 <varlistentry>
 324         <term><command><option>use_xft</option></command></term>
 325         <listitem>
 326                 Use Xft (anti-aliased font and stuff)
 327         <para></para></listitem>
 328 </varlistentry>
 329
 330 <varlistentry>
 331         <term><command><option>wm_class_name</option></command></term>
 332         <listitem>
 333                 Manually set the WM_CLASS name.  Defaults to "conky".
 334         <para></para></listitem>
 335 </varlistentry>
 336
 337 <varlistentry>
 338         <term><command><option>xmms_player</option></command></term>
 339         <listitem>
 340                 Use specified player/plugin for the xmms status variables.  Valid items are: none, xmms, bmp, audacious and infopipe. (default is none).  Note that bmpx is currently handled separately.
 341         <para></para></listitem>
 342 </varlistentry>
 343
 344 <varlistentry>
 345         <term><command><option>TEXT</option></command></term>
 346         <listitem>
 347                 After this begins text to be formatted on screen
 348         <para></para></listitem>
 349 </varlistentry>
 350
 351 </variablelist>