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>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>cpu_avg_samples</option></command></term>
  32         <listitem>
  33                 The number of samples to average for CPU monitoring
  34         <para></para></listitem>
  35 </varlistentry>
  36
  37 <varlistentry>
  38         <term><command><option>default_color</option></command></term>
  39         <listitem>
  40                 Default color and border color
  41         <para></para></listitem>
  42 </varlistentry>
  43
  44 <varlistentry>
  45         <term><command><option>default_shade_color</option></command></term>
  46         <listitem>
  47                 Default shading color and border's shading color
  48         <para></para></listitem>
  49 </varlistentry>
  50
  51 <varlistentry>
  52         <term><command><option>default_outline_color</option></command></term>
  53         <listitem>
  54                 Default outline color
  55         <para></para></listitem>
  56 </varlistentry>
  57
  58 <varlistentry>
  59         <term><command><option>double_buffer</option></command></term>
  60         <listitem>
  61                 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.
  62         <para></para></listitem>
  63 </varlistentry>
  64
  65 <varlistentry>
  66         <term><command><option>draw_borders</option></command></term>
  67         <listitem>
  68                 Draw borders around text?
  69         <para></para></listitem>
  70 </varlistentry>
  71
  72 <varlistentry>
  73         <term><command><option>draw_graph_borders</option></command></term>
  74         <listitem>
  75                 Draw borders around graphs?
  76         <para></para></listitem>
  77 </varlistentry>
  78
  79 <varlistentry>
  80         <term><command><option>draw_shades</option></command></term>
  81         <listitem>
  82                 Draw shades?
  83         <para></para></listitem>
  84 </varlistentry>
  85
  86 <varlistentry>
  87         <term><command><option>draw_outline</option></command></term>
  88         <listitem>
  89                 Draw outlines?
  90         <para></para></listitem>
  91 </varlistentry>
  92
  93 <varlistentry>
  94         <term><command><option>font</option></command></term>
  95         <listitem>
  96                 Font name in X, xfontsel can be used to get a nice font
  97         <para></para></listitem>
  98 </varlistentry>
  99
 100 <varlistentry>
 101         <term><command><option>gap_x</option></command></term>
 102         <listitem>
 103                 Gap between right or left border of screen, same as passing -x at command line
 104         <para></para></listitem>
 105 </varlistentry>
 106
 107 <varlistentry>
 108         <term><command><option>gap_y</option></command></term>
 109         <listitem>
 110                 Gap between top or bottom border of screen, same as passing -y at command line
 111         <para></para></listitem>
 112 </varlistentry>
 113
 114 <varlistentry>
 115         <term><command><option>imap</option></command></term>
 116         <listitem>
 117                 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.
 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>mpd_host</option></command></term>
 169         <listitem>
 170                 Host of MPD server
 171         <para></para></listitem>
 172 </varlistentry>
 173
 174 <varlistentry>
 175         <term><command><option>mpd_port</option></command></term>
 176         <listitem>
 177                 Port of MPD server
 178         <para></para></listitem>
 179 </varlistentry>
 180
 181 <varlistentry>
 182         <term><command><option>mpd_password</option></command></term>
 183         <listitem>
 184                 MPD server password
 185         <para></para></listitem>
 186 </varlistentry>
 187
 188 <varlistentry>
 189         <term><command><option>net_avg_samples</option></command></term>
 190         <listitem>
 191                 The number of samples to average for net data
 192         <para></para></listitem>
 193 </varlistentry>
 194
 195 <varlistentry>
 196         <term><command><option>override_utf8_locale</option></command></term>
 197         <listitem>
 198                 Force UTF8? requires XFT
 199         <para></para></listitem>
 200 </varlistentry>
 201
 202 <varlistentry>
 203         <term><command><option>own_window</option></command></term>
 204         <listitem>
 205                 Boolean, create own window to draw?
 206         <para></para></listitem>
 207 </varlistentry>
 208
 209 <varlistentry>
 210         <term><command><option>own_window_transparent</option></command></term>
 211         <listitem>
 212                 Boolean, set pseudo-transparency?
 213                 <para></para></listitem>
 214 </varlistentry>
 215
 216 <varlistentry>
 217         <term><command><option>own_window_type</option></command></term>
 218         <listitem>
 219                 if own_window is yes, you may specify type normal, desktop or override (default: normal).
 220                 Desktop windows are special windows that have no window decorations; are always visible
 221                 on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
 222                 Override windows are not under the control of the window manager.  Hints are ignored. This type
 223                 of window can be useful for certain situations.
 224                 <para></para></listitem>
 225 </varlistentry>
 226
 227 <varlistentry>
 228         <term><command><option>own_window_colour</option></command>
 229                 <option>colour</option>
 230         </term>
 231         <listitem>
 232                 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)
 233                 <para></para></listitem>
 234 </varlistentry>
 235
 236 <varlistentry>
 237         <term><command><option>own_window_hints</option></command>
 238                 <option>undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
 239         </term>
 240         <listitem>
 241                 If own_window is yes, you may use these window manager hints to affect the way Conky displays.
 242                 Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
 243                 If you use own_window_type override, window manager hints have no meaning and are ignored.
 244         <para></para></listitem>
 245 </varlistentry>
 246
 247 <varlistentry>
 248         <term><command><option>out_to_console</option></command>
 249         </term>
 250         <listitem>
 251                 Print text to stdout.
 252                 <para></para></listitem>
 253 </varlistentry>
 254 <varlistentry>
 255         <term><command><option>pad_percents</option></command></term>
 256         <listitem>
 257                 Pad percentages to this many decimals (0 = no padding)
 258         <para></para></listitem>
 259 </varlistentry>
 260
 261 <varlistentry>
 262         <term><command><option>pop3</option></command></term>
 263         <listitem>
 264                 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.
 265         <para></para></listitem>
 266 </varlistentry>
 267
 268 <varlistentry>
 269         <term><command><option>stippled_borders</option></command></term>
 270         <listitem>
 271                 Border stippling (dashing) in pixels
 272         <para></para></listitem>
 273 </varlistentry>
 274
 275 <varlistentry>
 276         <term><command><option>total_run_times</option></command></term>
 277         <listitem>
 278                 Total number of times for Conky to update before quitting. Zero makes Conky run forever
 279         <para></para></listitem>
 280 </varlistentry>
 281
 282 <varlistentry>
 283         <term><command><option>update_interval</option></command></term>
 284         <listitem>
 285                 Update interval in seconds
 286         <para></para></listitem>
 287 </varlistentry>
 288
 289 <varlistentry>
 290         <term><command><option>uppercase</option></command></term>
 291         <listitem>
 292                 Boolean value, if true, text is rendered in upper case
 293         <para></para></listitem>
 294 </varlistentry>
 295
 296 <varlistentry>
 297         <term><command><option>use_spacer</option></command></term>
 298         <listitem>
 299                 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.
 300         <para></para></listitem>
 301 </varlistentry>
 302
 303 <varlistentry>
 304         <term><command><option>use_xft</option></command></term>
 305         <listitem>
 306                 Use Xft (anti-aliased font and stuff)
 307         <para></para></listitem>
 308 </varlistentry>
 309
 310 <varlistentry>
 311         <term><command><option>wm_class_name</option></command></term>
 312         <listitem>
 313                 Manually set the WM_CLASS name.  Defaults to "conky".
 314         <para></para></listitem>
 315 </varlistentry>
 316
 317 <varlistentry>
 318         <term><command><option>xftalpha</option></command></term>
 319         <listitem>
 320                 Alpha of Xft font.  Must be a value at or between 1 and 0.
 321         <para></para></listitem>
 322 </varlistentry>
 323
 324 <varlistentry>
 325         <term><command><option>xftfont</option></command></term>
 326         <listitem>
 327                 Xft font to use.
 328         <para></para></listitem>
 329 </varlistentry>
 330
 331 <varlistentry>
 332         <term><command><option>TEXT</option></command></term>
 333         <listitem>
 334                 After this begins text to be formatted on screen
 335         <para></para></listitem>
 336 </varlistentry>
 337
 338 </variablelist>