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_outline_color</option></command></term>
  46         <listitem>
  47                 Default outline 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>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_outline</option></command></term>
  81         <listitem>
  82                 Draw outlines?
  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>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, in pixels, between right or left border of screen, same as passing -x at command line,
 104                 e.g. gap_x 10
 105         <para></para></listitem>
 106 </varlistentry>
 107
 108 <varlistentry>
 109         <term><command><option>gap_y</option></command></term>
 110         <listitem>
 111                 Gap, in pixels, between top or bottom border of screen, same as passing -y at command line,
 112                 e.g. gap_y 10.
 113         <para></para></listitem>
 114 </varlistentry>
 115
 116 <varlistentry>
 117         <term><command><option>imap</option></command></term>
 118         <listitem>
 119                 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.
 120         <para></para></listitem>
 121 </varlistentry>
 122
 123 <varlistentry>
 124         <term><command><option>mail_spool</option></command></term>
 125         <listitem>
 126                 Mail spool for mail checking
 127         <para></para></listitem>
 128 </varlistentry>
 129
 130 <varlistentry>
 131         <term><command><option>max_specials</option></command></term>
 132         <listitem>
 133                 Maximum number of special things, e.g. fonts, offsets, aligns, etc. (default is 512)
 134                 <para></para></listitem>
 135 </varlistentry>
 136
 137 <varlistentry>
 138         <term><command><option>max_user_text</option></command>
 139                 <option>bytes</option>
 140         </term>
 141         <listitem>
 142                 Maximum size of user text buffer, i.e. layout below TEXT line in config file
 143                 (default is 16384 bytes)
 144                 <para></para></listitem>
 145 </varlistentry>
 146
 147 <varlistentry>
 148         <term><command><option>maximum_width</option></command>
 149                 <option>pixels</option>
 150         </term>
 151         <listitem>
 152                 Maximum width of window
 153                 <para></para></listitem>
 154 </varlistentry>
 155
 156 <varlistentry>
 157         <term><command><option>minimum_size</option></command>
 158         <option>width (height)</option>
 159         </term>
 160         <listitem>
 161                 Minimum size of window
 162         <para></para></listitem>
 163 </varlistentry>
 164
 165 <varlistentry>
 166         <term><command><option>min_port_monitors</option></command></term>
 167         <listitem>
 168                 Allow for the creation of at least this number of port monitors (if 0 or not set, default is 16)
 169         <para></para></listitem>
 170 </varlistentry>
 171
 172 <varlistentry>
 173         <term><command><option>min_port_monitor_connections</option></command></term>
 174         <listitem>
 175                 Allow each port monitor to track at least this many connections (if 0 or not set, default is 256)
 176         <para></para></listitem>
 177 </varlistentry>
 178
 179 <varlistentry>
 180         <term><command><option>mpd_host</option></command></term>
 181         <listitem>
 182                 Host of MPD server
 183         <para></para></listitem>
 184 </varlistentry>
 185
 186 <varlistentry>
 187         <term><command><option>mpd_port</option></command></term>
 188         <listitem>
 189                 Port of MPD server
 190         <para></para></listitem>
 191 </varlistentry>
 192
 193 <varlistentry>
 194         <term><command><option>mpd_password</option></command></term>
 195         <listitem>
 196                 MPD server password
 197         <para></para></listitem>
 198 </varlistentry>
 199
 200 <varlistentry>
 201         <term><command><option>net_avg_samples</option></command></term>
 202         <listitem>
 203                 The number of samples to average for net data
 204         <para></para></listitem>
 205 </varlistentry>
 206
 207 <varlistentry>
 208         <term><command><option>no_buffers</option></command></term>
 209         <listitem>
 210                 Substract (file system) buffers from used memory?
 211         <para></para></listitem>
 212 </varlistentry>
 213
 214 <varlistentry>
 215         <term><command><option>override_utf8_locale</option></command></term>
 216         <listitem>
 217                 Force UTF8? requires XFT
 218         <para></para></listitem>
 219 </varlistentry>
 220
 221 <varlistentry>
 222         <term><command><option>own_window</option></command></term>
 223         <listitem>
 224                 Boolean, create own window to draw?
 225         <para></para></listitem>
 226 </varlistentry>
 227
 228 <varlistentry>
 229         <term><command><option>own_window_transparent</option></command></term>
 230         <listitem>
 231                 Boolean, set pseudo-transparency?
 232                 <para></para></listitem>
 233 </varlistentry>
 234
 235 <varlistentry>
 236         <term><command><option>own_window_type</option></command></term>
 237         <listitem>
 238                 if own_window is yes, you may specify type normal, desktop or override (default: normal).
 239                 Desktop windows are special windows that have no window decorations; are always visible
 240                 on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
 241                 Override windows are not under the control of the window manager.  Hints are ignored. This type
 242                 of window can be useful for certain situations.
 243                 <para></para></listitem>
 244 </varlistentry>
 245
 246 <varlistentry>
 247         <term><command><option>own_window_colour</option></command>
 248                 <option>colour</option>
 249         </term>
 250         <listitem>
 251                 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)
 252                 <para></para></listitem>
 253 </varlistentry>
 254
 255 <varlistentry>
 256         <term><command><option>own_window_hints</option></command>
 257                 <option>undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
 258         </term>
 259         <listitem>
 260                 If own_window is yes, you may use these window manager hints to affect the way Conky displays.
 261                 Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
 262                 If you use own_window_type override, window manager hints have no meaning and are ignored.
 263         <para></para></listitem>
 264 </varlistentry>
 265
 266 <varlistentry>
 267         <term><command><option>out_to_console</option></command>
 268         </term>
 269         <listitem>
 270                 Print text to stdout.
 271                 <para></para></listitem>
 272 </varlistentry>
 273 <varlistentry>
 274         <term><command><option>pad_percents</option></command></term>
 275         <listitem>
 276                 Pad percentages to this many decimals (0 = no padding)
 277         <para></para></listitem>
 278 </varlistentry>
 279
 280 <varlistentry>
 281         <term><command><option>pop3</option></command></term>
 282         <listitem>
 283                 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.
 284         <para></para></listitem>
 285 </varlistentry>
 286
 287 <varlistentry>
 288         <term><command><option>stippled_borders</option></command></term>
 289         <listitem>
 290                 Border stippling (dashing) in pixels
 291         <para></para></listitem>
 292 </varlistentry>
 293
 294 <varlistentry>
 295         <term><command><option>total_run_times</option></command></term>
 296         <listitem>
 297                 Total number of times for Conky to update before quitting. Zero makes Conky run forever
 298         <para></para></listitem>
 299 </varlistentry>
 300
 301 <varlistentry>
 302         <term><command><option>update_interval</option></command></term>
 303         <listitem>
 304                 Update interval in seconds
 305         <para></para></listitem>
 306 </varlistentry>
 307
 308 <varlistentry>
 309         <term><command><option>uppercase</option></command></term>
 310         <listitem>
 311                 Boolean value, if true, text is rendered in upper case
 312         <para></para></listitem>
 313 </varlistentry>
 314
 315 <varlistentry>
 316         <term><command><option>use_spacer</option></command></term>
 317         <listitem>
 318                 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.
 319         <para></para></listitem>
 320 </varlistentry>
 321
 322 <varlistentry>
 323         <term><command><option>use_xft</option></command></term>
 324         <listitem>
 325                 Use Xft (anti-aliased font and stuff)
 326         <para></para></listitem>
 327 </varlistentry>
 328
 329 <varlistentry>
 330         <term><command><option>wm_class_name</option></command></term>
 331         <listitem>
 332                 Manually set the WM_CLASS name.  Defaults to "conky".
 333         <para></para></listitem>
 334 </varlistentry>
 335
 336 <varlistentry>
 337         <term><command><option>xftalpha</option></command></term>
 338         <listitem>
 339                 Alpha of Xft font.  Must be a value at or between 1 and 0.
 340         <para></para></listitem>
 341 </varlistentry>
 342
 343 <varlistentry>
 344         <term><command><option>xftfont</option></command></term>
 345         <listitem>
 346                 Xft font to use.
 347         <para></para></listitem>
 348 </varlistentry>
 349
 350 <varlistentry>
 351         <term><command><option>TEXT</option></command></term>
 352         <listitem>
 353                 After this begins text to be formatted on screen
 354         <para></para></listitem>
 355 </varlistentry>
 356
 357 </variablelist>