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>imap</option></command></term>
 123         <listitem>
 124                 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.
 125         <para></para></listitem>
 126 </varlistentry>
 127
 128 <varlistentry>
 129         <term><command><option>no_buffers</option></command></term>
 130         <listitem>
 131                 Substract (file system) buffers from used memory?
 132         <para></para></listitem>
 133 </varlistentry>
 134
 135 <varlistentry>
 136         <term><command><option>mail_spool</option></command></term>
 137         <listitem>
 138                 Mail spool for mail checking
 139         <para></para></listitem>
 140 </varlistentry>
 141
 142 <varlistentry>
 143         <term><command><option>maximum_width</option></command>
 144                 <option>pixels</option>
 145         </term>
 146         <listitem>
 147                 Maximum width of window
 148                 <para></para></listitem>
 149 </varlistentry>
 150
 151 <varlistentry>
 152         <term><command><option>minimum_size</option></command>
 153         <option>width (height)</option>
 154         </term>
 155         <listitem>
 156                 Minimum size of window
 157         <para></para></listitem>
 158 </varlistentry>
 159
 160 <varlistentry>
 161         <term><command><option>min_port_monitors</option></command></term>
 162         <listitem>
 163                 Allow for the creation of at least this number of port monitors (if 0 or not set, default is 16)
 164         <para></para></listitem>
 165 </varlistentry>
 166
 167 <varlistentry>
 168         <term><command><option>min_port_monitor_connections</option></command></term>
 169         <listitem>
 170                 Allow each port monitor to track at least this many connections (if 0 or not set, default is 256)
 171         <para></para></listitem>
 172 </varlistentry>
 173
 174 <varlistentry>
 175         <term><command><option>mldonkey_hostname</option></command></term>
 176         <listitem>
 177                 Hostname for mldonkey stuff, defaults to localhost
 178         <para></para></listitem>
 179 </varlistentry>
 180
 181 <varlistentry>
 182         <term><command><option>mldonkey_port</option></command></term>
 183         <listitem>
 184                 Mldonkey port, 4001 default
 185         <para></para></listitem>
 186 </varlistentry>
 187
 188 <varlistentry>
 189         <term><command><option>mldonkey_login</option></command></term>
 190         <listitem>
 191                 Mldonkey login, default none
 192         <para></para></listitem>
 193 </varlistentry>
 194
 195 <varlistentry>
 196         <term><command><option>mldonkey_password</option></command></term>
 197         <listitem>
 198                 Mldonkey password, default none
 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>net_avg_samples</option></command></term>
 225         <listitem>
 226                 The number of samples to average for net data
 227         <para></para></listitem>
 228 </varlistentry>
 229
 230 <varlistentry>
 231         <term><command><option>override_utf8_locale</option></command></term>
 232         <listitem>
 233                 Force UTF8? requires XFT
 234         <para></para></listitem>
 235 </varlistentry>
 236
 237 <varlistentry>
 238         <term><command><option>own_window</option></command></term>
 239         <listitem>
 240                 Boolean, create own window to draw?
 241         <para></para></listitem>
 242 </varlistentry>
 243
 244 <varlistentry>
 245         <term><command><option>own_window_transparent</option></command></term>
 246         <listitem>
 247                 Boolean, set pseudo-transparency?
 248                 <para></para></listitem>
 249 </varlistentry>
 250
 251 <varlistentry>
 252         <term><command><option>own_window_type</option></command></term>
 253         <listitem>
 254                 if own_window is yes, you may specify type normal, desktop or override (default: normal).
 255                 Desktop windows are special windows that have no window decorations; are always visible
 256                 on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
 257                 Override windows are not under the control of the window manager.  Hints are ignored. This type
 258                 of window can be useful for certain situations.
 259                 <para></para></listitem>
 260 </varlistentry>
 261
 262 <varlistentry>
 263         <term><command><option>own_window_colour</option></command>
 264                 <option>colour</option>
 265         </term>
 266         <listitem>
 267                 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)
 268                 <para></para></listitem>
 269 </varlistentry>
 270
 271 <varlistentry>
 272         <term><command><option>own_window_hints</option></command>
 273                 <option>undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
 274         </term>
 275         <listitem>
 276                 If own_window is yes, you may use these window manager hints to affect the way Conky displays.
 277                 Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
 278                 If you use own_window_type override, window manager hints have no meaning and are ignored.
 279         <para></para></listitem>
 280 </varlistentry>
 281
 282 <varlistentry>
 283         <term><command><option>out_to_console</option></command>
 284         </term>
 285         <listitem>
 286                 Print text to stdout.
 287                 <para></para></listitem>
 288 </varlistentry>
 289 <varlistentry>
 290         <term><command><option>pad_percents</option></command></term>
 291         <listitem>
 292                 Pad percentages to this many decimals (0 = no padding)
 293         <para></para></listitem>
 294 </varlistentry>
 295
 296 <varlistentry>
 297         <term><command><option>pop3</option></command></term>
 298         <listitem>
 299                 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.
 300         <para></para></listitem>
 301 </varlistentry>
 302
 303 <varlistentry>
 304         <term><command><option>stippled_borders</option></command></term>
 305         <listitem>
 306                 Border stippling (dashing) in pixels
 307         <para></para></listitem>
 308 </varlistentry>
 309
 310 <varlistentry>
 311         <term><command><option>total_run_times</option></command></term>
 312         <listitem>
 313                 Total number of times for Conky to update before quitting. Zero makes Conky run forever
 314         <para></para></listitem>
 315 </varlistentry>
 316
 317 <varlistentry>
 318         <term><command><option>update_interval</option></command></term>
 319         <listitem>
 320                 Update interval in seconds
 321         <para></para></listitem>
 322 </varlistentry>
 323
 324 <varlistentry>
 325         <term><command><option>uppercase</option></command></term>
 326         <listitem>
 327                 Boolean value, if true, text is rendered in upper case
 328         <para></para></listitem>
 329 </varlistentry>
 330
 331 <varlistentry>
 332         <term><command><option>use_spacer</option></command></term>
 333         <listitem>
 334                 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.
 335         <para></para></listitem>
 336 </varlistentry>
 337
 338 <varlistentry>
 339         <term><command><option>use_xft</option></command></term>
 340         <listitem>
 341                 Use Xft (anti-aliased font and stuff)
 342         <para></para></listitem>
 343 </varlistentry>
 344
 345 <varlistentry>
 346         <term><command><option>wm_class_name</option></command></term>
 347         <listitem>
 348                 Manually set the WM_CLASS name.  Defaults to "conky".
 349         <para></para></listitem>
 350 </varlistentry>
 351
 352 <varlistentry>
 353         <term><command><option>xftalpha</option></command></term>
 354         <listitem>
 355                 Alpha of Xft font.  Must be a value at or between 1 and 0.
 356         <para></para></listitem>
 357 </varlistentry>
 358
 359 <varlistentry>
 360         <term><command><option>xftfont</option></command></term>
 361         <listitem>
 362                 Xft font to use.
 363         <para></para></listitem>
 364 </varlistentry>
 365
 366 <varlistentry>
 367         <term><command><option>TEXT</option></command></term>
 368         <listitem>
 369                 After this begins text to be formatted on screen
 370         <para></para></listitem>
 371 </varlistentry>
 372
 373 </variablelist>