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_port_monitor_connections</option></command></term>
 132         <listitem>
 133                 Allow each port monitor to track at most this many connections (if 0 or not set, default is 256)
 134         <para></para></listitem>
 135 </varlistentry>
 136
 137 <varlistentry>
 138         <term><command><option>max_specials</option></command></term>
 139         <listitem>
 140                 Maximum number of special things, e.g. fonts, offsets, aligns, etc. (default is 512)
 141                 <para></para></listitem>
 142 </varlistentry>
 143
 144 <varlistentry>
 145         <term><command><option>max_user_text</option></command>
 146                 <option>bytes</option>
 147         </term>
 148         <listitem>
 149                 Maximum size of user text buffer, i.e. layout below TEXT line in config file
 150                 (default is 16384 bytes)
 151                 <para></para></listitem>
 152 </varlistentry>
 153
 154 <varlistentry>
 155         <term><command><option>text_buffer_size</option></command>
 156                 <option>bytes</option>
 157         </term>
 158         <listitem>
 159                 Size of the standard text buffer (default is 1280 bytes).
 160                 <para></para></listitem>
 161 </varlistentry>
 162
 163 <varlistentry>
 164         <term><command><option>maximum_width</option></command>
 165                 <option>pixels</option>
 166         </term>
 167         <listitem>
 168                 Maximum width of window
 169                 <para></para></listitem>
 170 </varlistentry>
 171
 172 <varlistentry>
 173         <term><command><option>minimum_size</option></command>
 174         <option>width (height)</option>
 175         </term>
 176         <listitem>
 177                 Minimum size of window
 178         <para></para></listitem>
 179 </varlistentry>
 180
 181 <varlistentry>
 182         <term><command><option>mpd_host</option></command></term>
 183         <listitem>
 184                 Host of MPD server
 185         <para></para></listitem>
 186 </varlistentry>
 187
 188 <varlistentry>
 189         <term><command><option>mpd_port</option></command></term>
 190         <listitem>
 191                 Port of MPD server
 192         <para></para></listitem>
 193 </varlistentry>
 194
 195 <varlistentry>
 196         <term><command><option>mpd_password</option></command></term>
 197         <listitem>
 198                 MPD server password
 199         <para></para></listitem>
 200 </varlistentry>
 201
 202 <varlistentry>
 203         <term><command><option>net_avg_samples</option></command></term>
 204         <listitem>
 205                 The number of samples to average for net data
 206         <para></para></listitem>
 207 </varlistentry>
 208
 209 <varlistentry>
 210         <term><command><option>no_buffers</option></command></term>
 211         <listitem>
 212                 Substract (file system) buffers from used memory?
 213         <para></para></listitem>
 214 </varlistentry>
 215
 216 <varlistentry>
 217         <term><command><option>override_utf8_locale</option></command></term>
 218         <listitem>
 219                 Force UTF8? requires XFT
 220         <para></para></listitem>
 221 </varlistentry>
 222
 223 <varlistentry>
 224         <term><command><option>own_window</option></command></term>
 225         <listitem>
 226                 Boolean, create own window to draw?
 227         <para></para></listitem>
 228 </varlistentry>
 229
 230 <varlistentry>
 231         <term><command><option>own_window_class</option></command></term>
 232         <listitem>
 233                 Manually set the WM_CLASS name.  Defaults to "Conky".
 234         <para></para></listitem>
 235 </varlistentry>
 236
 237 <varlistentry>
 238         <term><command><option>own_window_colour</option></command>
 239                 <option>colour</option>
 240         </term>
 241         <listitem>
 242                 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)
 243                 <para></para></listitem>
 244 </varlistentry>
 245
 246 <varlistentry>
 247         <term><command><option>own_window_hints</option></command>
 248                 <option>undecorated,below,above,sticky,skip_taskbar,skip_pager</option>
 249         </term>
 250         <listitem>
 251                 If own_window is yes, you may use these window manager hints to affect the way Conky displays.
 252                 Notes: Use own_window_type desktop as another way to implement many of these hints implicitly.
 253                 If you use own_window_type override, window manager hints have no meaning and are ignored.
 254         <para></para></listitem>
 255 </varlistentry>
 256
 257 <varlistentry>
 258         <term><command><option>own_window_title</option></command></term>
 259         <listitem>
 260                 Manually set the window name.  Defaults to "&lt;hostname&gt; - conky".
 261         <para></para></listitem>
 262 </varlistentry>
 263
 264 <varlistentry>
 265         <term><command><option>own_window_transparent</option></command></term>
 266         <listitem>
 267                 Boolean, set pseudo-transparency?
 268                 <para></para></listitem>
 269 </varlistentry>
 270
 271 <varlistentry>
 272         <term><command><option>own_window_type</option></command></term>
 273         <listitem>
 274                 if own_window is yes, you may specify type normal, desktop or override (default: normal).
 275                 Desktop windows are special windows that have no window decorations; are always visible
 276                 on your desktop; do not appear in your pager or taskbar; and are sticky across all workspaces.
 277                 Override windows are not under the control of the window manager.  Hints are ignored. This type
 278                 of window can be useful for certain situations.
 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>xftalpha</option></command></term>
 347         <listitem>
 348                 Alpha of Xft font.  Must be a value at or between 1 and 0.
 349         <para></para></listitem>
 350 </varlistentry>
 351
 352 <varlistentry>
 353         <term><command><option>xftfont</option></command></term>
 354         <listitem>
 355                 Xft font to use.
 356         <para></para></listitem>
 357 </varlistentry>
 358
 359 <varlistentry>
 360         <term><command><option>TEXT</option></command></term>
 361         <listitem>
 362                 After this begins text to be formatted on screen
 363         <para></para></listitem>
 364 </varlistentry>
 365
 366 </variablelist>